Re: [PATCH 2/2] dt-bindings: i2c: mv64xxx: Add YAML schemas

[Gregory CLEMENT <gregory.clement@bootlin.com>]

Hi,

> Switch the DT binding to a YAML schema to enable the DT validation.
>
> Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
> ---
>  .../devicetree/bindings/i2c/i2c-mv64xxx.txt   |  64 -----------
>  .../bindings/i2c/marvell,mv64xxx-i2c.yaml     | 106 ++++++++++++++++++
>  2 files changed, 106 insertions(+), 64 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt
>  create mode 100644 Documentation/devicetree/bindings/i2c/marvell,mv64xxx-i2c.yaml
>
> diff --git a/Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt b/Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt
> deleted file mode 100644
> index 0ffe65a316ae..000000000000
> --- a/Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt
> +++ /dev/null
> @@ -1,64 +0,0 @@
> -
> -* Marvell MV64XXX I2C controller
> -
> -Required properties :
> -
> - - reg             : Offset and length of the register set for the device
> - - compatible      : Should be either:
> -                     - "allwinner,sun4i-a10-i2c"
> -                     - "allwinner,sun6i-a31-i2c"
> -                     - "marvell,mv64xxx-i2c"
> -                     - "marvell,mv78230-i2c"
> -                     - "marvell,mv78230-a0-i2c"
> -                       * Note: Only use "marvell,mv78230-a0-i2c" for a
> -                         very rare, initial version of the SoC which
> -                         had broken offload support.  Linux
> -                         auto-detects this and sets it appropriately.
> - - interrupts      : The interrupt number
> -
> -Optional properties :
> -
> - - clock-frequency : Desired I2C bus clock frequency in Hz. If not set the
> -default frequency is 100kHz
> -
> - - resets          : phandle to the parent reset controller. Mandatory
> -                     whenever you're using the "allwinner,sun6i-a31-i2c"
> -                     compatible.
> -
> - - clocks:	   : pointers to the reference clocks for this device, the
> -		     first one is the one used for the clock on the i2c bus,
> -		     the second one is the clock used to acces the registers
> -		     of the controller
> -
> - - clock-names	   : names of used clocks, mandatory if the second clock is
> -		     used, the name must be "core", and "reg" (the latter is
> -		     only for Armada 7K/8K).
> -
> -Examples:
> -
> -	i2c@11000 {
> -		compatible = "marvell,mv64xxx-i2c";
> -		reg = <0x11000 0x20>;
> -		interrupts = <29>;
> -		clock-frequency = <100000>;
> -	};
> -
> -For the Armada XP:
> -
> -	i2c@11000 {
> -		compatible = "marvell,mv78230-i2c", "marvell,mv64xxx-i2c";
> -		reg = <0x11000 0x100>;
> -		interrupts = <29>;
> -		clock-frequency = <100000>;
> -	};
> -
> -For the Armada 7040:
> -
> -	i2c@701000 {
> -		compatible = "marvell,mv78230-i2c";
> -		reg = <0x701000 0x20>;
> -		interrupts = <29>;
> -		clock-frequency = <100000>;
> -		clock-names = "core", "reg";
> -		clocks = <&core_clock>, <&reg_clock>;
> -	};
> diff --git a/Documentation/devicetree/bindings/i2c/marvell,mv64xxx-i2c.yaml b/Documentation/devicetree/bindings/i2c/marvell,mv64xxx-i2c.yaml
> new file mode 100644
> index 000000000000..984c01dccc37
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/i2c/marvell,mv64xxx-i2c.yaml
> @@ -0,0 +1,106 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/i2c/marvell,mv64xxx-i2c.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell MV64XXX I2C Controller Device Tree Bindings
> +
> +maintainers:
> +  - Chen-Yu Tsai <wens@csie.org>
> +  - Maxime Ripard <maxime.ripard@bootlin.com>

If you take over the maintenanceship and became maintainer for this
driver, then update the MAINTAINERS files too. For now it was assigned
to me, but I don't mind letting this for both of you.

Actually I gave my acked-by to a patch from Wolfram adding the
Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt file to the "I2C
MV64XXX MARVELL AND ALLWINNER DRIVER" entry "MAINTAINERS: add DT
bindings to i2c-mv64xxx" so I guess this patch have to be discarded or
at least updated.

Gregory

> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: allwinner,sun4i-a10-i2c
> +      - items:
> +          - const: allwinner,sun7i-a20-i2c
> +          - const: allwinner,sun4i-a10-i2c
> +      - const: allwinner,sun6i-a31-i2c
> +      - items:
> +          - const: allwinner,sun8i-a23-i2c
> +          - const: allwinner,sun6i-a31-i2c
> +      - items:
> +          - const: allwinner,sun8i-a83t-i2c
> +          - const: allwinner,sun6i-a31-i2c
> +      - items:
> +          - const: allwinner,sun50i-a64-i2c
> +          - const: allwinner,sun6i-a31-i2c
> +
> +      - const: marvell,mv64xxx-i2c
> +      - const: marvell,mv78230-i2c
> +      - const: marvell,mv78230-a0-i2c
> +
> +    description:
> +      Only use "marvell,mv78230-a0-i2c" for a very rare, initial
> +      version of the SoC which had broken offload support. Linux
> +      auto-detects this and sets it appropriately.
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    minItems: 1
> +    maxItems: 2
> +    items:
> +      - description: Reference clock for the I2C bus
> +      - description: Bus clock (Only for Armada 7K/8K)
> +
> +  clock-names:
> +    minItems: 1
> +    maxItems: 2
> +    items:
> +      - const: core
> +      - const: reg
> +    description:
> +      Mandatory if two clocks are used (only for Armada 7k and 8k).
> +
> +  resets:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +allOf:
> +  - $ref: /schemas/i2c/i2c-controller.yaml#
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - allwinner,sun4i-a10-i2c
> +              - allwinner,sun6i-a31-i2c
> +
> +    then:
> +      required:
> +        - clocks
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            const: allwinner,sun6i-a31-i2c
> +
> +    then:
> +      required:
> +        - resets
> +
> +# FIXME: We should set it, but it would report all the generic
> +# properties as additional properties.
> +# additionalProperties: false
> +
> +examples:
> +  - |
> +    timer {
> +      compatible = "allwinner,sun4i-a10-timer";
> +      reg = <0x01c20c00 0x400>;
> +      interrupts = <22>;
> +      clocks = <&osc>;
> +    };
> +...
> -- 
> 2.21.0
>

-- 
Gregory Clement, Bootlin
Embedded Linux and Kernel engineering
http://bootlin.com