xref: /netbsd-src/sys/dev/mii/icsphy.c (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
1 /*	$NetBSD: icsphy.c,v 1.49 2014/06/16 16:48:16 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 Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY
59  * datasheet from www.icst.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: icsphy.c,v 1.49 2014/06/16 16:48:16 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 
71 #include <net/if.h>
72 #include <net/if_media.h>
73 
74 #include <dev/mii/mii.h>
75 #include <dev/mii/miivar.h>
76 #include <dev/mii/miidevs.h>
77 
78 #include <dev/mii/icsphyreg.h>
79 
80 static int	icsphymatch(device_t, cfdata_t, void *);
81 static void	icsphyattach(device_t, device_t, void *);
82 
83 CFATTACH_DECL_NEW(icsphy, sizeof(struct mii_softc),
84     icsphymatch, icsphyattach, mii_phy_detach, mii_phy_activate);
85 
86 static int	icsphy_service(struct mii_softc *, struct mii_data *, int);
87 static void	icsphy_status(struct mii_softc *);
88 static void	icsphy_reset(struct mii_softc *);
89 
90 static const struct mii_phy_funcs icsphy_funcs = {
91 	icsphy_service, icsphy_status, icsphy_reset,
92 };
93 
94 static const struct mii_phydesc icsphys[] = {
95 	{ MII_OUI_ICS,		MII_MODEL_ICS_1889,
96 	  MII_STR_ICS_1889 },
97 
98 	{ MII_OUI_ICS,		MII_MODEL_ICS_1890,
99 	  MII_STR_ICS_1890 },
100 
101 	{ MII_OUI_ICS,		MII_MODEL_ICS_1892,
102 	  MII_STR_ICS_1892 },
103 
104 	{ MII_OUI_ICS,		MII_MODEL_ICS_1893,
105 	  MII_STR_ICS_1893 },
106 
107 	{ 0,			0,
108 	  NULL },
109 };
110 
111 static int
112 icsphymatch(device_t parent, cfdata_t match, void *aux)
113 {
114 	struct mii_attach_args *ma = aux;
115 
116 	if (mii_phy_match(ma, icsphys) != NULL)
117 		return (10);
118 
119 	return (0);
120 }
121 
122 static void
123 icsphyattach(device_t parent, device_t self, void *aux)
124 {
125 	struct mii_softc *sc = device_private(self);
126 	struct mii_attach_args *ma = aux;
127 	struct mii_data *mii = ma->mii_data;
128 	const struct mii_phydesc *mpd;
129 
130 	mpd = mii_phy_match(ma, icsphys);
131 	aprint_naive(": Media interface\n");
132 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
133 
134 	sc->mii_dev = self;
135 	sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
136 	sc->mii_inst = mii->mii_instance;
137 	sc->mii_phy = ma->mii_phyno;
138 	sc->mii_funcs = &icsphy_funcs;
139 	sc->mii_pdata = mii;
140 	sc->mii_flags = ma->mii_flags;
141 	sc->mii_anegticks = MII_ANEGTICKS;
142 
143 	PHY_RESET(sc);
144 
145 	sc->mii_capabilities =
146 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
147 	aprint_normal_dev(self, "");
148 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
149 		aprint_error("no media present");
150 	else
151 		mii_phy_add_media(sc);
152 	aprint_normal("\n");
153 }
154 
155 static int
156 icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
157 {
158 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
159 	int reg;
160 
161 	switch (cmd) {
162 	case MII_POLLSTAT:
163 		/*
164 		 * If we're not polling our PHY instance, just return.
165 		 */
166 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
167 			return (0);
168 		break;
169 
170 	case MII_MEDIACHG:
171 		/*
172 		 * If the media indicates a different PHY instance,
173 		 * isolate ourselves.
174 		 */
175 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
176 			reg = PHY_READ(sc, MII_BMCR);
177 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
178 			return (0);
179 		}
180 
181 		/*
182 		 * If the interface is not up, don't do anything.
183 		 */
184 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
185 			break;
186 
187 		mii_phy_setmedia(sc);
188 		break;
189 
190 	case MII_TICK:
191 		/*
192 		 * If we're not currently selected, just return.
193 		 */
194 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
195 			return (0);
196 
197 		if (mii_phy_tick(sc) == EJUSTRETURN)
198 			return (0);
199 		break;
200 
201 	case MII_DOWN:
202 		mii_phy_down(sc);
203 		return (0);
204 	}
205 
206 	/* Update the media status. */
207 	mii_phy_status(sc);
208 
209 	/* Callback if something changed. */
210 	mii_phy_update(sc, cmd);
211 	return (0);
212 }
213 
214 static void
215 icsphy_status(struct mii_softc *sc)
216 {
217 	struct mii_data *mii = sc->mii_pdata;
218 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
219 	int bmcr, qpr;
220 
221 	mii->mii_media_status = IFM_AVALID;
222 	mii->mii_media_active = IFM_ETHER;
223 
224 	/*
225 	 * Don't get link from the BMSR.  It's available in the QPR,
226 	 * and we have to read it twice to unlatch it anyhow.  This
227 	 * gives us fewer register reads.
228 	 */
229 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* unlatch */
230 	qpr = PHY_READ(sc, MII_ICSPHY_QPR);		/* real value */
231 
232 	if (qpr & QPR_LINK)
233 		mii->mii_media_status |= IFM_ACTIVE;
234 
235 	bmcr = PHY_READ(sc, MII_BMCR);
236 	if (bmcr & BMCR_ISO) {
237 		mii->mii_media_active |= IFM_NONE;
238 		mii->mii_media_status = 0;
239 		return;
240 	}
241 
242 	if (bmcr & BMCR_LOOP)
243 		mii->mii_media_active |= IFM_LOOP;
244 
245 	if (bmcr & BMCR_AUTOEN) {
246 		if ((qpr & QPR_ACOMP) == 0) {
247 			/* Erg, still trying, I guess... */
248 			mii->mii_media_active |= IFM_NONE;
249 			return;
250 		}
251 		if (qpr & QPR_SPEED)
252 			mii->mii_media_active |= IFM_100_TX;
253 		else
254 			mii->mii_media_active |= IFM_10_T;
255 
256 		if (qpr & QPR_FDX)
257 			mii->mii_media_active |= IFM_FDX;
258 		else
259 			mii->mii_media_active |= IFM_HDX;
260 	} else
261 		mii->mii_media_active = ife->ifm_media;
262 }
263 
264 static void
265 icsphy_reset(struct mii_softc *sc)
266 {
267 
268 	mii_phy_reset(sc);
269 	/* set powerdown feature */
270 	switch (sc->mii_mpd_model) {
271 		case MII_MODEL_ICS_1890:
272 		case MII_MODEL_ICS_1893:
273 			PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN);
274 			break;
275 		case MII_MODEL_ICS_1892:
276 			PHY_WRITE(sc, MII_ICSPHY_ECR2,
277 			    ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN);
278 			break;
279 		default:
280 			/* 1889 have no ECR2 */
281 			break;
282 	}
283 	/*
284 	 * There is no description that the reset do auto-negotiation in the
285 	 * data sheet.
286 	 */
287 	PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX);
288 }
289