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/idle-task.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/idle-task.rst')
| -rw-r--r-- | c-user/config/idle-task.rst | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst index 5cf8364..359f862 100644 --- a/c-user/config/idle-task.rst +++ b/c-user/config/idle-task.rst @@ -48,8 +48,11 @@ This configuration option is an initializer define. .. rubric:: DEFAULT VALUE: -If :ref:`BSP_IDLE_TASK_BODY` is defined, then this will be the default value, -otherwise the default value is ``_CPU_Thread_Idle_body``. +If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and +:c:macro:`BSP_IDLE_TASK_BODY` is provided by the +:term:`BSP`, then the default value is defined by +:c:macro:`BSP_IDLE_TASK_BODY`, otherwise the default value is +``_CPU_Thread_Idle_body``. .. rubric:: DESCRIPTION: @@ -64,6 +67,11 @@ exists. IDLE threads can be used to initialize the application, see configuration option :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`. +The BSP may have knowledge of the specific CPU model, system controller +logic, and peripheral buses, so a BSP-specific IDLE task may be capable of +turning components off to save power during extended periods of no task +activity. + .. rubric:: CONSTRAINTS: The value of the configuration option shall be defined to a valid function @@ -149,7 +157,11 @@ This configuration option is an integer define. .. rubric:: DEFAULT VALUE: -The default value is :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. +If the :ref:`CONFIGURE_DISABLE_BSP_SETTINGS` configuration option is not defined and +:c:macro:`BSP_IDLE_TASK_STACK_SIZE` is provided by the +:term:`BSP`, then the default value is defined by +:c:macro:`BSP_IDLE_TASK_STACK_SIZE`, otherwise the default value is +defined by the :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE` configuration option. .. rubric:: DESCRIPTION: |