Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 30 | #include <linux/hid.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | #include <linux/input.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 32 | #include <linux/slab.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | #include <linux/usb.h> |
| 34 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 35 | #include "hid-ids.h" |
| 36 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 37 | static const signed short ff_rumble[] = { |
| 38 | FF_RUMBLE, |
| 39 | -1 |
| 40 | }; |
| 41 | |
| 42 | static const signed short ff_joystick[] = { |
| 43 | FF_CONSTANT, |
| 44 | -1 |
| 45 | }; |
| 46 | |
Jiri Kosina | 0f6f431 | 2009-05-15 15:46:44 +0200 | [diff] [blame] | 47 | #ifdef CONFIG_THRUSTMASTER_FF |
| 48 | #include "usbhid/usbhid.h" |
| 49 | |
| 50 | /* Usages for thrustmaster devices I know about */ |
| 51 | #define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb) |
| 52 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | struct tmff_device { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | struct hid_report *report; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 55 | struct hid_field *ff_field; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | }; |
| 57 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 58 | /* Changes values from 0 to 0xffff into values from minimum to maximum */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 59 | static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum) |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 60 | { |
| 61 | int ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 63 | ret = (in * (maximum - minimum) / 0xffff) + minimum; |
| 64 | if (ret < minimum) |
| 65 | return minimum; |
| 66 | if (ret > maximum) |
| 67 | return maximum; |
| 68 | return ret; |
| 69 | } |
| 70 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 71 | /* Changes values from -0x80 to 0x7f into values from minimum to maximum */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 72 | static inline int tmff_scale_s8(int in, int minimum, int maximum) |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 73 | { |
| 74 | int ret; |
| 75 | |
| 76 | ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum; |
| 77 | if (ret < minimum) |
| 78 | return minimum; |
| 79 | if (ret > maximum) |
| 80 | return maximum; |
| 81 | return ret; |
| 82 | } |
| 83 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 84 | static int tmff_play(struct input_dev *dev, void *data, |
| 85 | struct ff_effect *effect) |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 86 | { |
Dmitry Torokhov | e071298 | 2007-05-09 10:17:31 +0200 | [diff] [blame] | 87 | struct hid_device *hid = input_get_drvdata(dev); |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 88 | struct tmff_device *tmff = data; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 89 | struct hid_field *ff_field = tmff->ff_field; |
| 90 | int x, y; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 91 | int left, right; /* Rumbling */ |
| 92 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 93 | switch (effect->type) { |
| 94 | case FF_CONSTANT: |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 95 | x = tmff_scale_s8(effect->u.ramp.start_level, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 96 | ff_field->logical_minimum, |
| 97 | ff_field->logical_maximum); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 98 | y = tmff_scale_s8(effect->u.ramp.end_level, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 99 | ff_field->logical_minimum, |
| 100 | ff_field->logical_maximum); |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 101 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 102 | dbg_hid("(x, y)=(%04x, %04x)\n", x, y); |
| 103 | ff_field->value[0] = x; |
| 104 | ff_field->value[1] = y; |
| 105 | usbhid_submit_report(hid, tmff->report, USB_DIR_OUT); |
| 106 | break; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 107 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 108 | case FF_RUMBLE: |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 109 | left = tmff_scale_u16(effect->u.rumble.weak_magnitude, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 110 | ff_field->logical_minimum, |
| 111 | ff_field->logical_maximum); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 112 | right = tmff_scale_u16(effect->u.rumble.strong_magnitude, |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 113 | ff_field->logical_minimum, |
| 114 | ff_field->logical_maximum); |
| 115 | |
| 116 | dbg_hid("(left,right)=(%08x, %08x)\n", left, right); |
| 117 | ff_field->value[0] = left; |
| 118 | ff_field->value[1] = right; |
| 119 | usbhid_submit_report(hid, tmff->report, USB_DIR_OUT); |
| 120 | break; |
| 121 | } |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 122 | return 0; |
| 123 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 125 | static int tmff_init(struct hid_device *hid, const signed short *ff_bits) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | { |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 127 | struct tmff_device *tmff; |
Li Zefan | 3ba5619 | 2007-11-14 11:31:05 +0100 | [diff] [blame] | 128 | struct hid_report *report; |
| 129 | struct list_head *report_list; |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 130 | struct hid_input *hidinput = list_entry(hid->inputs.next, |
| 131 | struct hid_input, list); |
Dmitry Torokhov | c5b7c7c | 2005-09-15 02:01:47 -0500 | [diff] [blame] | 132 | struct input_dev *input_dev = hidinput->input; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 133 | int error; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 134 | int i; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 136 | tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL); |
| 137 | if (!tmff) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | return -ENOMEM; |
| 139 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | /* Find the report to use */ |
Li Zefan | 3ba5619 | 2007-11-14 11:31:05 +0100 | [diff] [blame] | 141 | report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list; |
| 142 | list_for_each_entry(report, report_list, list) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | int fieldnum; |
| 144 | |
| 145 | for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) { |
| 146 | struct hid_field *field = report->field[fieldnum]; |
| 147 | |
| 148 | if (field->maxusage <= 0) |
| 149 | continue; |
| 150 | |
| 151 | switch (field->usage[0].hid) { |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 152 | case THRUSTMASTER_USAGE_FF: |
| 153 | if (field->report_count < 2) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 154 | hid_warn(hid, "ignoring FF field with report_count < 2\n"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | continue; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 156 | } |
| 157 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 158 | if (field->logical_maximum == |
| 159 | field->logical_minimum) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 160 | hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 161 | continue; |
| 162 | } |
| 163 | |
| 164 | if (tmff->report && tmff->report != report) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 165 | hid_warn(hid, "ignoring FF field in other report\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 166 | continue; |
| 167 | } |
| 168 | |
| 169 | if (tmff->ff_field && tmff->ff_field != field) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 170 | hid_warn(hid, "ignoring duplicate FF field\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 171 | continue; |
| 172 | } |
| 173 | |
| 174 | tmff->report = report; |
| 175 | tmff->ff_field = field; |
| 176 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 177 | for (i = 0; ff_bits[i] >= 0; i++) |
| 178 | set_bit(ff_bits[i], input_dev->ffbit); |
| 179 | |
| 180 | break; |
| 181 | |
| 182 | default: |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 183 | hid_warn(hid, "ignoring unknown output usage %08x\n", |
| 184 | field->usage[0].hid); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 185 | continue; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 186 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 187 | } |
| 188 | } |
| 189 | |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 190 | if (!tmff->report) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 191 | hid_err(hid, "can't find FF field in output reports\n"); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 192 | error = -ENODEV; |
| 193 | goto fail; |
Anssi Hannula | dc76c91 | 2006-07-19 01:40:55 -0400 | [diff] [blame] | 194 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 196 | error = input_ff_create_memless(input_dev, tmff, tmff_play); |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 197 | if (error) |
| 198 | goto fail; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 200 | hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n"); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | return 0; |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 202 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 203 | fail: |
Dmitry Torokhov | b27c959 | 2007-07-30 14:56:26 +0200 | [diff] [blame] | 204 | kfree(tmff); |
| 205 | return error; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 206 | } |
Jiri Kosina | 0f6f431 | 2009-05-15 15:46:44 +0200 | [diff] [blame] | 207 | #else |
| 208 | static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits) |
| 209 | { |
| 210 | return 0; |
| 211 | } |
| 212 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 214 | static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id) |
| 215 | { |
| 216 | int ret; |
| 217 | |
| 218 | ret = hid_parse(hdev); |
| 219 | if (ret) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 220 | hid_err(hdev, "parse failed\n"); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 221 | goto err; |
| 222 | } |
| 223 | |
| 224 | ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF); |
| 225 | if (ret) { |
Joe Perches | 4291ee3 | 2010-12-09 19:29:03 -0800 | [diff] [blame] | 226 | hid_err(hdev, "hw start failed\n"); |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 227 | goto err; |
| 228 | } |
| 229 | |
| 230 | tmff_init(hdev, (void *)id->driver_data); |
| 231 | |
| 232 | return 0; |
| 233 | err: |
| 234 | return ret; |
| 235 | } |
| 236 | |
| 237 | static const struct hid_device_id tm_devices[] = { |
| 238 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300), |
| 239 | .driver_data = (unsigned long)ff_rumble }, |
Ruben Aos Garralda | 7a84b13 | 2009-06-29 09:41:29 +0200 | [diff] [blame] | 240 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */ |
| 241 | .driver_data = (unsigned long)ff_rumble }, |
| 242 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */ |
| 243 | .driver_data = (unsigned long)ff_rumble }, |
| 244 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */ |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 245 | .driver_data = (unsigned long)ff_rumble }, |
| 246 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */ |
| 247 | .driver_data = (unsigned long)ff_rumble }, |
Markus Rathgeb | 3ee8f0a | 2010-03-13 17:29:43 +0100 | [diff] [blame] | 248 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */ |
| 249 | .driver_data = (unsigned long)ff_joystick }, |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 250 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */ |
| 251 | .driver_data = (unsigned long)ff_joystick }, |
Simon Wood | d65c376 | 2010-11-29 17:41:23 +0100 | [diff] [blame] | 252 | { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */ |
| 253 | .driver_data = (unsigned long)ff_joystick }, |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 254 | { } |
| 255 | }; |
| 256 | MODULE_DEVICE_TABLE(hid, tm_devices); |
| 257 | |
| 258 | static struct hid_driver tm_driver = { |
| 259 | .name = "thrustmaster", |
| 260 | .id_table = tm_devices, |
| 261 | .probe = tm_probe, |
| 262 | }; |
| 263 | |
Peter Huewe | a24f423b | 2009-07-02 19:08:38 +0200 | [diff] [blame] | 264 | static int __init tm_init(void) |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 265 | { |
| 266 | return hid_register_driver(&tm_driver); |
| 267 | } |
| 268 | |
Peter Huewe | a24f423b | 2009-07-02 19:08:38 +0200 | [diff] [blame] | 269 | static void __exit tm_exit(void) |
Jiri Slaby | 10e41a7 | 2008-09-18 12:23:31 +0200 | [diff] [blame] | 270 | { |
| 271 | hid_unregister_driver(&tm_driver); |
| 272 | } |
| 273 | |
| 274 | module_init(tm_init); |
| 275 | module_exit(tm_exit); |
| 276 | MODULE_LICENSE("GPL"); |