Changeset a9e6a1d in rtems-docs


Ignore:
Timestamp:
Mar 9, 2020, 7:47:12 AM (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
5, master
Children:
16b0d3f
Parents:
bf995cf
git-author:
Sebastian Huber <sebastian.huber@…> (03/09/20 07:47:12)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/12/20 09:16:10)
Message:

c-user: Move "Classic API Initialization Task Configuration"

Update #3836.

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

Legend:

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

    rbf995cf ra9e6a1d  
    1515    general
    1616    classic-api
    17 
    18 Classic API Initialization Task Configuration
    19 =============================================
    20 
    21 The ``<rtems/confdefs.h>`` configuration system can automatically generate an
    22 Initialization Tasks Table named ``Initialization_tasks`` with a single entry.
    23 The following parameters control the generation of that table.
    24 
    25 .. index:: CONFIGURE_INIT_TASK_ARGUMENTS
    26 
    27 .. _CONFIGURE_INIT_TASK_ARGUMENTS:
    28 
    29 CONFIGURE_INIT_TASK_ARGUMENTS
    30 -----------------------------
    31 
    32 CONSTANT:
    33     ``CONFIGURE_INIT_TASK_ARGUMENTS``
    34 
    35 DATA TYPE:
    36     RTEMS Task Argument (``rtems_task_argument``).
    37 
    38 RANGE:
    39     Complete range of the type.
    40 
    41 DEFAULT VALUE:
    42     The default value is 0.
    43 
    44 DESCRIPTION:
    45     ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single
    46     initialization task defined by the Classic API Initialization Tasks Table.
    47 
    48 NOTES:
    49     None.
    50 
    51 .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES
    52 
    53 .. _CONFIGURE_INIT_TASK_ATTRIBUTES:
    54 
    55 CONFIGURE_INIT_TASK_ATTRIBUTES
    56 ------------------------------
    57 
    58 CONSTANT:
    59     ``CONFIGURE_INIT_TASK_ATTRIBUTES``
    60 
    61 DATA TYPE:
    62     RTEMS Attributes (``rtems_attribute``).
    63 
    64 RANGE:
    65     Valid task attribute sets.
    66 
    67 DEFAULT VALUE:
    68     The default value is ``RTEMS_DEFAULT_ATTRIBUTES``.
    69 
    70 DESCRIPTION:
    71     ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single
    72     initialization task defined by the Classic API Initialization Tasks Table.
    73 
    74 NOTES:
    75     None.
    76 
    77 .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
    78 
    79 .. _CONFIGURE_INIT_TASK_ENTRY_POINT:
    80 
    81 CONFIGURE_INIT_TASK_ENTRY_POINT
    82 -------------------------------
    83 
    84 CONSTANT:
    85     ``CONFIGURE_INIT_TASK_ENTRY_POINT``
    86 
    87 DATA TYPE:
    88     Task entry function pointer (``rtems_task_entry``).
    89 
    90 RANGE:
    91     Valid task entry function pointer.
    92 
    93 DEFAULT VALUE:
    94     The default value is ``Init``.
    95 
    96 DESCRIPTION:
    97     ``CONFIGURE_INIT_TASK_ENTRY_POINT`` is the entry point (a.k.a. function
    98     name) of the single initialization task defined by the Classic API
    99     Initialization Tasks Table.
    100 
    101 NOTES:
    102     The user must implement the function ``Init`` or the function name provided
    103     in this configuration parameter.
    104 
    105 .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES
    106 
    107 .. _CONFIGURE_INIT_TASK_INITIAL_MODES:
    108 
    109 CONFIGURE_INIT_TASK_INITIAL_MODES
    110 ---------------------------------
    111 
    112 CONSTANT:
    113     ``CONFIGURE_INIT_TASK_INITIAL_MODES``
    114 
    115 DATA TYPE:
    116     RTEMS Mode (``rtems_mode``).
    117 
    118 RANGE:
    119     Valid task mode sets.
    120 
    121 DEFAULT VALUE:
    122     The default value is ``RTEMS_NO_PREEMPT``.
    123 
    124 DESCRIPTION:
    125     ``CONFIGURE_INIT_TASK_INITIAL_MODES`` is the initial execution mode of the
    126     single initialization task defined by the Classic API Initialization Tasks
    127     Table.
    128 
    129 NOTES:
    130     None.
    131 
    132 .. index:: CONFIGURE_INIT_TASK_NAME
    133 
    134 .. _CONFIGURE_INIT_TASK_NAME:
    135 
    136 CONFIGURE_INIT_TASK_NAME
    137 ------------------------
    138 
    139 CONSTANT:
    140     ``CONFIGURE_INIT_TASK_NAME``
    141 
    142 DATA TYPE:
    143     RTEMS Name (``rtems_name``).
    144 
    145 RANGE:
    146     Any value.
    147 
    148 DEFAULT VALUE:
    149     The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``.
    150 
    151 DESCRIPTION:
    152     ``CONFIGURE_INIT_TASK_NAME`` is the name of the single initialization task
    153     defined by the Classic API Initialization Tasks Table.
    154 
    155 NOTES:
    156     None.
    157 
    158 .. index:: CONFIGURE_INIT_TASK_PRIORITY
    159 
    160 .. _CONFIGURE_INIT_TASK_PRIORITY:
    161 
    162 CONFIGURE_INIT_TASK_PRIORITY
    163 ----------------------------
    164 
    165 CONSTANT:
    166     ``CONFIGURE_INIT_TASK_PRIORITY``
    167 
    168 DATA TYPE:
    169     RTEMS Task Priority (``rtems_task_priority``).
    170 
    171 RANGE:
    172     One (1) to the maximum user priority value of the scheduler.
    173 
    174 DEFAULT VALUE:
    175     The default value is 1, which is the highest priority in the Classic API.
    176 
    177 DESCRIPTION:
    178     ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single
    179     initialization task defined by the Classic API Initialization Tasks Table.
    180 
    181 NOTES:
    182     None.
    183 
    184 .. index:: CONFIGURE_INIT_TASK_STACK_SIZE
    185 
    186 .. _CONFIGURE_INIT_TASK_STACK_SIZE:
    187 
    188 CONFIGURE_INIT_TASK_STACK_SIZE
    189 ------------------------------
    190 
    191 CONSTANT:
    192     ``CONFIGURE_INIT_TASK_STACK_SIZE``
    193 
    194 DATA TYPE:
    195     Unsigned integer (``size_t``).
    196 
    197 RANGE:
    198     Zero or positive.
    199 
    200 DEFAULT VALUE:
    201     The default value is RTEMS_MINIMUM_STACK_SIZE.
    202 
    203 DESCRIPTION:
    204     ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single
    205     initialization task defined by the Classic API Initialization Tasks Table.
    206 
    207 NOTES:
    208     If the stack size specified is greater than the configured minimum, it must
    209     be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
    210     Task/Thread Stack Memory Above Minimum` for more information about
    211     ``CONFIGURE_EXTRA_TASK_STACKS``.
    212 
    213 .. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE
    214 
    215 .. _CONFIGURE_RTEMS_INIT_TASKS_TABLE:
    216 
    217 CONFIGURE_RTEMS_INIT_TASKS_TABLE
    218 --------------------------------
    219 
    220 CONSTANT:
    221     ``CONFIGURE_RTEMS_INIT_TASKS_TABLE``
    222 
    223 DATA TYPE:
    224     Boolean feature macro.
    225 
    226 RANGE:
    227     Defined or undefined.
    228 
    229 DEFAULT VALUE:
    230     This is not defined by default.
    231 
    232 DESCRIPTION:
    233     ``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` is defined if the user wishes to use a
    234     Classic RTEMS API Initialization Task Table. The table built by
    235     ``<rtems/confdefs.h>`` specifies the parameters for a single task. This is
    236     sufficient for applications which initialization the system from a single
    237     task.
    238 
    239     By default, this field is not defined as the user MUST select their own API
    240     for initialization tasks.
    241 
    242 NOTES:
    243     The application may choose to use the initialization tasks or threads table
    244     from another API.
    245 
    246     A compile time error will be generated if the user does not configure any
    247     initialization tasks or threads.
     17    classic-init-task
    24818
    24919POSIX API Configuration
Note: See TracChangeset for help on using the changeset viewer.