diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-11-17 08:46:56 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2022-08-31 11:38:37 +0200 |
commit | cf9f2121577b11f8eab5e49c48173c46cf09c627 (patch) | |
tree | 23005dcdfd86cec60f8da71478c3cd661e493cb2 /c-user/config/general.rst | |
parent | commands: Add 'rtems' command (diff) | |
download | rtems-docs-cf9f2121577b11f8eab5e49c48173c46cf09c627.tar.bz2 |
c-user: Clarify BSP related configuration settings
Diffstat (limited to 'c-user/config/general.rst')
-rw-r--r-- | c-user/config/general.rst | 60 |
1 files changed, 56 insertions, 4 deletions
diff --git a/c-user/config/general.rst b/c-user/config/general.rst index fa43686..c80d162 100644 --- a/c-user/config/general.rst +++ b/c-user/config/general.rst @@ -67,6 +67,55 @@ memory is first dirtied and then zeroed. See also :ref:`CONFIGURE_MALLOC_DIRTY`. +.. Generated from spec:/acfg/if/disable-bsp-settings + +.. raw:: latex + + \clearpage + +.. index:: CONFIGURE_DISABLE_BSP_SETTINGS + +.. _CONFIGURE_DISABLE_BSP_SETTINGS: + +CONFIGURE_DISABLE_BSP_SETTINGS +------------------------------ + +.. rubric:: CONSTANT: + +``CONFIGURE_DISABLE_BSP_SETTINGS`` + +.. rubric:: OPTION TYPE: + +This configuration option is a boolean feature define. + +.. rubric:: DEFAULT CONFIGURATION: + +If this configuration option is undefined, then the described feature is not +enabled. + +.. rubric:: DESCRIPTION: + +In case this configuration option is defined, then the optional BSP provided +settings listed below are disabled. + +The optional BSP provided default values for the following application +configuration options are disabled: + +* :ref:`CONFIGURE_IDLE_TASK_BODY` + +* :ref:`CONFIGURE_IDLE_TASK_STACK_SIZE` + +* :ref:`CONFIGURE_INTERRUPT_STACK_SIZE` + +The optional BSP provided initial extension set is disabled (see +:term:`initial extension sets`). The optional BSP provided +prerequisite IO device drivers are disabled (see +Device Driver Configuration). The optional BSP provided support for +:c:func:`sbrk` is disabled. + +This configuration option provides an all or nothing choice with respect to +the optional BSP provided settings. + .. Generated from spec:/acfg/if/disable-newlib-reentrancy .. raw:: latex @@ -237,8 +286,8 @@ initial user extensions. .. rubric:: NOTES: The value of this configuration option is placed before the entries of -:ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial -user extensions. +:c:macro:`BSP_INITIAL_EXTENSION` and after the entries of all other +initial user extensions. .. rubric:: CONSTRAINTS: @@ -269,8 +318,11 @@ This configuration option is an integer define. .. rubric:: DEFAULT VALUE: -The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined, -otherwise the default value is :c:macro:`CPU_STACK_MINIMUM_SIZE`. +If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and +:c:macro:`BSP_INTERRUPT_STACK_SIZE` is provided by the +:term:`BSP`, then the default value is defined by +:c:macro:`BSP_INTERRUPT_STACK_SIZE`, otherwise the default value is +:c:macro:`CPU_STACK_MINIMUM_SIZE`. .. rubric:: DESCRIPTION: |