Changeset 4bb586b in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:53:10 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
38032b0
Parents:
1af97ad
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:53:10)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:19:25)
Message:

c-user: Move "BSP Related Configuration Options"

Update #3836.

Location:
c-user/config
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/index.rst

    r1af97ad r4bb586b  
    2222    filesystem
    2323    bdbuf
    24 
    25 BSP Related Configuration Options
    26 =================================
    27 
    28 This section describes configuration options related to the BSP.  Some
    29 configuration options may have a BSP-specific setting which is defined by
    30 ``<bsp.h>``.  The BSP-specific settings can be disabled by the
    31 :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option.
    32 
    33 .. index:: BSP_IDLE_TASK_BODY
    34 
    35 .. _BSP_IDLE_TASK_BODY:
    36 
    37 BSP_IDLE_TASK_BODY
    38 ------------------
    39 
    40 CONSTANT:
    41     ``BSP_IDLE_TASK_BODY``
    42 
    43 DATA TYPE:
    44     Function pointer.
    45 
    46 RANGE:
    47     Undefined or valid function pointer.
    48 
    49 DEFAULT VALUE:
    50     This option is BSP specific.
    51 
    52 DESCRIPTION:
    53     If ``BSP_IDLE_TASK_BODY`` is defined by the BSP and
    54     ``CONFIGURE_IDLE_TASK_BODY`` is not defined by the application, then this
    55     BSP specific idle task body will be used.
    56 
    57 NOTES:
    58     As it has knowledge of the specific CPU model, system controller logic, and
    59     peripheral buses, a BSP specific IDLE task may be capable of turning
    60     components off to save power during extended periods of no task activity
    61 
    62 .. index:: BSP_IDLE_TASK_STACK_SIZE
    63 
    64 .. _BSP_IDLE_TASK_STACK_SIZE:
    65 
    66 BSP_IDLE_TASK_STACK_SIZE
    67 ------------------------
    68 
    69 CONSTANT:
    70     ``BSP_IDLE_TASK_STACK_SIZE``
    71 
    72 DATA TYPE:
    73     Unsigned integer (``size_t``).
    74 
    75 RANGE:
    76     Undefined or positive.
    77 
    78 DEFAULT VALUE:
    79     This option is BSP specific.
    80 
    81 DESCRIPTION:
    82     If ``BSP_IDLE_TASK_STACK_SIZE`` is defined by the BSP and
    83     ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is not defined by the application, then
    84     this BSP suggested idle task stack size will be used.
    85 
    86 NOTES:
    87     The order of precedence for configuring the IDLE task stack size is:
    88 
    89     - RTEMS default minimum stack size.
    90 
    91     - If defined, then ``CONFIGURE_MINIMUM_TASK_STACK_SIZE``.
    92 
    93     - If defined, then the BSP specific ``BSP_IDLE_TASK_SIZE``.
    94 
    95     - If defined, then the application specified ``CONFIGURE_IDLE_TASK_SIZE``.
    96 
    97 .. index:: BSP_INITIAL_EXTENSION
    98 
    99 .. _BSP_INITIAL_EXTENSION:
    100 
    101 BSP_INITIAL_EXTENSION
    102 ---------------------
    103 
    104 CONSTANT:
    105     ``BSP_INITIAL_EXTENSION``
    106 
    107 DATA TYPE:
    108     List of user extension initializers (``rtems_extensions_table``).
    109 
    110 RANGE:
    111     Undefined or a list of user extension initializers.
    112 
    113 DEFAULT VALUE:
    114     This option is BSP specific.
    115 
    116 DESCRIPTION:
    117     If ``BSP_INITIAL_EXTENSION`` is defined by the BSP, then this BSP specific
    118     initial extension will be placed as the last entry in the initial extension
    119     table.
    120 
    121 NOTES:
    122     None.
    123 
    124 .. index:: BSP_INTERRUPT_STACK_SIZE
    125 
    126 .. _BSP_INTERRUPT_STACK_SIZE:
    127 
    128 BSP_INTERRUPT_STACK_SIZE
    129 ------------------------
    130 
    131 CONSTANT:
    132     ``BSP_INTERRUPT_STACK_SIZE``
    133 
    134 DATA TYPE:
    135     Unsigned integer (``size_t``).
    136 
    137 RANGE:
    138     Undefined or positive.
    139 
    140 DEFAULT VALUE:
    141     This option is BSP specific.
    142 
    143 DESCRIPTION:
    144     If ``BSP_INTERRUPT_STACK_SIZE`` is defined by the BSP and
    145     ``CONFIGURE_INTERRUPT_STACK_SIZE`` is not defined by the application, then
    146     this BSP specific interrupt stack size will be used.
    147 
    148 NOTES:
    149     None.
    150 
    151 .. index:: BSP_MAXIMUM_DEVICES
    152 
    153 .. _BSP_MAXIMUM_DEVICES:
    154 
    155 BSP_MAXIMUM_DEVICES
    156 -------------------
    157 
    158 CONSTANT:
    159     ``BSP_MAXIMUM_DEVICES``
    160 
    161 DATA TYPE:
    162     Unsigned integer (``size_t``).
    163 
    164 RANGE:
    165     Undefined or positive.
    166 
    167 DEFAULT VALUE:
    168     This option is BSP specific.
    169 
    170 DESCRIPTION:
    171     If ``BSP_MAXIMUM_DEVICES`` is defined by the BSP and
    172     ``CONFIGURE_MAXIMUM_DEVICES`` is not defined by the application, then this
    173     BSP specific maximum device count will be used.
    174 
    175 NOTES:
    176     This option is specific to the device file system (devFS) and should not be
    177     confused with the ``CONFIGURE_MAXIMUM_DRIVERS`` option.  This parameter
    178     only impacts the devFS and thus is only used by ``<rtems/confdefs.h>`` when
    179     ``CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM`` is specified.
    180 
    181 .. index:: CONFIGURE_BSP_PREREQUISITE_DRIVERS
    182 
    183 .. _CONFIGURE_BSP_PREREQUISITE_DRIVERS:
    184 
    185 CONFIGURE_BSP_PREREQUISITE_DRIVERS
    186 ----------------------------------
    187 
    188 CONSTANT:
    189     ``CONFIGURE_BSP_PREREQUISITE_DRIVERS``
    190 
    191 DATA TYPE:
    192     List of device driver initializers (``rtems_driver_address_table``).
    193 
    194 RANGE:
    195     Undefined or array of device drivers.
    196 
    197 DEFAULT VALUE:
    198     This option is BSP specific.
    199 
    200 DESCRIPTION:
    201     ``CONFIGURE_BSP_PREREQUISITE_DRIVERS`` is defined if the BSP has device
    202     drivers it needs to include in the Device Driver Table.  This should be
    203     defined to the set of device driver entries that will be placed in the
    204     table at the *FRONT* of the Device Driver Table and initialized before any
    205     other drivers *INCLUDING* any application prerequisite drivers.
    206 
    207 NOTES:
    208     ``CONFIGURE_BSP_PREREQUISITE_DRIVERS`` is typically used by BSPs to
    209     configure common infrastructure such as bus controllers or probe for
    210     devices.
    211 
    212 .. index:: CONFIGURE_DISABLE_BSP_SETTINGS
    213 
    214 .. _CONFIGURE_DISABLE_BSP_SETTINGS:
    215 
    216 CONFIGURE_DISABLE_BSP_SETTINGS
    217 ------------------------------
    218 
    219 CONSTANT:
    220     ``CONFIGURE_DISABLE_BSP_SETTINGS``
    221 
    222 DATA TYPE:
    223     Boolean feature macro.
    224 
    225 RANGE:
    226     Defined or undefined.
    227 
    228 DEFAULT VALUE:
    229     This is not defined by default.
    230 
    231 DESCRIPTION:
    232     All BSP specific configuration settings can be disabled by the application
    233     with the ``CONFIGURE_DISABLE_BSP_SETTINGS`` option.
    234 
    235 NOTES:
    236     None.
    237 
    238 .. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    239 
    240 .. _CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK:
    241 
    242 CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    243 ----------------------------------
    244 
    245 CONSTANT:
    246     ``CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK``
    247 
    248 DATA TYPE:
    249     Boolean feature macro.
    250 
    251 RANGE:
    252     Defined or undefined.
    253 
    254 DEFAULT VALUE:
    255     This option is BSP specific.
    256 
    257 DESCRIPTION:
    258     This configuration parameter is defined by a BSP to indicate that it does
    259     not allocate all available memory to the C Program Heap used by the Malloc
    260     Family of routines.
    261 
    262     If defined, when ``malloc()`` is unable to allocate memory, it will call
    263     the BSP supplied ``sbrk()`` to obtain more memory.
    264 
    265 NOTES:
    266     This parameter should not be defined by the application. Only the BSP knows
    267     how it allocates memory to the C Program Heap.
     24    bsp-related
    26825
    26926Idle Task Configuration
Note: See TracChangeset for help on using the changeset viewer.