diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/object.h')
-rw-r--r-- | cpukit/include/rtems/rtems/object.h | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h index 02b8ef01e2..2f2513893e 100644 --- a/cpukit/include/rtems/rtems/object.h +++ b/cpukit/include/rtems/rtems/object.h @@ -126,6 +126,15 @@ typedef struct { * @ingroup RTEMSAPIClassicObject * * @brief This constant represents the highest object identifier value. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL @@ -136,6 +145,15 @@ typedef struct { * * @brief This constant represents the highest value for the index component of * an object identifier. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX @@ -160,6 +178,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -175,6 +197,15 @@ typedef struct { * * @brief This constant represents the lowest value for the index component of * an object identifier. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX @@ -241,6 +272,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -256,6 +291,17 @@ rtems_id rtems_build_id( ); /* Generated from spec:/rtems/object/if/build-id-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_build_id( _api, _class, _node, _index ) \ _Objects_Build_id( _api, _class, _node, _index ) @@ -327,6 +373,10 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -374,6 +424,10 @@ rtems_status_code rtems_object_get_classic_name( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -427,6 +481,10 @@ char *rtems_object_get_name( rtems_id id, size_t length, char *name ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -456,6 +514,10 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -466,6 +528,17 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name ); int rtems_object_id_get_api( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-api-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_api( _id ) _Objects_Get_API( _id ) /* Generated from spec:/rtems/object/if/id-get-class */ @@ -486,6 +559,10 @@ int rtems_object_id_get_api( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -496,6 +573,17 @@ int rtems_object_id_get_api( rtems_id id ); int rtems_object_id_get_class( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-class-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_class( _id ) _Objects_Get_class( _id ) /* Generated from spec:/rtems/object/if/id-get-node */ @@ -516,6 +604,10 @@ int rtems_object_id_get_class( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -526,6 +618,17 @@ int rtems_object_id_get_class( rtems_id id ); int rtems_object_id_get_node( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-node-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_node( _id ) _Objects_Get_node( _id ) /* Generated from spec:/rtems/object/if/id-get-index */ @@ -546,6 +649,10 @@ int rtems_object_id_get_node( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -556,6 +663,17 @@ int rtems_object_id_get_node( rtems_id id ); int rtems_object_id_get_index( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-index-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_index( _id ) _Objects_Get_index( _id ) /* Generated from spec:/rtems/object/if/id-api-minimum */ @@ -573,6 +691,10 @@ int rtems_object_id_get_index( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -583,6 +705,17 @@ int rtems_object_id_get_index( rtems_id id ); int rtems_object_id_api_minimum( void ); /* Generated from spec:/rtems/object/if/id-api-minimum-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_api_minimum() OBJECTS_INTERNAL_API /* Generated from spec:/rtems/object/if/id-api-maximum */ @@ -600,6 +733,10 @@ int rtems_object_id_api_minimum( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -610,6 +747,17 @@ int rtems_object_id_api_minimum( void ); int rtems_object_id_api_maximum( void ); /* Generated from spec:/rtems/object/if/id-api-maximum-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_api_maximum() OBJECTS_APIS_LAST /* Generated from spec:/rtems/object/if/api-minimum-class */ @@ -629,6 +777,10 @@ int rtems_object_id_api_maximum( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -653,6 +805,10 @@ int rtems_object_api_minimum_class( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -680,6 +836,10 @@ int rtems_object_api_maximum_class( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -712,6 +872,10 @@ const char *rtems_object_get_api_name( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -746,6 +910,10 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. |