blob: e4fcf3f702a519b95fdc9ca8ea73d1d80a777c42 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 Slaby10e41a72008-09-18 12:23:31 +020030#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/input.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090032#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/usb.h>
Paul Gortmaker8f86a2c2011-07-03 13:39:48 -040034#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Jiri Slaby10e41a72008-09-18 12:23:31 +020036#include "hid-ids.h"
37
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020038static const signed short ff_rumble[] = {
39 FF_RUMBLE,
40 -1
41};
42
43static const signed short ff_joystick[] = {
44 FF_CONSTANT,
45 -1
46};
47
Jiri Kosina0f6f4312009-05-15 15:46:44 +020048#ifdef CONFIG_THRUSTMASTER_FF
49#include "usbhid/usbhid.h"
50
51/* Usages for thrustmaster devices I know about */
52#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb)
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054struct tmff_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 struct hid_report *report;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020056 struct hid_field *ff_field;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057};
58
Anssi Hannuladc76c912006-07-19 01:40:55 -040059/* Changes values from 0 to 0xffff into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020060static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
Anssi Hannuladc76c912006-07-19 01:40:55 -040061{
62 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Anssi Hannuladc76c912006-07-19 01:40:55 -040064 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
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020072/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020073static inline int tmff_scale_s8(int in, int minimum, int maximum)
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020074{
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
Jiri Slaby10e41a72008-09-18 12:23:31 +020085static int tmff_play(struct input_dev *dev, void *data,
86 struct ff_effect *effect)
Anssi Hannuladc76c912006-07-19 01:40:55 -040087{
Dmitry Torokhove0712982007-05-09 10:17:31 +020088 struct hid_device *hid = input_get_drvdata(dev);
Anssi Hannuladc76c912006-07-19 01:40:55 -040089 struct tmff_device *tmff = data;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020090 struct hid_field *ff_field = tmff->ff_field;
91 int x, y;
Anssi Hannuladc76c912006-07-19 01:40:55 -040092 int left, right; /* Rumbling */
93
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020094 switch (effect->type) {
95 case FF_CONSTANT:
Jiri Slaby10e41a72008-09-18 12:23:31 +020096 x = tmff_scale_s8(effect->u.ramp.start_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020097 ff_field->logical_minimum,
98 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +020099 y = tmff_scale_s8(effect->u.ramp.end_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200100 ff_field->logical_minimum,
101 ff_field->logical_maximum);
Anssi Hannuladc76c912006-07-19 01:40:55 -0400102
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200103 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
104 ff_field->value[0] = x;
105 ff_field->value[1] = y;
106 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
107 break;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400108
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200109 case FF_RUMBLE:
Jiri Slaby10e41a72008-09-18 12:23:31 +0200110 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200111 ff_field->logical_minimum,
112 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +0200113 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200114 ff_field->logical_minimum,
115 ff_field->logical_maximum);
116
117 dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
118 ff_field->value[0] = left;
119 ff_field->value[1] = right;
120 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
121 break;
122 }
Anssi Hannuladc76c912006-07-19 01:40:55 -0400123 return 0;
124}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Jiri Slaby10e41a72008-09-18 12:23:31 +0200126static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Anssi Hannuladc76c912006-07-19 01:40:55 -0400128 struct tmff_device *tmff;
Li Zefan3ba56192007-11-14 11:31:05 +0100129 struct hid_report *report;
130 struct list_head *report_list;
Jiri Slaby10e41a72008-09-18 12:23:31 +0200131 struct hid_input *hidinput = list_entry(hid->inputs.next,
132 struct hid_input, list);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500133 struct input_dev *input_dev = hidinput->input;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400134 int error;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200135 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Anssi Hannuladc76c912006-07-19 01:40:55 -0400137 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
138 if (!tmff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 return -ENOMEM;
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 /* Find the report to use */
Li Zefan3ba56192007-11-14 11:31:05 +0100142 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
143 list_for_each_entry(report, report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 int fieldnum;
145
146 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
147 struct hid_field *field = report->field[fieldnum];
148
149 if (field->maxusage <= 0)
150 continue;
151
152 switch (field->usage[0].hid) {
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200153 case THRUSTMASTER_USAGE_FF:
154 if (field->report_count < 2) {
Joe Perches4291ee32010-12-09 19:29:03 -0800155 hid_warn(hid, "ignoring FF field with report_count < 2\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 continue;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200157 }
158
Jiri Slaby10e41a72008-09-18 12:23:31 +0200159 if (field->logical_maximum ==
160 field->logical_minimum) {
Joe Perches4291ee32010-12-09 19:29:03 -0800161 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200162 continue;
163 }
164
165 if (tmff->report && tmff->report != report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800166 hid_warn(hid, "ignoring FF field in other report\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200167 continue;
168 }
169
170 if (tmff->ff_field && tmff->ff_field != field) {
Joe Perches4291ee32010-12-09 19:29:03 -0800171 hid_warn(hid, "ignoring duplicate FF field\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200172 continue;
173 }
174
175 tmff->report = report;
176 tmff->ff_field = field;
177
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200178 for (i = 0; ff_bits[i] >= 0; i++)
179 set_bit(ff_bits[i], input_dev->ffbit);
180
181 break;
182
183 default:
Joe Perches4291ee32010-12-09 19:29:03 -0800184 hid_warn(hid, "ignoring unknown output usage %08x\n",
185 field->usage[0].hid);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200186 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 }
189 }
190
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200191 if (!tmff->report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800192 hid_err(hid, "can't find FF field in output reports\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200193 error = -ENODEV;
194 goto fail;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Jiri Slaby10e41a72008-09-18 12:23:31 +0200197 error = input_ff_create_memless(input_dev, tmff, tmff_play);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200198 if (error)
199 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Joe Perches4291ee32010-12-09 19:29:03 -0800201 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 return 0;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200203
Jiri Slaby10e41a72008-09-18 12:23:31 +0200204fail:
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200205 kfree(tmff);
206 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200208#else
209static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
210{
211 return 0;
212}
213#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Jiri Slaby10e41a72008-09-18 12:23:31 +0200215static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
216{
217 int ret;
218
219 ret = hid_parse(hdev);
220 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800221 hid_err(hdev, "parse failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200222 goto err;
223 }
224
225 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
226 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800227 hid_err(hdev, "hw start failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200228 goto err;
229 }
230
231 tmff_init(hdev, (void *)id->driver_data);
232
233 return 0;
234err:
235 return ret;
236}
237
238static const struct hid_device_id tm_devices[] = {
239 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
240 .driver_data = (unsigned long)ff_rumble },
Ruben Aos Garralda7a84b132009-06-29 09:41:29 +0200241 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */
242 .driver_data = (unsigned long)ff_rumble },
243 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */
244 .driver_data = (unsigned long)ff_rumble },
245 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */
Jiri Slaby10e41a72008-09-18 12:23:31 +0200246 .driver_data = (unsigned long)ff_rumble },
247 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
248 .driver_data = (unsigned long)ff_rumble },
Markus Rathgeb3ee8f0a2010-03-13 17:29:43 +0100249 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */
250 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200251 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
252 .driver_data = (unsigned long)ff_joystick },
Simon Woodd65c3762010-11-29 17:41:23 +0100253 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */
254 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200255 { }
256};
257MODULE_DEVICE_TABLE(hid, tm_devices);
258
259static struct hid_driver tm_driver = {
260 .name = "thrustmaster",
261 .id_table = tm_devices,
262 .probe = tm_probe,
263};
H Hartley Sweetenf4254582012-12-17 15:28:26 -0700264module_hid_driver(tm_driver);
Jiri Slaby10e41a72008-09-18 12:23:31 +0200265
Jiri Slaby10e41a72008-09-18 12:23:31 +0200266MODULE_LICENSE("GPL");