[rtems-central commit] spec: Move scheduler API to own header

Sebastian Huber sebh at rtems.org
Sat Dec 4 12:27:03 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Thu Dec  2 14:24:36 2021 +0100

spec: Move scheduler API to own header

---

 spec/rtems/if/header.yml                                |  3 +++
 spec/rtems/scheduler/if/add-processor.yml               |  2 +-
 spec/rtems/scheduler/if/get-maximum-priority.yml        |  2 +-
 spec/rtems/scheduler/if/get-processor-macro.yml         |  2 +-
 spec/rtems/scheduler/if/get-processor-maximum-macro.yml |  2 +-
 spec/rtems/scheduler/if/get-processor-maximum.yml       |  2 +-
 spec/rtems/scheduler/if/get-processor-set.yml           |  2 +-
 spec/rtems/scheduler/if/get-processor.yml               |  2 +-
 spec/rtems/scheduler/if/group.yml                       |  2 +-
 spec/rtems/scheduler/if/header.yml                      | 15 +++++++++++++++
 spec/rtems/scheduler/if/ident-by-processor-set.yml      |  2 +-
 spec/rtems/scheduler/if/ident-by-processor.yml          |  2 +-
 spec/rtems/scheduler/if/ident.yml                       |  2 +-
 spec/rtems/scheduler/if/map-priority-from-posix.yml     |  2 +-
 spec/rtems/scheduler/if/map-priority-to-posix.yml       |  2 +-
 spec/rtems/scheduler/if/remove-processor.yml            |  2 +-
 spec/rtems/scheduler/req/group.yml                      | 16 ++++++++++++++++
 17 files changed, 48 insertions(+), 14 deletions(-)

diff --git a/spec/rtems/if/header.yml b/spec/rtems/if/header.yml
index d21963d..d7ca64b 100644
--- a/spec/rtems/if/header.yml
+++ b/spec/rtems/if/header.yml
@@ -61,6 +61,9 @@ links:
   uid: ../region/if/header
 - enabled-by: []
   role: interface-include
+  uid: ../scheduler/if/header
+- enabled-by: []
+  role: interface-include
   uid: ../sem/if/header
 - enabled-by: []
   role: interface-include
diff --git a/spec/rtems/scheduler/if/add-processor.yml b/spec/rtems/scheduler/if/add-processor.yml
index 6a004fe..9195a52 100644
--- a/spec/rtems/scheduler/if/add-processor.yml
+++ b/spec/rtems/scheduler/if/add-processor.yml
@@ -20,7 +20,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/get-maximum-priority.yml b/spec/rtems/scheduler/if/get-maximum-priority.yml
index c58ccb9..bc8621b 100644
--- a/spec/rtems/scheduler/if/get-maximum-priority.yml
+++ b/spec/rtems/scheduler/if/get-maximum-priority.yml
@@ -18,7 +18,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/get-processor-macro.yml b/spec/rtems/scheduler/if/get-processor-macro.yml
index 08b809d..1fe3d38 100644
--- a/spec/rtems/scheduler/if/get-processor-macro.yml
+++ b/spec/rtems/scheduler/if/get-processor-macro.yml
@@ -11,7 +11,7 @@ index-entries: []
 interface-type: macro
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup-hidden
   uid: group
 name: rtems_scheduler_get_processor
diff --git a/spec/rtems/scheduler/if/get-processor-maximum-macro.yml b/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
index 4e40dab..41c338f 100644
--- a/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
+++ b/spec/rtems/scheduler/if/get-processor-maximum-macro.yml
@@ -11,7 +11,7 @@ index-entries: []
 interface-type: macro
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup-hidden
   uid: group
 name: rtems_scheduler_get_processor_maximum
diff --git a/spec/rtems/scheduler/if/get-processor-maximum.yml b/spec/rtems/scheduler/if/get-processor-maximum.yml
index bc1a8fc..7179e0d 100644
--- a/spec/rtems/scheduler/if/get-processor-maximum.yml
+++ b/spec/rtems/scheduler/if/get-processor-maximum.yml
@@ -26,7 +26,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/get-processor-set.yml b/spec/rtems/scheduler/if/get-processor-set.yml
index cdc514b..7c9ab49 100644
--- a/spec/rtems/scheduler/if/get-processor-set.yml
+++ b/spec/rtems/scheduler/if/get-processor-set.yml
@@ -20,7 +20,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/get-processor.yml b/spec/rtems/scheduler/if/get-processor.yml
index 830cc17..9c7c9d4 100644
--- a/spec/rtems/scheduler/if/get-processor.yml
+++ b/spec/rtems/scheduler/if/get-processor.yml
@@ -23,7 +23,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/group.yml b/spec/rtems/scheduler/if/group.yml
index 6474c61..c5ab8ce 100644
--- a/spec/rtems/scheduler/if/group.yml
+++ b/spec/rtems/scheduler/if/group.yml
@@ -22,7 +22,7 @@ index-entries: []
 interface-type: group
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: ../../if/group
 - role: placement-order
diff --git a/spec/rtems/scheduler/if/header.yml b/spec/rtems/scheduler/if/header.yml
new file mode 100644
index 0000000..6ad80de
--- /dev/null
+++ b/spec/rtems/scheduler/if/header.yml
@@ -0,0 +1,15 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the main parts of the Scheduler Manager API.
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+index-entries: []
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
+path: rtems/rtems/scheduler.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/scheduler/if/ident-by-processor-set.yml b/spec/rtems/scheduler/if/ident-by-processor-set.yml
index c6d8820..515d72f 100644
--- a/spec/rtems/scheduler/if/ident-by-processor-set.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor-set.yml
@@ -21,7 +21,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/ident-by-processor.yml b/spec/rtems/scheduler/if/ident-by-processor.yml
index ae1dafc..dbe29b3 100644
--- a/spec/rtems/scheduler/if/ident-by-processor.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor.yml
@@ -18,7 +18,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/ident.yml b/spec/rtems/scheduler/if/ident.yml
index 159faf8..663618e 100644
--- a/spec/rtems/scheduler/if/ident.yml
+++ b/spec/rtems/scheduler/if/ident.yml
@@ -20,7 +20,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/map-priority-from-posix.yml b/spec/rtems/scheduler/if/map-priority-from-posix.yml
index 39f8927..d51398d 100644
--- a/spec/rtems/scheduler/if/map-priority-from-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-from-posix.yml
@@ -19,7 +19,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/map-priority-to-posix.yml b/spec/rtems/scheduler/if/map-priority-to-posix.yml
index 9561ccb..472b996 100644
--- a/spec/rtems/scheduler/if/map-priority-to-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-to-posix.yml
@@ -19,7 +19,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/if/remove-processor.yml b/spec/rtems/scheduler/if/remove-processor.yml
index 0eff88f..d7a8b18 100644
--- a/spec/rtems/scheduler/if/remove-processor.yml
+++ b/spec/rtems/scheduler/if/remove-processor.yml
@@ -20,7 +20,7 @@ index-entries: []
 interface-type: function
 links:
 - role: interface-placement
-  uid: ../../task/if/header
+  uid: header
 - role: interface-ingroup
   uid: group
 - role: constraint
diff --git a/spec/rtems/scheduler/req/group.yml b/spec/rtems/scheduler/req/group.yml
new file mode 100644
index 0000000..d17389c
--- /dev/null
+++ b/spec/rtems/scheduler/req/group.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+identifier: RTEMSImplClassicScheduler
+links:
+- role: requirement-refinement
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+  The software architecture shall have a component containing the Scheduler
+  Manager implementation.
+type: requirement



More information about the vc mailing list