1 /* $NetBSD: rlphy.c,v 1.39 2020/03/15 23:04:50 thorpej Exp $ */
2 /* $OpenBSD: rlphy.c,v 1.20 2005/07/31 05:27:30 pvalchev Exp $ */
3
4 /*
5 * Copyright (c) 1998, 1999 Jason L. Wright (jason@thought.net)
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 /*
31 * Driver for the internal PHY found on RTL8139 based nics, based
32 * on drivers for the 'exphy' (Internal 3Com phys) and 'nsphy'
33 * (National Semiconductor DP83840).
34 */
35
36 /*
37 * Ported to NetBSD by Juan Romero Pardines <xtraeme@NetBSD.org>
38 */
39
40 #include <sys/cdefs.h>
41 __KERNEL_RCSID(0, "$NetBSD: rlphy.c,v 1.39 2020/03/15 23:04:50 thorpej Exp $");
42
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/device.h>
47 #include <sys/socket.h>
48 #include <sys/errno.h>
49
50 #include <net/if.h>
51 #include <net/if_media.h>
52
53 #include <dev/mii/mii.h>
54 #include <dev/mii/miivar.h>
55 #include <dev/mii/miidevs.h>
56 #include <sys/bus.h>
57 #include <dev/ic/rtl81x9reg.h>
58
59 struct rlphy_softc {
60 struct mii_softc sc_mii;
61 int sc_rtl8201;
62 };
63
64 static int rlphymatch(device_t, cfdata_t, void *);
65 static void rlphyattach(device_t, device_t, void *);
66
67 CFATTACH_DECL_NEW(rlphy, sizeof(struct rlphy_softc),
68 rlphymatch, rlphyattach, mii_phy_detach, mii_phy_activate);
69
70 static int rlphy_service(struct mii_softc *, struct mii_data *, int);
71 static void rlphy_status(struct mii_softc *);
72 static void rlphy_reset(struct mii_softc *);
73
74 const struct mii_phy_funcs rlphy_funcs = {
75 rlphy_service, rlphy_status, rlphy_reset,
76 };
77
78 static const struct mii_phydesc rlphys[] = {
79 MII_PHY_DESC(yyREALTEK, RTL8201L),
80 MII_PHY_DESC(REALTEK, RTL8201E),
81 MII_PHY_DESC(xxICPLUS, IP101),
82 MII_PHY_END,
83 };
84
85 static int
rlphymatch(device_t parent,cfdata_t match,void * aux)86 rlphymatch(device_t parent, cfdata_t match, void *aux)
87 {
88 struct mii_attach_args *ma = aux;
89 struct mii_data *mii = ma->mii_data;
90
91 if (mii->mii_instance != 0)
92 return 0;
93
94 if (mii_phy_match(ma, rlphys) != NULL)
95 return 10;
96
97 if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 ||
98 MII_MODEL(ma->mii_id2) != 0)
99 return 0;
100
101 if (!device_is_a(parent, "rtk") && !device_is_a(parent, "re"))
102 return 0;
103
104 /*
105 * A "real" phy should get preference, but on the 8139 there
106 * is no phyid register.
107 */
108 return 5;
109 }
110
111 static void
rlphyattach(device_t parent,device_t self,void * aux)112 rlphyattach(device_t parent, device_t self, void *aux)
113 {
114 struct rlphy_softc *rsc = device_private(self);
115 struct mii_softc *sc = &rsc->sc_mii;
116 struct mii_attach_args *ma = aux;
117 struct mii_data *mii = ma->mii_data;
118
119 aprint_naive("\n");
120 if (MII_MODEL(ma->mii_id2) == MII_MODEL_yyREALTEK_RTL8201L) {
121 rsc->sc_rtl8201 = 1;
122 aprint_normal(": %s, rev. %d\n", MII_STR_yyREALTEK_RTL8201L,
123 MII_REV(ma->mii_id2));
124 } else if (MII_MODEL(ma->mii_id2) == MII_MODEL_REALTEK_RTL8201E) {
125 rsc->sc_rtl8201 = 1;
126 aprint_normal(": %s, rev. %d\n", MII_STR_REALTEK_RTL8201E,
127 MII_REV(ma->mii_id2));
128 } else if (MII_MODEL(ma->mii_id2) == MII_MODEL_xxICPLUS_IP101) {
129 aprint_normal(": %s, rev. %d\n", MII_STR_xxICPLUS_IP101,
130 MII_REV(ma->mii_id2));
131 } else
132 aprint_normal(": Realtek internal PHY\n");
133
134 sc->mii_dev = self;
135 sc->mii_inst = mii->mii_instance;
136 sc->mii_phy = ma->mii_phyno;
137 sc->mii_funcs = &rlphy_funcs;
138 sc->mii_pdata = mii;
139 sc->mii_flags = ma->mii_flags;
140
141 sc->mii_flags |= MIIF_NOISOLATE;
142
143 mii_lock(mii);
144
145 PHY_RESET(sc);
146
147 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
148 sc->mii_capabilities &= ma->mii_capmask;
149
150 mii_unlock(mii);
151
152 mii_phy_add_media(sc);
153 }
154
155 static int
rlphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)156 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
157 {
158 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
159
160 /* Can't isolate the RTL8139 phy, so it has to be the only one. */
161 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
162 panic("rlphy_service: attempt to isolate phy");
163
164 KASSERT(mii_locked(mii));
165
166 switch (cmd) {
167 case MII_POLLSTAT:
168 break;
169
170 case MII_MEDIACHG:
171 /* If the interface is not up, don't do anything. */
172 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
173 break;
174
175 mii_phy_setmedia(sc);
176 break;
177
178 case MII_TICK:
179 /* Is the interface even up? */
180 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
181 return 0;
182
183 /* Only used for autonegotiation. */
184 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
185 break;
186
187 /*
188 * The RealTek PHY's autonegotiation doesn't need to be
189 * kicked; it continues in the background.
190 */
191 break;
192
193 case MII_DOWN:
194 mii_phy_down(sc);
195 return 0;
196 }
197
198 /* Update the media status. */
199 mii_phy_status(sc);
200
201 /* Callback if something changed. */
202 mii_phy_update(sc, cmd);
203 return 0;
204 }
205
206 static void
rlphy_status(struct mii_softc * sc)207 rlphy_status(struct mii_softc *sc)
208 {
209 struct rlphy_softc *rsc = (void *)sc;
210 struct mii_data *mii = sc->mii_pdata;
211 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
212 uint16_t bmsr, bmcr, anar, anlpar, result, reg;
213
214 KASSERT(mii_locked(mii));
215
216 mii->mii_media_status = IFM_AVALID;
217 mii->mii_media_active = IFM_ETHER;
218
219 PHY_READ(sc, MII_BMSR, &bmsr);
220 PHY_READ(sc, MII_BMSR, &bmsr);
221 if (bmsr & BMSR_LINK)
222 mii->mii_media_status |= IFM_ACTIVE;
223
224 PHY_READ(sc, MII_BMCR, &bmcr);
225 if (bmcr & BMCR_ISO) {
226 mii->mii_media_active |= IFM_NONE;
227 mii->mii_media_status = 0;
228 return;
229 }
230
231 if (bmcr & BMCR_LOOP)
232 mii->mii_media_active |= IFM_LOOP;
233
234 if (bmcr & BMCR_AUTOEN) {
235 /*
236 * NWay autonegotiation takes the highest-order common
237 * bit of the ANAR and ANLPAR (i.e. best media advertised
238 * both by us and our link partner).
239 */
240 if ((bmsr & BMSR_ACOMP) == 0) {
241 /* Erg, still trying, I guess... */
242 mii->mii_media_active |= IFM_NONE;
243 return;
244 }
245
246 PHY_READ(sc, MII_ANAR, &anar);
247 PHY_READ(sc, MII_ANLPAR, &anlpar);
248 result = anar & anlpar;
249 if (result != 0) {
250 if (result & ANLPAR_TX_FD)
251 mii->mii_media_active |= IFM_100_TX | IFM_FDX;
252 else if (result & ANLPAR_T4)
253 mii->mii_media_active |= IFM_100_T4 | IFM_HDX;
254 else if (result & ANLPAR_TX)
255 mii->mii_media_active |= IFM_100_TX | IFM_HDX;
256 else if (result & ANLPAR_10_FD)
257 mii->mii_media_active |= IFM_10_T | IFM_FDX;
258 else if (result & ANLPAR_10)
259 mii->mii_media_active |= IFM_10_T | IFM_HDX;
260 else
261 mii->mii_media_active |= IFM_NONE;
262 return;
263 }
264
265 /*
266 * If the other side doesn't support NWAY, then the
267 * best we can do is determine if we have a 10Mbps or
268 * 100Mbps link. There's no way to know if the link
269 * is full or half duplex, so we default to half duplex
270 * and hope that the user is clever enough to manually
271 * change the media settings if we're wrong.
272 */
273
274 /*
275 * The RealTek PHY supports non-NWAY link speed
276 * detection, however it does not report the link
277 * detection results via the ANLPAR or BMSR registers.
278 * (What? RealTek doesn't do things the way everyone
279 * else does? I'm just shocked, shocked I tell you.)
280 * To determine the link speed, we have to do one
281 * of two things:
282 *
283 * - If this is a standalone RealTek RTL8201 PHY,
284 * we can determine the link speed by testing bit 0
285 * in the magic, vendor-specific register at offset
286 * 0x19.
287 *
288 * - If this is a RealTek MAC with integrated PHY, we
289 * can test the 'SPEED10' bit of the MAC's media status
290 * register.
291 */
292 if (rsc->sc_rtl8201) {
293 PHY_READ(sc, 0x0019, ®);
294 if (reg & 0x01)
295 mii->mii_media_active |= IFM_100_TX;
296 else
297 mii->mii_media_active |= IFM_10_T;
298 } else {
299 PHY_READ(sc, RTK_MEDIASTAT, ®);
300 if (reg & RTK_MEDIASTAT_SPEED10)
301 mii->mii_media_active |= IFM_10_T;
302 else
303 mii->mii_media_active |= IFM_100_TX;
304 }
305 mii->mii_media_active |= IFM_HDX;
306 } else
307 mii->mii_media_active = ife->ifm_media;
308 }
309
310 static void
rlphy_reset(struct mii_softc * sc)311 rlphy_reset(struct mii_softc *sc)
312 {
313
314 KASSERT(mii_locked(sc->mii_pdata));
315
316 mii_phy_reset(sc);
317
318 /*
319 * XXX RealTek PHY doesn't set the BMCR properly after
320 * XXX reset, which breaks autonegotiation.
321 */
322 PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN);
323 }
324