blob: fcd6ccd02fee28fb77d9775f962c38cdec516754 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/usb.h>
33
Jiri Slaby10e41a72008-09-18 12:23:31 +020034#include "hid-ids.h"
35
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020036static const signed short ff_rumble[] = {
37 FF_RUMBLE,
38 -1
39};
40
41static const signed short ff_joystick[] = {
42 FF_CONSTANT,
43 -1
44};
45
Jiri Kosina0f6f4312009-05-15 15:46:44 +020046#ifdef CONFIG_THRUSTMASTER_FF
47#include "usbhid/usbhid.h"
48
49/* Usages for thrustmaster devices I know about */
50#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb)
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct tmff_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 struct hid_report *report;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020054 struct hid_field *ff_field;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055};
56
Anssi Hannuladc76c912006-07-19 01:40:55 -040057/* Changes values from 0 to 0xffff into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020058static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
Anssi Hannuladc76c912006-07-19 01:40:55 -040059{
60 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Anssi Hannuladc76c912006-07-19 01:40:55 -040062 ret = (in * (maximum - minimum) / 0xffff) + minimum;
63 if (ret < minimum)
64 return minimum;
65 if (ret > maximum)
66 return maximum;
67 return ret;
68}
69
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020070/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
Jiri Slaby10e41a72008-09-18 12:23:31 +020071static inline int tmff_scale_s8(int in, int minimum, int maximum)
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020072{
73 int ret;
74
75 ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
76 if (ret < minimum)
77 return minimum;
78 if (ret > maximum)
79 return maximum;
80 return ret;
81}
82
Jiri Slaby10e41a72008-09-18 12:23:31 +020083static int tmff_play(struct input_dev *dev, void *data,
84 struct ff_effect *effect)
Anssi Hannuladc76c912006-07-19 01:40:55 -040085{
Dmitry Torokhove0712982007-05-09 10:17:31 +020086 struct hid_device *hid = input_get_drvdata(dev);
Anssi Hannuladc76c912006-07-19 01:40:55 -040087 struct tmff_device *tmff = data;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020088 struct hid_field *ff_field = tmff->ff_field;
89 int x, y;
Anssi Hannuladc76c912006-07-19 01:40:55 -040090 int left, right; /* Rumbling */
91
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020092 switch (effect->type) {
93 case FF_CONSTANT:
Jiri Slaby10e41a72008-09-18 12:23:31 +020094 x = tmff_scale_s8(effect->u.ramp.start_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020095 ff_field->logical_minimum,
96 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +020097 y = tmff_scale_s8(effect->u.ramp.end_level,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +020098 ff_field->logical_minimum,
99 ff_field->logical_maximum);
Anssi Hannuladc76c912006-07-19 01:40:55 -0400100
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200101 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
102 ff_field->value[0] = x;
103 ff_field->value[1] = y;
104 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
105 break;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400106
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200107 case FF_RUMBLE:
Jiri Slaby10e41a72008-09-18 12:23:31 +0200108 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200109 ff_field->logical_minimum,
110 ff_field->logical_maximum);
Jiri Slaby10e41a72008-09-18 12:23:31 +0200111 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200112 ff_field->logical_minimum,
113 ff_field->logical_maximum);
114
115 dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
116 ff_field->value[0] = left;
117 ff_field->value[1] = right;
118 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
119 break;
120 }
Anssi Hannuladc76c912006-07-19 01:40:55 -0400121 return 0;
122}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Jiri Slaby10e41a72008-09-18 12:23:31 +0200124static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Anssi Hannuladc76c912006-07-19 01:40:55 -0400126 struct tmff_device *tmff;
Li Zefan3ba56192007-11-14 11:31:05 +0100127 struct hid_report *report;
128 struct list_head *report_list;
Jiri Slaby10e41a72008-09-18 12:23:31 +0200129 struct hid_input *hidinput = list_entry(hid->inputs.next,
130 struct hid_input, list);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500131 struct input_dev *input_dev = hidinput->input;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400132 int error;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200133 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Anssi Hannuladc76c912006-07-19 01:40:55 -0400135 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
136 if (!tmff)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 return -ENOMEM;
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 /* Find the report to use */
Li Zefan3ba56192007-11-14 11:31:05 +0100140 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
141 list_for_each_entry(report, report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 int fieldnum;
143
144 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
145 struct hid_field *field = report->field[fieldnum];
146
147 if (field->maxusage <= 0)
148 continue;
149
150 switch (field->usage[0].hid) {
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200151 case THRUSTMASTER_USAGE_FF:
152 if (field->report_count < 2) {
Jiri Slaby79575012008-09-18 12:23:34 +0200153 dev_warn(&hid->dev, "ignoring FF field "
154 "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) {
Jiri Slaby79575012008-09-18 12:23:34 +0200160 dev_warn(&hid->dev, "ignoring FF field "
161 "with logical_maximum "
162 "== logical_minimum\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200163 continue;
164 }
165
166 if (tmff->report && tmff->report != report) {
Jiri Slaby79575012008-09-18 12:23:34 +0200167 dev_warn(&hid->dev, "ignoring FF field "
168 "in other report\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200169 continue;
170 }
171
172 if (tmff->ff_field && tmff->ff_field != field) {
Jiri Slaby79575012008-09-18 12:23:34 +0200173 dev_warn(&hid->dev, "ignoring "
174 "duplicate FF field\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200175 continue;
176 }
177
178 tmff->report = report;
179 tmff->ff_field = field;
180
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200181 for (i = 0; ff_bits[i] >= 0; i++)
182 set_bit(ff_bits[i], input_dev->ffbit);
183
184 break;
185
186 default:
Jiri Slaby79575012008-09-18 12:23:34 +0200187 dev_warn(&hid->dev, "ignoring unknown output "
188 "usage %08x\n",
Jiri Slaby10e41a72008-09-18 12:23:31 +0200189 field->usage[0].hid);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200190 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 }
193 }
194
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200195 if (!tmff->report) {
Jiri Slaby79575012008-09-18 12:23:34 +0200196 dev_err(&hid->dev, "can't find FF field in output reports\n");
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200197 error = -ENODEV;
198 goto fail;
Anssi Hannuladc76c912006-07-19 01:40:55 -0400199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Jiri Slaby10e41a72008-09-18 12:23:31 +0200201 error = input_ff_create_memless(input_dev, tmff, tmff_play);
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200202 if (error)
203 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Jiri Slaby79575012008-09-18 12:23:34 +0200205 dev_info(&hid->dev, "force feedback for ThrustMaster devices by Zinx "
206 "Verituse <zinx@epicsol.org>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 return 0;
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200208
Jiri Slaby10e41a72008-09-18 12:23:31 +0200209fail:
Dmitry Torokhovb27c9592007-07-30 14:56:26 +0200210 kfree(tmff);
211 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200213#else
214static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
215{
216 return 0;
217}
218#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Jiri Slaby10e41a72008-09-18 12:23:31 +0200220static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
221{
222 int ret;
223
224 ret = hid_parse(hdev);
225 if (ret) {
226 dev_err(&hdev->dev, "parse failed\n");
227 goto err;
228 }
229
230 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
231 if (ret) {
232 dev_err(&hdev->dev, "hw start failed\n");
233 goto err;
234 }
235
236 tmff_init(hdev, (void *)id->driver_data);
237
238 return 0;
239err:
240 return ret;
241}
242
243static const struct hid_device_id tm_devices[] = {
244 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
245 .driver_data = (unsigned long)ff_rumble },
246 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304),
247 .driver_data = (unsigned long)ff_rumble },
248 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
249 .driver_data = (unsigned long)ff_rumble },
250 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
251 .driver_data = (unsigned long)ff_joystick },
252 { }
253};
254MODULE_DEVICE_TABLE(hid, tm_devices);
255
256static struct hid_driver tm_driver = {
257 .name = "thrustmaster",
258 .id_table = tm_devices,
259 .probe = tm_probe,
260};
261
262static int tm_init(void)
263{
264 return hid_register_driver(&tm_driver);
265}
266
267static void tm_exit(void)
268{
269 hid_unregister_driver(&tm_driver);
270}
271
272module_init(tm_init);
273module_exit(tm_exit);
274MODULE_LICENSE("GPL");