| Message ID | 561c35648e22a3c1e3b5477ae27fd1a50da7fe98.1620323639.git.geert+renesas@glider.be (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Geert Uytterhoeven |
| Headers | show |
| Series | dt-bindings: can: renesas: Convert to json-schema | expand |
> On 05/06/2021 7:55 PM Geert Uytterhoeven <geert+renesas@glider.be> wrote: > > > Convert the Renesas R-Car CAN Controller Device Tree binding > documentation to json-schema. > > Document missing properties. > Update the example to match reality. > > Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> > --- > I have listed Sergei as the maintainer, as he wrote the original driver > and bindings. Sergei: Please scream if this is inappropriate ;-) > --- > .../devicetree/bindings/net/can/rcar_can.txt | 80 ---------- > .../bindings/net/can/renesas,rcar-can.yaml | 139 ++++++++++++++++++ > 2 files changed, 139 insertions(+), 80 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/net/can/rcar_can.txt > create mode 100644 Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml > > diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt > deleted file mode 100644 > index 90ac4fef23f5255c..0000000000000000 > --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt > +++ /dev/null > @@ -1,80 +0,0 @@ > -Renesas R-Car CAN controller Device Tree Bindings > -------------------------------------------------- > - > -Required properties: > -- compatible: "renesas,can-r8a7742" if CAN controller is a part of R8A7742 SoC. > - "renesas,can-r8a7743" if CAN controller is a part of R8A7743 SoC. > - "renesas,can-r8a7744" if CAN controller is a part of R8A7744 SoC. > - "renesas,can-r8a7745" if CAN controller is a part of R8A7745 SoC. > - "renesas,can-r8a77470" if CAN controller is a part of R8A77470 SoC. > - "renesas,can-r8a774a1" if CAN controller is a part of R8A774A1 SoC. > - "renesas,can-r8a774b1" if CAN controller is a part of R8A774B1 SoC. > - "renesas,can-r8a774c0" if CAN controller is a part of R8A774C0 SoC. > - "renesas,can-r8a774e1" if CAN controller is a part of R8A774E1 SoC. > - "renesas,can-r8a7778" if CAN controller is a part of R8A7778 SoC. > - "renesas,can-r8a7779" if CAN controller is a part of R8A7779 SoC. > - "renesas,can-r8a7790" if CAN controller is a part of R8A7790 SoC. > - "renesas,can-r8a7791" if CAN controller is a part of R8A7791 SoC. > - "renesas,can-r8a7792" if CAN controller is a part of R8A7792 SoC. > - "renesas,can-r8a7793" if CAN controller is a part of R8A7793 SoC. > - "renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC. > - "renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC. > - "renesas,can-r8a7796" if CAN controller is a part of R8A77960 SoC. > - "renesas,can-r8a77961" if CAN controller is a part of R8A77961 SoC. > - "renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC. > - "renesas,can-r8a77990" if CAN controller is a part of R8A77990 SoC. > - "renesas,can-r8a77995" if CAN controller is a part of R8A77995 SoC. > - "renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device. > - "renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1 > - compatible device. > - "renesas,rcar-gen3-can" for a generic R-Car Gen3 or RZ/G2 > - compatible device. > - When compatible with the generic version, nodes must list the > - SoC-specific version corresponding to the platform first > - followed by the generic version. > - > -- reg: physical base address and size of the R-Car CAN register map. > -- interrupts: interrupt specifier for the sole interrupt. > -- clocks: phandles and clock specifiers for 3 CAN clock inputs. > -- clock-names: 3 clock input name strings: "clkp1", "clkp2", and "can_clk". > -- pinctrl-0: pin control group to be used for this controller. > -- pinctrl-names: must be "default". > - > -Required properties for R8A774A1, R8A774B1, R8A774C0, R8A774E1, R8A7795, > -R8A77960, R8A77961, R8A77965, R8A77990, and R8A77995: > -For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock and can > -be used by both CAN and CAN FD controller at the same time. It needs to be > -scaled to maximum frequency if any of these controllers use it. This is done > -using the below properties: > - > -- assigned-clocks: phandle of clkp2(CANFD) clock. > -- assigned-clock-rates: maximum frequency of this clock. > - > -Optional properties: > -- renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are: > - <0x0> (default) : Peripheral clock (clkp1) > - <0x1> : Peripheral clock (clkp2) > - <0x3> : External input clock > - > -Example > -------- > - > -SoC common .dtsi file: > - > - can0: can@e6e80000 { > - compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can"; > - reg = <0 0xe6e80000 0 0x1000>; > - interrupts = <0 186 IRQ_TYPE_LEVEL_HIGH>; > - clocks = <&mstp9_clks R8A7791_CLK_RCAN0>, > - <&cpg_clocks R8A7791_CLK_RCAN>, <&can_clk>; > - clock-names = "clkp1", "clkp2", "can_clk"; > - status = "disabled"; > - }; > - > -Board specific .dts file: > - > -&can0 { > - pinctrl-0 = <&can0_pins>; > - pinctrl-names = "default"; > - status = "okay"; > -}; > diff --git a/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml b/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml > new file mode 100644 > index 0000000000000000..fadc871fd6b0eada > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml > @@ -0,0 +1,139 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/net/can/renesas,rcar-can.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Renesas R-Car CAN Controller > + > +maintainers: > + - Sergei Shtylyov <sergei.shtylyov@gmail.com> > + > +properties: > + compatible: > + oneOf: > + - items: > + - enum: > + - renesas,can-r8a7778 # R-Car M1-A > + - renesas,can-r8a7779 # R-Car H1 > + - const: renesas,rcar-gen1-can # R-Car Gen1 > + > + - items: > + - enum: > + - renesas,can-r8a7742 # RZ/G1H > + - renesas,can-r8a7743 # RZ/G1M > + - renesas,can-r8a7744 # RZ/G1N > + - renesas,can-r8a7745 # RZ/G1E > + - renesas,can-r8a77470 # RZ/G1C > + - renesas,can-r8a7790 # R-Car H2 > + - renesas,can-r8a7791 # R-Car M2-W > + - renesas,can-r8a7792 # R-Car V2H > + - renesas,can-r8a7793 # R-Car M2-N > + - renesas,can-r8a7794 # R-Car E2 > + - const: renesas,rcar-gen2-can # R-Car Gen2 and RZ/G1 > + > + - items: > + - enum: > + - renesas,can-r8a774a1 # RZ/G2M > + - renesas,can-r8a774b1 # RZ/G2N > + - renesas,can-r8a774c0 # RZ/G2E > + - renesas,can-r8a774e1 # RZ/G2H > + - renesas,can-r8a7795 # R-Car H3 > + - renesas,can-r8a7796 # R-Car M3-W > + - renesas,can-r8a77961 # R-Car M3-W+ > + - renesas,can-r8a77965 # R-Car M3-N > + - renesas,can-r8a77990 # R-Car E3 > + - renesas,can-r8a77995 # R-Car D3 > + - const: renesas,rcar-gen3-can # R-Car Gen3 and RZ/G2 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + clocks: > + maxItems: 3 > + > + clock-names: > + items: > + - const: clkp1 > + - const: clkp2 > + - const: can_clk > + > + power-domains: > + maxItems: 1 > + > + resets: > + maxItems: 1 > + > + renesas,can-clock-select: > + $ref: /schemas/types.yaml#/definitions/uint32 > + enum: [ 0, 1, 3 ] > + default: 0 > + description: | > + R-Car CAN Clock Source Select. Valid values are: > + <0x0> (default) : Peripheral clock (clkp1) > + <0x1> : Peripheral clock (clkp2) > + <0x3> : External input clock > + > + assigned-clocks: > + description: > + Reference to the clkp2 (CANFD) clock. > + On R-Car Gen3 and RZ/G2 SoCs, "clkp2" is the CANFD clock. This is a div6 > + clock and can be used by both CAN and CAN FD controllers at the same > + time. It needs to be scaled to maximum frequency if any of these > + controllers use it. > + > + assigned-clock-rates: > + description: Maximum frequency of the CANFD clock. > + > +required: > + - compatible > + - reg > + - interrupts > + - clocks > + - clock-names > + - power-domains > + > +allOf: > + - $ref: can-controller.yaml# > + > + - if: > + not: > + properties: > + compatible: > + contains: > + const: renesas,rcar-gen1-can > + then: > + required: > + - resets > + > + - if: > + properties: > + compatible: > + contains: > + const: renesas,rcar-gen3-can > + then: > + required: > + - assigned-clocks > + - assigned-clock-rates > + > +unevaluatedProperties: false > + > +examples: > + - | > + #include <dt-bindings/clock/r8a7791-cpg-mssr.h> > + #include <dt-bindings/interrupt-controller/arm-gic.h> > + #include <dt-bindings/power/r8a7791-sysc.h> > + > + can0: can@e6e80000 { > + compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can"; > + reg = <0xe6e80000 0x1000>; > + interrupts = <GIC_SPI 186 IRQ_TYPE_LEVEL_HIGH>; > + clocks = <&cpg CPG_MOD 916>, > + <&cpg CPG_CORE R8A7791_CLK_RCAN>, <&can_clk>; > + clock-names = "clkp1", "clkp2", "can_clk"; > + power-domains = <&sysc R8A7791_PD_ALWAYS_ON>; > + resets = <&cpg 916>; > + }; > -- > 2.25.1 Reviewed-by: Ulrich Hecht <uli+renesas@fpond.eu> CU Uli
On Thu, 06 May 2021 19:55:53 +0200, Geert Uytterhoeven wrote: > Convert the Renesas R-Car CAN Controller Device Tree binding > documentation to json-schema. > > Document missing properties. > Update the example to match reality. > > Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> > --- > I have listed Sergei as the maintainer, as he wrote the original driver > and bindings. Sergei: Please scream if this is inappropriate ;-) > --- > .../devicetree/bindings/net/can/rcar_can.txt | 80 ---------- > .../bindings/net/can/renesas,rcar-can.yaml | 139 ++++++++++++++++++ > 2 files changed, 139 insertions(+), 80 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/net/can/rcar_can.txt > create mode 100644 Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml > Reviewed-by: Rob Herring <robh@kernel.org>
diff --git a/Documentation/devicetree/bindings/net/can/rcar_can.txt b/Documentation/devicetree/bindings/net/can/rcar_can.txt deleted file mode 100644 index 90ac4fef23f5255c..0000000000000000 --- a/Documentation/devicetree/bindings/net/can/rcar_can.txt +++ /dev/null @@ -1,80 +0,0 @@ -Renesas R-Car CAN controller Device Tree Bindings -------------------------------------------------- - -Required properties: -- compatible: "renesas,can-r8a7742" if CAN controller is a part of R8A7742 SoC. - "renesas,can-r8a7743" if CAN controller is a part of R8A7743 SoC. - "renesas,can-r8a7744" if CAN controller is a part of R8A7744 SoC. - "renesas,can-r8a7745" if CAN controller is a part of R8A7745 SoC. - "renesas,can-r8a77470" if CAN controller is a part of R8A77470 SoC. - "renesas,can-r8a774a1" if CAN controller is a part of R8A774A1 SoC. - "renesas,can-r8a774b1" if CAN controller is a part of R8A774B1 SoC. - "renesas,can-r8a774c0" if CAN controller is a part of R8A774C0 SoC. - "renesas,can-r8a774e1" if CAN controller is a part of R8A774E1 SoC. - "renesas,can-r8a7778" if CAN controller is a part of R8A7778 SoC. - "renesas,can-r8a7779" if CAN controller is a part of R8A7779 SoC. - "renesas,can-r8a7790" if CAN controller is a part of R8A7790 SoC. - "renesas,can-r8a7791" if CAN controller is a part of R8A7791 SoC. - "renesas,can-r8a7792" if CAN controller is a part of R8A7792 SoC. - "renesas,can-r8a7793" if CAN controller is a part of R8A7793 SoC. - "renesas,can-r8a7794" if CAN controller is a part of R8A7794 SoC. - "renesas,can-r8a7795" if CAN controller is a part of R8A7795 SoC. - "renesas,can-r8a7796" if CAN controller is a part of R8A77960 SoC. - "renesas,can-r8a77961" if CAN controller is a part of R8A77961 SoC. - "renesas,can-r8a77965" if CAN controller is a part of R8A77965 SoC. - "renesas,can-r8a77990" if CAN controller is a part of R8A77990 SoC. - "renesas,can-r8a77995" if CAN controller is a part of R8A77995 SoC. - "renesas,rcar-gen1-can" for a generic R-Car Gen1 compatible device. - "renesas,rcar-gen2-can" for a generic R-Car Gen2 or RZ/G1 - compatible device. - "renesas,rcar-gen3-can" for a generic R-Car Gen3 or RZ/G2 - compatible device. - When compatible with the generic version, nodes must list the - SoC-specific version corresponding to the platform first - followed by the generic version. - -- reg: physical base address and size of the R-Car CAN register map. -- interrupts: interrupt specifier for the sole interrupt. -- clocks: phandles and clock specifiers for 3 CAN clock inputs. -- clock-names: 3 clock input name strings: "clkp1", "clkp2", and "can_clk". -- pinctrl-0: pin control group to be used for this controller. -- pinctrl-names: must be "default". - -Required properties for R8A774A1, R8A774B1, R8A774C0, R8A774E1, R8A7795, -R8A77960, R8A77961, R8A77965, R8A77990, and R8A77995: -For the denoted SoCs, "clkp2" can be CANFD clock. This is a div6 clock and can -be used by both CAN and CAN FD controller at the same time. It needs to be -scaled to maximum frequency if any of these controllers use it. This is done -using the below properties: - -- assigned-clocks: phandle of clkp2(CANFD) clock. -- assigned-clock-rates: maximum frequency of this clock. - -Optional properties: -- renesas,can-clock-select: R-Car CAN Clock Source Select. Valid values are: - <0x0> (default) : Peripheral clock (clkp1) - <0x1> : Peripheral clock (clkp2) - <0x3> : External input clock - -Example -------- - -SoC common .dtsi file: - - can0: can@e6e80000 { - compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can"; - reg = <0 0xe6e80000 0 0x1000>; - interrupts = <0 186 IRQ_TYPE_LEVEL_HIGH>; - clocks = <&mstp9_clks R8A7791_CLK_RCAN0>, - <&cpg_clocks R8A7791_CLK_RCAN>, <&can_clk>; - clock-names = "clkp1", "clkp2", "can_clk"; - status = "disabled"; - }; - -Board specific .dts file: - -&can0 { - pinctrl-0 = <&can0_pins>; - pinctrl-names = "default"; - status = "okay"; -}; diff --git a/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml b/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml new file mode 100644 index 0000000000000000..fadc871fd6b0eada --- /dev/null +++ b/Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml @@ -0,0 +1,139 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/can/renesas,rcar-can.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Renesas R-Car CAN Controller + +maintainers: + - Sergei Shtylyov <sergei.shtylyov@gmail.com> + +properties: + compatible: + oneOf: + - items: + - enum: + - renesas,can-r8a7778 # R-Car M1-A + - renesas,can-r8a7779 # R-Car H1 + - const: renesas,rcar-gen1-can # R-Car Gen1 + + - items: + - enum: + - renesas,can-r8a7742 # RZ/G1H + - renesas,can-r8a7743 # RZ/G1M + - renesas,can-r8a7744 # RZ/G1N + - renesas,can-r8a7745 # RZ/G1E + - renesas,can-r8a77470 # RZ/G1C + - renesas,can-r8a7790 # R-Car H2 + - renesas,can-r8a7791 # R-Car M2-W + - renesas,can-r8a7792 # R-Car V2H + - renesas,can-r8a7793 # R-Car M2-N + - renesas,can-r8a7794 # R-Car E2 + - const: renesas,rcar-gen2-can # R-Car Gen2 and RZ/G1 + + - items: + - enum: + - renesas,can-r8a774a1 # RZ/G2M + - renesas,can-r8a774b1 # RZ/G2N + - renesas,can-r8a774c0 # RZ/G2E + - renesas,can-r8a774e1 # RZ/G2H + - renesas,can-r8a7795 # R-Car H3 + - renesas,can-r8a7796 # R-Car M3-W + - renesas,can-r8a77961 # R-Car M3-W+ + - renesas,can-r8a77965 # R-Car M3-N + - renesas,can-r8a77990 # R-Car E3 + - renesas,can-r8a77995 # R-Car D3 + - const: renesas,rcar-gen3-can # R-Car Gen3 and RZ/G2 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 3 + + clock-names: + items: + - const: clkp1 + - const: clkp2 + - const: can_clk + + power-domains: + maxItems: 1 + + resets: + maxItems: 1 + + renesas,can-clock-select: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [ 0, 1, 3 ] + default: 0 + description: | + R-Car CAN Clock Source Select. Valid values are: + <0x0> (default) : Peripheral clock (clkp1) + <0x1> : Peripheral clock (clkp2) + <0x3> : External input clock + + assigned-clocks: + description: + Reference to the clkp2 (CANFD) clock. + On R-Car Gen3 and RZ/G2 SoCs, "clkp2" is the CANFD clock. This is a div6 + clock and can be used by both CAN and CAN FD controllers at the same + time. It needs to be scaled to maximum frequency if any of these + controllers use it. + + assigned-clock-rates: + description: Maximum frequency of the CANFD clock. + +required: + - compatible + - reg + - interrupts + - clocks + - clock-names + - power-domains + +allOf: + - $ref: can-controller.yaml# + + - if: + not: + properties: + compatible: + contains: + const: renesas,rcar-gen1-can + then: + required: + - resets + + - if: + properties: + compatible: + contains: + const: renesas,rcar-gen3-can + then: + required: + - assigned-clocks + - assigned-clock-rates + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/clock/r8a7791-cpg-mssr.h> + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/power/r8a7791-sysc.h> + + can0: can@e6e80000 { + compatible = "renesas,can-r8a7791", "renesas,rcar-gen2-can"; + reg = <0xe6e80000 0x1000>; + interrupts = <GIC_SPI 186 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&cpg CPG_MOD 916>, + <&cpg CPG_CORE R8A7791_CLK_RCAN>, <&can_clk>; + clock-names = "clkp1", "clkp2", "can_clk"; + power-domains = <&sysc R8A7791_PD_ALWAYS_ON>; + resets = <&cpg 916>; + };
Convert the Renesas R-Car CAN Controller Device Tree binding documentation to json-schema. Document missing properties. Update the example to match reality. Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> --- I have listed Sergei as the maintainer, as he wrote the original driver and bindings. Sergei: Please scream if this is inappropriate ;-) --- .../devicetree/bindings/net/can/rcar_can.txt | 80 ---------- .../bindings/net/can/renesas,rcar-can.yaml | 139 ++++++++++++++++++ 2 files changed, 139 insertions(+), 80 deletions(-) delete mode 100644 Documentation/devicetree/bindings/net/can/rcar_can.txt create mode 100644 Documentation/devicetree/bindings/net/can/renesas,rcar-can.yaml