diff options
Diffstat (limited to 'include/rtems/score/apiext.h')
-rw-r--r-- | include/rtems/score/apiext.h | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/include/rtems/score/apiext.h b/include/rtems/score/apiext.h new file mode 100644 index 0000000000..ab1329b261 --- /dev/null +++ b/include/rtems/score/apiext.h @@ -0,0 +1,89 @@ +/** + * @file rtems/score/apiext.h + * + * @brief API Extensions Handler + * + * This is the API Extensions Handler. + */ + +/* + * COPYRIGHT (c) 1989-2009. + * On-Line Applications Research Corporation (OAR). + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.org/license/LICENSE. + */ + +#ifndef _RTEMS_SCORE_APIEXT_H +#define _RTEMS_SCORE_APIEXT_H + +#include <rtems/score/chainimpl.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @defgroup ScoreAPIExtension API Extension Handler + * + * @ingroup Score + * + * This handler encapsulates functionality which provides mechanisms for the + * SuperCore to perform API specific actions without there beingg + * "up-references" from the SuperCore to APIs. If these referencesg + * were allowed in the implementation, the cohesion would be too high + * and adding an API would be more difficult. The SuperCore is supposed + * to be largely independent of any API. + */ +/**@{*/ + +/** + * This type defines the prototype of the Postdriver Hook. + */ +typedef void (*API_extensions_Postdriver_hook)(void); + +/** + * The control structure which defines the points at which an API + * can add an extension to the system initialization thread. + */ +typedef struct { + /** This field allows this structure to be used with the Chain Handler. */ + Chain_Node Node; + + /** + * This field is the callout invoked during RTEMS initialization after + * RTEMS data structures and device driver initialization has occurred + * but before multitasking is initiated. + * + * @note If this field is NULL, no extension is invoked. + */ + API_extensions_Postdriver_hook postdriver_hook; +} API_extensions_Control; + +/** + * @brief Add extension set to the active set. + * + * This routine adds @a the_extension to the active set of API extensions. + * + * @param[in] the_extension is the extension set to add. + */ +void _API_extensions_Add( + API_extensions_Control *the_extension +); + +/** + * @brief Execute all post-driver extensions. + * + * This routine executes all of the postdriver callouts. + */ +void _API_extensions_Run_postdriver( void ); + +/**@}*/ + +#ifdef __cplusplus +} +#endif + +#endif +/* end of include file */ |