ugfx/drivers/ginput/touch/FT5336/ft5336.h

242 lines
8.6 KiB
C
Raw Normal View History

/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
#ifndef _FT5336_H
#define _FT5336_H
// I2C Slave address of touchscreen FocalTech FT5336
#define FT5336_I2C_SLAVE_ADDRESS 0x70
// Maximum border values of the touchscreen pad
#define FT5336_MAX_WIDTH 480 // Touchscreen pad max width
#define FT5336_MAX_HEIGHT 272 // Touchscreen pad max height
// Possible values of driver functions return status
#define FT5336_STATUS_OK 0x00
#define FT5336_STATUS_NOT_OK 0x01
// Possible values of global variable 'TS_I2C_Initialized'
#define FT5336_I2C_NOT_INITIALIZED 0x00
#define FT5336_I2C_INITIALIZED 0x01
// Max detectable simultaneous touches
#define FT5336_MAX_DETECTABLE_TOUCH 0x05
// Current mode register of the FT5336 (R)/W
#define FT5336_DEV_MODE_REG 0x00
// Possible values of FT5336_DEV_MODE_REG
#define FT5336_DEV_MODE_WORKING 0x00
#define FT5336_DEV_MODE_FACTORY 0x04
#define FT5336_DEV_MODE_MASK 0x07
#define FT5336_DEV_MODE_SHIFT 0x04
// Gesture ID register
#define FT5336_GEST_ID_REG 0x01
// Possible values of FT5336_GEST_ID_REG
#define FT5336_GEST_ID_NO_GESTURE 0x00
#define FT5336_GEST_ID_MOVE_UP 0x10
#define FT5336_GEST_ID_MOVE_RIGHT 0x14
#define FT5336_GEST_ID_MOVE_DOWN 0x18
#define FT5336_GEST_ID_MOVE_LEFT 0x1C
#define FT5336_GEST_ID_SINGLE_CLICK 0x20
#define FT5336_GEST_ID_DOUBLE_CLICK 0x22
#define FT5336_GEST_ID_ROTATE_CLOCKWISE 0x28
#define FT5336_GEST_ID_ROTATE_C_CLOCKWISE 0x29
#define FT5336_GEST_ID_ZOOM_IN 0x40
#define FT5336_GEST_ID_ZOOM_OUT 0x49
// Touch Data Status register : gives number of active touch points (0..5)
#define FT5336_TD_STAT_REG 0x02
// Values related to FT5336_TD_STAT_REG
#define FT5336_TD_STAT_MASK 0x0F
#define FT5336_TD_STAT_SHIFT 0x00
// Values Pn_XH and Pn_YH related
#define FT5336_TOUCH_EVT_FLAG_PRESS_DOWN 0x00
#define FT5336_TOUCH_EVT_FLAG_LIFT_UP 0x01
#define FT5336_TOUCH_EVT_FLAG_CONTACT 0x02
#define FT5336_TOUCH_EVT_FLAG_NO_EVENT 0x03
#define FT5336_TOUCH_EVT_FLAG_SHIFT 0x06
#define FT5336_TOUCH_EVT_FLAG_MASK (3 << FT5336_TOUCH_EVT_FLAG_SHIFT)
#define FT5336_TOUCH_POS_MSB_MASK 0x0F
#define FT5336_TOUCH_POS_MSB_SHIFT 0x00
// Values Pn_XL and Pn_YL related
#define FT5336_TOUCH_POS_LSB_MASK 0xFF
#define FT5336_TOUCH_POS_LSB_SHIFT 0x00
// Values Pn_WEIGHT related
#define FT5336_TOUCH_WEIGHT_MASK 0xFF
#define FT5336_TOUCH_WEIGHT_SHIFT 0x00
// Values related to FT5336_Pn_MISC_REG
#define FT5336_TOUCH_AREA_MASK (0x04 << 4)
#define FT5336_TOUCH_AREA_SHIFT 0x04
#define FT5336_P1_XH_REG 0x03
#define FT5336_P1_XL_REG 0x04
#define FT5336_P1_YH_REG 0x05
#define FT5336_P1_YL_REG 0x06
#define FT5336_P1_WEIGHT_REG 0x07
#define FT5336_P1_MISC_REG 0x08
#define FT5336_P2_XH_REG 0x09
#define FT5336_P2_XL_REG 0x0A
#define FT5336_P2_YH_REG 0x0B
#define FT5336_P2_YL_REG 0x0C
#define FT5336_P2_WEIGHT_REG 0x0D
#define FT5336_P2_MISC_REG 0x0E
#define FT5336_P3_XH_REG 0x0F
#define FT5336_P3_XL_REG 0x10
#define FT5336_P3_YH_REG 0x11
#define FT5336_P3_YL_REG 0x12
#define FT5336_P3_WEIGHT_REG 0x13
#define FT5336_P3_MISC_REG 0x14
#define FT5336_P4_XH_REG 0x15
#define FT5336_P4_XL_REG 0x16
#define FT5336_P4_YH_REG 0x17
#define FT5336_P4_YL_REG 0x18
#define FT5336_P4_WEIGHT_REG 0x19
#define FT5336_P4_MISC_REG 0x1A
#define FT5336_P5_XH_REG 0x1B
#define FT5336_P5_XL_REG 0x1C
#define FT5336_P5_YH_REG 0x1D
#define FT5336_P5_YL_REG 0x1E
#define FT5336_P5_WEIGHT_REG 0x1F
#define FT5336_P5_MISC_REG 0x20
#define FT5336_P6_XH_REG 0x21
#define FT5336_P6_XL_REG 0x22
#define FT5336_P6_YH_REG 0x23
#define FT5336_P6_YL_REG 0x24
#define FT5336_P6_WEIGHT_REG 0x25
#define FT5336_P6_MISC_REG 0x26
#define FT5336_P7_XH_REG 0x27
#define FT5336_P7_XL_REG 0x28
#define FT5336_P7_YH_REG 0x29
#define FT5336_P7_YL_REG 0x2A
#define FT5336_P7_WEIGHT_REG 0x2B
#define FT5336_P7_MISC_REG 0x2C
#define FT5336_P8_XH_REG 0x2D
#define FT5336_P8_XL_REG 0x2E
#define FT5336_P8_YH_REG 0x2F
#define FT5336_P8_YL_REG 0x30
#define FT5336_P8_WEIGHT_REG 0x31
#define FT5336_P8_MISC_REG 0x32
#define FT5336_P9_XH_REG 0x33
#define FT5336_P9_XL_REG 0x34
#define FT5336_P9_YH_REG 0x35
#define FT5336_P9_YL_REG 0x36
#define FT5336_P9_WEIGHT_REG 0x37
#define FT5336_P9_MISC_REG 0x38
#define FT5336_P10_XH_REG 0x39
#define FT5336_P10_XL_REG 0x3A
#define FT5336_P10_YH_REG 0x3B
#define FT5336_P10_YL_REG 0x3C
#define FT5336_P10_WEIGHT_REG 0x3D
#define FT5336_P10_MISC_REG 0x3E
// Threshold for touch detection
#define FT5336_TH_GROUP_REG 0x80
// Values FT5336_TH_GROUP_REG : threshold related
#define FT5336_THRESHOLD_MASK 0xFF
#define FT5336_THRESHOLD_SHIFT 0x00
// Filter function coefficients
#define FT5336_TH_DIFF_REG 0x85
// Control register
#define FT5336_CTRL_REG 0x86
// Values related to FT5336_CTRL_REG
// Will keep the Active mode when there is no touching
#define FT5336_CTRL_KEEP_ACTIVE_MODE 0x00
// Switching from Active mode to Monitor mode automatically when there is no touching
#define FT5336_CTRL_KEEP_AUTO_SWITCH_MONITOR_MODE 0x01
// The time period of switching from Active mode to Monitor mode when there is no touching
#define FT5336_TIMEENTERMONITOR_REG 0x87
// Report rate in Active mode
#define FT5336_PERIODACTIVE_REG 0x88
// Report rate in Monitor mode
#define FT5336_PERIODMONITOR_REG 0x89
// The value of the minimum allowed angle while Rotating gesture mode
#define FT5336_RADIAN_VALUE_REG 0x91
// Maximum offset while Moving Left and Moving Right gesture
#define FT5336_OFFSET_LEFT_RIGHT_REG 0x92
// Maximum offset while Moving Up and Moving Down gesture
#define FT5336_OFFSET_UP_DOWN_REG 0x93
// Minimum distance while Moving Left and Moving Right gesture
#define FT5336_DISTANCE_LEFT_RIGHT_REG 0x94
// Minimum distance while Moving Up and Moving Down gesture
#define FT5336_DISTANCE_UP_DOWN_REG 0x95
// Maximum distance while Zoom In and Zoom Out gesture
#define FT5336_DISTANCE_ZOOM_REG 0x96
// High 8-bit of LIB Version info
#define FT5336_LIB_VER_H_REG 0xA1
// Low 8-bit of LIB Version info
#define FT5336_LIB_VER_L_REG 0xA2
// Chip Selecting
#define FT5336_CIPHER_REG 0xA3
// Interrupt mode register (used when in interrupt mode
#define FT5336_GMODE_REG 0xA4
#define FT5336_G_MODE_INTERRUPT_MASK 0x03
#define FT5336_G_MODE_INTERRUPT_SHIFT 0x00
// Possible values of FT5336_GMODE_REG
#define FT5336_G_MODE_INTERRUPT_POLLING 0x00
#define FT5336_G_MODE_INTERRUPT_TRIGGER 0x01
// Current power mode the FT5336 system is in (R)
#define FT5336_PWR_MODE_REG 0xA5
// FT5336 firmware version
#define FT5336_FIRMID_REG 0xA6
// FT5336 Chip identification register
#define FT5336_CHIP_ID_REG 0xA8
// Possible values of FT5336_CHIP_ID_REG
#define FT5336_ID_VALUE 0x51
// Release code version
#define FT5336_RELEASE_CODE_ID_REG 0xAF
// Current operating mode the FT5336 system is in (R)
#define FT5336_STATE_REG 0xBC
#endif /* _FT5336_H */