summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2022-08-11 09:46:36 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-09-09 09:12:40 +0200
commitf7dc9ea5cdbf653d68de30cc3c694d7e7a959d90 (patch)
tree925a58a4158748b05be1e031d6c79960817c932d
parent33bcd6c7b5b90a642821bbd60e942e0f39c7ddd9 (diff)
Add pre-qualified constraintsqual-64
-rw-r--r--cpukit/doxygen/appl-config.h615
-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.h58
-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/event.h66
-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/timer.h31
23 files changed, 1546 insertions, 32 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
index 95f3e29bd5..436a3ab1d5 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
@@ -98,6 +103,10 @@
* @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 greater than or equal to
* zero.
*
@@ -122,6 +131,10 @@
* @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 greater than or equal to
* zero.
*
@@ -146,6 +159,10 @@
* @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 greater than or equal to
* zero.
*
@@ -170,6 +187,10 @@
* @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 greater than or equal to
* zero.
*
@@ -199,6 +220,10 @@
* @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 greater than or equal to
* zero.
*
@@ -219,9 +244,17 @@
* The default value is 15.
*
* @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.
+ * @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
@@ -240,6 +273,10 @@
* @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 greater than or equal to
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
@@ -270,6 +307,10 @@
* @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 greater than or equal to
* zero.
*
@@ -294,6 +335,10 @@
* @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 greater than or equal to
* zero.
*
@@ -314,9 +359,17 @@
* The default value is 15.
*
* @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.
+ * @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
@@ -335,6 +388,10 @@
* @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 greater than or equal to
* zero.
*
@@ -356,9 +413,17 @@
* The default value is 15.
*
* @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.
+ * @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_WORKER_TASK_PRIORITY
@@ -544,6 +609,10 @@
* @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 greater than or equal to
* zero.
*
@@ -582,6 +651,10 @@
* @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 greater than or equal to
* zero.
*
@@ -1053,6 +1126,10 @@
* @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 greater than or equal to
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
@@ -1163,8 +1240,16 @@
* The default value is the empty list.
*
* @par Constraints
- * The value of the configuration option shall be a list of initializers for
- * structures of type ::rtems_driver_address_table.
+ * @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
@@ -1189,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.
@@ -1242,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
@@ -1276,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
@@ -1299,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.
@@ -1321,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.
*/
@@ -1338,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
@@ -1361,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
@@ -1399,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
@@ -1446,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.
@@ -1464,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
@@ -1495,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
@@ -1518,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.
*/
@@ -1535,8 +1680,16 @@
* The default value is the empty list.
*
* @par Constraints
- * The value of the configuration option shall be a list of initializers for
- * structures of type ::rtems_driver_address_table.
+ * @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
@@ -1561,9 +1714,17 @@
* The default value is 140.
*
* @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.
+ * @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
@@ -1583,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
@@ -1648,6 +1814,10 @@
* @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 less than or equal to <a
* href="https://en.cppreference.com/w/c/types/limits">SIZE_MAX</a>.
*
@@ -1698,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.
@@ -1726,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.
*/
@@ -1751,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.
@@ -1772,6 +1957,10 @@
* @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 greater than or equal to
* 16.
*
@@ -1838,6 +2027,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_POSIX_TIMERS_FACE_BEHAVIOR
@@ -1908,6 +2102,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
@@ -1940,6 +2139,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
@@ -1956,6 +2160,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.
@@ -1974,6 +2183,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
@@ -1990,6 +2204,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
@@ -2010,6 +2229,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
@@ -2025,6 +2249,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
@@ -2041,6 +2270,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.
@@ -2059,6 +2293,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
@@ -2073,6 +2312,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
@@ -2087,6 +2331,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
@@ -2101,6 +2350,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
@@ -2115,6 +2369,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
@@ -2129,6 +2388,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
@@ -2143,6 +2407,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
@@ -2157,6 +2426,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
@@ -2172,6 +2446,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
@@ -2186,6 +2465,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
@@ -2200,6 +2484,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
@@ -2214,6 +2503,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
@@ -2228,6 +2522,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
@@ -2242,6 +2541,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
@@ -2256,6 +2560,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
@@ -2270,6 +2579,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
@@ -2285,8 +2599,16 @@
* The default value is 128.
*
* @par Constraints
- * The value of the configuration option shall be equal to 16, 32, 64, 128,
- * 256, or 512.
+ * @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
@@ -2333,6 +2655,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
@@ -2384,6 +2711,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
@@ -2436,6 +2768,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
@@ -2492,6 +2829,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
@@ -2517,6 +2859,10 @@
* @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 greater than or equal to
* zero.
*
@@ -2550,6 +2896,10 @@
* @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 greater than or equal to
* zero.
*
@@ -2652,6 +3002,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
@@ -2675,6 +3030,11 @@
* @parblock
* The following constraints apply to this configuration option:
*
+ * * 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.
+ *
* * The value of the configuration option shall be greater than or equal to
* zero.
*
@@ -2744,6 +3104,10 @@
* @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 greater than or equal to
* zero.
*
@@ -2784,6 +3148,10 @@
* @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 greater than or equal to
* zero.
*
@@ -2821,6 +3189,10 @@
* @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 greater than or equal to
* zero.
*
@@ -2995,6 +3367,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
@@ -3046,6 +3423,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
@@ -3077,8 +3459,16 @@
* The default value is 8.
*
* @par Constraints
- * The value of the configuration option shall meet the constraints of all
- * object classes to which it is applied.
+ * @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
@@ -3103,6 +3493,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
@@ -3129,6 +3524,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.
@@ -3148,6 +3548,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
@@ -3315,6 +3720,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3346,6 +3755,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 multiprocessing build
@@ -3369,6 +3783,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3402,6 +3820,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3431,6 +3853,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3463,8 +3889,16 @@
* The default value is ``&MPCI_table``.
*
* @par Constraints
- * The value of the configuration option shall be a pointer to
- * ::rtems_mpci_table.
+ * @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
@@ -3493,6 +3927,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3545,6 +3983,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3584,6 +4026,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3628,6 +4074,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3672,6 +4122,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3715,6 +4169,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3764,6 +4222,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3807,6 +4269,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3858,6 +4324,10 @@
* @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 greater than or equal to
* zero.
*
@@ -3907,6 +4377,10 @@
* @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 small enough so that the
* task stack space calculation carried out by ``<rtems/confdefs.h>`` does
* not overflow an integer of type <a
@@ -3946,8 +4420,16 @@
* The default value is ``POSIX_Init``.
*
* @par Constraints
- * The value of the configuration option shall be defined to a valid function
- * pointer of the type ``void *( *entry_point )( void * )``.
+ * @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
@@ -3970,6 +4452,10 @@
* @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 greater than or equal to
* #CONFIGURE_MINIMUM_TASK_STACK_SIZE.
*
@@ -3993,6 +4479,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
@@ -4062,6 +4553,10 @@
* @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 greater than or equal to
* zero.
*
@@ -4201,6 +4696,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.
@@ -4227,6 +4727,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.
@@ -4380,6 +4885,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.
@@ -4412,6 +4922,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.
@@ -4444,6 +4959,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.
@@ -4470,6 +4990,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.
@@ -4498,6 +5023,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.
@@ -4586,6 +5116,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.
@@ -4722,9 +5257,17 @@
* href="https://en.cppreference.com/w/c/types/NULL">NULL</a>.
*
* @par Constraints
- * 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>.
+ * @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
@@ -4782,11 +5325,19 @@
* The default value is a macro which supports the system heap allocator.
*
* @par Constraints
- * 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.
+ * @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 6fc0924f4f..56d8f2dd46 100644
--- a/cpukit/include/rtems/config.h
+++ b/cpukit/include/rtems/config.h
@@ -119,6 +119,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.
@@ -134,6 +138,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 );
@@ -150,6 +163,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
@@ -300,6 +322,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)
@@ -350,6 +381,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
@@ -397,6 +437,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 );
@@ -426,6 +475,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.
@@ -462,6 +515,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
@@ -474,6 +536,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
@@ -487,6 +558,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() \
@@ -503,6 +583,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 );
@@ -516,6 +605,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 + \
@@ -529,6 +627,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
@@ -546,6 +653,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 )
@@ -564,6 +680,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 )
@@ -602,6 +727,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
@@ -621,6 +755,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 1cc59076fe..3711d41f70 100644
--- a/cpukit/include/rtems/fatal.h
+++ b/cpukit/include/rtems/fatal.h
@@ -180,6 +180,10 @@ RTEMS_NO_RETURN static inline void rtems_fatal(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
@@ -209,6 +213,15 @@ RTEMS_NO_RETURN RTEMS_PRINTFLIKE( 1, 2 ) void rtems_panic(
*
* The exception frame is printed in an architecture-dependent format using
* printk().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
static inline void rtems_exception_frame_print(
const rtems_exception_frame *frame
@@ -235,6 +248,10 @@ static inline void rtems_exception_frame_print(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
* @endparblock
*/
@@ -259,6 +276,10 @@ const char *rtems_fatal_source_text( rtems_fatal_source fatal_source );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
* @endparblock
*/
@@ -286,6 +307,10 @@ const char *rtems_internal_error_text( rtems_fatal_code internal_error_code );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h
index d386a0bcea..90dfa3bf92 100644
--- a/cpukit/include/rtems/init.h
+++ b/cpukit/include/rtems/init.h
@@ -96,6 +96,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive should be called by boot_card() only.
*
* * The directive will not return to the caller.
@@ -120,6 +124,10 @@ RTEMS_NO_RETURN void rtems_initialize_executive( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not return to the caller.
diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
index 181da9fe4f..ecc89e16a2 100644
--- a/cpukit/include/rtems/io.h
+++ b/cpukit/include/rtems/io.h
@@ -228,6 +228,15 @@ typedef struct {
* After a successful registration, the rtems_io_initialize() directive will be
* called to initialize the device.
* @endparblock
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_register_driver(
rtems_device_major_number major,
@@ -254,6 +263,15 @@ rtems_status_code rtems_io_register_driver(
*
* @par Notes
* Currently no specific checks are made and the driver is not closed.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
@@ -294,6 +312,15 @@ rtems_status_code rtems_io_unregister_driver(
* hardware and data structures associated with a device. If necessary, it can
* allocate memory to be used during other operations.
* @endparblock
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
@@ -322,6 +349,15 @@ rtems_status_code rtems_io_initialize(
*
* @par Notes
* The device is registered as a character device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_register_name(
const char *device_name,
@@ -354,6 +390,15 @@ rtems_status_code rtems_io_register_name(
* @par Notes
* The open entry point is commonly used by device drivers to provide exclusive
* access to a device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_open(
rtems_device_major_number major,
@@ -386,6 +431,15 @@ rtems_status_code rtems_io_open(
* @par Notes
* The close entry point is commonly used by device drivers to relinquish
* exclusive access to a device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_close(
rtems_device_major_number major,
@@ -420,6 +474,15 @@ rtems_status_code rtems_io_close(
* Read operations typically require a buffer address as part of the argument
* parameter block. The contents of this buffer will be replaced with data
* from the device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_read(
rtems_device_major_number major,
@@ -452,6 +515,15 @@ rtems_status_code rtems_io_read(
* @par Notes
* Write operations typically require a buffer address as part of the argument
* parameter block. The contents of this buffer will be sent to the device.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_write(
rtems_device_major_number major,
@@ -489,6 +561,15 @@ rtems_status_code rtems_io_write(
* device drivers are compatible. For example, an RS-232 driver I/O control
* operation may change the baud of a serial line, while an I/O control
* operation for a floppy disk driver may cause a seek operation.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h
index e869769393..d0e5e9593c 100644
--- a/cpukit/include/rtems/rtems/cache.h
+++ b/cpukit/include/rtems/rtems/cache.h
@@ -93,6 +93,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -145,6 +149,10 @@ void rtems_cache_coherent_add_area( void *begin, uintptr_t size );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -171,6 +179,10 @@ void *rtems_cache_coherent_allocate(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -640,6 +652,10 @@ void rtems_cache_disable_instruction( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h
index 7b460ea4fb..d22bdb07e0 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.
@@ -1140,6 +1194,10 @@ static inline bool rtems_clock_tick_before( rtems_interval ticks )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index 3d813c55b6..18462b32a2 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -180,6 +180,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 855ea3ddc6..a913cfef89 100644
--- a/cpukit/include/rtems/rtems/dpmem.h
+++ b/cpukit/include/rtems/rtems/dpmem.h
@@ -129,6 +129,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -195,6 +199,10 @@ rtems_status_code rtems_port_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -225,6 +233,10 @@ rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -272,6 +284,10 @@ rtems_status_code rtems_port_delete( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -319,6 +335,10 @@ rtems_status_code rtems_port_external_to_internal(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h
index 8d4424e628..fe5830ba06 100644
--- a/cpukit/include/rtems/rtems/event.h
+++ b/cpukit/include/rtems/rtems/event.h
@@ -440,6 +440,15 @@ typedef uint32_t rtems_event_set;
/**
* @brief This event set constant represents the reserved system event for a
* network socket close.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_NETWORK_CLOSE RTEMS_EVENT_26
@@ -448,6 +457,15 @@ typedef uint32_t rtems_event_set;
/**
* @brief This event set constant represents the reserved system event for a
* network socket buffer wait usage.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_NETWORK_SBWAIT RTEMS_EVENT_24
@@ -456,6 +474,15 @@ typedef uint32_t rtems_event_set;
/**
* @brief This event set constant represents the reserved system event for a
* network socket sleep.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_NETWORK_SOSLEEP RTEMS_EVENT_25
@@ -533,6 +560,15 @@ rtems_status_code rtems_event_system_send(
/**
* @brief This event set constant represents the reserved system event for
* server thread usage, for example the timer or interrupt server.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_SERVER RTEMS_EVENT_30
@@ -541,6 +577,15 @@ rtems_status_code rtems_event_system_send(
/**
* @brief This event set constant represents the reserved system event to
* resume a server thread, for example the timer or interrupt server.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_SERVER_RESUME RTEMS_EVENT_29
@@ -549,6 +594,15 @@ rtems_status_code rtems_event_system_send(
/**
* @brief This event set constant represents the reserved system event for
* transient usage.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_EVENT_SYSTEM_TRANSIENT RTEMS_EVENT_31
@@ -561,6 +615,10 @@ rtems_status_code rtems_event_system_send(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -594,6 +652,10 @@ static inline void rtems_event_transient_clear( void )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -628,6 +690,10 @@ static inline rtems_status_code rtems_event_transient_receive(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h
index e37234a79f..07c55b27a8 100644
--- a/cpukit/include/rtems/rtems/intr.h
+++ b/cpukit/include/rtems/rtems/intr.h
@@ -172,6 +172,10 @@ typedef ISR_Handler rtems_isr;
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -251,6 +255,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -293,6 +301,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -341,6 +353,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -487,6 +503,10 @@ rtems_status_code rtems_interrupt_catch(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -925,6 +945,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler shared option
* #RTEMS_INTERRUPT_SHARED is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_SHARED( _options ) \
( ( _options ) & RTEMS_INTERRUPT_SHARED )
@@ -938,6 +967,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler unique option
* #RTEMS_INTERRUPT_UNIQUE is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_UNIQUE( _options ) \
( ( _options ) & RTEMS_INTERRUPT_UNIQUE )
@@ -951,6 +989,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context;
*
* @return Returns true, if the interrupt handler replace option
* #RTEMS_INTERRUPT_REPLACE is set, otherwise false.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_IS_REPLACE( _options ) \
( ( _options ) & RTEMS_INTERRUPT_REPLACE )
@@ -1301,6 +1348,10 @@ rtems_status_code rtems_interrupt_entry_remove(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -1351,6 +1402,10 @@ rtems_status_code rtems_interrupt_handler_install(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2062,6 +2117,15 @@ rtems_status_code rtems_interrupt_handler_iterate(
* @ingroup RTEMSAPIClassicIntr
*
* @brief The constant represents the index of the default interrupt server.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_INTERRUPT_SERVER_DEFAULT 0
@@ -2228,6 +2292,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2276,6 +2344,10 @@ rtems_status_code rtems_interrupt_server_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2354,6 +2426,10 @@ rtems_status_code rtems_interrupt_server_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2405,6 +2481,10 @@ rtems_status_code rtems_interrupt_server_handler_install(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -2469,6 +2549,10 @@ rtems_status_code rtems_interrupt_server_handler_remove(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2517,6 +2601,10 @@ rtems_status_code rtems_interrupt_server_set_affinity(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2552,6 +2640,10 @@ rtems_status_code rtems_interrupt_server_delete( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2587,6 +2679,10 @@ rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2632,6 +2728,10 @@ rtems_status_code rtems_interrupt_server_resume( uint32_t server_index );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2689,6 +2789,10 @@ rtems_status_code rtems_interrupt_server_move(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2801,6 +2905,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -2841,6 +2949,10 @@ rtems_status_code rtems_interrupt_server_entry_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2894,6 +3006,10 @@ void rtems_interrupt_server_action_prepend(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -2943,6 +3059,10 @@ void rtems_interrupt_server_entry_destroy(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -2992,6 +3112,10 @@ void rtems_interrupt_server_entry_submit(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -3088,6 +3212,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -3130,6 +3258,10 @@ rtems_status_code rtems_interrupt_server_request_initialize(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -3181,6 +3313,10 @@ static inline void rtems_interrupt_server_request_set_vector(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive shall not be called from within the context of an interrupt
@@ -3232,6 +3368,10 @@ static inline void rtems_interrupt_server_request_destroy(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h
index 0a76b1f9b8..7cb0591e67 100644
--- a/cpukit/include/rtems/rtems/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -248,6 +248,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h
index 038a84676d..6f70519756 100644
--- a/cpukit/include/rtems/rtems/modes.h
+++ b/cpukit/include/rtems/rtems/modes.h
@@ -161,6 +161,15 @@ extern "C" {
* @par Notes
* This task mode constant is used by bindings from languages other than C and
* C++.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this object:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
extern const uint32_t rtems_interrupt_mask;
@@ -187,6 +196,15 @@ typedef uint32_t rtems_mode;
*
* @par Notes
* This function is used by bindings from languages other than C and C++.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
rtems_mode rtems_interrupt_level_body( uint32_t level );
diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h
index 614a65fe4c..c2ff0e7db7 100644
--- a/cpukit/include/rtems/rtems/mp.h
+++ b/cpukit/include/rtems/rtems/mp.h
@@ -122,6 +122,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization
@@ -145,6 +149,15 @@ void rtems_multiprocessing_announce( void );
*
* In packets longer than this value, some of the extra data may be a user
* message buffer which is not automatically endian swapped.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION
@@ -155,6 +168,15 @@ void rtems_multiprocessing_announce( void );
*
* @brief This constant defines the minimum packet size which must be supported
* by the MPCI.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index 02b8ef01e2..2f2513893e 100644
--- a/cpukit/include/rtems/rtems/object.h
+++ b/cpukit/include/rtems/rtems/object.h
@@ -126,6 +126,15 @@ typedef struct {
* @ingroup RTEMSAPIClassicObject
*
* @brief This constant represents the highest object identifier value.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL
@@ -136,6 +145,15 @@ typedef struct {
*
* @brief This constant represents the highest value for the index component of
* an object identifier.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX
@@ -160,6 +178,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -175,6 +197,15 @@ typedef struct {
*
* @brief This constant represents the lowest value for the index component of
* an object identifier.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX
@@ -241,6 +272,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -256,6 +291,17 @@ rtems_id rtems_build_id(
);
/* Generated from spec:/rtems/object/if/build-id-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_build_id( _api, _class, _node, _index ) \
_Objects_Build_id( _api, _class, _node, _index )
@@ -327,6 +373,10 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -374,6 +424,10 @@ rtems_status_code rtems_object_get_classic_name(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -427,6 +481,10 @@ char *rtems_object_get_name( rtems_id id, size_t length, char *name );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -456,6 +514,10 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -466,6 +528,17 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
int rtems_object_id_get_api( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-api-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_api( _id ) _Objects_Get_API( _id )
/* Generated from spec:/rtems/object/if/id-get-class */
@@ -486,6 +559,10 @@ int rtems_object_id_get_api( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -496,6 +573,17 @@ int rtems_object_id_get_api( rtems_id id );
int rtems_object_id_get_class( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-class-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_class( _id ) _Objects_Get_class( _id )
/* Generated from spec:/rtems/object/if/id-get-node */
@@ -516,6 +604,10 @@ int rtems_object_id_get_class( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -526,6 +618,17 @@ int rtems_object_id_get_class( rtems_id id );
int rtems_object_id_get_node( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-node-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_node( _id ) _Objects_Get_node( _id )
/* Generated from spec:/rtems/object/if/id-get-index */
@@ -546,6 +649,10 @@ int rtems_object_id_get_node( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -556,6 +663,17 @@ int rtems_object_id_get_node( rtems_id id );
int rtems_object_id_get_index( rtems_id id );
/* Generated from spec:/rtems/object/if/id-get-index-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_get_index( _id ) _Objects_Get_index( _id )
/* Generated from spec:/rtems/object/if/id-api-minimum */
@@ -573,6 +691,10 @@ int rtems_object_id_get_index( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -583,6 +705,17 @@ int rtems_object_id_get_index( rtems_id id );
int rtems_object_id_api_minimum( void );
/* Generated from spec:/rtems/object/if/id-api-minimum-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_api_minimum() OBJECTS_INTERNAL_API
/* Generated from spec:/rtems/object/if/id-api-maximum */
@@ -600,6 +733,10 @@ int rtems_object_id_api_minimum( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -610,6 +747,17 @@ int rtems_object_id_api_minimum( void );
int rtems_object_id_api_maximum( void );
/* Generated from spec:/rtems/object/if/id-api-maximum-macro */
+
+/**
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
+ */
#define rtems_object_id_api_maximum() OBJECTS_APIS_LAST
/* Generated from spec:/rtems/object/if/api-minimum-class */
@@ -629,6 +777,10 @@ int rtems_object_id_api_maximum( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -653,6 +805,10 @@ int rtems_object_api_minimum_class( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -680,6 +836,10 @@ int rtems_object_api_maximum_class( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -712,6 +872,10 @@ const char *rtems_object_get_api_name( int api );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -746,6 +910,10 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h
index 7c789a204b..015cb95680 100644
--- a/cpukit/include/rtems/rtems/ratemon.h
+++ b/cpukit/include/rtems/rtems/ratemon.h
@@ -572,6 +572,10 @@ rtems_status_code rtems_rate_monotonic_get_status(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may be called from within interrupt context.
@@ -605,6 +609,10 @@ rtems_status_code rtems_rate_monotonic_get_statistics(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may be called from within interrupt context.
@@ -628,6 +636,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -650,6 +662,10 @@ void rtems_rate_monotonic_reset_all_statistics( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
@@ -674,6 +690,10 @@ void rtems_rate_monotonic_report_statistics( void );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within task context.
*
* * The directive may obtain and release the object allocator mutex. This may
diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h
index 94a8d7008f..2bffb6e705 100644
--- a/cpukit/include/rtems/rtems/region.h
+++ b/cpukit/include/rtems/rtems/region.h
@@ -115,6 +115,10 @@ extern "C" {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -210,6 +214,10 @@ rtems_status_code rtems_region_get_segment_size(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -277,6 +285,10 @@ rtems_status_code rtems_region_create(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -314,6 +326,10 @@ rtems_status_code rtems_region_ident( rtems_name name, rtems_id *id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -371,6 +387,10 @@ rtems_status_code rtems_region_delete( rtems_id id );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -470,6 +490,10 @@ rtems_status_code rtems_region_extend(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -533,6 +557,10 @@ rtems_status_code rtems_region_get_segment(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -590,6 +618,10 @@ rtems_status_code rtems_region_return_segment( rtems_id id, void *segment );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -647,6 +679,10 @@ rtems_status_code rtems_region_resize_segment(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -704,6 +740,10 @@ rtems_status_code rtems_region_get_information(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/scheduler.h b/cpukit/include/rtems/rtems/scheduler.h
index 8bd041558f..df02d17da1 100644
--- a/cpukit/include/rtems/rtems/scheduler.h
+++ b/cpukit/include/rtems/rtems/scheduler.h
@@ -282,6 +282,10 @@ rtems_status_code rtems_scheduler_get_maximum_priority(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -323,6 +327,10 @@ rtems_status_code rtems_scheduler_map_priority_to_posix(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h
index 29bcb27dc1..908088f813 100644
--- a/cpukit/include/rtems/rtems/status.h
+++ b/cpukit/include/rtems/rtems/status.h
@@ -298,6 +298,15 @@ typedef enum {
* @retval EPERM The status code was ::RTEMS_NOT_OWNER_OF_RESOURCE.
*
* @retval ETIMEDOUT The status code was ::RTEMS_TIMEOUT.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
int rtems_status_code_to_errno( rtems_status_code status_code );
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h
index 356e29739b..2da84d43bb 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -122,6 +122,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -145,6 +149,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive is implemented by a macro and may be called from within
* C/C++ constant expressions. In addition, a function implementation of the
* directive exists for bindings to other programming languages.
@@ -173,6 +181,10 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within any runtime context.
*
* * The directive will not cause the calling task to be preempted.
@@ -243,6 +255,10 @@ static inline void rtems_name_to_characters(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -270,6 +286,10 @@ bool rtems_workspace_allocate( size_t bytes, void **pointer );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -299,6 +319,10 @@ bool rtems_workspace_free( void *pointer );
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -327,6 +351,15 @@ bool rtems_workspace_get_information( Heap_Information_block *the_info );
*
* @return The returned pointer value may be used to free the greedy allocation
* by calling rtems_workspace_greedy_free().
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ * @endparblock
*/
void *rtems_workspace_greedy_allocate(
const uintptr_t *block_sizes,
@@ -357,6 +390,10 @@ void *rtems_workspace_greedy_allocate(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
@@ -388,6 +425,10 @@ void *rtems_workspace_greedy_allocate_all_except_largest(
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within device driver initialization
* context.
*
diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h
index 0f13c04bda..4e6c9c247e 100644
--- a/cpukit/include/rtems/rtems/timer.h
+++ b/cpukit/include/rtems/rtems/timer.h
@@ -82,6 +82,15 @@ extern "C" {
* @ingroup RTEMSAPIClassicTimer
*
* @brief This timer class bit indicates that the timer is not dormant.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_NOT_DORMANT 0x4
@@ -92,6 +101,15 @@ extern "C" {
*
* @brief This timer class bit indicates that the timer routine executes in a
* task context.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_ON_TASK 0x2
@@ -101,6 +119,15 @@ extern "C" {
* @ingroup RTEMSAPIClassicTimer
*
* @brief This timer class bit indicates that the timer uses a time of day.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this constant:
+ *
+ * * The constant is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the constant.
+ * @endparblock
*/
#define TIMER_CLASS_BIT_TIME_OF_DAY 0x1
@@ -208,6 +235,10 @@ typedef struct {
* @parblock
* The following constraints apply to this directive:
*
+ * * The directive is not included in the pre-qualified feature set of RTEMS.
+ * Applications which are restricted to only use interfaces of the
+ * pre-qualified feature set of RTEMS shall not use the directive.
+ *
* * The directive may be called from within interrupt context.
*
* * The directive may be called from within device driver initialization