diff mbox series

[v2,1/2] dt-bindings: i2c: sun6i-p2wi: Add YAML schemas

Message ID 20190605122936.11972-1-maxime.ripard@bootlin.com
State Superseded
Headers show
Series [v2,1/2] dt-bindings: i2c: sun6i-p2wi: Add YAML schemas | expand

Commit Message

Maxime Ripard June 5, 2019, 12:29 p.m. UTC
Switch the DT binding to a YAML schema to enable the DT validation.

Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
---
 .../i2c/allwinner,sun6i-a31-p2wi.yaml         | 71 +++++++++++++++++++
 .../bindings/i2c/i2c-sun6i-p2wi.txt           | 41 -----------
 2 files changed, 71 insertions(+), 41 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
 delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-sun6i-p2wi.txt

Comments

Rob Herring June 10, 2019, 9:34 p.m. UTC | #1
On Wed, Jun 5, 2019 at 6:29 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
>
> Switch the DT binding to a YAML schema to enable the DT validation.
>
> Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
> ---
>  .../i2c/allwinner,sun6i-a31-p2wi.yaml         | 71 +++++++++++++++++++
>  .../bindings/i2c/i2c-sun6i-p2wi.txt           | 41 -----------
>  2 files changed, 71 insertions(+), 41 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
>  delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-sun6i-p2wi.txt
>
> diff --git a/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml b/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
> new file mode 100644
> index 000000000000..780a33080140
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
> @@ -0,0 +1,71 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/i2c/allwinner,sun6i-a31-p2wi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Allwinner A31 P2WI (Push/Pull 2 Wires Interface) Device Tree Bindings
> +
> +maintainers:
> +  - Chen-Yu Tsai <wens@csie.org>
> +  - Maxime Ripard <maxime.ripard@bootlin.com>
> +
> +allOf:
> +  - $ref: /schemas/i2c/i2c-controller.yaml#
> +
> +properties:
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0

These 2 are covered by i2c-controller.yaml, right?

> +
> +  compatible:
> +    const: allwinner,sun6i-a31-p2wi
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +  clock-frequency:
> +    minimum: 1
> +    maximum: 6000000
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - resets
> +
> +# FIXME: We should set it, but it would report all the generic
> +# properties as additional properties.
> +# additionalProperties: false
> +
> +examples:
> +  - |
> +    p2wi@1f03400 {

i2c@...

That should fail on the schema (I need to get the schema checking of
examples finished.)

> +      compatible = "allwinner,sun6i-a31-p2wi";
> +      reg = <0x01f03400 0x400>;
> +      interrupts = <0 39 4>;
> +      clocks = <&apb0_gates 3>;
> +      clock-frequency = <6000000>;
> +      resets = <&apb0_rst 3>;
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      axp221: pmic@68 {
> +        compatible = "x-powers,axp221";
> +        reg = <0x68>;
> +      };
> +    };
> +
> +...
Maxime Ripard June 11, 2019, 9:06 a.m. UTC | #2
Hi Rob,

On Mon, Jun 10, 2019 at 03:34:18PM -0600, Rob Herring wrote:
> On Wed, Jun 5, 2019 at 6:29 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
> > +properties:
> > +  "#address-cells":
> > +    const: 1
> > +
> > +  "#size-cells":
> > +    const: 0
>
> These 2 are covered by i2c-controller.yaml, right?

Indeed, I've removed them.

> > +examples:
> > +  - |
> > +    p2wi@1f03400 {
>
> i2c@...
>
> That should fail on the schema (I need to get the schema checking of
> examples finished.)

That would be great :) The compilation of the examples alone already
caught a good number of examples that weren't even compiling.

Speaking of examples, one thing that would be great too would be to
allow the usage of our C headers. It's not supported at the moment,
and this often ends up with an example that is less readable than the
actual DT.

Maxime

--
Maxime Ripard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
Rob Herring June 11, 2019, 2:50 p.m. UTC | #3
On Tue, Jun 11, 2019 at 3:06 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
>
> Hi Rob,
>
> On Mon, Jun 10, 2019 at 03:34:18PM -0600, Rob Herring wrote:
> > On Wed, Jun 5, 2019 at 6:29 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
> > > +properties:
> > > +  "#address-cells":
> > > +    const: 1
> > > +
> > > +  "#size-cells":
> > > +    const: 0
> >
> > These 2 are covered by i2c-controller.yaml, right?
>
> Indeed, I've removed them.
>
> > > +examples:
> > > +  - |
> > > +    p2wi@1f03400 {
> >
> > i2c@...
> >
> > That should fail on the schema (I need to get the schema checking of
> > examples finished.)
>
> That would be great :) The compilation of the examples alone already
> caught a good number of examples that weren't even compiling.

I'm primarily waiting on a dtc change to be accepted[1]. Feel free to
review/ack.

> Speaking of examples, one thing that would be great too would be to
> allow the usage of our C headers. It's not supported at the moment,
> and this often ends up with an example that is less readable than the
> actual DT.

It should be. You just have to add them. See
Documentation/devicetree/bindings/timer/intel,ixp4xx-timer.yaml for
example.

Maybe the common interrupt and gpio ones should be added by default.

Rob

[1] https://www.spinics.net/lists/devicetree-compiler/msg02709.html
Maxime Ripard June 12, 2019, 3:38 p.m. UTC | #4
Hi,

On Tue, Jun 11, 2019 at 08:50:37AM -0600, Rob Herring wrote:
> On Tue, Jun 11, 2019 at 3:06 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
> >
> > Hi Rob,
> >
> > On Mon, Jun 10, 2019 at 03:34:18PM -0600, Rob Herring wrote:
> > > On Wed, Jun 5, 2019 at 6:29 AM Maxime Ripard <maxime.ripard@bootlin.com> wrote:
> > > > +properties:
> > > > +  "#address-cells":
> > > > +    const: 1
> > > > +
> > > > +  "#size-cells":
> > > > +    const: 0
> > >
> > > These 2 are covered by i2c-controller.yaml, right?
> >
> > Indeed, I've removed them.
> >
> > > > +examples:
> > > > +  - |
> > > > +    p2wi@1f03400 {
> > >
> > > i2c@...
> > >
> > > That should fail on the schema (I need to get the schema checking of
> > > examples finished.)
> >
> > That would be great :) The compilation of the examples alone already
> > caught a good number of examples that weren't even compiling.
>
> I'm primarily waiting on a dtc change to be accepted[1]. Feel free to
> review/ack.

I guess it's too late now :)

> > Speaking of examples, one thing that would be great too would be to
> > allow the usage of our C headers. It's not supported at the moment,
> > and this often ends up with an example that is less readable than the
> > actual DT.
>
> It should be. You just have to add them. See
> Documentation/devicetree/bindings/timer/intel,ixp4xx-timer.yaml for
> example.

Hmmm, I'm pretty sure I tried this before. I'll try again.

> Maybe the common interrupt and gpio ones should be added by default.

I guess so, yeah. The GIC too is pretty common

Maxime

--
Maxime Ripard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml b/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
new file mode 100644
index 000000000000..780a33080140
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/allwinner,sun6i-a31-p2wi.yaml
@@ -0,0 +1,71 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/allwinner,sun6i-a31-p2wi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Allwinner A31 P2WI (Push/Pull 2 Wires Interface) Device Tree Bindings
+
+maintainers:
+  - Chen-Yu Tsai <wens@csie.org>
+  - Maxime Ripard <maxime.ripard@bootlin.com>
+
+allOf:
+  - $ref: /schemas/i2c/i2c-controller.yaml#
+
+properties:
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+  compatible:
+    const: allwinner,sun6i-a31-p2wi
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  clock-frequency:
+    minimum: 1
+    maximum: 6000000
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - resets
+
+# FIXME: We should set it, but it would report all the generic
+# properties as additional properties.
+# additionalProperties: false
+
+examples:
+  - |
+    p2wi@1f03400 {
+      compatible = "allwinner,sun6i-a31-p2wi";
+      reg = <0x01f03400 0x400>;
+      interrupts = <0 39 4>;
+      clocks = <&apb0_gates 3>;
+      clock-frequency = <6000000>;
+      resets = <&apb0_rst 3>;
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      axp221: pmic@68 {
+        compatible = "x-powers,axp221";
+        reg = <0x68>;
+      };
+    };
+
+...
diff --git a/Documentation/devicetree/bindings/i2c/i2c-sun6i-p2wi.txt b/Documentation/devicetree/bindings/i2c/i2c-sun6i-p2wi.txt
deleted file mode 100644
index 49df0053347a..000000000000
--- a/Documentation/devicetree/bindings/i2c/i2c-sun6i-p2wi.txt
+++ /dev/null
@@ -1,41 +0,0 @@ 
-
-* Allwinner P2WI (Push/Pull 2 Wire Interface) controller
-
-Required properties :
-
- - reg             : Offset and length of the register set for the device.
- - compatible      : Should one of the following:
-                     - "allwinner,sun6i-a31-p2wi"
- - interrupts      : The interrupt line connected to the P2WI peripheral.
- - clocks          : The gate clk connected to the P2WI peripheral.
- - resets          : The reset line connected to the P2WI peripheral.
-
-Optional properties :
-
- - clock-frequency : Desired P2WI bus clock frequency in Hz. If not set the
-default frequency is 100kHz
-
-A P2WI may contain one child node encoding a P2WI slave device.
-
-Slave device properties:
-  Required properties:
-   - reg           : the I2C slave address used during the initialization
-                     process to switch from I2C to P2WI mode
-
-Example:
-
-	p2wi@1f03400 {
-		compatible = "allwinner,sun6i-a31-p2wi";
-		reg = <0x01f03400 0x400>;
-		interrupts = <0 39 4>;
-		clocks = <&apb0_gates 3>;
-		clock-frequency = <6000000>;
-		resets = <&apb0_rst 3>;
-
-		axp221: pmic@68 {
-			compatible = "x-powers,axp221";
-			reg = <0x68>;
-
-			/* ... */
-		};
-	};