[mirror_ubuntu-bionic-kernel.git] / drivers / hid / hid-lg.c

/*
 *  HID driver for some logitech "special" devices
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
 *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
 *  Copyright (c) 2006-2007 Jiri Kosina
 *  Copyright (c) 2007 Paul Walmsley
 *  Copyright (c) 2008 Jiri Slaby
 */

/*
 * 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/random.h>
#include <linux/sched.h>
#include <linux/wait.h>

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

#define LG_RDESC		0x001
#define LG_BAD_RELATIVE_KEYS	0x002
#define LG_DUPLICATE_USAGES	0x004
#define LG_EXPANDED_KEYMAP	0x010
#define LG_IGNORE_DOUBLED_WHEEL	0x020
#define LG_WIRELESS		0x040
#define LG_INVERT_HWHEEL	0x080
#define LG_NOGET		0x100
#define LG_FF			0x200
#define LG_FF2			0x400
#define LG_RDESC_REL_ABS	0x800
#define LG_FF3			0x1000
#define LG_FF4			0x2000

/*
 * Certain Logitech keyboards send in report #3 keys which are far
 * above the logical maximum described in descriptor. This extends
 * the original value of 0x28c of logical maximum to 0x104d
 */
static void lg_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int rsize)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if ((quirks & LG_RDESC) && rsize >= 90 && rdesc[83] == 0x26 &&
			rdesc[84] == 0x8c && rdesc[85] == 0x02) {
		dev_info(&hdev->dev, "fixing up Logitech keyboard report "
				"descriptor\n");
		rdesc[84] = rdesc[89] = 0x4d;
		rdesc[85] = rdesc[90] = 0x10;
	}
	if ((quirks & LG_RDESC_REL_ABS) && rsize >= 50 &&
			rdesc[32] == 0x81 && rdesc[33] == 0x06 &&
			rdesc[49] == 0x81 && rdesc[50] == 0x06) {
		dev_info(&hdev->dev, "fixing up rel/abs in Logitech "
				"report descriptor\n");
		rdesc[33] = rdesc[50] = 0x02;
	}

	if ((quirks & LG_FF4) && rsize >= 101 &&
			rdesc[41] == 0x95 && rdesc[42] == 0x0B &&
			rdesc[47] == 0x05 && rdesc[48] == 0x09) {
		dev_info(&hdev->dev, "fixing up Logitech Speed Force Wireless "
			"button descriptor\n");
		rdesc[41] = 0x05;
		rdesc[42] = 0x09;
		rdesc[47] = 0x95;
		rdesc[48] = 0x0B;
	}
}

#define lg_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, max, \
		EV_KEY, (c))

static int lg_ultrax_remote_mapping(struct hid_input *hi,
		struct hid_usage *usage, unsigned long **bit, int *max)
{
	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_LOGIVENDOR)
		return 0;

	set_bit(EV_REP, hi->input->evbit);
	switch (usage->hid & HID_USAGE) {
	/* Reported on Logitech Ultra X Media Remote */
	case 0x004: lg_map_key_clear(KEY_AGAIN);	break;
	case 0x00d: lg_map_key_clear(KEY_HOME);		break;
	case 0x024: lg_map_key_clear(KEY_SHUFFLE);	break;
	case 0x025: lg_map_key_clear(KEY_TV);		break;
	case 0x026: lg_map_key_clear(KEY_MENU);		break;
	case 0x031: lg_map_key_clear(KEY_AUDIO);	break;
	case 0x032: lg_map_key_clear(KEY_TEXT);		break;
	case 0x033: lg_map_key_clear(KEY_LAST);		break;
	case 0x047: lg_map_key_clear(KEY_MP3);		break;
	case 0x048: lg_map_key_clear(KEY_DVD);		break;
	case 0x049: lg_map_key_clear(KEY_MEDIA);	break;
	case 0x04a: lg_map_key_clear(KEY_VIDEO);	break;
	case 0x04b: lg_map_key_clear(KEY_ANGLE);	break;
	case 0x04c: lg_map_key_clear(KEY_LANGUAGE);	break;
	case 0x04d: lg_map_key_clear(KEY_SUBTITLE);	break;
	case 0x051: lg_map_key_clear(KEY_RED);		break;
	case 0x052: lg_map_key_clear(KEY_CLOSE);	break;

	default:
		return 0;
	}
	return 1;
}

static int lg_dinovo_mapping(struct hid_input *hi, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_LOGIVENDOR)
		return 0;

	switch (usage->hid & HID_USAGE) {

	case 0x00d: lg_map_key_clear(KEY_MEDIA);	break;
	default:
		return 0;

	}
	return 1;
}

static int lg_wireless_mapping(struct hid_input *hi, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_CONSUMER)
		return 0;

	switch (usage->hid & HID_USAGE) {
	case 0x1001: lg_map_key_clear(KEY_MESSENGER);		break;
	case 0x1003: lg_map_key_clear(KEY_SOUND);		break;
	case 0x1004: lg_map_key_clear(KEY_VIDEO);		break;
	case 0x1005: lg_map_key_clear(KEY_AUDIO);		break;
	case 0x100a: lg_map_key_clear(KEY_DOCUMENTS);		break;
	/* The following two entries are Playlist 1 and 2 on the MX3200 */
	case 0x100f: lg_map_key_clear(KEY_FN_1);		break;
	case 0x1010: lg_map_key_clear(KEY_FN_2);		break;
	case 0x1011: lg_map_key_clear(KEY_PREVIOUSSONG);	break;
	case 0x1012: lg_map_key_clear(KEY_NEXTSONG);		break;
	case 0x1013: lg_map_key_clear(KEY_CAMERA);		break;
	case 0x1014: lg_map_key_clear(KEY_MESSENGER);		break;
	case 0x1015: lg_map_key_clear(KEY_RECORD);		break;
	case 0x1016: lg_map_key_clear(KEY_PLAYER);		break;
	case 0x1017: lg_map_key_clear(KEY_EJECTCD);		break;
	case 0x1018: lg_map_key_clear(KEY_MEDIA);		break;
	case 0x1019: lg_map_key_clear(KEY_PROG1);		break;
	case 0x101a: lg_map_key_clear(KEY_PROG2);		break;
	case 0x101b: lg_map_key_clear(KEY_PROG3);		break;
	case 0x101c: lg_map_key_clear(KEY_CYCLEWINDOWS);	break;
	case 0x101f: lg_map_key_clear(KEY_ZOOMIN);		break;
	case 0x1020: lg_map_key_clear(KEY_ZOOMOUT);		break;
	case 0x1021: lg_map_key_clear(KEY_ZOOMRESET);		break;
	case 0x1023: lg_map_key_clear(KEY_CLOSE);		break;
	case 0x1027: lg_map_key_clear(KEY_MENU);		break;
	/* this one is marked as 'Rotate' */
	case 0x1028: lg_map_key_clear(KEY_ANGLE);		break;
	case 0x1029: lg_map_key_clear(KEY_SHUFFLE);		break;
	case 0x102a: lg_map_key_clear(KEY_BACK);		break;
	case 0x102b: lg_map_key_clear(KEY_CYCLEWINDOWS);	break;
	case 0x102d: lg_map_key_clear(KEY_WWW);			break;
	/* The following two are 'Start/answer call' and 'End/reject call'
	   on the MX3200 */
	case 0x1031: lg_map_key_clear(KEY_OK);			break;
	case 0x1032: lg_map_key_clear(KEY_CANCEL);		break;
	case 0x1041: lg_map_key_clear(KEY_BATTERY);		break;
	case 0x1042: lg_map_key_clear(KEY_WORDPROCESSOR);	break;
	case 0x1043: lg_map_key_clear(KEY_SPREADSHEET);		break;
	case 0x1044: lg_map_key_clear(KEY_PRESENTATION);	break;
	case 0x1045: lg_map_key_clear(KEY_UNDO);		break;
	case 0x1046: lg_map_key_clear(KEY_REDO);		break;
	case 0x1047: lg_map_key_clear(KEY_PRINT);		break;
	case 0x1048: lg_map_key_clear(KEY_SAVE);		break;
	case 0x1049: lg_map_key_clear(KEY_PROG1);		break;
	case 0x104a: lg_map_key_clear(KEY_PROG2);		break;
	case 0x104b: lg_map_key_clear(KEY_PROG3);		break;
	case 0x104c: lg_map_key_clear(KEY_PROG4);		break;

	default:
		return 0;
	}
	return 1;
}

static int lg_input_mapping(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	/* extended mapping for certain Logitech hardware (Logitech cordless
	   desktop LX500) */
	static const u8 e_keymap[] = {
		  0,216,  0,213,175,156,  0,  0,  0,  0,
		144,  0,  0,  0,  0,  0,  0,  0,  0,212,
		174,167,152,161,112,  0,  0,  0,154,  0,
		  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
		  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
		  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
		  0,  0,  0,  0,  0,183,184,185,186,187,
		188,189,190,191,192,193,194,  0,  0,  0
	};
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	unsigned int hid = usage->hid;

	if (hdev->product == USB_DEVICE_ID_LOGITECH_RECEIVER &&
			lg_ultrax_remote_mapping(hi, usage, bit, max))
		return 1;

	if (hdev->product == USB_DEVICE_ID_DINOVO_MINI &&
			lg_dinovo_mapping(hi, usage, bit, max))
		return 1;

	if ((quirks & LG_WIRELESS) && lg_wireless_mapping(hi, usage, bit, max))
		return 1;

	if ((hid & HID_USAGE_PAGE) != HID_UP_BUTTON)
		return 0;

	hid &= HID_USAGE;

	/* Special handling for Logitech Cordless Desktop */
	if (field->application == HID_GD_MOUSE) {
		if ((quirks & LG_IGNORE_DOUBLED_WHEEL) &&
				(hid == 7 || hid == 8))
			return -1;
	} else {
		if ((quirks & LG_EXPANDED_KEYMAP) &&
				hid < ARRAY_SIZE(e_keymap) &&
				e_keymap[hid] != 0) {
			hid_map_usage(hi, usage, bit, max, EV_KEY,
					e_keymap[hid]);
			return 1;
		}
	}

	return 0;
}

static int lg_input_mapped(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if ((quirks & LG_BAD_RELATIVE_KEYS) && usage->type == EV_KEY &&
			(field->flags & HID_MAIN_ITEM_RELATIVE))
		field->flags &= ~HID_MAIN_ITEM_RELATIVE;

	if ((quirks & LG_DUPLICATE_USAGES) && (usage->type == EV_KEY ||
			 usage->type == EV_REL || usage->type == EV_ABS))
		clear_bit(usage->code, *bit);

	return 0;
}

static int lg_event(struct hid_device *hdev, struct hid_field *field,
		struct hid_usage *usage, __s32 value)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if ((quirks & LG_INVERT_HWHEEL) && usage->code == REL_HWHEEL) {
		input_event(field->hidinput->input, usage->type, usage->code,
				-value);
		return 1;
	}

	return 0;
}

static int lg_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	unsigned long quirks = id->driver_data;
	unsigned int connect_mask = HID_CONNECT_DEFAULT;
	int ret;

	hid_set_drvdata(hdev, (void *)quirks);

	if (quirks & LG_NOGET)
		hdev->quirks |= HID_QUIRK_NOGET;

	ret = hid_parse(hdev);
	if (ret) {
		dev_err(&hdev->dev, "parse failed\n");
		goto err_free;
	}

	if (quirks & (LG_FF | LG_FF2 | LG_FF3))
		connect_mask &= ~HID_CONNECT_FF;

	ret = hid_hw_start(hdev, connect_mask);
	if (ret) {
		dev_err(&hdev->dev, "hw start failed\n");
		goto err_free;
	}

	if (quirks & LG_FF4) {
		unsigned char buf[] = { 0x00, 0xAF,  0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };

		ret = hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);

		if (ret >= 0) {
			/* insert a little delay of 10 jiffies ~ 40ms */
			wait_queue_head_t wait;
			init_waitqueue_head (&wait);
			wait_event_interruptible_timeout(wait, 0, 10);

			/* Select random Address */
			buf[1] = 0xB2;
			get_random_bytes(&buf[2], 2);

			ret = hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
		}
	}

	if (quirks & LG_FF)
		lgff_init(hdev);
	if (quirks & LG_FF2)
		lg2ff_init(hdev);
	if (quirks & LG_FF3)
		lg3ff_init(hdev);
	if (quirks & LG_FF4)
		lg4ff_init(hdev);

	return 0;
err_free:
	return ret;
}

static const struct hid_device_id lg_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_MX3000_RECEIVER),
		.driver_data = LG_RDESC | LG_WIRELESS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER),
		.driver_data = LG_RDESC | LG_WIRELESS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER_2),
		.driver_data = LG_RDESC | LG_WIRELESS },

	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RECEIVER),
		.driver_data = LG_BAD_RELATIVE_KEYS },

	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_DESKTOP),
		.driver_data = LG_DUPLICATE_USAGES },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_EDGE),
		.driver_data = LG_DUPLICATE_USAGES },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_MINI),
		.driver_data = LG_DUPLICATE_USAGES },

	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_ELITE_KBD),
		.driver_data = LG_IGNORE_DOUBLED_WHEEL | LG_EXPANDED_KEYMAP },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_CORDLESS_DESKTOP_LX500),
		.driver_data = LG_IGNORE_DOUBLED_WHEEL | LG_EXPANDED_KEYMAP },

	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_EXTREME_3D),
		.driver_data = LG_NOGET },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEEL),
		.driver_data = LG_NOGET | LG_FF },

	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2_2),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_F3D),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FORCE3D_PRO),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WII_WHEEL),
		.driver_data = LG_FF4 },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_FFG ),
		.driver_data = LG_FF },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2),
		.driver_data = LG_FF2 },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FLIGHT_SYSTEM_G940),
		.driver_data = LG_FF3 },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACENAVIGATOR),
		.driver_data = LG_RDESC_REL_ABS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACETRAVELLER),
		.driver_data = LG_RDESC_REL_ABS },
	{ }
};

MODULE_DEVICE_TABLE(hid, lg_devices);

static struct hid_driver lg_driver = {
	.name = "logitech",
	.id_table = lg_devices,
	.report_fixup = lg_report_fixup,
	.input_mapping = lg_input_mapping,
	.input_mapped = lg_input_mapped,
	.event = lg_event,
	.probe = lg_probe,
};

static int __init lg_init(void)
{
	return hid_register_driver(&lg_driver);
}

static void __exit lg_exit(void)
{
	hid_unregister_driver(&lg_driver);
}

module_init(lg_init);
module_exit(lg_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
5f22a799 JS	1	/*
	2	* HID driver for some logitech "special" devices
	3	*
	4	* Copyright (c) 1999 Andreas Gal
	5	* Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
	6	* Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
	7	* Copyright (c) 2006-2007 Jiri Kosina
	8	* Copyright (c) 2007 Paul Walmsley
	9	* Copyright (c) 2008 Jiri Slaby
	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>
32c88cbc SW	22	#include <linux/random.h>
	23	#include <linux/sched.h>
	24	#include <linux/wait.h>
5f22a799 JS	25
5f22a799 JS	26	#include "hid-ids.h"
606bd0a8	27	#include "hid-lg.h"
5f22a799 JS	28
	29	#define LG_RDESC 0x001
	30	#define LG_BAD_RELATIVE_KEYS 0x002
	31	#define LG_DUPLICATE_USAGES 0x004
5f22a799 JS	32	#define LG_EXPANDED_KEYMAP 0x010
	33	#define LG_IGNORE_DOUBLED_WHEEL 0x020
	34	#define LG_WIRELESS 0x040
	35	#define LG_INVERT_HWHEEL 0x080
	36	#define LG_NOGET 0x100
606bd0a8 JS	37	#define LG_FF 0x200
606bd0a8 JS	38	#define LG_FF2 0x400
24985cf6	39	#define LG_RDESC_REL_ABS 0x800
74f292ca	40	#define LG_FF3 0x1000
32c88cbc	41	#define LG_FF4 0x2000
5f22a799 JS	42
	43	/*
	44	* Certain Logitech keyboards send in report #3 keys which are far
	45	* above the logical maximum described in descriptor. This extends
	46	* the original value of 0x28c of logical maximum to 0x104d
	47	*/
	48	static void lg_report_fixup(struct hid_device hdev, __u8 rdesc,
	49	unsigned int rsize)
	50	{
	51	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	52
	53	if ((quirks & LG_RDESC) && rsize >= 90 && rdesc[83] == 0x26 &&
	54	rdesc[84] == 0x8c && rdesc[85] == 0x02) {
	55	dev_info(&hdev->dev, "fixing up Logitech keyboard report "
	56	"descriptor\n");
	57	rdesc[84] = rdesc[89] = 0x4d;
	58	rdesc[85] = rdesc[90] = 0x10;
	59	}
24985cf6 JK	60	if ((quirks & LG_RDESC_REL_ABS) && rsize >= 50 &&
	61	rdesc[32] == 0x81 && rdesc[33] == 0x06 &&
	62	rdesc[49] == 0x81 && rdesc[50] == 0x06) {
	63	dev_info(&hdev->dev, "fixing up rel/abs in Logitech "
	64	"report descriptor\n");
	65	rdesc[33] = rdesc[50] = 0x02;
	66	}
32c88cbc SW	67
	68	if ((quirks & LG_FF4) && rsize >= 101 &&
	69	rdesc[41] == 0x95 && rdesc[42] == 0x0B &&
	70	rdesc[47] == 0x05 && rdesc[48] == 0x09) {
	71	dev_info(&hdev->dev, "fixing up Logitech Speed Force Wireless "
	72	"button descriptor\n");
	73	rdesc[41] = 0x05;
	74	rdesc[42] = 0x09;
	75	rdesc[47] = 0x95;
	76	rdesc[48] = 0x0B;
	77	}
5f22a799 JS	78	}
	79
	80	#define lg_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \
	81	EV_KEY, (c))
	82
	83	static int lg_ultrax_remote_mapping(struct hid_input *hi,
	84	struct hid_usage usage, unsigned long bit, int max)
	85	{
	86	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_LOGIVENDOR)
	87	return 0;
	88
	89	set_bit(EV_REP, hi->input->evbit);
	90	switch (usage->hid & HID_USAGE) {
	91	/* Reported on Logitech Ultra X Media Remote */
	92	case 0x004: lg_map_key_clear(KEY_AGAIN); break;
	93	case 0x00d: lg_map_key_clear(KEY_HOME); break;
	94	case 0x024: lg_map_key_clear(KEY_SHUFFLE); break;
	95	case 0x025: lg_map_key_clear(KEY_TV); break;
	96	case 0x026: lg_map_key_clear(KEY_MENU); break;
	97	case 0x031: lg_map_key_clear(KEY_AUDIO); break;
	98	case 0x032: lg_map_key_clear(KEY_TEXT); break;
	99	case 0x033: lg_map_key_clear(KEY_LAST); break;
	100	case 0x047: lg_map_key_clear(KEY_MP3); break;
	101	case 0x048: lg_map_key_clear(KEY_DVD); break;
	102	case 0x049: lg_map_key_clear(KEY_MEDIA); break;
	103	case 0x04a: lg_map_key_clear(KEY_VIDEO); break;
	104	case 0x04b: lg_map_key_clear(KEY_ANGLE); break;
	105	case 0x04c: lg_map_key_clear(KEY_LANGUAGE); break;
	106	case 0x04d: lg_map_key_clear(KEY_SUBTITLE); break;
	107	case 0x051: lg_map_key_clear(KEY_RED); break;
	108	case 0x052: lg_map_key_clear(KEY_CLOSE); break;
	109
	110	default:
	111	return 0;
	112	}
	113	return 1;
	114	}
	115
66d61bec JK	116	static int lg_dinovo_mapping(struct hid_input hi, struct hid_usage usage,
	117	unsigned long *bit, int max)
	118	{
	119	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_LOGIVENDOR)
	120	return 0;
	121
	122	switch (usage->hid & HID_USAGE) {
	123
	124	case 0x00d: lg_map_key_clear(KEY_MEDIA); break;
	125	default:
	126	return 0;
	127
	128	}
	129	return 1;
	130	}
	131
5f22a799 JS	132	static int lg_wireless_mapping(struct hid_input hi, struct hid_usage usage,
	133	unsigned long *bit, int max)
	134	{
	135	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_CONSUMER)
	136	return 0;
	137
	138	switch (usage->hid & HID_USAGE) {
	139	case 0x1001: lg_map_key_clear(KEY_MESSENGER); break;
	140	case 0x1003: lg_map_key_clear(KEY_SOUND); break;
	141	case 0x1004: lg_map_key_clear(KEY_VIDEO); break;
	142	case 0x1005: lg_map_key_clear(KEY_AUDIO); break;
	143	case 0x100a: lg_map_key_clear(KEY_DOCUMENTS); break;
18392212 LC	144	/* The following two entries are Playlist 1 and 2 on the MX3200 */
	145	case 0x100f: lg_map_key_clear(KEY_FN_1); break;
	146	case 0x1010: lg_map_key_clear(KEY_FN_2); break;
5f22a799 JS	147	case 0x1011: lg_map_key_clear(KEY_PREVIOUSSONG); break;
	148	case 0x1012: lg_map_key_clear(KEY_NEXTSONG); break;
	149	case 0x1013: lg_map_key_clear(KEY_CAMERA); break;
	150	case 0x1014: lg_map_key_clear(KEY_MESSENGER); break;
	151	case 0x1015: lg_map_key_clear(KEY_RECORD); break;
	152	case 0x1016: lg_map_key_clear(KEY_PLAYER); break;
	153	case 0x1017: lg_map_key_clear(KEY_EJECTCD); break;
	154	case 0x1018: lg_map_key_clear(KEY_MEDIA); break;
	155	case 0x1019: lg_map_key_clear(KEY_PROG1); break;
	156	case 0x101a: lg_map_key_clear(KEY_PROG2); break;
	157	case 0x101b: lg_map_key_clear(KEY_PROG3); break;
18392212	158	case 0x101c: lg_map_key_clear(KEY_CYCLEWINDOWS); break;
5f22a799 JS	159	case 0x101f: lg_map_key_clear(KEY_ZOOMIN); break;
	160	case 0x1020: lg_map_key_clear(KEY_ZOOMOUT); break;
	161	case 0x1021: lg_map_key_clear(KEY_ZOOMRESET); break;
	162	case 0x1023: lg_map_key_clear(KEY_CLOSE); break;
	163	case 0x1027: lg_map_key_clear(KEY_MENU); break;
	164	/* this one is marked as 'Rotate' */
	165	case 0x1028: lg_map_key_clear(KEY_ANGLE); break;
	166	case 0x1029: lg_map_key_clear(KEY_SHUFFLE); break;
	167	case 0x102a: lg_map_key_clear(KEY_BACK); break;
	168	case 0x102b: lg_map_key_clear(KEY_CYCLEWINDOWS); break;
18392212 LC	169	case 0x102d: lg_map_key_clear(KEY_WWW); break;
	170	/* The following two are 'Start/answer call' and 'End/reject call'
	171	on the MX3200 */
	172	case 0x1031: lg_map_key_clear(KEY_OK); break;
	173	case 0x1032: lg_map_key_clear(KEY_CANCEL); break;
5f22a799 JS	174	case 0x1041: lg_map_key_clear(KEY_BATTERY); break;
	175	case 0x1042: lg_map_key_clear(KEY_WORDPROCESSOR); break;
	176	case 0x1043: lg_map_key_clear(KEY_SPREADSHEET); break;
	177	case 0x1044: lg_map_key_clear(KEY_PRESENTATION); break;
	178	case 0x1045: lg_map_key_clear(KEY_UNDO); break;
	179	case 0x1046: lg_map_key_clear(KEY_REDO); break;
	180	case 0x1047: lg_map_key_clear(KEY_PRINT); break;
	181	case 0x1048: lg_map_key_clear(KEY_SAVE); break;
	182	case 0x1049: lg_map_key_clear(KEY_PROG1); break;
	183	case 0x104a: lg_map_key_clear(KEY_PROG2); break;
	184	case 0x104b: lg_map_key_clear(KEY_PROG3); break;
	185	case 0x104c: lg_map_key_clear(KEY_PROG4); break;
	186
	187	default:
	188	return 0;
	189	}
	190	return 1;
	191	}
	192
	193	static int lg_input_mapping(struct hid_device hdev, struct hid_input hi,
	194	struct hid_field field, struct hid_usage usage,
	195	unsigned long *bit, int max)
	196	{
	197	/* extended mapping for certain Logitech hardware (Logitech cordless
	198	desktop LX500) */
	199	static const u8 e_keymap[] = {
	200	0,216, 0,213,175,156, 0, 0, 0, 0,
	201	144, 0, 0, 0, 0, 0, 0, 0, 0,212,
	202	174,167,152,161,112, 0, 0, 0,154, 0,
	203	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	204	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	205	0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	206	0, 0, 0, 0, 0,183,184,185,186,187,
	207	188,189,190,191,192,193,194, 0, 0, 0
	208	};
	209	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	210	unsigned int hid = usage->hid;
	211
	212	if (hdev->product == USB_DEVICE_ID_LOGITECH_RECEIVER &&
	213	lg_ultrax_remote_mapping(hi, usage, bit, max))
	214	return 1;
	215
66d61bec JK	216	if (hdev->product == USB_DEVICE_ID_DINOVO_MINI &&
	217	lg_dinovo_mapping(hi, usage, bit, max))
	218	return 1;
	219
5f22a799 JS	220	if ((quirks & LG_WIRELESS) && lg_wireless_mapping(hi, usage, bit, max))
	221	return 1;
	222
	223	if ((hid & HID_USAGE_PAGE) != HID_UP_BUTTON)
	224	return 0;
	225
	226	hid &= HID_USAGE;
	227
	228	/* Special handling for Logitech Cordless Desktop */
	229	if (field->application == HID_GD_MOUSE) {
	230	if ((quirks & LG_IGNORE_DOUBLED_WHEEL) &&
	231	(hid == 7 \|\| hid == 8))
	232	return -1;
	233	} else {
	234	if ((quirks & LG_EXPANDED_KEYMAP) &&
	235	hid < ARRAY_SIZE(e_keymap) &&
	236	e_keymap[hid] != 0) {
	237	hid_map_usage(hi, usage, bit, max, EV_KEY,
	238	e_keymap[hid]);
	239	return 1;
	240	}
	241	}
	242
	243	return 0;
	244	}
	245
	246	static int lg_input_mapped(struct hid_device hdev, struct hid_input hi,
	247	struct hid_field field, struct hid_usage usage,
	248	unsigned long *bit, int max)
	249	{
	250	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	251
	252	if ((quirks & LG_BAD_RELATIVE_KEYS) && usage->type == EV_KEY &&
	253	(field->flags & HID_MAIN_ITEM_RELATIVE))
	254	field->flags &= ~HID_MAIN_ITEM_RELATIVE;
	255
	256	if ((quirks & LG_DUPLICATE_USAGES) && (usage->type == EV_KEY \|\|
	257	usage->type == EV_REL \|\| usage->type == EV_ABS))
	258	clear_bit(usage->code, *bit);
	259
	260	return 0;
	261	}
	262
	263	static int lg_event(struct hid_device hdev, struct hid_field field,
	264	struct hid_usage *usage, __s32 value)
	265	{
	266	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	267
	268	if ((quirks & LG_INVERT_HWHEEL) && usage->code == REL_HWHEEL) {
	269	input_event(field->hidinput->input, usage->type, usage->code,
	270	-value);
	271	return 1;
	272	}
	273
	274	return 0;
	275	}
	276
	277	static int lg_probe(struct hid_device hdev, const struct hid_device_id id)
	278	{
	279	unsigned long quirks = id->driver_data;
606bd0a8	280	unsigned int connect_mask = HID_CONNECT_DEFAULT;
5f22a799 JS	281	int ret;
	282
	283	hid_set_drvdata(hdev, (void *)quirks);
	284
5f22a799 JS	285	if (quirks & LG_NOGET)
	286	hdev->quirks \|= HID_QUIRK_NOGET;
	287
	288	ret = hid_parse(hdev);
	289	if (ret) {
	290	dev_err(&hdev->dev, "parse failed\n");
	291	goto err_free;
	292	}
	293
74f292ca	294	if (quirks & (LG_FF \| LG_FF2 \| LG_FF3))
606bd0a8 JS	295	connect_mask &= ~HID_CONNECT_FF;
	296
	297	ret = hid_hw_start(hdev, connect_mask);
5f22a799 JS	298	if (ret) {
	299	dev_err(&hdev->dev, "hw start failed\n");
	300	goto err_free;
	301	}
	302
32c88cbc SW	303	if (quirks & LG_FF4) {
	304	unsigned char buf[] = { 0x00, 0xAF, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
	305
	306	ret = hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
	307
	308	if (ret >= 0) {
	309	/* insert a little delay of 10 jiffies ~ 40ms */
	310	wait_queue_head_t wait;
	311	init_waitqueue_head (&wait);
	312	wait_event_interruptible_timeout(wait, 0, 10);
	313
	314	/* Select random Address */
	315	buf[1] = 0xB2;
	316	get_random_bytes(&buf[2], 2);
	317
	318	ret = hdev->hid_output_raw_report(hdev, buf, sizeof(buf), HID_FEATURE_REPORT);
	319	}
	320	}
	321
606bd0a8 JS	322	if (quirks & LG_FF)
	323	lgff_init(hdev);
	324	if (quirks & LG_FF2)
	325	lg2ff_init(hdev);
74f292ca GS	326	if (quirks & LG_FF3)
74f292ca GS	327	lg3ff_init(hdev);
32c88cbc SW	328	if (quirks & LG_FF4)
32c88cbc SW	329	lg4ff_init(hdev);
606bd0a8	330
5f22a799 JS	331	return 0;
	332	err_free:
	333	return ret;
	334	}
	335
	336	static const struct hid_device_id lg_devices[] = {
	337	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_MX3000_RECEIVER),
	338	.driver_data = LG_RDESC \| LG_WIRELESS },
	339	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER),
	340	.driver_data = LG_RDESC \| LG_WIRELESS },
	341	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_S510_RECEIVER_2),
	342	.driver_data = LG_RDESC \| LG_WIRELESS },
	343
	344	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RECEIVER),
	345	.driver_data = LG_BAD_RELATIVE_KEYS },
	346
	347	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_DESKTOP),
	348	.driver_data = LG_DUPLICATE_USAGES },
	349	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_EDGE),
	350	.driver_data = LG_DUPLICATE_USAGES },
	351	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_DINOVO_MINI),
	352	.driver_data = LG_DUPLICATE_USAGES },
	353
5f22a799 JS	354	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_ELITE_KBD),
	355	.driver_data = LG_IGNORE_DOUBLED_WHEEL \| LG_EXPANDED_KEYMAP },
	356	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_CORDLESS_DESKTOP_LX500),
	357	.driver_data = LG_IGNORE_DOUBLED_WHEEL \| LG_EXPANDED_KEYMAP },
	358
5f22a799 JS	359	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_EXTREME_3D),
	360	.driver_data = LG_NOGET },
	361	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WHEEL),
606bd0a8 JS	362	.driver_data = LG_NOGET \| LG_FF },
	363
	364	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD),
	365	.driver_data = LG_FF },
	366	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2_2),
	367	.driver_data = LG_FF },
	368	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_F3D),
	369	.driver_data = LG_FF },
	370	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FORCE3D_PRO),
	371	.driver_data = LG_FF },
	372	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL),
	373	.driver_data = LG_FF },
	374	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_MOMO_WHEEL2),
	375	.driver_data = LG_FF },
243b706d CB	376	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_G25_WHEEL),
243b706d CB	377	.driver_data = LG_FF },
32c88cbc SW	378	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WII_WHEEL),
32c88cbc SW	379	.driver_data = LG_FF4 },
fd30ea8c JK	380	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_WINGMAN_FFG ),
fd30ea8c JK	381	.driver_data = LG_FF },
606bd0a8 JS	382	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_RUMBLEPAD2),
606bd0a8 JS	383	.driver_data = LG_FF2 },
74f292ca GS	384	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_LOGITECH_FLIGHT_SYSTEM_G940),
74f292ca GS	385	.driver_data = LG_FF3 },
24985cf6 JK	386	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACENAVIGATOR),
	387	.driver_data = LG_RDESC_REL_ABS },
	388	{ HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, USB_DEVICE_ID_SPACETRAVELLER),
	389	.driver_data = LG_RDESC_REL_ABS },
5f22a799 JS	390	{ }
5f22a799 JS	391	};
24985cf6	392
5f22a799 JS	393	MODULE_DEVICE_TABLE(hid, lg_devices);
	394
	395	static struct hid_driver lg_driver = {
	396	.name = "logitech",
	397	.id_table = lg_devices,
	398	.report_fixup = lg_report_fixup,
	399	.input_mapping = lg_input_mapping,
	400	.input_mapped = lg_input_mapped,
	401	.event = lg_event,
	402	.probe = lg_probe,
	403	};
	404
a24f423b	405	static int __init lg_init(void)
5f22a799 JS	406	{
	407	return hid_register_driver(&lg_driver);
	408	}
	409
a24f423b	410	static void __exit lg_exit(void)
5f22a799 JS	411	{
	412	hid_unregister_driver(&lg_driver);
	413	}
	414
	415	module_init(lg_init);
	416	module_exit(lg_exit);
	417	MODULE_LICENSE("GPL");