From patchwork Sun Dec 29 09:43:56 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Aditya Garg X-Patchwork-Id: 13922634 Received: from PNYPR01CU001.outbound.protection.outlook.com (mail-centralindiaazolkn19010012.outbound.protection.outlook.com [52.103.68.12]) (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 B6AD878F36; Sun, 29 Dec 2024 09:44:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=52.103.68.12 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1735465444; cv=fail; b=JaGqzGbam30+ndUcably/SnbCLRor2WYXDq9axSnMBxnkj2yc9xjq5s6xV5EO867QSeq+qd+g0eywdpnUOlw3NFrIkzz2LDvlat1pxbOFm6BmfYGsgMZ2H/Z1EN6UV7fn77T/TVHiv0fIq+4qYh8VSTTKhbtUUgJYkffLC30SZo= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1735465444; c=relaxed/simple; bh=nQ/DwVgFVO3Vllcf1AzVKw4C/c+9cDooz0F7eTtoE7Q=; h=From:To:CC:Subject:Date:Message-ID:References:In-Reply-To: Content-Type:MIME-Version; b=i/qR6ZkMeMOUWtJutYJ790AmQK0Ih7hTzedNGWiTbs9SbdjzduK+7cbtWtnYkzX0UDwWaupB6ai2gEueSCa66Sv2bSjw8kg51i33BnJyqKKbdC+heDzWd0eUp3uX3ls4CBBYHFuZfaHsu+N2B03cAUg9tOEO3oV1L/IVWDRkcTM= 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=leBVw/se; arc=fail smtp.client-ip=52.103.68.12 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="leBVw/se" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=pVJGEqg0XGScLcaTy+SW6Ql48v5uka1F/kQWzkzAo0rcfrkIIdWRyKjQrOA8h7gqrHXEBAtgtA6YoNFSOxUAr09svHW3KEr2Gq5xX69oT7N5AJp0B4VO6rGakhm0q2KGx6ShTBZ2TCZOgDR6GA3klbmQAzAJJLKCeD1PcScFLXyqZDgX5jfqWYoL30pT6gipL5QrhVJA6vgGMh6F4cMWQnWyK+WDVWepMxonyenpHGKhCi0EEWIgUM9GsulzuC6ii2szcNL1RvuZ/yDr06KNR7yRYyTF4FYu/BSAgSUSey4WH3PLPvHe4w2ZO3OCkpJxyHD4Q6c2PB7ld/G7mHJbHg== 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=nQ/DwVgFVO3Vllcf1AzVKw4C/c+9cDooz0F7eTtoE7Q=; b=wbUJtRZe1JD07ikHohxpmRHqUOz1OdG3p8BegK/uZrP0QCwZeiIsF1vJlPOTx+kIPjtwa/HgGZZREgDyHXlk0sHeG+meEMLXftCHXE2Ff4oB0fQbR8ZFaVrE1FsarTwMTehmvez4iL5W9XPFV3frp3yZ3Zn1jCnMBk0DG+2LYERDmnf4if50KVpVDoJviVqkocFYySUth9PG2z17m/UgLobZ9kWNvaqhudMox+2aXTsgV037jx/4G1Qg77dZAbRAUqGO+yhYLJELHnnMyEnDb91rApAIg3XWb5L0ZmCvrZp0avQW4+ZsX83zSf9+G4/RuNkd0A6Cq76RVe2CSPhp+w== 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=nQ/DwVgFVO3Vllcf1AzVKw4C/c+9cDooz0F7eTtoE7Q=; b=leBVw/se9dK+J/PDwFrOamX6pisNyUQx/0a8fsMf86QpiWc+Rsp9BzqFdPwC2UVyjDYjCz1NIp6xdTcbQxZMDhe6fOBPFiv248PFv5lve3XpqWF0GqHk0KlVU15VuUhoZZxTjVEin6fUB3sYtQC4ekhOr774oGSLN1NvMUMXz2rZ+Z4J4hZmKlnrbJ/eOxdFp4ovNiYmha5m6b3RP9WlIhD+XaqplYita3ezwcS/PYrr6NMSWgqOI7r4e57eaqhqIqAUy7p3O4kzYbXrYE3gQaOFDeHGrci07BpD3FpruIuctoyPidCzsmJPLPq3KAbV0v4dtuzsXeIL+l24g6ax0Q== Received: from PN3PR01MB7728.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c01:cd::12) by MA0PR01MB7898.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a01:1c::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8293.18; Sun, 29 Dec 2024 09:43:57 +0000 Received: from PN3PR01MB7728.INDPRD01.PROD.OUTLOOK.COM ([fe80::d3b7:2498:cd95:5d06]) by PN3PR01MB7728.INDPRD01.PROD.OUTLOOK.COM ([fe80::d3b7:2498:cd95:5d06%3]) with mapi id 15.20.8293.000; Sun, 29 Dec 2024 09:43:57 +0000 From: Aditya Garg To: "jikos@kernel.org" , Benjamin Tissoires , "bentiss@kernel.org" CC: Kerem Karabay , Orlando Chamberlain , "linux-input@vger.kernel.org" , Linux Kernel Mailing List Subject: [PATCH 2/4] HID: hid-appletb-kbd: add driver for the keyboard mode of Apple Touch Bars Thread-Topic: [PATCH 2/4] HID: hid-appletb-kbd: add driver for the keyboard mode of Apple Touch Bars Thread-Index: AQHbWdYuylyprycvE0+t9mFJBj4wEg== Date: Sun, 29 Dec 2024 09:43:56 +0000 Message-ID: References: <793F0F3B-D51C-49C8-9236-124CF130E833@live.com> In-Reply-To: <793F0F3B-D51C-49C8-9236-124CF130E833@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: PN3PR01MB7728:EE_|MA0PR01MB7898:EE_ x-ms-office365-filtering-correlation-id: 6fe55142-5f5f-4cac-87ff-08dd27ed50a7 x-microsoft-antispam: BCL:0;ARA:14566002|8060799006|7092599003|461199028|19110799003|8062599003|15080799006|102099032|440099028|3412199025; x-microsoft-antispam-message-info: =?utf-8?q?wZLvy54rNiVxgSGIJeSIe6CLetL4cxa?= =?utf-8?q?R++/9BssP0YYsaht27D9dxw9Z7JFsTbyiRuFa4AILL9BGkVNKCZqhtgGiAS1YYVI5?= =?utf-8?q?Nnc5RasNJsNHR4I1/ly9cN3wrVH2uFvuHG734itqPalbkOqNdef39OE9LBorlP4q0?= =?utf-8?q?vZ+iXeg3HTF/pf7ou5/d8oxenPSUjE0wdqWLPu5DLuDOEFHhVxFIEOT3C4NFl8Rku?= =?utf-8?q?HERA/bBaQPtp5HVLFTwZwyVIjxS3W2JfRidUHdDM4WzkAbJd/JlQWwjwGua1GXJvi?= =?utf-8?q?fz4srCq3JLS9kxNY6rT4PWOA1IuU2exkFwWKQWD24YR1ZGDZc2V/SriaJFcWqZdPV?= =?utf-8?q?aBaozyxGFpo4W6l8JKWOBnSM6BGamvnDdmOw5M9mZ9AaTPGfEsOw0ICGuBVtST9yq?= =?utf-8?q?tjXZ79frw7MLX/Qu9ActpbEFny2MAYN+HAQEwN0GQ46bFkJYlLI14NyFF1vjG3GID?= =?utf-8?q?TlToSEunQ41PvyHnEBWuPlu434yk95XimjXs7qnRSe+lJzYfJP9zb4fmanEVWceiO?= =?utf-8?q?SR8pzpcFRVxg2FsWGSiA+RlOV6znxzc2U7E2POuNFWO0wqj2BiRPlUzgMkARHEFHq?= =?utf-8?q?a+XPbcu9uk35SCkeaT3NJgmMTx/SFyewecYMt2/8h/z3EPvk1pv4HAKCI11GSrfOj?= =?utf-8?q?0giicnOBVVHYbylW+cVd73aUOVPD/X62hiDYiknRGgo5k7xqdQZ5a30j6LKZdF+tx?= =?utf-8?q?g9uTw0JJeeykClhDX7hAgQRBLzHkFC/qDD8Zi56RD3LezYYA/ZpBNIXkONc5IWdXN?= =?utf-8?q?K+keGDDigR+iH+0gVsarGf4mUVi+gs4jmwnYhXsJZy8QmeEU90NNcJhrV48o/mBvq?= =?utf-8?q?vYta8Xp+rZTFY62pwQsyUBv25lbHKYOkHe2TWEFUM/EaqT8uijV0tNSCuwsoe7zTz?= =?utf-8?q?v9XrGjYYIEafYjB2eZD/rLKm/YxqLWWYTBe7zyC0h6R2rFzk16tA+5J7g35yNukLJ?= =?utf-8?q?ESVbUf+94U7gKpeowRvcQmXVLnXx/pJUXFkgaArd5vWxDVf9ChWZ7X6VX0JiHyJt+?= =?utf-8?q?4CW9CXEVm6h1EVcm6keVwpTYSsAw2sFMLTKvQhA=3D=3D?= x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?utf-8?q?QFCJ555h72YzpOCskhNhdlYDpt3U?= =?utf-8?q?8foY3ONeMAIdNHEEZ1MltgHW42sauycny9FhweHS8FTdGx4YDetjJ4mN37FJsE1z2?= =?utf-8?q?HBEwJIBnd5LgCJOr/U4JSs3UPTaqMGAId9FUaVrSk6Y7PdyM8oHaQO7eiQehPL3UT?= =?utf-8?q?crENr4krZtPy+hiqRgjGxyzKBPGNMNnxgE0C8YpXu0DKbnoT4Bwky7Uwfem7UFVSq?= =?utf-8?q?VDsEwNVEfKjEv2KEdnJLzKjoTrhb3Hchl5jIDF2kMMJSeyp2dx4qQbOZOoaECOjI+?= =?utf-8?q?74Kyfj20/aSkN0mXPhqBxJkj8WTn9rg2nUB13mlksSuB5wwwgBdvfzthHfTf2chdZ?= =?utf-8?q?QKAy9s4ajU7pgBCrMNFhYjkwzuEYdKXzkvhuZzE+207x2iADB35jDuuJ0gov4v3C2?= =?utf-8?q?91W/PMikaMqLbWq4oF6KGgoyi9YNcvZI5yf3+mO+KRBDhCPplCFKMqLbaZLYkvDqp?= =?utf-8?q?TX7wAhWw+MQQY6361urLqgaoS7EJ4I8m6mQ6wO+fDqw76DiGqTFknUJE+lggC3lUH?= =?utf-8?q?4iznFZfx1+lTkiUATmMYJtDuKdP0a3GRVfofLmdo6AthcSkuZAMfk88OCBwIcEaEt?= =?utf-8?q?RChGCHacnE09RQqoUuV87Zf4RrGYoF98mdDGFxuhIKDh2d2/j9Wl4zb3eWuufpz9c?= =?utf-8?q?fsnTXIpCAz1/osFDYwpiK91YtcUk3cQM5rKBPIOPfmgwWUlSwG8FdaEhbT9qRo1bp?= =?utf-8?q?wINZy8gNESuQugdp34/bdPJmdnrraHxJNtUJ8pPibvsqkAbZ/two/HEx6xZxzP/ku?= =?utf-8?q?Wx7yGhsOJPLNCJPGmExY0ij7FoqTQPaLIOyA1HhAbNNuTHvbrJtuIzy60EgmeqRxe?= =?utf-8?q?SymWXwKF5labVWtSlAIsWqoj2O1Yn6KisYDUnkjF4ARvN8KN2LfRdo0BFl+SSXpbJ?= =?utf-8?q?KbO45lBHpmgPFfctQgey5B2Ct/fEbYYS5swcw4j9Pz9pvZKcKKbONtHXIkY3XWi8F?= =?utf-8?q?ISuL6OUx7aOw20VpH84TLeIBli5Med/8yFsTX39igc7OnLoRwvhQ1Qu+C0snDTB5n?= =?utf-8?q?gEsDF3RyUkFp/s2qWCeCHD699iI21a4fSx6sYN3mHgwDW0KjGD8FgVrXcK+89pgVi?= =?utf-8?q?9vsgFznwQobdcR2X7BZOEg7k1cr1aNhfuWvzjcwoDdIxeXLZgwV1nLuBqDXxQ9PCz?= =?utf-8?q?p4jc+8Fry8VpLi0CaNngYqpeMkkSVsGqGQMwC7arboIk66Pii8iD2CjZM6uzh/2oi?= =?utf-8?q?hcYpNSI6+SbNxMxP4Naws7ICp42wcNo3EvmQsJkwK/oQGgWiIYKgubuVmbggAmGK0?= =?utf-8?q?wK31UwNLM59rKCBk?= Content-ID: <2F6BC0AE33ADC94789B0ADF5216CB7C4@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: PN3PR01MB7728.INDPRD01.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-CrossTenant-Network-Message-Id: 6fe55142-5f5f-4cac-87ff-08dd27ed50a7 X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-CrossTenant-originalarrivaltime: 29 Dec 2024 09:43:57.0024 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-Transport-CrossTenantHeadersStamped: MA0PR01MB7898 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) },