[PATCH v3] c-user: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE

[Gedare Bloom]

On Wed, Nov 25, 2020 at 12:14 AM Sebastian Huber <
sebastian.huber at embedded-brains.de> wrote:

> Document new configuration option
> CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE.
>
> Close #4181.
> ---
>  c-user/config/classic-init-task.rst | 67 ++++++++++++++++++++++++++++-
>  1 file changed, 66 insertions(+), 1 deletion(-)
>
> diff --git a/c-user/config/classic-init-task.rst
> b/c-user/config/classic-init-task.rst
> index 4d3bf81..d848546 100644
> --- a/c-user/config/classic-init-task.rst
> +++ b/c-user/config/classic-init-task.rst
> @@ -79,6 +79,65 @@ DESCRIPTION:
>  NOTES:
>      None.
>
> +.. Generated from spec:/acfg/if/init-task-construct-storage-size
> +
> +.. index:: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
> +
> +.. _CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE:
> +
> +CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
> +------------------------------------------
> +
> +CONSTANT:
> +    ``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE``
> +
> +OPTION TYPE:
> +    This configuration option is an integer define.
> +
> +DEFAULT VALUE:
> +    The default value is 0.
> +
> +VALUE CONSTRAINTS:
> +    The value of this configuration option shall satisfy all of the
> following
> +    constraints:
> +
> +    * It shall be greater than or equal to
> :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
> +
>
I guess the constraints don't apply to defaults? Or should an exception be
noted, like below .. "if specified"


> +    * It shall be defined using
> +      :c:func:`RTEMS_TASK_STORAGE_SIZE`.
> +
> +DESCRIPTION:
> +    The value of this configuration option defines the task storage size
> of the
> +    Classic API initialization task.
> +
> +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
> +      :c:func:`rtems_task_construct` instead of using
> +      :c:func:`rtems_task_create`,
> +
> +    * 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.
>
nit: remove comma


> +
> +    The
> +
> +    * :ref:`CONFIGURE_INIT_TASK_STACK_SIZE` and
> +
> +    * ``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE``
> +
> +    configuration options are mutually exclusive.
> +
>  .. Generated from spec:/acfg/if/init-task-entrypoint
>
>  .. index:: CONFIGURE_INIT_TASK_ENTRY_POINT
> @@ -229,7 +288,13 @@ DESCRIPTION:
>      Classic API initialization task.
>
>  NOTES:
> -    None.
> +    The
> +
> +    * ``CONFIGURE_INIT_TASK_STACK_SIZE`` and
> +
> +    * :ref:`CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE`
> +
> +    configuration options are mutually exclusive.
>
>  .. Generated from spec:/acfg/if/rtems-init-tasks-table
>
> --
> 2.26.2
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20201125/44fb014b/attachment-0001.html>