Data Fields
EnetUdma_OpenTxChPrms_s Struct Reference

Param struct for the TX channel open function. More...

#include <enet_udma.h>

Data Fields

Udma_DrvHandle hUdmaDrv
 
uint32_t chNum
 
EnetUdma_UdmaChPrms udmaChPrms
 
EnetUdma_UdmaChTxPrms udmaTxChPrms
 
EnetUdma_PktNotifyCb notifyCb
 
uint32_t numTxPkts
 
bool disableCacheOpsFlag
 
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 TX channel open function.

The configuration structure for the TX channel open function # EnetDma_openTxCh().

Field Documentation

EnetUdma_AutoReclaimPrms EnetUdma_OpenTxChPrms_s::autoReclaimPrms

Buffer auto-reclaim params

void* EnetUdma_OpenTxChPrms_s::cbArg

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

uint32_t EnetUdma_OpenTxChPrms_s::chNum

UDMA channel to number allocated for transmit. Set to #UDMA_DMA_CH_ANY if the channel to allocate and open could be any from the free pool

bool EnetUdma_OpenTxChPrms_s::disableCacheOpsFlag

Flag to disable cache operations on the ring memory

EnetUdma_AllocDmaDescFxn EnetUdma_OpenTxChPrms_s::dmaDescAllocFxn

DMA HPD (host packet descriptor) memory allocation callback

EnetUdma_FreeDmaDescFxn EnetUdma_OpenTxChPrms_s::dmaDescFreeFxn

Transmit HPD (host packet descriptor) memory free callback

Udma_DrvHandle EnetUdma_OpenTxChPrms_s::hUdmaDrv

UDMA driver handle

EnetUdma_PktNotifyCb EnetUdma_OpenTxChPrms_s::notifyCb

Enet UDMA event callback function - this function will be called when the registered packets are transmitted on TX channel

uint32_t EnetUdma_OpenTxChPrms_s::numTxPkts

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

EnetUdma_AllocRingMemFxn EnetUdma_OpenTxChPrms_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_OpenTxChPrms_s::ringMemFreeFxn

Ring memory free function callback, used in close flow

EnetUdma_UdmaChPrms EnetUdma_OpenTxChPrms_s::udmaChPrms

UDMA channel params

EnetUdma_UdmaChTxPrms EnetUdma_OpenTxChPrms_s::udmaTxChPrms

UDMA transmit channel params

bool EnetUdma_OpenTxChPrms_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