diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-15 14:01:59 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-02-03 06:26:37 +0100 |
commit | f389cb495ca5b5aec7c7905feb419b9f27d32b8e (patch) | |
tree | 0786a2f37a63fcb444081d0fbbca12b4da97ff27 | |
parent | spec: Clarify object services (diff) | |
download | rtems-central-f389cb495ca5b5aec7c7905feb419b9f27d32b8e.tar.bz2 |
spec: Move scheduler API to own group
-rw-r--r-- | rtemsspec/applconfig.py | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/add-processor.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/get-maximum-priority.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/get-processor-maximum.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/get-processor-set.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/get-processor.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/group.yml | 31 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/ident-by-processor-set.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/ident-by-processor.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/ident.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/map-priority-from-posix.yml | 2 | ||||
-rw-r--r-- | spec/rtems/scheduler/if/map-priority-to-posix.yml | 2 | ||||
-rw-r--r-- | 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 c25503e7..07a74907 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 c7aa80b2..5adc7b10 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 002d3a94..4f8e8417 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 58fccf31..e76d3a2e 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 9a942fc5..c4dfbdeb 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 2b1210d0..a0578d20 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 00000000..35f57989 --- /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 69b8cddf..52275ca0 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 a36ef72e..5aaa848d 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 1bb0759d..f0816b18 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 4b8bbe0f..53274b67 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 50d6b8d9..4ca3e515 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 9db5152b..654c4ec8 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 |