summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/dpmem.h
blob: 9ecdf3a1707b85f3c18375ff2c3ce6d181da69f6 (plain)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @brief This header file defines the Dual-Ported Memory Manager API.
 */

/*
 * Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/rtems/dpmem/if/header */

#ifndef _RTEMS_RTEMS_DPMEM_H
#define _RTEMS_RTEMS_DPMEM_H

#include <stdint.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/dpmem/if/group */

/**
 * @defgroup RTEMSAPIClassicDPMem Dual-Ported Memory Manager
 *
 * @ingroup RTEMSAPIClassic
 *
 * @brief The Dual-Ported Memory Manager provides a mechanism for converting
 *   addresses between internal and external representations for multiple
 *   dual-ported memory areas (DPMA).
 */

/* Generated from spec:/rtems/dpmem/if/create */

/**
 * @ingroup RTEMSAPIClassicDPMem
 *
 * @brief Creates a port.
 *
 * @param name is the object name of the port.
 *
 * @param internal_start is the internal start address of the memory area.
 *
 * @param external_start is the external start address of the memory area.
 *
 * @param length is the length in bytes of the memory area.
 *
 * @param[out] id is the pointer to an ::rtems_id object.  When the directive
 *   call is successful, the identifier of the created port will be stored in
 *   this object.
 *
 * This directive creates a port which resides on the local node.  The port has
 * the user-defined object name specified in ``name``.  The assigned object
 * identifier is returned in ``id``.  This identifier is used to access the
 * port with other dual-ported memory port related directives.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was invalid.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``internal_start`` parameter was not
 *   properly aligned.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``external_start`` parameter was not
 *   properly aligned.
 *
 * @retval ::RTEMS_TOO_MANY There was no inactive object available to create a
 *   port.  The number of port available to the application is configured
 *   through the #CONFIGURE_MAXIMUM_PORTS application configuration option.
 *
 * @par Notes
 * @parblock
 * The ``internal_start`` and ``external_start`` parameters must be on a
 * boundary defined by the target processor architecture.
 *
 * For control and maintenance of the port, RTEMS allocates a DPCB from the
 * local DPCB free pool and initializes it.
 * @endparblock
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive may obtain and release the object allocator mutex.  This may
 *   cause the calling task to be preempted.
 *
 * * The number of ports available to the application is configured through the
 *   #CONFIGURE_MAXIMUM_PORTS application configuration option.
 *
 * * Where the object class corresponding to the directive is configured to use
 *   unlimited objects, the directive may allocate memory from the RTEMS
 *   Workspace.
 * @endparblock
 */
rtems_status_code rtems_port_create(
  rtems_name name,
  void      *internal_start,
  void      *external_start,
  uint32_t   length,
  rtems_id  *id
);

/* Generated from spec:/rtems/dpmem/if/ident */

/**
 * @ingroup RTEMSAPIClassicDPMem
 *
 * @brief Identifies a port by the object name.
 *
 * @param name is the object name to look up.
 *
 * @param[out] id is the pointer to an ::rtems_id object.  When the directive
 *   call is successful, the object identifier of an object with the specified
 *   name will be stored in this object.
 *
 * This directive obtains a port identifier associated with the port name
 * specified in ``name``.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
 *
 * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was 0.
 *
 * @retval ::RTEMS_INVALID_NAME There was no object with the specified name on
 *   the local node.
 *
 * @par Notes
 * @parblock
 * 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 objects are searched from lowest to the highest index.  Only the local
 * node is searched.
 *
 * The port identifier is used with other dual-ported memory related directives
 * to access the port.
 * @endparblock
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within any runtime context.
 *
 * * The directive will not cause the calling task to be preempted.
 * @endparblock
 */
rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id );

/* Generated from spec:/rtems/dpmem/if/delete */

/**
 * @ingroup RTEMSAPIClassicDPMem
 *
 * @brief Deletes the port.
 *
 * @param id is the port identifier.
 *
 * This directive deletes the port specified by ``id``.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_ID There was no port associated with the identifier
 *   specified by ``id``.
 *
 * @par Notes
 * The DPCB for the deleted port is reclaimed by RTEMS.
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive may obtain and release the object allocator mutex.  This may
 *   cause the calling task to be preempted.
 *
 * * The calling task does not have to be the task that created the object.
 *   Any local task that knows the object identifier can delete the object.
 *
 * * Where the object class corresponding to the directive is configured to use
 *   unlimited objects, the directive may free memory to the RTEMS Workspace.
 * @endparblock
 */
rtems_status_code rtems_port_delete( rtems_id id );

/* Generated from spec:/rtems/dpmem/if/external-to-internal */

/**
 * @ingroup RTEMSAPIClassicDPMem
 *
 * @brief Converts the external address to the internal address.
 *
 * @param id is the port identifier.
 *
 * @param external is the external address to convert.
 *
 * @param[out] internal 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.
 *
 * 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.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_NAME The ``id`` parameter was invalid.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``internal`` parameter was NULL.
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within interrupt context.
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive will not cause the calling task to be preempted.
 * @endparblock
 */
rtems_status_code rtems_port_external_to_internal(
  rtems_id id,
  void    *external,
  void   **internal
);

/* Generated from spec:/rtems/dpmem/if/internal-to-external */

/**
 * @ingroup RTEMSAPIClassicDPMem
 *
 * @brief Converts the internal address to the external address.
 *
 * @param id is the port identifier.
 *
 * @param internal is the internal address to convert.
 *
 * @param[out] external 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.
 *
 * This directive converts a dual-ported memory address from internal to
 * external representation so that it can be passed to owner of the DPMA
 * represented by the specified port.  If the given internal address is an
 * invalid dual-ported address, then the external address is set to the given
 * internal address.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_NAME The ``id`` parameter was invalid.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``external`` parameter was NULL.
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within interrupt context.
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive will not cause the calling task to be preempted.
 * @endparblock
 */
rtems_status_code rtems_port_internal_to_external(
  rtems_id id,
  void    *internal,
  void   **external
);

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_RTEMS_DPMEM_H */