1/* $NetBSD: urlphy.c,v 1.31 2016/07/07 06:55:41 msaitoh 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.31 2016/07/07 06:55:41 msaitoh 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
56int urlphydebug = URLPHY_DEBUG;
57#else
58#define DPRINTF(x)
59#define DPRINTFN(n,x)
60#endif
61
62static int urlphy_match(device_t, cfdata_t, void *);
63static void urlphy_attach(device_t, device_t, void *);
64
65CFATTACH_DECL_NEW(urlphy, sizeof(struct mii_softc),
66 urlphy_match, urlphy_attach, mii_phy_detach, mii_phy_activate);
67
68static int urlphy_service(struct mii_softc *, struct mii_data *, int);
69static void urlphy_status(struct mii_softc *);
70
71static const struct mii_phy_funcs urlphy_funcs = {
72 urlphy_service, urlphy_status, mii_phy_reset,
73};
74
75static int
76urlphy_match(device_t parent, cfdata_t match, void *aux)
77{
78 struct mii_attach_args *ma = aux;
79
80 /*
81 * RTL8150 reports OUI == 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
96static void
97urlphy_attach(device_t parent, device_t 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(self), __func__));
107
108 sc->mii_dev = self;
109 sc->mii_inst = mii->mii_instance;
110 sc->mii_phy = ma->mii_phyno;
111 sc->mii_funcs = &urlphy_funcs;
112 sc->mii_pdata = mii;
113 sc->mii_flags = mii->mii_flags;
114 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
115
116 /* Don't do loopback on this PHY. */
117 sc->mii_flags |= MIIF_NOLOOP;
118 /* Don't do isolate on this PHY. */
119 sc->mii_flags |= MIIF_NOISOLATE;
120
121 if (mii->mii_instance != 0) {
122 aprint_error_dev(self,
123 "ignoring this PHY, non-zero instance\n");
124 return;
125 }
126 PHY_RESET(sc);
127
128 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
129 aprint_normal_dev(self, "");
130 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
131 aprint_error("no media present");
132 else
133 mii_phy_add_media(sc);
134 aprint_normal("\n");
135}
136
137static int
138urlphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
139{
140 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
141 int reg;
142
143 DPRINTF(("%s: %s: enter\n", device_xname(sc->mii_dev), __func__));
144
145 switch (cmd) {
146 case MII_POLLSTAT:
147 /*
148 * If we're not polling our PHY instance, just return.
149 */
150 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
151 return (0);
152 break;
153
154 case MII_MEDIACHG:
155 /*
156 * If we're not currently selected, just return.
157 */
158 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
159 return (0);
160
161 /* If the interface is not up, don't do anything. */
162 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
163 break;
164
165 mii_phy_setmedia(sc);
166 break;
167
168 case MII_TICK:
169 /*
170 * If we're not currently selected, just return.
171 */
172 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
173 return (0);
174
175 /* Just bail now if the interface is down. */
176 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
177 return (0);
178
179 /*
180 * If we're not doing autonegotiation, we don't need to do
181 * any extra work here. However, we need to check the link
182 * status so we can generate an announcement if the status
183 * changes.
184 */
185 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
186 break;
187
188 /* Read the status register twice; MSR_LINK is latch-low. */
189 reg = PHY_READ(sc, URLPHY_MSR) | PHY_READ(sc, URLPHY_MSR);
190 if (reg & URLPHY_MSR_LINK) {
191 /*
192 * Reset autonegotiation timer to 0 in case the link
193 * goes down in the next tick.
194 */
195 sc->mii_ticks = 0;
196 /* See above. */
197 break;
198 }
199
200 /*
201 * mii_ticks == 0 means it's the first tick after changing the
202 * media or the link became down since the last tick (see
203 * above), so break to update the status.
204 */
205 if (sc->mii_ticks++ == 0)
206 break;
207
208 /*
209 * Only retry autonegotiation every N seconds.
210 */
211 KASSERT(sc->mii_anegticks != 0);
212 if (sc->mii_ticks <= sc->mii_anegticks)
213 return (0);
214
215 PHY_RESET(sc);
216
217 if (mii_phy_auto(sc, 0) == EJUSTRETURN)
218 return (0);
219
220 break;
221
222 case MII_DOWN:
223 mii_phy_down(sc);
224 return (0);
225 }
226
227 /* Update the media status. */
228 mii_phy_status(sc);
229
230 /* Callback if something changed. */
231 mii_phy_update(sc, cmd);
232
233 return (0);
234}
235
236static void
237urlphy_status(struct mii_softc *sc)
238{
239 struct mii_data *mii = sc->mii_pdata;
240 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
241 int msr, bmsr, bmcr;
242
243 DPRINTF(("%s: %s: enter\n", device_xname(sc->mii_dev), __func__));
244
245 mii->mii_media_status = IFM_AVALID;
246 mii->mii_media_active = IFM_ETHER;
247
248 /*
249 * The link status bit is not exist in the BMSR register,
250 * so we need to read the MSR register to get link status.
251 */
252 msr = PHY_READ(sc, URLPHY_MSR) | PHY_READ(sc, URLPHY_MSR);
253 if (msr & URLPHY_MSR_LINK)
254 mii->mii_media_status |= IFM_ACTIVE;
255
256 DPRINTF(("%s: %s: link %s\n", device_xname(sc->mii_dev), __func__,
257 mii->mii_media_status & IFM_ACTIVE ? "up" : "down"));
258
259 bmcr = PHY_READ(sc, MII_BMCR);
260 if (bmcr & BMCR_AUTOEN) {
261 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
262 if ((bmsr & BMSR_ACOMP) == 0) {
263 /* Erg, still trying, I guess... */
264 mii->mii_media_active |= IFM_NONE;
265 return;
266 }
267
268 if (msr & URLPHY_MSR_SPEED_100)
269 mii->mii_media_active |= IFM_100_TX;
270 else
271 mii->mii_media_active |= IFM_10_T;
272
273 if (msr & URLPHY_MSR_DUPLEX)
274 mii->mii_media_active |= IFM_FDX;
275 else
276 mii->mii_media_active |= IFM_HDX;
277 } else
278 mii->mii_media_active = ife->ifm_media;
279}
280