2 * ASIX AX88172A based USB 2.0 Ethernet Devices
3 * Copyright (C) 2012 OMICRON electronics GmbH
5 * Supports external PHYs via phylib. Based on the driver for the
6 * AX88772. Original copyrights follow:
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.
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.
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.
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/>.
28 #include <linux/phy.h>
30 struct ax88172a_private {
32 struct phy_device *phydev;
37 struct asix_rx_fixup_info rx_fixup_info;
40 /* MDIO read and write wrappers for phylib */
41 static int asix_mdio_bus_read(struct mii_bus *bus, int phy_id, int regnum)
43 return asix_mdio_read(((struct usbnet *)bus->priv)->net, phy_id,
47 static int asix_mdio_bus_write(struct mii_bus *bus, int phy_id, int regnum,
50 asix_mdio_write(((struct usbnet *)bus->priv)->net, phy_id, regnum, val);
54 static int ax88172a_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
56 if (!netif_running(net))
62 return phy_mii_ioctl(net->phydev, rq, cmd);
65 /* set MAC link settings according to information from phylib */
66 static void ax88172a_adjust_link(struct net_device *netdev)
68 struct phy_device *phydev = netdev->phydev;
69 struct usbnet *dev = netdev_priv(netdev);
70 struct ax88172a_private *priv = dev->driver_priv;
74 mode = AX88772_MEDIUM_DEFAULT;
76 if (phydev->duplex == DUPLEX_HALF)
77 mode &= ~AX_MEDIUM_FD;
79 if (phydev->speed != SPEED_100)
80 mode &= ~AX_MEDIUM_PS;
83 if (mode != priv->oldmode) {
84 asix_write_medium_mode(dev, 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);
92 static void ax88172a_status(struct usbnet *dev, struct urb *urb)
94 /* link changes are detected by polling the phy */
97 /* use phylib infrastructure */
98 static int ax88172a_init_mdio(struct usbnet *dev)
100 struct ax88172a_private *priv = dev->driver_priv;
103 priv->mdio = mdiobus_alloc();
105 netdev_err(dev->net, "Could not allocate MDIO bus\n");
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);
117 ret = mdiobus_register(priv->mdio);
119 netdev_err(dev->net, "Could not register MDIO bus\n");
123 netdev_info(dev->net, "registered mdio bus %s\n", priv->mdio->id);
127 mdiobus_free(priv->mdio);
131 static void ax88172a_remove_mdio(struct usbnet *dev)
133 struct ax88172a_private *priv = dev->driver_priv;
135 netdev_info(dev->net, "deregistering mdio bus %s\n", priv->mdio->id);
136 mdiobus_unregister(priv->mdio);
137 kfree(priv->mdio->irq);
138 mdiobus_free(priv->mdio);
141 static const struct net_device_ops ax88172a_netdev_ops = {
142 .ndo_open = usbnet_open,
143 .ndo_stop = usbnet_stop,
144 .ndo_start_xmit = usbnet_start_xmit,
145 .ndo_tx_timeout = usbnet_tx_timeout,
146 .ndo_change_mtu = usbnet_change_mtu,
147 .ndo_set_mac_address = asix_set_mac_address,
148 .ndo_validate_addr = eth_validate_addr,
149 .ndo_do_ioctl = ax88172a_ioctl,
150 .ndo_set_rx_mode = asix_set_multicast,
153 static int ax88172a_get_settings(struct net_device *net,
154 struct ethtool_cmd *cmd)
159 return phy_ethtool_gset(net->phydev, cmd);
162 static int ax88172a_set_settings(struct net_device *net,
163 struct ethtool_cmd *cmd)
168 return phy_ethtool_sset(net->phydev, cmd);
171 static int ax88172a_nway_reset(struct net_device *net)
176 return phy_start_aneg(net->phydev);
179 static const struct ethtool_ops ax88172a_ethtool_ops = {
180 .get_drvinfo = asix_get_drvinfo,
181 .get_link = usbnet_get_link,
182 .get_msglevel = usbnet_get_msglevel,
183 .set_msglevel = usbnet_set_msglevel,
184 .get_wol = asix_get_wol,
185 .set_wol = asix_set_wol,
186 .get_eeprom_len = asix_get_eeprom_len,
187 .get_eeprom = asix_get_eeprom,
188 .set_eeprom = asix_set_eeprom,
189 .get_settings = ax88172a_get_settings,
190 .set_settings = ax88172a_set_settings,
191 .nway_reset = ax88172a_nway_reset,
194 static int ax88172a_reset_phy(struct usbnet *dev, int embd_phy)
198 ret = asix_sw_reset(dev, AX_SWRESET_IPPD);
203 ret = asix_sw_reset(dev, AX_SWRESET_CLEAR);
209 ret = asix_sw_reset(dev, embd_phy ? AX_SWRESET_IPRL : AX_SWRESET_IPPD);
220 static int ax88172a_bind(struct usbnet *dev, struct usb_interface *intf)
224 struct ax88172a_private *priv;
226 usbnet_get_endpoints(dev, intf);
228 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
232 dev->driver_priv = priv;
234 /* Get the MAC address */
235 ret = asix_read_cmd(dev, AX_CMD_READ_NODE_ID, 0, 0, ETH_ALEN, buf);
237 netdev_err(dev->net, "Failed to read MAC address: %d\n", ret);
240 memcpy(dev->net->dev_addr, buf, ETH_ALEN);
242 dev->net->netdev_ops = &ax88172a_netdev_ops;
243 dev->net->ethtool_ops = &ax88172a_ethtool_ops;
245 /* are we using the internal or the external phy? */
246 ret = asix_read_cmd(dev, AX_CMD_SW_PHY_STATUS, 0, 0, 1, buf);
248 netdev_err(dev->net, "Failed to read software interface selection register: %d\n",
253 netdev_dbg(dev->net, "AX_CMD_SW_PHY_STATUS = 0x%02x\n", buf[0]);
254 switch (buf[0] & AX_PHY_SELECT_MASK) {
255 case AX_PHY_SELECT_INTERNAL:
256 netdev_dbg(dev->net, "use internal phy\n");
257 priv->use_embdphy = 1;
259 case AX_PHY_SELECT_EXTERNAL:
260 netdev_dbg(dev->net, "use external phy\n");
261 priv->use_embdphy = 0;
264 netdev_err(dev->net, "Interface mode not supported by driver\n");
269 priv->phy_addr = asix_read_phy_addr(dev, priv->use_embdphy);
270 ax88172a_reset_phy(dev, priv->use_embdphy);
272 /* Asix framing packs multiple eth frames into a 2K usb bulk transfer */
273 if (dev->driver_info->flags & FLAG_FRAMING_AX) {
274 /* hard_mtu is still the default - the device does not support
276 dev->rx_urb_size = 2048;
280 ret = ax88172a_init_mdio(dev);
291 static int ax88172a_stop(struct usbnet *dev)
293 struct ax88172a_private *priv = dev->driver_priv;
295 netdev_dbg(dev->net, "Stopping interface\n");
298 netdev_info(dev->net, "Disconnecting from phy %s\n",
300 phy_stop(priv->phydev);
301 phy_disconnect(priv->phydev);
307 static void ax88172a_unbind(struct usbnet *dev, struct usb_interface *intf)
309 struct ax88172a_private *priv = dev->driver_priv;
311 ax88172a_remove_mdio(dev);
315 static int ax88172a_reset(struct usbnet *dev)
317 struct asix_data *data = (struct asix_data *)&dev->data;
318 struct ax88172a_private *priv = dev->driver_priv;
322 ax88172a_reset_phy(dev, priv->use_embdphy);
325 rx_ctl = asix_read_rx_ctl(dev);
326 netdev_dbg(dev->net, "RX_CTL is 0x%04x after software reset\n", rx_ctl);
327 ret = asix_write_rx_ctl(dev, 0x0000);
331 rx_ctl = asix_read_rx_ctl(dev);
332 netdev_dbg(dev->net, "RX_CTL is 0x%04x setting to 0x0000\n", rx_ctl);
336 ret = asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
337 AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
338 AX88772_IPG2_DEFAULT, 0, NULL);
340 netdev_err(dev->net, "Write IPG,IPG1,IPG2 failed: %d\n", ret);
344 /* Rewrite MAC address */
345 memcpy(data->mac_addr, dev->net->dev_addr, ETH_ALEN);
346 ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,
351 /* Set RX_CTL to default values with 2k buffer, and enable cactus */
352 ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL);
356 rx_ctl = asix_read_rx_ctl(dev);
357 netdev_dbg(dev->net, "RX_CTL is 0x%04x after all initializations\n",
360 rx_ctl = asix_read_medium_status(dev);
361 netdev_dbg(dev->net, "Medium Status is 0x%04x after all initializations\n",
365 snprintf(priv->phy_name, 20, PHY_ID_FMT,
366 priv->mdio->id, priv->phy_addr);
368 priv->phydev = phy_connect(dev->net, priv->phy_name,
369 &ax88172a_adjust_link,
370 PHY_INTERFACE_MODE_MII);
371 if (IS_ERR(priv->phydev)) {
372 netdev_err(dev->net, "Could not connect to PHY device %s\n",
374 ret = PTR_ERR(priv->phydev);
378 netdev_info(dev->net, "Connected to phy %s\n", priv->phy_name);
380 /* During power-up, the AX88172A set the power down (BMCR_PDOWN)
381 * bit of the PHY. Bring the PHY up again.
383 genphy_resume(priv->phydev);
384 phy_start(priv->phydev);
393 static int ax88172a_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
395 struct ax88172a_private *dp = dev->driver_priv;
396 struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
398 return asix_rx_fixup_internal(dev, skb, rx);
401 const struct driver_info ax88172a_info = {
402 .description = "ASIX AX88172A USB 2.0 Ethernet",
403 .bind = ax88172a_bind,
404 .reset = ax88172a_reset,
405 .stop = ax88172a_stop,
406 .unbind = ax88172a_unbind,
407 .status = ax88172a_status,
408 .flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR |
410 .rx_fixup = ax88172a_rx_fixup,
411 .tx_fixup = asix_tx_fixup,