1 /* $NetBSD: mii.c,v 1.40 2005/12/11 12:22:42 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 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 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 * 39 * $FreeBSD: src/sys/dev/mii/mii.c,v 1.6.2.2 2002/08/19 16:56:33 ambrisko Exp $ 40 * $DragonFly: src/sys/dev/netif/mii_layer/mii.c,v 1.12 2008/07/22 10:59:16 sephe Exp $ 41 */ 42 43 /* 44 * MII bus layer, glues MII-capable network interface drivers to sharable 45 * PHY drivers. This exports an interface compatible with BSD/OS 3.0's, 46 * plus some NetBSD extensions. 47 */ 48 49 #include <sys/param.h> 50 #include <sys/systm.h> 51 #include <sys/socket.h> 52 #include <sys/malloc.h> 53 #include <sys/kernel.h> 54 #include <sys/module.h> 55 #include <sys/bus.h> 56 57 #include <net/if.h> 58 #include <net/if_media.h> 59 60 #include "mii.h" 61 #include "miivar.h" 62 63 #include "miibus_if.h" 64 65 static int miibus_probe(device_t); 66 static int miibus_attach(device_t); 67 static int miibus_detach(device_t); 68 static int miibus_readreg(device_t, int, int); 69 static int miibus_writereg(device_t, int, int, int); 70 static void miibus_statchg(device_t); 71 static void miibus_mediainit(device_t); 72 73 static device_method_t miibus_methods[] = { 74 /* device interface */ 75 DEVMETHOD(device_probe, miibus_probe), 76 DEVMETHOD(device_attach, miibus_attach), 77 DEVMETHOD(device_detach, miibus_detach), 78 DEVMETHOD(device_shutdown, bus_generic_shutdown), 79 80 /* bus interface */ 81 DEVMETHOD(bus_print_child, bus_generic_print_child), 82 DEVMETHOD(bus_driver_added, bus_generic_driver_added), 83 84 /* MII interface */ 85 DEVMETHOD(miibus_readreg, miibus_readreg), 86 DEVMETHOD(miibus_writereg, miibus_writereg), 87 DEVMETHOD(miibus_statchg, miibus_statchg), 88 DEVMETHOD(miibus_mediainit, miibus_mediainit), 89 90 { 0, 0 } 91 }; 92 93 devclass_t miibus_devclass; 94 95 driver_t miibus_driver = { 96 "miibus", 97 miibus_methods, 98 sizeof(struct mii_data) 99 }; 100 101 /* 102 * Check to see if there is a PHY at this address. Note, 103 * many braindead PHYs report 0/0 in their ID registers, 104 * so we test for media in the BMSR. 105 */ 106 static __inline int 107 miibus_no_phy(device_t dev, const struct mii_probe_args *args, int phyno) 108 { 109 int bmsr; 110 111 if ((args->mii_probemask & (1 << phyno)) == 0) 112 return 1; 113 114 bmsr = MIIBUS_READREG(dev, phyno, MII_BMSR); 115 return (bmsr == 0 || bmsr == 0xffff || 116 (bmsr & (BMSR_MEDIAMASK | BMSR_EXTSTAT)) == 0); 117 } 118 119 /* 120 * Helper function used by network interface drivers, attaches PHYs 121 * to the network interface driver parent. 122 */ 123 124 int 125 miibus_probe(device_t dev) 126 { 127 struct mii_attach_args ma, *args; 128 const struct mii_probe_args *probe_args; 129 struct mii_data *mii; 130 device_t child = NULL, parent; 131 132 probe_args = device_get_ivars(dev); 133 134 mii = device_get_softc(dev); 135 parent = device_get_parent(dev); 136 LIST_INIT(&mii->mii_phys); 137 bzero(&ma, sizeof(ma)); 138 139 for (ma.mii_phyno = 0; ma.mii_phyno < MII_NPHY; ma.mii_phyno++) { 140 if (miibus_no_phy(parent, probe_args, ma.mii_phyno)) 141 continue; 142 143 /* 144 * Extract the IDs. Braindead PHYs will be handled by 145 * the `ukphy' driver, as we have no ID information to 146 * match on. 147 */ 148 ma.mii_id1 = MIIBUS_READREG(parent, ma.mii_phyno, 149 MII_PHYIDR1); 150 ma.mii_id2 = MIIBUS_READREG(parent, ma.mii_phyno, 151 MII_PHYIDR2); 152 153 ma.mii_data = mii; 154 ma.mii_capmask = probe_args->mii_capmask; 155 ma.mii_privtag = probe_args->mii_privtag; 156 ma.mii_priv = probe_args->mii_priv; 157 158 args = kmalloc(sizeof(struct mii_attach_args), M_DEVBUF, 159 M_WAITOK); 160 *args = ma; 161 child = device_add_child(dev, NULL, -1); 162 device_set_ivars(child, args); 163 } 164 if (child == NULL) 165 return ENXIO; 166 167 device_set_desc(dev, "MII bus"); 168 return 0; 169 } 170 171 int 172 miibus_attach(device_t dev) 173 { 174 const struct mii_probe_args *probe_args; 175 struct mii_data *mii; 176 177 mii = device_get_softc(dev); 178 mii->mii_ifp = device_get_softc(device_get_parent(dev)); 179 180 probe_args = device_get_ivars(dev); 181 ifmedia_init(&mii->mii_media, IFM_IMASK, 182 probe_args->mii_ifmedia_upd, probe_args->mii_ifmedia_sts); 183 184 bus_generic_attach(dev); 185 return 0; 186 } 187 188 int 189 miibus_detach(device_t dev) 190 { 191 struct mii_data *mii; 192 193 bus_generic_detach(dev); 194 mii = device_get_softc(dev); 195 ifmedia_removeall(&mii->mii_media); 196 mii->mii_ifp = NULL; 197 198 return 0; 199 } 200 201 static int 202 miibus_readreg(device_t dev, int phy, int reg) 203 { 204 device_t parent; 205 206 parent = device_get_parent(dev); 207 return MIIBUS_READREG(parent, phy, reg); 208 } 209 210 static int 211 miibus_writereg(device_t dev, int phy, int reg, int data) 212 { 213 device_t parent; 214 215 parent = device_get_parent(dev); 216 return MIIBUS_WRITEREG(parent, phy, reg, data); 217 } 218 219 static void 220 miibus_statchg(device_t dev) 221 { 222 device_t parent; 223 224 parent = device_get_parent(dev); 225 MIIBUS_STATCHG(parent); 226 } 227 228 static void 229 miibus_mediainit(device_t dev) 230 { 231 struct mii_data *mii; 232 struct ifmedia_entry *m; 233 int media = 0; 234 235 /* Poke the parent in case it has any media of its own to add. */ 236 MIIBUS_MEDIAINIT(device_get_parent(dev)); 237 238 mii = device_get_softc(dev); 239 for (m = LIST_FIRST(&mii->mii_media.ifm_list); m != NULL; 240 m = LIST_NEXT(m, ifm_list)) { 241 media = m->ifm_media; 242 if (media == (IFM_ETHER|IFM_AUTO)) 243 break; 244 } 245 ifmedia_set(&mii->mii_media, media); 246 } 247 248 int 249 mii_phy_probe(device_t dev, device_t *child, 250 ifm_change_cb_t ifmedia_upd, ifm_stat_cb_t ifmedia_sts) 251 { 252 struct mii_probe_args args; 253 254 mii_probe_args_init(&args, ifmedia_upd, ifmedia_sts); 255 return mii_probe(dev, child, &args); 256 } 257 258 int 259 mii_probe(device_t dev, device_t *child, const struct mii_probe_args *args0) 260 { 261 struct mii_probe_args *args; 262 int i; 263 264 args = kmalloc(sizeof(*args), M_DEVBUF, M_WAITOK); 265 *args = *args0; 266 267 *child = device_add_child(dev, "miibus", -1); 268 device_set_ivars(*child, args); 269 270 for (i = 0; i < MII_NPHY; i++) { 271 if (!miibus_no_phy(dev, args0, i)) 272 break; 273 } 274 275 if (i == MII_NPHY) { 276 device_delete_child(dev, *child); 277 *child = NULL; 278 return ENXIO; 279 } 280 281 bus_generic_attach(dev); 282 return 0; 283 } 284 285 void 286 mii_probe_args_init(struct mii_probe_args *args, 287 ifm_change_cb_t ifmedia_upd, ifm_stat_cb_t ifmedia_sts) 288 { 289 memset(args, 0, sizeof(*args)); 290 291 args->mii_ifmedia_upd = ifmedia_upd; 292 args->mii_ifmedia_sts = ifmedia_sts; 293 args->mii_probemask = MII_PROBEMASK_DEFAULT; 294 args->mii_capmask = MII_CAPMASK_DEFAULT; 295 args->mii_privtag = MII_PRIVTAG_NONE; 296 } 297 298 /* 299 * Media changed; notify all PHYs. 300 */ 301 int 302 mii_mediachg(struct mii_data *mii) 303 { 304 struct mii_softc *child; 305 int rv; 306 307 mii->mii_media_status = 0; 308 mii->mii_media_active = IFM_NONE; 309 310 for (child = LIST_FIRST(&mii->mii_phys); child != NULL; 311 child = LIST_NEXT(child, mii_list)) { 312 rv = (*child->mii_service)(child, mii, MII_MEDIACHG); 313 if (rv) { 314 return rv; 315 } else { 316 /* Reset autonegotiation timer. */ 317 child->mii_ticks = 0; 318 } 319 } 320 return 0; 321 } 322 323 /* 324 * Call the PHY tick routines, used during autonegotiation. 325 */ 326 void 327 mii_tick(struct mii_data *mii) 328 { 329 struct mii_softc *child; 330 331 for (child = LIST_FIRST(&mii->mii_phys); child != NULL; 332 child = LIST_NEXT(child, mii_list)) 333 (*child->mii_service)(child, mii, MII_TICK); 334 } 335 336 /* 337 * Get media status from PHYs. 338 */ 339 void 340 mii_pollstat(struct mii_data *mii) 341 { 342 struct mii_softc *child; 343 344 mii->mii_media_status = 0; 345 mii->mii_media_active = IFM_NONE; 346 347 for (child = LIST_FIRST(&mii->mii_phys); child != NULL; 348 child = LIST_NEXT(child, mii_list)) 349 (*child->mii_service)(child, mii, MII_POLLSTAT); 350 } 351 352 static moduledata_t miibus_mod = { "miibus" }; 353 354 DECLARE_MODULE(miibus, miibus_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE); 355 MODULE_VERSION(miibus, 1); 356