2 * Davicom DM96xx USB 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/netdevice.h>
17 #include <linux/etherdevice.h>
18 #include <linux/ethtool.h>
19 #include <linux/mii.h>
20 #include <linux/usb.h>
21 #include <linux/crc32.h>
22 #include <linux/usb/usbnet.h>
23 #include <linux/slab.h>
26 http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/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
47 #define DM_CHIP_ID 0x2c
48 #define DM_MODE_CTRL 0x91 /* only on dm9620 */
54 #define DM_MAX_MCAST 64
55 #define DM_MCAST_SIZE 8
56 #define DM_EEPROM_LEN 256
57 #define DM_TX_OVERHEAD 2 /* 2 byte header */
58 #define DM_RX_OVERHEAD 7 /* 3 byte header + 4 byte crc tail */
59 #define DM_TIMEOUT 1000
61 static int dm_read(struct usbnet
*dev
, u8 reg
, u16 length
, void *data
)
64 err
= usbnet_read_cmd(dev
, DM_READ_REGS
,
65 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
66 0, reg
, data
, length
);
67 if(err
!= length
&& err
>= 0)
72 static int dm_read_reg(struct usbnet
*dev
, u8 reg
, u8
*value
)
74 return dm_read(dev
, reg
, 1, value
);
77 static int dm_write(struct usbnet
*dev
, u8 reg
, u16 length
, void *data
)
80 err
= usbnet_write_cmd(dev
, DM_WRITE_REGS
,
81 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
82 0, reg
, data
, length
);
84 if (err
>= 0 && err
< length
)
89 static int dm_write_reg(struct usbnet
*dev
, u8 reg
, u8 value
)
91 return usbnet_write_cmd(dev
, DM_WRITE_REG
,
92 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
96 static void dm_write_async(struct usbnet
*dev
, u8 reg
, u16 length
, void *data
)
98 usbnet_write_cmd_async(dev
, DM_WRITE_REGS
,
99 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
100 0, reg
, data
, length
);
103 static void dm_write_reg_async(struct usbnet
*dev
, u8 reg
, u8 value
)
105 usbnet_write_cmd_async(dev
, DM_WRITE_REG
,
106 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
107 value
, reg
, NULL
, 0);
110 static int dm_read_shared_word(struct usbnet
*dev
, int phy
, u8 reg
, __le16
*value
)
114 mutex_lock(&dev
->phy_mutex
);
116 dm_write_reg(dev
, DM_SHARED_ADDR
, phy
? (reg
| 0x40) : reg
);
117 dm_write_reg(dev
, DM_SHARED_CTRL
, phy
? 0xc : 0x4);
119 for (i
= 0; i
< DM_TIMEOUT
; i
++) {
123 ret
= dm_read_reg(dev
, DM_SHARED_CTRL
, &tmp
);
132 if (i
== DM_TIMEOUT
) {
133 netdev_err(dev
->net
, "%s read timed out!\n", phy
? "phy" : "eeprom");
138 dm_write_reg(dev
, DM_SHARED_CTRL
, 0x0);
139 ret
= dm_read(dev
, DM_SHARED_DATA
, 2, value
);
141 netdev_dbg(dev
->net
, "read shared %d 0x%02x returned 0x%04x, %d\n",
142 phy
, reg
, *value
, ret
);
145 mutex_unlock(&dev
->phy_mutex
);
149 static int dm_write_shared_word(struct usbnet
*dev
, int phy
, u8 reg
, __le16 value
)
153 mutex_lock(&dev
->phy_mutex
);
155 ret
= dm_write(dev
, DM_SHARED_DATA
, 2, &value
);
159 dm_write_reg(dev
, DM_SHARED_ADDR
, phy
? (reg
| 0x40) : reg
);
160 dm_write_reg(dev
, DM_SHARED_CTRL
, phy
? 0x1a : 0x12);
162 for (i
= 0; i
< DM_TIMEOUT
; i
++) {
166 ret
= dm_read_reg(dev
, DM_SHARED_CTRL
, &tmp
);
175 if (i
== DM_TIMEOUT
) {
176 netdev_err(dev
->net
, "%s write timed out!\n", phy
? "phy" : "eeprom");
181 dm_write_reg(dev
, DM_SHARED_CTRL
, 0x0);
184 mutex_unlock(&dev
->phy_mutex
);
188 static int dm_read_eeprom_word(struct usbnet
*dev
, u8 offset
, void *value
)
190 return dm_read_shared_word(dev
, 0, offset
, value
);
195 static int dm9601_get_eeprom_len(struct net_device
*dev
)
197 return DM_EEPROM_LEN
;
200 static int dm9601_get_eeprom(struct net_device
*net
,
201 struct ethtool_eeprom
*eeprom
, u8
* data
)
203 struct usbnet
*dev
= netdev_priv(net
);
204 __le16
*ebuf
= (__le16
*) data
;
207 /* access is 16bit */
208 if ((eeprom
->offset
% 2) || (eeprom
->len
% 2))
211 for (i
= 0; i
< eeprom
->len
/ 2; i
++) {
212 if (dm_read_eeprom_word(dev
, eeprom
->offset
/ 2 + i
,
219 static int dm9601_mdio_read(struct net_device
*netdev
, int phy_id
, int loc
)
221 struct usbnet
*dev
= netdev_priv(netdev
);
226 netdev_dbg(dev
->net
, "Only internal phy supported\n");
230 dm_read_shared_word(dev
, 1, loc
, &res
);
233 "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
234 phy_id
, loc
, le16_to_cpu(res
));
236 return le16_to_cpu(res
);
239 static void dm9601_mdio_write(struct net_device
*netdev
, int phy_id
, int loc
,
242 struct usbnet
*dev
= netdev_priv(netdev
);
243 __le16 res
= cpu_to_le16(val
);
246 netdev_dbg(dev
->net
, "Only internal phy supported\n");
250 netdev_dbg(dev
->net
, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
253 dm_write_shared_word(dev
, 1, loc
, res
);
256 static void dm9601_get_drvinfo(struct net_device
*net
,
257 struct ethtool_drvinfo
*info
)
259 /* Inherit standard device info */
260 usbnet_get_drvinfo(net
, info
);
261 info
->eedump_len
= DM_EEPROM_LEN
;
264 static u32
dm9601_get_link(struct net_device
*net
)
266 struct usbnet
*dev
= netdev_priv(net
);
268 return mii_link_ok(&dev
->mii
);
271 static int dm9601_ioctl(struct net_device
*net
, struct ifreq
*rq
, int cmd
)
273 struct usbnet
*dev
= netdev_priv(net
);
275 return generic_mii_ioctl(&dev
->mii
, if_mii(rq
), cmd
, NULL
);
278 static const struct ethtool_ops dm9601_ethtool_ops
= {
279 .get_drvinfo
= dm9601_get_drvinfo
,
280 .get_link
= dm9601_get_link
,
281 .get_msglevel
= usbnet_get_msglevel
,
282 .set_msglevel
= usbnet_set_msglevel
,
283 .get_eeprom_len
= dm9601_get_eeprom_len
,
284 .get_eeprom
= dm9601_get_eeprom
,
285 .get_settings
= usbnet_get_settings
,
286 .set_settings
= usbnet_set_settings
,
287 .nway_reset
= usbnet_nway_reset
,
290 static void dm9601_set_multicast(struct net_device
*net
)
292 struct usbnet
*dev
= netdev_priv(net
);
293 /* We use the 20 byte dev->data for our 8 byte filter buffer
294 * to avoid allocating memory that is tricky to free later */
295 u8
*hashes
= (u8
*) & dev
->data
;
298 memset(hashes
, 0x00, DM_MCAST_SIZE
);
299 hashes
[DM_MCAST_SIZE
- 1] |= 0x80; /* broadcast address */
301 if (net
->flags
& IFF_PROMISC
) {
303 } else if (net
->flags
& IFF_ALLMULTI
||
304 netdev_mc_count(net
) > DM_MAX_MCAST
) {
306 } else if (!netdev_mc_empty(net
)) {
307 struct netdev_hw_addr
*ha
;
309 netdev_for_each_mc_addr(ha
, net
) {
310 u32 crc
= ether_crc(ETH_ALEN
, ha
->addr
) >> 26;
311 hashes
[crc
>> 3] |= 1 << (crc
& 0x7);
315 dm_write_async(dev
, DM_MCAST_ADDR
, DM_MCAST_SIZE
, hashes
);
316 dm_write_reg_async(dev
, DM_RX_CTRL
, rx_ctl
);
319 static void __dm9601_set_mac_address(struct usbnet
*dev
)
321 dm_write_async(dev
, DM_PHY_ADDR
, ETH_ALEN
, dev
->net
->dev_addr
);
324 static int dm9601_set_mac_address(struct net_device
*net
, void *p
)
326 struct sockaddr
*addr
= p
;
327 struct usbnet
*dev
= netdev_priv(net
);
329 if (!is_valid_ether_addr(addr
->sa_data
)) {
330 dev_err(&net
->dev
, "not setting invalid mac address %pM\n",
335 memcpy(net
->dev_addr
, addr
->sa_data
, net
->addr_len
);
336 __dm9601_set_mac_address(dev
);
341 static const struct net_device_ops dm9601_netdev_ops
= {
342 .ndo_open
= usbnet_open
,
343 .ndo_stop
= usbnet_stop
,
344 .ndo_start_xmit
= usbnet_start_xmit
,
345 .ndo_tx_timeout
= usbnet_tx_timeout
,
346 .ndo_change_mtu
= usbnet_change_mtu
,
347 .ndo_validate_addr
= eth_validate_addr
,
348 .ndo_do_ioctl
= dm9601_ioctl
,
349 .ndo_set_rx_mode
= dm9601_set_multicast
,
350 .ndo_set_mac_address
= dm9601_set_mac_address
,
353 static int dm9601_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
356 u8 mac
[ETH_ALEN
], id
;
358 ret
= usbnet_get_endpoints(dev
, intf
);
362 dev
->net
->netdev_ops
= &dm9601_netdev_ops
;
363 dev
->net
->ethtool_ops
= &dm9601_ethtool_ops
;
364 dev
->net
->hard_header_len
+= DM_TX_OVERHEAD
;
365 dev
->hard_mtu
= dev
->net
->mtu
+ dev
->net
->hard_header_len
;
367 /* dm9620/21a require room for 4 byte padding, even in dm9601
368 * mode, so we need +1 to be able to receive full size
371 dev
->rx_urb_size
= dev
->net
->mtu
+ ETH_HLEN
+ DM_RX_OVERHEAD
+ 1;
373 dev
->mii
.dev
= dev
->net
;
374 dev
->mii
.mdio_read
= dm9601_mdio_read
;
375 dev
->mii
.mdio_write
= dm9601_mdio_write
;
376 dev
->mii
.phy_id_mask
= 0x1f;
377 dev
->mii
.reg_num_mask
= 0x1f;
380 dm_write_reg(dev
, DM_NET_CTRL
, 1);
384 if (dm_read(dev
, DM_PHY_ADDR
, ETH_ALEN
, mac
) < 0) {
385 printk(KERN_ERR
"Error reading MAC address\n");
391 * Overwrite the auto-generated address only with good ones.
393 if (is_valid_ether_addr(mac
))
394 memcpy(dev
->net
->dev_addr
, mac
, ETH_ALEN
);
397 "dm9601: No valid MAC address in EEPROM, using %pM\n",
399 __dm9601_set_mac_address(dev
);
402 if (dm_read_reg(dev
, DM_CHIP_ID
, &id
) < 0) {
403 netdev_err(dev
->net
, "Error reading chip ID\n");
408 /* put dm9620 devices in dm9601 mode */
409 if (id
== ID_DM9620
) {
412 if (dm_read_reg(dev
, DM_MODE_CTRL
, &mode
) < 0) {
413 netdev_err(dev
->net
, "Error reading MODE_CTRL\n");
417 dm_write_reg(dev
, DM_MODE_CTRL
, mode
& 0x7f);
421 dm_write_reg(dev
, DM_GPR_CTRL
, 1);
422 dm_write_reg(dev
, DM_GPR_DATA
, 0);
424 /* receive broadcast packets */
425 dm9601_set_multicast(dev
->net
);
427 dm9601_mdio_write(dev
->net
, dev
->mii
.phy_id
, MII_BMCR
, BMCR_RESET
);
428 dm9601_mdio_write(dev
->net
, dev
->mii
.phy_id
, MII_ADVERTISE
,
429 ADVERTISE_ALL
| ADVERTISE_CSMA
| ADVERTISE_PAUSE_CAP
);
430 mii_nway_restart(&dev
->mii
);
436 static int dm9601_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
443 b2: packet length (incl crc) low
444 b3: packet length (incl crc) high
446 bn-3..bn: ethernet crc
449 if (unlikely(skb
->len
< DM_RX_OVERHEAD
)) {
450 dev_err(&dev
->udev
->dev
, "unexpected tiny rx frame\n");
454 status
= skb
->data
[0];
455 len
= (skb
->data
[1] | (skb
->data
[2] << 8)) - 4;
457 if (unlikely(status
& 0xbf)) {
458 if (status
& 0x01) dev
->net
->stats
.rx_fifo_errors
++;
459 if (status
& 0x02) dev
->net
->stats
.rx_crc_errors
++;
460 if (status
& 0x04) dev
->net
->stats
.rx_frame_errors
++;
461 if (status
& 0x20) dev
->net
->stats
.rx_missed_errors
++;
462 if (status
& 0x90) dev
->net
->stats
.rx_length_errors
++;
472 static struct sk_buff
*dm9601_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
,
478 b1: packet length low
479 b2: packet length high
483 len
= skb
->len
+ DM_TX_OVERHEAD
;
485 /* workaround for dm962x errata with tx fifo getting out of
486 * sync if a USB bulk transfer retry happens right after a
487 * packet with odd / maxpacket length by adding up to 3 bytes
490 while ((len
& 1) || !(len
% dev
->maxpacket
))
493 len
-= DM_TX_OVERHEAD
; /* hw header doesn't count as part of length */
494 pad
= len
- skb
->len
;
496 if (skb_headroom(skb
) < DM_TX_OVERHEAD
|| skb_tailroom(skb
) < pad
) {
497 struct sk_buff
*skb2
;
499 skb2
= skb_copy_expand(skb
, DM_TX_OVERHEAD
, pad
, flags
);
500 dev_kfree_skb_any(skb
);
506 __skb_push(skb
, DM_TX_OVERHEAD
);
509 memset(skb
->data
+ skb
->len
, 0, pad
);
514 skb
->data
[1] = len
>> 8;
519 static void dm9601_status(struct usbnet
*dev
, struct urb
*urb
)
535 if (urb
->actual_length
< 8)
538 buf
= urb
->transfer_buffer
;
540 link
= !!(buf
[0] & 0x40);
541 if (netif_carrier_ok(dev
->net
) != link
) {
542 usbnet_link_change(dev
, link
, 1);
543 netdev_dbg(dev
->net
, "Link Status is: %d\n", link
);
547 static int dm9601_link_reset(struct usbnet
*dev
)
549 struct ethtool_cmd ecmd
= { .cmd
= ETHTOOL_GSET
};
551 mii_check_media(&dev
->mii
, 1, 1);
552 mii_ethtool_gset(&dev
->mii
, &ecmd
);
554 netdev_dbg(dev
->net
, "link_reset() speed: %u duplex: %d\n",
555 ethtool_cmd_speed(&ecmd
), ecmd
.duplex
);
560 static const struct driver_info dm9601_info
= {
561 .description
= "Davicom DM96xx USB 10/100 Ethernet",
562 .flags
= FLAG_ETHER
| FLAG_LINK_INTR
,
564 .rx_fixup
= dm9601_rx_fixup
,
565 .tx_fixup
= dm9601_tx_fixup
,
566 .status
= dm9601_status
,
567 .link_reset
= dm9601_link_reset
,
568 .reset
= dm9601_link_reset
,
571 static const struct usb_device_id products
[] = {
573 USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
574 .driver_info
= (unsigned long)&dm9601_info
,
577 USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
578 .driver_info
= (unsigned long)&dm9601_info
,
581 USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
582 .driver_info
= (unsigned long)&dm9601_info
,
585 USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
586 .driver_info
= (unsigned long)&dm9601_info
,
589 USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
590 .driver_info
= (unsigned long)&dm9601_info
,
593 USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
594 .driver_info
= (unsigned long)&dm9601_info
,
597 USB_DEVICE(0x0fe6, 0x8101), /* DM9601 USB to Fast Ethernet Adapter */
598 .driver_info
= (unsigned long)&dm9601_info
,
601 USB_DEVICE(0x0fe6, 0x9700), /* DM9601 USB to Fast Ethernet Adapter */
602 .driver_info
= (unsigned long)&dm9601_info
,
605 USB_DEVICE(0x0a46, 0x9000), /* DM9000E */
606 .driver_info
= (unsigned long)&dm9601_info
,
609 USB_DEVICE(0x0a46, 0x9620), /* DM9620 USB to Fast Ethernet Adapter */
610 .driver_info
= (unsigned long)&dm9601_info
,
613 USB_DEVICE(0x0a46, 0x9621), /* DM9621A USB to Fast Ethernet Adapter */
614 .driver_info
= (unsigned long)&dm9601_info
,
617 USB_DEVICE(0x0a46, 0x9622), /* DM9622 USB to Fast Ethernet Adapter */
618 .driver_info
= (unsigned long)&dm9601_info
,
621 USB_DEVICE(0x0a46, 0x0269), /* DM962OA USB to Fast Ethernet Adapter */
622 .driver_info
= (unsigned long)&dm9601_info
,
625 USB_DEVICE(0x0a46, 0x1269), /* DM9621A USB to Fast Ethernet Adapter */
626 .driver_info
= (unsigned long)&dm9601_info
,
631 MODULE_DEVICE_TABLE(usb
, products
);
633 static struct usb_driver dm9601_driver
= {
635 .id_table
= products
,
636 .probe
= usbnet_probe
,
637 .disconnect
= usbnet_disconnect
,
638 .suspend
= usbnet_suspend
,
639 .resume
= usbnet_resume
,
640 .disable_hub_initiated_lpm
= 1,
643 module_usb_driver(dm9601_driver
);
645 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
646 MODULE_DESCRIPTION("Davicom DM96xx USB 10/100 ethernet devices");
647 MODULE_LICENSE("GPL");