Detailed Description

CBUFF configuration.

The structure describes the configuration which is required to configure the CBUFF Driver.

Data Fields
CBUFF_FrameDoneCallbackFxn	frameDoneCallbackFxn
	This is the callback function which is triggered once the frame has been sent over the HSI. This can be set to NULL if the application only uses a single session. But if multiple sessions are being used application should register this callback function in order to switch from one session to another. More...

EDMA_Handle	edmaHandle
	EDMA Instance Handle: The session will allocate EDMA channels. More...

CBUFF_EDMAChannelAllocateFxn	allocateEDMAChannelFxn
	Application provided EDMA Channel allocation function. More...

CBUFF_EDMAChannelFreeFxn	freeEDMAChannelFxn
	Application provided EDMA Channel free function. More...

CBUFF_DataType	dataType
	Type of Data: Real or Complex which is going to be streamed out via the CBUFF High speed interface. More...

CBUFF_BufferCfg	header
	This is the header which needs to be added to the stream. If the size in the header is set to 0 then no header will be appended. More...

CBUFF_SwSessionCfg	swCfg
	Configuration used if the session is executing in software trigerred mode. More...

Field Documentation

◆ frameDoneCallbackFxn

CBUFF_FrameDoneCallbackFxn CBUFF_SessionCfg::frameDoneCallbackFxn

This is the callback function which is triggered once the frame has been sent over the HSI. This can be set to NULL if the application only uses a single session. But if multiple sessions are being used application should register this callback function in order to switch from one session to another.

NOTE: Applications are responsible for ensuring that the switch between the sessions is done between the inter-frame boundaries. Failure to enforce this will result in unpredictable behavior.

◆ edmaHandle

EDMA_Handle CBUFF_SessionCfg::edmaHandle

EDMA Instance Handle: The session will allocate EDMA channels.

◆ allocateEDMAChannelFxn

CBUFF_EDMAChannelAllocateFxn CBUFF_SessionCfg::allocateEDMAChannelFxn

Application provided EDMA Channel allocation function.

◆ freeEDMAChannelFxn

CBUFF_EDMAChannelFreeFxn CBUFF_SessionCfg::freeEDMAChannelFxn

Application provided EDMA Channel free function.

◆ dataType

CBUFF_DataType CBUFF_SessionCfg::dataType

Type of Data: Real or Complex which is going to be streamed out via the CBUFF High speed interface.

◆ header

CBUFF_BufferCfg CBUFF_SessionCfg::header

This is the header which needs to be added to the stream. If the size in the header is set to 0 then no header will be appended.

◆ swCfg

CBUFF_SwSessionCfg CBUFF_SessionCfg::swCfg

Configuration used if the session is executing in software trigerred mode.