drivers/hid/hid-pl.c

   1 /*
   2  *  Force feedback support for PantherLord/GreenAsia based devices
   3  *
   4  *  The devices are distributed under various names and the same USB device ID
   5  *  can be used in both adapters and actual game controllers.
   6  *
   7  *  0810:0001 "Twin USB Joystick"
   8  *   - tested with PantherLord USB/PS2 2in1 Adapter
   9  *   - contains two reports, one for each port (HID_QUIRK_MULTI_INPUT)
  10  *
  11  *  0e8f:0003 "GreenAsia Inc.    USB Joystick     "
  12  *   - tested with König Gaming gamepad
  13  *
  14  *  0e8f:0003 "GASIA USB Gamepad"
  15  *   - another version of the König gamepad
  16  *
  17  *  Copyright (c) 2007, 2009 Anssi Hannula <anssi.hannula@gmail.com>
  18  */
  19
  20 /*
  21  * This program is free software; you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation; either version 2 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  34  */
  35
  36
  37 /* #define DEBUG */
  38
  39 #define debug(format, arg...) pr_debug("hid-plff: " format "\n" , ## arg)
  40
  41 #include <linux/input.h>
  42 #include <linux/slab.h>
  43 #include <linux/usb.h>
  44 #include <linux/hid.h>
  45
  46 #include "hid-ids.h"
  47
  48 #ifdef CONFIG_PANTHERLORD_FF
  49 #include "usbhid/usbhid.h"
  50
  51 struct plff_device {
  52         struct hid_report *report;
  53         s32 *strong;
  54         s32 *weak;
  55 };
  56
  57 static int hid_plff_play(struct input_dev *dev, void *data,
  58                          struct ff_effect *effect)
  59 {
  60         struct hid_device *hid = input_get_drvdata(dev);
  61         struct plff_device *plff = data;
  62         int left, right;
  63
  64         left = effect->u.rumble.strong_magnitude;
  65         right = effect->u.rumble.weak_magnitude;
  66         debug("called with 0x%04x 0x%04x", left, right);
  67
  68         left = left * 0x7f / 0xffff;
  69         right = right * 0x7f / 0xffff;
  70
  71         *plff->strong = left;
  72         *plff->weak = right;
  73         debug("running with 0x%02x 0x%02x", left, right);
  74         usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
  75
  76         return 0;
  77 }
  78
  79 static int plff_init(struct hid_device *hid)
  80 {
  81         struct plff_device *plff;
  82         struct hid_report *report;
  83         struct hid_input *hidinput;
  84         struct list_head *report_list =
  85                         &hid->report_enum[HID_OUTPUT_REPORT].report_list;
  86         struct list_head *report_ptr = report_list;
  87         struct input_dev *dev;
  88         int error;
  89         s32 *strong;
  90         s32 *weak;
  91
  92         /* The device contains one output report per physical device, all
  93            containing 1 field, which contains 4 ff00.0002 usages and 4 16bit
  94            absolute values.
  95
  96            The input reports also contain a field which contains
  97            8 ff00.0001 usages and 8 boolean values. Their meaning is
  98            currently unknown.
  99
 100            A version of the 0e8f:0003 exists that has all the values in
 101            separate fields and misses the extra input field, thus resembling
 102            Zeroplus (hid-zpff) devices.
 103         */
 104
 105         if (list_empty(report_list)) {
 106                 hid_err(hid, "no output reports found\n");
 107                 return -ENODEV;
 108         }
 109
 110         list_for_each_entry(hidinput, &hid->inputs, list) {
 111
 112                 report_ptr = report_ptr->next;
 113
 114                 if (report_ptr == report_list) {
 115                         hid_err(hid, "required output report is missing\n");
 116                         return -ENODEV;
 117                 }
 118
 119                 report = list_entry(report_ptr, struct hid_report, list);
 120                 if (report->maxfield < 1) {
 121                         hid_err(hid, "no fields in the report\n");
 122                         return -ENODEV;
 123                 }
 124
 125                 if (report->field[0]->report_count >= 4) {
 126                         report->field[0]->value[0] = 0x00;
 127                         report->field[0]->value[1] = 0x00;
 128                         strong = &report->field[0]->value[2];
 129                         weak = &report->field[0]->value[3];
 130                         debug("detected single-field device");
 131                 } else if (report->maxfield >= 4 && report->field[0]->maxusage == 1 &&
 132                                 report->field[0]->usage[0].hid == (HID_UP_LED | 0x43)) {
 133                         report->field[0]->value[0] = 0x00;
 134                         report->field[1]->value[0] = 0x00;
 135                         strong = &report->field[2]->value[0];
 136                         weak = &report->field[3]->value[0];
 137                         debug("detected 4-field device");
 138                 } else {
 139                         hid_err(hid, "not enough fields or values\n");
 140                         return -ENODEV;
 141                 }
 142
 143                 plff = kzalloc(sizeof(struct plff_device), GFP_KERNEL);
 144                 if (!plff)
 145                         return -ENOMEM;
 146
 147                 dev = hidinput->input;
 148
 149                 set_bit(FF_RUMBLE, dev->ffbit);
 150
 151                 error = input_ff_create_memless(dev, plff, hid_plff_play);
 152                 if (error) {
 153                         kfree(plff);
 154                         return error;
 155                 }
 156
 157                 plff->report = report;
 158                 plff->strong = strong;
 159                 plff->weak = weak;
 160
 161                 *strong = 0x00;
 162                 *weak = 0x00;
 163                 usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
 164         }
 165
 166         hid_info(hid, "Force feedback for PantherLord/GreenAsia devices by Anssi Hannula <anssi.hannula@gmail.com>\n");
 167
 168         return 0;
 169 }
 170 #else
 171 static inline int plff_init(struct hid_device *hid)
 172 {
 173         return 0;
 174 }
 175 #endif
 176
 177 static int pl_probe(struct hid_device *hdev, const struct hid_device_id *id)
 178 {
 179         int ret;
 180
 181         if (id->driver_data)
 182                 hdev->quirks |= HID_QUIRK_MULTI_INPUT;
 183
 184         ret = hid_parse(hdev);
 185         if (ret) {
 186                 hid_err(hdev, "parse failed\n");
 187                 goto err;
 188         }
 189
 190         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
 191         if (ret) {
 192                 hid_err(hdev, "hw start failed\n");
 193                 goto err;
 194         }
 195
 196         plff_init(hdev);
 197
 198         return 0;
 199 err:
 200         return ret;
 201 }
 202
 203 static const struct hid_device_id pl_devices[] = {
 204         { HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR),
 205                 .driver_data = 1 }, /* Twin USB Joystick */
 206         { HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR),
 207                 .driver_data = 1 }, /* Twin USB Joystick */
 208         { HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003), },
 209         { }
 210 };
 211 MODULE_DEVICE_TABLE(hid, pl_devices);
 212
 213 static struct hid_driver pl_driver = {
 214         .name = "pantherlord",
 215         .id_table = pl_devices,
 216         .probe = pl_probe,
 217 };
 218
 219 static int __init pl_init(void)
 220 {
 221         return hid_register_driver(&pl_driver);
 222 }
 223
 224 static void __exit pl_exit(void)
 225 {
 226         hid_unregister_driver(&pl_driver);
 227 }
 228
 229 module_init(pl_init);
 230 module_exit(pl_exit);
 231 MODULE_LICENSE("GPL");