2 * HIDPP protocol for Logitech Unifying receivers
4 * Copyright (c) 2011 Logitech (c)
5 * Copyright (c) 2012-2013 Google (c)
6 * Copyright (c) 2013-2014 Red Hat Inc.
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; version 2 of the License.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/device.h>
18 #include <linux/input.h>
19 #include <linux/usb.h>
20 #include <linux/hid.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/kfifo.h>
25 #include <linux/input/mt.h>
26 #include <linux/workqueue.h>
27 #include <linux/atomic.h>
28 #include <linux/fixp-arith.h>
29 #include <asm/unaligned.h>
30 #include "usbhid/usbhid.h"
33 MODULE_LICENSE("GPL");
34 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
35 MODULE_AUTHOR("Nestor Lopez Casado <nlopezcasad@logitech.com>");
37 static bool disable_raw_mode
;
38 module_param(disable_raw_mode
, bool, 0644);
39 MODULE_PARM_DESC(disable_raw_mode
,
40 "Disable Raw mode reporting for touchpads and keep firmware gestures.");
42 static bool disable_tap_to_click
;
43 module_param(disable_tap_to_click
, bool, 0644);
44 MODULE_PARM_DESC(disable_tap_to_click
,
45 "Disable Tap-To-Click mode reporting for touchpads (only on the K400 currently).");
47 #define REPORT_ID_HIDPP_SHORT 0x10
48 #define REPORT_ID_HIDPP_LONG 0x11
49 #define REPORT_ID_HIDPP_VERY_LONG 0x12
51 #define HIDPP_REPORT_SHORT_LENGTH 7
52 #define HIDPP_REPORT_LONG_LENGTH 20
53 #define HIDPP_REPORT_VERY_LONG_LENGTH 64
55 #define HIDPP_QUIRK_CLASS_WTP BIT(0)
56 #define HIDPP_QUIRK_CLASS_M560 BIT(1)
57 #define HIDPP_QUIRK_CLASS_K400 BIT(2)
58 #define HIDPP_QUIRK_CLASS_G920 BIT(3)
60 /* bits 2..20 are reserved for classes */
61 /* #define HIDPP_QUIRK_CONNECT_EVENTS BIT(21) disabled */
62 #define HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS BIT(22)
63 #define HIDPP_QUIRK_NO_HIDINPUT BIT(23)
64 #define HIDPP_QUIRK_FORCE_OUTPUT_REPORTS BIT(24)
65 #define HIDPP_QUIRK_UNIFYING BIT(25)
67 #define HIDPP_QUIRK_DELAYED_INIT HIDPP_QUIRK_NO_HIDINPUT
69 #define HIDPP_CAPABILITY_HIDPP10_BATTERY BIT(0)
70 #define HIDPP_CAPABILITY_HIDPP20_BATTERY BIT(1)
73 * There are two hidpp protocols in use, the first version hidpp10 is known
74 * as register access protocol or RAP, the second version hidpp20 is known as
75 * feature access protocol or FAP
77 * Most older devices (including the Unifying usb receiver) use the RAP protocol
78 * where as most newer devices use the FAP protocol. Both protocols are
79 * compatible with the underlying transport, which could be usb, Unifiying, or
80 * bluetooth. The message lengths are defined by the hid vendor specific report
81 * descriptor for the HIDPP_SHORT report type (total message lenth 7 bytes) and
82 * the HIDPP_LONG report type (total message length 20 bytes)
84 * The RAP protocol uses both report types, whereas the FAP only uses HIDPP_LONG
85 * messages. The Unifying receiver itself responds to RAP messages (device index
86 * is 0xFF for the receiver), and all messages (short or long) with a device
87 * index between 1 and 6 are passed untouched to the corresponding paired
90 * The paired device can be RAP or FAP, it will receive the message untouched
91 * from the Unifiying receiver.
96 u8 funcindex_clientid
;
97 u8 params
[HIDPP_REPORT_VERY_LONG_LENGTH
- 4U];
103 u8 params
[HIDPP_REPORT_VERY_LONG_LENGTH
- 4U];
106 struct hidpp_report
{
112 u8 rawbytes
[sizeof(struct fap
)];
116 struct hidpp_battery
{
118 struct power_supply_desc desc
;
119 struct power_supply
*ps
;
125 struct hidpp_device
{
126 struct hid_device
*hid_dev
;
127 struct mutex send_mutex
;
128 void *send_receive_buf
;
129 char *name
; /* will never be NULL and should not be freed */
130 wait_queue_head_t wait
;
131 bool answer_available
;
137 struct work_struct work
;
138 struct kfifo delayed_work_fifo
;
140 struct input_dev
*delayed_input
;
142 unsigned long quirks
;
143 unsigned long capabilities
;
145 struct hidpp_battery battery
;
148 /* HID++ 1.0 error codes */
149 #define HIDPP_ERROR 0x8f
150 #define HIDPP_ERROR_SUCCESS 0x00
151 #define HIDPP_ERROR_INVALID_SUBID 0x01
152 #define HIDPP_ERROR_INVALID_ADRESS 0x02
153 #define HIDPP_ERROR_INVALID_VALUE 0x03
154 #define HIDPP_ERROR_CONNECT_FAIL 0x04
155 #define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
156 #define HIDPP_ERROR_ALREADY_EXISTS 0x06
157 #define HIDPP_ERROR_BUSY 0x07
158 #define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
159 #define HIDPP_ERROR_RESOURCE_ERROR 0x09
160 #define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
161 #define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
162 #define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
163 /* HID++ 2.0 error codes */
164 #define HIDPP20_ERROR 0xff
166 static void hidpp_connect_event(struct hidpp_device
*hidpp_dev
);
168 static int __hidpp_send_report(struct hid_device
*hdev
,
169 struct hidpp_report
*hidpp_report
)
171 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
172 int fields_count
, ret
;
174 hidpp
= hid_get_drvdata(hdev
);
176 switch (hidpp_report
->report_id
) {
177 case REPORT_ID_HIDPP_SHORT
:
178 fields_count
= HIDPP_REPORT_SHORT_LENGTH
;
180 case REPORT_ID_HIDPP_LONG
:
181 fields_count
= HIDPP_REPORT_LONG_LENGTH
;
183 case REPORT_ID_HIDPP_VERY_LONG
:
184 fields_count
= HIDPP_REPORT_VERY_LONG_LENGTH
;
191 * set the device_index as the receiver, it will be overwritten by
192 * hid_hw_request if needed
194 hidpp_report
->device_index
= 0xff;
196 if (hidpp
->quirks
& HIDPP_QUIRK_FORCE_OUTPUT_REPORTS
) {
197 ret
= hid_hw_output_report(hdev
, (u8
*)hidpp_report
, fields_count
);
199 ret
= hid_hw_raw_request(hdev
, hidpp_report
->report_id
,
200 (u8
*)hidpp_report
, fields_count
, HID_OUTPUT_REPORT
,
204 return ret
== fields_count
? 0 : -1;
208 * hidpp_send_message_sync() returns 0 in case of success, and something else
209 * in case of a failure.
210 * - If ' something else' is positive, that means that an error has been raised
211 * by the protocol itself.
212 * - If ' something else' is negative, that means that we had a classic error
213 * (-ENOMEM, -EPIPE, etc...)
215 static int hidpp_send_message_sync(struct hidpp_device
*hidpp
,
216 struct hidpp_report
*message
,
217 struct hidpp_report
*response
)
221 mutex_lock(&hidpp
->send_mutex
);
223 hidpp
->send_receive_buf
= response
;
224 hidpp
->answer_available
= false;
227 * So that we can later validate the answer when it arrives
230 *response
= *message
;
232 ret
= __hidpp_send_report(hidpp
->hid_dev
, message
);
235 dbg_hid("__hidpp_send_report returned err: %d\n", ret
);
236 memset(response
, 0, sizeof(struct hidpp_report
));
240 if (!wait_event_timeout(hidpp
->wait
, hidpp
->answer_available
,
242 dbg_hid("%s:timeout waiting for response\n", __func__
);
243 memset(response
, 0, sizeof(struct hidpp_report
));
247 if (response
->report_id
== REPORT_ID_HIDPP_SHORT
&&
248 response
->rap
.sub_id
== HIDPP_ERROR
) {
249 ret
= response
->rap
.params
[1];
250 dbg_hid("%s:got hidpp error %02X\n", __func__
, ret
);
254 if ((response
->report_id
== REPORT_ID_HIDPP_LONG
||
255 response
->report_id
== REPORT_ID_HIDPP_VERY_LONG
) &&
256 response
->fap
.feature_index
== HIDPP20_ERROR
) {
257 ret
= response
->fap
.params
[1];
258 dbg_hid("%s:got hidpp 2.0 error %02X\n", __func__
, ret
);
263 mutex_unlock(&hidpp
->send_mutex
);
268 static int hidpp_send_fap_command_sync(struct hidpp_device
*hidpp
,
269 u8 feat_index
, u8 funcindex_clientid
, u8
*params
, int param_count
,
270 struct hidpp_report
*response
)
272 struct hidpp_report
*message
;
275 if (param_count
> sizeof(message
->fap
.params
))
278 message
= kzalloc(sizeof(struct hidpp_report
), GFP_KERNEL
);
282 if (param_count
> (HIDPP_REPORT_LONG_LENGTH
- 4))
283 message
->report_id
= REPORT_ID_HIDPP_VERY_LONG
;
285 message
->report_id
= REPORT_ID_HIDPP_LONG
;
286 message
->fap
.feature_index
= feat_index
;
287 message
->fap
.funcindex_clientid
= funcindex_clientid
;
288 memcpy(&message
->fap
.params
, params
, param_count
);
290 ret
= hidpp_send_message_sync(hidpp
, message
, response
);
295 static int hidpp_send_rap_command_sync(struct hidpp_device
*hidpp_dev
,
296 u8 report_id
, u8 sub_id
, u8 reg_address
, u8
*params
, int param_count
,
297 struct hidpp_report
*response
)
299 struct hidpp_report
*message
;
303 case REPORT_ID_HIDPP_SHORT
:
304 max_count
= HIDPP_REPORT_SHORT_LENGTH
- 4;
306 case REPORT_ID_HIDPP_LONG
:
307 max_count
= HIDPP_REPORT_LONG_LENGTH
- 4;
309 case REPORT_ID_HIDPP_VERY_LONG
:
310 max_count
= HIDPP_REPORT_VERY_LONG_LENGTH
- 4;
316 if (param_count
> max_count
)
319 message
= kzalloc(sizeof(struct hidpp_report
), GFP_KERNEL
);
322 message
->report_id
= report_id
;
323 message
->rap
.sub_id
= sub_id
;
324 message
->rap
.reg_address
= reg_address
;
325 memcpy(&message
->rap
.params
, params
, param_count
);
327 ret
= hidpp_send_message_sync(hidpp_dev
, message
, response
);
332 static void delayed_work_cb(struct work_struct
*work
)
334 struct hidpp_device
*hidpp
= container_of(work
, struct hidpp_device
,
336 hidpp_connect_event(hidpp
);
339 static inline bool hidpp_match_answer(struct hidpp_report
*question
,
340 struct hidpp_report
*answer
)
342 return (answer
->fap
.feature_index
== question
->fap
.feature_index
) &&
343 (answer
->fap
.funcindex_clientid
== question
->fap
.funcindex_clientid
);
346 static inline bool hidpp_match_error(struct hidpp_report
*question
,
347 struct hidpp_report
*answer
)
349 return ((answer
->rap
.sub_id
== HIDPP_ERROR
) ||
350 (answer
->fap
.feature_index
== HIDPP20_ERROR
)) &&
351 (answer
->fap
.funcindex_clientid
== question
->fap
.feature_index
) &&
352 (answer
->fap
.params
[0] == question
->fap
.funcindex_clientid
);
355 static inline bool hidpp_report_is_connect_event(struct hidpp_report
*report
)
357 return (report
->report_id
== REPORT_ID_HIDPP_SHORT
) &&
358 (report
->rap
.sub_id
== 0x41);
362 * hidpp_prefix_name() prefixes the current given name with "Logitech ".
364 static void hidpp_prefix_name(char **name
, int name_length
)
366 #define PREFIX_LENGTH 9 /* "Logitech " */
371 if (name_length
> PREFIX_LENGTH
&&
372 strncmp(*name
, "Logitech ", PREFIX_LENGTH
) == 0)
373 /* The prefix has is already in the name */
376 new_length
= PREFIX_LENGTH
+ name_length
;
377 new_name
= kzalloc(new_length
, GFP_KERNEL
);
381 snprintf(new_name
, new_length
, "Logitech %s", *name
);
388 /* -------------------------------------------------------------------------- */
389 /* HIDP++ 1.0 commands */
390 /* -------------------------------------------------------------------------- */
392 #define HIDPP_SET_REGISTER 0x80
393 #define HIDPP_GET_REGISTER 0x81
394 #define HIDPP_SET_LONG_REGISTER 0x82
395 #define HIDPP_GET_LONG_REGISTER 0x83
397 #define HIDPP_REG_PAIRING_INFORMATION 0xB5
398 #define HIDPP_EXTENDED_PAIRING 0x30
399 #define HIDPP_DEVICE_NAME 0x40
401 static char *hidpp_unifying_get_name(struct hidpp_device
*hidpp_dev
)
403 struct hidpp_report response
;
405 u8 params
[1] = { HIDPP_DEVICE_NAME
};
409 ret
= hidpp_send_rap_command_sync(hidpp_dev
,
410 REPORT_ID_HIDPP_SHORT
,
411 HIDPP_GET_LONG_REGISTER
,
412 HIDPP_REG_PAIRING_INFORMATION
,
413 params
, 1, &response
);
417 len
= response
.rap
.params
[1];
419 if (2 + len
> sizeof(response
.rap
.params
))
422 name
= kzalloc(len
+ 1, GFP_KERNEL
);
426 memcpy(name
, &response
.rap
.params
[2], len
);
428 /* include the terminating '\0' */
429 hidpp_prefix_name(&name
, len
+ 1);
434 static int hidpp_unifying_get_serial(struct hidpp_device
*hidpp
, u32
*serial
)
436 struct hidpp_report response
;
438 u8 params
[1] = { HIDPP_EXTENDED_PAIRING
};
440 ret
= hidpp_send_rap_command_sync(hidpp
,
441 REPORT_ID_HIDPP_SHORT
,
442 HIDPP_GET_LONG_REGISTER
,
443 HIDPP_REG_PAIRING_INFORMATION
,
444 params
, 1, &response
);
449 * We don't care about LE or BE, we will output it as a string
450 * with %4phD, so we need to keep the order.
452 *serial
= *((u32
*)&response
.rap
.params
[1]);
456 static int hidpp_unifying_init(struct hidpp_device
*hidpp
)
458 struct hid_device
*hdev
= hidpp
->hid_dev
;
463 ret
= hidpp_unifying_get_serial(hidpp
, &serial
);
467 snprintf(hdev
->uniq
, sizeof(hdev
->uniq
), "%04x-%4phD",
468 hdev
->product
, &serial
);
469 dbg_hid("HID++ Unifying: Got serial: %s\n", hdev
->uniq
);
471 name
= hidpp_unifying_get_name(hidpp
);
475 snprintf(hdev
->name
, sizeof(hdev
->name
), "%s", name
);
476 dbg_hid("HID++ Unifying: Got name: %s\n", name
);
482 /* -------------------------------------------------------------------------- */
484 /* -------------------------------------------------------------------------- */
486 #define HIDPP_PAGE_ROOT 0x0000
487 #define HIDPP_PAGE_ROOT_IDX 0x00
489 #define CMD_ROOT_GET_FEATURE 0x01
490 #define CMD_ROOT_GET_PROTOCOL_VERSION 0x11
492 static int hidpp_root_get_feature(struct hidpp_device
*hidpp
, u16 feature
,
493 u8
*feature_index
, u8
*feature_type
)
495 struct hidpp_report response
;
497 u8 params
[2] = { feature
>> 8, feature
& 0x00FF };
499 ret
= hidpp_send_fap_command_sync(hidpp
,
501 CMD_ROOT_GET_FEATURE
,
502 params
, 2, &response
);
506 *feature_index
= response
.fap
.params
[0];
507 *feature_type
= response
.fap
.params
[1];
512 static int hidpp_root_get_protocol_version(struct hidpp_device
*hidpp
)
514 struct hidpp_report response
;
517 ret
= hidpp_send_fap_command_sync(hidpp
,
519 CMD_ROOT_GET_PROTOCOL_VERSION
,
522 if (ret
== HIDPP_ERROR_INVALID_SUBID
) {
523 hidpp
->protocol_major
= 1;
524 hidpp
->protocol_minor
= 0;
528 /* the device might not be connected */
529 if (ret
== HIDPP_ERROR_RESOURCE_ERROR
)
533 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
540 hidpp
->protocol_major
= response
.fap
.params
[0];
541 hidpp
->protocol_minor
= response
.fap
.params
[1];
546 static bool hidpp_is_connected(struct hidpp_device
*hidpp
)
550 ret
= hidpp_root_get_protocol_version(hidpp
);
552 hid_dbg(hidpp
->hid_dev
, "HID++ %u.%u device connected.\n",
553 hidpp
->protocol_major
, hidpp
->protocol_minor
);
557 /* -------------------------------------------------------------------------- */
558 /* 0x0005: GetDeviceNameType */
559 /* -------------------------------------------------------------------------- */
561 #define HIDPP_PAGE_GET_DEVICE_NAME_TYPE 0x0005
563 #define CMD_GET_DEVICE_NAME_TYPE_GET_COUNT 0x01
564 #define CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME 0x11
565 #define CMD_GET_DEVICE_NAME_TYPE_GET_TYPE 0x21
567 static int hidpp_devicenametype_get_count(struct hidpp_device
*hidpp
,
568 u8 feature_index
, u8
*nameLength
)
570 struct hidpp_report response
;
573 ret
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
574 CMD_GET_DEVICE_NAME_TYPE_GET_COUNT
, NULL
, 0, &response
);
577 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
584 *nameLength
= response
.fap
.params
[0];
589 static int hidpp_devicenametype_get_device_name(struct hidpp_device
*hidpp
,
590 u8 feature_index
, u8 char_index
, char *device_name
, int len_buf
)
592 struct hidpp_report response
;
596 ret
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
597 CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME
, &char_index
, 1,
601 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
608 switch (response
.report_id
) {
609 case REPORT_ID_HIDPP_VERY_LONG
:
610 count
= HIDPP_REPORT_VERY_LONG_LENGTH
- 4;
612 case REPORT_ID_HIDPP_LONG
:
613 count
= HIDPP_REPORT_LONG_LENGTH
- 4;
615 case REPORT_ID_HIDPP_SHORT
:
616 count
= HIDPP_REPORT_SHORT_LENGTH
- 4;
625 for (i
= 0; i
< count
; i
++)
626 device_name
[i
] = response
.fap
.params
[i
];
631 static char *hidpp_get_device_name(struct hidpp_device
*hidpp
)
640 ret
= hidpp_root_get_feature(hidpp
, HIDPP_PAGE_GET_DEVICE_NAME_TYPE
,
641 &feature_index
, &feature_type
);
645 ret
= hidpp_devicenametype_get_count(hidpp
, feature_index
,
650 name
= kzalloc(__name_length
+ 1, GFP_KERNEL
);
654 while (index
< __name_length
) {
655 ret
= hidpp_devicenametype_get_device_name(hidpp
,
656 feature_index
, index
, name
+ index
,
657 __name_length
- index
);
665 /* include the terminating '\0' */
666 hidpp_prefix_name(&name
, __name_length
+ 1);
671 /* -------------------------------------------------------------------------- */
672 /* 0x1000: Battery level status */
673 /* -------------------------------------------------------------------------- */
675 #define HIDPP_PAGE_BATTERY_LEVEL_STATUS 0x1000
677 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS 0x00
678 #define CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_CAPABILITY 0x10
680 #define EVENT_BATTERY_LEVEL_STATUS_BROADCAST 0x00
682 static int hidpp20_batterylevel_map_status_level(u8 data
[3], int *level
,
689 *next_level
= data
[1];
691 /* When discharging, we can rely on the device reported level.
692 * For all other states the device reports level 0 (unknown). Make up
696 case 0: /* discharging (in use) */
697 status
= POWER_SUPPLY_STATUS_DISCHARGING
;
700 case 1: /* recharging */
701 status
= POWER_SUPPLY_STATUS_CHARGING
;
704 case 2: /* charge in final stage */
705 status
= POWER_SUPPLY_STATUS_CHARGING
;
708 case 3: /* charge complete */
709 status
= POWER_SUPPLY_STATUS_FULL
;
710 level_override
= 100;
712 case 4: /* recharging below optimal speed */
713 status
= POWER_SUPPLY_STATUS_CHARGING
;
716 /* 5 = invalid battery type
718 7 = other charging error */
720 status
= POWER_SUPPLY_STATUS_NOT_CHARGING
;
725 if (level_override
!= 0 && *level
== 0)
726 *level
= level_override
;
731 static int hidpp20_batterylevel_get_battery_level(struct hidpp_device
*hidpp
,
737 struct hidpp_report response
;
739 u8
*params
= (u8
*)response
.fap
.params
;
741 ret
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
742 CMD_BATTERY_LEVEL_STATUS_GET_BATTERY_LEVEL_STATUS
,
745 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
752 *status
= hidpp20_batterylevel_map_status_level(params
, level
,
758 static int hidpp20_query_battery_info(struct hidpp_device
*hidpp
)
762 int status
, level
, next_level
;
764 if (hidpp
->battery
.feature_index
== 0) {
765 ret
= hidpp_root_get_feature(hidpp
,
766 HIDPP_PAGE_BATTERY_LEVEL_STATUS
,
767 &hidpp
->battery
.feature_index
,
773 ret
= hidpp20_batterylevel_get_battery_level(hidpp
,
774 hidpp
->battery
.feature_index
,
775 &status
, &level
, &next_level
);
779 hidpp
->battery
.status
= status
;
780 hidpp
->battery
.level
= level
;
785 static int hidpp20_battery_event(struct hidpp_device
*hidpp
,
788 struct hidpp_report
*report
= (struct hidpp_report
*)data
;
789 int status
, level
, next_level
;
792 if (report
->fap
.feature_index
!= hidpp
->battery
.feature_index
||
793 report
->fap
.funcindex_clientid
!= EVENT_BATTERY_LEVEL_STATUS_BROADCAST
)
796 status
= hidpp20_batterylevel_map_status_level(report
->fap
.params
,
797 &level
, &next_level
);
799 changed
= level
!= hidpp
->battery
.level
||
800 status
!= hidpp
->battery
.status
;
803 hidpp
->battery
.level
= level
;
804 hidpp
->battery
.status
= status
;
805 if (hidpp
->battery
.ps
)
806 power_supply_changed(hidpp
->battery
.ps
);
812 static enum power_supply_property hidpp_battery_props
[] = {
813 POWER_SUPPLY_PROP_STATUS
,
814 POWER_SUPPLY_PROP_CAPACITY
,
815 POWER_SUPPLY_PROP_SCOPE
,
816 POWER_SUPPLY_PROP_MODEL_NAME
,
817 POWER_SUPPLY_PROP_MANUFACTURER
,
818 POWER_SUPPLY_PROP_SERIAL_NUMBER
,
821 static int hidpp_battery_get_property(struct power_supply
*psy
,
822 enum power_supply_property psp
,
823 union power_supply_propval
*val
)
825 struct hidpp_device
*hidpp
= power_supply_get_drvdata(psy
);
829 case POWER_SUPPLY_PROP_STATUS
:
830 val
->intval
= hidpp
->battery
.status
;
832 case POWER_SUPPLY_PROP_CAPACITY
:
833 val
->intval
= hidpp
->battery
.level
;
835 case POWER_SUPPLY_PROP_SCOPE
:
836 val
->intval
= POWER_SUPPLY_SCOPE_DEVICE
;
838 case POWER_SUPPLY_PROP_MODEL_NAME
:
839 if (!strncmp(hidpp
->name
, "Logitech ", 9))
840 val
->strval
= hidpp
->name
+ 9;
842 val
->strval
= hidpp
->name
;
844 case POWER_SUPPLY_PROP_MANUFACTURER
:
845 val
->strval
= "Logitech";
847 case POWER_SUPPLY_PROP_SERIAL_NUMBER
:
848 val
->strval
= hidpp
->hid_dev
->uniq
;
858 static int hidpp20_initialize_battery(struct hidpp_device
*hidpp
)
860 static atomic_t battery_no
= ATOMIC_INIT(0);
861 struct power_supply_config cfg
= { .drv_data
= hidpp
};
862 struct power_supply_desc
*desc
= &hidpp
->battery
.desc
;
863 struct hidpp_battery
*battery
;
867 ret
= hidpp20_query_battery_info(hidpp
);
871 battery
= &hidpp
->battery
;
873 n
= atomic_inc_return(&battery_no
) - 1;
874 desc
->properties
= hidpp_battery_props
;
875 desc
->num_properties
= ARRAY_SIZE(hidpp_battery_props
);
876 desc
->get_property
= hidpp_battery_get_property
;
877 sprintf(battery
->name
, "hidpp_battery_%ld", n
);
878 desc
->name
= battery
->name
;
879 desc
->type
= POWER_SUPPLY_TYPE_BATTERY
;
880 desc
->use_for_apm
= 0;
882 battery
->ps
= devm_power_supply_register(&hidpp
->hid_dev
->dev
,
885 if (IS_ERR(battery
->ps
))
886 return PTR_ERR(battery
->ps
);
888 power_supply_powers(battery
->ps
, &hidpp
->hid_dev
->dev
);
893 static int hidpp_initialize_battery(struct hidpp_device
*hidpp
)
897 if (hidpp
->battery
.ps
)
900 if (hidpp
->protocol_major
>= 2) {
901 ret
= hidpp20_initialize_battery(hidpp
);
903 hidpp
->capabilities
|= HIDPP_CAPABILITY_HIDPP20_BATTERY
;
909 /* -------------------------------------------------------------------------- */
910 /* 0x6010: Touchpad FW items */
911 /* -------------------------------------------------------------------------- */
913 #define HIDPP_PAGE_TOUCHPAD_FW_ITEMS 0x6010
915 #define CMD_TOUCHPAD_FW_ITEMS_SET 0x10
917 struct hidpp_touchpad_fw_items
{
919 uint8_t desired_state
;
925 * send a set state command to the device by reading the current items->state
926 * field. items is then filled with the current state.
928 static int hidpp_touchpad_fw_items_set(struct hidpp_device
*hidpp
,
930 struct hidpp_touchpad_fw_items
*items
)
932 struct hidpp_report response
;
934 u8
*params
= (u8
*)response
.fap
.params
;
936 ret
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
937 CMD_TOUCHPAD_FW_ITEMS_SET
, &items
->state
, 1, &response
);
940 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
947 items
->presence
= params
[0];
948 items
->desired_state
= params
[1];
949 items
->state
= params
[2];
950 items
->persistent
= params
[3];
955 /* -------------------------------------------------------------------------- */
956 /* 0x6100: TouchPadRawXY */
957 /* -------------------------------------------------------------------------- */
959 #define HIDPP_PAGE_TOUCHPAD_RAW_XY 0x6100
961 #define CMD_TOUCHPAD_GET_RAW_INFO 0x01
962 #define CMD_TOUCHPAD_SET_RAW_REPORT_STATE 0x21
964 #define EVENT_TOUCHPAD_RAW_XY 0x00
966 #define TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT 0x01
967 #define TOUCHPAD_RAW_XY_ORIGIN_UPPER_LEFT 0x03
969 struct hidpp_touchpad_raw_info
{
980 struct hidpp_touchpad_raw_xy_finger
{
990 struct hidpp_touchpad_raw_xy
{
992 struct hidpp_touchpad_raw_xy_finger fingers
[2];
999 static int hidpp_touchpad_get_raw_info(struct hidpp_device
*hidpp
,
1000 u8 feature_index
, struct hidpp_touchpad_raw_info
*raw_info
)
1002 struct hidpp_report response
;
1004 u8
*params
= (u8
*)response
.fap
.params
;
1006 ret
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
1007 CMD_TOUCHPAD_GET_RAW_INFO
, NULL
, 0, &response
);
1010 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
1017 raw_info
->x_size
= get_unaligned_be16(¶ms
[0]);
1018 raw_info
->y_size
= get_unaligned_be16(¶ms
[2]);
1019 raw_info
->z_range
= params
[4];
1020 raw_info
->area_range
= params
[5];
1021 raw_info
->maxcontacts
= params
[7];
1022 raw_info
->origin
= params
[8];
1023 /* res is given in unit per inch */
1024 raw_info
->res
= get_unaligned_be16(¶ms
[13]) * 2 / 51;
1029 static int hidpp_touchpad_set_raw_report_state(struct hidpp_device
*hidpp_dev
,
1030 u8 feature_index
, bool send_raw_reports
,
1031 bool sensor_enhanced_settings
)
1033 struct hidpp_report response
;
1037 * bit 0 - enable raw
1038 * bit 1 - 16bit Z, no area
1039 * bit 2 - enhanced sensitivity
1040 * bit 3 - width, height (4 bits each) instead of area
1041 * bit 4 - send raw + gestures (degrades smoothness)
1042 * remaining bits - reserved
1044 u8 params
= send_raw_reports
| (sensor_enhanced_settings
<< 2);
1046 return hidpp_send_fap_command_sync(hidpp_dev
, feature_index
,
1047 CMD_TOUCHPAD_SET_RAW_REPORT_STATE
, ¶ms
, 1, &response
);
1050 static void hidpp_touchpad_touch_event(u8
*data
,
1051 struct hidpp_touchpad_raw_xy_finger
*finger
)
1053 u8 x_m
= data
[0] << 2;
1054 u8 y_m
= data
[2] << 2;
1056 finger
->x
= x_m
<< 6 | data
[1];
1057 finger
->y
= y_m
<< 6 | data
[3];
1059 finger
->contact_type
= data
[0] >> 6;
1060 finger
->contact_status
= data
[2] >> 6;
1062 finger
->z
= data
[4];
1063 finger
->area
= data
[5];
1064 finger
->finger_id
= data
[6] >> 4;
1067 static void hidpp_touchpad_raw_xy_event(struct hidpp_device
*hidpp_dev
,
1068 u8
*data
, struct hidpp_touchpad_raw_xy
*raw_xy
)
1070 memset(raw_xy
, 0, sizeof(struct hidpp_touchpad_raw_xy
));
1071 raw_xy
->end_of_frame
= data
[8] & 0x01;
1072 raw_xy
->spurious_flag
= (data
[8] >> 1) & 0x01;
1073 raw_xy
->finger_count
= data
[15] & 0x0f;
1074 raw_xy
->button
= (data
[8] >> 2) & 0x01;
1076 if (raw_xy
->finger_count
) {
1077 hidpp_touchpad_touch_event(&data
[2], &raw_xy
->fingers
[0]);
1078 hidpp_touchpad_touch_event(&data
[9], &raw_xy
->fingers
[1]);
1082 /* -------------------------------------------------------------------------- */
1083 /* 0x8123: Force feedback support */
1084 /* -------------------------------------------------------------------------- */
1086 #define HIDPP_FF_GET_INFO 0x01
1087 #define HIDPP_FF_RESET_ALL 0x11
1088 #define HIDPP_FF_DOWNLOAD_EFFECT 0x21
1089 #define HIDPP_FF_SET_EFFECT_STATE 0x31
1090 #define HIDPP_FF_DESTROY_EFFECT 0x41
1091 #define HIDPP_FF_GET_APERTURE 0x51
1092 #define HIDPP_FF_SET_APERTURE 0x61
1093 #define HIDPP_FF_GET_GLOBAL_GAINS 0x71
1094 #define HIDPP_FF_SET_GLOBAL_GAINS 0x81
1096 #define HIDPP_FF_EFFECT_STATE_GET 0x00
1097 #define HIDPP_FF_EFFECT_STATE_STOP 0x01
1098 #define HIDPP_FF_EFFECT_STATE_PLAY 0x02
1099 #define HIDPP_FF_EFFECT_STATE_PAUSE 0x03
1101 #define HIDPP_FF_EFFECT_CONSTANT 0x00
1102 #define HIDPP_FF_EFFECT_PERIODIC_SINE 0x01
1103 #define HIDPP_FF_EFFECT_PERIODIC_SQUARE 0x02
1104 #define HIDPP_FF_EFFECT_PERIODIC_TRIANGLE 0x03
1105 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP 0x04
1106 #define HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN 0x05
1107 #define HIDPP_FF_EFFECT_SPRING 0x06
1108 #define HIDPP_FF_EFFECT_DAMPER 0x07
1109 #define HIDPP_FF_EFFECT_FRICTION 0x08
1110 #define HIDPP_FF_EFFECT_INERTIA 0x09
1111 #define HIDPP_FF_EFFECT_RAMP 0x0A
1113 #define HIDPP_FF_EFFECT_AUTOSTART 0x80
1115 #define HIDPP_FF_EFFECTID_NONE -1
1116 #define HIDPP_FF_EFFECTID_AUTOCENTER -2
1118 #define HIDPP_FF_MAX_PARAMS 20
1119 #define HIDPP_FF_RESERVED_SLOTS 1
1121 struct hidpp_ff_private_data
{
1122 struct hidpp_device
*hidpp
;
1130 struct workqueue_struct
*wq
;
1131 atomic_t workqueue_size
;
1134 struct hidpp_ff_work_data
{
1135 struct work_struct work
;
1136 struct hidpp_ff_private_data
*data
;
1139 u8 params
[HIDPP_FF_MAX_PARAMS
];
1143 static const signed short hiddpp_ff_effects
[] = {
1158 static const signed short hiddpp_ff_effects_v2
[] = {
1165 static const u8 HIDPP_FF_CONDITION_CMDS
[] = {
1166 HIDPP_FF_EFFECT_SPRING
,
1167 HIDPP_FF_EFFECT_FRICTION
,
1168 HIDPP_FF_EFFECT_DAMPER
,
1169 HIDPP_FF_EFFECT_INERTIA
1172 static const char *HIDPP_FF_CONDITION_NAMES
[] = {
1180 static u8
hidpp_ff_find_effect(struct hidpp_ff_private_data
*data
, int effect_id
)
1184 for (i
= 0; i
< data
->num_effects
; i
++)
1185 if (data
->effect_ids
[i
] == effect_id
)
1191 static void hidpp_ff_work_handler(struct work_struct
*w
)
1193 struct hidpp_ff_work_data
*wd
= container_of(w
, struct hidpp_ff_work_data
, work
);
1194 struct hidpp_ff_private_data
*data
= wd
->data
;
1195 struct hidpp_report response
;
1199 /* add slot number if needed */
1200 switch (wd
->effect_id
) {
1201 case HIDPP_FF_EFFECTID_AUTOCENTER
:
1202 wd
->params
[0] = data
->slot_autocenter
;
1204 case HIDPP_FF_EFFECTID_NONE
:
1205 /* leave slot as zero */
1208 /* find current slot for effect */
1209 wd
->params
[0] = hidpp_ff_find_effect(data
, wd
->effect_id
);
1213 /* send command and wait for reply */
1214 ret
= hidpp_send_fap_command_sync(data
->hidpp
, data
->feature_index
,
1215 wd
->command
, wd
->params
, wd
->size
, &response
);
1218 hid_err(data
->hidpp
->hid_dev
, "Failed to send command to device!\n");
1222 /* parse return data */
1223 switch (wd
->command
) {
1224 case HIDPP_FF_DOWNLOAD_EFFECT
:
1225 slot
= response
.fap
.params
[0];
1226 if (slot
> 0 && slot
<= data
->num_effects
) {
1227 if (wd
->effect_id
>= 0)
1228 /* regular effect uploaded */
1229 data
->effect_ids
[slot
-1] = wd
->effect_id
;
1230 else if (wd
->effect_id
>= HIDPP_FF_EFFECTID_AUTOCENTER
)
1231 /* autocenter spring uploaded */
1232 data
->slot_autocenter
= slot
;
1235 case HIDPP_FF_DESTROY_EFFECT
:
1236 if (wd
->effect_id
>= 0)
1237 /* regular effect destroyed */
1238 data
->effect_ids
[wd
->params
[0]-1] = -1;
1239 else if (wd
->effect_id
>= HIDPP_FF_EFFECTID_AUTOCENTER
)
1240 /* autocenter spring destoyed */
1241 data
->slot_autocenter
= 0;
1243 case HIDPP_FF_SET_GLOBAL_GAINS
:
1244 data
->gain
= (wd
->params
[0] << 8) + wd
->params
[1];
1246 case HIDPP_FF_SET_APERTURE
:
1247 data
->range
= (wd
->params
[0] << 8) + wd
->params
[1];
1250 /* no action needed */
1255 atomic_dec(&data
->workqueue_size
);
1259 static int hidpp_ff_queue_work(struct hidpp_ff_private_data
*data
, int effect_id
, u8 command
, u8
*params
, u8 size
)
1261 struct hidpp_ff_work_data
*wd
= kzalloc(sizeof(*wd
), GFP_KERNEL
);
1267 INIT_WORK(&wd
->work
, hidpp_ff_work_handler
);
1270 wd
->effect_id
= effect_id
;
1271 wd
->command
= command
;
1273 memcpy(wd
->params
, params
, size
);
1275 atomic_inc(&data
->workqueue_size
);
1276 queue_work(data
->wq
, &wd
->work
);
1278 /* warn about excessive queue size */
1279 s
= atomic_read(&data
->workqueue_size
);
1280 if (s
>= 20 && s
% 20 == 0)
1281 hid_warn(data
->hidpp
->hid_dev
, "Force feedback command queue contains %d commands, causing substantial delays!", s
);
1286 static int hidpp_ff_upload_effect(struct input_dev
*dev
, struct ff_effect
*effect
, struct ff_effect
*old
)
1288 struct hidpp_ff_private_data
*data
= dev
->ff
->private;
1293 /* set common parameters */
1294 params
[2] = effect
->replay
.length
>> 8;
1295 params
[3] = effect
->replay
.length
& 255;
1296 params
[4] = effect
->replay
.delay
>> 8;
1297 params
[5] = effect
->replay
.delay
& 255;
1299 switch (effect
->type
) {
1301 force
= (effect
->u
.constant
.level
* fixp_sin16((effect
->direction
* 360) >> 16)) >> 15;
1302 params
[1] = HIDPP_FF_EFFECT_CONSTANT
;
1303 params
[6] = force
>> 8;
1304 params
[7] = force
& 255;
1305 params
[8] = effect
->u
.constant
.envelope
.attack_level
>> 7;
1306 params
[9] = effect
->u
.constant
.envelope
.attack_length
>> 8;
1307 params
[10] = effect
->u
.constant
.envelope
.attack_length
& 255;
1308 params
[11] = effect
->u
.constant
.envelope
.fade_level
>> 7;
1309 params
[12] = effect
->u
.constant
.envelope
.fade_length
>> 8;
1310 params
[13] = effect
->u
.constant
.envelope
.fade_length
& 255;
1312 dbg_hid("Uploading constant force level=%d in dir %d = %d\n",
1313 effect
->u
.constant
.level
,
1314 effect
->direction
, force
);
1315 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1316 effect
->u
.constant
.envelope
.attack_level
,
1317 effect
->u
.constant
.envelope
.attack_length
,
1318 effect
->u
.constant
.envelope
.fade_level
,
1319 effect
->u
.constant
.envelope
.fade_length
);
1323 switch (effect
->u
.periodic
.waveform
) {
1325 params
[1] = HIDPP_FF_EFFECT_PERIODIC_SINE
;
1328 params
[1] = HIDPP_FF_EFFECT_PERIODIC_SQUARE
;
1331 params
[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHUP
;
1334 params
[1] = HIDPP_FF_EFFECT_PERIODIC_SAWTOOTHDOWN
;
1337 params
[1] = HIDPP_FF_EFFECT_PERIODIC_TRIANGLE
;
1340 hid_err(data
->hidpp
->hid_dev
, "Unexpected periodic waveform type %i!\n", effect
->u
.periodic
.waveform
);
1343 force
= (effect
->u
.periodic
.magnitude
* fixp_sin16((effect
->direction
* 360) >> 16)) >> 15;
1344 params
[6] = effect
->u
.periodic
.magnitude
>> 8;
1345 params
[7] = effect
->u
.periodic
.magnitude
& 255;
1346 params
[8] = effect
->u
.periodic
.offset
>> 8;
1347 params
[9] = effect
->u
.periodic
.offset
& 255;
1348 params
[10] = effect
->u
.periodic
.period
>> 8;
1349 params
[11] = effect
->u
.periodic
.period
& 255;
1350 params
[12] = effect
->u
.periodic
.phase
>> 8;
1351 params
[13] = effect
->u
.periodic
.phase
& 255;
1352 params
[14] = effect
->u
.periodic
.envelope
.attack_level
>> 7;
1353 params
[15] = effect
->u
.periodic
.envelope
.attack_length
>> 8;
1354 params
[16] = effect
->u
.periodic
.envelope
.attack_length
& 255;
1355 params
[17] = effect
->u
.periodic
.envelope
.fade_level
>> 7;
1356 params
[18] = effect
->u
.periodic
.envelope
.fade_length
>> 8;
1357 params
[19] = effect
->u
.periodic
.envelope
.fade_length
& 255;
1359 dbg_hid("Uploading periodic force mag=%d/dir=%d, offset=%d, period=%d ms, phase=%d\n",
1360 effect
->u
.periodic
.magnitude
, effect
->direction
,
1361 effect
->u
.periodic
.offset
,
1362 effect
->u
.periodic
.period
,
1363 effect
->u
.periodic
.phase
);
1364 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1365 effect
->u
.periodic
.envelope
.attack_level
,
1366 effect
->u
.periodic
.envelope
.attack_length
,
1367 effect
->u
.periodic
.envelope
.fade_level
,
1368 effect
->u
.periodic
.envelope
.fade_length
);
1372 params
[1] = HIDPP_FF_EFFECT_RAMP
;
1373 force
= (effect
->u
.ramp
.start_level
* fixp_sin16((effect
->direction
* 360) >> 16)) >> 15;
1374 params
[6] = force
>> 8;
1375 params
[7] = force
& 255;
1376 force
= (effect
->u
.ramp
.end_level
* fixp_sin16((effect
->direction
* 360) >> 16)) >> 15;
1377 params
[8] = force
>> 8;
1378 params
[9] = force
& 255;
1379 params
[10] = effect
->u
.ramp
.envelope
.attack_level
>> 7;
1380 params
[11] = effect
->u
.ramp
.envelope
.attack_length
>> 8;
1381 params
[12] = effect
->u
.ramp
.envelope
.attack_length
& 255;
1382 params
[13] = effect
->u
.ramp
.envelope
.fade_level
>> 7;
1383 params
[14] = effect
->u
.ramp
.envelope
.fade_length
>> 8;
1384 params
[15] = effect
->u
.ramp
.envelope
.fade_length
& 255;
1386 dbg_hid("Uploading ramp force level=%d -> %d in dir %d = %d\n",
1387 effect
->u
.ramp
.start_level
,
1388 effect
->u
.ramp
.end_level
,
1389 effect
->direction
, force
);
1390 dbg_hid(" envelope attack=(%d, %d ms) fade=(%d, %d ms)\n",
1391 effect
->u
.ramp
.envelope
.attack_level
,
1392 effect
->u
.ramp
.envelope
.attack_length
,
1393 effect
->u
.ramp
.envelope
.fade_level
,
1394 effect
->u
.ramp
.envelope
.fade_length
);
1400 params
[1] = HIDPP_FF_CONDITION_CMDS
[effect
->type
- FF_SPRING
];
1401 params
[6] = effect
->u
.condition
[0].left_saturation
>> 9;
1402 params
[7] = (effect
->u
.condition
[0].left_saturation
>> 1) & 255;
1403 params
[8] = effect
->u
.condition
[0].left_coeff
>> 8;
1404 params
[9] = effect
->u
.condition
[0].left_coeff
& 255;
1405 params
[10] = effect
->u
.condition
[0].deadband
>> 9;
1406 params
[11] = (effect
->u
.condition
[0].deadband
>> 1) & 255;
1407 params
[12] = effect
->u
.condition
[0].center
>> 8;
1408 params
[13] = effect
->u
.condition
[0].center
& 255;
1409 params
[14] = effect
->u
.condition
[0].right_coeff
>> 8;
1410 params
[15] = effect
->u
.condition
[0].right_coeff
& 255;
1411 params
[16] = effect
->u
.condition
[0].right_saturation
>> 9;
1412 params
[17] = (effect
->u
.condition
[0].right_saturation
>> 1) & 255;
1414 dbg_hid("Uploading %s force left coeff=%d, left sat=%d, right coeff=%d, right sat=%d\n",
1415 HIDPP_FF_CONDITION_NAMES
[effect
->type
- FF_SPRING
],
1416 effect
->u
.condition
[0].left_coeff
,
1417 effect
->u
.condition
[0].left_saturation
,
1418 effect
->u
.condition
[0].right_coeff
,
1419 effect
->u
.condition
[0].right_saturation
);
1420 dbg_hid(" deadband=%d, center=%d\n",
1421 effect
->u
.condition
[0].deadband
,
1422 effect
->u
.condition
[0].center
);
1425 hid_err(data
->hidpp
->hid_dev
, "Unexpected force type %i!\n", effect
->type
);
1429 return hidpp_ff_queue_work(data
, effect
->id
, HIDPP_FF_DOWNLOAD_EFFECT
, params
, size
);
1432 static int hidpp_ff_playback(struct input_dev
*dev
, int effect_id
, int value
)
1434 struct hidpp_ff_private_data
*data
= dev
->ff
->private;
1437 params
[1] = value
? HIDPP_FF_EFFECT_STATE_PLAY
: HIDPP_FF_EFFECT_STATE_STOP
;
1439 dbg_hid("St%sing playback of effect %d.\n", value
?"art":"opp", effect_id
);
1441 return hidpp_ff_queue_work(data
, effect_id
, HIDPP_FF_SET_EFFECT_STATE
, params
, ARRAY_SIZE(params
));
1444 static int hidpp_ff_erase_effect(struct input_dev
*dev
, int effect_id
)
1446 struct hidpp_ff_private_data
*data
= dev
->ff
->private;
1449 dbg_hid("Erasing effect %d.\n", effect_id
);
1451 return hidpp_ff_queue_work(data
, effect_id
, HIDPP_FF_DESTROY_EFFECT
, &slot
, 1);
1454 static void hidpp_ff_set_autocenter(struct input_dev
*dev
, u16 magnitude
)
1456 struct hidpp_ff_private_data
*data
= dev
->ff
->private;
1459 dbg_hid("Setting autocenter to %d.\n", magnitude
);
1461 /* start a standard spring effect */
1462 params
[1] = HIDPP_FF_EFFECT_SPRING
| HIDPP_FF_EFFECT_AUTOSTART
;
1463 /* zero delay and duration */
1464 params
[2] = params
[3] = params
[4] = params
[5] = 0;
1465 /* set coeff to 25% of saturation */
1466 params
[8] = params
[14] = magnitude
>> 11;
1467 params
[9] = params
[15] = (magnitude
>> 3) & 255;
1468 params
[6] = params
[16] = magnitude
>> 9;
1469 params
[7] = params
[17] = (magnitude
>> 1) & 255;
1470 /* zero deadband and center */
1471 params
[10] = params
[11] = params
[12] = params
[13] = 0;
1473 hidpp_ff_queue_work(data
, HIDPP_FF_EFFECTID_AUTOCENTER
, HIDPP_FF_DOWNLOAD_EFFECT
, params
, ARRAY_SIZE(params
));
1476 static void hidpp_ff_set_gain(struct input_dev
*dev
, u16 gain
)
1478 struct hidpp_ff_private_data
*data
= dev
->ff
->private;
1481 dbg_hid("Setting gain to %d.\n", gain
);
1483 params
[0] = gain
>> 8;
1484 params
[1] = gain
& 255;
1485 params
[2] = 0; /* no boost */
1488 hidpp_ff_queue_work(data
, HIDPP_FF_EFFECTID_NONE
, HIDPP_FF_SET_GLOBAL_GAINS
, params
, ARRAY_SIZE(params
));
1491 static ssize_t
hidpp_ff_range_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
1493 struct hid_device
*hid
= to_hid_device(dev
);
1494 struct hid_input
*hidinput
= list_entry(hid
->inputs
.next
, struct hid_input
, list
);
1495 struct input_dev
*idev
= hidinput
->input
;
1496 struct hidpp_ff_private_data
*data
= idev
->ff
->private;
1498 return scnprintf(buf
, PAGE_SIZE
, "%u\n", data
->range
);
1501 static ssize_t
hidpp_ff_range_store(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
1503 struct hid_device
*hid
= to_hid_device(dev
);
1504 struct hid_input
*hidinput
= list_entry(hid
->inputs
.next
, struct hid_input
, list
);
1505 struct input_dev
*idev
= hidinput
->input
;
1506 struct hidpp_ff_private_data
*data
= idev
->ff
->private;
1508 int range
= simple_strtoul(buf
, NULL
, 10);
1510 range
= clamp(range
, 180, 900);
1512 params
[0] = range
>> 8;
1513 params
[1] = range
& 0x00FF;
1515 hidpp_ff_queue_work(data
, -1, HIDPP_FF_SET_APERTURE
, params
, ARRAY_SIZE(params
));
1520 static DEVICE_ATTR(range
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IROTH
, hidpp_ff_range_show
, hidpp_ff_range_store
);
1522 static void hidpp_ff_destroy(struct ff_device
*ff
)
1524 struct hidpp_ff_private_data
*data
= ff
->private;
1526 kfree(data
->effect_ids
);
1529 static int hidpp_ff_init(struct hidpp_device
*hidpp
, u8 feature_index
)
1531 struct hid_device
*hid
= hidpp
->hid_dev
;
1532 struct hid_input
*hidinput
= list_entry(hid
->inputs
.next
, struct hid_input
, list
);
1533 struct input_dev
*dev
= hidinput
->input
;
1534 const struct usb_device_descriptor
*udesc
= &(hid_to_usb_dev(hid
)->descriptor
);
1535 const u16 bcdDevice
= le16_to_cpu(udesc
->bcdDevice
);
1536 struct ff_device
*ff
;
1537 struct hidpp_report response
;
1538 struct hidpp_ff_private_data
*data
;
1539 int error
, j
, num_slots
;
1543 hid_err(hid
, "Struct input_dev not set!\n");
1547 /* Get firmware release */
1548 version
= bcdDevice
& 255;
1550 /* Set supported force feedback capabilities */
1551 for (j
= 0; hiddpp_ff_effects
[j
] >= 0; j
++)
1552 set_bit(hiddpp_ff_effects
[j
], dev
->ffbit
);
1554 for (j
= 0; hiddpp_ff_effects_v2
[j
] >= 0; j
++)
1555 set_bit(hiddpp_ff_effects_v2
[j
], dev
->ffbit
);
1557 /* Read number of slots available in device */
1558 error
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
1559 HIDPP_FF_GET_INFO
, NULL
, 0, &response
);
1563 hid_err(hidpp
->hid_dev
, "%s: received protocol error 0x%02x\n",
1568 num_slots
= response
.fap
.params
[0] - HIDPP_FF_RESERVED_SLOTS
;
1570 error
= input_ff_create(dev
, num_slots
);
1573 hid_err(dev
, "Failed to create FF device!\n");
1577 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
1580 data
->effect_ids
= kcalloc(num_slots
, sizeof(int), GFP_KERNEL
);
1581 if (!data
->effect_ids
) {
1585 data
->hidpp
= hidpp
;
1586 data
->feature_index
= feature_index
;
1587 data
->version
= version
;
1588 data
->slot_autocenter
= 0;
1589 data
->num_effects
= num_slots
;
1590 for (j
= 0; j
< num_slots
; j
++)
1591 data
->effect_ids
[j
] = -1;
1596 ff
->upload
= hidpp_ff_upload_effect
;
1597 ff
->erase
= hidpp_ff_erase_effect
;
1598 ff
->playback
= hidpp_ff_playback
;
1599 ff
->set_gain
= hidpp_ff_set_gain
;
1600 ff
->set_autocenter
= hidpp_ff_set_autocenter
;
1601 ff
->destroy
= hidpp_ff_destroy
;
1604 /* reset all forces */
1605 error
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
1606 HIDPP_FF_RESET_ALL
, NULL
, 0, &response
);
1608 /* Read current Range */
1609 error
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
1610 HIDPP_FF_GET_APERTURE
, NULL
, 0, &response
);
1612 hid_warn(hidpp
->hid_dev
, "Failed to read range from device!\n");
1613 data
->range
= error
? 900 : get_unaligned_be16(&response
.fap
.params
[0]);
1615 /* Create sysfs interface */
1616 error
= device_create_file(&(hidpp
->hid_dev
->dev
), &dev_attr_range
);
1618 hid_warn(hidpp
->hid_dev
, "Unable to create sysfs interface for \"range\", errno %d!\n", error
);
1620 /* Read the current gain values */
1621 error
= hidpp_send_fap_command_sync(hidpp
, feature_index
,
1622 HIDPP_FF_GET_GLOBAL_GAINS
, NULL
, 0, &response
);
1624 hid_warn(hidpp
->hid_dev
, "Failed to read gain values from device!\n");
1625 data
->gain
= error
? 0xffff : get_unaligned_be16(&response
.fap
.params
[0]);
1626 /* ignore boost value at response.fap.params[2] */
1628 /* init the hardware command queue */
1629 data
->wq
= create_singlethread_workqueue("hidpp-ff-sendqueue");
1630 atomic_set(&data
->workqueue_size
, 0);
1632 /* initialize with zero autocenter to get wheel in usable state */
1633 hidpp_ff_set_autocenter(dev
, 0);
1635 hid_info(hid
, "Force feeback support loaded (firmware release %d).\n", version
);
1640 static int hidpp_ff_deinit(struct hid_device
*hid
)
1642 struct hid_input
*hidinput
= list_entry(hid
->inputs
.next
, struct hid_input
, list
);
1643 struct input_dev
*dev
= hidinput
->input
;
1644 struct hidpp_ff_private_data
*data
;
1647 hid_err(hid
, "Struct input_dev not found!\n");
1651 hid_info(hid
, "Unloading HID++ force feedback.\n");
1652 data
= dev
->ff
->private;
1654 hid_err(hid
, "Private data not found!\n");
1658 destroy_workqueue(data
->wq
);
1659 device_remove_file(&hid
->dev
, &dev_attr_range
);
1665 /* ************************************************************************** */
1667 /* Device Support */
1669 /* ************************************************************************** */
1671 /* -------------------------------------------------------------------------- */
1672 /* Touchpad HID++ devices */
1673 /* -------------------------------------------------------------------------- */
1675 #define WTP_MANUAL_RESOLUTION 39
1678 struct input_dev
*input
;
1681 u8 mt_feature_index
;
1682 u8 button_feature_index
;
1685 unsigned int resolution
;
1688 static int wtp_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
1689 struct hid_field
*field
, struct hid_usage
*usage
,
1690 unsigned long **bit
, int *max
)
1695 static void wtp_populate_input(struct hidpp_device
*hidpp
,
1696 struct input_dev
*input_dev
, bool origin_is_hid_core
)
1698 struct wtp_data
*wd
= hidpp
->private_data
;
1700 __set_bit(EV_ABS
, input_dev
->evbit
);
1701 __set_bit(EV_KEY
, input_dev
->evbit
);
1702 __clear_bit(EV_REL
, input_dev
->evbit
);
1703 __clear_bit(EV_LED
, input_dev
->evbit
);
1705 input_set_abs_params(input_dev
, ABS_MT_POSITION_X
, 0, wd
->x_size
, 0, 0);
1706 input_abs_set_res(input_dev
, ABS_MT_POSITION_X
, wd
->resolution
);
1707 input_set_abs_params(input_dev
, ABS_MT_POSITION_Y
, 0, wd
->y_size
, 0, 0);
1708 input_abs_set_res(input_dev
, ABS_MT_POSITION_Y
, wd
->resolution
);
1710 /* Max pressure is not given by the devices, pick one */
1711 input_set_abs_params(input_dev
, ABS_MT_PRESSURE
, 0, 50, 0, 0);
1713 input_set_capability(input_dev
, EV_KEY
, BTN_LEFT
);
1715 if (hidpp
->quirks
& HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS
)
1716 input_set_capability(input_dev
, EV_KEY
, BTN_RIGHT
);
1718 __set_bit(INPUT_PROP_BUTTONPAD
, input_dev
->propbit
);
1720 input_mt_init_slots(input_dev
, wd
->maxcontacts
, INPUT_MT_POINTER
|
1721 INPUT_MT_DROP_UNUSED
);
1723 wd
->input
= input_dev
;
1726 static void wtp_touch_event(struct wtp_data
*wd
,
1727 struct hidpp_touchpad_raw_xy_finger
*touch_report
)
1731 if (!touch_report
->finger_id
|| touch_report
->contact_type
)
1732 /* no actual data */
1735 slot
= input_mt_get_slot_by_key(wd
->input
, touch_report
->finger_id
);
1737 input_mt_slot(wd
->input
, slot
);
1738 input_mt_report_slot_state(wd
->input
, MT_TOOL_FINGER
,
1739 touch_report
->contact_status
);
1740 if (touch_report
->contact_status
) {
1741 input_event(wd
->input
, EV_ABS
, ABS_MT_POSITION_X
,
1743 input_event(wd
->input
, EV_ABS
, ABS_MT_POSITION_Y
,
1744 wd
->flip_y
? wd
->y_size
- touch_report
->y
:
1746 input_event(wd
->input
, EV_ABS
, ABS_MT_PRESSURE
,
1747 touch_report
->area
);
1751 static void wtp_send_raw_xy_event(struct hidpp_device
*hidpp
,
1752 struct hidpp_touchpad_raw_xy
*raw
)
1754 struct wtp_data
*wd
= hidpp
->private_data
;
1757 for (i
= 0; i
< 2; i
++)
1758 wtp_touch_event(wd
, &(raw
->fingers
[i
]));
1760 if (raw
->end_of_frame
&&
1761 !(hidpp
->quirks
& HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS
))
1762 input_event(wd
->input
, EV_KEY
, BTN_LEFT
, raw
->button
);
1764 if (raw
->end_of_frame
|| raw
->finger_count
<= 2) {
1765 input_mt_sync_frame(wd
->input
);
1766 input_sync(wd
->input
);
1770 static int wtp_mouse_raw_xy_event(struct hidpp_device
*hidpp
, u8
*data
)
1772 struct wtp_data
*wd
= hidpp
->private_data
;
1773 u8 c1_area
= ((data
[7] & 0xf) * (data
[7] & 0xf) +
1774 (data
[7] >> 4) * (data
[7] >> 4)) / 2;
1775 u8 c2_area
= ((data
[13] & 0xf) * (data
[13] & 0xf) +
1776 (data
[13] >> 4) * (data
[13] >> 4)) / 2;
1777 struct hidpp_touchpad_raw_xy raw
= {
1778 .timestamp
= data
[1],
1782 .contact_status
= !!data
[7],
1783 .x
= get_unaligned_le16(&data
[3]),
1784 .y
= get_unaligned_le16(&data
[5]),
1787 .finger_id
= data
[2],
1790 .contact_status
= !!data
[13],
1791 .x
= get_unaligned_le16(&data
[9]),
1792 .y
= get_unaligned_le16(&data
[11]),
1795 .finger_id
= data
[8],
1798 .finger_count
= wd
->maxcontacts
,
1800 .end_of_frame
= (data
[0] >> 7) == 0,
1801 .button
= data
[0] & 0x01,
1804 wtp_send_raw_xy_event(hidpp
, &raw
);
1809 static int wtp_raw_event(struct hid_device
*hdev
, u8
*data
, int size
)
1811 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
1812 struct wtp_data
*wd
= hidpp
->private_data
;
1813 struct hidpp_report
*report
= (struct hidpp_report
*)data
;
1814 struct hidpp_touchpad_raw_xy raw
;
1816 if (!wd
|| !wd
->input
)
1822 hid_err(hdev
, "Received HID report of bad size (%d)",
1826 if (hidpp
->quirks
& HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS
) {
1827 input_event(wd
->input
, EV_KEY
, BTN_LEFT
,
1828 !!(data
[1] & 0x01));
1829 input_event(wd
->input
, EV_KEY
, BTN_RIGHT
,
1830 !!(data
[1] & 0x02));
1831 input_sync(wd
->input
);
1836 return wtp_mouse_raw_xy_event(hidpp
, &data
[7]);
1838 case REPORT_ID_HIDPP_LONG
:
1839 /* size is already checked in hidpp_raw_event. */
1840 if ((report
->fap
.feature_index
!= wd
->mt_feature_index
) ||
1841 (report
->fap
.funcindex_clientid
!= EVENT_TOUCHPAD_RAW_XY
))
1843 hidpp_touchpad_raw_xy_event(hidpp
, data
+ 4, &raw
);
1845 wtp_send_raw_xy_event(hidpp
, &raw
);
1852 static int wtp_get_config(struct hidpp_device
*hidpp
)
1854 struct wtp_data
*wd
= hidpp
->private_data
;
1855 struct hidpp_touchpad_raw_info raw_info
= {0};
1859 ret
= hidpp_root_get_feature(hidpp
, HIDPP_PAGE_TOUCHPAD_RAW_XY
,
1860 &wd
->mt_feature_index
, &feature_type
);
1862 /* means that the device is not powered up */
1865 ret
= hidpp_touchpad_get_raw_info(hidpp
, wd
->mt_feature_index
,
1870 wd
->x_size
= raw_info
.x_size
;
1871 wd
->y_size
= raw_info
.y_size
;
1872 wd
->maxcontacts
= raw_info
.maxcontacts
;
1873 wd
->flip_y
= raw_info
.origin
== TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT
;
1874 wd
->resolution
= raw_info
.res
;
1875 if (!wd
->resolution
)
1876 wd
->resolution
= WTP_MANUAL_RESOLUTION
;
1881 static int wtp_allocate(struct hid_device
*hdev
, const struct hid_device_id
*id
)
1883 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
1884 struct wtp_data
*wd
;
1886 wd
= devm_kzalloc(&hdev
->dev
, sizeof(struct wtp_data
),
1891 hidpp
->private_data
= wd
;
1896 static int wtp_connect(struct hid_device
*hdev
, bool connected
)
1898 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
1899 struct wtp_data
*wd
= hidpp
->private_data
;
1903 ret
= wtp_get_config(hidpp
);
1905 hid_err(hdev
, "Can not get wtp config: %d\n", ret
);
1910 return hidpp_touchpad_set_raw_report_state(hidpp
, wd
->mt_feature_index
,
1914 /* ------------------------------------------------------------------------- */
1915 /* Logitech M560 devices */
1916 /* ------------------------------------------------------------------------- */
1919 * Logitech M560 protocol overview
1921 * The Logitech M560 mouse, is designed for windows 8. When the middle and/or
1922 * the sides buttons are pressed, it sends some keyboard keys events
1923 * instead of buttons ones.
1924 * To complicate things further, the middle button keys sequence
1925 * is different from the odd press and the even press.
1927 * forward button -> Super_R
1928 * backward button -> Super_L+'d' (press only)
1929 * middle button -> 1st time: Alt_L+SuperL+XF86TouchpadOff (press only)
1930 * 2nd time: left-click (press only)
1931 * NB: press-only means that when the button is pressed, the
1932 * KeyPress/ButtonPress and KeyRelease/ButtonRelease events are generated
1933 * together sequentially; instead when the button is released, no event is
1937 * 10<xx>0a 3500af03 (where <xx> is the mouse id),
1938 * the mouse reacts differently:
1939 * - it never sends a keyboard key event
1940 * - for the three mouse button it sends:
1941 * middle button press 11<xx>0a 3500af00...
1942 * side 1 button (forward) press 11<xx>0a 3500b000...
1943 * side 2 button (backward) press 11<xx>0a 3500ae00...
1944 * middle/side1/side2 button release 11<xx>0a 35000000...
1947 static const u8 m560_config_parameter
[] = {0x00, 0xaf, 0x03};
1949 struct m560_private_data
{
1950 struct input_dev
*input
;
1953 /* how buttons are mapped in the report */
1954 #define M560_MOUSE_BTN_LEFT 0x01
1955 #define M560_MOUSE_BTN_RIGHT 0x02
1956 #define M560_MOUSE_BTN_WHEEL_LEFT 0x08
1957 #define M560_MOUSE_BTN_WHEEL_RIGHT 0x10
1959 #define M560_SUB_ID 0x0a
1960 #define M560_BUTTON_MODE_REGISTER 0x35
1962 static int m560_send_config_command(struct hid_device
*hdev
, bool connected
)
1964 struct hidpp_report response
;
1965 struct hidpp_device
*hidpp_dev
;
1967 hidpp_dev
= hid_get_drvdata(hdev
);
1969 return hidpp_send_rap_command_sync(
1971 REPORT_ID_HIDPP_SHORT
,
1973 M560_BUTTON_MODE_REGISTER
,
1974 (u8
*)m560_config_parameter
,
1975 sizeof(m560_config_parameter
),
1980 static int m560_allocate(struct hid_device
*hdev
)
1982 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
1983 struct m560_private_data
*d
;
1985 d
= devm_kzalloc(&hdev
->dev
, sizeof(struct m560_private_data
),
1990 hidpp
->private_data
= d
;
1995 static int m560_raw_event(struct hid_device
*hdev
, u8
*data
, int size
)
1997 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
1998 struct m560_private_data
*mydata
= hidpp
->private_data
;
2001 if (!mydata
|| !mydata
->input
) {
2002 hid_err(hdev
, "error in parameter\n");
2007 hid_err(hdev
, "error in report\n");
2011 if (data
[0] == REPORT_ID_HIDPP_LONG
&&
2012 data
[2] == M560_SUB_ID
&& data
[6] == 0x00) {
2014 * m560 mouse report for middle, forward and backward button
2017 * data[1] = device-id
2019 * data[5] = 0xaf -> middle
2022 * 0x00 -> release all
2028 input_report_key(mydata
->input
, BTN_MIDDLE
, 1);
2031 input_report_key(mydata
->input
, BTN_FORWARD
, 1);
2034 input_report_key(mydata
->input
, BTN_BACK
, 1);
2037 input_report_key(mydata
->input
, BTN_BACK
, 0);
2038 input_report_key(mydata
->input
, BTN_FORWARD
, 0);
2039 input_report_key(mydata
->input
, BTN_MIDDLE
, 0);
2042 hid_err(hdev
, "error in report\n");
2045 input_sync(mydata
->input
);
2047 } else if (data
[0] == 0x02) {
2049 * Logitech M560 mouse report
2051 * data[0] = type (0x02)
2052 * data[1..2] = buttons
2059 input_report_key(mydata
->input
, BTN_LEFT
,
2060 !!(data
[1] & M560_MOUSE_BTN_LEFT
));
2061 input_report_key(mydata
->input
, BTN_RIGHT
,
2062 !!(data
[1] & M560_MOUSE_BTN_RIGHT
));
2064 if (data
[1] & M560_MOUSE_BTN_WHEEL_LEFT
)
2065 input_report_rel(mydata
->input
, REL_HWHEEL
, -1);
2066 else if (data
[1] & M560_MOUSE_BTN_WHEEL_RIGHT
)
2067 input_report_rel(mydata
->input
, REL_HWHEEL
, 1);
2069 v
= hid_snto32(hid_field_extract(hdev
, data
+3, 0, 12), 12);
2070 input_report_rel(mydata
->input
, REL_X
, v
);
2072 v
= hid_snto32(hid_field_extract(hdev
, data
+3, 12, 12), 12);
2073 input_report_rel(mydata
->input
, REL_Y
, v
);
2075 v
= hid_snto32(data
[6], 8);
2076 input_report_rel(mydata
->input
, REL_WHEEL
, v
);
2078 input_sync(mydata
->input
);
2084 static void m560_populate_input(struct hidpp_device
*hidpp
,
2085 struct input_dev
*input_dev
, bool origin_is_hid_core
)
2087 struct m560_private_data
*mydata
= hidpp
->private_data
;
2089 mydata
->input
= input_dev
;
2091 __set_bit(EV_KEY
, mydata
->input
->evbit
);
2092 __set_bit(BTN_MIDDLE
, mydata
->input
->keybit
);
2093 __set_bit(BTN_RIGHT
, mydata
->input
->keybit
);
2094 __set_bit(BTN_LEFT
, mydata
->input
->keybit
);
2095 __set_bit(BTN_BACK
, mydata
->input
->keybit
);
2096 __set_bit(BTN_FORWARD
, mydata
->input
->keybit
);
2098 __set_bit(EV_REL
, mydata
->input
->evbit
);
2099 __set_bit(REL_X
, mydata
->input
->relbit
);
2100 __set_bit(REL_Y
, mydata
->input
->relbit
);
2101 __set_bit(REL_WHEEL
, mydata
->input
->relbit
);
2102 __set_bit(REL_HWHEEL
, mydata
->input
->relbit
);
2105 static int m560_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
2106 struct hid_field
*field
, struct hid_usage
*usage
,
2107 unsigned long **bit
, int *max
)
2112 /* ------------------------------------------------------------------------- */
2113 /* Logitech K400 devices */
2114 /* ------------------------------------------------------------------------- */
2117 * The Logitech K400 keyboard has an embedded touchpad which is seen
2118 * as a mouse from the OS point of view. There is a hardware shortcut to disable
2119 * tap-to-click but the setting is not remembered accross reset, annoying some
2122 * We can toggle this feature from the host by using the feature 0x6010:
2126 struct k400_private_data
{
2130 static int k400_disable_tap_to_click(struct hidpp_device
*hidpp
)
2132 struct k400_private_data
*k400
= hidpp
->private_data
;
2133 struct hidpp_touchpad_fw_items items
= {};
2137 if (!k400
->feature_index
) {
2138 ret
= hidpp_root_get_feature(hidpp
,
2139 HIDPP_PAGE_TOUCHPAD_FW_ITEMS
,
2140 &k400
->feature_index
, &feature_type
);
2142 /* means that the device is not powered up */
2146 ret
= hidpp_touchpad_fw_items_set(hidpp
, k400
->feature_index
, &items
);
2153 static int k400_allocate(struct hid_device
*hdev
)
2155 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2156 struct k400_private_data
*k400
;
2158 k400
= devm_kzalloc(&hdev
->dev
, sizeof(struct k400_private_data
),
2163 hidpp
->private_data
= k400
;
2168 static int k400_connect(struct hid_device
*hdev
, bool connected
)
2170 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2172 if (!disable_tap_to_click
)
2175 return k400_disable_tap_to_click(hidpp
);
2178 /* ------------------------------------------------------------------------- */
2179 /* Logitech G920 Driving Force Racing Wheel for Xbox One */
2180 /* ------------------------------------------------------------------------- */
2182 #define HIDPP_PAGE_G920_FORCE_FEEDBACK 0x8123
2184 static int g920_get_config(struct hidpp_device
*hidpp
)
2190 /* Find feature and store for later use */
2191 ret
= hidpp_root_get_feature(hidpp
, HIDPP_PAGE_G920_FORCE_FEEDBACK
,
2192 &feature_index
, &feature_type
);
2196 ret
= hidpp_ff_init(hidpp
, feature_index
);
2198 hid_warn(hidpp
->hid_dev
, "Unable to initialize force feedback support, errno %d\n",
2204 /* -------------------------------------------------------------------------- */
2205 /* Generic HID++ devices */
2206 /* -------------------------------------------------------------------------- */
2208 static int hidpp_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
2209 struct hid_field
*field
, struct hid_usage
*usage
,
2210 unsigned long **bit
, int *max
)
2212 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2214 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
)
2215 return wtp_input_mapping(hdev
, hi
, field
, usage
, bit
, max
);
2216 else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_M560
&&
2217 field
->application
!= HID_GD_MOUSE
)
2218 return m560_input_mapping(hdev
, hi
, field
, usage
, bit
, max
);
2223 static int hidpp_input_mapped(struct hid_device
*hdev
, struct hid_input
*hi
,
2224 struct hid_field
*field
, struct hid_usage
*usage
,
2225 unsigned long **bit
, int *max
)
2227 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2229 /* Ensure that Logitech G920 is not given a default fuzz/flat value */
2230 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
) {
2231 if (usage
->type
== EV_ABS
&& (usage
->code
== ABS_X
||
2232 usage
->code
== ABS_Y
|| usage
->code
== ABS_Z
||
2233 usage
->code
== ABS_RZ
)) {
2234 field
->application
= HID_GD_MULTIAXIS
;
2242 static void hidpp_populate_input(struct hidpp_device
*hidpp
,
2243 struct input_dev
*input
, bool origin_is_hid_core
)
2245 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
)
2246 wtp_populate_input(hidpp
, input
, origin_is_hid_core
);
2247 else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_M560
)
2248 m560_populate_input(hidpp
, input
, origin_is_hid_core
);
2251 static int hidpp_input_configured(struct hid_device
*hdev
,
2252 struct hid_input
*hidinput
)
2254 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2255 struct input_dev
*input
= hidinput
->input
;
2257 hidpp_populate_input(hidpp
, input
, true);
2262 static int hidpp_raw_hidpp_event(struct hidpp_device
*hidpp
, u8
*data
,
2265 struct hidpp_report
*question
= hidpp
->send_receive_buf
;
2266 struct hidpp_report
*answer
= hidpp
->send_receive_buf
;
2267 struct hidpp_report
*report
= (struct hidpp_report
*)data
;
2271 * If the mutex is locked then we have a pending answer from a
2272 * previously sent command.
2274 if (unlikely(mutex_is_locked(&hidpp
->send_mutex
))) {
2276 * Check for a correct hidpp20 answer or the corresponding
2279 if (hidpp_match_answer(question
, report
) ||
2280 hidpp_match_error(question
, report
)) {
2282 hidpp
->answer_available
= true;
2283 wake_up(&hidpp
->wait
);
2285 * This was an answer to a command that this driver sent
2286 * We return 1 to hid-core to avoid forwarding the
2287 * command upstream as it has been treated by the driver
2294 if (unlikely(hidpp_report_is_connect_event(report
))) {
2295 atomic_set(&hidpp
->connected
,
2296 !(report
->rap
.params
[0] & (1 << 6)));
2297 if (schedule_work(&hidpp
->work
) == 0)
2298 dbg_hid("%s: connect event already queued\n", __func__
);
2302 if (hidpp
->capabilities
& HIDPP_CAPABILITY_HIDPP20_BATTERY
) {
2303 ret
= hidpp20_battery_event(hidpp
, data
, size
);
2311 static int hidpp_raw_event(struct hid_device
*hdev
, struct hid_report
*report
,
2314 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2317 /* Generic HID++ processing. */
2319 case REPORT_ID_HIDPP_VERY_LONG
:
2320 if (size
!= HIDPP_REPORT_VERY_LONG_LENGTH
) {
2321 hid_err(hdev
, "received hid++ report of bad size (%d)",
2325 ret
= hidpp_raw_hidpp_event(hidpp
, data
, size
);
2327 case REPORT_ID_HIDPP_LONG
:
2328 if (size
!= HIDPP_REPORT_LONG_LENGTH
) {
2329 hid_err(hdev
, "received hid++ report of bad size (%d)",
2333 ret
= hidpp_raw_hidpp_event(hidpp
, data
, size
);
2335 case REPORT_ID_HIDPP_SHORT
:
2336 if (size
!= HIDPP_REPORT_SHORT_LENGTH
) {
2337 hid_err(hdev
, "received hid++ report of bad size (%d)",
2341 ret
= hidpp_raw_hidpp_event(hidpp
, data
, size
);
2345 /* If no report is available for further processing, skip calling
2346 * raw_event of subclasses. */
2350 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
)
2351 return wtp_raw_event(hdev
, data
, size
);
2352 else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_M560
)
2353 return m560_raw_event(hdev
, data
, size
);
2358 static void hidpp_overwrite_name(struct hid_device
*hdev
)
2360 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2363 if (hidpp
->protocol_major
< 2)
2366 name
= hidpp_get_device_name(hidpp
);
2369 hid_err(hdev
, "unable to retrieve the name of the device");
2371 dbg_hid("HID++: Got name: %s\n", name
);
2372 snprintf(hdev
->name
, sizeof(hdev
->name
), "%s", name
);
2378 static int hidpp_input_open(struct input_dev
*dev
)
2380 struct hid_device
*hid
= input_get_drvdata(dev
);
2382 return hid_hw_open(hid
);
2385 static void hidpp_input_close(struct input_dev
*dev
)
2387 struct hid_device
*hid
= input_get_drvdata(dev
);
2392 static struct input_dev
*hidpp_allocate_input(struct hid_device
*hdev
)
2394 struct input_dev
*input_dev
= devm_input_allocate_device(&hdev
->dev
);
2395 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2400 input_set_drvdata(input_dev
, hdev
);
2401 input_dev
->open
= hidpp_input_open
;
2402 input_dev
->close
= hidpp_input_close
;
2404 input_dev
->name
= hidpp
->name
;
2405 input_dev
->phys
= hdev
->phys
;
2406 input_dev
->uniq
= hdev
->uniq
;
2407 input_dev
->id
.bustype
= hdev
->bus
;
2408 input_dev
->id
.vendor
= hdev
->vendor
;
2409 input_dev
->id
.product
= hdev
->product
;
2410 input_dev
->id
.version
= hdev
->version
;
2411 input_dev
->dev
.parent
= &hdev
->dev
;
2416 static void hidpp_connect_event(struct hidpp_device
*hidpp
)
2418 struct hid_device
*hdev
= hidpp
->hid_dev
;
2420 bool connected
= atomic_read(&hidpp
->connected
);
2421 struct input_dev
*input
;
2422 char *name
, *devm_name
;
2427 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
) {
2428 ret
= wtp_connect(hdev
, connected
);
2431 } else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_M560
) {
2432 ret
= m560_send_config_command(hdev
, connected
);
2435 } else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_K400
) {
2436 ret
= k400_connect(hdev
, connected
);
2441 /* the device is already connected, we can ask for its name and
2443 if (!hidpp
->protocol_major
) {
2444 ret
= !hidpp_is_connected(hidpp
);
2446 hid_err(hdev
, "Can not get the protocol version.\n");
2449 hid_info(hdev
, "HID++ %u.%u device connected.\n",
2450 hidpp
->protocol_major
, hidpp
->protocol_minor
);
2453 if (hidpp
->name
== hdev
->name
&& hidpp
->protocol_major
>= 2) {
2454 name
= hidpp_get_device_name(hidpp
);
2457 "unable to retrieve the name of the device");
2461 devm_name
= devm_kasprintf(&hdev
->dev
, GFP_KERNEL
, "%s", name
);
2466 hidpp
->name
= devm_name
;
2469 hidpp_initialize_battery(hidpp
);
2471 if (!(hidpp
->quirks
& HIDPP_QUIRK_NO_HIDINPUT
) || hidpp
->delayed_input
)
2472 /* if the input nodes are already created, we can stop now */
2475 input
= hidpp_allocate_input(hdev
);
2477 hid_err(hdev
, "cannot allocate new input device: %d\n", ret
);
2481 hidpp_populate_input(hidpp
, input
, false);
2483 ret
= input_register_device(input
);
2485 input_free_device(input
);
2487 hidpp
->delayed_input
= input
;
2490 static int hidpp_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
2492 struct hidpp_device
*hidpp
;
2495 unsigned int connect_mask
= HID_CONNECT_DEFAULT
;
2497 hidpp
= devm_kzalloc(&hdev
->dev
, sizeof(struct hidpp_device
),
2502 hidpp
->hid_dev
= hdev
;
2503 hidpp
->name
= hdev
->name
;
2504 hid_set_drvdata(hdev
, hidpp
);
2506 hidpp
->quirks
= id
->driver_data
;
2508 if (id
->group
== HID_GROUP_LOGITECH_DJ_DEVICE
)
2509 hidpp
->quirks
|= HIDPP_QUIRK_UNIFYING
;
2511 if (disable_raw_mode
) {
2512 hidpp
->quirks
&= ~HIDPP_QUIRK_CLASS_WTP
;
2513 hidpp
->quirks
&= ~HIDPP_QUIRK_NO_HIDINPUT
;
2516 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
) {
2517 ret
= wtp_allocate(hdev
, id
);
2520 } else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_M560
) {
2521 ret
= m560_allocate(hdev
);
2524 } else if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_K400
) {
2525 ret
= k400_allocate(hdev
);
2530 INIT_WORK(&hidpp
->work
, delayed_work_cb
);
2531 mutex_init(&hidpp
->send_mutex
);
2532 init_waitqueue_head(&hidpp
->wait
);
2534 ret
= hid_parse(hdev
);
2536 hid_err(hdev
, "%s:parse failed\n", __func__
);
2537 goto hid_parse_fail
;
2540 if (hidpp
->quirks
& HIDPP_QUIRK_NO_HIDINPUT
)
2541 connect_mask
&= ~HID_CONNECT_HIDINPUT
;
2543 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
) {
2544 ret
= hid_hw_start(hdev
, connect_mask
);
2546 hid_err(hdev
, "hw start failed\n");
2547 goto hid_hw_start_fail
;
2549 ret
= hid_hw_open(hdev
);
2551 dev_err(&hdev
->dev
, "%s:hid_hw_open returned error:%d\n",
2554 goto hid_hw_start_fail
;
2559 /* Allow incoming packets */
2560 hid_device_io_start(hdev
);
2562 if (hidpp
->quirks
& HIDPP_QUIRK_UNIFYING
)
2563 hidpp_unifying_init(hidpp
);
2565 connected
= hidpp_is_connected(hidpp
);
2566 atomic_set(&hidpp
->connected
, connected
);
2567 if (!(hidpp
->quirks
& HIDPP_QUIRK_UNIFYING
)) {
2570 hid_err(hdev
, "Device not connected");
2571 goto hid_hw_open_failed
;
2574 hid_info(hdev
, "HID++ %u.%u device connected.\n",
2575 hidpp
->protocol_major
, hidpp
->protocol_minor
);
2577 hidpp_overwrite_name(hdev
);
2580 if (connected
&& (hidpp
->quirks
& HIDPP_QUIRK_CLASS_WTP
)) {
2581 ret
= wtp_get_config(hidpp
);
2583 goto hid_hw_open_failed
;
2584 } else if (connected
&& (hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
)) {
2585 ret
= g920_get_config(hidpp
);
2587 goto hid_hw_open_failed
;
2590 /* Block incoming packets */
2591 hid_device_io_stop(hdev
);
2593 if (!(hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
)) {
2594 ret
= hid_hw_start(hdev
, connect_mask
);
2596 hid_err(hdev
, "%s:hid_hw_start returned error\n", __func__
);
2597 goto hid_hw_start_fail
;
2601 /* Allow incoming packets */
2602 hid_device_io_start(hdev
);
2604 hidpp_connect_event(hidpp
);
2609 hid_device_io_stop(hdev
);
2610 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
) {
2616 cancel_work_sync(&hidpp
->work
);
2617 mutex_destroy(&hidpp
->send_mutex
);
2619 hid_set_drvdata(hdev
, NULL
);
2623 static void hidpp_remove(struct hid_device
*hdev
)
2625 struct hidpp_device
*hidpp
= hid_get_drvdata(hdev
);
2627 if (hidpp
->quirks
& HIDPP_QUIRK_CLASS_G920
) {
2628 hidpp_ff_deinit(hdev
);
2632 cancel_work_sync(&hidpp
->work
);
2633 mutex_destroy(&hidpp
->send_mutex
);
2636 static const struct hid_device_id hidpp_devices
[] = {
2637 { /* wireless touchpad */
2638 HID_DEVICE(BUS_USB
, HID_GROUP_LOGITECH_DJ_DEVICE
,
2639 USB_VENDOR_ID_LOGITECH
, 0x4011),
2640 .driver_data
= HIDPP_QUIRK_CLASS_WTP
| HIDPP_QUIRK_DELAYED_INIT
|
2641 HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS
},
2642 { /* wireless touchpad T650 */
2643 HID_DEVICE(BUS_USB
, HID_GROUP_LOGITECH_DJ_DEVICE
,
2644 USB_VENDOR_ID_LOGITECH
, 0x4101),
2645 .driver_data
= HIDPP_QUIRK_CLASS_WTP
| HIDPP_QUIRK_DELAYED_INIT
},
2646 { /* wireless touchpad T651 */
2647 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH
,
2648 USB_DEVICE_ID_LOGITECH_T651
),
2649 .driver_data
= HIDPP_QUIRK_CLASS_WTP
},
2650 { /* Mouse logitech M560 */
2651 HID_DEVICE(BUS_USB
, HID_GROUP_LOGITECH_DJ_DEVICE
,
2652 USB_VENDOR_ID_LOGITECH
, 0x402d),
2653 .driver_data
= HIDPP_QUIRK_DELAYED_INIT
| HIDPP_QUIRK_CLASS_M560
},
2654 { /* Keyboard logitech K400 */
2655 HID_DEVICE(BUS_USB
, HID_GROUP_LOGITECH_DJ_DEVICE
,
2656 USB_VENDOR_ID_LOGITECH
, 0x4024),
2657 .driver_data
= HIDPP_QUIRK_CLASS_K400
},
2659 { HID_DEVICE(BUS_USB
, HID_GROUP_LOGITECH_DJ_DEVICE
,
2660 USB_VENDOR_ID_LOGITECH
, HID_ANY_ID
)},
2662 { HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH
, USB_DEVICE_ID_LOGITECH_G920_WHEEL
),
2663 .driver_data
= HIDPP_QUIRK_CLASS_G920
| HIDPP_QUIRK_FORCE_OUTPUT_REPORTS
},
2667 MODULE_DEVICE_TABLE(hid
, hidpp_devices
);
2669 static struct hid_driver hidpp_driver
= {
2670 .name
= "logitech-hidpp-device",
2671 .id_table
= hidpp_devices
,
2672 .probe
= hidpp_probe
,
2673 .remove
= hidpp_remove
,
2674 .raw_event
= hidpp_raw_event
,
2675 .input_configured
= hidpp_input_configured
,
2676 .input_mapping
= hidpp_input_mapping
,
2677 .input_mapped
= hidpp_input_mapped
,
2680 module_hid_driver(hidpp_driver
);