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