summaryrefslogtreecommitdiffstats
path: root/spec/acfg/if/idle-task-init-appl.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-16 11:48:29 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-16 16:33:00 +0200
commit3bdf817950eadd75a2785b62220eb0b04533b9fd (patch)
treeed221c6de813e7a473e2882af6326bf2e5b44bd1 /spec/acfg/if/idle-task-init-appl.yml
parentspec: Specify rtems_task_construct() (diff)
downloadrtems-central-3bdf817950eadd75a2785b62220eb0b04533b9fd.tar.bz2
spec: Group items by component
Diffstat (limited to 'spec/acfg/if/idle-task-init-appl.yml')
-rw-r--r--spec/acfg/if/idle-task-init-appl.yml43
1 files changed, 43 insertions, 0 deletions
diff --git a/spec/acfg/if/idle-task-init-appl.yml b/spec/acfg/if/idle-task-init-appl.yml
new file mode 100644
index 00000000..ad5f31da
--- /dev/null
+++ b/spec/acfg/if/idle-task-init-appl.yml
@@ -0,0 +1,43 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+appl-config-option-type: feature
+copyrights:
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+default: |
+ If this configuration option is undefined, then the user is assumed to
+ provide one or more initialization tasks.
+description: |
+ This configuration option is defined to indicate that the user has configured
+ **no** user initialization tasks or threads and that the user provided IDLE
+ task will perform application initialization and then transform itself into
+ an IDLE task.
+enabled-by: true
+index-entries: []
+interface-type: appl-config-option
+links:
+- role: appl-config-group-member
+ uid: group-idle
+name: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
+notes: |
+ If you use this option be careful, the user IDLE task **cannot** block at all
+ during the initialization sequence. Further, once application
+ initialization is complete, it shall make itself preemptible and enter an idle
+ body loop.
+
+ The IDLE task shall run at the lowest priority of all tasks in the system.
+
+ If this configuration option is defined, then it is mandatory to configure a
+ user IDLE task with the ${idle-task-body:/name} configuration option,
+ otherwise a compile time error in the configuration file will occur.
+
+ The application shall define exactly one of the following configuration
+ options
+
+ * ${rtems-init-tasks-table:/name},
+
+ * ${posix-init-thread-table:/name}, or
+
+ * ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
+
+ otherwise a compile time error in the configuration file will occur.
+text: ''
+type: interface