AM261x MCU+ SDK: enet_cpdma_types.h Source File

| AM261x MCU+ SDK 26.00.00 |

enet_cpdma_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_CPDMA_TYPES_H_
45 #define ENET_CPDMA_TYPES_H_
46
47 /* ========================================================================== */
48 /* Include Files */
49 /* ========================================================================== */
50
51 #include <stdint.h>
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 /* ========================================================================== */
58 /* Macros */
59 /* ========================================================================== */
60
61 /* None */
62
63 /* ========================================================================== */
64 /* Structures and Enums */
65 /* ========================================================================== */
66
67 /* Forward declarations */
68 struct EnetCpdma_DrvObj_s;
69 struct EnetCpdma_RxFlowObj_s;
70 struct EnetCpdma_RxFlowObj_s;
71 struct EnetCpdma_TxChObj_s;
72 struct EnetCpdma_PktInfo_s;
73
86 typedef struct EnetCpdma_DrvObj_s *EnetDma_Handle;
87
92 typedef struct EnetCpdma_RxChObj_s *EnetDma_RxChHandle;
93
97 typedef struct EnetCpdma_TxChObj_s *EnetDma_TxChHandle;
98
102 typedef struct EnetCpdma_PktInfo_s EnetDma_Pkt;
103
106 /* ========================================================================== */
107 /* Global Variables Declarations */
108 /* ========================================================================== */
109
110 /* None */
111
112 /* ========================================================================== */
113 /* Function Declarations */
114 /* ========================================================================== */
115
116 /* None */
117
118 /* ========================================================================== */
119 /* Deprecated Function Declarations */
120 /* ========================================================================== */
121
122 /* None */
123
124 /* ========================================================================== */
125 /* Static Function Definitions */
126 /* ========================================================================== */
127
128 /* None */
129
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif /* ENET_CPDMA_TYPES_H_ */
135
EnetDma_RxChHandle
struct EnetCpdma_RxChObj_s * EnetDma_RxChHandle
Opaque handle that holds software state for Enet RX DMA channel.
Definition: enet_cpdma_types.h:92
EnetDma_Handle
struct EnetCpdma_DrvObj_s * EnetDma_Handle
Opaque handle for Enet CPDMA driver object.
Definition: enet_cpdma_types.h:86
EnetDma_TxChHandle
struct EnetCpdma_TxChObj_s * EnetDma_TxChHandle
Opaque handle that holds software state for Enet TX DMA channel.
Definition: enet_cpdma_types.h:97
EnetDma_Pkt
struct EnetCpdma_PktInfo_s EnetDma_Pkt
Opaque handle that holds software state for Enet Packet Info.
Definition: enet_cpdma_types.h:102