summaryrefslogtreecommitdiffstats
path: root/spec/if/rtems/scheduler/add-processor.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/if/rtems/scheduler/add-processor.yml')
-rw-r--r--spec/if/rtems/scheduler/add-processor.yml52
1 files changed, 0 insertions, 52 deletions
diff --git a/spec/if/rtems/scheduler/add-processor.yml b/spec/if/rtems/scheduler/add-processor.yml
deleted file mode 100644
index a13eb90b..00000000
--- a/spec/if/rtems/scheduler/add-processor.yml
+++ /dev/null
@@ -1,52 +0,0 @@
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
- Adds the processor to the set of processors owned by the scheduler instance.
-copyrights:
-- Copyright (C) 2016, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-definition:
- default:
- body: null
- params:
- - ${../types/id:/name} ${.:/params[0]/name}
- - ${/if/c/uint32_t:/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_add_processor
-notes: |
- This directive shall be called from task context. It obtains and releases
- the objects allocator lock.
-params:
-- description: is the scheduler instance identifier.
- dir: null
- name: scheduler_id
-- description: is the index of the processor to add.
- dir: null
- name: cpu_index
-return:
- return: null
- return-values:
- - description: |
- The requested operation was successful.
- value: ${../status/successful:/name}
- - description: |
- The processor was configured to be used by the application, however, it
- was not online.
- value: ${../status/incorrect-state:/name}
- - description: |
- The scheduler instance identifier was invalid.
- value: ${../status/invalid-id:/name}
- - description: |
- The processor was not configured to be used by the application.
- value: ${../status/not-configured:/name}
- - description: |
- The processor was already assigned to a scheduler instance.
- value: ${../status/resource-in-use:/name}
-type: interface