blob: bc9e9ff93663334a19a8c654f928a6629aa51e6f (
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
|
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
|
