[mirror_ubuntu-hirsute-kernel.git] / drivers / usb / input / hid-tmff.c

/*
 * Force feedback support for various HID compliant devices by ThrustMaster:
 *    ThrustMaster FireStorm Dual Power 2
 * and possibly others whose device ids haven't been added.
 *
 *  Modified to support ThrustMaster devices by Zinx Verituse
 *  on 2003-01-25 from the Logitech force feedback driver,
 *  which is by Johann Deneux.
 *
 *  Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
 *  Copyright (c) 2002 Johann Deneux
 */

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

#undef DEBUG
#include <linux/usb.h>

#include "hid.h"

/* Usages for thrustmaster devices I know about */
#define THRUSTMASTER_USAGE_RUMBLE_LR	(HID_UP_GENDESK | 0xbb)


struct tmff_device {
	struct hid_report *report;
	struct hid_field *rumble;
};

/* Changes values from 0 to 0xffff into values from minimum to maximum */
static inline int hid_tmff_scale(unsigned int in, int minimum, int maximum)
{
	int ret;

	ret = (in * (maximum - minimum) / 0xffff) + minimum;
	if (ret < minimum)
		return minimum;
	if (ret > maximum)
		return maximum;
	return ret;
}

static int hid_tmff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
{
	struct hid_device *hid = dev->private;
	struct tmff_device *tmff = data;
	int left, right;	/* Rumbling */

	left = hid_tmff_scale(effect->u.rumble.weak_magnitude,
		tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);
	right = hid_tmff_scale(effect->u.rumble.strong_magnitude,
		tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);

	tmff->rumble->value[0] = left;
	tmff->rumble->value[1] = right;
	dbg("(left,right)=(%08x, %08x)", left, right);
	hid_submit_report(hid, tmff->report, USB_DIR_OUT);

	return 0;
}

int hid_tmff_init(struct hid_device *hid)
{
	struct tmff_device *tmff;
	struct list_head *pos;
	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
	struct input_dev *input_dev = hidinput->input;
	int error;

	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
	if (!tmff)
		return -ENOMEM;

	/* Find the report to use */
	__list_for_each(pos, &hid->report_enum[HID_OUTPUT_REPORT].report_list) {
		struct hid_report *report = (struct hid_report *)pos;
		int fieldnum;

		for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
			struct hid_field *field = report->field[fieldnum];

			if (field->maxusage <= 0)
				continue;

			switch (field->usage[0].hid) {
				case THRUSTMASTER_USAGE_RUMBLE_LR:
					if (field->report_count < 2) {
						warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with report_count < 2");
						continue;
					}

					if (field->logical_maximum == field->logical_minimum) {
						warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with logical_maximum == logical_minimum");
						continue;
					}

					if (tmff->report && tmff->report != report) {
						warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR in other report");
						continue;
					}

					if (tmff->rumble && tmff->rumble != field) {
						warn("ignoring duplicate THRUSTMASTER_USAGE_RUMBLE_LR");
						continue;
					}

					tmff->report = report;
					tmff->rumble = field;

					set_bit(FF_RUMBLE, input_dev->ffbit);
					break;

				default:
					warn("ignoring unknown output usage %08x", field->usage[0].hid);
					continue;
			}
		}
	}

	error = input_ff_create_memless(input_dev, tmff, hid_tmff_play);
	if (error) {
		kfree(tmff);
		return error;
	}

	info("Force feedback for ThrustMaster rumble pad devices by Zinx Verituse <zinx@epicsol.org>");

	return 0;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Force feedback support for various HID compliant devices by ThrustMaster:
	3	* ThrustMaster FireStorm Dual Power 2
	4	* and possibly others whose device ids haven't been added.
	5	*
	6	* Modified to support ThrustMaster devices by Zinx Verituse
	7	* on 2003-01-25 from the Logitech force feedback driver,
	8	* which is by Johann Deneux.
	9	*
	10	* Copyright (c) 2003 Zinx Verituse <zinx@epicsol.org>
	11	* Copyright (c) 2002 Johann Deneux
	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>
1da177e4 LT	31
	32	#undef DEBUG
	33	#include <linux/usb.h>
	34
1da177e4	35	#include "hid.h"
1da177e4 LT	36
	37	/* Usages for thrustmaster devices I know about */
	38	#define THRUSTMASTER_USAGE_RUMBLE_LR (HID_UP_GENDESK \| 0xbb)
1da177e4	39
1da177e4 LT	40
1da177e4 LT	41	struct tmff_device {
1da177e4	42	struct hid_report *report;
1da177e4	43	struct hid_field *rumble;
dc76c912	44	};
1da177e4	45
dc76c912 AH	46	/* Changes values from 0 to 0xffff into values from minimum to maximum */
	47	static inline int hid_tmff_scale(unsigned int in, int minimum, int maximum)
	48	{
	49	int ret;
1da177e4	50
dc76c912 AH	51	ret = (in * (maximum - minimum) / 0xffff) + minimum;
	52	if (ret < minimum)
	53	return minimum;
	54	if (ret > maximum)
	55	return maximum;
	56	return ret;
	57	}
1da177e4	58
dc76c912 AH	59	static int hid_tmff_play(struct input_dev dev, void data, struct ff_effect *effect)
	60	{
	61	struct hid_device *hid = dev->private;
	62	struct tmff_device *tmff = data;
	63	int left, right; /* Rumbling */
1da177e4	64
dc76c912 AH	65	left = hid_tmff_scale(effect->u.rumble.weak_magnitude,
	66	tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);
	67	right = hid_tmff_scale(effect->u.rumble.strong_magnitude,
	68	tmff->rumble->logical_minimum, tmff->rumble->logical_maximum);
1da177e4	69
dc76c912 AH	70	tmff->rumble->value[0] = left;
	71	tmff->rumble->value[1] = right;
	72	dbg("(left,right)=(%08x, %08x)", left, right);
	73	hid_submit_report(hid, tmff->report, USB_DIR_OUT);
	74
	75	return 0;
	76	}
1da177e4 LT	77
	78	int hid_tmff_init(struct hid_device *hid)
	79	{
dc76c912	80	struct tmff_device *tmff;
1da177e4 LT	81	struct list_head *pos;
1da177e4 LT	82	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
c5b7c7c3	83	struct input_dev *input_dev = hidinput->input;
dc76c912	84	int error;
1da177e4	85
dc76c912 AH	86	tmff = kzalloc(sizeof(struct tmff_device), GFP_KERNEL);
dc76c912 AH	87	if (!tmff)
1da177e4 LT	88	return -ENOMEM;
1da177e4 LT	89
1da177e4 LT	90	/* Find the report to use */
	91	__list_for_each(pos, &hid->report_enum[HID_OUTPUT_REPORT].report_list) {
	92	struct hid_report report = (struct hid_report )pos;
	93	int fieldnum;
	94
	95	for (fieldnum = 0; fieldnum < report->maxfield; ++fieldnum) {
	96	struct hid_field *field = report->field[fieldnum];
	97
	98	if (field->maxusage <= 0)
	99	continue;
	100
	101	switch (field->usage[0].hid) {
	102	case THRUSTMASTER_USAGE_RUMBLE_LR:
	103	if (field->report_count < 2) {
	104	warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with report_count < 2");
	105	continue;
	106	}
	107
	108	if (field->logical_maximum == field->logical_minimum) {
	109	warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR with logical_maximum == logical_minimum");
	110	continue;
	111	}
	112
dc76c912	113	if (tmff->report && tmff->report != report) {
1da177e4 LT	114	warn("ignoring THRUSTMASTER_USAGE_RUMBLE_LR in other report");
	115	continue;
	116	}
	117
dc76c912	118	if (tmff->rumble && tmff->rumble != field) {
1da177e4 LT	119	warn("ignoring duplicate THRUSTMASTER_USAGE_RUMBLE_LR");
	120	continue;
	121	}
	122
dc76c912 AH	123	tmff->report = report;
dc76c912 AH	124	tmff->rumble = field;
1da177e4	125
c5b7c7c3	126	set_bit(FF_RUMBLE, input_dev->ffbit);
1da177e4 LT	127	break;
	128
	129	default:
	130	warn("ignoring unknown output usage %08x", field->usage[0].hid);
	131	continue;
	132	}
1da177e4 LT	133	}
	134	}
	135
dc76c912 AH	136	error = input_ff_create_memless(input_dev, tmff, hid_tmff_play);
	137	if (error) {
	138	kfree(tmff);
	139	return error;
1da177e4 LT	140	}
1da177e4 LT	141
dc76c912	142	info("Force feedback for ThrustMaster rumble pad devices by Zinx Verituse <zinx@epicsol.org>");
1da177e4	143
1da177e4 LT	144	return 0;
	145	}
	146