tpg
Vitis Drivers API Documentation
xtpg_hw.h File Reference

Macros

#define XTPG_HW_H_
 Prevent circular inclusions by using protection macros. More...
 
#define XTpg_In32   Xil_In32
 Input Operation. More...
 
#define XTpg_Out32   Xil_Out32
 Output Operation. More...
 
#define XTpg_ReadReg(BaseAddress, RegOffset)   XTpg_In32((BaseAddress) + (u32)(RegOffset))
 This function macro reads the given register. More...
 
#define XTpg_WriteReg(BaseAddress, RegOffset, Data)   XTpg_Out32((BaseAddress) + (u32)(RegOffset), (Data))
 This function macro writes the given register. More...
 
TPG registers offsets
#define XTPG_CONTROL_OFFSET   0x000
 Control Offset. More...
 
#define XTPG_STATUS_OFFSET   0x004
 Status Offset. More...
 
#define XTPG_ERROR_OFFSET   0x008
 Error Offset. More...
 
#define XTPG_IRQ_EN_OFFSET   0x00C
 IRQ Enable Offset. More...
 
#define XTPG_VERSION_OFFSET   0x010
 Version Offset. More...
 
#define XTPG_ACTIVE_SIZE_OFFSET   0x020
 Active Size (V x H) Offset. More...
 
#define XTPG_PATTERN_CONTROL_OFFSET   0x100
 Pattern Control Offset. More...
 
#define XTPG_MOTION_SPEED_OFFSET   0x104
 Motion Speed Offset. More...
 
#define XTPG_CROSS_HAIRS_OFFSET   0x108
 Cross Hair Offset. More...
 
#define XTPG_ZPLATE_HOR_CONTROL_OFFSET   0x10C
 ZPlate Horizontal Control Offset. More...
 
#define XTPG_ZPLATE_VER_CONTROL_OFFSET   0x110
 ZPlate Vertical Control Offset. More...
 
#define XTPG_BOX_SIZE_OFFSET   0x114
 Box Size Offset. More...
 
#define XTPG_BOX_COLOR_OFFSET   0x118
 Box Color Offset. More...
 
#define XTPG_STUCK_PIXEL_THRESH_OFFSET   0x11C
 Stuck Pixel Threshold Offset. More...
 
#define XTPG_NOISE_GAIN_OFFSET   0x120
 Noise Gain Offset. More...
 
#define XTPG_BAYER_PHASE_OFFSET   0x124
 Bayer Phase Offset. More...
 
Control register bit masks
#define XTPG_CTL_SW_EN_MASK   0x00000001
 S/W Enable Mask. More...
 
#define XTPG_CTL_RUE_MASK   0x00000002
 Register Update Enable Mask. More...
 
#define XTPG_CTL_AUTORESET_MASK   0x40000000
 Software Reset - Auto-synchronize to SOF Mask. More...
 
#define XTPG_CTL_RESET_MASK   0x80000000
 Software Reset - Instantaneous Mask. More...
 
Interrupt register bit masks. It is applicable for

Status and IRQ_ENABLE Registers

#define XTPG_IXR_PROCS_STARTED_MASK   0x00000001
 Process started Mask. More...
 
#define XTPG_IXR_EOF_MASK   0x00000002
 End-Of-Frame Mask. More...
 
#define XTPG_IXR_SE_MASK   0x00010000
 Slave Error Mask. More...
 
#define XTPG_IXR_ALLINTR_MASK   0x00010003
 Addition of all Masks. More...
 
Error register bit mask definitions
#define XTPG_ERR_EOL_EARLY_MASK   0x00000001
 End of Line Early Mask. More...
 
#define XTPG_ERR_EOL_LATE_MASK   0x00000002
 End of Line Late Mask. More...
 
#define XTPG_ERR_SOF_EARLY_MASK   0x00000004
 Start of Frame Early Mask. More...
 
#define XTPG_ERR_SOF_LATE_MASK   0x00000008
 Start of Frame Late Mask. More...
 
Version register bit masks and shifts
#define XTPG_VER_REV_NUM_MASK   0x000000FF
 Version Revision Number Mask. More...
 
#define XTPG_VER_PID_MASK   0x00000F00
 Version Patch ID Mask. More...
 
#define XTPG_VER_REV_MASK   0x0000F000
 Version Revision Mask. More...
 
#define XTPG_VER_MINOR_MASK   0x00FF0000
 Version Minor Mask. More...
 
#define XTPG_VER_MAJOR_MASK   0xFF000000
 Version Major Mask. More...
 
#define XTPG_VER_INTERNAL_SHIFT   8
 Version Internal Shift. More...
 
#define XTPG_VER_REV_SHIFT   12
 Version Revision Shift. More...
 
#define XTPG_VER_MINOR_SHIFT   16
 Version Minor Shift. More...
 
#define XTPG_VER_MAJOR_SHIFT   24
 Version Major Shift. More...
 
Active Size register bit masks and shifts
#define XTPG_ACTSIZE_NUM_PIXEL_MASK   0x00001FFF
 Number of Active pixels per scan line (Horizontal) Mask. More...
 
#define XTPG_ACTSIZE_NUM_LINE_MASK   0x1FFF0000
 Number of Active lines per Frame (Vertical) Mask. More...
 
#define XTPG_ACTSIZE_NUM_LINE_SHIFT   16
 Shift for number of lines. More...
 
Pattern Control register bit masks
#define XTPG_PTRN_CTL_SET_BG_MASK   0x0000000F
 Set background pattern mask. More...
 
#define XTPG_PTRN_CTL_EN_CROSSHAIR_MASK   0x00000010
 Enable Cross Hair Mask. More...
 
#define XTPG_PTRN_CTL_EN_BOX_MASK   0x00000020
 Moving box enable Mask. More...
 
#define XTPG_PTRN_CTL_MASK_COLR_COMP_MASK   0x000001C0
 Mask out a particular color component mask. More...
 
#define XTPG_PTRN_CTL_EN_STUCK_MASK   0x00000200
 Enable Stuck Mask. More...
 
#define XTPG_PTRN_CTL_EN_NOISE_MASK   0x00000400
 Enable Noise Mask. More...
 
#define XTPG_PTRN_CTL_EN_MOTION_MASK   0x00001000
 Enable Motion Mask. More...
 
#define XTPG_PTRN_CTL_MASK_COLR_COMP_SHIFT   5
 Shift for a particular color component shift. More...
 
Pattern values of Pattern Control register
#define XTPG_PTRN_CTL_PASS_THROUGH   0x00000000
 Value for Pass Through. More...
 
#define XTPG_PTRN_CTL_HOR_RAMP   0x00000001
 Value for Horizontal Ramp. More...
 
#define XTPG_PTRN_CTL_VER_RAMP   0x00000002
 Value for Vertical Ramp. More...
 
#define XTPG_PTRN_CTL_TEMP_RAMP   0x00000003
 Value for Temporal Ramp. More...
 
#define XTPG_PTRN_CTL_SOLID_RED   0x00000004
 Value for Solid Red Output. More...
 
#define XTPG_PTRN_CTL_SOLID_GREEN   0x00000005
 Value for Solid Green Output. More...
 
#define XTPG_PTRN_CTL_SOLID_BLUE   0x00000006
 Value for Solid Blue Output. More...
 
#define XTPG_PTRN_CTL_SOLID_BLACK   0x00000007
 Value for Solid Black Output. More...
 
#define XTPG_PTRN_CTL_SOLID_WHITE   0x00000008
 Value for Solid White Output. More...
 
#define XTPG_PTRN_CTL_COLOR_BARS   0x00000009
 Value for Color Bars Output. More...
 
#define XTPG_PTRN_CTL_ZONE_PLATE   0x0000000A
 Value for Zone Plate. More...
 
#define XTPG_PTRN_CTL_TARTAN_BARS   0x0000000B
 Value for Tartan Bars. More...
 
#define XTPG_PTRN_CTL_CROSS_HATCH   0x0000000C
 Value for Cross Hatch. More...
 
#define XTPG_PTRN_CTL_VER_HOR_RAMP   0x0000000E
 Value for Combined Vertical and Horizontal ramp. More...
 
#define XTPG_PTRN_CTL_CHECKER_BOARD   0x0000000F
 Value for Black and White Checker Board. More...
 
#define XTPG_PTRN_CTL_MASK_RED_CR   0x00000040
 Value for Masking Red Component. More...
 
#define XTPG_PTRN_CTL_MASK_GREEN_Y   0x00000080
 Value for Masking Green Component. More...
 
#define XTPG_PTRN_CTL_MASK_BLUE_CB   0x00000100
 Value for Masking Blue Component. More...
 
Motion Speed register bit mask
#define XTPG_MOTION_SPEED_MASK   0x000000FF
 Motion Speed Mask. More...
 
Cross Hair register bit masks and shift
#define XTPG_CROSSHAIR_HPOS_MASK   0x00001FFF
 CrossHair Horizontal Position Mask. More...
 
#define XTPG_CROSSHAIR_VPOS_MASK   0x1FFF0000
 CrossHair Vertical Position Mask. More...
 
#define XTPG_CROSSHAIR_SHIFT   16
 Cross Hair Shift. More...
 
ZPlate Horizontal Control register bit masks and shift
#define XTPG_ZPLATEHOR_START_MASK   0x0000FFFF
 ZPlate Horizontal Start Mask. More...
 
#define XTPG_ZPLATEHOR_SPEED_MASK   0xFFFF0000
 ZPlate Horizontal Speed Mask. More...
 
#define XTPG_ZPLATEHOR_SPEED_SHIFT   16
 ZPlate Horizontal Speed Shift. More...
 
ZPlate Vertical Control register bit masks
#define XTPG_ZPLATEVER_START_MASK   0x0000FFFF
 ZPlate Vertical Start Mask. More...
 
#define XTPG_ZPLATEVER_SPEED_MASK   0xFFFF0000
 ZPlate Vertical Speed Mask. More...
 
#define XTPG_ZPLATEVER_SPEED_SHIFT   16
 ZPlate Vertical Speed. More...
 
Box Size register bit mask
#define XTPG_BOX_SIZE_MASK   0x00001FFF
 Box Size Mask. More...
 
TPG Box Color register bit masks
#define XTPG_BOXCOL_BLUE_MASK   0x000000FF
 Blue Color Mask. More...
 
#define XTPG_BOXCOL_GREEN_MASK   0x0000FF00
 Green Color Mask. More...
 
#define XTPG_BOXCOL_RED_MASK   0x00FF0000
 Red Color Mask. More...
 
#define XTPG_BOXCOL_GREEN_SHIFT   8
 Green color shift. More...
 
#define XTPG_BOXCOL_RED_SHIFT   16
 Red color shift. More...
 
Stuck Pixel Threshold register bit mask
#define XTPG_STUCKPIX_THRESH_MASK   0x0000FFFF
 Stuck Pixel Threshold Mask. More...
 
Noise Gain register bit mask
#define XTPG_NOISE_GAIN_MASK   0x000000FF
 Nose Gain Mask. More...
 
Bayer Phase register bit mask
#define XTPG_BAYER_PHASE_MASK   0x00000007
 Bayer Phase Mask. More...
 
General purpose masks
#define XTPG_8_BIT_MASK   0x000000FF
 8-bit Mask More...
 
Backward compatibility macros
#define TPG_CONTROL   XTPG_CONTROL_OFFSET
 
#define TPG_STATUS   XTPG_STATUS_OFFSET
 
#define TPG_ERROR   XTPG_ERROR_OFFSET
 
#define TPG_IRQ_EN   XTPG_IRQ_EN_OFFSET
 
#define TPG_VERSION   XTPG_VERSION_OFFSET
 
#define TPG_ACTIVE_SIZE   XTPG_ACTIVE_SIZE_OFFSET
 
#define TPG_PATTERN_CONTROL   XTPG_PATTERN_CONTROL_OFFSET
 
#define TPG_MOTION_SPEED   XTPG_MOTION_SPEED_OFFSET
 
#define TPG_CROSS_HAIRS   XTPG_CROSS_HAIRS_OFFSET
 
#define TPG_ZPLATE_HOR_CONTROL   XTPG_ZPLATE_HOR_CONTROL_OFFSET
 
#define TPG_ZPLATE_VER_CONTROL   XTPG_ZPLATE_VER_CONTROL_OFFSET
 
#define TPG_BOX_SIZE   XTPG_BOX_SIZE_OFFSET_OFFSET
 
#define TPG_BOX_COLOR   XTPG_BOX_COLOR_OFFSET
 
#define TPG_STUCK_PIXEL_THRESH   XTPG_STUCK_PIXEL_THRESH_OFFSET
 
#define TPG_NOISE_GAIN   XTPG_NOISE_GAIN_OFFSET
 
#define TPG_CTL_EN_MASK   XTPG_CTL_SW_EN_MASK
 
#define TPG_CTL_RUE_MASK   XTPG_CTL_RUE_MASK
 
#define TPG_RST_RESET   XTPG_CTL_RESET_MASK
 
#define TPG_RST_AUTORESET   XTPG_CTL_AUTORESET_MASK
 
#define TPG_BAYER_PHASE   XTPG_BAYER_PHASE_OFFSET
 
#define TPG_PASS_THROUGH   XTPG_PASS_THROUGH
 
#define TPG_HOR_RAMP   XTPG_HOR_RAMP
 
#define TPG_VER_RAMP   XTPG_VER_RAMP
 
#define TPG_TEMP_RAMP   XTPG_TEMP_RAMP
 
#define TPG_SOLID_RED   XTPG_SOLID_RED
 
#define TPG_SOLID_GREEN   XTPG_SOLID_GREEN
 
#define TPG_SOLID_BLUE   XTPG_SOLID_BLUE
 
#define TPG_SOILD_BLACK   XTPG_SOLID_BLACK
 
#define TPG_SOLID_WHITE   XTPG_SOLID_WHITE
 
#define TPG_COLOR_BARS   XTPG_COLOR_BARS
 
#define TPG_ZONE_PLATE   XTPG_ZONE_PLATE
 
#define TPG_TARTAN_BARS   XTPG_TARTAN_BARS
 
#define TPG_CROSS_HATCH   XTPG_CROSS_HATCH
 
#define TPG_VER_HOR_RAMP   XTPG_VER_HOR_RAMP
 
#define TPG_CHECKER_BOARD   XTPG_CHECKER_BOARD
 
#define TPG_MOVING_BOX   XTPG_PTRN_CTL_EN_BOX_MASK
 
#define TPG_MASK_RED_CR   XTPG_MASK_RED_CR
 
#define TPG_MASK_GREEN_Y   XTPG_MASK_GREEN_Y
 
#define TPG_MASK_BLUE_CB   XTPG_MASK_BLUE_CB
 
#define TPG_ENABLE_STUCK   XTPG_PTRN_CTL_EN_STUCK_MASK
 
#define TPG_ENABLE_NOISE   XTPG_PTRN_CTL_EN_NOISE_MASK
 
#define TPG_ENABLE_MOTION   XTPG_PTRN_CTL_EN_MOTION_MASK
 
#define TPG_In32   XTpg_In32
 
#define TPG_Out32   XTpg_Out32
 
#define XTPG_ReadReg   XTpg_ReadReg
 
#define XTPG_WriteReg   XTpg_WriteReg
 
Interrupt Enable and Status Registers Offsets
#define XTPG_ISR_OFFSET   XTPG_STATUS_OFFSET
 Interrupt status register generates a interrupt if the corresponding bits of interrupt enable register bits are set. More...
 
#define XTPG_IER_OFFSET   XTPG_IRQ_EN_OFFSET
 Interrupt Enable Offset. More...