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