diff options
Diffstat (limited to 'cpukit/doxygen/appl-config.h')
-rw-r--r-- | cpukit/doxygen/appl-config.h | 620 |
1 files changed, 588 insertions, 32 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index ccc9032300..cf32a9895d 100644 --- a/cpukit/doxygen/appl-config.h +++ b/cpukit/doxygen/appl-config.h @@ -86,6 +86,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 @@ -110,6 +115,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. * @@ -136,6 +145,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. * @@ -162,6 +175,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. * @@ -188,6 +205,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,6 +240,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. * @@ -241,9 +266,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 @@ -264,6 +297,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 * @ref CONFIGURE_MINIMUM_TASK_STACK_SIZE. * @@ -296,6 +333,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. * @@ -322,6 +363,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. * @@ -344,9 +389,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 @@ -367,6 +420,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. * @@ -390,9 +447,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 @@ -588,6 +653,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. * @@ -628,6 +697,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. * @@ -1078,6 +1151,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 * @ref CONFIGURE_MINIMUM_TASK_STACK_SIZE. * @@ -1198,8 +1275,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 @@ -1226,6 +1311,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. @@ -1283,6 +1373,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 @@ -1319,6 +1414,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 @@ -1344,6 +1444,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. @@ -1368,6 +1473,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. */ @@ -1387,6 +1497,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 @@ -1412,6 +1527,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 @@ -1452,6 +1572,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 @@ -1501,6 +1626,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. @@ -1521,6 +1651,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 @@ -1554,6 +1689,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 @@ -1579,6 +1719,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. */ @@ -1598,8 +1743,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 @@ -1626,9 +1779,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 @ref @@ -1650,6 +1811,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 @@ -1717,6 +1883,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>. * @@ -1769,6 +1939,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. @@ -1799,6 +1974,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. */ @@ -1826,6 +2006,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. @@ -1851,6 +2036,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 interrupt event recording generates interrupt entry and exit events when * interrupt entries are dispatched. @@ -1874,6 +2064,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. * @@ -1942,6 +2136,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 @@ -2014,6 +2213,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 @@ -2048,6 +2252,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 @@ -2066,6 +2275,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 @ref * CONFIGURE_APPLICATION_NEEDS_LIBBLOCK. @@ -2086,6 +2300,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 @@ -2104,6 +2323,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 @@ -2126,6 +2350,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 @@ -2143,6 +2372,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 @@ -2161,6 +2395,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 @ref * CONFIGURE_APPLICATION_NEEDS_LIBBLOCK. @@ -2181,6 +2420,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 @@ -2197,6 +2441,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 @@ -2213,6 +2462,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 @@ -2229,6 +2483,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 @@ -2245,6 +2504,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 @@ -2261,6 +2525,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 @@ -2277,6 +2546,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 @@ -2293,6 +2567,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 @@ -2310,6 +2589,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 @@ -2326,6 +2610,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 @@ -2342,6 +2631,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 @@ -2358,6 +2652,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 @@ -2374,6 +2673,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 @@ -2390,6 +2694,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 @@ -2406,6 +2715,11 @@ * @par Default Configuration * If this configuration option is undefined, then the root IMFS supports * changing file times. + * + * @par Constraints + * The configuration option is not included in the pre-qualified feature set of + * RTEMS. Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the configuration option. */ #define CONFIGURE_IMFS_DISABLE_UTIME @@ -2422,6 +2736,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 @@ -2439,8 +2758,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 @@ -2489,6 +2816,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 @@ -2542,6 +2874,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 @@ -2596,6 +2933,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 @@ -2656,6 +2998,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 @@ -2683,6 +3030,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. * @@ -2718,6 +3069,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. * @@ -2847,6 +3202,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 @ref @@ -2872,6 +3232,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. * @@ -2995,6 +3360,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. * @@ -3037,6 +3406,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. * @@ -3076,6 +3449,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. * @@ -3256,6 +3633,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 @@ -3311,6 +3693,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 @@ -3344,8 +3731,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 @@ -3372,6 +3767,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 @ref @@ -3400,6 +3800,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. @@ -3421,6 +3826,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 @@ -3657,6 +4067,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. * @@ -3690,6 +4104,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 @@ -3715,6 +4134,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. * @@ -3750,6 +4173,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. * @@ -3781,6 +4208,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. * @@ -3815,8 +4246,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 @@ -3847,6 +4286,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. * @@ -3901,6 +4344,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. * @@ -3942,6 +4389,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. * @@ -3988,6 +4439,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. * @@ -4034,6 +4489,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. * @@ -4079,6 +4538,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. * @@ -4130,6 +4593,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. * @@ -4175,6 +4642,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. * @@ -4228,6 +4699,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. * @@ -4279,6 +4754,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 @@ -4320,8 +4799,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 @@ -4346,6 +4833,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 * @ref CONFIGURE_MINIMUM_TASK_STACK_SIZE. * @@ -4371,6 +4862,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 at least one of the following configuration @@ -4447,6 +4943,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. * @@ -4592,6 +5092,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. @@ -4620,6 +5125,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. @@ -4781,6 +5291,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. @@ -4815,6 +5330,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. @@ -4849,6 +5369,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. @@ -4877,6 +5402,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. @@ -4907,6 +5437,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. @@ -4999,6 +5534,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. @@ -5166,9 +5706,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 @@ -5230,11 +5778,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 |