diff options
Diffstat (limited to 'cpukit/include/rtems')
22 files changed, 871 insertions, 0 deletions
diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h index b8a48e8237..8cda0452e3 100644 --- a/cpukit/include/rtems/bspIo.h +++ b/cpukit/include/rtems/bspIo.h @@ -188,6 +188,10 @@ void rtems_put_char( int c, void *unused ); * @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. @@ -224,6 +228,10 @@ int putk( const char *s ); * @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. @@ -262,6 +270,10 @@ RTEMS_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... ); * @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. @@ -302,6 +314,10 @@ int vprintk( const char *fmt, va_list ap ); * @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. diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h index 3d51fd6b5d..423d9d12e1 100644 --- a/cpukit/include/rtems/config.h +++ b/cpukit/include/rtems/config.h @@ -137,6 +137,15 @@ extern "C" { * * @brief This flag is used in augment a resource number so that it indicates * an unlimited resource. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * 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_UNLIMITED_OBJECTS OBJECTS_UNLIMITED_OBJECTS @@ -187,6 +196,10 @@ extern "C" { * @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. @@ -201,6 +214,15 @@ uintptr_t rtems_configuration_get_stack_space_size( void ); * * @brief This constant evaluates to #TRUE, if this processor variant has * hardware floating point support, otherwise to #FALSE. + * + * @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_HAS_HARDWARE_FP CPU_HARDWARE_FP @@ -256,6 +278,10 @@ typedef Stack_Allocator_free rtems_stack_free_hook; * @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. @@ -276,6 +302,10 @@ const char *rtems_get_build_label( 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. @@ -310,6 +340,10 @@ const char *rtems_get_copyright_notice( 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. @@ -334,6 +368,10 @@ const char *rtems_get_target_hash( 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. @@ -360,6 +398,10 @@ const char *rtems_get_version_string( 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. @@ -601,6 +643,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -681,6 +727,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -760,6 +810,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -781,6 +835,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -803,6 +861,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -830,6 +892,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -855,6 +921,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -880,6 +950,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. @@ -911,6 +985,10 @@ uint32_t rtems_configuration_get_maximum_extensions( 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. diff --git a/cpukit/include/rtems/cpuuse.h b/cpukit/include/rtems/cpuuse.h index 86338a7332..51ad17fb0e 100644 --- a/cpukit/include/rtems/cpuuse.h +++ b/cpukit/include/rtems/cpuuse.h @@ -90,6 +90,10 @@ struct rtems_printer; * @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. @@ -111,6 +115,10 @@ int rtems_cpu_info_report( const struct rtems_printer *printer ); * @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. * @@ -135,6 +143,10 @@ void rtems_cpu_usage_report( 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 device driver initialization * context. * @@ -182,6 +194,10 @@ void rtems_cpu_usage_reset( 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 task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -210,6 +226,10 @@ void rtems_cpu_usage_top( 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 task context. * * * The directive may obtain and release the object allocator mutex. This may diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h index 1cc59076fe..3711d41f70 100644 --- a/cpukit/include/rtems/fatal.h +++ b/cpukit/include/rtems/fatal.h @@ -180,6 +180,10 @@ RTEMS_NO_RETURN static inline void rtems_fatal( * @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 return to the caller. @@ -209,6 +213,15 @@ RTEMS_NO_RETURN RTEMS_PRINTFLIKE( 1, 2 ) void rtems_panic( * * The exception frame is printed in an architecture-dependent format using * printk(). + * + * @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 */ static inline void rtems_exception_frame_print( const rtems_exception_frame *frame @@ -235,6 +248,10 @@ static inline void rtems_exception_frame_print( * @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. * @endparblock */ @@ -259,6 +276,10 @@ const char *rtems_fatal_source_text( rtems_fatal_source fatal_source ); * @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. * @endparblock */ @@ -286,6 +307,10 @@ const char *rtems_internal_error_text( rtems_fatal_code internal_error_code ); * @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 return to the caller. diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h index d386a0bcea..90dfa3bf92 100644 --- a/cpukit/include/rtems/init.h +++ b/cpukit/include/rtems/init.h @@ -96,6 +96,10 @@ extern "C" { * @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 should be called by boot_card() only. * * * The directive will not return to the caller. @@ -120,6 +124,10 @@ RTEMS_NO_RETURN void rtems_initialize_executive( 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 return to the caller. diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h index 181da9fe4f..ecc89e16a2 100644 --- a/cpukit/include/rtems/io.h +++ b/cpukit/include/rtems/io.h @@ -228,6 +228,15 @@ typedef struct { * After a successful registration, the rtems_io_initialize() directive will be * called to initialize the device. * @endparblock + * + * @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 */ rtems_status_code rtems_io_register_driver( rtems_device_major_number major, @@ -254,6 +263,15 @@ rtems_status_code rtems_io_register_driver( * * @par Notes * Currently no specific checks are made and the driver is not closed. + * + * @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 */ rtems_status_code rtems_io_unregister_driver( rtems_device_major_number major @@ -294,6 +312,15 @@ rtems_status_code rtems_io_unregister_driver( * hardware and data structures associated with a device. If necessary, it can * allocate memory to be used during other operations. * @endparblock + * + * @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 */ rtems_status_code rtems_io_initialize( rtems_device_major_number major, @@ -322,6 +349,15 @@ rtems_status_code rtems_io_initialize( * * @par Notes * The device is registered as a character device. + * + * @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 */ rtems_status_code rtems_io_register_name( const char *device_name, @@ -354,6 +390,15 @@ rtems_status_code rtems_io_register_name( * @par Notes * The open entry point is commonly used by device drivers to provide exclusive * access to a device. + * + * @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 */ rtems_status_code rtems_io_open( rtems_device_major_number major, @@ -386,6 +431,15 @@ rtems_status_code rtems_io_open( * @par Notes * The close entry point is commonly used by device drivers to relinquish * exclusive access to a device. + * + * @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 */ rtems_status_code rtems_io_close( rtems_device_major_number major, @@ -420,6 +474,15 @@ rtems_status_code rtems_io_close( * Read operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be replaced with data * from the device. + * + * @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 */ rtems_status_code rtems_io_read( rtems_device_major_number major, @@ -452,6 +515,15 @@ rtems_status_code rtems_io_read( * @par Notes * Write operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be sent to the device. + * + * @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 */ rtems_status_code rtems_io_write( rtems_device_major_number major, @@ -489,6 +561,15 @@ rtems_status_code rtems_io_write( * device drivers are compatible. For example, an RS-232 driver I/O control * operation may change the baud of a serial line, while an I/O control * operation for a floppy disk driver may cause a seek operation. + * + * @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 */ rtems_status_code rtems_io_control( rtems_device_major_number major, diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h index e869769393..d0e5e9593c 100644 --- a/cpukit/include/rtems/rtems/cache.h +++ b/cpukit/include/rtems/rtems/cache.h @@ -93,6 +93,10 @@ extern "C" { * @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. * @@ -145,6 +149,10 @@ void rtems_cache_coherent_add_area( void *begin, uintptr_t size ); * @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. * @@ -171,6 +179,10 @@ void *rtems_cache_coherent_allocate( * @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. * @@ -640,6 +652,10 @@ void rtems_cache_disable_instruction( 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 device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h index 7b460ea4fb..6186d82319 100644 --- a/cpukit/include/rtems/rtems/clock.h +++ b/cpukit/include/rtems/rtems/clock.h @@ -209,6 +209,10 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day ); * @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. @@ -830,6 +834,10 @@ void rtems_clock_get_boot_time_timeval( struct timeval *boot_time ); * @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. @@ -949,6 +957,10 @@ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime ); * @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. @@ -974,6 +986,10 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime ); * @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. @@ -999,6 +1015,10 @@ time_t rtems_clock_get_uptime_seconds( 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. @@ -1025,6 +1045,10 @@ uint64_t rtems_clock_get_uptime_nanoseconds( 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. @@ -1054,6 +1078,10 @@ static inline rtems_interval rtems_clock_tick_later( rtems_interval delta ) * @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. @@ -1115,6 +1143,10 @@ static inline rtems_interval rtems_clock_tick_later_usec( * @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. @@ -1140,6 +1172,10 @@ static inline bool rtems_clock_tick_before( rtems_interval ticks ) * @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 interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h index 4a6e6c8e2e..04c71d5e42 100644 --- a/cpukit/include/rtems/rtems/config.h +++ b/cpukit/include/rtems/rtems/config.h @@ -428,6 +428,10 @@ uint32_t rtems_configuration_get_maximum_timers( 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. diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h index 855ea3ddc6..a913cfef89 100644 --- a/cpukit/include/rtems/rtems/dpmem.h +++ b/cpukit/include/rtems/rtems/dpmem.h @@ -129,6 +129,10 @@ extern "C" { * @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. * @@ -195,6 +199,10 @@ rtems_status_code rtems_port_create( * @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. @@ -225,6 +233,10 @@ rtems_status_code rtems_port_ident( rtems_name name, 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 may be called from within device driver initialization * context. * @@ -272,6 +284,10 @@ rtems_status_code rtems_port_delete( 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 may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -319,6 +335,10 @@ rtems_status_code rtems_port_external_to_internal( * @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 interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h index 8d4424e628..fe5830ba06 100644 --- a/cpukit/include/rtems/rtems/event.h +++ b/cpukit/include/rtems/rtems/event.h @@ -440,6 +440,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket close. + * + * @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_EVENT_SYSTEM_NETWORK_CLOSE RTEMS_EVENT_26 @@ -448,6 +457,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket buffer wait usage. + * + * @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_EVENT_SYSTEM_NETWORK_SBWAIT RTEMS_EVENT_24 @@ -456,6 +474,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket sleep. + * + * @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_EVENT_SYSTEM_NETWORK_SOSLEEP RTEMS_EVENT_25 @@ -533,6 +560,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event for * server thread usage, for example the timer or interrupt server. + * + * @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_EVENT_SYSTEM_SERVER RTEMS_EVENT_30 @@ -541,6 +577,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event to * resume a server thread, for example the timer or interrupt server. + * + * @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_EVENT_SYSTEM_SERVER_RESUME RTEMS_EVENT_29 @@ -549,6 +594,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event for * transient usage. + * + * @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_EVENT_SYSTEM_TRANSIENT RTEMS_EVENT_31 @@ -561,6 +615,10 @@ rtems_status_code rtems_event_system_send( * @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. * @@ -594,6 +652,10 @@ static inline void rtems_event_transient_clear( 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 device driver initialization * context. * @@ -628,6 +690,10 @@ static inline rtems_status_code rtems_event_transient_receive( * @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 interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h index 021b9e3e94..6bf6150b93 100644 --- a/cpukit/include/rtems/rtems/intr.h +++ b/cpukit/include/rtems/rtems/intr.h @@ -172,6 +172,10 @@ typedef ISR_Handler rtems_isr; * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -251,6 +255,10 @@ rtems_status_code rtems_interrupt_catch( * @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. @@ -293,6 +301,10 @@ rtems_status_code rtems_interrupt_catch( * @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. @@ -341,6 +353,10 @@ rtems_status_code rtems_interrupt_catch( * @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. @@ -487,6 +503,10 @@ rtems_status_code rtems_interrupt_catch( * @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. @@ -925,6 +945,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler shared option * #RTEMS_INTERRUPT_SHARED is set, otherwise false. + * + * @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_INTERRUPT_IS_SHARED( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_SHARED ) @@ -938,6 +967,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler unique option * #RTEMS_INTERRUPT_UNIQUE is set, otherwise false. + * + * @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_INTERRUPT_IS_UNIQUE( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_UNIQUE ) @@ -951,6 +989,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler replace option * #RTEMS_INTERRUPT_REPLACE is set, otherwise false. + * + * @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_INTERRUPT_IS_REPLACE( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_REPLACE ) @@ -1301,6 +1348,10 @@ rtems_status_code rtems_interrupt_entry_remove( * @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. * @@ -1351,6 +1402,10 @@ rtems_status_code rtems_interrupt_handler_install( * @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. * @@ -2062,6 +2117,15 @@ rtems_status_code rtems_interrupt_handler_iterate( * @ingroup RTEMSAPIClassicIntr * * @brief The constant represents the index of the default interrupt server. + * + * @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_INTERRUPT_SERVER_DEFAULT 0 @@ -2228,6 +2292,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 device driver initialization * context. * @@ -2276,6 +2344,10 @@ rtems_status_code rtems_interrupt_server_initialize( * @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. * @@ -2354,6 +2426,10 @@ rtems_status_code rtems_interrupt_server_create( * @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. * @@ -2405,6 +2481,10 @@ rtems_status_code rtems_interrupt_server_handler_install( * @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 task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -2469,6 +2549,10 @@ rtems_status_code rtems_interrupt_server_handler_remove( * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -2517,6 +2601,10 @@ rtems_status_code rtems_interrupt_server_set_affinity( * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -2552,6 +2640,10 @@ rtems_status_code rtems_interrupt_server_delete( uint32_t server_index ); * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -2587,6 +2679,10 @@ rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index ); * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -2632,6 +2728,10 @@ rtems_status_code rtems_interrupt_server_resume( uint32_t server_index ); * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -2689,6 +2789,10 @@ rtems_status_code rtems_interrupt_server_move( * @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. * @@ -2801,6 +2905,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 device driver initialization * context. * @@ -2841,6 +2949,10 @@ rtems_status_code rtems_interrupt_server_entry_initialize( * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -2894,6 +3006,10 @@ void rtems_interrupt_server_action_prepend( * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -2943,6 +3059,10 @@ void rtems_interrupt_server_entry_destroy( * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -2992,6 +3112,10 @@ void rtems_interrupt_server_entry_submit( * @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. * @@ -3088,6 +3212,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 device driver initialization * context. * @@ -3130,6 +3258,10 @@ rtems_status_code rtems_interrupt_server_request_initialize( * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -3181,6 +3313,10 @@ static inline void rtems_interrupt_server_request_set_vector( * @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 task context. * * * The directive shall not be called from within the context of an interrupt @@ -3232,6 +3368,10 @@ static inline void rtems_interrupt_server_request_destroy( * @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 interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h index 0a76b1f9b8..7cb0591e67 100644 --- a/cpukit/include/rtems/rtems/message.h +++ b/cpukit/include/rtems/rtems/message.h @@ -248,6 +248,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 device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h index 038a84676d..6f70519756 100644 --- a/cpukit/include/rtems/rtems/modes.h +++ b/cpukit/include/rtems/rtems/modes.h @@ -161,6 +161,15 @@ extern "C" { * @par Notes * This task mode constant is used by bindings from languages other than C and * C++. + * + * @par Constraints + * @parblock + * The following constraints apply to this object: + * + * * 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 */ extern const uint32_t rtems_interrupt_mask; @@ -187,6 +196,15 @@ typedef uint32_t rtems_mode; * * @par Notes * This function is used by bindings from languages other than C and C++. + * + * @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 */ rtems_mode rtems_interrupt_level_body( uint32_t level ); diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h index 614a65fe4c..c2ff0e7db7 100644 --- a/cpukit/include/rtems/rtems/mp.h +++ b/cpukit/include/rtems/rtems/mp.h @@ -122,6 +122,10 @@ extern "C" { * @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 interrupt context. * * * The directive may be called from within device driver initialization @@ -145,6 +149,15 @@ void rtems_multiprocessing_announce( void ); * * In packets longer than this value, some of the extra data may be a user * message buffer which is not automatically endian swapped. + * + * @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_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION @@ -155,6 +168,15 @@ void rtems_multiprocessing_announce( void ); * * @brief This constant defines the minimum packet size which must be supported * by the MPCI. + * + * @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_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE 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. diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h index 7c789a204b..015cb95680 100644 --- a/cpukit/include/rtems/rtems/ratemon.h +++ b/cpukit/include/rtems/rtems/ratemon.h @@ -572,6 +572,10 @@ rtems_status_code rtems_rate_monotonic_get_status( * @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 task context. * * * The directive may be called from within interrupt context. @@ -605,6 +609,10 @@ rtems_status_code rtems_rate_monotonic_get_statistics( * @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 task context. * * * The directive may be called from within interrupt context. @@ -628,6 +636,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( 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 may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -650,6 +662,10 @@ void rtems_rate_monotonic_reset_all_statistics( 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 task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -674,6 +690,10 @@ void rtems_rate_monotonic_report_statistics( 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 task context. * * * The directive may obtain and release the object allocator mutex. This may diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h index 94a8d7008f..2bffb6e705 100644 --- a/cpukit/include/rtems/rtems/region.h +++ b/cpukit/include/rtems/rtems/region.h @@ -115,6 +115,10 @@ extern "C" { * @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. * @@ -210,6 +214,10 @@ rtems_status_code rtems_region_get_segment_size( * @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. * @@ -277,6 +285,10 @@ rtems_status_code rtems_region_create( * @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. @@ -314,6 +326,10 @@ rtems_status_code rtems_region_ident( rtems_name name, 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 may be called from within device driver initialization * context. * @@ -371,6 +387,10 @@ rtems_status_code rtems_region_delete( 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 may be called from within device driver initialization * context. * @@ -470,6 +490,10 @@ rtems_status_code rtems_region_extend( * @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. * @@ -533,6 +557,10 @@ rtems_status_code rtems_region_get_segment( * @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. * @@ -590,6 +618,10 @@ rtems_status_code rtems_region_return_segment( rtems_id id, void *segment ); * @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. * @@ -647,6 +679,10 @@ rtems_status_code rtems_region_resize_segment( * @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. * @@ -704,6 +740,10 @@ rtems_status_code rtems_region_get_information( * @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. * diff --git a/cpukit/include/rtems/rtems/scheduler.h b/cpukit/include/rtems/rtems/scheduler.h index 8bd041558f..df02d17da1 100644 --- a/cpukit/include/rtems/rtems/scheduler.h +++ b/cpukit/include/rtems/rtems/scheduler.h @@ -282,6 +282,10 @@ rtems_status_code rtems_scheduler_get_maximum_priority( * @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. @@ -323,6 +327,10 @@ rtems_status_code rtems_scheduler_map_priority_to_posix( * @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. diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h index 29bcb27dc1..908088f813 100644 --- a/cpukit/include/rtems/rtems/status.h +++ b/cpukit/include/rtems/rtems/status.h @@ -298,6 +298,15 @@ typedef enum { * @retval EPERM The status code was ::RTEMS_NOT_OWNER_OF_RESOURCE. * * @retval ETIMEDOUT The status code was ::RTEMS_TIMEOUT. + * + * @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 */ int rtems_status_code_to_errno( rtems_status_code status_code ); diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h index 356e29739b..2da84d43bb 100644 --- a/cpukit/include/rtems/rtems/support.h +++ b/cpukit/include/rtems/rtems/support.h @@ -122,6 +122,10 @@ static inline bool rtems_is_name_valid( rtems_name 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. @@ -145,6 +149,10 @@ static inline bool rtems_is_name_valid( rtems_name 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. @@ -173,6 +181,10 @@ static inline bool rtems_is_name_valid( rtems_name 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. @@ -243,6 +255,10 @@ static inline void rtems_name_to_characters( * @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. * @@ -270,6 +286,10 @@ bool rtems_workspace_allocate( size_t bytes, void **pointer ); * @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. * @@ -299,6 +319,10 @@ bool rtems_workspace_free( void *pointer ); * @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. * @@ -327,6 +351,15 @@ bool rtems_workspace_get_information( Heap_Information_block *the_info ); * * @return The returned pointer value may be used to free the greedy allocation * by calling rtems_workspace_greedy_free(). + * + * @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 */ void *rtems_workspace_greedy_allocate( const uintptr_t *block_sizes, @@ -357,6 +390,10 @@ void *rtems_workspace_greedy_allocate( * @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. * @@ -388,6 +425,10 @@ void *rtems_workspace_greedy_allocate_all_except_largest( * @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. * diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h index 0f13c04bda..4e6c9c247e 100644 --- a/cpukit/include/rtems/rtems/timer.h +++ b/cpukit/include/rtems/rtems/timer.h @@ -82,6 +82,15 @@ extern "C" { * @ingroup RTEMSAPIClassicTimer * * @brief This timer class bit indicates that the timer is not dormant. + * + * @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 TIMER_CLASS_BIT_NOT_DORMANT 0x4 @@ -92,6 +101,15 @@ extern "C" { * * @brief This timer class bit indicates that the timer routine executes in a * task context. + * + * @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 TIMER_CLASS_BIT_ON_TASK 0x2 @@ -101,6 +119,15 @@ extern "C" { * @ingroup RTEMSAPIClassicTimer * * @brief This timer class bit indicates that the timer uses a time of day. + * + * @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 TIMER_CLASS_BIT_TIME_OF_DAY 0x1 @@ -208,6 +235,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 interrupt context. * * * The directive may be called from within device driver initialization |