xref: /netbsd-src/sys/dev/mii/inphy.c (revision f3cfa6f6ce31685c6c4a758bc430e69eb99f50a4)
1 /*	$NetBSD: inphy.c,v 1.58 2019/03/25 09:29:08 msaitoh Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55  */
56 
57 /*
58  * driver for Intel's i82555 ethernet 10/100 PHY
59  * Data Sheet available from www.intel.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: inphy.c,v 1.58 2019/03/25 09:29:08 msaitoh Exp $");
64 
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/device.h>
69 #include <sys/socket.h>
70 #include <sys/errno.h>
71 
72 #include <net/if.h>
73 #include <net/if_media.h>
74 
75 #include <dev/mii/mii.h>
76 #include <dev/mii/miivar.h>
77 #include <dev/mii/miidevs.h>
78 
79 #include <dev/mii/inphyreg.h>
80 
81 static int	inphymatch(device_t, cfdata_t, void *);
82 static void	inphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(inphy, sizeof(struct mii_softc),
85     inphymatch, inphyattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	inphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	inphy_status(struct mii_softc *);
89 
90 static const struct mii_phy_funcs inphy_funcs = {
91 	inphy_service, inphy_status, mii_phy_reset,
92 };
93 
94 static const struct mii_phydesc inphys[] = {
95 	MII_PHY_DESC(yyINTEL, I82555),
96 	MII_PHY_DESC(yyINTEL, I82562EH),
97 	MII_PHY_DESC(yyINTEL, I82562EM),
98 	MII_PHY_DESC(yyINTEL, I82562ET),
99 	MII_PHY_DESC(yyINTEL, I82562G),
100 	MII_PHY_END,
101 };
102 
103 static int
104 inphymatch(device_t parent, cfdata_t match, void *aux)
105 {
106 	struct mii_attach_args *ma = aux;
107 
108 	if (mii_phy_match(ma, inphys) != NULL)
109 		return 10;
110 
111 	return 0;
112 }
113 
114 static void
115 inphyattach(device_t parent, device_t self, void *aux)
116 {
117 	struct mii_softc *sc = device_private(self);
118 	struct mii_attach_args *ma = aux;
119 	struct mii_data *mii = ma->mii_data;
120 	const struct mii_phydesc *mpd;
121 
122 	mpd = mii_phy_match(ma, inphys);
123 	aprint_naive(": Media interface\n");
124 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
125 
126 	sc->mii_dev = self;
127 	sc->mii_inst = mii->mii_instance;
128 	sc->mii_phy = ma->mii_phyno;
129 	sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
130 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
131 	sc->mii_mpd_rev = MII_REV(ma->mii_id2);
132 	sc->mii_funcs = &inphy_funcs;
133 	sc->mii_pdata = mii;
134 	sc->mii_flags = ma->mii_flags;
135 	sc->mii_anegticks = MII_ANEGTICKS;
136 
137 	PHY_RESET(sc);
138 
139 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
140 	sc->mii_capabilities &= ma->mii_capmask;
141 	aprint_normal_dev(self, "");
142 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
143 		aprint_error("no media present");
144 	else
145 		mii_phy_add_media(sc);
146 	aprint_normal("\n");
147 }
148 
149 static int
150 inphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
151 {
152 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
153 	uint16_t reg;
154 
155 	switch (cmd) {
156 	case MII_POLLSTAT:
157 		/* If we're not polling our PHY instance, just return. */
158 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
159 			return 0;
160 		break;
161 
162 	case MII_MEDIACHG:
163 		/*
164 		 * If the media indicates a different PHY instance,
165 		 * isolate ourselves.
166 		 */
167 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
168 			PHY_READ(sc, MII_BMCR, &reg);
169 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
170 			return 0;
171 		}
172 
173 		/* If the interface is not up, don't do anything. */
174 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
175 			break;
176 
177 		mii_phy_setmedia(sc);
178 		break;
179 
180 	case MII_TICK:
181 		/* If we're not currently selected, just return. */
182 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
183 			return 0;
184 
185 		if (mii_phy_tick(sc) == EJUSTRETURN)
186 			return 0;
187 		break;
188 
189 	case MII_DOWN:
190 		mii_phy_down(sc);
191 		return 0;
192 	}
193 
194 	/* Update the media status. */
195 	mii_phy_status(sc);
196 
197 	/* Callback if something changed. */
198 	mii_phy_update(sc, cmd);
199 	return 0;
200 }
201 
202 static void
203 inphy_status(struct mii_softc *sc)
204 {
205 	struct mii_data *mii = sc->mii_pdata;
206 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
207 	uint16_t bmsr, bmcr, scr;
208 
209 	mii->mii_media_status = IFM_AVALID;
210 	mii->mii_media_active = IFM_ETHER;
211 
212 	PHY_READ(sc, MII_BMSR, &bmsr);
213 	PHY_READ(sc, MII_BMSR, &bmsr);
214 	if (bmsr & BMSR_LINK)
215 		mii->mii_media_status |= IFM_ACTIVE;
216 
217 	PHY_READ(sc, MII_BMCR, &bmcr);
218 	if (bmcr & BMCR_ISO) {
219 		mii->mii_media_active |= IFM_NONE;
220 		mii->mii_media_status = 0;
221 		return;
222 	}
223 
224 	if (bmcr & BMCR_LOOP)
225 		mii->mii_media_active |= IFM_LOOP;
226 
227 	if (bmcr & BMCR_AUTOEN) {
228 		if ((bmsr & BMSR_ACOMP) == 0) {
229 			/* Erg, still trying, I guess... */
230 			mii->mii_media_active |= IFM_NONE;
231 			return;
232 		}
233 
234 		PHY_READ(sc, MII_INPHY_SCR, &scr);
235 		if (scr & SCR_S100)
236 			mii->mii_media_active |= IFM_100_TX;
237 		else if ((bmsr & BMSR_100T4) && (scr & SCR_T4))
238 			mii->mii_media_active |= IFM_100_T4;
239 		else
240 			mii->mii_media_active |= IFM_10_T;
241 
242 		if (scr & SCR_FDX)
243 			mii->mii_media_active |= IFM_FDX;
244 		else
245 			mii->mii_media_active |= IFM_HDX;
246 
247 		if (mii->mii_media_active & IFM_FDX)
248 			mii->mii_media_active |= mii_phy_flowstatus(sc);
249 	} else
250 		mii->mii_media_active = ife->ifm_media;
251 }
252