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