Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[linux-2.6] / drivers / hid / usbhid / 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/input.h>
31
32 #undef DEBUG
33 #include <linux/usb.h>
34
35 #include <linux/hid.h>
36 #include "usbhid.h"
37
38 /* Usages for thrustmaster devices I know about */
39 #define THRUSTMASTER_USAGE_RUMBLE_LR    (HID_UP_GENDESK | 0xbb)
40
41
42 struct tmff_device {
43         struct hid_report *report;
44         struct hid_field *rumble;
45 };
46
47 /* Changes values from 0 to 0xffff into values from minimum to maximum */
48 static inline int hid_tmff_scale(unsigned int in, int minimum, int maximum)
49 {
50         int ret;
51
52         ret = (in * (maximum - minimum) / 0xffff) + minimum;
53         if (ret < minimum)
54                 return minimum;
55         if (ret > maximum)
56                 return maximum;
57         return ret;
58 }
59
60 static int hid_tmff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
61 {
62         struct hid_device *hid = input_get_drvdata(dev);
63         struct tmff_device *tmff = data;
64         int left, right;        /* Rumbling */
65
66         left = hid_tmff_scale(effect->u.rumble.weak_magnitude,
67                 tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);
68         right = hid_tmff_scale(effect->u.rumble.strong_magnitude,
69                 tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);
70
71         tmff->rumble->value[0] = left;
72         tmff->rumble->value[1] = right;
73         dbg_hid("(left,right)=(%08x, %08x)\n", left, right);
74         usbhid_submit_report(hid, tmff->report, USB_DIR_OUT);
75
76         return 0;
77 }
78
79 int hid_tmff_init(struct hid_device *hid)
80 {
81         struct tmff_device *tmff;
82         struct list_head *pos;
83         struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
84         struct input_dev *input_dev = hidinput->input;
85         int error;
86
87         tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
88         if (!tmff)
89                 return -ENOMEM;
90
91         /* Find the report to use */
92         __list_for_each(pos, &hid->report_enum[HID_OUTPUT_REPORT].report_list) {
93                 struct hid_report *report = (struct hid_report *)pos;
94                 int fieldnum;
95
96                 for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
97                         struct hid_field *field = report->field[fieldnum];
98
99                         if (field->maxusage <= 0)
100                                 continue;
101
102                         switch (field->usage[0].hid) {
103                                 case THRUSTMASTER_USAGE_RUMBLE_LR:
104                                         if (field->report_count < 2) {
105                                                 warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with report_count < 2");
106                                                 continue;
107                                         }
108
109                                         if (field->logical_maximum == field->logical_minimum) {
110                                                 warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with logical_maximum == logical_minimum");
111                                                 continue;
112                                         }
113
114                                         if (tmff->report && tmff->report != report) {
115                                                 warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR in other report");
116                                                 continue;
117                                         }
118
119                                         if (tmff->rumble && tmff->rumble != field) {
120                                                 warn("ignoring duplicate THRUSTMASTER_USAGE_RUMBLE_LR");
121                                                 continue;
122                                         }
123
124                                         tmff->report = report;
125                                         tmff->rumble = field;
126
127                                         set_bit(FF_RUMBLE, input_dev->ffbit);
128                                         break;
129
130                                 default:
131                                         warn("ignoring unknown output usage %08x", field->usage[0].hid);
132                                         continue;
133                         }
134                 }
135         }
136
137         error = input_ff_create_memless(input_dev, tmff, hid_tmff_play);
138         if (error) {
139                 kfree(tmff);
140                 return error;
141         }
142
143         info("Force feedback for ThrustMaster rumble pad devices by Zinx Verituse <zinx@epicsol.org>");
144
145         return 0;
146 }
147