xref: /freebsd/sys/dev/mii/truephy.c (revision 271c3a9060f2ee55607ebe146523f888e1db2654)
1 /*-
2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Sepherosa Ziehau <sepherosa@gmail.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/dev/netif/mii_layer/truephy.c,v 1.3 2008/02/10 07:29:27 sephe Exp $
35  * $FreeBSD$
36  */
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/socket.h>
42 #include <sys/errno.h>
43 #include <sys/module.h>
44 #include <sys/bus.h>
45 
46 #include <net/if.h>
47 #include <net/if_media.h>
48 #include <net/if_arp.h>
49 #include <net/ethernet.h>
50 #include <net/if_vlan_var.h>
51 
52 #include <dev/mii/mii.h>
53 #include <dev/mii/miivar.h>
54 #include "miidevs.h"
55 
56 #include <dev/mii/truephyreg.h>
57 
58 #include "miibus_if.h"
59 
60 #define FRAMELEN(mtu)	(ETHER_HDR_LEN + ETHER_VLAN_ENCAP_LEN + (mtu) + ETHER_CRC_LEN)
61 
62 static int	truephy_service(struct mii_softc *, struct mii_data *, int);
63 static int	truephy_attach(device_t);
64 static int	truephy_probe(device_t);
65 static void	truephy_reset(struct mii_softc *);
66 static void	truephy_status(struct mii_softc *);
67 
68 static device_method_t truephy_methods[] = {
69 	/* device interface */
70 	DEVMETHOD(device_probe,		truephy_probe),
71 	DEVMETHOD(device_attach,	truephy_attach),
72 	DEVMETHOD(device_detach,	mii_phy_detach),
73 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74 	{ 0, 0 }
75 };
76 
77 static const struct mii_phydesc truephys[] = {
78 	MII_PHY_DESC(AGERE,	ET1011C),
79 	MII_PHY_END
80 };
81 
82 static devclass_t truephy_devclass;
83 
84 static driver_t truephy_driver = {
85 	"truephy",
86 	truephy_methods,
87 	sizeof(struct mii_softc)
88 };
89 
90 DRIVER_MODULE(truephy, miibus, truephy_driver, truephy_devclass, 0, 0);
91 
92 static const struct truephy_dsp {
93 	uint16_t	index;
94 	uint16_t	data;
95 } truephy_dspcode[] = {
96 	{ 0x880b,	0x0926 },	/* AfeIfCreg4B1000Msbs */
97 	{ 0x880c,	0x0926 },	/* AfeIfCreg4B100Msbs */
98 	{ 0x880d,	0x0926 },	/* AfeIfCreg4B10Msbs */
99 
100 	{ 0x880e,	0xb4d3 },	/* AfeIfCreg4B1000Lsbs */
101 	{ 0x880f,	0xb4d3 },	/* AfeIfCreg4B100Lsbs */
102 	{ 0x8810,	0xb4d3 },	/* AfeIfCreg4B10Lsbs */
103 
104 	{ 0x8805,	0xb03e },	/* AfeIfCreg3B1000Msbs */
105 	{ 0x8806,	0xb03e },	/* AfeIfCreg3B100Msbs */
106 	{ 0x8807,	0xff00 },	/* AfeIfCreg3B10Msbs */
107 
108 	{ 0x8808,	0xe090 },	/* AfeIfCreg3B1000Lsbs */
109 	{ 0x8809,	0xe110 },	/* AfeIfCreg3B100Lsbs */
110 	{ 0x880a,	0x0000 },	/* AfeIfCreg3B10Lsbs */
111 
112 	{ 0x300d,	1      },	/* DisableNorm */
113 
114 	{ 0x280c,	0x0180 },	/* LinkHoldEnd */
115 
116 	{ 0x1c21,	0x0002 },	/* AlphaM */
117 
118 	{ 0x3821,	6      },	/* FfeLkgTx0 */
119 	{ 0x381d,	1      },	/* FfeLkg1g4 */
120 	{ 0x381e,	1      },	/* FfeLkg1g5 */
121 	{ 0x381f,	1      },	/* FfeLkg1g6 */
122 	{ 0x3820,	1      },	/* FfeLkg1g7 */
123 
124 	{ 0x8402,	0x01f0 },	/* Btinact */
125 	{ 0x800e,	20     },	/* LftrainTime */
126 	{ 0x800f,	24     },	/* DvguardTime */
127 	{ 0x8010,	46     }	/* IdlguardTime */
128 };
129 
130 static int
131 truephy_probe(device_t dev)
132 {
133 
134 	return (mii_phy_dev_probe(dev, truephys, BUS_PROBE_DEFAULT));
135 }
136 
137 static int
138 truephy_attach(device_t dev)
139 {
140 	struct mii_softc *sc;
141 	struct mii_attach_args *ma;
142 	struct mii_data *mii;
143 
144 	sc = device_get_softc(dev);
145 	ma = device_get_ivars(dev);
146 
147 	sc->mii_phy = ma->mii_phyno;
148 	if (sc->mii_anegticks == 0)
149 		sc->mii_anegticks = MII_ANEGTICKS;
150 	sc->mii_dev = device_get_parent(dev);
151 	mii = device_get_softc(sc->mii_dev);
152 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
153 
154 	sc->mii_inst = mii->mii_instance;
155 	sc->mii_phy = ma->mii_phyno;
156 	sc->mii_service = truephy_service;
157 	sc->mii_pdata = mii;
158 
159 	sc->mii_flags |= MIIF_NOISOLATE | MIIF_NOLOOP;
160 
161 	mii->mii_instance++;
162 
163 	truephy_reset(sc);
164 
165 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
166 	if (sc->mii_capabilities & BMSR_EXTSTAT) {
167 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
168 		/* No 1000baseT half-duplex support */
169 		sc->mii_extcapabilities &= ~EXTSR_1000THDX;
170 	}
171 
172 	device_printf(dev, " ");
173 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
174 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
175 		printf("no media present");
176 	else
177 		mii_phy_add_media(sc);
178 	printf("\n");
179 
180 	MIIBUS_MEDIAINIT(sc->mii_dev);
181 	return 0;
182 }
183 
184 static int
185 truephy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
186 {
187 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
188 	int bmcr;
189 
190 	switch (cmd) {
191 	case MII_POLLSTAT:
192 		/*
193 		 * If we're not polling our PHY instance, just return.
194 		 */
195 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
196 			return 0;
197 		break;
198 
199 	case MII_MEDIACHG:
200 		/*
201 		 * If the media indicates a different PHY instance,
202 		 * isolate ourselves.
203 		 */
204 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
205 			bmcr = PHY_READ(sc, MII_BMCR);
206 			PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
207 			return 0;
208 		}
209 
210 		/*
211 		 * If the interface is not up, don't do anything.
212 		 */
213 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
214 			break;
215 
216 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
217 			bmcr = PHY_READ(sc, MII_BMCR) & ~BMCR_AUTOEN;
218 			PHY_WRITE(sc, MII_BMCR, bmcr);
219 			PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_PDOWN);
220 		}
221 
222 		mii_phy_setmedia(sc);
223 
224 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
225 			bmcr = PHY_READ(sc, MII_BMCR) & ~BMCR_PDOWN;
226 			PHY_WRITE(sc, MII_BMCR, bmcr);
227 
228 			if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
229 				PHY_WRITE(sc, MII_BMCR,
230 					  bmcr | BMCR_AUTOEN | BMCR_STARTNEG);
231 			}
232 		}
233 		break;
234 
235 	case MII_TICK:
236 		/*
237 		 * If we're not currently selected, just return.
238 		 */
239 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
240 			return 0;
241 
242 		if (mii_phy_tick(sc) == EJUSTRETURN)
243 			return 0;
244 		break;
245 	}
246 
247 	/* Update the media status. */
248 	truephy_status(sc);
249 
250 	/* Callback if something changed. */
251 	mii_phy_update(sc, cmd);
252 	return 0;
253 }
254 
255 static void
256 truephy_reset(struct mii_softc *sc)
257 {
258 	int i;
259 
260 	for (i = 0; i < 2; ++i) {
261 		PHY_READ(sc, MII_PHYIDR1);
262 		PHY_READ(sc, MII_PHYIDR2);
263 
264 		PHY_READ(sc, TRUEPHY_CTRL);
265 		PHY_WRITE(sc, TRUEPHY_CTRL,
266 			  TRUEPHY_CTRL_DIAG | TRUEPHY_CTRL_RSV1);
267 
268 		PHY_WRITE(sc, TRUEPHY_INDEX, TRUEPHY_INDEX_MAGIC);
269 		PHY_READ(sc, TRUEPHY_DATA);
270 
271 		PHY_WRITE(sc, TRUEPHY_CTRL, TRUEPHY_CTRL_RSV1);
272 	}
273 
274 	PHY_READ(sc, MII_BMCR);
275 	PHY_READ(sc, TRUEPHY_CTRL);
276 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_PDOWN | BMCR_S1000);
277 	PHY_WRITE(sc, TRUEPHY_CTRL,
278 		  TRUEPHY_CTRL_DIAG | TRUEPHY_CTRL_RSV1 | TRUEPHY_CTRL_RSV0);
279 
280 #define N(arr)	(int)(sizeof(arr) / sizeof(arr[0]))
281 
282 	for (i = 0; i < N(truephy_dspcode); ++i) {
283 		const struct truephy_dsp *dsp = &truephy_dspcode[i];
284 
285 		PHY_WRITE(sc, TRUEPHY_INDEX, dsp->index);
286 		PHY_WRITE(sc, TRUEPHY_DATA, dsp->data);
287 
288 		PHY_WRITE(sc, TRUEPHY_INDEX, dsp->index);
289 		PHY_READ(sc, TRUEPHY_DATA);
290 	}
291 
292 #undef N
293 
294 	PHY_READ(sc, MII_BMCR);
295 	PHY_READ(sc, TRUEPHY_CTRL);
296 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN |  BMCR_S1000);
297 	PHY_WRITE(sc, TRUEPHY_CTRL, TRUEPHY_CTRL_RSV1);
298 
299 	mii_phy_reset(sc);
300 
301 	if (FRAMELEN(sc->mii_pdata->mii_ifp->if_mtu) > 2048) {
302 		int conf;
303 
304 		conf = PHY_READ(sc, TRUEPHY_CONF);
305 		conf &= ~TRUEPHY_CONF_TXFIFO_MASK;
306 		conf |= TRUEPHY_CONF_TXFIFO_24;
307 		PHY_WRITE(sc, TRUEPHY_CONF, conf);
308 	}
309 }
310 
311 static void
312 truephy_status(struct mii_softc *sc)
313 {
314 	struct mii_data *mii = sc->mii_pdata;
315 	int bmsr, bmcr, sr;
316 
317 	mii->mii_media_status = IFM_AVALID;
318 	mii->mii_media_active = IFM_ETHER;
319 
320 	sr = PHY_READ(sc, TRUEPHY_SR);
321 	bmcr = PHY_READ(sc, MII_BMCR);
322 
323 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
324 	if (bmsr & BMSR_LINK)
325 		mii->mii_media_status |= IFM_ACTIVE;
326 
327 	if (bmcr & BMCR_AUTOEN) {
328 		if ((bmsr & BMSR_ACOMP) == 0) {
329 			mii->mii_media_active |= IFM_NONE;
330 			return;
331 		}
332 	}
333 
334 	switch (sr & TRUEPHY_SR_SPD_MASK) {
335 	case TRUEPHY_SR_SPD_1000T:
336 		mii->mii_media_active |= IFM_1000_T;
337 		break;
338 	case TRUEPHY_SR_SPD_100TX:
339 		mii->mii_media_active |= IFM_100_TX;
340 		break;
341 	case TRUEPHY_SR_SPD_10T:
342 		mii->mii_media_active |= IFM_10_T;
343 		break;
344 	default:
345 		/* XXX will this ever happen? */
346 		printf("invalid media SR %#x\n", sr);
347 		mii->mii_media_active |= IFM_NONE;
348 		return;
349 	}
350 
351 	if (sr & TRUEPHY_SR_FDX)
352 		mii->mii_media_active |= IFM_FDX;
353 	else
354 		mii->mii_media_active |= IFM_HDX;
355 }
356