linux/drivers/hid/hid-apple.c
<<
>>
Prefs
   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
  38static unsigned int fnmode = 1;
  39module_param(fnmode, uint, 0644);
  40MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
  41                "[1] = fkeyslast, 2 = fkeysfirst)");
  42
  43static unsigned int iso_layout = 1;
  44module_param(iso_layout, uint, 0644);
  45MODULE_PARM_DESC(iso_layout, "Enable/Disable hardcoded ISO-layout of the keyboard. "
  46                "(0 = disabled, [1] = enabled)");
  47
  48static unsigned int swap_opt_cmd;
  49module_param(swap_opt_cmd, uint, 0644);
  50MODULE_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
  54static unsigned int swap_fn_leftctrl;
  55module_param(swap_fn_leftctrl, uint, 0644);
  56MODULE_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
  60struct 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
  67struct apple_key_translation {
  68        u16 from;
  69        u16 to;
  70        u8 flags;
  71};
  72
  73static 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
  94static 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
 116static 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
 135static 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
 158static const struct apple_key_translation apple_iso_keyboard[] = {
 159        { KEY_GRAVE,    KEY_102ND },
 160        { KEY_102ND,    KEY_GRAVE },
 161        { }
 162};
 163
 164static 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
 172static const struct apple_key_translation swapped_fn_leftctrl_keys[] = {
 173        { KEY_FN, KEY_LEFTCTRL },
 174        { }
 175};
 176
 177static 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
 190static 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
 298static 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 */
 326static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 327                unsigned int *rsize)
 328{
 329        struct apple_sc *asc = hid_get_drvdata(hdev);
 330
 331        if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
 332                        rdesc[53] == 0x65 && rdesc[59] == 0x65) {
 333                hid_info(hdev,
 334                         "fixing up MacBook JIS keyboard report descriptor\n");
 335                rdesc[53] = rdesc[59] = 0xe7;
 336        }
 337        return rdesc;
 338}
 339
 340static void apple_setup_input(struct input_dev *input)
 341{
 342        const struct apple_key_translation *trans;
 343
 344        set_bit(KEY_NUMLOCK, input->keybit);
 345
 346        /* Enable all needed keys */
 347        for (trans = apple_fn_keys; trans->from; trans++)
 348                set_bit(trans->to, input->keybit);
 349
 350        for (trans = powerbook_fn_keys; trans->from; trans++)
 351                set_bit(trans->to, input->keybit);
 352
 353        for (trans = powerbook_numlock_keys; trans->from; trans++)
 354                set_bit(trans->to, input->keybit);
 355
 356        for (trans = apple_iso_keyboard; trans->from; trans++)
 357                set_bit(trans->to, input->keybit);
 358
 359        if (swap_fn_leftctrl) {
 360                for (trans = swapped_fn_leftctrl_keys; trans->from; trans++)
 361                        set_bit(trans->to, input->keybit);
 362        }
 363}
 364
 365static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 366                struct hid_field *field, struct hid_usage *usage,
 367                unsigned long **bit, int *max)
 368{
 369        struct apple_sc *asc = hid_get_drvdata(hdev);
 370
 371        if (usage->hid == (HID_UP_CUSTOM | 0x0003) ||
 372                        usage->hid == (HID_UP_MSVENDOR | 0x0003) ||
 373                        usage->hid == (HID_UP_HPVENDOR2 | 0x0003)) {
 374                /* The fn key on Apple USB keyboards */
 375                set_bit(EV_REP, hi->input->evbit);
 376                hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
 377                asc->fn_found = true;
 378                apple_setup_input(hi->input);
 379                return 1;
 380        }
 381
 382        /* we want the hid layer to go through standard path (set and ignore) */
 383        return 0;
 384}
 385
 386static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 387                struct hid_field *field, struct hid_usage *usage,
 388                unsigned long **bit, int *max)
 389{
 390        struct apple_sc *asc = hid_get_drvdata(hdev);
 391
 392        if (asc->quirks & APPLE_MIGHTYMOUSE) {
 393                if (usage->hid == HID_GD_Z)
 394                        hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
 395                else if (usage->code == BTN_1)
 396                        hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
 397                else if (usage->code == BTN_2)
 398                        hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
 399        }
 400
 401        return 0;
 402}
 403
 404static int apple_input_configured(struct hid_device *hdev,
 405                struct hid_input *hidinput)
 406{
 407        struct apple_sc *asc = hid_get_drvdata(hdev);
 408
 409        if ((asc->quirks & APPLE_HAS_FN) && !asc->fn_found) {
 410                hid_info(hdev, "Fn key not found (Apple Wireless Keyboard clone?), disabling Fn key handling\n");
 411                asc->quirks = 0;
 412        }
 413
 414        return 0;
 415}
 416
 417static int apple_probe(struct hid_device *hdev,
 418                const struct hid_device_id *id)
 419{
 420        unsigned long quirks = id->driver_data;
 421        struct apple_sc *asc;
 422        unsigned int connect_mask = HID_CONNECT_DEFAULT;
 423        int ret;
 424
 425        asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
 426        if (asc == NULL) {
 427                hid_err(hdev, "can't alloc apple descriptor\n");
 428                return -ENOMEM;
 429        }
 430
 431        asc->quirks = quirks;
 432
 433        hid_set_drvdata(hdev, asc);
 434
 435        ret = hid_parse(hdev);
 436        if (ret) {
 437                hid_err(hdev, "parse failed\n");
 438                return ret;
 439        }
 440
 441        if (quirks & APPLE_HIDDEV)
 442                connect_mask |= HID_CONNECT_HIDDEV_FORCE;
 443        if (quirks & APPLE_IGNORE_HIDINPUT)
 444                connect_mask &= ~HID_CONNECT_HIDINPUT;
 445
 446        ret = hid_hw_start(hdev, connect_mask);
 447        if (ret) {
 448                hid_err(hdev, "hw start failed\n");
 449                return ret;
 450        }
 451
 452        return 0;
 453}
 454
 455static const struct hid_device_id apple_devices[] = {
 456        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
 457                .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
 458
 459        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
 460                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 461        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
 462                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 463        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
 464                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 465        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
 466                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 467        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
 468                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 469        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
 470                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 471        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
 472                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 473        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
 474                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 475                        APPLE_RDESC_JIS },
 476        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
 477                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 478        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
 479                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 480        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_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_ALU_MINI_ANSI),
 484                .driver_data = APPLE_HAS_FN },
 485        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
 486                .driver_data = APPLE_HAS_FN },
 487        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
 488                .driver_data = APPLE_HAS_FN },
 489        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
 490                .driver_data = APPLE_HAS_FN },
 491        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
 492                .driver_data = APPLE_HAS_FN },
 493        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
 494                .driver_data = APPLE_HAS_FN },
 495        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
 496                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 497        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
 498                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 499        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
 500                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 501                        APPLE_RDESC_JIS },
 502        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
 503                .driver_data = APPLE_HAS_FN },
 504        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
 505                .driver_data = APPLE_HAS_FN },
 506        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
 507                .driver_data = APPLE_HAS_FN },
 508        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
 509                .driver_data = APPLE_HAS_FN },
 510        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
 511                .driver_data = APPLE_HAS_FN },
 512        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
 513                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 514        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
 515                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 516        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
 517                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 518        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 519                                USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
 520                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 521        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 522                                USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
 523                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 524        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
 525                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 526        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_ANSI),
 527                .driver_data = APPLE_HAS_FN },
 528        { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_ANSI),
 529                .driver_data = APPLE_HAS_FN },
 530        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_ANSI),
 531                .driver_data = APPLE_HAS_FN },
 532        { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_ANSI),
 533                .driver_data = APPLE_HAS_FN },
 534        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
 535                .driver_data = APPLE_HAS_FN },
 536        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
 537                .driver_data = APPLE_HAS_FN },
 538        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
 539                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 540        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
 541                .driver_data = APPLE_HAS_FN },
 542        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
 543                .driver_data = APPLE_HAS_FN },
 544        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
 545                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 546        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
 547                .driver_data = APPLE_HAS_FN },
 548        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
 549                .driver_data = APPLE_HAS_FN },
 550        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
 551                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 552        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
 553                .driver_data = APPLE_HAS_FN },
 554        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
 555                .driver_data = APPLE_HAS_FN },
 556        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
 557                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 558        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
 559                .driver_data = APPLE_HAS_FN },
 560        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
 561                .driver_data = APPLE_HAS_FN },
 562        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
 563                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 564        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
 565                .driver_data = APPLE_HAS_FN },
 566        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
 567                .driver_data = APPLE_HAS_FN },
 568        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
 569                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 570        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
 571                .driver_data = APPLE_HAS_FN },
 572        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
 573                .driver_data = APPLE_HAS_FN },
 574        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
 575                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 576        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
 577                .driver_data = APPLE_HAS_FN },
 578        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
 579                .driver_data = APPLE_HAS_FN },
 580        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
 581                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 582        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
 583                .driver_data = APPLE_HAS_FN },
 584        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
 585                .driver_data = APPLE_HAS_FN },
 586        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
 587                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 588        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
 589                .driver_data = APPLE_HAS_FN },
 590        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
 591                .driver_data = APPLE_HAS_FN },
 592        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
 593                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 594        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
 595                .driver_data = APPLE_HAS_FN },
 596        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
 597                .driver_data = APPLE_HAS_FN },
 598        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
 599                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 600        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
 601                .driver_data = APPLE_HAS_FN },
 602        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
 603                .driver_data = APPLE_HAS_FN },
 604        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
 605                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 606        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
 607                .driver_data = APPLE_HAS_FN },
 608        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
 609                .driver_data = APPLE_HAS_FN },
 610        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
 611                .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 612        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
 613                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 614        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
 615                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 616        { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
 617                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 618        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
 619                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 620        { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
 621                .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 622
 623        { }
 624};
 625MODULE_DEVICE_TABLE(hid, apple_devices);
 626
 627static struct hid_driver apple_driver = {
 628        .name = "apple",
 629        .id_table = apple_devices,
 630        .report_fixup = apple_report_fixup,
 631        .probe = apple_probe,
 632        .event = apple_event,
 633        .input_mapping = apple_input_mapping,
 634        .input_mapped = apple_input_mapped,
 635        .input_configured = apple_input_configured,
 636};
 637module_hid_driver(apple_driver);
 638
 639MODULE_LICENSE("GPL");
 640