Changeset a174ae4 in rtems-docs


Ignore:
Timestamp:
Mar 6, 2020, 12:43:56 PM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
988e7ca
Parents:
851e4df
git-author:
Sebastian Huber <sebastian.huber@…> (03/06/20 12:43:56)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/09/20 06:38:00)
Message:

c-user: Clarify BSP related configuration options

Sort options alphabetically.

Update #3836.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/configuring_a_system.rst

    r851e4df ra174ae4  
    30033003    None.
    30043004
    3005 BSP Specific Settings
    3006 =====================
    3007 
    3008 This section describes BSP specific configuration settings used by
    3009 ``<rtems/confdefs.h>``.  The BSP specific configuration settings are defined in
    3010 ``<bsp.h>``.
    3011 
    3012 .. index:: CONFIGURE_DISABLE_BSP_SETTINGS
    3013 
    3014 .. _CONFIGURE_DISABLE_BSP_SETTINGS:
    3015 
    3016 CONFIGURE_DISABLE_BSP_SETTINGS
    3017 ------------------------------
    3018 
    3019 CONSTANT:
    3020     ``CONFIGURE_DISABLE_BSP_SETTINGS``
    3021 
    3022 DATA TYPE:
    3023     Boolean feature macro.
    3024 
    3025 RANGE:
    3026     Defined or undefined.
    3027 
    3028 DEFAULT VALUE:
    3029     This is not defined by default.
    3030 
    3031 DESCRIPTION:
    3032     All BSP specific configuration settings can be disabled by the application
    3033     with the ``CONFIGURE_DISABLE_BSP_SETTINGS`` option.
    3034 
    3035 NOTES:
    3036     None.
    3037 
    3038 .. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    3039 
    3040 .. _CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK:
    3041 
    3042 CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
    3043 ----------------------------------
    3044 
    3045 CONSTANT:
    3046     ``CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK``
    3047 
    3048 DATA TYPE:
    3049     Boolean feature macro.
    3050 
    3051 RANGE:
    3052     Defined or undefined.
    3053 
    3054 DEFAULT VALUE:
    3055     This option is BSP specific.
    3056 
    3057 DESCRIPTION:
    3058     This configuration parameter is defined by a BSP to indicate that it does
    3059     not allocate all available memory to the C Program Heap used by the Malloc
    3060     Family of routines.
    3061 
    3062     If defined, when ``malloc()`` is unable to allocate memory, it will call
    3063     the BSP supplied ``sbrk()`` to obtain more memory.
    3064 
    3065 NOTES:
    3066     This parameter should not be defined by the application. Only the BSP knows
    3067     how it allocates memory to the C Program Heap.
     3005BSP Related Configuration Options
     3006=================================
     3007
     3008This section describes configuration options related to the BSP.  Some
     3009configuration options may have a BSP-specific setting which is defined by
     3010``<bsp.h>``.  The BSP-specific settings can be disabled by the
     3011:ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option.
    30683012
    30693013.. index:: BSP_IDLE_TASK_BODY
     
    31303074
    31313075    - If defined, then the application specified ``CONFIGURE_IDLE_TASK_SIZE``.
    3132 
    3133 .. COMMENT: XXX - add cross references to other related values.
    31343076
    31353077.. index:: BSP_INITIAL_EXTENSION
     
    32473189    configure common infrastructure such as bus controllers or probe for
    32483190    devices.
     3191
     3192.. index:: CONFIGURE_DISABLE_BSP_SETTINGS
     3193
     3194.. _CONFIGURE_DISABLE_BSP_SETTINGS:
     3195
     3196CONFIGURE_DISABLE_BSP_SETTINGS
     3197------------------------------
     3198
     3199CONSTANT:
     3200    ``CONFIGURE_DISABLE_BSP_SETTINGS``
     3201
     3202DATA TYPE:
     3203    Boolean feature macro.
     3204
     3205RANGE:
     3206    Defined or undefined.
     3207
     3208DEFAULT VALUE:
     3209    This is not defined by default.
     3210
     3211DESCRIPTION:
     3212    All BSP specific configuration settings can be disabled by the application
     3213    with the ``CONFIGURE_DISABLE_BSP_SETTINGS`` option.
     3214
     3215NOTES:
     3216    None.
     3217
     3218.. index:: CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
     3219
     3220.. _CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK:
     3221
     3222CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
     3223----------------------------------
     3224
     3225CONSTANT:
     3226    ``CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK``
     3227
     3228DATA TYPE:
     3229    Boolean feature macro.
     3230
     3231RANGE:
     3232    Defined or undefined.
     3233
     3234DEFAULT VALUE:
     3235    This option is BSP specific.
     3236
     3237DESCRIPTION:
     3238    This configuration parameter is defined by a BSP to indicate that it does
     3239    not allocate all available memory to the C Program Heap used by the Malloc
     3240    Family of routines.
     3241
     3242    If defined, when ``malloc()`` is unable to allocate memory, it will call
     3243    the BSP supplied ``sbrk()`` to obtain more memory.
     3244
     3245NOTES:
     3246    This parameter should not be defined by the application. Only the BSP knows
     3247    how it allocates memory to the C Program Heap.
    32493248
    32503249Idle Task Configuration
Note: See TracChangeset for help on using the changeset viewer.