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