summaryrefslogtreecommitdiff
path: root/cpukit/include/rtems/rtems/support.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include/rtems/rtems/support.h')
-rw-r--r--cpukit/include/rtems/rtems/support.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h
index 60e090ccec..e53dbdb8b0 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -123,6 +123,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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_MICROSECONDS_TO_TICKS( _us ) \
@@ -148,6 +152,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* directive exists for bindings to other programming languages.
*
* * The directive will not cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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_MILLISECONDS_TO_MICROSECONDS( _ms ) ( ( _ms ) * 1000UL )
@@ -174,6 +182,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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_MILLISECONDS_TO_TICKS( _ms ) \
@@ -248,6 +260,10 @@ static inline void rtems_name_to_characters(
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
bool rtems_workspace_allocate( size_t bytes, void **pointer );
@@ -275,6 +291,10 @@ bool rtems_workspace_allocate( size_t bytes, void **pointer );
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
bool rtems_workspace_free( void *pointer );
@@ -304,6 +324,10 @@ bool rtems_workspace_free( void *pointer );
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
bool rtems_workspace_get_information( Heap_Information_block *the_info );
@@ -325,6 +349,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,
@@ -362,6 +395,10 @@ void *rtems_workspace_greedy_allocate(
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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_all_except_largest(
@@ -393,6 +430,10 @@ void *rtems_workspace_greedy_allocate_all_except_largest(
*
* * The directive may obtain and release the object allocator mutex. This may
* cause the calling task to be preempted.
+ *
+ * * The directive is not included in the pre-qualified feature 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_free( void *opaque );