projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'xarray-5.2-rc6' of git://git.infradead.org/users/willy/linux-dax
[linux-block.git] / drivers / hid / hid-logitech-dj.c
CommitLineData
45051539 1// SPDX-License-Identifier: GPL-2.0-only
534a7b8e
NLC		 2/*
3 * HID driver for Logitech Unifying receivers
4 *
5 * Copyright (c) 2011 Logitech
6 */
7
534a7b8e
NLC		 8
9
10#include <linux/device.h>
11#include <linux/hid.h>
12#include <linux/module.h>
8cb3746a 13#include <linux/kfifo.h>
82c0beb8 14#include <linux/delay.h>
da12b224 15#include <linux/usb.h> /* For to_usb_interface for kvm extra intf check */
44d27f7d 16#include <asm/unaligned.h>
534a7b8e 17#include "hid-ids.h"
8cb3746a
BT		 18
19#define DJ_MAX_PAIRED_DEVICES 6
4fcad95a 20#define DJ_MAX_NUMBER_NOTIFS 8
8cb3746a
BT		 21#define DJ_RECEIVER_INDEX 0
22#define DJ_DEVICE_INDEX_MIN 1
23#define DJ_DEVICE_INDEX_MAX 6
24
25#define DJREPORT_SHORT_LENGTH 15
26#define DJREPORT_LONG_LENGTH 32
27
28#define REPORT_ID_DJ_SHORT 0x20
29#define REPORT_ID_DJ_LONG 0x21
30
925f0f3e
BT		 31#define REPORT_ID_HIDPP_SHORT 0x10
32#define REPORT_ID_HIDPP_LONG 0x11
3a9a2c86 33#define REPORT_ID_HIDPP_VERY_LONG 0x12
925f0f3e
BT		 34
35#define HIDPP_REPORT_SHORT_LENGTH 7
36#define HIDPP_REPORT_LONG_LENGTH 20
37
38#define HIDPP_RECEIVER_INDEX 0xff
39
40#define REPORT_TYPE_RFREPORT_FIRST 0x01
8cb3746a
BT		 41#define REPORT_TYPE_RFREPORT_LAST 0x1F
42
43/* Command Switch to DJ mode */
44#define REPORT_TYPE_CMD_SWITCH 0x80
45#define CMD_SWITCH_PARAM_DEVBITFIELD 0x00
46#define CMD_SWITCH_PARAM_TIMEOUT_SECONDS 0x01
47#define TIMEOUT_NO_KEEPALIVE 0x00
48
49/* Command to Get the list of Paired devices */
50#define REPORT_TYPE_CMD_GET_PAIRED_DEVICES 0x81
51
52/* Device Paired Notification */
53#define REPORT_TYPE_NOTIF_DEVICE_PAIRED 0x41
54#define SPFUNCTION_MORE_NOTIF_EXPECTED 0x01
55#define SPFUNCTION_DEVICE_LIST_EMPTY 0x02
56#define DEVICE_PAIRED_PARAM_SPFUNCTION 0x00
57#define DEVICE_PAIRED_PARAM_EQUAD_ID_LSB 0x01
58#define DEVICE_PAIRED_PARAM_EQUAD_ID_MSB 0x02
59#define DEVICE_PAIRED_RF_REPORT_TYPE 0x03
60
61/* Device Un-Paired Notification */
62#define REPORT_TYPE_NOTIF_DEVICE_UNPAIRED 0x40
63
8cb3746a
BT		 64/* Connection Status Notification */
65#define REPORT_TYPE_NOTIF_CONNECTION_STATUS 0x42
66#define CONNECTION_STATUS_PARAM_STATUS 0x00
67#define STATUS_LINKLOSS 0x01
68
69/* Error Notification */
70#define REPORT_TYPE_NOTIF_ERROR 0x7F
71#define NOTIF_ERROR_PARAM_ETYPE 0x00
72#define ETYPE_KEEPALIVE_TIMEOUT 0x01
73
74/* supported DJ HID && RF report types */
75#define REPORT_TYPE_KEYBOARD 0x01
76#define REPORT_TYPE_MOUSE 0x02
77#define REPORT_TYPE_CONSUMER_CONTROL 0x03
78#define REPORT_TYPE_SYSTEM_CONTROL 0x04
79#define REPORT_TYPE_MEDIA_CENTER 0x08
80#define REPORT_TYPE_LEDS 0x0E
81
82/* RF Report types bitfield */
a17dd1f2
BT		 83#define STD_KEYBOARD BIT(1)
84#define STD_MOUSE BIT(2)
85#define MULTIMEDIA BIT(3)
86#define POWER_KEYS BIT(4)
87#define MEDIA_CENTER BIT(8)
88#define KBD_LEDS BIT(14)
6d3c3f03
HG		 89/* Fake (bitnr > NUMBER_OF_HID_REPORTS) bit to track HID++ capability */
90#define HIDPP BIT_ULL(63)
8cb3746a 91
74808f91
HG		 92/* HID++ Device Connected Notification */
93#define REPORT_TYPE_NOTIF_DEVICE_CONNECTED 0x41
94#define HIDPP_PARAM_PROTO_TYPE 0x00
95#define HIDPP_PARAM_DEVICE_INFO 0x01
96#define HIDPP_PARAM_EQUAD_LSB 0x02
97#define HIDPP_PARAM_EQUAD_MSB 0x03
c9121cf6 98#define HIDPP_PARAM_27MHZ_DEVID 0x03
74808f91
HG		 99#define HIDPP_DEVICE_TYPE_MASK GENMASK(3, 0)
100#define HIDPP_LINK_STATUS_MASK BIT(6)
f2113c30 101#define HIDPP_MANUFACTURER_MASK BIT(7)
74808f91 102
de76b1d3
HG		 103#define HIDPP_DEVICE_TYPE_KEYBOARD 1
104#define HIDPP_DEVICE_TYPE_MOUSE 2
105
74808f91 106#define HIDPP_SET_REGISTER 0x80
c0340412 107#define HIDPP_GET_LONG_REGISTER 0x83
74808f91 108#define HIDPP_REG_CONNECTION_STATE 0x02
c0340412
BT		 109#define HIDPP_REG_PAIRING_INFORMATION 0xB5
110#define HIDPP_PAIRING_INFORMATION 0x20
74808f91
HG		 111#define HIDPP_FAKE_DEVICE_ARRIVAL 0x02
112
113enum recvr_type {
114 recvr_type_dj,
115 recvr_type_hidpp,
f5fb57a7 116 recvr_type_gaming_hidpp,
3ed224e2 117 recvr_type_mouse_only,
c9121cf6 118 recvr_type_27mhz,
f2113c30 119 recvr_type_bluetooth,
74808f91 120};
c0340412 121
8cb3746a
BT		 122struct dj_report {
123 u8 report_id;
124 u8 device_index;
125 u8 report_type;
126 u8 report_params[DJREPORT_SHORT_LENGTH - 3];
127};
128
7bb56a5f
BT		 129struct hidpp_event {
130 u8 report_id;
131 u8 device_index;
132 u8 sub_id;
133 u8 params[HIDPP_REPORT_LONG_LENGTH - 3U];
134} __packed;
135
8cb3746a 136struct dj_receiver_dev {
a1d97ccb
HG		 137 struct hid_device *mouse;
138 struct hid_device *keyboard;
0ee75544 139 struct hid_device *hidpp;
8cb3746a
BT		 140 struct dj_device *paired_dj_devices[DJ_MAX_PAIRED_DEVICES +
141 DJ_DEVICE_INDEX_MIN];
a1d97ccb
HG		 142 struct list_head list;
143 struct kref kref;
8cb3746a
BT		 144 struct work_struct work;
145 struct kfifo notif_fifo;
b6aeedde 146 unsigned long last_query; /* in jiffies */
a1d97ccb 147 bool ready;
74808f91
HG		 148 enum recvr_type type;
149 unsigned int unnumbered_application;
8cb3746a 150 spinlock_t lock;
8cb3746a
BT		 151};
152
153struct dj_device {
154 struct hid_device *hdev;
155 struct dj_receiver_dev *dj_receiver_dev;
6d3c3f03 156 u64 reports_supported;
8cb3746a
BT		 157 u8 device_index;
158};
534a7b8e 159
4fcad95a
BT		 160#define WORKITEM_TYPE_EMPTY 0
161#define WORKITEM_TYPE_PAIRED 1
162#define WORKITEM_TYPE_UNPAIRED 2
163#define WORKITEM_TYPE_UNKNOWN 255
164
165struct dj_workitem {
166 u8 type; /* WORKITEM_TYPE_* */
167 u8 device_index;
de76b1d3 168 u8 device_type;
4fcad95a
BT		 169 u8 quad_id_msb;
170 u8 quad_id_lsb;
6d3c3f03 171 u64 reports_supported;
4fcad95a
BT		 172};
173
534a7b8e
NLC		 174/* Keyboard descriptor (1) */
175static const char kbd_descriptor[] = {
176 0x05, 0x01, /* USAGE_PAGE (generic Desktop) */
177 0x09, 0x06, /* USAGE (Keyboard) */
178 0xA1, 0x01, /* COLLECTION (Application) */
179 0x85, 0x01, /* REPORT_ID (1) */
180 0x95, 0x08, /* REPORT_COUNT (8) */
181 0x75, 0x01, /* REPORT_SIZE (1) */
182 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
183 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
184 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
185 0x19, 0xE0, /* USAGE_MINIMUM (Left Control) */
186 0x29, 0xE7, /* USAGE_MAXIMUM (Right GUI) */
187 0x81, 0x02, /* INPUT (Data,Var,Abs) */
534a7b8e
NLC		 188 0x95, 0x06, /* REPORT_COUNT (6) */
189 0x75, 0x08, /* REPORT_SIZE (8) */
190 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
191 0x26, 0xFF, 0x00, /* LOGICAL_MAXIMUM (255) */
192 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
193 0x19, 0x00, /* USAGE_MINIMUM (no event) */
194 0x2A, 0xFF, 0x00, /* USAGE_MAXIMUM (reserved) */
195 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
0e40d356
BT		 196 0x85, 0x0e, /* REPORT_ID (14) */
197 0x05, 0x08, /* USAGE PAGE (LED page) */
198 0x95, 0x05, /* REPORT COUNT (5) */
199 0x75, 0x01, /* REPORT SIZE (1) */
200 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
201 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
202 0x19, 0x01, /* USAGE MINIMUM (1) */
203 0x29, 0x05, /* USAGE MAXIMUM (5) */
204 0x91, 0x02, /* OUTPUT (Data, Variable, Absolute) */
205 0x95, 0x01, /* REPORT COUNT (1) */
206 0x75, 0x03, /* REPORT SIZE (3) */
207 0x91, 0x01, /* OUTPUT (Constant) */
534a7b8e
NLC		 208 0xC0
209};
210
211/* Mouse descriptor (2) */
212static const char mse_descriptor[] = {
213 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
214 0x09, 0x02, /* USAGE (Mouse) */
215 0xA1, 0x01, /* COLLECTION (Application) */
216 0x85, 0x02, /* REPORT_ID = 2 */
217 0x09, 0x01, /* USAGE (pointer) */
218 0xA1, 0x00, /* COLLECTION (physical) */
219 0x05, 0x09, /* USAGE_PAGE (buttons) */
220 0x19, 0x01, /* USAGE_MIN (1) */
221 0x29, 0x10, /* USAGE_MAX (16) */
222 0x15, 0x00, /* LOGICAL_MIN (0) */
223 0x25, 0x01, /* LOGICAL_MAX (1) */
224 0x95, 0x10, /* REPORT_COUNT (16) */
225 0x75, 0x01, /* REPORT_SIZE (1) */
226 0x81, 0x02, /* INPUT (data var abs) */
227 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
228 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */
229 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */
230 0x75, 0x0C, /* REPORT_SIZE (12) */
231 0x95, 0x02, /* REPORT_COUNT (2) */
232 0x09, 0x30, /* USAGE (X) */
233 0x09, 0x31, /* USAGE (Y) */
234 0x81, 0x06, /* INPUT */
235 0x15, 0x81, /* LOGICAL_MIN (-127) */
236 0x25, 0x7F, /* LOGICAL_MAX (127) */
237 0x75, 0x08, /* REPORT_SIZE (8) */
238 0x95, 0x01, /* REPORT_COUNT (1) */
239 0x09, 0x38, /* USAGE (wheel) */
240 0x81, 0x06, /* INPUT */
241 0x05, 0x0C, /* USAGE_PAGE(consumer) */
242 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
243 0x95, 0x01, /* REPORT_COUNT (1) */
244 0x81, 0x06, /* INPUT */
245 0xC0, /* END_COLLECTION */
246 0xC0, /* END_COLLECTION */
247};
248
c9121cf6
HG		 249/* Mouse descriptor (2) for 27 MHz receiver, only 8 buttons */
250static const char mse_27mhz_descriptor[] = {
251 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
252 0x09, 0x02, /* USAGE (Mouse) */
253 0xA1, 0x01, /* COLLECTION (Application) */
254 0x85, 0x02, /* REPORT_ID = 2 */
255 0x09, 0x01, /* USAGE (pointer) */
256 0xA1, 0x00, /* COLLECTION (physical) */
257 0x05, 0x09, /* USAGE_PAGE (buttons) */
258 0x19, 0x01, /* USAGE_MIN (1) */
259 0x29, 0x08, /* USAGE_MAX (8) */
260 0x15, 0x00, /* LOGICAL_MIN (0) */
261 0x25, 0x01, /* LOGICAL_MAX (1) */
262 0x95, 0x08, /* REPORT_COUNT (8) */
263 0x75, 0x01, /* REPORT_SIZE (1) */
264 0x81, 0x02, /* INPUT (data var abs) */
265 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
266 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */
267 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */
268 0x75, 0x0C, /* REPORT_SIZE (12) */
269 0x95, 0x02, /* REPORT_COUNT (2) */
270 0x09, 0x30, /* USAGE (X) */
271 0x09, 0x31, /* USAGE (Y) */
272 0x81, 0x06, /* INPUT */
273 0x15, 0x81, /* LOGICAL_MIN (-127) */
274 0x25, 0x7F, /* LOGICAL_MAX (127) */
275 0x75, 0x08, /* REPORT_SIZE (8) */
276 0x95, 0x01, /* REPORT_COUNT (1) */
277 0x09, 0x38, /* USAGE (wheel) */
278 0x81, 0x06, /* INPUT */
279 0x05, 0x0C, /* USAGE_PAGE(consumer) */
280 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
281 0x95, 0x01, /* REPORT_COUNT (1) */
282 0x81, 0x06, /* INPUT */
283 0xC0, /* END_COLLECTION */
284 0xC0, /* END_COLLECTION */
285};
286
f2113c30
HG		 287/* Mouse descriptor (2) for Bluetooth receiver, low-res hwheel, 12 buttons */
288static const char mse_bluetooth_descriptor[] = {
289 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
290 0x09, 0x02, /* USAGE (Mouse) */
291 0xA1, 0x01, /* COLLECTION (Application) */
292 0x85, 0x02, /* REPORT_ID = 2 */
293 0x09, 0x01, /* USAGE (pointer) */
294 0xA1, 0x00, /* COLLECTION (physical) */
295 0x05, 0x09, /* USAGE_PAGE (buttons) */
296 0x19, 0x01, /* USAGE_MIN (1) */
297 0x29, 0x08, /* USAGE_MAX (8) */
298 0x15, 0x00, /* LOGICAL_MIN (0) */
299 0x25, 0x01, /* LOGICAL_MAX (1) */
300 0x95, 0x08, /* REPORT_COUNT (8) */
301 0x75, 0x01, /* REPORT_SIZE (1) */
302 0x81, 0x02, /* INPUT (data var abs) */
303 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
304 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */
305 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */
306 0x75, 0x0C, /* REPORT_SIZE (12) */
307 0x95, 0x02, /* REPORT_COUNT (2) */
308 0x09, 0x30, /* USAGE (X) */
309 0x09, 0x31, /* USAGE (Y) */
310 0x81, 0x06, /* INPUT */
311 0x15, 0x81, /* LOGICAL_MIN (-127) */
312 0x25, 0x7F, /* LOGICAL_MAX (127) */
313 0x75, 0x08, /* REPORT_SIZE (8) */
314 0x95, 0x01, /* REPORT_COUNT (1) */
315 0x09, 0x38, /* USAGE (wheel) */
316 0x81, 0x06, /* INPUT */
317 0x05, 0x0C, /* USAGE_PAGE(consumer) */
318 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
319 0x15, 0xF9, /* LOGICAL_MIN (-7) */
320 0x25, 0x07, /* LOGICAL_MAX (7) */
321 0x75, 0x04, /* REPORT_SIZE (4) */
322 0x95, 0x01, /* REPORT_COUNT (1) */
323 0x81, 0x06, /* INPUT */
324 0x05, 0x09, /* USAGE_PAGE (buttons) */
325 0x19, 0x09, /* USAGE_MIN (9) */
326 0x29, 0x0C, /* USAGE_MAX (12) */
327 0x15, 0x00, /* LOGICAL_MIN (0) */
328 0x25, 0x01, /* LOGICAL_MAX (1) */
329 0x75, 0x01, /* REPORT_SIZE (1) */
330 0x95, 0x04, /* REPORT_COUNT (4) */
331 0x81, 0x06, /* INPUT */
332 0xC0, /* END_COLLECTION */
333 0xC0, /* END_COLLECTION */
334};
335
f5fb57a7
BT		 336/* Gaming Mouse descriptor (2) */
337static const char mse_high_res_descriptor[] = {
338 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
339 0x09, 0x02, /* USAGE (Mouse) */
340 0xA1, 0x01, /* COLLECTION (Application) */
341 0x85, 0x02, /* REPORT_ID = 2 */
342 0x09, 0x01, /* USAGE (pointer) */
343 0xA1, 0x00, /* COLLECTION (physical) */
344 0x05, 0x09, /* USAGE_PAGE (buttons) */
345 0x19, 0x01, /* USAGE_MIN (1) */
346 0x29, 0x10, /* USAGE_MAX (16) */
347 0x15, 0x00, /* LOGICAL_MIN (0) */
348 0x25, 0x01, /* LOGICAL_MAX (1) */
349 0x95, 0x10, /* REPORT_COUNT (16) */
350 0x75, 0x01, /* REPORT_SIZE (1) */
351 0x81, 0x02, /* INPUT (data var abs) */
352 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
353 0x16, 0x01, 0x80, /* LOGICAL_MIN (-32767) */
354 0x26, 0xFF, 0x7F, /* LOGICAL_MAX (32767) */
355 0x75, 0x10, /* REPORT_SIZE (16) */
356 0x95, 0x02, /* REPORT_COUNT (2) */
357 0x09, 0x30, /* USAGE (X) */
358 0x09, 0x31, /* USAGE (Y) */
359 0x81, 0x06, /* INPUT */
360 0x15, 0x81, /* LOGICAL_MIN (-127) */
361 0x25, 0x7F, /* LOGICAL_MAX (127) */
362 0x75, 0x08, /* REPORT_SIZE (8) */
363 0x95, 0x01, /* REPORT_COUNT (1) */
364 0x09, 0x38, /* USAGE (wheel) */
365 0x81, 0x06, /* INPUT */
366 0x05, 0x0C, /* USAGE_PAGE(consumer) */
367 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
368 0x95, 0x01, /* REPORT_COUNT (1) */
369 0x81, 0x06, /* INPUT */
370 0xC0, /* END_COLLECTION */
371 0xC0, /* END_COLLECTION */
372};
373
534a7b8e
NLC		 374/* Consumer Control descriptor (3) */
375static const char consumer_descriptor[] = {
376 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */
377 0x09, 0x01, /* USAGE (Consumer Control) */
378 0xA1, 0x01, /* COLLECTION (Application) */
379 0x85, 0x03, /* REPORT_ID = 3 */
380 0x75, 0x10, /* REPORT_SIZE (16) */
381 0x95, 0x02, /* REPORT_COUNT (2) */
382 0x15, 0x01, /* LOGICAL_MIN (1) */
383 0x26, 0x8C, 0x02, /* LOGICAL_MAX (652) */
384 0x19, 0x01, /* USAGE_MIN (1) */
385 0x2A, 0x8C, 0x02, /* USAGE_MAX (652) */
386 0x81, 0x00, /* INPUT (Data Ary Abs) */
387 0xC0, /* END_COLLECTION */
388}; /* */
389
390/* System control descriptor (4) */
391static const char syscontrol_descriptor[] = {
392 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
393 0x09, 0x80, /* USAGE (System Control) */
394 0xA1, 0x01, /* COLLECTION (Application) */
395 0x85, 0x04, /* REPORT_ID = 4 */
396 0x75, 0x02, /* REPORT_SIZE (2) */
397 0x95, 0x01, /* REPORT_COUNT (1) */
398 0x15, 0x01, /* LOGICAL_MIN (1) */
399 0x25, 0x03, /* LOGICAL_MAX (3) */
400 0x09, 0x82, /* USAGE (System Sleep) */
401 0x09, 0x81, /* USAGE (System Power Down) */
402 0x09, 0x83, /* USAGE (System Wake Up) */
403 0x81, 0x60, /* INPUT (Data Ary Abs NPrf Null) */
404 0x75, 0x06, /* REPORT_SIZE (6) */
405 0x81, 0x03, /* INPUT (Cnst Var Abs) */
406 0xC0, /* END_COLLECTION */
407};
408
409/* Media descriptor (8) */
410static const char media_descriptor[] = {
411 0x06, 0xbc, 0xff, /* Usage Page 0xffbc */
412 0x09, 0x88, /* Usage 0x0088 */
413 0xa1, 0x01, /* BeginCollection */
414 0x85, 0x08, /* Report ID 8 */
415 0x19, 0x01, /* Usage Min 0x0001 */
416 0x29, 0xff, /* Usage Max 0x00ff */
417 0x15, 0x01, /* Logical Min 1 */
418 0x26, 0xff, 0x00, /* Logical Max 255 */
419 0x75, 0x08, /* Report Size 8 */
420 0x95, 0x01, /* Report Count 1 */
421 0x81, 0x00, /* Input */
422 0xc0, /* EndCollection */
423}; /* */
424
925f0f3e
BT		 425/* HIDPP descriptor */
426static const char hidpp_descriptor[] = {
427 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */
428 0x09, 0x01, /* Usage (Vendor Usage 1) */
429 0xa1, 0x01, /* Collection (Application) */
430 0x85, 0x10, /* Report ID (16) */
431 0x75, 0x08, /* Report Size (8) */
432 0x95, 0x06, /* Report Count (6) */
433 0x15, 0x00, /* Logical Minimum (0) */
434 0x26, 0xff, 0x00, /* Logical Maximum (255) */
435 0x09, 0x01, /* Usage (Vendor Usage 1) */
436 0x81, 0x00, /* Input (Data,Arr,Abs) */
437 0x09, 0x01, /* Usage (Vendor Usage 1) */
438 0x91, 0x00, /* Output (Data,Arr,Abs) */
439 0xc0, /* End Collection */
440 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */
441 0x09, 0x02, /* Usage (Vendor Usage 2) */
442 0xa1, 0x01, /* Collection (Application) */
443 0x85, 0x11, /* Report ID (17) */
444 0x75, 0x08, /* Report Size (8) */
445 0x95, 0x13, /* Report Count (19) */
446 0x15, 0x00, /* Logical Minimum (0) */
447 0x26, 0xff, 0x00, /* Logical Maximum (255) */
448 0x09, 0x02, /* Usage (Vendor Usage 2) */
449 0x81, 0x00, /* Input (Data,Arr,Abs) */
450 0x09, 0x02, /* Usage (Vendor Usage 2) */
451 0x91, 0x00, /* Output (Data,Arr,Abs) */
452 0xc0, /* End Collection */
453 0x06, 0x00, 0xff, /* Usage Page (Vendor Defined Page 1) */
454 0x09, 0x04, /* Usage (Vendor Usage 0x04) */
455 0xa1, 0x01, /* Collection (Application) */
456 0x85, 0x20, /* Report ID (32) */
457 0x75, 0x08, /* Report Size (8) */
458 0x95, 0x0e, /* Report Count (14) */
459 0x15, 0x00, /* Logical Minimum (0) */
460 0x26, 0xff, 0x00, /* Logical Maximum (255) */
461 0x09, 0x41, /* Usage (Vendor Usage 0x41) */
462 0x81, 0x00, /* Input (Data,Arr,Abs) */
463 0x09, 0x41, /* Usage (Vendor Usage 0x41) */
464 0x91, 0x00, /* Output (Data,Arr,Abs) */
465 0x85, 0x21, /* Report ID (33) */
466 0x95, 0x1f, /* Report Count (31) */
467 0x15, 0x00, /* Logical Minimum (0) */
468 0x26, 0xff, 0x00, /* Logical Maximum (255) */
469 0x09, 0x42, /* Usage (Vendor Usage 0x42) */
470 0x81, 0x00, /* Input (Data,Arr,Abs) */
471 0x09, 0x42, /* Usage (Vendor Usage 0x42) */
472 0x91, 0x00, /* Output (Data,Arr,Abs) */
473 0xc0, /* End Collection */
474};
475
534a7b8e
NLC		 476/* Maximum size of all defined hid reports in bytes (including report id) */
477#define MAX_REPORT_SIZE 8
478
2a039bf5
HR		 479/* Make sure all descriptors are present here */
480#define MAX_RDESC_SIZE \
481 (sizeof(kbd_descriptor) + \
f2113c30 482 sizeof(mse_bluetooth_descriptor) + \
2a039bf5
HR		 483 sizeof(consumer_descriptor) + \
484 sizeof(syscontrol_descriptor) + \
925f0f3e
BT		 485 sizeof(media_descriptor) + \
486 sizeof(hidpp_descriptor))
2a039bf5 487
534a7b8e
NLC		 488/* Number of possible hid report types that can be created by this driver.
489 *
490 * Right now, RF report types have the same report types (or report id's)
491 * than the hid report created from those RF reports. In the future
492 * this doesnt have to be true.
493 *
494 * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds
495 * to hid report id 0x01, this is standard keyboard. Same thing applies to mice
496 * reports and consumer control, etc. If a new RF report is created, it doesn't
497 * has to have the same report id as its corresponding hid report, so an
498 * translation may have to take place for future report types.
499 */
500#define NUMBER_OF_HID_REPORTS 32
501static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = {
502 [1] = 8, /* Standard keyboard */
503 [2] = 8, /* Standard mouse */
504 [3] = 5, /* Consumer control */
505 [4] = 2, /* System control */
506 [8] = 2, /* Media Center */
507};
508
509
510#define LOGITECH_DJ_INTERFACE_NUMBER 0x02
511
534a7b8e
NLC		 512static struct hid_ll_driver logi_dj_ll_driver;
513
c63e0e37 514static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev);
a1d97ccb
HG		 515static void delayedwork_callback(struct work_struct *work);
516
517static LIST_HEAD(dj_hdev_list);
518static DEFINE_MUTEX(dj_hdev_list_lock);
519
520/*
521 * dj/HID++ receivers are really a single logical entity, but for BIOS/Windows
522 * compatibility they have multiple USB interfaces. On HID++ receivers we need
523 * to listen for input reports on both interfaces. The functions below are used
524 * to create a single struct dj_receiver_dev for all interfaces belonging to
525 * a single USB-device / receiver.
526 */
f2113c30
HG		 527static struct dj_receiver_dev *dj_find_receiver_dev(struct hid_device *hdev,
528 enum recvr_type type)
a1d97ccb
HG		 529{
530 struct dj_receiver_dev *djrcv_dev;
f2113c30
HG		 531 char sep;
532
533 /*
534 * The bluetooth receiver contains a built-in hub and has separate
535 * USB-devices for the keyboard and mouse interfaces.
536 */
537 sep = (type == recvr_type_bluetooth) ? '.' : '/';
a1d97ccb
HG		 538
539 /* Try to find an already-probed interface from the same device */
540 list_for_each_entry(djrcv_dev, &dj_hdev_list, list) {
541 if (djrcv_dev->mouse &&
f2113c30 542 hid_compare_device_paths(hdev, djrcv_dev->mouse, sep)) {
a1d97ccb
HG		 543 kref_get(&djrcv_dev->kref);
544 return djrcv_dev;
545 }
546 if (djrcv_dev->keyboard &&
f2113c30 547 hid_compare_device_paths(hdev, djrcv_dev->keyboard, sep)) {
a1d97ccb
HG		 548 kref_get(&djrcv_dev->kref);
549 return djrcv_dev;
550 }
551 if (djrcv_dev->hidpp &&
f2113c30 552 hid_compare_device_paths(hdev, djrcv_dev->hidpp, sep)) {
a1d97ccb
HG		 553 kref_get(&djrcv_dev->kref);
554 return djrcv_dev;
555 }
556 }
557
558 return NULL;
559}
560
561static void dj_release_receiver_dev(struct kref *kref)
562{
563 struct dj_receiver_dev *djrcv_dev = container_of(kref, struct dj_receiver_dev, kref);
564
565 list_del(&djrcv_dev->list);
566 kfifo_free(&djrcv_dev->notif_fifo);
567 kfree(djrcv_dev);
568}
569
570static void dj_put_receiver_dev(struct hid_device *hdev)
571{
572 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
573
574 mutex_lock(&dj_hdev_list_lock);
575
576 if (djrcv_dev->mouse == hdev)
577 djrcv_dev->mouse = NULL;
578 if (djrcv_dev->keyboard == hdev)
579 djrcv_dev->keyboard = NULL;
580 if (djrcv_dev->hidpp == hdev)
581 djrcv_dev->hidpp = NULL;
582
583 kref_put(&djrcv_dev->kref, dj_release_receiver_dev);
584
585 mutex_unlock(&dj_hdev_list_lock);
586}
587
588static struct dj_receiver_dev *dj_get_receiver_dev(struct hid_device *hdev,
74808f91 589 enum recvr_type type,
a1d97ccb
HG		 590 unsigned int application,
591 bool is_hidpp)
592{
593 struct dj_receiver_dev *djrcv_dev;
594
595 mutex_lock(&dj_hdev_list_lock);
596
f2113c30 597 djrcv_dev = dj_find_receiver_dev(hdev, type);
a1d97ccb
HG		 598 if (!djrcv_dev) {
599 djrcv_dev = kzalloc(sizeof(*djrcv_dev), GFP_KERNEL);
600 if (!djrcv_dev)
601 goto out;
602
603 INIT_WORK(&djrcv_dev->work, delayedwork_callback);
604 spin_lock_init(&djrcv_dev->lock);
605 if (kfifo_alloc(&djrcv_dev->notif_fifo,
606 DJ_MAX_NUMBER_NOTIFS * sizeof(struct dj_workitem),
607 GFP_KERNEL)) {
608 kfree(djrcv_dev);
609 djrcv_dev = NULL;
610 goto out;
611 }
612 kref_init(&djrcv_dev->kref);
613 list_add_tail(&djrcv_dev->list, &dj_hdev_list);
b6aeedde 614 djrcv_dev->last_query = jiffies;
74808f91 615 djrcv_dev->type = type;
a1d97ccb
HG		 616 }
617
618 if (application == HID_GD_KEYBOARD)
619 djrcv_dev->keyboard = hdev;
620 if (application == HID_GD_MOUSE)
621 djrcv_dev->mouse = hdev;
622 if (is_hidpp)
623 djrcv_dev->hidpp = hdev;
624
625 hid_set_drvdata(hdev, djrcv_dev);
626out:
627 mutex_unlock(&dj_hdev_list_lock);
628 return djrcv_dev;
629}
534a7b8e
NLC		 630
631static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
4fcad95a 632 struct dj_workitem *workitem)
534a7b8e
NLC		 633{
634 /* Called in delayed work context */
635 struct dj_device *dj_dev;
636 unsigned long flags;
637
638 spin_lock_irqsave(&djrcv_dev->lock, flags);
4fcad95a
BT		 639 dj_dev = djrcv_dev->paired_dj_devices[workitem->device_index];
640 djrcv_dev->paired_dj_devices[workitem->device_index] = NULL;
534a7b8e
NLC		 641 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
642
643 if (dj_dev != NULL) {
644 hid_destroy_device(dj_dev->hdev);
645 kfree(dj_dev);
646 } else {
0ee75544 647 hid_err(djrcv_dev->hidpp, "%s: can't destroy a NULL device\n",
534a7b8e
NLC		 648 __func__);
649 }
650}
651
652static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
4fcad95a 653 struct dj_workitem *workitem)
534a7b8e
NLC		 654{
655 /* Called in delayed work context */
0ee75544 656 struct hid_device *djrcv_hdev = djrcv_dev->hidpp;
534a7b8e
NLC		 657 struct hid_device *dj_hiddev;
658 struct dj_device *dj_dev;
4fcad95a 659 u8 device_index = workitem->device_index;
f41d766c 660 unsigned long flags;
534a7b8e
NLC		 661
662 /* Device index goes from 1 to 6, we need 3 bytes to store the
663 * semicolon, the index, and a null terminator
664 */
665 unsigned char tmpstr[3];
666
f41d766c 667 /* We are the only one ever adding a device, no need to lock */
4fcad95a 668 if (djrcv_dev->paired_dj_devices[device_index]) {
c63e0e37
NLC		 669 /* The device is already known. No need to reallocate it. */
670 dbg_hid("%s: device is already known\n", __func__);
671 return;
672 }
673
534a7b8e
NLC		 674 dj_hiddev = hid_allocate_device();
675 if (IS_ERR(dj_hiddev)) {
aca22a35 676 hid_err(djrcv_hdev, "%s: hid_allocate_dev failed\n", __func__);
534a7b8e
NLC		 677 return;
678 }
679
680 dj_hiddev->ll_driver = &logi_dj_ll_driver;
534a7b8e
NLC		 681
682 dj_hiddev->dev.parent = &djrcv_hdev->dev;
683 dj_hiddev->bus = BUS_USB;
82c0beb8 684 dj_hiddev->vendor = djrcv_hdev->vendor;
4fcad95a
BT		 685 dj_hiddev->product = (workitem->quad_id_msb << 8) |
686 workitem->quad_id_lsb;
de76b1d3
HG		 687 if (workitem->device_type) {
688 const char *type_str = "Device";
689
690 switch (workitem->device_type) {
691 case 0x01: type_str = "Keyboard"; break;
692 case 0x02: type_str = "Mouse"; break;
693 case 0x03: type_str = "Numpad"; break;
694 case 0x04: type_str = "Presenter"; break;
695 case 0x07: type_str = "Remote Control"; break;
696 case 0x08: type_str = "Trackball"; break;
697 case 0x09: type_str = "Touchpad"; break;
698 }
699 snprintf(dj_hiddev->name, sizeof(dj_hiddev->name),
700 "Logitech Wireless %s PID:%04x",
701 type_str, dj_hiddev->product);
702 } else {
703 snprintf(dj_hiddev->name, sizeof(dj_hiddev->name),
704 "Logitech Unifying Device. Wireless PID:%04x",
705 dj_hiddev->product);
706 }
d610274b 707
c9121cf6
HG		 708 if (djrcv_dev->type == recvr_type_27mhz)
709 dj_hiddev->group = HID_GROUP_LOGITECH_27MHZ_DEVICE;
710 else
711 dj_hiddev->group = HID_GROUP_LOGITECH_DJ_DEVICE;
534a7b8e 712
82c0beb8 713 memcpy(dj_hiddev->phys, djrcv_hdev->phys, sizeof(djrcv_hdev->phys));
4fcad95a 714 snprintf(tmpstr, sizeof(tmpstr), ":%d", device_index);
534a7b8e
NLC		 715 strlcat(dj_hiddev->phys, tmpstr, sizeof(dj_hiddev->phys));
716
717 dj_dev = kzalloc(sizeof(struct dj_device), GFP_KERNEL);
718
719 if (!dj_dev) {
aca22a35 720 hid_err(djrcv_hdev, "%s: failed allocating dj_dev\n", __func__);
534a7b8e
NLC		 721 goto dj_device_allocate_fail;
722 }
723
4fcad95a 724 dj_dev->reports_supported = workitem->reports_supported;
534a7b8e
NLC		 725 dj_dev->hdev = dj_hiddev;
726 dj_dev->dj_receiver_dev = djrcv_dev;
4fcad95a 727 dj_dev->device_index = device_index;
534a7b8e
NLC		 728 dj_hiddev->driver_data = dj_dev;
729
f41d766c 730 spin_lock_irqsave(&djrcv_dev->lock, flags);
4fcad95a 731 djrcv_dev->paired_dj_devices[device_index] = dj_dev;
f41d766c 732 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
534a7b8e
NLC		 733
734 if (hid_add_device(dj_hiddev)) {
aca22a35 735 hid_err(djrcv_hdev, "%s: failed adding dj_device\n", __func__);
534a7b8e
NLC		 736 goto hid_add_device_fail;
737 }
738
739 return;
740
741hid_add_device_fail:
f41d766c 742 spin_lock_irqsave(&djrcv_dev->lock, flags);
4fcad95a 743 djrcv_dev->paired_dj_devices[device_index] = NULL;
f41d766c 744 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
534a7b8e
NLC		 745 kfree(dj_dev);
746dj_device_allocate_fail:
747 hid_destroy_device(dj_hiddev);
748}
749
750static void delayedwork_callback(struct work_struct *work)
751{
752 struct dj_receiver_dev *djrcv_dev =
753 container_of(work, struct dj_receiver_dev, work);
754
4fcad95a 755 struct dj_workitem workitem;
534a7b8e
NLC		 756 unsigned long flags;
757 int count;
c63e0e37 758 int retval;
534a7b8e
NLC		 759
760 dbg_hid("%s\n", __func__);
761
762 spin_lock_irqsave(&djrcv_dev->lock, flags);
763
a1d97ccb
HG		 764 /*
765 * Since we attach to multiple interfaces, we may get scheduled before
766 * we are bound to the HID++ interface, catch this.
767 */
768 if (!djrcv_dev->ready) {
769 pr_warn("%s: delayedwork queued before hidpp interface was enumerated\n",
770 __func__);
771 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
772 return;
773 }
774
4fcad95a 775 count = kfifo_out(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem));
534a7b8e 776
4fcad95a 777 if (count != sizeof(workitem)) {
534a7b8e
NLC		 778 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
779 return;
780 }
781
e316aa6e
HG		 782 if (!kfifo_is_empty(&djrcv_dev->notif_fifo))
783 schedule_work(&djrcv_dev->work);
534a7b8e
NLC		 784
785 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
786
4fcad95a
BT		 787 switch (workitem.type) {
788 case WORKITEM_TYPE_PAIRED:
789 logi_dj_recv_add_djhid_device(djrcv_dev, &workitem);
534a7b8e 790 break;
4fcad95a
BT		 791 case WORKITEM_TYPE_UNPAIRED:
792 logi_dj_recv_destroy_djhid_device(djrcv_dev, &workitem);
793 break;
794 case WORKITEM_TYPE_UNKNOWN:
795 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
796 if (retval) {
0ee75544 797 hid_err(djrcv_dev->hidpp, "%s: logi_dj_recv_query_paired_devices error: %d\n",
4fcad95a
BT		 798 __func__, retval);
799 }
800 break;
801 case WORKITEM_TYPE_EMPTY:
802 dbg_hid("%s: device list is empty\n", __func__);
803 break;
804 }
805}
806
b6aeedde
HG		 807/*
808 * Sometimes we receive reports for which we do not have a paired dj_device
809 * associated with the device_index or report-type to forward the report to.
810 * This means that the original "device paired" notification corresponding
811 * to the dj_device never arrived to this driver. Possible reasons for this are:
812 * 1) hid-core discards all packets coming from a device during probe().
813 * 2) if the receiver is plugged into a KVM switch then the pairing reports
814 * are only forwarded to it if the focus is on this PC.
815 * This function deals with this by re-asking the receiver for the list of
816 * connected devices in the delayed work callback.
817 * This function MUST be called with djrcv->lock held.
818 */
819static void logi_dj_recv_queue_unknown_work(struct dj_receiver_dev *djrcv_dev)
820{
821 struct dj_workitem workitem = { .type = WORKITEM_TYPE_UNKNOWN };
822
823 /* Rate limit queries done because of unhandeled reports to 2/sec */
824 if (time_before(jiffies, djrcv_dev->last_query + HZ / 2))
825 return;
826
827 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem));
828 schedule_work(&djrcv_dev->work);
829}
830
4fcad95a
BT		 831static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev,
832 struct dj_report *dj_report)
833{
834 /* We are called from atomic context (tasklet && djrcv->lock held) */
835 struct dj_workitem workitem = {
836 .device_index = dj_report->device_index,
837 };
838
839 switch (dj_report->report_type) {
840 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
841 workitem.type = WORKITEM_TYPE_PAIRED;
842 if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] &
843 SPFUNCTION_DEVICE_LIST_EMPTY) {
844 workitem.type = WORKITEM_TYPE_EMPTY;
845 break;
846 }
847 /* fall-through */
534a7b8e 848 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
4fcad95a
BT		 849 workitem.quad_id_msb =
850 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB];
851 workitem.quad_id_lsb =
852 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB];
853 workitem.reports_supported = get_unaligned_le32(
854 dj_report->report_params +
855 DEVICE_PAIRED_RF_REPORT_TYPE);
6d3c3f03 856 workitem.reports_supported |= HIDPP;
4fcad95a
BT		 857 if (dj_report->report_type == REPORT_TYPE_NOTIF_DEVICE_UNPAIRED)
858 workitem.type = WORKITEM_TYPE_UNPAIRED;
534a7b8e
NLC		 859 break;
860 default:
b6aeedde
HG		 861 logi_dj_recv_queue_unknown_work(djrcv_dev);
862 return;
534a7b8e 863 }
534a7b8e 864
4fcad95a 865 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem));
e316aa6e 866 schedule_work(&djrcv_dev->work);
534a7b8e
NLC		 867}
868
3ed224e2
HG		 869static void logi_hidpp_dev_conn_notif_equad(struct hid_device *hdev,
870 struct hidpp_event *hidpp_report,
74808f91
HG		 871 struct dj_workitem *workitem)
872{
3ed224e2
HG		 873 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
874
74808f91 875 workitem->type = WORKITEM_TYPE_PAIRED;
de76b1d3
HG		 876 workitem->device_type = hidpp_report->params[HIDPP_PARAM_DEVICE_INFO] &
877 HIDPP_DEVICE_TYPE_MASK;
74808f91
HG		 878 workitem->quad_id_msb = hidpp_report->params[HIDPP_PARAM_EQUAD_MSB];
879 workitem->quad_id_lsb = hidpp_report->params[HIDPP_PARAM_EQUAD_LSB];
de76b1d3 880 switch (workitem->device_type) {
74808f91
HG		 881 case REPORT_TYPE_KEYBOARD:
882 workitem->reports_supported |= STD_KEYBOARD | MULTIMEDIA |
6d3c3f03
HG		 883 POWER_KEYS | MEDIA_CENTER |
884 HIDPP;
74808f91
HG		 885 break;
886 case REPORT_TYPE_MOUSE:
6d3c3f03 887 workitem->reports_supported |= STD_MOUSE | HIDPP;
3ed224e2
HG		 888 if (djrcv_dev->type == recvr_type_mouse_only)
889 workitem->reports_supported |= MULTIMEDIA;
74808f91
HG		 890 break;
891 }
892}
893
c9121cf6
HG		 894static void logi_hidpp_dev_conn_notif_27mhz(struct hid_device *hdev,
895 struct hidpp_event *hidpp_report,
896 struct dj_workitem *workitem)
897{
898 workitem->type = WORKITEM_TYPE_PAIRED;
899 workitem->quad_id_lsb = hidpp_report->params[HIDPP_PARAM_27MHZ_DEVID];
900 switch (hidpp_report->device_index) {
901 case 1: /* Index 1 is always a mouse */
902 case 2: /* Index 2 is always a mouse */
de76b1d3 903 workitem->device_type = HIDPP_DEVICE_TYPE_MOUSE;
6d3c3f03 904 workitem->reports_supported |= STD_MOUSE | HIDPP;
c9121cf6
HG		 905 break;
906 case 3: /* Index 3 is always the keyboard */
907 case 4: /* Index 4 is used for an optional separate numpad */
de76b1d3 908 workitem->device_type = HIDPP_DEVICE_TYPE_KEYBOARD;
c9121cf6 909 workitem->reports_supported |= STD_KEYBOARD | MULTIMEDIA |
6d3c3f03 910 POWER_KEYS | HIDPP;
c9121cf6
HG		 911 break;
912 default:
913 hid_warn(hdev, "%s: unexpected device-index %d", __func__,
914 hidpp_report->device_index);
915 }
916}
917
74808f91
HG		 918static void logi_hidpp_recv_queue_notif(struct hid_device *hdev,
919 struct hidpp_event *hidpp_report)
920{
921 /* We are called from atomic context (tasklet && djrcv->lock held) */
922 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
923 const char *device_type = "UNKNOWN";
924 struct dj_workitem workitem = {
925 .type = WORKITEM_TYPE_EMPTY,
926 .device_index = hidpp_report->device_index,
927 };
928
929 switch (hidpp_report->params[HIDPP_PARAM_PROTO_TYPE]) {
930 case 0x01:
931 device_type = "Bluetooth";
f2113c30 932 /* Bluetooth connect packet contents is the same as (e)QUAD */
3ed224e2 933 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
f2113c30
HG		 934 if (!(hidpp_report->params[HIDPP_PARAM_DEVICE_INFO] &
935 HIDPP_MANUFACTURER_MASK)) {
936 hid_info(hdev, "Non Logitech device connected on slot %d\n",
937 hidpp_report->device_index);
938 workitem.reports_supported &= ~HIDPP;
939 }
74808f91
HG		 940 break;
941 case 0x02:
942 device_type = "27 Mhz";
c9121cf6 943 logi_hidpp_dev_conn_notif_27mhz(hdev, hidpp_report, &workitem);
74808f91
HG		 944 break;
945 case 0x03:
946 device_type = "QUAD or eQUAD";
3ed224e2 947 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
74808f91
HG		 948 break;
949 case 0x04:
950 device_type = "eQUAD step 4 DJ";
3ed224e2 951 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
74808f91
HG		 952 break;
953 case 0x05:
954 device_type = "DFU Lite";
955 break;
956 case 0x06:
957 device_type = "eQUAD step 4 Lite";
3ed224e2 958 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
74808f91
HG		 959 break;
960 case 0x07:
961 device_type = "eQUAD step 4 Gaming";
962 break;
963 case 0x08:
964 device_type = "eQUAD step 4 for gamepads";
965 break;
966 case 0x0a:
967 device_type = "eQUAD nano Lite";
3ed224e2 968 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
74808f91
HG		 969 break;
970 case 0x0c:
971 device_type = "eQUAD Lightspeed";
3ed224e2 972 logi_hidpp_dev_conn_notif_equad(hdev, hidpp_report, &workitem);
f5fb57a7 973 workitem.reports_supported |= STD_KEYBOARD;
74808f91
HG		 974 break;
975 }
976
977 if (workitem.type == WORKITEM_TYPE_EMPTY) {
978 hid_warn(hdev,
979 "unusable device of type %s (0x%02x) connected on slot %d",
980 device_type,
981 hidpp_report->params[HIDPP_PARAM_PROTO_TYPE],
982 hidpp_report->device_index);
983 return;
984 }
985
986 hid_info(hdev, "device of type %s (0x%02x) connected on slot %d",
987 device_type, hidpp_report->params[HIDPP_PARAM_PROTO_TYPE],
988 hidpp_report->device_index);
989
74808f91 990 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem));
e316aa6e 991 schedule_work(&djrcv_dev->work);
74808f91
HG		 992}
993
534a7b8e
NLC		 994static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev,
995 struct dj_report *dj_report)
996{
997 /* We are called from atomic context (tasklet && djrcv->lock held) */
998 unsigned int i;
999 u8 reportbuffer[MAX_REPORT_SIZE];
1000 struct dj_device *djdev;
1001
1002 djdev = djrcv_dev->paired_dj_devices[dj_report->device_index];
1003
534a7b8e
NLC		 1004 memset(reportbuffer, 0, sizeof(reportbuffer));
1005
1006 for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
1007 if (djdev->reports_supported & (1 << i)) {
1008 reportbuffer[0] = i;
1009 if (hid_input_report(djdev->hdev,
1010 HID_INPUT_REPORT,
1011 reportbuffer,
1012 hid_reportid_size_map[i], 1)) {
1013 dbg_hid("hid_input_report error sending null "
1014 "report\n");
1015 }
1016 }
1017 }
1018}
1019
83898234
BT		 1020static void logi_dj_recv_forward_dj(struct dj_receiver_dev *djrcv_dev,
1021 struct dj_report *dj_report)
534a7b8e
NLC		 1022{
1023 /* We are called from atomic context (tasklet && djrcv->lock held) */
1024 struct dj_device *dj_device;
1025
1026 dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
1027
534a7b8e
NLC		 1028 if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) ||
1029 (hid_reportid_size_map[dj_report->report_type] == 0)) {
1030 dbg_hid("invalid report type:%x\n", dj_report->report_type);
1031 return;
1032 }
1033
1034 if (hid_input_report(dj_device->hdev,
1035 HID_INPUT_REPORT, &dj_report->report_type,
1036 hid_reportid_size_map[dj_report->report_type], 1)) {
1037 dbg_hid("hid_input_report error\n");
1038 }
1039}
1040
83898234
BT		 1041static void logi_dj_recv_forward_report(struct dj_device *dj_dev, u8 *data,
1042 int size)
925f0f3e
BT		 1043{
1044 /* We are called from atomic context (tasklet && djrcv->lock held) */
1045 if (hid_input_report(dj_dev->hdev, HID_INPUT_REPORT, data, size, 1))
1046 dbg_hid("hid_input_report error\n");
1047}
534a7b8e 1048
74808f91
HG		 1049static void logi_dj_recv_forward_input_report(struct hid_device *hdev,
1050 u8 *data, int size)
1051{
1052 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
1053 struct dj_device *dj_dev;
1054 unsigned long flags;
1055 u8 report = data[0];
1056 int i;
1057
1058 if (report > REPORT_TYPE_RFREPORT_LAST) {
640d4ea8 1059 hid_err(hdev, "Unexpected input report number %d\n", report);
74808f91
HG		 1060 return;
1061 }
1062
1063 spin_lock_irqsave(&djrcv_dev->lock, flags);
1064 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
1065 dj_dev = djrcv_dev->paired_dj_devices[i];
1066 if (dj_dev && (dj_dev->reports_supported & BIT(report))) {
1067 logi_dj_recv_forward_report(dj_dev, data, size);
1068 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1069 return;
1070 }
1071 }
1072
1073 logi_dj_recv_queue_unknown_work(djrcv_dev);
1074 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1075
1076 dbg_hid("No dj-devs handling input report number %d\n", report);
1077}
1078
534a7b8e
NLC		 1079static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
1080 struct dj_report *dj_report)
1081{
0ee75544 1082 struct hid_device *hdev = djrcv_dev->hidpp;
dcd9006b
BT		 1083 struct hid_report *report;
1084 struct hid_report_enum *output_report_enum;
1085 u8 *data = (u8 *)(&dj_report->device_index);
297502ab 1086 unsigned int i;
534a7b8e 1087
dcd9006b
BT		 1088 output_report_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
1089 report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
1090
1091 if (!report) {
aca22a35 1092 hid_err(hdev, "%s: unable to find dj report\n", __func__);
534a7b8e
NLC		 1093 return -ENODEV;
1094 }
1095
297502ab 1096 for (i = 0; i < DJREPORT_SHORT_LENGTH - 1; i++)
dcd9006b
BT		 1097 report->field[0]->value[i] = data[i];
1098
83a44ac8 1099 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
534a7b8e 1100
dcd9006b 1101 return 0;
534a7b8e
NLC		 1102}
1103
74808f91
HG		 1104static int logi_dj_recv_query_hidpp_devices(struct dj_receiver_dev *djrcv_dev)
1105{
1106 const u8 template[] = {REPORT_ID_HIDPP_SHORT,
1107 HIDPP_RECEIVER_INDEX,
1108 HIDPP_SET_REGISTER,
1109 HIDPP_REG_CONNECTION_STATE,
1110 HIDPP_FAKE_DEVICE_ARRIVAL,
1111 0x00, 0x00};
1112 u8 *hidpp_report;
1113 int retval;
1114
1115 hidpp_report = kmemdup(template, sizeof(template), GFP_KERNEL);
1116 if (!hidpp_report)
1117 return -ENOMEM;
1118
1119 retval = hid_hw_raw_request(djrcv_dev->hidpp,
1120 REPORT_ID_HIDPP_SHORT,
1121 hidpp_report, sizeof(template),
1122 HID_OUTPUT_REPORT,
1123 HID_REQ_SET_REPORT);
1124
1125 kfree(hidpp_report);
1126 return 0;
1127}
1128
534a7b8e
NLC		 1129static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
1130{
d8dc3494
MD		 1131 struct dj_report *dj_report;
1132 int retval;
534a7b8e 1133
b6aeedde
HG		 1134 djrcv_dev->last_query = jiffies;
1135
74808f91
HG		 1136 if (djrcv_dev->type != recvr_type_dj)
1137 return logi_dj_recv_query_hidpp_devices(djrcv_dev);
1138
8a55ade7 1139 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
d8dc3494
MD		 1140 if (!dj_report)
1141 return -ENOMEM;
1142 dj_report->report_id = REPORT_ID_DJ_SHORT;
1143 dj_report->device_index = 0xFF;
1144 dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
1145 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
1146 kfree(dj_report);
1147 return retval;
534a7b8e
NLC		 1148}
1149
c63e0e37 1150
534a7b8e
NLC		 1151static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
1152 unsigned timeout)
1153{
0ee75544 1154 struct hid_device *hdev = djrcv_dev->hidpp;
d8dc3494 1155 struct dj_report *dj_report;
6a9ddc89 1156 u8 *buf;
74808f91 1157 int retval = 0;
534a7b8e 1158
8a55ade7 1159 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
d8dc3494
MD		 1160 if (!dj_report)
1161 return -ENOMEM;
42c22dbf 1162
74808f91
HG		 1163 if (djrcv_dev->type == recvr_type_dj) {
1164 dj_report->report_id = REPORT_ID_DJ_SHORT;
1165 dj_report->device_index = 0xFF;
1166 dj_report->report_type = REPORT_TYPE_CMD_SWITCH;
1167 dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
1168 dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] =
1169 (u8)timeout;
1170
1171 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
1172
1173 /*
1174 * Ugly sleep to work around a USB 3.0 bug when the receiver is
1175 * still processing the "switch-to-dj" command while we send an
1176 * other command.
1177 * 50 msec should gives enough time to the receiver to be ready.
1178 */
1179 msleep(50);
1180 }
42c22dbf 1181
6a9ddc89
BT		 1182 /*
1183 * Magical bits to set up hidpp notifications when the dj devices
1184 * are connected/disconnected.
1185 *
1186 * We can reuse dj_report because HIDPP_REPORT_SHORT_LENGTH is smaller
1187 * than DJREPORT_SHORT_LENGTH.
1188 */
1189 buf = (u8 *)dj_report;
1190
1191 memset(buf, 0, HIDPP_REPORT_SHORT_LENGTH);
1192
1193 buf[0] = REPORT_ID_HIDPP_SHORT;
1194 buf[1] = 0xFF;
1195 buf[2] = 0x80;
1196 buf[3] = 0x00;
1197 buf[4] = 0x00;
1198 buf[5] = 0x09;
1199 buf[6] = 0x00;
1200
1201 hid_hw_raw_request(hdev, REPORT_ID_HIDPP_SHORT, buf,
1202 HIDPP_REPORT_SHORT_LENGTH, HID_OUTPUT_REPORT,
1203 HID_REQ_SET_REPORT);
1204
1205 kfree(dj_report);
d8dc3494 1206 return retval;
534a7b8e
NLC		 1207}
1208
1209
1210static int logi_dj_ll_open(struct hid_device *hid)
1211{
aca22a35 1212 dbg_hid("%s: %s\n", __func__, hid->phys);
534a7b8e
NLC		 1213 return 0;
1214
1215}
1216
1217static void logi_dj_ll_close(struct hid_device *hid)
1218{
aca22a35 1219 dbg_hid("%s: %s\n", __func__, hid->phys);
534a7b8e
NLC		 1220}
1221
8dba3026
BT		 1222/*
1223 * Register 0xB5 is "pairing information". It is solely intended for the
1224 * receiver, so do not overwrite the device index.
1225 */
c0340412
BT		 1226static u8 unifying_pairing_query[] = { REPORT_ID_HIDPP_SHORT,
1227 HIDPP_RECEIVER_INDEX,
1228 HIDPP_GET_LONG_REGISTER,
1229 HIDPP_REG_PAIRING_INFORMATION };
1230static u8 unifying_pairing_answer[] = { REPORT_ID_HIDPP_LONG,
1231 HIDPP_RECEIVER_INDEX,
1232 HIDPP_GET_LONG_REGISTER,
1233 HIDPP_REG_PAIRING_INFORMATION };
33797820 1234
bd27e202
BT		 1235static int logi_dj_ll_raw_request(struct hid_device *hid,
1236 unsigned char reportnum, __u8 *buf,
1237 size_t count, unsigned char report_type,
1238 int reqtype)
534a7b8e 1239{
0e40d356
BT		 1240 struct dj_device *djdev = hid->driver_data;
1241 struct dj_receiver_dev *djrcv_dev = djdev->dj_receiver_dev;
1242 u8 *out_buf;
1243 int ret;
534a7b8e 1244
925f0f3e 1245 if ((buf[0] == REPORT_ID_HIDPP_SHORT) ||
3a9a2c86
HG		 1246 (buf[0] == REPORT_ID_HIDPP_LONG) ||
1247 (buf[0] == REPORT_ID_HIDPP_VERY_LONG)) {
925f0f3e
BT		 1248 if (count < 2)
1249 return -EINVAL;
1250
33797820
BT		 1251 /* special case where we should not overwrite
1252 * the device_index */
8dba3026
BT		 1253 if (count == 7 && !memcmp(buf, unifying_pairing_query,
1254 sizeof(unifying_pairing_query)))
1255 buf[4] = (buf[4] & 0xf0) | (djdev->device_index - 1);
33797820
BT		 1256 else
1257 buf[1] = djdev->device_index;
0ee75544 1258 return hid_hw_raw_request(djrcv_dev->hidpp, reportnum, buf,
925f0f3e
BT		 1259 count, report_type, reqtype);
1260 }
1261
0e40d356
BT		 1262 if (buf[0] != REPORT_TYPE_LEDS)
1263 return -EINVAL;
1264
74808f91
HG		 1265 if (djrcv_dev->type != recvr_type_dj && count >= 2) {
1266 if (!djrcv_dev->keyboard) {
1267 hid_warn(hid, "Received REPORT_TYPE_LEDS request before the keyboard interface was enumerated\n");
1268 return 0;
1269 }
1270 /* usbhid overrides the report ID and ignores the first byte */
1271 return hid_hw_raw_request(djrcv_dev->keyboard, 0, buf, count,
1272 report_type, reqtype);
1273 }
1274
0e40d356
BT		 1275 out_buf = kzalloc(DJREPORT_SHORT_LENGTH, GFP_ATOMIC);
1276 if (!out_buf)
1277 return -ENOMEM;
1278
51217e69 1279 if (count > DJREPORT_SHORT_LENGTH - 2)
0e40d356
BT		 1280 count = DJREPORT_SHORT_LENGTH - 2;
1281
1282 out_buf[0] = REPORT_ID_DJ_SHORT;
1283 out_buf[1] = djdev->device_index;
1284 memcpy(out_buf + 2, buf, count);
1285
0ee75544 1286 ret = hid_hw_raw_request(djrcv_dev->hidpp, out_buf[0], out_buf,
bd27e202 1287 DJREPORT_SHORT_LENGTH, report_type, reqtype);
0e40d356
BT		 1288
1289 kfree(out_buf);
1290 return ret;
534a7b8e
NLC		 1291}
1292
6d603326 1293static void rdcat(char *rdesc, unsigned int *rsize, const char *data, unsigned int size)
2a039bf5 1294{
6d603326 1295 memcpy(rdesc + *rsize, data, size);
2a039bf5
HR		 1296 *rsize += size;
1297}
1298
534a7b8e
NLC		 1299static int logi_dj_ll_parse(struct hid_device *hid)
1300{
1301 struct dj_device *djdev = hid->driver_data;
2a039bf5
HR		 1302 unsigned int rsize = 0;
1303 char *rdesc;
534a7b8e
NLC		 1304 int retval;
1305
1306 dbg_hid("%s\n", __func__);
1307
1308 djdev->hdev->version = 0x0111;
1309 djdev->hdev->country = 0x00;
1310
2a039bf5
HR		 1311 rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL);
1312 if (!rdesc)
1313 return -ENOMEM;
1314
534a7b8e 1315 if (djdev->reports_supported & STD_KEYBOARD) {
6d3c3f03 1316 dbg_hid("%s: sending a kbd descriptor, reports_supported: %llx\n",
534a7b8e 1317 __func__, djdev->reports_supported);
6d603326 1318 rdcat(rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor));
534a7b8e
NLC		 1319 }
1320
1321 if (djdev->reports_supported & STD_MOUSE) {
6d3c3f03
HG		 1322 dbg_hid("%s: sending a mouse descriptor, reports_supported: %llx\n",
1323 __func__, djdev->reports_supported);
3ed224e2
HG		 1324 if (djdev->dj_receiver_dev->type == recvr_type_gaming_hidpp ||
1325 djdev->dj_receiver_dev->type == recvr_type_mouse_only)
f5fb57a7
BT		 1326 rdcat(rdesc, &rsize, mse_high_res_descriptor,
1327 sizeof(mse_high_res_descriptor));
c9121cf6
HG		 1328 else if (djdev->dj_receiver_dev->type == recvr_type_27mhz)
1329 rdcat(rdesc, &rsize, mse_27mhz_descriptor,
1330 sizeof(mse_27mhz_descriptor));
f2113c30
HG		 1331 else if (djdev->dj_receiver_dev->type == recvr_type_bluetooth)
1332 rdcat(rdesc, &rsize, mse_bluetooth_descriptor,
1333 sizeof(mse_bluetooth_descriptor));
f5fb57a7
BT		 1334 else
1335 rdcat(rdesc, &rsize, mse_descriptor,
1336 sizeof(mse_descriptor));
534a7b8e
NLC		 1337 }
1338
1339 if (djdev->reports_supported & MULTIMEDIA) {
6d3c3f03 1340 dbg_hid("%s: sending a multimedia report descriptor: %llx\n",
534a7b8e 1341 __func__, djdev->reports_supported);
6d603326 1342 rdcat(rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor));
534a7b8e
NLC		 1343 }
1344
1345 if (djdev->reports_supported & POWER_KEYS) {
6d3c3f03 1346 dbg_hid("%s: sending a power keys report descriptor: %llx\n",
534a7b8e 1347 __func__, djdev->reports_supported);
6d603326 1348 rdcat(rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor));
534a7b8e
NLC		 1349 }
1350
1351 if (djdev->reports_supported & MEDIA_CENTER) {
6d3c3f03 1352 dbg_hid("%s: sending a media center report descriptor: %llx\n",
534a7b8e 1353 __func__, djdev->reports_supported);
6d603326 1354 rdcat(rdesc, &rsize, media_descriptor, sizeof(media_descriptor));
534a7b8e
NLC		 1355 }
1356
1357 if (djdev->reports_supported & KBD_LEDS) {
6d3c3f03 1358 dbg_hid("%s: need to send kbd leds report descriptor: %llx\n",
534a7b8e
NLC		 1359 __func__, djdev->reports_supported);
1360 }
1361
6d3c3f03
HG		 1362 if (djdev->reports_supported & HIDPP) {
1363 rdcat(rdesc, &rsize, hidpp_descriptor,
1364 sizeof(hidpp_descriptor));
1365 }
925f0f3e 1366
2a039bf5
HR		 1367 retval = hid_parse_report(hid, rdesc, rsize);
1368 kfree(rdesc);
1369
1370 return retval;
534a7b8e
NLC		 1371}
1372
534a7b8e
NLC		 1373static int logi_dj_ll_start(struct hid_device *hid)
1374{
1375 dbg_hid("%s\n", __func__);
1376 return 0;
1377}
1378
1379static void logi_dj_ll_stop(struct hid_device *hid)
1380{
1381 dbg_hid("%s\n", __func__);
1382}
1383
1384
1385static struct hid_ll_driver logi_dj_ll_driver = {
1386 .parse = logi_dj_ll_parse,
1387 .start = logi_dj_ll_start,
1388 .stop = logi_dj_ll_stop,
1389 .open = logi_dj_ll_open,
1390 .close = logi_dj_ll_close,
bd27e202 1391 .raw_request = logi_dj_ll_raw_request,
534a7b8e
NLC		 1392};
1393
925f0f3e 1394static int logi_dj_dj_event(struct hid_device *hdev,
534a7b8e
NLC		 1395 struct hid_report *report, u8 *data,
1396 int size)
1397{
1398 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
1399 struct dj_report *dj_report = (struct dj_report *) data;
1400 unsigned long flags;
534a7b8e 1401
925f0f3e
BT		 1402 /*
1403 * Here we receive all data coming from iface 2, there are 3 cases:
534a7b8e 1404 *
925f0f3e
BT		 1405 * 1) Data is intended for this driver i. e. data contains arrival,
1406 * departure, etc notifications, in which case we queue them for delayed
1407 * processing by the work queue. We return 1 to hid-core as no further
1408 * processing is required from it.
534a7b8e 1409 *
925f0f3e
BT		 1410 * 2) Data informs a connection change, if the change means rf link
1411 * loss, then we must send a null report to the upper layer to discard
1412 * potentially pressed keys that may be repeated forever by the input
1413 * layer. Return 1 to hid-core as no further processing is required.
534a7b8e 1414 *
925f0f3e
BT		 1415 * 3) Data is an actual input event from a paired DJ device in which
1416 * case we forward it to the correct hid device (via hid_input_report()
1417 * ) and return 1 so hid-core does not anything else with it.
534a7b8e 1418 */
5abfe85c 1419
ad3e14d7
JK		 1420 if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
1421 (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
5abfe85c
BT		 1422 /*
1423 * Device index is wrong, bail out.
1424 * This driver can ignore safely the receiver notifications,
1425 * so ignore those reports too.
1426 */
1427 if (dj_report->device_index != DJ_RECEIVER_INDEX)
aca22a35 1428 hid_err(hdev, "%s: invalid device index:%d\n",
ad3e14d7
JK		 1429 __func__, dj_report->device_index);
1430 return false;
1431 }
534a7b8e
NLC		 1432
1433 spin_lock_irqsave(&djrcv_dev->lock, flags);
368d4e59
BT		 1434
1435 if (!djrcv_dev->paired_dj_devices[dj_report->device_index]) {
1436 /* received an event for an unknown device, bail out */
1437 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
1438 goto out;
1439 }
1440
5abfe85c
BT		 1441 switch (dj_report->report_type) {
1442 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
368d4e59
BT		 1443 /* pairing notifications are handled above the switch */
1444 break;
5abfe85c
BT		 1445 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
1446 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
1447 break;
1448 case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
1449 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
1450 STATUS_LINKLOSS) {
1451 logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
534a7b8e 1452 }
5abfe85c
BT		 1453 break;
1454 default:
83898234 1455 logi_dj_recv_forward_dj(djrcv_dev, dj_report);
534a7b8e 1456 }
368d4e59
BT		 1457
1458out:
534a7b8e
NLC		 1459 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1460
5abfe85c 1461 return true;
534a7b8e
NLC		 1462}
1463
925f0f3e
BT		 1464static int logi_dj_hidpp_event(struct hid_device *hdev,
1465 struct hid_report *report, u8 *data,
1466 int size)
1467{
1468 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
7bb56a5f 1469 struct hidpp_event *hidpp_report = (struct hidpp_event *) data;
74808f91 1470 struct dj_device *dj_dev;
925f0f3e 1471 unsigned long flags;
7bb56a5f 1472 u8 device_index = hidpp_report->device_index;
925f0f3e 1473
33797820
BT		 1474 if (device_index == HIDPP_RECEIVER_INDEX) {
1475 /* special case were the device wants to know its unifying
1476 * name */
1477 if (size == HIDPP_REPORT_LONG_LENGTH &&
8dba3026
BT		 1478 !memcmp(data, unifying_pairing_answer,
1479 sizeof(unifying_pairing_answer)))
33797820
BT		 1480 device_index = (data[4] & 0x0F) + 1;
1481 else
1482 return false;
1483 }
925f0f3e
BT		 1484
1485 /*
1486 * Data is from the HID++ collection, in this case, we forward the
1487 * data to the corresponding child dj device and return 0 to hid-core
1488 * so he data also goes to the hidraw device of the receiver. This
1489 * allows a user space application to implement the full HID++ routing
1490 * via the receiver.
1491 */
1492
1493 if ((device_index < DJ_DEVICE_INDEX_MIN) ||
1494 (device_index > DJ_DEVICE_INDEX_MAX)) {
1495 /*
1496 * Device index is wrong, bail out.
1497 * This driver can ignore safely the receiver notifications,
1498 * so ignore those reports too.
1499 */
aca22a35
HG		 1500 hid_err(hdev, "%s: invalid device index:%d\n", __func__,
1501 hidpp_report->device_index);
925f0f3e
BT		 1502 return false;
1503 }
1504
1505 spin_lock_irqsave(&djrcv_dev->lock, flags);
1506
74808f91 1507 dj_dev = djrcv_dev->paired_dj_devices[device_index];
c9121cf6
HG		 1508
1509 /*
1510 * With 27 MHz receivers, we do not get an explicit unpair event,
1511 * remove the old device if the user has paired a *different* device.
1512 */
1513 if (djrcv_dev->type == recvr_type_27mhz && dj_dev &&
1514 hidpp_report->sub_id == REPORT_TYPE_NOTIF_DEVICE_CONNECTED &&
1515 hidpp_report->params[HIDPP_PARAM_PROTO_TYPE] == 0x02 &&
1516 hidpp_report->params[HIDPP_PARAM_27MHZ_DEVID] !=
1517 dj_dev->hdev->product) {
1518 struct dj_workitem workitem = {
1519 .device_index = hidpp_report->device_index,
1520 .type = WORKITEM_TYPE_UNPAIRED,
1521 };
1522 kfifo_in(&djrcv_dev->notif_fifo, &workitem, sizeof(workitem));
1523 /* logi_hidpp_recv_queue_notif will queue the work */
1524 dj_dev = NULL;
1525 }
1526
74808f91
HG		 1527 if (dj_dev) {
1528 logi_dj_recv_forward_report(dj_dev, data, size);
1529 } else {
1530 if (hidpp_report->sub_id == REPORT_TYPE_NOTIF_DEVICE_CONNECTED)
1531 logi_hidpp_recv_queue_notif(hdev, hidpp_report);
1532 else
1533 logi_dj_recv_queue_unknown_work(djrcv_dev);
1534 }
925f0f3e 1535
925f0f3e
BT		 1536 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1537
1538 return false;
1539}
1540
1541static int logi_dj_raw_event(struct hid_device *hdev,
1542 struct hid_report *report, u8 *data,
1543 int size)
1544{
74808f91 1545 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
925f0f3e
BT		 1546 dbg_hid("%s, size:%d\n", __func__, size);
1547
da12b224
HG		 1548 if (!djrcv_dev)
1549 return 0;
1550
74808f91
HG		 1551 if (!hdev->report_enum[HID_INPUT_REPORT].numbered) {
1552
1553 if (djrcv_dev->unnumbered_application == HID_GD_KEYBOARD) {
1554 /*
1555 * For the keyboard, we can reuse the same report by
1556 * using the second byte which is constant in the USB
1557 * HID report descriptor.
1558 */
1559 data[1] = data[0];
1560 data[0] = REPORT_TYPE_KEYBOARD;
1561
1562 logi_dj_recv_forward_input_report(hdev, data, size);
1563
1564 /* restore previous state */
1565 data[0] = data[1];
1566 data[1] = 0;
1567 }
3ed224e2
HG		 1568 /*
1569 * Mouse-only receivers send unnumbered mouse data. The 27 MHz
1570 * receiver uses 6 byte packets, the nano receiver 8 bytes.
1571 */
1f944ac6 1572 if (djrcv_dev->unnumbered_application == HID_GD_MOUSE &&
3ed224e2
HG		 1573 size <= 8) {
1574 u8 mouse_report[9];
1f944ac6
HG		 1575
1576 /* Prepend report id */
1577 mouse_report[0] = REPORT_TYPE_MOUSE;
3ed224e2
HG		 1578 memcpy(mouse_report + 1, data, size);
1579 logi_dj_recv_forward_input_report(hdev, mouse_report,
1580 size + 1);
1f944ac6 1581 }
74808f91
HG		 1582
1583 return false;
1584 }
1585
925f0f3e
BT		 1586 switch (data[0]) {
1587 case REPORT_ID_DJ_SHORT:
f254ae93 1588 if (size != DJREPORT_SHORT_LENGTH) {
aca22a35 1589 hid_err(hdev, "Short DJ report bad size (%d)", size);
f254ae93
PW		 1590 return false;
1591 }
925f0f3e 1592 return logi_dj_dj_event(hdev, report, data, size);
f5fb57a7
BT		 1593 case REPORT_ID_DJ_LONG:
1594 if (size != DJREPORT_LONG_LENGTH) {
aca22a35 1595 hid_err(hdev, "Long DJ report bad size (%d)", size);
f5fb57a7
BT		 1596 return false;
1597 }
1598 return logi_dj_dj_event(hdev, report, data, size);
925f0f3e 1599 case REPORT_ID_HIDPP_SHORT:
f254ae93 1600 if (size != HIDPP_REPORT_SHORT_LENGTH) {
aca22a35 1601 hid_err(hdev, "Short HID++ report bad size (%d)", size);
f254ae93
PW		 1602 return false;
1603 }
1604 return logi_dj_hidpp_event(hdev, report, data, size);
925f0f3e 1605 case REPORT_ID_HIDPP_LONG:
f254ae93 1606 if (size != HIDPP_REPORT_LONG_LENGTH) {
aca22a35 1607 hid_err(hdev, "Long HID++ report bad size (%d)", size);
f254ae93
PW		 1608 return false;
1609 }
925f0f3e
BT		 1610 return logi_dj_hidpp_event(hdev, report, data, size);
1611 }
1612
74808f91
HG		 1613 logi_dj_recv_forward_input_report(hdev, data, size);
1614
925f0f3e
BT		 1615 return false;
1616}
1617
534a7b8e
NLC		 1618static int logi_dj_probe(struct hid_device *hdev,
1619 const struct hid_device_id *id)
1620{
82c0beb8
BT		 1621 struct hid_report_enum *rep_enum;
1622 struct hid_report *rep;
534a7b8e 1623 struct dj_receiver_dev *djrcv_dev;
da12b224
HG		 1624 struct usb_interface *intf;
1625 unsigned int no_dj_interfaces = 0;
82c0beb8 1626 bool has_hidpp = false;
a1d97ccb 1627 unsigned long flags;
534a7b8e
NLC		 1628 int retval;
1629
82c0beb8
BT		 1630 /*
1631 * Call to usbhid to fetch the HID descriptors of the current
1632 * interface subsequently call to the hid/hid-core to parse the
1633 * fetched descriptors.
1634 */
1635 retval = hid_parse(hdev);
1636 if (retval) {
aca22a35 1637 hid_err(hdev, "%s: parse failed\n", __func__);
82c0beb8
BT		 1638 return retval;
1639 }
534a7b8e 1640
da12b224
HG		 1641 /*
1642 * Some KVMs add an extra interface for e.g. mouse emulation. If we
1643 * treat these as logitech-dj interfaces then this causes input events
1644 * reported through this extra interface to not be reported correctly.
1645 * To avoid this, we treat these as generic-hid devices.
1646 */
1647 switch (id->driver_data) {
1648 case recvr_type_dj: no_dj_interfaces = 3; break;
1649 case recvr_type_hidpp: no_dj_interfaces = 2; break;
1650 case recvr_type_gaming_hidpp: no_dj_interfaces = 3; break;
3ed224e2 1651 case recvr_type_mouse_only: no_dj_interfaces = 2; break;
da12b224 1652 case recvr_type_27mhz: no_dj_interfaces = 2; break;
f2113c30 1653 case recvr_type_bluetooth: no_dj_interfaces = 2; break;
da12b224
HG		 1654 }
1655 if (hid_is_using_ll_driver(hdev, &usb_hid_driver)) {
1656 intf = to_usb_interface(hdev->dev.parent);
1657 if (intf && intf->altsetting->desc.bInterfaceNumber >=
1658 no_dj_interfaces) {
1659 hdev->quirks |= HID_QUIRK_INPUT_PER_APP;
1660 return hid_hw_start(hdev, HID_CONNECT_DEFAULT);
1661 }
1662 }
1663
82c0beb8
BT		 1664 rep_enum = &hdev->report_enum[HID_INPUT_REPORT];
1665
74808f91
HG		 1666 /* no input reports, bail out */
1667 if (list_empty(&rep_enum->report_list))
1668 return -ENODEV;
1669
82c0beb8
BT		 1670 /*
1671 * Check for the HID++ application.
1672 * Note: we should theoretically check for HID++ and DJ
1673 * collections, but this will do.
1674 */
1675 list_for_each_entry(rep, &rep_enum->report_list, list) {
1676 if (rep->application == 0xff000001)
1677 has_hidpp = true;
534a7b8e
NLC		 1678 }
1679
82c0beb8
BT		 1680 /*
1681 * Ignore interfaces without DJ/HID++ collection, they will not carry
1682 * any data, dont create any hid_device for them.
1683 */
74808f91 1684 if (!has_hidpp && id->driver_data == recvr_type_dj)
82c0beb8
BT		 1685 return -ENODEV;
1686
a1d97ccb
HG		 1687 /* get the current application attached to the node */
1688 rep = list_first_entry(&rep_enum->report_list, struct hid_report, list);
74808f91 1689 djrcv_dev = dj_get_receiver_dev(hdev, id->driver_data,
a1d97ccb 1690 rep->application, has_hidpp);
534a7b8e 1691 if (!djrcv_dev) {
aca22a35 1692 hid_err(hdev, "%s: dj_get_receiver_dev failed\n", __func__);
534a7b8e
NLC		 1693 return -ENOMEM;
1694 }
297502ab 1695
74808f91
HG		 1696 if (!rep_enum->numbered)
1697 djrcv_dev->unnumbered_application = rep->application;
1698
534a7b8e
NLC		 1699 /* Starts the usb device and connects to upper interfaces hiddev and
1700 * hidraw */
74808f91 1701 retval = hid_hw_start(hdev, HID_CONNECT_HIDRAW|HID_CONNECT_HIDDEV);
534a7b8e 1702 if (retval) {
aca22a35 1703 hid_err(hdev, "%s: hid_hw_start returned error\n", __func__);
534a7b8e
NLC		 1704 goto hid_hw_start_fail;
1705 }
1706
74808f91
HG		 1707 if (has_hidpp) {
1708 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
1709 if (retval < 0) {
1710 hid_err(hdev, "%s: logi_dj_recv_switch_to_dj_mode returned error:%d\n",
1711 __func__, retval);
1712 goto switch_to_dj_mode_fail;
1713 }
534a7b8e
NLC		 1714 }
1715
1716 /* This is enabling the polling urb on the IN endpoint */
ddf7540e 1717 retval = hid_hw_open(hdev);
534a7b8e 1718 if (retval < 0) {
aca22a35 1719 hid_err(hdev, "%s: hid_hw_open returned error:%d\n",
ddf7540e 1720 __func__, retval);
534a7b8e
NLC		 1721 goto llopen_failed;
1722 }
1723
a9dd22b7
AR		 1724 /* Allow incoming packets to arrive: */
1725 hid_device_io_start(hdev);
1726
74808f91
HG		 1727 if (has_hidpp) {
1728 spin_lock_irqsave(&djrcv_dev->lock, flags);
1729 djrcv_dev->ready = true;
1730 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1731 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
1732 if (retval < 0) {
1733 hid_err(hdev, "%s: logi_dj_recv_query_paired_devices error:%d\n",
1734 __func__, retval);
1735 goto logi_dj_recv_query_paired_devices_failed;
1736 }
534a7b8e
NLC		 1737 }
1738
1739 return retval;
1740
1741logi_dj_recv_query_paired_devices_failed:
ddf7540e 1742 hid_hw_close(hdev);
534a7b8e
NLC		 1743
1744llopen_failed:
1745switch_to_dj_mode_fail:
1746 hid_hw_stop(hdev);
1747
1748hid_hw_start_fail:
a1d97ccb 1749 dj_put_receiver_dev(hdev);
534a7b8e 1750 return retval;
534a7b8e
NLC		 1751}
1752
1753#ifdef CONFIG_PM
1754static int logi_dj_reset_resume(struct hid_device *hdev)
1755{
1756 int retval;
1757 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
1758
da12b224 1759 if (!djrcv_dev || djrcv_dev->hidpp != hdev)
74808f91
HG		 1760 return 0;
1761
534a7b8e
NLC		 1762 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
1763 if (retval < 0) {
aca22a35 1764 hid_err(hdev, "%s: logi_dj_recv_switch_to_dj_mode returned error:%d\n",
534a7b8e
NLC		 1765 __func__, retval);
1766 }
1767
1768 return 0;
1769}
1770#endif
1771
1772static void logi_dj_remove(struct hid_device *hdev)
1773{
1774 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
1775 struct dj_device *dj_dev;
a1d97ccb 1776 unsigned long flags;
534a7b8e
NLC		 1777 int i;
1778
1779 dbg_hid("%s\n", __func__);
1780
da12b224
HG		 1781 if (!djrcv_dev)
1782 return hid_hw_stop(hdev);
1783
a1d97ccb
HG		 1784 /*
1785 * This ensures that if the work gets requeued from another
1786 * interface of the same receiver it will be a no-op.
1787 */
1788 spin_lock_irqsave(&djrcv_dev->lock, flags);
1789 djrcv_dev->ready = false;
1790 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
1791
534a7b8e
NLC		 1792 cancel_work_sync(&djrcv_dev->work);
1793
ddf7540e 1794 hid_hw_close(hdev);
534a7b8e
NLC		 1795 hid_hw_stop(hdev);
1796
a1d97ccb
HG		 1797 /*
1798 * For proper operation we need access to all interfaces, so we destroy
1799 * the paired devices when we're unbound from any interface.
1800 *
1801 * Note we may still be bound to other interfaces, sharing the same
1802 * djrcv_dev, so we need locking here.
1803 */
844580ff 1804 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
a1d97ccb 1805 spin_lock_irqsave(&djrcv_dev->lock, flags);
534a7b8e 1806 dj_dev = djrcv_dev->paired_dj_devices[i];
a1d97ccb
HG		 1807 djrcv_dev->paired_dj_devices[i] = NULL;
1808 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
534a7b8e
NLC		 1809 if (dj_dev != NULL) {
1810 hid_destroy_device(dj_dev->hdev);
1811 kfree(dj_dev);
534a7b8e
NLC		 1812 }
1813 }
1814
a1d97ccb 1815 dj_put_receiver_dev(hdev);
534a7b8e
NLC		 1816}
1817
534a7b8e
NLC		 1818static const struct hid_device_id logi_dj_receivers[] = {
1819 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
74808f91
HG		 1820 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER),
1821 .driver_data = recvr_type_dj},
534a7b8e 1822 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
74808f91
HG		 1823 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2),
1824 .driver_data = recvr_type_dj},
3ed224e2 1825 { /* Logitech Nano mouse only receiver */
74808f91
HG		 1826 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1827 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER),
3ed224e2 1828 .driver_data = recvr_type_mouse_only},
74808f91
HG		 1829 { /* Logitech Nano (non DJ) receiver */
1830 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1831 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_2),
1832 .driver_data = recvr_type_hidpp},
f5fb57a7
BT		 1833 { /* Logitech gaming receiver (0xc539) */
1834 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1835 USB_DEVICE_ID_LOGITECH_NANO_RECEIVER_GAMING),
1836 .driver_data = recvr_type_gaming_hidpp},
c9121cf6
HG		 1837 { /* Logitech 27 MHz HID++ 1.0 receiver (0xc517) */
1838 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1839 USB_DEVICE_ID_S510_RECEIVER_2),
1840 .driver_data = recvr_type_27mhz},
1f944ac6
HG		 1841 { /* Logitech 27 MHz HID++ 1.0 mouse-only receiver (0xc51b) */
1842 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1843 USB_DEVICE_ID_LOGITECH_27MHZ_MOUSE_RECEIVER),
1844 .driver_data = recvr_type_27mhz},
f2113c30
HG		 1845 { /* Logitech MX5000 HID++ / bluetooth receiver keyboard intf. */
1846 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1847 0xc70e),
1848 .driver_data = recvr_type_bluetooth},
1849 { /* Logitech MX5000 HID++ / bluetooth receiver mouse intf. */
1850 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1851 0xc70a),
1852 .driver_data = recvr_type_bluetooth},
b9a94fbe
HG		 1853 { /* Logitech MX5500 HID++ / bluetooth receiver keyboard intf. */
1854 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1855 0xc71b),
1856 .driver_data = recvr_type_bluetooth},
1857 { /* Logitech MX5500 HID++ / bluetooth receiver mouse intf. */
1858 HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
1859 0xc71c),
1860 .driver_data = recvr_type_bluetooth},
534a7b8e
NLC		 1861 {}
1862};
1863
1864MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
1865
1866static struct hid_driver logi_djreceiver_driver = {
1867 .name = "logitech-djreceiver",
1868 .id_table = logi_dj_receivers,
1869 .probe = logi_dj_probe,
1870 .remove = logi_dj_remove,
1871 .raw_event = logi_dj_raw_event,
1872#ifdef CONFIG_PM
1873 .reset_resume = logi_dj_reset_resume,
1874#endif
1875};
1876
ab94e562 1877module_hid_driver(logi_djreceiver_driver);
534a7b8e 1878
534a7b8e
NLC		 1879MODULE_LICENSE("GPL");
1880MODULE_AUTHOR("Logitech");
1881MODULE_AUTHOR("Nestor Lopez Casado");
1882MODULE_AUTHOR("nlopezcasad@logitech.com");
Linux 6.x block layer and io_uring tree(s)