Changeset cf9f212 in rtems-docs


Ignore:
Timestamp:
11/17/21 07:46:56 (13 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
4f9e9e5
Parents:
f052446
git-author:
Sebastian Huber <sebastian.huber@…> (11/17/21 07:46:56)
git-committer:
Sebastian Huber <sebastian.huber@…> (08/31/22 09:38:37)
Message:

c-user: Clarify BSP related configuration settings

Location:
c-user/config
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/device-driver.rst

    rf052446 rcf9f212  
    710710
    711711The value of this configuration option is placed after the entries defined by
    712 :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` and before all other device driver
     712:c:macro:`CONFIGURE_BSP_PREREQUISITE_DRIVERS` and before all other device driver
    713713configuration options.
    714714
     
    859859* :ref:`CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS`
    860860
    861 * :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
     861If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and
     862the :term:`BSP` provides
     863:c:macro:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`, then the BSP-provided
     864prerequisite device drivers are also taken into account.
    862865
    863866.. rubric:: DESCRIPTION:
  • c-user/config/general.rst

    rf052446 rcf9f212  
    6868See also :ref:`CONFIGURE_MALLOC_DIRTY`.
    6969
     70.. Generated from spec:/acfg/if/disable-bsp-settings
     71
     72.. raw:: latex
     73
     74    \clearpage
     75
     76.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
     77
     78.. _CONFIGURE_DISABLE_BSP_SETTINGS:
     79
     80CONFIGURE_DISABLE_BSP_SETTINGS
     81------------------------------
     82
     83.. rubric:: CONSTANT:
     84
     85``CONFIGURE_DISABLE_BSP_SETTINGS``
     86
     87.. rubric:: OPTION TYPE:
     88
     89This configuration option is a boolean feature define.
     90
     91.. rubric:: DEFAULT CONFIGURATION:
     92
     93If this configuration option is undefined, then the described feature is not
     94enabled.
     95
     96.. rubric:: DESCRIPTION:
     97
     98In case this configuration option is defined, then the optional BSP provided
     99settings listed below are disabled.
     100
     101The optional BSP provided default values for the following application
     102configuration options are disabled:
     103
     104* :ref:`CONFIGURE_IDLE_TASK_BODY`
     105
     106* :ref:`CONFIGURE_IDLE_TASK_STACK_SIZE`
     107
     108* :ref:`CONFIGURE_INTERRUPT_STACK_SIZE`
     109
     110The optional BSP provided initial extension set is disabled (see
     111:term:`initial extension sets`).  The optional BSP provided
     112prerequisite IO device drivers are disabled (see
     113Device Driver Configuration).  The optional BSP provided support for
     114:c:func:`sbrk` is disabled.
     115
     116This configuration option provides an all or nothing choice with respect to
     117the optional BSP provided settings.
     118
    70119.. Generated from spec:/acfg/if/disable-newlib-reentrancy
    71120
     
    238287
    239288The value of this configuration option is placed before the entries of
    240 :ref:`BSP_INITIAL_EXTENSION` and after the entries of all other initial
    241 user extensions.
     289:c:macro:`BSP_INITIAL_EXTENSION` and after the entries of all other
     290initial user extensions.
    242291
    243292.. rubric:: CONSTRAINTS:
     
    270319.. rubric:: DEFAULT VALUE:
    271320
    272 The default value is :ref:`BSP_INTERRUPT_STACK_SIZE` in case it is defined,
    273 otherwise the default value is :c:macro:`CPU_STACK_MINIMUM_SIZE`.
     321If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and
     322:c:macro:`BSP_INTERRUPT_STACK_SIZE` is provided by the
     323:term:`BSP`, then the default value is defined by
     324:c:macro:`BSP_INTERRUPT_STACK_SIZE`, otherwise the default value is
     325:c:macro:`CPU_STACK_MINIMUM_SIZE`.
    274326
    275327.. rubric:: DESCRIPTION:
  • c-user/config/idle-task.rst

    rf052446 rcf9f212  
    4949.. rubric:: DEFAULT VALUE:
    5050
    51 If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value,
    52 otherwise the default value is ``_CPU_Thread_Idle_body``.
     51If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and
     52:c:macro:`BSP_IDLE_TASK_BODY` is provided by the
     53:term:`BSP`, then the default value is defined by
     54:c:macro:`BSP_IDLE_TASK_BODY`, otherwise the default value is
     55``_CPU_Thread_Idle_body``.
    5356
    5457.. rubric:: DESCRIPTION:
     
    6467IDLE threads can be used to initialize the application, see configuration
    6568option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`.
     69
     70The BSP may have knowledge of the specific CPU model, system controller
     71logic, and peripheral buses, so a BSP-specific IDLE task may be capable of
     72turning components off to save power during extended periods of no task
     73activity.
    6674
    6775.. rubric:: CONSTRAINTS:
     
    150158.. rubric:: DEFAULT VALUE:
    151159
    152 The default value is :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
     160If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and
     161:c:macro:`BSP_IDLE_TASK_STACK_SIZE` is provided by the
     162:term:`BSP`, then the default value is defined by
     163:c:macro:`BSP_IDLE_TASK_STACK_SIZE`, otherwise the default value is
     164defined by the :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` configuration option.
    153165
    154166.. rubric:: DESCRIPTION:
Note: See TracChangeset for help on using the changeset viewer.