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