summaryrefslogtreecommitdiffstats
path: root/spec/acfg/if/idle-task-init-appl.yml
blob: ad5f31da543b1fa1abe3ffd2e8f5f186340d64ee (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
31
32
33
34
35
36
37
38
39
40
41
42
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