source: rtems-docs/c-user/config/idle-task.rst @ dfe0ec0

5
Last change on this file since dfe0ec0 was dfe0ec0, checked in by Sebastian Huber <sebastian.huber@…>, on 03/18/20 at 15:50:00

c-user: Use new template for feature config opts

Try to bring all descriptions up to date. Add cross-references to
several options.

Close #3900.
  • Property mode set to 100644
File size: 2.8 KB
Line 
1.. SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
4
5Idle Task Configuration
6=======================
7
8This section describes configuration options related to the idle tasks.
9
10.. index:: CONFIGURE_IDLE_TASK_BODY
11
12.. _CONFIGURE_IDLE_TASK_BODY:
13
14CONFIGURE_IDLE_TASK_BODY
15------------------------
16
17CONSTANT:
18    ``CONFIGURE_IDLE_TASK_BODY``
19
20DATA TYPE:
21    Function pointer.
22
23RANGE:
24    Undefined or valid function pointer.
25
26DEFAULT VALUE:
27    This is not defined by default.
28
29DESCRIPTION:
30    ``CONFIGURE_IDLE_TASK_BODY`` is set to the function name corresponding to
31    the application specific IDLE thread body.  If not specified, the BSP or
32    RTEMS default IDLE thread body will be used.
33
34NOTES:
35    None.
36
37.. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
38
39.. _CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION:
40
41CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
42-------------------------------------------
43
44CONSTANT:
45    ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
46
47OPTION TYPE:
48    This configuration option is a boolean feature define.
49
50DEFAULT CONFIGURATION:
51    If this configuration option is undefined, then the user is assumed to
52    provide one or more initialization tasks.
53
54DESCRIPTION:
55    This configuration option is defined to indicate that the user has configured
56    **no** user initialization tasks or threads and that the user provided idle
57    task will perform application initialization and then transform itself into
58    an idle task.
59
60NOTES:
61    If you use this option be careful, the user idle task **cannot** block at all
62    during the initialization sequence.  Further, once application
63    initialization is complete, it must make itself preemptible and enter an idle
64    body loop.
65
66    The idle task must run at the lowest priority of all tasks in the system.
67
68    If this configuration option is defined, then it is mandatory to configure a
69    user idle task with the :ref:`CONFIGURE_IDLE_TASK_BODY` configuration option,
70    otherwise a compile time error in the configuration file will occur.
71
72    The application must define exactly one of the following configuration
73    options
74
75    * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
76
77    * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
78
79    * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
80
81    otherwise a compile time error in the configuration file will occur.
82
83.. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
84
85.. _CONFIGURE_IDLE_TASK_STACK_SIZE:
86
87CONFIGURE_IDLE_TASK_STACK_SIZE
88------------------------------
89
90CONSTANT:
91    ``CONFIGURE_IDLE_TASK_STACK_SIZE``
92
93DATA TYPE:
94    Unsigned integer (``size_t``).
95
96RANGE:
97    Undefined or positive.
98
99DEFAULT VALUE:
100    The default value is RTEMS_MINIMUM_STACK_SIZE.
101
102DESCRIPTION:
103    ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the
104    IDLE task.
105
106NOTES:
107    None.
Note: See TracBrowser for help on using the repository browser.