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  *  Copyright (c) 2019 Paul Pawlowski <paul@mrarm.io>
  11  */
  12
  13 /*
  14  */
  15
  16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  17
  18 #include <linux/device.h>
  19 #include <linux/hid.h>
  20 #include <linux/jiffies.h>
  21 #include <linux/module.h>
  22 #include <linux/slab.h>
  23 #include <linux/timer.h>
  24 #include <linux/string.h>
  25 #include <linux/leds.h>
  26
  27 #include "hid-ids.h"
  28
  29 #define APPLE_RDESC_JIS         BIT(0)
  30 #define APPLE_IGNORE_MOUSE      BIT(1)
  31 #define APPLE_HAS_FN            BIT(2)
  32 /* BIT(3) reserved, was: APPLE_HIDDEV */
  33 #define APPLE_ISO_TILDE_QUIRK   BIT(4)
  34 #define APPLE_MIGHTYMOUSE       BIT(5)
  35 #define APPLE_INVERT_HWHEEL     BIT(6)
  36 /* BIT(7) reserved, was: APPLE_IGNORE_HIDINPUT */
  37 #define APPLE_NUMLOCK_EMULATION BIT(8)
  38 #define APPLE_RDESC_BATTERY     BIT(9)
  39 #define APPLE_BACKLIGHT_CTL     BIT(10)
  40 #define APPLE_IS_NON_APPLE      BIT(11)
  41
  42 #define APPLE_FLAG_FKEY         0x01
  43
  44 #define HID_COUNTRY_INTERNATIONAL_ISO   13
  45 #define APPLE_BATTERY_TIMEOUT_MS        60000
  46
  47 static unsigned int fnmode = 3;
  48 module_param(fnmode, uint, 0644);
  49 MODULE_PARM_DESC(fnmode, "Mode of fn key on Apple keyboards (0 = disabled, "
  50                 "1 = fkeyslast, 2 = fkeysfirst, [3] = auto)");
  51
  52 static int iso_layout = -1;
  53 module_param(iso_layout, int, 0644);
  54 MODULE_PARM_DESC(iso_layout, "Swap the backtick/tilde and greater-than/less-than keys. "
  55                 "([-1] = auto, 0 = disabled, 1 = enabled)");
  56
  57 static unsigned int swap_opt_cmd;
  58 module_param(swap_opt_cmd, uint, 0644);
  59 MODULE_PARM_DESC(swap_opt_cmd, "Swap the Option (\"Alt\") and Command (\"Flag\") keys. "
  60                 "(For people who want to keep Windows PC keyboard muscle memory. "
  61                 "[0] = as-is, Mac layout. 1 = swapped, Windows layout.)");
  62
  63 static unsigned int swap_ctrl_cmd;
  64 module_param(swap_ctrl_cmd, uint, 0644);
  65 MODULE_PARM_DESC(swap_ctrl_cmd, "Swap the Control (\"Ctrl\") and Command (\"Flag\") keys. "
  66                 "(For people who are used to Mac shortcuts involving Command instead of Control. "
  67                 "[0] = No change. 1 = Swapped.)");
  68
  69 static unsigned int swap_fn_leftctrl;
  70 module_param(swap_fn_leftctrl, uint, 0644);
  71 MODULE_PARM_DESC(swap_fn_leftctrl, "Swap the Fn and left Control keys. "
  72                 "(For people who want to keep PC keyboard muscle memory. "
  73                 "[0] = as-is, Mac layout, 1 = swapped, PC layout)");
  74
  75 struct apple_non_apple_keyboard {
  76         char *name;
  77 };
  78
  79 struct apple_sc_backlight {
  80         struct led_classdev cdev;
  81         struct hid_device *hdev;
  82         unsigned short backlight_off, backlight_on_min, backlight_on_max;
  83 };
  84
  85 struct apple_sc {
  86         struct hid_device *hdev;
  87         unsigned long quirks;
  88         unsigned int fn_on;
  89         unsigned int fn_found;
  90         DECLARE_BITMAP(pressed_numlock, KEY_CNT);
  91         struct timer_list battery_timer;
  92         struct apple_sc_backlight *backlight;
  93 };
  94
  95 struct apple_key_translation {
  96         u16 from;
  97         u16 to;
  98         u8 flags;
  99 };
 100
 101 static const struct apple_key_translation magic_keyboard_alu_fn_keys[] = {
 102         { KEY_BACKSPACE, KEY_DELETE },
 103         { KEY_ENTER,    KEY_INSERT },
 104         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
 105         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
 106         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
 107         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
 108         { KEY_F6,       KEY_NUMLOCK,        APPLE_FLAG_FKEY },
 109         { KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
 110         { KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 111         { KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 112         { KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
 113         { KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 114         { KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 115         { KEY_UP,       KEY_PAGEUP },
 116         { KEY_DOWN,     KEY_PAGEDOWN },
 117         { KEY_LEFT,     KEY_HOME },
 118         { KEY_RIGHT,    KEY_END },
 119         { }
 120 };
 121
 122 static const struct apple_key_translation magic_keyboard_2015_fn_keys[] = {
 123         { KEY_BACKSPACE, KEY_DELETE },
 124         { KEY_ENTER,    KEY_INSERT },
 125         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
 126         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
 127         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
 128         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
 129         { KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
 130         { KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 131         { KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 132         { KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
 133         { KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 134         { KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 135         { KEY_UP,       KEY_PAGEUP },
 136         { KEY_DOWN,     KEY_PAGEDOWN },
 137         { KEY_LEFT,     KEY_HOME },
 138         { KEY_RIGHT,    KEY_END },
 139         { }
 140 };
 141
 142 struct apple_backlight_config_report {
 143         u8 report_id;
 144         u8 version;
 145         u16 backlight_off, backlight_on_min, backlight_on_max;
 146 };
 147
 148 struct apple_backlight_set_report {
 149         u8 report_id;
 150         u8 version;
 151         u16 backlight;
 152         u16 rate;
 153 };
 154
 155
 156 static const struct apple_key_translation apple2021_fn_keys[] = {
 157         { KEY_BACKSPACE, KEY_DELETE },
 158         { KEY_ENTER,    KEY_INSERT },
 159         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
 160         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
 161         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
 162         { KEY_F4,       KEY_SEARCH,         APPLE_FLAG_FKEY },
 163         { KEY_F5,       KEY_MICMUTE,        APPLE_FLAG_FKEY },
 164         { KEY_F6,       KEY_SLEEP,          APPLE_FLAG_FKEY },
 165         { KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
 166         { KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 167         { KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 168         { KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
 169         { KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 170         { KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 171         { KEY_UP,       KEY_PAGEUP },
 172         { KEY_DOWN,     KEY_PAGEDOWN },
 173         { KEY_LEFT,     KEY_HOME },
 174         { KEY_RIGHT,    KEY_END },
 175         { }
 176 };
 177
 178 static const struct apple_key_translation macbookair_fn_keys[] = {
 179         { KEY_BACKSPACE, KEY_DELETE },
 180         { KEY_ENTER,    KEY_INSERT },
 181         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
 182         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
 183         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
 184         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
 185         { KEY_F6,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
 186         { KEY_F7,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 187         { KEY_F8,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 188         { KEY_F9,       KEY_MUTE,           APPLE_FLAG_FKEY },
 189         { KEY_F10,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 190         { KEY_F11,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 191         { KEY_F12,      KEY_EJECTCD,        APPLE_FLAG_FKEY },
 192         { KEY_UP,       KEY_PAGEUP },
 193         { KEY_DOWN,     KEY_PAGEDOWN },
 194         { KEY_LEFT,     KEY_HOME },
 195         { KEY_RIGHT,    KEY_END },
 196         { }
 197 };
 198
 199 static const struct apple_key_translation macbookpro_no_esc_fn_keys[] = {
 200         { KEY_BACKSPACE, KEY_DELETE },
 201         { KEY_ENTER,    KEY_INSERT },
 202         { KEY_GRAVE,    KEY_ESC },
 203         { KEY_1,        KEY_F1 },
 204         { KEY_2,        KEY_F2 },
 205         { KEY_3,        KEY_F3 },
 206         { KEY_4,        KEY_F4 },
 207         { KEY_5,        KEY_F5 },
 208         { KEY_6,        KEY_F6 },
 209         { KEY_7,        KEY_F7 },
 210         { KEY_8,        KEY_F8 },
 211         { KEY_9,        KEY_F9 },
 212         { KEY_0,        KEY_F10 },
 213         { KEY_MINUS,    KEY_F11 },
 214         { KEY_EQUAL,    KEY_F12 },
 215         { KEY_UP,       KEY_PAGEUP },
 216         { KEY_DOWN,     KEY_PAGEDOWN },
 217         { KEY_LEFT,     KEY_HOME },
 218         { KEY_RIGHT,    KEY_END },
 219         { }
 220 };
 221
 222 static const struct apple_key_translation macbookpro_dedicated_esc_fn_keys[] = {
 223         { KEY_BACKSPACE, KEY_DELETE },
 224         { KEY_ENTER,    KEY_INSERT },
 225         { KEY_1,        KEY_F1 },
 226         { KEY_2,        KEY_F2 },
 227         { KEY_3,        KEY_F3 },
 228         { KEY_4,        KEY_F4 },
 229         { KEY_5,        KEY_F5 },
 230         { KEY_6,        KEY_F6 },
 231         { KEY_7,        KEY_F7 },
 232         { KEY_8,        KEY_F8 },
 233         { KEY_9,        KEY_F9 },
 234         { KEY_0,        KEY_F10 },
 235         { KEY_MINUS,    KEY_F11 },
 236         { KEY_EQUAL,    KEY_F12 },
 237         { KEY_UP,       KEY_PAGEUP },
 238         { KEY_DOWN,     KEY_PAGEDOWN },
 239         { KEY_LEFT,     KEY_HOME },
 240         { KEY_RIGHT,    KEY_END },
 241         { }
 242 };
 243
 244 static const struct apple_key_translation apple_fn_keys[] = {
 245         { KEY_BACKSPACE, KEY_DELETE },
 246         { KEY_ENTER,    KEY_INSERT },
 247         { KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
 248         { KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
 249         { KEY_F3,       KEY_SCALE,          APPLE_FLAG_FKEY },
 250         { KEY_F4,       KEY_DASHBOARD,      APPLE_FLAG_FKEY },
 251         { KEY_F5,       KEY_KBDILLUMDOWN,   APPLE_FLAG_FKEY },
 252         { KEY_F6,       KEY_KBDILLUMUP,     APPLE_FLAG_FKEY },
 253         { KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
 254         { KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
 255         { KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
 256         { KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
 257         { KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
 258         { KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
 259         { KEY_UP,       KEY_PAGEUP },
 260         { KEY_DOWN,     KEY_PAGEDOWN },
 261         { KEY_LEFT,     KEY_HOME },
 262         { KEY_RIGHT,    KEY_END },
 263         { }
 264 };
 265
 266 static const struct apple_key_translation powerbook_fn_keys[] = {
 267         { KEY_BACKSPACE, KEY_DELETE },
 268         { KEY_F1,       KEY_BRIGHTNESSDOWN,     APPLE_FLAG_FKEY },
 269         { KEY_F2,       KEY_BRIGHTNESSUP,       APPLE_FLAG_FKEY },
 270         { KEY_F3,       KEY_MUTE,               APPLE_FLAG_FKEY },
 271         { KEY_F4,       KEY_VOLUMEDOWN,         APPLE_FLAG_FKEY },
 272         { KEY_F5,       KEY_VOLUMEUP,           APPLE_FLAG_FKEY },
 273         { KEY_F6,       KEY_NUMLOCK,            APPLE_FLAG_FKEY },
 274         { KEY_F7,       KEY_SWITCHVIDEOMODE,    APPLE_FLAG_FKEY },
 275         { KEY_F8,       KEY_KBDILLUMTOGGLE,     APPLE_FLAG_FKEY },
 276         { KEY_F9,       KEY_KBDILLUMDOWN,       APPLE_FLAG_FKEY },
 277         { KEY_F10,      KEY_KBDILLUMUP,         APPLE_FLAG_FKEY },
 278         { KEY_UP,       KEY_PAGEUP },
 279         { KEY_DOWN,     KEY_PAGEDOWN },
 280         { KEY_LEFT,     KEY_HOME },
 281         { KEY_RIGHT,    KEY_END },
 282         { }
 283 };
 284
 285 static const struct apple_key_translation powerbook_numlock_keys[] = {
 286         { KEY_J,        KEY_KP1 },
 287         { KEY_K,        KEY_KP2 },
 288         { KEY_L,        KEY_KP3 },
 289         { KEY_U,        KEY_KP4 },
 290         { KEY_I,        KEY_KP5 },
 291         { KEY_O,        KEY_KP6 },
 292         { KEY_7,        KEY_KP7 },
 293         { KEY_8,        KEY_KP8 },
 294         { KEY_9,        KEY_KP9 },
 295         { KEY_M,        KEY_KP0 },
 296         { KEY_DOT,      KEY_KPDOT },
 297         { KEY_SLASH,    KEY_KPPLUS },
 298         { KEY_SEMICOLON, KEY_KPMINUS },
 299         { KEY_P,        KEY_KPASTERISK },
 300         { KEY_MINUS,    KEY_KPEQUAL },
 301         { KEY_0,        KEY_KPSLASH },
 302         { KEY_F6,       KEY_NUMLOCK },
 303         { KEY_KPENTER,  KEY_KPENTER },
 304         { KEY_BACKSPACE, KEY_BACKSPACE },
 305         { }
 306 };
 307
 308 static const struct apple_key_translation apple_iso_keyboard[] = {
 309         { KEY_GRAVE,    KEY_102ND },
 310         { KEY_102ND,    KEY_GRAVE },
 311         { }
 312 };
 313
 314 static const struct apple_key_translation swapped_option_cmd_keys[] = {
 315         { KEY_LEFTALT,  KEY_LEFTMETA },
 316         { KEY_LEFTMETA, KEY_LEFTALT },
 317         { KEY_RIGHTALT, KEY_RIGHTMETA },
 318         { KEY_RIGHTMETA, KEY_RIGHTALT },
 319         { }
 320 };
 321
 322 static const struct apple_key_translation swapped_ctrl_cmd_keys[] = {
 323         { KEY_LEFTCTRL, KEY_LEFTMETA },
 324         { KEY_LEFTMETA, KEY_LEFTCTRL },
 325         { KEY_RIGHTCTRL, KEY_RIGHTMETA },
 326         { KEY_RIGHTMETA, KEY_RIGHTCTRL },
 327         { }
 328 };
 329
 330 static const struct apple_key_translation swapped_fn_leftctrl_keys[] = {
 331         { KEY_FN, KEY_LEFTCTRL },
 332         { KEY_LEFTCTRL, KEY_FN },
 333         { }
 334 };
 335
 336 static const struct apple_non_apple_keyboard non_apple_keyboards[] = {
 337         { "SONiX USB DEVICE" },
 338         { "Keychron" },
 339         { "AONE" },
 340         { "GANSS" }
 341 };
 342
 343 static bool apple_is_non_apple_keyboard(struct hid_device *hdev)
 344 {
 345         int i;
 346
 347         for (i = 0; i < ARRAY_SIZE(non_apple_keyboards); i++) {
 348                 char *non_apple = non_apple_keyboards[i].name;
 349
 350                 if (strncmp(hdev->name, non_apple, strlen(non_apple)) == 0)
 351                         return true;
 352         }
 353
 354         return false;
 355 }
 356
 357 static inline void apple_setup_key_translation(struct input_dev *input,
 358                 const struct apple_key_translation *table)
 359 {
 360         const struct apple_key_translation *trans;
 361
 362         for (trans = table; trans->from; trans++)
 363                 set_bit(trans->to, input->keybit);
 364 }
 365
 366 static const struct apple_key_translation *apple_find_translation(
 367                 const struct apple_key_translation *table, u16 from)
 368 {
 369         const struct apple_key_translation *trans;
 370
 371         /* Look for the translation */
 372         for (trans = table; trans->from; trans++)
 373                 if (trans->from == from)
 374                         return trans;
 375
 376         return NULL;
 377 }
 378
 379 static void input_event_with_scancode(struct input_dev *input,
 380                 __u8 type, __u16 code, unsigned int hid, __s32 value)
 381 {
 382         if (type == EV_KEY &&
 383             (!test_bit(code, input->key)) == value)
 384                 input_event(input, EV_MSC, MSC_SCAN, hid);
 385         input_event(input, type, code, value);
 386 }
 387
 388 static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
 389                 struct hid_usage *usage, __s32 value)
 390 {
 391         struct apple_sc *asc = hid_get_drvdata(hid);
 392         const struct apple_key_translation *trans, *table;
 393         bool do_translate;
 394         u16 code = usage->code;
 395         unsigned int real_fnmode;
 396
 397         if (fnmode == 3) {
 398                 real_fnmode = (asc->quirks & APPLE_IS_NON_APPLE) ? 2 : 1;
 399         } else {
 400                 real_fnmode = fnmode;
 401         }
 402
 403         if (swap_fn_leftctrl) {
 404                 trans = apple_find_translation(swapped_fn_leftctrl_keys, code);
 405
 406                 if (trans)
 407                         code = trans->to;
 408         }
 409
 410         if (iso_layout > 0 || (iso_layout < 0 && (asc->quirks & APPLE_ISO_TILDE_QUIRK) &&
 411                         hid->country == HID_COUNTRY_INTERNATIONAL_ISO)) {
 412                 trans = apple_find_translation(apple_iso_keyboard, code);
 413
 414                 if (trans)
 415                         code = trans->to;
 416         }
 417
 418         if (swap_opt_cmd) {
 419                 trans = apple_find_translation(swapped_option_cmd_keys, code);
 420
 421                 if (trans)
 422                         code = trans->to;
 423         }
 424
 425         if (swap_ctrl_cmd) {
 426                 trans = apple_find_translation(swapped_ctrl_cmd_keys, code);
 427
 428                 if (trans)
 429                         code = trans->to;
 430         }
 431
 432         if (code == KEY_FN)
 433                 asc->fn_on = !!value;
 434
 435         if (real_fnmode) {
 436                 if (hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI ||
 437                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO ||
 438                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS ||
 439                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI ||
 440                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO ||
 441                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS ||
 442                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI ||
 443                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO ||
 444                     hid->product == USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS)
 445                         table = magic_keyboard_alu_fn_keys;
 446                 else if (hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015 ||
 447                          hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015)
 448                         table = magic_keyboard_2015_fn_keys;
 449                 else if (hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021 ||
 450                          hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021 ||
 451                          hid->product == USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021)
 452                         table = apple2021_fn_keys;
 453                 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132 ||
 454                          hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680 ||
 455                          hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213)
 456                                 table = macbookpro_no_esc_fn_keys;
 457                 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K ||
 458                          hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223 ||
 459                          hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F)
 460                                 table = macbookpro_dedicated_esc_fn_keys;
 461                 else if (hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K ||
 462                          hid->product == USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K)
 463                                 table = apple_fn_keys;
 464                 else if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
 465                                 hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
 466                         table = macbookair_fn_keys;
 467                 else if (hid->product < 0x21d || hid->product >= 0x300)
 468                         table = powerbook_fn_keys;
 469                 else
 470                         table = apple_fn_keys;
 471
 472                 trans = apple_find_translation(table, code);
 473
 474                 if (trans) {
 475                         bool from_is_set = test_bit(trans->from, input->key);
 476                         bool to_is_set = test_bit(trans->to, input->key);
 477
 478                         if (from_is_set)
 479                                 code = trans->from;
 480                         else if (to_is_set)
 481                                 code = trans->to;
 482
 483                         if (!(from_is_set || to_is_set)) {
 484                                 if (trans->flags & APPLE_FLAG_FKEY) {
 485                                         switch (real_fnmode) {
 486                                         case 1:
 487                                                 do_translate = !asc->fn_on;
 488                                                 break;
 489                                         case 2:
 490                                                 do_translate = asc->fn_on;
 491                                                 break;
 492                                         default:
 493                                                 /* should never happen */
 494                                                 do_translate = false;
 495                                         }
 496                                 } else {
 497                                         do_translate = asc->fn_on;
 498                                 }
 499
 500                                 if (do_translate)
 501                                         code = trans->to;
 502                         }
 503                 }
 504
 505                 if (asc->quirks & APPLE_NUMLOCK_EMULATION &&
 506                                 (test_bit(code, asc->pressed_numlock) ||
 507                                 test_bit(LED_NUML, input->led))) {
 508                         trans = apple_find_translation(powerbook_numlock_keys, code);
 509
 510                         if (trans) {
 511                                 if (value)
 512                                         set_bit(code, asc->pressed_numlock);
 513                                 else
 514                                         clear_bit(code, asc->pressed_numlock);
 515
 516                                 code = trans->to;
 517                         }
 518                 }
 519         }
 520
 521         if (usage->code != code) {
 522                 input_event_with_scancode(input, usage->type, code, usage->hid, value);
 523
 524                 return 1;
 525         }
 526
 527         return 0;
 528 }
 529
 530 static int apple_event(struct hid_device *hdev, struct hid_field *field,
 531                 struct hid_usage *usage, __s32 value)
 532 {
 533         struct apple_sc *asc = hid_get_drvdata(hdev);
 534
 535         if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
 536                         !usage->type)
 537                 return 0;
 538
 539         if ((asc->quirks & APPLE_INVERT_HWHEEL) &&
 540                         usage->code == REL_HWHEEL) {
 541                 input_event_with_scancode(field->hidinput->input, usage->type,
 542                                 usage->code, usage->hid, -value);
 543                 return 1;
 544         }
 545
 546         if ((asc->quirks & APPLE_HAS_FN) &&
 547                         hidinput_apple_event(hdev, field->hidinput->input,
 548                                 usage, value))
 549                 return 1;
 550
 551
 552         return 0;
 553 }
 554
 555 static int apple_fetch_battery(struct hid_device *hdev)
 556 {
 557 #ifdef CONFIG_HID_BATTERY_STRENGTH
 558         struct apple_sc *asc = hid_get_drvdata(hdev);
 559         struct hid_report_enum *report_enum;
 560         struct hid_report *report;
 561
 562         if (!(asc->quirks & APPLE_RDESC_BATTERY) || !hdev->battery)
 563                 return -1;
 564
 565         report_enum = &hdev->report_enum[hdev->battery_report_type];
 566         report = report_enum->report_id_hash[hdev->battery_report_id];
 567
 568         if (!report || report->maxfield < 1)
 569                 return -1;
 570
 571         if (hdev->battery_capacity == hdev->battery_max)
 572                 return -1;
 573
 574         hid_hw_request(hdev, report, HID_REQ_GET_REPORT);
 575         return 0;
 576 #else
 577         return -1;
 578 #endif
 579 }
 580
 581 static void apple_battery_timer_tick(struct timer_list *t)
 582 {
 583         struct apple_sc *asc = from_timer(asc, t, battery_timer);
 584         struct hid_device *hdev = asc->hdev;
 585
 586         if (apple_fetch_battery(hdev) == 0) {
 587                 mod_timer(&asc->battery_timer,
 588                           jiffies + msecs_to_jiffies(APPLE_BATTERY_TIMEOUT_MS));
 589         }
 590 }
 591
 592 /*
 593  * MacBook JIS keyboard has wrong logical maximum
 594  * Magic Keyboard JIS has wrong logical maximum
 595  */
 596 static __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 597                 unsigned int *rsize)
 598 {
 599         struct apple_sc *asc = hid_get_drvdata(hdev);
 600
 601         if(*rsize >=71 && rdesc[70] == 0x65 && rdesc[64] == 0x65) {
 602                 hid_info(hdev,
 603                          "fixing up Magic Keyboard JIS report descriptor\n");
 604                 rdesc[64] = rdesc[70] = 0xe7;
 605         }
 606
 607         if ((asc->quirks & APPLE_RDESC_JIS) && *rsize >= 60 &&
 608                         rdesc[53] == 0x65 && rdesc[59] == 0x65) {
 609                 hid_info(hdev,
 610                          "fixing up MacBook JIS keyboard report descriptor\n");
 611                 rdesc[53] = rdesc[59] = 0xe7;
 612         }
 613
 614         /*
 615          * Change the usage from:
 616          *   0x06, 0x00, 0xff, // Usage Page (Vendor Defined Page 1)  0
 617          *   0x09, 0x0b,       // Usage (Vendor Usage 0x0b)           3
 618          * To:
 619          *   0x05, 0x01,       // Usage Page (Generic Desktop)        0
 620          *   0x09, 0x06,       // Usage (Keyboard)                    2
 621          */
 622         if ((asc->quirks & APPLE_RDESC_BATTERY) && *rsize == 83 &&
 623             rdesc[46] == 0x84 && rdesc[58] == 0x85) {
 624                 hid_info(hdev,
 625                          "fixing up Magic Keyboard battery report descriptor\n");
 626                 *rsize = *rsize - 1;
 627                 rdesc = kmemdup(rdesc + 1, *rsize, GFP_KERNEL);
 628                 if (!rdesc)
 629                         return NULL;
 630
 631                 rdesc[0] = 0x05;
 632                 rdesc[1] = 0x01;
 633                 rdesc[2] = 0x09;
 634                 rdesc[3] = 0x06;
 635         }
 636
 637         return rdesc;
 638 }
 639
 640 static void apple_setup_input(struct input_dev *input)
 641 {
 642         set_bit(KEY_NUMLOCK, input->keybit);
 643
 644         /* Enable all needed keys */
 645         apple_setup_key_translation(input, apple_fn_keys);
 646         apple_setup_key_translation(input, powerbook_fn_keys);
 647         apple_setup_key_translation(input, powerbook_numlock_keys);
 648         apple_setup_key_translation(input, apple_iso_keyboard);
 649         apple_setup_key_translation(input, magic_keyboard_alu_fn_keys);
 650         apple_setup_key_translation(input, magic_keyboard_2015_fn_keys);
 651         apple_setup_key_translation(input, apple2021_fn_keys);
 652         apple_setup_key_translation(input, macbookpro_no_esc_fn_keys);
 653         apple_setup_key_translation(input, macbookpro_dedicated_esc_fn_keys);
 654 }
 655
 656 static int apple_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 657                 struct hid_field *field, struct hid_usage *usage,
 658                 unsigned long **bit, int *max)
 659 {
 660         struct apple_sc *asc = hid_get_drvdata(hdev);
 661
 662         if (usage->hid == (HID_UP_CUSTOM | 0x0003) ||
 663                         usage->hid == (HID_UP_MSVENDOR | 0x0003) ||
 664                         usage->hid == (HID_UP_HPVENDOR2 | 0x0003)) {
 665                 /* The fn key on Apple USB keyboards */
 666                 set_bit(EV_REP, hi->input->evbit);
 667                 hid_map_usage_clear(hi, usage, bit, max, EV_KEY, KEY_FN);
 668                 asc->fn_found = true;
 669                 apple_setup_input(hi->input);
 670                 return 1;
 671         }
 672
 673         /* we want the hid layer to go through standard path (set and ignore) */
 674         return 0;
 675 }
 676
 677 static int apple_input_mapped(struct hid_device *hdev, struct hid_input *hi,
 678                 struct hid_field *field, struct hid_usage *usage,
 679                 unsigned long **bit, int *max)
 680 {
 681         struct apple_sc *asc = hid_get_drvdata(hdev);
 682
 683         if (asc->quirks & APPLE_MIGHTYMOUSE) {
 684                 if (usage->hid == HID_GD_Z)
 685                         hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
 686                 else if (usage->code == BTN_1)
 687                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_2);
 688                 else if (usage->code == BTN_2)
 689                         hid_map_usage(hi, usage, bit, max, EV_KEY, BTN_1);
 690         }
 691
 692         return 0;
 693 }
 694
 695 static int apple_input_configured(struct hid_device *hdev,
 696                 struct hid_input *hidinput)
 697 {
 698         struct apple_sc *asc = hid_get_drvdata(hdev);
 699
 700         if ((asc->quirks & APPLE_HAS_FN) && !asc->fn_found) {
 701                 hid_info(hdev, "Fn key not found (Apple Wireless Keyboard clone?), disabling Fn key handling\n");
 702                 asc->quirks &= ~APPLE_HAS_FN;
 703         }
 704
 705         if (apple_is_non_apple_keyboard(hdev)) {
 706                 hid_info(hdev, "Non-apple keyboard detected; function keys will default to fnmode=2 behavior\n");
 707                 asc->quirks |= APPLE_IS_NON_APPLE;
 708         }
 709
 710         return 0;
 711 }
 712
 713 static bool apple_backlight_check_support(struct hid_device *hdev)
 714 {
 715         int i;
 716         unsigned int hid;
 717         struct hid_report *report;
 718
 719         list_for_each_entry(report, &hdev->report_enum[HID_INPUT_REPORT].report_list, list) {
 720                 for (i = 0; i < report->maxfield; i++) {
 721                         hid = report->field[i]->usage->hid;
 722                         if ((hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR && (hid & HID_USAGE) == 0xf)
 723                                 return true;
 724                 }
 725         }
 726
 727         return false;
 728 }
 729
 730 static int apple_backlight_set(struct hid_device *hdev, u16 value, u16 rate)
 731 {
 732         int ret = 0;
 733         struct apple_backlight_set_report *rep;
 734
 735         rep = kmalloc(sizeof(*rep), GFP_KERNEL);
 736         if (rep == NULL)
 737                 return -ENOMEM;
 738
 739         rep->report_id = 0xB0;
 740         rep->version = 1;
 741         rep->backlight = value;
 742         rep->rate = rate;
 743
 744         ret = hid_hw_raw_request(hdev, 0xB0u, (u8 *) rep, sizeof(*rep),
 745                                  HID_OUTPUT_REPORT, HID_REQ_SET_REPORT);
 746
 747         kfree(rep);
 748         return ret;
 749 }
 750
 751 static int apple_backlight_led_set(struct led_classdev *led_cdev,
 752         enum led_brightness brightness)
 753 {
 754         struct apple_sc_backlight *backlight = container_of(led_cdev,
 755                                                             struct apple_sc_backlight, cdev);
 756
 757         return apple_backlight_set(backlight->hdev, brightness, 0);
 758 }
 759
 760 static int apple_backlight_init(struct hid_device *hdev)
 761 {
 762         int ret;
 763         struct apple_sc *asc = hid_get_drvdata(hdev);
 764         struct apple_backlight_config_report *rep;
 765
 766         if (!apple_backlight_check_support(hdev))
 767                 return -EINVAL;
 768
 769         rep = kmalloc(0x200, GFP_KERNEL);
 770         if (rep == NULL)
 771                 return -ENOMEM;
 772
 773         ret = hid_hw_raw_request(hdev, 0xBFu, (u8 *) rep, sizeof(*rep),
 774                                  HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
 775         if (ret < 0) {
 776                 hid_err(hdev, "backlight request failed: %d\n", ret);
 777                 goto cleanup_and_exit;
 778         }
 779         if (ret < 8 || rep->version != 1) {
 780                 hid_err(hdev, "backlight config struct: bad version %i\n", rep->version);
 781                 ret = -EINVAL;
 782                 goto cleanup_and_exit;
 783         }
 784
 785         hid_dbg(hdev, "backlight config: off=%u, on_min=%u, on_max=%u\n",
 786                 rep->backlight_off, rep->backlight_on_min, rep->backlight_on_max);
 787
 788         asc->backlight = devm_kzalloc(&hdev->dev, sizeof(*asc->backlight), GFP_KERNEL);
 789         if (!asc->backlight) {
 790                 ret = -ENOMEM;
 791                 goto cleanup_and_exit;
 792         }
 793
 794         asc->backlight->hdev = hdev;
 795         asc->backlight->cdev.name = "apple::kbd_backlight";
 796         asc->backlight->cdev.max_brightness = rep->backlight_on_max;
 797         asc->backlight->cdev.brightness_set_blocking = apple_backlight_led_set;
 798
 799         ret = apple_backlight_set(hdev, 0, 0);
 800         if (ret < 0) {
 801                 hid_err(hdev, "backlight set request failed: %d\n", ret);
 802                 goto cleanup_and_exit;
 803         }
 804
 805         ret = devm_led_classdev_register(&hdev->dev, &asc->backlight->cdev);
 806
 807 cleanup_and_exit:
 808         kfree(rep);
 809         return ret;
 810 }
 811
 812 static int apple_probe(struct hid_device *hdev,
 813                 const struct hid_device_id *id)
 814 {
 815         unsigned long quirks = id->driver_data;
 816         struct apple_sc *asc;
 817         int ret;
 818
 819         asc = devm_kzalloc(&hdev->dev, sizeof(*asc), GFP_KERNEL);
 820         if (asc == NULL) {
 821                 hid_err(hdev, "can't alloc apple descriptor\n");
 822                 return -ENOMEM;
 823         }
 824
 825         asc->hdev = hdev;
 826         asc->quirks = quirks;
 827
 828         hid_set_drvdata(hdev, asc);
 829
 830         ret = hid_parse(hdev);
 831         if (ret) {
 832                 hid_err(hdev, "parse failed\n");
 833                 return ret;
 834         }
 835
 836         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 837         if (ret) {
 838                 hid_err(hdev, "hw start failed\n");
 839                 return ret;
 840         }
 841
 842         timer_setup(&asc->battery_timer, apple_battery_timer_tick, 0);
 843         mod_timer(&asc->battery_timer,
 844                   jiffies + msecs_to_jiffies(APPLE_BATTERY_TIMEOUT_MS));
 845         apple_fetch_battery(hdev);
 846
 847         if (quirks & APPLE_BACKLIGHT_CTL)
 848                 apple_backlight_init(hdev);
 849
 850         return 0;
 851 }
 852
 853 static void apple_remove(struct hid_device *hdev)
 854 {
 855         struct apple_sc *asc = hid_get_drvdata(hdev);
 856
 857         del_timer_sync(&asc->battery_timer);
 858
 859         hid_hw_stop(hdev);
 860 }
 861
 862 static const struct hid_device_id apple_devices[] = {
 863         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
 864                 .driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
 865
 866         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI),
 867                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 868         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO),
 869                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 870         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI),
 871                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 872         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO),
 873                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 874         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS),
 875                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 876         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI),
 877                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 878         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO),
 879                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 880                         APPLE_ISO_TILDE_QUIRK },
 881         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS),
 882                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 883                         APPLE_RDESC_JIS },
 884         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI),
 885                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 886         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO),
 887                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 888                         APPLE_ISO_TILDE_QUIRK },
 889         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS),
 890                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 891                         APPLE_RDESC_JIS },
 892         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI),
 893                 .driver_data = APPLE_HAS_FN },
 894         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO),
 895                 .driver_data = APPLE_HAS_FN },
 896         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS),
 897                 .driver_data = APPLE_HAS_FN },
 898         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI),
 899                 .driver_data = APPLE_HAS_FN },
 900         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO),
 901                 .driver_data = APPLE_HAS_FN },
 902         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS),
 903                 .driver_data = APPLE_HAS_FN },
 904         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI),
 905                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 906         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO),
 907                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 908                         APPLE_ISO_TILDE_QUIRK },
 909         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS),
 910                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 911                         APPLE_RDESC_JIS },
 912         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
 913                 .driver_data = APPLE_HAS_FN },
 914         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ANSI),
 915                 .driver_data = APPLE_HAS_FN },
 916         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
 917                 .driver_data = APPLE_HAS_FN },
 918         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_ISO),
 919                 .driver_data = APPLE_HAS_FN },
 920         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_REVB_JIS),
 921                 .driver_data = APPLE_HAS_FN },
 922         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
 923                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 924         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO),
 925                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 926                         APPLE_ISO_TILDE_QUIRK },
 927         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
 928                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
 929                         APPLE_ISO_TILDE_QUIRK },
 930         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 931                                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
 932                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 933         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 934                                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS),
 935                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 936         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS),
 937                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
 938         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015),
 939                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
 940         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015),
 941                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 942         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015),
 943                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
 944         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015),
 945                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 946         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
 947                 .driver_data = APPLE_HAS_FN },
 948         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
 949                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 950         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
 951                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 952         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
 953                 .driver_data = APPLE_HAS_FN },
 954         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
 955                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 956         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
 957                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 958         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
 959                 .driver_data = APPLE_HAS_FN },
 960         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
 961                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 962         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
 963                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 964         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI),
 965                 .driver_data = APPLE_HAS_FN },
 966         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_ISO),
 967                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 968         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4_JIS),
 969                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 970         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ANSI),
 971                 .driver_data = APPLE_HAS_FN },
 972         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_ISO),
 973                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 974         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS),
 975                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 976         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ANSI),
 977                 .driver_data = APPLE_HAS_FN },
 978         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_ISO),
 979                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 980         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5_JIS),
 981                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 982         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ANSI),
 983                 .driver_data = APPLE_HAS_FN },
 984         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_ISO),
 985                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 986         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6_JIS),
 987                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 988         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ANSI),
 989                 .driver_data = APPLE_HAS_FN },
 990         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_ISO),
 991                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 992         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING6A_JIS),
 993                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
 994         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ANSI),
 995                 .driver_data = APPLE_HAS_FN },
 996         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_ISO),
 997                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
 998         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING5A_JIS),
 999                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1000         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ANSI),
1001                 .driver_data = APPLE_HAS_FN },
1002         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_ISO),
1003                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1004         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7_JIS),
1005                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1006         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ANSI),
1007                 .driver_data = APPLE_HAS_FN },
1008         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_ISO),
1009                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1010         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING7A_JIS),
1011                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1012         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ANSI),
1013                 .driver_data = APPLE_HAS_FN },
1014         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_ISO),
1015                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1016         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING8_JIS),
1017                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1018         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ANSI),
1019                 .driver_data = APPLE_HAS_FN },
1020         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_ISO),
1021                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1022         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING9_JIS),
1023                 .driver_data = APPLE_HAS_FN | APPLE_RDESC_JIS },
1024         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K),
1025                 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1026         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132),
1027                 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1028         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680),
1029                 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1030         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213),
1031                 .driver_data = APPLE_HAS_FN | APPLE_BACKLIGHT_CTL | APPLE_ISO_TILDE_QUIRK },
1032         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K),
1033                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1034         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223),
1035                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1036         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K),
1037                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1038         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F),
1039                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1040         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
1041                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1042         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
1043                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN |
1044                         APPLE_ISO_TILDE_QUIRK },
1045         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS),
1046                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1047         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY),
1048                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1049         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY),
1050                 .driver_data = APPLE_NUMLOCK_EMULATION | APPLE_HAS_FN },
1051         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021),
1052                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1053         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021),
1054                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1055         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021),
1056                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1057         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021),
1058                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1059         { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021),
1060                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK | APPLE_RDESC_BATTERY },
1061         { HID_BLUETOOTH_DEVICE(BT_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021),
1062                 .driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
1063
1064         { }
1065 };
1066 MODULE_DEVICE_TABLE(hid, apple_devices);
1067
1068 static struct hid_driver apple_driver = {
1069         .name = "apple",
1070         .id_table = apple_devices,
1071         .report_fixup = apple_report_fixup,
1072         .probe = apple_probe,
1073         .remove = apple_remove,
1074         .event = apple_event,
1075         .input_mapping = apple_input_mapping,
1076         .input_mapped = apple_input_mapped,
1077         .input_configured = apple_input_configured,
1078 };
1079 module_hid_driver(apple_driver);
1080
1081 MODULE_LICENSE("GPL");