Commit 1883a934 authored by Roger Quadros's avatar Roger Quadros Committed by Felipe Balbi
Browse files

dt-bindings: usb: convert keystone-usb.txt to YAML



Convert keystone-usb documentation to YAML format.

Signed-off-by: default avatarRoger Quadros <rogerq@ti.com>
Signed-off-by: default avatarFelipe Balbi <balbi@kernel.org>
parent 63c7bb29
Loading
Loading
Loading
Loading
+0 −56
Original line number Diff line number Diff line
TI Keystone Soc USB Controller

DWC3 GLUE

Required properties:
 - compatible: should be
		"ti,keystone-dwc3" for Keystone 2 SoCs
		"ti,am654-dwc3" for AM654 SoC
 - #address-cells, #size-cells : should be '1' if the device has sub-nodes
   with 'reg' property.
 - reg : Address and length of the register set for the USB subsystem on
   the SOC.
 - interrupts : The irq number of this device that is used to interrupt the
   MPU.
 - ranges: allows valid 1:1 translation between child's address space and
   parent's address space.

SoC-specific Required Properties:
The following are mandatory properties for Keystone 2 66AK2HK, 66AK2L and 66AK2E
SoCs only:

- clocks:		Clock ID for USB functional clock.
- clock-names:		Must be "usb".


The following are mandatory properties for 66AK2G and AM654:

- power-domains:	Should contain a phandle to a PM domain provider node
			and an args specifier containing the USB device id
			value. This property is as per the binding,
			Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt

Sub-nodes:
The dwc3 core should be added as subnode to Keystone DWC3 glue.
- dwc3 :
   The binding details of dwc3 can be found in:
   Documentation/devicetree/bindings/usb/dwc3.txt

Example:
	usb: usb@2680000 {
		compatible = "ti,keystone-dwc3";
		#address-cells = <1>;
		#size-cells = <1>;
		reg = <0x2680000 0x10000>;
		clocks = <&clkusb>;
		clock-names = "usb";
		interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
		ranges;

		dwc3@2690000 {
			compatible = "synopsys,dwc3";
			reg = <0x2690000 0x70000>;
			interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
			usb-phy = <&usb_phy>, <&usb_phy>;
		};
	};
+67 −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/usb/ti,keystone-dwc3.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: TI Keystone Soc USB Controller

maintainers:
  - Roger Quadros <rogerq@ti.com>

properties:
  compatible:
    oneOf:
      - const: "ti,keystone-dwc3"
      - const: "ti,am654-dwc3"

  reg:
    maxItems: 1
    description: Address and length of the register set for the USB subsystem on
      the SOC.

  interrupts:
    maxItems: 1
    description: The irq number of this device that is used to interrupt the MPU.


  clocks:
    description: Clock ID for USB functional clock.

  power-domains:
    description: Should contain a phandle to a PM domain provider node
      and an args specifier containing the USB device id
      value. This property is as per the binding,
      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt

  dwc3:
    description: This is the node representing the DWC3 controller instance
      Documentation/devicetree/bindings/usb/dwc3.txt

required:
  - compatible
  - reg
  - interrupts
  - clocks

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

    usb: usb@2680000 {
      compatible = "ti,keystone-dwc3";
      #address-cells = <1>;
      #size-cells = <1>;
      reg = <0x2680000 0x10000>;
      clocks = <&clkusb>;
      clock-names = "usb";
      interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
      ranges;

      dwc3@2690000 {
        compatible = "synopsys,dwc3";
        reg = <0x2690000 0x70000>;
        interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
        usb-phy = <&usb_phy>, <&usb_phy>;
      };
    };