drivers/hid/hid-apple.c

   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) 2008 Jiri Slaby <jirislaby@gmail.com>
   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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  19
  20 #include <linux/device.h>
  21 #include <linux/hid.h>
  22 #include <linux/module.h>
  23 #include <linux/slab.h>
  24
  25 #include "hid-ids.h"
  26
  27 #define APPLE_RDESC_JIS         0x0001
  28 #define APPLE_IGNORE_MOUSE      0x0002
  29 #define APPLE_HAS_FN            0x0004
  30 #define APPLE_HIDDEV            0x0008
  31 #define APPLE_ISO_KEYBOARD      0x0010
  32 #define APPLE_MIGHTYMOUSE       0x0020
  33 #define APPLE_INVERT_HWHEEL     0x0040
  34 #define APPLE_IGNORE_HIDINPUT   0x0080
  35 #define APPLE_NUMLOCK_EMULATION 0x0100
  36
  37 #define APPLE_FLAG_FKEY         0x01
  38
  39 static unsigned int fnmode = 1;
  40 module_param(fnmode, uint, 0644);
  41 MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
  42                 "[1] = fkeyslast, 2 = fkeysfirst)");
  43
  44 static unsigned int iso_layout = 1;
  45 module_param(iso_layout, uint, 0644);
  46 MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. "
  47                 "(0 = disabled, [1] = enabled)");
  48
  49 static unsigned int swap_opt_cmd;
  50 module_param(swap_opt_cmd, uint, 0644);
  51 MODULE_PARM_DESC(swap_opt_cmd, "Swap the Option (\"Alt\") and Command (\"Flag\") keys. "
  52                 "(For people who want to keep Windows PC keyboard muscle memory. "
  53                 "[0] = as-is, Mac layout. 1 = swapped, Windows layout.)");
  54
  55 struct apple_sc {
  56         unsigned long quirks;
  57         unsigned int fn_on;
  58         unsigned int fn_found;
  59         DECLARE_BITMAP(pressed_numlock, KEY_CNT);
  60 };
  61
  62 struct apple_key_translation {
  63         u16 from;
  64         u16 to;
  65         u8 flags;
  66 };
  67
  68 static const struct apple_key_translation macbookair_fn_keys[] = {
  69         { KEY_BACKSPACE, KEY_DELETE },
  70         { KEY_ENTER,    KEY_INSERT },
  71         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
  72         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
  73         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
  74         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
  75         { KEY_F6,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
  76         { KEY_F7,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
  77         { KEY_F8,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
  78         { KEY_F9,       KEY_MUTE,           APPLE_FLAG_FKEY },
  79         { KEY_F10,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
  80         { KEY_F11,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
  81         { KEY_F12,      KEY_EJECTCD,        APPLE_FLAG_FKEY },
  82         { KEY_UP,       KEY_PAGEUP },
  83         { KEY_DOWN,     KEY_PAGEDOWN },
  84         { KEY_LEFT,     KEY_HOME },
  85         { KEY_RIGHT,    KEY_END },
  86         { }
  87 };
  88
  89 static const struct apple_key_translation apple_fn_keys[] = {
  90         { KEY_BACKSPACE, KEY_DELETE },
  91         { KEY_ENTER,    KEY_INSERT },
  92         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
  93         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
  94         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
  95         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
  96         { KEY_F5,       KEY_KBDILLUMDOWN,   APPLE_FLAG_FKEY },
  97         { KEY_F6,       KEY_KBDILLUMUP,     APPLE_FLAG_FKEY },
  98         { KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
  99         { KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 100         { KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 101         { KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
 102         { KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 103         { KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 104         { KEY_UP,       KEY_PAGEUP },
 105         { KEY_DOWN,     KEY_PAGEDOWN },
 106         { KEY_LEFT,     KEY_HOME },
 107         { KEY_RIGHT,    KEY_END },
 108         { }
 109 };
 110
 111 static const struct apple_key_translation powerbook_fn_keys[] = {
 112         { KEY_BACKSPACE, KEY_DELETE },
 113         { KEY_F1,       KEY_BRIGHTNESSDOWN,     APPLE_FLAG_FKEY },
 114         { KEY_F2,       KEY_BRIGHTNESSUP,       APPLE_FLAG_FKEY },
 115         { KEY_F3,       KEY_MUTE,               APPLE_FLAG_FKEY },
 116         { KEY_F4,       KEY_VOLUMEDOWN,         APPLE_FLAG_FKEY },
 117         { KEY_F5,       KEY_VOLUMEUP,           APPLE_FLAG_FKEY },
 118         { KEY_F6,       KEY_NUMLOCK,            APPLE_FLAG_FKEY },
 119         { KEY_F7,       KEY_SWITCHVIDEOMODE,    APPLE_FLAG_FKEY },
 120         { KEY_F8,       KEY_KBDILLUMTOGGLE,     APPLE_FLAG_FKEY },
 121         { KEY_F9,       KEY_KBDILLUMDOWN,       APPLE_FLAG_FKEY },
 122         { KEY_F10,      KEY_KBDILLUMUP,         APPLE_FLAG_FKEY },
 123         { KEY_UP,       KEY_PAGEUP },
 124         { KEY_DOWN,     KEY_PAGEDOWN },
 125         { KEY_LEFT,     KEY_HOME },
 126         { KEY_RIGHT,    KEY_END },
 127         { }
 128 };
 129
 130 static const struct apple_key_translation powerbook_numlock_keys[] = {
 131         { KEY_J,        KEY_KP1 },
 132         { KEY_K,        KEY_KP2 },
 133         { KEY_L,        KEY_KP3 },
 134         { KEY_U,        KEY_KP4 },
 135         { KEY_I,        KEY_KP5 },
 136         { KEY_O,        KEY_KP6 },
 137         { KEY_7,        KEY_KP7 },
 138         { KEY_8,        KEY_KP8 },
 139         { KEY_9,        KEY_KP9 },
 140         { KEY_M,        KEY_KP0 },
 141         { KEY_DOT,      KEY_KPDOT },
 142         { KEY_SLASH,    KEY_KPPLUS },
 143         { KEY_SEMICOLON, KEY_KPMINUS },
 144         { KEY_P,        KEY_KPASTERISK },
 145         { KEY_MINUS,    KEY_KPEQUAL },
 146         { KEY_0,        KEY_KPSLASH },
 147         { KEY_F6,       KEY_NUMLOCK },
 148         { KEY_KPENTER,  KEY_KPENTER },
 149         { KEY_BACKSPACE, KEY_BACKSPACE },
 150         { }
 151 };
 152
 153 static const struct apple_key_translation apple_iso_keyboard[] = {
 154         { KEY_GRAVE,    KEY_102ND },
 155         { KEY_102ND,    KEY_GRAVE },
 156         { }
 157 };
 158
 159 static const struct apple_key_translation swapped_option_cmd_keys[] = {
 160         { KEY_LEFTALT,  KEY_LEFTMETA },
 161         { KEY_LEFTMETA, KEY_LEFTALT },
 162         { KEY_RIGHTALT, KEY_RIGHTMETA },
 163         { KEY_RIGHTMETA,KEY_RIGHTALT },
 164         { }
 165 };
 166
 167 static const struct apple_key_translation *apple_find_translation(
 168                 const struct apple_key_translation *table, u16 from)
 169 {
 170         const struct apple_key_translation *trans;
 171
 172         /* Look for the translation */
 173         for (trans = table; trans->from; trans++)
 174                 if (trans->from == from)
 175                         return trans;
 176
 177         return NULL;
 178 }
 179
 180 static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
 181                 struct hid_usage *usage, __s32 value)
 182 {
 183         struct apple_sc *asc = hid_get_drvdata(hid);
 184         const struct apple_key_translation *trans, *table;
 185         bool do_translate;
 186         u16 code = 0;
 187
 188         if (usage->code == KEY_FN) {
 189                 asc->fn_on = !!value;
 190                 input_event(input, usage->type, usage->code, value);
 191                 return 1;
 192         }
 193
 194         if (fnmode) {
 195                 if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
 196                                 hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
 197                         table = macbookair_fn_keys;
 198                 else if (hid->product < 0x21d || hid->product >= 0x300)
 199                         table = powerbook_fn_keys;
 200                 else
 201                         table = apple_fn_keys;
 202
 203                 trans = apple_find_translation (table, usage->code);
 204
 205                 if (trans) {
 206                         if (test_bit(trans->from, input->key))
 207                                 code = trans->from;
 208                         else if (test_bit(trans->to, input->key))
 209                                 code = trans->to;
 210
 211                         if (!code) {
 212                                 if (trans->flags & APPLE_FLAG_FKEY) {
 213                                         switch (fnmode) {
 214                                         case 1:
 215                                                 do_translate = !asc->fn_on;
 216                                                 break;
 217                                         case 2:
 218                                                 do_translate = asc->fn_on;
 219                                                 break;
 220                                         default:
 221                                                 /* should never happen */
 222                                                 do_translate = false;
 223                                         }
 224                                 } else {
 225                                         do_translate = asc->fn_on;
 226                                 }
 227
 228                                 code = do_translate ? trans->to : trans->from;
 229                         }
 230
 231                         input_event(input, usage->type, code, value);
 232                         return 1;
 233                 }
 234
 235                 if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
 236                                 (test_bit(usage->code, asc->pressed_numlock) ||
 237                                 test_bit(LED_NUML, input->led))) {
 238                         trans = apple_find_translation(powerbook_numlock_keys,
 239                                         usage->code);
 240
 241                         if (trans) {
 242                                 if (value)
 243                                         set_bit(usage->code,
 244                                                         asc->pressed_numlock);
 245                                 else
 246                                         clear_bit(usage->code,
 247                                                         asc->pressed_numlock);
 248
 249                                 input_event(input, usage->type, trans->to,
 250                                                 value);
 251                         }
 252
 253                         return 1;
 254                 }
 255         }
 256
 257         if (iso_layout) {
 258                 if (asc->quirks & APPLE_ISO_KEYBOARD) {
 259                         trans = apple_find_translation(apple_iso_keyboard, usage->code);
 260                         if (trans) {
 261                                 input_event(input, usage->type, trans->to, value);
 262                                 return 1;
 263                         }
 264                 }
 265         }
 266
 267         if (swap_opt_cmd) {
 268                 trans = apple_find_translation(swapped_option_cmd_keys, usage->code);
 269                 if (trans) {
 270                         input_event(input, usage->type, trans->to, value);
 271                         return 1;
 272                 }
 273         }
 274
 275         return 0;
 276 }
 277
 278 static int apple_event(struct hid_device *hdev, struct hid_field *field,
 279                 struct hid_usage *usage, __s32 value)
 280 {
 281         struct apple_sc *asc = hid_get_drvdata(hdev);
 282
 283         if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
 284                         !usage->type)
 285                 return 0;
 286
 287         if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
 288                         usage->code == REL_HWHEEL) {
 289                 input_event(field->hidinput->input, usage->type, usage->code,
 290                                 -value);
 291                 return 1;
 292         }
 293
 294         if ((asc->quirks & APPLE_HAS_FN) &&
 295                         hidinput_apple_event(hdev, field->hidinput->input,
 296                                 usage, value))
 297                 return 1;
 298
 299
 300         return 0;
 301 }
 302
 303 /*
 304  * MacBook JIS keyboard has wrong logical maximum
 305  * Magic Keyboard JIS has wrong logical maximum
 306  */
 307 static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 308                 unsigned int *rsize)
 309 {
 310         struct apple_sc *asc = hid_get_drvdata(hdev);
 311
 312         if(*rsize >=71 && rdesc[70] == 0x65 && rdesc[64] == 0x65) {
 313                 hid_info(hdev,
 314                          "fixing up Magic Keyboard JIS report descriptor\n");
 315                 rdesc[64] = rdesc[70] = 0xe7;
 316         }
 317
 318         if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
 319                         rdesc[53] == 0x65 && rdesc[59] == 0x65) {
 320                 hid_info(hdev,
 321                          "fixing up MacBook JIS keyboard report descriptor\n");
 322                 rdesc[53] = rdesc[59] = 0xe7;
 323         }
 324         return rdesc;
 325 }
 326
 327 static void apple_setup_input(struct input_dev *input)
 328 {
 329         const struct apple_key_translation *trans;
 330
 331         set_bit(KEY_NUMLOCK, input->keybit);
 332
 333         /* Enable all needed keys */
 334         for (trans = apple_fn_keys; trans->from; trans++)
 335                 set_bit(trans->to, input->keybit);
 336
 337         for (trans = powerbook_fn_keys; trans->from; trans++)
 338                 set_bit(trans->to, input->keybit);
 339
 340         for (trans = powerbook_numlock_keys; trans->from; trans++)
 341                 set_bit(trans->to, input->keybit);
 342
 343         for (trans = apple_iso_keyboard; trans->from; trans++)
 344                 set_bit(trans->to, input->keybit);
 345 }
 346
 347 static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 348                 struct hid_field *field, struct hid_usage *usage,
 349                 unsigned long **bit, int *max)
 350 {
 351         struct apple_sc *asc = hid_get_drvdata(hdev);
 352
 353         if (usage->hid == (HID_UP_CUSTOM | 0x0003) ||
 354                         usage->hid == (HID_UP_MSVENDOR | 0x0003) ||
 355                         usage->hid == (HID_UP_HPVENDOR2 | 0x0003)) {
 356                 /* The fn key on Apple USB keyboards */
 357                 set_bit(EV_REP, hi->input->evbit);
 358                 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
 359                 asc->fn_found = true;
 360                 apple_setup_input(hi->input);
 361                 return 1;
 362         }
 363
 364         /* we want the hid layer to go through standard path (set and ignore) */
 365         return 0;
 366 }
 367
 368 static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 369                 struct hid_field *field, struct hid_usage *usage,
 370                 unsigned long **bit, int *max)
 371 {
 372         struct apple_sc *asc = hid_get_drvdata(hdev);
 373
 374         if (asc->quirks & APPLE_MIGHTYMOUSE) {
 375                 if (usage->hid == HID_GD_Z)
 376                         hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
 377                 else if (usage->code == BTN_1)
 378                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
 379                 else if (usage->code == BTN_2)
 380                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
 381         }
 382
 383         return 0;
 384 }
 385
 386 static int apple_input_configured(struct hid_device *hdev,
 387                 struct hid_input *hidinput)
 388 {
 389         struct apple_sc *asc = hid_get_drvdata(hdev);
 390
 391         if ((asc->quirks & APPLE_HAS_FN) && !asc->fn_found) {
 392                 hid_info(hdev, "Fn key not found (Apple Wireless Keyboard clone?), disabling Fn key handling\n");
 393                 asc->quirks &= ~APPLE_HAS_FN;
 394         }
 395
 396         return 0;
 397 }
 398
 399 static int apple_probe(struct hid_device *hdev,
 400                 const struct hid_device_id *id)
 401 {
 402         unsigned long quirks = id->driver_data;
 403         struct apple_sc *asc;
 404         unsigned int connect_mask = HID_CONNECT_DEFAULT;
 405         int ret;
 406
 407         asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
 408         if (asc == NULL) {
 409                 hid_err(hdev, "can't alloc apple descriptor\n");
 410                 return -ENOMEM;
 411         }
 412
 413         asc->quirks = quirks;
 414
 415         hid_set_drvdata(hdev, asc);
 416
 417         ret = hid_parse(hdev);
 418         if (ret) {
 419                 hid_err(hdev, "parse failed\n");
 420                 return ret;
 421         }
 422
 423         if (quirks & APPLE_HIDDEV)
 424                 connect_mask |= HID_CONNECT_HIDDEV_FORCE;
 425         if (quirks & APPLE_IGNORE_HIDINPUT)
 426                 connect_mask &= ~HID_CONNECT_HIDINPUT;
 427
 428         ret = hid_hw_start(hdev, connect_mask);
 429         if (ret) {
 430                 hid_err(hdev, "hw start failed\n");
 431                 return ret;
 432         }
 433
 434         return 0;
 435 }
 436
 437 static const struct hid_device_id apple_devices[] = {
 438         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
 439                 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
 440
 441         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
 442                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 443         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
 444                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 445         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
 446                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 447         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
 448                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 449                         APPLE_ISO_KEYBOARD },
 450         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
 451                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 452         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
 453                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 454         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
 455                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 456                         APPLE_ISO_KEYBOARD },
 457         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
 458                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 459                         APPLE_RDESC_JIS },
 460         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
 461                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 462         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
 463                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 464                         APPLE_ISO_KEYBOARD },
 465         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
 466                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 467                         APPLE_RDESC_JIS },
 468         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
 469                 .driver_data = APPLE_HAS_FN },
 470         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
 471                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 472         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
 473                 .driver_data = APPLE_HAS_FN },
 474         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
 475                 .driver_data = APPLE_HAS_FN },
 476         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
 477                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 478         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
 479                 .driver_data = APPLE_HAS_FN },
 480         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
 481                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 482         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
 483                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 484                         APPLE_ISO_KEYBOARD },
 485         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
 486                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 487                         APPLE_RDESC_JIS },
 488         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
 489                 .driver_data = APPLE_HAS_FN },
 490         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
 491                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 492         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
 493                 .driver_data = APPLE_HAS_FN },
 494         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
 495                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 496         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
 497                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 498                         APPLE_ISO_KEYBOARD },
 499         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
 500                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 501                         APPLE_ISO_KEYBOARD },
 502         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 503                                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
 504                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 505         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 506                                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
 507                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 508         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
 509                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 510         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_ANSI),
 511                 .driver_data = APPLE_HAS_FN },
 512         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_ANSI),
 513                 .driver_data = APPLE_HAS_FN },
 514         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_ANSI),
 515                 .driver_data = APPLE_HAS_FN },
 516         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_ANSI),
 517                 .driver_data = APPLE_HAS_FN },
 518         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
 519                 .driver_data = APPLE_HAS_FN },
 520         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
 521                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 522         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
 523                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 524         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
 525                 .driver_data = APPLE_HAS_FN },
 526         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
 527                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 528         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
 529                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 530         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
 531                 .driver_data = APPLE_HAS_FN },
 532         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
 533                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 534         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
 535                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 536         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
 537                 .driver_data = APPLE_HAS_FN },
 538         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
 539                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 540         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
 541                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 542         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
 543                 .driver_data = APPLE_HAS_FN },
 544         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
 545                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 546         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
 547                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 548         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
 549                 .driver_data = APPLE_HAS_FN },
 550         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
 551                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 552         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
 553                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 554         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
 555                 .driver_data = APPLE_HAS_FN },
 556         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
 557                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 558         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
 559                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 560         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
 561                 .driver_data = APPLE_HAS_FN },
 562         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
 563                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 564         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
 565                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 566         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
 567                 .driver_data = APPLE_HAS_FN },
 568         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
 569                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 570         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
 571                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 572         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
 573                 .driver_data = APPLE_HAS_FN },
 574         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
 575                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 576         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
 577                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 578         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
 579                 .driver_data = APPLE_HAS_FN },
 580         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
 581                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 582         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
 583                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 584         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
 585                 .driver_data = APPLE_HAS_FN },
 586         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
 587                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 588         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
 589                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 590         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
 591                 .driver_data = APPLE_HAS_FN },
 592         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
 593                 .driver_data = APPLE_HAS_FN | APPLE_ISO_KEYBOARD },
 594         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
 595                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 596         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
 597                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 598         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
 599                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 600                         APPLE_ISO_KEYBOARD },
 601         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
 602                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 603         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
 604                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 605         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
 606                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 607
 608         { }
 609 };
 610 MODULE_DEVICE_TABLE(hid, apple_devices);
 611
 612 static struct hid_driver apple_driver = {
 613         .name = "apple",
 614         .id_table = apple_devices,
 615         .report_fixup = apple_report_fixup,
 616         .probe = apple_probe,
 617         .event = apple_event,
 618         .input_mapping = apple_input_mapping,
 619         .input_mapped = apple_input_mapped,
 620         .input_configured = apple_input_configured,
 621 };
 622 module_hid_driver(apple_driver);
 623
 624 MODULE_LICENSE("GPL");