Merge tag 'nfs-for-4.15-3' of git://git.linux-nfs.org/projects/anna/linux-nfs
[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 - address-cells: should be 1
12 - size-cells: should be 0
13 - reg: register ranges for the PHY PCB interface
14 - reg-names: should be "phy" and "phy-ctrl"
15      The "phy-ctrl" registers are only required for
16      "brcm,iproc-ns2-sata-phy" and "brcm,iproc-sr-sata-phy".
17
18 Sub-nodes:
19   Each port's PHY should be represented as a sub-node.
20
21 Sub-nodes required properties:
22 - reg: the PHY number
23 - phy-cells: generic PHY binding; must be 0
24
25 Sub-nodes optional properties:
26 - brcm,enable-ssc: use spread spectrum clocking (SSC) on this port
27      This property is not applicable for "brcm,iproc-ns2-sata-phy",
28      "brcm,iproc-nsp-sata-phy" and "brcm,iproc-sr-sata-phy".
29
30 - brcm,rxaeq-mode: string that indicates the desired RX equalizer
31   mode, possible values are:
32         "off" (equivalent to not specifying the property)
33         "auto"
34         "manual" (brcm,rxaeq-value is used in that case)
35
36 - brcm,rxaeq-value: when 'rxaeq-mode' is set to "manual", provides the RX
37   equalizer value that should be used. Allowed range is 0..63.
38
39 Example
40         sata-phy@f0458100 {
41                 compatible = "brcm,bcm7445-sata-phy", "brcm,phy-sata3";
42                 reg = <0xf0458100 0x1e00>, <0xf045804c 0x10>;
43                 reg-names = "phy";
44                 #address-cells = <1>;
45                 #size-cells = <0>;
46
47                 sata-phy@0 {
48                         reg = <0>;
49                         #phy-cells = <0>;
50                 };
51
52                 sata-phy@1 {
53                         reg = <1>;
54                         #phy-cells = <0>;
55                 };
56         };