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: releng/11.0/sys/dev/mii/rlphy.c 277093 2015-01-12 22:27:38Z glebius $");
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#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
61static int rlphy_probe(device_t);
62static int rlphy_attach(device_t);
63
64static 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
73static devclass_t rlphy_devclass;
74
75static driver_t rlphy_driver = {
76	"rlphy",
77	rlphy_methods,
78	sizeof(struct mii_softc)
79};
80
81DRIVER_MODULE(rlphy, miibus, rlphy_driver, rlphy_devclass, 0, 0);
82
83static int	rlphy_service(struct mii_softc *, struct mii_data *, int);
84static void	rlphy_status(struct mii_softc *);
85
86/*
87 * RealTek internal PHYs don't have vendor/device ID registers;
88 * re(4) and rl(4) fake up a return value of all zeros.
89 */
90static const struct mii_phydesc rlintphys[] = {
91	{ 0, 0, "RealTek internal media interface" },
92	MII_PHY_END
93};
94
95static const struct mii_phydesc rlphys[] = {
96	MII_PHY_DESC(yyREALTEK, RTL8201L),
97	MII_PHY_DESC(REALTEK, RTL8201E),
98	MII_PHY_DESC(xxICPLUS, IP101),
99	MII_PHY_END
100};
101
102static const struct mii_phy_funcs rlphy_funcs = {
103	rlphy_service,
104	rlphy_status,
105	mii_phy_reset
106};
107
108static int
109rlphy_probe(device_t dev)
110{
111	int rv;
112
113	rv = mii_phy_dev_probe(dev, rlphys, BUS_PROBE_DEFAULT);
114	if (rv <= 0)
115		return (rv);
116
117	if (mii_dev_mac_match(dev, "rl") || mii_dev_mac_match(dev, "re"))
118		return (mii_phy_dev_probe(dev, rlintphys, BUS_PROBE_DEFAULT));
119	return (ENXIO);
120}
121
122static int
123rlphy_attach(device_t dev)
124{
125
126	/*
127	 * The RealTek PHY can never be isolated.
128	 */
129	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
130	    &rlphy_funcs, 1);
131	return (0);
132}
133
134static int
135rlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
136{
137
138	switch (cmd) {
139	case MII_POLLSTAT:
140		break;
141
142	case MII_MEDIACHG:
143		mii_phy_setmedia(sc);
144		break;
145
146	case MII_TICK:
147		/*
148		 * The RealTek PHY's autonegotiation doesn't need to be
149		 * kicked; it continues in the background.
150		 */
151		break;
152	}
153
154	/* Update the media status. */
155	PHY_STATUS(sc);
156
157	/* Callback if something changed. */
158	mii_phy_update(sc, cmd);
159	return (0);
160}
161
162static void
163rlphy_status(struct mii_softc *phy)
164{
165	struct mii_data *mii = phy->mii_pdata;
166	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
167	int bmsr, bmcr, anlpar;
168
169	mii->mii_media_status = IFM_AVALID;
170	mii->mii_media_active = IFM_ETHER;
171
172	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
173	if (bmsr & BMSR_LINK)
174		mii->mii_media_status |= IFM_ACTIVE;
175
176	bmcr = PHY_READ(phy, MII_BMCR);
177	if (bmcr & BMCR_ISO) {
178		mii->mii_media_active |= IFM_NONE;
179		mii->mii_media_status = 0;
180		return;
181	}
182
183	if (bmcr & BMCR_LOOP)
184		mii->mii_media_active |= IFM_LOOP;
185
186	if (bmcr & BMCR_AUTOEN) {
187		/*
188		 * NWay autonegotiation takes the highest-order common
189		 * bit of the ANAR and ANLPAR (i.e. best media advertised
190		 * both by us and our link partner).
191		 */
192		if ((bmsr & BMSR_ACOMP) == 0) {
193			/* Erg, still trying, I guess... */
194			mii->mii_media_active |= IFM_NONE;
195			return;
196		}
197
198		if ((anlpar = PHY_READ(phy, MII_ANAR) &
199		    PHY_READ(phy, MII_ANLPAR))) {
200			if (anlpar & ANLPAR_TX_FD)
201				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
202			else if (anlpar & ANLPAR_T4)
203				mii->mii_media_active |= IFM_100_T4|IFM_HDX;
204			else if (anlpar & ANLPAR_TX)
205				mii->mii_media_active |= IFM_100_TX|IFM_HDX;
206			else if (anlpar & ANLPAR_10_FD)
207				mii->mii_media_active |= IFM_10_T|IFM_FDX;
208			else if (anlpar & ANLPAR_10)
209				mii->mii_media_active |= IFM_10_T|IFM_HDX;
210			else
211				mii->mii_media_active |= IFM_NONE;
212			if ((mii->mii_media_active & IFM_FDX) != 0)
213				mii->mii_media_active |=
214				    mii_phy_flowstatus(phy);
215			return;
216		}
217		/*
218		 * If the other side doesn't support NWAY, then the
219		 * best we can do is determine if we have a 10Mbps or
220		 * 100Mbps link. There's no way to know if the link
221		 * is full or half duplex, so we default to half duplex
222		 * and hope that the user is clever enough to manually
223		 * change the media settings if we're wrong.
224		 */
225
226		/*
227		 * The RealTek PHY supports non-NWAY link speed
228		 * detection, however it does not report the link
229		 * detection results via the ANLPAR or BMSR registers.
230		 * (What? RealTek doesn't do things the way everyone
231		 * else does? I'm just shocked, shocked I tell you.)
232		 * To determine the link speed, we have to do one
233		 * of two things:
234		 *
235		 * - If this is a standalone RealTek RTL8201(L) or
236		 *   workalike PHY, we can determine the link speed by
237		 *   testing bit 0 in the magic, vendor-specific register
238		 *   at offset 0x19.
239		 *
240		 * - If this is a RealTek MAC with integrated PHY, we
241		 *   can test the 'SPEED10' bit of the MAC's media status
242		 *   register.
243		 */
244		if (!(phy->mii_mpd_model == 0 && phy->mii_mpd_rev == 0)) {
245			if (PHY_READ(phy, 0x0019) & 0x01)
246				mii->mii_media_active |= IFM_100_TX;
247			else
248				mii->mii_media_active |= IFM_10_T;
249		} else {
250			if (PHY_READ(phy, RL_MEDIASTAT) &
251			    RL_MEDIASTAT_SPEED10)
252				mii->mii_media_active |= IFM_10_T;
253			else
254				mii->mii_media_active |= IFM_100_TX;
255		}
256		mii->mii_media_active |= IFM_HDX;
257	} else
258		mii->mii_media_active = ife->ifm_media;
259}
260