[mirror_ubuntu-eoan-kernel.git] / drivers / hid / usbhid / hid-quirks.c

/*
 *  USB HID quirks support for Linux
 *
 *  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
 */

/*
 * 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/hid.h>

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

/*
 * Alphabetically sorted blacklist by quirk type.
 */

static const struct hid_blacklist {
	__u16 idVendor;
	__u16 idProduct;
	__u32 quirks;
} hid_blacklist[] = {
	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
	{ USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },

	{ USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },

	{ USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },

	{ USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
	{ USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },

	{ USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },

	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },

	{ USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },

	{ USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },

	{ 0, 0 }
};

/* Quirks for devices which require report descriptor fixup go here */
static const struct hid_rdesc_blacklist {
	__u16 idVendor;
	__u16 idProduct;
	__u32 quirks;
} hid_rdesc_blacklist[] = {
	{ USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },

	{ USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },

	{ USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },

	{ 0, 0 }
};

/* Dynamic HID quirks list - specified at runtime */
struct quirks_list_struct {
	struct hid_blacklist hid_bl_item;
	struct list_head node;
};

static LIST_HEAD(dquirks_list);
static DECLARE_RWSEM(dquirks_rwsem);

/* Runtime ("dynamic") quirks manipulation functions */

/**
 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 * @idProduct: the 16-bit USB product ID, in native byteorder
 *
 * Description:
 *         Scans dquirks_list for a matching dynamic quirk and returns
 *         the pointer to the relevant struct hid_blacklist if found.
 *         Must be called with a read lock held on dquirks_rwsem.
 *
 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 */
static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
		const u16 idProduct)
{
	struct quirks_list_struct *q;
	struct hid_blacklist *bl_entry = NULL;

	list_for_each_entry(q, &dquirks_list, node) {
		if (q->hid_bl_item.idVendor == idVendor &&
				q->hid_bl_item.idProduct == idProduct) {
			bl_entry = &q->hid_bl_item;
			break;
		}
	}

	if (bl_entry != NULL)
		dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
				bl_entry->quirks, bl_entry->idVendor,
				bl_entry->idProduct);

	return bl_entry;
}


/**
 * usbhid_modify_dquirk: add/replace a HID quirk
 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 * @idProduct: the 16-bit USB product ID, in native byteorder
 * @quirks: the u32 quirks value to add/replace
 *
 * Description:
 *         If an dynamic quirk exists in memory for this (idVendor,
 *         idProduct) pair, replace its quirks value with what was
 *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 *
 * Returns: 0 OK, -error on failure.
 */
static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
				const u32 quirks)
{
	struct quirks_list_struct *q_new, *q;
	int list_edited = 0;

	if (!idVendor) {
		dbg_hid("Cannot add a quirk with idVendor = 0\n");
		return -EINVAL;
	}

	q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
	if (!q_new) {
		dbg_hid("Could not allocate quirks_list_struct\n");
		return -ENOMEM;
	}

	q_new->hid_bl_item.idVendor = idVendor;
	q_new->hid_bl_item.idProduct = idProduct;
	q_new->hid_bl_item.quirks = quirks;

	down_write(&dquirks_rwsem);

	list_for_each_entry(q, &dquirks_list, node) {

		if (q->hid_bl_item.idVendor == idVendor &&
				q->hid_bl_item.idProduct == idProduct) {

			list_replace(&q->node, &q_new->node);
			kfree(q);
			list_edited = 1;
			break;

		}

	}

	if (!list_edited)
		list_add_tail(&q_new->node, &dquirks_list);

	up_write(&dquirks_rwsem);

	return 0;
}

/**
 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 *
 * Description:
 *         Free all memory associated with dynamic quirks - called before
 *         module unload.
 *
 */
static void usbhid_remove_all_dquirks(void)
{
	struct quirks_list_struct *q, *temp;

	down_write(&dquirks_rwsem);
	list_for_each_entry_safe(q, temp, &dquirks_list, node) {
		list_del(&q->node);
		kfree(q);
	}
	up_write(&dquirks_rwsem);

}

/** 
 * usbhid_quirks_init: apply USB HID quirks specified at module load time
 */
int usbhid_quirks_init(char **quirks_param)
{
	u16 idVendor, idProduct;
	u32 quirks;
	int n = 0, m;

	for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {

		m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
				&idVendor, &idProduct, &quirks);

		if (m != 3 ||
				usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
			printk(KERN_WARNING
					"Could not parse HID quirk module param %s\n",
					quirks_param[n]);
		}
	}

	return 0;
}

/**
 * usbhid_quirks_exit: release memory associated with dynamic_quirks
 *
 * Description:
 *     Release all memory associated with dynamic quirks.  Called upon
 *     module unload.
 *
 * Returns: nothing
 */
void usbhid_quirks_exit(void)
{
	usbhid_remove_all_dquirks();
}

/**
 * usbhid_exists_squirk: return any static quirks for a USB HID device
 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 * @idProduct: the 16-bit USB product ID, in native byteorder
 *
 * Description:
 *     Given a USB vendor ID and product ID, return a pointer to
 *     the hid_blacklist entry associated with that device.
 *
 * Returns: pointer if quirk found, or NULL if no quirks found.
 */
static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
		const u16 idProduct)
{
	const struct hid_blacklist *bl_entry = NULL;
	int n = 0;

	for (; hid_blacklist[n].idVendor; n++)
		if (hid_blacklist[n].idVendor == idVendor &&
				hid_blacklist[n].idProduct == idProduct)
			bl_entry = &hid_blacklist[n];

	if (bl_entry != NULL)
		dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
				bl_entry->quirks, bl_entry->idVendor, 
				bl_entry->idProduct);
	return bl_entry;
}

/**
 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 * @idProduct: the 16-bit USB product ID, in native byteorder
 *
 * Description:
 *     Given a USB vendor ID and product ID, return any quirks associated
 *     with that device.
 *
 * Returns: a u32 quirks value.
 */
u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
{
	u32 quirks = 0;
	const struct hid_blacklist *bl_entry = NULL;

	/* NCR devices must not be queried for reports */
	if (idVendor == USB_VENDOR_ID_NCR &&
			idProduct >= USB_DEVICE_ID_NCR_FIRST &&
			idProduct <= USB_DEVICE_ID_NCR_LAST)
			return HID_QUIRK_NOGET;

	down_read(&dquirks_rwsem);
	bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
	if (!bl_entry)
		bl_entry = usbhid_exists_squirk(idVendor, idProduct);
	if (bl_entry)
		quirks = bl_entry->quirks;
	up_read(&dquirks_rwsem);

	return quirks;
}

EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);

/*
 * Samsung IrDA remote controller (reports as Cypress USB Mouse).
 *
 * Vendor specific report #4 has a size of 48 bit,
 * and therefore is not accepted when inspecting the descriptors.
 * As a workaround we reinterpret the report as:
 *   Variable type, count 6, size 8 bit, log. maximum 255
 * The burden to reconstruct the data is moved into user space.
 */
static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
						  int rsize)
{
	if (rsize >= 182 && rdesc[175] == 0x25
			 && rdesc[176] == 0x40
			 && rdesc[177] == 0x75
			 && rdesc[178] == 0x30
			 && rdesc[179] == 0x95
			 && rdesc[180] == 0x01
			 && rdesc[182] == 0x40) {
		printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
		rdesc[176] = 0xff;
		rdesc[178] = 0x08;
		rdesc[180] = 0x06;
		rdesc[182] = 0x42;
	}
}

/* Petalynx Maxter Remote has maximum for consumer page set too low */
static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
{
	if (rsize >= 60 && rdesc[39] == 0x2a
			&& rdesc[40] == 0xf5
			&& rdesc[41] == 0x00
			&& rdesc[59] == 0x26
			&& rdesc[60] == 0xf9
			&& rdesc[61] == 0x00) {
		printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
		rdesc[60] = 0xfa;
		rdesc[40] = 0xfa;
	}
}

static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
{
	if (rsize >= 30 && rdesc[29] == 0x05
			&& rdesc[30] == 0x09) {
		printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
		rdesc[30] = 0x0c;
	}
}

static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
{
	if (quirks & HID_QUIRK_RDESC_PETALYNX)
		usbhid_fixup_petalynx_descriptor(rdesc, rsize);

	if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
		usbhid_fixup_button_consumer_descriptor(rdesc, rsize);

	if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
		usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
}

/**
 * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
 *
 * Description:
 *	Walks the hid_rdesc_blacklist[] array and checks whether the device
 *	is known to have broken report descriptor that needs to be fixed up
 *	prior to entering the HID parser
 *
 * Returns: nothing
 */
void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
				    char *rdesc, unsigned rsize, char **quirks_param)
{
	int n, m;
	u16 paramVendor, paramProduct;
	u32 quirks;

	/* static rdesc quirk entries */
	for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
		if (hid_rdesc_blacklist[n].idVendor == idVendor &&
				hid_rdesc_blacklist[n].idProduct == idProduct)
			__usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
					rdesc, rsize);

	/* runtime rdesc quirk entries handling */
	for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
		m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
				&paramVendor, &paramProduct, &quirks);

		if (m != 3)
			printk(KERN_WARNING
				"Could not parse HID quirk module param %s\n",
				quirks_param[n]);
		else if (paramVendor == idVendor && paramProduct == idProduct)
			__usbhid_fixup_report_descriptor(quirks, rdesc, rsize);
	}
}
Commit	Line	Data
2eb5dc30 PW	1	/*
	2	* USB HID quirks support for Linux
	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	*/
	10
	11	/*
	12	* This program is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by the Free
	14	* Software Foundation; either version 2 of the License, or (at your option)
	15	* any later version.
	16	*/
	17
	18	#include <linux/hid.h>
	19
990436a7	20	#include "../hid-ids.h"
a32bcc45	21
2eb5dc30 PW	22	/*
	23	* Alphabetically sorted blacklist by quirk type.
	24	*/
	25
	26	static const struct hid_blacklist {
	27	__u16 idVendor;
	28	__u16 idProduct;
	29	__u32 quirks;
	30	} hid_blacklist[] = {
2eb5dc30 PW	31	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
	32	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
	33	{ USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
	34	{ USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
1b3ebe93	35	{ USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
2eb5dc30 PW	36	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
	37	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
	38	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
c9bde7ad	39	{ USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
2eb5dc30 PW	40	{ USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
	41	{ USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
	42	{ USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
2c3e3bfb	43
f345c37c PS	44	{ USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
f345c37c PS	45
efa0f16b	46	{ USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV \| HID_QUIRK_IGNORE_HIDINPUT },
2eb5dc30	47
2eb5dc30 PW	48	{ USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT \| HID_QUIRK_SKIP_OUTPUT_REPORTS },
	49	{ USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
	50
0887b4cb	51	{ USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER \| HID_QUIRK_HIDDEV },
2eb5dc30 PW	52
	53	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
	54	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
	55	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
	56	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
	57	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
02008faa	58	{ USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
d500d116	59	{ USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
ea9a4a8b	60	{ USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
2eb5dc30 PW	61	{ USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
2eb5dc30 PW	62	{ USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
3e52a05f	63	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT \| HID_QUIRK_SKIP_OUTPUT_REPORTS },
2eb5dc30 PW	64	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT },
	65
	66	{ USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT },
	67
2eb5dc30 PW	68	{ USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
2eb5dc30 PW	69
ea9a4a8b JK	70	{ 0, 0 }
	71	};
	72
	73	/* Quirks for devices which require report descriptor fixup go here */
	74	static const struct hid_rdesc_blacklist {
	75	__u16 idVendor;
	76	__u16 idProduct;
	77	__u32 quirks;
	78	} hid_rdesc_blacklist[] = {
af9e0eac JK	79	{ USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
af9e0eac JK	80
ea9a4a8b JK	81	{ USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
ea9a4a8b JK	82
fe56caa9 RS	83	{ USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
fe56caa9 RS	84
2eb5dc30 PW	85	{ 0, 0 }
2eb5dc30 PW	86	};
8cef9082 PW	87
	88	/* Dynamic HID quirks list - specified at runtime */
	89	struct quirks_list_struct {
	90	struct hid_blacklist hid_bl_item;
	91	struct list_head node;
	92	};
	93
	94	static LIST_HEAD(dquirks_list);
	95	static DECLARE_RWSEM(dquirks_rwsem);
	96
	97	/* Runtime ("dynamic") quirks manipulation functions */
	98
8222fbe6	99	/**
8cef9082 PW	100	* usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
	101	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	102	* @idProduct: the 16-bit USB product ID, in native byteorder
	103	*
	104	* Description:
	105	* Scans dquirks_list for a matching dynamic quirk and returns
	106	* the pointer to the relevant struct hid_blacklist if found.
	107	* Must be called with a read lock held on dquirks_rwsem.
	108	*
	109	* Returns: NULL if no quirk found, struct hid_blacklist * if found.
	110	*/
	111	static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
	112	const u16 idProduct)
	113	{
	114	struct quirks_list_struct *q;
	115	struct hid_blacklist *bl_entry = NULL;
	116
8cef9082 PW	117	list_for_each_entry(q, &dquirks_list, node) {
	118	if (q->hid_bl_item.idVendor == idVendor &&
	119	q->hid_bl_item.idProduct == idProduct) {
	120	bl_entry = &q->hid_bl_item;
	121	break;
	122	}
	123	}
	124
	125	if (bl_entry != NULL)
58037eb9	126	dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8cef9082 PW	127	bl_entry->quirks, bl_entry->idVendor,
	128	bl_entry->idProduct);
	129
	130	return bl_entry;
	131	}
	132
	133
	134	/**
	135	* usbhid_modify_dquirk: add/replace a HID quirk
	136	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	137	* @idProduct: the 16-bit USB product ID, in native byteorder
	138	* @quirks: the u32 quirks value to add/replace
	139	*
	140	* Description:
	141	* If an dynamic quirk exists in memory for this (idVendor,
	142	* idProduct) pair, replace its quirks value with what was
	143	* provided. Otherwise, add the quirk to the dynamic quirks list.
	144	*
	145	* Returns: 0 OK, -error on failure.
	146	*/
abdff0f7 AB	147	static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
abdff0f7 AB	148	const u32 quirks)
8cef9082 PW	149	{
	150	struct quirks_list_struct q_new, q;
	151	int list_edited = 0;
	152
	153	if (!idVendor) {
58037eb9	154	dbg_hid("Cannot add a quirk with idVendor = 0\n");
8cef9082 PW	155	return -EINVAL;
	156	}
	157
	158	q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
	159	if (!q_new) {
58037eb9	160	dbg_hid("Could not allocate quirks_list_struct\n");
8cef9082 PW	161	return -ENOMEM;
	162	}
	163
	164	q_new->hid_bl_item.idVendor = idVendor;
	165	q_new->hid_bl_item.idProduct = idProduct;
	166	q_new->hid_bl_item.quirks = quirks;
	167
	168	down_write(&dquirks_rwsem);
	169
	170	list_for_each_entry(q, &dquirks_list, node) {
	171
	172	if (q->hid_bl_item.idVendor == idVendor &&
	173	q->hid_bl_item.idProduct == idProduct) {
	174
	175	list_replace(&q->node, &q_new->node);
	176	kfree(q);
	177	list_edited = 1;
	178	break;
	179
	180	}
	181
	182	}
	183
	184	if (!list_edited)
	185	list_add_tail(&q_new->node, &dquirks_list);
	186
	187	up_write(&dquirks_rwsem);
	188
	189	return 0;
	190	}
	191
8cef9082 PW	192	/**
	193	* usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
	194	*
	195	* Description:
	196	* Free all memory associated with dynamic quirks - called before
	197	* module unload.
	198	*
	199	*/
	200	static void usbhid_remove_all_dquirks(void)
	201	{
	202	struct quirks_list_struct q, temp;
	203
	204	down_write(&dquirks_rwsem);
	205	list_for_each_entry_safe(q, temp, &dquirks_list, node) {
	206	list_del(&q->node);
	207	kfree(q);
	208	}
	209	up_write(&dquirks_rwsem);
	210
	211	}
	212
876b9276 PW	213	/**
	214	* usbhid_quirks_init: apply USB HID quirks specified at module load time
	215	*/
	216	int usbhid_quirks_init(char **quirks_param)
	217	{
	218	u16 idVendor, idProduct;
	219	u32 quirks;
	220	int n = 0, m;
	221
	222	for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
	223
	224	m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
	225	&idVendor, &idProduct, &quirks);
	226
	227	if (m != 3 \|\|
	228	usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
	229	printk(KERN_WARNING
	230	"Could not parse HID quirk module param %s\n",
	231	quirks_param[n]);
	232	}
	233	}
	234
	235	return 0;
	236	}
	237
	238	/**
	239	* usbhid_quirks_exit: release memory associated with dynamic_quirks
	240	*
	241	* Description:
	242	* Release all memory associated with dynamic quirks. Called upon
	243	* module unload.
	244	*
	245	* Returns: nothing
	246	*/
	247	void usbhid_quirks_exit(void)
	248	{
	249	usbhid_remove_all_dquirks();
	250	}
8cef9082 PW	251
	252	/**
	253	* usbhid_exists_squirk: return any static quirks for a USB HID device
	254	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	255	* @idProduct: the 16-bit USB product ID, in native byteorder
	256	*
	257	* Description:
	258	* Given a USB vendor ID and product ID, return a pointer to
	259	* the hid_blacklist entry associated with that device.
	260	*
	261	* Returns: pointer if quirk found, or NULL if no quirks found.
	262	*/
8222fbe6	263	static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
8cef9082	264	const u16 idProduct)
8222fbe6	265	{
8cef9082 PW	266	const struct hid_blacklist *bl_entry = NULL;
8cef9082 PW	267	int n = 0;
8222fbe6 PW	268
	269	for (; hid_blacklist[n].idVendor; n++)
	270	if (hid_blacklist[n].idVendor == idVendor &&
	271	hid_blacklist[n].idProduct == idProduct)
	272	bl_entry = &hid_blacklist[n];
	273
	274	if (bl_entry != NULL)
58037eb9	275	dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8222fbe6 PW	276	bl_entry->quirks, bl_entry->idVendor,
	277	bl_entry->idProduct);
	278	return bl_entry;
	279	}
2eb5dc30 PW	280
	281	/**
	282	* usbhid_lookup_quirk: return any quirks associated with a USB HID device
	283	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	284	* @idProduct: the 16-bit USB product ID, in native byteorder
	285	*
	286	* Description:
	287	* Given a USB vendor ID and product ID, return any quirks associated
	288	* with that device.
	289	*
	290	* Returns: a u32 quirks value.
	291	*/
	292	u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
	293	{
	294	u32 quirks = 0;
8222fbe6	295	const struct hid_blacklist *bl_entry = NULL;
2eb5dc30	296
b8e98f1c JK	297	/* NCR devices must not be queried for reports */
	298	if (idVendor == USB_VENDOR_ID_NCR &&
	299	idProduct >= USB_DEVICE_ID_NCR_FIRST &&
	300	idProduct <= USB_DEVICE_ID_NCR_LAST)
	301	return HID_QUIRK_NOGET;
	302
8cef9082 PW	303	down_read(&dquirks_rwsem);
	304	bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
	305	if (!bl_entry)
	306	bl_entry = usbhid_exists_squirk(idVendor, idProduct);
8222fbe6 PW	307	if (bl_entry)
8222fbe6 PW	308	quirks = bl_entry->quirks;
8cef9082 PW	309	up_read(&dquirks_rwsem);
8cef9082 PW	310
2eb5dc30 PW	311	return quirks;
2eb5dc30 PW	312	}
8222fbe6	313
9f6b3727 PT	314	EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
9f6b3727 PT	315
fe56caa9 RS	316	/*
	317	* Samsung IrDA remote controller (reports as Cypress USB Mouse).
	318	*
	319	* Vendor specific report #4 has a size of 48 bit,
	320	* and therefore is not accepted when inspecting the descriptors.
	321	* As a workaround we reinterpret the report as:
	322	* Variable type, count 6, size 8 bit, log. maximum 255
	323	* The burden to reconstruct the data is moved into user space.
	324	*/
	325	static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
	326	int rsize)
	327	{
	328	if (rsize >= 182 && rdesc[175] == 0x25
	329	&& rdesc[176] == 0x40
	330	&& rdesc[177] == 0x75
	331	&& rdesc[178] == 0x30
	332	&& rdesc[179] == 0x95
	333	&& rdesc[180] == 0x01
	334	&& rdesc[182] == 0x40) {
	335	printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
	336	rdesc[176] = 0xff;
	337	rdesc[178] = 0x08;
	338	rdesc[180] = 0x06;
	339	rdesc[182] = 0x42;
	340	}
	341	}
	342
ea9a4a8b JK	343	/* Petalynx Maxter Remote has maximum for consumer page set too low */
	344	static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
	345	{
	346	if (rsize >= 60 && rdesc[39] == 0x2a
	347	&& rdesc[40] == 0xf5
	348	&& rdesc[41] == 0x00
	349	&& rdesc[59] == 0x26
	350	&& rdesc[60] == 0xf9
	351	&& rdesc[61] == 0x00) {
	352	printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
	353	rdesc[60] = 0xfa;
	354	rdesc[40] = 0xfa;
	355	}
	356	}
	357
af9e0eac JK	358	static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
	359	{
	360	if (rsize >= 30 && rdesc[29] == 0x05
	361	&& rdesc[30] == 0x09) {
	362	printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
	363	rdesc[30] = 0x0c;
	364	}
	365	}
ea9a4a8b JK	366
	367	static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
	368	{
ea9a4a8b JK	369	if (quirks & HID_QUIRK_RDESC_PETALYNX)
ea9a4a8b JK	370	usbhid_fixup_petalynx_descriptor(rdesc, rsize);
08f06177	371
af9e0eac JK	372	if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
af9e0eac JK	373	usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
fe56caa9 RS	374
	375	if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
	376	usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
ea9a4a8b JK	377	}
	378
	379	/**
	380	* usbhid_fixup_report_descriptor: check if report descriptor needs fixup
	381	*
	382	* Description:
	383	* Walks the hid_rdesc_blacklist[] array and checks whether the device
	384	* is known to have broken report descriptor that needs to be fixed up
	385	* prior to entering the HID parser
	386	*
	387	* Returns: nothing
	388	*/
	389	void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
	390	char rdesc, unsigned rsize, char *quirks_param)
	391	{
	392	int n, m;
	393	u16 paramVendor, paramProduct;
	394	u32 quirks;
	395
	396	/* static rdesc quirk entries */
	397	for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
	398	if (hid_rdesc_blacklist[n].idVendor == idVendor &&
	399	hid_rdesc_blacklist[n].idProduct == idProduct)
	400	__usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
	401	rdesc, rsize);
	402
	403	/* runtime rdesc quirk entries handling */
	404	for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
	405	m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
	406	&paramVendor, &paramProduct, &quirks);
	407
	408	if (m != 3)
	409	printk(KERN_WARNING
	410	"Could not parse HID quirk module param %s\n",
	411	quirks_param[n]);
	412	else if (paramVendor == idVendor && paramProduct == idProduct)
	413	__usbhid_fixup_report_descriptor(quirks, rdesc, rsize);
	414	}
ea9a4a8b	415	}