diff options
Diffstat (limited to 'spec/rtems/scheduler/if/ident-by-processor.yml')
| -rw-r--r-- | spec/rtems/scheduler/if/ident-by-processor.yml | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/spec/rtems/scheduler/if/ident-by-processor.yml b/spec/rtems/scheduler/if/ident-by-processor.yml new file mode 100644 index 00000000..4a05cc96 --- /dev/null +++ b/spec/rtems/scheduler/if/ident-by-processor.yml @@ -0,0 +1,51 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + Identifies a scheduler instance by a processor index. +copyrights: +- Copyright (C) 2017, 2020 embedded brains GmbH (http://www.embedded-brains.de) +definition: + default: + body: null + params: + - ${/c/if/uint32_t:/name} ${.:/params[0]/name} + - ${../../type/if/id:/name} *${.:/params[1]/name} + return: ${../../status/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: ../../task/if/header +- role: interface-ingroup + uid: ../../task/if/group +name: rtems_scheduler_ident_by_processor +notes: null +params: +- description: | + is the processor index to identify the scheduler instance. + dir: null + name: cpu_index +- description: | + is the pointer to an object identifier variable. The identifier of the + scheduler instance will be stored in this variable, in case of a successful + operation. + dir: out + name: id +return: + return: null + return-values: + - description: | + The requested operation was successful. + value: ${../../status/if/successful:/name} + - description: | + The processor index was valid, however, the corresponding processor was + not owned by a scheduler instance. + value: ${../../status/if/incorrect-state:/name} + - description: | + The ${.:/params[1]/name} parameter was ${/c/if/null:/name}. + value: ${../../status/if/invalid-address:/name} + - description: | + The processor index was invalid. + value: ${../../status/if/invalid-name:/name} +type: interface |