diff options
Diffstat (limited to 'cpukit/doxygen/appl-config.h')
| -rw-r--r-- | cpukit/doxygen/appl-config.h | 610 |
1 files changed, 578 insertions, 32 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 358eae14ac..ed732a7ffa 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. * @@ -1859,6 +2048,11 @@ * If this configuration option is undefined, then a base filesystem and the * configured filesystems are initialized during system initialization. * + * @par Constraints + * The configuration option is mandatory for the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall define the configuration option. + * * @par Notes * Filesystems shall be initialized to support file descriptor based device * drivers and basic input/output functions such as printf(). Filesystems can @@ -1891,6 +2085,11 @@ * @par Default Configuration * If this configuration option is undefined, then the described feature is not * enabled. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_FILESYSTEM_ALL @@ -1907,6 +2106,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * This filesystem requires a Block Device Cache configuration, see * #CONFIGURE_APPLICATION_NEEDS_LIBBLOCK. @@ -1925,6 +2129,11 @@ * @par Default Configuration * If this configuration option is undefined, then the described feature is not * enabled. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_FILESYSTEM_FTPFS @@ -1941,6 +2150,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * Applications will rarely need this configuration option. This configuration * option is intended for test programs. You do not need to define this @@ -1961,6 +2175,11 @@ * @par Default Configuration * If this configuration option is undefined, then the described feature is not * enabled. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_FILESYSTEM_JFFS2 @@ -1976,6 +2195,11 @@ * @par Default Configuration * If this configuration option is undefined, then the described feature is not * enabled. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_FILESYSTEM_NFS @@ -1992,6 +2216,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * This filesystem requires a Block Device Cache configuration, see * #CONFIGURE_APPLICATION_NEEDS_LIBBLOCK. @@ -2010,6 +2239,11 @@ * @par Default Configuration * If this configuration option is undefined, then the described feature is not * enabled. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_FILESYSTEM_TFTPFS @@ -2024,6 +2258,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * changing the mode of files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_CHMOD @@ -2038,6 +2277,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * changing the ownership of files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_CHOWN @@ -2052,6 +2296,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports hard * links. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_LINK @@ -2066,6 +2315,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * making files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_MKNOD @@ -2080,6 +2334,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * making device files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE @@ -2094,6 +2353,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * making regular files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_MKNOD_FILE @@ -2108,6 +2372,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * mounting other filesystems. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_MOUNT @@ -2123,6 +2392,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * reading directories. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_READDIR @@ -2137,6 +2411,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * reading symbolic links. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_READLINK @@ -2151,6 +2430,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * renaming files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_RENAME @@ -2165,6 +2449,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * removing files. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_RMNOD @@ -2179,6 +2468,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * creating symbolic links. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_SYMLINK @@ -2193,6 +2487,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * unmounting other filesystems. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_UNMOUNT @@ -2207,6 +2506,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * changing file times. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_UTIME @@ -2221,6 +2525,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS does not * support making FIFOs (no support for mkfifo()). + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_ENABLE_MKFIFO @@ -2236,8 +2545,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 @@ -2284,6 +2601,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * In case this configuration option is defined, then the following @@ -2335,6 +2657,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * In case this configuration option is defined, then the following @@ -2387,6 +2714,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * Dirtying memory can add significantly to system initialization time. It may @@ -2443,6 +2775,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is mandatory for the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall define the configuration option. + * * @par Notes * You can enable this option to reduce the size of the :term:`TCB`. Use this * option with care, since it can lead to race conditions and undefined system @@ -2468,6 +2805,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. * @@ -2501,6 +2842,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. * @@ -2603,6 +2948,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * The dirtying performed by this option is carried out for each successful * memory allocation from the C Program Heap in contrast to @@ -2626,6 +2976,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. * @@ -2695,6 +3050,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. * @@ -2735,6 +3094,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. * @@ -2772,6 +3135,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. * @@ -2946,6 +3313,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * The stack checker performs run-time stack bounds checking. This increases @@ -2997,6 +3369,11 @@ * If this configuration option is undefined, then there will be separate * memory pools for the RTEMS Workspace and C Program Heap. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * Having separate pools does have some advantages in the event a task blows a @@ -3028,8 +3405,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 @@ -3054,6 +3439,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * @parblock * When using unlimited objects, it is common practice to also specify @@ -3080,6 +3470,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * You may use this feature to debug system initialization issues. The * printk() function is used to print the information. @@ -3099,6 +3494,11 @@ * If this configuration option is undefined, then the described feature is not * enabled. * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. + * * @par Notes * Zeroing memory can add significantly to the system initialization time. It * is not necessary for RTEMS but is often assumed by support libraries. In @@ -3266,6 +3666,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. * @@ -3297,6 +3701,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 @@ -3320,6 +3729,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. * @@ -3353,6 +3766,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. * @@ -3382,6 +3799,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. * @@ -3414,8 +3835,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 @@ -3444,6 +3873,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. * @@ -3496,6 +3929,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. * @@ -3535,6 +3972,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. * @@ -3579,6 +4020,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. * @@ -3623,6 +4068,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. * @@ -3666,6 +4115,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 +4168,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. * @@ -3758,6 +4215,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. * @@ -3809,6 +4270,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 +4323,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 @@ -3897,8 +4366,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 @@ -3921,6 +4398,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. * @@ -3944,6 +4425,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 @@ -4013,6 +4499,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. * @@ -4152,6 +4642,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. @@ -4178,6 +4673,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. @@ -4331,6 +4831,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. @@ -4363,6 +4868,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. @@ -4395,6 +4905,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. @@ -4421,6 +4936,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. @@ -4449,6 +4969,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. @@ -4537,6 +5062,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. @@ -4673,9 +5203,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 @@ -4733,11 +5271,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 |