diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-31 16:40:49 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-31 16:48:50 +0200 |
commit | b4b639fe8abc7ad1b94edd3d0424085a5fdd5fac (patch) | |
tree | b82a2989fdf4b8546da88804c13e3dcd1108e84c /spec/acfg | |
parent | spec: New option template (diff) | |
download | rtems-central-b4b639fe8abc7ad1b94edd3d0424085a5fdd5fac.tar.bz2 |
spec: Add undocumented configuration options
Diffstat (limited to 'spec/acfg')
23 files changed, 650 insertions, 0 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSATADRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSATADRIVER.yml new file mode 100644 index 00000000..2b21f367 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSATADRIVER.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the ATA Driver is + initialized during system initialization. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER +appl-config-option-notes: | + Most BSPs do not include support for an ATA Driver. + + If this option is defined and the BSP does not have this device driver, then + the user will get a link time error for an undefined symbol. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.139 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSIDEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSIDEDRIVER.yml new file mode 100644 index 00000000..425c1792 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSIDEDRIVER.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the IDE Driver is + initialized during system initialization. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_IDE_DRIVER +appl-config-option-notes: | + Most BSPs do not include support for an IDE Driver. + + If this option is defined and the BSP does not have this device driver, then + the user will get a link time error for an undefined symbol. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.140' +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-ATADRIVERTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-ATADRIVERTASKPRIORITY.yml new file mode 100644 index 00000000..f21cc580 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-ATADRIVERTASKPRIORITY.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: integer +appl-config-option-default-value: 140 +appl-config-option-index: [] +appl-config-option-description: | + The value of this configuration option defines the ATA task priority. +appl-config-option-name: CONFIGURE_ATA_DRIVER_TASK_PRIORITY +appl-config-option-notes: | + This configuration option is only evaluated if the configuration option + :ref:`CONFIGURE_APPLICATION_NEEDS_ATA_DRIVER` is defined. +appl-config-option-constraint: + custom: + - | + The value of this configuration option shall be a valid Classic API task + priority. The set of valid task priorities is scheduler-specific. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.141 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-CBSMAXIMUMSERVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-CBSMAXIMUMSERVERS.yml new file mode 100644 index 00000000..6899a055 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-CBSMAXIMUMSERVERS.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-default-value: ':ref:`CONFIGURE_MAXIMUM_TASKS`' +appl-config-option-description: | + The value of this configuration option defines the maximum number Constant + Bandwidth Servers that can be concurrently active. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_CBS_MAXIMUM_SERVERS +appl-config-option-notes: | + This configuration option is only evaluated if the configuration option + :ref:`CONFIGURE_SCHEDULER_CBS` is defined. +appl-config-option-type: integer +appl-config-option-constraint: + min: 0 + max: '``SIZE_MAX``' + links: + - RTEMS-ACFG-OPT-CONSTRAINTMEMSZ +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.142 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml index 53b87705..192bb2b6 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml @@ -13,6 +13,8 @@ appl-config-option-notes: | areas is cleared to zero during system initialization. In case :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the memory is first dirtied and then zeroed. + + See also :ref:`CONFIGURE_MALLOC_DIRTY`. copyrights: - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) derived: false diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLENEWLIBREENTRANCY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLENEWLIBREENTRANCY.yml new file mode 100644 index 00000000..755cd8d3 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLENEWLIBREENTRANCY.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the Newlib reentrancy + support per thread is disabled and a global reentrancy structure is used. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_DISABLE_NEWLIB_REENTRANCY +appl-config-option-notes: | + You can enable this option to reduce the size of the :term:`TCB`. Use this + option with care, since it can lead to race conditions and undefined system + behaviour. For example, :c:data:`errno` is no longer a thread-local variable + if this option is enabled. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.143 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-EXECUTIVERAMSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-EXECUTIVERAMSIZE.yml new file mode 100644 index 00000000..b4e6742a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-EXECUTIVERAMSIZE.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-default-value: | + If this configuration option is undefined, then the RTEMS Workspace and task + stack space size is calculated by ``<rtems/confdefs.h>`` based on the values + configuration options. +appl-config-option-description: | + The value of this configuration option defines the RTEMS Workspace size in + bytes. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_EXECUTIVE_RAM_SIZE +appl-config-option-notes: | + This is an advanced configuration option. Use it only if you know exactly + what you are doing. +appl-config-option-type: integer +appl-config-option-constraint: + min: 0 + max: '``UINTPTR_MAX``' + links: + - RTEMS-ACFG-OPT-CONSTRAINTMEMSZ +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.144 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMALL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMALL.yml new file mode 100644 index 00000000..6085a60d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMALL.yml @@ -0,0 +1,38 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the following + configuration options will be defined as well + + - :ref:`CONFIGURE_FILESYSTEM_DOSFS`, + + - :ref:`CONFIGURE_FILESYSTEM_FTPFS`, + + - :ref:`CONFIGURE_FILESYSTEM_IMFS`, + + - :ref:`CONFIGURE_FILESYSTEM_JFFS2`, + + - :ref:`CONFIGURE_FILESYSTEM_NFS`, + + - :ref:`CONFIGURE_FILESYSTEM_RFS`, and + + - :ref:`CONFIGURE_FILESYSTEM_TFTPFS`. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_ALL +appl-config-option-notes: | + None. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.146 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMDOSFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMDOSFS.yml new file mode 100644 index 00000000..8a451b8e --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMDOSFS.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the DOS (FAT) filesystem + is registered, so that instances of this filesystem can be mounted by the + application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_DOSFS +appl-config-option-notes: | + This filesystem requires a Block Device Cache configuration, see + :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.148 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMFTPFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMFTPFS.yml new file mode 100644 index 00000000..008c876b --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMFTPFS.yml @@ -0,0 +1,25 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the FTP filesystem (FTP + client) is registered, so that instances of this filesystem + can be mounted by the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_FTPFS +appl-config-option-notes: | + None. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.149 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMIMFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMIMFS.yml new file mode 100644 index 00000000..d77463af --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMIMFS.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the In-Memory Filesystem + (IMFS) is registered, so that instances of this filesystem can be mounted by + the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_IMFS +appl-config-option-notes: | + Applications will rarely need this configuration option. This configuration + option is intended for test programs. You do not need to define this + configuration option for the base filesystem (also known as root filesystem). +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.150' +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMJFFS2.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMJFFS2.yml new file mode 100644 index 00000000..54899c20 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMJFFS2.yml @@ -0,0 +1,25 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the JFFS2 filesystem + is registered, so that instances of this filesystem can be mounted by the + application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_JFFS2 +appl-config-option-notes: | + None. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.151 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMNFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMNFS.yml new file mode 100644 index 00000000..dfa339e2 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMNFS.yml @@ -0,0 +1,25 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the Network Filesystem + (NFS) client is registered, so that instances of this filesystem can be + mounted by the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_NFS +appl-config-option-notes: | + None. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.152 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMRFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMRFS.yml new file mode 100644 index 00000000..49b1a0b0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMRFS.yml @@ -0,0 +1,26 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the RTEMS Filesystem (RFS) + is registered, so that instances of this filesystem can be mounted by the + application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_RFS +appl-config-option-notes: | + This filesystem requires a Block Device Cache configuration, see + :ref:`CONFIGURE_APPLICATION_NEEDS_LIBBLOCK`. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.153 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMTFTPFS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMTFTPFS.yml new file mode 100644 index 00000000..9c23791a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-FILESYSTEMTFTPFS.yml @@ -0,0 +1,25 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then the TFTP filesystem (TFTP + client) is registered, so that instances of this filesystem can be mounted by + the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_FILESYSTEM_TFTPFS +appl-config-option-notes: | + None. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.154 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODDEVICE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODDEVICE.yml new file mode 100644 index 00000000..eaa52d2e --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODDEVICE.yml @@ -0,0 +1,27 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: feature +appl-config-option-default: | + If this configuration option is undefined, then the root IMFS supports making + device files. +appl-config-option-description: | + In case this configuration option is defined, then the root IMFS does not + support making device files. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD_DEVICE +appl-config-option-notes: | + None. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.155 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCDIRTY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCDIRTY.yml new file mode 100644 index 00000000..048c8ee6 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCDIRTY.yml @@ -0,0 +1,28 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-description: | + In case this configuration option is defined, then each memory area returned + by C Program Heap allocator functions such as :c:func:`malloc` is dirtied + with a ``0xCF`` byte pattern before it is handed over to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_MALLOC_DIRTY +appl-config-option-notes: | + The dirtying performed by this option is carried out for each successful + memory allocation from the C Program Heap in contrast to + :ref:`CONFIGURE_DIRTY_MEMORY` which dirties the memory only once during the + system initialization. +appl-config-option-type: feature-enable +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.156 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSHMS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSHMS.yml new file mode 100644 index 00000000..42f7d89f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSHMS.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: integer +appl-config-option-default-value: 0 +appl-config-option-description: | + The value of this configuration option defines the maximum number of POSIX + API Shared Memory objects that can be concurrently active. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_SHMS +appl-config-option-notes: | + This object class can be configured in unlimited allocation mode, see + :ref:`ConfigUnlimitedObjects`. +appl-config-option-constraint: + min: 0 + max: 65535 + links: + - RTEMS-ACFG-OPT-CONSTRAINTUNLIMITED + - RTEMS-ACFG-OPT-CONSTRAINTWKSPACE + - RTEMS-ACFG-OPT-CONSTRAINTMEMSZ +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.157 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml new file mode 100644 index 00000000..fe064e17 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPEXTRASERVERSTACK.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-default-value: 0 +appl-config-option-description: | + The value of this configuration option defines the number of bytes the + applications wishes to add to the MPCI task stack on top of + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK +appl-config-option-notes: | + None. +appl-config-option-type: integer +appl-config-option-constraint: + min: 0 + max: '``UINT32_MAX``' + custom: + - | + The value of this configuration option shall be small enough so that the + MPCI receive server stack area calculation carried out by + ``<rtems/confdefs.h>`` does not overflow an integer of type ``size_t``. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.145 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERASSIGNMENTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERASSIGNMENTS.yml new file mode 100644 index 00000000..a4c49b0d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERASSIGNMENTS.yml @@ -0,0 +1,42 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-default-value: | + The default value of this configuration option is computed so that the + default scheduler is assigned to each configured processor (up to 32). +appl-config-option-description: | + The value of this configuration option is used to initialize the initial + scheduler to processor assignments. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_ASSIGNMENTS +appl-config-option-notes: | + This configuration option is only evaluated in SMP configurations. + + This is an advanced configuration option, see + :ref:`ConfigurationSchedulersClustered`. +appl-config-option-type: initializer +appl-config-option-constraint: + custom: + - | + The value of this configuration option shall be a list of the following + macros: + + * ``RTEMS_SCHEDULER_ASSIGN( processor_index, attributes )`` + + * :c:macro:`RTEMS_SCHEDULER_ASSIGN_NO_SCHEDULER` + - | + The value of this configuration option shall be a list of exactly + :ref:`CONFIGURE_MAXIMUM_PROCESSORS` elements. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.158 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSTRONGAPA.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSTRONGAPA.yml new file mode 100644 index 00000000..6fa78735 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSTRONGAPA.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: feature-enable +appl-config-option-description: | + In case this configuration option is defined, then Strong APA algorithm is + made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_STRONG_APA +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + This scheduler algorithm is only available when RTEMS is built with SMP + support enabled. + + This scheduler algorithm is not correctly implemented. Do not use it. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.159 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKFROMALLOC.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKFROMALLOC.yml new file mode 100644 index 00000000..f5885fb2 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKFROMALLOC.yml @@ -0,0 +1,36 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: initializer +appl-config-option-default-value: | + The default value is a macro which supports the system heap allocator. +appl-config-option-description: | + The value of this configuration option is used to calculate the task stack + space size. +appl-config-option-index: +- task stack allocator +appl-config-option-name: CONFIGURE_TASK_STACK_FROM_ALLOCATOR +appl-config-option-notes: | + This configuration option may be used if a custom task stack allocator is + configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. +appl-config-option-constraint: + custom: + - | + The value of this configuration option shall be defined to a macro which + accepts exactly one parameter and returns an unsigned integer. The + parameter will be an allocation size and the macro shall return this size + plus the overhead of the allocator to manage an allocation request for this + size. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.161 +links: +- RTEMS-ACFG-STACKALLOC: RinkAR6bq3NOG7L5KiFW19GxN_mHxMpEd6-axxdk-k4= +normative: true +ref: '' +reviewed: null +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKNOWKSPACE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKNOWKSPACE.yml new file mode 100644 index 00000000..4f0b6894 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKNOWKSPACE.yml @@ -0,0 +1,25 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-type: feature-enable +appl-config-option-description: | + In case this configuration option is defined, then the system is informed + that the task stack allocator does not use the RTEMS Workspace. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE +appl-config-option-notes: | + This configuration option may be used if a custom task stack allocator is + configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.160' +links: +- RTEMS-ACFG-STACKALLOC: RinkAR6bq3NOG7L5KiFW19GxN_mHxMpEd6-axxdk-k4= +normative: true +ref: '' +reviewed: null +text: '' +type: interface |