[rtems-central commit] spec: Move scheduler API to own group
Sebastian Huber
sebh at rtems.org
Wed Feb 3 05:28:01 UTC 2021
Module: rtems-central
Branch: master
Commit: f389cb495ca5b5aec7c7905feb419b9f27d32b8e
Changeset: http://git.rtems.org/rtems-central/commit/?id=f389cb495ca5b5aec7c7905feb419b9f27d32b8e
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Jan 15 14:01:59 2021 +0100
spec: Move scheduler API to own group
---
rtemsspec/applconfig.py | 2 +-
spec/rtems/scheduler/if/add-processor.yml | 2 +-
spec/rtems/scheduler/if/get-maximum-priority.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 | 31 ++++++++++++++++++++++
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 +-
.../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 +-
13 files changed, 43 insertions(+), 12 deletions(-)
diff --git a/rtemsspec/applconfig.py b/rtemsspec/applconfig.py
index c25503e..07a7490 100644
--- a/rtemsspec/applconfig.py
+++ b/rtemsspec/applconfig.py
@@ -337,7 +337,7 @@ _SPHINX_DOC_REFS = {
"mrsp": _sphinx_ref("MrsP"),
"pthread-setname-np": f"`PTHREAD_SETNAME_NP(3) <{_PTHREAD_NAME_NP}>`_",
"scheduler-cbs": _sphinx_ref("SchedulerCBS"),
- "scheduler-concepts": _sphinx_ref("SchedulingConcepts"),
+ "scheduler-concepts": _sphinx_ref("RTEMSAPIClassicScheduler"),
"scheduler-edf": _sphinx_ref("SchedulerEDF"),
"scheduler-priority": _sphinx_ref("SchedulerPriority"),
"scheduler-priority-simple": _sphinx_ref("SchedulerPrioritySimple"),
diff --git a/spec/rtems/scheduler/if/add-processor.yml b/spec/rtems/scheduler/if/add-processor.yml
index c7aa80b..5adc7b1 100644
--- a/spec/rtems/scheduler/if/add-processor.yml
+++ b/spec/rtems/scheduler/if/add-processor.yml
@@ -20,7 +20,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_add_processor
notes: |
This directive shall be called from task context. It obtains and releases
diff --git a/spec/rtems/scheduler/if/get-maximum-priority.yml b/spec/rtems/scheduler/if/get-maximum-priority.yml
index 002d3a9..4f8e841 100644
--- a/spec/rtems/scheduler/if/get-maximum-priority.yml
+++ b/spec/rtems/scheduler/if/get-maximum-priority.yml
@@ -20,7 +20,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_get_maximum_priority
notes: null
params:
diff --git a/spec/rtems/scheduler/if/get-processor-maximum.yml b/spec/rtems/scheduler/if/get-processor-maximum.yml
index 58fccf3..e76d3a2 100644
--- a/spec/rtems/scheduler/if/get-processor-maximum.yml
+++ b/spec/rtems/scheduler/if/get-processor-maximum.yml
@@ -23,7 +23,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_get_processor_maximum
notes: null
params: []
diff --git a/spec/rtems/scheduler/if/get-processor-set.yml b/spec/rtems/scheduler/if/get-processor-set.yml
index 9a942fc..c4dfbde 100644
--- a/spec/rtems/scheduler/if/get-processor-set.yml
+++ b/spec/rtems/scheduler/if/get-processor-set.yml
@@ -22,7 +22,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_get_processor_set
notes: null
params:
diff --git a/spec/rtems/scheduler/if/get-processor.yml b/spec/rtems/scheduler/if/get-processor.yml
index 2b1210d..a0578d2 100644
--- a/spec/rtems/scheduler/if/get-processor.yml
+++ b/spec/rtems/scheduler/if/get-processor.yml
@@ -21,7 +21,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_get_processor
notes: |
Outside of sections with disabled thread dispatching the current processor
diff --git a/spec/rtems/scheduler/if/group.yml b/spec/rtems/scheduler/if/group.yml
new file mode 100644
index 0000000..35f5798
--- /dev/null
+++ b/spec/rtems/scheduler/if/group.yml
@@ -0,0 +1,31 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ The scheduling concepts relate to the allocation of processing time for tasks.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: |
+ The concept of scheduling in real-time systems dictates the ability to
+ provide an immediate response to specific external events, particularly the
+ necessity of scheduling tasks to run within a specified time limit after the
+ occurrence of an event. For example, software embedded in life-support
+ systems used to monitor hospital patients must take instant action if a
+ change in the patient’s status is detected.
+
+ The component of RTEMS responsible for providing this capability is
+ appropriately called the scheduler. The scheduler’s sole purpose is to
+ allocate the all important resource of processor time to the various tasks
+ competing for attention.
+enabled-by: true
+identifier: RTEMSAPIClassicScheduler
+index-entries: []
+interface-type: group
+links:
+- role: interface-placement
+ uid: ../../task/if/header
+- role: interface-ingroup
+ uid: ../../if/group
+name: Scheduler Manager
+text: |
+ The Classic API shall provide an interface to the Scheduler Manager.
+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 69b8cdd..52275ca 100644
--- a/spec/rtems/scheduler/if/ident-by-processor-set.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor-set.yml
@@ -23,7 +23,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_ident_by_processor_set
notes: null
params:
diff --git a/spec/rtems/scheduler/if/ident-by-processor.yml b/spec/rtems/scheduler/if/ident-by-processor.yml
index a36ef72..5aaa848 100644
--- a/spec/rtems/scheduler/if/ident-by-processor.yml
+++ b/spec/rtems/scheduler/if/ident-by-processor.yml
@@ -20,7 +20,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_ident_by_processor
notes: null
params:
diff --git a/spec/rtems/scheduler/if/ident.yml b/spec/rtems/scheduler/if/ident.yml
index 1bb0759..f0816b1 100644
--- a/spec/rtems/scheduler/if/ident.yml
+++ b/spec/rtems/scheduler/if/ident.yml
@@ -20,7 +20,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_ident
notes: |
The scheduler name is determined by the scheduler configuration.
diff --git a/spec/rtems/scheduler/if/map-priority-from-posix.yml b/spec/rtems/scheduler/if/map-priority-from-posix.yml
index 4b8bbe0..53274b6 100644
--- a/spec/rtems/scheduler/if/map-priority-from-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-from-posix.yml
@@ -21,7 +21,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_map_priority_from_posix
notes: null
params:
diff --git a/spec/rtems/scheduler/if/map-priority-to-posix.yml b/spec/rtems/scheduler/if/map-priority-to-posix.yml
index 50d6b8d..4ca3e51 100644
--- a/spec/rtems/scheduler/if/map-priority-to-posix.yml
+++ b/spec/rtems/scheduler/if/map-priority-to-posix.yml
@@ -21,7 +21,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_map_priority_to_posix
notes: null
params:
diff --git a/spec/rtems/scheduler/if/remove-processor.yml b/spec/rtems/scheduler/if/remove-processor.yml
index 9db5152..654c4ec 100644
--- a/spec/rtems/scheduler/if/remove-processor.yml
+++ b/spec/rtems/scheduler/if/remove-processor.yml
@@ -20,7 +20,7 @@ links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
- uid: ../../task/if/group
+ uid: group
name: rtems_scheduler_remove_processor
notes: |
This directive shall be called from task context. It obtains and releases
More information about the vc
mailing list