1 /*	$OpenBSD: qsphy.c,v 1.13 2005/02/19 06:00:04 brad Exp $	*/
2 /*	$NetBSD: qsphy.c,v 1.19 2000/02/02 23:34:57 thorpej Exp $	*/
3 
4 /*-
5  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the NetBSD
23  *	Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by Manuel Bouyer.
55  * 4. The name of the author may not be used to endorse or promote products
56  *    derived from this software without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
59  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
60  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
61  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
62  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
63  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
64  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
65  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
67  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68  */
69 
70 /*
71  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
72  * datasheet from www.qualitysemi.com
73  */
74 
75 #include <sys/param.h>
76 #include <sys/systm.h>
77 #include <sys/kernel.h>
78 #include <sys/device.h>
79 #include <sys/socket.h>
80 
81 #include <net/if.h>
82 #include <net/if_media.h>
83 
84 #include <dev/mii/mii.h>
85 #include <dev/mii/miivar.h>
86 #include <dev/mii/miidevs.h>
87 
88 #include <dev/mii/qsphyreg.h>
89 
90 int	qsphymatch(struct device *, void *, void *);
91 void	qsphyattach(struct device *, struct device *, void *);
92 
93 struct cfattach qsphy_ca = {
94 	sizeof(struct mii_softc), qsphymatch, qsphyattach, mii_phy_detach,
95 	    mii_phy_activate
96 };
97 
98 struct cfdriver qsphy_cd = {
99 	NULL, "qsphy", DV_DULL
100 };
101 
102 int	qsphy_service(struct mii_softc *, struct mii_data *, int);
103 void	qsphy_reset(struct mii_softc *);
104 void	qsphy_status(struct mii_softc *);
105 
106 const struct mii_phy_funcs qsphy_funcs = {
107 	qsphy_service, qsphy_status, qsphy_reset,
108 };
109 
110 static const struct mii_phydesc qsphys[] = {
111 	{ MII_OUI_QUALITYSEMI,		MII_MODEL_QUALITYSEMI_QS6612,
112 	  MII_STR_QUALITYSEMI_QS6612 },
113 
114 	{ 0,			0,
115 	  NULL },
116 };
117 
118 int
qsphymatch(struct device * parent,void * match,void * aux)119 qsphymatch(struct device *parent, void *match, void *aux)
120 {
121 	struct mii_attach_args *ma = aux;
122 
123 	if (mii_phy_match(ma, qsphys) != NULL)
124 		return (10);
125 
126 	return (0);
127 }
128 
129 void
qsphyattach(struct device * parent,struct device * self,void * aux)130 qsphyattach(struct device *parent, struct device *self, void *aux)
131 {
132 	struct mii_softc *sc = (struct mii_softc *)self;
133 	struct mii_attach_args *ma = aux;
134 	struct mii_data *mii = ma->mii_data;
135 	const struct mii_phydesc *mpd;
136 
137 	mpd = mii_phy_match(ma, qsphys);
138 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
139 
140 	sc->mii_inst = mii->mii_instance;
141 	sc->mii_phy = ma->mii_phyno;
142 	sc->mii_funcs = &qsphy_funcs;
143 	sc->mii_pdata = mii;
144 	sc->mii_flags = ma->mii_flags;
145 
146 	PHY_RESET(sc);
147 
148 	sc->mii_capabilities =
149 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
150 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
151 		mii_phy_add_media(sc);
152 }
153 
154 int
qsphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)155 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
156 {
157 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
158 	int reg;
159 
160 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
161 		return (ENXIO);
162 
163 	switch (cmd) {
164 	case MII_POLLSTAT:
165 		/*
166 		 * If we're not polling our PHY instance, just return.
167 		 */
168 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
169 			return (0);
170 		break;
171 
172 	case MII_MEDIACHG:
173 		/*
174 		 * If the media indicates a different PHY instance,
175 		 * isolate ourselves.
176 		 */
177 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
178 			reg = PHY_READ(sc, MII_BMCR);
179 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
180 			return (0);
181 		}
182 
183 		/*
184 		 * If the interface is not up, don't do anything.
185 		 */
186 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
187 			break;
188 
189 		mii_phy_setmedia(sc);
190 		break;
191 
192 	case MII_TICK:
193 		/*
194 		 * If we're not currently selected, just return.
195 		 */
196 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
197 			return (0);
198 
199 		if (mii_phy_tick(sc) == EJUSTRETURN)
200 			return (0);
201 		break;
202 
203 	case MII_DOWN:
204 		mii_phy_down(sc);
205 		return (0);
206 	}
207 
208 	/* Update the media status. */
209 	mii_phy_status(sc);
210 
211 	/* Callback if something changed. */
212 	mii_phy_update(sc, cmd);
213 	return (0);
214 }
215 
216 void
qsphy_status(struct mii_softc * sc)217 qsphy_status(struct mii_softc *sc)
218 {
219 	struct mii_data *mii = sc->mii_pdata;
220 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
221 	int bmsr, bmcr, pctl;
222 
223 	mii->mii_media_status = IFM_AVALID;
224 	mii->mii_media_active = IFM_ETHER;
225 
226 	bmsr = PHY_READ(sc, MII_BMSR) |
227 	    PHY_READ(sc, MII_BMSR);
228 	if (bmsr & BMSR_LINK)
229 		mii->mii_media_status |= IFM_ACTIVE;
230 
231 	bmcr = PHY_READ(sc, MII_BMCR);
232 	if (bmcr & BMCR_ISO) {
233 		mii->mii_media_active |= IFM_NONE;
234 		mii->mii_media_status = 0;
235 		return;
236 	}
237 
238 	if (bmcr & BMCR_LOOP)
239 		mii->mii_media_active |= IFM_LOOP;
240 
241 	if (bmcr & BMCR_AUTOEN) {
242 		if ((bmsr & BMSR_ACOMP) == 0) {
243 			/* Erg, still trying, I guess... */
244 			mii->mii_media_active |= IFM_NONE;
245 			return;
246 		}
247 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
248 		    PHY_READ(sc, MII_QSPHY_PCTL);
249 		switch (pctl & PCTL_OPMASK) {
250 		case PCTL_10_T:
251 			mii->mii_media_active |= IFM_10_T;
252 			break;
253 		case PCTL_10_T_FDX:
254 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
255 			break;
256 		case PCTL_100_TX:
257 			mii->mii_media_active |= IFM_100_TX;
258 			break;
259 		case PCTL_100_TX_FDX:
260 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
261 			break;
262 		case PCTL_100_T4:
263 			mii->mii_media_active |= IFM_100_T4;
264 			break;
265 		default:
266 			/* Erg... this shouldn't happen. */
267 			mii->mii_media_active |= IFM_NONE;
268 			break;
269 		}
270 	} else
271 		mii->mii_media_active = ife->ifm_media;
272 }
273 
274 void
qsphy_reset(struct mii_softc * sc)275 qsphy_reset(struct mii_softc *sc)
276 {
277 	mii_phy_reset(sc);
278 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
279 }
280