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