AM64x MCU+ SDK  10.00.00
udma_utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018-2021 Texas Instruments Incorporated
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_UTILS_H_
48 #define UDMA_UTILS_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 
72 #define UDMA_TR_TYPE_0 (CSL_UDMAP_TR_FLAGS_TYPE_1D_DATA_MOVE)
73 #define UDMA_TR_TYPE_1 (CSL_UDMAP_TR_FLAGS_TYPE_2D_DATA_MOVE)
74 #define UDMA_TR_TYPE_2 (CSL_UDMAP_TR_FLAGS_TYPE_3D_DATA_MOVE)
75 #define UDMA_TR_TYPE_3 (CSL_UDMAP_TR_FLAGS_TYPE_4D_DATA_MOVE)
76 #define UDMA_TR_TYPE_4 (CSL_UDMAP_TR_FLAGS_TYPE_4D_DATA_MOVE_FORMATTING)
77 #define UDMA_TR_TYPE_5 (CSL_UDMAP_TR_FLAGS_TYPE_4D_CACHE_WARM)
78 #define UDMA_TR_TYPE_8 (CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE)
79 #define UDMA_TR_TYPE_9 (CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE_REPACKING)
80 #define UDMA_TR_TYPE_10 (CSL_UDMAP_TR_FLAGS_TYPE_2D_BLOCK_MOVE)
81 #define UDMA_TR_TYPE_11 (CSL_UDMAP_TR_FLAGS_TYPE_2D_BLOCK_MOVE_REPACKING)
82 #define UDMA_TR_TYPE_15 (CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE_REPACKING_INDIRECTION)
83 
94 #define UDMA_GET_TRPD_TR15_SIZE(n) (UDMA_ALIGN_SIZE(sizeof(CSL_UdmapTR15) + ((n) * (sizeof(CSL_UdmapTR15) + 4U))))
95 
96 /* ========================================================================== */
97 /* Structure Declarations */
98 /* ========================================================================== */
99 
100 /* None */
101 
102 /* ========================================================================== */
103 /* Function Declarations */
104 /* ========================================================================== */
105 
116  uint32_t elemCnt,
117  uint8_t elemSize);
118 
131 void UdmaUtils_makeTrpdTr15(uint8_t *trpdMem, uint32_t trCnt, uint32_t cqRingNum);
132 
146 void UdmaUtils_makeTrpd(uint8_t *trpdMem,
147  uint32_t trType,
148  uint32_t trCnt,
149  uint32_t cqRingNum);
150 
158 uint32_t UdmaUtils_getTrSizeEncoded(uint32_t trType);
159 
167 uint32_t UdmaUtils_getTrSizeBytes(uint32_t trType);
168 
178 static inline uint32_t UdmaUtils_getTrpdTr15Response(const uint8_t *trpdMem,
179  uint32_t trCnt,
180  uint32_t trIndex);
181 
190 static inline CSL_UdmapTR15 *UdmaUtils_getTrpdTr15Pointer(uint8_t *trpdMem,
191  uint32_t trIndex);
192 
210  uint32_t localeventID, uint32_t eventMode);
211 
212 /* ========================================================================== */
213 /* Static Function Definitions */
214 /* ========================================================================== */
215 
216 static inline uint32_t UdmaUtils_getTrpdTr15Response(const uint8_t *trpdMem,
217  uint32_t trCnt,
218  uint32_t trIndex)
219 {
220  uint32_t trRespStatus;
221  const uint32_t *pTrResp;;
222 
223  /* Get TR index */
224  pTrResp = (const uint32_t *) (trpdMem +
225  (sizeof(CSL_UdmapTR15) +
226  (sizeof(CSL_UdmapTR15) * trCnt) +
227  (sizeof(uint32_t) * trIndex)));
228  trRespStatus = CSL_FEXT(*pTrResp, UDMAP_TR_RESPONSE_STATUS_TYPE);
229 
230  return (trRespStatus);
231 }
232 
233 static inline CSL_UdmapTR15 *UdmaUtils_getTrpdTr15Pointer(uint8_t *trpdMem,
234  uint32_t trIndex)
235 {
236  CSL_UdmapTR15 *pTr;
237 
238  pTr = (CSL_UdmapTR15 *)(trpdMem + sizeof(CSL_UdmapTR15) + (sizeof(CSL_UdmapTR15) * trIndex));
239 
240  return (pTr);
241 }
242 
243 #ifdef __cplusplus
244 }
245 #endif
246 
247 #endif /* #ifndef UDMA_UTILS_H_ */
248 
Udma_ChHandle
void * Udma_ChHandle
UDMA channel handle.
Definition: udma_types.h:67
UdmaUtils_getTrSizeEncoded
uint32_t UdmaUtils_getTrSizeEncoded(uint32_t trType)
Returns the size of TR (encoded) based on the type.
UdmaUtils_makeTrpd
void UdmaUtils_makeTrpd(uint8_t *trpdMem, uint32_t trType, uint32_t trCnt, uint32_t cqRingNum)
UDMA utility API to make TRPD. Other TRPD make APIs should be called only after this API.
UdmaUtils_makeTrpdTr15
void UdmaUtils_makeTrpdTr15(uint8_t *trpdMem, uint32_t trCnt, uint32_t cqRingNum)
UDMA utility API to make TRPD with TR15 TR type. Other TRPD make APIs should be called only after thi...
mode
char mode[32]
Definition: tisci_pm_core.h:1
UdmaUtils_getTrSizeBytes
uint32_t UdmaUtils_getTrSizeBytes(uint32_t trType)
Returns the size of TR in bytes based on the type.
Udma_DrvHandle
void * Udma_DrvHandle
UDMA driver handle.
Definition: udma_types.h:65
UdmaUtils_getTrpdTr15Response
static uint32_t UdmaUtils_getTrpdTr15Response(const uint8_t *trpdMem, uint32_t trCnt, uint32_t trIndex)
Returns the TR response in the TRPD memory based on the index.
Definition: udma_utils.h:216
UdmaUtils_getRingMemSize
uint32_t UdmaUtils_getRingMemSize(uint8_t mode, uint32_t elemCnt, uint8_t elemSize)
UDMA get ring size utility API.
UdmaUtils_mapLocaltoGlobalEvent
int32_t UdmaUtils_mapLocaltoGlobalEvent(Udma_DrvHandle drvHandle, Udma_ChHandle chHandle, uint32_t localeventID, uint32_t eventMode)
Map L2G event for BCDMA trigger.
UdmaUtils_getTrpdTr15Pointer
static CSL_UdmapTR15 * UdmaUtils_getTrpdTr15Pointer(uint8_t *trpdMem, uint32_t trIndex)
Returns the TR15 pointer in the TRPD memory based on the index.
Definition: udma_utils.h:233