AM263Px MCU+ SDK: mcspi_dma_edma.h Source File

| AM263Px MCU+ SDK 26.00.00 |

mcspi_dma_edma.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2023 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
33 #ifndef MCSPI_DMA_EDMA_H_
34 #define MCSPI_DMA_EDMA_H_
35
36 #include <stdint.h>
37 #include <drivers/edma/v0/edma.h>
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42
43 typedef struct McspiDma_EdmaArgs_s
44 {
45 EDMA_Handle drvHandle;
47 } McspiDma_EdmaArgs;
48
49 typedef struct MCSPI_DmaChConfig_s
50 {
51 uint32_t edmaTccRx;
53 uint32_t edmaTccTx;
55 uint32_t edmaRxChId;
57 uint32_t edmaTxChId;
59 uint32_t edmaRxParam;
61 uint32_t edmaTxParam;
63 uint32_t edmaDummyParam;
65 uint32_t edmaRegionId;
67 uint32_t edmaBaseAddr;
69 Edma_IntrObject edmaIntrObjRx;
71 Edma_IntrObject edmaIntrObjTx;
73 uint32_t isOpen;
75 }MCSPI_EdmaChConfig;
76
78 typedef struct MCSPI_DmaChConfig_s *MCSPI_DmaChConfig;
80 typedef EDMA_Config *MCSPI_DmaHandle;
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* MCSPI_DMA_EDMA_H_ */
EDMA_Config
EDMA Instance Configuration. Pointer to this object is returned as handle by driver open.
Definition: edma/v0/edma.h:675
MCSPI_EdmaChConfig::isOpen
uint32_t isOpen
Definition: mcspi_dma_edma.h:73
MCSPI_EdmaChConfig
Definition: mcspi_dma_edma.h:50
MCSPI_EdmaChConfig::edmaTxParam
uint32_t edmaTxParam
Definition: mcspi_dma_edma.h:61
MCSPI_DmaHandle
EDMA_Config * MCSPI_DmaHandle
Definition: mcspi_dma_edma.h:80
Edma_IntrObject
EDMA interrupt configuration object. The object is passed to the EDMA_registerIntr() function....
Definition: edma/v0/edma.h:576
McspiDma_EdmaArgs::drvHandle
EDMA_Handle drvHandle
Definition: mcspi_dma_edma.h:45
MCSPI_EdmaChConfig::edmaDummyParam
uint32_t edmaDummyParam
Definition: mcspi_dma_edma.h:63
McspiDma_EdmaArgs
Definition: mcspi_dma_edma.h:44
MCSPI_EdmaChConfig::edmaRxParam
uint32_t edmaRxParam
Definition: mcspi_dma_edma.h:59
MCSPI_EdmaChConfig::edmaTccRx
uint32_t edmaTccRx
Definition: mcspi_dma_edma.h:51
MCSPI_EdmaChConfig::edmaRegionId
uint32_t edmaRegionId
Definition: mcspi_dma_edma.h:65
MCSPI_EdmaChConfig::edmaTxChId
uint32_t edmaTxChId
Definition: mcspi_dma_edma.h:57
MCSPI_EdmaChConfig::edmaRxChId
uint32_t edmaRxChId
Definition: mcspi_dma_edma.h:55
MCSPI_EdmaChConfig::edmaBaseAddr
uint32_t edmaBaseAddr
Definition: mcspi_dma_edma.h:67
edma.h
This file contains the prototype of EDMA driver APIs.
EDMA_Handle
void * EDMA_Handle
A handle that is returned from a EDMA_open() call.
Definition: edma/v0/edma.h:596
MCSPI_EdmaChConfig::edmaTccTx
uint32_t edmaTccTx
Definition: mcspi_dma_edma.h:53
MCSPI_DmaChConfig
struct MCSPI_DmaChConfig_s * MCSPI_DmaChConfig
Definition: mcspi_dma_edma.h:78
MCSPI_EdmaChConfig::edmaIntrObjRx
Edma_IntrObject edmaIntrObjRx
Definition: mcspi_dma_edma.h:69
MCSPI_EdmaChConfig::edmaIntrObjTx
Edma_IntrObject edmaIntrObjTx
Definition: mcspi_dma_edma.h:71