Commit 51d11d0a authored by Yoshihiro Shimoda's avatar Yoshihiro Shimoda Committed by Greg Kroah-Hartman
Browse files

dt-bindings: usb: renesas: usb3-peri: convert bindings to json-schema



Convert Renesas USB 3.0 Peripheral controller bindings documentation
to json-schema.

Signed-off-by: default avatarYoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/1573036493-16525-1-git-send-email-yoshihiro.shimoda.uh@renesas.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 74ce3e41
Loading
Loading
Loading
Loading
+0 −65
Original line number Diff line number Diff line
Renesas Electronics USB3.0 Peripheral driver

Required properties:
  - compatible: Must contain one of the following:
	- "renesas,r8a774a1-usb3-peri"
	- "renesas,r8a774b1-usb3-peri"
	- "renesas,r8a774c0-usb3-peri"
	- "renesas,r8a7795-usb3-peri"
	- "renesas,r8a7796-usb3-peri"
	- "renesas,r8a77965-usb3-peri"
	- "renesas,r8a77990-usb3-peri"
	- "renesas,rcar-gen3-usb3-peri" 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: Base address and length of the register for the USB3.0 Peripheral
  - interrupts: Interrupt specifier for the USB3.0 Peripheral
  - clocks: clock phandle and specifier pair

Optional properties:
  - phys: phandle + phy specifier pair
  - phy-names: must be "usb"
  - usb-role-switch: support role switch. see usb/generic.txt

Sub-nodes:
- any connector to the data bus of this controller should be modelled using the
  OF graph bindings specified in bindings/graph.txt, if the "usb-role-switch"
  property is used.

Example of R-Car H3 ES1.x:
	usb3_peri0: usb@ee020000 {
		compatible = "renesas,r8a7795-usb3-peri",
			     "renesas,rcar-gen3-usb3-peri";
		reg = <0 0xee020000 0 0x400>;
		interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&cpg CPG_MOD 328>;
	};

	usb3_peri1: usb@ee060000 {
		compatible = "renesas,r8a7795-usb3-peri",
			     "renesas,rcar-gen3-usb3-peri";
		reg = <0 0xee060000 0 0x400>;
		interrupts = <GIC_SPI 100 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&cpg CPG_MOD 327>;
	};

Example of RZ/G2E:
	usb3_peri0: usb@ee020000 {
		compatible = "renesas,r8a774c0-usb3-peri",
			     "renesas,rcar-gen3-usb3-peri";
		reg = <0 0xee020000 0 0x400>;
		interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&cpg CPG_MOD 328>;
		companion = <&xhci0>;
		usb-role-switch;

		port {
			usb3_role_switch: endpoint {
				remote-endpoint = <&hd3ss3220_ep>;
			};
		};
	};
+86 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0-only
%YAML 1.2
---
$id: http://devicetree.org/schemas/usb/renesas,usb3-peri.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Renesas USB 3.0 Peripheral controller

maintainers:
  - Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>

properties:
  compatible:
    items:
      - enum:
          - renesas,r8a774a1-usb3-peri # RZ/G2M
          - renesas,r8a774b1-usb3-peri # RZ/G2N
          - renesas,r8a774c0-usb3-peri # RZ/G2E
          - renesas,r8a7795-usb3-peri  # R-Car H3
          - renesas,r8a7796-usb3-peri  # R-Car M3-W
          - renesas,r8a77965-usb3-peri # R-Car M3-N
          - renesas,r8a77990-usb3-peri # R-Car E3
      - const: renesas,rcar-gen3-usb3-peri

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  phys:
    maxItems: 1

  phy-names:
    const: usb

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

  usb-role-switch:
    $ref: /schemas/types.yaml#/definitions/flag
    description: Support role switch.

  companion:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: phandle of a companion.

  port:
    description: |
      any connector to the data bus of this controller should be modelled
      using the OF graph bindings specified, if the "usb-role-switch"
      property is used.

required:
  - compatible
  - interrupts
  - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/r8a774c0-cpg-mssr.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/power/r8a774c0-sysc.h>

    usb3_peri0: usb@ee020000 {
        compatible = "renesas,r8a774c0-usb3-peri", "renesas,rcar-gen3-usb3-peri";
        reg = <0 0xee020000 0 0x400>;
        interrupts = <GIC_SPI 104 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&cpg CPG_MOD 328>;
        companion = <&xhci0>;
        usb-role-switch;

        port {
            usb3_role_switch: endpoint {
                remote-endpoint = <&hd3ss3220_ep>;
            };
        };
    };