include/bsp/bootcard.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsSharedStartup
0007  */
0008
0009 /*
0010  * Copyright (C) 2008, 2014 embedded brains GmbH & Co. KG
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 #ifndef LIBBSP_SHARED_BOOTCARD_H
0035 #define LIBBSP_SHARED_BOOTCARD_H
0036
0037 #include <rtems/config.h>
0038 #include <rtems/bspIo.h>
0039 #include <rtems/malloc.h>
0040 #include <rtems/score/memory.h>
0041
0042 #include <bspopts.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif /* __cplusplus */
0047
0048 /**
0049  * @defgroup RTEMSBSPsSharedStartup Bootcard
0050  *
0051  * @ingroup RTEMSBSPsShared
0052  *
0053  * @brief Standard system startup.
0054  *
0055  * @{
0056  */
0057
0058 /**
0059  * @brief Global pointer to the command line of boot_card().
0060  */
0061 extern const char *bsp_boot_cmdline;
0062
0063 void bsp_start(void);
0064
0065 RTEMS_NO_RETURN void bsp_reset(rtems_fatal_source source, rtems_fatal_code code);
0066
0067 /**
0068  * @brief Standard system initialization procedure.
0069  *
0070  * You may pass a command line in @a cmdline.  It is later available via the
0071  * global @ref bsp_boot_cmdline variable.
0072  *
0073  * This is the C entry point for ALL RTEMS BSPs.  It is invoked from the
0074  * assembly language initialization file usually called @c start.S which does
0075  * the basic CPU setup (stack, C runtime environment, zero BSS, load other
0076  * sections) and calls afterwards boot_card().  The boot card function provides
0077  * the framework for the BSP initialization sequence.  For the basic flow of
0078  * initialization see RTEMS C User's Guide, Initialization Manager.
0079  *
0080  * This style of initialization ensures that the C++ global constructors are
0081  * executed after RTEMS is initialized.
0082  */
0083 RTEMS_NO_RETURN void boot_card(const char *cmdline);
0084
0085 struct Per_CPU_Control;
0086
0087 /**
0088  * @brief Standard start routine for secondary processors.
0089  *
0090  * This function is usually called by low-level startup code of secondary
0091  * processors or boot loaders starting a secondary processor.  The final step
0092  * of this function is a call to
0093  * _SMP_Start_multitasking_on_secondary_processor().
0094  */
0095 void bsp_start_on_secondary_processor(struct Per_CPU_Control *cpu_self);
0096
0097 /** @} */
0098
0099 #ifdef __cplusplus
0100 }
0101 #endif /* __cplusplus */
0102
0103 #endif /* LIBBSP_SHARED_BOOTCARD_H */