diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-03-27 12:53:09 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-04-01 07:49:12 +0200 |
| commit | 7bad8940ad05ea1e3b41745012a0dc5391275477 (patch) | |
| tree | 417974a7eedf1b89c709648c36e1d234934b9ff7 /c-user/config/task-stack-alloc.rst | |
| parent | c-user: Avoid self references (diff) | |
| download | rtems-docs-7bad8940ad05ea1e3b41745012a0dc5391275477.tar.bz2 | |
c-user: Use new template for integer config opts
Try to bring all descriptions up to date. Add cross-references to
several options. Clarify configuration value constraints.
Use this template also for initializer type options.
Close #3901.
Diffstat (limited to 'c-user/config/task-stack-alloc.rst')
| -rw-r--r-- | c-user/config/task-stack-alloc.rst | 73 |
1 files changed, 37 insertions, 36 deletions
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst index e031595..513815c 100644 --- a/c-user/config/task-stack-alloc.rst +++ b/c-user/config/task-stack-alloc.rst @@ -22,28 +22,29 @@ CONFIGURE_TASK_STACK_ALLOCATOR CONSTANT: ``CONFIGURE_TASK_STACK_ALLOCATOR`` -DATA TYPE: - Function pointer. - -RANGE: - Undefined or valid function pointer. +OPTION TYPE: + This configuration option is an initializer define. DEFAULT VALUE: The default value is ``_Workspace_Allocate``, which indicates that task stacks will be allocated from the RTEMS Workspace. +VALUE CONSTRAINTS: + The value of this configuration option shall be defined to a valid function + pointer of the type ``void *( *allocate )( size_t )``. + DESCRIPTION: - ``CONFIGURE_TASK_STACK_ALLOCATOR`` may point to a user provided routine to - allocate task stacks. + The value of this configuration option initializes the stack allocator + allocate handler. NOTES: - A correctly configured system must configure the following to be consistent: + A correctly configured system shall configure the following to be consistent: - - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT` - - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + - `CONFIGURE_TASK_STACK_ALLOCATOR` - - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` + - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` .. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT @@ -55,29 +56,28 @@ CONFIGURE_TASK_STACK_ALLOCATOR_INIT CONSTANT: ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` -DATA TYPE: - Function pointer. - -RANGE: - Undefined, NULL or valid function pointer. +OPTION TYPE: + This configuration option is an initializer define. DEFAULT VALUE: - The default value is NULL, which indicates that task stacks will be - allocated from the RTEMS Workspace. + The default value is ``NULL``. + +VALUE CONSTRAINTS: + The value of this configuration option shall be defined to a valid function + pointer of the type ``void ( *initialize )( size_t )`` or to ``NULL``. DESCRIPTION: - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` configures the initialization - method for an application or BSP specific task stack allocation - implementation. + The value of this configuration option initializes the stack allocator + initialization handler. NOTES: - A correctly configured system must configure the following to be consistent: + A correctly configured system shall configure the following to be consistent: - - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + - `CONFIGURE_TASK_STACK_ALLOCATOR_INIT` - - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` - - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` + - :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR` .. index:: CONFIGURE_TASK_STACK_DEALLOCATOR .. index:: task stack deallocator @@ -90,25 +90,26 @@ CONFIGURE_TASK_STACK_DEALLOCATOR CONSTANT: ``CONFIGURE_TASK_STACK_DEALLOCATOR`` -DATA TYPE: - Function pointer. - -RANGE: - Undefined or valid function pointer. +OPTION TYPE: + This configuration option is an initializer define. DEFAULT VALUE: The default value is ``_Workspace_Free``, which indicates that task stacks will be allocated from the RTEMS Workspace. +VALUE CONSTRAINTS: + The value of this configuration option shall be defined to a valid function + pointer of the type ``void ( *deallocate )( void * )``. + DESCRIPTION: - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` may point to a user provided routine - to free task stacks. + The value of this configuration option initializes the stack allocator + deallocate handler. NOTES: - A correctly configured system must configure the following to be consistent: + A correctly configured system shall configure the following to be consistent: - - ``CONFIGURE_TASK_STACK_ALLOCATOR_INIT`` + - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR_INIT` - - ``CONFIGURE_TASK_STACK_ALLOCATOR`` + - :ref:`CONFIGURE_TASK_STACK_ALLOCATOR` - - ``CONFIGURE_TASK_STACK_DEALLOCATOR`` + - `CONFIGURE_TASK_STACK_DEALLOCATOR` |