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