blob: 0fe8f65ef01a64c7d68155946498a28acbeaf63e [file] [log] [blame]
Richard Walmsley3f866fb2009-03-04 22:12:04 +13001/*
2 * Force feedback support for DragonRise Inc. game controllers
3 *
4 * From what I have gathered, these devices are mass produced in China and are
5 * distributed under several vendors. They often share the same design as
6 * the original PlayStation DualShock controller.
7 *
8 * 0079:0006 "DragonRise Inc. Generic USB Joystick "
9 * - tested with a Tesun USB-703 game controller.
10 *
11 * Copyright (c) 2009 Richard Walmsley <richwalm@gmail.com>
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Richard Walmsley3f866fb2009-03-04 22:12:04 +130032#include <linux/usb.h>
33#include <linux/hid.h>
Paul Gortmaker8f86a2c2011-07-03 13:39:48 -040034#include <linux/module.h>
Richard Walmsley3f866fb2009-03-04 22:12:04 +130035
36#include "hid-ids.h"
Jiri Kosina0f6f4312009-05-15 15:46:44 +020037
38#ifdef CONFIG_DRAGONRISE_FF
Richard Walmsley3f866fb2009-03-04 22:12:04 +130039#include "usbhid/usbhid.h"
40
41struct drff_device {
42 struct hid_report *report;
43};
44
45static int drff_play(struct input_dev *dev, void *data,
46 struct ff_effect *effect)
47{
48 struct hid_device *hid = input_get_drvdata(dev);
49 struct drff_device *drff = data;
50 int strong, weak;
51
52 strong = effect->u.rumble.strong_magnitude;
53 weak = effect->u.rumble.weak_magnitude;
54
55 dbg_hid("called with 0x%04x 0x%04x", strong, weak);
56
57 if (strong || weak) {
58 strong = strong * 0xff / 0xffff;
59 weak = weak * 0xff / 0xffff;
60
61 /* While reverse engineering this device, I found that when
62 this value is set, it causes the strong rumble to function
63 at a near maximum speed, so we'll bypass it. */
64 if (weak == 0x0a)
65 weak = 0x0b;
66
67 drff->report->field[0]->value[0] = 0x51;
68 drff->report->field[0]->value[1] = 0x00;
69 drff->report->field[0]->value[2] = weak;
70 drff->report->field[0]->value[4] = strong;
71 usbhid_submit_report(hid, drff->report, USB_DIR_OUT);
72
73 drff->report->field[0]->value[0] = 0xfa;
74 drff->report->field[0]->value[1] = 0xfe;
75 } else {
76 drff->report->field[0]->value[0] = 0xf3;
77 drff->report->field[0]->value[1] = 0x00;
78 }
79
80 drff->report->field[0]->value[2] = 0x00;
81 drff->report->field[0]->value[4] = 0x00;
82 dbg_hid("running with 0x%02x 0x%02x", strong, weak);
83 usbhid_submit_report(hid, drff->report, USB_DIR_OUT);
84
85 return 0;
86}
87
88static int drff_init(struct hid_device *hid)
89{
90 struct drff_device *drff;
91 struct hid_report *report;
92 struct hid_input *hidinput = list_first_entry(&hid->inputs,
93 struct hid_input, list);
94 struct list_head *report_list =
95 &hid->report_enum[HID_OUTPUT_REPORT].report_list;
96 struct input_dev *dev = hidinput->input;
97 int error;
98
99 if (list_empty(report_list)) {
Joe Perches4291ee32010-12-09 19:29:03 -0800100 hid_err(hid, "no output reports found\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300101 return -ENODEV;
102 }
103
104 report = list_first_entry(report_list, struct hid_report, list);
105 if (report->maxfield < 1) {
Joe Perches4291ee32010-12-09 19:29:03 -0800106 hid_err(hid, "no fields in the report\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300107 return -ENODEV;
108 }
109
110 if (report->field[0]->report_count < 7) {
Joe Perches4291ee32010-12-09 19:29:03 -0800111 hid_err(hid, "not enough values in the field\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300112 return -ENODEV;
113 }
114
115 drff = kzalloc(sizeof(struct drff_device), GFP_KERNEL);
116 if (!drff)
117 return -ENOMEM;
118
119 set_bit(FF_RUMBLE, dev->ffbit);
120
121 error = input_ff_create_memless(dev, drff, drff_play);
122 if (error) {
123 kfree(drff);
124 return error;
125 }
126
127 drff->report = report;
128 drff->report->field[0]->value[0] = 0xf3;
129 drff->report->field[0]->value[1] = 0x00;
130 drff->report->field[0]->value[2] = 0x00;
131 drff->report->field[0]->value[3] = 0x00;
132 drff->report->field[0]->value[4] = 0x00;
133 drff->report->field[0]->value[5] = 0x00;
134 drff->report->field[0]->value[6] = 0x00;
135 usbhid_submit_report(hid, drff->report, USB_DIR_OUT);
136
Joe Perches4291ee32010-12-09 19:29:03 -0800137 hid_info(hid, "Force Feedback for DragonRise Inc. "
138 "game controllers by Richard Walmsley <richwalm@gmail.com>\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300139
140 return 0;
141}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200142#else
143static inline int drff_init(struct hid_device *hid)
144{
145 return 0;
146}
147#endif
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300148
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300149/*
150 * The original descriptor of joystick with PID 0x0011, represented by DVTech PC
151 * JS19. It seems both copied from another device and a result of confusion
152 * either about the specification or about the program used to create the
153 * descriptor. In any case, it's a wonder it works on Windows.
154 *
155 * Usage Page (Desktop), ; Generic desktop controls (01h)
156 * Usage (Joystik), ; Joystik (04h, application collection)
157 * Collection (Application),
158 * Collection (Logical),
159 * Report Size (8),
160 * Report Count (5),
161 * Logical Minimum (0),
162 * Logical Maximum (255),
163 * Physical Minimum (0),
164 * Physical Maximum (255),
165 * Usage (X), ; X (30h, dynamic value)
166 * Usage (X), ; X (30h, dynamic value)
167 * Usage (X), ; X (30h, dynamic value)
168 * Usage (X), ; X (30h, dynamic value)
169 * Usage (Y), ; Y (31h, dynamic value)
170 * Input (Variable),
171 * Report Size (4),
172 * Report Count (1),
173 * Logical Maximum (7),
174 * Physical Maximum (315),
175 * Unit (Degrees),
176 * Usage (00h),
177 * Input (Variable, Null State),
178 * Unit,
179 * Report Size (1),
180 * Report Count (10),
181 * Logical Maximum (1),
182 * Physical Maximum (1),
183 * Usage Page (Button), ; Button (09h)
184 * Usage Minimum (01h),
185 * Usage Maximum (0Ah),
186 * Input (Variable),
187 * Usage Page (FF00h), ; FF00h, vendor-defined
188 * Report Size (1),
189 * Report Count (10),
190 * Logical Maximum (1),
191 * Physical Maximum (1),
192 * Usage (01h),
193 * Input (Variable),
194 * End Collection,
195 * Collection (Logical),
196 * Report Size (8),
197 * Report Count (4),
198 * Physical Maximum (255),
199 * Logical Maximum (255),
200 * Usage (02h),
201 * Output (Variable),
202 * End Collection,
203 * End Collection
204 */
205
206/* Size of the original descriptor of the PID 0x0011 joystick */
207#define PID0011_RDESC_ORIG_SIZE 101
208
209/* Fixed report descriptor for PID 0x011 joystick */
210static __u8 pid0011_rdesc_fixed[] = {
211 0x05, 0x01, /* Usage Page (Desktop), */
212 0x09, 0x04, /* Usage (Joystik), */
213 0xA1, 0x01, /* Collection (Application), */
214 0xA1, 0x02, /* Collection (Logical), */
215 0x14, /* Logical Minimum (0), */
216 0x75, 0x08, /* Report Size (8), */
217 0x95, 0x03, /* Report Count (3), */
218 0x81, 0x01, /* Input (Constant), */
219 0x26, 0xFF, 0x00, /* Logical Maximum (255), */
220 0x95, 0x02, /* Report Count (2), */
221 0x09, 0x30, /* Usage (X), */
222 0x09, 0x31, /* Usage (Y), */
223 0x81, 0x02, /* Input (Variable), */
224 0x75, 0x01, /* Report Size (1), */
225 0x95, 0x04, /* Report Count (4), */
226 0x81, 0x01, /* Input (Constant), */
227 0x25, 0x01, /* Logical Maximum (1), */
228 0x95, 0x0A, /* Report Count (10), */
229 0x05, 0x09, /* Usage Page (Button), */
230 0x19, 0x01, /* Usage Minimum (01h), */
231 0x29, 0x0A, /* Usage Maximum (0Ah), */
232 0x81, 0x02, /* Input (Variable), */
233 0x95, 0x0A, /* Report Count (10), */
234 0x81, 0x01, /* Input (Constant), */
235 0xC0, /* End Collection, */
236 0xC0 /* End Collection */
237};
238
239static __u8 *dr_report_fixup(struct hid_device *hdev, __u8 *rdesc,
240 unsigned int *rsize)
241{
242 switch (hdev->product) {
243 case 0x0011:
244 if (*rsize == PID0011_RDESC_ORIG_SIZE) {
245 rdesc = pid0011_rdesc_fixed;
246 *rsize = sizeof(pid0011_rdesc_fixed);
247 }
248 break;
249 }
250 return rdesc;
251}
252
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300253static int dr_probe(struct hid_device *hdev, const struct hid_device_id *id)
254{
255 int ret;
256
257 dev_dbg(&hdev->dev, "DragonRise Inc. HID hardware probe...");
258
259 ret = hid_parse(hdev);
260 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800261 hid_err(hdev, "parse failed\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300262 goto err;
263 }
264
265 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
266 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800267 hid_err(hdev, "hw start failed\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300268 goto err;
269 }
270
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300271 switch (hdev->product) {
272 case 0x0006:
273 ret = drff_init(hdev);
274 if (ret) {
275 dev_err(&hdev->dev, "force feedback init failed\n");
276 hid_hw_stop(hdev);
277 goto err;
278 }
279 break;
280 }
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300281
282 return 0;
283err:
284 return ret;
285}
286
287static const struct hid_device_id dr_devices[] = {
288 { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006), },
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300289 { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0011), },
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300290 { }
291};
292MODULE_DEVICE_TABLE(hid, dr_devices);
293
294static struct hid_driver dr_driver = {
295 .name = "dragonrise",
296 .id_table = dr_devices,
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300297 .report_fixup = dr_report_fixup,
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300298 .probe = dr_probe,
299};
H Hartley Sweetenf4254582012-12-17 15:28:26 -0700300module_hid_driver(dr_driver);
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300301
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300302MODULE_LICENSE("GPL");