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

/*
 * Force feedback support for DragonRise Inc. game controllers
 *
 * From what I have gathered, these devices are mass produced in China and are
 * distributed under several vendors. They often share the same design as
 * the original PlayStation DualShock controller.
 *
 * 0079:0006 "DragonRise Inc.   Generic   USB  Joystick  "
 *  - tested with a Tesun USB-703 game controller.
 *
 * Copyright (c) 2009 Richard Walmsley <[email protected]>
 */

/*
 * 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
 */

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

#include "hid-ids.h"

#ifdef CONFIG_DRAGONRISE_FF

struct drff_device {
	struct hid_report *report;
};

static int drff_play(struct input_dev *dev, void *data,
				 struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct drff_device *drff = data;
	int strong, weak;

	strong = effect->u.rumble.strong_magnitude;
	weak = effect->u.rumble.weak_magnitude;

	dbg_hid("called with 0x%04x 0x%04x", strong, weak);

	if (strong || weak) {
		strong = strong * 0xff / 0xffff;
		weak = weak * 0xff / 0xffff;

		/* While reverse engineering this device, I found that when
		   this value is set, it causes the strong rumble to function
		   at a near maximum speed, so we'll bypass it. */
		if (weak == 0x0a)
			weak = 0x0b;

		drff->report->field[0]->value[0] = 0x51;
		drff->report->field[0]->value[1] = 0x00;
		drff->report->field[0]->value[2] = weak;
		drff->report->field[0]->value[4] = strong;
		hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);

		drff->report->field[0]->value[0] = 0xfa;
		drff->report->field[0]->value[1] = 0xfe;
	} else {
		drff->report->field[0]->value[0] = 0xf3;
		drff->report->field[0]->value[1] = 0x00;
	}

	drff->report->field[0]->value[2] = 0x00;
	drff->report->field[0]->value[4] = 0x00;
	dbg_hid("running with 0x%02x 0x%02x", strong, weak);
	hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);

	return 0;
}

static int drff_init(struct hid_device *hid)
{
	struct drff_device *drff;
	struct hid_report *report;
	struct hid_input *hidinput = list_first_entry(&hid->inputs,
						struct hid_input, list);
	struct list_head *report_list =
			&hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct input_dev *dev = hidinput->input;
	int error;

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

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

	if (report->field[0]->report_count < 7) {
		hid_err(hid, "not enough values in the field\n");
		return -ENODEV;
	}

	drff = kzalloc(sizeof(struct drff_device), GFP_KERNEL);
	if (!drff)
		return -ENOMEM;

	set_bit(FF_RUMBLE, dev->ffbit);

	error = input_ff_create_memless(dev, drff, drff_play);
	if (error) {
		kfree(drff);
		return error;
	}

	drff->report = report;
	drff->report->field[0]->value[0] = 0xf3;
	drff->report->field[0]->value[1] = 0x00;
	drff->report->field[0]->value[2] = 0x00;
	drff->report->field[0]->value[3] = 0x00;
	drff->report->field[0]->value[4] = 0x00;
	drff->report->field[0]->value[5] = 0x00;
	drff->report->field[0]->value[6] = 0x00;
	hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);

	hid_info(hid, "Force Feedback for DragonRise Inc. "
		 "game controllers by Richard Walmsley <[email protected]>\n");

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

/*
 * The original descriptor of joystick with PID 0x0011, represented by DVTech PC
 * JS19. It seems both copied from another device and a result of confusion
 * either about the specification or about the program used to create the
 * descriptor. In any case, it's a wonder it works on Windows.
 *
 *  Usage Page (Desktop),             ; Generic desktop controls (01h)
 *  Usage (Joystick),                 ; Joystick (04h, application collection)
 *  Collection (Application),
 *    Collection (Logical),
 *      Report Size (8),
 *      Report Count (5),
 *      Logical Minimum (0),
 *      Logical Maximum (255),
 *      Physical Minimum (0),
 *      Physical Maximum (255),
 *      Usage (X),                    ; X (30h, dynamic value)
 *      Usage (X),                    ; X (30h, dynamic value)
 *      Usage (X),                    ; X (30h, dynamic value)
 *      Usage (X),                    ; X (30h, dynamic value)
 *      Usage (Y),                    ; Y (31h, dynamic value)
 *      Input (Variable),
 *      Report Size (4),
 *      Report Count (1),
 *      Logical Maximum (7),
 *      Physical Maximum (315),
 *      Unit (Degrees),
 *      Usage (00h),
 *      Input (Variable, Null State),
 *      Unit,
 *      Report Size (1),
 *      Report Count (10),
 *      Logical Maximum (1),
 *      Physical Maximum (1),
 *      Usage Page (Button),          ; Button (09h)
 *      Usage Minimum (01h),
 *      Usage Maximum (0Ah),
 *      Input (Variable),
 *      Usage Page (FF00h),           ; FF00h, vendor-defined
 *      Report Size (1),
 *      Report Count (10),
 *      Logical Maximum (1),
 *      Physical Maximum (1),
 *      Usage (01h),
 *      Input (Variable),
 *    End Collection,
 *    Collection (Logical),
 *      Report Size (8),
 *      Report Count (4),
 *      Physical Maximum (255),
 *      Logical Maximum (255),
 *      Usage (02h),
 *      Output (Variable),
 *    End Collection,
 *  End Collection
 */

/* Size of the original descriptor of the PID 0x0011 joystick */
#define PID0011_RDESC_ORIG_SIZE	101

/* Fixed report descriptor for PID 0x011 joystick */
static __u8 pid0011_rdesc_fixed[] = {
	0x05, 0x01,         /*  Usage Page (Desktop),           */
	0x09, 0x04,         /*  Usage (Joystick),               */
	0xA1, 0x01,         /*  Collection (Application),       */
	0xA1, 0x02,         /*      Collection (Logical),       */
	0x14,               /*          Logical Minimum (0),    */
	0x75, 0x08,         /*          Report Size (8),        */
	0x95, 0x03,         /*          Report Count (3),       */
	0x81, 0x01,         /*          Input (Constant),       */
	0x26, 0xFF, 0x00,   /*          Logical Maximum (255),  */
	0x95, 0x02,         /*          Report Count (2),       */
	0x09, 0x30,         /*          Usage (X),              */
	0x09, 0x31,         /*          Usage (Y),              */
	0x81, 0x02,         /*          Input (Variable),       */
	0x75, 0x01,         /*          Report Size (1),        */
	0x95, 0x04,         /*          Report Count (4),       */
	0x81, 0x01,         /*          Input (Constant),       */
	0x25, 0x01,         /*          Logical Maximum (1),    */
	0x95, 0x0A,         /*          Report Count (10),      */
	0x05, 0x09,         /*          Usage Page (Button),    */
	0x19, 0x01,         /*          Usage Minimum (01h),    */
	0x29, 0x0A,         /*          Usage Maximum (0Ah),    */
	0x81, 0x02,         /*          Input (Variable),       */
	0x95, 0x0A,         /*          Report Count (10),      */
	0x81, 0x01,         /*          Input (Constant),       */
	0xC0,               /*      End Collection,             */
	0xC0                /*  End Collection                  */
};

static __u8 *dr_report_fixup(struct hid_device *hdev, __u8 *rdesc,
				unsigned int *rsize)
{
	switch (hdev->product) {
	case 0x0011:
		if (*rsize == PID0011_RDESC_ORIG_SIZE) {
			rdesc = pid0011_rdesc_fixed;
			*rsize = sizeof(pid0011_rdesc_fixed);
		}
		break;
	}
	return rdesc;
}

#define map_abs(c)      hid_map_usage(hi, usage, bit, max, EV_ABS, (c))
#define map_rel(c)      hid_map_usage(hi, usage, bit, max, EV_REL, (c))

static int dr_input_mapping(struct hid_device *hdev, struct hid_input *hi,
			    struct hid_field *field, struct hid_usage *usage,
			    unsigned long **bit, int *max)
{
	switch (usage->hid) {
	/*
	 * revert to the old hid-input behavior where axes
	 * can be randomly assigned when hid->usage is reused.
	 */
	case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
	case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
		if (field->flags & HID_MAIN_ITEM_RELATIVE)
			map_rel(usage->hid & 0xf);
		else
			map_abs(usage->hid & 0xf);
		return 1;
	}

	return 0;
}

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

	dev_dbg(&hdev->dev, "DragonRise Inc. HID hardware probe...");

	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;
	}

	switch (hdev->product) {
	case 0x0006:
		ret = drff_init(hdev);
		if (ret) {
			dev_err(&hdev->dev, "force feedback init failed\n");
			hid_hw_stop(hdev);
			goto err;
		}
		break;
	}

	return 0;
err:
	return ret;
}

static const struct hid_device_id dr_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006),  },
	{ HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0011),  },
	{ }
};
MODULE_DEVICE_TABLE(hid, dr_devices);

static struct hid_driver dr_driver = {
	.name = "dragonrise",
	.id_table = dr_devices,
	.report_fixup = dr_report_fixup,
	.probe = dr_probe,
	.input_mapping = dr_input_mapping,
};
module_hid_driver(dr_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
3f866fbd RW	1	/*
	2	* Force feedback support for DragonRise Inc. game controllers
	3	*
	4	* From what I have gathered, these devices are mass produced in China and are
	5	* distributed under several vendors. They often share the same design as
	6	* the original PlayStation DualShock controller.
	7	*
	8	* 0079:0006 "DragonRise Inc. Generic USB Joystick "
	9	* - tested with a Tesun USB-703 game controller.
	10	*
	11	* Copyright (c) 2009 Richard Walmsley <[email protected]>
	12	*/
	13
	14	/*
	15	* This program is free software; you can redistribute it and/or modify
	16	* it under the terms of the GNU General Public License as published by
	17	* the Free Software Foundation; either version 2 of the License, or
	18	* (at your option) any later version.
	19	*
	20	* This program is distributed in the hope that it will be useful,
	21	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	22	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	23	* GNU General Public License for more details.
	24	*
	25	* You should have received a copy of the GNU General Public License
	26	* along with this program; if not, write to the Free Software
	27	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	28	*/
	29
	30	#include <linux/input.h>
5a0e3ad6	31	#include <linux/slab.h>
3f866fbd	32	#include <linux/hid.h>
8f86a2c3	33	#include <linux/module.h>
3f866fbd RW	34
3f866fbd RW	35	#include "hid-ids.h"
0f6f4319 JK	36
0f6f4319 JK	37	#ifdef CONFIG_DRAGONRISE_FF
3f866fbd RW	38
	39	struct drff_device {
	40	struct hid_report *report;
	41	};
	42
	43	static int drff_play(struct input_dev dev, void data,
	44	struct ff_effect *effect)
	45	{
	46	struct hid_device *hid = input_get_drvdata(dev);
	47	struct drff_device *drff = data;
	48	int strong, weak;
	49
	50	strong = effect->u.rumble.strong_magnitude;
	51	weak = effect->u.rumble.weak_magnitude;
	52
	53	dbg_hid("called with 0x%04x 0x%04x", strong, weak);
	54
	55	if (strong \|\| weak) {
	56	strong = strong * 0xff / 0xffff;
	57	weak = weak * 0xff / 0xffff;
	58
	59	/* While reverse engineering this device, I found that when
	60	this value is set, it causes the strong rumble to function
	61	at a near maximum speed, so we'll bypass it. */
	62	if (weak == 0x0a)
	63	weak = 0x0b;
	64
	65	drff->report->field[0]->value[0] = 0x51;
	66	drff->report->field[0]->value[1] = 0x00;
	67	drff->report->field[0]->value[2] = weak;
	68	drff->report->field[0]->value[4] = strong;
d8814272	69	hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
3f866fbd RW	70
	71	drff->report->field[0]->value[0] = 0xfa;
	72	drff->report->field[0]->value[1] = 0xfe;
	73	} else {
	74	drff->report->field[0]->value[0] = 0xf3;
	75	drff->report->field[0]->value[1] = 0x00;
	76	}
	77
	78	drff->report->field[0]->value[2] = 0x00;
	79	drff->report->field[0]->value[4] = 0x00;
	80	dbg_hid("running with 0x%02x 0x%02x", strong, weak);
d8814272	81	hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
3f866fbd RW	82
	83	return 0;
	84	}
	85
	86	static int drff_init(struct hid_device *hid)
	87	{
	88	struct drff_device *drff;
	89	struct hid_report *report;
	90	struct hid_input *hidinput = list_first_entry(&hid->inputs,
	91	struct hid_input, list);
	92	struct list_head *report_list =
	93	&hid->report_enum[HID_OUTPUT_REPORT].report_list;
	94	struct input_dev *dev = hidinput->input;
	95	int error;
	96
	97	if (list_empty(report_list)) {
4291ee30	98	hid_err(hid, "no output reports found\n");
3f866fbd RW	99	return -ENODEV;
	100	}
	101
	102	report = list_first_entry(report_list, struct hid_report, list);
	103	if (report->maxfield < 1) {
4291ee30	104	hid_err(hid, "no fields in the report\n");
3f866fbd RW	105	return -ENODEV;
	106	}
	107
	108	if (report->field[0]->report_count < 7) {
4291ee30	109	hid_err(hid, "not enough values in the field\n");
3f866fbd RW	110	return -ENODEV;
	111	}
	112
	113	drff = kzalloc(sizeof(struct drff_device), GFP_KERNEL);
	114	if (!drff)
	115	return -ENOMEM;
	116
	117	set_bit(FF_RUMBLE, dev->ffbit);
	118
	119	error = input_ff_create_memless(dev, drff, drff_play);
	120	if (error) {
	121	kfree(drff);
	122	return error;
	123	}
	124
	125	drff->report = report;
	126	drff->report->field[0]->value[0] = 0xf3;
	127	drff->report->field[0]->value[1] = 0x00;
	128	drff->report->field[0]->value[2] = 0x00;
	129	drff->report->field[0]->value[3] = 0x00;
	130	drff->report->field[0]->value[4] = 0x00;
	131	drff->report->field[0]->value[5] = 0x00;
	132	drff->report->field[0]->value[6] = 0x00;
d8814272	133	hid_hw_request(hid, drff->report, HID_REQ_SET_REPORT);
3f866fbd	134
4291ee30 JP	135	hid_info(hid, "Force Feedback for DragonRise Inc. "
4291ee30 JP	136	"game controllers by Richard Walmsley <[email protected]>\n");
3f866fbd RW	137
	138	return 0;
	139	}
0f6f4319 JK	140	#else
	141	static inline int drff_init(struct hid_device *hid)
	142	{
	143	return 0;
	144	}
	145	#endif
3f866fbd	146
e05eefb9 NK	147	/*
	148	* The original descriptor of joystick with PID 0x0011, represented by DVTech PC
	149	* JS19. It seems both copied from another device and a result of confusion
	150	* either about the specification or about the program used to create the
	151	* descriptor. In any case, it's a wonder it works on Windows.
	152	*
	153	* Usage Page (Desktop), ; Generic desktop controls (01h)
313726ca	154	* Usage (Joystick), ; Joystick (04h, application collection)
e05eefb9 NK	155	* Collection (Application),
	156	* Collection (Logical),
	157	* Report Size (8),
	158	* Report Count (5),
	159	* Logical Minimum (0),
	160	* Logical Maximum (255),
	161	* Physical Minimum (0),
	162	* Physical Maximum (255),
	163	* Usage (X), ; X (30h, dynamic value)
	164	* Usage (X), ; X (30h, dynamic value)
	165	* Usage (X), ; X (30h, dynamic value)
	166	* Usage (X), ; X (30h, dynamic value)
	167	* Usage (Y), ; Y (31h, dynamic value)
	168	* Input (Variable),
	169	* Report Size (4),
	170	* Report Count (1),
	171	* Logical Maximum (7),
	172	* Physical Maximum (315),
	173	* Unit (Degrees),
	174	* Usage (00h),
	175	* Input (Variable, Null State),
	176	* Unit,
	177	* Report Size (1),
	178	* Report Count (10),
	179	* Logical Maximum (1),
	180	* Physical Maximum (1),
	181	* Usage Page (Button), ; Button (09h)
	182	* Usage Minimum (01h),
	183	* Usage Maximum (0Ah),
	184	* Input (Variable),
	185	* Usage Page (FF00h), ; FF00h, vendor-defined
	186	* Report Size (1),
	187	* Report Count (10),
	188	* Logical Maximum (1),
	189	* Physical Maximum (1),
	190	* Usage (01h),
	191	* Input (Variable),
	192	* End Collection,
	193	* Collection (Logical),
	194	* Report Size (8),
	195	* Report Count (4),
	196	* Physical Maximum (255),
	197	* Logical Maximum (255),
	198	* Usage (02h),
	199	* Output (Variable),
	200	* End Collection,
	201	* End Collection
	202	*/
	203
	204	/* Size of the original descriptor of the PID 0x0011 joystick */
	205	#define PID0011_RDESC_ORIG_SIZE 101
	206
	207	/* Fixed report descriptor for PID 0x011 joystick */
	208	static __u8 pid0011_rdesc_fixed[] = {
	209	0x05, 0x01, /* Usage Page (Desktop), */
313726ca	210	0x09, 0x04, /* Usage (Joystick), */
e05eefb9 NK	211	0xA1, 0x01, /* Collection (Application), */
	212	0xA1, 0x02, /* Collection (Logical), */
	213	0x14, /* Logical Minimum (0), */
	214	0x75, 0x08, /* Report Size (8), */
	215	0x95, 0x03, /* Report Count (3), */
	216	0x81, 0x01, /* Input (Constant), */
	217	0x26, 0xFF, 0x00, /* Logical Maximum (255), */
	218	0x95, 0x02, /* Report Count (2), */
	219	0x09, 0x30, /* Usage (X), */
	220	0x09, 0x31, /* Usage (Y), */
	221	0x81, 0x02, /* Input (Variable), */
	222	0x75, 0x01, /* Report Size (1), */
	223	0x95, 0x04, /* Report Count (4), */
	224	0x81, 0x01, /* Input (Constant), */
	225	0x25, 0x01, /* Logical Maximum (1), */
	226	0x95, 0x0A, /* Report Count (10), */
	227	0x05, 0x09, /* Usage Page (Button), */
	228	0x19, 0x01, /* Usage Minimum (01h), */
	229	0x29, 0x0A, /* Usage Maximum (0Ah), */
	230	0x81, 0x02, /* Input (Variable), */
	231	0x95, 0x0A, /* Report Count (10), */
	232	0x81, 0x01, /* Input (Constant), */
	233	0xC0, /* End Collection, */
	234	0xC0 /* End Collection */
	235	};
	236
	237	static __u8 dr_report_fixup(struct hid_device hdev, __u8 *rdesc,
	238	unsigned int *rsize)
	239	{
	240	switch (hdev->product) {
	241	case 0x0011:
	242	if (*rsize == PID0011_RDESC_ORIG_SIZE) {
	243	rdesc = pid0011_rdesc_fixed;
	244	*rsize = sizeof(pid0011_rdesc_fixed);
	245	}
	246	break;
	247	}
	248	return rdesc;
	249	}
	250
e1594409 IAR	251	#define map_abs(c) hid_map_usage(hi, usage, bit, max, EV_ABS, (c))
	252	#define map_rel(c) hid_map_usage(hi, usage, bit, max, EV_REL, (c))
	253
	254	static int dr_input_mapping(struct hid_device hdev, struct hid_input hi,
	255	struct hid_field field, struct hid_usage usage,
	256	unsigned long *bit, int max)
	257	{
	258	switch (usage->hid) {
	259	/*
	260	* revert to the old hid-input behavior where axes
	261	* can be randomly assigned when hid->usage is reused.
	262	*/
	263	case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
	264	case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
	265	if (field->flags & HID_MAIN_ITEM_RELATIVE)
	266	map_rel(usage->hid & 0xf);
	267	else
	268	map_abs(usage->hid & 0xf);
	269	return 1;
	270	}
	271
	272	return 0;
	273	}
	274
3f866fbd RW	275	static int dr_probe(struct hid_device hdev, const struct hid_device_id id)
	276	{
	277	int ret;
	278
	279	dev_dbg(&hdev->dev, "DragonRise Inc. HID hardware probe...");
	280
	281	ret = hid_parse(hdev);
	282	if (ret) {
4291ee30	283	hid_err(hdev, "parse failed\n");
3f866fbd RW	284	goto err;
	285	}
	286
	287	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
	288	if (ret) {
4291ee30	289	hid_err(hdev, "hw start failed\n");
3f866fbd RW	290	goto err;
	291	}
	292
e05eefb9 NK	293	switch (hdev->product) {
	294	case 0x0006:
	295	ret = drff_init(hdev);
	296	if (ret) {
	297	dev_err(&hdev->dev, "force feedback init failed\n");
	298	hid_hw_stop(hdev);
	299	goto err;
	300	}
	301	break;
	302	}
3f866fbd RW	303
	304	return 0;
	305	err:
	306	return ret;
	307	}
	308
	309	static const struct hid_device_id dr_devices[] = {
	310	{ HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0006), },
e05eefb9	311	{ HID_USB_DEVICE(USB_VENDOR_ID_DRAGONRISE, 0x0011), },
3f866fbd RW	312	{ }
	313	};
	314	MODULE_DEVICE_TABLE(hid, dr_devices);
	315
	316	static struct hid_driver dr_driver = {
	317	.name = "dragonrise",
	318	.id_table = dr_devices,
e05eefb9	319	.report_fixup = dr_report_fixup,
3f866fbd	320	.probe = dr_probe,
e1594409	321	.input_mapping = dr_input_mapping,
3f866fbd	322	};
f425458e	323	module_hid_driver(dr_driver);
3f866fbd	324
3f866fbd	325	MODULE_LICENSE("GPL");