Detailed Description

Callbacks and callback arguments for various common interrupt event.

Context specific callback be registered using CSIRX_ContextConfig

Data Fields
CSIRX_Callback	combinedEndOfLineCallback
	Combined End of Line call back function definition. More...

void *	combinedEndOfLineCallbackArgs
	Argument for CSIRX_CommonIntrCallbacks::combinedEndOfLineCallback. More...

CSIRX_Callback	combinedEndOfFrameCallback
	Combined End of Frame call back function definition. More...

void *	combinedEndOfFrameCallbackArgs
	Argument for CSIRX_CommonIntrCallbacks::combinedEndOfFrameCallback. More...

CSIRX_CommonCallback	commonCallback
	Common interrupt call back function definition. More...

void *	commonCallbackArgs
	Argument for CSIRX_CommonIntrCallbacks::commonCallback. More...

CSIRX_ContextCallback	startOfFrameIntr0Callback
	Start of Frame (SOF) Interrupt 0 call back function definition. More...

void *	startOfFrameIntr0CallbackArgs
	Argument for CSIRX_CommonIntrCallbacks::startOfFrameIntr0Callback. More...

CSIRX_ContextCallback	startOfFrameIntr1Callback
	Start of Frame (SOF) Interrupt 1 call back function definition. More...

void *	startOfFrameIntr1CallbackArgs
	Argument for CSIRX_CommonIntrCallbacks::startOfFrameIntr1Callback. More...

Field Documentation

◆ combinedEndOfLineCallback

CSIRX_Callback CSIRX_CommonIntrCallbacks::combinedEndOfLineCallback

Combined End of Line call back function definition.

This is called when one or more context whose CSIRX_ContextConfig::isEndOfLinePulseEnabled is true(enabled) triggers the end of line pulse

◆ combinedEndOfLineCallbackArgs

void* CSIRX_CommonIntrCallbacks::combinedEndOfLineCallbackArgs

Argument for CSIRX_CommonIntrCallbacks::combinedEndOfLineCallback.

◆ combinedEndOfFrameCallback

CSIRX_Callback CSIRX_CommonIntrCallbacks::combinedEndOfFrameCallback

Combined End of Frame call back function definition.

    This is called when
    one or more context whose \ref CSIRX_ContextConfig::isEndOfFramePulseEnabled
    is true(enaled) triggers the end of frame pulse

◆ combinedEndOfFrameCallbackArgs

void* CSIRX_CommonIntrCallbacks::combinedEndOfFrameCallbackArgs

Argument for CSIRX_CommonIntrCallbacks::combinedEndOfFrameCallback.

◆ commonCallback

CSIRX_CommonCallback CSIRX_CommonIntrCallbacks::commonCallback

Common interrupt call back function definition.

    This is called when any of the
    conditions in \ref CSIRX_CommonIntr are enabled and they happen.
    This API only provides the common interrupt status, the one associated with
    the physical interrupt line. User in their supplied call back function can do
    further parsing of common interrupt status to then query for example the
    complex IO and context interrupt using the following APIs: \n
    \ref CSIRX_complexioGetPendingIntr, \ref CSIRX_contextGetPendingIntr \n
    User must also clear the above ones using:
    \ref CSIRX_complexioClearAllIntr, \ref CSIRX_contextClearAllIntr \n
    Note the Isr inside the driver has responsibility of clearing all
    of the common interrupts. However, separate public APIs to query
    (\ref CSIRX_commonGetPendingIntr) and clear (\ref CSIRX_commonClearAllIntr)
    common interrupts are provided when user gives this call back function
    to be NULL, indicating a desire to poll the common interrupt.

◆ commonCallbackArgs

void* CSIRX_CommonIntrCallbacks::commonCallbackArgs

Argument for CSIRX_CommonIntrCallbacks::commonCallback.

◆ startOfFrameIntr0Callback

CSIRX_ContextCallback CSIRX_CommonIntrCallbacks::startOfFrameIntr0Callback

Start of Frame (SOF) Interrupt 0 call back function definition.

    This is
    called when the context for which SOF Interrupt 0 is to be generated gets a
    SOF packet. Note this is independent of the
    \ref CSIRX_ContextIntr::isFrameStartCodeDetect configuration.

◆ startOfFrameIntr0CallbackArgs

void* CSIRX_CommonIntrCallbacks::startOfFrameIntr0CallbackArgs

Argument for CSIRX_CommonIntrCallbacks::startOfFrameIntr0Callback.

◆ startOfFrameIntr1Callback

CSIRX_ContextCallback CSIRX_CommonIntrCallbacks::startOfFrameIntr1Callback

Start of Frame (SOF) Interrupt 1 call back function definition.

    This is
    called when the context for which SOF Interrupt 1 is to be generated gets a
    SOF packet. Note this is independent of the
    \ref CSIRX_ContextIntr::isFrameStartCodeDetect configuration.

◆ startOfFrameIntr1CallbackArgs

void* CSIRX_CommonIntrCallbacks::startOfFrameIntr1CallbackArgs

Argument for CSIRX_CommonIntrCallbacks::startOfFrameIntr1Callback.