xref: /freebsd/sys/dev/mii/truephy.c (revision 5c52a79884070364bfc920fb8e492cfac61ec72f)
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	TRUEPHY_FRAMELEN(mtu)	\
61     (ETHER_HDR_LEN + ETHER_VLAN_ENCAP_LEN + (mtu) + ETHER_CRC_LEN)
62 
63 static int	truephy_service(struct mii_softc *, struct mii_data *, int);
64 static int	truephy_attach(device_t);
65 static int	truephy_probe(device_t);
66 static void	truephy_reset(struct mii_softc *);
67 static void	truephy_status(struct mii_softc *);
68 
69 static device_method_t truephy_methods[] = {
70 	/* device interface */
71 	DEVMETHOD(device_probe,		truephy_probe),
72 	DEVMETHOD(device_attach,	truephy_attach),
73 	DEVMETHOD(device_detach,	mii_phy_detach),
74 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
75 	{ 0, 0 }
76 };
77 
78 static const struct mii_phydesc truephys[] = {
79 	MII_PHY_DESC(AGERE,	ET1011C),
80 	MII_PHY_END
81 };
82 
83 static devclass_t truephy_devclass;
84 
85 static driver_t truephy_driver = {
86 	"truephy",
87 	truephy_methods,
88 	sizeof(struct mii_softc)
89 };
90 
91 DRIVER_MODULE(truephy, miibus, truephy_driver, truephy_devclass, 0, 0);
92 
93 static const struct truephy_dsp {
94 	uint16_t	index;
95 	uint16_t	data;
96 } truephy_dspcode[] = {
97 	{ 0x880b,	0x0926 },	/* AfeIfCreg4B1000Msbs */
98 	{ 0x880c,	0x0926 },	/* AfeIfCreg4B100Msbs */
99 	{ 0x880d,	0x0926 },	/* AfeIfCreg4B10Msbs */
100 
101 	{ 0x880e,	0xb4d3 },	/* AfeIfCreg4B1000Lsbs */
102 	{ 0x880f,	0xb4d3 },	/* AfeIfCreg4B100Lsbs */
103 	{ 0x8810,	0xb4d3 },	/* AfeIfCreg4B10Lsbs */
104 
105 	{ 0x8805,	0xb03e },	/* AfeIfCreg3B1000Msbs */
106 	{ 0x8806,	0xb03e },	/* AfeIfCreg3B100Msbs */
107 	{ 0x8807,	0xff00 },	/* AfeIfCreg3B10Msbs */
108 
109 	{ 0x8808,	0xe090 },	/* AfeIfCreg3B1000Lsbs */
110 	{ 0x8809,	0xe110 },	/* AfeIfCreg3B100Lsbs */
111 	{ 0x880a,	0x0000 },	/* AfeIfCreg3B10Lsbs */
112 
113 	{ 0x300d,	1      },	/* DisableNorm */
114 
115 	{ 0x280c,	0x0180 },	/* LinkHoldEnd */
116 
117 	{ 0x1c21,	0x0002 },	/* AlphaM */
118 
119 	{ 0x3821,	6      },	/* FfeLkgTx0 */
120 	{ 0x381d,	1      },	/* FfeLkg1g4 */
121 	{ 0x381e,	1      },	/* FfeLkg1g5 */
122 	{ 0x381f,	1      },	/* FfeLkg1g6 */
123 	{ 0x3820,	1      },	/* FfeLkg1g7 */
124 
125 	{ 0x8402,	0x01f0 },	/* Btinact */
126 	{ 0x800e,	20     },	/* LftrainTime */
127 	{ 0x800f,	24     },	/* DvguardTime */
128 	{ 0x8010,	46     }	/* IdlguardTime */
129 };
130 
131 static int
132 truephy_probe(device_t dev)
133 {
134 
135 	return (mii_phy_dev_probe(dev, truephys, BUS_PROBE_DEFAULT));
136 }
137 
138 static int
139 truephy_attach(device_t dev)
140 {
141 	struct mii_softc *sc;
142 	struct mii_attach_args *ma;
143 	struct mii_data *mii;
144 
145 	sc = device_get_softc(dev);
146 	ma = device_get_ivars(dev);
147 
148 	sc->mii_phy = ma->mii_phyno;
149 	if (sc->mii_anegticks == 0)
150 		sc->mii_anegticks = MII_ANEGTICKS;
151 	sc->mii_dev = device_get_parent(dev);
152 	mii = device_get_softc(sc->mii_dev);
153 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
154 
155 	sc->mii_inst = mii->mii_instance;
156 	sc->mii_phy = ma->mii_phyno;
157 	sc->mii_service = truephy_service;
158 	sc->mii_pdata = mii;
159 
160 	sc->mii_flags |= MIIF_NOISOLATE | MIIF_NOLOOP;
161 
162 	mii->mii_instance++;
163 
164 	truephy_reset(sc);
165 
166 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
167 	if (sc->mii_capabilities & BMSR_EXTSTAT) {
168 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
169 		/* No 1000baseT half-duplex support */
170 		sc->mii_extcapabilities &= ~EXTSR_1000THDX;
171 	}
172 
173 	device_printf(dev, " ");
174 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
175 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
176 		printf("no media present");
177 	else
178 		mii_phy_add_media(sc);
179 	printf("\n");
180 
181 	MIIBUS_MEDIAINIT(sc->mii_dev);
182 	return 0;
183 }
184 
185 static int
186 truephy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
187 {
188 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
189 	int bmcr;
190 
191 	switch (cmd) {
192 	case MII_POLLSTAT:
193 		/*
194 		 * If we're not polling our PHY instance, just return.
195 		 */
196 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
197 			return 0;
198 		break;
199 
200 	case MII_MEDIACHG:
201 		/*
202 		 * If the media indicates a different PHY instance,
203 		 * isolate ourselves.
204 		 */
205 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
206 			bmcr = PHY_READ(sc, MII_BMCR);
207 			PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
208 			return 0;
209 		}
210 
211 		/*
212 		 * If the interface is not up, don't do anything.
213 		 */
214 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
215 			break;
216 
217 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
218 			bmcr = PHY_READ(sc, MII_BMCR) & ~BMCR_AUTOEN;
219 			PHY_WRITE(sc, MII_BMCR, bmcr);
220 			PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_PDOWN);
221 		}
222 
223 		mii_phy_setmedia(sc);
224 
225 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
226 			bmcr = PHY_READ(sc, MII_BMCR) & ~BMCR_PDOWN;
227 			PHY_WRITE(sc, MII_BMCR, bmcr);
228 
229 			if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
230 				PHY_WRITE(sc, MII_BMCR,
231 					  bmcr | BMCR_AUTOEN | BMCR_STARTNEG);
232 			}
233 		}
234 		break;
235 
236 	case MII_TICK:
237 		/*
238 		 * If we're not currently selected, just return.
239 		 */
240 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
241 			return 0;
242 
243 		if (mii_phy_tick(sc) == EJUSTRETURN)
244 			return 0;
245 		break;
246 	}
247 
248 	/* Update the media status. */
249 	truephy_status(sc);
250 
251 	/* Callback if something changed. */
252 	mii_phy_update(sc, cmd);
253 	return 0;
254 }
255 
256 static void
257 truephy_reset(struct mii_softc *sc)
258 {
259 	int i;
260 
261 	for (i = 0; i < 2; ++i) {
262 		PHY_READ(sc, MII_PHYIDR1);
263 		PHY_READ(sc, MII_PHYIDR2);
264 
265 		PHY_READ(sc, TRUEPHY_CTRL);
266 		PHY_WRITE(sc, TRUEPHY_CTRL,
267 			  TRUEPHY_CTRL_DIAG | TRUEPHY_CTRL_RSV1);
268 
269 		PHY_WRITE(sc, TRUEPHY_INDEX, TRUEPHY_INDEX_MAGIC);
270 		PHY_READ(sc, TRUEPHY_DATA);
271 
272 		PHY_WRITE(sc, TRUEPHY_CTRL, TRUEPHY_CTRL_RSV1);
273 	}
274 
275 	PHY_READ(sc, MII_BMCR);
276 	PHY_READ(sc, TRUEPHY_CTRL);
277 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_PDOWN | BMCR_S1000);
278 	PHY_WRITE(sc, TRUEPHY_CTRL,
279 		  TRUEPHY_CTRL_DIAG | TRUEPHY_CTRL_RSV1 | TRUEPHY_CTRL_RSV0);
280 
281 #define N(arr)	(int)(sizeof(arr) / sizeof(arr[0]))
282 
283 	for (i = 0; i < N(truephy_dspcode); ++i) {
284 		const struct truephy_dsp *dsp = &truephy_dspcode[i];
285 
286 		PHY_WRITE(sc, TRUEPHY_INDEX, dsp->index);
287 		PHY_WRITE(sc, TRUEPHY_DATA, dsp->data);
288 
289 		PHY_WRITE(sc, TRUEPHY_INDEX, dsp->index);
290 		PHY_READ(sc, TRUEPHY_DATA);
291 	}
292 
293 #undef N
294 
295 	PHY_READ(sc, MII_BMCR);
296 	PHY_READ(sc, TRUEPHY_CTRL);
297 	PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN |  BMCR_S1000);
298 	PHY_WRITE(sc, TRUEPHY_CTRL, TRUEPHY_CTRL_RSV1);
299 
300 	mii_phy_reset(sc);
301 
302 	if (TRUEPHY_FRAMELEN(sc->mii_pdata->mii_ifp->if_mtu) > 2048) {
303 		int conf;
304 
305 		conf = PHY_READ(sc, TRUEPHY_CONF);
306 		conf &= ~TRUEPHY_CONF_TXFIFO_MASK;
307 		conf |= TRUEPHY_CONF_TXFIFO_24;
308 		PHY_WRITE(sc, TRUEPHY_CONF, conf);
309 	}
310 }
311 
312 static void
313 truephy_status(struct mii_softc *sc)
314 {
315 	struct mii_data *mii = sc->mii_pdata;
316 	int bmsr, bmcr, sr;
317 
318 	mii->mii_media_status = IFM_AVALID;
319 	mii->mii_media_active = IFM_ETHER;
320 
321 	sr = PHY_READ(sc, TRUEPHY_SR);
322 	bmcr = PHY_READ(sc, MII_BMCR);
323 
324 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
325 	if (bmsr & BMSR_LINK)
326 		mii->mii_media_status |= IFM_ACTIVE;
327 
328 	if (bmcr & BMCR_AUTOEN) {
329 		if ((bmsr & BMSR_ACOMP) == 0) {
330 			mii->mii_media_active |= IFM_NONE;
331 			return;
332 		}
333 	}
334 
335 	switch (sr & TRUEPHY_SR_SPD_MASK) {
336 	case TRUEPHY_SR_SPD_1000T:
337 		mii->mii_media_active |= IFM_1000_T;
338 		break;
339 	case TRUEPHY_SR_SPD_100TX:
340 		mii->mii_media_active |= IFM_100_TX;
341 		break;
342 	case TRUEPHY_SR_SPD_10T:
343 		mii->mii_media_active |= IFM_10_T;
344 		break;
345 	default:
346 		/* XXX will this ever happen? */
347 		printf("invalid media SR %#x\n", sr);
348 		mii->mii_media_active |= IFM_NONE;
349 		return;
350 	}
351 
352 	if (sr & TRUEPHY_SR_FDX)
353 		mii->mii_media_active |= IFM_FDX;
354 	else
355 		mii->mii_media_active |= IFM_HDX;
356 }
357