]> Pileus Git - ~andy/linux/blobdiff - drivers/hid/hid-sony.c
Merge tag 'fbdev-for-3.11' of git://git.kernel.org/pub/scm/linux/kernel/git/plagnioj...
[~andy/linux] / drivers / hid / hid-sony.c
index 312098e4af4f092bd40b38e6f2bb79a3d3769d8b..ecbc74923d063d6494aaa4648f08d91a6c44e686 100644 (file)
@@ -1,11 +1,13 @@
 /*
- *  HID driver for some sony "special" devices
+ *  HID driver for Sony / PS2 / PS3 BD devices.
  *
  *  Copyright (c) 1999 Andreas Gal
  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
  *  Copyright (c) 2008 Jiri Slaby
- *  Copyright (c) 2006-2008 Jiri Kosina
+ *  Copyright (c) 2012 David Dillow <dave@thedillows.org>
+ *  Copyright (c) 2006-2013 Jiri Kosina
+ *  Copyright (c) 2013 Colin Leitner <colin.leitner@gmail.com>
  */
 
 /*
  * any later version.
  */
 
+/* NOTE: in order for the Sony PS3 BD Remote Control to be found by
+ * a Bluetooth host, the key combination Start+Enter has to be kept pressed
+ * for about 7 seconds with the Bluetooth Host Controller in discovering mode.
+ *
+ * There will be no PIN request from the device.
+ */
+
 #include <linux/device.h>
 #include <linux/hid.h>
 #include <linux/module.h>
 #include <linux/slab.h>
 #include <linux/usb.h>
+#include <linux/leds.h>
 
 #include "hid-ids.h"
 
 #define VAIO_RDESC_CONSTANT     (1 << 0)
 #define SIXAXIS_CONTROLLER_USB  (1 << 1)
 #define SIXAXIS_CONTROLLER_BT   (1 << 2)
+#define BUZZ_CONTROLLER         (1 << 3)
+#define PS3REMOTE              (1 << 4)
 
 static const u8 sixaxis_rdesc_fixup[] = {
        0x95, 0x13, 0x09, 0x01, 0x81, 0x02, 0x95, 0x0C,
@@ -55,10 +67,214 @@ static const u8 sixaxis_rdesc_fixup2[] = {
        0xb1, 0x02, 0xc0, 0xc0,
 };
 
+static __u8 ps3remote_rdesc[] = {
+       0x05, 0x01,          /* GUsagePage Generic Desktop */
+       0x09, 0x05,          /* LUsage 0x05 [Game Pad] */
+       0xA1, 0x01,          /* MCollection Application (mouse, keyboard) */
+
+        /* Use collection 1 for joypad buttons */
+        0xA1, 0x02,         /* MCollection Logical (interrelated data) */
+
+         /* Ignore the 1st byte, maybe it is used for a controller
+          * number but it's not needed for correct operation */
+         0x75, 0x08,        /* GReportSize 0x08 [8] */
+         0x95, 0x01,        /* GReportCount 0x01 [1] */
+         0x81, 0x01,        /* MInput 0x01 (Const[0] Arr[1] Abs[2]) */
+
+         /* Bytes from 2nd to 4th are a bitmap for joypad buttons, for these
+          * buttons multiple keypresses are allowed */
+         0x05, 0x09,        /* GUsagePage Button */
+         0x19, 0x01,        /* LUsageMinimum 0x01 [Button 1 (primary/trigger)] */
+         0x29, 0x18,        /* LUsageMaximum 0x18 [Button 24] */
+         0x14,              /* GLogicalMinimum [0] */
+         0x25, 0x01,        /* GLogicalMaximum 0x01 [1] */
+         0x75, 0x01,        /* GReportSize 0x01 [1] */
+         0x95, 0x18,        /* GReportCount 0x18 [24] */
+         0x81, 0x02,        /* MInput 0x02 (Data[0] Var[1] Abs[2]) */
+
+         0xC0,              /* MEndCollection */
+
+        /* Use collection 2 for remote control buttons */
+        0xA1, 0x02,         /* MCollection Logical (interrelated data) */
+
+         /* 5th byte is used for remote control buttons */
+         0x05, 0x09,        /* GUsagePage Button */
+         0x18,              /* LUsageMinimum [No button pressed] */
+         0x29, 0xFE,        /* LUsageMaximum 0xFE [Button 254] */
+         0x14,              /* GLogicalMinimum [0] */
+         0x26, 0xFE, 0x00,  /* GLogicalMaximum 0x00FE [254] */
+         0x75, 0x08,        /* GReportSize 0x08 [8] */
+         0x95, 0x01,        /* GReportCount 0x01 [1] */
+         0x80,              /* MInput  */
+
+         /* Ignore bytes from 6th to 11th, 6th to 10th are always constant at
+          * 0xff and 11th is for press indication */
+         0x75, 0x08,        /* GReportSize 0x08 [8] */
+         0x95, 0x06,        /* GReportCount 0x06 [6] */
+         0x81, 0x01,        /* MInput 0x01 (Const[0] Arr[1] Abs[2]) */
+
+         /* 12th byte is for battery strength */
+         0x05, 0x06,        /* GUsagePage Generic Device Controls */
+         0x09, 0x20,        /* LUsage 0x20 [Battery Strength] */
+         0x14,              /* GLogicalMinimum [0] */
+         0x25, 0x05,        /* GLogicalMaximum 0x05 [5] */
+         0x75, 0x08,        /* GReportSize 0x08 [8] */
+         0x95, 0x01,        /* GReportCount 0x01 [1] */
+         0x81, 0x02,        /* MInput 0x02 (Data[0] Var[1] Abs[2]) */
+
+         0xC0,              /* MEndCollection */
+
+        0xC0                /* MEndCollection [Game Pad] */
+};
+
+static const unsigned int ps3remote_keymap_joypad_buttons[] = {
+       [0x01] = KEY_SELECT,
+       [0x02] = BTN_THUMBL,            /* L3 */
+       [0x03] = BTN_THUMBR,            /* R3 */
+       [0x04] = BTN_START,
+       [0x05] = KEY_UP,
+       [0x06] = KEY_RIGHT,
+       [0x07] = KEY_DOWN,
+       [0x08] = KEY_LEFT,
+       [0x09] = BTN_TL2,               /* L2 */
+       [0x0a] = BTN_TR2,               /* R2 */
+       [0x0b] = BTN_TL,                /* L1 */
+       [0x0c] = BTN_TR,                /* R1 */
+       [0x0d] = KEY_OPTION,            /* options/triangle */
+       [0x0e] = KEY_BACK,              /* back/circle */
+       [0x0f] = BTN_0,                 /* cross */
+       [0x10] = KEY_SCREEN,            /* view/square */
+       [0x11] = KEY_HOMEPAGE,          /* PS button */
+       [0x14] = KEY_ENTER,
+};
+static const unsigned int ps3remote_keymap_remote_buttons[] = {
+       [0x00] = KEY_1,
+       [0x01] = KEY_2,
+       [0x02] = KEY_3,
+       [0x03] = KEY_4,
+       [0x04] = KEY_5,
+       [0x05] = KEY_6,
+       [0x06] = KEY_7,
+       [0x07] = KEY_8,
+       [0x08] = KEY_9,
+       [0x09] = KEY_0,
+       [0x0e] = KEY_ESC,               /* return */
+       [0x0f] = KEY_CLEAR,
+       [0x16] = KEY_EJECTCD,
+       [0x1a] = KEY_MENU,              /* top menu */
+       [0x28] = KEY_TIME,
+       [0x30] = KEY_PREVIOUS,
+       [0x31] = KEY_NEXT,
+       [0x32] = KEY_PLAY,
+       [0x33] = KEY_REWIND,            /* scan back */
+       [0x34] = KEY_FORWARD,           /* scan forward */
+       [0x38] = KEY_STOP,
+       [0x39] = KEY_PAUSE,
+       [0x40] = KEY_CONTEXT_MENU,      /* pop up/menu */
+       [0x60] = KEY_FRAMEBACK,         /* slow/step back */
+       [0x61] = KEY_FRAMEFORWARD,      /* slow/step forward */
+       [0x63] = KEY_SUBTITLE,
+       [0x64] = KEY_AUDIO,
+       [0x65] = KEY_ANGLE,
+       [0x70] = KEY_INFO,              /* display */
+       [0x80] = KEY_BLUE,
+       [0x81] = KEY_RED,
+       [0x82] = KEY_GREEN,
+       [0x83] = KEY_YELLOW,
+};
+
+static const unsigned int buzz_keymap[] = {
+       /* The controller has 4 remote buzzers, each with one LED and 5
+        * buttons.
+        * 
+        * We use the mapping chosen by the controller, which is:
+        *
+        * Key          Offset
+        * -------------------
+        * Buzz              1
+        * Blue              5
+        * Orange            4
+        * Green             3
+        * Yellow            2
+        *
+        * So, for example, the orange button on the third buzzer is mapped to
+        * BTN_TRIGGER_HAPPY14
+        */
+       [ 1] = BTN_TRIGGER_HAPPY1,
+       [ 2] = BTN_TRIGGER_HAPPY2,
+       [ 3] = BTN_TRIGGER_HAPPY3,
+       [ 4] = BTN_TRIGGER_HAPPY4,
+       [ 5] = BTN_TRIGGER_HAPPY5,
+       [ 6] = BTN_TRIGGER_HAPPY6,
+       [ 7] = BTN_TRIGGER_HAPPY7,
+       [ 8] = BTN_TRIGGER_HAPPY8,
+       [ 9] = BTN_TRIGGER_HAPPY9,
+       [10] = BTN_TRIGGER_HAPPY10,
+       [11] = BTN_TRIGGER_HAPPY11,
+       [12] = BTN_TRIGGER_HAPPY12,
+       [13] = BTN_TRIGGER_HAPPY13,
+       [14] = BTN_TRIGGER_HAPPY14,
+       [15] = BTN_TRIGGER_HAPPY15,
+       [16] = BTN_TRIGGER_HAPPY16,
+       [17] = BTN_TRIGGER_HAPPY17,
+       [18] = BTN_TRIGGER_HAPPY18,
+       [19] = BTN_TRIGGER_HAPPY19,
+       [20] = BTN_TRIGGER_HAPPY20,
+};
+
 struct sony_sc {
        unsigned long quirks;
+
+       void *extra;
 };
 
+struct buzz_extra {
+       int led_state;
+       struct led_classdev *leds[4];
+};
+
+static __u8 *ps3remote_fixup(struct hid_device *hdev, __u8 *rdesc,
+                            unsigned int *rsize)
+{
+       *rsize = sizeof(ps3remote_rdesc);
+       return ps3remote_rdesc;
+}
+
+static int ps3remote_mapping(struct hid_device *hdev, struct hid_input *hi,
+                            struct hid_field *field, struct hid_usage *usage,
+                            unsigned long **bit, int *max)
+{
+       unsigned int key = usage->hid & HID_USAGE;
+
+       if ((usage->hid & HID_USAGE_PAGE) != HID_UP_BUTTON)
+               return -1;
+
+       switch (usage->collection_index) {
+       case 1:
+               if (key >= ARRAY_SIZE(ps3remote_keymap_joypad_buttons))
+                       return -1;
+
+               key = ps3remote_keymap_joypad_buttons[key];
+               if (!key)
+                       return -1;
+               break;
+       case 2:
+               if (key >= ARRAY_SIZE(ps3remote_keymap_remote_buttons))
+                       return -1;
+
+               key = ps3remote_keymap_remote_buttons[key];
+               if (!key)
+                       return -1;
+               break;
+       default:
+               return -1;
+       }
+
+       hid_map_usage_clear(hi, usage, bit, max, EV_KEY, key);
+       return 1;
+}
+
+
 /* Sony Vaio VGX has wrongly mouse pointer declared as constant */
 static __u8 *sony_report_fixup(struct hid_device *hdev, __u8 *rdesc,
                unsigned int *rsize)
@@ -95,6 +311,10 @@ static __u8 *sony_report_fixup(struct hid_device *hdev, __u8 *rdesc,
                *rsize = sizeof(sixaxis_rdesc_fixup2);
                memcpy(rdesc, &sixaxis_rdesc_fixup2, *rsize);
        }
+
+       if (sc->quirks & PS3REMOTE)
+               return ps3remote_fixup(hdev, rdesc, rsize);
+
        return rdesc;
 }
 
@@ -117,6 +337,41 @@ static int sony_raw_event(struct hid_device *hdev, struct hid_report *report,
        return 0;
 }
 
+static int sony_mapping(struct hid_device *hdev, struct hid_input *hi,
+                       struct hid_field *field, struct hid_usage *usage,
+                       unsigned long **bit, int *max)
+{
+       struct sony_sc *sc = hid_get_drvdata(hdev);
+
+       if (sc->quirks & BUZZ_CONTROLLER) {
+               unsigned int key = usage->hid & HID_USAGE;
+
+               if ((usage->hid & HID_USAGE_PAGE) != HID_UP_BUTTON)
+                       return -1;
+
+               switch (usage->collection_index) {
+               case 1:
+                       if (key >= ARRAY_SIZE(buzz_keymap))
+                               return -1;
+
+                       key = buzz_keymap[key];
+                       if (!key)
+                               return -1;
+                       break;
+               default:
+                       return -1;
+               }
+
+               hid_map_usage_clear(hi, usage, bit, max, EV_KEY, key);
+               return 1;
+       }
+
+       if (sc->quirks & PS3REMOTE)
+               return ps3remote_mapping(hdev, hi, field, usage, bit, max);
+
+       return -1;
+}
+
 /*
  * The Sony Sixaxis does not handle HID Output Reports on the Interrupt EP
  * like it should according to usbhid/hid-core.c::usbhid_output_raw_report()
@@ -192,11 +447,181 @@ static int sixaxis_set_operational_bt(struct hid_device *hdev)
        return hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
 }
 
+static void buzz_set_leds(struct hid_device *hdev, int leds)
+{
+       struct list_head *report_list =
+               &hdev->report_enum[HID_OUTPUT_REPORT].report_list;
+       struct hid_report *report = list_entry(report_list->next,
+               struct hid_report, list);
+       __s32 *value = report->field[0]->value;
+
+       value[0] = 0x00;
+       value[1] = (leds & 1) ? 0xff : 0x00;
+       value[2] = (leds & 2) ? 0xff : 0x00;
+       value[3] = (leds & 4) ? 0xff : 0x00;
+       value[4] = (leds & 8) ? 0xff : 0x00;
+       value[5] = 0x00;
+       value[6] = 0x00;
+       hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
+}
+
+static void buzz_led_set_brightness(struct led_classdev *led,
+                                   enum led_brightness value)
+{
+       struct device *dev = led->dev->parent;
+       struct hid_device *hdev = container_of(dev, struct hid_device, dev);
+       struct sony_sc *drv_data;
+       struct buzz_extra *buzz;
+
+       int n;
+
+       drv_data = hid_get_drvdata(hdev);
+       if (!drv_data || !drv_data->extra) {
+               hid_err(hdev, "No device data\n");
+               return;
+       }
+       buzz = drv_data->extra;
+
+       for (n = 0; n < 4; n++) {
+               if (led == buzz->leds[n]) {
+                       int on = !! (buzz->led_state & (1 << n));
+                       if (value == LED_OFF && on) {
+                               buzz->led_state &= ~(1 << n);
+                               buzz_set_leds(hdev, buzz->led_state);
+                       } else if (value != LED_OFF && !on) {
+                               buzz->led_state |= (1 << n);
+                               buzz_set_leds(hdev, buzz->led_state);
+                       }
+                       break;
+               }
+       }
+}
+
+static enum led_brightness buzz_led_get_brightness(struct led_classdev *led)
+{
+       struct device *dev = led->dev->parent;
+       struct hid_device *hdev = container_of(dev, struct hid_device, dev);
+       struct sony_sc *drv_data;
+       struct buzz_extra *buzz;
+
+       int n;
+       int on = 0;
+
+       drv_data = hid_get_drvdata(hdev);
+       if (!drv_data || !drv_data->extra) {
+               hid_err(hdev, "No device data\n");
+               return LED_OFF;
+       }
+       buzz = drv_data->extra;
+
+       for (n = 0; n < 4; n++) {
+               if (led == buzz->leds[n]) {
+                       on = !! (buzz->led_state & (1 << n));
+                       break;
+               }
+       }
+
+       return on ? LED_FULL : LED_OFF;
+}
+
+static int buzz_init(struct hid_device *hdev)
+{
+       struct sony_sc *drv_data;
+       struct buzz_extra *buzz;
+       int n, ret = 0;
+       struct led_classdev *led;
+       size_t name_sz;
+       char *name;
+
+       drv_data = hid_get_drvdata(hdev);
+       BUG_ON(!(drv_data->quirks & BUZZ_CONTROLLER));
+
+       buzz = kzalloc(sizeof(*buzz), GFP_KERNEL);
+       if (!buzz) {
+               hid_err(hdev, "Insufficient memory, cannot allocate driver data\n");
+               return -ENOMEM;
+       }
+       drv_data->extra = buzz;
+
+       /* Clear LEDs as we have no way of reading their initial state. This is
+        * only relevant if the driver is loaded after somebody actively set the
+        * LEDs to on */
+       buzz_set_leds(hdev, 0x00);
+
+       name_sz = strlen(dev_name(&hdev->dev)) + strlen("::buzz#") + 1;
+
+       for (n = 0; n < 4; n++) {
+               led = kzalloc(sizeof(struct led_classdev) + name_sz, GFP_KERNEL);
+               if (!led) {
+                       hid_err(hdev, "Couldn't allocate memory for LED %d\n", n);
+                       goto error_leds;
+               }
+
+               name = (void *)(&led[1]);
+               snprintf(name, name_sz, "%s::buzz%d", dev_name(&hdev->dev), n + 1);
+               led->name = name;
+               led->brightness = 0;
+               led->max_brightness = 1;
+               led->brightness_get = buzz_led_get_brightness;
+               led->brightness_set = buzz_led_set_brightness;
+
+               if (led_classdev_register(&hdev->dev, led)) {
+                       hid_err(hdev, "Failed to register LED %d\n", n);
+                       kfree(led);
+                       goto error_leds;
+               }
+
+               buzz->leds[n] = led;
+       }
+
+       return ret;
+
+error_leds:
+       for (n = 0; n < 4; n++) {
+               led = buzz->leds[n];
+               buzz->leds[n] = NULL;
+               if (!led)
+                       continue;
+               led_classdev_unregister(led);
+               kfree(led);
+       }
+
+       kfree(drv_data->extra);
+       drv_data->extra = NULL;
+       return ret;
+}
+
+static void buzz_remove(struct hid_device *hdev)
+{
+       struct sony_sc *drv_data;
+       struct buzz_extra *buzz;
+       struct led_classdev *led;
+       int n;
+
+       drv_data = hid_get_drvdata(hdev);
+       BUG_ON(!(drv_data->quirks & BUZZ_CONTROLLER));
+
+       buzz = drv_data->extra;
+
+       for (n = 0; n < 4; n++) {
+               led = buzz->leds[n];
+               buzz->leds[n] = NULL;
+               if (!led)
+                       continue;
+               led_classdev_unregister(led);
+               kfree(led);
+       }
+
+       kfree(drv_data->extra);
+       drv_data->extra = NULL;
+}
+
 static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
 {
        int ret;
        unsigned long quirks = id->driver_data;
        struct sony_sc *sc;
+       unsigned int connect_mask = HID_CONNECT_DEFAULT;
 
        sc = kzalloc(sizeof(*sc), GFP_KERNEL);
        if (sc == NULL) {
@@ -213,8 +638,14 @@ static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
                goto err_free;
        }
 
-       ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT |
-                       HID_CONNECT_HIDDEV_FORCE);
+       if (sc->quirks & VAIO_RDESC_CONSTANT)
+               connect_mask |= HID_CONNECT_HIDDEV_FORCE;
+       else if (sc->quirks & SIXAXIS_CONTROLLER_USB)
+               connect_mask |= HID_CONNECT_HIDDEV_FORCE;
+       else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
+               connect_mask |= HID_CONNECT_HIDDEV_FORCE;
+
+       ret = hid_hw_start(hdev, connect_mask);
        if (ret) {
                hid_err(hdev, "hw start failed\n");
                goto err_free;
@@ -226,6 +657,8 @@ static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
        }
        else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
                ret = sixaxis_set_operational_bt(hdev);
+       else if (sc->quirks & BUZZ_CONTROLLER)
+               ret = buzz_init(hdev);
        else
                ret = 0;
 
@@ -242,8 +675,13 @@ err_free:
 
 static void sony_remove(struct hid_device *hdev)
 {
+       struct sony_sc *sc = hid_get_drvdata(hdev);
+
+       if (sc->quirks & BUZZ_CONTROLLER)
+               buzz_remove(hdev);
+
        hid_hw_stop(hdev);
-       kfree(hid_get_drvdata(hdev));
+       kfree(sc);
 }
 
 static const struct hid_device_id sony_devices[] = {
@@ -257,17 +695,30 @@ static const struct hid_device_id sony_devices[] = {
                .driver_data = VAIO_RDESC_CONSTANT },
        { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGP_MOUSE),
                .driver_data = VAIO_RDESC_CONSTANT },
+       /* Wired Buzz Controller. Reported as Sony Hub from its USB ID and as
+        * Logitech joystick from the device descriptor. */
+       { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_BUZZ_CONTROLLER),
+               .driver_data = BUZZ_CONTROLLER },
+       { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_WIRELESS_BUZZ_CONTROLLER),
+               .driver_data = BUZZ_CONTROLLER },
+       /* PS3 BD Remote Control */
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_BDREMOTE),
+               .driver_data = PS3REMOTE },
+       /* Logitech Harmony Adapter for PS3 */
+       { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_HARMONY_PS3),
+               .driver_data = PS3REMOTE },
        { }
 };
 MODULE_DEVICE_TABLE(hid, sony_devices);
 
 static struct hid_driver sony_driver = {
-       .name = "sony",
-       .id_table = sony_devices,
-       .probe = sony_probe,
-       .remove = sony_remove,
-       .report_fixup = sony_report_fixup,
-       .raw_event = sony_raw_event
+       .name          = "sony",
+       .id_table      = sony_devices,
+       .input_mapping = sony_mapping,
+       .probe         = sony_probe,
+       .remove        = sony_remove,
+       .report_fixup  = sony_report_fixup,
+       .raw_event     = sony_raw_event
 };
 module_hid_driver(sony_driver);