blob: 3c1fd8af5e0c37495a25e98dbbfc19db9b22bb99 [file] [log] [blame]
Jiri Slaby980a3da2008-06-25 22:31:48 +02001/*
2 * HID driver for some samsung "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
Don Princeb3558502010-05-17 11:42:39 +010010 * Copyright (c) 2010 Don Prince <dhprince.devel@yahoo.co.uk>
11 *
12 *
13 * This driver supports several HID devices:
14 *
15 * [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
16 * various hid report fixups for different variants.
17 *
18 * [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
19 * several key mappings used from the consumer usage page
20 * deviate from the USB HUT 1.12 standard.
21 *
Jiri Slaby980a3da2008-06-25 22:31:48 +020022 */
23
24/*
25 * This program is free software; you can redistribute it and/or modify it
26 * under the terms of the GNU General Public License as published by the Free
27 * Software Foundation; either version 2 of the License, or (at your option)
28 * any later version.
29 */
30
31#include <linux/device.h>
Don Princeb3558502010-05-17 11:42:39 +010032#include <linux/usb.h>
Jiri Slaby980a3da2008-06-25 22:31:48 +020033#include <linux/hid.h>
34#include <linux/module.h>
35
36#include "hid-ids.h"
37
38/*
Robert Schedel0810b512009-06-23 11:26:48 +020039 * There are several variants for 0419:0001:
40 *
41 * 1. 184 byte report descriptor
Jiri Slaby980a3da2008-06-25 22:31:48 +020042 * Vendor specific report #4 has a size of 48 bit,
43 * and therefore is not accepted when inspecting the descriptors.
44 * As a workaround we reinterpret the report as:
45 * Variable type, count 6, size 8 bit, log. maximum 255
46 * The burden to reconstruct the data is moved into user space.
Robert Schedel0810b512009-06-23 11:26:48 +020047 *
48 * 2. 203 byte report descriptor
49 * Report #4 has an array field with logical range 0..18 instead of 1..15.
50 *
51 * 3. 135 byte report descriptor
52 * Report #4 has an array field with logical range 0..17 instead of 1..14.
Robert Schedel3975bc52009-12-11 00:37:11 +010053 *
54 * 4. 171 byte report descriptor
55 * Report #3 has an array field with logical range 0..1 instead of 1..3.
Jiri Slaby980a3da2008-06-25 22:31:48 +020056 */
Don Princeb3558502010-05-17 11:42:39 +010057static inline void samsung_irda_dev_trace(struct hid_device *hdev,
Robert Schedel3975bc52009-12-11 00:37:11 +010058 unsigned int rsize)
59{
Joe Perches4291ee32010-12-09 19:29:03 -080060 hid_info(hdev, "fixing up Samsung IrDA %d byte report descriptor\n",
61 rsize);
Robert Schedel3975bc52009-12-11 00:37:11 +010062}
63
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040064static __u8 *samsung_irda_report_fixup(struct hid_device *hdev, __u8 *rdesc,
65 unsigned int *rsize)
Jiri Slaby980a3da2008-06-25 22:31:48 +020066{
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040067 if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
Jiri Slaby980a3da2008-06-25 22:31:48 +020068 rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
69 rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
70 rdesc[182] == 0x40) {
Don Princeb3558502010-05-17 11:42:39 +010071 samsung_irda_dev_trace(hdev, 184);
Jiri Slaby980a3da2008-06-25 22:31:48 +020072 rdesc[176] = 0xff;
73 rdesc[178] = 0x08;
74 rdesc[180] = 0x06;
75 rdesc[182] = 0x42;
Robert Schedel0810b512009-06-23 11:26:48 +020076 } else
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040077 if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
Robert Schedel0810b512009-06-23 11:26:48 +020078 rdesc[194] == 0x25 && rdesc[195] == 0x12) {
Don Princeb3558502010-05-17 11:42:39 +010079 samsung_irda_dev_trace(hdev, 203);
Robert Schedel0810b512009-06-23 11:26:48 +020080 rdesc[193] = 0x1;
81 rdesc[195] = 0xf;
82 } else
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040083 if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
Robert Schedel0810b512009-06-23 11:26:48 +020084 rdesc[126] == 0x25 && rdesc[127] == 0x11) {
Don Princeb3558502010-05-17 11:42:39 +010085 samsung_irda_dev_trace(hdev, 135);
Robert Schedel0810b512009-06-23 11:26:48 +020086 rdesc[125] = 0x1;
87 rdesc[127] = 0xe;
Robert Schedel3975bc52009-12-11 00:37:11 +010088 } else
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040089 if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
Robert Schedel3975bc52009-12-11 00:37:11 +010090 rdesc[162] == 0x25 && rdesc[163] == 0x01) {
Don Princeb3558502010-05-17 11:42:39 +010091 samsung_irda_dev_trace(hdev, 171);
Robert Schedel3975bc52009-12-11 00:37:11 +010092 rdesc[161] = 0x1;
93 rdesc[163] = 0x3;
Jiri Slaby980a3da2008-06-25 22:31:48 +020094 }
Nikolai Kondrashov73e40082010-08-06 23:03:06 +040095 return rdesc;
Jiri Slaby980a3da2008-06-25 22:31:48 +020096}
97
Don Princeb3558502010-05-17 11:42:39 +010098#define samsung_kbd_mouse_map_key_clear(c) \
99 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))
100
101static int samsung_kbd_mouse_input_mapping(struct hid_device *hdev,
102 struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
103 unsigned long **bit, int *max)
104{
105 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
106 unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
107
108 if (1 != ifnum || HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
109 return 0;
110
111 dbg_hid("samsung wireless keyboard/mouse input mapping event [0x%x]\n",
112 usage->hid & HID_USAGE);
113
114 switch (usage->hid & HID_USAGE) {
115 /* report 2 */
Don Princeb3558502010-05-17 11:42:39 +0100116 case 0x183: samsung_kbd_mouse_map_key_clear(KEY_MEDIA); break;
117 case 0x195: samsung_kbd_mouse_map_key_clear(KEY_EMAIL); break;
118 case 0x196: samsung_kbd_mouse_map_key_clear(KEY_CALC); break;
119 case 0x197: samsung_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
120 case 0x22b: samsung_kbd_mouse_map_key_clear(KEY_SEARCH); break;
121 case 0x22c: samsung_kbd_mouse_map_key_clear(KEY_WWW); break;
122 case 0x22d: samsung_kbd_mouse_map_key_clear(KEY_BACK); break;
123 case 0x22e: samsung_kbd_mouse_map_key_clear(KEY_FORWARD); break;
124 case 0x22f: samsung_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
125 case 0x230: samsung_kbd_mouse_map_key_clear(KEY_REFRESH); break;
126 case 0x231: samsung_kbd_mouse_map_key_clear(KEY_STOP); break;
127 default:
128 return 0;
129 }
130
131 return 1;
132}
133
Nikolai Kondrashov73e40082010-08-06 23:03:06 +0400134static __u8 *samsung_report_fixup(struct hid_device *hdev, __u8 *rdesc,
135 unsigned int *rsize)
Don Princeb3558502010-05-17 11:42:39 +0100136{
137 if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product)
Nikolai Kondrashov73e40082010-08-06 23:03:06 +0400138 rdesc = samsung_irda_report_fixup(hdev, rdesc, rsize);
139 return rdesc;
Don Princeb3558502010-05-17 11:42:39 +0100140}
141
142static int samsung_input_mapping(struct hid_device *hdev, struct hid_input *hi,
143 struct hid_field *field, struct hid_usage *usage,
144 unsigned long **bit, int *max)
145{
146 int ret = 0;
147
148 if (USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE == hdev->product)
149 ret = samsung_kbd_mouse_input_mapping(hdev,
150 hi, field, usage, bit, max);
151
152 return ret;
153}
154
Jiri Slaby980a3da2008-06-25 22:31:48 +0200155static int samsung_probe(struct hid_device *hdev,
156 const struct hid_device_id *id)
157{
158 int ret;
Robert Schedel0810b512009-06-23 11:26:48 +0200159 unsigned int cmask = HID_CONNECT_DEFAULT;
Jiri Slaby980a3da2008-06-25 22:31:48 +0200160
Jiri Slaby980a3da2008-06-25 22:31:48 +0200161 ret = hid_parse(hdev);
162 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800163 hid_err(hdev, "parse failed\n");
Jiri Slaby980a3da2008-06-25 22:31:48 +0200164 goto err_free;
165 }
166
Don Princeb3558502010-05-17 11:42:39 +0100167 if (USB_DEVICE_ID_SAMSUNG_IR_REMOTE == hdev->product) {
168 if (hdev->rsize == 184) {
169 /* disable hidinput, force hiddev */
170 cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
171 HID_CONNECT_HIDDEV_FORCE;
172 }
Robert Schedel0810b512009-06-23 11:26:48 +0200173 }
174
175 ret = hid_hw_start(hdev, cmask);
Jiri Slaby980a3da2008-06-25 22:31:48 +0200176 if (ret) {
Joe Perches4291ee32010-12-09 19:29:03 -0800177 hid_err(hdev, "hw start failed\n");
Jiri Slaby980a3da2008-06-25 22:31:48 +0200178 goto err_free;
179 }
180
181 return 0;
182err_free:
183 return ret;
184}
185
186static const struct hid_device_id samsung_devices[] = {
187 { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },
Don Princeb3558502010-05-17 11:42:39 +0100188 { HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },
Jiri Slaby980a3da2008-06-25 22:31:48 +0200189 { }
190};
191MODULE_DEVICE_TABLE(hid, samsung_devices);
192
193static struct hid_driver samsung_driver = {
194 .name = "samsung",
195 .id_table = samsung_devices,
196 .report_fixup = samsung_report_fixup,
Don Princeb3558502010-05-17 11:42:39 +0100197 .input_mapping = samsung_input_mapping,
Jiri Slaby980a3da2008-06-25 22:31:48 +0200198 .probe = samsung_probe,
199};
200
Peter Huewea24f423b2009-07-02 19:08:38 +0200201static int __init samsung_init(void)
Jiri Slaby980a3da2008-06-25 22:31:48 +0200202{
203 return hid_register_driver(&samsung_driver);
204}
205
Peter Huewea24f423b2009-07-02 19:08:38 +0200206static void __exit samsung_exit(void)
Jiri Slaby980a3da2008-06-25 22:31:48 +0200207{
208 hid_unregister_driver(&samsung_driver);
209}
210
211module_init(samsung_init);
212module_exit(samsung_exit);
213MODULE_LICENSE("GPL");