[deliverable/linux.git] / drivers / hid / hid-pl.c

/*
 *  Force feedback support for PantherLord/GreenAsia based devices
 *
 *  The devices are distributed under various names and the same USB device ID
 *  can be used in both adapters and actual game controllers.
 *
 *  0810:0001 "Twin USB Joystick"
 *   - tested with PantherLord USB/PS2 2in1 Adapter
 *   - contains two reports, one for each port (HID_QUIRK_MULTI_INPUT)
 *
 *  0e8f:0003 "GreenAsia Inc.    USB Joystick     "
 *   - tested with König Gaming gamepad
 *
 *  0e8f:0003 "GASIA USB Gamepad"
 *   - another version of the König gamepad
 *
 *  0f30:0111 "Saitek Color Rumble Pad"
 *
 *  Copyright (c) 2007, 2009 Anssi Hannula <anssi.hannula@gmail.com>
 */

/*
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */


/* #define DEBUG */

#define debug(format, arg...) pr_debug("hid-plff: " format "\n" , ## arg)

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

#include "hid-ids.h"

#ifdef CONFIG_PANTHERLORD_FF
#include "usbhid/usbhid.h"

struct plff_device {
	struct hid_report *report;
	s32 maxval;
	s32 *strong;
	s32 *weak;
};

static int hid_plff_play(struct input_dev *dev, void *data,
			 struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct plff_device *plff = data;
	int left, right;

	left = effect->u.rumble.strong_magnitude;
	right = effect->u.rumble.weak_magnitude;
	debug("called with 0x%04x 0x%04x", left, right);

	left = left * plff->maxval / 0xffff;
	right = right * plff->maxval / 0xffff;

	*plff->strong = left;
	*plff->weak = right;
	debug("running with 0x%02x 0x%02x", left, right);
	usbhid_submit_report(hid, plff->report, USB_DIR_OUT);

	return 0;
}

static int plff_init(struct hid_device *hid)
{
	struct plff_device *plff;
	struct hid_report *report;
	struct hid_input *hidinput;
	struct list_head *report_list =
			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct list_head *report_ptr = report_list;
	struct input_dev *dev;
	int error;
	s32 maxval;
	s32 *strong;
	s32 *weak;

	/* The device contains one output report per physical device, all
	   containing 1 field, which contains 4 ff00.0002 usages and 4 16bit
	   absolute values.

	   The input reports also contain a field which contains
	   8 ff00.0001 usages and 8 boolean values. Their meaning is
	   currently unknown.
	   
	   A version of the 0e8f:0003 exists that has all the values in
	   separate fields and misses the extra input field, thus resembling
	   Zeroplus (hid-zpff) devices.
	*/

	if (list_empty(report_list)) {
		hid_err(hid, "no output reports found\n");
		return -ENODEV;
	}

	list_for_each_entry(hidinput, &hid->inputs, list) {

		report_ptr = report_ptr->next;

		if (report_ptr == report_list) {
			hid_err(hid, "required output report is missing\n");
			return -ENODEV;
		}

		report = list_entry(report_ptr, struct hid_report, list);
		if (report->maxfield < 1) {
			hid_err(hid, "no fields in the report\n");
			return -ENODEV;
		}

		maxval = 0x7f;
		if (report->field[0]->report_count >= 4) {
			report->field[0]->value[0] = 0x00;
			report->field[0]->value[1] = 0x00;
			strong = &report->field[0]->value[2];
			weak = &report->field[0]->value[3];
			debug("detected single-field device");
		} else if (report->maxfield >= 4 && report->field[0]->maxusage == 1 &&
				report->field[0]->usage[0].hid == (HID_UP_LED | 0x43)) {
			report->field[0]->value[0] = 0x00;
			report->field[1]->value[0] = 0x00;
			strong = &report->field[2]->value[0];
			weak = &report->field[3]->value[0];
			if (hid->vendor == USB_VENDOR_ID_JESS2)
				maxval = 0xff;
			debug("detected 4-field device");
		} else {
			hid_err(hid, "not enough fields or values\n");
			return -ENODEV;
		}

		plff = kzalloc(sizeof(struct plff_device), GFP_KERNEL);
		if (!plff)
			return -ENOMEM;

		dev = hidinput->input;

		set_bit(FF_RUMBLE, dev->ffbit);

		error = input_ff_create_memless(dev, plff, hid_plff_play);
		if (error) {
			kfree(plff);
			return error;
		}

		plff->report = report;
		plff->strong = strong;
		plff->weak = weak;
		plff->maxval = maxval;

		*strong = 0x00;
		*weak = 0x00;
		usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
	}

	hid_info(hid, "Force feedback for PantherLord/GreenAsia devices by Anssi Hannula <anssi.hannula@gmail.com>\n");

	return 0;
}
#else
static inline int plff_init(struct hid_device *hid)
{
	return 0;
}
#endif

static int pl_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret;

	if (id->driver_data)
		hdev->quirks |= HID_QUIRK_MULTI_INPUT;

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

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		goto err;
	}

	plff_init(hdev);

	return 0;
err:
	return ret;
}

static const struct hid_device_id pl_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR),
		.driver_data = 1 }, /* Twin USB Joystick */
	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR),
		.driver_data = 1 }, /* Twin USB Joystick */
	{ HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003), },
	{ HID_USB_DEVICE(USB_VENDOR_ID_JESS2, USB_DEVICE_ID_JESS2_COLOR_RUMBLE_PAD), },
	{ }
};
MODULE_DEVICE_TABLE(hid, pl_devices);

static struct hid_driver pl_driver = {
	.name = "pantherlord",
	.id_table = pl_devices,
	.probe = pl_probe,
};
module_hid_driver(pl_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
20eb1279	1	/*
5edc41ee AH	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 "
d36b6910	12	* - tested with König Gaming gamepad
20eb1279	13	*
27a9c179	14	* 0e8f:0003 "GASIA USB Gamepad"
d36b6910	15	* - another version of the König gamepad
27a9c179	16	*
aaca9cc0 MK	17	* 0f30:0111 "Saitek Color Rumble Pad"
aaca9cc0 MK	18	*
27a9c179	19	* Copyright (c) 2007, 2009 Anssi Hannula <anssi.hannula@gmail.com>
20eb1279 AH	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>
5a0e3ad6	44	#include <linux/slab.h>
8f86a2c3	45	#include <linux/module.h>
20eb1279 AH	46	#include <linux/usb.h>
20eb1279 AH	47	#include <linux/hid.h>
5f022298 JS	48
	49	#include "hid-ids.h"
	50
	51	#ifdef CONFIG_PANTHERLORD_FF
	52	#include "usbhid/usbhid.h"
20eb1279 AH	53
	54	struct plff_device {
	55	struct hid_report *report;
aaca9cc0	56	s32 maxval;
27a9c179 AH	57	s32 *strong;
27a9c179 AH	58	s32 *weak;
20eb1279 AH	59	};
	60
	61	static int hid_plff_play(struct input_dev dev, void data,
	62	struct ff_effect *effect)
	63	{
e0712985	64	struct hid_device *hid = input_get_drvdata(dev);
20eb1279 AH	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
aaca9cc0 MK	72	left = left * plff->maxval / 0xffff;
aaca9cc0 MK	73	right = right * plff->maxval / 0xffff;
20eb1279	74
27a9c179 AH	75	*plff->strong = left;
27a9c179 AH	76	*plff->weak = right;
20eb1279 AH	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
5f022298	83	static int plff_init(struct hid_device *hid)
20eb1279 AH	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;
aaca9cc0	93	s32 maxval;
27a9c179 AH	94	s32 *strong;
27a9c179 AH	95	s32 *weak;
20eb1279	96
5edc41ee AH	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.
20eb1279	100
5edc41ee	101	The input reports also contain a field which contains
20eb1279	102	8 ff00.0001 usages and 8 boolean values. Their meaning is
27a9c179 AH	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	*/
20eb1279 AH	109
20eb1279 AH	110	if (list_empty(report_list)) {
4291ee30	111	hid_err(hid, "no output reports found\n");
20eb1279 AH	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) {
4291ee30	120	hid_err(hid, "required output report is missing\n");
20eb1279 AH	121	return -ENODEV;
	122	}
	123
	124	report = list_entry(report_ptr, struct hid_report, list);
	125	if (report->maxfield < 1) {
4291ee30	126	hid_err(hid, "no fields in the report\n");
20eb1279 AH	127	return -ENODEV;
	128	}
	129
aaca9cc0	130	maxval = 0x7f;
27a9c179 AH	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];
aaca9cc0 MK	143	if (hid->vendor == USB_VENDOR_ID_JESS2)
aaca9cc0 MK	144	maxval = 0xff;
27a9c179 AH	145	debug("detected 4-field device");
27a9c179 AH	146	} else {
4291ee30	147	hid_err(hid, "not enough fields or values\n");
20eb1279 AH	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;
27a9c179 AH	166	plff->strong = strong;
27a9c179 AH	167	plff->weak = weak;
aaca9cc0	168	plff->maxval = maxval;
27a9c179 AH	169
	170	*strong = 0x00;
	171	*weak = 0x00;
20eb1279 AH	172	usbhid_submit_report(hid, plff->report, USB_DIR_OUT);
	173	}
	174
4291ee30	175	hid_info(hid, "Force feedback for PantherLord/GreenAsia devices by Anssi Hannula <anssi.hannula@gmail.com>\n");
20eb1279 AH	176
	177	return 0;
	178	}
5f022298 JS	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) {
4291ee30	195	hid_err(hdev, "parse failed\n");
5f022298 JS	196	goto err;
	197	}
	198
	199	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	200	if (ret) {
4291ee30	201	hid_err(hdev, "hw start failed\n");
5f022298 JS	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 */
578f3a35 JK	215	{ HID_USB_DEVICE(USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PCS_ADAPTOR),
578f3a35 JK	216	.driver_data = 1 }, /* Twin USB Joystick */
27a9c179	217	{ HID_USB_DEVICE(USB_VENDOR_ID_GREENASIA, 0x0003), },
aaca9cc0	218	{ HID_USB_DEVICE(USB_VENDOR_ID_JESS2, USB_DEVICE_ID_JESS2_COLOR_RUMBLE_PAD), },
5f022298 JS	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	};
f425458e	228	module_hid_driver(pl_driver);
5f022298	229
5f022298	230	MODULE_LICENSE("GPL");