rtems/score/threadidledata.h

0001 /**
0002  * @file
0003  *
0004  * @ingroup RTEMSScoreThread
0005  *
0006  * @brief This header file provides data structures used by the implementation
0007  *   and the @ref RTEMSImplApplConfig to define ::_Thread_Idle_stack_size and
0008  *   ::_Thread_Idle_body.
0009  */
0010
0011 /*
0012  * SPDX-License-Identifier: BSD-2-Clause
0013  *
0014  * Copyright (C) 2020 embedded brains GmbH & Co. KG
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _RTEMS_SCORE_THREADIDLEDATA_H
0039 #define _RTEMS_SCORE_THREADIDLEDATA_H
0040
0041 #include <rtems/score/basedefs.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /**
0048  * @addtogroup RTEMSScoreThread
0049  *
0050  * @{
0051  */
0052
0053 /**
0054  * @brief The idle thread stack size in bytes.
0055  *
0056  * This constant is defined by the application configuration via
0057  * <rtems/confdefs.h>.
0058  */
0059 extern const size_t _Thread_Idle_stack_size;
0060
0061 /**
0062  * @brief The idle thread body type.
0063  */
0064 typedef void *( *Thread_Idle_body )( uintptr_t );
0065
0066 /**
0067  * @brief The idle thread body.
0068  *
0069  * This constant is defined by the application configuration via
0070  * <rtems/confdefs.h>.
0071  */
0072 extern const Thread_Idle_body _Thread_Idle_body;
0073
0074 /** @} */
0075
0076 #ifdef __cplusplus
0077 }
0078 #endif
0079
0080 #endif /* _RTEMS_SCORE_THREADIDLEDATA_H */