Type Definitions

General Description

Typedefs
typedef bool(*	cy_cb_hbdma_intr_callback_t) (cy_hbdma_socket_id_t socketId, cy_en_hbdma_sock_evt_t intrType, uint32_t curDscr, void *userCtx)
	High BandWidth DMA socket interrupt callback prototype. More...
typedef void(*	cy_cb_hbdma_mgr_intr_ctrl_cb_t) (bool enableIntr)
	Type of callback function to be provided by the application to enable dynamic enable/disable control of the HBDma interrupts. More...
typedef void(*	cy_cb_hbdma_event_callback_t) (struct cy_stc_hbdma_channel *handle, cy_en_hbdma_cb_type_t type, struct cy_stc_hbdma_buff_status *pbufStat, void *userCtx)
	Type of callback function to be registered to receive DMA channel event notifications. More...

Typedef Documentation

cy_cb_hbdma_intr_callback_t

typedef bool(* cy_cb_hbdma_intr_callback_t) (cy_hbdma_socket_id_t socketId, cy_en_hbdma_sock_evt_t intrType, uint32_t curDscr, void *userCtx)

High BandWidth DMA socket interrupt callback prototype.

This is an internal callback function used by the socket ISRs to send information to the DMA manager for processing.

Returns

Indicates whether further interrupt processing is to be paused to avoid over-running the interrupt queue.

Parameters

socketId	Socket on which the interrupt was received.
intrType	Type of interrupt received.
curDscr	Current descriptor on the socket after the interrupt has been received.
userCtx	Opaque variable used to pass the DMA manager context structure pointer.

cy_cb_hbdma_mgr_intr_ctrl_cb_t

typedef void(* cy_cb_hbdma_mgr_intr_ctrl_cb_t) (bool enableIntr)

Type of callback function to be provided by the application to enable dynamic enable/disable control of the HBDma interrupts.

This function will be used by the HBDma manager as required to prevent overflows in the message queue used to receive interrupt notifications.

Parameters

enableIntr

Whether the DMA adapter interrupts are to be enabled or disabled.

Returns

void

cy_cb_hbdma_event_callback_t

typedef void(* cy_cb_hbdma_event_callback_t) (struct cy_stc_hbdma_channel *handle, cy_en_hbdma_cb_type_t type, struct cy_stc_hbdma_buff_status *pbufStat, void *userCtx)

Type of callback function to be registered to receive DMA channel event notifications.

Parameters

handle	Handle to DMA channel on which event of interest has been detected.
type	Type of the DMA event being notified.
pbufStat	Provides active DMA buffer status where applicable.
userCtx	User provided opaque data which is passed back to the event callback.

Returns

void