diff options
Diffstat (limited to 'c-user/config/classic-init-task.rst')
| -rw-r--r-- | c-user/config/classic-init-task.rst | 414 |
1 files changed, 300 insertions, 114 deletions
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst index 8addf9f..f65bb8a 100644 --- a/c-user/config/classic-init-task.rst +++ b/c-user/config/classic-init-task.rst @@ -1,13 +1,37 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 +.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +.. This file is part of the RTEMS quality process and was automatically +.. generated. If you find something that needs to be fixed or +.. worded better please post a report or patch to an RTEMS mailing list +.. or raise a bug report: +.. +.. https://www.rtems.org/bugs.html +.. +.. For information on updating and regenerating please refer to the How-To +.. section in the Software Requirements Engineering chapter of the +.. RTEMS Software Engineering manual. The manual is provided as a part of +.. a release. For development sources please refer to the online +.. documentation at: +.. +.. https://docs.rtems.org + +.. Generated from spec:/acfg/if/group-classicinit + Classic API Initialization Task Configuration ============================================= This section describes configuration options related to the Classic API initialization task. +.. Generated from spec:/acfg/if/init-task-arguments + +.. raw:: latex + + \clearpage + .. index:: CONFIGURE_INIT_TASK_ARGUMENTS .. _CONFIGURE_INIT_TASK_ARGUMENTS: @@ -15,24 +39,33 @@ initialization task. CONFIGURE_INIT_TASK_ARGUMENTS ----------------------------- -CONSTANT: - ``CONFIGURE_INIT_TASK_ARGUMENTS`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_ARGUMENTS`` + +.. rubric:: OPTION TYPE: + +This configuration option is an integer define. -DATA TYPE: - RTEMS Task Argument (``rtems_task_argument``). +.. rubric:: DEFAULT VALUE: -RANGE: - Complete range of the type. +The default value is 0. -DEFAULT VALUE: - The default value is 0. +.. rubric:: DESCRIPTION: -DESCRIPTION: - ``CONFIGURE_INIT_TASK_ARGUMENTS`` is the task argument of the single - initialization task defined by the Classic API Initialization Tasks Table. +The value of this configuration option defines task argument of the Classic +API initialization task. -NOTES: - None. +.. rubric:: CONSTRAINTS: + +The value of the configuration option shall be convertible to an integer of +type :ref:`InterfaceRtemsTaskArgument`. + +.. Generated from spec:/acfg/if/init-task-attributes + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_INIT_TASK_ATTRIBUTES @@ -41,24 +74,103 @@ NOTES: CONFIGURE_INIT_TASK_ATTRIBUTES ------------------------------ -CONSTANT: - ``CONFIGURE_INIT_TASK_ATTRIBUTES`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_ATTRIBUTES`` + +.. rubric:: OPTION TYPE: + +This configuration option is an integer define. + +.. rubric:: DEFAULT VALUE: + +The default value is :c:macro:`RTEMS_DEFAULT_ATTRIBUTES`. + +.. rubric:: DESCRIPTION: + +The value of this configuration option defines the task attributes of the +Classic API initialization task. + +.. rubric:: CONSTRAINTS: + +The value of the configuration option shall be a valid task attribute set. + +.. Generated from spec:/acfg/if/init-task-construct-storage-size + +.. raw:: latex + + \clearpage + +.. index:: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE + +.. _CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE: -DATA TYPE: - RTEMS Attributes (``rtems_attribute``). +CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE +------------------------------------------ -RANGE: - Valid task attribute sets. +.. rubric:: CONSTANT: -DEFAULT VALUE: - The default value is ``RTEMS_DEFAULT_ATTRIBUTES``. +``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE`` -DESCRIPTION: - ``CONFIGURE_INIT_TASK_ATTRIBUTES`` is the task attributes of the single - initialization task defined by the Classic API Initialization Tasks Table. +.. rubric:: OPTION TYPE: -NOTES: - None. +This configuration option is an integer define. + +.. rubric:: DEFAULT VALUE: + +This configuration option has no default value. If it is not specified, then +the Classic API initialization task will be created with the stack size +defined by the :ref:`CONFIGURE_INIT_TASK_STACK_SIZE` configuration option. + +.. rubric:: DESCRIPTION: + +The value of this configuration option defines the task storage size of the +Classic API initialization task. + +.. rubric:: NOTES: + +If this configuration option is specified, then + +* a task storage area of the specified size is statically allocated by + ``<rtems/confdefs.h>`` for the Classic API initialization task, + +* the Classic API initialization task is constructed by + :ref:`InterfaceRtemsTaskConstruct` instead of using + :ref:`InterfaceRtemsTaskCreate`, + +* the maximum thread-local storage size defined by + :ref:`CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE` is used for the Classic API + initialization task, + +* the Classic API initialization task should be accounted for in + :ref:`CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE`, and + +* the task storage area used for the Classic API initialization task is not + reclaimed by the system if the task is deleted. + +The + +* :ref:`CONFIGURE_INIT_TASK_STACK_SIZE` and + +* ``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE`` + +configuration options are mutually exclusive. + +.. rubric:: CONSTRAINTS: + +The following constraints apply to this configuration option: + +* The value of the configuration option shall be greater than or equal to + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. + +* The value of the configuration option shall be defined using + :ref:`InterfaceRTEMSTASKSTORAGESIZE`. + +.. Generated from spec:/acfg/if/init-task-entrypoint + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT @@ -67,26 +179,38 @@ NOTES: CONFIGURE_INIT_TASK_ENTRY_POINT ------------------------------- -CONSTANT: - ``CONFIGURE_INIT_TASK_ENTRY_POINT`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_ENTRY_POINT`` + +.. rubric:: OPTION TYPE: + +This configuration option is an initializer define. -DATA TYPE: - Task entry function pointer (``rtems_task_entry``). +.. rubric:: DEFAULT VALUE: -RANGE: - Valid task entry function pointer. +The default value is ``Init``. -DEFAULT VALUE: - The default value is ``Init``. +.. rubric:: DESCRIPTION: -DESCRIPTION: - ``CONFIGURE_INIT_TASK_ENTRY_POINT`` is the entry point (a.k.a. function - name) of the single initialization task defined by the Classic API - Initialization Tasks Table. +The value of this configuration option initializes the entry point of the +Classic API initialization task. -NOTES: - The user must implement the function ``Init`` or the function name provided - in this configuration parameter. +.. rubric:: NOTES: + +The application shall provide the function referenced by this configuration +option. + +.. rubric:: CONSTRAINTS: + +The value of the configuration option shall be defined to a valid function +pointer of the type ``void ( *entry_point )( rtems_task_argument )``. + +.. Generated from spec:/acfg/if/init-task-initial-modes + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_INIT_TASK_INITIAL_MODES @@ -95,25 +219,33 @@ NOTES: CONFIGURE_INIT_TASK_INITIAL_MODES --------------------------------- -CONSTANT: - ``CONFIGURE_INIT_TASK_INITIAL_MODES`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_INITIAL_MODES`` + +.. rubric:: OPTION TYPE: + +This configuration option is an integer define. + +.. rubric:: DEFAULT VALUE: + +In SMP configurations, the default value is :c:macro:`RTEMS_DEFAULT_MODES` +otherwise the default value is :c:macro:`RTEMS_NO_PREEMPT`. + +.. rubric:: DESCRIPTION: + +The value of this configuration option defines the initial execution mode of +the Classic API initialization task. -DATA TYPE: - RTEMS Mode (``rtems_mode``). +.. rubric:: CONSTRAINTS: -RANGE: - Valid task mode sets. +The value of the configuration option shall be a valid task mode set. -DEFAULT VALUE: - The default value is ``RTEMS_NO_PREEMPT``. +.. Generated from spec:/acfg/if/init-task-name -DESCRIPTION: - ``CONFIGURE_INIT_TASK_INITIAL_MODES`` is the initial execution mode of the - single initialization task defined by the Classic API Initialization Tasks - Table. +.. raw:: latex -NOTES: - None. + \clearpage .. index:: CONFIGURE_INIT_TASK_NAME @@ -122,24 +254,37 @@ NOTES: CONFIGURE_INIT_TASK_NAME ------------------------ -CONSTANT: - ``CONFIGURE_INIT_TASK_NAME`` +.. rubric:: CONSTANT: -DATA TYPE: - RTEMS Name (``rtems_name``). +``CONFIGURE_INIT_TASK_NAME`` -RANGE: - Any value. +.. rubric:: OPTION TYPE: -DEFAULT VALUE: - The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. +This configuration option is an integer define. -DESCRIPTION: - ``CONFIGURE_INIT_TASK_NAME`` is the name of the single initialization task - defined by the Classic API Initialization Tasks Table. +.. rubric:: DEFAULT VALUE: -NOTES: - None. +The default value is ``rtems_build_name( 'U', 'I', '1', ' ' )``. + +.. rubric:: DESCRIPTION: + +The value of this configuration option defines the name of the Classic API +initialization task. + +.. rubric:: NOTES: + +Use :ref:`InterfaceRtemsBuildName` to define the task name. + +.. rubric:: CONSTRAINTS: + +The value of the configuration option shall be convertible to an integer of +type :c:type:`rtems_name`. + +.. Generated from spec:/acfg/if/init-task-priority + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_INIT_TASK_PRIORITY @@ -148,24 +293,34 @@ NOTES: CONFIGURE_INIT_TASK_PRIORITY ---------------------------- -CONSTANT: - ``CONFIGURE_INIT_TASK_PRIORITY`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_PRIORITY`` + +.. rubric:: OPTION TYPE: -DATA TYPE: - RTEMS Task Priority (``rtems_task_priority``). +This configuration option is an integer define. -RANGE: - One (1) to the maximum user priority value of the scheduler. +.. rubric:: DEFAULT VALUE: -DEFAULT VALUE: - The default value is 1, which is the highest priority in the Classic API. +The default value is 1. -DESCRIPTION: - ``CONFIGURE_INIT_TASK_PRIORITY`` is the initial priority of the single - initialization task defined by the Classic API Initialization Tasks Table. +.. rubric:: DESCRIPTION: -NOTES: - None. +The value of this configuration option defines the initial priority of the +Classic API initialization task. + +.. rubric:: CONSTRAINTS: + +The value of the configuration option shall be a valid Classic API task +priority. The set of valid task priorities depends on the scheduler +configuration. + +.. Generated from spec:/acfg/if/init-task-stack-size + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_INIT_TASK_STACK_SIZE @@ -174,27 +329,50 @@ NOTES: CONFIGURE_INIT_TASK_STACK_SIZE ------------------------------ -CONSTANT: - ``CONFIGURE_INIT_TASK_STACK_SIZE`` +.. rubric:: CONSTANT: + +``CONFIGURE_INIT_TASK_STACK_SIZE`` + +.. rubric:: OPTION TYPE: + +This configuration option is an integer define. + +.. rubric:: DEFAULT VALUE: + +The default value is :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. + +.. rubric:: DESCRIPTION: + +The value of this configuration option defines the task stack size of the +Classic API initialization task. + +.. rubric:: NOTES: -DATA TYPE: - Unsigned integer (``size_t``). +The -RANGE: - Zero or positive. +* ``CONFIGURE_INIT_TASK_STACK_SIZE`` and -DEFAULT VALUE: - The default value is RTEMS_MINIMUM_STACK_SIZE. +* :ref:`CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE` -DESCRIPTION: - ``CONFIGURE_INIT_TASK_STACK_SIZE`` is the stack size of the single - initialization task defined by the Classic API Initialization Tasks Table. +configuration options are mutually exclusive. -NOTES: - If the stack size specified is greater than the configured minimum, it must - be accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``. See :ref:`Reserve - Task/Thread Stack Memory Above Minimum` for more information about - ``CONFIGURE_EXTRA_TASK_STACKS``. +.. rubric:: CONSTRAINTS: + +The following constraints apply to this configuration option: + +* The value of the configuration option shall be greater than or equal to + :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`. + +* The value of the configuration option shall be small enough so that the task + stack space calculation carried out by ``<rtems/confdefs.h>`` does not + overflow an integer of type `uintptr_t + <https://en.cppreference.com/w/c/types/integer>`_. + +.. Generated from spec:/acfg/if/rtems-init-tasks-table + +.. raw:: latex + + \clearpage .. index:: CONFIGURE_RTEMS_INIT_TASKS_TABLE @@ -203,28 +381,36 @@ NOTES: CONFIGURE_RTEMS_INIT_TASKS_TABLE -------------------------------- -CONSTANT: - ``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` +.. rubric:: CONSTANT: + +``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` + +.. rubric:: OPTION TYPE: + +This configuration option is a boolean feature define. + +.. rubric:: DEFAULT CONFIGURATION: + +If this configuration option is undefined, then the described feature is not +enabled. + +.. rubric:: DESCRIPTION: -OPTION TYPE: - This configuration option is a boolean feature define. +In case this configuration option is defined, then exactly one Classic API +initialization task is configured. -DEFAULT CONFIGURATION: - If this configuration option is undefined, then the described feature is not - enabled. +.. rubric:: NOTES: -DESCRIPTION: - In case this configuration option is defined, then exactly one Classic API - initialization task is configured. +The application shall define at least one of the following configuration +options -NOTES: - The application must define exactly one of the following configuration - options +* ``CONFIGURE_RTEMS_INIT_TASKS_TABLE``, - * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`, +* :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or - * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or +* :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` - * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION` +otherwise a compile time error in the configuration file will occur. - otherwise a compile time error in the configuration file will occur. +The Classic API initialization task performs the +:ref:`GlobalConstruction`. |