staging: comedi: amplc_pc236: Replace printk calls
[linux-2.6/btrfs-unstable.git] / drivers / hid / hid-logitech-dj.c
blob5e8a7ed42344d67d1c874fe3e3242766aed1b537
1 /*
2 * HID driver for Logitech Unifying receivers
4 * Copyright (c) 2011 Logitech
5 */
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.
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"
31 #include "hid-ids.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) */
64 0xC0
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 */
119 }; /* */
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 */
154 }; /* */
156 /* Maximum size of all defined hid reports in bytes (including report id) */
157 #define MAX_REPORT_SIZE 8
159 /* Make sure all descriptors are present here */
160 #define MAX_RDESC_SIZE \
161 (sizeof(kbd_descriptor) + \
162 sizeof(mse_descriptor) + \
163 sizeof(consumer_descriptor) + \
164 sizeof(syscontrol_descriptor) + \
165 sizeof(media_descriptor))
167 /* Number of possible hid report types that can be created by this driver.
169 * Right now, RF report types have the same report types (or report id's)
170 * than the hid report created from those RF reports. In the future
171 * this doesnt have to be true.
173 * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds
174 * to hid report id 0x01, this is standard keyboard. Same thing applies to mice
175 * reports and consumer control, etc. If a new RF report is created, it doesn't
176 * has to have the same report id as its corresponding hid report, so an
177 * translation may have to take place for future report types.
179 #define NUMBER_OF_HID_REPORTS 32
180 static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = {
181 [1] = 8, /* Standard keyboard */
182 [2] = 8, /* Standard mouse */
183 [3] = 5, /* Consumer control */
184 [4] = 2, /* System control */
185 [8] = 2, /* Media Center */
189 #define LOGITECH_DJ_INTERFACE_NUMBER 0x02
191 static struct hid_ll_driver logi_dj_ll_driver;
193 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
194 size_t count,
195 unsigned char report_type);
197 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
198 struct dj_report *dj_report)
200 /* Called in delayed work context */
201 struct dj_device *dj_dev;
202 unsigned long flags;
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);
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__);
218 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
219 struct dj_report *dj_report)
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;
228 /* Device index goes from 1 to 6, we need 3 bytes to store the
229 * semicolon, the index, and a null terminator
231 unsigned char tmpstr[3];
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 return;
239 if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
240 (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
241 dev_err(&djrcv_hdev->dev, "%s: invalid device index:%d\n",
242 __func__, dj_report->device_index);
243 return;
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;
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);
271 if (!dj_dev) {
272 dev_err(&djrcv_hdev->dev, "%s: failed allocating dj_device\n",
273 __func__);
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",
288 __func__);
289 goto hid_add_device_fail;
292 return;
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);
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;
307 unsigned long flags;
308 int count;
310 dbg_hid("%s\n", __func__);
312 spin_lock_irqsave(&djrcv_dev->lock, flags);
314 count = kfifo_out(&djrcv_dev->notif_fifo, &dj_report,
315 sizeof(struct dj_report));
317 if (count != sizeof(struct dj_report)) {
318 dev_err(&djrcv_dev->hdev->dev, "%s: workitem triggered without "
319 "notifications available\n", __func__);
320 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
321 return;
324 if (!kfifo_is_empty(&djrcv_dev->notif_fifo)) {
325 if (schedule_work(&djrcv_dev->work) == 0) {
326 dbg_hid("%s: did not schedule the work item, was "
327 "already queued\n", __func__);
331 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
333 switch (dj_report.report_type) {
334 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
335 logi_dj_recv_add_djhid_device(djrcv_dev, &dj_report);
336 break;
337 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
338 logi_dj_recv_destroy_djhid_device(djrcv_dev, &dj_report);
339 break;
340 default:
341 dbg_hid("%s: unexpected report type\n", __func__);
345 static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev,
346 struct dj_report *dj_report)
348 /* We are called from atomic context (tasklet && djrcv->lock held) */
350 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
352 if (schedule_work(&djrcv_dev->work) == 0) {
353 dbg_hid("%s: did not schedule the work item, was already "
354 "queued\n", __func__);
358 static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev,
359 struct dj_report *dj_report)
361 /* We are called from atomic context (tasklet && djrcv->lock held) */
362 unsigned int i;
363 u8 reportbuffer[MAX_REPORT_SIZE];
364 struct dj_device *djdev;
366 djdev = djrcv_dev->paired_dj_devices[dj_report->device_index];
368 if (!djdev) {
369 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
370 " is NULL, index %d\n", dj_report->device_index);
371 return;
374 memset(reportbuffer, 0, sizeof(reportbuffer));
376 for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
377 if (djdev->reports_supported & (1 << i)) {
378 reportbuffer[0] = i;
379 if (hid_input_report(djdev->hdev,
380 HID_INPUT_REPORT,
381 reportbuffer,
382 hid_reportid_size_map[i], 1)) {
383 dbg_hid("hid_input_report error sending null "
384 "report\n");
390 static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
391 struct dj_report *dj_report)
393 /* We are called from atomic context (tasklet && djrcv->lock held) */
394 struct dj_device *dj_device;
396 dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
398 if (dj_device == NULL) {
399 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
400 " is NULL, index %d\n", dj_report->device_index);
401 return;
404 if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) ||
405 (hid_reportid_size_map[dj_report->report_type] == 0)) {
406 dbg_hid("invalid report type:%x\n", dj_report->report_type);
407 return;
410 if (hid_input_report(dj_device->hdev,
411 HID_INPUT_REPORT, &dj_report->report_type,
412 hid_reportid_size_map[dj_report->report_type], 1)) {
413 dbg_hid("hid_input_report error\n");
418 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
419 struct dj_report *dj_report)
421 struct hid_device *hdev = djrcv_dev->hdev;
422 int sent_bytes;
424 if (!hdev->hid_output_raw_report) {
425 dev_err(&hdev->dev, "%s:"
426 "hid_output_raw_report is null\n", __func__);
427 return -ENODEV;
430 sent_bytes = hdev->hid_output_raw_report(hdev, (u8 *) dj_report,
431 sizeof(struct dj_report),
432 HID_OUTPUT_REPORT);
434 return (sent_bytes < 0) ? sent_bytes : 0;
437 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
439 struct dj_report dj_report;
441 memset(&dj_report, 0, sizeof(dj_report));
442 dj_report.report_id = REPORT_ID_DJ_SHORT;
443 dj_report.device_index = 0xFF;
444 dj_report.report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
445 return logi_dj_recv_send_report(djrcv_dev, &dj_report);
448 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
449 unsigned timeout)
451 struct dj_report dj_report;
453 memset(&dj_report, 0, sizeof(dj_report));
454 dj_report.report_id = REPORT_ID_DJ_SHORT;
455 dj_report.device_index = 0xFF;
456 dj_report.report_type = REPORT_TYPE_CMD_SWITCH;
457 dj_report.report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
458 dj_report.report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
459 return logi_dj_recv_send_report(djrcv_dev, &dj_report);
463 static int logi_dj_ll_open(struct hid_device *hid)
465 dbg_hid("%s:%s\n", __func__, hid->phys);
466 return 0;
470 static void logi_dj_ll_close(struct hid_device *hid)
472 dbg_hid("%s:%s\n", __func__, hid->phys);
475 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
476 size_t count,
477 unsigned char report_type)
479 /* Called by hid raw to send data */
480 dbg_hid("%s\n", __func__);
482 return 0;
485 static void rdcat(char **rdesc, unsigned int *rsize, const char *data, unsigned int size)
487 memcpy(*rdesc + *rsize, data, size);
488 *rsize += size;
491 static int logi_dj_ll_parse(struct hid_device *hid)
493 struct dj_device *djdev = hid->driver_data;
494 unsigned int rsize = 0;
495 char *rdesc;
496 int retval;
498 dbg_hid("%s\n", __func__);
500 djdev->hdev->version = 0x0111;
501 djdev->hdev->country = 0x00;
503 rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL);
504 if (!rdesc)
505 return -ENOMEM;
507 if (djdev->reports_supported & STD_KEYBOARD) {
508 dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n",
509 __func__, djdev->reports_supported);
510 rdcat(&rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor));
513 if (djdev->reports_supported & STD_MOUSE) {
514 dbg_hid("%s: sending a mouse descriptor, reports_supported: "
515 "%x\n", __func__, djdev->reports_supported);
516 rdcat(&rdesc, &rsize, mse_descriptor, sizeof(mse_descriptor));
519 if (djdev->reports_supported & MULTIMEDIA) {
520 dbg_hid("%s: sending a multimedia report descriptor: %x\n",
521 __func__, djdev->reports_supported);
522 rdcat(&rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor));
525 if (djdev->reports_supported & POWER_KEYS) {
526 dbg_hid("%s: sending a power keys report descriptor: %x\n",
527 __func__, djdev->reports_supported);
528 rdcat(&rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor));
531 if (djdev->reports_supported & MEDIA_CENTER) {
532 dbg_hid("%s: sending a media center report descriptor: %x\n",
533 __func__, djdev->reports_supported);
534 rdcat(&rdesc, &rsize, media_descriptor, sizeof(media_descriptor));
537 if (djdev->reports_supported & KBD_LEDS) {
538 dbg_hid("%s: need to send kbd leds report descriptor: %x\n",
539 __func__, djdev->reports_supported);
542 retval = hid_parse_report(hid, rdesc, rsize);
543 kfree(rdesc);
545 return retval;
548 static int logi_dj_ll_input_event(struct input_dev *dev, unsigned int type,
549 unsigned int code, int value)
551 /* Sent by the input layer to handle leds and Force Feedback */
552 struct hid_device *dj_hiddev = input_get_drvdata(dev);
553 struct dj_device *dj_dev = dj_hiddev->driver_data;
555 struct dj_receiver_dev *djrcv_dev =
556 dev_get_drvdata(dj_hiddev->dev.parent);
557 struct hid_device *dj_rcv_hiddev = djrcv_dev->hdev;
558 struct hid_report_enum *output_report_enum;
560 struct hid_field *field;
561 struct hid_report *report;
562 unsigned char data[8];
563 int offset;
565 dbg_hid("%s: %s, type:%d | code:%d | value:%d\n",
566 __func__, dev->phys, type, code, value);
568 if (type != EV_LED)
569 return -1;
571 offset = hidinput_find_field(dj_hiddev, type, code, &field);
573 if (offset == -1) {
574 dev_warn(&dev->dev, "event field not found\n");
575 return -1;
577 hid_set_field(field, offset, value);
578 hid_output_report(field->report, &data[0]);
580 output_report_enum = &dj_rcv_hiddev->report_enum[HID_OUTPUT_REPORT];
581 report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
582 hid_set_field(report->field[0], 0, dj_dev->device_index);
583 hid_set_field(report->field[0], 1, REPORT_TYPE_LEDS);
584 hid_set_field(report->field[0], 2, data[1]);
586 usbhid_submit_report(dj_rcv_hiddev, report, USB_DIR_OUT);
588 return 0;
592 static int logi_dj_ll_start(struct hid_device *hid)
594 dbg_hid("%s\n", __func__);
595 return 0;
598 static void logi_dj_ll_stop(struct hid_device *hid)
600 dbg_hid("%s\n", __func__);
604 static struct hid_ll_driver logi_dj_ll_driver = {
605 .parse = logi_dj_ll_parse,
606 .start = logi_dj_ll_start,
607 .stop = logi_dj_ll_stop,
608 .open = logi_dj_ll_open,
609 .close = logi_dj_ll_close,
610 .hidinput_input_event = logi_dj_ll_input_event,
614 static int logi_dj_raw_event(struct hid_device *hdev,
615 struct hid_report *report, u8 *data,
616 int size)
618 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
619 struct dj_report *dj_report = (struct dj_report *) data;
620 unsigned long flags;
621 bool report_processed = false;
623 dbg_hid("%s, size:%d\n", __func__, size);
625 /* Here we receive all data coming from iface 2, there are 4 cases:
627 * 1) Data should continue its normal processing i.e. data does not
628 * come from the DJ collection, in which case we do nothing and
629 * return 0, so hid-core can continue normal processing (will forward
630 * to associated hidraw device)
632 * 2) Data is from DJ collection, and is intended for this driver i. e.
633 * data contains arrival, departure, etc notifications, in which case
634 * we queue them for delayed processing by the work queue. We return 1
635 * to hid-core as no further processing is required from it.
637 * 3) Data is from DJ collection, and informs a connection change,
638 * if the change means rf link loss, then we must send a null report
639 * to the upper layer to discard potentially pressed keys that may be
640 * repeated forever by the input layer. Return 1 to hid-core as no
641 * further processing is required.
643 * 4) Data is from DJ collection and is an actual input event from
644 * a paired DJ device in which case we forward it to the correct hid
645 * device (via hid_input_report() ) and return 1 so hid-core does not do
646 * anything else with it.
649 spin_lock_irqsave(&djrcv_dev->lock, flags);
650 if (dj_report->report_id == REPORT_ID_DJ_SHORT) {
651 switch (dj_report->report_type) {
652 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
653 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
654 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
655 break;
656 case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
657 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
658 STATUS_LINKLOSS) {
659 logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
661 break;
662 default:
663 logi_dj_recv_forward_report(djrcv_dev, dj_report);
665 report_processed = true;
667 spin_unlock_irqrestore(&djrcv_dev->lock, flags);
669 return report_processed;
672 static int logi_dj_probe(struct hid_device *hdev,
673 const struct hid_device_id *id)
675 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
676 struct dj_receiver_dev *djrcv_dev;
677 int retval;
679 if (is_dj_device((struct dj_device *)hdev->driver_data))
680 return -ENODEV;
682 dbg_hid("%s called for ifnum %d\n", __func__,
683 intf->cur_altsetting->desc.bInterfaceNumber);
685 /* Ignore interfaces 0 and 1, they will not carry any data, dont create
686 * any hid_device for them */
687 if (intf->cur_altsetting->desc.bInterfaceNumber !=
688 LOGITECH_DJ_INTERFACE_NUMBER) {
689 dbg_hid("%s: ignoring ifnum %d\n", __func__,
690 intf->cur_altsetting->desc.bInterfaceNumber);
691 return -ENODEV;
694 /* Treat interface 2 */
696 djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL);
697 if (!djrcv_dev) {
698 dev_err(&hdev->dev,
699 "%s:failed allocating dj_receiver_dev\n", __func__);
700 return -ENOMEM;
702 djrcv_dev->hdev = hdev;
703 INIT_WORK(&djrcv_dev->work, delayedwork_callback);
704 spin_lock_init(&djrcv_dev->lock);
705 if (kfifo_alloc(&djrcv_dev->notif_fifo,
706 DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report),
707 GFP_KERNEL)) {
708 dev_err(&hdev->dev,
709 "%s:failed allocating notif_fifo\n", __func__);
710 kfree(djrcv_dev);
711 return -ENOMEM;
713 hid_set_drvdata(hdev, djrcv_dev);
715 /* Call to usbhid to fetch the HID descriptors of interface 2 and
716 * subsequently call to the hid/hid-core to parse the fetched
717 * descriptors, this will in turn create the hidraw and hiddev nodes
718 * for interface 2 of the receiver */
719 retval = hid_parse(hdev);
720 if (retval) {
721 dev_err(&hdev->dev,
722 "%s:parse of interface 2 failed\n", __func__);
723 goto hid_parse_fail;
726 /* Starts the usb device and connects to upper interfaces hiddev and
727 * hidraw */
728 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
729 if (retval) {
730 dev_err(&hdev->dev,
731 "%s:hid_hw_start returned error\n", __func__);
732 goto hid_hw_start_fail;
735 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
736 if (retval < 0) {
737 dev_err(&hdev->dev,
738 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
739 __func__, retval);
740 goto switch_to_dj_mode_fail;
743 /* This is enabling the polling urb on the IN endpoint */
744 retval = hdev->ll_driver->open(hdev);
745 if (retval < 0) {
746 dev_err(&hdev->dev, "%s:hdev->ll_driver->open returned "
747 "error:%d\n", __func__, retval);
748 goto llopen_failed;
751 retval = logi_dj_recv_query_paired_devices(djrcv_dev);
752 if (retval < 0) {
753 dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices "
754 "error:%d\n", __func__, retval);
755 goto logi_dj_recv_query_paired_devices_failed;
758 return retval;
760 logi_dj_recv_query_paired_devices_failed:
761 hdev->ll_driver->close(hdev);
763 llopen_failed:
764 switch_to_dj_mode_fail:
765 hid_hw_stop(hdev);
767 hid_hw_start_fail:
768 hid_parse_fail:
769 kfifo_free(&djrcv_dev->notif_fifo);
770 kfree(djrcv_dev);
771 hid_set_drvdata(hdev, NULL);
772 return retval;
776 #ifdef CONFIG_PM
777 static int logi_dj_reset_resume(struct hid_device *hdev)
779 int retval;
780 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
782 retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
783 if (retval < 0) {
784 dev_err(&hdev->dev,
785 "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
786 __func__, retval);
789 return 0;
791 #endif
793 static void logi_dj_remove(struct hid_device *hdev)
795 struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
796 struct dj_device *dj_dev;
797 int i;
799 dbg_hid("%s\n", __func__);
801 cancel_work_sync(&djrcv_dev->work);
803 hdev->ll_driver->close(hdev);
804 hid_hw_stop(hdev);
806 /* I suppose that at this point the only context that can access
807 * the djrecv_data is this thread as the work item is guaranteed to
808 * have finished and no more raw_event callbacks should arrive after
809 * the remove callback was triggered so no locks are put around the
810 * code below */
811 for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
812 dj_dev = djrcv_dev->paired_dj_devices[i];
813 if (dj_dev != NULL) {
814 hid_destroy_device(dj_dev->hdev);
815 kfree(dj_dev);
816 djrcv_dev->paired_dj_devices[i] = NULL;
820 kfifo_free(&djrcv_dev->notif_fifo);
821 kfree(djrcv_dev);
822 hid_set_drvdata(hdev, NULL);
825 static int logi_djdevice_probe(struct hid_device *hdev,
826 const struct hid_device_id *id)
828 int ret;
829 struct dj_device *dj_dev = hdev->driver_data;
831 if (!is_dj_device(dj_dev))
832 return -ENODEV;
834 ret = hid_parse(hdev);
835 if (!ret)
836 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
838 return ret;
841 static const struct hid_device_id logi_dj_receivers[] = {
842 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
843 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
844 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
845 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
849 MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
851 static struct hid_driver logi_djreceiver_driver = {
852 .name = "logitech-djreceiver",
853 .id_table = logi_dj_receivers,
854 .probe = logi_dj_probe,
855 .remove = logi_dj_remove,
856 .raw_event = logi_dj_raw_event,
857 #ifdef CONFIG_PM
858 .reset_resume = logi_dj_reset_resume,
859 #endif
863 static const struct hid_device_id logi_dj_devices[] = {
864 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
865 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
866 {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
867 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
871 static struct hid_driver logi_djdevice_driver = {
872 .name = "logitech-djdevice",
873 .id_table = logi_dj_devices,
874 .probe = logi_djdevice_probe,
878 static int __init logi_dj_init(void)
880 int retval;
882 dbg_hid("Logitech-DJ:%s\n", __func__);
884 retval = hid_register_driver(&logi_djreceiver_driver);
885 if (retval)
886 return retval;
888 retval = hid_register_driver(&logi_djdevice_driver);
889 if (retval)
890 hid_unregister_driver(&logi_djreceiver_driver);
892 return retval;
896 static void __exit logi_dj_exit(void)
898 dbg_hid("Logitech-DJ:%s\n", __func__);
900 hid_unregister_driver(&logi_djdevice_driver);
901 hid_unregister_driver(&logi_djreceiver_driver);
905 module_init(logi_dj_init);
906 module_exit(logi_dj_exit);
907 MODULE_LICENSE("GPL");
908 MODULE_AUTHOR("Logitech");
909 MODULE_AUTHOR("Nestor Lopez Casado");
910 MODULE_AUTHOR("nlopezcasad@logitech.com");