1 /*	$NetBSD: dmphy.c,v 1.36 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 Davicom's DM9101 ethernet 10/100 PHY
59  * Data Sheet available from www.davicom8.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: dmphy.c,v 1.36 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 #include <sys/errno.h>
71 
72 #include <net/if.h>
73 #include <net/if_media.h>
74 
75 #include <dev/mii/mii.h>
76 #include <dev/mii/miivar.h>
77 #include <dev/mii/miidevs.h>
78 
79 #include <dev/mii/dmphyreg.h>
80 
81 static int	dmphymatch(device_t, cfdata_t, void *);
82 static void	dmphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(dmphy, sizeof(struct mii_softc),
85     dmphymatch, dmphyattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	dmphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	dmphy_status(struct mii_softc *);
89 
90 static const struct mii_phy_funcs dmphy_funcs = {
91 	dmphy_service, dmphy_status, mii_phy_reset,
92 };
93 
94 static const struct mii_phydesc dmphys[] = {
95 	{ MII_OUI_xxDAVICOM,		MII_MODEL_xxDAVICOM_DM9101,
96 	  MII_STR_xxDAVICOM_DM9101 },
97 
98 	{ MII_OUI_xxDAVICOM,		MII_MODEL_xxDAVICOM_DM9102,
99 	  MII_STR_xxDAVICOM_DM9102 },
100 
101 	{ MII_OUI_DAVICOM,		MII_MODEL_xxDAVICOM_DM9101,
102 	  MII_STR_xxDAVICOM_DM9101 },
103 
104 	{ 0,				0,
105 	  NULL },
106 };
107 
108 static int
dmphymatch(device_t parent,cfdata_t match,void * aux)109 dmphymatch(device_t parent, cfdata_t match, void *aux)
110 {
111 	struct mii_attach_args *ma = aux;
112 
113 	if (mii_phy_match(ma, dmphys) != NULL)
114 		return (10);
115 
116 	return (0);
117 }
118 
119 static void
dmphyattach(device_t parent,device_t self,void * aux)120 dmphyattach(device_t parent, device_t self, void *aux)
121 {
122 	struct mii_softc *sc = device_private(self);
123 	struct mii_attach_args *ma = aux;
124 	struct mii_data *mii = ma->mii_data;
125 	const struct mii_phydesc *mpd;
126 
127 	mpd = mii_phy_match(ma, dmphys);
128 	aprint_naive(": Media interface\n");
129 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
130 
131 	sc->mii_dev = self;
132 	sc->mii_inst = mii->mii_instance;
133 	sc->mii_phy = ma->mii_phyno;
134 	sc->mii_funcs = &dmphy_funcs;
135 	sc->mii_pdata = mii;
136 	sc->mii_flags = ma->mii_flags;
137 	sc->mii_anegticks = MII_ANEGTICKS;
138 
139 	PHY_RESET(sc);
140 
141 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
142 	aprint_normal_dev(self, "");
143 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
144 		aprint_error("no media present");
145 	else
146 		mii_phy_add_media(sc);
147 	aprint_normal("\n");
148 }
149 
150 static int
dmphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)151 dmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
152 {
153 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
154 	int reg;
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 static void
dmphy_status(struct mii_softc * sc)210 dmphy_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, dscsr;
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 		/*
236 		 * The PAR status bits are only valid of autonegotiation
237 		 * has completed (or it's disabled).
238 		 */
239 		if ((bmsr & BMSR_ACOMP) == 0) {
240 			/* Erg, still trying, I guess... */
241 			mii->mii_media_active |= IFM_NONE;
242 			return;
243 		}
244 
245 		dscsr = PHY_READ(sc, MII_DMPHY_DSCSR);
246 		if (dscsr & DSCSR_100FDX)
247 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
248 		else if (dscsr & DSCSR_100HDX)
249 			mii->mii_media_active |= IFM_100_TX|IFM_HDX;
250 		else if (dscsr & DSCSR_10FDX)
251 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
252 		else if (dscsr & DSCSR_10HDX)
253 			mii->mii_media_active |= IFM_10_T|IFM_HDX;
254 		else
255 			mii->mii_media_active |= IFM_NONE;
256 	} else
257 		mii->mii_media_active = ife->ifm_media;
258 }
259