xref: /linux/drivers/hid/hid-tmff.c (revision 8f86a2c3cb90e8bb0733de2d2b0abbe7050bb536)
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/usb.h>
34 #include <linux/module.h>
35 
36 #include "hid-ids.h"
37 
38 static const signed short ff_rumble[] = {
39 	FF_RUMBLE,
40 	-1
41 };
42 
43 static const signed short ff_joystick[] = {
44 	FF_CONSTANT,
45 	-1
46 };
47 
48 #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 
54 struct tmff_device {
55 	struct hid_report *report;
56 	struct hid_field *ff_field;
57 };
58 
59 /* Changes values from 0 to 0xffff into values from minimum to maximum */
60 static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
61 {
62 	int ret;
63 
64 	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 
72 /* Changes values from -0x80 to 0x7f into values from minimum to maximum */
73 static inline int tmff_scale_s8(int in, int minimum, int maximum)
74 {
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 
85 static int tmff_play(struct input_dev *dev, void *data,
86 		struct ff_effect *effect)
87 {
88 	struct hid_device *hid = input_get_drvdata(dev);
89 	struct tmff_device *tmff = data;
90 	struct hid_field *ff_field = tmff->ff_field;
91 	int x, y;
92 	int left, right;	/* Rumbling */
93 
94 	switch (effect->type) {
95 	case FF_CONSTANT:
96 		x = tmff_scale_s8(effect->u.ramp.start_level,
97 					ff_field->logical_minimum,
98 					ff_field->logical_maximum);
99 		y = tmff_scale_s8(effect->u.ramp.end_level,
100 					ff_field->logical_minimum,
101 					ff_field->logical_maximum);
102 
103 		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;
108 
109 	case FF_RUMBLE:
110 		left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
111 					ff_field->logical_minimum,
112 					ff_field->logical_maximum);
113 		right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
114 					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 	}
123 	return 0;
124 }
125 
126 static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
127 {
128 	struct tmff_device *tmff;
129 	struct hid_report *report;
130 	struct list_head *report_list;
131 	struct hid_input *hidinput = list_entry(hid->inputs.next,
132 							struct hid_input, list);
133 	struct input_dev *input_dev = hidinput->input;
134 	int error;
135 	int i;
136 
137 	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
138 	if (!tmff)
139 		return -ENOMEM;
140 
141 	/* Find the report to use */
142 	report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
143 	list_for_each_entry(report, report_list, list) {
144 		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) {
153 			case THRUSTMASTER_USAGE_FF:
154 				if (field->report_count < 2) {
155 					hid_warn(hid, "ignoring FF field with report_count < 2\n");
156 					continue;
157 				}
158 
159 				if (field->logical_maximum ==
160 						field->logical_minimum) {
161 					hid_warn(hid, "ignoring FF field with logical_maximum == logical_minimum\n");
162 					continue;
163 				}
164 
165 				if (tmff->report && tmff->report != report) {
166 					hid_warn(hid, "ignoring FF field in other report\n");
167 					continue;
168 				}
169 
170 				if (tmff->ff_field && tmff->ff_field != field) {
171 					hid_warn(hid, "ignoring duplicate FF field\n");
172 					continue;
173 				}
174 
175 				tmff->report = report;
176 				tmff->ff_field = field;
177 
178 				for (i = 0; ff_bits[i] >= 0; i++)
179 					set_bit(ff_bits[i], input_dev->ffbit);
180 
181 				break;
182 
183 			default:
184 				hid_warn(hid, "ignoring unknown output usage %08x\n",
185 					 field->usage[0].hid);
186 				continue;
187 			}
188 		}
189 	}
190 
191 	if (!tmff->report) {
192 		hid_err(hid, "can't find FF field in output reports\n");
193 		error = -ENODEV;
194 		goto fail;
195 	}
196 
197 	error = input_ff_create_memless(input_dev, tmff, tmff_play);
198 	if (error)
199 		goto fail;
200 
201 	hid_info(hid, "force feedback for ThrustMaster devices by Zinx Verituse <zinx@epicsol.org>\n");
202 	return 0;
203 
204 fail:
205 	kfree(tmff);
206 	return error;
207 }
208 #else
209 static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
210 {
211 	return 0;
212 }
213 #endif
214 
215 static 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) {
221 		hid_err(hdev, "parse failed\n");
222 		goto err;
223 	}
224 
225 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
226 	if (ret) {
227 		hid_err(hdev, "hw start failed\n");
228 		goto err;
229 	}
230 
231 	tmff_init(hdev, (void *)id->driver_data);
232 
233 	return 0;
234 err:
235 	return ret;
236 }
237 
238 static const struct hid_device_id tm_devices[] = {
239 	{ HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb300),
240 		.driver_data = (unsigned long)ff_rumble },
241 	{ 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) */
246 		.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 },
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 };
257 MODULE_DEVICE_TABLE(hid, tm_devices);
258 
259 static struct hid_driver tm_driver = {
260 	.name = "thrustmaster",
261 	.id_table = tm_devices,
262 	.probe = tm_probe,
263 };
264 
265 static int __init tm_init(void)
266 {
267 	return hid_register_driver(&tm_driver);
268 }
269 
270 static void __exit tm_exit(void)
271 {
272 	hid_unregister_driver(&tm_driver);
273 }
274 
275 module_init(tm_init);
276 module_exit(tm_exit);
277 MODULE_LICENSE("GPL");
278