blob: 8fdacc44dec9698146b5918c95bbd7b264930cf2 (
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
66
67
68
69
70
71
72
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies a scheduler by the processor set.
copyrights:
- Copyright (C) 2017, 2020 embedded brains GmbH & Co. KG
definition:
default:
attributes: null
body: null
params:
- ${/c/if/size_t:/name} ${.:/params[0]/name}
- const ${/c/if/cpu_set_t:/name} *${.:/params[1]/name}
- ${../../type/if/id:/name} *${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
The scheduler is selected according to the highest numbered online processor
in the specified processor set.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-ctx-any
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_scheduler_ident_by_processor_set
notes: null
params:
- description: |
is the size of the processor set referenced by ${.:/params[1]/name} in
bytes. The size shall be positive.
dir: null
name: cpusetsize
- description: |
is the pointer to a ${/c/if/cpu_set_t:/name}. The referenced processor set
will be used to identify the scheduler.
dir: null
name: cpuset
- description: |
is the pointer to an ${../../type/if/id:/name} object. When the directive call
is successful, the identifier of the scheduler will be stored in this
object.
dir: out
name: id
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: |
The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
The processor set size was invalid.
value: ${../../status/if/invalid-size:/name}
- description: |
The processor set contained no online processor.
value: ${../../status/if/invalid-name:/name}
- description: |
The processor set was valid, however, the highest numbered online
processor in the processor set was not owned by a scheduler.
value: ${../../status/if/incorrect-state:/name}
type: interface
|
