xref: /netbsd-src/sys/dev/mii/qsphy.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: qsphy.c,v 1.49 2016/07/07 06:55:41 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 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.49 2016/07/07 06:55:41 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/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 = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
136 	aprint_normal_dev(self, "");
137 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
138 		aprint_error("no media present");
139 	else
140 		mii_phy_add_media(sc);
141 	aprint_normal("\n");
142 }
143 
144 static int
145 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
146 {
147 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
148 	int reg;
149 
150 	switch (cmd) {
151 	case MII_POLLSTAT:
152 		/*
153 		 * If we're not polling our PHY instance, just return.
154 		 */
155 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
156 			return (0);
157 		break;
158 
159 	case MII_MEDIACHG:
160 		/*
161 		 * If the media indicates a different PHY instance,
162 		 * isolate ourselves.
163 		 */
164 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
165 			reg = PHY_READ(sc, MII_BMCR);
166 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
167 			return (0);
168 		}
169 
170 		/*
171 		 * If the interface is not up, don't do anything.
172 		 */
173 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
174 			break;
175 
176 		mii_phy_setmedia(sc);
177 		break;
178 
179 	case MII_TICK:
180 		/*
181 		 * If we're not currently selected, just return.
182 		 */
183 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
184 			return (0);
185 
186 		if (mii_phy_tick(sc) == EJUSTRETURN)
187 			return (0);
188 		break;
189 
190 	case MII_DOWN:
191 		mii_phy_down(sc);
192 		return (0);
193 	}
194 
195 	/* Update the media status. */
196 	mii_phy_status(sc);
197 
198 	/* Callback if something changed. */
199 	mii_phy_update(sc, cmd);
200 	return (0);
201 }
202 
203 static void
204 qsphy_status(struct mii_softc *sc)
205 {
206 	struct mii_data *mii = sc->mii_pdata;
207 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
208 	int bmsr, bmcr, pctl;
209 
210 	mii->mii_media_status = IFM_AVALID;
211 	mii->mii_media_active = IFM_ETHER;
212 
213 	bmsr = PHY_READ(sc, MII_BMSR) |
214 	    PHY_READ(sc, MII_BMSR);
215 	if (bmsr & BMSR_LINK)
216 		mii->mii_media_status |= IFM_ACTIVE;
217 
218 	bmcr = PHY_READ(sc, MII_BMCR);
219 	if (bmcr & BMCR_ISO) {
220 		mii->mii_media_active |= IFM_NONE;
221 		mii->mii_media_status = 0;
222 		return;
223 	}
224 
225 	if (bmcr & BMCR_LOOP)
226 		mii->mii_media_active |= IFM_LOOP;
227 
228 	if (bmcr & BMCR_AUTOEN) {
229 		if ((bmsr & BMSR_ACOMP) == 0) {
230 			/* Erg, still trying, I guess... */
231 			mii->mii_media_active |= IFM_NONE;
232 			return;
233 		}
234 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
235 		    PHY_READ(sc, MII_QSPHY_PCTL);
236 		switch (pctl & PCTL_OPMASK) {
237 		case PCTL_10_T:
238 			mii->mii_media_active |= IFM_10_T|IFM_HDX;
239 			break;
240 		case PCTL_10_T_FDX:
241 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
242 			break;
243 		case PCTL_100_TX:
244 			mii->mii_media_active |= IFM_100_TX|IFM_HDX;
245 			break;
246 		case PCTL_100_TX_FDX:
247 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
248 			break;
249 		case PCTL_100_T4:
250 			mii->mii_media_active |= IFM_100_T4|IFM_HDX;
251 			break;
252 		default:
253 			/* Erg... this shouldn't happen. */
254 			mii->mii_media_active |= IFM_NONE;
255 			break;
256 		}
257 	} else
258 		mii->mii_media_active = ife->ifm_media;
259 }
260 
261 static void
262 qsphy_reset(struct mii_softc *sc)
263 {
264 
265 	mii_phy_reset(sc);
266 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
267 }
268