diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-30 11:04:25 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-30 11:05:03 +0200 |
commit | 6a2e34923045d9d5c7a23ad14bba40964bb44695 (patch) | |
tree | 24638c5118e520d198b5522d2babb5b69c2d6c5b /spec/acfg/opt | |
parent | 86db7a32dba6745f8d03bec9f989ea76d0357719 (diff) |
spec: Canonicalize integer options
Diffstat (limited to '')
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml | 10 | ||||
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml | 10 | ||||
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml | 10 | ||||
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml | 2 | ||||
-rw-r--r-- | spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml | 4 |
5 files changed, 19 insertions, 17 deletions
diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml index 932075b7..4661d336 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKINITAPPL.yml @@ -6,21 +6,21 @@ appl-config-option-default: | provide one or more initialization tasks. appl-config-option-description: | This configuration option is defined to indicate that the user has configured - **no** user initialization tasks or threads and that the user provided idle + **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. + an IDLE task. appl-config-option-index: [] appl-config-option-name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION appl-config-option-notes: | - If you use this option be careful, the user idle task **cannot** block at all + If you use this option be careful, the user IDLE task **cannot** block at all during the initialization sequence. Further, once application initialization is complete, it must make itself preemptible and enter an idle body loop. - The idle task must run at the lowest priority of all tasks in the system. + The IDLE task must run at the lowest priority of all tasks in the system. If this configuration option is defined, then it is mandatory to configure a - user idle task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option, + user IDLE task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option, otherwise a compile time error in the configuration file will occur. The application must define exactly one of the following configuration diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml index c06bd2d3..f08114e7 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-IDLETASKSTACKSIZE.yml @@ -4,17 +4,19 @@ appl-config-option-type: integer appl-config-option-default-value: '``RTEMS_MINIMUM_STACK_SIZE``' appl-config-option-description: | The value of this configuration option defines the task stack size for an - idle task. + IDLE task. appl-config-option-index: [] appl-config-option-name: CONFIGURE_IDLE_TASK_STACK_SIZE appl-config-option-notes: | - In SMP configurations, there is one idle task per configured processor, see + In SMP configurations, there is one IDLE task per configured processor, see :ref:`CONFIGURE_MAXIMUM_PROCESSORS`. appl-config-option-constraint: - min: 0 custom: - | - It must be small enough so that the idle task stack area calculation + 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: diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml index d9ccfa4e..9b0d269c 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-INTERRUPTSTACKSIZE.yml @@ -32,12 +32,12 @@ appl-config-option-notes: | appl-config-option-constraint: custom: - | - The system does not ensure a minimum size. The minimum size is - BSP-specific and application-specific. + It must be greater than or equal to a BSP-specific and application-specific + minimum value. - | - It must be small enough so that the interrupt stack requirements - calculation carried out by ``<rtems/confdefs.h>`` does not overflow an - integer of type ``size_t``. + 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 diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml index 2886f593..7d8d4266 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MAXPROCESSORS.yml @@ -7,7 +7,7 @@ appl-config-option-description: | 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. + Each processor needs an IDLE task stack and interrupt stack for example. appl-config-option-index: [] appl-config-option-name: CONFIGURE_MAXIMUM_PROCESSORS appl-config-option-notes: | diff --git a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml index 44f1a35b..762af8ab 100644 --- a/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml +++ b/spec/acfg/opt/RTEMS-ACFG-OPT-MINTASKSTACKSIZE.yml @@ -32,8 +32,8 @@ appl-config-option-notes: | appl-config-option-constraint: custom: - | - The system does not ensure a minimum size. The minimum size is - BSP-specific and application-specific. + It must be greater than or equal to a BSP-specific and application-specific + minimum value. - | It must be small enough so that the task stack space calculation carried out by ``<rtems/confdefs.h>`` does not overflow an integer of type |