Merge branch 'for-4.20' of https://git.kernel.org/pub/scm/linux/kernel/git/broonie...
[sfrench/cifs-2.6.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 and RZ/G2 USB 3.0 PHY contain.
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,r8a774a1-usb3-phy" if the device is a part of an R8A774A1
11               SoC.
12               "renesas,r8a7795-usb3-phy" if the device is a part of an R8A7795
13               SoC.
14               "renesas,r8a7796-usb3-phy" if the device is a part of an R8A7796
15               SoC.
16               "renesas,r8a77965-usb3-phy" if the device is a part of an
17               R8A77965 SoC.
18               "renesas,rcar-gen3-usb3-phy" for a generic R-Car Gen3 or RZ/G2
19               compatible device.
20
21               When compatible with the generic version, nodes must list the
22               SoC-specific version corresponding to the platform first
23               followed by the generic version.
24
25 - reg: offset and length of the USB 3.0 PHY register block.
26 - clocks: A list of phandles and clock-specifier pairs.
27 - clock-names: Name of the clocks.
28   - The funcional clock must be "usb3-if".
29   - The usb3's external clock must be "usb3s_clk".
30   - The usb2's external clock must be "usb_extal". If you want to use the ssc,
31     the clock-frequency must not be 0.
32 - #phy-cells: see phy-bindings.txt in the same directory, must be <0>.
33
34 Optional properties:
35 - renesas,ssc-range: Enable/disable spread spectrum clock (ssc) by using
36                      the following values as u32:
37                         - 0 (or the property doesn't exist): disable the ssc
38                         - 4980: enable the ssc as -4980 ppm
39                         - 4492: enable the ssc as -4492 ppm
40                         - 4003: enable the ssc as -4003 ppm
41
42 Example (R-Car H3):
43
44         usb-phy@e65ee000 {
45                 compatible = "renesas,r8a7795-usb3-phy",
46                              "renesas,rcar-gen3-usb3-phy";
47                 reg = <0 0xe65ee000 0 0x90>;
48                 clocks = <&cpg CPG_MOD 328>, <&usb3s0_clk>, <&usb_extal>;
49                 clock-names = "usb3-if", "usb3s_clk", "usb_extal";
50         };