blob: 0cf1ef24d2d2db877b9a84209097b97ed6723f6c (
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
87
88
89
90
91
92
93
94
95
96
97
98
99
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Creates a port.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/name:/name} ${.:/params[0]/name}
- void *${.:/params[1]/name}
- void *${.:/params[2]/name}
- ${/c/if/uint32_t:/name} ${.:/params[3]/name}
- ${../../type/if/id:/name} *${.:/params[4]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive creates a port which resides on the local node. The port has
the user-defined object name specified in ${.:/params[0]/name}. The assigned
object identifier is returned in ${.:/params[4]/name}. This identifier is
used to access the port with other dual-ported memory port related
directives.
enabled-by: true
index-entries:
- create a port
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-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/object-allocator
- role: constraint
uid: ../constraint/max
- role: constraint
uid: /constraint/obj-unlimited-alloc
name: rtems_port_create
notes: |
The ${.:/params[1]/name} and ${.:/params[2]/name} parameters must be on a
boundary defined by the target processor architecture.
For control and maintenance of the port, RTEMS allocates a
${/glossary/dpcb:/term} from the local DPCB free pool and initializes it.
params:
- description: |
is the object name of the port.
dir: null
name: name
- description: |
is the internal start address of the memory area.
dir: null
name: internal_start
- description: |
is the external start address of the memory area.
dir: null
name: external_start
- description: |
is the length in bytes of the memory area.
dir: null
name: length
- description: |
is the pointer to an ${../../type/if/id:/name} object. When the directive
call is successful, the identifier of the created port 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[0]/name} parameter was invalid.
value: ${../../status/if/invalid-name:/name}
- description: |
The ${.:/params[4]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
The ${.:/params[1]/name} parameter was not properly aligned.
value: ${../../status/if/invalid-address:/name}
- description: |
The ${.:/params[2]/name} parameter was not properly aligned.
value: ${../../status/if/invalid-address:/name}
- description: |
There was no inactive object available to create a port. The number of
port available to the application is configured through the
${/acfg/if/max-ports:/name} application configuration option.
value: ${../../status/if/too-many:/name}
type: interface
|
