PDK API Guide for AM64x
udma_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2018
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
47 #ifndef UDMA_TYPES_H_
48 #define UDMA_TYPES_H_
49 
50 /* ========================================================================== */
51 /* Include Files */
52 /* ========================================================================== */
53 
54 /* None */
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59 
60 /* ========================================================================== */
61 /* Macros & Typedefs */
62 /* ========================================================================== */
63 
65 typedef struct Udma_DrvObj * Udma_DrvHandle;
67 typedef struct Udma_ChObj * Udma_ChHandle;
69 typedef struct Udma_EventObj * Udma_EventHandle;
71 typedef struct Udma_RingObj * Udma_RingHandle;
73 typedef struct Udma_FlowObj * Udma_FlowHandle;
75 typedef struct Udma_ProxyObj * Udma_ProxyHandle;
77 typedef struct Udma_RingMonObj * Udma_RingMonHandle;
78 
80 #define UDMA_CACHELINE_ALIGNMENT (128U)
81 
91 #define UDMA_SOK (CSL_PASS)
92 
94 #define UDMA_EFAIL (CSL_EFAIL)
95 
97 #define UDMA_EBADARGS (CSL_EBADARGS)
98 
100 #define UDMA_EINVALID_PARAMS (CSL_EINVALID_PARAMS)
101 
104 #define UDMA_ETIMEOUT (CSL_ETIMEOUT)
105 
106 #define UDMA_EALLOC (CSL_EALLOC)
107 /* @} */
108 
110 #define UDMA_NO_WAIT ((uint32_t) 0U)
111 
112 #define UDMA_WAIT_FOREVER (~((uint32_t) 0U))
113 
115 #define UDMA_INIT_DONE (0xABDCABCDU)
116 
117 #define UDMA_DEINIT_DONE (0x00000000U)
118 
129 #define UDMA_INST_ID_0 (0U)
130 #define UDMA_INST_ID_1 (1U)
131 #define UDMA_INST_ID_2 (2U)
132 #define UDMA_INST_ID_3 (3U)
133 /* @} */
134 
145 #define UDMA_UTC_ID0 (0U)
146 #define UDMA_UTC_ID1 (1U)
147 #define UDMA_UTC_ID2 (2U)
148 #define UDMA_UTC_ID3 (3U)
149 /* @} */
150 
163 #define UDMA_MAPPED_GROUP0 (0U)
164 #define UDMA_MAPPED_GROUP1 (1U)
165 #define UDMA_MAPPED_GROUP2 (2U)
166 #define UDMA_MAPPED_GROUP3 (3U)
167 #define UDMA_MAPPED_GROUP4 (4U)
168 #define UDMA_MAPPED_GROUP5 (5U)
169 #define UDMA_MAPPED_GROUP6 (6U)
170 #define UDMA_MAPPED_GROUP7 (7U)
171 /* @} */
172 
173 /* ========================================================================== */
174 /* Structure Declarations */
175 /* ========================================================================== */
176 
177 /* None */
178 
179 /* ========================================================================== */
180 /* Function Declarations */
181 /* ========================================================================== */
182 
183 /* None */
184 
185 /* ========================================================================== */
186 /* Static Function Definitions */
187 /* ========================================================================== */
188 
189 /* None */
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 
195 #endif /* #ifndef UDMA_TYPES_H_ */
196 
197 /* @} */
UDMA flow object.
Definition: udma_flow.h:465
UDMA driver object.
Definition: udma.h:416
UDMA ring object.
Definition: udma_ring.h:775
UDMA ring monitor object.
Definition: udma_ring.h:843
UDMA channel object.
Definition: udma_ch.h:1085
UDMA event object.
Definition: udma_event.h:503
struct Udma_ProxyObj * Udma_ProxyHandle
UDMA proxy handle.
Definition: udma_types.h:75