1 /*
2 * Copyright (c) 2019-2025 Allwinner Technology Co., Ltd. ALL rights reserved.
3 *
4 * Allwinner is a trademark of Allwinner Technology Co.,Ltd., registered in
5 * the the People's Republic of China and other countries.
6 * All Allwinner Technology Co.,Ltd. trademarks are used with permission.
7 *
8 * DISCLAIMER
9 * THIRD PARTY LICENCES MAY BE REQUIRED TO IMPLEMENT THE SOLUTION/PRODUCT.
10 * IF YOU NEED TO INTEGRATE THIRD PARTY’S TECHNOLOGY (SONY, DTS, DOLBY, AVS OR MPEGLA, ETC.)
11 * IN ALLWINNERS’SDK OR PRODUCTS, YOU SHALL BE SOLELY RESPONSIBLE TO OBTAIN
12 * ALL APPROPRIATELY REQUIRED THIRD PARTY LICENCES.
13 * ALLWINNER SHALL HAVE NO WARRANTY, INDEMNITY OR OTHER OBLIGATIONS WITH RESPECT TO MATTERS
14 * COVERED UNDER ANY REQUIRED THIRD PARTY LICENSE.
15 * YOU ARE SOLELY RESPONSIBLE FOR YOUR USAGE OF THIRD PARTY’S TECHNOLOGY.
16 *
17 *
18 * THIS SOFTWARE IS PROVIDED BY ALLWINNER"AS IS" AND TO THE MAXIMUM EXTENT
19 * PERMITTED BY LAW, ALLWINNER EXPRESSLY DISCLAIMS ALL WARRANTIES OF ANY KIND,
20 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION REGARDING
21 * THE TITLE, NON-INFRINGEMENT, ACCURACY, CONDITION, COMPLETENESS, PERFORMANCE
22 * OR MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
23 * IN NO EVENT SHALL ALLWINNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS, OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30 * OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
33 #ifndef __SUNXI_HAL_MDIO_H__
34 #define __SUNXI_HAL_MDIO_H__
35 
36 #include <sunxi_hal_mii.h>
37 
38 /* MDIO Manageable Devices (MMDs). */
39 #define MDIO_MMD_PMAPMD     1   /* Physical Medium Attachment/
40                      * Physical Medium Dependent */
41 #define MDIO_MMD_WIS        2   /* WAN Interface Sublayer */
42 #define MDIO_MMD_PCS        3   /* Physical Coding Sublayer */
43 #define MDIO_MMD_PHYXS      4   /* PHY Extender Sublayer */
44 #define MDIO_MMD_DTEXS      5   /* DTE Extender Sublayer */
45 #define MDIO_MMD_TC     6   /* Transmission Convergence */
46 #define MDIO_MMD_AN     7   /* Auto-Negotiation */
47 #define MDIO_MMD_C22EXT     29  /* Clause 22 extension */
48 #define MDIO_MMD_VEND1      30  /* Vendor specific 1 */
49 #define MDIO_MMD_VEND2      31  /* Vendor specific 2 */
50 
51 /* Generic MDIO registers. */
52 #define MDIO_CTRL1      MII_BMCR
53 #define MDIO_STAT1      MII_BMSR
54 #define MDIO_DEVID1     MII_PHYSID1
55 #define MDIO_DEVID2     MII_PHYSID2
56 #define MDIO_SPEED      4   /* Speed ability */
57 #define MDIO_DEVS1      5   /* Devices in package */
58 #define MDIO_DEVS2      6
59 #define MDIO_CTRL2      7   /* 10G control 2 */
60 #define MDIO_STAT2      8   /* 10G status 2 */
61 #define MDIO_PMA_TXDIS      9   /* 10G PMA/PMD transmit disable */
62 #define MDIO_PMA_RXDET      10  /* 10G PMA/PMD receive signal detect */
63 #define MDIO_PMA_EXTABLE    11  /* 10G PMA/PMD extended ability */
64 #define MDIO_PKGID1     14  /* Package identifier */
65 #define MDIO_PKGID2     15
66 #define MDIO_AN_ADVERTISE   16  /* AN advertising (base page) */
67 #define MDIO_AN_LPA     19  /* AN LP abilities (base page) */
68 #define MDIO_PHYXS_LNSTAT   24  /* PHY XGXS lane state */
69 
70 /* Media-dependent registers. */
71 #define MDIO_PMA_10GBT_SWAPPOL  130 /* 10GBASE-T pair swap & polarity */
72 #define MDIO_PMA_10GBT_TXPWR    131 /* 10GBASE-T TX power control */
73 #define MDIO_PMA_10GBT_SNR  133 /* 10GBASE-T SNR margin, lane A.
74                      * Lanes B-D are numbered 134-136. */
75 #define MDIO_PMA_10GBR_FECABLE  170 /* 10GBASE-R FEC ability */
76 #define MDIO_PCS_10GBX_STAT1    24  /* 10GBASE-X PCS status 1 */
77 #define MDIO_PCS_10GBRT_STAT1   32  /* 10GBASE-R/-T PCS status 1 */
78 #define MDIO_PCS_10GBRT_STAT2   33  /* 10GBASE-R/-T PCS status 2 */
79 #define MDIO_AN_10GBT_CTRL  32  /* 10GBASE-T auto-negotiation control */
80 #define MDIO_AN_10GBT_STAT  33  /* 10GBASE-T auto-negotiation status */
81 #define MDIO_AN_EEE_ADV     60  /* EEE advertisement */
82 
83 /* LASI (Link Alarm Status Interrupt) registers, defined by XENPAK MSA. */
84 #define MDIO_PMA_LASI_RXCTRL    0x9000  /* RX_ALARM control */
85 #define MDIO_PMA_LASI_TXCTRL    0x9001  /* TX_ALARM control */
86 #define MDIO_PMA_LASI_CTRL  0x9002  /* LASI control */
87 #define MDIO_PMA_LASI_RXSTAT    0x9003  /* RX_ALARM status */
88 #define MDIO_PMA_LASI_TXSTAT    0x9004  /* TX_ALARM status */
89 #define MDIO_PMA_LASI_STAT  0x9005  /* LASI status */
90 
91 /* Control register 1. */
92 /* Enable extended speed selection */
93 #define MDIO_CTRL1_SPEEDSELEXT      (BMCR_SPEED1000 | BMCR_SPEED100)
94 /* All speed selection bits */
95 #define MDIO_CTRL1_SPEEDSEL     (MDIO_CTRL1_SPEEDSELEXT | 0x003c)
96 #define MDIO_CTRL1_FULLDPLX     BMCR_FULLDPLX
97 #define MDIO_CTRL1_LPOWER       BMCR_PDOWN
98 #define MDIO_CTRL1_RESET        BMCR_RESET
99 #define MDIO_PMA_CTRL1_LOOPBACK     0x0001
100 #define MDIO_PMA_CTRL1_SPEED1000    BMCR_SPEED1000
101 #define MDIO_PMA_CTRL1_SPEED100     BMCR_SPEED100
102 #define MDIO_PCS_CTRL1_LOOPBACK     BMCR_LOOPBACK
103 #define MDIO_PHYXS_CTRL1_LOOPBACK   BMCR_LOOPBACK
104 #define MDIO_AN_CTRL1_RESTART       BMCR_ANRESTART
105 #define MDIO_AN_CTRL1_ENABLE        BMCR_ANENABLE
106 #define MDIO_AN_CTRL1_XNP       0x2000  /* Enable extended next page */
107 
108 /* 10 Gb/s */
109 #define MDIO_CTRL1_SPEED10G     (MDIO_CTRL1_SPEEDSELEXT | 0x00)
110 /* 10PASS-TS/2BASE-TL */
111 #define MDIO_CTRL1_SPEED10P2B       (MDIO_CTRL1_SPEEDSELEXT | 0x04)
112 
113 /* Status register 1. */
114 #define MDIO_STAT1_LPOWERABLE       0x0002  /* Low-power ability */
115 #define MDIO_STAT1_LSTATUS      BMSR_LSTATUS
116 #define MDIO_STAT1_FAULT        0x0080  /* Fault */
117 #define MDIO_AN_STAT1_LPABLE        0x0001  /* Link partner AN ability */
118 #define MDIO_AN_STAT1_ABLE      BMSR_ANEGCAPABLE
119 #define MDIO_AN_STAT1_RFAULT        BMSR_RFAULT
120 #define MDIO_AN_STAT1_COMPLETE      BMSR_ANEGCOMPLETE
121 #define MDIO_AN_STAT1_PAGE      0x0040  /* Page received */
122 #define MDIO_AN_STAT1_XNP       0x0080  /* Extended next page status */
123 
124 /* Speed register. */
125 #define MDIO_SPEED_10G          0x0001  /* 10G capable */
126 #define MDIO_PMA_SPEED_2B       0x0002  /* 2BASE-TL capable */
127 #define MDIO_PMA_SPEED_10P      0x0004  /* 10PASS-TS capable */
128 #define MDIO_PMA_SPEED_1000     0x0010  /* 1000M capable */
129 #define MDIO_PMA_SPEED_100      0x0020  /* 100M capable */
130 #define MDIO_PMA_SPEED_10       0x0040  /* 10M capable */
131 #define MDIO_PCS_SPEED_10P2B        0x0002  /* 10PASS-TS/2BASE-TL capable */
132 
133 /* Device present registers. */
134 #define MDIO_DEVS_PRESENT(devad)    (1 << (devad))
135 #define MDIO_DEVS_PMAPMD        MDIO_DEVS_PRESENT(MDIO_MMD_PMAPMD)
136 #define MDIO_DEVS_WIS           MDIO_DEVS_PRESENT(MDIO_MMD_WIS)
137 #define MDIO_DEVS_PCS           MDIO_DEVS_PRESENT(MDIO_MMD_PCS)
138 #define MDIO_DEVS_PHYXS         MDIO_DEVS_PRESENT(MDIO_MMD_PHYXS)
139 #define MDIO_DEVS_DTEXS         MDIO_DEVS_PRESENT(MDIO_MMD_DTEXS)
140 #define MDIO_DEVS_TC            MDIO_DEVS_PRESENT(MDIO_MMD_TC)
141 #define MDIO_DEVS_AN            MDIO_DEVS_PRESENT(MDIO_MMD_AN)
142 #define MDIO_DEVS_C22EXT        MDIO_DEVS_PRESENT(MDIO_MMD_C22EXT)
143 #define MDIO_DEVS_VEND1         MDIO_DEVS_PRESENT(MDIO_MMD_VEND1)
144 #define MDIO_DEVS_VEND2         MDIO_DEVS_PRESENT(MDIO_MMD_VEND2)
145 
146 #define MDIO_DEVS_LINK          (MDIO_DEVS_PMAPMD | \
147                     MDIO_DEVS_WIS | \
148                     MDIO_DEVS_PCS | \
149                     MDIO_DEVS_PHYXS | \
150                     MDIO_DEVS_DTEXS | \
151                     MDIO_DEVS_AN)
152 
153 /* Control register 2. */
154 #define MDIO_PMA_CTRL2_TYPE     0x000f  /* PMA/PMD type selection */
155 #define MDIO_PMA_CTRL2_10GBCX4      0x0000  /* 10GBASE-CX4 type */
156 #define MDIO_PMA_CTRL2_10GBEW       0x0001  /* 10GBASE-EW type */
157 #define MDIO_PMA_CTRL2_10GBLW       0x0002  /* 10GBASE-LW type */
158 #define MDIO_PMA_CTRL2_10GBSW       0x0003  /* 10GBASE-SW type */
159 #define MDIO_PMA_CTRL2_10GBLX4      0x0004  /* 10GBASE-LX4 type */
160 #define MDIO_PMA_CTRL2_10GBER       0x0005  /* 10GBASE-ER type */
161 #define MDIO_PMA_CTRL2_10GBLR       0x0006  /* 10GBASE-LR type */
162 #define MDIO_PMA_CTRL2_10GBSR       0x0007  /* 10GBASE-SR type */
163 #define MDIO_PMA_CTRL2_10GBLRM      0x0008  /* 10GBASE-LRM type */
164 #define MDIO_PMA_CTRL2_10GBT        0x0009  /* 10GBASE-T type */
165 #define MDIO_PMA_CTRL2_10GBKX4      0x000a  /* 10GBASE-KX4 type */
166 #define MDIO_PMA_CTRL2_10GBKR       0x000b  /* 10GBASE-KR type */
167 #define MDIO_PMA_CTRL2_1000BT       0x000c  /* 1000BASE-T type */
168 #define MDIO_PMA_CTRL2_1000BKX      0x000d  /* 1000BASE-KX type */
169 #define MDIO_PMA_CTRL2_100BTX       0x000e  /* 100BASE-TX type */
170 #define MDIO_PMA_CTRL2_10BT     0x000f  /* 10BASE-T type */
171 #define MDIO_PCS_CTRL2_TYPE     0x0003  /* PCS type selection */
172 #define MDIO_PCS_CTRL2_10GBR        0x0000  /* 10GBASE-R type */
173 #define MDIO_PCS_CTRL2_10GBX        0x0001  /* 10GBASE-X type */
174 #define MDIO_PCS_CTRL2_10GBW        0x0002  /* 10GBASE-W type */
175 #define MDIO_PCS_CTRL2_10GBT        0x0003  /* 10GBASE-T type */
176 
177 /* Status register 2. */
178 #define MDIO_STAT2_RXFAULT      0x0400  /* Receive fault */
179 #define MDIO_STAT2_TXFAULT      0x0800  /* Transmit fault */
180 #define MDIO_STAT2_DEVPRST      0xc000  /* Device present */
181 #define MDIO_STAT2_DEVPRST_VAL      0x8000  /* Device present value */
182 #define MDIO_PMA_STAT2_LBABLE       0x0001  /* PMA loopback ability */
183 #define MDIO_PMA_STAT2_10GBEW       0x0002  /* 10GBASE-EW ability */
184 #define MDIO_PMA_STAT2_10GBLW       0x0004  /* 10GBASE-LW ability */
185 #define MDIO_PMA_STAT2_10GBSW       0x0008  /* 10GBASE-SW ability */
186 #define MDIO_PMA_STAT2_10GBLX4      0x0010  /* 10GBASE-LX4 ability */
187 #define MDIO_PMA_STAT2_10GBER       0x0020  /* 10GBASE-ER ability */
188 #define MDIO_PMA_STAT2_10GBLR       0x0040  /* 10GBASE-LR ability */
189 #define MDIO_PMA_STAT2_10GBSR       0x0080  /* 10GBASE-SR ability */
190 #define MDIO_PMD_STAT2_TXDISAB      0x0100  /* PMD TX disable ability */
191 #define MDIO_PMA_STAT2_EXTABLE      0x0200  /* Extended abilities */
192 #define MDIO_PMA_STAT2_RXFLTABLE    0x1000  /* Receive fault ability */
193 #define MDIO_PMA_STAT2_TXFLTABLE    0x2000  /* Transmit fault ability */
194 #define MDIO_PCS_STAT2_10GBR        0x0001  /* 10GBASE-R capable */
195 #define MDIO_PCS_STAT2_10GBX        0x0002  /* 10GBASE-X capable */
196 #define MDIO_PCS_STAT2_10GBW        0x0004  /* 10GBASE-W capable */
197 #define MDIO_PCS_STAT2_RXFLTABLE    0x1000  /* Receive fault ability */
198 #define MDIO_PCS_STAT2_TXFLTABLE    0x2000  /* Transmit fault ability */
199 
200 /* Transmit disable register. */
201 #define MDIO_PMD_TXDIS_GLOBAL       0x0001  /* Global PMD TX disable */
202 #define MDIO_PMD_TXDIS_0        0x0002  /* PMD TX disable 0 */
203 #define MDIO_PMD_TXDIS_1        0x0004  /* PMD TX disable 1 */
204 #define MDIO_PMD_TXDIS_2        0x0008  /* PMD TX disable 2 */
205 #define MDIO_PMD_TXDIS_3        0x0010  /* PMD TX disable 3 */
206 
207 /* Receive signal detect register. */
208 #define MDIO_PMD_RXDET_GLOBAL       0x0001  /* Global PMD RX signal detect */
209 #define MDIO_PMD_RXDET_0        0x0002  /* PMD RX signal detect 0 */
210 #define MDIO_PMD_RXDET_1        0x0004  /* PMD RX signal detect 1 */
211 #define MDIO_PMD_RXDET_2        0x0008  /* PMD RX signal detect 2 */
212 #define MDIO_PMD_RXDET_3        0x0010  /* PMD RX signal detect 3 */
213 
214 /* Extended abilities register. */
215 #define MDIO_PMA_EXTABLE_10GCX4     0x0001  /* 10GBASE-CX4 ability */
216 #define MDIO_PMA_EXTABLE_10GBLRM    0x0002  /* 10GBASE-LRM ability */
217 #define MDIO_PMA_EXTABLE_10GBT      0x0004  /* 10GBASE-T ability */
218 #define MDIO_PMA_EXTABLE_10GBKX4    0x0008  /* 10GBASE-KX4 ability */
219 #define MDIO_PMA_EXTABLE_10GBKR     0x0010  /* 10GBASE-KR ability */
220 #define MDIO_PMA_EXTABLE_1000BT     0x0020  /* 1000BASE-T ability */
221 #define MDIO_PMA_EXTABLE_1000BKX    0x0040  /* 1000BASE-KX ability */
222 #define MDIO_PMA_EXTABLE_100BTX     0x0080  /* 100BASE-TX ability */
223 #define MDIO_PMA_EXTABLE_10BT       0x0100  /* 10BASE-T ability */
224 
225 /* PHY XGXS lane state register. */
226 #define MDIO_PHYXS_LNSTAT_SYNC0     0x0001
227 #define MDIO_PHYXS_LNSTAT_SYNC1     0x0002
228 #define MDIO_PHYXS_LNSTAT_SYNC2     0x0004
229 #define MDIO_PHYXS_LNSTAT_SYNC3     0x0008
230 #define MDIO_PHYXS_LNSTAT_ALIGN     0x1000
231 
232 /* PMA 10GBASE-T pair swap & polarity */
233 #define MDIO_PMA_10GBT_SWAPPOL_ABNX 0x0001  /* Pair A/B uncrossed */
234 #define MDIO_PMA_10GBT_SWAPPOL_CDNX 0x0002  /* Pair C/D uncrossed */
235 #define MDIO_PMA_10GBT_SWAPPOL_AREV 0x0100  /* Pair A polarity reversed */
236 #define MDIO_PMA_10GBT_SWAPPOL_BREV 0x0200  /* Pair B polarity reversed */
237 #define MDIO_PMA_10GBT_SWAPPOL_CREV 0x0400  /* Pair C polarity reversed */
238 #define MDIO_PMA_10GBT_SWAPPOL_DREV 0x0800  /* Pair D polarity reversed */
239 
240 /* PMA 10GBASE-T TX power register. */
241 #define MDIO_PMA_10GBT_TXPWR_SHORT  0x0001  /* Short-reach mode */
242 
243 /* PMA 10GBASE-T SNR registers. */
244 /* Value is SNR margin in dB, clamped to range [-127, 127], plus 0x8000. */
245 #define MDIO_PMA_10GBT_SNR_BIAS     0x8000
246 #define MDIO_PMA_10GBT_SNR_MAX      127
247 
248 /* PMA 10GBASE-R FEC ability register. */
249 #define MDIO_PMA_10GBR_FECABLE_ABLE 0x0001  /* FEC ability */
250 #define MDIO_PMA_10GBR_FECABLE_ERRABLE  0x0002  /* FEC error indic. ability */
251 
252 /* PCS 10GBASE-R/-T status register 1. */
253 #define MDIO_PCS_10GBRT_STAT1_BLKLK 0x0001  /* Block lock attained */
254 
255 /* PCS 10GBASE-R/-T status register 2. */
256 #define MDIO_PCS_10GBRT_STAT2_ERR   0x00ff
257 #define MDIO_PCS_10GBRT_STAT2_BER   0x3f00
258 
259 /* AN 10GBASE-T control register. */
260 #define MDIO_AN_10GBT_CTRL_ADV10G   0x1000  /* Advertise 10GBASE-T */
261 
262 /* AN 10GBASE-T status register. */
263 #define MDIO_AN_10GBT_STAT_LPTRR    0x0200  /* LP training reset req. */
264 #define MDIO_AN_10GBT_STAT_LPLTABLE 0x0400  /* LP loop timing ability */
265 #define MDIO_AN_10GBT_STAT_LP10G    0x0800  /* LP is 10GBT capable */
266 #define MDIO_AN_10GBT_STAT_REMOK    0x1000  /* Remote OK */
267 #define MDIO_AN_10GBT_STAT_LOCOK    0x2000  /* Local OK */
268 #define MDIO_AN_10GBT_STAT_MS       0x4000  /* Master/slave config */
269 #define MDIO_AN_10GBT_STAT_MSFLT    0x8000  /* Master/slave config fault */
270 
271 /* AN EEE Advertisement register. */
272 #define MDIO_AN_EEE_ADV_100TX       0x0002  /* Advertise 100TX EEE cap */
273 #define MDIO_AN_EEE_ADV_1000T       0x0004  /* Advertise 1000T EEE cap */
274 
275 /* LASI RX_ALARM control/status registers. */
276 #define MDIO_PMA_LASI_RX_PHYXSLFLT  0x0001  /* PHY XS RX local fault */
277 #define MDIO_PMA_LASI_RX_PCSLFLT    0x0008  /* PCS RX local fault */
278 #define MDIO_PMA_LASI_RX_PMALFLT    0x0010  /* PMA/PMD RX local fault */
279 #define MDIO_PMA_LASI_RX_OPTICPOWERFLT  0x0020  /* RX optical power fault */
280 #define MDIO_PMA_LASI_RX_WISLFLT    0x0200  /* WIS local fault */
281 
282 /* LASI TX_ALARM control/status registers. */
283 #define MDIO_PMA_LASI_TX_PHYXSLFLT  0x0001  /* PHY XS TX local fault */
284 #define MDIO_PMA_LASI_TX_PCSLFLT    0x0008  /* PCS TX local fault */
285 #define MDIO_PMA_LASI_TX_PMALFLT    0x0010  /* PMA/PMD TX local fault */
286 #define MDIO_PMA_LASI_TX_LASERPOWERFLT  0x0080  /* Laser output power fault */
287 #define MDIO_PMA_LASI_TX_LASERTEMPFLT   0x0100  /* Laser temperature fault */
288 #define MDIO_PMA_LASI_TX_LASERBICURRFLT 0x0200  /* Laser bias current fault */
289 
290 /* LASI control/status registers. */
291 #define MDIO_PMA_LASI_LSALARM       0x0001  /* LS_ALARM enable/status */
292 #define MDIO_PMA_LASI_TXALARM       0x0002  /* TX_ALARM enable/status */
293 #define MDIO_PMA_LASI_RXALARM       0x0004  /* RX_ALARM enable/status */
294 
295 /* Mapping between MDIO PRTAD/DEVAD and mii_ioctl_data::phy_id */
296 
297 #define MDIO_PHY_ID_C45         0x8000
298 #define MDIO_PHY_ID_PRTAD       0x03e0
299 #define MDIO_PHY_ID_DEVAD       0x001f
300 #define MDIO_PHY_ID_C45_MASK                        \
301     (MDIO_PHY_ID_C45 | MDIO_PHY_ID_PRTAD | MDIO_PHY_ID_DEVAD)
302 
303 #define MDIO_PRTAD_NONE         (-1)
304 #define MDIO_DEVAD_NONE         (-1)
305 #define MDIO_EMULATE_C22        4
306 
307 #endif /* __SUNXI_HAL_MDIO_H__ */
308