Loading...
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
57static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
58{
59 void *buf;
60 int err = -ENOMEM;
61
62 netdev_dbg(dev->net, "dm_read() reg=0x%02x length=%d\n", reg, length);
63
64 buf = kmalloc(length, GFP_KERNEL);
65 if (!buf)
66 goto out;
67
68 err = usb_control_msg(dev->udev,
69 usb_rcvctrlpipe(dev->udev, 0),
70 DM_READ_REGS,
71 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
72 0, reg, buf, length, USB_CTRL_SET_TIMEOUT);
73 if (err == length)
74 memcpy(data, buf, length);
75 else if (err >= 0)
76 err = -EINVAL;
77 kfree(buf);
78
79 out:
80 return err;
81}
82
83static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
84{
85 return dm_read(dev, reg, 1, value);
86}
87
88static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
89{
90 void *buf = NULL;
91 int err = -ENOMEM;
92
93 netdev_dbg(dev->net, "dm_write() reg=0x%02x, length=%d\n", reg, length);
94
95 if (data) {
96 buf = kmemdup(data, length, GFP_KERNEL);
97 if (!buf)
98 goto out;
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
113static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
114{
115 netdev_dbg(dev->net, "dm_write_reg() reg=0x%02x, value=0x%02x\n",
116 reg, value);
117 return usb_control_msg(dev->udev,
118 usb_sndctrlpipe(dev->udev, 0),
119 DM_WRITE_REG,
120 USB_DIR_OUT | USB_TYPE_VENDOR |USB_RECIP_DEVICE,
121 value, reg, NULL, 0, USB_CTRL_SET_TIMEOUT);
122}
123
124static void dm_write_async_callback(struct urb *urb)
125{
126 struct usb_ctrlrequest *req = (struct usb_ctrlrequest *)urb->context;
127 int status = urb->status;
128
129 if (status < 0)
130 printk(KERN_DEBUG "dm_write_async_callback() failed with %d\n",
131 status);
132
133 kfree(req);
134 usb_free_urb(urb);
135}
136
137static void dm_write_async_helper(struct usbnet *dev, u8 reg, u8 value,
138 u16 length, void *data)
139{
140 struct usb_ctrlrequest *req;
141 struct urb *urb;
142 int status;
143
144 urb = usb_alloc_urb(0, GFP_ATOMIC);
145 if (!urb) {
146 netdev_err(dev->net, "Error allocating URB in dm_write_async_helper!\n");
147 return;
148 }
149
150 req = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
151 if (!req) {
152 netdev_err(dev->net, "Failed to allocate memory for control request\n");
153 usb_free_urb(urb);
154 return;
155 }
156
157 req->bRequestType = USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE;
158 req->bRequest = length ? DM_WRITE_REGS : DM_WRITE_REG;
159 req->wValue = cpu_to_le16(value);
160 req->wIndex = cpu_to_le16(reg);
161 req->wLength = cpu_to_le16(length);
162
163 usb_fill_control_urb(urb, dev->udev,
164 usb_sndctrlpipe(dev->udev, 0),
165 (void *)req, data, length,
166 dm_write_async_callback, req);
167
168 status = usb_submit_urb(urb, GFP_ATOMIC);
169 if (status < 0) {
170 netdev_err(dev->net, "Error submitting the control message: status=%d\n",
171 status);
172 kfree(req);
173 usb_free_urb(urb);
174 }
175}
176
177static void dm_write_async(struct usbnet *dev, u8 reg, u16 length, void *data)
178{
179 netdev_dbg(dev->net, "dm_write_async() reg=0x%02x length=%d\n", reg, length);
180
181 dm_write_async_helper(dev, reg, 0, length, data);
182}
183
184static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
185{
186 netdev_dbg(dev->net, "dm_write_reg_async() reg=0x%02x value=0x%02x\n",
187 reg, value);
188
189 dm_write_async_helper(dev, reg, value, 0, NULL);
190}
191
192static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 *value)
193{
194 int ret, i;
195
196 mutex_lock(&dev->phy_mutex);
197
198 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
199 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
200
201 for (i = 0; i < DM_TIMEOUT; i++) {
202 u8 tmp;
203
204 udelay(1);
205 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
206 if (ret < 0)
207 goto out;
208
209 /* ready */
210 if ((tmp & 1) == 0)
211 break;
212 }
213
214 if (i == DM_TIMEOUT) {
215 netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
216 ret = -EIO;
217 goto out;
218 }
219
220 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
221 ret = dm_read(dev, DM_SHARED_DATA, 2, value);
222
223 netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
224 phy, reg, *value, ret);
225
226 out:
227 mutex_unlock(&dev->phy_mutex);
228 return ret;
229}
230
231static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
232{
233 int ret, i;
234
235 mutex_lock(&dev->phy_mutex);
236
237 ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
238 if (ret < 0)
239 goto out;
240
241 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
242 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1a : 0x12);
243
244 for (i = 0; i < DM_TIMEOUT; i++) {
245 u8 tmp;
246
247 udelay(1);
248 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
249 if (ret < 0)
250 goto out;
251
252 /* ready */
253 if ((tmp & 1) == 0)
254 break;
255 }
256
257 if (i == DM_TIMEOUT) {
258 netdev_err(dev->net, "%s write timed out!\n", phy ? "phy" : "eeprom");
259 ret = -EIO;
260 goto out;
261 }
262
263 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
264
265out:
266 mutex_unlock(&dev->phy_mutex);
267 return ret;
268}
269
270static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
271{
272 return dm_read_shared_word(dev, 0, offset, value);
273}
274
275
276
277static int dm9601_get_eeprom_len(struct net_device *dev)
278{
279 return DM_EEPROM_LEN;
280}
281
282static int dm9601_get_eeprom(struct net_device *net,
283 struct ethtool_eeprom *eeprom, u8 * data)
284{
285 struct usbnet *dev = netdev_priv(net);
286 __le16 *ebuf = (__le16 *) data;
287 int i;
288
289 /* access is 16bit */
290 if ((eeprom->offset % 2) || (eeprom->len % 2))
291 return -EINVAL;
292
293 for (i = 0; i < eeprom->len / 2; i++) {
294 if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
295 &ebuf[i]) < 0)
296 return -EINVAL;
297 }
298 return 0;
299}
300
301static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
302{
303 struct usbnet *dev = netdev_priv(netdev);
304
305 __le16 res;
306
307 if (phy_id) {
308 netdev_dbg(dev->net, "Only internal phy supported\n");
309 return 0;
310 }
311
312 dm_read_shared_word(dev, 1, loc, &res);
313
314 netdev_dbg(dev->net,
315 "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
316 phy_id, loc, le16_to_cpu(res));
317
318 return le16_to_cpu(res);
319}
320
321static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
322 int val)
323{
324 struct usbnet *dev = netdev_priv(netdev);
325 __le16 res = cpu_to_le16(val);
326
327 if (phy_id) {
328 netdev_dbg(dev->net, "Only internal phy supported\n");
329 return;
330 }
331
332 netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
333 phy_id, loc, val);
334
335 dm_write_shared_word(dev, 1, loc, res);
336}
337
338static void dm9601_get_drvinfo(struct net_device *net,
339 struct ethtool_drvinfo *info)
340{
341 /* Inherit standard device info */
342 usbnet_get_drvinfo(net, info);
343 info->eedump_len = DM_EEPROM_LEN;
344}
345
346static u32 dm9601_get_link(struct net_device *net)
347{
348 struct usbnet *dev = netdev_priv(net);
349
350 return mii_link_ok(&dev->mii);
351}
352
353static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
354{
355 struct usbnet *dev = netdev_priv(net);
356
357 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
358}
359
360static const struct ethtool_ops dm9601_ethtool_ops = {
361 .get_drvinfo = dm9601_get_drvinfo,
362 .get_link = dm9601_get_link,
363 .get_msglevel = usbnet_get_msglevel,
364 .set_msglevel = usbnet_set_msglevel,
365 .get_eeprom_len = dm9601_get_eeprom_len,
366 .get_eeprom = dm9601_get_eeprom,
367 .get_settings = usbnet_get_settings,
368 .set_settings = usbnet_set_settings,
369 .nway_reset = usbnet_nway_reset,
370};
371
372static void dm9601_set_multicast(struct net_device *net)
373{
374 struct usbnet *dev = netdev_priv(net);
375 /* We use the 20 byte dev->data for our 8 byte filter buffer
376 * to avoid allocating memory that is tricky to free later */
377 u8 *hashes = (u8 *) & dev->data;
378 u8 rx_ctl = 0x31;
379
380 memset(hashes, 0x00, DM_MCAST_SIZE);
381 hashes[DM_MCAST_SIZE - 1] |= 0x80; /* broadcast address */
382
383 if (net->flags & IFF_PROMISC) {
384 rx_ctl |= 0x02;
385 } else if (net->flags & IFF_ALLMULTI ||
386 netdev_mc_count(net) > DM_MAX_MCAST) {
387 rx_ctl |= 0x04;
388 } else if (!netdev_mc_empty(net)) {
389 struct netdev_hw_addr *ha;
390
391 netdev_for_each_mc_addr(ha, net) {
392 u32 crc = ether_crc(ETH_ALEN, ha->addr) >> 26;
393 hashes[crc >> 3] |= 1 << (crc & 0x7);
394 }
395 }
396
397 dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
398 dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
399}
400
401static void __dm9601_set_mac_address(struct usbnet *dev)
402{
403 dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
404}
405
406static int dm9601_set_mac_address(struct net_device *net, void *p)
407{
408 struct sockaddr *addr = p;
409 struct usbnet *dev = netdev_priv(net);
410
411 if (!is_valid_ether_addr(addr->sa_data)) {
412 dev_err(&net->dev, "not setting invalid mac address %pM\n",
413 addr->sa_data);
414 return -EINVAL;
415 }
416
417 memcpy(net->dev_addr, addr->sa_data, net->addr_len);
418 __dm9601_set_mac_address(dev);
419
420 return 0;
421}
422
423static const struct net_device_ops dm9601_netdev_ops = {
424 .ndo_open = usbnet_open,
425 .ndo_stop = usbnet_stop,
426 .ndo_start_xmit = usbnet_start_xmit,
427 .ndo_tx_timeout = usbnet_tx_timeout,
428 .ndo_change_mtu = usbnet_change_mtu,
429 .ndo_validate_addr = eth_validate_addr,
430 .ndo_do_ioctl = dm9601_ioctl,
431 .ndo_set_multicast_list = dm9601_set_multicast,
432 .ndo_set_mac_address = dm9601_set_mac_address,
433};
434
435static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
436{
437 int ret;
438 u8 mac[ETH_ALEN];
439
440 ret = usbnet_get_endpoints(dev, intf);
441 if (ret)
442 goto out;
443
444 dev->net->netdev_ops = &dm9601_netdev_ops;
445 dev->net->ethtool_ops = &dm9601_ethtool_ops;
446 dev->net->hard_header_len += DM_TX_OVERHEAD;
447 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
448 dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD;
449
450 dev->mii.dev = dev->net;
451 dev->mii.mdio_read = dm9601_mdio_read;
452 dev->mii.mdio_write = dm9601_mdio_write;
453 dev->mii.phy_id_mask = 0x1f;
454 dev->mii.reg_num_mask = 0x1f;
455
456 /* reset */
457 dm_write_reg(dev, DM_NET_CTRL, 1);
458 udelay(20);
459
460 /* read MAC */
461 if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
462 printk(KERN_ERR "Error reading MAC address\n");
463 ret = -ENODEV;
464 goto out;
465 }
466
467 /*
468 * Overwrite the auto-generated address only with good ones.
469 */
470 if (is_valid_ether_addr(mac))
471 memcpy(dev->net->dev_addr, mac, ETH_ALEN);
472 else {
473 printk(KERN_WARNING
474 "dm9601: No valid MAC address in EEPROM, using %pM\n",
475 dev->net->dev_addr);
476 __dm9601_set_mac_address(dev);
477 }
478
479 /* power up phy */
480 dm_write_reg(dev, DM_GPR_CTRL, 1);
481 dm_write_reg(dev, DM_GPR_DATA, 0);
482
483 /* receive broadcast packets */
484 dm9601_set_multicast(dev->net);
485
486 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
487 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
488 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
489 mii_nway_restart(&dev->mii);
490
491out:
492 return ret;
493}
494
495static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
496{
497 u8 status;
498 int len;
499
500 /* format:
501 b1: rx status
502 b2: packet length (incl crc) low
503 b3: packet length (incl crc) high
504 b4..n-4: packet data
505 bn-3..bn: ethernet crc
506 */
507
508 if (unlikely(skb->len < DM_RX_OVERHEAD)) {
509 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
510 return 0;
511 }
512
513 status = skb->data[0];
514 len = (skb->data[1] | (skb->data[2] << 8)) - 4;
515
516 if (unlikely(status & 0xbf)) {
517 if (status & 0x01) dev->net->stats.rx_fifo_errors++;
518 if (status & 0x02) dev->net->stats.rx_crc_errors++;
519 if (status & 0x04) dev->net->stats.rx_frame_errors++;
520 if (status & 0x20) dev->net->stats.rx_missed_errors++;
521 if (status & 0x90) dev->net->stats.rx_length_errors++;
522 return 0;
523 }
524
525 skb_pull(skb, 3);
526 skb_trim(skb, len);
527
528 return 1;
529}
530
531static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
532 gfp_t flags)
533{
534 int len;
535
536 /* format:
537 b1: packet length low
538 b2: packet length high
539 b3..n: packet data
540 */
541
542 len = skb->len;
543
544 if (skb_headroom(skb) < DM_TX_OVERHEAD) {
545 struct sk_buff *skb2;
546
547 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, 0, flags);
548 dev_kfree_skb_any(skb);
549 skb = skb2;
550 if (!skb)
551 return NULL;
552 }
553
554 __skb_push(skb, DM_TX_OVERHEAD);
555
556 /* usbnet adds padding if length is a multiple of packet size
557 if so, adjust length value in header */
558 if ((skb->len % dev->maxpacket) == 0)
559 len++;
560
561 skb->data[0] = len;
562 skb->data[1] = len >> 8;
563
564 return skb;
565}
566
567static void dm9601_status(struct usbnet *dev, struct urb *urb)
568{
569 int link;
570 u8 *buf;
571
572 /* format:
573 b0: net status
574 b1: tx status 1
575 b2: tx status 2
576 b3: rx status
577 b4: rx overflow
578 b5: rx count
579 b6: tx count
580 b7: gpr
581 */
582
583 if (urb->actual_length < 8)
584 return;
585
586 buf = urb->transfer_buffer;
587
588 link = !!(buf[0] & 0x40);
589 if (netif_carrier_ok(dev->net) != link) {
590 if (link) {
591 netif_carrier_on(dev->net);
592 usbnet_defer_kevent (dev, EVENT_LINK_RESET);
593 }
594 else
595 netif_carrier_off(dev->net);
596 netdev_dbg(dev->net, "Link Status is: %d\n", link);
597 }
598}
599
600static int dm9601_link_reset(struct usbnet *dev)
601{
602 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
603
604 mii_check_media(&dev->mii, 1, 1);
605 mii_ethtool_gset(&dev->mii, &ecmd);
606
607 netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
608 ethtool_cmd_speed(&ecmd), ecmd.duplex);
609
610 return 0;
611}
612
613static const struct driver_info dm9601_info = {
614 .description = "Davicom DM9601 USB Ethernet",
615 .flags = FLAG_ETHER | FLAG_LINK_INTR,
616 .bind = dm9601_bind,
617 .rx_fixup = dm9601_rx_fixup,
618 .tx_fixup = dm9601_tx_fixup,
619 .status = dm9601_status,
620 .link_reset = dm9601_link_reset,
621 .reset = dm9601_link_reset,
622};
623
624static const struct usb_device_id products[] = {
625 {
626 USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
627 .driver_info = (unsigned long)&dm9601_info,
628 },
629 {
630 USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
631 .driver_info = (unsigned long)&dm9601_info,
632 },
633 {
634 USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
635 .driver_info = (unsigned long)&dm9601_info,
636 },
637 {
638 USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
639 .driver_info = (unsigned long)&dm9601_info,
640 },
641 {
642 USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
643 .driver_info = (unsigned long)&dm9601_info,
644 },
645 {
646 USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
647 .driver_info = (unsigned long)&dm9601_info,
648 },
649 {
650 USB_DEVICE(0x0fe6, 0x8101), /* DM9601 USB to Fast Ethernet Adapter */
651 .driver_info = (unsigned long)&dm9601_info,
652 },
653 {
654 USB_DEVICE(0x0fe6, 0x9700), /* DM9601 USB to Fast Ethernet Adapter */
655 .driver_info = (unsigned long)&dm9601_info,
656 },
657 {
658 USB_DEVICE(0x0a46, 0x9000), /* DM9000E */
659 .driver_info = (unsigned long)&dm9601_info,
660 },
661 {}, // END
662};
663
664MODULE_DEVICE_TABLE(usb, products);
665
666static struct usb_driver dm9601_driver = {
667 .name = "dm9601",
668 .id_table = products,
669 .probe = usbnet_probe,
670 .disconnect = usbnet_disconnect,
671 .suspend = usbnet_suspend,
672 .resume = usbnet_resume,
673};
674
675static int __init dm9601_init(void)
676{
677 return usb_register(&dm9601_driver);
678}
679
680static void __exit dm9601_exit(void)
681{
682 usb_deregister(&dm9601_driver);
683}
684
685module_init(dm9601_init);
686module_exit(dm9601_exit);
687
688MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
689MODULE_DESCRIPTION("Davicom DM9601 USB 1.1 ethernet devices");
690MODULE_LICENSE("GPL");
1/*
2 * Davicom DM96xx USB 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/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>
24
25/* datasheet:
26 http://ptm2.cc.utu.fi/ftp/network/cards/DM9601/From_NET/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#define DM_CHIP_ID 0x2c
48#define DM_MODE_CTRL 0x91 /* only on dm9620 */
49
50/* chip id values */
51#define ID_DM9601 0
52#define ID_DM9620 1
53
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
60
61static int dm_read(struct usbnet *dev, u8 reg, u16 length, void *data)
62{
63 int err;
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)
68 err = -EINVAL;
69 return err;
70}
71
72static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
73{
74 return dm_read(dev, reg, 1, value);
75}
76
77static int dm_write(struct usbnet *dev, u8 reg, u16 length, void *data)
78{
79 int err;
80 err = usbnet_write_cmd(dev, DM_WRITE_REGS,
81 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
82 0, reg, data, length);
83
84 if (err >= 0 && err < length)
85 err = -EINVAL;
86 return err;
87}
88
89static int dm_write_reg(struct usbnet *dev, u8 reg, u8 value)
90{
91 return usbnet_write_cmd(dev, DM_WRITE_REG,
92 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
93 value, reg, NULL, 0);
94}
95
96static void dm_write_async(struct usbnet *dev, u8 reg, u16 length,
97 const void *data)
98{
99 usbnet_write_cmd_async(dev, DM_WRITE_REGS,
100 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
101 0, reg, data, length);
102}
103
104static void dm_write_reg_async(struct usbnet *dev, u8 reg, u8 value)
105{
106 usbnet_write_cmd_async(dev, DM_WRITE_REG,
107 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
108 value, reg, NULL, 0);
109}
110
111static int dm_read_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 *value)
112{
113 int ret, i;
114
115 mutex_lock(&dev->phy_mutex);
116
117 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
118 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0xc : 0x4);
119
120 for (i = 0; i < DM_TIMEOUT; i++) {
121 u8 tmp = 0;
122
123 udelay(1);
124 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
125 if (ret < 0)
126 goto out;
127
128 /* ready */
129 if ((tmp & 1) == 0)
130 break;
131 }
132
133 if (i == DM_TIMEOUT) {
134 netdev_err(dev->net, "%s read timed out!\n", phy ? "phy" : "eeprom");
135 ret = -EIO;
136 goto out;
137 }
138
139 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
140 ret = dm_read(dev, DM_SHARED_DATA, 2, value);
141
142 netdev_dbg(dev->net, "read shared %d 0x%02x returned 0x%04x, %d\n",
143 phy, reg, *value, ret);
144
145 out:
146 mutex_unlock(&dev->phy_mutex);
147 return ret;
148}
149
150static int dm_write_shared_word(struct usbnet *dev, int phy, u8 reg, __le16 value)
151{
152 int ret, i;
153
154 mutex_lock(&dev->phy_mutex);
155
156 ret = dm_write(dev, DM_SHARED_DATA, 2, &value);
157 if (ret < 0)
158 goto out;
159
160 dm_write_reg(dev, DM_SHARED_ADDR, phy ? (reg | 0x40) : reg);
161 dm_write_reg(dev, DM_SHARED_CTRL, phy ? 0x1a : 0x12);
162
163 for (i = 0; i < DM_TIMEOUT; i++) {
164 u8 tmp = 0;
165
166 udelay(1);
167 ret = dm_read_reg(dev, DM_SHARED_CTRL, &tmp);
168 if (ret < 0)
169 goto out;
170
171 /* ready */
172 if ((tmp & 1) == 0)
173 break;
174 }
175
176 if (i == DM_TIMEOUT) {
177 netdev_err(dev->net, "%s write timed out!\n", phy ? "phy" : "eeprom");
178 ret = -EIO;
179 goto out;
180 }
181
182 dm_write_reg(dev, DM_SHARED_CTRL, 0x0);
183
184out:
185 mutex_unlock(&dev->phy_mutex);
186 return ret;
187}
188
189static int dm_read_eeprom_word(struct usbnet *dev, u8 offset, void *value)
190{
191 return dm_read_shared_word(dev, 0, offset, value);
192}
193
194
195
196static int dm9601_get_eeprom_len(struct net_device *dev)
197{
198 return DM_EEPROM_LEN;
199}
200
201static int dm9601_get_eeprom(struct net_device *net,
202 struct ethtool_eeprom *eeprom, u8 * data)
203{
204 struct usbnet *dev = netdev_priv(net);
205 __le16 *ebuf = (__le16 *) data;
206 int i;
207
208 /* access is 16bit */
209 if ((eeprom->offset % 2) || (eeprom->len % 2))
210 return -EINVAL;
211
212 for (i = 0; i < eeprom->len / 2; i++) {
213 if (dm_read_eeprom_word(dev, eeprom->offset / 2 + i,
214 &ebuf[i]) < 0)
215 return -EINVAL;
216 }
217 return 0;
218}
219
220static int dm9601_mdio_read(struct net_device *netdev, int phy_id, int loc)
221{
222 struct usbnet *dev = netdev_priv(netdev);
223
224 __le16 res;
225 int err;
226
227 if (phy_id) {
228 netdev_dbg(dev->net, "Only internal phy supported\n");
229 return 0;
230 }
231
232 err = dm_read_shared_word(dev, 1, loc, &res);
233 if (err < 0) {
234 netdev_err(dev->net, "MDIO read error: %d\n", err);
235 return 0;
236 }
237
238 netdev_dbg(dev->net,
239 "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
240 phy_id, loc, le16_to_cpu(res));
241
242 return le16_to_cpu(res);
243}
244
245static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
246 int val)
247{
248 struct usbnet *dev = netdev_priv(netdev);
249 __le16 res = cpu_to_le16(val);
250
251 if (phy_id) {
252 netdev_dbg(dev->net, "Only internal phy supported\n");
253 return;
254 }
255
256 netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
257 phy_id, loc, val);
258
259 dm_write_shared_word(dev, 1, loc, res);
260}
261
262static void dm9601_get_drvinfo(struct net_device *net,
263 struct ethtool_drvinfo *info)
264{
265 /* Inherit standard device info */
266 usbnet_get_drvinfo(net, info);
267}
268
269static u32 dm9601_get_link(struct net_device *net)
270{
271 struct usbnet *dev = netdev_priv(net);
272
273 return mii_link_ok(&dev->mii);
274}
275
276static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
277{
278 struct usbnet *dev = netdev_priv(net);
279
280 return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
281}
282
283static const struct ethtool_ops dm9601_ethtool_ops = {
284 .get_drvinfo = dm9601_get_drvinfo,
285 .get_link = dm9601_get_link,
286 .get_msglevel = usbnet_get_msglevel,
287 .set_msglevel = usbnet_set_msglevel,
288 .get_eeprom_len = dm9601_get_eeprom_len,
289 .get_eeprom = dm9601_get_eeprom,
290 .nway_reset = usbnet_nway_reset,
291 .get_link_ksettings = usbnet_get_link_ksettings_mii,
292 .set_link_ksettings = usbnet_set_link_ksettings_mii,
293};
294
295static void dm9601_set_multicast(struct net_device *net)
296{
297 struct usbnet *dev = netdev_priv(net);
298 /* We use the 20 byte dev->data for our 8 byte filter buffer
299 * to avoid allocating memory that is tricky to free later */
300 u8 *hashes = (u8 *) & dev->data;
301 u8 rx_ctl = 0x31;
302
303 memset(hashes, 0x00, DM_MCAST_SIZE);
304 hashes[DM_MCAST_SIZE - 1] |= 0x80; /* broadcast address */
305
306 if (net->flags & IFF_PROMISC) {
307 rx_ctl |= 0x02;
308 } else if (net->flags & IFF_ALLMULTI ||
309 netdev_mc_count(net) > DM_MAX_MCAST) {
310 rx_ctl |= 0x08;
311 } else if (!netdev_mc_empty(net)) {
312 struct netdev_hw_addr *ha;
313
314 netdev_for_each_mc_addr(ha, net) {
315 u32 crc = ether_crc(ETH_ALEN, ha->addr) >> 26;
316 hashes[crc >> 3] |= 1 << (crc & 0x7);
317 }
318 }
319
320 dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
321 dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
322}
323
324static void __dm9601_set_mac_address(struct usbnet *dev)
325{
326 dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
327}
328
329static int dm9601_set_mac_address(struct net_device *net, void *p)
330{
331 struct sockaddr *addr = p;
332 struct usbnet *dev = netdev_priv(net);
333
334 if (!is_valid_ether_addr(addr->sa_data)) {
335 dev_err(&net->dev, "not setting invalid mac address %pM\n",
336 addr->sa_data);
337 return -EINVAL;
338 }
339
340 eth_hw_addr_set(net, addr->sa_data);
341 __dm9601_set_mac_address(dev);
342
343 return 0;
344}
345
346static const struct net_device_ops dm9601_netdev_ops = {
347 .ndo_open = usbnet_open,
348 .ndo_stop = usbnet_stop,
349 .ndo_start_xmit = usbnet_start_xmit,
350 .ndo_tx_timeout = usbnet_tx_timeout,
351 .ndo_change_mtu = usbnet_change_mtu,
352 .ndo_get_stats64 = dev_get_tstats64,
353 .ndo_validate_addr = eth_validate_addr,
354 .ndo_eth_ioctl = dm9601_ioctl,
355 .ndo_set_rx_mode = dm9601_set_multicast,
356 .ndo_set_mac_address = dm9601_set_mac_address,
357};
358
359static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
360{
361 int ret;
362 u8 mac[ETH_ALEN], id;
363
364 ret = usbnet_get_endpoints(dev, intf);
365 if (ret)
366 goto out;
367
368 dev->net->netdev_ops = &dm9601_netdev_ops;
369 dev->net->ethtool_ops = &dm9601_ethtool_ops;
370 dev->net->hard_header_len += DM_TX_OVERHEAD;
371 dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
372
373 /* dm9620/21a require room for 4 byte padding, even in dm9601
374 * mode, so we need +1 to be able to receive full size
375 * ethernet frames.
376 */
377 dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD + 1;
378
379 dev->mii.dev = dev->net;
380 dev->mii.mdio_read = dm9601_mdio_read;
381 dev->mii.mdio_write = dm9601_mdio_write;
382 dev->mii.phy_id_mask = 0x1f;
383 dev->mii.reg_num_mask = 0x1f;
384
385 /* reset */
386 dm_write_reg(dev, DM_NET_CTRL, 1);
387 udelay(20);
388
389 /* read MAC */
390 if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
391 printk(KERN_ERR "Error reading MAC address\n");
392 ret = -ENODEV;
393 goto out;
394 }
395
396 /*
397 * Overwrite the auto-generated address only with good ones.
398 */
399 if (is_valid_ether_addr(mac))
400 eth_hw_addr_set(dev->net, mac);
401 else {
402 printk(KERN_WARNING
403 "dm9601: No valid MAC address in EEPROM, using %pM\n",
404 dev->net->dev_addr);
405 __dm9601_set_mac_address(dev);
406 }
407
408 if (dm_read_reg(dev, DM_CHIP_ID, &id) < 0) {
409 netdev_err(dev->net, "Error reading chip ID\n");
410 ret = -ENODEV;
411 goto out;
412 }
413
414 /* put dm9620 devices in dm9601 mode */
415 if (id == ID_DM9620) {
416 u8 mode;
417
418 if (dm_read_reg(dev, DM_MODE_CTRL, &mode) < 0) {
419 netdev_err(dev->net, "Error reading MODE_CTRL\n");
420 ret = -ENODEV;
421 goto out;
422 }
423 dm_write_reg(dev, DM_MODE_CTRL, mode & 0x7f);
424 }
425
426 /* power up phy */
427 dm_write_reg(dev, DM_GPR_CTRL, 1);
428 dm_write_reg(dev, DM_GPR_DATA, 0);
429
430 /* receive broadcast packets */
431 dm9601_set_multicast(dev->net);
432
433 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
434 dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
435 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
436 mii_nway_restart(&dev->mii);
437
438out:
439 return ret;
440}
441
442static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
443{
444 u8 status;
445 int len;
446
447 /* format:
448 b1: rx status
449 b2: packet length (incl crc) low
450 b3: packet length (incl crc) high
451 b4..n-4: packet data
452 bn-3..bn: ethernet crc
453 */
454
455 if (unlikely(skb->len < DM_RX_OVERHEAD)) {
456 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
457 return 0;
458 }
459
460 status = skb->data[0];
461 len = (skb->data[1] | (skb->data[2] << 8)) - 4;
462
463 if (unlikely(status & 0xbf)) {
464 if (status & 0x01) dev->net->stats.rx_fifo_errors++;
465 if (status & 0x02) dev->net->stats.rx_crc_errors++;
466 if (status & 0x04) dev->net->stats.rx_frame_errors++;
467 if (status & 0x20) dev->net->stats.rx_missed_errors++;
468 if (status & 0x90) dev->net->stats.rx_length_errors++;
469 return 0;
470 }
471
472 skb_pull(skb, 3);
473 skb_trim(skb, len);
474
475 return 1;
476}
477
478static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
479 gfp_t flags)
480{
481 int len, pad;
482
483 /* format:
484 b1: packet length low
485 b2: packet length high
486 b3..n: packet data
487 */
488
489 len = skb->len + DM_TX_OVERHEAD;
490
491 /* workaround for dm962x errata with tx fifo getting out of
492 * sync if a USB bulk transfer retry happens right after a
493 * packet with odd / maxpacket length by adding up to 3 bytes
494 * padding.
495 */
496 while ((len & 1) || !(len % dev->maxpacket))
497 len++;
498
499 len -= DM_TX_OVERHEAD; /* hw header doesn't count as part of length */
500 pad = len - skb->len;
501
502 if (skb_headroom(skb) < DM_TX_OVERHEAD || skb_tailroom(skb) < pad) {
503 struct sk_buff *skb2;
504
505 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, pad, flags);
506 dev_kfree_skb_any(skb);
507 skb = skb2;
508 if (!skb)
509 return NULL;
510 }
511
512 __skb_push(skb, DM_TX_OVERHEAD);
513
514 if (pad) {
515 memset(skb->data + skb->len, 0, pad);
516 __skb_put(skb, pad);
517 }
518
519 skb->data[0] = len;
520 skb->data[1] = len >> 8;
521
522 return skb;
523}
524
525static void dm9601_status(struct usbnet *dev, struct urb *urb)
526{
527 int link;
528 u8 *buf;
529
530 /* format:
531 b0: net status
532 b1: tx status 1
533 b2: tx status 2
534 b3: rx status
535 b4: rx overflow
536 b5: rx count
537 b6: tx count
538 b7: gpr
539 */
540
541 if (urb->actual_length < 8)
542 return;
543
544 buf = urb->transfer_buffer;
545
546 link = !!(buf[0] & 0x40);
547 if (netif_carrier_ok(dev->net) != link) {
548 usbnet_link_change(dev, link, 1);
549 netdev_dbg(dev->net, "Link Status is: %d\n", link);
550 }
551}
552
553static int dm9601_link_reset(struct usbnet *dev)
554{
555 struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
556
557 mii_check_media(&dev->mii, 1, 1);
558 mii_ethtool_gset(&dev->mii, &ecmd);
559
560 netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
561 ethtool_cmd_speed(&ecmd), ecmd.duplex);
562
563 return 0;
564}
565
566static const struct driver_info dm9601_info = {
567 .description = "Davicom DM96xx USB 10/100 Ethernet",
568 .flags = FLAG_ETHER | FLAG_LINK_INTR,
569 .bind = dm9601_bind,
570 .rx_fixup = dm9601_rx_fixup,
571 .tx_fixup = dm9601_tx_fixup,
572 .status = dm9601_status,
573 .link_reset = dm9601_link_reset,
574 .reset = dm9601_link_reset,
575};
576
577static const struct usb_device_id products[] = {
578 {
579 USB_DEVICE(0x07aa, 0x9601), /* Corega FEther USB-TXC */
580 .driver_info = (unsigned long)&dm9601_info,
581 },
582 {
583 USB_DEVICE(0x0a46, 0x9601), /* Davicom USB-100 */
584 .driver_info = (unsigned long)&dm9601_info,
585 },
586 {
587 USB_DEVICE(0x0a46, 0x6688), /* ZT6688 USB NIC */
588 .driver_info = (unsigned long)&dm9601_info,
589 },
590 {
591 USB_DEVICE(0x0a46, 0x0268), /* ShanTou ST268 USB NIC */
592 .driver_info = (unsigned long)&dm9601_info,
593 },
594 {
595 USB_DEVICE(0x0a46, 0x8515), /* ADMtek ADM8515 USB NIC */
596 .driver_info = (unsigned long)&dm9601_info,
597 },
598 {
599 USB_DEVICE(0x0a47, 0x9601), /* Hirose USB-100 */
600 .driver_info = (unsigned long)&dm9601_info,
601 },
602 {
603 USB_DEVICE(0x0fe6, 0x8101), /* DM9601 USB to Fast Ethernet Adapter */
604 .driver_info = (unsigned long)&dm9601_info,
605 },
606 {
607 USB_DEVICE(0x0fe6, 0x9700), /* DM9601 USB to Fast Ethernet Adapter */
608 .driver_info = (unsigned long)&dm9601_info,
609 },
610 {
611 USB_DEVICE(0x0a46, 0x9000), /* DM9000E */
612 .driver_info = (unsigned long)&dm9601_info,
613 },
614 {
615 USB_DEVICE(0x0a46, 0x9620), /* DM9620 USB to Fast Ethernet Adapter */
616 .driver_info = (unsigned long)&dm9601_info,
617 },
618 {
619 USB_DEVICE(0x0a46, 0x9621), /* DM9621A USB to Fast Ethernet Adapter */
620 .driver_info = (unsigned long)&dm9601_info,
621 },
622 {
623 USB_DEVICE(0x0a46, 0x9622), /* DM9622 USB to Fast Ethernet Adapter */
624 .driver_info = (unsigned long)&dm9601_info,
625 },
626 {
627 USB_DEVICE(0x0a46, 0x0269), /* DM962OA USB to Fast Ethernet Adapter */
628 .driver_info = (unsigned long)&dm9601_info,
629 },
630 {
631 USB_DEVICE(0x0a46, 0x1269), /* DM9621A USB to Fast Ethernet Adapter */
632 .driver_info = (unsigned long)&dm9601_info,
633 },
634 {
635 USB_DEVICE(0x0586, 0x3427), /* ZyXEL Keenetic Plus DSL xDSL modem */
636 .driver_info = (unsigned long)&dm9601_info,
637 },
638 {}, // END
639};
640
641MODULE_DEVICE_TABLE(usb, products);
642
643static struct usb_driver dm9601_driver = {
644 .name = "dm9601",
645 .id_table = products,
646 .probe = usbnet_probe,
647 .disconnect = usbnet_disconnect,
648 .suspend = usbnet_suspend,
649 .resume = usbnet_resume,
650 .disable_hub_initiated_lpm = 1,
651};
652
653module_usb_driver(dm9601_driver);
654
655MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
656MODULE_DESCRIPTION("Davicom DM96xx USB 10/100 ethernet devices");
657MODULE_LICENSE("GPL");