1ca96ea86SBastien Nocera /* 2ca96ea86SBastien Nocera * Driver for Goodix Touchscreens 3ca96ea86SBastien Nocera * 4ca96ea86SBastien Nocera * Copyright (c) 2014 Red Hat Inc. 5ad48cf5eSKarsten Merker * Copyright (c) 2015 K. Merker <merker@debian.org> 6ca96ea86SBastien Nocera * 7ca96ea86SBastien Nocera * This code is based on gt9xx.c authored by andrew@goodix.com: 8ca96ea86SBastien Nocera * 9ca96ea86SBastien Nocera * 2010 - 2012 Goodix Technology. 10ca96ea86SBastien Nocera */ 11ca96ea86SBastien Nocera 12ca96ea86SBastien Nocera /* 13ca96ea86SBastien Nocera * This program is free software; you can redistribute it and/or modify it 14ca96ea86SBastien Nocera * under the terms of the GNU General Public License as published by the Free 15ca96ea86SBastien Nocera * Software Foundation; version 2 of the License. 16ca96ea86SBastien Nocera */ 17ca96ea86SBastien Nocera 18ca96ea86SBastien Nocera #include <linux/kernel.h> 198b5a359cSBastien Nocera #include <linux/dmi.h> 2068caf858SIrina Tirdea #include <linux/firmware.h> 21ec6e1b40SIrina Tirdea #include <linux/gpio/consumer.h> 22ca96ea86SBastien Nocera #include <linux/i2c.h> 23ca96ea86SBastien Nocera #include <linux/input.h> 24ca96ea86SBastien Nocera #include <linux/input/mt.h> 25fafef982SMarcin Niestroj #include <linux/input/touchscreen.h> 26ca96ea86SBastien Nocera #include <linux/module.h> 27ca96ea86SBastien Nocera #include <linux/delay.h> 28ca96ea86SBastien Nocera #include <linux/irq.h> 29ca96ea86SBastien Nocera #include <linux/interrupt.h> 30ca96ea86SBastien Nocera #include <linux/slab.h> 31771d8f1bSAleksei Mamlin #include <linux/acpi.h> 32771d8f1bSAleksei Mamlin #include <linux/of.h> 33ca96ea86SBastien Nocera #include <asm/unaligned.h> 34ca96ea86SBastien Nocera 3525309004SMarcin Niestroj struct goodix_ts_data; 3625309004SMarcin Niestroj 3725309004SMarcin Niestroj struct goodix_chip_data { 3825309004SMarcin Niestroj u16 config_addr; 3925309004SMarcin Niestroj int config_len; 4025309004SMarcin Niestroj int (*check_config)(struct goodix_ts_data *, const struct firmware *); 4125309004SMarcin Niestroj }; 4225309004SMarcin Niestroj 43ca96ea86SBastien Nocera struct goodix_ts_data { 44ca96ea86SBastien Nocera struct i2c_client *client; 45ca96ea86SBastien Nocera struct input_dev *input_dev; 4625309004SMarcin Niestroj const struct goodix_chip_data *chip; 47fafef982SMarcin Niestroj struct touchscreen_properties prop; 48ca96ea86SBastien Nocera unsigned int max_touch_num; 49ca96ea86SBastien Nocera unsigned int int_trigger_type; 50ec6e1b40SIrina Tirdea struct gpio_desc *gpiod_int; 51ec6e1b40SIrina Tirdea struct gpio_desc *gpiod_rst; 5268caf858SIrina Tirdea u16 id; 5368caf858SIrina Tirdea u16 version; 5468caf858SIrina Tirdea const char *cfg_name; 5568caf858SIrina Tirdea struct completion firmware_loading_complete; 565ab09d6aSIrina Tirdea unsigned long irq_flags; 57ca96ea86SBastien Nocera }; 58ca96ea86SBastien Nocera 59ec6e1b40SIrina Tirdea #define GOODIX_GPIO_INT_NAME "irq" 60ec6e1b40SIrina Tirdea #define GOODIX_GPIO_RST_NAME "reset" 61ec6e1b40SIrina Tirdea 62ca96ea86SBastien Nocera #define GOODIX_MAX_HEIGHT 4096 63ca96ea86SBastien Nocera #define GOODIX_MAX_WIDTH 4096 64ca96ea86SBastien Nocera #define GOODIX_INT_TRIGGER 1 65ca96ea86SBastien Nocera #define GOODIX_CONTACT_SIZE 8 66ca96ea86SBastien Nocera #define GOODIX_MAX_CONTACTS 10 67ca96ea86SBastien Nocera 68ca96ea86SBastien Nocera #define GOODIX_CONFIG_MAX_LENGTH 240 69a779fbc6SIrina Tirdea #define GOODIX_CONFIG_911_LENGTH 186 70a779fbc6SIrina Tirdea #define GOODIX_CONFIG_967_LENGTH 228 71ca96ea86SBastien Nocera 72ca96ea86SBastien Nocera /* Register defines */ 735ab09d6aSIrina Tirdea #define GOODIX_REG_COMMAND 0x8040 745ab09d6aSIrina Tirdea #define GOODIX_CMD_SCREEN_OFF 0x05 755ab09d6aSIrina Tirdea 76ca96ea86SBastien Nocera #define GOODIX_READ_COOR_ADDR 0x814E 7725309004SMarcin Niestroj #define GOODIX_GT1X_REG_CONFIG_DATA 0x8050 7825309004SMarcin Niestroj #define GOODIX_GT9X_REG_CONFIG_DATA 0x8047 79e70b0307SIrina Tirdea #define GOODIX_REG_ID 0x8140 80ca96ea86SBastien Nocera 819b5db7aaSPaul Cercueil #define GOODIX_BUFFER_STATUS_READY BIT(7) 829b5db7aaSPaul Cercueil #define GOODIX_BUFFER_STATUS_TIMEOUT 20 839b5db7aaSPaul Cercueil 84ca96ea86SBastien Nocera #define RESOLUTION_LOC 1 85a7ac7c95SAleksei Mamlin #define MAX_CONTACTS_LOC 5 86ca96ea86SBastien Nocera #define TRIGGER_LOC 6 87ca96ea86SBastien Nocera 8825309004SMarcin Niestroj static int goodix_check_cfg_8(struct goodix_ts_data *ts, 8925309004SMarcin Niestroj const struct firmware *cfg); 9025309004SMarcin Niestroj static int goodix_check_cfg_16(struct goodix_ts_data *ts, 9125309004SMarcin Niestroj const struct firmware *cfg); 9225309004SMarcin Niestroj 9325309004SMarcin Niestroj static const struct goodix_chip_data gt1x_chip_data = { 9425309004SMarcin Niestroj .config_addr = GOODIX_GT1X_REG_CONFIG_DATA, 9525309004SMarcin Niestroj .config_len = GOODIX_CONFIG_MAX_LENGTH, 9625309004SMarcin Niestroj .check_config = goodix_check_cfg_16, 9725309004SMarcin Niestroj }; 9825309004SMarcin Niestroj 9925309004SMarcin Niestroj static const struct goodix_chip_data gt911_chip_data = { 10025309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 10125309004SMarcin Niestroj .config_len = GOODIX_CONFIG_911_LENGTH, 10225309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 10325309004SMarcin Niestroj }; 10425309004SMarcin Niestroj 10525309004SMarcin Niestroj static const struct goodix_chip_data gt967_chip_data = { 10625309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 10725309004SMarcin Niestroj .config_len = GOODIX_CONFIG_967_LENGTH, 10825309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 10925309004SMarcin Niestroj }; 11025309004SMarcin Niestroj 11125309004SMarcin Niestroj static const struct goodix_chip_data gt9x_chip_data = { 11225309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 11325309004SMarcin Niestroj .config_len = GOODIX_CONFIG_MAX_LENGTH, 11425309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 11525309004SMarcin Niestroj }; 11625309004SMarcin Niestroj 117ca96ea86SBastien Nocera static const unsigned long goodix_irq_flags[] = { 118ca96ea86SBastien Nocera IRQ_TYPE_EDGE_RISING, 119ca96ea86SBastien Nocera IRQ_TYPE_EDGE_FALLING, 120ca96ea86SBastien Nocera IRQ_TYPE_LEVEL_LOW, 121ca96ea86SBastien Nocera IRQ_TYPE_LEVEL_HIGH, 122ca96ea86SBastien Nocera }; 123ca96ea86SBastien Nocera 1248b5a359cSBastien Nocera /* 1258b5a359cSBastien Nocera * Those tablets have their coordinates origin at the bottom right 1268b5a359cSBastien Nocera * of the tablet, as if rotated 180 degrees 1278b5a359cSBastien Nocera */ 1288b5a359cSBastien Nocera static const struct dmi_system_id rotated_screen[] = { 1298b5a359cSBastien Nocera #if defined(CONFIG_DMI) && defined(CONFIG_X86) 1308b5a359cSBastien Nocera { 1318b5a359cSBastien Nocera .ident = "WinBook TW100", 1328b5a359cSBastien Nocera .matches = { 1338b5a359cSBastien Nocera DMI_MATCH(DMI_SYS_VENDOR, "WinBook"), 1348b5a359cSBastien Nocera DMI_MATCH(DMI_PRODUCT_NAME, "TW100") 1358b5a359cSBastien Nocera } 1368b5a359cSBastien Nocera }, 1378b5a359cSBastien Nocera { 1388b5a359cSBastien Nocera .ident = "WinBook TW700", 1398b5a359cSBastien Nocera .matches = { 1408b5a359cSBastien Nocera DMI_MATCH(DMI_SYS_VENDOR, "WinBook"), 1418b5a359cSBastien Nocera DMI_MATCH(DMI_PRODUCT_NAME, "TW700") 1428b5a359cSBastien Nocera }, 1438b5a359cSBastien Nocera }, 1448b5a359cSBastien Nocera #endif 1458b5a359cSBastien Nocera {} 1468b5a359cSBastien Nocera }; 1478b5a359cSBastien Nocera 148ca96ea86SBastien Nocera /** 149ca96ea86SBastien Nocera * goodix_i2c_read - read data from a register of the i2c slave device. 150ca96ea86SBastien Nocera * 151ca96ea86SBastien Nocera * @client: i2c device. 152ca96ea86SBastien Nocera * @reg: the register to read from. 153ca96ea86SBastien Nocera * @buf: raw write data buffer. 154ca96ea86SBastien Nocera * @len: length of the buffer to write 155ca96ea86SBastien Nocera */ 156ca96ea86SBastien Nocera static int goodix_i2c_read(struct i2c_client *client, 157ca96ea86SBastien Nocera u16 reg, u8 *buf, int len) 158ca96ea86SBastien Nocera { 159ca96ea86SBastien Nocera struct i2c_msg msgs[2]; 160fafef982SMarcin Niestroj __be16 wbuf = cpu_to_be16(reg); 161ca96ea86SBastien Nocera int ret; 162ca96ea86SBastien Nocera 163ca96ea86SBastien Nocera msgs[0].flags = 0; 164ca96ea86SBastien Nocera msgs[0].addr = client->addr; 165ca96ea86SBastien Nocera msgs[0].len = 2; 166ca96ea86SBastien Nocera msgs[0].buf = (u8 *)&wbuf; 167ca96ea86SBastien Nocera 168ca96ea86SBastien Nocera msgs[1].flags = I2C_M_RD; 169ca96ea86SBastien Nocera msgs[1].addr = client->addr; 170ca96ea86SBastien Nocera msgs[1].len = len; 171ca96ea86SBastien Nocera msgs[1].buf = buf; 172ca96ea86SBastien Nocera 173ca96ea86SBastien Nocera ret = i2c_transfer(client->adapter, msgs, 2); 174ca96ea86SBastien Nocera return ret < 0 ? ret : (ret != ARRAY_SIZE(msgs) ? -EIO : 0); 175ca96ea86SBastien Nocera } 176ca96ea86SBastien Nocera 17768caf858SIrina Tirdea /** 17868caf858SIrina Tirdea * goodix_i2c_write - write data to a register of the i2c slave device. 17968caf858SIrina Tirdea * 18068caf858SIrina Tirdea * @client: i2c device. 18168caf858SIrina Tirdea * @reg: the register to write to. 18268caf858SIrina Tirdea * @buf: raw data buffer to write. 18368caf858SIrina Tirdea * @len: length of the buffer to write 18468caf858SIrina Tirdea */ 18568caf858SIrina Tirdea static int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, 18668caf858SIrina Tirdea unsigned len) 18768caf858SIrina Tirdea { 18868caf858SIrina Tirdea u8 *addr_buf; 18968caf858SIrina Tirdea struct i2c_msg msg; 19068caf858SIrina Tirdea int ret; 19168caf858SIrina Tirdea 19268caf858SIrina Tirdea addr_buf = kmalloc(len + 2, GFP_KERNEL); 19368caf858SIrina Tirdea if (!addr_buf) 19468caf858SIrina Tirdea return -ENOMEM; 19568caf858SIrina Tirdea 19668caf858SIrina Tirdea addr_buf[0] = reg >> 8; 19768caf858SIrina Tirdea addr_buf[1] = reg & 0xFF; 19868caf858SIrina Tirdea memcpy(&addr_buf[2], buf, len); 19968caf858SIrina Tirdea 20068caf858SIrina Tirdea msg.flags = 0; 20168caf858SIrina Tirdea msg.addr = client->addr; 20268caf858SIrina Tirdea msg.buf = addr_buf; 20368caf858SIrina Tirdea msg.len = len + 2; 20468caf858SIrina Tirdea 20568caf858SIrina Tirdea ret = i2c_transfer(client->adapter, &msg, 1); 20668caf858SIrina Tirdea kfree(addr_buf); 20768caf858SIrina Tirdea return ret < 0 ? ret : (ret != 1 ? -EIO : 0); 20868caf858SIrina Tirdea } 20968caf858SIrina Tirdea 2105ab09d6aSIrina Tirdea static int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value) 2115ab09d6aSIrina Tirdea { 2125ab09d6aSIrina Tirdea return goodix_i2c_write(client, reg, &value, sizeof(value)); 2135ab09d6aSIrina Tirdea } 2145ab09d6aSIrina Tirdea 21525309004SMarcin Niestroj static const struct goodix_chip_data *goodix_get_chip_data(u16 id) 216a779fbc6SIrina Tirdea { 217a779fbc6SIrina Tirdea switch (id) { 21825309004SMarcin Niestroj case 1151: 21984ef1b33SGuido Günther case 5688: 22025309004SMarcin Niestroj return >1x_chip_data; 22125309004SMarcin Niestroj 222a779fbc6SIrina Tirdea case 911: 223a779fbc6SIrina Tirdea case 9271: 224a779fbc6SIrina Tirdea case 9110: 225a779fbc6SIrina Tirdea case 927: 226a779fbc6SIrina Tirdea case 928: 22725309004SMarcin Niestroj return >911_chip_data; 228a779fbc6SIrina Tirdea 229a779fbc6SIrina Tirdea case 912: 230a779fbc6SIrina Tirdea case 967: 23125309004SMarcin Niestroj return >967_chip_data; 232a779fbc6SIrina Tirdea 233a779fbc6SIrina Tirdea default: 23425309004SMarcin Niestroj return >9x_chip_data; 235a779fbc6SIrina Tirdea } 236a779fbc6SIrina Tirdea } 237a779fbc6SIrina Tirdea 238ca96ea86SBastien Nocera static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data) 239ca96ea86SBastien Nocera { 2409b5db7aaSPaul Cercueil unsigned long max_timeout; 241ca96ea86SBastien Nocera int touch_num; 242ca96ea86SBastien Nocera int error; 243ca96ea86SBastien Nocera 2449b5db7aaSPaul Cercueil /* 2459b5db7aaSPaul Cercueil * The 'buffer status' bit, which indicates that the data is valid, is 2469b5db7aaSPaul Cercueil * not set as soon as the interrupt is raised, but slightly after. 2479b5db7aaSPaul Cercueil * This takes around 10 ms to happen, so we poll for 20 ms. 2489b5db7aaSPaul Cercueil */ 2499b5db7aaSPaul Cercueil max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT); 2509b5db7aaSPaul Cercueil do { 2519b5db7aaSPaul Cercueil error = goodix_i2c_read(ts->client, GOODIX_READ_COOR_ADDR, 2529b5db7aaSPaul Cercueil data, GOODIX_CONTACT_SIZE + 1); 253ca96ea86SBastien Nocera if (error) { 2549b5db7aaSPaul Cercueil dev_err(&ts->client->dev, "I2C transfer error: %d\n", 2559b5db7aaSPaul Cercueil error); 256ca96ea86SBastien Nocera return error; 257ca96ea86SBastien Nocera } 258ca96ea86SBastien Nocera 2599b5db7aaSPaul Cercueil if (data[0] & GOODIX_BUFFER_STATUS_READY) { 260ca96ea86SBastien Nocera touch_num = data[0] & 0x0f; 261a7ac7c95SAleksei Mamlin if (touch_num > ts->max_touch_num) 262ca96ea86SBastien Nocera return -EPROTO; 263ca96ea86SBastien Nocera 264ca96ea86SBastien Nocera if (touch_num > 1) { 265ca96ea86SBastien Nocera data += 1 + GOODIX_CONTACT_SIZE; 266ca96ea86SBastien Nocera error = goodix_i2c_read(ts->client, 267ca96ea86SBastien Nocera GOODIX_READ_COOR_ADDR + 268ca96ea86SBastien Nocera 1 + GOODIX_CONTACT_SIZE, 269ca96ea86SBastien Nocera data, 2709b5db7aaSPaul Cercueil GOODIX_CONTACT_SIZE * 2719b5db7aaSPaul Cercueil (touch_num - 1)); 272ca96ea86SBastien Nocera if (error) 273ca96ea86SBastien Nocera return error; 274ca96ea86SBastien Nocera } 275ca96ea86SBastien Nocera 276ca96ea86SBastien Nocera return touch_num; 277ca96ea86SBastien Nocera } 278ca96ea86SBastien Nocera 2799b5db7aaSPaul Cercueil usleep_range(1000, 2000); /* Poll every 1 - 2 ms */ 2809b5db7aaSPaul Cercueil } while (time_before(jiffies, max_timeout)); 2819b5db7aaSPaul Cercueil 2829b5db7aaSPaul Cercueil /* 2839b5db7aaSPaul Cercueil * The Goodix panel will send spurious interrupts after a 2849b5db7aaSPaul Cercueil * 'finger up' event, which will always cause a timeout. 2859b5db7aaSPaul Cercueil */ 2869b5db7aaSPaul Cercueil return 0; 2879b5db7aaSPaul Cercueil } 2889b5db7aaSPaul Cercueil 289ca96ea86SBastien Nocera static void goodix_ts_report_touch(struct goodix_ts_data *ts, u8 *coor_data) 290ca96ea86SBastien Nocera { 291ca96ea86SBastien Nocera int id = coor_data[0] & 0x0F; 292ca96ea86SBastien Nocera int input_x = get_unaligned_le16(&coor_data[1]); 293ca96ea86SBastien Nocera int input_y = get_unaligned_le16(&coor_data[3]); 294ca96ea86SBastien Nocera int input_w = get_unaligned_le16(&coor_data[5]); 295ca96ea86SBastien Nocera 296ca96ea86SBastien Nocera input_mt_slot(ts->input_dev, id); 297ca96ea86SBastien Nocera input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true); 298fafef982SMarcin Niestroj touchscreen_report_pos(ts->input_dev, &ts->prop, 299fafef982SMarcin Niestroj input_x, input_y, true); 300ca96ea86SBastien Nocera input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w); 301ca96ea86SBastien Nocera input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w); 302ca96ea86SBastien Nocera } 303ca96ea86SBastien Nocera 304ca96ea86SBastien Nocera /** 305ca96ea86SBastien Nocera * goodix_process_events - Process incoming events 306ca96ea86SBastien Nocera * 307ca96ea86SBastien Nocera * @ts: our goodix_ts_data pointer 308ca96ea86SBastien Nocera * 309ca96ea86SBastien Nocera * Called when the IRQ is triggered. Read the current device state, and push 310ca96ea86SBastien Nocera * the input events to the user space. 311ca96ea86SBastien Nocera */ 312ca96ea86SBastien Nocera static void goodix_process_events(struct goodix_ts_data *ts) 313ca96ea86SBastien Nocera { 3140e0432f0SIrina Tirdea u8 point_data[1 + GOODIX_CONTACT_SIZE * GOODIX_MAX_CONTACTS]; 315ca96ea86SBastien Nocera int touch_num; 316ca96ea86SBastien Nocera int i; 317ca96ea86SBastien Nocera 318ca96ea86SBastien Nocera touch_num = goodix_ts_read_input_report(ts, point_data); 319ca96ea86SBastien Nocera if (touch_num < 0) 320ca96ea86SBastien Nocera return; 321ca96ea86SBastien Nocera 3224a54feeaSSergei A. Trusov /* 3234a54feeaSSergei A. Trusov * Bit 4 of the first byte reports the status of the capacitive 3244a54feeaSSergei A. Trusov * Windows/Home button. 3254a54feeaSSergei A. Trusov */ 3264a54feeaSSergei A. Trusov input_report_key(ts->input_dev, KEY_LEFTMETA, point_data[0] & BIT(4)); 3274a54feeaSSergei A. Trusov 328ca96ea86SBastien Nocera for (i = 0; i < touch_num; i++) 329ca96ea86SBastien Nocera goodix_ts_report_touch(ts, 330ca96ea86SBastien Nocera &point_data[1 + GOODIX_CONTACT_SIZE * i]); 331ca96ea86SBastien Nocera 332ca96ea86SBastien Nocera input_mt_sync_frame(ts->input_dev); 333ca96ea86SBastien Nocera input_sync(ts->input_dev); 334ca96ea86SBastien Nocera } 335ca96ea86SBastien Nocera 336ca96ea86SBastien Nocera /** 337ca96ea86SBastien Nocera * goodix_ts_irq_handler - The IRQ handler 338ca96ea86SBastien Nocera * 339ca96ea86SBastien Nocera * @irq: interrupt number. 340ca96ea86SBastien Nocera * @dev_id: private data pointer. 341ca96ea86SBastien Nocera */ 342ca96ea86SBastien Nocera static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id) 343ca96ea86SBastien Nocera { 344ca96ea86SBastien Nocera struct goodix_ts_data *ts = dev_id; 345ca96ea86SBastien Nocera 346ca96ea86SBastien Nocera goodix_process_events(ts); 347ca96ea86SBastien Nocera 3485d655b35SIrina Tirdea if (goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0) < 0) 349ca96ea86SBastien Nocera dev_err(&ts->client->dev, "I2C write end_cmd error\n"); 350ca96ea86SBastien Nocera 351ca96ea86SBastien Nocera return IRQ_HANDLED; 352ca96ea86SBastien Nocera } 353ca96ea86SBastien Nocera 3545ab09d6aSIrina Tirdea static void goodix_free_irq(struct goodix_ts_data *ts) 3555ab09d6aSIrina Tirdea { 3565ab09d6aSIrina Tirdea devm_free_irq(&ts->client->dev, ts->client->irq, ts); 3575ab09d6aSIrina Tirdea } 3585ab09d6aSIrina Tirdea 3595ab09d6aSIrina Tirdea static int goodix_request_irq(struct goodix_ts_data *ts) 3605ab09d6aSIrina Tirdea { 3615ab09d6aSIrina Tirdea return devm_request_threaded_irq(&ts->client->dev, ts->client->irq, 3625ab09d6aSIrina Tirdea NULL, goodix_ts_irq_handler, 3635ab09d6aSIrina Tirdea ts->irq_flags, ts->client->name, ts); 3645ab09d6aSIrina Tirdea } 3655ab09d6aSIrina Tirdea 36625309004SMarcin Niestroj static int goodix_check_cfg_8(struct goodix_ts_data *ts, 36768caf858SIrina Tirdea const struct firmware *cfg) 36868caf858SIrina Tirdea { 36925309004SMarcin Niestroj int i, raw_cfg_len = cfg->size - 2; 37068caf858SIrina Tirdea u8 check_sum = 0; 37168caf858SIrina Tirdea 37268caf858SIrina Tirdea for (i = 0; i < raw_cfg_len; i++) 37368caf858SIrina Tirdea check_sum += cfg->data[i]; 37468caf858SIrina Tirdea check_sum = (~check_sum) + 1; 37568caf858SIrina Tirdea if (check_sum != cfg->data[raw_cfg_len]) { 37668caf858SIrina Tirdea dev_err(&ts->client->dev, 37768caf858SIrina Tirdea "The checksum of the config fw is not correct"); 37868caf858SIrina Tirdea return -EINVAL; 37968caf858SIrina Tirdea } 38068caf858SIrina Tirdea 38168caf858SIrina Tirdea if (cfg->data[raw_cfg_len + 1] != 1) { 38268caf858SIrina Tirdea dev_err(&ts->client->dev, 38368caf858SIrina Tirdea "Config fw must have Config_Fresh register set"); 38468caf858SIrina Tirdea return -EINVAL; 38568caf858SIrina Tirdea } 38668caf858SIrina Tirdea 38768caf858SIrina Tirdea return 0; 38868caf858SIrina Tirdea } 38968caf858SIrina Tirdea 39025309004SMarcin Niestroj static int goodix_check_cfg_16(struct goodix_ts_data *ts, 39125309004SMarcin Niestroj const struct firmware *cfg) 39225309004SMarcin Niestroj { 39325309004SMarcin Niestroj int i, raw_cfg_len = cfg->size - 3; 39425309004SMarcin Niestroj u16 check_sum = 0; 39525309004SMarcin Niestroj 39625309004SMarcin Niestroj for (i = 0; i < raw_cfg_len; i += 2) 39725309004SMarcin Niestroj check_sum += get_unaligned_be16(&cfg->data[i]); 39825309004SMarcin Niestroj check_sum = (~check_sum) + 1; 39925309004SMarcin Niestroj if (check_sum != get_unaligned_be16(&cfg->data[raw_cfg_len])) { 40025309004SMarcin Niestroj dev_err(&ts->client->dev, 40125309004SMarcin Niestroj "The checksum of the config fw is not correct"); 40225309004SMarcin Niestroj return -EINVAL; 40325309004SMarcin Niestroj } 40425309004SMarcin Niestroj 40525309004SMarcin Niestroj if (cfg->data[raw_cfg_len + 2] != 1) { 40625309004SMarcin Niestroj dev_err(&ts->client->dev, 40725309004SMarcin Niestroj "Config fw must have Config_Fresh register set"); 40825309004SMarcin Niestroj return -EINVAL; 40925309004SMarcin Niestroj } 41025309004SMarcin Niestroj 41125309004SMarcin Niestroj return 0; 41225309004SMarcin Niestroj } 41325309004SMarcin Niestroj 41425309004SMarcin Niestroj /** 41525309004SMarcin Niestroj * goodix_check_cfg - Checks if config fw is valid 41625309004SMarcin Niestroj * 41725309004SMarcin Niestroj * @ts: goodix_ts_data pointer 41825309004SMarcin Niestroj * @cfg: firmware config data 41925309004SMarcin Niestroj */ 42025309004SMarcin Niestroj static int goodix_check_cfg(struct goodix_ts_data *ts, 42125309004SMarcin Niestroj const struct firmware *cfg) 42225309004SMarcin Niestroj { 42325309004SMarcin Niestroj if (cfg->size > GOODIX_CONFIG_MAX_LENGTH) { 42425309004SMarcin Niestroj dev_err(&ts->client->dev, 42525309004SMarcin Niestroj "The length of the config fw is not correct"); 42625309004SMarcin Niestroj return -EINVAL; 42725309004SMarcin Niestroj } 42825309004SMarcin Niestroj 42925309004SMarcin Niestroj return ts->chip->check_config(ts, cfg); 43025309004SMarcin Niestroj } 43125309004SMarcin Niestroj 43268caf858SIrina Tirdea /** 43368caf858SIrina Tirdea * goodix_send_cfg - Write fw config to device 43468caf858SIrina Tirdea * 43568caf858SIrina Tirdea * @ts: goodix_ts_data pointer 43668caf858SIrina Tirdea * @cfg: config firmware to write to device 43768caf858SIrina Tirdea */ 43868caf858SIrina Tirdea static int goodix_send_cfg(struct goodix_ts_data *ts, 43968caf858SIrina Tirdea const struct firmware *cfg) 44068caf858SIrina Tirdea { 44168caf858SIrina Tirdea int error; 44268caf858SIrina Tirdea 44368caf858SIrina Tirdea error = goodix_check_cfg(ts, cfg); 44468caf858SIrina Tirdea if (error) 44568caf858SIrina Tirdea return error; 44668caf858SIrina Tirdea 44725309004SMarcin Niestroj error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg->data, 44868caf858SIrina Tirdea cfg->size); 44968caf858SIrina Tirdea if (error) { 45068caf858SIrina Tirdea dev_err(&ts->client->dev, "Failed to write config data: %d", 45168caf858SIrina Tirdea error); 45268caf858SIrina Tirdea return error; 45368caf858SIrina Tirdea } 45468caf858SIrina Tirdea dev_dbg(&ts->client->dev, "Config sent successfully."); 45568caf858SIrina Tirdea 45668caf858SIrina Tirdea /* Let the firmware reconfigure itself, so sleep for 10ms */ 45768caf858SIrina Tirdea usleep_range(10000, 11000); 45868caf858SIrina Tirdea 45968caf858SIrina Tirdea return 0; 46068caf858SIrina Tirdea } 46168caf858SIrina Tirdea 462ec6e1b40SIrina Tirdea static int goodix_int_sync(struct goodix_ts_data *ts) 463ec6e1b40SIrina Tirdea { 464ec6e1b40SIrina Tirdea int error; 465ec6e1b40SIrina Tirdea 466ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 0); 467ec6e1b40SIrina Tirdea if (error) 468ec6e1b40SIrina Tirdea return error; 469ec6e1b40SIrina Tirdea 470ec6e1b40SIrina Tirdea msleep(50); /* T5: 50ms */ 471ec6e1b40SIrina Tirdea 472ec6e1b40SIrina Tirdea error = gpiod_direction_input(ts->gpiod_int); 473ec6e1b40SIrina Tirdea if (error) 474ec6e1b40SIrina Tirdea return error; 475ec6e1b40SIrina Tirdea 476ec6e1b40SIrina Tirdea return 0; 477ec6e1b40SIrina Tirdea } 478ec6e1b40SIrina Tirdea 479ec6e1b40SIrina Tirdea /** 480ec6e1b40SIrina Tirdea * goodix_reset - Reset device during power on 481ec6e1b40SIrina Tirdea * 482ec6e1b40SIrina Tirdea * @ts: goodix_ts_data pointer 483ec6e1b40SIrina Tirdea */ 484ec6e1b40SIrina Tirdea static int goodix_reset(struct goodix_ts_data *ts) 485ec6e1b40SIrina Tirdea { 486ec6e1b40SIrina Tirdea int error; 487ec6e1b40SIrina Tirdea 488ec6e1b40SIrina Tirdea /* begin select I2C slave addr */ 489ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_rst, 0); 490ec6e1b40SIrina Tirdea if (error) 491ec6e1b40SIrina Tirdea return error; 492ec6e1b40SIrina Tirdea 493ec6e1b40SIrina Tirdea msleep(20); /* T2: > 10ms */ 494ec6e1b40SIrina Tirdea 495ec6e1b40SIrina Tirdea /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */ 496ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, ts->client->addr == 0x14); 497ec6e1b40SIrina Tirdea if (error) 498ec6e1b40SIrina Tirdea return error; 499ec6e1b40SIrina Tirdea 500ec6e1b40SIrina Tirdea usleep_range(100, 2000); /* T3: > 100us */ 501ec6e1b40SIrina Tirdea 502ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_rst, 1); 503ec6e1b40SIrina Tirdea if (error) 504ec6e1b40SIrina Tirdea return error; 505ec6e1b40SIrina Tirdea 506ec6e1b40SIrina Tirdea usleep_range(6000, 10000); /* T4: > 5ms */ 507ec6e1b40SIrina Tirdea 508ec6e1b40SIrina Tirdea /* end select I2C slave addr */ 509ec6e1b40SIrina Tirdea error = gpiod_direction_input(ts->gpiod_rst); 510ec6e1b40SIrina Tirdea if (error) 511ec6e1b40SIrina Tirdea return error; 512ec6e1b40SIrina Tirdea 513ec6e1b40SIrina Tirdea error = goodix_int_sync(ts); 514ec6e1b40SIrina Tirdea if (error) 515ec6e1b40SIrina Tirdea return error; 516ec6e1b40SIrina Tirdea 517ec6e1b40SIrina Tirdea return 0; 518ec6e1b40SIrina Tirdea } 519ec6e1b40SIrina Tirdea 520ec6e1b40SIrina Tirdea /** 521ec6e1b40SIrina Tirdea * goodix_get_gpio_config - Get GPIO config from ACPI/DT 522ec6e1b40SIrina Tirdea * 523ec6e1b40SIrina Tirdea * @ts: goodix_ts_data pointer 524ec6e1b40SIrina Tirdea */ 525ec6e1b40SIrina Tirdea static int goodix_get_gpio_config(struct goodix_ts_data *ts) 526ec6e1b40SIrina Tirdea { 527ec6e1b40SIrina Tirdea int error; 528ec6e1b40SIrina Tirdea struct device *dev; 529ec6e1b40SIrina Tirdea struct gpio_desc *gpiod; 530ec6e1b40SIrina Tirdea 531ec6e1b40SIrina Tirdea if (!ts->client) 532ec6e1b40SIrina Tirdea return -EINVAL; 533ec6e1b40SIrina Tirdea dev = &ts->client->dev; 534ec6e1b40SIrina Tirdea 535ec6e1b40SIrina Tirdea /* Get the interrupt GPIO pin number */ 536ec6e1b40SIrina Tirdea gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN); 537ec6e1b40SIrina Tirdea if (IS_ERR(gpiod)) { 538ec6e1b40SIrina Tirdea error = PTR_ERR(gpiod); 539ec6e1b40SIrina Tirdea if (error != -EPROBE_DEFER) 540ec6e1b40SIrina Tirdea dev_dbg(dev, "Failed to get %s GPIO: %d\n", 541ec6e1b40SIrina Tirdea GOODIX_GPIO_INT_NAME, error); 542ec6e1b40SIrina Tirdea return error; 543ec6e1b40SIrina Tirdea } 544ec6e1b40SIrina Tirdea 545ec6e1b40SIrina Tirdea ts->gpiod_int = gpiod; 546ec6e1b40SIrina Tirdea 547ec6e1b40SIrina Tirdea /* Get the reset line GPIO pin number */ 548ec6e1b40SIrina Tirdea gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, GPIOD_IN); 549ec6e1b40SIrina Tirdea if (IS_ERR(gpiod)) { 550ec6e1b40SIrina Tirdea error = PTR_ERR(gpiod); 551ec6e1b40SIrina Tirdea if (error != -EPROBE_DEFER) 552ec6e1b40SIrina Tirdea dev_dbg(dev, "Failed to get %s GPIO: %d\n", 553ec6e1b40SIrina Tirdea GOODIX_GPIO_RST_NAME, error); 554ec6e1b40SIrina Tirdea return error; 555ec6e1b40SIrina Tirdea } 556ec6e1b40SIrina Tirdea 557ec6e1b40SIrina Tirdea ts->gpiod_rst = gpiod; 558ec6e1b40SIrina Tirdea 559ec6e1b40SIrina Tirdea return 0; 560ec6e1b40SIrina Tirdea } 561ec6e1b40SIrina Tirdea 562ca96ea86SBastien Nocera /** 563ca96ea86SBastien Nocera * goodix_read_config - Read the embedded configuration of the panel 564ca96ea86SBastien Nocera * 565ca96ea86SBastien Nocera * @ts: our goodix_ts_data pointer 566ca96ea86SBastien Nocera * 567ca96ea86SBastien Nocera * Must be called during probe 568ca96ea86SBastien Nocera */ 569ca96ea86SBastien Nocera static void goodix_read_config(struct goodix_ts_data *ts) 570ca96ea86SBastien Nocera { 571ca96ea86SBastien Nocera u8 config[GOODIX_CONFIG_MAX_LENGTH]; 572fafef982SMarcin Niestroj int x_max, y_max; 573ca96ea86SBastien Nocera int error; 574ca96ea86SBastien Nocera 57525309004SMarcin Niestroj error = goodix_i2c_read(ts->client, ts->chip->config_addr, 57625309004SMarcin Niestroj config, ts->chip->config_len); 577ca96ea86SBastien Nocera if (error) { 578fafef982SMarcin Niestroj dev_warn(&ts->client->dev, "Error reading config: %d\n", 579ca96ea86SBastien Nocera error); 580ca96ea86SBastien Nocera ts->int_trigger_type = GOODIX_INT_TRIGGER; 581a7ac7c95SAleksei Mamlin ts->max_touch_num = GOODIX_MAX_CONTACTS; 582ca96ea86SBastien Nocera return; 583ca96ea86SBastien Nocera } 584ca96ea86SBastien Nocera 585a7ac7c95SAleksei Mamlin ts->int_trigger_type = config[TRIGGER_LOC] & 0x03; 586a7ac7c95SAleksei Mamlin ts->max_touch_num = config[MAX_CONTACTS_LOC] & 0x0f; 5878b5a359cSBastien Nocera 588fafef982SMarcin Niestroj x_max = get_unaligned_le16(&config[RESOLUTION_LOC]); 589fafef982SMarcin Niestroj y_max = get_unaligned_le16(&config[RESOLUTION_LOC + 2]); 590fafef982SMarcin Niestroj if (x_max && y_max) { 591fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1); 592fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1); 593ca96ea86SBastien Nocera } 59457c80e8eSKarsten Merker } 595ca96ea86SBastien Nocera 596ca96ea86SBastien Nocera /** 597ca96ea86SBastien Nocera * goodix_read_version - Read goodix touchscreen version 598ca96ea86SBastien Nocera * 59968caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 600ca96ea86SBastien Nocera */ 60168caf858SIrina Tirdea static int goodix_read_version(struct goodix_ts_data *ts) 602ca96ea86SBastien Nocera { 603ca96ea86SBastien Nocera int error; 604ca96ea86SBastien Nocera u8 buf[6]; 605e70b0307SIrina Tirdea char id_str[5]; 606ca96ea86SBastien Nocera 60768caf858SIrina Tirdea error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf)); 608ca96ea86SBastien Nocera if (error) { 60968caf858SIrina Tirdea dev_err(&ts->client->dev, "read version failed: %d\n", error); 610ca96ea86SBastien Nocera return error; 611ca96ea86SBastien Nocera } 612ca96ea86SBastien Nocera 613e70b0307SIrina Tirdea memcpy(id_str, buf, 4); 614e70b0307SIrina Tirdea id_str[4] = 0; 61568caf858SIrina Tirdea if (kstrtou16(id_str, 10, &ts->id)) 61668caf858SIrina Tirdea ts->id = 0x1001; 617e70b0307SIrina Tirdea 61868caf858SIrina Tirdea ts->version = get_unaligned_le16(&buf[4]); 619ca96ea86SBastien Nocera 62068caf858SIrina Tirdea dev_info(&ts->client->dev, "ID %d, version: %04x\n", ts->id, 62168caf858SIrina Tirdea ts->version); 622ca96ea86SBastien Nocera 623ca96ea86SBastien Nocera return 0; 624ca96ea86SBastien Nocera } 625ca96ea86SBastien Nocera 626ca96ea86SBastien Nocera /** 627ca96ea86SBastien Nocera * goodix_i2c_test - I2C test function to check if the device answers. 628ca96ea86SBastien Nocera * 629ca96ea86SBastien Nocera * @client: the i2c client 630ca96ea86SBastien Nocera */ 631ca96ea86SBastien Nocera static int goodix_i2c_test(struct i2c_client *client) 632ca96ea86SBastien Nocera { 633ca96ea86SBastien Nocera int retry = 0; 634ca96ea86SBastien Nocera int error; 635ca96ea86SBastien Nocera u8 test; 636ca96ea86SBastien Nocera 637ca96ea86SBastien Nocera while (retry++ < 2) { 63825309004SMarcin Niestroj error = goodix_i2c_read(client, GOODIX_REG_ID, 639ca96ea86SBastien Nocera &test, 1); 640ca96ea86SBastien Nocera if (!error) 641ca96ea86SBastien Nocera return 0; 642ca96ea86SBastien Nocera 643ca96ea86SBastien Nocera dev_err(&client->dev, "i2c test failed attempt %d: %d\n", 644ca96ea86SBastien Nocera retry, error); 645ca96ea86SBastien Nocera msleep(20); 646ca96ea86SBastien Nocera } 647ca96ea86SBastien Nocera 648ca96ea86SBastien Nocera return error; 649ca96ea86SBastien Nocera } 650ca96ea86SBastien Nocera 651ca96ea86SBastien Nocera /** 65268caf858SIrina Tirdea * goodix_configure_dev - Finish device initialization 65368caf858SIrina Tirdea * 65468caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 65568caf858SIrina Tirdea * 65668caf858SIrina Tirdea * Must be called from probe to finish initialization of the device. 65768caf858SIrina Tirdea * Contains the common initialization code for both devices that 65868caf858SIrina Tirdea * declare gpio pins and devices that do not. It is either called 65968caf858SIrina Tirdea * directly from probe or from request_firmware_wait callback. 66068caf858SIrina Tirdea */ 66168caf858SIrina Tirdea static int goodix_configure_dev(struct goodix_ts_data *ts) 66268caf858SIrina Tirdea { 66368caf858SIrina Tirdea int error; 66468caf858SIrina Tirdea 665fafef982SMarcin Niestroj ts->int_trigger_type = GOODIX_INT_TRIGGER; 666fafef982SMarcin Niestroj ts->max_touch_num = GOODIX_MAX_CONTACTS; 667ad48cf5eSKarsten Merker 668fafef982SMarcin Niestroj ts->input_dev = devm_input_allocate_device(&ts->client->dev); 669fafef982SMarcin Niestroj if (!ts->input_dev) { 670fafef982SMarcin Niestroj dev_err(&ts->client->dev, "Failed to allocate input device."); 671fafef982SMarcin Niestroj return -ENOMEM; 672fafef982SMarcin Niestroj } 673fafef982SMarcin Niestroj 674fafef982SMarcin Niestroj ts->input_dev->name = "Goodix Capacitive TouchScreen"; 675fafef982SMarcin Niestroj ts->input_dev->phys = "input/ts"; 676fafef982SMarcin Niestroj ts->input_dev->id.bustype = BUS_I2C; 677fafef982SMarcin Niestroj ts->input_dev->id.vendor = 0x0416; 678fafef982SMarcin Niestroj ts->input_dev->id.product = ts->id; 679fafef982SMarcin Niestroj ts->input_dev->id.version = ts->version; 680fafef982SMarcin Niestroj 681fafef982SMarcin Niestroj /* Capacitive Windows/Home button on some devices */ 682fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_KEY, KEY_LEFTMETA); 683fafef982SMarcin Niestroj 684fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X); 685fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y); 686fafef982SMarcin Niestroj input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0); 687fafef982SMarcin Niestroj input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0); 688fafef982SMarcin Niestroj 689fafef982SMarcin Niestroj /* Read configuration and apply touchscreen parameters */ 69068caf858SIrina Tirdea goodix_read_config(ts); 69168caf858SIrina Tirdea 692fafef982SMarcin Niestroj /* Try overriding touchscreen parameters via device properties */ 693fafef982SMarcin Niestroj touchscreen_parse_properties(ts->input_dev, true, &ts->prop); 694fafef982SMarcin Niestroj 695fafef982SMarcin Niestroj if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) { 696fafef982SMarcin Niestroj dev_err(&ts->client->dev, "Invalid config, using defaults\n"); 697fafef982SMarcin Niestroj ts->prop.max_x = GOODIX_MAX_WIDTH - 1; 698fafef982SMarcin Niestroj ts->prop.max_y = GOODIX_MAX_HEIGHT - 1; 699fafef982SMarcin Niestroj ts->max_touch_num = GOODIX_MAX_CONTACTS; 700fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, 701fafef982SMarcin Niestroj ABS_MT_POSITION_X, ts->prop.max_x); 702fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, 703fafef982SMarcin Niestroj ABS_MT_POSITION_Y, ts->prop.max_y); 704fafef982SMarcin Niestroj } 705fafef982SMarcin Niestroj 706fafef982SMarcin Niestroj if (dmi_check_system(rotated_screen)) { 707fafef982SMarcin Niestroj ts->prop.invert_x = true; 708fafef982SMarcin Niestroj ts->prop.invert_y = true; 709fafef982SMarcin Niestroj dev_dbg(&ts->client->dev, 710fafef982SMarcin Niestroj "Applying '180 degrees rotated screen' quirk\n"); 711fafef982SMarcin Niestroj } 712fafef982SMarcin Niestroj 713fafef982SMarcin Niestroj error = input_mt_init_slots(ts->input_dev, ts->max_touch_num, 714fafef982SMarcin Niestroj INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED); 715fafef982SMarcin Niestroj if (error) { 716fafef982SMarcin Niestroj dev_err(&ts->client->dev, 717fafef982SMarcin Niestroj "Failed to initialize MT slots: %d", error); 71868caf858SIrina Tirdea return error; 719fafef982SMarcin Niestroj } 720fafef982SMarcin Niestroj 721fafef982SMarcin Niestroj error = input_register_device(ts->input_dev); 722fafef982SMarcin Niestroj if (error) { 723fafef982SMarcin Niestroj dev_err(&ts->client->dev, 724fafef982SMarcin Niestroj "Failed to register input device: %d", error); 725fafef982SMarcin Niestroj return error; 726fafef982SMarcin Niestroj } 72768caf858SIrina Tirdea 7285ab09d6aSIrina Tirdea ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT; 7295ab09d6aSIrina Tirdea error = goodix_request_irq(ts); 73068caf858SIrina Tirdea if (error) { 73168caf858SIrina Tirdea dev_err(&ts->client->dev, "request IRQ failed: %d\n", error); 73268caf858SIrina Tirdea return error; 73368caf858SIrina Tirdea } 73468caf858SIrina Tirdea 73568caf858SIrina Tirdea return 0; 73668caf858SIrina Tirdea } 73768caf858SIrina Tirdea 73868caf858SIrina Tirdea /** 73968caf858SIrina Tirdea * goodix_config_cb - Callback to finish device init 74068caf858SIrina Tirdea * 74168caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 74268caf858SIrina Tirdea * 74368caf858SIrina Tirdea * request_firmware_wait callback that finishes 74468caf858SIrina Tirdea * initialization of the device. 74568caf858SIrina Tirdea */ 74668caf858SIrina Tirdea static void goodix_config_cb(const struct firmware *cfg, void *ctx) 74768caf858SIrina Tirdea { 74868caf858SIrina Tirdea struct goodix_ts_data *ts = ctx; 74968caf858SIrina Tirdea int error; 75068caf858SIrina Tirdea 75168caf858SIrina Tirdea if (cfg) { 75268caf858SIrina Tirdea /* send device configuration to the firmware */ 75368caf858SIrina Tirdea error = goodix_send_cfg(ts, cfg); 75468caf858SIrina Tirdea if (error) 75568caf858SIrina Tirdea goto err_release_cfg; 75668caf858SIrina Tirdea } 75768caf858SIrina Tirdea 75868caf858SIrina Tirdea goodix_configure_dev(ts); 75968caf858SIrina Tirdea 76068caf858SIrina Tirdea err_release_cfg: 76168caf858SIrina Tirdea release_firmware(cfg); 76268caf858SIrina Tirdea complete_all(&ts->firmware_loading_complete); 76368caf858SIrina Tirdea } 76468caf858SIrina Tirdea 765ca96ea86SBastien Nocera static int goodix_ts_probe(struct i2c_client *client, 766ca96ea86SBastien Nocera const struct i2c_device_id *id) 767ca96ea86SBastien Nocera { 768ca96ea86SBastien Nocera struct goodix_ts_data *ts; 769ca96ea86SBastien Nocera int error; 770ca96ea86SBastien Nocera 771ca96ea86SBastien Nocera dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr); 772ca96ea86SBastien Nocera 773ca96ea86SBastien Nocera if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 774ca96ea86SBastien Nocera dev_err(&client->dev, "I2C check functionality failed.\n"); 775ca96ea86SBastien Nocera return -ENXIO; 776ca96ea86SBastien Nocera } 777ca96ea86SBastien Nocera 778ca96ea86SBastien Nocera ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL); 779ca96ea86SBastien Nocera if (!ts) 780ca96ea86SBastien Nocera return -ENOMEM; 781ca96ea86SBastien Nocera 782ca96ea86SBastien Nocera ts->client = client; 783ca96ea86SBastien Nocera i2c_set_clientdata(client, ts); 78468caf858SIrina Tirdea init_completion(&ts->firmware_loading_complete); 785ca96ea86SBastien Nocera 786ec6e1b40SIrina Tirdea error = goodix_get_gpio_config(ts); 787ec6e1b40SIrina Tirdea if (error) 788ec6e1b40SIrina Tirdea return error; 789ec6e1b40SIrina Tirdea 790ec6e1b40SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) { 791ec6e1b40SIrina Tirdea /* reset the controller */ 792ec6e1b40SIrina Tirdea error = goodix_reset(ts); 793ec6e1b40SIrina Tirdea if (error) { 794ec6e1b40SIrina Tirdea dev_err(&client->dev, "Controller reset failed.\n"); 795ec6e1b40SIrina Tirdea return error; 796ec6e1b40SIrina Tirdea } 797ec6e1b40SIrina Tirdea } 798ec6e1b40SIrina Tirdea 799ca96ea86SBastien Nocera error = goodix_i2c_test(client); 800ca96ea86SBastien Nocera if (error) { 801ca96ea86SBastien Nocera dev_err(&client->dev, "I2C communication failure: %d\n", error); 802ca96ea86SBastien Nocera return error; 803ca96ea86SBastien Nocera } 804ca96ea86SBastien Nocera 80568caf858SIrina Tirdea error = goodix_read_version(ts); 806ca96ea86SBastien Nocera if (error) { 807ca96ea86SBastien Nocera dev_err(&client->dev, "Read version failed.\n"); 808ca96ea86SBastien Nocera return error; 809ca96ea86SBastien Nocera } 810ca96ea86SBastien Nocera 81125309004SMarcin Niestroj ts->chip = goodix_get_chip_data(ts->id); 812a779fbc6SIrina Tirdea 81368caf858SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) { 81468caf858SIrina Tirdea /* update device config */ 81568caf858SIrina Tirdea ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL, 81668caf858SIrina Tirdea "goodix_%d_cfg.bin", ts->id); 81768caf858SIrina Tirdea if (!ts->cfg_name) 81868caf858SIrina Tirdea return -ENOMEM; 819ca96ea86SBastien Nocera 82068caf858SIrina Tirdea error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name, 82168caf858SIrina Tirdea &client->dev, GFP_KERNEL, ts, 82268caf858SIrina Tirdea goodix_config_cb); 823ca96ea86SBastien Nocera if (error) { 82468caf858SIrina Tirdea dev_err(&client->dev, 82568caf858SIrina Tirdea "Failed to invoke firmware loader: %d\n", 82668caf858SIrina Tirdea error); 827ca96ea86SBastien Nocera return error; 828ca96ea86SBastien Nocera } 829ca96ea86SBastien Nocera 830ca96ea86SBastien Nocera return 0; 83168caf858SIrina Tirdea } else { 83268caf858SIrina Tirdea error = goodix_configure_dev(ts); 83368caf858SIrina Tirdea if (error) 83468caf858SIrina Tirdea return error; 83568caf858SIrina Tirdea } 83668caf858SIrina Tirdea 83768caf858SIrina Tirdea return 0; 83868caf858SIrina Tirdea } 83968caf858SIrina Tirdea 84068caf858SIrina Tirdea static int goodix_ts_remove(struct i2c_client *client) 84168caf858SIrina Tirdea { 84268caf858SIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 84368caf858SIrina Tirdea 84468caf858SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) 84568caf858SIrina Tirdea wait_for_completion(&ts->firmware_loading_complete); 84668caf858SIrina Tirdea 84768caf858SIrina Tirdea return 0; 848ca96ea86SBastien Nocera } 849ca96ea86SBastien Nocera 8505ab09d6aSIrina Tirdea static int __maybe_unused goodix_suspend(struct device *dev) 8515ab09d6aSIrina Tirdea { 8525ab09d6aSIrina Tirdea struct i2c_client *client = to_i2c_client(dev); 8535ab09d6aSIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 8545ab09d6aSIrina Tirdea int error; 8555ab09d6aSIrina Tirdea 8565ab09d6aSIrina Tirdea /* We need gpio pins to suspend/resume */ 857faec44b6SHans de Goede if (!ts->gpiod_int || !ts->gpiod_rst) { 858faec44b6SHans de Goede disable_irq(client->irq); 8595ab09d6aSIrina Tirdea return 0; 860faec44b6SHans de Goede } 8615ab09d6aSIrina Tirdea 8625ab09d6aSIrina Tirdea wait_for_completion(&ts->firmware_loading_complete); 8635ab09d6aSIrina Tirdea 8645ab09d6aSIrina Tirdea /* Free IRQ as IRQ pin is used as output in the suspend sequence */ 8655ab09d6aSIrina Tirdea goodix_free_irq(ts); 8665ab09d6aSIrina Tirdea 8675ab09d6aSIrina Tirdea /* Output LOW on the INT pin for 5 ms */ 8685ab09d6aSIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 0); 8695ab09d6aSIrina Tirdea if (error) { 8705ab09d6aSIrina Tirdea goodix_request_irq(ts); 8715ab09d6aSIrina Tirdea return error; 8725ab09d6aSIrina Tirdea } 8735ab09d6aSIrina Tirdea 8745ab09d6aSIrina Tirdea usleep_range(5000, 6000); 8755ab09d6aSIrina Tirdea 8765ab09d6aSIrina Tirdea error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND, 8775ab09d6aSIrina Tirdea GOODIX_CMD_SCREEN_OFF); 8785ab09d6aSIrina Tirdea if (error) { 8795ab09d6aSIrina Tirdea dev_err(&ts->client->dev, "Screen off command failed\n"); 8805ab09d6aSIrina Tirdea gpiod_direction_input(ts->gpiod_int); 8815ab09d6aSIrina Tirdea goodix_request_irq(ts); 8825ab09d6aSIrina Tirdea return -EAGAIN; 8835ab09d6aSIrina Tirdea } 8845ab09d6aSIrina Tirdea 8855ab09d6aSIrina Tirdea /* 8865ab09d6aSIrina Tirdea * The datasheet specifies that the interval between sending screen-off 8875ab09d6aSIrina Tirdea * command and wake-up should be longer than 58 ms. To avoid waking up 8885ab09d6aSIrina Tirdea * sooner, delay 58ms here. 8895ab09d6aSIrina Tirdea */ 8905ab09d6aSIrina Tirdea msleep(58); 8915ab09d6aSIrina Tirdea return 0; 8925ab09d6aSIrina Tirdea } 8935ab09d6aSIrina Tirdea 8945ab09d6aSIrina Tirdea static int __maybe_unused goodix_resume(struct device *dev) 8955ab09d6aSIrina Tirdea { 8965ab09d6aSIrina Tirdea struct i2c_client *client = to_i2c_client(dev); 8975ab09d6aSIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 8985ab09d6aSIrina Tirdea int error; 8995ab09d6aSIrina Tirdea 900faec44b6SHans de Goede if (!ts->gpiod_int || !ts->gpiod_rst) { 901faec44b6SHans de Goede enable_irq(client->irq); 9025ab09d6aSIrina Tirdea return 0; 903faec44b6SHans de Goede } 9045ab09d6aSIrina Tirdea 9055ab09d6aSIrina Tirdea /* 9065ab09d6aSIrina Tirdea * Exit sleep mode by outputting HIGH level to INT pin 9075ab09d6aSIrina Tirdea * for 2ms~5ms. 9085ab09d6aSIrina Tirdea */ 9095ab09d6aSIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 1); 9105ab09d6aSIrina Tirdea if (error) 9115ab09d6aSIrina Tirdea return error; 9125ab09d6aSIrina Tirdea 9135ab09d6aSIrina Tirdea usleep_range(2000, 5000); 9145ab09d6aSIrina Tirdea 9155ab09d6aSIrina Tirdea error = goodix_int_sync(ts); 9165ab09d6aSIrina Tirdea if (error) 9175ab09d6aSIrina Tirdea return error; 9185ab09d6aSIrina Tirdea 9195ab09d6aSIrina Tirdea error = goodix_request_irq(ts); 9205ab09d6aSIrina Tirdea if (error) 9215ab09d6aSIrina Tirdea return error; 9225ab09d6aSIrina Tirdea 9235ab09d6aSIrina Tirdea return 0; 9245ab09d6aSIrina Tirdea } 9255ab09d6aSIrina Tirdea 9265ab09d6aSIrina Tirdea static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume); 9275ab09d6aSIrina Tirdea 928ca96ea86SBastien Nocera static const struct i2c_device_id goodix_ts_id[] = { 929ca96ea86SBastien Nocera { "GDIX1001:00", 0 }, 930ca96ea86SBastien Nocera { } 931ca96ea86SBastien Nocera }; 9322e9e910eSJavier Martinez Canillas MODULE_DEVICE_TABLE(i2c, goodix_ts_id); 933ca96ea86SBastien Nocera 934771d8f1bSAleksei Mamlin #ifdef CONFIG_ACPI 935ca96ea86SBastien Nocera static const struct acpi_device_id goodix_acpi_match[] = { 936ca96ea86SBastien Nocera { "GDIX1001", 0 }, 9375ca4d1aeSEthan Lee { "GDIX1002", 0 }, 938ca96ea86SBastien Nocera { } 939ca96ea86SBastien Nocera }; 940ca96ea86SBastien Nocera MODULE_DEVICE_TABLE(acpi, goodix_acpi_match); 941771d8f1bSAleksei Mamlin #endif 942771d8f1bSAleksei Mamlin 943771d8f1bSAleksei Mamlin #ifdef CONFIG_OF 944771d8f1bSAleksei Mamlin static const struct of_device_id goodix_of_match[] = { 94525309004SMarcin Niestroj { .compatible = "goodix,gt1151" }, 94684ef1b33SGuido Günther { .compatible = "goodix,gt5688" }, 947771d8f1bSAleksei Mamlin { .compatible = "goodix,gt911" }, 948771d8f1bSAleksei Mamlin { .compatible = "goodix,gt9110" }, 949771d8f1bSAleksei Mamlin { .compatible = "goodix,gt912" }, 950771d8f1bSAleksei Mamlin { .compatible = "goodix,gt927" }, 951771d8f1bSAleksei Mamlin { .compatible = "goodix,gt9271" }, 952771d8f1bSAleksei Mamlin { .compatible = "goodix,gt928" }, 953771d8f1bSAleksei Mamlin { .compatible = "goodix,gt967" }, 954771d8f1bSAleksei Mamlin { } 955771d8f1bSAleksei Mamlin }; 956771d8f1bSAleksei Mamlin MODULE_DEVICE_TABLE(of, goodix_of_match); 957771d8f1bSAleksei Mamlin #endif 958ca96ea86SBastien Nocera 959ca96ea86SBastien Nocera static struct i2c_driver goodix_ts_driver = { 960ca96ea86SBastien Nocera .probe = goodix_ts_probe, 96168caf858SIrina Tirdea .remove = goodix_ts_remove, 962ca96ea86SBastien Nocera .id_table = goodix_ts_id, 963ca96ea86SBastien Nocera .driver = { 964ca96ea86SBastien Nocera .name = "Goodix-TS", 965771d8f1bSAleksei Mamlin .acpi_match_table = ACPI_PTR(goodix_acpi_match), 966771d8f1bSAleksei Mamlin .of_match_table = of_match_ptr(goodix_of_match), 9675ab09d6aSIrina Tirdea .pm = &goodix_pm_ops, 968ca96ea86SBastien Nocera }, 969ca96ea86SBastien Nocera }; 970ca96ea86SBastien Nocera module_i2c_driver(goodix_ts_driver); 971ca96ea86SBastien Nocera 972ca96ea86SBastien Nocera MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>"); 973ca96ea86SBastien Nocera MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>"); 974ca96ea86SBastien Nocera MODULE_DESCRIPTION("Goodix touchscreen driver"); 975ca96ea86SBastien Nocera MODULE_LICENSE("GPL v2"); 976