jmphy.c revision 215298
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 215298 2010-11-14 13:31:01Z 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_setmedia(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_flags = miibus_get_flags(dev);
116	sc->mii_inst = mii->mii_instance++;
117	sc->mii_phy = ma->mii_phyno;
118	sc->mii_service = jmphy_service;
119	sc->mii_pdata = mii;
120
121	jsc->mii_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
122	jsc->mii_model = MII_MODEL(ma->mii_id2);
123	jsc->mii_rev = MII_REV(ma->mii_id2);
124	if (bootverbose)
125		device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
126		    jsc->mii_oui, jsc->mii_model, jsc->mii_rev);
127
128	jmphy_reset(sc);
129
130	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
131	if (sc->mii_capabilities & BMSR_EXTSTAT)
132		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
133	device_printf(dev, " ");
134	mii_phy_add_media(sc);
135	printf("\n");
136
137	MIIBUS_MEDIAINIT(sc->mii_dev);
138	return (0);
139}
140
141static int
142jmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
143{
144	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
145
146	switch (cmd) {
147	case MII_POLLSTAT:
148		break;
149
150	case MII_MEDIACHG:
151		/*
152		 * If the interface is not up, don't do anything.
153		 */
154		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
155			break;
156
157		if (jmphy_setmedia(sc, ife) != EJUSTRETURN)
158			return (EINVAL);
159		break;
160
161	case MII_TICK:
162		/*
163		 * Is the interface even up?
164		 */
165		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
166			return (0);
167
168		/*
169		 * Only used for autonegotiation.
170		 */
171		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
172			sc->mii_ticks = 0;
173			break;
174		}
175
176		/* Check for link. */
177		if ((PHY_READ(sc, JMPHY_SSR) & JMPHY_SSR_LINK_UP) != 0) {
178			sc->mii_ticks = 0;
179			break;
180		}
181
182		/* Announce link loss right after it happens. */
183		if (sc->mii_ticks++ == 0)
184			break;
185		if (sc->mii_ticks <= sc->mii_anegticks)
186			return (0);
187
188		sc->mii_ticks = 0;
189		(void)jmphy_setmedia(sc, ife);
190		break;
191	}
192
193	/* Update the media status. */
194	jmphy_status(sc);
195
196	/* Callback if something changed. */
197	mii_phy_update(sc, cmd);
198	return (0);
199}
200
201static void
202jmphy_status(struct mii_softc *sc)
203{
204	struct mii_data *mii = sc->mii_pdata;
205	int bmcr, ssr;
206
207	mii->mii_media_status = IFM_AVALID;
208	mii->mii_media_active = IFM_ETHER;
209
210	ssr = PHY_READ(sc, JMPHY_SSR);
211	if ((ssr & JMPHY_SSR_LINK_UP) != 0)
212		mii->mii_media_status |= IFM_ACTIVE;
213
214	bmcr = PHY_READ(sc, MII_BMCR);
215	if ((bmcr & BMCR_ISO) != 0) {
216		mii->mii_media_active |= IFM_NONE;
217		mii->mii_media_status = 0;
218		return;
219	}
220
221	if ((bmcr & BMCR_LOOP) != 0)
222		mii->mii_media_active |= IFM_LOOP;
223
224	if ((ssr & JMPHY_SSR_SPD_DPLX_RESOLVED) == 0) {
225		/* Erg, still trying, I guess... */
226		mii->mii_media_active |= IFM_NONE;
227		return;
228	}
229
230	switch ((ssr & JMPHY_SSR_SPEED_MASK)) {
231	case JMPHY_SSR_SPEED_1000:
232		mii->mii_media_active |= IFM_1000_T;
233		/*
234		 * jmphy(4) got a valid link so reset mii_ticks.
235		 * Resetting mii_ticks is needed in order to
236		 * detect link loss after auto-negotiation.
237		 */
238		sc->mii_ticks = 0;
239		break;
240	case JMPHY_SSR_SPEED_100:
241		mii->mii_media_active |= IFM_100_TX;
242		sc->mii_ticks = 0;
243		break;
244	case JMPHY_SSR_SPEED_10:
245		mii->mii_media_active |= IFM_10_T;
246		sc->mii_ticks = 0;
247		break;
248	default:
249		mii->mii_media_active |= IFM_NONE;
250		return;
251	}
252
253	if ((ssr & JMPHY_SSR_DUPLEX) != 0)
254		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
255	else
256		mii->mii_media_active |= IFM_HDX;
257
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}
263
264static void
265jmphy_reset(struct mii_softc *sc)
266{
267	struct jmphy_softc *jsc;
268	int i;
269
270	jsc = (struct jmphy_softc *)sc;
271
272	/* Disable sleep mode. */
273	PHY_WRITE(sc, JMPHY_TMCTL,
274	    PHY_READ(sc, JMPHY_TMCTL) & ~JMPHY_TMCTL_SLEEP_ENB);
275	PHY_WRITE(sc, MII_BMCR, BMCR_RESET | BMCR_AUTOEN);
276
277	for (i = 0; i < 1000; i++) {
278		DELAY(1);
279		if ((PHY_READ(sc, MII_BMCR) & BMCR_RESET) == 0)
280			break;
281	}
282}
283
284static uint16_t
285jmphy_anar(struct ifmedia_entry *ife)
286{
287	uint16_t anar;
288
289	anar = 0;
290	switch (IFM_SUBTYPE(ife->ifm_media)) {
291	case IFM_AUTO:
292		anar |= ANAR_TX_FD | ANAR_TX | ANAR_10_FD | ANAR_10;
293		break;
294	case IFM_1000_T:
295		break;
296	case IFM_100_TX:
297		anar |= ANAR_TX | ANAR_TX_FD;
298		break;
299	case IFM_10_T:
300		anar |= ANAR_10 | ANAR_10_FD;
301		break;
302	default:
303		break;
304	}
305
306	return (anar);
307}
308
309static int
310jmphy_setmedia(struct mii_softc *sc, struct ifmedia_entry *ife)
311{
312	uint16_t anar, bmcr, gig;
313
314	gig = 0;
315	bmcr = PHY_READ(sc, MII_BMCR);
316	switch (IFM_SUBTYPE(ife->ifm_media)) {
317	case IFM_AUTO:
318		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
319		break;
320	case IFM_1000_T:
321		gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
322		break;
323	case IFM_100_TX:
324	case IFM_10_T:
325		break;
326	case IFM_NONE:
327		PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO | BMCR_PDOWN);
328		return (EJUSTRETURN);
329	default:
330		return (EINVAL);
331	}
332
333	if ((ife->ifm_media & IFM_LOOP) != 0)
334		bmcr |= BMCR_LOOP;
335
336	anar = jmphy_anar(ife);
337	if (((IFM_SUBTYPE(ife->ifm_media) == IFM_AUTO ||
338	    (ife->ifm_media & IFM_FDX) != 0) &&
339	    (ife->ifm_media & IFM_FLOW) != 0) ||
340	    (sc->mii_flags & MIIF_FORCEPAUSE) != 0)
341		anar |= ANAR_PAUSE_TOWARDS;
342
343	if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
344		if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
345			gig |= GTCR_MAN_MS;
346			if ((ife->ifm_media & IFM_ETH_MASTER) != 0)
347				gig |= GTCR_ADV_MS;
348		}
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