2 * HID driver for Logitech Unifying receivers
4 * Copyright (c) 2011 Logitech
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.
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.
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
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 "usbhid/usbhid.h"
32 #include "hid-logitech-dj.h"
34 /* Keyboard descriptor (1) */
35 static const char kbd_descriptor[] = {
36 0x05, 0x01, /* USAGE_PAGE (generic Desktop) */
37 0x09, 0x06, /* USAGE (Keyboard) */
38 0xA1, 0x01, /* COLLECTION (Application) */
39 0x85, 0x01, /* REPORT_ID (1) */
40 0x95, 0x08, /* REPORT_COUNT (8) */
41 0x75, 0x01, /* REPORT_SIZE (1) */
42 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
43 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
44 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
45 0x19, 0xE0, /* USAGE_MINIMUM (Left Control) */
46 0x29, 0xE7, /* USAGE_MAXIMUM (Right GUI) */
47 0x81, 0x02, /* INPUT (Data,Var,Abs) */
48 0x95, 0x05, /* REPORT COUNT (5) */
49 0x05, 0x08, /* USAGE PAGE (LED page) */
50 0x19, 0x01, /* USAGE MINIMUM (1) */
51 0x29, 0x05, /* USAGE MAXIMUM (5) */
52 0x91, 0x02, /* OUTPUT (Data, Variable, Absolute) */
53 0x95, 0x01, /* REPORT COUNT (1) */
54 0x75, 0x03, /* REPORT SIZE (3) */
55 0x91, 0x01, /* OUTPUT (Constant) */
56 0x95, 0x06, /* REPORT_COUNT (6) */
57 0x75, 0x08, /* REPORT_SIZE (8) */
58 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
59 0x26, 0xFF, 0x00, /* LOGICAL_MAXIMUM (255) */
60 0x05, 0x07, /* USAGE_PAGE (Keyboard) */
61 0x19, 0x00, /* USAGE_MINIMUM (no event) */
62 0x2A, 0xFF, 0x00, /* USAGE_MAXIMUM (reserved) */
63 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
67 /* Mouse descriptor (2) */
68 static const char mse_descriptor[] = {
69 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
70 0x09, 0x02, /* USAGE (Mouse) */
71 0xA1, 0x01, /* COLLECTION (Application) */
72 0x85, 0x02, /* REPORT_ID = 2 */
73 0x09, 0x01, /* USAGE (pointer) */
74 0xA1, 0x00, /* COLLECTION (physical) */
75 0x05, 0x09, /* USAGE_PAGE (buttons) */
76 0x19, 0x01, /* USAGE_MIN (1) */
77 0x29, 0x10, /* USAGE_MAX (16) */
78 0x15, 0x00, /* LOGICAL_MIN (0) */
79 0x25, 0x01, /* LOGICAL_MAX (1) */
80 0x95, 0x10, /* REPORT_COUNT (16) */
81 0x75, 0x01, /* REPORT_SIZE (1) */
82 0x81, 0x02, /* INPUT (data var abs) */
83 0x05, 0x01, /* USAGE_PAGE (generic desktop) */
84 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */
85 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */
86 0x75, 0x0C, /* REPORT_SIZE (12) */
87 0x95, 0x02, /* REPORT_COUNT (2) */
88 0x09, 0x30, /* USAGE (X) */
89 0x09, 0x31, /* USAGE (Y) */
90 0x81, 0x06, /* INPUT */
91 0x15, 0x81, /* LOGICAL_MIN (-127) */
92 0x25, 0x7F, /* LOGICAL_MAX (127) */
93 0x75, 0x08, /* REPORT_SIZE (8) */
94 0x95, 0x01, /* REPORT_COUNT (1) */
95 0x09, 0x38, /* USAGE (wheel) */
96 0x81, 0x06, /* INPUT */
97 0x05, 0x0C, /* USAGE_PAGE(consumer) */
98 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */
99 0x95, 0x01, /* REPORT_COUNT (1) */
100 0x81, 0x06, /* INPUT */
101 0xC0, /* END_COLLECTION */
102 0xC0, /* END_COLLECTION */
105 /* Consumer Control descriptor (3) */
106 static const char consumer_descriptor[] = {
107 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */
108 0x09, 0x01, /* USAGE (Consumer Control) */
109 0xA1, 0x01, /* COLLECTION (Application) */
110 0x85, 0x03, /* REPORT_ID = 3 */
111 0x75, 0x10, /* REPORT_SIZE (16) */
112 0x95, 0x02, /* REPORT_COUNT (2) */
113 0x15, 0x01, /* LOGICAL_MIN (1) */
114 0x26, 0x8C, 0x02, /* LOGICAL_MAX (652) */
115 0x19, 0x01, /* USAGE_MIN (1) */
116 0x2A, 0x8C, 0x02, /* USAGE_MAX (652) */
117 0x81, 0x00, /* INPUT (Data Ary Abs) */
118 0xC0, /* END_COLLECTION */
121 /* System control descriptor (4) */
122 static const char syscontrol_descriptor[] = {
123 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
124 0x09, 0x80, /* USAGE (System Control) */
125 0xA1, 0x01, /* COLLECTION (Application) */
126 0x85, 0x04, /* REPORT_ID = 4 */
127 0x75, 0x02, /* REPORT_SIZE (2) */
128 0x95, 0x01, /* REPORT_COUNT (1) */
129 0x15, 0x01, /* LOGICAL_MIN (1) */
130 0x25, 0x03, /* LOGICAL_MAX (3) */
131 0x09, 0x82, /* USAGE (System Sleep) */
132 0x09, 0x81, /* USAGE (System Power Down) */
133 0x09, 0x83, /* USAGE (System Wake Up) */
134 0x81, 0x60, /* INPUT (Data Ary Abs NPrf Null) */
135 0x75, 0x06, /* REPORT_SIZE (6) */
136 0x81, 0x03, /* INPUT (Cnst Var Abs) */
137 0xC0, /* END_COLLECTION */
140 /* Media descriptor (8) */
141 static const char media_descriptor[] = {
142 0x06, 0xbc, 0xff, /* Usage Page 0xffbc */
143 0x09, 0x88, /* Usage 0x0088 */
144 0xa1, 0x01, /* BeginCollection */
145 0x85, 0x08, /* Report ID 8 */
146 0x19, 0x01, /* Usage Min 0x0001 */
147 0x29, 0xff, /* Usage Max 0x00ff */
148 0x15, 0x01, /* Logical Min 1 */
149 0x26, 0xff, 0x00, /* Logical Max 255 */
150 0x75, 0x08, /* Report Size 8 */
151 0x95, 0x01, /* Report Count 1 */
152 0x81, 0x00, /* Input */
153 0xc0, /* EndCollection */
156 /* Maximum size of all defined hid reports in bytes (including report id) */
157 #define MAX_REPORT_SIZE 8
159 /* Number of possible hid report types that can be created by this driver.
161 * Right now, RF report types have the same report types (or report id's)
162 * than the hid report created from those RF reports. In the future
163 * this doesnt have to be true.
165 * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds
166 * to hid report id 0x01, this is standard keyboard. Same thing applies to mice
167 * reports and consumer control, etc. If a new RF report is created, it doesn't
168 * has to have the same report id as its corresponding hid report, so an
169 * translation may have to take place for future report types.
171 #define NUMBER_OF_HID_REPORTS 32
172 static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = {
173 [1] = 8, /* Standard keyboard */
174 [2] = 8, /* Standard mouse */
175 [3] = 5, /* Consumer control */
176 [4] = 2, /* System control */
177 [8] = 2, /* Media Center */
181 #define LOGITECH_DJ_INTERFACE_NUMBER 0x02
183 static struct hid_ll_driver logi_dj_ll_driver;
185 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
187 unsigned char report_type);
188 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev);
190 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
191 struct dj_report *dj_report)
193 /* Called in delayed work context */
194 struct dj_device *dj_dev;
197 spin_lock_irqsave(&djrcv_dev->lock, flags);
198 dj_dev = djrcv_dev->paired_dj_devices[dj_report->device_index];
199 djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
200 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
202 if (dj_dev != NULL) {
203 hid_destroy_device(dj_dev->hdev);
206 dev_err(&djrcv_dev->hdev->dev, "%s: can't destroy a NULL device\n",
211 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
212 struct dj_report *dj_report)
214 /* Called in delayed work context */
215 struct hid_device *djrcv_hdev = djrcv_dev->hdev;
216 struct usb_interface *intf = to_usb_interface(djrcv_hdev->dev.parent);
217 struct usb_device *usbdev = interface_to_usbdev(intf);
218 struct hid_device *dj_hiddev;
219 struct dj_device *dj_dev;
221 /* Device index goes from 1 to 6, we need 3 bytes to store the
222 * semicolon, the index, and a null terminator
224 unsigned char tmpstr[3];
226 if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] &
227 SPFUNCTION_DEVICE_LIST_EMPTY) {
228 dbg_hid("%s: device list is empty\n", __func__);
229 djrcv_dev->querying_devices = false;
233 if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
234 (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
235 dev_err(&djrcv_hdev->dev, "%s: invalid device index:%d\n",
236 __func__, dj_report->device_index);
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__);
246 dj_hiddev = hid_allocate_device();
247 if (IS_ERR(dj_hiddev)) {
248 dev_err(&djrcv_hdev->dev, "%s: hid_allocate_device failed\n",
253 dj_hiddev->ll_driver = &logi_dj_ll_driver;
254 dj_hiddev->hid_output_raw_report = logi_dj_output_hidraw_report;
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]);
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));
269 dj_dev = kzalloc(sizeof(struct dj_device), GFP_KERNEL);
272 dev_err(&djrcv_hdev->dev, "%s: failed allocating dj_device\n",
274 goto dj_device_allocate_fail;
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;
284 djrcv_dev->paired_dj_devices[dj_report->device_index] = dj_dev;
286 if (hid_add_device(dj_hiddev)) {
287 dev_err(&djrcv_hdev->dev, "%s: failed adding dj_device\n",
289 goto hid_add_device_fail;
295 djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
297 dj_device_allocate_fail:
298 hid_destroy_device(dj_hiddev);
301 static void delayedwork_callback(struct work_struct *work)
303 struct dj_receiver_dev *djrcv_dev =
304 container_of(work, struct dj_receiver_dev, work);
306 struct dj_report dj_report;
311 dbg_hid("%s\n", __func__);
313 spin_lock_irqsave(&djrcv_dev->lock, flags);
315 count = kfifo_out(&djrcv_dev->notif_fifo, &dj_report,
316 sizeof(struct dj_report));
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);
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__);
332 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
334 switch (dj_report.report_type) {
335 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
336 logi_dj_recv_add_djhid_device(djrcv_dev, &dj_report);
338 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
339 logi_dj_recv_destroy_djhid_device(djrcv_dev, &dj_report);
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
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);
354 /* everything went fine, so just leave */
357 dev_err(&djrcv_dev->hdev->dev,
358 "%s:logi_dj_recv_query_paired_devices "
359 "error:%d\n", __func__, retval);
361 dbg_hid("%s: unexpected report type\n", __func__);
365 static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev,
366 struct dj_report *dj_report)
368 /* We are called from atomic context (tasklet && djrcv->lock held) */
370 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
372 if (schedule_work(&djrcv_dev->work) == 0) {
373 dbg_hid("%s: did not schedule the work item, was already "
374 "queued\n", __func__);
378 static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev,
379 struct dj_report *dj_report)
381 /* We are called from atomic context (tasklet && djrcv->lock held) */
383 u8 reportbuffer[MAX_REPORT_SIZE];
384 struct dj_device *djdev;
386 djdev = djrcv_dev->paired_dj_devices[dj_report->device_index];
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));
393 if (schedule_work(&djrcv_dev->work) == 0) {
394 dbg_hid("%s: did not schedule the work item, was already "
395 "queued\n", __func__);
400 memset(reportbuffer, 0, sizeof(reportbuffer));
402 for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
403 if (djdev->reports_supported & (1 << i)) {
405 if (hid_input_report(djdev->hdev,
408 hid_reportid_size_map[i], 1)) {
409 dbg_hid("hid_input_report error sending null "
416 static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
417 struct dj_report *dj_report)
419 /* We are called from atomic context (tasklet && djrcv->lock held) */
420 struct dj_device *dj_device;
422 dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
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));
429 if (schedule_work(&djrcv_dev->work) == 0) {
430 dbg_hid("%s: did not schedule the work item, was already "
431 "queued\n", __func__);
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);
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");
450 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
451 struct dj_report *dj_report)
453 struct hid_device *hdev = djrcv_dev->hdev;
456 if (!hdev->hid_output_raw_report) {
457 dev_err(&hdev->dev, "%s:"
458 "hid_output_raw_report is null\n", __func__);
462 sent_bytes = hdev->hid_output_raw_report(hdev, (u8 *) dj_report,
463 sizeof(struct dj_report),
466 return (sent_bytes < 0) ? sent_bytes : 0;
469 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
471 struct dj_report *dj_report;
474 /* no need to protect djrcv_dev->querying_devices */
475 if (djrcv_dev->querying_devices)
478 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
481 dj_report->report_id = REPORT_ID_DJ_SHORT;
482 dj_report->device_index = 0xFF;
483 dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
484 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
490 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
493 struct dj_report *dj_report;
496 dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
499 dj_report->report_id = REPORT_ID_DJ_SHORT;
500 dj_report->device_index = 0xFF;
501 dj_report->report_type = REPORT_TYPE_CMD_SWITCH;
502 dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
503 dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
504 retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
510 static int logi_dj_ll_open(struct hid_device *hid)
512 dbg_hid("%s:%s\n", __func__, hid->phys);
517 static void logi_dj_ll_close(struct hid_device *hid)
519 dbg_hid("%s:%s\n", __func__, hid->phys);
522 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
524 unsigned char report_type)
526 /* Called by hid raw to send data */
527 dbg_hid("%s\n", __func__);
532 static int logi_dj_ll_parse(struct hid_device *hid)
534 struct dj_device *djdev = hid->driver_data;
537 dbg_hid("%s\n", __func__);
539 djdev->hdev->version = 0x0111;
540 djdev->hdev->country = 0x00;
542 if (djdev->reports_supported & STD_KEYBOARD) {
543 dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n",
544 __func__, djdev->reports_supported);
545 retval = hid_parse_report(hid,
546 (u8 *) kbd_descriptor,
547 sizeof(kbd_descriptor));
549 dbg_hid("%s: sending a kbd descriptor, hid_parse failed"
550 " error: %d\n", __func__, retval);
555 if (djdev->reports_supported & STD_MOUSE) {
556 dbg_hid("%s: sending a mouse descriptor, reports_supported: "
557 "%x\n", __func__, djdev->reports_supported);
558 retval = hid_parse_report(hid,
559 (u8 *) mse_descriptor,
560 sizeof(mse_descriptor));
562 dbg_hid("%s: sending a mouse descriptor, hid_parse "
563 "failed error: %d\n", __func__, retval);
568 if (djdev->reports_supported & MULTIMEDIA) {
569 dbg_hid("%s: sending a multimedia report descriptor: %x\n",
570 __func__, djdev->reports_supported);
571 retval = hid_parse_report(hid,
572 (u8 *) consumer_descriptor,
573 sizeof(consumer_descriptor));
575 dbg_hid("%s: sending a consumer_descriptor, hid_parse "
576 "failed error: %d\n", __func__, retval);
581 if (djdev->reports_supported & POWER_KEYS) {
582 dbg_hid("%s: sending a power keys report descriptor: %x\n",
583 __func__, djdev->reports_supported);
584 retval = hid_parse_report(hid,
585 (u8 *) syscontrol_descriptor,
586 sizeof(syscontrol_descriptor));
588 dbg_hid("%s: sending a syscontrol_descriptor, "
589 "hid_parse failed error: %d\n",
595 if (djdev->reports_supported & MEDIA_CENTER) {
596 dbg_hid("%s: sending a media center report descriptor: %x\n",
597 __func__, djdev->reports_supported);
598 retval = hid_parse_report(hid,
599 (u8 *) media_descriptor,
600 sizeof(media_descriptor));
602 dbg_hid("%s: sending a media_descriptor, hid_parse "
603 "failed error: %d\n", __func__, retval);
608 if (djdev->reports_supported & KBD_LEDS) {
609 dbg_hid("%s: need to send kbd leds report descriptor: %x\n",
610 __func__, djdev->reports_supported);
616 static int logi_dj_ll_input_event(struct input_dev *dev, unsigned int type,
617 unsigned int code, int value)
619 /* Sent by the input layer to handle leds and Force Feedback */
620 struct hid_device *dj_hiddev = input_get_drvdata(dev);
621 struct dj_device *dj_dev = dj_hiddev->driver_data;
623 struct dj_receiver_dev *djrcv_dev =
624 dev_get_drvdata(dj_hiddev->dev.parent);
625 struct hid_device *dj_rcv_hiddev = djrcv_dev->hdev;
626 struct hid_report_enum *output_report_enum;
628 struct hid_field *field;
629 struct hid_report *report;
630 unsigned char data[8];
633 dbg_hid("%s: %s, type:%d | code:%d | value:%d\n",
634 __func__, dev->phys, type, code, value);
639 offset = hidinput_find_field(dj_hiddev, type, code, &field);
642 dev_warn(&dev->dev, "event field not found\n");
645 hid_set_field(field, offset, value);
646 hid_output_report(field->report, &data[0]);
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]);
654 usbhid_submit_report(dj_rcv_hiddev, report, USB_DIR_OUT);
660 static int logi_dj_ll_start(struct hid_device *hid)
662 dbg_hid("%s\n", __func__);
666 static void logi_dj_ll_stop(struct hid_device *hid)
668 dbg_hid("%s\n", __func__);
672 static struct hid_ll_driver logi_dj_ll_driver = {
673 .parse = logi_dj_ll_parse,
674 .start = logi_dj_ll_start,
675 .stop = logi_dj_ll_stop,
676 .open = logi_dj_ll_open,
677 .close = logi_dj_ll_close,
678 .hidinput_input_event = logi_dj_ll_input_event,
682 static int logi_dj_raw_event(struct hid_device *hdev,
683 struct hid_report *report, u8 *data,
686 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
687 struct dj_report *dj_report = (struct dj_report *) data;
689 bool report_processed = false;
691 dbg_hid("%s, size:%d\n", __func__, size);
693 /* Here we receive all data coming from iface 2, there are 4 cases:
695 * 1) Data should continue its normal processing i.e. data does not
696 * come from the DJ collection, in which case we do nothing and
697 * return 0, so hid-core can continue normal processing (will forward
698 * to associated hidraw device)
700 * 2) Data is from DJ collection, and is intended for this driver i. e.
701 * data contains arrival, departure, etc notifications, in which case
702 * we queue them for delayed processing by the work queue. We return 1
703 * to hid-core as no further processing is required from it.
705 * 3) Data is from DJ collection, and informs a connection change,
706 * if the change means rf link loss, then we must send a null report
707 * to the upper layer to discard potentially pressed keys that may be
708 * repeated forever by the input layer. Return 1 to hid-core as no
709 * further processing is required.
711 * 4) Data is from DJ collection and is an actual input event from
712 * a paired DJ device in which case we forward it to the correct hid
713 * device (via hid_input_report() ) and return 1 so hid-core does not do
714 * anything else with it.
717 spin_lock_irqsave(&djrcv_dev->lock, flags);
718 if (dj_report->report_id == REPORT_ID_DJ_SHORT) {
719 switch (dj_report->report_type) {
720 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
721 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
722 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
724 case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
725 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
727 logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
731 logi_dj_recv_forward_report(djrcv_dev, dj_report);
733 report_processed = true;
735 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
737 return report_processed;
740 static int logi_dj_probe(struct hid_device *hdev,
741 const struct hid_device_id *id)
743 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
744 struct dj_receiver_dev *djrcv_dev;
747 if (is_dj_device((struct dj_device *)hdev->driver_data))
750 dbg_hid("%s called for ifnum %d\n", __func__,
751 intf->cur_altsetting->desc.bInterfaceNumber);
753 /* Ignore interfaces 0 and 1, they will not carry any data, dont create
754 * any hid_device for them */
755 if (intf->cur_altsetting->desc.bInterfaceNumber !=
756 LOGITECH_DJ_INTERFACE_NUMBER) {
757 dbg_hid("%s: ignoring ifnum %d\n", __func__,
758 intf->cur_altsetting->desc.bInterfaceNumber);
762 /* Treat interface 2 */
764 djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL);
767 "%s:failed allocating dj_receiver_dev\n", __func__);
770 djrcv_dev->hdev = hdev;
771 INIT_WORK(&djrcv_dev->work, delayedwork_callback);
772 spin_lock_init(&djrcv_dev->lock);
773 if (kfifo_alloc(&djrcv_dev->notif_fifo,
774 DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report),
777 "%s:failed allocating notif_fifo\n", __func__);
781 hid_set_drvdata(hdev, djrcv_dev);
783 /* Call to usbhid to fetch the HID descriptors of interface 2 and
784 * subsequently call to the hid/hid-core to parse the fetched
785 * descriptors, this will in turn create the hidraw and hiddev nodes
786 * for interface 2 of the receiver */
787 retval = hid_parse(hdev);
790 "%s:parse of interface 2 failed\n", __func__);
794 /* Starts the usb device and connects to upper interfaces hiddev and
796 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
799 "%s:hid_hw_start returned error\n", __func__);
800 goto hid_hw_start_fail;
803 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
806 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
808 goto switch_to_dj_mode_fail;
811 /* This is enabling the polling urb on the IN endpoint */
812 retval = hdev->ll_driver->open(hdev);
814 dev_err(&hdev->dev, "%s:hdev->ll_driver->open returned "
815 "error:%d\n", __func__, retval);
819 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
821 dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices "
822 "error:%d\n", __func__, retval);
823 goto logi_dj_recv_query_paired_devices_failed;
828 logi_dj_recv_query_paired_devices_failed:
829 hdev->ll_driver->close(hdev);
832 switch_to_dj_mode_fail:
837 kfifo_free(&djrcv_dev->notif_fifo);
839 hid_set_drvdata(hdev, NULL);
845 static int logi_dj_reset_resume(struct hid_device *hdev)
848 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
850 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
853 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
861 static void logi_dj_remove(struct hid_device *hdev)
863 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
864 struct dj_device *dj_dev;
867 dbg_hid("%s\n", __func__);
869 cancel_work_sync(&djrcv_dev->work);
871 hdev->ll_driver->close(hdev);
874 /* I suppose that at this point the only context that can access
875 * the djrecv_data is this thread as the work item is guaranteed to
876 * have finished and no more raw_event callbacks should arrive after
877 * the remove callback was triggered so no locks are put around the
879 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
880 dj_dev = djrcv_dev->paired_dj_devices[i];
881 if (dj_dev != NULL) {
882 hid_destroy_device(dj_dev->hdev);
884 djrcv_dev->paired_dj_devices[i] = NULL;
888 kfifo_free(&djrcv_dev->notif_fifo);
890 hid_set_drvdata(hdev, NULL);
893 static int logi_djdevice_probe(struct hid_device *hdev,
894 const struct hid_device_id *id)
897 struct dj_device *dj_dev = hdev->driver_data;
899 if (!is_dj_device(dj_dev))
902 ret = hid_parse(hdev);
904 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
909 static const struct hid_device_id logi_dj_receivers[] = {
910 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
911 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
912 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
913 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
917 MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
919 static struct hid_driver logi_djreceiver_driver = {
920 .name = "logitech-djreceiver",
921 .id_table = logi_dj_receivers,
922 .probe = logi_dj_probe,
923 .remove = logi_dj_remove,
924 .raw_event = logi_dj_raw_event,
926 .reset_resume = logi_dj_reset_resume,
931 static const struct hid_device_id logi_dj_devices[] = {
932 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
933 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
934 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
935 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
939 static struct hid_driver logi_djdevice_driver = {
940 .name = "logitech-djdevice",
941 .id_table = logi_dj_devices,
942 .probe = logi_djdevice_probe,
946 static int __init logi_dj_init(void)
950 dbg_hid("Logitech-DJ:%s\n", __func__);
952 retval = hid_register_driver(&logi_djreceiver_driver);
956 retval = hid_register_driver(&logi_djdevice_driver);
958 hid_unregister_driver(&logi_djreceiver_driver);
964 static void __exit logi_dj_exit(void)
966 dbg_hid("Logitech-DJ:%s\n", __func__);
968 hid_unregister_driver(&logi_djdevice_driver);
969 hid_unregister_driver(&logi_djreceiver_driver);
973 module_init(logi_dj_init);
974 module_exit(logi_dj_exit);
975 MODULE_LICENSE("GPL");
976 MODULE_AUTHOR("Logitech");
977 MODULE_AUTHOR("Nestor Lopez Casado");
978 MODULE_AUTHOR("nlopezcasad@logitech.com");