Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound-2.6
[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 #include "usbhid/usbhid.h"
37
38 /* Usages for thrustmaster devices I know about */
39 #define THRUSTMASTER_USAGE_FF   (HID_UP_GENDESK | 0xbb)
40
41 static const signed short ff_rumble[] = {
42         FF_RUMBLE,
43         -1
44 };
45
46 static const signed short ff_joystick[] = {
47         FF_CONSTANT,
48         -1
49 };
50
51 struct tmff_device {
52         struct hid_report *report;
53         struct hid_field *ff_field;
54 };
55
56 /* Changes values from 0 to 0xffff into values from minimum to maximum */
57 static inline int tmff_scale_u16(unsigned int in, int minimum, int maximum)
58 {
59         int ret;
60
61         ret = (in * (maximum - minimum) / 0xffff) + minimum;
62         if (ret < minimum)
63                 return minimum;
64         if (ret > maximum)
65                 return maximum;
66         return ret;
67 }
68
69 /* Changes values from -0x80 to 0x7f into values from minimum to maximum */
70 static inline int tmff_scale_s8(int in, int minimum, int maximum)
71 {
72         int ret;
73
74         ret = (((in + 0x80) * (maximum - minimum)) / 0xff) + minimum;
75         if (ret < minimum)
76                 return minimum;
77         if (ret > maximum)
78                 return maximum;
79         return ret;
80 }
81
82 static int tmff_play(struct input_dev *dev, void *data,
83                 struct ff_effect *effect)
84 {
85         struct hid_device *hid = input_get_drvdata(dev);
86         struct tmff_device *tmff = data;
87         struct hid_field *ff_field = tmff->ff_field;
88         int x, y;
89         int left, right;        /* Rumbling */
90
91         switch (effect->type) {
92         case FF_CONSTANT:
93                 x = tmff_scale_s8(effect->u.ramp.start_level,
94                                         ff_field->logical_minimum,
95                                         ff_field->logical_maximum);
96                 y = tmff_scale_s8(effect->u.ramp.end_level,
97                                         ff_field->logical_minimum,
98                                         ff_field->logical_maximum);
99
100                 dbg_hid("(x, y)=(%04x, %04x)\n", x, y);
101                 ff_field->value[0] = x;
102                 ff_field->value[1] = y;
103                 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
104                 break;
105
106         case FF_RUMBLE:
107                 left = tmff_scale_u16(effect->u.rumble.weak_magnitude,
108                                         ff_field->logical_minimum,
109                                         ff_field->logical_maximum);
110                 right = tmff_scale_u16(effect->u.rumble.strong_magnitude,
111                                         ff_field->logical_minimum,
112                                         ff_field->logical_maximum);
113
114                 dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
115                 ff_field->value[0] = left;
116                 ff_field->value[1] = right;
117                 usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
118                 break;
119         }
120         return 0;
121 }
122
123 static int tmff_init(struct hid_device *hid, const signed short *ff_bits)
124 {
125         struct tmff_device *tmff;
126         struct hid_report *report;
127         struct list_head *report_list;
128         struct hid_input *hidinput = list_entry(hid->inputs.next,
129                                                         struct hid_input, list);
130         struct input_dev *input_dev = hidinput->input;
131         int error;
132         int i;
133
134         tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
135         if (!tmff)
136                 return -ENOMEM;
137
138         /* Find the report to use */
139         report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
140         list_for_each_entry(report, report_list, list) {
141                 int fieldnum;
142
143                 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
144                         struct hid_field *field = report->field[fieldnum];
145
146                         if (field->maxusage <= 0)
147                                 continue;
148
149                         switch (field->usage[0].hid) {
150                         case THRUSTMASTER_USAGE_FF:
151                                 if (field->report_count < 2) {
152                                         dev_warn(&hid->dev, "ignoring FF field "
153                                                 "with report_count < 2\n");
154                                         continue;
155                                 }
156
157                                 if (field->logical_maximum ==
158                                                 field->logical_minimum) {
159                                         dev_warn(&hid->dev, "ignoring FF field "
160                                                         "with logical_maximum "
161                                                         "== logical_minimum\n");
162                                         continue;
163                                 }
164
165                                 if (tmff->report && tmff->report != report) {
166                                         dev_warn(&hid->dev, "ignoring FF field "
167                                                         "in other report\n");
168                                         continue;
169                                 }
170
171                                 if (tmff->ff_field && tmff->ff_field != field) {
172                                         dev_warn(&hid->dev, "ignoring "
173                                                         "duplicate FF field\n");
174                                         continue;
175                                 }
176
177                                 tmff->report = report;
178                                 tmff->ff_field = field;
179
180                                 for (i = 0; ff_bits[i] >= 0; i++)
181                                         set_bit(ff_bits[i], input_dev->ffbit);
182
183                                 break;
184
185                         default:
186                                 dev_warn(&hid->dev, "ignoring unknown output "
187                                                 "usage %08x\n",
188                                                 field->usage[0].hid);
189                                 continue;
190                         }
191                 }
192         }
193
194         if (!tmff->report) {
195                 dev_err(&hid->dev, "can't find FF field in output reports\n");
196                 error = -ENODEV;
197                 goto fail;
198         }
199
200         error = input_ff_create_memless(input_dev, tmff, tmff_play);
201         if (error)
202                 goto fail;
203
204         dev_info(&hid->dev, "force feedback for ThrustMaster devices by Zinx "
205                         "Verituse <zinx@epicsol.org>");
206         return 0;
207
208 fail:
209         kfree(tmff);
210         return error;
211 }
212
213 static 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                 dev_err(&hdev->dev, "parse failed\n");
220                 goto err;
221         }
222
223         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
224         if (ret) {
225                 dev_err(&hdev->dev, "hw start failed\n");
226                 goto err;
227         }
228
229         tmff_init(hdev, (void *)id->driver_data);
230
231         return 0;
232 err:
233         return ret;
234 }
235
236 static 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),
240                 .driver_data = (unsigned long)ff_rumble },
241         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb651),   /* FGT Rumble Force Wheel */
242                 .driver_data = (unsigned long)ff_rumble },
243         { HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, 0xb654),   /* FGT Force Feedback Wheel */
244                 .driver_data = (unsigned long)ff_joystick },
245         { }
246 };
247 MODULE_DEVICE_TABLE(hid, tm_devices);
248
249 static struct hid_driver tm_driver = {
250         .name = "thrustmaster",
251         .id_table = tm_devices,
252         .probe = tm_probe,
253 };
254
255 static int tm_init(void)
256 {
257         return hid_register_driver(&tm_driver);
258 }
259
260 static void tm_exit(void)
261 {
262         hid_unregister_driver(&tm_driver);
263 }
264
265 module_init(tm_init);
266 module_exit(tm_exit);
267 MODULE_LICENSE("GPL");
268
269 HID_COMPAT_LOAD_DRIVER(thrustmaster);