1.34.29.15 XDMAC_CHANNEL_CALLBACK Typedef

C

    typedef void (*XDMAC_CHANNEL_CALLBACK) (XDMAC_TRANSFER_EVENT event, uintptr_t contextHandle);

Summary

Pointer to a XDMAC Transfer Event handler function.

Description

This data type defines a XDMAC Transfer Event Handler Function.

A XDMAC PLIB client must register a transfer event handler function of this type to receive transfer related events from the PLIB.

If the event is XDMAC_TRANSFER_EVENT_COMPLETE, this means that the data was transferred successfully.

If the event is XDMAC_TRANSFER_EVENT_ERROR, this means that the data was not transferred successfully.

The contextHandle parameter contains the context handle that was provided by the client at the time of registering the event handler. This context handle can be anything that the client consider helpful or necessary to identify the client context object associated with the channel of the XDMAC PLIB that generated the event.

The event handler function executes in an interrupt context of XDMAC. It is recommended to the application not to perform process intensive operations with in this function.

Remarks

None.