diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 16:22:15 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 16:33:04 +0200 |
| commit | 3b1ae6dc995be529375d5193f4bcc05960820e7d (patch) | |
| tree | 224bc482ccc4876c303230ae0607e22b9d3fc6d4 /spec/rtems/task/if/construct.yml | |
| parent | spec: Group items by component (diff) | |
| download | rtems-central-3b1ae6dc995be529375d5193f4bcc05960820e7d.tar.bz2 | |
spec: Document rtems_task_construct(), ...
Diffstat (limited to 'spec/rtems/task/if/construct.yml')
| -rw-r--r-- | spec/rtems/task/if/construct.yml | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/spec/rtems/task/if/construct.yml b/spec/rtems/task/if/construct.yml index d5168070..867aee1d 100644 --- a/spec/rtems/task/if/construct.yml +++ b/spec/rtems/task/if/construct.yml @@ -26,14 +26,26 @@ notes: | contains the task stack, the thread-local storage, and the floating-point context on architectures with a separate floating-point context. - It is not recommended to mix ${create:/name} and ${.:/name} in an - application. This directive is intended for applications which do not want - to use the RTEMS Workspace and instead statically allocate all operating - system resources. The stack space estimate done by <rtems/confdefs.h> - assumes that all tasks are created by ${create:/name}. The estimate can be - adjusted to take user-provided task storage areas into account through the + This directive is intended for applications which do not want to use the + RTEMS Workspace and instead statically allocate all operating system + resources. It is not recommended to use ${create:/name} and ${.:/name} + together in an application. It is also not recommended to use ${.:/name} for + drivers or general purpose libraries. The reason for these recommendations + is that the task configuration needs settings which can be only given with a + through knowledge of the application resources. + + An application based solely on static allocation can avoid any runtime memory + allocators. This can simplfiy the application architecture as well as any + analysis that may be required. + + The stack space estimate done by <rtems/confdefs.h> assumes that all tasks + are created by ${create:/name}. The estimate can be adjusted to take + user-provided task storage areas into account through the ${/acfg/if/min-tasks-with-user-provided-storage:/name} application configuration option. + + The ${/acfg/if/max-tasks:/name} should include tasks constructed by + ${create:/name}. params: - description: is the task configuration. dir: null |