diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-18 14:45:19 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-19 09:04:34 +0100 |
| commit | a0e78f0e0fac19ed6361e91bac32a0a6b30b3d28 (patch) | |
| tree | ca30798781a82aa873f2e325c4209c070445e02f /spec/acfg | |
| parent | applconfig: Support new boolean feature template (diff) | |
| download | rtems-central-a0e78f0e0fac19ed6361e91bac32a0a6b30b3d28.tar.bz2 | |
spec: Convert boolean feature options
Diffstat (limited to 'spec/acfg')
50 files changed, 496 insertions, 518 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml index 193e3eec..87c9b02d 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml @@ -1,20 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. If no other root file system configuration - parameters are specified, the IMFS will be used as the root file system. +appl-config-option-name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the filesystems are + initialized during system initialization. appl-config-option-description: | - This configuration parameter is defined if the application dose not intend - to use any kind of filesystem support. This include the device - infrastructure necessary to support ``printf()``. + In case this configuration option is defined, then the filesystems are + **not** initialized during system initialization. appl-config-option-index: [] -appl-config-option-name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM appl-config-option-notes: | - None. -appl-config-option-range: | - Defined or undefined. + Filesystems must 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. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml index a10a7488..a8e962f7 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml @@ -1,22 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then a clock driver may be + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is defined when the - application does *NOT* want the Clock Device Driver and is *NOT* using the - Timer Driver. The inclusion or exclusion of the Clock Driver must be - explicit in user applications. + 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: | 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. -appl-config-option-range: | - Defined or undefined. + + The application must define exactly one of the following configuration options + + * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, + + * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or + + * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, + + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml index d1c29db3..0386ebab 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml @@ -1,24 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Clock Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`` is defined if the application - wishes to include the Clock Device Driver. + 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: | - This device driver is responsible for providing a regular interrupt which - invokes a clock tick directive. + The Clock Driver is responsible for providing a regular interrupt + which invokes a clock tick directive. - If neither the Clock Driver not Benchmark Timer is enabled and the - configuration parameter - ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a - compile time error will occur. -appl-config-option-range: | - Defined or undefined. + The application must define exactly one of the following configuration options + + * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, + + * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or + + * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, + + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml index 427f8d6b..53343c95 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml @@ -1,33 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Console Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`` is defined if the - application wishes to include the Console Device Driver. + 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: | - This device driver is responsible for providing the :file:`/dev/console` + 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. - BSPs should be constructed in a manner that allows ``printk()`` to work - properly without the need for the console driver to be configured. + BSPs should be constructed in a manner that allows :c:func:`printk` to work + properly without the need for the Console Driver to be configured. The - * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`, - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml index 459b4fb7..12d32885 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml @@ -1,22 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Frame Buffer Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`` is defined if the - application wishes to include the BSP's Frame Buffer Device Driver. + 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 Device Driver. This is + Most BSPs do not include support for a Frame Buffer 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-range: | - Defined or undefined. + 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. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml index 8e345cad..14fb7cb2 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml @@ -1,19 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the Block Device Cache is not + initialized during system initialization. appl-config-option-description: | - Provides a Block Device Cache configuration. + 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 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 file systems. -appl-config-option-range: | - Defined or undefined. + 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. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml index c2dbd8b1..d56f15b5 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml @@ -1,18 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no :file:`/dev/null` Driver + is initialized during system initialization. appl-config-option-description: | - This configuration variable is specified to enable ``/dev/null`` device driver. + 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml index c01f14fc..638a0d36 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml @@ -1,22 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Real-Time Clock Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`` is defined if the application - wishes to include the Real-Time Clock Driver. + 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. This is because + 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml index 7466ae8a..78d03ac9 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml @@ -1,12 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Simple Console Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`` is defined if the - application wishes to include the Simple Console Device Driver. + 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: | @@ -14,24 +14,22 @@ appl-config-option-notes: | device file. This device is used to initialize the standard input, output, and error file descriptors. - This device driver reads via ``getchark()``. + This device driver reads via :c:func:`getchark`. - This device driver writes via ``rtems_putc()``. + This device driver writes via :c:func:`rtems_putc`. The Termios framework is not used. There is no support to change device settings, e.g. baud, stop bits, parity, etc. The - * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`, - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml index 8cbc8684..8f0fa82a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml @@ -1,12 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Simple Task Console Driver + is initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` is defined if - the application wishes to include the Simple Task Console Device Driver. + 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: | @@ -14,15 +14,15 @@ appl-config-option-notes: | device file. This device is used to initialize the standard input, output, and error file descriptors. - This device driver reads via ``getchark()``. + This device driver reads via :c:func:`getchark`. This device driver writes into a write buffer. The count of characters written into the write buffer is returned. It might be less than the requested count, in case the write buffer is full. The write is non-blocking and may be called from interrupt context. A dedicated task reads from the write buffer and outputs the characters via - ``rtems_putc()``. This task runs with the least important priority. The - write buffer size is 2047 characters and it is not configurable. + :c:func:`rtems_putc`. This task runs with the least important priority. + The write buffer size is 2047 characters and it is not configurable. Use ``fsync(STDOUT_FILENO)`` or ``fdatasync(STDOUT_FILENO)`` to drain the write buffer. @@ -32,15 +32,13 @@ appl-config-option-notes: | The - * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`, - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and - * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER` configuration options are mutually exclusive. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml index c98ad32b..8d3d3feb 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml @@ -1,19 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Stub Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`` is defined if the application - wishes to include the Stub Device Driver. + 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml index f854be80..bbc2940f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml @@ -1,22 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Benchmark Timer Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`` is defined if the application - wishes to include the Timer Driver. This device driver is used to - benchmark execution times by the RTEMS Timing Test Suites. + 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: | - If neither the Clock Driver not Benchmark Timer is enabled and the - configuration parameter - ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a - compile time error will occur. -appl-config-option-range: | - Defined or undefined. + The Benchmark Timer Driver is intended for the benchmark tests of the RTEMS + Testsuite. Applications should not use this driver. + + The application must define exactly one of the following configuration options + + * :ref:`CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`, + + * :ref:`CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`, or + + * :ref:`CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`, + + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml index 81a8fd12..eb1ca3c4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml @@ -1,12 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Watchdog Driver is + initialized during system initialization. appl-config-option-description: | - ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`` is defined if the - application wishes to include the Watchdog Driver. + 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: | @@ -15,8 +15,6 @@ appl-config-option-notes: | 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml index 184f6dc4..f60e8db7 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml @@ -1,18 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no :file:`/dev/zero` Driver + is initialized during system initialization. appl-config-option-description: | - This configuration variable is specified to enable ``/dev/zero`` device driver. + 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml index 4d429181..58a16396 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml @@ -1,25 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - By default, the memory used by the RTEMS Workspace and the C Program Heap - is uninitialized memory. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the memory areas used for the + RTEMS Workspace and the C Program Heap are not dirtied. appl-config-option-description: | - This macro indicates whether RTEMS should dirty the memory used by the - RTEMS Workspace and the C Program Heap as part of its initialization. If - defined, the memory areas are dirtied with a ``0xCF`` byte pattern. - Otherwise, they are not. + 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: | - Dirtying memory can add significantly to system boot 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 + 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 :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the memory is first dirtied and then zeroed. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml index b1ea44e4..aecd8535 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml @@ -1,26 +1,37 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default, the user is assumed to provide one or more - initialization tasks. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the user is assumed to + provide one or more initialization tasks. appl-config-option-description: | - ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`` is set 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. + 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: | - If you use this option be careful, the user IDLE task *CANNOT* block at all + 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 must make itself preemptible and enter an - IDLE body loop. + initialization is complete, it must make itself preemptible and enter an idle + body loop. - The IDLE task must run at the lowest priority of all tasks in the system. -appl-config-option-range: | - Defined or undefined. + The idle task must run at the lowest priority of all tasks in the system. + + Configure a user idle task with the :ref:`CONFIGURE_IDLE_TASK_BODY` + configuration option. + + The application must define exactly one of the following configuration + options + + * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`, + + * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or + + * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` + + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml index d212c632..3deaa274 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + changing the mode of a file. appl-config-option-description: | - In case this configuration option is defined, then the support to change - the mode is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml index 070432f0..f6c83561 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + changing the ownership of files. appl-config-option-description: | - In case this configuration option is defined, then the support to change - the owner is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml index 01d87e86..71ace56d 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports hard + links. appl-config-option-description: | - In case this configuration option is defined, then the support to create - hard links is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml index 197fe696..97386ce6 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports making + files. appl-config-option-description: | - In case this configuration option is defined, then the support to make - directories, devices, regular files and FIFOs is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml index 3bae9054..9a05ac20 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports making + regular files. appl-config-option-description: | - In case this configuration option is defined, then the support to make - regular files is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml index 8ca63e6e..d6c558e3 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + mounting other filesystems. appl-config-option-description: | - In case this configuration option is defined, then the support to mount - other file systems is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml index 6adaf700..2e8ca833 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml @@ -1,19 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + reading directories. appl-config-option-description: | - In case this configuration option is defined, then the support to read a - directory is disabled in the root IMFS. It is still possible to open nodes - in a directory. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml index 94c99be2..c7dd6b90 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + reading symbolic links. appl-config-option-description: | - In case this configuration option is defined, then the support to read - symbolic links is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml index 955adf77..8320907a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + renaming files. appl-config-option-description: | - In case this configuration option is defined, then the support to rename - nodes is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml index 7917e19d..9fbc0fe1 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + removing files. appl-config-option-description: | - In case this configuration option is defined, then the support to remove - nodes is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml index b39b6b27..9ad09b7a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + creating symbolic links. appl-config-option-description: | - In case this configuration option is defined, then the support to create - symbolic links is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml index 5c78c34d..e447f946 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + unmounting other filesystems. appl-config-option-description: | - In case this configuration option is defined, then the support to unmount - file systems is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml index 55bd492f..253418c8 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports + changing file times. appl-config-option-description: | - In case this configuration option is defined, then the support to change - times is disabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml index 36805b09..84e1c667 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml @@ -1,18 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-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: | - In case this configuration option is defined, then the support to make FIFOs - is enabled in the root IMFS. + 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: | None. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml index c554d6cc..b3470141 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml @@ -1,21 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the multiprocessing services + are not initialized. appl-config-option-description: | - This configuration parameter must be defined to indicate that the - application intends to be part of a multiprocessing - configuration. Additional configuration parameters are assumed to be - provided. + This configuration option is defined to indicate that the application intends + to be part of a multiprocessing configuration. Additional configuration + parameters are assumed to be provided. appl-config-option-index: [] appl-config-option-name: CONFIGURE_MP_APPLICATION appl-config-option-notes: | This has no impact unless RTEMS was built with the ``--enable-multiprocessing`` build configuration option. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml index d4e4e6b9..19fce73e 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml @@ -1,29 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This field is not defined by default, as the user MUST select their own API - for initialization tasks. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no POSIX initialization + thread is configured. appl-config-option-description: | - ``CONFIGURE_POSIX_INIT_THREAD_TABLE`` is defined if the user wishes to use - a POSIX API Initialization Threads Table. The table built by - ``<rtems/confdefs.h>`` specifies the parameters for a single thread. This - is sufficient for applications which initialization the system from a - single task. - - By default, this field is not defined as the user MUST select their own API - for initialization tasks. + In case this configuration option is defined, then a POSIX initialization + thread is configured. appl-config-option-index: [] appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_TABLE appl-config-option-notes: | - The application may choose to use the initialization tasks or threads table - from another API. + The application must define exactly one of the following configuration + options + + * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`, + + * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or + + * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` - A compile time error will be generated if the user does not configure any - initialization tasks or threads. -appl-config-option-range: | - Defined or undefined. + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml index 502bbda2..ea481e8c 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml @@ -1,20 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the event record extensions + are not enabled. appl-config-option-description: | - If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS - <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the - record extensions are enabled. + In case + + * this configuration option is defined + + * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is also 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-range: | - Defined or undefined. + The record extensions capture thread create, start, restart, delete, switch, + begin, exitted and terminate events. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml index b147f579..19deb718 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml @@ -1,28 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no Classic API initialization + task is configured. appl-config-option-description: | - ``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` is defined if the user wishes to use a - Classic RTEMS API Initialization Task Table. The table built by - ``<rtems/confdefs.h>`` specifies the parameters for a single task. This is - sufficient for applications which initialization the system from a single - task. - - By default, this field is not defined as the user MUST select their own API - for initialization tasks. + In case this configuration option is defined, then a Classic API + initialization task is configured. appl-config-option-index: [] appl-config-option-name: CONFIGURE_RTEMS_INIT_TASKS_TABLE appl-config-option-notes: | - The application may choose to use the initialization tasks or threads table - from another API. + The application must define exactly one of the following configuration + options + + * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`, + + * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or + + * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` - A compile time error will be generated if the user does not configure any - initialization tasks or threads. -appl-config-option-range: | - Defined or undefined. + otherwise a compile time error will occur. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml index ac7d8d11..99ca1035 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Constant Bandwidth Server (CBS) Scheduler <SchedulerCBS>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Constant Bandwidth Server (CBS) Scheduler - <SchedulerCBS>` algorithm is made available to the application. + 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: | @@ -16,8 +18,6 @@ appl-config-option-notes: | 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml index 03f543d1..f0a03a14 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Earliest Deadline First (EDF) Scheduler <SchedulerEDF>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Earliest Deadline First (EDF) Scheduler - <SchedulerEDF>` algorithm is made available to the application. + 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: | @@ -16,8 +18,6 @@ appl-config-option-notes: | 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml index 42a88858..44323ffa 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Earliest Deadline First (EDF) SMP Scheduler <SchedulerSMPEDF>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler - <SchedulerSMPEDF>` algorithm is made available to the application. + 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: | @@ -21,10 +23,8 @@ appl-config-option-notes: | scheduler for up to 32 processors. This scheduler algorithm is the default in SMP configurations if - :ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>` is + :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is greater than one. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml index c5dad3ce..580fd741 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml @@ -1,13 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is defined by default. This is the default scheduler and specifying - this configuration parameter is redundant. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Deterministic Priority Scheduler <SchedulerPriority>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Deterministic Priority Scheduler - <SchedulerPriority>` algorithm is made available to the application. + 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: | @@ -19,13 +20,11 @@ appl-config-option-notes: | scheduler for exactly one processor. This scheduler algorithm is the default when - :ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>` is + :ref:`CONFIGURE_MAXIMUM_PROCESSORS` is exactly one. The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 2010 Gedare Bloom - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml index 4a60069d..ebaac96d 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml @@ -1,13 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Arbitrary Processor Affinity SMP Scheduler <SchedulerSMPPriorityAffinity>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Arbitrary Processor Affinity SMP Scheduler - <SchedulerSMPPriorityAffinity>` algorithm is made available to the - application. + 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: | @@ -23,8 +24,6 @@ appl-config-option-notes: | The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml index 5c5b4cf8..8d65f1d5 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Deterministic Priority SMP Scheduler - <SchedulerSMPPriority>` algorithm is made available to the application. + 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: | @@ -22,8 +24,6 @@ appl-config-option-notes: | The memory allocated for this scheduler depends on the :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. -appl-config-option-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml index ff9d5147..123566bd 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Simple Priority Scheduler <SchedulerPrioritySimple>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Simple Priority Scheduler - <SchedulerPrioritySimple>` algorithm is made available to the application. + 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: | @@ -16,8 +18,6 @@ appl-config-option-notes: | 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml index 1bddfdfd..684a6451 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml @@ -1,12 +1,14 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the + :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>` + algorithm is not available to the application. appl-config-option-description: | - If defined, then the :ref:`Simple Priority SMP Scheduler - <SchedulerSMPPrioritySimple>` algorithm is made available to the + 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 @@ -20,8 +22,6 @@ 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml index f4af6697..a19d7409 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml @@ -1,10 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no user provided scheduler + algorithm is available to the application. appl-config-option-description: | + In case this configuration option is defined, then the user must provide a + scheduler algorithm to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_USER +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + RTEMS allows the application to provide its own task/thread scheduling algorithm. In order to do this, one must define ``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own @@ -19,11 +27,6 @@ appl-config-option-description: | - ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` must be defined to the type of the per-thread information of the user scheduler. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_SCHEDULER_USER -appl-config-option-notes: | - This scheduler configuration option is an advanced configuration option. - Think twice before you use it. At this time, the mechanics and requirements for writing a new scheduler are evolving and not fully documented. It is recommended that you look at @@ -31,8 +34,6 @@ 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-range: | - Defined or undefined. copyrights: - Copyright (C) 2010 Gedare Bloom - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml index 3c8aa992..558d10f5 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml @@ -1,21 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default, and thus stack checking is disabled. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the stack checker is + disabled. appl-config-option-description: | - This configuration parameter is defined when the application wishes to - enable run-time stack bounds checking. + 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: | - In 4.9 and older, this configuration parameter was named ``STACK_CHECKER_ON``. + 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. - This increases the time required to create tasks as well as adding overhead - to each context switch. -appl-config-option-range: | - Defined or undefined. + In 4.9 and older, this configuration option was named ``STACK_CHECKER_ON``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml index 897033a0..21bba443 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml @@ -1,16 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default, which specifies that the C Program Heap and - the RTEMS Workspace will be separate. +appl-config-option-type: feature +appl-config-option-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: | - When defined, the C Program Heap and the RTEMS Workspace will be one pool - of memory. - - When not defined, there will be separate memory pools for the RTEMS - Workspace and C Program Heap. + 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: - unified work areas - separate work areas @@ -24,11 +20,9 @@ appl-config-option-notes: | pool is very undesirable. In high memory environments, this is desirable when you want to use the - RTEMS "unlimited" objects 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-range: | - Defined or undefined. + :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. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml index bbffda71..ea02afe2 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml @@ -1,21 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then no unlimited objects are used + by default. appl-config-option-description: | - ``CONFIGURE_UNLIMITED_OBJECTS`` enables ``rtems_resource_unlimited`` mode - for Classic API and POSIX API objects that do not already have a specific - maximum limit defined. + 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: | When using unlimited objects, it is common practice to also specify - ``CONFIGURE_UNIFIED_WORK_AREAS`` so the system operates with a single pool - of memory for both RTEMS and application memory allocations. -appl-config-option-range: | - Defined or undefined. + :ref:`CONFIGURE_UNIFIED_WORK_AREAS` so the system operates with a single pool + of memory for both RTEMS Workspace and C Program Heap. + + This option does not override an explicit configuration for a particular + object class by the user. + + See also :ref:`CONFIGURE_UNLIMITED_ALLOCATION_SIZE`. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml index 5ae11762..5590a644 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml @@ -1,23 +1,48 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. If no other root file system configuration - parameters are specified, the IMFS will be used as the root file system. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS has the full + feature set by default. appl-config-option-description: | - This configuration parameter is defined if the application wishes to use - the device-only filesytem as the root file system. + 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: | - The device-only filesystem supports only device nodes and is smaller in - executable code size than the full IMFS and miniIMFS. + In case this configuration option is defined, then the following + configuration options will be defined as well - The devFS is comparable in functionality to the pseudo-filesystem name - space provided before RTEMS release 4.5.0. -appl-config-option-range: | - Defined or undefined. + - :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`, + + - :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`, + + - :ref:`CONFIGURE_IMFS_DISABLE_LINK`, + + - :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE`, + + - :ref:`CONFIGURE_IMFS_DISABLE_MOUNT`, + + - :ref:`CONFIGURE_IMFS_DISABLE_READDIR`, + + - :ref:`CONFIGURE_IMFS_DISABLE_READLINK`, + + - :ref:`CONFIGURE_IMFS_DISABLE_RENAME`, + + - :ref:`CONFIGURE_IMFS_DISABLE_RMNOD`, + + - :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`, + + - :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and + + - :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`. + + In addition, a simplified path evaluation is enabled. It allows only a look + up of absolute paths. + + 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. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml index ce1af24c..23a305dd 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml @@ -1,34 +1,33 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS has the full + feature set by default. appl-config-option-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: | In case this configuration option is defined, then the following configuration options will be defined as well - - ``CONFIGURE_IMFS_DISABLE_CHMOD``, + - :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`, - - ``CONFIGURE_IMFS_DISABLE_CHOWN``, + - :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`, - - ``CONFIGURE_IMFS_DISABLE_UTIME``, + - :ref:`CONFIGURE_IMFS_DISABLE_LINK`, - - ``CONFIGURE_IMFS_DISABLE_LINK``, + - :ref:`CONFIGURE_IMFS_DISABLE_READLINK`, - - ``CONFIGURE_IMFS_DISABLE_SYMLINK``, + - :ref:`CONFIGURE_IMFS_DISABLE_RENAME`, - - ``CONFIGURE_IMFS_DISABLE_READLINK``, + - :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK`, - - ``CONFIGURE_IMFS_DISABLE_RENAME``, and + - :ref:`CONFIGURE_IMFS_DISABLE_UTIME`, and - - ``CONFIGURE_IMFS_DISABLE_UNMOUNT``. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM -appl-config-option-notes: | - None. -appl-config-option-range: | - Defined or undefined. + - :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT`. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml index c2ebcbb1..b15cc711 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml @@ -1,20 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default, and thus the system initialization is +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the system initialization is quiet. appl-config-option-description: | - This configuration option enables to print some information during system - initialization. + 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 - printk() function is used to print the information. -appl-config-option-range: | - Defined or undefined. + :c:func:`printk` function is used to print the information. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml index 4b26f917..7600c0e1 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml @@ -1,14 +1,13 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Boolean feature macro. -appl-config-option-default-value: | - This is not defined by default. The default is *NOT* to zero out the RTEMS - Workspace or C Program Heap. +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the memory areas used for the + RTEMS Workspace and the C Program Heap are not zeroed. appl-config-option-description: | - This macro indicates whether RTEMS should zero the RTEMS Workspace and C - Program Heap as part of its initialization. If defined, the memory regions - are zeroed. Otherwise, they are not. + 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 ``0x0` byte + pattern during system initialization. appl-config-option-index: - clear C Program Heap - clear RTEMS Workspace @@ -16,12 +15,10 @@ appl-config-option-index: - zero RTEMS Workspace appl-config-option-name: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY appl-config-option-notes: | - Zeroing memory can add significantly to system boot time. It is not - necessary for RTEMS but is often assumed by support libraries. In case + 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-range: | - Defined or undefined. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false |