hid-microsoft.c revision 3faed1aff786a007b3ea0549ac469e09f48c98f9
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 33static __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)) 60static 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_MSVENDOR) 66 return 0; 67 68 switch (usage->hid & HID_USAGE) { 69 case 0xfd06: ms_map_key_clear(KEY_CHAT); break; 70 case 0xfd07: ms_map_key_clear(KEY_PHONE); break; 71 case 0xff00: 72 /* Special keypad keys */ 73 ms_map_key_clear(KEY_KPEQUAL); 74 set_bit(KEY_KPLEFTPAREN, input->keybit); 75 set_bit(KEY_KPRIGHTPAREN, input->keybit); 76 break; 77 case 0xff01: 78 /* Scroll wheel */ 79 hid_map_usage_clear(hi, usage, bit, max, EV_REL, REL_WHEEL); 80 break; 81 case 0xff02: 82 /* 83 * This byte contains a copy of the modifier keys byte of a 84 * standard hid keyboard report, as send by interface 0 85 * (this usage is found on interface 1). 86 * 87 * This byte only gets send when another key in the same report 88 * changes state, and as such is useless, ignore it. 89 */ 90 return -1; 91 case 0xff05: 92 set_bit(EV_REP, input->evbit); 93 ms_map_key_clear(KEY_F13); 94 set_bit(KEY_F14, input->keybit); 95 set_bit(KEY_F15, input->keybit); 96 set_bit(KEY_F16, input->keybit); 97 set_bit(KEY_F17, input->keybit); 98 set_bit(KEY_F18, input->keybit); 99 break; 100 default: 101 return 0; 102 } 103 return 1; 104} 105 106static int ms_presenter_8k_quirk(struct hid_input *hi, struct hid_usage *usage, 107 unsigned long **bit, int *max) 108{ 109 if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR) 110 return 0; 111 112 set_bit(EV_REP, hi->input->evbit); 113 switch (usage->hid & HID_USAGE) { 114 case 0xfd08: ms_map_key_clear(KEY_FORWARD); break; 115 case 0xfd09: ms_map_key_clear(KEY_BACK); break; 116 case 0xfd0b: ms_map_key_clear(KEY_PLAYPAUSE); break; 117 case 0xfd0e: ms_map_key_clear(KEY_CLOSE); break; 118 case 0xfd0f: ms_map_key_clear(KEY_PLAY); break; 119 default: 120 return 0; 121 } 122 return 1; 123} 124 125static int ms_input_mapping(struct hid_device *hdev, struct hid_input *hi, 126 struct hid_field *field, struct hid_usage *usage, 127 unsigned long **bit, int *max) 128{ 129 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 130 131 if (quirks & MS_ERGONOMY) { 132 int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max); 133 if (ret) 134 return ret; 135 } 136 137 if ((quirks & MS_PRESENTER) && 138 ms_presenter_8k_quirk(hi, usage, bit, max)) 139 return 1; 140 141 return 0; 142} 143 144static int ms_input_mapped(struct hid_device *hdev, struct hid_input *hi, 145 struct hid_field *field, struct hid_usage *usage, 146 unsigned long **bit, int *max) 147{ 148 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 149 150 if (quirks & MS_DUPLICATE_USAGES) 151 clear_bit(usage->code, *bit); 152 153 return 0; 154} 155 156static int ms_event(struct hid_device *hdev, struct hid_field *field, 157 struct hid_usage *usage, __s32 value) 158{ 159 unsigned long quirks = (unsigned long)hid_get_drvdata(hdev); 160 struct input_dev *input; 161 162 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput || 163 !usage->type) 164 return 0; 165 166 input = field->hidinput->input; 167 168 /* Handling MS keyboards special buttons */ 169 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff00)) { 170 /* Special keypad keys */ 171 input_report_key(input, KEY_KPEQUAL, value & 0x01); 172 input_report_key(input, KEY_KPLEFTPAREN, value & 0x02); 173 input_report_key(input, KEY_KPRIGHTPAREN, value & 0x04); 174 return 1; 175 } 176 177 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff01)) { 178 /* Scroll wheel */ 179 int step = ((value & 0x60) >> 5) + 1; 180 181 switch (value & 0x1f) { 182 case 0x01: 183 input_report_rel(input, REL_WHEEL, step); 184 break; 185 case 0x1f: 186 input_report_rel(input, REL_WHEEL, -step); 187 break; 188 } 189 return 1; 190 } 191 192 if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff05)) { 193 static unsigned int last_key = 0; 194 unsigned int key = 0; 195 switch (value) { 196 case 0x01: key = KEY_F14; break; 197 case 0x02: key = KEY_F15; break; 198 case 0x04: key = KEY_F16; break; 199 case 0x08: key = KEY_F17; break; 200 case 0x10: key = KEY_F18; break; 201 } 202 if (key) { 203 input_event(input, usage->type, key, 1); 204 last_key = key; 205 } else 206 input_event(input, usage->type, last_key, 0); 207 208 return 1; 209 } 210 211 return 0; 212} 213 214static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id) 215{ 216 unsigned long quirks = id->driver_data; 217 int ret; 218 219 hid_set_drvdata(hdev, (void *)quirks); 220 221 if (quirks & MS_NOGET) 222 hdev->quirks |= HID_QUIRK_NOGET; 223 224 ret = hid_parse(hdev); 225 if (ret) { 226 hid_err(hdev, "parse failed\n"); 227 goto err_free; 228 } 229 230 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT | ((quirks & MS_HIDINPUT) ? 231 HID_CONNECT_HIDINPUT_FORCE : 0)); 232 if (ret) { 233 hid_err(hdev, "hw start failed\n"); 234 goto err_free; 235 } 236 237 return 0; 238err_free: 239 return ret; 240} 241 242static const struct hid_device_id ms_devices[] = { 243 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV), 244 .driver_data = MS_HIDINPUT }, 245 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_OFFICE_KB), 246 .driver_data = MS_ERGONOMY }, 247 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K), 248 .driver_data = MS_ERGONOMY }, 249 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K_JP), 250 .driver_data = MS_ERGONOMY }, 251 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K), 252 .driver_data = MS_ERGONOMY | MS_RDESC }, 253 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB), 254 .driver_data = MS_PRESENTER }, 255 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3K), 256 .driver_data = MS_ERGONOMY | MS_RDESC_3K }, 257 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0), 258 .driver_data = MS_NOGET }, 259 { HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_MOUSE_4500), 260 .driver_data = MS_DUPLICATE_USAGES }, 261 262 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT), 263 .driver_data = MS_PRESENTER }, 264 { } 265}; 266MODULE_DEVICE_TABLE(hid, ms_devices); 267 268static struct hid_driver ms_driver = { 269 .name = "microsoft", 270 .id_table = ms_devices, 271 .report_fixup = ms_report_fixup, 272 .input_mapping = ms_input_mapping, 273 .input_mapped = ms_input_mapped, 274 .event = ms_event, 275 .probe = ms_probe, 276}; 277module_hid_driver(ms_driver); 278 279MODULE_LICENSE("GPL"); 280