?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 5.1.15
[linux/fpc-iii.git] / drivers / hid / hid-logitech-hidpp.c
blobe74fa990ba13377542b8f51e46e27d82be690b33
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/sched/clock.h>
25 #include <linux/kfifo.h>
26 #include <linux/input/mt.h>
27 #include <linux/workqueue.h>
28 #include <linux/atomic.h>
29 #include <linux/fixp-arith.h>
30 #include <asm/unaligned.h>
31 #include "usbhid/usbhid.h"
32 #include "hid-ids.h"
33
34 MODULE_LICENSE("GPL");
35 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
36 MODULE_AUTHOR("Nestor Lopez Casado <nlopezcasad@logitech.com>");
37
38 static bool disable_raw_mode;
39 module_param(disable_raw_mode, bool, 0644);
40 MODULE_PARM_DESC(disable_raw_mode,
41 "Disable Raw mode reporting for touchpads and keep firmware gestures.");
42
43 static bool disable_tap_to_click;
44 module_param(disable_tap_to_click, bool, 0644);
45 MODULE_PARM_DESC(disable_tap_to_click,
46 "Disable Tap-To-Click mode reporting for touchpads (only on the K400 currently).");
47
48 #define REPORT_ID_HIDPP_SHORT 0x10
49 #define REPORT_ID_HIDPP_LONG 0x11
50 #define REPORT_ID_HIDPP_VERY_LONG 0x12
51
52 #define HIDPP_REPORT_SHORT_LENGTH 7
53 #define HIDPP_REPORT_LONG_LENGTH 20
54 #define HIDPP_REPORT_VERY_LONG_LENGTH 64
55
56 #define HIDPP_QUIRK_CLASS_WTP BIT(0)
57 #define HIDPP_QUIRK_CLASS_M560 BIT(1)
58 #define HIDPP_QUIRK_CLASS_K400 BIT(2)
59 #define HIDPP_QUIRK_CLASS_G920 BIT(3)
60 #define HIDPP_QUIRK_CLASS_K750 BIT(4)
61
62 /* bits 2..20 are reserved for classes */
63 /* #define HIDPP_QUIRK_CONNECT_EVENTS BIT(21) disabled */
64 #define HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS BIT(22)
65 #define HIDPP_QUIRK_NO_HIDINPUT BIT(23)
66 #define HIDPP_QUIRK_FORCE_OUTPUT_REPORTS BIT(24)
67 #define HIDPP_QUIRK_UNIFYING BIT(25)
68 #define HIDPP_QUIRK_HI_RES_SCROLL_1P0 BIT(26)
69 #define HIDPP_QUIRK_HI_RES_SCROLL_X2120 BIT(27)
70 #define HIDPP_QUIRK_HI_RES_SCROLL_X2121 BIT(28)
71
72 /* Convenience constant to check for any high-res support. */
73 #define HIDPP_QUIRK_HI_RES_SCROLL (HIDPP_QUIRK_HI_RES_SCROLL_1P0 | \
74 HIDPP_QUIRK_HI_RES_SCROLL_X2120 | \
75 HIDPP_QUIRK_HI_RES_SCROLL_X2121)
76
77 #define HIDPP_QUIRK_DELAYED_INIT HIDPP_QUIRK_NO_HIDINPUT
78
79 #define HIDPP_CAPABILITY_HIDPP10_BATTERY BIT(0)
80 #define HIDPP_CAPABILITY_HIDPP20_BATTERY BIT(1)
81 #define HIDPP_CAPABILITY_BATTERY_MILEAGE BIT(2)
82 #define HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS BIT(3)
83
84 /*
85 * There are two hidpp protocols in use, the first version hidpp10 is known
86 * as register access protocol or RAP, the second version hidpp20 is known as
87 * feature access protocol or FAP
88 *
89 * Most older devices (including the Unifying usb receiver) use the RAP protocol
90 * where as most newer devices use the FAP protocol. Both protocols are
91 * compatible with the underlying transport, which could be usb, Unifiying, or
92 * bluetooth. The message lengths are defined by the hid vendor specific report
93 * descriptor for the HIDPP_SHORT report type (total message lenth 7 bytes) and
94 * the HIDPP_LONG report type (total message length 20 bytes)
95 *
96 * The RAP protocol uses both report types, whereas the FAP only uses HIDPP_LONG
97 * messages. The Unifying receiver itself responds to RAP messages (device index
98 * is 0xFF for the receiver), and all messages (short or long) with a device
99 * index between 1 and 6 are passed untouched to the corresponding paired
100 * Unifying device.
101 *
102 * The paired device can be RAP or FAP, it will receive the message untouched
103 * from the Unifiying receiver.
104 */
105
106 struct fap {
107 u8 feature_index;
108 u8 funcindex_clientid;
109 u8 params[HIDPP_REPORT_VERY_LONG_LENGTH - 4U];
110 };
111
112 struct rap {
113 u8 sub_id;
114 u8 reg_address;
115 u8 params[HIDPP_REPORT_VERY_LONG_LENGTH - 4U];
116 };
117
118 struct hidpp_report {
119 u8 report_id;
120 u8 device_index;
121 union {
122 struct fap fap;
123 struct rap rap;
124 u8 rawbytes[sizeof(struct fap)];
125 };
126 } __packed;
127
128 struct hidpp_battery {
129 u8 feature_index;
130 u8 solar_feature_index;
131 struct power_supply_desc desc;
132 struct power_supply *ps;
133 char name[64];
134 int status;
135 int capacity;
136 int level;
137 bool online;
138 };
139
140 /**
141 * struct hidpp_scroll_counter - Utility class for processing high-resolution
142 * scroll events.
143 * @dev: the input device for which events should be reported.
144 * @wheel_multiplier: the scalar multiplier to be applied to each wheel event
145 * @remainder: counts the number of high-resolution units moved since the last
146 * low-resolution event (REL_WHEEL or REL_HWHEEL) was sent. Should
147 * only be used by class methods.
148 * @direction: direction of last movement (1 or -1)
149 * @last_time: last event time, used to reset remainder after inactivity
150 */
151 struct hidpp_scroll_counter {
152 struct input_dev *dev;
153 int wheel_multiplier;
154 int remainder;
155 int direction;
156 unsigned long long last_time;
157 };
158
159 struct hidpp_device {
160 struct hid_device *hid_dev;
161 struct mutex send_mutex;
162 void *send_receive_buf;
163 char *name; /* will never be NULL and should not be freed */
164 wait_queue_head_t wait;
165 bool answer_available;
166 u8 protocol_major;
167 u8 protocol_minor;
168
169 void *private_data;
170
171 struct work_struct work;
172 struct kfifo delayed_work_fifo;
173 atomic_t connected;
174 struct input_dev *delayed_input;
175
176 unsigned long quirks;
177 unsigned long capabilities;
178
179 struct hidpp_battery battery;
180 struct hidpp_scroll_counter vertical_wheel_counter;
181 };
182
183 /* HID++ 1.0 error codes */
184 #define HIDPP_ERROR 0x8f
185 #define HIDPP_ERROR_SUCCESS 0x00
186 #define HIDPP_ERROR_INVALID_SUBID 0x01
187 #define HIDPP_ERROR_INVALID_ADRESS 0x02
188 #define HIDPP_ERROR_INVALID_VALUE 0x03
189 #define HIDPP_ERROR_CONNECT_FAIL 0x04
190 #define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
191 #define HIDPP_ERROR_ALREADY_EXISTS 0x06
192 #define HIDPP_ERROR_BUSY 0x07
193 #define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
194 #define HIDPP_ERROR_RESOURCE_ERROR 0x09
195 #define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
196 #define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
197 #define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
198 /* HID++ 2.0 error codes */
199 #define HIDPP20_ERROR 0xff
200
201 static void hidpp_connect_event(struct hidpp_device *hidpp_dev);
202
203 static int __hidpp_send_report(struct hid_device *hdev,
204 struct hidpp_report *hidpp_report)
205 {
206 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
207 int fields_count, ret;
208
209 hidpp = hid_get_drvdata(hdev);
210
211 switch (hidpp_report->report_id) {
212 case REPORT_ID_HIDPP_SHORT:
213 fields_count = HIDPP_REPORT_SHORT_LENGTH;
214 break;
215 case REPORT_ID_HIDPP_LONG:
216 fields_count = HIDPP_REPORT_LONG_LENGTH;
217 break;
218 case REPORT_ID_HIDPP_VERY_LONG:
219 fields_count = HIDPP_REPORT_VERY_LONG_LENGTH;
220 break;
221 default:
222 return -ENODEV;
223 }
224
225 /*
226 * set the device_index as the receiver, it will be overwritten by
227 * hid_hw_request if needed
228 */
229 hidpp_report->device_index = 0xff;
230
231 if (hidpp->quirks & HIDPP_QUIRK_FORCE_OUTPUT_REPORTS) {
232 ret = hid_hw_output_report(hdev, (u8 *)hidpp_report, fields_count);
233 } else {
234 ret = hid_hw_raw_request(hdev, hidpp_report->report_id,
235 (u8 *)hidpp_report, fields_count, HID_OUTPUT_REPORT,
236 HID_REQ_SET_REPORT);
237 }
238
239 return ret == fields_count ? 0 : -1;
240 }
241
242 /**
243 * hidpp_send_message_sync() returns 0 in case of success, and something else
244 * in case of a failure.
245 * - If ' something else' is positive, that means that an error has been raised
246 * by the protocol itself.
247 * - If ' something else' is negative, that means that we had a classic error
248 * (-ENOMEM, -EPIPE, etc...)
249 */
250 static int hidpp_send_message_sync(struct hidpp_device *hidpp,
251 struct hidpp_report *message,
252 struct hidpp_report *response)
253 {
254 int ret;
255
256 mutex_lock(&hidpp->send_mutex);
257
258 hidpp->send_receive_buf = response;
259 hidpp->answer_available = false;
260
261 /*
262 * So that we can later validate the answer when it arrives
263 * in hidpp_raw_event
264 */
265 *response = *message;
266
267 ret = __hidpp_send_report(hidpp->hid_dev, message);
268
269 if (ret) {
270 dbg_hid("__hidpp_send_report returned err: %d\n", ret);
271 memset(response, 0, sizeof(struct hidpp_report));
272 goto exit;
273 }
274
275 if (!wait_event_timeout(hidpp->wait, hidpp->answer_available,
276 5*HZ)) {
277 dbg_hid("%s:timeout waiting for response\n", __func__);
278 memset(response, 0, sizeof(struct hidpp_report));
279 ret = -ETIMEDOUT;
280 }
281
282 if (response->report_id == REPORT_ID_HIDPP_SHORT &&
283 response->rap.sub_id == HIDPP_ERROR) {
284 ret = response->rap.params[1];
285 dbg_hid("%s:got hidpp error %02X\n", __func__, ret);
286 goto exit;
287 }
288
289 if ((response->report_id == REPORT_ID_HIDPP_LONG ||
290 response->report_id == REPORT_ID_HIDPP_VERY_LONG) &&
291 response->fap.feature_index == HIDPP20_ERROR) {
292 ret = response->fap.params[1];
293 dbg_hid("%s:got hidpp 2.0 error %02X\n", __func__, ret);
294 goto exit;
295 }
296
297 exit:
298 mutex_unlock(&hidpp->send_mutex);
299 return ret;
300
301 }
302
303 static int hidpp_send_fap_command_sync(struct hidpp_device *hidpp,
304 u8 feat_index, u8 funcindex_clientid, u8 *params, int param_count,
305 struct hidpp_report *response)
306 {
307 struct hidpp_report *message;
308 int ret;
309
310 if (param_count > sizeof(message->fap.params))
311 return -EINVAL;
312
313 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
314 if (!message)
315 return -ENOMEM;
316
317 if (param_count > (HIDPP_REPORT_LONG_LENGTH - 4))
318 message->report_id = REPORT_ID_HIDPP_VERY_LONG;
319 else
320 message->report_id = REPORT_ID_HIDPP_LONG;
321 message->fap.feature_index = feat_index;
322 message->fap.funcindex_clientid = funcindex_clientid;
323 memcpy(&message->fap.params, params, param_count);
324
325 ret = hidpp_send_message_sync(hidpp, message, response);
326 kfree(message);
327 return ret;
328 }
329
330 static int hidpp_send_rap_command_sync(struct hidpp_device *hidpp_dev,
331 u8 report_id, u8 sub_id, u8 reg_address, u8 *params, int param_count,
332 struct hidpp_report *response)
333 {
334 struct hidpp_report *message;
335 int ret, max_count;
336
337 switch (report_id) {
338 case REPORT_ID_HIDPP_SHORT:
339 max_count = HIDPP_REPORT_SHORT_LENGTH - 4;
340 break;
341 case REPORT_ID_HIDPP_LONG:
342 max_count = HIDPP_REPORT_LONG_LENGTH - 4;
343 break;
344 case REPORT_ID_HIDPP_VERY_LONG:
345 max_count = HIDPP_REPORT_VERY_LONG_LENGTH - 4;
346 break;
347 default:
348 return -EINVAL;
349 }
350
351 if (param_count > max_count)
352 return -EINVAL;
353
354 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
355 if (!message)
356 return -ENOMEM;
357 message->report_id = report_id;
358 message->rap.sub_id = sub_id;
359 message->rap.reg_address = reg_address;
360 memcpy(&message->rap.params, params, param_count);
361
362 ret = hidpp_send_message_sync(hidpp_dev, message, response);
363 kfree(message);
364 return ret;
365 }
366
367 static void delayed_work_cb(struct work_struct *work)
368 {
369 struct hidpp_device *hidpp = container_of(work, struct hidpp_device,
370 work);
371 hidpp_connect_event(hidpp);
372 }
373
374 static inline bool hidpp_match_answer(struct hidpp_report *question,
375 struct hidpp_report *answer)
376 {
377 return (answer->fap.feature_index == question->fap.feature_index) &&
378 (answer->fap.funcindex_clientid == question->fap.funcindex_clientid);
379 }
380
381 static inline bool hidpp_match_error(struct hidpp_report *question,
382 struct hidpp_report *answer)
383 {
384 return ((answer->rap.sub_id == HIDPP_ERROR) ||
385 (answer->fap.feature_index == HIDPP20_ERROR)) &&
386 (answer->fap.funcindex_clientid == question->fap.feature_index) &&
387 (answer->fap.params[0] == question->fap.funcindex_clientid);
388 }
389
390 static inline bool hidpp_report_is_connect_event(struct hidpp_report *report)
391 {
392 return (report->report_id == REPORT_ID_HIDPP_SHORT) &&
393 (report->rap.sub_id == 0x41);
394 }
395
396 /**
397 * hidpp_prefix_name() prefixes the current given name with "Logitech ".
398 */
399 static void hidpp_prefix_name(char **name, int name_length)
400 {
401 #define PREFIX_LENGTH 9 /* "Logitech " */
402
403 int new_length;
404 char *new_name;
405
406 if (name_length > PREFIX_LENGTH &&
407 strncmp(*name, "Logitech ", PREFIX_LENGTH) == 0)
408 /* The prefix has is already in the name */
409 return;
410
411 new_length = PREFIX_LENGTH + name_length;
412 new_name = kzalloc(new_length, GFP_KERNEL);
413 if (!new_name)
414 return;
415
416 snprintf(new_name, new_length, "Logitech %s", *name);
417
418 kfree(*name);
419
420 *name = new_name;
421 }
422
423 /**
424 * hidpp_scroll_counter_handle_scroll() - Send high- and low-resolution scroll
425 * events given a high-resolution wheel
426 * movement.
427 * @counter: a hid_scroll_counter struct describing the wheel.
428 * @hi_res_value: the movement of the wheel, in the mouse's high-resolution
429 * units.
430 *
431 * Given a high-resolution movement, this function converts the movement into
432 * fractions of 120 and emits high-resolution scroll events for the input
433 * device. It also uses the multiplier from &struct hid_scroll_counter to
434 * emit low-resolution scroll events when appropriate for
435 * backwards-compatibility with userspace input libraries.
436 */
437 static void hidpp_scroll_counter_handle_scroll(struct hidpp_scroll_counter *counter,
438 int hi_res_value)
439 {
440 int low_res_value, remainder, direction;
441 unsigned long long now, previous;
442
443 hi_res_value = hi_res_value * 120/counter->wheel_multiplier;
444 input_report_rel(counter->dev, REL_WHEEL_HI_RES, hi_res_value);
445
446 remainder = counter->remainder;
447 direction = hi_res_value > 0 ? 1 : -1;
448
449 now = sched_clock();
450 previous = counter->last_time;
451 counter->last_time = now;
452 /*
453 * Reset the remainder after a period of inactivity or when the
454 * direction changes. This prevents the REL_WHEEL emulation point
455 * from sliding for devices that don't always provide the same
456 * number of movements per detent.
457 */
458 if (now - previous > 1000000000 || direction != counter->direction)
459 remainder = 0;
460
461 counter->direction = direction;
462 remainder += hi_res_value;
463
464 /* Some wheels will rest 7/8ths of a detent from the previous detent
465 * after slow movement, so we want the threshold for low-res events to
466 * be in the middle between two detents (e.g. after 4/8ths) as
467 * opposed to on the detents themselves (8/8ths).
468 */
469 if (abs(remainder) >= 60) {
470 /* Add (or subtract) 1 because we want to trigger when the wheel
471 * is half-way to the next detent (i.e. scroll 1 detent after a
472 * 1/2 detent movement, 2 detents after a 1 1/2 detent movement,
473 * etc.).
474 */
475 low_res_value = remainder / 120;
476 if (low_res_value == 0)
477 low_res_value = (hi_res_value > 0 ? 1 : -1);
478 input_report_rel(counter->dev, REL_WHEEL, low_res_value);
479 remainder -= low_res_value * 120;
480 }
481 counter->remainder = remainder;
482 }
483
484 /* -------------------------------------------------------------------------- */
485 /* HIDP++ 1.0 commands */
486 /* -------------------------------------------------------------------------- */
487
488 #define HIDPP_SET_REGISTER 0x80
489 #define HIDPP_GET_REGISTER 0x81
490 #define HIDPP_SET_LONG_REGISTER 0x82
491 #define HIDPP_GET_LONG_REGISTER 0x83
492
493 /**
494 * hidpp10_set_register_bit() - Sets a single bit in a HID++ 1.0 register.
495 * @hidpp_dev: the device to set the register on.
496 * @register_address: the address of the register to modify.
497 * @byte: the byte of the register to modify. Should be less than 3.
498 * Return: 0 if successful, otherwise a negative error code.
499 */
500 static int hidpp10_set_register_bit(struct hidpp_device *hidpp_dev,
501 u8 register_address, u8 byte, u8 bit)
502 {
503 struct hidpp_report response;
504 int ret;
505 u8 params[3] = { 0 };
506
507 ret = hidpp_send_rap_command_sync(hidpp_dev,
508 REPORT_ID_HIDPP_SHORT,
509 HIDPP_GET_REGISTER,
510 register_address,
511 NULL, 0, &response);
512 if (ret)
513 return ret;
514
515 memcpy(params, response.rap.params, 3);
516
517 params[byte] |= BIT(bit);
518
519 return hidpp_send_rap_command_sync(hidpp_dev,
520 REPORT_ID_HIDPP_SHORT,
521 HIDPP_SET_REGISTER,
522 register_address,
523 params, 3, &response);
524 }
525
526
527 #define HIDPP_REG_GENERAL 0x00
528
529 static int hidpp10_enable_battery_reporting(struct hidpp_device *hidpp_dev)
530 {
531 return hidpp10_set_register_bit(hidpp_dev, HIDPP_REG_GENERAL, 0, 4);
532 }
533
534 #define HIDPP_REG_FEATURES 0x01
535
536 /* On HID++ 1.0 devices, high-res scroll was called "scrolling acceleration". */
537 static int hidpp10_enable_scrolling_acceleration(struct hidpp_device *hidpp_dev)
538 {
539 return hidpp10_set_register_bit(hidpp_dev, HIDPP_REG_FEATURES, 0, 6);
540 }
541
542 #define HIDPP_REG_BATTERY_STATUS 0x07
543
544 static int hidpp10_battery_status_map_level(u8 param)
545 {
546 int level;
547
548 switch (param) {
549 case 1 ... 2:
550 level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
551 break;
552 case 3 ... 4:
553 level = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
554 break;
555 case 5 ... 6:
556 level = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
557 break;
558 case 7:
559 level = POWER_SUPPLY_CAPACITY_LEVEL_HIGH;
560 break;
561 default:
562 level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
563 }
564
565 return level;
566 }
567
568 static int hidpp10_battery_status_map_status(u8 param)
569 {
570 int status;
571
572 switch (param) {
573 case 0x00:
574 /* discharging (in use) */
575 status = POWER_SUPPLY_STATUS_DISCHARGING;
576 break;
577 case 0x21: /* (standard) charging */
578 case 0x24: /* fast charging */
579 case 0x25: /* slow charging */
580 status = POWER_SUPPLY_STATUS_CHARGING;
581 break;
582 case 0x26: /* topping charge */
583 case 0x22: /* charge complete */
584 status = POWER_SUPPLY_STATUS_FULL;
585 break;
586 case 0x20: /* unknown */
587 status = POWER_SUPPLY_STATUS_UNKNOWN;
588 break;
589 /*
590 * 0x01...0x1F = reserved (not charging)
591 * 0x23 = charging error
592 * 0x27..0xff = reserved
593 */
594 default:
595 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
596 break;
597 }
598
599 return status;
600 }
601
602 static int hidpp10_query_battery_status(struct hidpp_device *hidpp)
603 {
604 struct hidpp_report response;
605 int ret, status;
606
607 ret = hidpp_send_rap_command_sync(hidpp,
608 REPORT_ID_HIDPP_SHORT,
609 HIDPP_GET_REGISTER,
610 HIDPP_REG_BATTERY_STATUS,
611 NULL, 0, &response);
612 if (ret)
613 return ret;
614
615 hidpp->battery.level =
616 hidpp10_battery_status_map_level(response.rap.params[0]);
617 status = hidpp10_battery_status_map_status(response.rap.params[1]);
618 hidpp->battery.status = status;
619 /* the capacity is only available when discharging or full */
620 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
621 status == POWER_SUPPLY_STATUS_FULL;
622
623 return 0;
624 }
625
626 #define HIDPP_REG_BATTERY_MILEAGE 0x0D
627
628 static int hidpp10_battery_mileage_map_status(u8 param)
629 {
630 int status;
631
632 switch (param >> 6) {
633 case 0x00:
634 /* discharging (in use) */
635 status = POWER_SUPPLY_STATUS_DISCHARGING;
636 break;
637 case 0x01: /* charging */
638 status = POWER_SUPPLY_STATUS_CHARGING;
639 break;
640 case 0x02: /* charge complete */
641 status = POWER_SUPPLY_STATUS_FULL;
642 break;
643 /*
644 * 0x03 = charging error
645 */
646 default:
647 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
648 break;
649 }
650
651 return status;
652 }
653
654 static int hidpp10_query_battery_mileage(struct hidpp_device *hidpp)
655 {
656 struct hidpp_report response;
657 int ret, status;
658
659 ret = hidpp_send_rap_command_sync(hidpp,
660 REPORT_ID_HIDPP_SHORT,
661 HIDPP_GET_REGISTER,
662 HIDPP_REG_BATTERY_MILEAGE,
663 NULL, 0, &response);
664 if (ret)
665 return ret;
666
667 hidpp->battery.capacity = response.rap.params[0];
668 status = hidpp10_battery_mileage_map_status(response.rap.params[2]);
669 hidpp->battery.status = status;
670 /* the capacity is only available when discharging or full */
671 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
672 status == POWER_SUPPLY_STATUS_FULL;
673
674 return 0;
675 }
676
677 static int hidpp10_battery_event(struct hidpp_device *hidpp, u8 *data, int size)
678 {
679 struct hidpp_report *report = (struct hidpp_report *)data;
680 int status, capacity, level;
681 bool changed;
682
683 if (report->report_id != REPORT_ID_HIDPP_SHORT)
684 return 0;
685
686 switch (report->rap.sub_id) {
687 case HIDPP_REG_BATTERY_STATUS:
688 capacity = hidpp->battery.capacity;
689 level = hidpp10_battery_status_map_level(report->rawbytes[1]);
690 status = hidpp10_battery_status_map_status(report->rawbytes[2]);
691 break;
692 case HIDPP_REG_BATTERY_MILEAGE:
693 capacity = report->rap.params[0];
694 level = hidpp->battery.level;
695 status = hidpp10_battery_mileage_map_status(report->rawbytes[3]);
696 break;
697 default:
698 return 0;
699 }
700
701 changed = capacity != hidpp->battery.capacity ||
702 level != hidpp->battery.level ||
703 status != hidpp->battery.status;
704
705 /* the capacity is only available when discharging or full */
706 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
707 status == POWER_SUPPLY_STATUS_FULL;
708
709 if (changed) {
710 hidpp->battery.level = level;
711 hidpp->battery.status = status;
712 if (hidpp->battery.ps)
713 power_supply_changed(hidpp->battery.ps);
714 }
715
716 return 0;
717 }
718
719 #define HIDPP_REG_PAIRING_INFORMATION 0xB5
720 #define HIDPP_EXTENDED_PAIRING 0x30
721 #define HIDPP_DEVICE_NAME 0x40
722
723 static char *hidpp_unifying_get_name(struct hidpp_device *hidpp_dev)
724 {
725 struct hidpp_report response;
726 int ret;
727 u8 params[1] = { HIDPP_DEVICE_NAME };
728 char *name;
729 int len;
730
731 ret = hidpp_send_rap_command_sync(hidpp_dev,
732 REPORT_ID_HIDPP_SHORT,
733 HIDPP_GET_LONG_REGISTER,
734 HIDPP_REG_PAIRING_INFORMATION,
735 params, 1, &response);
736 if (ret)
737 return NULL;
738
739 len = response.rap.params[1];
740
741 if (2 + len > sizeof(response.rap.params))
742 return NULL;
743
744 name = kzalloc(len + 1, GFP_KERNEL);
745 if (!name)
746 return NULL;
747
748 memcpy(name, &response.rap.params[2], len);
749
750 /* include the terminating '\0' */
751 hidpp_prefix_name(&name, len + 1);
752
753 return name;
754 }
755
756 static int hidpp_unifying_get_serial(struct hidpp_device *hidpp, u32 *serial)
757 {
758 struct hidpp_report response;
759 int ret;
760 u8 params[1] = { HIDPP_EXTENDED_PAIRING };
761
762 ret = hidpp_send_rap_command_sync(hidpp,
763 REPORT_ID_HIDPP_SHORT,
764 HIDPP_GET_LONG_REGISTER,
765 HIDPP_REG_PAIRING_INFORMATION,
766 params, 1, &response);
767 if (ret)
768 return ret;
769
770 /*
771 * We don't care about LE or BE, we will output it as a string
772 * with %4phD, so we need to keep the order.
773 */
774 *serial = *((u32 *)&response.rap.params[1]);
775 return 0;
776 }
777
778 static int hidpp_unifying_init(struct hidpp_device *hidpp)
779 {
780 struct hid_device *hdev = hidpp->hid_dev;
781 const char *name;
782 u32 serial;
783 int ret;
784
785 ret = hidpp_unifying_get_serial(hidpp, &serial);
786 if (ret)
787 return ret;
788
789 snprintf(hdev->uniq, sizeof(hdev->uniq), "%04x-%4phD",
790 hdev->product, &serial);
791 dbg_hid("HID++ Unifying: Got serial: %s\n", hdev->uniq);
792
793 name = hidpp_unifying_get_name(hidpp);
794 if (!name)
795 return -EIO;
796
797 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
798 dbg_hid("HID++ Unifying: Got name: %s\n", name);
799
800 kfree(name);
801 return 0;
802 }
803
804 /* -------------------------------------------------------------------------- */
805 /* 0x0000: Root */
806 /* -------------------------------------------------------------------------- */
807
808 #define HIDPP_PAGE_ROOT 0x0000
809 #define HIDPP_PAGE_ROOT_IDX 0x00
810
811 #define CMD_ROOT_GET_FEATURE 0x01
812 #define CMD_ROOT_GET_PROTOCOL_VERSION 0x11
813
814 static int hidpp_root_get_feature(struct hidpp_device *hidpp, u16 feature,
815 u8 *feature_index, u8 *feature_type)
816 {
817 struct hidpp_report response;
818 int ret;
819 u8 params[2] = { feature >> 8, feature & 0x00FF };
820
821 ret = hidpp_send_fap_command_sync(hidpp,
822 HIDPP_PAGE_ROOT_IDX,
823 CMD_ROOT_GET_FEATURE,
824 params, 2, &response);
825 if (ret)
826 return ret;
827
828 if (response.fap.params[0] == 0)
829 return -ENOENT;
830
831 *feature_index = response.fap.params[0];
832 *feature_type = response.fap.params[1];
833
834 return ret;
835 }
836
837 static int hidpp_root_get_protocol_version(struct hidpp_device *hidpp)
838 {
839 const u8 ping_byte = 0x5a;
840 u8 ping_data[3] = { 0, 0, ping_byte };
841 struct hidpp_report response;
842 int ret;
843
844 ret = hidpp_send_rap_command_sync(hidpp,
845 REPORT_ID_HIDPP_SHORT,
846 HIDPP_PAGE_ROOT_IDX,
847 CMD_ROOT_GET_PROTOCOL_VERSION,
848 ping_data, sizeof(ping_data), &response);
849
850 if (ret == HIDPP_ERROR_INVALID_SUBID) {
851 hidpp->protocol_major = 1;
852 hidpp->protocol_minor = 0;
853 return 0;
854 }
855
856 /* the device might not be connected */
857 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
858 return -EIO;
859
860 if (ret > 0) {
861 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
862 __func__, ret);
863 return -EPROTO;
864 }
865 if (ret)
866 return ret;
867
868 if (response.rap.params[2] != ping_byte) {
869 hid_err(hidpp->hid_dev, "%s: ping mismatch 0x%02x != 0x%02x\n",
870 __func__, response.rap.params[2], ping_byte);
871 return -EPROTO;
872 }
873
874 hidpp->protocol_major = response.rap.params[0];
875 hidpp->protocol_minor = response.rap.params[1];
876
877 return ret;
878 }
879
880 static bool hidpp_is_connected(struct hidpp_device *hidpp)
881 {
882 int ret;
883
884 ret = hidpp_root_get_protocol_version(hidpp);
885 if (!ret)
886 hid_dbg(hidpp->hid_dev, "HID++ %u.%u device connected.\n",
887 hidpp->protocol_major, hidpp->protocol_minor);
888 return ret == 0;
889 }
890
891 /* -------------------------------------------------------------------------- */
892 /* 0x0005: GetDeviceNameType */
893 /* -------------------------------------------------------------------------- */
894
895 #define HIDPP_PAGE_GET_DEVICE_NAME_TYPE 0x0005
896
897 #define CMD_GET_DEVICE_NAME_TYPE_GET_COUNT 0x01
898 #define CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME 0x11
899 #define CMD_GET_DEVICE_NAME_TYPE_GET_TYPE 0x21
900
901 static int hidpp_devicenametype_get_count(struct hidpp_device *hidpp,
902 u8 feature_index, u8 *nameLength)
903 {
904 struct hidpp_report response;
905 int ret;
906
907 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
908 CMD_GET_DEVICE_NAME_TYPE_GET_COUNT, NULL, 0, &response);
909
910 if (ret > 0) {
911 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
912 __func__, ret);
913 return -EPROTO;
914 }
915 if (ret)
916 return ret;
917
918 *nameLength = response.fap.params[0];
919
920 return ret;
921 }
922
923 static int hidpp_devicenametype_get_device_name(struct hidpp_device *hidpp,
924 u8 feature_index, u8 char_index, char *device_name, int len_buf)
925 {
926 struct hidpp_report response;
927 int ret, i;
928 int count;
929
930 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
931 CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME, &char_index, 1,
932 &response);
933
934 if (ret > 0) {
935 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
936 __func__, ret);
937 return -EPROTO;
938 }
939 if (ret)
940 return ret;
941
942 switch (response.report_id) {
943 case REPORT_ID_HIDPP_VERY_LONG:
944 count = HIDPP_REPORT_VERY_LONG_LENGTH - 4;
945 break;
946 case REPORT_ID_HIDPP_LONG:
947 count = HIDPP_REPORT_LONG_LENGTH - 4;
948 break;
949 case REPORT_ID_HIDPP_SHORT:
950 count = HIDPP_REPORT_SHORT_LENGTH - 4;
951 break;
952 default:
953 return -EPROTO;
954 }
955
956 if (len_buf < count)
957 count = len_buf;
958
959 for (i = 0; i < count; i++)
960 device_name[i] = response.fap.params[i];
961
962 return count;
963 }
964
965 static char *hidpp_get_device_name(struct hidpp_device *hidpp)
966 {
967 u8 feature_type;
968 u8 feature_index;
969 u8 __name_length;
970 char *name;
971 unsigned index = 0;
972 int ret;
973
974 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_GET_DEVICE_NAME_TYPE,
975 &feature_index, &feature_type);
976 if (ret)
977 return NULL;
978
979 ret = hidpp_devicenametype_get_count(hidpp, feature_index,
980 &__name_length);
981 if (ret)
982 return NULL;
983
984 name = kzalloc(__name_length + 1, GFP_KERNEL);
985 if (!name)
986 return NULL;
987
988 while (index < __name_length) {
989 ret = hidpp_devicenametype_get_device_name(hidpp,
990 feature_index, index, name + index,
991 __name_length - index);
992 if (ret <= 0) {
993 kfree(name);
994 return NULL;
995 }
996 index += ret;
997 }
998
999 /* include the terminating '\0' */
1000 hidpp_prefix_name(&name, __name_length + 1);
1001
1002 return name;
1003 }
1004
1005 /* -------------------------------------------------------------------------- */
1006 /* 0x1000: Battery level status */
1007 /* -------------------------------------------------------------------------- */
1008
1009 #define HIDPP_PAGE_BATTERY_LEVEL_STATUS 0x1000
1010
1011 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS 0x00
1012 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY 0x10
1013
1014 #define EVENT_BATTERY_LEVEL_STATUS_BROADCAST 0x00
1015
1016 #define FLAG_BATTERY_LEVEL_DISABLE_OSD BIT(0)
1017 #define FLAG_BATTERY_LEVEL_MILEAGE BIT(1)
1018 #define FLAG_BATTERY_LEVEL_RECHARGEABLE BIT(2)
1019
1020 static int hidpp_map_battery_level(int capacity)
1021 {
1022 if (capacity < 11)
1023 return POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1024 /*
1025 * The spec says this should be < 31 but some devices report 30
1026 * with brand new batteries and Windows reports 30 as "Good".
1027 */
1028 else if (capacity < 30)
1029 return POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1030 else if (capacity < 81)
1031 return POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1032 return POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1033 }
1034
1035 static int hidpp20_batterylevel_map_status_capacity(u8 data[3], int *capacity,
1036 int *next_capacity,
1037 int *level)
1038 {
1039 int status;
1040
1041 *capacity = data[0];
1042 *next_capacity = data[1];
1043 *level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1044
1045 /* When discharging, we can rely on the device reported capacity.
1046 * For all other states the device reports 0 (unknown).
1047 */
1048 switch (data[2]) {
1049 case 0: /* discharging (in use) */
1050 status = POWER_SUPPLY_STATUS_DISCHARGING;
1051 *level = hidpp_map_battery_level(*capacity);
1052 break;
1053 case 1: /* recharging */
1054 status = POWER_SUPPLY_STATUS_CHARGING;
1055 break;
1056 case 2: /* charge in final stage */
1057 status = POWER_SUPPLY_STATUS_CHARGING;
1058 break;
1059 case 3: /* charge complete */
1060 status = POWER_SUPPLY_STATUS_FULL;
1061 *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1062 *capacity = 100;
1063 break;
1064 case 4: /* recharging below optimal speed */
1065 status = POWER_SUPPLY_STATUS_CHARGING;
1066 break;
1067 /* 5 = invalid battery type
1068 6 = thermal error
1069 7 = other charging error */
1070 default:
1071 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
1072 break;
1073 }
1074
1075 return status;
1076 }
1077
1078 static int hidpp20_batterylevel_get_battery_capacity(struct hidpp_device *hidpp,
1079 u8 feature_index,
1080 int *status,
1081 int *capacity,
1082 int *next_capacity,
1083 int *level)
1084 {
1085 struct hidpp_report response;
1086 int ret;
1087 u8 *params = (u8 *)response.fap.params;
1088
1089 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1090 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS,
1091 NULL, 0, &response);
1092 if (ret > 0) {
1093 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1094 __func__, ret);
1095 return -EPROTO;
1096 }
1097 if (ret)
1098 return ret;
1099
1100 *status = hidpp20_batterylevel_map_status_capacity(params, capacity,
1101 next_capacity,
1102 level);
1103
1104 return 0;
1105 }
1106
1107 static int hidpp20_batterylevel_get_battery_info(struct hidpp_device *hidpp,
1108 u8 feature_index)
1109 {
1110 struct hidpp_report response;
1111 int ret;
1112 u8 *params = (u8 *)response.fap.params;
1113 unsigned int level_count, flags;
1114
1115 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1116 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY,
1117 NULL, 0, &response);
1118 if (ret > 0) {
1119 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1120 __func__, ret);
1121 return -EPROTO;
1122 }
1123 if (ret)
1124 return ret;
1125
1126 level_count = params[0];
1127 flags = params[1];
1128
1129 if (level_count < 10 || !(flags & FLAG_BATTERY_LEVEL_MILEAGE))
1130 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS;
1131 else
1132 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
1133
1134 return 0;
1135 }
1136
1137 static int hidpp20_query_battery_info(struct hidpp_device *hidpp)
1138 {
1139 u8 feature_type;
1140 int ret;
1141 int status, capacity, next_capacity, level;
1142
1143 if (hidpp->battery.feature_index == 0xff) {
1144 ret = hidpp_root_get_feature(hidpp,
1145 HIDPP_PAGE_BATTERY_LEVEL_STATUS,
1146 &hidpp->battery.feature_index,
1147 &feature_type);
1148 if (ret)
1149 return ret;
1150 }
1151
1152 ret = hidpp20_batterylevel_get_battery_capacity(hidpp,
1153 hidpp->battery.feature_index,
1154 &status, &capacity,
1155 &next_capacity, &level);
1156 if (ret)
1157 return ret;
1158
1159 ret = hidpp20_batterylevel_get_battery_info(hidpp,
1160 hidpp->battery.feature_index);
1161 if (ret)
1162 return ret;
1163
1164 hidpp->battery.status = status;
1165 hidpp->battery.capacity = capacity;
1166 hidpp->battery.level = level;
1167 /* the capacity is only available when discharging or full */
1168 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
1169 status == POWER_SUPPLY_STATUS_FULL;
1170
1171 return 0;
1172 }
1173
1174 static int hidpp20_battery_event(struct hidpp_device *hidpp,
1175 u8 *data, int size)
1176 {
1177 struct hidpp_report *report = (struct hidpp_report *)data;
1178 int status, capacity, next_capacity, level;
1179 bool changed;
1180
1181 if (report->fap.feature_index != hidpp->battery.feature_index ||
1182 report->fap.funcindex_clientid != EVENT_BATTERY_LEVEL_STATUS_BROADCAST)
1183 return 0;
1184
1185 status = hidpp20_batterylevel_map_status_capacity(report->fap.params,
1186 &capacity,
1187 &next_capacity,
1188 &level);
1189
1190 /* the capacity is only available when discharging or full */
1191 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
1192 status == POWER_SUPPLY_STATUS_FULL;
1193
1194 changed = capacity != hidpp->battery.capacity ||
1195 level != hidpp->battery.level ||
1196 status != hidpp->battery.status;
1197
1198 if (changed) {
1199 hidpp->battery.level = level;
1200 hidpp->battery.capacity = capacity;
1201 hidpp->battery.status = status;
1202 if (hidpp->battery.ps)
1203 power_supply_changed(hidpp->battery.ps);
1204 }
1205
1206 return 0;
1207 }
1208
1209 static enum power_supply_property hidpp_battery_props[] = {
1210 POWER_SUPPLY_PROP_ONLINE,
1211 POWER_SUPPLY_PROP_STATUS,
1212 POWER_SUPPLY_PROP_SCOPE,
1213 POWER_SUPPLY_PROP_MODEL_NAME,
1214 POWER_SUPPLY_PROP_MANUFACTURER,
1215 POWER_SUPPLY_PROP_SERIAL_NUMBER,
1216 0, /* placeholder for POWER_SUPPLY_PROP_CAPACITY, */
1217 0, /* placeholder for POWER_SUPPLY_PROP_CAPACITY_LEVEL, */
1218 };
1219
1220 static int hidpp_battery_get_property(struct power_supply *psy,
1221 enum power_supply_property psp,
1222 union power_supply_propval *val)
1223 {
1224 struct hidpp_device *hidpp = power_supply_get_drvdata(psy);
1225 int ret = 0;
1226
1227 switch(psp) {
1228 case POWER_SUPPLY_PROP_STATUS:
1229 val->intval = hidpp->battery.status;
1230 break;
1231 case POWER_SUPPLY_PROP_CAPACITY:
1232 val->intval = hidpp->battery.capacity;
1233 break;
1234 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
1235 val->intval = hidpp->battery.level;
1236 break;
1237 case POWER_SUPPLY_PROP_SCOPE:
1238 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1239 break;
1240 case POWER_SUPPLY_PROP_ONLINE:
1241 val->intval = hidpp->battery.online;
1242 break;
1243 case POWER_SUPPLY_PROP_MODEL_NAME:
1244 if (!strncmp(hidpp->name, "Logitech ", 9))
1245 val->strval = hidpp->name + 9;
1246 else
1247 val->strval = hidpp->name;
1248 break;
1249 case POWER_SUPPLY_PROP_MANUFACTURER:
1250 val->strval = "Logitech";
1251 break;
1252 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
1253 val->strval = hidpp->hid_dev->uniq;
1254 break;
1255 default:
1256 ret = -EINVAL;
1257 break;
1258 }
1259
1260 return ret;
1261 }
1262
1263 /* -------------------------------------------------------------------------- */
1264 /* 0x2120: Hi-resolution scrolling */
1265 /* -------------------------------------------------------------------------- */
1266
1267 #define HIDPP_PAGE_HI_RESOLUTION_SCROLLING 0x2120
1268
1269 #define CMD_HI_RESOLUTION_SCROLLING_SET_HIGHRES_SCROLLING_MODE 0x10
1270
1271 static int hidpp_hrs_set_highres_scrolling_mode(struct hidpp_device *hidpp,
1272 bool enabled, u8 *multiplier)
1273 {
1274 u8 feature_index;
1275 u8 feature_type;
1276 int ret;
1277 u8 params[1];
1278 struct hidpp_report response;
1279
1280 ret = hidpp_root_get_feature(hidpp,
1281 HIDPP_PAGE_HI_RESOLUTION_SCROLLING,
1282 &feature_index,
1283 &feature_type);
1284 if (ret)
1285 return ret;
1286
1287 params[0] = enabled ? BIT(0) : 0;
1288 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1289 CMD_HI_RESOLUTION_SCROLLING_SET_HIGHRES_SCROLLING_MODE,
1290 params, sizeof(params), &response);
1291 if (ret)
1292 return ret;
1293 *multiplier = response.fap.params[1];
1294 return 0;
1295 }
1296
1297 /* -------------------------------------------------------------------------- */
1298 /* 0x2121: HiRes Wheel */
1299 /* -------------------------------------------------------------------------- */
1300
1301 #define HIDPP_PAGE_HIRES_WHEEL 0x2121
1302
1303 #define CMD_HIRES_WHEEL_GET_WHEEL_CAPABILITY 0x00
1304 #define CMD_HIRES_WHEEL_SET_WHEEL_MODE 0x20
1305
1306 static int hidpp_hrw_get_wheel_capability(struct hidpp_device *hidpp,
1307 u8 *multiplier)
1308 {
1309 u8 feature_index;
1310 u8 feature_type;
1311 int ret;
1312 struct hidpp_report response;
1313
1314 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_HIRES_WHEEL,
1315 &feature_index, &feature_type);
1316 if (ret)
1317 goto return_default;
1318
1319 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1320 CMD_HIRES_WHEEL_GET_WHEEL_CAPABILITY,
1321 NULL, 0, &response);
1322 if (ret)
1323 goto return_default;
1324
1325 *multiplier = response.fap.params[0];
1326 return 0;
1327 return_default:
1328 hid_warn(hidpp->hid_dev,
1329 "Couldn't get wheel multiplier (error %d)\n", ret);
1330 return ret;
1331 }
1332
1333 static int hidpp_hrw_set_wheel_mode(struct hidpp_device *hidpp, bool invert,
1334 bool high_resolution, bool use_hidpp)
1335 {
1336 u8 feature_index;
1337 u8 feature_type;
1338 int ret;
1339 u8 params[1];
1340 struct hidpp_report response;
1341
1342 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_HIRES_WHEEL,
1343 &feature_index, &feature_type);
1344 if (ret)
1345 return ret;
1346
1347 params[0] = (invert ? BIT(2) : 0) |
1348 (high_resolution ? BIT(1) : 0) |
1349 (use_hidpp ? BIT(0) : 0);
1350
1351 return hidpp_send_fap_command_sync(hidpp, feature_index,
1352 CMD_HIRES_WHEEL_SET_WHEEL_MODE,
1353 params, sizeof(params), &response);
1354 }
1355
1356 /* -------------------------------------------------------------------------- */
1357 /* 0x4301: Solar Keyboard */
1358 /* -------------------------------------------------------------------------- */
1359
1360 #define HIDPP_PAGE_SOLAR_KEYBOARD 0x4301
1361
1362 #define CMD_SOLAR_SET_LIGHT_MEASURE 0x00
1363
1364 #define EVENT_SOLAR_BATTERY_BROADCAST 0x00
1365 #define EVENT_SOLAR_BATTERY_LIGHT_MEASURE 0x10
1366 #define EVENT_SOLAR_CHECK_LIGHT_BUTTON 0x20
1367
1368 static int hidpp_solar_request_battery_event(struct hidpp_device *hidpp)
1369 {
1370 struct hidpp_report response;
1371 u8 params[2] = { 1, 1 };
1372 u8 feature_type;
1373 int ret;
1374
1375 if (hidpp->battery.feature_index == 0xff) {
1376 ret = hidpp_root_get_feature(hidpp,
1377 HIDPP_PAGE_SOLAR_KEYBOARD,
1378 &hidpp->battery.solar_feature_index,
1379 &feature_type);
1380 if (ret)
1381 return ret;
1382 }
1383
1384 ret = hidpp_send_fap_command_sync(hidpp,
1385 hidpp->battery.solar_feature_index,
1386 CMD_SOLAR_SET_LIGHT_MEASURE,
1387 params, 2, &response);
1388 if (ret > 0) {
1389 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1390 __func__, ret);
1391 return -EPROTO;
1392 }
1393 if (ret)
1394 return ret;
1395
1396 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
1397
1398 return 0;
1399 }
1400
1401 static int hidpp_solar_battery_event(struct hidpp_device *hidpp,
1402 u8 *data, int size)
1403 {
1404 struct hidpp_report *report = (struct hidpp_report *)data;
1405 int capacity, lux, status;
1406 u8 function;
1407
1408 function = report->fap.funcindex_clientid;
1409
1410
1411 if (report->fap.feature_index != hidpp->battery.solar_feature_index ||
1412 !(function == EVENT_SOLAR_BATTERY_BROADCAST ||
1413 function == EVENT_SOLAR_BATTERY_LIGHT_MEASURE ||
1414 function == EVENT_SOLAR_CHECK_LIGHT_BUTTON))
1415 return 0;
1416
1417 capacity = report->fap.params[0];
1418
1419 switch (function) {
1420 case EVENT_SOLAR_BATTERY_LIGHT_MEASURE:
1421 lux = (report->fap.params[1] << 8) | report->fap.params[2];
1422 if (lux > 200)
1423 status = POWER_SUPPLY_STATUS_CHARGING;
1424 else
1425 status = POWER_SUPPLY_STATUS_DISCHARGING;
1426 break;
1427 case EVENT_SOLAR_CHECK_LIGHT_BUTTON:
1428 default:
1429 if (capacity < hidpp->battery.capacity)
1430 status = POWER_SUPPLY_STATUS_DISCHARGING;
1431 else
1432 status = POWER_SUPPLY_STATUS_CHARGING;
1433
1434 }
1435
1436 if (capacity == 100)
1437 status = POWER_SUPPLY_STATUS_FULL;
1438
1439 hidpp->battery.online = true;
1440 if (capacity != hidpp->battery.capacity ||
1441 status != hidpp->battery.status) {
1442 hidpp->battery.capacity = capacity;
1443 hidpp->battery.status = status;
1444 if (hidpp->battery.ps)
1445 power_supply_changed(hidpp->battery.ps);
1446 }
1447
1448 return 0;
1449 }
1450
1451 /* -------------------------------------------------------------------------- */
1452 /* 0x6010: Touchpad FW items */
1453 /* -------------------------------------------------------------------------- */
1454
1455 #define HIDPP_PAGE_TOUCHPAD_FW_ITEMS 0x6010
1456
1457 #define CMD_TOUCHPAD_FW_ITEMS_SET 0x10
1458
1459 struct hidpp_touchpad_fw_items {
1460 uint8_t presence;
1461 uint8_t desired_state;
1462 uint8_t state;
1463 uint8_t persistent;
1464 };
1465
1466 /**
1467 * send a set state command to the device by reading the current items->state
1468 * field. items is then filled with the current state.
1469 */
1470 static int hidpp_touchpad_fw_items_set(struct hidpp_device *hidpp,
1471 u8 feature_index,
1472 struct hidpp_touchpad_fw_items *items)
1473 {
1474 struct hidpp_report response;
1475 int ret;
1476 u8 *params = (u8 *)response.fap.params;
1477
1478 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1479 CMD_TOUCHPAD_FW_ITEMS_SET, &items->state, 1, &response);
1480
1481 if (ret > 0) {
1482 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1483 __func__, ret);
1484 return -EPROTO;
1485 }
1486 if (ret)
1487 return ret;
1488
1489 items->presence = params[0];
1490 items->desired_state = params[1];
1491 items->state = params[2];
1492 items->persistent = params[3];
1493
1494 return 0;
1495 }
1496
1497 /* -------------------------------------------------------------------------- */
1498 /* 0x6100: TouchPadRawXY */
1499 /* -------------------------------------------------------------------------- */
1500
1501 #define HIDPP_PAGE_TOUCHPAD_RAW_XY 0x6100
1502
1503 #define CMD_TOUCHPAD_GET_RAW_INFO 0x01
1504 #define CMD_TOUCHPAD_SET_RAW_REPORT_STATE 0x21
1505
1506 #define EVENT_TOUCHPAD_RAW_XY 0x00
1507
1508 #define TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT 0x01
1509 #define TOUCHPAD_RAW_XY_ORIGIN_UPPER_LEFT 0x03
1510
1511 struct hidpp_touchpad_raw_info {
1512 u16 x_size;
1513 u16 y_size;
1514 u8 z_range;
1515 u8 area_range;
1516 u8 timestamp_unit;
1517 u8 maxcontacts;
1518 u8 origin;
1519 u16 res;
1520 };
1521
1522 struct hidpp_touchpad_raw_xy_finger {
1523 u8 contact_type;
1524 u8 contact_status;
1525 u16 x;
1526 u16 y;
1527 u8 z;
1528 u8 area;
1529 u8 finger_id;
1530 };
1531
1532 struct hidpp_touchpad_raw_xy {
1533 u16 timestamp;
1534 struct hidpp_touchpad_raw_xy_finger fingers[2];
1535 u8 spurious_flag;
1536 u8 end_of_frame;
1537 u8 finger_count;
1538 u8 button;
1539 };
1540
1541 static int hidpp_touchpad_get_raw_info(struct hidpp_device *hidpp,
1542 u8 feature_index, struct hidpp_touchpad_raw_info *raw_info)
1543 {
1544 struct hidpp_report response;
1545 int ret;
1546 u8 *params = (u8 *)response.fap.params;
1547
1548 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1549 CMD_TOUCHPAD_GET_RAW_INFO, NULL, 0, &response);
1550
1551 if (ret > 0) {
1552 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1553 __func__, ret);
1554 return -EPROTO;
1555 }
1556 if (ret)
1557 return ret;
1558
1559 raw_info->x_size = get_unaligned_be16(&params[0]);
1560 raw_info->y_size = get_unaligned_be16(&params[2]);
1561 raw_info->z_range = params[4];
1562 raw_info->area_range = params[5];
1563 raw_info->maxcontacts = params[7];
1564 raw_info->origin = params[8];
1565 /* res is given in unit per inch */
1566 raw_info->res = get_unaligned_be16(&params[13]) * 2 / 51;
1567
1568 return ret;
1569 }
1570
1571 static int hidpp_touchpad_set_raw_report_state(struct hidpp_device *hidpp_dev,
1572 u8 feature_index, bool send_raw_reports,
1573 bool sensor_enhanced_settings)
1574 {
1575 struct hidpp_report response;
1576
1577 /*
1578 * Params:
1579 * bit 0 - enable raw
1580 * bit 1 - 16bit Z, no area
1581 * bit 2 - enhanced sensitivity
1582 * bit 3 - width, height (4 bits each) instead of area
1583 * bit 4 - send raw + gestures (degrades smoothness)
1584 * remaining bits - reserved
1585 */
1586 u8 params = send_raw_reports | (sensor_enhanced_settings << 2);
1587
1588 return hidpp_send_fap_command_sync(hidpp_dev, feature_index,
1589 CMD_TOUCHPAD_SET_RAW_REPORT_STATE, &params, 1, &response);
1590 }
1591
1592 static void hidpp_touchpad_touch_event(u8 *data,
1593 struct hidpp_touchpad_raw_xy_finger *finger)
1594 {
1595 u8 x_m = data[0] << 2;
1596 u8 y_m = data[2] << 2;
1597
1598 finger->x = x_m << 6 | data[1];
1599 finger->y = y_m << 6 | data[3];
1600
1601 finger->contact_type = data[0] >> 6;
1602 finger->contact_status = data[2] >> 6;
1603
1604 finger->z = data[4];
1605 finger->area = data[5];
1606 finger->finger_id = data[6] >> 4;
1607 }
1608
1609 static void hidpp_touchpad_raw_xy_event(struct hidpp_device *hidpp_dev,
1610 u8 *data, struct hidpp_touchpad_raw_xy *raw_xy)
1611 {
1612 memset(raw_xy, 0, sizeof(struct hidpp_touchpad_raw_xy));
1613 raw_xy->end_of_frame = data[8] & 0x01;
1614 raw_xy->spurious_flag = (data[8] >> 1) & 0x01;
1615 raw_xy->finger_count = data[15] & 0x0f;
1616 raw_xy->button = (data[8] >> 2) & 0x01;
1617
1618 if (raw_xy->finger_count) {
1619 hidpp_touchpad_touch_event(&data[2], &raw_xy->fingers[0]);
1620 hidpp_touchpad_touch_event(&data[9], &raw_xy->fingers[1]);
1621 }
1622 }
1623
1624 /* -------------------------------------------------------------------------- */
1625 /* 0x8123: Force feedback support */
1626 /* -------------------------------------------------------------------------- */
1627
1628 #define HIDPP_FF_GET_INFO 0x01
1629 #define HIDPP_FF_RESET_ALL 0x11
1630 #define HIDPP_FF_DOWNLOAD_EFFECT 0x21
1631 #define HIDPP_FF_SET_EFFECT_STATE 0x31
1632 #define HIDPP_FF_DESTROY_EFFECT 0x41
1633 #define HIDPP_FF_GET_APERTURE 0x51
1634 #define HIDPP_FF_SET_APERTURE 0x61
1635 #define HIDPP_FF_GET_GLOBAL_GAINS 0x71
1636 #define HIDPP_FF_SET_GLOBAL_GAINS 0x81
1637
1638 #define HIDPP_FF_EFFECT_STATE_GET 0x00
1639 #define HIDPP_FF_EFFECT_STATE_STOP 0x01
1640 #define HIDPP_FF_EFFECT_STATE_PLAY 0x02
1641 #define HIDPP_FF_EFFECT_STATE_PAUSE 0x03
1642
1643 #define HIDPP_FF_EFFECT_CONSTANT 0x00
1644 #define HIDPP_FF_EFFECT_PERIODIC_SINE 0x01
1645 #define HIDPP_FF_EFFECT_PERIODIC_SQUARE 0x02
1646 #define HIDPP_FF_EFFECT_PERIODIC_TRIANGLE 0x03
1647 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP 0x04
1648 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN 0x05
1649 #define HIDPP_FF_EFFECT_SPRING 0x06
1650 #define HIDPP_FF_EFFECT_DAMPER 0x07
1651 #define HIDPP_FF_EFFECT_FRICTION 0x08
1652 #define HIDPP_FF_EFFECT_INERTIA 0x09
1653 #define HIDPP_FF_EFFECT_RAMP 0x0A
1654
1655 #define HIDPP_FF_EFFECT_AUTOSTART 0x80
1656
1657 #define HIDPP_FF_EFFECTID_NONE -1
1658 #define HIDPP_FF_EFFECTID_AUTOCENTER -2
1659
1660 #define HIDPP_FF_MAX_PARAMS 20
1661 #define HIDPP_FF_RESERVED_SLOTS 1
1662
1663 struct hidpp_ff_private_data {
1664 struct hidpp_device *hidpp;
1665 u8 feature_index;
1666 u8 version;
1667 u16 gain;
1668 s16 range;
1669 u8 slot_autocenter;
1670 u8 num_effects;
1671 int *effect_ids;
1672 struct workqueue_struct *wq;
1673 atomic_t workqueue_size;
1674 };
1675
1676 struct hidpp_ff_work_data {
1677 struct work_struct work;
1678 struct hidpp_ff_private_data *data;
1679 int effect_id;
1680 u8 command;
1681 u8 params[HIDPP_FF_MAX_PARAMS];
1682 u8 size;
1683 };
1684
1685 static const signed short hidpp_ff_effects[] = {
1686 FF_CONSTANT,
1687 FF_PERIODIC,
1688 FF_SINE,
1689 FF_SQUARE,
1690 FF_SAW_UP,
1691 FF_SAW_DOWN,
1692 FF_TRIANGLE,
1693 FF_SPRING,
1694 FF_DAMPER,
1695 FF_AUTOCENTER,
1696 FF_GAIN,
1697 -1
1698 };
1699
1700 static const signed short hidpp_ff_effects_v2[] = {
1701 FF_RAMP,
1702 FF_FRICTION,
1703 FF_INERTIA,
1704 -1
1705 };
1706
1707 static const u8 HIDPP_FF_CONDITION_CMDS[] = {
1708 HIDPP_FF_EFFECT_SPRING,
1709 HIDPP_FF_EFFECT_FRICTION,
1710 HIDPP_FF_EFFECT_DAMPER,
1711 HIDPP_FF_EFFECT_INERTIA
1712 };
1713
1714 static const char *HIDPP_FF_CONDITION_NAMES[] = {
1715 "spring",
1716 "friction",
1717 "damper",
1718 "inertia"
1719 };
1720
1721
1722 static u8 hidpp_ff_find_effect(struct hidpp_ff_private_data *data, int effect_id)
1723 {
1724 int i;
1725
1726 for (i = 0; i < data->num_effects; i++)
1727 if (data->effect_ids[i] == effect_id)
1728 return i+1;
1729
1730 return 0;
1731 }
1732
1733 static void hidpp_ff_work_handler(struct work_struct *w)
1734 {
1735 struct hidpp_ff_work_data *wd = container_of(w, struct hidpp_ff_work_data, work);
1736 struct hidpp_ff_private_data *data = wd->data;
1737 struct hidpp_report response;
1738 u8 slot;
1739 int ret;
1740
1741 /* add slot number if needed */
1742 switch (wd->effect_id) {
1743 case HIDPP_FF_EFFECTID_AUTOCENTER:
1744 wd->params[0] = data->slot_autocenter;
1745 break;
1746 case HIDPP_FF_EFFECTID_NONE:
1747 /* leave slot as zero */
1748 break;
1749 default:
1750 /* find current slot for effect */
1751 wd->params[0] = hidpp_ff_find_effect(data, wd->effect_id);
1752 break;
1753 }
1754
1755 /* send command and wait for reply */
1756 ret = hidpp_send_fap_command_sync(data->hidpp, data->feature_index,
1757 wd->command, wd->params, wd->size, &response);
1758
1759 if (ret) {
1760 hid_err(data->hidpp->hid_dev, "Failed to send command to device!\n");
1761 goto out;
1762 }
1763
1764 /* parse return data */
1765 switch (wd->command) {
1766 case HIDPP_FF_DOWNLOAD_EFFECT:
1767 slot = response.fap.params[0];
1768 if (slot > 0 && slot <= data->num_effects) {
1769 if (wd->effect_id >= 0)
1770 /* regular effect uploaded */
1771 data->effect_ids[slot-1] = wd->effect_id;
1772 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
1773 /* autocenter spring uploaded */
1774 data->slot_autocenter = slot;
1775 }
1776 break;
1777 case HIDPP_FF_DESTROY_EFFECT:
1778 if (wd->effect_id >= 0)
1779 /* regular effect destroyed */
1780 data->effect_ids[wd->params[0]-1] = -1;
1781 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
1782 /* autocenter spring destoyed */
1783 data->slot_autocenter = 0;
1784 break;
1785 case HIDPP_FF_SET_GLOBAL_GAINS:
1786 data->gain = (wd->params[0] << 8) + wd->params[1];
1787 break;
1788 case HIDPP_FF_SET_APERTURE:
1789 data->range = (wd->params[0] << 8) + wd->params[1];
1790 break;
1791 default:
1792 /* no action needed */
1793 break;
1794 }
1795
1796 out:
1797 atomic_dec(&data->workqueue_size);
1798 kfree(wd);
1799 }
1800
1801 static int hidpp_ff_queue_work(struct hidpp_ff_private_data *data, int effect_id, u8 command, u8 *params, u8 size)
1802 {
1803 struct hidpp_ff_work_data *wd = kzalloc(sizeof(*wd), GFP_KERNEL);
1804 int s;
1805
1806 if (!wd)
1807 return -ENOMEM;
1808
1809 INIT_WORK(&wd->work, hidpp_ff_work_handler);
1810
1811 wd->data = data;
1812 wd->effect_id = effect_id;
1813 wd->command = command;
1814 wd->size = size;
1815 memcpy(wd->params, params, size);
1816
1817 atomic_inc(&data->workqueue_size);
1818 queue_work(data->wq, &wd->work);
1819
1820 /* warn about excessive queue size */
1821 s = atomic_read(&data->workqueue_size);
1822 if (s >= 20 && s % 20 == 0)
1823 hid_warn(data->hidpp->hid_dev, "Force feedback command queue contains %d commands, causing substantial delays!", s);
1824
1825 return 0;
1826 }
1827
1828 static int hidpp_ff_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
1829 {
1830 struct hidpp_ff_private_data *data = dev->ff->private;
1831 u8 params[20];
1832 u8 size;
1833 int force;
1834
1835 /* set common parameters */
1836 params[2] = effect->replay.length >> 8;
1837 params[3] = effect->replay.length & 255;
1838 params[4] = effect->replay.delay >> 8;
1839 params[5] = effect->replay.delay & 255;
1840
1841 switch (effect->type) {
1842 case FF_CONSTANT:
1843 force = (effect->u.constant.level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1844 params[1] = HIDPP_FF_EFFECT_CONSTANT;
1845 params[6] = force >> 8;
1846 params[7] = force & 255;
1847 params[8] = effect->u.constant.envelope.attack_level >> 7;
1848 params[9] = effect->u.constant.envelope.attack_length >> 8;
1849 params[10] = effect->u.constant.envelope.attack_length & 255;
1850 params[11] = effect->u.constant.envelope.fade_level >> 7;
1851 params[12] = effect->u.constant.envelope.fade_length >> 8;
1852 params[13] = effect->u.constant.envelope.fade_length & 255;
1853 size = 14;
1854 dbg_hid("Uploading constant force level=%d in dir %d = %d\n",
1855 effect->u.constant.level,
1856 effect->direction, force);
1857 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1858 effect->u.constant.envelope.attack_level,
1859 effect->u.constant.envelope.attack_length,
1860 effect->u.constant.envelope.fade_level,
1861 effect->u.constant.envelope.fade_length);
1862 break;
1863 case FF_PERIODIC:
1864 {
1865 switch (effect->u.periodic.waveform) {
1866 case FF_SINE:
1867 params[1] = HIDPP_FF_EFFECT_PERIODIC_SINE;
1868 break;
1869 case FF_SQUARE:
1870 params[1] = HIDPP_FF_EFFECT_PERIODIC_SQUARE;
1871 break;
1872 case FF_SAW_UP:
1873 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP;
1874 break;
1875 case FF_SAW_DOWN:
1876 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN;
1877 break;
1878 case FF_TRIANGLE:
1879 params[1] = HIDPP_FF_EFFECT_PERIODIC_TRIANGLE;
1880 break;
1881 default:
1882 hid_err(data->hidpp->hid_dev, "Unexpected periodic waveform type %i!\n", effect->u.periodic.waveform);
1883 return -EINVAL;
1884 }
1885 force = (effect->u.periodic.magnitude * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1886 params[6] = effect->u.periodic.magnitude >> 8;
1887 params[7] = effect->u.periodic.magnitude & 255;
1888 params[8] = effect->u.periodic.offset >> 8;
1889 params[9] = effect->u.periodic.offset & 255;
1890 params[10] = effect->u.periodic.period >> 8;
1891 params[11] = effect->u.periodic.period & 255;
1892 params[12] = effect->u.periodic.phase >> 8;
1893 params[13] = effect->u.periodic.phase & 255;
1894 params[14] = effect->u.periodic.envelope.attack_level >> 7;
1895 params[15] = effect->u.periodic.envelope.attack_length >> 8;
1896 params[16] = effect->u.periodic.envelope.attack_length & 255;
1897 params[17] = effect->u.periodic.envelope.fade_level >> 7;
1898 params[18] = effect->u.periodic.envelope.fade_length >> 8;
1899 params[19] = effect->u.periodic.envelope.fade_length & 255;
1900 size = 20;
1901 dbg_hid("Uploading periodic force mag=%d/dir=%d, offset=%d, period=%d ms, phase=%d\n",
1902 effect->u.periodic.magnitude, effect->direction,
1903 effect->u.periodic.offset,
1904 effect->u.periodic.period,
1905 effect->u.periodic.phase);
1906 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1907 effect->u.periodic.envelope.attack_level,
1908 effect->u.periodic.envelope.attack_length,
1909 effect->u.periodic.envelope.fade_level,
1910 effect->u.periodic.envelope.fade_length);
1911 break;
1912 }
1913 case FF_RAMP:
1914 params[1] = HIDPP_FF_EFFECT_RAMP;
1915 force = (effect->u.ramp.start_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1916 params[6] = force >> 8;
1917 params[7] = force & 255;
1918 force = (effect->u.ramp.end_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
1919 params[8] = force >> 8;
1920 params[9] = force & 255;
1921 params[10] = effect->u.ramp.envelope.attack_level >> 7;
1922 params[11] = effect->u.ramp.envelope.attack_length >> 8;
1923 params[12] = effect->u.ramp.envelope.attack_length & 255;
1924 params[13] = effect->u.ramp.envelope.fade_level >> 7;
1925 params[14] = effect->u.ramp.envelope.fade_length >> 8;
1926 params[15] = effect->u.ramp.envelope.fade_length & 255;
1927 size = 16;
1928 dbg_hid("Uploading ramp force level=%d -> %d in dir %d = %d\n",
1929 effect->u.ramp.start_level,
1930 effect->u.ramp.end_level,
1931 effect->direction, force);
1932 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1933 effect->u.ramp.envelope.attack_level,
1934 effect->u.ramp.envelope.attack_length,
1935 effect->u.ramp.envelope.fade_level,
1936 effect->u.ramp.envelope.fade_length);
1937 break;
1938 case FF_FRICTION:
1939 case FF_INERTIA:
1940 case FF_SPRING:
1941 case FF_DAMPER:
1942 params[1] = HIDPP_FF_CONDITION_CMDS[effect->type - FF_SPRING];
1943 params[6] = effect->u.condition[0].left_saturation >> 9;
1944 params[7] = (effect->u.condition[0].left_saturation >> 1) & 255;
1945 params[8] = effect->u.condition[0].left_coeff >> 8;
1946 params[9] = effect->u.condition[0].left_coeff & 255;
1947 params[10] = effect->u.condition[0].deadband >> 9;
1948 params[11] = (effect->u.condition[0].deadband >> 1) & 255;
1949 params[12] = effect->u.condition[0].center >> 8;
1950 params[13] = effect->u.condition[0].center & 255;
1951 params[14] = effect->u.condition[0].right_coeff >> 8;
1952 params[15] = effect->u.condition[0].right_coeff & 255;
1953 params[16] = effect->u.condition[0].right_saturation >> 9;
1954 params[17] = (effect->u.condition[0].right_saturation >> 1) & 255;
1955 size = 18;
1956 dbg_hid("Uploading %s force left coeff=%d, left sat=%d, right coeff=%d, right sat=%d\n",
1957 HIDPP_FF_CONDITION_NAMES[effect->type - FF_SPRING],
1958 effect->u.condition[0].left_coeff,
1959 effect->u.condition[0].left_saturation,
1960 effect->u.condition[0].right_coeff,
1961 effect->u.condition[0].right_saturation);
1962 dbg_hid(" deadband=%d, center=%d\n",
1963 effect->u.condition[0].deadband,
1964 effect->u.condition[0].center);
1965 break;
1966 default:
1967 hid_err(data->hidpp->hid_dev, "Unexpected force type %i!\n", effect->type);
1968 return -EINVAL;
1969 }
1970
1971 return hidpp_ff_queue_work(data, effect->id, HIDPP_FF_DOWNLOAD_EFFECT, params, size);
1972 }
1973
1974 static int hidpp_ff_playback(struct input_dev *dev, int effect_id, int value)
1975 {
1976 struct hidpp_ff_private_data *data = dev->ff->private;
1977 u8 params[2];
1978
1979 params[1] = value ? HIDPP_FF_EFFECT_STATE_PLAY : HIDPP_FF_EFFECT_STATE_STOP;
1980
1981 dbg_hid("St%sing playback of effect %d.\n", value?"art":"opp", effect_id);
1982
1983 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_SET_EFFECT_STATE, params, ARRAY_SIZE(params));
1984 }
1985
1986 static int hidpp_ff_erase_effect(struct input_dev *dev, int effect_id)
1987 {
1988 struct hidpp_ff_private_data *data = dev->ff->private;
1989 u8 slot = 0;
1990
1991 dbg_hid("Erasing effect %d.\n", effect_id);
1992
1993 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_DESTROY_EFFECT, &slot, 1);
1994 }
1995
1996 static void hidpp_ff_set_autocenter(struct input_dev *dev, u16 magnitude)
1997 {
1998 struct hidpp_ff_private_data *data = dev->ff->private;
1999 u8 params[18];
2000
2001 dbg_hid("Setting autocenter to %d.\n", magnitude);
2002
2003 /* start a standard spring effect */
2004 params[1] = HIDPP_FF_EFFECT_SPRING | HIDPP_FF_EFFECT_AUTOSTART;
2005 /* zero delay and duration */
2006 params[2] = params[3] = params[4] = params[5] = 0;
2007 /* set coeff to 25% of saturation */
2008 params[8] = params[14] = magnitude >> 11;
2009 params[9] = params[15] = (magnitude >> 3) & 255;
2010 params[6] = params[16] = magnitude >> 9;
2011 params[7] = params[17] = (magnitude >> 1) & 255;
2012 /* zero deadband and center */
2013 params[10] = params[11] = params[12] = params[13] = 0;
2014
2015 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_AUTOCENTER, HIDPP_FF_DOWNLOAD_EFFECT, params, ARRAY_SIZE(params));
2016 }
2017
2018 static void hidpp_ff_set_gain(struct input_dev *dev, u16 gain)
2019 {
2020 struct hidpp_ff_private_data *data = dev->ff->private;
2021 u8 params[4];
2022
2023 dbg_hid("Setting gain to %d.\n", gain);
2024
2025 params[0] = gain >> 8;
2026 params[1] = gain & 255;
2027 params[2] = 0; /* no boost */
2028 params[3] = 0;
2029
2030 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_NONE, HIDPP_FF_SET_GLOBAL_GAINS, params, ARRAY_SIZE(params));
2031 }
2032
2033 static ssize_t hidpp_ff_range_show(struct device *dev, struct device_attribute *attr, char *buf)
2034 {
2035 struct hid_device *hid = to_hid_device(dev);
2036 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2037 struct input_dev *idev = hidinput->input;
2038 struct hidpp_ff_private_data *data = idev->ff->private;
2039
2040 return scnprintf(buf, PAGE_SIZE, "%u\n", data->range);
2041 }
2042
2043 static ssize_t hidpp_ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
2044 {
2045 struct hid_device *hid = to_hid_device(dev);
2046 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2047 struct input_dev *idev = hidinput->input;
2048 struct hidpp_ff_private_data *data = idev->ff->private;
2049 u8 params[2];
2050 int range = simple_strtoul(buf, NULL, 10);
2051
2052 range = clamp(range, 180, 900);
2053
2054 params[0] = range >> 8;
2055 params[1] = range & 0x00FF;
2056
2057 hidpp_ff_queue_work(data, -1, HIDPP_FF_SET_APERTURE, params, ARRAY_SIZE(params));
2058
2059 return count;
2060 }
2061
2062 static DEVICE_ATTR(range, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, hidpp_ff_range_show, hidpp_ff_range_store);
2063
2064 static void hidpp_ff_destroy(struct ff_device *ff)
2065 {
2066 struct hidpp_ff_private_data *data = ff->private;
2067
2068 kfree(data->effect_ids);
2069 }
2070
2071 static int hidpp_ff_init(struct hidpp_device *hidpp, u8 feature_index)
2072 {
2073 struct hid_device *hid = hidpp->hid_dev;
2074 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2075 struct input_dev *dev = hidinput->input;
2076 const struct usb_device_descriptor *udesc = &(hid_to_usb_dev(hid)->descriptor);
2077 const u16 bcdDevice = le16_to_cpu(udesc->bcdDevice);
2078 struct ff_device *ff;
2079 struct hidpp_report response;
2080 struct hidpp_ff_private_data *data;
2081 int error, j, num_slots;
2082 u8 version;
2083
2084 if (!dev) {
2085 hid_err(hid, "Struct input_dev not set!\n");
2086 return -EINVAL;
2087 }
2088
2089 /* Get firmware release */
2090 version = bcdDevice & 255;
2091
2092 /* Set supported force feedback capabilities */
2093 for (j = 0; hidpp_ff_effects[j] >= 0; j++)
2094 set_bit(hidpp_ff_effects[j], dev->ffbit);
2095 if (version > 1)
2096 for (j = 0; hidpp_ff_effects_v2[j] >= 0; j++)
2097 set_bit(hidpp_ff_effects_v2[j], dev->ffbit);
2098
2099 /* Read number of slots available in device */
2100 error = hidpp_send_fap_command_sync(hidpp, feature_index,
2101 HIDPP_FF_GET_INFO, NULL, 0, &response);
2102 if (error) {
2103 if (error < 0)
2104 return error;
2105 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
2106 __func__, error);
2107 return -EPROTO;
2108 }
2109
2110 num_slots = response.fap.params[0] - HIDPP_FF_RESERVED_SLOTS;
2111
2112 error = input_ff_create(dev, num_slots);
2113
2114 if (error) {
2115 hid_err(dev, "Failed to create FF device!\n");
2116 return error;
2117 }
2118
2119 data = kzalloc(sizeof(*data), GFP_KERNEL);
2120 if (!data)
2121 return -ENOMEM;
2122 data->effect_ids = kcalloc(num_slots, sizeof(int), GFP_KERNEL);
2123 if (!data->effect_ids) {
2124 kfree(data);
2125 return -ENOMEM;
2126 }
2127 data->wq = create_singlethread_workqueue("hidpp-ff-sendqueue");
2128 if (!data->wq) {
2129 kfree(data->effect_ids);
2130 kfree(data);
2131 return -ENOMEM;
2132 }
2133
2134 data->hidpp = hidpp;
2135 data->feature_index = feature_index;
2136 data->version = version;
2137 data->slot_autocenter = 0;
2138 data->num_effects = num_slots;
2139 for (j = 0; j < num_slots; j++)
2140 data->effect_ids[j] = -1;
2141
2142 ff = dev->ff;
2143 ff->private = data;
2144
2145 ff->upload = hidpp_ff_upload_effect;
2146 ff->erase = hidpp_ff_erase_effect;
2147 ff->playback = hidpp_ff_playback;
2148 ff->set_gain = hidpp_ff_set_gain;
2149 ff->set_autocenter = hidpp_ff_set_autocenter;
2150 ff->destroy = hidpp_ff_destroy;
2151
2152
2153 /* reset all forces */
2154 error = hidpp_send_fap_command_sync(hidpp, feature_index,
2155 HIDPP_FF_RESET_ALL, NULL, 0, &response);
2156
2157 /* Read current Range */
2158 error = hidpp_send_fap_command_sync(hidpp, feature_index,
2159 HIDPP_FF_GET_APERTURE, NULL, 0, &response);
2160 if (error)
2161 hid_warn(hidpp->hid_dev, "Failed to read range from device!\n");
2162 data->range = error ? 900 : get_unaligned_be16(&response.fap.params[0]);
2163
2164 /* Create sysfs interface */
2165 error = device_create_file(&(hidpp->hid_dev->dev), &dev_attr_range);
2166 if (error)
2167 hid_warn(hidpp->hid_dev, "Unable to create sysfs interface for \"range\", errno %d!\n", error);
2168
2169 /* Read the current gain values */
2170 error = hidpp_send_fap_command_sync(hidpp, feature_index,
2171 HIDPP_FF_GET_GLOBAL_GAINS, NULL, 0, &response);
2172 if (error)
2173 hid_warn(hidpp->hid_dev, "Failed to read gain values from device!\n");
2174 data->gain = error ? 0xffff : get_unaligned_be16(&response.fap.params[0]);
2175 /* ignore boost value at response.fap.params[2] */
2176
2177 /* init the hardware command queue */
2178 atomic_set(&data->workqueue_size, 0);
2179
2180 /* initialize with zero autocenter to get wheel in usable state */
2181 hidpp_ff_set_autocenter(dev, 0);
2182
2183 hid_info(hid, "Force feedback support loaded (firmware release %d).\n",
2184 version);
2185
2186 return 0;
2187 }
2188
2189 static int hidpp_ff_deinit(struct hid_device *hid)
2190 {
2191 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2192 struct input_dev *dev = hidinput->input;
2193 struct hidpp_ff_private_data *data;
2194
2195 if (!dev) {
2196 hid_err(hid, "Struct input_dev not found!\n");
2197 return -EINVAL;
2198 }
2199
2200 hid_info(hid, "Unloading HID++ force feedback.\n");
2201 data = dev->ff->private;
2202 if (!data) {
2203 hid_err(hid, "Private data not found!\n");
2204 return -EINVAL;
2205 }
2206
2207 destroy_workqueue(data->wq);
2208 device_remove_file(&hid->dev, &dev_attr_range);
2209
2210 return 0;
2211 }
2212
2213
2214 /* ************************************************************************** */
2215 /* */
2216 /* Device Support */
2217 /* */
2218 /* ************************************************************************** */
2219
2220 /* -------------------------------------------------------------------------- */
2221 /* Touchpad HID++ devices */
2222 /* -------------------------------------------------------------------------- */
2223
2224 #define WTP_MANUAL_RESOLUTION 39
2225
2226 struct wtp_data {
2227 struct input_dev *input;
2228 u16 x_size, y_size;
2229 u8 finger_count;
2230 u8 mt_feature_index;
2231 u8 button_feature_index;
2232 u8 maxcontacts;
2233 bool flip_y;
2234 unsigned int resolution;
2235 };
2236
2237 static int wtp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2238 struct hid_field *field, struct hid_usage *usage,
2239 unsigned long **bit, int *max)
2240 {
2241 return -1;
2242 }
2243
2244 static void wtp_populate_input(struct hidpp_device *hidpp,
2245 struct input_dev *input_dev, bool origin_is_hid_core)
2246 {
2247 struct wtp_data *wd = hidpp->private_data;
2248
2249 __set_bit(EV_ABS, input_dev->evbit);
2250 __set_bit(EV_KEY, input_dev->evbit);
2251 __clear_bit(EV_REL, input_dev->evbit);
2252 __clear_bit(EV_LED, input_dev->evbit);
2253
2254 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0, wd->x_size, 0, 0);
2255 input_abs_set_res(input_dev, ABS_MT_POSITION_X, wd->resolution);
2256 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0, wd->y_size, 0, 0);
2257 input_abs_set_res(input_dev, ABS_MT_POSITION_Y, wd->resolution);
2258
2259 /* Max pressure is not given by the devices, pick one */
2260 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 50, 0, 0);
2261
2262 input_set_capability(input_dev, EV_KEY, BTN_LEFT);
2263
2264 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS)
2265 input_set_capability(input_dev, EV_KEY, BTN_RIGHT);
2266 else
2267 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
2268
2269 input_mt_init_slots(input_dev, wd->maxcontacts, INPUT_MT_POINTER |
2270 INPUT_MT_DROP_UNUSED);
2271
2272 wd->input = input_dev;
2273 }
2274
2275 static void wtp_touch_event(struct wtp_data *wd,
2276 struct hidpp_touchpad_raw_xy_finger *touch_report)
2277 {
2278 int slot;
2279
2280 if (!touch_report->finger_id || touch_report->contact_type)
2281 /* no actual data */
2282 return;
2283
2284 slot = input_mt_get_slot_by_key(wd->input, touch_report->finger_id);
2285
2286 input_mt_slot(wd->input, slot);
2287 input_mt_report_slot_state(wd->input, MT_TOOL_FINGER,
2288 touch_report->contact_status);
2289 if (touch_report->contact_status) {
2290 input_event(wd->input, EV_ABS, ABS_MT_POSITION_X,
2291 touch_report->x);
2292 input_event(wd->input, EV_ABS, ABS_MT_POSITION_Y,
2293 wd->flip_y ? wd->y_size - touch_report->y :
2294 touch_report->y);
2295 input_event(wd->input, EV_ABS, ABS_MT_PRESSURE,
2296 touch_report->area);
2297 }
2298 }
2299
2300 static void wtp_send_raw_xy_event(struct hidpp_device *hidpp,
2301 struct hidpp_touchpad_raw_xy *raw)
2302 {
2303 struct wtp_data *wd = hidpp->private_data;
2304 int i;
2305
2306 for (i = 0; i < 2; i++)
2307 wtp_touch_event(wd, &(raw->fingers[i]));
2308
2309 if (raw->end_of_frame &&
2310 !(hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS))
2311 input_event(wd->input, EV_KEY, BTN_LEFT, raw->button);
2312
2313 if (raw->end_of_frame || raw->finger_count <= 2) {
2314 input_mt_sync_frame(wd->input);
2315 input_sync(wd->input);
2316 }
2317 }
2318
2319 static int wtp_mouse_raw_xy_event(struct hidpp_device *hidpp, u8 *data)
2320 {
2321 struct wtp_data *wd = hidpp->private_data;
2322 u8 c1_area = ((data[7] & 0xf) * (data[7] & 0xf) +
2323 (data[7] >> 4) * (data[7] >> 4)) / 2;
2324 u8 c2_area = ((data[13] & 0xf) * (data[13] & 0xf) +
2325 (data[13] >> 4) * (data[13] >> 4)) / 2;
2326 struct hidpp_touchpad_raw_xy raw = {
2327 .timestamp = data[1],
2328 .fingers = {
2329 {
2330 .contact_type = 0,
2331 .contact_status = !!data[7],
2332 .x = get_unaligned_le16(&data[3]),
2333 .y = get_unaligned_le16(&data[5]),
2334 .z = c1_area,
2335 .area = c1_area,
2336 .finger_id = data[2],
2337 }, {
2338 .contact_type = 0,
2339 .contact_status = !!data[13],
2340 .x = get_unaligned_le16(&data[9]),
2341 .y = get_unaligned_le16(&data[11]),
2342 .z = c2_area,
2343 .area = c2_area,
2344 .finger_id = data[8],
2345 }
2346 },
2347 .finger_count = wd->maxcontacts,
2348 .spurious_flag = 0,
2349 .end_of_frame = (data[0] >> 7) == 0,
2350 .button = data[0] & 0x01,
2351 };
2352
2353 wtp_send_raw_xy_event(hidpp, &raw);
2354
2355 return 1;
2356 }
2357
2358 static int wtp_raw_event(struct hid_device *hdev, u8 *data, int size)
2359 {
2360 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2361 struct wtp_data *wd = hidpp->private_data;
2362 struct hidpp_report *report = (struct hidpp_report *)data;
2363 struct hidpp_touchpad_raw_xy raw;
2364
2365 if (!wd || !wd->input)
2366 return 1;
2367
2368 switch (data[0]) {
2369 case 0x02:
2370 if (size < 2) {
2371 hid_err(hdev, "Received HID report of bad size (%d)",
2372 size);
2373 return 1;
2374 }
2375 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS) {
2376 input_event(wd->input, EV_KEY, BTN_LEFT,
2377 !!(data[1] & 0x01));
2378 input_event(wd->input, EV_KEY, BTN_RIGHT,
2379 !!(data[1] & 0x02));
2380 input_sync(wd->input);
2381 return 0;
2382 } else {
2383 if (size < 21)
2384 return 1;
2385 return wtp_mouse_raw_xy_event(hidpp, &data[7]);
2386 }
2387 case REPORT_ID_HIDPP_LONG:
2388 /* size is already checked in hidpp_raw_event. */
2389 if ((report->fap.feature_index != wd->mt_feature_index) ||
2390 (report->fap.funcindex_clientid != EVENT_TOUCHPAD_RAW_XY))
2391 return 1;
2392 hidpp_touchpad_raw_xy_event(hidpp, data + 4, &raw);
2393
2394 wtp_send_raw_xy_event(hidpp, &raw);
2395 return 0;
2396 }
2397
2398 return 0;
2399 }
2400
2401 static int wtp_get_config(struct hidpp_device *hidpp)
2402 {
2403 struct wtp_data *wd = hidpp->private_data;
2404 struct hidpp_touchpad_raw_info raw_info = {0};
2405 u8 feature_type;
2406 int ret;
2407
2408 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_TOUCHPAD_RAW_XY,
2409 &wd->mt_feature_index, &feature_type);
2410 if (ret)
2411 /* means that the device is not powered up */
2412 return ret;
2413
2414 ret = hidpp_touchpad_get_raw_info(hidpp, wd->mt_feature_index,
2415 &raw_info);
2416 if (ret)
2417 return ret;
2418
2419 wd->x_size = raw_info.x_size;
2420 wd->y_size = raw_info.y_size;
2421 wd->maxcontacts = raw_info.maxcontacts;
2422 wd->flip_y = raw_info.origin == TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT;
2423 wd->resolution = raw_info.res;
2424 if (!wd->resolution)
2425 wd->resolution = WTP_MANUAL_RESOLUTION;
2426
2427 return 0;
2428 }
2429
2430 static int wtp_allocate(struct hid_device *hdev, const struct hid_device_id *id)
2431 {
2432 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2433 struct wtp_data *wd;
2434
2435 wd = devm_kzalloc(&hdev->dev, sizeof(struct wtp_data),
2436 GFP_KERNEL);
2437 if (!wd)
2438 return -ENOMEM;
2439
2440 hidpp->private_data = wd;
2441
2442 return 0;
2443 };
2444
2445 static int wtp_connect(struct hid_device *hdev, bool connected)
2446 {
2447 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2448 struct wtp_data *wd = hidpp->private_data;
2449 int ret;
2450
2451 if (!wd->x_size) {
2452 ret = wtp_get_config(hidpp);
2453 if (ret) {
2454 hid_err(hdev, "Can not get wtp config: %d\n", ret);
2455 return ret;
2456 }
2457 }
2458
2459 return hidpp_touchpad_set_raw_report_state(hidpp, wd->mt_feature_index,
2460 true, true);
2461 }
2462
2463 /* ------------------------------------------------------------------------- */
2464 /* Logitech M560 devices */
2465 /* ------------------------------------------------------------------------- */
2466
2467 /*
2468 * Logitech M560 protocol overview
2469 *
2470 * The Logitech M560 mouse, is designed for windows 8. When the middle and/or
2471 * the sides buttons are pressed, it sends some keyboard keys events
2472 * instead of buttons ones.
2473 * To complicate things further, the middle button keys sequence
2474 * is different from the odd press and the even press.
2475 *
2476 * forward button -> Super_R
2477 * backward button -> Super_L+'d' (press only)
2478 * middle button -> 1st time: Alt_L+SuperL+XF86TouchpadOff (press only)
2479 * 2nd time: left-click (press only)
2480 * NB: press-only means that when the button is pressed, the
2481 * KeyPress/ButtonPress and KeyRelease/ButtonRelease events are generated
2482 * together sequentially; instead when the button is released, no event is
2483 * generated !
2484 *
2485 * With the command
2486 * 10<xx>0a 3500af03 (where <xx> is the mouse id),
2487 * the mouse reacts differently:
2488 * - it never sends a keyboard key event
2489 * - for the three mouse button it sends:
2490 * middle button press 11<xx>0a 3500af00...
2491 * side 1 button (forward) press 11<xx>0a 3500b000...
2492 * side 2 button (backward) press 11<xx>0a 3500ae00...
2493 * middle/side1/side2 button release 11<xx>0a 35000000...
2494 */
2495
2496 static const u8 m560_config_parameter[] = {0x00, 0xaf, 0x03};
2497
2498 struct m560_private_data {
2499 struct input_dev *input;
2500 };
2501
2502 /* how buttons are mapped in the report */
2503 #define M560_MOUSE_BTN_LEFT 0x01
2504 #define M560_MOUSE_BTN_RIGHT 0x02
2505 #define M560_MOUSE_BTN_WHEEL_LEFT 0x08
2506 #define M560_MOUSE_BTN_WHEEL_RIGHT 0x10
2507
2508 #define M560_SUB_ID 0x0a
2509 #define M560_BUTTON_MODE_REGISTER 0x35
2510
2511 static int m560_send_config_command(struct hid_device *hdev, bool connected)
2512 {
2513 struct hidpp_report response;
2514 struct hidpp_device *hidpp_dev;
2515
2516 hidpp_dev = hid_get_drvdata(hdev);
2517
2518 return hidpp_send_rap_command_sync(
2519 hidpp_dev,
2520 REPORT_ID_HIDPP_SHORT,
2521 M560_SUB_ID,
2522 M560_BUTTON_MODE_REGISTER,
2523 (u8 *)m560_config_parameter,
2524 sizeof(m560_config_parameter),
2525 &response
2526 );
2527 }
2528
2529 static int m560_allocate(struct hid_device *hdev)
2530 {
2531 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2532 struct m560_private_data *d;
2533
2534 d = devm_kzalloc(&hdev->dev, sizeof(struct m560_private_data),
2535 GFP_KERNEL);
2536 if (!d)
2537 return -ENOMEM;
2538
2539 hidpp->private_data = d;
2540
2541 return 0;
2542 };
2543
2544 static int m560_raw_event(struct hid_device *hdev, u8 *data, int size)
2545 {
2546 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2547 struct m560_private_data *mydata = hidpp->private_data;
2548
2549 /* sanity check */
2550 if (!mydata || !mydata->input) {
2551 hid_err(hdev, "error in parameter\n");
2552 return -EINVAL;
2553 }
2554
2555 if (size < 7) {
2556 hid_err(hdev, "error in report\n");
2557 return 0;
2558 }
2559
2560 if (data[0] == REPORT_ID_HIDPP_LONG &&
2561 data[2] == M560_SUB_ID && data[6] == 0x00) {
2562 /*
2563 * m560 mouse report for middle, forward and backward button
2564 *
2565 * data[0] = 0x11
2566 * data[1] = device-id
2567 * data[2] = 0x0a
2568 * data[5] = 0xaf -> middle
2569 * 0xb0 -> forward
2570 * 0xae -> backward
2571 * 0x00 -> release all
2572 * data[6] = 0x00
2573 */
2574
2575 switch (data[5]) {
2576 case 0xaf:
2577 input_report_key(mydata->input, BTN_MIDDLE, 1);
2578 break;
2579 case 0xb0:
2580 input_report_key(mydata->input, BTN_FORWARD, 1);
2581 break;
2582 case 0xae:
2583 input_report_key(mydata->input, BTN_BACK, 1);
2584 break;
2585 case 0x00:
2586 input_report_key(mydata->input, BTN_BACK, 0);
2587 input_report_key(mydata->input, BTN_FORWARD, 0);
2588 input_report_key(mydata->input, BTN_MIDDLE, 0);
2589 break;
2590 default:
2591 hid_err(hdev, "error in report\n");
2592 return 0;
2593 }
2594 input_sync(mydata->input);
2595
2596 } else if (data[0] == 0x02) {
2597 /*
2598 * Logitech M560 mouse report
2599 *
2600 * data[0] = type (0x02)
2601 * data[1..2] = buttons
2602 * data[3..5] = xy
2603 * data[6] = wheel
2604 */
2605
2606 int v;
2607
2608 input_report_key(mydata->input, BTN_LEFT,
2609 !!(data[1] & M560_MOUSE_BTN_LEFT));
2610 input_report_key(mydata->input, BTN_RIGHT,
2611 !!(data[1] & M560_MOUSE_BTN_RIGHT));
2612
2613 if (data[1] & M560_MOUSE_BTN_WHEEL_LEFT) {
2614 input_report_rel(mydata->input, REL_HWHEEL, -1);
2615 input_report_rel(mydata->input, REL_HWHEEL_HI_RES,
2616 -120);
2617 } else if (data[1] & M560_MOUSE_BTN_WHEEL_RIGHT) {
2618 input_report_rel(mydata->input, REL_HWHEEL, 1);
2619 input_report_rel(mydata->input, REL_HWHEEL_HI_RES,
2620 120);
2621 }
2622
2623 v = hid_snto32(hid_field_extract(hdev, data+3, 0, 12), 12);
2624 input_report_rel(mydata->input, REL_X, v);
2625
2626 v = hid_snto32(hid_field_extract(hdev, data+3, 12, 12), 12);
2627 input_report_rel(mydata->input, REL_Y, v);
2628
2629 v = hid_snto32(data[6], 8);
2630 if (v != 0)
2631 hidpp_scroll_counter_handle_scroll(
2632 &hidpp->vertical_wheel_counter, v);
2633
2634 input_sync(mydata->input);
2635 }
2636
2637 return 1;
2638 }
2639
2640 static void m560_populate_input(struct hidpp_device *hidpp,
2641 struct input_dev *input_dev, bool origin_is_hid_core)
2642 {
2643 struct m560_private_data *mydata = hidpp->private_data;
2644
2645 mydata->input = input_dev;
2646
2647 __set_bit(EV_KEY, mydata->input->evbit);
2648 __set_bit(BTN_MIDDLE, mydata->input->keybit);
2649 __set_bit(BTN_RIGHT, mydata->input->keybit);
2650 __set_bit(BTN_LEFT, mydata->input->keybit);
2651 __set_bit(BTN_BACK, mydata->input->keybit);
2652 __set_bit(BTN_FORWARD, mydata->input->keybit);
2653
2654 __set_bit(EV_REL, mydata->input->evbit);
2655 __set_bit(REL_X, mydata->input->relbit);
2656 __set_bit(REL_Y, mydata->input->relbit);
2657 __set_bit(REL_WHEEL, mydata->input->relbit);
2658 __set_bit(REL_HWHEEL, mydata->input->relbit);
2659 __set_bit(REL_WHEEL_HI_RES, mydata->input->relbit);
2660 __set_bit(REL_HWHEEL_HI_RES, mydata->input->relbit);
2661 }
2662
2663 static int m560_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2664 struct hid_field *field, struct hid_usage *usage,
2665 unsigned long **bit, int *max)
2666 {
2667 return -1;
2668 }
2669
2670 /* ------------------------------------------------------------------------- */
2671 /* Logitech K400 devices */
2672 /* ------------------------------------------------------------------------- */
2673
2674 /*
2675 * The Logitech K400 keyboard has an embedded touchpad which is seen
2676 * as a mouse from the OS point of view. There is a hardware shortcut to disable
2677 * tap-to-click but the setting is not remembered accross reset, annoying some
2678 * users.
2679 *
2680 * We can toggle this feature from the host by using the feature 0x6010:
2681 * Touchpad FW items
2682 */
2683
2684 struct k400_private_data {
2685 u8 feature_index;
2686 };
2687
2688 static int k400_disable_tap_to_click(struct hidpp_device *hidpp)
2689 {
2690 struct k400_private_data *k400 = hidpp->private_data;
2691 struct hidpp_touchpad_fw_items items = {};
2692 int ret;
2693 u8 feature_type;
2694
2695 if (!k400->feature_index) {
2696 ret = hidpp_root_get_feature(hidpp,
2697 HIDPP_PAGE_TOUCHPAD_FW_ITEMS,
2698 &k400->feature_index, &feature_type);
2699 if (ret)
2700 /* means that the device is not powered up */
2701 return ret;
2702 }
2703
2704 ret = hidpp_touchpad_fw_items_set(hidpp, k400->feature_index, &items);
2705 if (ret)
2706 return ret;
2707
2708 return 0;
2709 }
2710
2711 static int k400_allocate(struct hid_device *hdev)
2712 {
2713 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2714 struct k400_private_data *k400;
2715
2716 k400 = devm_kzalloc(&hdev->dev, sizeof(struct k400_private_data),
2717 GFP_KERNEL);
2718 if (!k400)
2719 return -ENOMEM;
2720
2721 hidpp->private_data = k400;
2722
2723 return 0;
2724 };
2725
2726 static int k400_connect(struct hid_device *hdev, bool connected)
2727 {
2728 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2729
2730 if (!disable_tap_to_click)
2731 return 0;
2732
2733 return k400_disable_tap_to_click(hidpp);
2734 }
2735
2736 /* ------------------------------------------------------------------------- */
2737 /* Logitech G920 Driving Force Racing Wheel for Xbox One */
2738 /* ------------------------------------------------------------------------- */
2739
2740 #define HIDPP_PAGE_G920_FORCE_FEEDBACK 0x8123
2741
2742 static int g920_get_config(struct hidpp_device *hidpp)
2743 {
2744 u8 feature_type;
2745 u8 feature_index;
2746 int ret;
2747
2748 /* Find feature and store for later use */
2749 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_G920_FORCE_FEEDBACK,
2750 &feature_index, &feature_type);
2751 if (ret)
2752 return ret;
2753
2754 ret = hidpp_ff_init(hidpp, feature_index);
2755 if (ret)
2756 hid_warn(hidpp->hid_dev, "Unable to initialize force feedback support, errno %d\n",
2757 ret);
2758
2759 return 0;
2760 }
2761
2762 /* -------------------------------------------------------------------------- */
2763 /* High-resolution scroll wheels */
2764 /* -------------------------------------------------------------------------- */
2765
2766 static int hi_res_scroll_enable(struct hidpp_device *hidpp)
2767 {
2768 int ret;
2769 u8 multiplier = 1;
2770
2771 if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_X2121) {
2772 ret = hidpp_hrw_set_wheel_mode(hidpp, false, true, false);
2773 if (ret == 0)
2774 ret = hidpp_hrw_get_wheel_capability(hidpp, &multiplier);
2775 } else if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_X2120) {
2776 ret = hidpp_hrs_set_highres_scrolling_mode(hidpp, true,
2777 &multiplier);
2778 } else /* if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_1P0) */ {
2779 ret = hidpp10_enable_scrolling_acceleration(hidpp);
2780 multiplier = 8;
2781 }
2782 if (ret)
2783 return ret;
2784
2785 if (multiplier == 0)
2786 multiplier = 1;
2787
2788 hidpp->vertical_wheel_counter.wheel_multiplier = multiplier;
2789 hid_info(hidpp->hid_dev, "multiplier = %d\n", multiplier);
2790 return 0;
2791 }
2792
2793 /* -------------------------------------------------------------------------- */
2794 /* Generic HID++ devices */
2795 /* -------------------------------------------------------------------------- */
2796
2797 static int hidpp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2798 struct hid_field *field, struct hid_usage *usage,
2799 unsigned long **bit, int *max)
2800 {
2801 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2802
2803 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2804 return wtp_input_mapping(hdev, hi, field, usage, bit, max);
2805 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560 &&
2806 field->application != HID_GD_MOUSE)
2807 return m560_input_mapping(hdev, hi, field, usage, bit, max);
2808
2809 return 0;
2810 }
2811
2812 static int hidpp_input_mapped(struct hid_device *hdev, struct hid_input *hi,
2813 struct hid_field *field, struct hid_usage *usage,
2814 unsigned long **bit, int *max)
2815 {
2816 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2817
2818 /* Ensure that Logitech G920 is not given a default fuzz/flat value */
2819 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
2820 if (usage->type == EV_ABS && (usage->code == ABS_X ||
2821 usage->code == ABS_Y || usage->code == ABS_Z ||
2822 usage->code == ABS_RZ)) {
2823 field->application = HID_GD_MULTIAXIS;
2824 }
2825 }
2826
2827 return 0;
2828 }
2829
2830
2831 static void hidpp_populate_input(struct hidpp_device *hidpp,
2832 struct input_dev *input, bool origin_is_hid_core)
2833 {
2834 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2835 wtp_populate_input(hidpp, input, origin_is_hid_core);
2836 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
2837 m560_populate_input(hidpp, input, origin_is_hid_core);
2838
2839 if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL)
2840 hidpp->vertical_wheel_counter.dev = input;
2841 }
2842
2843 static int hidpp_input_configured(struct hid_device *hdev,
2844 struct hid_input *hidinput)
2845 {
2846 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2847 struct input_dev *input = hidinput->input;
2848
2849 hidpp_populate_input(hidpp, input, true);
2850
2851 return 0;
2852 }
2853
2854 static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
2855 int size)
2856 {
2857 struct hidpp_report *question = hidpp->send_receive_buf;
2858 struct hidpp_report *answer = hidpp->send_receive_buf;
2859 struct hidpp_report *report = (struct hidpp_report *)data;
2860 int ret;
2861
2862 /*
2863 * If the mutex is locked then we have a pending answer from a
2864 * previously sent command.
2865 */
2866 if (unlikely(mutex_is_locked(&hidpp->send_mutex))) {
2867 /*
2868 * Check for a correct hidpp20 answer or the corresponding
2869 * error
2870 */
2871 if (hidpp_match_answer(question, report) ||
2872 hidpp_match_error(question, report)) {
2873 *answer = *report;
2874 hidpp->answer_available = true;
2875 wake_up(&hidpp->wait);
2876 /*
2877 * This was an answer to a command that this driver sent
2878 * We return 1 to hid-core to avoid forwarding the
2879 * command upstream as it has been treated by the driver
2880 */
2881
2882 return 1;
2883 }
2884 }
2885
2886 if (unlikely(hidpp_report_is_connect_event(report))) {
2887 atomic_set(&hidpp->connected,
2888 !(report->rap.params[0] & (1 << 6)));
2889 if (schedule_work(&hidpp->work) == 0)
2890 dbg_hid("%s: connect event already queued\n", __func__);
2891 return 1;
2892 }
2893
2894 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
2895 ret = hidpp20_battery_event(hidpp, data, size);
2896 if (ret != 0)
2897 return ret;
2898 ret = hidpp_solar_battery_event(hidpp, data, size);
2899 if (ret != 0)
2900 return ret;
2901 }
2902
2903 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP10_BATTERY) {
2904 ret = hidpp10_battery_event(hidpp, data, size);
2905 if (ret != 0)
2906 return ret;
2907 }
2908
2909 return 0;
2910 }
2911
2912 static int hidpp_raw_event(struct hid_device *hdev, struct hid_report *report,
2913 u8 *data, int size)
2914 {
2915 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2916 int ret = 0;
2917
2918 /* Generic HID++ processing. */
2919 switch (data[0]) {
2920 case REPORT_ID_HIDPP_VERY_LONG:
2921 if (size != HIDPP_REPORT_VERY_LONG_LENGTH) {
2922 hid_err(hdev, "received hid++ report of bad size (%d)",
2923 size);
2924 return 1;
2925 }
2926 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2927 break;
2928 case REPORT_ID_HIDPP_LONG:
2929 if (size != HIDPP_REPORT_LONG_LENGTH) {
2930 hid_err(hdev, "received hid++ report of bad size (%d)",
2931 size);
2932 return 1;
2933 }
2934 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2935 break;
2936 case REPORT_ID_HIDPP_SHORT:
2937 if (size != HIDPP_REPORT_SHORT_LENGTH) {
2938 hid_err(hdev, "received hid++ report of bad size (%d)",
2939 size);
2940 return 1;
2941 }
2942 ret = hidpp_raw_hidpp_event(hidpp, data, size);
2943 break;
2944 }
2945
2946 /* If no report is available for further processing, skip calling
2947 * raw_event of subclasses. */
2948 if (ret != 0)
2949 return ret;
2950
2951 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
2952 return wtp_raw_event(hdev, data, size);
2953 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
2954 return m560_raw_event(hdev, data, size);
2955
2956 return 0;
2957 }
2958
2959 static int hidpp_event(struct hid_device *hdev, struct hid_field *field,
2960 struct hid_usage *usage, __s32 value)
2961 {
2962 /* This function will only be called for scroll events, due to the
2963 * restriction imposed in hidpp_usages.
2964 */
2965 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2966 struct hidpp_scroll_counter *counter = &hidpp->vertical_wheel_counter;
2967 /* A scroll event may occur before the multiplier has been retrieved or
2968 * the input device set, or high-res scroll enabling may fail. In such
2969 * cases we must return early (falling back to default behaviour) to
2970 * avoid a crash in hidpp_scroll_counter_handle_scroll.
2971 */
2972 if (!(hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL) || value == 0
2973 || counter->dev == NULL || counter->wheel_multiplier == 0)
2974 return 0;
2975
2976 hidpp_scroll_counter_handle_scroll(counter, value);
2977 return 1;
2978 }
2979
2980 static int hidpp_initialize_battery(struct hidpp_device *hidpp)
2981 {
2982 static atomic_t battery_no = ATOMIC_INIT(0);
2983 struct power_supply_config cfg = { .drv_data = hidpp };
2984 struct power_supply_desc *desc = &hidpp->battery.desc;
2985 enum power_supply_property *battery_props;
2986 struct hidpp_battery *battery;
2987 unsigned int num_battery_props;
2988 unsigned long n;
2989 int ret;
2990
2991 if (hidpp->battery.ps)
2992 return 0;
2993
2994 hidpp->battery.feature_index = 0xff;
2995 hidpp->battery.solar_feature_index = 0xff;
2996
2997 if (hidpp->protocol_major >= 2) {
2998 if (hidpp->quirks & HIDPP_QUIRK_CLASS_K750)
2999 ret = hidpp_solar_request_battery_event(hidpp);
3000 else
3001 ret = hidpp20_query_battery_info(hidpp);
3002
3003 if (ret)
3004 return ret;
3005 hidpp->capabilities |= HIDPP_CAPABILITY_HIDPP20_BATTERY;
3006 } else {
3007 ret = hidpp10_query_battery_status(hidpp);
3008 if (ret) {
3009 ret = hidpp10_query_battery_mileage(hidpp);
3010 if (ret)
3011 return -ENOENT;
3012 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
3013 } else {
3014 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS;
3015 }
3016 hidpp->capabilities |= HIDPP_CAPABILITY_HIDPP10_BATTERY;
3017 }
3018
3019 battery_props = devm_kmemdup(&hidpp->hid_dev->dev,
3020 hidpp_battery_props,
3021 sizeof(hidpp_battery_props),
3022 GFP_KERNEL);
3023 if (!battery_props)
3024 return -ENOMEM;
3025
3026 num_battery_props = ARRAY_SIZE(hidpp_battery_props) - 2;
3027
3028 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_MILEAGE)
3029 battery_props[num_battery_props++] =
3030 POWER_SUPPLY_PROP_CAPACITY;
3031
3032 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS)
3033 battery_props[num_battery_props++] =
3034 POWER_SUPPLY_PROP_CAPACITY_LEVEL;
3035
3036 battery = &hidpp->battery;
3037
3038 n = atomic_inc_return(&battery_no) - 1;
3039 desc->properties = battery_props;
3040 desc->num_properties = num_battery_props;
3041 desc->get_property = hidpp_battery_get_property;
3042 sprintf(battery->name, "hidpp_battery_%ld", n);
3043 desc->name = battery->name;
3044 desc->type = POWER_SUPPLY_TYPE_BATTERY;
3045 desc->use_for_apm = 0;
3046
3047 battery->ps = devm_power_supply_register(&hidpp->hid_dev->dev,
3048 &battery->desc,
3049 &cfg);
3050 if (IS_ERR(battery->ps))
3051 return PTR_ERR(battery->ps);
3052
3053 power_supply_powers(battery->ps, &hidpp->hid_dev->dev);
3054
3055 return ret;
3056 }
3057
3058 static void hidpp_overwrite_name(struct hid_device *hdev)
3059 {
3060 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3061 char *name;
3062
3063 if (hidpp->protocol_major < 2)
3064 return;
3065
3066 name = hidpp_get_device_name(hidpp);
3067
3068 if (!name) {
3069 hid_err(hdev, "unable to retrieve the name of the device");
3070 } else {
3071 dbg_hid("HID++: Got name: %s\n", name);
3072 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
3073 }
3074
3075 kfree(name);
3076 }
3077
3078 static int hidpp_input_open(struct input_dev *dev)
3079 {
3080 struct hid_device *hid = input_get_drvdata(dev);
3081
3082 return hid_hw_open(hid);
3083 }
3084
3085 static void hidpp_input_close(struct input_dev *dev)
3086 {
3087 struct hid_device *hid = input_get_drvdata(dev);
3088
3089 hid_hw_close(hid);
3090 }
3091
3092 static struct input_dev *hidpp_allocate_input(struct hid_device *hdev)
3093 {
3094 struct input_dev *input_dev = devm_input_allocate_device(&hdev->dev);
3095 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3096
3097 if (!input_dev)
3098 return NULL;
3099
3100 input_set_drvdata(input_dev, hdev);
3101 input_dev->open = hidpp_input_open;
3102 input_dev->close = hidpp_input_close;
3103
3104 input_dev->name = hidpp->name;
3105 input_dev->phys = hdev->phys;
3106 input_dev->uniq = hdev->uniq;
3107 input_dev->id.bustype = hdev->bus;
3108 input_dev->id.vendor = hdev->vendor;
3109 input_dev->id.product = hdev->product;
3110 input_dev->id.version = hdev->version;
3111 input_dev->dev.parent = &hdev->dev;
3112
3113 return input_dev;
3114 }
3115
3116 static void hidpp_connect_event(struct hidpp_device *hidpp)
3117 {
3118 struct hid_device *hdev = hidpp->hid_dev;
3119 int ret = 0;
3120 bool connected = atomic_read(&hidpp->connected);
3121 struct input_dev *input;
3122 char *name, *devm_name;
3123
3124 if (!connected) {
3125 if (hidpp->battery.ps) {
3126 hidpp->battery.online = false;
3127 hidpp->battery.status = POWER_SUPPLY_STATUS_UNKNOWN;
3128 hidpp->battery.level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
3129 power_supply_changed(hidpp->battery.ps);
3130 }
3131 return;
3132 }
3133
3134 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
3135 ret = wtp_connect(hdev, connected);
3136 if (ret)
3137 return;
3138 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560) {
3139 ret = m560_send_config_command(hdev, connected);
3140 if (ret)
3141 return;
3142 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
3143 ret = k400_connect(hdev, connected);
3144 if (ret)
3145 return;
3146 }
3147
3148 /* the device is already connected, we can ask for its name and
3149 * protocol */
3150 if (!hidpp->protocol_major) {
3151 ret = !hidpp_is_connected(hidpp);
3152 if (ret) {
3153 hid_err(hdev, "Can not get the protocol version.\n");
3154 return;
3155 }
3156 hid_info(hdev, "HID++ %u.%u device connected.\n",
3157 hidpp->protocol_major, hidpp->protocol_minor);
3158 }
3159
3160 if (hidpp->name == hdev->name && hidpp->protocol_major >= 2) {
3161 name = hidpp_get_device_name(hidpp);
3162 if (!name) {
3163 hid_err(hdev,
3164 "unable to retrieve the name of the device");
3165 return;
3166 }
3167
3168 devm_name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s", name);
3169 kfree(name);
3170 if (!devm_name)
3171 return;
3172
3173 hidpp->name = devm_name;
3174 }
3175
3176 hidpp_initialize_battery(hidpp);
3177
3178 /* forward current battery state */
3179 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP10_BATTERY) {
3180 hidpp10_enable_battery_reporting(hidpp);
3181 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_MILEAGE)
3182 hidpp10_query_battery_mileage(hidpp);
3183 else
3184 hidpp10_query_battery_status(hidpp);
3185 } else if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
3186 hidpp20_query_battery_info(hidpp);
3187 }
3188 if (hidpp->battery.ps)
3189 power_supply_changed(hidpp->battery.ps);
3190
3191 if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL)
3192 hi_res_scroll_enable(hidpp);
3193
3194 if (!(hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT) || hidpp->delayed_input)
3195 /* if the input nodes are already created, we can stop now */
3196 return;
3197
3198 input = hidpp_allocate_input(hdev);
3199 if (!input) {
3200 hid_err(hdev, "cannot allocate new input device: %d\n", ret);
3201 return;
3202 }
3203
3204 hidpp_populate_input(hidpp, input, false);
3205
3206 ret = input_register_device(input);
3207 if (ret)
3208 input_free_device(input);
3209
3210 hidpp->delayed_input = input;
3211 }
3212
3213 static DEVICE_ATTR(builtin_power_supply, 0000, NULL, NULL);
3214
3215 static struct attribute *sysfs_attrs[] = {
3216 &dev_attr_builtin_power_supply.attr,
3217 NULL
3218 };
3219
3220 static const struct attribute_group ps_attribute_group = {
3221 .attrs = sysfs_attrs
3222 };
3223
3224 static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
3225 {
3226 struct hidpp_device *hidpp;
3227 int ret;
3228 bool connected;
3229 unsigned int connect_mask = HID_CONNECT_DEFAULT;
3230
3231 hidpp = devm_kzalloc(&hdev->dev, sizeof(struct hidpp_device),
3232 GFP_KERNEL);
3233 if (!hidpp)
3234 return -ENOMEM;
3235
3236 hidpp->hid_dev = hdev;
3237 hidpp->name = hdev->name;
3238 hid_set_drvdata(hdev, hidpp);
3239
3240 hidpp->quirks = id->driver_data;
3241
3242 if (id->group == HID_GROUP_LOGITECH_DJ_DEVICE)
3243 hidpp->quirks |= HIDPP_QUIRK_UNIFYING;
3244
3245 if (disable_raw_mode) {
3246 hidpp->quirks &= ~HIDPP_QUIRK_CLASS_WTP;
3247 hidpp->quirks &= ~HIDPP_QUIRK_NO_HIDINPUT;
3248 }
3249
3250 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
3251 ret = wtp_allocate(hdev, id);
3252 if (ret)
3253 goto allocate_fail;
3254 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560) {
3255 ret = m560_allocate(hdev);
3256 if (ret)
3257 goto allocate_fail;
3258 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
3259 ret = k400_allocate(hdev);
3260 if (ret)
3261 goto allocate_fail;
3262 }
3263
3264 INIT_WORK(&hidpp->work, delayed_work_cb);
3265 mutex_init(&hidpp->send_mutex);
3266 init_waitqueue_head(&hidpp->wait);
3267
3268 /* indicates we are handling the battery properties in the kernel */
3269 ret = sysfs_create_group(&hdev->dev.kobj, &ps_attribute_group);
3270 if (ret)
3271 hid_warn(hdev, "Cannot allocate sysfs group for %s\n",
3272 hdev->name);
3273
3274 ret = hid_parse(hdev);
3275 if (ret) {
3276 hid_err(hdev, "%s:parse failed\n", __func__);
3277 goto hid_parse_fail;
3278 }
3279
3280 if (hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT)
3281 connect_mask &= ~HID_CONNECT_HIDINPUT;
3282
3283 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
3284 ret = hid_hw_start(hdev, connect_mask);
3285 if (ret) {
3286 hid_err(hdev, "hw start failed\n");
3287 goto hid_hw_start_fail;
3288 }
3289 ret = hid_hw_open(hdev);
3290 if (ret < 0) {
3291 dev_err(&hdev->dev, "%s:hid_hw_open returned error:%d\n",
3292 __func__, ret);
3293 hid_hw_stop(hdev);
3294 goto hid_hw_start_fail;
3295 }
3296 }
3297
3298
3299 /* Allow incoming packets */
3300 hid_device_io_start(hdev);
3301
3302 if (hidpp->quirks & HIDPP_QUIRK_UNIFYING)
3303 hidpp_unifying_init(hidpp);
3304
3305 connected = hidpp_is_connected(hidpp);
3306 atomic_set(&hidpp->connected, connected);
3307 if (!(hidpp->quirks & HIDPP_QUIRK_UNIFYING)) {
3308 if (!connected) {
3309 ret = -ENODEV;
3310 hid_err(hdev, "Device not connected");
3311 goto hid_hw_open_failed;
3312 }
3313
3314 hid_info(hdev, "HID++ %u.%u device connected.\n",
3315 hidpp->protocol_major, hidpp->protocol_minor);
3316
3317 hidpp_overwrite_name(hdev);
3318 }
3319
3320 if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)) {
3321 ret = wtp_get_config(hidpp);
3322 if (ret)
3323 goto hid_hw_open_failed;
3324 } else if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_G920)) {
3325 ret = g920_get_config(hidpp);
3326 if (ret)
3327 goto hid_hw_open_failed;
3328 }
3329
3330 /* Block incoming packets */
3331 hid_device_io_stop(hdev);
3332
3333 if (!(hidpp->quirks & HIDPP_QUIRK_CLASS_G920)) {
3334 ret = hid_hw_start(hdev, connect_mask);
3335 if (ret) {
3336 hid_err(hdev, "%s:hid_hw_start returned error\n", __func__);
3337 goto hid_hw_start_fail;
3338 }
3339 }
3340
3341 /* Allow incoming packets */
3342 hid_device_io_start(hdev);
3343
3344 hidpp_connect_event(hidpp);
3345
3346 return ret;
3347
3348 hid_hw_open_failed:
3349 hid_device_io_stop(hdev);
3350 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
3351 hid_hw_close(hdev);
3352 hid_hw_stop(hdev);
3353 }
3354 hid_hw_start_fail:
3355 hid_parse_fail:
3356 sysfs_remove_group(&hdev->dev.kobj, &ps_attribute_group);
3357 cancel_work_sync(&hidpp->work);
3358 mutex_destroy(&hidpp->send_mutex);
3359 allocate_fail:
3360 hid_set_drvdata(hdev, NULL);
3361 return ret;
3362 }
3363
3364 static void hidpp_remove(struct hid_device *hdev)
3365 {
3366 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3367
3368 sysfs_remove_group(&hdev->dev.kobj, &ps_attribute_group);
3369
3370 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
3371 hidpp_ff_deinit(hdev);
3372 hid_hw_close(hdev);
3373 }
3374 hid_hw_stop(hdev);
3375 cancel_work_sync(&hidpp->work);
3376 mutex_destroy(&hidpp->send_mutex);
3377 }
3378
3379 #define LDJ_DEVICE(product) \
3380 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE, \
3381 USB_VENDOR_ID_LOGITECH, (product))
3382
3383 static const struct hid_device_id hidpp_devices[] = {
3384 { /* wireless touchpad */
3385 LDJ_DEVICE(0x4011),
3386 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT |
3387 HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS },
3388 { /* wireless touchpad T650 */
3389 LDJ_DEVICE(0x4101),
3390 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT },
3391 { /* wireless touchpad T651 */
3392 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
3393 USB_DEVICE_ID_LOGITECH_T651),
3394 .driver_data = HIDPP_QUIRK_CLASS_WTP },
3395 { /* Mouse Logitech Anywhere MX */
3396 LDJ_DEVICE(0x1017), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
3397 { /* Mouse Logitech Cube */
3398 LDJ_DEVICE(0x4010), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
3399 { /* Mouse Logitech M335 */
3400 LDJ_DEVICE(0x4050), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3401 { /* Mouse Logitech M515 */
3402 LDJ_DEVICE(0x4007), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
3403 { /* Mouse logitech M560 */
3404 LDJ_DEVICE(0x402d),
3405 .driver_data = HIDPP_QUIRK_DELAYED_INIT | HIDPP_QUIRK_CLASS_M560
3406 | HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
3407 { /* Mouse Logitech M705 (firmware RQM17) */
3408 LDJ_DEVICE(0x101b), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
3409 { /* Mouse Logitech M705 (firmware RQM67) */
3410 LDJ_DEVICE(0x406d), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3411 { /* Mouse Logitech M720 */
3412 LDJ_DEVICE(0x405e), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3413 { /* Mouse Logitech MX Anywhere 2 */
3414 LDJ_DEVICE(0x404a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3415 { LDJ_DEVICE(0xb013), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3416 { LDJ_DEVICE(0xb018), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3417 { LDJ_DEVICE(0xb01f), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3418 { /* Mouse Logitech MX Anywhere 2S */
3419 LDJ_DEVICE(0x406a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3420 { /* Mouse Logitech MX Master */
3421 LDJ_DEVICE(0x4041), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3422 { LDJ_DEVICE(0x4060), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3423 { LDJ_DEVICE(0x4071), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3424 { /* Mouse Logitech MX Master 2S */
3425 LDJ_DEVICE(0x4069), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
3426 { /* Mouse Logitech Performance MX */
3427 LDJ_DEVICE(0x101a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
3428 { /* Keyboard logitech K400 */
3429 LDJ_DEVICE(0x4024),
3430 .driver_data = HIDPP_QUIRK_CLASS_K400 },
3431 { /* Solar Keyboard Logitech K750 */
3432 LDJ_DEVICE(0x4002),
3433 .driver_data = HIDPP_QUIRK_CLASS_K750 },
3434
3435 { LDJ_DEVICE(HID_ANY_ID) },
3436
3437 { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G920_WHEEL),
3438 .driver_data = HIDPP_QUIRK_CLASS_G920 | HIDPP_QUIRK_FORCE_OUTPUT_REPORTS},
3439 {}
3440 };
3441
3442 MODULE_DEVICE_TABLE(hid, hidpp_devices);
3443
3444 static const struct hid_usage_id hidpp_usages[] = {
3445 { HID_GD_WHEEL, EV_REL, REL_WHEEL_HI_RES },
3446 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
3447 };
3448
3449 static struct hid_driver hidpp_driver = {
3450 .name = "logitech-hidpp-device",
3451 .id_table = hidpp_devices,
3452 .probe = hidpp_probe,
3453 .remove = hidpp_remove,
3454 .raw_event = hidpp_raw_event,
3455 .usage_table = hidpp_usages,
3456 .event = hidpp_event,
3457 .input_configured = hidpp_input_configured,
3458 .input_mapping = hidpp_input_mapping,
3459 .input_mapped = hidpp_input_mapped,
3460 };
3461
3462 module_hid_driver(hidpp_driver);
Linux with added FPC-III support