drivers/hid/hid-tmff.c

   1 /*
   2  * Force feedback support for various HID compliant devices by ThrustMaster:
   3  *    ThrustMaster FireStorm Dual Power 2
   4  * and possibly others whose device ids haven't been added.
   5  *
   6  *  Modified to support ThrustMaster devices by Zinx Verituse
   7  *  on 2003-01-25 from the Logitech force feedback driver,
   8  *  which is by Johann Deneux.
   9  *
  10  *  Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
  11  *  Copyright (c) 2002 Johann Deneux
  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/hid.h>
  31 #include <linux/input.h>
  32 #include <linux/slab.h>
  33 #include <linux/module.h>
  34
  35 #include "hid-ids.h"
  36
  37 #define THRUSTMASTER_DEVICE_ID_2_IN_1_DT        0xb320
  38
  39 static const signed short ff_rumble[] = {
  40         FF_RUMBLE,
  41         -1
  42 };
  43
  44 static const signed short ff_joystick[] = {
  45         FF_CONSTANT,
  46         -1
  47 };
  48
  49 #ifdef CONFIG_THRUSTMASTER_FF
  50
  51 /* Usages for thrustmaster devices I know about */
  52 #define THRUSTMASTER_USAGE_FF   (HID_UP_GENDESK | 0xbb)
  53
  54 struct tmff_device {
  55         struct hid_report *report;
  56         struct hid_field *ff_field;
  57 };
  58
  59 /* Changes values from 0 to 0xffff into values from minimum to maximum */
  60 static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
  61 {
  62         int ret;
  63
  64         ret = (in * (maximum - minimum) / 0xffff) + minimum;
  65         if (ret < minimum)
  66                 return minimum;
  67         if (ret > maximum)
  68                 return maximum;
  69         return ret;
  70 }
  71
  72 /* Changes values from -0x80 to 0x7f into values from minimum to maximum */
  73 static inline int tmff_scale_s8(int in, int minimum, int maximum)
  74 {
  75         int ret;
  76
  77         ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
  78         if (ret < minimum)
  79                 return minimum;
  80         if (ret > maximum)
  81                 return maximum;
  82         return ret;
  83 }
  84
  85 static int tmff_play(struct input_dev *dev, void *data,
  86                 struct ff_effect *effect)
  87 {
  88         struct hid_device *hid = input_get_drvdata(dev);
  89         struct tmff_device *tmff = data;
  90         struct hid_field *ff_field = tmff->ff_field;
  91         int x, y;
  92         int left, right;        /* Rumbling */
  93         int motor_swap;
  94
  95         switch (effect->type) {
  96         case FF_CONSTANT:
  97                 x = tmff_scale_s8(effect->u.ramp.start_level,
  98                                         ff_field->logical_minimum,
  99                                         ff_field->logical_maximum);
 100                 y = tmff_scale_s8(effect->u.ramp.end_level,
 101                                         ff_field->logical_minimum,
 102                                         ff_field->logical_maximum);
 103
 104                 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
 105                 ff_field->value[0] = x;
 106                 ff_field->value[1] = y;
 107                 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
 108                 break;
 109
 110         case FF_RUMBLE:
 111                 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
 112                                         ff_field->logical_minimum,
 113                                         ff_field->logical_maximum);
 114                 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
 115                                         ff_field->logical_minimum,
 116                                         ff_field->logical_maximum);
 117
 118                 /* 2-in-1 strong motor is left */
 119                 if (hid->product == THRUSTMASTER_DEVICE_ID_2_IN_1_DT) {
 120                         motor_swap = left;
 121                         left = right;
 122                         right = motor_swap;
 123                 }
 124
 125                 dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
 126                 ff_field->value[0] = left;
 127                 ff_field->value[1] = right;
 128                 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
 129                 break;
 130         }
 131         return 0;
 132 }
 133
 134 static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
 135 {
 136         struct tmff_device *tmff;
 137         struct hid_report *report;
 138         struct list_head *report_list;
 139         struct hid_input *hidinput;
 140         struct input_dev *input_dev;
 141         int error;
 142         int i;
 143
 144         if (list_empty(&hid->inputs)) {
 145                 hid_err(hid, "no inputs found\n");
 146                 return -ENODEV;
 147         }
 148         hidinput = list_entry(hid->inputs.next, struct hid_input, list);
 149         input_dev = hidinput->input;
 150
 151         tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
 152         if (!tmff)
 153                 return -ENOMEM;
 154
 155         /* Find the report to use */
 156         report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
 157         list_for_each_entry(report, report_list, list) {
 158                 int fieldnum;
 159
 160                 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
 161                         struct hid_field *field = report->field[fieldnum];
 162
 163                         if (field->maxusage <= 0)
 164                                 continue;
 165
 166                         switch (field->usage[0].hid) {
 167                         case THRUSTMASTER_USAGE_FF:
 168                                 if (field->report_count < 2) {
 169                                         hid_warn(hid, "ignoring FF field with report_count < 2\n");
 170                                         continue;
 171                                 }
 172
 173                                 if (field->logical_maximum ==
 174                                                 field->logical_minimum) {
 175                                         hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
 176                                         continue;
 177                                 }
 178
 179                                 if (tmff->report && tmff->report != report) {
 180                                         hid_warn(hid, "ignoring FF field in other report\n");
 181                                         continue;
 182                                 }
 183
 184                                 if (tmff->ff_field && tmff->ff_field != field) {
 185                                         hid_warn(hid, "ignoring duplicate FF field\n");
 186                                         continue;
 187                                 }
 188
 189                                 tmff->report = report;
 190                                 tmff->ff_field = field;
 191
 192                                 for (i = 0; ff_bits[i] >= 0; i++)
 193                                         set_bit(ff_bits[i], input_dev->ffbit);
 194
 195                                 break;
 196
 197                         default:
 198                                 hid_warn(hid, "ignoring unknown output usage %08x\n",
 199                                          field->usage[0].hid);
 200                                 continue;
 201                         }
 202                 }
 203         }
 204
 205         if (!tmff->report) {
 206                 hid_err(hid, "can't find FF field in output reports\n");
 207                 error = -ENODEV;
 208                 goto fail;
 209         }
 210
 211         error = input_ff_create_memless(input_dev, tmff, tmff_play);
 212         if (error)
 213                 goto fail;
 214
 215         hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
 216         return 0;
 217
 218 fail:
 219         kfree(tmff);
 220         return error;
 221 }
 222 #else
 223 static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
 224 {
 225         return 0;
 226 }
 227 #endif
 228
 229 static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
 230 {
 231         int ret;
 232
 233         ret = hid_parse(hdev);
 234         if (ret) {
 235                 hid_err(hdev, "parse failed\n");
 236                 goto err;
 237         }
 238
 239         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
 240         if (ret) {
 241                 hid_err(hdev, "hw start failed\n");
 242                 goto err;
 243         }
 244
 245         tmff_init(hdev, (void *)id->driver_data);
 246
 247         return 0;
 248 err:
 249         return ret;
 250 }
 251
 252 static const struct hid_device_id tm_devices[] = {
 253         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
 254                 .driver_data = (unsigned long)ff_rumble },
 255         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304),   /* FireStorm Dual Power 2 (and 3) */
 256                 .driver_data = (unsigned long)ff_rumble },
 257         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, THRUSTMASTER_DEVICE_ID_2_IN_1_DT),   /* Dual Trigger 2-in-1 */
 258                 .driver_data = (unsigned long)ff_rumble },
 259         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323),   /* Dual Trigger 3-in-1 (PC Mode) */
 260                 .driver_data = (unsigned long)ff_rumble },
 261         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324),   /* Dual Trigger 3-in-1 (PS3 Mode) */
 262                 .driver_data = (unsigned long)ff_rumble },
 263         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651),   /* FGT Rumble Force Wheel */
 264                 .driver_data = (unsigned long)ff_rumble },
 265         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653),   /* RGT Force Feedback CLUTCH Raging Wheel */
 266                 .driver_data = (unsigned long)ff_joystick },
 267         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654),   /* FGT Force Feedback Wheel */
 268                 .driver_data = (unsigned long)ff_joystick },
 269         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a),   /* F430 Force Feedback Wheel */
 270                 .driver_data = (unsigned long)ff_joystick },
 271         { }
 272 };
 273 MODULE_DEVICE_TABLE(hid, tm_devices);
 274
 275 static struct hid_driver tm_driver = {
 276         .name = "thrustmaster",
 277         .id_table = tm_devices,
 278         .probe = tm_probe,
 279 };
 280 module_hid_driver(tm_driver);
 281
 282 MODULE_LICENSE("GPL");