GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / phy / rcar-gen3-phy-usb3.txt
1 * Renesas R-Car generation 3 USB 3.0 PHY
2
3 This file provides information on what the device node for the R-Car generation
4 3 USB 3.0 PHY contains.
5 If you want to enable spread spectrum clock (ssc), you should use USB_EXTAL
6 instead of USB3_CLK. However, if you don't want to these features, you don't
7 need this driver.
8
9 Required properties:
10 - compatible: "renesas,r8a7795-usb3-phy" if the device is a part of an R8A7795
11               SoC.
12               "renesas,r8a7796-usb3-phy" if the device is a part of an R8A7796
13               SoC.
14               "renesas,rcar-gen3-usb3-phy" for a generic R-Car Gen3 compatible
15               device.
16
17               When compatible with the generic version, nodes must list the
18               SoC-specific version corresponding to the platform first
19               followed by the generic version.
20
21 - reg: offset and length of the USB 3.0 PHY register block.
22 - clocks: A list of phandles and clock-specifier pairs.
23 - clock-names: Name of the clocks.
24   - The funcional clock must be "usb3-if".
25   - The usb3's external clock must be "usb3s_clk".
26   - The usb2's external clock must be "usb_extal". If you want to use the ssc,
27     the clock-frequency must not be 0.
28 - #phy-cells: see phy-bindings.txt in the same directory, must be <0>.
29
30 Optional properties:
31 - renesas,ssc-range: Enable/disable spread spectrum clock (ssc) by using
32                      the following values as u32:
33                         - 0 (or the property doesn't exist): disable the ssc
34                         - 4980: enable the ssc as -4980 ppm
35                         - 4492: enable the ssc as -4492 ppm
36                         - 4003: enable the ssc as -4003 ppm
37
38 Example (R-Car H3):
39
40         usb-phy@e65ee000 {
41                 compatible = "renesas,r8a7795-usb3-phy",
42                              "renesas,rcar-gen3-usb3-phy";
43                 reg = <0 0xe65ee000 0 0x90>;
44                 clocks = <&cpg CPG_MOD 328>, <&usb3s0_clk>, <&usb_extal>;
45                 clock-names = "usb3-if", "usb3s_clk", "usb_extal";
46         };