0001
0002
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014
0015
0016
0017
0018 #include <linux/acpi.h>
0019 #include <linux/delay.h>
0020 #include <linux/device.h>
0021 #include <linux/firmware.h>
0022 #include <linux/i2c.h>
0023 #include <linux/init.h>
0024 #include <linux/input/mt.h>
0025 #include <linux/interrupt.h>
0026 #include <linux/irq.h>
0027 #include <linux/module.h>
0028 #include <linux/slab.h>
0029 #include <linux/kernel.h>
0030 #include <linux/sched.h>
0031 #include <linux/input.h>
0032 #include <linux/uaccess.h>
0033 #include <linux/jiffies.h>
0034 #include <linux/completion.h>
0035 #include <linux/of.h>
0036 #include <linux/property.h>
0037 #include <linux/regulator/consumer.h>
0038 #include <asm/unaligned.h>
0039
0040 #include "elan_i2c.h"
0041
0042 #define DRIVER_NAME "elan_i2c"
0043 #define ELAN_VENDOR_ID 0x04f3
0044 #define ETP_MAX_PRESSURE 255
0045 #define ETP_FWIDTH_REDUCE 90
0046 #define ETP_FINGER_WIDTH 15
0047 #define ETP_RETRY_COUNT 3
0048
0049
0050 #define ETP_QUIRK_QUICK_WAKEUP BIT(0)
0051
0052
0053 struct elan_tp_data {
0054 struct i2c_client *client;
0055 struct input_dev *input;
0056 struct input_dev *tp_input;
0057 struct regulator *vcc;
0058
0059 const struct elan_transport_ops *ops;
0060
0061
0062 struct completion fw_completion;
0063 bool in_fw_update;
0064
0065 struct mutex sysfs_mutex;
0066
0067 unsigned int max_x;
0068 unsigned int max_y;
0069 unsigned int width_x;
0070 unsigned int width_y;
0071 unsigned int x_res;
0072 unsigned int y_res;
0073
0074 u8 pattern;
0075 u16 product_id;
0076 u8 fw_version;
0077 u8 sm_version;
0078 u8 iap_version;
0079 u16 fw_checksum;
0080 unsigned int report_features;
0081 unsigned int report_len;
0082 int pressure_adjustment;
0083 u8 mode;
0084 u16 ic_type;
0085 u16 fw_validpage_count;
0086 u16 fw_page_size;
0087 u32 fw_signature_address;
0088
0089 bool irq_wake;
0090
0091 u8 min_baseline;
0092 u8 max_baseline;
0093 bool baseline_ready;
0094 u8 clickpad;
0095 bool middle_button;
0096
0097 u32 quirks;
0098 };
0099
0100 static u32 elan_i2c_lookup_quirks(u16 ic_type, u16 product_id)
0101 {
0102 static const struct {
0103 u16 ic_type;
0104 u16 product_id;
0105 u32 quirks;
0106 } elan_i2c_quirks[] = {
0107 { 0x0D, ETP_PRODUCT_ID_DELBIN, ETP_QUIRK_QUICK_WAKEUP },
0108 { 0x0D, ETP_PRODUCT_ID_WHITEBOX, ETP_QUIRK_QUICK_WAKEUP },
0109 { 0x10, ETP_PRODUCT_ID_VOXEL, ETP_QUIRK_QUICK_WAKEUP },
0110 { 0x14, ETP_PRODUCT_ID_MAGPIE, ETP_QUIRK_QUICK_WAKEUP },
0111 { 0x14, ETP_PRODUCT_ID_BOBBA, ETP_QUIRK_QUICK_WAKEUP },
0112 };
0113 u32 quirks = 0;
0114 int i;
0115
0116 for (i = 0; i < ARRAY_SIZE(elan_i2c_quirks); i++) {
0117 if (elan_i2c_quirks[i].ic_type == ic_type &&
0118 elan_i2c_quirks[i].product_id == product_id) {
0119 quirks = elan_i2c_quirks[i].quirks;
0120 }
0121 }
0122
0123 if (ic_type >= 0x0D && product_id >= 0x123)
0124 quirks |= ETP_QUIRK_QUICK_WAKEUP;
0125
0126 return quirks;
0127 }
0128
0129 static int elan_get_fwinfo(u16 ic_type, u8 iap_version, u16 *validpage_count,
0130 u32 *signature_address, u16 *page_size)
0131 {
0132 switch (ic_type) {
0133 case 0x00:
0134 case 0x06:
0135 case 0x08:
0136 *validpage_count = 512;
0137 break;
0138 case 0x03:
0139 case 0x07:
0140 case 0x09:
0141 case 0x0A:
0142 case 0x0B:
0143 case 0x0C:
0144 *validpage_count = 768;
0145 break;
0146 case 0x0D:
0147 *validpage_count = 896;
0148 break;
0149 case 0x0E:
0150 *validpage_count = 640;
0151 break;
0152 case 0x10:
0153 *validpage_count = 1024;
0154 break;
0155 case 0x11:
0156 *validpage_count = 1280;
0157 break;
0158 case 0x13:
0159 *validpage_count = 2048;
0160 break;
0161 case 0x14:
0162 case 0x15:
0163 *validpage_count = 1024;
0164 break;
0165 default:
0166
0167 *validpage_count = 0;
0168 *signature_address = 0;
0169 *page_size = 0;
0170 return -ENXIO;
0171 }
0172
0173 *signature_address =
0174 (*validpage_count * ETP_FW_PAGE_SIZE) - ETP_FW_SIGNATURE_SIZE;
0175
0176 if ((ic_type == 0x14 || ic_type == 0x15) && iap_version >= 2) {
0177 *validpage_count /= 8;
0178 *page_size = ETP_FW_PAGE_SIZE_512;
0179 } else if (ic_type >= 0x0D && iap_version >= 1) {
0180 *validpage_count /= 2;
0181 *page_size = ETP_FW_PAGE_SIZE_128;
0182 } else {
0183 *page_size = ETP_FW_PAGE_SIZE;
0184 }
0185
0186 return 0;
0187 }
0188
0189 static int elan_set_power(struct elan_tp_data *data, bool on)
0190 {
0191 int repeat = ETP_RETRY_COUNT;
0192 int error;
0193
0194 do {
0195 error = data->ops->power_control(data->client, on);
0196 if (error >= 0)
0197 return 0;
0198
0199 msleep(30);
0200 } while (--repeat > 0);
0201
0202 dev_err(&data->client->dev, "failed to set power %s: %d\n",
0203 on ? "on" : "off", error);
0204 return error;
0205 }
0206
0207 static int elan_sleep(struct elan_tp_data *data)
0208 {
0209 int repeat = ETP_RETRY_COUNT;
0210 int error;
0211
0212 do {
0213 error = data->ops->sleep_control(data->client, true);
0214 if (!error)
0215 return 0;
0216
0217 msleep(30);
0218 } while (--repeat > 0);
0219
0220 return error;
0221 }
0222
0223 static int elan_query_product(struct elan_tp_data *data)
0224 {
0225 int error;
0226
0227 error = data->ops->get_product_id(data->client, &data->product_id);
0228 if (error)
0229 return error;
0230
0231 error = data->ops->get_pattern(data->client, &data->pattern);
0232 if (error)
0233 return error;
0234
0235 error = data->ops->get_sm_version(data->client, data->pattern,
0236 &data->ic_type, &data->sm_version,
0237 &data->clickpad);
0238 if (error)
0239 return error;
0240
0241 return 0;
0242 }
0243
0244 static int elan_check_ASUS_special_fw(struct elan_tp_data *data)
0245 {
0246 if (data->ic_type == 0x0E) {
0247 switch (data->product_id) {
0248 case 0x05 ... 0x07:
0249 case 0x09:
0250 case 0x13:
0251 return true;
0252 }
0253 } else if (data->ic_type == 0x08 && data->product_id == 0x26) {
0254
0255 return true;
0256 }
0257
0258 return false;
0259 }
0260
0261 static int __elan_initialize(struct elan_tp_data *data, bool skip_reset)
0262 {
0263 struct i2c_client *client = data->client;
0264 bool woken_up = false;
0265 int error;
0266
0267 if (!skip_reset) {
0268 error = data->ops->initialize(client);
0269 if (error) {
0270 dev_err(&client->dev, "device initialize failed: %d\n", error);
0271 return error;
0272 }
0273 }
0274
0275 error = elan_query_product(data);
0276 if (error)
0277 return error;
0278
0279
0280
0281
0282
0283
0284 if (elan_check_ASUS_special_fw(data)) {
0285 error = data->ops->sleep_control(client, false);
0286 if (error) {
0287 dev_err(&client->dev,
0288 "failed to wake device up: %d\n", error);
0289 return error;
0290 }
0291
0292 msleep(200);
0293 woken_up = true;
0294 }
0295
0296 data->mode |= ETP_ENABLE_ABS;
0297 error = data->ops->set_mode(client, data->mode);
0298 if (error) {
0299 dev_err(&client->dev,
0300 "failed to switch to absolute mode: %d\n", error);
0301 return error;
0302 }
0303
0304 if (!woken_up) {
0305 error = data->ops->sleep_control(client, false);
0306 if (error) {
0307 dev_err(&client->dev,
0308 "failed to wake device up: %d\n", error);
0309 return error;
0310 }
0311 }
0312
0313 return 0;
0314 }
0315
0316 static int elan_initialize(struct elan_tp_data *data, bool skip_reset)
0317 {
0318 int repeat = ETP_RETRY_COUNT;
0319 int error;
0320
0321 do {
0322 error = __elan_initialize(data, skip_reset);
0323 if (!error)
0324 return 0;
0325
0326 skip_reset = false;
0327 msleep(30);
0328 } while (--repeat > 0);
0329
0330 return error;
0331 }
0332
0333 static int elan_query_device_info(struct elan_tp_data *data)
0334 {
0335 int error;
0336
0337 error = data->ops->get_version(data->client, data->pattern, false,
0338 &data->fw_version);
0339 if (error)
0340 return error;
0341
0342 error = data->ops->get_checksum(data->client, false,
0343 &data->fw_checksum);
0344 if (error)
0345 return error;
0346
0347 error = data->ops->get_version(data->client, data->pattern,
0348 true, &data->iap_version);
0349 if (error)
0350 return error;
0351
0352 error = data->ops->get_pressure_adjustment(data->client,
0353 &data->pressure_adjustment);
0354 if (error)
0355 return error;
0356
0357 error = data->ops->get_report_features(data->client, data->pattern,
0358 &data->report_features,
0359 &data->report_len);
0360 if (error)
0361 return error;
0362
0363 data->quirks = elan_i2c_lookup_quirks(data->ic_type, data->product_id);
0364
0365 error = elan_get_fwinfo(data->ic_type, data->iap_version,
0366 &data->fw_validpage_count,
0367 &data->fw_signature_address,
0368 &data->fw_page_size);
0369 if (error)
0370 dev_warn(&data->client->dev,
0371 "unexpected iap version %#04x (ic type: %#04x), firmware update will not work\n",
0372 data->iap_version, data->ic_type);
0373
0374 return 0;
0375 }
0376
0377 static unsigned int elan_convert_resolution(u8 val, u8 pattern)
0378 {
0379
0380
0381
0382
0383
0384
0385 int res = pattern <= 0x01 ?
0386 (int)(char)val * 10 + 790 : ((int)(char)val + 3) * 100;
0387
0388
0389
0390
0391 return res * 10 / 254;
0392 }
0393
0394 static int elan_query_device_parameters(struct elan_tp_data *data)
0395 {
0396 struct i2c_client *client = data->client;
0397 unsigned int x_traces, y_traces;
0398 u32 x_mm, y_mm;
0399 u8 hw_x_res, hw_y_res;
0400 int error;
0401
0402 if (device_property_read_u32(&client->dev,
0403 "touchscreen-size-x", &data->max_x) ||
0404 device_property_read_u32(&client->dev,
0405 "touchscreen-size-y", &data->max_y)) {
0406 error = data->ops->get_max(data->client,
0407 &data->max_x,
0408 &data->max_y);
0409 if (error)
0410 return error;
0411 } else {
0412
0413 --data->max_x;
0414 --data->max_y;
0415 }
0416
0417 if (device_property_read_u32(&client->dev,
0418 "elan,x_traces",
0419 &x_traces) ||
0420 device_property_read_u32(&client->dev,
0421 "elan,y_traces",
0422 &y_traces)) {
0423 error = data->ops->get_num_traces(data->client,
0424 &x_traces, &y_traces);
0425 if (error)
0426 return error;
0427 }
0428 data->width_x = data->max_x / x_traces;
0429 data->width_y = data->max_y / y_traces;
0430
0431 if (device_property_read_u32(&client->dev,
0432 "touchscreen-x-mm", &x_mm) ||
0433 device_property_read_u32(&client->dev,
0434 "touchscreen-y-mm", &y_mm)) {
0435 error = data->ops->get_resolution(data->client,
0436 &hw_x_res, &hw_y_res);
0437 if (error)
0438 return error;
0439
0440 data->x_res = elan_convert_resolution(hw_x_res, data->pattern);
0441 data->y_res = elan_convert_resolution(hw_y_res, data->pattern);
0442 } else {
0443 data->x_res = (data->max_x + 1) / x_mm;
0444 data->y_res = (data->max_y + 1) / y_mm;
0445 }
0446
0447 if (device_property_read_bool(&client->dev, "elan,clickpad"))
0448 data->clickpad = 1;
0449
0450 if (device_property_read_bool(&client->dev, "elan,middle-button"))
0451 data->middle_button = true;
0452
0453 return 0;
0454 }
0455
0456
0457
0458
0459
0460
0461 static int elan_write_fw_block(struct elan_tp_data *data, u16 page_size,
0462 const u8 *page, u16 checksum, int idx)
0463 {
0464 int retry = ETP_RETRY_COUNT;
0465 int error;
0466
0467 do {
0468 error = data->ops->write_fw_block(data->client, page_size,
0469 page, checksum, idx);
0470 if (!error)
0471 return 0;
0472
0473 dev_dbg(&data->client->dev,
0474 "IAP retrying page %d (error: %d)\n", idx, error);
0475 } while (--retry > 0);
0476
0477 return error;
0478 }
0479
0480 static int __elan_update_firmware(struct elan_tp_data *data,
0481 const struct firmware *fw)
0482 {
0483 struct i2c_client *client = data->client;
0484 struct device *dev = &client->dev;
0485 int i, j;
0486 int error;
0487 u16 iap_start_addr;
0488 u16 boot_page_count;
0489 u16 sw_checksum = 0, fw_checksum = 0;
0490
0491 error = data->ops->prepare_fw_update(client, data->ic_type,
0492 data->iap_version,
0493 data->fw_page_size);
0494 if (error)
0495 return error;
0496
0497 iap_start_addr = get_unaligned_le16(&fw->data[ETP_IAP_START_ADDR * 2]);
0498
0499 boot_page_count = (iap_start_addr * 2) / data->fw_page_size;
0500 for (i = boot_page_count; i < data->fw_validpage_count; i++) {
0501 u16 checksum = 0;
0502 const u8 *page = &fw->data[i * data->fw_page_size];
0503
0504 for (j = 0; j < data->fw_page_size; j += 2)
0505 checksum += ((page[j + 1] << 8) | page[j]);
0506
0507 error = elan_write_fw_block(data, data->fw_page_size,
0508 page, checksum, i);
0509 if (error) {
0510 dev_err(dev, "write page %d fail: %d\n", i, error);
0511 return error;
0512 }
0513
0514 sw_checksum += checksum;
0515 }
0516
0517
0518 msleep(600);
0519
0520 error = data->ops->finish_fw_update(client, &data->fw_completion);
0521 if (error)
0522 return error;
0523
0524 error = data->ops->get_checksum(client, true, &fw_checksum);
0525 if (error)
0526 return error;
0527
0528 if (sw_checksum != fw_checksum) {
0529 dev_err(dev, "checksum diff sw=[%04X], fw=[%04X]\n",
0530 sw_checksum, fw_checksum);
0531 return -EIO;
0532 }
0533
0534 return 0;
0535 }
0536
0537 static int elan_update_firmware(struct elan_tp_data *data,
0538 const struct firmware *fw)
0539 {
0540 struct i2c_client *client = data->client;
0541 int retval;
0542
0543 dev_dbg(&client->dev, "Starting firmware update....\n");
0544
0545 disable_irq(client->irq);
0546 data->in_fw_update = true;
0547
0548 retval = __elan_update_firmware(data, fw);
0549 if (retval) {
0550 dev_err(&client->dev, "firmware update failed: %d\n", retval);
0551 data->ops->iap_reset(client);
0552 } else {
0553
0554 elan_initialize(data, false);
0555 elan_query_device_info(data);
0556 }
0557
0558 data->in_fw_update = false;
0559 enable_irq(client->irq);
0560
0561 return retval;
0562 }
0563
0564
0565
0566
0567
0568
0569 static ssize_t elan_sysfs_read_fw_checksum(struct device *dev,
0570 struct device_attribute *attr,
0571 char *buf)
0572 {
0573 struct i2c_client *client = to_i2c_client(dev);
0574 struct elan_tp_data *data = i2c_get_clientdata(client);
0575
0576 return sprintf(buf, "0x%04x\n", data->fw_checksum);
0577 }
0578
0579 static ssize_t elan_sysfs_read_product_id(struct device *dev,
0580 struct device_attribute *attr,
0581 char *buf)
0582 {
0583 struct i2c_client *client = to_i2c_client(dev);
0584 struct elan_tp_data *data = i2c_get_clientdata(client);
0585
0586 return sprintf(buf, ETP_PRODUCT_ID_FORMAT_STRING "\n",
0587 data->product_id);
0588 }
0589
0590 static ssize_t elan_sysfs_read_fw_ver(struct device *dev,
0591 struct device_attribute *attr,
0592 char *buf)
0593 {
0594 struct i2c_client *client = to_i2c_client(dev);
0595 struct elan_tp_data *data = i2c_get_clientdata(client);
0596
0597 return sprintf(buf, "%d.0\n", data->fw_version);
0598 }
0599
0600 static ssize_t elan_sysfs_read_sm_ver(struct device *dev,
0601 struct device_attribute *attr,
0602 char *buf)
0603 {
0604 struct i2c_client *client = to_i2c_client(dev);
0605 struct elan_tp_data *data = i2c_get_clientdata(client);
0606
0607 return sprintf(buf, "%d.0\n", data->sm_version);
0608 }
0609
0610 static ssize_t elan_sysfs_read_iap_ver(struct device *dev,
0611 struct device_attribute *attr,
0612 char *buf)
0613 {
0614 struct i2c_client *client = to_i2c_client(dev);
0615 struct elan_tp_data *data = i2c_get_clientdata(client);
0616
0617 return sprintf(buf, "%d.0\n", data->iap_version);
0618 }
0619
0620 static ssize_t elan_sysfs_update_fw(struct device *dev,
0621 struct device_attribute *attr,
0622 const char *buf, size_t count)
0623 {
0624 struct elan_tp_data *data = dev_get_drvdata(dev);
0625 const struct firmware *fw;
0626 char *fw_name;
0627 int error;
0628 const u8 *fw_signature;
0629 static const u8 signature[] = {0xAA, 0x55, 0xCC, 0x33, 0xFF, 0xFF};
0630
0631 if (data->fw_validpage_count == 0)
0632 return -EINVAL;
0633
0634
0635 fw_name = kasprintf(GFP_KERNEL, ETP_FW_NAME, data->product_id);
0636 if (!fw_name) {
0637 dev_err(dev, "failed to allocate memory for firmware name\n");
0638 return -ENOMEM;
0639 }
0640
0641 dev_info(dev, "requesting fw '%s'\n", fw_name);
0642 error = request_firmware(&fw, fw_name, dev);
0643 kfree(fw_name);
0644 if (error) {
0645 dev_err(dev, "failed to request firmware: %d\n", error);
0646 return error;
0647 }
0648
0649
0650 fw_signature = &fw->data[data->fw_signature_address];
0651 if (memcmp(fw_signature, signature, sizeof(signature)) != 0) {
0652 dev_err(dev, "signature mismatch (expected %*ph, got %*ph)\n",
0653 (int)sizeof(signature), signature,
0654 (int)sizeof(signature), fw_signature);
0655 error = -EBADF;
0656 goto out_release_fw;
0657 }
0658
0659 error = mutex_lock_interruptible(&data->sysfs_mutex);
0660 if (error)
0661 goto out_release_fw;
0662
0663 error = elan_update_firmware(data, fw);
0664
0665 mutex_unlock(&data->sysfs_mutex);
0666
0667 out_release_fw:
0668 release_firmware(fw);
0669 return error ?: count;
0670 }
0671
0672 static ssize_t calibrate_store(struct device *dev,
0673 struct device_attribute *attr,
0674 const char *buf, size_t count)
0675 {
0676 struct i2c_client *client = to_i2c_client(dev);
0677 struct elan_tp_data *data = i2c_get_clientdata(client);
0678 int tries = 20;
0679 int retval;
0680 int error;
0681 u8 val[ETP_CALIBRATE_MAX_LEN];
0682
0683 retval = mutex_lock_interruptible(&data->sysfs_mutex);
0684 if (retval)
0685 return retval;
0686
0687 disable_irq(client->irq);
0688
0689 data->mode |= ETP_ENABLE_CALIBRATE;
0690 retval = data->ops->set_mode(client, data->mode);
0691 if (retval) {
0692 dev_err(dev, "failed to enable calibration mode: %d\n",
0693 retval);
0694 goto out;
0695 }
0696
0697 retval = data->ops->calibrate(client);
0698 if (retval) {
0699 dev_err(dev, "failed to start calibration: %d\n",
0700 retval);
0701 goto out_disable_calibrate;
0702 }
0703
0704 val[0] = 0xff;
0705 do {
0706
0707 msleep(250);
0708
0709 retval = data->ops->calibrate_result(client, val);
0710 if (retval)
0711 dev_err(dev, "failed to check calibration result: %d\n",
0712 retval);
0713 else if (val[0] == 0)
0714 break;
0715
0716 } while (--tries);
0717
0718 if (tries == 0) {
0719 dev_err(dev, "failed to calibrate. Timeout.\n");
0720 retval = -ETIMEDOUT;
0721 }
0722
0723 out_disable_calibrate:
0724 data->mode &= ~ETP_ENABLE_CALIBRATE;
0725 error = data->ops->set_mode(data->client, data->mode);
0726 if (error) {
0727 dev_err(dev, "failed to disable calibration mode: %d\n",
0728 error);
0729 if (!retval)
0730 retval = error;
0731 }
0732 out:
0733 enable_irq(client->irq);
0734 mutex_unlock(&data->sysfs_mutex);
0735 return retval ?: count;
0736 }
0737
0738 static ssize_t elan_sysfs_read_mode(struct device *dev,
0739 struct device_attribute *attr,
0740 char *buf)
0741 {
0742 struct i2c_client *client = to_i2c_client(dev);
0743 struct elan_tp_data *data = i2c_get_clientdata(client);
0744 int error;
0745 enum tp_mode mode;
0746
0747 error = mutex_lock_interruptible(&data->sysfs_mutex);
0748 if (error)
0749 return error;
0750
0751 error = data->ops->iap_get_mode(data->client, &mode);
0752
0753 mutex_unlock(&data->sysfs_mutex);
0754
0755 if (error)
0756 return error;
0757
0758 return sprintf(buf, "%d\n", (int)mode);
0759 }
0760
0761 static DEVICE_ATTR(product_id, S_IRUGO, elan_sysfs_read_product_id, NULL);
0762 static DEVICE_ATTR(firmware_version, S_IRUGO, elan_sysfs_read_fw_ver, NULL);
0763 static DEVICE_ATTR(sample_version, S_IRUGO, elan_sysfs_read_sm_ver, NULL);
0764 static DEVICE_ATTR(iap_version, S_IRUGO, elan_sysfs_read_iap_ver, NULL);
0765 static DEVICE_ATTR(fw_checksum, S_IRUGO, elan_sysfs_read_fw_checksum, NULL);
0766 static DEVICE_ATTR(mode, S_IRUGO, elan_sysfs_read_mode, NULL);
0767 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, elan_sysfs_update_fw);
0768
0769 static DEVICE_ATTR_WO(calibrate);
0770
0771 static struct attribute *elan_sysfs_entries[] = {
0772 &dev_attr_product_id.attr,
0773 &dev_attr_firmware_version.attr,
0774 &dev_attr_sample_version.attr,
0775 &dev_attr_iap_version.attr,
0776 &dev_attr_fw_checksum.attr,
0777 &dev_attr_calibrate.attr,
0778 &dev_attr_mode.attr,
0779 &dev_attr_update_fw.attr,
0780 NULL,
0781 };
0782
0783 static const struct attribute_group elan_sysfs_group = {
0784 .attrs = elan_sysfs_entries,
0785 };
0786
0787 static ssize_t acquire_store(struct device *dev, struct device_attribute *attr,
0788 const char *buf, size_t count)
0789 {
0790 struct i2c_client *client = to_i2c_client(dev);
0791 struct elan_tp_data *data = i2c_get_clientdata(client);
0792 int error;
0793 int retval;
0794
0795 retval = mutex_lock_interruptible(&data->sysfs_mutex);
0796 if (retval)
0797 return retval;
0798
0799 disable_irq(client->irq);
0800
0801 data->baseline_ready = false;
0802
0803 data->mode |= ETP_ENABLE_CALIBRATE;
0804 retval = data->ops->set_mode(data->client, data->mode);
0805 if (retval) {
0806 dev_err(dev, "Failed to enable calibration mode to get baseline: %d\n",
0807 retval);
0808 goto out;
0809 }
0810
0811 msleep(250);
0812
0813 retval = data->ops->get_baseline_data(data->client, true,
0814 &data->max_baseline);
0815 if (retval) {
0816 dev_err(dev, "Failed to read max baseline form device: %d\n",
0817 retval);
0818 goto out_disable_calibrate;
0819 }
0820
0821 retval = data->ops->get_baseline_data(data->client, false,
0822 &data->min_baseline);
0823 if (retval) {
0824 dev_err(dev, "Failed to read min baseline form device: %d\n",
0825 retval);
0826 goto out_disable_calibrate;
0827 }
0828
0829 data->baseline_ready = true;
0830
0831 out_disable_calibrate:
0832 data->mode &= ~ETP_ENABLE_CALIBRATE;
0833 error = data->ops->set_mode(data->client, data->mode);
0834 if (error) {
0835 dev_err(dev, "Failed to disable calibration mode after acquiring baseline: %d\n",
0836 error);
0837 if (!retval)
0838 retval = error;
0839 }
0840 out:
0841 enable_irq(client->irq);
0842 mutex_unlock(&data->sysfs_mutex);
0843 return retval ?: count;
0844 }
0845
0846 static ssize_t min_show(struct device *dev,
0847 struct device_attribute *attr, char *buf)
0848 {
0849 struct i2c_client *client = to_i2c_client(dev);
0850 struct elan_tp_data *data = i2c_get_clientdata(client);
0851 int retval;
0852
0853 retval = mutex_lock_interruptible(&data->sysfs_mutex);
0854 if (retval)
0855 return retval;
0856
0857 if (!data->baseline_ready) {
0858 retval = -ENODATA;
0859 goto out;
0860 }
0861
0862 retval = snprintf(buf, PAGE_SIZE, "%d", data->min_baseline);
0863
0864 out:
0865 mutex_unlock(&data->sysfs_mutex);
0866 return retval;
0867 }
0868
0869 static ssize_t max_show(struct device *dev,
0870 struct device_attribute *attr, char *buf)
0871 {
0872 struct i2c_client *client = to_i2c_client(dev);
0873 struct elan_tp_data *data = i2c_get_clientdata(client);
0874 int retval;
0875
0876 retval = mutex_lock_interruptible(&data->sysfs_mutex);
0877 if (retval)
0878 return retval;
0879
0880 if (!data->baseline_ready) {
0881 retval = -ENODATA;
0882 goto out;
0883 }
0884
0885 retval = snprintf(buf, PAGE_SIZE, "%d", data->max_baseline);
0886
0887 out:
0888 mutex_unlock(&data->sysfs_mutex);
0889 return retval;
0890 }
0891
0892
0893 static DEVICE_ATTR_WO(acquire);
0894 static DEVICE_ATTR_RO(min);
0895 static DEVICE_ATTR_RO(max);
0896
0897 static struct attribute *elan_baseline_sysfs_entries[] = {
0898 &dev_attr_acquire.attr,
0899 &dev_attr_min.attr,
0900 &dev_attr_max.attr,
0901 NULL,
0902 };
0903
0904 static const struct attribute_group elan_baseline_sysfs_group = {
0905 .name = "baseline",
0906 .attrs = elan_baseline_sysfs_entries,
0907 };
0908
0909 static const struct attribute_group *elan_sysfs_groups[] = {
0910 &elan_sysfs_group,
0911 &elan_baseline_sysfs_group,
0912 NULL
0913 };
0914
0915
0916
0917
0918
0919
0920 static void elan_report_contact(struct elan_tp_data *data, int contact_num,
0921 bool contact_valid, bool high_precision,
0922 u8 *packet, u8 *finger_data)
0923 {
0924 struct input_dev *input = data->input;
0925 unsigned int pos_x, pos_y;
0926 unsigned int pressure, scaled_pressure;
0927
0928 if (contact_valid) {
0929 if (high_precision) {
0930 pos_x = get_unaligned_be16(&finger_data[0]);
0931 pos_y = get_unaligned_be16(&finger_data[2]);
0932 } else {
0933 pos_x = ((finger_data[0] & 0xf0) << 4) | finger_data[1];
0934 pos_y = ((finger_data[0] & 0x0f) << 8) | finger_data[2];
0935 }
0936
0937 if (pos_x > data->max_x || pos_y > data->max_y) {
0938 dev_dbg(input->dev.parent,
0939 "[%d] x=%d y=%d over max (%d, %d)",
0940 contact_num, pos_x, pos_y,
0941 data->max_x, data->max_y);
0942 return;
0943 }
0944
0945 pressure = finger_data[4];
0946 scaled_pressure = pressure + data->pressure_adjustment;
0947 if (scaled_pressure > ETP_MAX_PRESSURE)
0948 scaled_pressure = ETP_MAX_PRESSURE;
0949
0950 input_mt_slot(input, contact_num);
0951 input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
0952 input_report_abs(input, ABS_MT_POSITION_X, pos_x);
0953 input_report_abs(input, ABS_MT_POSITION_Y, data->max_y - pos_y);
0954 input_report_abs(input, ABS_MT_PRESSURE, scaled_pressure);
0955
0956 if (data->report_features & ETP_FEATURE_REPORT_MK) {
0957 unsigned int mk_x, mk_y, area_x, area_y;
0958 u8 mk_data = high_precision ?
0959 packet[ETP_MK_DATA_OFFSET + contact_num] :
0960 finger_data[3];
0961
0962 mk_x = mk_data & 0x0f;
0963 mk_y = mk_data >> 4;
0964
0965
0966
0967
0968
0969 area_x = mk_x * (data->width_x - ETP_FWIDTH_REDUCE);
0970 area_y = mk_y * (data->width_y - ETP_FWIDTH_REDUCE);
0971
0972 input_report_abs(input, ABS_TOOL_WIDTH, mk_x);
0973 input_report_abs(input, ABS_MT_TOUCH_MAJOR,
0974 max(area_x, area_y));
0975 input_report_abs(input, ABS_MT_TOUCH_MINOR,
0976 min(area_x, area_y));
0977 }
0978 } else {
0979 input_mt_slot(input, contact_num);
0980 input_mt_report_slot_inactive(input);
0981 }
0982 }
0983
0984 static void elan_report_absolute(struct elan_tp_data *data, u8 *packet,
0985 bool high_precision)
0986 {
0987 struct input_dev *input = data->input;
0988 u8 *finger_data = &packet[ETP_FINGER_DATA_OFFSET];
0989 int i;
0990 u8 tp_info = packet[ETP_TOUCH_INFO_OFFSET];
0991 u8 hover_info = packet[ETP_HOVER_INFO_OFFSET];
0992 bool contact_valid, hover_event;
0993
0994 pm_wakeup_event(&data->client->dev, 0);
0995
0996 hover_event = hover_info & BIT(6);
0997
0998 for (i = 0; i < ETP_MAX_FINGERS; i++) {
0999 contact_valid = tp_info & BIT(3 + i);
1000 elan_report_contact(data, i, contact_valid, high_precision,
1001 packet, finger_data);
1002 if (contact_valid)
1003 finger_data += ETP_FINGER_DATA_LEN;
1004 }
1005
1006 input_report_key(input, BTN_LEFT, tp_info & BIT(0));
1007 input_report_key(input, BTN_MIDDLE, tp_info & BIT(2));
1008 input_report_key(input, BTN_RIGHT, tp_info & BIT(1));
1009 input_report_abs(input, ABS_DISTANCE, hover_event != 0);
1010 input_mt_report_pointer_emulation(input, true);
1011 input_sync(input);
1012 }
1013
1014 static void elan_report_trackpoint(struct elan_tp_data *data, u8 *report)
1015 {
1016 struct input_dev *input = data->tp_input;
1017 u8 *packet = &report[ETP_REPORT_ID_OFFSET + 1];
1018 int x, y;
1019
1020 pm_wakeup_event(&data->client->dev, 0);
1021
1022 if (!data->tp_input) {
1023 dev_warn_once(&data->client->dev,
1024 "received a trackpoint report while no trackpoint device has been created. Please report upstream.\n");
1025 return;
1026 }
1027
1028 input_report_key(input, BTN_LEFT, packet[0] & 0x01);
1029 input_report_key(input, BTN_RIGHT, packet[0] & 0x02);
1030 input_report_key(input, BTN_MIDDLE, packet[0] & 0x04);
1031
1032 if ((packet[3] & 0x0F) == 0x06) {
1033 x = packet[4] - (int)((packet[1] ^ 0x80) << 1);
1034 y = (int)((packet[2] ^ 0x80) << 1) - packet[5];
1035
1036 input_report_rel(input, REL_X, x);
1037 input_report_rel(input, REL_Y, y);
1038 }
1039
1040 input_sync(input);
1041 }
1042
1043 static irqreturn_t elan_isr(int irq, void *dev_id)
1044 {
1045 struct elan_tp_data *data = dev_id;
1046 int error;
1047 u8 report[ETP_MAX_REPORT_LEN];
1048
1049
1050
1051
1052
1053
1054 if (data->in_fw_update) {
1055 complete(&data->fw_completion);
1056 goto out;
1057 }
1058
1059 error = data->ops->get_report(data->client, report, data->report_len);
1060 if (error)
1061 goto out;
1062
1063 switch (report[ETP_REPORT_ID_OFFSET]) {
1064 case ETP_REPORT_ID:
1065 elan_report_absolute(data, report, false);
1066 break;
1067 case ETP_REPORT_ID2:
1068 elan_report_absolute(data, report, true);
1069 break;
1070 case ETP_TP_REPORT_ID:
1071 case ETP_TP_REPORT_ID2:
1072 elan_report_trackpoint(data, report);
1073 break;
1074 default:
1075 dev_err(&data->client->dev, "invalid report id data (%x)\n",
1076 report[ETP_REPORT_ID_OFFSET]);
1077 }
1078
1079 out:
1080 return IRQ_HANDLED;
1081 }
1082
1083
1084
1085
1086
1087
1088
1089 static int elan_setup_trackpoint_input_device(struct elan_tp_data *data)
1090 {
1091 struct device *dev = &data->client->dev;
1092 struct input_dev *input;
1093
1094 input = devm_input_allocate_device(dev);
1095 if (!input)
1096 return -ENOMEM;
1097
1098 input->name = "Elan TrackPoint";
1099 input->id.bustype = BUS_I2C;
1100 input->id.vendor = ELAN_VENDOR_ID;
1101 input->id.product = data->product_id;
1102 input_set_drvdata(input, data);
1103
1104 input_set_capability(input, EV_REL, REL_X);
1105 input_set_capability(input, EV_REL, REL_Y);
1106 input_set_capability(input, EV_KEY, BTN_LEFT);
1107 input_set_capability(input, EV_KEY, BTN_RIGHT);
1108 input_set_capability(input, EV_KEY, BTN_MIDDLE);
1109
1110 __set_bit(INPUT_PROP_POINTER, input->propbit);
1111 __set_bit(INPUT_PROP_POINTING_STICK, input->propbit);
1112
1113 data->tp_input = input;
1114
1115 return 0;
1116 }
1117
1118 static int elan_setup_input_device(struct elan_tp_data *data)
1119 {
1120 struct device *dev = &data->client->dev;
1121 struct input_dev *input;
1122 unsigned int max_width = max(data->width_x, data->width_y);
1123 unsigned int min_width = min(data->width_x, data->width_y);
1124 int error;
1125
1126 input = devm_input_allocate_device(dev);
1127 if (!input)
1128 return -ENOMEM;
1129
1130 input->name = "Elan Touchpad";
1131 input->id.bustype = BUS_I2C;
1132 input->id.vendor = ELAN_VENDOR_ID;
1133 input->id.product = data->product_id;
1134 input_set_drvdata(input, data);
1135
1136 error = input_mt_init_slots(input, ETP_MAX_FINGERS,
1137 INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
1138 if (error) {
1139 dev_err(dev, "failed to initialize MT slots: %d\n", error);
1140 return error;
1141 }
1142
1143 __set_bit(EV_ABS, input->evbit);
1144 __set_bit(INPUT_PROP_POINTER, input->propbit);
1145 if (data->clickpad) {
1146 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
1147 } else {
1148 __set_bit(BTN_RIGHT, input->keybit);
1149 if (data->middle_button)
1150 __set_bit(BTN_MIDDLE, input->keybit);
1151 }
1152 __set_bit(BTN_LEFT, input->keybit);
1153
1154
1155 input_set_abs_params(input, ABS_X, 0, data->max_x, 0, 0);
1156 input_set_abs_params(input, ABS_Y, 0, data->max_y, 0, 0);
1157 input_abs_set_res(input, ABS_X, data->x_res);
1158 input_abs_set_res(input, ABS_Y, data->y_res);
1159 input_set_abs_params(input, ABS_PRESSURE, 0, ETP_MAX_PRESSURE, 0, 0);
1160 if (data->report_features & ETP_FEATURE_REPORT_MK)
1161 input_set_abs_params(input, ABS_TOOL_WIDTH,
1162 0, ETP_FINGER_WIDTH, 0, 0);
1163 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0);
1164
1165
1166 input_set_abs_params(input, ABS_MT_POSITION_X, 0, data->max_x, 0, 0);
1167 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, data->max_y, 0, 0);
1168 input_abs_set_res(input, ABS_MT_POSITION_X, data->x_res);
1169 input_abs_set_res(input, ABS_MT_POSITION_Y, data->y_res);
1170 input_set_abs_params(input, ABS_MT_PRESSURE, 0,
1171 ETP_MAX_PRESSURE, 0, 0);
1172 if (data->report_features & ETP_FEATURE_REPORT_MK) {
1173 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR,
1174 0, ETP_FINGER_WIDTH * max_width, 0, 0);
1175 input_set_abs_params(input, ABS_MT_TOUCH_MINOR,
1176 0, ETP_FINGER_WIDTH * min_width, 0, 0);
1177 }
1178
1179 data->input = input;
1180
1181 return 0;
1182 }
1183
1184 static void elan_disable_regulator(void *_data)
1185 {
1186 struct elan_tp_data *data = _data;
1187
1188 regulator_disable(data->vcc);
1189 }
1190
1191 static int elan_probe(struct i2c_client *client,
1192 const struct i2c_device_id *dev_id)
1193 {
1194 const struct elan_transport_ops *transport_ops;
1195 struct device *dev = &client->dev;
1196 struct elan_tp_data *data;
1197 unsigned long irqflags;
1198 int error;
1199
1200 if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_I2C) &&
1201 i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1202 transport_ops = &elan_i2c_ops;
1203 } else if (IS_ENABLED(CONFIG_MOUSE_ELAN_I2C_SMBUS) &&
1204 i2c_check_functionality(client->adapter,
1205 I2C_FUNC_SMBUS_BYTE_DATA |
1206 I2C_FUNC_SMBUS_BLOCK_DATA |
1207 I2C_FUNC_SMBUS_I2C_BLOCK)) {
1208 transport_ops = &elan_smbus_ops;
1209 } else {
1210 dev_err(dev, "not a supported I2C/SMBus adapter\n");
1211 return -EIO;
1212 }
1213
1214 data = devm_kzalloc(dev, sizeof(struct elan_tp_data), GFP_KERNEL);
1215 if (!data)
1216 return -ENOMEM;
1217
1218 i2c_set_clientdata(client, data);
1219
1220 data->ops = transport_ops;
1221 data->client = client;
1222 init_completion(&data->fw_completion);
1223 mutex_init(&data->sysfs_mutex);
1224
1225 data->vcc = devm_regulator_get(dev, "vcc");
1226 if (IS_ERR(data->vcc)) {
1227 error = PTR_ERR(data->vcc);
1228 if (error != -EPROBE_DEFER)
1229 dev_err(dev, "Failed to get 'vcc' regulator: %d\n",
1230 error);
1231 return error;
1232 }
1233
1234 error = regulator_enable(data->vcc);
1235 if (error) {
1236 dev_err(dev, "Failed to enable regulator: %d\n", error);
1237 return error;
1238 }
1239
1240 error = devm_add_action_or_reset(dev, elan_disable_regulator, data);
1241 if (error) {
1242 dev_err(dev, "Failed to add disable regulator action: %d\n",
1243 error);
1244 return error;
1245 }
1246
1247
1248 error = i2c_smbus_read_byte(client);
1249 if (error < 0) {
1250 dev_dbg(&client->dev, "nothing at this address: %d\n", error);
1251 return -ENXIO;
1252 }
1253
1254
1255 error = elan_initialize(data, false);
1256 if (error)
1257 return error;
1258
1259 error = elan_query_device_info(data);
1260 if (error)
1261 return error;
1262
1263 error = elan_query_device_parameters(data);
1264 if (error)
1265 return error;
1266
1267 dev_info(dev,
1268 "Elan Touchpad: Module ID: 0x%04x, Firmware: 0x%04x, Sample: 0x%04x, IAP: 0x%04x\n",
1269 data->product_id,
1270 data->fw_version,
1271 data->sm_version,
1272 data->iap_version);
1273
1274 dev_dbg(dev,
1275 "Elan Touchpad Extra Information:\n"
1276 " Max ABS X,Y: %d,%d\n"
1277 " Width X,Y: %d,%d\n"
1278 " Resolution X,Y: %d,%d (dots/mm)\n"
1279 " ic type: 0x%x\n"
1280 " info pattern: 0x%x\n",
1281 data->max_x, data->max_y,
1282 data->width_x, data->width_y,
1283 data->x_res, data->y_res,
1284 data->ic_type, data->pattern);
1285
1286
1287 error = elan_setup_input_device(data);
1288 if (error)
1289 return error;
1290
1291 if (device_property_read_bool(&client->dev, "elan,trackpoint")) {
1292 error = elan_setup_trackpoint_input_device(data);
1293 if (error)
1294 return error;
1295 }
1296
1297
1298
1299
1300
1301
1302 irqflags = irq_get_trigger_type(client->irq);
1303 if (!irqflags)
1304 irqflags = IRQF_TRIGGER_FALLING;
1305
1306 error = devm_request_threaded_irq(dev, client->irq, NULL, elan_isr,
1307 irqflags | IRQF_ONESHOT,
1308 client->name, data);
1309 if (error) {
1310 dev_err(dev, "cannot register irq=%d\n", client->irq);
1311 return error;
1312 }
1313
1314 error = devm_device_add_groups(dev, elan_sysfs_groups);
1315 if (error) {
1316 dev_err(dev, "failed to create sysfs attributes: %d\n", error);
1317 return error;
1318 }
1319
1320 error = input_register_device(data->input);
1321 if (error) {
1322 dev_err(dev, "failed to register input device: %d\n", error);
1323 return error;
1324 }
1325
1326 if (data->tp_input) {
1327 error = input_register_device(data->tp_input);
1328 if (error) {
1329 dev_err(&client->dev,
1330 "failed to register TrackPoint input device: %d\n",
1331 error);
1332 return error;
1333 }
1334 }
1335
1336
1337
1338
1339
1340 if (!dev->of_node)
1341 device_init_wakeup(dev, true);
1342
1343 return 0;
1344 }
1345
1346 static int __maybe_unused elan_suspend(struct device *dev)
1347 {
1348 struct i2c_client *client = to_i2c_client(dev);
1349 struct elan_tp_data *data = i2c_get_clientdata(client);
1350 int ret;
1351
1352
1353
1354
1355
1356
1357 ret = mutex_lock_interruptible(&data->sysfs_mutex);
1358 if (ret)
1359 return ret;
1360
1361 disable_irq(client->irq);
1362
1363 if (device_may_wakeup(dev)) {
1364 ret = elan_sleep(data);
1365
1366 data->irq_wake = (enable_irq_wake(client->irq) == 0);
1367 } else {
1368 ret = elan_set_power(data, false);
1369 if (ret)
1370 goto err;
1371
1372 ret = regulator_disable(data->vcc);
1373 if (ret) {
1374 dev_err(dev, "error %d disabling regulator\n", ret);
1375
1376 elan_set_power(data, true);
1377 }
1378 }
1379
1380 err:
1381 mutex_unlock(&data->sysfs_mutex);
1382 return ret;
1383 }
1384
1385 static int __maybe_unused elan_resume(struct device *dev)
1386 {
1387 struct i2c_client *client = to_i2c_client(dev);
1388 struct elan_tp_data *data = i2c_get_clientdata(client);
1389 int error;
1390
1391 if (!device_may_wakeup(dev)) {
1392 error = regulator_enable(data->vcc);
1393 if (error) {
1394 dev_err(dev, "error %d enabling regulator\n", error);
1395 goto err;
1396 }
1397 } else if (data->irq_wake) {
1398 disable_irq_wake(client->irq);
1399 data->irq_wake = false;
1400 }
1401
1402 error = elan_set_power(data, true);
1403 if (error) {
1404 dev_err(dev, "power up when resuming failed: %d\n", error);
1405 goto err;
1406 }
1407
1408 error = elan_initialize(data, data->quirks & ETP_QUIRK_QUICK_WAKEUP);
1409 if (error)
1410 dev_err(dev, "initialize when resuming failed: %d\n", error);
1411
1412 err:
1413 enable_irq(data->client->irq);
1414 return error;
1415 }
1416
1417 static SIMPLE_DEV_PM_OPS(elan_pm_ops, elan_suspend, elan_resume);
1418
1419 static const struct i2c_device_id elan_id[] = {
1420 { DRIVER_NAME, 0 },
1421 { },
1422 };
1423 MODULE_DEVICE_TABLE(i2c, elan_id);
1424
1425 #ifdef CONFIG_ACPI
1426 #include <linux/input/elan-i2c-ids.h>
1427 MODULE_DEVICE_TABLE(acpi, elan_acpi_id);
1428 #endif
1429
1430 #ifdef CONFIG_OF
1431 static const struct of_device_id elan_of_match[] = {
1432 { .compatible = "elan,ekth3000" },
1433 { }
1434 };
1435 MODULE_DEVICE_TABLE(of, elan_of_match);
1436 #endif
1437
1438 static struct i2c_driver elan_driver = {
1439 .driver = {
1440 .name = DRIVER_NAME,
1441 .pm = &elan_pm_ops,
1442 .acpi_match_table = ACPI_PTR(elan_acpi_id),
1443 .of_match_table = of_match_ptr(elan_of_match),
1444 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1445 },
1446 .probe = elan_probe,
1447 .id_table = elan_id,
1448 };
1449
1450 module_i2c_driver(elan_driver);
1451
1452 MODULE_AUTHOR("Duson Lin <dusonlin@emc.com.tw>");
1453 MODULE_DESCRIPTION("Elan I2C/SMBus Touchpad driver");
1454 MODULE_LICENSE("GPL");