xref: /netbsd-src/sys/dev/mii/qsphy.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: qsphy.c,v 1.46 2008/11/17 03:04:27 dyoung 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  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Manuel Bouyer.
47  * 4. The name of the author may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 /*
63  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
64  * datasheet from www.qualitysemi.com
65  */
66 
67 #include <sys/cdefs.h>
68 __KERNEL_RCSID(0, "$NetBSD: qsphy.c,v 1.46 2008/11/17 03:04:27 dyoung Exp $");
69 
70 #include <sys/param.h>
71 #include <sys/systm.h>
72 #include <sys/kernel.h>
73 #include <sys/device.h>
74 #include <sys/socket.h>
75 
76 #include <net/if.h>
77 #include <net/if_media.h>
78 
79 #include <dev/mii/mii.h>
80 #include <dev/mii/miivar.h>
81 #include <dev/mii/miidevs.h>
82 
83 #include <dev/mii/qsphyreg.h>
84 
85 static int	qsphymatch(device_t, cfdata_t, void *);
86 static void	qsphyattach(device_t, device_t, void *);
87 
88 CFATTACH_DECL_NEW(qsphy, sizeof(struct mii_softc),
89     qsphymatch, qsphyattach, mii_phy_detach, mii_phy_activate);
90 
91 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
92 static void	qsphy_status(struct mii_softc *);
93 static void	qsphy_reset(struct mii_softc *);
94 
95 static const struct mii_phy_funcs qsphy_funcs = {
96 	qsphy_service, qsphy_status, qsphy_reset,
97 };
98 
99 static const struct mii_phydesc qsphys[] = {
100 	{ MII_OUI_xxQUALSEMI,		MII_MODEL_xxQUALSEMI_QS6612,
101 	  MII_STR_xxQUALSEMI_QS6612 },
102 
103 	{ 0,				0,
104 	  NULL },
105 };
106 
107 static int
108 qsphymatch(device_t parent, cfdata_t match, void *aux)
109 {
110 	struct mii_attach_args *ma = aux;
111 
112 	if (mii_phy_match(ma, qsphys) != NULL)
113 		return (10);
114 
115 	return (0);
116 }
117 
118 static void
119 qsphyattach(device_t parent, device_t self, void *aux)
120 {
121 	struct mii_softc *sc = device_private(self);
122 	struct mii_attach_args *ma = aux;
123 	struct mii_data *mii = ma->mii_data;
124 	const struct mii_phydesc *mpd;
125 
126 	mpd = mii_phy_match(ma, qsphys);
127 	aprint_naive(": Media interface\n");
128 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
129 
130 	sc->mii_dev = self;
131 	sc->mii_inst = mii->mii_instance;
132 	sc->mii_phy = ma->mii_phyno;
133 	sc->mii_funcs = &qsphy_funcs;
134 	sc->mii_pdata = mii;
135 	sc->mii_flags = ma->mii_flags;
136 	sc->mii_anegticks = MII_ANEGTICKS;
137 
138 	PHY_RESET(sc);
139 
140 	sc->mii_capabilities =
141 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
142 	aprint_normal_dev(self, "");
143 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
144 		aprint_error("no media present");
145 	else
146 		mii_phy_add_media(sc);
147 	aprint_normal("\n");
148 }
149 
150 static int
151 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
152 {
153 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
154 	int reg;
155 
156 	switch (cmd) {
157 	case MII_POLLSTAT:
158 		/*
159 		 * If we're not polling our PHY instance, just return.
160 		 */
161 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
162 			return (0);
163 		break;
164 
165 	case MII_MEDIACHG:
166 		/*
167 		 * If the media indicates a different PHY instance,
168 		 * isolate ourselves.
169 		 */
170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
171 			reg = PHY_READ(sc, MII_BMCR);
172 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
173 			return (0);
174 		}
175 
176 		/*
177 		 * If the interface is not up, don't do anything.
178 		 */
179 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
180 			break;
181 
182 		mii_phy_setmedia(sc);
183 		break;
184 
185 	case MII_TICK:
186 		/*
187 		 * If we're not currently selected, just return.
188 		 */
189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
190 			return (0);
191 
192 		if (mii_phy_tick(sc) == EJUSTRETURN)
193 			return (0);
194 		break;
195 
196 	case MII_DOWN:
197 		mii_phy_down(sc);
198 		return (0);
199 	}
200 
201 	/* Update the media status. */
202 	mii_phy_status(sc);
203 
204 	/* Callback if something changed. */
205 	mii_phy_update(sc, cmd);
206 	return (0);
207 }
208 
209 static void
210 qsphy_status(struct mii_softc *sc)
211 {
212 	struct mii_data *mii = sc->mii_pdata;
213 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
214 	int bmsr, bmcr, pctl;
215 
216 	mii->mii_media_status = IFM_AVALID;
217 	mii->mii_media_active = IFM_ETHER;
218 
219 	bmsr = PHY_READ(sc, MII_BMSR) |
220 	    PHY_READ(sc, MII_BMSR);
221 	if (bmsr & BMSR_LINK)
222 		mii->mii_media_status |= IFM_ACTIVE;
223 
224 	bmcr = PHY_READ(sc, MII_BMCR);
225 	if (bmcr & BMCR_ISO) {
226 		mii->mii_media_active |= IFM_NONE;
227 		mii->mii_media_status = 0;
228 		return;
229 	}
230 
231 	if (bmcr & BMCR_LOOP)
232 		mii->mii_media_active |= IFM_LOOP;
233 
234 	if (bmcr & BMCR_AUTOEN) {
235 		if ((bmsr & BMSR_ACOMP) == 0) {
236 			/* Erg, still trying, I guess... */
237 			mii->mii_media_active |= IFM_NONE;
238 			return;
239 		}
240 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
241 		    PHY_READ(sc, MII_QSPHY_PCTL);
242 		switch (pctl & PCTL_OPMASK) {
243 		case PCTL_10_T:
244 			mii->mii_media_active |= IFM_10_T;
245 			break;
246 		case PCTL_10_T_FDX:
247 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
248 			break;
249 		case PCTL_100_TX:
250 			mii->mii_media_active |= IFM_100_TX;
251 			break;
252 		case PCTL_100_TX_FDX:
253 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
254 			break;
255 		case PCTL_100_T4:
256 			mii->mii_media_active |= IFM_100_T4;
257 			break;
258 		default:
259 			/* Erg... this shouldn't happen. */
260 			mii->mii_media_active |= IFM_NONE;
261 			break;
262 		}
263 	} else
264 		mii->mii_media_active = ife->ifm_media;
265 }
266 
267 static void
268 qsphy_reset(struct mii_softc *sc)
269 {
270 
271 	mii_phy_reset(sc);
272 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
273 }
274