2 * Copyright (c) 2002 Petko Manolov (petkan@users.sourceforge.net)
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * version 2 as published by the Free Software Foundation.
9 #include <linux/config.h>
10 #include <linux/sched.h>
11 #include <linux/init.h>
12 #include <linux/signal.h>
13 #include <linux/slab.h>
14 #include <linux/module.h>
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/mii.h>
18 #include <linux/ethtool.h>
19 #include <linux/usb.h>
20 #include <asm/uaccess.h>
22 /* Version Information */
23 #define DRIVER_VERSION "v0.5.7 (2002/12/31)"
24 #define DRIVER_AUTHOR "Petko Manolov <petkan@users.sourceforge.net>"
25 #define DRIVER_DESC "rtl8150 based usb-ethernet driver"
47 #define IDR_EEPROM 0x1202
50 #define PHY_WRITE 0x20
53 #define MII_TIMEOUT 10
55 #define RTL8150_REQT_READ 0xc0
56 #define RTL8150_REQT_WRITE 0x40
57 #define RTL8150_REQ_GET_REGS 0x05
58 #define RTL8150_REQ_SET_REGS 0x05
60 #define RTL8150_MTU 1540
61 #define RTL8150_TX_TIMEOUT (HZ)
62 #define RX_SKB_POOL_SIZE 4
65 #define RTL8150_HW_CRC 0
67 #define RTL8150_UNPLUG 2
70 /* Define these values to match your device */
71 #define VENDOR_ID_REALTEK 0x0bda
72 #define VENDOR_ID_MELCO 0x0411
74 #define PRODUCT_ID_RTL8150 0x8150
75 #define PRODUCT_ID_LUAKTX 0x0012
79 /* table of devices that work with this driver */
80 static struct usb_device_id rtl8150_table[] = {
81 {USB_DEVICE(VENDOR_ID_REALTEK, PRODUCT_ID_RTL8150)},
82 {USB_DEVICE(VENDOR_ID_MELCO, PRODUCT_ID_LUAKTX)},
86 MODULE_DEVICE_TABLE(usb, rtl8150_table);
90 struct usb_device *udev;
91 struct tasklet_struct tl;
92 struct net_device_stats stats;
93 struct net_device *netdev;
94 struct urb *rx_urb, *tx_urb, *intr_urb, *ctrl_urb;
95 struct sk_buff *tx_skb, *rx_skb;
96 struct sk_buff *rx_skb_pool[RX_SKB_POOL_SIZE];
97 spinlock_t rx_pool_lock;
98 struct usb_ctrlrequest dr;
105 typedef struct rtl8150 rtl8150_t;
107 unsigned long multicast_filter_limit = 32;
109 static void fill_skb_pool(rtl8150_t *);
110 static void free_skb_pool(rtl8150_t *);
111 static inline struct sk_buff *pull_skb(rtl8150_t *);
112 static void rtl8150_disconnect(struct usb_interface *intf);
113 static int rtl8150_probe(struct usb_interface *intf,
114 const struct usb_device_id *id);
116 static const char driver_name [] = "rtl8150";
118 static struct usb_driver rtl8150_driver = {
119 .owner = THIS_MODULE,
121 .probe = rtl8150_probe,
122 .disconnect = rtl8150_disconnect,
123 .id_table = rtl8150_table,
128 ** device related part of the code
131 static int get_registers(rtl8150_t * dev, u16 indx, u16 size, void *data)
133 return usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
134 RTL8150_REQ_GET_REGS, RTL8150_REQT_READ,
135 indx, 0, data, size, HZ / 2);
138 static int set_registers(rtl8150_t * dev, u16 indx, u16 size, void *data)
140 return usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
141 RTL8150_REQ_SET_REGS, RTL8150_REQT_WRITE,
142 indx, 0, data, size, HZ / 2);
145 static void ctrl_callback(struct urb *urb, struct pt_regs *regs)
149 switch (urb->status) {
157 warn("ctrl urb status %d", urb->status);
160 clear_bit(RX_REG_SET, &dev->flags);
163 static int async_set_registers(rtl8150_t * dev, u16 indx, u16 size)
167 if (test_bit(RX_REG_SET, &dev->flags))
170 dev->dr.bRequestType = RTL8150_REQT_WRITE;
171 dev->dr.bRequest = RTL8150_REQ_SET_REGS;
172 dev->dr.wValue = cpu_to_le16(indx);
174 dev->dr.wLength = cpu_to_le16(size);
175 dev->ctrl_urb->transfer_buffer_length = size;
176 usb_fill_control_urb(dev->ctrl_urb, dev->udev,
177 usb_sndctrlpipe(dev->udev, 0), (char *) &dev->dr,
178 &dev->rx_creg, size, ctrl_callback, dev);
179 if ((ret = usb_submit_urb(dev->ctrl_urb, GFP_ATOMIC)))
180 err("control request submission failed: %d", ret);
182 set_bit(RX_REG_SET, &dev->flags);
187 static int read_mii_word(rtl8150_t * dev, u8 phy, __u8 indx, u16 * reg)
193 data[1] = data[2] = 0;
194 tmp = indx | PHY_READ | PHY_GO;
197 set_registers(dev, PHYADD, sizeof(data), data);
198 set_registers(dev, PHYCNT, 1, &tmp);
200 get_registers(dev, PHYCNT, 1, data);
201 } while ((data[0] & PHY_GO) && (i++ < MII_TIMEOUT));
203 if (i < MII_TIMEOUT) {
204 get_registers(dev, PHYDAT, 2, data);
205 *reg = le16_to_cpup(data);
211 static int write_mii_word(rtl8150_t * dev, u8 phy, __u8 indx, u16 reg)
217 *(data + 1) = cpu_to_le16p(®);
218 tmp = indx | PHY_WRITE | PHY_GO;
221 set_registers(dev, PHYADD, sizeof(data), data);
222 set_registers(dev, PHYCNT, 1, &tmp);
224 get_registers(dev, PHYCNT, 1, data);
225 } while ((data[0] & PHY_GO) && (i++ < MII_TIMEOUT));
233 static inline void set_ethernet_addr(rtl8150_t * dev)
237 get_registers(dev, IDR, sizeof(node_id), node_id);
238 memcpy(dev->netdev->dev_addr, node_id, sizeof(node_id));
241 static int rtl8150_set_mac_address(struct net_device *netdev, void *p)
243 struct sockaddr *addr = p;
247 if (netif_running(netdev))
253 memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
254 dbg("%s: Setting MAC address to ", netdev->name);
255 for (i = 0; i < 5; i++)
256 dbg("%02X:", netdev->dev_addr[i]);
257 dbg("%02X\n", netdev->dev_addr[i]);
258 /* Set the IDR registers. */
259 set_registers(dev, IDR, sizeof(netdev->dev_addr), netdev->dev_addr);
263 /* Get the CR contents. */
264 get_registers(dev, CR, 1, &cr);
265 /* Set the WEPROM bit (eeprom write enable). */
267 set_registers(dev, CR, 1, &cr);
268 /* Write the MAC address into eeprom. Eeprom writes must be word-sized,
269 so we need to split them up. */
270 for (i = 0; i * 2 < netdev->addr_len; i++) {
271 set_registers(dev, IDR_EEPROM + (i * 2), 2,
272 netdev->dev_addr + (i * 2));
274 /* Clear the WEPROM bit (preventing accidental eeprom writes). */
276 set_registers(dev, CR, 1, &cr);
282 static int rtl8150_reset(rtl8150_t * dev)
287 set_registers(dev, CR, 1, &data);
289 get_registers(dev, CR, 1, &data);
290 } while ((data & 0x10) && --i);
292 return (i > 0) ? 1 : 0;
295 static int alloc_all_urbs(rtl8150_t * dev)
297 dev->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
300 dev->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
302 usb_free_urb(dev->rx_urb);
305 dev->intr_urb = usb_alloc_urb(0, GFP_KERNEL);
306 if (!dev->intr_urb) {
307 usb_free_urb(dev->rx_urb);
308 usb_free_urb(dev->tx_urb);
311 dev->ctrl_urb = usb_alloc_urb(0, GFP_KERNEL);
312 if (!dev->intr_urb) {
313 usb_free_urb(dev->rx_urb);
314 usb_free_urb(dev->tx_urb);
315 usb_free_urb(dev->intr_urb);
322 static void free_all_urbs(rtl8150_t * dev)
324 usb_free_urb(dev->rx_urb);
325 usb_free_urb(dev->tx_urb);
326 usb_free_urb(dev->intr_urb);
327 usb_free_urb(dev->ctrl_urb);
330 static void unlink_all_urbs(rtl8150_t * dev)
332 usb_unlink_urb(dev->rx_urb);
333 usb_unlink_urb(dev->tx_urb);
334 usb_unlink_urb(dev->intr_urb);
335 usb_unlink_urb(dev->ctrl_urb);
338 static void read_bulk_callback(struct urb *urb, struct pt_regs *regs)
341 unsigned pkt_len, res;
343 struct net_device *netdev;
349 if (test_bit(RTL8150_UNPLUG, &dev->flags))
351 netdev = dev->netdev;
352 if (!netif_device_present(netdev))
355 switch (urb->status) {
359 return; /* the urb is in unlink state */
361 warn("may be reset is needed?..");
364 warn("Rx status %d", urb->status);
371 res = urb->actual_length;
372 rx_stat = le16_to_cpu(*(short *)(urb->transfer_buffer + res - 4));
375 skb_put(dev->rx_skb, pkt_len);
376 dev->rx_skb->protocol = eth_type_trans(dev->rx_skb, netdev);
377 netif_rx(dev->rx_skb);
378 dev->stats.rx_packets++;
379 dev->stats.rx_bytes += pkt_len;
381 spin_lock(&dev->rx_pool_lock);
383 spin_unlock(&dev->rx_pool_lock);
389 usb_fill_bulk_urb(dev->rx_urb, dev->udev, usb_rcvbulkpipe(dev->udev, 1),
390 dev->rx_skb->data, RTL8150_MTU, read_bulk_callback, dev);
391 if (usb_submit_urb(dev->rx_urb, GFP_ATOMIC)) {
392 set_bit(RX_URB_FAIL, &dev->flags);
395 clear_bit(RX_URB_FAIL, &dev->flags);
400 tasklet_schedule(&dev->tl);
403 static void rx_fixup(unsigned long data)
408 dev = (rtl8150_t *)data;
410 spin_lock_irq(&dev->rx_pool_lock);
412 spin_unlock_irq(&dev->rx_pool_lock);
413 if (test_bit(RX_URB_FAIL, &dev->flags))
416 spin_lock_irq(&dev->rx_pool_lock);
418 spin_unlock_irq(&dev->rx_pool_lock);
422 usb_fill_bulk_urb(dev->rx_urb, dev->udev, usb_rcvbulkpipe(dev->udev, 1),
423 dev->rx_skb->data, RTL8150_MTU, read_bulk_callback, dev);
425 if (usb_submit_urb(dev->rx_urb, GFP_ATOMIC)) {
426 set_bit(RX_URB_FAIL, &dev->flags);
429 clear_bit(RX_URB_FAIL, &dev->flags);
434 tasklet_schedule(&dev->tl);
437 static void write_bulk_callback(struct urb *urb, struct pt_regs *regs)
444 dev_kfree_skb_irq(dev->tx_skb);
445 if (!netif_device_present(dev->netdev))
448 info("%s: Tx status %d", dev->netdev->name, urb->status);
449 dev->netdev->trans_start = jiffies;
450 netif_wake_queue(dev->netdev);
453 void intr_callback(struct urb *urb, struct pt_regs *regs)
461 switch (urb->status) {
462 case 0: /* success */
464 case -ECONNRESET: /* unlink */
468 /* -EPIPE: should clear the halt */
470 info("%s: intr status %d", dev->netdev->name, urb->status);
474 /* FIXME if this doesn't do anything, don't submit the urb! */
477 status = usb_submit_urb (urb, SLAB_ATOMIC);
479 err ("can't resubmit intr, %s-%s/input0, status %d",
480 dev->udev->bus->bus_name,
481 dev->udev->devpath, status);
486 ** network related part of the code
490 static void fill_skb_pool(rtl8150_t *dev)
495 for (i = 0; i < RX_SKB_POOL_SIZE; i++) {
496 if (dev->rx_skb_pool[i])
498 skb = dev_alloc_skb(RTL8150_MTU + 2);
502 skb->dev = dev->netdev;
504 dev->rx_skb_pool[i] = skb;
508 static void free_skb_pool(rtl8150_t *dev)
512 for (i = 0; i < RX_SKB_POOL_SIZE; i++)
513 if (dev->rx_skb_pool[i])
514 dev_kfree_skb(dev->rx_skb_pool[i]);
517 static inline struct sk_buff *pull_skb(rtl8150_t *dev)
522 for (i = 0; i < RX_SKB_POOL_SIZE; i++) {
523 if (dev->rx_skb_pool[i]) {
524 skb = dev->rx_skb_pool[i];
525 dev->rx_skb_pool[i] = NULL;
532 static int enable_net_traffic(rtl8150_t * dev)
534 u8 cr, tcr, rcr, msr;
536 if (!rtl8150_reset(dev)) {
537 warn("%s - device reset failed", __FUNCTION__);
539 /* RCR bit7=1 attach Rx info at the end; =0 HW CRC (which is broken) */
540 rcr = 0x9e; /* bit7=1 attach Rx info at the end */
541 dev->rx_creg = cpu_to_le16(rcr);
545 set_bit(RTL8150_HW_CRC, &dev->flags);
546 set_registers(dev, RCR, 1, &rcr);
547 set_registers(dev, TCR, 1, &tcr);
548 set_registers(dev, CR, 1, &cr);
549 get_registers(dev, MSR, 1, &msr);
554 static void disable_net_traffic(rtl8150_t * dev)
558 get_registers(dev, CR, 1, &cr);
560 set_registers(dev, CR, 1, &cr);
563 static struct net_device_stats *rtl8150_netdev_stats(struct net_device *dev)
565 return &((rtl8150_t *) dev->priv)->stats;
568 static void rtl8150_tx_timeout(struct net_device *netdev)
575 warn("%s: Tx timeout.", netdev->name);
576 dev->tx_urb->transfer_flags |= URB_ASYNC_UNLINK;
577 usb_unlink_urb(dev->tx_urb);
578 dev->stats.tx_errors++;
581 static void rtl8150_set_multicast(struct net_device *netdev)
586 netif_stop_queue(netdev);
587 if (netdev->flags & IFF_PROMISC) {
588 dev->rx_creg |= cpu_to_le16(0x0001);
589 info("%s: promiscuous mode", netdev->name);
590 } else if ((netdev->mc_count > multicast_filter_limit) ||
591 (netdev->flags & IFF_ALLMULTI)) {
592 dev->rx_creg &= cpu_to_le16(0xfffe);
593 dev->rx_creg |= cpu_to_le16(0x0002);
594 info("%s: allmulti set", netdev->name);
596 /* ~RX_MULTICAST, ~RX_PROMISCUOUS */
597 dev->rx_creg &= cpu_to_le16(0x00fc);
599 async_set_registers(dev, RCR, 2);
600 netif_wake_queue(netdev);
603 static int rtl8150_start_xmit(struct sk_buff *skb, struct net_device *netdev)
608 netif_stop_queue(netdev);
610 count = (skb->len < 60) ? 60 : skb->len;
611 count = (count & 0x3f) ? count : count + 1;
613 usb_fill_bulk_urb(dev->tx_urb, dev->udev, usb_sndbulkpipe(dev->udev, 2),
614 skb->data, count, write_bulk_callback, dev);
615 if ((res = usb_submit_urb(dev->tx_urb, GFP_ATOMIC))) {
616 warn("failed tx_urb %d\n", res);
617 dev->stats.tx_errors++;
618 netif_start_queue(netdev);
620 dev->stats.tx_packets++;
621 dev->stats.tx_bytes += skb->len;
622 netdev->trans_start = jiffies;
628 static int rtl8150_open(struct net_device *netdev)
637 if (dev->rx_skb == NULL)
638 dev->rx_skb = pull_skb(dev);
642 set_registers(dev, IDR, 6, netdev->dev_addr);
644 usb_fill_bulk_urb(dev->rx_urb, dev->udev, usb_rcvbulkpipe(dev->udev, 1),
645 dev->rx_skb->data, RTL8150_MTU, read_bulk_callback, dev);
646 if ((res = usb_submit_urb(dev->rx_urb, GFP_KERNEL)))
647 warn("%s: rx_urb submit failed: %d", __FUNCTION__, res);
648 usb_fill_int_urb(dev->intr_urb, dev->udev, usb_rcvintpipe(dev->udev, 3),
649 dev->intr_buff, sizeof(dev->intr_buff), intr_callback,
650 dev, dev->intr_interval);
651 if ((res = usb_submit_urb(dev->intr_urb, GFP_KERNEL)))
652 warn("%s: intr_urb submit failed: %d", __FUNCTION__, res);
653 netif_start_queue(netdev);
654 enable_net_traffic(dev);
659 static int rtl8150_close(struct net_device *netdev)
668 netif_stop_queue(netdev);
669 if (!test_bit(RTL8150_UNPLUG, &dev->flags))
670 disable_net_traffic(dev);
671 unlink_all_urbs(dev);
676 static int rtl8150_ethtool_ioctl(struct net_device *netdev, void __user *uaddr)
682 if (get_user(cmd, (int *) uaddr))
686 case ETHTOOL_GDRVINFO:{
687 struct ethtool_drvinfo info = { ETHTOOL_GDRVINFO };
689 strncpy(info.driver, driver_name, ETHTOOL_BUSINFO_LEN);
690 strncpy(info.version, DRIVER_VERSION, ETHTOOL_BUSINFO_LEN);
691 usb_make_path(dev->udev, info.bus_info, sizeof info.bus_info);
692 if (copy_to_user(uaddr, &info, sizeof(info)))
697 struct ethtool_cmd ecmd;
700 if (copy_from_user(&ecmd, uaddr, sizeof(ecmd)))
702 ecmd.supported = (SUPPORTED_10baseT_Half |
703 SUPPORTED_10baseT_Full |
704 SUPPORTED_100baseT_Half |
705 SUPPORTED_100baseT_Full |
707 SUPPORTED_TP | SUPPORTED_MII);
709 ecmd.transceiver = XCVR_INTERNAL;
710 ecmd.phy_address = dev->phy;
711 get_registers(dev, BMCR, 2, &bmcr);
712 get_registers(dev, ANLP, 2, &lpa);
713 if (bmcr & BMCR_ANENABLE) {
714 ecmd.autoneg = AUTONEG_ENABLE;
715 ecmd.speed = (lpa & (LPA_100HALF | LPA_100FULL)) ?
716 SPEED_100 : SPEED_10;
717 if (ecmd.speed == SPEED_100)
718 ecmd.duplex = (lpa & LPA_100FULL) ?
719 DUPLEX_FULL : DUPLEX_HALF;
721 ecmd.duplex = (lpa & LPA_10FULL) ?
722 DUPLEX_FULL : DUPLEX_HALF;
724 ecmd.autoneg = AUTONEG_DISABLE;
725 ecmd.speed = (bmcr & BMCR_SPEED100) ?
726 SPEED_100 : SPEED_10;
727 ecmd.duplex = (bmcr & BMCR_FULLDPLX) ?
728 DUPLEX_FULL : DUPLEX_HALF;
730 if (copy_to_user(uaddr, &ecmd, sizeof(ecmd)))
737 struct ethtool_value edata = { ETHTOOL_GLINK };
739 edata.data = netif_carrier_ok(netdev);
740 if (copy_to_user(uaddr, &edata, sizeof(edata)))
749 static int rtl8150_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
756 data = (u16 *) & rq->ifr_data;
761 res = rtl8150_ethtool_ioctl(netdev, (void __user *)rq->ifr_data);
765 case SIOCDEVPRIVATE + 1:
766 read_mii_word(dev, dev->phy, (data[1] & 0x1f), &data[3]);
768 case SIOCDEVPRIVATE + 2:
769 if (!capable(CAP_NET_ADMIN))
771 write_mii_word(dev, dev->phy, (data[1] & 0x1f), data[2]);
779 static int rtl8150_probe(struct usb_interface *intf,
780 const struct usb_device_id *id)
782 struct usb_device *udev = interface_to_usbdev(intf);
784 struct net_device *netdev;
786 dev = kmalloc(sizeof(rtl8150_t), GFP_KERNEL);
788 err("Out of memory");
791 memset(dev, 0, sizeof(rtl8150_t));
793 netdev = alloc_etherdev(0);
796 err("Oh boy, out of memory again?!?");
800 tasklet_init(&dev->tl, rx_fixup, (unsigned long)dev);
801 spin_lock_init(&dev->rx_pool_lock);
804 dev->netdev = netdev;
805 SET_MODULE_OWNER(netdev);
807 netdev->open = rtl8150_open;
808 netdev->stop = rtl8150_close;
809 netdev->do_ioctl = rtl8150_ioctl;
810 netdev->watchdog_timeo = RTL8150_TX_TIMEOUT;
811 netdev->tx_timeout = rtl8150_tx_timeout;
812 netdev->hard_start_xmit = rtl8150_start_xmit;
813 netdev->set_multicast_list = rtl8150_set_multicast;
814 netdev->set_mac_address = rtl8150_set_mac_address;
815 netdev->get_stats = rtl8150_netdev_stats;
816 netdev->mtu = RTL8150_MTU;
817 dev->intr_interval = 100; /* 100ms */
819 if (!alloc_all_urbs(dev)) {
820 err("out of memory");
823 if (!rtl8150_reset(dev)) {
824 err("couldn't reset the device");
828 set_ethernet_addr(dev);
829 info("%s: rtl8150 is detected", netdev->name);
831 usb_set_intfdata(intf, dev);
833 SET_NETDEV_DEV(netdev, &intf->dev);
834 if (register_netdev(netdev) != 0) {
835 err("couldn't register the device");
841 usb_set_intfdata(intf, NULL);
851 static void rtl8150_disconnect(struct usb_interface *intf)
853 rtl8150_t *dev = usb_get_intfdata(intf);
855 usb_set_intfdata(intf, NULL);
857 set_bit(RTL8150_UNPLUG, &dev->flags);
858 unregister_netdev(dev->netdev);
859 unlink_all_urbs(dev);
863 dev_kfree_skb(dev->rx_skb);
869 int __init usb_rtl8150_init(void)
871 info(DRIVER_DESC " " DRIVER_VERSION);
872 return usb_register(&rtl8150_driver);
875 void __exit usb_rtl8150_exit(void)
877 usb_deregister(&rtl8150_driver);
880 module_init(usb_rtl8150_init);
881 module_exit(usb_rtl8150_exit);
883 MODULE_AUTHOR(DRIVER_AUTHOR);
884 MODULE_DESCRIPTION(DRIVER_DESC);
885 MODULE_LICENSE("GPL");