Convert the ps2-gpio dt-binding documentation to DT schema format using
the json-schema.
Signed-off-by: Danilo Krummrich <[email protected]>
---
.../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 <[email protected]>
+
+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
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 <[email protected]>
> ---
> .../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 <[email protected]>
> +
> +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
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 <[email protected]>
> > ---
> > .../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 <[email protected]>
> > +
> > +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
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 <[email protected]>
> ---
> .../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.
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 <[email protected]>
> > ---
> > .../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
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 <[email protected]>
> ---
> .../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 <[email protected]>
> +
> +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