blob: 575862b0688e4e233108f155812a5962dd38177b [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>
34
Jiri Slaby10e41a72008-09-18 12:23:31 +020035#include "hid-ids.h"
36
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020037static const signed short ff_rumble[] = {
38 FF_RUMBLE,
39 -1
40};
41
42static const signed short ff_joystick[] = {
43 FF_CONSTANT,
44 -1
45};
46
Jiri Kosina0f6f4312009-05-15 15:46:44 +020047#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 Torvalds1da177e2005-04-16 15:20:36 -070053struct tmff_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 struct hid_report *report;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020055 struct hid_field *ff_field;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Anssi Hannuladc76c912006-07-19 01:40:55 -040058/* Changes values from 0 to 0xffff into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020059static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
Anssi Hannuladc76c912006-07-19 01:40:55 -040060{
61 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Anssi Hannuladc76c912006-07-19 01:40:55 -040063 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 Torokhovb27c9592007-07-30 14:56:26 +020071/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020072static inline int tmff_scale_s8(int in, int minimum, int maximum)
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020073{
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 Slaby10e41a72008-09-18 12:23:31 +020084static int tmff_play(struct input_dev *dev, void *data,
85 struct ff_effect *effect)
Anssi Hannuladc76c912006-07-19 01:40:55 -040086{
Dmitry Torokhove0712982007-05-09 10:17:31 +020087 struct hid_device *hid = input_get_drvdata(dev);
Anssi Hannuladc76c912006-07-19 01:40:55 -040088 struct tmff_device *tmff = data;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020089 struct hid_field *ff_field = tmff->ff_field;
90 int x, y;
Anssi Hannuladc76c912006-07-19 01:40:55 -040091 int left, right; /* Rumbling */
92
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020093 switch (effect->type) {
94 case FF_CONSTANT:
Jiri Slaby10e41a72008-09-18 12:23:31 +020095 x = tmff_scale_s8(effect->u.ramp.start_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020096 ff_field->logical_minimum,
97 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +020098 y = tmff_scale_s8(effect->u.ramp.end_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020099 ff_field->logical_minimum,
100 ff_field->logical_maximum);
Anssi Hannuladc76c912006-07-19 01:40:55 -0400101
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200102 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 Hannuladc76c912006-07-19 01:40:55 -0400107
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200108 case FF_RUMBLE:
Jiri Slaby10e41a72008-09-18 12:23:31 +0200109 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200110 ff_field->logical_minimum,
111 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +0200112 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200113 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 Hannuladc76c912006-07-19 01:40:55 -0400122 return 0;
123}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Jiri Slaby10e41a72008-09-18 12:23:31 +0200125static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126{
Anssi Hannuladc76c912006-07-19 01:40:55 -0400127 struct tmff_device *tmff;
Li Zefan3ba56192007-11-14 11:31:05 +0100128 struct hid_report *report;
129 struct list_head *report_list;
Jiri Slaby10e41a72008-09-18 12:23:31 +0200130 struct hid_input *hidinput = list_entry(hid->inputs.next,
131 struct hid_input, list);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500132 struct input_dev *input_dev = hidinput->input;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400133 int error;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200134 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Anssi Hannuladc76c912006-07-19 01:40:55 -0400136 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
137 if (!tmff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 return -ENOMEM;
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 /* Find the report to use */
Li Zefan3ba56192007-11-14 11:31:05 +0100141 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
142 list_for_each_entry(report, report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 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 Torokhovb27c9592007-07-30 14:56:26 +0200152 case THRUSTMASTER_USAGE_FF:
153 if (field->report_count < 2) {
Joe Perches4291ee32010-12-09 19:29:03 -0800154 hid_warn(hid, "ignoring FF field with report_count < 2\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 continue;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200156 }
157
Jiri Slaby10e41a72008-09-18 12:23:31 +0200158 if (field->logical_maximum ==
159 field->logical_minimum) {
Joe Perches4291ee32010-12-09 19:29:03 -0800160 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200161 continue;
162 }
163
164 if (tmff->report && tmff->report != report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800165 hid_warn(hid, "ignoring FF field in other report\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200166 continue;
167 }
168
169 if (tmff->ff_field && tmff->ff_field != field) {
Joe Perches4291ee32010-12-09 19:29:03 -0800170 hid_warn(hid, "ignoring duplicate FF field\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200171 continue;
172 }
173
174 tmff->report = report;
175 tmff->ff_field = field;
176
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200177 for (i = 0; ff_bits[i] >= 0; i++)
178 set_bit(ff_bits[i], input_dev->ffbit);
179
180 break;
181
182 default:
Joe Perches4291ee32010-12-09 19:29:03 -0800183 hid_warn(hid, "ignoring unknown output usage %08x\n",
184 field->usage[0].hid);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200185 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 }
188 }
189
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200190 if (!tmff->report) {
Joe Perches4291ee32010-12-09 19:29:03 -0800191 hid_err(hid, "can't find FF field in output reports\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200192 error = -ENODEV;
193 goto fail;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400194 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Jiri Slaby10e41a72008-09-18 12:23:31 +0200196 error = input_ff_create_memless(input_dev, tmff, tmff_play);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200197 if (error)
198 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Joe Perches4291ee32010-12-09 19:29:03 -0800200 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 return 0;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200202
Jiri Slaby10e41a72008-09-18 12:23:31 +0200203fail:
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200204 kfree(tmff);
205 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200207#else
208static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
209{
210 return 0;
211}
212#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Jiri Slaby10e41a72008-09-18 12:23:31 +0200214static 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 Perches4291ee32010-12-09 19:29:03 -0800220 hid_err(hdev, "parse failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200221 goto err;
222 }
223
224 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
225 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800226 hid_err(hdev, "hw start failed\n");
Jiri Slaby10e41a72008-09-18 12:23:31 +0200227 goto err;
228 }
229
230 tmff_init(hdev, (void *)id->driver_data);
231
232 return 0;
233err:
234 return ret;
235}
236
237static 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 Garralda7a84b132009-06-29 09:41:29 +0200240 { 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 Slaby10e41a72008-09-18 12:23:31 +0200245 .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 Rathgeb3ee8f0a2010-03-13 17:29:43 +0100248 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */
249 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200250 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
251 .driver_data = (unsigned long)ff_joystick },
Simon Woodd65c3762010-11-29 17:41:23 +0100252 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */
253 .driver_data = (unsigned long)ff_joystick },
Jiri Slaby10e41a72008-09-18 12:23:31 +0200254 { }
255};
256MODULE_DEVICE_TABLE(hid, tm_devices);
257
258static struct hid_driver tm_driver = {
259 .name = "thrustmaster",
260 .id_table = tm_devices,
261 .probe = tm_probe,
262};
263
Peter Huewea24f4232009-07-02 19:08:38 +0200264static int __init tm_init(void)
Jiri Slaby10e41a72008-09-18 12:23:31 +0200265{
266 return hid_register_driver(&tm_driver);
267}
268
Peter Huewea24f4232009-07-02 19:08:38 +0200269static void __exit tm_exit(void)
Jiri Slaby10e41a72008-09-18 12:23:31 +0200270{
271 hid_unregister_driver(&tm_driver);
272}
273
274module_init(tm_init);
275module_exit(tm_exit);
276MODULE_LICENSE("GPL");