xref: /netbsd-src/sys/dev/mii/dmphy.c (revision f3cfa6f6ce31685c6c4a758bc430e69eb99f50a4)
1 /*	$NetBSD: dmphy.c,v 1.43 2019/03/25 09:20:46 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.43 2019/03/25 09:20:46 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_PHY_DESC(xxDAVICOM, DM9101),
96 	MII_PHY_DESC(xxDAVICOM, DM9102),
97 	MII_PHY_DESC(xxDAVICOM, DM9161),
98 	MII_PHY_DESC(xxDAVICOM, DM9161A),
99 	MII_PHY_DESC(xxDAVICOM, DM9161B),
100 	MII_PHY_DESC(xxDAVICOM, DM9601),
101 	MII_PHY_DESC(DAVICOM, DM9101),
102 	MII_PHY_END,
103 };
104 
105 static int
106 dmphymatch(device_t parent, cfdata_t match, void *aux)
107 {
108 	struct mii_attach_args *ma = aux;
109 
110 	if (mii_phy_match(ma, dmphys) != NULL)
111 		return 10;
112 
113 	return 0;
114 }
115 
116 static void
117 dmphyattach(device_t parent, device_t self, void *aux)
118 {
119 	struct mii_softc *sc = device_private(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, dmphys);
125 	aprint_naive(": Media interface\n");
126 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
127 
128 	sc->mii_dev = self;
129 	sc->mii_inst = mii->mii_instance;
130 	sc->mii_phy = ma->mii_phyno;
131 	sc->mii_funcs = &dmphy_funcs;
132 	sc->mii_pdata = mii;
133 	sc->mii_flags = ma->mii_flags;
134 	sc->mii_anegticks = MII_ANEGTICKS;
135 
136 	PHY_RESET(sc);
137 
138 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
139 	sc->mii_capabilities &= ma->mii_capmask;
140 	aprint_normal_dev(self, "");
141 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
142 		aprint_error("no media present");
143 	else
144 		mii_phy_add_media(sc);
145 	aprint_normal("\n");
146 }
147 
148 static int
149 dmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
150 {
151 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
152 	uint16_t reg;
153 
154 	switch (cmd) {
155 	case MII_POLLSTAT:
156 		/* If we're not polling our PHY instance, just return. */
157 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
158 			return 0;
159 		break;
160 
161 	case MII_MEDIACHG:
162 		/*
163 		 * If the media indicates a different PHY instance,
164 		 * isolate ourselves.
165 		 */
166 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
167 			PHY_READ(sc, MII_BMCR, &reg);
168 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
169 			return 0;
170 		}
171 
172 		/* If the interface is not up, don't do anything. */
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 		/* If we're not currently selected, just return. */
181 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
182 			return 0;
183 
184 		if (mii_phy_tick(sc) == EJUSTRETURN)
185 			return 0;
186 		break;
187 
188 	case MII_DOWN:
189 		mii_phy_down(sc);
190 		return 0;
191 	}
192 
193 	/* Update the media status. */
194 	mii_phy_status(sc);
195 
196 	/* Callback if something changed. */
197 	mii_phy_update(sc, cmd);
198 	return 0;
199 }
200 
201 static void
202 dmphy_status(struct mii_softc *sc)
203 {
204 	struct mii_data *mii = sc->mii_pdata;
205 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
206 	uint16_t bmsr, bmcr, dscsr;
207 
208 	mii->mii_media_status = IFM_AVALID;
209 	mii->mii_media_active = IFM_ETHER;
210 
211 	PHY_READ(sc, MII_BMSR, &bmsr);
212 	PHY_READ(sc, MII_BMSR, &bmsr);
213 	if (bmsr & BMSR_LINK)
214 		mii->mii_media_status |= IFM_ACTIVE;
215 
216 	PHY_READ(sc, MII_BMCR, &bmcr);
217 	if (bmcr & BMCR_ISO) {
218 		mii->mii_media_active |= IFM_NONE;
219 		mii->mii_media_status = 0;
220 		return;
221 	}
222 
223 	if (bmcr & BMCR_LOOP)
224 		mii->mii_media_active |= IFM_LOOP;
225 
226 	if (bmcr & BMCR_AUTOEN) {
227 		/*
228 		 * The PAR status bits are only valid if autonegotiation
229 		 * has completed (or it's disabled).
230 		 */
231 		if ((bmsr & BMSR_ACOMP) == 0) {
232 			/* Erg, still trying, I guess... */
233 			mii->mii_media_active |= IFM_NONE;
234 			return;
235 		}
236 
237 		PHY_READ(sc, MII_DMPHY_DSCSR, &dscsr);
238 		if (dscsr & DSCSR_100FDX)
239 			mii->mii_media_active |= IFM_100_TX | IFM_FDX;
240 		else if (dscsr & DSCSR_100HDX)
241 			mii->mii_media_active |= IFM_100_TX | IFM_HDX;
242 		else if (dscsr & DSCSR_10FDX)
243 			mii->mii_media_active |= IFM_10_T | IFM_FDX;
244 		else if (dscsr & DSCSR_10HDX)
245 			mii->mii_media_active |= IFM_10_T | IFM_HDX;
246 		else
247 			mii->mii_media_active |= IFM_NONE;
248 	} else
249 		mii->mii_media_active = ife->ifm_media;
250 }
251