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 2690b67d21..48980300d1 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. * @@ -1194,8 +1271,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 @@ -1222,6 +1307,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. @@ -1279,6 +1369,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 @@ -1315,6 +1410,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 @@ -1340,6 +1440,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. @@ -1364,6 +1469,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. */ @@ -1383,6 +1493,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 @@ -1408,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 * @parblock * This device driver is responsible for providing the ``/dev/console`` device @@ -1448,6 +1568,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 @@ -1497,6 +1622,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. @@ -1517,6 +1647,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 @@ -1550,6 +1685,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 @@ -1575,6 +1715,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. */ @@ -1594,8 +1739,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 @@ -1622,9 +1775,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 @@ -1646,6 +1807,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 @@ -1713,6 +1879,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>. * @@ -1765,6 +1935,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. @@ -1795,6 +1970,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. */ @@ -1822,6 +2002,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. @@ -1847,6 +2032,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. @@ -1870,6 +2060,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. * @@ -1938,6 +2132,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 @@ -2010,6 +2209,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 @@ -2044,6 +2248,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 @@ -2062,6 +2271,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. @@ -2082,6 +2296,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 @@ -2100,6 +2319,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 @@ -2122,6 +2346,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 @@ -2139,6 +2368,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 @@ -2157,6 +2391,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. @@ -2177,6 +2416,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 @@ -2193,6 +2437,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 @@ -2209,6 +2458,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 @@ -2225,6 +2479,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 @@ -2241,6 +2500,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 @@ -2257,6 +2521,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 @@ -2273,6 +2542,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 @@ -2289,6 +2563,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 @@ -2306,6 +2585,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 @@ -2322,6 +2606,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 @@ -2338,6 +2627,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 @@ -2354,6 +2648,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 @@ -2370,6 +2669,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 @@ -2386,6 +2690,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 @@ -2402,6 +2711,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 @@ -2418,6 +2732,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 @@ -2435,8 +2754,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 @@ -2485,6 +2812,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 @@ -2538,6 +2870,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 @@ -2592,6 +2929,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 @@ -2652,6 +2994,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 @@ -2679,6 +3026,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. * @@ -2714,6 +3065,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. * @@ -2843,6 +3198,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 @@ -2868,6 +3228,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. * @@ -2991,6 +3356,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. * @@ -3033,6 +3402,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. * @@ -3072,6 +3445,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. * @@ -3252,6 +3629,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 @@ -3307,6 +3689,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 @@ -3340,8 +3727,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 @@ -3368,6 +3763,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 @@ -3396,6 +3796,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. @@ -3417,6 +3822,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 @@ -3648,6 +4058,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 +4095,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 @@ -3706,6 +4125,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. * @@ -3741,6 +4164,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. * @@ -3772,6 +4199,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. * @@ -3806,8 +4237,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 @@ -3838,6 +4277,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. * @@ -3892,6 +4335,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. * @@ -3933,6 +4380,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. * @@ -3979,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 greater than or equal to * zero. * @@ -4025,6 +4480,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. * @@ -4070,6 +4529,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. * @@ -4121,6 +4584,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. * @@ -4166,6 +4633,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. * @@ -4219,6 +4690,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. * @@ -4270,6 +4745,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 @@ -4311,8 +4790,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 @@ -4337,6 +4824,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. * @@ -4362,6 +4853,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 @@ -4433,6 +4929,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. * @@ -4578,6 +5078,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. @@ -4606,6 +5111,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. @@ -4767,6 +5277,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. @@ -4801,6 +5316,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. @@ -4835,6 +5355,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. @@ -4863,6 +5388,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. @@ -4893,6 +5423,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. @@ -4985,6 +5520,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. @@ -5152,9 +5692,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 @@ -5216,11 +5764,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 |