1 /* 2 * HID driver for some microsoft "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) 2008 Jiri Slaby 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/device.h> 19 #include <linux/input.h> 20 #include <linux/hid.h> 21 #include <linux/module.h> 22 23 #include "hid-ids.h" 24 25 #define MS_HIDINPUT 0x01 26 #define MS_ERGONOMY 0x02 27 #define MS_PRESENTER 0x04 28 #define MS_RDESC 0x08 29 #define MS_NOGET 0x10 30 #define MS_DUPLICATE_USAGES 0x20 31 #define MS_RDESC_3K 0x40 32 33 static __u8 *ms_report_fixup(struct hid_device *hdev, __u8 *rdesc, 34 unsigned int *rsize) 35 { 36 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 37 38 /* 39 * Microsoft Wireless Desktop Receiver (Model 1028) has 40 * 'Usage Min/Max' where it ought to have 'Physical Min/Max' 41 */ 42 if ((quirks & MS_RDESC) && *rsize == 571 && rdesc[557] == 0x19 && 43 rdesc[559] == 0x29) { 44 hid_info(hdev, "fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n"); 45 rdesc[557] = 0x35; 46 rdesc[559] = 0x45; 47 } 48 /* the same as above (s/usage/physical/) */ 49 if ((quirks & MS_RDESC_3K) && *rsize == 106 && rdesc[94] == 0x19 && 50 rdesc[95] == 0x00 && rdesc[96] == 0x29 && 51 rdesc[97] == 0xff) { 52 rdesc[94] = 0x35; 53 rdesc[96] = 0x45; 54 } 55 return rdesc; 56 } 57 58 #define ms_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \ 59 EV_KEY, (c)) 60 static int ms_ergonomy_kb_quirk(struct hid_input *hi, struct hid_usage *usage, 61 unsigned long **bit, int *max) 62 { 63 struct input_dev *input = hi->input; 64 65 if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER) { 66 switch (usage->hid & HID_USAGE) { 67 /* 68 * Microsoft uses these 2 reserved usage ids for 2 keys on 69 * the MS office kb labelled "Office Home" and "Task Pane". 70 */ 71 case 0x29d: 72 ms_map_key_clear(KEY_PROG1); 73 return 1; 74 case 0x29e: 75 ms_map_key_clear(KEY_PROG2); 76 return 1; 77 } 78 return 0; 79 } 80 81 if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR) 82 return 0; 83 84 switch (usage->hid & HID_USAGE) { 85 case 0xfd06: ms_map_key_clear(KEY_CHAT); break; 86 case 0xfd07: ms_map_key_clear(KEY_PHONE); break; 87 case 0xff00: 88 /* Special keypad keys */ 89 ms_map_key_clear(KEY_KPEQUAL); 90 set_bit(KEY_KPLEFTPAREN, input->keybit); 91 set_bit(KEY_KPRIGHTPAREN, input->keybit); 92 break; 93 case 0xff01: 94 /* Scroll wheel */ 95 hid_map_usage_clear(hi, usage, bit, max, EV_REL, REL_WHEEL); 96 break; 97 case 0xff02: 98 /* 99 * This byte contains a copy of the modifier keys byte of a 100 * standard hid keyboard report, as send by interface 0 101 * (this usage is found on interface 1). 102 * 103 * This byte only gets send when another key in the same report 104 * changes state, and as such is useless, ignore it. 105 */ 106 return -1; 107 case 0xff05: 108 set_bit(EV_REP, input->evbit); 109 ms_map_key_clear(KEY_F13); 110 set_bit(KEY_F14, input->keybit); 111 set_bit(KEY_F15, input->keybit); 112 set_bit(KEY_F16, input->keybit); 113 set_bit(KEY_F17, input->keybit); 114 set_bit(KEY_F18, input->keybit); 115 break; 116 default: 117 return 0; 118 } 119 return 1; 120 } 121 122 static int ms_presenter_8k_quirk(struct hid_input *hi, struct hid_usage *usage, 123 unsigned long **bit, int *max) 124 { 125 if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR) 126 return 0; 127 128 set_bit(EV_REP, hi->input->evbit); 129 switch (usage->hid & HID_USAGE) { 130 case 0xfd08: ms_map_key_clear(KEY_FORWARD); break; 131 case 0xfd09: ms_map_key_clear(KEY_BACK); break; 132 case 0xfd0b: ms_map_key_clear(KEY_PLAYPAUSE); break; 133 case 0xfd0e: ms_map_key_clear(KEY_CLOSE); break; 134 case 0xfd0f: ms_map_key_clear(KEY_PLAY); break; 135 default: 136 return 0; 137 } 138 return 1; 139 } 140 141 static int ms_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 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 146 147 if (quirks & MS_ERGONOMY) { 148 int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max); 149 if (ret) 150 return ret; 151 } 152 153 if ((quirks & MS_PRESENTER) && 154 ms_presenter_8k_quirk(hi, usage, bit, max)) 155 return 1; 156 157 return 0; 158 } 159 160 static int ms_input_mapped(struct hid_device *hdev, struct hid_input *hi, 161 struct hid_field *field, struct hid_usage *usage, 162 unsigned long **bit, int *max) 163 { 164 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 165 166 if (quirks & MS_DUPLICATE_USAGES) 167 clear_bit(usage->code, *bit); 168 169 return 0; 170 } 171 172 static int ms_event(struct hid_device *hdev, struct hid_field *field, 173 struct hid_usage *usage, __s32 value) 174 { 175 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 176 struct input_dev *input; 177 178 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput || 179 !usage->type) 180 return 0; 181 182 input = field->hidinput->input; 183 184 /* Handling MS keyboards special buttons */ 185 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff00)) { 186 /* Special keypad keys */ 187 input_report_key(input, KEY_KPEQUAL, value & 0x01); 188 input_report_key(input, KEY_KPLEFTPAREN, value & 0x02); 189 input_report_key(input, KEY_KPRIGHTPAREN, value & 0x04); 190 return 1; 191 } 192 193 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff01)) { 194 /* Scroll wheel */ 195 int step = ((value & 0x60) >> 5) + 1; 196 197 switch (value & 0x1f) { 198 case 0x01: 199 input_report_rel(input, REL_WHEEL, step); 200 break; 201 case 0x1f: 202 input_report_rel(input, REL_WHEEL, -step); 203 break; 204 } 205 return 1; 206 } 207 208 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff05)) { 209 static unsigned int last_key = 0; 210 unsigned int key = 0; 211 switch (value) { 212 case 0x01: key = KEY_F14; break; 213 case 0x02: key = KEY_F15; break; 214 case 0x04: key = KEY_F16; break; 215 case 0x08: key = KEY_F17; break; 216 case 0x10: key = KEY_F18; break; 217 } 218 if (key) { 219 input_event(input, usage->type, key, 1); 220 last_key = key; 221 } else 222 input_event(input, usage->type, last_key, 0); 223 224 return 1; 225 } 226 227 return 0; 228 } 229 230 static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id) 231 { 232 unsigned long quirks = id->driver_data; 233 int ret; 234 235 hid_set_drvdata(hdev, (void *)quirks); 236 237 if (quirks & MS_NOGET) 238 hdev->quirks |= HID_QUIRK_NOGET; 239 240 ret = hid_parse(hdev); 241 if (ret) { 242 hid_err(hdev, "parse failed\n"); 243 goto err_free; 244 } 245 246 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT | ((quirks & MS_HIDINPUT) ? 247 HID_CONNECT_HIDINPUT_FORCE : 0)); 248 if (ret) { 249 hid_err(hdev, "hw start failed\n"); 250 goto err_free; 251 } 252 253 return 0; 254 err_free: 255 return ret; 256 } 257 258 static const struct hid_device_id ms_devices[] = { 259 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV), 260 .driver_data = MS_HIDINPUT }, 261 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_OFFICE_KB), 262 .driver_data = MS_ERGONOMY }, 263 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K), 264 .driver_data = MS_ERGONOMY }, 265 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K_JP), 266 .driver_data = MS_ERGONOMY }, 267 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K), 268 .driver_data = MS_ERGONOMY | MS_RDESC }, 269 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB), 270 .driver_data = MS_PRESENTER }, 271 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3K), 272 .driver_data = MS_ERGONOMY | MS_RDESC_3K }, 273 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0), 274 .driver_data = MS_NOGET }, 275 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_MOUSE_4500), 276 .driver_data = MS_DUPLICATE_USAGES }, 277 278 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT), 279 .driver_data = MS_PRESENTER }, 280 { } 281 }; 282 MODULE_DEVICE_TABLE(hid, ms_devices); 283 284 static struct hid_driver ms_driver = { 285 .name = "microsoft", 286 .id_table = ms_devices, 287 .report_fixup = ms_report_fixup, 288 .input_mapping = ms_input_mapping, 289 .input_mapped = ms_input_mapped, 290 .event = ms_event, 291 .probe = ms_probe, 292 }; 293 module_hid_driver(ms_driver); 294 295 MODULE_LICENSE("GPL"); 296