Changeset 38032b0 in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:53:58 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
275f4a0
Parents:
4bb586b
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:53:58)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:20:00)
Message:

c-user: Move "Idle Task Configuration"

Update #3836.

Location:
c-user/config
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/config/index.rst

    r4bb586b r38032b0  
    2323    bdbuf
    2424    bsp-related
    25 
    26 Idle Task Configuration
    27 =======================
    28 
    29 This section defines the IDLE task related configuration parameters supported
    30 by ``<rtems/confdefs.h>``.
    31 
    32 .. index:: CONFIGURE_IDLE_TASK_BODY
    33 
    34 .. _CONFIGURE_IDLE_TASK_BODY:
    35 
    36 CONFIGURE_IDLE_TASK_BODY
    37 ------------------------
    38 
    39 CONSTANT:
    40     ``CONFIGURE_IDLE_TASK_BODY``
    41 
    42 DATA TYPE:
    43     Function pointer.
    44 
    45 RANGE:
    46     Undefined or valid function pointer.
    47 
    48 DEFAULT VALUE:
    49     This is not defined by default.
    50 
    51 DESCRIPTION:
    52     ``CONFIGURE_IDLE_TASK_BODY`` is set to the function name corresponding to
    53     the application specific IDLE thread body.  If not specified, the BSP or
    54     RTEMS default IDLE thread body will be used.
    55 
    56 NOTES:
    57     None.
    58 
    59 .. index:: CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    60 
    61 .. _CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION:
    62 
    63 CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION
    64 -------------------------------------------
    65 
    66 CONSTANT:
    67     ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION``
    68 
    69 DATA TYPE:
    70     Boolean feature macro.
    71 
    72 RANGE:
    73     Defined or undefined.
    74 
    75 DEFAULT VALUE:
    76     This is not defined by default, the user is assumed to provide one or more
    77     initialization tasks.
    78 
    79 DESCRIPTION:
    80     ``CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`` is set to indicate that the
    81     user has configured *NO* user initialization tasks or threads and that the
    82     user provided IDLE task will perform application initialization and then
    83     transform itself into an IDLE task.
    84 
    85 NOTES:
    86     If you use this option be careful, the user IDLE task *CANNOT* block at all
    87     during the initialization sequence.  Further, once application
    88     initialization is complete, it must make itself preemptible and enter an
    89     IDLE body loop.
    90 
    91     The IDLE task must run at the lowest priority of all tasks in the system.
    92 
    93 .. index:: CONFIGURE_IDLE_TASK_STACK_SIZE
    94 
    95 .. _CONFIGURE_IDLE_TASK_STACK_SIZE:
    96 
    97 CONFIGURE_IDLE_TASK_STACK_SIZE
    98 ------------------------------
    99 
    100 CONSTANT:
    101     ``CONFIGURE_IDLE_TASK_STACK_SIZE``
    102 
    103 DATA TYPE:
    104     Unsigned integer (``size_t``).
    105 
    106 RANGE:
    107     Undefined or positive.
    108 
    109 DEFAULT VALUE:
    110     The default value is RTEMS_MINIMUM_STACK_SIZE.
    111 
    112 DESCRIPTION:
    113     ``CONFIGURE_IDLE_TASK_STACK_SIZE`` is set to the desired stack size for the
    114     IDLE task.
    115 
    116 NOTES:
    117     None.
     25    idle-task
    11826
    11927General Scheduler Configuration
Note: See TracChangeset for help on using the changeset viewer.