Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
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)
7 * - ThinkPad TrackPoint Keyboard II USB/Bluetooth (cptkbd/tpIIkbd)
8 *
9 * Copyright (c) 2012 Bernhard Seibold
10 * Copyright (c) 2014 Jamie Lentin <jm@lentin.co.uk>
11 *
12 * Linux IBM/Lenovo Scrollpoint mouse driver:
13 * - IBM Scrollpoint III
14 * - IBM Scrollpoint Pro
15 * - IBM Scrollpoint Optical
16 * - IBM Scrollpoint Optical 800dpi
17 * - IBM Scrollpoint Optical 800dpi Pro
18 * - Lenovo Scrollpoint Optical
19 *
20 * Copyright (c) 2012 Peter De Wachter <pdewacht@gmail.com>
21 * Copyright (c) 2018 Peter Ganzhorn <peter.ganzhorn@gmail.com>
22 */
23
24/*
25 */
26
27#include <linux/module.h>
28#include <linux/sysfs.h>
29#include <linux/device.h>
30#include <linux/hid.h>
31#include <linux/input.h>
32#include <linux/leds.h>
33#include <linux/workqueue.h>
34
35#include "hid-ids.h"
36
37/* Userspace expects F20 for mic-mute KEY_MICMUTE does not work */
38#define LENOVO_KEY_MICMUTE KEY_F20
39
40struct lenovo_drvdata {
41 u8 led_report[3]; /* Must be first for proper alignment */
42 int led_state;
43 struct mutex led_report_mutex;
44 struct led_classdev led_mute;
45 struct led_classdev led_micmute;
46 struct work_struct fn_lock_sync_work;
47 struct hid_device *hdev;
48 int press_to_select;
49 int dragging;
50 int release_to_select;
51 int select_right;
52 int sensitivity;
53 int press_speed;
54 /* 0: Up
55 * 1: Down (undecided)
56 * 2: Scrolling
57 * 3: Patched firmware, disable workaround
58 */
59 u8 middlebutton_state;
60 bool fn_lock;
61};
62
63#define map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
64
65#define TP10UBKBD_LED_OUTPUT_REPORT 9
66
67#define TP10UBKBD_FN_LOCK_LED 0x54
68#define TP10UBKBD_MUTE_LED 0x64
69#define TP10UBKBD_MICMUTE_LED 0x74
70
71#define TP10UBKBD_LED_OFF 1
72#define TP10UBKBD_LED_ON 2
73
74static int lenovo_led_set_tp10ubkbd(struct hid_device *hdev, u8 led_code,
75 enum led_brightness value)
76{
77 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
78 int ret;
79
80 mutex_lock(&data->led_report_mutex);
81
82 data->led_report[0] = TP10UBKBD_LED_OUTPUT_REPORT;
83 data->led_report[1] = led_code;
84 data->led_report[2] = value ? TP10UBKBD_LED_ON : TP10UBKBD_LED_OFF;
85 ret = hid_hw_raw_request(hdev, data->led_report[0], data->led_report, 3,
86 HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
87 if (ret != 3) {
88 if (ret != -ENODEV)
89 hid_err(hdev, "Set LED output report error: %d\n", ret);
90
91 ret = ret < 0 ? ret : -EIO;
92 } else {
93 ret = 0;
94 }
95
96 mutex_unlock(&data->led_report_mutex);
97
98 return ret;
99}
100
101static void lenovo_tp10ubkbd_sync_fn_lock(struct work_struct *work)
102{
103 struct lenovo_drvdata *data =
104 container_of(work, struct lenovo_drvdata, fn_lock_sync_work);
105
106 lenovo_led_set_tp10ubkbd(data->hdev, TP10UBKBD_FN_LOCK_LED,
107 data->fn_lock);
108}
109
110static const __u8 lenovo_pro_dock_need_fixup_collection[] = {
111 0x05, 0x88, /* Usage Page (Vendor Usage Page 0x88) */
112 0x09, 0x01, /* Usage (Vendor Usage 0x01) */
113 0xa1, 0x01, /* Collection (Application) */
114 0x85, 0x04, /* Report ID (4) */
115 0x19, 0x00, /* Usage Minimum (0) */
116 0x2a, 0xff, 0xff, /* Usage Maximum (65535) */
117};
118
119/* Broken ThinkPad TrackPoint II collection (Bluetooth mode) */
120static const __u8 lenovo_tpIIbtkbd_need_fixup_collection[] = {
121 0x06, 0x00, 0xFF, /* Usage Page (Vendor Defined 0xFF00) */
122 0x09, 0x01, /* Usage (0x01) */
123 0xA1, 0x01, /* Collection (Application) */
124 0x85, 0x05, /* Report ID (5) */
125 0x1A, 0xF1, 0x00, /* Usage Minimum (0xF1) */
126 0x2A, 0xFC, 0x00, /* Usage Maximum (0xFC) */
127 0x15, 0x00, /* Logical Minimum (0) */
128 0x25, 0x01, /* Logical Maximum (1) */
129 0x75, 0x01, /* Report Size (1) */
130 0x95, 0x0D, /* Report Count (13) */
131 0x81, 0x02, /* Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) */
132 0x95, 0x03, /* Report Count (3) */
133 0x81, 0x01, /* Input (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position) */
134};
135
136static __u8 *lenovo_report_fixup(struct hid_device *hdev, __u8 *rdesc,
137 unsigned int *rsize)
138{
139 switch (hdev->product) {
140 case USB_DEVICE_ID_LENOVO_TPPRODOCK:
141 /* the fixups that need to be done:
142 * - get a reasonable usage max for the vendor collection
143 * 0x8801 from the report ID 4
144 */
145 if (*rsize >= 153 &&
146 memcmp(&rdesc[140], lenovo_pro_dock_need_fixup_collection,
147 sizeof(lenovo_pro_dock_need_fixup_collection)) == 0) {
148 rdesc[151] = 0x01;
149 rdesc[152] = 0x00;
150 }
151 break;
152 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
153 if (*rsize >= 263 &&
154 memcmp(&rdesc[234], lenovo_tpIIbtkbd_need_fixup_collection,
155 sizeof(lenovo_tpIIbtkbd_need_fixup_collection)) == 0) {
156 rdesc[244] = 0x00; /* usage minimum = 0x00 */
157 rdesc[247] = 0xff; /* usage maximum = 0xff */
158 rdesc[252] = 0xff; /* logical maximum = 0xff */
159 rdesc[254] = 0x08; /* report size = 0x08 */
160 rdesc[256] = 0x01; /* report count = 0x01 */
161 rdesc[258] = 0x00; /* input = 0x00 */
162 rdesc[260] = 0x01; /* report count (2) = 0x01 */
163 }
164 break;
165 }
166 return rdesc;
167}
168
169static int lenovo_input_mapping_tpkbd(struct hid_device *hdev,
170 struct hid_input *hi, struct hid_field *field,
171 struct hid_usage *usage, unsigned long **bit, int *max)
172{
173 if (usage->hid == (HID_UP_BUTTON | 0x0010)) {
174 /* This sub-device contains trackpoint, mark it */
175 hid_set_drvdata(hdev, (void *)1);
176 map_key_clear(LENOVO_KEY_MICMUTE);
177 return 1;
178 }
179 return 0;
180}
181
182static int lenovo_input_mapping_cptkbd(struct hid_device *hdev,
183 struct hid_input *hi, struct hid_field *field,
184 struct hid_usage *usage, unsigned long **bit, int *max)
185{
186 /* HID_UP_LNVENDOR = USB, HID_UP_MSVENDOR = BT */
187 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR ||
188 (usage->hid & HID_USAGE_PAGE) == HID_UP_LNVENDOR) {
189 switch (usage->hid & HID_USAGE) {
190 case 0x00f1: /* Fn-F4: Mic mute */
191 map_key_clear(LENOVO_KEY_MICMUTE);
192 return 1;
193 case 0x00f2: /* Fn-F5: Brightness down */
194 map_key_clear(KEY_BRIGHTNESSDOWN);
195 return 1;
196 case 0x00f3: /* Fn-F6: Brightness up */
197 map_key_clear(KEY_BRIGHTNESSUP);
198 return 1;
199 case 0x00f4: /* Fn-F7: External display (projector) */
200 map_key_clear(KEY_SWITCHVIDEOMODE);
201 return 1;
202 case 0x00f5: /* Fn-F8: Wireless */
203 map_key_clear(KEY_WLAN);
204 return 1;
205 case 0x00f6: /* Fn-F9: Control panel */
206 map_key_clear(KEY_CONFIG);
207 return 1;
208 case 0x00f8: /* Fn-F11: View open applications (3 boxes) */
209 map_key_clear(KEY_SCALE);
210 return 1;
211 case 0x00f9: /* Fn-F12: Open My computer (6 boxes) USB-only */
212 /* NB: This mapping is invented in raw_event below */
213 map_key_clear(KEY_FILE);
214 return 1;
215 case 0x00fa: /* Fn-Esc: Fn-lock toggle */
216 map_key_clear(KEY_FN_ESC);
217 return 1;
218 case 0x00fb: /* Middle mouse button (in native mode) */
219 map_key_clear(BTN_MIDDLE);
220 return 1;
221 }
222 }
223
224 /* Compatibility middle/wheel mappings should be ignored */
225 if (usage->hid == HID_GD_WHEEL)
226 return -1;
227 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON &&
228 (usage->hid & HID_USAGE) == 0x003)
229 return -1;
230 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER &&
231 (usage->hid & HID_USAGE) == 0x238)
232 return -1;
233
234 /* Map wheel emulation reports: 0xffa1 = USB, 0xff10 = BT */
235 if ((usage->hid & HID_USAGE_PAGE) == 0xff100000 ||
236 (usage->hid & HID_USAGE_PAGE) == 0xffa10000) {
237 field->flags |= HID_MAIN_ITEM_RELATIVE | HID_MAIN_ITEM_VARIABLE;
238 field->logical_minimum = -127;
239 field->logical_maximum = 127;
240
241 switch (usage->hid & HID_USAGE) {
242 case 0x0000:
243 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
244 return 1;
245 case 0x0001:
246 hid_map_usage(hi, usage, bit, max, EV_REL, REL_WHEEL);
247 return 1;
248 default:
249 return -1;
250 }
251 }
252
253 return 0;
254}
255
256static int lenovo_input_mapping_tpIIkbd(struct hid_device *hdev,
257 struct hid_input *hi, struct hid_field *field,
258 struct hid_usage *usage, unsigned long **bit, int *max)
259{
260 /*
261 * 0xff0a0000 = USB, HID_UP_MSVENDOR = BT.
262 *
263 * In BT mode, there are two HID_UP_MSVENDOR pages.
264 * Use only the page that contains report ID == 5.
265 */
266 if (((usage->hid & HID_USAGE_PAGE) == 0xff0a0000 ||
267 (usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR) &&
268 field->report->id == 5) {
269 switch (usage->hid & HID_USAGE) {
270 case 0x00bb: /* Fn-F4: Mic mute */
271 map_key_clear(LENOVO_KEY_MICMUTE);
272 return 1;
273 case 0x00c3: /* Fn-F5: Brightness down */
274 map_key_clear(KEY_BRIGHTNESSDOWN);
275 return 1;
276 case 0x00c4: /* Fn-F6: Brightness up */
277 map_key_clear(KEY_BRIGHTNESSUP);
278 return 1;
279 case 0x00c1: /* Fn-F8: Notification center */
280 map_key_clear(KEY_NOTIFICATION_CENTER);
281 return 1;
282 case 0x00bc: /* Fn-F9: Control panel */
283 map_key_clear(KEY_CONFIG);
284 return 1;
285 case 0x00b6: /* Fn-F10: Bluetooth */
286 map_key_clear(KEY_BLUETOOTH);
287 return 1;
288 case 0x00b7: /* Fn-F11: Keyboard config */
289 map_key_clear(KEY_KEYBOARD);
290 return 1;
291 case 0x00b8: /* Fn-F12: User function */
292 map_key_clear(KEY_PROG1);
293 return 1;
294 case 0x00b9: /* Fn-PrtSc: Snipping tool */
295 map_key_clear(KEY_SELECTIVE_SCREENSHOT);
296 return 1;
297 case 0x00b5: /* Fn-Esc: Fn-lock toggle */
298 map_key_clear(KEY_FN_ESC);
299 return 1;
300 }
301 }
302
303 if ((usage->hid & HID_USAGE_PAGE) == 0xffa00000) {
304 switch (usage->hid & HID_USAGE) {
305 case 0x00fb: /* Middle mouse (in native USB mode) */
306 map_key_clear(BTN_MIDDLE);
307 return 1;
308 }
309 }
310
311 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR &&
312 field->report->id == 21) {
313 switch (usage->hid & HID_USAGE) {
314 case 0x0004: /* Middle mouse (in native Bluetooth mode) */
315 map_key_clear(BTN_MIDDLE);
316 return 1;
317 }
318 }
319
320 /* Compatibility middle/wheel mappings should be ignored */
321 if (usage->hid == HID_GD_WHEEL)
322 return -1;
323 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON &&
324 (usage->hid & HID_USAGE) == 0x003)
325 return -1;
326 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER &&
327 (usage->hid & HID_USAGE) == 0x238)
328 return -1;
329
330 /* Map wheel emulation reports: 0xff10 */
331 if ((usage->hid & HID_USAGE_PAGE) == 0xff100000) {
332 field->flags |= HID_MAIN_ITEM_RELATIVE | HID_MAIN_ITEM_VARIABLE;
333 field->logical_minimum = -127;
334 field->logical_maximum = 127;
335
336 switch (usage->hid & HID_USAGE) {
337 case 0x0000:
338 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
339 return 1;
340 case 0x0001:
341 hid_map_usage(hi, usage, bit, max, EV_REL, REL_WHEEL);
342 return 1;
343 default:
344 return -1;
345 }
346 }
347
348 return 0;
349}
350
351static int lenovo_input_mapping_scrollpoint(struct hid_device *hdev,
352 struct hid_input *hi, struct hid_field *field,
353 struct hid_usage *usage, unsigned long **bit, int *max)
354{
355 if (usage->hid == HID_GD_Z) {
356 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
357 return 1;
358 }
359 return 0;
360}
361
362static int lenovo_input_mapping_tp10_ultrabook_kbd(struct hid_device *hdev,
363 struct hid_input *hi, struct hid_field *field,
364 struct hid_usage *usage, unsigned long **bit, int *max)
365{
366 /*
367 * The ThinkPad 10 Ultrabook Keyboard uses 0x000c0001 usage for
368 * a bunch of keys which have no standard consumer page code.
369 */
370 if (usage->hid == 0x000c0001) {
371 switch (usage->usage_index) {
372 case 8: /* Fn-Esc: Fn-lock toggle */
373 map_key_clear(KEY_FN_ESC);
374 return 1;
375 case 9: /* Fn-F4: Mic mute */
376 map_key_clear(LENOVO_KEY_MICMUTE);
377 return 1;
378 case 10: /* Fn-F7: Control panel */
379 map_key_clear(KEY_CONFIG);
380 return 1;
381 case 11: /* Fn-F8: Search (magnifier glass) */
382 map_key_clear(KEY_SEARCH);
383 return 1;
384 case 12: /* Fn-F10: Open My computer (6 boxes) */
385 map_key_clear(KEY_FILE);
386 return 1;
387 }
388 }
389
390 /*
391 * The Ultrabook Keyboard sends a spurious F23 key-press when resuming
392 * from suspend and it does not actually have a F23 key, ignore it.
393 */
394 if (usage->hid == 0x00070072)
395 return -1;
396
397 return 0;
398}
399
400static int lenovo_input_mapping_x1_tab_kbd(struct hid_device *hdev,
401 struct hid_input *hi, struct hid_field *field,
402 struct hid_usage *usage, unsigned long **bit, int *max)
403{
404 /*
405 * The ThinkPad X1 Tablet Thin Keyboard uses 0x000c0001 usage for
406 * a bunch of keys which have no standard consumer page code.
407 */
408 if (usage->hid == 0x000c0001) {
409 switch (usage->usage_index) {
410 case 0: /* Fn-F10: Enable/disable bluetooth */
411 map_key_clear(KEY_BLUETOOTH);
412 return 1;
413 case 1: /* Fn-F11: Keyboard settings */
414 map_key_clear(KEY_KEYBOARD);
415 return 1;
416 case 2: /* Fn-F12: User function / Cortana */
417 map_key_clear(KEY_MACRO1);
418 return 1;
419 case 3: /* Fn-PrtSc: Snipping tool */
420 map_key_clear(KEY_SELECTIVE_SCREENSHOT);
421 return 1;
422 case 8: /* Fn-Esc: Fn-lock toggle */
423 map_key_clear(KEY_FN_ESC);
424 return 1;
425 case 9: /* Fn-F4: Mute/unmute microphone */
426 map_key_clear(KEY_MICMUTE);
427 return 1;
428 case 10: /* Fn-F9: Settings */
429 map_key_clear(KEY_CONFIG);
430 return 1;
431 case 13: /* Fn-F7: Manage external displays */
432 map_key_clear(KEY_SWITCHVIDEOMODE);
433 return 1;
434 case 14: /* Fn-F8: Enable/disable wifi */
435 map_key_clear(KEY_WLAN);
436 return 1;
437 }
438 }
439
440 if (usage->hid == (HID_UP_KEYBOARD | 0x009a)) {
441 map_key_clear(KEY_SYSRQ);
442 return 1;
443 }
444
445 return 0;
446}
447
448static int lenovo_input_mapping(struct hid_device *hdev,
449 struct hid_input *hi, struct hid_field *field,
450 struct hid_usage *usage, unsigned long **bit, int *max)
451{
452 switch (hdev->product) {
453 case USB_DEVICE_ID_LENOVO_TPKBD:
454 return lenovo_input_mapping_tpkbd(hdev, hi, field,
455 usage, bit, max);
456 case USB_DEVICE_ID_LENOVO_CUSBKBD:
457 case USB_DEVICE_ID_LENOVO_CBTKBD:
458 return lenovo_input_mapping_cptkbd(hdev, hi, field,
459 usage, bit, max);
460 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
461 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
462 return lenovo_input_mapping_tpIIkbd(hdev, hi, field,
463 usage, bit, max);
464 case USB_DEVICE_ID_IBM_SCROLLPOINT_III:
465 case USB_DEVICE_ID_IBM_SCROLLPOINT_PRO:
466 case USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL:
467 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL:
468 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO:
469 case USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL:
470 return lenovo_input_mapping_scrollpoint(hdev, hi, field,
471 usage, bit, max);
472 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
473 return lenovo_input_mapping_tp10_ultrabook_kbd(hdev, hi, field,
474 usage, bit, max);
475 case USB_DEVICE_ID_LENOVO_X1_TAB:
476 return lenovo_input_mapping_x1_tab_kbd(hdev, hi, field, usage, bit, max);
477 default:
478 return 0;
479 }
480}
481
482#undef map_key_clear
483
484/* Send a config command to the keyboard */
485static int lenovo_send_cmd_cptkbd(struct hid_device *hdev,
486 unsigned char byte2, unsigned char byte3)
487{
488 int ret;
489 unsigned char *buf;
490
491 buf = kzalloc(3, GFP_KERNEL);
492 if (!buf)
493 return -ENOMEM;
494
495 /*
496 * Feature report 0x13 is used for USB,
497 * output report 0x18 is used for Bluetooth.
498 * buf[0] is ignored by hid_hw_raw_request.
499 */
500 buf[0] = 0x18;
501 buf[1] = byte2;
502 buf[2] = byte3;
503
504 switch (hdev->product) {
505 case USB_DEVICE_ID_LENOVO_CUSBKBD:
506 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
507 ret = hid_hw_raw_request(hdev, 0x13, buf, 3,
508 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
509 break;
510 case USB_DEVICE_ID_LENOVO_CBTKBD:
511 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
512 ret = hid_hw_output_report(hdev, buf, 3);
513 break;
514 default:
515 ret = -EINVAL;
516 break;
517 }
518
519 kfree(buf);
520
521 return ret < 0 ? ret : 0; /* BT returns 0, USB returns sizeof(buf) */
522}
523
524static void lenovo_features_set_cptkbd(struct hid_device *hdev)
525{
526 int ret;
527 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
528
529 /*
530 * Tell the keyboard a driver understands it, and turn F7, F9, F11 into
531 * regular keys
532 */
533 ret = lenovo_send_cmd_cptkbd(hdev, 0x01, 0x03);
534 if (ret)
535 hid_warn(hdev, "Failed to switch F7/9/11 mode: %d\n", ret);
536
537 /* Switch middle button to native mode */
538 ret = lenovo_send_cmd_cptkbd(hdev, 0x09, 0x01);
539 if (ret)
540 hid_warn(hdev, "Failed to switch middle button: %d\n", ret);
541
542 ret = lenovo_send_cmd_cptkbd(hdev, 0x05, cptkbd_data->fn_lock);
543 if (ret)
544 hid_err(hdev, "Fn-lock setting failed: %d\n", ret);
545
546 ret = lenovo_send_cmd_cptkbd(hdev, 0x02, cptkbd_data->sensitivity);
547 if (ret)
548 hid_err(hdev, "Sensitivity setting failed: %d\n", ret);
549}
550
551static ssize_t attr_fn_lock_show(struct device *dev,
552 struct device_attribute *attr,
553 char *buf)
554{
555 struct hid_device *hdev = to_hid_device(dev);
556 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
557
558 return snprintf(buf, PAGE_SIZE, "%u\n", data->fn_lock);
559}
560
561static ssize_t attr_fn_lock_store(struct device *dev,
562 struct device_attribute *attr,
563 const char *buf,
564 size_t count)
565{
566 struct hid_device *hdev = to_hid_device(dev);
567 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
568 int value, ret;
569
570 if (kstrtoint(buf, 10, &value))
571 return -EINVAL;
572 if (value < 0 || value > 1)
573 return -EINVAL;
574
575 data->fn_lock = !!value;
576
577 switch (hdev->product) {
578 case USB_DEVICE_ID_LENOVO_CUSBKBD:
579 case USB_DEVICE_ID_LENOVO_CBTKBD:
580 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
581 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
582 lenovo_features_set_cptkbd(hdev);
583 break;
584 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
585 case USB_DEVICE_ID_LENOVO_X1_TAB:
586 ret = lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, value);
587 if (ret)
588 return ret;
589 break;
590 }
591
592 return count;
593}
594
595static ssize_t attr_sensitivity_show_cptkbd(struct device *dev,
596 struct device_attribute *attr,
597 char *buf)
598{
599 struct hid_device *hdev = to_hid_device(dev);
600 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
601
602 return snprintf(buf, PAGE_SIZE, "%u\n",
603 cptkbd_data->sensitivity);
604}
605
606static ssize_t attr_sensitivity_store_cptkbd(struct device *dev,
607 struct device_attribute *attr,
608 const char *buf,
609 size_t count)
610{
611 struct hid_device *hdev = to_hid_device(dev);
612 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
613 int value;
614
615 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
616 return -EINVAL;
617
618 cptkbd_data->sensitivity = value;
619 lenovo_features_set_cptkbd(hdev);
620
621 return count;
622}
623
624
625static struct device_attribute dev_attr_fn_lock =
626 __ATTR(fn_lock, S_IWUSR | S_IRUGO,
627 attr_fn_lock_show,
628 attr_fn_lock_store);
629
630static struct device_attribute dev_attr_sensitivity_cptkbd =
631 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
632 attr_sensitivity_show_cptkbd,
633 attr_sensitivity_store_cptkbd);
634
635
636static struct attribute *lenovo_attributes_cptkbd[] = {
637 &dev_attr_fn_lock.attr,
638 &dev_attr_sensitivity_cptkbd.attr,
639 NULL
640};
641
642static const struct attribute_group lenovo_attr_group_cptkbd = {
643 .attrs = lenovo_attributes_cptkbd,
644};
645
646static int lenovo_raw_event(struct hid_device *hdev,
647 struct hid_report *report, u8 *data, int size)
648{
649 /*
650 * Compact USB keyboard's Fn-F12 report holds down many other keys, and
651 * its own key is outside the usage page range. Remove extra
652 * keypresses and remap to inside usage page.
653 */
654 if (unlikely(hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
655 && size == 3
656 && data[0] == 0x15
657 && data[1] == 0x94
658 && data[2] == 0x01)) {
659 data[1] = 0x00;
660 data[2] = 0x01;
661 }
662
663 return 0;
664}
665
666static int lenovo_event_tp10ubkbd(struct hid_device *hdev,
667 struct hid_field *field, struct hid_usage *usage, __s32 value)
668{
669 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
670
671 if (usage->type == EV_KEY && usage->code == KEY_FN_ESC && value == 1) {
672 /*
673 * The user has toggled the Fn-lock state. Toggle our own
674 * cached value of it and sync our value to the keyboard to
675 * ensure things are in sync (the sycning should be a no-op).
676 */
677 data->fn_lock = !data->fn_lock;
678 schedule_work(&data->fn_lock_sync_work);
679 }
680
681 return 0;
682}
683
684static int lenovo_event_cptkbd(struct hid_device *hdev,
685 struct hid_field *field, struct hid_usage *usage, __s32 value)
686{
687 struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
688
689 if (cptkbd_data->middlebutton_state != 3) {
690 /* REL_X and REL_Y events during middle button pressed
691 * are only possible on patched, bug-free firmware
692 * so set middlebutton_state to 3
693 * to never apply workaround anymore
694 */
695 if (hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD &&
696 cptkbd_data->middlebutton_state == 1 &&
697 usage->type == EV_REL &&
698 (usage->code == REL_X || usage->code == REL_Y)) {
699 cptkbd_data->middlebutton_state = 3;
700 /* send middle button press which was hold before */
701 input_event(field->hidinput->input,
702 EV_KEY, BTN_MIDDLE, 1);
703 input_sync(field->hidinput->input);
704 }
705
706 /* "wheel" scroll events */
707 if (usage->type == EV_REL && (usage->code == REL_WHEEL ||
708 usage->code == REL_HWHEEL)) {
709 /* Scroll events disable middle-click event */
710 cptkbd_data->middlebutton_state = 2;
711 return 0;
712 }
713
714 /* Middle click events */
715 if (usage->type == EV_KEY && usage->code == BTN_MIDDLE) {
716 if (value == 1) {
717 cptkbd_data->middlebutton_state = 1;
718 } else if (value == 0) {
719 if (cptkbd_data->middlebutton_state == 1) {
720 /* No scrolling inbetween, send middle-click */
721 input_event(field->hidinput->input,
722 EV_KEY, BTN_MIDDLE, 1);
723 input_sync(field->hidinput->input);
724 input_event(field->hidinput->input,
725 EV_KEY, BTN_MIDDLE, 0);
726 input_sync(field->hidinput->input);
727 }
728 cptkbd_data->middlebutton_state = 0;
729 }
730 return 1;
731 }
732 }
733
734 if (usage->type == EV_KEY && usage->code == KEY_FN_ESC && value == 1) {
735 /*
736 * The user has toggled the Fn-lock state. Toggle our own
737 * cached value of it and sync our value to the keyboard to
738 * ensure things are in sync (the syncing should be a no-op).
739 */
740 cptkbd_data->fn_lock = !cptkbd_data->fn_lock;
741 }
742
743 return 0;
744}
745
746static int lenovo_event(struct hid_device *hdev, struct hid_field *field,
747 struct hid_usage *usage, __s32 value)
748{
749 if (!hid_get_drvdata(hdev))
750 return 0;
751
752 switch (hdev->product) {
753 case USB_DEVICE_ID_LENOVO_CUSBKBD:
754 case USB_DEVICE_ID_LENOVO_CBTKBD:
755 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
756 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
757 return lenovo_event_cptkbd(hdev, field, usage, value);
758 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
759 case USB_DEVICE_ID_LENOVO_X1_TAB:
760 return lenovo_event_tp10ubkbd(hdev, field, usage, value);
761 default:
762 return 0;
763 }
764}
765
766static int lenovo_features_set_tpkbd(struct hid_device *hdev)
767{
768 struct hid_report *report;
769 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
770
771 report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[4];
772
773 report->field[0]->value[0] = data_pointer->press_to_select ? 0x01 : 0x02;
774 report->field[0]->value[0] |= data_pointer->dragging ? 0x04 : 0x08;
775 report->field[0]->value[0] |= data_pointer->release_to_select ? 0x10 : 0x20;
776 report->field[0]->value[0] |= data_pointer->select_right ? 0x80 : 0x40;
777 report->field[1]->value[0] = 0x03; // unknown setting, imitate windows driver
778 report->field[2]->value[0] = data_pointer->sensitivity;
779 report->field[3]->value[0] = data_pointer->press_speed;
780
781 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
782 return 0;
783}
784
785static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,
786 struct device_attribute *attr,
787 char *buf)
788{
789 struct hid_device *hdev = to_hid_device(dev);
790 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
791
792 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->press_to_select);
793}
794
795static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,
796 struct device_attribute *attr,
797 const char *buf,
798 size_t count)
799{
800 struct hid_device *hdev = to_hid_device(dev);
801 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
802 int value;
803
804 if (kstrtoint(buf, 10, &value))
805 return -EINVAL;
806 if (value < 0 || value > 1)
807 return -EINVAL;
808
809 data_pointer->press_to_select = value;
810 lenovo_features_set_tpkbd(hdev);
811
812 return count;
813}
814
815static ssize_t attr_dragging_show_tpkbd(struct device *dev,
816 struct device_attribute *attr,
817 char *buf)
818{
819 struct hid_device *hdev = to_hid_device(dev);
820 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
821
822 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->dragging);
823}
824
825static ssize_t attr_dragging_store_tpkbd(struct device *dev,
826 struct device_attribute *attr,
827 const char *buf,
828 size_t count)
829{
830 struct hid_device *hdev = to_hid_device(dev);
831 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
832 int value;
833
834 if (kstrtoint(buf, 10, &value))
835 return -EINVAL;
836 if (value < 0 || value > 1)
837 return -EINVAL;
838
839 data_pointer->dragging = value;
840 lenovo_features_set_tpkbd(hdev);
841
842 return count;
843}
844
845static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,
846 struct device_attribute *attr,
847 char *buf)
848{
849 struct hid_device *hdev = to_hid_device(dev);
850 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
851
852 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->release_to_select);
853}
854
855static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,
856 struct device_attribute *attr,
857 const char *buf,
858 size_t count)
859{
860 struct hid_device *hdev = to_hid_device(dev);
861 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
862 int value;
863
864 if (kstrtoint(buf, 10, &value))
865 return -EINVAL;
866 if (value < 0 || value > 1)
867 return -EINVAL;
868
869 data_pointer->release_to_select = value;
870 lenovo_features_set_tpkbd(hdev);
871
872 return count;
873}
874
875static ssize_t attr_select_right_show_tpkbd(struct device *dev,
876 struct device_attribute *attr,
877 char *buf)
878{
879 struct hid_device *hdev = to_hid_device(dev);
880 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
881
882 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->select_right);
883}
884
885static ssize_t attr_select_right_store_tpkbd(struct device *dev,
886 struct device_attribute *attr,
887 const char *buf,
888 size_t count)
889{
890 struct hid_device *hdev = to_hid_device(dev);
891 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
892 int value;
893
894 if (kstrtoint(buf, 10, &value))
895 return -EINVAL;
896 if (value < 0 || value > 1)
897 return -EINVAL;
898
899 data_pointer->select_right = value;
900 lenovo_features_set_tpkbd(hdev);
901
902 return count;
903}
904
905static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,
906 struct device_attribute *attr,
907 char *buf)
908{
909 struct hid_device *hdev = to_hid_device(dev);
910 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
911
912 return snprintf(buf, PAGE_SIZE, "%u\n",
913 data_pointer->sensitivity);
914}
915
916static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,
917 struct device_attribute *attr,
918 const char *buf,
919 size_t count)
920{
921 struct hid_device *hdev = to_hid_device(dev);
922 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
923 int value;
924
925 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
926 return -EINVAL;
927
928 data_pointer->sensitivity = value;
929 lenovo_features_set_tpkbd(hdev);
930
931 return count;
932}
933
934static ssize_t attr_press_speed_show_tpkbd(struct device *dev,
935 struct device_attribute *attr,
936 char *buf)
937{
938 struct hid_device *hdev = to_hid_device(dev);
939 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
940
941 return snprintf(buf, PAGE_SIZE, "%u\n",
942 data_pointer->press_speed);
943}
944
945static ssize_t attr_press_speed_store_tpkbd(struct device *dev,
946 struct device_attribute *attr,
947 const char *buf,
948 size_t count)
949{
950 struct hid_device *hdev = to_hid_device(dev);
951 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
952 int value;
953
954 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
955 return -EINVAL;
956
957 data_pointer->press_speed = value;
958 lenovo_features_set_tpkbd(hdev);
959
960 return count;
961}
962
963static struct device_attribute dev_attr_press_to_select_tpkbd =
964 __ATTR(press_to_select, S_IWUSR | S_IRUGO,
965 attr_press_to_select_show_tpkbd,
966 attr_press_to_select_store_tpkbd);
967
968static struct device_attribute dev_attr_dragging_tpkbd =
969 __ATTR(dragging, S_IWUSR | S_IRUGO,
970 attr_dragging_show_tpkbd,
971 attr_dragging_store_tpkbd);
972
973static struct device_attribute dev_attr_release_to_select_tpkbd =
974 __ATTR(release_to_select, S_IWUSR | S_IRUGO,
975 attr_release_to_select_show_tpkbd,
976 attr_release_to_select_store_tpkbd);
977
978static struct device_attribute dev_attr_select_right_tpkbd =
979 __ATTR(select_right, S_IWUSR | S_IRUGO,
980 attr_select_right_show_tpkbd,
981 attr_select_right_store_tpkbd);
982
983static struct device_attribute dev_attr_sensitivity_tpkbd =
984 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
985 attr_sensitivity_show_tpkbd,
986 attr_sensitivity_store_tpkbd);
987
988static struct device_attribute dev_attr_press_speed_tpkbd =
989 __ATTR(press_speed, S_IWUSR | S_IRUGO,
990 attr_press_speed_show_tpkbd,
991 attr_press_speed_store_tpkbd);
992
993static struct attribute *lenovo_attributes_tpkbd[] = {
994 &dev_attr_press_to_select_tpkbd.attr,
995 &dev_attr_dragging_tpkbd.attr,
996 &dev_attr_release_to_select_tpkbd.attr,
997 &dev_attr_select_right_tpkbd.attr,
998 &dev_attr_sensitivity_tpkbd.attr,
999 &dev_attr_press_speed_tpkbd.attr,
1000 NULL
1001};
1002
1003static const struct attribute_group lenovo_attr_group_tpkbd = {
1004 .attrs = lenovo_attributes_tpkbd,
1005};
1006
1007static void lenovo_led_set_tpkbd(struct hid_device *hdev)
1008{
1009 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1010 struct hid_report *report;
1011
1012 report = hdev->report_enum[HID_OUTPUT_REPORT].report_id_hash[3];
1013 report->field[0]->value[0] = (data_pointer->led_state >> 0) & 1;
1014 report->field[0]->value[1] = (data_pointer->led_state >> 1) & 1;
1015 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
1016}
1017
1018static int lenovo_led_brightness_set(struct led_classdev *led_cdev,
1019 enum led_brightness value)
1020{
1021 struct device *dev = led_cdev->dev->parent;
1022 struct hid_device *hdev = to_hid_device(dev);
1023 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1024 static const u8 tp10ubkbd_led[] = { TP10UBKBD_MUTE_LED, TP10UBKBD_MICMUTE_LED };
1025 int led_nr = 0;
1026 int ret = 0;
1027
1028 if (led_cdev == &data_pointer->led_micmute)
1029 led_nr = 1;
1030
1031 if (value == LED_OFF)
1032 data_pointer->led_state &= ~(1 << led_nr);
1033 else
1034 data_pointer->led_state |= 1 << led_nr;
1035
1036 switch (hdev->product) {
1037 case USB_DEVICE_ID_LENOVO_TPKBD:
1038 lenovo_led_set_tpkbd(hdev);
1039 break;
1040 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1041 case USB_DEVICE_ID_LENOVO_X1_TAB:
1042 ret = lenovo_led_set_tp10ubkbd(hdev, tp10ubkbd_led[led_nr], value);
1043 break;
1044 }
1045
1046 return ret;
1047}
1048
1049static int lenovo_register_leds(struct hid_device *hdev)
1050{
1051 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
1052 size_t name_sz = strlen(dev_name(&hdev->dev)) + 16;
1053 char *name_mute, *name_micm;
1054 int ret;
1055
1056 name_mute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
1057 name_micm = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
1058 if (name_mute == NULL || name_micm == NULL) {
1059 hid_err(hdev, "Could not allocate memory for led data\n");
1060 return -ENOMEM;
1061 }
1062 snprintf(name_mute, name_sz, "%s:amber:mute", dev_name(&hdev->dev));
1063 snprintf(name_micm, name_sz, "%s:amber:micmute", dev_name(&hdev->dev));
1064
1065 data->led_mute.name = name_mute;
1066 data->led_mute.default_trigger = "audio-mute";
1067 data->led_mute.brightness_set_blocking = lenovo_led_brightness_set;
1068 data->led_mute.max_brightness = 1;
1069 data->led_mute.flags = LED_HW_PLUGGABLE;
1070 data->led_mute.dev = &hdev->dev;
1071 ret = led_classdev_register(&hdev->dev, &data->led_mute);
1072 if (ret < 0)
1073 return ret;
1074
1075 data->led_micmute.name = name_micm;
1076 data->led_micmute.default_trigger = "audio-micmute";
1077 data->led_micmute.brightness_set_blocking = lenovo_led_brightness_set;
1078 data->led_micmute.max_brightness = 1;
1079 data->led_micmute.flags = LED_HW_PLUGGABLE;
1080 data->led_micmute.dev = &hdev->dev;
1081 ret = led_classdev_register(&hdev->dev, &data->led_micmute);
1082 if (ret < 0) {
1083 led_classdev_unregister(&data->led_mute);
1084 return ret;
1085 }
1086
1087 return 0;
1088}
1089
1090static int lenovo_probe_tpkbd(struct hid_device *hdev)
1091{
1092 struct lenovo_drvdata *data_pointer;
1093 int i, ret;
1094
1095 /*
1096 * Only register extra settings against subdevice where input_mapping
1097 * set drvdata to 1, i.e. the trackpoint.
1098 */
1099 if (!hid_get_drvdata(hdev))
1100 return 0;
1101
1102 hid_set_drvdata(hdev, NULL);
1103
1104 /* Validate required reports. */
1105 for (i = 0; i < 4; i++) {
1106 if (!hid_validate_values(hdev, HID_FEATURE_REPORT, 4, i, 1))
1107 return -ENODEV;
1108 }
1109 if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, 3, 0, 2))
1110 return -ENODEV;
1111
1112 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
1113 if (ret)
1114 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
1115
1116 data_pointer = devm_kzalloc(&hdev->dev,
1117 sizeof(struct lenovo_drvdata),
1118 GFP_KERNEL);
1119 if (data_pointer == NULL) {
1120 hid_err(hdev, "Could not allocate memory for driver data\n");
1121 ret = -ENOMEM;
1122 goto err;
1123 }
1124
1125 // set same default values as windows driver
1126 data_pointer->sensitivity = 0xa0;
1127 data_pointer->press_speed = 0x38;
1128
1129 hid_set_drvdata(hdev, data_pointer);
1130
1131 ret = lenovo_register_leds(hdev);
1132 if (ret)
1133 goto err;
1134
1135 lenovo_features_set_tpkbd(hdev);
1136
1137 return 0;
1138err:
1139 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
1140 return ret;
1141}
1142
1143static int lenovo_probe_cptkbd(struct hid_device *hdev)
1144{
1145 int ret;
1146 struct lenovo_drvdata *cptkbd_data;
1147
1148 /* All the custom action happens on the USBMOUSE device for USB */
1149 if (((hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD) ||
1150 (hdev->product == USB_DEVICE_ID_LENOVO_TPIIUSBKBD)) &&
1151 hdev->type != HID_TYPE_USBMOUSE) {
1152 hid_dbg(hdev, "Ignoring keyboard half of device\n");
1153 return 0;
1154 }
1155
1156 cptkbd_data = devm_kzalloc(&hdev->dev,
1157 sizeof(*cptkbd_data),
1158 GFP_KERNEL);
1159 if (cptkbd_data == NULL) {
1160 hid_err(hdev, "can't alloc keyboard descriptor\n");
1161 return -ENOMEM;
1162 }
1163 hid_set_drvdata(hdev, cptkbd_data);
1164
1165 /* Set keyboard settings to known state */
1166 cptkbd_data->middlebutton_state = 0;
1167 cptkbd_data->fn_lock = true;
1168 cptkbd_data->sensitivity = 0x05;
1169 lenovo_features_set_cptkbd(hdev);
1170
1171 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_cptkbd);
1172 if (ret)
1173 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
1174
1175 return 0;
1176}
1177
1178static struct attribute *lenovo_attributes_tp10ubkbd[] = {
1179 &dev_attr_fn_lock.attr,
1180 NULL
1181};
1182
1183static const struct attribute_group lenovo_attr_group_tp10ubkbd = {
1184 .attrs = lenovo_attributes_tp10ubkbd,
1185};
1186
1187static int lenovo_probe_tp10ubkbd(struct hid_device *hdev)
1188{
1189 struct hid_report_enum *rep_enum;
1190 struct lenovo_drvdata *data;
1191 struct hid_report *rep;
1192 bool found;
1193 int ret;
1194
1195 /*
1196 * The LEDs and the Fn-lock functionality use output report 9,
1197 * with an application of 0xffa0001, add the LEDs on the interface
1198 * with this output report.
1199 */
1200 found = false;
1201 rep_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
1202 list_for_each_entry(rep, &rep_enum->report_list, list) {
1203 if (rep->application == 0xffa00001)
1204 found = true;
1205 }
1206 if (!found)
1207 return 0;
1208
1209 data = devm_kzalloc(&hdev->dev, sizeof(*data), GFP_KERNEL);
1210 if (!data)
1211 return -ENOMEM;
1212
1213 mutex_init(&data->led_report_mutex);
1214 INIT_WORK(&data->fn_lock_sync_work, lenovo_tp10ubkbd_sync_fn_lock);
1215 data->hdev = hdev;
1216
1217 hid_set_drvdata(hdev, data);
1218
1219 /*
1220 * The Thinkpad 10 ultrabook USB kbd dock's Fn-lock defaults to on.
1221 * We cannot read the state, only set it, so we force it to on here
1222 * (which should be a no-op) to make sure that our state matches the
1223 * keyboard's FN-lock state. This is the same as what Windows does.
1224 */
1225 data->fn_lock = true;
1226 lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, data->fn_lock);
1227
1228 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1229 if (ret)
1230 return ret;
1231
1232 ret = lenovo_register_leds(hdev);
1233 if (ret)
1234 goto err;
1235
1236 return 0;
1237err:
1238 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1239 return ret;
1240}
1241
1242static int lenovo_probe(struct hid_device *hdev,
1243 const struct hid_device_id *id)
1244{
1245 int ret;
1246
1247 ret = hid_parse(hdev);
1248 if (ret) {
1249 hid_err(hdev, "hid_parse failed\n");
1250 goto err;
1251 }
1252
1253 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1254 if (ret) {
1255 hid_err(hdev, "hid_hw_start failed\n");
1256 goto err;
1257 }
1258
1259 switch (hdev->product) {
1260 case USB_DEVICE_ID_LENOVO_TPKBD:
1261 ret = lenovo_probe_tpkbd(hdev);
1262 break;
1263 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1264 case USB_DEVICE_ID_LENOVO_CBTKBD:
1265 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1266 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1267 ret = lenovo_probe_cptkbd(hdev);
1268 break;
1269 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1270 case USB_DEVICE_ID_LENOVO_X1_TAB:
1271 ret = lenovo_probe_tp10ubkbd(hdev);
1272 break;
1273 default:
1274 ret = 0;
1275 break;
1276 }
1277 if (ret)
1278 goto err_hid;
1279
1280 return 0;
1281err_hid:
1282 hid_hw_stop(hdev);
1283err:
1284 return ret;
1285}
1286
1287#ifdef CONFIG_PM
1288static int lenovo_reset_resume(struct hid_device *hdev)
1289{
1290 switch (hdev->product) {
1291 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1292 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1293 if (hdev->type == HID_TYPE_USBMOUSE)
1294 lenovo_features_set_cptkbd(hdev);
1295
1296 break;
1297 default:
1298 break;
1299 }
1300
1301 return 0;
1302}
1303#endif
1304
1305static void lenovo_remove_tpkbd(struct hid_device *hdev)
1306{
1307 struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1308
1309 /*
1310 * Only the trackpoint half of the keyboard has drvdata and stuff that
1311 * needs unregistering.
1312 */
1313 if (data_pointer == NULL)
1314 return;
1315
1316 sysfs_remove_group(&hdev->dev.kobj,
1317 &lenovo_attr_group_tpkbd);
1318
1319 led_classdev_unregister(&data_pointer->led_micmute);
1320 led_classdev_unregister(&data_pointer->led_mute);
1321}
1322
1323static void lenovo_remove_cptkbd(struct hid_device *hdev)
1324{
1325 sysfs_remove_group(&hdev->dev.kobj,
1326 &lenovo_attr_group_cptkbd);
1327}
1328
1329static void lenovo_remove_tp10ubkbd(struct hid_device *hdev)
1330{
1331 struct lenovo_drvdata *data = hid_get_drvdata(hdev);
1332
1333 if (data == NULL)
1334 return;
1335
1336 led_classdev_unregister(&data->led_micmute);
1337 led_classdev_unregister(&data->led_mute);
1338
1339 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1340 cancel_work_sync(&data->fn_lock_sync_work);
1341}
1342
1343static void lenovo_remove(struct hid_device *hdev)
1344{
1345 switch (hdev->product) {
1346 case USB_DEVICE_ID_LENOVO_TPKBD:
1347 lenovo_remove_tpkbd(hdev);
1348 break;
1349 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1350 case USB_DEVICE_ID_LENOVO_CBTKBD:
1351 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1352 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1353 lenovo_remove_cptkbd(hdev);
1354 break;
1355 case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1356 case USB_DEVICE_ID_LENOVO_X1_TAB:
1357 lenovo_remove_tp10ubkbd(hdev);
1358 break;
1359 }
1360
1361 hid_hw_stop(hdev);
1362}
1363
1364static int lenovo_input_configured(struct hid_device *hdev,
1365 struct hid_input *hi)
1366{
1367 switch (hdev->product) {
1368 case USB_DEVICE_ID_LENOVO_TPKBD:
1369 case USB_DEVICE_ID_LENOVO_CUSBKBD:
1370 case USB_DEVICE_ID_LENOVO_CBTKBD:
1371 case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1372 case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1373 if (test_bit(EV_REL, hi->input->evbit)) {
1374 /* set only for trackpoint device */
1375 __set_bit(INPUT_PROP_POINTER, hi->input->propbit);
1376 __set_bit(INPUT_PROP_POINTING_STICK,
1377 hi->input->propbit);
1378 }
1379 break;
1380 }
1381
1382 return 0;
1383}
1384
1385
1386static const struct hid_device_id lenovo_devices[] = {
1387 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },
1388 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CUSBKBD) },
1389 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPIIUSBKBD) },
1390 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CBTKBD) },
1391 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPIIBTKBD) },
1392 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPPRODOCK) },
1393 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_III) },
1394 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_PRO) },
1395 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL) },
1396 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL) },
1397 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO) },
1398 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL) },
1399 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TP10UBKBD) },
1400 /*
1401 * Note bind to the HID_GROUP_GENERIC group, so that we only bind to the keyboard
1402 * part, while letting hid-multitouch.c handle the touchpad and trackpoint.
1403 */
1404 { HID_DEVICE(BUS_USB, HID_GROUP_GENERIC,
1405 USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_TAB) },
1406 { }
1407};
1408
1409MODULE_DEVICE_TABLE(hid, lenovo_devices);
1410
1411static struct hid_driver lenovo_driver = {
1412 .name = "lenovo",
1413 .id_table = lenovo_devices,
1414 .input_configured = lenovo_input_configured,
1415 .input_mapping = lenovo_input_mapping,
1416 .probe = lenovo_probe,
1417 .remove = lenovo_remove,
1418 .raw_event = lenovo_raw_event,
1419 .event = lenovo_event,
1420 .report_fixup = lenovo_report_fixup,
1421#ifdef CONFIG_PM
1422 .reset_resume = lenovo_reset_resume,
1423#endif
1424};
1425module_hid_driver(lenovo_driver);
1426
1427MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
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)
7 *
8 * Copyright (c) 2012 Bernhard Seibold
9 * Copyright (c) 2014 Jamie Lentin <jm@lentin.co.uk>
10 *
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
18 *
19 * Copyright (c) 2012 Peter De Wachter <pdewacht@gmail.com>
20 * Copyright (c) 2018 Peter Ganzhorn <peter.ganzhorn@gmail.com>
21 */
22
23/*
24 */
25
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
33#include "hid-ids.h"
34
35struct lenovo_drvdata_tpkbd {
36 int led_state;
37 struct led_classdev led_mute;
38 struct led_classdev led_micmute;
39 int press_to_select;
40 int dragging;
41 int release_to_select;
42 int select_right;
43 int sensitivity;
44 int press_speed;
45};
46
47struct lenovo_drvdata_cptkbd {
48 u8 middlebutton_state; /* 0:Up, 1:Down (undecided), 2:Scrolling */
49 bool fn_lock;
50 int sensitivity;
51};
52
53#define map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
54
55static const __u8 lenovo_pro_dock_need_fixup_collection[] = {
56 0x05, 0x88, /* Usage Page (Vendor Usage Page 0x88) */
57 0x09, 0x01, /* Usage (Vendor Usage 0x01) */
58 0xa1, 0x01, /* Collection (Application) */
59 0x85, 0x04, /* Report ID (4) */
60 0x19, 0x00, /* Usage Minimum (0) */
61 0x2a, 0xff, 0xff, /* Usage Maximum (65535) */
62};
63
64static __u8 *lenovo_report_fixup(struct hid_device *hdev, __u8 *rdesc,
65 unsigned int *rsize)
66{
67 switch (hdev->product) {
68 case USB_DEVICE_ID_LENOVO_TPPRODOCK:
69 /* the fixups that need to be done:
70 * - get a reasonable usage max for the vendor collection
71 * 0x8801 from the report ID 4
72 */
73 if (*rsize >= 153 &&
74 memcmp(&rdesc[140], lenovo_pro_dock_need_fixup_collection,
75 sizeof(lenovo_pro_dock_need_fixup_collection)) == 0) {
76 rdesc[151] = 0x01;
77 rdesc[152] = 0x00;
78 }
79 break;
80 }
81 return rdesc;
82}
83
84static int lenovo_input_mapping_tpkbd(struct hid_device *hdev,
85 struct hid_input *hi, struct hid_field *field,
86 struct hid_usage *usage, unsigned long **bit, int *max)
87{
88 if (usage->hid == (HID_UP_BUTTON | 0x0010)) {
89 /* This sub-device contains trackpoint, mark it */
90 hid_set_drvdata(hdev, (void *)1);
91 map_key_clear(KEY_MICMUTE);
92 return 1;
93 }
94 return 0;
95}
96
97static int lenovo_input_mapping_cptkbd(struct hid_device *hdev,
98 struct hid_input *hi, struct hid_field *field,
99 struct hid_usage *usage, unsigned long **bit, int *max)
100{
101 /* HID_UP_LNVENDOR = USB, HID_UP_MSVENDOR = BT */
102 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR ||
103 (usage->hid & HID_USAGE_PAGE) == HID_UP_LNVENDOR) {
104 switch (usage->hid & HID_USAGE) {
105 case 0x00f1: /* Fn-F4: Mic mute */
106 map_key_clear(KEY_MICMUTE);
107 return 1;
108 case 0x00f2: /* Fn-F5: Brightness down */
109 map_key_clear(KEY_BRIGHTNESSDOWN);
110 return 1;
111 case 0x00f3: /* Fn-F6: Brightness up */
112 map_key_clear(KEY_BRIGHTNESSUP);
113 return 1;
114 case 0x00f4: /* Fn-F7: External display (projector) */
115 map_key_clear(KEY_SWITCHVIDEOMODE);
116 return 1;
117 case 0x00f5: /* Fn-F8: Wireless */
118 map_key_clear(KEY_WLAN);
119 return 1;
120 case 0x00f6: /* Fn-F9: Control panel */
121 map_key_clear(KEY_CONFIG);
122 return 1;
123 case 0x00f8: /* Fn-F11: View open applications (3 boxes) */
124 map_key_clear(KEY_SCALE);
125 return 1;
126 case 0x00f9: /* Fn-F12: Open My computer (6 boxes) USB-only */
127 /* NB: This mapping is invented in raw_event below */
128 map_key_clear(KEY_FILE);
129 return 1;
130 case 0x00fa: /* Fn-Esc: Fn-lock toggle */
131 map_key_clear(KEY_FN_ESC);
132 return 1;
133 case 0x00fb: /* Middle mouse button (in native mode) */
134 map_key_clear(BTN_MIDDLE);
135 return 1;
136 }
137 }
138
139 /* Compatibility middle/wheel mappings should be ignored */
140 if (usage->hid == HID_GD_WHEEL)
141 return -1;
142 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON &&
143 (usage->hid & HID_USAGE) == 0x003)
144 return -1;
145 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER &&
146 (usage->hid & HID_USAGE) == 0x238)
147 return -1;
148
149 /* Map wheel emulation reports: 0xffa1 = USB, 0xff10 = BT */
150 if ((usage->hid & HID_USAGE_PAGE) == 0xff100000 ||
151 (usage->hid & HID_USAGE_PAGE) == 0xffa10000) {
152 field->flags |= HID_MAIN_ITEM_RELATIVE | HID_MAIN_ITEM_VARIABLE;
153 field->logical_minimum = -127;
154 field->logical_maximum = 127;
155
156 switch (usage->hid & HID_USAGE) {
157 case 0x0000:
158 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
159 return 1;
160 case 0x0001:
161 hid_map_usage(hi, usage, bit, max, EV_REL, REL_WHEEL);
162 return 1;
163 default:
164 return -1;
165 }
166 }
167
168 return 0;
169}
170
171static int lenovo_input_mapping_scrollpoint(struct hid_device *hdev,
172 struct hid_input *hi, struct hid_field *field,
173 struct hid_usage *usage, unsigned long **bit, int *max)
174{
175 if (usage->hid == HID_GD_Z) {
176 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
177 return 1;
178 }
179 return 0;
180}
181
182static int lenovo_input_mapping(struct hid_device *hdev,
183 struct hid_input *hi, struct hid_field *field,
184 struct hid_usage *usage, unsigned long **bit, int *max)
185{
186 switch (hdev->product) {
187 case USB_DEVICE_ID_LENOVO_TPKBD:
188 return lenovo_input_mapping_tpkbd(hdev, hi, field,
189 usage, bit, max);
190 case USB_DEVICE_ID_LENOVO_CUSBKBD:
191 case USB_DEVICE_ID_LENOVO_CBTKBD:
192 return lenovo_input_mapping_cptkbd(hdev, hi, field,
193 usage, bit, max);
194 case USB_DEVICE_ID_IBM_SCROLLPOINT_III:
195 case USB_DEVICE_ID_IBM_SCROLLPOINT_PRO:
196 case USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL:
197 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL:
198 case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO:
199 case USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL:
200 return lenovo_input_mapping_scrollpoint(hdev, hi, field,
201 usage, bit, max);
202 default:
203 return 0;
204 }
205}
206
207#undef map_key_clear
208
209/* Send a config command to the keyboard */
210static int lenovo_send_cmd_cptkbd(struct hid_device *hdev,
211 unsigned char byte2, unsigned char byte3)
212{
213 int ret;
214 unsigned char *buf;
215
216 buf = kzalloc(3, GFP_KERNEL);
217 if (!buf)
218 return -ENOMEM;
219
220 buf[0] = 0x18;
221 buf[1] = byte2;
222 buf[2] = byte3;
223
224 switch (hdev->product) {
225 case USB_DEVICE_ID_LENOVO_CUSBKBD:
226 ret = hid_hw_raw_request(hdev, 0x13, buf, 3,
227 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
228 break;
229 case USB_DEVICE_ID_LENOVO_CBTKBD:
230 ret = hid_hw_output_report(hdev, buf, 3);
231 break;
232 default:
233 ret = -EINVAL;
234 break;
235 }
236
237 kfree(buf);
238
239 return ret < 0 ? ret : 0; /* BT returns 0, USB returns sizeof(buf) */
240}
241
242static void lenovo_features_set_cptkbd(struct hid_device *hdev)
243{
244 int ret;
245 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
246
247 ret = lenovo_send_cmd_cptkbd(hdev, 0x05, cptkbd_data->fn_lock);
248 if (ret)
249 hid_err(hdev, "Fn-lock setting failed: %d\n", ret);
250
251 ret = lenovo_send_cmd_cptkbd(hdev, 0x02, cptkbd_data->sensitivity);
252 if (ret)
253 hid_err(hdev, "Sensitivity setting failed: %d\n", ret);
254}
255
256static ssize_t attr_fn_lock_show_cptkbd(struct device *dev,
257 struct device_attribute *attr,
258 char *buf)
259{
260 struct hid_device *hdev = to_hid_device(dev);
261 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
262
263 return snprintf(buf, PAGE_SIZE, "%u\n", cptkbd_data->fn_lock);
264}
265
266static ssize_t attr_fn_lock_store_cptkbd(struct device *dev,
267 struct device_attribute *attr,
268 const char *buf,
269 size_t count)
270{
271 struct hid_device *hdev = to_hid_device(dev);
272 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
273 int value;
274
275 if (kstrtoint(buf, 10, &value))
276 return -EINVAL;
277 if (value < 0 || value > 1)
278 return -EINVAL;
279
280 cptkbd_data->fn_lock = !!value;
281 lenovo_features_set_cptkbd(hdev);
282
283 return count;
284}
285
286static ssize_t attr_sensitivity_show_cptkbd(struct device *dev,
287 struct device_attribute *attr,
288 char *buf)
289{
290 struct hid_device *hdev = to_hid_device(dev);
291 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
292
293 return snprintf(buf, PAGE_SIZE, "%u\n",
294 cptkbd_data->sensitivity);
295}
296
297static ssize_t attr_sensitivity_store_cptkbd(struct device *dev,
298 struct device_attribute *attr,
299 const char *buf,
300 size_t count)
301{
302 struct hid_device *hdev = to_hid_device(dev);
303 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
304 int value;
305
306 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
307 return -EINVAL;
308
309 cptkbd_data->sensitivity = value;
310 lenovo_features_set_cptkbd(hdev);
311
312 return count;
313}
314
315
316static struct device_attribute dev_attr_fn_lock_cptkbd =
317 __ATTR(fn_lock, S_IWUSR | S_IRUGO,
318 attr_fn_lock_show_cptkbd,
319 attr_fn_lock_store_cptkbd);
320
321static struct device_attribute dev_attr_sensitivity_cptkbd =
322 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
323 attr_sensitivity_show_cptkbd,
324 attr_sensitivity_store_cptkbd);
325
326
327static struct attribute *lenovo_attributes_cptkbd[] = {
328 &dev_attr_fn_lock_cptkbd.attr,
329 &dev_attr_sensitivity_cptkbd.attr,
330 NULL
331};
332
333static const struct attribute_group lenovo_attr_group_cptkbd = {
334 .attrs = lenovo_attributes_cptkbd,
335};
336
337static int lenovo_raw_event(struct hid_device *hdev,
338 struct hid_report *report, u8 *data, int size)
339{
340 /*
341 * Compact USB keyboard's Fn-F12 report holds down many other keys, and
342 * its own key is outside the usage page range. Remove extra
343 * keypresses and remap to inside usage page.
344 */
345 if (unlikely(hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
346 && size == 3
347 && data[0] == 0x15
348 && data[1] == 0x94
349 && data[2] == 0x01)) {
350 data[1] = 0x00;
351 data[2] = 0x01;
352 }
353
354 return 0;
355}
356
357static int lenovo_event_cptkbd(struct hid_device *hdev,
358 struct hid_field *field, struct hid_usage *usage, __s32 value)
359{
360 struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
361
362 /* "wheel" scroll events */
363 if (usage->type == EV_REL && (usage->code == REL_WHEEL ||
364 usage->code == REL_HWHEEL)) {
365 /* Scroll events disable middle-click event */
366 cptkbd_data->middlebutton_state = 2;
367 return 0;
368 }
369
370 /* Middle click events */
371 if (usage->type == EV_KEY && usage->code == BTN_MIDDLE) {
372 if (value == 1) {
373 cptkbd_data->middlebutton_state = 1;
374 } else if (value == 0) {
375 if (cptkbd_data->middlebutton_state == 1) {
376 /* No scrolling inbetween, send middle-click */
377 input_event(field->hidinput->input,
378 EV_KEY, BTN_MIDDLE, 1);
379 input_sync(field->hidinput->input);
380 input_event(field->hidinput->input,
381 EV_KEY, BTN_MIDDLE, 0);
382 input_sync(field->hidinput->input);
383 }
384 cptkbd_data->middlebutton_state = 0;
385 }
386 return 1;
387 }
388
389 return 0;
390}
391
392static int lenovo_event(struct hid_device *hdev, struct hid_field *field,
393 struct hid_usage *usage, __s32 value)
394{
395 switch (hdev->product) {
396 case USB_DEVICE_ID_LENOVO_CUSBKBD:
397 case USB_DEVICE_ID_LENOVO_CBTKBD:
398 return lenovo_event_cptkbd(hdev, field, usage, value);
399 default:
400 return 0;
401 }
402}
403
404static int lenovo_features_set_tpkbd(struct hid_device *hdev)
405{
406 struct hid_report *report;
407 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
408
409 report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[4];
410
411 report->field[0]->value[0] = data_pointer->press_to_select ? 0x01 : 0x02;
412 report->field[0]->value[0] |= data_pointer->dragging ? 0x04 : 0x08;
413 report->field[0]->value[0] |= data_pointer->release_to_select ? 0x10 : 0x20;
414 report->field[0]->value[0] |= data_pointer->select_right ? 0x80 : 0x40;
415 report->field[1]->value[0] = 0x03; // unknown setting, imitate windows driver
416 report->field[2]->value[0] = data_pointer->sensitivity;
417 report->field[3]->value[0] = data_pointer->press_speed;
418
419 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
420 return 0;
421}
422
423static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,
424 struct device_attribute *attr,
425 char *buf)
426{
427 struct hid_device *hdev = to_hid_device(dev);
428 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
429
430 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->press_to_select);
431}
432
433static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,
434 struct device_attribute *attr,
435 const char *buf,
436 size_t count)
437{
438 struct hid_device *hdev = to_hid_device(dev);
439 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
440 int value;
441
442 if (kstrtoint(buf, 10, &value))
443 return -EINVAL;
444 if (value < 0 || value > 1)
445 return -EINVAL;
446
447 data_pointer->press_to_select = value;
448 lenovo_features_set_tpkbd(hdev);
449
450 return count;
451}
452
453static ssize_t attr_dragging_show_tpkbd(struct device *dev,
454 struct device_attribute *attr,
455 char *buf)
456{
457 struct hid_device *hdev = to_hid_device(dev);
458 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
459
460 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->dragging);
461}
462
463static ssize_t attr_dragging_store_tpkbd(struct device *dev,
464 struct device_attribute *attr,
465 const char *buf,
466 size_t count)
467{
468 struct hid_device *hdev = to_hid_device(dev);
469 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
470 int value;
471
472 if (kstrtoint(buf, 10, &value))
473 return -EINVAL;
474 if (value < 0 || value > 1)
475 return -EINVAL;
476
477 data_pointer->dragging = value;
478 lenovo_features_set_tpkbd(hdev);
479
480 return count;
481}
482
483static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,
484 struct device_attribute *attr,
485 char *buf)
486{
487 struct hid_device *hdev = to_hid_device(dev);
488 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
489
490 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->release_to_select);
491}
492
493static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,
494 struct device_attribute *attr,
495 const char *buf,
496 size_t count)
497{
498 struct hid_device *hdev = to_hid_device(dev);
499 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
500 int value;
501
502 if (kstrtoint(buf, 10, &value))
503 return -EINVAL;
504 if (value < 0 || value > 1)
505 return -EINVAL;
506
507 data_pointer->release_to_select = value;
508 lenovo_features_set_tpkbd(hdev);
509
510 return count;
511}
512
513static ssize_t attr_select_right_show_tpkbd(struct device *dev,
514 struct device_attribute *attr,
515 char *buf)
516{
517 struct hid_device *hdev = to_hid_device(dev);
518 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
519
520 return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->select_right);
521}
522
523static ssize_t attr_select_right_store_tpkbd(struct device *dev,
524 struct device_attribute *attr,
525 const char *buf,
526 size_t count)
527{
528 struct hid_device *hdev = to_hid_device(dev);
529 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
530 int value;
531
532 if (kstrtoint(buf, 10, &value))
533 return -EINVAL;
534 if (value < 0 || value > 1)
535 return -EINVAL;
536
537 data_pointer->select_right = value;
538 lenovo_features_set_tpkbd(hdev);
539
540 return count;
541}
542
543static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,
544 struct device_attribute *attr,
545 char *buf)
546{
547 struct hid_device *hdev = to_hid_device(dev);
548 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
549
550 return snprintf(buf, PAGE_SIZE, "%u\n",
551 data_pointer->sensitivity);
552}
553
554static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,
555 struct device_attribute *attr,
556 const char *buf,
557 size_t count)
558{
559 struct hid_device *hdev = to_hid_device(dev);
560 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
561 int value;
562
563 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
564 return -EINVAL;
565
566 data_pointer->sensitivity = value;
567 lenovo_features_set_tpkbd(hdev);
568
569 return count;
570}
571
572static ssize_t attr_press_speed_show_tpkbd(struct device *dev,
573 struct device_attribute *attr,
574 char *buf)
575{
576 struct hid_device *hdev = to_hid_device(dev);
577 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
578
579 return snprintf(buf, PAGE_SIZE, "%u\n",
580 data_pointer->press_speed);
581}
582
583static ssize_t attr_press_speed_store_tpkbd(struct device *dev,
584 struct device_attribute *attr,
585 const char *buf,
586 size_t count)
587{
588 struct hid_device *hdev = to_hid_device(dev);
589 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
590 int value;
591
592 if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
593 return -EINVAL;
594
595 data_pointer->press_speed = value;
596 lenovo_features_set_tpkbd(hdev);
597
598 return count;
599}
600
601static struct device_attribute dev_attr_press_to_select_tpkbd =
602 __ATTR(press_to_select, S_IWUSR | S_IRUGO,
603 attr_press_to_select_show_tpkbd,
604 attr_press_to_select_store_tpkbd);
605
606static struct device_attribute dev_attr_dragging_tpkbd =
607 __ATTR(dragging, S_IWUSR | S_IRUGO,
608 attr_dragging_show_tpkbd,
609 attr_dragging_store_tpkbd);
610
611static struct device_attribute dev_attr_release_to_select_tpkbd =
612 __ATTR(release_to_select, S_IWUSR | S_IRUGO,
613 attr_release_to_select_show_tpkbd,
614 attr_release_to_select_store_tpkbd);
615
616static struct device_attribute dev_attr_select_right_tpkbd =
617 __ATTR(select_right, S_IWUSR | S_IRUGO,
618 attr_select_right_show_tpkbd,
619 attr_select_right_store_tpkbd);
620
621static struct device_attribute dev_attr_sensitivity_tpkbd =
622 __ATTR(sensitivity, S_IWUSR | S_IRUGO,
623 attr_sensitivity_show_tpkbd,
624 attr_sensitivity_store_tpkbd);
625
626static struct device_attribute dev_attr_press_speed_tpkbd =
627 __ATTR(press_speed, S_IWUSR | S_IRUGO,
628 attr_press_speed_show_tpkbd,
629 attr_press_speed_store_tpkbd);
630
631static struct attribute *lenovo_attributes_tpkbd[] = {
632 &dev_attr_press_to_select_tpkbd.attr,
633 &dev_attr_dragging_tpkbd.attr,
634 &dev_attr_release_to_select_tpkbd.attr,
635 &dev_attr_select_right_tpkbd.attr,
636 &dev_attr_sensitivity_tpkbd.attr,
637 &dev_attr_press_speed_tpkbd.attr,
638 NULL
639};
640
641static const struct attribute_group lenovo_attr_group_tpkbd = {
642 .attrs = lenovo_attributes_tpkbd,
643};
644
645static enum led_brightness lenovo_led_brightness_get_tpkbd(
646 struct led_classdev *led_cdev)
647{
648 struct device *dev = led_cdev->dev->parent;
649 struct hid_device *hdev = to_hid_device(dev);
650 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
651 int led_nr = 0;
652
653 if (led_cdev == &data_pointer->led_micmute)
654 led_nr = 1;
655
656 return data_pointer->led_state & (1 << led_nr)
657 ? LED_FULL
658 : LED_OFF;
659}
660
661static void lenovo_led_brightness_set_tpkbd(struct led_classdev *led_cdev,
662 enum led_brightness value)
663{
664 struct device *dev = led_cdev->dev->parent;
665 struct hid_device *hdev = to_hid_device(dev);
666 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
667 struct hid_report *report;
668 int led_nr = 0;
669
670 if (led_cdev == &data_pointer->led_micmute)
671 led_nr = 1;
672
673 if (value == LED_OFF)
674 data_pointer->led_state &= ~(1 << led_nr);
675 else
676 data_pointer->led_state |= 1 << led_nr;
677
678 report = hdev->report_enum[HID_OUTPUT_REPORT].report_id_hash[3];
679 report->field[0]->value[0] = (data_pointer->led_state >> 0) & 1;
680 report->field[0]->value[1] = (data_pointer->led_state >> 1) & 1;
681 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
682}
683
684static int lenovo_probe_tpkbd(struct hid_device *hdev)
685{
686 struct device *dev = &hdev->dev;
687 struct lenovo_drvdata_tpkbd *data_pointer;
688 size_t name_sz = strlen(dev_name(dev)) + 16;
689 char *name_mute, *name_micmute;
690 int i;
691 int ret;
692
693 /*
694 * Only register extra settings against subdevice where input_mapping
695 * set drvdata to 1, i.e. the trackpoint.
696 */
697 if (!hid_get_drvdata(hdev))
698 return 0;
699
700 hid_set_drvdata(hdev, NULL);
701
702 /* Validate required reports. */
703 for (i = 0; i < 4; i++) {
704 if (!hid_validate_values(hdev, HID_FEATURE_REPORT, 4, i, 1))
705 return -ENODEV;
706 }
707 if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, 3, 0, 2))
708 return -ENODEV;
709
710 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
711 if (ret)
712 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
713
714 data_pointer = devm_kzalloc(&hdev->dev,
715 sizeof(struct lenovo_drvdata_tpkbd),
716 GFP_KERNEL);
717 if (data_pointer == NULL) {
718 hid_err(hdev, "Could not allocate memory for driver data\n");
719 ret = -ENOMEM;
720 goto err;
721 }
722
723 // set same default values as windows driver
724 data_pointer->sensitivity = 0xa0;
725 data_pointer->press_speed = 0x38;
726
727 name_mute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
728 name_micmute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
729 if (name_mute == NULL || name_micmute == NULL) {
730 hid_err(hdev, "Could not allocate memory for led data\n");
731 ret = -ENOMEM;
732 goto err;
733 }
734 snprintf(name_mute, name_sz, "%s:amber:mute", dev_name(dev));
735 snprintf(name_micmute, name_sz, "%s:amber:micmute", dev_name(dev));
736
737 hid_set_drvdata(hdev, data_pointer);
738
739 data_pointer->led_mute.name = name_mute;
740 data_pointer->led_mute.brightness_get = lenovo_led_brightness_get_tpkbd;
741 data_pointer->led_mute.brightness_set = lenovo_led_brightness_set_tpkbd;
742 data_pointer->led_mute.dev = dev;
743 ret = led_classdev_register(dev, &data_pointer->led_mute);
744 if (ret < 0)
745 goto err;
746
747 data_pointer->led_micmute.name = name_micmute;
748 data_pointer->led_micmute.brightness_get =
749 lenovo_led_brightness_get_tpkbd;
750 data_pointer->led_micmute.brightness_set =
751 lenovo_led_brightness_set_tpkbd;
752 data_pointer->led_micmute.dev = dev;
753 ret = led_classdev_register(dev, &data_pointer->led_micmute);
754 if (ret < 0) {
755 led_classdev_unregister(&data_pointer->led_mute);
756 goto err;
757 }
758
759 lenovo_features_set_tpkbd(hdev);
760
761 return 0;
762err:
763 sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
764 return ret;
765}
766
767static int lenovo_probe_cptkbd(struct hid_device *hdev)
768{
769 int ret;
770 struct lenovo_drvdata_cptkbd *cptkbd_data;
771
772 /* All the custom action happens on the USBMOUSE device for USB */
773 if (hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
774 && hdev->type != HID_TYPE_USBMOUSE) {
775 hid_dbg(hdev, "Ignoring keyboard half of device\n");
776 return 0;
777 }
778
779 cptkbd_data = devm_kzalloc(&hdev->dev,
780 sizeof(*cptkbd_data),
781 GFP_KERNEL);
782 if (cptkbd_data == NULL) {
783 hid_err(hdev, "can't alloc keyboard descriptor\n");
784 return -ENOMEM;
785 }
786 hid_set_drvdata(hdev, cptkbd_data);
787
788 /*
789 * Tell the keyboard a driver understands it, and turn F7, F9, F11 into
790 * regular keys
791 */
792 ret = lenovo_send_cmd_cptkbd(hdev, 0x01, 0x03);
793 if (ret)
794 hid_warn(hdev, "Failed to switch F7/9/11 mode: %d\n", ret);
795
796 /* Switch middle button to native mode */
797 ret = lenovo_send_cmd_cptkbd(hdev, 0x09, 0x01);
798 if (ret)
799 hid_warn(hdev, "Failed to switch middle button: %d\n", ret);
800
801 /* Set keyboard settings to known state */
802 cptkbd_data->middlebutton_state = 0;
803 cptkbd_data->fn_lock = true;
804 cptkbd_data->sensitivity = 0x05;
805 lenovo_features_set_cptkbd(hdev);
806
807 ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_cptkbd);
808 if (ret)
809 hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
810
811 return 0;
812}
813
814static int lenovo_probe(struct hid_device *hdev,
815 const struct hid_device_id *id)
816{
817 int ret;
818
819 ret = hid_parse(hdev);
820 if (ret) {
821 hid_err(hdev, "hid_parse failed\n");
822 goto err;
823 }
824
825 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
826 if (ret) {
827 hid_err(hdev, "hid_hw_start failed\n");
828 goto err;
829 }
830
831 switch (hdev->product) {
832 case USB_DEVICE_ID_LENOVO_TPKBD:
833 ret = lenovo_probe_tpkbd(hdev);
834 break;
835 case USB_DEVICE_ID_LENOVO_CUSBKBD:
836 case USB_DEVICE_ID_LENOVO_CBTKBD:
837 ret = lenovo_probe_cptkbd(hdev);
838 break;
839 default:
840 ret = 0;
841 break;
842 }
843 if (ret)
844 goto err_hid;
845
846 return 0;
847err_hid:
848 hid_hw_stop(hdev);
849err:
850 return ret;
851}
852
853static void lenovo_remove_tpkbd(struct hid_device *hdev)
854{
855 struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
856
857 /*
858 * Only the trackpoint half of the keyboard has drvdata and stuff that
859 * needs unregistering.
860 */
861 if (data_pointer == NULL)
862 return;
863
864 sysfs_remove_group(&hdev->dev.kobj,
865 &lenovo_attr_group_tpkbd);
866
867 led_classdev_unregister(&data_pointer->led_micmute);
868 led_classdev_unregister(&data_pointer->led_mute);
869}
870
871static void lenovo_remove_cptkbd(struct hid_device *hdev)
872{
873 sysfs_remove_group(&hdev->dev.kobj,
874 &lenovo_attr_group_cptkbd);
875}
876
877static void lenovo_remove(struct hid_device *hdev)
878{
879 switch (hdev->product) {
880 case USB_DEVICE_ID_LENOVO_TPKBD:
881 lenovo_remove_tpkbd(hdev);
882 break;
883 case USB_DEVICE_ID_LENOVO_CUSBKBD:
884 case USB_DEVICE_ID_LENOVO_CBTKBD:
885 lenovo_remove_cptkbd(hdev);
886 break;
887 }
888
889 hid_hw_stop(hdev);
890}
891
892static int lenovo_input_configured(struct hid_device *hdev,
893 struct hid_input *hi)
894{
895 switch (hdev->product) {
896 case USB_DEVICE_ID_LENOVO_TPKBD:
897 case USB_DEVICE_ID_LENOVO_CUSBKBD:
898 case USB_DEVICE_ID_LENOVO_CBTKBD:
899 if (test_bit(EV_REL, hi->input->evbit)) {
900 /* set only for trackpoint device */
901 __set_bit(INPUT_PROP_POINTER, hi->input->propbit);
902 __set_bit(INPUT_PROP_POINTING_STICK,
903 hi->input->propbit);
904 }
905 break;
906 }
907
908 return 0;
909}
910
911
912static const struct hid_device_id lenovo_devices[] = {
913 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },
914 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CUSBKBD) },
915 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CBTKBD) },
916 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPPRODOCK) },
917 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_III) },
918 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_PRO) },
919 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL) },
920 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL) },
921 { HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO) },
922 { HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL) },
923 { }
924};
925
926MODULE_DEVICE_TABLE(hid, lenovo_devices);
927
928static struct hid_driver lenovo_driver = {
929 .name = "lenovo",
930 .id_table = lenovo_devices,
931 .input_configured = lenovo_input_configured,
932 .input_mapping = lenovo_input_mapping,
933 .probe = lenovo_probe,
934 .remove = lenovo_remove,
935 .raw_event = lenovo_raw_event,
936 .event = lenovo_event,
937 .report_fixup = lenovo_report_fixup,
938};
939module_hid_driver(lenovo_driver);
940
941MODULE_LICENSE("GPL");