diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-27 13:12:12 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-27 18:28:51 +0100 |
| commit | c4fc8bd46be06c2ad4aed10e2372a4a065412216 (patch) | |
| tree | 8c40ba3b82a80cf131558271af46600ec1fd5ba8 /spec/acfg | |
| parent | applconfig: Support integer options (diff) | |
| download | rtems-central-c4fc8bd46be06c2ad4aed10e2372a4a065412216.tar.bz2 | |
spec: Convert integer feature options
Diffstat (limited to 'spec/acfg')
58 files changed, 768 insertions, 545 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml index b5c27120..a23ef826 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml @@ -1,17 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 4096 bytes. +appl-config-option-type: integer +appl-config-option-default-value: 4096 appl-config-option-description: | - Defines the maximum size of a buffer in bytes. + 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: | None. -appl-config-option-range: | - It must be positive and an integral multiple of the buffer minimum size. +appl-config-option-constraint: + min: 0 + custom: + - It must be an integral multiple of :ref:`CONFIGURE_BDBUF_BUFFER_MIN_SIZE`. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml index 586af2d7..6231ff95 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 512 bytes. +appl-config-option-type: integer +appl-config-option-default-value: 512 appl-config-option-description: | - Defines the minimum size of a buffer in bytes. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml index 889c9786..3f11dd08 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 32768 bytes. +appl-config-option-type: integer +appl-config-option-default-value: 32768 appl-config-option-description: | - Size of the cache memory in bytes. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml index 00890aa5..2b639eda 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml @@ -1,19 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - Defines the maximum blocks per read-ahead request. + 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-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml index 2e3e5457..ee159e9a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 16. +appl-config-option-type: integer +appl-config-option-default-value: 16 appl-config-option-description: | - Defines the maximum blocks per write request. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml index 0c1980e0..cc6cb959 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml @@ -1,17 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Task priority (``rtems_task_priority``). -appl-config-option-default-value: | - The default value is 15. +appl-config-option-type: integer +appl-config-option-default-value: 15 appl-config-option-description: | - Defines the read-ahead task priority. -appl-config-option-index: [] -appl-config-option-name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY + The value of this configuration option defines the read-ahead task priority. appl-config-option-notes: | None. -appl-config-option-range: | - Valid task priority. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid task priority of the + configured scheduler. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml index fbcdf402..5f2afeae 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml @@ -1,17 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is RTEMS_MINIMUM_STACK_SIZE. +appl-config-option-type: integer +appl-config-option-default-value: '``RTEMS_MINIMUM_STACK_SIZE``' appl-config-option-description: | - Defines the task stack size of the Block Device Cache tasks in bytes. + 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: | None. -appl-config-option-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml index ae56e752..f8619991 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml @@ -1,22 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - This configuration parameter is set to the number of bytes the applications - wishes to add to the task stack requirements calculated by + 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 + stacks larger then the minimum, then that memory is **not** accounted for by ``<rtems/confdefs.h>``. -appl-config-option-range: | - Undefined or positive. +appl-config-option-constraint: + min: 0 + custom: + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml index 2f790246..c06bd2d3 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml @@ -1,18 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is RTEMS_MINIMUM_STACK_SIZE. +appl-config-option-type: integer +appl-config-option-default-value: '``RTEMS_MINIMUM_STACK_SIZE``' appl-config-option-description: | - ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the - IDLE task. + 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: | - None. -appl-config-option-range: | - Undefined or positive. + In SMP configurations, there is one idle task per configured processor, see + :ref:`CONFIGURE_MAXIMUM_PROCESSORS`. +appl-config-option-constraint: + min: 0 + custom: + - | + It must be small enough so that the idle task stack area calculation + carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``size_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml index 0fda442f..8ec1a472 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml @@ -1,18 +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: | - The default IMFS block size is 128 bytes. +appl-config-option-type: integer +appl-config-option-default-value: 128 appl-config-option-description: | - This configuration parameter specifies the block size for in-memory files - managed by the IMFS. 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 unused and the memory is wasted. In contrast, when - the block size is 16, the average unused memory per file is only 8 - bytes. However, it requires more allocations for the same size file and - thus more overhead per block for the dynamic memory management. + The value of this configuration option defines the block size for in-memory + files managed by the IMFS. +appl-config-option-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 + unused and the memory is wasted. In contrast, when the block size is 16, the + average unused memory per file is only 8 bytes. However, it requires more + allocations for the same size file and thus more overhead per block for the + dynamic memory management. Second, the block size has an impact on the maximum size file that can be stored in the IMFS. With smaller block size, the maximum file size is @@ -33,12 +33,14 @@ appl-config-option-description: | bytes. appl-config-option-index: [] appl-config-option-name: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK -appl-config-option-notes: | - None. -appl-config-option-range: | - Valid values for this configuration parameter are a power of two (2) - between 16 and 512 inclusive. In other words, valid values are 16, 32, 64, - 128, 256,and 512. +appl-config-option-constraint: + set: + - 16 + - 32 + - 64 + - 128 + - 256 + - 512 copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml index 26bcee73..ecab24e4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml @@ -1,18 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Task Argument (``rtems_task_argument``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single - initialization task defined by the Classic API Initialization Tasks Table. + 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: | None. appl-config-option-range: | Complete range of the type. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid integer of type + ``rtems_task_argument``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml index 877f17f0..249e78f6 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml @@ -1,18 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Attributes (``rtems_attribute``). -appl-config-option-default-value: | - The default value is ``RTEMS_DEFAULT_ATTRIBUTES``. +appl-config-option-type: integer +appl-config-option-default-value: '``RTEMS_DEFAULT_ATTRIBUTES``' appl-config-option-description: | - ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single - initialization task defined by the Classic API Initialization Tasks Table. + 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: | None. -appl-config-option-range: | - Valid task attribute sets. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid task attribute set. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml index fcced0cc..f3a43ba8 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml @@ -1,19 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Mode (``rtems_mode``). +appl-config-option-type: integer appl-config-option-default-value: | - The default value is ``RTEMS_NO_PREEMPT``. + In SMP configurations, the default value is ``RTEMS_DEFAULT_MODES``, + otherwise the default value is ``RTEMS_NO_PREEMPT``. appl-config-option-description: | - ``CONFIGURE_INIT_TASK_INITIAL_MODES`` is the initial execution mode of the - single initialization task defined by the Classic API Initialization Tasks - Table. + 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: | None. -appl-config-option-range: | - Valid task mode sets. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid task mode set. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml index 934b3f69..96edc68f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml @@ -1,18 +1,20 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Name (``rtems_name``). +appl-config-option-type: integer appl-config-option-default-value: | The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. appl-config-option-description: | - ``CONFIGURE_INIT_TASK_NAME`` is the name of the single initialization task - defined by the Classic API Initialization Tasks Table. + 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: | - None. -appl-config-option-range: | - Any value. + Use :c:func:`rtems_build_name` to define the task name. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid integer of type + ``rtems_name``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml index 76dccb40..e001a673 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml @@ -1,18 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Task Priority (``rtems_task_priority``). -appl-config-option-default-value: | - The default value is 1, which is the highest priority in the Classic API. +appl-config-option-type: integer +appl-config-option-default-value: 1 appl-config-option-description: | - ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single - initialization task defined by the Classic API Initialization Tasks Table. + 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: | None. -appl-config-option-range: | - One (1) to the maximum user priority value of the scheduler. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid task priority. The + set of valid task priorities is scheduler-specific. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml index 814ec502..4e06c887 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml @@ -1,21 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is RTEMS_MINIMUM_STACK_SIZE. +appl-config-option-type: integer +appl-config-option-default-value: ':ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`' appl-config-option-description: | - ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single - initialization task defined by the Classic API Initialization Tasks Table. + 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: | - If the stack size specified is greater than the configured minimum, it must - be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``. See :ref:`Reserve - Task/Thread Stack Memory Above Minimum` for more information about - ``CONFIGURE_EXTRA_TASK_STACKS``. -appl-config-option-range: | - Zero or positive. + None. +appl-config-option-constraint: + min: ':ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`' + custom: + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml index d0c6ed1d..d9ccfa4e 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml @@ -1,13 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer. +appl-config-option-type: integer appl-config-option-default-value: | - The default value is ``BSP_INTERRUPT_STACK_SIZE`` in case it is defined, + 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: | - The ``CONFIGURE_INTERRUPT_STACK_SIZE`` configuration option defines the - size of an interrupt stack in bytes. + The value of this configuration option defines the size of an interrupt stack + in bytes. appl-config-option-index: - interrupt stack size appl-config-option-name: CONFIGURE_INTERRUPT_STACK_SIZE @@ -16,10 +15,9 @@ appl-config-option-notes: | ``CPU_INTERRUPT_STACK_ALIGNMENT``. There is one interrupt stack available for each configured processor - (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`). The - interrupt stack areas are statically allocated in a special linker section - (``.rtemsstack.interrupt``). The placement of this linker section is - BSP-specific. + (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). The interrupt stack areas are + statically allocated in a special linker section (``.rtemsstack.interrupt``). + The placement of this linker section is BSP-specific. Some BSPs use the interrupt stack as the initialization stack which is used to perform the sequential system initialization before the multithreading @@ -30,10 +28,16 @@ appl-config-option-notes: | stack size may still result in undefined behaviour. In releases before RTEMS 5.1 the default value was - :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE - <CONFIGURE_MINIMUM_TASK_STACK_SIZE>` instead of ``CPU_STACK_MINIMUM_SIZE``. -appl-config-option-range: | - Positive. + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` instead of ``CPU_STACK_MINIMUM_SIZE``. +appl-config-option-constraint: + custom: + - | + The system does not ensure a minimum size. The minimum size is + BSP-specific and application-specific. + - | + It must be small enough so that the interrupt stack requirements + calculation carried out by ``<rtems/confdefs.h>`` does not overflow an + integer of type ``size_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml index 97f50620..a2f8083a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_BARRIERS`` is the maximum number of Classic API - Barriers that can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml index 10288faf..76702d14 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml @@ -2,23 +2,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true appl-config-option-data-type: | Unsigned integer (``uint32_t``). +appl-config-option-type: integer appl-config-option-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 parameters. + configuration options. appl-config-option-description: | - ``CONFIGURE_MAXIMUM_DRIVERS`` is defined as the number of device drivers - per node. + 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 must be larger than the number of statically configured device drivers. Drivers configured using the - ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration parameters are + ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` configuration options are statically installed. -appl-config-option-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml index a0849681..94b504e4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml @@ -1,22 +1,23 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - If ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`` is defined, then the - default value is 3, otherwise the default value is 0. Three file - descriptors allows RTEMS to support standard input, output, and error I/O - streams on ``/dev/console``. +appl-config-option-type: integer +appl-config-option-default-value: 3 appl-config-option-description: | - This configuration parameter is set to the maximum number of file like - objects that can be concurrently open. + 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: | - None. -appl-config-option-range: | - Zero or positive. + 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-constraint: + min: 0 + max: '``SIZE_MAX``' + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml index 3d0017d6..bce9b2c4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml @@ -1,20 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES`` is the maximum number of Classic API - Message Queues that can be concurrently active. + 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. 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-range: | - Zero or positive. + 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-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml index fd677cab..651bc49d 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_PARTITIONS`` is the maximum number of Classic API - Partitions that can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml index ba32f6cb..59b1c8d8 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_PERIODS`` is the maximum number of Classic API Periods - that can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml index 3997041e..e8033e7f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_PORTS`` is the maximum number of Classic API Ports that - can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml index 7a176446..e275fc66 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_KEYS`` is the maximum number of POSIX API Keys - that can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml index 81b41984..1ea9ad4a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml @@ -1,24 +1,34 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). +appl-config-option-type: integer appl-config-option-default-value: | The default value is - :ref:`CONFIGURE_MAXIMUM_POSIX_KEYS <CONFIGURE_MAXIMUM_POSIX_KEYS>` * - :ref:`CONFIGURE_MAXIMUM_TASKS <CONFIGURE_MAXIMUM_TASKS>` + - :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS <CONFIGURE_MAXIMUM_POSIX_THREADS>`. + :ref:`CONFIGURE_MAXIMUM_POSIX_KEYS` * + :ref:`CONFIGURE_MAXIMUM_TASKS` + + :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`. appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS`` is the maximum number of key + 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. + 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-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml index 092a8eaa..10c0652f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml @@ -1,20 +1,29 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES`` is the maximum number of POSIX + 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. 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-range: | - Zero or positive. + 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-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml index 298a73de..fafb8712 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml @@ -1,11 +1,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS`` is the maximum number of POSIX + 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 @@ -14,8 +12,13 @@ appl-config-option-notes: | Queued signals are only available if RTEMS was built with the ``--enable-posix`` build configuration option. -appl-config-option-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml index 37c440a5..464fe86f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml @@ -1,22 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_SEMAPHORES`` is the maximum number of POSIX API - Named Semaphores that can be concurrently active. + 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: | - This object class can be configured in unlimited allocation mode. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. - Named semaphores are created with ``sem_open()``. Semaphores initialized - with ``sem_init()`` are not affected by this configuration option since the - storage space for these semaphores is user-provided. -appl-config-option-range: | - Zero or positive. + 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-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml index 7944ba13..50076cda 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml @@ -1,31 +1,39 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_THREADS`` is the maximum number of POSIX API - Threads that can be concurrently active. + 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: | - This object class can be configured in unlimited allocation mode. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. This calculations for the required memory in the RTEMS Workspace for threads assume that each thread has a minimum stack size and has floating - point support enabled. The configuration parameter - ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify thread stack - requirements *ABOVE* the minimum size required. See :ref:`Reserve + point support enabled. The configuration option + :ref:`CONFIGURE_EXTRA_TASK_STACKS` is used to specify thread stack + requirements **above** the minimum size required. See :ref:`Reserve Task/Thread Stack Memory Above Minimum` for more information about ``CONFIGURE_EXTRA_TASK_STACKS``. The maximum number of Classic API Tasks is specified by - :ref:`CONFIGURE_MAXIMUM_TASKS <CONFIGURE_MAXIMUM_TASKS>`. + :ref:`CONFIGURE_MAXIMUM_TASKS`. All POSIX threads have floating point enabled. -appl-config-option-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml index d1c58599..aef189e4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml @@ -1,21 +1,30 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_POSIX_TIMERS`` is the maximum number of POSIX API - Timers that can be concurrently active. + 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. + 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-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml index db19fcb2..3e8d2728 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml @@ -1,13 +1,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint8_t``). -appl-config-option-default-value: | - The default value is 255, because RTEMS must support 256 priority levels to - be compliant with various standards. These priorities range from zero (0) - to 255. +appl-config-option-type: integer +appl-config-option-default-value: 255 appl-config-option-description: | - For the schedulers + For the following schedulers * :ref:`SchedulerPriority`, which is the default in uniprocessor configurations and can be configured through the @@ -31,8 +27,8 @@ appl-config-option-notes: | The numerically greatest priority is the logically lowest priority in the system and will thus be used by the IDLE task. - Priority zero (0) is reserved for internal use by RTEMS and is not available - to applications. + Priority zero is reserved for internal use by RTEMS and is not available to + applications. Reducing the number of priorities through this configuration option reduces the amount of memory allocated by the schedulers listed above. These @@ -41,10 +37,17 @@ appl-config-option-notes: | is 12 bytes * (``CONFIGURE_MAXIMUM_PRIORITY`` + 1), e.g. 3072 bytes for 256 priority levels (default), 48 bytes for 4 priority levels (``CONFIGURE_MAXIMUM_PRIORITY == 3``). -appl-config-option-range: | - Valid values for this configuration parameter must be one (1) less than - than a power of two (2) between 4 and 256 inclusively. In other words, - valid values are 3, 7, 31, 63, 127, and 255. + + The default value is 255, because RTEMS must support 256 priority levels to + be compliant with various standards. These priorities range from 0 to 255. +appl-config-option-constraint: + set: + - 3 + - 7 + - 31 + - 63 + - 127 + - 255 copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml index a81a40d1..2886f593 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml @@ -1,24 +1,22 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 1. +appl-config-option-type: integer +appl-config-option-default-value: 1 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_PROCESSORS`` must be set to the maximum number of + 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 thread and interrupt stack for - example. + 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 thread and interrupt stack for example. appl-config-option-index: [] appl-config-option-name: CONFIGURE_MAXIMUM_PROCESSORS appl-config-option-notes: | If there are more processors available than configured, the rest will be - ignored. This configuration define is ignored in uniprocessor - configurations. -appl-config-option-range: | - Positive. + ignored. In uniprocessor configuration, this configuration define is + ignored. +appl-config-option-constraint: + min: 0 + max: '``CPU_MAXIMUM_PROCESSORS``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml index 1aa013fe..0a744693 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_REGIONS`` is the maximum number of Classic API Regions - that can be concurrently active. + 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: | - None. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml index fa911bda..531453f1 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml @@ -1,22 +1,31 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_SEMAPHORES`` is the maximum number of Classic API - Semaphores that can be concurrently active. + 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: | - This object class can be configured in unlimited allocation mode. + 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-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml index 773e8732..448c5696 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml @@ -1,16 +1,15 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is ``0``. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_TASKS`` is the maximum number of Classic API Tasks that - can be concurrently active. + 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: | - This object class can be configured in unlimited allocation mode. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. The calculations for the required memory in the RTEMS Workspace for tasks assume that each task has a minimum stack size and has floating point @@ -21,14 +20,28 @@ appl-config-option-notes: | ``CONFIGURE_EXTRA_TASK_STACKS``. The maximum number of POSIX threads is specified by - :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS <CONFIGURE_MAXIMUM_POSIX_THREADS>`. + :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS`. A future enhancement to ``<rtems/confdefs.h>`` could be to eliminate the 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-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml index def36f2f..1249acd5 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml @@ -1,22 +1,28 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 16. This value was chosen for Linux compatibility, - see - `PTHREAD_SETNAME_NP(3) <http://man7.org/linux/man-pages/man3/pthread_setname_np.3.html>`_. +appl-config-option-type: integer +appl-config-option-default-value: 16 appl-config-option-description: | - This configuration parameter specifies the maximum thread name size - including the terminating `NUL` character. + The value of this configuration option defines the maximum thread name size + including the terminating ``NUL`` character. appl-config-option-index: - maximum thread name size appl-config-option-name: CONFIGURE_MAXIMUM_THREAD_NAME_SIZE appl-config-option-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>`_. + The size of the thread control block is increased by the maximum thread name - size. This configuration option is available since RTEMS 5.1. -appl-config-option-range: | - No restrictions. + size. + + This configuration option is available since RTEMS 5.1. +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml index 6798d6ee..0ef09705 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml @@ -1,18 +1,27 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_TIMERS`` is the maximum number of Classic API Timers - that can be concurrently active. + 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. -appl-config-option-range: | - Zero or positive. + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. + - | + The value may be defined through :c:func:`rtems_resource_unlimited` the + enable unlimited objects for this object class, if the value passed to + :c:func:`rtems_resource_unlimited` satisfies all other constraints of this + configuration option. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml index 57132f56..0dc20374 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml @@ -1,18 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - ``CONFIGURE_MAXIMUM_USER_EXTENSIONS`` is the maximum number of Classic API - User Extensions that can be concurrently active. + 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 can be configured in unlimited allocation mode. -appl-config-option-range: | - Zero or positive. + This object class cannot be configured in unlimited allocation mode. +appl-config-option-constraint: + min: 0 + max: 65535 + custom: + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml index c58dc02e..6783dc17 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml @@ -1,21 +1,26 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - This parameter is set to the number of kilobytes the application wishes to - add to the requirements calculated by ``<rtems/confdefs.h>``. + 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 parameter 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. -appl-config-option-range: | - Zero or positive. + 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-constraint: + min: 0 + custom: + - | + It must be small enough so that the RTEMS Workspace size calculation + carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml index bf401a63..596378e8 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml @@ -1,12 +1,10 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - integer summation macro -appl-config-option-default-value: | - The default value is zero. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - The value of this configuration option defines the number of bytes - resereved for message queue buffers in the RTEMS Workspace. + The value of this configuration option defines the number of bytes reserved + for message queue buffers in the RTEMS Workspace. appl-config-option-index: - configure message queue buffer memory - CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE @@ -58,6 +56,13 @@ appl-config-option-notes: | sizeof( other_message_type ) \ ) \ ) +appl-config-option-constraint: + min: 0 + custom: + - | + It must be small enough so that the RTEMS Workspace size calculation + carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. appl-config-option-range: | undefined (zero) or calculation resulting in a positive integer copyrights: diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml index afe85419..33cc1bdc 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml @@ -1,12 +1,10 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - This is not defined by default. When not defined, the clock tick quantum is - configured to be 10,000 microseconds which is ten (10) milliseconds. +appl-config-option-type: integer +appl-config-option-default-value: 10000 appl-config-option-description: | - This constant is used to specify the length of time between clock ticks. + The value of this configuration option defines the length of time in + microseconds between clock ticks (clock tick quantum). When the clock tick quantum value is too low, the system will spend so much time processing clock ticks that it does not have processing time available @@ -23,16 +21,20 @@ appl-config-option-description: | rounding errors will be introduced which may negatively impact the application. appl-config-option-index: +- clock tick quantum - tick quantum appl-config-option-name: CONFIGURE_MICROSECONDS_PER_TICK appl-config-option-notes: | - This configuration parameter has no impact if the Clock Tick Device driver - is not configured. + 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 BSP specific limits on the resolution or maximum value of a - clock tick quantum. -appl-config-option-range: | - Positive. + There may be Clock Driver specific limits on the resolution or maximum value + of a clock tick quantum. +appl-config-option-constraint: + custom: + - It must be greater than or equal to a Clock Driver specific value. + - It must be less than or equal to a Clock Driver specific value. + - The resulting clock ticks per second should be an integer. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml index 1e7c4359..7d174a94 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml @@ -1,20 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). +appl-config-option-type: integer appl-config-option-default-value: | The default value is two times the value of - :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE <CONFIGURE_MINIMUM_TASK_STACK_SIZE>`. + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. appl-config-option-description: | - This configuration parameter defines the minimum stack size in bytes for - every POSIX thread in the system. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + custom: + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml index 73ac9ac0..44f1a35b 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml @@ -1,19 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is architecture-specific. +appl-config-option-type: integer +appl-config-option-default-value: '``CPU_STACK_MINIMUM_SIZE``' appl-config-option-description: | - This configuration parameter defines the minimum stack size in bytes for - every user task or thread in the system. + 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: - minimum task stack size appl-config-option-name: CONFIGURE_MINIMUM_TASK_STACK_SIZE appl-config-option-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 <CONFIGURE_STACK_CHECKER_ENABLED>`). + (see also :ref:`CONFIGURE_STACK_CHECKER_ENABLED`). This parameter can be used to lower the minimum from that recommended. This can be used in low memory systems to reduce memory consumption for @@ -26,14 +24,20 @@ appl-config-option-notes: | By default, this configuration parameter defines also the minimum stack size of POSIX threads. This can be changed with the - :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE <CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE>` + :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE` configuration option. 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 - <CONFIGURE_INTERRUPT_STACK_SIZE>`. -appl-config-option-range: | - Positive. + used to define the default value of :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`. +appl-config-option-constraint: + custom: + - | + The system does not ensure a minimum size. The minimum size is + BSP-specific and application-specific. + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml index bbeca34f..c52b5ce3 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml @@ -1,19 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 32. +appl-config-option-type: integer +appl-config-option-default-value: 32 appl-config-option-description: | - ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS`` is the maximum number of + 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. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml index 6219f2ce..6ef75577 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml @@ -1,18 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 2. +appl-config-option-type: integer +appl-config-option-default-value: 2 appl-config-option-description: | - ``CONFIGURE_MP_MAXIMUM_NODES`` is the maximum number of nodes in a - multiprocessor system. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml index a1343426..134cda7e 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml @@ -1,12 +1,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 32. +appl-config-option-type: integer +appl-config-option-default-value: 32 appl-config-option-description: | - ``CONFIGURE_MP_MAXIMUM_PROXIES`` is the maximum number of concurrently - active thread/task proxies on this node in a multiprocessor system. + 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: | @@ -14,8 +13,9 @@ appl-config-option-notes: | on this node. This configuration parameter reflects the maximum number of remote tasks/threads which can be blocked on objects on this node, see :ref:`MPCIProxies`. -appl-config-option-range: | - Undefined or positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml index 36908a89..93dd2e38 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml @@ -1,13 +1,10 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is ``NODE_NUMBER``, which is assumed to be set by the - compilation environment. +appl-config-option-type: integer +appl-config-option-default-value: '``NODE_NUMBER``' appl-config-option-description: | - ``CONFIGURE_MP_NODE_NUMBER`` is the node number of this node in a - multiprocessor system. + 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: | @@ -15,8 +12,9 @@ appl-config-option-notes: | the Makefile variable ``NODE_NUMBER``. The same code is compiled with the ``NODE_NUMBER`` set to different values. The test programs behave differently based upon their node number. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml index 8593c62c..9a6ca421 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml @@ -1,22 +1,21 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE. +appl-config-option-type: integer +appl-config-option-default-value: ':ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE`' appl-config-option-description: | - ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE`` is the stack size of the single - initialization thread defined by the POSIX API Initialization Threads - Table. + The value of this configuration option defines the thread stack size of the + POSIX API initialization threads. appl-config-option-index: [] appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE appl-config-option-notes: | - If the stack size specified is greater than the configured minimum, it must - be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``. See :ref:`Reserve - Task/Thread Stack Memory Above Minimum` for more information about - ``CONFIGURE_EXTRA_TASK_STACKS``. -appl-config-option-range: | - Zero or positive. + None. +appl-config-option-constraint: + min: ':ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`' + custom: + - | + It must be small enough so that the task stack space calculation carried + out by ``<rtems/confdefs.h>`` does not overflow an integer of type + ``uintptr_t``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml index 60d5f00d..867ddead 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml @@ -1,19 +1,24 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``unsigned int``). -appl-config-option-default-value: | - This is not defined by default. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - If defined, then a record item buffer of the specified item count is - statically allocated for each configured processor - (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`). + 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: | - None. -appl-config-option-range: | - A power of two greater than or equal to 16. + 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-constraint: + min: 16 + max: '``SIZE_MAX``' + custom: + - It must be a power of two. + - | + It must be less than or equal to a BSP-specific value which depends on the + memory size of the platform available to the application. copyrights: - Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml index 4d335c60..2e72a75f 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml @@ -1,28 +1,41 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - RTEMS Name (``rtems_name``). +appl-config-option-type: integer appl-config-option-default-value: | - The default name is - - - ``"MEDF"`` for the :ref:`EDF SMP Scheduler <SchedulerSMPEDF>`, - - ``"MPA "`` for the :ref:`Arbitrary Processor Affinity Priority SMP Scheduler <SchedulerSMPPriorityAffinity>`, - - ``"MPD "`` for the :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>`, - - ``"MPS "`` for the :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>`, - - ``"UCBS"`` for the :ref:`Uniprocessor CBS Scheduler <SchedulerCBS>`, - - ``"UEDF"`` for the :ref:`Uniprocessor EDF Scheduler <SchedulerEDF>`, - - ``"UPD "`` for the :ref:`Uniprocessor Deterministic Priority Scheduler <SchedulerPriority>`, and - - ``"UPS "`` for the :ref:`Uniprocessor Simple Priority Scheduler <SchedulerPrioritySimple>`. + The default value is + + * ``"MEDF"`` for the :ref:`EDF SMP Scheduler <SchedulerSMPEDF>`, + + * ``"MPA "`` for the :ref:`Arbitrary Processor Affinity Priority SMP Scheduler <SchedulerSMPPriorityAffinity>`, + + * ``"MPD "`` for the :ref:`Deterministic Priority SMP Scheduler <SchedulerSMPPriority>`, + + * ``"MPS "`` for the :ref:`Simple Priority SMP Scheduler <SchedulerSMPPrioritySimple>`, + + * ``"UCBS"`` for the :ref:`Uniprocessor CBS Scheduler <SchedulerCBS>`, + + * ``"UEDF"`` for the :ref:`Uniprocessor EDF Scheduler <SchedulerEDF>`, + + * ``"UPD "`` for the :ref:`Uniprocessor Deterministic Priority Scheduler <SchedulerPriority>`, and + + * ``"UPS "`` for the :ref:`Uniprocessor Simple Priority Scheduler <SchedulerPrioritySimple>`. appl-config-option-description: | - Schedulers can be identified via ``rtems_scheduler_ident``. The name of - the scheduler is determined by the configuration. + 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: | This scheduler configuration option is an advanced configuration option. Think twice before you use it. -appl-config-option-range: | - Any value. + + Schedulers can be identified via c:func:`rtems_scheduler_ident`. + + Use :c:func:`rtems_build_name` to define the scheduler name. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid integer of type + ``rtems_name``. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml index 4338793d..bda539ba 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 1000 milliseconds. +appl-config-option-type: integer +appl-config-option-default-value: 1000 appl-config-option-description: | - Defines the swapout task maximum block hold time in milliseconds. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml index 62876325..543746fb 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml @@ -1,17 +1,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 250 milliseconds. +appl-config-option-type: integer +appl-config-option-default-value: 250 appl-config-option-description: | - Defines the swapout task swap period in milliseconds. + 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: | None. -appl-config-option-range: | - Positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml index 1209becf..485f284c 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml @@ -1,17 +1,18 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Task priority (``rtems_task_priority``). -appl-config-option-default-value: | - The default value is 15. +appl-config-option-type: integer +appl-config-option-default-value: 15 appl-config-option-description: | - Defines the swapout task priority. + 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: | None. -appl-config-option-range: | - Valid task priority. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid Classic API task + priority. The set of valid task priorities is scheduler-specific. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml index 5ca49571..e643125e 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml @@ -1,17 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Task priority (``rtems_task_priority``). -appl-config-option-default-value: | - The default value is 15. +appl-config-option-type: integer +appl-config-option-default-value: 15 appl-config-option-description: | - Defines the swapout worker task priority. + 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: | None. -appl-config-option-range: | - Valid task priority. +appl-config-option-constraint: + custom: + - | + The value of this configuration option must be a valid Classic API task + priority. The set of valid task priorities is scheduler-specific. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml index cde5879f..40003673 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml @@ -1,17 +1,16 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``size_t``). -appl-config-option-default-value: | - The default value is 0. +appl-config-option-type: integer +appl-config-option-default-value: 0 appl-config-option-description: | - Defines the swapout worker task count. + 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: | None. -appl-config-option-range: | - Zero or positive. +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml index a89d7f4a..c185de6a 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml @@ -1,20 +1,19 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - The default value is 50. +appl-config-option-type: integer +appl-config-option-default-value: 50 appl-config-option-description: | - This configuration parameter specifies the length of the timeslice quantum - in ticks for each task. + 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 parameter has no impact if the Clock Tick Device driver - is not configured. -appl-config-option-range: | - Positive. + 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-constraint: + min: 0 + max: '``UINT32_MAX``' copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml index 8404a23a..9201e4e4 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml @@ -1,24 +1,25 @@ SPDX-License-Identifier: CC-BY-SA-4.0 active: true -appl-config-option-data-type: | - Unsigned integer (``uint32_t``). -appl-config-option-default-value: | - If not defined and ``CONFIGURE_UNLIMITED_OBJECTS`` is defined, the default - value is eight (8). +appl-config-option-type: integer +appl-config-option-default-value: 8 appl-config-option-description: | - ``CONFIGURE_UNLIMITED_ALLOCATION_SIZE`` provides an allocation size to use - for ``rtems_resource_unlimited`` when using - ``CONFIGURE_UNLIMITED_OBJECTS``. + 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. ``CONFIGURE_UNLIMITED_OBJECTS`` does not support varying the - allocation sizes for different objects; users who want that much control - can define the ``rtems_resource_unlimited`` macros themselves. -appl-config-option-range: | - Positive. + 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-constraint: + custom: + - | + The value of this configuration option must meet the constraints of all + object classes to which it is applied. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false |