summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/scheduler/ident-by-processor-set.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/if/rtems/scheduler/ident-by-processor-set.yml')
-rw-r--r--spec/if/rtems/scheduler/ident-by-processor-set.yml63
1 files changed, 0 insertions, 63 deletions
diff --git a/spec/if/rtems/scheduler/ident-by-processor-set.yml b/spec/if/rtems/scheduler/ident-by-processor-set.yml
deleted file mode 100644
index bc9e9ff9..00000000
--- a/spec/if/rtems/scheduler/ident-by-processor-set.yml
+++ /dev/null
@@ -1,63 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- Identifies a scheduler instance by a processor set.
-copyrights:
-- Copyright (C) 2017, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-definition:
- default:
- body: null
- params:
- - ${/if/c/size_t:/name} ${.:/params[0]/name}
- - const ${/if/c/cpu_set_t:/name} *${.:/params[1]/name}
- - ${../types/id:/name} *${.:/params[2]/name}
- return: ${../status/code:/name}
- variants: []
-description: |
- The scheduler instance is selected according to the highest numbered online
- processor in the specified processor set.
-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_set
-notes: null
-params:
-- description: |
- is the size of the referenced processor set variable in bytes. This value
- shall be positive.
- dir: null
- name: cpusetsize
-- description: |
- is the pointer to a processor set variable. The referenced processor set
- will be used to identify the scheduler instance.
- dir: null
- name: cpuset
-- 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 set was valid, however, the highest numbered online
- processor in the processor set was not owned by a scheduler instance.
- value: ${../status/incorrect-state:/name}
- - description: |
- The ${.:/params[2]/name} parameter was ${/if/c/null:/name}.
- value: ${../status/invalid-address:/name}
- - description: |
- The processor set contained no online processor.
- value: ${../status/invalid-name:/name}
- - description: |
- The processor set size was invalid.
- value: ${../status/invalid-size:/name}
-type: interface