spec: Add BSP related config options

8 files changed, 289 insertions, 0 deletions

diff --git a/spec/acfg/RTEMS-ACFG-BSP.yml b/spec/acfg/RTEMS-ACFG-BSP.yml
new file mode 100644
index 00000000..16d6cfcc
--- /dev/null
+++ b/spec/acfg/RTEMS-ACFG-BSP.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 BSP.  Some
+  configuration options may have a BSP-specific setting which is defined by
+  ``<bsp.h>``.  The BSP-specific settings can be disabled by the
+  :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option.
+appl-config-group-name: BSP Related Configuration Options
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-group
+level: 1.17
+links:
+- RTEMS-APPLCONFIG: _UBhDG0InGYgvxZhg-cUyh3flgj_xCc4GH8Rs0qjazE=
+normative: true
+ref: ''
+reviewed: rwjX-0R-u4r1rGEOE2eY-zh80RZYwzt1bEC7_CYm5VU=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml
new file mode 100644
index 00000000..40b700ff
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKBODY.yml
@@ -0,0 +1,39 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: initializer
+appl-config-option-default-value: |
+  The default value is BSP-specific.
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then the value of this configuration option defines the default value of
+  :ref:`CONFIGURE_IDLE_TASK_BODY`.
+appl-config-option-index: []
+appl-config-option-name: BSP_IDLE_TASK_BODY
+appl-config-option-notes: |
+  As it has knowledge of the specific CPU model, system controller logic, and
+  peripheral buses, a BSP-specific IDLE task may be capable of turning
+  components off to save power during extended periods of no task activity.
+appl-config-option-constraint:
+  custom:
+  - |
+    The value of this configuration option must be defined to a valid function
+    pointer of the type ``void *( *idle_body )( uintptr_t )``.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.123
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: tQwexSVyaofV3ETvezRbUOHChUYBcMxaVp-Gg1XzKdI=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml
new file mode 100644
index 00000000..f9d8e0f7
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPIDLETASKSTACKSIZE.yml
@@ -0,0 +1,41 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: integer
+appl-config-option-default-value: |
+  The default value is BSP-specific.
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then the value of this configuration option defines the default value of
+  :ref:`CONFIGURE_IDLE_TASK_SIZE`.
+appl-config-option-index: []
+appl-config-option-name: BSP_IDLE_TASK_STACK_SIZE
+appl-config-option-notes: |
+  None.
+appl-config-option-constraint:
+  custom:
+  - |
+    It must be greater than or equal to a BSP-specific and application-specific
+    minimum value.
+  - |
+    It must be small enough so that the IDLE task stack area calculation
+    carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+    ``size_t``.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.124
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: 7pOEeaD7uYF8aVrkAtJ8NgZ5v5OuE_dMnRbuttiCX5A=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml
new file mode 100644
index 00000000..1202ab23
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINITIALEXTENSION.yml
@@ -0,0 +1,38 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: initializer
+appl-config-option-default-value: |
+  The default value is BSP-specific.
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then the value of this configuration option is used to initialize the table
+  of initial user extensions.
+appl-config-option-index: []
+appl-config-option-name: BSP_INITIAL_EXTENSION
+appl-config-option-notes: |
+  The value of this configuration option is placed after the entries of all
+  other initial user extensions.
+appl-config-option-constraint:
+  custom:
+  - |
+    The value of this configuration option must be a list of initializers for
+    structures of type :c:type:`rtems_extensions_table`.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.125
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: GnIbLfENzpNresFPNwwKix3_KZBpvoZ0F11u0YExFwo=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml
new file mode 100644
index 00000000..14947b84
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPINTERRUPTSTACKSIZE.yml
@@ -0,0 +1,41 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: integer
+appl-config-option-default-value: |
+  The default value is BSP-specific.
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then the value of this configuration option defines the default value of
+  :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`.
+appl-config-option-index: []
+appl-config-option-name: BSP_INTERRUPT_STACK_SIZE
+appl-config-option-notes: |
+  None.
+appl-config-option-constraint:
+  custom:
+  - |
+    It must be greater than or equal to a BSP-specific and application-specific
+    minimum value.
+  - |
+    It must be small enough so that the interrupt stack area calculation
+    carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type
+    ``size_t``.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.126
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: J_GQkZT6Jtrwb-LYr52tN-UvpikNSf2SYSPELlON0dA=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml
new file mode 100644
index 00000000..ac53affd
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-BSPPREREQUISITEDRIVERS.yml
@@ -0,0 +1,39 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: initializer
+appl-config-option-default-value: |
+  The default value is BSP-specific.
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then the value of this configuration option is used to initialize the table
+  of initial user extensions.
+appl-config-option-index: []
+appl-config-option-name: CONFIGURE_BSP_PREREQUISITE_DRIVERS
+appl-config-option-notes: |
+  The value of this configuration option is placed before the entries of all
+  other initial user extensions (including
+  :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`).
+appl-config-option-constraint:
+  custom:
+  - |
+    The value of this configuration option must be a list of initializers for
+    structures of type :c:type:`rtems_extensions_table`.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.128
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: O8t88Es4vkBzNEFmBwklHs6Sv5Sh8z-3S7oALxRS2ZA=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLEBSPSETTINGS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLEBSPSETTINGS.yml
new file mode 100644
index 00000000..20f480eb
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-DISABLEBSPSETTINGS.yml
@@ -0,0 +1,36 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: feature-enable
+appl-config-option-description: |
+  In case this configuration option is defined, then the following BSP related
+  configuration options are undefined:
+
+  - :ref:`BSP_IDLE_TASK_BODY`
+
+  - :ref:`BSP_IDLE_TASK_STACK_SIZE`
+
+  - :ref:`BSP_INITIAL_EXTENSION`
+
+  - :ref:`BSP_INTERRUPT_STACK_SIZE`
+
+  - :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
+
+  - :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK`
+appl-config-option-index: []
+appl-config-option-name: CONFIGURE_DISABLE_BSP_SETTINGS
+appl-config-option-notes: |
+  None.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: 1.129
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: NdV6jdrCvK6mfwAVHiZw-0ftzRA1MlxFQxX85WE2otQ=
+text: ''
+type: interface
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCBSPSUPPORTSSBRK.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCBSPSUPPORTSSBRK.yml
new file mode 100644
index 00000000..0bdbd5e6
--- /dev/null
+++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MALLOCBSPSUPPORTSSBRK.yml
@@ -0,0 +1,33 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+active: true
+appl-config-option-type: feature-enable
+appl-config-option-description: |
+  If
+
+  * this configuration option is defined by the BSP
+
+  * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
+
+  then not all memory is made available to the C Program Heap immediately at
+  system initialization time.  When :c:func:`malloc()` or other standard memory
+  allocation functions are unable to allocate memory, they will call the BSP
+  supplied :c:func:`sbrk()` function to obtain more memory.
+appl-config-option-index: []
+appl-config-option-name: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
+appl-config-option-notes: |
+  This option should not be defined by the application. Only the BSP knows how
+  it allocates memory to the C Program Heap.
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+derived: false
+enabled-by: []
+header: ''
+interface-type: appl-config-option
+level: '1.130'
+links:
+- RTEMS-ACFG-BSP: _GrDY3wCA-wZIjNaNIwqZBM6OrMLGu0_LLx2H-VYSyA=
+normative: true
+ref: ''
+reviewed: -pt7FJTxjn5rpQP-H-sIahLJqTBj6y93GfUWxLYW9No=
+text: ''
+type: interface