xref: /openbmc/linux/drivers/hid/hid-lenovo.c (revision 70151949)
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 
40 struct 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 
74 static 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 
101 static 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 
110 static 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) */
120 static 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 
136 static __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 
169 static 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 
182 static 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 
256 static 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 
351 static 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 
362 static 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 
400 static 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 
448 static 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 */
485 static 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 
524 static 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 	ret = lenovo_send_cmd_cptkbd(hdev, 0x05, cptkbd_data->fn_lock);
530 	if (ret)
531 		hid_err(hdev, "Fn-lock setting failed: %d\n", ret);
532 
533 	ret = lenovo_send_cmd_cptkbd(hdev, 0x02, cptkbd_data->sensitivity);
534 	if (ret)
535 		hid_err(hdev, "Sensitivity setting failed: %d\n", ret);
536 }
537 
538 static ssize_t attr_fn_lock_show(struct device *dev,
539 		struct device_attribute *attr,
540 		char *buf)
541 {
542 	struct hid_device *hdev = to_hid_device(dev);
543 	struct lenovo_drvdata *data = hid_get_drvdata(hdev);
544 
545 	return snprintf(buf, PAGE_SIZE, "%u\n", data->fn_lock);
546 }
547 
548 static ssize_t attr_fn_lock_store(struct device *dev,
549 		struct device_attribute *attr,
550 		const char *buf,
551 		size_t count)
552 {
553 	struct hid_device *hdev = to_hid_device(dev);
554 	struct lenovo_drvdata *data = hid_get_drvdata(hdev);
555 	int value, ret;
556 
557 	if (kstrtoint(buf, 10, &value))
558 		return -EINVAL;
559 	if (value < 0 || value > 1)
560 		return -EINVAL;
561 
562 	data->fn_lock = !!value;
563 
564 	switch (hdev->product) {
565 	case USB_DEVICE_ID_LENOVO_CUSBKBD:
566 	case USB_DEVICE_ID_LENOVO_CBTKBD:
567 	case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
568 	case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
569 		lenovo_features_set_cptkbd(hdev);
570 		break;
571 	case USB_DEVICE_ID_LENOVO_TP10UBKBD:
572 	case USB_DEVICE_ID_LENOVO_X1_TAB:
573 		ret = lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, value);
574 		if (ret)
575 			return ret;
576 		break;
577 	}
578 
579 	return count;
580 }
581 
582 static ssize_t attr_sensitivity_show_cptkbd(struct device *dev,
583 		struct device_attribute *attr,
584 		char *buf)
585 {
586 	struct hid_device *hdev = to_hid_device(dev);
587 	struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
588 
589 	return snprintf(buf, PAGE_SIZE, "%u\n",
590 		cptkbd_data->sensitivity);
591 }
592 
593 static ssize_t attr_sensitivity_store_cptkbd(struct device *dev,
594 		struct device_attribute *attr,
595 		const char *buf,
596 		size_t count)
597 {
598 	struct hid_device *hdev = to_hid_device(dev);
599 	struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
600 	int value;
601 
602 	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
603 		return -EINVAL;
604 
605 	cptkbd_data->sensitivity = value;
606 	lenovo_features_set_cptkbd(hdev);
607 
608 	return count;
609 }
610 
611 
612 static struct device_attribute dev_attr_fn_lock =
613 	__ATTR(fn_lock, S_IWUSR | S_IRUGO,
614 			attr_fn_lock_show,
615 			attr_fn_lock_store);
616 
617 static struct device_attribute dev_attr_sensitivity_cptkbd =
618 	__ATTR(sensitivity, S_IWUSR | S_IRUGO,
619 			attr_sensitivity_show_cptkbd,
620 			attr_sensitivity_store_cptkbd);
621 
622 
623 static struct attribute *lenovo_attributes_cptkbd[] = {
624 	&dev_attr_fn_lock.attr,
625 	&dev_attr_sensitivity_cptkbd.attr,
626 	NULL
627 };
628 
629 static const struct attribute_group lenovo_attr_group_cptkbd = {
630 	.attrs = lenovo_attributes_cptkbd,
631 };
632 
633 static int lenovo_raw_event(struct hid_device *hdev,
634 			struct hid_report *report, u8 *data, int size)
635 {
636 	/*
637 	 * Compact USB keyboard's Fn-F12 report holds down many other keys, and
638 	 * its own key is outside the usage page range. Remove extra
639 	 * keypresses and remap to inside usage page.
640 	 */
641 	if (unlikely(hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
642 			&& size == 3
643 			&& data[0] == 0x15
644 			&& data[1] == 0x94
645 			&& data[2] == 0x01)) {
646 		data[1] = 0x00;
647 		data[2] = 0x01;
648 	}
649 
650 	return 0;
651 }
652 
653 static int lenovo_event_tp10ubkbd(struct hid_device *hdev,
654 		struct hid_field *field, struct hid_usage *usage, __s32 value)
655 {
656 	struct lenovo_drvdata *data = hid_get_drvdata(hdev);
657 
658 	if (usage->type == EV_KEY && usage->code == KEY_FN_ESC && value == 1) {
659 		/*
660 		 * The user has toggled the Fn-lock state. Toggle our own
661 		 * cached value of it and sync our value to the keyboard to
662 		 * ensure things are in sync (the sycning should be a no-op).
663 		 */
664 		data->fn_lock = !data->fn_lock;
665 		schedule_work(&data->fn_lock_sync_work);
666 	}
667 
668 	return 0;
669 }
670 
671 static int lenovo_event_cptkbd(struct hid_device *hdev,
672 		struct hid_field *field, struct hid_usage *usage, __s32 value)
673 {
674 	struct lenovo_drvdata *cptkbd_data = hid_get_drvdata(hdev);
675 
676 	if (cptkbd_data->middlebutton_state != 3) {
677 		/* REL_X and REL_Y events during middle button pressed
678 		 * are only possible on patched, bug-free firmware
679 		 * so set middlebutton_state to 3
680 		 * to never apply workaround anymore
681 		 */
682 		if (cptkbd_data->middlebutton_state == 1 &&
683 				usage->type == EV_REL &&
684 				(usage->code == REL_X || usage->code == REL_Y)) {
685 			cptkbd_data->middlebutton_state = 3;
686 			/* send middle button press which was hold before */
687 			input_event(field->hidinput->input,
688 				EV_KEY, BTN_MIDDLE, 1);
689 			input_sync(field->hidinput->input);
690 		}
691 
692 		/* "wheel" scroll events */
693 		if (usage->type == EV_REL && (usage->code == REL_WHEEL ||
694 				usage->code == REL_HWHEEL)) {
695 			/* Scroll events disable middle-click event */
696 			cptkbd_data->middlebutton_state = 2;
697 			return 0;
698 		}
699 
700 		/* Middle click events */
701 		if (usage->type == EV_KEY && usage->code == BTN_MIDDLE) {
702 			if (value == 1) {
703 				cptkbd_data->middlebutton_state = 1;
704 			} else if (value == 0) {
705 				if (cptkbd_data->middlebutton_state == 1) {
706 					/* No scrolling inbetween, send middle-click */
707 					input_event(field->hidinput->input,
708 						EV_KEY, BTN_MIDDLE, 1);
709 					input_sync(field->hidinput->input);
710 					input_event(field->hidinput->input,
711 						EV_KEY, BTN_MIDDLE, 0);
712 					input_sync(field->hidinput->input);
713 				}
714 				cptkbd_data->middlebutton_state = 0;
715 			}
716 			return 1;
717 		}
718 	}
719 
720 	if (usage->type == EV_KEY && usage->code == KEY_FN_ESC && value == 1) {
721 		/*
722 		 * The user has toggled the Fn-lock state. Toggle our own
723 		 * cached value of it and sync our value to the keyboard to
724 		 * ensure things are in sync (the syncing should be a no-op).
725 		 */
726 		cptkbd_data->fn_lock = !cptkbd_data->fn_lock;
727 	}
728 
729 	return 0;
730 }
731 
732 static int lenovo_event(struct hid_device *hdev, struct hid_field *field,
733 		struct hid_usage *usage, __s32 value)
734 {
735 	if (!hid_get_drvdata(hdev))
736 		return 0;
737 
738 	switch (hdev->product) {
739 	case USB_DEVICE_ID_LENOVO_CUSBKBD:
740 	case USB_DEVICE_ID_LENOVO_CBTKBD:
741 	case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
742 	case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
743 		return lenovo_event_cptkbd(hdev, field, usage, value);
744 	case USB_DEVICE_ID_LENOVO_TP10UBKBD:
745 	case USB_DEVICE_ID_LENOVO_X1_TAB:
746 		return lenovo_event_tp10ubkbd(hdev, field, usage, value);
747 	default:
748 		return 0;
749 	}
750 }
751 
752 static int lenovo_features_set_tpkbd(struct hid_device *hdev)
753 {
754 	struct hid_report *report;
755 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
756 
757 	report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[4];
758 
759 	report->field[0]->value[0]  = data_pointer->press_to_select   ? 0x01 : 0x02;
760 	report->field[0]->value[0] |= data_pointer->dragging          ? 0x04 : 0x08;
761 	report->field[0]->value[0] |= data_pointer->release_to_select ? 0x10 : 0x20;
762 	report->field[0]->value[0] |= data_pointer->select_right      ? 0x80 : 0x40;
763 	report->field[1]->value[0] = 0x03; // unknown setting, imitate windows driver
764 	report->field[2]->value[0] = data_pointer->sensitivity;
765 	report->field[3]->value[0] = data_pointer->press_speed;
766 
767 	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
768 	return 0;
769 }
770 
771 static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,
772 		struct device_attribute *attr,
773 		char *buf)
774 {
775 	struct hid_device *hdev = to_hid_device(dev);
776 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
777 
778 	return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->press_to_select);
779 }
780 
781 static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,
782 		struct device_attribute *attr,
783 		const char *buf,
784 		size_t count)
785 {
786 	struct hid_device *hdev = to_hid_device(dev);
787 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
788 	int value;
789 
790 	if (kstrtoint(buf, 10, &value))
791 		return -EINVAL;
792 	if (value < 0 || value > 1)
793 		return -EINVAL;
794 
795 	data_pointer->press_to_select = value;
796 	lenovo_features_set_tpkbd(hdev);
797 
798 	return count;
799 }
800 
801 static ssize_t attr_dragging_show_tpkbd(struct device *dev,
802 		struct device_attribute *attr,
803 		char *buf)
804 {
805 	struct hid_device *hdev = to_hid_device(dev);
806 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
807 
808 	return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->dragging);
809 }
810 
811 static ssize_t attr_dragging_store_tpkbd(struct device *dev,
812 		struct device_attribute *attr,
813 		const char *buf,
814 		size_t count)
815 {
816 	struct hid_device *hdev = to_hid_device(dev);
817 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
818 	int value;
819 
820 	if (kstrtoint(buf, 10, &value))
821 		return -EINVAL;
822 	if (value < 0 || value > 1)
823 		return -EINVAL;
824 
825 	data_pointer->dragging = value;
826 	lenovo_features_set_tpkbd(hdev);
827 
828 	return count;
829 }
830 
831 static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,
832 		struct device_attribute *attr,
833 		char *buf)
834 {
835 	struct hid_device *hdev = to_hid_device(dev);
836 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
837 
838 	return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->release_to_select);
839 }
840 
841 static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,
842 		struct device_attribute *attr,
843 		const char *buf,
844 		size_t count)
845 {
846 	struct hid_device *hdev = to_hid_device(dev);
847 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
848 	int value;
849 
850 	if (kstrtoint(buf, 10, &value))
851 		return -EINVAL;
852 	if (value < 0 || value > 1)
853 		return -EINVAL;
854 
855 	data_pointer->release_to_select = value;
856 	lenovo_features_set_tpkbd(hdev);
857 
858 	return count;
859 }
860 
861 static ssize_t attr_select_right_show_tpkbd(struct device *dev,
862 		struct device_attribute *attr,
863 		char *buf)
864 {
865 	struct hid_device *hdev = to_hid_device(dev);
866 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
867 
868 	return snprintf(buf, PAGE_SIZE, "%u\n", data_pointer->select_right);
869 }
870 
871 static ssize_t attr_select_right_store_tpkbd(struct device *dev,
872 		struct device_attribute *attr,
873 		const char *buf,
874 		size_t count)
875 {
876 	struct hid_device *hdev = to_hid_device(dev);
877 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
878 	int value;
879 
880 	if (kstrtoint(buf, 10, &value))
881 		return -EINVAL;
882 	if (value < 0 || value > 1)
883 		return -EINVAL;
884 
885 	data_pointer->select_right = value;
886 	lenovo_features_set_tpkbd(hdev);
887 
888 	return count;
889 }
890 
891 static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,
892 		struct device_attribute *attr,
893 		char *buf)
894 {
895 	struct hid_device *hdev = to_hid_device(dev);
896 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
897 
898 	return snprintf(buf, PAGE_SIZE, "%u\n",
899 		data_pointer->sensitivity);
900 }
901 
902 static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,
903 		struct device_attribute *attr,
904 		const char *buf,
905 		size_t count)
906 {
907 	struct hid_device *hdev = to_hid_device(dev);
908 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
909 	int value;
910 
911 	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
912 		return -EINVAL;
913 
914 	data_pointer->sensitivity = value;
915 	lenovo_features_set_tpkbd(hdev);
916 
917 	return count;
918 }
919 
920 static ssize_t attr_press_speed_show_tpkbd(struct device *dev,
921 		struct device_attribute *attr,
922 		char *buf)
923 {
924 	struct hid_device *hdev = to_hid_device(dev);
925 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
926 
927 	return snprintf(buf, PAGE_SIZE, "%u\n",
928 		data_pointer->press_speed);
929 }
930 
931 static ssize_t attr_press_speed_store_tpkbd(struct device *dev,
932 		struct device_attribute *attr,
933 		const char *buf,
934 		size_t count)
935 {
936 	struct hid_device *hdev = to_hid_device(dev);
937 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
938 	int value;
939 
940 	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
941 		return -EINVAL;
942 
943 	data_pointer->press_speed = value;
944 	lenovo_features_set_tpkbd(hdev);
945 
946 	return count;
947 }
948 
949 static struct device_attribute dev_attr_press_to_select_tpkbd =
950 	__ATTR(press_to_select, S_IWUSR | S_IRUGO,
951 			attr_press_to_select_show_tpkbd,
952 			attr_press_to_select_store_tpkbd);
953 
954 static struct device_attribute dev_attr_dragging_tpkbd =
955 	__ATTR(dragging, S_IWUSR | S_IRUGO,
956 			attr_dragging_show_tpkbd,
957 			attr_dragging_store_tpkbd);
958 
959 static struct device_attribute dev_attr_release_to_select_tpkbd =
960 	__ATTR(release_to_select, S_IWUSR | S_IRUGO,
961 			attr_release_to_select_show_tpkbd,
962 			attr_release_to_select_store_tpkbd);
963 
964 static struct device_attribute dev_attr_select_right_tpkbd =
965 	__ATTR(select_right, S_IWUSR | S_IRUGO,
966 			attr_select_right_show_tpkbd,
967 			attr_select_right_store_tpkbd);
968 
969 static struct device_attribute dev_attr_sensitivity_tpkbd =
970 	__ATTR(sensitivity, S_IWUSR | S_IRUGO,
971 			attr_sensitivity_show_tpkbd,
972 			attr_sensitivity_store_tpkbd);
973 
974 static struct device_attribute dev_attr_press_speed_tpkbd =
975 	__ATTR(press_speed, S_IWUSR | S_IRUGO,
976 			attr_press_speed_show_tpkbd,
977 			attr_press_speed_store_tpkbd);
978 
979 static struct attribute *lenovo_attributes_tpkbd[] = {
980 	&dev_attr_press_to_select_tpkbd.attr,
981 	&dev_attr_dragging_tpkbd.attr,
982 	&dev_attr_release_to_select_tpkbd.attr,
983 	&dev_attr_select_right_tpkbd.attr,
984 	&dev_attr_sensitivity_tpkbd.attr,
985 	&dev_attr_press_speed_tpkbd.attr,
986 	NULL
987 };
988 
989 static const struct attribute_group lenovo_attr_group_tpkbd = {
990 	.attrs = lenovo_attributes_tpkbd,
991 };
992 
993 static void lenovo_led_set_tpkbd(struct hid_device *hdev)
994 {
995 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
996 	struct hid_report *report;
997 
998 	report = hdev->report_enum[HID_OUTPUT_REPORT].report_id_hash[3];
999 	report->field[0]->value[0] = (data_pointer->led_state >> 0) & 1;
1000 	report->field[0]->value[1] = (data_pointer->led_state >> 1) & 1;
1001 	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
1002 }
1003 
1004 static int lenovo_led_brightness_set(struct led_classdev *led_cdev,
1005 			enum led_brightness value)
1006 {
1007 	struct device *dev = led_cdev->dev->parent;
1008 	struct hid_device *hdev = to_hid_device(dev);
1009 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1010 	static const u8 tp10ubkbd_led[] = { TP10UBKBD_MUTE_LED, TP10UBKBD_MICMUTE_LED };
1011 	int led_nr = 0;
1012 	int ret = 0;
1013 
1014 	if (led_cdev == &data_pointer->led_micmute)
1015 		led_nr = 1;
1016 
1017 	if (value == LED_OFF)
1018 		data_pointer->led_state &= ~(1 << led_nr);
1019 	else
1020 		data_pointer->led_state |= 1 << led_nr;
1021 
1022 	switch (hdev->product) {
1023 	case USB_DEVICE_ID_LENOVO_TPKBD:
1024 		lenovo_led_set_tpkbd(hdev);
1025 		break;
1026 	case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1027 	case USB_DEVICE_ID_LENOVO_X1_TAB:
1028 		ret = lenovo_led_set_tp10ubkbd(hdev, tp10ubkbd_led[led_nr], value);
1029 		break;
1030 	}
1031 
1032 	return ret;
1033 }
1034 
1035 static int lenovo_register_leds(struct hid_device *hdev)
1036 {
1037 	struct lenovo_drvdata *data = hid_get_drvdata(hdev);
1038 	size_t name_sz = strlen(dev_name(&hdev->dev)) + 16;
1039 	char *name_mute, *name_micm;
1040 	int ret;
1041 
1042 	name_mute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
1043 	name_micm = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
1044 	if (name_mute == NULL || name_micm == NULL) {
1045 		hid_err(hdev, "Could not allocate memory for led data\n");
1046 		return -ENOMEM;
1047 	}
1048 	snprintf(name_mute, name_sz, "%s:amber:mute", dev_name(&hdev->dev));
1049 	snprintf(name_micm, name_sz, "%s:amber:micmute", dev_name(&hdev->dev));
1050 
1051 	data->led_mute.name = name_mute;
1052 	data->led_mute.default_trigger = "audio-mute";
1053 	data->led_mute.brightness_set_blocking = lenovo_led_brightness_set;
1054 	data->led_mute.max_brightness = 1;
1055 	data->led_mute.flags = LED_HW_PLUGGABLE;
1056 	data->led_mute.dev = &hdev->dev;
1057 	ret = led_classdev_register(&hdev->dev, &data->led_mute);
1058 	if (ret < 0)
1059 		return ret;
1060 
1061 	data->led_micmute.name = name_micm;
1062 	data->led_micmute.default_trigger = "audio-micmute";
1063 	data->led_micmute.brightness_set_blocking = lenovo_led_brightness_set;
1064 	data->led_micmute.max_brightness = 1;
1065 	data->led_micmute.flags = LED_HW_PLUGGABLE;
1066 	data->led_micmute.dev = &hdev->dev;
1067 	ret = led_classdev_register(&hdev->dev, &data->led_micmute);
1068 	if (ret < 0) {
1069 		led_classdev_unregister(&data->led_mute);
1070 		return ret;
1071 	}
1072 
1073 	return 0;
1074 }
1075 
1076 static int lenovo_probe_tpkbd(struct hid_device *hdev)
1077 {
1078 	struct lenovo_drvdata *data_pointer;
1079 	int i, ret;
1080 
1081 	/*
1082 	 * Only register extra settings against subdevice where input_mapping
1083 	 * set drvdata to 1, i.e. the trackpoint.
1084 	 */
1085 	if (!hid_get_drvdata(hdev))
1086 		return 0;
1087 
1088 	hid_set_drvdata(hdev, NULL);
1089 
1090 	/* Validate required reports. */
1091 	for (i = 0; i < 4; i++) {
1092 		if (!hid_validate_values(hdev, HID_FEATURE_REPORT, 4, i, 1))
1093 			return -ENODEV;
1094 	}
1095 	if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, 3, 0, 2))
1096 		return -ENODEV;
1097 
1098 	ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
1099 	if (ret)
1100 		hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
1101 
1102 	data_pointer = devm_kzalloc(&hdev->dev,
1103 				    sizeof(struct lenovo_drvdata),
1104 				    GFP_KERNEL);
1105 	if (data_pointer == NULL) {
1106 		hid_err(hdev, "Could not allocate memory for driver data\n");
1107 		ret = -ENOMEM;
1108 		goto err;
1109 	}
1110 
1111 	// set same default values as windows driver
1112 	data_pointer->sensitivity = 0xa0;
1113 	data_pointer->press_speed = 0x38;
1114 
1115 	hid_set_drvdata(hdev, data_pointer);
1116 
1117 	ret = lenovo_register_leds(hdev);
1118 	if (ret)
1119 		goto err;
1120 
1121 	lenovo_features_set_tpkbd(hdev);
1122 
1123 	return 0;
1124 err:
1125 	sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
1126 	return ret;
1127 }
1128 
1129 static int lenovo_probe_cptkbd(struct hid_device *hdev)
1130 {
1131 	int ret;
1132 	struct lenovo_drvdata *cptkbd_data;
1133 
1134 	/* All the custom action happens on the USBMOUSE device for USB */
1135 	if (((hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD) ||
1136 	    (hdev->product == USB_DEVICE_ID_LENOVO_TPIIUSBKBD)) &&
1137 	    hdev->type != HID_TYPE_USBMOUSE) {
1138 		hid_dbg(hdev, "Ignoring keyboard half of device\n");
1139 		return 0;
1140 	}
1141 
1142 	cptkbd_data = devm_kzalloc(&hdev->dev,
1143 					sizeof(*cptkbd_data),
1144 					GFP_KERNEL);
1145 	if (cptkbd_data == NULL) {
1146 		hid_err(hdev, "can't alloc keyboard descriptor\n");
1147 		return -ENOMEM;
1148 	}
1149 	hid_set_drvdata(hdev, cptkbd_data);
1150 
1151 	/*
1152 	 * Tell the keyboard a driver understands it, and turn F7, F9, F11 into
1153 	 * regular keys (Compact only)
1154 	 */
1155 	if (hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD ||
1156 	    hdev->product == USB_DEVICE_ID_LENOVO_CBTKBD) {
1157 		ret = lenovo_send_cmd_cptkbd(hdev, 0x01, 0x03);
1158 		if (ret)
1159 			hid_warn(hdev, "Failed to switch F7/9/11 mode: %d\n", ret);
1160 	}
1161 
1162 	/* Switch middle button to native mode */
1163 	ret = lenovo_send_cmd_cptkbd(hdev, 0x09, 0x01);
1164 	if (ret)
1165 		hid_warn(hdev, "Failed to switch middle button: %d\n", ret);
1166 
1167 	/* Set keyboard settings to known state */
1168 	cptkbd_data->middlebutton_state = 0;
1169 	cptkbd_data->fn_lock = true;
1170 	cptkbd_data->sensitivity = 0x05;
1171 	lenovo_features_set_cptkbd(hdev);
1172 
1173 	ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_cptkbd);
1174 	if (ret)
1175 		hid_warn(hdev, "Could not create sysfs group: %d\n", ret);
1176 
1177 	return 0;
1178 }
1179 
1180 static struct attribute *lenovo_attributes_tp10ubkbd[] = {
1181 	&dev_attr_fn_lock.attr,
1182 	NULL
1183 };
1184 
1185 static const struct attribute_group lenovo_attr_group_tp10ubkbd = {
1186 	.attrs = lenovo_attributes_tp10ubkbd,
1187 };
1188 
1189 static int lenovo_probe_tp10ubkbd(struct hid_device *hdev)
1190 {
1191 	struct hid_report_enum *rep_enum;
1192 	struct lenovo_drvdata *data;
1193 	struct hid_report *rep;
1194 	bool found;
1195 	int ret;
1196 
1197 	/*
1198 	 * The LEDs and the Fn-lock functionality use output report 9,
1199 	 * with an application of 0xffa0001, add the LEDs on the interface
1200 	 * with this output report.
1201 	 */
1202 	found = false;
1203 	rep_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
1204 	list_for_each_entry(rep, &rep_enum->report_list, list) {
1205 		if (rep->application == 0xffa00001)
1206 			found = true;
1207 	}
1208 	if (!found)
1209 		return 0;
1210 
1211 	data = devm_kzalloc(&hdev->dev, sizeof(*data), GFP_KERNEL);
1212 	if (!data)
1213 		return -ENOMEM;
1214 
1215 	mutex_init(&data->led_report_mutex);
1216 	INIT_WORK(&data->fn_lock_sync_work, lenovo_tp10ubkbd_sync_fn_lock);
1217 	data->hdev = hdev;
1218 
1219 	hid_set_drvdata(hdev, data);
1220 
1221 	/*
1222 	 * The Thinkpad 10 ultrabook USB kbd dock's Fn-lock defaults to on.
1223 	 * We cannot read the state, only set it, so we force it to on here
1224 	 * (which should be a no-op) to make sure that our state matches the
1225 	 * keyboard's FN-lock state. This is the same as what Windows does.
1226 	 */
1227 	data->fn_lock = true;
1228 	lenovo_led_set_tp10ubkbd(hdev, TP10UBKBD_FN_LOCK_LED, data->fn_lock);
1229 
1230 	ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1231 	if (ret)
1232 		return ret;
1233 
1234 	ret = lenovo_register_leds(hdev);
1235 	if (ret)
1236 		goto err;
1237 
1238 	return 0;
1239 err:
1240 	sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1241 	return ret;
1242 }
1243 
1244 static int lenovo_probe(struct hid_device *hdev,
1245 		const struct hid_device_id *id)
1246 {
1247 	int ret;
1248 
1249 	ret = hid_parse(hdev);
1250 	if (ret) {
1251 		hid_err(hdev, "hid_parse failed\n");
1252 		goto err;
1253 	}
1254 
1255 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1256 	if (ret) {
1257 		hid_err(hdev, "hid_hw_start failed\n");
1258 		goto err;
1259 	}
1260 
1261 	switch (hdev->product) {
1262 	case USB_DEVICE_ID_LENOVO_TPKBD:
1263 		ret = lenovo_probe_tpkbd(hdev);
1264 		break;
1265 	case USB_DEVICE_ID_LENOVO_CUSBKBD:
1266 	case USB_DEVICE_ID_LENOVO_CBTKBD:
1267 	case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1268 	case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1269 		ret = lenovo_probe_cptkbd(hdev);
1270 		break;
1271 	case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1272 	case USB_DEVICE_ID_LENOVO_X1_TAB:
1273 		ret = lenovo_probe_tp10ubkbd(hdev);
1274 		break;
1275 	default:
1276 		ret = 0;
1277 		break;
1278 	}
1279 	if (ret)
1280 		goto err_hid;
1281 
1282 	return 0;
1283 err_hid:
1284 	hid_hw_stop(hdev);
1285 err:
1286 	return ret;
1287 }
1288 
1289 static void lenovo_remove_tpkbd(struct hid_device *hdev)
1290 {
1291 	struct lenovo_drvdata *data_pointer = hid_get_drvdata(hdev);
1292 
1293 	/*
1294 	 * Only the trackpoint half of the keyboard has drvdata and stuff that
1295 	 * needs unregistering.
1296 	 */
1297 	if (data_pointer == NULL)
1298 		return;
1299 
1300 	sysfs_remove_group(&hdev->dev.kobj,
1301 			&lenovo_attr_group_tpkbd);
1302 
1303 	led_classdev_unregister(&data_pointer->led_micmute);
1304 	led_classdev_unregister(&data_pointer->led_mute);
1305 }
1306 
1307 static void lenovo_remove_cptkbd(struct hid_device *hdev)
1308 {
1309 	sysfs_remove_group(&hdev->dev.kobj,
1310 			&lenovo_attr_group_cptkbd);
1311 }
1312 
1313 static void lenovo_remove_tp10ubkbd(struct hid_device *hdev)
1314 {
1315 	struct lenovo_drvdata *data = hid_get_drvdata(hdev);
1316 
1317 	if (data == NULL)
1318 		return;
1319 
1320 	led_classdev_unregister(&data->led_micmute);
1321 	led_classdev_unregister(&data->led_mute);
1322 
1323 	sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tp10ubkbd);
1324 	cancel_work_sync(&data->fn_lock_sync_work);
1325 }
1326 
1327 static void lenovo_remove(struct hid_device *hdev)
1328 {
1329 	switch (hdev->product) {
1330 	case USB_DEVICE_ID_LENOVO_TPKBD:
1331 		lenovo_remove_tpkbd(hdev);
1332 		break;
1333 	case USB_DEVICE_ID_LENOVO_CUSBKBD:
1334 	case USB_DEVICE_ID_LENOVO_CBTKBD:
1335 	case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1336 	case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1337 		lenovo_remove_cptkbd(hdev);
1338 		break;
1339 	case USB_DEVICE_ID_LENOVO_TP10UBKBD:
1340 	case USB_DEVICE_ID_LENOVO_X1_TAB:
1341 		lenovo_remove_tp10ubkbd(hdev);
1342 		break;
1343 	}
1344 
1345 	hid_hw_stop(hdev);
1346 }
1347 
1348 static int lenovo_input_configured(struct hid_device *hdev,
1349 		struct hid_input *hi)
1350 {
1351 	switch (hdev->product) {
1352 		case USB_DEVICE_ID_LENOVO_TPKBD:
1353 		case USB_DEVICE_ID_LENOVO_CUSBKBD:
1354 		case USB_DEVICE_ID_LENOVO_CBTKBD:
1355 		case USB_DEVICE_ID_LENOVO_TPIIUSBKBD:
1356 		case USB_DEVICE_ID_LENOVO_TPIIBTKBD:
1357 			if (test_bit(EV_REL, hi->input->evbit)) {
1358 				/* set only for trackpoint device */
1359 				__set_bit(INPUT_PROP_POINTER, hi->input->propbit);
1360 				__set_bit(INPUT_PROP_POINTING_STICK,
1361 						hi->input->propbit);
1362 			}
1363 			break;
1364 	}
1365 
1366 	return 0;
1367 }
1368 
1369 
1370 static const struct hid_device_id lenovo_devices[] = {
1371 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },
1372 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CUSBKBD) },
1373 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPIIUSBKBD) },
1374 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CBTKBD) },
1375 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPIIBTKBD) },
1376 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPPRODOCK) },
1377 	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_III) },
1378 	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_PRO) },
1379 	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL) },
1380 	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL) },
1381 	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO) },
1382 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL) },
1383 	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TP10UBKBD) },
1384 	/*
1385 	 * Note bind to the HID_GROUP_GENERIC group, so that we only bind to the keyboard
1386 	 * part, while letting hid-multitouch.c handle the touchpad and trackpoint.
1387 	 */
1388 	{ HID_DEVICE(BUS_USB, HID_GROUP_GENERIC,
1389 		     USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_X1_TAB) },
1390 	{ }
1391 };
1392 
1393 MODULE_DEVICE_TABLE(hid, lenovo_devices);
1394 
1395 static struct hid_driver lenovo_driver = {
1396 	.name = "lenovo",
1397 	.id_table = lenovo_devices,
1398 	.input_configured = lenovo_input_configured,
1399 	.input_mapping = lenovo_input_mapping,
1400 	.probe = lenovo_probe,
1401 	.remove = lenovo_remove,
1402 	.raw_event = lenovo_raw_event,
1403 	.event = lenovo_event,
1404 	.report_fixup = lenovo_report_fixup,
1405 };
1406 module_hid_driver(lenovo_driver);
1407 
1408 MODULE_LICENSE("GPL");
1409