AM64x MCU+ SDK  10.00.00
udma_rm.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 
48 #ifndef UDMA_RM_H_
49 #define UDMA_RM_H_
50 
51 /* ========================================================================== */
52 /* Include Files */
53 /* ========================================================================== */
54 
55 /* None */
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /* ========================================================================== */
62 /* Macros & Typedefs */
63 /* ========================================================================== */
64 
66 #define UDMA_RM_RES_ID_INVALID ((uint32_t) 0xFFFF0005U)
67 
69 #define UDMA_RM_SHARED_RES_CNT_MIN ((uint32_t) 0xFFFF0006U)
70 
72 #define UDMA_RM_SHARED_RES_CNT_REST ((uint32_t) 0xFFFF0007U)
73 
74 /* ========================================================================== */
75 /* Structure Declarations */
76 /* ========================================================================== */
77 
81 typedef struct
82 {
83  uint32_t resId;
85  uint32_t startResrvCnt;
88  uint32_t endResrvCnt;
91  uint32_t numInst;
97  uint32_t minReq;
117  uint32_t instShare[UDMA_RM_SHARED_RES_MAX_INST];
159 
160 /* ========================================================================== */
161 /* Function Declarations */
162 /* ========================================================================== */
178 
179 /* ========================================================================== */
180 /* Static Function Definitions */
181 /* ========================================================================== */
182 
183 /* None */
184 
185 /* ========================================================================== */
186 /* Internal/Private Structure Declarations */
187 /* ========================================================================== */
188 
189 /* None */
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 
195 #endif /* #ifndef UDMA_RM_H_ */
196 
Udma_RmSharedResPrms::resId
uint32_t resId
Definition: udma_rm.h:83
Udma_RmSharedResPrms::startResrvCnt
uint32_t startResrvCnt
Definition: udma_rm.h:85
UDMA_RM_SHARED_RES_MAX_INST
#define UDMA_RM_SHARED_RES_MAX_INST
Maximum no.of instances to split a shared resource. This should be max(UDMA_NUM_CORE,...
Definition: udma_soc.h:288
Udma_RmSharedResPrms::endResrvCnt
uint32_t endResrvCnt
Definition: udma_rm.h:88
Udma_rmGetSharedResPrms
Udma_RmSharedResPrms * Udma_rmGetSharedResPrms(uint32_t resId)
Returns the RM Shared Resource default parameters structure for the requested resource....
Udma_RmSharedResPrms
UDMA resource manager shared resource parameters.
Definition: udma_rm.h:82
Udma_RmSharedResPrms::numInst
uint32_t numInst
Definition: udma_rm.h:91
Udma_RmSharedResPrms::minReq
uint32_t minReq
Definition: udma_rm.h:97