diff options
Diffstat (limited to 'cpukit/doxygen/appl-config.h')
| -rw-r--r-- | cpukit/doxygen/appl-config.h | 615 |
1 files changed, 583 insertions, 32 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 167fa30520..dd0fd8b369 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. * @@ -1005,6 +1078,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. * @@ -1115,8 +1192,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 @@ -1141,6 +1226,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. @@ -1194,6 +1284,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 @@ -1228,6 +1323,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 @@ -1251,6 +1351,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. @@ -1273,6 +1378,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. */ @@ -1290,6 +1400,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 @@ -1313,6 +1428,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 @@ -1351,6 +1471,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 @@ -1398,6 +1523,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. @@ -1416,6 +1546,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 @@ -1447,6 +1582,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 @@ -1470,6 +1610,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. */ @@ -1487,8 +1632,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 @@ -1513,9 +1666,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 @@ -1535,6 +1696,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 @@ -1600,6 +1766,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>. * @@ -1650,6 +1820,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. @@ -1678,6 +1853,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. */ @@ -1703,6 +1883,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. @@ -1724,6 +1909,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. * @@ -1790,6 +1979,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 @@ -1860,6 +2054,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 @@ -1892,6 +2091,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 @@ -1908,6 +2112,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. @@ -1926,6 +2135,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 @@ -1942,6 +2156,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 @@ -1962,6 +2181,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 @@ -1977,6 +2201,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 @@ -1993,6 +2222,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. @@ -2011,6 +2245,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 @@ -2025,6 +2264,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 @@ -2039,6 +2283,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 @@ -2053,6 +2302,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 @@ -2067,6 +2321,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 @@ -2081,6 +2340,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 @@ -2095,6 +2359,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 @@ -2109,6 +2378,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 @@ -2124,6 +2398,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 @@ -2138,6 +2417,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 @@ -2152,6 +2436,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 @@ -2166,6 +2455,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 @@ -2180,6 +2474,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 @@ -2194,6 +2493,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 @@ -2208,6 +2512,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 @@ -2222,6 +2531,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 @@ -2237,8 +2551,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 @@ -2285,6 +2607,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 @@ -2336,6 +2663,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 @@ -2388,6 +2720,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 @@ -2444,6 +2781,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 @@ -2469,6 +2811,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. * @@ -2502,6 +2848,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. * @@ -2604,6 +2954,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 @@ -2627,6 +2982,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 @@ -3368,6 +3773,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. * @@ -3399,6 +3808,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 @@ -3422,6 +3836,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. * @@ -3455,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. * @@ -3484,6 +3906,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. * @@ -3516,8 +3942,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 @@ -3546,6 +3980,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. * @@ -3598,6 +4036,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. * @@ -3637,6 +4079,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. * @@ -3681,6 +4127,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. * @@ -3725,6 +4175,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. * @@ -3768,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. * @@ -3817,6 +4275,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. * @@ -3860,6 +4322,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. * @@ -3911,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 greater than or equal to * zero. * @@ -3960,6 +4430,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 @@ -3999,8 +4473,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 @@ -4023,6 +4505,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. * @@ -4046,6 +4532,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 @@ -4115,6 +4606,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. * @@ -4254,6 +4749,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. @@ -4280,6 +4780,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. @@ -4433,6 +4938,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. @@ -4465,6 +4975,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. @@ -4497,6 +5012,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. @@ -4523,6 +5043,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. @@ -4551,6 +5076,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. @@ -4639,6 +5169,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. @@ -4797,9 +5332,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 @@ -4857,11 +5400,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 |