From: Dmitry Antipov <daantipov@gmail.com>
To: Jiri Kosina <jikos@kernel.org>,
Benjamin Tissoires <benjamin.tissoires@redhat.com>,
Dmitry Torokhov <dmitry.torokhov@gmail.com>,
Rob Herring <robh+dt@kernel.org>, Mark Brown <broonie@kernel.org>,
Felipe Balbi <balbi@kernel.org>
Cc: linux-input@vger.kernel.org, devicetree@vger.kernel.org,
linux-spi@vger.kernel.org, Dmitry Antipov <dmanti@microsoft.com>
Subject: [PATCH v3 3/5] Documentation: DT bindings for HID over SPI.
Date: Fri, 14 Jan 2022 18:31:33 -0800 [thread overview]
Message-ID: <20220115023135.234667-4-dmanti@microsoft.com> (raw)
In-Reply-To: <20220115023135.234667-1-dmanti@microsoft.com>
From: Dmitry Antipov <dmanti@microsoft.com>
Added documentation describes the required properties for implementing
Device Tree for a device supporting HID over SPI and also provides an
example.
Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
.../bindings/input/hid-over-spi.txt | 43 +++++++++++++++++++
1 file changed, 43 insertions(+)
create mode 100755 Documentation/devicetree/bindings/input/hid-over-spi.txt
diff --git a/Documentation/devicetree/bindings/input/hid-over-spi.txt b/Documentation/devicetree/bindings/input/hid-over-spi.txt
new file mode 100755
index 000000000000..5eba95b5724e
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/hid-over-spi.txt
@@ -0,0 +1,43 @@
+* HID over SPI Device-Tree bindings
+
+HID over SPI provides support for Human Interface Devices over the SPI bus. HID
+Over SPI Protocol Specification 1.0 was written by Microsoft and is available at
+https://www.microsoft.com/en-us/download/details.aspx?id=103325.
+
+If this binding is used, the kernel module spi-hid will handle the communication
+with the device and the generic hid core layer will handle the protocol.
+
+Required properties:
+- compatible: must be "hid-over-spi"
+- interrupts: interrupt line
+- vdd-supply: phandle of the regulator that provides the supply voltage
+- reset_gpio-gpios: gpio wired to the device reset line
+- post-power-on-delay-ms: time required by the device after enabling its
+regulators or powering it on, before it is ready for communication
+- minimal-reset-delay-ms: minimum amount of time that device needs to be in
+reset state for the reset to take effect
+- input-report-header-address: this property and the rest are described in HID
+Over SPI Protocol Spec 1.0
+- input-report-body-address
+- output-report-address
+- read-opcode
+- write-opcode
+- flags
+
+Example:
+ spi-hid-dev0 {
+ compatible = "hid-over-spi";
+ reg = <0>;
+ interrupts-extended = <&tlmm 42 IRQ_TYPE_EDGE_FALLING>;
+ vdd-supply = <&pm8350c_l3>;
+ input-report-header-address = <0x1000>;
+ input-report-body-address = <0x1004>;
+ output-report-address = <0x2000>;
+ read-opcode = <0x0b>;
+ write-opcode = <0x02>;
+ flags = <0x00>;
+ reset_gpio-gpios = <&tlmm 25 GPIO_ACTIVE_LOW>;
+ post-power-on-delay-ms = <5>;
+ minimal-reset-delay-ms = <5>;
+
+ };
--
2.25.1
next prev parent reply other threads:[~2022-01-15 2:31 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-15 2:31 [PATCH v3 0/5] Add spi-hid, transport for HID over SPI bus Dmitry Antipov
2022-01-15 2:31 ` [PATCH v3 1/5] HID: Add BUS_SPI support when printing out device info in hid_connect() Dmitry Antipov
2022-01-15 2:31 ` [PATCH v3 2/5] HID: define HID_SPI_DEVICE macro in hid.h Dmitry Antipov
2022-01-15 2:31 ` Dmitry Antipov [this message]
2022-01-20 20:06 ` [PATCH v3 3/5] Documentation: DT bindings for HID over SPI Rob Herring
2022-02-25 1:34 ` [EXTERNAL] " Dmitry Antipov
2022-01-24 10:32 ` Felipe Balbi
2022-01-15 2:31 ` [PATCH v3 4/5] Documentation: Correction in HID output_report callback description Dmitry Antipov
2022-01-15 2:31 ` [PATCH v3 5/5] HID: add spi-hid, transport driver for HID over SPI bus Dmitry Antipov
2022-01-15 4:32 ` Dmitry Torokhov
2022-02-25 1:20 ` [EXTERNAL] " Dmitry Antipov
2022-01-15 6:10 ` kernel test robot
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220115023135.234667-4-dmanti@microsoft.com \
--to=daantipov@gmail.com \
--cc=balbi@kernel.org \
--cc=benjamin.tissoires@redhat.com \
--cc=broonie@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=dmanti@microsoft.com \
--cc=dmitry.torokhov@gmail.com \
--cc=jikos@kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-spi@vger.kernel.org \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox