summaryrefslogtreecommitdiffstats
path: root/spec/acfg/if/idle-task-body.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/acfg/if/idle-task-body.yml')
-rw-r--r--spec/acfg/if/idle-task-body.yml30
1 files changed, 30 insertions, 0 deletions
diff --git a/spec/acfg/if/idle-task-body.yml b/spec/acfg/if/idle-task-body.yml
new file mode 100644
index 00000000..82fc7a4f
--- /dev/null
+++ b/spec/acfg/if/idle-task-body.yml
@@ -0,0 +1,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