xref: /netbsd-src/sys/dev/mii/urlphy.c (revision 8ac07aec990b9d2e483062509d0a9fa5b4f57cf2)
1 /*	$NetBSD: urlphy.c,v 1.22 2008/04/08 20:10:20 cegger Exp $	*/
2 /*
3  * Copyright (c) 2001, 2002
4  *     Shingo WATANABE <nabe@nabechan.org>.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the author nor the names of any co-contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 /*
33  * driver for Realtek RL8150L internal phy
34  */
35 
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: urlphy.c,v 1.22 2008/04/08 20:10:20 cegger Exp $");
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/device.h>
43 #include <sys/socket.h>
44 
45 #include <net/if.h>
46 #include <net/if_media.h>
47 
48 #include <dev/mii/mii.h>
49 #include <dev/mii/miivar.h>
50 #include <dev/mii/miidevs.h>
51 #include <dev/mii/urlphyreg.h>
52 
53 #ifdef URLPHY_DEBUG
54 #define DPRINTF(x)	if (urlphydebug) printf x
55 #define DPRINTFN(n,x)	if (urlphydebug>(n)) printf x
56 int urlphydebug = URLPHY_DEBUG;
57 #else
58 #define DPRINTF(x)
59 #define DPRINTFN(n,x)
60 #endif
61 
62 static int	urlphy_match(struct device *, struct cfdata *, void *);
63 static void	urlphy_attach(struct device *, struct device *, void *);
64 
65 CFATTACH_DECL(urlphy, sizeof(struct mii_softc),
66     urlphy_match, urlphy_attach, mii_phy_detach, mii_phy_activate);
67 
68 static int	urlphy_service(struct mii_softc *, struct mii_data *, int);
69 static void	urlphy_status(struct mii_softc *);
70 
71 static const struct mii_phy_funcs urlphy_funcs = {
72 	urlphy_service, urlphy_status, mii_phy_reset,
73 };
74 
75 static int
76 urlphy_match(struct device *parent, struct cfdata *match, void *aux)
77 {
78 	struct mii_attach_args *ma = aux;
79 
80 	/*
81 	 * RTL8150 reports OUT == 0, MODEL == 0
82 	 */
83 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != 0 &&
84 	    MII_MODEL(ma->mii_id2) != 0)
85 		return (0);
86 
87 	/*
88 	 * Make sure the parent is an 'url' device.
89 	 */
90 	if (!device_is_a(parent, "url"))
91 		return(0);
92 
93 	return (10);
94 }
95 
96 static void
97 urlphy_attach(struct device *parent, struct device *self, void *aux)
98 {
99 	struct mii_softc *sc = device_private(self);
100 	struct mii_attach_args *ma = aux;
101 	struct mii_data *mii = ma->mii_data;
102 
103 	aprint_naive(": Media interface\n");
104 	aprint_normal(": Realtek RTL8150L internal media interface\n");
105 
106 	DPRINTF(("%s: %s: enter\n", device_xname(&sc->mii_dev), __func__));
107 
108 	sc->mii_inst = mii->mii_instance;
109 	sc->mii_phy = ma->mii_phyno;
110 	sc->mii_funcs = &urlphy_funcs;
111 	sc->mii_pdata = mii;
112 	sc->mii_flags = mii->mii_flags;
113 	sc->mii_anegticks = MII_ANEGTICKS_GIGE;
114 
115 	/* Don't do loopback on this PHY. */
116 	sc->mii_flags |= MIIF_NOLOOP;
117 	/* Don't do isolate on this PHY. */
118 	sc->mii_flags |= MIIF_NOISOLATE;
119 
120 	if (mii->mii_instance != 0) {
121 		aprint_error_dev(&sc->mii_dev, "ignoring this PHY, non-zero instance\n");
122 		return;
123 	}
124 	PHY_RESET(sc);
125 
126 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
127 	aprint_normal_dev(&sc->mii_dev, "");
128 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
129 		aprint_error("no media present");
130 	else
131 		mii_phy_add_media(sc);
132 	aprint_normal("\n");
133 
134 	if (!pmf_device_register(self, NULL, mii_phy_resume))
135 		aprint_error_dev(self, "couldn't establish power handler\n");
136 }
137 
138 static int
139 urlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
140 {
141 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
142 	int reg;
143 
144 	DPRINTF(("%s: %s: enter\n", device_xname(&sc->mii_dev), __func__));
145 
146 	switch (cmd) {
147 	case MII_POLLSTAT:
148 		/*
149 		 * If we're not polling our PHY instance, just return.
150 		 */
151 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
152 			return (0);
153 		break;
154 
155 	case MII_MEDIACHG:
156 		/*
157 		 * If we're not currently selected, just return.
158 		 */
159 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
160 			return (0);
161 
162 		/* If the interface is not up, don't do anything. */
163 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
164 			break;
165 
166 		mii_phy_setmedia(sc);
167 		break;
168 
169 	case MII_TICK:
170 		/*
171 		 * If we're not currently selected, just return.
172 		 */
173 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
174 			return (0);
175 
176 		/* Just bail now if the interface is down. */
177 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
178 			return (0);
179 
180 		/*
181 		 * If we're not doing autonegotiation, we don't need to do
182 		 * any extra work here.  However, we need to check the link
183 		 * status so we can generate an announcement if the status
184 		 * changes.
185 		 */
186 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
187 			return (0);
188 
189 		/* Read the status register twice; MSR_LINK is latch-low. */
190 		reg = PHY_READ(sc, URLPHY_MSR) | PHY_READ(sc, URLPHY_MSR);
191 		if (reg & URLPHY_MSR_LINK)
192 			return (0);
193 
194 		/*
195 		 * Only retry autonegotiation every N seconds.
196 		 */
197 		KASSERT(sc->mii_anegticks != 0);
198 		if (++sc->mii_ticks <= sc->mii_anegticks)
199 			return (0);
200 
201 		sc->mii_ticks = 0;
202 		PHY_RESET(sc);
203 
204 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
205 			return (0);
206 
207 		break;
208 
209 	case MII_DOWN:
210 		mii_phy_down(sc);
211 		return (0);
212 	}
213 
214 	/* Update the media status. */
215 	mii_phy_status(sc);
216 
217 	/* Callback if something changed. */
218 	mii_phy_update(sc, cmd);
219 
220 	return (0);
221 }
222 
223 static void
224 urlphy_status(struct mii_softc *sc)
225 {
226 	struct mii_data *mii = sc->mii_pdata;
227 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
228 	int msr, bmsr, bmcr;
229 
230 	DPRINTF(("%s: %s: enter\n", device_xname(&sc->mii_dev), __func__));
231 
232 	mii->mii_media_status = IFM_AVALID;
233 	mii->mii_media_active = IFM_ETHER;
234 
235 	/*
236 	 * The link status bit is not exist in the BMSR register,
237 	 * so we need to read the MSR register to get link status.
238 	 */
239 	msr = PHY_READ(sc, URLPHY_MSR) | PHY_READ(sc, URLPHY_MSR);
240 	if (msr & URLPHY_MSR_LINK)
241 		mii->mii_media_status |= IFM_ACTIVE;
242 
243 	DPRINTF(("%s: %s: link %s\n", device_xname(&sc->mii_dev), __func__,
244 		 mii->mii_media_status & IFM_ACTIVE ? "up" : "down"));
245 
246 	bmcr = PHY_READ(sc, MII_BMCR);
247 	if (bmcr & BMCR_AUTOEN) {
248 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
249 		if ((bmsr & BMSR_ACOMP) == 0) {
250 			/* Erg, still trying, I guess... */
251 			mii->mii_media_active |= IFM_NONE;
252 			return;
253 		}
254 
255 		if (msr & URLPHY_MSR_SPEED_100)
256 			mii->mii_media_active |= IFM_100_TX;
257 		else
258 			mii->mii_media_active |= IFM_10_T;
259 		if (msr & URLPHY_MSR_DUPLEX)
260 			mii->mii_media_active |= IFM_FDX;
261 	} else
262 		mii->mii_media_active = ife->ifm_media;
263 }
264