Commit 92b7716f authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Wolfram Sang
Browse files

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



Convert the Renesas RZ/A I2C Bus Interface (RIIC) Device Tree binding
documentation to json-schema.

Document missing properties.
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 6221a934
Loading
Loading
Loading
Loading
+0 −32
Original line number Diff line number Diff line
Device tree configuration for Renesas RIIC driver

Required properties:
- compatible      :
	"renesas,riic-r7s72100" if the device is a part of a R7S72100 SoC.
	"renesas,riic-r7s9210" if the device is a part of a R7S9210 SoC.
	"renesas,riic-rz" for a generic RZ/A compatible device.
- reg             : address start and address range size of device
- interrupts      : 8 interrupts (TEI, RI, TI, SPI, STI, NAKI, ALI, TMOI)
- clock-frequency : frequency of bus clock in Hz
- #address-cells  : should be <1>
- #size-cells     : should be <0>

Pinctrl properties might be needed, too. See there.

Example:

	i2c0: i2c@fcfee000 {
		compatible = "renesas,riic-r7s72100", "renesas,riic-rz";
		reg = <0xfcfee000 0x44>;
		interrupts = <0 157 IRQ_TYPE_LEVEL_HIGH>,
			     <0 158 IRQ_TYPE_EDGE_RISING>,
			     <0 159 IRQ_TYPE_EDGE_RISING>,
			     <0 160 IRQ_TYPE_LEVEL_HIGH>,
			     <0 161 IRQ_TYPE_LEVEL_HIGH>,
			     <0 162 IRQ_TYPE_LEVEL_HIGH>,
			     <0 163 IRQ_TYPE_LEVEL_HIGH>,
			     <0 164 IRQ_TYPE_LEVEL_HIGH>;
		clock-frequency = <100000>;
		#address-cells = <1>;
		#size-cells = <0>;
	};
+82 −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,riic.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Renesas RZ/A I2C Bus Interface (RIIC)

maintainers:
  - Chris Brandt <chris.brandt@renesas.com>
  - Wolfram Sang <wsa+renesas@sang-engineering.com>

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

properties:
  compatible:
    items:
      - enum:
          - renesas,riic-r7s72100 # RZ/A1H
          - renesas,riic-r7s9210  # RZ/A2M
      - const: renesas,riic-rz    # RZ/A

  reg:
    maxItems: 1

  interrupts:
    items:
      - description: Transmit End Interrupt (TEI)
      - description: Receive Data Full Interrupt (RI)
      - description: Transmit Data Empty Interrupt (TI)
      - description: Stop Condition Detection Interrupt (SPI)
      - description: Start Condition Detection Interrupt (STI)
      - description: NACK Reception Interrupt (NAKI)
      - description: Arbitration-Lost Interrupt (ALI)
      - description: Timeout Interrupt (TMOI)

  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

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - clock-frequency
  - power-domains
  - '#address-cells'
  - '#size-cells'

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/clock/r7s72100-clock.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    i2c0: i2c@fcfee000 {
            compatible = "renesas,riic-r7s72100", "renesas,riic-rz";
            reg = <0xfcfee000 0x44>;
            interrupts = <GIC_SPI 157 IRQ_TYPE_LEVEL_HIGH>,
                         <GIC_SPI 158 IRQ_TYPE_EDGE_RISING>,
                         <GIC_SPI 159 IRQ_TYPE_EDGE_RISING>,
                         <GIC_SPI 160 IRQ_TYPE_LEVEL_HIGH>,
                         <GIC_SPI 161 IRQ_TYPE_LEVEL_HIGH>,
                         <GIC_SPI 162 IRQ_TYPE_LEVEL_HIGH>,
                         <GIC_SPI 163 IRQ_TYPE_LEVEL_HIGH>,
                         <GIC_SPI 164 IRQ_TYPE_LEVEL_HIGH>;
            clocks = <&mstp9_clks R7S72100_CLK_I2C0>;
            clock-frequency = <100000>;
            power-domains = <&cpg_clocks>;
            #address-cells = <1>;
            #size-cells = <0>;
    };
+1 −1
Original line number Diff line number Diff line
@@ -15613,7 +15613,7 @@ F: drivers/thermal/rcar_thermal.c
RENESAS RIIC DRIVER
M:	Chris Brandt <chris.brandt@renesas.com>
S:	Supported
F:	Documentation/devicetree/bindings/i2c/renesas,riic.txt
F:	Documentation/devicetree/bindings/i2c/renesas,riic.yaml
F:	drivers/i2c/busses/i2c-riic.c
RENESAS USB PHY DRIVER