blob: a1161ad7d7bb14468fae6e403e2eae2711ec96a5 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Converts the external address to the internal address.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
- void *${.:/params[1]/name}
- void **${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive converts a dual-ported memory address from external to
internal representation for the specified port. If the given external
address is invalid for the specified port, then the internal address is set
to the given external address.
enabled-by: true
index-entries:
- convert external to internal address
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
- role: constraint
uid: /constraint/directive-ctx-isr
- role: constraint
uid: /constraint/directive-ctx-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_port_external_to_internal
notes: null
params:
- description: |
is the port identifier.
dir: null
name: id
- description: |
is the external address to convert.
dir: null
name: external
- description: |
is the pointer to a ``void`` pointer object. When the directive call is
successful, the external address associated with the internal address will
be stored in this object.
dir: out
name: internal
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
The ${.:/params[0]/name} parameter was invalid.
value: ${../../status/if/invalid-name:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
type: interface
|
