summaryrefslogtreecommitdiffstats
path: root/c-user/config/bsp-related.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-30 11:13:44 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-30 11:14:41 +0200
commit2f18a530bc73d9e54bd4d6b3cdb27f4e5ea1ca4e (patch)
tree9ff9d0e28852604c64fcb5288494f138b4a3d2fe /c-user/config/bsp-related.rst
parentc-user: Fix typo in file name (diff)
downloadrtems-docs-2f18a530bc73d9e54bd4d6b3cdb27f4e5ea1ca4e.tar.bz2
c-user: Use new template for feature config opts
Update #3900.
Diffstat (limited to 'c-user/config/bsp-related.rst')
-rw-r--r--c-user/config/bsp-related.rst58
1 files changed, 35 insertions, 23 deletions
diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
index a8988e7..62fcda4 100644
--- a/c-user/config/bsp-related.rst
+++ b/c-user/config/bsp-related.rst
@@ -199,18 +199,28 @@ CONFIGURE_DISABLE_BSP_SETTINGS
CONSTANT:
``CONFIGURE_DISABLE_BSP_SETTINGS``
-DATA TYPE:
- Boolean feature macro.
+OPTION TYPE:
+ This configuration option is a boolean feature define.
-RANGE:
- Defined or undefined.
-
-DEFAULT VALUE:
- This is not defined by default.
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
DESCRIPTION:
- All BSP specific configuration settings can be disabled by the application
- with the ``CONFIGURE_DISABLE_BSP_SETTINGS`` option.
+ In case this configuration option is defined, then the following BSP related
+ configuration options are undefined:
+
+ - :ref:`BSP_IDLE_TASK_BODY`
+
+ - :ref:`BSP_IDLE_TASK_STACK_SIZE`
+
+ - :ref:`BSP_INITIAL_EXTENSION`
+
+ - :ref:`BSP_INTERRUPT_STACK_SIZE`
+
+ - :ref:`CONFIGURE_BSP_PREREQUISITE_DRIVERS`
+
+ - :ref:`CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK`
NOTES:
None.
@@ -225,23 +235,25 @@ CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK
CONSTANT:
``CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK``
-DATA TYPE:
- Boolean feature macro.
-
-RANGE:
- Defined or undefined.
+OPTION TYPE:
+ This configuration option is a boolean feature define.
-DEFAULT VALUE:
- This option is BSP specific.
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
DESCRIPTION:
- This configuration parameter is defined by a BSP to indicate that it does
- not allocate all available memory to the C Program Heap used by the Malloc
- Family of routines.
+ If
+
+ * this configuration option is defined by the BSP
+
+ * and :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` is undefined,
- If defined, when ``malloc()`` is unable to allocate memory, it will call
- the BSP supplied ``sbrk()`` to obtain more memory.
+ then not all memory is made available to the C Program Heap immediately at
+ system initialization time. When :c:func:`malloc()` or other standard memory
+ allocation functions are unable to allocate memory, they will call the BSP
+ supplied :c:func:`sbrk()` function to obtain more memory.
NOTES:
- This parameter should not be defined by the application. Only the BSP knows
- how it allocates memory to the C Program Heap.
+ This option should not be defined by the application. Only the BSP knows how
+ it allocates memory to the C Program Heap.