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 * Copyright (c) 2008 Jiri Slaby <jirislaby@gmail.com> 10 */ 11 12 /* 13 * This program is free software; you can redistribute it and/or modify it 14 * under the terms of the GNU General Public License as published by the Free 15 * Software Foundation; either version 2 of the License, or (at your option) 16 * any later version. 17 */ 18 19 #include <linux/device.h> 20 #include <linux/hid.h> 21 #include <linux/module.h> 22 #include <linux/usb.h> 23 24 #include "hid-ids.h" 25 26 #define APPLE_RDESC_JIS 0x0001 27 #define APPLE_IGNORE_MOUSE 0x0002 28 #define APPLE_HAS_FN 0x0004 29 #define APPLE_HIDDEV 0x0008 30 #define APPLE_ISO_KEYBOARD 0x0010 31 #define APPLE_MIGHTYMOUSE 0x0020 32 #define APPLE_INVERT_HWHEEL 0x0040 33 #define APPLE_IGNORE_HIDINPUT 0x0080 34 #define APPLE_NUMLOCK_EMULATION 0x0100 35 36 #define APPLE_FLAG_FKEY 0x01 37 38 static unsigned int fnmode = 1; 39 module_param(fnmode, uint, 0644); 40 MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, " 41 "[1] = fkeyslast, 2 = fkeysfirst)"); 42 43 struct apple_sc { 44 unsigned long quirks; 45 unsigned int fn_on; 46 DECLARE_BITMAP(pressed_fn, KEY_CNT); 47 DECLARE_BITMAP(pressed_numlock, KEY_CNT); 48 }; 49 50 struct apple_key_translation { 51 u16 from; 52 u16 to; 53 u8 flags; 54 }; 55 56 static struct apple_key_translation apple_fn_keys[] = { 57 { KEY_BACKSPACE, KEY_DELETE }, 58 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY }, 59 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY }, 60 { KEY_F3, KEY_FN_F5, APPLE_FLAG_FKEY }, /* Exposé */ 61 { KEY_F4, KEY_FN_F4, APPLE_FLAG_FKEY }, /* Dashboard */ 62 { KEY_F5, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY }, 63 { KEY_F6, KEY_KBDILLUMUP, APPLE_FLAG_FKEY }, 64 { KEY_F7, KEY_PREVIOUSSONG, APPLE_FLAG_FKEY }, 65 { KEY_F8, KEY_PLAYPAUSE, APPLE_FLAG_FKEY }, 66 { KEY_F9, KEY_NEXTSONG, APPLE_FLAG_FKEY }, 67 { KEY_F10, KEY_MUTE, APPLE_FLAG_FKEY }, 68 { KEY_F11, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY }, 69 { KEY_F12, KEY_VOLUMEUP, APPLE_FLAG_FKEY }, 70 { KEY_UP, KEY_PAGEUP }, 71 { KEY_DOWN, KEY_PAGEDOWN }, 72 { KEY_LEFT, KEY_HOME }, 73 { KEY_RIGHT, KEY_END }, 74 { } 75 }; 76 77 static struct apple_key_translation powerbook_fn_keys[] = { 78 { KEY_BACKSPACE, KEY_DELETE }, 79 { KEY_F1, KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY }, 80 { KEY_F2, KEY_BRIGHTNESSUP, APPLE_FLAG_FKEY }, 81 { KEY_F3, KEY_MUTE, APPLE_FLAG_FKEY }, 82 { KEY_F4, KEY_VOLUMEDOWN, APPLE_FLAG_FKEY }, 83 { KEY_F5, KEY_VOLUMEUP, APPLE_FLAG_FKEY }, 84 { KEY_F6, KEY_NUMLOCK, APPLE_FLAG_FKEY }, 85 { KEY_F7, KEY_SWITCHVIDEOMODE, APPLE_FLAG_FKEY }, 86 { KEY_F8, KEY_KBDILLUMTOGGLE, APPLE_FLAG_FKEY }, 87 { KEY_F9, KEY_KBDILLUMDOWN, APPLE_FLAG_FKEY }, 88 { KEY_F10, KEY_KBDILLUMUP, APPLE_FLAG_FKEY }, 89 { KEY_UP, KEY_PAGEUP }, 90 { KEY_DOWN, KEY_PAGEDOWN }, 91 { KEY_LEFT, KEY_HOME }, 92 { KEY_RIGHT, KEY_END }, 93 { } 94 }; 95 96 static struct apple_key_translation powerbook_numlock_keys[] = { 97 { KEY_J, KEY_KP1 }, 98 { KEY_K, KEY_KP2 }, 99 { KEY_L, KEY_KP3 }, 100 { KEY_U, KEY_KP4 }, 101 { KEY_I, KEY_KP5 }, 102 { KEY_O, KEY_KP6 }, 103 { KEY_7, KEY_KP7 }, 104 { KEY_8, KEY_KP8 }, 105 { KEY_9, KEY_KP9 }, 106 { KEY_M, KEY_KP0 }, 107 { KEY_DOT, KEY_KPDOT }, 108 { KEY_SLASH, KEY_KPPLUS }, 109 { KEY_SEMICOLON, KEY_KPMINUS }, 110 { KEY_P, KEY_KPASTERISK }, 111 { KEY_MINUS, KEY_KPEQUAL }, 112 { KEY_0, KEY_KPSLASH }, 113 { KEY_F6, KEY_NUMLOCK }, 114 { KEY_KPENTER, KEY_KPENTER }, 115 { KEY_BACKSPACE, KEY_BACKSPACE }, 116 { } 117 }; 118 119 static struct apple_key_translation apple_iso_keyboard[] = { 120 { KEY_GRAVE, KEY_102ND }, 121 { KEY_102ND, KEY_GRAVE }, 122 { } 123 }; 124 125 static struct apple_key_translation *apple_find_translation( 126 struct apple_key_translation *table, u16 from) 127 { 128 struct apple_key_translation *trans; 129 130 /* Look for the translation */ 131 for (trans = table; trans->from; trans++) 132 if (trans->from == from) 133 return trans; 134 135 return NULL; 136 } 137 138 static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input, 139 struct hid_usage *usage, __s32 value) 140 { 141 struct apple_sc *asc = hid_get_drvdata(hid); 142 struct apple_key_translation *trans; 143 144 if (usage->code == KEY_FN) { 145 asc->fn_on = !!value; 146 input_event(input, usage->type, usage->code, value); 147 return 1; 148 } 149 150 if (fnmode) { 151 int do_translate; 152 153 trans = apple_find_translation((hid->product < 0x220 || 154 hid->product >= 0x300) ? 155 powerbook_fn_keys : apple_fn_keys, 156 usage->code); 157 if (trans) { 158 if (test_bit(usage->code, asc->pressed_fn)) 159 do_translate = 1; 160 else if (trans->flags & APPLE_FLAG_FKEY) 161 do_translate = (fnmode == 2 && asc->fn_on) || 162 (fnmode == 1 && !asc->fn_on); 163 else 164 do_translate = asc->fn_on; 165 166 if (do_translate) { 167 if (value) 168 set_bit(usage->code, asc->pressed_fn); 169 else 170 clear_bit(usage->code, asc->pressed_fn); 171 172 input_event(input, usage->type, trans->to, 173 value); 174 175 return 1; 176 } 177 } 178 179 if (asc->quirks & APPLE_NUMLOCK_EMULATION && 180 (test_bit(usage->code, asc->pressed_numlock) || 181 test_bit(LED_NUML, input->led))) { 182 trans = apple_find_translation(powerbook_numlock_keys, 183 usage->code); 184 185 if (trans) { 186 if (value) 187 set_bit(usage->code, 188 asc->pressed_numlock); 189 else 190 clear_bit(usage->code, 191 asc->pressed_numlock); 192 193 input_event(input, usage->type, trans->to, 194 value); 195 } 196 197 return 1; 198 } 199 } 200 201 if (asc->quirks & APPLE_ISO_KEYBOARD) { 202 trans = apple_find_translation(apple_iso_keyboard, usage->code); 203 if (trans) { 204 input_event(input, usage->type, trans->to, value); 205 return 1; 206 } 207 } 208 209 return 0; 210 } 211 212 static int apple_event(struct hid_device *hdev, struct hid_field *field, 213 struct hid_usage *usage, __s32 value) 214 { 215 struct apple_sc *asc = hid_get_drvdata(hdev); 216 217 if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput || 218 !usage->type) 219 return 0; 220 221 if ((asc->quirks & APPLE_INVERT_HWHEEL) && 222 usage->code == REL_HWHEEL) { 223 input_event(field->hidinput->input, usage->type, usage->code, 224 -value); 225 return 1; 226 } 227 228 if ((asc->quirks & APPLE_HAS_FN) && 229 hidinput_apple_event(hdev, field->hidinput->input, 230 usage, value)) 231 return 1; 232 233 234 return 0; 235 } 236 237 /* 238 * MacBook JIS keyboard has wrong logical maximum 239 */ 240 static void apple_report_fixup(struct hid_device *hdev, __u8 *rdesc, 241 unsigned int rsize) 242 { 243 struct apple_sc *asc = hid_get_drvdata(hdev); 244 245 if ((asc->quirks & APPLE_RDESC_JIS) && rsize >= 60 && 246 rdesc[53] == 0x65 && rdesc[59] == 0x65) { 247 dev_info(&hdev->dev, "fixing up MacBook JIS keyboard report " 248 "descriptor\n"); 249 rdesc[53] = rdesc[59] = 0xe7; 250 } 251 } 252 253 static void apple_setup_input(struct input_dev *input) 254 { 255 struct apple_key_translation *trans; 256 257 set_bit(KEY_NUMLOCK, input->keybit); 258 259 /* Enable all needed keys */ 260 for (trans = apple_fn_keys; trans->from; trans++) 261 set_bit(trans->to, input->keybit); 262 263 for (trans = powerbook_fn_keys; trans->from; trans++) 264 set_bit(trans->to, input->keybit); 265 266 for (trans = powerbook_numlock_keys; trans->from; trans++) 267 set_bit(trans->to, input->keybit); 268 269 for (trans = apple_iso_keyboard; trans->from; trans++) 270 set_bit(trans->to, input->keybit); 271 } 272 273 static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi, 274 struct hid_field *field, struct hid_usage *usage, 275 unsigned long **bit, int *max) 276 { 277 if (usage->hid == (HID_UP_CUSTOM | 0x0003)) { 278 /* The fn key on Apple USB keyboards */ 279 set_bit(EV_REP, hi->input->evbit); 280 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN); 281 apple_setup_input(hi->input); 282 return 1; 283 } 284 285 /* we want the hid layer to go through standard path (set and ignore) */ 286 return 0; 287 } 288 289 static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi, 290 struct hid_field *field, struct hid_usage *usage, 291 unsigned long **bit, int *max) 292 { 293 struct apple_sc *asc = hid_get_drvdata(hdev); 294 295 if (asc->quirks & APPLE_MIGHTYMOUSE) { 296 if (usage->hid == HID_GD_Z) 297 hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL); 298 else if (usage->code == BTN_1) 299 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2); 300 else if (usage->code == BTN_2) 301 hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1); 302 } 303 304 return 0; 305 } 306 307 static int apple_probe(struct hid_device *hdev, 308 const struct hid_device_id *id) 309 { 310 unsigned long quirks = id->driver_data; 311 struct apple_sc *asc; 312 unsigned int connect_mask = HID_CONNECT_DEFAULT; 313 int ret; 314 315 asc = kzalloc(sizeof(*asc), GFP_KERNEL); 316 if (asc == NULL) { 317 dev_err(&hdev->dev, "can't alloc apple descriptor\n"); 318 return -ENOMEM; 319 } 320 321 asc->quirks = quirks; 322 323 hid_set_drvdata(hdev, asc); 324 325 ret = hid_parse(hdev); 326 if (ret) { 327 dev_err(&hdev->dev, "parse failed\n"); 328 goto err_free; 329 } 330 331 if (quirks & APPLE_HIDDEV) 332 connect_mask |= HID_CONNECT_HIDDEV_FORCE; 333 if (quirks & APPLE_IGNORE_HIDINPUT) 334 connect_mask &= ~HID_CONNECT_HIDINPUT; 335 336 ret = hid_hw_start(hdev, connect_mask); 337 if (ret) { 338 dev_err(&hdev->dev, "hw start failed\n"); 339 goto err_free; 340 } 341 342 return 0; 343 err_free: 344 kfree(asc); 345 return ret; 346 } 347 348 static void apple_remove(struct hid_device *hdev) 349 { 350 hid_hw_stop(hdev); 351 kfree(hid_get_drvdata(hdev)); 352 } 353 354 static const struct hid_device_id apple_devices[] = { 355 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL), 356 .driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT }, 357 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4), 358 .driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT }, 359 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE), 360 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL }, 361 362 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI), 363 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 364 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO), 365 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 366 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI), 367 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 368 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO), 369 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 370 APPLE_ISO_KEYBOARD }, 371 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS), 372 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 373 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI), 374 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 375 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO), 376 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 377 APPLE_ISO_KEYBOARD }, 378 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS), 379 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 380 APPLE_RDESC_JIS }, 381 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI), 382 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 383 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO), 384 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 385 APPLE_ISO_KEYBOARD }, 386 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS), 387 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 388 APPLE_RDESC_JIS }, 389 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI), 390 .driver_data = APPLE_HAS_FN }, 391 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO), 392 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD }, 393 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS), 394 .driver_data = APPLE_HAS_FN }, 395 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI), 396 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 397 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO), 398 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 399 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS), 400 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 401 APPLE_RDESC_JIS }, 402 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI), 403 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 404 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO), 405 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN | 406 APPLE_ISO_KEYBOARD }, 407 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS), 408 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 409 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI), 410 .driver_data = APPLE_HAS_FN }, 411 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO), 412 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD }, 413 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS), 414 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS }, 415 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI), 416 .driver_data = APPLE_HAS_FN }, 417 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO), 418 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD }, 419 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS), 420 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS }, 421 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY), 422 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 423 { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY), 424 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN }, 425 426 /* Apple wireless Mighty Mouse */ 427 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 0x030c), 428 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL }, 429 430 { } 431 }; 432 MODULE_DEVICE_TABLE(hid, apple_devices); 433 434 static struct hid_driver apple_driver = { 435 .name = "apple", 436 .id_table = apple_devices, 437 .report_fixup = apple_report_fixup, 438 .probe = apple_probe, 439 .remove = apple_remove, 440 .event = apple_event, 441 .input_mapping = apple_input_mapping, 442 .input_mapped = apple_input_mapped, 443 }; 444 445 static int apple_init(void) 446 { 447 int ret; 448 449 ret = hid_register_driver(&apple_driver); 450 if (ret) 451 printk(KERN_ERR "can't register apple driver\n"); 452 453 return ret; 454 } 455 456 static void apple_exit(void) 457 { 458 hid_unregister_driver(&apple_driver); 459 } 460 461 module_init(apple_init); 462 module_exit(apple_exit); 463 MODULE_LICENSE("GPL"); 464 465 HID_COMPAT_LOAD_DRIVER(apple); 466