Vision Apps User Guide
app_udma.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2018 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef APP_UDMA_H_
64 #define APP_UDMA_H_
65 
83 #include <stdint.h>
84 #include <stdlib.h>
85 #if defined(SOC_AM62A) || defined(SOC_J722S)
86 #if !defined(MCU_PLUS_SDK)
87 #include <ti/drv/udma/dmautils/udma_standalone/udma.h>
88 #else
89 #include <drivers/dmautils/udma_standalone/udma.h>
90 #endif
91 #else
92 #include <ti/drv/udma/udma.h>
93 #endif
94 
95 #if !(defined(SOC_AM62A) || defined(SOC_J722S))
96 #include "app_udma_utils.h"
97 #endif
98 
99 #ifdef __cplusplus
100 extern "C" {
101 #endif
102 
103 /* ========================================================================== */
104 /* Macros & Typedefs */
105 /* ========================================================================== */
106 
108 typedef struct
109 {
110  Udma_VirtToPhyFxn virtToPhyFxn;
119 
120 /* ========================================================================== */
121 /* Function Declarations */
122 /* ========================================================================== */
123 
124 #if !(defined(SOC_AM62A) || defined(SOC_J722S))
125 #if defined(SOC_J721S2) || defined(SOC_J784S4)
126 
133 int32_t appUdmaCsirxCsitxInit(void);
134 
141 int32_t appUdmaCsirxCsitxDeInit(void);
142 
143 #endif
144 
151 void *appUdmaCsirxCsitxGetObj(void);
152 #endif
153 
161 
169 int32_t appUdmaInit(const app_udma_init_prms_t *prms);
170 
176 int32_t appUdmaDeInit(void);
177 
183 void *appUdmaGetObj(void);
184 
193 int32_t appUdmaTest(void);
194 
195 #ifdef __cplusplus
196 }
197 #endif /* __cplusplus */
198 
199 /* @} */
200 
201 #endif
int32_t appUdmaDeInit(void)
Performs de-initializations needed for UDMA.
void appUdmaInitPrmSetDefault(app_udma_init_prms_t *prm)
Sets default UDMA init parameters.
Udma_VirtToPhyFxn virtToPhyFxn
Definition: app_udma.h:110
void * appUdmaCsirxCsitxGetObj(void)
Provides global handle to UDMA Obj BCDMA instance Required for CSIRX/CSITX on J721S2.
int32_t appUdmaTest(void)
DMA copy test function.
UDMA init parameters.
Definition: app_udma.h:108
int32_t appUdmaInit(const app_udma_init_prms_t *prms)
Performs initializations needed for UDMA.
void * appUdmaGetObj(void)
Provides global handle to UDMA Obj.