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

dt-bindings: usb: renesas_usbhs: convert bindings to json-schema



Convert Renesas USBHS (HS-USB) 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/1573102944-11095-1-git-send-email-yoshihiro.shimoda.uh@renesas.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 26a4d4c0
Loading
Loading
Loading
Loading
+0 −58
Original line number Diff line number Diff line
Renesas Electronics USBHS driver

Required properties:
  - compatible: Must contain one or more of the following:

	- "renesas,usbhs-r8a7743" for r8a7743 (RZ/G1M) compatible device
	- "renesas,usbhs-r8a7744" for r8a7744 (RZ/G1N) compatible device
	- "renesas,usbhs-r8a7745" for r8a7745 (RZ/G1E) compatible device
	- "renesas,usbhs-r8a77470" for r8a77470 (RZ/G1C) compatible device
	- "renesas,usbhs-r8a774a1" for r8a774a1 (RZ/G2M) compatible device
	- "renesas,usbhs-r8a774b1" for r8a774b1 (RZ/G2N) compatible device
	- "renesas,usbhs-r8a774c0" for r8a774c0 (RZ/G2E) compatible device
	- "renesas,usbhs-r8a7790" for r8a7790 (R-Car H2) compatible device
	- "renesas,usbhs-r8a7791" for r8a7791 (R-Car M2-W) compatible device
	- "renesas,usbhs-r8a7792" for r8a7792 (R-Car V2H) compatible device
	- "renesas,usbhs-r8a7793" for r8a7793 (R-Car M2-N) compatible device
	- "renesas,usbhs-r8a7794" for r8a7794 (R-Car E2) compatible device
	- "renesas,usbhs-r8a7795" for r8a7795 (R-Car H3) compatible device
	- "renesas,usbhs-r8a7796" for r8a7796 (R-Car M3-W) compatible device
	- "renesas,usbhs-r8a77965" for r8a77965 (R-Car M3-N) compatible device
	- "renesas,usbhs-r8a77990" for r8a77990 (R-Car E3) compatible device
	- "renesas,usbhs-r8a77995" for r8a77995 (R-Car D3) compatible device
	- "renesas,usbhs-r7s72100" for r7s72100 (RZ/A1) compatible device
	- "renesas,usbhs-r7s9210" for r7s9210 (RZ/A2) compatible device
	- "renesas,rcar-gen2-usbhs" for R-Car Gen2 or RZ/G1 compatible devices
	- "renesas,rcar-gen3-usbhs" for R-Car Gen3 or RZ/G2 compatible devices
	- "renesas,rza1-usbhs" for RZ/A1 compatible device
	- "renesas,rza2-usbhs" for RZ/A2 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 USBHS
  - interrupts: Interrupt specifier for the USBHS
  - clocks: A list of phandle + clock specifier pairs.
	    - In case of "renesas,rcar-gen3-usbhs", two clocks are required.
	      First clock should be peripheral and second one should be host.
	    - In case of except above, one clock is required. First clock
	      should be peripheral.

Optional properties:
  - renesas,buswait: Integer to use BUSWAIT register
  - renesas,enable-gpio: A gpio specifier to check GPIO determining if USB
			 function should be enabled
  - phys: phandle + phy specifier pair
  - phy-names: must be "usb"
  - dmas: Must contain a list of references to DMA specifiers.
  - dma-names : named "ch%d", where %d is the channel number ranging from zero
                to the number of channels (DnFIFOs) minus one.

Example:
	usbhs: usb@e6590000 {
		compatible = "renesas,usbhs-r8a7790", "renesas,rcar-gen2-usbhs";
		reg = <0 0xe6590000 0 0x100>;
		interrupts = <0 107 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&mstp7_clks R8A7790_CLK_HSUSB>;
	};
+126 −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,usbhs.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Renesas USBHS (HS-USB) controller

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

properties:
  compatible:
    oneOf:
      - items:
          - const: renesas,usbhs-r7s72100 # RZ/A1
          - const: renesas,rza1-usbhs

      - items:
          - const: renesas,usbhs-r7s9210 # RZ/A2
          - const: renesas,rza2-usbhs

      - items:
          - enum:
              - renesas,usbhs-r8a7743  # RZ/G1M
              - renesas,usbhs-r8a7744  # RZ/G1N
              - renesas,usbhs-r8a7745  # RZ/G1E
              - renesas,usbhs-r8a77470 # RZ/G1C
              - renesas,usbhs-r8a7790  # R-Car H2
              - renesas,usbhs-r8a7791  # R-Car M2-W
              - renesas,usbhs-r8a7792  # R-Car V2H
              - renesas,usbhs-r8a7793  # R-Car M2-N
              - renesas,usbhs-r8a7794  # R-Car E2
          - const: renesas,rcar-gen2-usbhs

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

  reg:
    maxItems: 1

  clocks:
    minItems: 1
    maxItems: 3
    items:
      - description: USB 2.0 host
      - description: USB 2.0 peripheral
      - description: USB 2.0 clock selector

  interrupts:
    maxItems: 1

  renesas,buswait:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |
      Integer to use BUSWAIT register.

  renesas,enable-gpio:
    description: |
      gpio specifier to check GPIO determining if USB function should be
      enabled.

  phys:
    maxItems: 1
    items:
      - description: phandle + phy specifier pair.

  phy-names:
    maxItems: 1
    items:
      - const: usb

  dmas:
    minItems: 2
    maxItems: 4

  dma-names:
    minItems: 2
    maxItems: 4
    items:
      - const: ch0
      - const: ch1
      - const: ch2
      - const: ch3

  dr_mode: true

  power-domains:
    maxItems: 1

  resets:
    minItems: 1
    maxItems: 2
    items:
      - description: USB 2.0 host
      - description: USB 2.0 peripheral

required:
  - compatible
  - reg
  - clocks
  - interrupts

additionalProperties: 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>

    usbhs: usb@e6590000 {
        compatible = "renesas,usbhs-r8a7790", "renesas,rcar-gen2-usbhs";
        reg = <0 0xe6590000 0 0x100>;
        interrupts = <GIC_SPI 107 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&cpg CPG_MOD 704>;
    };