Commit 487adc54 authored by Rob Herring's avatar Rob Herring Committed by Greg Kroah-Hartman
Browse files

dt-bindings: usb: usb-nop-xceiv: Convert to DT schema



Convert the usb-nop-xceiv binding to DT schema.

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
Signed-off-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210327202816.545282-1-robh@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent cc27bb4e
Loading
Loading
Loading
Loading
+0 −43
Original line number Diff line number Diff line
USB NOP PHY

Required properties:
- compatible: should be usb-nop-xceiv
- #phy-cells: Must be 0

Optional properties:
- clocks: phandle to the PHY clock. Use as per Documentation/devicetree
  /bindings/clock/clock-bindings.txt
  This property is required if clock-frequency is specified.

- clock-names: Should be "main_clk"

- clock-frequency: the clock frequency (in Hz) that the PHY clock must
  be configured to.

- vcc-supply: phandle to the regulator that provides power to the PHY.

- reset-gpios: Should specify the GPIO for reset.

- vbus-detect-gpio: should specify the GPIO detecting a VBus insertion
                    (see Documentation/devicetree/bindings/gpio/gpio.txt)
- vbus-regulator : should specifiy the regulator supplying current drawn from
  the VBus line (see Documentation/devicetree/bindings/regulator/regulator.txt).

Example:

	hsusb1_phy {
		compatible = "usb-nop-xceiv";
		clock-frequency = <19200000>;
		clocks = <&osc 0>;
		clock-names = "main_clk";
		vcc-supply = <&hsusb1_vcc_regulator>;
		reset-gpios = <&gpio1 7 GPIO_ACTIVE_LOW>;
		vbus-detect-gpio = <&gpio2 13 GPIO_ACTIVE_HIGH>;
		vbus-regulator = <&vbus_regulator>;
		#phy-cells = <0>;
	};

hsusb1_phy is a NOP USB PHY device that gets its clock from an oscillator
and expects that clock to be configured to 19.2MHz by the NOP PHY driver.
hsusb1_vcc_regulator provides power to the PHY and GPIO 7 controls RESET.
GPIO 13 detects VBus insertion, and accordingly notifies the vbus-regulator.
+64 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/usb/usb-nop-xceiv.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: USB NOP PHY

maintainers:
  - Rob Herring <robh@kernel.org>

properties:
  compatible:
    const: usb-nop-xceiv

  clocks:
    maxItems: 1

  clock-names:
    const: main_clk

  clock-frequency: true

  '#phy-cells':
    const: 0

  vcc-supply:
    description: phandle to the regulator that provides power to the PHY.

  reset-gpios:
    maxItems: 1

  vbus-detect-gpio:
    description: Should specify the GPIO detecting a VBus insertion
    maxItems: 1

  vbus-regulator:
    description: Should specifiy the regulator supplying current drawn from
      the VBus line.
    $ref: /schemas/types.yaml#/definitions/phandle

required:
  - compatible
  - '#phy-cells'

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    hsusb1_phy {
        compatible = "usb-nop-xceiv";
        clock-frequency = <19200000>;
        clocks = <&osc 0>;
        clock-names = "main_clk";
        vcc-supply = <&hsusb1_vcc_regulator>;
        reset-gpios = <&gpio1 7 GPIO_ACTIVE_LOW>;
        vbus-detect-gpio = <&gpio2 13 GPIO_ACTIVE_HIGH>;
        vbus-regulator = <&vbus_regulator>;
        #phy-cells = <0>;
    };

...