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