blob: 8fd4bf77f264940ec04631252062e06aafe148c8 [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/hid.h>
Paul Gortmaker8f86a2c2011-07-03 13:39:48 -040033#include <linux/module.h>
Richard Walmsley3f866fb2009-03-04 22:12:04 +130034
35#include "hid-ids.h"
Jiri Kosina0f6f4312009-05-15 15:46:44 +020036
37#ifdef CONFIG_DRAGONRISE_FF
Richard Walmsley3f866fb2009-03-04 22:12:04 +130038
39struct drff_device {
40 struct hid_report *report;
41};
42
43static int drff_play(struct input_dev *dev, void *data,
44 struct ff_effect *effect)
45{
46 struct hid_device *hid = input_get_drvdata(dev);
47 struct drff_device *drff = data;
48 int strong, weak;
49
50 strong = effect->u.rumble.strong_magnitude;
51 weak = effect->u.rumble.weak_magnitude;
52
53 dbg_hid("called with 0x%04x 0x%04x", strong, weak);
54
55 if (strong || weak) {
56 strong = strong * 0xff / 0xffff;
57 weak = weak * 0xff / 0xffff;
58
59 /* While reverse engineering this device, I found that when
60 this value is set, it causes the strong rumble to function
61 at a near maximum speed, so we'll bypass it. */
62 if (weak == 0x0a)
63 weak = 0x0b;
64
65 drff->report->field[0]->value[0] = 0x51;
66 drff->report->field[0]->value[1] = 0x00;
67 drff->report->field[0]->value[2] = weak;
68 drff->report->field[0]->value[4] = strong;
Benjamin Tissoiresd88142722013-02-25 11:31:46 +010069 hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
Richard Walmsley3f866fb2009-03-04 22:12:04 +130070
71 drff->report->field[0]->value[0] = 0xfa;
72 drff->report->field[0]->value[1] = 0xfe;
73 } else {
74 drff->report->field[0]->value[0] = 0xf3;
75 drff->report->field[0]->value[1] = 0x00;
76 }
77
78 drff->report->field[0]->value[2] = 0x00;
79 drff->report->field[0]->value[4] = 0x00;
80 dbg_hid("running with 0x%02x 0x%02x", strong, weak);
Benjamin Tissoiresd88142722013-02-25 11:31:46 +010081 hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
Richard Walmsley3f866fb2009-03-04 22:12:04 +130082
83 return 0;
84}
85
86static int drff_init(struct hid_device *hid)
87{
88 struct drff_device *drff;
89 struct hid_report *report;
90 struct hid_input *hidinput = list_first_entry(&hid->inputs,
91 struct hid_input, list);
92 struct list_head *report_list =
93 &hid->report_enum[HID_OUTPUT_REPORT].report_list;
94 struct input_dev *dev = hidinput->input;
95 int error;
96
97 if (list_empty(report_list)) {
Joe Perches4291ee32010-12-09 19:29:03 -080098 hid_err(hid, "no output reports found\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +130099 return -ENODEV;
100 }
101
102 report = list_first_entry(report_list, struct hid_report, list);
103 if (report->maxfield < 1) {
Joe Perches4291ee32010-12-09 19:29:03 -0800104 hid_err(hid, "no fields in the report\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300105 return -ENODEV;
106 }
107
108 if (report->field[0]->report_count < 7) {
Joe Perches4291ee32010-12-09 19:29:03 -0800109 hid_err(hid, "not enough values in the field\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300110 return -ENODEV;
111 }
112
113 drff = kzalloc(sizeof(struct drff_device), GFP_KERNEL);
114 if (!drff)
115 return -ENOMEM;
116
117 set_bit(FF_RUMBLE, dev->ffbit);
118
119 error = input_ff_create_memless(dev, drff, drff_play);
120 if (error) {
121 kfree(drff);
122 return error;
123 }
124
125 drff->report = report;
126 drff->report->field[0]->value[0] = 0xf3;
127 drff->report->field[0]->value[1] = 0x00;
128 drff->report->field[0]->value[2] = 0x00;
129 drff->report->field[0]->value[3] = 0x00;
130 drff->report->field[0]->value[4] = 0x00;
131 drff->report->field[0]->value[5] = 0x00;
132 drff->report->field[0]->value[6] = 0x00;
Benjamin Tissoiresd88142722013-02-25 11:31:46 +0100133 hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300134
Joe Perches4291ee32010-12-09 19:29:03 -0800135 hid_info(hid, "Force Feedback for DragonRise Inc. "
136 "game controllers by Richard Walmsley <richwalm@gmail.com>\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300137
138 return 0;
139}
Jiri Kosina0f6f4312009-05-15 15:46:44 +0200140#else
141static inline int drff_init(struct hid_device *hid)
142{
143 return 0;
144}
145#endif
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300146
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300147/*
148 * The original descriptor of joystick with PID 0x0011, represented by DVTech PC
149 * JS19. It seems both copied from another device and a result of confusion
150 * either about the specification or about the program used to create the
151 * descriptor. In any case, it's a wonder it works on Windows.
152 *
153 * Usage Page (Desktop), ; Generic desktop controls (01h)
Antonio Ospite313726c2016-01-28 18:23:41 +0100154 * Usage (Joystick), ; Joystick (04h, application collection)
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300155 * Collection (Application),
156 * Collection (Logical),
157 * Report Size (8),
158 * Report Count (5),
159 * Logical Minimum (0),
160 * Logical Maximum (255),
161 * Physical Minimum (0),
162 * Physical Maximum (255),
163 * Usage (X), ; X (30h, dynamic value)
164 * Usage (X), ; X (30h, dynamic value)
165 * Usage (X), ; X (30h, dynamic value)
166 * Usage (X), ; X (30h, dynamic value)
167 * Usage (Y), ; Y (31h, dynamic value)
168 * Input (Variable),
169 * Report Size (4),
170 * Report Count (1),
171 * Logical Maximum (7),
172 * Physical Maximum (315),
173 * Unit (Degrees),
174 * Usage (00h),
175 * Input (Variable, Null State),
176 * Unit,
177 * Report Size (1),
178 * Report Count (10),
179 * Logical Maximum (1),
180 * Physical Maximum (1),
181 * Usage Page (Button), ; Button (09h)
182 * Usage Minimum (01h),
183 * Usage Maximum (0Ah),
184 * Input (Variable),
185 * Usage Page (FF00h), ; FF00h, vendor-defined
186 * Report Size (1),
187 * Report Count (10),
188 * Logical Maximum (1),
189 * Physical Maximum (1),
190 * Usage (01h),
191 * Input (Variable),
192 * End Collection,
193 * Collection (Logical),
194 * Report Size (8),
195 * Report Count (4),
196 * Physical Maximum (255),
197 * Logical Maximum (255),
198 * Usage (02h),
199 * Output (Variable),
200 * End Collection,
201 * End Collection
202 */
203
204/* Size of the original descriptor of the PID 0x0011 joystick */
205#define PID0011_RDESC_ORIG_SIZE 101
206
207/* Fixed report descriptor for PID 0x011 joystick */
208static __u8 pid0011_rdesc_fixed[] = {
209 0x05, 0x01, /* Usage Page (Desktop), */
Antonio Ospite313726c2016-01-28 18:23:41 +0100210 0x09, 0x04, /* Usage (Joystick), */
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300211 0xA1, 0x01, /* Collection (Application), */
212 0xA1, 0x02, /* Collection (Logical), */
213 0x14, /* Logical Minimum (0), */
214 0x75, 0x08, /* Report Size (8), */
215 0x95, 0x03, /* Report Count (3), */
216 0x81, 0x01, /* Input (Constant), */
217 0x26, 0xFF, 0x00, /* Logical Maximum (255), */
218 0x95, 0x02, /* Report Count (2), */
219 0x09, 0x30, /* Usage (X), */
220 0x09, 0x31, /* Usage (Y), */
221 0x81, 0x02, /* Input (Variable), */
222 0x75, 0x01, /* Report Size (1), */
223 0x95, 0x04, /* Report Count (4), */
224 0x81, 0x01, /* Input (Constant), */
225 0x25, 0x01, /* Logical Maximum (1), */
226 0x95, 0x0A, /* Report Count (10), */
227 0x05, 0x09, /* Usage Page (Button), */
228 0x19, 0x01, /* Usage Minimum (01h), */
229 0x29, 0x0A, /* Usage Maximum (0Ah), */
230 0x81, 0x02, /* Input (Variable), */
231 0x95, 0x0A, /* Report Count (10), */
232 0x81, 0x01, /* Input (Constant), */
233 0xC0, /* End Collection, */
234 0xC0 /* End Collection */
235};
236
Maciej Zuk18339f52015-09-03 21:46:39 +0200237static __u8 pid0006_rdesc_fixed[] = {
238 0x05, 0x01, /* Usage Page (Generic Desktop) */
239 0x09, 0x04, /* Usage (Joystick) */
240 0xA1, 0x01, /* Collection (Application) */
241 0xA1, 0x02, /* Collection (Logical) */
242 0x75, 0x08, /* Report Size (8) */
243 0x95, 0x05, /* Report Count (5) */
244 0x15, 0x00, /* Logical Minimum (0) */
245 0x26, 0xFF, 0x00, /* Logical Maximum (255) */
246 0x35, 0x00, /* Physical Minimum (0) */
247 0x46, 0xFF, 0x00, /* Physical Maximum (255) */
248 0x09, 0x30, /* Usage (X) */
249 0x09, 0x33, /* Usage (Ry) */
250 0x09, 0x32, /* Usage (Z) */
251 0x09, 0x31, /* Usage (Y) */
252 0x09, 0x34, /* Usage (Ry) */
253 0x81, 0x02, /* Input (Variable) */
254 0x75, 0x04, /* Report Size (4) */
255 0x95, 0x01, /* Report Count (1) */
256 0x25, 0x07, /* Logical Maximum (7) */
257 0x46, 0x3B, 0x01, /* Physical Maximum (315) */
258 0x65, 0x14, /* Unit (Centimeter) */
259 0x09, 0x39, /* Usage (Hat switch) */
260 0x81, 0x42, /* Input (Variable) */
261 0x65, 0x00, /* Unit (None) */
262 0x75, 0x01, /* Report Size (1) */
263 0x95, 0x0C, /* Report Count (12) */
264 0x25, 0x01, /* Logical Maximum (1) */
265 0x45, 0x01, /* Physical Maximum (1) */
266 0x05, 0x09, /* Usage Page (Button) */
267 0x19, 0x01, /* Usage Minimum (0x01) */
268 0x29, 0x0C, /* Usage Maximum (0x0C) */
269 0x81, 0x02, /* Input (Variable) */
270 0x06, 0x00, 0xFF, /* Usage Page (Vendor Defined) */
271 0x75, 0x01, /* Report Size (1) */
272 0x95, 0x08, /* Report Count (8) */
273 0x25, 0x01, /* Logical Maximum (1) */
274 0x45, 0x01, /* Physical Maximum (1) */
275 0x09, 0x01, /* Usage (0x01) */
276 0x81, 0x02, /* Input (Variable) */
277 0xC0, /* End Collection */
278 0xA1, 0x02, /* Collection (Logical) */
279 0x75, 0x08, /* Report Size (8) */
280 0x95, 0x07, /* Report Count (7) */
281 0x46, 0xFF, 0x00, /* Physical Maximum (255) */
282 0x26, 0xFF, 0x00, /* Logical Maximum (255) */
283 0x09, 0x02, /* Usage (0x02) */
284 0x91, 0x02, /* Output (Variable) */
285 0xC0, /* End Collection */
286 0xC0 /* End Collection */
287};
288
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300289static __u8 *dr_report_fixup(struct hid_device *hdev, __u8 *rdesc,
290 unsigned int *rsize)
291{
292 switch (hdev->product) {
293 case 0x0011:
294 if (*rsize == PID0011_RDESC_ORIG_SIZE) {
295 rdesc = pid0011_rdesc_fixed;
296 *rsize = sizeof(pid0011_rdesc_fixed);
297 }
298 break;
Maciej Zuk18339f52015-09-03 21:46:39 +0200299 case 0x0006:
300 if (*rsize == sizeof(pid0006_rdesc_fixed)) {
301 rdesc = pid0006_rdesc_fixed;
302 *rsize = sizeof(pid0006_rdesc_fixed);
303 }
304 break;
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300305 }
306 return rdesc;
307}
308
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300309static int dr_probe(struct hid_device *hdev, const struct hid_device_id *id)
310{
311 int ret;
312
313 dev_dbg(&hdev->dev, "DragonRise Inc. HID hardware probe...");
314
315 ret = hid_parse(hdev);
316 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800317 hid_err(hdev, "parse failed\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300318 goto err;
319 }
320
321 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
322 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800323 hid_err(hdev, "hw start failed\n");
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300324 goto err;
325 }
326
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300327 switch (hdev->product) {
328 case 0x0006:
329 ret = drff_init(hdev);
330 if (ret) {
331 dev_err(&hdev->dev, "force feedback init failed\n");
332 hid_hw_stop(hdev);
333 goto err;
334 }
335 break;
336 }
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300337
338 return 0;
339err:
340 return ret;
341}
342
343static const struct hid_device_id dr_devices[] = {
344 { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006), },
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300345 { HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0011), },
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300346 { }
347};
348MODULE_DEVICE_TABLE(hid, dr_devices);
349
350static struct hid_driver dr_driver = {
351 .name = "dragonrise",
352 .id_table = dr_devices,
Nikolai Kondrashove05eefb2011-01-28 14:50:52 +0300353 .report_fixup = dr_report_fixup,
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300354 .probe = dr_probe,
355};
H Hartley Sweetenf4254582012-12-17 15:28:26 -0700356module_hid_driver(dr_driver);
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300357
Richard Walmsley3f866fb2009-03-04 22:12:04 +1300358MODULE_LICENSE("GPL");