summaryrefslogtreecommitdiff
path: root/spec/if/acfg/idle-task-body.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-06 09:23:27 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-07 12:58:52 +0200
commit518d8c3763f4ab0e3cac33d643b968f5e868e9c4 (patch)
tree63b8ca1334ab7c71956214ab17a81d5bef04aaac /spec/if/acfg/idle-task-body.yml
parent813f520674faf874a74fe8cf28423da9a564feb7 (diff)
spec: Move application configuration items
Diffstat (limited to 'spec/if/acfg/idle-task-body.yml')
-rw-r--r--spec/if/acfg/idle-task-body.yml30
1 files changed, 30 insertions, 0 deletions
diff --git a/spec/if/acfg/idle-task-body.yml b/spec/if/acfg/idle-task-body.yml
new file mode 100644
index 00000000..a4221954
--- /dev/null
+++ b/spec/if/acfg/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 :ref:`BSP_IDLE_TASK_BODY` 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 :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`.
+text: ''
+type: interface