path: root/spec/acfg/if/bsp-idle-task-body.yml

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
appl-config-option-type: initializer
constraints:
  texts:
  - |
    The value of this configuration option shall be defined to a valid function
    pointer of the type ``void *( *idle_body )( uintptr_t )``.
copyrights:
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
default-value: |
  The default value is BSP-specific.
description: |
  If

  * this configuration option is defined by the BSP

  * and ${disable-bsp-settings:/name} is undefined,

  then the value of this configuration option defines the default value of
  ${idle-task-body:/name}.
enabled-by: true
index-entries: []
interface-type: appl-config-option
links:
- role: appl-config-group-member
  uid: group-bsp
name: BSP_IDLE_TASK_BODY
notes: |
  As it has knowledge of the specific CPU model, system controller logic, and
  peripheral buses, a BSP-specific IDLE task may be capable of turning
  components off to save power during extended periods of no task activity.
text: ''
type: interface