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