Commit 632ce677 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Wolfram Sang
Browse files

dt-bindings: i2c: renesas,iic: Convert to json-schema 



Convert the Renesas R-Mobile I2C Bus Interface (IIC) Device Tree binding
documentation to json-schema.

Document missing properties.
R-Mobile A1 and SH-Mobile have multiple interrupts.
Update the example to match reality.

Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarWolfram Sang <wsa@kernel.org>
parent 56909511

Documentation/devicetree/bindings/i2c/renesas,iic.txt

deleted100644 → 0
+0 −67
Original line number Diff line number Diff line 
Device tree configuration for Renesas IIC (sh_mobile) driver



Required properties:

- compatible      :

			- "renesas,iic-r8a73a4" (R-Mobile APE6)

			- "renesas,iic-r8a7740" (R-Mobile A1)

			- "renesas,iic-r8a7742" (RZ/G1H)

			- "renesas,iic-r8a7743" (RZ/G1M)

			- "renesas,iic-r8a7744" (RZ/G1N)

			- "renesas,iic-r8a7745" (RZ/G1E)

			- "renesas,iic-r8a774a1" (RZ/G2M)

			- "renesas,iic-r8a774b1" (RZ/G2N)

			- "renesas,iic-r8a774c0" (RZ/G2E)

			- "renesas,iic-r8a774e1" (RZ/G2H)

			- "renesas,iic-r8a7790" (R-Car H2)

			- "renesas,iic-r8a7791" (R-Car M2-W)

			- "renesas,iic-r8a7792" (R-Car V2H)

			- "renesas,iic-r8a7793" (R-Car M2-N)

			- "renesas,iic-r8a7794" (R-Car E2)

			- "renesas,iic-r8a7795" (R-Car H3)

			- "renesas,iic-r8a7796" (R-Car M3-W)

			- "renesas,iic-r8a77961" (R-Car M3-W+)

			- "renesas,iic-r8a77965" (R-Car M3-N)

			- "renesas,iic-r8a77990" (R-Car E3)

			- "renesas,iic-sh73a0" (SH-Mobile AG5)

			- "renesas,rcar-gen2-iic" (generic R-Car Gen2 or RZ/G1

							compatible device)

			- "renesas,rcar-gen3-iic" (generic R-Car Gen3 or RZ/G2

							compatible device)

			- "renesas,rmobile-iic" (generic device)



			When compatible with a generic R-Car version, nodes

			must list the SoC-specific version corresponding to

			the platform first followed by the generic R-Car

			version.



			When compatible with "renesas,rmobile-iic" it should

			be the last compatibility string listed.



- reg             : address start and address range size of device

- interrupts      : interrupt of device

- clocks          : clock for device

- #address-cells  : should be <1>

- #size-cells     : should be <0>



Optional properties:

- clock-frequency : frequency of bus clock in Hz. Default 100kHz if unset.

- dmas            : Must contain a list of two references to DMA

		    specifiers, one for transmission, and one for

		    reception.

- dma-names       : Must contain a list of two DMA names, "tx" and "rx".





Pinctrl properties might be needed, too. See there.



Example:



	iic0: i2c@e6500000 {

		compatible = "renesas,iic-r8a7790", "renesas,rcar-gen2-iic",

			     "renesas,rmobile-iic";

		reg = <0 0xe6500000 0 0x425>;

		interrupts = <0 174 IRQ_TYPE_LEVEL_HIGH>;

		clocks = <&mstp3_clks R8A7790_CLK_IIC0>;

		clock-frequency = <400000>;

		#address-cells = <1>;

		#size-cells = <0>;

	};

Documentation/devicetree/bindings/i2c/renesas,rmobile-iic.yaml

0 → 100644
+149 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/i2c/renesas,rmobile-iic.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Renesas R-Mobile I2C Bus Interface (IIC)



maintainers:

  - Wolfram Sang <wsa+renesas@sang-engineering.com>



properties:

  compatible:

    oneOf:

      - items:

          - enum:

              - renesas,iic-r8a73a4      # R-Mobile APE6

              - renesas,iic-r8a7740      # R-Mobile A1

              - renesas,iic-sh73a0       # SH-Mobile AG5

          - const: renesas,rmobile-iic   # Generic



      - items:

          - enum:

              - renesas,iic-r8a7742      # RZ/G1H

              - renesas,iic-r8a7743      # RZ/G1M

              - renesas,iic-r8a7744      # RZ/G1N

              - renesas,iic-r8a7745      # RZ/G1E

              - renesas,iic-r8a7790      # R-Car H2

              - renesas,iic-r8a7791      # R-Car M2-W

              - renesas,iic-r8a7792      # R-Car V2H

              - renesas,iic-r8a7793      # R-Car M2-N

              - renesas,iic-r8a7794      # R-Car E2

          - const: renesas,rcar-gen2-iic # R-Car Gen2 and RZ/G1

          - const: renesas,rmobile-iic   # Generic



      - items:

          - enum:

              - renesas,iic-r8a774a1     # RZ/G2M

              - renesas,iic-r8a774b1     # RZ/G2N

              - renesas,iic-r8a774c0     # RZ/G2E

              - renesas,iic-r8a774e1     # RZ/G2H

              - renesas,iic-r8a7795      # R-Car H3

              - renesas,iic-r8a7796      # R-Car M3-W

              - renesas,iic-r8a77961     # R-Car M3-W+

              - renesas,iic-r8a77965     # R-Car M3-N

              - renesas,iic-r8a77990     # R-Car E3

          - const: renesas,rcar-gen3-iic # R-Car Gen3 and RZ/G2

          - const: renesas,rmobile-iic   # Generic



  reg:

    maxItems: 1



  interrupts: true



  clock-frequency:

    description:

      Desired I2C bus clock frequency in Hz. The absence of this property

      indicates the default frequency 100 kHz.



  clocks:

    maxItems: 1



  power-domains:

    maxItems: 1



  resets:

    maxItems: 1



  dmas:

    minItems: 2

    maxItems: 4

    description:

      Must contain a list of pairs of references to DMA specifiers, one for

      transmission, and one for reception.



  dma-names:

    minItems: 2

    maxItems: 4

    items:

      enum:

        - tx

        - rx



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - power-domains

  - '#address-cells'

  - '#size-cells'



allOf:

  - $ref: /schemas/i2c/i2c-controller.yaml#



  - if:

      properties:

        compatible:

          contains:

            enum:

              - renesas,iic-r8a7740

              - renesas,iic-sh73a0

    then:

      properties:

        interrupts:

          items:

            - description: Arbitration Lost Interrupt (ALI)

            - description: Non-acknowledge Detection Interrupt (TACKI)

            - description: Wait Interrupt (WAITI)

            - description: Data Transmit Enable interrupt (DTEI)

    else:

      properties:

        interrupts:

          items:

            - description: Single combined interrupt



  - if:

      properties:

        compatible:

          contains:

            enum:

              - renesas,rcar-gen2-iic

              - renesas,rcar-gen3-iic

    then:

      required:

        - resets



unevaluatedProperties: false



examples:

  - |

    #include <dt-bindings/clock/r8a7790-cpg-mssr.h>

    #include <dt-bindings/interrupt-controller/arm-gic.h>

    #include <dt-bindings/power/r8a7790-sysc.h>



    iic0: i2c@e6500000 {

            compatible = "renesas,iic-r8a7790", "renesas,rcar-gen2-iic",

                         "renesas,rmobile-iic";

            reg = <0xe6500000 0x425>;

            interrupts = <GIC_SPI 174 IRQ_TYPE_LEVEL_HIGH>;

            clocks = <&cpg CPG_MOD 318>;

            clock-frequency = <400000>;

            dmas = <&dmac0 0x61>, <&dmac0 0x62>, <&dmac1 0x61>, <&dmac1 0x62>;

            dma-names = "tx", "rx", "tx", "rx";

            power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;

            resets = <&cpg 318>;

            #address-cells = <1>;

            #size-cells = <0>;

    };

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -15599,7 +15599,7 @@ M: Wolfram Sang <wsa+renesas@sang-engineering.com> 
L:	linux-renesas-soc@vger.kernel.org

S:	Supported

F:	Documentation/devicetree/bindings/i2c/renesas,rcar-i2c.yaml

F:	Documentation/devicetree/bindings/i2c/renesas,iic.txt

F:	Documentation/devicetree/bindings/i2c/renesas,rmobile-iic.yaml

F:	drivers/i2c/busses/i2c-rcar.c

F:	drivers/i2c/busses/i2c-sh_mobile.c