[rtems-central commit] spec: Review task modes API

Sebastian Huber sebh at rtems.org
Mon Nov 9 09:49:19 UTC 2020


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Nov  9 09:33:48 2020 +0100

spec: Review task modes API

---

 spec/rtems/mode/if/all-mode-masks.yml          | 2 +-
 spec/rtems/mode/if/asr.yml                     | 2 +-
 spec/rtems/mode/if/current-mode.yml            | 4 ++--
 spec/rtems/mode/if/header.yml                  | 2 +-
 spec/rtems/mode/if/interrupt-level-body.yml    | 7 ++++---
 spec/rtems/mode/if/interrupt-level.yml         | 8 +++++---
 spec/rtems/mode/if/interrupt-mask-constant.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.yml                 | 2 +-
 spec/rtems/mode/if/timeslice.yml               | 2 +-
 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 6f59441..88f67fe 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 fec646b..e80ca80 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 0c8a848..2f5b3a7 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 930530d..3877c3b 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 9c736be..a42fb0d 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 58ee892..23949c5 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 d53496e..4d33951 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 144e973..a182448 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 15f5927..665de5b 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 6a55b6d..52a6ac5 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 694c34a..160a16b 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 2bd5673..68a1e20 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 11a02fe..9beefb6 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)



More information about the vc mailing list