v_sditx: xv_sditx_hw.h File Reference

| v_sditx Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Macros
xv_sditx_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 TX core.

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

      MODIFICATION HISTORY:

#

      Ver   Who    Date     Changes

      1.0   jsr    07/17/17 Initial release.

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

## Macros
#define | XV_SDITX_HW_H_
| Prevent circular inclusions by using protection macros. More...
Register access macro definition
#define | XV_SdiTx_In32 Xil_In32
| Input Operations. More...
#define | XV_SdiTx_Out32 Xil_Out32
| Output Operations. More...
#define | XV_SdiTx_ReadReg(BaseAddress, RegOffset) XV_SdiTx_In32((BaseAddress) + (RegOffset))
| This macro reads a value from a SDI TX register. More...
#define | XV_SdiTx_WriteReg(BaseAddress, RegOffset, Data) XV_SdiTx_Out32((BaseAddress) + (RegOffset), (u32)(Data))
| This macro writes a value to a SDI TX register. More...

## Macro Definition Documentation

#define XV_SDITX_HW_H_

Prevent circular inclusions by using protection macros.

#define XV_SdiTx_In32 Xil_In32

Input Operations.

#define XV_SdiTx_Out32 Xil_Out32

Output Operations.

#define XV_SdiTx_ReadReg | ( |  | BaseAddress,
|  |  | RegOffset
| ) |  | XV_SdiTx_In32((BaseAddress) + (RegOffset))

This macro reads a value from a SDI TX 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

  BaseAddress | is the base address of the SDI TX core instance.
  RegOffset | is 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_SdiTx_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XV_SdiTx_Axi4sBridgeVtcDisable(), XV_SdiTx_Axi4sBridgeVtcEnable(), XV_SdiTx_ClearDetectedError(), XV_SdiTx_ClearYCbCr444_RGB_10bit(), XV_SdiTx_DebugInfo(), XV_SdiTx_GetIntrEnable(), XV_SdiTx_GetIntrStatus(), XV_SdiTx_InterruptClear(), XV_SdiTx_IntrEnable(), XV_SdiTx_IntrHandler(), XV_SdiTx_ReportDetectedError(), XV_SdiTx_SelfTest(), XV_SdiTx_SetColorFormat(), XV_SdiTx_SetCoreSettings(), XV_SdiTx_SetPayloadLineNum(), XV_SdiTx_SetVidBridgeMode(), XV_SdiTx_SetYCbCr444_RGB_10bit(), XV_SdiTx_ST352CStreamEnable(), XV_SdiTx_ST352CSwitch3GA(), XV_SdiTx_StartSdi(), XV_SdiTx_StopSdi(), XV_SdiTx_StreamStart(), XV_SdiTx_VidBridgeDisable(), and XV_SdiTx_VidBridgeEnable().

#define XV_SdiTx_WriteReg | ( |  | BaseAddress,
|  |  | RegOffset,
|  |  | Data
| ) |  | XV_SdiTx_Out32((BaseAddress) + (RegOffset), (u32)(Data))

This macro writes a value to a SDI TX register.

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

Parameters

  BaseAddress | is the base address of the SDI TX core instance.
  RegOffset | is the register offset of the register (defined at the top of this file) to be written.
  Data | is the 32-bit value to write into the register.

Returns
  None.

Note
  C-style signature: void XV_SdiTx_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XV_SdiTx_Axi4sBridgeVtcDisable(), XV_SdiTx_Axi4sBridgeVtcEnable(), XV_SdiTx_ClearDetectedError(), XV_SdiTx_ClearYCbCr444_RGB_10bit(), XV_SdiTx_InterruptClear(), XV_SdiTx_IntrDisable(), XV_SdiTx_IntrEnable(), XV_SdiTx_SetColorFormat(), XV_SdiTx_SetCoreSettings(), XV_SdiTx_SetPayloadId(), XV_SdiTx_SetPayloadLineNum(), XV_SdiTx_SetVidBridgeMode(), XV_SdiTx_SetYCbCr444_RGB_10bit(), XV_SdiTx_ST352CStreamEnable(), XV_SdiTx_ST352CSwitch3GA(), XV_SdiTx_StartSdi(), XV_SdiTx_StopSdi(), XV_SdiTx_VidBridgeDisable(), and XV_SdiTx_VidBridgeEnable().