tft
Vitis Drivers API Documentation
xtft.h File Reference

Data Structures

struct  XTft_Config
 This structure holds the Device base address, video memory base address and Unique identifier of the device. More...
 
struct  XTft
 This structure is the base for whole of the operations that are to be performed on the TFT screen. More...
 

Macros

#define XTFT_ASCIICHAR_OFFSET   32
 As the first bitmap available in the Character Bitmap array is "space" whose value is 32 in the ASCII character table, this offset enables us to move to this first character in the array. More...
 
#define XTFT_DEF_FGCOLOR   0x00FFFFFF
 The default color is white for foreground and black for background. More...
 
#define XTFT_DEF_BGCOLOR   0x0
 Background Color - Black. More...
 
#define XTFT_DEF_COLVAL   0x0
 Default Column Value. More...
 
#define XTFT_DEF_ROWVAL   0x0
 Default Row Value. More...
 

Functions

XTft_ConfigXTft_LookupConfig (u16 DeviceId)
 This function obtains the Configuration pointer of the device whose ID is being passed as the parameter to the function. More...
 
int XTft_CfgInitialize (XTft *InstancePtr, XTft_Config *ConfigPtr, UINTPTR EffectiveAddr)
 This function initializes a TFT Driver Instance. More...
 
void XTft_SetPos (XTft *InstancePtr, u32 ColVal, u32 RowVal)
 This function updates the column, row position in the Instance structure of driver. More...
 
void XTft_SetPosChar (XTft *InstancePtr, u32 ColVal, u32 RowVal)
 This function changes the column, row position in the Instance structure of driver. More...
 
void XTft_SetColor (XTft *InstancePtr, u32 FgColor, u32 BgColor)
 This function changes the color values in the instance structure of driver. More...
 
void XTft_SetPixel (XTft *InstancePtr, u32 ColVal, u32 RowVal, u32 PixelVal)
 This function sets the pixel with the given color at the given column, row position. More...
 
void XTft_GetPixel (XTft *InstancePtr, u32 ColVal, u32 RowVal, u32 *PixelVal)
 This function gets the color of the pixel at the given column, row position. More...
 
void XTft_Write (XTft *InstancePtr, u8 CharValue)
 This function performs one of the following three operations based on the CharValue passed : More...
 
void XTft_Scroll (XTft *InstancePtr)
 This function inserts a new blank line at the bottom of the screen, it deletes the first line and moves the remaining lines up by one line. More...
 
void XTft_ClearScreen (XTft *InstancePtr)
 This function re-initializes all the pixels to the default background color. More...
 
void XTft_FillScreen (XTft *InstancePtr, u32 ColStartVal, u32 RowStartVal, u32 ColEndVal, u32 RowEndVal, u32 PixelVal)
 This function fills the screen with the range defined by the start and end values of column and row with the color passed as argument. More...
 
void XTft_EnableDisplay (XTft *InstancePtr)
 This function enables the TFT display by setting the Display Enable bit in the Control register. More...
 
void XTft_DisableDisplay (XTft *InstancePtr)
 This function disables the TFT display by clearing the Display Enable bit in the Control register. More...
 
void XTft_ScanReverse (XTft *InstancePtr)
 This function enables reverse scan by setting the Display Scan Control(DPS) bit in the Control register. More...
 
void XTft_ScanNormal (XTft *InstancePtr)
 This function enables normal scan by clearing the Display Scan Control(DPS) bit in the Control register. More...
 
void XTft_SetFrameBaseAddr (XTft *InstancePtr, UINTPTR NewFrameBaseAddr)
 This function changes the Video Memory Base address stored in the Address Register. More...
 
void XTft_WriteReg (XTft *InstancePtr, u32 RegOffset, u32 Data)
 Write a value to a TFT register. More...
 
u32 XTft_ReadReg (XTft *InstancePtr, u32 RegOffset)
 Read a value from a TFT register. More...
 
void XTft_IntrEnable (XTft *InstancePtr)
 This function enables the Vsync Interrupt in the Interrupt Enable and Status Register. More...
 
void XTft_IntrDisable (XTft *InstancePtr)
 This function disables the Vsync Interrupt in the Interrupt Enable and Status Register. More...
 
int XTft_GetVsyncStatus (XTft *InstancePtr)
 This function gets the Vsync(Video address latch) status from the Interrupt Enable and Status Register. More...