blob: d4e0bb1c5be0e4c865947cc9bc5b2991c2af2d78 (
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies a partition object by the specified object name.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
body: null
params:
- ${../../type/if/name:/name} ${.:/params[0]/name}
- ${/c/if/uint32_t:/name} ${.:/params[1]/name}
- ${../../type/if/id:/name} *${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive obtains the partition identifier associated with the partition
name specified in ``${.:/params[0]/name}``.
The node to search is specified in ``${.:/params[1]/name}``. It shall be
* a valid node number,
* the constant ${../../object/if/search-all-nodes:/name} to search in all nodes,
* the constant ${../../object/if/search-local-node:/name} to search in the local
node only, or
* the constant ${../../object/if/search-other-nodes:/name} to search in all nodes
except the local node.
enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_partition_ident
notes: |
If the partition name is not unique, then the partition identifier will match
the first partition with that name in the search order. However, this
partition identifier is not guaranteed to correspond to the desired
partition. The partition identifier is used with other partition related
directives to access the partition.
If node is ${../../object/if/search-all-nodes:/name}, all nodes are searched with
the local node being searched first. All other nodes are searched with the
lowest numbered node searched first.
If node is a valid node number which does not represent the local node, then
only the partitions exported by the designated node are searched.
This directive does not generate activity on remote nodes. It accesses only
the local copy of the global object table.
params:
- description: is the object name to look up.
dir: null
name: name
- description: is the node or node set to search for a matching object.
dir: null
name: node
- description: |
is the pointer to an object identifier variable. The object identifier of
an object with the specified name 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/if/successful:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
The ${.:/params[0]/name} parameter was 0.
value: ${../../status/if/invalid-name:/name}
- description: |
There was no object with the specified name on the specified nodes.
value: ${../../status/if/invalid-name:/name}
- description: |
In multiprocessing configurations, the specified node was invalid.
value: ${../../status/if/invalid-node:/name}
type: interface
|