GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / usb / usb-nop-xceiv.txt
1 USB NOP PHY
2
3 Required properties:
4 - compatible: should be usb-nop-xceiv
5 - #phy-cells: Must be 0
6
7 Optional properties:
8 - clocks: phandle to the PHY clock. Use as per Documentation/devicetree
9   /bindings/clock/clock-bindings.txt
10   This property is required if clock-frequency is specified.
11
12 - clock-names: Should be "main_clk"
13
14 - clock-frequency: the clock frequency (in Hz) that the PHY clock must
15   be configured to.
16
17 - vcc-supply: phandle to the regulator that provides power to the PHY.
18
19 - reset-gpios: Should specify the GPIO for reset.
20
21 - vbus-detect-gpio: should specify the GPIO detecting a VBus insertion
22                     (see Documentation/devicetree/bindings/gpio/gpio.txt)
23 - vbus-regulator : should specifiy the regulator supplying current drawn from
24   the VBus line (see Documentation/devicetree/bindings/regulator/regulator.txt).
25
26 Example:
27
28         hsusb1_phy {
29                 compatible = "usb-nop-xceiv";
30                 clock-frequency = <19200000>;
31                 clocks = <&osc 0>;
32                 clock-names = "main_clk";
33                 vcc-supply = <&hsusb1_vcc_regulator>;
34                 reset-gpios = <&gpio1 7 GPIO_ACTIVE_LOW>;
35                 vbus-detect-gpio = <&gpio2 13 GPIO_ACTIVE_HIGH>;
36                 vbus-regulator = <&vbus_regulator>;
37                 #phy-cells = <0>;
38         };
39
40 hsusb1_phy is a NOP USB PHY device that gets its clock from an oscillator
41 and expects that clock to be configured to 19.2MHz by the NOP PHY driver.
42 hsusb1_vcc_regulator provides power to the PHY and GPIO 7 controls RESET.
43 GPIO 13 detects VBus insertion, and accordingly notifies the vbus-regulator.