1 /*-
2 * SPDX-License-Identifier: BSD-4-Clause
3 *
4 * Copyright (c) 1997, 1998, 1999
5 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Bill Paul.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #include <sys/cdefs.h>
36 /*
37 * driver for RealTek 8139 internal PHYs
38 */
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/module.h>
44 #include <sys/socket.h>
45 #include <sys/bus.h>
46 #include <sys/taskqueue.h> /* XXXGL: if_rlreg.h contamination */
47
48 #include <net/if.h>
49 #include <net/if_arp.h>
50 #include <net/if_media.h>
51
52 #include <dev/mii/mii.h>
53 #include <dev/mii/miivar.h>
54 #include "miidevs.h"
55
56 #include <machine/bus.h>
57 #include <dev/rl/if_rlreg.h>
58
59 #include "miibus_if.h"
60
61 static int rlphy_probe(device_t);
62 static int rlphy_attach(device_t);
63
64 static device_method_t rlphy_methods[] = {
65 /* device interface */
66 DEVMETHOD(device_probe, rlphy_probe),
67 DEVMETHOD(device_attach, rlphy_attach),
68 DEVMETHOD(device_detach, mii_phy_detach),
69 DEVMETHOD(device_shutdown, bus_generic_shutdown),
70 DEVMETHOD_END
71 };
72
73 static driver_t rlphy_driver = {
74 "rlphy",
75 rlphy_methods,
76 sizeof(struct mii_softc)
77 };
78
79 DRIVER_MODULE(rlphy, miibus, rlphy_driver, 0, 0);
80
81 static int rlphy_service(struct mii_softc *, struct mii_data *, int);
82 static void rlphy_status(struct mii_softc *);
83
84 /*
85 * RealTek internal PHYs don't have vendor/device ID registers;
86 * re(4) and rl(4) fake up a return value of all zeros.
87 */
88 static const struct mii_phydesc rlintphys[] = {
89 { 0, 0, "RealTek internal media interface" },
90 MII_PHY_END
91 };
92
93 static const struct mii_phydesc rlphys[] = {
94 MII_PHY_DESC(yyREALTEK, RTL8201L),
95 MII_PHY_DESC(REALTEK, RTL8201E),
96 MII_PHY_DESC(xxICPLUS, IP101),
97 MII_PHY_END
98 };
99
100 static const struct mii_phy_funcs rlphy_funcs = {
101 rlphy_service,
102 rlphy_status,
103 mii_phy_reset
104 };
105
106 static int
rlphy_probe(device_t dev)107 rlphy_probe(device_t dev)
108 {
109 int rv;
110
111 rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT);
112 if (rv <= 0)
113 return (rv);
114
115 if (mii_dev_mac_match(dev, "rl") || mii_dev_mac_match(dev, "re"))
116 return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT));
117 return (ENXIO);
118 }
119
120 static int
rlphy_attach(device_t dev)121 rlphy_attach(device_t dev)
122 {
123
124 /*
125 * The RealTek PHY can never be isolated.
126 */
127 mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
128 &rlphy_funcs, 1);
129 return (0);
130 }
131
132 static int
rlphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)133 rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
134 {
135
136 switch (cmd) {
137 case MII_POLLSTAT:
138 break;
139
140 case MII_MEDIACHG:
141 mii_phy_setmedia(sc);
142 break;
143
144 case MII_TICK:
145 /*
146 * The RealTek PHY's autonegotiation doesn't need to be
147 * kicked; it continues in the background.
148 */
149 break;
150 }
151
152 /* Update the media status. */
153 PHY_STATUS(sc);
154
155 /* Callback if something changed. */
156 mii_phy_update(sc, cmd);
157 return (0);
158 }
159
160 static void
rlphy_status(struct mii_softc * phy)161 rlphy_status(struct mii_softc *phy)
162 {
163 struct mii_data *mii = phy->mii_pdata;
164 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
165 int bmsr, bmcr, anlpar;
166
167 mii->mii_media_status = IFM_AVALID;
168 mii->mii_media_active = IFM_ETHER;
169
170 bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
171 if (bmsr & BMSR_LINK)
172 mii->mii_media_status |= IFM_ACTIVE;
173
174 bmcr = PHY_READ(phy, MII_BMCR);
175 if (bmcr & BMCR_ISO) {
176 mii->mii_media_active |= IFM_NONE;
177 mii->mii_media_status = 0;
178 return;
179 }
180
181 if (bmcr & BMCR_LOOP)
182 mii->mii_media_active |= IFM_LOOP;
183
184 if (bmcr & BMCR_AUTOEN) {
185 /*
186 * NWay autonegotiation takes the highest-order common
187 * bit of the ANAR and ANLPAR (i.e. best media advertised
188 * both by us and our link partner).
189 */
190 if ((bmsr & BMSR_ACOMP) == 0) {
191 /* Erg, still trying, I guess... */
192 mii->mii_media_active |= IFM_NONE;
193 return;
194 }
195
196 if ((anlpar = PHY_READ(phy, MII_ANAR) &
197 PHY_READ(phy, MII_ANLPAR))) {
198 if (anlpar & ANLPAR_TX_FD)
199 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
200 else if (anlpar & ANLPAR_T4)
201 mii->mii_media_active |= IFM_100_T4|IFM_HDX;
202 else if (anlpar & ANLPAR_TX)
203 mii->mii_media_active |= IFM_100_TX|IFM_HDX;
204 else if (anlpar & ANLPAR_10_FD)
205 mii->mii_media_active |= IFM_10_T|IFM_FDX;
206 else if (anlpar & ANLPAR_10)
207 mii->mii_media_active |= IFM_10_T|IFM_HDX;
208 else
209 mii->mii_media_active |= IFM_NONE;
210 if ((mii->mii_media_active & IFM_FDX) != 0)
211 mii->mii_media_active |=
212 mii_phy_flowstatus(phy);
213 return;
214 }
215 /*
216 * If the other side doesn't support NWAY, then the
217 * best we can do is determine if we have a 10Mbps or
218 * 100Mbps link. There's no way to know if the link
219 * is full or half duplex, so we default to half duplex
220 * and hope that the user is clever enough to manually
221 * change the media settings if we're wrong.
222 */
223
224 /*
225 * The RealTek PHY supports non-NWAY link speed
226 * detection, however it does not report the link
227 * detection results via the ANLPAR or BMSR registers.
228 * (What? RealTek doesn't do things the way everyone
229 * else does? I'm just shocked, shocked I tell you.)
230 * To determine the link speed, we have to do one
231 * of two things:
232 *
233 * - If this is a standalone RealTek RTL8201(L) or
234 * workalike PHY, we can determine the link speed by
235 * testing bit 0 in the magic, vendor-specific register
236 * at offset 0x19.
237 *
238 * - If this is a RealTek MAC with integrated PHY, we
239 * can test the 'SPEED10' bit of the MAC's media status
240 * register.
241 */
242 if (!(phy->mii_mpd_model == 0 && phy->mii_mpd_rev == 0)) {
243 if (PHY_READ(phy, 0x0019) & 0x01)
244 mii->mii_media_active |= IFM_100_TX;
245 else
246 mii->mii_media_active |= IFM_10_T;
247 } else {
248 if (PHY_READ(phy, RL_MEDIASTAT) &
249 RL_MEDIASTAT_SPEED10)
250 mii->mii_media_active |= IFM_10_T;
251 else
252 mii->mii_media_active |= IFM_100_TX;
253 }
254 mii->mii_media_active |= IFM_HDX;
255 } else
256 mii->mii_media_active = ife->ifm_media;
257 }
258