summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-19 15:33:26 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-27 08:39:49 +0100
commit4896f8a46442ebda0d4b19c4a05e25aee3902692 (patch)
tree43a86c921565ba39dd7158bf639f1060cca860c8
parentRevert "interfacedoc: Strip leading "_" from parameters" (diff)
downloadrtems-central-4896f8a46442ebda0d4b19c4a05e25aee3902692.tar.bz2
spec: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
-rw-r--r--spec/acfg/if/init-task-construct-storage-size.yml53
-rw-r--r--spec/acfg/if/init-task-stack-size.yml9
2 files changed, 61 insertions, 1 deletions
diff --git a/spec/acfg/if/init-task-construct-storage-size.yml b/spec/acfg/if/init-task-construct-storage-size.yml
new file mode 100644
index 00000000..d01a094b
--- /dev/null
+++ b/spec/acfg/if/init-task-construct-storage-size.yml
@@ -0,0 +1,53 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+appl-config-option-type: integer
+constraints:
+ min: ${min-task-stack-size:/name}
+ texts:
+ - |
+ The value of this configuration option shall be defined using
+ ${/rtems/task/if/storage-size:/name}.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+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 ${init-task-stack-size:/name} configuration option.
+description: |
+ The value of this configuration option defines the task storage size of the
+ Classic API initialization task.
+enabled-by: true
+index-entries: []
+interface-type: appl-config-option
+links:
+- role: appl-config-group-member
+ uid: group-classicinit
+name: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
+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
+ ${/rtems/task/if/construct:/name} instead of using
+ ${/rtems/task/if/create:/name},
+
+ * the maximum thread-local storage size defined by
+ ${max-thread-local-storage-size:/name} is used for the Classic API
+ initialization task,
+
+ * the Classic API initialization task should be accounted for in
+ ${min-tasks-with-user-provided-storage:/name}, and
+
+ * the task storage area used for the Classic API initialization task is not
+ reclaimed by the system if the task is deleted.
+
+ The
+
+ * ${init-task-stack-size:/name} and
+
+ * ``CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE``
+
+ configuration options are mutually exclusive.
+text: ''
+type: interface
diff --git a/spec/acfg/if/init-task-stack-size.yml b/spec/acfg/if/init-task-stack-size.yml
index 8bccea64..ba0a8275 100644
--- a/spec/acfg/if/init-task-stack-size.yml
+++ b/spec/acfg/if/init-task-stack-size.yml
@@ -17,6 +17,13 @@ links:
- role: constraint
uid: constraint-stackspace
name: CONFIGURE_INIT_TASK_STACK_SIZE
-notes: null
+notes: |
+ The
+
+ * ``CONFIGURE_INIT_TASK_STACK_SIZE`` and
+
+ * ${init-task-construct-storage-size:/name}
+
+ configuration options are mutually exclusive.
text: ''
type: interface