From: Danilo Krummrich <danilokrummrich@dk-develop.de>
To: krzysztof.kozlowski@canonical.com, dmitry.torokhov@gmail.com,
robh+dt@kernel.org, devicetree@vger.kernel.org,
linux-input@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: linus.walleij@linaro.org,
Danilo Krummrich <danilokrummrich@dk-develop.de>
Subject: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
Date: Tue, 15 Feb 2022 17:51:12 +0100 [thread overview]
Message-ID: <20220215165113.52659-2-danilokrummrich@dk-develop.de> (raw)
In-Reply-To: <20220215165113.52659-1-danilokrummrich@dk-develop.de>
Convert the ps2-gpio dt-binding documentation to DT schema format using
the json-schema.
Signed-off-by: Danilo Krummrich <danilokrummrich@dk-develop.de>
---
.../devicetree/bindings/serio/ps2-gpio.txt | 23 --------
.../devicetree/bindings/serio/ps2-gpio.yaml | 58 +++++++++++++++++++
2 files changed, 58 insertions(+), 23 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml
diff --git a/Documentation/devicetree/bindings/serio/ps2-gpio.txt b/Documentation/devicetree/bindings/serio/ps2-gpio.txt
deleted file mode 100644
index 7b7bc9cdf986..000000000000
--- a/Documentation/devicetree/bindings/serio/ps2-gpio.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-Device-Tree binding for ps/2 gpio device
-
-Required properties:
- - compatible = "ps2-gpio"
- - data-gpios: the data pin
- - clk-gpios: the clock pin
- - interrupts: Should trigger on the falling edge of the clock line.
-
-Optional properties:
- - write-enable: Indicates whether write function is provided
- to serio device. Possibly providing the write fn will not work, because
- of the tough timing requirements.
-
-Example nodes:
-
-ps2@0 {
- compatible = "ps2-gpio";
- interrupt-parent = <&gpio>;
- interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
- data-gpios = <&gpio 24 GPIO_ACTIVE_HIGH>;
- clk-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
- write-enable;
-};
diff --git a/Documentation/devicetree/bindings/serio/ps2-gpio.yaml b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
new file mode 100644
index 000000000000..41e43d797651
--- /dev/null
+++ b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/serio/ps2-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bindings for GPIO based PS/2
+
+maintainers:
+ - Danilo Krummrich <danilokrummrich@dk-develop.de>
+
+properties:
+ compatible:
+ const: ps2-gpio
+
+ data-gpios:
+ description:
+ the gpio used for the data signal
+ maxItems: 1
+
+ clk-gpios:
+ description:
+ the gpio used for the clock signal
+ maxItems: 1
+
+ interrupts:
+ description:
+ The given interrupt should trigger on the falling edge of the clock line.
+ maxItems: 1
+
+ write-enable:
+ type: boolean
+ description:
+ Indicates whether write function is provided to serio device. Possibly
+ providing the write function will not work, because of the tough timing
+ requirements.
+
+required:
+ - compatible
+ - data-gpios
+ - clk-gpios
+ - interrupts
+
+additionalProperties: true
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ ps2 {
+ compatible = "ps2-gpio";
+ interrupt-parent = <&gpio>;
+ interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
+ data-gpios = <&gpio 24 GPIO_ACTIVE_HIGH>;
+ clk-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
+ write-enable;
+ };
--
2.35.1
next prev parent reply other threads:[~2022-02-15 16:51 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-15 16:51 dt-bindings: ps2-gpio: convert binding to json-schema Danilo Krummrich
2022-02-15 16:51 ` Danilo Krummrich [this message]
2022-02-15 16:59 ` [PATCH 1/2] " Krzysztof Kozlowski
2022-02-15 17:53 ` Danilo Krummrich
2022-02-15 16:51 ` [PATCH 2/2] dt-bindings: ps2-gpio: document bus signals open drain Danilo Krummrich
2022-02-15 17:01 ` Krzysztof Kozlowski
2022-02-15 17:01 ` dt-bindings: ps2-gpio: convert binding to json-schema Krzysztof Kozlowski
2022-02-15 17:46 ` Danilo Krummrich
-- strict thread matches above, loose matches on Subject: below --
2022-02-11 23:31 Danilo Krummrich
2022-02-11 23:31 ` [PATCH 1/2] " Danilo Krummrich
2022-02-14 21:49 ` Krzysztof Kozlowski
2022-02-14 22:53 ` Danilo Krummrich
2022-02-15 15:22 ` Rob Herring
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=20220215165113.52659-2-danilokrummrich@dk-develop.de \
--to=danilokrummrich@dk-develop.de \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.torokhov@gmail.com \
--cc=krzysztof.kozlowski@canonical.com \
--cc=linus.walleij@linaro.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@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;
as well as URLs for NNTP newsgroup(s).