Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2012-2013 MundoReader S.L.
4 * Author: Heiko Stuebner <heiko@sntech.de>
5 *
6 * based in parts on Nook zforce driver
7 *
8 * Copyright (C) 2010 Barnes & Noble, Inc.
9 * Author: Pieter Truter<ptruter@intrinsyc.com>
10 */
11
12#include <linux/delay.h>
13#include <linux/device.h>
14#include <linux/gpio/consumer.h>
15#include <linux/i2c.h>
16#include <linux/input.h>
17#include <linux/input/mt.h>
18#include <linux/input/touchscreen.h>
19#include <linux/interrupt.h>
20#include <linux/module.h>
21#include <linux/of.h>
22#include <linux/property.h>
23#include <linux/regulator/consumer.h>
24#include <linux/slab.h>
25#include <linux/unaligned.h>
26
27#define WAIT_TIMEOUT msecs_to_jiffies(1000)
28
29#define FRAME_START 0xee
30#define FRAME_MAXSIZE 257
31
32/* Offsets of the different parts of the payload the controller sends */
33#define PAYLOAD_HEADER 0
34#define PAYLOAD_LENGTH 1
35#define PAYLOAD_BODY 2
36
37/* Response offsets */
38#define RESPONSE_ID 0
39#define RESPONSE_DATA 1
40
41/* Commands */
42#define COMMAND_DEACTIVATE 0x00
43#define COMMAND_INITIALIZE 0x01
44#define COMMAND_RESOLUTION 0x02
45#define COMMAND_SETCONFIG 0x03
46#define COMMAND_DATAREQUEST 0x04
47#define COMMAND_SCANFREQ 0x08
48#define COMMAND_STATUS 0X1e
49
50/*
51 * Responses the controller sends as a result of
52 * command requests
53 */
54#define RESPONSE_DEACTIVATE 0x00
55#define RESPONSE_INITIALIZE 0x01
56#define RESPONSE_RESOLUTION 0x02
57#define RESPONSE_SETCONFIG 0x03
58#define RESPONSE_SCANFREQ 0x08
59#define RESPONSE_STATUS 0X1e
60
61/*
62 * Notifications are sent by the touch controller without
63 * being requested by the driver and include for example
64 * touch indications
65 */
66#define NOTIFICATION_TOUCH 0x04
67#define NOTIFICATION_BOOTCOMPLETE 0x07
68#define NOTIFICATION_OVERRUN 0x25
69#define NOTIFICATION_PROXIMITY 0x26
70#define NOTIFICATION_INVALID_COMMAND 0xfe
71
72#define ZFORCE_REPORT_POINTS 2
73#define ZFORCE_MAX_AREA 0xff
74
75#define STATE_DOWN 0
76#define STATE_MOVE 1
77#define STATE_UP 2
78
79#define SETCONFIG_DUALTOUCH (1 << 0)
80
81struct zforce_point {
82 int coord_x;
83 int coord_y;
84 int state;
85 int id;
86 int area_major;
87 int area_minor;
88 int orientation;
89 int pressure;
90 int prblty;
91};
92
93/*
94 * @client the i2c_client
95 * @input the input device
96 * @suspending in the process of going to suspend (don't emit wakeup
97 * events for commands executed to suspend the device)
98 * @suspended device suspended
99 * @command_done completion to wait for the command result
100 * @command_waiting the id of the command that is currently waiting
101 * for a result
102 * @command_result returned result of the command
103 */
104struct zforce_ts {
105 struct i2c_client *client;
106 struct input_dev *input;
107 struct touchscreen_properties prop;
108 char phys[32];
109
110 struct gpio_desc *gpio_int;
111 struct gpio_desc *gpio_rst;
112
113 bool suspending;
114 bool suspended;
115 bool boot_complete;
116
117 /* Firmware version information */
118 u16 version_major;
119 u16 version_minor;
120 u16 version_build;
121 u16 version_rev;
122
123 struct completion command_done;
124 int command_waiting;
125 int command_result;
126};
127
128static int zforce_command(struct zforce_ts *ts, u8 cmd)
129{
130 struct i2c_client *client = ts->client;
131 char buf[3];
132 int ret;
133
134 dev_dbg(&client->dev, "%s: 0x%x\n", __func__, cmd);
135
136 buf[0] = FRAME_START;
137 buf[1] = 1; /* data size, command only */
138 buf[2] = cmd;
139
140 ret = i2c_master_send(client, &buf[0], ARRAY_SIZE(buf));
141 if (ret < 0) {
142 dev_err(&client->dev, "i2c send data request error: %d\n", ret);
143 return ret;
144 }
145
146 return 0;
147}
148
149static int zforce_send_wait(struct zforce_ts *ts, const char *buf, int len)
150{
151 struct i2c_client *client = ts->client;
152 int ret;
153
154 dev_dbg(&client->dev, "sending %d bytes for command 0x%x\n",
155 buf[1], buf[2]);
156
157 ts->command_waiting = buf[2];
158
159 ret = i2c_master_send(client, buf, len);
160 if (ret < 0) {
161 dev_err(&client->dev, "i2c send data request error: %d\n", ret);
162 return ret;
163 }
164
165 dev_dbg(&client->dev, "waiting for result for command 0x%x\n", buf[2]);
166
167 if (wait_for_completion_timeout(&ts->command_done, WAIT_TIMEOUT) == 0)
168 return -ETIME;
169
170 ret = ts->command_result;
171 return 0;
172}
173
174static int zforce_command_wait(struct zforce_ts *ts, u8 cmd)
175{
176 struct i2c_client *client = ts->client;
177 char buf[3];
178 int error;
179
180 dev_dbg(&client->dev, "%s: 0x%x\n", __func__, cmd);
181
182 buf[0] = FRAME_START;
183 buf[1] = 1; /* data size, command only */
184 buf[2] = cmd;
185
186 error = zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
187 if (error) {
188 dev_err(&client->dev, "i2c send data request error: %d\n",
189 error);
190 return error;
191 }
192
193 return 0;
194}
195
196static int zforce_resolution(struct zforce_ts *ts, u16 x, u16 y)
197{
198 struct i2c_client *client = ts->client;
199 char buf[7] = { FRAME_START, 5, COMMAND_RESOLUTION,
200 (x & 0xff), ((x >> 8) & 0xff),
201 (y & 0xff), ((y >> 8) & 0xff) };
202
203 dev_dbg(&client->dev, "set resolution to (%d,%d)\n", x, y);
204
205 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
206}
207
208static int zforce_scan_frequency(struct zforce_ts *ts, u16 idle, u16 finger,
209 u16 stylus)
210{
211 struct i2c_client *client = ts->client;
212 char buf[9] = { FRAME_START, 7, COMMAND_SCANFREQ,
213 (idle & 0xff), ((idle >> 8) & 0xff),
214 (finger & 0xff), ((finger >> 8) & 0xff),
215 (stylus & 0xff), ((stylus >> 8) & 0xff) };
216
217 dev_dbg(&client->dev,
218 "set scan frequency to (idle: %d, finger: %d, stylus: %d)\n",
219 idle, finger, stylus);
220
221 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
222}
223
224static int zforce_setconfig(struct zforce_ts *ts, char b1)
225{
226 struct i2c_client *client = ts->client;
227 char buf[7] = { FRAME_START, 5, COMMAND_SETCONFIG,
228 b1, 0, 0, 0 };
229
230 dev_dbg(&client->dev, "set config to (%d)\n", b1);
231
232 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
233}
234
235static int zforce_start(struct zforce_ts *ts)
236{
237 struct i2c_client *client = ts->client;
238 int error;
239
240 dev_dbg(&client->dev, "starting device\n");
241
242 error = zforce_command_wait(ts, COMMAND_INITIALIZE);
243 if (error) {
244 dev_err(&client->dev, "Unable to initialize, %d\n", error);
245 return error;
246 }
247
248 error = zforce_resolution(ts, ts->prop.max_x, ts->prop.max_y);
249 if (error) {
250 dev_err(&client->dev, "Unable to set resolution, %d\n", error);
251 goto err_deactivate;
252 }
253
254 error = zforce_scan_frequency(ts, 10, 50, 50);
255 if (error) {
256 dev_err(&client->dev, "Unable to set scan frequency, %d\n",
257 error);
258 goto err_deactivate;
259 }
260
261 error = zforce_setconfig(ts, SETCONFIG_DUALTOUCH);
262 if (error) {
263 dev_err(&client->dev, "Unable to set config\n");
264 goto err_deactivate;
265 }
266
267 /* start sending touch events */
268 error = zforce_command(ts, COMMAND_DATAREQUEST);
269 if (error) {
270 dev_err(&client->dev, "Unable to request data\n");
271 goto err_deactivate;
272 }
273
274 /*
275 * Per NN, initial cal. take max. of 200msec.
276 * Allow time to complete this calibration
277 */
278 msleep(200);
279
280 return 0;
281
282err_deactivate:
283 zforce_command_wait(ts, COMMAND_DEACTIVATE);
284 return error;
285}
286
287static int zforce_stop(struct zforce_ts *ts)
288{
289 struct i2c_client *client = ts->client;
290 int error;
291
292 dev_dbg(&client->dev, "stopping device\n");
293
294 /* Deactivates touch sensing and puts the device into sleep. */
295 error = zforce_command_wait(ts, COMMAND_DEACTIVATE);
296 if (error) {
297 dev_err(&client->dev, "could not deactivate device, %d\n",
298 error);
299 return error;
300 }
301
302 return 0;
303}
304
305static int zforce_touch_event(struct zforce_ts *ts, u8 *payload)
306{
307 struct i2c_client *client = ts->client;
308 struct zforce_point point;
309 int count, i, num = 0;
310 u8 *p;
311
312 count = payload[0];
313 if (count > ZFORCE_REPORT_POINTS) {
314 dev_warn(&client->dev,
315 "too many coordinates %d, expected max %d\n",
316 count, ZFORCE_REPORT_POINTS);
317 count = ZFORCE_REPORT_POINTS;
318 }
319
320 for (i = 0; i < count; i++) {
321 p = &payload[i * 9 + 1];
322
323 point.coord_x = get_unaligned_le16(&p[0]);
324 point.coord_y = get_unaligned_le16(&p[2]);
325
326 if (point.coord_x > ts->prop.max_x ||
327 point.coord_y > ts->prop.max_y) {
328 dev_warn(&client->dev, "coordinates (%d,%d) invalid\n",
329 point.coord_x, point.coord_y);
330 point.coord_x = point.coord_y = 0;
331 }
332
333 point.state = p[4] & 0x0f;
334 point.id = (p[4] & 0xf0) >> 4;
335
336 /* determine touch major, minor and orientation */
337 point.area_major = max(p[5], p[6]);
338 point.area_minor = min(p[5], p[6]);
339 point.orientation = p[5] > p[6];
340
341 point.pressure = p[7];
342 point.prblty = p[8];
343
344 dev_dbg(&client->dev,
345 "point %d/%d: state %d, id %d, pressure %d, prblty %d, x %d, y %d, amajor %d, aminor %d, ori %d\n",
346 i, count, point.state, point.id,
347 point.pressure, point.prblty,
348 point.coord_x, point.coord_y,
349 point.area_major, point.area_minor,
350 point.orientation);
351
352 /* the zforce id starts with "1", so needs to be decreased */
353 input_mt_slot(ts->input, point.id - 1);
354
355 if (input_mt_report_slot_state(ts->input, MT_TOOL_FINGER,
356 point.state != STATE_UP)) {
357 touchscreen_report_pos(ts->input, &ts->prop,
358 point.coord_x, point.coord_y,
359 true);
360 input_report_abs(ts->input, ABS_MT_TOUCH_MAJOR,
361 point.area_major);
362 input_report_abs(ts->input, ABS_MT_TOUCH_MINOR,
363 point.area_minor);
364 input_report_abs(ts->input, ABS_MT_ORIENTATION,
365 point.orientation);
366 num++;
367 }
368 }
369
370 input_mt_sync_frame(ts->input);
371
372 input_mt_report_finger_count(ts->input, num);
373
374 input_sync(ts->input);
375
376 return 0;
377}
378
379static int zforce_read_packet(struct zforce_ts *ts, u8 *buf)
380{
381 struct i2c_client *client = ts->client;
382 int ret;
383
384 /* read 2 byte message header */
385 ret = i2c_master_recv(client, buf, 2);
386 if (ret < 0) {
387 dev_err(&client->dev, "error reading header: %d\n", ret);
388 return ret;
389 }
390
391 if (buf[PAYLOAD_HEADER] != FRAME_START) {
392 dev_err(&client->dev, "invalid frame start: %d\n", buf[0]);
393 return -EIO;
394 }
395
396 if (buf[PAYLOAD_LENGTH] == 0) {
397 dev_err(&client->dev, "invalid payload length: %d\n",
398 buf[PAYLOAD_LENGTH]);
399 return -EIO;
400 }
401
402 /* read the message */
403 ret = i2c_master_recv(client, &buf[PAYLOAD_BODY], buf[PAYLOAD_LENGTH]);
404 if (ret < 0) {
405 dev_err(&client->dev, "error reading payload: %d\n", ret);
406 return ret;
407 }
408
409 dev_dbg(&client->dev, "read %d bytes for response command 0x%x\n",
410 buf[PAYLOAD_LENGTH], buf[PAYLOAD_BODY]);
411
412 return 0;
413}
414
415static void zforce_complete(struct zforce_ts *ts, int cmd, int result)
416{
417 struct i2c_client *client = ts->client;
418
419 if (ts->command_waiting == cmd) {
420 dev_dbg(&client->dev, "completing command 0x%x\n", cmd);
421 ts->command_result = result;
422 complete(&ts->command_done);
423 } else {
424 dev_dbg(&client->dev, "command %d not for us\n", cmd);
425 }
426}
427
428static irqreturn_t zforce_irq(int irq, void *dev_id)
429{
430 struct zforce_ts *ts = dev_id;
431 struct i2c_client *client = ts->client;
432
433 if (ts->suspended && device_may_wakeup(&client->dev))
434 pm_wakeup_event(&client->dev, 500);
435
436 return IRQ_WAKE_THREAD;
437}
438
439static irqreturn_t zforce_irq_thread(int irq, void *dev_id)
440{
441 struct zforce_ts *ts = dev_id;
442 struct i2c_client *client = ts->client;
443 int error;
444 u8 payload_buffer[FRAME_MAXSIZE];
445 u8 *payload;
446 bool suspending;
447
448 /*
449 * When still suspended, return.
450 * Due to the level-interrupt we will get re-triggered later.
451 */
452 if (ts->suspended) {
453 msleep(20);
454 return IRQ_HANDLED;
455 }
456
457 dev_dbg(&client->dev, "handling interrupt\n");
458
459 /* Don't emit wakeup events from commands run by zforce_suspend */
460 suspending = READ_ONCE(ts->suspending);
461 if (!suspending && device_may_wakeup(&client->dev))
462 pm_stay_awake(&client->dev);
463
464 /*
465 * Run at least once and exit the loop if
466 * - the optional interrupt GPIO isn't specified
467 * (there is only one packet read per ISR invocation, then)
468 * or
469 * - the GPIO isn't active any more
470 * (packet read until the level GPIO indicates that there is
471 * no IRQ any more)
472 */
473 do {
474 error = zforce_read_packet(ts, payload_buffer);
475 if (error) {
476 dev_err(&client->dev,
477 "could not read packet, ret: %d\n", error);
478 break;
479 }
480
481 payload = &payload_buffer[PAYLOAD_BODY];
482
483 switch (payload[RESPONSE_ID]) {
484 case NOTIFICATION_TOUCH:
485 /*
486 * Always report touch-events received while
487 * suspending, when being a wakeup source
488 */
489 if (suspending && device_may_wakeup(&client->dev))
490 pm_wakeup_event(&client->dev, 500);
491 zforce_touch_event(ts, &payload[RESPONSE_DATA]);
492 break;
493
494 case NOTIFICATION_BOOTCOMPLETE:
495 ts->boot_complete = payload[RESPONSE_DATA];
496 zforce_complete(ts, payload[RESPONSE_ID], 0);
497 break;
498
499 case RESPONSE_INITIALIZE:
500 case RESPONSE_DEACTIVATE:
501 case RESPONSE_SETCONFIG:
502 case RESPONSE_RESOLUTION:
503 case RESPONSE_SCANFREQ:
504 zforce_complete(ts, payload[RESPONSE_ID],
505 payload[RESPONSE_DATA]);
506 break;
507
508 case RESPONSE_STATUS:
509 /*
510 * Version Payload Results
511 * [2:major] [2:minor] [2:build] [2:rev]
512 */
513 ts->version_major =
514 get_unaligned_le16(&payload[RESPONSE_DATA]);
515 ts->version_minor =
516 get_unaligned_le16(&payload[RESPONSE_DATA + 2]);
517 ts->version_build =
518 get_unaligned_le16(&payload[RESPONSE_DATA + 4]);
519 ts->version_rev =
520 get_unaligned_le16(&payload[RESPONSE_DATA + 6]);
521
522 dev_dbg(&ts->client->dev,
523 "Firmware Version %04x:%04x %04x:%04x\n",
524 ts->version_major, ts->version_minor,
525 ts->version_build, ts->version_rev);
526
527 zforce_complete(ts, payload[RESPONSE_ID], 0);
528 break;
529
530 case NOTIFICATION_INVALID_COMMAND:
531 dev_err(&ts->client->dev, "invalid command: 0x%x\n",
532 payload[RESPONSE_DATA]);
533 break;
534
535 default:
536 dev_err(&ts->client->dev,
537 "unrecognized response id: 0x%x\n",
538 payload[RESPONSE_ID]);
539 break;
540 }
541 } while (gpiod_get_value_cansleep(ts->gpio_int));
542
543 if (!suspending && device_may_wakeup(&client->dev))
544 pm_relax(&client->dev);
545
546 dev_dbg(&client->dev, "finished interrupt\n");
547
548 return IRQ_HANDLED;
549}
550
551static int zforce_input_open(struct input_dev *dev)
552{
553 struct zforce_ts *ts = input_get_drvdata(dev);
554
555 return zforce_start(ts);
556}
557
558static void zforce_input_close(struct input_dev *dev)
559{
560 struct zforce_ts *ts = input_get_drvdata(dev);
561 struct i2c_client *client = ts->client;
562 int error;
563
564 error = zforce_stop(ts);
565 if (error)
566 dev_warn(&client->dev, "stopping zforce failed\n");
567}
568
569static int __zforce_suspend(struct zforce_ts *ts)
570{
571 struct i2c_client *client = ts->client;
572 struct input_dev *input = ts->input;
573 int error;
574
575 guard(mutex)(&input->mutex);
576
577 /*
578 * When configured as a wakeup source device should always wake
579 * the system, therefore start device if necessary.
580 */
581 if (device_may_wakeup(&client->dev)) {
582 dev_dbg(&client->dev, "suspend while being a wakeup source\n");
583
584 /* Need to start device, if not open, to be a wakeup source. */
585 if (!input_device_enabled(input)) {
586 error = zforce_start(ts);
587 if (error)
588 return error;
589 }
590
591 enable_irq_wake(client->irq);
592 } else if (input_device_enabled(input)) {
593 dev_dbg(&client->dev,
594 "suspend without being a wakeup source\n");
595
596 error = zforce_stop(ts);
597 if (error)
598 return error;
599
600 disable_irq(client->irq);
601 }
602
603 ts->suspended = true;
604 return 0;
605}
606
607static int zforce_suspend(struct device *dev)
608{
609 struct i2c_client *client = to_i2c_client(dev);
610 struct zforce_ts *ts = i2c_get_clientdata(client);
611 int ret;
612
613 WRITE_ONCE(ts->suspending, true);
614 smp_mb();
615
616 ret = __zforce_suspend(ts);
617
618 smp_mb();
619 WRITE_ONCE(ts->suspending, false);
620
621 return ret;
622}
623
624static int zforce_resume(struct device *dev)
625{
626 struct i2c_client *client = to_i2c_client(dev);
627 struct zforce_ts *ts = i2c_get_clientdata(client);
628 struct input_dev *input = ts->input;
629 int error;
630
631 guard(mutex)(&input->mutex);
632
633 ts->suspended = false;
634
635 if (device_may_wakeup(&client->dev)) {
636 dev_dbg(&client->dev, "resume from being a wakeup source\n");
637
638 disable_irq_wake(client->irq);
639
640 /* need to stop device if it was not open on suspend */
641 if (!input_device_enabled(input)) {
642 error = zforce_stop(ts);
643 if (error)
644 return error;
645 }
646 } else if (input_device_enabled(input)) {
647 dev_dbg(&client->dev, "resume without being a wakeup source\n");
648
649 enable_irq(client->irq);
650
651 error = zforce_start(ts);
652 if (error)
653 return error;
654 }
655
656 return 0;
657}
658
659static DEFINE_SIMPLE_DEV_PM_OPS(zforce_pm_ops, zforce_suspend, zforce_resume);
660
661static void zforce_reset(void *data)
662{
663 struct zforce_ts *ts = data;
664
665 gpiod_set_value_cansleep(ts->gpio_rst, 1);
666 udelay(10);
667}
668
669static void zforce_ts_parse_legacy_properties(struct zforce_ts *ts)
670{
671 u32 x_max = 0;
672 u32 y_max = 0;
673
674 device_property_read_u32(&ts->client->dev, "x-size", &x_max);
675 input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, x_max, 0, 0);
676
677 device_property_read_u32(&ts->client->dev, "y-size", &y_max);
678 input_set_abs_params(ts->input, ABS_MT_POSITION_Y, 0, y_max, 0, 0);
679}
680
681static int zforce_probe(struct i2c_client *client)
682{
683 struct zforce_ts *ts;
684 struct input_dev *input_dev;
685 int error;
686
687 ts = devm_kzalloc(&client->dev, sizeof(struct zforce_ts), GFP_KERNEL);
688 if (!ts)
689 return -ENOMEM;
690
691 ts->gpio_rst = devm_gpiod_get_optional(&client->dev, "reset",
692 GPIOD_OUT_HIGH);
693 error = PTR_ERR_OR_ZERO(ts->gpio_rst);
694 if (error)
695 return dev_err_probe(&client->dev, error,
696 "failed to request reset GPIO\n");
697
698 if (ts->gpio_rst) {
699 ts->gpio_int = devm_gpiod_get_optional(&client->dev, "irq",
700 GPIOD_IN);
701 error = PTR_ERR_OR_ZERO(ts->gpio_int);
702 if (error)
703 return dev_err_probe(&client->dev, error,
704 "failed to request interrupt GPIO\n");
705 } else {
706 /*
707 * Deprecated GPIO handling for compatibility
708 * with legacy binding.
709 */
710
711 /* INT GPIO */
712 ts->gpio_int = devm_gpiod_get_index(&client->dev, NULL, 0,
713 GPIOD_IN);
714
715 error = PTR_ERR_OR_ZERO(ts->gpio_int);
716 if (error)
717 return dev_err_probe(&client->dev, error,
718 "failed to request interrupt GPIO\n");
719
720 /* RST GPIO */
721 ts->gpio_rst = devm_gpiod_get_index(&client->dev, NULL, 1,
722 GPIOD_OUT_HIGH);
723 error = PTR_ERR_OR_ZERO(ts->gpio_rst);
724 if (error)
725 return dev_err_probe(&client->dev, error,
726 "failed to request reset GPIO\n");
727 }
728
729 error = devm_regulator_get_enable(&client->dev, "vdd");
730 if (error)
731 return dev_err_probe(&client->dev, error,
732 "failed to request vdd supply\n");
733
734 /*
735 * According to datasheet add 100us grace time after regular
736 * regulator enable delay.
737 */
738 usleep_range(100, 200);
739
740 error = devm_add_action_or_reset(&client->dev, zforce_reset, ts);
741 if (error)
742 return dev_err_probe(&client->dev, error,
743 "failed to register reset action\n");
744
745 snprintf(ts->phys, sizeof(ts->phys),
746 "%s/input0", dev_name(&client->dev));
747
748 input_dev = devm_input_allocate_device(&client->dev);
749 if (!input_dev)
750 return dev_err_probe(&client->dev, -ENOMEM,
751 "could not allocate input device\n");
752
753 ts->client = client;
754 ts->input = input_dev;
755
756 input_dev->name = "Neonode zForce touchscreen";
757 input_dev->phys = ts->phys;
758 input_dev->id.bustype = BUS_I2C;
759
760 input_dev->open = zforce_input_open;
761 input_dev->close = zforce_input_close;
762
763 zforce_ts_parse_legacy_properties(ts);
764 touchscreen_parse_properties(input_dev, true, &ts->prop);
765 if (ts->prop.max_x == 0 || ts->prop.max_y == 0)
766 return dev_err_probe(&client->dev, -EINVAL, "no size specified");
767
768 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 0,
769 ZFORCE_MAX_AREA, 0, 0);
770 input_set_abs_params(input_dev, ABS_MT_TOUCH_MINOR, 0,
771 ZFORCE_MAX_AREA, 0, 0);
772 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 0, 1, 0, 0);
773
774 error = input_mt_init_slots(input_dev, ZFORCE_REPORT_POINTS,
775 INPUT_MT_DIRECT);
776 if (error)
777 return error;
778
779 input_set_drvdata(ts->input, ts);
780
781 init_completion(&ts->command_done);
782
783 /*
784 * The zforce pulls the interrupt low when it has data ready.
785 * After it is triggered the isr thread runs until all the available
786 * packets have been read and the interrupt is high again.
787 * Therefore we can trigger the interrupt anytime it is low and do
788 * not need to limit it to the interrupt edge.
789 */
790 error = devm_request_threaded_irq(&client->dev, client->irq,
791 zforce_irq, zforce_irq_thread,
792 IRQF_ONESHOT, input_dev->name, ts);
793 if (error)
794 return dev_err_probe(&client->dev, error,
795 "irq %d request failed\n", client->irq);
796
797 i2c_set_clientdata(client, ts);
798
799 /* let the controller boot */
800 gpiod_set_value_cansleep(ts->gpio_rst, 0);
801
802 ts->command_waiting = NOTIFICATION_BOOTCOMPLETE;
803 if (wait_for_completion_timeout(&ts->command_done, WAIT_TIMEOUT) == 0)
804 dev_warn(&client->dev, "bootcomplete timed out\n");
805
806 /* need to start device to get version information */
807 error = zforce_command_wait(ts, COMMAND_INITIALIZE);
808 if (error)
809 return dev_err_probe(&client->dev, error, "unable to initialize\n");
810
811 /* this gets the firmware version among other information */
812 error = zforce_command_wait(ts, COMMAND_STATUS);
813 if (error) {
814 dev_err_probe(&client->dev, error, "couldn't get status\n");
815 zforce_stop(ts);
816 return error;
817 }
818
819 /* stop device and put it into sleep until it is opened */
820 error = zforce_stop(ts);
821 if (error)
822 return error;
823
824 device_set_wakeup_capable(&client->dev, true);
825
826 error = input_register_device(input_dev);
827 if (error)
828 return dev_err_probe(&client->dev, error,
829 "could not register input device\n");
830
831 return 0;
832}
833
834static const struct i2c_device_id zforce_idtable[] = {
835 { "zforce-ts" },
836 { }
837};
838MODULE_DEVICE_TABLE(i2c, zforce_idtable);
839
840#ifdef CONFIG_OF
841static const struct of_device_id zforce_dt_idtable[] = {
842 { .compatible = "neonode,zforce" },
843 {},
844};
845MODULE_DEVICE_TABLE(of, zforce_dt_idtable);
846#endif
847
848static struct i2c_driver zforce_driver = {
849 .driver = {
850 .name = "zforce-ts",
851 .pm = pm_sleep_ptr(&zforce_pm_ops),
852 .of_match_table = of_match_ptr(zforce_dt_idtable),
853 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
854 },
855 .probe = zforce_probe,
856 .id_table = zforce_idtable,
857};
858
859module_i2c_driver(zforce_driver);
860
861MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
862MODULE_DESCRIPTION("zForce TouchScreen Driver");
863MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (C) 2012-2013 MundoReader S.L.
4 * Author: Heiko Stuebner <heiko@sntech.de>
5 *
6 * based in parts on Nook zforce driver
7 *
8 * Copyright (C) 2010 Barnes & Noble, Inc.
9 * Author: Pieter Truter<ptruter@intrinsyc.com>
10 */
11
12#include <linux/module.h>
13#include <linux/hrtimer.h>
14#include <linux/slab.h>
15#include <linux/input.h>
16#include <linux/interrupt.h>
17#include <linux/i2c.h>
18#include <linux/delay.h>
19#include <linux/gpio/consumer.h>
20#include <linux/device.h>
21#include <linux/sysfs.h>
22#include <linux/input/mt.h>
23#include <linux/input/touchscreen.h>
24#include <linux/platform_data/zforce_ts.h>
25#include <linux/regulator/consumer.h>
26#include <linux/of.h>
27
28#define WAIT_TIMEOUT msecs_to_jiffies(1000)
29
30#define FRAME_START 0xee
31#define FRAME_MAXSIZE 257
32
33/* Offsets of the different parts of the payload the controller sends */
34#define PAYLOAD_HEADER 0
35#define PAYLOAD_LENGTH 1
36#define PAYLOAD_BODY 2
37
38/* Response offsets */
39#define RESPONSE_ID 0
40#define RESPONSE_DATA 1
41
42/* Commands */
43#define COMMAND_DEACTIVATE 0x00
44#define COMMAND_INITIALIZE 0x01
45#define COMMAND_RESOLUTION 0x02
46#define COMMAND_SETCONFIG 0x03
47#define COMMAND_DATAREQUEST 0x04
48#define COMMAND_SCANFREQ 0x08
49#define COMMAND_STATUS 0X1e
50
51/*
52 * Responses the controller sends as a result of
53 * command requests
54 */
55#define RESPONSE_DEACTIVATE 0x00
56#define RESPONSE_INITIALIZE 0x01
57#define RESPONSE_RESOLUTION 0x02
58#define RESPONSE_SETCONFIG 0x03
59#define RESPONSE_SCANFREQ 0x08
60#define RESPONSE_STATUS 0X1e
61
62/*
63 * Notifications are sent by the touch controller without
64 * being requested by the driver and include for example
65 * touch indications
66 */
67#define NOTIFICATION_TOUCH 0x04
68#define NOTIFICATION_BOOTCOMPLETE 0x07
69#define NOTIFICATION_OVERRUN 0x25
70#define NOTIFICATION_PROXIMITY 0x26
71#define NOTIFICATION_INVALID_COMMAND 0xfe
72
73#define ZFORCE_REPORT_POINTS 2
74#define ZFORCE_MAX_AREA 0xff
75
76#define STATE_DOWN 0
77#define STATE_MOVE 1
78#define STATE_UP 2
79
80#define SETCONFIG_DUALTOUCH (1 << 0)
81
82struct zforce_point {
83 int coord_x;
84 int coord_y;
85 int state;
86 int id;
87 int area_major;
88 int area_minor;
89 int orientation;
90 int pressure;
91 int prblty;
92};
93
94/*
95 * @client the i2c_client
96 * @input the input device
97 * @suspending in the process of going to suspend (don't emit wakeup
98 * events for commands executed to suspend the device)
99 * @suspended device suspended
100 * @access_mutex serialize i2c-access, to keep multipart reads together
101 * @command_done completion to wait for the command result
102 * @command_mutex serialize commands sent to the ic
103 * @command_waiting the id of the command that is currently waiting
104 * for a result
105 * @command_result returned result of the command
106 */
107struct zforce_ts {
108 struct i2c_client *client;
109 struct input_dev *input;
110 struct touchscreen_properties prop;
111 const struct zforce_ts_platdata *pdata;
112 char phys[32];
113
114 struct regulator *reg_vdd;
115
116 struct gpio_desc *gpio_int;
117 struct gpio_desc *gpio_rst;
118
119 bool suspending;
120 bool suspended;
121 bool boot_complete;
122
123 /* Firmware version information */
124 u16 version_major;
125 u16 version_minor;
126 u16 version_build;
127 u16 version_rev;
128
129 struct mutex access_mutex;
130
131 struct completion command_done;
132 struct mutex command_mutex;
133 int command_waiting;
134 int command_result;
135};
136
137static int zforce_command(struct zforce_ts *ts, u8 cmd)
138{
139 struct i2c_client *client = ts->client;
140 char buf[3];
141 int ret;
142
143 dev_dbg(&client->dev, "%s: 0x%x\n", __func__, cmd);
144
145 buf[0] = FRAME_START;
146 buf[1] = 1; /* data size, command only */
147 buf[2] = cmd;
148
149 mutex_lock(&ts->access_mutex);
150 ret = i2c_master_send(client, &buf[0], ARRAY_SIZE(buf));
151 mutex_unlock(&ts->access_mutex);
152 if (ret < 0) {
153 dev_err(&client->dev, "i2c send data request error: %d\n", ret);
154 return ret;
155 }
156
157 return 0;
158}
159
160static void zforce_reset_assert(struct zforce_ts *ts)
161{
162 gpiod_set_value_cansleep(ts->gpio_rst, 1);
163}
164
165static void zforce_reset_deassert(struct zforce_ts *ts)
166{
167 gpiod_set_value_cansleep(ts->gpio_rst, 0);
168}
169
170static int zforce_send_wait(struct zforce_ts *ts, const char *buf, int len)
171{
172 struct i2c_client *client = ts->client;
173 int ret;
174
175 ret = mutex_trylock(&ts->command_mutex);
176 if (!ret) {
177 dev_err(&client->dev, "already waiting for a command\n");
178 return -EBUSY;
179 }
180
181 dev_dbg(&client->dev, "sending %d bytes for command 0x%x\n",
182 buf[1], buf[2]);
183
184 ts->command_waiting = buf[2];
185
186 mutex_lock(&ts->access_mutex);
187 ret = i2c_master_send(client, buf, len);
188 mutex_unlock(&ts->access_mutex);
189 if (ret < 0) {
190 dev_err(&client->dev, "i2c send data request error: %d\n", ret);
191 goto unlock;
192 }
193
194 dev_dbg(&client->dev, "waiting for result for command 0x%x\n", buf[2]);
195
196 if (wait_for_completion_timeout(&ts->command_done, WAIT_TIMEOUT) == 0) {
197 ret = -ETIME;
198 goto unlock;
199 }
200
201 ret = ts->command_result;
202
203unlock:
204 mutex_unlock(&ts->command_mutex);
205 return ret;
206}
207
208static int zforce_command_wait(struct zforce_ts *ts, u8 cmd)
209{
210 struct i2c_client *client = ts->client;
211 char buf[3];
212 int ret;
213
214 dev_dbg(&client->dev, "%s: 0x%x\n", __func__, cmd);
215
216 buf[0] = FRAME_START;
217 buf[1] = 1; /* data size, command only */
218 buf[2] = cmd;
219
220 ret = zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
221 if (ret < 0) {
222 dev_err(&client->dev, "i2c send data request error: %d\n", ret);
223 return ret;
224 }
225
226 return 0;
227}
228
229static int zforce_resolution(struct zforce_ts *ts, u16 x, u16 y)
230{
231 struct i2c_client *client = ts->client;
232 char buf[7] = { FRAME_START, 5, COMMAND_RESOLUTION,
233 (x & 0xff), ((x >> 8) & 0xff),
234 (y & 0xff), ((y >> 8) & 0xff) };
235
236 dev_dbg(&client->dev, "set resolution to (%d,%d)\n", x, y);
237
238 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
239}
240
241static int zforce_scan_frequency(struct zforce_ts *ts, u16 idle, u16 finger,
242 u16 stylus)
243{
244 struct i2c_client *client = ts->client;
245 char buf[9] = { FRAME_START, 7, COMMAND_SCANFREQ,
246 (idle & 0xff), ((idle >> 8) & 0xff),
247 (finger & 0xff), ((finger >> 8) & 0xff),
248 (stylus & 0xff), ((stylus >> 8) & 0xff) };
249
250 dev_dbg(&client->dev,
251 "set scan frequency to (idle: %d, finger: %d, stylus: %d)\n",
252 idle, finger, stylus);
253
254 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
255}
256
257static int zforce_setconfig(struct zforce_ts *ts, char b1)
258{
259 struct i2c_client *client = ts->client;
260 char buf[7] = { FRAME_START, 5, COMMAND_SETCONFIG,
261 b1, 0, 0, 0 };
262
263 dev_dbg(&client->dev, "set config to (%d)\n", b1);
264
265 return zforce_send_wait(ts, &buf[0], ARRAY_SIZE(buf));
266}
267
268static int zforce_start(struct zforce_ts *ts)
269{
270 struct i2c_client *client = ts->client;
271 int ret;
272
273 dev_dbg(&client->dev, "starting device\n");
274
275 ret = zforce_command_wait(ts, COMMAND_INITIALIZE);
276 if (ret) {
277 dev_err(&client->dev, "Unable to initialize, %d\n", ret);
278 return ret;
279 }
280
281 ret = zforce_resolution(ts, ts->prop.max_x, ts->prop.max_y);
282 if (ret) {
283 dev_err(&client->dev, "Unable to set resolution, %d\n", ret);
284 goto error;
285 }
286
287 ret = zforce_scan_frequency(ts, 10, 50, 50);
288 if (ret) {
289 dev_err(&client->dev, "Unable to set scan frequency, %d\n",
290 ret);
291 goto error;
292 }
293
294 ret = zforce_setconfig(ts, SETCONFIG_DUALTOUCH);
295 if (ret) {
296 dev_err(&client->dev, "Unable to set config\n");
297 goto error;
298 }
299
300 /* start sending touch events */
301 ret = zforce_command(ts, COMMAND_DATAREQUEST);
302 if (ret) {
303 dev_err(&client->dev, "Unable to request data\n");
304 goto error;
305 }
306
307 /*
308 * Per NN, initial cal. take max. of 200msec.
309 * Allow time to complete this calibration
310 */
311 msleep(200);
312
313 return 0;
314
315error:
316 zforce_command_wait(ts, COMMAND_DEACTIVATE);
317 return ret;
318}
319
320static int zforce_stop(struct zforce_ts *ts)
321{
322 struct i2c_client *client = ts->client;
323 int ret;
324
325 dev_dbg(&client->dev, "stopping device\n");
326
327 /* Deactivates touch sensing and puts the device into sleep. */
328 ret = zforce_command_wait(ts, COMMAND_DEACTIVATE);
329 if (ret != 0) {
330 dev_err(&client->dev, "could not deactivate device, %d\n",
331 ret);
332 return ret;
333 }
334
335 return 0;
336}
337
338static int zforce_touch_event(struct zforce_ts *ts, u8 *payload)
339{
340 struct i2c_client *client = ts->client;
341 struct zforce_point point;
342 int count, i, num = 0;
343
344 count = payload[0];
345 if (count > ZFORCE_REPORT_POINTS) {
346 dev_warn(&client->dev,
347 "too many coordinates %d, expected max %d\n",
348 count, ZFORCE_REPORT_POINTS);
349 count = ZFORCE_REPORT_POINTS;
350 }
351
352 for (i = 0; i < count; i++) {
353 point.coord_x =
354 payload[9 * i + 2] << 8 | payload[9 * i + 1];
355 point.coord_y =
356 payload[9 * i + 4] << 8 | payload[9 * i + 3];
357
358 if (point.coord_x > ts->prop.max_x ||
359 point.coord_y > ts->prop.max_y) {
360 dev_warn(&client->dev, "coordinates (%d,%d) invalid\n",
361 point.coord_x, point.coord_y);
362 point.coord_x = point.coord_y = 0;
363 }
364
365 point.state = payload[9 * i + 5] & 0x0f;
366 point.id = (payload[9 * i + 5] & 0xf0) >> 4;
367
368 /* determine touch major, minor and orientation */
369 point.area_major = max(payload[9 * i + 6],
370 payload[9 * i + 7]);
371 point.area_minor = min(payload[9 * i + 6],
372 payload[9 * i + 7]);
373 point.orientation = payload[9 * i + 6] > payload[9 * i + 7];
374
375 point.pressure = payload[9 * i + 8];
376 point.prblty = payload[9 * i + 9];
377
378 dev_dbg(&client->dev,
379 "point %d/%d: state %d, id %d, pressure %d, prblty %d, x %d, y %d, amajor %d, aminor %d, ori %d\n",
380 i, count, point.state, point.id,
381 point.pressure, point.prblty,
382 point.coord_x, point.coord_y,
383 point.area_major, point.area_minor,
384 point.orientation);
385
386 /* the zforce id starts with "1", so needs to be decreased */
387 input_mt_slot(ts->input, point.id - 1);
388
389 input_mt_report_slot_state(ts->input, MT_TOOL_FINGER,
390 point.state != STATE_UP);
391
392 if (point.state != STATE_UP) {
393 touchscreen_report_pos(ts->input, &ts->prop,
394 point.coord_x, point.coord_y,
395 true);
396 input_report_abs(ts->input, ABS_MT_TOUCH_MAJOR,
397 point.area_major);
398 input_report_abs(ts->input, ABS_MT_TOUCH_MINOR,
399 point.area_minor);
400 input_report_abs(ts->input, ABS_MT_ORIENTATION,
401 point.orientation);
402 num++;
403 }
404 }
405
406 input_mt_sync_frame(ts->input);
407
408 input_mt_report_finger_count(ts->input, num);
409
410 input_sync(ts->input);
411
412 return 0;
413}
414
415static int zforce_read_packet(struct zforce_ts *ts, u8 *buf)
416{
417 struct i2c_client *client = ts->client;
418 int ret;
419
420 mutex_lock(&ts->access_mutex);
421
422 /* read 2 byte message header */
423 ret = i2c_master_recv(client, buf, 2);
424 if (ret < 0) {
425 dev_err(&client->dev, "error reading header: %d\n", ret);
426 goto unlock;
427 }
428
429 if (buf[PAYLOAD_HEADER] != FRAME_START) {
430 dev_err(&client->dev, "invalid frame start: %d\n", buf[0]);
431 ret = -EIO;
432 goto unlock;
433 }
434
435 if (buf[PAYLOAD_LENGTH] == 0) {
436 dev_err(&client->dev, "invalid payload length: %d\n",
437 buf[PAYLOAD_LENGTH]);
438 ret = -EIO;
439 goto unlock;
440 }
441
442 /* read the message */
443 ret = i2c_master_recv(client, &buf[PAYLOAD_BODY], buf[PAYLOAD_LENGTH]);
444 if (ret < 0) {
445 dev_err(&client->dev, "error reading payload: %d\n", ret);
446 goto unlock;
447 }
448
449 dev_dbg(&client->dev, "read %d bytes for response command 0x%x\n",
450 buf[PAYLOAD_LENGTH], buf[PAYLOAD_BODY]);
451
452unlock:
453 mutex_unlock(&ts->access_mutex);
454 return ret;
455}
456
457static void zforce_complete(struct zforce_ts *ts, int cmd, int result)
458{
459 struct i2c_client *client = ts->client;
460
461 if (ts->command_waiting == cmd) {
462 dev_dbg(&client->dev, "completing command 0x%x\n", cmd);
463 ts->command_result = result;
464 complete(&ts->command_done);
465 } else {
466 dev_dbg(&client->dev, "command %d not for us\n", cmd);
467 }
468}
469
470static irqreturn_t zforce_irq(int irq, void *dev_id)
471{
472 struct zforce_ts *ts = dev_id;
473 struct i2c_client *client = ts->client;
474
475 if (ts->suspended && device_may_wakeup(&client->dev))
476 pm_wakeup_event(&client->dev, 500);
477
478 return IRQ_WAKE_THREAD;
479}
480
481static irqreturn_t zforce_irq_thread(int irq, void *dev_id)
482{
483 struct zforce_ts *ts = dev_id;
484 struct i2c_client *client = ts->client;
485 int ret;
486 u8 payload_buffer[FRAME_MAXSIZE];
487 u8 *payload;
488
489 /*
490 * When still suspended, return.
491 * Due to the level-interrupt we will get re-triggered later.
492 */
493 if (ts->suspended) {
494 msleep(20);
495 return IRQ_HANDLED;
496 }
497
498 dev_dbg(&client->dev, "handling interrupt\n");
499
500 /* Don't emit wakeup events from commands run by zforce_suspend */
501 if (!ts->suspending && device_may_wakeup(&client->dev))
502 pm_stay_awake(&client->dev);
503
504 /*
505 * Run at least once and exit the loop if
506 * - the optional interrupt GPIO isn't specified
507 * (there is only one packet read per ISR invocation, then)
508 * or
509 * - the GPIO isn't active any more
510 * (packet read until the level GPIO indicates that there is
511 * no IRQ any more)
512 */
513 do {
514 ret = zforce_read_packet(ts, payload_buffer);
515 if (ret < 0) {
516 dev_err(&client->dev,
517 "could not read packet, ret: %d\n", ret);
518 break;
519 }
520
521 payload = &payload_buffer[PAYLOAD_BODY];
522
523 switch (payload[RESPONSE_ID]) {
524 case NOTIFICATION_TOUCH:
525 /*
526 * Always report touch-events received while
527 * suspending, when being a wakeup source
528 */
529 if (ts->suspending && device_may_wakeup(&client->dev))
530 pm_wakeup_event(&client->dev, 500);
531 zforce_touch_event(ts, &payload[RESPONSE_DATA]);
532 break;
533
534 case NOTIFICATION_BOOTCOMPLETE:
535 ts->boot_complete = payload[RESPONSE_DATA];
536 zforce_complete(ts, payload[RESPONSE_ID], 0);
537 break;
538
539 case RESPONSE_INITIALIZE:
540 case RESPONSE_DEACTIVATE:
541 case RESPONSE_SETCONFIG:
542 case RESPONSE_RESOLUTION:
543 case RESPONSE_SCANFREQ:
544 zforce_complete(ts, payload[RESPONSE_ID],
545 payload[RESPONSE_DATA]);
546 break;
547
548 case RESPONSE_STATUS:
549 /*
550 * Version Payload Results
551 * [2:major] [2:minor] [2:build] [2:rev]
552 */
553 ts->version_major = (payload[RESPONSE_DATA + 1] << 8) |
554 payload[RESPONSE_DATA];
555 ts->version_minor = (payload[RESPONSE_DATA + 3] << 8) |
556 payload[RESPONSE_DATA + 2];
557 ts->version_build = (payload[RESPONSE_DATA + 5] << 8) |
558 payload[RESPONSE_DATA + 4];
559 ts->version_rev = (payload[RESPONSE_DATA + 7] << 8) |
560 payload[RESPONSE_DATA + 6];
561 dev_dbg(&ts->client->dev,
562 "Firmware Version %04x:%04x %04x:%04x\n",
563 ts->version_major, ts->version_minor,
564 ts->version_build, ts->version_rev);
565
566 zforce_complete(ts, payload[RESPONSE_ID], 0);
567 break;
568
569 case NOTIFICATION_INVALID_COMMAND:
570 dev_err(&ts->client->dev, "invalid command: 0x%x\n",
571 payload[RESPONSE_DATA]);
572 break;
573
574 default:
575 dev_err(&ts->client->dev,
576 "unrecognized response id: 0x%x\n",
577 payload[RESPONSE_ID]);
578 break;
579 }
580 } while (gpiod_get_value_cansleep(ts->gpio_int));
581
582 if (!ts->suspending && device_may_wakeup(&client->dev))
583 pm_relax(&client->dev);
584
585 dev_dbg(&client->dev, "finished interrupt\n");
586
587 return IRQ_HANDLED;
588}
589
590static int zforce_input_open(struct input_dev *dev)
591{
592 struct zforce_ts *ts = input_get_drvdata(dev);
593
594 return zforce_start(ts);
595}
596
597static void zforce_input_close(struct input_dev *dev)
598{
599 struct zforce_ts *ts = input_get_drvdata(dev);
600 struct i2c_client *client = ts->client;
601 int ret;
602
603 ret = zforce_stop(ts);
604 if (ret)
605 dev_warn(&client->dev, "stopping zforce failed\n");
606
607 return;
608}
609
610static int zforce_suspend(struct device *dev)
611{
612 struct i2c_client *client = to_i2c_client(dev);
613 struct zforce_ts *ts = i2c_get_clientdata(client);
614 struct input_dev *input = ts->input;
615 int ret = 0;
616
617 mutex_lock(&input->mutex);
618 ts->suspending = true;
619
620 /*
621 * When configured as a wakeup source device should always wake
622 * the system, therefore start device if necessary.
623 */
624 if (device_may_wakeup(&client->dev)) {
625 dev_dbg(&client->dev, "suspend while being a wakeup source\n");
626
627 /* Need to start device, if not open, to be a wakeup source. */
628 if (!input_device_enabled(input)) {
629 ret = zforce_start(ts);
630 if (ret)
631 goto unlock;
632 }
633
634 enable_irq_wake(client->irq);
635 } else if (input_device_enabled(input)) {
636 dev_dbg(&client->dev,
637 "suspend without being a wakeup source\n");
638
639 ret = zforce_stop(ts);
640 if (ret)
641 goto unlock;
642
643 disable_irq(client->irq);
644 }
645
646 ts->suspended = true;
647
648unlock:
649 ts->suspending = false;
650 mutex_unlock(&input->mutex);
651
652 return ret;
653}
654
655static int zforce_resume(struct device *dev)
656{
657 struct i2c_client *client = to_i2c_client(dev);
658 struct zforce_ts *ts = i2c_get_clientdata(client);
659 struct input_dev *input = ts->input;
660 int ret = 0;
661
662 mutex_lock(&input->mutex);
663
664 ts->suspended = false;
665
666 if (device_may_wakeup(&client->dev)) {
667 dev_dbg(&client->dev, "resume from being a wakeup source\n");
668
669 disable_irq_wake(client->irq);
670
671 /* need to stop device if it was not open on suspend */
672 if (!input_device_enabled(input)) {
673 ret = zforce_stop(ts);
674 if (ret)
675 goto unlock;
676 }
677 } else if (input_device_enabled(input)) {
678 dev_dbg(&client->dev, "resume without being a wakeup source\n");
679
680 enable_irq(client->irq);
681
682 ret = zforce_start(ts);
683 if (ret < 0)
684 goto unlock;
685 }
686
687unlock:
688 mutex_unlock(&input->mutex);
689
690 return ret;
691}
692
693static DEFINE_SIMPLE_DEV_PM_OPS(zforce_pm_ops, zforce_suspend, zforce_resume);
694
695static void zforce_reset(void *data)
696{
697 struct zforce_ts *ts = data;
698
699 zforce_reset_assert(ts);
700
701 udelay(10);
702
703 if (!IS_ERR(ts->reg_vdd))
704 regulator_disable(ts->reg_vdd);
705}
706
707static struct zforce_ts_platdata *zforce_parse_dt(struct device *dev)
708{
709 struct zforce_ts_platdata *pdata;
710 struct device_node *np = dev->of_node;
711
712 if (!np)
713 return ERR_PTR(-ENOENT);
714
715 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
716 if (!pdata) {
717 dev_err(dev, "failed to allocate platform data\n");
718 return ERR_PTR(-ENOMEM);
719 }
720
721 of_property_read_u32(np, "x-size", &pdata->x_max);
722 of_property_read_u32(np, "y-size", &pdata->y_max);
723
724 return pdata;
725}
726
727static int zforce_probe(struct i2c_client *client)
728{
729 const struct zforce_ts_platdata *pdata = dev_get_platdata(&client->dev);
730 struct zforce_ts *ts;
731 struct input_dev *input_dev;
732 int ret;
733
734 if (!pdata) {
735 pdata = zforce_parse_dt(&client->dev);
736 if (IS_ERR(pdata))
737 return PTR_ERR(pdata);
738 }
739
740 ts = devm_kzalloc(&client->dev, sizeof(struct zforce_ts), GFP_KERNEL);
741 if (!ts)
742 return -ENOMEM;
743
744 ts->gpio_rst = devm_gpiod_get_optional(&client->dev, "reset",
745 GPIOD_OUT_HIGH);
746 if (IS_ERR(ts->gpio_rst)) {
747 ret = PTR_ERR(ts->gpio_rst);
748 dev_err(&client->dev,
749 "failed to request reset GPIO: %d\n", ret);
750 return ret;
751 }
752
753 if (ts->gpio_rst) {
754 ts->gpio_int = devm_gpiod_get_optional(&client->dev, "irq",
755 GPIOD_IN);
756 if (IS_ERR(ts->gpio_int)) {
757 ret = PTR_ERR(ts->gpio_int);
758 dev_err(&client->dev,
759 "failed to request interrupt GPIO: %d\n", ret);
760 return ret;
761 }
762 } else {
763 /*
764 * Deprecated GPIO handling for compatibility
765 * with legacy binding.
766 */
767
768 /* INT GPIO */
769 ts->gpio_int = devm_gpiod_get_index(&client->dev, NULL, 0,
770 GPIOD_IN);
771 if (IS_ERR(ts->gpio_int)) {
772 ret = PTR_ERR(ts->gpio_int);
773 dev_err(&client->dev,
774 "failed to request interrupt GPIO: %d\n", ret);
775 return ret;
776 }
777
778 /* RST GPIO */
779 ts->gpio_rst = devm_gpiod_get_index(&client->dev, NULL, 1,
780 GPIOD_OUT_HIGH);
781 if (IS_ERR(ts->gpio_rst)) {
782 ret = PTR_ERR(ts->gpio_rst);
783 dev_err(&client->dev,
784 "failed to request reset GPIO: %d\n", ret);
785 return ret;
786 }
787 }
788
789 ts->reg_vdd = devm_regulator_get_optional(&client->dev, "vdd");
790 if (IS_ERR(ts->reg_vdd)) {
791 ret = PTR_ERR(ts->reg_vdd);
792 if (ret == -EPROBE_DEFER)
793 return ret;
794 } else {
795 ret = regulator_enable(ts->reg_vdd);
796 if (ret)
797 return ret;
798
799 /*
800 * according to datasheet add 100us grace time after regular
801 * regulator enable delay.
802 */
803 udelay(100);
804 }
805
806 ret = devm_add_action(&client->dev, zforce_reset, ts);
807 if (ret) {
808 dev_err(&client->dev, "failed to register reset action, %d\n",
809 ret);
810
811 /* hereafter the regulator will be disabled by the action */
812 if (!IS_ERR(ts->reg_vdd))
813 regulator_disable(ts->reg_vdd);
814
815 return ret;
816 }
817
818 snprintf(ts->phys, sizeof(ts->phys),
819 "%s/input0", dev_name(&client->dev));
820
821 input_dev = devm_input_allocate_device(&client->dev);
822 if (!input_dev) {
823 dev_err(&client->dev, "could not allocate input device\n");
824 return -ENOMEM;
825 }
826
827 mutex_init(&ts->access_mutex);
828 mutex_init(&ts->command_mutex);
829
830 ts->pdata = pdata;
831 ts->client = client;
832 ts->input = input_dev;
833
834 input_dev->name = "Neonode zForce touchscreen";
835 input_dev->phys = ts->phys;
836 input_dev->id.bustype = BUS_I2C;
837
838 input_dev->open = zforce_input_open;
839 input_dev->close = zforce_input_close;
840
841 __set_bit(EV_KEY, input_dev->evbit);
842 __set_bit(EV_SYN, input_dev->evbit);
843 __set_bit(EV_ABS, input_dev->evbit);
844
845 /* For multi touch */
846 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0,
847 pdata->x_max, 0, 0);
848 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0,
849 pdata->y_max, 0, 0);
850
851 touchscreen_parse_properties(input_dev, true, &ts->prop);
852 if (ts->prop.max_x == 0 || ts->prop.max_y == 0) {
853 dev_err(&client->dev, "no size specified\n");
854 return -EINVAL;
855 }
856
857 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 0,
858 ZFORCE_MAX_AREA, 0, 0);
859 input_set_abs_params(input_dev, ABS_MT_TOUCH_MINOR, 0,
860 ZFORCE_MAX_AREA, 0, 0);
861 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 0, 1, 0, 0);
862 input_mt_init_slots(input_dev, ZFORCE_REPORT_POINTS, INPUT_MT_DIRECT);
863
864 input_set_drvdata(ts->input, ts);
865
866 init_completion(&ts->command_done);
867
868 /*
869 * The zforce pulls the interrupt low when it has data ready.
870 * After it is triggered the isr thread runs until all the available
871 * packets have been read and the interrupt is high again.
872 * Therefore we can trigger the interrupt anytime it is low and do
873 * not need to limit it to the interrupt edge.
874 */
875 ret = devm_request_threaded_irq(&client->dev, client->irq,
876 zforce_irq, zforce_irq_thread,
877 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
878 input_dev->name, ts);
879 if (ret) {
880 dev_err(&client->dev, "irq %d request failed\n", client->irq);
881 return ret;
882 }
883
884 i2c_set_clientdata(client, ts);
885
886 /* let the controller boot */
887 zforce_reset_deassert(ts);
888
889 ts->command_waiting = NOTIFICATION_BOOTCOMPLETE;
890 if (wait_for_completion_timeout(&ts->command_done, WAIT_TIMEOUT) == 0)
891 dev_warn(&client->dev, "bootcomplete timed out\n");
892
893 /* need to start device to get version information */
894 ret = zforce_command_wait(ts, COMMAND_INITIALIZE);
895 if (ret) {
896 dev_err(&client->dev, "unable to initialize, %d\n", ret);
897 return ret;
898 }
899
900 /* this gets the firmware version among other information */
901 ret = zforce_command_wait(ts, COMMAND_STATUS);
902 if (ret < 0) {
903 dev_err(&client->dev, "couldn't get status, %d\n", ret);
904 zforce_stop(ts);
905 return ret;
906 }
907
908 /* stop device and put it into sleep until it is opened */
909 ret = zforce_stop(ts);
910 if (ret < 0)
911 return ret;
912
913 device_set_wakeup_capable(&client->dev, true);
914
915 ret = input_register_device(input_dev);
916 if (ret) {
917 dev_err(&client->dev, "could not register input device, %d\n",
918 ret);
919 return ret;
920 }
921
922 return 0;
923}
924
925static struct i2c_device_id zforce_idtable[] = {
926 { "zforce-ts", 0 },
927 { }
928};
929MODULE_DEVICE_TABLE(i2c, zforce_idtable);
930
931#ifdef CONFIG_OF
932static const struct of_device_id zforce_dt_idtable[] = {
933 { .compatible = "neonode,zforce" },
934 {},
935};
936MODULE_DEVICE_TABLE(of, zforce_dt_idtable);
937#endif
938
939static struct i2c_driver zforce_driver = {
940 .driver = {
941 .name = "zforce-ts",
942 .pm = pm_sleep_ptr(&zforce_pm_ops),
943 .of_match_table = of_match_ptr(zforce_dt_idtable),
944 },
945 .probe = zforce_probe,
946 .id_table = zforce_idtable,
947};
948
949module_i2c_driver(zforce_driver);
950
951MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
952MODULE_DESCRIPTION("zForce TouchScreen Driver");
953MODULE_LICENSE("GPL");