xref: /openbmc/linux/drivers/hid/hid-sony.c (revision 95e9fd10)
1 /*
2  *  HID driver for some sony "special" devices
3  *
4  *  Copyright (c) 1999 Andreas Gal
5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7  *  Copyright (c) 2007 Paul Walmsley
8  *  Copyright (c) 2008 Jiri Slaby
9  *  Copyright (c) 2006-2008 Jiri Kosina
10  */
11 
12 /*
13  * This program is free software; you can redistribute it and/or modify it
14  * under the terms of the GNU General Public License as published by the Free
15  * Software Foundation; either version 2 of the License, or (at your option)
16  * any later version.
17  */
18 
19 #include <linux/device.h>
20 #include <linux/hid.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/usb.h>
24 
25 #include "hid-ids.h"
26 
27 #define VAIO_RDESC_CONSTANT     (1 << 0)
28 #define SIXAXIS_CONTROLLER_USB  (1 << 1)
29 #define SIXAXIS_CONTROLLER_BT   (1 << 2)
30 
31 static const u8 sixaxis_rdesc_fixup[] = {
32 	0x95, 0x13, 0x09, 0x01, 0x81, 0x02, 0x95, 0x0C,
33 	0x81, 0x01, 0x75, 0x10, 0x95, 0x04, 0x26, 0xFF,
34 	0x03, 0x46, 0xFF, 0x03, 0x09, 0x01, 0x81, 0x02
35 };
36 
37 struct sony_sc {
38 	unsigned long quirks;
39 };
40 
41 /* Sony Vaio VGX has wrongly mouse pointer declared as constant */
42 static __u8 *sony_report_fixup(struct hid_device *hdev, __u8 *rdesc,
43 		unsigned int *rsize)
44 {
45 	struct sony_sc *sc = hid_get_drvdata(hdev);
46 
47 	if ((sc->quirks & VAIO_RDESC_CONSTANT) &&
48 			*rsize >= 56 && rdesc[54] == 0x81 && rdesc[55] == 0x07) {
49 		hid_info(hdev, "Fixing up Sony Vaio VGX report descriptor\n");
50 		rdesc[55] = 0x06;
51 	}
52 
53 	/* The HID descriptor exposed over BT has a trailing zero byte */
54 	if ((((sc->quirks & SIXAXIS_CONTROLLER_USB) && *rsize == 148) ||
55 			((sc->quirks & SIXAXIS_CONTROLLER_BT) && *rsize == 149)) &&
56 			rdesc[83] == 0x75) {
57 		hid_info(hdev, "Fixing up Sony Sixaxis report descriptor\n");
58 		memcpy((void *)&rdesc[83], (void *)&sixaxis_rdesc_fixup,
59 			sizeof(sixaxis_rdesc_fixup));
60 	}
61 	return rdesc;
62 }
63 
64 static int sony_raw_event(struct hid_device *hdev, struct hid_report *report,
65 		__u8 *rd, int size)
66 {
67 	struct sony_sc *sc = hid_get_drvdata(hdev);
68 
69 	/* Sixaxis HID report has acclerometers/gyro with MSByte first, this
70 	 * has to be BYTE_SWAPPED before passing up to joystick interface
71 	 */
72 	if ((sc->quirks & (SIXAXIS_CONTROLLER_USB | SIXAXIS_CONTROLLER_BT)) &&
73 			rd[0] == 0x01 && size == 49) {
74 		swap(rd[41], rd[42]);
75 		swap(rd[43], rd[44]);
76 		swap(rd[45], rd[46]);
77 		swap(rd[47], rd[48]);
78 	}
79 
80 	return 0;
81 }
82 
83 /*
84  * The Sony Sixaxis does not handle HID Output Reports on the Interrupt EP
85  * like it should according to usbhid/hid-core.c::usbhid_output_raw_report()
86  * so we need to override that forcing HID Output Reports on the Control EP.
87  *
88  * There is also another issue about HID Output Reports via USB, the Sixaxis
89  * does not want the report_id as part of the data packet, so we have to
90  * discard buf[0] when sending the actual control message, even for numbered
91  * reports, humpf!
92  */
93 static int sixaxis_usb_output_raw_report(struct hid_device *hid, __u8 *buf,
94 		size_t count, unsigned char report_type)
95 {
96 	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
97 	struct usb_device *dev = interface_to_usbdev(intf);
98 	struct usb_host_interface *interface = intf->cur_altsetting;
99 	int report_id = buf[0];
100 	int ret;
101 
102 	if (report_type == HID_OUTPUT_REPORT) {
103 		/* Don't send the Report ID */
104 		buf++;
105 		count--;
106 	}
107 
108 	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
109 		HID_REQ_SET_REPORT,
110 		USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
111 		((report_type + 1) << 8) | report_id,
112 		interface->desc.bInterfaceNumber, buf, count,
113 		USB_CTRL_SET_TIMEOUT);
114 
115 	/* Count also the Report ID, in case of an Output report. */
116 	if (ret > 0 && report_type == HID_OUTPUT_REPORT)
117 		ret++;
118 
119 	return ret;
120 }
121 
122 /*
123  * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
124  * to "operational".  Without this, the ps3 controller will not report any
125  * events.
126  */
127 static int sixaxis_set_operational_usb(struct hid_device *hdev)
128 {
129 	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
130 	struct usb_device *dev = interface_to_usbdev(intf);
131 	__u16 ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
132 	int ret;
133 	char *buf = kmalloc(18, GFP_KERNEL);
134 
135 	if (!buf)
136 		return -ENOMEM;
137 
138 	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
139 				 HID_REQ_GET_REPORT,
140 				 USB_DIR_IN | USB_TYPE_CLASS |
141 				 USB_RECIP_INTERFACE,
142 				 (3 << 8) | 0xf2, ifnum, buf, 17,
143 				 USB_CTRL_GET_TIMEOUT);
144 	if (ret < 0)
145 		hid_err(hdev, "can't set operational mode\n");
146 
147 	kfree(buf);
148 
149 	return ret;
150 }
151 
152 static int sixaxis_set_operational_bt(struct hid_device *hdev)
153 {
154 	unsigned char buf[] = { 0xf4,  0x42, 0x03, 0x00, 0x00 };
155 	return hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
156 }
157 
158 static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
159 {
160 	int ret;
161 	unsigned long quirks = id->driver_data;
162 	struct sony_sc *sc;
163 
164 	sc = kzalloc(sizeof(*sc), GFP_KERNEL);
165 	if (sc == NULL) {
166 		hid_err(hdev, "can't alloc sony descriptor\n");
167 		return -ENOMEM;
168 	}
169 
170 	sc->quirks = quirks;
171 	hid_set_drvdata(hdev, sc);
172 
173 	ret = hid_parse(hdev);
174 	if (ret) {
175 		hid_err(hdev, "parse failed\n");
176 		goto err_free;
177 	}
178 
179 	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT |
180 			HID_CONNECT_HIDDEV_FORCE);
181 	if (ret) {
182 		hid_err(hdev, "hw start failed\n");
183 		goto err_free;
184 	}
185 
186 	if (sc->quirks & SIXAXIS_CONTROLLER_USB) {
187 		hdev->hid_output_raw_report = sixaxis_usb_output_raw_report;
188 		ret = sixaxis_set_operational_usb(hdev);
189 	}
190 	else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
191 		ret = sixaxis_set_operational_bt(hdev);
192 	else
193 		ret = 0;
194 
195 	if (ret < 0)
196 		goto err_stop;
197 
198 	return 0;
199 err_stop:
200 	hid_hw_stop(hdev);
201 err_free:
202 	kfree(sc);
203 	return ret;
204 }
205 
206 static void sony_remove(struct hid_device *hdev)
207 {
208 	hid_hw_stop(hdev);
209 	kfree(hid_get_drvdata(hdev));
210 }
211 
212 static const struct hid_device_id sony_devices[] = {
213 	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
214 		.driver_data = SIXAXIS_CONTROLLER_USB },
215 	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_NAVIGATION_CONTROLLER),
216 		.driver_data = SIXAXIS_CONTROLLER_USB },
217 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
218 		.driver_data = SIXAXIS_CONTROLLER_BT },
219 	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE),
220 		.driver_data = VAIO_RDESC_CONSTANT },
221 	{ }
222 };
223 MODULE_DEVICE_TABLE(hid, sony_devices);
224 
225 static struct hid_driver sony_driver = {
226 	.name = "sony",
227 	.id_table = sony_devices,
228 	.probe = sony_probe,
229 	.remove = sony_remove,
230 	.report_fixup = sony_report_fixup,
231 	.raw_event = sony_raw_event
232 };
233 
234 static int __init sony_init(void)
235 {
236 	return hid_register_driver(&sony_driver);
237 }
238 
239 static void __exit sony_exit(void)
240 {
241 	hid_unregister_driver(&sony_driver);
242 }
243 
244 module_init(sony_init);
245 module_exit(sony_exit);
246 MODULE_LICENSE("GPL");
247