2 * Elan I2C/SMBus Touchpad driver - SMBus interface
4 * Copyright (c) 2013 ELAN Microelectronics Corp.
6 * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw>
8 * Based on cyapa driver:
9 * copyright (c) 2011-2012 Cypress Semiconductor, Inc.
10 * copyright (c) 2011-2012 Google, Inc.
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License version 2 as published
14 * by the Free Software Foundation.
16 * Trademarks are the property of their respective owners.
19 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/init.h>
22 #include <linux/kernel.h>
26 /* Elan SMbus commands */
27 #define ETP_SMBUS_IAP_CMD 0x00
28 #define ETP_SMBUS_ENABLE_TP 0x20
29 #define ETP_SMBUS_SLEEP_CMD 0x21
30 #define ETP_SMBUS_IAP_PASSWORD_WRITE 0x29
31 #define ETP_SMBUS_IAP_PASSWORD_READ 0x80
32 #define ETP_SMBUS_WRITE_FW_BLOCK 0x2A
33 #define ETP_SMBUS_IAP_RESET_CMD 0x2B
34 #define ETP_SMBUS_RANGE_CMD 0xA0
35 #define ETP_SMBUS_FW_VERSION_CMD 0xA1
36 #define ETP_SMBUS_XY_TRACENUM_CMD 0xA2
37 #define ETP_SMBUS_SM_VERSION_CMD 0xA3
38 #define ETP_SMBUS_UNIQUEID_CMD 0xA3
39 #define ETP_SMBUS_RESOLUTION_CMD 0xA4
40 #define ETP_SMBUS_HELLOPACKET_CMD 0xA7
41 #define ETP_SMBUS_PACKET_QUERY 0xA8
42 #define ETP_SMBUS_IAP_VERSION_CMD 0xAC
43 #define ETP_SMBUS_IAP_CTRL_CMD 0xAD
44 #define ETP_SMBUS_IAP_CHECKSUM_CMD 0xAE
45 #define ETP_SMBUS_FW_CHECKSUM_CMD 0xAF
46 #define ETP_SMBUS_MAX_BASELINE_CMD 0xC3
47 #define ETP_SMBUS_MIN_BASELINE_CMD 0xC4
48 #define ETP_SMBUS_CALIBRATE_QUERY 0xC5
50 #define ETP_SMBUS_REPORT_LEN 32
51 #define ETP_SMBUS_REPORT_OFFSET 2
52 #define ETP_SMBUS_HELLOPACKET_LEN 5
53 #define ETP_SMBUS_IAP_PASSWORD 0x1234
54 #define ETP_SMBUS_IAP_MODE_ON (1 << 6)
56 static int elan_smbus_initialize(struct i2c_client *client)
58 u8 check[ETP_SMBUS_HELLOPACKET_LEN] = { 0x55, 0x55, 0x55, 0x55, 0x55 };
59 u8 values[I2C_SMBUS_BLOCK_MAX] = {0};
62 /* Get hello packet */
63 len = i2c_smbus_read_block_data(client,
64 ETP_SMBUS_HELLOPACKET_CMD, values);
65 if (len != ETP_SMBUS_HELLOPACKET_LEN) {
66 dev_err(&client->dev, "hello packet length fail: %d\n", len);
67 error = len < 0 ? len : -EIO;
71 /* compare hello packet */
72 if (memcmp(values, check, ETP_SMBUS_HELLOPACKET_LEN)) {
73 dev_err(&client->dev, "hello packet fail [%*ph]\n",
74 ETP_SMBUS_HELLOPACKET_LEN, values);
79 error = i2c_smbus_write_byte(client, ETP_SMBUS_ENABLE_TP);
81 dev_err(&client->dev, "failed to enable touchpad: %d\n", error);
88 static int elan_smbus_set_mode(struct i2c_client *client, u8 mode)
90 u8 cmd[4] = { 0x00, 0x07, 0x00, mode };
92 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
96 static int elan_smbus_sleep_control(struct i2c_client *client, bool sleep)
99 return i2c_smbus_write_byte(client, ETP_SMBUS_SLEEP_CMD);
101 return 0; /* XXX should we send ETP_SMBUS_ENABLE_TP here? */
104 static int elan_smbus_power_control(struct i2c_client *client, bool enable)
106 return 0; /* A no-op */
109 static int elan_smbus_calibrate(struct i2c_client *client)
111 u8 cmd[4] = { 0x00, 0x08, 0x00, 0x01 };
113 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
117 static int elan_smbus_calibrate_result(struct i2c_client *client, u8 *val)
120 u8 buf[I2C_SMBUS_BLOCK_MAX] = {0};
122 BUILD_BUG_ON(ETP_CALIBRATE_MAX_LEN > sizeof(buf));
124 error = i2c_smbus_read_block_data(client,
125 ETP_SMBUS_CALIBRATE_QUERY, buf);
129 memcpy(val, buf, ETP_CALIBRATE_MAX_LEN);
133 static int elan_smbus_get_baseline_data(struct i2c_client *client,
134 bool max_baseline, u8 *value)
137 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
139 error = i2c_smbus_read_block_data(client,
141 ETP_SMBUS_MAX_BASELINE_CMD :
142 ETP_SMBUS_MIN_BASELINE_CMD,
147 *value = be16_to_cpup((__be16 *)val);
152 static int elan_smbus_get_version(struct i2c_client *client,
153 bool iap, u8 *version)
156 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
158 error = i2c_smbus_read_block_data(client,
159 iap ? ETP_SMBUS_IAP_VERSION_CMD :
160 ETP_SMBUS_FW_VERSION_CMD,
163 dev_err(&client->dev, "failed to get %s version: %d\n",
164 iap ? "IAP" : "FW", error);
172 static int elan_smbus_get_sm_version(struct i2c_client *client,
173 u8 *ic_type, u8 *version)
176 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
178 error = i2c_smbus_read_block_data(client,
179 ETP_SMBUS_SM_VERSION_CMD, val);
181 dev_err(&client->dev, "failed to get SM version: %d\n", error);
190 static int elan_smbus_get_product_id(struct i2c_client *client, u16 *id)
193 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
195 error = i2c_smbus_read_block_data(client,
196 ETP_SMBUS_UNIQUEID_CMD, val);
198 dev_err(&client->dev, "failed to get product ID: %d\n", error);
202 *id = be16_to_cpup((__be16 *)val);
206 static int elan_smbus_get_checksum(struct i2c_client *client,
210 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
212 error = i2c_smbus_read_block_data(client,
213 iap ? ETP_SMBUS_FW_CHECKSUM_CMD :
214 ETP_SMBUS_IAP_CHECKSUM_CMD,
217 dev_err(&client->dev, "failed to get %s checksum: %d\n",
218 iap ? "IAP" : "FW", error);
222 *csum = be16_to_cpup((__be16 *)val);
226 static int elan_smbus_get_max(struct i2c_client *client,
227 unsigned int *max_x, unsigned int *max_y)
231 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
233 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RANGE_CMD, val);
235 error = ret < 0 ? ret : -EIO;
236 dev_err(&client->dev, "failed to get dimensions: %d\n", error);
240 *max_x = (0x0f & val[0]) << 8 | val[1];
241 *max_y = (0xf0 & val[0]) << 4 | val[2];
246 static int elan_smbus_get_resolution(struct i2c_client *client,
247 u8 *hw_res_x, u8 *hw_res_y)
251 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
253 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RESOLUTION_CMD, val);
255 error = ret < 0 ? ret : -EIO;
256 dev_err(&client->dev, "failed to get resolution: %d\n", error);
260 *hw_res_x = val[1] & 0x0F;
261 *hw_res_y = (val[1] & 0xF0) >> 4;
266 static int elan_smbus_get_num_traces(struct i2c_client *client,
267 unsigned int *x_traces,
268 unsigned int *y_traces)
272 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
274 ret = i2c_smbus_read_block_data(client, ETP_SMBUS_XY_TRACENUM_CMD, val);
276 error = ret < 0 ? ret : -EIO;
277 dev_err(&client->dev, "failed to get trace info: %d\n", error);
287 static int elan_smbus_get_pressure_adjustment(struct i2c_client *client,
290 *adjustment = ETP_PRESSURE_OFFSET;
294 static int elan_smbus_iap_get_mode(struct i2c_client *client,
299 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
301 error = i2c_smbus_read_block_data(client, ETP_SMBUS_IAP_CTRL_CMD, val);
303 dev_err(&client->dev, "failed to read iap ctrol register: %d\n",
308 constant = be16_to_cpup((__be16 *)val);
309 dev_dbg(&client->dev, "iap control reg: 0x%04x.\n", constant);
311 *mode = (constant & ETP_SMBUS_IAP_MODE_ON) ? IAP_MODE : MAIN_MODE;
316 static int elan_smbus_iap_reset(struct i2c_client *client)
320 error = i2c_smbus_write_byte(client, ETP_SMBUS_IAP_RESET_CMD);
322 dev_err(&client->dev, "cannot reset IC: %d\n", error);
329 static int elan_smbus_set_flash_key(struct i2c_client *client)
332 u8 cmd[4] = { 0x00, 0x0B, 0x00, 0x5A };
334 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
337 dev_err(&client->dev, "cannot set flash key: %d\n", error);
344 static int elan_smbus_prepare_fw_update(struct i2c_client *client)
346 struct device *dev = &client->dev;
350 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
351 u8 cmd[4] = {0x0F, 0x78, 0x00, 0x06};
354 /* Get FW in which mode (IAP_MODE/MAIN_MODE) */
355 error = elan_smbus_iap_get_mode(client, &mode);
359 if (mode == MAIN_MODE) {
362 error = elan_smbus_set_flash_key(client);
366 /* write iap password */
367 if (i2c_smbus_write_byte(client,
368 ETP_SMBUS_IAP_PASSWORD_WRITE) < 0) {
369 dev_err(dev, "cannot write iap password\n");
373 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
376 dev_err(dev, "failed to write iap password: %d\n",
382 * Read back password to make sure we enabled flash
385 len = i2c_smbus_read_block_data(client,
386 ETP_SMBUS_IAP_PASSWORD_READ,
388 if (len < sizeof(u16)) {
389 error = len < 0 ? len : -EIO;
390 dev_err(dev, "failed to read iap password: %d\n",
395 password = be16_to_cpup((__be16 *)val);
396 if (password != ETP_SMBUS_IAP_PASSWORD) {
397 dev_err(dev, "wrong iap password = 0x%X\n", password);
401 /* Wait 30ms for MAIN_MODE change to IAP_MODE */
405 error = elan_smbus_set_flash_key(client);
410 error = elan_smbus_iap_reset(client);
418 static int elan_smbus_write_fw_block(struct i2c_client *client,
419 const u8 *page, u16 checksum, int idx)
421 struct device *dev = &client->dev;
424 u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
427 * Due to the limitation of smbus protocol limiting
428 * transfer to 32 bytes at a time, we must split block
431 error = i2c_smbus_write_block_data(client,
432 ETP_SMBUS_WRITE_FW_BLOCK,
433 ETP_FW_PAGE_SIZE / 2,
436 dev_err(dev, "Failed to write page %d (part %d): %d\n",
441 error = i2c_smbus_write_block_data(client,
442 ETP_SMBUS_WRITE_FW_BLOCK,
443 ETP_FW_PAGE_SIZE / 2,
444 page + ETP_FW_PAGE_SIZE / 2);
446 dev_err(dev, "Failed to write page %d (part %d): %d\n",
452 /* Wait for F/W to update one page ROM data. */
453 usleep_range(8000, 10000);
455 error = i2c_smbus_read_block_data(client,
456 ETP_SMBUS_IAP_CTRL_CMD, val);
458 dev_err(dev, "Failed to read IAP write result: %d\n",
463 result = be16_to_cpup((__be16 *)val);
464 if (result & (ETP_FW_IAP_PAGE_ERR | ETP_FW_IAP_INTF_ERR)) {
465 dev_err(dev, "IAP reports failed write: %04hx\n",
473 static int elan_smbus_get_report(struct i2c_client *client, u8 *report)
477 BUILD_BUG_ON(I2C_SMBUS_BLOCK_MAX > ETP_SMBUS_REPORT_LEN);
479 len = i2c_smbus_read_block_data(client,
480 ETP_SMBUS_PACKET_QUERY,
481 &report[ETP_SMBUS_REPORT_OFFSET]);
483 dev_err(&client->dev, "failed to read report data: %d\n", len);
487 if (len != ETP_SMBUS_REPORT_LEN) {
488 dev_err(&client->dev,
489 "wrong report length (%d vs %d expected)\n",
490 len, ETP_SMBUS_REPORT_LEN);
497 static int elan_smbus_finish_fw_update(struct i2c_client *client,
498 struct completion *fw_completion)
500 /* No special handling unlike I2C transport */
504 const struct elan_transport_ops elan_smbus_ops = {
505 .initialize = elan_smbus_initialize,
506 .sleep_control = elan_smbus_sleep_control,
507 .power_control = elan_smbus_power_control,
508 .set_mode = elan_smbus_set_mode,
510 .calibrate = elan_smbus_calibrate,
511 .calibrate_result = elan_smbus_calibrate_result,
513 .get_baseline_data = elan_smbus_get_baseline_data,
515 .get_version = elan_smbus_get_version,
516 .get_sm_version = elan_smbus_get_sm_version,
517 .get_product_id = elan_smbus_get_product_id,
518 .get_checksum = elan_smbus_get_checksum,
519 .get_pressure_adjustment = elan_smbus_get_pressure_adjustment,
521 .get_max = elan_smbus_get_max,
522 .get_resolution = elan_smbus_get_resolution,
523 .get_num_traces = elan_smbus_get_num_traces,
525 .iap_get_mode = elan_smbus_iap_get_mode,
526 .iap_reset = elan_smbus_iap_reset,
528 .prepare_fw_update = elan_smbus_prepare_fw_update,
529 .write_fw_block = elan_smbus_write_fw_block,
530 .finish_fw_update = elan_smbus_finish_fw_update,
532 .get_report = elan_smbus_get_report,