1a2233cb7SHans de Goede /* SPDX-License-Identifier: GPL-2.0-only */ 2a2233cb7SHans de Goede #ifndef __GOODIX_H__ 3a2233cb7SHans de Goede #define __GOODIX_H__ 4a2233cb7SHans de Goede 5a2233cb7SHans de Goede #include <linux/gpio/consumer.h> 6a2233cb7SHans de Goede #include <linux/i2c.h> 7a2233cb7SHans de Goede #include <linux/input.h> 8a2233cb7SHans de Goede #include <linux/input/mt.h> 9a2233cb7SHans de Goede #include <linux/input/touchscreen.h> 10a2233cb7SHans de Goede #include <linux/regulator/consumer.h> 11a2233cb7SHans de Goede 12a2233cb7SHans de Goede /* Register defines */ 1309182ed2SHans de Goede #define GOODIX_REG_MISCTL_DSP_CTL 0x4010 1409182ed2SHans de Goede #define GOODIX_REG_MISCTL_SRAM_BANK 0x4048 1509182ed2SHans de Goede #define GOODIX_REG_MISCTL_MEM_CD_EN 0x4049 1609182ed2SHans de Goede #define GOODIX_REG_MISCTL_CACHE_EN 0x404B 1709182ed2SHans de Goede #define GOODIX_REG_MISCTL_TMR0_EN 0x40B0 1809182ed2SHans de Goede #define GOODIX_REG_MISCTL_SWRST 0x4180 1909182ed2SHans de Goede #define GOODIX_REG_MISCTL_CPU_SWRST_PULSE 0x4184 2009182ed2SHans de Goede #define GOODIX_REG_MISCTL_BOOTCTL 0x4190 2109182ed2SHans de Goede #define GOODIX_REG_MISCTL_BOOT_OPT 0x4218 2209182ed2SHans de Goede #define GOODIX_REG_MISCTL_BOOT_CTL 0x5094 2309182ed2SHans de Goede 2409182ed2SHans de Goede #define GOODIX_REG_FW_SIG 0x8000 2509182ed2SHans de Goede #define GOODIX_FW_SIG_LEN 10 2609182ed2SHans de Goede 2709182ed2SHans de Goede #define GOODIX_REG_MAIN_CLK 0x8020 2809182ed2SHans de Goede #define GOODIX_MAIN_CLK_LEN 6 2909182ed2SHans de Goede 30a2233cb7SHans de Goede #define GOODIX_REG_COMMAND 0x8040 31a2233cb7SHans de Goede #define GOODIX_CMD_SCREEN_OFF 0x05 32a2233cb7SHans de Goede 3309182ed2SHans de Goede #define GOODIX_REG_SW_WDT 0x8041 3409182ed2SHans de Goede 3509182ed2SHans de Goede #define GOODIX_REG_REQUEST 0x8043 3609182ed2SHans de Goede #define GOODIX_RQST_RESPONDED 0x00 3709182ed2SHans de Goede #define GOODIX_RQST_CONFIG 0x01 3809182ed2SHans de Goede #define GOODIX_RQST_BAK_REF 0x02 3909182ed2SHans de Goede #define GOODIX_RQST_RESET 0x03 4009182ed2SHans de Goede #define GOODIX_RQST_MAIN_CLOCK 0x04 4109182ed2SHans de Goede /* 4209182ed2SHans de Goede * Unknown request which gets send by the controller aprox. 4309182ed2SHans de Goede * every 34 seconds once it is up and running. 4409182ed2SHans de Goede */ 4509182ed2SHans de Goede #define GOODIX_RQST_UNKNOWN 0x06 4609182ed2SHans de Goede #define GOODIX_RQST_IDLE 0xFF 4709182ed2SHans de Goede 4809182ed2SHans de Goede #define GOODIX_REG_STATUS 0x8044 4909182ed2SHans de Goede 50a2233cb7SHans de Goede #define GOODIX_GT1X_REG_CONFIG_DATA 0x8050 51a2233cb7SHans de Goede #define GOODIX_GT9X_REG_CONFIG_DATA 0x8047 52a2233cb7SHans de Goede #define GOODIX_REG_ID 0x8140 53a2233cb7SHans de Goede #define GOODIX_READ_COOR_ADDR 0x814E 5409182ed2SHans de Goede #define GOODIX_REG_BAK_REF 0x99D0 55a2233cb7SHans de Goede 56a2233cb7SHans de Goede #define GOODIX_ID_MAX_LEN 4 57a2233cb7SHans de Goede #define GOODIX_CONFIG_MAX_LENGTH 240 58a2233cb7SHans de Goede #define GOODIX_MAX_KEYS 7 59a2233cb7SHans de Goede 60a2233cb7SHans de Goede enum goodix_irq_pin_access_method { 61a2233cb7SHans de Goede IRQ_PIN_ACCESS_NONE, 62a2233cb7SHans de Goede IRQ_PIN_ACCESS_GPIO, 63a2233cb7SHans de Goede IRQ_PIN_ACCESS_ACPI_GPIO, 64a2233cb7SHans de Goede IRQ_PIN_ACCESS_ACPI_METHOD, 65a2233cb7SHans de Goede }; 66a2233cb7SHans de Goede 67a2233cb7SHans de Goede struct goodix_ts_data; 68a2233cb7SHans de Goede 69a2233cb7SHans de Goede struct goodix_chip_data { 70a2233cb7SHans de Goede u16 config_addr; 71a2233cb7SHans de Goede int config_len; 72a2233cb7SHans de Goede int (*check_config)(struct goodix_ts_data *ts, const u8 *cfg, int len); 73a2233cb7SHans de Goede void (*calc_config_checksum)(struct goodix_ts_data *ts); 74a2233cb7SHans de Goede }; 75a2233cb7SHans de Goede 76a2233cb7SHans de Goede struct goodix_ts_data { 77a2233cb7SHans de Goede struct i2c_client *client; 78a2233cb7SHans de Goede struct input_dev *input_dev; 795ede7f0cSHans de Goede struct input_dev *input_pen; 80a2233cb7SHans de Goede const struct goodix_chip_data *chip; 8109182ed2SHans de Goede const char *firmware_name; 82a2233cb7SHans de Goede struct touchscreen_properties prop; 83a2233cb7SHans de Goede unsigned int max_touch_num; 84a2233cb7SHans de Goede unsigned int int_trigger_type; 85a2233cb7SHans de Goede struct regulator *avdd28; 86a2233cb7SHans de Goede struct regulator *vddio; 87a2233cb7SHans de Goede struct gpio_desc *gpiod_int; 88a2233cb7SHans de Goede struct gpio_desc *gpiod_rst; 89a2233cb7SHans de Goede int gpio_count; 90a2233cb7SHans de Goede int gpio_int_idx; 91a2fd46cdSHans de Goede enum gpiod_flags gpiod_rst_flags; 92a2233cb7SHans de Goede char id[GOODIX_ID_MAX_LEN + 1]; 9320e31722SHans de Goede char cfg_name[64]; 94a2233cb7SHans de Goede u16 version; 95a2233cb7SHans de Goede bool reset_controller_at_probe; 96a2233cb7SHans de Goede bool load_cfg_from_disk; 97*65de58c2SHans de Goede int pen_input_registered; 98a2233cb7SHans de Goede struct completion firmware_loading_complete; 99a2233cb7SHans de Goede unsigned long irq_flags; 100a2233cb7SHans de Goede enum goodix_irq_pin_access_method irq_pin_access_method; 101a2233cb7SHans de Goede unsigned int contact_size; 102a2233cb7SHans de Goede u8 config[GOODIX_CONFIG_MAX_LENGTH]; 103a2233cb7SHans de Goede unsigned short keymap[GOODIX_MAX_KEYS]; 10409182ed2SHans de Goede u8 main_clk[GOODIX_MAIN_CLK_LEN]; 10509182ed2SHans de Goede int bak_ref_len; 10609182ed2SHans de Goede u8 *bak_ref; 107a2233cb7SHans de Goede }; 108a2233cb7SHans de Goede 109a2233cb7SHans de Goede int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len); 110a2233cb7SHans de Goede int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len); 111a2233cb7SHans de Goede int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value); 112a2233cb7SHans de Goede int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len); 113a2233cb7SHans de Goede int goodix_int_sync(struct goodix_ts_data *ts); 114209bda47SHans de Goede int goodix_reset_no_int_sync(struct goodix_ts_data *ts); 115a2233cb7SHans de Goede 11609182ed2SHans de Goede int goodix_firmware_check(struct goodix_ts_data *ts); 11709182ed2SHans de Goede bool goodix_handle_fw_request(struct goodix_ts_data *ts); 11809182ed2SHans de Goede void goodix_save_bak_ref(struct goodix_ts_data *ts); 11909182ed2SHans de Goede 120a2233cb7SHans de Goede #endif 121