1 // SPDX-License-Identifier: GPL-2.0-only
3 * Elan I2C/SMBus Touchpad driver - SMBus 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/delay.h>
17 #include <linux/i2c.h>
18 #include <linux/init.h>
19 #include <linux/kernel.h>
23 /* Elan SMbus commands */
24 #define ETP_SMBUS_IAP_CMD 0x00
25 #define ETP_SMBUS_ENABLE_TP 0x20
26 #define ETP_SMBUS_SLEEP_CMD 0x21
27 #define ETP_SMBUS_IAP_PASSWORD_WRITE 0x29
28 #define ETP_SMBUS_IAP_PASSWORD_READ 0x80
29 #define ETP_SMBUS_WRITE_FW_BLOCK 0x2A
30 #define ETP_SMBUS_IAP_RESET_CMD 0x2B
31 #define ETP_SMBUS_RANGE_CMD 0xA0
32 #define ETP_SMBUS_FW_VERSION_CMD 0xA1
33 #define ETP_SMBUS_XY_TRACENUM_CMD 0xA2
34 #define ETP_SMBUS_SM_VERSION_CMD 0xA3
35 #define ETP_SMBUS_UNIQUEID_CMD 0xA3
36 #define ETP_SMBUS_RESOLUTION_CMD 0xA4
37 #define ETP_SMBUS_HELLOPACKET_CMD 0xA7
38 #define ETP_SMBUS_PACKET_QUERY 0xA8
39 #define ETP_SMBUS_IAP_VERSION_CMD 0xAC
40 #define ETP_SMBUS_IAP_CTRL_CMD 0xAD
41 #define ETP_SMBUS_IAP_CHECKSUM_CMD 0xAE
42 #define ETP_SMBUS_FW_CHECKSUM_CMD 0xAF
43 #define ETP_SMBUS_MAX_BASELINE_CMD 0xC3
44 #define ETP_SMBUS_MIN_BASELINE_CMD 0xC4
45 #define ETP_SMBUS_CALIBRATE_QUERY 0xC5
47 #define ETP_SMBUS_REPORT_LEN 32
48 #define ETP_SMBUS_REPORT_OFFSET 2
49 #define ETP_SMBUS_HELLOPACKET_LEN 5
50 #define ETP_SMBUS_IAP_PASSWORD 0x1234
51 #define ETP_SMBUS_IAP_MODE_ON (1 << 6)
53 static int elan_smbus_initialize(struct i2c_client *client)
55 u8 check[ETP_SMBUS_HELLOPACKET_LEN] = { 0x55, 0x55, 0x55, 0x55, 0x55 };
56 u8 values[I2C_SMBUS_BLOCK_MAX] = {0};
59 /* Get hello packet */
60 len = i2c_smbus_read_block_data(client,
61 ETP_SMBUS_HELLOPACKET_CMD, values);
62 if (len != ETP_SMBUS_HELLOPACKET_LEN) {
63 dev_err(&client->dev, "hello packet length fail: %d\n", len);
64 error = len < 0 ? len : -EIO;
68 /* compare hello packet */
69 if (memcmp(values, check, ETP_SMBUS_HELLOPACKET_LEN)) {
70 dev_err(&client->dev, "hello packet fail [%*ph]\n",
71 ETP_SMBUS_HELLOPACKET_LEN, values);
76 error = i2c_smbus_write_byte(client, ETP_SMBUS_ENABLE_TP);
78 dev_err(&client->dev, "failed to enable touchpad: %d\n", error);
85 static int elan_smbus_set_mode(struct i2c_client *client, u8 mode)
87 u8 cmd[4] = { 0x00, 0x07, 0x00, mode };
89 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
93 static int elan_smbus_sleep_control(struct i2c_client *client, bool sleep)
96 return i2c_smbus_write_byte(client, ETP_SMBUS_SLEEP_CMD);
98 return 0; /* XXX should we send ETP_SMBUS_ENABLE_TP here? */
101 static int elan_smbus_power_control(struct i2c_client *client, bool enable)
103 return 0; /* A no-op */
106 static int elan_smbus_calibrate(struct i2c_client *client)
108 u8 cmd[4] = { 0x00, 0x08, 0x00, 0x01 };
110 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
114 static int elan_smbus_calibrate_result(struct i2c_client *client, u8 *val)
117 u8 buf[I2C_SMBUS_BLOCK_MAX] = {0};
119 BUILD_BUG_ON(ETP_CALIBRATE_MAX_LEN > sizeof(buf));
121 error = i2c_smbus_read_block_data(client,
122 ETP_SMBUS_CALIBRATE_QUERY, buf);
126 memcpy(val, buf, ETP_CALIBRATE_MAX_LEN);
130 static int elan_smbus_get_baseline_data(struct i2c_client *client,
131 bool max_baseline, u8 *value)
134 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
136 error = i2c_smbus_read_block_data(client,
138 ETP_SMBUS_MAX_BASELINE_CMD :
139 ETP_SMBUS_MIN_BASELINE_CMD,
144 *value = be16_to_cpup((__be16 *)val);
149 static int elan_smbus_get_version(struct i2c_client *client,
150 bool iap, u8 *version)
153 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
155 error = i2c_smbus_read_block_data(client,
156 iap ? ETP_SMBUS_IAP_VERSION_CMD :
157 ETP_SMBUS_FW_VERSION_CMD,
160 dev_err(&client->dev, "failed to get %s version: %d\n",
161 iap ? "IAP" : "FW", error);
169 static int elan_smbus_get_sm_version(struct i2c_client *client,
170 u16 *ic_type, u8 *version,
174 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
176 error = i2c_smbus_read_block_data(client,
177 ETP_SMBUS_SM_VERSION_CMD, val);
179 dev_err(&client->dev, "failed to get SM version: %d\n", error);
185 *clickpad = val[0] & 0x10;
189 static int elan_smbus_get_product_id(struct i2c_client *client, u16 *id)
192 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
194 error = i2c_smbus_read_block_data(client,
195 ETP_SMBUS_UNIQUEID_CMD, val);
197 dev_err(&client->dev, "failed to get product ID: %d\n", error);
201 *id = be16_to_cpup((__be16 *)val);
205 static int elan_smbus_get_checksum(struct i2c_client *client,
209 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
211 error = i2c_smbus_read_block_data(client,
212 iap ? ETP_SMBUS_FW_CHECKSUM_CMD :
213 ETP_SMBUS_IAP_CHECKSUM_CMD,
216 dev_err(&client->dev, "failed to get %s checksum: %d\n",
217 iap ? "IAP" : "FW", error);
221 *csum = be16_to_cpup((__be16 *)val);
225 static int elan_smbus_get_max(struct i2c_client *client,
226 unsigned int *max_x, unsigned int *max_y)
230 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
232 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RANGE_CMD, val);
234 error = ret < 0 ? ret : -EIO;
235 dev_err(&client->dev, "failed to get dimensions: %d\n", error);
239 *max_x = (0x0f & val[0]) << 8 | val[1];
240 *max_y = (0xf0 & val[0]) << 4 | val[2];
245 static int elan_smbus_get_resolution(struct i2c_client *client,
246 u8 *hw_res_x, u8 *hw_res_y)
250 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
252 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RESOLUTION_CMD, val);
254 error = ret < 0 ? ret : -EIO;
255 dev_err(&client->dev, "failed to get resolution: %d\n", error);
259 *hw_res_x = val[1] & 0x0F;
260 *hw_res_y = (val[1] & 0xF0) >> 4;
265 static int elan_smbus_get_num_traces(struct i2c_client *client,
266 unsigned int *x_traces,
267 unsigned int *y_traces)
271 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
273 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_XY_TRACENUM_CMD, val);
275 error = ret < 0 ? ret : -EIO;
276 dev_err(&client->dev, "failed to get trace info: %d\n", error);
286 static int elan_smbus_get_pressure_adjustment(struct i2c_client *client,
289 *adjustment = ETP_PRESSURE_OFFSET;
293 static int elan_smbus_iap_get_mode(struct i2c_client *client,
298 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
300 error = i2c_smbus_read_block_data(client, ETP_SMBUS_IAP_CTRL_CMD, val);
302 dev_err(&client->dev, "failed to read iap ctrol register: %d\n",
307 constant = be16_to_cpup((__be16 *)val);
308 dev_dbg(&client->dev, "iap control reg: 0x%04x.\n", constant);
310 *mode = (constant & ETP_SMBUS_IAP_MODE_ON) ? IAP_MODE : MAIN_MODE;
315 static int elan_smbus_iap_reset(struct i2c_client *client)
319 error = i2c_smbus_write_byte(client, ETP_SMBUS_IAP_RESET_CMD);
321 dev_err(&client->dev, "cannot reset IC: %d\n", error);
328 static int elan_smbus_set_flash_key(struct i2c_client *client)
331 u8 cmd[4] = { 0x00, 0x0B, 0x00, 0x5A };
333 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
336 dev_err(&client->dev, "cannot set flash key: %d\n", error);
343 static int elan_smbus_prepare_fw_update(struct i2c_client *client)
345 struct device *dev = &client->dev;
349 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
350 u8 cmd[4] = {0x0F, 0x78, 0x00, 0x06};
353 /* Get FW in which mode (IAP_MODE/MAIN_MODE) */
354 error = elan_smbus_iap_get_mode(client, &mode);
358 if (mode == MAIN_MODE) {
361 error = elan_smbus_set_flash_key(client);
365 /* write iap password */
366 if (i2c_smbus_write_byte(client,
367 ETP_SMBUS_IAP_PASSWORD_WRITE) < 0) {
368 dev_err(dev, "cannot write iap password\n");
372 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
375 dev_err(dev, "failed to write iap password: %d\n",
381 * Read back password to make sure we enabled flash
384 len = i2c_smbus_read_block_data(client,
385 ETP_SMBUS_IAP_PASSWORD_READ,
387 if (len < (int)sizeof(u16)) {
388 error = len < 0 ? len : -EIO;
389 dev_err(dev, "failed to read iap password: %d\n",
394 password = be16_to_cpup((__be16 *)val);
395 if (password != ETP_SMBUS_IAP_PASSWORD) {
396 dev_err(dev, "wrong iap password = 0x%X\n", password);
400 /* Wait 30ms for MAIN_MODE change to IAP_MODE */
404 error = elan_smbus_set_flash_key(client);
409 error = elan_smbus_iap_reset(client);
417 static int elan_smbus_write_fw_block(struct i2c_client *client,
418 const u8 *page, u16 checksum, int idx)
420 struct device *dev = &client->dev;
423 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
426 * Due to the limitation of smbus protocol limiting
427 * transfer to 32 bytes at a time, we must split block
430 error = i2c_smbus_write_block_data(client,
431 ETP_SMBUS_WRITE_FW_BLOCK,
432 ETP_FW_PAGE_SIZE / 2,
435 dev_err(dev, "Failed to write page %d (part %d): %d\n",
440 error = i2c_smbus_write_block_data(client,
441 ETP_SMBUS_WRITE_FW_BLOCK,
442 ETP_FW_PAGE_SIZE / 2,
443 page + ETP_FW_PAGE_SIZE / 2);
445 dev_err(dev, "Failed to write page %d (part %d): %d\n",
451 /* Wait for F/W to update one page ROM data. */
452 usleep_range(8000, 10000);
454 error = i2c_smbus_read_block_data(client,
455 ETP_SMBUS_IAP_CTRL_CMD, val);
457 dev_err(dev, "Failed to read IAP write result: %d\n",
462 result = be16_to_cpup((__be16 *)val);
463 if (result & (ETP_FW_IAP_PAGE_ERR | ETP_FW_IAP_INTF_ERR)) {
464 dev_err(dev, "IAP reports failed write: %04hx\n",
472 static int elan_smbus_get_report(struct i2c_client *client, u8 *report)
476 BUILD_BUG_ON(I2C_SMBUS_BLOCK_MAX > ETP_SMBUS_REPORT_LEN);
478 len = i2c_smbus_read_block_data(client,
479 ETP_SMBUS_PACKET_QUERY,
480 &report[ETP_SMBUS_REPORT_OFFSET]);
482 dev_err(&client->dev, "failed to read report data: %d\n", len);
486 if (len != ETP_SMBUS_REPORT_LEN) {
487 dev_err(&client->dev,
488 "wrong report length (%d vs %d expected)\n",
489 len, ETP_SMBUS_REPORT_LEN);
496 static int elan_smbus_finish_fw_update(struct i2c_client *client,
497 struct completion *fw_completion)
499 /* No special handling unlike I2C transport */
503 static int elan_smbus_get_pattern(struct i2c_client *client, u8 *pattern)
509 const struct elan_transport_ops elan_smbus_ops = {
510 .initialize = elan_smbus_initialize,
511 .sleep_control = elan_smbus_sleep_control,
512 .power_control = elan_smbus_power_control,
513 .set_mode = elan_smbus_set_mode,
515 .calibrate = elan_smbus_calibrate,
516 .calibrate_result = elan_smbus_calibrate_result,
518 .get_baseline_data = elan_smbus_get_baseline_data,
520 .get_version = elan_smbus_get_version,
521 .get_sm_version = elan_smbus_get_sm_version,
522 .get_product_id = elan_smbus_get_product_id,
523 .get_checksum = elan_smbus_get_checksum,
524 .get_pressure_adjustment = elan_smbus_get_pressure_adjustment,
526 .get_max = elan_smbus_get_max,
527 .get_resolution = elan_smbus_get_resolution,
528 .get_num_traces = elan_smbus_get_num_traces,
530 .iap_get_mode = elan_smbus_iap_get_mode,
531 .iap_reset = elan_smbus_iap_reset,
533 .prepare_fw_update = elan_smbus_prepare_fw_update,
534 .write_fw_block = elan_smbus_write_fw_block,
535 .finish_fw_update = elan_smbus_finish_fw_update,
537 .get_report = elan_smbus_get_report,
538 .get_pattern = elan_smbus_get_pattern,