1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HID driver for Lenovo:
4 * - ThinkPad USB Keyboard with TrackPoint (tpkbd)
5 * - ThinkPad Compact Bluetooth Keyboard with TrackPoint (cptkbd)
6 * - ThinkPad Compact USB Keyboard with TrackPoint (cptkbd)
8 * Copyright (c) 2012 Bernhard Seibold
9 * Copyright (c) 2014 Jamie Lentin <jm@lentin.co.uk>
11 * Linux IBM/Lenovo Scrollpoint mouse driver:
12 * - IBM Scrollpoint III
13 * - IBM Scrollpoint Pro
14 * - IBM Scrollpoint Optical
15 * - IBM Scrollpoint Optical 800dpi
16 * - IBM Scrollpoint Optical 800dpi Pro
17 * - Lenovo Scrollpoint Optical
19 * Copyright (c) 2012 Peter De Wachter <pdewacht@gmail.com>
20 * Copyright (c) 2018 Peter Ganzhorn <peter.ganzhorn@gmail.com>
26 #include <linux/module.h>
27 #include <linux/sysfs.h>
28 #include <linux/device.h>
29 #include <linux/hid.h>
30 #include <linux/input.h>
31 #include <linux/leds.h>
32 #include <linux/workqueue.h>
36 /* Userspace expects F20 for mic-mute KEY_MICMUTE does not work */
37 #define LENOVO_KEY_MICMUTE KEY_F20
39 struct lenovo_drvdata {
40 u8 led_report[3]; /* Must be first for proper alignment */
42 struct mutex led_report_mutex;
43 struct led_classdev led_mute;
44 struct led_classdev led_micmute;
45 struct work_struct fn_lock_sync_work;
46 struct hid_device *hdev;
49 int release_to_select;
53 u8 middlebutton_state; /* 0:Up, 1:Down (undecided), 2:Scrolling */
57 #define map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
59 #define TP10UBKBD_LED_OUTPUT_REPORT 9
61 #define TP10UBKBD_FN_LOCK_LED 0x54
62 #define TP10UBKBD_MUTE_LED 0x64
63 #define TP10UBKBD_MICMUTE_LED 0x74
65 #define TP10UBKBD_LED_OFF 1
66 #define TP10UBKBD_LED_ON 2
68 static int lenovo_led_set_tp10ubkbd(struct hid_device *hdev, u8 led_code,
69 enum led_brightness value)
71 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
74 mutex_lock(&data->led_report_mutex);
76 data->led_report[0] = TP10UBKBD_LED_OUTPUT_REPORT;
77 data->led_report[1] = led_code;
78 data->led_report[2] = value ? TP10UBKBD_LED_ON : TP10UBKBD_LED_OFF;
79 ret = hid_hw_raw_request(hdev, data->led_report[0], data->led_report, 3,
80 HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
83 hid_err(hdev, "Set LED output report error: %d\n", ret);
85 ret = ret < 0 ? ret : -EIO;
90 mutex_unlock(&data->led_report_mutex);
95 static void lenovo_tp10ubkbd_sync_fn_lock(struct work_struct *work)
97 struct lenovo_drvdata *data =
98 container_of(work, struct lenovo_drvdata, fn_lock_sync_work);
100 lenovo_led_set_tp10ubkbd(data->hdev, TP10UBKBD_FN_LOCK_LED,
104 static const __u8 lenovo_pro_dock_need_fixup_collection[] = {
105 0x05, 0x88, /* Usage Page (Vendor Usage Page 0x88) */
106 0x09, 0x01, /* Usage (Vendor Usage 0x01) */
107 0xa1, 0x01, /* Collection (Application) */
108 0x85, 0x04, /* Report ID (4) */
109 0x19, 0x00, /* Usage Minimum (0) */
110 0x2a, 0xff, 0xff, /* Usage Maximum (65535) */
113 static __u8 *lenovo_report_fixup(struct hid_device *hdev, __u8 *rdesc,
116 switch (hdev->product) {
117 case USB_DEVICE_ID_LENOVO_TPPRODOCK:
118 /* the fixups that need to be done:
119 * - get a reasonable usage max for the vendor collection
120 * 0x8801 from the report ID 4
123 memcmp(&rdesc[140], lenovo_pro_dock_need_fixup_collection,
124 sizeof(lenovo_pro_dock_need_fixup_collection)) == 0) {
133 static int lenovo_input_mapping_tpkbd(struct hid_device *hdev,
134 struct hid_input *hi, struct hid_field *field,
135 struct hid_usage *usage, unsigned long **bit, int *max)
137 if (usage->hid == (HID_UP_BUTTON | 0x0010)) {
138 /* This sub-device contains trackpoint, mark it */
139 hid_set_drvdata(hdev, (void *)1);
140 map_key_clear(LENOVO_KEY_MICMUTE);
146 static int lenovo_input_mapping_cptkbd(struct hid_device *hdev,
147 struct hid_input *hi, struct hid_field *field,
148 struct hid_usage *usage, unsigned long **bit, int *max)
150 /* HID_UP_LNVENDOR = USB, HID_UP_MSVENDOR = BT */
151 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR ||
152 (usage->hid & HID_USAGE_PAGE) == HID_UP_LNVENDOR) {
153 switch (usage->hid & HID_USAGE) {
154 case 0x00f1: /* Fn-F4: Mic mute */
155 map_key_clear(LENOVO_KEY_MICMUTE);
157 case 0x00f2: /* Fn-F5: Brightness down */
158 map_key_clear(KEY_BRIGHTNESSDOWN);
160 case 0x00f3: /* Fn-F6: Brightness up */
161 map_key_clear(KEY_BRIGHTNESSUP);
163 case 0x00f4: /* Fn-F7: External display (projector) */
164 map_key_clear(KEY_SWITCHVIDEOMODE);
166 case 0x00f5: /* Fn-F8: Wireless */
167 map_key_clear(KEY_WLAN);
169 case 0x00f6: /* Fn-F9: Control panel */
170 map_key_clear(KEY_CONFIG);
172 case 0x00f8: /* Fn-F11: View open applications (3 boxes) */
173 map_key_clear(KEY_SCALE);
175 case 0x00f9: /* Fn-F12: Open My computer (6 boxes) USB-only */
176 /* NB: This mapping is invented in raw_event below */
177 map_key_clear(KEY_FILE);
179 case 0x00fa: /* Fn-Esc: Fn-lock toggle */
180 map_key_clear(KEY_FN_ESC);
182 case 0x00fb: /* Middle mouse button (in native mode) */
183 map_key_clear(BTN_MIDDLE);
188 /* Compatibility middle/wheel mappings should be ignored */
189 if (usage->hid == HID_GD_WHEEL)
191 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON &&
192 (usage->hid & HID_USAGE) == 0x003)
194 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER &&
195 (usage->hid & HID_USAGE) == 0x238)
198 /* Map wheel emulation reports: 0xffa1 = USB, 0xff10 = BT */
199 if ((usage->hid & HID_USAGE_PAGE) == 0xff100000 ||
200 (usage->hid & HID_USAGE_PAGE) == 0xffa10000) {
201 field->flags |= HID_MAIN_ITEM_RELATIVE | HID_MAIN_ITEM_VARIABLE;
202 field->logical_minimum = -127;
203 field->logical_maximum = 127;
205 switch (usage->hid & HID_USAGE) {
207 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
210 hid_map_usage(hi, usage, bit, max, EV_REL, REL_WHEEL);
220 static int lenovo_input_mapping_scrollpoint(struct hid_device *hdev,
221 struct hid_input *hi, struct hid_field *field,
222 struct hid_usage *usage, unsigned long **bit, int *max)
224 if (usage->hid == HID_GD_Z) {
225 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
231 static int lenovo_input_mapping_tp10_ultrabook_kbd(struct hid_device *hdev,
232 struct hid_input *hi, struct hid_field *field,
233 struct hid_usage *usage, unsigned long **bit, int *max)
236 * The ThinkPad 10 Ultrabook Keyboard uses 0x000c0001 usage for
237 * a bunch of keys which have no standard consumer page code.
239 if (usage->hid == 0x000c0001) {
240 switch (usage->usage_index) {
241 case 8: /* Fn-Esc: Fn-lock toggle */
242 map_key_clear(KEY_FN_ESC);
244 case 9: /* Fn-F4: Mic mute */
245 map_key_clear(LENOVO_KEY_MICMUTE);
247 case 10: /* Fn-F7: Control panel */
248 map_key_clear(KEY_CONFIG);
250 case 11: /* Fn-F8: Search (magnifier glass) */
251 map_key_clear(KEY_SEARCH);
253 case 12: /* Fn-F10: Open My computer (6 boxes) */
254 map_key_clear(KEY_FILE);
260 * The Ultrabook Keyboard sends a spurious F23 key-press when resuming
261 * from suspend and it does not actually have a F23 key, ignore it.
263 if (usage->hid == 0x00070072)
269 static int lenovo_input_mapping_x1_tab_kbd(struct hid_device *hdev,
270 struct hid_input *hi, struct hid_field *field,
271 struct hid_usage *usage, unsigned long **bit, int *max)
274 * The ThinkPad X1 Tablet Thin Keyboard uses 0x000c0001 usage for
275 * a bunch of keys which have no standard consumer page code.
277 if (usage->hid == 0x000c0001) {
278 switch (usage->usage_index) {
279 case 0: /* Fn-F10: Enable/disable bluetooth */
280 map_key_clear(KEY_BLUETOOTH);
282 case 1: /* Fn-F11: Keyboard settings */
283 map_key_clear(KEY_KEYBOARD);
285 case 2: /* Fn-F12: User function / Cortana */
286 map_key_clear(KEY_MACRO1);
288 case 3: /* Fn-PrtSc: Snipping tool */
289 map_key_clear(KEY_SELECTIVE_SCREENSHOT);
291 case 8: /* Fn-Esc: Fn-lock toggle */
292 map_key_clear(KEY_FN_ESC);
294 case 9: /* Fn-F4: Mute/unmute microphone */
295 map_key_clear(KEY_MICMUTE);
297 case 10: /* Fn-F9: Settings */
298 map_key_clear(KEY_CONFIG);
300 case 13: /* Fn-F7: Manage external displays */
301 map_key_clear(KEY_SWITCHVIDEOMODE);
303 case 14: /* Fn-F8: Enable/disable wifi */
304 map_key_clear(KEY_WLAN);
309 if (usage->hid == (HID_UP_KEYBOARD | 0x009a)) {
310 map_key_clear(KEY_SYSRQ);
317 static int lenovo_input_mapping(struct hid_device *hdev,
318 struct hid_input *hi, struct hid_field *field,
319 struct hid_usage *usage, unsigned long **bit, int *max)
321 switch (hdev->product) {
322 case USB_DEVICE_ID_LENOVO_TPKBD:
323 return lenovo_input_mapping_tpkbd(hdev, hi, field,
325 case USB_DEVICE_ID_LENOVO_CUSBKBD:
326 case USB_DEVICE_ID_LENOVO_CBTKBD:
327 return lenovo_input_mapping_cptkbd(hdev, hi, field,
329 case USB_DEVICE_ID_IBM_SCROLLPOINT_III:
330 case USB_DEVICE_ID_IBM_SCROLLPOINT_PRO:
331 case USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL:
332 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL:
333 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO:
334 case USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL:
335 return lenovo_input_mapping_scrollpoint(hdev, hi, field,
337 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
338 return lenovo_input_mapping_tp10_ultrabook_kbd(hdev, hi, field,
340 case USB_DEVICE_ID_LENOVO_X1_TAB:
341 return lenovo_input_mapping_x1_tab_kbd(hdev, hi, field, usage, bit, max);
349 /* Send a config command to the keyboard */
350 static int lenovo_send_cmd_cptkbd(struct hid_device *hdev,
351 unsigned char byte2, unsigned char byte3)
356 buf = kzalloc(3, GFP_KERNEL);
364 switch (hdev->product) {
365 case USB_DEVICE_ID_LENOVO_CUSBKBD:
366 ret = hid_hw_raw_request(hdev, 0x13, buf, 3,
367 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
369 case USB_DEVICE_ID_LENOVO_CBTKBD:
370 ret = hid_hw_output_report(hdev, buf, 3);
379 return ret < 0 ? ret : 0; /* BT returns 0, USB returns sizeof(buf) */
382 static void lenovo_features_set_cptkbd(struct hid_device *hdev)
385 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
387 ret = lenovo_send_cmd_cptkbd(hdev, 0x05, cptkbd_data->fn_lock);
389 hid_err(hdev, "Fn-lock setting failed: %d\n", ret);
391 ret = lenovo_send_cmd_cptkbd(hdev, 0x02, cptkbd_data->sensitivity);
393 hid_err(hdev, "Sensitivity setting failed: %d\n", ret);
396 static ssize_t attr_fn_lock_show(struct device *dev,
397 struct device_attribute *attr,
400 struct hid_device *hdev = to_hid_device(dev);
401 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
403 return snprintf(buf, PAGE_SIZE, "%u\n", data->fn_lock);
406 static ssize_t attr_fn_lock_store(struct device *dev,
407 struct device_attribute *attr,
411 struct hid_device *hdev = to_hid_device(dev);
412 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
415 if (kstrtoint(buf, 10, &value))
417 if (value < 0 || value > 1)
420 data->fn_lock = !!value;
422 switch (hdev->product) {
423 case USB_DEVICE_ID_LENOVO_CUSBKBD:
424 case USB_DEVICE_ID_LENOVO_CBTKBD:
425 lenovo_features_set_cptkbd(hdev);
427 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
428 case USB_DEVICE_ID_LENOVO_X1_TAB:
429 ret = lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, value);
438 static ssize_t attr_sensitivity_show_cptkbd(struct device *dev,
439 struct device_attribute *attr,
442 struct hid_device *hdev = to_hid_device(dev);
443 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
445 return snprintf(buf, PAGE_SIZE, "%u\n",
446 cptkbd_data->sensitivity);
449 static ssize_t attr_sensitivity_store_cptkbd(struct device *dev,
450 struct device_attribute *attr,
454 struct hid_device *hdev = to_hid_device(dev);
455 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
458 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
461 cptkbd_data->sensitivity = value;
462 lenovo_features_set_cptkbd(hdev);
468 static struct device_attribute dev_attr_fn_lock =
469 __ATTR(fn_lock, S_IWUSR | S_IRUGO,
473 static struct device_attribute dev_attr_sensitivity_cptkbd =
474 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
475 attr_sensitivity_show_cptkbd,
476 attr_sensitivity_store_cptkbd);
479 static struct attribute *lenovo_attributes_cptkbd[] = {
480 &dev_attr_fn_lock.attr,
481 &dev_attr_sensitivity_cptkbd.attr,
485 static const struct attribute_group lenovo_attr_group_cptkbd = {
486 .attrs = lenovo_attributes_cptkbd,
489 static int lenovo_raw_event(struct hid_device *hdev,
490 struct hid_report *report, u8 *data, int size)
493 * Compact USB keyboard's Fn-F12 report holds down many other keys, and
494 * its own key is outside the usage page range. Remove extra
495 * keypresses and remap to inside usage page.
497 if (unlikely(hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
501 && data[2] == 0x01)) {
509 static int lenovo_event_tp10ubkbd(struct hid_device *hdev,
510 struct hid_field *field, struct hid_usage *usage, __s32 value)
512 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
514 if (usage->type == EV_KEY && usage->code == KEY_FN_ESC && value == 1) {
516 * The user has toggled the Fn-lock state. Toggle our own
517 * cached value of it and sync our value to the keyboard to
518 * ensure things are in sync (the sycning should be a no-op).
520 data->fn_lock = !data->fn_lock;
521 schedule_work(&data->fn_lock_sync_work);
527 static int lenovo_event_cptkbd(struct hid_device *hdev,
528 struct hid_field *field, struct hid_usage *usage, __s32 value)
530 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
532 /* "wheel" scroll events */
533 if (usage->type == EV_REL && (usage->code == REL_WHEEL ||
534 usage->code == REL_HWHEEL)) {
535 /* Scroll events disable middle-click event */
536 cptkbd_data->middlebutton_state = 2;
540 /* Middle click events */
541 if (usage->type == EV_KEY && usage->code == BTN_MIDDLE) {
543 cptkbd_data->middlebutton_state = 1;
544 } else if (value == 0) {
545 if (cptkbd_data->middlebutton_state == 1) {
546 /* No scrolling inbetween, send middle-click */
547 input_event(field->hidinput->input,
548 EV_KEY, BTN_MIDDLE, 1);
549 input_sync(field->hidinput->input);
550 input_event(field->hidinput->input,
551 EV_KEY, BTN_MIDDLE, 0);
552 input_sync(field->hidinput->input);
554 cptkbd_data->middlebutton_state = 0;
562 static int lenovo_event(struct hid_device *hdev, struct hid_field *field,
563 struct hid_usage *usage, __s32 value)
565 if (!hid_get_drvdata(hdev))
568 switch (hdev->product) {
569 case USB_DEVICE_ID_LENOVO_CUSBKBD:
570 case USB_DEVICE_ID_LENOVO_CBTKBD:
571 return lenovo_event_cptkbd(hdev, field, usage, value);
572 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
573 case USB_DEVICE_ID_LENOVO_X1_TAB:
574 return lenovo_event_tp10ubkbd(hdev, field, usage, value);
580 static int lenovo_features_set_tpkbd(struct hid_device *hdev)
582 struct hid_report *report;
583 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
585 report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[4];
587 report->field[0]->value[0] = data_pointer->press_to_select ? 0x01 : 0x02;
588 report->field[0]->value[0] |= data_pointer->dragging ? 0x04 : 0x08;
589 report->field[0]->value[0] |= data_pointer->release_to_select ? 0x10 : 0x20;
590 report->field[0]->value[0] |= data_pointer->select_right ? 0x80 : 0x40;
591 report->field[1]->value[0] = 0x03; // unknown setting, imitate windows driver
592 report->field[2]->value[0] = data_pointer->sensitivity;
593 report->field[3]->value[0] = data_pointer->press_speed;
595 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
599 static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,
600 struct device_attribute *attr,
603 struct hid_device *hdev = to_hid_device(dev);
604 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
606 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->press_to_select);
609 static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,
610 struct device_attribute *attr,
614 struct hid_device *hdev = to_hid_device(dev);
615 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
618 if (kstrtoint(buf, 10, &value))
620 if (value < 0 || value > 1)
623 data_pointer->press_to_select = value;
624 lenovo_features_set_tpkbd(hdev);
629 static ssize_t attr_dragging_show_tpkbd(struct device *dev,
630 struct device_attribute *attr,
633 struct hid_device *hdev = to_hid_device(dev);
634 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
636 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->dragging);
639 static ssize_t attr_dragging_store_tpkbd(struct device *dev,
640 struct device_attribute *attr,
644 struct hid_device *hdev = to_hid_device(dev);
645 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
648 if (kstrtoint(buf, 10, &value))
650 if (value < 0 || value > 1)
653 data_pointer->dragging = value;
654 lenovo_features_set_tpkbd(hdev);
659 static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,
660 struct device_attribute *attr,
663 struct hid_device *hdev = to_hid_device(dev);
664 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
666 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->release_to_select);
669 static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,
670 struct device_attribute *attr,
674 struct hid_device *hdev = to_hid_device(dev);
675 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
678 if (kstrtoint(buf, 10, &value))
680 if (value < 0 || value > 1)
683 data_pointer->release_to_select = value;
684 lenovo_features_set_tpkbd(hdev);
689 static ssize_t attr_select_right_show_tpkbd(struct device *dev,
690 struct device_attribute *attr,
693 struct hid_device *hdev = to_hid_device(dev);
694 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
696 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->select_right);
699 static ssize_t attr_select_right_store_tpkbd(struct device *dev,
700 struct device_attribute *attr,
704 struct hid_device *hdev = to_hid_device(dev);
705 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
708 if (kstrtoint(buf, 10, &value))
710 if (value < 0 || value > 1)
713 data_pointer->select_right = value;
714 lenovo_features_set_tpkbd(hdev);
719 static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,
720 struct device_attribute *attr,
723 struct hid_device *hdev = to_hid_device(dev);
724 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
726 return snprintf(buf, PAGE_SIZE, "%u\n",
727 data_pointer->sensitivity);
730 static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,
731 struct device_attribute *attr,
735 struct hid_device *hdev = to_hid_device(dev);
736 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
739 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
742 data_pointer->sensitivity = value;
743 lenovo_features_set_tpkbd(hdev);
748 static ssize_t attr_press_speed_show_tpkbd(struct device *dev,
749 struct device_attribute *attr,
752 struct hid_device *hdev = to_hid_device(dev);
753 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
755 return snprintf(buf, PAGE_SIZE, "%u\n",
756 data_pointer->press_speed);
759 static ssize_t attr_press_speed_store_tpkbd(struct device *dev,
760 struct device_attribute *attr,
764 struct hid_device *hdev = to_hid_device(dev);
765 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
768 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
771 data_pointer->press_speed = value;
772 lenovo_features_set_tpkbd(hdev);
777 static struct device_attribute dev_attr_press_to_select_tpkbd =
778 __ATTR(press_to_select, S_IWUSR | S_IRUGO,
779 attr_press_to_select_show_tpkbd,
780 attr_press_to_select_store_tpkbd);
782 static struct device_attribute dev_attr_dragging_tpkbd =
783 __ATTR(dragging, S_IWUSR | S_IRUGO,
784 attr_dragging_show_tpkbd,
785 attr_dragging_store_tpkbd);
787 static struct device_attribute dev_attr_release_to_select_tpkbd =
788 __ATTR(release_to_select, S_IWUSR | S_IRUGO,
789 attr_release_to_select_show_tpkbd,
790 attr_release_to_select_store_tpkbd);
792 static struct device_attribute dev_attr_select_right_tpkbd =
793 __ATTR(select_right, S_IWUSR | S_IRUGO,
794 attr_select_right_show_tpkbd,
795 attr_select_right_store_tpkbd);
797 static struct device_attribute dev_attr_sensitivity_tpkbd =
798 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
799 attr_sensitivity_show_tpkbd,
800 attr_sensitivity_store_tpkbd);
802 static struct device_attribute dev_attr_press_speed_tpkbd =
803 __ATTR(press_speed, S_IWUSR | S_IRUGO,
804 attr_press_speed_show_tpkbd,
805 attr_press_speed_store_tpkbd);
807 static struct attribute *lenovo_attributes_tpkbd[] = {
808 &dev_attr_press_to_select_tpkbd.attr,
809 &dev_attr_dragging_tpkbd.attr,
810 &dev_attr_release_to_select_tpkbd.attr,
811 &dev_attr_select_right_tpkbd.attr,
812 &dev_attr_sensitivity_tpkbd.attr,
813 &dev_attr_press_speed_tpkbd.attr,
817 static const struct attribute_group lenovo_attr_group_tpkbd = {
818 .attrs = lenovo_attributes_tpkbd,
821 static void lenovo_led_set_tpkbd(struct hid_device *hdev)
823 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
824 struct hid_report *report;
826 report = hdev->report_enum[HID_OUTPUT_REPORT].report_id_hash[3];
827 report->field[0]->value[0] = (data_pointer->led_state >> 0) & 1;
828 report->field[0]->value[1] = (data_pointer->led_state >> 1) & 1;
829 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
832 static int lenovo_led_brightness_set(struct led_classdev *led_cdev,
833 enum led_brightness value)
835 struct device *dev = led_cdev->dev->parent;
836 struct hid_device *hdev = to_hid_device(dev);
837 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
838 u8 tp10ubkbd_led[] = { TP10UBKBD_MUTE_LED, TP10UBKBD_MICMUTE_LED };
842 if (led_cdev == &data_pointer->led_micmute)
845 if (value == LED_OFF)
846 data_pointer->led_state &= ~(1 << led_nr);
848 data_pointer->led_state |= 1 << led_nr;
850 switch (hdev->product) {
851 case USB_DEVICE_ID_LENOVO_TPKBD:
852 lenovo_led_set_tpkbd(hdev);
854 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
855 case USB_DEVICE_ID_LENOVO_X1_TAB:
856 ret = lenovo_led_set_tp10ubkbd(hdev, tp10ubkbd_led[led_nr], value);
863 static int lenovo_register_leds(struct hid_device *hdev)
865 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
866 size_t name_sz = strlen(dev_name(&hdev->dev)) + 16;
867 char *name_mute, *name_micm;
870 name_mute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
871 name_micm = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
872 if (name_mute == NULL || name_micm == NULL) {
873 hid_err(hdev, "Could not allocate memory for led data\n");
876 snprintf(name_mute, name_sz, "%s:amber:mute", dev_name(&hdev->dev));
877 snprintf(name_micm, name_sz, "%s:amber:micmute", dev_name(&hdev->dev));
879 data->led_mute.name = name_mute;
880 data->led_mute.default_trigger = "audio-mute";
881 data->led_mute.brightness_set_blocking = lenovo_led_brightness_set;
882 data->led_mute.max_brightness = 1;
883 data->led_mute.flags = LED_HW_PLUGGABLE;
884 data->led_mute.dev = &hdev->dev;
885 ret = led_classdev_register(&hdev->dev, &data->led_mute);
889 data->led_micmute.name = name_micm;
890 data->led_micmute.default_trigger = "audio-micmute";
891 data->led_micmute.brightness_set_blocking = lenovo_led_brightness_set;
892 data->led_micmute.max_brightness = 1;
893 data->led_micmute.flags = LED_HW_PLUGGABLE;
894 data->led_micmute.dev = &hdev->dev;
895 ret = led_classdev_register(&hdev->dev, &data->led_micmute);
897 led_classdev_unregister(&data->led_mute);
904 static int lenovo_probe_tpkbd(struct hid_device *hdev)
906 struct lenovo_drvdata *data_pointer;
910 * Only register extra settings against subdevice where input_mapping
911 * set drvdata to 1, i.e. the trackpoint.
913 if (!hid_get_drvdata(hdev))
916 hid_set_drvdata(hdev, NULL);
918 /* Validate required reports. */
919 for (i = 0; i < 4; i++) {
920 if (!hid_validate_values(hdev, HID_FEATURE_REPORT, 4, i, 1))
923 if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, 3, 0, 2))
926 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
928 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
930 data_pointer = devm_kzalloc(&hdev->dev,
931 sizeof(struct lenovo_drvdata),
933 if (data_pointer == NULL) {
934 hid_err(hdev, "Could not allocate memory for driver data\n");
939 // set same default values as windows driver
940 data_pointer->sensitivity = 0xa0;
941 data_pointer->press_speed = 0x38;
943 hid_set_drvdata(hdev, data_pointer);
945 ret = lenovo_register_leds(hdev);
949 lenovo_features_set_tpkbd(hdev);
953 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
957 static int lenovo_probe_cptkbd(struct hid_device *hdev)
960 struct lenovo_drvdata *cptkbd_data;
962 /* All the custom action happens on the USBMOUSE device for USB */
963 if (hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
964 && hdev->type != HID_TYPE_USBMOUSE) {
965 hid_dbg(hdev, "Ignoring keyboard half of device\n");
969 cptkbd_data = devm_kzalloc(&hdev->dev,
970 sizeof(*cptkbd_data),
972 if (cptkbd_data == NULL) {
973 hid_err(hdev, "can't alloc keyboard descriptor\n");
976 hid_set_drvdata(hdev, cptkbd_data);
979 * Tell the keyboard a driver understands it, and turn F7, F9, F11 into
982 ret = lenovo_send_cmd_cptkbd(hdev, 0x01, 0x03);
984 hid_warn(hdev, "Failed to switch F7/9/11 mode: %d\n", ret);
986 /* Switch middle button to native mode */
987 ret = lenovo_send_cmd_cptkbd(hdev, 0x09, 0x01);
989 hid_warn(hdev, "Failed to switch middle button: %d\n", ret);
991 /* Set keyboard settings to known state */
992 cptkbd_data->middlebutton_state = 0;
993 cptkbd_data->fn_lock = true;
994 cptkbd_data->sensitivity = 0x05;
995 lenovo_features_set_cptkbd(hdev);
997 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_cptkbd);
999 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
1004 static struct attribute *lenovo_attributes_tp10ubkbd[] = {
1005 &dev_attr_fn_lock.attr,
1009 static const struct attribute_group lenovo_attr_group_tp10ubkbd = {
1010 .attrs = lenovo_attributes_tp10ubkbd,
1013 static int lenovo_probe_tp10ubkbd(struct hid_device *hdev)
1015 struct hid_report_enum *rep_enum;
1016 struct lenovo_drvdata *data;
1017 struct hid_report *rep;
1022 * The LEDs and the Fn-lock functionality use output report 9,
1023 * with an application of 0xffa0001, add the LEDs on the interface
1024 * with this output report.
1027 rep_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
1028 list_for_each_entry(rep, &rep_enum->report_list, list) {
1029 if (rep->application == 0xffa00001)
1035 data = devm_kzalloc(&hdev->dev, sizeof(*data), GFP_KERNEL);
1039 mutex_init(&data->led_report_mutex);
1040 INIT_WORK(&data->fn_lock_sync_work, lenovo_tp10ubkbd_sync_fn_lock);
1043 hid_set_drvdata(hdev, data);
1046 * The Thinkpad 10 ultrabook USB kbd dock's Fn-lock defaults to on.
1047 * We cannot read the state, only set it, so we force it to on here
1048 * (which should be a no-op) to make sure that our state matches the
1049 * keyboard's FN-lock state. This is the same as what Windows does.
1051 data->fn_lock = true;
1052 lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, data->fn_lock);
1054 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1058 ret = lenovo_register_leds(hdev);
1064 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1068 static int lenovo_probe(struct hid_device *hdev,
1069 const struct hid_device_id *id)
1073 ret = hid_parse(hdev);
1075 hid_err(hdev, "hid_parse failed\n");
1079 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1081 hid_err(hdev, "hid_hw_start failed\n");
1085 switch (hdev->product) {
1086 case USB_DEVICE_ID_LENOVO_TPKBD:
1087 ret = lenovo_probe_tpkbd(hdev);
1089 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1090 case USB_DEVICE_ID_LENOVO_CBTKBD:
1091 ret = lenovo_probe_cptkbd(hdev);
1093 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1094 case USB_DEVICE_ID_LENOVO_X1_TAB:
1095 ret = lenovo_probe_tp10ubkbd(hdev);
1111 static void lenovo_remove_tpkbd(struct hid_device *hdev)
1113 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1116 * Only the trackpoint half of the keyboard has drvdata and stuff that
1117 * needs unregistering.
1119 if (data_pointer == NULL)
1122 sysfs_remove_group(&hdev->dev.kobj,
1123 &lenovo_attr_group_tpkbd);
1125 led_classdev_unregister(&data_pointer->led_micmute);
1126 led_classdev_unregister(&data_pointer->led_mute);
1129 static void lenovo_remove_cptkbd(struct hid_device *hdev)
1131 sysfs_remove_group(&hdev->dev.kobj,
1132 &lenovo_attr_group_cptkbd);
1135 static void lenovo_remove_tp10ubkbd(struct hid_device *hdev)
1137 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
1142 led_classdev_unregister(&data->led_micmute);
1143 led_classdev_unregister(&data->led_mute);
1145 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1146 cancel_work_sync(&data->fn_lock_sync_work);
1149 static void lenovo_remove(struct hid_device *hdev)
1151 switch (hdev->product) {
1152 case USB_DEVICE_ID_LENOVO_TPKBD:
1153 lenovo_remove_tpkbd(hdev);
1155 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1156 case USB_DEVICE_ID_LENOVO_CBTKBD:
1157 lenovo_remove_cptkbd(hdev);
1159 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1160 case USB_DEVICE_ID_LENOVO_X1_TAB:
1161 lenovo_remove_tp10ubkbd(hdev);
1168 static int lenovo_input_configured(struct hid_device *hdev,
1169 struct hid_input *hi)
1171 switch (hdev->product) {
1172 case USB_DEVICE_ID_LENOVO_TPKBD:
1173 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1174 case USB_DEVICE_ID_LENOVO_CBTKBD:
1175 if (test_bit(EV_REL, hi->input->evbit)) {
1176 /* set only for trackpoint device */
1177 __set_bit(INPUT_PROP_POINTER, hi->input->propbit);
1178 __set_bit(INPUT_PROP_POINTING_STICK,
1179 hi->input->propbit);
1188 static const struct hid_device_id lenovo_devices[] = {
1189 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },
1190 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CUSBKBD) },
1191 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CBTKBD) },
1192 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPPRODOCK) },
1193 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_III) },
1194 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_PRO) },
1195 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL) },
1196 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL) },
1197 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO) },
1198 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL) },
1199 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TP10UBKBD) },
1201 * Note bind to the HID_GROUP_GENERIC group, so that we only bind to the keyboard
1202 * part, while letting hid-multitouch.c handle the touchpad and trackpoint.
1204 { HID_DEVICE(BUS_USB, HID_GROUP_GENERIC,
1205 USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_TAB) },
1209 MODULE_DEVICE_TABLE(hid, lenovo_devices);
1211 static struct hid_driver lenovo_driver = {
1213 .id_table = lenovo_devices,
1214 .input_configured = lenovo_input_configured,
1215 .input_mapping = lenovo_input_mapping,
1216 .probe = lenovo_probe,
1217 .remove = lenovo_remove,
1218 .raw_event = lenovo_raw_event,
1219 .event = lenovo_event,
1220 .report_fixup = lenovo_report_fixup,
1222 module_hid_driver(lenovo_driver);
1224 MODULE_LICENSE("GPL");