blob: d013aa0aa515d8a9c9513e129c3b35f807460604 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies a port 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}
- ${../../type/if/id:/name} *${.:/params[1]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive obtains the port identifier associated with the port name
specified in ``${.:/params[0]/name}``.
enabled-by: true
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_port_ident
notes: |
If the port name is not unique, then the port identifier will match the first
port with that name in the search order. However, this port identifier is
not guaranteed to correspond to the desired port. The port identifier is
used with other dual-ported memory related directives to access the port.
The objects are searched from lowest to the highest index. Only the local
node is searched.
params:
- description: is the object name to look up.
dir: null
name: name
- 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[1]/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 local node.
value: ${../../status/if/invalid-name:/name}
type: interface
|
