?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
x86/xen: resume timer irqs early
[linux/fpc-iii.git] / drivers / hid / hid-logitech-dj.c
blob9bf4c218cac808ee822429f388915f39747a2ec5
1 /*
2 * HID driver for Logitech Unifying receivers
3 *
4 * Copyright (c) 2011 Logitech
5 */
6
7 /*
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 *
22 */
23
24
25 #include <linux/device.h>
26 #include <linux/hid.h>
27 #include <linux/module.h>
28 #include <linux/usb.h>
29 #include <asm/unaligned.h>
30 #include "hid-ids.h"
31 #include "hid-logitech-dj.h"
32
33 /* Keyboard descriptor (1) */
34 static const char kbd_descriptor[] = {
35 0x05, 0x01, /* USAGE_PAGE (generic Desktop) */
36 0x09, 0x06, /* USAGE (Keyboard) */
37 0xA1, 0x01, /* COLLECTION (Application) */
38 0x85, 0x01, /* REPORT_ID (1) */
39 0x95, 0x08, /* REPORT_COUNT (8) */
40 0x75, 0x01, /* REPORT_SIZE (1) */
41 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
42 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
43 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
44 0x19, 0xE0, /* USAGE_MINIMUM (Left Control) */
45 0x29, 0xE7, /* USAGE_MAXIMUM (Right GUI) */
46 0x81, 0x02, /* INPUT (Data,Var,Abs) */
47 0x95, 0x05, /* REPORT COUNT (5) */
48 0x05, 0x08, /* USAGE PAGE (LED page) */
49 0x19, 0x01, /* USAGE MINIMUM (1) */
50 0x29, 0x05, /* USAGE MAXIMUM (5) */
51 0x91, 0x02, /* OUTPUT (Data, Variable, Absolute) */
52 0x95, 0x01, /* REPORT COUNT (1) */
53 0x75, 0x03, /* REPORT SIZE (3) */
54 0x91, 0x01, /* OUTPUT (Constant) */
55 0x95, 0x06, /* REPORT_COUNT (6) */
56 0x75, 0x08, /* REPORT_SIZE (8) */
57 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
58 0x26, 0xFF, 0x00, /* LOGICAL_MAXIMUM (255) */
59 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
60 0x19, 0x00, /* USAGE_MINIMUM (no event) */
61 0x2A, 0xFF, 0x00, /* USAGE_MAXIMUM (reserved) */
62 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
63 0xC0
64 };
65
66 /* Mouse descriptor (2) */
67 static const char mse_descriptor[] = {
68 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
69 0x09, 0x02, /* USAGE (Mouse) */
70 0xA1, 0x01, /* COLLECTION (Application) */
71 0x85, 0x02, /* REPORT_ID = 2 */
72 0x09, 0x01, /* USAGE (pointer) */
73 0xA1, 0x00, /* COLLECTION (physical) */
74 0x05, 0x09, /* USAGE_PAGE (buttons) */
75 0x19, 0x01, /* USAGE_MIN (1) */
76 0x29, 0x10, /* USAGE_MAX (16) */
77 0x15, 0x00, /* LOGICAL_MIN (0) */
78 0x25, 0x01, /* LOGICAL_MAX (1) */
79 0x95, 0x10, /* REPORT_COUNT (16) */
80 0x75, 0x01, /* REPORT_SIZE (1) */
81 0x81, 0x02, /* INPUT (data var abs) */
82 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
83 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */
84 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */
85 0x75, 0x0C, /* REPORT_SIZE (12) */
86 0x95, 0x02, /* REPORT_COUNT (2) */
87 0x09, 0x30, /* USAGE (X) */
88 0x09, 0x31, /* USAGE (Y) */
89 0x81, 0x06, /* INPUT */
90 0x15, 0x81, /* LOGICAL_MIN (-127) */
91 0x25, 0x7F, /* LOGICAL_MAX (127) */
92 0x75, 0x08, /* REPORT_SIZE (8) */
93 0x95, 0x01, /* REPORT_COUNT (1) */
94 0x09, 0x38, /* USAGE (wheel) */
95 0x81, 0x06, /* INPUT */
96 0x05, 0x0C, /* USAGE_PAGE(consumer) */
97 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
98 0x95, 0x01, /* REPORT_COUNT (1) */
99 0x81, 0x06, /* INPUT */
100 0xC0, /* END_COLLECTION */
101 0xC0, /* END_COLLECTION */
102 };
103
104 /* Consumer Control descriptor (3) */
105 static const char consumer_descriptor[] = {
106 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */
107 0x09, 0x01, /* USAGE (Consumer Control) */
108 0xA1, 0x01, /* COLLECTION (Application) */
109 0x85, 0x03, /* REPORT_ID = 3 */
110 0x75, 0x10, /* REPORT_SIZE (16) */
111 0x95, 0x02, /* REPORT_COUNT (2) */
112 0x15, 0x01, /* LOGICAL_MIN (1) */
113 0x26, 0x8C, 0x02, /* LOGICAL_MAX (652) */
114 0x19, 0x01, /* USAGE_MIN (1) */
115 0x2A, 0x8C, 0x02, /* USAGE_MAX (652) */
116 0x81, 0x00, /* INPUT (Data Ary Abs) */
117 0xC0, /* END_COLLECTION */
118 }; /* */
119
120 /* System control descriptor (4) */
121 static const char syscontrol_descriptor[] = {
122 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
123 0x09, 0x80, /* USAGE (System Control) */
124 0xA1, 0x01, /* COLLECTION (Application) */
125 0x85, 0x04, /* REPORT_ID = 4 */
126 0x75, 0x02, /* REPORT_SIZE (2) */
127 0x95, 0x01, /* REPORT_COUNT (1) */
128 0x15, 0x01, /* LOGICAL_MIN (1) */
129 0x25, 0x03, /* LOGICAL_MAX (3) */
130 0x09, 0x82, /* USAGE (System Sleep) */
131 0x09, 0x81, /* USAGE (System Power Down) */
132 0x09, 0x83, /* USAGE (System Wake Up) */
133 0x81, 0x60, /* INPUT (Data Ary Abs NPrf Null) */
134 0x75, 0x06, /* REPORT_SIZE (6) */
135 0x81, 0x03, /* INPUT (Cnst Var Abs) */
136 0xC0, /* END_COLLECTION */
137 };
138
139 /* Media descriptor (8) */
140 static const char media_descriptor[] = {
141 0x06, 0xbc, 0xff, /* Usage Page 0xffbc */
142 0x09, 0x88, /* Usage 0x0088 */
143 0xa1, 0x01, /* BeginCollection */
144 0x85, 0x08, /* Report ID 8 */
145 0x19, 0x01, /* Usage Min 0x0001 */
146 0x29, 0xff, /* Usage Max 0x00ff */
147 0x15, 0x01, /* Logical Min 1 */
148 0x26, 0xff, 0x00, /* Logical Max 255 */
149 0x75, 0x08, /* Report Size 8 */
150 0x95, 0x01, /* Report Count 1 */
151 0x81, 0x00, /* Input */
152 0xc0, /* EndCollection */
153 }; /* */
154
155 /* Maximum size of all defined hid reports in bytes (including report id) */
156 #define MAX_REPORT_SIZE 8
157
158 /* Make sure all descriptors are present here */
159 #define MAX_RDESC_SIZE \
160 (sizeof(kbd_descriptor) + \
161 sizeof(mse_descriptor) + \
162 sizeof(consumer_descriptor) + \
163 sizeof(syscontrol_descriptor) + \
164 sizeof(media_descriptor))
165
166 /* Number of possible hid report types that can be created by this driver.
167 *
168 * Right now, RF report types have the same report types (or report id's)
169 * than the hid report created from those RF reports. In the future
170 * this doesnt have to be true.
171 *
172 * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds
173 * to hid report id 0x01, this is standard keyboard. Same thing applies to mice
174 * reports and consumer control, etc. If a new RF report is created, it doesn't
175 * has to have the same report id as its corresponding hid report, so an
176 * translation may have to take place for future report types.
177 */
178 #define NUMBER_OF_HID_REPORTS 32
179 static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = {
180 [1] = 8, /* Standard keyboard */
181 [2] = 8, /* Standard mouse */
182 [3] = 5, /* Consumer control */
183 [4] = 2, /* System control */
184 [8] = 2, /* Media Center */
185 };
186
187
188 #define LOGITECH_DJ_INTERFACE_NUMBER 0x02
189
190 static struct hid_ll_driver logi_dj_ll_driver;
191
192 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
193 size_t count,
194 unsigned char report_type);
195 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev);
196
197 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
198 struct dj_report *dj_report)
199 {
200 /* Called in delayed work context */
201 struct dj_device *dj_dev;
202 unsigned long flags;
203
204 spin_lock_irqsave(&djrcv_dev->lock, flags);
205 dj_dev = djrcv_dev->paired_dj_devices[dj_report->device_index];
206 djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
207 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
208
209 if (dj_dev != NULL) {
210 hid_destroy_device(dj_dev->hdev);
211 kfree(dj_dev);
212 } else {
213 dev_err(&djrcv_dev->hdev->dev, "%s: can't destroy a NULL device\n",
214 __func__);
215 }
216 }
217
218 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
219 struct dj_report *dj_report)
220 {
221 /* Called in delayed work context */
222 struct hid_device *djrcv_hdev = djrcv_dev->hdev;
223 struct usb_interface *intf = to_usb_interface(djrcv_hdev->dev.parent);
224 struct usb_device *usbdev = interface_to_usbdev(intf);
225 struct hid_device *dj_hiddev;
226 struct dj_device *dj_dev;
227
228 /* Device index goes from 1 to 6, we need 3 bytes to store the
229 * semicolon, the index, and a null terminator
230 */
231 unsigned char tmpstr[3];
232
233 if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] &
234 SPFUNCTION_DEVICE_LIST_EMPTY) {
235 dbg_hid("%s: device list is empty\n", __func__);
236 djrcv_dev->querying_devices = false;
237 return;
238 }
239
240 if (djrcv_dev->paired_dj_devices[dj_report->device_index]) {
241 /* The device is already known. No need to reallocate it. */
242 dbg_hid("%s: device is already known\n", __func__);
243 return;
244 }
245
246 dj_hiddev = hid_allocate_device();
247 if (IS_ERR(dj_hiddev)) {
248 dev_err(&djrcv_hdev->dev, "%s: hid_allocate_device failed\n",
249 __func__);
250 return;
251 }
252
253 dj_hiddev->ll_driver = &logi_dj_ll_driver;
254 dj_hiddev->hid_output_raw_report = logi_dj_output_hidraw_report;
255
256 dj_hiddev->dev.parent = &djrcv_hdev->dev;
257 dj_hiddev->bus = BUS_USB;
258 dj_hiddev->vendor = le16_to_cpu(usbdev->descriptor.idVendor);
259 dj_hiddev->product = le16_to_cpu(usbdev->descriptor.idProduct);
260 snprintf(dj_hiddev->name, sizeof(dj_hiddev->name),
261 "Logitech Unifying Device. Wireless PID:%02x%02x",
262 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB],
263 dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB]);
264
265 usb_make_path(usbdev, dj_hiddev->phys, sizeof(dj_hiddev->phys));
266 snprintf(tmpstr, sizeof(tmpstr), ":%d", dj_report->device_index);
267 strlcat(dj_hiddev->phys, tmpstr, sizeof(dj_hiddev->phys));
268
269 dj_dev = kzalloc(sizeof(struct dj_device), GFP_KERNEL);
270
271 if (!dj_dev) {
272 dev_err(&djrcv_hdev->dev, "%s: failed allocating dj_device\n",
273 __func__);
274 goto dj_device_allocate_fail;
275 }
276
277 dj_dev->reports_supported = get_unaligned_le32(
278 dj_report->report_params + DEVICE_PAIRED_RF_REPORT_TYPE);
279 dj_dev->hdev = dj_hiddev;
280 dj_dev->dj_receiver_dev = djrcv_dev;
281 dj_dev->device_index = dj_report->device_index;
282 dj_hiddev->driver_data = dj_dev;
283
284 djrcv_dev->paired_dj_devices[dj_report->device_index] = dj_dev;
285
286 if (hid_add_device(dj_hiddev)) {
287 dev_err(&djrcv_hdev->dev, "%s: failed adding dj_device\n",
288 __func__);
289 goto hid_add_device_fail;
290 }
291
292 return;
293
294 hid_add_device_fail:
295 djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
296 kfree(dj_dev);
297 dj_device_allocate_fail:
298 hid_destroy_device(dj_hiddev);
299 }
300
301 static void delayedwork_callback(struct work_struct *work)
302 {
303 struct dj_receiver_dev *djrcv_dev =
304 container_of(work, struct dj_receiver_dev, work);
305
306 struct dj_report dj_report;
307 unsigned long flags;
308 int count;
309 int retval;
310
311 dbg_hid("%s\n", __func__);
312
313 spin_lock_irqsave(&djrcv_dev->lock, flags);
314
315 count = kfifo_out(&djrcv_dev->notif_fifo, &dj_report,
316 sizeof(struct dj_report));
317
318 if (count != sizeof(struct dj_report)) {
319 dev_err(&djrcv_dev->hdev->dev, "%s: workitem triggered without "
320 "notifications available\n", __func__);
321 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
322 return;
323 }
324
325 if (!kfifo_is_empty(&djrcv_dev->notif_fifo)) {
326 if (schedule_work(&djrcv_dev->work) == 0) {
327 dbg_hid("%s: did not schedule the work item, was "
328 "already queued\n", __func__);
329 }
330 }
331
332 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
333
334 switch (dj_report.report_type) {
335 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
336 logi_dj_recv_add_djhid_device(djrcv_dev, &dj_report);
337 break;
338 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
339 logi_dj_recv_destroy_djhid_device(djrcv_dev, &dj_report);
340 break;
341 default:
342 /* A normal report (i. e. not belonging to a pair/unpair notification)
343 * arriving here, means that the report arrived but we did not have a
344 * paired dj_device associated to the report's device_index, this
345 * means that the original "device paired" notification corresponding
346 * to this dj_device never arrived to this driver. The reason is that
347 * hid-core discards all packets coming from a device while probe() is
348 * executing. */
349 if (!djrcv_dev->paired_dj_devices[dj_report.device_index]) {
350 /* ok, we don't know the device, just re-ask the
351 * receiver for the list of connected devices. */
352 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
353 if (!retval) {
354 /* everything went fine, so just leave */
355 break;
356 }
357 dev_err(&djrcv_dev->hdev->dev,
358 "%s:logi_dj_recv_query_paired_devices "
359 "error:%d\n", __func__, retval);
360 }
361 dbg_hid("%s: unexpected report type\n", __func__);
362 }
363 }
364
365 static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev,
366 struct dj_report *dj_report)
367 {
368 /* We are called from atomic context (tasklet && djrcv->lock held) */
369
370 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
371
372 if (schedule_work(&djrcv_dev->work) == 0) {
373 dbg_hid("%s: did not schedule the work item, was already "
374 "queued\n", __func__);
375 }
376 }
377
378 static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev,
379 struct dj_report *dj_report)
380 {
381 /* We are called from atomic context (tasklet && djrcv->lock held) */
382 unsigned int i;
383 u8 reportbuffer[MAX_REPORT_SIZE];
384 struct dj_device *djdev;
385
386 djdev = djrcv_dev->paired_dj_devices[dj_report->device_index];
387
388 if (!djdev) {
389 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
390 " is NULL, index %d\n", dj_report->device_index);
391 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
392
393 if (schedule_work(&djrcv_dev->work) == 0) {
394 dbg_hid("%s: did not schedule the work item, was already "
395 "queued\n", __func__);
396 }
397 return;
398 }
399
400 memset(reportbuffer, 0, sizeof(reportbuffer));
401
402 for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
403 if (djdev->reports_supported & (1 << i)) {
404 reportbuffer[0] = i;
405 if (hid_input_report(djdev->hdev,
406 HID_INPUT_REPORT,
407 reportbuffer,
408 hid_reportid_size_map[i], 1)) {
409 dbg_hid("hid_input_report error sending null "
410 "report\n");
411 }
412 }
413 }
414 }
415
416 static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
417 struct dj_report *dj_report)
418 {
419 /* We are called from atomic context (tasklet && djrcv->lock held) */
420 struct dj_device *dj_device;
421
422 dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
423
424 if (dj_device == NULL) {
425 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
426 " is NULL, index %d\n", dj_report->device_index);
427 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
428
429 if (schedule_work(&djrcv_dev->work) == 0) {
430 dbg_hid("%s: did not schedule the work item, was already "
431 "queued\n", __func__);
432 }
433 return;
434 }
435
436 if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) ||
437 (hid_reportid_size_map[dj_report->report_type] == 0)) {
438 dbg_hid("invalid report type:%x\n", dj_report->report_type);
439 return;
440 }
441
442 if (hid_input_report(dj_device->hdev,
443 HID_INPUT_REPORT, &dj_report->report_type,
444 hid_reportid_size_map[dj_report->report_type], 1)) {
445 dbg_hid("hid_input_report error\n");
446 }
447 }
448
449
450 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
451 struct dj_report *dj_report)
452 {
453 struct hid_device *hdev = djrcv_dev->hdev;
454 struct hid_report *report;
455 struct hid_report_enum *output_report_enum;
456 u8 *data = (u8 *)(&dj_report->device_index);
457 unsigned int i;
458
459 output_report_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
460 report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
461
462 if (!report) {
463 dev_err(&hdev->dev, "%s: unable to find dj report\n", __func__);
464 return -ENODEV;
465 }
466
467 for (i = 0; i < DJREPORT_SHORT_LENGTH - 1; i++)
468 report->field[0]->value[i] = data[i];
469
470 hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
471
472 return 0;
473 }
474
475 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
476 {
477 struct dj_report *dj_report;
478 int retval;
479
480 /* no need to protect djrcv_dev->querying_devices */
481 if (djrcv_dev->querying_devices)
482 return 0;
483
484 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
485 if (!dj_report)
486 return -ENOMEM;
487 dj_report->report_id = REPORT_ID_DJ_SHORT;
488 dj_report->device_index = 0xFF;
489 dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
490 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
491 kfree(dj_report);
492 return retval;
493 }
494
495
496 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
497 unsigned timeout)
498 {
499 struct dj_report *dj_report;
500 int retval;
501
502 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
503 if (!dj_report)
504 return -ENOMEM;
505 dj_report->report_id = REPORT_ID_DJ_SHORT;
506 dj_report->device_index = 0xFF;
507 dj_report->report_type = REPORT_TYPE_CMD_SWITCH;
508 dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
509 dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
510 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
511 kfree(dj_report);
512
513 /*
514 * Ugly sleep to work around a USB 3.0 bug when the receiver is still
515 * processing the "switch-to-dj" command while we send an other command.
516 * 50 msec should gives enough time to the receiver to be ready.
517 */
518 msleep(50);
519
520 return retval;
521 }
522
523
524 static int logi_dj_ll_open(struct hid_device *hid)
525 {
526 dbg_hid("%s:%s\n", __func__, hid->phys);
527 return 0;
528
529 }
530
531 static void logi_dj_ll_close(struct hid_device *hid)
532 {
533 dbg_hid("%s:%s\n", __func__, hid->phys);
534 }
535
536 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
537 size_t count,
538 unsigned char report_type)
539 {
540 /* Called by hid raw to send data */
541 dbg_hid("%s\n", __func__);
542
543 return 0;
544 }
545
546 static void rdcat(char **rdesc, unsigned int *rsize, const char *data, unsigned int size)
547 {
548 memcpy(*rdesc + *rsize, data, size);
549 *rsize += size;
550 }
551
552 static int logi_dj_ll_parse(struct hid_device *hid)
553 {
554 struct dj_device *djdev = hid->driver_data;
555 unsigned int rsize = 0;
556 char *rdesc;
557 int retval;
558
559 dbg_hid("%s\n", __func__);
560
561 djdev->hdev->version = 0x0111;
562 djdev->hdev->country = 0x00;
563
564 rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL);
565 if (!rdesc)
566 return -ENOMEM;
567
568 if (djdev->reports_supported & STD_KEYBOARD) {
569 dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n",
570 __func__, djdev->reports_supported);
571 rdcat(&rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor));
572 }
573
574 if (djdev->reports_supported & STD_MOUSE) {
575 dbg_hid("%s: sending a mouse descriptor, reports_supported: "
576 "%x\n", __func__, djdev->reports_supported);
577 rdcat(&rdesc, &rsize, mse_descriptor, sizeof(mse_descriptor));
578 }
579
580 if (djdev->reports_supported & MULTIMEDIA) {
581 dbg_hid("%s: sending a multimedia report descriptor: %x\n",
582 __func__, djdev->reports_supported);
583 rdcat(&rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor));
584 }
585
586 if (djdev->reports_supported & POWER_KEYS) {
587 dbg_hid("%s: sending a power keys report descriptor: %x\n",
588 __func__, djdev->reports_supported);
589 rdcat(&rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor));
590 }
591
592 if (djdev->reports_supported & MEDIA_CENTER) {
593 dbg_hid("%s: sending a media center report descriptor: %x\n",
594 __func__, djdev->reports_supported);
595 rdcat(&rdesc, &rsize, media_descriptor, sizeof(media_descriptor));
596 }
597
598 if (djdev->reports_supported & KBD_LEDS) {
599 dbg_hid("%s: need to send kbd leds report descriptor: %x\n",
600 __func__, djdev->reports_supported);
601 }
602
603 retval = hid_parse_report(hid, rdesc, rsize);
604 kfree(rdesc);
605
606 return retval;
607 }
608
609 static int logi_dj_ll_input_event(struct input_dev *dev, unsigned int type,
610 unsigned int code, int value)
611 {
612 /* Sent by the input layer to handle leds and Force Feedback */
613 struct hid_device *dj_hiddev = input_get_drvdata(dev);
614 struct dj_device *dj_dev = dj_hiddev->driver_data;
615
616 struct dj_receiver_dev *djrcv_dev =
617 dev_get_drvdata(dj_hiddev->dev.parent);
618 struct hid_device *dj_rcv_hiddev = djrcv_dev->hdev;
619 struct hid_report_enum *output_report_enum;
620
621 struct hid_field *field;
622 struct hid_report *report;
623 unsigned char *data;
624 int offset;
625
626 dbg_hid("%s: %s, type:%d | code:%d | value:%d\n",
627 __func__, dev->phys, type, code, value);
628
629 if (type != EV_LED)
630 return -1;
631
632 offset = hidinput_find_field(dj_hiddev, type, code, &field);
633
634 if (offset == -1) {
635 dev_warn(&dev->dev, "event field not found\n");
636 return -1;
637 }
638 hid_set_field(field, offset, value);
639
640 data = hid_alloc_report_buf(field->report, GFP_ATOMIC);
641 if (!data) {
642 dev_warn(&dev->dev, "failed to allocate report buf memory\n");
643 return -1;
644 }
645
646 hid_output_report(field->report, &data[0]);
647
648 output_report_enum = &dj_rcv_hiddev->report_enum[HID_OUTPUT_REPORT];
649 report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
650 hid_set_field(report->field[0], 0, dj_dev->device_index);
651 hid_set_field(report->field[0], 1, REPORT_TYPE_LEDS);
652 hid_set_field(report->field[0], 2, data[1]);
653
654 hid_hw_request(dj_rcv_hiddev, report, HID_REQ_SET_REPORT);
655
656 kfree(data);
657
658 return 0;
659 }
660
661 static int logi_dj_ll_start(struct hid_device *hid)
662 {
663 dbg_hid("%s\n", __func__);
664 return 0;
665 }
666
667 static void logi_dj_ll_stop(struct hid_device *hid)
668 {
669 dbg_hid("%s\n", __func__);
670 }
671
672
673 static struct hid_ll_driver logi_dj_ll_driver = {
674 .parse = logi_dj_ll_parse,
675 .start = logi_dj_ll_start,
676 .stop = logi_dj_ll_stop,
677 .open = logi_dj_ll_open,
678 .close = logi_dj_ll_close,
679 .hidinput_input_event = logi_dj_ll_input_event,
680 };
681
682
683 static int logi_dj_raw_event(struct hid_device *hdev,
684 struct hid_report *report, u8 *data,
685 int size)
686 {
687 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
688 struct dj_report *dj_report = (struct dj_report *) data;
689 unsigned long flags;
690 bool report_processed = false;
691
692 dbg_hid("%s, size:%d\n", __func__, size);
693
694 /* Here we receive all data coming from iface 2, there are 4 cases:
695 *
696 * 1) Data should continue its normal processing i.e. data does not
697 * come from the DJ collection, in which case we do nothing and
698 * return 0, so hid-core can continue normal processing (will forward
699 * to associated hidraw device)
700 *
701 * 2) Data is from DJ collection, and is intended for this driver i. e.
702 * data contains arrival, departure, etc notifications, in which case
703 * we queue them for delayed processing by the work queue. We return 1
704 * to hid-core as no further processing is required from it.
705 *
706 * 3) Data is from DJ collection, and informs a connection change,
707 * if the change means rf link loss, then we must send a null report
708 * to the upper layer to discard potentially pressed keys that may be
709 * repeated forever by the input layer. Return 1 to hid-core as no
710 * further processing is required.
711 *
712 * 4) Data is from DJ collection and is an actual input event from
713 * a paired DJ device in which case we forward it to the correct hid
714 * device (via hid_input_report() ) and return 1 so hid-core does not do
715 * anything else with it.
716 */
717 if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
718 (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
719 dev_err(&hdev->dev, "%s: invalid device index:%d\n",
720 __func__, dj_report->device_index);
721 return false;
722 }
723
724 spin_lock_irqsave(&djrcv_dev->lock, flags);
725 if (dj_report->report_id == REPORT_ID_DJ_SHORT) {
726 switch (dj_report->report_type) {
727 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
728 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
729 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
730 break;
731 case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
732 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
733 STATUS_LINKLOSS) {
734 logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
735 }
736 break;
737 default:
738 logi_dj_recv_forward_report(djrcv_dev, dj_report);
739 }
740 report_processed = true;
741 }
742 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
743
744 return report_processed;
745 }
746
747 static int logi_dj_probe(struct hid_device *hdev,
748 const struct hid_device_id *id)
749 {
750 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
751 struct dj_receiver_dev *djrcv_dev;
752 int retval;
753
754 if (is_dj_device((struct dj_device *)hdev->driver_data))
755 return -ENODEV;
756
757 dbg_hid("%s called for ifnum %d\n", __func__,
758 intf->cur_altsetting->desc.bInterfaceNumber);
759
760 /* Ignore interfaces 0 and 1, they will not carry any data, dont create
761 * any hid_device for them */
762 if (intf->cur_altsetting->desc.bInterfaceNumber !=
763 LOGITECH_DJ_INTERFACE_NUMBER) {
764 dbg_hid("%s: ignoring ifnum %d\n", __func__,
765 intf->cur_altsetting->desc.bInterfaceNumber);
766 return -ENODEV;
767 }
768
769 /* Treat interface 2 */
770
771 djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL);
772 if (!djrcv_dev) {
773 dev_err(&hdev->dev,
774 "%s:failed allocating dj_receiver_dev\n", __func__);
775 return -ENOMEM;
776 }
777 djrcv_dev->hdev = hdev;
778 INIT_WORK(&djrcv_dev->work, delayedwork_callback);
779 spin_lock_init(&djrcv_dev->lock);
780 if (kfifo_alloc(&djrcv_dev->notif_fifo,
781 DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report),
782 GFP_KERNEL)) {
783 dev_err(&hdev->dev,
784 "%s:failed allocating notif_fifo\n", __func__);
785 kfree(djrcv_dev);
786 return -ENOMEM;
787 }
788 hid_set_drvdata(hdev, djrcv_dev);
789
790 /* Call to usbhid to fetch the HID descriptors of interface 2 and
791 * subsequently call to the hid/hid-core to parse the fetched
792 * descriptors, this will in turn create the hidraw and hiddev nodes
793 * for interface 2 of the receiver */
794 retval = hid_parse(hdev);
795 if (retval) {
796 dev_err(&hdev->dev,
797 "%s:parse of interface 2 failed\n", __func__);
798 goto hid_parse_fail;
799 }
800
801 if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, REPORT_ID_DJ_SHORT,
802 0, DJREPORT_SHORT_LENGTH - 1)) {
803 retval = -ENODEV;
804 goto hid_parse_fail;
805 }
806
807 /* Starts the usb device and connects to upper interfaces hiddev and
808 * hidraw */
809 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
810 if (retval) {
811 dev_err(&hdev->dev,
812 "%s:hid_hw_start returned error\n", __func__);
813 goto hid_hw_start_fail;
814 }
815
816 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
817 if (retval < 0) {
818 dev_err(&hdev->dev,
819 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
820 __func__, retval);
821 goto switch_to_dj_mode_fail;
822 }
823
824 /* This is enabling the polling urb on the IN endpoint */
825 retval = hid_hw_open(hdev);
826 if (retval < 0) {
827 dev_err(&hdev->dev, "%s:hid_hw_open returned error:%d\n",
828 __func__, retval);
829 goto llopen_failed;
830 }
831
832 /* Allow incoming packets to arrive: */
833 hid_device_io_start(hdev);
834
835 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
836 if (retval < 0) {
837 dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices "
838 "error:%d\n", __func__, retval);
839 goto logi_dj_recv_query_paired_devices_failed;
840 }
841
842 return retval;
843
844 logi_dj_recv_query_paired_devices_failed:
845 hid_hw_close(hdev);
846
847 llopen_failed:
848 switch_to_dj_mode_fail:
849 hid_hw_stop(hdev);
850
851 hid_hw_start_fail:
852 hid_parse_fail:
853 kfifo_free(&djrcv_dev->notif_fifo);
854 kfree(djrcv_dev);
855 hid_set_drvdata(hdev, NULL);
856 return retval;
857
858 }
859
860 #ifdef CONFIG_PM
861 static int logi_dj_reset_resume(struct hid_device *hdev)
862 {
863 int retval;
864 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
865
866 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
867 if (retval < 0) {
868 dev_err(&hdev->dev,
869 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
870 __func__, retval);
871 }
872
873 return 0;
874 }
875 #endif
876
877 static void logi_dj_remove(struct hid_device *hdev)
878 {
879 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
880 struct dj_device *dj_dev;
881 int i;
882
883 dbg_hid("%s\n", __func__);
884
885 cancel_work_sync(&djrcv_dev->work);
886
887 hid_hw_close(hdev);
888 hid_hw_stop(hdev);
889
890 /* I suppose that at this point the only context that can access
891 * the djrecv_data is this thread as the work item is guaranteed to
892 * have finished and no more raw_event callbacks should arrive after
893 * the remove callback was triggered so no locks are put around the
894 * code below */
895 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
896 dj_dev = djrcv_dev->paired_dj_devices[i];
897 if (dj_dev != NULL) {
898 hid_destroy_device(dj_dev->hdev);
899 kfree(dj_dev);
900 djrcv_dev->paired_dj_devices[i] = NULL;
901 }
902 }
903
904 kfifo_free(&djrcv_dev->notif_fifo);
905 kfree(djrcv_dev);
906 hid_set_drvdata(hdev, NULL);
907 }
908
909 static int logi_djdevice_probe(struct hid_device *hdev,
910 const struct hid_device_id *id)
911 {
912 int ret;
913 struct dj_device *dj_dev = hdev->driver_data;
914
915 if (!is_dj_device(dj_dev))
916 return -ENODEV;
917
918 ret = hid_parse(hdev);
919 if (!ret)
920 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
921
922 return ret;
923 }
924
925 static const struct hid_device_id logi_dj_receivers[] = {
926 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
927 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
928 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
929 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
930 {}
931 };
932
933 MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
934
935 static struct hid_driver logi_djreceiver_driver = {
936 .name = "logitech-djreceiver",
937 .id_table = logi_dj_receivers,
938 .probe = logi_dj_probe,
939 .remove = logi_dj_remove,
940 .raw_event = logi_dj_raw_event,
941 #ifdef CONFIG_PM
942 .reset_resume = logi_dj_reset_resume,
943 #endif
944 };
945
946
947 static const struct hid_device_id logi_dj_devices[] = {
948 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
949 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
950 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
951 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
952 {}
953 };
954
955 static struct hid_driver logi_djdevice_driver = {
956 .name = "logitech-djdevice",
957 .id_table = logi_dj_devices,
958 .probe = logi_djdevice_probe,
959 };
960
961
962 static int __init logi_dj_init(void)
963 {
964 int retval;
965
966 dbg_hid("Logitech-DJ:%s\n", __func__);
967
968 retval = hid_register_driver(&logi_djreceiver_driver);
969 if (retval)
970 return retval;
971
972 retval = hid_register_driver(&logi_djdevice_driver);
973 if (retval)
974 hid_unregister_driver(&logi_djreceiver_driver);
975
976 return retval;
977
978 }
979
980 static void __exit logi_dj_exit(void)
981 {
982 dbg_hid("Logitech-DJ:%s\n", __func__);
983
984 hid_unregister_driver(&logi_djdevice_driver);
985 hid_unregister_driver(&logi_djreceiver_driver);
986
987 }
988
989 module_init(logi_dj_init);
990 module_exit(logi_dj_exit);
991 MODULE_LICENSE("GPL");
992 MODULE_AUTHOR("Logitech");
993 MODULE_AUTHOR("Nestor Lopez Casado");
994 MODULE_AUTHOR("nlopezcasad@logitech.com");
Linux with added FPC-III support