Loading...
Note: File does not exist in v3.1.
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Driver for Goodix Touchscreens
4 *
5 * Copyright (c) 2014 Red Hat Inc.
6 * Copyright (c) 2015 K. Merker <merker@debian.org>
7 *
8 * This code is based on gt9xx.c authored by andrew@goodix.com:
9 *
10 * 2010 - 2012 Goodix Technology.
11 */
12
13
14#include <linux/kernel.h>
15#include <linux/dmi.h>
16#include <linux/firmware.h>
17#include <linux/module.h>
18#include <linux/delay.h>
19#include <linux/irq.h>
20#include <linux/interrupt.h>
21#include <linux/platform_data/x86/soc.h>
22#include <linux/slab.h>
23#include <linux/acpi.h>
24#include <linux/of.h>
25#include <asm/unaligned.h>
26#include "goodix.h"
27
28#define GOODIX_GPIO_INT_NAME "irq"
29#define GOODIX_GPIO_RST_NAME "reset"
30
31#define GOODIX_MAX_HEIGHT 4096
32#define GOODIX_MAX_WIDTH 4096
33#define GOODIX_INT_TRIGGER 1
34#define GOODIX_CONTACT_SIZE 8
35#define GOODIX_MAX_CONTACT_SIZE 9
36#define GOODIX_MAX_CONTACTS 10
37
38#define GOODIX_CONFIG_MIN_LENGTH 186
39#define GOODIX_CONFIG_911_LENGTH 186
40#define GOODIX_CONFIG_967_LENGTH 228
41#define GOODIX_CONFIG_GT9X_LENGTH 240
42
43#define GOODIX_BUFFER_STATUS_READY BIT(7)
44#define GOODIX_HAVE_KEY BIT(4)
45#define GOODIX_BUFFER_STATUS_TIMEOUT 20
46
47#define RESOLUTION_LOC 1
48#define MAX_CONTACTS_LOC 5
49#define TRIGGER_LOC 6
50
51/* Our special handling for GPIO accesses through ACPI is x86 specific */
52#if defined CONFIG_X86 && defined CONFIG_ACPI
53#define ACPI_GPIO_SUPPORT
54#endif
55
56struct goodix_chip_id {
57 const char *id;
58 const struct goodix_chip_data *data;
59};
60
61static int goodix_check_cfg_8(struct goodix_ts_data *ts,
62 const u8 *cfg, int len);
63static int goodix_check_cfg_16(struct goodix_ts_data *ts,
64 const u8 *cfg, int len);
65static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts);
66static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts);
67
68static const struct goodix_chip_data gt1x_chip_data = {
69 .config_addr = GOODIX_GT1X_REG_CONFIG_DATA,
70 .config_len = GOODIX_CONFIG_GT9X_LENGTH,
71 .check_config = goodix_check_cfg_16,
72 .calc_config_checksum = goodix_calc_cfg_checksum_16,
73};
74
75static const struct goodix_chip_data gt911_chip_data = {
76 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA,
77 .config_len = GOODIX_CONFIG_911_LENGTH,
78 .check_config = goodix_check_cfg_8,
79 .calc_config_checksum = goodix_calc_cfg_checksum_8,
80};
81
82static const struct goodix_chip_data gt967_chip_data = {
83 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA,
84 .config_len = GOODIX_CONFIG_967_LENGTH,
85 .check_config = goodix_check_cfg_8,
86 .calc_config_checksum = goodix_calc_cfg_checksum_8,
87};
88
89static const struct goodix_chip_data gt9x_chip_data = {
90 .config_addr = GOODIX_GT9X_REG_CONFIG_DATA,
91 .config_len = GOODIX_CONFIG_GT9X_LENGTH,
92 .check_config = goodix_check_cfg_8,
93 .calc_config_checksum = goodix_calc_cfg_checksum_8,
94};
95
96static const struct goodix_chip_id goodix_chip_ids[] = {
97 { .id = "1151", .data = >1x_chip_data },
98 { .id = "1158", .data = >1x_chip_data },
99 { .id = "5663", .data = >1x_chip_data },
100 { .id = "5688", .data = >1x_chip_data },
101 { .id = "917S", .data = >1x_chip_data },
102 { .id = "9286", .data = >1x_chip_data },
103
104 { .id = "911", .data = >911_chip_data },
105 { .id = "9271", .data = >911_chip_data },
106 { .id = "9110", .data = >911_chip_data },
107 { .id = "9111", .data = >911_chip_data },
108 { .id = "927", .data = >911_chip_data },
109 { .id = "928", .data = >911_chip_data },
110
111 { .id = "912", .data = >967_chip_data },
112 { .id = "9147", .data = >967_chip_data },
113 { .id = "967", .data = >967_chip_data },
114 { }
115};
116
117static const unsigned long goodix_irq_flags[] = {
118 IRQ_TYPE_EDGE_RISING,
119 IRQ_TYPE_EDGE_FALLING,
120 IRQ_TYPE_LEVEL_LOW,
121 IRQ_TYPE_LEVEL_HIGH,
122};
123
124static const struct dmi_system_id nine_bytes_report[] = {
125#if defined(CONFIG_DMI) && defined(CONFIG_X86)
126 {
127 .ident = "Lenovo YogaBook",
128 /* YB1-X91L/F and YB1-X90L/F */
129 .matches = {
130 DMI_MATCH(DMI_PRODUCT_NAME, "Lenovo YB1-X9")
131 }
132 },
133#endif
134 {}
135};
136
137/*
138 * Those tablets have their x coordinate inverted
139 */
140static const struct dmi_system_id inverted_x_screen[] = {
141#if defined(CONFIG_DMI) && defined(CONFIG_X86)
142 {
143 .ident = "Cube I15-TC",
144 .matches = {
145 DMI_MATCH(DMI_SYS_VENDOR, "Cube"),
146 DMI_MATCH(DMI_PRODUCT_NAME, "I15-TC")
147 },
148 },
149#endif
150 {}
151};
152
153/**
154 * goodix_i2c_read - read data from a register of the i2c slave device.
155 *
156 * @client: i2c device.
157 * @reg: the register to read from.
158 * @buf: raw write data buffer.
159 * @len: length of the buffer to write
160 */
161int goodix_i2c_read(struct i2c_client *client, u16 reg, u8 *buf, int len)
162{
163 struct i2c_msg msgs[2];
164 __be16 wbuf = cpu_to_be16(reg);
165 int ret;
166
167 msgs[0].flags = 0;
168 msgs[0].addr = client->addr;
169 msgs[0].len = 2;
170 msgs[0].buf = (u8 *)&wbuf;
171
172 msgs[1].flags = I2C_M_RD;
173 msgs[1].addr = client->addr;
174 msgs[1].len = len;
175 msgs[1].buf = buf;
176
177 ret = i2c_transfer(client->adapter, msgs, 2);
178 if (ret >= 0)
179 ret = (ret == ARRAY_SIZE(msgs) ? 0 : -EIO);
180
181 if (ret)
182 dev_err(&client->dev, "Error reading %d bytes from 0x%04x: %d\n",
183 len, reg, ret);
184 return ret;
185}
186
187/**
188 * goodix_i2c_write - write data to a register of the i2c slave device.
189 *
190 * @client: i2c device.
191 * @reg: the register to write to.
192 * @buf: raw data buffer to write.
193 * @len: length of the buffer to write
194 */
195int goodix_i2c_write(struct i2c_client *client, u16 reg, const u8 *buf, int len)
196{
197 u8 *addr_buf;
198 struct i2c_msg msg;
199 int ret;
200
201 addr_buf = kmalloc(len + 2, GFP_KERNEL);
202 if (!addr_buf)
203 return -ENOMEM;
204
205 addr_buf[0] = reg >> 8;
206 addr_buf[1] = reg & 0xFF;
207 memcpy(&addr_buf[2], buf, len);
208
209 msg.flags = 0;
210 msg.addr = client->addr;
211 msg.buf = addr_buf;
212 msg.len = len + 2;
213
214 ret = i2c_transfer(client->adapter, &msg, 1);
215 if (ret >= 0)
216 ret = (ret == 1 ? 0 : -EIO);
217
218 kfree(addr_buf);
219
220 if (ret)
221 dev_err(&client->dev, "Error writing %d bytes to 0x%04x: %d\n",
222 len, reg, ret);
223 return ret;
224}
225
226int goodix_i2c_write_u8(struct i2c_client *client, u16 reg, u8 value)
227{
228 return goodix_i2c_write(client, reg, &value, sizeof(value));
229}
230
231static const struct goodix_chip_data *goodix_get_chip_data(const char *id)
232{
233 unsigned int i;
234
235 for (i = 0; goodix_chip_ids[i].id; i++) {
236 if (!strcmp(goodix_chip_ids[i].id, id))
237 return goodix_chip_ids[i].data;
238 }
239
240 return >9x_chip_data;
241}
242
243static int goodix_ts_read_input_report(struct goodix_ts_data *ts, u8 *data)
244{
245 unsigned long max_timeout;
246 int touch_num;
247 int error;
248 u16 addr = GOODIX_READ_COOR_ADDR;
249 /*
250 * We are going to read 1-byte header,
251 * ts->contact_size * max(1, touch_num) bytes of coordinates
252 * and 1-byte footer which contains the touch-key code.
253 */
254 const int header_contact_keycode_size = 1 + ts->contact_size + 1;
255
256 /*
257 * The 'buffer status' bit, which indicates that the data is valid, is
258 * not set as soon as the interrupt is raised, but slightly after.
259 * This takes around 10 ms to happen, so we poll for 20 ms.
260 */
261 max_timeout = jiffies + msecs_to_jiffies(GOODIX_BUFFER_STATUS_TIMEOUT);
262 do {
263 error = goodix_i2c_read(ts->client, addr, data,
264 header_contact_keycode_size);
265 if (error)
266 return error;
267
268 if (data[0] & GOODIX_BUFFER_STATUS_READY) {
269 touch_num = data[0] & 0x0f;
270 if (touch_num > ts->max_touch_num)
271 return -EPROTO;
272
273 if (touch_num > 1) {
274 addr += header_contact_keycode_size;
275 data += header_contact_keycode_size;
276 error = goodix_i2c_read(ts->client,
277 addr, data,
278 ts->contact_size *
279 (touch_num - 1));
280 if (error)
281 return error;
282 }
283
284 return touch_num;
285 }
286
287 if (data[0] == 0 && ts->firmware_name) {
288 if (goodix_handle_fw_request(ts))
289 return 0;
290 }
291
292 usleep_range(1000, 2000); /* Poll every 1 - 2 ms */
293 } while (time_before(jiffies, max_timeout));
294
295 /*
296 * The Goodix panel will send spurious interrupts after a
297 * 'finger up' event, which will always cause a timeout.
298 */
299 return -ENOMSG;
300}
301
302static int goodix_create_pen_input(struct goodix_ts_data *ts)
303{
304 struct device *dev = &ts->client->dev;
305 struct input_dev *input;
306
307 input = devm_input_allocate_device(dev);
308 if (!input)
309 return -ENOMEM;
310
311 input_copy_abs(input, ABS_X, ts->input_dev, ABS_MT_POSITION_X);
312 input_copy_abs(input, ABS_Y, ts->input_dev, ABS_MT_POSITION_Y);
313 /*
314 * The resolution of these touchscreens is about 10 units/mm, the actual
315 * resolution does not matter much since we set INPUT_PROP_DIRECT.
316 * Userspace wants something here though, so just set it to 10 units/mm.
317 */
318 input_abs_set_res(input, ABS_X, 10);
319 input_abs_set_res(input, ABS_Y, 10);
320 input_set_abs_params(input, ABS_PRESSURE, 0, 255, 0, 0);
321
322 input_set_capability(input, EV_KEY, BTN_TOUCH);
323 input_set_capability(input, EV_KEY, BTN_TOOL_PEN);
324 input_set_capability(input, EV_KEY, BTN_STYLUS);
325 input_set_capability(input, EV_KEY, BTN_STYLUS2);
326 __set_bit(INPUT_PROP_DIRECT, input->propbit);
327
328 input->name = "Goodix Active Pen";
329 input->phys = "input/pen";
330 input->id.bustype = BUS_I2C;
331 input->id.vendor = 0x0416;
332 if (kstrtou16(ts->id, 10, &input->id.product))
333 input->id.product = 0x1001;
334 input->id.version = ts->version;
335
336 ts->input_pen = input;
337 return 0;
338}
339
340static void goodix_ts_report_pen_down(struct goodix_ts_data *ts, u8 *data)
341{
342 int input_x, input_y, input_w, error;
343 u8 key_value;
344
345 if (!ts->pen_input_registered) {
346 error = input_register_device(ts->input_pen);
347 ts->pen_input_registered = (error == 0) ? 1 : error;
348 }
349
350 if (ts->pen_input_registered < 0)
351 return;
352
353 if (ts->contact_size == 9) {
354 input_x = get_unaligned_le16(&data[4]);
355 input_y = get_unaligned_le16(&data[6]);
356 input_w = get_unaligned_le16(&data[8]);
357 } else {
358 input_x = get_unaligned_le16(&data[2]);
359 input_y = get_unaligned_le16(&data[4]);
360 input_w = get_unaligned_le16(&data[6]);
361 }
362
363 touchscreen_report_pos(ts->input_pen, &ts->prop, input_x, input_y, false);
364 input_report_abs(ts->input_pen, ABS_PRESSURE, input_w);
365
366 input_report_key(ts->input_pen, BTN_TOUCH, 1);
367 input_report_key(ts->input_pen, BTN_TOOL_PEN, 1);
368
369 if (data[0] & GOODIX_HAVE_KEY) {
370 key_value = data[1 + ts->contact_size];
371 input_report_key(ts->input_pen, BTN_STYLUS, key_value & 0x10);
372 input_report_key(ts->input_pen, BTN_STYLUS2, key_value & 0x20);
373 } else {
374 input_report_key(ts->input_pen, BTN_STYLUS, 0);
375 input_report_key(ts->input_pen, BTN_STYLUS2, 0);
376 }
377
378 input_sync(ts->input_pen);
379}
380
381static void goodix_ts_report_pen_up(struct goodix_ts_data *ts)
382{
383 if (!ts->input_pen)
384 return;
385
386 input_report_key(ts->input_pen, BTN_TOUCH, 0);
387 input_report_key(ts->input_pen, BTN_TOOL_PEN, 0);
388 input_report_key(ts->input_pen, BTN_STYLUS, 0);
389 input_report_key(ts->input_pen, BTN_STYLUS2, 0);
390
391 input_sync(ts->input_pen);
392}
393
394static void goodix_ts_report_touch_8b(struct goodix_ts_data *ts, u8 *coor_data)
395{
396 int id = coor_data[0] & 0x0F;
397 int input_x = get_unaligned_le16(&coor_data[1]);
398 int input_y = get_unaligned_le16(&coor_data[3]);
399 int input_w = get_unaligned_le16(&coor_data[5]);
400
401 input_mt_slot(ts->input_dev, id);
402 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
403 touchscreen_report_pos(ts->input_dev, &ts->prop,
404 input_x, input_y, true);
405 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
406 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
407}
408
409static void goodix_ts_report_touch_9b(struct goodix_ts_data *ts, u8 *coor_data)
410{
411 int id = coor_data[1] & 0x0F;
412 int input_x = get_unaligned_le16(&coor_data[3]);
413 int input_y = get_unaligned_le16(&coor_data[5]);
414 int input_w = get_unaligned_le16(&coor_data[7]);
415
416 input_mt_slot(ts->input_dev, id);
417 input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER, true);
418 touchscreen_report_pos(ts->input_dev, &ts->prop,
419 input_x, input_y, true);
420 input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, input_w);
421 input_report_abs(ts->input_dev, ABS_MT_WIDTH_MAJOR, input_w);
422}
423
424static void goodix_ts_release_keys(struct goodix_ts_data *ts)
425{
426 int i;
427
428 for (i = 0; i < GOODIX_MAX_KEYS; i++)
429 input_report_key(ts->input_dev, ts->keymap[i], 0);
430}
431
432static void goodix_ts_report_key(struct goodix_ts_data *ts, u8 *data)
433{
434 int touch_num;
435 u8 key_value;
436 int i;
437
438 if (data[0] & GOODIX_HAVE_KEY) {
439 touch_num = data[0] & 0x0f;
440 key_value = data[1 + ts->contact_size * touch_num];
441 for (i = 0; i < GOODIX_MAX_KEYS; i++)
442 if (key_value & BIT(i))
443 input_report_key(ts->input_dev,
444 ts->keymap[i], 1);
445 } else {
446 goodix_ts_release_keys(ts);
447 }
448}
449
450/**
451 * goodix_process_events - Process incoming events
452 *
453 * @ts: our goodix_ts_data pointer
454 *
455 * Called when the IRQ is triggered. Read the current device state, and push
456 * the input events to the user space.
457 */
458static void goodix_process_events(struct goodix_ts_data *ts)
459{
460 u8 point_data[2 + GOODIX_MAX_CONTACT_SIZE * GOODIX_MAX_CONTACTS];
461 int touch_num;
462 int i;
463
464 touch_num = goodix_ts_read_input_report(ts, point_data);
465 if (touch_num < 0)
466 return;
467
468 /* The pen being down is always reported as a single touch */
469 if (touch_num == 1 && (point_data[1] & 0x80)) {
470 goodix_ts_report_pen_down(ts, point_data);
471 goodix_ts_release_keys(ts);
472 goto sync; /* Release any previously registered touches */
473 } else {
474 goodix_ts_report_pen_up(ts);
475 }
476
477 goodix_ts_report_key(ts, point_data);
478
479 for (i = 0; i < touch_num; i++)
480 if (ts->contact_size == 9)
481 goodix_ts_report_touch_9b(ts,
482 &point_data[1 + ts->contact_size * i]);
483 else
484 goodix_ts_report_touch_8b(ts,
485 &point_data[1 + ts->contact_size * i]);
486
487sync:
488 input_mt_sync_frame(ts->input_dev);
489 input_sync(ts->input_dev);
490}
491
492/**
493 * goodix_ts_irq_handler - The IRQ handler
494 *
495 * @irq: interrupt number.
496 * @dev_id: private data pointer.
497 */
498static irqreturn_t goodix_ts_irq_handler(int irq, void *dev_id)
499{
500 struct goodix_ts_data *ts = dev_id;
501
502 goodix_process_events(ts);
503 goodix_i2c_write_u8(ts->client, GOODIX_READ_COOR_ADDR, 0);
504
505 return IRQ_HANDLED;
506}
507
508static void goodix_free_irq(struct goodix_ts_data *ts)
509{
510 devm_free_irq(&ts->client->dev, ts->client->irq, ts);
511}
512
513static int goodix_request_irq(struct goodix_ts_data *ts)
514{
515 return devm_request_threaded_irq(&ts->client->dev, ts->client->irq,
516 NULL, goodix_ts_irq_handler,
517 ts->irq_flags, ts->client->name, ts);
518}
519
520static int goodix_check_cfg_8(struct goodix_ts_data *ts, const u8 *cfg, int len)
521{
522 int i, raw_cfg_len = len - 2;
523 u8 check_sum = 0;
524
525 for (i = 0; i < raw_cfg_len; i++)
526 check_sum += cfg[i];
527 check_sum = (~check_sum) + 1;
528 if (check_sum != cfg[raw_cfg_len]) {
529 dev_err(&ts->client->dev,
530 "The checksum of the config fw is not correct");
531 return -EINVAL;
532 }
533
534 if (cfg[raw_cfg_len + 1] != 1) {
535 dev_err(&ts->client->dev,
536 "Config fw must have Config_Fresh register set");
537 return -EINVAL;
538 }
539
540 return 0;
541}
542
543static void goodix_calc_cfg_checksum_8(struct goodix_ts_data *ts)
544{
545 int i, raw_cfg_len = ts->chip->config_len - 2;
546 u8 check_sum = 0;
547
548 for (i = 0; i < raw_cfg_len; i++)
549 check_sum += ts->config[i];
550 check_sum = (~check_sum) + 1;
551
552 ts->config[raw_cfg_len] = check_sum;
553 ts->config[raw_cfg_len + 1] = 1; /* Set "config_fresh" bit */
554}
555
556static int goodix_check_cfg_16(struct goodix_ts_data *ts, const u8 *cfg,
557 int len)
558{
559 int i, raw_cfg_len = len - 3;
560 u16 check_sum = 0;
561
562 for (i = 0; i < raw_cfg_len; i += 2)
563 check_sum += get_unaligned_be16(&cfg[i]);
564 check_sum = (~check_sum) + 1;
565 if (check_sum != get_unaligned_be16(&cfg[raw_cfg_len])) {
566 dev_err(&ts->client->dev,
567 "The checksum of the config fw is not correct");
568 return -EINVAL;
569 }
570
571 if (cfg[raw_cfg_len + 2] != 1) {
572 dev_err(&ts->client->dev,
573 "Config fw must have Config_Fresh register set");
574 return -EINVAL;
575 }
576
577 return 0;
578}
579
580static void goodix_calc_cfg_checksum_16(struct goodix_ts_data *ts)
581{
582 int i, raw_cfg_len = ts->chip->config_len - 3;
583 u16 check_sum = 0;
584
585 for (i = 0; i < raw_cfg_len; i += 2)
586 check_sum += get_unaligned_be16(&ts->config[i]);
587 check_sum = (~check_sum) + 1;
588
589 put_unaligned_be16(check_sum, &ts->config[raw_cfg_len]);
590 ts->config[raw_cfg_len + 2] = 1; /* Set "config_fresh" bit */
591}
592
593/**
594 * goodix_check_cfg - Checks if config fw is valid
595 *
596 * @ts: goodix_ts_data pointer
597 * @cfg: firmware config data
598 * @len: config data length
599 */
600static int goodix_check_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
601{
602 if (len < GOODIX_CONFIG_MIN_LENGTH ||
603 len > GOODIX_CONFIG_MAX_LENGTH) {
604 dev_err(&ts->client->dev,
605 "The length of the config fw is not correct");
606 return -EINVAL;
607 }
608
609 return ts->chip->check_config(ts, cfg, len);
610}
611
612/**
613 * goodix_send_cfg - Write fw config to device
614 *
615 * @ts: goodix_ts_data pointer
616 * @cfg: config firmware to write to device
617 * @len: config data length
618 */
619int goodix_send_cfg(struct goodix_ts_data *ts, const u8 *cfg, int len)
620{
621 int error;
622
623 error = goodix_check_cfg(ts, cfg, len);
624 if (error)
625 return error;
626
627 error = goodix_i2c_write(ts->client, ts->chip->config_addr, cfg, len);
628 if (error)
629 return error;
630
631 dev_dbg(&ts->client->dev, "Config sent successfully.");
632
633 /* Let the firmware reconfigure itself, so sleep for 10ms */
634 usleep_range(10000, 11000);
635
636 return 0;
637}
638
639#ifdef ACPI_GPIO_SUPPORT
640static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
641{
642 acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
643 acpi_status status;
644
645 status = acpi_evaluate_object(handle, "INTI", NULL, NULL);
646 return ACPI_SUCCESS(status) ? 0 : -EIO;
647}
648
649static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
650{
651 acpi_handle handle = ACPI_HANDLE(&ts->client->dev);
652 acpi_status status;
653
654 status = acpi_execute_simple_method(handle, "INTO", value);
655 return ACPI_SUCCESS(status) ? 0 : -EIO;
656}
657#else
658static int goodix_pin_acpi_direction_input(struct goodix_ts_data *ts)
659{
660 dev_err(&ts->client->dev,
661 "%s called on device without ACPI support\n", __func__);
662 return -EINVAL;
663}
664
665static int goodix_pin_acpi_output_method(struct goodix_ts_data *ts, int value)
666{
667 dev_err(&ts->client->dev,
668 "%s called on device without ACPI support\n", __func__);
669 return -EINVAL;
670}
671#endif
672
673static int goodix_irq_direction_output(struct goodix_ts_data *ts, int value)
674{
675 switch (ts->irq_pin_access_method) {
676 case IRQ_PIN_ACCESS_NONE:
677 dev_err(&ts->client->dev,
678 "%s called without an irq_pin_access_method set\n",
679 __func__);
680 return -EINVAL;
681 case IRQ_PIN_ACCESS_GPIO:
682 return gpiod_direction_output(ts->gpiod_int, value);
683 case IRQ_PIN_ACCESS_ACPI_GPIO:
684 /*
685 * The IRQ pin triggers on a falling edge, so its gets marked
686 * as active-low, use output_raw to avoid the value inversion.
687 */
688 return gpiod_direction_output_raw(ts->gpiod_int, value);
689 case IRQ_PIN_ACCESS_ACPI_METHOD:
690 return goodix_pin_acpi_output_method(ts, value);
691 }
692
693 return -EINVAL; /* Never reached */
694}
695
696static int goodix_irq_direction_input(struct goodix_ts_data *ts)
697{
698 switch (ts->irq_pin_access_method) {
699 case IRQ_PIN_ACCESS_NONE:
700 dev_err(&ts->client->dev,
701 "%s called without an irq_pin_access_method set\n",
702 __func__);
703 return -EINVAL;
704 case IRQ_PIN_ACCESS_GPIO:
705 return gpiod_direction_input(ts->gpiod_int);
706 case IRQ_PIN_ACCESS_ACPI_GPIO:
707 return gpiod_direction_input(ts->gpiod_int);
708 case IRQ_PIN_ACCESS_ACPI_METHOD:
709 return goodix_pin_acpi_direction_input(ts);
710 }
711
712 return -EINVAL; /* Never reached */
713}
714
715int goodix_int_sync(struct goodix_ts_data *ts)
716{
717 int error;
718
719 error = goodix_irq_direction_output(ts, 0);
720 if (error)
721 goto error;
722
723 msleep(50); /* T5: 50ms */
724
725 error = goodix_irq_direction_input(ts);
726 if (error)
727 goto error;
728
729 return 0;
730
731error:
732 dev_err(&ts->client->dev, "Controller irq sync failed.\n");
733 return error;
734}
735
736/**
737 * goodix_reset_no_int_sync - Reset device, leaving interrupt line in output mode
738 *
739 * @ts: goodix_ts_data pointer
740 */
741int goodix_reset_no_int_sync(struct goodix_ts_data *ts)
742{
743 int error;
744
745 /* begin select I2C slave addr */
746 error = gpiod_direction_output(ts->gpiod_rst, 0);
747 if (error)
748 goto error;
749
750 msleep(20); /* T2: > 10ms */
751
752 /* HIGH: 0x28/0x29, LOW: 0xBA/0xBB */
753 error = goodix_irq_direction_output(ts, ts->client->addr == 0x14);
754 if (error)
755 goto error;
756
757 usleep_range(100, 2000); /* T3: > 100us */
758
759 error = gpiod_direction_output(ts->gpiod_rst, 1);
760 if (error)
761 goto error;
762
763 usleep_range(6000, 10000); /* T4: > 5ms */
764
765 /*
766 * Put the reset pin back in to input / high-impedance mode to save
767 * power. Only do this in the non ACPI case since some ACPI boards
768 * don't have a pull-up, so there the reset pin must stay active-high.
769 */
770 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_GPIO) {
771 error = gpiod_direction_input(ts->gpiod_rst);
772 if (error)
773 goto error;
774 }
775
776 return 0;
777
778error:
779 dev_err(&ts->client->dev, "Controller reset failed.\n");
780 return error;
781}
782
783/**
784 * goodix_reset - Reset device during power on
785 *
786 * @ts: goodix_ts_data pointer
787 */
788static int goodix_reset(struct goodix_ts_data *ts)
789{
790 int error;
791
792 error = goodix_reset_no_int_sync(ts);
793 if (error)
794 return error;
795
796 return goodix_int_sync(ts);
797}
798
799#ifdef ACPI_GPIO_SUPPORT
800static const struct acpi_gpio_params first_gpio = { 0, 0, false };
801static const struct acpi_gpio_params second_gpio = { 1, 0, false };
802
803static const struct acpi_gpio_mapping acpi_goodix_int_first_gpios[] = {
804 { GOODIX_GPIO_INT_NAME "-gpios", &first_gpio, 1 },
805 { GOODIX_GPIO_RST_NAME "-gpios", &second_gpio, 1 },
806 { },
807};
808
809static const struct acpi_gpio_mapping acpi_goodix_int_last_gpios[] = {
810 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
811 { GOODIX_GPIO_INT_NAME "-gpios", &second_gpio, 1 },
812 { },
813};
814
815static const struct acpi_gpio_mapping acpi_goodix_reset_only_gpios[] = {
816 { GOODIX_GPIO_RST_NAME "-gpios", &first_gpio, 1 },
817 { },
818};
819
820static int goodix_resource(struct acpi_resource *ares, void *data)
821{
822 struct goodix_ts_data *ts = data;
823 struct device *dev = &ts->client->dev;
824 struct acpi_resource_gpio *gpio;
825
826 if (acpi_gpio_get_irq_resource(ares, &gpio)) {
827 if (ts->gpio_int_idx == -1) {
828 ts->gpio_int_idx = ts->gpio_count;
829 } else {
830 dev_err(dev, "More then one GpioInt resource, ignoring ACPI GPIO resources\n");
831 ts->gpio_int_idx = -2;
832 }
833 ts->gpio_count++;
834 } else if (acpi_gpio_get_io_resource(ares, &gpio))
835 ts->gpio_count++;
836
837 return 0;
838}
839
840/*
841 * This function gets called in case we fail to get the irq GPIO directly
842 * because the ACPI tables lack GPIO-name to APCI _CRS index mappings
843 * (no _DSD UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 data).
844 * In that case we add our own mapping and then goodix_get_gpio_config()
845 * retries to get the GPIOs based on the added mapping.
846 */
847static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
848{
849 const struct acpi_gpio_mapping *gpio_mapping = NULL;
850 struct device *dev = &ts->client->dev;
851 LIST_HEAD(resources);
852 int irq, ret;
853
854 ts->gpio_count = 0;
855 ts->gpio_int_idx = -1;
856 ret = acpi_dev_get_resources(ACPI_COMPANION(dev), &resources,
857 goodix_resource, ts);
858 if (ret < 0) {
859 dev_err(dev, "Error getting ACPI resources: %d\n", ret);
860 return ret;
861 }
862
863 acpi_dev_free_resource_list(&resources);
864
865 /*
866 * CHT devices should have a GpioInt + a regular GPIO ACPI resource.
867 * Some CHT devices have a bug (where the also is bogus Interrupt
868 * resource copied from a previous BYT based generation). i2c-core-acpi
869 * will use the non-working Interrupt resource, fix this up.
870 */
871 if (soc_intel_is_cht() && ts->gpio_count == 2 && ts->gpio_int_idx != -1) {
872 irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
873 if (irq > 0 && irq != ts->client->irq) {
874 dev_warn(dev, "Overriding IRQ %d -> %d\n", ts->client->irq, irq);
875 ts->client->irq = irq;
876 }
877 }
878
879 if (ts->gpio_count == 2 && ts->gpio_int_idx == 0) {
880 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
881 gpio_mapping = acpi_goodix_int_first_gpios;
882 } else if (ts->gpio_count == 2 && ts->gpio_int_idx == 1) {
883 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
884 gpio_mapping = acpi_goodix_int_last_gpios;
885 } else if (ts->gpio_count == 1 && ts->gpio_int_idx == -1 &&
886 acpi_has_method(ACPI_HANDLE(dev), "INTI") &&
887 acpi_has_method(ACPI_HANDLE(dev), "INTO")) {
888 dev_info(dev, "Using ACPI INTI and INTO methods for IRQ pin access\n");
889 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_METHOD;
890 gpio_mapping = acpi_goodix_reset_only_gpios;
891 } else if (soc_intel_is_byt() && ts->gpio_count == 2 && ts->gpio_int_idx == -1) {
892 dev_info(dev, "No ACPI GpioInt resource, assuming that the GPIO order is reset, int\n");
893 ts->irq_pin_access_method = IRQ_PIN_ACCESS_ACPI_GPIO;
894 gpio_mapping = acpi_goodix_int_last_gpios;
895 } else {
896 dev_warn(dev, "Unexpected ACPI resources: gpio_count %d, gpio_int_idx %d\n",
897 ts->gpio_count, ts->gpio_int_idx);
898 /*
899 * On some devices _PS0 does a reset for us and
900 * sometimes this is necessary for things to work.
901 */
902 acpi_device_fix_up_power(ACPI_COMPANION(dev));
903 return -EINVAL;
904 }
905
906 /*
907 * Normally we put the reset pin in input / high-impedance mode to save
908 * power. But some x86/ACPI boards don't have a pull-up, so for the ACPI
909 * case, leave the pin as is. This results in the pin not being touched
910 * at all on x86/ACPI boards, except when needed for error-recover.
911 */
912 ts->gpiod_rst_flags = GPIOD_ASIS;
913
914 return devm_acpi_dev_add_driver_gpios(dev, gpio_mapping);
915}
916#else
917static int goodix_add_acpi_gpio_mappings(struct goodix_ts_data *ts)
918{
919 return -EINVAL;
920}
921#endif /* CONFIG_X86 && CONFIG_ACPI */
922
923/**
924 * goodix_get_gpio_config - Get GPIO config from ACPI/DT
925 *
926 * @ts: goodix_ts_data pointer
927 */
928static int goodix_get_gpio_config(struct goodix_ts_data *ts)
929{
930 int error;
931 struct device *dev;
932 struct gpio_desc *gpiod;
933 bool added_acpi_mappings = false;
934
935 if (!ts->client)
936 return -EINVAL;
937 dev = &ts->client->dev;
938
939 /*
940 * By default we request the reset pin as input, leaving it in
941 * high-impedance when not resetting the controller to save power.
942 */
943 ts->gpiod_rst_flags = GPIOD_IN;
944
945 ts->avdd28 = devm_regulator_get(dev, "AVDD28");
946 if (IS_ERR(ts->avdd28)) {
947 error = PTR_ERR(ts->avdd28);
948 if (error != -EPROBE_DEFER)
949 dev_err(dev,
950 "Failed to get AVDD28 regulator: %d\n", error);
951 return error;
952 }
953
954 ts->vddio = devm_regulator_get(dev, "VDDIO");
955 if (IS_ERR(ts->vddio)) {
956 error = PTR_ERR(ts->vddio);
957 if (error != -EPROBE_DEFER)
958 dev_err(dev,
959 "Failed to get VDDIO regulator: %d\n", error);
960 return error;
961 }
962
963retry_get_irq_gpio:
964 /* Get the interrupt GPIO pin number */
965 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_INT_NAME, GPIOD_IN);
966 if (IS_ERR(gpiod)) {
967 error = PTR_ERR(gpiod);
968 if (error != -EPROBE_DEFER)
969 dev_err(dev, "Failed to get %s GPIO: %d\n",
970 GOODIX_GPIO_INT_NAME, error);
971 return error;
972 }
973 if (!gpiod && has_acpi_companion(dev) && !added_acpi_mappings) {
974 added_acpi_mappings = true;
975 if (goodix_add_acpi_gpio_mappings(ts) == 0)
976 goto retry_get_irq_gpio;
977 }
978
979 ts->gpiod_int = gpiod;
980
981 /* Get the reset line GPIO pin number */
982 gpiod = devm_gpiod_get_optional(dev, GOODIX_GPIO_RST_NAME, ts->gpiod_rst_flags);
983 if (IS_ERR(gpiod)) {
984 error = PTR_ERR(gpiod);
985 if (error != -EPROBE_DEFER)
986 dev_err(dev, "Failed to get %s GPIO: %d\n",
987 GOODIX_GPIO_RST_NAME, error);
988 return error;
989 }
990
991 ts->gpiod_rst = gpiod;
992
993 switch (ts->irq_pin_access_method) {
994 case IRQ_PIN_ACCESS_ACPI_GPIO:
995 /*
996 * We end up here if goodix_add_acpi_gpio_mappings() has
997 * called devm_acpi_dev_add_driver_gpios() because the ACPI
998 * tables did not contain name to index mappings.
999 * Check that we successfully got both GPIOs after we've
1000 * added our own acpi_gpio_mapping and if we did not get both
1001 * GPIOs reset irq_pin_access_method to IRQ_PIN_ACCESS_NONE.
1002 */
1003 if (!ts->gpiod_int || !ts->gpiod_rst)
1004 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
1005 break;
1006 case IRQ_PIN_ACCESS_ACPI_METHOD:
1007 if (!ts->gpiod_rst)
1008 ts->irq_pin_access_method = IRQ_PIN_ACCESS_NONE;
1009 break;
1010 default:
1011 if (ts->gpiod_int && ts->gpiod_rst) {
1012 ts->reset_controller_at_probe = true;
1013 ts->load_cfg_from_disk = true;
1014 ts->irq_pin_access_method = IRQ_PIN_ACCESS_GPIO;
1015 }
1016 }
1017
1018 return 0;
1019}
1020
1021/**
1022 * goodix_read_config - Read the embedded configuration of the panel
1023 *
1024 * @ts: our goodix_ts_data pointer
1025 *
1026 * Must be called during probe
1027 */
1028static void goodix_read_config(struct goodix_ts_data *ts)
1029{
1030 int x_max, y_max;
1031 int error;
1032
1033 /*
1034 * On controllers where we need to upload the firmware
1035 * (controllers without flash) ts->config already has the config
1036 * at this point and the controller itself does not have it yet!
1037 */
1038 if (!ts->firmware_name) {
1039 error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1040 ts->config, ts->chip->config_len);
1041 if (error) {
1042 ts->int_trigger_type = GOODIX_INT_TRIGGER;
1043 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1044 return;
1045 }
1046 }
1047
1048 ts->int_trigger_type = ts->config[TRIGGER_LOC] & 0x03;
1049 ts->max_touch_num = ts->config[MAX_CONTACTS_LOC] & 0x0f;
1050
1051 x_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC]);
1052 y_max = get_unaligned_le16(&ts->config[RESOLUTION_LOC + 2]);
1053 if (x_max && y_max) {
1054 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_X, x_max - 1);
1055 input_abs_set_max(ts->input_dev, ABS_MT_POSITION_Y, y_max - 1);
1056 }
1057
1058 ts->chip->calc_config_checksum(ts);
1059}
1060
1061/**
1062 * goodix_read_version - Read goodix touchscreen version
1063 *
1064 * @ts: our goodix_ts_data pointer
1065 */
1066static int goodix_read_version(struct goodix_ts_data *ts)
1067{
1068 int error;
1069 u8 buf[6];
1070 char id_str[GOODIX_ID_MAX_LEN + 1];
1071
1072 error = goodix_i2c_read(ts->client, GOODIX_REG_ID, buf, sizeof(buf));
1073 if (error)
1074 return error;
1075
1076 memcpy(id_str, buf, GOODIX_ID_MAX_LEN);
1077 id_str[GOODIX_ID_MAX_LEN] = 0;
1078 strscpy(ts->id, id_str, GOODIX_ID_MAX_LEN + 1);
1079
1080 ts->version = get_unaligned_le16(&buf[4]);
1081
1082 dev_info(&ts->client->dev, "ID %s, version: %04x\n", ts->id,
1083 ts->version);
1084
1085 return 0;
1086}
1087
1088/**
1089 * goodix_i2c_test - I2C test function to check if the device answers.
1090 *
1091 * @client: the i2c client
1092 */
1093static int goodix_i2c_test(struct i2c_client *client)
1094{
1095 int retry = 0;
1096 int error;
1097 u8 test;
1098
1099 while (retry++ < 2) {
1100 error = goodix_i2c_read(client, GOODIX_REG_ID, &test, 1);
1101 if (!error)
1102 return 0;
1103
1104 msleep(20);
1105 }
1106
1107 return error;
1108}
1109
1110/**
1111 * goodix_configure_dev - Finish device initialization
1112 *
1113 * @ts: our goodix_ts_data pointer
1114 *
1115 * Must be called from probe to finish initialization of the device.
1116 * Contains the common initialization code for both devices that
1117 * declare gpio pins and devices that do not. It is either called
1118 * directly from probe or from request_firmware_wait callback.
1119 */
1120static int goodix_configure_dev(struct goodix_ts_data *ts)
1121{
1122 int error;
1123 int i;
1124
1125 ts->int_trigger_type = GOODIX_INT_TRIGGER;
1126 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1127
1128 ts->input_dev = devm_input_allocate_device(&ts->client->dev);
1129 if (!ts->input_dev) {
1130 dev_err(&ts->client->dev, "Failed to allocate input device.");
1131 return -ENOMEM;
1132 }
1133
1134 ts->input_dev->name = "Goodix Capacitive TouchScreen";
1135 ts->input_dev->phys = "input/ts";
1136 ts->input_dev->id.bustype = BUS_I2C;
1137 ts->input_dev->id.vendor = 0x0416;
1138 if (kstrtou16(ts->id, 10, &ts->input_dev->id.product))
1139 ts->input_dev->id.product = 0x1001;
1140 ts->input_dev->id.version = ts->version;
1141
1142 ts->input_dev->keycode = ts->keymap;
1143 ts->input_dev->keycodesize = sizeof(ts->keymap[0]);
1144 ts->input_dev->keycodemax = GOODIX_MAX_KEYS;
1145
1146 /* Capacitive Windows/Home button on some devices */
1147 for (i = 0; i < GOODIX_MAX_KEYS; ++i) {
1148 if (i == 0)
1149 ts->keymap[i] = KEY_LEFTMETA;
1150 else
1151 ts->keymap[i] = KEY_F1 + (i - 1);
1152
1153 input_set_capability(ts->input_dev, EV_KEY, ts->keymap[i]);
1154 }
1155
1156 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_X);
1157 input_set_capability(ts->input_dev, EV_ABS, ABS_MT_POSITION_Y);
1158 input_set_abs_params(ts->input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
1159 input_set_abs_params(ts->input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
1160
1161retry_read_config:
1162 /* Read configuration and apply touchscreen parameters */
1163 goodix_read_config(ts);
1164
1165 /* Try overriding touchscreen parameters via device properties */
1166 touchscreen_parse_properties(ts->input_dev, true, &ts->prop);
1167
1168 if (!ts->prop.max_x || !ts->prop.max_y || !ts->max_touch_num) {
1169 if (!ts->reset_controller_at_probe &&
1170 ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
1171 dev_info(&ts->client->dev, "Config not set, resetting controller\n");
1172 /* Retry after a controller reset */
1173 ts->reset_controller_at_probe = true;
1174 error = goodix_reset(ts);
1175 if (error)
1176 return error;
1177 goto retry_read_config;
1178 }
1179 dev_err(&ts->client->dev,
1180 "Invalid config (%d, %d, %d), using defaults\n",
1181 ts->prop.max_x, ts->prop.max_y, ts->max_touch_num);
1182 ts->prop.max_x = GOODIX_MAX_WIDTH - 1;
1183 ts->prop.max_y = GOODIX_MAX_HEIGHT - 1;
1184 ts->max_touch_num = GOODIX_MAX_CONTACTS;
1185 input_abs_set_max(ts->input_dev,
1186 ABS_MT_POSITION_X, ts->prop.max_x);
1187 input_abs_set_max(ts->input_dev,
1188 ABS_MT_POSITION_Y, ts->prop.max_y);
1189 }
1190
1191 if (dmi_check_system(nine_bytes_report)) {
1192 ts->contact_size = 9;
1193
1194 dev_dbg(&ts->client->dev,
1195 "Non-standard 9-bytes report format quirk\n");
1196 }
1197
1198 if (dmi_check_system(inverted_x_screen)) {
1199 ts->prop.invert_x = true;
1200 dev_dbg(&ts->client->dev,
1201 "Applying 'inverted x screen' quirk\n");
1202 }
1203
1204 error = input_mt_init_slots(ts->input_dev, ts->max_touch_num,
1205 INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
1206 if (error) {
1207 dev_err(&ts->client->dev,
1208 "Failed to initialize MT slots: %d", error);
1209 return error;
1210 }
1211
1212 error = input_register_device(ts->input_dev);
1213 if (error) {
1214 dev_err(&ts->client->dev,
1215 "Failed to register input device: %d", error);
1216 return error;
1217 }
1218
1219 /*
1220 * Create the input_pen device before goodix_request_irq() calls
1221 * devm_request_threaded_irq() so that the devm framework frees
1222 * it after disabling the irq.
1223 * Unfortunately there is no way to detect if the touchscreen has pen
1224 * support, so registering the dev is delayed till the first pen event.
1225 */
1226 error = goodix_create_pen_input(ts);
1227 if (error)
1228 return error;
1229
1230 ts->irq_flags = goodix_irq_flags[ts->int_trigger_type] | IRQF_ONESHOT;
1231 error = goodix_request_irq(ts);
1232 if (error) {
1233 dev_err(&ts->client->dev, "request IRQ failed: %d\n", error);
1234 return error;
1235 }
1236
1237 return 0;
1238}
1239
1240/**
1241 * goodix_config_cb - Callback to finish device init
1242 *
1243 * @cfg: firmware config
1244 * @ctx: our goodix_ts_data pointer
1245 *
1246 * request_firmware_wait callback that finishes
1247 * initialization of the device.
1248 */
1249static void goodix_config_cb(const struct firmware *cfg, void *ctx)
1250{
1251 struct goodix_ts_data *ts = ctx;
1252 int error;
1253
1254 if (ts->firmware_name) {
1255 if (!cfg)
1256 goto err_release_cfg;
1257
1258 error = goodix_check_cfg(ts, cfg->data, cfg->size);
1259 if (error)
1260 goto err_release_cfg;
1261
1262 memcpy(ts->config, cfg->data, cfg->size);
1263 } else if (cfg) {
1264 /* send device configuration to the firmware */
1265 error = goodix_send_cfg(ts, cfg->data, cfg->size);
1266 if (error)
1267 goto err_release_cfg;
1268 }
1269
1270 goodix_configure_dev(ts);
1271
1272err_release_cfg:
1273 release_firmware(cfg);
1274 complete_all(&ts->firmware_loading_complete);
1275}
1276
1277static void goodix_disable_regulators(void *arg)
1278{
1279 struct goodix_ts_data *ts = arg;
1280
1281 regulator_disable(ts->vddio);
1282 regulator_disable(ts->avdd28);
1283}
1284
1285static int goodix_ts_probe(struct i2c_client *client)
1286{
1287 struct goodix_ts_data *ts;
1288 const char *cfg_name;
1289 int error;
1290
1291 dev_dbg(&client->dev, "I2C Address: 0x%02x\n", client->addr);
1292
1293 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1294 dev_err(&client->dev, "I2C check functionality failed.\n");
1295 return -ENXIO;
1296 }
1297
1298 ts = devm_kzalloc(&client->dev, sizeof(*ts), GFP_KERNEL);
1299 if (!ts)
1300 return -ENOMEM;
1301
1302 ts->client = client;
1303 i2c_set_clientdata(client, ts);
1304 init_completion(&ts->firmware_loading_complete);
1305 ts->contact_size = GOODIX_CONTACT_SIZE;
1306
1307 error = goodix_get_gpio_config(ts);
1308 if (error)
1309 return error;
1310
1311 /* power up the controller */
1312 error = regulator_enable(ts->avdd28);
1313 if (error) {
1314 dev_err(&client->dev,
1315 "Failed to enable AVDD28 regulator: %d\n",
1316 error);
1317 return error;
1318 }
1319
1320 error = regulator_enable(ts->vddio);
1321 if (error) {
1322 dev_err(&client->dev,
1323 "Failed to enable VDDIO regulator: %d\n",
1324 error);
1325 regulator_disable(ts->avdd28);
1326 return error;
1327 }
1328
1329 error = devm_add_action_or_reset(&client->dev,
1330 goodix_disable_regulators, ts);
1331 if (error)
1332 return error;
1333
1334reset:
1335 if (ts->reset_controller_at_probe) {
1336 /* reset the controller */
1337 error = goodix_reset(ts);
1338 if (error)
1339 return error;
1340 }
1341
1342 error = goodix_i2c_test(client);
1343 if (error) {
1344 if (!ts->reset_controller_at_probe &&
1345 ts->irq_pin_access_method != IRQ_PIN_ACCESS_NONE) {
1346 /* Retry after a controller reset */
1347 ts->reset_controller_at_probe = true;
1348 goto reset;
1349 }
1350 dev_err(&client->dev, "I2C communication failure: %d\n", error);
1351 return error;
1352 }
1353
1354 error = goodix_firmware_check(ts);
1355 if (error)
1356 return error;
1357
1358 error = goodix_read_version(ts);
1359 if (error)
1360 return error;
1361
1362 ts->chip = goodix_get_chip_data(ts->id);
1363
1364 if (ts->load_cfg_from_disk) {
1365 /* update device config */
1366 error = device_property_read_string(&client->dev,
1367 "goodix,config-name",
1368 &cfg_name);
1369 if (!error)
1370 snprintf(ts->cfg_name, sizeof(ts->cfg_name),
1371 "goodix/%s", cfg_name);
1372 else
1373 snprintf(ts->cfg_name, sizeof(ts->cfg_name),
1374 "goodix_%s_cfg.bin", ts->id);
1375
1376 error = request_firmware_nowait(THIS_MODULE, true, ts->cfg_name,
1377 &client->dev, GFP_KERNEL, ts,
1378 goodix_config_cb);
1379 if (error) {
1380 dev_err(&client->dev,
1381 "Failed to invoke firmware loader: %d\n",
1382 error);
1383 return error;
1384 }
1385
1386 return 0;
1387 } else {
1388 error = goodix_configure_dev(ts);
1389 if (error)
1390 return error;
1391 }
1392
1393 return 0;
1394}
1395
1396static void goodix_ts_remove(struct i2c_client *client)
1397{
1398 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1399
1400 if (ts->load_cfg_from_disk)
1401 wait_for_completion(&ts->firmware_loading_complete);
1402}
1403
1404static int __maybe_unused goodix_suspend(struct device *dev)
1405{
1406 struct i2c_client *client = to_i2c_client(dev);
1407 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1408 int error;
1409
1410 if (ts->load_cfg_from_disk)
1411 wait_for_completion(&ts->firmware_loading_complete);
1412
1413 /* We need gpio pins to suspend/resume */
1414 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1415 disable_irq(client->irq);
1416 return 0;
1417 }
1418
1419 /* Free IRQ as IRQ pin is used as output in the suspend sequence */
1420 goodix_free_irq(ts);
1421
1422 /* Save reference (calibration) info if necessary */
1423 goodix_save_bak_ref(ts);
1424
1425 /* Output LOW on the INT pin for 5 ms */
1426 error = goodix_irq_direction_output(ts, 0);
1427 if (error) {
1428 goodix_request_irq(ts);
1429 return error;
1430 }
1431
1432 usleep_range(5000, 6000);
1433
1434 error = goodix_i2c_write_u8(ts->client, GOODIX_REG_COMMAND,
1435 GOODIX_CMD_SCREEN_OFF);
1436 if (error) {
1437 goodix_irq_direction_input(ts);
1438 goodix_request_irq(ts);
1439 return -EAGAIN;
1440 }
1441
1442 /*
1443 * The datasheet specifies that the interval between sending screen-off
1444 * command and wake-up should be longer than 58 ms. To avoid waking up
1445 * sooner, delay 58ms here.
1446 */
1447 msleep(58);
1448 return 0;
1449}
1450
1451static int __maybe_unused goodix_resume(struct device *dev)
1452{
1453 struct i2c_client *client = to_i2c_client(dev);
1454 struct goodix_ts_data *ts = i2c_get_clientdata(client);
1455 u8 config_ver;
1456 int error;
1457
1458 if (ts->irq_pin_access_method == IRQ_PIN_ACCESS_NONE) {
1459 enable_irq(client->irq);
1460 return 0;
1461 }
1462
1463 /*
1464 * Exit sleep mode by outputting HIGH level to INT pin
1465 * for 2ms~5ms.
1466 */
1467 error = goodix_irq_direction_output(ts, 1);
1468 if (error)
1469 return error;
1470
1471 usleep_range(2000, 5000);
1472
1473 error = goodix_int_sync(ts);
1474 if (error)
1475 return error;
1476
1477 error = goodix_i2c_read(ts->client, ts->chip->config_addr,
1478 &config_ver, 1);
1479 if (!error && config_ver != ts->config[0])
1480 dev_info(dev, "Config version mismatch %d != %d, resetting controller\n",
1481 config_ver, ts->config[0]);
1482
1483 if (error != 0 || config_ver != ts->config[0]) {
1484 error = goodix_reset(ts);
1485 if (error)
1486 return error;
1487
1488 error = goodix_send_cfg(ts, ts->config, ts->chip->config_len);
1489 if (error)
1490 return error;
1491 }
1492
1493 error = goodix_request_irq(ts);
1494 if (error)
1495 return error;
1496
1497 return 0;
1498}
1499
1500static SIMPLE_DEV_PM_OPS(goodix_pm_ops, goodix_suspend, goodix_resume);
1501
1502static const struct i2c_device_id goodix_ts_id[] = {
1503 { "GDIX1001:00", 0 },
1504 { }
1505};
1506MODULE_DEVICE_TABLE(i2c, goodix_ts_id);
1507
1508#ifdef CONFIG_ACPI
1509static const struct acpi_device_id goodix_acpi_match[] = {
1510 { "GDIX1001", 0 },
1511 { "GDIX1002", 0 },
1512 { }
1513};
1514MODULE_DEVICE_TABLE(acpi, goodix_acpi_match);
1515#endif
1516
1517#ifdef CONFIG_OF
1518static const struct of_device_id goodix_of_match[] = {
1519 { .compatible = "goodix,gt1151" },
1520 { .compatible = "goodix,gt1158" },
1521 { .compatible = "goodix,gt5663" },
1522 { .compatible = "goodix,gt5688" },
1523 { .compatible = "goodix,gt911" },
1524 { .compatible = "goodix,gt9110" },
1525 { .compatible = "goodix,gt912" },
1526 { .compatible = "goodix,gt9147" },
1527 { .compatible = "goodix,gt917s" },
1528 { .compatible = "goodix,gt927" },
1529 { .compatible = "goodix,gt9271" },
1530 { .compatible = "goodix,gt928" },
1531 { .compatible = "goodix,gt9286" },
1532 { .compatible = "goodix,gt967" },
1533 { }
1534};
1535MODULE_DEVICE_TABLE(of, goodix_of_match);
1536#endif
1537
1538static struct i2c_driver goodix_ts_driver = {
1539 .probe_new = goodix_ts_probe,
1540 .remove = goodix_ts_remove,
1541 .id_table = goodix_ts_id,
1542 .driver = {
1543 .name = "Goodix-TS",
1544 .acpi_match_table = ACPI_PTR(goodix_acpi_match),
1545 .of_match_table = of_match_ptr(goodix_of_match),
1546 .pm = &goodix_pm_ops,
1547 },
1548};
1549module_i2c_driver(goodix_ts_driver);
1550
1551MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1552MODULE_AUTHOR("Bastien Nocera <hadess@hadess.net>");
1553MODULE_DESCRIPTION("Goodix touchscreen driver");
1554MODULE_LICENSE("GPL v2");