diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-26 14:20:52 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:23 +0200 |
| commit | 92ea0a0cdeb38290478685ab40a35b5338592f4d (patch) | |
| tree | d4d03e15f49d73d4555581efc51fdf07c0b85cda /spec/acfg | |
| parent | content: Add and use Content.paste_and_add() (diff) | |
| download | rtems-central-92ea0a0cdeb38290478685ab40a35b5338592f4d.tar.bz2 | |
Rename application configuration attributes
Diffstat (limited to 'spec/acfg')
163 files changed, 1676 insertions, 1676 deletions
diff --git a/spec/acfg/bdbuf.yml b/spec/acfg/bdbuf.yml index 7ebc7262..a3dc4201 100644 --- a/spec/acfg/bdbuf.yml +++ b/spec/acfg/bdbuf.yml @@ -1,14 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the Block Device Cache - (bdbuf). -appl-config-group-name: Block Device Cache Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the Block Device Cache + (bdbuf). enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Block Device Cache Configuration text: '' type: interface diff --git a/spec/acfg/bsp.yml b/spec/acfg/bsp.yml index 527e0ff5..43314ac1 100644 --- a/spec/acfg/bsp.yml +++ b/spec/acfg/bsp.yml @@ -1,16 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes configuration options related to the BSP. Some configuration options may have a BSP-specific setting which is defined by ``<bsp.h>``. The BSP-specific settings can be disabled by the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option. -appl-config-group-name: BSP Related Configuration Options -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: BSP Related Configuration Options text: '' type: interface diff --git a/spec/acfg/classic.yml b/spec/acfg/classic.yml index f884ffe2..cac3f421 100644 --- a/spec/acfg/classic.yml +++ b/spec/acfg/classic.yml @@ -1,13 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the Classic API. -appl-config-group-name: Classic API Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the Classic API. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Classic API Configuration text: '' type: interface diff --git a/spec/acfg/classicinit.yml b/spec/acfg/classicinit.yml index 436481cc..2325b25e 100644 --- a/spec/acfg/classicinit.yml +++ b/spec/acfg/classicinit.yml @@ -1,14 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the Classic API - initialization task. -appl-config-group-name: Classic API Initialization Task Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the Classic API + initialization task. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Classic API Initialization Task Configuration text: '' type: interface diff --git a/spec/acfg/devdrv.yml b/spec/acfg/devdrv.yml index 04bcb0e7..80c05a76 100644 --- a/spec/acfg/devdrv.yml +++ b/spec/acfg/devdrv.yml @@ -1,14 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the device drivers. - Note that network device drivers are not covered by the following options. -appl-config-group-name: Device Driver Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the device drivers. + Note that network device drivers are not covered by the following options. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Device Driver Configuration text: '' type: interface diff --git a/spec/acfg/eventrecord.yml b/spec/acfg/eventrecord.yml index db3a133f..52e2223a 100644 --- a/spec/acfg/eventrecord.yml +++ b/spec/acfg/eventrecord.yml @@ -1,13 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the event recording. -appl-config-group-name: Event Recording Configuration copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + This section describes configuration options related to the event recording. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Event Recording Configuration text: '' type: interface diff --git a/spec/acfg/filesystem.yml b/spec/acfg/filesystem.yml index 67392f38..e6bd9905 100644 --- a/spec/acfg/filesystem.yml +++ b/spec/acfg/filesystem.yml @@ -1,5 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes configuration options related to filesytems. By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also known as root filesystem). In order to save some memory for your application, @@ -41,13 +43,11 @@ appl-config-group-description: | * :ref:`CONFIGURE_IMFS_DISABLE_UTIME` * :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO` -appl-config-group-name: Filesystem Configuration -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Filesystem Configuration text: '' type: interface diff --git a/spec/acfg/general.yml b/spec/acfg/general.yml index 993e970e..200632dd 100644 --- a/spec/acfg/general.yml +++ b/spec/acfg/general.yml @@ -1,13 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes general system configuration options. -appl-config-group-name: General System Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes general system configuration options. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: General System Configuration text: '' type: interface diff --git a/spec/acfg/idle.yml b/spec/acfg/idle.yml index 7e96c144..a317e073 100644 --- a/spec/acfg/idle.yml +++ b/spec/acfg/idle.yml @@ -1,13 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the idle tasks. -appl-config-group-name: Idle Task Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the idle tasks. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Idle Task Configuration text: '' type: interface diff --git a/spec/acfg/mpci.yml b/spec/acfg/mpci.yml index 15cdbb2f..35d8a365 100644 --- a/spec/acfg/mpci.yml +++ b/spec/acfg/mpci.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes multiprocessing related configuration options. The options are only used if RTEMS was built with the ``--enable-multiprocessing`` build configuration option. Additionally, this class of configuration options are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION` is defined. The multiprocessing (MPCI) support must not be confused with the SMP support. -appl-config-group-name: Multiprocessing Configuration -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Multiprocessing Configuration text: '' type: interface diff --git a/spec/acfg/opt/appldisablefilesystem.yml b/spec/acfg/opt/appldisablefilesystem.yml index 7d2ac8ba..bf18b8b6 100644 --- a/spec/acfg/opt/appldisablefilesystem.yml +++ b/spec/acfg/opt/appldisablefilesystem.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then a base filesystem and the configured filesystems are initialized during system initialization. -appl-config-option-description: | +description: | In case this configuration option is defined, then **no** base filesystem is initialized during system initialization and **no** filesystems are configured. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM -appl-config-option-notes: | - Filesystems shall be initialized to support file descriptor based device - drivers and basic input/output functions such as :c:func:`printf`. - Filesystems can be disabled to reduce the memory footprint of an application. -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM +notes: | + Filesystems shall be initialized to support file descriptor based device + drivers and basic input/output functions such as :c:func:`printf`. + Filesystems can be disabled to reduce the memory footprint of an application. text: '' type: interface diff --git a/spec/acfg/opt/appldoesnotneedclockdriver.yml b/spec/acfg/opt/appldoesnotneedclockdriver.yml index aa4232fe..2bd12034 100644 --- a/spec/acfg/opt/appldoesnotneedclockdriver.yml +++ b/spec/acfg/opt/appldoesnotneedclockdriver.yml @@ -1,13 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then a Clock Driver may be initialized during system initialization. -appl-config-option-description: | +description: | In case this configuration option is defined, then **no** Clock Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER +notes: | This configuration parameter is intended to prevent the common user error of using the Hello World example as the baseline for an application and leaving out a clock tick source. @@ -21,13 +29,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, otherwise a compile time error in the configuration file will occur. -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applextradrivers.yml b/spec/acfg/opt/applextradrivers.yml index 6b7b79e7..5fbe28e0 100644 --- a/spec/acfg/opt/applextradrivers.yml +++ b/spec/acfg/opt/applextradrivers.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of initializers for structures of type :c:type:`rtems_driver_address_table`. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is the empty list. -appl-config-option-description: | +description: | The value of this configuration option is used to initialize the Device Driver Table. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_EXTRA_DRIVERS -appl-config-option-notes: | - The value of this configuration option is placed after the entries of other - device driver configuration options. - - See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative - placement of application device driver initializers. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_EXTRA_DRIVERS +notes: | + The value of this configuration option is placed after the entries of other + device driver configuration options. + + See :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS` for an alternative + placement of application device driver initializers. text: '' type: interface diff --git a/spec/acfg/opt/applneedsatadriver.yml b/spec/acfg/opt/applneedsatadriver.yml index f49b68e9..a2c81281 100644 --- a/spec/acfg/opt/applneedsatadriver.yml +++ b/spec/acfg/opt/applneedsatadriver.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the ATA Driver is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER -appl-config-option-notes: | - Most BSPs do not include support for an ATA Driver. - - If this option is defined and the BSP does not have this device driver, then - the user will get a link time error for an undefined symbol. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the ATA Driver is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER +notes: | + Most BSPs do not include support for an ATA Driver. + + If this option is defined and the BSP does not have this device driver, then + the user will get a link time error for an undefined symbol. text: '' type: interface diff --git a/spec/acfg/opt/applneedsclockdriver.yml b/spec/acfg/opt/applneedsclockdriver.yml index 7fa8a725..c8ed8cb0 100644 --- a/spec/acfg/opt/applneedsclockdriver.yml +++ b/spec/acfg/opt/applneedsclockdriver.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the Clock Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER +notes: | The Clock Driver is responsible for providing a regular interrupt which invokes a clock tick directive. @@ -17,13 +25,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, otherwise a compile time error in the configuration file will occur. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applneedsconsoledriver.yml b/spec/acfg/opt/applneedsconsoledriver.yml index fa4d964b..a114def4 100644 --- a/spec/acfg/opt/applneedsconsoledriver.yml +++ b/spec/acfg/opt/applneedsconsoledriver.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the Console Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER +notes: | The Console Driver is responsible for providing the :file:`/dev/console` device file. This device is used to initialize the standard input, output, and error file descriptors. @@ -21,13 +29,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applneedsframebufferdriver.yml b/spec/acfg/opt/applneedsframebufferdriver.yml index 7066cee9..0c22287f 100644 --- a/spec/acfg/opt/applneedsframebufferdriver.yml +++ b/spec/acfg/opt/applneedsframebufferdriver.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Frame Buffer Driver is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER -appl-config-option-notes: | - Most BSPs do not include support for a Frame Buffer Driver. This is - because many boards do not include the required hardware. - - If this option is defined and the BSP does not have this device driver, then - the user will get a link time error for an undefined symbol. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the Frame Buffer Driver is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER +notes: | + Most BSPs do not include support for a Frame Buffer Driver. This is + because many boards do not include the required hardware. + + If this option is defined and the BSP does not have this device driver, then + the user will get a link time error for an undefined symbol. text: '' type: interface diff --git a/spec/acfg/opt/applneedsidedriver.yml b/spec/acfg/opt/applneedsidedriver.yml index 31a2415f..054d3e51 100644 --- a/spec/acfg/opt/applneedsidedriver.yml +++ b/spec/acfg/opt/applneedsidedriver.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the IDE Driver is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER -appl-config-option-notes: | - Most BSPs do not include support for an IDE Driver. - - If this option is defined and the BSP does not have this device driver, then - the user will get a link time error for an undefined symbol. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the IDE Driver is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER +notes: | + Most BSPs do not include support for an IDE Driver. + + If this option is defined and the BSP does not have this device driver, then + the user will get a link time error for an undefined symbol. text: '' type: interface diff --git a/spec/acfg/opt/applneedslibblock.yml b/spec/acfg/opt/applneedslibblock.yml index 9f075926..116b1986 100644 --- a/spec/acfg/opt/applneedslibblock.yml +++ b/spec/acfg/opt/applneedslibblock.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Block Device Cache is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK -appl-config-option-notes: | - Each option of the Block Device Cache (bdbuf) configuration can be explicitly - set by the user with the configuration options below. The Block Device Cache - is used for example by the RFS and DOSFS filesystems. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the Block Device Cache is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK +notes: | + Each option of the Block Device Cache (bdbuf) configuration can be explicitly + set by the user with the configuration options below. The Block Device Cache + is used for example by the RFS and DOSFS filesystems. text: '' type: interface diff --git a/spec/acfg/opt/applneedsnulldriver.yml b/spec/acfg/opt/applneedsnulldriver.yml index 958a9fa6..fe0c71d9 100644 --- a/spec/acfg/opt/applneedsnulldriver.yml +++ b/spec/acfg/opt/applneedsnulldriver.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the :file:`/dev/null` - Driver is initialized during system initialization. -appl-config-option-index: -- /dev/null -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER -appl-config-option-notes: | - This device driver is supported by all BSPs. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the :file:`/dev/null` + Driver is initialized during system initialization. enabled-by: true +index-entries: +- /dev/null interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER +notes: | + This device driver is supported by all BSPs. text: '' type: interface diff --git a/spec/acfg/opt/applneedsrtcdriver.yml b/spec/acfg/opt/applneedsrtcdriver.yml index 8f4e2924..d3f7542f 100644 --- a/spec/acfg/opt/applneedsrtcdriver.yml +++ b/spec/acfg/opt/applneedsrtcdriver.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Real-Time Clock Driver - is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER -appl-config-option-notes: | - Most BSPs do not include support for a real-time clock (RTC). This is because - many boards do not include the required hardware. - - If this is defined and the BSP does not have this device driver, then the - user will get a link time error for an undefined symbol. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the Real-Time Clock Driver + is initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER +notes: | + Most BSPs do not include support for a real-time clock (RTC). This is because + many boards do not include the required hardware. + + If this is defined and the BSP does not have this device driver, then the + user will get a link time error for an undefined symbol. text: '' type: interface diff --git a/spec/acfg/opt/applneedssimpleconsoledriver.yml b/spec/acfg/opt/applneedssimpleconsoledriver.yml index 273e7a2e..e736b10c 100644 --- a/spec/acfg/opt/applneedssimpleconsoledriver.yml +++ b/spec/acfg/opt/applneedssimpleconsoledriver.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the Simple Console Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER +notes: | This device driver is responsible for providing the :file:`/dev/console` device file. This device is used to initialize the standard input, output, and error file descriptors. @@ -25,13 +33,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applneedssimpletaskconsoledriver.yml b/spec/acfg/opt/applneedssimpletaskconsoledriver.yml index 08898fc2..1da5c771 100644 --- a/spec/acfg/opt/applneedssimpletaskconsoledriver.yml +++ b/spec/acfg/opt/applneedssimpletaskconsoledriver.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the Simple Task Console Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER +notes: | This device driver is responsible for providing the :file:`/dev/console` device file. This device is used to initialize the standard input, output, and error file descriptors. @@ -34,13 +42,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applneedsstubdriver.yml b/spec/acfg/opt/applneedsstubdriver.yml index 53cd8ba6..92cad5a8 100644 --- a/spec/acfg/opt/applneedsstubdriver.yml +++ b/spec/acfg/opt/applneedsstubdriver.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Stub Driver is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER -appl-config-option-notes: | - This device driver simply provides entry points that return successful and - is primarily a test fixture. It is supported by all BSPs. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the Stub Driver is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER +notes: | + This device driver simply provides entry points that return successful and + is primarily a test fixture. It is supported by all BSPs. text: '' type: interface diff --git a/spec/acfg/opt/applneedstimerdriver.yml b/spec/acfg/opt/applneedstimerdriver.yml index b0ca008c..779eddae 100644 --- a/spec/acfg/opt/applneedstimerdriver.yml +++ b/spec/acfg/opt/applneedstimerdriver.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the Benchmark Timer Driver is initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER +notes: | The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS Testsuite. Applications should not use this driver. @@ -17,13 +25,5 @@ appl-config-option-notes: | * `CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, otherwise a compile time error will occur. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/applneedswatchdogdriver.yml b/spec/acfg/opt/applneedswatchdogdriver.yml index cca9433b..450dfe67 100644 --- a/spec/acfg/opt/applneedswatchdogdriver.yml +++ b/spec/acfg/opt/applneedswatchdogdriver.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Watchdog Driver is - initialized during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER -appl-config-option-notes: | - Most BSPs do not include support for a watchdog device driver. This is - because many boards do not include the required hardware. - - If this is defined and the BSP does not have this device driver, then the - user will get a link time error for an undefined symbol. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the Watchdog Driver is + initialized during system initialization. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER +notes: | + Most BSPs do not include support for a watchdog device driver. This is + because many boards do not include the required hardware. + + If this is defined and the BSP does not have this device driver, then the + user will get a link time error for an undefined symbol. text: '' type: interface diff --git a/spec/acfg/opt/applneedszerodriver.yml b/spec/acfg/opt/applneedszerodriver.yml index 408ca23f..a9c1ba5c 100644 --- a/spec/acfg/opt/applneedszerodriver.yml +++ b/spec/acfg/opt/applneedszerodriver.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the :file:`/dev/zero` - Driver is initialized during system initialization. -appl-config-option-index: -- /dev/zero -appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER -appl-config-option-notes: | - This device driver is supported by all BSPs. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the :file:`/dev/zero` + Driver is initialized during system initialization. enabled-by: true +index-entries: +- /dev/zero interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER +notes: | + This device driver is supported by all BSPs. text: '' type: interface diff --git a/spec/acfg/opt/applprerequisitedrivers.yml b/spec/acfg/opt/applprerequisitedrivers.yml index 062958e5..4d54d2cf 100644 --- a/spec/acfg/opt/applprerequisitedrivers.yml +++ b/spec/acfg/opt/applprerequisitedrivers.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of initializers for structures of type :c:type:`rtems_driver_address_table`. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is the empty list. -appl-config-option-description: | +description: | The value of this configuration option is used to initialize the Device Driver Table. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../devdrv +name: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS +notes: | The value of this configuration option is placed after the entries defined by :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` and before all other device driver configuration options. See :ref:`CONFIGURE_APPLICATION_EXTRA_DRIVERS` for an alternative placement of application device driver initializers. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../devdrv text: '' type: interface diff --git a/spec/acfg/opt/atadrivertaskpriority.yml b/spec/acfg/opt/atadrivertaskpriority.yml index b36e5ae3..914c8b65 100644 --- a/spec/acfg/opt/atadrivertaskpriority.yml +++ b/spec/acfg/opt/atadrivertaskpriority.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintprioclassic -appl-config-option-default-value: 140 -appl-config-option-description: | - The value of this configuration option defines the ATA task priority. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_ATA_DRIVER_TASK_PRIORITY -appl-config-option-notes: | - This configuration option is only evaluated if the configuration option - :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined. -appl-config-option-type: integer copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: 140 +description: | + The value of this configuration option defines the ATA task priority. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_ATA_DRIVER_TASK_PRIORITY +notes: | + This configuration option is only evaluated if the configuration option + :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined. text: '' type: interface diff --git a/spec/acfg/opt/bdbufbuffermaxsize.yml b/spec/acfg/opt/bdbufbuffermaxsize.yml index 43555349..802c7de5 100644 --- a/spec/acfg/opt/bdbufbuffermaxsize.yml +++ b/spec/acfg/opt/bdbufbuffermaxsize.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - It shall be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`. min: 0 -appl-config-option-default-value: 4096 -appl-config-option-description: | - The value of this configuration option defines the maximum size of a buffer - in bytes. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_BUFFER_MAX_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 4096 +description: | + The value of this configuration option defines the maximum size of a buffer + in bytes. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_BUFFER_MAX_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bdbufbufferminsize.yml b/spec/acfg/opt/bdbufbufferminsize.yml index 3d597ae5..549416e3 100644 --- a/spec/acfg/opt/bdbufbufferminsize.yml +++ b/spec/acfg/opt/bdbufbufferminsize.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 512 -appl-config-option-description: | - The value of this configuration option defines the minimum size of a buffer - in bytes. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_BUFFER_MIN_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 512 +description: | + The value of this configuration option defines the minimum size of a buffer + in bytes. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_BUFFER_MIN_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bdbufcachememorysize.yml b/spec/acfg/opt/bdbufcachememorysize.yml index f6377400..016866c6 100644 --- a/spec/acfg/opt/bdbufcachememorysize.yml +++ b/spec/acfg/opt/bdbufcachememorysize.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``SIZE_MAX``' min: 0 -appl-config-option-default-value: 32768 -appl-config-option-description: | - The value of this configuration option defines the size of the cache memory - in bytes. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 32768 +description: | + The value of this configuration option defines the size of the cache memory + in bytes. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bdbufmaxreadaheadblocks.yml b/spec/acfg/opt/bdbufmaxreadaheadblocks.yml index 39da1ce4..bda81ac0 100644 --- a/spec/acfg/opt/bdbufmaxreadaheadblocks.yml +++ b/spec/acfg/opt/bdbufmaxreadaheadblocks.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum blocks per - read-ahead request. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS -appl-config-option-notes: | - A value of 0 disables the read-ahead task (default). The read-ahead task - will issue speculative read transfers if a sequential access pattern is - detected. This can improve the performance on some systems. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum blocks per + read-ahead request. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS +notes: | + A value of 0 disables the read-ahead task (default). The read-ahead task + will issue speculative read transfers if a sequential access pattern is + detected. This can improve the performance on some systems. text: '' type: interface diff --git a/spec/acfg/opt/bdbufmaxwriteblocks.yml b/spec/acfg/opt/bdbufmaxwriteblocks.yml index d1b021a7..71373012 100644 --- a/spec/acfg/opt/bdbufmaxwriteblocks.yml +++ b/spec/acfg/opt/bdbufmaxwriteblocks.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 16 -appl-config-option-description: | - The value of this configuration option defines the maximum blocks per write - request. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 16 +description: | + The value of this configuration option defines the maximum blocks per write + request. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_MAX_WRITE_BLOCKS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bdbufreadaheadtaskpriority.yml b/spec/acfg/opt/bdbufreadaheadtaskpriority.yml index 6a31cf73..ce871387 100644 --- a/spec/acfg/opt/bdbufreadaheadtaskpriority.yml +++ b/spec/acfg/opt/bdbufreadaheadtaskpriority.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintprioclassic -appl-config-option-default-value: 15 -appl-config-option-description: | - The value of this configuration option defines the read-ahead task priority. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 15 +description: | + The value of this configuration option defines the read-ahead task priority. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bdbuftaskstacksize.yml b/spec/acfg/opt/bdbuftaskstacksize.yml index 89fe49d5..60bc187e 100644 --- a/spec/acfg/opt/bdbuftaskstacksize.yml +++ b/spec/acfg/opt/bdbuftaskstacksize.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintstackspace - /acfg/opt/constraintmemsz min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` -appl-config-option-default-value: '``RTEMS_MINIMUM_STACK_SIZE``' -appl-config-option-description: | - The value of this configuration option defines the task stack size of the - Block Device Cache tasks in bytes. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_TASK_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``RTEMS_MINIMUM_STACK_SIZE``' +description: | + The value of this configuration option defines the task stack size of the + Block Device Cache tasks in bytes. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_BDBUF_TASK_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bspidletaskbody.yml b/spec/acfg/opt/bspidletaskbody.yml index d5cd0459..83f9244a 100644 --- a/spec/acfg/opt/bspidletaskbody.yml +++ b/spec/acfg/opt/bspidletaskbody.yml @@ -1,12 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void *( *idle_body )( uintptr_t )``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is BSP-specific. -appl-config-option-description: | +description: | If * this configuration option is defined by the BSP @@ -15,19 +18,16 @@ appl-config-option-description: | then the value of this configuration option defines the default value of :ref:`CONFIGURE_IDLE_TASK_BODY`. -appl-config-option-index: [] -appl-config-option-name: BSP_IDLE_TASK_BODY -appl-config-option-notes: | - As it has knowledge of the specific CPU model, system controller logic, and - peripheral buses, a BSP-specific IDLE task may be capable of turning - components off to save power during extended periods of no task activity. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: BSP_IDLE_TASK_BODY +notes: | + As it has knowledge of the specific CPU model, system controller logic, and + peripheral buses, a BSP-specific IDLE task may be capable of turning + components off to save power during extended periods of no task activity. text: '' type: interface diff --git a/spec/acfg/opt/bspidletaskstacksize.yml b/spec/acfg/opt/bspidletaskstacksize.yml index 29abfb28..e01bc2e2 100644 --- a/spec/acfg/opt/bspidletaskstacksize.yml +++ b/spec/acfg/opt/bspidletaskstacksize.yml @@ -1,11 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintidlestackarea - /acfg/opt/constraintbspappmin -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is BSP-specific. -appl-config-option-description: | +description: | If * this configuration option is defined by the BSP @@ -14,16 +17,13 @@ appl-config-option-description: | then the value of this configuration option defines the default value of :ref:`CONFIGURE_IDLE_TASK_SIZE`. -appl-config-option-index: [] -appl-config-option-name: BSP_IDLE_TASK_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: BSP_IDLE_TASK_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bspinitialextension.yml b/spec/acfg/opt/bspinitialextension.yml index 1f2d3922..31404f53 100644 --- a/spec/acfg/opt/bspinitialextension.yml +++ b/spec/acfg/opt/bspinitialextension.yml @@ -1,12 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of initializers for structures of type :c:type:`rtems_extensions_table`. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is BSP-specific. -appl-config-option-description: | +description: | If * this configuration option is defined by the BSP @@ -15,18 +18,15 @@ appl-config-option-description: | then the value of this configuration option is used to initialize the table of initial user extensions. -appl-config-option-index: [] -appl-config-option-name: BSP_INITIAL_EXTENSION -appl-config-option-notes: | - The value of this configuration option is placed after the entries of all - other initial user extensions. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: BSP_INITIAL_EXTENSION +notes: | + The value of this configuration option is placed after the entries of all + other initial user extensions. text: '' type: interface diff --git a/spec/acfg/opt/bspinterruptstacksize.yml b/spec/acfg/opt/bspinterruptstacksize.yml index fd6ad7bd..4b3dacbb 100644 --- a/spec/acfg/opt/bspinterruptstacksize.yml +++ b/spec/acfg/opt/bspinterruptstacksize.yml @@ -1,12 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintisrstackalign - /acfg/opt/constraintisrstackarea - /acfg/opt/constraintbspappmin -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is BSP-specific. -appl-config-option-description: | +description: | If * this configuration option is defined by the BSP @@ -15,16 +18,13 @@ appl-config-option-description: | then the value of this configuration option defines the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`. -appl-config-option-index: [] -appl-config-option-name: BSP_INTERRUPT_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: BSP_INTERRUPT_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/bspprerequisitedrivers.yml b/spec/acfg/opt/bspprerequisitedrivers.yml index 0c2d36d5..5520ddfa 100644 --- a/spec/acfg/opt/bspprerequisitedrivers.yml +++ b/spec/acfg/opt/bspprerequisitedrivers.yml @@ -1,12 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of initializers for structures of type :c:type:`rtems_extensions_table`. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is BSP-specific. -appl-config-option-description: | +description: | If * this configuration option is defined by the BSP @@ -15,19 +18,16 @@ appl-config-option-description: | then the value of this configuration option is used to initialize the table of initial user extensions. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BSP_PREREQUISITE_DRIVERS -appl-config-option-notes: | - The value of this configuration option is placed before the entries of all - other initial user extensions (including - :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`). -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: CONFIGURE_BSP_PREREQUISITE_DRIVERS +notes: | + The value of this configuration option is placed before the entries of all + other initial user extensions (including + :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`). text: '' type: interface diff --git a/spec/acfg/opt/cbsmaximumservers.yml b/spec/acfg/opt/cbsmaximumservers.yml index e9df9755..f0bdb221 100644 --- a/spec/acfg/opt/cbsmaximumservers.yml +++ b/spec/acfg/opt/cbsmaximumservers.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintmemsz max: '``SIZE_MAX``' min: 0 -appl-config-option-default-value: :ref:`CONFIGURE_MAXIMUM_TASKS` -appl-config-option-description: | - The value of this configuration option defines the maximum number Constant - Bandwidth Servers that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_CBS_MAXIMUM_SERVERS -appl-config-option-notes: | - This configuration option is only evaluated if the configuration option - :ref:`CONFIGURE_SCHEDULER_CBS` is defined. -appl-config-option-type: integer copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: :ref:`CONFIGURE_MAXIMUM_TASKS` +description: | + The value of this configuration option defines the maximum number Constant + Bandwidth Servers that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../schedgeneral +name: CONFIGURE_CBS_MAXIMUM_SERVERS +notes: | + This configuration option is only evaluated if the configuration option + :ref:`CONFIGURE_SCHEDULER_CBS` is defined. text: '' type: interface diff --git a/spec/acfg/opt/dirtymemory.yml b/spec/acfg/opt/dirtymemory.yml index 4ff1bb36..b2d5892e 100644 --- a/spec/acfg/opt/dirtymemory.yml +++ b/spec/acfg/opt/dirtymemory.yml @@ -1,11 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the memory areas used for the RTEMS Workspace and the C Program Heap are dirtied with a ``0xCF`` byte pattern during system initialization. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_DIRTY_MEMORY -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_DIRTY_MEMORY +notes: | Dirtying memory can add significantly to system initialization time. It may assist in finding code that incorrectly assumes the contents of free memory areas is cleared to zero during system initialization. In case @@ -13,13 +21,5 @@ appl-config-option-notes: | memory is first dirtied and then zeroed. See also :ref:`CONFIGURE_MALLOC_DIRTY`. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/disablebspsettings.yml b/spec/acfg/opt/disablebspsettings.yml index 08ece34d..e2e5a9af 100644 --- a/spec/acfg/opt/disablebspsettings.yml +++ b/spec/acfg/opt/disablebspsettings.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the following BSP related configuration options are undefined: @@ -14,16 +17,13 @@ appl-config-option-description: | - :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` - :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK` -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_DISABLE_BSP_SETTINGS -appl-config-option-notes: null -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: CONFIGURE_DISABLE_BSP_SETTINGS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/disablenewlibreentrancy.yml b/spec/acfg/opt/disablenewlibreentrancy.yml index 65cc705f..3a7556d5 100644 --- a/spec/acfg/opt/disablenewlibreentrancy.yml +++ b/spec/acfg/opt/disablenewlibreentrancy.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Newlib reentrancy - support per thread is disabled and a global reentrancy structure is used. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_DISABLE_NEWLIB_REENTRANCY -appl-config-option-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 - behaviour. For example, :c:data:`errno` is no longer a thread-local variable - if this option is enabled. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the Newlib reentrancy + support per thread is disabled and a global reentrancy structure is used. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_DISABLE_NEWLIB_REENTRANCY +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 + behaviour. For example, :c:data:`errno` is no longer a thread-local variable + if this option is enabled. text: '' type: interface diff --git a/spec/acfg/opt/executiveramsize.yml b/spec/acfg/opt/executiveramsize.yml index 690467ed..bca82437 100644 --- a/spec/acfg/opt/executiveramsize.yml +++ b/spec/acfg/opt/executiveramsize.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintmemsz max: '``UINTPTR_MAX``' min: 0 -appl-config-option-default-value: | +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: | If this configuration option is undefined, then the RTEMS Workspace and task stack space size is calculated by ``<rtems/confdefs.h>`` based on the values configuration options. -appl-config-option-description: | +description: | The value of this configuration option defines the RTEMS Workspace size in bytes. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_EXECUTIVE_RAM_SIZE -appl-config-option-notes: | - This is an advanced configuration option. Use it only if you know exactly - what you are doing. -appl-config-option-type: integer -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_EXECUTIVE_RAM_SIZE +notes: | + This is an advanced configuration option. Use it only if you know exactly + what you are doing. text: '' type: interface diff --git a/spec/acfg/opt/extrataskstacks.yml b/spec/acfg/opt/extrataskstacks.yml index 3612825b..74881eea 100644 --- a/spec/acfg/opt/extrataskstacks.yml +++ b/spec/acfg/opt/extrataskstacks.yml @@ -1,27 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintstackspace min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the number of bytes the applications wishes to add to the task stack requirements calculated by ``<rtems/confdefs.h>``. -appl-config-option-index: -- memory for task tasks -appl-config-option-name: CONFIGURE_EXTRA_TASK_STACKS -appl-config-option-notes: | - This parameter is very important. If the application creates tasks with - stacks larger then the minimum, then that memory is **not** accounted for by - ``<rtems/confdefs.h>``. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: +- memory for task tasks interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_EXTRA_TASK_STACKS +notes: | + This parameter is very important. If the application creates tasks with + stacks larger then the minimum, then that memory is **not** accounted for by + ``<rtems/confdefs.h>``. text: '' type: interface diff --git a/spec/acfg/opt/filesystemall.yml b/spec/acfg/opt/filesystemall.yml index b9b82c2f..d4c00ff7 100644 --- a/spec/acfg/opt/filesystemall.yml +++ b/spec/acfg/opt/filesystemall.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | In case this configuration option is defined, then the following configuration options will be defined as well @@ -16,16 +19,13 @@ appl-config-option-description: | - :ref:`CONFIGURE_FILESYSTEM_RFS`, and - :ref:`CONFIGURE_FILESYSTEM_TFTPFS`. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_ALL -appl-config-option-notes: null -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_ALL +notes: null text: '' type: interface diff --git a/spec/acfg/opt/filesystemdosfs.yml b/spec/acfg/opt/filesystemdosfs.yml index 31bafbc1..e29b28e7 100644 --- a/spec/acfg/opt/filesystemdosfs.yml +++ b/spec/acfg/opt/filesystemdosfs.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the DOS (FAT) filesystem - is registered, so that instances of this filesystem can be mounted by the - application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_DOSFS -appl-config-option-notes: | - This filesystem requires a Block Device Cache configuration, see - :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the DOS (FAT) filesystem + is registered, so that instances of this filesystem can be mounted by the + application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_DOSFS +notes: | + This filesystem requires a Block Device Cache configuration, see + :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. text: '' type: interface diff --git a/spec/acfg/opt/filesystemftpfs.yml b/spec/acfg/opt/filesystemftpfs.yml index f4f561f4..6eb47eac 100644 --- a/spec/acfg/opt/filesystemftpfs.yml +++ b/spec/acfg/opt/filesystemftpfs.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the FTP filesystem (FTP - client) is registered, so that instances of this filesystem - can be mounted by the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_FTPFS -appl-config-option-notes: null appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the FTP filesystem (FTP + client) is registered, so that instances of this filesystem + can be mounted by the application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_FTPFS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/filesystemimfs.yml b/spec/acfg/opt/filesystemimfs.yml index a9c2f456..ada2ec3d 100644 --- a/spec/acfg/opt/filesystemimfs.yml +++ b/spec/acfg/opt/filesystemimfs.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the In-Memory Filesystem - (IMFS) is registered, so that instances of this filesystem can be mounted by - the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_IMFS -appl-config-option-notes: | - Applications will rarely need this configuration option. This configuration - option is intended for test programs. You do not need to define this - configuration option for the base filesystem (also known as root filesystem). appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the In-Memory Filesystem + (IMFS) is registered, so that instances of this filesystem can be mounted by + the application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_IMFS +notes: | + Applications will rarely need this configuration option. This configuration + option is intended for test programs. You do not need to define this + configuration option for the base filesystem (also known as root filesystem). text: '' type: interface diff --git a/spec/acfg/opt/filesystemjffs2.yml b/spec/acfg/opt/filesystemjffs2.yml index efe5e2d8..be4c7617 100644 --- a/spec/acfg/opt/filesystemjffs2.yml +++ b/spec/acfg/opt/filesystemjffs2.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the JFFS2 filesystem - is registered, so that instances of this filesystem can be mounted by the - application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_JFFS2 -appl-config-option-notes: null appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the JFFS2 filesystem + is registered, so that instances of this filesystem can be mounted by the + application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_JFFS2 +notes: null text: '' type: interface diff --git a/spec/acfg/opt/filesystemnfs.yml b/spec/acfg/opt/filesystemnfs.yml index 0b7bb683..58bde27d 100644 --- a/spec/acfg/opt/filesystemnfs.yml +++ b/spec/acfg/opt/filesystemnfs.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the Network Filesystem - (NFS) client is registered, so that instances of this filesystem can be - mounted by the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_NFS -appl-config-option-notes: null appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the Network Filesystem + (NFS) client is registered, so that instances of this filesystem can be + mounted by the application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_NFS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/filesystemrfs.yml b/spec/acfg/opt/filesystemrfs.yml index 6d021dbd..cd50dae7 100644 --- a/spec/acfg/opt/filesystemrfs.yml +++ b/spec/acfg/opt/filesystemrfs.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the RTEMS Filesystem (RFS) - is registered, so that instances of this filesystem can be mounted by the - application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_RFS -appl-config-option-notes: | - This filesystem requires a Block Device Cache configuration, see - :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the RTEMS Filesystem (RFS) + is registered, so that instances of this filesystem can be mounted by the + application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_RFS +notes: | + This filesystem requires a Block Device Cache configuration, see + :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. text: '' type: interface diff --git a/spec/acfg/opt/filesystemtftpfs.yml b/spec/acfg/opt/filesystemtftpfs.yml index 165eb560..4ecc2a69 100644 --- a/spec/acfg/opt/filesystemtftpfs.yml +++ b/spec/acfg/opt/filesystemtftpfs.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the TFTP filesystem (TFTP - client) is registered, so that instances of this filesystem can be mounted by - the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_FILESYSTEM_TFTPFS -appl-config-option-notes: null appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the TFTP filesystem (TFTP + client) is registered, so that instances of this filesystem can be mounted by + the application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_FILESYSTEM_TFTPFS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/idletaskbody.yml b/spec/acfg/opt/idletaskbody.yml index fd9cd145..bcd87ea4 100644 --- a/spec/acfg/opt/idletaskbody.yml +++ b/spec/acfg/opt/idletaskbody.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void *( *idle_body )( uintptr_t )``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value, otherwise the default value is ``_CPU_Thread_Idle_body``. -appl-config-option-description: | +description: | The value of this configuration option initializes the IDLE thread body. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IDLE_TASK_BODY -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../idle +name: CONFIGURE_IDLE_TASK_BODY +notes: | IDLE threads shall not block. A blocking IDLE thread results in undefined system behaviour because the scheduler assume that at least one ready thread exists. IDLE threads can be used to initialize the application, see configuration option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../idle text: '' type: interface diff --git a/spec/acfg/opt/idletaskinitappl.yml b/spec/acfg/opt/idletaskinitappl.yml index 365d0e74..9692954d 100644 --- a/spec/acfg/opt/idletaskinitappl.yml +++ b/spec/acfg/opt/idletaskinitappl.yml @@ -1,15 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the user is assumed to provide one or more initialization tasks. -appl-config-option-description: | +description: | This configuration option is defined to indicate that the user has configured **no** user initialization tasks or threads and that the user provided IDLE task will perform application initialization and then transform itself into an IDLE task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../idle +name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION +notes: | If you use this option be careful, the user IDLE task **cannot** block at all during the initialization sequence. Further, once application initialization is complete, it shall make itself preemptible and enter an idle @@ -31,13 +39,5 @@ appl-config-option-notes: | * `CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` otherwise a compile time error in the configuration file will occur. -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../idle text: '' type: interface diff --git a/spec/acfg/opt/idletaskstacksize.yml b/spec/acfg/opt/idletaskstacksize.yml index 74d7e612..6539a78f 100644 --- a/spec/acfg/opt/idletaskstacksize.yml +++ b/spec/acfg/opt/idletaskstacksize.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintidlestackarea - /acfg/opt/constraintbspappmin -appl-config-option-default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` -appl-config-option-description: | - The value of this configuration option defines the task stack size for an - IDLE task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IDLE_TASK_STACK_SIZE -appl-config-option-notes: | - In SMP configurations, there is one IDLE task per configured processor, see - :ref:`CONFIGURE_MAXIMUM_PROCESSORS`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` +description: | + The value of this configuration option defines the task stack size for an + IDLE task. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../idle +name: CONFIGURE_IDLE_TASK_STACK_SIZE +notes: | + In SMP configurations, there is one IDLE task per configured processor, see + :ref:`CONFIGURE_MAXIMUM_PROCESSORS`. text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablechmod.yml b/spec/acfg/opt/imfsdisablechmod.yml index eb59f948..c687f090 100644 --- a/spec/acfg/opt/imfsdisablechmod.yml +++ b/spec/acfg/opt/imfsdisablechmod.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports changing the mode of files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support changing the mode of files (no support for :c:func:`chmod`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_CHMOD -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_CHMOD +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablechown.yml b/spec/acfg/opt/imfsdisablechown.yml index 969f149c..2c0c2fdd 100644 --- a/spec/acfg/opt/imfsdisablechown.yml +++ b/spec/acfg/opt/imfsdisablechown.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports changing the ownership of files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support changing the ownership of files (no support for :c:func:`chown`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_CHOWN -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_CHOWN +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablelink.yml b/spec/acfg/opt/imfsdisablelink.yml index 1392af9a..39c608a8 100644 --- a/spec/acfg/opt/imfsdisablelink.yml +++ b/spec/acfg/opt/imfsdisablelink.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports hard links. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support hard links (no support for :c:func:`link`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_LINK -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_LINK +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablemknod.yml b/spec/acfg/opt/imfsdisablemknod.yml index 65101409..a26f8c40 100644 --- a/spec/acfg/opt/imfsdisablemknod.yml +++ b/spec/acfg/opt/imfsdisablemknod.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports making files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support making files (no support for :c:func:`mknod`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_MKNOD +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablemknoddevice.yml b/spec/acfg/opt/imfsdisablemknoddevice.yml index 3b4d9490..f4d94cdc 100644 --- a/spec/acfg/opt/imfsdisablemknoddevice.yml +++ b/spec/acfg/opt/imfsdisablemknoddevice.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default: | If this configuration option is undefined, then the root IMFS supports making device files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support making device files. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablemknodfile.yml b/spec/acfg/opt/imfsdisablemknodfile.yml index 3121d990..b9050346 100644 --- a/spec/acfg/opt/imfsdisablemknodfile.yml +++ b/spec/acfg/opt/imfsdisablemknodfile.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports making regular files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support making regular files. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD_FILE -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_MKNOD_FILE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablemount.yml b/spec/acfg/opt/imfsdisablemount.yml index 3907cb2e..4ad81949 100644 --- a/spec/acfg/opt/imfsdisablemount.yml +++ b/spec/acfg/opt/imfsdisablemount.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports mounting other filesystems. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support mounting other filesystems (no support for :c:func:`mount`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_MOUNT -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_MOUNT +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablereaddir.yml b/spec/acfg/opt/imfsdisablereaddir.yml index 38e1c2ba..49d0f916 100644 --- a/spec/acfg/opt/imfsdisablereaddir.yml +++ b/spec/acfg/opt/imfsdisablereaddir.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports reading directories. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support reading directories (no support for :c:func:`readdir`). It is still possible to open files in a directory. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_READDIR -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_READDIR +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablereadlink.yml b/spec/acfg/opt/imfsdisablereadlink.yml index 28f98855..7aa0e3b8 100644 --- a/spec/acfg/opt/imfsdisablereadlink.yml +++ b/spec/acfg/opt/imfsdisablereadlink.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports reading symbolic links. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support reading symbolic links (no support for :c:func:`readlink`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_READLINK -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_READLINK +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablerename.yml b/spec/acfg/opt/imfsdisablerename.yml index 380a8126..b4683748 100644 --- a/spec/acfg/opt/imfsdisablerename.yml +++ b/spec/acfg/opt/imfsdisablerename.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports renaming files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support renaming files (no support for :c:func:`rename`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_RENAME -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_RENAME +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablermnod.yml b/spec/acfg/opt/imfsdisablermnod.yml index db7db171..a2ac2361 100644 --- a/spec/acfg/opt/imfsdisablermnod.yml +++ b/spec/acfg/opt/imfsdisablermnod.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports removing files. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support removing files (no support for :c:func:`rmnod`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_RMNOD -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_RMNOD +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisablesymlink.yml b/spec/acfg/opt/imfsdisablesymlink.yml index 14f85450..e396665f 100644 --- a/spec/acfg/opt/imfsdisablesymlink.yml +++ b/spec/acfg/opt/imfsdisablesymlink.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports creating symbolic links. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support creating symbolic links (no support for :c:func:`symlink`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_SYMLINK -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_SYMLINK +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisableunmount.yml b/spec/acfg/opt/imfsdisableunmount.yml index efa3ac79..44ff7c82 100644 --- a/spec/acfg/opt/imfsdisableunmount.yml +++ b/spec/acfg/opt/imfsdisableunmount.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports unmounting other filesystems. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support unmounting other filesystems (no support for :c:func:`unmount`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_UNMOUNT -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_UNMOUNT +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsdisableutime.yml b/spec/acfg/opt/imfsdisableutime.yml index 3510365f..5919c7c3 100644 --- a/spec/acfg/opt/imfsdisableutime.yml +++ b/spec/acfg/opt/imfsdisableutime.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS supports changing file times. -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS does not support changing file times (no support for :c:func:`utime`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_DISABLE_UTIME -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_DISABLE_UTIME +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsenablemkfifo.yml b/spec/acfg/opt/imfsenablemkfifo.yml index e5c4a204..a5447786 100644 --- a/spec/acfg/opt/imfsenablemkfifo.yml +++ b/spec/acfg/opt/imfsenablemkfifo.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the root IMFS does not support making FIFOs (no support for :c:func:`mkfifo`). -appl-config-option-description: | +description: | In case this configuration option is defined, then the root IMFS supports making FIFOs. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_ENABLE_MKFIFO -appl-config-option-notes: null -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../filesystem +name: CONFIGURE_IMFS_ENABLE_MKFIFO +notes: null text: '' type: interface diff --git a/spec/acfg/opt/imfsmemfilebytesperblock.yml b/spec/acfg/opt/imfsmemfilebytesperblock.yml index e425f82a..f43abf35 100644 --- a/spec/acfg/opt/imfsmemfilebytesperblock.yml +++ b/spec/acfg/opt/imfsmemfilebytesperblock.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: set: - 16 - 32 @@ -7,13 +8,20 @@ appl-config-option-constraint: - 128 - 256 - 512 -appl-config-option-default-value: 128 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 128 +description: | The value of this configuration option defines the block size for in-memory files managed by the IMFS. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../filesystem +name: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK +notes: | The configured block size has two impacts. The first is the average amount of unused memory in the last block of each file. For example, when the block size is 512, on average one-half of the last block of each file will remain @@ -39,13 +47,5 @@ appl-config-option-notes: | - when the block size is 512 bytes, the maximum file size is 1,082,195,456 bytes. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../filesystem text: '' type: interface diff --git a/spec/acfg/opt/initialextensions.yml b/spec/acfg/opt/initialextensions.yml index 5c777d6f..19adfce5 100644 --- a/spec/acfg/opt/initialextensions.yml +++ b/spec/acfg/opt/initialextensions.yml @@ -1,27 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of initializers for structures of type :c:type:`rtems_extensions_table`. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is the empty list. -appl-config-option-description: | +description: | The value of this configuration option is used to initialize the table of initial user extensions. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INITIAL_EXTENSIONS -appl-config-option-notes: | - The value of this configuration option is placed before the entries of - :ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial - user extensions. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_INITIAL_EXTENSIONS +notes: | + The value of this configuration option is placed before the entries of + :ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial + user extensions. text: '' type: interface diff --git a/spec/acfg/opt/inittaskarguments.yml b/spec/acfg/opt/inittaskarguments.yml index a8aa2ab5..12a14c86 100644 --- a/spec/acfg/opt/inittaskarguments.yml +++ b/spec/acfg/opt/inittaskarguments.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be a valid integer of type ``rtems_task_argument``. -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines task argument of the Classic - API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_ARGUMENTS -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines task argument of the Classic + API initialization task. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_ARGUMENTS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/inittaskattributes.yml b/spec/acfg/opt/inittaskattributes.yml index a15a7a73..95818ba5 100644 --- a/spec/acfg/opt/inittaskattributes.yml +++ b/spec/acfg/opt/inittaskattributes.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be a valid task attribute set. -appl-config-option-default-value: '``RTEMS_DEFAULT_ATTRIBUTES``' -appl-config-option-description: | - The value of this configuration option defines the task attributes of the - Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_ATTRIBUTES -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``RTEMS_DEFAULT_ATTRIBUTES``' +description: | + The value of this configuration option defines the task attributes of the + Classic API initialization task. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_ATTRIBUTES +notes: null text: '' type: interface diff --git a/spec/acfg/opt/inittaskentrypoint.yml b/spec/acfg/opt/inittaskentrypoint.yml index 2d59a5cb..edc8e8d5 100644 --- a/spec/acfg/opt/inittaskentrypoint.yml +++ b/spec/acfg/opt/inittaskentrypoint.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void ( *entry_point )( rtems_task_argument )``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is ``Init``. -appl-config-option-description: | +description: | The value of this configuration option initializes the entry point of the Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_ENTRY_POINT -appl-config-option-notes: | - The application shall provide the function referenced by this configuration - option. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_ENTRY_POINT +notes: | + The application shall provide the function referenced by this configuration + option. text: '' type: interface diff --git a/spec/acfg/opt/inittaskinitialmodes.yml b/spec/acfg/opt/inittaskinitialmodes.yml index b8aadc26..b2ea3dd9 100644 --- a/spec/acfg/opt/inittaskinitialmodes.yml +++ b/spec/acfg/opt/inittaskinitialmodes.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be a valid task mode set. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | In SMP configurations, the default value is ``RTEMS_DEFAULT_MODES``, otherwise the default value is ``RTEMS_NO_PREEMPT``. -appl-config-option-description: | +description: | The value of this configuration option defines the initial execution mode of the Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_INITIAL_MODES -appl-config-option-notes: null -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_INITIAL_MODES +notes: null text: '' type: interface diff --git a/spec/acfg/opt/inittaskname.yml b/spec/acfg/opt/inittaskname.yml index f9c4c0c6..8a35ba17 100644 --- a/spec/acfg/opt/inittaskname.yml +++ b/spec/acfg/opt/inittaskname.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be a valid integer of type ``rtems_name``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. -appl-config-option-description: | +description: | The value of this configuration option defines the name of the Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_NAME -appl-config-option-notes: | - Use :c:func:`rtems_build_name` to define the task name. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_NAME +notes: | + Use :c:func:`rtems_build_name` to define the task name. text: '' type: interface diff --git a/spec/acfg/opt/inittaskpriority.yml b/spec/acfg/opt/inittaskpriority.yml index 53a64b57..be70feb6 100644 --- a/spec/acfg/opt/inittaskpriority.yml +++ b/spec/acfg/opt/inittaskpriority.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintprioclassic -appl-config-option-default-value: 1 -appl-config-option-description: | - The value of this configuration option defines the initial priority of the - Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_PRIORITY -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 1 +description: | + The value of this configuration option defines the initial priority of the + Classic API initialization task. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_PRIORITY +notes: null text: '' type: interface diff --git a/spec/acfg/opt/inittaskstacksize.yml b/spec/acfg/opt/inittaskstacksize.yml index 42c276ab..19c4d7cb 100644 --- a/spec/acfg/opt/inittaskstacksize.yml +++ b/spec/acfg/opt/inittaskstacksize.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintstackspace min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` -appl-config-option-default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` -appl-config-option-description: | - The value of this configuration option defines the task stack size of the - Classic API initialization task. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_INIT_TASK_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` +description: | + The value of this configuration option defines the task stack size of the + Classic API initialization task. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classicinit +name: CONFIGURE_INIT_TASK_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/interruptstacksize.yml b/spec/acfg/opt/interruptstacksize.yml index ff28df37..1d51352e 100644 --- a/spec/acfg/opt/interruptstacksize.yml +++ b/spec/acfg/opt/interruptstacksize.yml @@ -1,19 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintisrstackalign - /acfg/opt/constraintisrstackarea - /acfg/opt/constraintbspappmin -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined, otherwise the default value is ``CPU_STACK_MINIMUM_SIZE``. -appl-config-option-description: | +description: | The value of this configuration option defines the size of an interrupt stack in bytes. -appl-config-option-index: +enabled-by: true +index-entries: - interrupt stack size -appl-config-option-name: CONFIGURE_INTERRUPT_STACK_SIZE -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_INTERRUPT_STACK_SIZE +notes: | There is one interrupt stack available for each configured processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). The interrupt stack areas are statically allocated in a special linker section (``.rtemsstack.interrupt``). @@ -29,13 +37,5 @@ appl-config-option-notes: | In releases before RTEMS 5.1 the default value was :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of ``CPU_STACK_MINIMUM_SIZE``. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/mallocbspsupportssbrk.yml b/spec/acfg/opt/mallocbspsupportssbrk.yml index 0c12d552..240a0a3d 100644 --- a/spec/acfg/opt/mallocbspsupportssbrk.yml +++ b/spec/acfg/opt/mallocbspsupportssbrk.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | If * this configuration option is defined by the BSP @@ -10,18 +13,15 @@ appl-config-option-description: | system initialization time. When :c:func:`malloc()` or other standard memory allocation functions are unable to allocate memory, they will call the BSP supplied :c:func:`sbrk()` function to obtain more memory. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK -appl-config-option-notes: | - This option should not be defined by the application. Only the BSP knows how - it allocates memory to the C Program Heap. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bsp +name: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK +notes: | + This option should not be defined by the application. Only the BSP knows how + it allocates memory to the C Program Heap. text: '' type: interface diff --git a/spec/acfg/opt/mallocdirty.yml b/spec/acfg/opt/mallocdirty.yml index d5460b08..41232e57 100644 --- a/spec/acfg/opt/mallocdirty.yml +++ b/spec/acfg/opt/mallocdirty.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then each memory area returned - by C Program Heap allocator functions such as :c:func:`malloc` is dirtied - with a ``0xCF`` byte pattern before it is handed over to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MALLOC_DIRTY -appl-config-option-notes: | - The dirtying performed by this option is carried out for each successful - memory allocation from the C Program Heap in contrast to - :ref:`CONFIGURE_DIRTY_MEMORY` which dirties the memory only once during the - system initialization. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then each memory area returned + by C Program Heap allocator functions such as :c:func:`malloc` is dirtied + with a ``0xCF`` byte pattern before it is handed over to the application. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_MALLOC_DIRTY +notes: | + The dirtying performed by this option is carried out for each successful + memory allocation from the C Program Heap in contrast to + :ref:`CONFIGURE_DIRTY_MEMORY` which dirties the memory only once during the + system initialization. text: '' type: interface diff --git a/spec/acfg/opt/maxbarriers.yml b/spec/acfg/opt/maxbarriers.yml index 0fc9fd24..3f39c3d7 100644 --- a/spec/acfg/opt/maxbarriers.yml +++ b/spec/acfg/opt/maxbarriers.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Barriers that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_BARRIERS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Barriers that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_BARRIERS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxdrivers.yml b/spec/acfg/opt/maxdrivers.yml index b4bb06a5..9b811c56 100644 --- a/spec/acfg/opt/maxdrivers.yml +++ b/spec/acfg/opt/maxdrivers.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | It shall be greater than or equal than the number of statically configured @@ -7,27 +8,26 @@ appl-config-option-constraint: links: - /acfg/opt/constraintmemsz max: '``SIZE_MAX``' -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | This is computed by default, and is set to the number of device drivers configured using the ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options. -appl-config-option-description: | +description: | The value of this configuration option defines the number of device drivers. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_DRIVERS -appl-config-option-notes: | - If the application will dynamically install device drivers, then this - configuration parameter shall be larger than the number of statically - configured device drivers. Drivers configured using the - ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options are - statically installed. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../devdrv +name: CONFIGURE_MAXIMUM_DRIVERS +notes: | + If the application will dynamically install device drivers, then this + configuration parameter shall be larger than the number of statically + configured device drivers. Drivers configured using the + ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options are + statically installed. text: '' type: interface diff --git a/spec/acfg/opt/maxfiledescriptors.yml b/spec/acfg/opt/maxfiledescriptors.yml index 14f51131..aecb9c17 100644 --- a/spec/acfg/opt/maxfiledescriptors.yml +++ b/spec/acfg/opt/maxfiledescriptors.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintmemsz max: '``SIZE_MAX``' min: 0 -appl-config-option-default-value: 3 -appl-config-option-description: | - The value of this configuration option defines the maximum number of file - like objects that can be concurrently open. -appl-config-option-index: -- maximum file descriptors -appl-config-option-name: CONFIGURE_MAXIMUM_FILE_DESCRIPTORS -appl-config-option-notes: | - The default value of three file descriptors allows RTEMS to support standard - input, output, and error I/O streams on ``/dev/console``. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 3 +description: | + The value of this configuration option defines the maximum number of file + like objects that can be concurrently open. enabled-by: true +index-entries: +- maximum file descriptors interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_MAXIMUM_FILE_DESCRIPTORS +notes: | + The default value of three file descriptors allows RTEMS to support standard + input, output, and error I/O streams on ``/dev/console``. text: '' type: interface diff --git a/spec/acfg/opt/maxmessagequeues.yml b/spec/acfg/opt/maxmessagequeues.yml index a4952be9..1b6b5a24 100644 --- a/spec/acfg/opt/maxmessagequeues.yml +++ b/spec/acfg/opt/maxmessagequeues.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Message Queues that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_MESSAGE_QUEUES -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to - store the messages of each message queue, see - :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Message Queues that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_MESSAGE_QUEUES +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to + store the messages of each message queue, see + :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. text: '' type: interface diff --git a/spec/acfg/opt/maxpartitions.yml b/spec/acfg/opt/maxpartitions.yml index c7953865..fb9fcd5d 100644 --- a/spec/acfg/opt/maxpartitions.yml +++ b/spec/acfg/opt/maxpartitions.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Partitions that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_PARTITIONS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Partitions that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_PARTITIONS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxperiods.yml b/spec/acfg/opt/maxperiods.yml index bcb0d3e0..f8bf50a5 100644 --- a/spec/acfg/opt/maxperiods.yml +++ b/spec/acfg/opt/maxperiods.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Periods that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_PERIODS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Periods that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_PERIODS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxports.yml b/spec/acfg/opt/maxports.yml index 3674bffd..0ccb8c72 100644 --- a/spec/acfg/opt/maxports.yml +++ b/spec/acfg/opt/maxports.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Ports that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_PORTS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Ports that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_PORTS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxposixkeys.yml b/spec/acfg/opt/maxposixkeys.yml index bd4af230..b3973715 100644 --- a/spec/acfg/opt/maxposixkeys.yml +++ b/spec/acfg/opt/maxposixkeys.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of POSIX - API Keys that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_KEYS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of POSIX + API Keys that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_KEYS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxposixkeyvaluepairs.yml b/spec/acfg/opt/maxposixkeyvaluepairs.yml index f3339c18..3a947f44 100644 --- a/spec/acfg/opt/maxposixkeyvaluepairs.yml +++ b/spec/acfg/opt/maxposixkeyvaluepairs.yml @@ -1,33 +1,33 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is :ref:`CONFIGURE_MAXIMUM_POSIX_KEYS` * :ref:`CONFIGURE_MAXIMUM_TASKS` + :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`. -appl-config-option-description: | +description: | The value of this configuration option defines the maximum number of key value pairs used by POSIX API Keys that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. - - A key value pair is created by :c:func:`pthread_setspecific` if the value - is not :c:macro:`NULL`, otherwise it is deleted. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. + + A key value pair is created by :c:func:`pthread_setspecific` if the value + is not :c:macro:`NULL`, otherwise it is deleted. text: '' type: interface diff --git a/spec/acfg/opt/maxposixmessagequeues.yml b/spec/acfg/opt/maxposixmessagequeues.yml index bccebd4d..96a45d7e 100644 --- a/spec/acfg/opt/maxposixmessagequeues.yml +++ b/spec/acfg/opt/maxposixmessagequeues.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of POSIX - API Message Queues that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to - store the messages of each message queue, see - :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of POSIX + API Message Queues that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. You have to account for the memory used to + store the messages of each message queue, see + :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. text: '' type: interface diff --git a/spec/acfg/opt/maxposixqueuedsignals.yml b/spec/acfg/opt/maxposixqueuedsignals.yml index 01f4e621..605666d7 100644 --- a/spec/acfg/opt/maxposixqueuedsignals.yml +++ b/spec/acfg/opt/maxposixqueuedsignals.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintposix - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of POSIX - API Queued Signals that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS -appl-config-option-notes: | - Unlimited objects are not available for queued signals. - - Queued signals are only available if RTEMS was built with the - ``--enable-posix`` build configuration option. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of POSIX + API Queued Signals that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS +notes: | + Unlimited objects are not available for queued signals. + + Queued signals are only available if RTEMS was built with the + ``--enable-posix`` build configuration option. text: '' type: interface diff --git a/spec/acfg/opt/maxposixsemaphores.yml b/spec/acfg/opt/maxposixsemaphores.yml index b57f90dc..4d1a691f 100644 --- a/spec/acfg/opt/maxposixsemaphores.yml +++ b/spec/acfg/opt/maxposixsemaphores.yml @@ -1,31 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the maximum number of POSIX API Named Semaphores that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES +notes: | This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. Named semaphores are created with :c:func:`sem_open()`. Semaphores initialized with :c:func:`sem_init()` are not affected by this configuration option since the storage space for these semaphores is user-provided. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../posix text: '' type: interface diff --git a/spec/acfg/opt/maxposixshms.yml b/spec/acfg/opt/maxposixshms.yml index 0509b6a1..6b0c6dbd 100644 --- a/spec/acfg/opt/maxposixshms.yml +++ b/spec/acfg/opt/maxposixshms.yml @@ -1,27 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of POSIX - API Shared Memory objects that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_SHMS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of POSIX + API Shared Memory objects that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_SHMS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxposixthreads.yml b/spec/acfg/opt/maxposixthreads.yml index 059aec4c..c304de6d 100644 --- a/spec/acfg/opt/maxposixthreads.yml +++ b/spec/acfg/opt/maxposixthreads.yml @@ -1,17 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintstackspace - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the maximum number of POSIX API Threads that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_THREADS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_THREADS +notes: | This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. @@ -27,13 +35,5 @@ appl-config-option-notes: | :ref:`CONFIGURE_MAXIMUM_TASKS`. All POSIX threads have floating point enabled. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../posix text: '' type: interface diff --git a/spec/acfg/opt/maxposixtimers.yml b/spec/acfg/opt/maxposixtimers.yml index 6a101e0e..31208641 100644 --- a/spec/acfg/opt/maxposixtimers.yml +++ b/spec/acfg/opt/maxposixtimers.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintposix - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of POSIX - API Timers that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_TIMERS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. - - Timers are only available if RTEMS was built with the - ``--enable-posix`` build configuration option. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of POSIX + API Timers that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MAXIMUM_POSIX_TIMERS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. + + Timers are only available if RTEMS was built with the + ``--enable-posix`` build configuration option. text: '' type: interface diff --git a/spec/acfg/opt/maxpriority.yml b/spec/acfg/opt/maxpriority.yml index 8e677685..732f11d7 100644 --- a/spec/acfg/opt/maxpriority.yml +++ b/spec/acfg/opt/maxpriority.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: set: - 3 - 7 @@ -7,8 +8,10 @@ appl-config-option-constraint: - 63 - 127 - 255 -appl-config-option-default-value: 255 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 255 +description: | For the following schedulers * :ref:`SchedulerPriority`, which is the default in uniprocessor @@ -25,11 +28,16 @@ appl-config-option-description: | for these schedulers and one less that the number of priority levels for these schedulers. For all other schedulers provided by RTEMS, this configuration option has no effect. -appl-config-option-index: +enabled-by: true +index-entries: - maximum priority - number of priority levels -appl-config-option-name: CONFIGURE_MAXIMUM_PRIORITY -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_MAXIMUM_PRIORITY +notes: | The numerically greatest priority is the logically lowest priority in the system and will thus be used by the IDLE task. @@ -46,13 +54,5 @@ appl-config-option-notes: | The default value is 255, because RTEMS shall support 256 priority levels to be compliant with various standards. These priorities range from 0 to 255. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/maxprocessors.yml b/spec/acfg/opt/maxprocessors.yml index ff15ee26..9231c709 100644 --- a/spec/acfg/opt/maxprocessors.yml +++ b/spec/acfg/opt/maxprocessors.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``CPU_MAXIMUM_PROCESSORS``' min: 0 -appl-config-option-default-value: 1 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 1 +description: | The value of this configuration option defines the maximum number of processors an application intends to use. The number of actually available processors depends on the hardware and may be less. It is recommended to use the smallest value suitable for the application in order to save memory. Each processor needs an IDLE task stack and interrupt stack for example. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_PROCESSORS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_MAXIMUM_PROCESSORS +notes: | If there are more processors available than configured, the rest will be ignored. This configuration option is only evaluated in SMP configurations (e.g. RTEMS was built with the ``--enable-smp`` build configuration option). In all other configurations it has no effect. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/maxregions.yml b/spec/acfg/opt/maxregions.yml index 3218aafb..c98ae27a 100644 --- a/spec/acfg/opt/maxregions.yml +++ b/spec/acfg/opt/maxregions.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Regions that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_REGIONS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Regions that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_REGIONS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxsemaphores.yml b/spec/acfg/opt/maxsemaphores.yml index 64ca7fa2..5b7349b5 100644 --- a/spec/acfg/opt/maxsemaphores.yml +++ b/spec/acfg/opt/maxsemaphores.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the maximum number of Classic API Semaphore that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_SEMAPHORES -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../classic +name: CONFIGURE_MAXIMUM_SEMAPHORES +notes: | This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. In SMP configurations, the size of a Semaphore Control Block depends on the scheduler count (see :ref:`ConfigurationSchedulerTable`). The semaphores using the :ref:`MrsP` need a ceiling priority per scheduler. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../classic text: '' type: interface diff --git a/spec/acfg/opt/maxtasks.yml b/spec/acfg/opt/maxtasks.yml index 08982cff..98840903 100644 --- a/spec/acfg/opt/maxtasks.yml +++ b/spec/acfg/opt/maxtasks.yml @@ -1,18 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintstackspace - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the maximum number of Classic API Tasks that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_TASKS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../classic +name: CONFIGURE_MAXIMUM_TASKS +notes: | This object class can be configured in unlimited allocation mode, see :ref:`ConfigUnlimitedObjects`. @@ -31,13 +39,5 @@ appl-config-option-notes: | assumption that all tasks have floating point enabled. This would require the addition of a new configuration parameter to specify the number of tasks which enable floating point support. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../classic text: '' type: interface diff --git a/spec/acfg/opt/maxthreadnamesize.yml b/spec/acfg/opt/maxthreadnamesize.yml index da47d1b3..f1fd0ac4 100644 --- a/spec/acfg/opt/maxthreadnamesize.yml +++ b/spec/acfg/opt/maxthreadnamesize.yml @@ -1,17 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintmemsz max: '``SIZE_MAX``' min: 0 -appl-config-option-default-value: 16 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 16 +description: | The value of this configuration option defines the maximum thread name size including the terminating ``NUL`` character. -appl-config-option-index: +enabled-by: true +index-entries: - maximum thread name size -appl-config-option-name: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE +notes: | The default value was chosen for Linux compatibility, see `PTHREAD_SETNAME_NP(3) <http://man7.org/linux/man-pages/man3/pthread_setname_np.3.html>`_. @@ -19,13 +27,5 @@ appl-config-option-notes: | size. This configuration option is available since RTEMS 5.1. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/maxtimers.yml b/spec/acfg/opt/maxtimers.yml index e630b664..43814f94 100644 --- a/spec/acfg/opt/maxtimers.yml +++ b/spec/acfg/opt/maxtimers.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintunlimited - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API Timers that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_TIMERS -appl-config-option-notes: | - This object class can be configured in unlimited allocation mode, see - :ref:`ConfigUnlimitedObjects`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API Timers that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_TIMERS +notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. text: '' type: interface diff --git a/spec/acfg/opt/maxuserextensions.yml b/spec/acfg/opt/maxuserextensions.yml index 72ec1302..638b58d5 100644 --- a/spec/acfg/opt/maxuserextensions.yml +++ b/spec/acfg/opt/maxuserextensions.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintmemsz max: 65535 min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the maximum number of Classic - API User Extensions that can be concurrently active. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MAXIMUM_USER_EXTENSIONS -appl-config-option-notes: | - This object class cannot be configured in unlimited allocation mode. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the maximum number of Classic + API User Extensions that can be concurrently active. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../classic +name: CONFIGURE_MAXIMUM_USER_EXTENSIONS +notes: | + This object class cannot be configured in unlimited allocation mode. text: '' type: interface diff --git a/spec/acfg/opt/memoryoverhead.yml b/spec/acfg/opt/memoryoverhead.yml index b60500f1..bf0935cf 100644 --- a/spec/acfg/opt/memoryoverhead.yml +++ b/spec/acfg/opt/memoryoverhead.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the number of kilobytes the application wishes to add to the RTEMS Workspace size calculated by ``<rtems/confdefs.h>``. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MEMORY_OVERHEAD -appl-config-option-notes: | - This configuration option should only be used when it is suspected that a bug - in ``<rtems/confdefs.h>`` has resulted in an underestimation. Typically the - memory allocation will be too low when an application does not account for - all message queue buffers or task stacks, see - :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_MEMORY_OVERHEAD +notes: | + This configuration option should only be used when it is suspected that a bug + in ``<rtems/confdefs.h>`` has resulted in an underestimation. Typically the + memory allocation will be too low when an application does not account for + all message queue buffers or task stacks, see + :ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`. text: '' type: interface diff --git a/spec/acfg/opt/messagebuffermemory.yml b/spec/acfg/opt/messagebuffermemory.yml index d2954fc2..457eb72c 100644 --- a/spec/acfg/opt/messagebuffermemory.yml +++ b/spec/acfg/opt/messagebuffermemory.yml @@ -1,19 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintwkspace - /acfg/opt/constraintmemsz min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | The value of this configuration option defines the number of bytes reserved for message queue buffers in the RTEMS Workspace. -appl-config-option-index: +enabled-by: true +index-entries: - configure message queue buffer memory - CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE - memory for a single message queue's buffers -appl-config-option-name: CONFIGURE_MESSAGE_BUFFER_MEMORY -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_MESSAGE_BUFFER_MEMORY +notes: | The configuration options :ref:`CONFIGURE_MAXIMUM_MESSAGE_QUEUES` and :ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES` define only how many message queues can be created by the application. The memory for the message @@ -59,13 +67,5 @@ appl-config-option-notes: | sizeof( other_message_type ) \ ) \ ) -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/microsecondspertick.yml b/spec/acfg/opt/microsecondspertick.yml index f7ccd10a..704881c9 100644 --- a/spec/acfg/opt/microsecondspertick.yml +++ b/spec/acfg/opt/microsecondspertick.yml @@ -1,11 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - It shall be greater than or equal to a Clock Driver specific value. - It shall be less than or equal to a Clock Driver specific value. - The resulting clock ticks per second should be an integer. -appl-config-option-default-value: 10000 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 10000 +description: | The value of this configuration option defines the length of time in microseconds between clock ticks (clock tick quantum). @@ -23,23 +26,20 @@ appl-config-option-description: | delay times in the application are evenly divisible by it. Otherwise, rounding errors will be introduced which may negatively impact the application. -appl-config-option-index: +enabled-by: true +index-entries: - clock tick quantum - tick quantum -appl-config-option-name: CONFIGURE_MICROSECONDS_PER_TICK -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_MICROSECONDS_PER_TICK +notes: | This configuration option has no impact if the Clock Driver is not configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`. There may be Clock Driver specific limits on the resolution or maximum value of a clock tick quantum. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/minposixthreadstacksize.yml b/spec/acfg/opt/minposixthreadstacksize.yml index 238cc375..94c69016 100644 --- a/spec/acfg/opt/minposixthreadstacksize.yml +++ b/spec/acfg/opt/minposixthreadstacksize.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintbspappmin - /acfg/opt/constraintstackspace -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is two times the value of :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. -appl-config-option-description: | +description: | The value of this configuration option defines the minimum stack size in bytes for every POSIX thread in the system. -appl-config-option-index: -- minimum POSIX thread stack size -appl-config-option-name: CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: +- minimum POSIX thread stack size interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posix +name: CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/mintaskstacksize.yml b/spec/acfg/opt/mintaskstacksize.yml index 658701cd..67334562 100644 --- a/spec/acfg/opt/mintaskstacksize.yml +++ b/spec/acfg/opt/mintaskstacksize.yml @@ -1,16 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintbspappmin - /acfg/opt/constraintstackspace -appl-config-option-default-value: '``CPU_STACK_MINIMUM_SIZE``' -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``CPU_STACK_MINIMUM_SIZE``' +description: | The value of this configuration option defines the minimum stack size in bytes for every user task or thread in the system. -appl-config-option-index: +enabled-by: true +index-entries: - minimum task stack size -appl-config-option-name: CONFIGURE_MINIMUM_TASK_STACK_SIZE -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_MINIMUM_TASK_STACK_SIZE +notes: | Adjusting this parameter should be done with caution. Examining the actual stack usage using the stack checker usage reporting facility is recommended (see also :ref:`CONFIGURE_STACK_CHECKER_ENABLED`). @@ -31,13 +39,5 @@ appl-config-option-notes: | In releases before RTEMS 5.1 the ``CONFIGURE_MINIMUM_TASK_STACK_SIZE`` was used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/mpappl.yml b/spec/acfg/opt/mpappl.yml index 4901a405..6f21d52a 100644 --- a/spec/acfg/opt/mpappl.yml +++ b/spec/acfg/opt/mpappl.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then the multiprocessing services are not initialized. -appl-config-option-description: | +description: | This configuration option is defined to indicate that the application intends to be part of a multiprocessing configuration. Additional configuration options are assumed to be provided. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_APPLICATION -appl-config-option-notes: | - This configuration option shall be undefined if the multiprocessing support - is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing`` - build configuration option). Otherwise a compile time error in the - configuration file will occur. -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../mpci +name: CONFIGURE_MP_APPLICATION +notes: | + This configuration option shall be undefined if the multiprocessing support + is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing`` + build configuration option). Otherwise a compile time error in the + configuration file will occur. text: '' type: interface diff --git a/spec/acfg/opt/mpextraserverstack.yml b/spec/acfg/opt/mpextraserverstack.yml index 6dcdee23..67959ad7 100644 --- a/spec/acfg/opt/mpextraserverstack.yml +++ b/spec/acfg/opt/mpextraserverstack.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be small enough so that the @@ -7,23 +8,22 @@ appl-config-option-constraint: ``<rtems/confdefs.h>`` does not overflow an integer of type ``size_t``. max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: 0 +description: | The value of this configuration option defines the number of bytes the applications wishes to add to the MPCI task stack on top of :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK -appl-config-option-notes: | - This configuration option is only evaluated if - :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: integer -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../mpci +name: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK +notes: | + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. text: '' type: interface diff --git a/spec/acfg/opt/mpmaxglobalobjects.yml b/spec/acfg/opt/mpmaxglobalobjects.yml index 715b75a7..0564153a 100644 --- a/spec/acfg/opt/mpmaxglobalobjects.yml +++ b/spec/acfg/opt/mpmaxglobalobjects.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 32 -appl-config-option-description: | - The value of this configuration option defines the maximum number of - concurrently active global objects in a multiprocessor system. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS -appl-config-option-notes: | - This value corresponds to the total number of objects which can be created - with the ``RTEMS_GLOBAL`` attribute. - - This configuration option is only evaluated if - :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 32 +description: | + The value of this configuration option defines the maximum number of + concurrently active global objects in a multiprocessor system. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../mpci +name: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS +notes: | + This value corresponds to the total number of objects which can be created + with the ``RTEMS_GLOBAL`` attribute. + + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. text: '' type: interface diff --git a/spec/acfg/opt/mpmaxnodes.yml b/spec/acfg/opt/mpmaxnodes.yml index 0f85fc2d..d0421050 100644 --- a/spec/acfg/opt/mpmaxnodes.yml +++ b/spec/acfg/opt/mpmaxnodes.yml @@ -1,23 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 2 -appl-config-option-description: | - The value of this configuration option defines the maximum number of nodes in - a multiprocessor system. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_MAXIMUM_NODES -appl-config-option-notes: | - This configuration option is only evaluated if - :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 2 +description: | + The value of this configuration option defines the maximum number of nodes in + a multiprocessor system. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../mpci +name: CONFIGURE_MP_MAXIMUM_NODES +notes: | + This configuration option is only evaluated if + :ref:`CONFIGURE_MP_APPLICATION` is defined. text: '' type: interface diff --git a/spec/acfg/opt/mpmaxproxies.yml b/spec/acfg/opt/mpmaxproxies.yml index f04b33e9..89aadb5d 100644 --- a/spec/acfg/opt/mpmaxproxies.yml +++ b/spec/acfg/opt/mpmaxproxies.yml @@ -1,15 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 32 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 32 +description: | The value of this configuration option defines the maximum number of concurrently active thread/task proxies on this node in a multiprocessor system. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_MAXIMUM_PROXIES -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../mpci +name: CONFIGURE_MP_MAXIMUM_PROXIES +notes: | Since a proxy is used to represent a remote task/thread which is blocking on this node. This configuration parameter reflects the maximum number of remote tasks/threads which can be blocked on objects on this node, see @@ -17,13 +25,5 @@ appl-config-option-notes: | This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../mpci text: '' type: interface diff --git a/spec/acfg/opt/mpmpcitablepointer.yml b/spec/acfg/opt/mpmpcitablepointer.yml index 7b854156..2ad9d26f 100644 --- a/spec/acfg/opt/mpmpcitablepointer.yml +++ b/spec/acfg/opt/mpmpcitablepointer.yml @@ -1,29 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a pointer to :c:type:`rtems_mpci_table`. -appl-config-option-default-value: '``&MPCI_table``' -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``&MPCI_table``' +description: | The value of this configuration option initializes the MPCI Configuration Table. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_MPCI_TABLE_POINTER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../mpci +name: CONFIGURE_MP_MPCI_TABLE_POINTER +notes: | RTEMS provides a Shared Memory MPCI Device Driver which can be used on any Multiprocessor System assuming the BSP provides the proper set of supporting methods. This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../mpci text: '' type: interface diff --git a/spec/acfg/opt/mpnodenumber.yml b/spec/acfg/opt/mpnodenumber.yml index 0e0d3970..785ce68a 100644 --- a/spec/acfg/opt/mpnodenumber.yml +++ b/spec/acfg/opt/mpnodenumber.yml @@ -1,14 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: '``NODE_NUMBER``' -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``NODE_NUMBER``' +description: | The value of this configuration option defines the node number of this node in a multiprocessor system. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_MP_NODE_NUMBER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../mpci +name: CONFIGURE_MP_NODE_NUMBER +notes: | In the RTEMS Multiprocessing Test Suite, the node number is derived from the Makefile variable ``NODE_NUMBER``. The same code is compiled with the ``NODE_NUMBER`` set to different values. The test programs behave @@ -16,13 +24,5 @@ appl-config-option-notes: | This configuration option is only evaluated if :ref:`CONFIGURE_MP_APPLICATION` is defined. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../mpci text: '' type: interface diff --git a/spec/acfg/opt/posixinitthreadentrypoint.yml b/spec/acfg/opt/posixinitthreadentrypoint.yml index debb1dbe..9b3dc772 100644 --- a/spec/acfg/opt/posixinitthreadentrypoint.yml +++ b/spec/acfg/opt/posixinitthreadentrypoint.yml @@ -1,25 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void *( *entry_point )( void * )``. -appl-config-option-default-value: '``POSIX_Init``' -appl-config-option-description: | - The value of this configuration option initializes the entry point of the - POSIX API initialization thread. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT -appl-config-option-notes: | - The application shall provide the function referenced by this configuration - option. -appl-config-option-type: initializer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``POSIX_Init``' +description: | + The value of this configuration option initializes the entry point of the + POSIX API initialization thread. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posixinit +name: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT +notes: | + The application shall provide the function referenced by this configuration + option. text: '' type: interface diff --git a/spec/acfg/opt/posixinitthreadstacksize.yml b/spec/acfg/opt/posixinitthreadstacksize.yml index 7780468c..d7213fa0 100644 --- a/spec/acfg/opt/posixinitthreadstacksize.yml +++ b/spec/acfg/opt/posixinitthreadstacksize.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintstackspace min: :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` -appl-config-option-default-value: :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE` -appl-config-option-description: | - The value of this configuration option defines the thread stack size of the - POSIX API initialization thread. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE` +description: | + The value of this configuration option defines the thread stack size of the + POSIX API initialization thread. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../posixinit +name: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE +notes: null text: '' type: interface diff --git a/spec/acfg/opt/posixinitthreadtable.yml b/spec/acfg/opt/posixinitthreadtable.yml index 8dc7c535..21303d14 100644 --- a/spec/acfg/opt/posixinitthreadtable.yml +++ b/spec/acfg/opt/posixinitthreadtable.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then exactly one POSIX initialization thread is configured. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_TABLE -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../posixinit +name: CONFIGURE_POSIX_INIT_THREAD_TABLE +notes: | The application shall define exactly one of the following configuration options @@ -15,13 +23,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` otherwise a compile time error in the configuration file will occur. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../posixinit text: '' type: interface diff --git a/spec/acfg/opt/recordextensionsenabled.yml b/spec/acfg/opt/recordextensionsenabled.yml index 0e7ced5f..534a1f9f 100644 --- a/spec/acfg/opt/recordextensionsenabled.yml +++ b/spec/acfg/opt/recordextensionsenabled.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) +description: | In case * this configuration option is defined @@ -7,18 +10,15 @@ appl-config-option-description: | * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined, then the event record extensions are enabled. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_RECORD_EXTENSIONS_ENABLED -appl-config-option-notes: | - The record extensions capture thread create, start, restart, delete, switch, - begin, exitted and terminate events. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../eventrecord +name: CONFIGURE_RECORD_EXTENSIONS_ENABLED +notes: | + The record extensions capture thread create, start, restart, delete, switch, + begin, exitted and terminate events. text: '' type: interface diff --git a/spec/acfg/opt/recordfataldumpbase64.yml b/spec/acfg/opt/recordfataldumpbase64.yml index 75ba96d2..9215c7b1 100644 --- a/spec/acfg/opt/recordfataldumpbase64.yml +++ b/spec/acfg/opt/recordfataldumpbase64.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | In case * this configuration option is defined @@ -10,17 +13,14 @@ appl-config-option-description: | then the event records are dumped in Base64 encoding in a fatal error extension (see :ref:`Terminate`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_RECORD_FATAL_DUMP_BASE64 -appl-config-option-notes: | - This extension can be used to produce crash dumps. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../eventrecord +name: CONFIGURE_RECORD_FATAL_DUMP_BASE64 +notes: | + This extension can be used to produce crash dumps. text: '' type: interface diff --git a/spec/acfg/opt/recordfataldumpbase64zlib.yml b/spec/acfg/opt/recordfataldumpbase64zlib.yml index f49458c8..94f2af95 100644 --- a/spec/acfg/opt/recordfataldumpbase64zlib.yml +++ b/spec/acfg/opt/recordfataldumpbase64zlib.yml @@ -1,5 +1,8 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | In case * this configuration option is defined @@ -8,18 +11,15 @@ appl-config-option-description: | then the event records are compressed by zlib and dumped in Base64 encoding in a fatal error extension (see :ref:`Terminate`). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB -appl-config-option-notes: | - The zlib compression needs about 512KiB of RAM. This extension can be used - to produce crash dumps. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../eventrecord +name: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB +notes: | + The zlib compression needs about 512KiB of RAM. This extension can be used + to produce crash dumps. text: '' type: interface diff --git a/spec/acfg/opt/recordperprocessoritems.yml b/spec/acfg/opt/recordperprocessoritems.yml index db5f68ca..6caeaaf0 100644 --- a/spec/acfg/opt/recordperprocessoritems.yml +++ b/spec/acfg/opt/recordperprocessoritems.yml @@ -1,28 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - It shall be a power of two. links: - /acfg/opt/constraintmemsz max: '``SIZE_MAX``' min: 16 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the event record item count - per processor. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS -appl-config-option-notes: | - The event record buffers are statically allocated for each configured - processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this - configuration option is zero, then nothing is allocated. -appl-config-option-type: integer copyrights: - Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) +default-value: 0 +description: | + The value of this configuration option defines the event record item count + per processor. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../eventrecord +name: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS +notes: | + The event record buffers are statically allocated for each configured + processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this + configuration option is zero, then nothing is allocated. text: '' type: interface diff --git a/spec/acfg/opt/rtemsinittaskstable.yml b/spec/acfg/opt/rtemsinittaskstable.yml index 0ebb36bb..3c196461 100644 --- a/spec/acfg/opt/rtemsinittaskstable.yml +++ b/spec/acfg/opt/rtemsinittaskstable.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then exactly one Classic API initialization task is configured. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_RTEMS_INIT_TASKS_TABLE -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../classicinit +name: CONFIGURE_RTEMS_INIT_TASKS_TABLE +notes: | The application shall define exactly one of the following configuration options @@ -15,13 +23,5 @@ appl-config-option-notes: | * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` otherwise a compile time error in the configuration file will occur. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../classicinit text: '' type: interface diff --git a/spec/acfg/opt/schedulerassignments.yml b/spec/acfg/opt/schedulerassignments.yml index b6a8b7ad..b72defd2 100644 --- a/spec/acfg/opt/schedulerassignments.yml +++ b/spec/acfg/opt/schedulerassignments.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be a list of the following @@ -11,26 +12,25 @@ appl-config-option-constraint: - | The value of this configuration option shall be a list of exactly :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: | The default value of this configuration option is computed so that the default scheduler is assigned to each configured processor (up to 32). -appl-config-option-description: | +description: | The value of this configuration option is used to initialize the initial scheduler to processor assignments. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_ASSIGNMENTS -appl-config-option-notes: | - This configuration option is only evaluated in SMP configurations. - - This is an advanced configuration option, see - :ref:`ConfigurationSchedulersClustered`. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_ASSIGNMENTS +notes: | + This configuration option is only evaluated in SMP configurations. + + This is an advanced configuration option, see + :ref:`ConfigurationSchedulersClustered`. text: '' type: interface diff --git a/spec/acfg/opt/schedulercbs.yml b/spec/acfg/opt/schedulercbs.yml index cb599c8a..4408dd82 100644 --- a/spec/acfg/opt/schedulercbs.yml +++ b/spec/acfg/opt/schedulercbs.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Constant Bandwidth Server (CBS) Scheduler <SchedulerCBS>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_CBS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_CBS +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. In case no explicit :ref:`clustered scheduler configuration <ConfigurationSchedulersClustered>` is present, then it is used as the scheduler for exactly one processor. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/scheduleredf.yml b/spec/acfg/opt/scheduleredf.yml index f5a93670..68ca4b6f 100644 --- a/spec/acfg/opt/scheduleredf.yml +++ b/spec/acfg/opt/scheduleredf.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Earliest Deadline First (EDF) Scheduler <SchedulerEDF>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_EDF -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_EDF +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. In case no explicit :ref:`clustered scheduler configuration <ConfigurationSchedulersClustered>` is present, then it is used as the scheduler for exactly one processor. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/scheduleredfsmp.yml b/spec/acfg/opt/scheduleredfsmp.yml index a35a5432..fdcb82e7 100644 --- a/spec/acfg/opt/scheduleredfsmp.yml +++ b/spec/acfg/opt/scheduleredfsmp.yml @@ -1,11 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Earliest Deadline First (EDF) SMP Scheduler <SchedulerSMPEDF>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_EDF_SMP -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_EDF_SMP +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -19,13 +27,5 @@ appl-config-option-notes: | This scheduler algorithm is the default in SMP configurations if :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is greater than one. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulername.yml b/spec/acfg/opt/schedulername.yml index d6a6e0ae..dc16b5ac 100644 --- a/spec/acfg/opt/schedulername.yml +++ b/spec/acfg/opt/schedulername.yml @@ -1,10 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall be a valid integer of type ``rtems_name``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is * ``"MEDF"`` for the :ref:`EDF SMP Scheduler <SchedulerSMPEDF>`, @@ -22,25 +25,22 @@ appl-config-option-default-value: | * ``"UPD "`` for the :ref:`Uniprocessor Deterministic Priority Scheduler <SchedulerPriority>`, and * ``"UPS "`` for the :ref:`Uniprocessor Simple Priority Scheduler <SchedulerPrioritySimple>`. -appl-config-option-description: | +description: | The value of this configuration option defines the name of the default scheduler. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_NAME -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_NAME +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. Schedulers can be identified via c:func:`rtems_scheduler_ident`. Use :c:func:`rtems_build_name` to define the scheduler name. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulerpriority.yml b/spec/acfg/opt/schedulerpriority.yml index 3fdb3a9f..fc5d349f 100644 --- a/spec/acfg/opt/schedulerpriority.yml +++ b/spec/acfg/opt/schedulerpriority.yml @@ -1,11 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2010 Gedare Bloom +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Deterministic Priority Scheduler <SchedulerPriority>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_PRIORITY +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -19,14 +28,5 @@ appl-config-option-notes: | The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2010 Gedare Bloom -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulerpriorityaffinitysmp.yml b/spec/acfg/opt/schedulerpriorityaffinitysmp.yml index f3893f7c..b6e1392a 100644 --- a/spec/acfg/opt/schedulerpriorityaffinitysmp.yml +++ b/spec/acfg/opt/schedulerpriorityaffinitysmp.yml @@ -1,11 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Arbitrary Processor Affinity SMP Scheduler <SchedulerSMPPriorityAffinity>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -18,13 +26,5 @@ appl-config-option-notes: | The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulerprioritysmp.yml b/spec/acfg/opt/schedulerprioritysmp.yml index a1594248..060dc4fc 100644 --- a/spec/acfg/opt/schedulerprioritysmp.yml +++ b/spec/acfg/opt/schedulerprioritysmp.yml @@ -1,11 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY_SMP -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_PRIORITY_SMP +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -18,13 +26,5 @@ appl-config-option-notes: | The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulersimple.yml b/spec/acfg/opt/schedulersimple.yml index ef03c5a4..e6da5ab8 100644 --- a/spec/acfg/opt/schedulersimple.yml +++ b/spec/acfg/opt/schedulersimple.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Simple Priority Scheduler <SchedulerPrioritySimple>` algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_SIMPLE -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_SIMPLE +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. In case no explicit :ref:`clustered scheduler configuration <ConfigurationSchedulersClustered>` is present, then it is used as the scheduler for exactly one processor. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulersimplesmp.yml b/spec/acfg/opt/schedulersimplesmp.yml index 6442e86b..817e12d8 100644 --- a/spec/acfg/opt/schedulersimplesmp.yml +++ b/spec/acfg/opt/schedulersimplesmp.yml @@ -1,12 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>` algorithm is made available to the application. application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_SIMPLE_SMP -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_SIMPLE_SMP +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -16,13 +24,5 @@ appl-config-option-notes: | In case no explicit :ref:`clustered scheduler configuration <ConfigurationSchedulersClustered>` is present, then it is used as the scheduler for up to 32 processors. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/schedulerstrongapa.yml b/spec/acfg/opt/schedulerstrongapa.yml index e88a87c4..70fd5d81 100644 --- a/spec/acfg/opt/schedulerstrongapa.yml +++ b/spec/acfg/opt/schedulerstrongapa.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | In case this configuration option is defined, then Strong APA algorithm is made available to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_STRONG_APA -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_STRONG_APA +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -12,13 +20,5 @@ appl-config-option-notes: | support enabled. This scheduler algorithm is not correctly implemented. Do not use it. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/scheduleruser.yml b/spec/acfg/opt/scheduleruser.yml index 69186bb9..ec12b1b7 100644 --- a/spec/acfg/opt/scheduleruser.yml +++ b/spec/acfg/opt/scheduleruser.yml @@ -1,10 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2010 Gedare Bloom +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the user shall provide a scheduler algorithm to the application. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_USER -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../schedgeneral +name: CONFIGURE_SCHEDULER_USER +notes: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. @@ -29,14 +38,5 @@ appl-config-option-notes: | ``cpukit/score/src/schedulerpriority*.c`` for guidance. For guidance on the configuration macros, please examine ``cpukit/sapi/include/confdefs.h`` for how these are defined for the Deterministic Priority Scheduler. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 2010 Gedare Bloom -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../schedgeneral text: '' type: interface diff --git a/spec/acfg/opt/stackcheckerenabled.yml b/spec/acfg/opt/stackcheckerenabled.yml index 6ed475ef..116397b6 100644 --- a/spec/acfg/opt/stackcheckerenabled.yml +++ b/spec/acfg/opt/stackcheckerenabled.yml @@ -1,22 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the stack checker is - enabled. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_STACK_CHECKER_ENABLED -appl-config-option-notes: | - The stack checker performs run-time stack bounds checking. This increases - the time required to create tasks as well as adding overhead to each context - switch. - - In 4.9 and older, this configuration option was named ``STACK_CHECKER_ON``. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the stack checker is + enabled. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_STACK_CHECKER_ENABLED +notes: | + The stack checker performs run-time stack bounds checking. This increases + the time required to create tasks as well as adding overhead to each context + switch. + + In 4.9 and older, this configuration option was named ``STACK_CHECKER_ON``. text: '' type: interface diff --git a/spec/acfg/opt/swapoutblockhold.yml b/spec/acfg/opt/swapoutblockhold.yml index dbb84187..df9b98f2 100644 --- a/spec/acfg/opt/swapoutblockhold.yml +++ b/spec/acfg/opt/swapoutblockhold.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 1000 -appl-config-option-description: | - The value of this configuration option defines the swapout task maximum block - hold time in milliseconds. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SWAPOUT_BLOCK_HOLD -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 1000 +description: | + The value of this configuration option defines the swapout task maximum block + hold time in milliseconds. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_SWAPOUT_BLOCK_HOLD +notes: null text: '' type: interface diff --git a/spec/acfg/opt/swapoutswapperiod.yml b/spec/acfg/opt/swapoutswapperiod.yml index b35a3c3b..5a657924 100644 --- a/spec/acfg/opt/swapoutswapperiod.yml +++ b/spec/acfg/opt/swapoutswapperiod.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 250 -appl-config-option-description: | - The value of this configuration option defines the swapout task swap period - in milliseconds. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SWAPOUT_SWAP_PERIOD -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 250 +description: | + The value of this configuration option defines the swapout task swap period + in milliseconds. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_SWAPOUT_SWAP_PERIOD +notes: null text: '' type: interface diff --git a/spec/acfg/opt/swapouttaskpriority.yml b/spec/acfg/opt/swapouttaskpriority.yml index 13fb4078..01faf17f 100644 --- a/spec/acfg/opt/swapouttaskpriority.yml +++ b/spec/acfg/opt/swapouttaskpriority.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintprioclassic -appl-config-option-default-value: 15 -appl-config-option-description: | - The value of this configuration option defines the swapout task priority. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SWAPOUT_TASK_PRIORITY -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 15 +description: | + The value of this configuration option defines the swapout task priority. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_SWAPOUT_TASK_PRIORITY +notes: null text: '' type: interface diff --git a/spec/acfg/opt/swapoutworkertaskpriority.yml b/spec/acfg/opt/swapoutworkertaskpriority.yml index 861cf291..25ca935e 100644 --- a/spec/acfg/opt/swapoutworkertaskpriority.yml +++ b/spec/acfg/opt/swapoutworkertaskpriority.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: links: - /acfg/opt/constraintprioclassic -appl-config-option-default-value: 15 -appl-config-option-description: | - The value of this configuration option defines the swapout worker task - priority. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 15 +description: | + The value of this configuration option defines the swapout worker task + priority. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY +notes: null text: '' type: interface diff --git a/spec/acfg/opt/swapoutworkertasks.yml b/spec/acfg/opt/swapoutworkertasks.yml index 5b425f3a..84c7f6e2 100644 --- a/spec/acfg/opt/swapoutworkertasks.yml +++ b/spec/acfg/opt/swapoutworkertasks.yml @@ -1,20 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 0 -appl-config-option-description: | - The value of this configuration option defines the swapout worker task count. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SWAPOUT_WORKER_TASKS -appl-config-option-notes: null -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 0 +description: | + The value of this configuration option defines the swapout worker task count. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../bdbuf +name: CONFIGURE_SWAPOUT_WORKER_TASKS +notes: null text: '' type: interface diff --git a/spec/acfg/opt/taskstackallocator.yml b/spec/acfg/opt/taskstackallocator.yml index e3a81ff7..c045c58a 100644 --- a/spec/acfg/opt/taskstackallocator.yml +++ b/spec/acfg/opt/taskstackallocator.yml @@ -1,19 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void *( *allocate )( size_t )``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is ``_Workspace_Allocate``, which indicates that task stacks will be allocated from the RTEMS Workspace. -appl-config-option-description: | +description: | The value of this configuration option initializes the stack allocator allocate handler. -appl-config-option-index: +enabled-by: true +index-entries: - task stack allocator -appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../stackalloc +name: CONFIGURE_TASK_STACK_ALLOCATOR +notes: | A correctly configured system shall configure the following to be consistent: - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT` @@ -21,13 +29,5 @@ appl-config-option-notes: | - `CONFIGURE_TASK_STACK_ALLOCATOR` - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../stackalloc text: '' type: interface diff --git a/spec/acfg/opt/taskstackallocatorinit.yml b/spec/acfg/opt/taskstackallocatorinit.yml index c5c549da..74060ea6 100644 --- a/spec/acfg/opt/taskstackallocatorinit.yml +++ b/spec/acfg/opt/taskstackallocatorinit.yml @@ -1,16 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void ( *initialize )( size_t )`` or to ``NULL``. -appl-config-option-default-value: '``NULL``' -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: '``NULL``' +description: | The value of this configuration option initializes the stack allocator initialization handler. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR_INIT -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../stackalloc +name: CONFIGURE_TASK_STACK_ALLOCATOR_INIT +notes: | A correctly configured system shall configure the following to be consistent: - `CONFIGURE_TASK_STACK_ALLOCATOR_INIT` @@ -18,13 +26,5 @@ appl-config-option-notes: | - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../stackalloc text: '' type: interface diff --git a/spec/acfg/opt/taskstackdeallocator.yml b/spec/acfg/opt/taskstackdeallocator.yml index f3c73162..71ea8dd4 100644 --- a/spec/acfg/opt/taskstackdeallocator.yml +++ b/spec/acfg/opt/taskstackdeallocator.yml @@ -1,19 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a valid function pointer of the type ``void ( *deallocate )( void * )``. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: | The default value is ``_Workspace_Free``, which indicates that task stacks will be allocated from the RTEMS Workspace. -appl-config-option-description: | +description: | The value of this configuration option initializes the stack allocator deallocate handler. -appl-config-option-index: +enabled-by: true +index-entries: - task stack deallocator -appl-config-option-name: CONFIGURE_TASK_STACK_DEALLOCATOR -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../stackalloc +name: CONFIGURE_TASK_STACK_DEALLOCATOR +notes: | A correctly configured system shall configure the following to be consistent: - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT` @@ -21,13 +29,5 @@ appl-config-option-notes: | - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` - `CONFIGURE_TASK_STACK_DEALLOCATOR` -appl-config-option-type: initializer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../stackalloc text: '' type: interface diff --git a/spec/acfg/opt/taskstackfromalloc.yml b/spec/acfg/opt/taskstackfromalloc.yml index 0ec0d355..35d4998b 100644 --- a/spec/acfg/opt/taskstackfromalloc.yml +++ b/spec/acfg/opt/taskstackfromalloc.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: initializer +constraints: custom: - | The value of this configuration option shall be defined to a macro which @@ -7,24 +8,23 @@ appl-config-option-constraint: 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. -appl-config-option-default-value: | +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +default-value: | The default value is a macro which supports the system heap allocator. -appl-config-option-description: | +description: | The value of this configuration option is used to calculate the task stack space size. -appl-config-option-index: -- task stack allocator -appl-config-option-name: CONFIGURE_TASK_STACK_FROM_ALLOCATOR -appl-config-option-notes: | - This configuration option may be used if a custom task stack allocator is - configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. -appl-config-option-type: initializer -copyrights: -- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) enabled-by: true +index-entries: +- task stack allocator interface-type: appl-config-option links: - role: appl-config-group-member uid: ../stackalloc +name: CONFIGURE_TASK_STACK_FROM_ALLOCATOR +notes: | + This configuration option may be used if a custom task stack allocator is + configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. text: '' type: interface diff --git a/spec/acfg/opt/taskstacknowkspace.yml b/spec/acfg/opt/taskstacknowkspace.yml index 5834f5f7..cffc33a0 100644 --- a/spec/acfg/opt/taskstacknowkspace.yml +++ b/spec/acfg/opt/taskstacknowkspace.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the system is informed - that the task stack allocator does not use the RTEMS Workspace. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE -appl-config-option-notes: | - This configuration option may be used if a custom task stack allocator is - configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. appl-config-option-type: feature-enable copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +description: | + In case this configuration option is defined, then the system is informed + that the task stack allocator does not use the RTEMS Workspace. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../stackalloc +name: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE +notes: | + This configuration option may be used if a custom task stack allocator is + configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. text: '' type: interface diff --git a/spec/acfg/opt/tickspertimeslice.yml b/spec/acfg/opt/tickspertimeslice.yml index 37d56bbc..a0d6ec48 100644 --- a/spec/acfg/opt/tickspertimeslice.yml +++ b/spec/acfg/opt/tickspertimeslice.yml @@ -1,24 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: max: '``UINT32_MAX``' min: 0 -appl-config-option-default-value: 50 -appl-config-option-description: | - The value of this configuration option defines the length of the timeslice - quantum in ticks for each task. -appl-config-option-index: -- ticks per timeslice -appl-config-option-name: CONFIGURE_TICKS_PER_TIMESLICE -appl-config-option-notes: | - This configuration option has no impact if the Clock Driver is not - configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`. -appl-config-option-type: integer copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 50 +description: | + The value of this configuration option defines the length of the timeslice + quantum in ticks for each task. enabled-by: true +index-entries: +- ticks per timeslice interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_TICKS_PER_TIMESLICE +notes: | + This configuration option has no impact if the Clock Driver is not + configured, see :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`. text: '' type: interface diff --git a/spec/acfg/opt/unifiedworkareas.yml b/spec/acfg/opt/unifiedworkareas.yml index f41968a3..352d68c7 100644 --- a/spec/acfg/opt/unifiedworkareas.yml +++ b/spec/acfg/opt/unifiedworkareas.yml @@ -1,17 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-default: | +appl-config-option-type: feature +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default: | If this configuration option is undefined, then there will be separate memory pools for the RTEMS Workspace and C Program Heap. -appl-config-option-description: | +description: | In case this configuration option is defined, then the RTEMS Workspace and the C Program Heap will be one pool of memory. -appl-config-option-index: +enabled-by: true +index-entries: - unified work areas - separate work areas - RTEMS Workspace - C Program Heap -appl-config-option-name: CONFIGURE_UNIFIED_WORK_AREAS -appl-config-option-notes: | +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_UNIFIED_WORK_AREAS +notes: | Having separate pools does have some advantages in the event a task blows a stack or writes outside its memory area. However, in low memory systems the overhead of the two pools plus the potential for unused memory in either @@ -21,13 +29,5 @@ appl-config-option-notes: | :ref:`ConfigUnlimitedObjects` option. You will be able to create objects until you run out of all available memory rather then just until you run out of RTEMS Workspace. -appl-config-option-type: feature -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/unlimitedallocationsize.yml b/spec/acfg/opt/unlimitedallocationsize.yml index 66e5f90e..51353b59 100644 --- a/spec/acfg/opt/unlimitedallocationsize.yml +++ b/spec/acfg/opt/unlimitedallocationsize.yml @@ -1,30 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-constraint: +appl-config-option-type: integer +constraints: custom: - | The value of this configuration option shall meet the constraints of all object classes to which it is applied. -appl-config-option-default-value: 8 -appl-config-option-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +default-value: 8 +description: | If :ref:`CONFIGURE_UNLIMITED_OBJECTS` is defined, then the value of this configuration option defines the default objects maximum of all object classes supporting :ref:`ConfigUnlimitedObjects` to ``rtems_resource_unlimited(CONFIGURE_UNLIMITED_ALLOCATION_SIZE)``. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_UNLIMITED_ALLOCATION_SIZE -appl-config-option-notes: | - By allowing users to declare all resources as being unlimited the user can - avoid identifying and limiting the resources used. - - The object maximum of each class can be configured also individually using - the :c:func:`rtems_resource_unlimited` macro. -appl-config-option-type: integer -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_UNLIMITED_ALLOCATION_SIZE +notes: | + By allowing users to declare all resources as being unlimited the user can + avoid identifying and limiting the resources used. + + The object maximum of each class can be configured also individually using + the :c:func:`rtems_resource_unlimited` macro. text: '' type: interface diff --git a/spec/acfg/opt/unlimitedobjects.yml b/spec/acfg/opt/unlimitedobjects.yml index 3d677be4..11927fee 100644 --- a/spec/acfg/opt/unlimitedobjects.yml +++ b/spec/acfg/opt/unlimitedobjects.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then unlimited objects are used by default. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_UNLIMITED_OBJECTS -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../general +name: CONFIGURE_UNLIMITED_OBJECTS +notes: | When using unlimited objects, it is common practice to also specify :ref:`CONFIGURE_UNIFIED_WORK_AREAS` so the system operates with a single pool of memory for both RTEMS Workspace and C Program Heap. @@ -13,13 +21,5 @@ appl-config-option-notes: | object class by the user. See also :ref:`CONFIGURE_UNLIMITED_ALLOCATION_SIZE`. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../general text: '' type: interface diff --git a/spec/acfg/opt/usedevfsasbasefilesystem.yml b/spec/acfg/opt/usedevfsasbasefilesystem.yml index 1222b740..4631c885 100644 --- a/spec/acfg/opt/usedevfsasbasefilesystem.yml +++ b/spec/acfg/opt/usedevfsasbasefilesystem.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then an IMFS with a reduced feature set will be the base filesystem (also known as root filesystem). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../filesystem +name: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM +notes: | In case this configuration option is defined, then the following configuration options will be defined as well @@ -38,13 +46,5 @@ appl-config-option-notes: | This configuration of the IMFS is basically a device-only filesystem. It is comparable in functionality to the pseudo-filesystem name space provided before RTEMS release 4.5.0. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../filesystem text: '' type: interface diff --git a/spec/acfg/opt/useminiimfsasbasefilesystem.yml b/spec/acfg/opt/useminiimfsasbasefilesystem.yml index b347628f..4fcd3035 100644 --- a/spec/acfg/opt/useminiimfsasbasefilesystem.yml +++ b/spec/acfg/opt/useminiimfsasbasefilesystem.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then an IMFS with a reduced feature set will be the base filesystem (also known as root filesystem). -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM -appl-config-option-notes: | +enabled-by: true +index-entries: [] +interface-type: appl-config-option +links: +- role: appl-config-group-member + uid: ../filesystem +name: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM +notes: | In case this configuration option is defined, then the following configuration options will be defined as well @@ -23,13 +31,5 @@ appl-config-option-notes: | - :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and - :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true -interface-type: appl-config-option -links: -- role: appl-config-group-member - uid: ../filesystem text: '' type: interface diff --git a/spec/acfg/opt/verbosesysteminit.yml b/spec/acfg/opt/verbosesysteminit.yml index 54f9fa91..21b2f313 100644 --- a/spec/acfg/opt/verbosesysteminit.yml +++ b/spec/acfg/opt/verbosesysteminit.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | - In case this configuration option is defined, then the system initialization - is verbose. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION -appl-config-option-notes: | - You may use this feature to debug system initialization issues. The - :c:func:`printk` function is used to print the information. appl-config-option-type: feature-enable copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + In case this configuration option is defined, then the system initialization + is verbose. enabled-by: true +index-entries: [] interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION +notes: | + You may use this feature to debug system initialization issues. The + :c:func:`printk` function is used to print the information. text: '' type: interface diff --git a/spec/acfg/opt/zeroworkspaceautomatically.yml b/spec/acfg/opt/zeroworkspaceautomatically.yml index 6ff530ac..fdf52162 100644 --- a/spec/acfg/opt/zeroworkspaceautomatically.yml +++ b/spec/acfg/opt/zeroworkspaceautomatically.yml @@ -1,26 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-option-description: | +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | In case this configuration option is defined, then the memory areas used for the RTEMS Workspace and the C Program Heap are zeroed with a ``0x00`` byte pattern during system initialization. -appl-config-option-index: +enabled-by: true +index-entries: - clear C Program Heap - clear RTEMS Workspace - zero C Program Heap - zero RTEMS Workspace -appl-config-option-name: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY -appl-config-option-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 case - :ref:`CONFIGURE_DIRTY_MEMORY` is also defined, then the memory is first - dirtied and then zeroed. -appl-config-option-type: feature-enable -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) -enabled-by: true interface-type: appl-config-option links: - role: appl-config-group-member uid: ../general +name: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY +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 case + :ref:`CONFIGURE_DIRTY_MEMORY` is also defined, then the memory is first + dirtied and then zeroed. text: '' type: interface diff --git a/spec/acfg/posix.yml b/spec/acfg/posix.yml index 595bc08b..7d32a569 100644 --- a/spec/acfg/posix.yml +++ b/spec/acfg/posix.yml @@ -1,16 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes configuration options related to the POSIX API. Most POSIX API objects are available by default since RTEMS 5.1. The queued signals and timers are only available if RTEMS was built with the ``--enable-posix`` build configuration option. -appl-config-group-name: POSIX API Configuration -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: POSIX API Configuration text: '' type: interface diff --git a/spec/acfg/posixinit.yml b/spec/acfg/posixinit.yml index b9350d84..b052f85e 100644 --- a/spec/acfg/posixinit.yml +++ b/spec/acfg/posixinit.yml @@ -1,14 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | - This section describes configuration options related to the POSIX - initialization thread. -appl-config-group-name: POSIX Initialization Thread Configuration copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | + This section describes configuration options related to the POSIX + initialization thread. enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: POSIX Initialization Thread Configuration text: '' type: interface diff --git a/spec/acfg/schedgeneral.yml b/spec/acfg/schedgeneral.yml index 30bee4b7..285ed449 100644 --- a/spec/acfg/schedgeneral.yml +++ b/spec/acfg/schedgeneral.yml @@ -1,5 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes configuration options related to selecting a scheduling algorithm for an application. A scheduler configuration is optional and only necessary in very specific circumstances. A normal application @@ -21,13 +23,11 @@ appl-config-group-description: | The pluggable scheduler interface also enables the user to provide their own scheduling algorithm. If you choose to do this, you must define multiple configuration option. -appl-config-group-name: General Scheduler Configuration -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: General Scheduler Configuration text: '' type: interface diff --git a/spec/acfg/stackalloc.yml b/spec/acfg/stackalloc.yml index 591d336c..ff457bad 100644 --- a/spec/acfg/stackalloc.yml +++ b/spec/acfg/stackalloc.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 -appl-config-group-description: | +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: | This section describes configuration options related to the task stack allocator. RTEMS allows the application or BSP to define its own allocation and deallocation methods for task stacks. This can be used to place task stacks in special areas of memory or to utilize a Memory Management Unit so that stack overflows are detected in hardware. -appl-config-group-name: Task Stack Allocator Configuration -copyrights: -- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) enabled-by: true interface-type: appl-config-group links: - role: requirement-refinement uid: ../applconfig +name: Task Stack Allocator Configuration text: '' type: interface |