1 /* $NetBSD: icsphy.c,v 1.41 2006/11/16 21:24:07 christos 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 * 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 40 /* 41 * Copyright (c) 1997 Manuel Bouyer. All rights reserved. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 3. All advertising materials mentioning features or use of this software 52 * must display the following acknowledgement: 53 * This product includes software developed by Manuel Bouyer. 54 * 4. The name of the author may not be used to endorse or promote products 55 * derived from this software without specific prior written permission. 56 * 57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 67 */ 68 69 #include <sys/cdefs.h> 70 __FBSDID("$FreeBSD$"); 71 72 /* 73 * driver for Integrated Circuit Systems' ICS1889-1893 ethernet 10/100 PHY 74 * datasheet from www.icst.com 75 */ 76 77 #include <sys/param.h> 78 #include <sys/systm.h> 79 #include <sys/kernel.h> 80 #include <sys/module.h> 81 #include <sys/socket.h> 82 #include <sys/bus.h> 83 84 #include <net/if.h> 85 #include <net/if_media.h> 86 87 #include <dev/mii/mii.h> 88 #include <dev/mii/miivar.h> 89 #include "miidevs.h" 90 91 #include <dev/mii/icsphyreg.h> 92 93 #include "miibus_if.h" 94 95 static int icsphy_probe(device_t dev); 96 static int icsphy_attach(device_t dev); 97 98 struct icsphy_softc { 99 struct mii_softc mii_sc; 100 int mii_model; 101 }; 102 103 static device_method_t icsphy_methods[] = { 104 /* device interface */ 105 DEVMETHOD(device_probe, icsphy_probe), 106 DEVMETHOD(device_attach, icsphy_attach), 107 DEVMETHOD(device_detach, mii_phy_detach), 108 DEVMETHOD(device_shutdown, bus_generic_shutdown), 109 { 0, 0 } 110 }; 111 112 static devclass_t icsphy_devclass; 113 114 static driver_t icsphy_driver = { 115 "icsphy", 116 icsphy_methods, 117 sizeof(struct icsphy_softc) 118 }; 119 120 DRIVER_MODULE(icsphy, miibus, icsphy_driver, icsphy_devclass, 0, 0); 121 122 static int icsphy_service(struct mii_softc *, struct mii_data *, int); 123 static void icsphy_status(struct mii_softc *); 124 static void icsphy_reset(struct mii_softc *); 125 126 static const struct mii_phydesc icsphys[] = { 127 MII_PHY_DESC(xxICS, 1889), 128 MII_PHY_DESC(xxICS, 1890), 129 MII_PHY_DESC(xxICS, 1892), 130 MII_PHY_DESC(xxICS, 1893), 131 MII_PHY_END 132 }; 133 134 static int 135 icsphy_probe(device_t dev) 136 { 137 138 return (mii_phy_dev_probe(dev, icsphys, BUS_PROBE_DEFAULT)); 139 } 140 141 static int 142 icsphy_attach(device_t dev) 143 { 144 struct icsphy_softc *isc; 145 struct mii_softc *sc; 146 struct mii_attach_args *ma; 147 struct mii_data *mii; 148 149 isc = device_get_softc(dev); 150 sc = &isc->mii_sc; 151 ma = device_get_ivars(dev); 152 sc->mii_dev = device_get_parent(dev); 153 mii = device_get_softc(sc->mii_dev); 154 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list); 155 156 sc->mii_inst = mii->mii_instance; 157 sc->mii_phy = ma->mii_phyno; 158 sc->mii_service = icsphy_service; 159 sc->mii_pdata = mii; 160 sc->mii_anegticks = MII_ANEGTICKS; 161 sc->mii_flags |= MIIF_NOISOLATE; 162 163 mii->mii_instance++; 164 165 ifmedia_add(&mii->mii_media, 166 IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst), 167 MII_MEDIA_100_TX, NULL); 168 169 isc->mii_model = MII_MODEL(ma->mii_id2); 170 icsphy_reset(sc); 171 172 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask; 173 device_printf(dev, " "); 174 mii_phy_add_media(sc); 175 printf("\n"); 176 177 MIIBUS_MEDIAINIT(sc->mii_dev); 178 179 return (0); 180 } 181 182 static int 183 icsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd) 184 { 185 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 186 int reg; 187 188 /* 189 * If we're not selected, then do nothing, just isolate, if 190 * changing media. 191 */ 192 if (IFM_INST(ife->ifm_media) != sc->mii_inst) { 193 if (cmd == MII_MEDIACHG) { 194 reg = PHY_READ(sc, MII_BMCR); 195 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO); 196 } 197 return (0); 198 } 199 200 switch (cmd) { 201 case MII_POLLSTAT: 202 break; 203 204 case MII_MEDIACHG: 205 /* 206 * If the interface is not up, don't do anything. 207 */ 208 if ((mii->mii_ifp->if_flags & IFF_UP) == 0) 209 break; 210 211 mii_phy_setmedia(sc); 212 break; 213 214 case MII_TICK: 215 if (mii_phy_tick(sc) == EJUSTRETURN) 216 return (0); 217 break; 218 } 219 220 /* Update the media status. */ 221 icsphy_status(sc); 222 223 /* Callback if something changed. */ 224 mii_phy_update(sc, cmd); 225 return (0); 226 } 227 228 static void 229 icsphy_status(struct mii_softc *sc) 230 { 231 struct mii_data *mii = sc->mii_pdata; 232 struct ifmedia_entry *ife = mii->mii_media.ifm_cur; 233 int bmcr, qpr; 234 235 mii->mii_media_status = IFM_AVALID; 236 mii->mii_media_active = IFM_ETHER; 237 238 /* 239 * Don't get link from the BMSR. It's available in the QPR, 240 * and we have to read it twice to unlatch it anyhow. This 241 * gives us fewer register reads. 242 */ 243 qpr = PHY_READ(sc, MII_ICSPHY_QPR); /* unlatch */ 244 qpr = PHY_READ(sc, MII_ICSPHY_QPR); /* real value */ 245 246 if (qpr & QPR_LINK) 247 mii->mii_media_status |= IFM_ACTIVE; 248 249 bmcr = PHY_READ(sc, MII_BMCR); 250 if (bmcr & BMCR_ISO) { 251 mii->mii_media_active |= IFM_NONE; 252 mii->mii_media_status = 0; 253 return; 254 } 255 256 if (bmcr & BMCR_LOOP) 257 mii->mii_media_active |= IFM_LOOP; 258 259 if (bmcr & BMCR_AUTOEN) { 260 if ((qpr & QPR_ACOMP) == 0) { 261 /* Erg, still trying, I guess... */ 262 mii->mii_media_active |= IFM_NONE; 263 return; 264 } 265 if (qpr & QPR_SPEED) 266 mii->mii_media_active |= IFM_100_TX; 267 else 268 mii->mii_media_active |= IFM_10_T; 269 if (qpr & QPR_FDX) 270 mii->mii_media_active |= IFM_FDX; 271 else 272 mii->mii_media_active |= IFM_HDX; 273 } else 274 mii->mii_media_active = ife->ifm_media; 275 } 276 277 static void 278 icsphy_reset(struct mii_softc *sc) 279 { 280 struct icsphy_softc *isc = (struct icsphy_softc *)sc; 281 282 mii_phy_reset(sc); 283 /* set powerdown feature */ 284 switch (isc->mii_model) { 285 case MII_MODEL_xxICS_1890: 286 case MII_MODEL_xxICS_1893: 287 PHY_WRITE(sc, MII_ICSPHY_ECR2, ECR2_100AUTOPWRDN); 288 break; 289 case MII_MODEL_xxICS_1892: 290 PHY_WRITE(sc, MII_ICSPHY_ECR2, 291 ECR2_10AUTOPWRDN|ECR2_100AUTOPWRDN); 292 break; 293 default: 294 /* 1889 have no ECR2 */ 295 break; 296 } 297 /* 298 * There is no description that the reset do auto-negotiation in the 299 * data sheet. 300 */ 301 PHY_WRITE(sc, MII_BMCR, BMCR_S100|BMCR_STARTNEG|BMCR_FDX); 302 } 303