spec: Group items by component

1 files changed, 35 insertions, 0 deletions

diff --git a/spec/rtems/scheduler/if/get-processor.yml b/spec/rtems/scheduler/if/get-processor.yml
new file mode 100644
index 00000000..8c32712b
--- /dev/null
+++ b/spec/rtems/scheduler/if/get-processor.yml
@@ -0,0 +1,35 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Returns the index of the current processor.
+copyrights:
+- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/score/smp/if/get-current-processor:/name}()
+  variants: []
+description: |
+  In uniprocessor configurations, this macro evaluates to a compile time
+  constant of zero.
+
+  In SMP configurations, an architecture-specific method is used to obtain the
+  index of the current processor in the system.  The set of processor indices
+  is the range of integers starting with zero up to
+  ${get-processor-maximum:/name} minus one.
+enabled-by: true
+interface-type: macro
+links:
+- role: interface-placement
+  uid: ../../task/if/header
+- role: interface-ingroup
+  uid: ../../task/if/group
+name: rtems_scheduler_get_processor
+notes: |
+  Outside of sections with disabled thread dispatching the current processor
+  index may change after every instruction since the thread may migrate from
+  one processor to another.  Sections with disabled interrupts are sections
+  with thread dispatching disabled.
+params: []
+return:
+  return: |
+    The index of the current processor is returned.
+  return-values: []
+type: interface