blob: 9db5152bb9ac807c5d4619b0deb2cce1d6cb6c2f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Removes a processor from set of processors owned by the scheduler instance.
copyrights:
- Copyright (C) 2016, 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
- ${/c/if/uint32_t:/name} ${.:/params[1]/name}
return: ${../../status/if/code:/name}
variants: []
description: null
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: ../../task/if/header
- role: interface-ingroup
uid: ../../task/if/group
name: rtems_scheduler_remove_processor
notes: |
This directive shall be called from task context. It obtains and releases
the objects allocator lock. Removing a processor from a scheduler instance
is a complex operation that involves all tasks of the system.
params:
- description: is the scheduler instance identifier.
dir: null
name: scheduler_id
- description: is the index of the processor to remove.
dir: null
name: cpu_index
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
There was no scheduler associated with the identifier specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The processor was not owned by the specified scheduler instance.
value: ${../../status/if/invalid-number:/name}
- description: |
The set of processors owned by the specified scheduler instance would
have been empty after the processor removal and there was at least one
non-idle task that used this scheduler instance as its home scheduler
instance.
value: ${../../status/if/resource-in-use:/name}
type: interface
|
