xref: /netbsd-src/sys/dev/mii/ihphy.c (revision e778ac41949f2dbc38b2c892698119ccb0d00543)
1*e778ac41Smsaitoh /*	$NetBSD: ihphy.c,v 1.20 2021/11/05 01:53:30 msaitoh Exp $	*/
2e5ce60b3Schristos 
3e5ce60b3Schristos /*-
4e5ce60b3Schristos  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
5e5ce60b3Schristos  * All rights reserved.
6e5ce60b3Schristos  *
7e5ce60b3Schristos  * This code is derived from software contributed to The NetBSD Foundation
8e5ce60b3Schristos  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9e5ce60b3Schristos  * NASA Ames Research Center, and by Frank van der Linden.
10e5ce60b3Schristos  *
11e5ce60b3Schristos  * Redistribution and use in source and binary forms, with or without
12e5ce60b3Schristos  * modification, are permitted provided that the following conditions
13e5ce60b3Schristos  * are met:
14e5ce60b3Schristos  * 1. Redistributions of source code must retain the above copyright
15e5ce60b3Schristos  *    notice, this list of conditions and the following disclaimer.
16e5ce60b3Schristos  * 2. Redistributions in binary form must reproduce the above copyright
17e5ce60b3Schristos  *    notice, this list of conditions and the following disclaimer in the
18e5ce60b3Schristos  *    documentation and/or other materials provided with the distribution.
19e5ce60b3Schristos  *
20e5ce60b3Schristos  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21e5ce60b3Schristos  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22e5ce60b3Schristos  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23e5ce60b3Schristos  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24e5ce60b3Schristos  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25e5ce60b3Schristos  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26e5ce60b3Schristos  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27e5ce60b3Schristos  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28e5ce60b3Schristos  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29e5ce60b3Schristos  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30e5ce60b3Schristos  * POSSIBILITY OF SUCH DAMAGE.
31e5ce60b3Schristos  */
32e5ce60b3Schristos 
33e5ce60b3Schristos /*
34e5ce60b3Schristos  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35e5ce60b3Schristos  *
36e5ce60b3Schristos  * Redistribution and use in source and binary forms, with or without
37e5ce60b3Schristos  * modification, are permitted provided that the following conditions
38e5ce60b3Schristos  * are met:
39e5ce60b3Schristos  * 1. Redistributions of source code must retain the above copyright
40e5ce60b3Schristos  *    notice, this list of conditions and the following disclaimer.
41e5ce60b3Schristos  * 2. Redistributions in binary form must reproduce the above copyright
42e5ce60b3Schristos  *    notice, this list of conditions and the following disclaimer in the
43e5ce60b3Schristos  *    documentation and/or other materials provided with the distribution.
44e5ce60b3Schristos  *
45e5ce60b3Schristos  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46e5ce60b3Schristos  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47e5ce60b3Schristos  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48e5ce60b3Schristos  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49e5ce60b3Schristos  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50e5ce60b3Schristos  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51e5ce60b3Schristos  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52e5ce60b3Schristos  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53e5ce60b3Schristos  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54e5ce60b3Schristos  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55e5ce60b3Schristos  */
56e5ce60b3Schristos 
57e5ce60b3Schristos /*
58e5ce60b3Schristos  * Driver for Intel's 82577 (Hanksville) Ethernet 10/100/1000 PHY
59e5ce60b3Schristos  * Data Sheet: http://download.intel.com/design/network/datashts/319439.pdf
60e5ce60b3Schristos  */
61e5ce60b3Schristos 
62e5ce60b3Schristos #include <sys/cdefs.h>
63*e778ac41Smsaitoh __KERNEL_RCSID(0, "$NetBSD: ihphy.c,v 1.20 2021/11/05 01:53:30 msaitoh Exp $");
64e5ce60b3Schristos 
65e5ce60b3Schristos #include <sys/param.h>
66e5ce60b3Schristos #include <sys/systm.h>
67e5ce60b3Schristos #include <sys/kernel.h>
68e5ce60b3Schristos #include <sys/device.h>
69e5ce60b3Schristos #include <sys/socket.h>
70e5ce60b3Schristos #include <sys/errno.h>
71e5ce60b3Schristos 
72e5ce60b3Schristos #include <net/if.h>
73e5ce60b3Schristos #include <net/if_media.h>
74e5ce60b3Schristos 
75e5ce60b3Schristos #include <dev/mii/mii.h>
76e5ce60b3Schristos #include <dev/mii/miivar.h>
77e5ce60b3Schristos #include <dev/mii/miidevs.h>
78e5ce60b3Schristos 
79e5ce60b3Schristos #include <dev/mii/ihphyreg.h>
80e5ce60b3Schristos 
81e5ce60b3Schristos static int	ihphymatch(device_t, cfdata_t, void *);
82e5ce60b3Schristos static void	ihphyattach(device_t, device_t, void *);
83e5ce60b3Schristos 
8468e9e41eSthorpej CFATTACH_DECL_NEW(ihphy, sizeof(struct mii_softc),
8568e9e41eSthorpej     ihphymatch, ihphyattach, mii_phy_detach, mii_phy_activate);
86e5ce60b3Schristos 
87e5ce60b3Schristos static int	ihphy_service(struct mii_softc *, struct mii_data *, int);
88e5ce60b3Schristos static void	ihphy_status(struct mii_softc *);
89e5ce60b3Schristos static void	ihphy_reset(struct mii_softc *);
90e5ce60b3Schristos 
91e5ce60b3Schristos static const struct mii_phy_funcs ihphy_funcs = {
92e5ce60b3Schristos 	ihphy_service, ihphy_status, ihphy_reset,
93e5ce60b3Schristos };
94e5ce60b3Schristos 
95e5ce60b3Schristos static const struct mii_phydesc ihphys[] = {
967b43da1bSchristos 	MII_PHY_DESC(INTEL, I82577),
977b43da1bSchristos 	MII_PHY_DESC(INTEL, I82579),
987b43da1bSchristos 	MII_PHY_DESC(INTEL, I217),
997b43da1bSchristos 	MII_PHY_DESC(INTEL, I82580),
1007b43da1bSchristos 	MII_PHY_DESC(INTEL, I350),
1017b43da1bSchristos 	MII_PHY_END,
102e5ce60b3Schristos };
103e5ce60b3Schristos 
104e5ce60b3Schristos static int
ihphymatch(device_t parent,cfdata_t match,void * aux)105e5ce60b3Schristos ihphymatch(device_t parent, cfdata_t match, void *aux)
106e5ce60b3Schristos {
107e5ce60b3Schristos 	struct mii_attach_args *ma = aux;
108e5ce60b3Schristos 
109e5ce60b3Schristos 	if (mii_phy_match(ma, ihphys) != NULL)
110e5ce60b3Schristos 		return 10;
111e5ce60b3Schristos 
112e5ce60b3Schristos 	return 0;
113e5ce60b3Schristos }
114e5ce60b3Schristos 
115e5ce60b3Schristos static void
ihphyattach(device_t parent,device_t self,void * aux)116e5ce60b3Schristos ihphyattach(device_t parent, device_t self, void *aux)
117e5ce60b3Schristos {
118e5ce60b3Schristos 	struct mii_softc *sc = device_private(self);
119e5ce60b3Schristos 	struct mii_attach_args *ma = aux;
120e5ce60b3Schristos 	struct mii_data *mii = ma->mii_data;
121e5ce60b3Schristos 	const struct mii_phydesc *mpd;
122a5cdd4b4Smsaitoh 	uint16_t reg;
123e5ce60b3Schristos 
124e5ce60b3Schristos 	mpd = mii_phy_match(ma, ihphys);
125e5ce60b3Schristos 	aprint_naive(": Media interface\n");
126e5ce60b3Schristos 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
127e5ce60b3Schristos 
128e5ce60b3Schristos 	sc->mii_dev = self;
129e5ce60b3Schristos 	sc->mii_inst = mii->mii_instance;
130e5ce60b3Schristos 	sc->mii_phy = ma->mii_phyno;
1318fd2b67fSmsaitoh 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
1328fd2b67fSmsaitoh 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
1338fd2b67fSmsaitoh 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
134e5ce60b3Schristos 	sc->mii_funcs = &ihphy_funcs;
135e5ce60b3Schristos 	sc->mii_pdata = mii;
136e5ce60b3Schristos 	sc->mii_flags = ma->mii_flags;
137e5ce60b3Schristos 
1387a9a30c5Sthorpej 	mii_lock(mii);
1397a9a30c5Sthorpej 
140e5ce60b3Schristos 	PHY_RESET(sc);
141e5ce60b3Schristos 
142a5cdd4b4Smsaitoh 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
143a5cdd4b4Smsaitoh 	sc->mii_capabilities &= ma->mii_capmask;
144e5ce60b3Schristos 	if (sc->mii_capabilities & BMSR_EXTSTAT)
145a5cdd4b4Smsaitoh 		PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
146509697f3Smsaitoh 
1477a9a30c5Sthorpej 	mii_unlock(mii);
1487a9a30c5Sthorpej 
149e5ce60b3Schristos 	mii_phy_add_media(sc);
150e5ce60b3Schristos 
1517a9a30c5Sthorpej 	mii_lock(mii);
15202341723Smsaitoh 	/* Link setup (as done by Intel's Linux driver for the 82577). */
153a5cdd4b4Smsaitoh 	PHY_READ(sc, IHPHY_MII_CFG, &reg);
154e5ce60b3Schristos 	reg |= IHPHY_CFG_TX_CRS;
155e5ce60b3Schristos 	reg |= IHPHY_CFG_DOWN_SHIFT;
156e5ce60b3Schristos 	PHY_WRITE(sc, IHPHY_MII_CFG, reg);
1577a9a30c5Sthorpej 	mii_unlock(mii);
158e5ce60b3Schristos }
159e5ce60b3Schristos 
160e5ce60b3Schristos static int
ihphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)161e5ce60b3Schristos ihphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
162e5ce60b3Schristos {
163e5ce60b3Schristos 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
164a5cdd4b4Smsaitoh 	uint16_t reg;
165e5ce60b3Schristos 
1667a9a30c5Sthorpej 	KASSERT(mii_locked(mii));
1677a9a30c5Sthorpej 
168e5ce60b3Schristos 	switch (cmd) {
169e5ce60b3Schristos 	case MII_POLLSTAT:
17002341723Smsaitoh 		/* If we're not polling our PHY instance, just return. */
171e5ce60b3Schristos 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
172e5ce60b3Schristos 			return 0;
173e5ce60b3Schristos 		break;
174e5ce60b3Schristos 
175e5ce60b3Schristos 	case MII_MEDIACHG:
176e5ce60b3Schristos 		/*
177e5ce60b3Schristos 		 * If the media indicates a different PHY instance,
178e5ce60b3Schristos 		 * isolate ourselves.
179e5ce60b3Schristos 		 */
180e5ce60b3Schristos 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
181a5cdd4b4Smsaitoh 			PHY_READ(sc, MII_BMCR, &reg);
182e5ce60b3Schristos 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
183e5ce60b3Schristos 			return 0;
184e5ce60b3Schristos 		}
185e5ce60b3Schristos 
18602341723Smsaitoh 		/* If the interface is not up, don't do anything. */
187e5ce60b3Schristos 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
188e5ce60b3Schristos 			break;
189e5ce60b3Schristos 
19002341723Smsaitoh 		/* If media is deselected, disable link (standby). */
191a5cdd4b4Smsaitoh 		PHY_READ(sc, IHPHY_MII_ECR, &reg);
192e5ce60b3Schristos 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE)
193e5ce60b3Schristos 			reg &= ~IHPHY_ECR_LNK_EN;
194e5ce60b3Schristos 		else
195e5ce60b3Schristos 			reg |= IHPHY_ECR_LNK_EN;
196e5ce60b3Schristos 		PHY_WRITE(sc, IHPHY_MII_ECR, reg);
197e5ce60b3Schristos 
19802341723Smsaitoh 		/* XXX Adjust MDI/MDIX configuration?  Other settings? */
199e5ce60b3Schristos 
200e5ce60b3Schristos 		mii_phy_setmedia(sc);
201e5ce60b3Schristos 		break;
202e5ce60b3Schristos 
203e5ce60b3Schristos 	case MII_TICK:
20402341723Smsaitoh 		/* If we're not currently selected, just return. */
205e5ce60b3Schristos 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
206e5ce60b3Schristos 			return 0;
207e5ce60b3Schristos 
208e5ce60b3Schristos 		if (mii_phy_tick(sc) == EJUSTRETURN)
209e5ce60b3Schristos 			return 0;
210e5ce60b3Schristos 		break;
211e5ce60b3Schristos 
212e5ce60b3Schristos 	case MII_DOWN:
213e5ce60b3Schristos 		mii_phy_down(sc);
214e5ce60b3Schristos 		return 0;
215e5ce60b3Schristos 	}
216e5ce60b3Schristos 
217e5ce60b3Schristos 	/* Update the media status. */
218e5ce60b3Schristos 	mii_phy_status(sc);
219e5ce60b3Schristos 
220e5ce60b3Schristos 	/* Callback if something changed. */
221e5ce60b3Schristos 	mii_phy_update(sc, cmd);
222e5ce60b3Schristos 	return 0;
223e5ce60b3Schristos }
224e5ce60b3Schristos 
225e5ce60b3Schristos static void
ihphy_status(struct mii_softc * sc)226e5ce60b3Schristos ihphy_status(struct mii_softc *sc)
227e5ce60b3Schristos {
228e5ce60b3Schristos 	struct mii_data *mii = sc->mii_pdata;
229a5cdd4b4Smsaitoh 	uint16_t esr, bmcr, gtsr;
230e5ce60b3Schristos 
2317a9a30c5Sthorpej 	KASSERT(mii_locked(mii));
2327a9a30c5Sthorpej 
233e5ce60b3Schristos 	mii->mii_media_status = IFM_AVALID;
234e5ce60b3Schristos 	mii->mii_media_active = IFM_ETHER;
235e5ce60b3Schristos 
236a5cdd4b4Smsaitoh 	PHY_READ(sc, IHPHY_MII_ESR, &esr);
237e5ce60b3Schristos 
238e5ce60b3Schristos 	if (esr & IHPHY_ESR_LINK)
239e5ce60b3Schristos 		mii->mii_media_status |= IFM_ACTIVE;
240e5ce60b3Schristos 
241a5cdd4b4Smsaitoh 	PHY_READ(sc, MII_BMCR, &bmcr);
242e5ce60b3Schristos 	if (bmcr & (BMCR_ISO | BMCR_PDOWN)) {
243e5ce60b3Schristos 		mii->mii_media_active |= IFM_NONE;
244e5ce60b3Schristos 		return;
245e5ce60b3Schristos 	}
246e5ce60b3Schristos 
247e5ce60b3Schristos 	if (bmcr & BMCR_LOOP)
248e5ce60b3Schristos 		mii->mii_media_active |= IFM_LOOP;
249e5ce60b3Schristos 
250e5ce60b3Schristos 	if (bmcr & BMCR_AUTOEN) {
251e5ce60b3Schristos 		if ((esr & IHPHY_ESR_ANEG_STAT) == 0) {
252e5ce60b3Schristos 			/* Erg, still trying, I guess... */
253e5ce60b3Schristos 			mii->mii_media_active |= IFM_NONE;
254e5ce60b3Schristos 			return;
255e5ce60b3Schristos 		}
256e5ce60b3Schristos 	}
257e5ce60b3Schristos 
258e5ce60b3Schristos 	switch (esr & IHPHY_ESR_SPEED) {
259e5ce60b3Schristos 	case IHPHY_SPEED_1000:
260e5ce60b3Schristos 		mii->mii_media_active |= IFM_1000_T;
261a5cdd4b4Smsaitoh 		PHY_READ(sc, MII_100T2SR, &gtsr);
262e5ce60b3Schristos 		if (gtsr & GTSR_MS_RES)
263e5ce60b3Schristos 			mii->mii_media_active |= IFM_ETH_MASTER;
264e5ce60b3Schristos 		break;
265e5ce60b3Schristos 
266e5ce60b3Schristos 	case IHPHY_SPEED_100:
267e5ce60b3Schristos 		/* 100BASE-T2 and 100BASE-T4 are not supported. */
268e5ce60b3Schristos 		mii->mii_media_active |= IFM_100_TX;
269e5ce60b3Schristos 		break;
270e5ce60b3Schristos 
271e5ce60b3Schristos 	case IHPHY_SPEED_10:
272e5ce60b3Schristos 		mii->mii_media_active |= IFM_10_T;
273e5ce60b3Schristos 		break;
274e5ce60b3Schristos 
275e5ce60b3Schristos 	default:
276e5ce60b3Schristos 		mii->mii_media_active |= IFM_NONE;
277e5ce60b3Schristos 		mii->mii_media_status = 0;
278e5ce60b3Schristos 		return;
279e5ce60b3Schristos 	}
280e5ce60b3Schristos 
281e5ce60b3Schristos 	if (esr & IHPHY_ESR_DUPLEX)
282b211437bSmsaitoh 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
283b211437bSmsaitoh 	else
284b211437bSmsaitoh 		mii->mii_media_active |= IFM_HDX;
285e5ce60b3Schristos }
286e5ce60b3Schristos 
287e5ce60b3Schristos static void
ihphy_reset(struct mii_softc * sc)288e5ce60b3Schristos ihphy_reset(struct mii_softc *sc)
289e5ce60b3Schristos {
290a5cdd4b4Smsaitoh 	int i;
291a5cdd4b4Smsaitoh 	uint16_t reg;
292e5ce60b3Schristos 
2937a9a30c5Sthorpej 	KASSERT(mii_locked(sc->mii_pdata));
2947a9a30c5Sthorpej 
295e5ce60b3Schristos 	PHY_WRITE(sc, MII_BMCR, BMCR_RESET | BMCR_ISO);
296e5ce60b3Schristos 
297e5ce60b3Schristos 	/* Wait another 100ms for it to complete. */
298e5ce60b3Schristos 	for (i = 0; i < 100; i++) {
299a5cdd4b4Smsaitoh 		PHY_READ(sc, MII_BMCR, &reg);
300e5ce60b3Schristos 		if ((reg & BMCR_RESET) == 0)
301e5ce60b3Schristos 			break;
302e5ce60b3Schristos 		delay(1000);
303e5ce60b3Schristos 	}
304e5ce60b3Schristos 
305e5ce60b3Schristos 	if (sc->mii_inst != 0)
306e5ce60b3Schristos 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
307e5ce60b3Schristos }
308