From patchwork Mon Feb 3 17:03:52 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Aditya Garg X-Patchwork-Id: 13957858 Received: from PNZPR01CU001.outbound.protection.outlook.com (mail-centralindiaazolkn19011030.outbound.protection.outlook.com [52.103.68.30]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3ADED20B800; Mon, 3 Feb 2025 17:03:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.103.68.30 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738602240; cv=fail; b=d3EQOQ9qSop4LiEyAP82s7/q0giCF/7vEaMWgAnzhiVriOjoJCF/D6MfUHu//YCcSDsNubkhVEffB90DAW+H4jrbcSoo4ntLQ2Mr13phvZ+o+YVQA1nlwC2PCeIvpqL47rRtFy3jsZ4MzQ+OlpfH3iHbccoLfbRAmoe2NlqX64M= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738602240; c=relaxed/simple; bh=3Ufe7VxHQY4B2CMvUfMqMFAu2LC8AOIXx0VqYfOwMvg=; h=From:To:CC:Subject:Date:Message-ID:References:In-Reply-To: Content-Type:MIME-Version; b=utj8p46KvyQ8Zy2OwzgPqm3BTMYm6Sc5t/gzrbDMWwdvgIXYhbcZfdto1m29dtzlzasIU3uoI4ViyhTldk9A+VNq1Es6i9/yqrOTVy5k5auow7rjA7c4HZaW7Vr4BGRRebaVah+u8giii52cnSFbLv7n1QVGTDK4WkTgqA3LIh0= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=live.com; spf=pass smtp.mailfrom=live.com; dkim=pass (2048-bit key) header.d=live.com header.i=@live.com header.b=tTmOje9p; arc=fail smtp.client-ip=52.103.68.30 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=live.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=live.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=live.com header.i=@live.com header.b="tTmOje9p" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=O9418fkirzDq3Rp1n1rx7qLm1xbf+xCr6z9R46vv08obbPkkvlySL6OdAc3h9trQ3G8XmN68DjSUch74T9xz2awTRrTieWpYWFcOs40m9ea4cOGAeRMDiQ+08rJlE9wkmi5ktr/w14uunBSRYXtQf7ZAO5mQDSS/E13Bx+XnXcYGZll4KpTIRqq0p58LxQFJ1sJgFT5Vipm1STN+u0aFXfHcdm3lqovBNHc+rnQTmnbm15xIy8EhjJvXveCBc3JaZbRMpAj+D9/d/dtZvKHENv6qan6dJSzAbFalJLXLsYwUkSnUknyIwsCgatajb4Z24HX5vE0cpTzrj0I0+IrroQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3Ufe7VxHQY4B2CMvUfMqMFAu2LC8AOIXx0VqYfOwMvg=; b=lf8/L1Qsciv85ak57VpB45M9zjHFFo86McKHNygu9HZCiIKtqemhcQv0MIDdwRtlGy0c9VhDu+kG1idPFZ/8YYRR6WVdM2je+aaT9KRTkrSDyc2K7OxmBL6HpY29RIKyGq3ha2veqT/GE8sll65BcU9lTthQShgNXbHwy19Q6m9cjuNVLinREPMQYWKT3atzYmCX9LG4zfCdRN9OEjh5nL9gnx5p7QmePQQVDRxoZmDjSYx6GdmBZtFIPJuvbKclo6mt3itManH2yOGdUPfz/Cq0HZlE+zFZfowK/nnobH9me+lOgE23l2HDbHkHyL98RVy53OfdZVsOKtt+z3ac6g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=live.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=3Ufe7VxHQY4B2CMvUfMqMFAu2LC8AOIXx0VqYfOwMvg=; b=tTmOje9pbYZfmt4qy9bzujJzV1E5b+/hdHRZ7oIgBSUbVfrAb62AOTK+Qr1qMmXBhkBgbREkrB5/cFEHelvv9WOoKMlfNyEq7/M1N9HXHbuOvCYgwk76OLBTplv26LCHRNwByYONB5AagBfKkliOAk0DekdoL3b1qk9Fi3ezPdXhpcf67e1TTdQMV2zR8k+itTzGrlWswCyQL4EH39tTgSXjUZjW98mHQfcssTSnHLj0Yo4c4QUFbZhAlD6nsLA7lMs9/M1llCkRfXynXr9v+m2kEiTzucxGLYuymg30FrqfD9uEY0Ple/+p0KuiLdEN0H2M79UX/zlsMI8j/MrP9A== Received: from MAZPR01MB8280.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a01:a7::7) by PN3PR01MB8673.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c01:d8::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8398.25; Mon, 3 Feb 2025 17:03:53 +0000 Received: from MAZPR01MB8280.INDPRD01.PROD.OUTLOOK.COM ([fe80::21af:2873:67f3:302b]) by MAZPR01MB8280.INDPRD01.PROD.OUTLOOK.COM ([fe80::21af:2873:67f3:302b%4]) with mapi id 15.20.8398.025; Mon, 3 Feb 2025 17:03:53 +0000 From: Aditya Garg To: Jiri Kosina , "bentiss@kernel.org" , Benjamin Tissoires , =?utf-8?q?Thomas_Wei?= =?utf-8?q?=C3=9Fschuh?= , =?utf-8?q?Thomas_Wei=C3=9Fs?= =?utf-8?q?chuh?= , "jkosina@suse.cz" CC: Kerem Karabay , Orlando Chamberlain , Linux Kernel Mailing List , "linux-input@vger.kernel.org" Subject: [PATCH RESEND v2 2/4] HID: hid-appletb-kbd: add driver for the keyboard mode of Apple Touch Bars Thread-Topic: [PATCH RESEND v2 2/4] HID: hid-appletb-kbd: add driver for the keyboard mode of Apple Touch Bars Thread-Index: AQHbdl2aeEPfGyo4FECOtiWj8F4jCw== Date: Mon, 3 Feb 2025 17:03:52 +0000 Message-ID: <70EC8377-3E3D-45E0-907D-88FCEFA8930F@live.com> References: <5AEC08E1-0AEF-49BF-94F6-AA1AD71545D0@live.com> In-Reply-To: <5AEC08E1-0AEF-49BF-94F6-AA1AD71545D0@live.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-exchange-messagesentrepresentingtype: 1 x-ms-publictraffictype: Email x-ms-traffictypediagnostic: MAZPR01MB8280:EE_|PN3PR01MB8673:EE_ x-ms-office365-filtering-correlation-id: 40f91ded-bea1-469a-2f77-08dd4474bcc8 x-microsoft-antispam: BCL:0;ARA:14566002|8062599003|461199028|7092599003|15080799006|19110799003|8060799006|102099032|3412199025|440099028|41001999003; x-microsoft-antispam-message-info: =?utf-8?q?izyk2RYKDYv1W5e4lgTrcdLSb+2lLax?= =?utf-8?q?yx9bQNeW5+WH8Zc2jm0S8qitAxB8gGQt+omA1gh+0hMzvnXyZrBEaYF7jaWiF5may?= =?utf-8?q?dMLNOt0iSMrcvS2gxcCDkMyK70Ccr+XVDnQyhbOrJVhGNXJLalTeVL/82uNN1ZUJx?= =?utf-8?q?dtFJEqU43Tk7jYnbP5xKHE9Qt1GbGW7q1YZMvbFBf2CBrVeUgGpFi98bXlKMniGdy?= =?utf-8?q?ir+lvvpwIm46H4cNOUWMdZoJbuTDjHD2NbrPO4LiydvShCosbX3uv/zvOvGIxg8ey?= =?utf-8?q?jjOTH790FIhS7jj7R+w26JMwb6dOhq1hpdzbZ6bHma5oYncP/i+oTJaNiCt/hYdVJ?= =?utf-8?q?t7uz2ArfWZAkAS4KD+kk17xxMOSUWf8e/jEyWeigXAiWxtZLZ/uPpwDR3rKF0qAxu?= =?utf-8?q?jByoihd0Q0joGEfSW1DUr7lbvAt+oIG7PZ3V28EKHjr9DFx+KWsHYLHoTBRD7NqJR?= =?utf-8?q?8DtayVDX/hrzgaeTwkmcXORDY4+/dKyXNH1n6X6X6UiuBB8bp85h9Qot14hTBRidZ?= =?utf-8?q?VwycjQJHq4ElK5gFSs3eN3Ps4MbU6yP++YcRK4XQhIiqmRgfZIjIs9K5YIypPcIxG?= =?utf-8?q?yVCnQqXIpafHJ1ufFyvt3uSagZckVwqHCpLBksAGXDRMKMkYrcxV+DgBn265KpEMS?= =?utf-8?q?USAGeKBPcNNQzNVfrQKo8piM8Ul4jyGE255ZIihg5FuXl5fy/+WdJqUxc63h7b1oC?= =?utf-8?q?b0NJpTWGg7Up0p23Met+4obFJ3HfVMGeg6b1skRSIEbsztuvzadrB7woOa1U2VWqn?= =?utf-8?q?9H1xmmi0LwJ+Q+N4jz2N/JNtCA0yWRUi4wAlivv7A7MrRuqatM8RWKn9NXr8a1XdG?= =?utf-8?q?ziaTnVHqYGuQq/xRwiNj4WiPj1THHY5C5oKnT3f+d9msL3Q8pw6xMfre99Yt7135p?= =?utf-8?q?2ueVSpMqJipP0Rx2ISQa7UsVBbLTA61B5/+2U0eQOOLKlBQUBEh7AaA4TCUwBaUEm?= =?utf-8?q?0Dcmv1Wb4SMgwiKyguXIPwAIhBCPRAhBb4ppvV6x/Mhj3DjTK/YhgIvUguv5zRJ6R?= =?utf-8?q?MAgHxKDZHn0w79s0cAWIUJ4t4+184vvqsYQeiNqlMiXkmVciNYFT/XOvdMHo=3D?= x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?utf-8?q?7nbvB1nAIMGVIG+Zf7tTtxgYijXr?= =?utf-8?q?USQc0CoBV4k3BskTEOd7g2McnnLm8P6RAgLX2qQQ85ef8uXuNUnQy7SUkqxBwQRpR?= =?utf-8?q?IC/OppPwbQI2WGn8sEFC25offTXFFqyjhOjWEGVcLd5CIOf/hobzlZI2rMh0RDoYx?= =?utf-8?q?jeCQgmuB5qWXNtzRIErz5vkB9jqRIWEQL2AEoAQhoKrd45MOq5hckJudiPg3x8+Me?= =?utf-8?q?M6EkDfiNxSuBgup2OR8cvE5UImSP0hCVVswnJ4NhOQQnXpmlfruIqyh/r727BUfdB?= =?utf-8?q?wGqU5Y66+eV1i3eWr8FKmK/ryLSPYNPENASdpXW45LmQwyr2kqNgY694/4IS/IELV?= =?utf-8?q?6OOLtO8vo9hMxO2Gj9+Kq3ObTEBw6Rj6NLtCbkTuvjYxiFvjV2bBvpfkLEc5AMS+f?= =?utf-8?q?ZXdrJSOerM4OcCfx+JyXLo40IrRmWncxoxVJ5z6Qf4bfDgCpN78hfOMRHqxDddqS6?= =?utf-8?q?PhSUoma+UA7+uriS96y3rDtd9KOob/NjusFEr2JeGg7RB4k/tT7cpyAoboOZ1GxCl?= =?utf-8?q?NQjRvfAvzFH6C12T+swDbthqpvelk0cJ1HUiw6fysDSgqnXblgFPghOpWdF10KNFa?= =?utf-8?q?klM8qSeQ50r8c47eLmDMp6S5vl16HULpXd2q2lj7/LDnlkdDRJ25PRdUAojys2wBe?= =?utf-8?q?FgKs2eqohkztks4YRMGqykpMAcTCmjeN9YZxKjB3uz+pVAacGeE51N/6T2Wbb/+G5?= =?utf-8?q?LUFApxHPAtCvnyQ0Pw3lRraqCYYAQHl+zWrpcs/9/ZIavR/i4z7zRjTcxZCaGXt+y?= =?utf-8?q?Fe+KknzwP67EeUDYSF3TCPArHmd9J6uHg1GDHB1oUhxwuTZ/Cm64BOwvee6HoV7ST?= =?utf-8?q?XZSPX0g+r3M0PDlEoCZ9J+huyZfZAdXSn3DdYPc/eBijvanHkotTeget/mU7K51K4?= =?utf-8?q?xm+ShDyMuvoKnZlh+cfzMipoWgmu57zih64Upmiaj9U3oLDJcZ0SVZ/8yaXeITIan?= =?utf-8?q?+7apBLaXkdwgSkL3ZZHC1aLrU53763p/Ja3/8m8ysqBUKVf99xKuSMzhidrcmRY8u?= =?utf-8?q?TPUBxDQ1567UDEN2+GeuU1NwOumkbbTiR09Yv+yrLFyPFwS5dyJNfunR+ivl2+3jW?= =?utf-8?q?9tZUhfGjUkCqv/4OF9NwbgQR3f7xXnTqaDV0WsW0Bl8MGHbxzm/HswmEwPchz40fw?= =?utf-8?q?QHqyGtiSR7y7q/eXr/n07Q+mS/5aTnYKdpIMVPMwkFE4BQt+YpqDKSGfwxNz4=3D?= Content-ID: <712F854042F26840AB22380A01ED5B1C@INDPRD01.PROD.OUTLOOK.COM> Precedence: bulk X-Mailing-List: linux-input@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-OriginatorOrg: sct-15-20-7719-20-msonline-outlook-ae5c4.templateTenant X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: MAZPR01MB8280.INDPRD01.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-CrossTenant-Network-Message-Id: 40f91ded-bea1-469a-2f77-08dd4474bcc8 X-MS-Exchange-CrossTenant-originalarrivaltime: 03 Feb 2025 17:03:52.9990 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: PN3PR01MB8673 From: Kerem Karabay The Touch Bars found on x86 Macs support two USB configurations: one where the device presents itself as a HID keyboard and can display predefined sets of keys, and one where the operating system has full control over what is displayed. This commit adds a driver for the display functionality of the first configuration. Note that currently only T2 Macs are supported. This driver is based on previous work done by Ronald Tschalär . Signed-off-by: Kerem Karabay Co-developed-by: Aditya Garg Signed-off-by: Aditya Garg --- .../ABI/testing/sysfs-driver-hid-appletb-kbd | 13 + drivers/hid/Kconfig | 13 + drivers/hid/Makefile | 1 + drivers/hid/hid-appletb-kbd.c | 303 ++++++++++++++++++ drivers/hid/hid-quirks.c | 4 +- 5 files changed, 333 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/sysfs-driver-hid-appletb-kbd create mode 100644 drivers/hid/hid-appletb-kbd.c diff --git a/Documentation/ABI/testing/sysfs-driver-hid-appletb-kbd b/Documentation/ABI/testing/sysfs-driver-hid-appletb-kbd new file mode 100644 index 000000000..2a19584d0 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-driver-hid-appletb-kbd @@ -0,0 +1,13 @@ +What: /sys/bus/hid/drivers/hid-appletb-kbd//mode +Date: September, 2023 +KernelVersion: 6.5 +Contact: linux-input@vger.kernel.org +Description: + The set of keys displayed on the Touch Bar. + Valid values are: + == ================= + 0 Escape key only + 1 Function keys + 2 Media/brightness keys + 3 None + == ================= diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index f6678db27..5b16bfadc 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -158,6 +158,19 @@ config HID_APPLETB_BL To compile this driver as a module, choose M here: the module will be called hid-appletb-bl. +config HID_APPLETB_KBD + tristate "Apple Touch Bar Keyboard Mode" + depends on USB_HID + depends on INPUT + select INPUT_SPARSEKMAP + help + Say Y here if you want support for the keyboard mode (escape, + function, media and brightness keys) of Touch Bars on x86 MacBook + Pros. + + To compile this driver as a module, choose M here: the + module will be called hid-appletb-kbd. + config HID_ASUS tristate "Asus" depends on USB_HID diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index 444d24cec..1989288e0 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -30,6 +30,7 @@ obj-$(CONFIG_HID_ACRUX) += hid-axff.o obj-$(CONFIG_HID_APPLE) += hid-apple.o obj-$(CONFIG_HID_APPLEIR) += hid-appleir.o obj-$(CONFIG_HID_APPLETB_BL) += hid-appletb-bl.o +obj-$(CONFIG_HID_APPLETB_KBD) += hid-appletb-kbd.o obj-$(CONFIG_HID_CREATIVE_SB0540) += hid-creative-sb0540.o obj-$(CONFIG_HID_ASUS) += hid-asus.o obj-$(CONFIG_HID_AUREAL) += hid-aureal.o diff --git a/drivers/hid/hid-appletb-kbd.c b/drivers/hid/hid-appletb-kbd.c new file mode 100644 index 000000000..80c87396f --- /dev/null +++ b/drivers/hid/hid-appletb-kbd.c @@ -0,0 +1,303 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Apple Touch Bar Keyboard Mode Driver + * + * Copyright (c) 2017-2018 Ronald Tschalär + * Copyright (c) 2022-2023 Kerem Karabay + * Copyright (c) 2024 Aditya Garg + */ + +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hid-ids.h" + +#define APPLETB_KBD_MODE_ESC 0 +#define APPLETB_KBD_MODE_FN 1 +#define APPLETB_KBD_MODE_SPCL 2 +#define APPLETB_KBD_MODE_OFF 3 +#define APPLETB_KBD_MODE_MAX APPLETB_KBD_MODE_OFF + +#define HID_USAGE_MODE 0x00ff0004 + +static int appletb_tb_def_mode = APPLETB_KBD_MODE_SPCL; +module_param_named(mode, appletb_tb_def_mode, int, 0444); +MODULE_PARM_DESC(mode, "Default touchbar mode:\n" + " 0 - escape key only\n" + " 1 - function-keys\n" + " [2] - special keys"); + +struct appletb_kbd { + struct hid_field *mode_field; + + u8 saved_mode; + u8 current_mode; +}; + +static const struct key_entry appletb_kbd_keymap[] = { + { KE_KEY, KEY_ESC, { KEY_ESC } }, + { KE_KEY, KEY_F1, { KEY_BRIGHTNESSDOWN } }, + { KE_KEY, KEY_F2, { KEY_BRIGHTNESSUP } }, + { KE_KEY, KEY_F3, { KEY_RESERVED } }, + { KE_KEY, KEY_F4, { KEY_RESERVED } }, + { KE_KEY, KEY_F5, { KEY_KBDILLUMDOWN } }, + { KE_KEY, KEY_F6, { KEY_KBDILLUMUP } }, + { KE_KEY, KEY_F7, { KEY_PREVIOUSSONG } }, + { KE_KEY, KEY_F8, { KEY_PLAYPAUSE } }, + { KE_KEY, KEY_F9, { KEY_NEXTSONG } }, + { KE_KEY, KEY_F10, { KEY_MUTE } }, + { KE_KEY, KEY_F11, { KEY_VOLUMEDOWN } }, + { KE_KEY, KEY_F12, { KEY_VOLUMEUP } }, + { KE_END, 0 } +}; + +static int appletb_kbd_set_mode(struct appletb_kbd *kbd, u8 mode) +{ + struct hid_report *report = kbd->mode_field->report; + struct hid_device *hdev = report->device; + int ret; + + ret = hid_hw_power(hdev, PM_HINT_FULLON); + if (ret) { + hid_err(hdev, "Device didn't resume (%pe)\n", ERR_PTR(ret)); + return ret; + } + + ret = hid_set_field(kbd->mode_field, 0, mode); + if (ret) { + hid_err(hdev, "Failed to set mode field to %u (%pe)\n", mode, ERR_PTR(ret)); + goto power_normal; + } + + hid_hw_request(hdev, report, HID_REQ_SET_REPORT); + + kbd->current_mode = mode; + +power_normal: + hid_hw_power(hdev, PM_HINT_NORMAL); + + return ret; +} + +static ssize_t mode_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct appletb_kbd *kbd = dev_get_drvdata(dev); + + return sysfs_emit(buf, "%d\n", kbd->current_mode); +} + +static ssize_t mode_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t size) +{ + struct appletb_kbd *kbd = dev_get_drvdata(dev); + u8 mode; + int ret; + + ret = kstrtou8(buf, 0, &mode); + if (ret) + return ret; + + if (mode > APPLETB_KBD_MODE_MAX) + return -EINVAL; + + ret = appletb_kbd_set_mode(kbd, mode); + + return ret < 0 ? ret : size; +} +static DEVICE_ATTR_RW(mode); + +struct attribute *appletb_kbd_attrs[] = { + &dev_attr_mode.attr, + NULL +}; +ATTRIBUTE_GROUPS(appletb_kbd); + +static int appletb_tb_key_to_slot(unsigned int code) +{ + switch (code) { + case KEY_ESC: + return 0; + case KEY_F1 ... KEY_F10: + return code - KEY_F1 + 1; + case KEY_F11 ... KEY_F12: + return code - KEY_F11 + 11; + + default: + return -EINVAL; + } +} + +static int appletb_kbd_hid_event(struct hid_device *hdev, struct hid_field *field, + struct hid_usage *usage, __s32 value) +{ + struct appletb_kbd *kbd = hid_get_drvdata(hdev); + struct key_entry *translation; + struct input_dev *input; + int slot; + + if ((usage->hid & HID_USAGE_PAGE) != HID_UP_KEYBOARD || usage->type != EV_KEY) + return 0; + + input = field->hidinput->input; + + /* + * Skip non-touch-bar keys. + * + * Either the touch bar itself or usbhid generate a slew of key-down + * events for all the meta keys. None of which we're at all interested + * in. + */ + slot = appletb_tb_key_to_slot(usage->code); + if (slot < 0) + return 0; + + translation = sparse_keymap_entry_from_scancode(input, usage->code); + + if (translation && kbd->current_mode == APPLETB_KBD_MODE_SPCL) { + input_event(input, usage->type, translation->keycode, value); + + return 1; + } + + return kbd->current_mode == APPLETB_KBD_MODE_OFF; +} + +static int appletb_kbd_input_configured(struct hid_device *hdev, struct hid_input *hidinput) +{ + int idx; + struct input_dev *input = hidinput->input; + + /* + * Clear various input capabilities that are blindly set by the hid + * driver (usbkbd.c) + */ + memset(input->evbit, 0, sizeof(input->evbit)); + memset(input->keybit, 0, sizeof(input->keybit)); + memset(input->ledbit, 0, sizeof(input->ledbit)); + + __set_bit(EV_REP, input->evbit); + + sparse_keymap_setup(input, appletb_kbd_keymap, NULL); + + for (idx = 0; appletb_kbd_keymap[idx].type != KE_END; idx++) + input_set_capability(input, EV_KEY, appletb_kbd_keymap[idx].code); + + return 0; +} + +static int appletb_kbd_probe(struct hid_device *hdev, const struct hid_device_id *id) +{ + struct appletb_kbd *kbd; + struct device *dev = &hdev->dev; + struct hid_field *mode_field; + int ret; + + ret = hid_parse(hdev); + if (ret) + return dev_err_probe(dev, ret, "HID parse failed\n"); + + mode_field = hid_find_field(hdev, HID_OUTPUT_REPORT, + HID_GD_KEYBOARD, HID_USAGE_MODE); + if (!mode_field) + return -ENODEV; + + kbd = devm_kzalloc(dev, sizeof(*kbd), GFP_KERNEL); + if (!kbd) + return -ENOMEM; + + kbd->mode_field = mode_field; + + ret = hid_hw_start(hdev, HID_CONNECT_HIDINPUT); + if (ret) + return dev_err_probe(dev, ret, "HID hw start failed\n"); + + ret = hid_hw_open(hdev); + if (ret) { + dev_err_probe(dev, ret, "HID hw open failed\n"); + goto stop_hw; + } + + ret = appletb_kbd_set_mode(kbd, appletb_tb_def_mode); + if (ret) { + dev_err_probe(dev, ret, "Failed to set touchbar mode\n"); + goto close_hw; + } + + hid_set_drvdata(hdev, kbd); + + return 0; + +close_hw: + hid_hw_close(hdev); +stop_hw: + hid_hw_stop(hdev); + return ret; +} + +static void appletb_kbd_remove(struct hid_device *hdev) +{ + struct appletb_kbd *kbd = hid_get_drvdata(hdev); + + appletb_kbd_set_mode(kbd, APPLETB_KBD_MODE_OFF); + + hid_hw_close(hdev); + hid_hw_stop(hdev); +} + +#ifdef CONFIG_PM +static int appletb_kbd_suspend(struct hid_device *hdev, pm_message_t msg) +{ + struct appletb_kbd *kbd = hid_get_drvdata(hdev); + + kbd->saved_mode = kbd->current_mode; + appletb_kbd_set_mode(kbd, APPLETB_KBD_MODE_OFF); + + return 0; +} + +static int appletb_kbd_reset_resume(struct hid_device *hdev) +{ + struct appletb_kbd *kbd = hid_get_drvdata(hdev); + + appletb_kbd_set_mode(kbd, kbd->saved_mode); + + return 0; +} +#endif + +static const struct hid_device_id appletb_kbd_hid_ids[] = { + /* MacBook Pro's 2018, 2019, with T2 chip: iBridge Display */ + { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_TOUCHBAR_DISPLAY) }, + { } +}; +MODULE_DEVICE_TABLE(hid, appletb_kbd_hid_ids); + +static struct hid_driver appletb_kbd_hid_driver = { + .name = "hid-appletb-kbd", + .id_table = appletb_kbd_hid_ids, + .probe = appletb_kbd_probe, + .remove = appletb_kbd_remove, + .event = appletb_kbd_hid_event, + .input_configured = appletb_kbd_input_configured, +#ifdef CONFIG_PM + .suspend = appletb_kbd_suspend, + .reset_resume = appletb_kbd_reset_resume, +#endif + .driver.dev_groups = appletb_kbd_groups, +}; +module_hid_driver(appletb_kbd_hid_driver); + +MODULE_AUTHOR("Ronald Tschalär"); +MODULE_AUTHOR("Kerem Karabay "); +MODULE_DESCRIPTION("MacBookPro Touch Bar Keyboard Mode Driver"); +MODULE_LICENSE("GPL"); diff --git a/drivers/hid/hid-quirks.c b/drivers/hid/hid-quirks.c index 818d41a35..7c576d654 100644 --- a/drivers/hid/hid-quirks.c +++ b/drivers/hid/hid-quirks.c @@ -328,7 +328,6 @@ static const struct hid_device_id hid_have_special_driver[] = { { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY) }, { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021) }, { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021) }, - { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_TOUCHBAR_DISPLAY) }, #endif #if IS_ENABLED(CONFIG_HID_APPLEIR) { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL) }, @@ -340,6 +339,9 @@ static const struct hid_device_id hid_have_special_driver[] = { #if IS_ENABLED(CONFIG_HID_APPLETB_BL) { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_TOUCHBAR_BACKLIGHT) }, #endif +#if IS_ENABLED(CONFIG_HID_APPLETB_KBD) + { HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_TOUCHBAR_DISPLAY) }, +#endif #if IS_ENABLED(CONFIG_HID_ASUS) { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK, USB_DEVICE_ID_ASUSTEK_I2C_KEYBOARD) }, { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK, USB_DEVICE_ID_ASUSTEK_I2C_TOUCHPAD) },