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 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev);
 189
 190 static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev,
 191                                                 struct dj_report *dj_report)
 192 {
 193         /* Called in delayed work context */
 194         struct dj_device *dj_dev;
 195         unsigned long flags;
 196
 197         spin_lock_irqsave(&djrcv_dev->lock, flags);
 198         dj_dev = djrcv_dev->paired_dj_devices[dj_report->device_index];
 199         djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL;
 200         spin_unlock_irqrestore(&djrcv_dev->lock, flags);
 201
 202         if (dj_dev != NULL) {
 203                 hid_destroy_device(dj_dev->hdev);
 204                 kfree(dj_dev);
 205         } else {
 206                 dev_err(&djrcv_dev->hdev->dev, "%s: can't destroy a NULL device\n",
 207                         __func__);
 208         }
 209 }
 210
 211 static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
 212                                           struct dj_report *dj_report)
 213 {
 214         /* Called in delayed work context */
 215         struct hid_device *djrcv_hdev = djrcv_dev->hdev;
 216         struct usb_interface *intf = to_usb_interface(djrcv_hdev->dev.parent);
 217         struct usb_device *usbdev = interface_to_usbdev(intf);
 218         struct hid_device *dj_hiddev;
 219         struct dj_device *dj_dev;
 220
 221         /* Device index goes from 1 to 6, we need 3 bytes to store the
 222          * semicolon, the index, and a null terminator
 223          */
 224         unsigned char tmpstr[3];
 225
 226         if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] &
 227             SPFUNCTION_DEVICE_LIST_EMPTY) {
 228                 dbg_hid("%s: device list is empty\n", __func__);
 229                 djrcv_dev->querying_devices = false;
 230                 return;
 231         }
 232
 233         if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
 234             (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
 235                 dev_err(&djrcv_hdev->dev, "%s: invalid device index:%d\n",
 236                         __func__, dj_report->device_index);
 237                 return;
 238         }
 239
 240         if (djrcv_dev->paired_dj_devices[dj_report->device_index]) {
 241                 /* The device is already known. No need to reallocate it. */
 242                 dbg_hid("%s: device is already known\n", __func__);
 243                 return;
 244         }
 245
 246         dj_hiddev = hid_allocate_device();
 247         if (IS_ERR(dj_hiddev)) {
 248                 dev_err(&djrcv_hdev->dev, "%s: hid_allocate_device failed\n",
 249                         __func__);
 250                 return;
 251         }
 252
 253         dj_hiddev->ll_driver = &logi_dj_ll_driver;
 254         dj_hiddev->hid_output_raw_report = logi_dj_output_hidraw_report;
 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         if (!djdev) {
 389                 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
 390                         " is NULL, index %d\n", dj_report->device_index);
 391                 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
 392
 393                 if (schedule_work(&djrcv_dev->work) == 0) {
 394                         dbg_hid("%s: did not schedule the work item, was already "
 395                         "queued\n", __func__);
 396                 }
 397                 return;
 398         }
 399
 400         memset(reportbuffer, 0, sizeof(reportbuffer));
 401
 402         for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) {
 403                 if (djdev->reports_supported & (1 << i)) {
 404                         reportbuffer[0] = i;
 405                         if (hid_input_report(djdev->hdev,
 406                                              HID_INPUT_REPORT,
 407                                              reportbuffer,
 408                                              hid_reportid_size_map[i], 1)) {
 409                                 dbg_hid("hid_input_report error sending null "
 410                                         "report\n");
 411                         }
 412                 }
 413         }
 414 }
 415
 416 static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
 417                                         struct dj_report *dj_report)
 418 {
 419         /* We are called from atomic context (tasklet && djrcv->lock held) */
 420         struct dj_device *dj_device;
 421
 422         dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index];
 423
 424         if (dj_device == NULL) {
 425                 dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]"
 426                         " is NULL, index %d\n", dj_report->device_index);
 427                 kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report));
 428
 429                 if (schedule_work(&djrcv_dev->work) == 0) {
 430                         dbg_hid("%s: did not schedule the work item, was already "
 431                         "queued\n", __func__);
 432                 }
 433                 return;
 434         }
 435
 436         if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) ||
 437             (hid_reportid_size_map[dj_report->report_type] == 0)) {
 438                 dbg_hid("invalid report type:%x\n", dj_report->report_type);
 439                 return;
 440         }
 441
 442         if (hid_input_report(dj_device->hdev,
 443                         HID_INPUT_REPORT, &dj_report->report_type,
 444                         hid_reportid_size_map[dj_report->report_type], 1)) {
 445                 dbg_hid("hid_input_report error\n");
 446         }
 447 }
 448
 449
 450 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
 451                                     struct dj_report *dj_report)
 452 {
 453         struct hid_device *hdev = djrcv_dev->hdev;
 454         struct hid_report *report;
 455         struct hid_report_enum *output_report_enum;
 456         u8 *data = (u8 *)(&dj_report->device_index);
 457         unsigned int i;
 458
 459         output_report_enum = &hdev->report_enum[HID_OUTPUT_REPORT];
 460         report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
 461
 462         if (!report) {
 463                 dev_err(&hdev->dev, "%s: unable to find dj report\n", __func__);
 464                 return -ENODEV;
 465         }
 466
 467         for (i = 0; i < DJREPORT_SHORT_LENGTH - 1; i++)
 468                 report->field[0]->value[i] = data[i];
 469
 470         usbhid_submit_report(hdev, report, USB_DIR_OUT);
 471
 472         return 0;
 473 }
 474
 475 static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
 476 {
 477         struct dj_report *dj_report;
 478         int retval;
 479
 480         dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
 481         if (!dj_report)
 482                 return -ENOMEM;
 483         dj_report->report_id = REPORT_ID_DJ_SHORT;
 484         dj_report->device_index = 0xFF;
 485         dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES;
 486         retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
 487         kfree(dj_report);
 488         return retval;
 489 }
 490
 491
 492 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
 493                                           unsigned timeout)
 494 {
 495         struct dj_report *dj_report;
 496         int retval;
 497
 498         dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
 499         if (!dj_report)
 500                 return -ENOMEM;
 501         dj_report->report_id = REPORT_ID_DJ_SHORT;
 502         dj_report->device_index = 0xFF;
 503         dj_report->report_type = REPORT_TYPE_CMD_SWITCH;
 504         dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
 505         dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
 506         retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
 507         kfree(dj_report);
 508         return retval;
 509 }
 510
 511
 512 static int logi_dj_ll_open(struct hid_device *hid)
 513 {
 514         dbg_hid("%s:%s\n", __func__, hid->phys);
 515         return 0;
 516
 517 }
 518
 519 static void logi_dj_ll_close(struct hid_device *hid)
 520 {
 521         dbg_hid("%s:%s\n", __func__, hid->phys);
 522 }
 523
 524 static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf,
 525                                         size_t count,
 526                                         unsigned char report_type)
 527 {
 528         /* Called by hid raw to send data */
 529         dbg_hid("%s\n", __func__);
 530
 531         return 0;
 532 }
 533
 534 static int logi_dj_ll_parse(struct hid_device *hid)
 535 {
 536         struct dj_device *djdev = hid->driver_data;
 537         int retval;
 538
 539         dbg_hid("%s\n", __func__);
 540
 541         djdev->hdev->version = 0x0111;
 542         djdev->hdev->country = 0x00;
 543
 544         if (djdev->reports_supported & STD_KEYBOARD) {
 545                 dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n",
 546                         __func__, djdev->reports_supported);
 547                 retval = hid_parse_report(hid,
 548                                           (u8 *) kbd_descriptor,
 549                                           sizeof(kbd_descriptor));
 550                 if (retval) {
 551                         dbg_hid("%s: sending a kbd descriptor, hid_parse failed"
 552                                 " error: %d\n", __func__, retval);
 553                         return retval;
 554                 }
 555         }
 556
 557         if (djdev->reports_supported & STD_MOUSE) {
 558                 dbg_hid("%s: sending a mouse descriptor, reports_supported: "
 559                         "%x\n", __func__, djdev->reports_supported);
 560                 retval = hid_parse_report(hid,
 561                                           (u8 *) mse_descriptor,
 562                                           sizeof(mse_descriptor));
 563                 if (retval) {
 564                         dbg_hid("%s: sending a mouse descriptor, hid_parse "
 565                                 "failed error: %d\n", __func__, retval);
 566                         return retval;
 567                 }
 568         }
 569
 570         if (djdev->reports_supported & MULTIMEDIA) {
 571                 dbg_hid("%s: sending a multimedia report descriptor: %x\n",
 572                         __func__, djdev->reports_supported);
 573                 retval = hid_parse_report(hid,
 574                                           (u8 *) consumer_descriptor,
 575                                           sizeof(consumer_descriptor));
 576                 if (retval) {
 577                         dbg_hid("%s: sending a consumer_descriptor, hid_parse "
 578                                 "failed error: %d\n", __func__, retval);
 579                         return retval;
 580                 }
 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                 retval = hid_parse_report(hid,
 587                                           (u8 *) syscontrol_descriptor,
 588                                           sizeof(syscontrol_descriptor));
 589                 if (retval) {
 590                         dbg_hid("%s: sending a syscontrol_descriptor, "
 591                                 "hid_parse failed error: %d\n",
 592                                 __func__, retval);
 593                         return retval;
 594                 }
 595         }
 596
 597         if (djdev->reports_supported & MEDIA_CENTER) {
 598                 dbg_hid("%s: sending a media center report descriptor: %x\n",
 599                         __func__, djdev->reports_supported);
 600                 retval = hid_parse_report(hid,
 601                                           (u8 *) media_descriptor,
 602                                           sizeof(media_descriptor));
 603                 if (retval) {
 604                         dbg_hid("%s: sending a media_descriptor, hid_parse "
 605                                 "failed error: %d\n", __func__, retval);
 606                         return retval;
 607                 }
 608         }
 609
 610         if (djdev->reports_supported & KBD_LEDS) {
 611                 dbg_hid("%s: need to send kbd leds report descriptor: %x\n",
 612                         __func__, djdev->reports_supported);
 613         }
 614
 615         return 0;
 616 }
 617
 618 static int logi_dj_ll_input_event(struct input_dev *dev, unsigned int type,
 619                                   unsigned int code, int value)
 620 {
 621         /* Sent by the input layer to handle leds and Force Feedback */
 622         struct hid_device *dj_hiddev = input_get_drvdata(dev);
 623         struct dj_device *dj_dev = dj_hiddev->driver_data;
 624
 625         struct dj_receiver_dev *djrcv_dev =
 626             dev_get_drvdata(dj_hiddev->dev.parent);
 627         struct hid_device *dj_rcv_hiddev = djrcv_dev->hdev;
 628         struct hid_report_enum *output_report_enum;
 629
 630         struct hid_field *field;
 631         struct hid_report *report;
 632         unsigned char data[8];
 633         int offset;
 634
 635         dbg_hid("%s: %s, type:%d | code:%d | value:%d\n",
 636                 __func__, dev->phys, type, code, value);
 637
 638         if (type != EV_LED)
 639                 return -1;
 640
 641         offset = hidinput_find_field(dj_hiddev, type, code, &field);
 642
 643         if (offset == -1) {
 644                 dev_warn(&dev->dev, "event field not found\n");
 645                 return -1;
 646         }
 647         hid_set_field(field, offset, value);
 648         hid_output_report(field->report, &data[0]);
 649
 650         output_report_enum = &dj_rcv_hiddev->report_enum[HID_OUTPUT_REPORT];
 651         report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT];
 652         hid_set_field(report->field[0], 0, dj_dev->device_index);
 653         hid_set_field(report->field[0], 1, REPORT_TYPE_LEDS);
 654         hid_set_field(report->field[0], 2, data[1]);
 655
 656         usbhid_submit_report(dj_rcv_hiddev, report, USB_DIR_OUT);
 657
 658         return 0;
 659
 660 }
 661
 662 static int logi_dj_ll_start(struct hid_device *hid)
 663 {
 664         dbg_hid("%s\n", __func__);
 665         return 0;
 666 }
 667
 668 static void logi_dj_ll_stop(struct hid_device *hid)
 669 {
 670         dbg_hid("%s\n", __func__);
 671 }
 672
 673
 674 static struct hid_ll_driver logi_dj_ll_driver = {
 675         .parse = logi_dj_ll_parse,
 676         .start = logi_dj_ll_start,
 677         .stop = logi_dj_ll_stop,
 678         .open = logi_dj_ll_open,
 679         .close = logi_dj_ll_close,
 680         .hidinput_input_event = logi_dj_ll_input_event,
 681 };
 682
 683
 684 static int logi_dj_raw_event(struct hid_device *hdev,
 685                              struct hid_report *report, u8 *data,
 686                              int size)
 687 {
 688         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
 689         struct dj_report *dj_report = (struct dj_report *) data;
 690         unsigned long flags;
 691         bool report_processed = false;
 692
 693         dbg_hid("%s, size:%d\n", __func__, size);
 694
 695         /* Here we receive all data coming from iface 2, there are 4 cases:
 696          *
 697          * 1) Data should continue its normal processing i.e. data does not
 698          * come from the DJ collection, in which case we do nothing and
 699          * return 0, so hid-core can continue normal processing (will forward
 700          * to associated hidraw device)
 701          *
 702          * 2) Data is from DJ collection, and is intended for this driver i. e.
 703          * data contains arrival, departure, etc notifications, in which case
 704          * we queue them for delayed processing by the work queue. We return 1
 705          * to hid-core as no further processing is required from it.
 706          *
 707          * 3) Data is from DJ collection, and informs a connection change,
 708          * if the change means rf link loss, then we must send a null report
 709          * to the upper layer to discard potentially pressed keys that may be
 710          * repeated forever by the input layer. Return 1 to hid-core as no
 711          * further processing is required.
 712          *
 713          * 4) Data is from DJ collection and is an actual input event from
 714          * a paired DJ device in which case we forward it to the correct hid
 715          * device (via hid_input_report() ) and return 1 so hid-core does not do
 716          * anything else with it.
 717          */
 718
 719         spin_lock_irqsave(&djrcv_dev->lock, flags);
 720         if (dj_report->report_id == REPORT_ID_DJ_SHORT) {
 721                 switch (dj_report->report_type) {
 722                 case REPORT_TYPE_NOTIF_DEVICE_PAIRED:
 723                 case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED:
 724                         logi_dj_recv_queue_notification(djrcv_dev, dj_report);
 725                         break;
 726                 case REPORT_TYPE_NOTIF_CONNECTION_STATUS:
 727                         if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] ==
 728                             STATUS_LINKLOSS) {
 729                                 logi_dj_recv_forward_null_report(djrcv_dev, dj_report);
 730                         }
 731                         break;
 732                 default:
 733                         logi_dj_recv_forward_report(djrcv_dev, dj_report);
 734                 }
 735                 report_processed = true;
 736         }
 737         spin_unlock_irqrestore(&djrcv_dev->lock, flags);
 738
 739         return report_processed;
 740 }
 741
 742 static int logi_dj_probe(struct hid_device *hdev,
 743                          const struct hid_device_id *id)
 744 {
 745         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 746         struct dj_receiver_dev *djrcv_dev;
 747         int retval;
 748
 749         if (is_dj_device((struct dj_device *)hdev->driver_data))
 750                 return -ENODEV;
 751
 752         dbg_hid("%s called for ifnum %d\n", __func__,
 753                 intf->cur_altsetting->desc.bInterfaceNumber);
 754
 755         /* Ignore interfaces 0 and 1, they will not carry any data, dont create
 756          * any hid_device for them */
 757         if (intf->cur_altsetting->desc.bInterfaceNumber !=
 758             LOGITECH_DJ_INTERFACE_NUMBER) {
 759                 dbg_hid("%s: ignoring ifnum %d\n", __func__,
 760                         intf->cur_altsetting->desc.bInterfaceNumber);
 761                 return -ENODEV;
 762         }
 763
 764         /* Treat interface 2 */
 765
 766         djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL);
 767         if (!djrcv_dev) {
 768                 dev_err(&hdev->dev,
 769                         "%s:failed allocating dj_receiver_dev\n", __func__);
 770                 return -ENOMEM;
 771         }
 772         djrcv_dev->hdev = hdev;
 773         INIT_WORK(&djrcv_dev->work, delayedwork_callback);
 774         spin_lock_init(&djrcv_dev->lock);
 775         if (kfifo_alloc(&djrcv_dev->notif_fifo,
 776                         DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report),
 777                         GFP_KERNEL)) {
 778                 dev_err(&hdev->dev,
 779                         "%s:failed allocating notif_fifo\n", __func__);
 780                 kfree(djrcv_dev);
 781                 return -ENOMEM;
 782         }
 783         hid_set_drvdata(hdev, djrcv_dev);
 784
 785         /* Call  to usbhid to fetch the HID descriptors of interface 2 and
 786          * subsequently call to the hid/hid-core to parse the fetched
 787          * descriptors, this will in turn create the hidraw and hiddev nodes
 788          * for interface 2 of the receiver */
 789         retval = hid_parse(hdev);
 790         if (retval) {
 791                 dev_err(&hdev->dev,
 792                         "%s:parse of interface 2 failed\n", __func__);
 793                 goto hid_parse_fail;
 794         }
 795
 796         if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, REPORT_ID_DJ_SHORT,
 797                                  0, DJREPORT_SHORT_LENGTH - 1)) {
 798                 retval = -ENODEV;
 799                 goto hid_parse_fail;
 800         }
 801
 802         /* Starts the usb device and connects to upper interfaces hiddev and
 803          * hidraw */
 804         retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 805         if (retval) {
 806                 dev_err(&hdev->dev,
 807                         "%s:hid_hw_start returned error\n", __func__);
 808                 goto hid_hw_start_fail;
 809         }
 810
 811         retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
 812         if (retval < 0) {
 813                 dev_err(&hdev->dev,
 814                         "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
 815                         __func__, retval);
 816                 goto switch_to_dj_mode_fail;
 817         }
 818
 819         /* This is enabling the polling urb on the IN endpoint */
 820         retval = hdev->ll_driver->open(hdev);
 821         if (retval < 0) {
 822                 dev_err(&hdev->dev, "%s:hdev->ll_driver->open returned "
 823                         "error:%d\n", __func__, retval);
 824                 goto llopen_failed;
 825         }
 826
 827         retval = logi_dj_recv_query_paired_devices(djrcv_dev);
 828         if (retval < 0) {
 829                 dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices "
 830                         "error:%d\n", __func__, retval);
 831                 goto logi_dj_recv_query_paired_devices_failed;
 832         }
 833
 834         return retval;
 835
 836 logi_dj_recv_query_paired_devices_failed:
 837         hdev->ll_driver->close(hdev);
 838
 839 llopen_failed:
 840 switch_to_dj_mode_fail:
 841         hid_hw_stop(hdev);
 842
 843 hid_hw_start_fail:
 844 hid_parse_fail:
 845         kfifo_free(&djrcv_dev->notif_fifo);
 846         kfree(djrcv_dev);
 847         hid_set_drvdata(hdev, NULL);
 848         return retval;
 849
 850 }
 851
 852 #ifdef CONFIG_PM
 853 static int logi_dj_reset_resume(struct hid_device *hdev)
 854 {
 855         int retval;
 856         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
 857
 858         retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0);
 859         if (retval < 0) {
 860                 dev_err(&hdev->dev,
 861                         "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n",
 862                         __func__, retval);
 863         }
 864
 865         return 0;
 866 }
 867 #endif
 868
 869 static void logi_dj_remove(struct hid_device *hdev)
 870 {
 871         struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
 872         struct dj_device *dj_dev;
 873         int i;
 874
 875         dbg_hid("%s\n", __func__);
 876
 877         cancel_work_sync(&djrcv_dev->work);
 878
 879         hdev->ll_driver->close(hdev);
 880         hid_hw_stop(hdev);
 881
 882         /* I suppose that at this point the only context that can access
 883          * the djrecv_data is this thread as the work item is guaranteed to
 884          * have finished and no more raw_event callbacks should arrive after
 885          * the remove callback was triggered so no locks are put around the
 886          * code below */
 887         for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) {
 888                 dj_dev = djrcv_dev->paired_dj_devices[i];
 889                 if (dj_dev != NULL) {
 890                         hid_destroy_device(dj_dev->hdev);
 891                         kfree(dj_dev);
 892                         djrcv_dev->paired_dj_devices[i] = NULL;
 893                 }
 894         }
 895
 896         kfifo_free(&djrcv_dev->notif_fifo);
 897         kfree(djrcv_dev);
 898         hid_set_drvdata(hdev, NULL);
 899 }
 900
 901 static int logi_djdevice_probe(struct hid_device *hdev,
 902                          const struct hid_device_id *id)
 903 {
 904         int ret;
 905         struct dj_device *dj_dev = hdev->driver_data;
 906
 907         if (!is_dj_device(dj_dev))
 908                 return -ENODEV;
 909
 910         ret = hid_parse(hdev);
 911         if (!ret)
 912                 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 913
 914         return ret;
 915 }
 916
 917 static const struct hid_device_id logi_dj_receivers[] = {
 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 MODULE_DEVICE_TABLE(hid, logi_dj_receivers);
 926
 927 static struct hid_driver logi_djreceiver_driver = {
 928         .name = "logitech-djreceiver",
 929         .id_table = logi_dj_receivers,
 930         .probe = logi_dj_probe,
 931         .remove = logi_dj_remove,
 932         .raw_event = logi_dj_raw_event,
 933 #ifdef CONFIG_PM
 934         .reset_resume = logi_dj_reset_resume,
 935 #endif
 936 };
 937
 938
 939 static const struct hid_device_id logi_dj_devices[] = {
 940         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
 941                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
 942         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
 943                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
 944         {}
 945 };
 946
 947 static struct hid_driver logi_djdevice_driver = {
 948         .name = "logitech-djdevice",
 949         .id_table = logi_dj_devices,
 950         .probe = logi_djdevice_probe,
 951 };
 952
 953
 954 static int __init logi_dj_init(void)
 955 {
 956         int retval;
 957
 958         dbg_hid("Logitech-DJ:%s\n", __func__);
 959
 960         retval = hid_register_driver(&logi_djreceiver_driver);
 961         if (retval)
 962                 return retval;
 963
 964         retval = hid_register_driver(&logi_djdevice_driver);
 965         if (retval)
 966                 hid_unregister_driver(&logi_djreceiver_driver);
 967
 968         return retval;
 969
 970 }
 971
 972 static void __exit logi_dj_exit(void)
 973 {
 974         dbg_hid("Logitech-DJ:%s\n", __func__);
 975
 976         hid_unregister_driver(&logi_djdevice_driver);
 977         hid_unregister_driver(&logi_djreceiver_driver);
 978
 979 }
 980
 981 module_init(logi_dj_init);
 982 module_exit(logi_dj_exit);
 983 MODULE_LICENSE("GPL");
 984 MODULE_AUTHOR("Logitech");
 985 MODULE_AUTHOR("Nestor Lopez Casado");
 986 MODULE_AUTHOR("nlopezcasad@logitech.com");