Skip to content

Commit aa79b6c

Browse files
IntegralPilotIntegralPilot
committed
hid: apple: Add support for DockChannel HID devices
Modify hid-apple to recognize internal DockChannel HID devices. This adds support for the 2021/2024 FN-key tables on the Host bus and includes a report descriptor fixup to handle the oversized bitfields used by the DockChannel transport. Signed-off-by: Michael Reeves <[email protected]>
1 parent ae611b0 commit aa79b6c

1 file changed

Lines changed: 89 additions & 46 deletions

File tree

‎drivers/hid/hid-apple.c‎

Lines changed: 89 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -473,53 +473,61 @@ static int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
473473
asc->fn_on = !!value;
474474

475475
if (real_fnmode) {
476-
switch (hid->product) {
477-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI:
478-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO:
479-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS:
480-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI:
481-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO:
482-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS:
483-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI:
484-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO:
485-
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS:
486-
table = magic_keyboard_alu_fn_keys;
487-
break;
488-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015:
489-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015:
490-
table = magic_keyboard_2015_fn_keys;
491-
break;
492-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021:
493-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021:
494-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021:
495-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2024:
496-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2024:
497-
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2024:
476+
/*
477+
* If it's on the Host bus, it's a modern internal keyboard.
478+
* For other bus types, check the legacy USB product IDs.
479+
*/
480+
if (hid->bus == BUS_HOST) {
498481
table = magic_keyboard_2021_and_2024_fn_keys;
499-
break;
500-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132:
501-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213:
502-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680:
503-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680_ALT:
504-
table = macbookpro_no_esc_fn_keys;
505-
break;
506-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F:
507-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K:
508-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223:
509-
table = macbookpro_dedicated_esc_fn_keys;
510-
break;
511-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K:
512-
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K:
513-
table = apple_fn_keys;
514-
break;
515-
default:
516-
if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
517-
hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
518-
table = macbookair_fn_keys;
519-
else if (hid->product < 0x21d || hid->product >= 0x300)
520-
table = powerbook_fn_keys;
521-
else
482+
} else {
483+
switch (hid->product) {
484+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI:
485+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO:
486+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS:
487+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI:
488+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO:
489+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS:
490+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI:
491+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO:
492+
case USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_JIS:
493+
table = magic_keyboard_alu_fn_keys;
494+
break;
495+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2015:
496+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2015:
497+
table = magic_keyboard_2015_fn_keys;
498+
break;
499+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021:
500+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021:
501+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021:
502+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2024:
503+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2024:
504+
case USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2024:
505+
table = magic_keyboard_2021_and_2024_fn_keys;
506+
break;
507+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J132:
508+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J213:
509+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680:
510+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J680_ALT:
511+
table = macbookpro_no_esc_fn_keys;
512+
break;
513+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J152F:
514+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J214K:
515+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J223:
516+
table = macbookpro_dedicated_esc_fn_keys;
517+
break;
518+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J140K:
519+
case USB_DEVICE_ID_APPLE_WELLSPRINGT2_J230K:
522520
table = apple_fn_keys;
521+
break;
522+
default:
523+
if (hid->product >= USB_DEVICE_ID_APPLE_WELLSPRING4_ANSI &&
524+
hid->product <= USB_DEVICE_ID_APPLE_WELLSPRING4A_JIS)
525+
table = macbookair_fn_keys;
526+
else if (hid->product < 0x21d || hid->product >= 0x300)
527+
table = powerbook_fn_keys;
528+
else
529+
table = apple_fn_keys;
530+
}
523531
}
524532

525533
trans = apple_find_translation(table, code);
@@ -653,6 +661,7 @@ static void apple_battery_timer_tick(struct timer_list *t)
653661
/*
654662
* MacBook JIS keyboard has wrong logical maximum
655663
* Magic Keyboard JIS has wrong logical maximum
664+
* Internal DockChannel HIDs on MacBook M2+ have wrong report sizes
656665
*/
657666
static const __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
658667
unsigned int *rsize)
@@ -695,6 +704,38 @@ static const __u8 *apple_report_fixup(struct hid_device *hdev, __u8 *rdesc,
695704
rdesc[3] = 0x06;
696705
}
697706

707+
/*
708+
* Fix up DockChannel descriptors that use oversized report sizes (16384 bits).
709+
* The HID parser cannot handle such large sizes, so we redistribute the bits
710+
* into a standard 8-bit report size with a proportionally increased count
711+
* to maintain the same total data length in a byte-aligned format.
712+
*/
713+
if (*rsize >= 5) {
714+
int i;
715+
716+
for (i = 0; i <= *rsize - 5; i++) {
717+
/* Look for Report Size 0x4000 (16384) followed by Report Count */
718+
if (rdesc[i] == 0x76 && rdesc[i + 1] == 0x00 &&
719+
rdesc[i + 2] == 0x40 && rdesc[i + 3] == 0x95) {
720+
u8 count = rdesc[i + 4];
721+
722+
if (count > 0 && count < 32) {
723+
hid_info(hdev, "fixing up DockChannel report size (Count %d)\n",
724+
count);
725+
726+
/*
727+
* Replace with Report Size 8 and
728+
* Report Count (2048 * count)
729+
*/
730+
rdesc[i] = 0x75;
731+
rdesc[i + 1] = 0x08;
732+
rdesc[i + 2] = 0x96;
733+
rdesc[i + 3] = 0x00;
734+
rdesc[i + 4] = count * 8;
735+
}
736+
}
737+
}
738+
}
698739
return rdesc;
699740
}
700741

@@ -759,7 +800,7 @@ static int apple_input_configured(struct hid_device *hdev,
759800
struct apple_sc *asc = hid_get_drvdata(hdev);
760801

761802
if (((asc->quirks & APPLE_HAS_FN) && !asc->fn_found) || apple_is_omoton_kb066(hdev)) {
762-
hid_info(hdev, "Fn key not found (Apple Wireless Keyboard clone?), disabling Fn key handling\n");
803+
hid_info(hdev, "Disabling function quirk for device without function key\n");
763804
asc->quirks &= ~APPLE_HAS_FN;
764805
}
765806

@@ -1218,6 +1259,8 @@ static const struct hid_device_id apple_devices[] = {
12181259
.driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
12191260
{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_TOUCHBAR_BACKLIGHT),
12201261
.driver_data = APPLE_MAGIC_BACKLIGHT },
1262+
{ HID_DEVICE(BUS_HOST, HID_GROUP_ANY, USB_VENDOR_ID_APPLE, HID_ANY_ID),
1263+
.driver_data = APPLE_HAS_FN | APPLE_ISO_TILDE_QUIRK },
12211264

12221265
{ }
12231266
};

0 commit comments

Comments
 (0)