rtems/score/userextdata.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreUserExt
0007  *
0008  * @brief This header file provides data structures used by the implementation
0009  *   and the @ref RTEMSImplApplConfig to define
0010  *   ::_User_extensions_Initial_count, ::_User_extensions_Initial_extensions,
0011  *   and ::_User_extensions_Initial_switch_controls.
0012  */
0013
0014 /*
0015  *  COPYRIGHT (c) 1989-2009.
0016  *  On-Line Applications Research Corporation (OAR).
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0037  * POSSIBILITY OF SUCH DAMAGE.
0038  */
0039
0040 #ifndef _RTEMS_SCORE_USEREXTDATA_H
0041 #define _RTEMS_SCORE_USEREXTDATA_H
0042
0043 #include <rtems/score/userext.h>
0044 #include <rtems/score/chain.h>
0045
0046 #ifdef __cplusplus
0047 extern "C" {
0048 #endif
0049
0050 /**
0051  * @addtogroup RTEMSScoreUserExt
0052  *
0053  * @{
0054  */
0055
0056 /**
0057  * @brief Manages the switch callouts.
0058  *
0059  * They are managed separately from other extensions for performance reasons.
0060  */
0061 typedef struct {
0062   Chain_Node                              Node;
0063   User_extensions_thread_switch_extension thread_switch;
0064 }   User_extensions_Switch_control;
0065
0066 /**
0067  * @brief Manages each user extension set.
0068  *
0069  * The switch control is part of the extensions control even if not used due to
0070  * the extension not having a switch handler.
0071  */
0072 typedef struct {
0073   Chain_Node                     Node;
0074   User_extensions_Switch_control Switch;
0075   User_extensions_Table          Callouts;
0076 }   User_extensions_Control;
0077
0078 /**
0079  * @brief The count of initial user extensions.
0080  *
0081  * Application provided via <rtems/confdefs.h>.
0082  */
0083 extern const size_t _User_extensions_Initial_count;
0084
0085 /**
0086  * @brief The table of initial user extensions.
0087  *
0088  * Application provided via <rtems/confdefs.h>.
0089  */
0090 extern const User_extensions_Table _User_extensions_Initial_extensions[];
0091
0092 /**
0093  * @brief A spare switch control for each initial user extension.
0094  *
0095  * Application provided via <rtems/confdefs.h>.
0096  */
0097 extern User_extensions_Switch_control
0098   _User_extensions_Initial_switch_controls[];
0099
0100 /** @} */
0101
0102 #ifdef __cplusplus
0103 }
0104 #endif
0105
0106 #endif
0107 /* end of include file */