1 files changed, 300 insertions, 97 deletions

diff --git a/drivers/hid/hid-logitech-dj.c b/drivers/hid/hid-logitech-dj.c
index 71f569292cab..c917ab61aafa 100644
--- a/drivers/hid/hid-logitech-dj.c
+++ b/drivers/hid/hid-logitech-dj.c
@@ -26,9 +26,104 @@
 #include <linux/hid.h>
 #include <linux/module.h>
 #include <linux/usb.h>
+#include <linux/kfifo.h>
 #include <asm/unaligned.h>
 #include "hid-ids.h"
-#include "hid-logitech-dj.h"
+
+#define DJ_MAX_PAIRED_DEVICES                   6
+#define DJ_MAX_NUMBER_NOTIFICATIONS             8
+#define DJ_RECEIVER_INDEX                       0
+#define DJ_DEVICE_INDEX_MIN                     1
+#define DJ_DEVICE_INDEX_MAX                     6
+
+#define DJREPORT_SHORT_LENGTH                   15
+#define DJREPORT_LONG_LENGTH                    32
+
+#define REPORT_ID_DJ_SHORT                      0x20
+#define REPORT_ID_DJ_LONG                       0x21
+
+#define REPORT_ID_HIDPP_SHORT                   0x10
+#define REPORT_ID_HIDPP_LONG                    0x11
+
+#define HIDPP_REPORT_SHORT_LENGTH               7
+#define HIDPP_REPORT_LONG_LENGTH                20
+
+#define HIDPP_RECEIVER_INDEX                    0xff
+
+#define REPORT_TYPE_RFREPORT_FIRST              0x01
+#define REPORT_TYPE_RFREPORT_LAST               0x1F
+
+/* Command Switch to DJ mode */
+#define REPORT_TYPE_CMD_SWITCH                  0x80
+#define CMD_SWITCH_PARAM_DEVBITFIELD            0x00
+#define CMD_SWITCH_PARAM_TIMEOUT_SECONDS        0x01
+#define TIMEOUT_NO_KEEPALIVE                    0x00
+
+/* Command to Get the list of Paired devices */
+#define REPORT_TYPE_CMD_GET_PAIRED_DEVICES      0x81
+
+/* Device Paired Notification */
+#define REPORT_TYPE_NOTIF_DEVICE_PAIRED         0x41
+#define SPFUNCTION_MORE_NOTIF_EXPECTED          0x01
+#define SPFUNCTION_DEVICE_LIST_EMPTY            0x02
+#define DEVICE_PAIRED_PARAM_SPFUNCTION          0x00
+#define DEVICE_PAIRED_PARAM_EQUAD_ID_LSB        0x01
+#define DEVICE_PAIRED_PARAM_EQUAD_ID_MSB        0x02
+#define DEVICE_PAIRED_RF_REPORT_TYPE            0x03
+
+/* Device Un-Paired Notification */
+#define REPORT_TYPE_NOTIF_DEVICE_UNPAIRED       0x40
+
+
+/* Connection Status Notification */
+#define REPORT_TYPE_NOTIF_CONNECTION_STATUS     0x42
+#define CONNECTION_STATUS_PARAM_STATUS          0x00
+#define STATUS_LINKLOSS                         0x01
+
+/* Error Notification */
+#define REPORT_TYPE_NOTIF_ERROR                 0x7F
+#define NOTIF_ERROR_PARAM_ETYPE                 0x00
+#define ETYPE_KEEPALIVE_TIMEOUT                 0x01
+
+/* supported DJ HID && RF report types */
+#define REPORT_TYPE_KEYBOARD                    0x01
+#define REPORT_TYPE_MOUSE                       0x02
+#define REPORT_TYPE_CONSUMER_CONTROL            0x03
+#define REPORT_TYPE_SYSTEM_CONTROL              0x04
+#define REPORT_TYPE_MEDIA_CENTER                0x08
+#define REPORT_TYPE_LEDS                        0x0E
+
+/* RF Report types bitfield */
+#define STD_KEYBOARD                            0x00000002
+#define STD_MOUSE                               0x00000004
+#define MULTIMEDIA                              0x00000008
+#define POWER_KEYS                              0x00000010
+#define MEDIA_CENTER                            0x00000100
+#define KBD_LEDS                                0x00004000
+
+struct dj_report {
+        u8 report_id;
+        u8 device_index;
+        u8 report_type;
+        u8 report_params[DJREPORT_SHORT_LENGTH - 3];
+};
+
+struct dj_receiver_dev {
+        struct hid_device *hdev;
+        struct dj_device *paired_dj_devices[DJ_MAX_PAIRED_DEVICES +
+                                            DJ_DEVICE_INDEX_MIN];
+        struct work_struct work;
+        struct kfifo notif_fifo;
+        spinlock_t lock;
+        bool querying_devices;
+};
+
+struct dj_device {
+        struct hid_device *hdev;
+        struct dj_receiver_dev *dj_receiver_dev;
+        u32 reports_supported;
+        u8 device_index;
+};
 
 /* Keyboard descriptor (1) */
 static const char kbd_descriptor[] = {
@@ -156,6 +251,57 @@ static const char media_descriptor[] = {
         0xc0,                   /* EndCollection                       */
 };                              /*                                     */
 
+/* HIDPP descriptor */
+static const char hidpp_descriptor[] = {
+        0x06, 0x00, 0xff,       /* Usage Page (Vendor Defined Page 1)  */
+        0x09, 0x01,             /* Usage (Vendor Usage 1)              */
+        0xa1, 0x01,             /* Collection (Application)            */
+        0x85, 0x10,             /*   Report ID (16)                    */
+        0x75, 0x08,             /*   Report Size (8)                   */
+        0x95, 0x06,             /*   Report Count (6)                  */
+        0x15, 0x00,             /*   Logical Minimum (0)               */
+        0x26, 0xff, 0x00,       /*   Logical Maximum (255)             */
+        0x09, 0x01,             /*   Usage (Vendor Usage 1)            */
+        0x81, 0x00,             /*   Input (Data,Arr,Abs)              */
+        0x09, 0x01,             /*   Usage (Vendor Usage 1)            */
+        0x91, 0x00,             /*   Output (Data,Arr,Abs)             */
+        0xc0,                   /* End Collection                      */
+        0x06, 0x00, 0xff,       /* Usage Page (Vendor Defined Page 1)  */
+        0x09, 0x02,             /* Usage (Vendor Usage 2)              */
+        0xa1, 0x01,             /* Collection (Application)            */
+        0x85, 0x11,             /*   Report ID (17)                    */
+        0x75, 0x08,             /*   Report Size (8)                   */
+        0x95, 0x13,             /*   Report Count (19)                 */
+        0x15, 0x00,             /*   Logical Minimum (0)               */
+        0x26, 0xff, 0x00,       /*   Logical Maximum (255)             */
+        0x09, 0x02,             /*   Usage (Vendor Usage 2)            */
+        0x81, 0x00,             /*   Input (Data,Arr,Abs)              */
+        0x09, 0x02,             /*   Usage (Vendor Usage 2)            */
+        0x91, 0x00,             /*   Output (Data,Arr,Abs)             */
+        0xc0,                   /* End Collection                      */
+        0x06, 0x00, 0xff,       /* Usage Page (Vendor Defined Page 1)  */
+        0x09, 0x04,             /* Usage (Vendor Usage 0x04)           */
+        0xa1, 0x01,             /* Collection (Application)            */
+        0x85, 0x20,             /*   Report ID (32)                    */
+        0x75, 0x08,             /*   Report Size (8)                   */
+        0x95, 0x0e,             /*   Report Count (14)                 */
+        0x15, 0x00,             /*   Logical Minimum (0)               */
+        0x26, 0xff, 0x00,       /*   Logical Maximum (255)             */
+        0x09, 0x41,             /*   Usage (Vendor Usage 0x41)         */
+        0x81, 0x00,             /*   Input (Data,Arr,Abs)              */
+        0x09, 0x41,             /*   Usage (Vendor Usage 0x41)         */
+        0x91, 0x00,             /*   Output (Data,Arr,Abs)             */
+        0x85, 0x21,             /*   Report ID (33)                    */
+        0x95, 0x1f,             /*   Report Count (31)                 */
+        0x15, 0x00,             /*   Logical Minimum (0)               */
+        0x26, 0xff, 0x00,       /*   Logical Maximum (255)             */
+        0x09, 0x42,             /*   Usage (Vendor Usage 0x42)         */
+        0x81, 0x00,             /*   Input (Data,Arr,Abs)              */
+        0x09, 0x42,             /*   Usage (Vendor Usage 0x42)         */
+        0x91, 0x00,             /*   Output (Data,Arr,Abs)             */
+        0xc0,                   /* End Collection                      */
+};
+
 /* Maximum size of all defined hid reports in bytes (including report id) */
 #define MAX_REPORT_SIZE 8
 
@@ -165,7 +311,8 @@ static const char media_descriptor[] = {
          sizeof(mse_descriptor) +               \
          sizeof(consumer_descriptor) +          \
          sizeof(syscontrol_descriptor) +        \
-         sizeof(media_descriptor))
+         sizeof(media_descriptor) +     \
+         sizeof(hidpp_descriptor))
 
 /* Number of possible hid report types that can be created by this driver.
  *
@@ -256,11 +403,15 @@ static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev,
         dj_hiddev->dev.parent = &djrcv_hdev->dev;
         dj_hiddev->bus = BUS_USB;
         dj_hiddev->vendor = le16_to_cpu(usbdev->descriptor.idVendor);
-        dj_hiddev->product = le16_to_cpu(usbdev->descriptor.idProduct);
+        dj_hiddev->product =
+                (dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB]
+                                                                        << 8) |
+                dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB];
         snprintf(dj_hiddev->name, sizeof(dj_hiddev->name),
-                "Logitech Unifying Device. Wireless PID:%02x%02x",
-                dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB],
-                dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB]);
+                "Logitech Unifying Device. Wireless PID:%04x",
+                dj_hiddev->product);
+
+        dj_hiddev->group = HID_GROUP_LOGITECH_DJ_DEVICE;
 
         usb_make_path(usbdev, dj_hiddev->phys, sizeof(dj_hiddev->phys));
         snprintf(tmpstr, sizeof(tmpstr), ":%d", dj_report->device_index);
@@ -422,6 +573,13 @@ static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev,
         }
 }
 
+static void logi_dj_recv_forward_hidpp(struct dj_device *dj_dev, u8 *data,
+                                       int size)
+{
+        /* We are called from atomic context (tasklet && djrcv->lock held) */
+        if (hid_input_report(dj_dev->hdev, HID_INPUT_REPORT, data, size, 1))
+                dbg_hid("hid_input_report error\n");
+}
 
 static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev,
                                     struct dj_report *dj_report)
@@ -472,7 +630,9 @@ static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev)
 static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
                                           unsigned timeout)
 {
+        struct hid_device *hdev = djrcv_dev->hdev;
         struct dj_report *dj_report;
+        u8 *buf;
         int retval;
 
         dj_report = kzalloc(sizeof(struct dj_report), GFP_KERNEL);
@@ -484,7 +644,6 @@ static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
         dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F;
         dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout;
         retval = logi_dj_recv_send_report(djrcv_dev, dj_report);
-        kfree(dj_report);
 
         /*
          * Ugly sleep to work around a USB 3.0 bug when the receiver is still
@@ -493,6 +652,30 @@ static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev,
          */
         msleep(50);
 
+        /*
+         * Magical bits to set up hidpp notifications when the dj devices
+         * are connected/disconnected.
+         *
+         * We can reuse dj_report because HIDPP_REPORT_SHORT_LENGTH is smaller
+         * than DJREPORT_SHORT_LENGTH.
+         */
+        buf = (u8 *)dj_report;
+
+        memset(buf, 0, HIDPP_REPORT_SHORT_LENGTH);
+
+        buf[0] = REPORT_ID_HIDPP_SHORT;
+        buf[1] = 0xFF;
+        buf[2] = 0x80;
+        buf[3] = 0x00;
+        buf[4] = 0x00;
+        buf[5] = 0x09;
+        buf[6] = 0x00;
+
+        hid_hw_raw_request(hdev, REPORT_ID_HIDPP_SHORT, buf,
+                        HIDPP_REPORT_SHORT_LENGTH, HID_OUTPUT_REPORT,
+                        HID_REQ_SET_REPORT);
+
+        kfree(dj_report);
         return retval;
 }
 
@@ -509,6 +692,9 @@ static void logi_dj_ll_close(struct hid_device *hid)
         dbg_hid("%s:%s\n", __func__, hid->phys);
 }
 
+static u8 unifying_name_query[]  = {0x10, 0xff, 0x83, 0xb5, 0x40, 0x00, 0x00};
+static u8 unifying_name_answer[] = {0x11, 0xff, 0x83, 0xb5};
+
 static int logi_dj_ll_raw_request(struct hid_device *hid,
                                   unsigned char reportnum, __u8 *buf,
                                   size_t count, unsigned char report_type,
@@ -519,6 +705,22 @@ static int logi_dj_ll_raw_request(struct hid_device *hid,
         u8 *out_buf;
         int ret;
 
+        if ((buf[0] == REPORT_ID_HIDPP_SHORT) ||
+            (buf[0] == REPORT_ID_HIDPP_LONG)) {
+                if (count < 2)
+                        return -EINVAL;
+
+                /* special case where we should not overwrite
+                 * the device_index */
+                if (count == 7 && !memcmp(buf, unifying_name_query,
+                                          sizeof(unifying_name_query)))
+                        buf[4] |= djdev->device_index - 1;
+                else
+                        buf[1] = djdev->device_index;
+                return hid_hw_raw_request(djrcv_dev->hdev, reportnum, buf,
+                                count, report_type, reqtype);
+        }
+
         if (buf[0] != REPORT_TYPE_LEDS)
                 return -EINVAL;
 
@@ -597,6 +799,8 @@ static int logi_dj_ll_parse(struct hid_device *hid)
                         __func__, djdev->reports_supported);
         }
 
+        rdcat(rdesc, &rsize, hidpp_descriptor, sizeof(hidpp_descriptor));
+
         retval = hid_parse_report(hid, rdesc, rsize);
         kfree(rdesc);
 
@@ -624,8 +828,7 @@ static struct hid_ll_driver logi_dj_ll_driver = {
         .raw_request = logi_dj_ll_raw_request,
 };
 
-
-static int logi_dj_raw_event(struct hid_device *hdev,
+static int logi_dj_dj_event(struct hid_device *hdev,
                              struct hid_report *report, u8 *data,
                              int size)
 {
@@ -633,36 +836,24 @@ static int logi_dj_raw_event(struct hid_device *hdev,
         struct dj_report *dj_report = (struct dj_report *) data;
         unsigned long flags;
 
-        dbg_hid("%s, size:%d\n", __func__, size);
-
-        /* Here we receive all data coming from iface 2, there are 4 cases:
-         *
-         * 1) Data should continue its normal processing i.e. data does not
-         * come from the DJ collection, in which case we do nothing and
-         * return 0, so hid-core can continue normal processing (will forward
-         * to associated hidraw device)
+        /*
+         * Here we receive all data coming from iface 2, there are 3 cases:
          *
-         * 2) Data is from DJ collection, and is intended for this driver i. e.
-         * data contains arrival, departure, etc notifications, in which case
-         * we queue them for delayed processing by the work queue. We return 1
-         * to hid-core as no further processing is required from it.
+         * 1) Data is intended for this driver i. e. data contains arrival,
+         * departure, etc notifications, in which case we queue them for delayed
+         * processing by the work queue. We return 1 to hid-core as no further
+         * processing is required from it.
          *
-         * 3) Data is from DJ collection, and informs a connection change,
-         * if the change means rf link loss, then we must send a null report
-         * to the upper layer to discard potentially pressed keys that may be
-         * repeated forever by the input layer. Return 1 to hid-core as no
-         * further processing is required.
+         * 2) Data informs a connection change, if the change means rf link
+         * loss, then we must send a null report to the upper layer to discard
+         * potentially pressed keys that may be repeated forever by the input
+         * layer. Return 1 to hid-core as no further processing is required.
          *
-         * 4) Data is from DJ collection and is an actual input event from
-         * a paired DJ device in which case we forward it to the correct hid
-         * device (via hid_input_report() ) and return 1 so hid-core does not do
-         * anything else with it.
+         * 3) Data is an actual input event from a paired DJ device in which
+         * case we forward it to the correct hid device (via hid_input_report()
+         * ) and return 1 so hid-core does not anything else with it.
          */
 
-        /* case 1) */
-        if (data[0] != REPORT_ID_DJ_SHORT)
-                return false;
-
         if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) ||
             (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) {
                 /*
@@ -707,6 +898,80 @@ out:
         return true;
 }
 
+static int logi_dj_hidpp_event(struct hid_device *hdev,
+                             struct hid_report *report, u8 *data,
+                             int size)
+{
+        struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev);
+        struct dj_report *dj_report = (struct dj_report *) data;
+        unsigned long flags;
+        u8 device_index = dj_report->device_index;
+
+        if (device_index == HIDPP_RECEIVER_INDEX) {
+                /* special case were the device wants to know its unifying
+                 * name */
+                if (size == HIDPP_REPORT_LONG_LENGTH &&
+                    !memcmp(data, unifying_name_answer,
+                            sizeof(unifying_name_answer)) &&
+                    ((data[4] & 0xF0) == 0x40))
+                        device_index = (data[4] & 0x0F) + 1;
+                else
+                        return false;
+        }
+
+        /*
+         * Data is from the HID++ collection, in this case, we forward the
+         * data to the corresponding child dj device and return 0 to hid-core
+         * so he data also goes to the hidraw device of the receiver. This
+         * allows a user space application to implement the full HID++ routing
+         * via the receiver.
+         */
+
+        if ((device_index < DJ_DEVICE_INDEX_MIN) ||
+            (device_index > DJ_DEVICE_INDEX_MAX)) {
+                /*
+                 * Device index is wrong, bail out.
+                 * This driver can ignore safely the receiver notifications,
+                 * so ignore those reports too.
+                 */
+                dev_err(&hdev->dev, "%s: invalid device index:%d\n",
+                                __func__, dj_report->device_index);
+                return false;
+        }
+
+        spin_lock_irqsave(&djrcv_dev->lock, flags);
+
+        if (!djrcv_dev->paired_dj_devices[device_index])
+                /* received an event for an unknown device, bail out */
+                goto out;
+
+        logi_dj_recv_forward_hidpp(djrcv_dev->paired_dj_devices[device_index],
+                                   data, size);
+
+out:
+        spin_unlock_irqrestore(&djrcv_dev->lock, flags);
+
+        return false;
+}
+
+static int logi_dj_raw_event(struct hid_device *hdev,
+                             struct hid_report *report, u8 *data,
+                             int size)
+{
+        dbg_hid("%s, size:%d\n", __func__, size);
+
+        switch (data[0]) {
+        case REPORT_ID_DJ_SHORT:
+                return logi_dj_dj_event(hdev, report, data, size);
+        case REPORT_ID_HIDPP_SHORT:
+                /* intentional fallthrough */
+        case REPORT_ID_HIDPP_LONG:
+                return logi_dj_hidpp_event(hdev, report, data, size);
+        }
+
+        return false;
+}
+
 static int logi_dj_probe(struct hid_device *hdev,
                          const struct hid_device_id *id)
 {
@@ -714,9 +979,6 @@ static int logi_dj_probe(struct hid_device *hdev,
         struct dj_receiver_dev *djrcv_dev;
         int retval;
 
-        if (is_dj_device((struct dj_device *)hdev->driver_data))
-                return -ENODEV;
-
         dbg_hid("%s called for ifnum %d\n", __func__,
                 intf->cur_altsetting->desc.bInterfaceNumber);
 
@@ -869,22 +1131,6 @@ static void logi_dj_remove(struct hid_device *hdev)
         hid_set_drvdata(hdev, NULL);
 }
 
-static int logi_djdevice_probe(struct hid_device *hdev,
-                         const struct hid_device_id *id)
-{
-        int ret;
-        struct dj_device *dj_dev = hdev->driver_data;
-
-        if (!is_dj_device(dj_dev))
-                return -ENODEV;
-
-        ret = hid_parse(hdev);
-        if (!ret)
-                ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
-
-        return ret;
-}
-
 static const struct hid_device_id logi_dj_receivers[] = {
         {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
                 USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
@@ -906,51 +1152,8 @@ static struct hid_driver logi_djreceiver_driver = {
 #endif
 };
 
+module_hid_driver(logi_djreceiver_driver);
 
-static const struct hid_device_id logi_dj_devices[] = {
-        {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
-                USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)},
-        {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH,
-                USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)},
-        {}
-};
-
-static struct hid_driver logi_djdevice_driver = {
-        .name = "logitech-djdevice",
-        .id_table = logi_dj_devices,
-        .probe = logi_djdevice_probe,
-};
-
-
-static int __init logi_dj_init(void)
-{
-        int retval;
-
-        dbg_hid("Logitech-DJ:%s\n", __func__);
-
-        retval = hid_register_driver(&logi_djreceiver_driver);
-        if (retval)
-                return retval;
-
-        retval = hid_register_driver(&logi_djdevice_driver);
-        if (retval)
-                hid_unregister_driver(&logi_djreceiver_driver);
-
-        return retval;
-
-}
-
-static void __exit logi_dj_exit(void)
-{
-        dbg_hid("Logitech-DJ:%s\n", __func__);
-
-        hid_unregister_driver(&logi_djdevice_driver);
-        hid_unregister_driver(&logi_djreceiver_driver);
-
-}
-
-module_init(logi_dj_init);
-module_exit(logi_dj_exit);
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Logitech");
 MODULE_AUTHOR("Nestor Lopez Casado");