diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 11:48:29 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-16 16:33:00 +0200 |
commit | 3bdf817950eadd75a2785b62220eb0b04533b9fd (patch) | |
tree | ed221c6de813e7a473e2882af6326bf2e5b44bd1 /spec/if/rtems/scheduler/ident-by-processor.yml | |
parent | spec: Specify rtems_task_construct() (diff) | |
download | rtems-central-3bdf817950eadd75a2785b62220eb0b04533b9fd.tar.bz2 |
spec: Group items by component
Diffstat (limited to 'spec/if/rtems/scheduler/ident-by-processor.yml')
-rw-r--r-- | spec/if/rtems/scheduler/ident-by-processor.yml | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/spec/if/rtems/scheduler/ident-by-processor.yml b/spec/if/rtems/scheduler/ident-by-processor.yml deleted file mode 100644 index 1c41f1ee..00000000 --- a/spec/if/rtems/scheduler/ident-by-processor.yml +++ /dev/null @@ -1,51 +0,0 @@ -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: - - ${/if/c/uint32_t:/name} ${.:/params[0]/name} - - ${../types/id:/name} *${.:/params[1]/name} - return: ${../status/code:/name} - variants: [] -description: null -enabled-by: true -interface-type: function -links: -- role: interface-placement - uid: ../tasks/header -- role: interface-ingroup - uid: ../tasks/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/successful:/name} - - description: | - The processor index was valid, however, the corresponding processor was - not owned by a scheduler instance. - value: ${../status/incorrect-state:/name} - - description: | - The ${.:/params[1]/name} parameter was ${/if/c/null:/name}. - value: ${../status/invalid-address:/name} - - description: | - The processor index was invalid. - value: ${../status/invalid-name:/name} -type: interface |