include/bsp/start.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup powerpc_start
0007  *
0008  * @brief System low level start.
0009  */
0010
0011 /*
0012  * Copyright (c) 2010 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef LIBBSP_POWERPC_SHARED_START_H
0037 #define LIBBSP_POWERPC_SHARED_START_H
0038
0039 #include <stddef.h>
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 /**
0046  * @defgroup RTEMSBSPsPowerPCSharedStart PowerPC System Start
0047  *
0048  * @ingroup RTEMSBSPsPowerPCShared
0049  *
0050  * @brief PowerPC low level start.
0051  *
0052  * @{
0053  */
0054
0055 #define BSP_START_TEXT_SECTION __attribute__((section(".bsp_start_text")))
0056
0057 #define BSP_START_DATA_SECTION __attribute__((section(".bsp_start_data")))
0058
0059 /**
0060 * @brief System start entry.
0061 */
0062 void _start(void);
0063
0064 /**
0065  * Zeros @a byte_count bytes starting at @a begin.
0066  *
0067  * It wraps around in case of an address overflow.  The stack will not be used.
0068  * The code is position independent.  It uses the data cache block zero
0069  * instruction in case the data cache is enabled.  There are no alignment
0070  * constains for @a begin and @a byte_count.
0071  *
0072  * @see bsp_start_zero_begin, bsp_start_zero_end, and bsp_start_zero_size.
0073  */
0074 void BSP_START_TEXT_SECTION bsp_start_zero(void *begin, size_t byte_count);
0075
0076 /**
0077  * @brief Symbol which equals the bsp_start_zero() code begin.
0078  */
0079 extern char bsp_start_zero_begin [];
0080
0081 /**
0082  * @brief Symbol which equals the bsp_start_zero() code end.
0083  */
0084 extern char bsp_start_zero_end [];
0085
0086 /**
0087  * @brief Symbol which equals the bsp_start_zero() code size.
0088  */
0089 extern char bsp_start_zero_size [];
0090
0091 /** @} */
0092
0093 #ifdef __cplusplus
0094 }
0095 #endif /* __cplusplus */
0096
0097 #endif /* LIBBSP_POWERPC_SHARED_START_H */