![]() |
v_sdirx
Xilinx SDK Drivers API Documentation
|
This file contains interrupt related functions for Xilinx SDI RX core.
Please see xv_sdirx.h for more details of the driver.
MODIFICATION HISTORY:
Ver Who Date Changes
1.0 jsr 07/17/17 Initial release.
Functions | |
u32 | XV_SdiRx_GetIntrEnable (XV_SdiRx *InstancePtr) |
This function will get the interrupt mask set (enabled) in the SDI Rx core. More... | |
u32 | XV_SdiRx_GetIntrStatus (XV_SdiRx *InstancePtr) |
This function will get the list of interrupts pending in the Interrupt Status Register of the SDI Rx core. More... | |
void | XV_SdiRx_InterruptClear (XV_SdiRx *InstancePtr, u32 Mask) |
This function will clear the interrupts set in the Interrupt Status Register of the SDI Rx core. More... | |
void | XV_SdiRx_IntrHandler (void *InstancePtr) |
This function is the interrupt handler for the SDI RX driver. More... | |
int | XV_SdiRx_SetCallback (XV_SdiRx *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef) |
This function installs an asynchronous callback function for the given HandlerType: More... | |
void | XV_SdiRx_IntrEnable (XV_SdiRx *InstancePtr, u32 Mask) |
This function enables the selected interrupt. More... | |
void | XV_SdiRx_IntrDisable (XV_SdiRx *InstancePtr, u32 Mask) |
This function disables the selected interrupt. More... | |
u32 XV_SdiRx_GetIntrEnable | ( | XV_SdiRx * | InstancePtr | ) |
This function will get the interrupt mask set (enabled) in the SDI Rx core.
InstancePtr | is the XV_SdiRx instance to operate on |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
u32 XV_SdiRx_GetIntrStatus | ( | XV_SdiRx * | InstancePtr | ) |
This function will get the list of interrupts pending in the Interrupt Status Register of the SDI Rx core.
InstancePtr | is the XV_SdiRx instance to operate on |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
Referenced by XV_SdiRx_IntrHandler().
void XV_SdiRx_InterruptClear | ( | XV_SdiRx * | InstancePtr, |
u32 | Mask | ||
) |
This function will clear the interrupts set in the Interrupt Status Register of the SDI Rx core.
InstancePtr | is the XV_SdiRx instance to operate on |
Mask | is Interrupt Mask with bits set for corresponding interrupt to be cleared in the Interrupt Status register |
void XV_SdiRx_IntrDisable | ( | XV_SdiRx * | InstancePtr, |
u32 | Mask | ||
) |
This function disables the selected interrupt.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
Mask | is the interrupt mask which need to be disabled in core. |
void XV_SdiRx_IntrEnable | ( | XV_SdiRx * | InstancePtr, |
u32 | Mask | ||
) |
This function enables the selected interrupt.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
Mask | is the interrupt mask which need to be enabled in core. |
void XV_SdiRx_IntrHandler | ( | void * | InstancePtr | ) |
This function is the interrupt handler for the SDI RX driver.
This handler reads the pending interrupt for video lock or video unlock interrupts, determines the source of the interrupts, clears the interrupts and calls callbacks accordingly.
The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using XV_SdiRx_SetCallback() during initialization phase. An example delivered with this driver demonstrates how this could be done.
InstancePtr | is a pointer to the XV_SdiRx instance that just interrupted. |
References XV_SdiRx::IsReady, and XV_SdiRx_GetIntrStatus().
int XV_SdiRx_SetCallback | ( | XV_SdiRx * | InstancePtr, |
u32 | HandlerType, | ||
void * | CallbackFunc, | ||
void * | CallbackRef | ||
) |
This function installs an asynchronous callback function for the given HandlerType:
HandlerType Callback Function Type ------------------------- --------------------------------------- (XV_SDIRX_HANDLER_STREAM_DOWN) StreamDownCallback (XV_SDIRX_HANDLER_STREAM_UP) StreamUpCallback (XV_SDIRX_HANDLER_OVERFLOW) OverFlowCallback (XV_SDIRX_HANDLER_UNDERFLOW) UnderFlowCallback
InstancePtr | is a pointer to the SDI RX core instance. |
HandlerType | specifies the type of handler. |
CallbackFunc | is the address of the callback function. |
CallbackRef | is a user data item that will be passed to the callback function when it is invoked. |