[linux.git] / drivers / hid / hid-sony.c

/*
 *  HID driver for some sony "special" devices
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2005 Vojtech Pavlik <[email protected]>
 *  Copyright (c) 2005 Michael Haboustak <[email protected]> for Concept2, Inc
 *  Copyright (c) 2007 Paul Walmsley
 *  Copyright (c) 2008 Jiri Slaby
 *  Copyright (c) 2006-2008 Jiri Kosina
 */

/*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */

#include <linux/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/usb.h>

#include "hid-ids.h"

#define VAIO_RDESC_CONSTANT     (1 << 0)
#define SIXAXIS_CONTROLLER_USB  (1 << 1)
#define SIXAXIS_CONTROLLER_BT   (1 << 2)

static const u8 sixaxis_rdesc_fixup[] = {
	0x95, 0x13, 0x09, 0x01, 0x81, 0x02, 0x95, 0x0C,
	0x81, 0x01, 0x75, 0x10, 0x95, 0x04, 0x26, 0xFF,
	0x03, 0x46, 0xFF, 0x03, 0x09, 0x01, 0x81, 0x02
};

struct sony_sc {
	unsigned long quirks;
};

/* Sony Vaio VGX has wrongly mouse pointer declared as constant */
static __u8 *sony_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	struct sony_sc *sc = hid_get_drvdata(hdev);

	if ((sc->quirks & VAIO_RDESC_CONSTANT) &&
			*rsize >= 56 && rdesc[54] == 0x81 && rdesc[55] == 0x07) {
		hid_info(hdev, "Fixing up Sony Vaio VGX report descriptor\n");
		rdesc[55] = 0x06;
	}

	/* The HID descriptor exposed over BT has a trailing zero byte */
	if ((((sc->quirks & SIXAXIS_CONTROLLER_USB) && *rsize == 148) ||
			((sc->quirks & SIXAXIS_CONTROLLER_BT) && *rsize == 149)) &&
			rdesc[83] == 0x75) {
		hid_info(hdev, "Fixing up Sony Sixaxis report descriptor\n");
		memcpy((void *)&rdesc[83], (void *)&sixaxis_rdesc_fixup,
			sizeof(sixaxis_rdesc_fixup));
	}
	return rdesc;
}

static int sony_raw_event(struct hid_device *hdev, struct hid_report *report,
		__u8 *rd, int size)
{
	struct sony_sc *sc = hid_get_drvdata(hdev);

	/* Sixaxis HID report has acclerometers/gyro with MSByte first, this
	 * has to be BYTE_SWAPPED before passing up to joystick interface
	 */
	if ((sc->quirks & (SIXAXIS_CONTROLLER_USB | SIXAXIS_CONTROLLER_BT)) &&
			rd[0] == 0x01 && size == 49) {
		swap(rd[41], rd[42]);
		swap(rd[43], rd[44]);
		swap(rd[45], rd[46]);
		swap(rd[47], rd[48]);
	}

	return 0;
}

/*
 * The Sony Sixaxis does not handle HID Output Reports on the Interrupt EP
 * like it should according to usbhid/hid-core.c::usbhid_output_raw_report()
 * so we need to override that forcing HID Output Reports on the Control EP.
 *
 * There is also another issue about HID Output Reports via USB, the Sixaxis
 * does not want the report_id as part of the data packet, so we have to
 * discard buf[0] when sending the actual control message, even for numbered
 * reports, humpf!
 */
static int sixaxis_usb_output_raw_report(struct hid_device *hid, __u8 *buf,
		size_t count, unsigned char report_type)
{
	struct usb_interface *intf = to_usb_interface(hid->dev.parent);
	struct usb_device *dev = interface_to_usbdev(intf);
	struct usb_host_interface *interface = intf->cur_altsetting;
	int report_id = buf[0];
	int ret;

	if (report_type == HID_OUTPUT_REPORT) {
		/* Don't send the Report ID */
		buf++;
		count--;
	}

	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		HID_REQ_SET_REPORT,
		USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		((report_type + 1) << 8) | report_id,
		interface->desc.bInterfaceNumber, buf, count,
		USB_CTRL_SET_TIMEOUT);

	/* Count also the Report ID, in case of an Output report. */
	if (ret > 0 && report_type == HID_OUTPUT_REPORT)
		ret++;

	return ret;
}

/*
 * Sending HID_REQ_GET_REPORT changes the operation mode of the ps3 controller
 * to "operational".  Without this, the ps3 controller will not report any
 * events.
 */
static int sixaxis_set_operational_usb(struct hid_device *hdev)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	struct usb_device *dev = interface_to_usbdev(intf);
	__u16 ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
	int ret;
	char *buf = kmalloc(18, GFP_KERNEL);

	if (!buf)
		return -ENOMEM;

	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
				 HID_REQ_GET_REPORT,
				 USB_DIR_IN | USB_TYPE_CLASS |
				 USB_RECIP_INTERFACE,
				 (3 << 8) | 0xf2, ifnum, buf, 17,
				 USB_CTRL_GET_TIMEOUT);
	if (ret < 0)
		hid_err(hdev, "can't set operational mode\n");

	kfree(buf);

	return ret;
}

static int sixaxis_set_operational_bt(struct hid_device *hdev)
{
	unsigned char buf[] = { 0xf4,  0x42, 0x03, 0x00, 0x00 };
	return hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
}

static int sony_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret;
	unsigned long quirks = id->driver_data;
	struct sony_sc *sc;

	sc = kzalloc(sizeof(*sc), GFP_KERNEL);
	if (sc == NULL) {
		hid_err(hdev, "can't alloc sony descriptor\n");
		return -ENOMEM;
	}

	sc->quirks = quirks;
	hid_set_drvdata(hdev, sc);

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "parse failed\n");
		goto err_free;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT |
			HID_CONNECT_HIDDEV_FORCE);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		goto err_free;
	}

	if (sc->quirks & SIXAXIS_CONTROLLER_USB) {
		hdev->hid_output_raw_report = sixaxis_usb_output_raw_report;
		ret = sixaxis_set_operational_usb(hdev);
	}
	else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
		ret = sixaxis_set_operational_bt(hdev);
	else
		ret = 0;

	if (ret < 0)
		goto err_stop;

	return 0;
err_stop:
	hid_hw_stop(hdev);
err_free:
	kfree(sc);
	return ret;
}

static void sony_remove(struct hid_device *hdev)
{
	hid_hw_stop(hdev);
	kfree(hid_get_drvdata(hdev));
}

static const struct hid_device_id sony_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
		.driver_data = SIXAXIS_CONTROLLER_USB },
	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_NAVIGATION_CONTROLLER),
		.driver_data = SIXAXIS_CONTROLLER_USB },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
		.driver_data = SIXAXIS_CONTROLLER_BT },
	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE),
		.driver_data = VAIO_RDESC_CONSTANT },
	{ }
};
MODULE_DEVICE_TABLE(hid, sony_devices);

static struct hid_driver sony_driver = {
	.name = "sony",
	.id_table = sony_devices,
	.probe = sony_probe,
	.remove = sony_remove,
	.report_fixup = sony_report_fixup,
	.raw_event = sony_raw_event
};

static int __init sony_init(void)
{
	return hid_register_driver(&sony_driver);
}

static void __exit sony_exit(void)
{
	hid_unregister_driver(&sony_driver);
}

module_init(sony_init);
module_exit(sony_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
bd28ce00 JS	1	/*
	2	* HID driver for some sony "special" devices
	3	*
	4	* Copyright (c) 1999 Andreas Gal
	5	* Copyright (c) 2000-2005 Vojtech Pavlik <[email protected]>
	6	* Copyright (c) 2005 Michael Haboustak <[email protected]> for Concept2, Inc
bd28ce00 JS	7	* Copyright (c) 2007 Paul Walmsley
bd28ce00 JS	8	* Copyright (c) 2008 Jiri Slaby
cc6e0bbb	9	* Copyright (c) 2006-2008 Jiri Kosina
bd28ce00 JS	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>
5a0e3ad6	22	#include <linux/slab.h>
bd28ce00 JS	23	#include <linux/usb.h>
	24
	25	#include "hid-ids.h"
	26
816651a7 AO	27	#define VAIO_RDESC_CONSTANT (1 << 0)
	28	#define SIXAXIS_CONTROLLER_USB (1 << 1)
	29	#define SIXAXIS_CONTROLLER_BT (1 << 2)
cc6e0bbb	30
61ab44be SW	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
cc6e0bbb JK	37	struct sony_sc {
	38	unsigned long quirks;
	39	};
	40
	41	/* Sony Vaio VGX has wrongly mouse pointer declared as constant */
73e4008d NK	42	static __u8 sony_report_fixup(struct hid_device hdev, __u8 *rdesc,
73e4008d NK	43	unsigned int *rsize)
cc6e0bbb JK	44	{
	45	struct sony_sc *sc = hid_get_drvdata(hdev);
	46
	47	if ((sc->quirks & VAIO_RDESC_CONSTANT) &&
73e4008d	48	*rsize >= 56 && rdesc[54] == 0x81 && rdesc[55] == 0x07) {
4291ee30	49	hid_info(hdev, "Fixing up Sony Vaio VGX report descriptor\n");
cc6e0bbb JK	50	rdesc[55] = 0x06;
cc6e0bbb JK	51	}
61ab44be SW	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	}
73e4008d	61	return rdesc;
cc6e0bbb JK	62	}
cc6e0bbb JK	63
c9e4d877 SW	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
5710fabf AO	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	*/
569b10a5 AO	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
5710fabf AO	102	if (report_type == HID_OUTPUT_REPORT) {
	103	/* Don't send the Report ID */
	104	buf++;
	105	count--;
	106	}
	107
569b10a5 AO	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
5710fabf AO	115	/* Count also the Report ID, in case of an Output report. */
	116	if (ret > 0 && report_type == HID_OUTPUT_REPORT)
	117	ret++;
	118
569b10a5 AO	119	return ret;
	120	}
	121
bd28ce00 JS	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	*/
816651a7	127	static int sixaxis_set_operational_usb(struct hid_device *hdev)
bd28ce00 JS	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)
4291ee30	145	hid_err(hdev, "can't set operational mode\n");
bd28ce00 JS	146
	147	kfree(buf);
	148
	149	return ret;
	150	}
	151
816651a7	152	static int sixaxis_set_operational_bt(struct hid_device *hdev)
f9ce7c28	153	{
fddb33f2	154	unsigned char buf[] = { 0xf4, 0x42, 0x03, 0x00, 0x00 };
f9ce7c28 BN	155	return hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
	156	}
	157
bd28ce00 JS	158	static int sony_probe(struct hid_device hdev, const struct hid_device_id id)
	159	{
	160	int ret;
cc6e0bbb JK	161	unsigned long quirks = id->driver_data;
	162	struct sony_sc *sc;
	163
	164	sc = kzalloc(sizeof(*sc), GFP_KERNEL);
	165	if (sc == NULL) {
4291ee30	166	hid_err(hdev, "can't alloc sony descriptor\n");
cc6e0bbb JK	167	return -ENOMEM;
	168	}
	169
	170	sc->quirks = quirks;
	171	hid_set_drvdata(hdev, sc);
bd28ce00	172
bd28ce00 JS	173	ret = hid_parse(hdev);
bd28ce00 JS	174	if (ret) {
4291ee30	175	hid_err(hdev, "parse failed\n");
bd28ce00 JS	176	goto err_free;
	177	}
	178
93c10132 JS	179	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT \|
93c10132 JS	180	HID_CONNECT_HIDDEV_FORCE);
bd28ce00	181	if (ret) {
4291ee30	182	hid_err(hdev, "hw start failed\n");
bd28ce00 JS	183	goto err_free;
	184	}
	185
569b10a5 AO	186	if (sc->quirks & SIXAXIS_CONTROLLER_USB) {
569b10a5 AO	187	hdev->hid_output_raw_report = sixaxis_usb_output_raw_report;
816651a7	188	ret = sixaxis_set_operational_usb(hdev);
569b10a5	189	}
816651a7 AO	190	else if (sc->quirks & SIXAXIS_CONTROLLER_BT)
	191	ret = sixaxis_set_operational_bt(hdev);
	192	else
f9ce7c28	193	ret = 0;
f9ce7c28	194
4dfdc464	195	if (ret < 0)
bd28ce00 JS	196	goto err_stop;
	197
	198	return 0;
	199	err_stop:
	200	hid_hw_stop(hdev);
	201	err_free:
cc6e0bbb	202	kfree(sc);
bd28ce00 JS	203	return ret;
	204	}
	205
cc6e0bbb JK	206	static void sony_remove(struct hid_device *hdev)
	207	{
	208	hid_hw_stop(hdev);
	209	kfree(hid_get_drvdata(hdev));
	210	}
	211
bd28ce00	212	static const struct hid_device_id sony_devices[] = {
816651a7 AO	213	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
816651a7 AO	214	.driver_data = SIXAXIS_CONTROLLER_USB },
35dca5b4 JK	215	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_NAVIGATION_CONTROLLER),
35dca5b4 JK	216	.driver_data = SIXAXIS_CONTROLLER_USB },
816651a7 AO	217	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER),
816651a7 AO	218	.driver_data = SIXAXIS_CONTROLLER_BT },
cc6e0bbb JK	219	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_VAIO_VGX_MOUSE),
cc6e0bbb JK	220	.driver_data = VAIO_RDESC_CONSTANT },
bd28ce00 JS	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,
cc6e0bbb JK	229	.remove = sony_remove,
cc6e0bbb JK	230	.report_fixup = sony_report_fixup,
c9e4d877	231	.raw_event = sony_raw_event
bd28ce00 JS	232	};
bd28ce00 JS	233
a24f423b	234	static int __init sony_init(void)
bd28ce00 JS	235	{
	236	return hid_register_driver(&sony_driver);
	237	}
	238
a24f423b	239	static void __exit sony_exit(void)
bd28ce00 JS	240	{
	241	hid_unregister_driver(&sony_driver);
	242	}
	243
	244	module_init(sony_init);
	245	module_exit(sony_exit);
	246	MODULE_LICENSE("GPL");