Unit GoodixTouch

Return to Unit Reference

Description

---

Goodix I2C Touchscreen Driver unit

The GOODIX I2C controllers are a range of capacitive touchscreen controllers that include multipoint touch support and are used by a variety of small LCD displays. The exact features and capability of each device can be found by checking the datasheets which can be obtained online.

This driver is compatible with the following devices:

 goodix,gt1151
 goodix,gt5663
 goodix,gt5688
 goodix,gt911
 goodix,gt9110
 goodix,gt912
 goodix,gt9147
 goodix,gt917s
 goodix,gt927
 goodix,gt9271
 goodix,gt928
 goodix,gt9286
 goodix,gt967

Constants

---

[Expand]

Goodix specific constants GOODIX_*

GOODIX_TOUCH_DESCRIPTION = 'Goodix Touch Controller';	Description of Goodix Touch device
GOODIX_MAX_HEIGHT = 4096;
GOODIX_MAX_WIDTH = 4096;
GOODIX_INT_TRIGGER = 1;
GOODIX_CONTACT_SIZE = 8;
GOODIX_MAX_CONTACT_SIZE = 9;
GOODIX_MAX_CONTACTS = 10;
GOODIX_MAX_KEYS = 7;
GOODIX_CONFIG_MIN_LENGTH = 186;
GOODIX_CONFIG_911_LENGTH = 186;
GOODIX_CONFIG_967_LENGTH = 228;
GOODIX_CONFIG_GT9X_LENGTH = 240;
GOODIX_CONFIG_MAX_LENGTH = 240;

[Expand]

Goodix I2C clock rate GOODIX_I2C_*

GOODIX_I2C_RATE = 400000;

Default I2C clock rate

[Expand]

Goodix register commands GOODIX_REG_*

GOODIX_REG_COMMAND = $8040;
GOODIX_CMD_SCREEN_OFF = $05;
GOODIX_READ_COOR_ADDR = $814E;
GOODIX_GT1X_REG_CONFIG_DATA = $8050;
GOODIX_GT9X_REG_CONFIG_DATA = $8047;
GOODIX_REG_ID = $8140;
GOODIX_BUFFER_STATUS_READY = (1 shl 7);
GOODIX_HAVE_KEY = (1 shl 4);
GOODIX_BUFFER_STATUS_TIMEOUT = 20;
GOODIX_ID_MAX_LEN = 4;
GOODIX_RESOLUTION_OFFSET = 1;
GOODIX_MAX_CONTACTS_OFFSET = 5;
GOODIX_TRIGGER_OFFSET = 6;
GOODIX_IRQ_TRIGGERS:array[0..3] of LongWord = (GPIO_TRIGGER_RISING,GPIO_TRIGGER_FALLING,GPIO_TRIGGER_LOW,GPIO_TRIGGER_HIGH);

Type definitions

---

Goodix touch

[Expand]

PGOODIXTouch = ^TGOODIXTouch;

TGOODIXTouch = record

Touch Properties
Touch:TTouchDevice;
I2C Properties
I2C:PI2CDevice;	The I2C device this device is connected to
Address:Word;	The I2C address of the device
General Properties
IRQ:TGPIOInfo;	The GPIO information for the IRQ line (Optional)
RST:TGPIOInfo;	The GPIO information for the Reset line (Optional)
Timer:TTimerHandle;	Handle for touch release timer
MaxX:Word;	Maximum X value from current configuration
MaxY:Word;	Maximum Y value from current configuration
Width:Word;	Screen width value supplied during create
Height:Word;	Screen height value supplied during create
MaxPoints:LongWord;	Maximum touch points from current configuration
LastPoints:LongWord;	Points reported in last input report
Goodix Properties
Id:String;	ID String for this device
Version:Word;	Version number for this device
ConfigAddress:Word;	Configuration data address
ConfigLength:LongWord;	Configuration data length in bytes
ChecksumSize:LongWord;	Configuration checksum size
ContactSize:LongWord;	Size of each contact point coordinate in touch data
Configuration:array[0..GOODIX_CONFIG_MAX_LENGTH - 1] of Byte;
KeyCodes:array[0..GOODIX_MAX_KEYS - 1] of Word;
ScanCodes:array[0..GOODIX_MAX_KEYS - 1] of Word;
SwapConfigXY:Boolean;	If True swap the max X and Y values in the configuration
SwapReportXY:Boolean;	If True swap the X and Y values in the input report
InvertReportX:Boolean;	If True invert the X value in the input report
InvertReportY:Boolean;	If True invert the Y value in the input report
ConfigFilename:String;	The configuration filename to load during initialization
ResetController:Boolean;	If True reset the controller during initialization

GOODIX point data

TGOODIXPointData = array[0..(2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS) - 1] of Byte;

Public variables

---

Goodix specific variables

GOODIX_SWAP_CONFIG_XY:Boolean;

GOODIX_SWAP_REPORT_XY:Boolean;

GOODIX_INVERT_REPORT_X:Boolean;

GOODIX_INVERT_REPORT_Y:Boolean;

GOODIX_LOAD_CONFIG_FILE:String;

GOODIX_RESET_CONTROLLER:Boolean;

Function declarations

---

Initialization functions

[Expand]

procedure GOODIXInit;

Description: Initialize the Goodix Touch unit and parameters

Note	Called internally by other functions

Goodix functions

[Expand]

function GOODIXTouchCreate(I2C:PI2CDevice; Address:Word; Width,Height:LongWord; IRQ,RST:PGPIOInfo):PTouchDevice;

Description: Create, register and start a new Goodix Touch device connected to the specified I2C device

I2C	The I2C device this Goodix Touch device is connected to
Address	The I2C address for this Goodix Touch device
Width	The width of the screen in pixels (When set at TOUCH_ROTATION_0)
Height	The height of the screen in pixels (When set at TOUCH_ROTATION_0)
IRQ	The GPIO information for the IRQ line (Optional)
Return	Pointer to the new Touch device or nil on failure

[Expand]

function GOODIXTouchDestroy(Touch:PTouchDevice):LongWord;

Description: Stop, deregister and destroy a Goodix Touch device created by this driver

Touch	The Touch device to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Goodix touch functions

[Expand]

function GOODIXTouchStart(Touch:PTouchDevice):LongWord;

Description: Implementation of TouchDeviceStart API for Goodix Touch device

Note	Not intended to be called directly by applications, use TouchDeviceStart instead.

[Expand]

function GOODIXTouchStop(Touch:PTouchDevice):LongWord;

Description: Implementation of TouchDeviceStop API for Goodix Touch device

Note	Not intended to be called directly by applications, use TouchDeviceStop instead.

[Expand]

function GOODIXTouchUpdate(Touch:PTouchDevice):LongWord;

Description: Implementation of TouchDeviceUpdate API for Goodix Touch device

Note	Not intended to be called directly by applications, use TouchDeviceUpdate instead.

[Expand]

procedure GOODIXTouchTimer(Touch:PGOODIXTouch);

Description: Touch device timer event handler for Goodix Touch device

Note	Not intended to be called directly by applications

[Expand]

procedure GOODIXTouchCallback(Touch:PGOODIXTouch; Pin,Trigger:LongWord);

Description: Touch device event callback (Interrupt) handler for Goodix Touch device

Note	Not intended to be called directly by applications

Return to Unit Reference