summaryrefslogtreecommitdiffstats
path: root/spec/rtems/userext/if/task-start.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-09-09 15:29:54 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-09-14 14:32:42 +0200
commit94d88e4cdeb4527ca32efc2c22aecaf374cc0bf0 (patch)
tree3f3bfe6d9fb42a750a6bc6388008f8e145a5d798 /spec/rtems/userext/if/task-start.yml
parentinterface: Add parameters and return to typedefs (diff)
downloadrtems-central-94d88e4cdeb4527ca32efc2c22aecaf374cc0bf0.tar.bz2
spec: Document the user extension manager
Diffstat (limited to 'spec/rtems/userext/if/task-start.yml')
-rw-r--r--spec/rtems/userext/if/task-start.yml28
1 files changed, 23 insertions, 5 deletions
diff --git a/spec/rtems/userext/if/task-start.yml b/spec/rtems/userext/if/task-start.yml
index ffbbbef8..dd775b53 100644
--- a/spec/rtems/userext/if/task-start.yml
+++ b/spec/rtems/userext/if/task-start.yml
@@ -1,8 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Task start extensions are invoked when a task was made ready for the first
+ time.
copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+- Copyright (C) 2009, 2021 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default: ${/score/userext/if/thread-start:/name} ${.:/name}
variants: []
@@ -15,8 +16,25 @@ links:
uid: header
- role: interface-ingroup
uid: group
+- role: constraint
+ uid: /constraint/thread-dispatching-disabled
name: rtems_task_start_extension
-notes: null
-params: []
+notes: |
+ The task start extensions are invoked in
+ ${/glossary/extension-forward-order:/term}.
+
+ In SMP configurations, the thread may already run on another processor before
+ the task start extensions are actually invoked. Task switch and task begin
+ extensions may run before or in parallel with the thread start extension in
+ SMP configurations, see ${task-switch:/name} and ${task-begin:/name}.
+params:
+- description: |
+ is the ${/glossary/tcb:/term} of the executing thread.
+ dir: null
+ name: executing
+- description: |
+ is the ${/glossary/tcb:/term} of the started thread.
+ dir: null
+ name: started
return: null
type: interface