v_sditx
Xilinx SDK Drivers API Documentation
xv_sditx_intr.c File Reference

Overview

This file contains interrupt related functions for Xilinx SDI TX core.

Please see xv_sditx.h for more details of the driver.

MODIFICATION HISTORY:
Ver   Who    Date     Changes

1.0 jsr 07/17/17 Initial release.

Functions

u32 XV_SdiTx_GetIntrEnable (XV_SdiTx *InstancePtr)
 This function will get the interrupt mask set (enabled) in the SDI Tx core. More...
 
u32 XV_SdiTx_GetIntrStatus (XV_SdiTx *InstancePtr)
 This function will get the list of interrupts pending in the Interrupt Status Register of the SDI Tx core. More...
 
void XV_SdiTx_InterruptClear (XV_SdiTx *InstancePtr, u32 Mask)
 This function will clear the interrupts set in the Interrupt Status Register of the SDI Tx core. More...
 
void XV_SdiTx_IntrHandler (void *InstancePtr)
 This function is the interrupt handler for the SDI TX driver. More...
 
int XV_SdiTx_SetCallback (XV_SdiTx *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)
 This function installs an asynchronous callback function for the given HandlerType: More...
 
void XV_SdiTx_IntrEnable (XV_SdiTx *InstancePtr, u32 Mask)
 This function enables the selected interrupt. More...
 
void XV_SdiTx_IntrDisable (XV_SdiTx *InstancePtr, u32 Mask)
 This function disables the selected interrupt. More...
 

Function Documentation

◆ XV_SdiTx_GetIntrEnable()

u32 XV_SdiTx_GetIntrEnable ( XV_SdiTx InstancePtr)

This function will get the interrupt mask set (enabled) in the SDI Tx core.

Parameters
InstancePtris the XV_SdiTx instance to operate on
Returns
Interrupt Mask with bits set for corresponding interrupt in Interrupt enable register
Note
None

References XV_SdiTx_Config::BaseAddress, XV_SdiTx::Config, and XV_SdiTx_ReadReg.

◆ XV_SdiTx_GetIntrStatus()

u32 XV_SdiTx_GetIntrStatus ( XV_SdiTx InstancePtr)

This function will get the list of interrupts pending in the Interrupt Status Register of the SDI Tx core.

Parameters
InstancePtris the XV_SdiTx instance to operate on
Returns
Interrupt Mask with bits set for corresponding interrupt in Interrupt Status register
Note
None

References XV_SdiTx_Config::BaseAddress, XV_SdiTx::Config, and XV_SdiTx_ReadReg.

Referenced by XV_SdiTx_IntrHandler().

◆ XV_SdiTx_InterruptClear()

void XV_SdiTx_InterruptClear ( XV_SdiTx InstancePtr,
u32  Mask 
)

This function will clear the interrupts set in the Interrupt Status Register of the SDI Tx core.

Parameters
InstancePtris the XV_SdiTx instance to operate on
Maskis Interrupt Mask with bits set for corresponding interrupt to be cleared in the Interrupt Status register
Returns
None
Note
None

◆ XV_SdiTx_IntrDisable()

void XV_SdiTx_IntrDisable ( XV_SdiTx InstancePtr,
u32  Mask 
)

This function disables the selected interrupt.

Parameters
InstancePtris a pointer to the XV_SdiTx core instance.
Maskto be disabled.
Returns
None.
Note
None.

◆ XV_SdiTx_IntrEnable()

void XV_SdiTx_IntrEnable ( XV_SdiTx InstancePtr,
u32  Mask 
)

This function enables the selected interrupt.

Parameters
InstancePtris a pointer to the XV_SdiTx core instance.
Maskto be enabled.
Returns
None.
Note
None.

◆ XV_SdiTx_IntrHandler()

void XV_SdiTx_IntrHandler ( void *  InstancePtr)

This function is the interrupt handler for the SDI TX driver.

This handler reads the pending interrupt for GT reset done interrupt from Tx IP, 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_SdiTx_SetCallback() during initialization phase. An example delivered with this driver demonstrates how this could be done.

Parameters
InstancePtris a pointer to the XV_SdiTx instance that just interrupted.
Returns
None.
Note
None.

References XV_SdiTx::IsReady, and XV_SdiTx_GetIntrStatus().

◆ XV_SdiTx_SetCallback()

int XV_SdiTx_SetCallback ( XV_SdiTx InstancePtr,
u32  HandlerType,
void *  CallbackFunc,
void *  CallbackRef 
)

This function installs an asynchronous callback function for the given HandlerType:

HandlerType                       Callback Function Type
-------------------------         -------------------------------------------
(XV_SDITX_HANDLER_GTRESET_DONE) GtRstDoneCallback
(XV_SDITX_HANDLER_OVERFLOW)             OverFlowCallback
(XV_SDITX_HANDLER_UNDERFLOW)            UnderFlowCallback
Parameters
InstancePtris a pointer to the SDI TX core instance.
HandlerTypespecifies the type of handler.
CallbackFuncis the address of the callback function.
CallbackRefis a user data item that will be passed to the callback function when it is invoked.
Returns
  • XST_SUCCESS if callback function installed successfully.
  • XST_INVALID_PARAM when HandlerType is invalid.
Note
Invoking this function for a handler that already has been installed replaces it with the new handler.