xref: /netbsd/sys/dev/mii/qsphy.c (revision 6550d01e)
1 /*	$NetBSD: qsphy.c,v 1.47 2009/10/19 18:41:14 bouyer 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 Quality Semiconductor's QS6612 ethernet 10/100 PHY
59  * datasheet from www.qualitysemi.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: qsphy.c,v 1.47 2009/10/19 18:41:14 bouyer 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/qsphyreg.h>
79 
80 static int	qsphymatch(device_t, cfdata_t, void *);
81 static void	qsphyattach(device_t, device_t, void *);
82 
83 CFATTACH_DECL_NEW(qsphy, sizeof(struct mii_softc),
84     qsphymatch, qsphyattach, mii_phy_detach, mii_phy_activate);
85 
86 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
87 static void	qsphy_status(struct mii_softc *);
88 static void	qsphy_reset(struct mii_softc *);
89 
90 static const struct mii_phy_funcs qsphy_funcs = {
91 	qsphy_service, qsphy_status, qsphy_reset,
92 };
93 
94 static const struct mii_phydesc qsphys[] = {
95 	{ MII_OUI_xxQUALSEMI,		MII_MODEL_xxQUALSEMI_QS6612,
96 	  MII_STR_xxQUALSEMI_QS6612 },
97 
98 	{ 0,				0,
99 	  NULL },
100 };
101 
102 static int
103 qsphymatch(device_t parent, cfdata_t match, void *aux)
104 {
105 	struct mii_attach_args *ma = aux;
106 
107 	if (mii_phy_match(ma, qsphys) != NULL)
108 		return (10);
109 
110 	return (0);
111 }
112 
113 static void
114 qsphyattach(device_t parent, device_t self, void *aux)
115 {
116 	struct mii_softc *sc = device_private(self);
117 	struct mii_attach_args *ma = aux;
118 	struct mii_data *mii = ma->mii_data;
119 	const struct mii_phydesc *mpd;
120 
121 	mpd = mii_phy_match(ma, qsphys);
122 	aprint_naive(": Media interface\n");
123 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
124 
125 	sc->mii_dev = self;
126 	sc->mii_inst = mii->mii_instance;
127 	sc->mii_phy = ma->mii_phyno;
128 	sc->mii_funcs = &qsphy_funcs;
129 	sc->mii_pdata = mii;
130 	sc->mii_flags = ma->mii_flags;
131 	sc->mii_anegticks = MII_ANEGTICKS;
132 
133 	PHY_RESET(sc);
134 
135 	sc->mii_capabilities =
136 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
137 	aprint_normal_dev(self, "");
138 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
139 		aprint_error("no media present");
140 	else
141 		mii_phy_add_media(sc);
142 	aprint_normal("\n");
143 }
144 
145 static int
146 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
147 {
148 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
149 	int reg;
150 
151 	switch (cmd) {
152 	case MII_POLLSTAT:
153 		/*
154 		 * If we're not polling our PHY instance, just return.
155 		 */
156 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
157 			return (0);
158 		break;
159 
160 	case MII_MEDIACHG:
161 		/*
162 		 * If the media indicates a different PHY instance,
163 		 * isolate ourselves.
164 		 */
165 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
166 			reg = PHY_READ(sc, MII_BMCR);
167 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
168 			return (0);
169 		}
170 
171 		/*
172 		 * If the interface is not up, don't do anything.
173 		 */
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 		/*
182 		 * If we're not currently selected, just return.
183 		 */
184 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
185 			return (0);
186 
187 		if (mii_phy_tick(sc) == EJUSTRETURN)
188 			return (0);
189 		break;
190 
191 	case MII_DOWN:
192 		mii_phy_down(sc);
193 		return (0);
194 	}
195 
196 	/* Update the media status. */
197 	mii_phy_status(sc);
198 
199 	/* Callback if something changed. */
200 	mii_phy_update(sc, cmd);
201 	return (0);
202 }
203 
204 static void
205 qsphy_status(struct mii_softc *sc)
206 {
207 	struct mii_data *mii = sc->mii_pdata;
208 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
209 	int bmsr, bmcr, pctl;
210 
211 	mii->mii_media_status = IFM_AVALID;
212 	mii->mii_media_active = IFM_ETHER;
213 
214 	bmsr = PHY_READ(sc, MII_BMSR) |
215 	    PHY_READ(sc, MII_BMSR);
216 	if (bmsr & BMSR_LINK)
217 		mii->mii_media_status |= IFM_ACTIVE;
218 
219 	bmcr = PHY_READ(sc, MII_BMCR);
220 	if (bmcr & BMCR_ISO) {
221 		mii->mii_media_active |= IFM_NONE;
222 		mii->mii_media_status = 0;
223 		return;
224 	}
225 
226 	if (bmcr & BMCR_LOOP)
227 		mii->mii_media_active |= IFM_LOOP;
228 
229 	if (bmcr & BMCR_AUTOEN) {
230 		if ((bmsr & BMSR_ACOMP) == 0) {
231 			/* Erg, still trying, I guess... */
232 			mii->mii_media_active |= IFM_NONE;
233 			return;
234 		}
235 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
236 		    PHY_READ(sc, MII_QSPHY_PCTL);
237 		switch (pctl & PCTL_OPMASK) {
238 		case PCTL_10_T:
239 			mii->mii_media_active |= IFM_10_T;
240 			break;
241 		case PCTL_10_T_FDX:
242 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
243 			break;
244 		case PCTL_100_TX:
245 			mii->mii_media_active |= IFM_100_TX;
246 			break;
247 		case PCTL_100_TX_FDX:
248 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
249 			break;
250 		case PCTL_100_T4:
251 			mii->mii_media_active |= IFM_100_T4;
252 			break;
253 		default:
254 			/* Erg... this shouldn't happen. */
255 			mii->mii_media_active |= IFM_NONE;
256 			break;
257 		}
258 	} else
259 		mii->mii_media_active = ife->ifm_media;
260 }
261 
262 static void
263 qsphy_reset(struct mii_softc *sc)
264 {
265 
266 	mii_phy_reset(sc);
267 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
268 }
269