2 * Davicom DM9601 USB 1.1 10/100Mbps ethernet devices
4 * Peter Korsgaard <jacmet@sunsite.dk>
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.
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>
26 http://www.davicom.com.tw/big5/download/Data%20Sheet/DM9601-DS-P01-930914.pdf
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
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
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
56 static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
58 devdbg(dev, "dm_read() reg=0x%02x length=%d", reg, length);
59 return usb_control_msg(dev->udev,
60 usb_rcvctrlpipe(dev->udev, 0),
62 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
63 0, reg, data, length, USB_CTRL_SET_TIMEOUT);
66 static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
68 return dm_read(dev, reg, 1, value);
71 static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
73 devdbg(dev, "dm_write() reg=0x%02x, length=%d", reg, length);
74 return usb_control_msg(dev->udev,
75 usb_sndctrlpipe(dev->udev, 0),
77 USB_DIR_OUT | USB_TYPE_VENDOR |USB_RECIP_DEVICE,
78 0, reg, data, length, USB_CTRL_SET_TIMEOUT);
81 static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
83 devdbg(dev, "dm_write_reg() reg=0x%02x, value=0x%02x", reg, value);
84 return usb_control_msg(dev->udev,
85 usb_sndctrlpipe(dev->udev, 0),
87 USB_DIR_OUT | USB_TYPE_VENDOR |USB_RECIP_DEVICE,
88 value, reg, NULL, 0, USB_CTRL_SET_TIMEOUT);
91 static void dm_write_async_callback(struct urb *urb)
93 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
96 printk(KERN_DEBUG "dm_write_async_callback() failed with %d\n",
103 static void dm_write_async_helper(struct usbnet *dev, u8 reg, u8 value,
104 u16 length, void *data)
106 struct usb_ctrlrequest *req;
110 urb = usb_alloc_urb(0, GFP_ATOMIC);
112 deverr(dev, "Error allocating URB in dm_write_async_helper!");
116 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
118 deverr(dev, "Failed to allocate memory for control request");
123 req->bRequestType = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE;
124 req->bRequest = length ? DM_WRITE_REGS : DM_WRITE_REG;
125 req->wValue = cpu_to_le16(value);
126 req->wIndex = cpu_to_le16(reg);
127 req->wLength = cpu_to_le16(length);
129 usb_fill_control_urb(urb, dev->udev,
130 usb_sndctrlpipe(dev->udev, 0),
131 (void *)req, data, length,
132 dm_write_async_callback, req);
134 status = usb_submit_urb(urb, GFP_ATOMIC);
136 deverr(dev, "Error submitting the control message: status=%d",
143 static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
145 devdbg(dev, "dm_write_async() reg=0x%02x length=%d", reg, length);
147 dm_write_async_helper(dev, reg, 0, length, data);
150 static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
152 devdbg(dev, "dm_write_reg_async() reg=0x%02x value=0x%02x",
155 dm_write_async_helper(dev, reg, value, 0, NULL);
158 static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, u16 *value)
162 mutex_lock(&dev->phy_mutex);
164 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
165 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
167 for (i = 0; i < DM_TIMEOUT; i++) {
171 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
180 if (i == DM_TIMEOUT) {
181 deverr(dev, "%s read timed out!", phy ? "phy" : "eeprom");
186 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
187 ret = dm_read(dev, DM_SHARED_DATA, 2, value);
189 devdbg(dev, "read shared %d 0x%02x returned 0x%04x, %d",
190 phy, reg, *value, ret);
193 mutex_unlock(&dev->phy_mutex);
197 static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, u16 value)
201 mutex_lock(&dev->phy_mutex);
203 ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
207 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
208 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1c : 0x14);
210 for (i = 0; i < DM_TIMEOUT; i++) {
214 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
223 if (i == DM_TIMEOUT) {
224 deverr(dev, "%s write timed out!", phy ? "phy" : "eeprom");
229 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
232 mutex_unlock(&dev->phy_mutex);
236 static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
238 return dm_read_shared_word(dev, 0, offset, value);
243 static int dm9601_get_eeprom_len(struct net_device *dev)
245 return DM_EEPROM_LEN;
248 static int dm9601_get_eeprom(struct net_device *net,
249 struct ethtool_eeprom *eeprom, u8 * data)
251 struct usbnet *dev = netdev_priv(net);
252 u16 *ebuf = (u16 *) data;
255 /* access is 16bit */
256 if ((eeprom->offset % 2) || (eeprom->len % 2))
259 for (i = 0; i < eeprom->len / 2; i++) {
260 if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
267 static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
269 struct usbnet *dev = netdev_priv(netdev);
274 devdbg(dev, "Only internal phy supported");
278 dm_read_shared_word(dev, 1, loc, &res);
281 "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x",
282 phy_id, loc, le16_to_cpu(res));
284 return le16_to_cpu(res);
287 static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
290 struct usbnet *dev = netdev_priv(netdev);
291 u16 res = cpu_to_le16(val);
294 devdbg(dev, "Only internal phy supported");
298 devdbg(dev,"dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x",
301 dm_write_shared_word(dev, 1, loc, res);
304 static void dm9601_get_drvinfo(struct net_device *net,
305 struct ethtool_drvinfo *info)
307 /* Inherit standard device info */
308 usbnet_get_drvinfo(net, info);
309 info->eedump_len = DM_EEPROM_LEN;
312 static u32 dm9601_get_link(struct net_device *net)
314 struct usbnet *dev = netdev_priv(net);
316 return mii_link_ok(&dev->mii);
319 static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
321 struct usbnet *dev = netdev_priv(net);
323 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
326 static struct ethtool_ops dm9601_ethtool_ops = {
327 .get_drvinfo = dm9601_get_drvinfo,
328 .get_link = dm9601_get_link,
329 .get_msglevel = usbnet_get_msglevel,
330 .set_msglevel = usbnet_set_msglevel,
331 .get_eeprom_len = dm9601_get_eeprom_len,
332 .get_eeprom = dm9601_get_eeprom,
333 .get_settings = usbnet_get_settings,
334 .set_settings = usbnet_set_settings,
335 .nway_reset = usbnet_nway_reset,
338 static void dm9601_set_multicast(struct net_device *net)
340 struct usbnet *dev = netdev_priv(net);
341 /* We use the 20 byte dev->data for our 8 byte filter buffer
342 * to avoid allocating memory that is tricky to free later */
343 u8 *hashes = (u8 *) & dev->data;
346 memset(hashes, 0x00, DM_MCAST_SIZE);
347 hashes[DM_MCAST_SIZE - 1] |= 0x80; /* broadcast address */
349 if (net->flags & IFF_PROMISC) {
351 } else if (net->flags & IFF_ALLMULTI || net->mc_count > DM_MAX_MCAST) {
353 } else if (net->mc_count) {
354 struct dev_mc_list *mc_list = net->mc_list;
357 for (i = 0; i < net->mc_count; i++) {
358 u32 crc = ether_crc(ETH_ALEN, mc_list->dmi_addr) >> 26;
359 hashes[crc >> 3] |= 1 << (crc & 0x7);
363 dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
364 dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
367 static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
371 ret = usbnet_get_endpoints(dev, intf);
375 dev->net->do_ioctl = dm9601_ioctl;
376 dev->net->set_multicast_list = dm9601_set_multicast;
377 dev->net->ethtool_ops = &dm9601_ethtool_ops;
378 dev->net->hard_header_len += DM_TX_OVERHEAD;
379 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
380 dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD;
382 dev->mii.dev = dev->net;
383 dev->mii.mdio_read = dm9601_mdio_read;
384 dev->mii.mdio_write = dm9601_mdio_write;
385 dev->mii.phy_id_mask = 0x1f;
386 dev->mii.reg_num_mask = 0x1f;
389 dm_write_reg(dev, DM_NET_CTRL, 1);
393 if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr) < 0) {
394 printk(KERN_ERR "Error reading MAC address\n");
400 dm_write_reg(dev, DM_GPR_CTRL, 1);
401 dm_write_reg(dev, DM_GPR_DATA, 0);
403 /* receive broadcast packets */
404 dm9601_set_multicast(dev->net);
406 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
407 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
408 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
409 mii_nway_restart(&dev->mii);
415 static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
422 b1: packet length (incl crc) low
423 b2: packet length (incl crc) high
425 bn-3..bn: ethernet crc
428 if (unlikely(skb->len < DM_RX_OVERHEAD)) {
429 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
433 status = skb->data[0];
434 len = (skb->data[1] | (skb->data[2] << 8)) - 4;
436 if (unlikely(status & 0xbf)) {
437 if (status & 0x01) dev->stats.rx_fifo_errors++;
438 if (status & 0x02) dev->stats.rx_crc_errors++;
439 if (status & 0x04) dev->stats.rx_frame_errors++;
440 if (status & 0x20) dev->stats.rx_missed_errors++;
441 if (status & 0x90) dev->stats.rx_length_errors++;
451 static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
457 b0: packet length low
458 b1: packet length high
464 if (skb_headroom(skb) < DM_TX_OVERHEAD) {
465 struct sk_buff *skb2;
467 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
468 dev_kfree_skb_any(skb);
474 __skb_push(skb, DM_TX_OVERHEAD);
476 /* usbnet adds padding if length is a multiple of packet size
477 if so, adjust length value in header */
478 if ((skb->len % dev->maxpacket) == 0)
482 skb->data[1] = len >> 8;
487 static void dm9601_status(struct usbnet *dev, struct urb *urb)
503 if (urb->actual_length < 8)
506 buf = urb->transfer_buffer;
508 link = !!(buf[0] & 0x40);
509 if (netif_carrier_ok(dev->net) != link) {
511 netif_carrier_on(dev->net);
512 usbnet_defer_kevent (dev, EVENT_LINK_RESET);
515 netif_carrier_off(dev->net);
516 devdbg(dev, "Link Status is: %d", link);
520 static int dm9601_link_reset(struct usbnet *dev)
522 struct ethtool_cmd ecmd;
524 mii_check_media(&dev->mii, 1, 1);
525 mii_ethtool_gset(&dev->mii, &ecmd);
527 devdbg(dev, "link_reset() speed: %d duplex: %d",
528 ecmd.speed, ecmd.duplex);
533 static const struct driver_info dm9601_info = {
534 .description = "Davicom DM9601 USB Ethernet",
537 .rx_fixup = dm9601_rx_fixup,
538 .tx_fixup = dm9601_tx_fixup,
539 .status = dm9601_status,
540 .link_reset = dm9601_link_reset,
541 .reset = dm9601_link_reset,
544 static const struct usb_device_id products[] = {
546 USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
547 .driver_info = (unsigned long)&dm9601_info,
550 USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
551 .driver_info = (unsigned long)&dm9601_info,
554 USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
555 .driver_info = (unsigned long)&dm9601_info,
558 USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
559 .driver_info = (unsigned long)&dm9601_info,
562 USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
563 .driver_info = (unsigned long)&dm9601_info,
568 MODULE_DEVICE_TABLE(usb, products);
570 static struct usb_driver dm9601_driver = {
572 .id_table = products,
573 .probe = usbnet_probe,
574 .disconnect = usbnet_disconnect,
575 .suspend = usbnet_suspend,
576 .resume = usbnet_resume,
579 static int __init dm9601_init(void)
581 return usb_register(&dm9601_driver);
584 static void __exit dm9601_exit(void)
586 usb_deregister(&dm9601_driver);
589 module_init(dm9601_init);
590 module_exit(dm9601_exit);
592 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
593 MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
594 MODULE_LICENSE("GPL");