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> 30ae97fb58SJagan Teki #include <linux/regulator/consumer.h> 31ca96ea86SBastien Nocera #include <linux/slab.h> 32771d8f1bSAleksei Mamlin #include <linux/acpi.h> 33771d8f1bSAleksei Mamlin #include <linux/of.h> 34ca96ea86SBastien Nocera #include <asm/unaligned.h> 35ca96ea86SBastien Nocera 3625309004SMarcin Niestroj struct goodix_ts_data; 3725309004SMarcin Niestroj 3825309004SMarcin Niestroj struct goodix_chip_data { 3925309004SMarcin Niestroj u16 config_addr; 4025309004SMarcin Niestroj int config_len; 4125309004SMarcin Niestroj int (*check_config)(struct goodix_ts_data *, const struct firmware *); 4225309004SMarcin Niestroj }; 4325309004SMarcin Niestroj 44ca96ea86SBastien Nocera struct goodix_ts_data { 45ca96ea86SBastien Nocera struct i2c_client *client; 46ca96ea86SBastien Nocera struct input_dev *input_dev; 4725309004SMarcin Niestroj const struct goodix_chip_data *chip; 48fafef982SMarcin Niestroj struct touchscreen_properties prop; 49ca96ea86SBastien Nocera unsigned int max_touch_num; 50ca96ea86SBastien Nocera unsigned int int_trigger_type; 51ae97fb58SJagan Teki struct regulator *avdd28; 52ae97fb58SJagan Teki struct regulator *vddio; 53ec6e1b40SIrina Tirdea struct gpio_desc *gpiod_int; 54ec6e1b40SIrina Tirdea struct gpio_desc *gpiod_rst; 5568caf858SIrina Tirdea u16 id; 5668caf858SIrina Tirdea u16 version; 5768caf858SIrina Tirdea const char *cfg_name; 5868caf858SIrina Tirdea struct completion firmware_loading_complete; 595ab09d6aSIrina Tirdea unsigned long irq_flags; 60ca96ea86SBastien Nocera }; 61ca96ea86SBastien Nocera 62ec6e1b40SIrina Tirdea #define GOODIX_GPIO_INT_NAME "irq" 63ec6e1b40SIrina Tirdea #define GOODIX_GPIO_RST_NAME "reset" 64ec6e1b40SIrina Tirdea 65ca96ea86SBastien Nocera #define GOODIX_MAX_HEIGHT 4096 66ca96ea86SBastien Nocera #define GOODIX_MAX_WIDTH 4096 67ca96ea86SBastien Nocera #define GOODIX_INT_TRIGGER 1 68ca96ea86SBastien Nocera #define GOODIX_CONTACT_SIZE 8 69ca96ea86SBastien Nocera #define GOODIX_MAX_CONTACTS 10 70ca96ea86SBastien Nocera 71ca96ea86SBastien Nocera #define GOODIX_CONFIG_MAX_LENGTH 240 72a779fbc6SIrina Tirdea #define GOODIX_CONFIG_911_LENGTH 186 73a779fbc6SIrina Tirdea #define GOODIX_CONFIG_967_LENGTH 228 74ca96ea86SBastien Nocera 75ca96ea86SBastien Nocera /* Register defines */ 765ab09d6aSIrina Tirdea #define GOODIX_REG_COMMAND 0x8040 775ab09d6aSIrina Tirdea #define GOODIX_CMD_SCREEN_OFF 0x05 785ab09d6aSIrina Tirdea 79ca96ea86SBastien Nocera #define GOODIX_READ_COOR_ADDR 0x814E 8025309004SMarcin Niestroj #define GOODIX_GT1X_REG_CONFIG_DATA 0x8050 8125309004SMarcin Niestroj #define GOODIX_GT9X_REG_CONFIG_DATA 0x8047 82e70b0307SIrina Tirdea #define GOODIX_REG_ID 0x8140 83ca96ea86SBastien Nocera 849b5db7aaSPaul Cercueil #define GOODIX_BUFFER_STATUS_READY BIT(7) 859b5db7aaSPaul Cercueil #define GOODIX_BUFFER_STATUS_TIMEOUT 20 869b5db7aaSPaul Cercueil 87ca96ea86SBastien Nocera #define RESOLUTION_LOC 1 88a7ac7c95SAleksei Mamlin #define MAX_CONTACTS_LOC 5 89ca96ea86SBastien Nocera #define TRIGGER_LOC 6 90ca96ea86SBastien Nocera 9125309004SMarcin Niestroj static int goodix_check_cfg_8(struct goodix_ts_data *ts, 9225309004SMarcin Niestroj const struct firmware *cfg); 9325309004SMarcin Niestroj static int goodix_check_cfg_16(struct goodix_ts_data *ts, 9425309004SMarcin Niestroj const struct firmware *cfg); 9525309004SMarcin Niestroj 9625309004SMarcin Niestroj static const struct goodix_chip_data gt1x_chip_data = { 9725309004SMarcin Niestroj .config_addr = GOODIX_GT1X_REG_CONFIG_DATA, 9825309004SMarcin Niestroj .config_len = GOODIX_CONFIG_MAX_LENGTH, 9925309004SMarcin Niestroj .check_config = goodix_check_cfg_16, 10025309004SMarcin Niestroj }; 10125309004SMarcin Niestroj 10225309004SMarcin Niestroj static const struct goodix_chip_data gt911_chip_data = { 10325309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 10425309004SMarcin Niestroj .config_len = GOODIX_CONFIG_911_LENGTH, 10525309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 10625309004SMarcin Niestroj }; 10725309004SMarcin Niestroj 10825309004SMarcin Niestroj static const struct goodix_chip_data gt967_chip_data = { 10925309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 11025309004SMarcin Niestroj .config_len = GOODIX_CONFIG_967_LENGTH, 11125309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 11225309004SMarcin Niestroj }; 11325309004SMarcin Niestroj 11425309004SMarcin Niestroj static const struct goodix_chip_data gt9x_chip_data = { 11525309004SMarcin Niestroj .config_addr = GOODIX_GT9X_REG_CONFIG_DATA, 11625309004SMarcin Niestroj .config_len = GOODIX_CONFIG_MAX_LENGTH, 11725309004SMarcin Niestroj .check_config = goodix_check_cfg_8, 11825309004SMarcin Niestroj }; 11925309004SMarcin Niestroj 120ca96ea86SBastien Nocera static const unsigned long goodix_irq_flags[] = { 121ca96ea86SBastien Nocera IRQ_TYPE_EDGE_RISING, 122ca96ea86SBastien Nocera IRQ_TYPE_EDGE_FALLING, 123ca96ea86SBastien Nocera IRQ_TYPE_LEVEL_LOW, 124ca96ea86SBastien Nocera IRQ_TYPE_LEVEL_HIGH, 125ca96ea86SBastien Nocera }; 126ca96ea86SBastien Nocera 1278b5a359cSBastien Nocera /* 1288b5a359cSBastien Nocera * Those tablets have their coordinates origin at the bottom right 1298b5a359cSBastien Nocera * of the tablet, as if rotated 180 degrees 1308b5a359cSBastien Nocera */ 1318b5a359cSBastien Nocera static const struct dmi_system_id rotated_screen[] = { 1328b5a359cSBastien Nocera #if defined(CONFIG_DMI) && defined(CONFIG_X86) 1338b5a359cSBastien Nocera { 1348b5a359cSBastien Nocera .ident = "WinBook TW100", 1358b5a359cSBastien Nocera .matches = { 1368b5a359cSBastien Nocera DMI_MATCH(DMI_SYS_VENDOR, "WinBook"), 1378b5a359cSBastien Nocera DMI_MATCH(DMI_PRODUCT_NAME, "TW100") 1388b5a359cSBastien Nocera } 1398b5a359cSBastien Nocera }, 1408b5a359cSBastien Nocera { 1418b5a359cSBastien Nocera .ident = "WinBook TW700", 1428b5a359cSBastien Nocera .matches = { 1438b5a359cSBastien Nocera DMI_MATCH(DMI_SYS_VENDOR, "WinBook"), 1448b5a359cSBastien Nocera DMI_MATCH(DMI_PRODUCT_NAME, "TW700") 1458b5a359cSBastien Nocera }, 1468b5a359cSBastien Nocera }, 1478b5a359cSBastien Nocera #endif 1488b5a359cSBastien Nocera {} 1498b5a359cSBastien Nocera }; 1508b5a359cSBastien Nocera 151ca96ea86SBastien Nocera /** 152ca96ea86SBastien Nocera * goodix_i2c_read - read data from a register of the i2c slave device. 153ca96ea86SBastien Nocera * 154ca96ea86SBastien Nocera * @client: i2c device. 155ca96ea86SBastien Nocera * @reg: the register to read from. 156ca96ea86SBastien Nocera * @buf: raw write data buffer. 157ca96ea86SBastien Nocera * @len: length of the buffer to write 158ca96ea86SBastien Nocera */ 159ca96ea86SBastien Nocera static int goodix_i2c_read(struct i2c_client *client, 160ca96ea86SBastien Nocera u16 reg, u8 *buf, int len) 161ca96ea86SBastien Nocera { 162ca96ea86SBastien Nocera struct i2c_msg msgs[2]; 163fafef982SMarcin Niestroj __be16 wbuf = cpu_to_be16(reg); 164ca96ea86SBastien Nocera int ret; 165ca96ea86SBastien Nocera 166ca96ea86SBastien Nocera msgs[0].flags = 0; 167ca96ea86SBastien Nocera msgs[0].addr = client->addr; 168ca96ea86SBastien Nocera msgs[0].len = 2; 169ca96ea86SBastien Nocera msgs[0].buf = (u8 *)&wbuf; 170ca96ea86SBastien Nocera 171ca96ea86SBastien Nocera msgs[1].flags = I2C_M_RD; 172ca96ea86SBastien Nocera msgs[1].addr = client->addr; 173ca96ea86SBastien Nocera msgs[1].len = len; 174ca96ea86SBastien Nocera msgs[1].buf = buf; 175ca96ea86SBastien Nocera 176ca96ea86SBastien Nocera ret = i2c_transfer(client->adapter, msgs, 2); 177ca96ea86SBastien Nocera return ret < 0 ? ret : (ret != ARRAY_SIZE(msgs) ? -EIO : 0); 178ca96ea86SBastien Nocera } 179ca96ea86SBastien Nocera 18068caf858SIrina Tirdea /** 18168caf858SIrina Tirdea * goodix_i2c_write - write data to a register of the i2c slave device. 18268caf858SIrina Tirdea * 18368caf858SIrina Tirdea * @client: i2c device. 18468caf858SIrina Tirdea * @reg: the register to write to. 18568caf858SIrina Tirdea * @buf: raw data buffer to write. 18668caf858SIrina Tirdea * @len: length of the buffer to write 18768caf858SIrina Tirdea */ 18868caf858SIrina Tirdea static int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, 18968caf858SIrina Tirdea unsigned len) 19068caf858SIrina Tirdea { 19168caf858SIrina Tirdea u8 *addr_buf; 19268caf858SIrina Tirdea struct i2c_msg msg; 19368caf858SIrina Tirdea int ret; 19468caf858SIrina Tirdea 19568caf858SIrina Tirdea addr_buf = kmalloc(len + 2, GFP_KERNEL); 19668caf858SIrina Tirdea if (!addr_buf) 19768caf858SIrina Tirdea return -ENOMEM; 19868caf858SIrina Tirdea 19968caf858SIrina Tirdea addr_buf[0] = reg >> 8; 20068caf858SIrina Tirdea addr_buf[1] = reg & 0xFF; 20168caf858SIrina Tirdea memcpy(&addr_buf[2], buf, len); 20268caf858SIrina Tirdea 20368caf858SIrina Tirdea msg.flags = 0; 20468caf858SIrina Tirdea msg.addr = client->addr; 20568caf858SIrina Tirdea msg.buf = addr_buf; 20668caf858SIrina Tirdea msg.len = len + 2; 20768caf858SIrina Tirdea 20868caf858SIrina Tirdea ret = i2c_transfer(client->adapter, &msg, 1); 20968caf858SIrina Tirdea kfree(addr_buf); 21068caf858SIrina Tirdea return ret < 0 ? ret : (ret != 1 ? -EIO : 0); 21168caf858SIrina Tirdea } 21268caf858SIrina Tirdea 2135ab09d6aSIrina Tirdea static int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value) 2145ab09d6aSIrina Tirdea { 2155ab09d6aSIrina Tirdea return goodix_i2c_write(client, reg, &value, sizeof(value)); 2165ab09d6aSIrina Tirdea } 2175ab09d6aSIrina Tirdea 21825309004SMarcin Niestroj static const struct goodix_chip_data *goodix_get_chip_data(u16 id) 219a779fbc6SIrina Tirdea { 220a779fbc6SIrina Tirdea switch (id) { 22125309004SMarcin Niestroj case 1151: 222a5f50c50SJagan Teki case 5663: 22384ef1b33SGuido Günther case 5688: 22425309004SMarcin Niestroj return >1x_chip_data; 22525309004SMarcin Niestroj 226a779fbc6SIrina Tirdea case 911: 227a779fbc6SIrina Tirdea case 9271: 228a779fbc6SIrina Tirdea case 9110: 229a779fbc6SIrina Tirdea case 927: 230a779fbc6SIrina Tirdea case 928: 23125309004SMarcin Niestroj return >911_chip_data; 232a779fbc6SIrina Tirdea 233a779fbc6SIrina Tirdea case 912: 234a779fbc6SIrina Tirdea case 967: 23525309004SMarcin Niestroj return >967_chip_data; 236a779fbc6SIrina Tirdea 237a779fbc6SIrina Tirdea default: 23825309004SMarcin Niestroj return >9x_chip_data; 239a779fbc6SIrina Tirdea } 240a779fbc6SIrina Tirdea } 241a779fbc6SIrina Tirdea 242ca96ea86SBastien Nocera static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data) 243ca96ea86SBastien Nocera { 2449b5db7aaSPaul Cercueil unsigned long max_timeout; 245ca96ea86SBastien Nocera int touch_num; 246ca96ea86SBastien Nocera int error; 247ca96ea86SBastien Nocera 2489b5db7aaSPaul Cercueil /* 2499b5db7aaSPaul Cercueil * The 'buffer status' bit, which indicates that the data is valid, is 2509b5db7aaSPaul Cercueil * not set as soon as the interrupt is raised, but slightly after. 2519b5db7aaSPaul Cercueil * This takes around 10 ms to happen, so we poll for 20 ms. 2529b5db7aaSPaul Cercueil */ 2539b5db7aaSPaul Cercueil max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT); 2549b5db7aaSPaul Cercueil do { 2559b5db7aaSPaul Cercueil error = goodix_i2c_read(ts->client, GOODIX_READ_COOR_ADDR, 2569b5db7aaSPaul Cercueil data, GOODIX_CONTACT_SIZE + 1); 257ca96ea86SBastien Nocera if (error) { 2589b5db7aaSPaul Cercueil dev_err(&ts->client->dev, "I2C transfer error: %d\n", 2599b5db7aaSPaul Cercueil error); 260ca96ea86SBastien Nocera return error; 261ca96ea86SBastien Nocera } 262ca96ea86SBastien Nocera 2639b5db7aaSPaul Cercueil if (data[0] & GOODIX_BUFFER_STATUS_READY) { 264ca96ea86SBastien Nocera touch_num = data[0] & 0x0f; 265a7ac7c95SAleksei Mamlin if (touch_num > ts->max_touch_num) 266ca96ea86SBastien Nocera return -EPROTO; 267ca96ea86SBastien Nocera 268ca96ea86SBastien Nocera if (touch_num > 1) { 269ca96ea86SBastien Nocera data += 1 + GOODIX_CONTACT_SIZE; 270ca96ea86SBastien Nocera error = goodix_i2c_read(ts->client, 271ca96ea86SBastien Nocera GOODIX_READ_COOR_ADDR + 272ca96ea86SBastien Nocera 1 + GOODIX_CONTACT_SIZE, 273ca96ea86SBastien Nocera data, 2749b5db7aaSPaul Cercueil GOODIX_CONTACT_SIZE * 2759b5db7aaSPaul Cercueil (touch_num - 1)); 276ca96ea86SBastien Nocera if (error) 277ca96ea86SBastien Nocera return error; 278ca96ea86SBastien Nocera } 279ca96ea86SBastien Nocera 280ca96ea86SBastien Nocera return touch_num; 281ca96ea86SBastien Nocera } 282ca96ea86SBastien Nocera 2839b5db7aaSPaul Cercueil usleep_range(1000, 2000); /* Poll every 1 - 2 ms */ 2849b5db7aaSPaul Cercueil } while (time_before(jiffies, max_timeout)); 2859b5db7aaSPaul Cercueil 2869b5db7aaSPaul Cercueil /* 2879b5db7aaSPaul Cercueil * The Goodix panel will send spurious interrupts after a 2889b5db7aaSPaul Cercueil * 'finger up' event, which will always cause a timeout. 2899b5db7aaSPaul Cercueil */ 2909b5db7aaSPaul Cercueil return 0; 2919b5db7aaSPaul Cercueil } 2929b5db7aaSPaul Cercueil 293ca96ea86SBastien Nocera static void goodix_ts_report_touch(struct goodix_ts_data *ts, u8 *coor_data) 294ca96ea86SBastien Nocera { 295ca96ea86SBastien Nocera int id = coor_data[0] & 0x0F; 296ca96ea86SBastien Nocera int input_x = get_unaligned_le16(&coor_data[1]); 297ca96ea86SBastien Nocera int input_y = get_unaligned_le16(&coor_data[3]); 298ca96ea86SBastien Nocera int input_w = get_unaligned_le16(&coor_data[5]); 299ca96ea86SBastien Nocera 300ca96ea86SBastien Nocera input_mt_slot(ts->input_dev, id); 301ca96ea86SBastien Nocera input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true); 302fafef982SMarcin Niestroj touchscreen_report_pos(ts->input_dev, &ts->prop, 303fafef982SMarcin Niestroj input_x, input_y, true); 304ca96ea86SBastien Nocera input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w); 305ca96ea86SBastien Nocera input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w); 306ca96ea86SBastien Nocera } 307ca96ea86SBastien Nocera 308ca96ea86SBastien Nocera /** 309ca96ea86SBastien Nocera * goodix_process_events - Process incoming events 310ca96ea86SBastien Nocera * 311ca96ea86SBastien Nocera * @ts: our goodix_ts_data pointer 312ca96ea86SBastien Nocera * 313ca96ea86SBastien Nocera * Called when the IRQ is triggered. Read the current device state, and push 314ca96ea86SBastien Nocera * the input events to the user space. 315ca96ea86SBastien Nocera */ 316ca96ea86SBastien Nocera static void goodix_process_events(struct goodix_ts_data *ts) 317ca96ea86SBastien Nocera { 3180e0432f0SIrina Tirdea u8 point_data[1 + GOODIX_CONTACT_SIZE * GOODIX_MAX_CONTACTS]; 319ca96ea86SBastien Nocera int touch_num; 320ca96ea86SBastien Nocera int i; 321ca96ea86SBastien Nocera 322ca96ea86SBastien Nocera touch_num = goodix_ts_read_input_report(ts, point_data); 323ca96ea86SBastien Nocera if (touch_num < 0) 324ca96ea86SBastien Nocera return; 325ca96ea86SBastien Nocera 3264a54feeaSSergei A. Trusov /* 3274a54feeaSSergei A. Trusov * Bit 4 of the first byte reports the status of the capacitive 3284a54feeaSSergei A. Trusov * Windows/Home button. 3294a54feeaSSergei A. Trusov */ 3304a54feeaSSergei A. Trusov input_report_key(ts->input_dev, KEY_LEFTMETA, point_data[0] & BIT(4)); 3314a54feeaSSergei A. Trusov 332ca96ea86SBastien Nocera for (i = 0; i < touch_num; i++) 333ca96ea86SBastien Nocera goodix_ts_report_touch(ts, 334ca96ea86SBastien Nocera &point_data[1 + GOODIX_CONTACT_SIZE * i]); 335ca96ea86SBastien Nocera 336ca96ea86SBastien Nocera input_mt_sync_frame(ts->input_dev); 337ca96ea86SBastien Nocera input_sync(ts->input_dev); 338ca96ea86SBastien Nocera } 339ca96ea86SBastien Nocera 340ca96ea86SBastien Nocera /** 341ca96ea86SBastien Nocera * goodix_ts_irq_handler - The IRQ handler 342ca96ea86SBastien Nocera * 343ca96ea86SBastien Nocera * @irq: interrupt number. 344ca96ea86SBastien Nocera * @dev_id: private data pointer. 345ca96ea86SBastien Nocera */ 346ca96ea86SBastien Nocera static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id) 347ca96ea86SBastien Nocera { 348ca96ea86SBastien Nocera struct goodix_ts_data *ts = dev_id; 349ca96ea86SBastien Nocera 350ca96ea86SBastien Nocera goodix_process_events(ts); 351ca96ea86SBastien Nocera 3525d655b35SIrina Tirdea if (goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0) < 0) 353ca96ea86SBastien Nocera dev_err(&ts->client->dev, "I2C write end_cmd error\n"); 354ca96ea86SBastien Nocera 355ca96ea86SBastien Nocera return IRQ_HANDLED; 356ca96ea86SBastien Nocera } 357ca96ea86SBastien Nocera 3585ab09d6aSIrina Tirdea static void goodix_free_irq(struct goodix_ts_data *ts) 3595ab09d6aSIrina Tirdea { 3605ab09d6aSIrina Tirdea devm_free_irq(&ts->client->dev, ts->client->irq, ts); 3615ab09d6aSIrina Tirdea } 3625ab09d6aSIrina Tirdea 3635ab09d6aSIrina Tirdea static int goodix_request_irq(struct goodix_ts_data *ts) 3645ab09d6aSIrina Tirdea { 3655ab09d6aSIrina Tirdea return devm_request_threaded_irq(&ts->client->dev, ts->client->irq, 3665ab09d6aSIrina Tirdea NULL, goodix_ts_irq_handler, 3675ab09d6aSIrina Tirdea ts->irq_flags, ts->client->name, ts); 3685ab09d6aSIrina Tirdea } 3695ab09d6aSIrina Tirdea 37025309004SMarcin Niestroj static int goodix_check_cfg_8(struct goodix_ts_data *ts, 37168caf858SIrina Tirdea const struct firmware *cfg) 37268caf858SIrina Tirdea { 37325309004SMarcin Niestroj int i, raw_cfg_len = cfg->size - 2; 37468caf858SIrina Tirdea u8 check_sum = 0; 37568caf858SIrina Tirdea 37668caf858SIrina Tirdea for (i = 0; i < raw_cfg_len; i++) 37768caf858SIrina Tirdea check_sum += cfg->data[i]; 37868caf858SIrina Tirdea check_sum = (~check_sum) + 1; 37968caf858SIrina Tirdea if (check_sum != cfg->data[raw_cfg_len]) { 38068caf858SIrina Tirdea dev_err(&ts->client->dev, 38168caf858SIrina Tirdea "The checksum of the config fw is not correct"); 38268caf858SIrina Tirdea return -EINVAL; 38368caf858SIrina Tirdea } 38468caf858SIrina Tirdea 38568caf858SIrina Tirdea if (cfg->data[raw_cfg_len + 1] != 1) { 38668caf858SIrina Tirdea dev_err(&ts->client->dev, 38768caf858SIrina Tirdea "Config fw must have Config_Fresh register set"); 38868caf858SIrina Tirdea return -EINVAL; 38968caf858SIrina Tirdea } 39068caf858SIrina Tirdea 39168caf858SIrina Tirdea return 0; 39268caf858SIrina Tirdea } 39368caf858SIrina Tirdea 39425309004SMarcin Niestroj static int goodix_check_cfg_16(struct goodix_ts_data *ts, 39525309004SMarcin Niestroj const struct firmware *cfg) 39625309004SMarcin Niestroj { 39725309004SMarcin Niestroj int i, raw_cfg_len = cfg->size - 3; 39825309004SMarcin Niestroj u16 check_sum = 0; 39925309004SMarcin Niestroj 40025309004SMarcin Niestroj for (i = 0; i < raw_cfg_len; i += 2) 40125309004SMarcin Niestroj check_sum += get_unaligned_be16(&cfg->data[i]); 40225309004SMarcin Niestroj check_sum = (~check_sum) + 1; 40325309004SMarcin Niestroj if (check_sum != get_unaligned_be16(&cfg->data[raw_cfg_len])) { 40425309004SMarcin Niestroj dev_err(&ts->client->dev, 40525309004SMarcin Niestroj "The checksum of the config fw is not correct"); 40625309004SMarcin Niestroj return -EINVAL; 40725309004SMarcin Niestroj } 40825309004SMarcin Niestroj 40925309004SMarcin Niestroj if (cfg->data[raw_cfg_len + 2] != 1) { 41025309004SMarcin Niestroj dev_err(&ts->client->dev, 41125309004SMarcin Niestroj "Config fw must have Config_Fresh register set"); 41225309004SMarcin Niestroj return -EINVAL; 41325309004SMarcin Niestroj } 41425309004SMarcin Niestroj 41525309004SMarcin Niestroj return 0; 41625309004SMarcin Niestroj } 41725309004SMarcin Niestroj 41825309004SMarcin Niestroj /** 41925309004SMarcin Niestroj * goodix_check_cfg - Checks if config fw is valid 42025309004SMarcin Niestroj * 42125309004SMarcin Niestroj * @ts: goodix_ts_data pointer 42225309004SMarcin Niestroj * @cfg: firmware config data 42325309004SMarcin Niestroj */ 42425309004SMarcin Niestroj static int goodix_check_cfg(struct goodix_ts_data *ts, 42525309004SMarcin Niestroj const struct firmware *cfg) 42625309004SMarcin Niestroj { 42725309004SMarcin Niestroj if (cfg->size > GOODIX_CONFIG_MAX_LENGTH) { 42825309004SMarcin Niestroj dev_err(&ts->client->dev, 42925309004SMarcin Niestroj "The length of the config fw is not correct"); 43025309004SMarcin Niestroj return -EINVAL; 43125309004SMarcin Niestroj } 43225309004SMarcin Niestroj 43325309004SMarcin Niestroj return ts->chip->check_config(ts, cfg); 43425309004SMarcin Niestroj } 43525309004SMarcin Niestroj 43668caf858SIrina Tirdea /** 43768caf858SIrina Tirdea * goodix_send_cfg - Write fw config to device 43868caf858SIrina Tirdea * 43968caf858SIrina Tirdea * @ts: goodix_ts_data pointer 44068caf858SIrina Tirdea * @cfg: config firmware to write to device 44168caf858SIrina Tirdea */ 44268caf858SIrina Tirdea static int goodix_send_cfg(struct goodix_ts_data *ts, 44368caf858SIrina Tirdea const struct firmware *cfg) 44468caf858SIrina Tirdea { 44568caf858SIrina Tirdea int error; 44668caf858SIrina Tirdea 44768caf858SIrina Tirdea error = goodix_check_cfg(ts, cfg); 44868caf858SIrina Tirdea if (error) 44968caf858SIrina Tirdea return error; 45068caf858SIrina Tirdea 45125309004SMarcin Niestroj error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg->data, 45268caf858SIrina Tirdea cfg->size); 45368caf858SIrina Tirdea if (error) { 45468caf858SIrina Tirdea dev_err(&ts->client->dev, "Failed to write config data: %d", 45568caf858SIrina Tirdea error); 45668caf858SIrina Tirdea return error; 45768caf858SIrina Tirdea } 45868caf858SIrina Tirdea dev_dbg(&ts->client->dev, "Config sent successfully."); 45968caf858SIrina Tirdea 46068caf858SIrina Tirdea /* Let the firmware reconfigure itself, so sleep for 10ms */ 46168caf858SIrina Tirdea usleep_range(10000, 11000); 46268caf858SIrina Tirdea 46368caf858SIrina Tirdea return 0; 46468caf858SIrina Tirdea } 46568caf858SIrina Tirdea 466ec6e1b40SIrina Tirdea static int goodix_int_sync(struct goodix_ts_data *ts) 467ec6e1b40SIrina Tirdea { 468ec6e1b40SIrina Tirdea int error; 469ec6e1b40SIrina Tirdea 470ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 0); 471ec6e1b40SIrina Tirdea if (error) 472ec6e1b40SIrina Tirdea return error; 473ec6e1b40SIrina Tirdea 474ec6e1b40SIrina Tirdea msleep(50); /* T5: 50ms */ 475ec6e1b40SIrina Tirdea 476ec6e1b40SIrina Tirdea error = gpiod_direction_input(ts->gpiod_int); 477ec6e1b40SIrina Tirdea if (error) 478ec6e1b40SIrina Tirdea return error; 479ec6e1b40SIrina Tirdea 480ec6e1b40SIrina Tirdea return 0; 481ec6e1b40SIrina Tirdea } 482ec6e1b40SIrina Tirdea 483ec6e1b40SIrina Tirdea /** 484ec6e1b40SIrina Tirdea * goodix_reset - Reset device during power on 485ec6e1b40SIrina Tirdea * 486ec6e1b40SIrina Tirdea * @ts: goodix_ts_data pointer 487ec6e1b40SIrina Tirdea */ 488ec6e1b40SIrina Tirdea static int goodix_reset(struct goodix_ts_data *ts) 489ec6e1b40SIrina Tirdea { 490ec6e1b40SIrina Tirdea int error; 491ec6e1b40SIrina Tirdea 492ec6e1b40SIrina Tirdea /* begin select I2C slave addr */ 493ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_rst, 0); 494ec6e1b40SIrina Tirdea if (error) 495ec6e1b40SIrina Tirdea return error; 496ec6e1b40SIrina Tirdea 497ec6e1b40SIrina Tirdea msleep(20); /* T2: > 10ms */ 498ec6e1b40SIrina Tirdea 499ec6e1b40SIrina Tirdea /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */ 500ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, ts->client->addr == 0x14); 501ec6e1b40SIrina Tirdea if (error) 502ec6e1b40SIrina Tirdea return error; 503ec6e1b40SIrina Tirdea 504ec6e1b40SIrina Tirdea usleep_range(100, 2000); /* T3: > 100us */ 505ec6e1b40SIrina Tirdea 506ec6e1b40SIrina Tirdea error = gpiod_direction_output(ts->gpiod_rst, 1); 507ec6e1b40SIrina Tirdea if (error) 508ec6e1b40SIrina Tirdea return error; 509ec6e1b40SIrina Tirdea 510ec6e1b40SIrina Tirdea usleep_range(6000, 10000); /* T4: > 5ms */ 511ec6e1b40SIrina Tirdea 512ec6e1b40SIrina Tirdea /* end select I2C slave addr */ 513ec6e1b40SIrina Tirdea error = gpiod_direction_input(ts->gpiod_rst); 514ec6e1b40SIrina Tirdea if (error) 515ec6e1b40SIrina Tirdea return error; 516ec6e1b40SIrina Tirdea 517ec6e1b40SIrina Tirdea error = goodix_int_sync(ts); 518ec6e1b40SIrina Tirdea if (error) 519ec6e1b40SIrina Tirdea return error; 520ec6e1b40SIrina Tirdea 521ec6e1b40SIrina Tirdea return 0; 522ec6e1b40SIrina Tirdea } 523ec6e1b40SIrina Tirdea 524ec6e1b40SIrina Tirdea /** 525ec6e1b40SIrina Tirdea * goodix_get_gpio_config - Get GPIO config from ACPI/DT 526ec6e1b40SIrina Tirdea * 527ec6e1b40SIrina Tirdea * @ts: goodix_ts_data pointer 528ec6e1b40SIrina Tirdea */ 529ec6e1b40SIrina Tirdea static int goodix_get_gpio_config(struct goodix_ts_data *ts) 530ec6e1b40SIrina Tirdea { 531ec6e1b40SIrina Tirdea int error; 532ec6e1b40SIrina Tirdea struct device *dev; 533ec6e1b40SIrina Tirdea struct gpio_desc *gpiod; 534ec6e1b40SIrina Tirdea 535ec6e1b40SIrina Tirdea if (!ts->client) 536ec6e1b40SIrina Tirdea return -EINVAL; 537ec6e1b40SIrina Tirdea dev = &ts->client->dev; 538ec6e1b40SIrina Tirdea 539ae97fb58SJagan Teki ts->avdd28 = devm_regulator_get(dev, "AVDD28"); 540ae97fb58SJagan Teki if (IS_ERR(ts->avdd28)) { 541ae97fb58SJagan Teki error = PTR_ERR(ts->avdd28); 542ae97fb58SJagan Teki if (error != -EPROBE_DEFER) 543ae97fb58SJagan Teki dev_err(dev, 544ae97fb58SJagan Teki "Failed to get AVDD28 regulator: %d\n", error); 545ae97fb58SJagan Teki return error; 546ae97fb58SJagan Teki } 547ae97fb58SJagan Teki 548ae97fb58SJagan Teki ts->vddio = devm_regulator_get(dev, "VDDIO"); 549ae97fb58SJagan Teki if (IS_ERR(ts->vddio)) { 550ae97fb58SJagan Teki error = PTR_ERR(ts->vddio); 551ae97fb58SJagan Teki if (error != -EPROBE_DEFER) 552ae97fb58SJagan Teki dev_err(dev, 553ae97fb58SJagan Teki "Failed to get VDDIO regulator: %d\n", error); 554ae97fb58SJagan Teki return error; 555ae97fb58SJagan Teki } 556ae97fb58SJagan Teki 557ec6e1b40SIrina Tirdea /* Get the interrupt GPIO pin number */ 558ec6e1b40SIrina Tirdea gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN); 559ec6e1b40SIrina Tirdea if (IS_ERR(gpiod)) { 560ec6e1b40SIrina Tirdea error = PTR_ERR(gpiod); 561ec6e1b40SIrina Tirdea if (error != -EPROBE_DEFER) 562ec6e1b40SIrina Tirdea dev_dbg(dev, "Failed to get %s GPIO: %d\n", 563ec6e1b40SIrina Tirdea GOODIX_GPIO_INT_NAME, error); 564ec6e1b40SIrina Tirdea return error; 565ec6e1b40SIrina Tirdea } 566ec6e1b40SIrina Tirdea 567ec6e1b40SIrina Tirdea ts->gpiod_int = gpiod; 568ec6e1b40SIrina Tirdea 569ec6e1b40SIrina Tirdea /* Get the reset line GPIO pin number */ 570ec6e1b40SIrina Tirdea gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, GPIOD_IN); 571ec6e1b40SIrina Tirdea if (IS_ERR(gpiod)) { 572ec6e1b40SIrina Tirdea error = PTR_ERR(gpiod); 573ec6e1b40SIrina Tirdea if (error != -EPROBE_DEFER) 574ec6e1b40SIrina Tirdea dev_dbg(dev, "Failed to get %s GPIO: %d\n", 575ec6e1b40SIrina Tirdea GOODIX_GPIO_RST_NAME, error); 576ec6e1b40SIrina Tirdea return error; 577ec6e1b40SIrina Tirdea } 578ec6e1b40SIrina Tirdea 579ec6e1b40SIrina Tirdea ts->gpiod_rst = gpiod; 580ec6e1b40SIrina Tirdea 581ec6e1b40SIrina Tirdea return 0; 582ec6e1b40SIrina Tirdea } 583ec6e1b40SIrina Tirdea 584ca96ea86SBastien Nocera /** 585ca96ea86SBastien Nocera * goodix_read_config - Read the embedded configuration of the panel 586ca96ea86SBastien Nocera * 587ca96ea86SBastien Nocera * @ts: our goodix_ts_data pointer 588ca96ea86SBastien Nocera * 589ca96ea86SBastien Nocera * Must be called during probe 590ca96ea86SBastien Nocera */ 591ca96ea86SBastien Nocera static void goodix_read_config(struct goodix_ts_data *ts) 592ca96ea86SBastien Nocera { 593ca96ea86SBastien Nocera u8 config[GOODIX_CONFIG_MAX_LENGTH]; 594fafef982SMarcin Niestroj int x_max, y_max; 595ca96ea86SBastien Nocera int error; 596ca96ea86SBastien Nocera 59725309004SMarcin Niestroj error = goodix_i2c_read(ts->client, ts->chip->config_addr, 59825309004SMarcin Niestroj config, ts->chip->config_len); 599ca96ea86SBastien Nocera if (error) { 600fafef982SMarcin Niestroj dev_warn(&ts->client->dev, "Error reading config: %d\n", 601ca96ea86SBastien Nocera error); 602ca96ea86SBastien Nocera ts->int_trigger_type = GOODIX_INT_TRIGGER; 603a7ac7c95SAleksei Mamlin ts->max_touch_num = GOODIX_MAX_CONTACTS; 604ca96ea86SBastien Nocera return; 605ca96ea86SBastien Nocera } 606ca96ea86SBastien Nocera 607a7ac7c95SAleksei Mamlin ts->int_trigger_type = config[TRIGGER_LOC] & 0x03; 608a7ac7c95SAleksei Mamlin ts->max_touch_num = config[MAX_CONTACTS_LOC] & 0x0f; 6098b5a359cSBastien Nocera 610fafef982SMarcin Niestroj x_max = get_unaligned_le16(&config[RESOLUTION_LOC]); 611fafef982SMarcin Niestroj y_max = get_unaligned_le16(&config[RESOLUTION_LOC + 2]); 612fafef982SMarcin Niestroj if (x_max && y_max) { 613fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1); 614fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1); 615ca96ea86SBastien Nocera } 61657c80e8eSKarsten Merker } 617ca96ea86SBastien Nocera 618ca96ea86SBastien Nocera /** 619ca96ea86SBastien Nocera * goodix_read_version - Read goodix touchscreen version 620ca96ea86SBastien Nocera * 62168caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 622ca96ea86SBastien Nocera */ 62368caf858SIrina Tirdea static int goodix_read_version(struct goodix_ts_data *ts) 624ca96ea86SBastien Nocera { 625ca96ea86SBastien Nocera int error; 626ca96ea86SBastien Nocera u8 buf[6]; 627e70b0307SIrina Tirdea char id_str[5]; 628ca96ea86SBastien Nocera 62968caf858SIrina Tirdea error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf)); 630ca96ea86SBastien Nocera if (error) { 63168caf858SIrina Tirdea dev_err(&ts->client->dev, "read version failed: %d\n", error); 632ca96ea86SBastien Nocera return error; 633ca96ea86SBastien Nocera } 634ca96ea86SBastien Nocera 635e70b0307SIrina Tirdea memcpy(id_str, buf, 4); 636e70b0307SIrina Tirdea id_str[4] = 0; 63768caf858SIrina Tirdea if (kstrtou16(id_str, 10, &ts->id)) 63868caf858SIrina Tirdea ts->id = 0x1001; 639e70b0307SIrina Tirdea 64068caf858SIrina Tirdea ts->version = get_unaligned_le16(&buf[4]); 641ca96ea86SBastien Nocera 64268caf858SIrina Tirdea dev_info(&ts->client->dev, "ID %d, version: %04x\n", ts->id, 64368caf858SIrina Tirdea ts->version); 644ca96ea86SBastien Nocera 645ca96ea86SBastien Nocera return 0; 646ca96ea86SBastien Nocera } 647ca96ea86SBastien Nocera 648ca96ea86SBastien Nocera /** 649ca96ea86SBastien Nocera * goodix_i2c_test - I2C test function to check if the device answers. 650ca96ea86SBastien Nocera * 651ca96ea86SBastien Nocera * @client: the i2c client 652ca96ea86SBastien Nocera */ 653ca96ea86SBastien Nocera static int goodix_i2c_test(struct i2c_client *client) 654ca96ea86SBastien Nocera { 655ca96ea86SBastien Nocera int retry = 0; 656ca96ea86SBastien Nocera int error; 657ca96ea86SBastien Nocera u8 test; 658ca96ea86SBastien Nocera 659ca96ea86SBastien Nocera while (retry++ < 2) { 66025309004SMarcin Niestroj error = goodix_i2c_read(client, GOODIX_REG_ID, 661ca96ea86SBastien Nocera &test, 1); 662ca96ea86SBastien Nocera if (!error) 663ca96ea86SBastien Nocera return 0; 664ca96ea86SBastien Nocera 665ca96ea86SBastien Nocera dev_err(&client->dev, "i2c test failed attempt %d: %d\n", 666ca96ea86SBastien Nocera retry, error); 667ca96ea86SBastien Nocera msleep(20); 668ca96ea86SBastien Nocera } 669ca96ea86SBastien Nocera 670ca96ea86SBastien Nocera return error; 671ca96ea86SBastien Nocera } 672ca96ea86SBastien Nocera 673ca96ea86SBastien Nocera /** 67468caf858SIrina Tirdea * goodix_configure_dev - Finish device initialization 67568caf858SIrina Tirdea * 67668caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 67768caf858SIrina Tirdea * 67868caf858SIrina Tirdea * Must be called from probe to finish initialization of the device. 67968caf858SIrina Tirdea * Contains the common initialization code for both devices that 68068caf858SIrina Tirdea * declare gpio pins and devices that do not. It is either called 68168caf858SIrina Tirdea * directly from probe or from request_firmware_wait callback. 68268caf858SIrina Tirdea */ 68368caf858SIrina Tirdea static int goodix_configure_dev(struct goodix_ts_data *ts) 68468caf858SIrina Tirdea { 68568caf858SIrina Tirdea int error; 68668caf858SIrina Tirdea 687fafef982SMarcin Niestroj ts->int_trigger_type = GOODIX_INT_TRIGGER; 688fafef982SMarcin Niestroj ts->max_touch_num = GOODIX_MAX_CONTACTS; 689ad48cf5eSKarsten Merker 690fafef982SMarcin Niestroj ts->input_dev = devm_input_allocate_device(&ts->client->dev); 691fafef982SMarcin Niestroj if (!ts->input_dev) { 692fafef982SMarcin Niestroj dev_err(&ts->client->dev, "Failed to allocate input device."); 693fafef982SMarcin Niestroj return -ENOMEM; 694fafef982SMarcin Niestroj } 695fafef982SMarcin Niestroj 696fafef982SMarcin Niestroj ts->input_dev->name = "Goodix Capacitive TouchScreen"; 697fafef982SMarcin Niestroj ts->input_dev->phys = "input/ts"; 698fafef982SMarcin Niestroj ts->input_dev->id.bustype = BUS_I2C; 699fafef982SMarcin Niestroj ts->input_dev->id.vendor = 0x0416; 700fafef982SMarcin Niestroj ts->input_dev->id.product = ts->id; 701fafef982SMarcin Niestroj ts->input_dev->id.version = ts->version; 702fafef982SMarcin Niestroj 703fafef982SMarcin Niestroj /* Capacitive Windows/Home button on some devices */ 704fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_KEY, KEY_LEFTMETA); 705fafef982SMarcin Niestroj 706fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X); 707fafef982SMarcin Niestroj input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y); 708fafef982SMarcin Niestroj input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0); 709fafef982SMarcin Niestroj input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0); 710fafef982SMarcin Niestroj 711fafef982SMarcin Niestroj /* Read configuration and apply touchscreen parameters */ 71268caf858SIrina Tirdea goodix_read_config(ts); 71368caf858SIrina Tirdea 714fafef982SMarcin Niestroj /* Try overriding touchscreen parameters via device properties */ 715fafef982SMarcin Niestroj touchscreen_parse_properties(ts->input_dev, true, &ts->prop); 716fafef982SMarcin Niestroj 717fafef982SMarcin Niestroj if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) { 718c1c00aa5SGuido Günther dev_err(&ts->client->dev, 719c1c00aa5SGuido Günther "Invalid config (%d, %d, %d), using defaults\n", 720c1c00aa5SGuido Günther ts->prop.max_x, ts->prop.max_y, ts->max_touch_num); 721fafef982SMarcin Niestroj ts->prop.max_x = GOODIX_MAX_WIDTH - 1; 722fafef982SMarcin Niestroj ts->prop.max_y = GOODIX_MAX_HEIGHT - 1; 723fafef982SMarcin Niestroj ts->max_touch_num = GOODIX_MAX_CONTACTS; 724fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, 725fafef982SMarcin Niestroj ABS_MT_POSITION_X, ts->prop.max_x); 726fafef982SMarcin Niestroj input_abs_set_max(ts->input_dev, 727fafef982SMarcin Niestroj ABS_MT_POSITION_Y, ts->prop.max_y); 728fafef982SMarcin Niestroj } 729fafef982SMarcin Niestroj 730fafef982SMarcin Niestroj if (dmi_check_system(rotated_screen)) { 731fafef982SMarcin Niestroj ts->prop.invert_x = true; 732fafef982SMarcin Niestroj ts->prop.invert_y = true; 733fafef982SMarcin Niestroj dev_dbg(&ts->client->dev, 734fafef982SMarcin Niestroj "Applying '180 degrees rotated screen' quirk\n"); 735fafef982SMarcin Niestroj } 736fafef982SMarcin Niestroj 737fafef982SMarcin Niestroj error = input_mt_init_slots(ts->input_dev, ts->max_touch_num, 738fafef982SMarcin Niestroj INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED); 739fafef982SMarcin Niestroj if (error) { 740fafef982SMarcin Niestroj dev_err(&ts->client->dev, 741fafef982SMarcin Niestroj "Failed to initialize MT slots: %d", error); 74268caf858SIrina Tirdea return error; 743fafef982SMarcin Niestroj } 744fafef982SMarcin Niestroj 745fafef982SMarcin Niestroj error = input_register_device(ts->input_dev); 746fafef982SMarcin Niestroj if (error) { 747fafef982SMarcin Niestroj dev_err(&ts->client->dev, 748fafef982SMarcin Niestroj "Failed to register input device: %d", error); 749fafef982SMarcin Niestroj return error; 750fafef982SMarcin Niestroj } 75168caf858SIrina Tirdea 7525ab09d6aSIrina Tirdea ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT; 7535ab09d6aSIrina Tirdea error = goodix_request_irq(ts); 75468caf858SIrina Tirdea if (error) { 75568caf858SIrina Tirdea dev_err(&ts->client->dev, "request IRQ failed: %d\n", error); 75668caf858SIrina Tirdea return error; 75768caf858SIrina Tirdea } 75868caf858SIrina Tirdea 75968caf858SIrina Tirdea return 0; 76068caf858SIrina Tirdea } 76168caf858SIrina Tirdea 76268caf858SIrina Tirdea /** 76368caf858SIrina Tirdea * goodix_config_cb - Callback to finish device init 76468caf858SIrina Tirdea * 76568caf858SIrina Tirdea * @ts: our goodix_ts_data pointer 76668caf858SIrina Tirdea * 76768caf858SIrina Tirdea * request_firmware_wait callback that finishes 76868caf858SIrina Tirdea * initialization of the device. 76968caf858SIrina Tirdea */ 77068caf858SIrina Tirdea static void goodix_config_cb(const struct firmware *cfg, void *ctx) 77168caf858SIrina Tirdea { 77268caf858SIrina Tirdea struct goodix_ts_data *ts = ctx; 77368caf858SIrina Tirdea int error; 77468caf858SIrina Tirdea 77568caf858SIrina Tirdea if (cfg) { 77668caf858SIrina Tirdea /* send device configuration to the firmware */ 77768caf858SIrina Tirdea error = goodix_send_cfg(ts, cfg); 77868caf858SIrina Tirdea if (error) 77968caf858SIrina Tirdea goto err_release_cfg; 78068caf858SIrina Tirdea } 78168caf858SIrina Tirdea 78268caf858SIrina Tirdea goodix_configure_dev(ts); 78368caf858SIrina Tirdea 78468caf858SIrina Tirdea err_release_cfg: 78568caf858SIrina Tirdea release_firmware(cfg); 78668caf858SIrina Tirdea complete_all(&ts->firmware_loading_complete); 78768caf858SIrina Tirdea } 78868caf858SIrina Tirdea 789ae97fb58SJagan Teki static void goodix_disable_regulators(void *arg) 790ae97fb58SJagan Teki { 791ae97fb58SJagan Teki struct goodix_ts_data *ts = arg; 792ae97fb58SJagan Teki 793ae97fb58SJagan Teki regulator_disable(ts->vddio); 794ae97fb58SJagan Teki regulator_disable(ts->avdd28); 795ae97fb58SJagan Teki } 796ae97fb58SJagan Teki 797ca96ea86SBastien Nocera static int goodix_ts_probe(struct i2c_client *client, 798ca96ea86SBastien Nocera const struct i2c_device_id *id) 799ca96ea86SBastien Nocera { 800ca96ea86SBastien Nocera struct goodix_ts_data *ts; 801ca96ea86SBastien Nocera int error; 802ca96ea86SBastien Nocera 803ca96ea86SBastien Nocera dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr); 804ca96ea86SBastien Nocera 805ca96ea86SBastien Nocera if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 806ca96ea86SBastien Nocera dev_err(&client->dev, "I2C check functionality failed.\n"); 807ca96ea86SBastien Nocera return -ENXIO; 808ca96ea86SBastien Nocera } 809ca96ea86SBastien Nocera 810ca96ea86SBastien Nocera ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL); 811ca96ea86SBastien Nocera if (!ts) 812ca96ea86SBastien Nocera return -ENOMEM; 813ca96ea86SBastien Nocera 814ca96ea86SBastien Nocera ts->client = client; 815ca96ea86SBastien Nocera i2c_set_clientdata(client, ts); 81668caf858SIrina Tirdea init_completion(&ts->firmware_loading_complete); 817ca96ea86SBastien Nocera 818ec6e1b40SIrina Tirdea error = goodix_get_gpio_config(ts); 819ec6e1b40SIrina Tirdea if (error) 820ec6e1b40SIrina Tirdea return error; 821ec6e1b40SIrina Tirdea 822ae97fb58SJagan Teki /* power up the controller */ 823ae97fb58SJagan Teki error = regulator_enable(ts->avdd28); 824ae97fb58SJagan Teki if (error) { 825ae97fb58SJagan Teki dev_err(&client->dev, 826ae97fb58SJagan Teki "Failed to enable AVDD28 regulator: %d\n", 827ae97fb58SJagan Teki error); 828ae97fb58SJagan Teki return error; 829ae97fb58SJagan Teki } 830ae97fb58SJagan Teki 831ae97fb58SJagan Teki error = regulator_enable(ts->vddio); 832ae97fb58SJagan Teki if (error) { 833ae97fb58SJagan Teki dev_err(&client->dev, 834ae97fb58SJagan Teki "Failed to enable VDDIO regulator: %d\n", 835ae97fb58SJagan Teki error); 836ae97fb58SJagan Teki regulator_disable(ts->avdd28); 837ae97fb58SJagan Teki return error; 838ae97fb58SJagan Teki } 839ae97fb58SJagan Teki 840ae97fb58SJagan Teki error = devm_add_action_or_reset(&client->dev, 841ae97fb58SJagan Teki goodix_disable_regulators, ts); 842ae97fb58SJagan Teki if (error) 843ae97fb58SJagan Teki return error; 844ae97fb58SJagan Teki 845ec6e1b40SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) { 846ec6e1b40SIrina Tirdea /* reset the controller */ 847ec6e1b40SIrina Tirdea error = goodix_reset(ts); 848ec6e1b40SIrina Tirdea if (error) { 849ec6e1b40SIrina Tirdea dev_err(&client->dev, "Controller reset failed.\n"); 850ec6e1b40SIrina Tirdea return error; 851ec6e1b40SIrina Tirdea } 852ec6e1b40SIrina Tirdea } 853ec6e1b40SIrina Tirdea 854ca96ea86SBastien Nocera error = goodix_i2c_test(client); 855ca96ea86SBastien Nocera if (error) { 856ca96ea86SBastien Nocera dev_err(&client->dev, "I2C communication failure: %d\n", error); 857ca96ea86SBastien Nocera return error; 858ca96ea86SBastien Nocera } 859ca96ea86SBastien Nocera 86068caf858SIrina Tirdea error = goodix_read_version(ts); 861ca96ea86SBastien Nocera if (error) { 862ca96ea86SBastien Nocera dev_err(&client->dev, "Read version failed.\n"); 863ca96ea86SBastien Nocera return error; 864ca96ea86SBastien Nocera } 865ca96ea86SBastien Nocera 86625309004SMarcin Niestroj ts->chip = goodix_get_chip_data(ts->id); 867a779fbc6SIrina Tirdea 86868caf858SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) { 86968caf858SIrina Tirdea /* update device config */ 87068caf858SIrina Tirdea ts->cfg_name = devm_kasprintf(&client->dev, GFP_KERNEL, 87168caf858SIrina Tirdea "goodix_%d_cfg.bin", ts->id); 87268caf858SIrina Tirdea if (!ts->cfg_name) 87368caf858SIrina Tirdea return -ENOMEM; 874ca96ea86SBastien Nocera 87568caf858SIrina Tirdea error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name, 87668caf858SIrina Tirdea &client->dev, GFP_KERNEL, ts, 87768caf858SIrina Tirdea goodix_config_cb); 878ca96ea86SBastien Nocera if (error) { 87968caf858SIrina Tirdea dev_err(&client->dev, 88068caf858SIrina Tirdea "Failed to invoke firmware loader: %d\n", 88168caf858SIrina Tirdea error); 882ca96ea86SBastien Nocera return error; 883ca96ea86SBastien Nocera } 884ca96ea86SBastien Nocera 885ca96ea86SBastien Nocera return 0; 88668caf858SIrina Tirdea } else { 88768caf858SIrina Tirdea error = goodix_configure_dev(ts); 88868caf858SIrina Tirdea if (error) 88968caf858SIrina Tirdea return error; 89068caf858SIrina Tirdea } 89168caf858SIrina Tirdea 89268caf858SIrina Tirdea return 0; 89368caf858SIrina Tirdea } 89468caf858SIrina Tirdea 89568caf858SIrina Tirdea static int goodix_ts_remove(struct i2c_client *client) 89668caf858SIrina Tirdea { 89768caf858SIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 89868caf858SIrina Tirdea 89968caf858SIrina Tirdea if (ts->gpiod_int && ts->gpiod_rst) 90068caf858SIrina Tirdea wait_for_completion(&ts->firmware_loading_complete); 90168caf858SIrina Tirdea 90268caf858SIrina Tirdea return 0; 903ca96ea86SBastien Nocera } 904ca96ea86SBastien Nocera 9055ab09d6aSIrina Tirdea static int __maybe_unused goodix_suspend(struct device *dev) 9065ab09d6aSIrina Tirdea { 9075ab09d6aSIrina Tirdea struct i2c_client *client = to_i2c_client(dev); 9085ab09d6aSIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 9095ab09d6aSIrina Tirdea int error; 9105ab09d6aSIrina Tirdea 9115ab09d6aSIrina Tirdea /* We need gpio pins to suspend/resume */ 912faec44b6SHans de Goede if (!ts->gpiod_int || !ts->gpiod_rst) { 913faec44b6SHans de Goede disable_irq(client->irq); 9145ab09d6aSIrina Tirdea return 0; 915faec44b6SHans de Goede } 9165ab09d6aSIrina Tirdea 9175ab09d6aSIrina Tirdea wait_for_completion(&ts->firmware_loading_complete); 9185ab09d6aSIrina Tirdea 9195ab09d6aSIrina Tirdea /* Free IRQ as IRQ pin is used as output in the suspend sequence */ 9205ab09d6aSIrina Tirdea goodix_free_irq(ts); 9215ab09d6aSIrina Tirdea 9225ab09d6aSIrina Tirdea /* Output LOW on the INT pin for 5 ms */ 9235ab09d6aSIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 0); 9245ab09d6aSIrina Tirdea if (error) { 9255ab09d6aSIrina Tirdea goodix_request_irq(ts); 9265ab09d6aSIrina Tirdea return error; 9275ab09d6aSIrina Tirdea } 9285ab09d6aSIrina Tirdea 9295ab09d6aSIrina Tirdea usleep_range(5000, 6000); 9305ab09d6aSIrina Tirdea 9315ab09d6aSIrina Tirdea error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND, 9325ab09d6aSIrina Tirdea GOODIX_CMD_SCREEN_OFF); 9335ab09d6aSIrina Tirdea if (error) { 9345ab09d6aSIrina Tirdea dev_err(&ts->client->dev, "Screen off command failed\n"); 9355ab09d6aSIrina Tirdea gpiod_direction_input(ts->gpiod_int); 9365ab09d6aSIrina Tirdea goodix_request_irq(ts); 9375ab09d6aSIrina Tirdea return -EAGAIN; 9385ab09d6aSIrina Tirdea } 9395ab09d6aSIrina Tirdea 9405ab09d6aSIrina Tirdea /* 9415ab09d6aSIrina Tirdea * The datasheet specifies that the interval between sending screen-off 9425ab09d6aSIrina Tirdea * command and wake-up should be longer than 58 ms. To avoid waking up 9435ab09d6aSIrina Tirdea * sooner, delay 58ms here. 9445ab09d6aSIrina Tirdea */ 9455ab09d6aSIrina Tirdea msleep(58); 9465ab09d6aSIrina Tirdea return 0; 9475ab09d6aSIrina Tirdea } 9485ab09d6aSIrina Tirdea 9495ab09d6aSIrina Tirdea static int __maybe_unused goodix_resume(struct device *dev) 9505ab09d6aSIrina Tirdea { 9515ab09d6aSIrina Tirdea struct i2c_client *client = to_i2c_client(dev); 9525ab09d6aSIrina Tirdea struct goodix_ts_data *ts = i2c_get_clientdata(client); 9535ab09d6aSIrina Tirdea int error; 9545ab09d6aSIrina Tirdea 955faec44b6SHans de Goede if (!ts->gpiod_int || !ts->gpiod_rst) { 956faec44b6SHans de Goede enable_irq(client->irq); 9575ab09d6aSIrina Tirdea return 0; 958faec44b6SHans de Goede } 9595ab09d6aSIrina Tirdea 9605ab09d6aSIrina Tirdea /* 9615ab09d6aSIrina Tirdea * Exit sleep mode by outputting HIGH level to INT pin 9625ab09d6aSIrina Tirdea * for 2ms~5ms. 9635ab09d6aSIrina Tirdea */ 9645ab09d6aSIrina Tirdea error = gpiod_direction_output(ts->gpiod_int, 1); 9655ab09d6aSIrina Tirdea if (error) 9665ab09d6aSIrina Tirdea return error; 9675ab09d6aSIrina Tirdea 9685ab09d6aSIrina Tirdea usleep_range(2000, 5000); 9695ab09d6aSIrina Tirdea 9705ab09d6aSIrina Tirdea error = goodix_int_sync(ts); 9715ab09d6aSIrina Tirdea if (error) 9725ab09d6aSIrina Tirdea return error; 9735ab09d6aSIrina Tirdea 9745ab09d6aSIrina Tirdea error = goodix_request_irq(ts); 9755ab09d6aSIrina Tirdea if (error) 9765ab09d6aSIrina Tirdea return error; 9775ab09d6aSIrina Tirdea 9785ab09d6aSIrina Tirdea return 0; 9795ab09d6aSIrina Tirdea } 9805ab09d6aSIrina Tirdea 9815ab09d6aSIrina Tirdea static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume); 9825ab09d6aSIrina Tirdea 983ca96ea86SBastien Nocera static const struct i2c_device_id goodix_ts_id[] = { 984ca96ea86SBastien Nocera { "GDIX1001:00", 0 }, 985ca96ea86SBastien Nocera { } 986ca96ea86SBastien Nocera }; 9872e9e910eSJavier Martinez Canillas MODULE_DEVICE_TABLE(i2c, goodix_ts_id); 988ca96ea86SBastien Nocera 989771d8f1bSAleksei Mamlin #ifdef CONFIG_ACPI 990ca96ea86SBastien Nocera static const struct acpi_device_id goodix_acpi_match[] = { 991ca96ea86SBastien Nocera { "GDIX1001", 0 }, 9925ca4d1aeSEthan Lee { "GDIX1002", 0 }, 993ca96ea86SBastien Nocera { } 994ca96ea86SBastien Nocera }; 995ca96ea86SBastien Nocera MODULE_DEVICE_TABLE(acpi, goodix_acpi_match); 996771d8f1bSAleksei Mamlin #endif 997771d8f1bSAleksei Mamlin 998771d8f1bSAleksei Mamlin #ifdef CONFIG_OF 999771d8f1bSAleksei Mamlin static const struct of_device_id goodix_of_match[] = { 100025309004SMarcin Niestroj { .compatible = "goodix,gt1151" }, 1001a5f50c50SJagan Teki { .compatible = "goodix,gt5663" }, 100284ef1b33SGuido Günther { .compatible = "goodix,gt5688" }, 1003771d8f1bSAleksei Mamlin { .compatible = "goodix,gt911" }, 1004771d8f1bSAleksei Mamlin { .compatible = "goodix,gt9110" }, 1005771d8f1bSAleksei Mamlin { .compatible = "goodix,gt912" }, 1006771d8f1bSAleksei Mamlin { .compatible = "goodix,gt927" }, 1007771d8f1bSAleksei Mamlin { .compatible = "goodix,gt9271" }, 1008771d8f1bSAleksei Mamlin { .compatible = "goodix,gt928" }, 1009771d8f1bSAleksei Mamlin { .compatible = "goodix,gt967" }, 1010771d8f1bSAleksei Mamlin { } 1011771d8f1bSAleksei Mamlin }; 1012771d8f1bSAleksei Mamlin MODULE_DEVICE_TABLE(of, goodix_of_match); 1013771d8f1bSAleksei Mamlin #endif 1014ca96ea86SBastien Nocera 1015ca96ea86SBastien Nocera static struct i2c_driver goodix_ts_driver = { 1016ca96ea86SBastien Nocera .probe = goodix_ts_probe, 101768caf858SIrina Tirdea .remove = goodix_ts_remove, 1018ca96ea86SBastien Nocera .id_table = goodix_ts_id, 1019ca96ea86SBastien Nocera .driver = { 1020ca96ea86SBastien Nocera .name = "Goodix-TS", 1021771d8f1bSAleksei Mamlin .acpi_match_table = ACPI_PTR(goodix_acpi_match), 1022771d8f1bSAleksei Mamlin .of_match_table = of_match_ptr(goodix_of_match), 10235ab09d6aSIrina Tirdea .pm = &goodix_pm_ops, 1024ca96ea86SBastien Nocera }, 1025ca96ea86SBastien Nocera }; 1026ca96ea86SBastien Nocera module_i2c_driver(goodix_ts_driver); 1027ca96ea86SBastien Nocera 1028ca96ea86SBastien Nocera MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>"); 1029ca96ea86SBastien Nocera MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>"); 1030ca96ea86SBastien Nocera MODULE_DESCRIPTION("Goodix touchscreen driver"); 1031ca96ea86SBastien Nocera MODULE_LICENSE("GPL v2"); 1032