jmphy.c revision 213364
1/*-
2 * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org>
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 unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: head/sys/dev/mii/jmphy.c 213364 2010-10-02 18:53:12Z marius $");
30
31/*
32 * Driver for the JMicron JMP211 10/100/1000, JMP202 10/100 PHY.
33 */
34
35#include <sys/param.h>
36#include <sys/systm.h>
37#include <sys/kernel.h>
38#include <sys/module.h>
39#include <sys/socket.h>
40#include <sys/bus.h>
41
42#include <net/if.h>
43#include <net/if_media.h>
44
45#include <dev/mii/mii.h>
46#include <dev/mii/miivar.h>
47#include "miidevs.h"
48
49#include <dev/mii/jmphyreg.h>
50
51#include "miibus_if.h"
52
53static int 	jmphy_probe(device_t);
54static int 	jmphy_attach(device_t);
55static void	jmphy_reset(struct mii_softc *);
56static uint16_t	jmphy_anar(struct ifmedia_entry *);
57static int	jmphy_auto(struct mii_softc *, struct ifmedia_entry *);
58
59struct jmphy_softc {
60	struct mii_softc mii_sc;
61	int mii_oui;
62	int mii_model;
63	int mii_rev;
64};
65
66static device_method_t jmphy_methods[] = {
67	/* Device interface. */
68	DEVMETHOD(device_probe,		jmphy_probe),
69	DEVMETHOD(device_attach,	jmphy_attach),
70	DEVMETHOD(device_detach,	mii_phy_detach),
71	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
72	{ NULL, NULL }
73};
74
75static devclass_t jmphy_devclass;
76static driver_t jmphy_driver = {
77	"jmphy",
78	jmphy_methods,
79	sizeof(struct jmphy_softc)
80};
81
82DRIVER_MODULE(jmphy, miibus, jmphy_driver, jmphy_devclass, 0, 0);
83
84static int	jmphy_service(struct mii_softc *, struct mii_data *, int);
85static void	jmphy_status(struct mii_softc *);
86
87static const struct mii_phydesc jmphys[] = {
88	MII_PHY_DESC(JMICRON, JMP202),
89	MII_PHY_DESC(JMICRON, JMP211),
90	MII_PHY_END
91};
92
93static int
94jmphy_probe(device_t dev)
95{
96
97	return (mii_phy_dev_probe(dev, jmphys, BUS_PROBE_DEFAULT));
98}
99
100static int
101jmphy_attach(device_t dev)
102{
103	struct jmphy_softc *jsc;
104	struct mii_softc *sc;
105	struct mii_attach_args *ma;
106	struct mii_data *mii;
107
108	jsc = device_get_softc(dev);
109	sc = &jsc->mii_sc;
110	ma = device_get_ivars(dev);
111	sc->mii_dev = device_get_parent(dev);
112	mii = ma->mii_data;
113	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
114
115	sc->mii_inst = mii->mii_instance++;
116	sc->mii_phy = ma->mii_phyno;
117	sc->mii_service = jmphy_service;
118	sc->mii_pdata = mii;
119
120	jsc->mii_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
121	jsc->mii_model = MII_MODEL(ma->mii_id2);
122	jsc->mii_rev = MII_REV(ma->mii_id2);
123	if (bootverbose)
124		device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
125		    jsc->mii_oui, jsc->mii_model, jsc->mii_rev);
126
127	jmphy_reset(sc);
128
129	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
130	if (sc->mii_capabilities & BMSR_EXTSTAT)
131		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
132	device_printf(dev, " ");
133	mii_phy_add_media(sc);
134	printf("\n");
135
136	MIIBUS_MEDIAINIT(sc->mii_dev);
137	return (0);
138}
139
140static int
141jmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
142{
143	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
144
145	switch (cmd) {
146	case MII_POLLSTAT:
147		break;
148
149	case MII_MEDIACHG:
150		/*
151		 * If the interface is not up, don't do anything.
152		 */
153		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
154			break;
155
156		if (jmphy_auto(sc, ife) != EJUSTRETURN)
157			return (EINVAL);
158		break;
159
160	case MII_TICK:
161		/*
162		 * Is the interface even up?
163		 */
164		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
165			return (0);
166
167		/*
168		 * Only used for autonegotiation.
169		 */
170		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
171			sc->mii_ticks = 0;
172			break;
173		}
174
175		/* Check for link. */
176		if ((PHY_READ(sc, JMPHY_SSR) & JMPHY_SSR_LINK_UP) != 0) {
177			sc->mii_ticks = 0;
178			break;
179		}
180
181		/* Announce link loss right after it happens. */
182		if (sc->mii_ticks++ == 0)
183			break;
184		if (sc->mii_ticks <= sc->mii_anegticks)
185			return (0);
186
187		sc->mii_ticks = 0;
188		jmphy_auto(sc, ife);
189		break;
190	}
191
192	/* Update the media status. */
193	jmphy_status(sc);
194
195	/* Callback if something changed. */
196	mii_phy_update(sc, cmd);
197	return (0);
198}
199
200static void
201jmphy_status(struct mii_softc *sc)
202{
203	struct mii_data *mii = sc->mii_pdata;
204	int bmcr, ssr;
205
206	mii->mii_media_status = IFM_AVALID;
207	mii->mii_media_active = IFM_ETHER;
208
209	ssr = PHY_READ(sc, JMPHY_SSR);
210	if ((ssr & JMPHY_SSR_LINK_UP) != 0)
211		mii->mii_media_status |= IFM_ACTIVE;
212
213	bmcr = PHY_READ(sc, MII_BMCR);
214	if ((bmcr & BMCR_ISO) != 0) {
215		mii->mii_media_active |= IFM_NONE;
216		mii->mii_media_status = 0;
217		return;
218	}
219
220	if ((bmcr & BMCR_LOOP) != 0)
221		mii->mii_media_active |= IFM_LOOP;
222
223	if ((ssr & JMPHY_SSR_SPD_DPLX_RESOLVED) == 0) {
224		/* Erg, still trying, I guess... */
225		mii->mii_media_active |= IFM_NONE;
226		return;
227	}
228
229	switch ((ssr & JMPHY_SSR_SPEED_MASK)) {
230	case JMPHY_SSR_SPEED_1000:
231		mii->mii_media_active |= IFM_1000_T;
232		/*
233		 * jmphy(4) got a valid link so reset mii_ticks.
234		 * Resetting mii_ticks is needed in order to
235		 * detect link loss after auto-negotiation.
236		 */
237		sc->mii_ticks = 0;
238		break;
239	case JMPHY_SSR_SPEED_100:
240		mii->mii_media_active |= IFM_100_TX;
241		sc->mii_ticks = 0;
242		break;
243	case JMPHY_SSR_SPEED_10:
244		mii->mii_media_active |= IFM_10_T;
245		sc->mii_ticks = 0;
246		break;
247	default:
248		mii->mii_media_active |= IFM_NONE;
249		return;
250	}
251
252	if ((ssr & JMPHY_SSR_DUPLEX) != 0)
253		mii->mii_media_active |= IFM_FDX;
254	else
255		mii->mii_media_active |= IFM_HDX;
256	/* XXX Flow-control. */
257#ifdef notyet
258	if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) {
259		if ((PHY_READ(sc, MII_100T2SR) & GTSR_MS_RES) != 0)
260			mii->mii_media_active |= IFM_ETH_MASTER;
261	}
262#endif
263}
264
265static void
266jmphy_reset(struct mii_softc *sc)
267{
268	struct jmphy_softc *jsc;
269	int i;
270
271	jsc = (struct jmphy_softc *)sc;
272
273	/* Disable sleep mode. */
274	PHY_WRITE(sc, JMPHY_TMCTL,
275	    PHY_READ(sc, JMPHY_TMCTL) & ~JMPHY_TMCTL_SLEEP_ENB);
276	PHY_WRITE(sc, MII_BMCR, BMCR_RESET | BMCR_AUTOEN);
277
278	for (i = 0; i < 1000; i++) {
279		DELAY(1);
280		if ((PHY_READ(sc, MII_BMCR) & BMCR_RESET) == 0)
281			break;
282	}
283}
284
285static uint16_t
286jmphy_anar(struct ifmedia_entry *ife)
287{
288	uint16_t anar;
289
290	anar = 0;
291	switch (IFM_SUBTYPE(ife->ifm_media)) {
292	case IFM_AUTO:
293		anar |= ANAR_TX_FD | ANAR_TX | ANAR_10_FD | ANAR_10;
294		break;
295	case IFM_1000_T:
296		break;
297	case IFM_100_TX:
298		anar |= ANAR_TX | ANAR_TX_FD;
299		break;
300	case IFM_10_T:
301		anar |= ANAR_10 | ANAR_10_FD;
302		break;
303	default:
304		break;
305	}
306
307	return (anar);
308}
309
310static int
311jmphy_auto(struct mii_softc *sc, struct ifmedia_entry *ife)
312{
313	uint16_t anar, bmcr, gig;
314
315	gig = 0;
316	bmcr = PHY_READ(sc, MII_BMCR);
317	switch (IFM_SUBTYPE(ife->ifm_media)) {
318	case IFM_AUTO:
319		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
320		break;
321	case IFM_1000_T:
322		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
323		break;
324	case IFM_100_TX:
325	case IFM_10_T:
326		break;
327	case IFM_NONE:
328		PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO | BMCR_PDOWN);
329		return (EJUSTRETURN);
330	default:
331		return (EINVAL);
332	}
333
334	if ((ife->ifm_media & IFM_LOOP) != 0)
335		bmcr |= BMCR_LOOP;
336
337	anar = jmphy_anar(ife);
338	/* XXX Always advertise pause capability. */
339	anar |= (3 << 10);
340
341	if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
342#ifdef notyet
343		struct mii_data *mii;
344
345		mii = sc->mii_pdata;
346		if ((mii->mii_media.ifm_media & IFM_ETH_MASTER) != 0)
347			gig |= GTCR_MAN_MS | GTCR_MAN_ADV;
348#endif
349		PHY_WRITE(sc, MII_100T2CR, gig);
350	}
351	PHY_WRITE(sc, MII_ANAR, anar | ANAR_CSMA);
352	PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_AUTOEN | BMCR_STARTNEG);
353
354	return (EJUSTRETURN);
355}
356