2 * Davicom DM9000 Fast Ethernet driver for Linux.
3 * Copyright (C) 1997 Sten Wang
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * (C) Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
17 * Additional updates, Copyright:
18 * Ben Dooks <ben@simtec.co.uk>
19 * Sascha Hauer <s.hauer@pengutronix.de>
22 #include <linux/module.h>
23 #include <linux/ioport.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include <linux/init.h>
27 #include <linux/skbuff.h>
28 #include <linux/spinlock.h>
29 #include <linux/crc32.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/dm9000.h>
33 #include <linux/delay.h>
34 #include <linux/platform_device.h>
35 #include <linux/irq.h>
37 #include <asm/delay.h>
43 /* Board/System/Debug information/definition ---------------- */
45 #define DM9000_PHY 0x40 /* PHY address 0x01 */
47 #define CARDNAME "dm9000"
48 #define DRV_VERSION "1.31"
51 * Transmit timeout, default 5 seconds.
53 static int watchdog = 5000;
54 module_param(watchdog, int, 0400);
55 MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
57 /* DM9000 register address locking.
59 * The DM9000 uses an address register to control where data written
60 * to the data register goes. This means that the address register
61 * must be preserved over interrupts or similar calls.
63 * During interrupt and other critical calls, a spinlock is used to
64 * protect the system, but the calls themselves save the address
65 * in the address register in case they are interrupting another
66 * access to the device.
68 * For general accesses a lock is provided so that calls which are
69 * allowed to sleep are serialised so that the address register does
70 * not need to be saved. This lock also serves to serialise access
71 * to the EEPROM and PHY access registers which are shared between
75 /* The driver supports the original DM9000E, and now the two newer
76 * devices, DM9000A and DM9000B.
80 TYPE_DM9000E, /* original DM9000 */
85 /* Structure/enum declaration ------------------------------- */
86 typedef struct board_info {
88 void __iomem *io_addr; /* Register I/O base address */
89 void __iomem *io_data; /* Data I/O address */
96 u8 io_mode; /* 0:word, 2:byte */
101 unsigned int in_suspend :1;
104 enum dm9000_type type;
106 void (*inblk)(void __iomem *port, void *data, int length);
107 void (*outblk)(void __iomem *port, void *data, int length);
108 void (*dumpblk)(void __iomem *port, int length);
110 struct device *dev; /* parent device */
112 struct resource *addr_res; /* resources found */
113 struct resource *data_res;
114 struct resource *addr_req; /* resources requested */
115 struct resource *data_req;
116 struct resource *irq_res;
118 struct mutex addr_lock; /* phy and eeprom access lock */
120 struct delayed_work phy_poll;
121 struct net_device *ndev;
125 struct mii_if_info mii;
131 #define dm9000_dbg(db, lev, msg...) do { \
132 if ((lev) < CONFIG_DM9000_DEBUGLEVEL && \
133 (lev) < db->debug_level) { \
134 dev_dbg(db->dev, msg); \
138 static inline board_info_t *to_dm9000_board(struct net_device *dev)
140 return netdev_priv(dev);
143 /* DM9000 network board routine ---------------------------- */
146 dm9000_reset(board_info_t * db)
148 dev_dbg(db->dev, "resetting device\n");
151 writeb(DM9000_NCR, db->io_addr);
153 writeb(NCR_RST, db->io_data);
158 * Read a byte from I/O port
161 ior(board_info_t * db, int reg)
163 writeb(reg, db->io_addr);
164 return readb(db->io_data);
168 * Write a byte to I/O port
172 iow(board_info_t * db, int reg, int value)
174 writeb(reg, db->io_addr);
175 writeb(value, db->io_data);
178 /* routines for sending block to chip */
180 static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
182 writesb(reg, data, count);
185 static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
187 writesw(reg, data, (count+1) >> 1);
190 static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
192 writesl(reg, data, (count+3) >> 2);
195 /* input block from chip to memory */
197 static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
199 readsb(reg, data, count);
203 static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
205 readsw(reg, data, (count+1) >> 1);
208 static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
210 readsl(reg, data, (count+3) >> 2);
213 /* dump block from chip to null */
215 static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
220 for (i = 0; i < count; i++)
224 static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
229 count = (count + 1) >> 1;
231 for (i = 0; i < count; i++)
235 static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
240 count = (count + 3) >> 2;
242 for (i = 0; i < count; i++)
248 * select the specified set of io routines to use with the
252 static void dm9000_set_io(struct board_info *db, int byte_width)
254 /* use the size of the data resource to work out what IO
255 * routines we want to use
258 switch (byte_width) {
260 db->dumpblk = dm9000_dumpblk_8bit;
261 db->outblk = dm9000_outblk_8bit;
262 db->inblk = dm9000_inblk_8bit;
267 dev_dbg(db->dev, ": 3 byte IO, falling back to 16bit\n");
269 db->dumpblk = dm9000_dumpblk_16bit;
270 db->outblk = dm9000_outblk_16bit;
271 db->inblk = dm9000_inblk_16bit;
276 db->dumpblk = dm9000_dumpblk_32bit;
277 db->outblk = dm9000_outblk_32bit;
278 db->inblk = dm9000_inblk_32bit;
283 static void dm9000_schedule_poll(board_info_t *db)
285 if (db->type == TYPE_DM9000E)
286 schedule_delayed_work(&db->phy_poll, HZ * 2);
289 static int dm9000_ioctl(struct net_device *dev, struct ifreq *req, int cmd)
291 board_info_t *dm = to_dm9000_board(dev);
293 if (!netif_running(dev))
296 return generic_mii_ioctl(&dm->mii, if_mii(req), cmd, NULL);
300 dm9000_read_locked(board_info_t *db, int reg)
305 spin_lock_irqsave(&db->lock, flags);
307 spin_unlock_irqrestore(&db->lock, flags);
312 static int dm9000_wait_eeprom(board_info_t *db)
315 int timeout = 8; /* wait max 8msec */
317 /* The DM9000 data sheets say we should be able to
318 * poll the ERRE bit in EPCR to wait for the EEPROM
319 * operation. From testing several chips, this bit
320 * does not seem to work.
322 * We attempt to use the bit, but fall back to the
323 * timeout (which is why we do not return an error
324 * on expiry) to say that the EEPROM operation has
329 status = dm9000_read_locked(db, DM9000_EPCR);
331 if ((status & EPCR_ERRE) == 0)
337 dev_dbg(db->dev, "timeout waiting EEPROM\n");
346 * Read a word data from EEPROM
349 dm9000_read_eeprom(board_info_t *db, int offset, u8 *to)
353 if (db->flags & DM9000_PLATF_NO_EEPROM) {
359 mutex_lock(&db->addr_lock);
361 spin_lock_irqsave(&db->lock, flags);
363 iow(db, DM9000_EPAR, offset);
364 iow(db, DM9000_EPCR, EPCR_ERPRR);
366 spin_unlock_irqrestore(&db->lock, flags);
368 dm9000_wait_eeprom(db);
370 /* delay for at-least 150uS */
373 spin_lock_irqsave(&db->lock, flags);
375 iow(db, DM9000_EPCR, 0x0);
377 to[0] = ior(db, DM9000_EPDRL);
378 to[1] = ior(db, DM9000_EPDRH);
380 spin_unlock_irqrestore(&db->lock, flags);
382 mutex_unlock(&db->addr_lock);
386 * Write a word data to SROM
389 dm9000_write_eeprom(board_info_t *db, int offset, u8 *data)
393 if (db->flags & DM9000_PLATF_NO_EEPROM)
396 mutex_lock(&db->addr_lock);
398 spin_lock_irqsave(&db->lock, flags);
399 iow(db, DM9000_EPAR, offset);
400 iow(db, DM9000_EPDRH, data[1]);
401 iow(db, DM9000_EPDRL, data[0]);
402 iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
403 spin_unlock_irqrestore(&db->lock, flags);
405 dm9000_wait_eeprom(db);
407 mdelay(1); /* wait at least 150uS to clear */
409 spin_lock_irqsave(&db->lock, flags);
410 iow(db, DM9000_EPCR, 0);
411 spin_unlock_irqrestore(&db->lock, flags);
413 mutex_unlock(&db->addr_lock);
418 static void dm9000_get_drvinfo(struct net_device *dev,
419 struct ethtool_drvinfo *info)
421 board_info_t *dm = to_dm9000_board(dev);
423 strcpy(info->driver, CARDNAME);
424 strcpy(info->version, DRV_VERSION);
425 strcpy(info->bus_info, to_platform_device(dm->dev)->name);
428 static u32 dm9000_get_msglevel(struct net_device *dev)
430 board_info_t *dm = to_dm9000_board(dev);
432 return dm->msg_enable;
435 static void dm9000_set_msglevel(struct net_device *dev, u32 value)
437 board_info_t *dm = to_dm9000_board(dev);
439 dm->msg_enable = value;
442 static int dm9000_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
444 board_info_t *dm = to_dm9000_board(dev);
446 mii_ethtool_gset(&dm->mii, cmd);
450 static int dm9000_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
452 board_info_t *dm = to_dm9000_board(dev);
454 return mii_ethtool_sset(&dm->mii, cmd);
457 static int dm9000_nway_reset(struct net_device *dev)
459 board_info_t *dm = to_dm9000_board(dev);
460 return mii_nway_restart(&dm->mii);
463 static u32 dm9000_get_link(struct net_device *dev)
465 board_info_t *dm = to_dm9000_board(dev);
468 if (dm->flags & DM9000_PLATF_EXT_PHY)
469 ret = mii_link_ok(&dm->mii);
471 ret = dm9000_read_locked(dm, DM9000_NSR) & NSR_LINKST ? 1 : 0;
476 #define DM_EEPROM_MAGIC (0x444D394B)
478 static int dm9000_get_eeprom_len(struct net_device *dev)
483 static int dm9000_get_eeprom(struct net_device *dev,
484 struct ethtool_eeprom *ee, u8 *data)
486 board_info_t *dm = to_dm9000_board(dev);
487 int offset = ee->offset;
491 /* EEPROM access is aligned to two bytes */
493 if ((len & 1) != 0 || (offset & 1) != 0)
496 if (dm->flags & DM9000_PLATF_NO_EEPROM)
499 ee->magic = DM_EEPROM_MAGIC;
501 for (i = 0; i < len; i += 2)
502 dm9000_read_eeprom(dm, (offset + i) / 2, data + i);
507 static int dm9000_set_eeprom(struct net_device *dev,
508 struct ethtool_eeprom *ee, u8 *data)
510 board_info_t *dm = to_dm9000_board(dev);
511 int offset = ee->offset;
515 /* EEPROM access is aligned to two bytes */
517 if ((len & 1) != 0 || (offset & 1) != 0)
520 if (dm->flags & DM9000_PLATF_NO_EEPROM)
523 if (ee->magic != DM_EEPROM_MAGIC)
526 for (i = 0; i < len; i += 2)
527 dm9000_write_eeprom(dm, (offset + i) / 2, data + i);
532 static const struct ethtool_ops dm9000_ethtool_ops = {
533 .get_drvinfo = dm9000_get_drvinfo,
534 .get_settings = dm9000_get_settings,
535 .set_settings = dm9000_set_settings,
536 .get_msglevel = dm9000_get_msglevel,
537 .set_msglevel = dm9000_set_msglevel,
538 .nway_reset = dm9000_nway_reset,
539 .get_link = dm9000_get_link,
540 .get_eeprom_len = dm9000_get_eeprom_len,
541 .get_eeprom = dm9000_get_eeprom,
542 .set_eeprom = dm9000_set_eeprom,
545 static void dm9000_show_carrier(board_info_t *db,
546 unsigned carrier, unsigned nsr)
548 struct net_device *ndev = db->ndev;
549 unsigned ncr = dm9000_read_locked(db, DM9000_NCR);
552 dev_info(db->dev, "%s: link up, %dMbps, %s-duplex, no LPA\n",
553 ndev->name, (nsr & NSR_SPEED) ? 10 : 100,
554 (ncr & NCR_FDX) ? "full" : "half");
556 dev_info(db->dev, "%s: link down\n", ndev->name);
560 dm9000_poll_work(struct work_struct *w)
562 struct delayed_work *dw = to_delayed_work(w);
563 board_info_t *db = container_of(dw, board_info_t, phy_poll);
564 struct net_device *ndev = db->ndev;
566 if (db->flags & DM9000_PLATF_SIMPLE_PHY &&
567 !(db->flags & DM9000_PLATF_EXT_PHY)) {
568 unsigned nsr = dm9000_read_locked(db, DM9000_NSR);
569 unsigned old_carrier = netif_carrier_ok(ndev) ? 1 : 0;
570 unsigned new_carrier;
572 new_carrier = (nsr & NSR_LINKST) ? 1 : 0;
574 if (old_carrier != new_carrier) {
575 if (netif_msg_link(db))
576 dm9000_show_carrier(db, new_carrier, nsr);
579 netif_carrier_off(ndev);
581 netif_carrier_on(ndev);
584 mii_check_media(&db->mii, netif_msg_link(db), 0);
586 if (netif_running(ndev))
587 dm9000_schedule_poll(db);
590 /* dm9000_release_board
592 * release a board, and any mapped resources
596 dm9000_release_board(struct platform_device *pdev, struct board_info *db)
598 /* unmap our resources */
600 iounmap(db->io_addr);
601 iounmap(db->io_data);
603 /* release the resources */
605 release_resource(db->data_req);
608 release_resource(db->addr_req);
612 static unsigned char dm9000_type_to_char(enum dm9000_type type)
615 case TYPE_DM9000E: return 'e';
616 case TYPE_DM9000A: return 'a';
617 case TYPE_DM9000B: return 'b';
624 * Set DM9000 multicast address
627 dm9000_hash_table(struct net_device *dev)
629 board_info_t *db = netdev_priv(dev);
630 struct dev_mc_list *mcptr = dev->mc_list;
631 int mc_cnt = dev->mc_count;
635 u8 rcr = RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN;
638 dm9000_dbg(db, 1, "entering %s\n", __func__);
640 spin_lock_irqsave(&db->lock, flags);
642 for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
643 iow(db, oft, dev->dev_addr[i]);
645 /* Clear Hash Table */
646 for (i = 0; i < 4; i++)
649 /* broadcast address */
650 hash_table[3] = 0x8000;
652 if (dev->flags & IFF_PROMISC)
655 if (dev->flags & IFF_ALLMULTI)
658 /* the multicast address in Hash Table : 64 bits */
659 for (i = 0; i < mc_cnt; i++, mcptr = mcptr->next) {
660 hash_val = ether_crc_le(6, mcptr->dmi_addr) & 0x3f;
661 hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
664 /* Write the hash table to MAC MD table */
665 for (i = 0, oft = DM9000_MAR; i < 4; i++) {
666 iow(db, oft++, hash_table[i]);
667 iow(db, oft++, hash_table[i] >> 8);
670 iow(db, DM9000_RCR, rcr);
671 spin_unlock_irqrestore(&db->lock, flags);
675 * Initilize dm9000 board
678 dm9000_init_dm9000(struct net_device *dev)
680 board_info_t *db = netdev_priv(dev);
683 dm9000_dbg(db, 1, "entering %s\n", __func__);
686 db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
688 /* GPIO0 on pre-activate PHY */
689 iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
690 iow(db, DM9000_GPCR, GPCR_GEP_CNTL); /* Let GPIO0 output */
691 iow(db, DM9000_GPR, 0); /* Enable PHY */
693 if (db->flags & DM9000_PLATF_EXT_PHY)
694 iow(db, DM9000_NCR, NCR_EXT_PHY);
696 /* Program operating register */
697 iow(db, DM9000_TCR, 0); /* TX Polling clear */
698 iow(db, DM9000_BPTR, 0x3f); /* Less 3Kb, 200us */
699 iow(db, DM9000_FCR, 0xff); /* Flow Control */
700 iow(db, DM9000_SMCR, 0); /* Special Mode */
701 /* clear TX status */
702 iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
703 iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
705 /* Set address filter table */
706 dm9000_hash_table(dev);
708 imr = IMR_PAR | IMR_PTM | IMR_PRM;
709 if (db->type != TYPE_DM9000E)
714 /* Enable TX/RX interrupt mask */
715 iow(db, DM9000_IMR, imr);
717 /* Init Driver variable */
719 db->queue_pkt_len = 0;
720 dev->trans_start = 0;
723 /* Our watchdog timed out. Called by the networking layer */
724 static void dm9000_timeout(struct net_device *dev)
726 board_info_t *db = netdev_priv(dev);
730 /* Save previous register address */
731 reg_save = readb(db->io_addr);
732 spin_lock_irqsave(&db->lock, flags);
734 netif_stop_queue(dev);
736 dm9000_init_dm9000(dev);
737 /* We can accept TX packets again */
738 dev->trans_start = jiffies;
739 netif_wake_queue(dev);
741 /* Restore previous register address */
742 writeb(reg_save, db->io_addr);
743 spin_unlock_irqrestore(&db->lock, flags);
747 * Hardware start transmission.
748 * Send a packet to media from the upper layer.
751 dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
754 board_info_t *db = netdev_priv(dev);
756 dm9000_dbg(db, 3, "%s:\n", __func__);
758 if (db->tx_pkt_cnt > 1)
759 return NETDEV_TX_BUSY;
761 spin_lock_irqsave(&db->lock, flags);
763 /* Move data to DM9000 TX RAM */
764 writeb(DM9000_MWCMD, db->io_addr);
766 (db->outblk)(db->io_data, skb->data, skb->len);
767 dev->stats.tx_bytes += skb->len;
770 /* TX control: First packet immediately send, second packet queue */
771 if (db->tx_pkt_cnt == 1) {
772 /* Set TX length to DM9000 */
773 iow(db, DM9000_TXPLL, skb->len);
774 iow(db, DM9000_TXPLH, skb->len >> 8);
776 /* Issue TX polling command */
777 iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
779 dev->trans_start = jiffies; /* save the time stamp */
782 db->queue_pkt_len = skb->len;
783 netif_stop_queue(dev);
786 spin_unlock_irqrestore(&db->lock, flags);
795 * DM9000 interrupt handler
796 * receive the packet to upper layer, free the transmitted packet
799 static void dm9000_tx_done(struct net_device *dev, board_info_t *db)
801 int tx_status = ior(db, DM9000_NSR); /* Got TX status */
803 if (tx_status & (NSR_TX2END | NSR_TX1END)) {
804 /* One packet sent complete */
806 dev->stats.tx_packets++;
808 if (netif_msg_tx_done(db))
809 dev_dbg(db->dev, "tx done, NSR %02x\n", tx_status);
811 /* Queue packet check & send */
812 if (db->tx_pkt_cnt > 0) {
813 iow(db, DM9000_TXPLL, db->queue_pkt_len);
814 iow(db, DM9000_TXPLH, db->queue_pkt_len >> 8);
815 iow(db, DM9000_TCR, TCR_TXREQ);
816 dev->trans_start = jiffies;
818 netif_wake_queue(dev);
822 struct dm9000_rxhdr {
826 } __attribute__((__packed__));
829 * Received a packet and pass to upper layer
832 dm9000_rx(struct net_device *dev)
834 board_info_t *db = netdev_priv(dev);
835 struct dm9000_rxhdr rxhdr;
841 /* Check packet ready or not */
843 ior(db, DM9000_MRCMDX); /* Dummy read */
845 /* Get most updated data */
846 rxbyte = readb(db->io_data);
848 /* Status check: this byte must be 0 or 1 */
849 if (rxbyte > DM9000_PKT_RDY) {
850 dev_warn(db->dev, "status check fail: %d\n", rxbyte);
851 iow(db, DM9000_RCR, 0x00); /* Stop Device */
852 iow(db, DM9000_ISR, IMR_PAR); /* Stop INT request */
856 if (rxbyte != DM9000_PKT_RDY)
859 /* A packet ready now & Get status/length */
861 writeb(DM9000_MRCMD, db->io_addr);
863 (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
865 RxLen = le16_to_cpu(rxhdr.RxLen);
867 if (netif_msg_rx_status(db))
868 dev_dbg(db->dev, "RX: status %02x, length %04x\n",
869 rxhdr.RxStatus, RxLen);
871 /* Packet Status check */
874 if (netif_msg_rx_err(db))
875 dev_dbg(db->dev, "RX: Bad Packet (runt)\n");
878 if (RxLen > DM9000_PKT_MAX) {
879 dev_dbg(db->dev, "RST: RX Len:%x\n", RxLen);
882 /* rxhdr.RxStatus is identical to RSR register. */
883 if (rxhdr.RxStatus & (RSR_FOE | RSR_CE | RSR_AE |
887 if (rxhdr.RxStatus & RSR_FOE) {
888 if (netif_msg_rx_err(db))
889 dev_dbg(db->dev, "fifo error\n");
890 dev->stats.rx_fifo_errors++;
892 if (rxhdr.RxStatus & RSR_CE) {
893 if (netif_msg_rx_err(db))
894 dev_dbg(db->dev, "crc error\n");
895 dev->stats.rx_crc_errors++;
897 if (rxhdr.RxStatus & RSR_RF) {
898 if (netif_msg_rx_err(db))
899 dev_dbg(db->dev, "length error\n");
900 dev->stats.rx_length_errors++;
904 /* Move data from DM9000 */
906 && ((skb = dev_alloc_skb(RxLen + 4)) != NULL)) {
908 rdptr = (u8 *) skb_put(skb, RxLen - 4);
910 /* Read received packet from RX SRAM */
912 (db->inblk)(db->io_data, rdptr, RxLen);
913 dev->stats.rx_bytes += RxLen;
915 /* Pass to upper layer */
916 skb->protocol = eth_type_trans(skb, dev);
918 dev->stats.rx_packets++;
921 /* need to dump the packet's data */
923 (db->dumpblk)(db->io_data, RxLen);
925 } while (rxbyte == DM9000_PKT_RDY);
928 static irqreturn_t dm9000_interrupt(int irq, void *dev_id)
930 struct net_device *dev = dev_id;
931 board_info_t *db = netdev_priv(dev);
936 dm9000_dbg(db, 3, "entering %s\n", __func__);
938 /* A real interrupt coming */
940 /* holders of db->lock must always block IRQs */
941 spin_lock_irqsave(&db->lock, flags);
943 /* Save previous register address */
944 reg_save = readb(db->io_addr);
946 /* Disable all interrupts */
947 iow(db, DM9000_IMR, IMR_PAR);
949 /* Got DM9000 interrupt status */
950 int_status = ior(db, DM9000_ISR); /* Got ISR */
951 iow(db, DM9000_ISR, int_status); /* Clear ISR status */
953 if (netif_msg_intr(db))
954 dev_dbg(db->dev, "interrupt status %02x\n", int_status);
956 /* Received the coming packet */
957 if (int_status & ISR_PRS)
960 /* Trnasmit Interrupt check */
961 if (int_status & ISR_PTS)
962 dm9000_tx_done(dev, db);
964 if (db->type != TYPE_DM9000E) {
965 if (int_status & ISR_LNKCHNG) {
966 /* fire a link-change request */
967 schedule_delayed_work(&db->phy_poll, 1);
971 /* Re-enable interrupt mask */
972 iow(db, DM9000_IMR, db->imr_all);
974 /* Restore previous register address */
975 writeb(reg_save, db->io_addr);
977 spin_unlock_irqrestore(&db->lock, flags);
982 #ifdef CONFIG_NET_POLL_CONTROLLER
986 static void dm9000_poll_controller(struct net_device *dev)
988 disable_irq(dev->irq);
989 dm9000_interrupt(dev->irq, dev);
990 enable_irq(dev->irq);
995 * Open the interface.
996 * The interface is opened whenever "ifconfig" actives it.
999 dm9000_open(struct net_device *dev)
1001 board_info_t *db = netdev_priv(dev);
1002 unsigned long irqflags = db->irq_res->flags & IRQF_TRIGGER_MASK;
1004 if (netif_msg_ifup(db))
1005 dev_dbg(db->dev, "enabling %s\n", dev->name);
1007 /* If there is no IRQ type specified, default to something that
1008 * may work, and tell the user that this is a problem */
1010 if (irqflags == IRQF_TRIGGER_NONE)
1011 dev_warn(db->dev, "WARNING: no IRQ resource flags set.\n");
1013 irqflags |= IRQF_SHARED;
1015 if (request_irq(dev->irq, &dm9000_interrupt, irqflags, dev->name, dev))
1018 /* Initialize DM9000 board */
1020 dm9000_init_dm9000(dev);
1022 /* Init driver variable */
1025 mii_check_media(&db->mii, netif_msg_link(db), 1);
1026 netif_start_queue(dev);
1028 dm9000_schedule_poll(db);
1034 * Sleep, either by using msleep() or if we are suspending, then
1035 * use mdelay() to sleep.
1037 static void dm9000_msleep(board_info_t *db, unsigned int ms)
1046 * Read a word from phyxcer
1049 dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
1051 board_info_t *db = netdev_priv(dev);
1052 unsigned long flags;
1053 unsigned int reg_save;
1056 mutex_lock(&db->addr_lock);
1058 spin_lock_irqsave(&db->lock,flags);
1060 /* Save previous register address */
1061 reg_save = readb(db->io_addr);
1063 /* Fill the phyxcer register into REG_0C */
1064 iow(db, DM9000_EPAR, DM9000_PHY | reg);
1066 iow(db, DM9000_EPCR, EPCR_ERPRR | EPCR_EPOS); /* Issue phyxcer read command */
1068 writeb(reg_save, db->io_addr);
1069 spin_unlock_irqrestore(&db->lock,flags);
1071 dm9000_msleep(db, 1); /* Wait read complete */
1073 spin_lock_irqsave(&db->lock,flags);
1074 reg_save = readb(db->io_addr);
1076 iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer read command */
1078 /* The read data keeps on REG_0D & REG_0E */
1079 ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
1081 /* restore the previous address */
1082 writeb(reg_save, db->io_addr);
1083 spin_unlock_irqrestore(&db->lock,flags);
1085 mutex_unlock(&db->addr_lock);
1087 dm9000_dbg(db, 5, "phy_read[%02x] -> %04x\n", reg, ret);
1092 * Write a word to phyxcer
1095 dm9000_phy_write(struct net_device *dev,
1096 int phyaddr_unused, int reg, int value)
1098 board_info_t *db = netdev_priv(dev);
1099 unsigned long flags;
1100 unsigned long reg_save;
1102 dm9000_dbg(db, 5, "phy_write[%02x] = %04x\n", reg, value);
1103 mutex_lock(&db->addr_lock);
1105 spin_lock_irqsave(&db->lock,flags);
1107 /* Save previous register address */
1108 reg_save = readb(db->io_addr);
1110 /* Fill the phyxcer register into REG_0C */
1111 iow(db, DM9000_EPAR, DM9000_PHY | reg);
1113 /* Fill the written data into REG_0D & REG_0E */
1114 iow(db, DM9000_EPDRL, value);
1115 iow(db, DM9000_EPDRH, value >> 8);
1117 iow(db, DM9000_EPCR, EPCR_EPOS | EPCR_ERPRW); /* Issue phyxcer write command */
1119 writeb(reg_save, db->io_addr);
1120 spin_unlock_irqrestore(&db->lock, flags);
1122 dm9000_msleep(db, 1); /* Wait write complete */
1124 spin_lock_irqsave(&db->lock,flags);
1125 reg_save = readb(db->io_addr);
1127 iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer write command */
1129 /* restore the previous address */
1130 writeb(reg_save, db->io_addr);
1132 spin_unlock_irqrestore(&db->lock, flags);
1133 mutex_unlock(&db->addr_lock);
1137 dm9000_shutdown(struct net_device *dev)
1139 board_info_t *db = netdev_priv(dev);
1142 dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
1143 iow(db, DM9000_GPR, 0x01); /* Power-Down PHY */
1144 iow(db, DM9000_IMR, IMR_PAR); /* Disable all interrupt */
1145 iow(db, DM9000_RCR, 0x00); /* Disable RX */
1149 * Stop the interface.
1150 * The interface is stopped when it is brought.
1153 dm9000_stop(struct net_device *ndev)
1155 board_info_t *db = netdev_priv(ndev);
1157 if (netif_msg_ifdown(db))
1158 dev_dbg(db->dev, "shutting down %s\n", ndev->name);
1160 cancel_delayed_work_sync(&db->phy_poll);
1162 netif_stop_queue(ndev);
1163 netif_carrier_off(ndev);
1165 /* free interrupt */
1166 free_irq(ndev->irq, ndev);
1168 dm9000_shutdown(ndev);
1173 static const struct net_device_ops dm9000_netdev_ops = {
1174 .ndo_open = dm9000_open,
1175 .ndo_stop = dm9000_stop,
1176 .ndo_start_xmit = dm9000_start_xmit,
1177 .ndo_tx_timeout = dm9000_timeout,
1178 .ndo_set_multicast_list = dm9000_hash_table,
1179 .ndo_do_ioctl = dm9000_ioctl,
1180 .ndo_change_mtu = eth_change_mtu,
1181 .ndo_validate_addr = eth_validate_addr,
1182 .ndo_set_mac_address = eth_mac_addr,
1183 #ifdef CONFIG_NET_POLL_CONTROLLER
1184 .ndo_poll_controller = dm9000_poll_controller,
1188 #define res_size(_r) (((_r)->end - (_r)->start) + 1)
1191 * Search DM9000 board, allocate space and register it
1193 static int __devinit
1194 dm9000_probe(struct platform_device *pdev)
1196 struct dm9000_plat_data *pdata = pdev->dev.platform_data;
1197 struct board_info *db; /* Point a board information structure */
1198 struct net_device *ndev;
1199 const unsigned char *mac_src;
1205 /* Init network device */
1206 ndev = alloc_etherdev(sizeof(struct board_info));
1208 dev_err(&pdev->dev, "could not allocate device.\n");
1212 SET_NETDEV_DEV(ndev, &pdev->dev);
1214 dev_dbg(&pdev->dev, "dm9000_probe()\n");
1216 /* setup board info structure */
1217 db = netdev_priv(ndev);
1218 memset(db, 0, sizeof(*db));
1220 db->dev = &pdev->dev;
1223 spin_lock_init(&db->lock);
1224 mutex_init(&db->addr_lock);
1226 INIT_DELAYED_WORK(&db->phy_poll, dm9000_poll_work);
1228 db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1229 db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1230 db->irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1232 if (db->addr_res == NULL || db->data_res == NULL ||
1233 db->irq_res == NULL) {
1234 dev_err(db->dev, "insufficient resources\n");
1239 iosize = res_size(db->addr_res);
1240 db->addr_req = request_mem_region(db->addr_res->start, iosize,
1243 if (db->addr_req == NULL) {
1244 dev_err(db->dev, "cannot claim address reg area\n");
1249 db->io_addr = ioremap(db->addr_res->start, iosize);
1251 if (db->io_addr == NULL) {
1252 dev_err(db->dev, "failed to ioremap address reg\n");
1257 iosize = res_size(db->data_res);
1258 db->data_req = request_mem_region(db->data_res->start, iosize,
1261 if (db->data_req == NULL) {
1262 dev_err(db->dev, "cannot claim data reg area\n");
1267 db->io_data = ioremap(db->data_res->start, iosize);
1269 if (db->io_data == NULL) {
1270 dev_err(db->dev, "failed to ioremap data reg\n");
1275 /* fill in parameters for net-dev structure */
1276 ndev->base_addr = (unsigned long)db->io_addr;
1277 ndev->irq = db->irq_res->start;
1279 /* ensure at least we have a default set of IO routines */
1280 dm9000_set_io(db, iosize);
1282 /* check to see if anything is being over-ridden */
1283 if (pdata != NULL) {
1284 /* check to see if the driver wants to over-ride the
1285 * default IO width */
1287 if (pdata->flags & DM9000_PLATF_8BITONLY)
1288 dm9000_set_io(db, 1);
1290 if (pdata->flags & DM9000_PLATF_16BITONLY)
1291 dm9000_set_io(db, 2);
1293 if (pdata->flags & DM9000_PLATF_32BITONLY)
1294 dm9000_set_io(db, 4);
1296 /* check to see if there are any IO routine
1299 if (pdata->inblk != NULL)
1300 db->inblk = pdata->inblk;
1302 if (pdata->outblk != NULL)
1303 db->outblk = pdata->outblk;
1305 if (pdata->dumpblk != NULL)
1306 db->dumpblk = pdata->dumpblk;
1308 db->flags = pdata->flags;
1311 #ifdef CONFIG_DM9000_FORCE_SIMPLE_PHY_POLL
1312 db->flags |= DM9000_PLATF_SIMPLE_PHY;
1317 /* try multiple times, DM9000 sometimes gets the read wrong */
1318 for (i = 0; i < 8; i++) {
1319 id_val = ior(db, DM9000_VIDL);
1320 id_val |= (u32)ior(db, DM9000_VIDH) << 8;
1321 id_val |= (u32)ior(db, DM9000_PIDL) << 16;
1322 id_val |= (u32)ior(db, DM9000_PIDH) << 24;
1324 if (id_val == DM9000_ID)
1326 dev_err(db->dev, "read wrong id 0x%08x\n", id_val);
1329 if (id_val != DM9000_ID) {
1330 dev_err(db->dev, "wrong id: 0x%08x\n", id_val);
1335 /* Identify what type of DM9000 we are working on */
1337 id_val = ior(db, DM9000_CHIPR);
1338 dev_dbg(db->dev, "dm9000 revision 0x%02x\n", id_val);
1342 db->type = TYPE_DM9000A;
1345 db->type = TYPE_DM9000B;
1348 dev_dbg(db->dev, "ID %02x => defaulting to DM9000E\n", id_val);
1349 db->type = TYPE_DM9000E;
1352 /* from this point we assume that we have found a DM9000 */
1354 /* driver system function */
1357 ndev->netdev_ops = &dm9000_netdev_ops;
1358 ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
1359 ndev->ethtool_ops = &dm9000_ethtool_ops;
1361 db->msg_enable = NETIF_MSG_LINK;
1362 db->mii.phy_id_mask = 0x1f;
1363 db->mii.reg_num_mask = 0x1f;
1364 db->mii.force_media = 0;
1365 db->mii.full_duplex = 0;
1367 db->mii.mdio_read = dm9000_phy_read;
1368 db->mii.mdio_write = dm9000_phy_write;
1372 /* try reading the node address from the attached EEPROM */
1373 for (i = 0; i < 6; i += 2)
1374 dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);
1376 if (!is_valid_ether_addr(ndev->dev_addr) && pdata != NULL) {
1377 mac_src = "platform data";
1378 memcpy(ndev->dev_addr, pdata->dev_addr, 6);
1381 if (!is_valid_ether_addr(ndev->dev_addr)) {
1382 /* try reading from mac */
1385 for (i = 0; i < 6; i++)
1386 ndev->dev_addr[i] = ior(db, i+DM9000_PAR);
1389 if (!is_valid_ether_addr(ndev->dev_addr))
1390 dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
1391 "set using ifconfig\n", ndev->name);
1393 platform_set_drvdata(pdev, ndev);
1394 ret = register_netdev(ndev);
1397 printk(KERN_INFO "%s: dm9000%c at %p,%p IRQ %d MAC: %pM (%s)\n",
1398 ndev->name, dm9000_type_to_char(db->type),
1399 db->io_addr, db->io_data, ndev->irq,
1400 ndev->dev_addr, mac_src);
1404 dev_err(db->dev, "not found (%d).\n", ret);
1406 dm9000_release_board(pdev, db);
1413 dm9000_drv_suspend(struct platform_device *dev, pm_message_t state)
1415 struct net_device *ndev = platform_get_drvdata(dev);
1419 db = netdev_priv(ndev);
1422 if (netif_running(ndev)) {
1423 netif_device_detach(ndev);
1424 dm9000_shutdown(ndev);
1431 dm9000_drv_resume(struct platform_device *dev)
1433 struct net_device *ndev = platform_get_drvdata(dev);
1434 board_info_t *db = netdev_priv(ndev);
1438 if (netif_running(ndev)) {
1440 dm9000_init_dm9000(ndev);
1442 netif_device_attach(ndev);
1450 static int __devexit
1451 dm9000_drv_remove(struct platform_device *pdev)
1453 struct net_device *ndev = platform_get_drvdata(pdev);
1455 platform_set_drvdata(pdev, NULL);
1457 unregister_netdev(ndev);
1458 dm9000_release_board(pdev, (board_info_t *) netdev_priv(ndev));
1459 free_netdev(ndev); /* free device structure */
1461 dev_dbg(&pdev->dev, "released and freed device\n");
1465 static struct platform_driver dm9000_driver = {
1468 .owner = THIS_MODULE,
1470 .probe = dm9000_probe,
1471 .remove = __devexit_p(dm9000_drv_remove),
1472 .suspend = dm9000_drv_suspend,
1473 .resume = dm9000_drv_resume,
1479 printk(KERN_INFO "%s Ethernet Driver, V%s\n", CARDNAME, DRV_VERSION);
1481 return platform_driver_register(&dm9000_driver);
1485 dm9000_cleanup(void)
1487 platform_driver_unregister(&dm9000_driver);
1490 module_init(dm9000_init);
1491 module_exit(dm9000_cleanup);
1493 MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1494 MODULE_DESCRIPTION("Davicom DM9000 network driver");
1495 MODULE_LICENSE("GPL");
1496 MODULE_ALIAS("platform:dm9000");