[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / hid / hid-lg4ff.c

/*
 *  Force feedback support for Logitech Speed Force Wireless
 *
 *  http://wiibrew.org/wiki/Logitech_USB_steering_wheel
 *
 *  Copyright (c) 2010 Simon Wood <simon@mungewell.org>
 */

/*
 * 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/usb.h>
#include <linux/hid.h>

#include "usbhid/usbhid.h"
#include "hid-lg.h"
#include "hid-ids.h"

#define DFGT_REV_MAJ 0x13
#define DFGT_REV_MIN 0x22
#define DFP_REV_MAJ 0x11
#define DFP_REV_MIN 0x06
#define FFEX_REV_MAJ 0x21
#define FFEX_REV_MIN 0x00
#define G25_REV_MAJ 0x12
#define G25_REV_MIN 0x22
#define G27_REV_MAJ 0x12
#define G27_REV_MIN 0x38

#define to_hid_device(pdev) container_of(pdev, struct hid_device, dev)

static void hid_lg4ff_set_range_dfp(struct hid_device *hid, u16 range);
static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range);
static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr, char *buf);
static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count);

static DEVICE_ATTR(range, S_IRWXU | S_IRWXG | S_IRWXO, lg4ff_range_show, lg4ff_range_store);

static bool list_inited;

struct lg4ff_device_entry {
	char  *device_id;	/* Use name in respective kobject structure's address as the ID */
	__u16 range;
	__u16 min_range;
	__u16 max_range;
	__u8  leds;
	struct list_head list;
	void (*set_range)(struct hid_device *hid, u16 range);
};

static struct lg4ff_device_entry device_list;

static const signed short lg4ff_wheel_effects[] = {
	FF_CONSTANT,
	FF_AUTOCENTER,
	-1
};

struct lg4ff_wheel {
	const __u32 product_id;
	const signed short *ff_effects;
	const __u16 min_range;
	const __u16 max_range;
	void (*set_range)(struct hid_device *hid, u16 range);
};

static const struct lg4ff_wheel lg4ff_devices[] = {
	{USB_DEVICE_ID_LOGITECH_WHEEL,       lg4ff_wheel_effects, 40, 270, NULL},
	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL,  lg4ff_wheel_effects, 40, 270, NULL},
	{USB_DEVICE_ID_LOGITECH_DFP_WHEEL,   lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_dfp},
	{USB_DEVICE_ID_LOGITECH_G25_WHEEL,   lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	{USB_DEVICE_ID_LOGITECH_DFGT_WHEEL,  lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	{USB_DEVICE_ID_LOGITECH_G27_WHEEL,   lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2, lg4ff_wheel_effects, 40, 270, NULL},
	{USB_DEVICE_ID_LOGITECH_WII_WHEEL,   lg4ff_wheel_effects, 40, 270, NULL}
};

struct lg4ff_native_cmd {
	const __u8 cmd_num;	/* Number of commands to send */
	const __u8 cmd[];
};

struct lg4ff_usb_revision {
	const __u16 rev_maj;
	const __u16 rev_min;
	const struct lg4ff_native_cmd *command;
};

static const struct lg4ff_native_cmd native_dfp = {
	1,
	{0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
};

static const struct lg4ff_native_cmd native_dfgt = {
	2,
	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* 1st command */
	 0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00}	/* 2nd command */
};

static const struct lg4ff_native_cmd native_g25 = {
	1,
	{0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
};

static const struct lg4ff_native_cmd native_g27 = {
	2,
	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00,	/* 1st command */
	 0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00}	/* 2nd command */
};

static const struct lg4ff_usb_revision lg4ff_revs[] = {
	{DFGT_REV_MAJ, DFGT_REV_MIN, &native_dfgt},	/* Driving Force GT */
	{DFP_REV_MAJ,  DFP_REV_MIN,  &native_dfp},	/* Driving Force Pro */
	{G25_REV_MAJ,  G25_REV_MIN,  &native_g25},	/* G25 */
	{G27_REV_MAJ,  G27_REV_MIN,  &native_g27},	/* G27 */
};

static int hid_lg4ff_play(struct input_dev *dev, void *data, struct ff_effect *effect)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	int x;

#define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff

	switch (effect->type) {
	case FF_CONSTANT:
		x = effect->u.ramp.start_level + 0x80;	/* 0x80 is no force */
		CLAMP(x);
		report->field[0]->value[0] = 0x11;	/* Slot 1 */
		report->field[0]->value[1] = 0x08;
		report->field[0]->value[2] = x;
		report->field[0]->value[3] = 0x80;
		report->field[0]->value[4] = 0x00;
		report->field[0]->value[5] = 0x00;
		report->field[0]->value[6] = 0x00;

		usbhid_submit_report(hid, report, USB_DIR_OUT);
		break;
	}
	return 0;
}

/* Sends default autocentering command compatible with
 * all wheels except Formula Force EX */
static void hid_lg4ff_set_autocenter_default(struct input_dev *dev, u16 magnitude)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);

	report->field[0]->value[0] = 0xfe;
	report->field[0]->value[1] = 0x0d;
	report->field[0]->value[2] = magnitude >> 13;
	report->field[0]->value[3] = magnitude >> 13;
	report->field[0]->value[4] = magnitude >> 8;
	report->field[0]->value[5] = 0x00;
	report->field[0]->value[6] = 0x00;

	usbhid_submit_report(hid, report, USB_DIR_OUT);
}

/* Sends autocentering command compatible with Formula Force EX */
static void hid_lg4ff_set_autocenter_ffex(struct input_dev *dev, u16 magnitude)
{
	struct hid_device *hid = input_get_drvdata(dev);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	magnitude = magnitude * 90 / 65535;
	

	report->field[0]->value[0] = 0xfe;
	report->field[0]->value[1] = 0x03;
	report->field[0]->value[2] = magnitude >> 14;
	report->field[0]->value[3] = magnitude >> 14;
	report->field[0]->value[4] = magnitude;
	report->field[0]->value[5] = 0x00;
	report->field[0]->value[6] = 0x00;

	usbhid_submit_report(hid, report, USB_DIR_OUT);
}

/* Sends command to set range compatible with G25/G27/Driving Force GT */
static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range)
{
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	dbg_hid("G25/G27/DFGT: setting range to %u\n", range);

	report->field[0]->value[0] = 0xf8;
	report->field[0]->value[1] = 0x81;
	report->field[0]->value[2] = range & 0x00ff;
	report->field[0]->value[3] = (range & 0xff00) >> 8;
	report->field[0]->value[4] = 0x00;
	report->field[0]->value[5] = 0x00;
	report->field[0]->value[6] = 0x00;

	usbhid_submit_report(hid, report, USB_DIR_OUT);
}

/* Sends commands to set range compatible with Driving Force Pro wheel */
static void hid_lg4ff_set_range_dfp(struct hid_device *hid, __u16 range)
{
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	int start_left, start_right, full_range;
	dbg_hid("Driving Force Pro: setting range to %u\n", range);

	/* Prepare "coarse" limit command */
	report->field[0]->value[0] = 0xf8;
	report->field[0]->value[1] = 0x00; 	/* Set later */
	report->field[0]->value[2] = 0x00;
	report->field[0]->value[3] = 0x00;
	report->field[0]->value[4] = 0x00;
	report->field[0]->value[5] = 0x00;
	report->field[0]->value[6] = 0x00;

	if (range > 200) {
		report->field[0]->value[1] = 0x03;
		full_range = 900;
	} else {
		report->field[0]->value[1] = 0x02;
		full_range = 200;
	}
	usbhid_submit_report(hid, report, USB_DIR_OUT);

	/* Prepare "fine" limit command */
	report->field[0]->value[0] = 0x81;
	report->field[0]->value[1] = 0x0b;
	report->field[0]->value[2] = 0x00;
	report->field[0]->value[3] = 0x00;
	report->field[0]->value[4] = 0x00;
	report->field[0]->value[5] = 0x00;
	report->field[0]->value[6] = 0x00;

	if (range == 200 || range == 900) {	/* Do not apply any fine limit */
		usbhid_submit_report(hid, report, USB_DIR_OUT);
		return;
	}

	/* Construct fine limit command */
	start_left = (((full_range - range + 1) * 2047) / full_range);
	start_right = 0xfff - start_left;

	report->field[0]->value[2] = start_left >> 4;
	report->field[0]->value[3] = start_right >> 4;
	report->field[0]->value[4] = 0xff;
	report->field[0]->value[5] = (start_right & 0xe) << 4 | (start_left & 0xe);
	report->field[0]->value[6] = 0xff;

	usbhid_submit_report(hid, report, USB_DIR_OUT);
}

static void hid_lg4ff_switch_native(struct hid_device *hid, const struct lg4ff_native_cmd *cmd)
{
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	__u8 i, j;

	j = 0;
	while (j < 7*cmd->cmd_num) {
		for (i = 0; i < 7; i++)
			report->field[0]->value[i] = cmd->cmd[j++];

		usbhid_submit_report(hid, report, USB_DIR_OUT);
	}
}

/* Read current range and display it in terminal */
static ssize_t lg4ff_range_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct lg4ff_device_entry *uninitialized_var(entry);
	struct list_head *h;
	struct hid_device *hid = to_hid_device(dev);
	size_t count;

	list_for_each(h, &device_list.list) {
		entry = list_entry(h, struct lg4ff_device_entry, list);
		if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0)
			break;
	}
	if (h == &device_list.list) {
		dbg_hid("Device not found!");
		return 0;
	}

	count = scnprintf(buf, PAGE_SIZE, "%u\n", entry->range);
	return count;
}

/* Set range to user specified value, call appropriate function
 * according to the type of the wheel */
static ssize_t lg4ff_range_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
{
	struct lg4ff_device_entry *uninitialized_var(entry);
	struct list_head *h;
	struct hid_device *hid = to_hid_device(dev);
	__u16 range = simple_strtoul(buf, NULL, 10);

	list_for_each(h, &device_list.list) {
		entry = list_entry(h, struct lg4ff_device_entry, list);
		if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0)
			break;
	}
	if (h == &device_list.list) {
		dbg_hid("Device not found!");
		return count;
	}

	if (range == 0)
		range = entry->max_range;

	/* Check if the wheel supports range setting
	 * and that the range is within limits for the wheel */
	if (entry->set_range != NULL && range >= entry->min_range && range <= entry->max_range) {
		entry->set_range(hid, range);
		entry->range = range;
	}

	return count;
}

int lg4ff_init(struct hid_device *hid)
{
	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	struct input_dev *dev = hidinput->input;
	struct hid_report *report;
	struct hid_field *field;
	struct lg4ff_device_entry *entry;
	struct usb_device_descriptor *udesc;
	int error, i, j;
	__u16 bcdDevice, rev_maj, rev_min;

	/* Find the report to use */
	if (list_empty(report_list)) {
		hid_err(hid, "No output report found\n");
		return -1;
	}

	/* Check that the report looks ok */
	report = list_entry(report_list->next, struct hid_report, list);
	if (!report) {
		hid_err(hid, "NULL output report\n");
		return -1;
	}

	field = report->field[0];
	if (!field) {
		hid_err(hid, "NULL field\n");
		return -1;
	}

	/* Check what wheel has been connected */
	for (i = 0; i < ARRAY_SIZE(lg4ff_devices); i++) {
		if (hid->product == lg4ff_devices[i].product_id) {
			dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices[i].product_id);
			break;
		}
	}

	if (i == ARRAY_SIZE(lg4ff_devices)) {
		hid_err(hid, "Device is not supported by lg4ff driver. If you think it should be, consider reporting a bug to"
			     "LKML, Simon Wood <simon@mungewell.org> or Michal Maly <madcatxster@gmail.com>\n");
		return -1;
	}

	/* Attempt to switch wheel to native mode when applicable */
	udesc = &(hid_to_usb_dev(hid)->descriptor);
	if (!udesc) {
		hid_err(hid, "NULL USB device descriptor\n");
		return -1;
	}
	bcdDevice = le16_to_cpu(udesc->bcdDevice);
	rev_maj = bcdDevice >> 8;
	rev_min = bcdDevice & 0xff;

	if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_WHEEL) {
		dbg_hid("Generic wheel detected, can it do native?\n");
		dbg_hid("USB revision: %2x.%02x\n", rev_maj, rev_min);

		for (j = 0; j < ARRAY_SIZE(lg4ff_revs); j++) {
			if (lg4ff_revs[j].rev_maj == rev_maj && lg4ff_revs[j].rev_min == rev_min) {
				hid_lg4ff_switch_native(hid, lg4ff_revs[j].command);
				hid_info(hid, "Switched to native mode\n");
			}
		}
	}

	/* Set supported force feedback capabilities */
	for (j = 0; lg4ff_devices[i].ff_effects[j] >= 0; j++)
		set_bit(lg4ff_devices[i].ff_effects[j], dev->ffbit);

	error = input_ff_create_memless(dev, NULL, hid_lg4ff_play);

	if (error)
		return error;

	/* Check if autocentering is available and
	 * set the centering force to zero by default */
	if (test_bit(FF_AUTOCENTER, dev->ffbit)) {
		if(rev_maj == FFEX_REV_MAJ && rev_min == FFEX_REV_MIN)	/* Formula Force EX expects different autocentering command */
			dev->ff->set_autocenter = hid_lg4ff_set_autocenter_ffex;
		else
			dev->ff->set_autocenter = hid_lg4ff_set_autocenter_default;

		dev->ff->set_autocenter(dev, 0);
	}

		/* Initialize device_list if this is the first device to handle by lg4ff */
	if (!list_inited) {
		INIT_LIST_HEAD(&device_list.list);
		list_inited = 1;
	}

	/* Add the device to device_list */
	entry = kzalloc(sizeof(struct lg4ff_device_entry), GFP_KERNEL);
	if (!entry) {
		hid_err(hid, "Cannot add device, insufficient memory.\n");
		return -ENOMEM;
	}
	entry->device_id = kstrdup((&hid->dev)->kobj.name, GFP_KERNEL);
	if (!entry->device_id) {
		hid_err(hid, "Cannot set device_id, insufficient memory.\n");
		kfree(entry);
		return -ENOMEM;
	}
	entry->min_range = lg4ff_devices[i].min_range;
	entry->max_range = lg4ff_devices[i].max_range;
	entry->set_range = lg4ff_devices[i].set_range;
	list_add(&entry->list, &device_list.list);

	/* Create sysfs interface */
	error = device_create_file(&hid->dev, &dev_attr_range);
	if (error)
		return error;
	dbg_hid("sysfs interface created\n");

	/* Set the maximum range to start with */
	entry->range = entry->max_range;
	if (entry->set_range != NULL)
		entry->set_range(hid, entry->range);

	hid_info(hid, "Force feedback for Logitech Speed Force Wireless by Simon Wood <simon@mungewell.org>\n");
	return 0;
}

int lg4ff_deinit(struct hid_device *hid)
{
	bool found = 0;
	struct lg4ff_device_entry *entry;
	struct list_head *h, *g;
	list_for_each_safe(h, g, &device_list.list) {
		entry = list_entry(h, struct lg4ff_device_entry, list);
		if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0) {
			list_del(h);
			kfree(entry->device_id);
			kfree(entry);
			found = 1;
			break;
		}
	}

	if (!found) {
		dbg_hid("Device entry not found!\n");
		return -1;
	}

	device_remove_file(&hid->dev, &dev_attr_range);
	dbg_hid("Device successfully unregistered\n");
	return 0;
}
Commit	Line	Data
32c88cbc SW	1	/*
	2	* Force feedback support for Logitech Speed Force Wireless
	3	*
	4	* http://wiibrew.org/wiki/Logitech_USB_steering_wheel
	5	*
	6	* Copyright (c) 2010 Simon Wood <simon@mungewell.org>
	7	*/
	8
	9	/*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*/
	24
	25
	26	#include <linux/input.h>
	27	#include <linux/usb.h>
	28	#include <linux/hid.h>
	29
	30	#include "usbhid/usbhid.h"
	31	#include "hid-lg.h"
7362cd22	32	#include "hid-ids.h"
32c88cbc	33
96440c8a MM	34	#define DFGT_REV_MAJ 0x13
	35	#define DFGT_REV_MIN 0x22
	36	#define DFP_REV_MAJ 0x11
	37	#define DFP_REV_MIN 0x06
	38	#define FFEX_REV_MAJ 0x21
	39	#define FFEX_REV_MIN 0x00
	40	#define G25_REV_MAJ 0x12
	41	#define G25_REV_MIN 0x22
	42	#define G27_REV_MAJ 0x12
	43	#define G27_REV_MIN 0x38
	44
30bb75d7 MM	45	#define to_hid_device(pdev) container_of(pdev, struct hid_device, dev)
	46
	47	static void hid_lg4ff_set_range_dfp(struct hid_device *hid, u16 range);
	48	static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range);
	49	static ssize_t lg4ff_range_show(struct device dev, struct device_attribute attr, char *buf);
	50	static ssize_t lg4ff_range_store(struct device dev, struct device_attribute attr, const char *buf, size_t count);
	51
	52	static DEVICE_ATTR(range, S_IRWXU \| S_IRWXG \| S_IRWXO, lg4ff_range_show, lg4ff_range_store);
	53
	54	static bool list_inited;
	55
	56	struct lg4ff_device_entry {
	57	char device_id; / Use name in respective kobject structure's address as the ID */
	58	__u16 range;
	59	__u16 min_range;
	60	__u16 max_range;
	61	__u8 leds;
	62	struct list_head list;
	63	void (set_range)(struct hid_device hid, u16 range);
	64	};
	65
	66	static struct lg4ff_device_entry device_list;
	67
7362cd22	68	static const signed short lg4ff_wheel_effects[] = {
32c88cbc SW	69	FF_CONSTANT,
	70	FF_AUTOCENTER,
	71	-1
	72	};
	73
7362cd22 MM	74	struct lg4ff_wheel {
	75	const __u32 product_id;
	76	const signed short *ff_effects;
	77	const __u16 min_range;
	78	const __u16 max_range;
30bb75d7	79	void (set_range)(struct hid_device hid, u16 range);
7362cd22 MM	80	};
	81
	82	static const struct lg4ff_wheel lg4ff_devices[] = {
30bb75d7 MM	83	{USB_DEVICE_ID_LOGITECH_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
	84	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL, lg4ff_wheel_effects, 40, 270, NULL},
	85	{USB_DEVICE_ID_LOGITECH_DFP_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_dfp},
	86	{USB_DEVICE_ID_LOGITECH_G25_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	87	{USB_DEVICE_ID_LOGITECH_DFGT_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	88	{USB_DEVICE_ID_LOGITECH_G27_WHEEL, lg4ff_wheel_effects, 40, 900, hid_lg4ff_set_range_g25},
	89	{USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2, lg4ff_wheel_effects, 40, 270, NULL},
	90	{USB_DEVICE_ID_LOGITECH_WII_WHEEL, lg4ff_wheel_effects, 40, 270, NULL}
7362cd22 MM	91	};
7362cd22 MM	92
96440c8a MM	93	struct lg4ff_native_cmd {
	94	const __u8 cmd_num; /* Number of commands to send */
	95	const __u8 cmd[];
	96	};
	97
	98	struct lg4ff_usb_revision {
	99	const __u16 rev_maj;
	100	const __u16 rev_min;
	101	const struct lg4ff_native_cmd *command;
	102	};
	103
	104	static const struct lg4ff_native_cmd native_dfp = {
	105	1,
	106	{0xf8, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00}
	107	};
	108
	109	static const struct lg4ff_native_cmd native_dfgt = {
	110	2,
	111	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* 1st command */
	112	0xf8, 0x09, 0x03, 0x01, 0x00, 0x00, 0x00} /* 2nd command */
	113	};
	114
	115	static const struct lg4ff_native_cmd native_g25 = {
	116	1,
	117	{0xf8, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00}
	118	};
	119
	120	static const struct lg4ff_native_cmd native_g27 = {
	121	2,
	122	{0xf8, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, /* 1st command */
	123	0xf8, 0x09, 0x04, 0x01, 0x00, 0x00, 0x00} /* 2nd command */
	124	};
	125
	126	static const struct lg4ff_usb_revision lg4ff_revs[] = {
	127	{DFGT_REV_MAJ, DFGT_REV_MIN, &native_dfgt}, /* Driving Force GT */
	128	{DFP_REV_MAJ, DFP_REV_MIN, &native_dfp}, /* Driving Force Pro */
	129	{G25_REV_MAJ, G25_REV_MIN, &native_g25}, /* G25 */
	130	{G27_REV_MAJ, G27_REV_MIN, &native_g27}, /* G27 */
	131	};
	132
30bb75d7	133	static int hid_lg4ff_play(struct input_dev dev, void data, struct ff_effect *effect)
32c88cbc SW	134	{
	135	struct hid_device *hid = input_get_drvdata(dev);
	136	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	137	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	138	int x;
	139
	140	#define CLAMP(x) if (x < 0) x = 0; if (x > 0xff) x = 0xff
	141
	142	switch (effect->type) {
	143	case FF_CONSTANT:
	144	x = effect->u.ramp.start_level + 0x80; /* 0x80 is no force */
	145	CLAMP(x);
	146	report->field[0]->value[0] = 0x11; /* Slot 1 */
7362cd22	147	report->field[0]->value[1] = 0x08;
32c88cbc	148	report->field[0]->value[2] = x;
7362cd22	149	report->field[0]->value[3] = 0x80;
32c88cbc	150	report->field[0]->value[4] = 0x00;
7362cd22	151	report->field[0]->value[5] = 0x00;
32c88cbc	152	report->field[0]->value[6] = 0x00;
32c88cbc SW	153
	154	usbhid_submit_report(hid, report, USB_DIR_OUT);
	155	break;
	156	}
	157	return 0;
	158	}
	159
6e2de8e0 MM	160	/* Sends default autocentering command compatible with
	161	* all wheels except Formula Force EX */
	162	static void hid_lg4ff_set_autocenter_default(struct input_dev *dev, u16 magnitude)
32c88cbc SW	163	{
	164	struct hid_device *hid = input_get_drvdata(dev);
	165	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	166	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
32c88cbc	167
7362cd22 MM	168	report->field[0]->value[0] = 0xfe;
	169	report->field[0]->value[1] = 0x0d;
	170	report->field[0]->value[2] = magnitude >> 13;
	171	report->field[0]->value[3] = magnitude >> 13;
	172	report->field[0]->value[4] = magnitude >> 8;
	173	report->field[0]->value[5] = 0x00;
	174	report->field[0]->value[6] = 0x00;
32c88cbc SW	175
	176	usbhid_submit_report(hid, report, USB_DIR_OUT);
	177	}
	178
6e2de8e0 MM	179	/* Sends autocentering command compatible with Formula Force EX */
	180	static void hid_lg4ff_set_autocenter_ffex(struct input_dev *dev, u16 magnitude)
	181	{
	182	struct hid_device *hid = input_get_drvdata(dev);
	183	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	184	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	185	magnitude = magnitude * 90 / 65535;
	186
	187
	188	report->field[0]->value[0] = 0xfe;
	189	report->field[0]->value[1] = 0x03;
	190	report->field[0]->value[2] = magnitude >> 14;
	191	report->field[0]->value[3] = magnitude >> 14;
	192	report->field[0]->value[4] = magnitude;
	193	report->field[0]->value[5] = 0x00;
	194	report->field[0]->value[6] = 0x00;
	195
	196	usbhid_submit_report(hid, report, USB_DIR_OUT);
	197	}
	198
30bb75d7 MM	199	/* Sends command to set range compatible with G25/G27/Driving Force GT */
	200	static void hid_lg4ff_set_range_g25(struct hid_device *hid, u16 range)
	201	{
	202	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	203	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	204	dbg_hid("G25/G27/DFGT: setting range to %u\n", range);
	205
	206	report->field[0]->value[0] = 0xf8;
	207	report->field[0]->value[1] = 0x81;
	208	report->field[0]->value[2] = range & 0x00ff;
	209	report->field[0]->value[3] = (range & 0xff00) >> 8;
	210	report->field[0]->value[4] = 0x00;
	211	report->field[0]->value[5] = 0x00;
	212	report->field[0]->value[6] = 0x00;
	213
	214	usbhid_submit_report(hid, report, USB_DIR_OUT);
	215	}
	216
	217	/* Sends commands to set range compatible with Driving Force Pro wheel */
	218	static void hid_lg4ff_set_range_dfp(struct hid_device *hid, __u16 range)
	219	{
	220	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	221	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	222	int start_left, start_right, full_range;
	223	dbg_hid("Driving Force Pro: setting range to %u\n", range);
	224
	225	/* Prepare "coarse" limit command */
	226	report->field[0]->value[0] = 0xf8;
	227	report->field[0]->value[1] = 0x00; /* Set later */
	228	report->field[0]->value[2] = 0x00;
	229	report->field[0]->value[3] = 0x00;
	230	report->field[0]->value[4] = 0x00;
	231	report->field[0]->value[5] = 0x00;
	232	report->field[0]->value[6] = 0x00;
	233
	234	if (range > 200) {
	235	report->field[0]->value[1] = 0x03;
	236	full_range = 900;
	237	} else {
	238	report->field[0]->value[1] = 0x02;
	239	full_range = 200;
	240	}
	241	usbhid_submit_report(hid, report, USB_DIR_OUT);
	242
	243	/* Prepare "fine" limit command */
	244	report->field[0]->value[0] = 0x81;
	245	report->field[0]->value[1] = 0x0b;
	246	report->field[0]->value[2] = 0x00;
	247	report->field[0]->value[3] = 0x00;
	248	report->field[0]->value[4] = 0x00;
	249	report->field[0]->value[5] = 0x00;
	250	report->field[0]->value[6] = 0x00;
	251
	252	if (range == 200 \|\| range == 900) { /* Do not apply any fine limit */
	253	usbhid_submit_report(hid, report, USB_DIR_OUT);
	254	return;
	255	}
	256
	257	/* Construct fine limit command */
	258	start_left = (((full_range - range + 1) * 2047) / full_range);
	259	start_right = 0xfff - start_left;
	260
	261	report->field[0]->value[2] = start_left >> 4;
	262	report->field[0]->value[3] = start_right >> 4;
263	report->field[0]->value[4] = 0xff;
264	report->field[0]->value[5] = (start_right & 0xe) << 4 \| (start_left & 0xe);
265	report->field[0]->value[6] = 0xff;
266
267	usbhid_submit_report(hid, report, USB_DIR_OUT);
268	}
269
96440c8a MM	270	static void hid_lg4ff_switch_native(struct hid_device hid, const struct lg4ff_native_cmd cmd)
	271	{
	272	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	273	struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
	274	__u8 i, j;
	275
	276	j = 0;
	277	while (j < 7*cmd->cmd_num) {
	278	for (i = 0; i < 7; i++)
	279	report->field[0]->value[i] = cmd->cmd[j++];
	280
	281	usbhid_submit_report(hid, report, USB_DIR_OUT);
	282	}
	283	}
32c88cbc	284
30bb75d7 MM	285	/* Read current range and display it in terminal */
	286	static ssize_t lg4ff_range_show(struct device dev, struct device_attribute attr, char *buf)
	287	{
2bbaf771	288	struct lg4ff_device_entry *uninitialized_var(entry);
30bb75d7 MM	289	struct list_head *h;
	290	struct hid_device *hid = to_hid_device(dev);
	291	size_t count;
	292
	293	list_for_each(h, &device_list.list) {
	294	entry = list_entry(h, struct lg4ff_device_entry, list);
	295	if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0)
	296	break;
	297	}
	298	if (h == &device_list.list) {
	299	dbg_hid("Device not found!");
	300	return 0;
	301	}
	302
	303	count = scnprintf(buf, PAGE_SIZE, "%u\n", entry->range);
	304	return count;
	305	}
	306
	307	/* Set range to user specified value, call appropriate function
	308	* according to the type of the wheel */
	309	static ssize_t lg4ff_range_store(struct device dev, struct device_attribute attr, const char *buf, size_t count)
	310	{
2bbaf771	311	struct lg4ff_device_entry *uninitialized_var(entry);
30bb75d7 MM	312	struct list_head *h;
	313	struct hid_device *hid = to_hid_device(dev);
	314	__u16 range = simple_strtoul(buf, NULL, 10);
	315
	316	list_for_each(h, &device_list.list) {
	317	entry = list_entry(h, struct lg4ff_device_entry, list);
	318	if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0)
	319	break;
	320	}
	321	if (h == &device_list.list) {
	322	dbg_hid("Device not found!");
	323	return count;
	324	}
	325
	326	if (range == 0)
	327	range = entry->max_range;
	328
	329	/* Check if the wheel supports range setting
	330	* and that the range is within limits for the wheel */
	331	if (entry->set_range != NULL && range >= entry->min_range && range <= entry->max_range) {
	332	entry->set_range(hid, range);
	333	entry->range = range;
	334	}
	335
	336	return count;
	337	}
	338
32c88cbc SW	339	int lg4ff_init(struct hid_device *hid)
	340	{
	341	struct hid_input *hidinput = list_entry(hid->inputs.next, struct hid_input, list);
	342	struct list_head *report_list = &hid->report_enum[HID_OUTPUT_REPORT].report_list;
	343	struct input_dev *dev = hidinput->input;
	344	struct hid_report *report;
	345	struct hid_field *field;
30bb75d7 MM	346	struct lg4ff_device_entry *entry;
30bb75d7 MM	347	struct usb_device_descriptor *udesc;
7362cd22	348	int error, i, j;
96440c8a	349	__u16 bcdDevice, rev_maj, rev_min;
32c88cbc SW	350
	351	/* Find the report to use */
	352	if (list_empty(report_list)) {
4291ee30	353	hid_err(hid, "No output report found\n");
32c88cbc SW	354	return -1;
	355	}
	356
	357	/* Check that the report looks ok */
	358	report = list_entry(report_list->next, struct hid_report, list);
	359	if (!report) {
4291ee30	360	hid_err(hid, "NULL output report\n");
32c88cbc SW	361	return -1;
	362	}
	363
	364	field = report->field[0];
	365	if (!field) {
4291ee30	366	hid_err(hid, "NULL field\n");
32c88cbc SW	367	return -1;
32c88cbc SW	368	}
30bb75d7	369
7362cd22 MM	370	/* Check what wheel has been connected */
	371	for (i = 0; i < ARRAY_SIZE(lg4ff_devices); i++) {
	372	if (hid->product == lg4ff_devices[i].product_id) {
	373	dbg_hid("Found compatible device, product ID %04X\n", lg4ff_devices[i].product_id);
	374	break;
	375	}
	376	}
	377
	378	if (i == ARRAY_SIZE(lg4ff_devices)) {
	379	hid_err(hid, "Device is not supported by lg4ff driver. If you think it should be, consider reporting a bug to"
	380	"LKML, Simon Wood <simon@mungewell.org> or Michal Maly <madcatxster@gmail.com>\n");
	381	return -1;
	382	}
32c88cbc	383
96440c8a MM	384	/* Attempt to switch wheel to native mode when applicable */
	385	udesc = &(hid_to_usb_dev(hid)->descriptor);
	386	if (!udesc) {
	387	hid_err(hid, "NULL USB device descriptor\n");
	388	return -1;
	389	}
	390	bcdDevice = le16_to_cpu(udesc->bcdDevice);
	391	rev_maj = bcdDevice >> 8;
	392	rev_min = bcdDevice & 0xff;
	393
	394	if (lg4ff_devices[i].product_id == USB_DEVICE_ID_LOGITECH_WHEEL) {
	395	dbg_hid("Generic wheel detected, can it do native?\n");
	396	dbg_hid("USB revision: %2x.%02x\n", rev_maj, rev_min);
	397
	398	for (j = 0; j < ARRAY_SIZE(lg4ff_revs); j++) {
	399	if (lg4ff_revs[j].rev_maj == rev_maj && lg4ff_revs[j].rev_min == rev_min) {
	400	hid_lg4ff_switch_native(hid, lg4ff_revs[j].command);
	401	hid_info(hid, "Switched to native mode\n");
	402	}
	403	}
	404	}
	405
7362cd22 MM	406	/* Set supported force feedback capabilities */
	407	for (j = 0; lg4ff_devices[i].ff_effects[j] >= 0; j++)
	408	set_bit(lg4ff_devices[i].ff_effects[j], dev->ffbit);
32c88cbc SW	409
	410	error = input_ff_create_memless(dev, NULL, hid_lg4ff_play);
	411
	412	if (error)
	413	return error;
	414
6e2de8e0 MM	415	/* Check if autocentering is available and
	416	* set the centering force to zero by default */
	417	if (test_bit(FF_AUTOCENTER, dev->ffbit)) {
	418	if(rev_maj == FFEX_REV_MAJ && rev_min == FFEX_REV_MIN) /* Formula Force EX expects different autocentering command */
	419	dev->ff->set_autocenter = hid_lg4ff_set_autocenter_ffex;
	420	else
	421	dev->ff->set_autocenter = hid_lg4ff_set_autocenter_default;
	422
	423	dev->ff->set_autocenter(dev, 0);
	424	}
32c88cbc	425
30bb75d7 MM	426	/* Initialize device_list if this is the first device to handle by lg4ff */
	427	if (!list_inited) {
	428	INIT_LIST_HEAD(&device_list.list);
	429	list_inited = 1;
	430	}
	431
	432	/* Add the device to device_list */
8383c6bf	433	entry = kzalloc(sizeof(struct lg4ff_device_entry), GFP_KERNEL);
30bb75d7 MM	434	if (!entry) {
	435	hid_err(hid, "Cannot add device, insufficient memory.\n");
	436	return -ENOMEM;
	437	}
8f252290	438	entry->device_id = kstrdup((&hid->dev)->kobj.name, GFP_KERNEL);
30bb75d7 MM	439	if (!entry->device_id) {
30bb75d7 MM	440	hid_err(hid, "Cannot set device_id, insufficient memory.\n");
8f252290	441	kfree(entry);
30bb75d7 MM	442	return -ENOMEM;
30bb75d7 MM	443	}
30bb75d7 MM	444	entry->min_range = lg4ff_devices[i].min_range;
	445	entry->max_range = lg4ff_devices[i].max_range;
	446	entry->set_range = lg4ff_devices[i].set_range;
	447	list_add(&entry->list, &device_list.list);
	448
	449	/* Create sysfs interface */
	450	error = device_create_file(&hid->dev, &dev_attr_range);
	451	if (error)
	452	return error;
	453	dbg_hid("sysfs interface created\n");
	454
	455	/* Set the maximum range to start with */
	456	entry->range = entry->max_range;
	457	if (entry->set_range != NULL)
	458	entry->set_range(hid, entry->range);
	459
4291ee30	460	hid_info(hid, "Force feedback for Logitech Speed Force Wireless by Simon Wood <simon@mungewell.org>\n");
32c88cbc SW	461	return 0;
	462	}
	463
30bb75d7 MM	464	int lg4ff_deinit(struct hid_device *hid)
	465	{
	466	bool found = 0;
	467	struct lg4ff_device_entry *entry;
	468	struct list_head h, g;
	469	list_for_each_safe(h, g, &device_list.list) {
	470	entry = list_entry(h, struct lg4ff_device_entry, list);
	471	if (strcmp(entry->device_id, (&hid->dev)->kobj.name) == 0) {
	472	list_del(h);
	473	kfree(entry->device_id);
	474	kfree(entry);
	475	found = 1;
	476	break;
	477	}
	478	}
	479
	480	if (!found) {
	481	dbg_hid("Device entry not found!\n");
	482	return -1;
	483	}
	484
	485	device_remove_file(&hid->dev, &dev_attr_range);
	486	dbg_hid("Device successfully unregistered\n");
	487	return 0;
	488	}