![]() |
v_sdirx
Xilinx SDK Drivers API Documentation
|
This is the main file 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 | |
int | XV_SdiRx_CfgInitialize (XV_SdiRx *InstancePtr, XV_SdiRx_Config *CfgPtr, UINTPTR EffectiveAddr) |
This function initializes the SDI RX core. More... | |
void | XV_SdiRx_ResetStream (XV_SdiRx *InstancePtr) |
This function clears the SDI RX stream variables and sets them to the defaults. More... | |
void | XV_SdiRx_DebugInfo (XV_SdiRx *InstancePtr, XV_SdiRx_DebugSelId SelId) |
This function prints debug information of Stream 0 on STDIO/Uart console. More... | |
int | XV_SdiRx_Stop (XV_SdiRx *InstancePtr) |
This function stops SDI RX core's modes detection. More... | |
void | XV_SdiRx_FramerEnable (XV_SdiRx *InstancePtr) |
This function enables the framer function. More... | |
void | XV_SdiRx_FramerDisable (XV_SdiRx *InstancePtr) |
This function disables the framer function. More... | |
void | XV_SdiRx_Start (XV_SdiRx *InstancePtr, XV_SdiRx_SearchMode Mode) |
This function enables SDI RX core's modes detection function. More... | |
u32 | XV_SdiRx_ReportDetectedError (XV_SdiRx *InstancePtr) |
This function reports detected CRC or EDH errors count. More... | |
void | XV_SdiRx_VidBridgeEnable (XV_SdiRx *InstancePtr) |
This function enables the video bridge. More... | |
void | XV_SdiRx_VidBridgeDisable (XV_SdiRx *InstancePtr) |
This function disables the video bridge. More... | |
void | XV_SdiRx_Axi4sBridgeEnable (XV_SdiRx *InstancePtr) |
This function enable the AXI4S Bridge. More... | |
void | XV_SdiRx_Axi4sBridgeDisable (XV_SdiRx *InstancePtr) |
This function disables the AXI4S Bridge. More... | |
u32 | XV_SdiRx_GetPayloadId (XV_SdiRx *InstancePtr, u8 DataStream) |
This function returns incoming stream's incoming SDI payload ID. More... | |
u32 | XV_SdiRx_WaitforPayLoad (XV_SdiRx *InstancePtr) |
This function is used to wait for the payload valid bit to be set. More... | |
u32 | XV_SdiRx_GetSdiMode (XV_SdiRx *InstancePtr) |
This function returns the current SDI transport mode detected. More... | |
void | XV_SdiRx_SetVidLckWindow (XV_SdiRx *InstancePtr, u32 Data) |
This function sets the clock period for video lock signal to be asserted before video lock interrupt is triggered. More... | |
void | XV_SdiRx_SetEdhErrCntTrigger (XV_SdiRx *InstancePtr, u32 Enable) |
This function sets the type of EDH errors which will trigger the error count. More... | |
void | XV_SdiRx_EnableMode (XV_SdiRx *InstancePtr, XV_SdiRx_SupportedModes SupportModes) |
This function enables the modes which the SDI RX core will try to lock on. More... | |
void | XV_SdiRx_DisableMode (XV_SdiRx *InstancePtr, XV_SdiRx_SupportedModes RemoveModes) |
This function disables the modes which the SDI RX core will try to lock on. More... | |
void XV_SdiRx_Axi4sBridgeDisable | ( | XV_SdiRx * | InstancePtr | ) |
This function disables the AXI4S Bridge.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
void XV_SdiRx_Axi4sBridgeEnable | ( | XV_SdiRx * | InstancePtr | ) |
This function enable the AXI4S Bridge.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
int XV_SdiRx_CfgInitialize | ( | XV_SdiRx * | InstancePtr, |
XV_SdiRx_Config * | CfgPtr, | ||
UINTPTR | EffectiveAddr | ||
) |
This function initializes the SDI RX core.
This function must be called prior to using the SDI RX core. Initialization of the SDI RX includes setting up the instance data, and ensuring the hardware is in a quiescent state.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
CfgPtr | points to the configuration structure associated with the SDI RX core. |
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_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx::StreamDownCallback.
void XV_SdiRx_DebugInfo | ( | XV_SdiRx * | InstancePtr, |
XV_SdiRx_DebugSelId | SelId | ||
) |
This function prints debug information of Stream 0 on STDIO/Uart console.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
SelId | specifies which debug information to be printed out |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, XV_SdiRx::Stream, XV_SdiRx_Stream::Video, and XV_SdiRx_ReadReg.
void XV_SdiRx_DisableMode | ( | XV_SdiRx * | InstancePtr, |
XV_SdiRx_SupportedModes | RemoveModes | ||
) |
This function disables the modes which the SDI RX core will try to lock on.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
RemoveModes | specifies which SDI mode is to be removed from SDI mode detection logic. |
void XV_SdiRx_EnableMode | ( | XV_SdiRx * | InstancePtr, |
XV_SdiRx_SupportedModes | SupportModes | ||
) |
This function enables the modes which the SDI RX core will try to lock on.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
SupportModes | specifies which SDI mode is to be supported from SDI mode detection logic. |
void XV_SdiRx_FramerDisable | ( | XV_SdiRx * | InstancePtr | ) |
This function disables the framer function.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
void XV_SdiRx_FramerEnable | ( | XV_SdiRx * | InstancePtr | ) |
This function enables the framer function.
When enabled, the framer automatically readjusts the output word alignment to match the alignment of each timing reference signal (TRS).
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
u32 XV_SdiRx_GetPayloadId | ( | XV_SdiRx * | InstancePtr, |
u8 | DataStream | ||
) |
This function returns incoming stream's incoming SDI payload ID.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
DataStream | specifies which payload ID is to be returned. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
u32 XV_SdiRx_GetSdiMode | ( | XV_SdiRx * | InstancePtr | ) |
This function returns the current SDI transport mode detected.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
Referenced by XV_SdiRx_ReportDetectedError().
u32 XV_SdiRx_ReportDetectedError | ( | XV_SdiRx * | InstancePtr | ) |
This function reports detected CRC or EDH errors count.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, XV_SdiRx_GetSdiMode(), and XV_SdiRx_ReadReg.
void XV_SdiRx_ResetStream | ( | XV_SdiRx * | InstancePtr | ) |
This function clears the SDI RX stream variables and sets them to the defaults.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
void XV_SdiRx_SetEdhErrCntTrigger | ( | XV_SdiRx * | InstancePtr, |
u32 | Enable | ||
) |
This function sets the type of EDH errors which will trigger the error count.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
Enable | specifies the type of EDH errors to be allowed to increment the error counter.
|
void XV_SdiRx_SetVidLckWindow | ( | XV_SdiRx * | InstancePtr, |
u32 | Data | ||
) |
This function sets the clock period for video lock signal to be asserted before video lock interrupt is triggered.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
Data | specifies the clock period. |
References XV_SdiRx_WriteReg.
void XV_SdiRx_Start | ( | XV_SdiRx * | InstancePtr, |
XV_SdiRx_SearchMode | Mode | ||
) |
This function enables SDI RX core's modes detection function.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
Mode | specifies the mode of SDI modes searching operation.
|
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
int XV_SdiRx_Stop | ( | XV_SdiRx * | InstancePtr | ) |
This function stops SDI RX core's modes detection.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
Referenced by XV_SdiRx_SelfTest().
void XV_SdiRx_VidBridgeDisable | ( | XV_SdiRx * | InstancePtr | ) |
This function disables the video bridge.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
void XV_SdiRx_VidBridgeEnable | ( | XV_SdiRx * | InstancePtr | ) |
This function enables the video bridge.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.
u32 XV_SdiRx_WaitforPayLoad | ( | XV_SdiRx * | InstancePtr | ) |
This function is used to wait for the payload valid bit to be set.
This has to be called from application based on the callback indication of the video lock interrupt handler. Without this function being called, it may be guaranteed that payload bits are valid after video lock interrupt occured.
InstancePtr | is a pointer to the XV_SdiRx core instance. |
References XV_SdiRx_Config::BaseAddress, XV_SdiRx::Config, and XV_SdiRx_ReadReg.