xref: /openbsd/sys/dev/mii/qsphy.c (revision 404b540a)
1 /*	$OpenBSD: qsphy.c,v 1.17 2008/10/25 00:10:21 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  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by Manuel Bouyer.
48  * 4. The name of the author may not be used to endorse or promote products
49  *    derived from this software without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
52  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
53  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
54  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
55  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
60  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  */
62 
63 /*
64  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
65  * datasheet from www.qualitysemi.com
66  */
67 
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h>
71 #include <sys/device.h>
72 #include <sys/socket.h>
73 
74 #include <net/if.h>
75 #include <net/if_media.h>
76 
77 #include <dev/mii/mii.h>
78 #include <dev/mii/miivar.h>
79 #include <dev/mii/miidevs.h>
80 
81 #include <dev/mii/qsphyreg.h>
82 
83 int	qsphymatch(struct device *, void *, void *);
84 void	qsphyattach(struct device *, struct device *, void *);
85 
86 struct cfattach qsphy_ca = {
87 	sizeof(struct mii_softc), qsphymatch, qsphyattach, mii_phy_detach,
88 	    mii_phy_activate
89 };
90 
91 struct cfdriver qsphy_cd = {
92 	NULL, "qsphy", DV_DULL
93 };
94 
95 int	qsphy_service(struct mii_softc *, struct mii_data *, int);
96 void	qsphy_reset(struct mii_softc *);
97 void	qsphy_status(struct mii_softc *);
98 
99 const struct mii_phy_funcs qsphy_funcs = {
100 	qsphy_service, qsphy_status, qsphy_reset,
101 };
102 
103 static const struct mii_phydesc qsphys[] = {
104 	{ MII_OUI_QUALITYSEMI,		MII_MODEL_QUALITYSEMI_QS6612,
105 	  MII_STR_QUALITYSEMI_QS6612 },
106 
107 	{ 0,			0,
108 	  NULL },
109 };
110 
111 int
112 qsphymatch(struct device *parent, void *match, void *aux)
113 {
114 	struct mii_attach_args *ma = aux;
115 
116 	if (mii_phy_match(ma, qsphys) != NULL)
117 		return (10);
118 
119 	return (0);
120 }
121 
122 void
123 qsphyattach(struct device *parent, struct device *self, void *aux)
124 {
125 	struct mii_softc *sc = (struct mii_softc *)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, qsphys);
131 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
132 
133 	sc->mii_inst = mii->mii_instance;
134 	sc->mii_phy = ma->mii_phyno;
135 	sc->mii_funcs = &qsphy_funcs;
136 	sc->mii_pdata = mii;
137 	sc->mii_flags = ma->mii_flags;
138 
139 	PHY_RESET(sc);
140 
141 	sc->mii_capabilities =
142 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
143 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
144 		mii_phy_add_media(sc);
145 }
146 
147 int
148 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
149 {
150 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
151 	int reg;
152 
153 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
154 		return (ENXIO);
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 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|IFM_HDX;
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|IFM_HDX;
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|IFM_HDX;
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 void
268 qsphy_reset(struct mii_softc *sc)
269 {
270 	mii_phy_reset(sc);
271 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
272 }
273