![]() |
v_sdirxss
Xilinx SDK Drivers API Documentation
|
This is the main file for Xilinx SDI RX core.
Please see xv_ddirxss.h for more details of the driver.
MODIFICATION HISTORY:
Ver Who Date Changes
1.00 jsr 07/17/17 Initial release.
Functions | |
void | XV_SdiRxSS_SdiRxIntrHandler (XV_SdiRxSs *InstancePtr) |
This function calls the interrupt handler for SDI RX. More... | |
void | XV_SdiRxSs_ReportCoreInfo (XV_SdiRxSs *InstancePtr) |
This function reports list of cores included in Video Processing Subsystem. More... | |
int | XV_SdiRxSs_CfgInitialize (XV_SdiRxSs *InstancePtr, XV_SdiRxSs_Config *CfgPtr, UINTPTR EffectiveAddr) |
This function initializes the video subsystem and included sub-cores. More... | |
void | XV_SdiRxSs_StreamFlowEnable (XV_SdiRxSs *InstancePtr) |
This function enables the AXIS and video bridges. More... | |
void | XV_SdiRxSs_StreamFlowDisable (XV_SdiRxSs *InstancePtr) |
This function disables the AXIS and video bridges. More... | |
void | XV_SdiRxSs_Start (XV_SdiRxSs *InstancePtr, XV_SdiRx_SearchMode Mode) |
This function starts the SDI RX stream detection. More... | |
void | XV_SdiRxSs_Stop (XV_SdiRxSs *InstancePtr) |
This function stops the SDI RX stream detection. More... | |
int | XV_SdiRxSs_SetCallback (XV_SdiRxSs *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef) |
This function installs an asynchronous callback function for the given HandlerType: More... | |
XVidC_VideoStream * | XV_SdiRxSs_GetVideoStream (XV_SdiRxSs *InstancePtr, u8 StreamId) |
This function returns the pointer to SDI RX SS video stream. More... | |
void | XV_SdiRxSs_ReportInfo (XV_SdiRxSs *InstancePtr) |
This function prints the SDI RX SS information. More... | |
void | XV_SdiRxSs_ReportDebugInfo (XV_SdiRxSs *InstancePtr) |
This function prints the SDI RX SS debug information. More... | |
int | XV_SdiRxSs_IsStreamUp (XV_SdiRxSs *InstancePtr) |
This function checks if the video stream is up. More... | |
void | XV_SdiRxSs_IntrEnable (XV_SdiRxSs *InstancePtr, u32 IntrMask) |
This function is used to configure the SDI RX interrupts that are to be handled by the application. More... | |
void | XV_SdiRxSs_IntrDisable (XV_SdiRxSs *InstancePtr, u32 IntrMask) |
This function is used to configure the SDI RX interrupts that are to be handled by the application. More... | |
Variables | |
XV_SdiRxSs_SubCores | XV_SdiRxSs_SubCoreRepo [XPAR_XV_SDIRXSS_NUM_INSTANCES] |
Define Driver instance of all sub-core included in the design. More... | |
int XV_SdiRxSs_CfgInitialize | ( | XV_SdiRxSs * | InstancePtr, |
XV_SdiRxSs_Config * | CfgPtr, | ||
UINTPTR | EffectiveAddr | ||
) |
This function initializes the video subsystem and included sub-cores.
This function must be called prior to using the subsystem. Initialization includes setting up the instance data for top level as well as all included sub-core therein, and ensuring the hardware is in a known stable state.
InstancePtr | is a pointer to the Subsystem instance to be worked on. |
CfgPtr | points to the configuration structure associated with the subsystem instance. |
EffectiveAddr | is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used. |
References XV_SdiRxSs_Config::BaseAddress, and XV_SdiRxSs::Config.
Referenced by SdiRxSs_SelfTestExample().
XVidC_VideoStream* XV_SdiRxSs_GetVideoStream | ( | XV_SdiRxSs * | InstancePtr, |
u8 | StreamId | ||
) |
This function returns the pointer to SDI RX SS video stream.
InstancePtr | pointer to XV_SdiRxSs instance |
StreamId | specifies which video stream's pointer to be returned |
References XV_SdiRxSs::SdiRxPtr.
void XV_SdiRxSs_IntrDisable | ( | XV_SdiRxSs * | InstancePtr, |
u32 | IntrMask | ||
) |
This function is used to configure the SDI RX interrupts that are to be handled by the application.
Refer to xv_sdirxss_hw.h for interrupt masks.
InstancePtr | pointer to XV_SdiRxSs instance |
IntrMask | Indicates Mask for disabling interrupts. |
References XV_SdiRxSs::SdiRxPtr.
void XV_SdiRxSs_IntrEnable | ( | XV_SdiRxSs * | InstancePtr, |
u32 | IntrMask | ||
) |
This function is used to configure the SDI RX interrupts that are to be handled by the application.
Refer to xv_sdirxss_hw.h for interrupt masks.
InstancePtr | pointer to XV_SdiRxSs instance |
IntrMask | Indicates Mask for enable interrupts. |
References XV_SdiRxSs::SdiRxPtr.
int XV_SdiRxSs_IsStreamUp | ( | XV_SdiRxSs * | InstancePtr | ) |
This function checks if the video stream is up.
InstancePtr | pointer to XV_SdiRxSs instance |
References XV_SdiRxSs::IsStreamUp.
void XV_SdiRxSs_ReportCoreInfo | ( | XV_SdiRxSs * | InstancePtr | ) |
This function reports list of cores included in Video Processing Subsystem.
InstancePtr | is a pointer to the Subsystem instance. |
References XV_SdiRxSs::SdiRxPtr.
Referenced by XV_SdiRxSs_ReportInfo().
void XV_SdiRxSs_ReportDebugInfo | ( | XV_SdiRxSs * | InstancePtr | ) |
This function prints the SDI RX SS debug information.
InstancePtr | pointer to XV_SdiRxSs instance |
References XV_SdiRxSs::SdiRxPtr.
void XV_SdiRxSs_ReportInfo | ( | XV_SdiRxSs * | InstancePtr | ) |
This function prints the SDI RX SS information.
InstancePtr | pointer to XV_SdiRxSs instance |
References XV_SdiRxSs::SdiRxPtr, and XV_SdiRxSs_ReportCoreInfo().
void XV_SdiRxSS_SdiRxIntrHandler | ( | XV_SdiRxSs * | InstancePtr | ) |
This function calls the interrupt handler for SDI RX.
InstancePtr | is a pointer to the SDI RX Subsystem |
References XV_SdiRxSs::SdiRxPtr.
int XV_SdiRxSs_SetCallback | ( | XV_SdiRxSs * | InstancePtr, |
u32 | HandlerType, | ||
void * | CallbackFunc, | ||
void * | CallbackRef | ||
) |
This function installs an asynchronous callback function for the given HandlerType:
HandlerType Callback Function Type ----------------------- --------------------------------------------- (XV_SDIRXSS_HANDLER_STREAM_DOWN) StreamDownCallback (XV_SDIRXSS_HANDLER_STREAM_UP) StreamUpCallback (XV_SDIRXSS_HANDLER_OVERFLOW) OverFlowCallback (XV_SDIRXSS_HANDLER_UNDERFLOW) UnderFlowCallback
InstancePtr | is a pointer to the SDI RX Subsystem 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. |
References XV_SdiRxSs::OverFlowCallback, XV_SdiRxSs::OverFlowRef, XV_SdiRxSs::StreamDownCallback, XV_SdiRxSs::StreamDownRef, XV_SdiRxSs::StreamUpCallback, XV_SdiRxSs::StreamUpRef, XV_SdiRxSs::UnderFlowCallback, XV_SdiRxSs::UnderFlowRef, XV_SDIRXSS_HANDLER_OVERFLOW, XV_SDIRXSS_HANDLER_STREAM_DOWN, XV_SDIRXSS_HANDLER_STREAM_UP, and XV_SDIRXSS_HANDLER_UNDERFLOW.
void XV_SdiRxSs_Start | ( | XV_SdiRxSs * | InstancePtr, |
XV_SdiRx_SearchMode | Mode | ||
) |
This function starts the SDI RX stream detection.
InstancePtr | pointer to XV_SdiRxSs instance |
Mode | specifies the mode of SDI modes searching operation.
|
References XV_SdiRxSs::SdiRxPtr, XV_SDIRXSS_LOG_EVT_START, and XV_SdiRxSs_LogWrite().
void XV_SdiRxSs_Stop | ( | XV_SdiRxSs * | InstancePtr | ) |
This function stops the SDI RX stream detection.
InstancePtr | is a pointer to the Subsystem instance to be worked on. |
References XV_SdiRxSs::SdiRxPtr, XV_SDIRXSS_LOG_EVT_STOP, and XV_SdiRxSs_LogWrite().
void XV_SdiRxSs_StreamFlowDisable | ( | XV_SdiRxSs * | InstancePtr | ) |
This function disables the AXIS and video bridges.
InstancePtr | pointer to XV_SdiRxSs instance |
References XV_SdiRxSs::SdiRxPtr.
void XV_SdiRxSs_StreamFlowEnable | ( | XV_SdiRxSs * | InstancePtr | ) |
This function enables the AXIS and video bridges.
InstancePtr | pointer to XV_SdiRxSs instance |
References XV_SdiRxSs::SdiRxPtr.
XV_SdiRxSs_SubCores XV_SdiRxSs_SubCoreRepo[XPAR_XV_SDIRXSS_NUM_INSTANCES] |
Define Driver instance of all sub-core included in the design.