v_sdirx
Xilinx SDK Drivers API Documentation
xv_sdirx_hw.h File Reference

Overview

This header file contains identifiers and register-level core functions (or macros) that can be used to access the Xilinx SDI RX core.

For more information about the operation of this core see the hardware specification and documentation in the higher level driver xv_sdirx.h file.

  MODIFICATION HISTORY:
  Ver   Who    Date     Changes


1.0 jsr 07/17/17 Initial release.

vve 10/03/18 Add support for ST352 in C-Stream

  

Macros

#define XV_SDIRX_HW_H_
 Prevent circular inclusions by using protection macros. More...
 
#define XV_SDIRX_SHIFT_16   16
 16 shift value More...
 
#define XV_SDIRX_MASK_16   0xFFFF
 16 bit mask value More...
 
Register access macro definition
#define XV_SdiRx_In32   Xil_In32
 Input Operations. More...
 
#define XV_SdiRx_Out32   Xil_Out32
 Output Operations. More...
 
#define XV_SdiRx_ReadReg(BaseAddress, RegOffset)   XV_SdiRx_In32((BaseAddress) + (RegOffset))
 This macro reads a value from a SDI RX register. More...
 
#define XV_SdiRx_WriteReg(BaseAddress, RegOffset, Data)   XV_SdiRx_Out32((BaseAddress) + (RegOffset), (u32)(Data))
 This macro writes a value to a SDI RX register. More...
 

Macro Definition Documentation

#define XV_SDIRX_HW_H_

Prevent circular inclusions by using protection macros.

#define XV_SdiRx_In32   Xil_In32

Input Operations.

#define XV_SDIRX_MASK_16   0xFFFF

16 bit mask value

#define XV_SdiRx_Out32   Xil_Out32

Output Operations.

#define XV_SdiRx_ReadReg (   BaseAddress,
  RegOffset 
)    XV_SdiRx_In32((BaseAddress) + (RegOffset))

This macro reads a value from a SDI RX register.

A 32 bit read is performed. If the component is implemented in a smaller width, only the least significant data is read from the register. The most significant data will be read as 0.

Parameters
BaseAddressis the base address of the SDI RX core instance.
RegOffsetis the register offset of the register (defined at the top of this file).
Returns
The 32-bit value of the register.
Note
C-style signature: u32 XV_SdiRx_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XV_SdiRx_Axi4sBridgeDisable(), XV_SdiRx_Axi4sBridgeEnable(), XV_SdiRx_ClearYCbCr444_RGB_10bit(), XV_SdiRx_DebugInfo(), XV_SdiRx_FramerDisable(), XV_SdiRx_FramerEnable(), XV_SdiRx_GetIntrEnable(), XV_SdiRx_GetIntrStatus(), XV_SdiRx_GetPayloadId(), XV_SdiRx_GetSdiMode(), XV_SdiRx_InterruptClear(), XV_SdiRx_IntrEnable(), XV_SdiRx_ReportDetectedError(), XV_SdiRx_SelfTest(), XV_SdiRx_SetYCbCr444_RGB_10bit(), XV_SdiRx_Start(), XV_SdiRx_Stop(), XV_SdiRx_VidBridgeDisable(), XV_SdiRx_VidBridgeEnable(), and XV_SdiRx_WaitforPayLoad().

#define XV_SDIRX_SHIFT_16   16

16 shift value

#define XV_SdiRx_WriteReg (   BaseAddress,
  RegOffset,
  Data 
)    XV_SdiRx_Out32((BaseAddress) + (RegOffset), (u32)(Data))

This macro writes a value to a SDI RX register.

A 32 bit write is performed. If the component is implemented in a smaller width, only the least significant data is written.

Parameters
BaseAddressis the base address of the SDI RX core instance.
RegOffsetis the register offset of the register (defined at the top of this file) to be written.
Datais the 32-bit value to write into the register.
Returns
None.
Note
C-style signature: void XV_SdiRx_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XV_SdiRx_Axi4sBridgeDisable(), XV_SdiRx_Axi4sBridgeEnable(), XV_SdiRx_CfgInitialize(), XV_SdiRx_ClearYCbCr444_RGB_10bit(), XV_SdiRx_FramerDisable(), XV_SdiRx_FramerEnable(), XV_SdiRx_InterruptClear(), XV_SdiRx_IntrDisable(), XV_SdiRx_IntrEnable(), XV_SdiRx_SetEdhErrCntTrigger(), XV_SdiRx_SetVidLckWindow(), XV_SdiRx_SetYCbCr444_RGB_10bit(), XV_SdiRx_Start(), XV_SdiRx_Stop(), XV_SdiRx_VidBridgeDisable(), and XV_SdiRx_VidBridgeEnable().