Merge commit 'origin/master' into next
[linux-2.6] / drivers / hid / hid-tmff.c
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/usb.h>
33
34 #include "hid-ids.h"
35
36 static const signed short ff_rumble[] = {
37         FF_RUMBLE,
38         -1
39 };
40
41 static const signed short ff_joystick[] = {
42         FF_CONSTANT,
43         -1
44 };
45
46 #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
52 struct 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 */
58 static 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 */
71 static 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
83 static 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                 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
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                 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
119                 break;
120         }
121         return 0;
122 }
123
124 static 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                                         dev_warn(&hid->dev, "ignoring FF field "
154                                                 "with report_count < 2\n");
155                                         continue;
156                                 }
157
158                                 if (field->logical_maximum ==
159                                                 field->logical_minimum) {
160                                         dev_warn(&hid->dev, "ignoring FF field "
161                                                         "with logical_maximum "
162                                                         "== logical_minimum\n");
163                                         continue;
164                                 }
165
166                                 if (tmff->report && tmff->report != report) {
167                                         dev_warn(&hid->dev, "ignoring FF field "
168                                                         "in other report\n");
169                                         continue;
170                                 }
171
172                                 if (tmff->ff_field && tmff->ff_field != field) {
173                                         dev_warn(&hid->dev, "ignoring "
174                                                         "duplicate FF field\n");
175                                         continue;
176                                 }
177
178                                 tmff->report = report;
179                                 tmff->ff_field = field;
180
181                                 for (i = 0; ff_bits[i] >= 0; i++)
182                                         set_bit(ff_bits[i], input_dev->ffbit);
183
184                                 break;
185
186                         default:
187                                 dev_warn(&hid->dev, "ignoring unknown output "
188                                                 "usage %08x\n",
189                                                 field->usage[0].hid);
190                                 continue;
191                         }
192                 }
193         }
194
195         if (!tmff->report) {
196                 dev_err(&hid->dev, "can't find FF field in output reports\n");
197                 error = -ENODEV;
198                 goto fail;
199         }
200
201         error = input_ff_create_memless(input_dev, tmff, tmff_play);
202         if (error)
203                 goto fail;
204
205         dev_info(&hid->dev, "force feedback for ThrustMaster devices by Zinx "
206                         "Verituse <zinx@epicsol.org>");
207         return 0;
208
209 fail:
210         kfree(tmff);
211         return error;
212 }
213 #else
214 static inline int tmff_init(struct hid_device *hid, const signed short *ff_bits)
215 {
216         return 0;
217 }
218 #endif
219
220 static 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;
239 err:
240         return ret;
241 }
242
243 static 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 };
254 MODULE_DEVICE_TABLE(hid, tm_devices);
255
256 static struct hid_driver tm_driver = {
257         .name = "thrustmaster",
258         .id_table = tm_devices,
259         .probe = tm_probe,
260 };
261
262 static int tm_init(void)
263 {
264         return hid_register_driver(&tm_driver);
265 }
266
267 static void tm_exit(void)
268 {
269         hid_unregister_driver(&tm_driver);
270 }
271
272 module_init(tm_init);
273 module_exit(tm_exit);
274 MODULE_LICENSE("GPL");