summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-17 18:13:06 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-17 18:14:23 +0200
commit28db97275b29b3b9bd624fe9f053dd46656bad61 (patch)
tree1e418b6746f0c969386719d5658fc76ff7d6a7f4
parenta5fe9aad19fe003748e0100243c14da5fb9a7d66 (diff)
downloadrtems-docs-28db97275b29b3b9bd624fe9f053dd46656bad61.tar.bz2
c-user: CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE
Document this application configuration option. Update #3959.
-rw-r--r--c-user/config/classic-api.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
index 962aa40..bc6bfab 100644
--- a/c-user/config/classic-api.rst
+++ b/c-user/config/classic-api.rst
@@ -485,3 +485,35 @@ DESCRIPTION:
NOTES:
This object class cannot be configured in unlimited allocation mode.
+
+.. index:: CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE
+
+.. _CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE:
+
+CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE
+--------------------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE``
+
+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 be greater than or equal to 0
+ and less than or equal to :ref:`CONFIGURE_MAXIMUM_TASKS`.
+
+DESCRIPTION:
+ The value of this configuration option defines the minimum count of Classic
+ API Tasks which are constructed by :c:func:`rtems_task_construct`.
+
+NOTES:
+ By default, the calculation for the required memory in the RTEMS Workspace
+ for tasks assumes that all Classic API Tasks are created by
+ :c:func:`rtems_task_create`. This configuration option can be used to
+ reduce the required memory for the system-provided task storage areas since
+ tasks constructed by :c:func:`rtems_task_construct` use a user-provided
+ task storage area.