Version:  2.0.40 2.2.26 2.4.37 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18

Linux/drivers/hid/hid-logitech-dj.c

  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, 0x06,             /*   REPORT_COUNT (6)           */
 48         0x75, 0x08,             /*   REPORT_SIZE (8)            */
 49         0x15, 0x00,             /*   LOGICAL_MINIMUM (0)        */
 50         0x26, 0xFF, 0x00,       /*   LOGICAL_MAXIMUM (255)      */
 51         0x05, 0x07,             /*   USAGE_PAGE (Keyboard)      */
 52         0x19, 0x00,             /*   USAGE_MINIMUM (no event)       */
 53         0x2A, 0xFF, 0x00,       /*   USAGE_MAXIMUM (reserved)       */
 54         0x81, 0x00,             /*   INPUT (Data,Ary,Abs)       */
 55         0x85, 0x0e,             /* REPORT_ID (14)               */
 56         0x05, 0x08,             /*   USAGE PAGE (LED page)      */
 57         0x95, 0x05,             /*   REPORT COUNT (5)           */
 58         0x75, 0x01,             /*   REPORT SIZE (1)            */
 59         0x15, 0x00,             /*   LOGICAL_MINIMUM (0)        */
 60         0x25, 0x01,             /*   LOGICAL_MAXIMUM (1)        */
 61         0x19, 0x01,             /*   USAGE MINIMUM (1)          */
 62         0x29, 0x05,             /*   USAGE MAXIMUM (5)          */
 63         0x91, 0x02,             /*   OUTPUT (Data, Variable, Absolute)  */
 64         0x95, 0x01,             /*   REPORT COUNT (1)           */
 65         0x75, 0x03,             /*   REPORT SIZE (3)            */
 66         0x91, 0x01,             /*   OUTPUT (Constant)          */
 67         0xC0
 68 };
 69 
 70 /* Mouse descriptor (2)     */
 71 static const char mse_descriptor[] = {
 72         0x05, 0x01,             /*  USAGE_PAGE (Generic Desktop)        */
 73         0x09, 0x02,             /*  USAGE (Mouse)                       */
 74         0xA1, 0x01,             /*  COLLECTION (Application)            */
 75         0x85, 0x02,             /*    REPORT_ID = 2                     */
 76         0x09, 0x01,             /*    USAGE (pointer)                   */
 77         0xA1, 0x00,             /*    COLLECTION (physical)             */
 78         0x05, 0x09,             /*      USAGE_PAGE (buttons)            */
 79         0x19, 0x01,             /*      USAGE_MIN (1)                   */
 80         0x29, 0x10,             /*      USAGE_MAX (16)                  */
 81         0x15, 0x00,             /*      LOGICAL_MIN (0)                 */
 82         0x25, 0x01,             /*      LOGICAL_MAX (1)                 */
 83         0x95, 0x10,             /*      REPORT_COUNT (16)               */
 84         0x75, 0x01,             /*      REPORT_SIZE (1)                 */
 85         0x81, 0x02,             /*      INPUT (data var abs)            */
 86         0x05, 0x01,             /*      USAGE_PAGE (generic desktop)    */
 87         0x16, 0x01, 0xF8,       /*      LOGICAL_MIN (-2047)             */
 88         0x26, 0xFF, 0x07,       /*      LOGICAL_MAX (2047)              */
 89         0x75, 0x0C,             /*      REPORT_SIZE (12)                */
 90         0x95, 0x02,             /*      REPORT_COUNT (2)                */
 91         0x09, 0x30,             /*      USAGE (X)                       */
 92         0x09, 0x31,             /*      USAGE (Y)                       */
 93         0x81, 0x06,             /*      INPUT                           */
 94         0x15, 0x81,             /*      LOGICAL_MIN (-127)              */
 95         0x25, 0x7F,             /*      LOGICAL_MAX (127)               */
 96         0x75, 0x08,             /*      REPORT_SIZE (8)                 */
 97         0x95, 0x01,             /*      REPORT_COUNT (1)                */
 98         0x09, 0x38,             /*      USAGE (wheel)                   */
 99         0x81, 0x06,             /*      INPUT                           */
100         0x05, 0x0C,             /*      USAGE_PAGE(consumer)            */
101         0x0A, 0x38, 0x02,       /*      USAGE(AC Pan)                   */
102         0x95, 0x01,             /*      REPORT_COUNT (1)                */
103         0x81, 0x06,             /*      INPUT                           */
104         0xC0,                   /*    END_COLLECTION                    */
105         0xC0,                   /*  END_COLLECTION                      */
106 };
107 
108 /* Consumer Control descriptor (3) */
109 static const char consumer_descriptor[] = {
110         0x05, 0x0C,             /* USAGE_PAGE (Consumer Devices)       */
111         0x09, 0x01,             /* USAGE (Consumer Control)            */
112         0xA1, 0x01,             /* COLLECTION (Application)            */
113         0x85, 0x03,             /* REPORT_ID = 3                       */
114         0x75, 0x10,             /* REPORT_SIZE (16)                    */
115         0x95, 0x02,             /* REPORT_COUNT (2)                    */
116         0x15, 0x01,             /* LOGICAL_MIN (1)                     */
117         0x26, 0x8C, 0x02,       /* LOGICAL_MAX (652)                   */
118         0x19, 0x01,             /* USAGE_MIN (1)                       */
119         0x2A, 0x8C, 0x02,       /* USAGE_MAX (652)                     */
120         0x81, 0x00,             /* INPUT (Data Ary Abs)                */
121         0xC0,                   /* END_COLLECTION                      */
122 };                              /*                                     */
123 
124 /* System control descriptor (4) */
125 static const char syscontrol_descriptor[] = {
126         0x05, 0x01,             /*   USAGE_PAGE (Generic Desktop)      */
127         0x09, 0x80,             /*   USAGE (System Control)            */
128         0xA1, 0x01,             /*   COLLECTION (Application)          */
129         0x85, 0x04,             /*   REPORT_ID = 4                     */
130         0x75, 0x02,             /*   REPORT_SIZE (2)                   */
131         0x95, 0x01,             /*   REPORT_COUNT (1)                  */
132         0x15, 0x01,             /*   LOGICAL_MIN (1)                   */
133         0x25, 0x03,             /*   LOGICAL_MAX (3)                   */
134         0x09, 0x82,             /*   USAGE (System Sleep)              */
135         0x09, 0x81,             /*   USAGE (System Power Down)         */
136         0x09, 0x83,             /*   USAGE (System Wake Up)            */
137         0x81, 0x60,             /*   INPUT (Data Ary Abs NPrf Null)    */
138         0x75, 0x06,             /*   REPORT_SIZE (6)                   */
139         0x81, 0x03,             /*   INPUT (Cnst Var Abs)              */
140         0xC0,                   /*   END_COLLECTION                    */
141 };
142 
143 /* Media descriptor (8) */
144 static const char media_descriptor[] = {
145         0x06, 0xbc, 0xff,       /* Usage Page 0xffbc                   */
146         0x09, 0x88,             /* Usage 0x0088                        */
147         0xa1, 0x01,             /* BeginCollection                     */
148         0x85, 0x08,             /*   Report ID 8                       */
149         0x19, 0x01,             /*   Usage Min 0x0001                  */
150         0x29, 0xff,             /*   Usage Max 0x00ff                  */
151         0x15, 0x01,             /*   Logical Min 1                     */
152         0x26, 0xff, 0x00,       /*   Logical Max 255                   */
153         0x75, 0x08,             /*   Report Size 8                     */
154         0x95, 0x01,             /*   Report Count 1                    */
155         0x81, 0x00,             /*   Input                             */
156         0xc0,                   /* EndCollection                       */
157 };                              /*                                     */
158 
159 /* Maximum size of all defined hid reports in bytes (including report id) */
160 #define MAX_REPORT_SIZE 8
161 
162 /* Make sure all descriptors are present here */
163 #define MAX_RDESC_SIZE                          \
164         (sizeof(kbd_descriptor) +               \
165          sizeof(mse_descriptor) +               \
166          sizeof(consumer_descriptor) +          \
167          sizeof(syscontrol_descriptor) +        \
168          sizeof(media_descriptor))
169 
170 /* Number of possible hid report types that can be created by this driver.
171  *
172  * Right now, RF report types have the same report types (or report id's)
173  * than the hid report created from those RF reports. In the future
174  * this doesnt have to be true.
175  *
176  * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds
177  * to hid report id 0x01, this is standard keyboard. Same thing applies to mice
178  * reports and consumer control, etc. If a new RF report is created, it doesn't
179  * has to have the same report id as its corresponding hid report, so an
180  * translation may have to take place for future report types.
181  */
182 #define NUMBER_OF_HID_REPORTS 32
183 static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = {
184         [1] = 8,                /* Standard keyboard */
185         [2] = 8,                /* Standard mouse */
186         [3] = 5,                /* Consumer control */
187         [4] = 2,                /* System control */
188         [8] = 2,                /* Media Center */
189 };
190 
191 
192 #define LOGITECH_DJ_INTERFACE_NUMBER 0x02
193 
194 static struct hid_ll_driver logi_dj_ll_driver;
195 
196 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev);
197 
198 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
199                                                 struct dj_report *dj_report)
200 {
201         /* Called in delayed work context */
202         struct dj_device *dj_dev;
203         unsigned long flags;
204 
205         spin_lock_irqsave(&djrcv_dev->lock, flags);
206         dj_dev = djrcv_dev->paired_dj_devices[dj_report->device_index];
207         djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
208         spin_unlock_irqrestore(&djrcv_dev->lock, flags);
209 
210         if (dj_dev != NULL) {
211                 hid_destroy_device(dj_dev->hdev);
212                 kfree(dj_dev);
213         } else {
214                 dev_err(&djrcv_dev->hdev->dev, "%s: can't destroy a NULL device\n",
215                         __func__);
216         }
217 }
218 
219 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
220                                           struct dj_report *dj_report)
221 {
222         /* Called in delayed work context */
223         struct hid_device *djrcv_hdev = djrcv_dev->hdev;
224         struct usb_interface *intf = to_usb_interface(djrcv_hdev->dev.parent);
225         struct usb_device *usbdev = interface_to_usbdev(intf);
226         struct hid_device *dj_hiddev;
227         struct dj_device *dj_dev;
228 
229         /* Device index goes from 1 to 6, we need 3 bytes to store the
230          * semicolon, the index, and a null terminator
231          */
232         unsigned char tmpstr[3];
233 
234         if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] &
235             SPFUNCTION_DEVICE_LIST_EMPTY) {
236                 dbg_hid("%s: device list is empty\n", __func__);
237                 djrcv_dev->querying_devices = false;
238                 return;
239         }
240 
241         if (djrcv_dev->paired_dj_devices[dj_report->device_index]) {
242                 /* The device is already known. No need to reallocate it. */
243                 dbg_hid("%s: device is already known\n", __func__);
244                 return;
245         }
246 
247         dj_hiddev = hid_allocate_device();
248         if (IS_ERR(dj_hiddev)) {
249                 dev_err(&djrcv_hdev->dev, "%s: hid_allocate_device failed\n",
250                         __func__);
251                 return;
252         }
253 
254         dj_hiddev->ll_driver = &logi_dj_ll_driver;
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         memset(reportbuffer, 0, sizeof(reportbuffer));
389 
390         for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
391                 if (djdev->reports_supported & (1 << i)) {
392                         reportbuffer[0] = i;
393                         if (hid_input_report(djdev->hdev,
394                                              HID_INPUT_REPORT,
395                                              reportbuffer,
396                                              hid_reportid_size_map[i], 1)) {
397                                 dbg_hid("hid_input_report error sending null "
398                                         "report\n");
399                         }
400                 }
401         }
402 }
403 
404 static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
405                                         struct dj_report *dj_report)
406 {
407         /* We are called from atomic context (tasklet && djrcv->lock held) */
408         struct dj_device *dj_device;
409 
410         dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
411 
412         if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) ||
413             (hid_reportid_size_map[dj_report->report_type] == 0)) {
414                 dbg_hid("invalid report type:%x\n", dj_report->report_type);
415                 return;
416         }
417 
418         if (hid_input_report(dj_device->hdev,
419                         HID_INPUT_REPORT, &dj_report->report_type,
420                         hid_reportid_size_map[dj_report->report_type], 1)) {
421                 dbg_hid("hid_input_report error\n");
422         }
423 }
424 
425 
426 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
427                                     struct dj_report *dj_report)
428 {
429         struct hid_device *hdev = djrcv_dev->hdev;
430         struct hid_report *report;
431         struct hid_report_enum *output_report_enum;
432         u8 *data = (u8 *)(&dj_report->device_index);
433         unsigned int i;
434 
435         output_report_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
436         report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
437 
438         if (!report) {
439                 dev_err(&hdev->dev, "%s: unable to find dj report\n", __func__);
440                 return -ENODEV;
441         }
442 
443         for (i = 0; i < DJREPORT_SHORT_LENGTH - 1; i++)
444                 report->field[0]->value[i] = data[i];
445 
446         hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
447 
448         return 0;
449 }
450 
451 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
452 {
453         struct dj_report *dj_report;
454         int retval;
455 
456         /* no need to protect djrcv_dev->querying_devices */
457         if (djrcv_dev->querying_devices)
458                 return 0;
459 
460         dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
461         if (!dj_report)
462                 return -ENOMEM;
463         dj_report->report_id = REPORT_ID_DJ_SHORT;
464         dj_report->device_index = 0xFF;
465         dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
466         retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
467         kfree(dj_report);
468         return retval;
469 }
470 
471 
472 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
473                                           unsigned timeout)
474 {
475         struct dj_report *dj_report;
476         int retval;
477 
478         dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
479         if (!dj_report)
480                 return -ENOMEM;
481         dj_report->report_id = REPORT_ID_DJ_SHORT;
482         dj_report->device_index = 0xFF;
483         dj_report->report_type = REPORT_TYPE_CMD_SWITCH;
484         dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
485         dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
486         retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
487         kfree(dj_report);
488 
489         /*
490          * Ugly sleep to work around a USB 3.0 bug when the receiver is still
491          * processing the "switch-to-dj" command while we send an other command.
492          * 50 msec should gives enough time to the receiver to be ready.
493          */
494         msleep(50);
495 
496         return retval;
497 }
498 
499 
500 static int logi_dj_ll_open(struct hid_device *hid)
501 {
502         dbg_hid("%s:%s\n", __func__, hid->phys);
503         return 0;
504 
505 }
506 
507 static void logi_dj_ll_close(struct hid_device *hid)
508 {
509         dbg_hid("%s:%s\n", __func__, hid->phys);
510 }
511 
512 static int logi_dj_ll_raw_request(struct hid_device *hid,
513                                   unsigned char reportnum, __u8 *buf,
514                                   size_t count, unsigned char report_type,
515                                   int reqtype)
516 {
517         struct dj_device *djdev = hid->driver_data;
518         struct dj_receiver_dev *djrcv_dev = djdev->dj_receiver_dev;
519         u8 *out_buf;
520         int ret;
521 
522         if (buf[0] != REPORT_TYPE_LEDS)
523                 return -EINVAL;
524 
525         out_buf = kzalloc(DJREPORT_SHORT_LENGTH, GFP_ATOMIC);
526         if (!out_buf)
527                 return -ENOMEM;
528 
529         if (count > DJREPORT_SHORT_LENGTH - 2)
530                 count = DJREPORT_SHORT_LENGTH - 2;
531 
532         out_buf[0] = REPORT_ID_DJ_SHORT;
533         out_buf[1] = djdev->device_index;
534         memcpy(out_buf + 2, buf, count);
535 
536         ret = hid_hw_raw_request(djrcv_dev->hdev, out_buf[0], out_buf,
537                 DJREPORT_SHORT_LENGTH, report_type, reqtype);
538 
539         kfree(out_buf);
540         return ret;
541 }
542 
543 static void rdcat(char *rdesc, unsigned int *rsize, const char *data, unsigned int size)
544 {
545         memcpy(rdesc + *rsize, data, size);
546         *rsize += size;
547 }
548 
549 static int logi_dj_ll_parse(struct hid_device *hid)
550 {
551         struct dj_device *djdev = hid->driver_data;
552         unsigned int rsize = 0;
553         char *rdesc;
554         int retval;
555 
556         dbg_hid("%s\n", __func__);
557 
558         djdev->hdev->version = 0x0111;
559         djdev->hdev->country = 0x00;
560 
561         rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL);
562         if (!rdesc)
563                 return -ENOMEM;
564 
565         if (djdev->reports_supported & STD_KEYBOARD) {
566                 dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n",
567                         __func__, djdev->reports_supported);
568                 rdcat(rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor));
569         }
570 
571         if (djdev->reports_supported & STD_MOUSE) {
572                 dbg_hid("%s: sending a mouse descriptor, reports_supported: "
573                         "%x\n", __func__, djdev->reports_supported);
574                 rdcat(rdesc, &rsize, mse_descriptor, sizeof(mse_descriptor));
575         }
576 
577         if (djdev->reports_supported & MULTIMEDIA) {
578                 dbg_hid("%s: sending a multimedia report descriptor: %x\n",
579                         __func__, djdev->reports_supported);
580                 rdcat(rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor));
581         }
582 
583         if (djdev->reports_supported & POWER_KEYS) {
584                 dbg_hid("%s: sending a power keys report descriptor: %x\n",
585                         __func__, djdev->reports_supported);
586                 rdcat(rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor));
587         }
588 
589         if (djdev->reports_supported & MEDIA_CENTER) {
590                 dbg_hid("%s: sending a media center report descriptor: %x\n",
591                         __func__, djdev->reports_supported);
592                 rdcat(rdesc, &rsize, media_descriptor, sizeof(media_descriptor));
593         }
594 
595         if (djdev->reports_supported & KBD_LEDS) {
596                 dbg_hid("%s: need to send kbd leds report descriptor: %x\n",
597                         __func__, djdev->reports_supported);
598         }
599 
600         retval = hid_parse_report(hid, rdesc, rsize);
601         kfree(rdesc);
602 
603         return retval;
604 }
605 
606 static int logi_dj_ll_start(struct hid_device *hid)
607 {
608         dbg_hid("%s\n", __func__);
609         return 0;
610 }
611 
612 static void logi_dj_ll_stop(struct hid_device *hid)
613 {
614         dbg_hid("%s\n", __func__);
615 }
616 
617 
618 static struct hid_ll_driver logi_dj_ll_driver = {
619         .parse = logi_dj_ll_parse,
620         .start = logi_dj_ll_start,
621         .stop = logi_dj_ll_stop,
622         .open = logi_dj_ll_open,
623         .close = logi_dj_ll_close,
624         .raw_request = logi_dj_ll_raw_request,
625 };
626 
627 
628 static int logi_dj_raw_event(struct hid_device *hdev,
629                              struct hid_report *report, u8 *data,
630                              int size)
631 {
632         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
633         struct dj_report *dj_report = (struct dj_report *) data;
634         unsigned long flags;
635 
636         dbg_hid("%s, size:%d\n", __func__, size);
637 
638         /* Here we receive all data coming from iface 2, there are 4 cases:
639          *
640          * 1) Data should continue its normal processing i.e. data does not
641          * come from the DJ collection, in which case we do nothing and
642          * return 0, so hid-core can continue normal processing (will forward
643          * to associated hidraw device)
644          *
645          * 2) Data is from DJ collection, and is intended for this driver i. e.
646          * data contains arrival, departure, etc notifications, in which case
647          * we queue them for delayed processing by the work queue. We return 1
648          * to hid-core as no further processing is required from it.
649          *
650          * 3) Data is from DJ collection, and informs a connection change,
651          * if the change means rf link loss, then we must send a null report
652          * to the upper layer to discard potentially pressed keys that may be
653          * repeated forever by the input layer. Return 1 to hid-core as no
654          * further processing is required.
655          *
656          * 4) Data is from DJ collection and is an actual input event from
657          * a paired DJ device in which case we forward it to the correct hid
658          * device (via hid_input_report() ) and return 1 so hid-core does not do
659          * anything else with it.
660          */
661 
662         /* case 1) */
663         if (data[0] != REPORT_ID_DJ_SHORT)
664                 return false;
665 
666         if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
667             (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
668                 /*
669                  * Device index is wrong, bail out.
670                  * This driver can ignore safely the receiver notifications,
671                  * so ignore those reports too.
672                  */
673                 if (dj_report->device_index != DJ_RECEIVER_INDEX)
674                         dev_err(&hdev->dev, "%s: invalid device index:%d\n",
675                                 __func__, dj_report->device_index);
676                 return false;
677         }
678 
679         spin_lock_irqsave(&djrcv_dev->lock, flags);
680 
681         if (!djrcv_dev->paired_dj_devices[dj_report->device_index]) {
682                 /* received an event for an unknown device, bail out */
683                 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
684                 goto out;
685         }
686 
687         switch (dj_report->report_type) {
688         case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
689                 /* pairing notifications are handled above the switch */
690                 break;
691         case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
692                 logi_dj_recv_queue_notification(djrcv_dev, dj_report);
693                 break;
694         case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
695                 if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
696                     STATUS_LINKLOSS) {
697                         logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
698                 }
699                 break;
700         default:
701                 logi_dj_recv_forward_report(djrcv_dev, dj_report);
702         }
703 
704 out:
705         spin_unlock_irqrestore(&djrcv_dev->lock, flags);
706 
707         return true;
708 }
709 
710 static int logi_dj_probe(struct hid_device *hdev,
711                          const struct hid_device_id *id)
712 {
713         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
714         struct dj_receiver_dev *djrcv_dev;
715         int retval;
716 
717         if (is_dj_device((struct dj_device *)hdev->driver_data))
718                 return -ENODEV;
719 
720         dbg_hid("%s called for ifnum %d\n", __func__,
721                 intf->cur_altsetting->desc.bInterfaceNumber);
722 
723         /* Ignore interfaces 0 and 1, they will not carry any data, dont create
724          * any hid_device for them */
725         if (intf->cur_altsetting->desc.bInterfaceNumber !=
726             LOGITECH_DJ_INTERFACE_NUMBER) {
727                 dbg_hid("%s: ignoring ifnum %d\n", __func__,
728                         intf->cur_altsetting->desc.bInterfaceNumber);
729                 return -ENODEV;
730         }
731 
732         /* Treat interface 2 */
733 
734         djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL);
735         if (!djrcv_dev) {
736                 dev_err(&hdev->dev,
737                         "%s:failed allocating dj_receiver_dev\n", __func__);
738                 return -ENOMEM;
739         }
740         djrcv_dev->hdev = hdev;
741         INIT_WORK(&djrcv_dev->work, delayedwork_callback);
742         spin_lock_init(&djrcv_dev->lock);
743         if (kfifo_alloc(&djrcv_dev->notif_fifo,
744                         DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report),
745                         GFP_KERNEL)) {
746                 dev_err(&hdev->dev,
747                         "%s:failed allocating notif_fifo\n", __func__);
748                 kfree(djrcv_dev);
749                 return -ENOMEM;
750         }
751         hid_set_drvdata(hdev, djrcv_dev);
752 
753         /* Call  to usbhid to fetch the HID descriptors of interface 2 and
754          * subsequently call to the hid/hid-core to parse the fetched
755          * descriptors, this will in turn create the hidraw and hiddev nodes
756          * for interface 2 of the receiver */
757         retval = hid_parse(hdev);
758         if (retval) {
759                 dev_err(&hdev->dev,
760                         "%s:parse of interface 2 failed\n", __func__);
761                 goto hid_parse_fail;
762         }
763 
764         if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, REPORT_ID_DJ_SHORT,
765                                  0, DJREPORT_SHORT_LENGTH - 1)) {
766                 retval = -ENODEV;
767                 goto hid_parse_fail;
768         }
769 
770         /* Starts the usb device and connects to upper interfaces hiddev and
771          * hidraw */
772         retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
773         if (retval) {
774                 dev_err(&hdev->dev,
775                         "%s:hid_hw_start returned error\n", __func__);
776                 goto hid_hw_start_fail;
777         }
778 
779         retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
780         if (retval < 0) {
781                 dev_err(&hdev->dev,
782                         "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
783                         __func__, retval);
784                 goto switch_to_dj_mode_fail;
785         }
786 
787         /* This is enabling the polling urb on the IN endpoint */
788         retval = hid_hw_open(hdev);
789         if (retval < 0) {
790                 dev_err(&hdev->dev, "%s:hid_hw_open returned error:%d\n",
791                         __func__, retval);
792                 goto llopen_failed;
793         }
794 
795         /* Allow incoming packets to arrive: */
796         hid_device_io_start(hdev);
797 
798         retval = logi_dj_recv_query_paired_devices(djrcv_dev);
799         if (retval < 0) {
800                 dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices "
801                         "error:%d\n", __func__, retval);
802                 goto logi_dj_recv_query_paired_devices_failed;
803         }
804 
805         return retval;
806 
807 logi_dj_recv_query_paired_devices_failed:
808         hid_hw_close(hdev);
809 
810 llopen_failed:
811 switch_to_dj_mode_fail:
812         hid_hw_stop(hdev);
813 
814 hid_hw_start_fail:
815 hid_parse_fail:
816         kfifo_free(&djrcv_dev->notif_fifo);
817         kfree(djrcv_dev);
818         hid_set_drvdata(hdev, NULL);
819         return retval;
820 
821 }
822 
823 #ifdef CONFIG_PM
824 static int logi_dj_reset_resume(struct hid_device *hdev)
825 {
826         int retval;
827         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
828 
829         retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
830         if (retval < 0) {
831                 dev_err(&hdev->dev,
832                         "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
833                         __func__, retval);
834         }
835 
836         return 0;
837 }
838 #endif
839 
840 static void logi_dj_remove(struct hid_device *hdev)
841 {
842         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
843         struct dj_device *dj_dev;
844         int i;
845 
846         dbg_hid("%s\n", __func__);
847 
848         cancel_work_sync(&djrcv_dev->work);
849 
850         hid_hw_close(hdev);
851         hid_hw_stop(hdev);
852 
853         /* I suppose that at this point the only context that can access
854          * the djrecv_data is this thread as the work item is guaranteed to
855          * have finished and no more raw_event callbacks should arrive after
856          * the remove callback was triggered so no locks are put around the
857          * code below */
858         for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
859                 dj_dev = djrcv_dev->paired_dj_devices[i];
860                 if (dj_dev != NULL) {
861                         hid_destroy_device(dj_dev->hdev);
862                         kfree(dj_dev);
863                         djrcv_dev->paired_dj_devices[i] = NULL;
864                 }
865         }
866 
867         kfifo_free(&djrcv_dev->notif_fifo);
868         kfree(djrcv_dev);
869         hid_set_drvdata(hdev, NULL);
870 }
871 
872 static int logi_djdevice_probe(struct hid_device *hdev,
873                          const struct hid_device_id *id)
874 {
875         int ret;
876         struct dj_device *dj_dev = hdev->driver_data;
877 
878         if (!is_dj_device(dj_dev))
879                 return -ENODEV;
880 
881         ret = hid_parse(hdev);
882         if (!ret)
883                 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
884 
885         return ret;
886 }
887 
888 static const struct hid_device_id logi_dj_receivers[] = {
889         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
890                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
891         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
892                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
893         {}
894 };
895 
896 MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
897 
898 static struct hid_driver logi_djreceiver_driver = {
899         .name = "logitech-djreceiver",
900         .id_table = logi_dj_receivers,
901         .probe = logi_dj_probe,
902         .remove = logi_dj_remove,
903         .raw_event = logi_dj_raw_event,
904 #ifdef CONFIG_PM
905         .reset_resume = logi_dj_reset_resume,
906 #endif
907 };
908 
909 
910 static const struct hid_device_id logi_dj_devices[] = {
911         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
912                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
913         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
914                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
915         {}
916 };
917 
918 static struct hid_driver logi_djdevice_driver = {
919         .name = "logitech-djdevice",
920         .id_table = logi_dj_devices,
921         .probe = logi_djdevice_probe,
922 };
923 
924 
925 static int __init logi_dj_init(void)
926 {
927         int retval;
928 
929         dbg_hid("Logitech-DJ:%s\n", __func__);
930 
931         retval = hid_register_driver(&logi_djreceiver_driver);
932         if (retval)
933                 return retval;
934 
935         retval = hid_register_driver(&logi_djdevice_driver);
936         if (retval)
937                 hid_unregister_driver(&logi_djreceiver_driver);
938 
939         return retval;
940 
941 }
942 
943 static void __exit logi_dj_exit(void)
944 {
945         dbg_hid("Logitech-DJ:%s\n", __func__);
946 
947         hid_unregister_driver(&logi_djdevice_driver);
948         hid_unregister_driver(&logi_djreceiver_driver);
949 
950 }
951 
952 module_init(logi_dj_init);
953 module_exit(logi_dj_exit);
954 MODULE_LICENSE("GPL");
955 MODULE_AUTHOR("Logitech");
956 MODULE_AUTHOR("Nestor Lopez Casado");
957 MODULE_AUTHOR("nlopezcasad@logitech.com");
958 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us