Commit f3ca745d authored by Benjamin Gaignard's avatar Benjamin Gaignard Committed by Rob Herring
Browse files

dt-bindings: usb: Convert DWC2 bindings to json-schema 



Convert DWC2 bindings to DT schema format using json-schema.
DWC2 is widely use but a couple of compatibles and properties
(vusb_d-supply,vusb_a-supply) were missing in dwc2.txt, the
patch add them.

Signed-off-by: default avatarBenjamin Gaignard <benjamin.gaignard@st.com>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent eae2614d

Documentation/devicetree/bindings/usb/dwc2.txt

deleted100644 → 0
+0 −64
Original line number Diff line number Diff line 
Platform DesignWare HS OTG USB 2.0 controller

-----------------------------------------------------



Required properties:

- compatible : One of:

  - brcm,bcm2835-usb: The DWC2 USB controller instance in the BCM2835 SoC.

  - hisilicon,hi6220-usb: The DWC2 USB controller instance in the hi6220 SoC.

  - rockchip,rk3066-usb: The DWC2 USB controller instance in the rk3066 Soc;

  - "rockchip,px30-usb", "rockchip,rk3066-usb", "snps,dwc2": for px30 Soc;

  - "rockchip,rk3188-usb", "rockchip,rk3066-usb", "snps,dwc2": for rk3188 Soc;

  - "rockchip,rk3288-usb", "rockchip,rk3066-usb", "snps,dwc2": for rk3288 Soc;

  - "lantiq,arx100-usb": The DWC2 USB controller instance in Lantiq ARX SoCs;

  - "lantiq,xrx200-usb": The DWC2 USB controller instance in Lantiq XRX SoCs;

  - "amlogic,meson8-usb": The DWC2 USB controller instance in Amlogic Meson8 SoCs;

  - "amlogic,meson8b-usb": The DWC2 USB controller instance in Amlogic Meson8b SoCs;

  - "amlogic,meson-gxbb-usb": The DWC2 USB controller instance in Amlogic S905 SoCs;

  - "amlogic,meson-g12a-usb": The DWC2 USB controller instance in Amlogic G12A SoCs;

  - "amcc,dwc-otg": The DWC2 USB controller instance in AMCC Canyonlands 460EX SoCs;

  - snps,dwc2: A generic DWC2 USB controller with default parameters.

  - "st,stm32f4x9-fsotg": The DWC2 USB FS/HS controller instance in STM32F4x9 SoCs

  configured in FS mode;

  - "st,stm32f4x9-hsotg": The DWC2 USB HS controller instance in STM32F4x9 SoCs

  configured in HS mode;

  - "st,stm32f7-hsotg": The DWC2 USB HS controller instance in STM32F7 SoCs

    configured in HS mode;

- reg : Should contain 1 register range (address and length)

- interrupts : Should contain 1 interrupt

- clocks: clock provider specifier

- clock-names: shall be "otg"

Refer to clk/clock-bindings.txt for generic clock consumer properties



Optional properties:

- phys: phy provider specifier

- phy-names: shall be "usb2-phy"

- vbus-supply: reference to the VBUS regulator. Depending on the current mode

  this is enabled (in "host" mode") or disabled (in "peripheral" mode). The

  regulator is updated if the controller is configured in "otg" mode and the

  status changes between "host" and "peripheral".

Refer to phy/phy-bindings.txt for generic phy consumer properties

- dr_mode: shall be one of "host", "peripheral" and "otg"

  Refer to usb/generic.txt

- g-rx-fifo-size: size of rx fifo size in gadget mode.

- g-np-tx-fifo-size: size of non-periodic tx fifo size in gadget mode.

- g-tx-fifo-size: size of periodic tx fifo per endpoint (except ep0) in gadget mode.

- snps,need-phy-for-wake: If present indicates that the phy needs to be left

                          on for remote wakeup during suspend.

- snps,reset-phy-on-wake: If present indicates that we need to reset the PHY when

                          we detect a wakeup.  This is due to a hardware errata.



Deprecated properties:

- g-use-dma: gadget DMA mode is automatically detected



Example:



        usb@101c0000 {

                compatible = "ralink,rt3050-usb, snps,dwc2";

                reg = <0x101c0000 40000>;

                interrupts = <18>;

		clocks = <&usb_otg_ahb_clk>;

		clock-names = "otg";

		phys = <&usbphy>;

		phy-names = "usb2-phy";

		snps,need-phy-for-wake;

        };

Documentation/devicetree/bindings/usb/dwc2.yaml

0 → 100644
+151 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/usb/dwc2.yaml#

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



title: DesignWare HS OTG USB 2.0 controller Bindings



maintainers:

  - Rob Herring <robh@kernel.org>



properties:

  compatible:

    oneOf:

      - const: brcm,bcm2835-usb

      - const: hisilicon,hi6220-usb

      - items:

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,px30-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,rk3036-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,rv1108-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,rk3188-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,rk3228-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - items:

          - const: rockchip,rk3288-usb

          - const: rockchip,rk3066-usb

          - const: snps,dwc2

      - const: lantiq,arx100-usb

      - const: lantiq,xrx200-usb

      - items:

          - const: amlogic,meson8-usb

          - const: snps,dwc2

      - items:

          - const: amlogic,meson8b-usb

          - const: snps,dwc2

      - const: amlogic,meson-gxbb-usb

      - items:

          - const: amlogic,meson-g12a-usb

          - const: snps,dwc2

      - const: amcc,dwc-otg

      - const: snps,dwc2

      - const: st,stm32f4x9-fsotg

      - const: st,stm32f4x9-hsotg

      - const: st,stm32f7-hsotg

      - const: samsung,s3c6400-hsotg



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    maxItems: 1



  clock-names:

    items:

      - const: otg



  resets:

    items:

     - description: common reset

     - description: ecc reset

    minItems: 1



  reset-names:

    items:

     - const: dwc2

     - const: dwc2-ecc

    minItems: 1



  phys:

    maxItems: 1



  phy-names:

    const: usb2-phy



  vbus-supply:

    description: reference to the VBUS regulator. Depending on the current mode

      this is enabled (in "host" mode") or disabled (in "peripheral" mode). The

      regulator is updated if the controller is configured in "otg" mode and the

      status changes between "host" and "peripheral".



  vusb_d-supply:

    description: phandle to voltage regulator of digital section,



  vusb_a-supply:

    description: phandle to voltage regulator of analog section.



  dr_mode:

    enum: [host, peripheral, otg]



  g-rx-fifo-size:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: size of rx fifo size in gadget mode.



  g-np-tx-fifo-size:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: size of non-periodic tx fifo size in gadget mode.



  g-tx-fifo-size:

    $ref: /schemas/types.yaml#/definitions/uint32-array

    description: size of periodic tx fifo per endpoint (except ep0) in gadget mode.



  snps,need-phy-for-wake:

    $ref: /schemas/types.yaml#/definitions/flag

    description: If present indicates that the phy needs to be left on for remote wakeup during suspend.



  snps,reset-phy-on-wake:

    $ref: /schemas/types.yaml#/definitions/flag

    description: If present indicates that we need to reset the PHY when we detect a wakeup.

                 This is due to a hardware errata.



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names



additionalProperties: false



examples:

  - |

      usb@101c0000 {

        compatible = "rockchip,rk3066-usb", "snps,dwc2";

        reg = <0x10180000 0x40000>;

        interrupts = <18>;

        clocks = <&usb_otg_ahb_clk>;

        clock-names = "otg";

        phys = <&usbphy>;

        phy-names = "usb2-phy";

      };



...

CRA Git | Maintained and supported by SUSTech CRA and CCSE