drivers/net/usb/dm9601.c

   1 /*
   2  * Davicom DM9601 USB 1.1 10/100Mbps ethernet devices
   3  *
   4  * Peter Korsgaard <jacmet@sunsite.dk>
   5  *
   6  * This file is licensed under the terms of the GNU General Public License
   7  * version 2.  This program is licensed "as is" without any warranty of any
   8  * kind, whether express or implied.
   9  */
  10
  11 //#define DEBUG
  12
  13 #include <linux/module.h>
  14 #include <linux/sched.h>
  15 #include <linux/stddef.h>
  16 #include <linux/init.h>
  17 #include <linux/netdevice.h>
  18 #include <linux/etherdevice.h>
  19 #include <linux/ethtool.h>
  20 #include <linux/mii.h>
  21 #include <linux/usb.h>
  22 #include <linux/crc32.h>
  23 #include <linux/usb/usbnet.h>
  24 #include <linux/slab.h>
  25
  26 /* datasheet:
  27  http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/DM9601-DS-P01-930914.pdf
  28 */
  29
  30 /* control requests */
  31 #define DM_READ_REGS    0x00
  32 #define DM_WRITE_REGS   0x01
  33 #define DM_READ_MEMS    0x02
  34 #define DM_WRITE_REG    0x03
  35 #define DM_WRITE_MEMS   0x05
  36 #define DM_WRITE_MEM    0x07
  37
  38 /* registers */
  39 #define DM_NET_CTRL     0x00
  40 #define DM_RX_CTRL      0x05
  41 #define DM_SHARED_CTRL  0x0b
  42 #define DM_SHARED_ADDR  0x0c
  43 #define DM_SHARED_DATA  0x0d    /* low + high */
  44 #define DM_PHY_ADDR     0x10    /* 6 bytes */
  45 #define DM_MCAST_ADDR   0x16    /* 8 bytes */
  46 #define DM_GPR_CTRL     0x1e
  47 #define DM_GPR_DATA     0x1f
  48
  49 #define DM_MAX_MCAST    64
  50 #define DM_MCAST_SIZE   8
  51 #define DM_EEPROM_LEN   256
  52 #define DM_TX_OVERHEAD  2       /* 2 byte header */
  53 #define DM_RX_OVERHEAD  7       /* 3 byte header + 4 byte crc tail */
  54 #define DM_TIMEOUT      1000
  55
  56 static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
  57 {
  58         int err;
  59         err = usbnet_read_cmd(dev, DM_READ_REGS,
  60                                USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  61                                0, reg, data, length);
  62         if(err != length && err >= 0)
  63                 err = -EINVAL;
  64         return err;
  65 }
  66
  67 static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
  68 {
  69         return dm_read(dev, reg, 1, value);
  70 }
  71
  72 static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
  73 {
  74         int err;
  75         err = usbnet_write_cmd(dev, DM_WRITE_REGS,
  76                                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  77                                 0, reg, data, length);
  78
  79         if (err >= 0 && err < length)
  80                 err = -EINVAL;
  81         return err;
  82 }
  83
  84 static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
  85 {
  86         return usbnet_write_cmd(dev, DM_WRITE_REG,
  87                                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  88                                 value, reg, NULL, 0);
  89 }
  90
  91 static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
  92 {
  93         usbnet_write_cmd_async(dev, DM_WRITE_REGS,
  94                                USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  95                                0, reg, data, length);
  96 }
  97
  98 static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
  99 {
 100         usbnet_write_cmd_async(dev, DM_WRITE_REG,
 101                                USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 102                                value, reg, NULL, 0);
 103 }
 104
 105 static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 *value)
 106 {
 107         int ret, i;
 108
 109         mutex_lock(&dev->phy_mutex);
 110
 111         dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
 112         dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
 113
 114         for (i = 0; i < DM_TIMEOUT; i++) {
 115                 u8 tmp;
 116
 117                 udelay(1);
 118                 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
 119                 if (ret < 0)
 120                         goto out;
 121
 122                 /* ready */
 123                 if ((tmp & 1) == 0)
 124                         break;
 125         }
 126
 127         if (i == DM_TIMEOUT) {
 128                 netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
 129                 ret = -EIO;
 130                 goto out;
 131         }
 132
 133         dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
 134         ret = dm_read(dev, DM_SHARED_DATA, 2, value);
 135
 136         netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
 137                    phy, reg, *value, ret);
 138
 139  out:
 140         mutex_unlock(&dev->phy_mutex);
 141         return ret;
 142 }
 143
 144 static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
 145 {
 146         int ret, i;
 147
 148         mutex_lock(&dev->phy_mutex);
 149
 150         ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
 151         if (ret < 0)
 152                 goto out;
 153
 154         dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
 155         dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1a : 0x12);
 156
 157         for (i = 0; i < DM_TIMEOUT; i++) {
 158                 u8 tmp;
 159
 160                 udelay(1);
 161                 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
 162                 if (ret < 0)
 163                         goto out;
 164
 165                 /* ready */
 166                 if ((tmp & 1) == 0)
 167                         break;
 168         }
 169
 170         if (i == DM_TIMEOUT) {
 171                 netdev_err(dev->net, "%s write timed out!\n", phy ? "phy" : "eeprom");
 172                 ret = -EIO;
 173                 goto out;
 174         }
 175
 176         dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
 177
 178 out:
 179         mutex_unlock(&dev->phy_mutex);
 180         return ret;
 181 }
 182
 183 static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
 184 {
 185         return dm_read_shared_word(dev, 0, offset, value);
 186 }
 187
 188
 189
 190 static int dm9601_get_eeprom_len(struct net_device *dev)
 191 {
 192         return DM_EEPROM_LEN;
 193 }
 194
 195 static int dm9601_get_eeprom(struct net_device *net,
 196                              struct ethtool_eeprom *eeprom, u8 * data)
 197 {
 198         struct usbnet *dev = netdev_priv(net);
 199         __le16 *ebuf = (__le16 *) data;
 200         int i;
 201
 202         /* access is 16bit */
 203         if ((eeprom->offset % 2) || (eeprom->len % 2))
 204                 return -EINVAL;
 205
 206         for (i = 0; i < eeprom->len / 2; i++) {
 207                 if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
 208                                         &ebuf[i]) < 0)
 209                         return -EINVAL;
 210         }
 211         return 0;
 212 }
 213
 214 static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
 215 {
 216         struct usbnet *dev = netdev_priv(netdev);
 217
 218         __le16 res;
 219
 220         if (phy_id) {
 221                 netdev_dbg(dev->net, "Only internal phy supported\n");
 222                 return 0;
 223         }
 224
 225         dm_read_shared_word(dev, 1, loc, &res);
 226
 227         netdev_dbg(dev->net,
 228                    "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
 229                    phy_id, loc, le16_to_cpu(res));
 230
 231         return le16_to_cpu(res);
 232 }
 233
 234 static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
 235                               int val)
 236 {
 237         struct usbnet *dev = netdev_priv(netdev);
 238         __le16 res = cpu_to_le16(val);
 239
 240         if (phy_id) {
 241                 netdev_dbg(dev->net, "Only internal phy supported\n");
 242                 return;
 243         }
 244
 245         netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
 246                    phy_id, loc, val);
 247
 248         dm_write_shared_word(dev, 1, loc, res);
 249 }
 250
 251 static void dm9601_get_drvinfo(struct net_device *net,
 252                                struct ethtool_drvinfo *info)
 253 {
 254         /* Inherit standard device info */
 255         usbnet_get_drvinfo(net, info);
 256         info->eedump_len = DM_EEPROM_LEN;
 257 }
 258
 259 static u32 dm9601_get_link(struct net_device *net)
 260 {
 261         struct usbnet *dev = netdev_priv(net);
 262
 263         return mii_link_ok(&dev->mii);
 264 }
 265
 266 static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
 267 {
 268         struct usbnet *dev = netdev_priv(net);
 269
 270         return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
 271 }
 272
 273 static const struct ethtool_ops dm9601_ethtool_ops = {
 274         .get_drvinfo    = dm9601_get_drvinfo,
 275         .get_link       = dm9601_get_link,
 276         .get_msglevel   = usbnet_get_msglevel,
 277         .set_msglevel   = usbnet_set_msglevel,
 278         .get_eeprom_len = dm9601_get_eeprom_len,
 279         .get_eeprom     = dm9601_get_eeprom,
 280         .get_settings   = usbnet_get_settings,
 281         .set_settings   = usbnet_set_settings,
 282         .nway_reset     = usbnet_nway_reset,
 283 };
 284
 285 static void dm9601_set_multicast(struct net_device *net)
 286 {
 287         struct usbnet *dev = netdev_priv(net);
 288         /* We use the 20 byte dev->data for our 8 byte filter buffer
 289          * to avoid allocating memory that is tricky to free later */
 290         u8 *hashes = (u8 *) & dev->data;
 291         u8 rx_ctl = 0x31;
 292
 293         memset(hashes, 0x00, DM_MCAST_SIZE);
 294         hashes[DM_MCAST_SIZE - 1] |= 0x80;      /* broadcast address */
 295
 296         if (net->flags & IFF_PROMISC) {
 297                 rx_ctl |= 0x02;
 298         } else if (net->flags & IFF_ALLMULTI ||
 299                    netdev_mc_count(net) > DM_MAX_MCAST) {
 300                 rx_ctl |= 0x04;
 301         } else if (!netdev_mc_empty(net)) {
 302                 struct netdev_hw_addr *ha;
 303
 304                 netdev_for_each_mc_addr(ha, net) {
 305                         u32 crc = ether_crc(ETH_ALEN, ha->addr) >> 26;
 306                         hashes[crc >> 3] |= 1 << (crc & 0x7);
 307                 }
 308         }
 309
 310         dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
 311         dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
 312 }
 313
 314 static void __dm9601_set_mac_address(struct usbnet *dev)
 315 {
 316         dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
 317 }
 318
 319 static int dm9601_set_mac_address(struct net_device *net, void *p)
 320 {
 321         struct sockaddr *addr = p;
 322         struct usbnet *dev = netdev_priv(net);
 323
 324         if (!is_valid_ether_addr(addr->sa_data)) {
 325                 dev_err(&net->dev, "not setting invalid mac address %pM\n",
 326                                                                 addr->sa_data);
 327                 return -EINVAL;
 328         }
 329
 330         memcpy(net->dev_addr, addr->sa_data, net->addr_len);
 331         __dm9601_set_mac_address(dev);
 332
 333         return 0;
 334 }
 335
 336 static const struct net_device_ops dm9601_netdev_ops = {
 337         .ndo_open               = usbnet_open,
 338         .ndo_stop               = usbnet_stop,
 339         .ndo_start_xmit         = usbnet_start_xmit,
 340         .ndo_tx_timeout         = usbnet_tx_timeout,
 341         .ndo_change_mtu         = usbnet_change_mtu,
 342         .ndo_validate_addr      = eth_validate_addr,
 343         .ndo_do_ioctl           = dm9601_ioctl,
 344         .ndo_set_rx_mode        = dm9601_set_multicast,
 345         .ndo_set_mac_address    = dm9601_set_mac_address,
 346 };
 347
 348 static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
 349 {
 350         int ret;
 351         u8 mac[ETH_ALEN];
 352
 353         ret = usbnet_get_endpoints(dev, intf);
 354         if (ret)
 355                 goto out;
 356
 357         dev->net->netdev_ops = &dm9601_netdev_ops;
 358         dev->net->ethtool_ops = &dm9601_ethtool_ops;
 359         dev->net->hard_header_len += DM_TX_OVERHEAD;
 360         dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
 361         dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD;
 362
 363         dev->mii.dev = dev->net;
 364         dev->mii.mdio_read = dm9601_mdio_read;
 365         dev->mii.mdio_write = dm9601_mdio_write;
 366         dev->mii.phy_id_mask = 0x1f;
 367         dev->mii.reg_num_mask = 0x1f;
 368
 369         /* reset */
 370         dm_write_reg(dev, DM_NET_CTRL, 1);
 371         udelay(20);
 372
 373         /* read MAC */
 374         if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
 375                 printk(KERN_ERR "Error reading MAC address\n");
 376                 ret = -ENODEV;
 377                 goto out;
 378         }
 379
 380         /*
 381          * Overwrite the auto-generated address only with good ones.
 382          */
 383         if (is_valid_ether_addr(mac))
 384                 memcpy(dev->net->dev_addr, mac, ETH_ALEN);
 385         else {
 386                 printk(KERN_WARNING
 387                         "dm9601: No valid MAC address in EEPROM, using %pM\n",
 388                         dev->net->dev_addr);
 389                 __dm9601_set_mac_address(dev);
 390         }
 391
 392         /* power up phy */
 393         dm_write_reg(dev, DM_GPR_CTRL, 1);
 394         dm_write_reg(dev, DM_GPR_DATA, 0);
 395
 396         /* receive broadcast packets */
 397         dm9601_set_multicast(dev->net);
 398
 399         dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
 400         dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
 401                           ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
 402         mii_nway_restart(&dev->mii);
 403
 404 out:
 405         return ret;
 406 }
 407
 408 static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
 409 {
 410         u8 status;
 411         int len;
 412
 413         /* format:
 414            b1: rx status
 415            b2: packet length (incl crc) low
 416            b3: packet length (incl crc) high
 417            b4..n-4: packet data
 418            bn-3..bn: ethernet crc
 419          */
 420
 421         if (unlikely(skb->len < DM_RX_OVERHEAD)) {
 422                 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
 423                 return 0;
 424         }
 425
 426         status = skb->data[0];
 427         len = (skb->data[1] | (skb->data[2] << 8)) - 4;
 428
 429         if (unlikely(status & 0xbf)) {
 430                 if (status & 0x01) dev->net->stats.rx_fifo_errors++;
 431                 if (status & 0x02) dev->net->stats.rx_crc_errors++;
 432                 if (status & 0x04) dev->net->stats.rx_frame_errors++;
 433                 if (status & 0x20) dev->net->stats.rx_missed_errors++;
 434                 if (status & 0x90) dev->net->stats.rx_length_errors++;
 435                 return 0;
 436         }
 437
 438         skb_pull(skb, 3);
 439         skb_trim(skb, len);
 440
 441         return 1;
 442 }
 443
 444 static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
 445                                        gfp_t flags)
 446 {
 447         int len;
 448
 449         /* format:
 450            b1: packet length low
 451            b2: packet length high
 452            b3..n: packet data
 453         */
 454
 455         len = skb->len;
 456
 457         if (skb_headroom(skb) < DM_TX_OVERHEAD) {
 458                 struct sk_buff *skb2;
 459
 460                 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
 461                 dev_kfree_skb_any(skb);
 462                 skb = skb2;
 463                 if (!skb)
 464                         return NULL;
 465         }
 466
 467         __skb_push(skb, DM_TX_OVERHEAD);
 468
 469         /* usbnet adds padding if length is a multiple of packet size
 470            if so, adjust length value in header */
 471         if ((skb->len % dev->maxpacket) == 0)
 472                 len++;
 473
 474         skb->data[0] = len;
 475         skb->data[1] = len >> 8;
 476
 477         return skb;
 478 }
 479
 480 static void dm9601_status(struct usbnet *dev, struct urb *urb)
 481 {
 482         int link;
 483         u8 *buf;
 484
 485         /* format:
 486            b0: net status
 487            b1: tx status 1
 488            b2: tx status 2
 489            b3: rx status
 490            b4: rx overflow
 491            b5: rx count
 492            b6: tx count
 493            b7: gpr
 494         */
 495
 496         if (urb->actual_length < 8)
 497                 return;
 498
 499         buf = urb->transfer_buffer;
 500
 501         link = !!(buf[0] & 0x40);
 502         if (netif_carrier_ok(dev->net) != link) {
 503                 if (link) {
 504                         netif_carrier_on(dev->net);
 505                         usbnet_defer_kevent (dev, EVENT_LINK_RESET);
 506                 }
 507                 else
 508                         netif_carrier_off(dev->net);
 509                 netdev_dbg(dev->net, "Link Status is: %d\n", link);
 510         }
 511 }
 512
 513 static int dm9601_link_reset(struct usbnet *dev)
 514 {
 515         struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
 516
 517         mii_check_media(&dev->mii, 1, 1);
 518         mii_ethtool_gset(&dev->mii, &ecmd);
 519
 520         netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
 521                    ethtool_cmd_speed(&ecmd), ecmd.duplex);
 522
 523         return 0;
 524 }
 525
 526 static const struct driver_info dm9601_info = {
 527         .description    = "Davicom DM9601 USB Ethernet",
 528         .flags          = FLAG_ETHER | FLAG_LINK_INTR,
 529         .bind           = dm9601_bind,
 530         .rx_fixup       = dm9601_rx_fixup,
 531         .tx_fixup       = dm9601_tx_fixup,
 532         .status         = dm9601_status,
 533         .link_reset     = dm9601_link_reset,
 534         .reset          = dm9601_link_reset,
 535 };
 536
 537 static const struct usb_device_id products[] = {
 538         {
 539          USB_DEVICE(0x07aa, 0x9601),    /* Corega FEther USB-TXC */
 540          .driver_info = (unsigned long)&dm9601_info,
 541          },
 542         {
 543          USB_DEVICE(0x0a46, 0x9601),    /* Davicom USB-100 */
 544          .driver_info = (unsigned long)&dm9601_info,
 545          },
 546         {
 547          USB_DEVICE(0x0a46, 0x6688),    /* ZT6688 USB NIC */
 548          .driver_info = (unsigned long)&dm9601_info,
 549          },
 550         {
 551          USB_DEVICE(0x0a46, 0x0268),    /* ShanTou ST268 USB NIC */
 552          .driver_info = (unsigned long)&dm9601_info,
 553          },
 554         {
 555          USB_DEVICE(0x0a46, 0x8515),    /* ADMtek ADM8515 USB NIC */
 556          .driver_info = (unsigned long)&dm9601_info,
 557          },
 558         {
 559         USB_DEVICE(0x0a47, 0x9601),     /* Hirose USB-100 */
 560         .driver_info = (unsigned long)&dm9601_info,
 561          },
 562         {
 563         USB_DEVICE(0x0fe6, 0x8101),     /* DM9601 USB to Fast Ethernet Adapter */
 564         .driver_info = (unsigned long)&dm9601_info,
 565          },
 566         {
 567          USB_DEVICE(0x0fe6, 0x9700),    /* DM9601 USB to Fast Ethernet Adapter */
 568          .driver_info = (unsigned long)&dm9601_info,
 569          },
 570         {
 571          USB_DEVICE(0x0a46, 0x9000),    /* DM9000E */
 572          .driver_info = (unsigned long)&dm9601_info,
 573          },
 574         {},                     // END
 575 };
 576
 577 MODULE_DEVICE_TABLE(usb, products);
 578
 579 static struct usb_driver dm9601_driver = {
 580         .name = "dm9601",
 581         .id_table = products,
 582         .probe = usbnet_probe,
 583         .disconnect = usbnet_disconnect,
 584         .suspend = usbnet_suspend,
 585         .resume = usbnet_resume,
 586         .disable_hub_initiated_lpm = 1,
 587 };
 588
 589 module_usb_driver(dm9601_driver);
 590
 591 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
 592 MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
 593 MODULE_LICENSE("GPL");