Loading...
1/*
2 * Cypress APA trackpad with I2C interface
3 *
4 * Author: Dudley Du <dudl@cypress.com>
5 * Further cleanup and restructuring by:
6 * Daniel Kurtz <djkurtz@chromium.org>
7 * Benson Leung <bleung@chromium.org>
8 *
9 * Copyright (C) 2011-2015 Cypress Semiconductor, Inc.
10 * Copyright (C) 2011-2012 Google, Inc.
11 *
12 * This file is subject to the terms and conditions of the GNU General Public
13 * License. See the file COPYING in the main directory of this archive for
14 * more details.
15 */
16
17#include <linux/delay.h>
18#include <linux/i2c.h>
19#include <linux/input.h>
20#include <linux/input/mt.h>
21#include <linux/interrupt.h>
22#include <linux/module.h>
23#include <linux/mutex.h>
24#include <linux/regulator/consumer.h>
25#include <linux/slab.h>
26#include <linux/uaccess.h>
27#include <linux/pm_runtime.h>
28#include <linux/acpi.h>
29#include <linux/of.h>
30#include "cyapa.h"
31
32
33#define CYAPA_ADAPTER_FUNC_NONE 0
34#define CYAPA_ADAPTER_FUNC_I2C 1
35#define CYAPA_ADAPTER_FUNC_SMBUS 2
36#define CYAPA_ADAPTER_FUNC_BOTH 3
37
38#define CYAPA_FW_NAME "cyapa.bin"
39
40const char product_id[] = "CYTRA";
41
42static int cyapa_reinitialize(struct cyapa *cyapa);
43
44bool cyapa_is_pip_bl_mode(struct cyapa *cyapa)
45{
46 if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_BL)
47 return true;
48
49 if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_BL)
50 return true;
51
52 return false;
53}
54
55bool cyapa_is_pip_app_mode(struct cyapa *cyapa)
56{
57 if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_APP)
58 return true;
59
60 if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_APP)
61 return true;
62
63 return false;
64}
65
66static bool cyapa_is_bootloader_mode(struct cyapa *cyapa)
67{
68 if (cyapa_is_pip_bl_mode(cyapa))
69 return true;
70
71 if (cyapa->gen == CYAPA_GEN3 &&
72 cyapa->state >= CYAPA_STATE_BL_BUSY &&
73 cyapa->state <= CYAPA_STATE_BL_ACTIVE)
74 return true;
75
76 return false;
77}
78
79static inline bool cyapa_is_operational_mode(struct cyapa *cyapa)
80{
81 if (cyapa_is_pip_app_mode(cyapa))
82 return true;
83
84 if (cyapa->gen == CYAPA_GEN3 && cyapa->state == CYAPA_STATE_OP)
85 return true;
86
87 return false;
88}
89
90/* Returns 0 on success, else negative errno on failure. */
91static ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len,
92 u8 *values)
93{
94 struct i2c_client *client = cyapa->client;
95 struct i2c_msg msgs[] = {
96 {
97 .addr = client->addr,
98 .flags = 0,
99 .len = 1,
100 .buf = ®,
101 },
102 {
103 .addr = client->addr,
104 .flags = I2C_M_RD,
105 .len = len,
106 .buf = values,
107 },
108 };
109 int ret;
110
111 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
112
113 if (ret != ARRAY_SIZE(msgs))
114 return ret < 0 ? ret : -EIO;
115
116 return 0;
117}
118
119/**
120 * cyapa_i2c_write - Execute i2c block data write operation
121 * @cyapa: Handle to this driver
122 * @reg: Offset of the data to written in the register map
123 * @len: number of bytes to write
124 * @values: Data to be written
125 *
126 * Return negative errno code on error; return zero when success.
127 */
128static int cyapa_i2c_write(struct cyapa *cyapa, u8 reg,
129 size_t len, const void *values)
130{
131 struct i2c_client *client = cyapa->client;
132 char buf[32];
133 int ret;
134
135 if (len > sizeof(buf) - 1)
136 return -ENOMEM;
137
138 buf[0] = reg;
139 memcpy(&buf[1], values, len);
140
141 ret = i2c_master_send(client, buf, len + 1);
142 if (ret != len + 1)
143 return ret < 0 ? ret : -EIO;
144
145 return 0;
146}
147
148static u8 cyapa_check_adapter_functionality(struct i2c_client *client)
149{
150 u8 ret = CYAPA_ADAPTER_FUNC_NONE;
151
152 if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
153 ret |= CYAPA_ADAPTER_FUNC_I2C;
154 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA |
155 I2C_FUNC_SMBUS_BLOCK_DATA |
156 I2C_FUNC_SMBUS_I2C_BLOCK))
157 ret |= CYAPA_ADAPTER_FUNC_SMBUS;
158 return ret;
159}
160
161/*
162 * Query device for its current operating state.
163 */
164static int cyapa_get_state(struct cyapa *cyapa)
165{
166 u8 status[BL_STATUS_SIZE];
167 u8 cmd[32];
168 /* The i2c address of gen4 and gen5 trackpad device must be even. */
169 bool even_addr = ((cyapa->client->addr & 0x0001) == 0);
170 bool smbus = false;
171 int retries = 2;
172 int error;
173
174 cyapa->state = CYAPA_STATE_NO_DEVICE;
175
176 /*
177 * Get trackpad status by reading 3 registers starting from 0.
178 * If the device is in the bootloader, this will be BL_HEAD.
179 * If the device is in operation mode, this will be the DATA regs.
180 *
181 */
182 error = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE,
183 status);
184
185 /*
186 * On smbus systems in OP mode, the i2c_reg_read will fail with
187 * -ETIMEDOUT. In this case, try again using the smbus equivalent
188 * command. This should return a BL_HEAD indicating CYAPA_STATE_OP.
189 */
190 if (cyapa->smbus && (error == -ETIMEDOUT || error == -ENXIO)) {
191 if (!even_addr)
192 error = cyapa_read_block(cyapa,
193 CYAPA_CMD_BL_STATUS, status);
194 smbus = true;
195 }
196
197 if (error != BL_STATUS_SIZE)
198 goto error;
199
200 /*
201 * Detect trackpad protocol based on characteristic registers and bits.
202 */
203 do {
204 cyapa->status[REG_OP_STATUS] = status[REG_OP_STATUS];
205 cyapa->status[REG_BL_STATUS] = status[REG_BL_STATUS];
206 cyapa->status[REG_BL_ERROR] = status[REG_BL_ERROR];
207
208 if (cyapa->gen == CYAPA_GEN_UNKNOWN ||
209 cyapa->gen == CYAPA_GEN3) {
210 error = cyapa_gen3_ops.state_parse(cyapa,
211 status, BL_STATUS_SIZE);
212 if (!error)
213 goto out_detected;
214 }
215 if (cyapa->gen == CYAPA_GEN_UNKNOWN ||
216 cyapa->gen == CYAPA_GEN6 ||
217 cyapa->gen == CYAPA_GEN5) {
218 error = cyapa_pip_state_parse(cyapa,
219 status, BL_STATUS_SIZE);
220 if (!error)
221 goto out_detected;
222 }
223 /* For old Gen5 trackpads detecting. */
224 if ((cyapa->gen == CYAPA_GEN_UNKNOWN ||
225 cyapa->gen == CYAPA_GEN5) &&
226 !smbus && even_addr) {
227 error = cyapa_gen5_ops.state_parse(cyapa,
228 status, BL_STATUS_SIZE);
229 if (!error)
230 goto out_detected;
231 }
232
233 /*
234 * Write 0x00 0x00 to trackpad device to force update its
235 * status, then redo the detection again.
236 */
237 if (!smbus) {
238 cmd[0] = 0x00;
239 cmd[1] = 0x00;
240 error = cyapa_i2c_write(cyapa, 0, 2, cmd);
241 if (error)
242 goto error;
243
244 msleep(50);
245
246 error = cyapa_i2c_read(cyapa, BL_HEAD_OFFSET,
247 BL_STATUS_SIZE, status);
248 if (error)
249 goto error;
250 }
251 } while (--retries > 0 && !smbus);
252
253 goto error;
254
255out_detected:
256 if (cyapa->state <= CYAPA_STATE_BL_BUSY)
257 return -EAGAIN;
258 return 0;
259
260error:
261 return (error < 0) ? error : -EAGAIN;
262}
263
264/*
265 * Poll device for its status in a loop, waiting up to timeout for a response.
266 *
267 * When the device switches state, it usually takes ~300 ms.
268 * However, when running a new firmware image, the device must calibrate its
269 * sensors, which can take as long as 2 seconds.
270 *
271 * Note: The timeout has granularity of the polling rate, which is 100 ms.
272 *
273 * Returns:
274 * 0 when the device eventually responds with a valid non-busy state.
275 * -ETIMEDOUT if device never responds (too many -EAGAIN)
276 * -EAGAIN if bootload is busy, or unknown state.
277 * < 0 other errors
278 */
279int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout)
280{
281 int error;
282 int tries = timeout / 100;
283
284 do {
285 error = cyapa_get_state(cyapa);
286 if (!error && cyapa->state > CYAPA_STATE_BL_BUSY)
287 return 0;
288
289 msleep(100);
290 } while (tries--);
291
292 return (error == -EAGAIN || error == -ETIMEDOUT) ? -ETIMEDOUT : error;
293}
294
295/*
296 * Check if device is operational.
297 *
298 * An operational device is responding, has exited bootloader, and has
299 * firmware supported by this driver.
300 *
301 * Returns:
302 * -ENODEV no device
303 * -EBUSY no device or in bootloader
304 * -EIO failure while reading from device
305 * -ETIMEDOUT timeout failure for bus idle or bus no response
306 * -EAGAIN device is still in bootloader
307 * if ->state = CYAPA_STATE_BL_IDLE, device has invalid firmware
308 * -EINVAL device is in operational mode, but not supported by this driver
309 * 0 device is supported
310 */
311static int cyapa_check_is_operational(struct cyapa *cyapa)
312{
313 int error;
314
315 error = cyapa_poll_state(cyapa, 4000);
316 if (error)
317 return error;
318
319 switch (cyapa->gen) {
320 case CYAPA_GEN6:
321 cyapa->ops = &cyapa_gen6_ops;
322 break;
323 case CYAPA_GEN5:
324 cyapa->ops = &cyapa_gen5_ops;
325 break;
326 case CYAPA_GEN3:
327 cyapa->ops = &cyapa_gen3_ops;
328 break;
329 default:
330 return -ENODEV;
331 }
332
333 error = cyapa->ops->operational_check(cyapa);
334 if (!error && cyapa_is_operational_mode(cyapa))
335 cyapa->operational = true;
336 else
337 cyapa->operational = false;
338
339 return error;
340}
341
342
343/*
344 * Returns 0 on device detected, negative errno on no device detected.
345 * And when the device is detected and operational, it will be reset to
346 * full power active mode automatically.
347 */
348static int cyapa_detect(struct cyapa *cyapa)
349{
350 struct device *dev = &cyapa->client->dev;
351 int error;
352
353 error = cyapa_check_is_operational(cyapa);
354 if (error) {
355 if (error != -ETIMEDOUT && error != -ENODEV &&
356 cyapa_is_bootloader_mode(cyapa)) {
357 dev_warn(dev, "device detected but not operational\n");
358 return 0;
359 }
360
361 dev_err(dev, "no device detected: %d\n", error);
362 return error;
363 }
364
365 return 0;
366}
367
368static int cyapa_open(struct input_dev *input)
369{
370 struct cyapa *cyapa = input_get_drvdata(input);
371 struct i2c_client *client = cyapa->client;
372 struct device *dev = &client->dev;
373 int error;
374
375 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
376 if (error)
377 return error;
378
379 if (cyapa->operational) {
380 /*
381 * though failed to set active power mode,
382 * but still may be able to work in lower scan rate
383 * when in operational mode.
384 */
385 error = cyapa->ops->set_power_mode(cyapa,
386 PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE);
387 if (error) {
388 dev_warn(dev, "set active power failed: %d\n", error);
389 goto out;
390 }
391 } else {
392 error = cyapa_reinitialize(cyapa);
393 if (error || !cyapa->operational) {
394 error = error ? error : -EAGAIN;
395 goto out;
396 }
397 }
398
399 enable_irq(client->irq);
400 if (!pm_runtime_enabled(dev)) {
401 pm_runtime_set_active(dev);
402 pm_runtime_enable(dev);
403 }
404
405 pm_runtime_get_sync(dev);
406 pm_runtime_mark_last_busy(dev);
407 pm_runtime_put_sync_autosuspend(dev);
408out:
409 mutex_unlock(&cyapa->state_sync_lock);
410 return error;
411}
412
413static void cyapa_close(struct input_dev *input)
414{
415 struct cyapa *cyapa = input_get_drvdata(input);
416 struct i2c_client *client = cyapa->client;
417 struct device *dev = &cyapa->client->dev;
418
419 mutex_lock(&cyapa->state_sync_lock);
420
421 disable_irq(client->irq);
422 if (pm_runtime_enabled(dev))
423 pm_runtime_disable(dev);
424 pm_runtime_set_suspended(dev);
425
426 if (cyapa->operational)
427 cyapa->ops->set_power_mode(cyapa,
428 PWR_MODE_OFF, 0, CYAPA_PM_DEACTIVE);
429
430 mutex_unlock(&cyapa->state_sync_lock);
431}
432
433static int cyapa_create_input_dev(struct cyapa *cyapa)
434{
435 struct device *dev = &cyapa->client->dev;
436 struct input_dev *input;
437 int error;
438
439 if (!cyapa->physical_size_x || !cyapa->physical_size_y)
440 return -EINVAL;
441
442 input = devm_input_allocate_device(dev);
443 if (!input) {
444 dev_err(dev, "failed to allocate memory for input device.\n");
445 return -ENOMEM;
446 }
447
448 input->name = CYAPA_NAME;
449 input->phys = cyapa->phys;
450 input->id.bustype = BUS_I2C;
451 input->id.version = 1;
452 input->id.product = 0; /* Means any product in eventcomm. */
453 input->dev.parent = &cyapa->client->dev;
454
455 input->open = cyapa_open;
456 input->close = cyapa_close;
457
458 input_set_drvdata(input, cyapa);
459
460 __set_bit(EV_ABS, input->evbit);
461
462 /* Finger position */
463 input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0,
464 0);
465 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0,
466 0);
467 input_set_abs_params(input, ABS_MT_PRESSURE, 0, cyapa->max_z, 0, 0);
468 if (cyapa->gen > CYAPA_GEN3) {
469 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
470 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 0, 0);
471 /*
472 * Orientation is the angle between the vertical axis and
473 * the major axis of the contact ellipse.
474 * The range is -127 to 127.
475 * the positive direction is clockwise form the vertical axis.
476 * If the ellipse of contact degenerates into a circle,
477 * orientation is reported as 0.
478 *
479 * Also, for Gen5 trackpad the accurate of this orientation
480 * value is value + (-30 ~ 30).
481 */
482 input_set_abs_params(input, ABS_MT_ORIENTATION,
483 -127, 127, 0, 0);
484 }
485 if (cyapa->gen >= CYAPA_GEN5) {
486 input_set_abs_params(input, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
487 input_set_abs_params(input, ABS_MT_WIDTH_MINOR, 0, 255, 0, 0);
488 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0);
489 }
490
491 input_abs_set_res(input, ABS_MT_POSITION_X,
492 cyapa->max_abs_x / cyapa->physical_size_x);
493 input_abs_set_res(input, ABS_MT_POSITION_Y,
494 cyapa->max_abs_y / cyapa->physical_size_y);
495
496 if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK)
497 __set_bit(BTN_LEFT, input->keybit);
498 if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK)
499 __set_bit(BTN_MIDDLE, input->keybit);
500 if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK)
501 __set_bit(BTN_RIGHT, input->keybit);
502
503 if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK)
504 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
505
506 /* Handle pointer emulation and unused slots in core */
507 error = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS,
508 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
509 if (error) {
510 dev_err(dev, "failed to initialize MT slots: %d\n", error);
511 return error;
512 }
513
514 /* Register the device in input subsystem */
515 error = input_register_device(input);
516 if (error) {
517 dev_err(dev, "failed to register input device: %d\n", error);
518 return error;
519 }
520
521 cyapa->input = input;
522 return 0;
523}
524
525static void cyapa_enable_irq_for_cmd(struct cyapa *cyapa)
526{
527 struct input_dev *input = cyapa->input;
528
529 if (!input || !input_device_enabled(input)) {
530 /*
531 * When input is NULL, TP must be in deep sleep mode.
532 * In this mode, later non-power I2C command will always failed
533 * if not bring it out of deep sleep mode firstly,
534 * so must command TP to active mode here.
535 */
536 if (!input || cyapa->operational)
537 cyapa->ops->set_power_mode(cyapa,
538 PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE);
539 /* Gen3 always using polling mode for command. */
540 if (cyapa->gen >= CYAPA_GEN5)
541 enable_irq(cyapa->client->irq);
542 }
543}
544
545static void cyapa_disable_irq_for_cmd(struct cyapa *cyapa)
546{
547 struct input_dev *input = cyapa->input;
548
549 if (!input || !input_device_enabled(input)) {
550 if (cyapa->gen >= CYAPA_GEN5)
551 disable_irq(cyapa->client->irq);
552 if (!input || cyapa->operational)
553 cyapa->ops->set_power_mode(cyapa,
554 PWR_MODE_OFF, 0, CYAPA_PM_ACTIVE);
555 }
556}
557
558/*
559 * cyapa_sleep_time_to_pwr_cmd and cyapa_pwr_cmd_to_sleep_time
560 *
561 * These are helper functions that convert to and from integer idle
562 * times and register settings to write to the PowerMode register.
563 * The trackpad supports between 20ms to 1000ms scan intervals.
564 * The time will be increased in increments of 10ms from 20ms to 100ms.
565 * From 100ms to 1000ms, time will be increased in increments of 20ms.
566 *
567 * When Idle_Time < 100, the format to convert Idle_Time to Idle_Command is:
568 * Idle_Command = Idle Time / 10;
569 * When Idle_Time >= 100, the format to convert Idle_Time to Idle_Command is:
570 * Idle_Command = Idle Time / 20 + 5;
571 */
572u8 cyapa_sleep_time_to_pwr_cmd(u16 sleep_time)
573{
574 u16 encoded_time;
575
576 sleep_time = clamp_val(sleep_time, 20, 1000);
577 encoded_time = sleep_time < 100 ? sleep_time / 10 : sleep_time / 20 + 5;
578 return (encoded_time << 2) & PWR_MODE_MASK;
579}
580
581u16 cyapa_pwr_cmd_to_sleep_time(u8 pwr_mode)
582{
583 u8 encoded_time = pwr_mode >> 2;
584
585 return (encoded_time < 10) ? encoded_time * 10
586 : (encoded_time - 5) * 20;
587}
588
589/* 0 on driver initialize and detected successfully, negative on failure. */
590static int cyapa_initialize(struct cyapa *cyapa)
591{
592 int error = 0;
593
594 cyapa->state = CYAPA_STATE_NO_DEVICE;
595 cyapa->gen = CYAPA_GEN_UNKNOWN;
596 mutex_init(&cyapa->state_sync_lock);
597
598 /*
599 * Set to hard code default, they will be updated with trackpad set
600 * default values after probe and initialized.
601 */
602 cyapa->suspend_power_mode = PWR_MODE_SLEEP;
603 cyapa->suspend_sleep_time =
604 cyapa_pwr_cmd_to_sleep_time(cyapa->suspend_power_mode);
605
606 /* ops.initialize() is aimed to prepare for module communications. */
607 error = cyapa_gen3_ops.initialize(cyapa);
608 if (!error)
609 error = cyapa_gen5_ops.initialize(cyapa);
610 if (!error)
611 error = cyapa_gen6_ops.initialize(cyapa);
612 if (error)
613 return error;
614
615 error = cyapa_detect(cyapa);
616 if (error)
617 return error;
618
619 /* Power down the device until we need it. */
620 if (cyapa->operational)
621 cyapa->ops->set_power_mode(cyapa,
622 PWR_MODE_OFF, 0, CYAPA_PM_ACTIVE);
623
624 return 0;
625}
626
627static int cyapa_reinitialize(struct cyapa *cyapa)
628{
629 struct device *dev = &cyapa->client->dev;
630 struct input_dev *input = cyapa->input;
631 int error;
632
633 if (pm_runtime_enabled(dev))
634 pm_runtime_disable(dev);
635
636 /* Avoid command failures when TP was in OFF state. */
637 if (cyapa->operational)
638 cyapa->ops->set_power_mode(cyapa,
639 PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE);
640
641 error = cyapa_detect(cyapa);
642 if (error)
643 goto out;
644
645 if (!input && cyapa->operational) {
646 error = cyapa_create_input_dev(cyapa);
647 if (error) {
648 dev_err(dev, "create input_dev instance failed: %d\n",
649 error);
650 goto out;
651 }
652 }
653
654out:
655 if (!input || !input_device_enabled(input)) {
656 /* Reset to power OFF state to save power when no user open. */
657 if (cyapa->operational)
658 cyapa->ops->set_power_mode(cyapa,
659 PWR_MODE_OFF, 0, CYAPA_PM_DEACTIVE);
660 } else if (!error && cyapa->operational) {
661 /*
662 * Make sure only enable runtime PM when device is
663 * in operational mode and input->users > 0.
664 */
665 pm_runtime_set_active(dev);
666 pm_runtime_enable(dev);
667
668 pm_runtime_get_sync(dev);
669 pm_runtime_mark_last_busy(dev);
670 pm_runtime_put_sync_autosuspend(dev);
671 }
672
673 return error;
674}
675
676static irqreturn_t cyapa_irq(int irq, void *dev_id)
677{
678 struct cyapa *cyapa = dev_id;
679 struct device *dev = &cyapa->client->dev;
680 int error;
681
682 if (device_may_wakeup(dev))
683 pm_wakeup_event(dev, 0);
684
685 /* Interrupt event can be caused by host command to trackpad device. */
686 if (cyapa->ops->irq_cmd_handler(cyapa)) {
687 /*
688 * Interrupt event maybe from trackpad device input reporting.
689 */
690 if (!cyapa->input) {
691 /*
692 * Still in probing or in firmware image
693 * updating or reading.
694 */
695 cyapa->ops->sort_empty_output_data(cyapa,
696 NULL, NULL, NULL);
697 goto out;
698 }
699
700 if (cyapa->operational) {
701 error = cyapa->ops->irq_handler(cyapa);
702
703 /*
704 * Apply runtime power management to touch report event
705 * except the events caused by the command responses.
706 * Note:
707 * It will introduce about 20~40 ms additional delay
708 * time in receiving for first valid touch report data.
709 * The time is used to execute device runtime resume
710 * process.
711 */
712 pm_runtime_get_sync(dev);
713 pm_runtime_mark_last_busy(dev);
714 pm_runtime_put_sync_autosuspend(dev);
715 }
716
717 if (!cyapa->operational || error) {
718 if (!mutex_trylock(&cyapa->state_sync_lock)) {
719 cyapa->ops->sort_empty_output_data(cyapa,
720 NULL, NULL, NULL);
721 goto out;
722 }
723 cyapa_reinitialize(cyapa);
724 mutex_unlock(&cyapa->state_sync_lock);
725 }
726 }
727
728out:
729 return IRQ_HANDLED;
730}
731
732/*
733 **************************************************************
734 * sysfs interface
735 **************************************************************
736*/
737#ifdef CONFIG_PM_SLEEP
738static ssize_t cyapa_show_suspend_scanrate(struct device *dev,
739 struct device_attribute *attr,
740 char *buf)
741{
742 struct cyapa *cyapa = dev_get_drvdata(dev);
743 u8 pwr_cmd;
744 u16 sleep_time;
745 int len;
746 int error;
747
748 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
749 if (error)
750 return error;
751
752 pwr_cmd = cyapa->suspend_power_mode;
753 sleep_time = cyapa->suspend_sleep_time;
754
755 mutex_unlock(&cyapa->state_sync_lock);
756
757 switch (pwr_cmd) {
758 case PWR_MODE_BTN_ONLY:
759 len = scnprintf(buf, PAGE_SIZE, "%s\n", BTN_ONLY_MODE_NAME);
760 break;
761
762 case PWR_MODE_OFF:
763 len = scnprintf(buf, PAGE_SIZE, "%s\n", OFF_MODE_NAME);
764 break;
765
766 default:
767 len = scnprintf(buf, PAGE_SIZE, "%u\n",
768 cyapa->gen == CYAPA_GEN3 ?
769 cyapa_pwr_cmd_to_sleep_time(pwr_cmd) :
770 sleep_time);
771 break;
772 }
773
774 return len;
775}
776
777static ssize_t cyapa_update_suspend_scanrate(struct device *dev,
778 struct device_attribute *attr,
779 const char *buf, size_t count)
780{
781 struct cyapa *cyapa = dev_get_drvdata(dev);
782 u16 sleep_time;
783 int error;
784
785 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
786 if (error)
787 return error;
788
789 if (sysfs_streq(buf, BTN_ONLY_MODE_NAME)) {
790 cyapa->suspend_power_mode = PWR_MODE_BTN_ONLY;
791 } else if (sysfs_streq(buf, OFF_MODE_NAME)) {
792 cyapa->suspend_power_mode = PWR_MODE_OFF;
793 } else if (!kstrtou16(buf, 10, &sleep_time)) {
794 cyapa->suspend_sleep_time = min_t(u16, sleep_time, 1000);
795 cyapa->suspend_power_mode =
796 cyapa_sleep_time_to_pwr_cmd(cyapa->suspend_sleep_time);
797 } else {
798 count = -EINVAL;
799 }
800
801 mutex_unlock(&cyapa->state_sync_lock);
802
803 return count;
804}
805
806static DEVICE_ATTR(suspend_scanrate_ms, S_IRUGO|S_IWUSR,
807 cyapa_show_suspend_scanrate,
808 cyapa_update_suspend_scanrate);
809
810static struct attribute *cyapa_power_wakeup_entries[] = {
811 &dev_attr_suspend_scanrate_ms.attr,
812 NULL,
813};
814
815static const struct attribute_group cyapa_power_wakeup_group = {
816 .name = power_group_name,
817 .attrs = cyapa_power_wakeup_entries,
818};
819
820static void cyapa_remove_power_wakeup_group(void *data)
821{
822 struct cyapa *cyapa = data;
823
824 sysfs_unmerge_group(&cyapa->client->dev.kobj,
825 &cyapa_power_wakeup_group);
826}
827
828static int cyapa_prepare_wakeup_controls(struct cyapa *cyapa)
829{
830 struct i2c_client *client = cyapa->client;
831 struct device *dev = &client->dev;
832 int error;
833
834 if (device_can_wakeup(dev)) {
835 error = sysfs_merge_group(&dev->kobj,
836 &cyapa_power_wakeup_group);
837 if (error) {
838 dev_err(dev, "failed to add power wakeup group: %d\n",
839 error);
840 return error;
841 }
842
843 error = devm_add_action_or_reset(dev,
844 cyapa_remove_power_wakeup_group, cyapa);
845 if (error) {
846 dev_err(dev, "failed to add power cleanup action: %d\n",
847 error);
848 return error;
849 }
850 }
851
852 return 0;
853}
854#else
855static inline int cyapa_prepare_wakeup_controls(struct cyapa *cyapa)
856{
857 return 0;
858}
859#endif /* CONFIG_PM_SLEEP */
860
861#ifdef CONFIG_PM
862static ssize_t cyapa_show_rt_suspend_scanrate(struct device *dev,
863 struct device_attribute *attr,
864 char *buf)
865{
866 struct cyapa *cyapa = dev_get_drvdata(dev);
867 u8 pwr_cmd;
868 u16 sleep_time;
869 int error;
870
871 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
872 if (error)
873 return error;
874
875 pwr_cmd = cyapa->runtime_suspend_power_mode;
876 sleep_time = cyapa->runtime_suspend_sleep_time;
877
878 mutex_unlock(&cyapa->state_sync_lock);
879
880 return scnprintf(buf, PAGE_SIZE, "%u\n",
881 cyapa->gen == CYAPA_GEN3 ?
882 cyapa_pwr_cmd_to_sleep_time(pwr_cmd) :
883 sleep_time);
884}
885
886static ssize_t cyapa_update_rt_suspend_scanrate(struct device *dev,
887 struct device_attribute *attr,
888 const char *buf, size_t count)
889{
890 struct cyapa *cyapa = dev_get_drvdata(dev);
891 u16 time;
892 int error;
893
894 if (buf == NULL || count == 0 || kstrtou16(buf, 10, &time)) {
895 dev_err(dev, "invalid runtime suspend scanrate ms parameter\n");
896 return -EINVAL;
897 }
898
899 /*
900 * When the suspend scanrate is changed, pm_runtime_get to resume
901 * a potentially suspended device, update to the new pwr_cmd
902 * and then pm_runtime_put to suspend into the new power mode.
903 */
904 pm_runtime_get_sync(dev);
905
906 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
907 if (error)
908 return error;
909
910 cyapa->runtime_suspend_sleep_time = min_t(u16, time, 1000);
911 cyapa->runtime_suspend_power_mode =
912 cyapa_sleep_time_to_pwr_cmd(cyapa->runtime_suspend_sleep_time);
913
914 mutex_unlock(&cyapa->state_sync_lock);
915
916 pm_runtime_put_sync_autosuspend(dev);
917
918 return count;
919}
920
921static DEVICE_ATTR(runtime_suspend_scanrate_ms, S_IRUGO|S_IWUSR,
922 cyapa_show_rt_suspend_scanrate,
923 cyapa_update_rt_suspend_scanrate);
924
925static struct attribute *cyapa_power_runtime_entries[] = {
926 &dev_attr_runtime_suspend_scanrate_ms.attr,
927 NULL,
928};
929
930static const struct attribute_group cyapa_power_runtime_group = {
931 .name = power_group_name,
932 .attrs = cyapa_power_runtime_entries,
933};
934
935static void cyapa_remove_power_runtime_group(void *data)
936{
937 struct cyapa *cyapa = data;
938
939 sysfs_unmerge_group(&cyapa->client->dev.kobj,
940 &cyapa_power_runtime_group);
941}
942
943static int cyapa_start_runtime(struct cyapa *cyapa)
944{
945 struct device *dev = &cyapa->client->dev;
946 int error;
947
948 cyapa->runtime_suspend_power_mode = PWR_MODE_IDLE;
949 cyapa->runtime_suspend_sleep_time =
950 cyapa_pwr_cmd_to_sleep_time(cyapa->runtime_suspend_power_mode);
951
952 error = sysfs_merge_group(&dev->kobj, &cyapa_power_runtime_group);
953 if (error) {
954 dev_err(dev,
955 "failed to create power runtime group: %d\n", error);
956 return error;
957 }
958
959 error = devm_add_action_or_reset(dev, cyapa_remove_power_runtime_group,
960 cyapa);
961 if (error) {
962 dev_err(dev,
963 "failed to add power runtime cleanup action: %d\n",
964 error);
965 return error;
966 }
967
968 /* runtime is enabled until device is operational and opened. */
969 pm_runtime_set_suspended(dev);
970 pm_runtime_use_autosuspend(dev);
971 pm_runtime_set_autosuspend_delay(dev, AUTOSUSPEND_DELAY);
972
973 return 0;
974}
975#else
976static inline int cyapa_start_runtime(struct cyapa *cyapa)
977{
978 return 0;
979}
980#endif /* CONFIG_PM */
981
982static ssize_t cyapa_show_fm_ver(struct device *dev,
983 struct device_attribute *attr, char *buf)
984{
985 int error;
986 struct cyapa *cyapa = dev_get_drvdata(dev);
987
988 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
989 if (error)
990 return error;
991 error = scnprintf(buf, PAGE_SIZE, "%d.%d\n", cyapa->fw_maj_ver,
992 cyapa->fw_min_ver);
993 mutex_unlock(&cyapa->state_sync_lock);
994 return error;
995}
996
997static ssize_t cyapa_show_product_id(struct device *dev,
998 struct device_attribute *attr, char *buf)
999{
1000 struct cyapa *cyapa = dev_get_drvdata(dev);
1001 int size;
1002 int error;
1003
1004 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1005 if (error)
1006 return error;
1007 size = scnprintf(buf, PAGE_SIZE, "%s\n", cyapa->product_id);
1008 mutex_unlock(&cyapa->state_sync_lock);
1009 return size;
1010}
1011
1012static int cyapa_firmware(struct cyapa *cyapa, const char *fw_name)
1013{
1014 struct device *dev = &cyapa->client->dev;
1015 const struct firmware *fw;
1016 int error;
1017
1018 error = request_firmware(&fw, fw_name, dev);
1019 if (error) {
1020 dev_err(dev, "Could not load firmware from %s: %d\n",
1021 fw_name, error);
1022 return error;
1023 }
1024
1025 error = cyapa->ops->check_fw(cyapa, fw);
1026 if (error) {
1027 dev_err(dev, "Invalid CYAPA firmware image: %s\n",
1028 fw_name);
1029 goto done;
1030 }
1031
1032 /*
1033 * Resume the potentially suspended device because doing FW
1034 * update on a device not in the FULL mode has a chance to
1035 * fail.
1036 */
1037 pm_runtime_get_sync(dev);
1038
1039 /* Require IRQ support for firmware update commands. */
1040 cyapa_enable_irq_for_cmd(cyapa);
1041
1042 error = cyapa->ops->bl_enter(cyapa);
1043 if (error) {
1044 dev_err(dev, "bl_enter failed, %d\n", error);
1045 goto err_detect;
1046 }
1047
1048 error = cyapa->ops->bl_activate(cyapa);
1049 if (error) {
1050 dev_err(dev, "bl_activate failed, %d\n", error);
1051 goto err_detect;
1052 }
1053
1054 error = cyapa->ops->bl_initiate(cyapa, fw);
1055 if (error) {
1056 dev_err(dev, "bl_initiate failed, %d\n", error);
1057 goto err_detect;
1058 }
1059
1060 error = cyapa->ops->update_fw(cyapa, fw);
1061 if (error) {
1062 dev_err(dev, "update_fw failed, %d\n", error);
1063 goto err_detect;
1064 }
1065
1066err_detect:
1067 cyapa_disable_irq_for_cmd(cyapa);
1068 pm_runtime_put_noidle(dev);
1069
1070done:
1071 release_firmware(fw);
1072 return error;
1073}
1074
1075static ssize_t cyapa_update_fw_store(struct device *dev,
1076 struct device_attribute *attr,
1077 const char *buf, size_t count)
1078{
1079 struct cyapa *cyapa = dev_get_drvdata(dev);
1080 char fw_name[NAME_MAX];
1081 int ret, error;
1082
1083 if (count >= NAME_MAX) {
1084 dev_err(dev, "File name too long\n");
1085 return -EINVAL;
1086 }
1087
1088 memcpy(fw_name, buf, count);
1089 if (fw_name[count - 1] == '\n')
1090 fw_name[count - 1] = '\0';
1091 else
1092 fw_name[count] = '\0';
1093
1094 if (cyapa->input) {
1095 /*
1096 * Force the input device to be registered after the firmware
1097 * image is updated, so if the corresponding parameters updated
1098 * in the new firmware image can taken effect immediately.
1099 */
1100 input_unregister_device(cyapa->input);
1101 cyapa->input = NULL;
1102 }
1103
1104 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1105 if (error) {
1106 /*
1107 * Whatever, do reinitialize to try to recover TP state to
1108 * previous state just as it entered fw update entrance.
1109 */
1110 cyapa_reinitialize(cyapa);
1111 return error;
1112 }
1113
1114 error = cyapa_firmware(cyapa, fw_name);
1115 if (error)
1116 dev_err(dev, "firmware update failed: %d\n", error);
1117 else
1118 dev_dbg(dev, "firmware update successfully done.\n");
1119
1120 /*
1121 * Re-detect trackpad device states because firmware update process
1122 * will reset trackpad device into bootloader mode.
1123 */
1124 ret = cyapa_reinitialize(cyapa);
1125 if (ret) {
1126 dev_err(dev, "failed to re-detect after updated: %d\n", ret);
1127 error = error ? error : ret;
1128 }
1129
1130 mutex_unlock(&cyapa->state_sync_lock);
1131
1132 return error ? error : count;
1133}
1134
1135static ssize_t cyapa_calibrate_store(struct device *dev,
1136 struct device_attribute *attr,
1137 const char *buf, size_t count)
1138{
1139 struct cyapa *cyapa = dev_get_drvdata(dev);
1140 int error;
1141
1142 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1143 if (error)
1144 return error;
1145
1146 if (cyapa->operational) {
1147 cyapa_enable_irq_for_cmd(cyapa);
1148 error = cyapa->ops->calibrate_store(dev, attr, buf, count);
1149 cyapa_disable_irq_for_cmd(cyapa);
1150 } else {
1151 error = -EBUSY; /* Still running in bootloader mode. */
1152 }
1153
1154 mutex_unlock(&cyapa->state_sync_lock);
1155 return error < 0 ? error : count;
1156}
1157
1158static ssize_t cyapa_show_baseline(struct device *dev,
1159 struct device_attribute *attr, char *buf)
1160{
1161 struct cyapa *cyapa = dev_get_drvdata(dev);
1162 ssize_t error;
1163
1164 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1165 if (error)
1166 return error;
1167
1168 if (cyapa->operational) {
1169 cyapa_enable_irq_for_cmd(cyapa);
1170 error = cyapa->ops->show_baseline(dev, attr, buf);
1171 cyapa_disable_irq_for_cmd(cyapa);
1172 } else {
1173 error = -EBUSY; /* Still running in bootloader mode. */
1174 }
1175
1176 mutex_unlock(&cyapa->state_sync_lock);
1177 return error;
1178}
1179
1180static char *cyapa_state_to_string(struct cyapa *cyapa)
1181{
1182 switch (cyapa->state) {
1183 case CYAPA_STATE_BL_BUSY:
1184 return "bootloader busy";
1185 case CYAPA_STATE_BL_IDLE:
1186 return "bootloader idle";
1187 case CYAPA_STATE_BL_ACTIVE:
1188 return "bootloader active";
1189 case CYAPA_STATE_GEN5_BL:
1190 case CYAPA_STATE_GEN6_BL:
1191 return "bootloader";
1192 case CYAPA_STATE_OP:
1193 case CYAPA_STATE_GEN5_APP:
1194 case CYAPA_STATE_GEN6_APP:
1195 return "operational"; /* Normal valid state. */
1196 default:
1197 return "invalid mode";
1198 }
1199}
1200
1201static ssize_t cyapa_show_mode(struct device *dev,
1202 struct device_attribute *attr, char *buf)
1203{
1204 struct cyapa *cyapa = dev_get_drvdata(dev);
1205 int size;
1206 int error;
1207
1208 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1209 if (error)
1210 return error;
1211
1212 size = scnprintf(buf, PAGE_SIZE, "gen%d %s\n",
1213 cyapa->gen, cyapa_state_to_string(cyapa));
1214
1215 mutex_unlock(&cyapa->state_sync_lock);
1216 return size;
1217}
1218
1219static DEVICE_ATTR(firmware_version, S_IRUGO, cyapa_show_fm_ver, NULL);
1220static DEVICE_ATTR(product_id, S_IRUGO, cyapa_show_product_id, NULL);
1221static DEVICE_ATTR(update_fw, S_IWUSR, NULL, cyapa_update_fw_store);
1222static DEVICE_ATTR(baseline, S_IRUGO, cyapa_show_baseline, NULL);
1223static DEVICE_ATTR(calibrate, S_IWUSR, NULL, cyapa_calibrate_store);
1224static DEVICE_ATTR(mode, S_IRUGO, cyapa_show_mode, NULL);
1225
1226static struct attribute *cyapa_sysfs_entries[] = {
1227 &dev_attr_firmware_version.attr,
1228 &dev_attr_product_id.attr,
1229 &dev_attr_update_fw.attr,
1230 &dev_attr_baseline.attr,
1231 &dev_attr_calibrate.attr,
1232 &dev_attr_mode.attr,
1233 NULL,
1234};
1235
1236static const struct attribute_group cyapa_sysfs_group = {
1237 .attrs = cyapa_sysfs_entries,
1238};
1239
1240static void cyapa_disable_regulator(void *data)
1241{
1242 struct cyapa *cyapa = data;
1243
1244 regulator_disable(cyapa->vcc);
1245}
1246
1247static int cyapa_probe(struct i2c_client *client)
1248{
1249 struct device *dev = &client->dev;
1250 struct cyapa *cyapa;
1251 u8 adapter_func;
1252 union i2c_smbus_data dummy;
1253 int error;
1254
1255 adapter_func = cyapa_check_adapter_functionality(client);
1256 if (adapter_func == CYAPA_ADAPTER_FUNC_NONE) {
1257 dev_err(dev, "not a supported I2C/SMBus adapter\n");
1258 return -EIO;
1259 }
1260
1261 /* Make sure there is something at this address */
1262 if (i2c_smbus_xfer(client->adapter, client->addr, 0,
1263 I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0)
1264 return -ENODEV;
1265
1266 cyapa = devm_kzalloc(dev, sizeof(struct cyapa), GFP_KERNEL);
1267 if (!cyapa)
1268 return -ENOMEM;
1269
1270 /* i2c isn't supported, use smbus */
1271 if (adapter_func == CYAPA_ADAPTER_FUNC_SMBUS)
1272 cyapa->smbus = true;
1273
1274 cyapa->client = client;
1275 i2c_set_clientdata(client, cyapa);
1276 sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr,
1277 client->addr);
1278
1279 cyapa->vcc = devm_regulator_get(dev, "vcc");
1280 if (IS_ERR(cyapa->vcc)) {
1281 error = PTR_ERR(cyapa->vcc);
1282 dev_err(dev, "failed to get vcc regulator: %d\n", error);
1283 return error;
1284 }
1285
1286 error = regulator_enable(cyapa->vcc);
1287 if (error) {
1288 dev_err(dev, "failed to enable regulator: %d\n", error);
1289 return error;
1290 }
1291
1292 error = devm_add_action_or_reset(dev, cyapa_disable_regulator, cyapa);
1293 if (error) {
1294 dev_err(dev, "failed to add disable regulator action: %d\n",
1295 error);
1296 return error;
1297 }
1298
1299 error = cyapa_initialize(cyapa);
1300 if (error) {
1301 dev_err(dev, "failed to detect and initialize tp device.\n");
1302 return error;
1303 }
1304
1305 error = devm_device_add_group(dev, &cyapa_sysfs_group);
1306 if (error) {
1307 dev_err(dev, "failed to create sysfs entries: %d\n", error);
1308 return error;
1309 }
1310
1311 error = cyapa_prepare_wakeup_controls(cyapa);
1312 if (error) {
1313 dev_err(dev, "failed to prepare wakeup controls: %d\n", error);
1314 return error;
1315 }
1316
1317 error = cyapa_start_runtime(cyapa);
1318 if (error) {
1319 dev_err(dev, "failed to start pm_runtime: %d\n", error);
1320 return error;
1321 }
1322
1323 error = devm_request_threaded_irq(dev, client->irq,
1324 NULL, cyapa_irq,
1325 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1326 "cyapa", cyapa);
1327 if (error) {
1328 dev_err(dev, "failed to request threaded irq: %d\n", error);
1329 return error;
1330 }
1331
1332 /* Disable IRQ until the device is opened */
1333 disable_irq(client->irq);
1334
1335 /*
1336 * Register the device in the input subsystem when it's operational.
1337 * Otherwise, keep in this driver, so it can be be recovered or updated
1338 * through the sysfs mode and update_fw interfaces by user or apps.
1339 */
1340 if (cyapa->operational) {
1341 error = cyapa_create_input_dev(cyapa);
1342 if (error) {
1343 dev_err(dev, "create input_dev instance failed: %d\n",
1344 error);
1345 return error;
1346 }
1347 }
1348
1349 return 0;
1350}
1351
1352static int __maybe_unused cyapa_suspend(struct device *dev)
1353{
1354 struct i2c_client *client = to_i2c_client(dev);
1355 struct cyapa *cyapa = i2c_get_clientdata(client);
1356 u8 power_mode;
1357 int error;
1358
1359 error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1360 if (error)
1361 return error;
1362
1363 /*
1364 * Runtime PM is enable only when device is in operational mode and
1365 * users in use, so need check it before disable it to
1366 * avoid unbalance warning.
1367 */
1368 if (pm_runtime_enabled(dev))
1369 pm_runtime_disable(dev);
1370 disable_irq(client->irq);
1371
1372 /*
1373 * Set trackpad device to idle mode if wakeup is allowed,
1374 * otherwise turn off.
1375 */
1376 if (cyapa->operational) {
1377 power_mode = device_may_wakeup(dev) ? cyapa->suspend_power_mode
1378 : PWR_MODE_OFF;
1379 error = cyapa->ops->set_power_mode(cyapa, power_mode,
1380 cyapa->suspend_sleep_time, CYAPA_PM_SUSPEND);
1381 if (error)
1382 dev_err(dev, "suspend set power mode failed: %d\n",
1383 error);
1384 }
1385
1386 /*
1387 * Disable proximity interrupt when system idle, want true touch to
1388 * wake the system.
1389 */
1390 if (cyapa->dev_pwr_mode != PWR_MODE_OFF)
1391 cyapa->ops->set_proximity(cyapa, false);
1392
1393 if (device_may_wakeup(dev))
1394 cyapa->irq_wake = (enable_irq_wake(client->irq) == 0);
1395
1396 mutex_unlock(&cyapa->state_sync_lock);
1397 return 0;
1398}
1399
1400static int __maybe_unused cyapa_resume(struct device *dev)
1401{
1402 struct i2c_client *client = to_i2c_client(dev);
1403 struct cyapa *cyapa = i2c_get_clientdata(client);
1404 int error;
1405
1406 mutex_lock(&cyapa->state_sync_lock);
1407
1408 if (device_may_wakeup(dev) && cyapa->irq_wake) {
1409 disable_irq_wake(client->irq);
1410 cyapa->irq_wake = false;
1411 }
1412
1413 /*
1414 * Update device states and runtime PM states.
1415 * Re-Enable proximity interrupt after enter operational mode.
1416 */
1417 error = cyapa_reinitialize(cyapa);
1418 if (error)
1419 dev_warn(dev, "failed to reinitialize TP device: %d\n", error);
1420
1421 enable_irq(client->irq);
1422
1423 mutex_unlock(&cyapa->state_sync_lock);
1424 return 0;
1425}
1426
1427static int __maybe_unused cyapa_runtime_suspend(struct device *dev)
1428{
1429 struct cyapa *cyapa = dev_get_drvdata(dev);
1430 int error;
1431
1432 error = cyapa->ops->set_power_mode(cyapa,
1433 cyapa->runtime_suspend_power_mode,
1434 cyapa->runtime_suspend_sleep_time,
1435 CYAPA_PM_RUNTIME_SUSPEND);
1436 if (error)
1437 dev_warn(dev, "runtime suspend failed: %d\n", error);
1438
1439 return 0;
1440}
1441
1442static int __maybe_unused cyapa_runtime_resume(struct device *dev)
1443{
1444 struct cyapa *cyapa = dev_get_drvdata(dev);
1445 int error;
1446
1447 error = cyapa->ops->set_power_mode(cyapa,
1448 PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_RUNTIME_RESUME);
1449 if (error)
1450 dev_warn(dev, "runtime resume failed: %d\n", error);
1451
1452 return 0;
1453}
1454
1455static const struct dev_pm_ops cyapa_pm_ops = {
1456 SET_SYSTEM_SLEEP_PM_OPS(cyapa_suspend, cyapa_resume)
1457 SET_RUNTIME_PM_OPS(cyapa_runtime_suspend, cyapa_runtime_resume, NULL)
1458};
1459
1460static const struct i2c_device_id cyapa_id_table[] = {
1461 { "cyapa", 0 },
1462 { },
1463};
1464MODULE_DEVICE_TABLE(i2c, cyapa_id_table);
1465
1466#ifdef CONFIG_ACPI
1467static const struct acpi_device_id cyapa_acpi_id[] = {
1468 { "CYAP0000", 0 }, /* Gen3 trackpad with 0x67 I2C address. */
1469 { "CYAP0001", 0 }, /* Gen5 trackpad with 0x24 I2C address. */
1470 { "CYAP0002", 0 }, /* Gen6 trackpad with 0x24 I2C address. */
1471 { }
1472};
1473MODULE_DEVICE_TABLE(acpi, cyapa_acpi_id);
1474#endif
1475
1476#ifdef CONFIG_OF
1477static const struct of_device_id cyapa_of_match[] = {
1478 { .compatible = "cypress,cyapa" },
1479 { /* sentinel */ }
1480};
1481MODULE_DEVICE_TABLE(of, cyapa_of_match);
1482#endif
1483
1484static struct i2c_driver cyapa_driver = {
1485 .driver = {
1486 .name = "cyapa",
1487 .pm = &cyapa_pm_ops,
1488 .acpi_match_table = ACPI_PTR(cyapa_acpi_id),
1489 .of_match_table = of_match_ptr(cyapa_of_match),
1490 },
1491
1492 .probe_new = cyapa_probe,
1493 .id_table = cyapa_id_table,
1494};
1495
1496module_i2c_driver(cyapa_driver);
1497
1498MODULE_DESCRIPTION("Cypress APA I2C Trackpad Driver");
1499MODULE_AUTHOR("Dudley Du <dudl@cypress.com>");
1500MODULE_LICENSE("GPL");
1/*
2 * Cypress APA trackpad with I2C interface
3 *
4 * Author: Dudley Du <dudl@cypress.com>
5 * Further cleanup and restructuring by:
6 * Daniel Kurtz <djkurtz@chromium.org>
7 * Benson Leung <bleung@chromium.org>
8 *
9 * Copyright (C) 2011-2012 Cypress Semiconductor, Inc.
10 * Copyright (C) 2011-2012 Google, Inc.
11 *
12 * This file is subject to the terms and conditions of the GNU General Public
13 * License. See the file COPYING in the main directory of this archive for
14 * more details.
15 */
16
17#include <linux/delay.h>
18#include <linux/i2c.h>
19#include <linux/input.h>
20#include <linux/input/mt.h>
21#include <linux/interrupt.h>
22#include <linux/module.h>
23#include <linux/slab.h>
24
25/* APA trackpad firmware generation */
26#define CYAPA_GEN3 0x03 /* support MT-protocol B with tracking ID. */
27
28#define CYAPA_NAME "Cypress APA Trackpad (cyapa)"
29
30/* commands for read/write registers of Cypress trackpad */
31#define CYAPA_CMD_SOFT_RESET 0x00
32#define CYAPA_CMD_POWER_MODE 0x01
33#define CYAPA_CMD_DEV_STATUS 0x02
34#define CYAPA_CMD_GROUP_DATA 0x03
35#define CYAPA_CMD_GROUP_CMD 0x04
36#define CYAPA_CMD_GROUP_QUERY 0x05
37#define CYAPA_CMD_BL_STATUS 0x06
38#define CYAPA_CMD_BL_HEAD 0x07
39#define CYAPA_CMD_BL_CMD 0x08
40#define CYAPA_CMD_BL_DATA 0x09
41#define CYAPA_CMD_BL_ALL 0x0a
42#define CYAPA_CMD_BLK_PRODUCT_ID 0x0b
43#define CYAPA_CMD_BLK_HEAD 0x0c
44
45/* report data start reg offset address. */
46#define DATA_REG_START_OFFSET 0x0000
47
48#define BL_HEAD_OFFSET 0x00
49#define BL_DATA_OFFSET 0x10
50
51/*
52 * Operational Device Status Register
53 *
54 * bit 7: Valid interrupt source
55 * bit 6 - 4: Reserved
56 * bit 3 - 2: Power status
57 * bit 1 - 0: Device status
58 */
59#define REG_OP_STATUS 0x00
60#define OP_STATUS_SRC 0x80
61#define OP_STATUS_POWER 0x0c
62#define OP_STATUS_DEV 0x03
63#define OP_STATUS_MASK (OP_STATUS_SRC | OP_STATUS_POWER | OP_STATUS_DEV)
64
65/*
66 * Operational Finger Count/Button Flags Register
67 *
68 * bit 7 - 4: Number of touched finger
69 * bit 3: Valid data
70 * bit 2: Middle Physical Button
71 * bit 1: Right Physical Button
72 * bit 0: Left physical Button
73 */
74#define REG_OP_DATA1 0x01
75#define OP_DATA_VALID 0x08
76#define OP_DATA_MIDDLE_BTN 0x04
77#define OP_DATA_RIGHT_BTN 0x02
78#define OP_DATA_LEFT_BTN 0x01
79#define OP_DATA_BTN_MASK (OP_DATA_MIDDLE_BTN | OP_DATA_RIGHT_BTN | \
80 OP_DATA_LEFT_BTN)
81
82/*
83 * Bootloader Status Register
84 *
85 * bit 7: Busy
86 * bit 6 - 5: Reserved
87 * bit 4: Bootloader running
88 * bit 3 - 1: Reserved
89 * bit 0: Checksum valid
90 */
91#define REG_BL_STATUS 0x01
92#define BL_STATUS_BUSY 0x80
93#define BL_STATUS_RUNNING 0x10
94#define BL_STATUS_DATA_VALID 0x08
95#define BL_STATUS_CSUM_VALID 0x01
96
97/*
98 * Bootloader Error Register
99 *
100 * bit 7: Invalid
101 * bit 6: Invalid security key
102 * bit 5: Bootloading
103 * bit 4: Command checksum
104 * bit 3: Flash protection error
105 * bit 2: Flash checksum error
106 * bit 1 - 0: Reserved
107 */
108#define REG_BL_ERROR 0x02
109#define BL_ERROR_INVALID 0x80
110#define BL_ERROR_INVALID_KEY 0x40
111#define BL_ERROR_BOOTLOADING 0x20
112#define BL_ERROR_CMD_CSUM 0x10
113#define BL_ERROR_FLASH_PROT 0x08
114#define BL_ERROR_FLASH_CSUM 0x04
115
116#define BL_STATUS_SIZE 3 /* length of bootloader status registers */
117#define BLK_HEAD_BYTES 32
118
119#define PRODUCT_ID_SIZE 16
120#define QUERY_DATA_SIZE 27
121#define REG_PROTOCOL_GEN_QUERY_OFFSET 20
122
123#define REG_OFFSET_DATA_BASE 0x0000
124#define REG_OFFSET_COMMAND_BASE 0x0028
125#define REG_OFFSET_QUERY_BASE 0x002a
126
127#define CAPABILITY_LEFT_BTN_MASK (0x01 << 3)
128#define CAPABILITY_RIGHT_BTN_MASK (0x01 << 4)
129#define CAPABILITY_MIDDLE_BTN_MASK (0x01 << 5)
130#define CAPABILITY_BTN_MASK (CAPABILITY_LEFT_BTN_MASK | \
131 CAPABILITY_RIGHT_BTN_MASK | \
132 CAPABILITY_MIDDLE_BTN_MASK)
133
134#define CYAPA_OFFSET_SOFT_RESET REG_OFFSET_COMMAND_BASE
135
136#define REG_OFFSET_POWER_MODE (REG_OFFSET_COMMAND_BASE + 1)
137
138#define PWR_MODE_MASK 0xfc
139#define PWR_MODE_FULL_ACTIVE (0x3f << 2)
140#define PWR_MODE_IDLE (0x05 << 2) /* default sleep time is 50 ms. */
141#define PWR_MODE_OFF (0x00 << 2)
142
143#define PWR_STATUS_MASK 0x0c
144#define PWR_STATUS_ACTIVE (0x03 << 2)
145#define PWR_STATUS_IDLE (0x02 << 2)
146#define PWR_STATUS_OFF (0x00 << 2)
147
148/*
149 * CYAPA trackpad device states.
150 * Used in register 0x00, bit1-0, DeviceStatus field.
151 * Other values indicate device is in an abnormal state and must be reset.
152 */
153#define CYAPA_DEV_NORMAL 0x03
154#define CYAPA_DEV_BUSY 0x01
155
156enum cyapa_state {
157 CYAPA_STATE_OP,
158 CYAPA_STATE_BL_IDLE,
159 CYAPA_STATE_BL_ACTIVE,
160 CYAPA_STATE_BL_BUSY,
161 CYAPA_STATE_NO_DEVICE,
162};
163
164
165struct cyapa_touch {
166 /*
167 * high bits or x/y position value
168 * bit 7 - 4: high 4 bits of x position value
169 * bit 3 - 0: high 4 bits of y position value
170 */
171 u8 xy_hi;
172 u8 x_lo; /* low 8 bits of x position value. */
173 u8 y_lo; /* low 8 bits of y position value. */
174 u8 pressure;
175 /* id range is 1 - 15. It is incremented with every new touch. */
176 u8 id;
177} __packed;
178
179/* The touch.id is used as the MT slot id, thus max MT slot is 15 */
180#define CYAPA_MAX_MT_SLOTS 15
181
182struct cyapa_reg_data {
183 /*
184 * bit 0 - 1: device status
185 * bit 3 - 2: power mode
186 * bit 6 - 4: reserved
187 * bit 7: interrupt valid bit
188 */
189 u8 device_status;
190 /*
191 * bit 7 - 4: number of fingers currently touching pad
192 * bit 3: valid data check bit
193 * bit 2: middle mechanism button state if exists
194 * bit 1: right mechanism button state if exists
195 * bit 0: left mechanism button state if exists
196 */
197 u8 finger_btn;
198 /* CYAPA reports up to 5 touches per packet. */
199 struct cyapa_touch touches[5];
200} __packed;
201
202/* The main device structure */
203struct cyapa {
204 enum cyapa_state state;
205
206 struct i2c_client *client;
207 struct input_dev *input;
208 char phys[32]; /* device physical location */
209 int irq;
210 bool irq_wake; /* irq wake is enabled */
211 bool smbus;
212
213 /* read from query data region. */
214 char product_id[16];
215 u8 btn_capability;
216 u8 gen;
217 int max_abs_x;
218 int max_abs_y;
219 int physical_size_x;
220 int physical_size_y;
221};
222
223static const u8 bl_deactivate[] = { 0x00, 0xff, 0x3b, 0x00, 0x01, 0x02, 0x03,
224 0x04, 0x05, 0x06, 0x07 };
225static const u8 bl_exit[] = { 0x00, 0xff, 0xa5, 0x00, 0x01, 0x02, 0x03, 0x04,
226 0x05, 0x06, 0x07 };
227
228struct cyapa_cmd_len {
229 u8 cmd;
230 u8 len;
231};
232
233#define CYAPA_ADAPTER_FUNC_NONE 0
234#define CYAPA_ADAPTER_FUNC_I2C 1
235#define CYAPA_ADAPTER_FUNC_SMBUS 2
236#define CYAPA_ADAPTER_FUNC_BOTH 3
237
238/*
239 * macros for SMBus communication
240 */
241#define SMBUS_READ 0x01
242#define SMBUS_WRITE 0x00
243#define SMBUS_ENCODE_IDX(cmd, idx) ((cmd) | (((idx) & 0x03) << 1))
244#define SMBUS_ENCODE_RW(cmd, rw) ((cmd) | ((rw) & 0x01))
245#define SMBUS_BYTE_BLOCK_CMD_MASK 0x80
246#define SMBUS_GROUP_BLOCK_CMD_MASK 0x40
247
248 /* for byte read/write command */
249#define CMD_RESET 0
250#define CMD_POWER_MODE 1
251#define CMD_DEV_STATUS 2
252#define SMBUS_BYTE_CMD(cmd) (((cmd) & 0x3f) << 1)
253#define CYAPA_SMBUS_RESET SMBUS_BYTE_CMD(CMD_RESET)
254#define CYAPA_SMBUS_POWER_MODE SMBUS_BYTE_CMD(CMD_POWER_MODE)
255#define CYAPA_SMBUS_DEV_STATUS SMBUS_BYTE_CMD(CMD_DEV_STATUS)
256
257 /* for group registers read/write command */
258#define REG_GROUP_DATA 0
259#define REG_GROUP_CMD 2
260#define REG_GROUP_QUERY 3
261#define SMBUS_GROUP_CMD(grp) (0x80 | (((grp) & 0x07) << 3))
262#define CYAPA_SMBUS_GROUP_DATA SMBUS_GROUP_CMD(REG_GROUP_DATA)
263#define CYAPA_SMBUS_GROUP_CMD SMBUS_GROUP_CMD(REG_GROUP_CMD)
264#define CYAPA_SMBUS_GROUP_QUERY SMBUS_GROUP_CMD(REG_GROUP_QUERY)
265
266 /* for register block read/write command */
267#define CMD_BL_STATUS 0
268#define CMD_BL_HEAD 1
269#define CMD_BL_CMD 2
270#define CMD_BL_DATA 3
271#define CMD_BL_ALL 4
272#define CMD_BLK_PRODUCT_ID 5
273#define CMD_BLK_HEAD 6
274#define SMBUS_BLOCK_CMD(cmd) (0xc0 | (((cmd) & 0x1f) << 1))
275
276/* register block read/write command in bootloader mode */
277#define CYAPA_SMBUS_BL_STATUS SMBUS_BLOCK_CMD(CMD_BL_STATUS)
278#define CYAPA_SMBUS_BL_HEAD SMBUS_BLOCK_CMD(CMD_BL_HEAD)
279#define CYAPA_SMBUS_BL_CMD SMBUS_BLOCK_CMD(CMD_BL_CMD)
280#define CYAPA_SMBUS_BL_DATA SMBUS_BLOCK_CMD(CMD_BL_DATA)
281#define CYAPA_SMBUS_BL_ALL SMBUS_BLOCK_CMD(CMD_BL_ALL)
282
283/* register block read/write command in operational mode */
284#define CYAPA_SMBUS_BLK_PRODUCT_ID SMBUS_BLOCK_CMD(CMD_BLK_PRODUCT_ID)
285#define CYAPA_SMBUS_BLK_HEAD SMBUS_BLOCK_CMD(CMD_BLK_HEAD)
286
287static const struct cyapa_cmd_len cyapa_i2c_cmds[] = {
288 { CYAPA_OFFSET_SOFT_RESET, 1 },
289 { REG_OFFSET_COMMAND_BASE + 1, 1 },
290 { REG_OFFSET_DATA_BASE, 1 },
291 { REG_OFFSET_DATA_BASE, sizeof(struct cyapa_reg_data) },
292 { REG_OFFSET_COMMAND_BASE, 0 },
293 { REG_OFFSET_QUERY_BASE, QUERY_DATA_SIZE },
294 { BL_HEAD_OFFSET, 3 },
295 { BL_HEAD_OFFSET, 16 },
296 { BL_HEAD_OFFSET, 16 },
297 { BL_DATA_OFFSET, 16 },
298 { BL_HEAD_OFFSET, 32 },
299 { REG_OFFSET_QUERY_BASE, PRODUCT_ID_SIZE },
300 { REG_OFFSET_DATA_BASE, 32 }
301};
302
303static const struct cyapa_cmd_len cyapa_smbus_cmds[] = {
304 { CYAPA_SMBUS_RESET, 1 },
305 { CYAPA_SMBUS_POWER_MODE, 1 },
306 { CYAPA_SMBUS_DEV_STATUS, 1 },
307 { CYAPA_SMBUS_GROUP_DATA, sizeof(struct cyapa_reg_data) },
308 { CYAPA_SMBUS_GROUP_CMD, 2 },
309 { CYAPA_SMBUS_GROUP_QUERY, QUERY_DATA_SIZE },
310 { CYAPA_SMBUS_BL_STATUS, 3 },
311 { CYAPA_SMBUS_BL_HEAD, 16 },
312 { CYAPA_SMBUS_BL_CMD, 16 },
313 { CYAPA_SMBUS_BL_DATA, 16 },
314 { CYAPA_SMBUS_BL_ALL, 32 },
315 { CYAPA_SMBUS_BLK_PRODUCT_ID, PRODUCT_ID_SIZE },
316 { CYAPA_SMBUS_BLK_HEAD, 16 },
317};
318
319static ssize_t cyapa_i2c_reg_read_block(struct cyapa *cyapa, u8 reg, size_t len,
320 u8 *values)
321{
322 return i2c_smbus_read_i2c_block_data(cyapa->client, reg, len, values);
323}
324
325static ssize_t cyapa_i2c_reg_write_block(struct cyapa *cyapa, u8 reg,
326 size_t len, const u8 *values)
327{
328 return i2c_smbus_write_i2c_block_data(cyapa->client, reg, len, values);
329}
330
331/*
332 * cyapa_smbus_read_block - perform smbus block read command
333 * @cyapa - private data structure of the driver
334 * @cmd - the properly encoded smbus command
335 * @len - expected length of smbus command result
336 * @values - buffer to store smbus command result
337 *
338 * Returns negative errno, else the number of bytes written.
339 *
340 * Note:
341 * In trackpad device, the memory block allocated for I2C register map
342 * is 256 bytes, so the max read block for I2C bus is 256 bytes.
343 */
344static ssize_t cyapa_smbus_read_block(struct cyapa *cyapa, u8 cmd, size_t len,
345 u8 *values)
346{
347 ssize_t ret;
348 u8 index;
349 u8 smbus_cmd;
350 u8 *buf;
351 struct i2c_client *client = cyapa->client;
352
353 if (!(SMBUS_BYTE_BLOCK_CMD_MASK & cmd))
354 return -EINVAL;
355
356 if (SMBUS_GROUP_BLOCK_CMD_MASK & cmd) {
357 /* read specific block registers command. */
358 smbus_cmd = SMBUS_ENCODE_RW(cmd, SMBUS_READ);
359 ret = i2c_smbus_read_block_data(client, smbus_cmd, values);
360 goto out;
361 }
362
363 ret = 0;
364 for (index = 0; index * I2C_SMBUS_BLOCK_MAX < len; index++) {
365 smbus_cmd = SMBUS_ENCODE_IDX(cmd, index);
366 smbus_cmd = SMBUS_ENCODE_RW(smbus_cmd, SMBUS_READ);
367 buf = values + I2C_SMBUS_BLOCK_MAX * index;
368 ret = i2c_smbus_read_block_data(client, smbus_cmd, buf);
369 if (ret < 0)
370 goto out;
371 }
372
373out:
374 return ret > 0 ? len : ret;
375}
376
377static s32 cyapa_read_byte(struct cyapa *cyapa, u8 cmd_idx)
378{
379 u8 cmd;
380
381 if (cyapa->smbus) {
382 cmd = cyapa_smbus_cmds[cmd_idx].cmd;
383 cmd = SMBUS_ENCODE_RW(cmd, SMBUS_READ);
384 } else {
385 cmd = cyapa_i2c_cmds[cmd_idx].cmd;
386 }
387 return i2c_smbus_read_byte_data(cyapa->client, cmd);
388}
389
390static s32 cyapa_write_byte(struct cyapa *cyapa, u8 cmd_idx, u8 value)
391{
392 u8 cmd;
393
394 if (cyapa->smbus) {
395 cmd = cyapa_smbus_cmds[cmd_idx].cmd;
396 cmd = SMBUS_ENCODE_RW(cmd, SMBUS_WRITE);
397 } else {
398 cmd = cyapa_i2c_cmds[cmd_idx].cmd;
399 }
400 return i2c_smbus_write_byte_data(cyapa->client, cmd, value);
401}
402
403static ssize_t cyapa_read_block(struct cyapa *cyapa, u8 cmd_idx, u8 *values)
404{
405 u8 cmd;
406 size_t len;
407
408 if (cyapa->smbus) {
409 cmd = cyapa_smbus_cmds[cmd_idx].cmd;
410 len = cyapa_smbus_cmds[cmd_idx].len;
411 return cyapa_smbus_read_block(cyapa, cmd, len, values);
412 } else {
413 cmd = cyapa_i2c_cmds[cmd_idx].cmd;
414 len = cyapa_i2c_cmds[cmd_idx].len;
415 return cyapa_i2c_reg_read_block(cyapa, cmd, len, values);
416 }
417}
418
419/*
420 * Query device for its current operating state.
421 *
422 */
423static int cyapa_get_state(struct cyapa *cyapa)
424{
425 int ret;
426 u8 status[BL_STATUS_SIZE];
427
428 cyapa->state = CYAPA_STATE_NO_DEVICE;
429
430 /*
431 * Get trackpad status by reading 3 registers starting from 0.
432 * If the device is in the bootloader, this will be BL_HEAD.
433 * If the device is in operation mode, this will be the DATA regs.
434 *
435 */
436 ret = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE,
437 status);
438
439 /*
440 * On smbus systems in OP mode, the i2c_reg_read will fail with
441 * -ETIMEDOUT. In this case, try again using the smbus equivalent
442 * command. This should return a BL_HEAD indicating CYAPA_STATE_OP.
443 */
444 if (cyapa->smbus && (ret == -ETIMEDOUT || ret == -ENXIO))
445 ret = cyapa_read_block(cyapa, CYAPA_CMD_BL_STATUS, status);
446
447 if (ret != BL_STATUS_SIZE)
448 goto error;
449
450 if ((status[REG_OP_STATUS] & OP_STATUS_SRC) == OP_STATUS_SRC) {
451 switch (status[REG_OP_STATUS] & OP_STATUS_DEV) {
452 case CYAPA_DEV_NORMAL:
453 case CYAPA_DEV_BUSY:
454 cyapa->state = CYAPA_STATE_OP;
455 break;
456 default:
457 ret = -EAGAIN;
458 goto error;
459 }
460 } else {
461 if (status[REG_BL_STATUS] & BL_STATUS_BUSY)
462 cyapa->state = CYAPA_STATE_BL_BUSY;
463 else if (status[REG_BL_ERROR] & BL_ERROR_BOOTLOADING)
464 cyapa->state = CYAPA_STATE_BL_ACTIVE;
465 else
466 cyapa->state = CYAPA_STATE_BL_IDLE;
467 }
468
469 return 0;
470error:
471 return (ret < 0) ? ret : -EAGAIN;
472}
473
474/*
475 * Poll device for its status in a loop, waiting up to timeout for a response.
476 *
477 * When the device switches state, it usually takes ~300 ms.
478 * However, when running a new firmware image, the device must calibrate its
479 * sensors, which can take as long as 2 seconds.
480 *
481 * Note: The timeout has granularity of the polling rate, which is 100 ms.
482 *
483 * Returns:
484 * 0 when the device eventually responds with a valid non-busy state.
485 * -ETIMEDOUT if device never responds (too many -EAGAIN)
486 * < 0 other errors
487 */
488static int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout)
489{
490 int ret;
491 int tries = timeout / 100;
492
493 ret = cyapa_get_state(cyapa);
494 while ((ret || cyapa->state >= CYAPA_STATE_BL_BUSY) && tries--) {
495 msleep(100);
496 ret = cyapa_get_state(cyapa);
497 }
498 return (ret == -EAGAIN || ret == -ETIMEDOUT) ? -ETIMEDOUT : ret;
499}
500
501static int cyapa_bl_deactivate(struct cyapa *cyapa)
502{
503 int ret;
504
505 ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_deactivate),
506 bl_deactivate);
507 if (ret < 0)
508 return ret;
509
510 /* wait for bootloader to switch to idle state; should take < 100ms */
511 msleep(100);
512 ret = cyapa_poll_state(cyapa, 500);
513 if (ret < 0)
514 return ret;
515 if (cyapa->state != CYAPA_STATE_BL_IDLE)
516 return -EAGAIN;
517 return 0;
518}
519
520/*
521 * Exit bootloader
522 *
523 * Send bl_exit command, then wait 50 - 100 ms to let device transition to
524 * operational mode. If this is the first time the device's firmware is
525 * running, it can take up to 2 seconds to calibrate its sensors. So, poll
526 * the device's new state for up to 2 seconds.
527 *
528 * Returns:
529 * -EIO failure while reading from device
530 * -EAGAIN device is stuck in bootloader, b/c it has invalid firmware
531 * 0 device is supported and in operational mode
532 */
533static int cyapa_bl_exit(struct cyapa *cyapa)
534{
535 int ret;
536
537 ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_exit), bl_exit);
538 if (ret < 0)
539 return ret;
540
541 /*
542 * Wait for bootloader to exit, and operation mode to start.
543 * Normally, this takes at least 50 ms.
544 */
545 usleep_range(50000, 100000);
546 /*
547 * In addition, when a device boots for the first time after being
548 * updated to new firmware, it must first calibrate its sensors, which
549 * can take up to an additional 2 seconds.
550 */
551 ret = cyapa_poll_state(cyapa, 2000);
552 if (ret < 0)
553 return ret;
554 if (cyapa->state != CYAPA_STATE_OP)
555 return -EAGAIN;
556
557 return 0;
558}
559
560/*
561 * Set device power mode
562 *
563 */
564static int cyapa_set_power_mode(struct cyapa *cyapa, u8 power_mode)
565{
566 struct device *dev = &cyapa->client->dev;
567 int ret;
568 u8 power;
569
570 if (cyapa->state != CYAPA_STATE_OP)
571 return 0;
572
573 ret = cyapa_read_byte(cyapa, CYAPA_CMD_POWER_MODE);
574 if (ret < 0)
575 return ret;
576
577 power = ret & ~PWR_MODE_MASK;
578 power |= power_mode & PWR_MODE_MASK;
579 ret = cyapa_write_byte(cyapa, CYAPA_CMD_POWER_MODE, power);
580 if (ret < 0)
581 dev_err(dev, "failed to set power_mode 0x%02x err = %d\n",
582 power_mode, ret);
583 return ret;
584}
585
586static int cyapa_get_query_data(struct cyapa *cyapa)
587{
588 u8 query_data[QUERY_DATA_SIZE];
589 int ret;
590
591 if (cyapa->state != CYAPA_STATE_OP)
592 return -EBUSY;
593
594 ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_QUERY, query_data);
595 if (ret < 0)
596 return ret;
597 if (ret != QUERY_DATA_SIZE)
598 return -EIO;
599
600 memcpy(&cyapa->product_id[0], &query_data[0], 5);
601 cyapa->product_id[5] = '-';
602 memcpy(&cyapa->product_id[6], &query_data[5], 6);
603 cyapa->product_id[12] = '-';
604 memcpy(&cyapa->product_id[13], &query_data[11], 2);
605 cyapa->product_id[15] = '\0';
606
607 cyapa->btn_capability = query_data[19] & CAPABILITY_BTN_MASK;
608
609 cyapa->gen = query_data[20] & 0x0f;
610
611 cyapa->max_abs_x = ((query_data[21] & 0xf0) << 4) | query_data[22];
612 cyapa->max_abs_y = ((query_data[21] & 0x0f) << 8) | query_data[23];
613
614 cyapa->physical_size_x =
615 ((query_data[24] & 0xf0) << 4) | query_data[25];
616 cyapa->physical_size_y =
617 ((query_data[24] & 0x0f) << 8) | query_data[26];
618
619 return 0;
620}
621
622/*
623 * Check if device is operational.
624 *
625 * An operational device is responding, has exited bootloader, and has
626 * firmware supported by this driver.
627 *
628 * Returns:
629 * -EBUSY no device or in bootloader
630 * -EIO failure while reading from device
631 * -EAGAIN device is still in bootloader
632 * if ->state = CYAPA_STATE_BL_IDLE, device has invalid firmware
633 * -EINVAL device is in operational mode, but not supported by this driver
634 * 0 device is supported
635 */
636static int cyapa_check_is_operational(struct cyapa *cyapa)
637{
638 struct device *dev = &cyapa->client->dev;
639 static const char unique_str[] = "CYTRA";
640 int ret;
641
642 ret = cyapa_poll_state(cyapa, 2000);
643 if (ret < 0)
644 return ret;
645 switch (cyapa->state) {
646 case CYAPA_STATE_BL_ACTIVE:
647 ret = cyapa_bl_deactivate(cyapa);
648 if (ret)
649 return ret;
650
651 /* Fallthrough state */
652 case CYAPA_STATE_BL_IDLE:
653 ret = cyapa_bl_exit(cyapa);
654 if (ret)
655 return ret;
656
657 /* Fallthrough state */
658 case CYAPA_STATE_OP:
659 ret = cyapa_get_query_data(cyapa);
660 if (ret < 0)
661 return ret;
662
663 /* only support firmware protocol gen3 */
664 if (cyapa->gen != CYAPA_GEN3) {
665 dev_err(dev, "unsupported protocol version (%d)",
666 cyapa->gen);
667 return -EINVAL;
668 }
669
670 /* only support product ID starting with CYTRA */
671 if (memcmp(cyapa->product_id, unique_str,
672 sizeof(unique_str) - 1) != 0) {
673 dev_err(dev, "unsupported product ID (%s)\n",
674 cyapa->product_id);
675 return -EINVAL;
676 }
677 return 0;
678
679 default:
680 return -EIO;
681 }
682 return 0;
683}
684
685static irqreturn_t cyapa_irq(int irq, void *dev_id)
686{
687 struct cyapa *cyapa = dev_id;
688 struct device *dev = &cyapa->client->dev;
689 struct input_dev *input = cyapa->input;
690 struct cyapa_reg_data data;
691 int i;
692 int ret;
693 int num_fingers;
694
695 if (device_may_wakeup(dev))
696 pm_wakeup_event(dev, 0);
697
698 ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_DATA, (u8 *)&data);
699 if (ret != sizeof(data))
700 goto out;
701
702 if ((data.device_status & OP_STATUS_SRC) != OP_STATUS_SRC ||
703 (data.device_status & OP_STATUS_DEV) != CYAPA_DEV_NORMAL ||
704 (data.finger_btn & OP_DATA_VALID) != OP_DATA_VALID) {
705 goto out;
706 }
707
708 num_fingers = (data.finger_btn >> 4) & 0x0f;
709 for (i = 0; i < num_fingers; i++) {
710 const struct cyapa_touch *touch = &data.touches[i];
711 /* Note: touch->id range is 1 to 15; slots are 0 to 14. */
712 int slot = touch->id - 1;
713
714 input_mt_slot(input, slot);
715 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
716 input_report_abs(input, ABS_MT_POSITION_X,
717 ((touch->xy_hi & 0xf0) << 4) | touch->x_lo);
718 input_report_abs(input, ABS_MT_POSITION_Y,
719 ((touch->xy_hi & 0x0f) << 8) | touch->y_lo);
720 input_report_abs(input, ABS_MT_PRESSURE, touch->pressure);
721 }
722
723 input_mt_sync_frame(input);
724
725 if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK)
726 input_report_key(input, BTN_LEFT,
727 data.finger_btn & OP_DATA_LEFT_BTN);
728
729 if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK)
730 input_report_key(input, BTN_MIDDLE,
731 data.finger_btn & OP_DATA_MIDDLE_BTN);
732
733 if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK)
734 input_report_key(input, BTN_RIGHT,
735 data.finger_btn & OP_DATA_RIGHT_BTN);
736
737 input_sync(input);
738
739out:
740 return IRQ_HANDLED;
741}
742
743static u8 cyapa_check_adapter_functionality(struct i2c_client *client)
744{
745 u8 ret = CYAPA_ADAPTER_FUNC_NONE;
746
747 if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
748 ret |= CYAPA_ADAPTER_FUNC_I2C;
749 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA |
750 I2C_FUNC_SMBUS_BLOCK_DATA |
751 I2C_FUNC_SMBUS_I2C_BLOCK))
752 ret |= CYAPA_ADAPTER_FUNC_SMBUS;
753 return ret;
754}
755
756static int cyapa_create_input_dev(struct cyapa *cyapa)
757{
758 struct device *dev = &cyapa->client->dev;
759 int ret;
760 struct input_dev *input;
761
762 if (!cyapa->physical_size_x || !cyapa->physical_size_y)
763 return -EINVAL;
764
765 input = cyapa->input = input_allocate_device();
766 if (!input) {
767 dev_err(dev, "allocate memory for input device failed\n");
768 return -ENOMEM;
769 }
770
771 input->name = CYAPA_NAME;
772 input->phys = cyapa->phys;
773 input->id.bustype = BUS_I2C;
774 input->id.version = 1;
775 input->id.product = 0; /* means any product in eventcomm. */
776 input->dev.parent = &cyapa->client->dev;
777
778 input_set_drvdata(input, cyapa);
779
780 __set_bit(EV_ABS, input->evbit);
781
782 /* finger position */
783 input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0,
784 0);
785 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0,
786 0);
787 input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0);
788
789 input_abs_set_res(input, ABS_MT_POSITION_X,
790 cyapa->max_abs_x / cyapa->physical_size_x);
791 input_abs_set_res(input, ABS_MT_POSITION_Y,
792 cyapa->max_abs_y / cyapa->physical_size_y);
793
794 if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK)
795 __set_bit(BTN_LEFT, input->keybit);
796 if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK)
797 __set_bit(BTN_MIDDLE, input->keybit);
798 if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK)
799 __set_bit(BTN_RIGHT, input->keybit);
800
801 if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK)
802 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
803
804 /* handle pointer emulation and unused slots in core */
805 ret = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS,
806 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
807 if (ret) {
808 dev_err(dev, "allocate memory for MT slots failed, %d\n", ret);
809 goto err_free_device;
810 }
811
812 /* Register the device in input subsystem */
813 ret = input_register_device(input);
814 if (ret) {
815 dev_err(dev, "input device register failed, %d\n", ret);
816 goto err_free_device;
817 }
818 return 0;
819
820err_free_device:
821 input_free_device(input);
822 cyapa->input = NULL;
823 return ret;
824}
825
826static int cyapa_probe(struct i2c_client *client,
827 const struct i2c_device_id *dev_id)
828{
829 int ret;
830 u8 adapter_func;
831 struct cyapa *cyapa;
832 struct device *dev = &client->dev;
833
834 adapter_func = cyapa_check_adapter_functionality(client);
835 if (adapter_func == CYAPA_ADAPTER_FUNC_NONE) {
836 dev_err(dev, "not a supported I2C/SMBus adapter\n");
837 return -EIO;
838 }
839
840 cyapa = kzalloc(sizeof(struct cyapa), GFP_KERNEL);
841 if (!cyapa) {
842 dev_err(dev, "allocate memory for cyapa failed\n");
843 return -ENOMEM;
844 }
845
846 cyapa->gen = CYAPA_GEN3;
847 cyapa->client = client;
848 i2c_set_clientdata(client, cyapa);
849 sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr,
850 client->addr);
851
852 /* i2c isn't supported, use smbus */
853 if (adapter_func == CYAPA_ADAPTER_FUNC_SMBUS)
854 cyapa->smbus = true;
855 cyapa->state = CYAPA_STATE_NO_DEVICE;
856 ret = cyapa_check_is_operational(cyapa);
857 if (ret) {
858 dev_err(dev, "device not operational, %d\n", ret);
859 goto err_mem_free;
860 }
861
862 ret = cyapa_create_input_dev(cyapa);
863 if (ret) {
864 dev_err(dev, "create input_dev instance failed, %d\n", ret);
865 goto err_mem_free;
866 }
867
868 ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE);
869 if (ret) {
870 dev_err(dev, "set active power failed, %d\n", ret);
871 goto err_unregister_device;
872 }
873
874 cyapa->irq = client->irq;
875 ret = request_threaded_irq(cyapa->irq,
876 NULL,
877 cyapa_irq,
878 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
879 "cyapa",
880 cyapa);
881 if (ret) {
882 dev_err(dev, "IRQ request failed: %d\n, ", ret);
883 goto err_unregister_device;
884 }
885
886 return 0;
887
888err_unregister_device:
889 input_unregister_device(cyapa->input);
890err_mem_free:
891 kfree(cyapa);
892
893 return ret;
894}
895
896static int cyapa_remove(struct i2c_client *client)
897{
898 struct cyapa *cyapa = i2c_get_clientdata(client);
899
900 free_irq(cyapa->irq, cyapa);
901 input_unregister_device(cyapa->input);
902 cyapa_set_power_mode(cyapa, PWR_MODE_OFF);
903 kfree(cyapa);
904
905 return 0;
906}
907
908#ifdef CONFIG_PM_SLEEP
909static int cyapa_suspend(struct device *dev)
910{
911 int ret;
912 u8 power_mode;
913 struct cyapa *cyapa = dev_get_drvdata(dev);
914
915 disable_irq(cyapa->irq);
916
917 /*
918 * Set trackpad device to idle mode if wakeup is allowed,
919 * otherwise turn off.
920 */
921 power_mode = device_may_wakeup(dev) ? PWR_MODE_IDLE
922 : PWR_MODE_OFF;
923 ret = cyapa_set_power_mode(cyapa, power_mode);
924 if (ret < 0)
925 dev_err(dev, "set power mode failed, %d\n", ret);
926
927 if (device_may_wakeup(dev))
928 cyapa->irq_wake = (enable_irq_wake(cyapa->irq) == 0);
929 return 0;
930}
931
932static int cyapa_resume(struct device *dev)
933{
934 int ret;
935 struct cyapa *cyapa = dev_get_drvdata(dev);
936
937 if (device_may_wakeup(dev) && cyapa->irq_wake)
938 disable_irq_wake(cyapa->irq);
939
940 ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE);
941 if (ret)
942 dev_warn(dev, "resume active power failed, %d\n", ret);
943
944 enable_irq(cyapa->irq);
945 return 0;
946}
947#endif /* CONFIG_PM_SLEEP */
948
949static SIMPLE_DEV_PM_OPS(cyapa_pm_ops, cyapa_suspend, cyapa_resume);
950
951static const struct i2c_device_id cyapa_id_table[] = {
952 { "cyapa", 0 },
953 { },
954};
955MODULE_DEVICE_TABLE(i2c, cyapa_id_table);
956
957static struct i2c_driver cyapa_driver = {
958 .driver = {
959 .name = "cyapa",
960 .owner = THIS_MODULE,
961 .pm = &cyapa_pm_ops,
962 },
963
964 .probe = cyapa_probe,
965 .remove = cyapa_remove,
966 .id_table = cyapa_id_table,
967};
968
969module_i2c_driver(cyapa_driver);
970
971MODULE_DESCRIPTION("Cypress APA I2C Trackpad Driver");
972MODULE_AUTHOR("Dudley Du <dudl@cypress.com>");
973MODULE_LICENSE("GPL");