xref: /openbsd/sys/dev/mii/qsphy.c (revision 471aeecf)
1 /*	$OpenBSD: qsphy.c,v 1.22 2022/04/06 18:59:29 naddy 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  *
46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
47  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
50  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
51  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
52  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
53  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
54  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
55  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 /*
59  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
60  * datasheet from www.qualitysemi.com
61  */
62 
63 #include <sys/param.h>
64 #include <sys/systm.h>
65 #include <sys/device.h>
66 #include <sys/socket.h>
67 
68 #include <net/if.h>
69 #include <net/if_var.h>
70 #include <net/if_media.h>
71 
72 #include <dev/mii/mii.h>
73 #include <dev/mii/miivar.h>
74 #include <dev/mii/miidevs.h>
75 
76 #include <dev/mii/qsphyreg.h>
77 
78 int	qsphymatch(struct device *, void *, void *);
79 void	qsphyattach(struct device *, struct device *, void *);
80 
81 const struct cfattach qsphy_ca = {
82 	sizeof(struct mii_softc), qsphymatch, qsphyattach, mii_phy_detach
83 };
84 
85 struct cfdriver qsphy_cd = {
86 	NULL, "qsphy", DV_DULL
87 };
88 
89 int	qsphy_service(struct mii_softc *, struct mii_data *, int);
90 void	qsphy_reset(struct mii_softc *);
91 void	qsphy_status(struct mii_softc *);
92 
93 const struct mii_phy_funcs qsphy_funcs = {
94 	qsphy_service, qsphy_status, qsphy_reset,
95 };
96 
97 static const struct mii_phydesc qsphys[] = {
98 	{ MII_OUI_QUALITYSEMI,		MII_MODEL_QUALITYSEMI_QS6612,
99 	  MII_STR_QUALITYSEMI_QS6612 },
100 
101 	{ 0,			0,
102 	  NULL },
103 };
104 
105 int
qsphymatch(struct device * parent,void * match,void * aux)106 qsphymatch(struct device *parent, void *match, void *aux)
107 {
108 	struct mii_attach_args *ma = aux;
109 
110 	if (mii_phy_match(ma, qsphys) != NULL)
111 		return (10);
112 
113 	return (0);
114 }
115 
116 void
qsphyattach(struct device * parent,struct device * self,void * aux)117 qsphyattach(struct device *parent, struct device *self, void *aux)
118 {
119 	struct mii_softc *sc = (struct mii_softc *)self;
120 	struct mii_attach_args *ma = aux;
121 	struct mii_data *mii = ma->mii_data;
122 	const struct mii_phydesc *mpd;
123 
124 	mpd = mii_phy_match(ma, qsphys);
125 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
126 
127 	sc->mii_inst = mii->mii_instance;
128 	sc->mii_phy = ma->mii_phyno;
129 	sc->mii_funcs = &qsphy_funcs;
130 	sc->mii_pdata = mii;
131 	sc->mii_flags = ma->mii_flags;
132 
133 	PHY_RESET(sc);
134 
135 	sc->mii_capabilities =
136 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
137 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
138 		mii_phy_add_media(sc);
139 }
140 
141 int
qsphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)142 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
143 {
144 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
145 	int reg;
146 
147 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
148 		return (ENXIO);
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 void
qsphy_status(struct mii_softc * sc)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 void
qsphy_reset(struct mii_softc * sc)262 qsphy_reset(struct mii_softc *sc)
263 {
264 	mii_phy_reset(sc);
265 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
266 }
267