1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * HID Driver for ELAN Touchpad 4 * 5 * Currently only supports touchpad found on HP Pavilion X2 10 6 * 7 * Copyright (c) 2016 Alexandrov Stanislav <neko@nya.ai> 8 */ 9 10 #include <linux/hid.h> 11 #include <linux/input/mt.h> 12 #include <linux/leds.h> 13 #include <linux/module.h> 14 #include <linux/usb.h> 15 16 #include "hid-ids.h" 17 18 #define ELAN_MT_I2C 0x5d 19 #define ELAN_SINGLE_FINGER 0x81 20 #define ELAN_MT_FIRST_FINGER 0x82 21 #define ELAN_MT_SECOND_FINGER 0x83 22 #define ELAN_INPUT_REPORT_SIZE 8 23 #define ELAN_I2C_REPORT_SIZE 32 24 #define ELAN_FINGER_DATA_LEN 5 25 #define ELAN_MAX_FINGERS 5 26 #define ELAN_MAX_PRESSURE 255 27 #define ELAN_TP_USB_INTF 1 28 29 #define ELAN_FEATURE_REPORT 0x0d 30 #define ELAN_FEATURE_SIZE 5 31 #define ELAN_PARAM_MAX_X 6 32 #define ELAN_PARAM_MAX_Y 7 33 #define ELAN_PARAM_RES 8 34 35 #define ELAN_MUTE_LED_REPORT 0xBC 36 #define ELAN_LED_REPORT_SIZE 8 37 38 #define ELAN_HAS_LED BIT(0) 39 40 struct elan_drvdata { 41 struct input_dev *input; 42 u8 prev_report[ELAN_INPUT_REPORT_SIZE]; 43 struct led_classdev mute_led; 44 u8 mute_led_state; 45 u16 max_x; 46 u16 max_y; 47 u16 res_x; 48 u16 res_y; 49 }; 50 51 static int is_not_elan_touchpad(struct hid_device *hdev) 52 { 53 if (hdev->bus == BUS_USB) { 54 struct usb_interface *intf = to_usb_interface(hdev->dev.parent); 55 56 return (intf->altsetting->desc.bInterfaceNumber != 57 ELAN_TP_USB_INTF); 58 } 59 60 return 0; 61 } 62 63 static int elan_input_mapping(struct hid_device *hdev, struct hid_input *hi, 64 struct hid_field *field, struct hid_usage *usage, 65 unsigned long **bit, int *max) 66 { 67 if (is_not_elan_touchpad(hdev)) 68 return 0; 69 70 if (field->report->id == ELAN_SINGLE_FINGER || 71 field->report->id == ELAN_MT_FIRST_FINGER || 72 field->report->id == ELAN_MT_SECOND_FINGER || 73 field->report->id == ELAN_MT_I2C) 74 return -1; 75 76 return 0; 77 } 78 79 static int elan_get_device_param(struct hid_device *hdev, 80 unsigned char *dmabuf, unsigned char param) 81 { 82 int ret; 83 84 dmabuf[0] = ELAN_FEATURE_REPORT; 85 dmabuf[1] = 0x05; 86 dmabuf[2] = 0x03; 87 dmabuf[3] = param; 88 dmabuf[4] = 0x01; 89 90 ret = hid_hw_raw_request(hdev, ELAN_FEATURE_REPORT, dmabuf, 91 ELAN_FEATURE_SIZE, HID_FEATURE_REPORT, 92 HID_REQ_SET_REPORT); 93 if (ret != ELAN_FEATURE_SIZE) { 94 hid_err(hdev, "Set report error for parm %d: %d\n", param, ret); 95 return ret; 96 } 97 98 ret = hid_hw_raw_request(hdev, ELAN_FEATURE_REPORT, dmabuf, 99 ELAN_FEATURE_SIZE, HID_FEATURE_REPORT, 100 HID_REQ_GET_REPORT); 101 if (ret != ELAN_FEATURE_SIZE) { 102 hid_err(hdev, "Get report error for parm %d: %d\n", param, ret); 103 return ret; 104 } 105 106 return 0; 107 } 108 109 static unsigned int elan_convert_res(char val) 110 { 111 /* 112 * (value from firmware) * 10 + 790 = dpi 113 * dpi * 10 / 254 = dots/mm 114 */ 115 return (val * 10 + 790) * 10 / 254; 116 } 117 118 static int elan_get_device_params(struct hid_device *hdev) 119 { 120 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 121 unsigned char *dmabuf; 122 int ret; 123 124 dmabuf = kmalloc(ELAN_FEATURE_SIZE, GFP_KERNEL); 125 if (!dmabuf) 126 return -ENOMEM; 127 128 ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_MAX_X); 129 if (ret) 130 goto err; 131 132 drvdata->max_x = (dmabuf[4] << 8) | dmabuf[3]; 133 134 ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_MAX_Y); 135 if (ret) 136 goto err; 137 138 drvdata->max_y = (dmabuf[4] << 8) | dmabuf[3]; 139 140 ret = elan_get_device_param(hdev, dmabuf, ELAN_PARAM_RES); 141 if (ret) 142 goto err; 143 144 drvdata->res_x = elan_convert_res(dmabuf[3]); 145 drvdata->res_y = elan_convert_res(dmabuf[4]); 146 147 err: 148 kfree(dmabuf); 149 return ret; 150 } 151 152 static int elan_input_configured(struct hid_device *hdev, struct hid_input *hi) 153 { 154 int ret; 155 struct input_dev *input; 156 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 157 158 if (is_not_elan_touchpad(hdev)) 159 return 0; 160 161 ret = elan_get_device_params(hdev); 162 if (ret) 163 return ret; 164 165 input = devm_input_allocate_device(&hdev->dev); 166 if (!input) 167 return -ENOMEM; 168 169 input->name = "Elan Touchpad"; 170 input->phys = hdev->phys; 171 input->uniq = hdev->uniq; 172 input->id.bustype = hdev->bus; 173 input->id.vendor = hdev->vendor; 174 input->id.product = hdev->product; 175 input->id.version = hdev->version; 176 input->dev.parent = &hdev->dev; 177 178 input_set_abs_params(input, ABS_MT_POSITION_X, 0, drvdata->max_x, 179 0, 0); 180 input_set_abs_params(input, ABS_MT_POSITION_Y, 0, drvdata->max_y, 181 0, 0); 182 input_set_abs_params(input, ABS_MT_PRESSURE, 0, ELAN_MAX_PRESSURE, 183 0, 0); 184 185 __set_bit(BTN_LEFT, input->keybit); 186 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit); 187 188 ret = input_mt_init_slots(input, ELAN_MAX_FINGERS, INPUT_MT_POINTER); 189 if (ret) { 190 hid_err(hdev, "Failed to init elan MT slots: %d\n", ret); 191 input_free_device(input); 192 return ret; 193 } 194 195 input_abs_set_res(input, ABS_X, drvdata->res_x); 196 input_abs_set_res(input, ABS_Y, drvdata->res_y); 197 198 ret = input_register_device(input); 199 if (ret) { 200 hid_err(hdev, "Failed to register elan input device: %d\n", 201 ret); 202 input_mt_destroy_slots(input); 203 input_free_device(input); 204 return ret; 205 } 206 207 drvdata->input = input; 208 209 return 0; 210 } 211 212 static void elan_report_mt_slot(struct elan_drvdata *drvdata, u8 *data, 213 unsigned int slot_num) 214 { 215 struct input_dev *input = drvdata->input; 216 int x, y, p; 217 218 bool active = !!data; 219 220 input_mt_slot(input, slot_num); 221 input_mt_report_slot_state(input, MT_TOOL_FINGER, active); 222 if (active) { 223 x = ((data[0] & 0xF0) << 4) | data[1]; 224 y = drvdata->max_y - 225 (((data[0] & 0x07) << 8) | data[2]); 226 p = data[4]; 227 228 input_report_abs(input, ABS_MT_POSITION_X, x); 229 input_report_abs(input, ABS_MT_POSITION_Y, y); 230 input_report_abs(input, ABS_MT_PRESSURE, p); 231 } 232 } 233 234 static void elan_usb_report_input(struct elan_drvdata *drvdata, u8 *data) 235 { 236 int i; 237 struct input_dev *input = drvdata->input; 238 239 /* 240 * There is 3 types of reports: for single touch, 241 * for multitouch - first finger and for multitouch - second finger 242 * 243 * packet structure for ELAN_SINGLE_FINGER and ELAN_MT_FIRST_FINGER: 244 * 245 * byte 1: 1 0 0 0 0 0 0 1 // 0x81 or 0x82 246 * byte 2: 0 0 0 0 0 0 0 0 // looks like unused 247 * byte 3: f5 f4 f3 f2 f1 0 0 L 248 * byte 4: x12 x11 x10 x9 0? y11 y10 y9 249 * byte 5: x8 x7 x6 x5 x4 x3 x2 x1 250 * byte 6: y8 y7 y6 y5 y4 y3 y2 y1 251 * byte 7: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1 252 * byte 8: p8 p7 p6 p5 p4 p3 p2 p1 253 * 254 * packet structure for ELAN_MT_SECOND_FINGER: 255 * 256 * byte 1: 1 0 0 0 0 0 1 1 // 0x83 257 * byte 2: x12 x11 x10 x9 0 y11 y10 y9 258 * byte 3: x8 x7 x6 x5 x4 x3 x2 x1 259 * byte 4: y8 y7 y6 y5 y4 y3 y2 y1 260 * byte 5: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1 261 * byte 6: p8 p7 p6 p5 p4 p3 p2 p1 262 * byte 7: 0 0 0 0 0 0 0 0 263 * byte 8: 0 0 0 0 0 0 0 0 264 * 265 * f5-f1: finger touch bits 266 * L: clickpad button 267 * sy / sx: finger width / height expressed in traces, the total number 268 * of traces can be queried by doing a HID_REQ_SET_REPORT 269 * { 0x0d, 0x05, 0x03, 0x05, 0x01 } followed by a GET, in the 270 * returned buf, buf[3]=no-x-traces, buf[4]=no-y-traces. 271 * p: pressure 272 */ 273 274 if (data[0] == ELAN_SINGLE_FINGER) { 275 for (i = 0; i < ELAN_MAX_FINGERS; i++) { 276 if (data[2] & BIT(i + 3)) 277 elan_report_mt_slot(drvdata, data + 3, i); 278 else 279 elan_report_mt_slot(drvdata, NULL, i); 280 } 281 input_report_key(input, BTN_LEFT, data[2] & 0x01); 282 } 283 /* 284 * When touched with two fingers Elan touchpad will emit two HID reports 285 * first is ELAN_MT_FIRST_FINGER and second is ELAN_MT_SECOND_FINGER 286 * we will save ELAN_MT_FIRST_FINGER report and wait for 287 * ELAN_MT_SECOND_FINGER to finish multitouch 288 */ 289 if (data[0] == ELAN_MT_FIRST_FINGER) { 290 memcpy(drvdata->prev_report, data, 291 sizeof(drvdata->prev_report)); 292 return; 293 } 294 295 if (data[0] == ELAN_MT_SECOND_FINGER) { 296 int first = 0; 297 u8 *prev_report = drvdata->prev_report; 298 299 if (prev_report[0] != ELAN_MT_FIRST_FINGER) 300 return; 301 302 for (i = 0; i < ELAN_MAX_FINGERS; i++) { 303 if (prev_report[2] & BIT(i + 3)) { 304 if (!first) { 305 first = 1; 306 elan_report_mt_slot(drvdata, prev_report + 3, i); 307 } else { 308 elan_report_mt_slot(drvdata, data + 1, i); 309 } 310 } else { 311 elan_report_mt_slot(drvdata, NULL, i); 312 } 313 } 314 input_report_key(input, BTN_LEFT, prev_report[2] & 0x01); 315 } 316 317 input_mt_sync_frame(input); 318 input_sync(input); 319 } 320 321 static void elan_i2c_report_input(struct elan_drvdata *drvdata, u8 *data) 322 { 323 struct input_dev *input = drvdata->input; 324 u8 *finger_data; 325 int i; 326 327 /* 328 * Elan MT touchpads in i2c mode send finger data in the same format 329 * as in USB mode, but then with all fingers in a single packet. 330 * 331 * packet structure for ELAN_MT_I2C: 332 * 333 * byte 1: 1 0 0 1 1 1 0 1 // 0x5d 334 * byte 2: f5 f4 f3 f2 f1 0 0 L 335 * byte 3: x12 x11 x10 x9 0? y11 y10 y9 336 * byte 4: x8 x7 x6 x5 x4 x3 x2 x1 337 * byte 5: y8 y7 y6 y5 y4 y3 y2 y1 338 * byte 6: sy4 sy3 sy2 sy1 sx4 sx3 sx2 sx1 339 * byte 7: p8 p7 p6 p5 p4 p3 p2 p1 340 * byte 8-12: Same as byte 3-7 for second finger down 341 * byte 13-17: Same as byte 3-7 for third finger down 342 * byte 18-22: Same as byte 3-7 for fourth finger down 343 * byte 23-27: Same as byte 3-7 for fifth finger down 344 */ 345 346 finger_data = data + 2; 347 for (i = 0; i < ELAN_MAX_FINGERS; i++) { 348 if (data[1] & BIT(i + 3)) { 349 elan_report_mt_slot(drvdata, finger_data, i); 350 finger_data += ELAN_FINGER_DATA_LEN; 351 } else { 352 elan_report_mt_slot(drvdata, NULL, i); 353 } 354 } 355 356 input_report_key(input, BTN_LEFT, data[1] & 0x01); 357 input_mt_sync_frame(input); 358 input_sync(input); 359 } 360 361 static int elan_raw_event(struct hid_device *hdev, 362 struct hid_report *report, u8 *data, int size) 363 { 364 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 365 366 if (is_not_elan_touchpad(hdev)) 367 return 0; 368 369 if (data[0] == ELAN_SINGLE_FINGER || 370 data[0] == ELAN_MT_FIRST_FINGER || 371 data[0] == ELAN_MT_SECOND_FINGER) { 372 if (size == ELAN_INPUT_REPORT_SIZE) { 373 elan_usb_report_input(drvdata, data); 374 return 1; 375 } 376 } 377 378 if (data[0] == ELAN_MT_I2C && size == ELAN_I2C_REPORT_SIZE) { 379 elan_i2c_report_input(drvdata, data); 380 return 1; 381 } 382 383 return 0; 384 } 385 386 static int elan_start_multitouch(struct hid_device *hdev) 387 { 388 int ret; 389 390 /* 391 * This byte sequence will enable multitouch mode and disable 392 * mouse emulation 393 */ 394 static const unsigned char buf[] = { 0x0D, 0x00, 0x03, 0x21, 0x00 }; 395 unsigned char *dmabuf = kmemdup(buf, sizeof(buf), GFP_KERNEL); 396 397 if (!dmabuf) 398 return -ENOMEM; 399 400 ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, sizeof(buf), 401 HID_FEATURE_REPORT, HID_REQ_SET_REPORT); 402 403 kfree(dmabuf); 404 405 if (ret != sizeof(buf)) { 406 hid_err(hdev, "Failed to start multitouch: %d\n", ret); 407 return ret; 408 } 409 410 return 0; 411 } 412 413 static enum led_brightness elan_mute_led_get_brigtness(struct led_classdev *led_cdev) 414 { 415 struct device *dev = led_cdev->dev->parent; 416 struct hid_device *hdev = to_hid_device(dev); 417 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 418 419 return drvdata->mute_led_state; 420 } 421 422 static int elan_mute_led_set_brigtness(struct led_classdev *led_cdev, 423 enum led_brightness value) 424 { 425 int ret; 426 u8 led_state; 427 struct device *dev = led_cdev->dev->parent; 428 struct hid_device *hdev = to_hid_device(dev); 429 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 430 431 unsigned char *dmabuf = kzalloc(ELAN_LED_REPORT_SIZE, GFP_KERNEL); 432 433 if (!dmabuf) 434 return -ENOMEM; 435 436 led_state = !!value; 437 438 dmabuf[0] = ELAN_MUTE_LED_REPORT; 439 dmabuf[1] = 0x02; 440 dmabuf[2] = led_state; 441 442 ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, ELAN_LED_REPORT_SIZE, 443 HID_FEATURE_REPORT, HID_REQ_SET_REPORT); 444 445 kfree(dmabuf); 446 447 if (ret != ELAN_LED_REPORT_SIZE) { 448 hid_err(hdev, "Failed to set mute led brightness: %d\n", ret); 449 return ret; 450 } 451 452 drvdata->mute_led_state = led_state; 453 return 0; 454 } 455 456 static int elan_init_mute_led(struct hid_device *hdev) 457 { 458 struct elan_drvdata *drvdata = hid_get_drvdata(hdev); 459 struct led_classdev *mute_led = &drvdata->mute_led; 460 461 mute_led->name = "elan:red:mute"; 462 mute_led->brightness_get = elan_mute_led_get_brigtness; 463 mute_led->brightness_set_blocking = elan_mute_led_set_brigtness; 464 mute_led->max_brightness = LED_ON; 465 mute_led->dev = &hdev->dev; 466 467 return devm_led_classdev_register(&hdev->dev, mute_led); 468 } 469 470 static int elan_probe(struct hid_device *hdev, const struct hid_device_id *id) 471 { 472 int ret; 473 struct elan_drvdata *drvdata; 474 475 drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL); 476 477 if (!drvdata) 478 return -ENOMEM; 479 480 hid_set_drvdata(hdev, drvdata); 481 482 ret = hid_parse(hdev); 483 if (ret) { 484 hid_err(hdev, "Hid Parse failed\n"); 485 return ret; 486 } 487 488 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); 489 if (ret) { 490 hid_err(hdev, "Hid hw start failed\n"); 491 return ret; 492 } 493 494 if (is_not_elan_touchpad(hdev)) 495 return 0; 496 497 if (!drvdata->input) { 498 hid_err(hdev, "Input device is not registered\n"); 499 ret = -ENAVAIL; 500 goto err; 501 } 502 503 ret = elan_start_multitouch(hdev); 504 if (ret) 505 goto err; 506 507 if (id->driver_data & ELAN_HAS_LED) { 508 ret = elan_init_mute_led(hdev); 509 if (ret) 510 goto err; 511 } 512 513 return 0; 514 err: 515 hid_hw_stop(hdev); 516 return ret; 517 } 518 519 static void elan_remove(struct hid_device *hdev) 520 { 521 hid_hw_stop(hdev); 522 } 523 524 static const struct hid_device_id elan_devices[] = { 525 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_HP_X2), 526 .driver_data = ELAN_HAS_LED }, 527 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_HP_X2_10_COVER), 528 .driver_data = ELAN_HAS_LED }, 529 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_TOSHIBA_CLICK_L9W) }, 530 { } 531 }; 532 MODULE_DEVICE_TABLE(hid, elan_devices); 533 534 static struct hid_driver elan_driver = { 535 .name = "elan", 536 .id_table = elan_devices, 537 .input_mapping = elan_input_mapping, 538 .input_configured = elan_input_configured, 539 .raw_event = elan_raw_event, 540 .probe = elan_probe, 541 .remove = elan_remove, 542 }; 543 544 module_hid_driver(elan_driver); 545 546 MODULE_LICENSE("GPL"); 547 MODULE_AUTHOR("Alexandrov Stanislav"); 548 MODULE_DESCRIPTION("Driver for HID ELAN Touchpads"); 549