From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) (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 76D6A503BF3 for ; Fri, 9 Oct 2026 22:26:44 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.172 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791584811; cv=none; b=W7WvXuKl4aUdGRbqKgQL55/DdIlqY+sWGJM72XtvD0MWwrgVqG4FDES24IARklk2Aft7OG0d49JJLIpinIVuit9r+graJudU3k09VcFu/u344MjrSIx/3BRUjmbhvwtWIM1n4o7uFk0XMTGiOU1u8pyqy0BS7vPJY0OZ/Mb2ZA4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791584811; c=relaxed/simple; bh=S0QBecAcncc63+m01u9T0Dtr/6XODkGsyD7M4q1inrY=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=blJrSa96O8ZQofJ7HVjigg42VsK/J7smxDk8/LfuN14ya8i7wCY/gMlCtOziHps87ivfJVvpk/mcFhVQCgwJ3wFHEp7N5a9LS0QlrCMmEvhFOzBfarrHxyxSpu0PUGeLNqNquGNQ/kJnmVceN+yix8UmvXSSNy8W7M9AtZI4+6k= 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=AJiRFUuZ; arc=none smtp.client-ip=209.85.214.172 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="AJiRFUuZ" Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-2e61f017091so1208205ad.1 for ; Fri, 09 Oct 2026 15:26:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1791584804; x=1792189604; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :content-type:mime-version:subject:date:from:from:to:cc:subject:date :message-id:reply-to:content-type; bh=CdtZZXq0NyL+apbyXgDNXmZWiPgD5LjbHkgGoWWG0zg=; b=AJiRFUuZCaVHEHIwsc/wT2YrCpaFnhuJPaNdijb6O4GiPo55bCHSZ+b6+eZ3gt0KDx 6yAgRYDKdu49A76w5W84SBzQXSQoIEhi8T1JQ3Gy3WUGQPUUGIeTtm9rP1N9H06itwad DafMvxZxUtAI1anLyAElNS4ahPybH/PtMZpZk= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1791584804; x=1792189604; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :content-type:mime-version:subject:date:from:x-gm-gg :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to :content-type; bh=CdtZZXq0NyL+apbyXgDNXmZWiPgD5LjbHkgGoWWG0zg=; b=N+XkpWZYxy7wgy7NwDmg4D/0GRE0OnBiuBhbn8VQ1idkhMwKZHNY8V+2Xlt41COkyj iiYm19aGNMe+Se3cho6I2FL5XmBA5lZJ6BsNrM/O4fLm0RlF76xa3XYaRys/DJaM3jcd etZrVQQC/9ysm4CXM7KnqgIgQJGqmyNiC2lo1GYE8TrE6e4JPeyW+mbmnGbnDV7jF/8j 1PsMmIKsCOSjMvk40iATXKJDg0PZg5huJ7zf6XH8aGvvliDQxj6ESaoflQjza2X+q2t0 LxXm285YlF4/DGmvpo1wihpMMVc8TiYkU6ByhkJaZkUepN9M8WDNCpNJZ4IJLG+ZEre6 8+JA== X-Gm-Message-State: AFq9FYJHX4vXm1JRrAkcg5khB4ZlLad2NSaZm1BtPztF2oRsMZKmkZ7Y X/23QNmDrSZF+tYceXgpcCCHut4+lfhQ9uXUJiTrYm9P9TKaHG/oCLsHyiyYimRp1FCcU+VUYht dV3BZHg== X-Gm-Gg: AYBFou2lhsopy8P2SCdPH/LwTHS3P9iei/nsa4ueXUv9fQoG1+PZE+oYpuHstJ1c2ya wjSTH6TiwixIkG7LMuzu7vIkMWm/goFh6npnjLU+cHtLYHBxlm51cSF8Lc4DfratFkzpROGdM3k SCZBdHNUHXIz8DeYIFIYE6hECAevFjni+xWUb1vhJxGSrspkeg1fsdvWDn0auYxYP3FK8D5r6+X Kf08MLCANvpvOEX/4rhSbyvLx1PZSXNQ9Tmv/fOrCJ3KeweZo2H8cHawgcBCm9cr8NAmCFz/aZH LPAFHvPNMCDyYCq4eeq1h/ebIiwKCY3YdWnPOv7p1e+3w5PrB06rzFBACxp7szR0kA8aTqASMge kSfOrMAs600UsDbNGu1K3Dj9a+iNSBmOFaGQzpIF4Emp5jXTj/4aONFLerm1WbXL9TZW6TsFHAd CI4MlVSx5ul2/yuyM+SUp/lIMO95E+vl5XJ1zaR5hdqMcc3XlSdOVolsTwQOq1tBKHSvpwWSsyd 2qFhJDFk/gm5WO1lIeniYOGT6LzhEB9gPeYpmgvdmiT2ULyISYWeb6jsFfAFIMsoKaVBz+QpuWt X-Received: by 2002:a17:903:2352:b0:2e6:dcce:8227 with SMTP id d9443c01a7336-2e842bc2b4emr31154355ad.37.1791584803557; Fri, 09 Oct 2026 15:26:43 -0700 (PDT) Received: from jingyliang-input-linux.c.googlers.com (35.152.82.34.bc.googleusercontent.com. [34.82.152.35]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-2e84219e503sm16660725ad.17.2026.10.09.15.26.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 09 Oct 2026 15:26:43 -0700 (PDT) From: Jingyuan Liang Date: Fri, 09 Oct 2026 22:25:32 +0000 Subject: [PATCH v5 07/11] HID: spi-hid: add ACPI support for HID over SPI Precedence: bulk X-Mailing-List: linux-input@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: <20261009-send-upstream-v5-7-384af01da3ee@chromium.org> References: <20261009-send-upstream-v5-0-384af01da3ee@chromium.org> In-Reply-To: <20261009-send-upstream-v5-0-384af01da3ee@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, fqwqf@fqwqf.xyz, daleyo@gmail.com, Jingyuan Liang , Angela Czubak X-Mailer: b4 0.14.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1791584797; l=13793; i=jingyliang@chromium.org; s=20260213; h=from:subject:message-id; bh=71Myuu6ESwWFI65r97oEJQ36Seqs4SGZAcVSv4SUcTM=; b=Lz5I0u6HyqOvxgwZPxaF8NpwQM1GaNvaPI85hXHB1mLkgLJnTZPo9uPYRWI9t2dC0gjSVOAPw ob4JFAJ8UitAnhaBK9UmFif56AO5YvZr0bHaTbLH0XRypDNC9GOr+yC 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 Tested-by: Dale Whinham Signed-off-by: Jingyuan Liang --- drivers/hid/spi-hid/Kconfig | 16 +++ drivers/hid/spi-hid/Makefile | 1 + drivers/hid/spi-hid/spi-hid-acpi.c | 261 +++++++++++++++++++++++++++++++++++++ drivers/hid/spi-hid/spi-hid-core.c | 48 +++---- drivers/hid/spi-hid/spi-hid.h | 45 +++++++ 5 files changed, 344 insertions(+), 27 deletions(-) diff --git a/drivers/hid/spi-hid/Kconfig b/drivers/hid/spi-hid/Kconfig index 836fdefe8345..303ada03a1bf 100644 --- a/drivers/hid/spi-hid/Kconfig +++ b/drivers/hid/spi-hid/Kconfig @@ -10,6 +10,22 @@ menuconfig SPI_HID if SPI_HID +config SPI_HID_ACPI + tristate "HID over SPI transport layer ACPI driver" + depends on ACPI + select RESET_CONTROLLER + 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..31ca3fa336cd --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid-acpi.c @@ -0,0 +1,261 @@ +// 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; + struct device *dev; +}; + +/* 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\n"); + 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\n"); + 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\n"); + 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\n"); + 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\n"); + 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\n"); + 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\n"); + 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\n"); + 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\n", 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); + + /* + * Probe guarantees an ACPI reset method exists. Use the optional + * variant so that the absence of an additional reset controller + * binding is not reported as an error after a successful reset. + */ + return device_reset_optional(conf->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\n"); + return -ENODEV; + } + + config = devm_kzalloc(dev, sizeof(struct spi_hid_acpi_config), + GFP_KERNEL); + if (!config) + return -ENOMEM; + + config->dev = dev; + + 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\n", __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 83678e683581..f4e9b4e1294e 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 @@ -115,31 +116,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, @@ -327,8 +303,21 @@ static void spi_hid_error_handler(struct spi_hid *shid) shid->power_state = HIDSPI_ON; - shid->ops->deassert_reset(shid->ops); + error = shid->ops->deassert_reset(shid->ops); + if (error) { + dev_err(dev, "failed to deassert reset: %d\n", error); + shid->bus_error_count++; + shid->bus_last_error = error; + /* + * Without a successful reset the device will not send a reset + * response, so no IRQ would trigger another recovery attempt. + * Retry from here; reset_attempts bounds the number of tries. + */ + set_bit(SPI_HID_ERROR, &shid->flags); + schedule_work(&shid->reset_work); + } + /* Balance disable_irq() above; a retry disables it again. */ enable_irq(shid->spi->irq); } @@ -1428,7 +1417,12 @@ int spi_hid_core_probe(struct spi_device *spi, struct spihid_ops *ops, return error; } - shid->ops->deassert_reset(shid->ops); + error = shid->ops->deassert_reset(shid->ops); + if (error) { + dev_err(dev, "%s: failed to deassert reset: %d\n", __func__, error); + shid->ops->power_down(shid->ops); + return error; + } enable_irq(spi->irq); 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.56.0.385.gd3acb90ef8-goog