[linux-2.6-block.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 <linux/slab.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_DWAV, USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH, HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, 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_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
	{ 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_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
	{ 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_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },

	{ 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_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, 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_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
	{ USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, 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_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
	{ USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
	{ 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_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },

	{ USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },

	{ 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 (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; 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_NO_INIT_REPORTS;

	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);
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>
5a0e3ad6	19	#include <linux/slab.h>
2eb5dc30	20
990436a7	21	#include "../hid-ids.h"
a32bcc45	22
2eb5dc30 PW	23	/*
	24	* Alphabetically sorted blacklist by quirk type.
	25	*/
	26
	27	static const struct hid_blacklist {
	28	__u16 idVendor;
	29	__u16 idProduct;
	30	__u32 quirks;
	31	} hid_blacklist[] = {
2eb5dc30 PW	32	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
	33	{ USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
	34	{ USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
	35	{ USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
77933c35	36	{ USB_VENDOR_ID_DWAV, USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH, HID_QUIRK_MULTI_INPUT },
1f45e324	37	{ USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
2eb5dc30 PW	38	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
	39	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
	40	{ USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD \| HID_QUIRK_MULTI_INPUT },
c9bde7ad	41	{ USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
2eb5dc30	42	{ USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
9db630b4	43	{ USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
2eb5dc30 PW	44	{ USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
2eb5dc30 PW	45	{ USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
2c3e3bfb	46
f345c37c PS	47	{ USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
f345c37c PS	48
8127f4e8	49	{ USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
2eb5dc30 PW	50	{ USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT \| HID_QUIRK_SKIP_OUTPUT_REPORTS },
2eb5dc30 PW	51	{ USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
c2c3489c	52	{ USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
2eb5dc30	53
2eb5dc30 PW	54	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
	55	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
	56	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
	57	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
	58	{ USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
b820aabf	59	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
c8e84646	60	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
b820aabf AS	61	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
b820aabf AS	62	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
73cdcf56	63	{ USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
02008faa	64	{ USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
d500d116	65	{ USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
c2c3489c	66	{ USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
c565c54d	67	{ USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
2eb5dc30 PW	68	{ USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
2eb5dc30 PW	69	{ USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
25e61613	70	{ USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
f8a489cc NK	71	{ USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
f8a489cc NK	72	{ USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
3e52a05f	73	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT \| HID_QUIRK_SKIP_OUTPUT_REPORTS },
2eb5dc30 PW	74	{ USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT },
	75
	76	{ USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT },
66ebf66e	77	{ USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET \| HID_QUIRK_MULTI_INPUT },
2eb5dc30	78
70c7c9c4 DM	79	{ USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
70c7c9c4 DM	80
ea9a4a8b JK	81	{ 0, 0 }
	82	};
	83
8cef9082 PW	84	/* Dynamic HID quirks list - specified at runtime */
	85	struct quirks_list_struct {
	86	struct hid_blacklist hid_bl_item;
	87	struct list_head node;
	88	};
	89
	90	static LIST_HEAD(dquirks_list);
	91	static DECLARE_RWSEM(dquirks_rwsem);
	92
	93	/* Runtime ("dynamic") quirks manipulation functions */
	94
8222fbe6	95	/**
8cef9082 PW	96	* usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
	97	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	98	* @idProduct: the 16-bit USB product ID, in native byteorder
	99	*
	100	* Description:
	101	* Scans dquirks_list for a matching dynamic quirk and returns
	102	* the pointer to the relevant struct hid_blacklist if found.
	103	* Must be called with a read lock held on dquirks_rwsem.
	104	*
	105	* Returns: NULL if no quirk found, struct hid_blacklist * if found.
	106	*/
	107	static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
	108	const u16 idProduct)
	109	{
	110	struct quirks_list_struct *q;
	111	struct hid_blacklist *bl_entry = NULL;
	112
8cef9082 PW	113	list_for_each_entry(q, &dquirks_list, node) {
	114	if (q->hid_bl_item.idVendor == idVendor &&
	115	q->hid_bl_item.idProduct == idProduct) {
	116	bl_entry = &q->hid_bl_item;
	117	break;
	118	}
	119	}
	120
	121	if (bl_entry != NULL)
58037eb9	122	dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8cef9082 PW	123	bl_entry->quirks, bl_entry->idVendor,
	124	bl_entry->idProduct);
	125
	126	return bl_entry;
	127	}
	128
	129
	130	/**
	131	* usbhid_modify_dquirk: add/replace a HID quirk
	132	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	133	* @idProduct: the 16-bit USB product ID, in native byteorder
	134	* @quirks: the u32 quirks value to add/replace
	135	*
	136	* Description:
	137	* If an dynamic quirk exists in memory for this (idVendor,
	138	* idProduct) pair, replace its quirks value with what was
	139	* provided. Otherwise, add the quirk to the dynamic quirks list.
	140	*
	141	* Returns: 0 OK, -error on failure.
	142	*/
abdff0f7 AB	143	static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
abdff0f7 AB	144	const u32 quirks)
8cef9082 PW	145	{
	146	struct quirks_list_struct q_new, q;
	147	int list_edited = 0;
	148
	149	if (!idVendor) {
58037eb9	150	dbg_hid("Cannot add a quirk with idVendor = 0\n");
8cef9082 PW	151	return -EINVAL;
	152	}
	153
	154	q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
	155	if (!q_new) {
58037eb9	156	dbg_hid("Could not allocate quirks_list_struct\n");
8cef9082 PW	157	return -ENOMEM;
	158	}
	159
	160	q_new->hid_bl_item.idVendor = idVendor;
	161	q_new->hid_bl_item.idProduct = idProduct;
	162	q_new->hid_bl_item.quirks = quirks;
	163
	164	down_write(&dquirks_rwsem);
	165
	166	list_for_each_entry(q, &dquirks_list, node) {
	167
	168	if (q->hid_bl_item.idVendor == idVendor &&
	169	q->hid_bl_item.idProduct == idProduct) {
	170
	171	list_replace(&q->node, &q_new->node);
	172	kfree(q);
	173	list_edited = 1;
	174	break;
	175
	176	}
	177
	178	}
	179
	180	if (!list_edited)
	181	list_add_tail(&q_new->node, &dquirks_list);
	182
	183	up_write(&dquirks_rwsem);
	184
	185	return 0;
	186	}
	187
8cef9082 PW	188	/**
	189	* usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
	190	*
	191	* Description:
	192	* Free all memory associated with dynamic quirks - called before
	193	* module unload.
	194	*
	195	*/
	196	static void usbhid_remove_all_dquirks(void)
	197	{
	198	struct quirks_list_struct q, temp;
	199
	200	down_write(&dquirks_rwsem);
	201	list_for_each_entry_safe(q, temp, &dquirks_list, node) {
	202	list_del(&q->node);
	203	kfree(q);
	204	}
	205	up_write(&dquirks_rwsem);
	206
	207	}
	208
876b9276 PW	209	/**
	210	* usbhid_quirks_init: apply USB HID quirks specified at module load time
	211	*/
	212	int usbhid_quirks_init(char **quirks_param)
	213	{
	214	u16 idVendor, idProduct;
	215	u32 quirks;
	216	int n = 0, m;
	217
44cb2db1	218	for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
876b9276 PW	219
	220	m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
	221	&idVendor, &idProduct, &quirks);
	222
	223	if (m != 3 \|\|
	224	usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
	225	printk(KERN_WARNING
	226	"Could not parse HID quirk module param %s\n",
	227	quirks_param[n]);
	228	}
	229	}
	230
	231	return 0;
	232	}
	233
	234	/**
	235	* usbhid_quirks_exit: release memory associated with dynamic_quirks
	236	*
	237	* Description:
	238	* Release all memory associated with dynamic quirks. Called upon
	239	* module unload.
	240	*
	241	* Returns: nothing
	242	*/
	243	void usbhid_quirks_exit(void)
	244	{
	245	usbhid_remove_all_dquirks();
	246	}
8cef9082 PW	247
	248	/**
	249	* usbhid_exists_squirk: return any static quirks for a USB HID device
	250	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	251	* @idProduct: the 16-bit USB product ID, in native byteorder
	252	*
	253	* Description:
	254	* Given a USB vendor ID and product ID, return a pointer to
	255	* the hid_blacklist entry associated with that device.
	256	*
	257	* Returns: pointer if quirk found, or NULL if no quirks found.
	258	*/
8222fbe6	259	static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
8cef9082	260	const u16 idProduct)
8222fbe6	261	{
8cef9082 PW	262	const struct hid_blacklist *bl_entry = NULL;
8cef9082 PW	263	int n = 0;
8222fbe6 PW	264
	265	for (; hid_blacklist[n].idVendor; n++)
	266	if (hid_blacklist[n].idVendor == idVendor &&
	267	hid_blacklist[n].idProduct == idProduct)
	268	bl_entry = &hid_blacklist[n];
	269
	270	if (bl_entry != NULL)
58037eb9	271	dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8222fbe6 PW	272	bl_entry->quirks, bl_entry->idVendor,
	273	bl_entry->idProduct);
	274	return bl_entry;
	275	}
2eb5dc30 PW	276
	277	/**
	278	* usbhid_lookup_quirk: return any quirks associated with a USB HID device
	279	* @idVendor: the 16-bit USB vendor ID, in native byteorder
	280	* @idProduct: the 16-bit USB product ID, in native byteorder
	281	*
	282	* Description:
	283	* Given a USB vendor ID and product ID, return any quirks associated
	284	* with that device.
	285	*
	286	* Returns: a u32 quirks value.
	287	*/
	288	u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
	289	{
	290	u32 quirks = 0;
8222fbe6	291	const struct hid_blacklist *bl_entry = NULL;
2eb5dc30	292
b8e98f1c JK	293	/* NCR devices must not be queried for reports */
	294	if (idVendor == USB_VENDOR_ID_NCR &&
	295	idProduct >= USB_DEVICE_ID_NCR_FIRST &&
	296	idProduct <= USB_DEVICE_ID_NCR_LAST)
5b915d9e	297	return HID_QUIRK_NO_INIT_REPORTS;
b8e98f1c	298
8cef9082 PW	299	down_read(&dquirks_rwsem);
	300	bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
	301	if (!bl_entry)
	302	bl_entry = usbhid_exists_squirk(idVendor, idProduct);
8222fbe6 PW	303	if (bl_entry)
8222fbe6 PW	304	quirks = bl_entry->quirks;
8cef9082 PW	305	up_read(&dquirks_rwsem);
8cef9082 PW	306
2eb5dc30 PW	307	return quirks;
2eb5dc30 PW	308	}
8222fbe6	309
9f6b3727	310	EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);