v_sditxss
Vitis Drivers API Documentation
xsdi_example.c File Reference

Overview

This file demonstrates how to use Xilinx SDI Rx Subsystem for standalone.

MODIFICATION HISTORY:
Ver   Who    Date     Changes


1.00 ssh 07/05/18 Initial release.

Macros

#define I2C_MUX_ADDR   0x74
 I2C Mux Address. More...
 
#define I2C_CLK_ADDR   0x69
 I2C Clk Address. More...
 
#define I2C_CLK_ADDR_570   0x5D
 I2C Clk Address for Si570. More...
 

Functions

void ClearScreen (void)
 This function Clears Uart terminal screen. More...
 
void RxStreamUpCallback (void *CallbackRef)
 This function is called when the RX Lock occurs, it calculates the frequency wrt RxTransMode, programs SI570 with the calculated frequency and then enables Rx stream flow IPs. More...
 
void RxStreamDownCallback (void *CallbackRef)
 This function is called when the RX loses lock, and it stops SDI Tx Subsystem. More...
 
void StartTxAfterRx (void)
 This function is called to start the TX stream after the RX stream was up and running. More...
 
int Si570_SetClock (u32 IICBaseAddress, u8 IICAddress1, u32 RxRefClk)
 Set the output frequency of the Si570 clock generator. More...
 
void Info (void)
 This function outputs the video information on TX and RX. More...
 
void DebugInfo (void)
 This function outputs the debug information. More...
 
int main (void)
 Main function to call example with SDI TX and SDI RX drivers. More...
 

Variables

XSdi_Menu SdiMenu
 Menu structure. More...
 

Macro Definition Documentation

#define I2C_CLK_ADDR   0x69

I2C Clk Address.

#define I2C_CLK_ADDR_570   0x5D

I2C Clk Address for Si570.

Referenced by main(), and RxStreamUpCallback().

#define I2C_MUX_ADDR   0x74

I2C Mux Address.

Function Documentation

void ClearScreen ( void  )

This function Clears Uart terminal screen.

Returns
None
Note
None.

< Clear Sreen

< Bring Cursor to 0,0

Referenced by main().

void DebugInfo ( void  )

This function outputs the debug information.

Returns
None.
Note
None.

References XV_SdiTxSs_ReportDebugInfo().

void Info ( void  )

This function outputs the video information on TX and RX.

Returns
None.
Note
None.

References XV_SdiTxSs_ReportInfo().

void RxStreamDownCallback ( void *  CallbackRef)

This function is called when the RX loses lock, and it stops SDI Tx Subsystem.

Parameters
CallbackRefis a callback function reference.
Returns
None.
Note
None.

References XV_SdiTxSs_Stop().

Referenced by main().

void RxStreamUpCallback ( void *  CallbackRef)

This function is called when the RX Lock occurs, it calculates the frequency wrt RxTransMode, programs SI570 with the calculated frequency and then enables Rx stream flow IPs.

Parameters
CallbackRefis a callback function reference.
Returns
None.
Note
None.

References I2C_CLK_ADDR_570, and Si570_SetClock().

Referenced by main().

int Si570_SetClock ( u32  IICBaseAddress,
u8  IICAddress1,
u32  RxRefClk 
)

Set the output frequency of the Si570 clock generator.

Parameters
IICBaseAddresscontains the base address of the IIC master device.
IICAddress1contains the 7 bit IIC address of the Si570 device.
RxRefClkcontains the value to be written in Si570 register for that particular clock frequency.
Returns
SI570_SUCCESS for success
SI570_ERR_IIC for IIC access failure,
SI570_ERR_FREQ when the requested frequency cannot be generated
SI570_ERR_PARM when the ClkSrc or ClkDest parameters are invalid or the ClkInFreq or ClkOutFreq are out of range.

References SI570_DEBUG, and Si570_DoSettings().

Referenced by main(), and RxStreamUpCallback().

void StartTxAfterRx ( void  )

This function is called to start the TX stream after the RX stream was up and running.

Returns
None.
Note
None.

References XV_SdiTxSs_GetPayloadId(), XV_SdiTxSs_GetTransport(), XV_SdiTxSs_GetVideoStream(), and XV_SdiTxSs_StreamConfig().

Referenced by main().

Variable Documentation

XSdi_Menu SdiMenu

Menu structure.