summaryrefslogtreecommitdiffstats
path: root/spec/acfg/if/idle-task-body.yml
blob: 82fc7a4fdbc420336c1812402b1854cf45c16024 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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: |
  If ${bsp-idle-task-body:/name} is defined, then this will be the default value,
  otherwise the default value is ``_CPU_Thread_Idle_body``.
description: |
  The value of this configuration option initializes the IDLE thread body.
enabled-by: true
index-entries: []
interface-type: appl-config-option
links:
- role: appl-config-group-member
  uid: group-idle
name: CONFIGURE_IDLE_TASK_BODY
notes: |
  IDLE threads shall not block.  A blocking IDLE thread results in undefined
  system behaviour because the scheduler assume that at least one ready thread
  exists.

  IDLE threads can be used to initialize the application, see configuration
  option ${idle-task-init-appl:/name}.
text: ''
type: interface