From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f176.google.com (mail-pl1-f176.google.com [209.85.214.176]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DE5453C5DBA for ; Tue, 9 Jun 2026 04:41:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.176 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1780980096; cv=none; b=W617O6jI4npWa2YsEJkKFwRZIlUhUccUkDTk/4BX/jTQiwHZNvwTTxA+8F164Wx63U2TW70EeV4hcpkCzrAM61N72SM2kkAvWQ1weC3R/9qOrSyx99wngXR7pJZjpajd3FNPi7MHxZGiYUGd62W0ng1ynAF+pBX4M1o59eVeAgk= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1780980096; c=relaxed/simple; bh=hG0V40iV/Y7c7cNuDaz97ooDhxn+35MGXdTaPNVx1A0=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=QCMVjOA3hbIMWMIsG92s8Ic2+bfKB8tOOO5bNmsC3FlISL0S+A8jhBxfumS7zGokuZ7ZNdXjwQKFn7n2xFcjyxf9IY7rqZ78+nCTENQy2O53PTQoATpZYVJixAoUrrL6LZze+E+t/g2qq5wviVR2l+TpJFP3zcitt48OXxei+6U= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b=L/Etf8Au; arc=none smtp.client-ip=209.85.214.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=chromium.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="L/Etf8Au" Received: by mail-pl1-f176.google.com with SMTP id d9443c01a7336-2c0b9328c4aso35761655ad.0 for ; Mon, 08 Jun 2026 21:41:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1780980090; x=1781584890; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=gWXDu3/HcuOfVv64RI+wowNxmcFlPuxMZRAdD/JxsdM=; b=L/Etf8AubDbw55dAIGKYc0bI8QVgeaFQ9bjhrvxF95CGthaPgY7QmUe5obDqgm/IaB KrMnsR8y7p0NSEfVuv8g9yDuyWXDlqR9SvEQWwYDAoUKZ3Hbr5XwXFdVboVJvIR0fV5q yQ804bof3QcKwxRx499y6DqF+sKyxPpvT8bxA= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1780980090; x=1781584890; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-gg:x-gm-message-state:from:to :cc:subject:date:message-id:reply-to; bh=gWXDu3/HcuOfVv64RI+wowNxmcFlPuxMZRAdD/JxsdM=; b=dnb1htHJdD3UjWPqgaJMf90xk6lqoi65VpKm05PJ7J/C3QF4Jd17Iv3SqDfCtD4DlG fBK3FAa5CfXnppQSOAv303okSXg/OVSKsqyIzhM9F2urWVRVxrB4FbU8CAGr8GiDTDKb I+H4oqrKuB4tznz7jzpo3HCHjljkrCVP+bI69Glht+YWi1Hpp2v9X4Ty2AjQfYCKx4+a nU1R+pbDD+6TcZ3+ftiyL4iWL+KOXTKRjUMI2jjOwutOSOh756xgb6eY79PQUDLayScR fTVhGGew070KQwSqCSQFOBeLdGbxD5n7fsC8wH3OYYUehBfEJPmZtvFhIKsWl0wlRYaK NpWw== X-Forwarded-Encrypted: i=1; AFNElJ+G+yqkrV+wvywn4+6aWhTQkTcqRSElO+H5QDlKrgvT3BRpVFL8SuXvlSKscUCqFf8MfrLkUKQS04w=@vger.kernel.org X-Gm-Message-State: AOJu0Yx+e8EsXJG/5F8MTftdHugzMNqD70ux7ep5urXJNC5l+ET3BXzo J6JVeqDSFUH6cH90mOyztgw46Bvpihz2JK3IHzZaEXvZdhBcZfe6RKpe+1i8NrHT/A== X-Gm-Gg: Acq92OGO/r/9uvGCpoi7XtpnegS17detDrrDGnywbTGL0/Kh/udv9pfMdIP780E8HuR pUqAX/GZOiH8/kU+qM8p0RBZ7yeFTHwAnDEDVNlRLXt+B8+PFt3SeQflaB5mZWgzsjouDA7QXZ3 Pm3kDAB8ik7GNAMu1XWoLoUpA04hA8lNx4vRbCIbU9x9UWN75+9E5FRFheHMVhYtnttnAe2iZZu 1zotwdA2ItYYc6d5QaVl2IanTVIzC3/4sHw8czr5RTFC1H6KfF60svlroanEI66o/ldLq2Nzirk +UyJCdm90aV/tl7pPl/5icXyYn+GjwA4yEjuZ4n2VETCU3rtfVNbd9GItjGa30eBiPgfcJzxbl0 92/P2eSFAGU/UdHsmFeLE/afamMy0H8+4ISKD54/I3u3XrI46hu0muUp246gPzpqPq2S+SzumxA efu+hgTiVfzJ9chW3/6t6tSMWLfv/DGmm0COOZoPsHUPgrQkkfLqGVrIrL3JHRPQtYPtHO0pOpV qmKsBLD/vhdBMO3b+Nbzl26E2uHVSSoS++7n3Bs4I6I X-Received: by 2002:a17:902:ebc3:b0:2c2:7baf:139f with SMTP id d9443c01a7336-2c2a1c9b30dmr15234975ad.30.1780980090158; Mon, 08 Jun 2026 21:41:30 -0700 (PDT) Received: from jingyliang-input-linux.c.googlers.com (111.169.168.34.bc.googleusercontent.com. [34.168.169.111]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2c1664a67b0sm200736065ad.80.2026.06.08.21.41.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jun 2026 21:41:29 -0700 (PDT) From: Jingyuan Liang Date: Tue, 09 Jun 2026 04:40:58 +0000 Subject: [PATCH v4 07/11] HID: spi_hid: add ACPI support for SPI over HID Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260609-send-upstream-v4-7-b843d5e6ced3@chromium.org> References: <20260609-send-upstream-v4-0-b843d5e6ced3@chromium.org> In-Reply-To: <20260609-send-upstream-v4-0-b843d5e6ced3@chromium.org> To: Jiri Kosina , Benjamin Tissoires , Jonathan Corbet , Mark Brown , Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Dmitry Torokhov , Rob Herring , Krzysztof Kozlowski , Conor Dooley Cc: linux-input@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, linux-trace-kernel@vger.kernel.org, devicetree@vger.kernel.org, hbarnor@chromium.org, tfiga@chromium.org, Jingyuan Liang , Angela Czubak X-Mailer: b4 0.14.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1780980084; l=12288; i=jingyliang@chromium.org; s=20260213; h=from:subject:message-id; bh=8M33xXmQDVVlf40o5Lxcmspv2S4S8yDzo/hCbMSduTg=; b=flz8ewSEJFt20YDARC8V5qyqpFQLht3Vfbh62au5eu6TsVv2Frut88X1L0shA0q8dQZ81B2d8 d/mxxN7vZjEAWse7Y/gqJmmUmYjNbqpwpgn9/7z9VDgjbMH4dYXUWx9 X-Developer-Key: i=jingyliang@chromium.org; a=ed25519; pk=VTYSdqslTtYOjWWoIGgYoWupGWqNSidrggReKMgfPo4= From: Angela Czubak Detect SPI HID devices described in ACPI. Signed-off-by: Angela Czubak Reviewed-by: Dmitry Torokhov Signed-off-by: Jingyuan Liang --- drivers/hid/spi-hid/Kconfig | 15 +++ drivers/hid/spi-hid/Makefile | 1 + drivers/hid/spi-hid/spi-hid-acpi.c | 253 +++++++++++++++++++++++++++++++++++++ drivers/hid/spi-hid/spi-hid-core.c | 26 +--- drivers/hid/spi-hid/spi-hid.h | 45 +++++++ 5 files changed, 315 insertions(+), 25 deletions(-) diff --git a/drivers/hid/spi-hid/Kconfig b/drivers/hid/spi-hid/Kconfig index 836fdefe8345..114b1e00da39 100644 --- a/drivers/hid/spi-hid/Kconfig +++ b/drivers/hid/spi-hid/Kconfig @@ -10,6 +10,21 @@ menuconfig SPI_HID if SPI_HID +config SPI_HID_ACPI + tristate "HID over SPI transport layer ACPI driver" + depends on ACPI + select SPI_HID_CORE + help + Say Y here if you use a keyboard, a touchpad, a touchscreen, or any + other HID based devices which are connected to your computer via SPI. + This driver supports ACPI-based systems. + + If unsure, say N. + + This support is also available as a module. If so, the module + will be called spi-hid-acpi. It will also build/depend on the + module spi-hid. + config SPI_HID_CORE tristate endif diff --git a/drivers/hid/spi-hid/Makefile b/drivers/hid/spi-hid/Makefile index 733e006df56e..3ca326602643 100644 --- a/drivers/hid/spi-hid/Makefile +++ b/drivers/hid/spi-hid/Makefile @@ -8,3 +8,4 @@ obj-$(CONFIG_SPI_HID_CORE) += spi-hid.o spi-hid-objs = spi-hid-core.o CFLAGS_spi-hid-core.o := -I$(src) +obj-$(CONFIG_SPI_HID_ACPI) += spi-hid-acpi.o diff --git a/drivers/hid/spi-hid/spi-hid-acpi.c b/drivers/hid/spi-hid/spi-hid-acpi.c new file mode 100644 index 000000000000..298e3ba44d8a --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid-acpi.c @@ -0,0 +1,253 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * HID over SPI protocol, ACPI related code + * + * Copyright (c) 2021 Microsoft Corporation + * Copyright (c) 2026 Google LLC + * + * This code was forked out of the HID over SPI core code, which is partially + * based on "HID over I2C protocol implementation: + * + * Copyright (c) 2012 Benjamin Tissoires + * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France + * Copyright (c) 2012 Red Hat, Inc + * + * which in turn is partially based on "USB HID support for Linux": + * + * Copyright (c) 1999 Andreas Gal + * Copyright (c) 2000-2005 Vojtech Pavlik + * Copyright (c) 2005 Michael Haboustak for Concept2, Inc + * Copyright (c) 2007-2008 Oliver Neukum + * Copyright (c) 2006-2010 Jiri Kosina + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "spi-hid.h" + +/* Config structure is filled with data from ACPI */ +struct spi_hid_acpi_config { + struct spihid_ops ops; + + struct spi_hid_conf property_conf; + u32 post_power_on_delay_ms; + u32 minimal_reset_delay_ms; + struct acpi_device *adev; +}; + +/* HID SPI Device: 6e2ac436-0fcf41af-a265-b32a220dcfab */ +static guid_t spi_hid_guid = + GUID_INIT(0x6E2AC436, 0x0FCF, 0x41AF, + 0xA2, 0x65, 0xB3, 0x2A, 0x22, 0x0D, 0xCF, 0xAB); + +static int spi_hid_acpi_populate_config(struct spi_hid_acpi_config *conf, + struct acpi_device *adev) +{ + acpi_handle handle = acpi_device_handle(adev); + union acpi_object *obj; + + conf->adev = adev; + + /* Revision 3 for HID over SPI V1, see specification. */ + obj = acpi_evaluate_dsm_typed(handle, &spi_hid_guid, 3, 1, NULL, + ACPI_TYPE_INTEGER); + if (!obj) { + acpi_handle_err(handle, + "Error _DSM call to get HID input report header address failed"); + return -ENODEV; + } + conf->property_conf.input_report_header_address = obj->integer.value; + ACPI_FREE(obj); + + obj = acpi_evaluate_dsm_typed(handle, &spi_hid_guid, 3, 2, NULL, + ACPI_TYPE_INTEGER); + if (!obj) { + acpi_handle_err(handle, + "Error _DSM call to get HID input report body address failed"); + return -ENODEV; + } + conf->property_conf.input_report_body_address = obj->integer.value; + ACPI_FREE(obj); + + obj = acpi_evaluate_dsm_typed(handle, &spi_hid_guid, 3, 3, NULL, + ACPI_TYPE_INTEGER); + if (!obj) { + acpi_handle_err(handle, + "Error _DSM call to get HID output report header address failed"); + return -ENODEV; + } + conf->property_conf.output_report_address = obj->integer.value; + ACPI_FREE(obj); + + obj = acpi_evaluate_dsm_typed(handle, &spi_hid_guid, 3, 4, NULL, + ACPI_TYPE_BUFFER); + if (!obj) { + acpi_handle_err(handle, + "Error _DSM call to get HID read opcode failed"); + return -ENODEV; + } + if (obj->buffer.length == 1) { + conf->property_conf.read_opcode = obj->buffer.pointer[0]; + } else { + acpi_handle_err(handle, + "Error _DSM call to get HID read opcode, too long buffer"); + ACPI_FREE(obj); + return -ENODEV; + } + ACPI_FREE(obj); + + obj = acpi_evaluate_dsm_typed(handle, &spi_hid_guid, 3, 5, NULL, + ACPI_TYPE_BUFFER); + if (!obj) { + acpi_handle_err(handle, + "Error _DSM call to get HID write opcode failed"); + return -ENODEV; + } + if (obj->buffer.length == 1) { + conf->property_conf.write_opcode = obj->buffer.pointer[0]; + } else { + acpi_handle_err(handle, + "Error _DSM call to get HID write opcode, too long buffer"); + ACPI_FREE(obj); + return -ENODEV; + } + ACPI_FREE(obj); + + /* Value not provided in ACPI,*/ + conf->post_power_on_delay_ms = 5; + conf->minimal_reset_delay_ms = 150; + + if (!acpi_has_method(handle, "_RST")) { + acpi_handle_err(handle, "No reset method for acpi handle"); + return -EINVAL; + } + + /* FIXME: not reading hid-over-spi-flags, multi-SPI not supported */ + + return 0; +} + +static int spi_hid_acpi_power_none(struct spihid_ops *ops) +{ + return 0; +} + +static int spi_hid_acpi_power_down(struct spihid_ops *ops) +{ + struct spi_hid_acpi_config *conf = container_of(ops, + struct spi_hid_acpi_config, + ops); + + return acpi_device_set_power(conf->adev, ACPI_STATE_D3); +} + +static int spi_hid_acpi_power_up(struct spihid_ops *ops) +{ + struct spi_hid_acpi_config *conf = container_of(ops, + struct spi_hid_acpi_config, + ops); + int error; + + error = acpi_device_set_power(conf->adev, ACPI_STATE_D0); + if (error) { + dev_err(&conf->adev->dev, "Error could not power up ACPI device: %d.", error); + return error; + } + + if (conf->post_power_on_delay_ms) + msleep(conf->post_power_on_delay_ms); + + return 0; +} + +static int spi_hid_acpi_assert_reset(struct spihid_ops *ops) +{ + return 0; +} + +static int spi_hid_acpi_deassert_reset(struct spihid_ops *ops) +{ + struct spi_hid_acpi_config *conf = container_of(ops, + struct spi_hid_acpi_config, + ops); + + return device_reset(&conf->adev->dev); +} + +static void spi_hid_acpi_sleep_minimal_reset_delay(struct spihid_ops *ops) +{ + struct spi_hid_acpi_config *conf = container_of(ops, + struct spi_hid_acpi_config, + ops); + fsleep(1000 * conf->minimal_reset_delay_ms); +} + +static int spi_hid_acpi_probe(struct spi_device *spi) +{ + struct device *dev = &spi->dev; + struct acpi_device *adev; + struct spi_hid_acpi_config *config; + int error; + + adev = ACPI_COMPANION(dev); + if (!adev) { + dev_err(dev, "Error could not get ACPI device."); + return -ENODEV; + } + + config = devm_kzalloc(dev, sizeof(struct spi_hid_acpi_config), + GFP_KERNEL); + if (!config) + return -ENOMEM; + + if (acpi_device_power_manageable(adev)) { + config->ops.power_up = spi_hid_acpi_power_up; + config->ops.power_down = spi_hid_acpi_power_down; + } else { + config->ops.power_up = spi_hid_acpi_power_none; + config->ops.power_down = spi_hid_acpi_power_none; + } + config->ops.assert_reset = spi_hid_acpi_assert_reset; + config->ops.deassert_reset = spi_hid_acpi_deassert_reset; + config->ops.sleep_minimal_reset_delay = + spi_hid_acpi_sleep_minimal_reset_delay; + + error = spi_hid_acpi_populate_config(config, adev); + if (error) { + dev_err(dev, "%s: unable to populate config data.", __func__); + return error; + } + + return spi_hid_core_probe(spi, &config->ops, &config->property_conf); +} + +static const struct acpi_device_id spi_hid_acpi_match[] = { + { "ACPI0C51", 0 }, + { "PNP0C51", 0 }, + { } +}; +MODULE_DEVICE_TABLE(acpi, spi_hid_acpi_match); + +static struct spi_driver spi_hid_acpi_driver = { + .driver = { + .name = "spi_hid_acpi", + .owner = THIS_MODULE, + .acpi_match_table = spi_hid_acpi_match, + .probe_type = PROBE_PREFER_ASYNCHRONOUS, + .dev_groups = spi_hid_groups, + }, + .probe = spi_hid_acpi_probe, + .remove = spi_hid_core_remove, +}; + +module_spi_driver(spi_hid_acpi_driver); + +MODULE_DESCRIPTION("HID over SPI ACPI transport driver"); +MODULE_AUTHOR("Angela Czubak "); +MODULE_LICENSE("GPL"); diff --git a/drivers/hid/spi-hid/spi-hid-core.c b/drivers/hid/spi-hid/spi-hid-core.c index ef527999d6dc..698e72102c11 100644 --- a/drivers/hid/spi-hid/spi-hid-core.c +++ b/drivers/hid/spi-hid/spi-hid-core.c @@ -44,6 +44,7 @@ #include #include +#include "spi-hid.h" #include "spi-hid-core.h" #define CREATE_TRACE_POINTS @@ -111,31 +112,6 @@ struct spi_hid_output_report { u8 *content; }; -/* struct spi_hid_conf - Conf provided to the core */ -struct spi_hid_conf { - u32 input_report_header_address; - u32 input_report_body_address; - u32 output_report_address; - u8 read_opcode; - u8 write_opcode; -}; - -/** - * struct spihid_ops - Ops provided to the core - * @power_up: do sequencing to power up the device - * @power_down: do sequencing to power down the device - * @assert_reset: do sequencing to assert the reset line - * @deassert_reset: do sequencing to deassert the reset line - * @sleep_minimal_reset_delay: minimal sleep delay during reset - */ -struct spihid_ops { - int (*power_up)(struct spihid_ops *ops); - int (*power_down)(struct spihid_ops *ops); - int (*assert_reset)(struct spihid_ops *ops); - int (*deassert_reset)(struct spihid_ops *ops); - void (*sleep_minimal_reset_delay)(struct spihid_ops *ops); -}; - static struct hid_ll_driver spi_hid_ll_driver; static void spi_hid_populate_read_approvals(const struct spi_hid_conf *conf, diff --git a/drivers/hid/spi-hid/spi-hid.h b/drivers/hid/spi-hid/spi-hid.h new file mode 100644 index 000000000000..f5a5f4d54beb --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid.h @@ -0,0 +1,45 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Copyright (c) 2021 Microsoft Corporation + * Copyright (c) 2026 Google LLC + */ + +#ifndef SPI_HID_H +#define SPI_HID_H + +#include +#include + +/* struct spi_hid_conf - Conf provided to the core */ +struct spi_hid_conf { + u32 input_report_header_address; + u32 input_report_body_address; + u32 output_report_address; + u8 read_opcode; + u8 write_opcode; +}; + +/** + * struct spihid_ops - Ops provided to the core + * @power_up: do sequencing to power up the device + * @power_down: do sequencing to power down the device + * @assert_reset: do sequencing to assert the reset line + * @deassert_reset: do sequencing to deassert the reset line + * @sleep_minimal_reset_delay: minimal sleep delay during reset + */ +struct spihid_ops { + int (*power_up)(struct spihid_ops *ops); + int (*power_down)(struct spihid_ops *ops); + int (*assert_reset)(struct spihid_ops *ops); + int (*deassert_reset)(struct spihid_ops *ops); + void (*sleep_minimal_reset_delay)(struct spihid_ops *ops); +}; + +int spi_hid_core_probe(struct spi_device *spi, struct spihid_ops *ops, + struct spi_hid_conf *conf); + +void spi_hid_core_remove(struct spi_device *spi); + +extern const struct attribute_group *spi_hid_groups[]; + +#endif /* SPI_HID_H */ -- 2.54.0.1064.gd145956f57-goog