]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/hid/hid-logitech-hidpp.c
projects / mirror_ubuntu-artful-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
HID: logitech-hidpp: create the battery for all types of HID++ devices
[mirror_ubuntu-artful-kernel.git] / drivers / hid / hid-logitech-hidpp.c
1 /*
2 * HIDPP protocol for Logitech Unifying receivers
3 *
4 * Copyright (c) 2011 Logitech (c)
5 * Copyright (c) 2012-2013 Google (c)
6 * Copyright (c) 2013-2014 Red Hat Inc.
7 */
8
9 /*
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; version 2 of the License.
13 */
14
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16
17 #include <linux/device.h>
18 #include <linux/input.h>
19 #include <linux/usb.h>
20 #include <linux/hid.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/kfifo.h>
25 #include <linux/input/mt.h>
26 #include <linux/workqueue.h>
27 #include <linux/atomic.h>
28 #include <linux/fixp-arith.h>
29 #include <asm/unaligned.h>
30 #include "usbhid/usbhid.h"
31 #include "hid-ids.h"
32
33 MODULE_LICENSE("GPL");
34 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
35 MODULE_AUTHOR("Nestor Lopez Casado <nlopezcasad@logitech.com>");
36
37 static bool disable_raw_mode;
38 module_param(disable_raw_mode, bool, 0644);
39 MODULE_PARM_DESC(disable_raw_mode,
40 "Disable Raw mode reporting for touchpads and keep firmware gestures.");
41
42 static bool disable_tap_to_click;
43 module_param(disable_tap_to_click, bool, 0644);
44 MODULE_PARM_DESC(disable_tap_to_click,
45 "Disable Tap-To-Click mode reporting for touchpads (only on the K400 currently).");
46
47 #define REPORT_ID_HIDPP_SHORT 0x10
48 #define REPORT_ID_HIDPP_LONG 0x11
49 #define REPORT_ID_HIDPP_VERY_LONG 0x12
50
51 #define HIDPP_REPORT_SHORT_LENGTH 7
52 #define HIDPP_REPORT_LONG_LENGTH 20
53 #define HIDPP_REPORT_VERY_LONG_LENGTH 64
54
55 #define HIDPP_QUIRK_CLASS_WTP BIT(0)
56 #define HIDPP_QUIRK_CLASS_M560 BIT(1)
57 #define HIDPP_QUIRK_CLASS_K400 BIT(2)
58 #define HIDPP_QUIRK_CLASS_G920 BIT(3)
59
60 /* bits 2..20 are reserved for classes */
61 /* #define HIDPP_QUIRK_CONNECT_EVENTS BIT(21) disabled */
62 #define HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS BIT(22)
63 #define HIDPP_QUIRK_NO_HIDINPUT BIT(23)
64 #define HIDPP_QUIRK_FORCE_OUTPUT_REPORTS BIT(24)
65 #define HIDPP_QUIRK_UNIFYING BIT(25)
66
67 #define HIDPP_QUIRK_DELAYED_INIT HIDPP_QUIRK_NO_HIDINPUT
68
69 #define HIDPP_CAPABILITY_HIDPP10_BATTERY BIT(0)
70 #define HIDPP_CAPABILITY_HIDPP20_BATTERY BIT(1)
71
72 /*
73 * There are two hidpp protocols in use, the first version hidpp10 is known
74 * as register access protocol or RAP, the second version hidpp20 is known as
75 * feature access protocol or FAP
76 *
77 * Most older devices (including the Unifying usb receiver) use the RAP protocol
78 * where as most newer devices use the FAP protocol. Both protocols are
79 * compatible with the underlying transport, which could be usb, Unifiying, or
80 * bluetooth. The message lengths are defined by the hid vendor specific report
81 * descriptor for the HIDPP_SHORT report type (total message lenth 7 bytes) and
82 * the HIDPP_LONG report type (total message length 20 bytes)
83 *
84 * The RAP protocol uses both report types, whereas the FAP only uses HIDPP_LONG
85 * messages. The Unifying receiver itself responds to RAP messages (device index
86 * is 0xFF for the receiver), and all messages (short or long) with a device
87 * index between 1 and 6 are passed untouched to the corresponding paired
88 * Unifying device.
89 *
90 * The paired device can be RAP or FAP, it will receive the message untouched
91 * from the Unifiying receiver.
92 */
93
94 struct fap {
95 u8 feature_index;
96 u8 funcindex_clientid;
97 u8 params[HIDPP_REPORT_VERY_LONG_LENGTH - 4U];
98 };
99
100 struct rap {
101 u8 sub_id;
102 u8 reg_address;
103 u8 params[HIDPP_REPORT_VERY_LONG_LENGTH - 4U];
104 };
105
106 struct hidpp_report {
107 u8 report_id;
108 u8 device_index;
109 union {
110 struct fap fap;
111 struct rap rap;
112 u8 rawbytes[sizeof(struct fap)];
113 };
114 } __packed;
115
116 struct hidpp_battery {
117 u8 feature_index;
118 struct power_supply_desc desc;
119 struct power_supply *ps;
120 char name[64];
121 int status;
122 int level;
123 };
124
125 struct hidpp_device {
126 struct hid_device *hid_dev;
127 struct mutex send_mutex;
128 void *send_receive_buf;
129 char *name; /* will never be NULL and should not be freed */
130 wait_queue_head_t wait;
131 bool answer_available;
132 u8 protocol_major;
133 u8 protocol_minor;
134
135 void *private_data;
136
137 struct work_struct work;
138 struct kfifo delayed_work_fifo;
139 atomic_t connected;
140 struct input_dev *delayed_input;
141
142 unsigned long quirks;
143 unsigned long capabilities;
144
145 struct hidpp_battery battery;
146 };
147
148 /* HID++ 1.0 error codes */
149 #define HIDPP_ERROR 0x8f
150 #define HIDPP_ERROR_SUCCESS 0x00
151 #define HIDPP_ERROR_INVALID_SUBID 0x01
152 #define HIDPP_ERROR_INVALID_ADRESS 0x02
153 #define HIDPP_ERROR_INVALID_VALUE 0x03
154 #define HIDPP_ERROR_CONNECT_FAIL 0x04
155 #define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
156 #define HIDPP_ERROR_ALREADY_EXISTS 0x06
157 #define HIDPP_ERROR_BUSY 0x07
158 #define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
159 #define HIDPP_ERROR_RESOURCE_ERROR 0x09
160 #define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
161 #define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
162 #define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
163 /* HID++ 2.0 error codes */
164 #define HIDPP20_ERROR 0xff
165
166 static void hidpp_connect_event(struct hidpp_device *hidpp_dev);
167
168 static int __hidpp_send_report(struct hid_device *hdev,
169 struct hidpp_report *hidpp_report)
170 {
171 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
172 int fields_count, ret;
173
174 hidpp = hid_get_drvdata(hdev);
175
176 switch (hidpp_report->report_id) {
177 case REPORT_ID_HIDPP_SHORT:
178 fields_count = HIDPP_REPORT_SHORT_LENGTH;
179 break;
180 case REPORT_ID_HIDPP_LONG:
181 fields_count = HIDPP_REPORT_LONG_LENGTH;
182 break;
183 case REPORT_ID_HIDPP_VERY_LONG:
184 fields_count = HIDPP_REPORT_VERY_LONG_LENGTH;
185 break;
186 default:
187 return -ENODEV;
188 }
189
190 /*
191 * set the device_index as the receiver, it will be overwritten by
192 * hid_hw_request if needed
193 */
194 hidpp_report->device_index = 0xff;
195
196 if (hidpp->quirks & HIDPP_QUIRK_FORCE_OUTPUT_REPORTS) {
197 ret = hid_hw_output_report(hdev, (u8 *)hidpp_report, fields_count);
198 } else {
199 ret = hid_hw_raw_request(hdev, hidpp_report->report_id,
200 (u8 *)hidpp_report, fields_count, HID_OUTPUT_REPORT,
201 HID_REQ_SET_REPORT);
202 }
203
204 return ret == fields_count ? 0 : -1;
205 }
206
207 /**
208 * hidpp_send_message_sync() returns 0 in case of success, and something else
209 * in case of a failure.
210 * - If ' something else' is positive, that means that an error has been raised
211 * by the protocol itself.
212 * - If ' something else' is negative, that means that we had a classic error
213 * (-ENOMEM, -EPIPE, etc...)
214 */
215 static int hidpp_send_message_sync(struct hidpp_device *hidpp,
216 struct hidpp_report *message,
217 struct hidpp_report *response)
218 {
219 int ret;
220
221 mutex_lock(&hidpp->send_mutex);
222
223 hidpp->send_receive_buf = response;
224 hidpp->answer_available = false;
225
226 /*
227 * So that we can later validate the answer when it arrives
228 * in hidpp_raw_event
229 */
230 *response = *message;
231
232 ret = __hidpp_send_report(hidpp->hid_dev, message);
233
234 if (ret) {
235 dbg_hid("__hidpp_send_report returned err: %d\n", ret);
236 memset(response, 0, sizeof(struct hidpp_report));
237 goto exit;
238 }
239
240 if (!wait_event_timeout(hidpp->wait, hidpp->answer_available,
241 5*HZ)) {
242 dbg_hid("%s:timeout waiting for response\n", __func__);
243 memset(response, 0, sizeof(struct hidpp_report));
244 ret = -ETIMEDOUT;
245 }
246
247 if (response->report_id == REPORT_ID_HIDPP_SHORT &&
248 response->rap.sub_id == HIDPP_ERROR) {
249 ret = response->rap.params[1];
250 dbg_hid("%s:got hidpp error %02X\n", __func__, ret);
251 goto exit;
252 }
253
254 if ((response->report_id == REPORT_ID_HIDPP_LONG ||
255 response->report_id == REPORT_ID_HIDPP_VERY_LONG) &&
256 response->fap.feature_index == HIDPP20_ERROR) {
257 ret = response->fap.params[1];
258 dbg_hid("%s:got hidpp 2.0 error %02X\n", __func__, ret);
259 goto exit;
260 }
261
262 exit:
263 mutex_unlock(&hidpp->send_mutex);
264 return ret;
265
266 }
267
268 static int hidpp_send_fap_command_sync(struct hidpp_device *hidpp,
269 u8 feat_index, u8 funcindex_clientid, u8 *params, int param_count,
270 struct hidpp_report *response)
271 {
272 struct hidpp_report *message;
273 int ret;
274
275 if (param_count > sizeof(message->fap.params))
276 return -EINVAL;
277
278 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
279 if (!message)
280 return -ENOMEM;
281
282 if (param_count > (HIDPP_REPORT_LONG_LENGTH - 4))
283 message->report_id = REPORT_ID_HIDPP_VERY_LONG;
284 else
285 message->report_id = REPORT_ID_HIDPP_LONG;
286 message->fap.feature_index = feat_index;
287 message->fap.funcindex_clientid = funcindex_clientid;
288 memcpy(&message->fap.params, params, param_count);
289
290 ret = hidpp_send_message_sync(hidpp, message, response);
291 kfree(message);
292 return ret;
293 }
294
295 static int hidpp_send_rap_command_sync(struct hidpp_device *hidpp_dev,
296 u8 report_id, u8 sub_id, u8 reg_address, u8 *params, int param_count,
297 struct hidpp_report *response)
298 {
299 struct hidpp_report *message;
300 int ret, max_count;
301
302 switch (report_id) {
303 case REPORT_ID_HIDPP_SHORT:
304 max_count = HIDPP_REPORT_SHORT_LENGTH - 4;
305 break;
306 case REPORT_ID_HIDPP_LONG:
307 max_count = HIDPP_REPORT_LONG_LENGTH - 4;
308 break;
309 case REPORT_ID_HIDPP_VERY_LONG:
310 max_count = HIDPP_REPORT_VERY_LONG_LENGTH - 4;
311 break;
312 default:
313 return -EINVAL;
314 }
315
316 if (param_count > max_count)
317 return -EINVAL;
318
319 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
320 if (!message)
321 return -ENOMEM;
322 message->report_id = report_id;
323 message->rap.sub_id = sub_id;
324 message->rap.reg_address = reg_address;
325 memcpy(&message->rap.params, params, param_count);
326
327 ret = hidpp_send_message_sync(hidpp_dev, message, response);
328 kfree(message);
329 return ret;
330 }
331
332 static void delayed_work_cb(struct work_struct *work)
333 {
334 struct hidpp_device *hidpp = container_of(work, struct hidpp_device,
335 work);
336 hidpp_connect_event(hidpp);
337 }
338
339 static inline bool hidpp_match_answer(struct hidpp_report *question,
340 struct hidpp_report *answer)
341 {
342 return (answer->fap.feature_index == question->fap.feature_index) &&
343 (answer->fap.funcindex_clientid == question->fap.funcindex_clientid);
344 }
345
346 static inline bool hidpp_match_error(struct hidpp_report *question,
347 struct hidpp_report *answer)
348 {
349 return ((answer->rap.sub_id == HIDPP_ERROR) ||
350 (answer->fap.feature_index == HIDPP20_ERROR)) &&
351 (answer->fap.funcindex_clientid == question->fap.feature_index) &&
352 (answer->fap.params[0] == question->fap.funcindex_clientid);
353 }
354
355 static inline bool hidpp_report_is_connect_event(struct hidpp_report *report)
356 {
357 return (report->report_id == REPORT_ID_HIDPP_SHORT) &&
358 (report->rap.sub_id == 0x41);
359 }
360
361 /**
362 * hidpp_prefix_name() prefixes the current given name with "Logitech ".
363 */
364 static void hidpp_prefix_name(char **name, int name_length)
365 {
366 #define PREFIX_LENGTH 9 /* "Logitech " */
367
368 int new_length;
369 char *new_name;
370
371 if (name_length > PREFIX_LENGTH &&
372 strncmp(*name, "Logitech ", PREFIX_LENGTH) == 0)
373 /* The prefix has is already in the name */
374 return;
375
376 new_length = PREFIX_LENGTH + name_length;
377 new_name = kzalloc(new_length, GFP_KERNEL);
378 if (!new_name)
379 return;
380
381 snprintf(new_name, new_length, "Logitech %s", *name);
382
383 kfree(*name);
384
385 *name = new_name;
386 }
387
388 /* -------------------------------------------------------------------------- */
389 /* HIDP++ 1.0 commands */
390 /* -------------------------------------------------------------------------- */
391
392 #define HIDPP_SET_REGISTER 0x80
393 #define HIDPP_GET_REGISTER 0x81
394 #define HIDPP_SET_LONG_REGISTER 0x82
395 #define HIDPP_GET_LONG_REGISTER 0x83
396
397 #define HIDPP_REG_PAIRING_INFORMATION 0xB5
398 #define HIDPP_EXTENDED_PAIRING 0x30
399 #define HIDPP_DEVICE_NAME 0x40
400
401 static char *hidpp_unifying_get_name(struct hidpp_device *hidpp_dev)
402 {
403 struct hidpp_report response;
404 int ret;
405 u8 params[1] = { HIDPP_DEVICE_NAME };
406 char *name;
407 int len;
408
409 ret = hidpp_send_rap_command_sync(hidpp_dev,
410 REPORT_ID_HIDPP_SHORT,
411 HIDPP_GET_LONG_REGISTER,
412 HIDPP_REG_PAIRING_INFORMATION,
413 params, 1, &response);
414 if (ret)
415 return NULL;
416
417 len = response.rap.params[1];
418
419 if (2 + len > sizeof(response.rap.params))
420 return NULL;
421
422 name = kzalloc(len + 1, GFP_KERNEL);
423 if (!name)
424 return NULL;
425
426 memcpy(name, &response.rap.params[2], len);
427
428 /* include the terminating '\0' */
429 hidpp_prefix_name(&name, len + 1);
430
431 return name;
432 }
433
434 static int hidpp_unifying_get_serial(struct hidpp_device *hidpp, u32 *serial)
435 {
436 struct hidpp_report response;
437 int ret;
438 u8 params[1] = { HIDPP_EXTENDED_PAIRING };
439
440 ret = hidpp_send_rap_command_sync(hidpp,
441 REPORT_ID_HIDPP_SHORT,
442 HIDPP_GET_LONG_REGISTER,
443 HIDPP_REG_PAIRING_INFORMATION,
444 params, 1, &response);
445 if (ret)
446 return ret;
447
448 /*
449 * We don't care about LE or BE, we will output it as a string
450 * with %4phD, so we need to keep the order.
451 */
452 *serial = *((u32 *)&response.rap.params[1]);
453 return 0;
454 }
455
456 static int hidpp_unifying_init(struct hidpp_device *hidpp)
457 {
458 struct hid_device *hdev = hidpp->hid_dev;
459 const char *name;
460 u32 serial;
461 int ret;
462
463 ret = hidpp_unifying_get_serial(hidpp, &serial);
464 if (ret)
465 return ret;
466
467 snprintf(hdev->uniq, sizeof(hdev->uniq), "%04x-%4phD",
468 hdev->product, &serial);
469 dbg_hid("HID++ Unifying: Got serial: %s\n", hdev->uniq);
470
471 name = hidpp_unifying_get_name(hidpp);
472 if (!name)
473 return -EIO;
474
475 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
476 dbg_hid("HID++ Unifying: Got name: %s\n", name);
477
478 kfree(name);
479 return 0;
480 }
481
482 /* -------------------------------------------------------------------------- */
483 /* 0x0000: Root */
484 /* -------------------------------------------------------------------------- */
485
486 #define HIDPP_PAGE_ROOT 0x0000
487 #define HIDPP_PAGE_ROOT_IDX 0x00
488
489 #define CMD_ROOT_GET_FEATURE 0x01
490 #define CMD_ROOT_GET_PROTOCOL_VERSION 0x11
491
492 static int hidpp_root_get_feature(struct hidpp_device *hidpp, u16 feature,
493 u8 *feature_index, u8 *feature_type)
494 {
495 struct hidpp_report response;
496 int ret;
497 u8 params[2] = { feature >> 8, feature & 0x00FF };
498
499 ret = hidpp_send_fap_command_sync(hidpp,
500 HIDPP_PAGE_ROOT_IDX,
501 CMD_ROOT_GET_FEATURE,
502 params, 2, &response);
503 if (ret)
504 return ret;
505
506 *feature_index = response.fap.params[0];
507 *feature_type = response.fap.params[1];
508
509 return ret;
510 }
511
512 static int hidpp_root_get_protocol_version(struct hidpp_device *hidpp)
513 {
514 struct hidpp_report response;
515 int ret;
516
517 ret = hidpp_send_fap_command_sync(hidpp,
518 HIDPP_PAGE_ROOT_IDX,
519 CMD_ROOT_GET_PROTOCOL_VERSION,
520 NULL, 0, &response);
521
522 if (ret == HIDPP_ERROR_INVALID_SUBID) {
523 hidpp->protocol_major = 1;
524 hidpp->protocol_minor = 0;
525 return 0;
526 }
527
528 /* the device might not be connected */
529 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
530 return -EIO;
531
532 if (ret > 0) {
533 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
534 __func__, ret);
535 return -EPROTO;
536 }
537 if (ret)
538 return ret;
539
540 hidpp->protocol_major = response.fap.params[0];
541 hidpp->protocol_minor = response.fap.params[1];
542
543 return ret;
544 }
545
546 static bool hidpp_is_connected(struct hidpp_device *hidpp)
547 {
548 int ret;
549
550 ret = hidpp_root_get_protocol_version(hidpp);
551 if (!ret)
552 hid_dbg(hidpp->hid_dev, "HID++ %u.%u device connected.\n",
553 hidpp->protocol_major, hidpp->protocol_minor);
554 return ret == 0;
555 }
556
557 /* -------------------------------------------------------------------------- */
558 /* 0x0005: GetDeviceNameType */
559 /* -------------------------------------------------------------------------- */
560
561 #define HIDPP_PAGE_GET_DEVICE_NAME_TYPE 0x0005
562
563 #define CMD_GET_DEVICE_NAME_TYPE_GET_COUNT 0x01
564 #define CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME 0x11
565 #define CMD_GET_DEVICE_NAME_TYPE_GET_TYPE 0x21
566
567 static int hidpp_devicenametype_get_count(struct hidpp_device *hidpp,
568 u8 feature_index, u8 *nameLength)
569 {
570 struct hidpp_report response;
571 int ret;
572
573 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
574 CMD_GET_DEVICE_NAME_TYPE_GET_COUNT, NULL, 0, &response);
575
576 if (ret > 0) {
577 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
578 __func__, ret);
579 return -EPROTO;
580 }
581 if (ret)
582 return ret;
583
584 *nameLength = response.fap.params[0];
585
586 return ret;
587 }
588
589 static int hidpp_devicenametype_get_device_name(struct hidpp_device *hidpp,
590 u8 feature_index, u8 char_index, char *device_name, int len_buf)
591 {
592 struct hidpp_report response;
593 int ret, i;
594 int count;
595
596 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
597 CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME, &char_index, 1,
598 &response);
599
600 if (ret > 0) {
601 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
602 __func__, ret);
603 return -EPROTO;
604 }
605 if (ret)
606 return ret;
607
608 switch (response.report_id) {
609 case REPORT_ID_HIDPP_VERY_LONG:
610 count = HIDPP_REPORT_VERY_LONG_LENGTH - 4;
611 break;
612 case REPORT_ID_HIDPP_LONG:
613 count = HIDPP_REPORT_LONG_LENGTH - 4;
614 break;
615 case REPORT_ID_HIDPP_SHORT:
616 count = HIDPP_REPORT_SHORT_LENGTH - 4;
617 break;
618 default:
619 return -EPROTO;
620 }
621
622 if (len_buf < count)
623 count = len_buf;
624
625 for (i = 0; i < count; i++)
626 device_name[i] = response.fap.params[i];
627
628 return count;
629 }
630
631 static char *hidpp_get_device_name(struct hidpp_device *hidpp)
632 {
633 u8 feature_type;
634 u8 feature_index;
635 u8 __name_length;
636 char *name;
637 unsigned index = 0;
638 int ret;
639
640 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_GET_DEVICE_NAME_TYPE,
641 &feature_index, &feature_type);
642 if (ret)
643 return NULL;
644
645 ret = hidpp_devicenametype_get_count(hidpp, feature_index,
646 &__name_length);
647 if (ret)
648 return NULL;
649
650 name = kzalloc(__name_length + 1, GFP_KERNEL);
651 if (!name)
652 return NULL;
653
654 while (index < __name_length) {
655 ret = hidpp_devicenametype_get_device_name(hidpp,
656 feature_index, index, name + index,
657 __name_length - index);
658 if (ret <= 0) {
659 kfree(name);
660 return NULL;
661 }
662 index += ret;
663 }
664
665 /* include the terminating '\0' */
666 hidpp_prefix_name(&name, __name_length + 1);
667
668 return name;
669 }
670
671 /* -------------------------------------------------------------------------- */
672 /* 0x1000: Battery level status */
673 /* -------------------------------------------------------------------------- */
674
675 #define HIDPP_PAGE_BATTERY_LEVEL_STATUS 0x1000
676
677 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS 0x00
678 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY 0x10
679
680 #define EVENT_BATTERY_LEVEL_STATUS_BROADCAST 0x00
681
682 static int hidpp20_batterylevel_map_status_level(u8 data[3], int *level,
683 int *next_level)
684 {
685 int status;
686 int level_override;
687
688 *level = data[0];
689 *next_level = data[1];
690
691 /* When discharging, we can rely on the device reported level.
692 * For all other states the device reports level 0 (unknown). Make up
693 * a number instead
694 */
695 switch (data[2]) {
696 case 0: /* discharging (in use) */
697 status = POWER_SUPPLY_STATUS_DISCHARGING;
698 level_override = 0;
699 break;
700 case 1: /* recharging */
701 status = POWER_SUPPLY_STATUS_CHARGING;
702 level_override = 80;
703 break;
704 case 2: /* charge in final stage */
705 status = POWER_SUPPLY_STATUS_CHARGING;
706 level_override = 90;
707 break;
708 case 3: /* charge complete */
709 status = POWER_SUPPLY_STATUS_FULL;
710 level_override = 100;
711 break;
712 case 4: /* recharging below optimal speed */
713 status = POWER_SUPPLY_STATUS_CHARGING;
714 level_override = 50;
715 break;
716 /* 5 = invalid battery type
717 6 = thermal error
718 7 = other charging error */
719 default:
720 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
721 level_override = 0;
722 break;
723 }
724
725 if (level_override != 0 && *level == 0)
726 *level = level_override;
727
728 return status;
729 }
730
731 static int hidpp20_batterylevel_get_battery_level(struct hidpp_device *hidpp,
732 u8 feature_index,
733 int *status,
734 int *level,
735 int *next_level)
736 {
737 struct hidpp_report response;
738 int ret;
739 u8 *params = (u8 *)response.fap.params;
740
741 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
742 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS,
743 NULL, 0, &response);
744 if (ret > 0) {
745 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
746 __func__, ret);
747 return -EPROTO;
748 }
749 if (ret)
750 return ret;
751
752 *status = hidpp20_batterylevel_map_status_level(params, level,
753 next_level);
754
755 return 0;
756 }
757
758 static int hidpp20_query_battery_info(struct hidpp_device *hidpp)
759 {
760 u8 feature_type;
761 int ret;
762 int status, level, next_level;
763
764 if (hidpp->battery.feature_index == 0) {
765 ret = hidpp_root_get_feature(hidpp,
766 HIDPP_PAGE_BATTERY_LEVEL_STATUS,
767 &hidpp->battery.feature_index,
768 &feature_type);
769 if (ret)
770 return ret;
771 }
772
773 ret = hidpp20_batterylevel_get_battery_level(hidpp,
774 hidpp->battery.feature_index,
775 &status, &level, &next_level);
776 if (ret)
777 return ret;
778
779 hidpp->battery.status = status;
780 hidpp->battery.level = level;
781
782 return 0;
783 }
784
785 static int hidpp20_battery_event(struct hidpp_device *hidpp,
786 u8 *data, int size)
787 {
788 struct hidpp_report *report = (struct hidpp_report *)data;
789 int status, level, next_level;
790 bool changed;
791
792 if (report->fap.feature_index != hidpp->battery.feature_index ||
793 report->fap.funcindex_clientid != EVENT_BATTERY_LEVEL_STATUS_BROADCAST)
794 return 0;
795
796 status = hidpp20_batterylevel_map_status_level(report->fap.params,
797 &level, &next_level);
798
799 changed = level != hidpp->battery.level ||
800 status != hidpp->battery.status;
801
802 if (changed) {
803 hidpp->battery.level = level;
804 hidpp->battery.status = status;
805 if (hidpp->battery.ps)
806 power_supply_changed(hidpp->battery.ps);
807 }
808
809 return 0;
810 }
811
812 static enum power_supply_property hidpp_battery_props[] = {
813 POWER_SUPPLY_PROP_STATUS,
814 POWER_SUPPLY_PROP_CAPACITY,
815 POWER_SUPPLY_PROP_SCOPE,
816 POWER_SUPPLY_PROP_MODEL_NAME,
817 POWER_SUPPLY_PROP_MANUFACTURER,
818 POWER_SUPPLY_PROP_SERIAL_NUMBER,
819 };
820
821 static int hidpp_battery_get_property(struct power_supply *psy,
822 enum power_supply_property psp,
823 union power_supply_propval *val)
824 {
825 struct hidpp_device *hidpp = power_supply_get_drvdata(psy);
826 int ret = 0;
827
828 switch(psp) {
829 case POWER_SUPPLY_PROP_STATUS:
830 val->intval = hidpp->battery.status;
831 break;
832 case POWER_SUPPLY_PROP_CAPACITY:
833 val->intval = hidpp->battery.level;
834 break;
835 case POWER_SUPPLY_PROP_SCOPE:
836 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
837 break;
838 case POWER_SUPPLY_PROP_MODEL_NAME:
839 if (!strncmp(hidpp->name, "Logitech ", 9))
840 val->strval = hidpp->name + 9;
841 else
842 val->strval = hidpp->name;
843 break;
844 case POWER_SUPPLY_PROP_MANUFACTURER:
845 val->strval = "Logitech";
846 break;
847 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
848 val->strval = hidpp->hid_dev->uniq;
849 break;
850 default:
851 ret = -EINVAL;
852 break;
853 }
854
855 return ret;
856 }
857
858 /* -------------------------------------------------------------------------- */
859 /* 0x6010: Touchpad FW items */
860 /* -------------------------------------------------------------------------- */
861
862 #define HIDPP_PAGE_TOUCHPAD_FW_ITEMS 0x6010
863
864 #define CMD_TOUCHPAD_FW_ITEMS_SET 0x10
865
866 struct hidpp_touchpad_fw_items {
867 uint8_t presence;
868 uint8_t desired_state;
869 uint8_t state;
870 uint8_t persistent;
871 };
872
873 /**
874 * send a set state command to the device by reading the current items->state
875 * field. items is then filled with the current state.
876 */
877 static int hidpp_touchpad_fw_items_set(struct hidpp_device *hidpp,
878 u8 feature_index,
879 struct hidpp_touchpad_fw_items *items)
880 {
881 struct hidpp_report response;
882 int ret;
883 u8 *params = (u8 *)response.fap.params;
884
885 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
886 CMD_TOUCHPAD_FW_ITEMS_SET, &items->state, 1, &response);
887
888 if (ret > 0) {
889 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
890 __func__, ret);
891 return -EPROTO;
892 }
893 if (ret)
894 return ret;
895
896 items->presence = params[0];
897 items->desired_state = params[1];
898 items->state = params[2];
899 items->persistent = params[3];
900
901 return 0;
902 }
903
904 /* -------------------------------------------------------------------------- */
905 /* 0x6100: TouchPadRawXY */
906 /* -------------------------------------------------------------------------- */
907
908 #define HIDPP_PAGE_TOUCHPAD_RAW_XY 0x6100
909
910 #define CMD_TOUCHPAD_GET_RAW_INFO 0x01
911 #define CMD_TOUCHPAD_SET_RAW_REPORT_STATE 0x21
912
913 #define EVENT_TOUCHPAD_RAW_XY 0x00
914
915 #define TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT 0x01
916 #define TOUCHPAD_RAW_XY_ORIGIN_UPPER_LEFT 0x03
917
918 struct hidpp_touchpad_raw_info {
919 u16 x_size;
920 u16 y_size;
921 u8 z_range;
922 u8 area_range;
923 u8 timestamp_unit;
924 u8 maxcontacts;
925 u8 origin;
926 u16 res;
927 };
928
929 struct hidpp_touchpad_raw_xy_finger {
930 u8 contact_type;
931 u8 contact_status;
932 u16 x;
933 u16 y;
934 u8 z;
935 u8 area;
936 u8 finger_id;
937 };
938
939 struct hidpp_touchpad_raw_xy {
940 u16 timestamp;
941 struct hidpp_touchpad_raw_xy_finger fingers[2];
942 u8 spurious_flag;
943 u8 end_of_frame;
944 u8 finger_count;
945 u8 button;
946 };
947
948 static int hidpp_touchpad_get_raw_info(struct hidpp_device *hidpp,
949 u8 feature_index, struct hidpp_touchpad_raw_info *raw_info)
950 {
951 struct hidpp_report response;
952 int ret;
953 u8 *params = (u8 *)response.fap.params;
954
955 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
956 CMD_TOUCHPAD_GET_RAW_INFO, NULL, 0, &response);
957
958 if (ret > 0) {
959 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
960 __func__, ret);
961 return -EPROTO;
962 }
963 if (ret)
964 return ret;
965
966 raw_info->x_size = get_unaligned_be16(&params[0]);
967 raw_info->y_size = get_unaligned_be16(&params[2]);
968 raw_info->z_range = params[4];
969 raw_info->area_range = params[5];
970 raw_info->maxcontacts = params[7];
971 raw_info->origin = params[8];
972 /* res is given in unit per inch */
973 raw_info->res = get_unaligned_be16(&params[13]) * 2 / 51;
974
975 return ret;
976 }
977
978 static int hidpp_touchpad_set_raw_report_state(struct hidpp_device *hidpp_dev,
979 u8 feature_index, bool send_raw_reports,
980 bool sensor_enhanced_settings)
981 {
982 struct hidpp_report response;
983
984 /*
985 * Params:
986 * bit 0 - enable raw
987 * bit 1 - 16bit Z, no area
988 * bit 2 - enhanced sensitivity
989 * bit 3 - width, height (4 bits each) instead of area
990 * bit 4 - send raw + gestures (degrades smoothness)
991 * remaining bits - reserved
992 */
993 u8 params = send_raw_reports | (sensor_enhanced_settings << 2);
994
995 return hidpp_send_fap_command_sync(hidpp_dev, feature_index,
996 CMD_TOUCHPAD_SET_RAW_REPORT_STATE, &params, 1, &response);
997 }
998
999 static void hidpp_touchpad_touch_event(u8 *data,
1000 struct hidpp_touchpad_raw_xy_finger *finger)
1001 {
1002 u8 x_m = data[0] << 2;
1003 u8 y_m = data[2] << 2;
1004
1005 finger->x = x_m << 6 | data[1];
1006 finger->y = y_m << 6 | data[3];
1007
1008 finger->contact_type = data[0] >> 6;
1009 finger->contact_status = data[2] >> 6;
1010
1011 finger->z = data[4];
1012 finger->area = data[5];
1013 finger->finger_id = data[6] >> 4;
1014 }
1015
1016 static void hidpp_touchpad_raw_xy_event(struct hidpp_device *hidpp_dev,
1017 u8 *data, struct hidpp_touchpad_raw_xy *raw_xy)
1018 {
1019 memset(raw_xy, 0, sizeof(struct hidpp_touchpad_raw_xy));
1020 raw_xy->end_of_frame = data[8] & 0x01;
1021 raw_xy->spurious_flag = (data[8] >> 1) & 0x01;
1022 raw_xy->finger_count = data[15] & 0x0f;
1023 raw_xy->button = (data[8] >> 2) & 0x01;
1024
1025 if (raw_xy->finger_count) {
1026 hidpp_touchpad_touch_event(&data[2], &raw_xy->fingers[0]);
1027 hidpp_touchpad_touch_event(&data[9], &raw_xy->fingers[1]);
1028 }
1029 }
1030
1031 /* -------------------------------------------------------------------------- */
1032 /* 0x8123: Force feedback support */
1033 /* -------------------------------------------------------------------------- */
1034
1035 #define HIDPP_FF_GET_INFO 0x01
1036 #define HIDPP_FF_RESET_ALL 0x11
1037 #define HIDPP_FF_DOWNLOAD_EFFECT 0x21
1038 #define HIDPP_FF_SET_EFFECT_STATE 0x31
1039 #define HIDPP_FF_DESTROY_EFFECT 0x41
1040 #define HIDPP_FF_GET_APERTURE 0x51
1041 #define HIDPP_FF_SET_APERTURE 0x61
1042 #define HIDPP_FF_GET_GLOBAL_GAINS 0x71
1043 #define HIDPP_FF_SET_GLOBAL_GAINS 0x81
1044
1045 #define HIDPP_FF_EFFECT_STATE_GET 0x00
1046 #define HIDPP_FF_EFFECT_STATE_STOP 0x01
1047 #define HIDPP_FF_EFFECT_STATE_PLAY 0x02
1048 #define HIDPP_FF_EFFECT_STATE_PAUSE 0x03
1049
1050 #define HIDPP_FF_EFFECT_CONSTANT 0x00
1051 #define HIDPP_FF_EFFECT_PERIODIC_SINE 0x01
1052 #define HIDPP_FF_EFFECT_PERIODIC_SQUARE 0x02
1053 #define HIDPP_FF_EFFECT_PERIODIC_TRIANGLE 0x03
1054 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP 0x04
1055 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN 0x05
1056 #define HIDPP_FF_EFFECT_SPRING 0x06
1057 #define HIDPP_FF_EFFECT_DAMPER 0x07
1058 #define HIDPP_FF_EFFECT_FRICTION 0x08
1059 #define HIDPP_FF_EFFECT_INERTIA 0x09
1060 #define HIDPP_FF_EFFECT_RAMP 0x0A
1061
1062 #define HIDPP_FF_EFFECT_AUTOSTART 0x80
1063
1064 #define HIDPP_FF_EFFECTID_NONE -1
1065 #define HIDPP_FF_EFFECTID_AUTOCENTER -2
1066
1067 #define HIDPP_FF_MAX_PARAMS 20
1068 #define HIDPP_FF_RESERVED_SLOTS 1
1069
1070 struct hidpp_ff_private_data {
1071 struct hidpp_device *hidpp;
1072 u8 feature_index;
1073 u8 version;
1074 u16 gain;
1075 s16 range;
1076 u8 slot_autocenter;
1077 u8 num_effects;
1078 int *effect_ids;
1079 struct workqueue_struct *wq;
1080 atomic_t workqueue_size;
1081 };
1082
1083 struct hidpp_ff_work_data {
1084 struct work_struct work;
1085 struct hidpp_ff_private_data *data;
1086 int effect_id;
1087 u8 command;
1088 u8 params[HIDPP_FF_MAX_PARAMS];
1089 u8 size;
1090 };
1091
1092 static const signed short hiddpp_ff_effects[] = {
1093 FF_CONSTANT,
1094 FF_PERIODIC,
1095 FF_SINE,
1096 FF_SQUARE,
1097 FF_SAW_UP,
1098 FF_SAW_DOWN,
1099 FF_TRIANGLE,
1100 FF_SPRING,
1101 FF_DAMPER,
1102 FF_AUTOCENTER,
1103 FF_GAIN,
1104 -1
1105 };
1106
1107 static const signed short hiddpp_ff_effects_v2[] = {
1108 FF_RAMP,
1109 FF_FRICTION,
1110 FF_INERTIA,
1111 -1
1112 };
1113
1114 static const u8 HIDPP_FF_CONDITION_CMDS[] = {
1115 HIDPP_FF_EFFECT_SPRING,
1116 HIDPP_FF_EFFECT_FRICTION,
1117 HIDPP_FF_EFFECT_DAMPER,
1118 HIDPP_FF_EFFECT_INERTIA
1119 };
1120
1121 static const char *HIDPP_FF_CONDITION_NAMES[] = {
1122 "spring",
1123 "friction",
1124 "damper",
1125 "inertia"
1126 };
1127
1128
1129 static u8 hidpp_ff_find_effect(struct hidpp_ff_private_data *data, int effect_id)
1130 {
1131 int i;
1132
1133 for (i = 0; i < data->num_effects; i++)
1134 if (data->effect_ids[i] == effect_id)
1135 return i+1;
1136
1137 return 0;
1138 }
1139
1140 static void hidpp_ff_work_handler(struct work_struct *w)
1141 {
1142 struct hidpp_ff_work_data *wd = container_of(w, struct hidpp_ff_work_data, work);
1143 struct hidpp_ff_private_data *data = wd->data;
1144 struct hidpp_report response;
1145 u8 slot;
1146 int ret;
1147
1148 /* add slot number if needed */
1149 switch (wd->effect_id) {
1150 case HIDPP_FF_EFFECTID_AUTOCENTER:
1151 wd->params[0] = data->slot_autocenter;
1152 break;
1153 case HIDPP_FF_EFFECTID_NONE:
1154 /* leave slot as zero */
1155 break;
1156 default:
1157 /* find current slot for effect */
1158 wd->params[0] = hidpp_ff_find_effect(data, wd->effect_id);
1159 break;
1160 }
1161
1162 /* send command and wait for reply */
1163 ret = hidpp_send_fap_command_sync(data->hidpp, data->feature_index,
1164 wd->command, wd->params, wd->size, &response);
1165
1166 if (ret) {
1167 hid_err(data->hidpp->hid_dev, "Failed to send command to device!\n");
1168 goto out;
1169 }
1170
1171 /* parse return data */
1172 switch (wd->command) {
1173 case HIDPP_FF_DOWNLOAD_EFFECT:
1174 slot = response.fap.params[0];
1175 if (slot > 0 && slot <= data->num_effects) {
1176 if (wd->effect_id >= 0)
1177 /* regular effect uploaded */
1178 data->effect_ids[slot-1] = wd->effect_id;
1179 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
1180 /* autocenter spring uploaded */
1181 data->slot_autocenter = slot;
1182 }
1183 break;
1184 case HIDPP_FF_DESTROY_EFFECT:
1185 if (wd->effect_id >= 0)
1186 /* regular effect destroyed */
1187 data->effect_ids[wd->params[0]-1] = -1;
1188 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
1189 /* autocenter spring destoyed */
1190 data->slot_autocenter = 0;
1191 break;
1192 case HIDPP_FF_SET_GLOBAL_GAINS:
1193 data->gain = (wd->params[0] << 8) + wd->params[1];
1194 break;
1195 case HIDPP_FF_SET_APERTURE:
1196 data->range = (wd->params[0] << 8) + wd->params[1];
1197 break;
1198 default:
1199 /* no action needed */
1200 break;
1201 }
1202
1203 out:
1204 atomic_dec(&data->workqueue_size);
1205 kfree(wd);
1206 }
1207
1208 static int hidpp_ff_queue_work(struct hidpp_ff_private_data *data, int effect_id, u8 command, u8 *params, u8 size)
1209 {
1210 struct hidpp_ff_work_data *wd = kzalloc(sizeof(*wd), GFP_KERNEL);
1211 int s;
1212
1213 if (!wd)
1214 return -ENOMEM;
1215
1216 INIT_WORK(&wd->work, hidpp_ff_work_handler);
1217
1218 wd->data = data;
1219 wd->effect_id = effect_id;
1220 wd->command = command;
1221 wd->size = size;
1222 memcpy(wd->params, params, size);
1223
1224 atomic_inc(&data->workqueue_size);
1225 queue_work(data->wq, &wd->work);
1226
1227 /* warn about excessive queue size */
1228 s = atomic_read(&data->workqueue_size);
1229 if (s >= 20 && s % 20 == 0)
1230 hid_warn(data->hidpp->hid_dev, "Force feedback command queue contains %d commands, causing substantial delays!", s);
1231
1232 return 0;
1233 }
1234
1235 static int hidpp_ff_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
1236 {
1237 struct hidpp_ff_private_data *data = dev->ff->private;
1238 u8 params[20];
1239 u8 size;
1240 int force;
1241
1242 /* set common parameters */
1243 params[2] = effect->replay.length >> 8;
1244 params[3] = effect->replay.length & 255;
1245 params[4] = effect->replay.delay >> 8;
1246 params[5] = effect->replay.delay & 255;
1247
1248 switch (effect->type) {
1249 case FF_CONSTANT:
1250 force = (effect->u.constant.level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1251 params[1] = HIDPP_FF_EFFECT_CONSTANT;
1252 params[6] = force >> 8;
1253 params[7] = force & 255;
1254 params[8] = effect->u.constant.envelope.attack_level >> 7;
1255 params[9] = effect->u.constant.envelope.attack_length >> 8;
1256 params[10] = effect->u.constant.envelope.attack_length & 255;
1257 params[11] = effect->u.constant.envelope.fade_level >> 7;
1258 params[12] = effect->u.constant.envelope.fade_length >> 8;
1259 params[13] = effect->u.constant.envelope.fade_length & 255;
1260 size = 14;
1261 dbg_hid("Uploading constant force level=%d in dir %d = %d\n",
1262 effect->u.constant.level,
1263 effect->direction, force);
1264 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1265 effect->u.constant.envelope.attack_level,
1266 effect->u.constant.envelope.attack_length,
1267 effect->u.constant.envelope.fade_level,
1268 effect->u.constant.envelope.fade_length);
1269 break;
1270 case FF_PERIODIC:
1271 {
1272 switch (effect->u.periodic.waveform) {
1273 case FF_SINE:
1274 params[1] = HIDPP_FF_EFFECT_PERIODIC_SINE;
1275 break;
1276 case FF_SQUARE:
1277 params[1] = HIDPP_FF_EFFECT_PERIODIC_SQUARE;
1278 break;
1279 case FF_SAW_UP:
1280 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP;
1281 break;
1282 case FF_SAW_DOWN:
1283 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN;
1284 break;
1285 case FF_TRIANGLE:
1286 params[1] = HIDPP_FF_EFFECT_PERIODIC_TRIANGLE;
1287 break;
1288 default:
1289 hid_err(data->hidpp->hid_dev, "Unexpected periodic waveform type %i!\n", effect->u.periodic.waveform);
1290 return -EINVAL;
1291 }
1292 force = (effect->u.periodic.magnitude * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1293 params[6] = effect->u.periodic.magnitude >> 8;
1294 params[7] = effect->u.periodic.magnitude & 255;
1295 params[8] = effect->u.periodic.offset >> 8;
1296 params[9] = effect->u.periodic.offset & 255;
1297 params[10] = effect->u.periodic.period >> 8;
1298 params[11] = effect->u.periodic.period & 255;
1299 params[12] = effect->u.periodic.phase >> 8;
1300 params[13] = effect->u.periodic.phase & 255;
1301 params[14] = effect->u.periodic.envelope.attack_level >> 7;
1302 params[15] = effect->u.periodic.envelope.attack_length >> 8;
1303 params[16] = effect->u.periodic.envelope.attack_length & 255;
1304 params[17] = effect->u.periodic.envelope.fade_level >> 7;
1305 params[18] = effect->u.periodic.envelope.fade_length >> 8;
1306 params[19] = effect->u.periodic.envelope.fade_length & 255;
1307 size = 20;
1308 dbg_hid("Uploading periodic force mag=%d/dir=%d, offset=%d, period=%d ms, phase=%d\n",
1309 effect->u.periodic.magnitude, effect->direction,
1310 effect->u.periodic.offset,
1311 effect->u.periodic.period,
1312 effect->u.periodic.phase);
1313 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1314 effect->u.periodic.envelope.attack_level,
1315 effect->u.periodic.envelope.attack_length,
1316 effect->u.periodic.envelope.fade_level,
1317 effect->u.periodic.envelope.fade_length);
1318 break;
1319 }
1320 case FF_RAMP:
1321 params[1] = HIDPP_FF_EFFECT_RAMP;
1322 force = (effect->u.ramp.start_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1323 params[6] = force >> 8;
1324 params[7] = force & 255;
1325 force = (effect->u.ramp.end_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1326 params[8] = force >> 8;
1327 params[9] = force & 255;
1328 params[10] = effect->u.ramp.envelope.attack_level >> 7;
1329 params[11] = effect->u.ramp.envelope.attack_length >> 8;
1330 params[12] = effect->u.ramp.envelope.attack_length & 255;
1331 params[13] = effect->u.ramp.envelope.fade_level >> 7;
1332 params[14] = effect->u.ramp.envelope.fade_length >> 8;
1333 params[15] = effect->u.ramp.envelope.fade_length & 255;
1334 size = 16;
1335 dbg_hid("Uploading ramp force level=%d -> %d in dir %d = %d\n",
1336 effect->u.ramp.start_level,
1337 effect->u.ramp.end_level,
1338 effect->direction, force);
1339 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1340 effect->u.ramp.envelope.attack_level,
1341 effect->u.ramp.envelope.attack_length,
1342 effect->u.ramp.envelope.fade_level,
1343 effect->u.ramp.envelope.fade_length);
1344 break;
1345 case FF_FRICTION:
1346 case FF_INERTIA:
1347 case FF_SPRING:
1348 case FF_DAMPER:
1349 params[1] = HIDPP_FF_CONDITION_CMDS[effect->type - FF_SPRING];
1350 params[6] = effect->u.condition[0].left_saturation >> 9;
1351 params[7] = (effect->u.condition[0].left_saturation >> 1) & 255;
1352 params[8] = effect->u.condition[0].left_coeff >> 8;
1353 params[9] = effect->u.condition[0].left_coeff & 255;
1354 params[10] = effect->u.condition[0].deadband >> 9;
1355 params[11] = (effect->u.condition[0].deadband >> 1) & 255;
1356 params[12] = effect->u.condition[0].center >> 8;
1357 params[13] = effect->u.condition[0].center & 255;
1358 params[14] = effect->u.condition[0].right_coeff >> 8;
1359 params[15] = effect->u.condition[0].right_coeff & 255;
1360 params[16] = effect->u.condition[0].right_saturation >> 9;
1361 params[17] = (effect->u.condition[0].right_saturation >> 1) & 255;
1362 size = 18;
1363 dbg_hid("Uploading %s force left coeff=%d, left sat=%d, right coeff=%d, right sat=%d\n",
1364 HIDPP_FF_CONDITION_NAMES[effect->type - FF_SPRING],
1365 effect->u.condition[0].left_coeff,
1366 effect->u.condition[0].left_saturation,
1367 effect->u.condition[0].right_coeff,
1368 effect->u.condition[0].right_saturation);
1369 dbg_hid(" deadband=%d, center=%d\n",
1370 effect->u.condition[0].deadband,
1371 effect->u.condition[0].center);
1372 break;
1373 default:
1374 hid_err(data->hidpp->hid_dev, "Unexpected force type %i!\n", effect->type);
1375 return -EINVAL;
1376 }
1377
1378 return hidpp_ff_queue_work(data, effect->id, HIDPP_FF_DOWNLOAD_EFFECT, params, size);
1379 }
1380
1381 static int hidpp_ff_playback(struct input_dev *dev, int effect_id, int value)
1382 {
1383 struct hidpp_ff_private_data *data = dev->ff->private;
1384 u8 params[2];
1385
1386 params[1] = value ? HIDPP_FF_EFFECT_STATE_PLAY : HIDPP_FF_EFFECT_STATE_STOP;
1387
1388 dbg_hid("St%sing playback of effect %d.\n", value?"art":"opp", effect_id);
1389
1390 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_SET_EFFECT_STATE, params, ARRAY_SIZE(params));
1391 }
1392
1393 static int hidpp_ff_erase_effect(struct input_dev *dev, int effect_id)
1394 {
1395 struct hidpp_ff_private_data *data = dev->ff->private;
1396 u8 slot = 0;
1397
1398 dbg_hid("Erasing effect %d.\n", effect_id);
1399
1400 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_DESTROY_EFFECT, &slot, 1);
1401 }
1402
1403 static void hidpp_ff_set_autocenter(struct input_dev *dev, u16 magnitude)
1404 {
1405 struct hidpp_ff_private_data *data = dev->ff->private;
1406 u8 params[18];
1407
1408 dbg_hid("Setting autocenter to %d.\n", magnitude);
1409
1410 /* start a standard spring effect */
1411 params[1] = HIDPP_FF_EFFECT_SPRING | HIDPP_FF_EFFECT_AUTOSTART;
1412 /* zero delay and duration */
1413 params[2] = params[3] = params[4] = params[5] = 0;
1414 /* set coeff to 25% of saturation */
1415 params[8] = params[14] = magnitude >> 11;
1416 params[9] = params[15] = (magnitude >> 3) & 255;
1417 params[6] = params[16] = magnitude >> 9;
1418 params[7] = params[17] = (magnitude >> 1) & 255;
1419 /* zero deadband and center */
1420 params[10] = params[11] = params[12] = params[13] = 0;
1421
1422 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_AUTOCENTER, HIDPP_FF_DOWNLOAD_EFFECT, params, ARRAY_SIZE(params));
1423 }
1424
1425 static void hidpp_ff_set_gain(struct input_dev *dev, u16 gain)
1426 {
1427 struct hidpp_ff_private_data *data = dev->ff->private;
1428 u8 params[4];
1429
1430 dbg_hid("Setting gain to %d.\n", gain);
1431
1432 params[0] = gain >> 8;
1433 params[1] = gain & 255;
1434 params[2] = 0; /* no boost */
1435 params[3] = 0;
1436
1437 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_NONE, HIDPP_FF_SET_GLOBAL_GAINS, params, ARRAY_SIZE(params));
1438 }
1439
1440 static ssize_t hidpp_ff_range_show(struct device *dev, struct device_attribute *attr, char *buf)
1441 {
1442 struct hid_device *hid = to_hid_device(dev);
1443 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
1444 struct input_dev *idev = hidinput->input;
1445 struct hidpp_ff_private_data *data = idev->ff->private;
1446
1447 return scnprintf(buf, PAGE_SIZE, "%u\n", data->range);
1448 }
1449
1450 static ssize_t hidpp_ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1451 {
1452 struct hid_device *hid = to_hid_device(dev);
1453 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
1454 struct input_dev *idev = hidinput->input;
1455 struct hidpp_ff_private_data *data = idev->ff->private;
1456 u8 params[2];
1457 int range = simple_strtoul(buf, NULL, 10);
1458
1459 range = clamp(range, 180, 900);
1460
1461 params[0] = range >> 8;
1462 params[1] = range & 0x00FF;
1463
1464 hidpp_ff_queue_work(data, -1, HIDPP_FF_SET_APERTURE, params, ARRAY_SIZE(params));
1465
1466 return count;
1467 }
1468
1469 static DEVICE_ATTR(range, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, hidpp_ff_range_show, hidpp_ff_range_store);
1470
1471 static void hidpp_ff_destroy(struct ff_device *ff)
1472 {
1473 struct hidpp_ff_private_data *data = ff->private;
1474
1475 kfree(data->effect_ids);
1476 }
1477
1478 static int hidpp_ff_init(struct hidpp_device *hidpp, u8 feature_index)
1479 {
1480 struct hid_device *hid = hidpp->hid_dev;
1481 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
1482 struct input_dev *dev = hidinput->input;
1483 const struct usb_device_descriptor *udesc = &(hid_to_usb_dev(hid)->descriptor);
1484 const u16 bcdDevice = le16_to_cpu(udesc->bcdDevice);
1485 struct ff_device *ff;
1486 struct hidpp_report response;
1487 struct hidpp_ff_private_data *data;
1488 int error, j, num_slots;
1489 u8 version;
1490
1491 if (!dev) {
1492 hid_err(hid, "Struct input_dev not set!\n");
1493 return -EINVAL;
1494 }
1495
1496 /* Get firmware release */
1497 version = bcdDevice & 255;
1498
1499 /* Set supported force feedback capabilities */
1500 for (j = 0; hiddpp_ff_effects[j] >= 0; j++)
1501 set_bit(hiddpp_ff_effects[j], dev->ffbit);
1502 if (version > 1)
1503 for (j = 0; hiddpp_ff_effects_v2[j] >= 0; j++)
1504 set_bit(hiddpp_ff_effects_v2[j], dev->ffbit);
1505
1506 /* Read number of slots available in device */
1507 error = hidpp_send_fap_command_sync(hidpp, feature_index,
1508 HIDPP_FF_GET_INFO, NULL, 0, &response);
1509 if (error) {
1510 if (error < 0)
1511 return error;
1512 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1513 __func__, error);
1514 return -EPROTO;
1515 }
1516
1517 num_slots = response.fap.params[0] - HIDPP_FF_RESERVED_SLOTS;
1518
1519 error = input_ff_create(dev, num_slots);
1520
1521 if (error) {
1522 hid_err(dev, "Failed to create FF device!\n");
1523 return error;
1524 }
1525
1526 data = kzalloc(sizeof(*data), GFP_KERNEL);
1527 if (!data)
1528 return -ENOMEM;
1529 data->effect_ids = kcalloc(num_slots, sizeof(int), GFP_KERNEL);
1530 if (!data->effect_ids) {
1531 kfree(data);
1532 return -ENOMEM;
1533 }
1534 data->hidpp = hidpp;
1535 data->feature_index = feature_index;
1536 data->version = version;
1537 data->slot_autocenter = 0;
1538 data->num_effects = num_slots;
1539 for (j = 0; j < num_slots; j++)
1540 data->effect_ids[j] = -1;
1541
1542 ff = dev->ff;
1543 ff->private = data;
1544
1545 ff->upload = hidpp_ff_upload_effect;
1546 ff->erase = hidpp_ff_erase_effect;
1547 ff->playback = hidpp_ff_playback;
1548 ff->set_gain = hidpp_ff_set_gain;
1549 ff->set_autocenter = hidpp_ff_set_autocenter;
1550 ff->destroy = hidpp_ff_destroy;
1551
1552
1553 /* reset all forces */
1554 error = hidpp_send_fap_command_sync(hidpp, feature_index,
1555 HIDPP_FF_RESET_ALL, NULL, 0, &response);
1556
1557 /* Read current Range */
1558 error = hidpp_send_fap_command_sync(hidpp, feature_index,
1559 HIDPP_FF_GET_APERTURE, NULL, 0, &response);
1560 if (error)
1561 hid_warn(hidpp->hid_dev, "Failed to read range from device!\n");
1562 data->range = error ? 900 : get_unaligned_be16(&response.fap.params[0]);
1563
1564 /* Create sysfs interface */
1565 error = device_create_file(&(hidpp->hid_dev->dev), &dev_attr_range);
1566 if (error)
1567 hid_warn(hidpp->hid_dev, "Unable to create sysfs interface for \"range\", errno %d!\n", error);
1568
1569 /* Read the current gain values */
1570 error = hidpp_send_fap_command_sync(hidpp, feature_index,
1571 HIDPP_FF_GET_GLOBAL_GAINS, NULL, 0, &response);
1572 if (error)
1573 hid_warn(hidpp->hid_dev, "Failed to read gain values from device!\n");
1574 data->gain = error ? 0xffff : get_unaligned_be16(&response.fap.params[0]);
1575 /* ignore boost value at response.fap.params[2] */
1576
1577 /* init the hardware command queue */
1578 data->wq = create_singlethread_workqueue("hidpp-ff-sendqueue");
1579 atomic_set(&data->workqueue_size, 0);
1580
1581 /* initialize with zero autocenter to get wheel in usable state */
1582 hidpp_ff_set_autocenter(dev, 0);
1583
1584 hid_info(hid, "Force feeback support loaded (firmware release %d).\n", version);
1585
1586 return 0;
1587 }
1588
1589 static int hidpp_ff_deinit(struct hid_device *hid)
1590 {
1591 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
1592 struct input_dev *dev = hidinput->input;
1593 struct hidpp_ff_private_data *data;
1594
1595 if (!dev) {
1596 hid_err(hid, "Struct input_dev not found!\n");
1597 return -EINVAL;
1598 }
1599
1600 hid_info(hid, "Unloading HID++ force feedback.\n");
1601 data = dev->ff->private;
1602 if (!data) {
1603 hid_err(hid, "Private data not found!\n");
1604 return -EINVAL;
1605 }
1606
1607 destroy_workqueue(data->wq);
1608 device_remove_file(&hid->dev, &dev_attr_range);
1609
1610 return 0;
1611 }
1612
1613
1614 /* ************************************************************************** */
1615 /* */
1616 /* Device Support */
1617 /* */
1618 /* ************************************************************************** */
1619
1620 /* -------------------------------------------------------------------------- */
1621 /* Touchpad HID++ devices */
1622 /* -------------------------------------------------------------------------- */
1623
1624 #define WTP_MANUAL_RESOLUTION 39
1625
1626 struct wtp_data {
1627 struct input_dev *input;
1628 u16 x_size, y_size;
1629 u8 finger_count;
1630 u8 mt_feature_index;
1631 u8 button_feature_index;
1632 u8 maxcontacts;
1633 bool flip_y;
1634 unsigned int resolution;
1635 };
1636
1637 static int wtp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
1638 struct hid_field *field, struct hid_usage *usage,
1639 unsigned long **bit, int *max)
1640 {
1641 return -1;
1642 }
1643
1644 static void wtp_populate_input(struct hidpp_device *hidpp,
1645 struct input_dev *input_dev, bool origin_is_hid_core)
1646 {
1647 struct wtp_data *wd = hidpp->private_data;
1648
1649 __set_bit(EV_ABS, input_dev->evbit);
1650 __set_bit(EV_KEY, input_dev->evbit);
1651 __clear_bit(EV_REL, input_dev->evbit);
1652 __clear_bit(EV_LED, input_dev->evbit);
1653
1654 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0, wd->x_size, 0, 0);
1655 input_abs_set_res(input_dev, ABS_MT_POSITION_X, wd->resolution);
1656 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0, wd->y_size, 0, 0);
1657 input_abs_set_res(input_dev, ABS_MT_POSITION_Y, wd->resolution);
1658
1659 /* Max pressure is not given by the devices, pick one */
1660 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 50, 0, 0);
1661
1662 input_set_capability(input_dev, EV_KEY, BTN_LEFT);
1663
1664 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS)
1665 input_set_capability(input_dev, EV_KEY, BTN_RIGHT);
1666 else
1667 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1668
1669 input_mt_init_slots(input_dev, wd->maxcontacts, INPUT_MT_POINTER |
1670 INPUT_MT_DROP_UNUSED);
1671
1672 wd->input = input_dev;
1673 }
1674
1675 static void wtp_touch_event(struct wtp_data *wd,
1676 struct hidpp_touchpad_raw_xy_finger *touch_report)
1677 {
1678 int slot;
1679
1680 if (!touch_report->finger_id || touch_report->contact_type)
1681 /* no actual data */
1682 return;
1683
1684 slot = input_mt_get_slot_by_key(wd->input, touch_report->finger_id);
1685
1686 input_mt_slot(wd->input, slot);
1687 input_mt_report_slot_state(wd->input, MT_TOOL_FINGER,
1688 touch_report->contact_status);
1689 if (touch_report->contact_status) {
1690 input_event(wd->input, EV_ABS, ABS_MT_POSITION_X,
1691 touch_report->x);
1692 input_event(wd->input, EV_ABS, ABS_MT_POSITION_Y,
1693 wd->flip_y ? wd->y_size - touch_report->y :
1694 touch_report->y);
1695 input_event(wd->input, EV_ABS, ABS_MT_PRESSURE,
1696 touch_report->area);
1697 }
1698 }
1699
1700 static void wtp_send_raw_xy_event(struct hidpp_device *hidpp,
1701 struct hidpp_touchpad_raw_xy *raw)
1702 {
1703 struct wtp_data *wd = hidpp->private_data;
1704 int i;
1705
1706 for (i = 0; i < 2; i++)
1707 wtp_touch_event(wd, &(raw->fingers[i]));
1708
1709 if (raw->end_of_frame &&
1710 !(hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS))
1711 input_event(wd->input, EV_KEY, BTN_LEFT, raw->button);
1712
1713 if (raw->end_of_frame || raw->finger_count <= 2) {
1714 input_mt_sync_frame(wd->input);
1715 input_sync(wd->input);
1716 }
1717 }
1718
1719 static int wtp_mouse_raw_xy_event(struct hidpp_device *hidpp, u8 *data)
1720 {
1721 struct wtp_data *wd = hidpp->private_data;
1722 u8 c1_area = ((data[7] & 0xf) * (data[7] & 0xf) +
1723 (data[7] >> 4) * (data[7] >> 4)) / 2;
1724 u8 c2_area = ((data[13] & 0xf) * (data[13] & 0xf) +
1725 (data[13] >> 4) * (data[13] >> 4)) / 2;
1726 struct hidpp_touchpad_raw_xy raw = {
1727 .timestamp = data[1],
1728 .fingers = {
1729 {
1730 .contact_type = 0,
1731 .contact_status = !!data[7],
1732 .x = get_unaligned_le16(&data[3]),
1733 .y = get_unaligned_le16(&data[5]),
1734 .z = c1_area,
1735 .area = c1_area,
1736 .finger_id = data[2],
1737 }, {
1738 .contact_type = 0,
1739 .contact_status = !!data[13],
1740 .x = get_unaligned_le16(&data[9]),
1741 .y = get_unaligned_le16(&data[11]),
1742 .z = c2_area,
1743 .area = c2_area,
1744 .finger_id = data[8],
1745 }
1746 },
1747 .finger_count = wd->maxcontacts,
1748 .spurious_flag = 0,
1749 .end_of_frame = (data[0] >> 7) == 0,
1750 .button = data[0] & 0x01,
1751 };
1752
1753 wtp_send_raw_xy_event(hidpp, &raw);
1754
1755 return 1;
1756 }
1757
1758 static int wtp_raw_event(struct hid_device *hdev, u8 *data, int size)
1759 {
1760 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1761 struct wtp_data *wd = hidpp->private_data;
1762 struct hidpp_report *report = (struct hidpp_report *)data;
1763 struct hidpp_touchpad_raw_xy raw;
1764
1765 if (!wd || !wd->input)
1766 return 1;
1767
1768 switch (data[0]) {
1769 case 0x02:
1770 if (size < 2) {
1771 hid_err(hdev, "Received HID report of bad size (%d)",
1772 size);
1773 return 1;
1774 }
1775 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS) {
1776 input_event(wd->input, EV_KEY, BTN_LEFT,
1777 !!(data[1] & 0x01));
1778 input_event(wd->input, EV_KEY, BTN_RIGHT,
1779 !!(data[1] & 0x02));
1780 input_sync(wd->input);
1781 return 0;
1782 } else {
1783 if (size < 21)
1784 return 1;
1785 return wtp_mouse_raw_xy_event(hidpp, &data[7]);
1786 }
1787 case REPORT_ID_HIDPP_LONG:
1788 /* size is already checked in hidpp_raw_event. */
1789 if ((report->fap.feature_index != wd->mt_feature_index) ||
1790 (report->fap.funcindex_clientid != EVENT_TOUCHPAD_RAW_XY))
1791 return 1;
1792 hidpp_touchpad_raw_xy_event(hidpp, data + 4, &raw);
1793
1794 wtp_send_raw_xy_event(hidpp, &raw);
1795 return 0;
1796 }
1797
1798 return 0;
1799 }
1800
1801 static int wtp_get_config(struct hidpp_device *hidpp)
1802 {
1803 struct wtp_data *wd = hidpp->private_data;
1804 struct hidpp_touchpad_raw_info raw_info = {0};
1805 u8 feature_type;
1806 int ret;
1807
1808 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_TOUCHPAD_RAW_XY,
1809 &wd->mt_feature_index, &feature_type);
1810 if (ret)
1811 /* means that the device is not powered up */
1812 return ret;
1813
1814 ret = hidpp_touchpad_get_raw_info(hidpp, wd->mt_feature_index,
1815 &raw_info);
1816 if (ret)
1817 return ret;
1818
1819 wd->x_size = raw_info.x_size;
1820 wd->y_size = raw_info.y_size;
1821 wd->maxcontacts = raw_info.maxcontacts;
1822 wd->flip_y = raw_info.origin == TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT;
1823 wd->resolution = raw_info.res;
1824 if (!wd->resolution)
1825 wd->resolution = WTP_MANUAL_RESOLUTION;
1826
1827 return 0;
1828 }
1829
1830 static int wtp_allocate(struct hid_device *hdev, const struct hid_device_id *id)
1831 {
1832 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1833 struct wtp_data *wd;
1834
1835 wd = devm_kzalloc(&hdev->dev, sizeof(struct wtp_data),
1836 GFP_KERNEL);
1837 if (!wd)
1838 return -ENOMEM;
1839
1840 hidpp->private_data = wd;
1841
1842 return 0;
1843 };
1844
1845 static int wtp_connect(struct hid_device *hdev, bool connected)
1846 {
1847 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1848 struct wtp_data *wd = hidpp->private_data;
1849 int ret;
1850
1851 if (!wd->x_size) {
1852 ret = wtp_get_config(hidpp);
1853 if (ret) {
1854 hid_err(hdev, "Can not get wtp config: %d\n", ret);
1855 return ret;
1856 }
1857 }
1858
1859 return hidpp_touchpad_set_raw_report_state(hidpp, wd->mt_feature_index,
1860 true, true);
1861 }
1862
1863 /* ------------------------------------------------------------------------- */
1864 /* Logitech M560 devices */
1865 /* ------------------------------------------------------------------------- */
1866
1867 /*
1868 * Logitech M560 protocol overview
1869 *
1870 * The Logitech M560 mouse, is designed for windows 8. When the middle and/or
1871 * the sides buttons are pressed, it sends some keyboard keys events
1872 * instead of buttons ones.
1873 * To complicate things further, the middle button keys sequence
1874 * is different from the odd press and the even press.
1875 *
1876 * forward button -> Super_R
1877 * backward button -> Super_L+'d' (press only)
1878 * middle button -> 1st time: Alt_L+SuperL+XF86TouchpadOff (press only)
1879 * 2nd time: left-click (press only)
1880 * NB: press-only means that when the button is pressed, the
1881 * KeyPress/ButtonPress and KeyRelease/ButtonRelease events are generated
1882 * together sequentially; instead when the button is released, no event is
1883 * generated !
1884 *
1885 * With the command
1886 * 10<xx>0a 3500af03 (where <xx> is the mouse id),
1887 * the mouse reacts differently:
1888 * - it never sends a keyboard key event
1889 * - for the three mouse button it sends:
1890 * middle button press 11<xx>0a 3500af00...
1891 * side 1 button (forward) press 11<xx>0a 3500b000...
1892 * side 2 button (backward) press 11<xx>0a 3500ae00...
1893 * middle/side1/side2 button release 11<xx>0a 35000000...
1894 */
1895
1896 static const u8 m560_config_parameter[] = {0x00, 0xaf, 0x03};
1897
1898 struct m560_private_data {
1899 struct input_dev *input;
1900 };
1901
1902 /* how buttons are mapped in the report */
1903 #define M560_MOUSE_BTN_LEFT 0x01
1904 #define M560_MOUSE_BTN_RIGHT 0x02
1905 #define M560_MOUSE_BTN_WHEEL_LEFT 0x08
1906 #define M560_MOUSE_BTN_WHEEL_RIGHT 0x10
1907
1908 #define M560_SUB_ID 0x0a
1909 #define M560_BUTTON_MODE_REGISTER 0x35
1910
1911 static int m560_send_config_command(struct hid_device *hdev, bool connected)
1912 {
1913 struct hidpp_report response;
1914 struct hidpp_device *hidpp_dev;
1915
1916 hidpp_dev = hid_get_drvdata(hdev);
1917
1918 return hidpp_send_rap_command_sync(
1919 hidpp_dev,
1920 REPORT_ID_HIDPP_SHORT,
1921 M560_SUB_ID,
1922 M560_BUTTON_MODE_REGISTER,
1923 (u8 *)m560_config_parameter,
1924 sizeof(m560_config_parameter),
1925 &response
1926 );
1927 }
1928
1929 static int m560_allocate(struct hid_device *hdev)
1930 {
1931 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1932 struct m560_private_data *d;
1933
1934 d = devm_kzalloc(&hdev->dev, sizeof(struct m560_private_data),
1935 GFP_KERNEL);
1936 if (!d)
1937 return -ENOMEM;
1938
1939 hidpp->private_data = d;
1940
1941 return 0;
1942 };
1943
1944 static int m560_raw_event(struct hid_device *hdev, u8 *data, int size)
1945 {
1946 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1947 struct m560_private_data *mydata = hidpp->private_data;
1948
1949 /* sanity check */
1950 if (!mydata || !mydata->input) {
1951 hid_err(hdev, "error in parameter\n");
1952 return -EINVAL;
1953 }
1954
1955 if (size < 7) {
1956 hid_err(hdev, "error in report\n");
1957 return 0;
1958 }
1959
1960 if (data[0] == REPORT_ID_HIDPP_LONG &&
1961 data[2] == M560_SUB_ID && data[6] == 0x00) {
1962 /*
1963 * m560 mouse report for middle, forward and backward button
1964 *
1965 * data[0] = 0x11
1966 * data[1] = device-id
1967 * data[2] = 0x0a
1968 * data[5] = 0xaf -> middle
1969 * 0xb0 -> forward
1970 * 0xae -> backward
1971 * 0x00 -> release all
1972 * data[6] = 0x00
1973 */
1974
1975 switch (data[5]) {
1976 case 0xaf:
1977 input_report_key(mydata->input, BTN_MIDDLE, 1);
1978 break;
1979 case 0xb0:
1980 input_report_key(mydata->input, BTN_FORWARD, 1);
1981 break;
1982 case 0xae:
1983 input_report_key(mydata->input, BTN_BACK, 1);
1984 break;
1985 case 0x00:
1986 input_report_key(mydata->input, BTN_BACK, 0);
1987 input_report_key(mydata->input, BTN_FORWARD, 0);
1988 input_report_key(mydata->input, BTN_MIDDLE, 0);
1989 break;
1990 default:
1991 hid_err(hdev, "error in report\n");
1992 return 0;
1993 }
1994 input_sync(mydata->input);
1995
1996 } else if (data[0] == 0x02) {
1997 /*
1998 * Logitech M560 mouse report
1999 *
2000 * data[0] = type (0x02)
2001 * data[1..2] = buttons
2002 * data[3..5] = xy
2003 * data[6] = wheel
2004 */
2005
2006 int v;
2007
2008 input_report_key(mydata->input, BTN_LEFT,
2009 !!(data[1] & M560_MOUSE_BTN_LEFT));
2010 input_report_key(mydata->input, BTN_RIGHT,
2011 !!(data[1] & M560_MOUSE_BTN_RIGHT));
2012
2013 if (data[1] & M560_MOUSE_BTN_WHEEL_LEFT)
2014 input_report_rel(mydata->input, REL_HWHEEL, -1);
2015 else if (data[1] & M560_MOUSE_BTN_WHEEL_RIGHT)
2016 input_report_rel(mydata->input, REL_HWHEEL, 1);
2017
2018 v = hid_snto32(hid_field_extract(hdev, data+3, 0, 12), 12);
2019 input_report_rel(mydata->input, REL_X, v);
2020
2021 v = hid_snto32(hid_field_extract(hdev, data+3, 12, 12), 12);
2022 input_report_rel(mydata->input, REL_Y, v);
2023
2024 v = hid_snto32(data[6], 8);
2025 input_report_rel(mydata->input, REL_WHEEL, v);
2026
2027 input_sync(mydata->input);
2028 }
2029
2030 return 1;
2031 }
2032
2033 static void m560_populate_input(struct hidpp_device *hidpp,
2034 struct input_dev *input_dev, bool origin_is_hid_core)
2035 {
2036 struct m560_private_data *mydata = hidpp->private_data;
2037
2038 mydata->input = input_dev;
2039
2040 __set_bit(EV_KEY, mydata->input->evbit);
2041 __set_bit(BTN_MIDDLE, mydata->input->keybit);
2042 __set_bit(BTN_RIGHT, mydata->input->keybit);
2043 __set_bit(BTN_LEFT, mydata->input->keybit);
2044 __set_bit(BTN_BACK, mydata->input->keybit);
2045 __set_bit(BTN_FORWARD, mydata->input->keybit);
2046
2047 __set_bit(EV_REL, mydata->input->evbit);
2048 __set_bit(REL_X, mydata->input->relbit);
2049 __set_bit(REL_Y, mydata->input->relbit);
2050 __set_bit(REL_WHEEL, mydata->input->relbit);
2051 __set_bit(REL_HWHEEL, mydata->input->relbit);
2052 }
2053
2054 static int m560_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2055 struct hid_field *field, struct hid_usage *usage,
2056 unsigned long **bit, int *max)
2057 {
2058 return -1;
2059 }
2060
2061 /* ------------------------------------------------------------------------- */
2062 /* Logitech K400 devices */
2063 /* ------------------------------------------------------------------------- */
2064
2065 /*
2066 * The Logitech K400 keyboard has an embedded touchpad which is seen
2067 * as a mouse from the OS point of view. There is a hardware shortcut to disable
2068 * tap-to-click but the setting is not remembered accross reset, annoying some
2069 * users.
2070 *
2071 * We can toggle this feature from the host by using the feature 0x6010:
2072 * Touchpad FW items
2073 */
2074
2075 struct k400_private_data {
2076 u8 feature_index;
2077 };
2078
2079 static int k400_disable_tap_to_click(struct hidpp_device *hidpp)
2080 {
2081 struct k400_private_data *k400 = hidpp->private_data;
2082 struct hidpp_touchpad_fw_items items = {};
2083 int ret;
2084 u8 feature_type;
2085
2086 if (!k400->feature_index) {
2087 ret = hidpp_root_get_feature(hidpp,
2088 HIDPP_PAGE_TOUCHPAD_FW_ITEMS,
2089 &k400->feature_index, &feature_type);
2090 if (ret)
2091 /* means that the device is not powered up */
2092 return ret;
2093 }
2094
2095 ret = hidpp_touchpad_fw_items_set(hidpp, k400->feature_index, &items);
2096 if (ret)
2097 return ret;
2098
2099 return 0;
2100 }
2101
2102 static int k400_allocate(struct hid_device *hdev)
2103 {
2104 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2105 struct k400_private_data *k400;
2106
2107 k400 = devm_kzalloc(&hdev->dev, sizeof(struct k400_private_data),
2108 GFP_KERNEL);
2109 if (!k400)
2110 return -ENOMEM;
2111
2112 hidpp->private_data = k400;
2113
2114 return 0;
2115 };
2116
2117 static int k400_connect(struct hid_device *hdev, bool connected)
2118 {
2119 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2120
2121 if (!disable_tap_to_click)
2122 return 0;
2123
2124 return k400_disable_tap_to_click(hidpp);
2125 }
2126
2127 /* ------------------------------------------------------------------------- */
2128 /* Logitech G920 Driving Force Racing Wheel for Xbox One */
2129 /* ------------------------------------------------------------------------- */
2130
2131 #define HIDPP_PAGE_G920_FORCE_FEEDBACK 0x8123
2132
2133 static int g920_get_config(struct hidpp_device *hidpp)
2134 {
2135 u8 feature_type;
2136 u8 feature_index;
2137 int ret;
2138
2139 /* Find feature and store for later use */
2140 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_G920_FORCE_FEEDBACK,
2141 &feature_index, &feature_type);
2142 if (ret)
2143 return ret;
2144
2145 ret = hidpp_ff_init(hidpp, feature_index);
2146 if (ret)
2147 hid_warn(hidpp->hid_dev, "Unable to initialize force feedback support, errno %d\n",
2148 ret);
2149
2150 return 0;
2151 }
2152
2153 /* -------------------------------------------------------------------------- */
2154 /* Generic HID++ devices */
2155 /* -------------------------------------------------------------------------- */
2156
2157 static int hidpp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2158 struct hid_field *field, struct hid_usage *usage,
2159 unsigned long **bit, int *max)
2160 {
2161 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2162
2163 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2164 return wtp_input_mapping(hdev, hi, field, usage, bit, max);
2165 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560 &&
2166 field->application != HID_GD_MOUSE)
2167 return m560_input_mapping(hdev, hi, field, usage, bit, max);
2168
2169 return 0;
2170 }
2171
2172 static int hidpp_input_mapped(struct hid_device *hdev, struct hid_input *hi,
2173 struct hid_field *field, struct hid_usage *usage,
2174 unsigned long **bit, int *max)
2175 {
2176 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2177
2178 /* Ensure that Logitech G920 is not given a default fuzz/flat value */
2179 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
2180 if (usage->type == EV_ABS && (usage->code == ABS_X ||
2181 usage->code == ABS_Y || usage->code == ABS_Z ||
2182 usage->code == ABS_RZ)) {
2183 field->application = HID_GD_MULTIAXIS;
2184 }
2185 }
2186
2187 return 0;
2188 }
2189
2190
2191 static void hidpp_populate_input(struct hidpp_device *hidpp,
2192 struct input_dev *input, bool origin_is_hid_core)
2193 {
2194 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2195 wtp_populate_input(hidpp, input, origin_is_hid_core);
2196 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
2197 m560_populate_input(hidpp, input, origin_is_hid_core);
2198 }
2199
2200 static int hidpp_input_configured(struct hid_device *hdev,
2201 struct hid_input *hidinput)
2202 {
2203 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2204 struct input_dev *input = hidinput->input;
2205
2206 hidpp_populate_input(hidpp, input, true);
2207
2208 return 0;
2209 }
2210
2211 static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
2212 int size)
2213 {
2214 struct hidpp_report *question = hidpp->send_receive_buf;
2215 struct hidpp_report *answer = hidpp->send_receive_buf;
2216 struct hidpp_report *report = (struct hidpp_report *)data;
2217 int ret;
2218
2219 /*
2220 * If the mutex is locked then we have a pending answer from a
2221 * previously sent command.
2222 */
2223 if (unlikely(mutex_is_locked(&hidpp->send_mutex))) {
2224 /*
2225 * Check for a correct hidpp20 answer or the corresponding
2226 * error
2227 */
2228 if (hidpp_match_answer(question, report) ||
2229 hidpp_match_error(question, report)) {
2230 *answer = *report;
2231 hidpp->answer_available = true;
2232 wake_up(&hidpp->wait);
2233 /*
2234 * This was an answer to a command that this driver sent
2235 * We return 1 to hid-core to avoid forwarding the
2236 * command upstream as it has been treated by the driver
2237 */
2238
2239 return 1;
2240 }
2241 }
2242
2243 if (unlikely(hidpp_report_is_connect_event(report))) {
2244 atomic_set(&hidpp->connected,
2245 !(report->rap.params[0] & (1 << 6)));
2246 if (schedule_work(&hidpp->work) == 0)
2247 dbg_hid("%s: connect event already queued\n", __func__);
2248 return 1;
2249 }
2250
2251 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
2252 ret = hidpp20_battery_event(hidpp, data, size);
2253 if (ret != 0)
2254 return ret;
2255 }
2256
2257 return 0;
2258 }
2259
2260 static int hidpp_raw_event(struct hid_device *hdev, struct hid_report *report,
2261 u8 *data, int size)
2262 {
2263 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2264 int ret = 0;
2265
2266 /* Generic HID++ processing. */
2267 switch (data[0]) {
2268 case REPORT_ID_HIDPP_VERY_LONG:
2269 if (size != HIDPP_REPORT_VERY_LONG_LENGTH) {
2270 hid_err(hdev, "received hid++ report of bad size (%d)",
2271 size);
2272 return 1;
2273 }
2274 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2275 break;
2276 case REPORT_ID_HIDPP_LONG:
2277 if (size != HIDPP_REPORT_LONG_LENGTH) {
2278 hid_err(hdev, "received hid++ report of bad size (%d)",
2279 size);
2280 return 1;
2281 }
2282 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2283 break;
2284 case REPORT_ID_HIDPP_SHORT:
2285 if (size != HIDPP_REPORT_SHORT_LENGTH) {
2286 hid_err(hdev, "received hid++ report of bad size (%d)",
2287 size);
2288 return 1;
2289 }
2290 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2291 break;
2292 }
2293
2294 /* If no report is available for further processing, skip calling
2295 * raw_event of subclasses. */
2296 if (ret != 0)
2297 return ret;
2298
2299 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2300 return wtp_raw_event(hdev, data, size);
2301 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
2302 return m560_raw_event(hdev, data, size);
2303
2304 return 0;
2305 }
2306
2307 static int hidpp_initialize_battery(struct hidpp_device *hidpp)
2308 {
2309 static atomic_t battery_no = ATOMIC_INIT(0);
2310 struct power_supply_config cfg = { .drv_data = hidpp };
2311 struct power_supply_desc *desc = &hidpp->battery.desc;
2312 struct hidpp_battery *battery;
2313 unsigned long n;
2314 int ret;
2315
2316 if (hidpp->battery.ps)
2317 return 0;
2318
2319 if (hidpp->protocol_major >= 2) {
2320 ret = hidpp20_query_battery_info(hidpp);
2321 if (ret)
2322 return ret;
2323 hidpp->capabilities |= HIDPP_CAPABILITY_HIDPP20_BATTERY;
2324 } else {
2325 return -ENOENT;
2326 }
2327
2328 battery = &hidpp->battery;
2329
2330 n = atomic_inc_return(&battery_no) - 1;
2331 desc->properties = hidpp_battery_props;
2332 desc->num_properties = ARRAY_SIZE(hidpp_battery_props);
2333 desc->get_property = hidpp_battery_get_property;
2334 sprintf(battery->name, "hidpp_battery_%ld", n);
2335 desc->name = battery->name;
2336 desc->type = POWER_SUPPLY_TYPE_BATTERY;
2337 desc->use_for_apm = 0;
2338
2339 battery->ps = devm_power_supply_register(&hidpp->hid_dev->dev,
2340 &battery->desc,
2341 &cfg);
2342 if (IS_ERR(battery->ps))
2343 return PTR_ERR(battery->ps);
2344
2345 power_supply_powers(battery->ps, &hidpp->hid_dev->dev);
2346
2347 return ret;
2348 }
2349
2350 static void hidpp_overwrite_name(struct hid_device *hdev)
2351 {
2352 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2353 char *name;
2354
2355 if (hidpp->protocol_major < 2)
2356 return;
2357
2358 name = hidpp_get_device_name(hidpp);
2359
2360 if (!name) {
2361 hid_err(hdev, "unable to retrieve the name of the device");
2362 } else {
2363 dbg_hid("HID++: Got name: %s\n", name);
2364 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
2365 }
2366
2367 kfree(name);
2368 }
2369
2370 static int hidpp_input_open(struct input_dev *dev)
2371 {
2372 struct hid_device *hid = input_get_drvdata(dev);
2373
2374 return hid_hw_open(hid);
2375 }
2376
2377 static void hidpp_input_close(struct input_dev *dev)
2378 {
2379 struct hid_device *hid = input_get_drvdata(dev);
2380
2381 hid_hw_close(hid);
2382 }
2383
2384 static struct input_dev *hidpp_allocate_input(struct hid_device *hdev)
2385 {
2386 struct input_dev *input_dev = devm_input_allocate_device(&hdev->dev);
2387 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2388
2389 if (!input_dev)
2390 return NULL;
2391
2392 input_set_drvdata(input_dev, hdev);
2393 input_dev->open = hidpp_input_open;
2394 input_dev->close = hidpp_input_close;
2395
2396 input_dev->name = hidpp->name;
2397 input_dev->phys = hdev->phys;
2398 input_dev->uniq = hdev->uniq;
2399 input_dev->id.bustype = hdev->bus;
2400 input_dev->id.vendor = hdev->vendor;
2401 input_dev->id.product = hdev->product;
2402 input_dev->id.version = hdev->version;
2403 input_dev->dev.parent = &hdev->dev;
2404
2405 return input_dev;
2406 }
2407
2408 static void hidpp_connect_event(struct hidpp_device *hidpp)
2409 {
2410 struct hid_device *hdev = hidpp->hid_dev;
2411 int ret = 0;
2412 bool connected = atomic_read(&hidpp->connected);
2413 struct input_dev *input;
2414 char *name, *devm_name;
2415
2416 if (!connected)
2417 return;
2418
2419 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
2420 ret = wtp_connect(hdev, connected);
2421 if (ret)
2422 return;
2423 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560) {
2424 ret = m560_send_config_command(hdev, connected);
2425 if (ret)
2426 return;
2427 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
2428 ret = k400_connect(hdev, connected);
2429 if (ret)
2430 return;
2431 }
2432
2433 /* the device is already connected, we can ask for its name and
2434 * protocol */
2435 if (!hidpp->protocol_major) {
2436 ret = !hidpp_is_connected(hidpp);
2437 if (ret) {
2438 hid_err(hdev, "Can not get the protocol version.\n");
2439 return;
2440 }
2441 hid_info(hdev, "HID++ %u.%u device connected.\n",
2442 hidpp->protocol_major, hidpp->protocol_minor);
2443 }
2444
2445 if (hidpp->name == hdev->name && hidpp->protocol_major >= 2) {
2446 name = hidpp_get_device_name(hidpp);
2447 if (!name) {
2448 hid_err(hdev,
2449 "unable to retrieve the name of the device");
2450 return;
2451 }
2452
2453 devm_name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s", name);
2454 kfree(name);
2455 if (!devm_name)
2456 return;
2457
2458 hidpp->name = devm_name;
2459 }
2460
2461 hidpp_initialize_battery(hidpp);
2462
2463 if (!(hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT) || hidpp->delayed_input)
2464 /* if the input nodes are already created, we can stop now */
2465 return;
2466
2467 input = hidpp_allocate_input(hdev);
2468 if (!input) {
2469 hid_err(hdev, "cannot allocate new input device: %d\n", ret);
2470 return;
2471 }
2472
2473 hidpp_populate_input(hidpp, input, false);
2474
2475 ret = input_register_device(input);
2476 if (ret)
2477 input_free_device(input);
2478
2479 hidpp->delayed_input = input;
2480 }
2481
2482 static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
2483 {
2484 struct hidpp_device *hidpp;
2485 int ret;
2486 bool connected;
2487 unsigned int connect_mask = HID_CONNECT_DEFAULT;
2488
2489 hidpp = devm_kzalloc(&hdev->dev, sizeof(struct hidpp_device),
2490 GFP_KERNEL);
2491 if (!hidpp)
2492 return -ENOMEM;
2493
2494 hidpp->hid_dev = hdev;
2495 hidpp->name = hdev->name;
2496 hid_set_drvdata(hdev, hidpp);
2497
2498 hidpp->quirks = id->driver_data;
2499
2500 if (id->group == HID_GROUP_LOGITECH_DJ_DEVICE)
2501 hidpp->quirks |= HIDPP_QUIRK_UNIFYING;
2502
2503 if (disable_raw_mode) {
2504 hidpp->quirks &= ~HIDPP_QUIRK_CLASS_WTP;
2505 hidpp->quirks &= ~HIDPP_QUIRK_NO_HIDINPUT;
2506 }
2507
2508 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
2509 ret = wtp_allocate(hdev, id);
2510 if (ret)
2511 goto allocate_fail;
2512 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560) {
2513 ret = m560_allocate(hdev);
2514 if (ret)
2515 goto allocate_fail;
2516 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
2517 ret = k400_allocate(hdev);
2518 if (ret)
2519 goto allocate_fail;
2520 }
2521
2522 INIT_WORK(&hidpp->work, delayed_work_cb);
2523 mutex_init(&hidpp->send_mutex);
2524 init_waitqueue_head(&hidpp->wait);
2525
2526 ret = hid_parse(hdev);
2527 if (ret) {
2528 hid_err(hdev, "%s:parse failed\n", __func__);
2529 goto hid_parse_fail;
2530 }
2531
2532 if (hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT)
2533 connect_mask &= ~HID_CONNECT_HIDINPUT;
2534
2535 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
2536 ret = hid_hw_start(hdev, connect_mask);
2537 if (ret) {
2538 hid_err(hdev, "hw start failed\n");
2539 goto hid_hw_start_fail;
2540 }
2541 ret = hid_hw_open(hdev);
2542 if (ret < 0) {
2543 dev_err(&hdev->dev, "%s:hid_hw_open returned error:%d\n",
2544 __func__, ret);
2545 hid_hw_stop(hdev);
2546 goto hid_hw_start_fail;
2547 }
2548 }
2549
2550
2551 /* Allow incoming packets */
2552 hid_device_io_start(hdev);
2553
2554 if (hidpp->quirks & HIDPP_QUIRK_UNIFYING)
2555 hidpp_unifying_init(hidpp);
2556
2557 connected = hidpp_is_connected(hidpp);
2558 atomic_set(&hidpp->connected, connected);
2559 if (!(hidpp->quirks & HIDPP_QUIRK_UNIFYING)) {
2560 if (!connected) {
2561 ret = -ENODEV;
2562 hid_err(hdev, "Device not connected");
2563 goto hid_hw_open_failed;
2564 }
2565
2566 hid_info(hdev, "HID++ %u.%u device connected.\n",
2567 hidpp->protocol_major, hidpp->protocol_minor);
2568
2569 hidpp_overwrite_name(hdev);
2570 }
2571
2572 if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)) {
2573 ret = wtp_get_config(hidpp);
2574 if (ret)
2575 goto hid_hw_open_failed;
2576 } else if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_G920)) {
2577 ret = g920_get_config(hidpp);
2578 if (ret)
2579 goto hid_hw_open_failed;
2580 }
2581
2582 /* Block incoming packets */
2583 hid_device_io_stop(hdev);
2584
2585 if (!(hidpp->quirks & HIDPP_QUIRK_CLASS_G920)) {
2586 ret = hid_hw_start(hdev, connect_mask);
2587 if (ret) {
2588 hid_err(hdev, "%s:hid_hw_start returned error\n", __func__);
2589 goto hid_hw_start_fail;
2590 }
2591 }
2592
2593 /* Allow incoming packets */
2594 hid_device_io_start(hdev);
2595
2596 hidpp_connect_event(hidpp);
2597
2598 return ret;
2599
2600 hid_hw_open_failed:
2601 hid_device_io_stop(hdev);
2602 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
2603 hid_hw_close(hdev);
2604 hid_hw_stop(hdev);
2605 }
2606 hid_hw_start_fail:
2607 hid_parse_fail:
2608 cancel_work_sync(&hidpp->work);
2609 mutex_destroy(&hidpp->send_mutex);
2610 allocate_fail:
2611 hid_set_drvdata(hdev, NULL);
2612 return ret;
2613 }
2614
2615 static void hidpp_remove(struct hid_device *hdev)
2616 {
2617 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2618
2619 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
2620 hidpp_ff_deinit(hdev);
2621 hid_hw_close(hdev);
2622 }
2623 hid_hw_stop(hdev);
2624 cancel_work_sync(&hidpp->work);
2625 mutex_destroy(&hidpp->send_mutex);
2626 }
2627
2628 static const struct hid_device_id hidpp_devices[] = {
2629 { /* wireless touchpad */
2630 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
2631 USB_VENDOR_ID_LOGITECH, 0x4011),
2632 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT |
2633 HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS },
2634 { /* wireless touchpad T650 */
2635 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
2636 USB_VENDOR_ID_LOGITECH, 0x4101),
2637 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT },
2638 { /* wireless touchpad T651 */
2639 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
2640 USB_DEVICE_ID_LOGITECH_T651),
2641 .driver_data = HIDPP_QUIRK_CLASS_WTP },
2642 { /* Mouse logitech M560 */
2643 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
2644 USB_VENDOR_ID_LOGITECH, 0x402d),
2645 .driver_data = HIDPP_QUIRK_DELAYED_INIT | HIDPP_QUIRK_CLASS_M560 },
2646 { /* Keyboard logitech K400 */
2647 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
2648 USB_VENDOR_ID_LOGITECH, 0x4024),
2649 .driver_data = HIDPP_QUIRK_CLASS_K400 },
2650
2651 { HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
2652 USB_VENDOR_ID_LOGITECH, HID_ANY_ID)},
2653
2654 { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G920_WHEEL),
2655 .driver_data = HIDPP_QUIRK_CLASS_G920 | HIDPP_QUIRK_FORCE_OUTPUT_REPORTS},
2656 {}
2657 };
2658
2659 MODULE_DEVICE_TABLE(hid, hidpp_devices);
2660
2661 static struct hid_driver hidpp_driver = {
2662 .name = "logitech-hidpp-device",
2663 .id_table = hidpp_devices,
2664 .probe = hidpp_probe,
2665 .remove = hidpp_remove,
2666 .raw_event = hidpp_raw_event,
2667 .input_configured = hidpp_input_configured,
2668 .input_mapping = hidpp_input_mapping,
2669 .input_mapped = hidpp_input_mapped,
2670 };
2671
2672 module_hid_driver(hidpp_driver);
Ubuntu Artful kernel mirror