xref: /freebsd/sys/contrib/device-tree/Bindings/phy/apm-xgene-phy.txt (revision 02e9120893770924227138ba49df1edb3896112a)
1* APM X-Gene 15Gbps Multi-purpose PHY nodes
2
3PHY nodes are defined to describe on-chip 15Gbps Multi-purpose PHY. Each
4PHY (pair of lanes) has its own node.
5
6Required properties:
7- compatible		: Shall be "apm,xgene-phy".
8- reg			: PHY memory resource is the SDS PHY access resource.
9- #phy-cells		: Shall be 1 as it expects one argument for setting
10			  the mode of the PHY. Possible values are 0 (SATA),
11			  1 (SGMII), 2 (PCIe), 3 (USB), and 4 (XFI).
12
13Optional properties:
14- status		: Shall be "ok" if enabled or "disabled" if disabled.
15			  Default is "ok".
16- clocks		: Reference to the clock entry.
17- apm,tx-eye-tuning	: Manual control to fine tune the capture of the serial
18			  bit lines from the automatic calibrated position.
19			  Two set of 3-tuple setting for each (up to 3)
20			  supported link speed on the host. Range from 0 to
21			  127 in unit of one bit period. Default is 10.
22- apm,tx-eye-direction	: Eye tuning manual control direction. 0 means sample
23			  data earlier than the nominal sampling point. 1 means
24			  sample data later than the nominal sampling point.
25			  Two set of 3-tuple setting for each (up to 3)
26			  supported link speed on the host. Default is 0.
27- apm,tx-boost-gain	: Frequency boost AC (LSB 3-bit) and DC (2-bit)
28			  gain control. Two set of 3-tuple setting for each
29			  (up to 3) supported link speed on the host. Range is
30			  between 0 to 31 in unit of dB. Default is 3.
31- apm,tx-amplitude	: Amplitude control. Two set of 3-tuple setting for
32			  each (up to 3) supported link speed on the host.
33			  Range is between 0 to 199500 in unit of uV.
34			  Default is 199500 uV.
35- apm,tx-pre-cursor1	: 1st pre-cursor emphasis taps control. Two set of
36			  3-tuple setting for each (up to 3) supported link
37			  speed on the host. Range is 0 to 273000 in unit of
38			  uV. Default is 0.
39- apm,tx-pre-cursor2	: 2st pre-cursor emphasis taps control. Two set of
40			  3-tuple setting for each (up to 3) supported link
41			  speed on the host. Range is 0 to 127400 in unit uV.
42			  Default is 0x0.
43- apm,tx-post-cursor	: Post-cursor emphasis taps control. Two set of
44			  3-tuple setting for Gen1, Gen2, and Gen3. Range is
45			  between 0 to 0x1f in unit of 18.2mV. Default is 0xf.
46- apm,tx-speed		: Tx operating speed. One set of 3-tuple for each
47			  supported link speed on the host.
48			   0 = 1-2Gbps
49			   1 = 2-4Gbps (1st tuple default)
50			   2 = 4-8Gbps
51			   3 = 8-15Gbps (2nd tuple default)
52			   4 = 2.5-4Gbps
53			   5 = 4-5Gbps
54			   6 = 5-6Gbps
55			   7 = 6-16Gbps (3rd tuple default)
56
57NOTE: PHY override parameters are board specific setting.
58
59Example:
60		phy1: phy@1f21a000 {
61			compatible = "apm,xgene-phy";
62			reg = <0x0 0x1f21a000 0x0 0x100>;
63			#phy-cells = <1>;
64		};
65
66		phy2: phy@1f22a000 {
67			compatible = "apm,xgene-phy";
68			reg = <0x0 0x1f22a000 0x0 0x100>;
69			#phy-cells = <1>;
70		};
71
72		phy3: phy@1f23a000 {
73			compatible = "apm,xgene-phy";
74			reg = <0x0 0x1f23a000 0x0 0x100>;
75			#phy-cells = <1>;
76		};
77