diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-17 10:06:27 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-17 16:32:51 +0100 |
commit | 64987c4dc4d83200f0fb0d0636ad7be621e5801a (patch) | |
tree | 001e6ffdbae32dee3bca245490bb2974097c5fd6 /spec/acfg | |
parent | content: Add method to register license/copyrights (diff) | |
download | rtems-central-64987c4dc4d83200f0fb0d0636ad7be621e5801a.tar.bz2 |
spec: Add application configuration
Diffstat (limited to 'spec/acfg')
133 files changed, 4372 insertions, 0 deletions
diff --git a/spec/acfg/.doorstop.yml b/spec/acfg/.doorstop.yml new file mode 100644 index 00000000..f470bed4 --- /dev/null +++ b/spec/acfg/.doorstop.yml @@ -0,0 +1,15 @@ +settings: + digits: 3 + parent: RTEMS + prefix: RTEMS-ACFG + sep: '-' +attributes: + defaults: + SPDX-License-Identifier: CC-BY-SA-4.0 + enabled-by: [] + interface-type: appl-config-group + type: interface + reviewed: + - enabled-by + - interface-type + - type diff --git a/spec/acfg/RTEMS-ACFG-BDBUF.yml b/spec/acfg/RTEMS-ACFG-BDBUF.yml new file mode 100644 index 00000000..09e111e9 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-BDBUF.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the Block Device Cache + (bdbuf). +appl-config-group-name: Block Device Cache Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.1 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: FnjaE8ztXyPAXKTsaagVNfHfh_8f4ncdxIG9ho9n_AA= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-CLASSIC.yml b/spec/acfg/RTEMS-ACFG-CLASSIC.yml new file mode 100644 index 00000000..84e4025b --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-CLASSIC.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the Classic API. +appl-config-group-name: Classic API Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.2 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: o56vQeLZdVSQ3We-eSixhJxwqGLBNJpD5wnaHeTlLjM= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-CLASSICINIT.yml b/spec/acfg/RTEMS-ACFG-CLASSICINIT.yml new file mode 100644 index 00000000..3f0cd373 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-CLASSICINIT.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the Classic API + initialization task. +appl-config-group-name: Classic API Initialization Task Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.3 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: mTC3DcfCqElhgdthRiOLV1t1Bw-Si4IM5_d5xP-2GSg= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-DEVDRV.yml b/spec/acfg/RTEMS-ACFG-DEVDRV.yml new file mode 100644 index 00000000..4b31af6a --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-DEVDRV.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the device drivers. + Note that network device drivers are not covered by the following options. +appl-config-group-name: Device Driver Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.4 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: LjipM-Hewis0-OHSPKwqB_Uffae0qmfBtzppXqrqBDU= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-EVENTRECORD.yml b/spec/acfg/RTEMS-ACFG-EVENTRECORD.yml new file mode 100644 index 00000000..50cf2beb --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-EVENTRECORD.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the event recording. +appl-config-group-name: Event Recording Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.5 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: tvw_EOJI4tIu_ZEKuxFvRuetfNZY7SwzZsOweSpi9W0= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-FILESYSTEM.yml b/spec/acfg/RTEMS-ACFG-FILESYSTEM.yml new file mode 100644 index 00000000..1e86bd22 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-FILESYSTEM.yml @@ -0,0 +1,59 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to filesytems. + By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also + known as root filesystem). In order to save some memory for your application, + you can disable the filesystem support with the + :ref:`CONFIGURE_APPLICATION_DISABLE_FILESYSTEM` configuration option. + Alternatively, you can strip down the features of the base filesystem with the + :ref:`CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM` and + :ref:`CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM` configuration options. These + three configuration options are mutually exclusive. They are intended for an + advanced application configuration. + + Features of the IMFS can be disabled and enabled with the following + configuration options: + + * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD` + + * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN` + + * :ref:`CONFIGURE_IMFS_DISABLE_LINK` + + * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD` + + * :ref:`CONFIGURE_IMFS_DISABLE_MKNOD_FILE` + + * :ref:`CONFIGURE_IMFS_DISABLE_MOUNT` + + * :ref:`CONFIGURE_IMFS_DISABLE_READDIR` + + * :ref:`CONFIGURE_IMFS_DISABLE_READLINK` + + * :ref:`CONFIGURE_IMFS_DISABLE_RENAME` + + * :ref:`CONFIGURE_IMFS_DISABLE_RMNOD` + + * :ref:`CONFIGURE_IMFS_DISABLE_SYMLINK` + + * :ref:`CONFIGURE_IMFS_DISABLE_UNMOUNT` + + * :ref:`CONFIGURE_IMFS_DISABLE_UTIME` + + * :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO` +appl-config-group-name: Filesystem Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.6 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: guzvijvCL3KNldxRZblk0dG3MnBE2BNDLRci3Rthhj8= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-GENERAL.yml b/spec/acfg/RTEMS-ACFG-GENERAL.yml new file mode 100644 index 00000000..76ae83ef --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-GENERAL.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes general system configuration options. +appl-config-group-name: General System Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.7 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: tQsepmlFchBRHS82XbAeBrN48Kk6-2V6XLryBW_z5Bw= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-IDLE.yml b/spec/acfg/RTEMS-ACFG-IDLE.yml new file mode 100644 index 00000000..e46ad599 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-IDLE.yml @@ -0,0 +1,19 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the idle tasks. +appl-config-group-name: Idle Task Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.8 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: 1wxlxj8JAjN2L2SS5ZWNiJDPOaPAykHSlNmo-Xvn-9Y= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-MPCI.yml b/spec/acfg/RTEMS-ACFG-MPCI.yml new file mode 100644 index 00000000..2a08f2c1 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-MPCI.yml @@ -0,0 +1,24 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes multiprocessing related configuration options. The + options are only used if RTEMS was built with the ``--enable-multiprocessing`` + build configuration option. Additionally, this class of configuration options + are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION` + is defined. The multiprocessing (MPCI) support must not be confused with the + SMP support. +appl-config-group-name: Multiprocessing Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.9 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: yXBH3hwCoRc1nTBA3tRJJdwwHdJSqpY9ffgWt2dFrV4= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-POSIX.yml b/spec/acfg/RTEMS-ACFG-POSIX.yml new file mode 100644 index 00000000..5de190b8 --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-POSIX.yml @@ -0,0 +1,22 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the POSIX API. Most + POSIX API objects are available by default since RTEMS 5.1. The queued signals + and timers are only available if RTEMS was built with the ``--enable-posix`` + build configuration option. +appl-config-group-name: POSIX API Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: '1.10' +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: bSP5fMnqun-ljjfq2ybxLaBRD3JGv3865L8eY98yll0= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-POSIXINIT.yml b/spec/acfg/RTEMS-ACFG-POSIXINIT.yml new file mode 100644 index 00000000..4f0aface --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-POSIXINIT.yml @@ -0,0 +1,20 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the POSIX + initialization thread. +appl-config-group-name: POSIX Initialization Thread Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.11 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: f1qRzv3GY8P-S90SQWPxoWg6mTMut92NG-0ZMC8JK9A= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-SCHEDGENERAL.yml b/spec/acfg/RTEMS-ACFG-SCHEDGENERAL.yml new file mode 100644 index 00000000..3e38a3fb --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-SCHEDGENERAL.yml @@ -0,0 +1,39 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to selecting a + scheduling algorithm for an application. A scheduler configuration is optional + and only necessary in very specific circumstances. A normal application + configuration does not need any of the configuration options described in this + section. + + By default, the :ref:`Deterministic Priority Scheduler <SchedulerPriority>` + algorithm is used in uniprocessor configurations. In case SMP is enabled and + the configured maximum processors + (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`) is greater + than one, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler + <SchedulerSMPEDF>` is selected as the default scheduler algorithm. + + For the :ref:`schedulers built into + RTEMS <SchedulingConcepts>`, the configuration is straightforward. All that is + required is to define the configuration option which specifies which scheduler + you want for in your application. + + The pluggable scheduler interface also enables the user to provide their own + scheduling algorithm. If you choose to do this, you must define multiple + configuration option. +appl-config-group-name: General Scheduler Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.13 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: cspvd3fHC4ovITlFE_yBwqsaR6qchsqED2vblDt1WK4= +text: '' +type: interface diff --git a/spec/acfg/RTEMS-ACFG-STACKALLOC.yml b/spec/acfg/RTEMS-ACFG-STACKALLOC.yml new file mode 100644 index 00000000..8bf5eecd --- /dev/null +++ b/spec/acfg/RTEMS-ACFG-STACKALLOC.yml @@ -0,0 +1,23 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-group-description: | + This section describes configuration options related to the task stack + allocator. RTEMS allows the application or BSP to define its own allocation + and deallocation methods for task stacks. This can be used to place task stacks + in special areas of memory or to utilize a Memory Management Unit so that stack + overflows are detected in hardware. +appl-config-group-name: Task Stack Allocator Configuration +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-group +level: 1.14 +links: +- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE= +normative: true +ref: '' +reviewed: KiUOZK5x9xTauGthof04ZAcsK21DCVfWCR4tC4qrX2Q= +text: '' +type: interface diff --git a/spec/acfg/opt/.doorstop.yml b/spec/acfg/opt/.doorstop.yml new file mode 100644 index 00000000..7b557365 --- /dev/null +++ b/spec/acfg/opt/.doorstop.yml @@ -0,0 +1,15 @@ +settings: + digits: 3 + parent: RTEMS-ACFG + prefix: RTEMS-ACFG-OPT + sep: '-' +attributes: + defaults: + SPDX-License-Identifier: CC-BY-SA-4.0 + enabled-by: [] + interface-type: appl-config-option + type: interface + reviewed: + - enabled-by + - interface-type + - type diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml new file mode 100644 index 00000000..193e3eec --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDISABLEFILESYSTEM.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. If no other root file system configuration + parameters are specified, the IMFS will be used as the root file system. +appl-config-option-description: | + This configuration parameter is defined if the application dose not intend + to use any kind of filesystem support. This include the device + infrastructure necessary to support ``printf()``. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.49 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: ISCAPa6Rmc7Wjwjzcpt2JGYcS_1NjTrLjGFNaQFP1CY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml new file mode 100644 index 00000000..a10a7488 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLDOESNOTNEEDCLOCKDRIVER.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is defined when the + application does *NOT* want the Clock Device Driver and is *NOT* using the + Timer Driver. The inclusion or exclusion of the Clock Driver must be + explicit in user applications. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER +appl-config-option-notes: | + This configuration parameter is intended to prevent the common user error + of using the Hello World example as the baseline for an application and + leaving out a clock tick source. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.32 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: _T9fkYVAoLLbQYU-jS3lI-pjFUgiFcsK3955GQS27hg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml new file mode 100644 index 00000000..b66f2074 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLEXTRADRIVERS.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + device driver entry structures +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_EXTRA_DRIVERS`` is defined if the application has + device drivers it needs to include in the Device Driver Table. This should + be defined to the set of device driver entries that will be placed in the + table at the *END* of the Device Driver Table. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_EXTRA_DRIVERS +appl-config-option-notes: | + None. +appl-config-option-range: | + Undefined or set of device driver entry structures +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.33 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: 1UivcEWeu7DQQ3YP0hVHwzRhICaQvtjZIngPW_odEtM= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml new file mode 100644 index 00000000..d1c29db3 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCLOCKDRIVER.yml @@ -0,0 +1,35 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER`` is defined if the application + wishes to include the Clock Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER +appl-config-option-notes: | + This device driver is responsible for providing a regular interrupt which + invokes a clock tick directive. + + If neither the Clock Driver not Benchmark Timer is enabled and the + configuration parameter + ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a + compile time error will occur. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.34 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: iYo4gVJmAy2sTZW86RErx_Si06MJ7ls-YdCePAOJ5JI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml new file mode 100644 index 00000000..427f8d6b --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSCONSOLEDRIVER.yml @@ -0,0 +1,44 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`` is defined if the + application wishes to include the Console Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER +appl-config-option-notes: | + This device driver is responsible for providing the :file:`/dev/console` + device file. This device is used to initialize the standard input, output, + and error file descriptors. + + BSPs should be constructed in a manner that allows ``printk()`` to work + properly without the need for the console driver to be configured. + + The + + * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + + configuration options are mutually exclusive. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.35 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: VpP5UWholTSJHqJZbAbU9jxEauYgF8_PgwbJOVCwldc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml new file mode 100644 index 00000000..459b4fb7 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSFRAMEBUFFERDRIVER.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER`` is defined if the + application wishes to include the BSP's Frame Buffer Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER +appl-config-option-notes: | + Most BSPs do not include support for a Frame Buffer Device Driver. This is + because many boards do not include the required hardware. + + If this is defined and the BSP does not have this device driver, then the + user will get a link time error for an undefined symbol. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.36 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: 2F01KzXw6CfqnUWhn2AacbqEERlpzY_lGS-MM0kTNMU= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml new file mode 100644 index 00000000..8e345cad --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSLIBBLOCK.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + Provides a Block Device Cache configuration. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK +appl-config-option-notes: | + Each option of the Block Device Cache configuration can be explicitly set + by the user with the configuration options below. The Block Device Cache + is used for example by the RFS and DOSFS file systems. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.1 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: M833U9HGwq-4g4ELB7aIDa_BZow-M0GaFavclYvSffI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml new file mode 100644 index 00000000..c2dbd8b1 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSNULLDRIVER.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + This configuration variable is specified to enable ``/dev/null`` device driver. +appl-config-option-index: +- /dev/null +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER +appl-config-option-notes: | + This device driver is supported by all BSPs. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.37 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: PUE4qQOTUh2GbprwppZoYYsECHdwKECRtfiwbd988C8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml new file mode 100644 index 00000000..c01f14fc --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSRTCDRIVER.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER`` is defined if the application + wishes to include the Real-Time Clock Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER +appl-config-option-notes: | + Most BSPs do not include support for a real-time clock. This is because + many boards do not include the required hardware. + + If this is defined and the BSP does not have this device driver, then the + user will get a link time error for an undefined symbol. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.38 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: 7z9kkey_i48fitPzhEtNOBktrDkPKJKhQUn-fKZkg7c= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml new file mode 100644 index 00000000..7466ae8a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLECONSOLEDRIVER.yml @@ -0,0 +1,48 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`` is defined if the + application wishes to include the Simple Console Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER +appl-config-option-notes: | + This device driver is responsible for providing the :file:`/dev/console` + device file. This device is used to initialize the standard input, output, + and error file descriptors. + + This device driver reads via ``getchark()``. + + This device driver writes via ``rtems_putc()``. + + The Termios framework is not used. There is no support to change device + settings, e.g. baud, stop bits, parity, etc. + + The + + * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + + configuration options are mutually exclusive. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.39 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: qkHAEqgIdMA19PJTZzuAlwHxp0KIMoT4BbzrDP2ik7M= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml new file mode 100644 index 00000000..8cbc8684 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSIMPLETASKCONSOLEDRIVER.yml @@ -0,0 +1,57 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` is defined if + the application wishes to include the Simple Task Console Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER +appl-config-option-notes: | + This device driver is responsible for providing the :file:`/dev/console` + device file. This device is used to initialize the standard input, output, + and error file descriptors. + + This device driver reads via ``getchark()``. + + This device driver writes into a write buffer. The count of characters + written into the write buffer is returned. It might be less than the + requested count, in case the write buffer is full. The write is + non-blocking and may be called from interrupt context. A dedicated task + reads from the write buffer and outputs the characters via + ``rtems_putc()``. This task runs with the least important priority. The + write buffer size is 2047 characters and it is not configurable. + + Use ``fsync(STDOUT_FILENO)`` or ``fdatasync(STDOUT_FILENO)`` to drain the + write buffer. + + The Termios framework is not used. There is no support to change device + settings, e.g. baud, stop bits, parity, etc. + + The + + * ``CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER``, + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER``, and + + * ``CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`` + + configuration options are mutually exclusive. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.40' +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: N-CV1Km7BOdv7hv_JgySEVM6bkfMVO61kWv3WcSotYE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml new file mode 100644 index 00000000..c98ad32b --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSSTUBDRIVER.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER`` is defined if the application + wishes to include the Stub Device Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER +appl-config-option-notes: | + This device driver simply provides entry points that return successful and + is primarily a test fixture. It is supported by all BSPs. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.41 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: KsaiA9DjlpfXZhK-VjPyk1FTWxlwgI35LQyJb6erL78= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml new file mode 100644 index 00000000..f854be80 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSTIMERDRIVER.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER`` is defined if the application + wishes to include the Timer Driver. This device driver is used to + benchmark execution times by the RTEMS Timing Test Suites. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER +appl-config-option-notes: | + If neither the Clock Driver not Benchmark Timer is enabled and the + configuration parameter + ``CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER`` is not defined, then a + compile time error will occur. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.42 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: z6pDFVmdbU3gNP-3KPQ8f14ebmZZzUu54GxGIffS9_E= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml new file mode 100644 index 00000000..81a8fd12 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSWATCHDOGDRIVER.yml @@ -0,0 +1,33 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER`` is defined if the + application wishes to include the Watchdog Driver. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER +appl-config-option-notes: | + Most BSPs do not include support for a watchdog device driver. This is + because many boards do not include the required hardware. + + If this is defined and the BSP does not have this device driver, then the + user will get a link time error for an undefined symbol. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.43 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: 7owvbyMVAe4Bz7tPsWiKrq9pIiFHN2hR0Lkx2H1pBv8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml new file mode 100644 index 00000000..184f6dc4 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLNEEDSZERODRIVER.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + This configuration variable is specified to enable ``/dev/zero`` device driver. +appl-config-option-index: +- /dev/zero +appl-config-option-name: CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER +appl-config-option-notes: | + This device driver is supported by all BSPs. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.44 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: HcrYQYZcCkuaF8hFIOnl74j6H5A1Zs5j6Z3S5cTR2Yg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml new file mode 100644 index 00000000..c987960d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-APPLPREREQUISITEDRIVERS.yml @@ -0,0 +1,36 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + device driver entry structures +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`` is defined if the + application has device drivers it needs to include in the Device Driver + Table. This should be defined to the set of device driver entries that + will be placed in the table at the *FRONT* of the Device Driver Table and + initialized before any other drivers *EXCEPT* any BSP prerequisite drivers. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS +appl-config-option-notes: | + In some cases, it is used by System On Chip BSPs to support peripheral + buses beyond those normally found on the System On Chip. For example, this + is used by one RTEMS system which has implemented a SPARC/ERC32 based board + with VMEBus. The VMEBus Controller initialization is performed by a device + driver configured via this configuration parameter. +appl-config-option-range: | + Undefined or set of device driver entry structures +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.45 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: N1-UI29pbUm9t9Dh809r1155DANz2vOL6My245rNpNk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml new file mode 100644 index 00000000..b5c27120 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMAXSIZE.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.2 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: fub05CXZScm_6L83WbMN6tNgzGgpuy9paA-VKGj2VaE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml new file mode 100644 index 00000000..586af2d7 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFBUFFERMINSIZE.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.3 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: qv78xwy_pWaNmasquzxSSYjSu29sI4OTunttgNCdFQY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml new file mode 100644 index 00000000..889c9786 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFCACHEMEMORYSIZE.yml @@ -0,0 +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 32768 bytes. +appl-config-option-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.4 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: ztDCYYeTOq-TfO2EtPIBYz0rowaJG-5EZadtp5Ekr_g= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml new file mode 100644 index 00000000..00890aa5 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXREADAHEADBLOCKS.yml @@ -0,0 +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.5 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: Lchcp6brJcQ0aMB3wBlfUD37WjbJ8CbjJUtLPz3u5sM= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml new file mode 100644 index 00000000..2e3e5457 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFMAXWRITEBLOCKS.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.6 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: IlQp-5NgXh5l0BFnnKzyAykBreQdE4MyZ2Xv-gvWpp4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml new file mode 100644 index 00000000..0c1980e0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFREADAHEADTASKPRIORITY.yml @@ -0,0 +1,28 @@ +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-description: | + Defines the read-ahead task priority. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY +appl-config-option-notes: | + None. +appl-config-option-range: | + Valid task priority. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.7 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: kE7Rcc1Fye0pi8-M8ufLxQnKdL63ba067U5VgAU6maE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml new file mode 100644 index 00000000..fbcdf402 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BDBUFTASKSTACKSIZE.yml @@ -0,0 +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 RTEMS_MINIMUM_STACK_SIZE. +appl-config-option-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.8 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: RNlzHbb_NjWFj0FpfnvOVRnHip5ZTfRX3IpogitGn9s= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml new file mode 100644 index 00000000..4d429181 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-DIRTYMEMORY.yml @@ -0,0 +1,36 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + By default, the memory used by the RTEMS Workspace and the C Program Heap + is uninitialized memory. +appl-config-option-description: | + This macro indicates whether RTEMS should dirty the memory used by the + RTEMS Workspace and the C Program Heap as part of its initialization. If + defined, the memory areas are dirtied with a ``0xCF`` byte pattern. + Otherwise, they are not. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_DIRTY_MEMORY +appl-config-option-notes: | + Dirtying memory can add significantly to system boot time. It may assist in + finding code that incorrectly assumes the contents of free memory areas is + cleared to zero during system initialization. In case + :ref:`CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY` is also defined, then the + memory is first dirtied and then zeroed. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.67 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: zOyiOMdbdMsmxId-SShr_wXLhsoksxKv9Wq7ZphmPog= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml new file mode 100644 index 00000000..ae56e752 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-EXTRATASKSTACKS.yml @@ -0,0 +1,33 @@ +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-description: | + This configuration parameter is set to the number of bytes the applications + wishes to add to the task stack requirements calculated by + ``<rtems/confdefs.h>``. +appl-config-option-index: +- memory for task tasks +appl-config-option-name: CONFIGURE_EXTRA_TASK_STACKS +appl-config-option-notes: | + This parameter is very important. If the application creates tasks with + stacks larger then the minimum, then that memory is NOT accounted for by + ``<rtems/confdefs.h>``. +appl-config-option-range: | + Undefined or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.68 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: mis7od0PZMb0qfwof2ubzwendT9dClrfwDpT2nCVivk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml new file mode 100644 index 00000000..ac0640f9 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKBODY.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Function pointer. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_IDLE_TASK_BODY`` is set to the function name corresponding to + the application specific IDLE thread body. If not specified, the BSP or + RTEMS default IDLE thread body will be used. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IDLE_TASK_BODY +appl-config-option-notes: | + None. +appl-config-option-range: | + Undefined or valid function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.86 +links: +- RTEMS-ACFG-IDLE: MPU6F9VtN3Et8wrFFFP7VlpO0zGaWoJFOwfuikRpGxs= +normative: true +ref: '' +reviewed: tA22lYVMXLWhTE8ZIPIGkocmsXQdVX2GkdMzLobDCO0= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml new file mode 100644 index 00000000..b1ea44e4 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml @@ -0,0 +1,37 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default, the user is assumed to provide one or more + initialization tasks. +appl-config-option-description: | + ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`` is set to indicate that the + user has configured *NO* user initialization tasks or threads and that the + user provided IDLE task will perform application initialization and then + transform itself into an IDLE task. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION +appl-config-option-notes: | + If you use this option be careful, the user IDLE task *CANNOT* block at all + during the initialization sequence. Further, once application + initialization is complete, it must make itself preemptible and enter an + IDLE body loop. + + The IDLE task must run at the lowest priority of all tasks in the system. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.87 +links: +- RTEMS-ACFG-IDLE: MPU6F9VtN3Et8wrFFFP7VlpO0zGaWoJFOwfuikRpGxs= +normative: true +ref: '' +reviewed: FgLDcT4kZkxgXgc8x6NU8jDffKzNY1vfPSsMpRljylE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml new file mode 100644 index 00000000..2f790246 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml @@ -0,0 +1,29 @@ +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-description: | + ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.88 +links: +- RTEMS-ACFG-IDLE: MPU6F9VtN3Et8wrFFFP7VlpO0zGaWoJFOwfuikRpGxs= +normative: true +ref: '' +reviewed: vCxvokQrszGqeHmPFiKnlsYeZWwUycCMU0_L_sbaQUo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml new file mode 100644 index 00000000..d212c632 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHMOD.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to change + the mode is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_CHMOD +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.50' +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: J6ILrGCyaH89KzZwbuFXciu5kv4l2EXC2Xh_WjWWQjw= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml new file mode 100644 index 00000000..070432f0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLECHOWN.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to change + the owner is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_CHOWN +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.51 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: eRyMZHMHpjZC1Os73g1SFhkwDJDO5NC62w4SoeClOpI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml new file mode 100644 index 00000000..01d87e86 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLELINK.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to create + hard links is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_LINK +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.52 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: Kz4op88t5gdkMh4ZET2dXEOMA-IkthUq69-lZTpaRI8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml new file mode 100644 index 00000000..197fe696 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNOD.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to make + directories, devices, regular files and FIFOs is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.53 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: W3_uZFT_UnrDuR34u2IzwYMyccywHxRucu8tShDrz4U= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml new file mode 100644 index 00000000..3bae9054 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMKNODFILE.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to make + regular files is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_MKNOD_FILE +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.54 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: 46ydxum3nxKXxueJdAIr-80usly9S5YcALlMv7oHcvI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml new file mode 100644 index 00000000..8ca63e6e --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEMOUNT.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to mount + other file systems is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_MOUNT +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.55 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: x4u1cvybGRBFFUslFJ8iDCSAhrr-TEbF93tiWtI0V_4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml new file mode 100644 index 00000000..6adaf700 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADDIR.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to read a + directory is disabled in the root IMFS. It is still possible to open nodes + in a directory. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_READDIR +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.56 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: zmO3IMdvDIZktX0p2SnGiHyp3wE0ADvc49lH8dgn1q4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml new file mode 100644 index 00000000..94c99be2 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEREADLINK.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to read + symbolic links is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_READLINK +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.57 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: 2ThG-m0Cd-y-j0dnD-EggrmfYuB28pBilXWH48Zc0tg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml new file mode 100644 index 00000000..955adf77 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERENAME.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to rename + nodes is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_RENAME +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.58 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: hg3xQ-NB18ypTPDSWB2ZnISFObWHRieRY3WTxNVBGmI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml new file mode 100644 index 00000000..7917e19d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLERMNOD.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to remove + nodes is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_RMNOD +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.59 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: NVmyY4QJoXlEpr2lPbak0i1cJWOaOuSvKWarMt2Y9I8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml new file mode 100644 index 00000000..b39b6b27 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLESYMLINK.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to create + symbolic links is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_SYMLINK +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.60' +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: 2tTHJZhWZs99a4799w5te-v2YYF_dciwyDbLcdjTUtk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml new file mode 100644 index 00000000..5c78c34d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUNMOUNT.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to unmount + file systems is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_UNMOUNT +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.61 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: nhyacgemgFJGPk279ClvyZsP5k_3P-Mc33BTCG3qJ0E= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml new file mode 100644 index 00000000..55bd492f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSDISABLEUTIME.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to change + times is disabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_DISABLE_UTIME +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.62 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: rrGCQJOGjqp0lM5nTvEMOjvV1OUAyGhJJrkHCn8iTdU= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml new file mode 100644 index 00000000..36805b09 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSENABLEMKFIFO.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the support to make FIFOs + is enabled in the root IMFS. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_IMFS_ENABLE_MKFIFO +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.63 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: I0m95z777CzfcvD-A3C2qawNgWd_7hjUtTiq7uw8KEE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml new file mode 100644 index 00000000..0fda442f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IMFSMEMFILEBYTESPERBLOCK.yml @@ -0,0 +1,55 @@ +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-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. + + 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 + correspondingly smaller. The following shows the maximum file size possible + based on the configured block size: + + - when the block size is 16 bytes, the maximum file size is 1,328 bytes. + + - when the block size is 32 bytes, the maximum file size is 18,656 bytes. + + - when the block size is 64 bytes, the maximum file size is 279,488 bytes. + + - when the block size is 128 bytes, the maximum file size is 4,329,344 bytes. + + - when the block size is 256 bytes, the maximum file size is 68,173,568 bytes. + + - when the block size is 512 bytes, the maximum file size is 1,082,195,456 + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.64 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: iA2QqUff1w3cWEYU5hSqcvelHFH2rdGHHEb8TCVHTdQ= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml new file mode 100644 index 00000000..1ee5818a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITIALEXTENSIONS.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + List of user extension initializers (``rtems_extensions_table``). +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If ``CONFIGURE_INITIAL_EXTENSIONS`` is defined by the application, then + this application specific set of initial extensions will be placed in the + initial extension table. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_INITIAL_EXTENSIONS +appl-config-option-notes: | + None. +appl-config-option-range: | + Undefined or a list of one or more user extensions. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.69 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: Sd9l4jat5QB1IDZpilTkoIwVqC_yJ6N-s_VrP76irAg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml new file mode 100644 index 00000000..26bcee73 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKARGUMENTS.yml @@ -0,0 +1,29 @@ +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-description: | + ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single + initialization task defined by the Classic API Initialization Tasks Table. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.24 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: jMwnu7-4ilJXkAUw6EL_YWvbjmdsKCZfNYHd-NrMhYY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml new file mode 100644 index 00000000..877f17f0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKATTRIBUTES.yml @@ -0,0 +1,29 @@ +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-description: | + ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single + initialization task defined by the Classic API Initialization Tasks Table. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.25 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: 1wSAoAaLJYYHhsD2dTGXAPg6sq-HKGO9E4rDL64LoAM= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml new file mode 100644 index 00000000..5c6b7a16 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKENTRYPOINT.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Task entry function pointer (``rtems_task_entry``). +appl-config-option-default-value: | + The default value is ``Init``. +appl-config-option-description: | + ``CONFIGURE_INIT_TASK_ENTRY_POINT`` is the entry point (a.k.a. function + name) of the single initialization task defined by the Classic API + Initialization Tasks Table. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_INIT_TASK_ENTRY_POINT +appl-config-option-notes: | + The user must implement the function ``Init`` or the function name provided + in this configuration parameter. +appl-config-option-range: | + Valid task entry function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.26 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: jOkXLnZAAC3nPhY6NtlLibjtoO6p3DQYy5LcJKHzUOo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml new file mode 100644 index 00000000..fcced0cc --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKINITIALMODES.yml @@ -0,0 +1,30 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + RTEMS Mode (``rtems_mode``). +appl-config-option-default-value: | + 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. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.27 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: cfugRwA222BfynK4vQ6fTwoiebtjWrylcPaHDy9Oaj8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml new file mode 100644 index 00000000..934b3f69 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKNAME.yml @@ -0,0 +1,29 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + RTEMS Name (``rtems_name``). +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. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_INIT_TASK_NAME +appl-config-option-notes: | + None. +appl-config-option-range: | + Any value. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.28 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: YPwhKZqVv-jA9R7N9GdU4xIf4DWBhhtaTebe_kPuwxg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml new file mode 100644 index 00000000..76dccb40 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKPRIORITY.yml @@ -0,0 +1,29 @@ +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-description: | + ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single + initialization task defined by the Classic API Initialization Tasks Table. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.29 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: Is50r8SdOMSSHLo7zDsCsO6hlwHa7wFKEzfJjTuFZTI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml new file mode 100644 index 00000000..814ec502 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INITTASKSTACKSIZE.yml @@ -0,0 +1,32 @@ +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-description: | + ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single + initialization task defined by the Classic API Initialization Tasks Table. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.30' +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: NasAYqLLBgKuwqe3fM4UFybmaqO1xw-ikLf6Swxpotw= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml new file mode 100644 index 00000000..d0c6ed1d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml @@ -0,0 +1,50 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Unsigned integer. +appl-config-option-default-value: | + The default value is ``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. +appl-config-option-index: +- interrupt stack size +appl-config-option-name: CONFIGURE_INTERRUPT_STACK_SIZE +appl-config-option-notes: | + The interrupt stack size must be aligned according to + ``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. + + Some BSPs use the interrupt stack as the initialization stack which is used + to perform the sequential system initialization before the multithreading + is started. + + The interrupt stacks are covered by the :ref:`stack checker + <CONFIGURE_STACK_CHECKER_ENABLED>`. However, using a too small interrupt + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.70' +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: baaaEdNuGXxSvuDwdHmPZVeBCak0pwpb03jv2nCU2tY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml new file mode 100644 index 00000000..97f50620 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXBARRIERS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_BARRIERS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.14 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: DXQ7n4VFdgQXHBbJOlUe7oLa-mccRpU-Sl5TzVd9RFk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml new file mode 100644 index 00000000..10288faf --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXDRIVERS.yml @@ -0,0 +1,35 @@ +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 computed by default, and is set to the number of device drivers + configured using the ``CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER`` + configuration parameters. +appl-config-option-description: | + ``CONFIGURE_MAXIMUM_DRIVERS`` is defined as the number of device drivers + per node. +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 + statically installed. +appl-config-option-range: | + Zero or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.46 +links: +- RTEMS-ACFG-DEVDRV: 75G0LF6n2XEdjSX-qN_FPap1vl0feYAa0HTSDWPm6-8= +normative: true +ref: '' +reviewed: ACNNr_lLcGVRhoWgoC2uEf3efgPBHW2Zidm-2X5lfqE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml new file mode 100644 index 00000000..a0849681 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXFILEDESCRIPTORS.yml @@ -0,0 +1,33 @@ +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-description: | + This configuration parameter is set to 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.71 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: v9NXVb63UxNrgIyr2XArEs-RinffbSpCHW8pKRRKzI8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml new file mode 100644 index 00000000..3d0017d6 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXMESSAGEQUEUES.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.15 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: qt88R2j8qTmt8r20x-0unu4cOEfeETPuOHPi247vKIA= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml new file mode 100644 index 00000000..fd677cab --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPARTITIONS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_PARTITIONS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.16 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: 7PJjYjWlNHTMhrdDNtDoLbGOcKs1Uq2zhZES8-vCLzk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml new file mode 100644 index 00000000..ba32f6cb --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPERIODS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_PERIODS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.17 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: JLk2cRkwP9mBDOkx8quXjrq3DBXq0AxZt_adp-o7AkI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml new file mode 100644 index 00000000..3997041e --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPORTS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_PORTS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.18 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: y1U22RxLdrpygCxueTw_IwQlNELp-xEQK9YVDGFgXEk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml new file mode 100644 index 00000000..7a176446 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_KEYS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.95 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: cz7kGSYoOWF2G6BuS2PE9lc1BEF6XaQXWT5GaRsgCOw= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml new file mode 100644 index 00000000..81b41984 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXKEYVALUEPAIRS.yml @@ -0,0 +1,35 @@ +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 + :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>`. +appl-config-option-description: | + ``CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS`` is 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. + + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.96 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: 9Dv05nMxAQ7fqMTd6hyDBY5q_WkZM2cUS0xdFUersG4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml new file mode 100644 index 00000000..092a8eaa --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXMESSAGEQUEUES.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.97 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: pIovfEL6fbcdMQA4KnqHMHCEOFeafHLNq0pIPoO5eGc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml new file mode 100644 index 00000000..298a73de --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXQUEUEDSIGNALS.yml @@ -0,0 +1,32 @@ +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS`` is the maximum number of POSIX + API Queued Signals that can be concurrently active. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS +appl-config-option-notes: | + Unlimited objects are not available for queued signals. + + Queued signals are only available if RTEMS was built with the + ``--enable-posix`` build configuration option. +appl-config-option-range: | + Zero or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.98 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: 3y-8Fcir9tbYZbjjF9IYEcXs6TeXA0mq3N0yovhVigc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml new file mode 100644 index 00000000..37c440a5 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXSEMAPHORES.yml @@ -0,0 +1,33 @@ +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_SEMAPHORES`` is 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. + + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.99 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: ZpB6iOxxNIA9FklsO1O4SmcJlClGEwS-e2yskIMqwvU= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml new file mode 100644 index 00000000..7944ba13 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTHREADS.yml @@ -0,0 +1,42 @@ +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_THREADS`` is 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 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 + 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>`. + + All POSIX threads have floating point enabled. +appl-config-option-range: | + Zero or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.100' +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: Mw1R8iWfvNISMX0oIe8FvPkmsTBJ4UNkReKpzyd8ZMw= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml new file mode 100644 index 00000000..d1c58599 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPOSIXTIMERS.yml @@ -0,0 +1,32 @@ +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-description: | + ``CONFIGURE_MAXIMUM_POSIX_TIMERS`` is 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. + + Timers are only available if RTEMS was built with the + ``--enable-posix`` build configuration option. +appl-config-option-range: | + Zero or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.101 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: -qjJAIJmmNnRW1tzT__IoHwUhy9sM3bVAnnWIMTW9bQ= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml new file mode 100644 index 00000000..db19fcb2 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPRIORITY.yml @@ -0,0 +1,61 @@ +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-description: | + For the schedulers + + * :ref:`SchedulerPriority`, which is the default in uniprocessor + configurations and can be configured through the + :ref:`CONFIGURE_SCHEDULER_PRIORITY` configuration option, + + * :ref:`SchedulerSMPPriority` which can be configured through the + :ref:`CONFIGURE_SCHEDULER_PRIORITY_SMP` configuration option, and + + * :ref:`SchedulerSMPPriorityAffinity` which can be configured through the + :ref:`CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP` configuration option + + this configuration option specifies the maximum numeric priority of any task + for these schedulers and one less that the number of priority levels for + these schedulers. For all other schedulers provided by RTEMS, this + configuration option has no effect. +appl-config-option-index: +- maximum priority +- number of priority levels +appl-config-option-name: CONFIGURE_MAXIMUM_PRIORITY +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. + + Reducing the number of priorities through this configuration option reduces + the amount of memory allocated by the schedulers listed above. These + schedulers use a chain control structure per priority and this structure + consists of three pointers. On a 32-bit architecture, the allocated memory + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.72 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: ksLz61UxfVP62IWAMhRmES1jMkdgahV0JiusncyKuOQ= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml new file mode 100644 index 00000000..a81a40d1 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml @@ -0,0 +1,35 @@ +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-description: | + ``CONFIGURE_MAXIMUM_PROCESSORS`` must be set to 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. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.73 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: yeUx3ny8N0sfPzVnTPrNj-pf5rJHU_ZwPRfapmGdXTs= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml new file mode 100644 index 00000000..1aa013fe --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXREGIONS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_REGIONS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.19 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: nofEzFgdd649zF9EK2dQNeuKuzLwdR36wnfmaoa4kJc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml new file mode 100644 index 00000000..fa911bda --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXSEMAPHORES.yml @@ -0,0 +1,33 @@ +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-description: | + ``CONFIGURE_MAXIMUM_SEMAPHORES`` is the maximum number of Classic API + Semaphores 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. + + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.20' +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: K0_04JLS3hk5w3ck1iYIv9yfezMOdlasvktn8NWzN58= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml new file mode 100644 index 00000000..773e8732 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTASKS.yml @@ -0,0 +1,45 @@ +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-description: | + ``CONFIGURE_MAXIMUM_TASKS`` is 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. + + 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 + support enabled. The configuration parameter + ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify task 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 POSIX threads is specified by + :ref:`CONFIGURE_MAXIMUM_POSIX_THREADS <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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.21 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: XmmAPAmszXjo_ovOXIiqv1Dmhu_rYwAKkJVCEXkRav4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml new file mode 100644 index 00000000..def36f2f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTHREADNAMESIZE.yml @@ -0,0 +1,33 @@ +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-description: | + This configuration parameter specifies 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 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.74 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: bAJnLtU8LrPzUyymLByizlcb-DRHawo1OwhGhKlvXZo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml new file mode 100644 index 00000000..6798d6ee --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXTIMERS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_TIMERS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.22 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: Aa4Vp5h5rnP-5t_aaT80lcQ6Gestq-3S30k7ze8PR5Q= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml new file mode 100644 index 00000000..57132f56 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXUSEREXTENSIONS.yml @@ -0,0 +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-description: | + ``CONFIGURE_MAXIMUM_USER_EXTENSIONS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.23 +links: +- RTEMS-ACFG-CLASSIC: xIlmS8RsfhmUc14dTO2H9l5xcMKe5d555tGIZ3hz_SM= +normative: true +ref: '' +reviewed: 62fPPD6G10QQVnoLmuQsz71HQXjRUZqop7KBiiexHBo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml new file mode 100644 index 00000000..c58dc02e --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MEMORYOVERHEAD.yml @@ -0,0 +1,32 @@ +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-description: | + This parameter is set to the number of kilobytes the application wishes to + add to the requirements 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.75 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: 8gsKsqCCY-PEXVGihoUMEk_q2YIGyWuGlPsMTA5v_jI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml new file mode 100644 index 00000000..bf401a63 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MESSAGEBUFFERMEMORY.yml @@ -0,0 +1,76 @@ +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-description: | + The value of this configuration option defines the number of bytes + resereved for message queue buffers in the RTEMS Workspace. +appl-config-option-index: +- configure message queue buffer memory +- CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE +- memory for a single message queue's buffers +appl-config-option-name: CONFIGURE_MESSAGE_BUFFER_MEMORY +appl-config-option-notes: | + The configuration options :ref:`CONFIGURE_MAXIMUM_MESSAGE_QUEUES` and + :ref:`CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES` define only how many message + queues can be created by the application. The memory for the message + buffers is configured by this option. For each message queue you have to + reserve some memory for the message buffers. The size dependes on the + maximum number of pending messages and the maximum size of the messages of + a message queue. Use the ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()`` macro + to specify the message buffer memory for each message queue and sum them up + to define the value for ``CONFIGURE_MAXIMUM_MESSAGE_QUEUES``. + + The interface for the ``CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()`` help + macro is as follows: + + .. code-block:: c + + CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( max_messages, max_msg_size ) + + Where ``max_messages`` is the maximum number of pending messages and + ``max_msg_size`` is the maximum size in bytes of the messages of the + corresponding message queue. Both parameters shall be compile time + constants. Not using this help macro (e.g. just using + ``max_messages * max_msg_size``) may result in an underestimate of the + RTEMS Workspace size. + + The following example illustrates how the + `CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE()` help macro can be used to assist in + calculating the message buffer memory required. In this example, there are + two message queues used in this application. The first message queue has a + maximum of 24 pending messages with the message structure defined by the + type ``one_message_type``. The other message queue has a maximum of 500 + pending messages with the message structure defined by the type + ``other_message_type``. + + .. code-block:: c + + #define CONFIGURE_MESSAGE_BUFFER_MEMORY ( \ + CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \ + 24, \ + sizeof( one_message_type ) \ + ) \ + + CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \ + 500, \ + sizeof( other_message_type ) \ + ) \ + ) +appl-config-option-range: | + undefined (zero) or calculation resulting in a positive integer +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.76 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: zVffxJPd0q-aQH6OwzO9GVd18FV5DgsvRbQPfts7WA0= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml new file mode 100644 index 00000000..afe85419 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MICROSECONDSPERTICK.yml @@ -0,0 +1,49 @@ +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-description: | + This constant is used to specify the length of time between clock ticks. + + 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 + to perform application work. In this case, the system will become + unresponsive. + + The lowest practical time quantum varies widely based upon the speed of the + target hardware and the architectural overhead associated with + interrupts. In general terms, you do not want to configure it lower than is + needed for the application. + + The clock tick quantum should be selected such that it all blocking and + delay times in the application are evenly divisible by it. Otherwise, + rounding errors will be introduced which may negatively impact the + application. +appl-config-option-index: +- 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. + + There may be BSP specific limits on the resolution or maximum value of a + clock tick quantum. +appl-config-option-range: | + Positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.77 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: GqXZMXycg_UHwy-SmYMFCIlzwHz8QsGCzR4tR8X85pw= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml new file mode 100644 index 00000000..1e7c4359 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINPOSIXTHREADSTACKSIZE.yml @@ -0,0 +1,31 @@ +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 two times the value of + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE <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. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.102 +links: +- RTEMS-ACFG-POSIX: bSf7xgvXVpy1u_mxP7Fk8qCHwxGCpkc9LrwgT9RzWSY= +normative: true +ref: '' +reviewed: lb4vc8b3jIDwHcVrQhPijTl5875G0kxkzw5mnMy-Jp8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml new file mode 100644 index 00000000..73ac9ac0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml @@ -0,0 +1,50 @@ +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-description: | + This configuration parameter 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>`). + + 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 + stacks. However, this must be done with caution as it could increase the + possibility of a blown task stack. + + This parameter can be used to increase the minimum from that + recommended. This can be used in higher memory systems to reduce the risk + of stack overflow without performing analysis on actual consumption. + + 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>` + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.78 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: e_hpc4Dbm4NalBY8FjE7kEjFme9Q5n0ETd6mp6TGTKU= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml new file mode 100644 index 00000000..c554d6cc --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPAPPL.yml @@ -0,0 +1,32 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + This configuration parameter must be defined to indicate that the + application intends to be part of a multiprocessing + configuration. Additional configuration parameters are assumed to be + provided. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_MP_APPLICATION +appl-config-option-notes: | + This has no impact unless RTEMS was built with the + ``--enable-multiprocessing`` build configuration option. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.89 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: B6AGbeDcGdyhJrG52n8r1M79D9wDZ8eoc-aiq11jlbk= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml new file mode 100644 index 00000000..bbeca34f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXGLOBALOBJECTS.yml @@ -0,0 +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 32. +appl-config-option-description: | + ``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.90' +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: D5uiel3qAnJJ_Z4RbIstAGedNwHLWPVIlLUf9iQbOD0= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml new file mode 100644 index 00000000..6219f2ce --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXNODES.yml @@ -0,0 +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 2. +appl-config-option-description: | + ``CONFIGURE_MP_MAXIMUM_NODES`` is 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.91 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: XGuWe2AajRXlpzyibJePbXxwZP_AqDFWKn-9rjwxJac= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml new file mode 100644 index 00000000..a1343426 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMAXPROXIES.yml @@ -0,0 +1,32 @@ +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-description: | + ``CONFIGURE_MP_MAXIMUM_PROXIES`` is 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: | + Since a proxy is used to represent a remote task/thread which is blocking + on this node. This configuration parameter reflects the maximum number of + remote tasks/threads which can be blocked on objects on this node, see + :ref:`MPCIProxies`. +appl-config-option-range: | + Undefined or positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.92 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: WCnxqy2N_5SCpuNKhJjw1ONhBbirPDP_lqNYKhBxi2I= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml new file mode 100644 index 00000000..69ef8498 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPMPCITABLEPOINTER.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + pointer to ``rtems_mpci_table`` +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_MP_MPCI_TABLE_POINTER`` is the pointer to the MPCI + Configuration Table. The default value of this field is``&MPCI_table``. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_MP_MPCI_TABLE_POINTER +appl-config-option-notes: | + RTEMS provides a Shared Memory MPCI Device Driver which can be used on any + Multiprocessor System assuming the BSP provides the proper set of + supporting methods. +appl-config-option-range: | + undefined or valid pointer +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.93 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: RMAEVgTOEMRezZmsqqRIACmHFRrFWISZNrgHtqrlhdo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml new file mode 100644 index 00000000..36908a89 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MPNODENUMBER.yml @@ -0,0 +1,33 @@ +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-description: | + ``CONFIGURE_MP_NODE_NUMBER`` is 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: | + In the RTEMS Multiprocessing Test Suite, the node number is derived from + the Makefile variable ``NODE_NUMBER``. The same code is compiled with the + ``NODE_NUMBER`` set to different values. The test programs behave + differently based upon their node number. +appl-config-option-range: | + Positive. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.94 +links: +- RTEMS-ACFG-MPCI: xehdBGNzB079tXh4oemnIjNyYffD-9n2YPdqHwfn7Hs= +normative: true +ref: '' +reviewed: c_GhzbTIhMr101CMwBtw9TIVbjJCherlfcVT6GkdDiI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml new file mode 100644 index 00000000..ae37deeb --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADENTRYPOINT.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + POSIX thread function pointer (``void *(*entry_point)(void *)``). +appl-config-option-default-value: | + The default value is ``POSIX_Init``. +appl-config-option-description: | + ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT`` is the entry point + (a.k.a. function name) of the single initialization thread defined by the + POSIX API Initialization Threads Table. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT +appl-config-option-notes: | + The user must implement the function ``POSIX_Init`` or the function name + provided in this configuration parameter. +appl-config-option-range: | + Undefined or a valid POSIX thread function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.103 +links: +- RTEMS-ACFG-POSIXINIT: oVe3LoIfxgyisYoH0mXl_PoC1X2Xc1QXF4i_e4KWRpQ= +normative: true +ref: '' +reviewed: DQ4BSvYaOd9dbm_wG9baBImQCTqf8FqfG6MFJ7ZMWyE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml new file mode 100644 index 00000000..8593c62c --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADSTACKSIZE.yml @@ -0,0 +1,33 @@ +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-description: | + ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE`` is the stack size of the single + initialization thread defined by the POSIX API Initialization Threads + Table. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.104 +links: +- RTEMS-ACFG-POSIXINIT: oVe3LoIfxgyisYoH0mXl_PoC1X2Xc1QXF4i_e4KWRpQ= +normative: true +ref: '' +reviewed: RpptUB-m1nWQihqz0jz-rW_GDQRVT4UNu887xmupW-I= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml new file mode 100644 index 00000000..d4e4e6b9 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-POSIXINITTHREADTABLE.yml @@ -0,0 +1,40 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This field is not defined by default, as the user MUST select their own API + for initialization tasks. +appl-config-option-description: | + ``CONFIGURE_POSIX_INIT_THREAD_TABLE`` is defined if the user wishes to use + a POSIX API Initialization Threads Table. The table built by + ``<rtems/confdefs.h>`` specifies the parameters for a single thread. This + is sufficient for applications which initialization the system from a + single task. + + By default, this field is not defined as the user MUST select their own API + for initialization tasks. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_POSIX_INIT_THREAD_TABLE +appl-config-option-notes: | + The application may choose to use the initialization tasks or threads table + from another API. + + A compile time error will be generated if the user does not configure any + initialization tasks or threads. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.105 +links: +- RTEMS-ACFG-POSIXINIT: oVe3LoIfxgyisYoH0mXl_PoC1X2Xc1QXF4i_e4KWRpQ= +normative: true +ref: '' +reviewed: PJX5K8XryB0Bh4_e-_llPkPmy42EOQy5xEePVVCuhIE= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml new file mode 100644 index 00000000..502bbda2 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDEXTENSIONSENABLED.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS + <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the + record extensions are enabled. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_RECORD_EXTENSIONS_ENABLED +appl-config-option-notes: | + The record extensions capture thread create, start, restart, delete, + switch, begin, exitted and terminate events. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.47 +links: +- RTEMS-ACFG-EVENTRECORD: 3xKeMAkaU2zxzN9UNmZQkb0frJf6VDZIRj25tOsaTj0= +normative: true +ref: '' +reviewed: qI6MsDjXn4xTIYt72JHL_vvy1f8Yq9A77D85In8HmLc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml new file mode 100644 index 00000000..76c91488 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RECORDPERPROCESSORITEMS.yml @@ -0,0 +1,30 @@ +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-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>`). +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.48 +links: +- RTEMS-ACFG-EVENTRECORD: 3xKeMAkaU2zxzN9UNmZQkb0frJf6VDZIRj25tOsaTj0= +normative: true +ref: '' +reviewed: MdiQNRkOJS8RnwGzGcBoMPq3hGjkweX4PnMxDCAg6ng= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml new file mode 100644 index 00000000..b147f579 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-RTEMSINITTASKSTABLE.yml @@ -0,0 +1,39 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` is defined if the user wishes to use a + Classic RTEMS API Initialization Task Table. The table built by + ``<rtems/confdefs.h>`` specifies the parameters for a single task. This is + sufficient for applications which initialization the system from a single + task. + + By default, this field is not defined as the user MUST select their own API + for initialization tasks. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_RTEMS_INIT_TASKS_TABLE +appl-config-option-notes: | + The application may choose to use the initialization tasks or threads table + from another API. + + A compile time error will be generated if the user does not configure any + initialization tasks or threads. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.31 +links: +- RTEMS-ACFG-CLASSICINIT: pl9Xp1_wCb3lJBR4Q6dEqZUfxqQWWbUDnEt6SKh38LQ= +normative: true +ref: '' +reviewed: tiYa1wK_VBtrW1-IRTub_fZ9M5wIwYBUS-KKyKgRVxA= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml new file mode 100644 index 00000000..ac7d8d11 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERCBS.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Constant Bandwidth Server (CBS) Scheduler + <SchedulerCBS>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_CBS +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for exactly one processor. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.106 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: lHXDuhkTzlOgm1r9q275WNvH4-cznp1arVrorxWLWao= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml new file mode 100644 index 00000000..03f543d1 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDF.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Earliest Deadline First (EDF) Scheduler + <SchedulerEDF>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_EDF +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for exactly one processor. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.107 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: 3F6zKqp_sbsJg7MOxooLQM9Fb-2prl9Bz6vjuRnSbRI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml new file mode 100644 index 00000000..42a88858 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULEREDFSMP.yml @@ -0,0 +1,41 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler + <SchedulerSMPEDF>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_EDF_SMP +appl-config-option-notes: | + 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. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for up to 32 processors. + + This scheduler algorithm is the default in SMP configurations if + :ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>` is + greater than one. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.108 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: XHpNHpf6LlWIddjLaMlq2JzUf2RtFtAUP1hlrl-XcKc= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml new file mode 100644 index 00000000..4d335c60 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERNAME.yml @@ -0,0 +1,39 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + RTEMS Name (``rtems_name``). +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>`. +appl-config-option-description: | + Schedulers can be identified via ``rtems_scheduler_ident``. The name of + the scheduler is determined by the configuration. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.109 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: FtsEqJcF_tYCxRGUsTJ1wmnjaQE9PlZgnu0b01xSe0U= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml new file mode 100644 index 00000000..c5dad3ce --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITY.yml @@ -0,0 +1,43 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is defined by default. This is the default scheduler and specifying + this configuration parameter is redundant. +appl-config-option-description: | + If defined, then the :ref:`Deterministic Priority Scheduler + <SchedulerPriority>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for exactly one processor. + + This scheduler algorithm is the default when + :ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>` is + exactly one. + + The memory allocated for this scheduler depends on the + :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 2010 Gedare Bloom +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.110' +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: kTe7QM8SgueRgDB3BkZXJUcN5xAD4fKr-MOaojql7tA= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml new file mode 100644 index 00000000..4a60069d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYAFFINITYSMP.yml @@ -0,0 +1,41 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Arbitrary Processor Affinity SMP Scheduler + <SchedulerSMPPriorityAffinity>` algorithm is made available to the + application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP +appl-config-option-notes: | + 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. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for up to 32 processors. + + The memory allocated for this scheduler depends on the + :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.111 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: YTbdJKcoyzB4zyR1WLkD4K31OKZyl2_nYF0IayYBZ6Y= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml new file mode 100644 index 00000000..5c5b4cf8 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERPRIORITYSMP.yml @@ -0,0 +1,40 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Deterministic Priority SMP Scheduler + <SchedulerSMPPriority>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_PRIORITY_SMP +appl-config-option-notes: | + 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. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for up to 32 processors. + + The memory allocated for this scheduler depends on the + :ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.112 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: -6i1Yw_5QeVO427vz-uCSgrX8-aaS6PyarQjN583mOA= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml new file mode 100644 index 00000000..ff9d5147 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLE.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Simple Priority Scheduler + <SchedulerPrioritySimple>` algorithm is made available to the application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_SIMPLE +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for exactly one processor. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.113 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: sgby0C78hBSvNZfhjERWqy4FW8mrrofL7bLhJskyWT0= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml new file mode 100644 index 00000000..1bddfdfd --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERSIMPLESMP.yml @@ -0,0 +1,38 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + If defined, then the :ref:`Simple Priority SMP Scheduler + <SchedulerSMPPrioritySimple>` algorithm is made available to the + application. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_SIMPLE_SMP +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. + + In case no explicit :ref:`clustered scheduler configuration + <ConfigurationSchedulersClustered>` is present, then it is used as the + scheduler for up to 32 processors. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.114 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: 2uO_iEFGg5nhsJmtg5WyTv0Sf33uWfyEHZrZy64MBuQ= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml new file mode 100644 index 00000000..f4af6697 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SCHEDULERUSER.yml @@ -0,0 +1,50 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + RTEMS allows the application to provide its own task/thread scheduling + algorithm. In order to do this, one must define + ``CONFIGURE_SCHEDULER_USER`` to indicate the application provides its own + scheduling algorithm. If ``CONFIGURE_SCHEDULER_USER`` is defined then the + following additional macros must be defined: + + - ``CONFIGURE_SCHEDULER`` must be defined to a static definition of + the scheduler data structures of the user scheduler. + + - ``CONFIGURE_SCHEDULER_TABLE_ENTRIES`` must be defined to a scheduler + table entry initializer for the user scheduler. + + - ``CONFIGURE_SCHEDULER_USER_PER_THREAD`` must be defined to the type of + the per-thread information of the user scheduler. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_SCHEDULER_USER +appl-config-option-notes: | + This scheduler configuration option is an advanced configuration option. + Think twice before you use it. + + At this time, the mechanics and requirements for writing a new scheduler + are evolving and not fully documented. It is recommended that you look at + the existing Deterministic Priority Scheduler in + ``cpukit/score/src/schedulerpriority*.c`` for guidance. For guidance on + the configuration macros, please examine ``cpukit/sapi/include/confdefs.h`` + for how these are defined for the Deterministic Priority Scheduler. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 2010 Gedare Bloom +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.115 +links: +- RTEMS-ACFG-SCHEDGENERAL: rc4sMdWxd5qw88Gl1zfZxhSAF4EJ3mvQOTYVBtVHtRc= +normative: true +ref: '' +reviewed: aBtV4yCQ4gYyyfQ1gGrXaHklIh7fJAsI4iQe9KGnD7E= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml new file mode 100644 index 00000000..3c8aa992 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-STACKCHECKERENABLED.yml @@ -0,0 +1,32 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default, and thus stack checking is disabled. +appl-config-option-description: | + This configuration parameter is defined when the application wishes to + enable run-time stack bounds checking. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_STACK_CHECKER_ENABLED +appl-config-option-notes: | + In 4.9 and older, this configuration parameter was named ``STACK_CHECKER_ON``. + + This increases the time required to create tasks as well as adding overhead + to each context switch. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.79 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: oQczTVsafGtaaeNZ_cRs7tkFGeXNI7M78k7m40NQVSg= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml new file mode 100644 index 00000000..4338793d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTBLOCKHOLD.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.9 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: lkIL_5ugKUc2dxvt7_VBgZI_QGcY8CXor-8U8tczqUo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml new file mode 100644 index 00000000..62876325 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTSWAPPERIOD.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.10' +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: -lZZxdhpjBmpMCsli_GUGyDB6RL75zJHhjBrzbwnyu8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml new file mode 100644 index 00000000..1209becf --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTTASKPRIORITY.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.11 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: MmXcrO7g0bTVem0meybginGwTz4KvgI4SAWFTo_tO_4= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml new file mode 100644 index 00000000..5ca49571 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKPRIORITY.yml @@ -0,0 +1,28 @@ +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-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.12 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: 9LMgY3ssxEKNPIxbn_qcrhcv7ftAF_lXmGx0YCgSqeY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml new file mode 100644 index 00000000..cde5879f --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-SWAPOUTWORKERTASKS.yml @@ -0,0 +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 0. +appl-config-option-description: | + 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.13 +links: +- RTEMS-ACFG-BDBUF: zcZaMkFYCeiO06I2a44TA1UsUbHOcxyH3xxhSH_pntk= +normative: true +ref: '' +reviewed: vJb_StTQzOl6rh7ls8xC8T6eJr9sBcDVW_oQmgoow3E= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml new file mode 100644 index 00000000..91945453 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATOR.yml @@ -0,0 +1,37 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Function pointer. +appl-config-option-default-value: | + The default value is ``_Workspace_Allocate``, which indicates that task + stacks will be allocated from the RTEMS Workspace. +appl-config-option-description: | + ``CONFIGURE_TASK_STACK_ALLOCATOR`` may point to a user provided routine to + allocate task stacks. +appl-config-option-index: +- task stack allocator +appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR +appl-config-option-notes: | + A correctly configured system must configure the following to be consistent: + + - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + + - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + + - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` +appl-config-option-range: | + Undefined or valid function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.116 +links: +- RTEMS-ACFG-STACKALLOC: RinkAR6bq3NOG7L5KiFW19GxN_mHxMpEd6-axxdk-k4= +normative: true +ref: '' +reviewed: XLkmul143Ctik0B858wJI5kxJE5eYisStCSWSe4-34s= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml new file mode 100644 index 00000000..071e1f8d --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKALLOCATORINIT.yml @@ -0,0 +1,37 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Function pointer. +appl-config-option-default-value: | + The default value is NULL, which indicates that task stacks will be + allocated from the RTEMS Workspace. +appl-config-option-description: | + ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` configures the initialization + method for an application or BSP specific task stack allocation + implementation. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_TASK_STACK_ALLOCATOR_INIT +appl-config-option-notes: | + A correctly configured system must configure the following to be consistent: + + - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + + - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + + - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` +appl-config-option-range: | + Undefined, NULL or valid function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.117 +links: +- RTEMS-ACFG-STACKALLOC: RinkAR6bq3NOG7L5KiFW19GxN_mHxMpEd6-axxdk-k4= +normative: true +ref: '' +reviewed: SF03ndITkMwZXooeg1Y03N5KqDcc9vk-mykL_FCSJUo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml new file mode 100644 index 00000000..bef3d41c --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TASKSTACKDEALLOCATOR.yml @@ -0,0 +1,37 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Function pointer. +appl-config-option-default-value: | + The default value is ``_Workspace_Free``, which indicates that task stacks + will be allocated from the RTEMS Workspace. +appl-config-option-description: | + ``CONFIGURE_TASK_STACK_DEALLOCATOR`` may point to a user provided routine + to free task stacks. +appl-config-option-index: +- task stack deallocator +appl-config-option-name: CONFIGURE_TASK_STACK_DEALLOCATOR +appl-config-option-notes: | + A correctly configured system must configure the following to be consistent: + + - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + + - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + + - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` +appl-config-option-range: | + Undefined or valid function pointer. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.118 +links: +- RTEMS-ACFG-STACKALLOC: RinkAR6bq3NOG7L5KiFW19GxN_mHxMpEd6-axxdk-k4= +normative: true +ref: '' +reviewed: YdVw4bEfKr_GbwiZ3Aq3BIMyoxngs02n3fWxP0sYowY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml new file mode 100644 index 00000000..a89d7f4a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-TICKSPERTIMESLICE.yml @@ -0,0 +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 50. +appl-config-option-description: | + This configuration parameter specifies 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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: '1.80' +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: NmY32-mz-jb6c2dLU8A6TV1nziypzi98knOtx7MrELQ= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml new file mode 100644 index 00000000..897033a0 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNIFIEDWORKAREAS.yml @@ -0,0 +1,45 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default, which specifies that the C Program Heap and + the RTEMS Workspace will be separate. +appl-config-option-description: | + When defined, the C Program Heap and the RTEMS Workspace will be one pool + of memory. + + When not defined, there will be separate memory pools for the RTEMS + Workspace and C Program Heap. +appl-config-option-index: +- unified work areas +- separate work areas +- RTEMS Workspace +- C Program Heap +appl-config-option-name: CONFIGURE_UNIFIED_WORK_AREAS +appl-config-option-notes: | + Having separate pools does have some advantages in the event a task blows a + stack or writes outside its memory area. However, in low memory systems the + overhead of the two pools plus the potential for unused memory in either + pool is very undesirable. + + In high memory environments, this is desirable when you want to use the + RTEMS "unlimited" objects option. You will be able to create objects until + you run out of all available memory rather then just until you run out of + RTEMS Workspace. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.81 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: PqTU6ij1_U1chCGHDGT52FynYIcRxkKX70R0aSy8v78= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml new file mode 100644 index 00000000..8404a23a --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDALLOCATIONSIZE.yml @@ -0,0 +1,35 @@ +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-description: | + ``CONFIGURE_UNLIMITED_ALLOCATION_SIZE`` provides an allocation size to use + for ``rtems_resource_unlimited`` when using + ``CONFIGURE_UNLIMITED_OBJECTS``. +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. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.82 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: QNMi21v3JbyxxnNzVWeiQ4KUIVtZAO7pb3Df6KRBNU8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml new file mode 100644 index 00000000..bbffda71 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-UNLIMITEDOBJECTS.yml @@ -0,0 +1,32 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + ``CONFIGURE_UNLIMITED_OBJECTS`` enables ``rtems_resource_unlimited`` mode + for Classic API and POSIX API objects that do not already have a specific + maximum limit defined. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_UNLIMITED_OBJECTS +appl-config-option-notes: | + When using unlimited objects, it is common practice to also specify + ``CONFIGURE_UNIFIED_WORK_AREAS`` so the system operates with a single pool + of memory for both RTEMS and application memory allocations. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.83 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: yWeZLUOGPPf3aOctQGi46Xb0wjX-jcxKl8CIV0sPeUI= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml new file mode 100644 index 00000000..5ae11762 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-USEDEVFSASBASEFILESYSTEM.yml @@ -0,0 +1,34 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. If no other root file system configuration + parameters are specified, the IMFS will be used as the root file system. +appl-config-option-description: | + This configuration parameter is defined if the application wishes to use + the device-only filesytem as the root file system. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM +appl-config-option-notes: | + The device-only filesystem supports only device nodes and is smaller in + executable code size than the full IMFS and miniIMFS. + + The devFS is comparable in functionality to the pseudo-filesystem name + space provided before RTEMS release 4.5.0. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.65 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: O_eKgQVt3pnNoaQu79QoyR3fQwkhM57DTxh4TOiBqHo= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml new file mode 100644 index 00000000..ce1af24c --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-USEMINIIMFSASBASEFILESYSTEM.yml @@ -0,0 +1,45 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. +appl-config-option-description: | + In case this configuration option is defined, then the following + configuration options will be defined as well + + - ``CONFIGURE_IMFS_DISABLE_CHMOD``, + + - ``CONFIGURE_IMFS_DISABLE_CHOWN``, + + - ``CONFIGURE_IMFS_DISABLE_UTIME``, + + - ``CONFIGURE_IMFS_DISABLE_LINK``, + + - ``CONFIGURE_IMFS_DISABLE_SYMLINK``, + + - ``CONFIGURE_IMFS_DISABLE_READLINK``, + + - ``CONFIGURE_IMFS_DISABLE_RENAME``, and + + - ``CONFIGURE_IMFS_DISABLE_UNMOUNT``. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM +appl-config-option-notes: | + None. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.66 +links: +- RTEMS-ACFG-FILESYSTEM: 9RfguldyRuN5UR-zcLUoiTYBDzow1fnI4B_ZnP_UyKk= +normative: true +ref: '' +reviewed: Zai0TYTNhPKsaFNnhj-QjSzEeKGkS-cXU2R-h-p-MRY= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml new file mode 100644 index 00000000..c2ebcbb1 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-VERBOSESYSTEMINIT.yml @@ -0,0 +1,31 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default, and thus the system initialization is + quiet. +appl-config-option-description: | + This configuration option enables to print some information during system + initialization. +appl-config-option-index: [] +appl-config-option-name: CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION +appl-config-option-notes: | + You may use this feature to debug system initialization issues. The + printk() function is used to print the information. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.84 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: K9XYyK0XIggO2DNvBAg1Ycr2cRB0tTygG9XCeg5ezN8= +text: '' +type: interface diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml new file mode 100644 index 00000000..4b26f917 --- /dev/null +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-ZEROWORKSPACEAUTOMATICALLY.yml @@ -0,0 +1,38 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +active: true +appl-config-option-data-type: | + Boolean feature macro. +appl-config-option-default-value: | + This is not defined by default. The default is *NOT* to zero out the RTEMS + Workspace or C Program Heap. +appl-config-option-description: | + This macro indicates whether RTEMS should zero the RTEMS Workspace and C + Program Heap as part of its initialization. If defined, the memory regions + are zeroed. Otherwise, they are not. +appl-config-option-index: +- clear C Program Heap +- clear RTEMS Workspace +- zero C Program Heap +- zero RTEMS Workspace +appl-config-option-name: CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY +appl-config-option-notes: | + Zeroing memory can add significantly to system boot time. It is not + necessary for RTEMS but is often assumed by support libraries. In case + :ref:`CONFIGURE_DIRTY_MEMORY` is also defined, then the memory is first + dirtied and then zeroed. +appl-config-option-range: | + Defined or undefined. +copyrights: +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +derived: false +enabled-by: [] +header: '' +interface-type: appl-config-option +level: 1.85 +links: +- RTEMS-ACFG-GENERAL: B6rbi_eXOZOzB3o8-DYzrc0JmF7ON1adlcZj3dQd6WY= +normative: true +ref: '' +reviewed: cnRoQA_n0AgYhv7sS3FAQuH4WIy-3GPa_65voEJ8ivU= +text: '' +type: interface |