From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.remote-ip=209.85.216.42 ARC-Seal: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; cv=none; t=1792803120; b=H7wPj7XhOPbG84tnogDqcjdVNchLfyBaiRYqwjsaAvpj6tSEuG9y+uOnYlRjqkwuIx6k IsQhgvu9CKheY9nOHvTzvlasovZMDzlkn/pED1dqFoVcuQxi63okkq13Jox9B1FkyGaHq vfbtGrqETmAl1K+wQCX0y5fH6dop6UiaVuMt14ixlVxTx1JPHtyiGF/ZFgMdFbZuvVnu1 Vcfveeyl4r1DART/FAh5SM1w0nxz8Fc+pQagVZeYXi9TeHA2UJKDSUwSR0Lc6+7ZbGFoV fV6dtcW10WndrxcyK2Czqdn1Kml/KzZGb1LxK7i4+GJNu3Z1XCm9F6gAuEe3Y4/34DA== ARC-Message-Signature: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; c=relaxed/relaxed; t=1792803120; h=DMARC-Filter:Received:DKIM-Signature:X-Google-DKIM-Signature: X-Forwarded-Encrypted:X-Gm-Message-State:X-Gm-Gg:X-Received:Received: From:Date:Subject:MIME-Version:Content-Type:Content-Transfer-Encoding: Message-Id:References:In-Reply-To:To:Cc:X-Mailer: X-Developer-Signature:X-Developer-Key; bh=qhROuWKNB1zu9GN0+zWtwkE2StJd098hmWLDpMHCuHw=; b=Ge72Kfj6MgsR+GavRcd4aY1jCk/nGMfVu2aT34MiEON/++OOPDE/1iBaMfSrvvvsNxyQ J0sFZsLuwsIoGRNIiz91iTuTWZysrfPYJcDsLmmmrrwuKH3amGGyU5XfvSvIjIrg68qd0 PuXzFB6I1qLna0HH+X0jmwPfnBJk43xNPWQ2TgOd6JMUxWwoAs4g5UBgjQ5eWN4UQA+p3 LLEjaDqIVgiPwlLuEHwxgK58Vh8mMTRa90KA37iKzTcxIQQ5ofEZ7OmGx5ls49hUAve+L XrMmGOFpbn+UA4GVaxhKfjHYeWppxvxFe0kZ20EdnMtqS2N16a/q2MW0cMDtLrHx0/A== ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass header.from=chromium.org; spf=pass smtp.mailfrom=chromium.org; dkim=pass header.d=chromium.org header.i=@chromium.org header.a=rsa-sha256 header.s=google header.b=RLtLcn9L; arc=none smtp.remote-ip=209.85.216.42 Received: from mail-pj1-f42.google.com (mail-pj1-f42.google.com [209.85.216.42]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 901B760A3802 for ; Sat, 24 Oct 2026 00:51:59 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.subspace.kernel.org 901B760A3802 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, unprotected) header.d=chromium.org header.i=@chromium.org header.a=rsa-sha256 header.s=google header.b=RLtLcn9L Received: by mail-pj1-f42.google.com with SMTP id 98e67ed59e1d1-3ada8bc2380so615583a91.3 for ; Fri, 23 Oct 2026 17:51:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1792803119; x=1793407919; 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=qhROuWKNB1zu9GN0+zWtwkE2StJd098hmWLDpMHCuHw=; b=RLtLcn9LajDMTUG4e+brYlO8O8fLxgyQJvbrTx5vRJIknt12EczmRKkqtdKbofOvXK lMlIKXCU0ip9IujT4eDHRJTaWv6ExERqP5JqNyM80ZggSP5E+SezOdf+7gz4cm32Memi r1TVe8bYt43+Ht8K0n8KrS2La3cPrpG84I0QY= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1792803119; x=1793407919; 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=qhROuWKNB1zu9GN0+zWtwkE2StJd098hmWLDpMHCuHw=; b=gRoEuTK3MMneRwOlltrpWfhAdGvQydy+n969HUTi+oh1KVBpZwdoxMcNwh60vHHkg9 zu0ul++MgMLQ0kcBa8z8hIBafYzOnQ6FJB/1bQcAf6r6griKC0hXWjQCAY78WAqCxV9t VMt5Ye0tw6NA0R1j9vo5cZmbYfCHJOmovu6uNoy+Y/FOapYSw2fvePbvEB3CJm9BuEqu +0D9pPSgqO+O9Tdt2/Q2/LzJ+sgeT6S4xhf14JudMJBt2JdIxS95buzYo+mUtYY72hON ptPme6xX1SXc4tWhxqUiyv8OWBhVNEaadbh/AEC5beqR6RU4fBOFtHoucsIlfNXYJI0D hlmQ== X-Forwarded-Encrypted: i=1; AKwUvBzz/ZnZHy6wQYcxPNR/X/rfJxg4cGan+m+TrpX+b5bSpFFkpgd8z2V/qUsfB8XqVgikldxZBZwfw9lbKHI=@vger.kernel.org X-Gm-Message-State: AFq9FYIVK9dyquS6S45/pnMEr14xS3n+Zn5nlliUITKksupmREYGieAf RnKe9YCL7eGOguMKy+3uGqDsruqrraLK6mFEYvfcBo0FBouERt1jSumsPEiCxevD8Q== X-Gm-Gg: AYBFou1Vf7rrog+6Ky2bPvdanlxFUnQBSJcZaJsD+n5ZCZQKPiXH8YuAgFcAAv1nocL NMTuJ73WIBiNwOampIeklQEiALYpbpTGRgwJFOsUIKTA2pyxCvfW9juHXBZ05Y4YlmCHg7yLzyG NESSEyE5SLMTpcRq7irG0eBIMZd7BWAuPhoc2tUtUa0OgbPvPIJlYhJaNo57LDOFJBjTfbtTbJ3 ByW7qM9+X8KuDkH2LDpxuroPA3BO/r+xBMmZ9LIf8HwF0NsKDTuzhRAOZIT2r8qsyKtfwkIgKvv O5zgQ1We4/1M4iGZkuzuCJ3Lh95DD4Xfo1WCdcSNisPxaulQCL8cuot331u82nsQsLwNzs8ypyG kHSM4JWg1Wvj4PtiNp/Wf8WeuDBOvR2VmKmuY9oEaWK6wVICagRX4rDFAjR+nCZol4nFcuQ4lh2 K3lDjdT1yIdgaGZo5KQHV2p1/1QoNooPC7yq1IDT2erfpZ2QeoL0SyFvcNJTM9qDEoLg42fkclS XTbuVomXNZTyyZBjqfo4FIKQJ85IAQwVtGz8I/sLgm3PNs0FjKhxtJZCNpr9rHud5DkqWTzhyDo sppXzXYadVDKiQIIFZGBb356pOKqU3ezT3pcgCFhc+VrSR34CLsfRfvSFnN+uE8= X-Received: by 2002:a17:90b:5787:b0:3ac:a139:1b13 with SMTP id 98e67ed59e1d1-3adeabe4318mr657663a91.29.1792803118943; Fri, 23 Oct 2026 17:51:58 -0700 (PDT) Received: from jingyliang-input-linux.c.googlers.com (218.117.230.35.bc.googleusercontent.com. [35.230.117.218]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-3adebadfeb1sm843763a91.9.2026.10.23.17.51.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2026 17:51:58 -0700 (PDT) From: Jingyuan Liang Date: Sat, 24 Oct 2026 00:51:43 +0000 Subject: [PATCH v7 09/11] HID: spi-hid: add device tree support for HID over SPI X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20261024-send-upstream-v7-9-abad13174b43@chromium.org> References: <20261024-send-upstream-v7-0-abad13174b43@chromium.org> In-Reply-To: <20261024-send-upstream-v7-0-abad13174b43@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 , Jarrett Schultz , Dmitry Antipov X-Mailer: b4 0.14.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1792803111; l=7909; i=jingyliang@chromium.org; s=20260213; h=from:subject:message-id; bh=d3PymUtLWxe99doziaHIYJBPfLQ/rKkR0CjPyLuledA=; b=HYYjnGNbkyh3fZZpXhyedWvrRYvZqZYx97jmI7aJXcMi0wFN0CAIwXs8IizWJ6Wmqs12BPKIO Se0/gf9HIVkD0xH6JAOWiVmPARO82ZGh1vMVOLcLXknY8haBXi74hD3 X-Developer-Key: i=jingyliang@chromium.org; a=ed25519; pk=VTYSdqslTtYOjWWoIGgYoWupGWqNSidrggReKMgfPo4= From: Jarrett Schultz Detect SPI HID devices described in Device Tree. Signed-off-by: Dmitry Antipov Signed-off-by: Jingyuan Liang --- drivers/hid/spi-hid/Kconfig | 15 +++ drivers/hid/spi-hid/Makefile | 1 + drivers/hid/spi-hid/spi-hid-of.c | 210 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 226 insertions(+) diff --git a/drivers/hid/spi-hid/Kconfig b/drivers/hid/spi-hid/Kconfig index 303ada03a1bf..63f202975ac3 100644 --- a/drivers/hid/spi-hid/Kconfig +++ b/drivers/hid/spi-hid/Kconfig @@ -26,6 +26,21 @@ config SPI_HID_ACPI will be called spi-hid-acpi. It will also build/depend on the module spi-hid. +config SPI_HID_OF + tristate "HID over SPI transport layer Open Firmware driver" + depends on OF + 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 Open Firmware (Device Tree)-based systems. + + If unsure, say N. + + This support is also available as a module. If so, the module + will be called spi-hid-of. 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 3ca326602643..31192e71edae 100644 --- a/drivers/hid/spi-hid/Makefile +++ b/drivers/hid/spi-hid/Makefile @@ -9,3 +9,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 +obj-$(CONFIG_SPI_HID_OF) += spi-hid-of.o diff --git a/drivers/hid/spi-hid/spi-hid-of.c b/drivers/hid/spi-hid/spi-hid-of.c new file mode 100644 index 000000000000..d1bbdc17102e --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid-of.c @@ -0,0 +1,210 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * HID over SPI protocol, Open Firmware related code + * + * Copyright (c) 2021 Microsoft Corporation + * + * 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 +#include + +#include "spi-hid.h" + +/* Per-compatible data: protocol parameters and timings */ +struct spi_hid_of_data { + struct spi_hid_conf conf; + u32 post_power_on_delay_ms; + u32 minimal_reset_delay_ms; +}; + +/* Config structure is filled with match data and Device Tree resources */ +struct spi_hid_of_config { + struct spihid_ops ops; + + struct spi_hid_of_data data; + + struct gpio_desc *reset_gpio; + struct regulator *supply; + bool supply_enabled; +}; + +static const struct spi_hid_of_data microsoft_g6_data = { + .conf = { + .input_report_header_address = 0x1000, + .input_report_body_address = 0x1004, + .output_report_address = 0x2000, + .read_opcode = 0x0b, + .write_opcode = 0x02, + }, + .post_power_on_delay_ms = 10, + .minimal_reset_delay_ms = 100, +}; + +static int spi_hid_of_populate_config(struct spi_hid_of_config *conf, + struct device *dev) +{ + conf->supply = devm_regulator_get(dev, "vdd"); + if (IS_ERR(conf->supply)) + return dev_err_probe(dev, PTR_ERR(conf->supply), + "Failed to get regulator\n"); + conf->supply_enabled = false; + + conf->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH); + if (IS_ERR(conf->reset_gpio)) + return dev_err_probe(dev, PTR_ERR(conf->reset_gpio), + "Failed to get reset GPIO\n"); + + return 0; +} + +static int spi_hid_of_power_down(struct spihid_ops *ops) +{ + struct spi_hid_of_config *conf = container_of(ops, + struct spi_hid_of_config, + ops); + int error; + + if (!conf->supply_enabled) + return 0; + + error = regulator_disable(conf->supply); + if (error == 0) + conf->supply_enabled = false; + + return error; +} + +static int spi_hid_of_power_up(struct spihid_ops *ops) +{ + struct spi_hid_of_config *conf = container_of(ops, + struct spi_hid_of_config, + ops); + int error; + + if (conf->supply_enabled) + return 0; + + error = regulator_enable(conf->supply); + + if (error == 0) { + conf->supply_enabled = true; + fsleep(1000 * conf->data.post_power_on_delay_ms); + } + + return error; +} + +static int spi_hid_of_assert_reset(struct spihid_ops *ops) +{ + struct spi_hid_of_config *conf = container_of(ops, + struct spi_hid_of_config, + ops); + + return gpiod_set_value_cansleep(conf->reset_gpio, 1); +} + +static int spi_hid_of_deassert_reset(struct spihid_ops *ops) +{ + struct spi_hid_of_config *conf = container_of(ops, + struct spi_hid_of_config, + ops); + + return gpiod_set_value_cansleep(conf->reset_gpio, 0); +} + +static void spi_hid_of_sleep_minimal_reset_delay(struct spihid_ops *ops) +{ + struct spi_hid_of_config *conf = container_of(ops, + struct spi_hid_of_config, + ops); + fsleep(1000 * conf->data.minimal_reset_delay_ms); +} + +static int spi_hid_of_probe(struct spi_device *spi) +{ + struct device *dev = &spi->dev; + const struct spi_hid_of_data *data; + struct spi_hid_of_config *config; + int error; + + config = devm_kzalloc(dev, sizeof(struct spi_hid_of_config), + GFP_KERNEL); + if (!config) + return -ENOMEM; + + config->ops.power_up = spi_hid_of_power_up; + config->ops.power_down = spi_hid_of_power_down; + config->ops.assert_reset = spi_hid_of_assert_reset; + config->ops.deassert_reset = spi_hid_of_deassert_reset; + config->ops.sleep_minimal_reset_delay = + spi_hid_of_sleep_minimal_reset_delay; + + data = spi_get_device_match_data(spi); + if (!data) + return dev_err_probe(dev, -ENODEV, "No match data\n"); + + config->data = *data; + + /* + * FIXME: multi-SPI not supported. Once it is, derive the + * HID-over-SPI flags from spi->mode. + */ + + error = spi_hid_of_populate_config(config, dev); + if (error) + return dev_err_probe(dev, error, "Unable to populate config data\n"); + + return spi_hid_core_probe(spi, &config->ops, &config->data.conf); +} + +static const struct of_device_id spi_hid_of_match[] = { + { .compatible = "microsoft,g6-touch-digitizer", .data = µsoft_g6_data }, + { } +}; +MODULE_DEVICE_TABLE(of, spi_hid_of_match); + +static const struct spi_device_id spi_hid_of_id_table[] = { + { .name = "g6-touch-digitizer", .driver_data = (kernel_ulong_t)µsoft_g6_data }, + { } +}; +MODULE_DEVICE_TABLE(spi, spi_hid_of_id_table); + +static struct spi_driver spi_hid_of_driver = { + .driver = { + .name = "spi_hid_of", + .owner = THIS_MODULE, + .of_match_table = spi_hid_of_match, + .probe_type = PROBE_PREFER_ASYNCHRONOUS, + }, + .probe = spi_hid_of_probe, + .remove = spi_hid_core_remove, + .id_table = spi_hid_of_id_table, +}; + +module_spi_driver(spi_hid_of_driver); + +MODULE_DESCRIPTION("HID over SPI OF transport driver"); +MODULE_AUTHOR("Dmitry Antipov "); +MODULE_LICENSE("GPL"); -- 2.56.0.257.gf7497c7d27-goog