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>
24 #include <linux/slab.h>
27 http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/DM9601-DS-P01-930914.pdf
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
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
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
56 static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
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)
67 static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
69 return dm_read(dev, reg, 1, value);
72 static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
75 err = usbnet_write_cmd(dev, DM_WRITE_REGS,
76 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
77 0, reg, data, length);
79 if (err >= 0 && err < length)
84 static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
86 return usbnet_write_cmd(dev, DM_WRITE_REG,
87 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
91 static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
93 usbnet_write_cmd_async(dev, DM_WRITE_REGS,
94 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
95 0, reg, data, length);
98 static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
100 usbnet_write_cmd_async(dev, DM_WRITE_REG,
101 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
102 value, reg, NULL, 0);
105 static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 *value)
109 mutex_lock(&dev->phy_mutex);
111 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
112 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
114 for (i = 0; i < DM_TIMEOUT; i++) {
118 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
127 if (i == DM_TIMEOUT) {
128 netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
133 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
134 ret = dm_read(dev, DM_SHARED_DATA, 2, value);
136 netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
137 phy, reg, *value, ret);
140 mutex_unlock(&dev->phy_mutex);
144 static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
148 mutex_lock(&dev->phy_mutex);
150 ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
154 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
155 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1a : 0x12);
157 for (i = 0; i < DM_TIMEOUT; i++) {
161 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
170 if (i == DM_TIMEOUT) {
171 netdev_err(dev->net, "%s write timed out!\n", phy ? "phy" : "eeprom");
176 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
179 mutex_unlock(&dev->phy_mutex);
183 static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
185 return dm_read_shared_word(dev, 0, offset, value);
190 static int dm9601_get_eeprom_len(struct net_device *dev)
192 return DM_EEPROM_LEN;
195 static int dm9601_get_eeprom(struct net_device *net,
196 struct ethtool_eeprom *eeprom, u8 * data)
198 struct usbnet *dev = netdev_priv(net);
199 __le16 *ebuf = (__le16 *) data;
202 /* access is 16bit */
203 if ((eeprom->offset % 2) || (eeprom->len % 2))
206 for (i = 0; i < eeprom->len / 2; i++) {
207 if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
214 static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
216 struct usbnet *dev = netdev_priv(netdev);
221 netdev_dbg(dev->net, "Only internal phy supported\n");
225 dm_read_shared_word(dev, 1, loc, &res);
228 "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
229 phy_id, loc, le16_to_cpu(res));
231 return le16_to_cpu(res);
234 static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
237 struct usbnet *dev = netdev_priv(netdev);
238 __le16 res = cpu_to_le16(val);
241 netdev_dbg(dev->net, "Only internal phy supported\n");
245 netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
248 dm_write_shared_word(dev, 1, loc, res);
251 static void dm9601_get_drvinfo(struct net_device *net,
252 struct ethtool_drvinfo *info)
254 /* Inherit standard device info */
255 usbnet_get_drvinfo(net, info);
256 info->eedump_len = DM_EEPROM_LEN;
259 static u32 dm9601_get_link(struct net_device *net)
261 struct usbnet *dev = netdev_priv(net);
263 return mii_link_ok(&dev->mii);
266 static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
268 struct usbnet *dev = netdev_priv(net);
270 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
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,
285 static void dm9601_set_multicast(struct net_device *net)
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;
293 memset(hashes, 0x00, DM_MCAST_SIZE);
294 hashes[DM_MCAST_SIZE - 1] |= 0x80; /* broadcast address */
296 if (net->flags & IFF_PROMISC) {
298 } else if (net->flags & IFF_ALLMULTI ||
299 netdev_mc_count(net) > DM_MAX_MCAST) {
301 } else if (!netdev_mc_empty(net)) {
302 struct netdev_hw_addr *ha;
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);
310 dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
311 dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
314 static void __dm9601_set_mac_address(struct usbnet *dev)
316 dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
319 static int dm9601_set_mac_address(struct net_device *net, void *p)
321 struct sockaddr *addr = p;
322 struct usbnet *dev = netdev_priv(net);
324 if (!is_valid_ether_addr(addr->sa_data)) {
325 dev_err(&net->dev, "not setting invalid mac address %pM\n",
330 memcpy(net->dev_addr, addr->sa_data, net->addr_len);
331 __dm9601_set_mac_address(dev);
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,
348 static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
353 ret = usbnet_get_endpoints(dev, intf);
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;
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;
370 dm_write_reg(dev, DM_NET_CTRL, 1);
374 if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
375 printk(KERN_ERR "Error reading MAC address\n");
381 * Overwrite the auto-generated address only with good ones.
383 if (is_valid_ether_addr(mac))
384 memcpy(dev->net->dev_addr, mac, ETH_ALEN);
387 "dm9601: No valid MAC address in EEPROM, using %pM\n",
389 __dm9601_set_mac_address(dev);
393 dm_write_reg(dev, DM_GPR_CTRL, 1);
394 dm_write_reg(dev, DM_GPR_DATA, 0);
396 /* receive broadcast packets */
397 dm9601_set_multicast(dev->net);
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);
408 static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
415 b2: packet length (incl crc) low
416 b3: packet length (incl crc) high
418 bn-3..bn: ethernet crc
421 if (unlikely(skb->len < DM_RX_OVERHEAD)) {
422 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
426 status = skb->data[0];
427 len = (skb->data[1] | (skb->data[2] << 8)) - 4;
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++;
444 static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
450 b1: packet length low
451 b2: packet length high
457 if (skb_headroom(skb) < DM_TX_OVERHEAD) {
458 struct sk_buff *skb2;
460 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
461 dev_kfree_skb_any(skb);
467 __skb_push(skb, DM_TX_OVERHEAD);
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)
475 skb->data[1] = len >> 8;
480 static void dm9601_status(struct usbnet *dev, struct urb *urb)
496 if (urb->actual_length < 8)
499 buf = urb->transfer_buffer;
501 link = !!(buf[0] & 0x40);
502 if (netif_carrier_ok(dev->net) != link) {
504 netif_carrier_on(dev->net);
505 usbnet_defer_kevent (dev, EVENT_LINK_RESET);
508 netif_carrier_off(dev->net);
509 netdev_dbg(dev->net, "Link Status is: %d\n", link);
513 static int dm9601_link_reset(struct usbnet *dev)
515 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
517 mii_check_media(&dev->mii, 1, 1);
518 mii_ethtool_gset(&dev->mii, &ecmd);
520 netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
521 ethtool_cmd_speed(&ecmd), ecmd.duplex);
526 static const struct driver_info dm9601_info = {
527 .description = "Davicom DM9601 USB Ethernet",
528 .flags = FLAG_ETHER | FLAG_LINK_INTR,
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,
537 static const struct usb_device_id products[] = {
539 USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
540 .driver_info = (unsigned long)&dm9601_info,
543 USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
544 .driver_info = (unsigned long)&dm9601_info,
547 USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
548 .driver_info = (unsigned long)&dm9601_info,
551 USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
552 .driver_info = (unsigned long)&dm9601_info,
555 USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
556 .driver_info = (unsigned long)&dm9601_info,
559 USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
560 .driver_info = (unsigned long)&dm9601_info,
563 USB_DEVICE(0x0fe6, 0x8101), /* DM9601 USB to Fast Ethernet Adapter */
564 .driver_info = (unsigned long)&dm9601_info,
567 USB_DEVICE(0x0fe6, 0x9700), /* DM9601 USB to Fast Ethernet Adapter */
568 .driver_info = (unsigned long)&dm9601_info,
571 USB_DEVICE(0x0a46, 0x9000), /* DM9000E */
572 .driver_info = (unsigned long)&dm9601_info,
577 MODULE_DEVICE_TABLE(usb, products);
579 static struct usb_driver dm9601_driver = {
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,
589 module_usb_driver(dm9601_driver);
591 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
592 MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
593 MODULE_LICENSE("GPL");