1 // SPDX-License-Identifier: GPL-2.0-only
3 * HIDPP protocol for Logitech receivers
5 * Copyright (c) 2011 Logitech (c)
6 * Copyright (c) 2012-2013 Google (c)
7 * Copyright (c) 2013-2014 Red Hat Inc.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/device.h>
14 #include <linux/input.h>
15 #include <linux/usb.h>
16 #include <linux/hid.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/sched.h>
20 #include <linux/sched/clock.h>
21 #include <linux/kfifo.h>
22 #include <linux/input/mt.h>
23 #include <linux/workqueue.h>
24 #include <linux/atomic.h>
25 #include <linux/fixp-arith.h>
26 #include <asm/unaligned.h>
27 #include "usbhid/usbhid.h"
30 MODULE_LICENSE("GPL");
31 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
32 MODULE_AUTHOR("Nestor Lopez Casado <nlopezcasad@logitech.com>");
34 static bool disable_raw_mode;
35 module_param(disable_raw_mode, bool, 0644);
36 MODULE_PARM_DESC(disable_raw_mode,
37 "Disable Raw mode reporting for touchpads and keep firmware gestures.");
39 static bool disable_tap_to_click;
40 module_param(disable_tap_to_click, bool, 0644);
41 MODULE_PARM_DESC(disable_tap_to_click,
42 "Disable Tap-To-Click mode reporting for touchpads (only on the K400 currently).");
44 #define REPORT_ID_HIDPP_SHORT 0x10
45 #define REPORT_ID_HIDPP_LONG 0x11
46 #define REPORT_ID_HIDPP_VERY_LONG 0x12
48 #define HIDPP_REPORT_SHORT_LENGTH 7
49 #define HIDPP_REPORT_LONG_LENGTH 20
50 #define HIDPP_REPORT_VERY_LONG_MAX_LENGTH 64
52 #define HIDPP_REPORT_SHORT_SUPPORTED BIT(0)
53 #define HIDPP_REPORT_LONG_SUPPORTED BIT(1)
54 #define HIDPP_REPORT_VERY_LONG_SUPPORTED BIT(2)
56 #define HIDPP_SUB_ID_CONSUMER_VENDOR_KEYS 0x03
57 #define HIDPP_SUB_ID_ROLLER 0x05
58 #define HIDPP_SUB_ID_MOUSE_EXTRA_BTNS 0x06
60 #define HIDPP_QUIRK_CLASS_WTP BIT(0)
61 #define HIDPP_QUIRK_CLASS_M560 BIT(1)
62 #define HIDPP_QUIRK_CLASS_K400 BIT(2)
63 #define HIDPP_QUIRK_CLASS_G920 BIT(3)
64 #define HIDPP_QUIRK_CLASS_K750 BIT(4)
66 /* bits 2..20 are reserved for classes */
67 /* #define HIDPP_QUIRK_CONNECT_EVENTS BIT(21) disabled */
68 #define HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS BIT(22)
69 #define HIDPP_QUIRK_NO_HIDINPUT BIT(23)
70 #define HIDPP_QUIRK_FORCE_OUTPUT_REPORTS BIT(24)
71 #define HIDPP_QUIRK_UNIFYING BIT(25)
72 #define HIDPP_QUIRK_HI_RES_SCROLL_1P0 BIT(26)
73 #define HIDPP_QUIRK_HI_RES_SCROLL_X2120 BIT(27)
74 #define HIDPP_QUIRK_HI_RES_SCROLL_X2121 BIT(28)
75 #define HIDPP_QUIRK_HIDPP_WHEELS BIT(29)
76 #define HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS BIT(30)
77 #define HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS BIT(31)
79 /* These are just aliases for now */
80 #define HIDPP_QUIRK_KBD_SCROLL_WHEEL HIDPP_QUIRK_HIDPP_WHEELS
81 #define HIDPP_QUIRK_KBD_ZOOM_WHEEL HIDPP_QUIRK_HIDPP_WHEELS
83 /* Convenience constant to check for any high-res support. */
84 #define HIDPP_QUIRK_HI_RES_SCROLL (HIDPP_QUIRK_HI_RES_SCROLL_1P0 | \
85 HIDPP_QUIRK_HI_RES_SCROLL_X2120 | \
86 HIDPP_QUIRK_HI_RES_SCROLL_X2121)
88 #define HIDPP_QUIRK_DELAYED_INIT HIDPP_QUIRK_NO_HIDINPUT
90 #define HIDPP_CAPABILITY_HIDPP10_BATTERY BIT(0)
91 #define HIDPP_CAPABILITY_HIDPP20_BATTERY BIT(1)
92 #define HIDPP_CAPABILITY_BATTERY_MILEAGE BIT(2)
93 #define HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS BIT(3)
94 #define HIDPP_CAPABILITY_BATTERY_VOLTAGE BIT(4)
95 #define HIDPP_CAPABILITY_BATTERY_PERCENTAGE BIT(5)
96 #define HIDPP_CAPABILITY_UNIFIED_BATTERY BIT(6)
98 #define lg_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
101 * There are two hidpp protocols in use, the first version hidpp10 is known
102 * as register access protocol or RAP, the second version hidpp20 is known as
103 * feature access protocol or FAP
105 * Most older devices (including the Unifying usb receiver) use the RAP protocol
106 * where as most newer devices use the FAP protocol. Both protocols are
107 * compatible with the underlying transport, which could be usb, Unifiying, or
108 * bluetooth. The message lengths are defined by the hid vendor specific report
109 * descriptor for the HIDPP_SHORT report type (total message lenth 7 bytes) and
110 * the HIDPP_LONG report type (total message length 20 bytes)
112 * The RAP protocol uses both report types, whereas the FAP only uses HIDPP_LONG
113 * messages. The Unifying receiver itself responds to RAP messages (device index
114 * is 0xFF for the receiver), and all messages (short or long) with a device
115 * index between 1 and 6 are passed untouched to the corresponding paired
118 * The paired device can be RAP or FAP, it will receive the message untouched
119 * from the Unifiying receiver.
124 u8 funcindex_clientid;
125 u8 params[HIDPP_REPORT_VERY_LONG_MAX_LENGTH - 4U];
131 u8 params[HIDPP_REPORT_VERY_LONG_MAX_LENGTH - 4U];
134 struct hidpp_report {
140 u8 rawbytes[sizeof(struct fap)];
144 struct hidpp_battery {
146 u8 solar_feature_index;
147 u8 voltage_feature_index;
148 struct power_supply_desc desc;
149 struct power_supply *ps;
157 u8 supported_levels_1004;
161 * struct hidpp_scroll_counter - Utility class for processing high-resolution
163 * @dev: the input device for which events should be reported.
164 * @wheel_multiplier: the scalar multiplier to be applied to each wheel event
165 * @remainder: counts the number of high-resolution units moved since the last
166 * low-resolution event (REL_WHEEL or REL_HWHEEL) was sent. Should
167 * only be used by class methods.
168 * @direction: direction of last movement (1 or -1)
169 * @last_time: last event time, used to reset remainder after inactivity
171 struct hidpp_scroll_counter {
172 int wheel_multiplier;
175 unsigned long long last_time;
178 struct hidpp_device {
179 struct hid_device *hid_dev;
180 struct input_dev *input;
181 struct mutex send_mutex;
182 void *send_receive_buf;
183 char *name; /* will never be NULL and should not be freed */
184 wait_queue_head_t wait;
185 int very_long_report_length;
186 bool answer_available;
192 struct work_struct work;
193 struct kfifo delayed_work_fifo;
195 struct input_dev *delayed_input;
197 unsigned long quirks;
198 unsigned long capabilities;
199 u8 supported_reports;
201 struct hidpp_battery battery;
202 struct hidpp_scroll_counter vertical_wheel_counter;
204 u8 wireless_feature_index;
207 /* HID++ 1.0 error codes */
208 #define HIDPP_ERROR 0x8f
209 #define HIDPP_ERROR_SUCCESS 0x00
210 #define HIDPP_ERROR_INVALID_SUBID 0x01
211 #define HIDPP_ERROR_INVALID_ADRESS 0x02
212 #define HIDPP_ERROR_INVALID_VALUE 0x03
213 #define HIDPP_ERROR_CONNECT_FAIL 0x04
214 #define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
215 #define HIDPP_ERROR_ALREADY_EXISTS 0x06
216 #define HIDPP_ERROR_BUSY 0x07
217 #define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
218 #define HIDPP_ERROR_RESOURCE_ERROR 0x09
219 #define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
220 #define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
221 #define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
222 /* HID++ 2.0 error codes */
223 #define HIDPP20_ERROR 0xff
225 static void hidpp_connect_event(struct hidpp_device *hidpp_dev);
227 static int __hidpp_send_report(struct hid_device *hdev,
228 struct hidpp_report *hidpp_report)
230 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
231 int fields_count, ret;
233 switch (hidpp_report->report_id) {
234 case REPORT_ID_HIDPP_SHORT:
235 fields_count = HIDPP_REPORT_SHORT_LENGTH;
237 case REPORT_ID_HIDPP_LONG:
238 fields_count = HIDPP_REPORT_LONG_LENGTH;
240 case REPORT_ID_HIDPP_VERY_LONG:
241 fields_count = hidpp->very_long_report_length;
248 * set the device_index as the receiver, it will be overwritten by
249 * hid_hw_request if needed
251 hidpp_report->device_index = 0xff;
253 if (hidpp->quirks & HIDPP_QUIRK_FORCE_OUTPUT_REPORTS) {
254 ret = hid_hw_output_report(hdev, (u8 *)hidpp_report, fields_count);
256 ret = hid_hw_raw_request(hdev, hidpp_report->report_id,
257 (u8 *)hidpp_report, fields_count, HID_OUTPUT_REPORT,
261 return ret == fields_count ? 0 : -1;
265 * hidpp_send_message_sync() returns 0 in case of success, and something else
266 * in case of a failure.
267 * - If ' something else' is positive, that means that an error has been raised
268 * by the protocol itself.
269 * - If ' something else' is negative, that means that we had a classic error
270 * (-ENOMEM, -EPIPE, etc...)
272 static int hidpp_send_message_sync(struct hidpp_device *hidpp,
273 struct hidpp_report *message,
274 struct hidpp_report *response)
278 mutex_lock(&hidpp->send_mutex);
280 hidpp->send_receive_buf = response;
281 hidpp->answer_available = false;
284 * So that we can later validate the answer when it arrives
287 *response = *message;
289 ret = __hidpp_send_report(hidpp->hid_dev, message);
292 dbg_hid("__hidpp_send_report returned err: %d\n", ret);
293 memset(response, 0, sizeof(struct hidpp_report));
297 if (!wait_event_timeout(hidpp->wait, hidpp->answer_available,
299 dbg_hid("%s:timeout waiting for response\n", __func__);
300 memset(response, 0, sizeof(struct hidpp_report));
304 if (response->report_id == REPORT_ID_HIDPP_SHORT &&
305 response->rap.sub_id == HIDPP_ERROR) {
306 ret = response->rap.params[1];
307 dbg_hid("%s:got hidpp error %02X\n", __func__, ret);
311 if ((response->report_id == REPORT_ID_HIDPP_LONG ||
312 response->report_id == REPORT_ID_HIDPP_VERY_LONG) &&
313 response->fap.feature_index == HIDPP20_ERROR) {
314 ret = response->fap.params[1];
315 dbg_hid("%s:got hidpp 2.0 error %02X\n", __func__, ret);
320 mutex_unlock(&hidpp->send_mutex);
325 static int hidpp_send_fap_command_sync(struct hidpp_device *hidpp,
326 u8 feat_index, u8 funcindex_clientid, u8 *params, int param_count,
327 struct hidpp_report *response)
329 struct hidpp_report *message;
332 if (param_count > sizeof(message->fap.params))
335 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
339 if (param_count > (HIDPP_REPORT_LONG_LENGTH - 4))
340 message->report_id = REPORT_ID_HIDPP_VERY_LONG;
342 message->report_id = REPORT_ID_HIDPP_LONG;
343 message->fap.feature_index = feat_index;
344 message->fap.funcindex_clientid = funcindex_clientid;
345 memcpy(&message->fap.params, params, param_count);
347 ret = hidpp_send_message_sync(hidpp, message, response);
352 static int hidpp_send_rap_command_sync(struct hidpp_device *hidpp_dev,
353 u8 report_id, u8 sub_id, u8 reg_address, u8 *params, int param_count,
354 struct hidpp_report *response)
356 struct hidpp_report *message;
359 /* Send as long report if short reports are not supported. */
360 if (report_id == REPORT_ID_HIDPP_SHORT &&
361 !(hidpp_dev->supported_reports & HIDPP_REPORT_SHORT_SUPPORTED))
362 report_id = REPORT_ID_HIDPP_LONG;
365 case REPORT_ID_HIDPP_SHORT:
366 max_count = HIDPP_REPORT_SHORT_LENGTH - 4;
368 case REPORT_ID_HIDPP_LONG:
369 max_count = HIDPP_REPORT_LONG_LENGTH - 4;
371 case REPORT_ID_HIDPP_VERY_LONG:
372 max_count = hidpp_dev->very_long_report_length - 4;
378 if (param_count > max_count)
381 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
384 message->report_id = report_id;
385 message->rap.sub_id = sub_id;
386 message->rap.reg_address = reg_address;
387 memcpy(&message->rap.params, params, param_count);
389 ret = hidpp_send_message_sync(hidpp_dev, message, response);
394 static void delayed_work_cb(struct work_struct *work)
396 struct hidpp_device *hidpp = container_of(work, struct hidpp_device,
398 hidpp_connect_event(hidpp);
401 static inline bool hidpp_match_answer(struct hidpp_report *question,
402 struct hidpp_report *answer)
404 return (answer->fap.feature_index == question->fap.feature_index) &&
405 (answer->fap.funcindex_clientid == question->fap.funcindex_clientid);
408 static inline bool hidpp_match_error(struct hidpp_report *question,
409 struct hidpp_report *answer)
411 return ((answer->rap.sub_id == HIDPP_ERROR) ||
412 (answer->fap.feature_index == HIDPP20_ERROR)) &&
413 (answer->fap.funcindex_clientid == question->fap.feature_index) &&
414 (answer->fap.params[0] == question->fap.funcindex_clientid);
417 static inline bool hidpp_report_is_connect_event(struct hidpp_device *hidpp,
418 struct hidpp_report *report)
420 return (hidpp->wireless_feature_index &&
421 (report->fap.feature_index == hidpp->wireless_feature_index)) ||
422 ((report->report_id == REPORT_ID_HIDPP_SHORT) &&
423 (report->rap.sub_id == 0x41));
427 * hidpp_prefix_name() prefixes the current given name with "Logitech ".
429 static void hidpp_prefix_name(char **name, int name_length)
431 #define PREFIX_LENGTH 9 /* "Logitech " */
436 if (name_length > PREFIX_LENGTH &&
437 strncmp(*name, "Logitech ", PREFIX_LENGTH) == 0)
438 /* The prefix has is already in the name */
441 new_length = PREFIX_LENGTH + name_length;
442 new_name = kzalloc(new_length, GFP_KERNEL);
446 snprintf(new_name, new_length, "Logitech %s", *name);
454 * hidpp_scroll_counter_handle_scroll() - Send high- and low-resolution scroll
455 * events given a high-resolution wheel
457 * @counter: a hid_scroll_counter struct describing the wheel.
458 * @hi_res_value: the movement of the wheel, in the mouse's high-resolution
461 * Given a high-resolution movement, this function converts the movement into
462 * fractions of 120 and emits high-resolution scroll events for the input
463 * device. It also uses the multiplier from &struct hid_scroll_counter to
464 * emit low-resolution scroll events when appropriate for
465 * backwards-compatibility with userspace input libraries.
467 static void hidpp_scroll_counter_handle_scroll(struct input_dev *input_dev,
468 struct hidpp_scroll_counter *counter,
471 int low_res_value, remainder, direction;
472 unsigned long long now, previous;
474 hi_res_value = hi_res_value * 120/counter->wheel_multiplier;
475 input_report_rel(input_dev, REL_WHEEL_HI_RES, hi_res_value);
477 remainder = counter->remainder;
478 direction = hi_res_value > 0 ? 1 : -1;
481 previous = counter->last_time;
482 counter->last_time = now;
484 * Reset the remainder after a period of inactivity or when the
485 * direction changes. This prevents the REL_WHEEL emulation point
486 * from sliding for devices that don't always provide the same
487 * number of movements per detent.
489 if (now - previous > 1000000000 || direction != counter->direction)
492 counter->direction = direction;
493 remainder += hi_res_value;
495 /* Some wheels will rest 7/8ths of a detent from the previous detent
496 * after slow movement, so we want the threshold for low-res events to
497 * be in the middle between two detents (e.g. after 4/8ths) as
498 * opposed to on the detents themselves (8/8ths).
500 if (abs(remainder) >= 60) {
501 /* Add (or subtract) 1 because we want to trigger when the wheel
502 * is half-way to the next detent (i.e. scroll 1 detent after a
503 * 1/2 detent movement, 2 detents after a 1 1/2 detent movement,
506 low_res_value = remainder / 120;
507 if (low_res_value == 0)
508 low_res_value = (hi_res_value > 0 ? 1 : -1);
509 input_report_rel(input_dev, REL_WHEEL, low_res_value);
510 remainder -= low_res_value * 120;
512 counter->remainder = remainder;
515 /* -------------------------------------------------------------------------- */
516 /* HIDP++ 1.0 commands */
517 /* -------------------------------------------------------------------------- */
519 #define HIDPP_SET_REGISTER 0x80
520 #define HIDPP_GET_REGISTER 0x81
521 #define HIDPP_SET_LONG_REGISTER 0x82
522 #define HIDPP_GET_LONG_REGISTER 0x83
525 * hidpp10_set_register - Modify a HID++ 1.0 register.
526 * @hidpp_dev: the device to set the register on.
527 * @register_address: the address of the register to modify.
528 * @byte: the byte of the register to modify. Should be less than 3.
529 * @mask: mask of the bits to modify
530 * @value: new values for the bits in mask
531 * Return: 0 if successful, otherwise a negative error code.
533 static int hidpp10_set_register(struct hidpp_device *hidpp_dev,
534 u8 register_address, u8 byte, u8 mask, u8 value)
536 struct hidpp_report response;
538 u8 params[3] = { 0 };
540 ret = hidpp_send_rap_command_sync(hidpp_dev,
541 REPORT_ID_HIDPP_SHORT,
548 memcpy(params, response.rap.params, 3);
550 params[byte] &= ~mask;
551 params[byte] |= value & mask;
553 return hidpp_send_rap_command_sync(hidpp_dev,
554 REPORT_ID_HIDPP_SHORT,
557 params, 3, &response);
560 #define HIDPP_REG_ENABLE_REPORTS 0x00
561 #define HIDPP_ENABLE_CONSUMER_REPORT BIT(0)
562 #define HIDPP_ENABLE_WHEEL_REPORT BIT(2)
563 #define HIDPP_ENABLE_MOUSE_EXTRA_BTN_REPORT BIT(3)
564 #define HIDPP_ENABLE_BAT_REPORT BIT(4)
565 #define HIDPP_ENABLE_HWHEEL_REPORT BIT(5)
567 static int hidpp10_enable_battery_reporting(struct hidpp_device *hidpp_dev)
569 return hidpp10_set_register(hidpp_dev, HIDPP_REG_ENABLE_REPORTS, 0,
570 HIDPP_ENABLE_BAT_REPORT, HIDPP_ENABLE_BAT_REPORT);
573 #define HIDPP_REG_FEATURES 0x01
574 #define HIDPP_ENABLE_SPECIAL_BUTTON_FUNC BIT(1)
575 #define HIDPP_ENABLE_FAST_SCROLL BIT(6)
577 /* On HID++ 1.0 devices, high-res scroll was called "scrolling acceleration". */
578 static int hidpp10_enable_scrolling_acceleration(struct hidpp_device *hidpp_dev)
580 return hidpp10_set_register(hidpp_dev, HIDPP_REG_FEATURES, 0,
581 HIDPP_ENABLE_FAST_SCROLL, HIDPP_ENABLE_FAST_SCROLL);
584 #define HIDPP_REG_BATTERY_STATUS 0x07
586 static int hidpp10_battery_status_map_level(u8 param)
592 level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
595 level = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
598 level = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
601 level = POWER_SUPPLY_CAPACITY_LEVEL_HIGH;
604 level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
610 static int hidpp10_battery_status_map_status(u8 param)
616 /* discharging (in use) */
617 status = POWER_SUPPLY_STATUS_DISCHARGING;
619 case 0x21: /* (standard) charging */
620 case 0x24: /* fast charging */
621 case 0x25: /* slow charging */
622 status = POWER_SUPPLY_STATUS_CHARGING;
624 case 0x26: /* topping charge */
625 case 0x22: /* charge complete */
626 status = POWER_SUPPLY_STATUS_FULL;
628 case 0x20: /* unknown */
629 status = POWER_SUPPLY_STATUS_UNKNOWN;
632 * 0x01...0x1F = reserved (not charging)
633 * 0x23 = charging error
634 * 0x27..0xff = reserved
637 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
644 static int hidpp10_query_battery_status(struct hidpp_device *hidpp)
646 struct hidpp_report response;
649 ret = hidpp_send_rap_command_sync(hidpp,
650 REPORT_ID_HIDPP_SHORT,
652 HIDPP_REG_BATTERY_STATUS,
657 hidpp->battery.level =
658 hidpp10_battery_status_map_level(response.rap.params[0]);
659 status = hidpp10_battery_status_map_status(response.rap.params[1]);
660 hidpp->battery.status = status;
661 /* the capacity is only available when discharging or full */
662 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
663 status == POWER_SUPPLY_STATUS_FULL;
668 #define HIDPP_REG_BATTERY_MILEAGE 0x0D
670 static int hidpp10_battery_mileage_map_status(u8 param)
674 switch (param >> 6) {
676 /* discharging (in use) */
677 status = POWER_SUPPLY_STATUS_DISCHARGING;
679 case 0x01: /* charging */
680 status = POWER_SUPPLY_STATUS_CHARGING;
682 case 0x02: /* charge complete */
683 status = POWER_SUPPLY_STATUS_FULL;
686 * 0x03 = charging error
689 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
696 static int hidpp10_query_battery_mileage(struct hidpp_device *hidpp)
698 struct hidpp_report response;
701 ret = hidpp_send_rap_command_sync(hidpp,
702 REPORT_ID_HIDPP_SHORT,
704 HIDPP_REG_BATTERY_MILEAGE,
709 hidpp->battery.capacity = response.rap.params[0];
710 status = hidpp10_battery_mileage_map_status(response.rap.params[2]);
711 hidpp->battery.status = status;
712 /* the capacity is only available when discharging or full */
713 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
714 status == POWER_SUPPLY_STATUS_FULL;
719 static int hidpp10_battery_event(struct hidpp_device *hidpp, u8 *data, int size)
721 struct hidpp_report *report = (struct hidpp_report *)data;
722 int status, capacity, level;
725 if (report->report_id != REPORT_ID_HIDPP_SHORT)
728 switch (report->rap.sub_id) {
729 case HIDPP_REG_BATTERY_STATUS:
730 capacity = hidpp->battery.capacity;
731 level = hidpp10_battery_status_map_level(report->rawbytes[1]);
732 status = hidpp10_battery_status_map_status(report->rawbytes[2]);
734 case HIDPP_REG_BATTERY_MILEAGE:
735 capacity = report->rap.params[0];
736 level = hidpp->battery.level;
737 status = hidpp10_battery_mileage_map_status(report->rawbytes[3]);
743 changed = capacity != hidpp->battery.capacity ||
744 level != hidpp->battery.level ||
745 status != hidpp->battery.status;
747 /* the capacity is only available when discharging or full */
748 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
749 status == POWER_SUPPLY_STATUS_FULL;
752 hidpp->battery.level = level;
753 hidpp->battery.status = status;
754 if (hidpp->battery.ps)
755 power_supply_changed(hidpp->battery.ps);
761 #define HIDPP_REG_PAIRING_INFORMATION 0xB5
762 #define HIDPP_EXTENDED_PAIRING 0x30
763 #define HIDPP_DEVICE_NAME 0x40
765 static char *hidpp_unifying_get_name(struct hidpp_device *hidpp_dev)
767 struct hidpp_report response;
769 u8 params[1] = { HIDPP_DEVICE_NAME };
773 ret = hidpp_send_rap_command_sync(hidpp_dev,
774 REPORT_ID_HIDPP_SHORT,
775 HIDPP_GET_LONG_REGISTER,
776 HIDPP_REG_PAIRING_INFORMATION,
777 params, 1, &response);
781 len = response.rap.params[1];
783 if (2 + len > sizeof(response.rap.params))
786 if (len < 4) /* logitech devices are usually at least Xddd */
789 name = kzalloc(len + 1, GFP_KERNEL);
793 memcpy(name, &response.rap.params[2], len);
795 /* include the terminating '\0' */
796 hidpp_prefix_name(&name, len + 1);
801 static int hidpp_unifying_get_serial(struct hidpp_device *hidpp, u32 *serial)
803 struct hidpp_report response;
805 u8 params[1] = { HIDPP_EXTENDED_PAIRING };
807 ret = hidpp_send_rap_command_sync(hidpp,
808 REPORT_ID_HIDPP_SHORT,
809 HIDPP_GET_LONG_REGISTER,
810 HIDPP_REG_PAIRING_INFORMATION,
811 params, 1, &response);
816 * We don't care about LE or BE, we will output it as a string
817 * with %4phD, so we need to keep the order.
819 *serial = *((u32 *)&response.rap.params[1]);
823 static int hidpp_unifying_init(struct hidpp_device *hidpp)
825 struct hid_device *hdev = hidpp->hid_dev;
830 ret = hidpp_unifying_get_serial(hidpp, &serial);
834 snprintf(hdev->uniq, sizeof(hdev->uniq), "%04x-%4phD",
835 hdev->product, &serial);
836 dbg_hid("HID++ Unifying: Got serial: %s\n", hdev->uniq);
838 name = hidpp_unifying_get_name(hidpp);
842 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
843 dbg_hid("HID++ Unifying: Got name: %s\n", name);
849 /* -------------------------------------------------------------------------- */
851 /* -------------------------------------------------------------------------- */
853 #define HIDPP_PAGE_ROOT 0x0000
854 #define HIDPP_PAGE_ROOT_IDX 0x00
856 #define CMD_ROOT_GET_FEATURE 0x01
857 #define CMD_ROOT_GET_PROTOCOL_VERSION 0x11
859 static int hidpp_root_get_feature(struct hidpp_device *hidpp, u16 feature,
860 u8 *feature_index, u8 *feature_type)
862 struct hidpp_report response;
864 u8 params[2] = { feature >> 8, feature & 0x00FF };
866 ret = hidpp_send_fap_command_sync(hidpp,
868 CMD_ROOT_GET_FEATURE,
869 params, 2, &response);
873 if (response.fap.params[0] == 0)
876 *feature_index = response.fap.params[0];
877 *feature_type = response.fap.params[1];
882 static int hidpp_root_get_protocol_version(struct hidpp_device *hidpp)
884 const u8 ping_byte = 0x5a;
885 u8 ping_data[3] = { 0, 0, ping_byte };
886 struct hidpp_report response;
889 ret = hidpp_send_rap_command_sync(hidpp,
890 REPORT_ID_HIDPP_SHORT,
892 CMD_ROOT_GET_PROTOCOL_VERSION,
893 ping_data, sizeof(ping_data), &response);
895 if (ret == HIDPP_ERROR_INVALID_SUBID) {
896 hidpp->protocol_major = 1;
897 hidpp->protocol_minor = 0;
901 /* the device might not be connected */
902 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
906 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
913 if (response.rap.params[2] != ping_byte) {
914 hid_err(hidpp->hid_dev, "%s: ping mismatch 0x%02x != 0x%02x\n",
915 __func__, response.rap.params[2], ping_byte);
919 hidpp->protocol_major = response.rap.params[0];
920 hidpp->protocol_minor = response.rap.params[1];
923 hid_info(hidpp->hid_dev, "HID++ %u.%u device connected.\n",
924 hidpp->protocol_major, hidpp->protocol_minor);
928 /* -------------------------------------------------------------------------- */
929 /* 0x0005: GetDeviceNameType */
930 /* -------------------------------------------------------------------------- */
932 #define HIDPP_PAGE_GET_DEVICE_NAME_TYPE 0x0005
934 #define CMD_GET_DEVICE_NAME_TYPE_GET_COUNT 0x01
935 #define CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME 0x11
936 #define CMD_GET_DEVICE_NAME_TYPE_GET_TYPE 0x21
938 static int hidpp_devicenametype_get_count(struct hidpp_device *hidpp,
939 u8 feature_index, u8 *nameLength)
941 struct hidpp_report response;
944 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
945 CMD_GET_DEVICE_NAME_TYPE_GET_COUNT, NULL, 0, &response);
948 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
955 *nameLength = response.fap.params[0];
960 static int hidpp_devicenametype_get_device_name(struct hidpp_device *hidpp,
961 u8 feature_index, u8 char_index, char *device_name, int len_buf)
963 struct hidpp_report response;
967 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
968 CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME, &char_index, 1,
972 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
979 switch (response.report_id) {
980 case REPORT_ID_HIDPP_VERY_LONG:
981 count = hidpp->very_long_report_length - 4;
983 case REPORT_ID_HIDPP_LONG:
984 count = HIDPP_REPORT_LONG_LENGTH - 4;
986 case REPORT_ID_HIDPP_SHORT:
987 count = HIDPP_REPORT_SHORT_LENGTH - 4;
996 for (i = 0; i < count; i++)
997 device_name[i] = response.fap.params[i];
1002 static char *hidpp_get_device_name(struct hidpp_device *hidpp)
1011 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_GET_DEVICE_NAME_TYPE,
1012 &feature_index, &feature_type);
1016 ret = hidpp_devicenametype_get_count(hidpp, feature_index,
1021 name = kzalloc(__name_length + 1, GFP_KERNEL);
1025 while (index < __name_length) {
1026 ret = hidpp_devicenametype_get_device_name(hidpp,
1027 feature_index, index, name + index,
1028 __name_length - index);
1036 /* include the terminating '\0' */
1037 hidpp_prefix_name(&name, __name_length + 1);
1042 /* -------------------------------------------------------------------------- */
1043 /* 0x1000: Battery level status */
1044 /* -------------------------------------------------------------------------- */
1046 #define HIDPP_PAGE_BATTERY_LEVEL_STATUS 0x1000
1048 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS 0x00
1049 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY 0x10
1051 #define EVENT_BATTERY_LEVEL_STATUS_BROADCAST 0x00
1053 #define FLAG_BATTERY_LEVEL_DISABLE_OSD BIT(0)
1054 #define FLAG_BATTERY_LEVEL_MILEAGE BIT(1)
1055 #define FLAG_BATTERY_LEVEL_RECHARGEABLE BIT(2)
1057 static int hidpp_map_battery_level(int capacity)
1060 return POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1062 * The spec says this should be < 31 but some devices report 30
1063 * with brand new batteries and Windows reports 30 as "Good".
1065 else if (capacity < 30)
1066 return POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1067 else if (capacity < 81)
1068 return POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1069 return POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1072 static int hidpp20_batterylevel_map_status_capacity(u8 data[3], int *capacity,
1078 *capacity = data[0];
1079 *next_capacity = data[1];
1080 *level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1082 /* When discharging, we can rely on the device reported capacity.
1083 * For all other states the device reports 0 (unknown).
1086 case 0: /* discharging (in use) */
1087 status = POWER_SUPPLY_STATUS_DISCHARGING;
1088 *level = hidpp_map_battery_level(*capacity);
1090 case 1: /* recharging */
1091 status = POWER_SUPPLY_STATUS_CHARGING;
1093 case 2: /* charge in final stage */
1094 status = POWER_SUPPLY_STATUS_CHARGING;
1096 case 3: /* charge complete */
1097 status = POWER_SUPPLY_STATUS_FULL;
1098 *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1101 case 4: /* recharging below optimal speed */
1102 status = POWER_SUPPLY_STATUS_CHARGING;
1104 /* 5 = invalid battery type
1106 7 = other charging error */
1108 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
1115 static int hidpp20_batterylevel_get_battery_capacity(struct hidpp_device *hidpp,
1122 struct hidpp_report response;
1124 u8 *params = (u8 *)response.fap.params;
1126 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1127 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS,
1128 NULL, 0, &response);
1129 /* Ignore these intermittent errors */
1130 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
1133 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1140 *status = hidpp20_batterylevel_map_status_capacity(params, capacity,
1147 static int hidpp20_batterylevel_get_battery_info(struct hidpp_device *hidpp,
1150 struct hidpp_report response;
1152 u8 *params = (u8 *)response.fap.params;
1153 unsigned int level_count, flags;
1155 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1156 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY,
1157 NULL, 0, &response);
1159 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1166 level_count = params[0];
1169 if (level_count < 10 || !(flags & FLAG_BATTERY_LEVEL_MILEAGE))
1170 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS;
1172 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
1177 static int hidpp20_query_battery_info_1000(struct hidpp_device *hidpp)
1181 int status, capacity, next_capacity, level;
1183 if (hidpp->battery.feature_index == 0xff) {
1184 ret = hidpp_root_get_feature(hidpp,
1185 HIDPP_PAGE_BATTERY_LEVEL_STATUS,
1186 &hidpp->battery.feature_index,
1192 ret = hidpp20_batterylevel_get_battery_capacity(hidpp,
1193 hidpp->battery.feature_index,
1195 &next_capacity, &level);
1199 ret = hidpp20_batterylevel_get_battery_info(hidpp,
1200 hidpp->battery.feature_index);
1204 hidpp->battery.status = status;
1205 hidpp->battery.capacity = capacity;
1206 hidpp->battery.level = level;
1207 /* the capacity is only available when discharging or full */
1208 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
1209 status == POWER_SUPPLY_STATUS_FULL;
1214 static int hidpp20_battery_event_1000(struct hidpp_device *hidpp,
1217 struct hidpp_report *report = (struct hidpp_report *)data;
1218 int status, capacity, next_capacity, level;
1221 if (report->fap.feature_index != hidpp->battery.feature_index ||
1222 report->fap.funcindex_clientid != EVENT_BATTERY_LEVEL_STATUS_BROADCAST)
1225 status = hidpp20_batterylevel_map_status_capacity(report->fap.params,
1230 /* the capacity is only available when discharging or full */
1231 hidpp->battery.online = status == POWER_SUPPLY_STATUS_DISCHARGING ||
1232 status == POWER_SUPPLY_STATUS_FULL;
1234 changed = capacity != hidpp->battery.capacity ||
1235 level != hidpp->battery.level ||
1236 status != hidpp->battery.status;
1239 hidpp->battery.level = level;
1240 hidpp->battery.capacity = capacity;
1241 hidpp->battery.status = status;
1242 if (hidpp->battery.ps)
1243 power_supply_changed(hidpp->battery.ps);
1249 /* -------------------------------------------------------------------------- */
1250 /* 0x1001: Battery voltage */
1251 /* -------------------------------------------------------------------------- */
1253 #define HIDPP_PAGE_BATTERY_VOLTAGE 0x1001
1255 #define CMD_BATTERY_VOLTAGE_GET_BATTERY_VOLTAGE 0x00
1257 #define EVENT_BATTERY_VOLTAGE_STATUS_BROADCAST 0x00
1259 static int hidpp20_battery_map_status_voltage(u8 data[3], int *voltage,
1260 int *level, int *charge_type)
1264 long flags = (long) data[2];
1267 switch (flags & 0x07) {
1269 status = POWER_SUPPLY_STATUS_CHARGING;
1272 status = POWER_SUPPLY_STATUS_FULL;
1273 *level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1276 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
1279 status = POWER_SUPPLY_STATUS_UNKNOWN;
1283 status = POWER_SUPPLY_STATUS_DISCHARGING;
1285 *charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
1286 if (test_bit(3, &flags)) {
1287 *charge_type = POWER_SUPPLY_CHARGE_TYPE_FAST;
1289 if (test_bit(4, &flags)) {
1290 *charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
1292 if (test_bit(5, &flags)) {
1293 *level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1296 *voltage = get_unaligned_be16(data);
1301 static int hidpp20_battery_get_battery_voltage(struct hidpp_device *hidpp,
1303 int *status, int *voltage,
1304 int *level, int *charge_type)
1306 struct hidpp_report response;
1308 u8 *params = (u8 *)response.fap.params;
1310 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1311 CMD_BATTERY_VOLTAGE_GET_BATTERY_VOLTAGE,
1312 NULL, 0, &response);
1315 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1322 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_VOLTAGE;
1324 *status = hidpp20_battery_map_status_voltage(params, voltage,
1325 level, charge_type);
1330 static int hidpp20_query_battery_voltage_info(struct hidpp_device *hidpp)
1334 int status, voltage, level, charge_type;
1336 if (hidpp->battery.voltage_feature_index == 0xff) {
1337 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_BATTERY_VOLTAGE,
1338 &hidpp->battery.voltage_feature_index,
1344 ret = hidpp20_battery_get_battery_voltage(hidpp,
1345 hidpp->battery.voltage_feature_index,
1346 &status, &voltage, &level, &charge_type);
1351 hidpp->battery.status = status;
1352 hidpp->battery.voltage = voltage;
1353 hidpp->battery.level = level;
1354 hidpp->battery.charge_type = charge_type;
1355 hidpp->battery.online = status != POWER_SUPPLY_STATUS_NOT_CHARGING;
1360 static int hidpp20_battery_voltage_event(struct hidpp_device *hidpp,
1363 struct hidpp_report *report = (struct hidpp_report *)data;
1364 int status, voltage, level, charge_type;
1366 if (report->fap.feature_index != hidpp->battery.voltage_feature_index ||
1367 report->fap.funcindex_clientid != EVENT_BATTERY_VOLTAGE_STATUS_BROADCAST)
1370 status = hidpp20_battery_map_status_voltage(report->fap.params, &voltage,
1371 &level, &charge_type);
1373 hidpp->battery.online = status != POWER_SUPPLY_STATUS_NOT_CHARGING;
1375 if (voltage != hidpp->battery.voltage || status != hidpp->battery.status) {
1376 hidpp->battery.voltage = voltage;
1377 hidpp->battery.status = status;
1378 hidpp->battery.level = level;
1379 hidpp->battery.charge_type = charge_type;
1380 if (hidpp->battery.ps)
1381 power_supply_changed(hidpp->battery.ps);
1386 /* -------------------------------------------------------------------------- */
1387 /* 0x1004: Unified battery */
1388 /* -------------------------------------------------------------------------- */
1390 #define HIDPP_PAGE_UNIFIED_BATTERY 0x1004
1392 #define CMD_UNIFIED_BATTERY_GET_CAPABILITIES 0x00
1393 #define CMD_UNIFIED_BATTERY_GET_STATUS 0x10
1395 #define EVENT_UNIFIED_BATTERY_STATUS_EVENT 0x00
1397 #define FLAG_UNIFIED_BATTERY_LEVEL_CRITICAL BIT(0)
1398 #define FLAG_UNIFIED_BATTERY_LEVEL_LOW BIT(1)
1399 #define FLAG_UNIFIED_BATTERY_LEVEL_GOOD BIT(2)
1400 #define FLAG_UNIFIED_BATTERY_LEVEL_FULL BIT(3)
1402 #define FLAG_UNIFIED_BATTERY_FLAGS_RECHARGEABLE BIT(0)
1403 #define FLAG_UNIFIED_BATTERY_FLAGS_STATE_OF_CHARGE BIT(1)
1405 static int hidpp20_unifiedbattery_get_capabilities(struct hidpp_device *hidpp,
1408 struct hidpp_report response;
1410 u8 *params = (u8 *)response.fap.params;
1412 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS ||
1413 hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_PERCENTAGE) {
1414 /* we have already set the device capabilities, so let's skip */
1418 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1419 CMD_UNIFIED_BATTERY_GET_CAPABILITIES,
1420 NULL, 0, &response);
1421 /* Ignore these intermittent errors */
1422 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
1425 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1433 * If the device supports state of charge (battery percentage) we won't
1434 * export the battery level information. there are 4 possible battery
1435 * levels and they all are optional, this means that the device might
1436 * not support any of them, we are just better off with the battery
1439 if (params[1] & FLAG_UNIFIED_BATTERY_FLAGS_STATE_OF_CHARGE) {
1440 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_PERCENTAGE;
1441 hidpp->battery.supported_levels_1004 = 0;
1443 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS;
1444 hidpp->battery.supported_levels_1004 = params[0];
1450 static int hidpp20_unifiedbattery_map_status(struct hidpp_device *hidpp,
1452 u8 external_power_status)
1456 switch (charging_status) {
1457 case 0: /* discharging */
1458 status = POWER_SUPPLY_STATUS_DISCHARGING;
1460 case 1: /* charging */
1461 case 2: /* charging slow */
1462 status = POWER_SUPPLY_STATUS_CHARGING;
1464 case 3: /* complete */
1465 status = POWER_SUPPLY_STATUS_FULL;
1468 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
1469 hid_info(hidpp->hid_dev, "%s: charging error",
1473 status = POWER_SUPPLY_STATUS_NOT_CHARGING;
1480 static int hidpp20_unifiedbattery_map_level(struct hidpp_device *hidpp,
1483 /* cler unsupported level bits */
1484 battery_level &= hidpp->battery.supported_levels_1004;
1486 if (battery_level & FLAG_UNIFIED_BATTERY_LEVEL_FULL)
1487 return POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1488 else if (battery_level & FLAG_UNIFIED_BATTERY_LEVEL_GOOD)
1489 return POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1490 else if (battery_level & FLAG_UNIFIED_BATTERY_LEVEL_LOW)
1491 return POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1492 else if (battery_level & FLAG_UNIFIED_BATTERY_LEVEL_CRITICAL)
1493 return POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1495 return POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
1498 static int hidpp20_unifiedbattery_get_status(struct hidpp_device *hidpp,
1500 u8 *state_of_charge,
1504 struct hidpp_report response;
1506 u8 *params = (u8 *)response.fap.params;
1508 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1509 CMD_UNIFIED_BATTERY_GET_STATUS,
1510 NULL, 0, &response);
1511 /* Ignore these intermittent errors */
1512 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
1515 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1522 *state_of_charge = params[0];
1523 *status = hidpp20_unifiedbattery_map_status(hidpp, params[2], params[3]);
1524 *level = hidpp20_unifiedbattery_map_level(hidpp, params[1]);
1529 static int hidpp20_query_battery_info_1004(struct hidpp_device *hidpp)
1536 if (hidpp->battery.feature_index == 0xff) {
1537 ret = hidpp_root_get_feature(hidpp,
1538 HIDPP_PAGE_UNIFIED_BATTERY,
1539 &hidpp->battery.feature_index,
1545 ret = hidpp20_unifiedbattery_get_capabilities(hidpp,
1546 hidpp->battery.feature_index);
1550 ret = hidpp20_unifiedbattery_get_status(hidpp,
1551 hidpp->battery.feature_index,
1558 hidpp->capabilities |= HIDPP_CAPABILITY_UNIFIED_BATTERY;
1559 hidpp->battery.capacity = state_of_charge;
1560 hidpp->battery.status = status;
1561 hidpp->battery.level = level;
1562 hidpp->battery.online = true;
1567 static int hidpp20_battery_event_1004(struct hidpp_device *hidpp,
1570 struct hidpp_report *report = (struct hidpp_report *)data;
1571 u8 *params = (u8 *)report->fap.params;
1572 int state_of_charge, status, level;
1575 if (report->fap.feature_index != hidpp->battery.feature_index ||
1576 report->fap.funcindex_clientid != EVENT_UNIFIED_BATTERY_STATUS_EVENT)
1579 state_of_charge = params[0];
1580 status = hidpp20_unifiedbattery_map_status(hidpp, params[2], params[3]);
1581 level = hidpp20_unifiedbattery_map_level(hidpp, params[1]);
1583 changed = status != hidpp->battery.status ||
1584 (state_of_charge != hidpp->battery.capacity &&
1585 hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_PERCENTAGE) ||
1586 (level != hidpp->battery.level &&
1587 hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS);
1590 hidpp->battery.capacity = state_of_charge;
1591 hidpp->battery.status = status;
1592 hidpp->battery.level = level;
1593 if (hidpp->battery.ps)
1594 power_supply_changed(hidpp->battery.ps);
1600 /* -------------------------------------------------------------------------- */
1601 /* Battery feature helpers */
1602 /* -------------------------------------------------------------------------- */
1604 static enum power_supply_property hidpp_battery_props[] = {
1605 POWER_SUPPLY_PROP_ONLINE,
1606 POWER_SUPPLY_PROP_STATUS,
1607 POWER_SUPPLY_PROP_SCOPE,
1608 POWER_SUPPLY_PROP_MODEL_NAME,
1609 POWER_SUPPLY_PROP_MANUFACTURER,
1610 POWER_SUPPLY_PROP_SERIAL_NUMBER,
1611 0, /* placeholder for POWER_SUPPLY_PROP_CAPACITY, */
1612 0, /* placeholder for POWER_SUPPLY_PROP_CAPACITY_LEVEL, */
1613 0, /* placeholder for POWER_SUPPLY_PROP_VOLTAGE_NOW, */
1616 static int hidpp_battery_get_property(struct power_supply *psy,
1617 enum power_supply_property psp,
1618 union power_supply_propval *val)
1620 struct hidpp_device *hidpp = power_supply_get_drvdata(psy);
1624 case POWER_SUPPLY_PROP_STATUS:
1625 val->intval = hidpp->battery.status;
1627 case POWER_SUPPLY_PROP_CAPACITY:
1628 val->intval = hidpp->battery.capacity;
1630 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
1631 val->intval = hidpp->battery.level;
1633 case POWER_SUPPLY_PROP_SCOPE:
1634 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1636 case POWER_SUPPLY_PROP_ONLINE:
1637 val->intval = hidpp->battery.online;
1639 case POWER_SUPPLY_PROP_MODEL_NAME:
1640 if (!strncmp(hidpp->name, "Logitech ", 9))
1641 val->strval = hidpp->name + 9;
1643 val->strval = hidpp->name;
1645 case POWER_SUPPLY_PROP_MANUFACTURER:
1646 val->strval = "Logitech";
1648 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
1649 val->strval = hidpp->hid_dev->uniq;
1651 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
1652 /* hardware reports voltage in in mV. sysfs expects uV */
1653 val->intval = hidpp->battery.voltage * 1000;
1655 case POWER_SUPPLY_PROP_CHARGE_TYPE:
1656 val->intval = hidpp->battery.charge_type;
1666 /* -------------------------------------------------------------------------- */
1667 /* 0x1d4b: Wireless device status */
1668 /* -------------------------------------------------------------------------- */
1669 #define HIDPP_PAGE_WIRELESS_DEVICE_STATUS 0x1d4b
1671 static int hidpp_set_wireless_feature_index(struct hidpp_device *hidpp)
1676 ret = hidpp_root_get_feature(hidpp,
1677 HIDPP_PAGE_WIRELESS_DEVICE_STATUS,
1678 &hidpp->wireless_feature_index,
1684 /* -------------------------------------------------------------------------- */
1685 /* 0x2120: Hi-resolution scrolling */
1686 /* -------------------------------------------------------------------------- */
1688 #define HIDPP_PAGE_HI_RESOLUTION_SCROLLING 0x2120
1690 #define CMD_HI_RESOLUTION_SCROLLING_SET_HIGHRES_SCROLLING_MODE 0x10
1692 static int hidpp_hrs_set_highres_scrolling_mode(struct hidpp_device *hidpp,
1693 bool enabled, u8 *multiplier)
1699 struct hidpp_report response;
1701 ret = hidpp_root_get_feature(hidpp,
1702 HIDPP_PAGE_HI_RESOLUTION_SCROLLING,
1708 params[0] = enabled ? BIT(0) : 0;
1709 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1710 CMD_HI_RESOLUTION_SCROLLING_SET_HIGHRES_SCROLLING_MODE,
1711 params, sizeof(params), &response);
1714 *multiplier = response.fap.params[1];
1718 /* -------------------------------------------------------------------------- */
1719 /* 0x2121: HiRes Wheel */
1720 /* -------------------------------------------------------------------------- */
1722 #define HIDPP_PAGE_HIRES_WHEEL 0x2121
1724 #define CMD_HIRES_WHEEL_GET_WHEEL_CAPABILITY 0x00
1725 #define CMD_HIRES_WHEEL_SET_WHEEL_MODE 0x20
1727 static int hidpp_hrw_get_wheel_capability(struct hidpp_device *hidpp,
1733 struct hidpp_report response;
1735 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_HIRES_WHEEL,
1736 &feature_index, &feature_type);
1738 goto return_default;
1740 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1741 CMD_HIRES_WHEEL_GET_WHEEL_CAPABILITY,
1742 NULL, 0, &response);
1744 goto return_default;
1746 *multiplier = response.fap.params[0];
1749 hid_warn(hidpp->hid_dev,
1750 "Couldn't get wheel multiplier (error %d)\n", ret);
1754 static int hidpp_hrw_set_wheel_mode(struct hidpp_device *hidpp, bool invert,
1755 bool high_resolution, bool use_hidpp)
1761 struct hidpp_report response;
1763 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_HIRES_WHEEL,
1764 &feature_index, &feature_type);
1768 params[0] = (invert ? BIT(2) : 0) |
1769 (high_resolution ? BIT(1) : 0) |
1770 (use_hidpp ? BIT(0) : 0);
1772 return hidpp_send_fap_command_sync(hidpp, feature_index,
1773 CMD_HIRES_WHEEL_SET_WHEEL_MODE,
1774 params, sizeof(params), &response);
1777 /* -------------------------------------------------------------------------- */
1778 /* 0x4301: Solar Keyboard */
1779 /* -------------------------------------------------------------------------- */
1781 #define HIDPP_PAGE_SOLAR_KEYBOARD 0x4301
1783 #define CMD_SOLAR_SET_LIGHT_MEASURE 0x00
1785 #define EVENT_SOLAR_BATTERY_BROADCAST 0x00
1786 #define EVENT_SOLAR_BATTERY_LIGHT_MEASURE 0x10
1787 #define EVENT_SOLAR_CHECK_LIGHT_BUTTON 0x20
1789 static int hidpp_solar_request_battery_event(struct hidpp_device *hidpp)
1791 struct hidpp_report response;
1792 u8 params[2] = { 1, 1 };
1796 if (hidpp->battery.feature_index == 0xff) {
1797 ret = hidpp_root_get_feature(hidpp,
1798 HIDPP_PAGE_SOLAR_KEYBOARD,
1799 &hidpp->battery.solar_feature_index,
1805 ret = hidpp_send_fap_command_sync(hidpp,
1806 hidpp->battery.solar_feature_index,
1807 CMD_SOLAR_SET_LIGHT_MEASURE,
1808 params, 2, &response);
1810 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1817 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
1822 static int hidpp_solar_battery_event(struct hidpp_device *hidpp,
1825 struct hidpp_report *report = (struct hidpp_report *)data;
1826 int capacity, lux, status;
1829 function = report->fap.funcindex_clientid;
1832 if (report->fap.feature_index != hidpp->battery.solar_feature_index ||
1833 !(function == EVENT_SOLAR_BATTERY_BROADCAST ||
1834 function == EVENT_SOLAR_BATTERY_LIGHT_MEASURE ||
1835 function == EVENT_SOLAR_CHECK_LIGHT_BUTTON))
1838 capacity = report->fap.params[0];
1841 case EVENT_SOLAR_BATTERY_LIGHT_MEASURE:
1842 lux = (report->fap.params[1] << 8) | report->fap.params[2];
1844 status = POWER_SUPPLY_STATUS_CHARGING;
1846 status = POWER_SUPPLY_STATUS_DISCHARGING;
1848 case EVENT_SOLAR_CHECK_LIGHT_BUTTON:
1850 if (capacity < hidpp->battery.capacity)
1851 status = POWER_SUPPLY_STATUS_DISCHARGING;
1853 status = POWER_SUPPLY_STATUS_CHARGING;
1857 if (capacity == 100)
1858 status = POWER_SUPPLY_STATUS_FULL;
1860 hidpp->battery.online = true;
1861 if (capacity != hidpp->battery.capacity ||
1862 status != hidpp->battery.status) {
1863 hidpp->battery.capacity = capacity;
1864 hidpp->battery.status = status;
1865 if (hidpp->battery.ps)
1866 power_supply_changed(hidpp->battery.ps);
1872 /* -------------------------------------------------------------------------- */
1873 /* 0x6010: Touchpad FW items */
1874 /* -------------------------------------------------------------------------- */
1876 #define HIDPP_PAGE_TOUCHPAD_FW_ITEMS 0x6010
1878 #define CMD_TOUCHPAD_FW_ITEMS_SET 0x10
1880 struct hidpp_touchpad_fw_items {
1882 uint8_t desired_state;
1888 * send a set state command to the device by reading the current items->state
1889 * field. items is then filled with the current state.
1891 static int hidpp_touchpad_fw_items_set(struct hidpp_device *hidpp,
1893 struct hidpp_touchpad_fw_items *items)
1895 struct hidpp_report response;
1897 u8 *params = (u8 *)response.fap.params;
1899 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1900 CMD_TOUCHPAD_FW_ITEMS_SET, &items->state, 1, &response);
1903 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1910 items->presence = params[0];
1911 items->desired_state = params[1];
1912 items->state = params[2];
1913 items->persistent = params[3];
1918 /* -------------------------------------------------------------------------- */
1919 /* 0x6100: TouchPadRawXY */
1920 /* -------------------------------------------------------------------------- */
1922 #define HIDPP_PAGE_TOUCHPAD_RAW_XY 0x6100
1924 #define CMD_TOUCHPAD_GET_RAW_INFO 0x01
1925 #define CMD_TOUCHPAD_SET_RAW_REPORT_STATE 0x21
1927 #define EVENT_TOUCHPAD_RAW_XY 0x00
1929 #define TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT 0x01
1930 #define TOUCHPAD_RAW_XY_ORIGIN_UPPER_LEFT 0x03
1932 struct hidpp_touchpad_raw_info {
1943 struct hidpp_touchpad_raw_xy_finger {
1953 struct hidpp_touchpad_raw_xy {
1955 struct hidpp_touchpad_raw_xy_finger fingers[2];
1962 static int hidpp_touchpad_get_raw_info(struct hidpp_device *hidpp,
1963 u8 feature_index, struct hidpp_touchpad_raw_info *raw_info)
1965 struct hidpp_report response;
1967 u8 *params = (u8 *)response.fap.params;
1969 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
1970 CMD_TOUCHPAD_GET_RAW_INFO, NULL, 0, &response);
1973 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
1980 raw_info->x_size = get_unaligned_be16(¶ms[0]);
1981 raw_info->y_size = get_unaligned_be16(¶ms[2]);
1982 raw_info->z_range = params[4];
1983 raw_info->area_range = params[5];
1984 raw_info->maxcontacts = params[7];
1985 raw_info->origin = params[8];
1986 /* res is given in unit per inch */
1987 raw_info->res = get_unaligned_be16(¶ms[13]) * 2 / 51;
1992 static int hidpp_touchpad_set_raw_report_state(struct hidpp_device *hidpp_dev,
1993 u8 feature_index, bool send_raw_reports,
1994 bool sensor_enhanced_settings)
1996 struct hidpp_report response;
2000 * bit 0 - enable raw
2001 * bit 1 - 16bit Z, no area
2002 * bit 2 - enhanced sensitivity
2003 * bit 3 - width, height (4 bits each) instead of area
2004 * bit 4 - send raw + gestures (degrades smoothness)
2005 * remaining bits - reserved
2007 u8 params = send_raw_reports | (sensor_enhanced_settings << 2);
2009 return hidpp_send_fap_command_sync(hidpp_dev, feature_index,
2010 CMD_TOUCHPAD_SET_RAW_REPORT_STATE, ¶ms, 1, &response);
2013 static void hidpp_touchpad_touch_event(u8 *data,
2014 struct hidpp_touchpad_raw_xy_finger *finger)
2016 u8 x_m = data[0] << 2;
2017 u8 y_m = data[2] << 2;
2019 finger->x = x_m << 6 | data[1];
2020 finger->y = y_m << 6 | data[3];
2022 finger->contact_type = data[0] >> 6;
2023 finger->contact_status = data[2] >> 6;
2025 finger->z = data[4];
2026 finger->area = data[5];
2027 finger->finger_id = data[6] >> 4;
2030 static void hidpp_touchpad_raw_xy_event(struct hidpp_device *hidpp_dev,
2031 u8 *data, struct hidpp_touchpad_raw_xy *raw_xy)
2033 memset(raw_xy, 0, sizeof(struct hidpp_touchpad_raw_xy));
2034 raw_xy->end_of_frame = data[8] & 0x01;
2035 raw_xy->spurious_flag = (data[8] >> 1) & 0x01;
2036 raw_xy->finger_count = data[15] & 0x0f;
2037 raw_xy->button = (data[8] >> 2) & 0x01;
2039 if (raw_xy->finger_count) {
2040 hidpp_touchpad_touch_event(&data[2], &raw_xy->fingers[0]);
2041 hidpp_touchpad_touch_event(&data[9], &raw_xy->fingers[1]);
2045 /* -------------------------------------------------------------------------- */
2046 /* 0x8123: Force feedback support */
2047 /* -------------------------------------------------------------------------- */
2049 #define HIDPP_FF_GET_INFO 0x01
2050 #define HIDPP_FF_RESET_ALL 0x11
2051 #define HIDPP_FF_DOWNLOAD_EFFECT 0x21
2052 #define HIDPP_FF_SET_EFFECT_STATE 0x31
2053 #define HIDPP_FF_DESTROY_EFFECT 0x41
2054 #define HIDPP_FF_GET_APERTURE 0x51
2055 #define HIDPP_FF_SET_APERTURE 0x61
2056 #define HIDPP_FF_GET_GLOBAL_GAINS 0x71
2057 #define HIDPP_FF_SET_GLOBAL_GAINS 0x81
2059 #define HIDPP_FF_EFFECT_STATE_GET 0x00
2060 #define HIDPP_FF_EFFECT_STATE_STOP 0x01
2061 #define HIDPP_FF_EFFECT_STATE_PLAY 0x02
2062 #define HIDPP_FF_EFFECT_STATE_PAUSE 0x03
2064 #define HIDPP_FF_EFFECT_CONSTANT 0x00
2065 #define HIDPP_FF_EFFECT_PERIODIC_SINE 0x01
2066 #define HIDPP_FF_EFFECT_PERIODIC_SQUARE 0x02
2067 #define HIDPP_FF_EFFECT_PERIODIC_TRIANGLE 0x03
2068 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP 0x04
2069 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN 0x05
2070 #define HIDPP_FF_EFFECT_SPRING 0x06
2071 #define HIDPP_FF_EFFECT_DAMPER 0x07
2072 #define HIDPP_FF_EFFECT_FRICTION 0x08
2073 #define HIDPP_FF_EFFECT_INERTIA 0x09
2074 #define HIDPP_FF_EFFECT_RAMP 0x0A
2076 #define HIDPP_FF_EFFECT_AUTOSTART 0x80
2078 #define HIDPP_FF_EFFECTID_NONE -1
2079 #define HIDPP_FF_EFFECTID_AUTOCENTER -2
2080 #define HIDPP_AUTOCENTER_PARAMS_LENGTH 18
2082 #define HIDPP_FF_MAX_PARAMS 20
2083 #define HIDPP_FF_RESERVED_SLOTS 1
2085 struct hidpp_ff_private_data {
2086 struct hidpp_device *hidpp;
2094 struct workqueue_struct *wq;
2095 atomic_t workqueue_size;
2098 struct hidpp_ff_work_data {
2099 struct work_struct work;
2100 struct hidpp_ff_private_data *data;
2103 u8 params[HIDPP_FF_MAX_PARAMS];
2107 static const signed short hidpp_ff_effects[] = {
2122 static const signed short hidpp_ff_effects_v2[] = {
2129 static const u8 HIDPP_FF_CONDITION_CMDS[] = {
2130 HIDPP_FF_EFFECT_SPRING,
2131 HIDPP_FF_EFFECT_FRICTION,
2132 HIDPP_FF_EFFECT_DAMPER,
2133 HIDPP_FF_EFFECT_INERTIA
2136 static const char *HIDPP_FF_CONDITION_NAMES[] = {
2144 static u8 hidpp_ff_find_effect(struct hidpp_ff_private_data *data, int effect_id)
2148 for (i = 0; i < data->num_effects; i++)
2149 if (data->effect_ids[i] == effect_id)
2155 static void hidpp_ff_work_handler(struct work_struct *w)
2157 struct hidpp_ff_work_data *wd = container_of(w, struct hidpp_ff_work_data, work);
2158 struct hidpp_ff_private_data *data = wd->data;
2159 struct hidpp_report response;
2163 /* add slot number if needed */
2164 switch (wd->effect_id) {
2165 case HIDPP_FF_EFFECTID_AUTOCENTER:
2166 wd->params[0] = data->slot_autocenter;
2168 case HIDPP_FF_EFFECTID_NONE:
2169 /* leave slot as zero */
2172 /* find current slot for effect */
2173 wd->params[0] = hidpp_ff_find_effect(data, wd->effect_id);
2177 /* send command and wait for reply */
2178 ret = hidpp_send_fap_command_sync(data->hidpp, data->feature_index,
2179 wd->command, wd->params, wd->size, &response);
2182 hid_err(data->hidpp->hid_dev, "Failed to send command to device!\n");
2186 /* parse return data */
2187 switch (wd->command) {
2188 case HIDPP_FF_DOWNLOAD_EFFECT:
2189 slot = response.fap.params[0];
2190 if (slot > 0 && slot <= data->num_effects) {
2191 if (wd->effect_id >= 0)
2192 /* regular effect uploaded */
2193 data->effect_ids[slot-1] = wd->effect_id;
2194 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
2195 /* autocenter spring uploaded */
2196 data->slot_autocenter = slot;
2199 case HIDPP_FF_DESTROY_EFFECT:
2200 if (wd->effect_id >= 0)
2201 /* regular effect destroyed */
2202 data->effect_ids[wd->params[0]-1] = -1;
2203 else if (wd->effect_id >= HIDPP_FF_EFFECTID_AUTOCENTER)
2204 /* autocenter spring destoyed */
2205 data->slot_autocenter = 0;
2207 case HIDPP_FF_SET_GLOBAL_GAINS:
2208 data->gain = (wd->params[0] << 8) + wd->params[1];
2210 case HIDPP_FF_SET_APERTURE:
2211 data->range = (wd->params[0] << 8) + wd->params[1];
2214 /* no action needed */
2219 atomic_dec(&data->workqueue_size);
2223 static int hidpp_ff_queue_work(struct hidpp_ff_private_data *data, int effect_id, u8 command, u8 *params, u8 size)
2225 struct hidpp_ff_work_data *wd = kzalloc(sizeof(*wd), GFP_KERNEL);
2231 INIT_WORK(&wd->work, hidpp_ff_work_handler);
2234 wd->effect_id = effect_id;
2235 wd->command = command;
2237 memcpy(wd->params, params, size);
2239 atomic_inc(&data->workqueue_size);
2240 queue_work(data->wq, &wd->work);
2242 /* warn about excessive queue size */
2243 s = atomic_read(&data->workqueue_size);
2244 if (s >= 20 && s % 20 == 0)
2245 hid_warn(data->hidpp->hid_dev, "Force feedback command queue contains %d commands, causing substantial delays!", s);
2250 static int hidpp_ff_upload_effect(struct input_dev *dev, struct ff_effect *effect, struct ff_effect *old)
2252 struct hidpp_ff_private_data *data = dev->ff->private;
2257 /* set common parameters */
2258 params[2] = effect->replay.length >> 8;
2259 params[3] = effect->replay.length & 255;
2260 params[4] = effect->replay.delay >> 8;
2261 params[5] = effect->replay.delay & 255;
2263 switch (effect->type) {
2265 force = (effect->u.constant.level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
2266 params[1] = HIDPP_FF_EFFECT_CONSTANT;
2267 params[6] = force >> 8;
2268 params[7] = force & 255;
2269 params[8] = effect->u.constant.envelope.attack_level >> 7;
2270 params[9] = effect->u.constant.envelope.attack_length >> 8;
2271 params[10] = effect->u.constant.envelope.attack_length & 255;
2272 params[11] = effect->u.constant.envelope.fade_level >> 7;
2273 params[12] = effect->u.constant.envelope.fade_length >> 8;
2274 params[13] = effect->u.constant.envelope.fade_length & 255;
2276 dbg_hid("Uploading constant force level=%d in dir %d = %d\n",
2277 effect->u.constant.level,
2278 effect->direction, force);
2279 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
2280 effect->u.constant.envelope.attack_level,
2281 effect->u.constant.envelope.attack_length,
2282 effect->u.constant.envelope.fade_level,
2283 effect->u.constant.envelope.fade_length);
2287 switch (effect->u.periodic.waveform) {
2289 params[1] = HIDPP_FF_EFFECT_PERIODIC_SINE;
2292 params[1] = HIDPP_FF_EFFECT_PERIODIC_SQUARE;
2295 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP;
2298 params[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN;
2301 params[1] = HIDPP_FF_EFFECT_PERIODIC_TRIANGLE;
2304 hid_err(data->hidpp->hid_dev, "Unexpected periodic waveform type %i!\n", effect->u.periodic.waveform);
2307 force = (effect->u.periodic.magnitude * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
2308 params[6] = effect->u.periodic.magnitude >> 8;
2309 params[7] = effect->u.periodic.magnitude & 255;
2310 params[8] = effect->u.periodic.offset >> 8;
2311 params[9] = effect->u.periodic.offset & 255;
2312 params[10] = effect->u.periodic.period >> 8;
2313 params[11] = effect->u.periodic.period & 255;
2314 params[12] = effect->u.periodic.phase >> 8;
2315 params[13] = effect->u.periodic.phase & 255;
2316 params[14] = effect->u.periodic.envelope.attack_level >> 7;
2317 params[15] = effect->u.periodic.envelope.attack_length >> 8;
2318 params[16] = effect->u.periodic.envelope.attack_length & 255;
2319 params[17] = effect->u.periodic.envelope.fade_level >> 7;
2320 params[18] = effect->u.periodic.envelope.fade_length >> 8;
2321 params[19] = effect->u.periodic.envelope.fade_length & 255;
2323 dbg_hid("Uploading periodic force mag=%d/dir=%d, offset=%d, period=%d ms, phase=%d\n",
2324 effect->u.periodic.magnitude, effect->direction,
2325 effect->u.periodic.offset,
2326 effect->u.periodic.period,
2327 effect->u.periodic.phase);
2328 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
2329 effect->u.periodic.envelope.attack_level,
2330 effect->u.periodic.envelope.attack_length,
2331 effect->u.periodic.envelope.fade_level,
2332 effect->u.periodic.envelope.fade_length);
2336 params[1] = HIDPP_FF_EFFECT_RAMP;
2337 force = (effect->u.ramp.start_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
2338 params[6] = force >> 8;
2339 params[7] = force & 255;
2340 force = (effect->u.ramp.end_level * fixp_sin16((effect->direction * 360) >> 16)) >> 15;
2341 params[8] = force >> 8;
2342 params[9] = force & 255;
2343 params[10] = effect->u.ramp.envelope.attack_level >> 7;
2344 params[11] = effect->u.ramp.envelope.attack_length >> 8;
2345 params[12] = effect->u.ramp.envelope.attack_length & 255;
2346 params[13] = effect->u.ramp.envelope.fade_level >> 7;
2347 params[14] = effect->u.ramp.envelope.fade_length >> 8;
2348 params[15] = effect->u.ramp.envelope.fade_length & 255;
2350 dbg_hid("Uploading ramp force level=%d -> %d in dir %d = %d\n",
2351 effect->u.ramp.start_level,
2352 effect->u.ramp.end_level,
2353 effect->direction, force);
2354 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
2355 effect->u.ramp.envelope.attack_level,
2356 effect->u.ramp.envelope.attack_length,
2357 effect->u.ramp.envelope.fade_level,
2358 effect->u.ramp.envelope.fade_length);
2364 params[1] = HIDPP_FF_CONDITION_CMDS[effect->type - FF_SPRING];
2365 params[6] = effect->u.condition[0].left_saturation >> 9;
2366 params[7] = (effect->u.condition[0].left_saturation >> 1) & 255;
2367 params[8] = effect->u.condition[0].left_coeff >> 8;
2368 params[9] = effect->u.condition[0].left_coeff & 255;
2369 params[10] = effect->u.condition[0].deadband >> 9;
2370 params[11] = (effect->u.condition[0].deadband >> 1) & 255;
2371 params[12] = effect->u.condition[0].center >> 8;
2372 params[13] = effect->u.condition[0].center & 255;
2373 params[14] = effect->u.condition[0].right_coeff >> 8;
2374 params[15] = effect->u.condition[0].right_coeff & 255;
2375 params[16] = effect->u.condition[0].right_saturation >> 9;
2376 params[17] = (effect->u.condition[0].right_saturation >> 1) & 255;
2378 dbg_hid("Uploading %s force left coeff=%d, left sat=%d, right coeff=%d, right sat=%d\n",
2379 HIDPP_FF_CONDITION_NAMES[effect->type - FF_SPRING],
2380 effect->u.condition[0].left_coeff,
2381 effect->u.condition[0].left_saturation,
2382 effect->u.condition[0].right_coeff,
2383 effect->u.condition[0].right_saturation);
2384 dbg_hid(" deadband=%d, center=%d\n",
2385 effect->u.condition[0].deadband,
2386 effect->u.condition[0].center);
2389 hid_err(data->hidpp->hid_dev, "Unexpected force type %i!\n", effect->type);
2393 return hidpp_ff_queue_work(data, effect->id, HIDPP_FF_DOWNLOAD_EFFECT, params, size);
2396 static int hidpp_ff_playback(struct input_dev *dev, int effect_id, int value)
2398 struct hidpp_ff_private_data *data = dev->ff->private;
2401 params[1] = value ? HIDPP_FF_EFFECT_STATE_PLAY : HIDPP_FF_EFFECT_STATE_STOP;
2403 dbg_hid("St%sing playback of effect %d.\n", value?"art":"opp", effect_id);
2405 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_SET_EFFECT_STATE, params, ARRAY_SIZE(params));
2408 static int hidpp_ff_erase_effect(struct input_dev *dev, int effect_id)
2410 struct hidpp_ff_private_data *data = dev->ff->private;
2413 dbg_hid("Erasing effect %d.\n", effect_id);
2415 return hidpp_ff_queue_work(data, effect_id, HIDPP_FF_DESTROY_EFFECT, &slot, 1);
2418 static void hidpp_ff_set_autocenter(struct input_dev *dev, u16 magnitude)
2420 struct hidpp_ff_private_data *data = dev->ff->private;
2421 u8 params[HIDPP_AUTOCENTER_PARAMS_LENGTH];
2423 dbg_hid("Setting autocenter to %d.\n", magnitude);
2425 /* start a standard spring effect */
2426 params[1] = HIDPP_FF_EFFECT_SPRING | HIDPP_FF_EFFECT_AUTOSTART;
2427 /* zero delay and duration */
2428 params[2] = params[3] = params[4] = params[5] = 0;
2429 /* set coeff to 25% of saturation */
2430 params[8] = params[14] = magnitude >> 11;
2431 params[9] = params[15] = (magnitude >> 3) & 255;
2432 params[6] = params[16] = magnitude >> 9;
2433 params[7] = params[17] = (magnitude >> 1) & 255;
2434 /* zero deadband and center */
2435 params[10] = params[11] = params[12] = params[13] = 0;
2437 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_AUTOCENTER, HIDPP_FF_DOWNLOAD_EFFECT, params, ARRAY_SIZE(params));
2440 static void hidpp_ff_set_gain(struct input_dev *dev, u16 gain)
2442 struct hidpp_ff_private_data *data = dev->ff->private;
2445 dbg_hid("Setting gain to %d.\n", gain);
2447 params[0] = gain >> 8;
2448 params[1] = gain & 255;
2449 params[2] = 0; /* no boost */
2452 hidpp_ff_queue_work(data, HIDPP_FF_EFFECTID_NONE, HIDPP_FF_SET_GLOBAL_GAINS, params, ARRAY_SIZE(params));
2455 static ssize_t hidpp_ff_range_show(struct device *dev, struct device_attribute *attr, char *buf)
2457 struct hid_device *hid = to_hid_device(dev);
2458 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2459 struct input_dev *idev = hidinput->input;
2460 struct hidpp_ff_private_data *data = idev->ff->private;
2462 return scnprintf(buf, PAGE_SIZE, "%u\n", data->range);
2465 static ssize_t hidpp_ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
2467 struct hid_device *hid = to_hid_device(dev);
2468 struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2469 struct input_dev *idev = hidinput->input;
2470 struct hidpp_ff_private_data *data = idev->ff->private;
2472 int range = simple_strtoul(buf, NULL, 10);
2474 range = clamp(range, 180, 900);
2476 params[0] = range >> 8;
2477 params[1] = range & 0x00FF;
2479 hidpp_ff_queue_work(data, -1, HIDPP_FF_SET_APERTURE, params, ARRAY_SIZE(params));
2484 static DEVICE_ATTR(range, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH, hidpp_ff_range_show, hidpp_ff_range_store);
2486 static void hidpp_ff_destroy(struct ff_device *ff)
2488 struct hidpp_ff_private_data *data = ff->private;
2489 struct hid_device *hid = data->hidpp->hid_dev;
2491 hid_info(hid, "Unloading HID++ force feedback.\n");
2493 device_remove_file(&hid->dev, &dev_attr_range);
2494 destroy_workqueue(data->wq);
2495 kfree(data->effect_ids);
2498 static int hidpp_ff_init(struct hidpp_device *hidpp,
2499 struct hidpp_ff_private_data *data)
2501 struct hid_device *hid = hidpp->hid_dev;
2502 struct hid_input *hidinput;
2503 struct input_dev *dev;
2504 const struct usb_device_descriptor *udesc = &(hid_to_usb_dev(hid)->descriptor);
2505 const u16 bcdDevice = le16_to_cpu(udesc->bcdDevice);
2506 struct ff_device *ff;
2507 int error, j, num_slots = data->num_effects;
2510 if (list_empty(&hid->inputs)) {
2511 hid_err(hid, "no inputs found\n");
2514 hidinput = list_entry(hid->inputs.next, struct hid_input, list);
2515 dev = hidinput->input;
2518 hid_err(hid, "Struct input_dev not set!\n");
2522 /* Get firmware release */
2523 version = bcdDevice & 255;
2525 /* Set supported force feedback capabilities */
2526 for (j = 0; hidpp_ff_effects[j] >= 0; j++)
2527 set_bit(hidpp_ff_effects[j], dev->ffbit);
2529 for (j = 0; hidpp_ff_effects_v2[j] >= 0; j++)
2530 set_bit(hidpp_ff_effects_v2[j], dev->ffbit);
2532 error = input_ff_create(dev, num_slots);
2535 hid_err(dev, "Failed to create FF device!\n");
2539 * Create a copy of passed data, so we can transfer memory
2540 * ownership to FF core
2542 data = kmemdup(data, sizeof(*data), GFP_KERNEL);
2545 data->effect_ids = kcalloc(num_slots, sizeof(int), GFP_KERNEL);
2546 if (!data->effect_ids) {
2550 data->wq = create_singlethread_workqueue("hidpp-ff-sendqueue");
2552 kfree(data->effect_ids);
2557 data->hidpp = hidpp;
2558 data->version = version;
2559 for (j = 0; j < num_slots; j++)
2560 data->effect_ids[j] = -1;
2565 ff->upload = hidpp_ff_upload_effect;
2566 ff->erase = hidpp_ff_erase_effect;
2567 ff->playback = hidpp_ff_playback;
2568 ff->set_gain = hidpp_ff_set_gain;
2569 ff->set_autocenter = hidpp_ff_set_autocenter;
2570 ff->destroy = hidpp_ff_destroy;
2572 /* Create sysfs interface */
2573 error = device_create_file(&(hidpp->hid_dev->dev), &dev_attr_range);
2575 hid_warn(hidpp->hid_dev, "Unable to create sysfs interface for \"range\", errno %d!\n", error);
2577 /* init the hardware command queue */
2578 atomic_set(&data->workqueue_size, 0);
2580 hid_info(hid, "Force feedback support loaded (firmware release %d).\n",
2586 /* ************************************************************************** */
2588 /* Device Support */
2590 /* ************************************************************************** */
2592 /* -------------------------------------------------------------------------- */
2593 /* Touchpad HID++ devices */
2594 /* -------------------------------------------------------------------------- */
2596 #define WTP_MANUAL_RESOLUTION 39
2601 u8 mt_feature_index;
2602 u8 button_feature_index;
2605 unsigned int resolution;
2608 static int wtp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
2609 struct hid_field *field, struct hid_usage *usage,
2610 unsigned long **bit, int *max)
2615 static void wtp_populate_input(struct hidpp_device *hidpp,
2616 struct input_dev *input_dev)
2618 struct wtp_data *wd = hidpp->private_data;
2620 __set_bit(EV_ABS, input_dev->evbit);
2621 __set_bit(EV_KEY, input_dev->evbit);
2622 __clear_bit(EV_REL, input_dev->evbit);
2623 __clear_bit(EV_LED, input_dev->evbit);
2625 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0, wd->x_size, 0, 0);
2626 input_abs_set_res(input_dev, ABS_MT_POSITION_X, wd->resolution);
2627 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0, wd->y_size, 0, 0);
2628 input_abs_set_res(input_dev, ABS_MT_POSITION_Y, wd->resolution);
2630 /* Max pressure is not given by the devices, pick one */
2631 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 50, 0, 0);
2633 input_set_capability(input_dev, EV_KEY, BTN_LEFT);
2635 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS)
2636 input_set_capability(input_dev, EV_KEY, BTN_RIGHT);
2638 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
2640 input_mt_init_slots(input_dev, wd->maxcontacts, INPUT_MT_POINTER |
2641 INPUT_MT_DROP_UNUSED);
2644 static void wtp_touch_event(struct hidpp_device *hidpp,
2645 struct hidpp_touchpad_raw_xy_finger *touch_report)
2647 struct wtp_data *wd = hidpp->private_data;
2650 if (!touch_report->finger_id || touch_report->contact_type)
2651 /* no actual data */
2654 slot = input_mt_get_slot_by_key(hidpp->input, touch_report->finger_id);
2656 input_mt_slot(hidpp->input, slot);
2657 input_mt_report_slot_state(hidpp->input, MT_TOOL_FINGER,
2658 touch_report->contact_status);
2659 if (touch_report->contact_status) {
2660 input_event(hidpp->input, EV_ABS, ABS_MT_POSITION_X,
2662 input_event(hidpp->input, EV_ABS, ABS_MT_POSITION_Y,
2663 wd->flip_y ? wd->y_size - touch_report->y :
2665 input_event(hidpp->input, EV_ABS, ABS_MT_PRESSURE,
2666 touch_report->area);
2670 static void wtp_send_raw_xy_event(struct hidpp_device *hidpp,
2671 struct hidpp_touchpad_raw_xy *raw)
2675 for (i = 0; i < 2; i++)
2676 wtp_touch_event(hidpp, &(raw->fingers[i]));
2678 if (raw->end_of_frame &&
2679 !(hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS))
2680 input_event(hidpp->input, EV_KEY, BTN_LEFT, raw->button);
2682 if (raw->end_of_frame || raw->finger_count <= 2) {
2683 input_mt_sync_frame(hidpp->input);
2684 input_sync(hidpp->input);
2688 static int wtp_mouse_raw_xy_event(struct hidpp_device *hidpp, u8 *data)
2690 struct wtp_data *wd = hidpp->private_data;
2691 u8 c1_area = ((data[7] & 0xf) * (data[7] & 0xf) +
2692 (data[7] >> 4) * (data[7] >> 4)) / 2;
2693 u8 c2_area = ((data[13] & 0xf) * (data[13] & 0xf) +
2694 (data[13] >> 4) * (data[13] >> 4)) / 2;
2695 struct hidpp_touchpad_raw_xy raw = {
2696 .timestamp = data[1],
2700 .contact_status = !!data[7],
2701 .x = get_unaligned_le16(&data[3]),
2702 .y = get_unaligned_le16(&data[5]),
2705 .finger_id = data[2],
2708 .contact_status = !!data[13],
2709 .x = get_unaligned_le16(&data[9]),
2710 .y = get_unaligned_le16(&data[11]),
2713 .finger_id = data[8],
2716 .finger_count = wd->maxcontacts,
2718 .end_of_frame = (data[0] >> 7) == 0,
2719 .button = data[0] & 0x01,
2722 wtp_send_raw_xy_event(hidpp, &raw);
2727 static int wtp_raw_event(struct hid_device *hdev, u8 *data, int size)
2729 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2730 struct wtp_data *wd = hidpp->private_data;
2731 struct hidpp_report *report = (struct hidpp_report *)data;
2732 struct hidpp_touchpad_raw_xy raw;
2734 if (!wd || !hidpp->input)
2740 hid_err(hdev, "Received HID report of bad size (%d)",
2744 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS) {
2745 input_event(hidpp->input, EV_KEY, BTN_LEFT,
2746 !!(data[1] & 0x01));
2747 input_event(hidpp->input, EV_KEY, BTN_RIGHT,
2748 !!(data[1] & 0x02));
2749 input_sync(hidpp->input);
2754 return wtp_mouse_raw_xy_event(hidpp, &data[7]);
2756 case REPORT_ID_HIDPP_LONG:
2757 /* size is already checked in hidpp_raw_event. */
2758 if ((report->fap.feature_index != wd->mt_feature_index) ||
2759 (report->fap.funcindex_clientid != EVENT_TOUCHPAD_RAW_XY))
2761 hidpp_touchpad_raw_xy_event(hidpp, data + 4, &raw);
2763 wtp_send_raw_xy_event(hidpp, &raw);
2770 static int wtp_get_config(struct hidpp_device *hidpp)
2772 struct wtp_data *wd = hidpp->private_data;
2773 struct hidpp_touchpad_raw_info raw_info = {0};
2777 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_TOUCHPAD_RAW_XY,
2778 &wd->mt_feature_index, &feature_type);
2780 /* means that the device is not powered up */
2783 ret = hidpp_touchpad_get_raw_info(hidpp, wd->mt_feature_index,
2788 wd->x_size = raw_info.x_size;
2789 wd->y_size = raw_info.y_size;
2790 wd->maxcontacts = raw_info.maxcontacts;
2791 wd->flip_y = raw_info.origin == TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT;
2792 wd->resolution = raw_info.res;
2793 if (!wd->resolution)
2794 wd->resolution = WTP_MANUAL_RESOLUTION;
2799 static int wtp_allocate(struct hid_device *hdev, const struct hid_device_id *id)
2801 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2802 struct wtp_data *wd;
2804 wd = devm_kzalloc(&hdev->dev, sizeof(struct wtp_data),
2809 hidpp->private_data = wd;
2814 static int wtp_connect(struct hid_device *hdev, bool connected)
2816 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2817 struct wtp_data *wd = hidpp->private_data;
2821 ret = wtp_get_config(hidpp);
2823 hid_err(hdev, "Can not get wtp config: %d\n", ret);
2828 return hidpp_touchpad_set_raw_report_state(hidpp, wd->mt_feature_index,
2832 /* ------------------------------------------------------------------------- */
2833 /* Logitech M560 devices */
2834 /* ------------------------------------------------------------------------- */
2837 * Logitech M560 protocol overview
2839 * The Logitech M560 mouse, is designed for windows 8. When the middle and/or
2840 * the sides buttons are pressed, it sends some keyboard keys events
2841 * instead of buttons ones.
2842 * To complicate things further, the middle button keys sequence
2843 * is different from the odd press and the even press.
2845 * forward button -> Super_R
2846 * backward button -> Super_L+'d' (press only)
2847 * middle button -> 1st time: Alt_L+SuperL+XF86TouchpadOff (press only)
2848 * 2nd time: left-click (press only)
2849 * NB: press-only means that when the button is pressed, the
2850 * KeyPress/ButtonPress and KeyRelease/ButtonRelease events are generated
2851 * together sequentially; instead when the button is released, no event is
2855 * 10<xx>0a 3500af03 (where <xx> is the mouse id),
2856 * the mouse reacts differently:
2857 * - it never sends a keyboard key event
2858 * - for the three mouse button it sends:
2859 * middle button press 11<xx>0a 3500af00...
2860 * side 1 button (forward) press 11<xx>0a 3500b000...
2861 * side 2 button (backward) press 11<xx>0a 3500ae00...
2862 * middle/side1/side2 button release 11<xx>0a 35000000...
2865 static const u8 m560_config_parameter[] = {0x00, 0xaf, 0x03};
2867 /* how buttons are mapped in the report */
2868 #define M560_MOUSE_BTN_LEFT 0x01
2869 #define M560_MOUSE_BTN_RIGHT 0x02
2870 #define M560_MOUSE_BTN_WHEEL_LEFT 0x08
2871 #define M560_MOUSE_BTN_WHEEL_RIGHT 0x10
2873 #define M560_SUB_ID 0x0a
2874 #define M560_BUTTON_MODE_REGISTER 0x35
2876 static int m560_send_config_command(struct hid_device *hdev, bool connected)
2878 struct hidpp_report response;
2879 struct hidpp_device *hidpp_dev;
2881 hidpp_dev = hid_get_drvdata(hdev);
2883 return hidpp_send_rap_command_sync(
2885 REPORT_ID_HIDPP_SHORT,
2887 M560_BUTTON_MODE_REGISTER,
2888 (u8 *)m560_config_parameter,
2889 sizeof(m560_config_parameter),
2894 static int m560_raw_event(struct hid_device *hdev, u8 *data, int size)
2896 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
2899 if (!hidpp->input) {
2900 hid_err(hdev, "error in parameter\n");
2905 hid_err(hdev, "error in report\n");
2909 if (data[0] == REPORT_ID_HIDPP_LONG &&
2910 data[2] == M560_SUB_ID && data[6] == 0x00) {
2912 * m560 mouse report for middle, forward and backward button
2915 * data[1] = device-id
2917 * data[5] = 0xaf -> middle
2920 * 0x00 -> release all
2926 input_report_key(hidpp->input, BTN_MIDDLE, 1);
2929 input_report_key(hidpp->input, BTN_FORWARD, 1);
2932 input_report_key(hidpp->input, BTN_BACK, 1);
2935 input_report_key(hidpp->input, BTN_BACK, 0);
2936 input_report_key(hidpp->input, BTN_FORWARD, 0);
2937 input_report_key(hidpp->input, BTN_MIDDLE, 0);
2940 hid_err(hdev, "error in report\n");
2943 input_sync(hidpp->input);
2945 } else if (data[0] == 0x02) {
2947 * Logitech M560 mouse report
2949 * data[0] = type (0x02)
2950 * data[1..2] = buttons
2957 input_report_key(hidpp->input, BTN_LEFT,
2958 !!(data[1] & M560_MOUSE_BTN_LEFT));
2959 input_report_key(hidpp->input, BTN_RIGHT,
2960 !!(data[1] & M560_MOUSE_BTN_RIGHT));
2962 if (data[1] & M560_MOUSE_BTN_WHEEL_LEFT) {
2963 input_report_rel(hidpp->input, REL_HWHEEL, -1);
2964 input_report_rel(hidpp->input, REL_HWHEEL_HI_RES,
2966 } else if (data[1] & M560_MOUSE_BTN_WHEEL_RIGHT) {
2967 input_report_rel(hidpp->input, REL_HWHEEL, 1);
2968 input_report_rel(hidpp->input, REL_HWHEEL_HI_RES,
2972 v = hid_snto32(hid_field_extract(hdev, data+3, 0, 12), 12);
2973 input_report_rel(hidpp->input, REL_X, v);
2975 v = hid_snto32(hid_field_extract(hdev, data+3, 12, 12), 12);
2976 input_report_rel(hidpp->input, REL_Y, v);
2978 v = hid_snto32(data[6], 8);
2980 hidpp_scroll_counter_handle_scroll(hidpp->input,
2981 &hidpp->vertical_wheel_counter, v);
2983 input_sync(hidpp->input);
2989 static void m560_populate_input(struct hidpp_device *hidpp,
2990 struct input_dev *input_dev)
2992 __set_bit(EV_KEY, input_dev->evbit);
2993 __set_bit(BTN_MIDDLE, input_dev->keybit);
2994 __set_bit(BTN_RIGHT, input_dev->keybit);
2995 __set_bit(BTN_LEFT, input_dev->keybit);
2996 __set_bit(BTN_BACK, input_dev->keybit);
2997 __set_bit(BTN_FORWARD, input_dev->keybit);
2999 __set_bit(EV_REL, input_dev->evbit);
3000 __set_bit(REL_X, input_dev->relbit);
3001 __set_bit(REL_Y, input_dev->relbit);
3002 __set_bit(REL_WHEEL, input_dev->relbit);
3003 __set_bit(REL_HWHEEL, input_dev->relbit);
3004 __set_bit(REL_WHEEL_HI_RES, input_dev->relbit);
3005 __set_bit(REL_HWHEEL_HI_RES, input_dev->relbit);
3008 static int m560_input_mapping(struct hid_device *hdev, struct hid_input *hi,
3009 struct hid_field *field, struct hid_usage *usage,
3010 unsigned long **bit, int *max)
3015 /* ------------------------------------------------------------------------- */
3016 /* Logitech K400 devices */
3017 /* ------------------------------------------------------------------------- */
3020 * The Logitech K400 keyboard has an embedded touchpad which is seen
3021 * as a mouse from the OS point of view. There is a hardware shortcut to disable
3022 * tap-to-click but the setting is not remembered accross reset, annoying some
3025 * We can toggle this feature from the host by using the feature 0x6010:
3029 struct k400_private_data {
3033 static int k400_disable_tap_to_click(struct hidpp_device *hidpp)
3035 struct k400_private_data *k400 = hidpp->private_data;
3036 struct hidpp_touchpad_fw_items items = {};
3040 if (!k400->feature_index) {
3041 ret = hidpp_root_get_feature(hidpp,
3042 HIDPP_PAGE_TOUCHPAD_FW_ITEMS,
3043 &k400->feature_index, &feature_type);
3045 /* means that the device is not powered up */
3049 ret = hidpp_touchpad_fw_items_set(hidpp, k400->feature_index, &items);
3056 static int k400_allocate(struct hid_device *hdev)
3058 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3059 struct k400_private_data *k400;
3061 k400 = devm_kzalloc(&hdev->dev, sizeof(struct k400_private_data),
3066 hidpp->private_data = k400;
3071 static int k400_connect(struct hid_device *hdev, bool connected)
3073 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3075 if (!disable_tap_to_click)
3078 return k400_disable_tap_to_click(hidpp);
3081 /* ------------------------------------------------------------------------- */
3082 /* Logitech G920 Driving Force Racing Wheel for Xbox One */
3083 /* ------------------------------------------------------------------------- */
3085 #define HIDPP_PAGE_G920_FORCE_FEEDBACK 0x8123
3087 static int g920_ff_set_autocenter(struct hidpp_device *hidpp,
3088 struct hidpp_ff_private_data *data)
3090 struct hidpp_report response;
3091 u8 params[HIDPP_AUTOCENTER_PARAMS_LENGTH] = {
3092 [1] = HIDPP_FF_EFFECT_SPRING | HIDPP_FF_EFFECT_AUTOSTART,
3096 /* initialize with zero autocenter to get wheel in usable state */
3098 dbg_hid("Setting autocenter to 0.\n");
3099 ret = hidpp_send_fap_command_sync(hidpp, data->feature_index,
3100 HIDPP_FF_DOWNLOAD_EFFECT,
3101 params, ARRAY_SIZE(params),
3104 hid_warn(hidpp->hid_dev, "Failed to autocenter device!\n");
3106 data->slot_autocenter = response.fap.params[0];
3111 static int g920_get_config(struct hidpp_device *hidpp,
3112 struct hidpp_ff_private_data *data)
3114 struct hidpp_report response;
3118 memset(data, 0, sizeof(*data));
3120 /* Find feature and store for later use */
3121 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_G920_FORCE_FEEDBACK,
3122 &data->feature_index, &feature_type);
3126 /* Read number of slots available in device */
3127 ret = hidpp_send_fap_command_sync(hidpp, data->feature_index,
3134 hid_err(hidpp->hid_dev,
3135 "%s: received protocol error 0x%02x\n", __func__, ret);
3139 data->num_effects = response.fap.params[0] - HIDPP_FF_RESERVED_SLOTS;
3141 /* reset all forces */
3142 ret = hidpp_send_fap_command_sync(hidpp, data->feature_index,
3147 hid_warn(hidpp->hid_dev, "Failed to reset all forces!\n");
3149 ret = hidpp_send_fap_command_sync(hidpp, data->feature_index,
3150 HIDPP_FF_GET_APERTURE,
3154 hid_warn(hidpp->hid_dev,
3155 "Failed to read range from device!\n");
3158 900 : get_unaligned_be16(&response.fap.params[0]);
3160 /* Read the current gain values */
3161 ret = hidpp_send_fap_command_sync(hidpp, data->feature_index,
3162 HIDPP_FF_GET_GLOBAL_GAINS,
3166 hid_warn(hidpp->hid_dev,
3167 "Failed to read gain values from device!\n");
3169 0xffff : get_unaligned_be16(&response.fap.params[0]);
3171 /* ignore boost value at response.fap.params[2] */
3173 return g920_ff_set_autocenter(hidpp, data);
3176 /* -------------------------------------------------------------------------- */
3177 /* Logitech Dinovo Mini keyboard with builtin touchpad */
3178 /* -------------------------------------------------------------------------- */
3179 #define DINOVO_MINI_PRODUCT_ID 0xb30c
3181 static int lg_dinovo_input_mapping(struct hid_device *hdev, struct hid_input *hi,
3182 struct hid_field *field, struct hid_usage *usage,
3183 unsigned long **bit, int *max)
3185 if ((usage->hid & HID_USAGE_PAGE) != HID_UP_LOGIVENDOR)
3188 switch (usage->hid & HID_USAGE) {
3189 case 0x00d: lg_map_key_clear(KEY_MEDIA); break;
3196 /* -------------------------------------------------------------------------- */
3197 /* HID++1.0 devices which use HID++ reports for their wheels */
3198 /* -------------------------------------------------------------------------- */
3199 static int hidpp10_wheel_connect(struct hidpp_device *hidpp)
3201 return hidpp10_set_register(hidpp, HIDPP_REG_ENABLE_REPORTS, 0,
3202 HIDPP_ENABLE_WHEEL_REPORT | HIDPP_ENABLE_HWHEEL_REPORT,
3203 HIDPP_ENABLE_WHEEL_REPORT | HIDPP_ENABLE_HWHEEL_REPORT);
3206 static int hidpp10_wheel_raw_event(struct hidpp_device *hidpp,
3217 if (data[0] != REPORT_ID_HIDPP_SHORT || data[2] != HIDPP_SUB_ID_ROLLER)
3223 input_report_rel(hidpp->input, REL_WHEEL, value);
3224 input_report_rel(hidpp->input, REL_WHEEL_HI_RES, value * 120);
3225 input_report_rel(hidpp->input, REL_HWHEEL, hvalue);
3226 input_report_rel(hidpp->input, REL_HWHEEL_HI_RES, hvalue * 120);
3227 input_sync(hidpp->input);
3232 static void hidpp10_wheel_populate_input(struct hidpp_device *hidpp,
3233 struct input_dev *input_dev)
3235 __set_bit(EV_REL, input_dev->evbit);
3236 __set_bit(REL_WHEEL, input_dev->relbit);
3237 __set_bit(REL_WHEEL_HI_RES, input_dev->relbit);
3238 __set_bit(REL_HWHEEL, input_dev->relbit);
3239 __set_bit(REL_HWHEEL_HI_RES, input_dev->relbit);
3242 /* -------------------------------------------------------------------------- */
3243 /* HID++1.0 mice which use HID++ reports for extra mouse buttons */
3244 /* -------------------------------------------------------------------------- */
3245 static int hidpp10_extra_mouse_buttons_connect(struct hidpp_device *hidpp)
3247 return hidpp10_set_register(hidpp, HIDPP_REG_ENABLE_REPORTS, 0,
3248 HIDPP_ENABLE_MOUSE_EXTRA_BTN_REPORT,
3249 HIDPP_ENABLE_MOUSE_EXTRA_BTN_REPORT);
3252 static int hidpp10_extra_mouse_buttons_raw_event(struct hidpp_device *hidpp,
3263 if (data[0] != REPORT_ID_HIDPP_SHORT ||
3264 data[2] != HIDPP_SUB_ID_MOUSE_EXTRA_BTNS)
3268 * Buttons are either delivered through the regular mouse report *or*
3269 * through the extra buttons report. At least for button 6 how it is
3270 * delivered differs per receiver firmware version. Even receivers with
3271 * the same usb-id show different behavior, so we handle both cases.
3273 for (i = 0; i < 8; i++)
3274 input_report_key(hidpp->input, BTN_MOUSE + i,
3275 (data[3] & (1 << i)));
3277 /* Some mice report events on button 9+, use BTN_MISC */
3278 for (i = 0; i < 8; i++)
3279 input_report_key(hidpp->input, BTN_MISC + i,
3280 (data[4] & (1 << i)));
3282 input_sync(hidpp->input);
3286 static void hidpp10_extra_mouse_buttons_populate_input(
3287 struct hidpp_device *hidpp, struct input_dev *input_dev)
3289 /* BTN_MOUSE - BTN_MOUSE+7 are set already by the descriptor */
3290 __set_bit(BTN_0, input_dev->keybit);
3291 __set_bit(BTN_1, input_dev->keybit);
3292 __set_bit(BTN_2, input_dev->keybit);
3293 __set_bit(BTN_3, input_dev->keybit);
3294 __set_bit(BTN_4, input_dev->keybit);
3295 __set_bit(BTN_5, input_dev->keybit);
3296 __set_bit(BTN_6, input_dev->keybit);
3297 __set_bit(BTN_7, input_dev->keybit);
3300 /* -------------------------------------------------------------------------- */
3301 /* HID++1.0 kbds which only report 0x10xx consumer usages through sub-id 0x03 */
3302 /* -------------------------------------------------------------------------- */
3304 /* Find the consumer-page input report desc and change Maximums to 0x107f */
3305 static u8 *hidpp10_consumer_keys_report_fixup(struct hidpp_device *hidpp,
3306 u8 *_rdesc, unsigned int *rsize)
3308 /* Note 0 terminated so we can use strnstr to search for this. */
3309 static const char consumer_rdesc_start[] = {
3310 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */
3311 0x09, 0x01, /* USAGE (Consumer Control) */
3312 0xA1, 0x01, /* COLLECTION (Application) */
3313 0x85, 0x03, /* REPORT_ID = 3 */
3314 0x75, 0x10, /* REPORT_SIZE (16) */
3315 0x95, 0x02, /* REPORT_COUNT (2) */
3316 0x15, 0x01, /* LOGICAL_MIN (1) */
3317 0x26, 0x00 /* LOGICAL_MAX (... */
3319 char *consumer_rdesc, *rdesc = (char *)_rdesc;
3322 consumer_rdesc = strnstr(rdesc, consumer_rdesc_start, *rsize);
3323 size = *rsize - (consumer_rdesc - rdesc);
3324 if (consumer_rdesc && size >= 25) {
3325 consumer_rdesc[15] = 0x7f;
3326 consumer_rdesc[16] = 0x10;
3327 consumer_rdesc[20] = 0x7f;
3328 consumer_rdesc[21] = 0x10;
3333 static int hidpp10_consumer_keys_connect(struct hidpp_device *hidpp)
3335 return hidpp10_set_register(hidpp, HIDPP_REG_ENABLE_REPORTS, 0,
3336 HIDPP_ENABLE_CONSUMER_REPORT,
3337 HIDPP_ENABLE_CONSUMER_REPORT);
3340 static int hidpp10_consumer_keys_raw_event(struct hidpp_device *hidpp,
3343 u8 consumer_report[5];
3348 if (data[0] != REPORT_ID_HIDPP_SHORT ||
3349 data[2] != HIDPP_SUB_ID_CONSUMER_VENDOR_KEYS)
3353 * Build a normal consumer report (3) out of the data, this detour
3354 * is necessary to get some keyboards to report their 0x10xx usages.
3356 consumer_report[0] = 0x03;
3357 memcpy(&consumer_report[1], &data[3], 4);
3358 /* We are called from atomic context */
3359 hid_report_raw_event(hidpp->hid_dev, HID_INPUT_REPORT,
3360 consumer_report, 5, 1);
3365 /* -------------------------------------------------------------------------- */
3366 /* High-resolution scroll wheels */
3367 /* -------------------------------------------------------------------------- */
3369 static int hi_res_scroll_enable(struct hidpp_device *hidpp)
3374 if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_X2121) {
3375 ret = hidpp_hrw_set_wheel_mode(hidpp, false, true, false);
3377 ret = hidpp_hrw_get_wheel_capability(hidpp, &multiplier);
3378 } else if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_X2120) {
3379 ret = hidpp_hrs_set_highres_scrolling_mode(hidpp, true,
3381 } else /* if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL_1P0) */ {
3382 ret = hidpp10_enable_scrolling_acceleration(hidpp);
3388 if (multiplier == 0)
3391 hidpp->vertical_wheel_counter.wheel_multiplier = multiplier;
3392 hid_dbg(hidpp->hid_dev, "wheel multiplier = %d\n", multiplier);
3396 /* -------------------------------------------------------------------------- */
3397 /* Generic HID++ devices */
3398 /* -------------------------------------------------------------------------- */
3400 static u8 *hidpp_report_fixup(struct hid_device *hdev, u8 *rdesc,
3401 unsigned int *rsize)
3403 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3408 /* For 27 MHz keyboards the quirk gets set after hid_parse. */
3409 if (hdev->group == HID_GROUP_LOGITECH_27MHZ_DEVICE ||
3410 (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS))
3411 rdesc = hidpp10_consumer_keys_report_fixup(hidpp, rdesc, rsize);
3416 static int hidpp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
3417 struct hid_field *field, struct hid_usage *usage,
3418 unsigned long **bit, int *max)
3420 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3425 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
3426 return wtp_input_mapping(hdev, hi, field, usage, bit, max);
3427 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560 &&
3428 field->application != HID_GD_MOUSE)
3429 return m560_input_mapping(hdev, hi, field, usage, bit, max);
3431 if (hdev->product == DINOVO_MINI_PRODUCT_ID)
3432 return lg_dinovo_input_mapping(hdev, hi, field, usage, bit, max);
3437 static int hidpp_input_mapped(struct hid_device *hdev, struct hid_input *hi,
3438 struct hid_field *field, struct hid_usage *usage,
3439 unsigned long **bit, int *max)
3441 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3446 /* Ensure that Logitech G920 is not given a default fuzz/flat value */
3447 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
3448 if (usage->type == EV_ABS && (usage->code == ABS_X ||
3449 usage->code == ABS_Y || usage->code == ABS_Z ||
3450 usage->code == ABS_RZ)) {
3451 field->application = HID_GD_MULTIAXIS;
3459 static void hidpp_populate_input(struct hidpp_device *hidpp,
3460 struct input_dev *input)
3462 hidpp->input = input;
3464 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
3465 wtp_populate_input(hidpp, input);
3466 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
3467 m560_populate_input(hidpp, input);
3469 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_WHEELS)
3470 hidpp10_wheel_populate_input(hidpp, input);
3472 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS)
3473 hidpp10_extra_mouse_buttons_populate_input(hidpp, input);
3476 static int hidpp_input_configured(struct hid_device *hdev,
3477 struct hid_input *hidinput)
3479 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3480 struct input_dev *input = hidinput->input;
3485 hidpp_populate_input(hidpp, input);
3490 static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
3493 struct hidpp_report *question = hidpp->send_receive_buf;
3494 struct hidpp_report *answer = hidpp->send_receive_buf;
3495 struct hidpp_report *report = (struct hidpp_report *)data;
3499 * If the mutex is locked then we have a pending answer from a
3500 * previously sent command.
3502 if (unlikely(mutex_is_locked(&hidpp->send_mutex))) {
3504 * Check for a correct hidpp20 answer or the corresponding
3507 if (hidpp_match_answer(question, report) ||
3508 hidpp_match_error(question, report)) {
3510 hidpp->answer_available = true;
3511 wake_up(&hidpp->wait);
3513 * This was an answer to a command that this driver sent
3514 * We return 1 to hid-core to avoid forwarding the
3515 * command upstream as it has been treated by the driver
3522 if (unlikely(hidpp_report_is_connect_event(hidpp, report))) {
3523 atomic_set(&hidpp->connected,
3524 !(report->rap.params[0] & (1 << 6)));
3525 if (schedule_work(&hidpp->work) == 0)
3526 dbg_hid("%s: connect event already queued\n", __func__);
3530 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
3531 ret = hidpp20_battery_event_1000(hidpp, data, size);
3534 ret = hidpp20_battery_event_1004(hidpp, data, size);
3537 ret = hidpp_solar_battery_event(hidpp, data, size);
3540 ret = hidpp20_battery_voltage_event(hidpp, data, size);
3545 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP10_BATTERY) {
3546 ret = hidpp10_battery_event(hidpp, data, size);
3551 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_WHEELS) {
3552 ret = hidpp10_wheel_raw_event(hidpp, data, size);
3557 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS) {
3558 ret = hidpp10_extra_mouse_buttons_raw_event(hidpp, data, size);
3563 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
3564 ret = hidpp10_consumer_keys_raw_event(hidpp, data, size);
3572 static int hidpp_raw_event(struct hid_device *hdev, struct hid_report *report,
3575 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3581 /* Generic HID++ processing. */
3583 case REPORT_ID_HIDPP_VERY_LONG:
3584 if (size != hidpp->very_long_report_length) {
3585 hid_err(hdev, "received hid++ report of bad size (%d)",
3589 ret = hidpp_raw_hidpp_event(hidpp, data, size);
3591 case REPORT_ID_HIDPP_LONG:
3592 if (size != HIDPP_REPORT_LONG_LENGTH) {
3593 hid_err(hdev, "received hid++ report of bad size (%d)",
3597 ret = hidpp_raw_hidpp_event(hidpp, data, size);
3599 case REPORT_ID_HIDPP_SHORT:
3600 if (size != HIDPP_REPORT_SHORT_LENGTH) {
3601 hid_err(hdev, "received hid++ report of bad size (%d)",
3605 ret = hidpp_raw_hidpp_event(hidpp, data, size);
3609 /* If no report is available for further processing, skip calling
3610 * raw_event of subclasses. */
3614 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
3615 return wtp_raw_event(hdev, data, size);
3616 else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560)
3617 return m560_raw_event(hdev, data, size);
3622 static int hidpp_event(struct hid_device *hdev, struct hid_field *field,
3623 struct hid_usage *usage, __s32 value)
3625 /* This function will only be called for scroll events, due to the
3626 * restriction imposed in hidpp_usages.
3628 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3629 struct hidpp_scroll_counter *counter;
3634 counter = &hidpp->vertical_wheel_counter;
3635 /* A scroll event may occur before the multiplier has been retrieved or
3636 * the input device set, or high-res scroll enabling may fail. In such
3637 * cases we must return early (falling back to default behaviour) to
3638 * avoid a crash in hidpp_scroll_counter_handle_scroll.
3640 if (!(hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL) || value == 0
3641 || hidpp->input == NULL || counter->wheel_multiplier == 0)
3644 hidpp_scroll_counter_handle_scroll(hidpp->input, counter, value);
3648 static int hidpp_initialize_battery(struct hidpp_device *hidpp)
3650 static atomic_t battery_no = ATOMIC_INIT(0);
3651 struct power_supply_config cfg = { .drv_data = hidpp };
3652 struct power_supply_desc *desc = &hidpp->battery.desc;
3653 enum power_supply_property *battery_props;
3654 struct hidpp_battery *battery;
3655 unsigned int num_battery_props;
3659 if (hidpp->battery.ps)
3662 hidpp->battery.feature_index = 0xff;
3663 hidpp->battery.solar_feature_index = 0xff;
3664 hidpp->battery.voltage_feature_index = 0xff;
3666 if (hidpp->protocol_major >= 2) {
3667 if (hidpp->quirks & HIDPP_QUIRK_CLASS_K750)
3668 ret = hidpp_solar_request_battery_event(hidpp);
3670 /* we only support one battery feature right now, so let's
3671 first check the ones that support battery level first
3672 and leave voltage for last */
3673 ret = hidpp20_query_battery_info_1000(hidpp);
3675 ret = hidpp20_query_battery_info_1004(hidpp);
3677 ret = hidpp20_query_battery_voltage_info(hidpp);
3682 hidpp->capabilities |= HIDPP_CAPABILITY_HIDPP20_BATTERY;
3684 ret = hidpp10_query_battery_status(hidpp);
3686 ret = hidpp10_query_battery_mileage(hidpp);
3689 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_MILEAGE;
3691 hidpp->capabilities |= HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS;
3693 hidpp->capabilities |= HIDPP_CAPABILITY_HIDPP10_BATTERY;
3696 battery_props = devm_kmemdup(&hidpp->hid_dev->dev,
3697 hidpp_battery_props,
3698 sizeof(hidpp_battery_props),
3703 num_battery_props = ARRAY_SIZE(hidpp_battery_props) - 3;
3705 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_MILEAGE ||
3706 hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_PERCENTAGE)
3707 battery_props[num_battery_props++] =
3708 POWER_SUPPLY_PROP_CAPACITY;
3710 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_LEVEL_STATUS)
3711 battery_props[num_battery_props++] =
3712 POWER_SUPPLY_PROP_CAPACITY_LEVEL;
3714 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_VOLTAGE)
3715 battery_props[num_battery_props++] =
3716 POWER_SUPPLY_PROP_VOLTAGE_NOW;
3718 battery = &hidpp->battery;
3720 n = atomic_inc_return(&battery_no) - 1;
3721 desc->properties = battery_props;
3722 desc->num_properties = num_battery_props;
3723 desc->get_property = hidpp_battery_get_property;
3724 sprintf(battery->name, "hidpp_battery_%ld", n);
3725 desc->name = battery->name;
3726 desc->type = POWER_SUPPLY_TYPE_BATTERY;
3727 desc->use_for_apm = 0;
3729 battery->ps = devm_power_supply_register(&hidpp->hid_dev->dev,
3732 if (IS_ERR(battery->ps))
3733 return PTR_ERR(battery->ps);
3735 power_supply_powers(battery->ps, &hidpp->hid_dev->dev);
3740 static void hidpp_overwrite_name(struct hid_device *hdev)
3742 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3745 if (hidpp->protocol_major < 2)
3748 name = hidpp_get_device_name(hidpp);
3751 hid_err(hdev, "unable to retrieve the name of the device");
3753 dbg_hid("HID++: Got name: %s\n", name);
3754 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
3760 static int hidpp_input_open(struct input_dev *dev)
3762 struct hid_device *hid = input_get_drvdata(dev);
3764 return hid_hw_open(hid);
3767 static void hidpp_input_close(struct input_dev *dev)
3769 struct hid_device *hid = input_get_drvdata(dev);
3774 static struct input_dev *hidpp_allocate_input(struct hid_device *hdev)
3776 struct input_dev *input_dev = devm_input_allocate_device(&hdev->dev);
3777 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3782 input_set_drvdata(input_dev, hdev);
3783 input_dev->open = hidpp_input_open;
3784 input_dev->close = hidpp_input_close;
3786 input_dev->name = hidpp->name;
3787 input_dev->phys = hdev->phys;
3788 input_dev->uniq = hdev->uniq;
3789 input_dev->id.bustype = hdev->bus;
3790 input_dev->id.vendor = hdev->vendor;
3791 input_dev->id.product = hdev->product;
3792 input_dev->id.version = hdev->version;
3793 input_dev->dev.parent = &hdev->dev;
3798 static void hidpp_connect_event(struct hidpp_device *hidpp)
3800 struct hid_device *hdev = hidpp->hid_dev;
3802 bool connected = atomic_read(&hidpp->connected);
3803 struct input_dev *input;
3804 char *name, *devm_name;
3807 if (hidpp->battery.ps) {
3808 hidpp->battery.online = false;
3809 hidpp->battery.status = POWER_SUPPLY_STATUS_UNKNOWN;
3810 hidpp->battery.level = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
3811 power_supply_changed(hidpp->battery.ps);
3816 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
3817 ret = wtp_connect(hdev, connected);
3820 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_M560) {
3821 ret = m560_send_config_command(hdev, connected);
3824 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
3825 ret = k400_connect(hdev, connected);
3830 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_WHEELS) {
3831 ret = hidpp10_wheel_connect(hidpp);
3836 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS) {
3837 ret = hidpp10_extra_mouse_buttons_connect(hidpp);
3842 if (hidpp->quirks & HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS) {
3843 ret = hidpp10_consumer_keys_connect(hidpp);
3848 /* the device is already connected, we can ask for its name and
3850 if (!hidpp->protocol_major) {
3851 ret = hidpp_root_get_protocol_version(hidpp);
3853 hid_err(hdev, "Can not get the protocol version.\n");
3858 if (hidpp->name == hdev->name && hidpp->protocol_major >= 2) {
3859 name = hidpp_get_device_name(hidpp);
3861 devm_name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
3867 hidpp->name = devm_name;
3871 hidpp_initialize_battery(hidpp);
3873 /* forward current battery state */
3874 if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP10_BATTERY) {
3875 hidpp10_enable_battery_reporting(hidpp);
3876 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_MILEAGE)
3877 hidpp10_query_battery_mileage(hidpp);
3879 hidpp10_query_battery_status(hidpp);
3880 } else if (hidpp->capabilities & HIDPP_CAPABILITY_HIDPP20_BATTERY) {
3881 if (hidpp->capabilities & HIDPP_CAPABILITY_BATTERY_VOLTAGE)
3882 hidpp20_query_battery_voltage_info(hidpp);
3883 else if (hidpp->capabilities & HIDPP_CAPABILITY_UNIFIED_BATTERY)
3884 hidpp20_query_battery_info_1004(hidpp);
3886 hidpp20_query_battery_info_1000(hidpp);
3888 if (hidpp->battery.ps)
3889 power_supply_changed(hidpp->battery.ps);
3891 if (hidpp->quirks & HIDPP_QUIRK_HI_RES_SCROLL)
3892 hi_res_scroll_enable(hidpp);
3894 if (!(hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT) || hidpp->delayed_input)
3895 /* if the input nodes are already created, we can stop now */
3898 input = hidpp_allocate_input(hdev);
3900 hid_err(hdev, "cannot allocate new input device: %d\n", ret);
3904 hidpp_populate_input(hidpp, input);
3906 ret = input_register_device(input);
3908 input_free_device(input);
3910 hidpp->delayed_input = input;
3913 static DEVICE_ATTR(builtin_power_supply, 0000, NULL, NULL);
3915 static struct attribute *sysfs_attrs[] = {
3916 &dev_attr_builtin_power_supply.attr,
3920 static const struct attribute_group ps_attribute_group = {
3921 .attrs = sysfs_attrs
3924 static int hidpp_get_report_length(struct hid_device *hdev, int id)
3926 struct hid_report_enum *re;
3927 struct hid_report *report;
3929 re = &(hdev->report_enum[HID_OUTPUT_REPORT]);
3930 report = re->report_id_hash[id];
3934 return report->field[0]->report_count + 1;
3937 static u8 hidpp_validate_device(struct hid_device *hdev)
3939 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
3940 int id, report_length;
3941 u8 supported_reports = 0;
3943 id = REPORT_ID_HIDPP_SHORT;
3944 report_length = hidpp_get_report_length(hdev, id);
3945 if (report_length) {
3946 if (report_length < HIDPP_REPORT_SHORT_LENGTH)
3949 supported_reports |= HIDPP_REPORT_SHORT_SUPPORTED;
3952 id = REPORT_ID_HIDPP_LONG;
3953 report_length = hidpp_get_report_length(hdev, id);
3954 if (report_length) {
3955 if (report_length < HIDPP_REPORT_LONG_LENGTH)
3958 supported_reports |= HIDPP_REPORT_LONG_SUPPORTED;
3961 id = REPORT_ID_HIDPP_VERY_LONG;
3962 report_length = hidpp_get_report_length(hdev, id);
3963 if (report_length) {
3964 if (report_length < HIDPP_REPORT_LONG_LENGTH ||
3965 report_length > HIDPP_REPORT_VERY_LONG_MAX_LENGTH)
3968 supported_reports |= HIDPP_REPORT_VERY_LONG_SUPPORTED;
3969 hidpp->very_long_report_length = report_length;
3972 return supported_reports;
3975 hid_warn(hdev, "not enough values in hidpp report %d\n", id);
3979 static bool hidpp_application_equals(struct hid_device *hdev,
3980 unsigned int application)
3982 struct list_head *report_list;
3983 struct hid_report *report;
3985 report_list = &hdev->report_enum[HID_INPUT_REPORT].report_list;
3986 report = list_first_entry_or_null(report_list, struct hid_report, list);
3987 return report && report->application == application;
3990 static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
3992 struct hidpp_device *hidpp;
3995 unsigned int connect_mask = HID_CONNECT_DEFAULT;
3996 struct hidpp_ff_private_data data;
3998 /* report_fixup needs drvdata to be set before we call hid_parse */
3999 hidpp = devm_kzalloc(&hdev->dev, sizeof(*hidpp), GFP_KERNEL);
4003 hidpp->hid_dev = hdev;
4004 hidpp->name = hdev->name;
4005 hidpp->quirks = id->driver_data;
4006 hid_set_drvdata(hdev, hidpp);
4008 ret = hid_parse(hdev);
4010 hid_err(hdev, "%s:parse failed\n", __func__);
4015 * Make sure the device is HID++ capable, otherwise treat as generic HID
4017 hidpp->supported_reports = hidpp_validate_device(hdev);
4019 if (!hidpp->supported_reports) {
4020 hid_set_drvdata(hdev, NULL);
4021 devm_kfree(&hdev->dev, hidpp);
4022 return hid_hw_start(hdev, HID_CONNECT_DEFAULT);
4025 if (id->group == HID_GROUP_LOGITECH_DJ_DEVICE)
4026 hidpp->quirks |= HIDPP_QUIRK_UNIFYING;
4028 if (id->group == HID_GROUP_LOGITECH_27MHZ_DEVICE &&
4029 hidpp_application_equals(hdev, HID_GD_MOUSE))
4030 hidpp->quirks |= HIDPP_QUIRK_HIDPP_WHEELS |
4031 HIDPP_QUIRK_HIDPP_EXTRA_MOUSE_BTNS;
4033 if (id->group == HID_GROUP_LOGITECH_27MHZ_DEVICE &&
4034 hidpp_application_equals(hdev, HID_GD_KEYBOARD))
4035 hidpp->quirks |= HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS;
4037 if (disable_raw_mode) {
4038 hidpp->quirks &= ~HIDPP_QUIRK_CLASS_WTP;
4039 hidpp->quirks &= ~HIDPP_QUIRK_NO_HIDINPUT;
4042 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
4043 ret = wtp_allocate(hdev, id);
4046 } else if (hidpp->quirks & HIDPP_QUIRK_CLASS_K400) {
4047 ret = k400_allocate(hdev);
4052 INIT_WORK(&hidpp->work, delayed_work_cb);
4053 mutex_init(&hidpp->send_mutex);
4054 init_waitqueue_head(&hidpp->wait);
4056 /* indicates we are handling the battery properties in the kernel */
4057 ret = sysfs_create_group(&hdev->dev.kobj, &ps_attribute_group);
4059 hid_warn(hdev, "Cannot allocate sysfs group for %s\n",
4063 * Plain USB connections need to actually call start and open
4064 * on the transport driver to allow incoming data.
4066 ret = hid_hw_start(hdev, 0);
4068 hid_err(hdev, "hw start failed\n");
4069 goto hid_hw_start_fail;
4072 ret = hid_hw_open(hdev);
4074 dev_err(&hdev->dev, "%s:hid_hw_open returned error:%d\n",
4076 goto hid_hw_open_fail;
4079 /* Allow incoming packets */
4080 hid_device_io_start(hdev);
4082 if (hidpp->quirks & HIDPP_QUIRK_UNIFYING)
4083 hidpp_unifying_init(hidpp);
4085 connected = hidpp_root_get_protocol_version(hidpp) == 0;
4086 atomic_set(&hidpp->connected, connected);
4087 if (!(hidpp->quirks & HIDPP_QUIRK_UNIFYING)) {
4090 hid_err(hdev, "Device not connected");
4091 goto hid_hw_init_fail;
4094 hidpp_overwrite_name(hdev);
4097 if (connected && hidpp->protocol_major >= 2) {
4098 ret = hidpp_set_wireless_feature_index(hidpp);
4100 hidpp->wireless_feature_index = 0;
4102 goto hid_hw_init_fail;
4105 if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)) {
4106 ret = wtp_get_config(hidpp);
4108 goto hid_hw_init_fail;
4109 } else if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_G920)) {
4110 ret = g920_get_config(hidpp, &data);
4112 goto hid_hw_init_fail;
4115 hidpp_connect_event(hidpp);
4117 /* Reset the HID node state */
4118 hid_device_io_stop(hdev);
4122 if (hidpp->quirks & HIDPP_QUIRK_NO_HIDINPUT)
4123 connect_mask &= ~HID_CONNECT_HIDINPUT;
4125 /* Now export the actual inputs and hidraw nodes to the world */
4126 ret = hid_hw_start(hdev, connect_mask);
4128 hid_err(hdev, "%s:hid_hw_start returned error\n", __func__);
4129 goto hid_hw_start_fail;
4132 if (hidpp->quirks & HIDPP_QUIRK_CLASS_G920) {
4133 ret = hidpp_ff_init(hidpp, &data);
4135 hid_warn(hidpp->hid_dev,
4136 "Unable to initialize force feedback support, errno %d\n",
4147 sysfs_remove_group(&hdev->dev.kobj, &ps_attribute_group);
4148 cancel_work_sync(&hidpp->work);
4149 mutex_destroy(&hidpp->send_mutex);
4153 static void hidpp_remove(struct hid_device *hdev)
4155 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
4158 return hid_hw_stop(hdev);
4160 sysfs_remove_group(&hdev->dev.kobj, &ps_attribute_group);
4163 cancel_work_sync(&hidpp->work);
4164 mutex_destroy(&hidpp->send_mutex);
4167 #define LDJ_DEVICE(product) \
4168 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE, \
4169 USB_VENDOR_ID_LOGITECH, (product))
4171 #define L27MHZ_DEVICE(product) \
4172 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_27MHZ_DEVICE, \
4173 USB_VENDOR_ID_LOGITECH, (product))
4175 static const struct hid_device_id hidpp_devices[] = {
4176 { /* wireless touchpad */
4178 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT |
4179 HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS },
4180 { /* wireless touchpad T650 */
4182 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT },
4183 { /* wireless touchpad T651 */
4184 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
4185 USB_DEVICE_ID_LOGITECH_T651),
4186 .driver_data = HIDPP_QUIRK_CLASS_WTP },
4187 { /* Mouse Logitech Anywhere MX */
4188 LDJ_DEVICE(0x1017), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
4189 { /* Mouse Logitech Cube */
4190 LDJ_DEVICE(0x4010), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
4191 { /* Mouse Logitech M335 */
4192 LDJ_DEVICE(0x4050), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4193 { /* Mouse Logitech M515 */
4194 LDJ_DEVICE(0x4007), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
4195 { /* Mouse logitech M560 */
4197 .driver_data = HIDPP_QUIRK_DELAYED_INIT | HIDPP_QUIRK_CLASS_M560
4198 | HIDPP_QUIRK_HI_RES_SCROLL_X2120 },
4199 { /* Mouse Logitech M705 (firmware RQM17) */
4200 LDJ_DEVICE(0x101b), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
4201 { /* Mouse Logitech M705 (firmware RQM67) */
4202 LDJ_DEVICE(0x406d), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4203 { /* Mouse Logitech M720 */
4204 LDJ_DEVICE(0x405e), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4205 { /* Mouse Logitech MX Anywhere 2 */
4206 LDJ_DEVICE(0x404a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4207 { LDJ_DEVICE(0x4072), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4208 { LDJ_DEVICE(0xb013), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4209 { LDJ_DEVICE(0xb018), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4210 { LDJ_DEVICE(0xb01f), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4211 { /* Mouse Logitech MX Anywhere 2S */
4212 LDJ_DEVICE(0x406a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4213 { /* Mouse Logitech MX Master */
4214 LDJ_DEVICE(0x4041), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4215 { LDJ_DEVICE(0x4060), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4216 { LDJ_DEVICE(0x4071), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4217 { /* Mouse Logitech MX Master 2S */
4218 LDJ_DEVICE(0x4069), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4219 { /* Mouse Logitech MX Master 3 */
4220 LDJ_DEVICE(0x4082), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4221 { /* Mouse Logitech Performance MX */
4222 LDJ_DEVICE(0x101a), .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_1P0 },
4223 { /* Keyboard logitech K400 */
4225 .driver_data = HIDPP_QUIRK_CLASS_K400 },
4226 { /* Solar Keyboard Logitech K750 */
4228 .driver_data = HIDPP_QUIRK_CLASS_K750 },
4229 { /* Keyboard MX5000 (Bluetooth-receiver in HID proxy mode) */
4231 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4232 { /* Dinovo Edge (Bluetooth-receiver in HID proxy mode) */
4234 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4235 { /* Keyboard MX5500 (Bluetooth-receiver in HID proxy mode) */
4237 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4239 { LDJ_DEVICE(HID_ANY_ID) },
4241 { /* Keyboard LX501 (Y-RR53) */
4242 L27MHZ_DEVICE(0x0049),
4243 .driver_data = HIDPP_QUIRK_KBD_ZOOM_WHEEL },
4244 { /* Keyboard MX3000 (Y-RAM74) */
4245 L27MHZ_DEVICE(0x0057),
4246 .driver_data = HIDPP_QUIRK_KBD_SCROLL_WHEEL },
4247 { /* Keyboard MX3200 (Y-RAV80) */
4248 L27MHZ_DEVICE(0x005c),
4249 .driver_data = HIDPP_QUIRK_KBD_ZOOM_WHEEL },
4250 { /* S510 Media Remote */
4251 L27MHZ_DEVICE(0x00fe),
4252 .driver_data = HIDPP_QUIRK_KBD_SCROLL_WHEEL },
4254 { L27MHZ_DEVICE(HID_ANY_ID) },
4256 { /* Logitech G403 Wireless Gaming Mouse over USB */
4257 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC082) },
4258 { /* Logitech G703 Gaming Mouse over USB */
4259 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC087) },
4260 { /* Logitech G703 Hero Gaming Mouse over USB */
4261 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC090) },
4262 { /* Logitech G900 Gaming Mouse over USB */
4263 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC081) },
4264 { /* Logitech G903 Gaming Mouse over USB */
4265 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC086) },
4266 { /* Logitech G903 Hero Gaming Mouse over USB */
4267 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC091) },
4268 { /* Logitech G920 Wheel over USB */
4269 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G920_WHEEL),
4270 .driver_data = HIDPP_QUIRK_CLASS_G920 | HIDPP_QUIRK_FORCE_OUTPUT_REPORTS},
4271 { /* Logitech G Pro Gaming Mouse over USB */
4272 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, 0xC088) },
4274 { /* MX5000 keyboard over Bluetooth */
4275 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb305),
4276 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4277 { /* Dinovo Edge keyboard over Bluetooth */
4278 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb309),
4279 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4280 { /* MX5500 keyboard over Bluetooth */
4281 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb30b),
4282 .driver_data = HIDPP_QUIRK_HIDPP_CONSUMER_VENDOR_KEYS },
4283 { /* M-RCQ142 V470 Cordless Laser Mouse over Bluetooth */
4284 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb008) },
4285 { /* MX Master mouse over Bluetooth */
4286 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb012),
4287 .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4288 { /* MX Ergo trackball over Bluetooth */
4289 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb01d) },
4290 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb01e),
4291 .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4292 { /* MX Master 3 mouse over Bluetooth */
4293 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 0xb023),
4294 .driver_data = HIDPP_QUIRK_HI_RES_SCROLL_X2121 },
4298 MODULE_DEVICE_TABLE(hid, hidpp_devices);
4300 static const struct hid_usage_id hidpp_usages[] = {
4301 { HID_GD_WHEEL, EV_REL, REL_WHEEL_HI_RES },
4302 { HID_ANY_ID - 1, HID_ANY_ID - 1, HID_ANY_ID - 1}
4305 static struct hid_driver hidpp_driver = {
4306 .name = "logitech-hidpp-device",
4307 .id_table = hidpp_devices,
4308 .report_fixup = hidpp_report_fixup,
4309 .probe = hidpp_probe,
4310 .remove = hidpp_remove,
4311 .raw_event = hidpp_raw_event,
4312 .usage_table = hidpp_usages,
4313 .event = hidpp_event,
4314 .input_configured = hidpp_input_configured,
4315 .input_mapping = hidpp_input_mapping,
4316 .input_mapped = hidpp_input_mapped,
4319 module_hid_driver(hidpp_driver);