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>2022-01-18 14:35:46 +0100
commita82afa49d1308a5826fba47c692cfebc61206036 (patch)
treed2e5b1d1439ee18f30afb528e696237078e69a90
parentaa189ab4b5265a3d04a98e24a6a6b3bf8f1b93ab (diff)
Add not pre-qualified constraints
-rw-r--r--cpukit/doxygen/appl-config.h1912
-rw-r--r--cpukit/include/rtems/bspIo.h16
-rw-r--r--cpukit/include/rtems/config.h143
-rw-r--r--cpukit/include/rtems/cpuuse.h20
-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/rtems/cache.h16
-rw-r--r--cpukit/include/rtems/rtems/clock.h54
-rw-r--r--cpukit/include/rtems/rtems/config.h9
-rw-r--r--cpukit/include/rtems/rtems/dpmem.h20
-rw-r--r--cpukit/include/rtems/rtems/intr.h140
-rw-r--r--cpukit/include/rtems/rtems/message.h4
-rw-r--r--cpukit/include/rtems/rtems/modes.h18
-rw-r--r--cpukit/include/rtems/rtems/mp.h22
-rw-r--r--cpukit/include/rtems/rtems/object.h168
-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/scheduler.h8
-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.h4
-rw-r--r--cpukit/include/rtems/rtems/timer.h31
23 files changed, 2056 insertions, 753 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index 1aed27bba6..fc5f3c0b93 100644
--- a/cpukit/doxygen/appl-config.h
+++ b/cpukit/doxygen/appl-config.h
@@ -76,6 +76,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* Each option of the Block Device Cache (bdbuf) configuration can be
* explicitly set by the user with the configuration options below. The Block
@@ -94,14 +99,19 @@
* @par Default Value
* The default value is 4096.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be an integral multiple of #CONFIGURE_BDBUF_BUFFER_MIN_SIZE.
+ * * The value of the configuration option shall be an integral multiple of
+ * #CONFIGURE_BDBUF_BUFFER_MIN_SIZE.
* @endparblock
*/
#define CONFIGURE_BDBUF_BUFFER_MAX_SIZE
@@ -117,14 +127,18 @@
* @par Default Value
* The default value is 512.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*/
@@ -141,14 +155,18 @@
* @par Default Value
* The default value is 32768.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
* @endparblock
*/
@@ -165,14 +183,18 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -194,14 +216,18 @@
* @par Default Value
* The default value is 16.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*/
@@ -217,10 +243,18 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a valid Classic API task
+ * priority. The set of valid task priorities depends on the scheduler
+ * configuration.
+ * @endparblock
*/
#define CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY
@@ -235,19 +269,24 @@
* @par Default Value
* The default value is #RTEMS_MINIMUM_STACK_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ * * The value of the configuration option shall be greater than or equal to
+ * #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
- * * 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 value of the configuration option 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.
*
- * * 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
+ * * The value of the configuration option 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>.
* @endparblock
*/
@@ -264,14 +303,18 @@
* @par Default Value
* The default value is 1000.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*/
@@ -288,14 +331,18 @@
* @par Default Value
* The default value is 250.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*/
@@ -311,10 +358,18 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a valid Classic API task
+ * priority. The set of valid task priorities depends on the scheduler
+ * configuration.
+ * @endparblock
*/
#define CONFIGURE_SWAPOUT_TASK_PRIORITY
@@ -329,14 +384,18 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*/
@@ -353,231 +412,20 @@
* @par Default Value
* 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.
- */
-#define CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
-
-/** @} */
-
-/* Generated from spec:/acfg/if/group-bsp */
-
-/**
- * @defgroup RTEMSApplConfigBSPRelatedConfigurationOptions \
- * BSP Related Configuration Options
- *
- * @ingroup RTEMSApplConfig
- *
- * This section describes configuration options related to the BSP. Some
- * configuration options may have a BSP-specific setting which is defined by
- * ``<bsp.h>``. The BSP-specific settings can be disabled by the
- * #CONFIGURE_DISABLE_BSP_SETTINGS configuration option.
- *
- * @{
- */
-
-/* Generated from spec:/acfg/if/bsp-idle-task-body */
-
-/**
- * @brief This configuration option is an initializer define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then the value of this configuration option defines the default value of
- * #CONFIGURE_IDLE_TASK_BODY.
- *
- * @par Default Value
- * The default value is BSP-specific.
- *
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
- * pointer of the type ``void *( *idle_body )( uintptr_t )``.
- *
- * @par Notes
- * As it has knowledge of the specific CPU model, system controller logic, and
- * peripheral buses, a BSP-specific IDLE task may be capable of turning
- * components off to save power during extended periods of no task activity.
- */
-#define BSP_IDLE_TASK_BODY
-
-/* Generated from spec:/acfg/if/bsp-idle-task-stack-size */
-
-/**
- * @brief This configuration option is an integer define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then the value of this configuration option defines the default value of
- * #CONFIGURE_IDLE_TASK_STACK_SIZE.
- *
- * @par Default Value
- * The default value is BSP-specific.
- *
- * @par Value Constraints
- * @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
- *
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
- *
- * * 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>.
- * @endparblock
- */
-#define BSP_IDLE_TASK_STACK_SIZE
-
-/* Generated from spec:/acfg/if/bsp-initial-extension */
-
-/**
- * @brief This configuration option is an initializer define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then the value of this configuration option is used to initialize the table
- * of initial user extensions.
- *
- * @par Default Value
- * 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.
- *
- * @par Notes
- * The value of this configuration option is placed after the entries of all
- * other initial user extensions.
- */
-#define BSP_INITIAL_EXTENSION
-
-/* Generated from spec:/acfg/if/bsp-interrupt-stack-size */
-
-/**
- * @brief This configuration option is an integer define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then the value of this configuration option defines the default value of
- * #CONFIGURE_INTERRUPT_STACK_SIZE.
- *
- * @par Default Value
- * The default value is BSP-specific.
- *
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
+ * * The 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 configuration option.
*
- * * It shall be small enough so that the interrupt 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>.
- *
- * * It shall be aligned according to #CPU_INTERRUPT_STACK_ALIGNMENT.
+ * * The value of the configuration option shall be a valid Classic API task
+ * priority. The set of valid task priorities depends on the scheduler
+ * configuration.
* @endparblock
*/
-#define BSP_INTERRUPT_STACK_SIZE
-
-/* Generated from spec:/acfg/if/bsp-prerequisite-drivers */
-
-/**
- * @brief This configuration option is an initializer define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then the value of this configuration option is used to add BSP-provided
- * prerequisite drivers to the Device Driver Table.
- *
- * @par Default Value
- * 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.
- *
- * @par Notes
- * The value of this configuration option is placed before the entries of all
- * other initial user extensions (including
- * #CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS).
- */
-#define CONFIGURE_BSP_PREREQUISITE_DRIVERS
-
-/* Generated from spec:/acfg/if/disable-bsp-settings */
-
-/**
- * @brief This configuration option is a boolean feature define.
- *
- * In case this configuration option is defined, then the following BSP related
- * configuration options are undefined:
- *
- * * #BSP_IDLE_TASK_BODY
- *
- * * #BSP_IDLE_TASK_STACK_SIZE
- *
- * * #BSP_INITIAL_EXTENSION
- *
- * * #BSP_INTERRUPT_STACK_SIZE
- *
- * * #CONFIGURE_BSP_PREREQUISITE_DRIVERS
- *
- * * #CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
- *
- * @par Default Configuration
- * If this configuration option is undefined, then the described feature is not
- * enabled.
- */
-#define CONFIGURE_DISABLE_BSP_SETTINGS
-
-/* Generated from spec:/acfg/if/malloc-bsp-supports-sbrk */
-
-/**
- * @brief This configuration option is a boolean feature define.
- *
- * If
- *
- * * this configuration option is defined by the BSP
- *
- * * and #CONFIGURE_DISABLE_BSP_SETTINGS is undefined,
- *
- * then not all memory is made available to the C Program Heap immediately at
- * system initialization time. When malloc() or other standard memory
- * allocation functions are unable to allocate memory, they will call the BSP
- * supplied sbrk() function to obtain more memory.
- *
- * @par Default Configuration
- * If this configuration option is undefined, then the described feature is not
- * enabled.
- *
- * @par Notes
- * This option should not be defined by the application. Only the BSP knows how
- * it allocates memory to the C Program Heap.
- */
-#define CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
+#define CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
/** @} */
@@ -604,23 +452,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -641,23 +490,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -679,23 +529,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -716,23 +567,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -753,23 +605,28 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option 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 value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -790,23 +647,28 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -827,23 +689,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -873,27 +736,29 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * 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
+ * * The value of the configuration option 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>.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -931,17 +796,18 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * It shall be an integral multiple of #RTEMS_TASK_STORAGE_ALIGNMENT.
+ * * The value of the configuration option shall be an integral multiple of
+ * #RTEMS_TASK_STORAGE_ALIGNMENT.
* @endparblock
*
* @par Notes
@@ -976,23 +842,24 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -1013,18 +880,19 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -1043,14 +911,15 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to #CONFIGURE_MAXIMUM_TASKS.
+ * * The value of the configuration option shall be less than or equal to
+ * #CONFIGURE_MAXIMUM_TASKS.
* @endparblock
*
* @par Notes
@@ -1089,8 +958,8 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
- * The value of this configuration option shall be convertible to an integer of
+ * @par Constraints
+ * The value of the configuration option shall be convertible to an integer of
* type ::rtems_task_argument.
*/
#define CONFIGURE_INIT_TASK_ARGUMENTS
@@ -1106,8 +975,8 @@
* @par Default Value
* The default value is #RTEMS_DEFAULT_ATTRIBUTES.
*
- * @par Value Constraints
- * The value of this configuration option shall be a valid task attribute set.
+ * @par Constraints
+ * The value of the configuration option shall be a valid task attribute set.
*/
#define CONFIGURE_INIT_TASK_ATTRIBUTES
@@ -1124,14 +993,15 @@
* then the Classic API initialization task will be created with the stack size
* defined by the #CONFIGURE_INIT_TASK_STACK_SIZE configuration option.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ * * The value of the configuration option shall be greater than or equal to
+ * #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
- * * It shall be defined using RTEMS_TASK_STORAGE_SIZE().
+ * * The value of the configuration option shall be defined using
+ * RTEMS_TASK_STORAGE_SIZE().
* @endparblock
*
* @par Notes
@@ -1176,8 +1046,8 @@
* @par Default Value
* The default value is ``Init``.
*
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
+ * @par Constraints
+ * The value of the configuration option shall be defined to a valid function
* pointer of the type ``void ( *entry_point )( rtems_task_argument )``.
*
* @par Notes
@@ -1198,8 +1068,8 @@
* In SMP configurations, the default value is #RTEMS_DEFAULT_MODES otherwise
* the default value is #RTEMS_NO_PREEMPT.
*
- * @par Value Constraints
- * The value of this configuration option shall be a valid task mode set.
+ * @par Constraints
+ * The value of the configuration option shall be a valid task mode set.
*/
#define CONFIGURE_INIT_TASK_INITIAL_MODES
@@ -1214,8 +1084,8 @@
* @par Default Value
* The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``.
*
- * @par Value Constraints
- * The value of this configuration option shall be convertible to an integer of
+ * @par Constraints
+ * The value of the configuration option shall be convertible to an integer of
* type ::rtems_name.
*
* @par Notes
@@ -1234,8 +1104,8 @@
* @par Default Value
* The default value is 1.
*
- * @par Value Constraints
- * The value of this configuration option shall be a valid Classic API task
+ * @par Constraints
+ * The value of the configuration option shall be a valid Classic API task
* priority. The set of valid task priorities depends on the scheduler
* configuration.
*/
@@ -1252,15 +1122,20 @@
* @par Default Value
* The default value is #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ * * The 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 configuration option.
*
- * * 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
+ * * The value of the configuration option shall be greater than or equal to
+ * #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ *
+ * * The value of the configuration option 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>.
* @endparblock
*
@@ -1364,9 +1239,17 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a list of initializers for
+ * structures of type ::rtems_driver_address_table.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -1391,6 +1274,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Most BSPs do not include support for an ATA Driver.
@@ -1444,6 +1332,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* The Console Driver is responsible for providing the ``/dev/console`` device
@@ -1478,6 +1371,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Most BSPs do not include support for a Frame Buffer Driver. This is because
@@ -1501,6 +1399,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Most BSPs do not include support for an IDE Driver.
@@ -1523,6 +1426,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This device driver is supported by all BSPs.
*/
@@ -1540,6 +1448,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Most BSPs do not include support for a real-time clock (RTC). This is
@@ -1563,6 +1476,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This device driver is responsible for providing the ``/dev/console`` device
@@ -1601,6 +1519,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This device driver is responsible for providing the ``/dev/console`` device
@@ -1648,6 +1571,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This device driver simply provides entry points that return successful and
* is primarily a test fixture. It is supported by all BSPs.
@@ -1666,6 +1594,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS
@@ -1697,6 +1630,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Most BSPs do not include support for a watchdog device driver. This is
@@ -1720,6 +1658,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This device driver is supported by all BSPs.
*/
@@ -1736,9 +1679,17 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a list of initializers for
+ * structures of type ::rtems_driver_address_table.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -1762,10 +1713,18 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a valid Classic API task
+ * priority. The set of valid task priorities depends on the scheduler
+ * configuration.
+ * @endparblock
*
* @par Notes
* This configuration option is only evaluated if the configuration option
@@ -1785,6 +1744,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This device driver is responsible for setting up a mapping from machine
@@ -1841,23 +1805,28 @@
*
* * #CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS
*
- * * #CONFIGURE_BSP_PREREQUISITE_DRIVERS
+ * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined
+ * and the BSP provides #CONFIGURE_BSP_PREREQUISITE_DRIVERS, then the
+ * BSP-provided prerequisite device drivers are also taken into account.
* @endparblock
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be less than or equal to <a
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * It shall be greater than or equal than the number of statically configured
- * device drivers.
+ * * The value of the configuration option shall be greater than or equal than
+ * the number of statically configured device drivers.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -1899,6 +1868,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* The record extensions capture thread create, start, restart, delete, switch,
* begin, exitted and terminate events.
@@ -1927,6 +1901,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This extension can be used to produce crash dumps.
*/
@@ -1952,6 +1931,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* The zlib compression needs about 512KiB of RAM. This extension can be used
* to produce crash dumps.
@@ -1969,21 +1953,25 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to 16.
+ * * The value of the configuration option shall be greater than or equal to
+ * 16.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * It shall be a power of two.
+ * * The value of the configuration option shall be a power of two.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -2060,6 +2048,11 @@
* If this configuration option is undefined, then a base filesystem and the
* configured filesystems are initialized during system initialization.
*
+ * @par Constraints
+ * The configuration option is mandatory for the pre-qualified feature set of
+ * RTEMS. Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall define the configuration option.
+ *
* @par Notes
* Filesystems shall be initialized to support file descriptor based device
* drivers and basic input/output functions such as printf(). Filesystems can
@@ -2092,6 +2085,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the described feature is not
* enabled.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_FILESYSTEM_ALL
@@ -2108,6 +2106,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This filesystem requires a Block Device Cache configuration, see
* #CONFIGURE_APPLICATION_NEEDS_LIBBLOCK.
@@ -2126,6 +2129,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the described feature is not
* enabled.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_FILESYSTEM_FTPFS
@@ -2142,6 +2150,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* Applications will rarely need this configuration option. This configuration
* option is intended for test programs. You do not need to define this
@@ -2162,6 +2175,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the described feature is not
* enabled.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_FILESYSTEM_JFFS2
@@ -2177,6 +2195,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the described feature is not
* enabled.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_FILESYSTEM_NFS
@@ -2193,6 +2216,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This filesystem requires a Block Device Cache configuration, see
* #CONFIGURE_APPLICATION_NEEDS_LIBBLOCK.
@@ -2211,6 +2239,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the described feature is not
* enabled.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_FILESYSTEM_TFTPFS
@@ -2225,6 +2258,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* changing the mode of files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_CHMOD
@@ -2239,6 +2277,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* changing the ownership of files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_CHOWN
@@ -2253,6 +2296,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports hard
* links.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_LINK
@@ -2267,6 +2315,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* making files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_MKNOD
@@ -2281,6 +2334,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* making device files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE
@@ -2295,6 +2353,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* making regular files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_MKNOD_FILE
@@ -2309,6 +2372,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* mounting other filesystems.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_MOUNT
@@ -2324,6 +2392,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* reading directories.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_READDIR
@@ -2338,6 +2411,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* reading symbolic links.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_READLINK
@@ -2352,6 +2430,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* renaming files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_RENAME
@@ -2366,6 +2449,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* removing files.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_RMNOD
@@ -2380,6 +2468,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* creating symbolic links.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_SYMLINK
@@ -2394,6 +2487,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* unmounting other filesystems.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_UNMOUNT
@@ -2408,6 +2506,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS supports
* changing file times.
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_DISABLE_UTIME
@@ -2422,6 +2525,11 @@
* @par Default Configuration
* If this configuration option is undefined, then the root IMFS does not
* support making FIFOs (no support for mkfifo()).
+ *
+ * @par Constraints
+ * The 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 configuration option.
*/
#define CONFIGURE_IMFS_ENABLE_MKFIFO
@@ -2436,9 +2544,17 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be equal to 16, 32, 64, 128,
+ * 256, or 512.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -2485,6 +2601,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* In case this configuration option is defined, then the following
@@ -2536,6 +2657,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* In case this configuration option is defined, then the following
@@ -2588,6 +2714,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Dirtying memory can add significantly to system initialization time. It may
@@ -2601,6 +2732,37 @@
*/
#define CONFIGURE_DIRTY_MEMORY
+/* Generated from spec:/acfg/if/disable-bsp-settings */
+
+/**
+ * @brief This configuration option is a boolean feature define.
+ *
+ * In case this configuration option is defined, then the optional BSP provided
+ * settings listed below are disabled.
+ *
+ * The optional BSP provided default values for the following application
+ * configuration options are disabled:
+ *
+ * * #CONFIGURE_IDLE_TASK_BODY
+ *
+ * * #CONFIGURE_IDLE_TASK_STACK_SIZE
+ *
+ * * #CONFIGURE_INTERRUPT_STACK_SIZE
+ *
+ * The optional BSP provided initial extension set is disabled (see initial
+ * extension sets). The optional BSP provided prerequisite IO device drivers
+ * are disabled (see Device Driver Configuration). The optional BSP provided
+ * support for sbrk() is disabled.
+ *
+ * This configuration option provides an all or nothing choice with respect to
+ * the optional BSP provided settings.
+ *
+ * @par Default Configuration
+ * If this configuration option is undefined, then the described feature is not
+ * enabled.
+ */
+#define CONFIGURE_DISABLE_BSP_SETTINGS
+
/* Generated from spec:/acfg/if/disable-newlib-reentrancy */
/**
@@ -2613,6 +2775,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The configuration option is mandatory for the pre-qualified feature set of
+ * RTEMS. Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall define the configuration option.
+ *
* @par Notes
* You can enable this option to reduce the size of the :term:`TCB`. Use this
* option with care, since it can lead to race conditions and undefined system
@@ -2634,19 +2801,23 @@
* stack space size is calculated by ``<rtems/confdefs.h>`` based on the values
* configuration options.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINTPTR_MAX</a>.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -2667,15 +2838,20 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * 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
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option 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>.
* @endparblock
*
@@ -2697,8 +2873,8 @@
* @par Default Value
* The default value is the empty list.
*
- * @par Value Constraints
- * The value of this configuration option shall be a list of initializers for
+ * @par Constraints
+ * The value of the configuration option shall be a list of initializers for
* structures of type ::rtems_extensions_table.
*
* @par Notes
@@ -2717,22 +2893,25 @@
* stack in bytes.
*
* @par Default Value
- * The default value is #BSP_INTERRUPT_STACK_SIZE in case it is defined,
- * otherwise the default value is #CPU_STACK_MINIMUM_SIZE.
+ * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined
+ * and #BSP_INTERRUPT_STACK_SIZE is provided by the BSP, then the default value
+ * is defined by #BSP_INTERRUPT_STACK_SIZE, otherwise the default value is
+ * #CPU_STACK_MINIMUM_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
+ * * The value of the configuration option shall be greater than or equal to a
+ * BSP-specific and application-specific minimum value.
*
- * * It shall be small enough so that the interrupt 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 value of the configuration option shall be small enough so that the
+ * interrupt 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>.
*
- * * It shall be aligned according to #CPU_INTERRUPT_STACK_ALIGNMENT.
+ * * The value of the configuration option shall be aligned according to
+ * #CPU_INTERRUPT_STACK_ALIGNMENT.
* @endparblock
*
* @par Notes
@@ -2769,6 +2948,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* The dirtying performed by this option is carried out for each successful
* memory allocation from the C Program Heap in contrast to
@@ -2788,19 +2972,24 @@
* @par Default Value
* The default value is 3.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * A value of zero for the configuration option is mandatory for the
+ * pre-qualified feature set of RTEMS. Applications which are restricted to
+ * only use interfaces of the pre-qualified feature set of RTEMS shall define
+ * the configuration option to zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -2823,14 +3012,15 @@
* @par Default Value
* The default value is 1.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to one.
+ * * The value of the configuration option shall be greater than or equal to
+ * one.
*
- * * It shall be less than or equal to #CPU_MAXIMUM_PROCESSORS.
+ * * The value of the configuration option shall be less than or equal to
+ * #CPU_MAXIMUM_PROCESSORS.
* @endparblock
*
* @par Notes
@@ -2856,19 +3046,23 @@
* @par Default Value
* The default value is 16.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -2896,20 +3090,25 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * 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 value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option 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 value of the configuration option 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>.
* @endparblock
*
* @par Notes
@@ -2932,20 +3131,25 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option 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.
*
- * * 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 value of the configuration option 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>.
* @endparblock
*
* @par Notes
@@ -3024,14 +3228,15 @@
* @par Default Value
* The default value is 10000.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to a value defined by the Clock Driver.
+ * * The value of the configuration option shall be greater than or equal to a
+ * value defined by the Clock Driver.
*
- * * It shall be less than or equal to a value defined by the Clock Driver.
+ * * The value of the configuration option shall be less than or equal to a
+ * value defined by the Clock Driver.
*
* * The resulting clock ticks per second should be an integer.
* @endparblock
@@ -3058,17 +3263,17 @@
* @par Default Value
* The default value is #CPU_STACK_MINIMUM_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * 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
+ * * The value of the configuration option 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>.
*
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
+ * * The value of the configuration option shall be greater than or equal to a
+ * BSP-specific and application-specific minimum value.
* @endparblock
*
* @par Notes
@@ -3108,6 +3313,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* The stack checker performs run-time stack bounds checking. This increases
@@ -3130,14 +3340,14 @@
* @par Default Value
* The default value is 50.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -3159,6 +3369,11 @@
* If this configuration option is undefined, then there will be separate
* memory pools for the RTEMS Workspace and C Program Heap.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* Having separate pools does have some advantages in the event a task blows a
@@ -3189,9 +3404,17 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall meet the constraints of all
+ * object classes to which it is applied.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -3216,6 +3439,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* When using unlimited objects, it is common practice to also specify
@@ -3242,6 +3470,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* You may use this feature to debug system initialization issues. The
* printk() function is used to print the information.
@@ -3261,6 +3494,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* Zeroing memory can add significantly to the system initialization time. It
* is not necessary for RTEMS but is often assumed by support libraries. In
@@ -3291,11 +3529,13 @@
* The value of this configuration option initializes the IDLE thread body.
*
* @par Default Value
- * If #BSP_IDLE_TASK_BODY is defined, then this will be the default value,
- * otherwise the default value is ``_CPU_Thread_Idle_body``.
+ * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined
+ * and #BSP_IDLE_TASK_BODY is provided by the BSP, then the default value is
+ * defined by #BSP_IDLE_TASK_BODY, otherwise the default value is
+ * ``_CPU_Thread_Idle_body``.
*
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
+ * @par Constraints
+ * The value of the configuration option shall be defined to a valid function
* pointer of the type ``void *( *idle_body )( uintptr_t )``.
*
* @par Notes
@@ -3306,6 +3546,11 @@
*
* IDLE threads can be used to initialize the application, see configuration
* option #CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION.
+ *
+ * The BSP may have knowledge of the specific CPU model, system controller
+ * logic, and peripheral buses, so a BSP-specific IDLE task may be capable of
+ * turning components off to save power during extended periods of no task
+ * activity.
* @endparblock
*/
#define CONFIGURE_IDLE_TASK_BODY
@@ -3360,19 +3605,22 @@
* IDLE task.
*
* @par Default Value
- * The default value is #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ * If the #CONFIGURE_DISABLE_BSP_SETTINGS configuration option is not defined
+ * and #BSP_IDLE_TASK_STACK_SIZE is provided by the BSP, then the default value
+ * is defined by #BSP_IDLE_TASK_STACK_SIZE, otherwise the default value is
+ * defined by the #CONFIGURE_MINIMUM_TASK_STACK_SIZE configuration option.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
+ * * The value of the configuration option shall be greater than or equal to a
+ * BSP-specific and application-specific minimum value.
*
- * * 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 value of the configuration option 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>.
* @endparblock
*
* @par Notes
@@ -3413,19 +3661,23 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
*
- * * It shall be small enough so that the MPCI receive server stack area
- * calculation carried out by ``<rtems/confdefs.h>`` does not overflow an
- * integer of type <a
+ * * The value of the configuration option shall be small enough so that the
+ * MPCI receive server 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>.
* @endparblock
*
@@ -3448,6 +3700,11 @@
* If this configuration option is undefined, then the multiprocessing services
* are not initialized.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* This configuration option shall be undefined if the multiprocessing support
* is not enabled (e.g. RTEMS was built without the
@@ -3467,14 +3724,18 @@
* @par Default Value
* The default value is 32.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -3500,14 +3761,18 @@
* @par Default Value
* The default value is 2.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -3529,14 +3794,18 @@
* @par Default Value
* The default value is 32.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -3564,9 +3833,17 @@
* @par Default Value
* The default value is ``&MPCI_table``.
*
- * @par Value Constraints
- * The value of this configuration option shall be a pointer to
- * ::rtems_mpci_table.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be a pointer to
+ * ::rtems_mpci_table.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -3591,14 +3868,18 @@
* @par Default Value
* The default value is ``NODE_NUMBER``.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
+ *
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/integer">UINT32_MAX</a>.
* @endparblock
*
@@ -3643,23 +3924,28 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -3678,26 +3964,31 @@
* value pairs used by POSIX API Keys that can be concurrently active.
*
* @par Default Value
- * The default value is #CONFIGURE_MAXIMUM_POSIX_KEYS *
- * #CONFIGURE_MAXIMUM_TASKS + #CONFIGURE_MAXIMUM_POSIX_THREADS.
+ * The default value is #CONFIGURE_MAXIMUM_POSIX_KEYS * (
+ * #CONFIGURE_MAXIMUM_TASKS + #CONFIGURE_MAXIMUM_POSIX_THREADS ).
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option 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 value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -3724,27 +4015,33 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * 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 value of the configuration option 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>.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -3766,24 +4063,30 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * 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 value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option 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 value of the configuration option 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>.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -3807,27 +4110,33 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option 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 value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -3854,27 +4163,33 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option 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 value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
* @endparblock
*
* @par Notes
@@ -3895,21 +4210,27 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * 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 value of the configuration option 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.
*
- * * 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
+ * * The value of the configuration option 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>.
* @endparblock
*
@@ -3944,27 +4265,33 @@
* @par Default Value
* The default value is 0.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The 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 configuration option.
*
- * * It shall be less than or equal to 65535.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * 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 value of the configuration option shall be less than or equal to
+ * 65535.
*
- * * It may be defined through rtems_resource_unlimited() the enable unlimited
- * objects for the object class, if the value passed to
- * rtems_resource_unlimited() satisfies all other constraints of the
- * configuration option.
+ * * The value of the configuration option 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.
*
- * * 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 value of the configuration option may be defined through
+ * rtems_resource_unlimited() the enable unlimited objects for the object
+ * class, if the value passed to rtems_resource_unlimited() satisfies all
+ * other constraints of the configuration option.
+ *
+ * * The value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -3991,17 +4318,21 @@
* The default value is two times the value of
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * 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
+ * * The value of the configuration option 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>.
*
- * * It shall be greater than or equal to a BSP-specific and
- * application-specific minimum value.
+ * * The value of the configuration option shall be greater than or equal to a
+ * BSP-specific and application-specific minimum value.
* @endparblock
*/
#define CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE
@@ -4033,9 +4364,17 @@
* @par Default Value
* 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 * )``.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the configuration option shall be defined to a valid function
+ * pointer of the type ``void *( *entry_point )( void * )``.
+ * @endparblock
*
* @par Notes
* The application shall provide the function referenced by this configuration
@@ -4054,15 +4393,20 @@
* @par Default Value
* The default value is #CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
+ * * The value of the configuration option shall be greater than or equal to
+ * #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
- * * 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
+ * * The value of the configuration option 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>.
* @endparblock
*/
@@ -4080,6 +4424,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* The application shall define exactly one of the following configuration
@@ -4145,19 +4494,23 @@
* @par Default Value
* The default value is #CONFIGURE_MAXIMUM_TASKS.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to <a
+ * * The value of the configuration option shall be less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
- * * 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 value of the configuration option 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.
* @endparblock
*
* @par Notes
@@ -4198,8 +4551,8 @@
* @par Default Value
* The default value is 255.
*
- * @par Value Constraints
- * The value of this configuration option shall be equal to 3, 7, 31, 63, 127,
+ * @par Constraints
+ * The value of the configuration option shall be equal to 3, 7, 31, 63, 127,
* or 255.
*
* @par Notes
@@ -4236,18 +4589,19 @@
* The default value of this configuration option is computed so that the
* default scheduler is assigned to each configured processor (up to 32).
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be a list of the following macros:
+ * * The value of the configuration option shall be a list of the following
+ * macros:
*
* * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )``
*
* * ``RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER``
*
- * * It shall be a list of exactly #CONFIGURE_MAXIMUM_PROCESSORS elements.
+ * * The value of the configuration option shall be a list of exactly
+ * #CONFIGURE_MAXIMUM_PROCESSORS elements.
* @endparblock
*
* @par Notes
@@ -4275,6 +4629,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4301,6 +4660,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4392,8 +4756,8 @@
* Priority Scheduler</a>.
* @endparblock
*
- * @par Value Constraints
- * The value of this configuration option shall be convertible to an integer of
+ * @par Constraints
+ * The value of the configuration option shall be convertible to an integer of
* type ::rtems_name.
*
* @par Notes
@@ -4454,6 +4818,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4486,6 +4855,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4518,6 +4892,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4544,6 +4923,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4572,6 +4956,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4597,6 +4986,11 @@
* If this configuration option is undefined, then the described feature is not
* enabled.
*
+ * @par Constraints
+ * The 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 configuration option.
+ *
* @par Notes
* @parblock
* This scheduler configuration option is an advanced configuration option.
@@ -4658,8 +5052,8 @@
* The default value is ``_Workspace_Allocate``, which indicates that task
* stacks will be allocated from the RTEMS Workspace.
*
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
+ * @par Constraints
+ * The value of the configuration option shall be defined to a valid function
* pointer of the type ``void *( *allocate )( size_t )``.
*
* @par Notes
@@ -4708,8 +5102,8 @@
* indicates that IDLE task stacks will be allocated from an area statically
* allocated by ``<rtems/confdefs.h>``.
*
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
+ * @par Constraints
+ * The value of the configuration option shall be defined to a valid function
* pointer of the type ``void *( *allocate )( uint32_t, size_t )``.
*
* @par Notes
@@ -4732,10 +5126,18 @@
* The default value is <a
* 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>.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the 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>.
+ * @endparblock
*
* @par Notes
* @parblock
@@ -4763,8 +5165,8 @@
* The default value is ``_Workspace_Free``, which indicates that task stacks
* will be allocated from the RTEMS Workspace.
*
- * @par Value Constraints
- * The value of this configuration option shall be defined to a valid function
+ * @par Constraints
+ * The value of the configuration option shall be defined to a valid function
* pointer of the type ``void ( *deallocate )( void * )``.
*
* @par Notes
@@ -4792,12 +5194,20 @@
* @par Default Value
* 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.
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this configuration option:
+ *
+ * * The 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 configuration option.
+ *
+ * * The value of the 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.
+ * @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..8cda0452e3 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -188,6 +188,10 @@ void rtems_put_char( int c, void *unused );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -224,6 +228,10 @@ int putk( const char *s );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -262,6 +270,10 @@ RTEMS_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -302,6 +314,10 @@ int vprintk( const char *fmt, va_list ap );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h
index 32dd662b3e..f3c806d494 100644
--- a/cpukit/include/rtems/config.h
+++ b/cpukit/include/rtems/config.h
@@ -118,6 +118,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -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 );
@@ -425,6 +474,10 @@ uintptr_t rtems_configuration_get_stack_space_size( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -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 + \
@@ -528,6 +626,15 @@ const char *rtems_get_version_string( void );
*
* @brief This constant evaluates to #TRUE, if this processor variant has
* hardware floating point support, otherwise to #FALSE.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP
@@ -545,6 +652,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 +679,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 )
@@ -601,6 +726,15 @@ typedef Stack_Allocator_free rtems_stack_free_hook;
*
* @brief This flag is used in augment a resource number so that it indicates
* an unlimited resource.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_UNLIMITED_OBJECTS OBJECTS_UNLIMITED_OBJECTS
@@ -620,6 +754,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/cpuuse.h b/cpukit/include/rtems/cpuuse.h
index 86338a7332..51ad17fb0e 100644
--- a/cpukit/include/rtems/cpuuse.h
+++ b/cpukit/include/rtems/cpuuse.h
@@ -90,6 +90,10 @@ struct rtems_printer;
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -111,6 +115,10 @@ int rtems_cpu_info_report( const struct rtems_printer *printer );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -135,6 +143,10 @@ void rtems_cpu_usage_report( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -182,6 +194,10 @@ void rtems_cpu_usage_reset( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -210,6 +226,10 @@ void rtems_cpu_usage_top( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h
index 0253ab4343..37dd24fdd1 100644
--- a/cpukit/include/rtems/fatal.h
+++ b/cpukit/include/rtems/fatal.h
@@ -178,6 +178,10 @@ RTEMS_NO_RETURN static inline void rtems_fatal(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
@@ -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
@@ -233,6 +246,10 @@ static inline void rtems_exception_frame_print(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
* @endparblock
*/
@@ -257,6 +274,10 @@ const char *rtems_fatal_source_text( rtems_fatal_source fatal_source );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
* @endparblock
*/
@@ -284,6 +305,10 @@ const char *rtems_internal_error_text( rtems_fatal_code internal_error_code );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h
index a821f92107..a2c27658ba 100644
--- a/cpukit/include/rtems/init.h
+++ b/cpukit/include/rtems/init.h
@@ -94,6 +94,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive should be called by boot_card() only.
*
* * The directive will not return to the caller.
@@ -118,6 +122,10 @@ RTEMS_NO_RETURN void rtems_initialize_executive( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
index 181da9fe4f..ecc89e16a2 100644
--- a/cpukit/include/rtems/io.h
+++ b/cpukit/include/rtems/io.h
@@ -228,6 +228,15 @@ typedef struct {
* After a successful registration, the rtems_io_initialize() directive will be
* called to initialize the device.
* @endparblock
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_register_driver(
rtems_device_major_number major,
@@ -254,6 +263,15 @@ rtems_status_code rtems_io_register_driver(
*
* @par Notes
* Currently no specific checks are made and the driver is not closed.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
@@ -294,6 +312,15 @@ rtems_status_code rtems_io_unregister_driver(
* hardware and data structures associated with a device. If necessary, it can
* allocate memory to be used during other operations.
* @endparblock
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
@@ -322,6 +349,15 @@ rtems_status_code rtems_io_initialize(
*
* @par Notes
* The device is registered as a character device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_register_name(
const char *device_name,
@@ -354,6 +390,15 @@ rtems_status_code rtems_io_register_name(
* @par Notes
* The open entry point is commonly used by device drivers to provide exclusive
* access to a device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_open(
rtems_device_major_number major,
@@ -386,6 +431,15 @@ rtems_status_code rtems_io_open(
* @par Notes
* The close entry point is commonly used by device drivers to relinquish
* exclusive access to a device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_close(
rtems_device_major_number major,
@@ -420,6 +474,15 @@ rtems_status_code rtems_io_close(
* Read operations typically require a buffer address as part of the argument
* parameter block. The contents of this buffer will be replaced with data
* from the device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_read(
rtems_device_major_number major,
@@ -452,6 +515,15 @@ rtems_status_code rtems_io_read(
* @par Notes
* Write operations typically require a buffer address as part of the argument
* parameter block. The contents of this buffer will be sent to the device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_write(
rtems_device_major_number major,
@@ -489,6 +561,15 @@ rtems_status_code rtems_io_write(
* device drivers are compatible. For example, an RS-232 driver I/O control
* operation may change the baud of a serial line, while an I/O control
* operation for a floppy disk driver may cause a seek operation.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h
index c7c19b80e2..baaa10a99b 100644
--- a/cpukit/include/rtems/rtems/cache.h
+++ b/cpukit/include/rtems/rtems/cache.h
@@ -91,6 +91,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -143,6 +147,10 @@ void rtems_cache_coherent_add_area( void *begin, uintptr_t size );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -169,6 +177,10 @@ void *rtems_cache_coherent_allocate(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -638,6 +650,10 @@ void rtems_cache_disable_instruction( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index 7247b483db..98ea9775e9 100644
--- a/cpukit/include/rtems/rtems/clock.h
+++ b/cpukit/include/rtems/rtems/clock.h
@@ -209,6 +209,10 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -830,6 +834,10 @@ void rtems_clock_get_boot_time_timeval( struct timeval *boot_time );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -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 */
@@ -949,6 +979,10 @@ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -974,6 +1008,10 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -999,6 +1037,10 @@ time_t rtems_clock_get_uptime_seconds( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -1025,6 +1067,10 @@ uint64_t rtems_clock_get_uptime_nanoseconds( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -1054,6 +1100,10 @@ static inline rtems_interval rtems_clock_tick_later( rtems_interval delta )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -1115,6 +1165,10 @@ static inline rtems_interval rtems_clock_tick_later_usec(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index 2a12c8f3cb..1aade74a0f 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 );
diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h
index 9ecdf3a170..54c660fe35 100644
--- a/cpukit/include/rtems/rtems/dpmem.h
+++ b/cpukit/include/rtems/rtems/dpmem.h
@@ -127,6 +127,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -193,6 +197,10 @@ rtems_status_code rtems_port_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -223,6 +231,10 @@ rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -270,6 +282,10 @@ rtems_status_code rtems_port_delete( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -317,6 +333,10 @@ rtems_status_code rtems_port_external_to_internal(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h
index 573cdf6f17..77d2ee5698 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -169,6 +169,10 @@ typedef ISR_Handler rtems_isr;
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -248,6 +252,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -290,6 +298,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -338,6 +350,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -484,6 +500,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -922,6 +942,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler shared option
* #RTEMS_INTERRUPT_SHARED is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_SHARED( _options ) \
( ( _options ) & RTEMS_INTERRUPT_SHARED )
@@ -935,6 +964,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler unique option
* #RTEMS_INTERRUPT_UNIQUE is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_UNIQUE( _options ) \
( ( _options ) & RTEMS_INTERRUPT_UNIQUE )
@@ -948,6 +986,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler replace option
* #RTEMS_INTERRUPT_REPLACE is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_REPLACE( _options ) \
( ( _options ) & RTEMS_INTERRUPT_REPLACE )
@@ -1298,6 +1345,10 @@ rtems_status_code rtems_interrupt_entry_remove(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -1348,6 +1399,10 @@ rtems_status_code rtems_interrupt_handler_install(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2052,6 +2107,15 @@ rtems_status_code rtems_interrupt_handler_iterate(
* @ingroup RTEMSAPIClassicIntr
*
* @brief The constant represents the index of the default interrupt server.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_SERVER_DEFAULT 0
@@ -2218,6 +2282,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2266,6 +2334,10 @@ rtems_status_code rtems_interrupt_server_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2344,6 +2416,10 @@ rtems_status_code rtems_interrupt_server_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2395,6 +2471,10 @@ rtems_status_code rtems_interrupt_server_handler_install(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -2459,6 +2539,10 @@ rtems_status_code rtems_interrupt_server_handler_remove(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2507,6 +2591,10 @@ rtems_status_code rtems_interrupt_server_set_affinity(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2542,6 +2630,10 @@ rtems_status_code rtems_interrupt_server_delete( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2577,6 +2669,10 @@ rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2622,6 +2718,10 @@ rtems_status_code rtems_interrupt_server_resume( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2679,6 +2779,10 @@ rtems_status_code rtems_interrupt_server_move(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2791,6 +2895,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2831,6 +2939,10 @@ rtems_status_code rtems_interrupt_server_entry_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2884,6 +2996,10 @@ void rtems_interrupt_server_action_prepend(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2933,6 +3049,10 @@ void rtems_interrupt_server_entry_destroy(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2982,6 +3102,10 @@ void rtems_interrupt_server_entry_submit(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -3078,6 +3202,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -3120,6 +3248,10 @@ rtems_status_code rtems_interrupt_server_request_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -3171,6 +3303,10 @@ static inline void rtems_interrupt_server_request_set_vector(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -3222,6 +3358,10 @@ static inline void rtems_interrupt_server_request_destroy(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 0a76b1f9b8..7cb0591e67 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -248,6 +248,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h
index 559029d2da..bbb18ac87b 100644
--- a/cpukit/include/rtems/rtems/modes.h
+++ b/cpukit/include/rtems/rtems/modes.h
@@ -159,6 +159,15 @@ extern "C" {
* @par Notes
* This task mode constant is used by bindings from languages other than C and
* C++.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this object:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
extern const uint32_t rtems_interrupt_mask;
@@ -185,6 +194,15 @@ typedef uint32_t rtems_mode;
*
* @par Notes
* This function is used by bindings from languages other than C and C++.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_mode rtems_interrupt_level_body( uint32_t level );
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 91c31047fb..74a65e7536 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -120,6 +120,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -143,6 +147,15 @@ void rtems_multiprocessing_announce( void );
*
* In packets longer than this value, some of the extra data may be a user
* message buffer which is not automatically endian swapped.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION
@@ -153,6 +166,15 @@ void rtems_multiprocessing_announce( void );
*
* @brief This constant defines the minimum packet size which must be supported
* by the MPCI.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index e80303da28..1de969c371 100644
--- a/cpukit/include/rtems/rtems/object.h
+++ b/cpukit/include/rtems/rtems/object.h
@@ -124,6 +124,15 @@ typedef struct {
* @ingroup RTEMSAPIClassicObject
*
* @brief This constant represents the highest object identifier value.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL
@@ -134,6 +143,15 @@ typedef struct {
*
* @brief This constant represents the highest value for the index component of
* an object identifier.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX
@@ -158,6 +176,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -173,6 +195,15 @@ typedef struct {
*
* @brief This constant represents the lowest value for the index component of
* an object identifier.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX
@@ -239,6 +270,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -254,6 +289,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 )
@@ -325,6 +371,10 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -372,6 +422,10 @@ rtems_status_code rtems_object_get_classic_name(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -425,6 +479,10 @@ char *rtems_object_get_name( rtems_id id, size_t length, char *name );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -454,6 +512,10 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -464,6 +526,17 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
int rtems_object_id_get_api( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-api-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_api( _id ) _Objects_Get_API( _id )
/* Generated from spec:/rtems/object/if/id-get-class */
@@ -484,6 +557,10 @@ int rtems_object_id_get_api( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -494,6 +571,17 @@ int rtems_object_id_get_api( rtems_id id );
int rtems_object_id_get_class( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-class-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_class( _id ) _Objects_Get_class( _id )
/* Generated from spec:/rtems/object/if/id-get-node */
@@ -514,6 +602,10 @@ int rtems_object_id_get_class( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -524,6 +616,17 @@ int rtems_object_id_get_class( rtems_id id );
int rtems_object_id_get_node( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-node-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_node( _id ) _Objects_Get_node( _id )
/* Generated from spec:/rtems/object/if/id-get-index */
@@ -544,6 +647,10 @@ int rtems_object_id_get_node( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -554,6 +661,17 @@ int rtems_object_id_get_node( rtems_id id );
int rtems_object_id_get_index( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-index-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_index( _id ) _Objects_Get_index( _id )
/* Generated from spec:/rtems/object/if/id-api-minimum */
@@ -571,6 +689,10 @@ int rtems_object_id_get_index( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -581,6 +703,17 @@ int rtems_object_id_get_index( rtems_id id );
int rtems_object_id_api_minimum( void );
/* Generated from spec:/rtems/object/if/id-api-minimum-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_api_minimum() OBJECTS_INTERNAL_API
/* Generated from spec:/rtems/object/if/id-api-maximum */
@@ -598,6 +731,10 @@ int rtems_object_id_api_minimum( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -608,6 +745,17 @@ int rtems_object_id_api_minimum( void );
int rtems_object_id_api_maximum( void );
/* Generated from spec:/rtems/object/if/id-api-maximum-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_api_maximum() OBJECTS_APIS_LAST
/* Generated from spec:/rtems/object/if/api-minimum-class */
@@ -627,6 +775,10 @@ int rtems_object_id_api_maximum( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -651,6 +803,10 @@ int rtems_object_api_minimum_class( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -678,6 +834,10 @@ int rtems_object_api_maximum_class( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -710,6 +870,10 @@ const char *rtems_object_get_api_name( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -744,6 +908,10 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 7c789a204b..015cb95680 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -572,6 +572,10 @@ rtems_status_code rtems_rate_monotonic_get_status(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may be called from within interrupt context.
@@ -605,6 +609,10 @@ rtems_status_code rtems_rate_monotonic_get_statistics(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may be called from within interrupt context.
@@ -628,6 +636,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -650,6 +662,10 @@ void rtems_rate_monotonic_reset_all_statistics( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -674,6 +690,10 @@ void rtems_rate_monotonic_report_statistics( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h
index 1e35344f7d..298b73ab3d 100644
--- a/cpukit/include/rtems/rtems/region.h
+++ b/cpukit/include/rtems/rtems/region.h
@@ -113,6 +113,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -208,6 +212,10 @@ rtems_status_code rtems_region_get_segment_size(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -275,6 +283,10 @@ rtems_status_code rtems_region_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -312,6 +324,10 @@ rtems_status_code rtems_region_ident( rtems_name name, rtems_id *id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -369,6 +385,10 @@ rtems_status_code rtems_region_delete( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -468,6 +488,10 @@ rtems_status_code rtems_region_extend(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -531,6 +555,10 @@ rtems_status_code rtems_region_get_segment(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -588,6 +616,10 @@ rtems_status_code rtems_region_return_segment( rtems_id id, void *segment );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -645,6 +677,10 @@ rtems_status_code rtems_region_resize_segment(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -702,6 +738,10 @@ rtems_status_code rtems_region_get_information(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/scheduler.h b/cpukit/include/rtems/rtems/scheduler.h
index 8bd041558f..df02d17da1 100644
--- a/cpukit/include/rtems/rtems/scheduler.h
+++ b/cpukit/include/rtems/rtems/scheduler.h
@@ -282,6 +282,10 @@ rtems_status_code rtems_scheduler_get_maximum_priority(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -323,6 +327,10 @@ rtems_status_code rtems_scheduler_map_priority_to_posix(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h
index 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..f099036193 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -120,6 +120,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -143,6 +147,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -171,6 +179,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -241,6 +253,10 @@ static inline void rtems_name_to_characters(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -268,6 +284,10 @@ bool rtems_workspace_allocate( size_t bytes, void **pointer );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -297,6 +317,10 @@ bool rtems_workspace_free( void *pointer );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -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,
@@ -355,6 +388,10 @@ void *rtems_workspace_greedy_allocate(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -386,6 +423,10 @@ void *rtems_workspace_greedy_allocate_all_except_largest(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/tasks.h b/cpukit/include/rtems/rtems/tasks.h
index e4609f6e9f..ea25f1c2bd 100644
--- a/cpukit/include/rtems/rtems/tasks.h
+++ b/cpukit/include/rtems/rtems/tasks.h
@@ -413,8 +413,8 @@ rtems_task_priority _RTEMS_Maximum_priority( void );
/**
* @ingroup RTEMSAPIClassicTasks
*
- * @brief This constant variable provides the lowest (least important) task
- * priority of the first configured scheduler.
+ * @brief This runtime constant represents the lowest (least important) task
+ * priority of the scheduler with index zero.
*/
#define RTEMS_MAXIMUM_PRIORITY _RTEMS_Maximum_priority()
diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h
index 0f13c04bda..4e6c9c247e 100644
--- a/cpukit/include/rtems/rtems/timer.h
+++ b/cpukit/include/rtems/rtems/timer.h
@@ -82,6 +82,15 @@ extern "C" {
* @ingroup RTEMSAPIClassicTimer
*
* @brief This timer class bit indicates that the timer is not dormant.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_NOT_DORMANT 0x4
@@ -92,6 +101,15 @@ extern "C" {
*
* @brief This timer class bit indicates that the timer routine executes in a
* task context.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_ON_TASK 0x2
@@ -101,6 +119,15 @@ extern "C" {
* @ingroup RTEMSAPIClassicTimer
*
* @brief This timer class bit indicates that the timer uses a time of day.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_TIME_OF_DAY 0x1
@@ -208,6 +235,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization