Merge branch 'omap-for-v4.20/defconfig' into omap-for-v4.21/defconfig
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / phy / brcm-sata-phy.txt
1 * Broadcom SATA3 PHY
2
3 Required properties:
4 - compatible: should be one or more of
5      "brcm,bcm7425-sata-phy"
6      "brcm,bcm7445-sata-phy"
7      "brcm,iproc-ns2-sata-phy"
8      "brcm,iproc-nsp-sata-phy"
9      "brcm,phy-sata3"
10      "brcm,iproc-sr-sata-phy"
11      "brcm,bcm63138-sata-phy"
12 - address-cells: should be 1
13 - size-cells: should be 0
14 - reg: register ranges for the PHY PCB interface
15 - reg-names: should be "phy" and "phy-ctrl"
16      The "phy-ctrl" registers are only required for
17      "brcm,iproc-ns2-sata-phy" and "brcm,iproc-sr-sata-phy".
18
19 Sub-nodes:
20   Each port's PHY should be represented as a sub-node.
21
22 Sub-nodes required properties:
23 - reg: the PHY number
24 - phy-cells: generic PHY binding; must be 0
25
26 Sub-nodes optional properties:
27 - brcm,enable-ssc: use spread spectrum clocking (SSC) on this port
28      This property is not applicable for "brcm,iproc-ns2-sata-phy",
29      "brcm,iproc-nsp-sata-phy" and "brcm,iproc-sr-sata-phy".
30
31 - brcm,rxaeq-mode: string that indicates the desired RX equalizer
32   mode, possible values are:
33         "off" (equivalent to not specifying the property)
34         "auto"
35         "manual" (brcm,rxaeq-value is used in that case)
36
37 - brcm,rxaeq-value: when 'rxaeq-mode' is set to "manual", provides the RX
38   equalizer value that should be used. Allowed range is 0..63.
39
40 Example
41         sata-phy@f0458100 {
42                 compatible = "brcm,bcm7445-sata-phy", "brcm,phy-sata3";
43                 reg = <0xf0458100 0x1e00>, <0xf045804c 0x10>;
44                 reg-names = "phy";
45                 #address-cells = <1>;
46                 #size-cells = <0>;
47
48                 sata-phy@0 {
49                         reg = <0>;
50                         #phy-cells = <0>;
51                 };
52
53                 sata-phy@1 {
54                         reg = <1>;
55                         #phy-cells = <0>;
56                 };
57         };