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