drivers/hid/hid-dr.c

   1 /*
   2  * Force feedback support for DragonRise Inc. game controllers
   3  *
   4  * From what I have gathered, these devices are mass produced in China and are
   5  * distributed under several vendors. They often share the same design as
   6  * the original PlayStation DualShock controller.
   7  *
   8  * 0079:0006 "DragonRise Inc.   Generic   USB  Joystick  "
   9  *  - tested with a Tesun USB-703 game controller.
  10  *
  11  * Copyright (c) 2009 Richard Walmsley <richwalm@gmail.com>
  12  */
  13
  14 /*
  15  * This program is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program; if not, write to the Free Software
  27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  28  */
  29
  30 #include <linux/input.h>
  31 #include <linux/slab.h>
  32 #include <linux/hid.h>
  33 #include <linux/module.h>
  34
  35 #include "hid-ids.h"
  36
  37 #ifdef CONFIG_DRAGONRISE_FF
  38
  39 struct drff_device {
  40         struct hid_report *report;
  41 };
  42
  43 static int drff_play(struct input_dev *dev, void *data,
  44                                  struct ff_effect *effect)
  45 {
  46         struct hid_device *hid = input_get_drvdata(dev);
  47         struct drff_device *drff = data;
  48         int strong, weak;
  49
  50         strong = effect->u.rumble.strong_magnitude;
  51         weak = effect->u.rumble.weak_magnitude;
  52
  53         dbg_hid("called with 0x%04x 0x%04x", strong, weak);
  54
  55         if (strong || weak) {
  56                 strong = strong * 0xff / 0xffff;
  57                 weak = weak * 0xff / 0xffff;
  58
  59                 /* While reverse engineering this device, I found that when
  60                    this value is set, it causes the strong rumble to function
  61                    at a near maximum speed, so we'll bypass it. */
  62                 if (weak == 0x0a)
  63                         weak = 0x0b;
  64
  65                 drff->report->field[0]->value[0] = 0x51;
  66                 drff->report->field[0]->value[1] = 0x00;
  67                 drff->report->field[0]->value[2] = weak;
  68                 drff->report->field[0]->value[4] = strong;
  69                 hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
  70
  71                 drff->report->field[0]->value[0] = 0xfa;
  72                 drff->report->field[0]->value[1] = 0xfe;
  73         } else {
  74                 drff->report->field[0]->value[0] = 0xf3;
  75                 drff->report->field[0]->value[1] = 0x00;
  76         }
  77
  78         drff->report->field[0]->value[2] = 0x00;
  79         drff->report->field[0]->value[4] = 0x00;
  80         dbg_hid("running with 0x%02x 0x%02x", strong, weak);
  81         hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
  82
  83         return 0;
  84 }
  85
  86 static int drff_init(struct hid_device *hid)
  87 {
  88         struct drff_device *drff;
  89         struct hid_report *report;
  90         struct hid_input *hidinput;
  91         struct list_head *report_list =
  92                         &hid->report_enum[HID_OUTPUT_REPORT].report_list;
  93         struct input_dev *dev;
  94         int error;
  95
  96         if (list_empty(&hid->inputs)) {
  97                 hid_err(hid, "no inputs found\n");
  98                 return -ENODEV;
  99         }
 100         hidinput = list_first_entry(&hid->inputs, struct hid_input, list);
 101         dev = hidinput->input;
 102
 103         if (list_empty(report_list)) {
 104                 hid_err(hid, "no output reports found\n");
 105                 return -ENODEV;
 106         }
 107
 108         report = list_first_entry(report_list, struct hid_report, list);
 109         if (report->maxfield < 1) {
 110                 hid_err(hid, "no fields in the report\n");
 111                 return -ENODEV;
 112         }
 113
 114         if (report->field[0]->report_count < 7) {
 115                 hid_err(hid, "not enough values in the field\n");
 116                 return -ENODEV;
 117         }
 118
 119         drff = kzalloc(sizeof(struct drff_device), GFP_KERNEL);
 120         if (!drff)
 121                 return -ENOMEM;
 122
 123         set_bit(FF_RUMBLE, dev->ffbit);
 124
 125         error = input_ff_create_memless(dev, drff, drff_play);
 126         if (error) {
 127                 kfree(drff);
 128                 return error;
 129         }
 130
 131         drff->report = report;
 132         drff->report->field[0]->value[0] = 0xf3;
 133         drff->report->field[0]->value[1] = 0x00;
 134         drff->report->field[0]->value[2] = 0x00;
 135         drff->report->field[0]->value[3] = 0x00;
 136         drff->report->field[0]->value[4] = 0x00;
 137         drff->report->field[0]->value[5] = 0x00;
 138         drff->report->field[0]->value[6] = 0x00;
 139         hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
 140
 141         hid_info(hid, "Force Feedback for DragonRise Inc. "
 142                  "game controllers by Richard Walmsley <richwalm@gmail.com>\n");
 143
 144         return 0;
 145 }
 146 #else
 147 static inline int drff_init(struct hid_device *hid)
 148 {
 149         return 0;
 150 }
 151 #endif
 152
 153 /*
 154  * The original descriptor of joystick with PID 0x0011, represented by DVTech PC
 155  * JS19. It seems both copied from another device and a result of confusion
 156  * either about the specification or about the program used to create the
 157  * descriptor. In any case, it's a wonder it works on Windows.
 158  *
 159  *  Usage Page (Desktop),             ; Generic desktop controls (01h)
 160  *  Usage (Joystik),                  ; Joystik (04h, application collection)
 161  *  Collection (Application),
 162  *    Collection (Logical),
 163  *      Report Size (8),
 164  *      Report Count (5),
 165  *      Logical Minimum (0),
 166  *      Logical Maximum (255),
 167  *      Physical Minimum (0),
 168  *      Physical Maximum (255),
 169  *      Usage (X),                    ; X (30h, dynamic value)
 170  *      Usage (X),                    ; X (30h, dynamic value)
 171  *      Usage (X),                    ; X (30h, dynamic value)
 172  *      Usage (X),                    ; X (30h, dynamic value)
 173  *      Usage (Y),                    ; Y (31h, dynamic value)
 174  *      Input (Variable),
 175  *      Report Size (4),
 176  *      Report Count (1),
 177  *      Logical Maximum (7),
 178  *      Physical Maximum (315),
 179  *      Unit (Degrees),
 180  *      Usage (00h),
 181  *      Input (Variable, Null State),
 182  *      Unit,
 183  *      Report Size (1),
 184  *      Report Count (10),
 185  *      Logical Maximum (1),
 186  *      Physical Maximum (1),
 187  *      Usage Page (Button),          ; Button (09h)
 188  *      Usage Minimum (01h),
 189  *      Usage Maximum (0Ah),
 190  *      Input (Variable),
 191  *      Usage Page (FF00h),           ; FF00h, vendor-defined
 192  *      Report Size (1),
 193  *      Report Count (10),
 194  *      Logical Maximum (1),
 195  *      Physical Maximum (1),
 196  *      Usage (01h),
 197  *      Input (Variable),
 198  *    End Collection,
 199  *    Collection (Logical),
 200  *      Report Size (8),
 201  *      Report Count (4),
 202  *      Physical Maximum (255),
 203  *      Logical Maximum (255),
 204  *      Usage (02h),
 205  *      Output (Variable),
 206  *    End Collection,
 207  *  End Collection
 208  */
 209
 210 /* Size of the original descriptor of the PID 0x0011 joystick */
 211 #define PID0011_RDESC_ORIG_SIZE 101
 212
 213 /* Fixed report descriptor for PID 0x011 joystick */
 214 static __u8 pid0011_rdesc_fixed[] = {
 215         0x05, 0x01,         /*  Usage Page (Desktop),           */
 216         0x09, 0x04,         /*  Usage (Joystik),                */
 217         0xA1, 0x01,         /*  Collection (Application),       */
 218         0xA1, 0x02,         /*      Collection (Logical),       */
 219         0x14,               /*          Logical Minimum (0),    */
 220         0x75, 0x08,         /*          Report Size (8),        */
 221         0x95, 0x03,         /*          Report Count (3),       */
 222         0x81, 0x01,         /*          Input (Constant),       */
 223         0x26, 0xFF, 0x00,   /*          Logical Maximum (255),  */
 224         0x95, 0x02,         /*          Report Count (2),       */
 225         0x09, 0x30,         /*          Usage (X),              */
 226         0x09, 0x31,         /*          Usage (Y),              */
 227         0x81, 0x02,         /*          Input (Variable),       */
 228         0x75, 0x01,         /*          Report Size (1),        */
 229         0x95, 0x04,         /*          Report Count (4),       */
 230         0x81, 0x01,         /*          Input (Constant),       */
 231         0x25, 0x01,         /*          Logical Maximum (1),    */
 232         0x95, 0x0A,         /*          Report Count (10),      */
 233         0x05, 0x09,         /*          Usage Page (Button),    */
 234         0x19, 0x01,         /*          Usage Minimum (01h),    */
 235         0x29, 0x0A,         /*          Usage Maximum (0Ah),    */
 236         0x81, 0x02,         /*          Input (Variable),       */
 237         0x95, 0x0A,         /*          Report Count (10),      */
 238         0x81, 0x01,         /*          Input (Constant),       */
 239         0xC0,               /*      End Collection,             */
 240         0xC0                /*  End Collection                  */
 241 };
 242
 243 static __u8 pid0006_rdesc_fixed[] = {
 244         0x05, 0x01,        /* Usage Page (Generic Desktop)      */
 245         0x09, 0x04,        /* Usage (Joystick)                  */
 246         0xA1, 0x01,        /* Collection (Application)          */
 247         0xA1, 0x02,        /*   Collection (Logical)            */
 248         0x75, 0x08,        /*     Report Size (8)               */
 249         0x95, 0x05,        /*     Report Count (5)              */
 250         0x15, 0x00,        /*     Logical Minimum (0)           */
 251         0x26, 0xFF, 0x00,  /*     Logical Maximum (255)         */
 252         0x35, 0x00,        /*     Physical Minimum (0)          */
 253         0x46, 0xFF, 0x00,  /*     Physical Maximum (255)        */
 254         0x09, 0x30,        /*     Usage (X)                     */
 255         0x09, 0x33,        /*     Usage (Ry)                    */
 256         0x09, 0x32,        /*     Usage (Z)                     */
 257         0x09, 0x31,        /*     Usage (Y)                     */
 258         0x09, 0x34,        /*     Usage (Ry)                    */
 259         0x81, 0x02,        /*     Input (Variable)              */
 260         0x75, 0x04,        /*     Report Size (4)               */
 261         0x95, 0x01,        /*     Report Count (1)              */
 262         0x25, 0x07,        /*     Logical Maximum (7)           */
 263         0x46, 0x3B, 0x01,  /*     Physical Maximum (315)        */
 264         0x65, 0x14,        /*     Unit (Centimeter)             */
 265         0x09, 0x39,        /*     Usage (Hat switch)            */
 266         0x81, 0x42,        /*     Input (Variable)              */
 267         0x65, 0x00,        /*     Unit (None)                   */
 268         0x75, 0x01,        /*     Report Size (1)               */
 269         0x95, 0x0C,        /*     Report Count (12)             */
 270         0x25, 0x01,        /*     Logical Maximum (1)           */
 271         0x45, 0x01,        /*     Physical Maximum (1)          */
 272         0x05, 0x09,        /*     Usage Page (Button)           */
 273         0x19, 0x01,        /*     Usage Minimum (0x01)          */
 274         0x29, 0x0C,        /*     Usage Maximum (0x0C)          */
 275         0x81, 0x02,        /*     Input (Variable)              */
 276         0x06, 0x00, 0xFF,  /*     Usage Page (Vendor Defined)   */
 277         0x75, 0x01,        /*     Report Size (1)               */
 278         0x95, 0x08,        /*     Report Count (8)              */
 279         0x25, 0x01,        /*     Logical Maximum (1)           */
 280         0x45, 0x01,        /*     Physical Maximum (1)          */
 281         0x09, 0x01,        /*     Usage (0x01)                  */
 282         0x81, 0x02,        /*     Input (Variable)              */
 283         0xC0,              /*   End Collection                  */
 284         0xA1, 0x02,        /*   Collection (Logical)            */
 285         0x75, 0x08,        /*     Report Size (8)               */
 286         0x95, 0x07,        /*     Report Count (7)              */
 287         0x46, 0xFF, 0x00,  /*     Physical Maximum (255)        */
 288         0x26, 0xFF, 0x00,  /*     Logical Maximum (255)         */
 289         0x09, 0x02,        /*     Usage (0x02)                  */
 290         0x91, 0x02,        /*     Output (Variable)             */
 291         0xC0,              /*   End Collection                  */
 292         0xC0               /* End Collection                    */
 293 };
 294
 295 static __u8 *dr_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 296                                 unsigned int *rsize)
 297 {
 298         switch (hdev->product) {
 299         case 0x0011:
 300                 if (*rsize == PID0011_RDESC_ORIG_SIZE) {
 301                         rdesc = pid0011_rdesc_fixed;
 302                         *rsize = sizeof(pid0011_rdesc_fixed);
 303                 }
 304                 break;
 305         case 0x0006:
 306                 if (*rsize == sizeof(pid0006_rdesc_fixed)) {
 307                         rdesc = pid0006_rdesc_fixed;
 308                         *rsize = sizeof(pid0006_rdesc_fixed);
 309                 }
 310                 break;
 311         }
 312         return rdesc;
 313 }
 314
 315 static int dr_probe(struct hid_device *hdev, const struct hid_device_id *id)
 316 {
 317         int ret;
 318
 319         dev_dbg(&hdev->dev, "DragonRise Inc. HID hardware probe...");
 320
 321         ret = hid_parse(hdev);
 322         if (ret) {
 323                 hid_err(hdev, "parse failed\n");
 324                 goto err;
 325         }
 326
 327         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
 328         if (ret) {
 329                 hid_err(hdev, "hw start failed\n");
 330                 goto err;
 331         }
 332
 333         switch (hdev->product) {
 334         case 0x0006:
 335                 ret = drff_init(hdev);
 336                 if (ret) {
 337                         dev_err(&hdev->dev, "force feedback init failed\n");
 338                         hid_hw_stop(hdev);
 339                         goto err;
 340                 }
 341                 break;
 342         }
 343
 344         return 0;
 345 err:
 346         return ret;
 347 }
 348
 349 static const struct hid_device_id dr_devices[] = {
 350         { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006),  },
 351         { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0011),  },
 352         { }
 353 };
 354 MODULE_DEVICE_TABLE(hid, dr_devices);
 355
 356 static struct hid_driver dr_driver = {
 357         .name = "dragonrise",
 358         .id_table = dr_devices,
 359         .report_fixup = dr_report_fixup,
 360         .probe = dr_probe,
 361 };
 362 module_hid_driver(dr_driver);
 363
 364 MODULE_LICENSE("GPL");