@@ -1,5 +1,5 @@
/*
- * Elan Microelectronics touch panels with I2C interface
+ * Elan Microelectronics touchpanels with I2C interface
*
* Copyright (C) 2014 Elan Microelectronics Corporation.
* Scott Liu <scott.liu@emc.com.tw>
@@ -16,12 +16,14 @@
* Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
* Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France
* Copyright (c) 2012 Red Hat, Inc
+ *
*/
/*
* This software is licensed under the terms of the GNU General Public
* License version 2, as published by the Free Software Foundation, and
* may be copied, distributed, and modified under those terms.
+ *
*/
#include <linux/module.h>
@@ -33,195 +35,316 @@
#include <linux/delay.h>
#include <linux/uaccess.h>
#include <linux/buffer_head.h>
+#include <linux/version.h>
#include <linux/slab.h>
#include <linux/firmware.h>
+#include <linux/version.h>
#include <linux/input/mt.h>
#include <linux/acpi.h>
#include <linux/of.h>
#include <asm/unaligned.h>
+/* debug option */
+static bool debug = false;
+module_param(debug, bool, 0444);
+MODULE_PARM_DESC(debug, "print a lot of debug information");
+
+#define elan_dbg(client, fmt, arg...) \
+ do { \
+ if (debug) \
+ dev_printk(KERN_DEBUG, &client->dev, fmt, ##arg); \
+ } while (0)
+
+#define ENTER_LOG() \
+ dev_dbg(&client->dev, "Enter: %s\n", __func__)
+
+
/* Device, Driver information */
#define DEVICE_NAME "elants_i2c"
-#define DRV_VERSION "1.0.9"
+#define DRV_VERSION "1.0.8"
+
+/* Finger report description */
+#define MAX_CONTACT_NUM 10
+
+/* Buffer size, used for Read command handshake */
+#define FIFO_SIZE 64
+#define MAX_MESSAGE_SIZE 256
-/* Convert from rows or columns into resolution */
-#define ELAN_TS_RESOLUTION(n, m) (((n) - 1) * (m))
-/* FW header data */
-#define HEADER_SIZE 4
-#define FW_HDR_TYPE 0
-#define FW_HDR_COUNT 1
-#define FW_HDR_LENGTH 2
+/*Convert from rows or columns into resolution */
+#define ELAN_TS_RESOLUTION(n, m) ((n - 1) * m)
+
+/* Firmware boot mode packets definition */
+#define HELLO_PACKET_LEN 4
+#define RECOV_PACKET_LEN 4
+static const char hello_packet[HELLO_PACKET_LEN] = {0x55, 0x55, 0x55, 0x55};
+static const char recov_packet[RECOV_PACKET_LEN] = {0x55, 0x55, 0x80, 0x80};
+
+/* Finger report information */
+#define REPORT_HEADER_10_FINGER 0x62
+#define PACKET_SIZE 55
+#define MAX_PACKET_LEN 169
/* Buffer mode Queue Header information */
-#define QUEUE_HEADER_SINGLE 0x62
-#define QUEUE_HEADER_NORMAL 0X63
-#define QUEUE_HEADER_WAIT 0x64
+#define QUEUE_HEADER_SINGLE 0x62
+#define QUEUE_HEADER_NORMAL 0X63
+#define QUEUE_HEADER_WAIT 0x64
+#define QUEUE_HEADER_SIZE 4
/* Command header definition */
-#define CMD_HEADER_WRITE 0x54
-#define CMD_HEADER_READ 0x53
-#define CMD_HEADER_6B_READ 0x5B
-#define CMD_HEADER_RESP 0x52
-#define CMD_HEADER_6B_RESP 0x9B
-#define CMD_HEADER_HELLO 0x55
-#define CMD_HEADER_REK 0x66
-
-/* FW position data */
-#define PACKET_SIZE 55
-#define MAX_CONTACT_NUM 10
-#define FW_POS_HEADER 0
-#define FW_POS_STATE 1
-#define FW_POS_TOTAL 2
-#define FW_POS_XY 3
-#define FW_POS_CHECKSUM 34
-#define FW_POS_WIDTH 35
-#define FW_POS_PRESSURE 45
-
-#define HEADER_REPORT_10_FINGER 0x62
-
-/* Header (4 bytes) plus 3 fill 10-finger packets */
-#define MAX_PACKET_SIZE 169
-
-#define BOOT_TIME_DELAY_MS 50
+#define CMD_HEADER_WRITE 0x54
+#define CMD_HEADER_READ 0x53
+#define CMD_HEADER_5B_READ 0x5B
+#define CMD_HEADER_RESP 0x52
+#define CMD_HEADER_5B_RESP 0x9B
+#define CMD_HEADER_HELLO 0x55
+#define CMD_HEADER_REK 0x66
+#define CMD_MAX_RESP_LEN 17
+
+/* FW information position */
+#define FW_POS_HEADER 0
+#define FW_POS_STATE 1
+#define FW_POS_TOTAL 2
+#define FW_POS_CHECKSUM 34
+#define FW_POS_WIDTH 35
+#define FW_POS_PRESSURE 45
+
+/* test_bit definition */
+#define LOCK_FILE_OPERATE 0
+#define LOCK_CMD_HANDSHAKE 1
+#define LOCK_FW_UPDATE 3
+
+#define RET_OK 0
+#define RET_CMDRSP 1
+#define RET_FAIL -1
+
+/* define boot condition definition */
+#define E_BOOT_NORM 0
+#define E_BOOT_IAP 1
+
+/* Firmware */
+#define IAP_MODE_ENABLE 1
+#define BOOT_TIME_DELAY_MS 50
/* FW read command, 0x53 0x?? 0x0, 0x01 */
-#define E_ELAN_INFO_FW_VER 0x00
-#define E_ELAN_INFO_BC_VER 0x10
-#define E_ELAN_INFO_TEST_VER 0xE0
-#define E_ELAN_INFO_FW_ID 0xF0
-#define E_INFO_OSR 0xD6
-#define E_INFO_PHY_SCAN 0xD7
-#define E_INFO_PHY_DRIVER 0xD8
+#define E_ELAN_INFO_FW_VER 0x00
+#define E_ELAN_INFO_BC_VER 0x10
+#define E_ELAN_INFO_TEST_VER 0xE0
+#define E_ELAN_INFO_FW_ID 0xF0
+#define E_INFO_OSR 0xD6
+#define E_INFO_PHY_SCAN 0xD7
+#define E_INFO_PHY_DRIVER 0xD8
+
+#define MAX_RETRIES 3
+#define MAX_FW_UPDATE_RETRIES 30
+
+#define ELAN_FW_PAGENUM 351
+#define ELAN_FW_PAGESIZE 132
+#define ELAN_FW_BASE_FILENAME "elants_i2c"
+#define ELAN_FW_EXTENSION "bin"
+#define ELAN_FW_FILENAME_MAX_LEN (ARRAY_SIZE(ELAN_FW_BASE_FILENAME) + \
+ ARRAY_SIZE(ELAN_FW_EXTENSION) + 5)
-#define MAX_RETRIES 3
-#define MAX_FW_UPDATE_RETRIES 30
+/* calibration timeout definition */
+#define ELAN_CALI_TIMEOUT_MSEC 10000
-#define ELAN_FW_PAGESIZE 132
+/* command response timeout definition */
+#define ELAN_CMD_RESP_TIMEOUT_MSEC 500
-/* calibration timeout definition */
-#define ELAN_CALI_TIMEOUT_MSEC 10000
+/* hello packet timeout definition */
+#define ELAN_HELLO_TIMEOUT_MSEC 2000
+
+/*
+ * struct multi_queue_header - used by buffer queue header
+ *
+ * packet_id: packet_id represented status of buffer.
+ * report_count: number of finger report in buffer.
+ * report_length: total length exclusive queue length.
+ */
+struct multi_queue_header {
+ u8 packet_id;
+ u8 report_count;
+ u8 report_length;
+ u8 reserved;
+};
-enum elants_state {
- ELAN_STATE_NORMAL,
- ELAN_WAIT_QUEUE_HEADER,
- ELAN_WAIT_RECALIBRATION,
+struct mt_slot {
+ __s32 x, y, p, w, h;
+ __s32 contactid; /* the device ContactID assigned to this slot */
+ bool touch_state; /* is the touch valid? */
+ bool seen_in_this_frame; /* has this slot been updated */
};
-enum elants_iap_mode {
- ELAN_IAP_OPERATIONAL,
- ELAN_IAP_RECOVERY,
+struct mt_device {
+ struct mt_slot curdata; /* placeholder of incoming data */
+ __u8 num_received; /* how many contacts we received */
+ bool curvalid; /* is the current contact valid? */
+ struct mt_slot slots[MAX_CONTACT_NUM];
};
-/* struct elants_data - represents state of Elan touchscreen device */
+
+/* struct elants_data - represents a global define of elants device */
struct elants_data {
- struct i2c_client *client;
- struct input_dev *input;
+ bool wake_irq_enabled;
+ u16 hw_version;
u16 fw_version;
u8 test_version;
u8 solution_version;
u8 bc_version;
u8 iap_version;
- u16 hw_version;
- unsigned int x_res; /* resolution in units/mm */
- unsigned int y_res;
- unsigned int x_max;
- unsigned int y_max;
- enum elants_state state;
- enum elants_iap_mode iap_mode;
+ int osr; /* interpolating trace */
+ int x_res; /* resolution in units/mm */
+ int y_res;
+ int rows; /* trace numbers */
+ int cols;
+ int x_max; /* Max ABS resolution */
+ int y_max;
+ unsigned int iap_mode;
+ unsigned int rx_size;
+
+ u8 packet_size;
- /* Guards against concurrent access to the device via sysfs */
+ struct multi_queue_header mq_header;
+
+ struct i2c_client *client;
+ struct input_dev *input;
+
+ struct mutex i2c_mutex; /* Protects I2C accesses to device */
+
+ /* Guards against concurrent access to the device via sysfs/debugfs */
struct mutex sysfs_mutex;
- u8 cmd_resp[HEADER_SIZE];
- struct completion cmd_done;
+ unsigned long flags;
- u8 buf[MAX_PACKET_SIZE];
+ char cmd_resp[CMD_MAX_RESP_LEN];
+ struct completion cmd_done;
- bool wake_irq_enabled;
+ struct mt_device td;
+
+ /* Add for TS driver debug */
+ long int irq_count;
+ long int packet_count;
+ long int touched_sync;
+ long int no_touched_sync;
+ long int wdt_reset;
+ u16 checksum_fail;
+ u16 header_fail;
+ u16 mq_header_fail;
};
-static int elants_i2c_send(struct i2c_client *client,
- const void *data, size_t size)
-{
- int ret;
+static int elan_initialize(struct i2c_client *client);
+static int elan_fw_update(struct elants_data *ts);
- ret = i2c_master_send(client, data, size);
- if (ret == size)
- return 0;
+/*
+ * Function implement
+ */
+#define elan_set_data(client, data, len) \
+ elan_async_rw(client, data, len, NULL, 0)
- if (ret >= 0)
- ret = -EIO;
+#define elan_get_data(client, data, len) \
+ elan_async_rw(client, NULL, 0, data, len)
- dev_err(&client->dev, "%s failed (%*ph): %d\n",
- __func__, (int)size, data, ret);
- return ret;
+static inline void elan_msleep(u32 t)
+{
+ /*
+ * If the sleeping time is 10us - 20ms, usleep_range() is recommended.
+ * Read Documentation/timers/timers-howto.txt
+ */
+ usleep_range(t * 1000, t * 1000 + 500);
}
-static int elants_i2c_read(struct i2c_client *client, void *data, size_t size)
+/*
+ * Set command or data to our TS.
+ *
+ * client: the i2c device to recieve from
+ * command: command or data which will send to TS
+ * cmd_len: The length of the command to send
+ * buffer: buffer to store the received data in
+ * buf_len: The expected length of the received data.
+ */
+static int elan_async_rw(struct i2c_client *client,
+ const u8 *command,
+ const __u16 cmd_len,
+ u8 *buffer,
+ const __u16 buf_len)
{
- int ret;
-
- ret = i2c_master_recv(client, data, size);
- if (ret == size)
- return 0;
+ struct i2c_adapter *adap = client->adapter;
+ struct i2c_msg msgs[2];
+ int num_of_msgs = 0;
+ int msg_id = 0;
+ int rc = 0;
- if (ret >= 0)
- ret = -EIO;
+ ENTER_LOG();
- dev_err(&client->dev, "%s failed: %d\n", __func__, ret);
+ if (cmd_len) {
+ elan_dbg(client,
+ "%s cmd: %*phC, addr=%x\n",
+ __func__, (int)cmd_len, command, client->addr);
- return ret;
-}
+ msgs[msg_id].addr = client->addr;
+ msgs[msg_id].flags = client->flags & I2C_M_TEN;
+ msgs[msg_id].len = cmd_len;
+ msgs[msg_id].buf = (u8 *)command;
-static int elants_i2c_execute_command(struct i2c_client *client,
- const u8 *cmd, size_t cmd_size,
- u8 *resp, size_t resp_size)
-{
- struct i2c_msg msgs[2];
- int ret;
- u8 expected_response;
+ num_of_msgs++;
+ msg_id++;
+ }
- switch (cmd[0]) {
- case CMD_HEADER_READ:
- expected_response = CMD_HEADER_RESP;
- break;
+ if (buf_len) {
+ msgs[msg_id].addr = client->addr;
+ msgs[msg_id].flags = client->flags & I2C_M_TEN;
+ msgs[msg_id].flags |= I2C_M_RD;
+ msgs[msg_id].len = buf_len;
+ msgs[msg_id].buf = buffer;
- case CMD_HEADER_6B_READ:
- expected_response = CMD_HEADER_6B_RESP;
- break;
+ num_of_msgs++;
+ }
- default:
- dev_err(&client->dev, "%s: invalid command %*ph\n",
- __func__, (int)cmd_size, cmd);
- return -EINVAL;
+ rc = i2c_transfer(adap, msgs, num_of_msgs);
+ if (rc < 0) {
+ elan_dbg(client, "ts_info error rc=%d\n", rc);
+ return rc;
}
- msgs[0].addr = client->addr;
- msgs[0].flags = client->flags & I2C_M_TEN;
- msgs[0].len = cmd_size;
- msgs[0].buf = (u8 *)cmd;
+ if (buf_len)
+ elan_dbg(client,
+ "%s buffer: %*phC, addr=%x\n",
+ __func__, (int)buf_len, buffer, client->addr);
- msgs[1].addr = client->addr;
- msgs[1].flags = client->flags & I2C_M_TEN;
- msgs[1].flags |= I2C_M_RD;
- msgs[1].len = resp_size;
- msgs[1].buf = resp;
+ return (rc < 0) ? -EIO : 0;
+}
- ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
- if (ret < 0)
- return ret;
+static int elan_i2c_read_block(struct i2c_client *client,
+ u8 *cmd, u16 cmd_len, u8 *val, u16 resp_len)
+{
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int ret, error;
- if (ret != ARRAY_SIZE(msgs) || resp[FW_HDR_TYPE] != expected_response)
- return -EIO;
+ ts->rx_size = resp_len;
+ disable_irq(client->irq);
+ INIT_COMPLETION(ts->cmd_done);
+ elan_set_data(client, cmd, cmd_len);
+ enable_irq(client->irq);
+ ret = wait_for_completion_interruptible_timeout(&ts->cmd_done,
+ msecs_to_jiffies(ELAN_CMD_RESP_TIMEOUT_MSEC));
+ if (ret <= 0) {
+ error = ret < 0 ? ret : -ETIMEDOUT;
+ dev_err(&client->dev,
+ "error while waiting for elan response to complete: %d\n",
+ error);
+ ts->rx_size = QUEUE_HEADER_SIZE;
+ return error;
+ }
+ memcpy(val, ts->cmd_resp, resp_len);
+ ts->rx_size = QUEUE_HEADER_SIZE;
- return 0;
+ return ret;
}
-static int elants_i2c_calibrate(struct elants_data *ts)
+static int elan_calibrate(struct elants_data *ts)
{
struct i2c_client *client = ts->client;
int ret, error;
@@ -229,21 +352,12 @@ static int elants_i2c_calibrate(struct elants_data *ts)
static const u8 rek[] = { 0x54, 0x29, 0x00, 0x01 };
static const u8 rek_resp[] = { CMD_HEADER_REK, 0x66, 0x66, 0x66 };
- disable_irq(client->irq);
-
- ts->state = ELAN_WAIT_RECALIBRATION;
- reinit_completion(&ts->cmd_done);
-
- elants_i2c_send(client, w_flashkey, sizeof(w_flashkey));
- elants_i2c_send(client, rek, sizeof(rek));
-
- enable_irq(client->irq);
+ elan_set_data(client, w_flashkey, sizeof(w_flashkey));
+ INIT_COMPLETION(ts->cmd_done); // XXX reinit_completion(&ts->cmd_done);
+ elan_set_data(client, rek, sizeof(rek));
ret = wait_for_completion_interruptible_timeout(&ts->cmd_done,
msecs_to_jiffies(ELAN_CALI_TIMEOUT_MSEC));
-
- ts->state = ELAN_STATE_NORMAL;
-
if (ret <= 0) {
error = ret < 0 ? ret : -ETIMEDOUT;
dev_err(&client->dev,
@@ -252,851 +366,1198 @@ static int elants_i2c_calibrate(struct elants_data *ts)
return error;
}
- if (memcmp(rek_resp, ts->cmd_resp, sizeof(rek_resp))) {
+ if (memcmp(rek_resp, ts->cmd_resp, 4)) {
dev_err(&client->dev,
"unexpected calibration response: %*ph\n",
- (int)sizeof(ts->cmd_resp), ts->cmd_resp);
+ 4, ts->cmd_resp);
return -EINVAL;
}
return 0;
}
-static int elants_i2c_sw_reset(struct i2c_client *client)
+/*
+ * sysfs interface
+ */
+static ssize_t calibrate_store(struct device *dev,
+ struct device_attribute *attr,
+ const char *buf, size_t count)
{
- const u8 soft_rst_cmd[] = { 0x77, 0x77, 0x77, 0x77 };
+ struct i2c_client *client = to_i2c_client(dev);
+ struct elants_data *ts = i2c_get_clientdata(client);
int error;
- error = elants_i2c_send(client, soft_rst_cmd,
- sizeof(soft_rst_cmd));
- if (error) {
- dev_err(&client->dev, "software reset failed: %d\n", error);
+ error = mutex_lock_interruptible(&ts->sysfs_mutex);
+ if (error)
return error;
- }
- /*
- * We should wait at least 10 msec (but no more than 40) before
- * sending fastboot or IAP command to the device.
- */
- msleep(30);
-
- return 0;
-}
+ error = elan_calibrate(ts);
-static u16 elants_i2c_parse_version(u8 *buf)
-{
- return get_unaligned_be32(buf) >> 4;
+ mutex_unlock(&ts->sysfs_mutex);
+ return error ?: count;
}
-static int elants_i2c_query_fw_id(struct elants_data *ts)
+static ssize_t write_update_fw(struct device *dev,
+ struct device_attribute *attr,
+ const char *buf, size_t count)
{
- struct i2c_client *client = ts->client;
- int error, retry_cnt;
- const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_ID, 0x00, 0x01 };
- u8 resp[HEADER_SIZE];
-
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
- resp, sizeof(resp));
- if (!error) {
- ts->hw_version = elants_i2c_parse_version(resp);
- if (ts->hw_version != 0xffff)
- return 0;
- }
+ struct i2c_client *client = to_i2c_client(dev);
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int error;
- dev_dbg(&client->dev, "read fw id error=%d, buf=%*phC\n",
- error, (int)sizeof(resp), resp);
- }
+ error = mutex_lock_interruptible(&ts->sysfs_mutex);
+ if (error)
+ return error;
- dev_err(&client->dev,
- "Failed to read fw id or fw id is invalid\n");
+ error = elan_fw_update(ts);
+ dev_dbg(dev, "firmware update result: %d\n", error);
- return -EINVAL;
+ mutex_unlock(&ts->sysfs_mutex);
+ return error ?: count;
}
-static int elants_i2c_query_fw_version(struct elants_data *ts)
+static ssize_t show_iap_mode(struct device *dev,
+ struct device_attribute *attr, char *buf)
{
- struct i2c_client *client = ts->client;
- int error, retry_cnt;
- const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_FW_VER, 0x00, 0x01 };
- u8 resp[HEADER_SIZE];
+ struct i2c_client *client = to_i2c_client(dev);
+ struct elants_data *ts = i2c_get_clientdata(client);
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
- resp, sizeof(resp));
- if (!error) {
- ts->fw_version = elants_i2c_parse_version(resp);
- if (ts->fw_version != 0x0000 &&
- ts->fw_version != 0xffff)
- return 0;
- }
+ return sprintf(buf, "%s\n",
+ (ts->iap_mode == 0) ? "Normal" : "Recovery");
+}
- dev_dbg(&client->dev, "read fw version error=%d, buf=%*phC\n",
- error, (int)sizeof(resp), resp);
- }
+static DEVICE_ATTR(calibrate, S_IWUSR, NULL, calibrate_store);
+static DEVICE_ATTR(iap_mode, S_IRUGO, show_iap_mode, NULL);
+static DEVICE_ATTR(update_fw, S_IWUSR, NULL, write_update_fw);
- dev_err(&client->dev,
- "Failed to read fw version or fw version is invalid\n");
+struct elants_version_attribute {
+ struct device_attribute dattr;
+ size_t field_offset;
+ size_t field_size;
+};
- return -EINVAL;
-}
+#define __ELANTS_FIELD_SIZE(_field) \
+ sizeof(((struct elants_data *)NULL)->_field)
+#define __ELANTS_VERIFY_SIZE(_field) \
+ (BUILD_BUG_ON_ZERO(__ELANTS_FIELD_SIZE(_field) > 2) + \
+ __ELANTS_FIELD_SIZE(_field))
+#define ELANTS_VERSION_ATTR(_field) \
+ struct elants_version_attribute elants_ver_attr_##_field = { \
+ .dattr = __ATTR(_field, S_IRUGO, \
+ elants_version_attribute_show, NULL), \
+ .field_offset = offsetof(struct elants_data, _field), \
+ .field_size = __ELANTS_VERIFY_SIZE(_field), \
+ }
-static int elants_i2c_query_test_version(struct elants_data *ts)
+static ssize_t elants_version_attribute_show(struct device *dev,
+ struct device_attribute *dattr,
+ char *buf)
{
- struct i2c_client *client = ts->client;
- int error, retry_cnt;
- u16 version;
- const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_TEST_VER, 0x00, 0x01 };
- u8 resp[HEADER_SIZE];
-
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
- resp, sizeof(resp));
- if (!error) {
- version = elants_i2c_parse_version(resp);
- ts->test_version = version >> 8;
- ts->solution_version = version & 0xff;
-
- return 0;
- }
+ struct i2c_client *client = to_i2c_client(dev);
+ struct elants_data *ts = i2c_get_clientdata(client);
+ struct elants_version_attribute *attr =
+ container_of(dattr, struct elants_version_attribute, dattr);
+ u8 *field = (u8 *)((char *)ts + attr->field_offset);
+ unsigned int fmt_size;
+ unsigned int val;
- dev_dbg(&client->dev,
- "read test version error rc=%d, buf=%*phC\n",
- error, (int)sizeof(resp), resp);
+ if (attr->field_size == 1) {
+ val = *field;
+ fmt_size = 2; /* 2 HEX digits */
+ } else {
+ val = *(u16 *)field;
+ fmt_size = 4; /* 4 HEX digits */
}
- dev_err(&client->dev, "Failed to read test version\n");
-
- return -EINVAL;
+ return sprintf(buf, "%0*x\n", fmt_size, val);
}
-static int elants_i2c_query_bc_version(struct elants_data *ts)
-{
- struct i2c_client *client = ts->client;
- const u8 cmd[] = { CMD_HEADER_READ, E_ELAN_INFO_BC_VER, 0x00, 0x01 };
- u8 resp[HEADER_SIZE];
- u16 version;
- int error;
+static ELANTS_VERSION_ATTR(fw_version);
+static ELANTS_VERSION_ATTR(hw_version);
+static ELANTS_VERSION_ATTR(test_version);
+static ELANTS_VERSION_ATTR(solution_version);
+static ELANTS_VERSION_ATTR(bc_version);
+static ELANTS_VERSION_ATTR(iap_version);
- error = elants_i2c_execute_command(client, cmd, sizeof(cmd),
- resp, sizeof(resp));
- if (error) {
- dev_err(&client->dev,
- "read BC version error=%d, buf=%*phC\n",
- error, (int)sizeof(resp), resp);
- return error;
- }
+static struct attribute *elan_attributes[] = {
+ &dev_attr_calibrate.attr,
+ &dev_attr_update_fw.attr,
+ &dev_attr_iap_mode.attr,
- version = elants_i2c_parse_version(resp);
- ts->bc_version = version >> 8;
- ts->iap_version = version & 0xff;
+ &elants_ver_attr_fw_version.dattr.attr,
+ &elants_ver_attr_hw_version.dattr.attr,
+ &elants_ver_attr_test_version.dattr.attr,
+ &elants_ver_attr_solution_version.dattr.attr,
+ &elants_ver_attr_bc_version.dattr.attr,
+ &elants_ver_attr_iap_version.dattr.attr,
+ NULL
+};
- return 0;
-}
+static struct attribute_group elan_attribute_group = {
+ .attrs = elan_attributes,
+};
-static int elants_i2c_query_ts_info(struct elants_data *ts)
+/*
+ * Software reset to our TS.
+ *
+ * ret >0 means reset success,
+ * otherwise is fail.
+ */
+static int elan_sw_reset(struct i2c_client *client)
{
- struct i2c_client *client = ts->client;
- int error;
- u8 resp[17];
- u16 phy_x, phy_y, rows, cols, osr;
- const u8 get_resolution_cmd[] = {
- CMD_HEADER_6B_READ, 0x00, 0x00, 0x00, 0x00, 0x00
- };
- const u8 get_osr_cmd[] = {
- CMD_HEADER_READ, E_INFO_OSR, 0x00, 0x01
- };
- const u8 get_physical_scan_cmd[] = {
- CMD_HEADER_READ, E_INFO_PHY_SCAN, 0x00, 0x01
- };
- const u8 get_physical_drive_cmd[] = {
- CMD_HEADER_READ, E_INFO_PHY_DRIVER, 0x00, 0x01
- };
+ int ret;
+ const u8 soft_rst_cmd[4] = {0x77, 0x77, 0x77, 0x77};
+ int len_rst_cmd = sizeof(soft_rst_cmd);
- /* Get trace number */
- error = elants_i2c_execute_command(client,
- get_resolution_cmd,
- sizeof(get_resolution_cmd),
- resp, sizeof(resp));
- if (error) {
- dev_err(&client->dev, "get resolution command failed: %d\n",
- error);
- return error;
- }
+ ENTER_LOG();
- rows = resp[2] + resp[6] + resp[10];
- cols = resp[3] + resp[7] + resp[11];
+ ret = i2c_master_send(client, soft_rst_cmd, len_rst_cmd);
- /* Process mm_to_pixel information */
- error = elants_i2c_execute_command(client,
- get_osr_cmd, sizeof(get_osr_cmd),
- resp, sizeof(resp));
- if (error) {
- dev_err(&client->dev, "get osr command failed: %d\n",
- error);
- return error;
+ if (ret != len_rst_cmd) {
+ dev_err(&client->dev, "%s: i2c_master_send failed\n", __func__);
+ return -ENODEV;
}
- osr = resp[3];
+ /* Wait to send fastboot command */
+ elan_msleep(10);
- error = elants_i2c_execute_command(client,
- get_physical_scan_cmd,
- sizeof(get_physical_scan_cmd),
- resp, sizeof(resp));
- if (error) {
- dev_err(&client->dev, "get physical scan command failed: %d\n",
- error);
- return error;
- }
+ return ret;
+}
+
+
+/*
+ * This is always the first packet that comes from
+ * firmware and we need to receive it.
+ *
+ * Normal hello packet is {0x55, 0x55, 0x55, 0x55}
+ * Recovery mode packet is {0x55, 0x55, 0x80, 0x80}
+ */
+static int __hello_packet_handler(struct i2c_client *client)
+{
+ int rc = 0, error = 0;
+ struct elants_data *ts = i2c_get_clientdata(client);
- phy_x = get_unaligned_be16(&resp[2]);
+ ENTER_LOG();
- error = elants_i2c_execute_command(client,
- get_physical_drive_cmd,
- sizeof(get_physical_drive_cmd),
- resp, sizeof(resp));
- if (error) {
- dev_err(&client->dev, "get physical drive command failed: %d\n",
+ /* Wait hello packet received */
+ rc = wait_for_completion_interruptible_timeout(&ts->cmd_done,
+ msecs_to_jiffies(ELAN_HELLO_TIMEOUT_MSEC));
+ if (rc <= 0) {
+ error = rc < 0 ? rc : -ETIMEDOUT;
+ dev_err(&client->dev,
+ "error while waiting for hello packet to complete: %d\n",
error);
return error;
}
- phy_y = get_unaligned_be16(&resp[2]);
+ /* Print ts->cmd_resp anyway */
+ dev_info(&client->dev, "rc=%d Hello Packet:%*phC\n",
+ rc, HELLO_PACKET_LEN, ts->cmd_resp);
- dev_dbg(&client->dev, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
+ if (memcmp(ts->cmd_resp, hello_packet, HELLO_PACKET_LEN)) {
+ if (!memcmp(ts->cmd_resp, recov_packet, RECOV_PACKET_LEN)) {
+ dev_info(&client->dev,
+ "got mainflow recovery message\n");
- if (rows == 0 || cols == 0 || osr == 0) {
- dev_warn(&client->dev,
- "invalid trace number data: %d, %d, %d\n",
- rows, cols, osr);
- } else {
- /* translate trace number to TS resolution */
- ts->x_max = ELAN_TS_RESOLUTION(rows, osr);
- ts->x_res = DIV_ROUND_CLOSEST(ts->x_max, phy_x);
- ts->y_max = ELAN_TS_RESOLUTION(cols, osr);
- ts->y_res = DIV_ROUND_CLOSEST(ts->y_max, phy_y);
+ ts->iap_mode = IAP_MODE_ENABLE;
+ set_bit(LOCK_FW_UPDATE, &ts->flags);
+ }
+ return -ENODEV;
}
- return 0;
+ return rc;
}
-static int elants_i2c_fastboot(struct i2c_client *client)
+static u16 parse_version_number(u8 *buf, size_t len)
{
- const u8 boot_cmd[] = { 0x4D, 0x61, 0x69, 0x6E };
- int error;
+ u8 version_num[2] = {0};
- error = elants_i2c_send(client, boot_cmd, sizeof(boot_cmd));
- if (error) {
- dev_err(&client->dev, "boot failed: %d\n", error);
- return error;
- }
+ if (len != 4)
+ return 0xffff;
- dev_dbg(&client->dev, "boot success -- 0x%x\n", client->addr);
- return 0;
+ version_num[0] = ((buf[1] & 0x0f) << 4) | ((buf[2] & 0xf0) >> 4);
+ version_num[1] = ((buf[2] & 0x0f) << 4) | ((buf[3] & 0xf0) >> 4);
+
+ return ((u16)version_num[0] << 8) + (u16)version_num[1];
}
-static int elants_i2c_initialize(struct elants_data *ts)
+static int __fw_id_packet_handler(struct i2c_client *client)
{
- struct i2c_client *client = ts->client;
- int error, retry_cnt;
- const u8 hello_packet[] = { 0x55, 0x55, 0x55, 0x55 };
- const u8 recov_packet[] = { 0x55, 0x55, 0x80, 0x80 };
- u8 buf[HEADER_SIZE];
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int rc, retry_cnt;
+ const u8 cmd[] = {CMD_HEADER_READ, E_ELAN_INFO_FW_ID, 0x00, 0x01};
+ u8 buf_recv[4] = {0x0};
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_sw_reset(client);
- if (error) {
- /* Continue initializing if it's the last try */
- if (retry_cnt < MAX_RETRIES - 1)
- continue;
- }
+ ENTER_LOG();
- error = elants_i2c_fastboot(client);
- if (error) {
- /* Continue initializing if it's the last try */
- if (retry_cnt < MAX_RETRIES - 1)
- continue;
- }
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
- /* Wait for Hello packet */
- msleep(BOOT_TIME_DELAY_MS);
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_i2c_read_block(client, (u8 *) cmd, sizeof(cmd),
+ buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client,
+ "read fw id rc=%d, buf=%*phC\n", rc, 4,
+ buf_recv);
+ }
- error = elants_i2c_read(client, buf, sizeof(buf));
- if (error) {
- dev_err(&client->dev,
- "failed to read 'hello' packet: %d\n", error);
- } else if (!memcmp(buf, hello_packet, sizeof(hello_packet))) {
- ts->iap_mode = ELAN_IAP_OPERATIONAL;
- break;
- } else if (!memcmp(buf, recov_packet, sizeof(recov_packet))) {
- /*
- * Setting error code will mark device
- * in recovery mode below.
- */
- error = -EIO;
+ if (buf_recv[0] == CMD_HEADER_RESP) {
+ ts->hw_version =
+ parse_version_number(buf_recv, sizeof(buf_recv));
+ if (ts->hw_version == 0xffff) {
+ dev_err(&client->dev,
+ "FW id is empty, "
+ "suggest IAP ELAN chip\n");
+ return -EINVAL;
+ }
break;
} else {
- error = -EINVAL;
- dev_err(&client->dev,
- "invalid 'hello' packet: %*ph\n",
- (int)sizeof(buf), buf);
+ elan_dbg(client, "read fw retry count=%d\n", retry_cnt);
+ if (retry_cnt == MAX_RETRIES - 1) {
+ ts->hw_version = 0xffff;
+ dev_err(&client->dev,
+ "Fail to read fw id for %d times, "
+ "suggest IAP ELAN chip\n", MAX_RETRIES);
+ return -EINVAL;
+ }
}
}
- if (!error)
- error = elants_i2c_query_fw_id(ts);
- if (!error)
- error = elants_i2c_query_fw_version(ts);
+ return 0;
+}
- if (error) {
- ts->iap_mode = ELAN_IAP_RECOVERY;
- } else {
- elants_i2c_query_test_version(ts);
- elants_i2c_query_bc_version(ts);
- elants_i2c_query_ts_info(ts);
+static int __fw_version_packet_handler(struct i2c_client *client)
+{
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int rc, retry_cnt;
+ const u8 cmd[] = {CMD_HEADER_READ, E_ELAN_INFO_FW_VER, 0x00, 0x01};
+ u8 buf_recv[4] = {0x0};
+
+ ENTER_LOG();
+
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
+
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_i2c_read_block(client, (u8 *) cmd, sizeof(cmd),
+ buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client,
+ "read fw version rc=%d, buf=%*phC\n", rc, 4,
+ buf_recv);
+ }
+
+ if (buf_recv[0] == CMD_HEADER_RESP) {
+ ts->fw_version =
+ parse_version_number(buf_recv, sizeof(buf_recv));
+ if ((ts->fw_version == 0x0000) ||
+ (ts->fw_version == 0xffff)) {
+ dev_err(&client->dev,
+ "FW version is empty, "
+ "suggest IAP ELAN chip\n");
+ return -EINVAL;
+ }
+ break;
+ } else {
+ elan_dbg(client, "read fw retry count=%d\n", retry_cnt);
+ if (retry_cnt == MAX_RETRIES - 1) {
+ ts->fw_version = 0xffff;
+ dev_err(&client->dev,
+ "Fail to read fw version for %d times, "
+ "suggest IAP ELAN chip\n", MAX_RETRIES);
+ return -EINVAL;
+ }
+ }
}
return 0;
}
-/*
- * Firmware update interface.
- */
-
-static int elants_i2c_fw_write_page(struct i2c_client *client,
- const void *page)
+static int __test_version_packet_handler(struct i2c_client *client)
{
- const u8 ack_ok[] = { 0xaa, 0xaa };
- u8 buf[2];
- int retry;
- int error;
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int rc, retry_cnt;
+ const u8 cmd[] = { CMD_HEADER_READ,
+ E_ELAN_INFO_TEST_VER, 0x00, 0x01
+ };
+ u8 buf_recv[4] = { 0x0 };
- for (retry = 0; retry < MAX_FW_UPDATE_RETRIES; retry++) {
- error = elants_i2c_send(client, page, ELAN_FW_PAGESIZE);
- if (error) {
- dev_err(&client->dev,
- "IAP Write Page failed: %d\n", error);
- continue;
+ ENTER_LOG();
+
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
+
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_i2c_read_block(client, (u8 *) cmd, sizeof(cmd),
+ buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client,
+ "read test version error rc=%d, buf=%*phC\n",
+ rc, 4, buf_recv);
+ return rc;
}
- error = elants_i2c_read(client, buf, 2);
- if (error) {
- dev_err(&client->dev,
- "IAP Ack read failed: %d\n", error);
- return error;
+ if (buf_recv[0] == CMD_HEADER_RESP) {
+ ts->test_version =
+ (((buf_recv[1] & 0x0f) << 4) |
+ ((buf_recv[2] & 0xf0) >> 4));
+ ts->solution_version =
+ (((buf_recv[2] & 0x0f) << 4) |
+ ((buf_recv[3] & 0xf0) >> 4));
+ break;
+ } else {
+ elan_dbg(client, "read fw retry count=%d\n", retry_cnt);
+ if (retry_cnt == MAX_RETRIES - 1) {
+ ts->test_version = 0xff;
+ ts->solution_version = 0xff;
+ dev_err(&client->dev,
+ "Fail to get test version for %d times.\n",
+ MAX_RETRIES);
+ return -EINVAL;
+ }
}
+ }
+
+ return 0;
+}
+
+static int __bc_version_packet_handler(struct i2c_client *client)
+{
+ struct elants_data *ts = i2c_get_clientdata(client);
+ const u8 get_bc_ver_cmd[] = { CMD_HEADER_READ,
+ E_ELAN_INFO_BC_VER, 0x00, 0x01
+ };
+ u8 buf_recv[4];
+ int rc;
+
+ ENTER_LOG();
- if (!memcmp(buf, ack_ok, sizeof(ack_ok)))
- return 0;
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
- error = -EIO;
+ rc = elan_i2c_read_block(client, (u8 *) get_bc_ver_cmd,
+ sizeof(get_bc_ver_cmd), buf_recv,
+ sizeof(buf_recv));
+ if (rc < 0) {
dev_err(&client->dev,
- "IAP Get Ack Error [%02x:%02x]\n",
- buf[0], buf[1]);
+ "Read BC version error rc=%d, buf=%*phC\n", rc, 4,
+ buf_recv);
+ return rc;
}
- return error;
+ ts->bc_version = (((buf_recv[1] & 0x0f) << 4) |
+ ((buf_recv[2] & 0xf0) >> 4));
+ ts->iap_version = (((buf_recv[2] & 0x0f) << 4) |
+ ((buf_recv[3] & 0xf0) >> 4));
+ return 0;
}
-static int elants_i2c_do_update_firmware(struct i2c_client *client,
- const struct firmware *fw,
- bool force)
+static int __ts_info_handler(struct i2c_client *client)
{
- const u8 enter_iap[] = { 0x45, 0x49, 0x41, 0x50 };
- const u8 enter_iap2[] = { 0x54, 0x00, 0x12, 0x34 };
- const u8 iap_ack[] = { 0x55, 0xaa, 0x33, 0xcc };
- u8 buf[HEADER_SIZE];
- u16 send_id;
- int page, n_fw_pages;
- int error;
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int rc;
+ u8 buf_recv[17] = {0};
+ u16 phy_x, phy_y;
+ const u8 get_resolution_cmd[] = {
+ CMD_HEADER_5B_READ, 0x00, 0x00, 0x00, 0x00, 0x00};
+ const u8 get_osr_cmd[] = {
+ CMD_HEADER_READ, E_INFO_OSR, 0x00, 0x01};
+ const u8 get_physical_scan_cmd[] = {
+ CMD_HEADER_READ, E_INFO_PHY_SCAN, 0x00, 0x01};
+ const u8 get_physical_drive_cmd[] = {
+ CMD_HEADER_READ, E_INFO_PHY_DRIVER, 0x00, 0x01};
- /* Recovery mode detection! */
- if (force) {
- dev_dbg(&client->dev, "Recovery mode procedure\n");
- error = elants_i2c_send(client, enter_iap2, sizeof(enter_iap2));
- } else {
- /* Start IAP Procedure */
- dev_dbg(&client->dev, "Normal IAP procedure\n");
- elants_i2c_sw_reset(client);
+ ENTER_LOG();
- error = elants_i2c_send(client, enter_iap, sizeof(enter_iap));
- }
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
- if (error) {
- dev_err(&client->dev, "failed to enter IAP mode: %d\n", error);
- return error;
- }
+ /* Get trace number */
+ elan_i2c_read_block(client, (u8 *) get_resolution_cmd,
+ sizeof(get_resolution_cmd), buf_recv, 17);
- msleep(20);
+ if (buf_recv[0] == CMD_HEADER_5B_RESP) {
+ ts->rows = (buf_recv[2] + buf_recv[6] + buf_recv[10]);
+ ts->cols = (buf_recv[3] + buf_recv[7] + buf_recv[11]);
+ } else
+ dev_warn(&client->dev, "Read TS Information failed!\n");
- /* check IAP state */
- error = elants_i2c_read(client, buf, 4);
- if (error) {
- dev_err(&client->dev,
- "failed to read IAP acknowledgement: %d\n",
- error);
- return error;
+ /* Process mm_to_pixel information */
+ rc = elan_i2c_read_block(client, (u8 *) get_osr_cmd,
+ sizeof(get_osr_cmd), buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client, "ts_info error rc=%d\n", rc);
+ return rc;
}
- if (memcmp(buf, iap_ack, sizeof(iap_ack))) {
- dev_err(&client->dev,
- "failed to enter IAP: %*ph (expected %*ph)\n",
- (int)sizeof(buf), buf, (int)sizeof(iap_ack), iap_ack);
- return -EIO;
+ if (buf_recv[0] == CMD_HEADER_RESP)
+ ts->osr = buf_recv[3];
+ else
+ dev_warn(&client->dev, "Read TS OSR failed!\n");
+
+ rc = elan_i2c_read_block(client, (u8 *) get_physical_scan_cmd,
+ sizeof(get_physical_scan_cmd), buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client, "ts_info error rc=%d\n", rc);
+ return rc;
}
- dev_info(&client->dev, "successfully entered IAP mode");
+ if (buf_recv[0] == CMD_HEADER_RESP)
+ phy_x = (buf_recv[2] << 8) | buf_recv[3];
+ else
+ dev_warn(&client->dev, "Read TS PHY_SCAN failed!\n");
- send_id = client->addr;
- error = elants_i2c_send(client, &send_id, 1);
- if (error) {
- dev_err(&client->dev, "sending dummy byte failed: %d\n",
- error);
- return error;
+ rc = elan_i2c_read_block(client, (u8 *) get_physical_drive_cmd,
+ sizeof(get_physical_drive_cmd), buf_recv, 4);
+ if (rc < 0) {
+ elan_dbg(client, "ts_info error rc=%d\n", rc);
+ return rc;
}
- /* Clear the last page of Master */
- error = elants_i2c_send(client, fw->data, ELAN_FW_PAGESIZE);
- if (error) {
- dev_err(&client->dev, "clearing of the last page failed: %d\n",
- error);
- return error;
- }
+ if (buf_recv[0] == CMD_HEADER_RESP)
+ phy_y = (buf_recv[2] << 8) | buf_recv[3];
+ else
+ dev_warn(&client->dev, "Read TS PHY_DRIVER failed!\n");
- error = elants_i2c_read(client, buf, 2);
- if (error) {
- dev_err(&client->dev,
- "failed to read ACK for clearing the last page: %d\n",
- error);
- return error;
- }
+ elan_dbg(client, "phy_x=%d, phy_y=%d\n", phy_x, phy_y);
- n_fw_pages = fw->size / ELAN_FW_PAGESIZE;
- dev_dbg(&client->dev, "IAP Pages = %d\n", n_fw_pages);
+ if (ts->rows > 0 && ts->cols > 0 && ts->osr > 0) {
+ /* translate trace number to TS resolution */
+ ts->x_max = ELAN_TS_RESOLUTION(ts->rows, ts->osr);
+ ts->y_max = ELAN_TS_RESOLUTION(ts->cols, ts->osr);
+ } else
+ dev_warn(&client->dev, "trace number error, %d,%d,%d\n",
+ ts->rows, ts->cols, ts->osr);
- for (page = 0; page < n_fw_pages; page++) {
- error = elants_i2c_fw_write_page(client,
- fw->data + page * ELAN_FW_PAGESIZE);
- if (error) {
- dev_err(&client->dev,
- "failed to write FW page %d: %d\n",
- page, error);
- return error;
- }
- }
+ ts->x_res = DIV_ROUND_CLOSEST(ts->x_max, phy_x);
+ ts->y_res = DIV_ROUND_CLOSEST(ts->y_max, phy_y);
+
+ return 0;
+}
- /* Old iap needs to wait 200ms for WDT and rest is for hello packets */
- msleep(300);
+static int check_firmware_compatibility(struct elants_data *ts,
+ const u8 *fw_index)
+{
+ u16 new_hw_ver;
+ u16 new_fw_ver;
+
+ new_hw_ver = get_unaligned_le16(&fw_index[0x871a]);
+ new_fw_ver = get_unaligned_le16(&fw_index[0x850a]);
+ elan_dbg(ts->client, "hw_ver = 0x%x, new_hw_ver = 0x%x\n",
+ ts->hw_version, new_hw_ver);
+ elan_dbg(ts->client, "fw_ver = 0x%x, new_fw_ver = 0x%x\n",
+ ts->fw_version, new_fw_ver);
+
+ if (ts->hw_version != new_hw_ver) {
+ dev_err(&ts->client->dev, "Hw_ver different, org = %x new = %x\n",
+ ts->hw_version, new_hw_ver);
+ return -1;
+ }
- dev_info(&client->dev, "firmware update completed\n");
return 0;
}
-static int elants_i2c_fw_update(struct elants_data *ts)
+/**
+ * elan_fw_update - Elan firmware update in driver
+ *
+ * client: our i2c client
+ *
+ * The driver will first try to load a device-specific FW named
+ * elants_i2c_${HW_VERSION}.bin then fail over to the more generic
+ * "elants_i2c.bin".
+ * The file path is located /system/etc/firmware at Android.
+ * The file path usually is located at /lib/firmware.
+ */
+static int elan_fw_update(struct elants_data *ts)
{
struct i2c_client *client = ts->client;
- const struct firmware *fw;
- char *fw_name;
- int error;
+ int rc = 0;
+ int page = 0;
+ int fw_size = 0, fw_pages;
+ int retry;
+ bool force = false;
+ char fw_filename_buffer[ELAN_FW_FILENAME_MAX_LEN];
+ u8 buf[4];
+ u16 send_id;
+ const struct firmware *p_fw_entry;
+ const u8 *fw_data;
+ const u8 enter_iap[4] = { 0x45, 0x49, 0x41, 0x50 };
+ const u8 enter_iap2[4] = { 0x54, 0x00, 0x12, 0x34 };
+ const u8 iap_rc[4] = { 0x55, 0xaa, 0x33, 0xcc };
+ const u8 ack_ok[2] = { 0xaa, 0xaa };
+ const u8 close_idle_cmd[] = {0x54, 0x2c, 0x01, 0x01};
- fw_name = kasprintf(GFP_KERNEL, "elants_i2c_%04x.bin", ts->hw_version);
- if (!fw_name)
- return -ENOMEM;
+ ENTER_LOG();
- dev_info(&client->dev, "requesting fw name = %s\n", fw_name);
- error = request_firmware(&fw, fw_name, &client->dev);
- kfree(fw_name);
- if (error) {
- dev_err(&client->dev, "failed to request firmware: %d\n",
- error);
- return error;
+ ts->iap_mode = IAP_MODE_ENABLE;
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ force = true;
+
+ elan_dbg(client, "IAP Start.\n");
+
+ rc = test_and_set_bit(LOCK_FW_UPDATE, &ts->flags);
+ if (rc)
+ dev_info(&client->dev, "Recovery IAP detection\n");
+
+
+ /*
+ * First try to load a FW with the hw_version appended to the end.
+ * Failing that, just load a FW without any hw version
+ */
+ snprintf(fw_filename_buffer, ELAN_FW_FILENAME_MAX_LEN, "%s_%4x.%s",
+ ELAN_FW_BASE_FILENAME, ts->hw_version, ELAN_FW_EXTENSION);
+ dev_info(&client->dev, "requesting fw name = %s\n", fw_filename_buffer);
+ rc = request_firmware(&p_fw_entry, fw_filename_buffer, &client->dev);
+ if (rc != 0) {
+ dev_err(&client->dev, "rc=%d, request_firmware fail\n", rc);
+ snprintf(fw_filename_buffer, ELAN_FW_FILENAME_MAX_LEN, "%s.%s",
+ ELAN_FW_BASE_FILENAME, ELAN_FW_EXTENSION);
+ dev_info(&client->dev, "Falling back to fw name = %s\n",
+ fw_filename_buffer);
+ rc = request_firmware(&p_fw_entry, fw_filename_buffer,
+ &client->dev);
+ if (rc != 0) {
+ dev_err(&client->dev,
+ "rc=%d, request_firmware fail\n", rc);
+ goto err;
+ }
}
+ elan_dbg(client, "Firmware loaded! Size=%zu\n", p_fw_entry->size);
+
+ fw_data = p_fw_entry->data;
+ fw_size = p_fw_entry->size;
- if (fw->size % ELAN_FW_PAGESIZE) {
- dev_err(&client->dev, "invalid firmware length: %zu\n",
- fw->size);
- error = -EINVAL;
- goto out;
+ rc = check_firmware_compatibility(ts, fw_data);
+ if (rc != 0) {
+ dev_err(&client->dev, "The hw_ver is different, exit fw update.\n");
+ goto err;
}
- disable_irq(client->irq);
+ if (fw_size % ELAN_FW_PAGESIZE) {
+ dev_err(&client->dev, "Wrong file length(size=%d)\n", fw_size);
+ goto err;
+ }
- error = elants_i2c_do_update_firmware(client, fw,
- ts->iap_mode == ELAN_IAP_RECOVERY);
- if (error) {
- dev_err(&client->dev, "firmware update failed: %d\n", error);
- ts->iap_mode = ELAN_IAP_RECOVERY;
- goto out_enable_irq;
+ /* Recovery mode detection! */
+ if (force) {
+ elan_dbg(client, "Recover mode procedure!\n");
+ elan_set_data(client, enter_iap2, 4);
+ } else {
+ /* Start IAP Procedure */
+ elan_dbg(client, "Normal IAP procedure!\n");
+ /* Close idle mode */
+ elan_set_data(client, close_idle_cmd, 4);
+ elan_msleep(60);
+ elan_sw_reset(client);
+ elan_msleep(20);
+ elan_set_data(client, enter_iap, 4);
}
+ elan_msleep(10);
- error = elants_i2c_initialize(ts);
- if (error) {
- dev_err(&client->dev,
- "failed to initialize device after firmware update: %d\n",
- error);
- ts->iap_mode = ELAN_IAP_RECOVERY;
- goto out_enable_irq;
+ /* check IAP state */
+ rc = elan_get_data(client, buf, 4);
+ if (rc < 0) {
+ dev_err(&client->dev, "Enter IAP fail!! [Read IAPRC=%d, addr-%.2x fail]\n",
+ rc, client->addr);
+ rc = -ENODEV;
+ goto err;
+ } else {
+ if (unlikely(memcmp(buf, iap_rc, 4))) {
+ dev_err(&client->dev, "Enter IAP fail!!");
+ rc = -ENODEV;
+ goto err;
+ } else {
+ dev_info(&client->dev, "Enter IAP success!");
+ }
}
- ts->iap_mode = ELAN_IAP_OPERATIONAL;
+ send_id = client->addr;
+ rc = elan_set_data(client, (const u8 *)&send_id, 1);
+ if (rc < 0) {
+ dev_err(&client->dev, "send dummy byte error addr=%.2x\n",
+ client->addr);
+ rc = -ENODEV;
+ goto err;
+ }
-out_enable_irq:
- ts->state = ELAN_STATE_NORMAL;
- enable_irq(client->irq);
- msleep(100);
+ /* Clear the last page of Master */
+ rc = elan_set_data(client, fw_data, ELAN_FW_PAGESIZE);
+ if (rc < 0) {
+ dev_err(&client->dev, "Clean the last page fail\n");
+ rc = -ENODEV;
+ goto err;
+ }
- if (!error)
- elants_i2c_calibrate(ts);
-out:
- release_firmware(fw);
- return error;
-}
+ rc = elan_get_data(client, buf, 2);
+ if (rc < 0) {
+ dev_err(&client->dev, "Stage1 IAP get ack fail!\n");
+ rc = -ENODATA;
+ goto err;
+ }
-/*
- * Event reporting.
- */
+ fw_pages = (fw_size / ELAN_FW_PAGESIZE);
+ elan_dbg(client, "IAP Pages = %d\n", fw_pages);
+
+ for (page = 0; page < fw_pages; page++) {
+ bool page_written_successfully = false;
+ for (retry = 0; retry < MAX_FW_UPDATE_RETRIES; retry++) {
+ rc = elan_set_data(
+ client, fw_data + (page * ELAN_FW_PAGESIZE),
+ ELAN_FW_PAGESIZE);
+ elan_dbg(client, "IAP_WRITE1...%d\n", page);
+ if (rc < 0) {
+ dev_err(&client->dev,
+ "IAP Write Page data err!! [rc=%d]\n",
+ rc);
+ }
-static void elants_i2c_mt_event(struct elants_data *ts, u8 *buf)
-{
- struct input_dev *input = ts->input;
- unsigned int n_fingers;
- u16 finger_state;
- int i;
+ rc = elan_get_data(client, buf, 2);
+ if (unlikely(rc < 0)) {
+ dev_err(&client->dev, "IAP Ack data err!!\n");
+ rc = -ENODATA;
+ goto err;
+ } else {
+ elan_dbg(client, "IAP_WRITE2...%d, ret=%x:%x\n",
+ page, buf[0], buf[1]);
+ if (memcmp(buf, ack_ok, 2)) {
+ dev_err(&client->dev,
+ "IAP Get Ack Error [%02x:%02x]!!\n",
+ buf[0], buf[1]);
+ elan_dbg(client,
+ "page_rewrite retry %d.\n",
+ retry);
+ } else {
+ dev_info(&client->dev,
+ "Elan fw update..page-%.2d OK\n",
+ page);
+ page_written_successfully = true;
+ break;
+ }
+ }
+ }
- n_fingers = buf[FW_POS_STATE + 1] & 0x0f;
- finger_state = ((buf[FW_POS_STATE + 1] & 0x30) << 4) |
- buf[FW_POS_STATE];
+ if (!page_written_successfully) {
+ dev_err(&client->dev,
+ "IAP Write Page %.2d timed out!!\n", page);
+ rc = -ENODEV;
+ goto err;
+ }
+ }
- dev_dbg(&ts->client->dev,
- "n_fingers: %u, state: %04x\n", n_fingers, finger_state);
+ dev_info(&client->dev, "fw update finish..check OK??\n");
- for (i = 0; i < MAX_CONTACT_NUM && n_fingers; i++) {
- if (finger_state & 1) {
- unsigned int x, y, p, w;
- u8 *pos;
+ clear_bit(LOCK_FW_UPDATE, &ts->flags);
+ ts->iap_mode = 0;
- pos = &buf[FW_POS_XY + i * 3];
- x = (((u16)pos[0] & 0xf0) << 4) | pos[1];
- y = (((u16)pos[0] & 0x0f) << 8) | pos[2];
- p = buf[FW_POS_PRESSURE + i];
- w = buf[FW_POS_WIDTH + i];
+ rc = elan_initialize(client);
+ if (rc < 0) {
+ dev_err(&client->dev, "TS Setup handshake fail!! (%d)\n", rc);
- dev_dbg(&ts->client->dev, "i=%d x=%d y=%d p=%d w=%d\n",
- i, x, y, p, w);
+ ts->hw_version = 0xffff;
+ ts->fw_version = 0xffff;
+ ts->test_version = 0xff;
+ ts->solution_version = 0xff;
+ ts->bc_version = 0xff;
+ ts->iap_version = 0xff;
- input_mt_slot(input, i);
- input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
- input_event(input, EV_ABS, ABS_MT_POSITION_X, x);
- input_event(input, EV_ABS, ABS_MT_POSITION_Y, y);
- input_event(input, EV_ABS, ABS_MT_PRESSURE, p);
- input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, w);
+ dev_err(&client->dev, "IAP Update Failure!!\n");
+ goto err;
+ } else {
+ dev_info(&client->dev, "IAP Update Successful!\n");
+ }
- n_fingers--;
- }
+err:
+ /* We don't have update fw info ...
+ * those is kept as previous fw data
+ * and will update after reboot if err case.
+ */
+ clear_bit(LOCK_FW_UPDATE, &ts->flags);
+ ts->iap_mode = 0;
- finger_state >>= 1;
+ release_firmware(p_fw_entry);
+ /* We don't release LOCK_FW_UPDATE flag if fail */
+ elan_msleep(600);
+ /* we need to calibrate touchscreen */
+ elan_calibrate(ts);
+
+ return rc;
+}
+
+/*
+ * Parsing report header and get data information.
+ *
+ * client: the i2c device to recieve from
+ * buf: buffer to store finger data header.
+ */
+static int elan_get_repo_info(struct i2c_client *client, u8 *buf)
+{
+ struct elants_data *ts = i2c_get_clientdata(client);
+ struct multi_queue_header *buff = (struct multi_queue_header *)buf;
+ struct multi_queue_header *mq = &ts->mq_header;
+ const u8 wait_packet[4] = {0x64, 0x64, 0x64, 0x64};
+ int times = 10, rc = 0;
+
+ ENTER_LOG();
+
+ switch (buf[FW_POS_HEADER]) {
+ case CMD_HEADER_HELLO:
+ if (!memcmp(buf, hello_packet, 4))
+ ts->wdt_reset++;
+ memcpy(ts->cmd_resp, buf, 4);
+ elan_dbg(client, "recv CMD_HEADER_HELLO: [%*phC]\n", 4, buf);
+ complete(&ts->cmd_done);
+ return RET_CMDRSP;
+
+ case CMD_HEADER_RESP:
+ case CMD_HEADER_REK:
+ elan_dbg(client, "recv CMD_HEADER_RESP: [%*phC]\n", 4, buf);
+ memcpy(ts->cmd_resp, buf, 4);
+ complete(&ts->cmd_done);
+
+ return RET_CMDRSP;
+
+ case CMD_HEADER_5B_RESP:
+ elan_dbg(client, "recv CMD_HEADER_5B_READ: [%*phC]\n", 17, buf);
+ memcpy(ts->cmd_resp, buf, 17);
+ complete(&ts->cmd_done);
+
+ return RET_CMDRSP;
+
+ /* Buffer mode header */
+ case QUEUE_HEADER_NORMAL:
+ elan_dbg(client,
+ "report_count=%d report_len=%d\n",
+ buff->report_count, buff->report_length);
+
+ if (buff->report_count <= 3) {
+ mq->report_count = buff->report_count;
+ mq->report_length = buff->report_length;
+ ts->rx_size = mq->report_length;
+ ts->packet_size = mq->report_length / mq->report_count;
+ } else
+ return RET_FAIL;
+
+ break;
+ case QUEUE_HEADER_WAIT:
+ elan_dbg(client,
+ "QUEUE_HEADER_WAIT %x:%x:%x:%x\n",
+ buf[0], buf[1], buf[2], buf[3]);
+
+ if (!memcmp(buf + 1, &wait_packet[1], 3)) {
+ do {
+ udelay(30);
+ elan_get_data(client, (u8 *)buff, ts->rx_size);
+ } while ((buff->packet_id != QUEUE_HEADER_NORMAL) &&
+ (--times > 0));
+ if (times > 0)
+ rc = elan_get_repo_info(client, (u8 *)buff);
+ else
+ return RET_FAIL;
+ elan_dbg(client,
+ "Detect Wait_Header:rx_size=%d, "
+ "report_count=%d report_len=%d\n",
+ ts->rx_size,
+ mq->report_count, mq->report_length);
+ } else
+ dev_err(&client->dev,
+ "ERROR!! wait header:%x:%x:%x:%x\n",
+ buf[0], buf[1], buf[2], buf[3]);
+ break;
+ /* Not buffer mode, it's single word mode */
+ case QUEUE_HEADER_SINGLE:
+ mq->report_count = 1;
+ mq->report_length = PACKET_SIZE;
+ ts->rx_size = mq->report_length;
+ ts->packet_size = mq->report_length / mq->report_count;
+ return ts->rx_size;
+ default:
+ dev_err(&client->dev,
+ "unknown multi-queue command!! --%x %x:%x:%x--\n",
+ buf[0], buf[1], buf[2], buf[3]);
+ ts->mq_header_fail++;
+
+ /* If glitch causes frame error, drop all finger report */
+ ts->rx_size = MAX_PACKET_LEN;
+ elan_get_data(client, (u8 *)buff, ts->rx_size);
+ return RET_FAIL;
}
- input_mt_sync_frame(input);
- input_sync(input);
+ return ts->rx_size;
}
-static u8 elants_i2c_calculate_checksum(u8 *buf)
+/*
+ * Caculating checksum for make sure all data validity.
+ *
+ * client : the i2c device to recieve from
+ * buf : raw finger data from firmware.
+ */
+static int elan_touch_checksum(struct i2c_client *client, u8 *buf)
{
- u8 checksum = 0;
- u8 i;
+ u8 i = 0, checksum = 0;
+ struct elants_data *ts = i2c_get_clientdata(client);
+
+ ENTER_LOG();
for (i = 0; i < FW_POS_CHECKSUM; i++)
- checksum += buf[i];
+ checksum = checksum + buf[i];
- return checksum;
+ if (checksum != buf[FW_POS_CHECKSUM]) {
+ ts->checksum_fail++;
+ dev_err(&client->dev,
+ "elan touch checksum fail: %02x:%02x\n",
+ checksum, buf[FW_POS_CHECKSUM]);
+ return -EFAULT;
+ }
+
+ return 0;
}
-static void elants_i2c_event(struct elants_data *ts, u8 *buf)
+/*
+ * Parsing the track id of fingers.
+ *
+ * data: the input bit stream
+ * fid: an array of tracking ID values
+ */
+static inline void elan_parse_fid(u8 *data, u8 *fid)
{
- u8 checksum = elants_i2c_calculate_checksum(buf);
-
- if (unlikely(buf[FW_POS_CHECKSUM] != checksum))
- dev_warn(&ts->client->dev,
- "%s: invalid checksum for packet %02x: %02x vs. %02x\n",
- __func__, buf[FW_POS_HEADER],
- checksum, buf[FW_POS_CHECKSUM]);
- else if (unlikely(buf[FW_POS_HEADER] != HEADER_REPORT_10_FINGER))
- dev_warn(&ts->client->dev,
- "%s: unknown packet type: %02x\n",
- __func__, buf[FW_POS_HEADER]);
- else
- elants_i2c_mt_event(ts, buf);
+ fid[0] = (data[0] & 0x01);
+ fid[1] = (data[0] & 0x02);
+ fid[2] = (data[0] & 0x04);
+ fid[3] = (data[0] & 0x08);
+ fid[4] = (data[0] & 0x10);
+ fid[5] = (data[0] & 0x20);
+ fid[6] = (data[0] & 0x40);
+ fid[7] = (data[0] & 0x80);
+ fid[8] = (data[1] & 0x10);
+ fid[9] = (data[1] & 0x20);
}
-static irqreturn_t elants_i2c_irq(int irq, void *_dev)
+/*
+ * Parsing finger widths data with length of 8 bits.
+ *
+ * data: the input bit stream
+ * width: an array of width level
+ */
+static inline void elan_parse_widths(u8 *data, u8 *width)
{
- const u8 wait_packet[] = { 0x64, 0x64, 0x64, 0x64 };
- struct elants_data *ts = _dev;
- struct i2c_client *client = ts->client;
- int report_count, report_len;
int i;
- int len;
- len = i2c_master_recv(client, ts->buf, sizeof(ts->buf));
- if (len < 0) {
- dev_err(&client->dev, "%s: failed to read data: %d\n",
- __func__, len);
- goto out;
- }
+ for (i = 0; i < MAX_CONTACT_NUM; i++)
+ width[i] = data[i];
- dev_dbg(&client->dev, "%s: packet %*ph\n",
- __func__, HEADER_SIZE, ts->buf);
+ return;
+}
- switch (ts->state) {
- case ELAN_WAIT_RECALIBRATION:
- if (ts->buf[FW_HDR_TYPE] == CMD_HEADER_REK) {
- memcpy(ts->cmd_resp, ts->buf, sizeof(ts->cmd_resp));
- complete(&ts->cmd_done);
- ts->state = ELAN_STATE_NORMAL;
- }
- break;
+/*
+ * Parsing finger pressure data with length of 8 bits.
+ *
+ * data: the input bit stream
+ * pressure: an array of pressure level
+ */
+static inline void elan_parse_pressures(u8 *data, u8 *pressure)
+{
+ memcpy(pressure, data, MAX_CONTACT_NUM);
+ return;
+}
- case ELAN_WAIT_QUEUE_HEADER:
- if (ts->buf[FW_HDR_TYPE] != QUEUE_HEADER_NORMAL)
- break;
+static inline int elan_parse_xy(u8 *data, u16 *x, u16 *y)
+{
+ *x = *y = 0;
- ts->state = ELAN_STATE_NORMAL;
- /* fall through */
+ *x = (data[0] & 0xf0);
+ *x <<= 4;
+ *x |= data[1];
- case ELAN_STATE_NORMAL:
+ *y = (data[0] & 0x0f);
+ *y <<= 8;
+ *y |= data[2];
- switch (ts->buf[FW_HDR_TYPE]) {
- case CMD_HEADER_HELLO:
- case CMD_HEADER_RESP:
- case CMD_HEADER_REK:
- break;
+ return 0;
+}
- case QUEUE_HEADER_WAIT:
- if (memcmp(ts->buf, wait_packet, sizeof(wait_packet))) {
- dev_err(&client->dev,
- "invalid wait packet %*ph\n",
- HEADER_SIZE, ts->buf);
- } else {
- ts->state = ELAN_WAIT_QUEUE_HEADER;
- udelay(30);
- }
- break;
+static int elan_mt_compute_slot(struct mt_device *td)
+{
+ int i;
+ struct elants_data *ts = container_of(td, struct elants_data, td);
- case QUEUE_HEADER_SINGLE:
- elants_i2c_event(ts, &ts->buf[HEADER_SIZE]);
- break;
+ for (i = 0; i < MAX_CONTACT_NUM; ++i) {
+ if (td->slots[i].contactid == td->curdata.contactid &&
+ td->slots[i].touch_state)
+ return i;
+ }
+ for (i = 0; i < MAX_CONTACT_NUM; ++i) {
+ if (!td->slots[i].seen_in_this_frame &&
+ !td->slots[i].touch_state)
+ return i;
+ }
- case QUEUE_HEADER_NORMAL:
- report_count = ts->buf[FW_HDR_COUNT];
- if (report_count > 3) {
- dev_err(&client->dev,
- "too large report count: %*ph\n",
- HEADER_SIZE, ts->buf);
- break;
- }
+ dev_err(&ts->client->dev,
+ "finger number exceed %d, ingore it then\n",
+ MAX_CONTACT_NUM);
+ /* should not occurs. If this happens that means
+ * that the device sent more touches that it says
+ * in the report descriptor. It is ignored then. */
+ return -1;
+}
- report_len = ts->buf[FW_HDR_LENGTH] / report_count;
- if (report_len != PACKET_SIZE) {
- dev_err(&client->dev,
- "mismatching report length: %*ph\n",
- HEADER_SIZE, ts->buf);
- break;
- }
+/*
+* This function is called when a whole contact has been processed,
+* so that it can assign it to a slot and store the data there
+*/
+static void elan_mt_complete_slot(struct mt_device *td)
+{
+ td->curdata.seen_in_this_frame = true;
+ if (td->curvalid) {
+ int slotnum = elan_mt_compute_slot(td);
- for (i = 0; i < report_count; i++) {
- u8 *buf = ts->buf + HEADER_SIZE +
- i * PACKET_SIZE;
- elants_i2c_event(ts, buf);
- }
- break;
+ if (slotnum >= 0 && slotnum < MAX_CONTACT_NUM)
+ td->slots[slotnum] = td->curdata;
+ }
+ td->num_received++;
+}
- default:
- dev_err(&client->dev, "unknown packet %*ph\n",
- HEADER_SIZE, ts->buf);
- break;
+/*
+* This function is called when a whole packet has been received and processed,
+* so that it can decide what to send to the input layer.
+*/
+static void elan_mt_emit_event(struct mt_device *td, struct input_dev *input)
+{
+ struct elants_data *ts = container_of(td, struct elants_data, td);
+ int i;
+
+ for (i = 0; i < MAX_CONTACT_NUM; ++i) {
+ struct mt_slot *s = &td->slots[i];
+ if (!s->seen_in_this_frame)
+ s->touch_state = false;
+
+ input_mt_slot(input, i);
+ input_mt_report_slot_state(input, MT_TOOL_FINGER,
+ s->touch_state);
+ if (s->touch_state) {
+ /* This finger is on the screen */
+ int major = max(s->w, s->h), minor = min(s->w, s->h);
+
+ elan_dbg(ts->client, "i=%d x=%d y=%d p=%d w=%d h=%d.\n",
+ i, s->x, s->y, s->p, major, minor);
+
+ input_event(input, EV_ABS, ABS_MT_POSITION_X, s->x);
+ input_event(input, EV_ABS, ABS_MT_POSITION_Y, s->y);
+ input_event(input, EV_ABS, ABS_MT_PRESSURE, s->p);
+ input_event(input, EV_ABS, ABS_MT_TOUCH_MAJOR, major);
}
- break;
+ s->seen_in_this_frame = false;
}
-out:
- return IRQ_HANDLED;
+ input_mt_report_pointer_emulation(input, true);
+ input_sync(input);
+ td->num_received = 0;
}
/*
- * sysfs interface
+ * Walk the received report and process the finger data, extracting
+ * and reporting co-ordinates.
+ *
+ * ts: our touchscreen
+ * num_fingers: number of fingers in packet
+ * buf: raw finger data
*/
-static ssize_t calibrate_store(struct device *dev,
- struct device_attribute *attr,
- const char *buf, size_t count)
+static int elan_mt_event(struct elants_data *ts, int num_fingers, u8 *buf)
{
- struct i2c_client *client = to_i2c_client(dev);
- struct elants_data *ts = i2c_get_clientdata(client);
- int error;
+ int i;
+ u8 fid[MAX_CONTACT_NUM] = {0};
+ u8 widths[MAX_CONTACT_NUM] = {0};
+ u8 pressures[MAX_CONTACT_NUM] = {0};
+ struct i2c_client *client = ts->client;
+ struct mt_device *td = &ts->td;
- error = mutex_lock_interruptible(&ts->sysfs_mutex);
- if (error)
- return error;
+ ENTER_LOG();
- error = elants_i2c_calibrate(ts);
+ /* Parsing Finger, Width, Pressure field */
+ elan_parse_fid(&buf[FW_POS_STATE], fid);
+ elan_parse_widths(&buf[FW_POS_WIDTH], widths);
+ elan_parse_pressures(&buf[FW_POS_PRESSURE], pressures);
- mutex_unlock(&ts->sysfs_mutex);
- return error ?: count;
-}
+ for (i = 0; (i < MAX_CONTACT_NUM) && (num_fingers > 0); i++) {
+ /* tracking id */
+ td->curdata.contactid = (fid[i] > 0) ? i + 1 : 0;
-static ssize_t write_update_fw(struct device *dev,
- struct device_attribute *attr,
- const char *buf, size_t count)
-{
- struct i2c_client *client = to_i2c_client(dev);
- struct elants_data *ts = i2c_get_clientdata(client);
- int error;
+ if (td->curdata.contactid == 0)
+ continue;
- error = mutex_lock_interruptible(&ts->sysfs_mutex);
- if (error)
- return error;
+ td->curdata.touch_state = true;
- error = elants_i2c_fw_update(ts);
- dev_dbg(dev, "firmware update result: %d\n", error);
+ elan_parse_xy(&buf[3 + i * 3],
+ (u16 *)&td->curdata.x,
+ (u16 *)&td->curdata.y);
+ td->curdata.p = pressures[i];
+ td->curdata.w = td->curdata.h = widths[i];
- mutex_unlock(&ts->sysfs_mutex);
- return error ?: count;
+ num_fingers--;
+
+ elan_mt_complete_slot(td);
+ }
+
+ if (td->num_received >= num_fingers)
+ elan_mt_emit_event(td, ts->input);
+
+ return 1;
}
-static ssize_t show_iap_mode(struct device *dev,
- struct device_attribute *attr, char *buf)
+/*
+ * To extract finger data and sanity check
+ * then send it out to input layer.
+ *
+ * client : the i2c device to recieve from
+ * buf : raw finger data.
+ */
+static void elan_report_data(struct i2c_client *client, u8 *buf)
{
- struct i2c_client *client = to_i2c_client(dev);
struct elants_data *ts = i2c_get_clientdata(client);
- return sprintf(buf, "%s\n",
- ts->iap_mode == ELAN_IAP_OPERATIONAL ?
- "Normal" : "Recovery");
-}
+ ENTER_LOG();
-static DEVICE_ATTR(calibrate, S_IWUSR, NULL, calibrate_store);
-static DEVICE_ATTR(iap_mode, S_IRUGO, show_iap_mode, NULL);
-static DEVICE_ATTR(update_fw, S_IWUSR, NULL, write_update_fw);
+ switch (buf[FW_POS_HEADER]) {
+ case REPORT_HEADER_10_FINGER:{
+ u8 num_fingers = buf[FW_POS_TOTAL] & 0x0f;
+ elan_dbg(client, "finger_stat == %d\n", num_fingers);
+ elan_dbg(client, "finger:%*phC\n", 10, buf);
-struct elants_version_attribute {
- struct device_attribute dattr;
- size_t field_offset;
- size_t field_size;
-};
+ /* Enter right process, reset int_status */
+ ts->packet_count++;
-#define __ELANTS_FIELD_SIZE(_field) \
- sizeof(((struct elants_data *)NULL)->_field)
-#define __ELANTS_VERIFY_SIZE(_field) \
- (BUILD_BUG_ON_ZERO(__ELANTS_FIELD_SIZE(_field) > 2) + \
- __ELANTS_FIELD_SIZE(_field))
-#define ELANTS_VERSION_ATTR(_field) \
- struct elants_version_attribute elants_ver_attr_##_field = { \
- .dattr = __ATTR(_field, S_IRUGO, \
- elants_version_attribute_show, NULL), \
- .field_offset = offsetof(struct elants_data, _field), \
- .field_size = __ELANTS_VERIFY_SIZE(_field), \
+ if (likely(num_fingers != 0)) {
+ ts->td.curvalid = true;
+ ts->touched_sync++;
+ } else {
+ ts->no_touched_sync++;
+ }
+ elan_mt_event(ts, num_fingers, buf);
+ }
+ break;
+ default:
+ ts->header_fail++;
+ dev_warn(&client->dev,
+ "%s: unknown packet type: %*phC\n", __func__, 10, buf);
+ break;
}
-static ssize_t elants_version_attribute_show(struct device *dev,
- struct device_attribute *dattr,
- char *buf)
+ return;
+}
+
+/*
+ * ISR Routine which handler to get finger data
+ * header from TS and resolved it then report it
+ * to linux input layer.
+*/
+static irqreturn_t elan_work_func(int irq, void *work)
{
- struct i2c_client *client = to_i2c_client(dev);
- struct elants_data *ts = i2c_get_clientdata(client);
- struct elants_version_attribute *attr =
- container_of(dattr, struct elants_version_attribute, dattr);
- u8 *field = (u8 *)((char *)ts + attr->field_offset);
- unsigned int fmt_size;
- unsigned int val;
+ struct elants_data *ts = work;
+ struct i2c_client *client = ts->client;
- if (attr->field_size == 1) {
- val = *field;
- fmt_size = 2; /* 2 HEX digits */
- } else {
- val = *(u16 *)field;
- fmt_size = 4; /* 4 HEX digits */
+ u8 buf[MAX_PACKET_LEN] = {0};
+ u8 pos = 0;
+ int rc = 0;
+
+ ENTER_LOG();
+
+ ts->irq_count++;
+
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return IRQ_HANDLED;
+
+ mutex_lock(&ts->i2c_mutex);
+
+ /* Read multi_queue header */
+ rc = elan_get_data(client, (u8 *)buf, ts->rx_size);
+ if (rc < 0)
+ goto fail;
+
+ /* Get multi_queue header info */
+ rc = elan_get_repo_info(ts->client, buf);
+ if (rc < 0 || rc == RET_CMDRSP)
+ goto fail;
+
+ /* check if packet size is valid */
+ if ((ts->packet_size != PACKET_SIZE)) {
+ dev_err(&ts->client->dev, "%s: incorrect packet size = %d\n",
+ __func__, ts->packet_size);
+ goto fail;
}
- return sprintf(buf, "%0*x\n", fmt_size, val);
-}
+ /* Get full finger report data according to header length */
+ rc = elan_get_data(client, (u8 *)buf, ts->rx_size);
+ if (rc < 0)
+ goto fail;
-static ELANTS_VERSION_ATTR(fw_version);
-static ELANTS_VERSION_ATTR(hw_version);
-static ELANTS_VERSION_ATTR(test_version);
-static ELANTS_VERSION_ATTR(solution_version);
-static ELANTS_VERSION_ATTR(bc_version);
-static ELANTS_VERSION_ATTR(iap_version);
+ mutex_unlock(&ts->i2c_mutex);
-static struct attribute *elants_attributes[] = {
- &dev_attr_calibrate.attr,
- &dev_attr_update_fw.attr,
- &dev_attr_iap_mode.attr,
+ /* parsing data and send it out */
+ while (ts->mq_header.report_count--) {
+ if (elan_touch_checksum(ts->client, buf + pos) == 0)
+ elan_report_data(ts->client, buf + pos);
+ pos = pos + ts->packet_size;
+ udelay(10);
+ }
- &elants_ver_attr_fw_version.dattr.attr,
- &elants_ver_attr_hw_version.dattr.attr,
- &elants_ver_attr_test_version.dattr.attr,
- &elants_ver_attr_solution_version.dattr.attr,
- &elants_ver_attr_bc_version.dattr.attr,
- &elants_ver_attr_iap_version.dattr.attr,
- NULL
-};
+ ts->rx_size = QUEUE_HEADER_SIZE;
-static struct attribute_group elants_attribute_group = {
- .attrs = elants_attributes,
-};
+ return IRQ_HANDLED;
-static void elants_i2c_remove_sysfs_group(void *_data)
-{
- struct elants_data *ts = _data;
+fail:
+ mutex_unlock(&ts->i2c_mutex);
+ ts->rx_size = QUEUE_HEADER_SIZE;
- sysfs_remove_group(&ts->client->dev.kobj, &elants_attribute_group);
+ return IRQ_HANDLED;
}
-static int elants_i2c_probe(struct i2c_client *client,
- const struct i2c_device_id *id)
+static int elan_remove(struct i2c_client *client)
{
- union i2c_smbus_data dummy;
- struct elants_data *ts;
- unsigned long irqflags;
- int error;
+ int ret = 0;
+ struct elants_data *ts = i2c_get_clientdata(client);
- if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
- dev_err(&client->dev,
- "%s: i2c check functionality error\n", DEVICE_NAME);
- return -ENXIO;
- }
+ /* remove sysfs */
+ sysfs_remove_group(&client->dev.kobj, &elan_attribute_group);
- /* Make sure there is something at this address */
- if (i2c_smbus_xfer(client->adapter, client->addr, 0,
- I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
- dev_err(&client->dev, "nothing at this address\n");
- return -ENXIO;
- }
+ if (client->irq)
+ free_irq(client->irq, ts);
- ts = devm_kzalloc(&client->dev, sizeof(struct elants_data), GFP_KERNEL);
- if (!ts)
- return -ENOMEM;
+ if (ts->input)
+ input_unregister_device(ts->input);
- mutex_init(&ts->sysfs_mutex);
- init_completion(&ts->cmd_done);
+ if (&ts->i2c_mutex)
+ mutex_destroy(&ts->i2c_mutex);
- ts->client = client;
- i2c_set_clientdata(client, ts);
+ kfree(ts);
- error = elants_i2c_initialize(ts);
- if (error) {
- dev_err(&client->dev, "failed to initialize: %d\n", error);
- return error;
+ return ret;
+}
+
+static int elan_input_dev_create(struct elants_data *ts)
+{
+ int err = 0;
+ struct i2c_client *client = ts->client;
+
+ /* Clear the existing one if it exists */
+ if (ts->input) {
+ input_unregister_device(ts->input);
+ ts->input = NULL;
}
- ts->input = devm_input_allocate_device(&client->dev);
- if (!ts->input) {
+ ts->input = input_allocate_device();
+ if (ts->input == NULL) {
dev_err(&client->dev, "Failed to allocate input device\n");
return -ENOMEM;
}
- ts->input->name = "Elan Touchscreen";
+ ts->input->name = "Elan-Touchscreen";
ts->input->id.bustype = BUS_I2C;
+ ts->input->dev.parent = &ts->client->dev;
__set_bit(BTN_TOUCH, ts->input->keybit);
__set_bit(EV_ABS, ts->input->evbit);
@@ -1110,12 +1571,11 @@ static int elants_i2c_probe(struct i2c_client *client,
input_abs_set_res(ts->input, ABS_Y, ts->y_res);
/* Multitouch input params setup */
- error = input_mt_init_slots(ts->input, MAX_CONTACT_NUM,
- INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
- if (error) {
+ err = input_mt_init_slots(ts->input, MAX_CONTACT_NUM, INPUT_MT_DIRECT);
+ if (err) {
dev_err(&client->dev,
- "failed to initialize MT slots: %d\n", error);
- return error;
+ "allocate memory for MT slots failed, %d\n", err);
+ goto err_free_device;
}
input_set_abs_params(ts->input, ABS_MT_POSITION_X, 0, ts->x_max, 0, 0);
@@ -1127,12 +1587,92 @@ static int elants_i2c_probe(struct i2c_client *client,
input_set_drvdata(ts->input, ts);
- error = input_register_device(ts->input);
- if (error) {
- dev_err(&client->dev,
- "unable to register input device: %d\n", error);
- return error;
+ err = input_register_device(ts->input);
+ if (err) {
+ dev_err(&client->dev, "unable to register input device\n");
+ goto err_free_device;
+ }
+
+ return 0;
+
+err_free_device:
+ input_free_device(ts->input);
+ ts->input = NULL;
+ return err;
+}
+
+/*
+ * Setup for Elan TS and get necessary information.
+ * -To reset Elan TS module
+ * -To receive hello packet
+ * -To get TS resolution
+ */
+static int elan_initialize(struct i2c_client *client)
+{
+ struct elants_data *ts = i2c_get_clientdata(client);
+ int rc = 0, retry_cnt = 0;
+
+ ENTER_LOG();
+ INIT_COMPLETION(ts->cmd_done);
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_sw_reset(client);
+ if (rc < 0)
+ dev_err(&client->dev, "Software reset failed\n");
+ else
+ break;
}
+ ts->rx_size = QUEUE_HEADER_SIZE;
+
+ rc = __hello_packet_handler(client);
+ if (rc < 0)
+ dev_err(&client->dev, "hello packet error\n");
+
+ rc = __fw_id_packet_handler(client);
+ if (rc < 0) {
+ dev_err(&client->dev, "firmware id checking error rc=%d\n", rc);
+
+ if (rc == -EINVAL) {
+ set_bit(LOCK_FW_UPDATE, &ts->flags);
+ ts->iap_mode = IAP_MODE_ENABLE;
+ }
+ }
+
+ rc = __fw_version_packet_handler(client);
+ if (rc < 0) {
+ dev_err(&client->dev, "firmware version checking error rc=%d\n",
+ rc);
+
+ if (rc == -EINVAL) {
+ set_bit(LOCK_FW_UPDATE, &ts->flags);
+ ts->iap_mode = IAP_MODE_ENABLE;
+ }
+ }
+
+ rc = __test_version_packet_handler(client);
+ if (rc < 0)
+ dev_err(&client->dev, "test version error\n");
+
+ rc = __bc_version_packet_handler(client);
+ if (rc < 0)
+ dev_err(&client->dev, "TS error getting BC version\n");
+
+ rc = __ts_info_handler(client);
+ if (rc < 0)
+ dev_err(&client->dev, "TS information checking error\n");
+
+ return 0;
+}
+
+/*
+ * Perform real probe for our I2C device and if successful configure
+ * it up as an input device. If not then clean up and simply return.
+ */
+static void elan_initialize_async(void *data, async_cookie_t cookie)
+{
+ struct elants_data *ts = data;
+ struct i2c_client *client = ts->client;
+ unsigned long irqflags;
+ int err = 0;
/*
* Systems using device tree should set up interrupt via DTS,
@@ -1140,15 +1680,70 @@ static int elants_i2c_probe(struct i2c_client *client,
*/
irqflags = client->dev.of_node ? 0 : IRQF_TRIGGER_FALLING;
- error = devm_request_threaded_irq(&client->dev, client->irq,
- NULL, elants_i2c_irq,
- irqflags | IRQF_ONESHOT,
- client->name, ts);
- if (error) {
+ err = request_threaded_irq(client->irq, NULL,
+ elan_work_func,
+ irqflags | IRQF_ONESHOT,
+ client->name, ts);
+ if (err) {
dev_err(&client->dev, "Failed to register interrupt\n");
- return error;
+ goto err_release;
+ }
+
+ err = elan_initialize(client);
+ if (err < 0)
+ dev_err(&client->dev, "probe failed! unbind device.\n");
+
+ err = elan_input_dev_create(ts);
+ if (err) {
+ dev_err(&client->dev, "%s crated failed, %d\n", __func__, err);
+ goto err_release;
+ }
+
+ return;
+
+err_release:
+ mutex_unlock(&ts->i2c_mutex);
+ elan_remove(client);
+ return;
+}
+
+/*
+ * Perform setup and probe for our I2C device and if successful configure
+ * it up as an input device. If not then clean up and return an error
+ * code.
+ */
+static int elan_probe(struct i2c_client *client, const struct i2c_device_id *id)
+{
+ union i2c_smbus_data dummy;
+ struct elants_data *ts;
+
+ if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
+ dev_err(&client->dev,
+ "%s: i2c check functionality error\n", DEVICE_NAME);
+ return -ENODEV;
+ }
+
+ /* Make sure there is something at this address */
+ if (i2c_smbus_xfer(client->adapter, client->addr, 0,
+ I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) {
+ dev_err(&client->dev, "nothing at this address\n");
+ return -ENODEV;
}
+ ts = kzalloc(sizeof(struct elants_data), GFP_KERNEL);
+ if (!ts)
+ return -ENOMEM;
+
+ mutex_init(&ts->i2c_mutex);
+ mutex_init(&ts->sysfs_mutex);
+ init_completion(&ts->cmd_done);
+
+ ts->client = client;
+ i2c_set_clientdata(client, ts);
+
+ /* Says HELLO to touch device */
+ async_schedule(elan_initialize_async, ts);
+
/*
* Systems using device tree should set up wakeup via DTS,
* the rest will configure device as wakeup source by default.
@@ -1156,89 +1751,90 @@ static int elants_i2c_probe(struct i2c_client *client,
if (!client->dev.of_node)
device_init_wakeup(&client->dev, true);
- error = sysfs_create_group(&client->dev.kobj, &elants_attribute_group);
- if (error) {
- dev_err(&client->dev, "failed to create sysfs attributes: %d\n",
- error);
- return error;
- }
-
- error = devm_add_action(&client->dev,
- elants_i2c_remove_sysfs_group, ts);
- if (error) {
- elants_i2c_remove_sysfs_group(ts);
- dev_err(&client->dev,
- "Failed to add sysfs cleanup action: %d\n",
- error);
- return error;
- }
+ /* register sysfs */
+ if (sysfs_create_group(&client->dev.kobj, &elan_attribute_group))
+ dev_err(&client->dev, "sysfs create group error\n");
return 0;
}
-static int __maybe_unused elants_i2c_suspend(struct device *dev)
+#ifdef CONFIG_PM_SLEEP
+static int elan_suspend(struct device *dev)
{
struct i2c_client *client = to_i2c_client(dev);
struct elants_data *ts = i2c_get_clientdata(client);
- const u8 set_sleep_cmd[] = { 0x54, 0x50, 0x00, 0x01 };
- int retry_cnt;
- int error;
+ const u8 set_sleep_cmd[] = {0x54, 0x50, 0x00, 0x01};
+ int rc = 0, retry_cnt;
+ ENTER_LOG();
/* Command not support in IAP recovery mode */
- if (ts->iap_mode != ELAN_IAP_OPERATIONAL)
- return -EBUSY;
-
- disable_irq(client->irq);
-
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_send(client, set_sleep_cmd,
- sizeof(set_sleep_cmd));
- if (!error)
- break;
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
- dev_err(&client->dev, "suspend command failed: %d\n", error);
+ mutex_lock(&ts->i2c_mutex);
+ if (!device_may_wakeup(dev)) {
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_set_data(client, set_sleep_cmd,
+ sizeof(set_sleep_cmd));
+ if (rc < 0)
+ dev_err(&client->dev, "suspend command failed!\n");
+ else
+ break;
+ }
+ } else {
+ ts->wake_irq_enabled = (enable_irq_wake(client->irq) == 0);
}
- if (device_may_wakeup(dev))
- ts->wake_irq_enabled = (enable_irq_wake(client->irq) == 0);
+ disable_irq(client->irq);
+
+ mutex_unlock(&ts->i2c_mutex);
return 0;
}
-static int __maybe_unused elants_i2c_resume(struct device *dev)
+static int elan_resume(struct device *dev)
{
struct i2c_client *client = to_i2c_client(dev);
struct elants_data *ts = i2c_get_clientdata(client);
- const u8 set_active_cmd[] = { 0x54, 0x58, 0x00, 0x01 };
- int retry_cnt;
- int error;
+ const u8 set_active_cmd[] = {0x54, 0x58, 0x00, 0x01};
+ int rc = 0, retry_cnt;
- if (device_may_wakeup(dev) && ts->wake_irq_enabled)
- disable_irq_wake(client->irq);
+ ENTER_LOG();
- for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
- error = elants_i2c_send(client, set_active_cmd,
- sizeof(set_active_cmd));
- if (!error)
- break;
+ /* Command not support in IAP recovery mode */
+ if (test_bit(LOCK_FW_UPDATE, &ts->flags))
+ return 0;
- dev_err(&client->dev, "resume command failed: %d\n", error);
+ mutex_lock(&ts->i2c_mutex);
+
+ if (device_may_wakeup(dev) && ts->wake_irq_enabled) {
+ disable_irq_wake(client->irq);
+ } else {
+ for (retry_cnt = 0; retry_cnt < MAX_RETRIES; retry_cnt++) {
+ rc = elan_set_data(client, set_active_cmd,
+ sizeof(set_active_cmd));
+ if (rc < 0)
+ dev_err(&client->dev, "resume command failed!\n");
+ else
+ break;
+ }
}
- ts->state = ELAN_STATE_NORMAL;
enable_irq(client->irq);
+ mutex_unlock(&ts->i2c_mutex);
+
return 0;
}
+#endif
-static SIMPLE_DEV_PM_OPS(elants_i2c_pm_ops,
- elants_i2c_suspend, elants_i2c_resume);
+static SIMPLE_DEV_PM_OPS(elan_pm_ops, elan_suspend, elan_resume);
-static const struct i2c_device_id elants_i2c_id[] = {
+static const struct i2c_device_id elan_ts_id[] = {
{ DEVICE_NAME, 0 },
{ }
};
-MODULE_DEVICE_TABLE(i2c, elants_i2c_id);
+MODULE_DEVICE_TABLE(i2c, elan_ts_id);
#ifdef CONFIG_ACPI
static const struct acpi_device_id elants_acpi_id[] = {
@@ -1249,25 +1845,26 @@ MODULE_DEVICE_TABLE(acpi, elants_acpi_id);
#endif
#ifdef CONFIG_OF
-static const struct of_device_id elants_of_match[] = {
- { .compatible = "elan,ekth3500" },
+static const struct of_device_id elan_of_match[] = {
+ { .compatible = "elan,i2c_touchscreen" },
{ /* sentinel */ }
};
-MODULE_DEVICE_TABLE(of, elants_of_match);
+MODULE_DEVICE_TABLE(of, elan_of_match);
#endif
-static struct i2c_driver elants_i2c_driver = {
- .probe = elants_i2c_probe,
- .id_table = elants_i2c_id,
+static struct i2c_driver elan_ts_driver = {
+ .probe = elan_probe,
+ .remove = elan_remove,
+ .id_table = elan_ts_id,
.driver = {
.name = DEVICE_NAME,
.owner = THIS_MODULE,
- .pm = &elants_i2c_pm_ops,
+ .pm = &elan_pm_ops,
.acpi_match_table = ACPI_PTR(elants_acpi_id),
- .of_match_table = of_match_ptr(elants_of_match),
+ .of_match_table = of_match_ptr(elan_of_match),
},
};
-module_i2c_driver(elants_i2c_driver);
+module_i2c_driver(elan_ts_driver);
MODULE_AUTHOR("Scott Liu <scott.liu@emc.com.tw>");
MODULE_DESCRIPTION("Elan I2c Touchscreen driver");
From: "james.chen" <james.chen@emc.com.tw> This patch refer 3.10 driver code to solve firmware upgrade issue(Change 266813) and enable noise-immunity(Change 243875). BUG=chrome-os-partner:39373 TEST=Test Elan Touch Screen on cyan project without problems. --- drivers/input/touchscreen/elants_i2c.c | 2287 ++++++++++++++++++++------------ 1 file changed, 1442 insertions(+), 845 deletions(-)