summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:33:48 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 09:33:48 +0100
commitfb94d6da8cc8feb881ddd245de55325267cdbd24 (patch)
tree03b466939c823f234cc868af43ca04189ef63232
parentf0d19f9749d813e8c2bbdab6383c4669a0829c4a (diff)
downloadrtems-central-fb94d6da8cc8feb881ddd245de55325267cdbd24.tar.bz2
spec: Review task modes API
-rw-r--r--spec/rtems/mode/if/all-mode-masks.yml2
-rw-r--r--spec/rtems/mode/if/asr.yml2
-rw-r--r--spec/rtems/mode/if/current-mode.yml4
-rw-r--r--spec/rtems/mode/if/header.yml2
-rw-r--r--spec/rtems/mode/if/interrupt-level-body.yml7
-rw-r--r--spec/rtems/mode/if/interrupt-level.yml8
-rw-r--r--spec/rtems/mode/if/interrupt-mask-constant.yml2
-rw-r--r--spec/rtems/mode/if/mode.yml2
-rw-r--r--spec/rtems/mode/if/no-asr.yml2
-rw-r--r--spec/rtems/mode/if/no-preempt.yml2
-rw-r--r--spec/rtems/mode/if/no-timeslice.yml2
-rw-r--r--spec/rtems/mode/if/preempt.yml2
-rw-r--r--spec/rtems/mode/if/timeslice.yml2
13 files changed, 21 insertions, 18 deletions
diff --git a/spec/rtems/mode/if/all-mode-masks.yml b/spec/rtems/mode/if/all-mode-masks.yml
index 6f594413..88f67fec 100644
--- a/spec/rtems/mode/if/all-mode-masks.yml
+++ b/spec/rtems/mode/if/all-mode-masks.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is a mask with all mode bits set.
+ This task mode constant is a bit mask with all mode bits set.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/asr.yml b/spec/rtems/mode/if/asr.yml
index fec646b2..e80ca809 100644
--- a/spec/rtems/mode/if/asr.yml
+++ b/spec/rtems/mode/if/asr.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate signal processing is disabled.
+ This task mode constant indicates that signal processing is disabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/current-mode.yml b/spec/rtems/mode/if/current-mode.yml
index 0c8a848d..2f5b3a7e 100644
--- a/spec/rtems/mode/if/current-mode.yml
+++ b/spec/rtems/mode/if/current-mode.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used when the user wishes to obtain the current
- task mode of the executing task.
+ This task mode constant indicates that the current task mode of the executing
+ task shall be returned by ${../../task/if/mode:/name}.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/header.yml b/spec/rtems/mode/if/header.yml
index 930530d0..3877c3b4 100644
--- a/spec/rtems/mode/if/header.yml
+++ b/spec/rtems/mode/if/header.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This header file defines the task modes of the Task Manager API.
+ This header file provides the task modes API of the Task Manager.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
diff --git a/spec/rtems/mode/if/interrupt-level-body.yml b/spec/rtems/mode/if/interrupt-level-body.yml
index 9c736beb..a42fb0de 100644
--- a/spec/rtems/mode/if/interrupt-level-body.yml
+++ b/spec/rtems/mode/if/interrupt-level-body.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the return value of ${interrupt-level:/name} for the specified
+ Maps the interrupt level to the associated processor-dependent task mode
interrupt level.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -26,10 +26,11 @@ name: rtems_interrupt_level_body
notes: |
This function is used by bindings from languages other than C and C++.
params:
-- description: is the interrupt level.
+- description: is the interrupt level to map.
dir: null
name: level
return:
- return: null
+ return: |
+ Returns ${interrupt-level:/name} for the interrupt level.
return-values: []
type: interface
diff --git a/spec/rtems/mode/if/interrupt-level.yml b/spec/rtems/mode/if/interrupt-level.yml
index 58ee892d..23949c53 100644
--- a/spec/rtems/mode/if/interrupt-level.yml
+++ b/spec/rtems/mode/if/interrupt-level.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- Returns the task mode with the processor-dependent interrupt level
- corresponding to the specified interrupt level.
+ Maps the interrupt level to the associated processor-dependent task mode
+ interrupt level.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -24,10 +24,12 @@ notes: |
256 levels may be supported. At least level 0 (all interrupts enabled) and
level 1 (interrupts disabled, on most architectures) are supported.
params:
-- description: is the interrupt level.
+- description: is the interrupt level to map.
dir: null
name: _interrupt_level
return:
return: null
+ Returns the processor-dependent task mode interrupt level associated with
+ the interrupt level.
return-values: []
type: interface
diff --git a/spec/rtems/mode/if/interrupt-mask-constant.yml b/spec/rtems/mode/if/interrupt-mask-constant.yml
index d53496eb..4d33951a 100644
--- a/spec/rtems/mode/if/interrupt-mask-constant.yml
+++ b/spec/rtems/mode/if/interrupt-mask-constant.yml
@@ -7,7 +7,7 @@ copyrights:
definition:
default: const ${/c/if/uint32_t:/name} ${.:/name}
variants: []
-description: '%'
+description: null
enabled-by: true
index-entries: []
interface-type: variable
diff --git a/spec/rtems/mode/if/mode.yml b/spec/rtems/mode/if/mode.yml
index 144e9739..a1824484 100644
--- a/spec/rtems/mode/if/mode.yml
+++ b/spec/rtems/mode/if/mode.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This type is used to represent a task mode set.
+ This type represents a Classic API task mode set.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/no-asr.yml b/spec/rtems/mode/if/no-asr.yml
index 15f5927b..665de5b2 100644
--- a/spec/rtems/mode/if/no-asr.yml
+++ b/spec/rtems/mode/if/no-asr.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate signal processing is disabled.
+ This task mode constant indicates that signal processing is disabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/no-preempt.yml b/spec/rtems/mode/if/no-preempt.yml
index 6a55b6d9..52a6ac54 100644
--- a/spec/rtems/mode/if/no-preempt.yml
+++ b/spec/rtems/mode/if/no-preempt.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate preemption is disabled.
+ This task mode constant indicates that preemption is disabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/no-timeslice.yml b/spec/rtems/mode/if/no-timeslice.yml
index 694c34a8..160a16ba 100644
--- a/spec/rtems/mode/if/no-timeslice.yml
+++ b/spec/rtems/mode/if/no-timeslice.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate timeslicing is disabled.
+ This task mode constant indicates that timeslicing is disabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/preempt.yml b/spec/rtems/mode/if/preempt.yml
index 2bd56736..68a1e200 100644
--- a/spec/rtems/mode/if/preempt.yml
+++ b/spec/rtems/mode/if/preempt.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate preemption is enabled.
+ This task mode constant indicates that preemption is enabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/mode/if/timeslice.yml b/spec/rtems/mode/if/timeslice.yml
index 11a02fe8..9beefb66 100644
--- a/spec/rtems/mode/if/timeslice.yml
+++ b/spec/rtems/mode/if/timeslice.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This task mode constant is used to indicate timeslicing is enabled.
+ This task mode constant indicates that timeslicing is enabled.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)