PDK API Guide for AM65xx
enet_hostport_udma.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 
40 #ifndef ENET_HOSTPORT_UDMA_H_
41 #define ENET_HOSTPORT_UDMA_H_
42 
43 /* ========================================================================== */
44 /* Include Files */
45 /* ========================================================================== */
46 
47 #include <stdint.h>
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 /* ========================================================================== */
56 /* Macros */
57 /* ========================================================================== */
58 
59 #define ENET_UDMA_RSVDFLOW_RX_PKTS_NUM (2U)
60 
62 #define ENET_UDMA_CPSW_RX_CH_NUM (1U)
63 
64 #define ENET_UDMA_ICSSG_RX_CH_NUM (6U)
65 
66 #define ENET_UDMA_RX_CH_NUM (ENET_UDMA_CPSW_RX_CH_NUM + \
67  ENET_UDMA_ICSSG_RX_CH_NUM)
68 
70 #define ENET_UDMA_RXFLOWIDX_INVALID (0xABCDABCDU)
71 
72 /* ========================================================================== */
73 /* Structures and Enums */
74 /* ========================================================================== */
75 
76 /* None */
77 
78 /* ========================================================================== */
79 /* Global Variables Declarations */
80 /* ========================================================================== */
81 
82 /* None */
83 
84 /* ========================================================================== */
85 /* Function Declarations */
86 /* ========================================================================== */
87 
88 void EnetHostPortDma_initCfg(Enet_Type enetType, const void *dmaCfg);
89 
91  const void *dmaCfg,
92  const EnetRm_ResCfg *resCfg);
93 
95 
97  Enet_dmaResInfo *dmaResInfo,
98  uint32_t chIdx);
99 
101  uint32_t startIdx,
102  uint32_t flowIdx);
103 
105 
106 /* ========================================================================== */
107 /* Deprecated Function Declarations */
108 /* ========================================================================== */
109 
110 /* None */
111 
112 /* ========================================================================== */
113 /* Static Function Definitions */
114 /* ========================================================================== */
115 
116 /* None */
117 
118 #ifdef __cplusplus
119 }
120 #endif
121 
122 #endif /* ENET_HOSTPORT_UDMA_H_ */
EnetDma_Handle EnetHostPortDma_open(EnetPer_Handle hPer, const void *dmaCfg, const EnetRm_ResCfg *resCfg)
Enet DMA resource information.
Definition: enet_base_priv.h:68
Enet_Type
Ethernet peripheral type.
Definition: enet_types.h:195
void EnetHostPortDma_initCfg(Enet_Type enetType, const void *dmaCfg)
EnetDma_RxChHandle EnetHostPortDma_openRsvdFlow(const void *cfg, uint32_t startIdx, uint32_t flowIdx)
struct EnetUdma_RxFlowObj_s * EnetDma_RxChHandle
Opaque handle that holds software state for Enet RX DMA flow.
Definition: enet_udma_types.h:95
This file contains the type definitions and helper macros for the Enet Peripheral interface.
struct EnetUdma_DrvObj_s * EnetDma_Handle
Opaque handle for Enet UDMA driver object.
Definition: enet_udma_types.h:86
Resource manager configuration parameters.
Definition: enet_rm.h:336
void EnetHostPortDma_close(EnetDma_Handle hDma)
void EnetHostPortDma_getDmaResInfo(EnetDma_Handle hDma, Enet_dmaResInfo *dmaResInfo, uint32_t chIdx)
struct EnetPer_Obj_s * EnetPer_Handle
Ethernet Peripheral handle.
Definition: enet_per.h:299
This file contains the private top-level type definitions and helper macros.
int32_t EnetHostPortDma_closeRsvdFlow(EnetDma_RxChHandle hRxRsvdFlow)