1 /* 2 * ASIX AX88172A based USB 2.0 Ethernet Devices 3 * Copyright (C) 2012 OMICRON electronics GmbH 4 * 5 * Supports external PHYs via phylib. Based on the driver for the 6 * AX88772. Original copyrights follow: 7 * 8 * Copyright (C) 2003-2006 David Hollis <dhollis@davehollis.com> 9 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net> 10 * Copyright (C) 2006 James Painter <jamie.painter@iname.com> 11 * Copyright (c) 2002-2003 TiVo Inc. 12 * 13 * This program is free software; you can redistribute it and/or modify 14 * it under the terms of the GNU General Public License as published by 15 * the Free Software Foundation; either version 2 of the License, or 16 * (at your option) any later version. 17 * 18 * This program is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU General Public License for more details. 22 * 23 * You should have received a copy of the GNU General Public License 24 * along with this program; if not, see <http://www.gnu.org/licenses/>. 25 */ 26 27 #include "asix.h" 28 #include <linux/phy.h> 29 30 struct ax88172a_private { 31 struct mii_bus *mdio; 32 struct phy_device *phydev; 33 char phy_name[20]; 34 u16 phy_addr; 35 u16 oldmode; 36 int use_embdphy; 37 struct asix_rx_fixup_info rx_fixup_info; 38 }; 39 40 /* MDIO read and write wrappers for phylib */ 41 static int asix_mdio_bus_read(struct mii_bus *bus, int phy_id, int regnum) 42 { 43 return asix_mdio_read(((struct usbnet *)bus->priv)->net, phy_id, 44 regnum); 45 } 46 47 static int asix_mdio_bus_write(struct mii_bus *bus, int phy_id, int regnum, 48 u16 val) 49 { 50 asix_mdio_write(((struct usbnet *)bus->priv)->net, phy_id, regnum, val); 51 return 0; 52 } 53 54 static int ax88172a_ioctl(struct net_device *net, struct ifreq *rq, int cmd) 55 { 56 if (!netif_running(net)) 57 return -EINVAL; 58 59 if (!net->phydev) 60 return -ENODEV; 61 62 return phy_mii_ioctl(net->phydev, rq, cmd); 63 } 64 65 /* set MAC link settings according to information from phylib */ 66 static void ax88172a_adjust_link(struct net_device *netdev) 67 { 68 struct phy_device *phydev = netdev->phydev; 69 struct usbnet *dev = netdev_priv(netdev); 70 struct ax88172a_private *priv = dev->driver_priv; 71 u16 mode = 0; 72 73 if (phydev->link) { 74 mode = AX88772_MEDIUM_DEFAULT; 75 76 if (phydev->duplex == DUPLEX_HALF) 77 mode &= ~AX_MEDIUM_FD; 78 79 if (phydev->speed != SPEED_100) 80 mode &= ~AX_MEDIUM_PS; 81 } 82 83 if (mode != priv->oldmode) { 84 asix_write_medium_mode(dev, mode, 0); 85 priv->oldmode = mode; 86 netdev_dbg(netdev, "speed %u duplex %d, setting mode to 0x%04x\n", 87 phydev->speed, phydev->duplex, mode); 88 phy_print_status(phydev); 89 } 90 } 91 92 static void ax88172a_status(struct usbnet *dev, struct urb *urb) 93 { 94 /* link changes are detected by polling the phy */ 95 } 96 97 /* use phylib infrastructure */ 98 static int ax88172a_init_mdio(struct usbnet *dev) 99 { 100 struct ax88172a_private *priv = dev->driver_priv; 101 int ret; 102 103 priv->mdio = mdiobus_alloc(); 104 if (!priv->mdio) { 105 netdev_err(dev->net, "Could not allocate MDIO bus\n"); 106 return -ENOMEM; 107 } 108 109 priv->mdio->priv = (void *)dev; 110 priv->mdio->read = &asix_mdio_bus_read; 111 priv->mdio->write = &asix_mdio_bus_write; 112 priv->mdio->name = "Asix MDIO Bus"; 113 /* mii bus name is usb-<usb bus number>-<usb device number> */ 114 snprintf(priv->mdio->id, MII_BUS_ID_SIZE, "usb-%03d:%03d", 115 dev->udev->bus->busnum, dev->udev->devnum); 116 117 ret = mdiobus_register(priv->mdio); 118 if (ret) { 119 netdev_err(dev->net, "Could not register MDIO bus\n"); 120 goto mfree; 121 } 122 123 netdev_info(dev->net, "registered mdio bus %s\n", priv->mdio->id); 124 return 0; 125 126 mfree: 127 mdiobus_free(priv->mdio); 128 return ret; 129 } 130 131 static void ax88172a_remove_mdio(struct usbnet *dev) 132 { 133 struct ax88172a_private *priv = dev->driver_priv; 134 135 netdev_info(dev->net, "deregistering mdio bus %s\n", priv->mdio->id); 136 mdiobus_unregister(priv->mdio); 137 mdiobus_free(priv->mdio); 138 } 139 140 static const struct net_device_ops ax88172a_netdev_ops = { 141 .ndo_open = usbnet_open, 142 .ndo_stop = usbnet_stop, 143 .ndo_start_xmit = usbnet_start_xmit, 144 .ndo_tx_timeout = usbnet_tx_timeout, 145 .ndo_change_mtu = usbnet_change_mtu, 146 .ndo_set_mac_address = asix_set_mac_address, 147 .ndo_validate_addr = eth_validate_addr, 148 .ndo_do_ioctl = ax88172a_ioctl, 149 .ndo_set_rx_mode = asix_set_multicast, 150 }; 151 152 static int ax88172a_nway_reset(struct net_device *net) 153 { 154 if (!net->phydev) 155 return -ENODEV; 156 157 return phy_start_aneg(net->phydev); 158 } 159 160 static const struct ethtool_ops ax88172a_ethtool_ops = { 161 .get_drvinfo = asix_get_drvinfo, 162 .get_link = usbnet_get_link, 163 .get_msglevel = usbnet_get_msglevel, 164 .set_msglevel = usbnet_set_msglevel, 165 .get_wol = asix_get_wol, 166 .set_wol = asix_set_wol, 167 .get_eeprom_len = asix_get_eeprom_len, 168 .get_eeprom = asix_get_eeprom, 169 .set_eeprom = asix_set_eeprom, 170 .nway_reset = ax88172a_nway_reset, 171 .get_link_ksettings = phy_ethtool_get_link_ksettings, 172 .set_link_ksettings = phy_ethtool_set_link_ksettings, 173 }; 174 175 static int ax88172a_reset_phy(struct usbnet *dev, int embd_phy) 176 { 177 int ret; 178 179 ret = asix_sw_reset(dev, AX_SWRESET_IPPD, 0); 180 if (ret < 0) 181 goto err; 182 183 msleep(150); 184 ret = asix_sw_reset(dev, AX_SWRESET_CLEAR, 0); 185 if (ret < 0) 186 goto err; 187 188 msleep(150); 189 190 ret = asix_sw_reset(dev, embd_phy ? AX_SWRESET_IPRL : AX_SWRESET_IPPD, 191 0); 192 if (ret < 0) 193 goto err; 194 195 return 0; 196 197 err: 198 return ret; 199 } 200 201 202 static int ax88172a_bind(struct usbnet *dev, struct usb_interface *intf) 203 { 204 int ret; 205 u8 buf[ETH_ALEN]; 206 struct ax88172a_private *priv; 207 208 usbnet_get_endpoints(dev, intf); 209 210 priv = kzalloc(sizeof(*priv), GFP_KERNEL); 211 if (!priv) 212 return -ENOMEM; 213 214 dev->driver_priv = priv; 215 216 /* Get the MAC address */ 217 ret = asix_read_cmd(dev, AX_CMD_READ_NODE_ID, 0, 0, ETH_ALEN, buf, 0); 218 if (ret < 0) { 219 netdev_err(dev->net, "Failed to read MAC address: %d\n", ret); 220 goto free; 221 } 222 memcpy(dev->net->dev_addr, buf, ETH_ALEN); 223 224 dev->net->netdev_ops = &ax88172a_netdev_ops; 225 dev->net->ethtool_ops = &ax88172a_ethtool_ops; 226 227 /* are we using the internal or the external phy? */ 228 ret = asix_read_cmd(dev, AX_CMD_SW_PHY_STATUS, 0, 0, 1, buf, 0); 229 if (ret < 0) { 230 netdev_err(dev->net, "Failed to read software interface selection register: %d\n", 231 ret); 232 goto free; 233 } 234 235 netdev_dbg(dev->net, "AX_CMD_SW_PHY_STATUS = 0x%02x\n", buf[0]); 236 switch (buf[0] & AX_PHY_SELECT_MASK) { 237 case AX_PHY_SELECT_INTERNAL: 238 netdev_dbg(dev->net, "use internal phy\n"); 239 priv->use_embdphy = 1; 240 break; 241 case AX_PHY_SELECT_EXTERNAL: 242 netdev_dbg(dev->net, "use external phy\n"); 243 priv->use_embdphy = 0; 244 break; 245 default: 246 netdev_err(dev->net, "Interface mode not supported by driver\n"); 247 ret = -ENOTSUPP; 248 goto free; 249 } 250 251 priv->phy_addr = asix_read_phy_addr(dev, priv->use_embdphy); 252 ax88172a_reset_phy(dev, priv->use_embdphy); 253 254 /* Asix framing packs multiple eth frames into a 2K usb bulk transfer */ 255 if (dev->driver_info->flags & FLAG_FRAMING_AX) { 256 /* hard_mtu is still the default - the device does not support 257 jumbo eth frames */ 258 dev->rx_urb_size = 2048; 259 } 260 261 /* init MDIO bus */ 262 ret = ax88172a_init_mdio(dev); 263 if (ret) 264 goto free; 265 266 return 0; 267 268 free: 269 kfree(priv); 270 return ret; 271 } 272 273 static int ax88172a_stop(struct usbnet *dev) 274 { 275 struct ax88172a_private *priv = dev->driver_priv; 276 277 netdev_dbg(dev->net, "Stopping interface\n"); 278 279 if (priv->phydev) { 280 netdev_info(dev->net, "Disconnecting from phy %s\n", 281 priv->phy_name); 282 phy_stop(priv->phydev); 283 phy_disconnect(priv->phydev); 284 } 285 286 return 0; 287 } 288 289 static void ax88172a_unbind(struct usbnet *dev, struct usb_interface *intf) 290 { 291 struct ax88172a_private *priv = dev->driver_priv; 292 293 ax88172a_remove_mdio(dev); 294 kfree(priv); 295 } 296 297 static int ax88172a_reset(struct usbnet *dev) 298 { 299 struct asix_data *data = (struct asix_data *)&dev->data; 300 struct ax88172a_private *priv = dev->driver_priv; 301 int ret; 302 u16 rx_ctl; 303 304 ax88172a_reset_phy(dev, priv->use_embdphy); 305 306 msleep(150); 307 rx_ctl = asix_read_rx_ctl(dev, 0); 308 netdev_dbg(dev->net, "RX_CTL is 0x%04x after software reset\n", rx_ctl); 309 ret = asix_write_rx_ctl(dev, 0x0000, 0); 310 if (ret < 0) 311 goto out; 312 313 rx_ctl = asix_read_rx_ctl(dev, 0); 314 netdev_dbg(dev->net, "RX_CTL is 0x%04x setting to 0x0000\n", rx_ctl); 315 316 msleep(150); 317 318 ret = asix_write_cmd(dev, AX_CMD_WRITE_IPG0, 319 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT, 320 AX88772_IPG2_DEFAULT, 0, NULL, 0); 321 if (ret < 0) { 322 netdev_err(dev->net, "Write IPG,IPG1,IPG2 failed: %d\n", ret); 323 goto out; 324 } 325 326 /* Rewrite MAC address */ 327 memcpy(data->mac_addr, dev->net->dev_addr, ETH_ALEN); 328 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN, 329 data->mac_addr, 0); 330 if (ret < 0) 331 goto out; 332 333 /* Set RX_CTL to default values with 2k buffer, and enable cactus */ 334 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, 0); 335 if (ret < 0) 336 goto out; 337 338 rx_ctl = asix_read_rx_ctl(dev, 0); 339 netdev_dbg(dev->net, "RX_CTL is 0x%04x after all initializations\n", 340 rx_ctl); 341 342 rx_ctl = asix_read_medium_status(dev, 0); 343 netdev_dbg(dev->net, "Medium Status is 0x%04x after all initializations\n", 344 rx_ctl); 345 346 /* Connect to PHY */ 347 snprintf(priv->phy_name, 20, PHY_ID_FMT, 348 priv->mdio->id, priv->phy_addr); 349 350 priv->phydev = phy_connect(dev->net, priv->phy_name, 351 &ax88172a_adjust_link, 352 PHY_INTERFACE_MODE_MII); 353 if (IS_ERR(priv->phydev)) { 354 netdev_err(dev->net, "Could not connect to PHY device %s\n", 355 priv->phy_name); 356 ret = PTR_ERR(priv->phydev); 357 goto out; 358 } 359 360 netdev_info(dev->net, "Connected to phy %s\n", priv->phy_name); 361 362 /* During power-up, the AX88172A set the power down (BMCR_PDOWN) 363 * bit of the PHY. Bring the PHY up again. 364 */ 365 genphy_resume(priv->phydev); 366 phy_start(priv->phydev); 367 368 return 0; 369 370 out: 371 return ret; 372 373 } 374 375 static int ax88172a_rx_fixup(struct usbnet *dev, struct sk_buff *skb) 376 { 377 struct ax88172a_private *dp = dev->driver_priv; 378 struct asix_rx_fixup_info *rx = &dp->rx_fixup_info; 379 380 return asix_rx_fixup_internal(dev, skb, rx); 381 } 382 383 const struct driver_info ax88172a_info = { 384 .description = "ASIX AX88172A USB 2.0 Ethernet", 385 .bind = ax88172a_bind, 386 .reset = ax88172a_reset, 387 .stop = ax88172a_stop, 388 .unbind = ax88172a_unbind, 389 .status = ax88172a_status, 390 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR | 391 FLAG_MULTI_PACKET, 392 .rx_fixup = ax88172a_rx_fixup, 393 .tx_fixup = asix_tx_fixup, 394 }; 395