1 // SPDX-License-Identifier: GPL-2.0-only
3 * Elan I2C/SMBus Touchpad driver - I2C interface
5 * Copyright (c) 2013 ELAN Microelectronics Corp.
7 * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw>
9 * Based on cyapa driver:
10 * copyright (c) 2011-2012 Cypress Semiconductor, Inc.
11 * copyright (c) 2011-2012 Google, Inc.
13 * Trademarks are the property of their respective owners.
16 #include <linux/completion.h>
17 #include <linux/delay.h>
18 #include <linux/i2c.h>
19 #include <linux/interrupt.h>
20 #include <linux/jiffies.h>
21 #include <linux/kernel.h>
22 #include <linux/sched.h>
23 #include <asm/unaligned.h>
27 /* Elan i2c commands */
28 #define ETP_I2C_RESET 0x0100
29 #define ETP_I2C_WAKE_UP 0x0800
30 #define ETP_I2C_SLEEP 0x0801
31 #define ETP_I2C_DESC_CMD 0x0001
32 #define ETP_I2C_REPORT_DESC_CMD 0x0002
33 #define ETP_I2C_STAND_CMD 0x0005
34 #define ETP_I2C_PATTERN_CMD 0x0100
35 #define ETP_I2C_UNIQUEID_CMD 0x0101
36 #define ETP_I2C_FW_VERSION_CMD 0x0102
37 #define ETP_I2C_IC_TYPE_CMD 0x0103
38 #define ETP_I2C_OSM_VERSION_CMD 0x0103
39 #define ETP_I2C_NSM_VERSION_CMD 0x0104
40 #define ETP_I2C_XY_TRACENUM_CMD 0x0105
41 #define ETP_I2C_MAX_X_AXIS_CMD 0x0106
42 #define ETP_I2C_MAX_Y_AXIS_CMD 0x0107
43 #define ETP_I2C_RESOLUTION_CMD 0x0108
44 #define ETP_I2C_PRESSURE_CMD 0x010A
45 #define ETP_I2C_IAP_VERSION_CMD 0x0110
46 #define ETP_I2C_SET_CMD 0x0300
47 #define ETP_I2C_POWER_CMD 0x0307
48 #define ETP_I2C_FW_CHECKSUM_CMD 0x030F
49 #define ETP_I2C_IAP_CTRL_CMD 0x0310
50 #define ETP_I2C_IAP_CMD 0x0311
51 #define ETP_I2C_IAP_RESET_CMD 0x0314
52 #define ETP_I2C_IAP_CHECKSUM_CMD 0x0315
53 #define ETP_I2C_CALIBRATE_CMD 0x0316
54 #define ETP_I2C_MAX_BASELINE_CMD 0x0317
55 #define ETP_I2C_MIN_BASELINE_CMD 0x0318
57 #define ETP_I2C_REPORT_LEN 34
58 #define ETP_I2C_DESC_LENGTH 30
59 #define ETP_I2C_REPORT_DESC_LENGTH 158
60 #define ETP_I2C_INF_LENGTH 2
61 #define ETP_I2C_IAP_PASSWORD 0x1EA5
62 #define ETP_I2C_IAP_RESET 0xF0F0
63 #define ETP_I2C_MAIN_MODE_ON (1 << 9)
64 #define ETP_I2C_IAP_REG_L 0x01
65 #define ETP_I2C_IAP_REG_H 0x06
67 static int elan_i2c_read_block(struct i2c_client
*client
,
68 u16 reg
, u8
*val
, u16 len
)
73 struct i2c_msg msgs
[] = {
76 .flags
= client
->flags
& I2C_M_TEN
,
82 .flags
= (client
->flags
& I2C_M_TEN
) | I2C_M_RD
,
89 ret
= i2c_transfer(client
->adapter
, msgs
, ARRAY_SIZE(msgs
));
90 return ret
== ARRAY_SIZE(msgs
) ? 0 : (ret
< 0 ? ret
: -EIO
);
93 static int elan_i2c_read_cmd(struct i2c_client
*client
, u16 reg
, u8
*val
)
97 retval
= elan_i2c_read_block(client
, reg
, val
, ETP_I2C_INF_LENGTH
);
99 dev_err(&client
->dev
, "reading cmd (0x%04x) fail.\n", reg
);
106 static int elan_i2c_write_cmd(struct i2c_client
*client
, u16 reg
, u16 cmd
)
112 struct i2c_msg msg
= {
113 .addr
= client
->addr
,
114 .flags
= client
->flags
& I2C_M_TEN
,
120 ret
= i2c_transfer(client
->adapter
, &msg
, 1);
124 dev_err(&client
->dev
, "writing cmd (0x%04x) failed: %d\n",
132 static int elan_i2c_initialize(struct i2c_client
*client
)
134 struct device
*dev
= &client
->dev
;
138 error
= elan_i2c_write_cmd(client
, ETP_I2C_STAND_CMD
, ETP_I2C_RESET
);
140 dev_err(dev
, "device reset failed: %d\n", error
);
144 /* Wait for the device to reset */
147 /* get reset acknowledgement 0000 */
148 error
= i2c_master_recv(client
, val
, ETP_I2C_INF_LENGTH
);
150 dev_err(dev
, "failed to read reset response: %d\n", error
);
154 error
= elan_i2c_read_block(client
, ETP_I2C_DESC_CMD
,
155 val
, ETP_I2C_DESC_LENGTH
);
157 dev_err(dev
, "cannot get device descriptor: %d\n", error
);
161 error
= elan_i2c_read_block(client
, ETP_I2C_REPORT_DESC_CMD
,
162 val
, ETP_I2C_REPORT_DESC_LENGTH
);
164 dev_err(dev
, "fetching report descriptor failed.: %d\n", error
);
171 static int elan_i2c_sleep_control(struct i2c_client
*client
, bool sleep
)
173 return elan_i2c_write_cmd(client
, ETP_I2C_STAND_CMD
,
174 sleep
? ETP_I2C_SLEEP
: ETP_I2C_WAKE_UP
);
177 static int elan_i2c_power_control(struct i2c_client
*client
, bool enable
)
183 error
= elan_i2c_read_cmd(client
, ETP_I2C_POWER_CMD
, val
);
185 dev_err(&client
->dev
,
186 "failed to read current power state: %d\n",
191 reg
= le16_to_cpup((__le16
*)val
);
193 reg
&= ~ETP_DISABLE_POWER
;
195 reg
|= ETP_DISABLE_POWER
;
197 error
= elan_i2c_write_cmd(client
, ETP_I2C_POWER_CMD
, reg
);
199 dev_err(&client
->dev
,
200 "failed to write current power state: %d\n",
208 static int elan_i2c_set_mode(struct i2c_client
*client
, u8 mode
)
210 return elan_i2c_write_cmd(client
, ETP_I2C_SET_CMD
, mode
);
214 static int elan_i2c_calibrate(struct i2c_client
*client
)
216 return elan_i2c_write_cmd(client
, ETP_I2C_CALIBRATE_CMD
, 1);
219 static int elan_i2c_calibrate_result(struct i2c_client
*client
, u8
*val
)
221 return elan_i2c_read_block(client
, ETP_I2C_CALIBRATE_CMD
, val
, 1);
224 static int elan_i2c_get_baseline_data(struct i2c_client
*client
,
225 bool max_baseline
, u8
*value
)
230 error
= elan_i2c_read_cmd(client
,
231 max_baseline
? ETP_I2C_MAX_BASELINE_CMD
:
232 ETP_I2C_MIN_BASELINE_CMD
,
237 *value
= le16_to_cpup((__le16
*)val
);
242 static int elan_i2c_get_pattern(struct i2c_client
*client
, u8
*pattern
)
247 error
= elan_i2c_read_cmd(client
, ETP_I2C_PATTERN_CMD
, val
);
249 dev_err(&client
->dev
, "failed to get pattern: %d\n", error
);
257 static int elan_i2c_get_version(struct i2c_client
*client
,
258 bool iap
, u8
*version
)
264 error
= elan_i2c_get_pattern(client
, &pattern_ver
);
266 dev_err(&client
->dev
, "failed to get pattern version\n");
270 error
= elan_i2c_read_cmd(client
,
271 iap
? ETP_I2C_IAP_VERSION_CMD
:
272 ETP_I2C_FW_VERSION_CMD
,
275 dev_err(&client
->dev
, "failed to get %s version: %d\n",
276 iap
? "IAP" : "FW", error
);
280 if (pattern_ver
== 0x01)
281 *version
= iap
? val
[1] : val
[0];
287 static int elan_i2c_get_sm_version(struct i2c_client
*client
,
288 u16
*ic_type
, u8
*version
,
295 error
= elan_i2c_get_pattern(client
, &pattern_ver
);
297 dev_err(&client
->dev
, "failed to get pattern version\n");
301 if (pattern_ver
== 0x01) {
302 error
= elan_i2c_read_cmd(client
, ETP_I2C_IC_TYPE_CMD
, val
);
304 dev_err(&client
->dev
, "failed to get ic type: %d\n",
308 *ic_type
= be16_to_cpup((__be16
*)val
);
310 error
= elan_i2c_read_cmd(client
, ETP_I2C_NSM_VERSION_CMD
,
313 dev_err(&client
->dev
, "failed to get SM version: %d\n",
318 *clickpad
= val
[0] & 0x10;
320 error
= elan_i2c_read_cmd(client
, ETP_I2C_OSM_VERSION_CMD
, val
);
322 dev_err(&client
->dev
, "failed to get SM version: %d\n",
329 error
= elan_i2c_read_cmd(client
, ETP_I2C_NSM_VERSION_CMD
,
332 dev_err(&client
->dev
, "failed to get SM version: %d\n",
336 *clickpad
= val
[0] & 0x10;
342 static int elan_i2c_get_product_id(struct i2c_client
*client
, u16
*id
)
347 error
= elan_i2c_read_cmd(client
, ETP_I2C_UNIQUEID_CMD
, val
);
349 dev_err(&client
->dev
, "failed to get product ID: %d\n", error
);
353 *id
= le16_to_cpup((__le16
*)val
);
357 static int elan_i2c_get_checksum(struct i2c_client
*client
,
363 error
= elan_i2c_read_cmd(client
,
364 iap
? ETP_I2C_IAP_CHECKSUM_CMD
:
365 ETP_I2C_FW_CHECKSUM_CMD
,
368 dev_err(&client
->dev
, "failed to get %s checksum: %d\n",
369 iap
? "IAP" : "FW", error
);
373 *csum
= le16_to_cpup((__le16
*)val
);
377 static int elan_i2c_get_max(struct i2c_client
*client
,
378 unsigned int *max_x
, unsigned int *max_y
)
383 error
= elan_i2c_read_cmd(client
, ETP_I2C_MAX_X_AXIS_CMD
, val
);
385 dev_err(&client
->dev
, "failed to get X dimension: %d\n", error
);
389 *max_x
= le16_to_cpup((__le16
*)val
) & 0x0fff;
391 error
= elan_i2c_read_cmd(client
, ETP_I2C_MAX_Y_AXIS_CMD
, val
);
393 dev_err(&client
->dev
, "failed to get Y dimension: %d\n", error
);
397 *max_y
= le16_to_cpup((__le16
*)val
) & 0x0fff;
402 static int elan_i2c_get_resolution(struct i2c_client
*client
,
403 u8
*hw_res_x
, u8
*hw_res_y
)
408 error
= elan_i2c_read_cmd(client
, ETP_I2C_RESOLUTION_CMD
, val
);
410 dev_err(&client
->dev
, "failed to get resolution: %d\n", error
);
420 static int elan_i2c_get_num_traces(struct i2c_client
*client
,
421 unsigned int *x_traces
,
422 unsigned int *y_traces
)
427 error
= elan_i2c_read_cmd(client
, ETP_I2C_XY_TRACENUM_CMD
, val
);
429 dev_err(&client
->dev
, "failed to get trace info: %d\n", error
);
439 static int elan_i2c_get_pressure_adjustment(struct i2c_client
*client
,
445 error
= elan_i2c_read_cmd(client
, ETP_I2C_PRESSURE_CMD
, val
);
447 dev_err(&client
->dev
, "failed to get pressure format: %d\n",
452 if ((val
[0] >> 4) & 0x1)
455 *adjustment
= ETP_PRESSURE_OFFSET
;
460 static int elan_i2c_iap_get_mode(struct i2c_client
*client
, enum tp_mode
*mode
)
466 error
= elan_i2c_read_cmd(client
, ETP_I2C_IAP_CTRL_CMD
, val
);
468 dev_err(&client
->dev
,
469 "failed to read iap control register: %d\n",
474 constant
= le16_to_cpup((__le16
*)val
);
475 dev_dbg(&client
->dev
, "iap control reg: 0x%04x.\n", constant
);
477 *mode
= (constant
& ETP_I2C_MAIN_MODE_ON
) ? MAIN_MODE
: IAP_MODE
;
482 static int elan_i2c_iap_reset(struct i2c_client
*client
)
486 error
= elan_i2c_write_cmd(client
, ETP_I2C_IAP_RESET_CMD
,
489 dev_err(&client
->dev
, "cannot reset IC: %d\n", error
);
496 static int elan_i2c_set_flash_key(struct i2c_client
*client
)
500 error
= elan_i2c_write_cmd(client
, ETP_I2C_IAP_CMD
,
501 ETP_I2C_IAP_PASSWORD
);
503 dev_err(&client
->dev
, "cannot set flash key: %d\n", error
);
510 static int elan_i2c_prepare_fw_update(struct i2c_client
*client
)
512 struct device
*dev
= &client
->dev
;
518 /* Get FW in which mode (IAP_MODE/MAIN_MODE) */
519 error
= elan_i2c_iap_get_mode(client
, &mode
);
523 if (mode
== IAP_MODE
) {
525 error
= elan_i2c_iap_reset(client
);
533 error
= elan_i2c_set_flash_key(client
);
537 /* Wait for F/W IAP initialization */
538 msleep(mode
== MAIN_MODE
? 100 : 30);
540 /* Check if we are in IAP mode or not */
541 error
= elan_i2c_iap_get_mode(client
, &mode
);
545 if (mode
== MAIN_MODE
) {
546 dev_err(dev
, "wrong mode: %d\n", mode
);
550 /* Set flash key again */
551 error
= elan_i2c_set_flash_key(client
);
555 /* Wait for F/W IAP initialization */
558 /* read back to check we actually enabled successfully. */
559 error
= elan_i2c_read_cmd(client
, ETP_I2C_IAP_CMD
, val
);
561 dev_err(dev
, "cannot read iap password: %d\n",
566 password
= le16_to_cpup((__le16
*)val
);
567 if (password
!= ETP_I2C_IAP_PASSWORD
) {
568 dev_err(dev
, "wrong iap password: 0x%X\n", password
);
575 static int elan_i2c_write_fw_block(struct i2c_client
*client
,
576 const u8
*page
, u16 checksum
, int idx
)
578 struct device
*dev
= &client
->dev
;
579 u8 page_store
[ETP_FW_PAGE_SIZE
+ 4];
584 page_store
[0] = ETP_I2C_IAP_REG_L
;
585 page_store
[1] = ETP_I2C_IAP_REG_H
;
586 memcpy(&page_store
[2], page
, ETP_FW_PAGE_SIZE
);
587 /* recode checksum at last two bytes */
588 put_unaligned_le16(checksum
, &page_store
[ETP_FW_PAGE_SIZE
+ 2]);
590 ret
= i2c_master_send(client
, page_store
, sizeof(page_store
));
591 if (ret
!= sizeof(page_store
)) {
592 error
= ret
< 0 ? ret
: -EIO
;
593 dev_err(dev
, "Failed to write page %d: %d\n", idx
, error
);
597 /* Wait for F/W to update one page ROM data. */
600 error
= elan_i2c_read_cmd(client
, ETP_I2C_IAP_CTRL_CMD
, val
);
602 dev_err(dev
, "Failed to read IAP write result: %d\n", error
);
606 result
= le16_to_cpup((__le16
*)val
);
607 if (result
& (ETP_FW_IAP_PAGE_ERR
| ETP_FW_IAP_INTF_ERR
)) {
608 dev_err(dev
, "IAP reports failed write: %04hx\n",
616 static int elan_i2c_finish_fw_update(struct i2c_client
*client
,
617 struct completion
*completion
)
619 struct device
*dev
= &client
->dev
;
622 u8 buffer
[ETP_I2C_REPORT_LEN
];
624 len
= i2c_master_recv(client
, buffer
, ETP_I2C_REPORT_LEN
);
625 if (len
!= ETP_I2C_REPORT_LEN
) {
626 error
= len
< 0 ? len
: -EIO
;
627 dev_warn(dev
, "failed to read I2C data after FW WDT reset: %d (%d)\n",
631 reinit_completion(completion
);
632 enable_irq(client
->irq
);
634 error
= elan_i2c_write_cmd(client
, ETP_I2C_STAND_CMD
, ETP_I2C_RESET
);
636 dev_err(dev
, "device reset failed: %d\n", error
);
637 } else if (!wait_for_completion_timeout(completion
,
638 msecs_to_jiffies(300))) {
639 dev_err(dev
, "timeout waiting for device reset\n");
643 disable_irq(client
->irq
);
648 len
= i2c_master_recv(client
, buffer
, ETP_I2C_INF_LENGTH
);
649 if (len
!= ETP_I2C_INF_LENGTH
) {
650 error
= len
< 0 ? len
: -EIO
;
651 dev_err(dev
, "failed to read INT signal: %d (%d)\n",
659 static int elan_i2c_get_report(struct i2c_client
*client
, u8
*report
)
663 len
= i2c_master_recv(client
, report
, ETP_I2C_REPORT_LEN
);
665 dev_err(&client
->dev
, "failed to read report data: %d\n", len
);
669 if (len
!= ETP_I2C_REPORT_LEN
) {
670 dev_err(&client
->dev
,
671 "wrong report length (%d vs %d expected)\n",
672 len
, ETP_I2C_REPORT_LEN
);
679 const struct elan_transport_ops elan_i2c_ops
= {
680 .initialize
= elan_i2c_initialize
,
681 .sleep_control
= elan_i2c_sleep_control
,
682 .power_control
= elan_i2c_power_control
,
683 .set_mode
= elan_i2c_set_mode
,
685 .calibrate
= elan_i2c_calibrate
,
686 .calibrate_result
= elan_i2c_calibrate_result
,
688 .get_baseline_data
= elan_i2c_get_baseline_data
,
690 .get_version
= elan_i2c_get_version
,
691 .get_sm_version
= elan_i2c_get_sm_version
,
692 .get_product_id
= elan_i2c_get_product_id
,
693 .get_checksum
= elan_i2c_get_checksum
,
694 .get_pressure_adjustment
= elan_i2c_get_pressure_adjustment
,
696 .get_max
= elan_i2c_get_max
,
697 .get_resolution
= elan_i2c_get_resolution
,
698 .get_num_traces
= elan_i2c_get_num_traces
,
700 .iap_get_mode
= elan_i2c_iap_get_mode
,
701 .iap_reset
= elan_i2c_iap_reset
,
703 .prepare_fw_update
= elan_i2c_prepare_fw_update
,
704 .write_fw_block
= elan_i2c_write_fw_block
,
705 .finish_fw_update
= elan_i2c_finish_fw_update
,
707 .get_pattern
= elan_i2c_get_pattern
,
709 .get_report
= elan_i2c_get_report
,