2 * Elan I2C/SMBus Touchpad driver - SMBus interface
4 * Copyright (c) 2013 ELAN Microelectronics Corp.
6 * 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 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License version 2 as published
15 * by the Free Software Foundation.
17 * Trademarks are the property of their respective owners.
20 #include <linux/delay.h>
21 #include <linux/i2c.h>
22 #include <linux/init.h>
23 #include <linux/kernel.h>
27 /* Elan SMbus commands */
28 #define ETP_SMBUS_IAP_CMD 0x00
29 #define ETP_SMBUS_ENABLE_TP 0x20
30 #define ETP_SMBUS_SLEEP_CMD 0x21
31 #define ETP_SMBUS_IAP_PASSWORD_WRITE 0x29
32 #define ETP_SMBUS_IAP_PASSWORD_READ 0x80
33 #define ETP_SMBUS_WRITE_FW_BLOCK 0x2A
34 #define ETP_SMBUS_IAP_RESET_CMD 0x2B
35 #define ETP_SMBUS_RANGE_CMD 0xA0
36 #define ETP_SMBUS_FW_VERSION_CMD 0xA1
37 #define ETP_SMBUS_XY_TRACENUM_CMD 0xA2
38 #define ETP_SMBUS_SM_VERSION_CMD 0xA3
39 #define ETP_SMBUS_UNIQUEID_CMD 0xA3
40 #define ETP_SMBUS_RESOLUTION_CMD 0xA4
41 #define ETP_SMBUS_HELLOPACKET_CMD 0xA7
42 #define ETP_SMBUS_PACKET_QUERY 0xA8
43 #define ETP_SMBUS_IAP_VERSION_CMD 0xAC
44 #define ETP_SMBUS_IAP_CTRL_CMD 0xAD
45 #define ETP_SMBUS_IAP_CHECKSUM_CMD 0xAE
46 #define ETP_SMBUS_FW_CHECKSUM_CMD 0xAF
47 #define ETP_SMBUS_MAX_BASELINE_CMD 0xC3
48 #define ETP_SMBUS_MIN_BASELINE_CMD 0xC4
49 #define ETP_SMBUS_CALIBRATE_QUERY 0xC5
51 #define ETP_SMBUS_REPORT_LEN 32
52 #define ETP_SMBUS_REPORT_OFFSET 2
53 #define ETP_SMBUS_HELLOPACKET_LEN 5
54 #define ETP_SMBUS_IAP_PASSWORD 0x1234
55 #define ETP_SMBUS_IAP_MODE_ON (1 << 6)
57 static int elan_smbus_initialize(struct i2c_client *client)
59 u8 check[ETP_SMBUS_HELLOPACKET_LEN] = { 0x55, 0x55, 0x55, 0x55, 0x55 };
60 u8 values[ETP_SMBUS_HELLOPACKET_LEN] = { 0, 0, 0, 0, 0 };
63 /* Get hello packet */
64 len = i2c_smbus_read_block_data(client,
65 ETP_SMBUS_HELLOPACKET_CMD, values);
66 if (len != ETP_SMBUS_HELLOPACKET_LEN) {
67 dev_err(&client->dev, "hello packet length fail: %d\n", len);
68 error = len < 0 ? len : -EIO;
72 /* compare hello packet */
73 if (memcmp(values, check, ETP_SMBUS_HELLOPACKET_LEN)) {
74 dev_err(&client->dev, "hello packet fail [%*px]\n",
75 ETP_SMBUS_HELLOPACKET_LEN, values);
80 error = i2c_smbus_write_byte(client, ETP_SMBUS_ENABLE_TP);
82 dev_err(&client->dev, "failed to enable touchpad: %d\n", error);
89 static int elan_smbus_set_mode(struct i2c_client *client, u8 mode)
91 u8 cmd[4] = { 0x00, 0x07, 0x00, mode };
93 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
97 static int elan_smbus_sleep_control(struct i2c_client *client, bool sleep)
100 return i2c_smbus_write_byte(client, ETP_SMBUS_SLEEP_CMD);
102 return 0; /* XXX should we send ETP_SMBUS_ENABLE_TP here? */
105 static int elan_smbus_power_control(struct i2c_client *client, bool enable)
107 return 0; /* A no-op */
110 static int elan_smbus_calibrate(struct i2c_client *client)
112 u8 cmd[4] = { 0x00, 0x08, 0x00, 0x01 };
114 return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
118 static int elan_smbus_calibrate_result(struct i2c_client *client, u8 *val)
122 error = i2c_smbus_read_block_data(client,
123 ETP_SMBUS_CALIBRATE_QUERY, val);
130 static int elan_smbus_get_baseline_data(struct i2c_client *client,
131 bool max_baseline, u8 *value)
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)
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, u8 *version)
174 error = i2c_smbus_read_block_data(client,
175 ETP_SMBUS_SM_VERSION_CMD, val);
177 dev_err(&client->dev, "failed to get SM version: %d\n", error);
181 *version = val[0]; /* XXX Why 0 and not 2 as in IAP/FW versions? */
185 static int elan_smbus_get_product_id(struct i2c_client *client, u8 *id)
190 error = i2c_smbus_read_block_data(client,
191 ETP_SMBUS_UNIQUEID_CMD, val);
193 dev_err(&client->dev, "failed to get product ID: %d\n", error);
201 static int elan_smbus_get_checksum(struct i2c_client *client,
207 error = i2c_smbus_read_block_data(client,
208 iap ? ETP_SMBUS_FW_CHECKSUM_CMD :
209 ETP_SMBUS_IAP_CHECKSUM_CMD,
212 dev_err(&client->dev, "failed to get %s checksum: %d\n",
213 iap ? "IAP" : "FW", error);
217 *csum = be16_to_cpup((__be16 *)val);
221 static int elan_smbus_get_max(struct i2c_client *client,
222 unsigned int *max_x, unsigned int *max_y)
227 error = i2c_smbus_read_block_data(client, ETP_SMBUS_RANGE_CMD, val);
229 dev_err(&client->dev, "failed to get dimensions: %d\n", error);
233 *max_x = (0x0f & val[0]) << 8 | val[1];
234 *max_y = (0xf0 & val[0]) << 4 | val[2];
239 static int elan_smbus_get_resolution(struct i2c_client *client,
240 u8 *hw_res_x, u8 *hw_res_y)
245 error = i2c_smbus_read_block_data(client,
246 ETP_SMBUS_RESOLUTION_CMD, val);
248 dev_err(&client->dev, "failed to get resolution: %d\n", error);
252 *hw_res_x = val[1] & 0x0F;
253 *hw_res_y = (val[1] & 0xF0) >> 4;
258 static int elan_smbus_get_num_traces(struct i2c_client *client,
259 unsigned int *x_traces,
260 unsigned int *y_traces)
265 error = i2c_smbus_read_block_data(client,
266 ETP_SMBUS_XY_TRACENUM_CMD, val);
268 dev_err(&client->dev, "failed to get trace info: %d\n", error);
272 *x_traces = val[1] - 1;
273 *y_traces = val[2] - 1;
278 static int elan_smbus_iap_get_mode(struct i2c_client *client,
285 error = i2c_smbus_read_block_data(client, ETP_SMBUS_IAP_CTRL_CMD, val);
287 dev_err(&client->dev, "failed to read iap ctrol register: %d\n",
292 constant = be16_to_cpup((__be16 *)val);
293 dev_dbg(&client->dev, "iap control reg: 0x%04x.\n", constant);
295 *mode = (constant & ETP_SMBUS_IAP_MODE_ON) ? IAP_MODE : MAIN_MODE;
300 static int elan_smbus_iap_reset(struct i2c_client *client)
304 error = i2c_smbus_write_byte(client, ETP_SMBUS_IAP_RESET_CMD);
306 dev_err(&client->dev, "cannot reset IC: %d\n", error);
313 static int elan_smbus_set_flash_key(struct i2c_client *client)
316 u8 cmd[4] = { 0x00, 0x0B, 0x00, 0x5A };
318 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
321 dev_err(&client->dev, "cannot set flash key: %d\n", error);
328 static int elan_smbus_prepare_fw_update(struct i2c_client *client)
330 struct device *dev = &client->dev;
335 u8 cmd[4] = {0x0F, 0x78, 0x00, 0x06};
338 /* Get FW in which mode (IAP_MODE/MAIN_MODE) */
339 error = elan_smbus_iap_get_mode(client, &mode);
343 if (mode == MAIN_MODE) {
346 error = elan_smbus_set_flash_key(client);
350 /* write iap password */
351 if (i2c_smbus_write_byte(client,
352 ETP_SMBUS_IAP_PASSWORD_WRITE) < 0) {
353 dev_err(dev, "cannot write iap password\n");
357 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
360 dev_err(dev, "failed to write iap password: %d\n",
366 * Read back password to make sure we enabled flash
369 len = i2c_smbus_read_block_data(client,
370 ETP_SMBUS_IAP_PASSWORD_READ,
372 if (len < sizeof(u16)) {
373 error = len < 0 ? len : -EIO;
374 dev_err(dev, "failed to read iap password: %d\n",
379 password = be16_to_cpup((__be16 *)val);
380 if (password != ETP_SMBUS_IAP_PASSWORD) {
381 dev_err(dev, "wrong iap password = 0x%X\n", password);
385 /* Wait 30ms for MAIN_MODE change to IAP_MODE */
389 error = elan_smbus_set_flash_key(client);
394 error = elan_smbus_iap_reset(client);
402 static int elan_smbus_write_fw_block(struct i2c_client *client,
403 const u8 *page, u16 checksum, int idx)
405 struct device *dev = &client->dev;
411 * Due to the limitation of smbus protocol limiting
412 * transfer to 32 bytes at a time, we must split block
415 error = i2c_smbus_write_block_data(client,
416 ETP_SMBUS_WRITE_FW_BLOCK,
417 ETP_FW_PAGE_SIZE / 2,
420 dev_err(dev, "Failed to write page %d (part %d): %d\n",
425 error = i2c_smbus_write_block_data(client,
426 ETP_SMBUS_WRITE_FW_BLOCK,
427 ETP_FW_PAGE_SIZE / 2,
428 page + ETP_FW_PAGE_SIZE / 2);
430 dev_err(dev, "Failed to write page %d (part %d): %d\n",
436 /* Wait for F/W to update one page ROM data. */
437 usleep_range(8000, 10000);
439 error = i2c_smbus_read_block_data(client,
440 ETP_SMBUS_IAP_CTRL_CMD, val);
442 dev_err(dev, "Failed to read IAP write result: %d\n",
447 result = be16_to_cpup((__be16 *)val);
448 if (result & (ETP_FW_IAP_PAGE_ERR | ETP_FW_IAP_INTF_ERR)) {
449 dev_err(dev, "IAP reports failed write: %04hx\n",
457 static int elan_smbus_get_report(struct i2c_client *client, u8 *report)
461 len = i2c_smbus_read_block_data(client,
462 ETP_SMBUS_PACKET_QUERY,
463 &report[ETP_SMBUS_REPORT_OFFSET]);
465 dev_err(&client->dev, "failed to read report data: %d\n", len);
469 if (len != ETP_SMBUS_REPORT_LEN) {
470 dev_err(&client->dev,
471 "wrong report length (%d vs %d expected)\n",
472 len, ETP_SMBUS_REPORT_LEN);
479 static int elan_smbus_finish_fw_update(struct i2c_client *client,
480 struct completion *fw_completion)
482 /* No special handling unlike I2C transport */
486 const struct elan_transport_ops elan_smbus_ops = {
487 .initialize = elan_smbus_initialize,
488 .sleep_control = elan_smbus_sleep_control,
489 .power_control = elan_smbus_power_control,
490 .set_mode = elan_smbus_set_mode,
492 .calibrate = elan_smbus_calibrate,
493 .calibrate_result = elan_smbus_calibrate_result,
495 .get_baseline_data = elan_smbus_get_baseline_data,
497 .get_version = elan_smbus_get_version,
498 .get_sm_version = elan_smbus_get_sm_version,
499 .get_product_id = elan_smbus_get_product_id,
500 .get_checksum = elan_smbus_get_checksum,
502 .get_max = elan_smbus_get_max,
503 .get_resolution = elan_smbus_get_resolution,
504 .get_num_traces = elan_smbus_get_num_traces,
506 .iap_get_mode = elan_smbus_iap_get_mode,
507 .iap_reset = elan_smbus_iap_reset,
509 .prepare_fw_update = elan_smbus_prepare_fw_update,
510 .write_fw_block = elan_smbus_write_fw_block,
511 .finish_fw_update = elan_smbus_finish_fw_update,
513 .get_report = elan_smbus_get_report,