Detailed Description

MCASP Parameters.

MCASP Parameters are used to with the MCASP_open() call. Default values for these parameters are set using MCASP_openParamsInit().

If NULL is passed for the parameters, MCASP_open() uses default parameters.

See also: MCASP_openParamsInit()

Data Fields
uint32_t	transferMode

uint8_t	txBufferFormat

uint8_t	rxBufferFormat

uint8_t	txSerUsedCount

uint8_t	rxSerUsedCount

uint8_t *	txSerUsedArray

uint8_t *	rxSerUsedArray

uint8_t	txSlotCount

uint8_t	rxSlotCount

MCASP_TxCallbackFxn	txCallbackFxn

MCASP_RxCallbackFxn	rxCallbackFxn

uint32_t	txLoopjobEnable

uint8_t *	txLoopjobBuf

uint32_t	txLoopjobBufLength

uint32_t	rxLoopjobEnable

uint8_t *	rxLoopjobBuf

uint32_t	rxLoopjobBufLength

MCASP_DmaChConfig *	dmaChCfg

void *	mcaspDmaDrvObj

uint8_t *	cyclicBuffTx

uint32_t	cyclicBuffSizeTx

uint32_t	cyclicBuffCntTx

uint8_t *	cyclicBuffRx

uint32_t	cyclicBuffSizeRx

uint32_t	cyclicBuffCntRx

Udma_ChHandle *	cyclicTxFeedDMAHandle

Udma_ChHandle *	cyclicRxFeedDMAHandle

Udma_EventHandle	bcdmaTxCqEvtHandle

Udma_EventHandle	bcdmaRxCqEvtHandle

Udma_DrvHandle	bcdmaDrvHandle

MCASP_DmaTrpdMemAlloc *	trpdMemAllocTx

MCASP_DmaTrpdMemAlloc *	trpdMemAllocRx

Field Documentation

◆ transferMode

uint32_t MCASP_OpenParams::transferMode

Polling, Blocking or Callback mode.

◆ txBufferFormat

uint8_t MCASP_OpenParams::txBufferFormat

Audio buffer format for app tx buffer

◆ rxBufferFormat

uint8_t MCASP_OpenParams::rxBufferFormat

Audio buffer format for app rx buffer

◆ txSerUsedCount

uint8_t MCASP_OpenParams::txSerUsedCount

Number of allocated transmit serializers

◆ rxSerUsedCount

uint8_t MCASP_OpenParams::rxSerUsedCount

Number of allocated receive serializers

◆ txSerUsedArray

uint8_t* MCASP_OpenParams::txSerUsedArray

POinter to the array of allocated transmit serializer indices

◆ rxSerUsedArray

uint8_t* MCASP_OpenParams::rxSerUsedArray

POinter to the array of allocated receive serializer indices

◆ txSlotCount

uint8_t MCASP_OpenParams::txSlotCount

Number of slots for trasnmit operation

◆ rxSlotCount

uint8_t MCASP_OpenParams::rxSlotCount

Number of slots for receive operation

◆ txCallbackFxn

MCASP_TxCallbackFxn MCASP_OpenParams::txCallbackFxn

Read callback function pointer

◆ rxCallbackFxn

MCASP_RxCallbackFxn MCASP_OpenParams::rxCallbackFxn

Write callback function pointer

◆ txLoopjobEnable

uint32_t MCASP_OpenParams::txLoopjobEnable

Flag to enable loopjob for transmit

◆ txLoopjobBuf

uint8_t* MCASP_OpenParams::txLoopjobBuf

Loopjob buffer address for transmit

◆ txLoopjobBufLength

uint32_t MCASP_OpenParams::txLoopjobBufLength

Loopjob buffer length for transmit

◆ rxLoopjobEnable

uint32_t MCASP_OpenParams::rxLoopjobEnable

Flag to enable loopjob for receive

◆ rxLoopjobBuf

uint8_t* MCASP_OpenParams::rxLoopjobBuf

Loopjob buffer address for receive

◆ rxLoopjobBufLength

uint32_t MCASP_OpenParams::rxLoopjobBufLength

Loopjob buffer length for receive

◆ dmaChCfg

MCASP_DmaChConfig* MCASP_OpenParams::dmaChCfg

DMA channel config

◆ mcaspDmaDrvObj

void* MCASP_OpenParams::mcaspDmaDrvObj

DMA Handle

◆ cyclicBuffTx

uint8_t* MCASP_OpenParams::cyclicBuffTx

Cyclic Tx buffer pointer

◆ cyclicBuffSizeTx

uint32_t MCASP_OpenParams::cyclicBuffSizeTx

Tx cyclic buffer size

◆ cyclicBuffCntTx

uint32_t MCASP_OpenParams::cyclicBuffCntTx

Tx cyclic buffer count

◆ cyclicBuffRx

uint8_t* MCASP_OpenParams::cyclicBuffRx

Cyclic Rx buffer pointer

◆ cyclicBuffSizeRx

uint32_t MCASP_OpenParams::cyclicBuffSizeRx

Rx cyclic buffer size

◆ cyclicBuffCntRx

uint32_t MCASP_OpenParams::cyclicBuffCntRx

Rx cyclic buffer count

◆ cyclicTxFeedDMAHandle

Udma_ChHandle* MCASP_OpenParams::cyclicTxFeedDMAHandle

Channel hande to feed in data to cyclic Tx buffer

◆ cyclicRxFeedDMAHandle

Udma_ChHandle* MCASP_OpenParams::cyclicRxFeedDMAHandle

Channel hande to get out data from cyclic Rx buffer

◆ bcdmaTxCqEvtHandle

Udma_EventHandle MCASP_OpenParams::bcdmaTxCqEvtHandle

Completion queue event handle for feeding data to cyclic Tx buffer

◆ bcdmaRxCqEvtHandle

Udma_EventHandle MCASP_OpenParams::bcdmaRxCqEvtHandle

Completion queue event handle for getting data from cyclic Rx buffer

◆ bcdmaDrvHandle

Udma_DrvHandle MCASP_OpenParams::bcdmaDrvHandle

Drive handle for BCDMA

◆ trpdMemAllocTx

MCASP_DmaTrpdMemAlloc* MCASP_OpenParams::trpdMemAllocTx

Trpds for feeding in data to the cyclic Tx buffer

◆ trpdMemAllocRx

MCASP_DmaTrpdMemAlloc* MCASP_OpenParams::trpdMemAllocRx

Trpds for getting out data from the cyclic Rx buffer