* dt-bindings: ps2-gpio: convert binding to json-schema
@ 2022-02-15 16:51 Danilo Krummrich
2022-02-15 16:51 ` [PATCH 1/2] " Danilo Krummrich
` (2 more replies)
0 siblings, 3 replies; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-15 16:51 UTC (permalink / raw)
To: krzysztof.kozlowski, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij
Changes since v1
================
- binding as separate patch (driver patch will be sent outside the scope of
this patch series)
- fixes requested by Krzysztof
- fix warnings/errors reported by 'make dt_binding_check'
This series converts the ps2-gpio dt-binding to the json-schema.
Additionally, it documents to flag the given gpios as open drain, since the
PS/2 bus is open drain by definition.
Danilo Krummrich (2):
dt-bindings: ps2-gpio: convert binding to json-schema
dt-bindings: ps2-gpio: document bus signals open drain
Documentation/devicetree/bindings/serio/ps2-gpio.txt | 23 -----------------------
Documentation/devicetree/bindings/serio/ps2-gpio.yaml | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 64 insertions(+), 23 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-15 16:51 dt-bindings: ps2-gpio: convert binding to json-schema Danilo Krummrich
@ 2022-02-15 16:51 ` Danilo Krummrich
2022-02-15 16:59 ` Krzysztof Kozlowski
2022-02-15 16:51 ` [PATCH 2/2] dt-bindings: ps2-gpio: document bus signals open drain Danilo Krummrich
2022-02-15 17:01 ` dt-bindings: ps2-gpio: convert binding to json-schema Krzysztof Kozlowski
2 siblings, 1 reply; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-15 16:51 UTC (permalink / raw)
To: krzysztof.kozlowski, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij, Danilo Krummrich
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
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-15 16:51 ` [PATCH 1/2] " Danilo Krummrich
@ 2022-02-15 16:59 ` Krzysztof Kozlowski
2022-02-15 17:53 ` Danilo Krummrich
0 siblings, 1 reply; 12+ messages in thread
From: Krzysztof Kozlowski @ 2022-02-15 16:59 UTC (permalink / raw)
To: Danilo Krummrich, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij
On 15/02/2022 17:51, Danilo Krummrich wrote:
> 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
>
Please version your patches in the subject. You can achieve it manually
or with `git format-patch -v2`. I think lack of v2 confuses b4 diff
("ERROR: Could not auto-find previous revision
").
> 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
> +
I missed this part (lack of) in your v1. This has to be false.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-15 16:59 ` Krzysztof Kozlowski
@ 2022-02-15 17:53 ` Danilo Krummrich
0 siblings, 0 replies; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-15 17:53 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: dmitry.torokhov, robh+dt, devicetree, linux-input, linux-kernel,
linus.walleij
On Tue, Feb 15, 2022 at 05:59:36PM +0100, Krzysztof Kozlowski wrote:
> On 15/02/2022 17:51, Danilo Krummrich wrote:
> > 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
> >
>
> Please version your patches in the subject. You can achieve it manually
> or with `git format-patch -v2`. I think lack of v2 confuses b4 diff
> ("ERROR: Could not auto-find previous revision
> ").
Yes, I accidentally missed the `-v2` parameter.
>
> > +
> > +additionalProperties: true
> > +
>
> I missed this part (lack of) in your v1. This has to be false.
I'll send a v3.
>
> Best regards,
> Krzysztof
Thanks.
- Danilo
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 2/2] dt-bindings: ps2-gpio: document bus signals open drain
2022-02-15 16:51 dt-bindings: ps2-gpio: convert binding to json-schema Danilo Krummrich
2022-02-15 16:51 ` [PATCH 1/2] " Danilo Krummrich
@ 2022-02-15 16:51 ` 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
2 siblings, 1 reply; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-15 16:51 UTC (permalink / raw)
To: krzysztof.kozlowski, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij, Danilo Krummrich
The PS/2 bus defines data and clock line to be open drain, this should
be reflected in the gpio flags set in the binding.
Especially, this is important since the clock line sometimes is driven
by the host while being used as interrupt source.
Signed-off-by: Danilo Krummrich <danilokrummrich@dk-develop.de>
---
.../devicetree/bindings/serio/ps2-gpio.yaml | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/Documentation/devicetree/bindings/serio/ps2-gpio.yaml b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
index 41e43d797651..42dbfe5523fd 100644
--- a/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
+++ b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
@@ -15,12 +15,18 @@ properties:
data-gpios:
description:
- the gpio used for the data signal
+ the gpio used for the data signal - this should be flagged as
+ active high using open drain with (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)
+ from <dt-bindings/gpio/gpio.h> since the signal is open drain by
+ definition
maxItems: 1
clk-gpios:
description:
- the gpio used for the clock signal
+ the gpio used for the clock signal - this should be flagged as
+ active high using open drain with (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)
+ from <dt-bindings/gpio/gpio.h> since the signal is open drain by
+ definition
maxItems: 1
interrupts:
@@ -52,7 +58,7 @@ examples:
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>;
+ data-gpios = <&gpio 24 (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)>;
+ clk-gpios = <&gpio 23 (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)>;
write-enable;
};
--
2.35.1
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH 2/2] dt-bindings: ps2-gpio: document bus signals open drain
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
0 siblings, 0 replies; 12+ messages in thread
From: Krzysztof Kozlowski @ 2022-02-15 17:01 UTC (permalink / raw)
To: Danilo Krummrich, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij
On 15/02/2022 17:51, Danilo Krummrich wrote:
> The PS/2 bus defines data and clock line to be open drain, this should
> be reflected in the gpio flags set in the binding.
>
> Especially, this is important since the clock line sometimes is driven
> by the host while being used as interrupt source.
>
> Signed-off-by: Danilo Krummrich <danilokrummrich@dk-develop.de>
> ---
> .../devicetree/bindings/serio/ps2-gpio.yaml | 14 ++++++++++----
> 1 file changed, 10 insertions(+), 4 deletions(-)
>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-15 16:51 dt-bindings: ps2-gpio: convert binding to json-schema Danilo Krummrich
2022-02-15 16:51 ` [PATCH 1/2] " 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:46 ` Danilo Krummrich
2 siblings, 1 reply; 12+ messages in thread
From: Krzysztof Kozlowski @ 2022-02-15 17:01 UTC (permalink / raw)
To: Danilo Krummrich, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij
On 15/02/2022 17:51, Danilo Krummrich wrote:
> Changes since v1
> ================
> - binding as separate patch (driver patch will be sent outside the scope of
> this patch series)
Bindings patches are not a separate series, but a separate patches
within the series, so driver should be posted here as well.
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-15 17:01 ` dt-bindings: ps2-gpio: convert binding to json-schema Krzysztof Kozlowski
@ 2022-02-15 17:46 ` Danilo Krummrich
0 siblings, 0 replies; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-15 17:46 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: dmitry.torokhov, robh+dt, devicetree, linux-input, linux-kernel,
linus.walleij
Hi Krzysztof,
On Tue, Feb 15, 2022 at 06:01:19PM +0100, Krzysztof Kozlowski wrote:
> On 15/02/2022 17:51, Danilo Krummrich wrote:
> > Changes since v1
> > ================
> > - binding as separate patch (driver patch will be sent outside the scope of
> > this patch series)
>
> Bindings patches are not a separate series, but a separate patches
> within the series, so driver should be posted here as well.
The changes are not dependent, as if a new property would have been added,
which is why I removed it from the series. However, they're at least related.
So if it's preferred, I'll add it to the series again.
>
> Best regards,
> Krzysztof
- Danilo
^ permalink raw reply [flat|nested] 12+ messages in thread
* dt-bindings: ps2-gpio: convert binding to json-schema
@ 2022-02-11 23:31 Danilo Krummrich
2022-02-11 23:31 ` [PATCH 1/2] " Danilo Krummrich
0 siblings, 1 reply; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-11 23:31 UTC (permalink / raw)
To: dmitry.torokhov, robh+dt, devicetree, linux-input, linux-kernel
Cc: linus.walleij
This series converts the ps2-gpio dt-binding to the json-schema.
Additionally, it documents (in the dt-binding) and enforces to flag the
given gpios as open drain, since the PS/2 bus is open drain by
definition.
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-11 23:31 Danilo Krummrich
@ 2022-02-11 23:31 ` Danilo Krummrich
2022-02-14 21:49 ` Krzysztof Kozlowski
2022-02-15 15:22 ` Rob Herring
0 siblings, 2 replies; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-11 23:31 UTC (permalink / raw)
To: dmitry.torokhov, robh+dt, devicetree, linux-input, linux-kernel
Cc: linus.walleij, Danilo Krummrich
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 | 52 +++++++++++++++++++
2 files changed, 52 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..ec6fa7b40851
--- /dev/null
+++ b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
@@ -0,0 +1,52 @@
+# 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:
+ items:
+ - 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:
+ 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:
+ - data-gpios
+ - clk-gpios
+ - interrupts
+
+examples:
+ - |
+ 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;
+ };
--
2.34.1
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
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
1 sibling, 1 reply; 12+ messages in thread
From: Krzysztof Kozlowski @ 2022-02-14 21:49 UTC (permalink / raw)
To: Danilo Krummrich, dmitry.torokhov, robh+dt, devicetree,
linux-input, linux-kernel
Cc: linus.walleij
On 12/02/2022 00:31, Danilo Krummrich wrote:
> 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 | 52 +++++++++++++++++++
> 2 files changed, 52 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..ec6fa7b40851
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
> @@ -0,0 +1,52 @@
> +# 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:
> + items:
Hi,
I think you do not expect more compatibles, so skip "items".
> + - 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:
This does not look like a standard property. You need "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:
Also: compatible
> + - data-gpios
> + - clk-gpios
> + - interrupts
> +
> +examples:
> + - |
> + ps2@0 {
Does it compile cleanly? You used an unit-address but there is no reg.
> + 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;
> + };
Best regards,
Krzysztof
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-14 21:49 ` Krzysztof Kozlowski
@ 2022-02-14 22:53 ` Danilo Krummrich
0 siblings, 0 replies; 12+ messages in thread
From: Danilo Krummrich @ 2022-02-14 22:53 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: dmitry.torokhov, robh+dt, devicetree, linux-input, linux-kernel,
linus.walleij
On Mon, Feb 14, 2022 at 10:49:27PM +0100, Krzysztof Kozlowski wrote:
> On 12/02/2022 00:31, Danilo Krummrich wrote:
> > 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 | 52 +++++++++++++++++++
> > 2 files changed, 52 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..ec6fa7b40851
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/serio/ps2-gpio.yaml
> > @@ -0,0 +1,52 @@
> > +# 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:
> > + items:
>
> Hi,
>
> I think you do not expect more compatibles, so skip "items".
>
> > + - 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:
>
> This does not look like a standard property. You need "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:
>
> Also: compatible
>
> > + - data-gpios
> > + - clk-gpios
> > + - interrupts
> > +
> > +examples:
> > + - |
> > + ps2@0 {
>
> Does it compile cleanly? You used an unit-address but there is no reg.
Yes, it does. I will fix those up and send a v2.
>
> > + 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;
> > + };
>
>
> Best regards,
> Krzysztof
- Danilo
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] dt-bindings: ps2-gpio: convert binding to json-schema
2022-02-11 23:31 ` [PATCH 1/2] " Danilo Krummrich
2022-02-14 21:49 ` Krzysztof Kozlowski
@ 2022-02-15 15:22 ` Rob Herring
1 sibling, 0 replies; 12+ messages in thread
From: Rob Herring @ 2022-02-15 15:22 UTC (permalink / raw)
To: Danilo Krummrich
Cc: linux-input, linus.walleij, linux-kernel, devicetree,
dmitry.torokhov, robh+dt
On Sat, 12 Feb 2022 00:31:36 +0100, Danilo Krummrich wrote:
> 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 | 52 +++++++++++++++++++
> 2 files changed, 52 insertions(+), 23 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
> create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/serio/ps2-gpio.yaml: 'additionalProperties' is a required property
hint: A schema without a "$ref" to another schema must define all properties and use "additionalProperties"
from schema $id: http://devicetree.org/meta-schemas/base.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/serio/ps2-gpio.yaml: ignoring, error in schema:
Error: Documentation/devicetree/bindings/serio/ps2-gpio.example.dts:22.30-31 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:378: Documentation/devicetree/bindings/serio/ps2-gpio.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1398: dt_binding_check] Error 2
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/1591901
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2022-02-15 17:53 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-02-15 16:51 dt-bindings: ps2-gpio: convert binding to json-schema Danilo Krummrich
2022-02-15 16:51 ` [PATCH 1/2] " Danilo Krummrich
2022-02-15 16:59 ` 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
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).