Mention branches and keyring.
[releases.git] / usb / dm9601.c
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
61 static 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
72 static int dm_read_reg(struct usbnet *dev, u8 reg, u8 *value)
73 {
74         return dm_read(dev, reg, 1, value);
75 }
76
77 static 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
89 static 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
96 static 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
104 static 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
111 static 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
150 static 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
184 out:
185         mutex_unlock(&dev->phy_mutex);
186         return ret;
187 }
188
189 static 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
196 static int dm9601_get_eeprom_len(struct net_device *dev)
197 {
198         return DM_EEPROM_LEN;
199 }
200
201 static 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
220 static 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
226         if (phy_id) {
227                 netdev_dbg(dev->net, "Only internal phy supported\n");
228                 return 0;
229         }
230
231         dm_read_shared_word(dev, 1, loc, &res);
232
233         netdev_dbg(dev->net,
234                    "dm9601_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
235                    phy_id, loc, le16_to_cpu(res));
236
237         return le16_to_cpu(res);
238 }
239
240 static void dm9601_mdio_write(struct net_device *netdev, int phy_id, int loc,
241                               int val)
242 {
243         struct usbnet *dev = netdev_priv(netdev);
244         __le16 res = cpu_to_le16(val);
245
246         if (phy_id) {
247                 netdev_dbg(dev->net, "Only internal phy supported\n");
248                 return;
249         }
250
251         netdev_dbg(dev->net, "dm9601_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
252                    phy_id, loc, val);
253
254         dm_write_shared_word(dev, 1, loc, res);
255 }
256
257 static void dm9601_get_drvinfo(struct net_device *net,
258                                struct ethtool_drvinfo *info)
259 {
260         /* Inherit standard device info */
261         usbnet_get_drvinfo(net, info);
262 }
263
264 static u32 dm9601_get_link(struct net_device *net)
265 {
266         struct usbnet *dev = netdev_priv(net);
267
268         return mii_link_ok(&dev->mii);
269 }
270
271 static int dm9601_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
272 {
273         struct usbnet *dev = netdev_priv(net);
274
275         return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
276 }
277
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         .nway_reset     = usbnet_nway_reset,
286         .get_link_ksettings     = usbnet_get_link_ksettings_mii,
287         .set_link_ksettings     = usbnet_set_link_ksettings_mii,
288 };
289
290 static void dm9601_set_multicast(struct net_device *net)
291 {
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;
296         u8 rx_ctl = 0x31;
297
298         memset(hashes, 0x00, DM_MCAST_SIZE);
299         hashes[DM_MCAST_SIZE - 1] |= 0x80;      /* broadcast address */
300
301         if (net->flags & IFF_PROMISC) {
302                 rx_ctl |= 0x02;
303         } else if (net->flags & IFF_ALLMULTI ||
304                    netdev_mc_count(net) > DM_MAX_MCAST) {
305                 rx_ctl |= 0x08;
306         } else if (!netdev_mc_empty(net)) {
307                 struct netdev_hw_addr *ha;
308
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);
312                 }
313         }
314
315         dm_write_async(dev, DM_MCAST_ADDR, DM_MCAST_SIZE, hashes);
316         dm_write_reg_async(dev, DM_RX_CTRL, rx_ctl);
317 }
318
319 static void __dm9601_set_mac_address(struct usbnet *dev)
320 {
321         dm_write_async(dev, DM_PHY_ADDR, ETH_ALEN, dev->net->dev_addr);
322 }
323
324 static int dm9601_set_mac_address(struct net_device *net, void *p)
325 {
326         struct sockaddr *addr = p;
327         struct usbnet *dev = netdev_priv(net);
328
329         if (!is_valid_ether_addr(addr->sa_data)) {
330                 dev_err(&net->dev, "not setting invalid mac address %pM\n",
331                                                                 addr->sa_data);
332                 return -EINVAL;
333         }
334
335         eth_hw_addr_set(net, addr->sa_data);
336         __dm9601_set_mac_address(dev);
337
338         return 0;
339 }
340
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_get_stats64        = dev_get_tstats64,
348         .ndo_validate_addr      = eth_validate_addr,
349         .ndo_eth_ioctl          = dm9601_ioctl,
350         .ndo_set_rx_mode        = dm9601_set_multicast,
351         .ndo_set_mac_address    = dm9601_set_mac_address,
352 };
353
354 static int dm9601_bind(struct usbnet *dev, struct usb_interface *intf)
355 {
356         int ret;
357         u8 mac[ETH_ALEN], id;
358
359         ret = usbnet_get_endpoints(dev, intf);
360         if (ret)
361                 goto out;
362
363         dev->net->netdev_ops = &dm9601_netdev_ops;
364         dev->net->ethtool_ops = &dm9601_ethtool_ops;
365         dev->net->hard_header_len += DM_TX_OVERHEAD;
366         dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
367
368         /* dm9620/21a require room for 4 byte padding, even in dm9601
369          * mode, so we need +1 to be able to receive full size
370          * ethernet frames.
371          */
372         dev->rx_urb_size = dev->net->mtu + ETH_HLEN + DM_RX_OVERHEAD + 1;
373
374         dev->mii.dev = dev->net;
375         dev->mii.mdio_read = dm9601_mdio_read;
376         dev->mii.mdio_write = dm9601_mdio_write;
377         dev->mii.phy_id_mask = 0x1f;
378         dev->mii.reg_num_mask = 0x1f;
379
380         /* reset */
381         dm_write_reg(dev, DM_NET_CTRL, 1);
382         udelay(20);
383
384         /* read MAC */
385         if (dm_read(dev, DM_PHY_ADDR, ETH_ALEN, mac) < 0) {
386                 printk(KERN_ERR "Error reading MAC address\n");
387                 ret = -ENODEV;
388                 goto out;
389         }
390
391         /*
392          * Overwrite the auto-generated address only with good ones.
393          */
394         if (is_valid_ether_addr(mac))
395                 eth_hw_addr_set(dev->net, mac);
396         else {
397                 printk(KERN_WARNING
398                         "dm9601: No valid MAC address in EEPROM, using %pM\n",
399                         dev->net->dev_addr);
400                 __dm9601_set_mac_address(dev);
401         }
402
403         if (dm_read_reg(dev, DM_CHIP_ID, &id) < 0) {
404                 netdev_err(dev->net, "Error reading chip ID\n");
405                 ret = -ENODEV;
406                 goto out;
407         }
408
409         /* put dm9620 devices in dm9601 mode */
410         if (id == ID_DM9620) {
411                 u8 mode;
412
413                 if (dm_read_reg(dev, DM_MODE_CTRL, &mode) < 0) {
414                         netdev_err(dev->net, "Error reading MODE_CTRL\n");
415                         ret = -ENODEV;
416                         goto out;
417                 }
418                 dm_write_reg(dev, DM_MODE_CTRL, mode & 0x7f);
419         }
420
421         /* power up phy */
422         dm_write_reg(dev, DM_GPR_CTRL, 1);
423         dm_write_reg(dev, DM_GPR_DATA, 0);
424
425         /* receive broadcast packets */
426         dm9601_set_multicast(dev->net);
427
428         dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
429         dm9601_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
430                           ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP);
431         mii_nway_restart(&dev->mii);
432
433 out:
434         return ret;
435 }
436
437 static int dm9601_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
438 {
439         u8 status;
440         int len;
441
442         /* format:
443            b1: rx status
444            b2: packet length (incl crc) low
445            b3: packet length (incl crc) high
446            b4..n-4: packet data
447            bn-3..bn: ethernet crc
448          */
449
450         if (unlikely(skb->len < DM_RX_OVERHEAD)) {
451                 dev_err(&dev->udev->dev, "unexpected tiny rx frame\n");
452                 return 0;
453         }
454
455         status = skb->data[0];
456         len = (skb->data[1] | (skb->data[2] << 8)) - 4;
457
458         if (unlikely(status & 0xbf)) {
459                 if (status & 0x01) dev->net->stats.rx_fifo_errors++;
460                 if (status & 0x02) dev->net->stats.rx_crc_errors++;
461                 if (status & 0x04) dev->net->stats.rx_frame_errors++;
462                 if (status & 0x20) dev->net->stats.rx_missed_errors++;
463                 if (status & 0x90) dev->net->stats.rx_length_errors++;
464                 return 0;
465         }
466
467         skb_pull(skb, 3);
468         skb_trim(skb, len);
469
470         return 1;
471 }
472
473 static struct sk_buff *dm9601_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
474                                        gfp_t flags)
475 {
476         int len, pad;
477
478         /* format:
479            b1: packet length low
480            b2: packet length high
481            b3..n: packet data
482         */
483
484         len = skb->len + DM_TX_OVERHEAD;
485
486         /* workaround for dm962x errata with tx fifo getting out of
487          * sync if a USB bulk transfer retry happens right after a
488          * packet with odd / maxpacket length by adding up to 3 bytes
489          * padding.
490          */
491         while ((len & 1) || !(len % dev->maxpacket))
492                 len++;
493
494         len -= DM_TX_OVERHEAD; /* hw header doesn't count as part of length */
495         pad = len - skb->len;
496
497         if (skb_headroom(skb) < DM_TX_OVERHEAD || skb_tailroom(skb) < pad) {
498                 struct sk_buff *skb2;
499
500                 skb2 = skb_copy_expand(skb, DM_TX_OVERHEAD, pad, flags);
501                 dev_kfree_skb_any(skb);
502                 skb = skb2;
503                 if (!skb)
504                         return NULL;
505         }
506
507         __skb_push(skb, DM_TX_OVERHEAD);
508
509         if (pad) {
510                 memset(skb->data + skb->len, 0, pad);
511                 __skb_put(skb, pad);
512         }
513
514         skb->data[0] = len;
515         skb->data[1] = len >> 8;
516
517         return skb;
518 }
519
520 static void dm9601_status(struct usbnet *dev, struct urb *urb)
521 {
522         int link;
523         u8 *buf;
524
525         /* format:
526            b0: net status
527            b1: tx status 1
528            b2: tx status 2
529            b3: rx status
530            b4: rx overflow
531            b5: rx count
532            b6: tx count
533            b7: gpr
534         */
535
536         if (urb->actual_length < 8)
537                 return;
538
539         buf = urb->transfer_buffer;
540
541         link = !!(buf[0] & 0x40);
542         if (netif_carrier_ok(dev->net) != link) {
543                 usbnet_link_change(dev, link, 1);
544                 netdev_dbg(dev->net, "Link Status is: %d\n", link);
545         }
546 }
547
548 static int dm9601_link_reset(struct usbnet *dev)
549 {
550         struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
551
552         mii_check_media(&dev->mii, 1, 1);
553         mii_ethtool_gset(&dev->mii, &ecmd);
554
555         netdev_dbg(dev->net, "link_reset() speed: %u duplex: %d\n",
556                    ethtool_cmd_speed(&ecmd), ecmd.duplex);
557
558         return 0;
559 }
560
561 static const struct driver_info dm9601_info = {
562         .description    = "Davicom DM96xx USB 10/100 Ethernet",
563         .flags          = FLAG_ETHER | FLAG_LINK_INTR,
564         .bind           = dm9601_bind,
565         .rx_fixup       = dm9601_rx_fixup,
566         .tx_fixup       = dm9601_tx_fixup,
567         .status         = dm9601_status,
568         .link_reset     = dm9601_link_reset,
569         .reset          = dm9601_link_reset,
570 };
571
572 static const struct usb_device_id products[] = {
573         {
574          USB_DEVICE(0x07aa, 0x9601),    /* Corega FEther USB-TXC */
575          .driver_info = (unsigned long)&dm9601_info,
576          },
577         {
578          USB_DEVICE(0x0a46, 0x9601),    /* Davicom USB-100 */
579          .driver_info = (unsigned long)&dm9601_info,
580          },
581         {
582          USB_DEVICE(0x0a46, 0x6688),    /* ZT6688 USB NIC */
583          .driver_info = (unsigned long)&dm9601_info,
584          },
585         {
586          USB_DEVICE(0x0a46, 0x0268),    /* ShanTou ST268 USB NIC */
587          .driver_info = (unsigned long)&dm9601_info,
588          },
589         {
590          USB_DEVICE(0x0a46, 0x8515),    /* ADMtek ADM8515 USB NIC */
591          .driver_info = (unsigned long)&dm9601_info,
592          },
593         {
594         USB_DEVICE(0x0a47, 0x9601),     /* Hirose USB-100 */
595         .driver_info = (unsigned long)&dm9601_info,
596          },
597         {
598         USB_DEVICE(0x0fe6, 0x8101),     /* DM9601 USB to Fast Ethernet Adapter */
599         .driver_info = (unsigned long)&dm9601_info,
600          },
601         {
602          USB_DEVICE(0x0fe6, 0x9700),    /* DM9601 USB to Fast Ethernet Adapter */
603          .driver_info = (unsigned long)&dm9601_info,
604          },
605         {
606          USB_DEVICE(0x0a46, 0x9000),    /* DM9000E */
607          .driver_info = (unsigned long)&dm9601_info,
608          },
609         {
610          USB_DEVICE(0x0a46, 0x9620),    /* DM9620 USB to Fast Ethernet Adapter */
611          .driver_info = (unsigned long)&dm9601_info,
612          },
613         {
614          USB_DEVICE(0x0a46, 0x9621),    /* DM9621A USB to Fast Ethernet Adapter */
615          .driver_info = (unsigned long)&dm9601_info,
616         },
617         {
618          USB_DEVICE(0x0a46, 0x9622),    /* DM9622 USB to Fast Ethernet Adapter */
619          .driver_info = (unsigned long)&dm9601_info,
620         },
621         {
622          USB_DEVICE(0x0a46, 0x0269),    /* DM962OA USB to Fast Ethernet Adapter */
623          .driver_info = (unsigned long)&dm9601_info,
624         },
625         {
626          USB_DEVICE(0x0a46, 0x1269),    /* DM9621A USB to Fast Ethernet Adapter */
627          .driver_info = (unsigned long)&dm9601_info,
628         },
629         {
630          USB_DEVICE(0x0586, 0x3427),    /* ZyXEL Keenetic Plus DSL xDSL modem */
631          .driver_info = (unsigned long)&dm9601_info,
632         },
633         {},                     // END
634 };
635
636 MODULE_DEVICE_TABLE(usb, products);
637
638 static struct usb_driver dm9601_driver = {
639         .name = "dm9601",
640         .id_table = products,
641         .probe = usbnet_probe,
642         .disconnect = usbnet_disconnect,
643         .suspend = usbnet_suspend,
644         .resume = usbnet_resume,
645         .disable_hub_initiated_lpm = 1,
646 };
647
648 module_usb_driver(dm9601_driver);
649
650 MODULE_AUTHOR("Peter Korsgaard <jacmet@sunsite.dk>");
651 MODULE_DESCRIPTION("Davicom DM96xx USB 10/100 ethernet devices");
652 MODULE_LICENSE("GPL");