drivers/hid/hid-apple.c

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