CSITX Driver Event API

Introduction

This is CSITX driver event related configuration parameters and API

Files
file	csitx_event.h
	CSITX event related parameters and API.

Data Structures
struct	Csitx_EventPrms
	CSITX event related parameters. More...
struct	Csitx_EventStatus
	CSITX event status parameters. Instance of this structure will passed to the application call-back. More...

Functions
void	Csitx_eventPrmsInit (Csitx_EventPrms *eventPrms)
	Csitx_EventPrms structure init function. More...

Typedefs
typedef void(*	CsitxDrv_EventCallback) (Csitx_EventStatus eventStatus, void *appData)
	CSITX event callback function. More...

Macros
#define	CSITX_EVENT_INVALID   ((uint32_t) CSL_CSITXP_NO_EVENT)
	Macro used to specify that event ID is invalid. More...
#define	CSITX_INTR_INVALID   ((uint32_t) 0xFFFF0000U)
	Macro used to specify that interrupt number is invalid. More...

CSITX Event Group
CSITX events groups per CSI instance supported.
#define	CSITX_EVENT_GROUP_TX_IRQ   ((uint32_t) 0U)
	Event Group: Tx Interrupts. Tx interrupts event group. More...
#define	CSITX_EVENT_GROUP_MAX

CSITX Tx Interrupts Event Type
CSITX Tx interrupt events supported. This is valid if event group is 'CSITX_EVENT_GROUP_TX_IRQ'
#define	CSITX_EVENT_TYPE_TX_IRQ_ALL
	All Error Group interrupts/events mask. More...

Macro Definition Documentation

CSITX_EVENT_INVALID

#define CSITX_EVENT_INVALID   ((uint32_t) CSL_CSITXP_NO_EVENT)

Macro used to specify that event ID is invalid.

CSITX_INTR_INVALID

#define CSITX_INTR_INVALID   ((uint32_t) 0xFFFF0000U)

Macro used to specify that interrupt number is invalid.

CSITX_EVENT_GROUP_TX_IRQ

#define CSITX_EVENT_GROUP_TX_IRQ   ((uint32_t) 0U)

Event Group: Tx Interrupts. Tx interrupts event group.

Tx Event Group: Tx Interrupts.

CSITX_EVENT_GROUP_MAX

#define CSITX_EVENT_GROUP_MAX

Value:

((uint32_t) \
                                            (CSITX_EVENT_GROUP_TX_IRQ + 1U))

CSITX_EVENT_TYPE_TX_IRQ_ALL

#define CSITX_EVENT_TYPE_TX_IRQ_ALL

All Error Group interrupts/events mask.

Typedef Documentation

CsitxDrv_EventCallback

typedef void(* CsitxDrv_EventCallback) (Csitx_EventStatus eventStatus, void *appData)

CSITX event callback function.

Parameters

eventType	Event that occurred
appData	Callback pointer passed during event register

Function Documentation

Csitx_eventPrmsInit()

void Csitx_eventPrmsInit

(

Csitx_EventPrms *

eventPrms

)

Csitx_EventPrms structure init function.

Note: 'eventPrms' cannot be NULL while calling this function. Also, before call 'Csitx_eventPrmsInit()', 'eventGroup' from 'eventPrms' should be set.

Parameters

eventPrms

Pointer to Csitx_EventPrms structure.