mcdma
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
XMcdma_ChanCtrl Struct Reference

Per-channel control and BD ring state for MCDMA. More...

#include <xmcdma.h>

Data Fields

UINTPTR ChanBase
 Base address of the channel registers. More...
 
u32 Chan_id
 Channel number. More...
 
u32 MaxTransferLen
 Maximum transfer length for the channel. More...
 
u32 len
 Total size of BD lengths in the channel. More...
 
u32 IsRxChan
 Non-zero when the channel is a receive channel. More...
 
u32 ext_addr
 Non-zero when extended (64-bit) addressing is used. More...
 
u32 Has_Txdre
 Non-zero when the transmit DRE is present. More...
 
u32 Has_Rxdre
 Non-zero when the receive DRE is present. More...
 
u32 TxDataWidth
 Transmit data width in bits. More...
 
u32 RxDataWidth
 Receive data width in bits. More...
 
u32 HasStsCntrlStrm
 Non-zero when status/control stream is present. More...
 
int HasRxLength
 Non-zero when receive length reporting is present. More...
 
volatile int ChanState
 Current channel state (idle, pause, or busy). More...
 
UINTPTR FirstBdAddr
 First BD address in the channel ring. More...
 
UINTPTR LastBdAddr
 Last BD address in the channel ring. More...
 
UINTPTR Separation
 Byte separation between consecutive BDs. More...
 
XMcdma_Bd * BdHead
 Pointer to the head BD in the ring. More...
 
XMcdma_Bd * BdTail
 Pointer to the tail BD in the ring. More...
 
XMcdma_Bd * BdRestart
 Pointer to the BD used to restart the channel. More...
 
u32 BdCnt
 Total number of BDs in the channel ring. More...
 
u32 BdPendingCnt
 Number of BDs pending hardware submission. More...
 
u32 BdSubmitCnt
 Number of BDs submitted to hardware. More...
 
u32 BdDoneCnt
 Number of completed BDs. More...
 
u32 Length
 Total length of the BD ring in bytes. More...
 
XMcdma_QScheduler Schedulertype
 Queue scheduler type for the channel. More...
 
XMcdma_ChanDoneHandler DoneHandler
 Callback for transfer done interrupt. More...
 
void * DoneRef
 Reference passed to the done interrupt callback. More...
 
XMcdma_ChanErrorHandler ErrorHandler
 Callback for error interrupt. More...
 
void * ErrorRef
 Reference passed to the error interrupt callback. More...
 
XMcdma_ChanPktDropHandler PktdropHandler
 Callback for packet drop interrupt. More...
 
void * PktDropRef
 Reference passed to the packet drop callback. More...
 

Detailed Description

Per-channel control and BD ring state for MCDMA.

Field Documentation

u32 XMcdma_ChanCtrl::BdCnt

Total number of BDs in the channel ring.

Referenced by XMcdma_BdChainFromHW(), XMcDma_Chan_Sideband_Submit(), XMcDma_ChanBdCreate(), and XMcDma_ChanSubmit().

u32 XMcdma_ChanCtrl::BdDoneCnt

Number of completed BDs.

Referenced by XMcdma_BdChainFree(), XMcdma_BdChainFromHW(), and XMcDma_ChanBdCreate().

XMcdma_Bd* XMcdma_ChanCtrl::BdHead

Pointer to the head BD in the ring.

Referenced by XMcdma_BdChainFromHW(), XMcDma_ChanBdCreate(), and XMcdma_UpdateChanCDesc().

u32 XMcdma_ChanCtrl::BdPendingCnt

Number of BDs pending hardware submission.

Referenced by XMcDma_Chan_Sideband_Submit(), XMcDma_ChanBdCreate(), XMcDma_ChanSubmit(), and XMcdma_UpdateChanTDesc().

XMcdma_Bd* XMcdma_ChanCtrl::BdRestart

Pointer to the BD used to restart the channel.

Referenced by XMcDma_Chan_Sideband_Submit(), XMcDma_ChanBdCreate(), and XMcDma_ChanSubmit().

u32 XMcdma_ChanCtrl::BdSubmitCnt

Number of BDs submitted to hardware.

Referenced by XMcdma_BdChainFromHW(), XMcDma_ChanBdCreate(), and XMcdma_UpdateChanTDesc().

XMcdma_Bd* XMcdma_ChanCtrl::BdTail
volatile int XMcdma_ChanCtrl::ChanState
XMcdma_ChanDoneHandler XMcdma_ChanCtrl::DoneHandler

Callback for transfer done interrupt.

Referenced by XMcdma_ChanIntrHandler(), and XMcdma_ChanSetCallBack().

void* XMcdma_ChanCtrl::DoneRef

Reference passed to the done interrupt callback.

Referenced by XMcdma_ChanIntrHandler(), and XMcdma_ChanSetCallBack().

XMcdma_ChanErrorHandler XMcdma_ChanCtrl::ErrorHandler

Callback for error interrupt.

Referenced by XMcdma_ChanIntrHandler(), and XMcdma_ChanSetCallBack().

void* XMcdma_ChanCtrl::ErrorRef

Reference passed to the error interrupt callback.

Referenced by XMcdma_ChanIntrHandler(), and XMcdma_ChanSetCallBack().

u32 XMcdma_ChanCtrl::ext_addr

Non-zero when extended (64-bit) addressing is used.

Referenced by XMcDma_Initialize(), XMcdma_UpdateChanCDesc(), and XMcdma_UpdateChanTDesc().

UINTPTR XMcdma_ChanCtrl::FirstBdAddr

First BD address in the channel ring.

Referenced by XMcDma_ChanBdCreate().

u32 XMcdma_ChanCtrl::Has_Rxdre

Non-zero when the receive DRE is present.

Referenced by XMcDma_ChanBdCreate(), and XMcDma_Initialize().

u32 XMcdma_ChanCtrl::Has_Txdre

Non-zero when the transmit DRE is present.

Referenced by XMcDma_ChanBdCreate(), and XMcDma_Initialize().

int XMcdma_ChanCtrl::HasRxLength

Non-zero when receive length reporting is present.

Referenced by XMcDma_Chan_Sideband_Submit(), and XMcDma_Initialize().

u32 XMcdma_ChanCtrl::HasStsCntrlStrm

Non-zero when status/control stream is present.

Referenced by XMcDma_ChanBdCreate(), and XMcDma_Initialize().

u32 XMcdma_ChanCtrl::IsRxChan
UINTPTR XMcdma_ChanCtrl::LastBdAddr

Last BD address in the channel ring.

Referenced by XMcDma_ChanBdCreate().

u32 XMcdma_ChanCtrl::len

Total size of BD lengths in the channel.

u32 XMcdma_ChanCtrl::Length

Total length of the BD ring in bytes.

Referenced by XMcDma_ChanBdCreate().

u32 XMcdma_ChanCtrl::MaxTransferLen

Maximum transfer length for the channel.

Referenced by XMcDma_Chan_Sideband_Submit(), XMcDma_ChanSubmit(), and XMcDma_Initialize().

XMcdma_ChanPktDropHandler XMcdma_ChanCtrl::PktdropHandler

Callback for packet drop interrupt.

void* XMcdma_ChanCtrl::PktDropRef

Reference passed to the packet drop callback.

u32 XMcdma_ChanCtrl::RxDataWidth

Receive data width in bits.

Referenced by XMcDma_ChanBdCreate(), and XMcDma_Initialize().

XMcdma_QScheduler XMcdma_ChanCtrl::Schedulertype

Queue scheduler type for the channel.

UINTPTR XMcdma_ChanCtrl::Separation

Byte separation between consecutive BDs.

Referenced by XMcDma_ChanBdCreate().

u32 XMcdma_ChanCtrl::TxDataWidth

Transmit data width in bits.

Referenced by XMcDma_ChanBdCreate(), and XMcDma_Initialize().