[linux.git] / drivers / hid / hid-samsung.c

/*
 *  HID driver for some samsung "special" devices
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2005 Vojtech Pavlik <[email protected]>
 *  Copyright (c) 2005 Michael Haboustak <[email protected]> for Concept2, Inc
 *  Copyright (c) 2006-2007 Jiri Kosina
 *  Copyright (c) 2008 Jiri Slaby
 *  Copyright (c) 2010 Don Prince <[email protected]>
 *
 *
 *  This driver supports several HID devices:
 *
 *  [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
 *	various hid report fixups for different variants.
 *
 *  [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
 *	several key mappings used from the consumer usage page
 *	deviate from the USB HUT 1.12 standard.
 *
 */

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

#include "hid-ids.h"

/*
 * There are several variants for 0419:0001:
 *
 * 1. 184 byte report descriptor
 * 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.
 *
 * 2. 203 byte report descriptor
 * Report #4 has an array field with logical range 0..18 instead of 1..15.
 *
 * 3. 135 byte report descriptor
 * Report #4 has an array field with logical range 0..17 instead of 1..14.
 *
 * 4. 171 byte report descriptor
 * Report #3 has an array field with logical range 0..1 instead of 1..3.
 */
static inline void samsung_irda_dev_trace(struct hid_device *hdev,
		unsigned int rsize)
{
	hid_info(hdev, "fixing up Samsung IrDA %d byte report descriptor\n",
		 rsize);
}

static __u8 *samsung_irda_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
			rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
			rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
			rdesc[182] == 0x40) {
		samsung_irda_dev_trace(hdev, 184);
		rdesc[176] = 0xff;
		rdesc[178] = 0x08;
		rdesc[180] = 0x06;
		rdesc[182] = 0x42;
	} else
	if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
			rdesc[194] == 0x25 && rdesc[195] == 0x12) {
		samsung_irda_dev_trace(hdev, 203);
		rdesc[193] = 0x1;
		rdesc[195] = 0xf;
	} else
	if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
			rdesc[126] == 0x25 && rdesc[127] == 0x11) {
		samsung_irda_dev_trace(hdev, 135);
		rdesc[125] = 0x1;
		rdesc[127] = 0xe;
	} else
	if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
			rdesc[162] == 0x25 && rdesc[163] == 0x01) {
		samsung_irda_dev_trace(hdev, 171);
		rdesc[161] = 0x1;
		rdesc[163] = 0x3;
	}
	return rdesc;
}

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

static int samsung_kbd_mouse_input_mapping(struct hid_device *hdev,
	struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
	unsigned long **bit, int *max)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;

	if (1 != ifnum || HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
		return 0;

	dbg_hid("samsung wireless keyboard/mouse input mapping event [0x%x]\n",
		usage->hid & HID_USAGE);

	switch (usage->hid & HID_USAGE) {
	/* report 2 */
	case 0x183: samsung_kbd_mouse_map_key_clear(KEY_MEDIA); break;
	case 0x195: samsung_kbd_mouse_map_key_clear(KEY_EMAIL);	break;
	case 0x196: samsung_kbd_mouse_map_key_clear(KEY_CALC); break;
	case 0x197: samsung_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
	case 0x22b: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
	case 0x22c: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
	case 0x22d: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
	case 0x22e: samsung_kbd_mouse_map_key_clear(KEY_FORWARD); break;
	case 0x22f: samsung_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
	case 0x230: samsung_kbd_mouse_map_key_clear(KEY_REFRESH); break;
	case 0x231: samsung_kbd_mouse_map_key_clear(KEY_STOP); break;
	default:
		return 0;
	}

	return 1;
}

static __u8 *samsung_report_fixup(struct hid_device *hdev, __u8 *rdesc,
	unsigned int *rsize)
{
	if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
		rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
	return rdesc;
}

static int samsung_input_mapping(struct hid_device *hdev, struct hid_input *hi,
	struct hid_field *field, struct hid_usage *usage,
	unsigned long **bit, int *max)
{
	int ret = 0;

	if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
		ret = samsung_kbd_mouse_input_mapping(hdev,
			hi, field, usage, bit, max);

	return ret;
}

static int samsung_probe(struct hid_device *hdev,
		const struct hid_device_id *id)
{
	int ret;
	unsigned int cmask = HID_CONNECT_DEFAULT;

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "parse failed\n");
		goto err_free;
	}

	if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
		if (hdev->rsize == 184) {
			/* disable hidinput, force hiddev */
			cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
				HID_CONNECT_HIDDEV_FORCE;
		}
	}

	ret = hid_hw_start(hdev, cmask);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		goto err_free;
	}

	return 0;
err_free:
	return ret;
}

static const struct hid_device_id samsung_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
	{ }
};
MODULE_DEVICE_TABLE(hid, samsung_devices);

static struct hid_driver samsung_driver = {
	.name = "samsung",
	.id_table = samsung_devices,
	.report_fixup = samsung_report_fixup,
	.input_mapping = samsung_input_mapping,
	.probe = samsung_probe,
};
module_hid_driver(samsung_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
980a3da6 JS	1	/*
	2	* HID driver for some samsung "special" devices
	3	*
	4	* Copyright (c) 1999 Andreas Gal
	5	* Copyright (c) 2000-2005 Vojtech Pavlik <[email protected]>
	6	* Copyright (c) 2005 Michael Haboustak <[email protected]> for Concept2, Inc
	7	* Copyright (c) 2006-2007 Jiri Kosina
980a3da6	8	* Copyright (c) 2008 Jiri Slaby
b355850b DP	9	* Copyright (c) 2010 Don Prince <[email protected]>
	10	*
	11	*
	12	* This driver supports several HID devices:
	13	*
	14	* [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
	15	* various hid report fixups for different variants.
	16	*
	17	* [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
	18	* several key mappings used from the consumer usage page
	19	* deviate from the USB HUT 1.12 standard.
	20	*
980a3da6 JS	21	*/
	22
	23	/*
	24	* This program is free software; you can redistribute it and/or modify it
	25	* under the terms of the GNU General Public License as published by the Free
	26	* Software Foundation; either version 2 of the License, or (at your option)
	27	* any later version.
	28	*/
	29
	30	#include <linux/device.h>
b355850b	31	#include <linux/usb.h>
980a3da6 JS	32	#include <linux/hid.h>
	33	#include <linux/module.h>
	34
	35	#include "hid-ids.h"
	36
	37	/*
0810b511 RS	38	* There are several variants for 0419:0001:
	39	*
	40	* 1. 184 byte report descriptor
980a3da6 JS	41	* Vendor specific report #4 has a size of 48 bit,
	42	* and therefore is not accepted when inspecting the descriptors.
	43	* As a workaround we reinterpret the report as:
	44	* Variable type, count 6, size 8 bit, log. maximum 255
	45	* The burden to reconstruct the data is moved into user space.
0810b511 RS	46	*
	47	* 2. 203 byte report descriptor
	48	* Report #4 has an array field with logical range 0..18 instead of 1..15.
	49	*
	50	* 3. 135 byte report descriptor
	51	* Report #4 has an array field with logical range 0..17 instead of 1..14.
3975bc56 RS	52	*
	53	* 4. 171 byte report descriptor
	54	* Report #3 has an array field with logical range 0..1 instead of 1..3.
980a3da6	55	*/
b355850b	56	static inline void samsung_irda_dev_trace(struct hid_device *hdev,
3975bc56 RS	57	unsigned int rsize)
3975bc56 RS	58	{
4291ee30 JP	59	hid_info(hdev, "fixing up Samsung IrDA %d byte report descriptor\n",
4291ee30 JP	60	rsize);
3975bc56 RS	61	}
3975bc56 RS	62
73e4008d NK	63	static __u8 samsung_irda_report_fixup(struct hid_device hdev, __u8 *rdesc,
73e4008d NK	64	unsigned int *rsize)
980a3da6	65	{
73e4008d	66	if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
980a3da6 JS	67	rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
	68	rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
	69	rdesc[182] == 0x40) {
b355850b	70	samsung_irda_dev_trace(hdev, 184);
980a3da6 JS	71	rdesc[176] = 0xff;
	72	rdesc[178] = 0x08;
	73	rdesc[180] = 0x06;
	74	rdesc[182] = 0x42;
0810b511	75	} else
73e4008d	76	if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
0810b511	77	rdesc[194] == 0x25 && rdesc[195] == 0x12) {
b355850b	78	samsung_irda_dev_trace(hdev, 203);
0810b511 RS	79	rdesc[193] = 0x1;
	80	rdesc[195] = 0xf;
	81	} else
73e4008d	82	if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
0810b511	83	rdesc[126] == 0x25 && rdesc[127] == 0x11) {
b355850b	84	samsung_irda_dev_trace(hdev, 135);
0810b511 RS	85	rdesc[125] = 0x1;
0810b511 RS	86	rdesc[127] = 0xe;
3975bc56	87	} else
73e4008d	88	if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
3975bc56	89	rdesc[162] == 0x25 && rdesc[163] == 0x01) {
b355850b	90	samsung_irda_dev_trace(hdev, 171);
3975bc56 RS	91	rdesc[161] = 0x1;
3975bc56 RS	92	rdesc[163] = 0x3;
980a3da6	93	}
73e4008d	94	return rdesc;
980a3da6 JS	95	}
980a3da6 JS	96
b355850b DP	97	#define samsung_kbd_mouse_map_key_clear(c) \
	98	hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
	99
	100	static int samsung_kbd_mouse_input_mapping(struct hid_device *hdev,
	101	struct hid_input hi, struct hid_field field, struct hid_usage *usage,
	102	unsigned long *bit, int max)
	103	{
	104	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	105	unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
	106
	107	if (1 != ifnum \|\| HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
	108	return 0;
	109
	110	dbg_hid("samsung wireless keyboard/mouse input mapping event [0x%x]\n",
	111	usage->hid & HID_USAGE);
	112
	113	switch (usage->hid & HID_USAGE) {
	114	/* report 2 */
b355850b DP	115	case 0x183: samsung_kbd_mouse_map_key_clear(KEY_MEDIA); break;
	116	case 0x195: samsung_kbd_mouse_map_key_clear(KEY_EMAIL); break;
	117	case 0x196: samsung_kbd_mouse_map_key_clear(KEY_CALC); break;
	118	case 0x197: samsung_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
	119	case 0x22b: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
	120	case 0x22c: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
	121	case 0x22d: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
	122	case 0x22e: samsung_kbd_mouse_map_key_clear(KEY_FORWARD); break;
	123	case 0x22f: samsung_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
	124	case 0x230: samsung_kbd_mouse_map_key_clear(KEY_REFRESH); break;
	125	case 0x231: samsung_kbd_mouse_map_key_clear(KEY_STOP); break;
	126	default:
	127	return 0;
	128	}
	129
	130	return 1;
	131	}
	132
73e4008d NK	133	static __u8 samsung_report_fixup(struct hid_device hdev, __u8 *rdesc,
73e4008d NK	134	unsigned int *rsize)
b355850b DP	135	{
b355850b DP	136	if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
73e4008d NK	137	rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
73e4008d NK	138	return rdesc;
b355850b DP	139	}
	140
	141	static int samsung_input_mapping(struct hid_device hdev, struct hid_input hi,
	142	struct hid_field field, struct hid_usage usage,
	143	unsigned long *bit, int max)
	144	{
	145	int ret = 0;
	146
	147	if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
	148	ret = samsung_kbd_mouse_input_mapping(hdev,
	149	hi, field, usage, bit, max);
	150
	151	return ret;
	152	}
	153
980a3da6 JS	154	static int samsung_probe(struct hid_device *hdev,
	155	const struct hid_device_id *id)
	156	{
	157	int ret;
0810b511	158	unsigned int cmask = HID_CONNECT_DEFAULT;
980a3da6	159
980a3da6 JS	160	ret = hid_parse(hdev);
980a3da6 JS	161	if (ret) {
4291ee30	162	hid_err(hdev, "parse failed\n");
980a3da6 JS	163	goto err_free;
	164	}
	165
b355850b DP	166	if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
	167	if (hdev->rsize == 184) {
	168	/* disable hidinput, force hiddev */
	169	cmask = (cmask & ~HID_CONNECT_HIDINPUT) \|
	170	HID_CONNECT_HIDDEV_FORCE;
	171	}
0810b511 RS	172	}
	173
	174	ret = hid_hw_start(hdev, cmask);
980a3da6	175	if (ret) {
4291ee30	176	hid_err(hdev, "hw start failed\n");
980a3da6 JS	177	goto err_free;
	178	}
	179
	180	return 0;
	181	err_free:
	182	return ret;
	183	}
	184
	185	static const struct hid_device_id samsung_devices[] = {
	186	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
b355850b	187	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
980a3da6 JS	188	{ }
	189	};
	190	MODULE_DEVICE_TABLE(hid, samsung_devices);
	191
	192	static struct hid_driver samsung_driver = {
	193	.name = "samsung",
	194	.id_table = samsung_devices,
	195	.report_fixup = samsung_report_fixup,
b355850b	196	.input_mapping = samsung_input_mapping,
980a3da6 JS	197	.probe = samsung_probe,
980a3da6 JS	198	};
f425458e	199	module_hid_driver(samsung_driver);
980a3da6	200
980a3da6	201	MODULE_LICENSE("GPL");