xref: /openbmc/linux/drivers/hid/hid-pl.c (revision 97da55fc)
1 /*
2  *  Force feedback support for PantherLord/GreenAsia based devices
3  *
4  *  The devices are distributed under various names and the same USB device ID
5  *  can be used in both adapters and actual game controllers.
6  *
7  *  0810:0001 "Twin USB Joystick"
8  *   - tested with PantherLord USB/PS2 2in1 Adapter
9  *   - contains two reports, one for each port (HID_QUIRK_MULTI_INPUT)
10  *
11  *  0e8f:0003 "GreenAsia Inc.    USB Joystick     "
12  *   - tested with König Gaming gamepad
13  *
14  *  0e8f:0003 "GASIA USB Gamepad"
15  *   - another version of the König gamepad
16  *
17  *  0f30:0111 "Saitek Color Rumble Pad"
18  *
19  *  Copyright (c) 2007, 2009 Anssi Hannula <anssi.hannula@gmail.com>
20  */
21 
22 /*
23  * This program is free software; you can redistribute it and/or modify
24  * it under the terms of the GNU General Public License as published by
25  * the Free Software Foundation; either version 2 of the License, or
26  * (at your option) any later version.
27  *
28  * This program is distributed in the hope that it will be useful,
29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
31  * GNU General Public License for more details.
32  *
33  * You should have received a copy of the GNU General Public License
34  * along with this program; if not, write to the Free Software
35  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
36  */
37 
38 
39 /* #define DEBUG */
40 
41 #define debug(format, arg...) pr_debug("hid-plff: " format "\n" , ## arg)
42 
43 #include <linux/input.h>
44 #include <linux/slab.h>
45 #include <linux/module.h>
46 #include <linux/usb.h>
47 #include <linux/hid.h>
48 
49 #include "hid-ids.h"
50 
51 #ifdef CONFIG_PANTHERLORD_FF
52 #include "usbhid/usbhid.h"
53 
54 struct plff_device {
55 	struct hid_report *report;
56 	s32 maxval;
57 	s32 *strong;
58 	s32 *weak;
59 };
60 
61 static int hid_plff_play(struct input_dev *dev, void *data,
62 			 struct ff_effect *effect)
63 {
64 	struct hid_device *hid = input_get_drvdata(dev);
65 	struct plff_device *plff = data;
66 	int left, right;
67 
68 	left = effect->u.rumble.strong_magnitude;
69 	right = effect->u.rumble.weak_magnitude;
70 	debug("called with 0x%04x 0x%04x", left, right);
71 
72 	left = left * plff->maxval / 0xffff;
73 	right = right * plff->maxval / 0xffff;
74 
75 	*plff->strong = left;
76 	*plff->weak = right;
77 	debug("running with 0x%02x 0x%02x", left, right);
78 	usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
79 
80 	return 0;
81 }
82 
83 static int plff_init(struct hid_device *hid)
84 {
85 	struct plff_device *plff;
86 	struct hid_report *report;
87 	struct hid_input *hidinput;
88 	struct list_head *report_list =
89 			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
90 	struct list_head *report_ptr = report_list;
91 	struct input_dev *dev;
92 	int error;
93 	s32 maxval;
94 	s32 *strong;
95 	s32 *weak;
96 
97 	/* The device contains one output report per physical device, all
98 	   containing 1 field, which contains 4 ff00.0002 usages and 4 16bit
99 	   absolute values.
100 
101 	   The input reports also contain a field which contains
102 	   8 ff00.0001 usages and 8 boolean values. Their meaning is
103 	   currently unknown.
104 
105 	   A version of the 0e8f:0003 exists that has all the values in
106 	   separate fields and misses the extra input field, thus resembling
107 	   Zeroplus (hid-zpff) devices.
108 	*/
109 
110 	if (list_empty(report_list)) {
111 		hid_err(hid, "no output reports found\n");
112 		return -ENODEV;
113 	}
114 
115 	list_for_each_entry(hidinput, &hid->inputs, list) {
116 
117 		report_ptr = report_ptr->next;
118 
119 		if (report_ptr == report_list) {
120 			hid_err(hid, "required output report is missing\n");
121 			return -ENODEV;
122 		}
123 
124 		report = list_entry(report_ptr, struct hid_report, list);
125 		if (report->maxfield < 1) {
126 			hid_err(hid, "no fields in the report\n");
127 			return -ENODEV;
128 		}
129 
130 		maxval = 0x7f;
131 		if (report->field[0]->report_count >= 4) {
132 			report->field[0]->value[0] = 0x00;
133 			report->field[0]->value[1] = 0x00;
134 			strong = &report->field[0]->value[2];
135 			weak = &report->field[0]->value[3];
136 			debug("detected single-field device");
137 		} else if (report->maxfield >= 4 && report->field[0]->maxusage == 1 &&
138 				report->field[0]->usage[0].hid == (HID_UP_LED | 0x43)) {
139 			report->field[0]->value[0] = 0x00;
140 			report->field[1]->value[0] = 0x00;
141 			strong = &report->field[2]->value[0];
142 			weak = &report->field[3]->value[0];
143 			if (hid->vendor == USB_VENDOR_ID_JESS2)
144 				maxval = 0xff;
145 			debug("detected 4-field device");
146 		} else {
147 			hid_err(hid, "not enough fields or values\n");
148 			return -ENODEV;
149 		}
150 
151 		plff = kzalloc(sizeof(struct plff_device), GFP_KERNEL);
152 		if (!plff)
153 			return -ENOMEM;
154 
155 		dev = hidinput->input;
156 
157 		set_bit(FF_RUMBLE, dev->ffbit);
158 
159 		error = input_ff_create_memless(dev, plff, hid_plff_play);
160 		if (error) {
161 			kfree(plff);
162 			return error;
163 		}
164 
165 		plff->report = report;
166 		plff->strong = strong;
167 		plff->weak = weak;
168 		plff->maxval = maxval;
169 
170 		*strong = 0x00;
171 		*weak = 0x00;
172 		usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
173 	}
174 
175 	hid_info(hid, "Force feedback for PantherLord/GreenAsia devices by Anssi Hannula <anssi.hannula@gmail.com>\n");
176 
177 	return 0;
178 }
179 #else
180 static inline int plff_init(struct hid_device *hid)
181 {
182 	return 0;
183 }
184 #endif
185 
186 static int pl_probe(struct hid_device *hdev, const struct hid_device_id *id)
187 {
188 	int ret;
189 
190 	if (id->driver_data)
191 		hdev->quirks |= HID_QUIRK_MULTI_INPUT;
192 
193 	ret = hid_parse(hdev);
194 	if (ret) {
195 		hid_err(hdev, "parse failed\n");
196 		goto err;
197 	}
198 
199 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
200 	if (ret) {
201 		hid_err(hdev, "hw start failed\n");
202 		goto err;
203 	}
204 
205 	plff_init(hdev);
206 
207 	return 0;
208 err:
209 	return ret;
210 }
211 
212 static const struct hid_device_id pl_devices[] = {
213 	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR),
214 		.driver_data = 1 }, /* Twin USB Joystick */
215 	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR),
216 		.driver_data = 1 }, /* Twin USB Joystick */
217 	{ HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003), },
218 	{ HID_USB_DEVICE(USB_VENDOR_ID_JESS2, USB_DEVICE_ID_JESS2_COLOR_RUMBLE_PAD), },
219 	{ }
220 };
221 MODULE_DEVICE_TABLE(hid, pl_devices);
222 
223 static struct hid_driver pl_driver = {
224 	.name = "pantherlord",
225 	.id_table = pl_devices,
226 	.probe = pl_probe,
227 };
228 module_hid_driver(pl_driver);
229 
230 MODULE_LICENSE("GPL");
231