1 // SPDX-License-Identifier: GPL-2.0-only
3 * Elan I2C/SMBus Touchpad driver
5 * Copyright (c) 2013 ELAN Microelectronics Corp.
7 * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw>
8 * Author: KT Liao <kt.liao@emc.com.tw>
11 * Based on cyapa driver:
12 * copyright (c) 2011-2012 Cypress Semiconductor, Inc.
13 * copyright (c) 2011-2012 Google, Inc.
15 * Trademarks are the property of their respective owners.
18 #include <linux/acpi.h>
19 #include <linux/delay.h>
20 #include <linux/device.h>
21 #include <linux/firmware.h>
22 #include <linux/i2c.h>
23 #include <linux/init.h>
24 #include <linux/input/mt.h>
25 #include <linux/interrupt.h>
26 #include <linux/irq.h>
27 #include <linux/module.h>
28 #include <linux/slab.h>
29 #include <linux/kernel.h>
30 #include <linux/sched.h>
31 #include <linux/input.h>
32 #include <linux/uaccess.h>
33 #include <linux/jiffies.h>
34 #include <linux/completion.h>
36 #include <linux/property.h>
37 #include <linux/regulator/consumer.h>
38 #include <asm/unaligned.h>
42 #define DRIVER_NAME "elan_i2c"
43 #define ELAN_VENDOR_ID 0x04f3
44 #define ETP_MAX_PRESSURE 255
45 #define ETP_FWIDTH_REDUCE 90
46 #define ETP_FINGER_WIDTH 15
47 #define ETP_RETRY_COUNT 3
49 /* quirks to control the device */
50 #define ETP_QUIRK_QUICK_WAKEUP BIT(0)
52 /* The main device structure */
54 struct i2c_client *client;
55 struct input_dev *input;
56 struct input_dev *tp_input; /* trackpoint input node */
57 struct regulator *vcc;
59 const struct elan_transport_ops *ops;
62 struct completion fw_completion;
65 struct mutex sysfs_mutex;
80 unsigned int report_features;
81 unsigned int report_len;
82 int pressure_adjustment;
85 u16 fw_validpage_count;
87 u32 fw_signature_address;
97 u32 quirks; /* Various quirks */
100 static u32 elan_i2c_lookup_quirks(u16 ic_type, u16 product_id)
102 static const struct {
106 } elan_i2c_quirks[] = {
107 { 0x0D, ETP_PRODUCT_ID_DELBIN, ETP_QUIRK_QUICK_WAKEUP },
108 { 0x0D, ETP_PRODUCT_ID_WHITEBOX, ETP_QUIRK_QUICK_WAKEUP },
109 { 0x10, ETP_PRODUCT_ID_VOXEL, ETP_QUIRK_QUICK_WAKEUP },
110 { 0x14, ETP_PRODUCT_ID_MAGPIE, ETP_QUIRK_QUICK_WAKEUP },
111 { 0x14, ETP_PRODUCT_ID_BOBBA, ETP_QUIRK_QUICK_WAKEUP },
116 for (i = 0; i < ARRAY_SIZE(elan_i2c_quirks); i++) {
117 if (elan_i2c_quirks[i].ic_type == ic_type &&
118 elan_i2c_quirks[i].product_id == product_id) {
119 quirks = elan_i2c_quirks[i].quirks;
123 if (ic_type >= 0x0D && product_id >= 0x123)
124 quirks |= ETP_QUIRK_QUICK_WAKEUP;
129 static int elan_get_fwinfo(u16 ic_type, u8 iap_version, u16 *validpage_count,
130 u32 *signature_address, u16 *page_size)
136 *validpage_count = 512;
144 *validpage_count = 768;
147 *validpage_count = 896;
150 *validpage_count = 640;
153 *validpage_count = 1024;
156 *validpage_count = 1280;
159 *validpage_count = 2048;
163 *validpage_count = 1024;
166 /* unknown ic type clear value */
167 *validpage_count = 0;
168 *signature_address = 0;
174 (*validpage_count * ETP_FW_PAGE_SIZE) - ETP_FW_SIGNATURE_SIZE;
176 if ((ic_type == 0x14 || ic_type == 0x15) && iap_version >= 2) {
177 *validpage_count /= 8;
178 *page_size = ETP_FW_PAGE_SIZE_512;
179 } else if (ic_type >= 0x0D && iap_version >= 1) {
180 *validpage_count /= 2;
181 *page_size = ETP_FW_PAGE_SIZE_128;
183 *page_size = ETP_FW_PAGE_SIZE;
189 static int elan_enable_power(struct elan_tp_data *data)
191 int repeat = ETP_RETRY_COUNT;
194 error = regulator_enable(data->vcc);
196 dev_err(&data->client->dev,
197 "failed to enable regulator: %d\n", error);
202 error = data->ops->power_control(data->client, true);
207 } while (--repeat > 0);
209 dev_err(&data->client->dev, "failed to enable power: %d\n", error);
213 static int elan_disable_power(struct elan_tp_data *data)
215 int repeat = ETP_RETRY_COUNT;
219 error = data->ops->power_control(data->client, false);
221 error = regulator_disable(data->vcc);
223 dev_err(&data->client->dev,
224 "failed to disable regulator: %d\n",
226 /* Attempt to power the chip back up */
227 data->ops->power_control(data->client, true);
235 } while (--repeat > 0);
237 dev_err(&data->client->dev, "failed to disable power: %d\n", error);
241 static int elan_sleep(struct elan_tp_data *data)
243 int repeat = ETP_RETRY_COUNT;
247 error = data->ops->sleep_control(data->client, true);
252 } while (--repeat > 0);
257 static int elan_query_product(struct elan_tp_data *data)
261 error = data->ops->get_product_id(data->client, &data->product_id);
265 error = data->ops->get_pattern(data->client, &data->pattern);
269 error = data->ops->get_sm_version(data->client, data->pattern,
270 &data->ic_type, &data->sm_version,
278 static int elan_check_ASUS_special_fw(struct elan_tp_data *data)
280 if (data->ic_type == 0x0E) {
281 switch (data->product_id) {
287 } else if (data->ic_type == 0x08 && data->product_id == 0x26) {
288 /* ASUS EeeBook X205TA */
295 static int __elan_initialize(struct elan_tp_data *data, bool skip_reset)
297 struct i2c_client *client = data->client;
298 bool woken_up = false;
302 error = data->ops->initialize(client);
304 dev_err(&client->dev, "device initialize failed: %d\n", error);
309 error = elan_query_product(data);
314 * Some ASUS devices were shipped with firmware that requires
315 * touchpads to be woken up first, before attempting to switch
316 * them into absolute reporting mode.
318 if (elan_check_ASUS_special_fw(data)) {
319 error = data->ops->sleep_control(client, false);
321 dev_err(&client->dev,
322 "failed to wake device up: %d\n", error);
330 data->mode |= ETP_ENABLE_ABS;
331 error = data->ops->set_mode(client, data->mode);
333 dev_err(&client->dev,
334 "failed to switch to absolute mode: %d\n", error);
339 error = data->ops->sleep_control(client, false);
341 dev_err(&client->dev,
342 "failed to wake device up: %d\n", error);
350 static int elan_initialize(struct elan_tp_data *data, bool skip_reset)
352 int repeat = ETP_RETRY_COUNT;
356 error = __elan_initialize(data, skip_reset);
362 } while (--repeat > 0);
367 static int elan_query_device_info(struct elan_tp_data *data)
371 error = data->ops->get_version(data->client, data->pattern, false,
376 error = data->ops->get_checksum(data->client, false,
381 error = data->ops->get_version(data->client, data->pattern,
382 true, &data->iap_version);
386 error = data->ops->get_pressure_adjustment(data->client,
387 &data->pressure_adjustment);
391 error = data->ops->get_report_features(data->client, data->pattern,
392 &data->report_features,
397 data->quirks = elan_i2c_lookup_quirks(data->ic_type, data->product_id);
399 error = elan_get_fwinfo(data->ic_type, data->iap_version,
400 &data->fw_validpage_count,
401 &data->fw_signature_address,
402 &data->fw_page_size);
404 dev_warn(&data->client->dev,
405 "unexpected iap version %#04x (ic type: %#04x), firmware update will not work\n",
406 data->iap_version, data->ic_type);
411 static unsigned int elan_convert_resolution(u8 val, u8 pattern)
415 * (value from firmware) * 10 + 790 = dpi
417 * ((value from firmware) + 3) * 100 = dpi
419 int res = pattern <= 0x01 ?
420 (int)(char)val * 10 + 790 : ((int)(char)val + 3) * 100;
422 * We also have to convert dpi to dots/mm (*10/254 to avoid floating
425 return res * 10 / 254;
428 static int elan_query_device_parameters(struct elan_tp_data *data)
430 struct i2c_client *client = data->client;
431 unsigned int x_traces, y_traces;
433 u8 hw_x_res, hw_y_res;
436 if (device_property_read_u32(&client->dev,
437 "touchscreen-size-x", &data->max_x) ||
438 device_property_read_u32(&client->dev,
439 "touchscreen-size-y", &data->max_y)) {
440 error = data->ops->get_max(data->client,
446 /* size is the maximum + 1 */
451 if (device_property_read_u32(&client->dev,
454 device_property_read_u32(&client->dev,
457 error = data->ops->get_num_traces(data->client,
458 &x_traces, &y_traces);
462 data->width_x = data->max_x / x_traces;
463 data->width_y = data->max_y / y_traces;
465 if (device_property_read_u32(&client->dev,
466 "touchscreen-x-mm", &x_mm) ||
467 device_property_read_u32(&client->dev,
468 "touchscreen-y-mm", &y_mm)) {
469 error = data->ops->get_resolution(data->client,
470 &hw_x_res, &hw_y_res);
474 data->x_res = elan_convert_resolution(hw_x_res, data->pattern);
475 data->y_res = elan_convert_resolution(hw_y_res, data->pattern);
477 data->x_res = (data->max_x + 1) / x_mm;
478 data->y_res = (data->max_y + 1) / y_mm;
481 if (device_property_read_bool(&client->dev, "elan,clickpad"))
484 if (device_property_read_bool(&client->dev, "elan,middle-button"))
485 data->middle_button = true;
491 **********************************************************
492 * IAP firmware updater related routines
493 **********************************************************
495 static int elan_write_fw_block(struct elan_tp_data *data, u16 page_size,
496 const u8 *page, u16 checksum, int idx)
498 int retry = ETP_RETRY_COUNT;
502 error = data->ops->write_fw_block(data->client, page_size,
503 page, checksum, idx);
507 dev_dbg(&data->client->dev,
508 "IAP retrying page %d (error: %d)\n", idx, error);
509 } while (--retry > 0);
514 static int __elan_update_firmware(struct elan_tp_data *data,
515 const struct firmware *fw)
517 struct i2c_client *client = data->client;
518 struct device *dev = &client->dev;
523 u16 sw_checksum = 0, fw_checksum = 0;
525 error = data->ops->prepare_fw_update(client, data->ic_type,
531 iap_start_addr = get_unaligned_le16(&fw->data[ETP_IAP_START_ADDR * 2]);
533 boot_page_count = (iap_start_addr * 2) / data->fw_page_size;
534 for (i = boot_page_count; i < data->fw_validpage_count; i++) {
536 const u8 *page = &fw->data[i * data->fw_page_size];
538 for (j = 0; j < data->fw_page_size; j += 2)
539 checksum += ((page[j + 1] << 8) | page[j]);
541 error = elan_write_fw_block(data, data->fw_page_size,
544 dev_err(dev, "write page %d fail: %d\n", i, error);
548 sw_checksum += checksum;
551 /* Wait WDT reset and power on reset */
554 error = data->ops->finish_fw_update(client, &data->fw_completion);
558 error = data->ops->get_checksum(client, true, &fw_checksum);
562 if (sw_checksum != fw_checksum) {
563 dev_err(dev, "checksum diff sw=[%04X], fw=[%04X]\n",
564 sw_checksum, fw_checksum);
571 static int elan_update_firmware(struct elan_tp_data *data,
572 const struct firmware *fw)
574 struct i2c_client *client = data->client;
577 dev_dbg(&client->dev, "Starting firmware update....\n");
579 disable_irq(client->irq);
580 data->in_fw_update = true;
582 retval = __elan_update_firmware(data, fw);
584 dev_err(&client->dev, "firmware update failed: %d\n", retval);
585 data->ops->iap_reset(client);
587 /* Reinitialize TP after fw is updated */
588 elan_initialize(data, false);
589 elan_query_device_info(data);
592 data->in_fw_update = false;
593 enable_irq(client->irq);
599 *******************************************************************
601 *******************************************************************
603 static ssize_t elan_sysfs_read_fw_checksum(struct device *dev,
604 struct device_attribute *attr,
607 struct i2c_client *client = to_i2c_client(dev);
608 struct elan_tp_data *data = i2c_get_clientdata(client);
610 return sprintf(buf, "0x%04x\n", data->fw_checksum);
613 static ssize_t elan_sysfs_read_product_id(struct device *dev,
614 struct device_attribute *attr,
617 struct i2c_client *client = to_i2c_client(dev);
618 struct elan_tp_data *data = i2c_get_clientdata(client);
620 return sprintf(buf, ETP_PRODUCT_ID_FORMAT_STRING "\n",
624 static ssize_t elan_sysfs_read_fw_ver(struct device *dev,
625 struct device_attribute *attr,
628 struct i2c_client *client = to_i2c_client(dev);
629 struct elan_tp_data *data = i2c_get_clientdata(client);
631 return sprintf(buf, "%d.0\n", data->fw_version);
634 static ssize_t elan_sysfs_read_sm_ver(struct device *dev,
635 struct device_attribute *attr,
638 struct i2c_client *client = to_i2c_client(dev);
639 struct elan_tp_data *data = i2c_get_clientdata(client);
641 return sprintf(buf, "%d.0\n", data->sm_version);
644 static ssize_t elan_sysfs_read_iap_ver(struct device *dev,
645 struct device_attribute *attr,
648 struct i2c_client *client = to_i2c_client(dev);
649 struct elan_tp_data *data = i2c_get_clientdata(client);
651 return sprintf(buf, "%d.0\n", data->iap_version);
654 static ssize_t elan_sysfs_update_fw(struct device *dev,
655 struct device_attribute *attr,
656 const char *buf, size_t count)
658 struct elan_tp_data *data = dev_get_drvdata(dev);
659 const struct firmware *fw;
662 const u8 *fw_signature;
663 static const u8 signature[] = {0xAA, 0x55, 0xCC, 0x33, 0xFF, 0xFF};
665 if (data->fw_validpage_count == 0)
668 /* Look for a firmware with the product id appended. */
669 fw_name = kasprintf(GFP_KERNEL, ETP_FW_NAME, data->product_id);
671 dev_err(dev, "failed to allocate memory for firmware name\n");
675 dev_info(dev, "requesting fw '%s'\n", fw_name);
676 error = request_firmware(&fw, fw_name, dev);
679 dev_err(dev, "failed to request firmware: %d\n", error);
683 /* Firmware file must match signature data */
684 fw_signature = &fw->data[data->fw_signature_address];
685 if (memcmp(fw_signature, signature, sizeof(signature)) != 0) {
686 dev_err(dev, "signature mismatch (expected %*ph, got %*ph)\n",
687 (int)sizeof(signature), signature,
688 (int)sizeof(signature), fw_signature);
693 error = mutex_lock_interruptible(&data->sysfs_mutex);
697 error = elan_update_firmware(data, fw);
699 mutex_unlock(&data->sysfs_mutex);
702 release_firmware(fw);
703 return error ?: count;
706 static ssize_t calibrate_store(struct device *dev,
707 struct device_attribute *attr,
708 const char *buf, size_t count)
710 struct i2c_client *client = to_i2c_client(dev);
711 struct elan_tp_data *data = i2c_get_clientdata(client);
715 u8 val[ETP_CALIBRATE_MAX_LEN];
717 retval = mutex_lock_interruptible(&data->sysfs_mutex);
721 disable_irq(client->irq);
723 data->mode |= ETP_ENABLE_CALIBRATE;
724 retval = data->ops->set_mode(client, data->mode);
726 dev_err(dev, "failed to enable calibration mode: %d\n",
731 retval = data->ops->calibrate(client);
733 dev_err(dev, "failed to start calibration: %d\n",
735 goto out_disable_calibrate;
740 /* Wait 250ms before checking if calibration has completed. */
743 retval = data->ops->calibrate_result(client, val);
745 dev_err(dev, "failed to check calibration result: %d\n",
747 else if (val[0] == 0)
748 break; /* calibration done */
753 dev_err(dev, "failed to calibrate. Timeout.\n");
757 out_disable_calibrate:
758 data->mode &= ~ETP_ENABLE_CALIBRATE;
759 error = data->ops->set_mode(data->client, data->mode);
761 dev_err(dev, "failed to disable calibration mode: %d\n",
767 enable_irq(client->irq);
768 mutex_unlock(&data->sysfs_mutex);
769 return retval ?: count;
772 static ssize_t elan_sysfs_read_mode(struct device *dev,
773 struct device_attribute *attr,
776 struct i2c_client *client = to_i2c_client(dev);
777 struct elan_tp_data *data = i2c_get_clientdata(client);
781 error = mutex_lock_interruptible(&data->sysfs_mutex);
785 error = data->ops->iap_get_mode(data->client, &mode);
787 mutex_unlock(&data->sysfs_mutex);
792 return sprintf(buf, "%d\n", (int)mode);
795 static DEVICE_ATTR(product_id, S_IRUGO, elan_sysfs_read_product_id, NULL);
796 static DEVICE_ATTR(firmware_version, S_IRUGO, elan_sysfs_read_fw_ver, NULL);
797 static DEVICE_ATTR(sample_version, S_IRUGO, elan_sysfs_read_sm_ver, NULL);
798 static DEVICE_ATTR(iap_version, S_IRUGO, elan_sysfs_read_iap_ver, NULL);
799 static DEVICE_ATTR(fw_checksum, S_IRUGO, elan_sysfs_read_fw_checksum, NULL);
800 static DEVICE_ATTR(mode, S_IRUGO, elan_sysfs_read_mode, NULL);
801 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, elan_sysfs_update_fw);
803 static DEVICE_ATTR_WO(calibrate);
805 static struct attribute *elan_sysfs_entries[] = {
806 &dev_attr_product_id.attr,
807 &dev_attr_firmware_version.attr,
808 &dev_attr_sample_version.attr,
809 &dev_attr_iap_version.attr,
810 &dev_attr_fw_checksum.attr,
811 &dev_attr_calibrate.attr,
813 &dev_attr_update_fw.attr,
817 static const struct attribute_group elan_sysfs_group = {
818 .attrs = elan_sysfs_entries,
821 static ssize_t acquire_store(struct device *dev, struct device_attribute *attr,
822 const char *buf, size_t count)
824 struct i2c_client *client = to_i2c_client(dev);
825 struct elan_tp_data *data = i2c_get_clientdata(client);
829 retval = mutex_lock_interruptible(&data->sysfs_mutex);
833 disable_irq(client->irq);
835 data->baseline_ready = false;
837 data->mode |= ETP_ENABLE_CALIBRATE;
838 retval = data->ops->set_mode(data->client, data->mode);
840 dev_err(dev, "Failed to enable calibration mode to get baseline: %d\n",
847 retval = data->ops->get_baseline_data(data->client, true,
848 &data->max_baseline);
850 dev_err(dev, "Failed to read max baseline form device: %d\n",
852 goto out_disable_calibrate;
855 retval = data->ops->get_baseline_data(data->client, false,
856 &data->min_baseline);
858 dev_err(dev, "Failed to read min baseline form device: %d\n",
860 goto out_disable_calibrate;
863 data->baseline_ready = true;
865 out_disable_calibrate:
866 data->mode &= ~ETP_ENABLE_CALIBRATE;
867 error = data->ops->set_mode(data->client, data->mode);
869 dev_err(dev, "Failed to disable calibration mode after acquiring baseline: %d\n",
875 enable_irq(client->irq);
876 mutex_unlock(&data->sysfs_mutex);
877 return retval ?: count;
880 static ssize_t min_show(struct device *dev,
881 struct device_attribute *attr, char *buf)
883 struct i2c_client *client = to_i2c_client(dev);
884 struct elan_tp_data *data = i2c_get_clientdata(client);
887 retval = mutex_lock_interruptible(&data->sysfs_mutex);
891 if (!data->baseline_ready) {
896 retval = snprintf(buf, PAGE_SIZE, "%d", data->min_baseline);
899 mutex_unlock(&data->sysfs_mutex);
903 static ssize_t max_show(struct device *dev,
904 struct device_attribute *attr, char *buf)
906 struct i2c_client *client = to_i2c_client(dev);
907 struct elan_tp_data *data = i2c_get_clientdata(client);
910 retval = mutex_lock_interruptible(&data->sysfs_mutex);
914 if (!data->baseline_ready) {
919 retval = snprintf(buf, PAGE_SIZE, "%d", data->max_baseline);
922 mutex_unlock(&data->sysfs_mutex);
927 static DEVICE_ATTR_WO(acquire);
928 static DEVICE_ATTR_RO(min);
929 static DEVICE_ATTR_RO(max);
931 static struct attribute *elan_baseline_sysfs_entries[] = {
932 &dev_attr_acquire.attr,
938 static const struct attribute_group elan_baseline_sysfs_group = {
940 .attrs = elan_baseline_sysfs_entries,
943 static const struct attribute_group *elan_sysfs_groups[] = {
945 &elan_baseline_sysfs_group,
950 ******************************************************************
952 ******************************************************************
954 static void elan_report_contact(struct elan_tp_data *data, int contact_num,
955 bool contact_valid, bool high_precision,
956 u8 *packet, u8 *finger_data)
958 struct input_dev *input = data->input;
959 unsigned int pos_x, pos_y;
960 unsigned int pressure, scaled_pressure;
963 if (high_precision) {
964 pos_x = get_unaligned_be16(&finger_data[0]);
965 pos_y = get_unaligned_be16(&finger_data[2]);
967 pos_x = ((finger_data[0] & 0xf0) << 4) | finger_data[1];
968 pos_y = ((finger_data[0] & 0x0f) << 8) | finger_data[2];
971 if (pos_x > data->max_x || pos_y > data->max_y) {
972 dev_dbg(input->dev.parent,
973 "[%d] x=%d y=%d over max (%d, %d)",
974 contact_num, pos_x, pos_y,
975 data->max_x, data->max_y);
979 pressure = finger_data[4];
980 scaled_pressure = pressure + data->pressure_adjustment;
981 if (scaled_pressure > ETP_MAX_PRESSURE)
982 scaled_pressure = ETP_MAX_PRESSURE;
984 input_mt_slot(input, contact_num);
985 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
986 input_report_abs(input, ABS_MT_POSITION_X, pos_x);
987 input_report_abs(input, ABS_MT_POSITION_Y, data->max_y - pos_y);
988 input_report_abs(input, ABS_MT_PRESSURE, scaled_pressure);
990 if (data->report_features & ETP_FEATURE_REPORT_MK) {
991 unsigned int mk_x, mk_y, area_x, area_y;
992 u8 mk_data = high_precision ?
993 packet[ETP_MK_DATA_OFFSET + contact_num] :
996 mk_x = mk_data & 0x0f;
1000 * To avoid treating large finger as palm, let's reduce
1001 * the width x and y per trace.
1003 area_x = mk_x * (data->width_x - ETP_FWIDTH_REDUCE);
1004 area_y = mk_y * (data->width_y - ETP_FWIDTH_REDUCE);
1006 input_report_abs(input, ABS_TOOL_WIDTH, mk_x);
1007 input_report_abs(input, ABS_MT_TOUCH_MAJOR,
1008 max(area_x, area_y));
1009 input_report_abs(input, ABS_MT_TOUCH_MINOR,
1010 min(area_x, area_y));
1013 input_mt_slot(input, contact_num);
1014 input_mt_report_slot_inactive(input);
1018 static void elan_report_absolute(struct elan_tp_data *data, u8 *packet,
1019 bool high_precision)
1021 struct input_dev *input = data->input;
1022 u8 *finger_data = &packet[ETP_FINGER_DATA_OFFSET];
1024 u8 tp_info = packet[ETP_TOUCH_INFO_OFFSET];
1025 u8 hover_info = packet[ETP_HOVER_INFO_OFFSET];
1026 bool contact_valid, hover_event;
1028 pm_wakeup_event(&data->client->dev, 0);
1030 hover_event = hover_info & BIT(6);
1032 for (i = 0; i < ETP_MAX_FINGERS; i++) {
1033 contact_valid = tp_info & BIT(3 + i);
1034 elan_report_contact(data, i, contact_valid, high_precision,
1035 packet, finger_data);
1037 finger_data += ETP_FINGER_DATA_LEN;
1040 input_report_key(input, BTN_LEFT, tp_info & BIT(0));
1041 input_report_key(input, BTN_MIDDLE, tp_info & BIT(2));
1042 input_report_key(input, BTN_RIGHT, tp_info & BIT(1));
1043 input_report_abs(input, ABS_DISTANCE, hover_event != 0);
1044 input_mt_report_pointer_emulation(input, true);
1048 static void elan_report_trackpoint(struct elan_tp_data *data, u8 *report)
1050 struct input_dev *input = data->tp_input;
1051 u8 *packet = &report[ETP_REPORT_ID_OFFSET + 1];
1054 pm_wakeup_event(&data->client->dev, 0);
1056 if (!data->tp_input) {
1057 dev_warn_once(&data->client->dev,
1058 "received a trackpoint report while no trackpoint device has been created. Please report upstream.\n");
1062 input_report_key(input, BTN_LEFT, packet[0] & 0x01);
1063 input_report_key(input, BTN_RIGHT, packet[0] & 0x02);
1064 input_report_key(input, BTN_MIDDLE, packet[0] & 0x04);
1066 if ((packet[3] & 0x0F) == 0x06) {
1067 x = packet[4] - (int)((packet[1] ^ 0x80) << 1);
1068 y = (int)((packet[2] ^ 0x80) << 1) - packet[5];
1070 input_report_rel(input, REL_X, x);
1071 input_report_rel(input, REL_Y, y);
1077 static irqreturn_t elan_isr(int irq, void *dev_id)
1079 struct elan_tp_data *data = dev_id;
1081 u8 report[ETP_MAX_REPORT_LEN];
1084 * When device is connected to i2c bus, when all IAP page writes
1085 * complete, the driver will receive interrupt and must read
1086 * 0000 to confirm that IAP is finished.
1088 if (data->in_fw_update) {
1089 complete(&data->fw_completion);
1093 error = data->ops->get_report(data->client, report, data->report_len);
1097 switch (report[ETP_REPORT_ID_OFFSET]) {
1099 elan_report_absolute(data, report, false);
1101 case ETP_REPORT_ID2:
1102 elan_report_absolute(data, report, true);
1104 case ETP_TP_REPORT_ID:
1105 case ETP_TP_REPORT_ID2:
1106 elan_report_trackpoint(data, report);
1109 dev_err(&data->client->dev, "invalid report id data (%x)\n",
1110 report[ETP_REPORT_ID_OFFSET]);
1118 ******************************************************************
1119 * Elan initialization functions
1120 ******************************************************************
1123 static int elan_setup_trackpoint_input_device(struct elan_tp_data *data)
1125 struct device *dev = &data->client->dev;
1126 struct input_dev *input;
1128 input = devm_input_allocate_device(dev);
1132 input->name = "Elan TrackPoint";
1133 input->id.bustype = BUS_I2C;
1134 input->id.vendor = ELAN_VENDOR_ID;
1135 input->id.product = data->product_id;
1136 input_set_drvdata(input, data);
1138 input_set_capability(input, EV_REL, REL_X);
1139 input_set_capability(input, EV_REL, REL_Y);
1140 input_set_capability(input, EV_KEY, BTN_LEFT);
1141 input_set_capability(input, EV_KEY, BTN_RIGHT);
1142 input_set_capability(input, EV_KEY, BTN_MIDDLE);
1144 __set_bit(INPUT_PROP_POINTER, input->propbit);
1145 __set_bit(INPUT_PROP_POINTING_STICK, input->propbit);
1147 data->tp_input = input;
1152 static int elan_setup_input_device(struct elan_tp_data *data)
1154 struct device *dev = &data->client->dev;
1155 struct input_dev *input;
1156 unsigned int max_width = max(data->width_x, data->width_y);
1157 unsigned int min_width = min(data->width_x, data->width_y);
1160 input = devm_input_allocate_device(dev);
1164 input->name = "Elan Touchpad";
1165 input->id.bustype = BUS_I2C;
1166 input->id.vendor = ELAN_VENDOR_ID;
1167 input->id.product = data->product_id;
1168 input_set_drvdata(input, data);
1170 error = input_mt_init_slots(input, ETP_MAX_FINGERS,
1171 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
1173 dev_err(dev, "failed to initialize MT slots: %d\n", error);
1177 __set_bit(EV_ABS, input->evbit);
1178 __set_bit(INPUT_PROP_POINTER, input->propbit);
1179 if (data->clickpad) {
1180 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1182 __set_bit(BTN_RIGHT, input->keybit);
1183 if (data->middle_button)
1184 __set_bit(BTN_MIDDLE, input->keybit);
1186 __set_bit(BTN_LEFT, input->keybit);
1188 /* Set up ST parameters */
1189 input_set_abs_params(input, ABS_X, 0, data->max_x, 0, 0);
1190 input_set_abs_params(input, ABS_Y, 0, data->max_y, 0, 0);
1191 input_abs_set_res(input, ABS_X, data->x_res);
1192 input_abs_set_res(input, ABS_Y, data->y_res);
1193 input_set_abs_params(input, ABS_PRESSURE, 0, ETP_MAX_PRESSURE, 0, 0);
1194 if (data->report_features & ETP_FEATURE_REPORT_MK)
1195 input_set_abs_params(input, ABS_TOOL_WIDTH,
1196 0, ETP_FINGER_WIDTH, 0, 0);
1197 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0);
1199 /* And MT parameters */
1200 input_set_abs_params(input, ABS_MT_POSITION_X, 0, data->max_x, 0, 0);
1201 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, data->max_y, 0, 0);
1202 input_abs_set_res(input, ABS_MT_POSITION_X, data->x_res);
1203 input_abs_set_res(input, ABS_MT_POSITION_Y, data->y_res);
1204 input_set_abs_params(input, ABS_MT_PRESSURE, 0,
1205 ETP_MAX_PRESSURE, 0, 0);
1206 if (data->report_features & ETP_FEATURE_REPORT_MK) {
1207 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR,
1208 0, ETP_FINGER_WIDTH * max_width, 0, 0);
1209 input_set_abs_params(input, ABS_MT_TOUCH_MINOR,
1210 0, ETP_FINGER_WIDTH * min_width, 0, 0);
1213 data->input = input;
1218 static void elan_disable_regulator(void *_data)
1220 struct elan_tp_data *data = _data;
1222 regulator_disable(data->vcc);
1225 static int elan_probe(struct i2c_client *client,
1226 const struct i2c_device_id *dev_id)
1228 const struct elan_transport_ops *transport_ops;
1229 struct device *dev = &client->dev;
1230 struct elan_tp_data *data;
1231 unsigned long irqflags;
1234 if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_I2C) &&
1235 i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1236 transport_ops = &elan_i2c_ops;
1237 } else if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) &&
1238 i2c_check_functionality(client->adapter,
1239 I2C_FUNC_SMBUS_BYTE_DATA |
1240 I2C_FUNC_SMBUS_BLOCK_DATA |
1241 I2C_FUNC_SMBUS_I2C_BLOCK)) {
1242 transport_ops = &elan_smbus_ops;
1244 dev_err(dev, "not a supported I2C/SMBus adapter\n");
1248 data = devm_kzalloc(dev, sizeof(struct elan_tp_data), GFP_KERNEL);
1252 i2c_set_clientdata(client, data);
1254 data->ops = transport_ops;
1255 data->client = client;
1256 init_completion(&data->fw_completion);
1257 mutex_init(&data->sysfs_mutex);
1259 data->vcc = devm_regulator_get(dev, "vcc");
1260 if (IS_ERR(data->vcc)) {
1261 error = PTR_ERR(data->vcc);
1262 if (error != -EPROBE_DEFER)
1263 dev_err(dev, "Failed to get 'vcc' regulator: %d\n",
1268 error = regulator_enable(data->vcc);
1270 dev_err(dev, "Failed to enable regulator: %d\n", error);
1274 error = devm_add_action_or_reset(dev, elan_disable_regulator, data);
1276 dev_err(dev, "Failed to add disable regulator action: %d\n",
1281 /* Make sure there is something at this address */
1282 error = i2c_smbus_read_byte(client);
1284 dev_dbg(&client->dev, "nothing at this address: %d\n", error);
1288 /* Initialize the touchpad. */
1289 error = elan_initialize(data, false);
1293 error = elan_query_device_info(data);
1297 error = elan_query_device_parameters(data);
1302 "Elan Touchpad: Module ID: 0x%04x, Firmware: 0x%04x, Sample: 0x%04x, IAP: 0x%04x\n",
1309 "Elan Touchpad Extra Information:\n"
1310 " Max ABS X,Y: %d,%d\n"
1311 " Width X,Y: %d,%d\n"
1312 " Resolution X,Y: %d,%d (dots/mm)\n"
1314 " info pattern: 0x%x\n",
1315 data->max_x, data->max_y,
1316 data->width_x, data->width_y,
1317 data->x_res, data->y_res,
1318 data->ic_type, data->pattern);
1320 /* Set up input device properties based on queried parameters. */
1321 error = elan_setup_input_device(data);
1325 if (device_property_read_bool(&client->dev, "elan,trackpoint")) {
1326 error = elan_setup_trackpoint_input_device(data);
1332 * Platform code (ACPI, DTS) should normally set up interrupt
1333 * for us, but in case it did not let's fall back to using falling
1334 * edge to be compatible with older Chromebooks.
1336 irqflags = irq_get_trigger_type(client->irq);
1338 irqflags = IRQF_TRIGGER_FALLING;
1340 error = devm_request_threaded_irq(dev, client->irq, NULL, elan_isr,
1341 irqflags | IRQF_ONESHOT,
1342 client->name, data);
1344 dev_err(dev, "cannot register irq=%d\n", client->irq);
1348 error = devm_device_add_groups(dev, elan_sysfs_groups);
1350 dev_err(dev, "failed to create sysfs attributes: %d\n", error);
1354 error = input_register_device(data->input);
1356 dev_err(dev, "failed to register input device: %d\n", error);
1360 if (data->tp_input) {
1361 error = input_register_device(data->tp_input);
1363 dev_err(&client->dev,
1364 "failed to register TrackPoint input device: %d\n",
1371 * Systems using device tree should set up wakeup via DTS,
1372 * the rest will configure device as wakeup source by default.
1375 device_init_wakeup(dev, true);
1380 static int __maybe_unused elan_suspend(struct device *dev)
1382 struct i2c_client *client = to_i2c_client(dev);
1383 struct elan_tp_data *data = i2c_get_clientdata(client);
1387 * We are taking the mutex to make sure sysfs operations are
1388 * complete before we attempt to bring the device into low[er]
1391 ret = mutex_lock_interruptible(&data->sysfs_mutex);
1395 disable_irq(client->irq);
1397 if (device_may_wakeup(dev)) {
1398 ret = elan_sleep(data);
1399 /* Enable wake from IRQ */
1400 data->irq_wake = (enable_irq_wake(client->irq) == 0);
1402 ret = elan_disable_power(data);
1405 mutex_unlock(&data->sysfs_mutex);
1409 static int __maybe_unused elan_resume(struct device *dev)
1411 struct i2c_client *client = to_i2c_client(dev);
1412 struct elan_tp_data *data = i2c_get_clientdata(client);
1415 if (device_may_wakeup(dev) && data->irq_wake) {
1416 disable_irq_wake(client->irq);
1417 data->irq_wake = false;
1420 error = elan_enable_power(data);
1422 dev_err(dev, "power up when resuming failed: %d\n", error);
1426 error = elan_initialize(data, data->quirks & ETP_QUIRK_QUICK_WAKEUP);
1428 dev_err(dev, "initialize when resuming failed: %d\n", error);
1431 enable_irq(data->client->irq);
1435 static SIMPLE_DEV_PM_OPS(elan_pm_ops, elan_suspend, elan_resume);
1437 static const struct i2c_device_id elan_id[] = {
1441 MODULE_DEVICE_TABLE(i2c, elan_id);
1444 #include <linux/input/elan-i2c-ids.h>
1445 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
1449 static const struct of_device_id elan_of_match[] = {
1450 { .compatible = "elan,ekth3000" },
1453 MODULE_DEVICE_TABLE(of, elan_of_match);
1456 static struct i2c_driver elan_driver = {
1458 .name = DRIVER_NAME,
1460 .acpi_match_table = ACPI_PTR(elan_acpi_id),
1461 .of_match_table = of_match_ptr(elan_of_match),
1462 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1464 .probe = elan_probe,
1465 .id_table = elan_id,
1468 module_i2c_driver(elan_driver);
1470 MODULE_AUTHOR("Duson Lin <dusonlin@emc.com.tw>");
1471 MODULE_DESCRIPTION("Elan I2C/SMBus Touchpad driver");
1472 MODULE_LICENSE("GPL");