diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2022-08-11 09:46:36 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-20 11:28:24 +0200 |
| commit | 8751016f8f8a25159fe3914854f670775f8d5886 (patch) | |
| tree | 2bee1f2124e1c3460a2eed325f17b411f4ba0fc4 | |
| parent | c7b64cd61ff07ae1e46d4bb41cb7ed59cef79f12 (diff) | |
Add pre-qualified constraintsqual-84
23 files changed, 1459 insertions, 32 deletions
diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h index 558a40cb0b..1eeb9664e2 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 diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h index a03e08c6a9..31580cd800 100644 --- a/cpukit/include/rtems/bspIo.h +++ b/cpukit/include/rtems/bspIo.h @@ -188,6 +188,10 @@ void rtems_put_char( int c, void *unused ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -224,6 +228,10 @@ int putk( const char *s ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -262,6 +270,10 @@ RTEMS_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -302,6 +314,10 @@ int vprintk( const char *fmt, va_list ap ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h index 40d703d61a..8aef7d034b 100644 --- a/cpukit/include/rtems/config.h +++ b/cpukit/include/rtems/config.h @@ -137,6 +137,15 @@ extern "C" { * * @brief This flag is used in augment a resource number so that it indicates * an unlimited resource. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ #define RTEMS_UNLIMITED_OBJECTS OBJECTS_UNLIMITED_OBJECTS @@ -187,6 +196,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -201,6 +214,15 @@ uintptr_t rtems_configuration_get_stack_space_size( void ); * * @brief This constant evaluates to #TRUE, if this processor variant has * hardware floating point support, otherwise to #FALSE. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_HAS_HARDWARE_FP CPU_HARDWARE_FP @@ -256,6 +278,10 @@ typedef Stack_Allocator_free rtems_stack_free_hook; * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -276,6 +302,10 @@ const char *rtems_get_build_label( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -310,6 +340,10 @@ const char *rtems_get_copyright_notice( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -334,6 +368,10 @@ const char *rtems_get_target_hash( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -360,6 +398,10 @@ const char *rtems_get_version_string( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -601,6 +643,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -681,6 +727,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -760,6 +810,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -781,6 +835,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -803,6 +861,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -830,6 +892,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -855,6 +921,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -880,6 +950,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -911,6 +985,10 @@ uint32_t rtems_configuration_get_maximum_extensions( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. diff --git a/cpukit/include/rtems/cpuuse.h b/cpukit/include/rtems/cpuuse.h index f02f004073..ff707cffc2 100644 --- a/cpukit/include/rtems/cpuuse.h +++ b/cpukit/include/rtems/cpuuse.h @@ -90,6 +90,10 @@ struct rtems_printer; * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -111,6 +115,10 @@ int rtems_cpu_info_report( const struct rtems_printer *printer ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -135,6 +143,10 @@ void rtems_cpu_usage_report( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -182,6 +194,10 @@ void rtems_cpu_usage_reset( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -210,6 +226,10 @@ void rtems_cpu_usage_top( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may diff --git a/cpukit/include/rtems/fatal.h b/cpukit/include/rtems/fatal.h index 680fd4f934..f84385dfcf 100644 --- a/cpukit/include/rtems/fatal.h +++ b/cpukit/include/rtems/fatal.h @@ -180,6 +180,10 @@ RTEMS_NO_RETURN static inline void rtems_fatal( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not return to the caller. @@ -209,6 +213,15 @@ RTEMS_NO_RETURN RTEMS_PRINTFLIKE( 1, 2 ) void rtems_panic( * * The exception frame is printed in an architecture-dependent format using * printk(). + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ static inline void rtems_exception_frame_print( const rtems_exception_frame *frame @@ -235,6 +248,10 @@ static inline void rtems_exception_frame_print( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * @endparblock */ @@ -259,6 +276,10 @@ const char *rtems_fatal_source_text( rtems_fatal_source fatal_source ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * @endparblock */ @@ -286,6 +307,10 @@ const char *rtems_internal_error_text( rtems_fatal_code internal_error_code ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not return to the caller. diff --git a/cpukit/include/rtems/init.h b/cpukit/include/rtems/init.h index 0ae483edf5..46b1df9c38 100644 --- a/cpukit/include/rtems/init.h +++ b/cpukit/include/rtems/init.h @@ -96,6 +96,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive should be called by boot_card() only. * * * The directive will not return to the caller. @@ -120,6 +124,10 @@ RTEMS_NO_RETURN void rtems_initialize_executive( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not return to the caller. diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h index b6a25b5f2f..2739a9c7f4 100644 --- a/cpukit/include/rtems/io.h +++ b/cpukit/include/rtems/io.h @@ -228,6 +228,15 @@ typedef struct { * After a successful registration, the rtems_io_initialize() directive will be * called to initialize the device. * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_register_driver( rtems_device_major_number major, @@ -254,6 +263,15 @@ rtems_status_code rtems_io_register_driver( * * @par Notes * Currently no specific checks are made and the driver is not closed. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_unregister_driver( rtems_device_major_number major @@ -294,6 +312,15 @@ rtems_status_code rtems_io_unregister_driver( * hardware and data structures associated with a device. If necessary, it can * allocate memory to be used during other operations. * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_initialize( rtems_device_major_number major, @@ -322,6 +349,15 @@ rtems_status_code rtems_io_initialize( * * @par Notes * The device is registered as a character device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_register_name( const char *device_name, @@ -354,6 +390,15 @@ rtems_status_code rtems_io_register_name( * @par Notes * The open entry point is commonly used by device drivers to provide exclusive * access to a device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_open( rtems_device_major_number major, @@ -386,6 +431,15 @@ rtems_status_code rtems_io_open( * @par Notes * The close entry point is commonly used by device drivers to relinquish * exclusive access to a device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_close( rtems_device_major_number major, @@ -420,6 +474,15 @@ rtems_status_code rtems_io_close( * Read operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be replaced with data * from the device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_read( rtems_device_major_number major, @@ -452,6 +515,15 @@ rtems_status_code rtems_io_read( * @par Notes * Write operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be sent to the device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_write( rtems_device_major_number major, @@ -489,6 +561,15 @@ rtems_status_code rtems_io_write( * device drivers are compatible. For example, an RS-232 driver I/O control * operation may change the baud of a serial line, while an I/O control * operation for a floppy disk driver may cause a seek operation. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_control( rtems_device_major_number major, diff --git a/cpukit/include/rtems/rtems/cache.h b/cpukit/include/rtems/rtems/cache.h index 20c630a3eb..0153b39f30 100644 --- a/cpukit/include/rtems/rtems/cache.h +++ b/cpukit/include/rtems/rtems/cache.h @@ -93,6 +93,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -145,6 +149,10 @@ void rtems_cache_coherent_add_area( void *begin, uintptr_t size ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -171,6 +179,10 @@ void *rtems_cache_coherent_allocate( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -640,6 +652,10 @@ void rtems_cache_disable_instruction( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h index 5a8d0a44f9..18fefc119a 100644 --- a/cpukit/include/rtems/rtems/clock.h +++ b/cpukit/include/rtems/rtems/clock.h @@ -209,6 +209,10 @@ rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -830,6 +834,10 @@ void rtems_clock_get_boot_time_timeval( struct timeval *boot_time ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -949,6 +957,10 @@ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -974,6 +986,10 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -999,6 +1015,10 @@ time_t rtems_clock_get_uptime_seconds( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -1025,6 +1045,10 @@ uint64_t rtems_clock_get_uptime_nanoseconds( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -1054,6 +1078,10 @@ static inline rtems_interval rtems_clock_tick_later( rtems_interval delta ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -1115,6 +1143,10 @@ static inline rtems_interval rtems_clock_tick_later_usec( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -1140,6 +1172,10 @@ static inline bool rtems_clock_tick_before( rtems_interval ticks ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h index d225902bf1..356d622faa 100644 --- a/cpukit/include/rtems/rtems/config.h +++ b/cpukit/include/rtems/rtems/config.h @@ -428,6 +428,10 @@ uint32_t rtems_configuration_get_maximum_timers( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. diff --git a/cpukit/include/rtems/rtems/dpmem.h b/cpukit/include/rtems/rtems/dpmem.h index 62e34053ea..712855ac46 100644 --- a/cpukit/include/rtems/rtems/dpmem.h +++ b/cpukit/include/rtems/rtems/dpmem.h @@ -129,6 +129,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -195,6 +199,10 @@ rtems_status_code rtems_port_create( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -225,6 +233,10 @@ rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -272,6 +284,10 @@ rtems_status_code rtems_port_delete( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -319,6 +335,10 @@ rtems_status_code rtems_port_external_to_internal( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h index 81aa57585f..a4c127fa5b 100644 --- a/cpukit/include/rtems/rtems/event.h +++ b/cpukit/include/rtems/rtems/event.h @@ -440,6 +440,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket close. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_NETWORK_CLOSE RTEMS_EVENT_26 @@ -448,6 +457,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket buffer wait usage. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_NETWORK_SBWAIT RTEMS_EVENT_24 @@ -456,6 +474,15 @@ typedef uint32_t rtems_event_set; /** * @brief This event set constant represents the reserved system event for a * network socket sleep. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_NETWORK_SOSLEEP RTEMS_EVENT_25 @@ -533,6 +560,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event for * server thread usage, for example the timer or interrupt server. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_SERVER RTEMS_EVENT_30 @@ -541,6 +577,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event to * resume a server thread, for example the timer or interrupt server. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_SERVER_RESUME RTEMS_EVENT_29 @@ -549,6 +594,15 @@ rtems_status_code rtems_event_system_send( /** * @brief This event set constant represents the reserved system event for * transient usage. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_EVENT_SYSTEM_TRANSIENT RTEMS_EVENT_31 @@ -561,6 +615,10 @@ rtems_status_code rtems_event_system_send( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -594,6 +652,10 @@ static inline void rtems_event_transient_clear( void ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -628,6 +690,10 @@ static inline rtems_status_code rtems_event_transient_receive( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/intr.h b/cpukit/include/rtems/rtems/intr.h index f682112bf5..f8809015e4 100644 --- a/cpukit/include/rtems/rtems/intr.h +++ b/cpukit/include/rtems/rtems/intr.h @@ -172,6 +172,10 @@ typedef ISR_Handler rtems_isr; * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -251,6 +255,10 @@ rtems_status_code rtems_interrupt_catch( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -293,6 +301,10 @@ rtems_status_code rtems_interrupt_catch( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -341,6 +353,10 @@ rtems_status_code rtems_interrupt_catch( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -487,6 +503,10 @@ rtems_status_code rtems_interrupt_catch( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -925,6 +945,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler shared option * #RTEMS_INTERRUPT_SHARED is set, otherwise false. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ #define RTEMS_INTERRUPT_IS_SHARED( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_SHARED ) @@ -938,6 +967,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler unique option * #RTEMS_INTERRUPT_UNIQUE is set, otherwise false. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ #define RTEMS_INTERRUPT_IS_UNIQUE( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_UNIQUE ) @@ -951,6 +989,15 @@ typedef ISR_lock_Context rtems_interrupt_lock_context; * * @return Returns true, if the interrupt handler replace option * #RTEMS_INTERRUPT_REPLACE is set, otherwise false. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ #define RTEMS_INTERRUPT_IS_REPLACE( _options ) \ ( ( _options ) & RTEMS_INTERRUPT_REPLACE ) @@ -1308,6 +1355,10 @@ rtems_status_code rtems_interrupt_entry_remove( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -1358,6 +1409,10 @@ rtems_status_code rtems_interrupt_handler_install( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2069,6 +2124,15 @@ rtems_status_code rtems_interrupt_handler_iterate( * @ingroup RTEMSAPIClassicIntr * * @brief The constant represents the index of the default interrupt server. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_INTERRUPT_SERVER_DEFAULT 0 @@ -2249,6 +2313,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2297,6 +2365,10 @@ rtems_status_code rtems_interrupt_server_initialize( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2375,6 +2447,10 @@ rtems_status_code rtems_interrupt_server_create( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2426,6 +2502,10 @@ rtems_status_code rtems_interrupt_server_handler_install( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -2490,6 +2570,10 @@ rtems_status_code rtems_interrupt_server_handler_remove( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -2538,6 +2622,10 @@ rtems_status_code rtems_interrupt_server_set_affinity( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -2573,6 +2661,10 @@ rtems_status_code rtems_interrupt_server_delete( uint32_t server_index ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -2608,6 +2700,10 @@ rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -2653,6 +2749,10 @@ rtems_status_code rtems_interrupt_server_resume( uint32_t server_index ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -2710,6 +2810,10 @@ rtems_status_code rtems_interrupt_server_move( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2836,6 +2940,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -2876,6 +2984,10 @@ rtems_status_code rtems_interrupt_server_entry_initialize( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -2929,6 +3041,10 @@ void rtems_interrupt_server_action_prepend( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -2978,6 +3094,10 @@ void rtems_interrupt_server_entry_destroy( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -3027,6 +3147,10 @@ void rtems_interrupt_server_entry_submit( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -3130,6 +3254,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -3172,6 +3300,10 @@ rtems_status_code rtems_interrupt_server_request_initialize( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -3223,6 +3355,10 @@ static inline void rtems_interrupt_server_request_set_vector( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive shall not be called from within the context of an interrupt @@ -3274,6 +3410,10 @@ static inline void rtems_interrupt_server_request_destroy( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h index 0967430934..31a393c06a 100644 --- a/cpukit/include/rtems/rtems/message.h +++ b/cpukit/include/rtems/rtems/message.h @@ -248,6 +248,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h index f348941b24..9b55950f3e 100644 --- a/cpukit/include/rtems/rtems/modes.h +++ b/cpukit/include/rtems/rtems/modes.h @@ -161,6 +161,15 @@ extern "C" { * @par Notes * This task mode constant is used by bindings from languages other than C and * C++. + * + * @par Constraints + * @parblock + * The following constraints apply to this object: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ extern const uint32_t rtems_interrupt_mask; @@ -187,6 +196,15 @@ typedef uint32_t rtems_mode; * * @par Notes * This function is used by bindings from languages other than C and C++. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_mode rtems_interrupt_level_body( uint32_t level ); diff --git a/cpukit/include/rtems/rtems/mp.h b/cpukit/include/rtems/rtems/mp.h index 5852f43381..f48fc082a7 100644 --- a/cpukit/include/rtems/rtems/mp.h +++ b/cpukit/include/rtems/rtems/mp.h @@ -122,6 +122,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization @@ -145,6 +149,15 @@ void rtems_multiprocessing_announce( void ); * * In packets longer than this value, some of the extra data may be a user * message buffer which is not automatically endian swapped. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_MINIMUN_HETERO_CONVERSION MP_PACKET_MINIMUN_HETERO_CONVERSION @@ -155,6 +168,15 @@ void rtems_multiprocessing_announce( void ); * * @brief This constant defines the minimum packet size which must be supported * by the MPCI. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_MINIMUM_PACKET_SIZE MP_PACKET_MINIMUM_PACKET_SIZE diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h index bda9a469ed..5de6c73607 100644 --- a/cpukit/include/rtems/rtems/object.h +++ b/cpukit/include/rtems/rtems/object.h @@ -126,6 +126,15 @@ typedef struct { * @ingroup RTEMSAPIClassicObject * * @brief This constant represents the highest object identifier value. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL @@ -136,6 +145,15 @@ typedef struct { * * @brief This constant represents the highest value for the index component of * an object identifier. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX @@ -160,6 +178,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -175,6 +197,15 @@ typedef struct { * * @brief This constant represents the lowest value for the index component of * an object identifier. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX @@ -241,6 +272,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -256,6 +291,17 @@ rtems_id rtems_build_id( ); /* Generated from spec:/rtems/object/if/build-id-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_build_id( _api, _class, _node, _index ) \ _Objects_Build_id( _api, _class, _node, _index ) @@ -327,6 +373,10 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -374,6 +424,10 @@ rtems_status_code rtems_object_get_classic_name( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -427,6 +481,10 @@ char *rtems_object_get_name( rtems_id id, size_t length, char *name ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -456,6 +514,10 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -466,6 +528,17 @@ rtems_status_code rtems_object_set_name( rtems_id id, const char *name ); int rtems_object_id_get_api( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-api-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_api( _id ) _Objects_Get_API( _id ) /* Generated from spec:/rtems/object/if/id-get-class */ @@ -486,6 +559,10 @@ int rtems_object_id_get_api( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -496,6 +573,17 @@ int rtems_object_id_get_api( rtems_id id ); int rtems_object_id_get_class( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-class-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_class( _id ) _Objects_Get_class( _id ) /* Generated from spec:/rtems/object/if/id-get-node */ @@ -516,6 +604,10 @@ int rtems_object_id_get_class( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -526,6 +618,17 @@ int rtems_object_id_get_class( rtems_id id ); int rtems_object_id_get_node( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-node-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_node( _id ) _Objects_Get_node( _id ) /* Generated from spec:/rtems/object/if/id-get-index */ @@ -546,6 +649,10 @@ int rtems_object_id_get_node( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -556,6 +663,17 @@ int rtems_object_id_get_node( rtems_id id ); int rtems_object_id_get_index( rtems_id id ); /* Generated from spec:/rtems/object/if/id-get-index-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_get_index( _id ) _Objects_Get_index( _id ) /* Generated from spec:/rtems/object/if/id-api-minimum */ @@ -573,6 +691,10 @@ int rtems_object_id_get_index( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -583,6 +705,17 @@ int rtems_object_id_get_index( rtems_id id ); int rtems_object_id_api_minimum( void ); /* Generated from spec:/rtems/object/if/id-api-minimum-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_api_minimum() OBJECTS_INTERNAL_API /* Generated from spec:/rtems/object/if/id-api-maximum */ @@ -600,6 +733,10 @@ int rtems_object_id_api_minimum( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -610,6 +747,17 @@ int rtems_object_id_api_minimum( void ); int rtems_object_id_api_maximum( void ); /* Generated from spec:/rtems/object/if/id-api-maximum-macro */ + +/** + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock + */ #define rtems_object_id_api_maximum() OBJECTS_APIS_LAST /* Generated from spec:/rtems/object/if/api-minimum-class */ @@ -629,6 +777,10 @@ int rtems_object_id_api_maximum( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -653,6 +805,10 @@ int rtems_object_api_minimum_class( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -680,6 +836,10 @@ int rtems_object_api_maximum_class( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -712,6 +872,10 @@ const char *rtems_object_get_api_name( int api ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -746,6 +910,10 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. diff --git a/cpukit/include/rtems/rtems/ratemon.h b/cpukit/include/rtems/rtems/ratemon.h index 4b9255e635..d8d9f04bbf 100644 --- a/cpukit/include/rtems/rtems/ratemon.h +++ b/cpukit/include/rtems/rtems/ratemon.h @@ -573,6 +573,10 @@ rtems_status_code rtems_rate_monotonic_get_status( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may be called from within interrupt context. @@ -606,6 +610,10 @@ rtems_status_code rtems_rate_monotonic_get_statistics( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may be called from within interrupt context. @@ -629,6 +637,10 @@ rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -651,6 +663,10 @@ void rtems_rate_monotonic_reset_all_statistics( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may @@ -675,6 +691,10 @@ void rtems_rate_monotonic_report_statistics( void ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within task context. * * * The directive may obtain and release the object allocator mutex. This may diff --git a/cpukit/include/rtems/rtems/region.h b/cpukit/include/rtems/rtems/region.h index 3d9c2bd8bc..b5ccd880e1 100644 --- a/cpukit/include/rtems/rtems/region.h +++ b/cpukit/include/rtems/rtems/region.h @@ -115,6 +115,10 @@ extern "C" { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -211,6 +215,10 @@ rtems_status_code rtems_region_get_segment_size( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -278,6 +286,10 @@ rtems_status_code rtems_region_create( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -315,6 +327,10 @@ rtems_status_code rtems_region_ident( rtems_name name, rtems_id *id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -372,6 +388,10 @@ rtems_status_code rtems_region_delete( rtems_id id ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -471,6 +491,10 @@ rtems_status_code rtems_region_extend( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -534,6 +558,10 @@ rtems_status_code rtems_region_get_segment( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -591,6 +619,10 @@ rtems_status_code rtems_region_return_segment( rtems_id id, void *segment ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -648,6 +680,10 @@ rtems_status_code rtems_region_resize_segment( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -705,6 +741,10 @@ rtems_status_code rtems_region_get_information( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/scheduler.h b/cpukit/include/rtems/rtems/scheduler.h index bec4932c6c..3b3fe86c10 100644 --- a/cpukit/include/rtems/rtems/scheduler.h +++ b/cpukit/include/rtems/rtems/scheduler.h @@ -282,6 +282,10 @@ rtems_status_code rtems_scheduler_get_maximum_priority( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -323,6 +327,10 @@ rtems_status_code rtems_scheduler_map_priority_to_posix( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h index 92a8b03c09..f51643d9f1 100644 --- a/cpukit/include/rtems/rtems/status.h +++ b/cpukit/include/rtems/rtems/status.h @@ -298,6 +298,15 @@ typedef enum { * @retval EPERM The status code was ::RTEMS_NOT_OWNER_OF_RESOURCE. * * @retval ETIMEDOUT The status code was ::RTEMS_TIMEOUT. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ int rtems_status_code_to_errno( rtems_status_code status_code ); diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h index bb2e6e3633..d860053afe 100644 --- a/cpukit/include/rtems/rtems/support.h +++ b/cpukit/include/rtems/rtems/support.h @@ -122,6 +122,10 @@ static inline bool rtems_is_name_valid( rtems_name name ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -145,6 +149,10 @@ static inline bool rtems_is_name_valid( rtems_name name ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive is implemented by a macro and may be called from within * C/C++ constant expressions. In addition, a function implementation of the * directive exists for bindings to other programming languages. @@ -173,6 +181,10 @@ static inline bool rtems_is_name_valid( rtems_name name ) * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within any runtime context. * * * The directive will not cause the calling task to be preempted. @@ -243,6 +255,10 @@ static inline void rtems_name_to_characters( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -270,6 +286,10 @@ bool rtems_workspace_allocate( size_t bytes, void **pointer ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -299,6 +319,10 @@ bool rtems_workspace_free( void *pointer ); * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -327,6 +351,15 @@ bool rtems_workspace_get_information( Heap_Information_block *the_info ); * * @return The returned pointer value may be used to free the greedy allocation * by calling rtems_workspace_greedy_free(). + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ void *rtems_workspace_greedy_allocate( const uintptr_t *block_sizes, @@ -357,6 +390,10 @@ void *rtems_workspace_greedy_allocate( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * @@ -388,6 +425,10 @@ void *rtems_workspace_greedy_allocate_all_except_largest( * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within device driver initialization * context. * diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h index 6af56c1576..614e483d36 100644 --- a/cpukit/include/rtems/rtems/timer.h +++ b/cpukit/include/rtems/rtems/timer.h @@ -82,6 +82,15 @@ extern "C" { * @ingroup RTEMSAPIClassicTimer * * @brief This timer class bit indicates that the timer is not dormant. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define TIMER_CLASS_BIT_NOT_DORMANT 0x4 @@ -92,6 +101,15 @@ extern "C" { * * @brief This timer class bit indicates that the timer routine executes in a * task context. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define TIMER_CLASS_BIT_ON_TASK 0x2 @@ -101,6 +119,15 @@ extern "C" { * @ingroup RTEMSAPIClassicTimer * * @brief This timer class bit indicates that the timer uses a time of day. + * + * @par Constraints + * @parblock + * The following constraints apply to this constant: + * + * * The constant is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the constant. + * @endparblock */ #define TIMER_CLASS_BIT_TIME_OF_DAY 0x1 @@ -208,6 +235,10 @@ typedef struct { * @parblock * The following constraints apply to this directive: * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * * * The directive may be called from within interrupt context. * * * The directive may be called from within device driver initialization |