1 // SPDX-License-Identifier: GPL-2.0-only
3 * Elan I2C/SMBus Touchpad driver
5 * Copyright (c) 2013 ELAN Microelectronics Corp.
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/pm_wakeirq.h>
37 #include <linux/property.h>
38 #include <linux/regulator/consumer.h>
39 #include <asm/unaligned.h>
43 #define DRIVER_NAME "elan_i2c"
44 #define ELAN_VENDOR_ID 0x04f3
45 #define ETP_MAX_PRESSURE 255
46 #define ETP_FWIDTH_REDUCE 90
47 #define ETP_FINGER_WIDTH 15
48 #define ETP_RETRY_COUNT 3
50 /* quirks to control the device */
51 #define ETP_QUIRK_QUICK_WAKEUP BIT(0)
53 /* The main device structure */
55 struct i2c_client *client;
56 struct input_dev *input;
57 struct input_dev *tp_input; /* trackpoint input node */
58 struct regulator *vcc;
60 const struct elan_transport_ops *ops;
63 struct completion fw_completion;
66 struct mutex sysfs_mutex;
81 unsigned int report_features;
82 unsigned int report_len;
83 int pressure_adjustment;
86 u16 fw_validpage_count;
88 u32 fw_signature_address;
96 u32 quirks; /* Various quirks */
99 static u32 elan_i2c_lookup_quirks(u16 ic_type, u16 product_id)
101 static const struct {
105 } elan_i2c_quirks[] = {
106 { 0x0D, ETP_PRODUCT_ID_DELBIN, ETP_QUIRK_QUICK_WAKEUP },
107 { 0x0D, ETP_PRODUCT_ID_WHITEBOX, ETP_QUIRK_QUICK_WAKEUP },
108 { 0x10, ETP_PRODUCT_ID_VOXEL, ETP_QUIRK_QUICK_WAKEUP },
109 { 0x14, ETP_PRODUCT_ID_MAGPIE, ETP_QUIRK_QUICK_WAKEUP },
110 { 0x14, ETP_PRODUCT_ID_BOBBA, ETP_QUIRK_QUICK_WAKEUP },
115 for (i = 0; i < ARRAY_SIZE(elan_i2c_quirks); i++) {
116 if (elan_i2c_quirks[i].ic_type == ic_type &&
117 elan_i2c_quirks[i].product_id == product_id) {
118 quirks = elan_i2c_quirks[i].quirks;
122 if (ic_type >= 0x0D && product_id >= 0x123)
123 quirks |= ETP_QUIRK_QUICK_WAKEUP;
128 static int elan_get_fwinfo(u16 ic_type, u8 iap_version, u16 *validpage_count,
129 u32 *signature_address, u16 *page_size)
135 *validpage_count = 512;
143 *validpage_count = 768;
146 *validpage_count = 896;
149 *validpage_count = 640;
152 *validpage_count = 1024;
155 *validpage_count = 1280;
158 *validpage_count = 2048;
162 *validpage_count = 1024;
165 /* unknown ic type clear value */
166 *validpage_count = 0;
167 *signature_address = 0;
173 (*validpage_count * ETP_FW_PAGE_SIZE) - ETP_FW_SIGNATURE_SIZE;
175 if ((ic_type == 0x14 || ic_type == 0x15) && iap_version >= 2) {
176 *validpage_count /= 8;
177 *page_size = ETP_FW_PAGE_SIZE_512;
178 } else if (ic_type >= 0x0D && iap_version >= 1) {
179 *validpage_count /= 2;
180 *page_size = ETP_FW_PAGE_SIZE_128;
182 *page_size = ETP_FW_PAGE_SIZE;
188 static int elan_set_power(struct elan_tp_data *data, bool on)
190 int repeat = ETP_RETRY_COUNT;
194 error = data->ops->power_control(data->client, on);
199 } while (--repeat > 0);
201 dev_err(&data->client->dev, "failed to set power %s: %d\n",
202 on ? "on" : "off", error);
206 static int elan_sleep(struct elan_tp_data *data)
208 int repeat = ETP_RETRY_COUNT;
212 error = data->ops->sleep_control(data->client, true);
217 } while (--repeat > 0);
222 static int elan_query_product(struct elan_tp_data *data)
226 error = data->ops->get_product_id(data->client, &data->product_id);
230 error = data->ops->get_pattern(data->client, &data->pattern);
234 error = data->ops->get_sm_version(data->client, data->pattern,
235 &data->ic_type, &data->sm_version,
243 static int elan_check_ASUS_special_fw(struct elan_tp_data *data)
245 if (data->ic_type == 0x0E) {
246 switch (data->product_id) {
252 } else if (data->ic_type == 0x08 && data->product_id == 0x26) {
253 /* ASUS EeeBook X205TA */
260 static int __elan_initialize(struct elan_tp_data *data, bool skip_reset)
262 struct i2c_client *client = data->client;
263 bool woken_up = false;
267 error = data->ops->initialize(client);
269 dev_err(&client->dev, "device initialize failed: %d\n", error);
274 error = elan_query_product(data);
279 * Some ASUS devices were shipped with firmware that requires
280 * touchpads to be woken up first, before attempting to switch
281 * them into absolute reporting mode.
283 if (elan_check_ASUS_special_fw(data)) {
284 error = data->ops->sleep_control(client, false);
286 dev_err(&client->dev,
287 "failed to wake device up: %d\n", error);
295 data->mode |= ETP_ENABLE_ABS;
296 error = data->ops->set_mode(client, data->mode);
298 dev_err(&client->dev,
299 "failed to switch to absolute mode: %d\n", error);
304 error = data->ops->sleep_control(client, false);
306 dev_err(&client->dev,
307 "failed to wake device up: %d\n", error);
315 static int elan_initialize(struct elan_tp_data *data, bool skip_reset)
317 int repeat = ETP_RETRY_COUNT;
321 error = __elan_initialize(data, skip_reset);
327 } while (--repeat > 0);
332 static int elan_query_device_info(struct elan_tp_data *data)
336 error = data->ops->get_version(data->client, data->pattern, false,
341 error = data->ops->get_checksum(data->client, false,
346 error = data->ops->get_version(data->client, data->pattern,
347 true, &data->iap_version);
351 error = data->ops->get_pressure_adjustment(data->client,
352 &data->pressure_adjustment);
356 error = data->ops->get_report_features(data->client, data->pattern,
357 &data->report_features,
362 data->quirks = elan_i2c_lookup_quirks(data->ic_type, data->product_id);
364 error = elan_get_fwinfo(data->ic_type, data->iap_version,
365 &data->fw_validpage_count,
366 &data->fw_signature_address,
367 &data->fw_page_size);
369 dev_warn(&data->client->dev,
370 "unexpected iap version %#04x (ic type: %#04x), firmware update will not work\n",
371 data->iap_version, data->ic_type);
376 static unsigned int elan_convert_resolution(u8 val, u8 pattern)
380 * (value from firmware) * 10 + 790 = dpi
382 * ((value from firmware) + 3) * 100 = dpi
384 int res = pattern <= 0x01 ?
385 (int)(char)val * 10 + 790 : ((int)(char)val + 3) * 100;
387 * We also have to convert dpi to dots/mm (*10/254 to avoid floating
390 return res * 10 / 254;
393 static int elan_query_device_parameters(struct elan_tp_data *data)
395 struct i2c_client *client = data->client;
396 unsigned int x_traces, y_traces;
398 u8 hw_x_res, hw_y_res;
401 if (device_property_read_u32(&client->dev,
402 "touchscreen-size-x", &data->max_x) ||
403 device_property_read_u32(&client->dev,
404 "touchscreen-size-y", &data->max_y)) {
405 error = data->ops->get_max(data->client,
411 /* size is the maximum + 1 */
416 if (device_property_read_u32(&client->dev,
419 device_property_read_u32(&client->dev,
422 error = data->ops->get_num_traces(data->client,
423 &x_traces, &y_traces);
427 data->width_x = data->max_x / x_traces;
428 data->width_y = data->max_y / y_traces;
430 if (device_property_read_u32(&client->dev,
431 "touchscreen-x-mm", &x_mm) ||
432 device_property_read_u32(&client->dev,
433 "touchscreen-y-mm", &y_mm)) {
434 error = data->ops->get_resolution(data->client,
435 &hw_x_res, &hw_y_res);
439 data->x_res = elan_convert_resolution(hw_x_res, data->pattern);
440 data->y_res = elan_convert_resolution(hw_y_res, data->pattern);
442 data->x_res = (data->max_x + 1) / x_mm;
443 data->y_res = (data->max_y + 1) / y_mm;
446 if (device_property_read_bool(&client->dev, "elan,clickpad"))
449 if (device_property_read_bool(&client->dev, "elan,middle-button"))
450 data->middle_button = true;
456 **********************************************************
457 * IAP firmware updater related routines
458 **********************************************************
460 static int elan_write_fw_block(struct elan_tp_data *data, u16 page_size,
461 const u8 *page, u16 checksum, int idx)
463 int retry = ETP_RETRY_COUNT;
467 error = data->ops->write_fw_block(data->client, page_size,
468 page, checksum, idx);
472 dev_dbg(&data->client->dev,
473 "IAP retrying page %d (error: %d)\n", idx, error);
474 } while (--retry > 0);
479 static int __elan_update_firmware(struct elan_tp_data *data,
480 const struct firmware *fw)
482 struct i2c_client *client = data->client;
483 struct device *dev = &client->dev;
488 u16 sw_checksum = 0, fw_checksum = 0;
490 error = data->ops->prepare_fw_update(client, data->ic_type,
496 iap_start_addr = get_unaligned_le16(&fw->data[ETP_IAP_START_ADDR * 2]);
498 boot_page_count = (iap_start_addr * 2) / data->fw_page_size;
499 for (i = boot_page_count; i < data->fw_validpage_count; i++) {
501 const u8 *page = &fw->data[i * data->fw_page_size];
503 for (j = 0; j < data->fw_page_size; j += 2)
504 checksum += ((page[j + 1] << 8) | page[j]);
506 error = elan_write_fw_block(data, data->fw_page_size,
509 dev_err(dev, "write page %d fail: %d\n", i, error);
513 sw_checksum += checksum;
516 /* Wait WDT reset and power on reset */
519 error = data->ops->finish_fw_update(client, &data->fw_completion);
523 error = data->ops->get_checksum(client, true, &fw_checksum);
527 if (sw_checksum != fw_checksum) {
528 dev_err(dev, "checksum diff sw=[%04X], fw=[%04X]\n",
529 sw_checksum, fw_checksum);
536 static int elan_update_firmware(struct elan_tp_data *data,
537 const struct firmware *fw)
539 struct i2c_client *client = data->client;
542 dev_dbg(&client->dev, "Starting firmware update....\n");
544 disable_irq(client->irq);
545 data->in_fw_update = true;
547 retval = __elan_update_firmware(data, fw);
549 dev_err(&client->dev, "firmware update failed: %d\n", retval);
550 data->ops->iap_reset(client);
552 /* Reinitialize TP after fw is updated */
553 elan_initialize(data, false);
554 elan_query_device_info(data);
557 data->in_fw_update = false;
558 enable_irq(client->irq);
564 *******************************************************************
566 *******************************************************************
568 static ssize_t elan_sysfs_read_fw_checksum(struct device *dev,
569 struct device_attribute *attr,
572 struct i2c_client *client = to_i2c_client(dev);
573 struct elan_tp_data *data = i2c_get_clientdata(client);
575 return sprintf(buf, "0x%04x\n", data->fw_checksum);
578 static ssize_t elan_sysfs_read_product_id(struct device *dev,
579 struct device_attribute *attr,
582 struct i2c_client *client = to_i2c_client(dev);
583 struct elan_tp_data *data = i2c_get_clientdata(client);
585 return sprintf(buf, ETP_PRODUCT_ID_FORMAT_STRING "\n",
589 static ssize_t elan_sysfs_read_fw_ver(struct device *dev,
590 struct device_attribute *attr,
593 struct i2c_client *client = to_i2c_client(dev);
594 struct elan_tp_data *data = i2c_get_clientdata(client);
596 return sprintf(buf, "%d.0\n", data->fw_version);
599 static ssize_t elan_sysfs_read_sm_ver(struct device *dev,
600 struct device_attribute *attr,
603 struct i2c_client *client = to_i2c_client(dev);
604 struct elan_tp_data *data = i2c_get_clientdata(client);
606 return sprintf(buf, "%d.0\n", data->sm_version);
609 static ssize_t elan_sysfs_read_iap_ver(struct device *dev,
610 struct device_attribute *attr,
613 struct i2c_client *client = to_i2c_client(dev);
614 struct elan_tp_data *data = i2c_get_clientdata(client);
616 return sprintf(buf, "%d.0\n", data->iap_version);
619 static ssize_t elan_sysfs_update_fw(struct device *dev,
620 struct device_attribute *attr,
621 const char *buf, size_t count)
623 struct elan_tp_data *data = dev_get_drvdata(dev);
624 const struct firmware *fw;
627 const u8 *fw_signature;
628 static const u8 signature[] = {0xAA, 0x55, 0xCC, 0x33, 0xFF, 0xFF};
630 if (data->fw_validpage_count == 0)
633 /* Look for a firmware with the product id appended. */
634 fw_name = kasprintf(GFP_KERNEL, ETP_FW_NAME, data->product_id);
636 dev_err(dev, "failed to allocate memory for firmware name\n");
640 dev_info(dev, "requesting fw '%s'\n", fw_name);
641 error = request_firmware(&fw, fw_name, dev);
644 dev_err(dev, "failed to request firmware: %d\n", error);
648 /* Firmware file must match signature data */
649 fw_signature = &fw->data[data->fw_signature_address];
650 if (memcmp(fw_signature, signature, sizeof(signature)) != 0) {
651 dev_err(dev, "signature mismatch (expected %*ph, got %*ph)\n",
652 (int)sizeof(signature), signature,
653 (int)sizeof(signature), fw_signature);
658 error = mutex_lock_interruptible(&data->sysfs_mutex);
662 error = elan_update_firmware(data, fw);
664 mutex_unlock(&data->sysfs_mutex);
667 release_firmware(fw);
668 return error ?: count;
671 static ssize_t calibrate_store(struct device *dev,
672 struct device_attribute *attr,
673 const char *buf, size_t count)
675 struct i2c_client *client = to_i2c_client(dev);
676 struct elan_tp_data *data = i2c_get_clientdata(client);
680 u8 val[ETP_CALIBRATE_MAX_LEN];
682 retval = mutex_lock_interruptible(&data->sysfs_mutex);
686 disable_irq(client->irq);
688 data->mode |= ETP_ENABLE_CALIBRATE;
689 retval = data->ops->set_mode(client, data->mode);
691 dev_err(dev, "failed to enable calibration mode: %d\n",
696 retval = data->ops->calibrate(client);
698 dev_err(dev, "failed to start calibration: %d\n",
700 goto out_disable_calibrate;
705 /* Wait 250ms before checking if calibration has completed. */
708 retval = data->ops->calibrate_result(client, val);
710 dev_err(dev, "failed to check calibration result: %d\n",
712 else if (val[0] == 0)
713 break; /* calibration done */
718 dev_err(dev, "failed to calibrate. Timeout.\n");
722 out_disable_calibrate:
723 data->mode &= ~ETP_ENABLE_CALIBRATE;
724 error = data->ops->set_mode(data->client, data->mode);
726 dev_err(dev, "failed to disable calibration mode: %d\n",
732 enable_irq(client->irq);
733 mutex_unlock(&data->sysfs_mutex);
734 return retval ?: count;
737 static ssize_t elan_sysfs_read_mode(struct device *dev,
738 struct device_attribute *attr,
741 struct i2c_client *client = to_i2c_client(dev);
742 struct elan_tp_data *data = i2c_get_clientdata(client);
746 error = mutex_lock_interruptible(&data->sysfs_mutex);
750 error = data->ops->iap_get_mode(data->client, &mode);
752 mutex_unlock(&data->sysfs_mutex);
757 return sprintf(buf, "%d\n", (int)mode);
760 static DEVICE_ATTR(product_id, S_IRUGO, elan_sysfs_read_product_id, NULL);
761 static DEVICE_ATTR(firmware_version, S_IRUGO, elan_sysfs_read_fw_ver, NULL);
762 static DEVICE_ATTR(sample_version, S_IRUGO, elan_sysfs_read_sm_ver, NULL);
763 static DEVICE_ATTR(iap_version, S_IRUGO, elan_sysfs_read_iap_ver, NULL);
764 static DEVICE_ATTR(fw_checksum, S_IRUGO, elan_sysfs_read_fw_checksum, NULL);
765 static DEVICE_ATTR(mode, S_IRUGO, elan_sysfs_read_mode, NULL);
766 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, elan_sysfs_update_fw);
768 static DEVICE_ATTR_WO(calibrate);
770 static struct attribute *elan_sysfs_entries[] = {
771 &dev_attr_product_id.attr,
772 &dev_attr_firmware_version.attr,
773 &dev_attr_sample_version.attr,
774 &dev_attr_iap_version.attr,
775 &dev_attr_fw_checksum.attr,
776 &dev_attr_calibrate.attr,
778 &dev_attr_update_fw.attr,
782 static const struct attribute_group elan_sysfs_group = {
783 .attrs = elan_sysfs_entries,
786 static ssize_t acquire_store(struct device *dev, struct device_attribute *attr,
787 const char *buf, size_t count)
789 struct i2c_client *client = to_i2c_client(dev);
790 struct elan_tp_data *data = i2c_get_clientdata(client);
794 retval = mutex_lock_interruptible(&data->sysfs_mutex);
798 disable_irq(client->irq);
800 data->baseline_ready = false;
802 data->mode |= ETP_ENABLE_CALIBRATE;
803 retval = data->ops->set_mode(data->client, data->mode);
805 dev_err(dev, "Failed to enable calibration mode to get baseline: %d\n",
812 retval = data->ops->get_baseline_data(data->client, true,
813 &data->max_baseline);
815 dev_err(dev, "Failed to read max baseline form device: %d\n",
817 goto out_disable_calibrate;
820 retval = data->ops->get_baseline_data(data->client, false,
821 &data->min_baseline);
823 dev_err(dev, "Failed to read min baseline form device: %d\n",
825 goto out_disable_calibrate;
828 data->baseline_ready = true;
830 out_disable_calibrate:
831 data->mode &= ~ETP_ENABLE_CALIBRATE;
832 error = data->ops->set_mode(data->client, data->mode);
834 dev_err(dev, "Failed to disable calibration mode after acquiring baseline: %d\n",
840 enable_irq(client->irq);
841 mutex_unlock(&data->sysfs_mutex);
842 return retval ?: count;
845 static ssize_t min_show(struct device *dev,
846 struct device_attribute *attr, char *buf)
848 struct i2c_client *client = to_i2c_client(dev);
849 struct elan_tp_data *data = i2c_get_clientdata(client);
852 retval = mutex_lock_interruptible(&data->sysfs_mutex);
856 if (!data->baseline_ready) {
861 retval = snprintf(buf, PAGE_SIZE, "%d", data->min_baseline);
864 mutex_unlock(&data->sysfs_mutex);
868 static ssize_t max_show(struct device *dev,
869 struct device_attribute *attr, char *buf)
871 struct i2c_client *client = to_i2c_client(dev);
872 struct elan_tp_data *data = i2c_get_clientdata(client);
875 retval = mutex_lock_interruptible(&data->sysfs_mutex);
879 if (!data->baseline_ready) {
884 retval = snprintf(buf, PAGE_SIZE, "%d", data->max_baseline);
887 mutex_unlock(&data->sysfs_mutex);
892 static DEVICE_ATTR_WO(acquire);
893 static DEVICE_ATTR_RO(min);
894 static DEVICE_ATTR_RO(max);
896 static struct attribute *elan_baseline_sysfs_entries[] = {
897 &dev_attr_acquire.attr,
903 static const struct attribute_group elan_baseline_sysfs_group = {
905 .attrs = elan_baseline_sysfs_entries,
908 static const struct attribute_group *elan_sysfs_groups[] = {
910 &elan_baseline_sysfs_group,
915 ******************************************************************
917 ******************************************************************
919 static void elan_report_contact(struct elan_tp_data *data, int contact_num,
920 bool contact_valid, bool high_precision,
921 u8 *packet, u8 *finger_data)
923 struct input_dev *input = data->input;
924 unsigned int pos_x, pos_y;
925 unsigned int pressure, scaled_pressure;
928 if (high_precision) {
929 pos_x = get_unaligned_be16(&finger_data[0]);
930 pos_y = get_unaligned_be16(&finger_data[2]);
932 pos_x = ((finger_data[0] & 0xf0) << 4) | finger_data[1];
933 pos_y = ((finger_data[0] & 0x0f) << 8) | finger_data[2];
936 if (pos_x > data->max_x || pos_y > data->max_y) {
937 dev_dbg(input->dev.parent,
938 "[%d] x=%d y=%d over max (%d, %d)",
939 contact_num, pos_x, pos_y,
940 data->max_x, data->max_y);
944 pressure = finger_data[4];
945 scaled_pressure = pressure + data->pressure_adjustment;
946 if (scaled_pressure > ETP_MAX_PRESSURE)
947 scaled_pressure = ETP_MAX_PRESSURE;
949 input_mt_slot(input, contact_num);
950 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
951 input_report_abs(input, ABS_MT_POSITION_X, pos_x);
952 input_report_abs(input, ABS_MT_POSITION_Y, data->max_y - pos_y);
953 input_report_abs(input, ABS_MT_PRESSURE, scaled_pressure);
955 if (data->report_features & ETP_FEATURE_REPORT_MK) {
956 unsigned int mk_x, mk_y, area_x, area_y;
957 u8 mk_data = high_precision ?
958 packet[ETP_MK_DATA_OFFSET + contact_num] :
961 mk_x = mk_data & 0x0f;
965 * To avoid treating large finger as palm, let's reduce
966 * the width x and y per trace.
968 area_x = mk_x * (data->width_x - ETP_FWIDTH_REDUCE);
969 area_y = mk_y * (data->width_y - ETP_FWIDTH_REDUCE);
971 input_report_abs(input, ABS_TOOL_WIDTH, mk_x);
972 input_report_abs(input, ABS_MT_TOUCH_MAJOR,
973 max(area_x, area_y));
974 input_report_abs(input, ABS_MT_TOUCH_MINOR,
975 min(area_x, area_y));
978 input_mt_slot(input, contact_num);
979 input_mt_report_slot_inactive(input);
983 static void elan_report_absolute(struct elan_tp_data *data, u8 *packet,
986 struct input_dev *input = data->input;
987 u8 *finger_data = &packet[ETP_FINGER_DATA_OFFSET];
989 u8 tp_info = packet[ETP_TOUCH_INFO_OFFSET];
990 u8 hover_info = packet[ETP_HOVER_INFO_OFFSET];
991 bool contact_valid, hover_event;
993 pm_wakeup_event(&data->client->dev, 0);
995 hover_event = hover_info & BIT(6);
997 for (i = 0; i < ETP_MAX_FINGERS; i++) {
998 contact_valid = tp_info & BIT(3 + i);
999 elan_report_contact(data, i, contact_valid, high_precision,
1000 packet, finger_data);
1002 finger_data += ETP_FINGER_DATA_LEN;
1005 input_report_key(input, BTN_LEFT, tp_info & BIT(0));
1006 input_report_key(input, BTN_MIDDLE, tp_info & BIT(2));
1007 input_report_key(input, BTN_RIGHT, tp_info & BIT(1));
1008 input_report_abs(input, ABS_DISTANCE, hover_event != 0);
1009 input_mt_report_pointer_emulation(input, true);
1013 static void elan_report_trackpoint(struct elan_tp_data *data, u8 *report)
1015 struct input_dev *input = data->tp_input;
1016 u8 *packet = &report[ETP_REPORT_ID_OFFSET + 1];
1019 pm_wakeup_event(&data->client->dev, 0);
1021 if (!data->tp_input) {
1022 dev_warn_once(&data->client->dev,
1023 "received a trackpoint report while no trackpoint device has been created. Please report upstream.\n");
1027 input_report_key(input, BTN_LEFT, packet[0] & 0x01);
1028 input_report_key(input, BTN_RIGHT, packet[0] & 0x02);
1029 input_report_key(input, BTN_MIDDLE, packet[0] & 0x04);
1031 if ((packet[3] & 0x0F) == 0x06) {
1032 x = packet[4] - (int)((packet[1] ^ 0x80) << 1);
1033 y = (int)((packet[2] ^ 0x80) << 1) - packet[5];
1035 input_report_rel(input, REL_X, x);
1036 input_report_rel(input, REL_Y, y);
1042 static irqreturn_t elan_isr(int irq, void *dev_id)
1044 struct elan_tp_data *data = dev_id;
1046 u8 report[ETP_MAX_REPORT_LEN];
1049 * When device is connected to i2c bus, when all IAP page writes
1050 * complete, the driver will receive interrupt and must read
1051 * 0000 to confirm that IAP is finished.
1053 if (data->in_fw_update) {
1054 complete(&data->fw_completion);
1058 error = data->ops->get_report(data->client, report, data->report_len);
1062 switch (report[ETP_REPORT_ID_OFFSET]) {
1064 elan_report_absolute(data, report, false);
1066 case ETP_REPORT_ID2:
1067 elan_report_absolute(data, report, true);
1069 case ETP_TP_REPORT_ID:
1070 case ETP_TP_REPORT_ID2:
1071 elan_report_trackpoint(data, report);
1074 dev_err(&data->client->dev, "invalid report id data (%x)\n",
1075 report[ETP_REPORT_ID_OFFSET]);
1083 ******************************************************************
1084 * Elan initialization functions
1085 ******************************************************************
1088 static int elan_setup_trackpoint_input_device(struct elan_tp_data *data)
1090 struct device *dev = &data->client->dev;
1091 struct input_dev *input;
1093 input = devm_input_allocate_device(dev);
1097 input->name = "Elan TrackPoint";
1098 input->id.bustype = BUS_I2C;
1099 input->id.vendor = ELAN_VENDOR_ID;
1100 input->id.product = data->product_id;
1101 input_set_drvdata(input, data);
1103 input_set_capability(input, EV_REL, REL_X);
1104 input_set_capability(input, EV_REL, REL_Y);
1105 input_set_capability(input, EV_KEY, BTN_LEFT);
1106 input_set_capability(input, EV_KEY, BTN_RIGHT);
1107 input_set_capability(input, EV_KEY, BTN_MIDDLE);
1109 __set_bit(INPUT_PROP_POINTER, input->propbit);
1110 __set_bit(INPUT_PROP_POINTING_STICK, input->propbit);
1112 data->tp_input = input;
1117 static int elan_setup_input_device(struct elan_tp_data *data)
1119 struct device *dev = &data->client->dev;
1120 struct input_dev *input;
1121 unsigned int max_width = max(data->width_x, data->width_y);
1122 unsigned int min_width = min(data->width_x, data->width_y);
1125 input = devm_input_allocate_device(dev);
1129 input->name = "Elan Touchpad";
1130 input->id.bustype = BUS_I2C;
1131 input->id.vendor = ELAN_VENDOR_ID;
1132 input->id.product = data->product_id;
1133 input_set_drvdata(input, data);
1135 error = input_mt_init_slots(input, ETP_MAX_FINGERS,
1136 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
1138 dev_err(dev, "failed to initialize MT slots: %d\n", error);
1142 __set_bit(EV_ABS, input->evbit);
1143 __set_bit(INPUT_PROP_POINTER, input->propbit);
1144 if (data->clickpad) {
1145 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1147 __set_bit(BTN_RIGHT, input->keybit);
1148 if (data->middle_button)
1149 __set_bit(BTN_MIDDLE, input->keybit);
1151 __set_bit(BTN_LEFT, input->keybit);
1153 /* Set up ST parameters */
1154 input_set_abs_params(input, ABS_X, 0, data->max_x, 0, 0);
1155 input_set_abs_params(input, ABS_Y, 0, data->max_y, 0, 0);
1156 input_abs_set_res(input, ABS_X, data->x_res);
1157 input_abs_set_res(input, ABS_Y, data->y_res);
1158 input_set_abs_params(input, ABS_PRESSURE, 0, ETP_MAX_PRESSURE, 0, 0);
1159 if (data->report_features & ETP_FEATURE_REPORT_MK)
1160 input_set_abs_params(input, ABS_TOOL_WIDTH,
1161 0, ETP_FINGER_WIDTH, 0, 0);
1162 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0);
1164 /* And MT parameters */
1165 input_set_abs_params(input, ABS_MT_POSITION_X, 0, data->max_x, 0, 0);
1166 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, data->max_y, 0, 0);
1167 input_abs_set_res(input, ABS_MT_POSITION_X, data->x_res);
1168 input_abs_set_res(input, ABS_MT_POSITION_Y, data->y_res);
1169 input_set_abs_params(input, ABS_MT_PRESSURE, 0,
1170 ETP_MAX_PRESSURE, 0, 0);
1171 if (data->report_features & ETP_FEATURE_REPORT_MK) {
1172 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR,
1173 0, ETP_FINGER_WIDTH * max_width, 0, 0);
1174 input_set_abs_params(input, ABS_MT_TOUCH_MINOR,
1175 0, ETP_FINGER_WIDTH * min_width, 0, 0);
1178 data->input = input;
1183 static void elan_disable_regulator(void *_data)
1185 struct elan_tp_data *data = _data;
1187 regulator_disable(data->vcc);
1190 static int elan_probe(struct i2c_client *client)
1192 const struct elan_transport_ops *transport_ops;
1193 struct device *dev = &client->dev;
1194 struct elan_tp_data *data;
1195 unsigned long irqflags;
1198 if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_I2C) &&
1199 i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1200 transport_ops = &elan_i2c_ops;
1201 } else if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) &&
1202 i2c_check_functionality(client->adapter,
1203 I2C_FUNC_SMBUS_BYTE_DATA |
1204 I2C_FUNC_SMBUS_BLOCK_DATA |
1205 I2C_FUNC_SMBUS_I2C_BLOCK)) {
1206 transport_ops = &elan_smbus_ops;
1208 dev_err(dev, "not a supported I2C/SMBus adapter\n");
1212 data = devm_kzalloc(dev, sizeof(struct elan_tp_data), GFP_KERNEL);
1216 i2c_set_clientdata(client, data);
1218 data->ops = transport_ops;
1219 data->client = client;
1220 init_completion(&data->fw_completion);
1221 mutex_init(&data->sysfs_mutex);
1223 data->vcc = devm_regulator_get(dev, "vcc");
1224 if (IS_ERR(data->vcc)) {
1225 error = PTR_ERR(data->vcc);
1226 if (error != -EPROBE_DEFER)
1227 dev_err(dev, "Failed to get 'vcc' regulator: %d\n",
1232 error = regulator_enable(data->vcc);
1234 dev_err(dev, "Failed to enable regulator: %d\n", error);
1238 error = devm_add_action_or_reset(dev, elan_disable_regulator, data);
1240 dev_err(dev, "Failed to add disable regulator action: %d\n",
1245 /* Make sure there is something at this address */
1246 error = i2c_smbus_read_byte(client);
1248 dev_dbg(&client->dev, "nothing at this address: %d\n", error);
1252 /* Initialize the touchpad. */
1253 error = elan_initialize(data, false);
1257 error = elan_query_device_info(data);
1261 error = elan_query_device_parameters(data);
1266 "Elan Touchpad: Module ID: 0x%04x, Firmware: 0x%04x, Sample: 0x%04x, IAP: 0x%04x\n",
1273 "Elan Touchpad Extra Information:\n"
1274 " Max ABS X,Y: %d,%d\n"
1275 " Width X,Y: %d,%d\n"
1276 " Resolution X,Y: %d,%d (dots/mm)\n"
1278 " info pattern: 0x%x\n",
1279 data->max_x, data->max_y,
1280 data->width_x, data->width_y,
1281 data->x_res, data->y_res,
1282 data->ic_type, data->pattern);
1284 /* Set up input device properties based on queried parameters. */
1285 error = elan_setup_input_device(data);
1289 if (device_property_read_bool(&client->dev, "elan,trackpoint")) {
1290 error = elan_setup_trackpoint_input_device(data);
1296 * Platform code (ACPI, DTS) should normally set up interrupt
1297 * for us, but in case it did not let's fall back to using falling
1298 * edge to be compatible with older Chromebooks.
1300 irqflags = irq_get_trigger_type(client->irq);
1302 irqflags = IRQF_TRIGGER_FALLING;
1304 error = devm_request_threaded_irq(dev, client->irq, NULL, elan_isr,
1305 irqflags | IRQF_ONESHOT,
1306 client->name, data);
1308 dev_err(dev, "cannot register irq=%d\n", client->irq);
1312 error = input_register_device(data->input);
1314 dev_err(dev, "failed to register input device: %d\n", error);
1318 if (data->tp_input) {
1319 error = input_register_device(data->tp_input);
1321 dev_err(&client->dev,
1322 "failed to register TrackPoint input device: %d\n",
1331 static int __maybe_unused elan_suspend(struct device *dev)
1333 struct i2c_client *client = to_i2c_client(dev);
1334 struct elan_tp_data *data = i2c_get_clientdata(client);
1338 * We are taking the mutex to make sure sysfs operations are
1339 * complete before we attempt to bring the device into low[er]
1342 ret = mutex_lock_interruptible(&data->sysfs_mutex);
1346 disable_irq(client->irq);
1348 if (device_may_wakeup(dev)) {
1349 ret = elan_sleep(data);
1351 ret = elan_set_power(data, false);
1355 ret = regulator_disable(data->vcc);
1357 dev_err(dev, "error %d disabling regulator\n", ret);
1358 /* Attempt to power the chip back up */
1359 elan_set_power(data, true);
1364 mutex_unlock(&data->sysfs_mutex);
1368 static int __maybe_unused elan_resume(struct device *dev)
1370 struct i2c_client *client = to_i2c_client(dev);
1371 struct elan_tp_data *data = i2c_get_clientdata(client);
1374 if (!device_may_wakeup(dev)) {
1375 error = regulator_enable(data->vcc);
1377 dev_err(dev, "error %d enabling regulator\n", error);
1382 error = elan_set_power(data, true);
1384 dev_err(dev, "power up when resuming failed: %d\n", error);
1388 error = elan_initialize(data, data->quirks & ETP_QUIRK_QUICK_WAKEUP);
1390 dev_err(dev, "initialize when resuming failed: %d\n", error);
1393 enable_irq(data->client->irq);
1397 static SIMPLE_DEV_PM_OPS(elan_pm_ops, elan_suspend, elan_resume);
1399 static const struct i2c_device_id elan_id[] = {
1403 MODULE_DEVICE_TABLE(i2c, elan_id);
1406 #include <linux/input/elan-i2c-ids.h>
1407 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
1411 static const struct of_device_id elan_of_match[] = {
1412 { .compatible = "elan,ekth3000" },
1415 MODULE_DEVICE_TABLE(of, elan_of_match);
1418 static struct i2c_driver elan_driver = {
1420 .name = DRIVER_NAME,
1422 .acpi_match_table = ACPI_PTR(elan_acpi_id),
1423 .of_match_table = of_match_ptr(elan_of_match),
1424 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1425 .dev_groups = elan_sysfs_groups,
1427 .probe_new = elan_probe,
1428 .id_table = elan_id,
1431 module_i2c_driver(elan_driver);
1434 MODULE_DESCRIPTION("Elan I2C/SMBus Touchpad driver");
1435 MODULE_LICENSE("GPL");