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
37static 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
47#ifdef CONFIG_THRUSTMASTER_FF
48
49/* Usages for thrustmaster devices I know about */
50#define THRUSTMASTER_USAGE_FF (HID_UP_GENDESK | 0xbb)
51
52struct tmff_device {
53 struct hid_report *report;
54 struct hid_field *ff_field;
55};
56
57/* Changes values from 0 to 0xffff into values from minimum to maximum */
58static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
59{
60 int ret;
61
62 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
70/* Changes values from -0x80 to 0x7f into values from minimum to maximum */
71static inline int tmff_scale_s8(int in, int minimum, int maximum)
72{
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
83static int tmff_play(struct input_dev *dev, void *data,
84 struct ff_effect *effect)
85{
86 struct hid_device *hid = input_get_drvdata(dev);
87 struct tmff_device *tmff = data;
88 struct hid_field *ff_field = tmff->ff_field;
89 int x, y;
90 int left, right; /* Rumbling */
91
92 switch (effect->type) {
93 case FF_CONSTANT:
94 x = tmff_scale_s8(effect->u.ramp.start_level,
95 ff_field->logical_minimum,
96 ff_field->logical_maximum);
97 y = tmff_scale_s8(effect->u.ramp.end_level,
98 ff_field->logical_minimum,
99 ff_field->logical_maximum);
100
101 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
102 ff_field->value[0] = x;
103 ff_field->value[1] = y;
104 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
105 break;
106
107 case FF_RUMBLE:
108 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
109 ff_field->logical_minimum,
110 ff_field->logical_maximum);
111 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
112 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 hid_hw_request(hid, tmff->report, HID_REQ_SET_REPORT);
119 break;
120 }
121 return 0;
122}
123
124static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
125{
126 struct tmff_device *tmff;
127 struct hid_report *report;
128 struct list_head *report_list;
129 struct hid_input *hidinput = list_entry(hid->inputs.next,
130 struct hid_input, list);
131 struct input_dev *input_dev = hidinput->input;
132 int error;
133 int i;
134
135 tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
136 if (!tmff)
137 return -ENOMEM;
138
139 /* Find the report to use */
140 report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
141 list_for_each_entry(report, report_list, list) {
142 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) {
151 case THRUSTMASTER_USAGE_FF:
152 if (field->report_count < 2) {
153 hid_warn(hid, "ignoring FF field with report_count < 2\n");
154 continue;
155 }
156
157 if (field->logical_maximum ==
158 field->logical_minimum) {
159 hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
160 continue;
161 }
162
163 if (tmff->report && tmff->report != report) {
164 hid_warn(hid, "ignoring FF field in other report\n");
165 continue;
166 }
167
168 if (tmff->ff_field && tmff->ff_field != field) {
169 hid_warn(hid, "ignoring duplicate FF field\n");
170 continue;
171 }
172
173 tmff->report = report;
174 tmff->ff_field = field;
175
176 for (i = 0; ff_bits[i] >= 0; i++)
177 set_bit(ff_bits[i], input_dev->ffbit);
178
179 break;
180
181 default:
182 hid_warn(hid, "ignoring unknown output usage %08x\n",
183 field->usage[0].hid);
184 continue;
185 }
186 }
187 }
188
189 if (!tmff->report) {
190 hid_err(hid, "can't find FF field in output reports\n");
191 error = -ENODEV;
192 goto fail;
193 }
194
195 error = input_ff_create_memless(input_dev, tmff, tmff_play);
196 if (error)
197 goto fail;
198
199 hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
200 return 0;
201
202fail:
203 kfree(tmff);
204 return error;
205}
206#else
207static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
208{
209 return 0;
210}
211#endif
212
213static int tm_probe(struct hid_device *hdev, const struct hid_device_id *id)
214{
215 int ret;
216
217 ret = hid_parse(hdev);
218 if (ret) {
219 hid_err(hdev, "parse failed\n");
220 goto err;
221 }
222
223 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
224 if (ret) {
225 hid_err(hdev, "hw start failed\n");
226 goto err;
227 }
228
229 tmff_init(hdev, (void *)id->driver_data);
230
231 return 0;
232err:
233 return ret;
234}
235
236static const struct hid_device_id tm_devices[] = {
237 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
238 .driver_data = (unsigned long)ff_rumble },
239 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb304), /* FireStorm Dual Power 2 (and 3) */
240 .driver_data = (unsigned long)ff_rumble },
241 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb323), /* Dual Trigger 3-in-1 (PC Mode) */
242 .driver_data = (unsigned long)ff_rumble },
243 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb324), /* Dual Trigger 3-in-1 (PS3 Mode) */
244 .driver_data = (unsigned long)ff_rumble },
245 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb605), /* NASCAR PRO FF2 Wheel */
246 .driver_data = (unsigned long)ff_joystick },
247 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651), /* FGT Rumble Force Wheel */
248 .driver_data = (unsigned long)ff_rumble },
249 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb653), /* RGT Force Feedback CLUTCH Raging Wheel */
250 .driver_data = (unsigned long)ff_joystick },
251 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654), /* FGT Force Feedback Wheel */
252 .driver_data = (unsigned long)ff_joystick },
253 { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb65a), /* F430 Force Feedback Wheel */
254 .driver_data = (unsigned long)ff_joystick },
255 { }
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};
264module_hid_driver(tm_driver);
265
266MODULE_LICENSE("GPL");
267