blob: b75f8b2a4e0896b47e50de4844fc1949d259dd1a (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Identifies a barrier 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:
- ${../types/name:/name} ${.:/params[0]/name}
- ${../types/id:/name} *${.:/params[1]/name}
return: ${../status/code:/name}
variants: []
description: |
This directive obtains the barrier identifier associated with the barrier
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_barrier_ident
notes: |
If the barrier name is not unique, then the barrier identifier will match the
first barrier with that name in the search order. However, this barrier
identifier is not guaranteed to correspond to the desired barrier. The
barrier identifier is used with other barrier related directives to access
the barrier.
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/successful:/name}
- description: |
The ${.:/params[1]/name} parameter was ${/if/c/null:/name}.
value: ${../status/invalid-address:/name}
- description: |
The ${.:/params[0]/name} parameter was 0.
value: ${../status/invalid-name:/name}
- description: |
There was no object with the specified name on the local node.
value: ${../status/invalid-name:/name}
type: interface
|
