summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-09-28 11:04:03 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-09 15:47:11 +0100
commit6476c46a2ad6447e038cf0012bf5619152a1153b (patch)
tree62eb50e3c963749b6809cbd908768af757f2012a
parente8af3e114318c45f93e626de5a2714c1a2d7888e (diff)
Add not pre-qualified constraints
-rw-r--r--cpukit/doxygen/appl-config.h376
-rw-r--r--cpukit/include/rtems/bspIo.h16
-rw-r--r--cpukit/include/rtems/config.h125
-rw-r--r--cpukit/include/rtems/fatal.h25
-rw-r--r--cpukit/include/rtems/init.h8
-rw-r--r--cpukit/include/rtems/io.h81
-rw-r--r--cpukit/include/rtems/irq-extension.h84
-rw-r--r--cpukit/include/rtems/rtems/cache.h16
-rw-r--r--cpukit/include/rtems/rtems/clock.h54
-rw-r--r--cpukit/include/rtems/rtems/config.h27
-rw-r--r--cpukit/include/rtems/rtems/dpmem.h40
-rw-r--r--cpukit/include/rtems/rtems/intr.h20
-rw-r--r--cpukit/include/rtems/rtems/message.h4
-rw-r--r--cpukit/include/rtems/rtems/mp.h4
-rw-r--r--cpukit/include/rtems/rtems/object.h141
-rw-r--r--cpukit/include/rtems/rtems/ratemon.h20
-rw-r--r--cpukit/include/rtems/rtems/region.h40
-rw-r--r--cpukit/include/rtems/rtems/status.h9
-rw-r--r--cpukit/include/rtems/rtems/support.h41
-rw-r--r--cpukit/include/rtems/rtems/tasks.h8
-rw-r--r--cpukit/include/rtems/rtems/timer.h4
21 files changed, 1109 insertions, 34 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index 1aed27bba6..5ce95949df 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -102,6 +102,11 @@
* * It shall be greater than or equal to zero.
*
* * It shall be an integral multiple of #CONFIGURE_BDBUF_BUFFER_MIN_SIZE.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_BDBUF_BUFFER_MAX_SIZE
@@ -126,6 +131,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_BDBUF_BUFFER_MIN_SIZE
@@ -150,6 +160,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
@@ -174,6 +189,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -203,6 +223,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_BDBUF_MAX_WRITE_BLOCKS
@@ -218,9 +243,18 @@
* The default value is 15.
*
* @par Value Constraints
- * The value of this configuration option shall be a valid Classic API task
- * priority. The set of valid task priorities depends on the scheduler
- * configuration.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a valid Classic API task priority. The set of valid task
+ * priorities depends on the scheduler configuration.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*/
#define CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
@@ -249,6 +283,11 @@
* * It shall be small enough so that the task stack space calculation carried
* out by ``<rtems/confdefs.h>`` does not overflow an integer of type <a
* href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_BDBUF_TASK_STACK_SIZE
@@ -273,6 +312,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_SWAPOUT_BLOCK_HOLD
@@ -297,6 +341,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_SWAPOUT_SWAP_PERIOD
@@ -312,9 +361,18 @@
* The default value is 15.
*
* @par Value Constraints
- * The value of this configuration option shall be a valid Classic API task
- * priority. The set of valid task priorities depends on the scheduler
- * configuration.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a valid Classic API task priority. The set of valid task
+ * priorities depends on the scheduler configuration.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*/
#define CONFIGURE_SWAPOUT_TASK_PRIORITY
@@ -338,6 +396,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_SWAPOUT_WORKER_TASKS
@@ -354,9 +417,18 @@
* The default value is 15.
*
* @par Value Constraints
- * The value of this configuration option shall be a valid Classic API task
- * priority. The set of valid task priorities depends on the scheduler
- * configuration.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a valid Classic API task priority. The set of valid task
+ * priorities depends on the scheduler configuration.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*/
#define CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
@@ -434,6 +506,11 @@
* * It shall be small enough so that the IDLE task stack area calculation
* carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type
* <a href="https://en.cppreference.com/w/c/types/size_t">size_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define BSP_IDLE_TASK_STACK_SIZE
@@ -495,6 +572,11 @@
* <a href="https://en.cppreference.com/w/c/types/size_t">size_t</a>.
*
* * It shall be aligned according to #CPU_INTERRUPT_STACK_ALIGNMENT.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define BSP_INTERRUPT_STACK_SIZE
@@ -517,8 +599,18 @@
* The default value is BSP-specific.
*
* @par Value Constraints
- * The value of this configuration option shall be a list of initializers for
- * structures of type ::rtems_extensions_table.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a list of initializers for structures of type
+ * ::rtems_extensions_table.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* The value of this configuration option is placed before the entries of all
@@ -770,6 +862,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -807,6 +904,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -1262,6 +1364,11 @@
* * It shall be small enough so that the task stack space calculation carried
* out by ``<rtems/confdefs.h>`` does not overflow an integer of type <a
* href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -1365,8 +1472,18 @@
* The default value is the empty list.
*
* @par Value Constraints
- * The value of this configuration option shall be a list of initializers for
- * structures of type ::rtems_driver_address_table.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a list of initializers for structures of type
+ * ::rtems_driver_address_table.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -1737,8 +1854,18 @@
* The default value is the empty list.
*
* @par Value Constraints
- * The value of this configuration option shall be a list of initializers for
- * structures of type ::rtems_driver_address_table.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a list of initializers for structures of type
+ * ::rtems_driver_address_table.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -1763,9 +1890,18 @@
* The default value is 140.
*
* @par Value Constraints
- * The value of this configuration option shall be a valid Classic API task
- * priority. The set of valid task priorities depends on the scheduler
- * configuration.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a valid Classic API task priority. The set of valid task
+ * priorities depends on the scheduler configuration.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* This configuration option is only evaluated if the configuration option
@@ -1858,6 +1994,11 @@
* * It shall be less than or equal to a BSP-specific and application-specific
* value which depends on the size of the memory available to the
* application.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -1984,6 +2125,11 @@
* * It shall be less than or equal to a BSP-specific and application-specific
* value which depends on the size of the memory available to the
* application.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -2437,8 +2583,17 @@
* The default value is 128.
*
* @par Value Constraints
- * The value of this configuration option shall be equal to 16, 32, 64, 128,
- * 256, or 512.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be equal to 16, 32, 64, 128, 256, or 512.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -2647,6 +2802,11 @@
* * It shall be less than or equal to a BSP-specific and application-specific
* value which depends on the size of the memory available to the
* application.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -2677,6 +2837,11 @@
* * It shall be small enough so that the task stack space calculation carried
* out by ``<rtems/confdefs.h>`` does not overflow an integer of type <a
* href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -2869,6 +3034,11 @@
* * It shall be less than or equal to a BSP-specific and application-specific
* value which depends on the size of the memory available to the
* application.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -2910,6 +3080,11 @@
* * It shall be small enough so that the RTEMS Workspace size calculation
* carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type
* <a href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -2946,6 +3121,11 @@
* * It shall be small enough so that the RTEMS Workspace size calculation
* carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type
* <a href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3190,8 +3370,18 @@
* The default value is 8.
*
* @par Value Constraints
- * The value of this configuration option shall meet the constraints of all
- * object classes to which it is applied.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall meet the constraints of all object classes to which it is
+ * applied.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -3427,6 +3617,11 @@
* calculation carried out by ``<rtems/confdefs.h>`` does not overflow an
* integer of type <a
* href="https://en.cppreference.com/w/c/types/size_t">size_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3476,6 +3671,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3509,6 +3709,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3538,6 +3743,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3565,8 +3775,17 @@
* The default value is ``&MPCI_table``.
*
* @par Value Constraints
- * The value of this configuration option shall be a pointer to
- * ::rtems_mpci_table.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be a pointer to ::rtems_mpci_table.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -3600,6 +3819,11 @@
*
* * It shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3660,6 +3884,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3698,6 +3927,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3745,6 +3979,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3784,6 +4023,11 @@
* * It shall be zero if the POSIX API is not enabled (e.g. RTEMS was built
* without the ``RTEMS_POSIX_API = True`` build configuration option).
* Otherwise a compile time error in the configuration file will occur.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3828,6 +4072,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3875,6 +4124,11 @@
* objects for the object class, if the value passed to
* rtems_resource_unlimited() satisfies all other constraints of the
* configuration option.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3911,6 +4165,11 @@
* * It shall be small enough so that the task stack space calculation carried
* out by ``<rtems/confdefs.h>`` does not overflow an integer of type <a
* href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -3965,6 +4224,11 @@
* * It shall be zero if the POSIX API is not enabled (e.g. RTEMS was built
* without the ``RTEMS_POSIX_API = True`` build configuration option).
* Otherwise a compile time error in the configuration file will occur.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -4002,6 +4266,11 @@
*
* * It shall be greater than or equal to a BSP-specific and
* application-specific minimum value.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE
@@ -4034,8 +4303,18 @@
* The default value is ``POSIX_Init``.
*
* @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
- * pointer of the type ``void *( *entry_point )( void * )``.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be defined to a valid function pointer of the type ``void *(
+ * *entry_point )( void * )``.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* The application shall provide the function referenced by this configuration
@@ -4064,6 +4343,11 @@
* * It shall be small enough so that the task stack space calculation carried
* out by ``<rtems/confdefs.h>`` does not overflow an integer of type <a
* href="https://en.cppreference.com/w/c/types/integer">uintptr_t</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*/
#define CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
@@ -4158,6 +4442,11 @@
* * It shall be less than or equal to a BSP-specific and application-specific
* value which depends on the size of the memory available to the
* application.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
* @endparblock
*
* @par Notes
@@ -4733,9 +5022,19 @@
* href="https://en.cppreference.com/w/c/types/NULL">NULL</a>.
*
* @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
- * pointer of the type ``void ( *initialize )( size_t )`` or to <a
- * href="https://en.cppreference.com/w/c/types/NULL">NULL</a>.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be defined to a valid function pointer of the type ``void (
+ * *initialize )( size_t )`` or to <a
+ * href="https://en.cppreference.com/w/c/types/NULL">NULL</a>.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -4793,11 +5092,20 @@
* The default value is a macro which supports the system heap allocator.
*
* @par Value Constraints
- * The value of this configuration option shall be defined to a macro which
- * accepts exactly one parameter and returns an unsigned integer. The
- * parameter will be an allocation size and the macro shall return this size
- * plus the overhead of the allocator to manage an allocation request for this
- * size.
+ * @parblock
+ * The value of this configuration option shall satisfy all of the following
+ * constraints:
+ *
+ * * It shall be defined to a macro which accepts exactly one parameter and
+ * returns an unsigned integer. The parameter will be an allocation size and
+ * the macro shall return this size plus the overhead of the allocator to
+ * manage an allocation request for this size.
+ *
+ * * The application configuration option is not included in the pre-qualified
+ * feature set of RTEMS. Applications which are restricted to only use
+ * interfaces of the pre-qualified feature set of RTEMS shall not use the
+ * application configuration option.
+ * @endparblock
*
* @par Notes
* This configuration option may be used if a custom task stack allocator is
diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h
index b8a48e8237..3c18e1dc87 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -191,6 +191,10 @@ void rtems_put_char( int c, void *unused );
* * 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
*/
int putk( const char *s );
@@ -229,6 +233,10 @@ int putk( const char *s );
* * The directive will not cause the calling task to be preempted.
*
* * Formatting of floating point numbers is not supported.
+ *
+ * * The directive is not included in the pre-qualified feature 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_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... );
@@ -267,6 +275,10 @@ RTEMS_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... );
* * The directive will not cause the calling task to be preempted.
*
* * Formatting of floating point numbers is not supported.
+ *
+ * * The directive is not included in the pre-qualified feature 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 vprintk( const char *fmt, va_list ap );
@@ -307,6 +319,10 @@ int vprintk( const char *fmt, va_list ap );
* * The directive will not cause the calling task to be preempted.
*
* * Formatting of floating point numbers is not supported.
+ *
+ * * The directive is not included in the pre-qualified feature 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_printk_printer( void *unused, const char *fmt, va_list ap );
diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h
index 32dd662b3e..f4cf23b572 100644
--- a/cpukit/include/rtems/config.h
+++ b/cpukit/include/rtems/config.h
@@ -121,6 +121,10 @@ extern "C" {
* * 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
*/
const char *rtems_get_build_label( void );
@@ -133,6 +137,15 @@ const char *rtems_get_build_label( void );
* @brief Gets the RTEMS copyright notice.
*
* @return Returns the pointer to the RTEMS copyright notice.
+ *
+ * @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
*/
const char *rtems_get_copyright_notice( void );
@@ -149,6 +162,15 @@ const char *rtems_get_copyright_notice( void );
*
* @par Notes
* See #CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY.
+ *
+ * @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_configuration_get_do_zero_of_workspace() _Memory_Zero_before_use
@@ -299,6 +321,15 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
*
* @par Notes
* See #CONFIGURE_INITIAL_EXTENSIONS.
+ *
+ * @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_configuration_get_number_of_initial_extensions() \
((uint32_t) _User_extensions_Initial_count)
@@ -349,6 +380,15 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
*
* @par Notes
* See #CONFIGURE_TASK_STACK_ALLOCATOR_INIT.
+ *
+ * @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_configuration_get_stack_allocate_init_hook() \
_Stack_Allocator_initialize
@@ -396,6 +436,15 @@ uint32_t rtems_configuration_get_maximum_extensions( void );
*
* @return Returns the thread stack space size in bytes of configured for this
* application.
+ *
+ * @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
*/
uintptr_t rtems_configuration_get_stack_space_size( void );
@@ -428,6 +477,10 @@ uintptr_t rtems_configuration_get_stack_space_size( void );
* * 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
*/
const char *rtems_get_target_hash( void );
@@ -461,6 +514,15 @@ const char *rtems_get_target_hash( void );
*
* @par Notes
* See #CONFIGURE_UNIFIED_WORK_AREAS.
+ *
+ * @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_configuration_get_unified_work_area() _Workspace_Is_unified
@@ -473,6 +535,15 @@ const char *rtems_get_target_hash( void );
*
* @return Returns the pointer to the initial extensions table configured for
* this application.
+ *
+ * @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_configuration_get_user_extension_table() \
_User_extensions_Initial_extensions
@@ -486,6 +557,15 @@ const char *rtems_get_target_hash( void );
*
* @return Returns the pointer to the MPCI configuration table configured for
* this application.
+ *
+ * @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
*/
#if defined(RTEMS_MULTIPROCESSING)
#define rtems_configuration_get_user_multiprocessing_table() \
@@ -502,6 +582,15 @@ const char *rtems_get_target_hash( void );
* @brief Gets the RTEMS version string.
*
* @return Returns the pointer to the RTEMS version string.
+ *
+ * @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
*/
const char *rtems_get_version_string( void );
@@ -515,6 +604,15 @@ const char *rtems_get_version_string( void );
*
* @return Returns the RTEMS Workspace size in bytes configured for this
* application.
+ *
+ * @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_configuration_get_work_space_size() \
( _Workspace_Size + \
@@ -545,6 +643,15 @@ const char *rtems_get_version_string( void );
* @par Notes
* This function is implemented as a macro and can be used to define compile
* time constants.
+ *
+ * @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_resource_is_unlimited( _resource ) \
_Objects_Is_unlimited( _resource )
@@ -563,6 +670,15 @@ const char *rtems_get_version_string( void );
* @par Notes
* This function is implemented as a macro and can be used to define compile
* time constants.
+ *
+ * @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_resource_maximum_per_allocation( _resource ) \
_Objects_Maximum_per_allocation( _resource )
@@ -620,6 +736,15 @@ typedef Stack_Allocator_free rtems_stack_free_hook;
* @par Notes
* This function is implemented as a macro and can be used to define compile
* time constants.
+ *
+ * @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_resource_unlimited( _resource ) \
( ( _resource ) | RTEMS_UNLIMITED_OBJECTS )
diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h
index 0253ab4343..9a654b6441 100644
--- a/cpukit/include/rtems/fatal.h
+++ b/cpukit/include/rtems/fatal.h
@@ -189,6 +189,10 @@ RTEMS_NO_RETURN static inline void rtems_fatal(
* on_exit().
*
* * The directive may terminate the system.
+ *
+ * * The directive is not included in the pre-qualified feature 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_NO_RETURN RTEMS_PRINTFLIKE( 1, 2 ) void rtems_panic(
@@ -207,6 +211,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
@@ -234,6 +247,10 @@ static inline void rtems_exception_frame_print(
* The following constraints apply to this directive:
*
* * The directive may be called from within any runtime context.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
const char *rtems_fatal_source_text( rtems_fatal_source fatal_source );
@@ -258,6 +275,10 @@ const char *rtems_fatal_source_text( rtems_fatal_source fatal_source );
* The following constraints apply to this directive:
*
* * The directive may be called from within any runtime context.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
const char *rtems_internal_error_text( rtems_fatal_code internal_error_code );
@@ -295,6 +316,10 @@ const char *rtems_internal_error_text( rtems_fatal_code internal_error_code );
* on_exit().
*
* * The directive may terminate the system.
+ *
+ * * The directive is not included in the pre-qualified feature 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_NO_RETURN void rtems_fatal_error_occurred( uint32_t fatal_code );
diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h
index a821f92107..2d7008cb59 100644
--- a/cpukit/include/rtems/init.h
+++ b/cpukit/include/rtems/init.h
@@ -97,6 +97,10 @@ extern "C" {
* * The directive should be called by boot_card() only.
*
* * The directive will not return to the caller.
+ *
+ * * The directive is not included in the pre-qualified feature 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_NO_RETURN void rtems_initialize_executive( void );
@@ -129,6 +133,10 @@ RTEMS_NO_RETURN void rtems_initialize_executive( void );
* on_exit().
*
* * The directive may terminate the system.
+ *
+ * * The directive is not included in the pre-qualified feature 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_NO_RETURN void rtems_shutdown_executive( uint32_t fatal_code );
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/irq-extension.h b/cpukit/include/rtems/irq-extension.h
index e45ea43004..2004d50559 100644
--- a/cpukit/include/rtems/irq-extension.h
+++ b/cpukit/include/rtems/irq-extension.h
@@ -494,6 +494,10 @@ rtems_status_code rtems_interrupt_entry_remove(
*
* * 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
*/
rtems_status_code rtems_interrupt_handler_install(
@@ -544,6 +548,10 @@ rtems_status_code rtems_interrupt_handler_install(
*
* * 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
*/
rtems_status_code rtems_interrupt_handler_remove(
@@ -1291,6 +1299,10 @@ typedef struct {
*
* * 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
*/
rtems_status_code rtems_interrupt_server_initialize(
@@ -1339,6 +1351,10 @@ rtems_status_code rtems_interrupt_server_initialize(
*
* * 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
*/
rtems_status_code rtems_interrupt_server_create(
@@ -1417,6 +1433,10 @@ rtems_status_code rtems_interrupt_server_create(
*
* * 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
*/
rtems_status_code rtems_interrupt_server_handler_install(
@@ -1472,6 +1492,10 @@ rtems_status_code rtems_interrupt_server_handler_install(
* * The directive shall not be called from within the context of an interrupt
* server. Calling the directive from within the context of an interrupt
* server is undefined behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_handler_remove(
@@ -1537,6 +1561,10 @@ rtems_status_code rtems_interrupt_server_handler_remove(
*
* * The directive may change the priority of a task. 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
*/
rtems_status_code rtems_interrupt_server_set_affinity(
@@ -1581,6 +1609,10 @@ rtems_status_code rtems_interrupt_server_set_affinity(
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_delete( uint32_t server_index );
@@ -1616,6 +1648,10 @@ rtems_status_code rtems_interrupt_server_delete( uint32_t server_index );
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_suspend( uint32_t server_index );
@@ -1651,6 +1687,10 @@ rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index );
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_resume( uint32_t server_index );
@@ -1696,6 +1736,10 @@ rtems_status_code rtems_interrupt_server_resume( uint32_t server_index );
*
* * The directive sends a request to another task and waits for a response.
* This may cause the calling task to be blocked and unblocked.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_move(
@@ -1752,6 +1796,10 @@ rtems_status_code rtems_interrupt_server_move(
*
* * 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
*/
rtems_status_code rtems_interrupt_server_handler_iterate(
@@ -1864,6 +1912,10 @@ typedef struct {
*
* * 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
*/
rtems_status_code rtems_interrupt_server_entry_initialize(
@@ -1925,6 +1977,10 @@ rtems_status_code rtems_interrupt_server_entry_initialize(
* * The directive shall not be called while the interrupt server entry is
* pending on or serviced by its current interrupt server. Calling the
* directive under these conditions is undefined behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_action_prepend(
@@ -1962,6 +2018,10 @@ void rtems_interrupt_server_action_prepend(
* * The interrupt server entry shall have been initialized by
* rtems_interrupt_server_entry_initialize() and further optional calls to
* rtems_interrupt_server_action_prepend().
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_entry_destroy(
@@ -2020,6 +2080,10 @@ void rtems_interrupt_server_entry_destroy(
* * The directive shall not be called concurrently with
* rtems_interrupt_server_entry_move() with the same interrupt server entry.
* Calling the directive under this condition is undefined behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_entry_submit(
@@ -2075,6 +2139,10 @@ void rtems_interrupt_server_entry_submit(
* * The directive shall not be called while the interrupt server entry is
* pending on or serviced by its current interrupt server. Calling the
* directive under these conditions is undefined behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_entry_move(
@@ -2151,6 +2219,10 @@ typedef struct {
*
* * 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
*/
rtems_status_code rtems_interrupt_server_request_initialize(
@@ -2211,6 +2283,10 @@ rtems_status_code rtems_interrupt_server_request_initialize(
* * The directive shall not be called while the interrupt server entry is
* pending on or serviced by its current interrupt server. Calling the
* directive under these conditions is undefined behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_request_set_vector(
@@ -2248,6 +2324,10 @@ static inline void rtems_interrupt_server_request_set_vector(
*
* * The interrupt server request shall have been initialized by
* rtems_interrupt_server_request_initialize().
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_request_destroy(
@@ -2305,6 +2385,10 @@ static inline void rtems_interrupt_server_request_destroy(
* rtems_interrupt_server_request_set_vector() with the same interrupt server
* request. Calling the directive under this condition is undefined
* behaviour.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_server_request_submit(
diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h
index c7c19b80e2..66f011ab69 100644
--- a/cpukit/include/rtems/rtems/cache.h
+++ b/cpukit/include/rtems/rtems/cache.h
@@ -98,6 +98,10 @@ extern "C" {
*
* * 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_cache_coherent_add_area( void *begin, uintptr_t size );
@@ -150,6 +154,10 @@ void rtems_cache_coherent_add_area( void *begin, uintptr_t size );
*
* * 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_cache_coherent_allocate(
@@ -176,6 +184,10 @@ void *rtems_cache_coherent_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_cache_coherent_free( void *ptr );
@@ -645,6 +657,10 @@ void rtems_cache_disable_instruction( void );
*
* * 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_cache_aligned_malloc( size_t size );
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index cd0bccb395..3e8800304f 100644
--- a/cpukit/include/rtems/rtems/clock.h
+++ b/cpukit/include/rtems/rtems/clock.h
@@ -214,6 +214,10 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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_clock_get_tod_timeval( struct timeval *time_of_day );
@@ -835,6 +839,10 @@ void rtems_clock_get_boot_time_timeval( struct timeval *boot_time );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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_clock_get_seconds_since_epoch(
@@ -868,6 +876,17 @@ rtems_status_code rtems_clock_get_seconds_since_epoch(
rtems_interval rtems_clock_get_ticks_per_second( void );
/* Generated from spec:/rtems/clock/if/get-ticks-per-second-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_clock_get_ticks_per_second() _Watchdog_Ticks_per_second
/* Generated from spec:/rtems/clock/if/get-ticks-since-boot */
@@ -899,6 +918,17 @@ rtems_interval rtems_clock_get_ticks_per_second( void );
rtems_interval rtems_clock_get_ticks_since_boot( void );
/* Generated from spec:/rtems/clock/if/get-ticks-since-boot-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_clock_get_ticks_since_boot() _Watchdog_Ticks_since_boot
/* Generated from spec:/rtems/clock/if/get-uptime */
@@ -954,6 +984,10 @@ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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_clock_get_uptime_timeval( struct timeval *uptime );
@@ -979,6 +1013,10 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
time_t rtems_clock_get_uptime_seconds( void );
@@ -1004,6 +1042,10 @@ time_t rtems_clock_get_uptime_seconds( void );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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
*/
uint64_t rtems_clock_get_uptime_nanoseconds( void );
@@ -1030,6 +1072,10 @@ uint64_t rtems_clock_get_uptime_nanoseconds( void );
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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 rtems_interval rtems_clock_tick_later( rtems_interval delta )
@@ -1059,6 +1105,10 @@ static inline rtems_interval rtems_clock_tick_later( rtems_interval delta )
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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 rtems_interval rtems_clock_tick_later_usec(
@@ -1120,6 +1170,10 @@ static inline rtems_interval rtems_clock_tick_later_usec(
* * The directive will not cause the calling task to be preempted.
*
* * The directive requires a Clock Driver.
+ *
+ * * The directive is not included in the pre-qualified feature 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 bool rtems_clock_tick_before( rtems_interval ticks )
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index 2a12c8f3cb..dad51f3fd9 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -178,6 +178,15 @@ typedef struct {
*
* @return Returns the pointer to the Classic API Configuration Table of this
* application.
+ *
+ * @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
*/
const rtems_api_configuration_table *
rtems_configuration_get_rtems_api_configuration( void );
@@ -259,6 +268,15 @@ uint32_t rtems_configuration_get_maximum_periods( void );
*
* @par Notes
* See #CONFIGURE_MAXIMUM_PORTS.
+ *
+ * @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
*/
uint32_t rtems_configuration_get_maximum_ports( void );
@@ -275,6 +293,15 @@ uint32_t rtems_configuration_get_maximum_ports( void );
*
* @par Notes
* See #CONFIGURE_MAXIMUM_REGIONS.
+ *
+ * @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
*/
uint32_t rtems_configuration_get_maximum_regions( void );
diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h
index 9ecdf3a170..aff6ac29d9 100644
--- a/cpukit/include/rtems/rtems/dpmem.h
+++ b/cpukit/include/rtems/rtems/dpmem.h
@@ -141,6 +141,14 @@ extern "C" {
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
+ *
+ * * The directive is not included in the pre-qualified feature 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 not included in the pre-qualified feature 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_port_create(
@@ -196,6 +204,14 @@ rtems_status_code rtems_port_create(
* * 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.
+ *
+ * * The directive is not included in the pre-qualified feature 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_port_ident( rtems_name name, rtems_id *id );
@@ -236,6 +252,14 @@ rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may free memory to the RTEMS Workspace.
+ *
+ * * The directive is not included in the pre-qualified feature 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 not included in the pre-qualified feature 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_port_delete( rtems_id id );
@@ -278,6 +302,14 @@ rtems_status_code rtems_port_delete( rtems_id id );
* * The directive may be called from within task 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.
+ *
+ * * The directive is not included in the pre-qualified feature 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_port_external_to_internal(
@@ -325,6 +357,14 @@ rtems_status_code rtems_port_external_to_internal(
* * The directive may be called from within task 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.
+ *
+ * * The directive is not included in the pre-qualified feature 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_port_internal_to_external(
diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h
index 7663541adc..de75279931 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -192,6 +192,10 @@ typedef ISR_Vector_number rtems_vector_number;
*
* * The directive is only available where the target architecture support
* enabled simple vectored interrupts.
+ *
+ * * The directive is not included in the pre-qualified feature 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_interrupt_catch(
@@ -268,6 +272,10 @@ rtems_status_code rtems_interrupt_catch(
* available. Its use will result in compiler warnings and linker errors.
* The rtems_interrupt_local_disable() and rtems_interrupt_local_enable()
* directives are available in all build configurations.
+ *
+ * * The directive is not included in the pre-qualified feature 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_disable( _isr_cookie ) _ISR_Local_disable( _isr_cookie )
@@ -315,6 +323,10 @@ rtems_status_code rtems_interrupt_catch(
* available. Its use will result in compiler warnings and linker errors.
* The rtems_interrupt_local_disable() and rtems_interrupt_local_enable()
* directives are available in all build configurations.
+ *
+ * * The directive is not included in the pre-qualified feature 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_enable( _isr_cookie ) _ISR_Local_enable( _isr_cookie )
@@ -358,6 +370,10 @@ rtems_status_code rtems_interrupt_catch(
* available. Its use will result in compiler warnings and linker errors.
* The rtems_interrupt_local_disable() and rtems_interrupt_local_enable()
* directives are available in all build configurations.
+ *
+ * * The directive is not included in the pre-qualified feature 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_flash( _isr_cookie ) _ISR_Local_flash( _isr_cookie )
@@ -499,6 +515,10 @@ rtems_status_code rtems_interrupt_catch(
* * 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_interrupt_is_in_progress() _ISR_Is_in_progress()
diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 0a76b1f9b8..5233dbc29e 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -270,6 +270,10 @@ typedef struct {
* * The number of global objects available to the application is configured
* through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration
* option.
+ *
+ * * The directive is not included in the pre-qualified feature 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_message_queue_create(
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 91c31047fb..413dd7ecf3 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -129,6 +129,10 @@ extern "C" {
*
* * The directive may unblock a task. 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_multiprocessing_announce( void );
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index e80303da28..5ac844d2d8 100644
--- a/cpukit/include/rtems/rtems/object.h
+++ b/cpukit/include/rtems/rtems/object.h
@@ -161,6 +161,10 @@ typedef struct {
* * 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_OBJECT_ID_INITIAL( _api, _class, _node ) \
@@ -244,6 +248,10 @@ typedef struct {
* 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
*/
rtems_id rtems_build_id(
@@ -254,6 +262,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 )
@@ -328,6 +347,10 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 );
* * 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
*/
rtems_status_code rtems_object_get_classic_name(
@@ -375,6 +398,10 @@ rtems_status_code rtems_object_get_classic_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
*/
char *rtems_object_get_name( rtems_id id, size_t length, char *name );
@@ -432,6 +459,10 @@ char *rtems_object_get_name( rtems_id id, size_t length, char *name );
*
* * 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
*/
rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
@@ -459,11 +490,26 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *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
*/
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 */
@@ -489,11 +535,26 @@ int rtems_object_id_get_api( rtems_id id );
* 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
*/
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 */
@@ -519,11 +580,26 @@ int rtems_object_id_get_class( rtems_id id );
* 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
*/
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 */
@@ -549,11 +625,26 @@ int rtems_object_id_get_node( rtems_id id );
* 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
*/
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 */
@@ -576,11 +667,26 @@ int rtems_object_id_get_index( rtems_id id );
* 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
*/
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 */
@@ -603,11 +709,26 @@ int rtems_object_id_api_minimum( void );
* 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
*/
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 */
@@ -630,6 +751,10 @@ int rtems_object_id_api_maximum( void );
* * 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
*/
int rtems_object_api_minimum_class( int api );
@@ -654,6 +779,10 @@ int rtems_object_api_minimum_class( int api );
* * 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
*/
int rtems_object_api_maximum_class( int api );
@@ -681,6 +810,10 @@ int rtems_object_api_maximum_class( int api );
* * 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
*/
const char *rtems_object_get_api_name( int api );
@@ -713,6 +846,10 @@ const char *rtems_object_get_api_name( int api );
* * 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
*/
const char *rtems_object_get_api_class_name( int the_api, int the_class );
@@ -747,6 +884,10 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class );
* * 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
*/
rtems_status_code rtems_object_get_class_information(
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 7c789a204b..526e951c39 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -577,6 +577,10 @@ rtems_status_code rtems_rate_monotonic_get_status(
* * The directive may be called from within interrupt 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
*/
rtems_status_code rtems_rate_monotonic_get_statistics(
@@ -610,6 +614,10 @@ rtems_status_code rtems_rate_monotonic_get_statistics(
* * The directive may be called from within interrupt 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
*/
rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );
@@ -632,6 +640,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );
*
* * 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_rate_monotonic_reset_all_statistics( void );
@@ -654,6 +666,10 @@ void rtems_rate_monotonic_reset_all_statistics( void );
*
* * 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_rate_monotonic_report_statistics( void );
@@ -678,6 +694,10 @@ void rtems_rate_monotonic_report_statistics( void );
*
* * 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_rate_monotonic_report_statistics_with_plugin(
diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h
index 1e35344f7d..1e11c30209 100644
--- a/cpukit/include/rtems/rtems/region.h
+++ b/cpukit/include/rtems/rtems/region.h
@@ -120,6 +120,10 @@ extern "C" {
*
* * 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
*/
rtems_status_code rtems_region_get_segment_size(
@@ -222,6 +226,10 @@ rtems_status_code rtems_region_get_segment_size(
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may allocate memory from the RTEMS
* Workspace.
+ *
+ * * The directive is not included in the pre-qualified feature 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_region_create(
@@ -278,6 +286,10 @@ rtems_status_code rtems_region_create(
* * 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
*/
rtems_status_code rtems_region_ident( rtems_name name, rtems_id *id );
@@ -325,6 +337,10 @@ rtems_status_code rtems_region_ident( rtems_name name, rtems_id *id );
*
* * Where the object class corresponding to the directive is configured to use
* unlimited objects, the directive may free memory to the RTEMS Workspace.
+ *
+ * * The directive is not included in the pre-qualified feature 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_region_delete( rtems_id id );
@@ -376,6 +392,10 @@ rtems_status_code rtems_region_delete( rtems_id id );
*
* * 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
*/
rtems_status_code rtems_region_extend(
@@ -481,6 +501,10 @@ rtems_status_code rtems_region_extend(
* call.
*
* * The timeout functionality of the directive requires a clock tick.
+ *
+ * * The directive is not included in the pre-qualified feature 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_region_get_segment(
@@ -541,6 +565,10 @@ rtems_status_code rtems_region_get_segment(
*
* * 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
*/
rtems_status_code rtems_region_return_segment( rtems_id id, void *segment );
@@ -595,6 +623,10 @@ rtems_status_code rtems_region_return_segment( rtems_id id, void *segment );
*
* * 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
*/
rtems_status_code rtems_region_resize_segment(
@@ -652,6 +684,10 @@ rtems_status_code rtems_region_resize_segment(
*
* * 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
*/
rtems_status_code rtems_region_get_information(
@@ -709,6 +745,10 @@ rtems_status_code rtems_region_get_information(
*
* * 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
*/
rtems_status_code rtems_region_get_free_information(
diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h
index 872bb9b2b3..429e5d4fbb 100644
--- a/cpukit/include/rtems/rtems/status.h
+++ b/cpukit/include/rtems/rtems/status.h
@@ -296,6 +296,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 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 );
diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h
index 8c6e8a3bca..7aeab24de5 100644
--- a/cpukit/include/rtems/rtems/tasks.h
+++ b/cpukit/include/rtems/rtems/tasks.h
@@ -637,6 +637,10 @@ rtems_status_code rtems_scheduler_get_maximum_priority(
* * 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
*/
rtems_status_code rtems_scheduler_map_priority_to_posix(
@@ -678,6 +682,10 @@ rtems_status_code rtems_scheduler_map_priority_to_posix(
* * 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
*/
rtems_status_code rtems_scheduler_map_priority_from_posix(
diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h
index 0f13c04bda..327f435fe5 100644
--- a/cpukit/include/rtems/rtems/timer.h
+++ b/cpukit/include/rtems/rtems/timer.h
@@ -216,6 +216,10 @@ typedef struct {
* * The directive may be called from within task 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
*/
rtems_status_code rtems_timer_get_information(