blob: fdff5d86d47d8d14700dbbd23449d8463adabda4 (
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
56
57
58
59
60
61
62
63
64
65
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the set of processors owned by the scheduler.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
- ${/c/if/size_t:/name} ${.:/params[1]/name}
- ${/c/if/cpu_set_t:/name} *${.:/params[2]/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: group
- role: constraint
uid: /constraint/directive-ctx-any
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_scheduler_get_processor_set
notes: null
params:
- description: |
is the scheduler identifier.
dir: null
name: scheduler_id
- description: |
is the size of the referenced processor set variable in bytes.
dir: null
name: cpusetsize
- description: |
is the pointer to a processor set variable. When the directive call is
successful, the processor set of the scheduler will be stored in this
variable. A set bit in the processor set means that the corresponding
processor is owned by the scheduler, otherwise the bit is cleared.
dir: out
name: cpuset
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
There was no scheduler associated with the identifier specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The provided processor set was too small for the set of processors owned
by the scheduler.
value: ${../../status/if/invalid-size:/name}
type: interface
|
