AM243x MCU+ SDK  09.02.00
enet_udma_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2020
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 
44 #ifndef ENET_UDMA_TYPES_H_
45 #define ENET_UDMA_TYPES_H_
46 
47 /* ========================================================================== */
48 /* Include Files */
49 /* ========================================================================== */
50 
51 #include <stdint.h>
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 /* ========================================================================== */
57 /* Macros */
58 /* ========================================================================== */
59 
60 /* None */
61 
62 /* ========================================================================== */
63 /* Structures and Enums */
64 /* ========================================================================== */
65 
66 /* Forward declarations */
67 struct EnetUdma_DrvObj_s;
68 struct EnetUdma_RxFlowObj_s;
69 struct EnetUdma_RxFlowObj_s;
70 struct EnetUdma_TxChObj_s;
71 struct EnetUdma_PktInfo_s;
72 
85 typedef struct EnetUdma_DrvObj_s *EnetDma_Handle;
86 
94 typedef struct EnetUdma_RxFlowObj_s *EnetDma_RxChHandle;
95 
99 typedef struct EnetUdma_TxChObj_s *EnetDma_TxChHandle;
100 
104 typedef struct EnetUdma_PktInfo_s EnetDma_Pkt;
105 
108 /* ========================================================================== */
109 /* Global Variables Declarations */
110 /* ========================================================================== */
111 
112 /* None */
113 
114 /* ========================================================================== */
115 /* Function Declarations */
116 /* ========================================================================== */
117 
118 /* None */
119 
120 /* ========================================================================== */
121 /* Deprecated Function Declarations */
122 /* ========================================================================== */
123 
124 /* None */
125 
126 /* ========================================================================== */
127 /* Static Function Definitions */
128 /* ========================================================================== */
129 
130 /* None */
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 #endif /* ENET_UDMA_TYPES_H_ */
137 
EnetDma_TxChHandle
struct EnetUdma_TxChObj_s * EnetDma_TxChHandle
Opaque handle that holds software state for Enet TX DMA channel.
Definition: enet_udma_types.h:99
EnetDma_Pkt
struct EnetUdma_PktInfo_s EnetDma_Pkt
Opaque handle that represents a DMA packet.
Definition: enet_udma_types.h:104
EnetDma_RxChHandle
struct EnetUdma_RxFlowObj_s * EnetDma_RxChHandle
Opaque handle that holds software state for Enet RX DMA flow.
Definition: enet_udma_types.h:94
EnetDma_Handle
struct EnetUdma_DrvObj_s * EnetDma_Handle
Opaque handle for Enet UDMA driver object.
Definition: enet_udma_types.h:85