Data Fields
EnetUdma_OpenRxFlowPrms_s Struct Reference

Param struct for the get default flowId open parameters. More...

#include <enet_udma.h>

Data Fields

Udma_DrvHandle hUdmaDrv
 
uint32_t startIdx
 
uint32_t flowIdx
 
EnetUdma_UdmaChPrms udmaChPrms
 
EnetUdma_PktNotifyCb notifyCb
 
EnetUdma_UdmaFlowPrms flowPrms
 
uint32_t numRxPkts
 
bool disableCacheOpsFlag
 
uint32_t rxFlowMtu
 
EnetUdma_AllocRingMemFxn ringMemAllocFxn
 
EnetUdma_FreeRingMemFxn ringMemFreeFxn
 
EnetUdma_AllocDmaDescFxn dmaDescAllocFxn
 
EnetUdma_FreeDmaDescFxn dmaDescFreeFxn
 
void * cbArg
 
bool useProxy
 
EnetUdma_AutoReclaimPrms autoReclaimPrms
 

Detailed Description

Param struct for the get default flowId open parameters.

The param struct for the RX flow open function, containing CPSW instance Id for RX flow. The returned channel handle is an opaque variable used to access the RX Flow in other function commands.

Field Documentation

EnetUdma_AutoReclaimPrms EnetUdma_OpenRxFlowPrms_s::autoReclaimPrms

Buffer auto-reclaim params

void* EnetUdma_OpenRxFlowPrms_s::cbArg

Argument to be used for the callback routines (it should mean something to layer into which the callback calls)

bool EnetUdma_OpenRxFlowPrms_s::disableCacheOpsFlag

Flag to disable cache operations on the ring memory

EnetUdma_AllocDmaDescFxn EnetUdma_OpenRxFlowPrms_s::dmaDescAllocFxn

DMA HPD (host packet descriptor) memory allocation callback

EnetUdma_FreeDmaDescFxn EnetUdma_OpenRxFlowPrms_s::dmaDescFreeFxn

Transmit HPD (host packet descriptor) memory free callback

uint32_t EnetUdma_OpenRxFlowPrms_s::flowIdx

Flow index to be opened

EnetUdma_UdmaFlowPrms EnetUdma_OpenRxFlowPrms_s::flowPrms

UDMA Flow params

Udma_DrvHandle EnetUdma_OpenRxFlowPrms_s::hUdmaDrv

UDMA driver handle

EnetUdma_PktNotifyCb EnetUdma_OpenRxFlowPrms_s::notifyCb

Enet UDMA event callback function - this function will be called when the registered packets are received on RX Flow

uint32_t EnetUdma_OpenRxFlowPrms_s::numRxPkts

Number of receive packets, used for allocating number of DMA descriptors Note - The HW ring element count field is 19-bit

EnetUdma_AllocRingMemFxn EnetUdma_OpenRxFlowPrms_s::ringMemAllocFxn

Callback functions. Callback function typedefs so that the CpswDma layer can call into the app layer and let it translate between the hardware buffer descriptors and packets and the stack/translation layer's buffers and packets

Ring memory allocation callback, this cannot be NULL

EnetUdma_FreeRingMemFxn EnetUdma_OpenRxFlowPrms_s::ringMemFreeFxn

Ring memory free function callback, used in close flow

uint32_t EnetUdma_OpenRxFlowPrms_s::rxFlowMtu

Maximum receive packet length for this flow. Make sure packets of at least this length are submitted in EnetUdma_submitRxPackets()

uint32_t EnetUdma_OpenRxFlowPrms_s::startIdx

Flow start index

EnetUdma_UdmaChPrms EnetUdma_OpenRxFlowPrms_s::udmaChPrms

UDMA specific channel params

bool EnetUdma_OpenRxFlowPrms_s::useProxy

Flag to indicate if a dedicated proxy should be allocated for the "FQ" for this flow. This should be enabled only for those flows that require very high throughput as there are limited proxy available in the system


The documentation for this struct was generated from the following file:

Copyright 2020, Texas Instruments Incorporated