tdkphy.c revision 164830
1/*-
2 * Copyright (c) 2000,2001 Jonathan Chen.
3 * 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 *    without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in
13 *    the documentation and/or other materials provided with the
14 *    distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD: head/sys/dev/mii/tdkphy.c 164830 2006-12-02 19:36:25Z marius $");
31
32/*
33 * Driver for the TDK 78Q2120 MII
34 *
35 * References:
36 *   Datasheet for the 78Q2120 - http://www.tsc.tdk.com/lan/78q2120.pdf
37 *   Most of this code stolen from ukphy.c
38 */
39
40/*
41 * The TDK 78Q2120 is found on some Xircom X3201 based cardbus cards,
42 * also spotted on some 3C575 cards.  It's just like any other normal
43 * phy, except it does auto negotiation in a different way.
44 */
45
46#include <sys/param.h>
47#include <sys/systm.h>
48#include <sys/kernel.h>
49#include <sys/socket.h>
50#include <sys/errno.h>
51#include <sys/module.h>
52#include <sys/bus.h>
53
54#include <net/if.h>
55#include <net/if_media.h>
56
57#include <dev/mii/mii.h>
58#include <dev/mii/miivar.h>
59#include "miidevs.h"
60
61#include <dev/mii/tdkphyreg.h>
62
63#include "miibus_if.h"
64
65static int tdkphy_probe(device_t);
66static int tdkphy_attach(device_t);
67
68static device_method_t tdkphy_methods[] = {
69	/* device interface */
70	DEVMETHOD(device_probe,		tdkphy_probe),
71	DEVMETHOD(device_attach,	tdkphy_attach),
72	DEVMETHOD(device_detach,	mii_phy_detach),
73	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74	{ 0, 0 }
75};
76
77static devclass_t tdkphy_devclass;
78
79static driver_t tdkphy_driver = {
80	"tdkphy",
81	tdkphy_methods,
82	sizeof(struct mii_softc)
83};
84
85DRIVER_MODULE(tdkphy, miibus, tdkphy_driver, tdkphy_devclass, 0, 0);
86
87static int tdkphy_service(struct mii_softc *, struct mii_data *, int);
88static void tdkphy_status(struct mii_softc *);
89
90static const struct mii_phydesc tdkphys[] = {
91	MII_PHY_DESC(TDK, 78Q2120),
92	MII_PHY_END
93};
94
95static int
96tdkphy_probe(device_t dev)
97{
98
99	return (mii_phy_dev_probe(dev, tdkphys, BUS_PROBE_DEFAULT));
100}
101
102static int
103tdkphy_attach(device_t dev)
104{
105	struct mii_softc *sc;
106	struct mii_attach_args *ma;
107	struct mii_data *mii;
108	sc = device_get_softc(dev);
109	ma = device_get_ivars(dev);
110	sc->mii_dev = device_get_parent(dev);
111	mii = device_get_softc(sc->mii_dev);
112	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
113
114	if (bootverbose)
115		device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
116		    MII_OUI(ma->mii_id1, ma->mii_id2),
117		    MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
118
119	sc->mii_inst = mii->mii_instance;
120	sc->mii_phy = ma->mii_phyno;
121	sc->mii_service = tdkphy_service;
122	sc->mii_pdata = mii;
123
124	mii->mii_instance++;
125
126	sc->mii_flags |= MIIF_NOISOLATE;
127
128#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
129
130	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
131	    BMCR_ISO);
132#if 0
133	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
134	    BMCR_LOOP|BMCR_S100);
135#endif
136
137	mii_phy_reset(sc);
138
139	sc->mii_capabilities =
140	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
141	device_printf(dev, " ");
142	mii_add_media(sc);
143	printf("\n");
144#undef ADD
145
146	MIIBUS_MEDIAINIT(sc->mii_dev);
147	return (0);
148}
149
150static int
151tdkphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
152{
153	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
154	int reg;
155
156	switch (cmd) {
157	case MII_POLLSTAT:
158		/*
159		 * If we're not polling our PHY instance, just return.
160		 */
161		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
162			return (0);
163		break;
164
165	case MII_MEDIACHG:
166		/*
167		 * If the media indicates a different PHY instance,
168		 * isolate ourselves.
169		 */
170		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
171			reg = PHY_READ(sc, MII_BMCR);
172			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
173			return (0);
174		}
175
176		/*
177		 * If the interface is not up, don't do anything.
178		 */
179		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
180			break;
181
182		switch (IFM_SUBTYPE(ife->ifm_media)) {
183		case IFM_AUTO:
184			/*
185			 * If we're already in auto mode, just return.
186			 */
187			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
188				return (0);
189			(void) mii_phy_auto(sc);
190			break;
191		case IFM_100_T4:
192			/*
193			 * Not supported on MII
194			 */
195			return (EINVAL);
196		default:
197			/*
198			 * BMCR data is stored in the ifmedia entry.
199			 */
200			PHY_WRITE(sc, MII_ANAR,
201			    mii_anar(ife->ifm_media));
202			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
203		}
204		break;
205
206	case MII_TICK:
207		/*
208		 * If we're not currently selected, just return.
209		 */
210		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
211			return (0);
212		if (mii_phy_tick(sc) == EJUSTRETURN)
213			return (0);
214		break;
215	}
216
217	/* Update the media status. */
218	tdkphy_status(sc);
219	if (sc->mii_pdata->mii_media_active & IFM_FDX)
220		PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) | BMCR_FDX);
221	else
222		PHY_WRITE(sc, MII_BMCR, PHY_READ(sc, MII_BMCR) & ~BMCR_FDX);
223
224	/* Callback if something changed. */
225	mii_phy_update(sc, cmd);
226	return (0);
227}
228
229static void
230tdkphy_status(struct mii_softc *phy)
231{
232	struct mii_data *mii = phy->mii_pdata;
233	int bmsr, bmcr, anlpar, diag;
234
235	mii->mii_media_status = IFM_AVALID;
236	mii->mii_media_active = IFM_ETHER;
237
238	bmsr = PHY_READ(phy, MII_BMSR) | PHY_READ(phy, MII_BMSR);
239	if (bmsr & BMSR_LINK)
240		mii->mii_media_status |= IFM_ACTIVE;
241
242	bmcr = PHY_READ(phy, MII_BMCR);
243	if (bmcr & BMCR_ISO) {
244		mii->mii_media_active |= IFM_NONE;
245		mii->mii_media_status = 0;
246		return;
247	}
248
249	if (bmcr & BMCR_LOOP)
250		mii->mii_media_active |= IFM_LOOP;
251
252	if (bmcr & BMCR_AUTOEN) {
253		/*
254		 * NWay autonegotiation takes the highest-order common
255		 * bit of the ANAR and ANLPAR (i.e. best media advertised
256		 * both by us and our link partner).
257		 */
258		if ((bmsr & BMSR_ACOMP) == 0) {
259			/* Erg, still trying, I guess... */
260			mii->mii_media_active |= IFM_NONE;
261			return;
262		}
263
264		anlpar = PHY_READ(phy, MII_ANAR) & PHY_READ(phy, MII_ANLPAR);
265		/*
266		 * ANLPAR doesn't get set on my card, but we check it anyway,
267		 * since it is mentioned in the 78Q2120 specs.
268		 */
269		if (anlpar & ANLPAR_T4)
270			mii->mii_media_active |= IFM_100_T4;
271		else if (anlpar & ANLPAR_TX_FD)
272			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
273		else if (anlpar & ANLPAR_TX)
274			mii->mii_media_active |= IFM_100_TX;
275		else if (anlpar & ANLPAR_10_FD)
276			mii->mii_media_active |= IFM_10_T|IFM_FDX;
277		else if (anlpar & ANLPAR_10)
278			mii->mii_media_active |= IFM_10_T;
279		else {
280			/*
281			 * ANLPAR isn't set, which leaves two possibilities:
282			 * 1) Auto negotiation failed
283			 * 2) Auto negotiation completed, but the card forgot
284			 *    to set ANLPAR.
285			 * So we check the MII_DIAG(18) register...
286			 */
287			diag = PHY_READ(phy, MII_DIAG);
288			if (diag & DIAG_NEGFAIL) /* assume 10baseT if no neg */
289				mii->mii_media_active |= IFM_10_T;
290			else {
291				if (diag & DIAG_DUPLEX)
292					mii->mii_media_active |= IFM_FDX;
293				if (diag & DIAG_RATE_100)
294					mii->mii_media_active |= IFM_100_TX;
295				else
296					mii->mii_media_active |= IFM_10_T;
297			}
298		}
299	} else {
300		mii->mii_media_active = mii_media_from_bmcr(bmcr);
301	}
302}
303