[rtems-central commit] spec: Review task modes

Sebastian Huber sebh at rtems.org
Fri Sep 25 15:28:32 UTC 2020 

Module:    rtems-central
Branch:    master
Commit:    03a06bf4f0448ce22ae43b16fc25a0eadccd12f5
Changeset: http://git.rtems.org/rtems-central/commit/?id=03a06bf4f0448ce22ae43b16fc25a0eadccd12f5

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Sep 25 16:49:38 2020 +0200

spec: Review task modes

---

 spec/rtems/mode/if/all-mode-masks.yml                      |  3 ++-
 spec/rtems/mode/if/asr.yml                                 |  2 +-
 spec/rtems/mode/if/current-mode.yml                        |  4 ++--
 spec/rtems/mode/if/default.yml                             |  2 +-
 spec/rtems/mode/if/header.yml                              |  3 ++-
 spec/rtems/mode/if/interrupt-level-body.yml                | 10 ++++------
 spec/rtems/mode/if/interrupt-level.yml                     | 14 ++++++++------
 ...rrupt-mask-variable.yml => interrupt-mask-constant.yml} |  7 +++++--
 spec/rtems/mode/if/interrupt-mask.yml                      |  2 +-
 spec/rtems/mode/if/mode.yml                                |  2 +-
 spec/rtems/mode/if/no-asr.yml                              |  2 +-
 spec/rtems/mode/if/no-preempt.yml                          |  2 +-
 spec/rtems/mode/if/no-timeslice.yml                        |  2 +-
 spec/rtems/mode/if/preempt-mask.yml                        |  2 +-
 spec/rtems/mode/if/preempt.yml                             |  2 +-
 spec/rtems/mode/if/timeslice-mask.yml                      |  2 +-
 spec/rtems/mode/if/timeslice.yml                           |  2 +-
 17 files changed, 34 insertions(+), 29 deletions(-)

diff --git a/spec/rtems/mode/if/all-mode-masks.yml b/spec/rtems/mode/if/all-mode-masks.yml
index 92a8610..7329fcd 100644
--- a/spec/rtems/mode/if/all-mode-masks.yml
+++ b/spec/rtems/mode/if/all-mode-masks.yml
@@ -1,5 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: This mode constant is a mask with all mode bits set.
+brief: |
+  This task mode constant is a 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 54231e7..d33e91e 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 mode constant is used to indicate signal processing is enabled.
+  This task mode constant is used to indicate 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 06767b5..db7c3ef 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 mode constant is used when the user wishes to obtain their current
-  execution mode.
+  This task mode constant is used when the user wishes to obtain the current
+  task mode of the executing task.
 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/default.yml b/spec/rtems/mode/if/default.yml
index a5d62d7..422bace 100644
--- a/spec/rtems/mode/if/default.yml
+++ b/spec/rtems/mode/if/default.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This mode constant is the default mode set.
+  This task mode constant represents the default 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/header.yml b/spec/rtems/mode/if/header.yml
index 17d2964..c9175ba 100644
--- a/spec/rtems/mode/if/header.yml
+++ b/spec/rtems/mode/if/header.yml
@@ -1,5 +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.
+brief: |
+  This header file defines the task modes of the Task Manager API.
 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 16608cc..8aefe27 100644
--- a/spec/rtems/mode/if/interrupt-level-body.yml
+++ b/spec/rtems/mode/if/interrupt-level-body.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  Returns a mode with the desired interrupt level in the proper bit-field
-  location.
+  Returns the return value of ${interrupt-level:/name} for the specified
+  interrupt level.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -24,12 +24,10 @@ name: rtems_interrupt_level_body
 notes: |
   This function is used by bindings from languages other than C and C++.
 params:
-- description: is the desired interrupt level.
+- description: is the interrupt level.
   dir: null
   name: level
 return:
-  return: |
-    A mode with the desired interrupt level in the proper bit-field location is
-    returned.
+  return: null
   return-values: []
 type: interface
diff --git a/spec/rtems/mode/if/interrupt-level.yml b/spec/rtems/mode/if/interrupt-level.yml
index b4eb17e..50144b0 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 processor dependent interrupt level which corresponds to the
-  requested interrupt level.
+  Returns the task mode with the processor-dependent interrupt level
+  corresponding to the specified interrupt level.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -18,12 +18,14 @@ links:
   uid: group
 name: RTEMS_INTERRUPT_LEVEL
 notes: |
-  RTEMS supports 256 interrupt levels using the least significant eight bits of
-  the mode set. On any particular CPU, fewer than 256 levels may be supported.
+  The Classic API supports 256 interrupt levels using the least significant
+  eight bits of the mode set.  On any particular processor variant, fewer than
+  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 mode set.
+- description: is the interrupt level.
   dir: null
-  name: _mode_set
+  name: _interrupt_level
 return:
   return: null
   return-values: []
diff --git a/spec/rtems/mode/if/interrupt-mask-variable.yml b/spec/rtems/mode/if/interrupt-mask-constant.yml
similarity index 73%
rename from spec/rtems/mode/if/interrupt-mask-variable.yml
rename to spec/rtems/mode/if/interrupt-mask-constant.yml
index 6e185f6..95d2011 100644
--- a/spec/rtems/mode/if/interrupt-mask-variable.yml
+++ b/spec/rtems/mode/if/interrupt-mask-constant.yml
@@ -1,5 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This task mode constant has the same value as ${interrupt-mask:/name}.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -15,5 +16,7 @@ links:
 - role: interface-ingroup
   uid: group
 name: rtems_interrupt_mask
-notes: null
+notes: |
+  This task mode constant is used by bindings from languages other than C and
+  C++.
 type: interface
diff --git a/spec/rtems/mode/if/interrupt-mask.yml b/spec/rtems/mode/if/interrupt-mask.yml
index 8f343f1..d2b8c30 100644
--- a/spec/rtems/mode/if/interrupt-mask.yml
+++ b/spec/rtems/mode/if/interrupt-mask.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This mode constant corresponds to the interrupt enable/disable bits.
+  This task mode constant corresponds to the interrupt enable/disable bits.
 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/mode.yml b/spec/rtems/mode/if/mode.yml
index 4ecfc56..13b11b2 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 defines the control block used to manage each a mode set.
+  This type is used to represent a 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 c227880..4059287 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 mode constant is used to indicate signal processing is disabled.
+  This task mode constant is used to indicate 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 f6183fe..5c57659 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 mode constant is used to indicate preemption is disabled.
+  This task mode constant is used to indicate 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 de7aec7..975d3ec 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 mode constant is used to indicate timeslicing is disabled.
+  This task mode constant is used to indicate 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-mask.yml b/spec/rtems/mode/if/preempt-mask.yml
index 8020cb4..294c986 100644
--- a/spec/rtems/mode/if/preempt-mask.yml
+++ b/spec/rtems/mode/if/preempt-mask.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This mode constant corresponds to the preemption enable/disable bit.
+  This task mode constant corresponds to the preemption enable/disable bit.
 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 c513ffa..c1953be 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 mode constant is used to indicate preemption is enabled.
+  This task mode constant is used to indicate 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-mask.yml b/spec/rtems/mode/if/timeslice-mask.yml
index c1846c5..39fe499 100644
--- a/spec/rtems/mode/if/timeslice-mask.yml
+++ b/spec/rtems/mode/if/timeslice-mask.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This mode constant corresponds to the timeslice enable/disable bit.
+  This task mode constant corresponds to the timeslice enable/disable bit.
 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 1d2f98b..6e8f4f9 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 mode constant is used to indicate timeslicing is enabled.
+  This task mode constant is used to indicate timeslicing is enabled.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)

More information about the vc mailing list