drivers/hid/hid-sony.c

   1 /*
   2  *  HID driver for some sony "special" devices
   3  *
   4  *  Copyright (c) 1999 Andreas Gal
   5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
   6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
   7  *  Copyright (c) 2008 Jiri Slaby
   8  *  Copyright (c) 2006-2008 Jiri Kosina
   9  */
  10
  11 /*
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 2 of the License, or (at your option)
  15  * any later version.
  16  */
  17
  18 #include <linux/device.h>
  19 #include <linux/hid.h>
  20 #include <linux/module.h>
  21 #include <linux/slab.h>
  22 #include <linux/usb.h>
  23
  24 #include "hid-ids.h"
  25
  26 #define VAIO_RDESC_CONSTANT     (1 << 0)
  27 #define SIXAXIS_CONTROLLER_USB  (1 << 1)
  28 #define SIXAXIS_CONTROLLER_BT   (1 << 2)
  29
  30 static const u8 sixaxis_rdesc_fixup[] = {
  31         0x95, 0x13, 0x09, 0x01, 0x81, 0x02, 0x95, 0x0C,
  32         0x81, 0x01, 0x75, 0x10, 0x95, 0x04, 0x26, 0xFF,
  33         0x03, 0x46, 0xFF, 0x03, 0x09, 0x01, 0x81, 0x02
  34 };
  35
  36 static const u8 sixaxis_rdesc_fixup2[] = {
  37         0x05, 0x01, 0x09, 0x04, 0xa1, 0x01, 0xa1, 0x02,
  38         0x85, 0x01, 0x75, 0x08, 0x95, 0x01, 0x15, 0x00,
  39         0x26, 0xff, 0x00, 0x81, 0x03, 0x75, 0x01, 0x95,
  40         0x13, 0x15, 0x00, 0x25, 0x01, 0x35, 0x00, 0x45,
  41         0x01, 0x05, 0x09, 0x19, 0x01, 0x29, 0x13, 0x81,
  42         0x02, 0x75, 0x01, 0x95, 0x0d, 0x06, 0x00, 0xff,
  43         0x81, 0x03, 0x15, 0x00, 0x26, 0xff, 0x00, 0x05,
  44         0x01, 0x09, 0x01, 0xa1, 0x00, 0x75, 0x08, 0x95,
  45         0x04, 0x35, 0x00, 0x46, 0xff, 0x00, 0x09, 0x30,
  46         0x09, 0x31, 0x09, 0x32, 0x09, 0x35, 0x81, 0x02,
  47         0xc0, 0x05, 0x01, 0x95, 0x13, 0x09, 0x01, 0x81,
  48         0x02, 0x95, 0x0c, 0x81, 0x01, 0x75, 0x10, 0x95,
  49         0x04, 0x26, 0xff, 0x03, 0x46, 0xff, 0x03, 0x09,
  50         0x01, 0x81, 0x02, 0xc0, 0xa1, 0x02, 0x85, 0x02,
  51         0x75, 0x08, 0x95, 0x30, 0x09, 0x01, 0xb1, 0x02,
  52         0xc0, 0xa1, 0x02, 0x85, 0xee, 0x75, 0x08, 0x95,
  53         0x30, 0x09, 0x01, 0xb1, 0x02, 0xc0, 0xa1, 0x02,
  54         0x85, 0xef, 0x75, 0x08, 0x95, 0x30, 0x09, 0x01,
  55         0xb1, 0x02, 0xc0, 0xc0,
  56 };
  57
  58 struct sony_sc {
  59         unsigned long quirks;
  60 };
  61
  62 /* Sony Vaio VGX has wrongly mouse pointer declared as constant */
  63 static __u8 *sony_report_fixup(struct hid_device *hdev, __u8 *rdesc,
  64                 unsigned int *rsize)
  65 {
  66         struct sony_sc *sc = hid_get_drvdata(hdev);
  67
  68         if ((sc->quirks & VAIO_RDESC_CONSTANT) &&
  69                         *rsize >= 56 && rdesc[54] == 0x81 && rdesc[55] == 0x07) {
  70                 hid_info(hdev, "Fixing up Sony RF Receiver report descriptor\n");
  71                 rdesc[55] = 0x06;
  72         }
  73
  74         /* The HID descriptor exposed over BT has a trailing zero byte */
  75         if ((((sc->quirks & SIXAXIS_CONTROLLER_USB) && *rsize == 148) ||
  76                         ((sc->quirks & SIXAXIS_CONTROLLER_BT) && *rsize == 149)) &&
  77                         rdesc[83] == 0x75) {
  78                 hid_info(hdev, "Fixing up Sony Sixaxis report descriptor\n");
  79                 memcpy((void *)&rdesc[83], (void *)&sixaxis_rdesc_fixup,
  80                         sizeof(sixaxis_rdesc_fixup));
  81         } else if (sc->quirks & SIXAXIS_CONTROLLER_USB &&
  82                    *rsize > sizeof(sixaxis_rdesc_fixup2)) {
  83                 hid_info(hdev, "Sony Sixaxis clone detected. Using original report descriptor (size: %d clone; %d new)\n",
  84                          *rsize, (int)sizeof(sixaxis_rdesc_fixup2));
  85                 *rsize = sizeof(sixaxis_rdesc_fixup2);
  86                 memcpy(rdesc, &sixaxis_rdesc_fixup2, *rsize);
  87         }
  88         return rdesc;
  89 }
  90
  91 static int sony_raw_event(struct hid_device *hdev, struct hid_report *report,
  92                 __u8 *rd, int size)
  93 {
  94         struct sony_sc *sc = hid_get_drvdata(hdev);
  95
  96         /* Sixaxis HID report has acclerometers/gyro with MSByte first, this
  97          * has to be BYTE_SWAPPED before passing up to joystick interface
  98          */
  99         if ((sc->quirks & (SIXAXIS_CONTROLLER_USB | SIXAXIS_CONTROLLER_BT)) &&
 100                         rd[0] == 0x01 && size == 49) {
 101                 swap(rd[41], rd[42]);
 102                 swap(rd[43], rd[44]);
 103                 swap(rd[45], rd[46]);
 104                 swap(rd[47], rd[48]);
 105         }
 106
 107         return 0;
 108 }
 109
 110 /*
 111  * The Sony Sixaxis does not handle HID Output Reports on the Interrupt EP
 112  * like it should according to usbhid/hid-core.c::usbhid_output_raw_report()
 113  * so we need to override that forcing HID Output Reports on the Control EP.
 114  *
 115  * There is also another issue about HID Output Reports via USB, the Sixaxis
 116  * does not want the report_id as part of the data packet, so we have to
 117  * discard buf[0] when sending the actual control message, even for numbered
 118  * reports, humpf!
 119  */
 120 static int sixaxis_usb_output_raw_report(struct hid_device *hid, __u8 *buf,
 121                 size_t count, unsigned char report_type)
 122 {
 123         struct usb_interface *intf = to_usb_interface(hid->dev.parent);
 124         struct usb_device *dev = interface_to_usbdev(intf);
 125         struct usb_host_interface *interface = intf->cur_altsetting;
 126         int report_id = buf[0];
 127         int ret;
 128
 129         if (report_type == HID_OUTPUT_REPORT) {
 130                 /* Don't send the Report ID */
 131                 buf++;
 132                 count--;
 133         }
 134
 135         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 136                 HID_REQ_SET_REPORT,
 137                 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 138                 ((report_type + 1) << 8) | report_id,
 139                 interface->desc.bInterfaceNumber, buf, count,
 140                 USB_CTRL_SET_TIMEOUT);
 141
 142         /* Count also the Report ID, in case of an Output report. */
 143         if (ret > 0 && report_type == HID_OUTPUT_REPORT)
 144                 ret++;
 145
 146         return ret;
 147 }
 148
 149 /*
 150  * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
 151  * to "operational".  Without this, the ps3 controller will not report any
 152  * events.
 153  */
 154 static int sixaxis_set_operational_usb(struct hid_device *hdev)
 155 {
 156         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 157         struct usb_device *dev = interface_to_usbdev(intf);
 158         __u16 ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
 159         int ret;
 160         char *buf = kmalloc(18, GFP_KERNEL);
 161
 162         if (!buf)
 163                 return -ENOMEM;
 164
 165         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 166                                  HID_REQ_GET_REPORT,
 167                                  USB_DIR_IN | USB_TYPE_CLASS |
 168                                  USB_RECIP_INTERFACE,
 169                                  (3 << 8) | 0xf2, ifnum, buf, 17,
 170                                  USB_CTRL_GET_TIMEOUT);
 171         if (ret < 0)
 172                 hid_err(hdev, "can't set operational mode\n");
 173
 174         kfree(buf);
 175
 176         return ret;
 177 }
 178
 179 static int sixaxis_set_operational_bt(struct hid_device *hdev)
 180 {
 181         unsigned char buf[] = { 0xf4,  0x42, 0x03, 0x00, 0x00 };
 182         return hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
 183 }
 184
 185 static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
 186 {
 187         int ret;
 188         unsigned long quirks = id->driver_data;
 189         struct sony_sc *sc;
 190
 191         sc = kzalloc(sizeof(*sc), GFP_KERNEL);
 192         if (sc == NULL) {
 193                 hid_err(hdev, "can't alloc sony descriptor\n");
 194                 return -ENOMEM;
 195         }
 196
 197         sc->quirks = quirks;
 198         hid_set_drvdata(hdev, sc);
 199
 200         ret = hid_parse(hdev);
 201         if (ret) {
 202                 hid_err(hdev, "parse failed\n");
 203                 goto err_free;
 204         }
 205
 206         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT |
 207                         HID_CONNECT_HIDDEV_FORCE);
 208         if (ret) {
 209                 hid_err(hdev, "hw start failed\n");
 210                 goto err_free;
 211         }
 212
 213         if (sc->quirks & SIXAXIS_CONTROLLER_USB) {
 214                 hdev->hid_output_raw_report = sixaxis_usb_output_raw_report;
 215                 ret = sixaxis_set_operational_usb(hdev);
 216         }
 217         else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
 218                 ret = sixaxis_set_operational_bt(hdev);
 219         else
 220                 ret = 0;
 221
 222         if (ret < 0)
 223                 goto err_stop;
 224
 225         return 0;
 226 err_stop:
 227         hid_hw_stop(hdev);
 228 err_free:
 229         kfree(sc);
 230         return ret;
 231 }
 232
 233 static void sony_remove(struct hid_device *hdev)
 234 {
 235         hid_hw_stop(hdev);
 236         kfree(hid_get_drvdata(hdev));
 237 }
 238
 239 static const struct hid_device_id sony_devices[] = {
 240         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
 241                 .driver_data = SIXAXIS_CONTROLLER_USB },
 242         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_NAVIGATION_CONTROLLER),
 243                 .driver_data = SIXAXIS_CONTROLLER_USB },
 244         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
 245                 .driver_data = SIXAXIS_CONTROLLER_BT },
 246         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE),
 247                 .driver_data = VAIO_RDESC_CONSTANT },
 248         { HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGP_MOUSE),
 249                 .driver_data = VAIO_RDESC_CONSTANT },
 250         { }
 251 };
 252 MODULE_DEVICE_TABLE(hid, sony_devices);
 253
 254 static struct hid_driver sony_driver = {
 255         .name = "sony",
 256         .id_table = sony_devices,
 257         .probe = sony_probe,
 258         .remove = sony_remove,
 259         .report_fixup = sony_report_fixup,
 260         .raw_event = sony_raw_event
 261 };
 262
 263 static int __init sony_init(void)
 264 {
 265         return hid_register_driver(&sony_driver);
 266 }
 267
 268 static void __exit sony_exit(void)
 269 {
 270         hid_unregister_driver(&sony_driver);
 271 }
 272
 273 module_init(sony_init);
 274 module_exit(sony_exit);
 275 MODULE_LICENSE("GPL");