diff options
Diffstat (limited to 'cpukit/include/rtems/rtems')
| -rw-r--r-- | cpukit/include/rtems/rtems/cache.h | 16 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/clock.h | 36 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/config.h | 4 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/dpmem.h | 20 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/event.h | 66 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/intr.h | 140 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/message.h | 4 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/modes.h | 18 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/mp.h | 22 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/object.h | 168 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/ratemon.h | 20 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/region.h | 40 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/scheduler.h | 8 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/status.h | 9 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/support.h | 41 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/timer.h | 31 |
16 files changed, 643 insertions, 0 deletions
diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h index 20c630a3eb..0153b39f30 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 5a8d0a44f9..18fefc119a 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 d225902bf1..356d622faa 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 62e34053ea..712855ac46 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 81aa57585f..a4c127fa5b 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 f682112bf5..f8809015e4 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 ) @@ -1308,6 +1355,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. * @@ -1358,6 +1409,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. * @@ -2069,6 +2124,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 @@ -2249,6 +2313,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. * @@ -2297,6 +2365,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. * @@ -2375,6 +2447,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. * @@ -2426,6 +2502,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 @@ -2490,6 +2570,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 @@ -2538,6 +2622,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 @@ -2573,6 +2661,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 @@ -2608,6 +2700,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 @@ -2653,6 +2749,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 @@ -2710,6 +2810,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. * @@ -2836,6 +2940,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. * @@ -2876,6 +2984,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 @@ -2929,6 +3041,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 @@ -2978,6 +3094,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 @@ -3027,6 +3147,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. * @@ -3130,6 +3254,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. * @@ -3172,6 +3300,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 @@ -3223,6 +3355,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 @@ -3274,6 +3410,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 0967430934..31a393c06a 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 f348941b24..9b55950f3e 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 5852f43381..f48fc082a7 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 bda9a469ed..5de6c73607 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 4b9255e635..d8d9f04bbf 100644 --- a/cpukit/include/rtems/rtems/ratemon.h +++ b/cpukit/include/rtems/rtems/ratemon.h @@ -573,6 +573,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. @@ -606,6 +610,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. @@ -629,6 +637,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 @@ -651,6 +663,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 @@ -675,6 +691,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 3d9c2bd8bc..b5ccd880e1 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. * @@ -211,6 +215,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. * @@ -278,6 +286,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. @@ -315,6 +327,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. * @@ -372,6 +388,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. * @@ -471,6 +491,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. * @@ -534,6 +558,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. * @@ -591,6 +619,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. * @@ -648,6 +680,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. * @@ -705,6 +741,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 bec4932c6c..3b3fe86c10 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 92a8b03c09..f51643d9f1 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 bb2e6e3633..d860053afe 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 6af56c1576..614e483d36 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 |