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 PFX CARDNAME ": "
49 #define DRV_VERSION "1.30"
51 #ifdef CONFIG_BLACKFIN
58 #define DEFAULT_TRIGGER IRQF_TRIGGER_HIGH
60 #define DEFAULT_TRIGGER (0)
64 * Transmit timeout, default 5 seconds.
66 static int watchdog = 5000;
67 module_param(watchdog, int, 0400);
68 MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
70 /* DM9000 register address locking.
72 * The DM9000 uses an address register to control where data written
73 * to the data register goes. This means that the address register
74 * must be preserved over interrupts or similar calls.
76 * During interrupt and other critical calls, a spinlock is used to
77 * protect the system, but the calls themselves save the address
78 * in the address register in case they are interrupting another
79 * access to the device.
81 * For general accesses a lock is provided so that calls which are
82 * allowed to sleep are serialised so that the address register does
83 * not need to be saved. This lock also serves to serialise access
84 * to the EEPROM and PHY access registers which are shared between
88 /* Structure/enum declaration ------------------------------- */
89 typedef struct board_info {
91 void __iomem *io_addr; /* Register I/O base address */
92 void __iomem *io_data; /* Data I/O address */
99 u8 io_mode; /* 0:word, 2:byte */
102 unsigned int in_suspend :1;
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 */
122 struct mii_if_info mii;
128 #define dm9000_dbg(db, lev, msg...) do { \
129 if ((lev) < CONFIG_DM9000_DEBUGLEVEL && \
130 (lev) < db->debug_level) { \
131 dev_dbg(db->dev, msg); \
135 static inline board_info_t *to_dm9000_board(struct net_device *dev)
140 /* function declaration ------------------------------------- */
141 static int dm9000_probe(struct platform_device *);
142 static int dm9000_open(struct net_device *);
143 static int dm9000_start_xmit(struct sk_buff *, struct net_device *);
144 static int dm9000_stop(struct net_device *);
145 static int dm9000_ioctl(struct net_device *dev, struct ifreq *req, int cmd);
147 static void dm9000_init_dm9000(struct net_device *);
149 static irqreturn_t dm9000_interrupt(int, void *);
151 static int dm9000_phy_read(struct net_device *dev, int phyaddr_unsused, int reg);
152 static void dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg,
155 static void dm9000_read_eeprom(board_info_t *, int addr, u8 *to);
156 static void dm9000_write_eeprom(board_info_t *, int addr, u8 *dp);
157 static void dm9000_rx(struct net_device *);
158 static void dm9000_hash_table(struct net_device *);
160 /* DM9000 network board routine ---------------------------- */
163 dm9000_reset(board_info_t * db)
165 dev_dbg(db->dev, "resetting device\n");
168 writeb(DM9000_NCR, db->io_addr);
170 writeb(NCR_RST, db->io_data);
175 * Read a byte from I/O port
178 ior(board_info_t * db, int reg)
180 writeb(reg, db->io_addr);
181 return readb(db->io_data);
185 * Write a byte to I/O port
189 iow(board_info_t * db, int reg, int value)
191 writeb(reg, db->io_addr);
192 writeb(value, db->io_data);
195 /* routines for sending block to chip */
197 static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
199 writesb(reg, data, count);
202 static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
204 writesw(reg, data, (count+1) >> 1);
207 static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
209 writesl(reg, data, (count+3) >> 2);
212 /* input block from chip to memory */
214 static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
216 readsb(reg, data, count);
220 static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
222 readsw(reg, data, (count+1) >> 1);
225 static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
227 readsl(reg, data, (count+3) >> 2);
230 /* dump block from chip to null */
232 static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
237 for (i = 0; i < count; i++)
241 static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
246 count = (count + 1) >> 1;
248 for (i = 0; i < count; i++)
252 static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
257 count = (count + 3) >> 2;
259 for (i = 0; i < count; i++)
265 * select the specified set of io routines to use with the
269 static void dm9000_set_io(struct board_info *db, int byte_width)
271 /* use the size of the data resource to work out what IO
272 * routines we want to use
275 switch (byte_width) {
277 db->dumpblk = dm9000_dumpblk_8bit;
278 db->outblk = dm9000_outblk_8bit;
279 db->inblk = dm9000_inblk_8bit;
284 dev_dbg(db->dev, ": 3 byte IO, falling back to 16bit\n");
286 db->dumpblk = dm9000_dumpblk_16bit;
287 db->outblk = dm9000_outblk_16bit;
288 db->inblk = dm9000_inblk_16bit;
293 db->dumpblk = dm9000_dumpblk_32bit;
294 db->outblk = dm9000_outblk_32bit;
295 db->inblk = dm9000_inblk_32bit;
301 /* Our watchdog timed out. Called by the networking layer */
302 static void dm9000_timeout(struct net_device *dev)
304 board_info_t *db = (board_info_t *) dev->priv;
308 /* Save previous register address */
309 reg_save = readb(db->io_addr);
310 spin_lock_irqsave(&db->lock,flags);
312 netif_stop_queue(dev);
314 dm9000_init_dm9000(dev);
315 /* We can accept TX packets again */
316 dev->trans_start = jiffies;
317 netif_wake_queue(dev);
319 /* Restore previous register address */
320 writeb(reg_save, db->io_addr);
321 spin_unlock_irqrestore(&db->lock,flags);
324 #ifdef CONFIG_NET_POLL_CONTROLLER
328 static void dm9000_poll_controller(struct net_device *dev)
330 disable_irq(dev->irq);
331 dm9000_interrupt(dev->irq,dev);
332 enable_irq(dev->irq);
336 static int dm9000_ioctl(struct net_device *dev, struct ifreq *req, int cmd)
338 board_info_t *dm = to_dm9000_board(dev);
340 if (!netif_running(dev))
343 return generic_mii_ioctl(&dm->mii, if_mii(req), cmd, NULL);
348 static void dm9000_get_drvinfo(struct net_device *dev,
349 struct ethtool_drvinfo *info)
351 board_info_t *dm = to_dm9000_board(dev);
353 strcpy(info->driver, CARDNAME);
354 strcpy(info->version, DRV_VERSION);
355 strcpy(info->bus_info, to_platform_device(dm->dev)->name);
358 static u32 dm9000_get_msglevel(struct net_device *dev)
360 board_info_t *dm = to_dm9000_board(dev);
362 return dm->msg_enable;
365 static void dm9000_set_msglevel(struct net_device *dev, u32 value)
367 board_info_t *dm = to_dm9000_board(dev);
369 dm->msg_enable = value;
372 static int dm9000_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
374 board_info_t *dm = to_dm9000_board(dev);
376 mii_ethtool_gset(&dm->mii, cmd);
380 static int dm9000_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
382 board_info_t *dm = to_dm9000_board(dev);
384 return mii_ethtool_sset(&dm->mii, cmd);
387 static int dm9000_nway_reset(struct net_device *dev)
389 board_info_t *dm = to_dm9000_board(dev);
390 return mii_nway_restart(&dm->mii);
393 static u32 dm9000_get_link(struct net_device *dev)
395 board_info_t *dm = to_dm9000_board(dev);
396 return mii_link_ok(&dm->mii);
399 #define DM_EEPROM_MAGIC (0x444D394B)
401 static int dm9000_get_eeprom_len(struct net_device *dev)
406 static int dm9000_get_eeprom(struct net_device *dev,
407 struct ethtool_eeprom *ee, u8 *data)
409 board_info_t *dm = to_dm9000_board(dev);
410 int offset = ee->offset;
414 /* EEPROM access is aligned to two bytes */
416 if ((len & 1) != 0 || (offset & 1) != 0)
419 if (dm->flags & DM9000_PLATF_NO_EEPROM)
422 ee->magic = DM_EEPROM_MAGIC;
424 for (i = 0; i < len; i += 2)
425 dm9000_read_eeprom(dm, (offset + i) / 2, data + i);
430 static int dm9000_set_eeprom(struct net_device *dev,
431 struct ethtool_eeprom *ee, u8 *data)
433 board_info_t *dm = to_dm9000_board(dev);
434 int offset = ee->offset;
438 /* EEPROM access is aligned to two bytes */
440 if ((len & 1) != 0 || (offset & 1) != 0)
443 if (dm->flags & DM9000_PLATF_NO_EEPROM)
446 if (ee->magic != DM_EEPROM_MAGIC)
449 for (i = 0; i < len; i += 2)
450 dm9000_write_eeprom(dm, (offset + i) / 2, data + i);
455 static const struct ethtool_ops dm9000_ethtool_ops = {
456 .get_drvinfo = dm9000_get_drvinfo,
457 .get_settings = dm9000_get_settings,
458 .set_settings = dm9000_set_settings,
459 .get_msglevel = dm9000_get_msglevel,
460 .set_msglevel = dm9000_set_msglevel,
461 .nway_reset = dm9000_nway_reset,
462 .get_link = dm9000_get_link,
463 .get_eeprom_len = dm9000_get_eeprom_len,
464 .get_eeprom = dm9000_get_eeprom,
465 .set_eeprom = dm9000_set_eeprom,
469 /* dm9000_release_board
471 * release a board, and any mapped resources
475 dm9000_release_board(struct platform_device *pdev, struct board_info *db)
477 if (db->data_res == NULL) {
478 if (db->addr_res != NULL)
479 release_mem_region((unsigned long)db->io_addr, 4);
483 /* unmap our resources */
485 iounmap(db->io_addr);
486 iounmap(db->io_data);
488 /* release the resources */
490 if (db->data_req != NULL) {
491 release_resource(db->data_req);
495 if (db->addr_req != NULL) {
496 release_resource(db->addr_req);
501 #define res_size(_r) (((_r)->end - (_r)->start) + 1)
504 * Search DM9000 board, allocate space and register it
507 dm9000_probe(struct platform_device *pdev)
509 struct dm9000_plat_data *pdata = pdev->dev.platform_data;
510 struct board_info *db; /* Point a board information structure */
511 struct net_device *ndev;
518 /* Init network device */
519 ndev = alloc_etherdev(sizeof (struct board_info));
521 dev_err(&pdev->dev, "could not allocate device.\n");
525 SET_NETDEV_DEV(ndev, &pdev->dev);
527 dev_dbg(&pdev->dev, "dm9000_probe()");
529 /* setup board info structure */
530 db = (struct board_info *) ndev->priv;
531 memset(db, 0, sizeof (*db));
533 db->dev = &pdev->dev;
535 spin_lock_init(&db->lock);
536 mutex_init(&db->addr_lock);
538 if (pdev->num_resources < 2) {
541 } else if (pdev->num_resources == 2) {
542 base = pdev->resource[0].start;
544 if (!request_mem_region(base, 4, ndev->name)) {
549 ndev->base_addr = base;
550 ndev->irq = pdev->resource[1].start;
551 db->io_addr = (void __iomem *)base;
552 db->io_data = (void __iomem *)(base + 4);
554 /* ensure at least we have a default set of IO routines */
555 dm9000_set_io(db, 2);
558 db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
559 db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
560 db->irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
562 if (db->addr_res == NULL || db->data_res == NULL ||
563 db->irq_res == NULL) {
564 dev_err(db->dev, "insufficient resources\n");
569 i = res_size(db->addr_res);
570 db->addr_req = request_mem_region(db->addr_res->start, i,
573 if (db->addr_req == NULL) {
574 dev_err(db->dev, "cannot claim address reg area\n");
579 db->io_addr = ioremap(db->addr_res->start, i);
581 if (db->io_addr == NULL) {
582 dev_err(db->dev, "failed to ioremap address reg\n");
587 iosize = res_size(db->data_res);
588 db->data_req = request_mem_region(db->data_res->start, iosize,
591 if (db->data_req == NULL) {
592 dev_err(db->dev, "cannot claim data reg area\n");
597 db->io_data = ioremap(db->data_res->start, iosize);
599 if (db->io_data == NULL) {
600 dev_err(db->dev,"failed to ioremap data reg\n");
605 /* fill in parameters for net-dev structure */
607 ndev->base_addr = (unsigned long)db->io_addr;
608 ndev->irq = db->irq_res->start;
610 /* ensure at least we have a default set of IO routines */
611 dm9000_set_io(db, iosize);
614 /* check to see if anything is being over-ridden */
616 /* check to see if the driver wants to over-ride the
617 * default IO width */
619 if (pdata->flags & DM9000_PLATF_8BITONLY)
620 dm9000_set_io(db, 1);
622 if (pdata->flags & DM9000_PLATF_16BITONLY)
623 dm9000_set_io(db, 2);
625 if (pdata->flags & DM9000_PLATF_32BITONLY)
626 dm9000_set_io(db, 4);
628 /* check to see if there are any IO routine
631 if (pdata->inblk != NULL)
632 db->inblk = pdata->inblk;
634 if (pdata->outblk != NULL)
635 db->outblk = pdata->outblk;
637 if (pdata->dumpblk != NULL)
638 db->dumpblk = pdata->dumpblk;
640 db->flags = pdata->flags;
645 /* try two times, DM9000 sometimes gets the first read wrong */
646 for (i = 0; i < 8; i++) {
647 id_val = ior(db, DM9000_VIDL);
648 id_val |= (u32)ior(db, DM9000_VIDH) << 8;
649 id_val |= (u32)ior(db, DM9000_PIDL) << 16;
650 id_val |= (u32)ior(db, DM9000_PIDH) << 24;
652 if (id_val == DM9000_ID)
654 dev_err(db->dev, "read wrong id 0x%08x\n", id_val);
657 if (id_val != DM9000_ID) {
658 dev_err(db->dev, "wrong id: 0x%08x\n", id_val);
663 /* from this point we assume that we have found a DM9000 */
665 /* driver system function */
668 ndev->open = &dm9000_open;
669 ndev->hard_start_xmit = &dm9000_start_xmit;
670 ndev->tx_timeout = &dm9000_timeout;
671 ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
672 ndev->stop = &dm9000_stop;
673 ndev->set_multicast_list = &dm9000_hash_table;
674 ndev->ethtool_ops = &dm9000_ethtool_ops;
675 ndev->do_ioctl = &dm9000_ioctl;
677 #ifdef CONFIG_NET_POLL_CONTROLLER
678 ndev->poll_controller = &dm9000_poll_controller;
681 db->msg_enable = NETIF_MSG_LINK;
682 db->mii.phy_id_mask = 0x1f;
683 db->mii.reg_num_mask = 0x1f;
684 db->mii.force_media = 0;
685 db->mii.full_duplex = 0;
687 db->mii.mdio_read = dm9000_phy_read;
688 db->mii.mdio_write = dm9000_phy_write;
690 /* try reading the node address from the attached EEPROM */
691 for (i = 0; i < 6; i += 2)
692 dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);
694 if (!is_valid_ether_addr(ndev->dev_addr)) {
695 /* try reading from mac */
697 for (i = 0; i < 6; i++)
698 ndev->dev_addr[i] = ior(db, i+DM9000_PAR);
701 if (!is_valid_ether_addr(ndev->dev_addr))
702 dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
703 "set using ifconfig\n", ndev->name);
705 platform_set_drvdata(pdev, ndev);
706 ret = register_netdev(ndev);
709 DECLARE_MAC_BUF(mac);
710 printk("%s: dm9000 at %p,%p IRQ %d MAC: %s\n",
711 ndev->name, db->io_addr, db->io_data, ndev->irq,
712 print_mac(mac, ndev->dev_addr));
717 dev_err(db->dev, "not found (%d).\n", ret);
719 dm9000_release_board(pdev, db);
726 * Open the interface.
727 * The interface is opened whenever "ifconfig" actives it.
730 dm9000_open(struct net_device *dev)
732 board_info_t *db = (board_info_t *) dev->priv;
733 unsigned long irqflags = db->irq_res->flags & IRQF_TRIGGER_MASK;
735 if (netif_msg_ifup(db))
736 dev_dbg(db->dev, "enabling %s\n", dev->name);
738 /* If there is no IRQ type specified, default to something that
739 * may work, and tell the user that this is a problem */
741 if (irqflags == IRQF_TRIGGER_NONE) {
742 dev_warn(db->dev, "WARNING: no IRQ resource flags set.\n");
743 irqflags = DEFAULT_TRIGGER;
746 irqflags |= IRQF_SHARED;
748 if (request_irq(dev->irq, &dm9000_interrupt, irqflags, dev->name, dev))
751 /* Initialize DM9000 board */
753 dm9000_init_dm9000(dev);
755 /* Init driver variable */
758 mii_check_media(&db->mii, netif_msg_link(db), 1);
759 netif_start_queue(dev);
765 * Initilize dm9000 board
768 dm9000_init_dm9000(struct net_device *dev)
770 board_info_t *db = (board_info_t *) dev->priv;
772 dm9000_dbg(db, 1, "entering %s\n", __func__);
775 db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
777 /* GPIO0 on pre-activate PHY */
778 iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
779 iow(db, DM9000_GPCR, GPCR_GEP_CNTL); /* Let GPIO0 output */
780 iow(db, DM9000_GPR, 0); /* Enable PHY */
782 if (db->flags & DM9000_PLATF_EXT_PHY)
783 iow(db, DM9000_NCR, NCR_EXT_PHY);
785 /* Program operating register */
786 iow(db, DM9000_TCR, 0); /* TX Polling clear */
787 iow(db, DM9000_BPTR, 0x3f); /* Less 3Kb, 200us */
788 iow(db, DM9000_FCR, 0xff); /* Flow Control */
789 iow(db, DM9000_SMCR, 0); /* Special Mode */
790 /* clear TX status */
791 iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
792 iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
794 /* Set address filter table */
795 dm9000_hash_table(dev);
797 /* Activate DM9000 */
798 iow(db, DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);
799 /* Enable TX/RX interrupt mask */
800 iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
802 /* Init Driver variable */
804 db->queue_pkt_len = 0;
805 dev->trans_start = 0;
809 * Hardware start transmission.
810 * Send a packet to media from the upper layer.
813 dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
816 board_info_t *db = (board_info_t *) dev->priv;
818 dm9000_dbg(db, 3, "%s:\n", __func__);
820 if (db->tx_pkt_cnt > 1)
823 spin_lock_irqsave(&db->lock, flags);
825 /* Move data to DM9000 TX RAM */
826 writeb(DM9000_MWCMD, db->io_addr);
828 (db->outblk)(db->io_data, skb->data, skb->len);
829 dev->stats.tx_bytes += skb->len;
832 /* TX control: First packet immediately send, second packet queue */
833 if (db->tx_pkt_cnt == 1) {
834 /* Set TX length to DM9000 */
835 iow(db, DM9000_TXPLL, skb->len);
836 iow(db, DM9000_TXPLH, skb->len >> 8);
838 /* Issue TX polling command */
839 iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
841 dev->trans_start = jiffies; /* save the time stamp */
844 db->queue_pkt_len = skb->len;
845 netif_stop_queue(dev);
848 spin_unlock_irqrestore(&db->lock, flags);
857 dm9000_shutdown(struct net_device *dev)
859 board_info_t *db = (board_info_t *) dev->priv;
862 dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
863 iow(db, DM9000_GPR, 0x01); /* Power-Down PHY */
864 iow(db, DM9000_IMR, IMR_PAR); /* Disable all interrupt */
865 iow(db, DM9000_RCR, 0x00); /* Disable RX */
869 * Stop the interface.
870 * The interface is stopped when it is brought.
873 dm9000_stop(struct net_device *ndev)
875 board_info_t *db = (board_info_t *) ndev->priv;
877 if (netif_msg_ifdown(db))
878 dev_dbg(db->dev, "shutting down %s\n", ndev->name);
880 netif_stop_queue(ndev);
881 netif_carrier_off(ndev);
884 free_irq(ndev->irq, ndev);
886 dm9000_shutdown(ndev);
892 * DM9000 interrupt handler
893 * receive the packet to upper layer, free the transmitted packet
897 dm9000_tx_done(struct net_device *dev, board_info_t * db)
899 int tx_status = ior(db, DM9000_NSR); /* Got TX status */
901 if (tx_status & (NSR_TX2END | NSR_TX1END)) {
902 /* One packet sent complete */
904 dev->stats.tx_packets++;
906 if (netif_msg_tx_done(db))
907 dev_dbg(db->dev, "tx done, NSR %02x\n", tx_status);
909 /* Queue packet check & send */
910 if (db->tx_pkt_cnt > 0) {
911 iow(db, DM9000_TXPLL, db->queue_pkt_len);
912 iow(db, DM9000_TXPLH, db->queue_pkt_len >> 8);
913 iow(db, DM9000_TCR, TCR_TXREQ);
914 dev->trans_start = jiffies;
916 netif_wake_queue(dev);
921 dm9000_interrupt(int irq, void *dev_id)
923 struct net_device *dev = dev_id;
924 board_info_t *db = (board_info_t *) dev->priv;
928 dm9000_dbg(db, 3, "entering %s\n", __func__);
930 /* A real interrupt coming */
932 spin_lock(&db->lock);
934 /* Save previous register address */
935 reg_save = readb(db->io_addr);
937 /* Disable all interrupts */
938 iow(db, DM9000_IMR, IMR_PAR);
940 /* Got DM9000 interrupt status */
941 int_status = ior(db, DM9000_ISR); /* Got ISR */
942 iow(db, DM9000_ISR, int_status); /* Clear ISR status */
944 if (netif_msg_intr(db))
945 dev_dbg(db->dev, "interrupt status %02x\n", int_status);
947 /* Received the coming packet */
948 if (int_status & ISR_PRS)
951 /* Trnasmit Interrupt check */
952 if (int_status & ISR_PTS)
953 dm9000_tx_done(dev, db);
955 /* Re-enable interrupt mask */
956 iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
958 /* Restore previous register address */
959 writeb(reg_save, db->io_addr);
961 spin_unlock(&db->lock);
966 struct dm9000_rxhdr {
970 } __attribute__((__packed__));
973 * Received a packet and pass to upper layer
976 dm9000_rx(struct net_device *dev)
978 board_info_t *db = (board_info_t *) dev->priv;
979 struct dm9000_rxhdr rxhdr;
985 /* Check packet ready or not */
987 ior(db, DM9000_MRCMDX); /* Dummy read */
989 /* Get most updated data */
990 rxbyte = readb(db->io_data);
992 /* Status check: this byte must be 0 or 1 */
993 if (rxbyte > DM9000_PKT_RDY) {
994 dev_warn(db->dev, "status check fail: %d\n", rxbyte);
995 iow(db, DM9000_RCR, 0x00); /* Stop Device */
996 iow(db, DM9000_ISR, IMR_PAR); /* Stop INT request */
1000 if (rxbyte != DM9000_PKT_RDY)
1003 /* A packet ready now & Get status/length */
1005 writeb(DM9000_MRCMD, db->io_addr);
1007 (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
1009 RxLen = le16_to_cpu(rxhdr.RxLen);
1011 if (netif_msg_rx_status(db))
1012 dev_dbg(db->dev, "RX: status %02x, length %04x\n",
1013 rxhdr.RxStatus, RxLen);
1015 /* Packet Status check */
1018 if (netif_msg_rx_err(db))
1019 dev_dbg(db->dev, "RX: Bad Packet (runt)\n");
1022 if (RxLen > DM9000_PKT_MAX) {
1023 dev_dbg(db->dev, "RST: RX Len:%x\n", RxLen);
1026 if (rxhdr.RxStatus & 0xbf) {
1028 if (rxhdr.RxStatus & 0x01) {
1029 if (netif_msg_rx_err(db))
1030 dev_dbg(db->dev, "fifo error\n");
1031 dev->stats.rx_fifo_errors++;
1033 if (rxhdr.RxStatus & 0x02) {
1034 if (netif_msg_rx_err(db))
1035 dev_dbg(db->dev, "crc error\n");
1036 dev->stats.rx_crc_errors++;
1038 if (rxhdr.RxStatus & 0x80) {
1039 if (netif_msg_rx_err(db))
1040 dev_dbg(db->dev, "length error\n");
1041 dev->stats.rx_length_errors++;
1045 /* Move data from DM9000 */
1047 && ((skb = dev_alloc_skb(RxLen + 4)) != NULL)) {
1048 skb_reserve(skb, 2);
1049 rdptr = (u8 *) skb_put(skb, RxLen - 4);
1051 /* Read received packet from RX SRAM */
1053 (db->inblk)(db->io_data, rdptr, RxLen);
1054 dev->stats.rx_bytes += RxLen;
1056 /* Pass to upper layer */
1057 skb->protocol = eth_type_trans(skb, dev);
1059 dev->stats.rx_packets++;
1062 /* need to dump the packet's data */
1064 (db->dumpblk)(db->io_data, RxLen);
1066 } while (rxbyte == DM9000_PKT_RDY);
1070 dm9000_read_locked(board_info_t *db, int reg)
1072 unsigned long flags;
1075 spin_lock_irqsave(&db->lock, flags);
1077 spin_unlock_irqrestore(&db->lock, flags);
1082 static int dm9000_wait_eeprom(board_info_t *db)
1084 unsigned int status;
1085 int timeout = 8; /* wait max 8msec */
1087 /* The DM9000 data sheets say we should be able to
1088 * poll the ERRE bit in EPCR to wait for the EEPROM
1089 * operation. From testing several chips, this bit
1090 * does not seem to work.
1092 * We attempt to use the bit, but fall back to the
1093 * timeout (which is why we do not return an error
1094 * on expiry) to say that the EEPROM operation has
1099 status = dm9000_read_locked(db, DM9000_EPCR);
1101 if ((status & EPCR_ERRE) == 0)
1104 if (timeout-- < 0) {
1105 dev_dbg(db->dev, "timeout waiting EEPROM\n");
1114 * Read a word data from EEPROM
1117 dm9000_read_eeprom(board_info_t *db, int offset, u8 *to)
1119 unsigned long flags;
1121 if (db->flags & DM9000_PLATF_NO_EEPROM) {
1127 mutex_lock(&db->addr_lock);
1129 spin_lock_irqsave(&db->lock, flags);
1131 iow(db, DM9000_EPAR, offset);
1132 iow(db, DM9000_EPCR, EPCR_ERPRR);
1134 spin_unlock_irqrestore(&db->lock, flags);
1136 dm9000_wait_eeprom(db);
1138 /* delay for at-least 150uS */
1141 spin_lock_irqsave(&db->lock, flags);
1143 iow(db, DM9000_EPCR, 0x0);
1145 to[0] = ior(db, DM9000_EPDRL);
1146 to[1] = ior(db, DM9000_EPDRH);
1148 spin_unlock_irqrestore(&db->lock, flags);
1150 mutex_unlock(&db->addr_lock);
1154 * Write a word data to SROM
1157 dm9000_write_eeprom(board_info_t *db, int offset, u8 *data)
1159 unsigned long flags;
1161 if (db->flags & DM9000_PLATF_NO_EEPROM)
1164 mutex_lock(&db->addr_lock);
1166 spin_lock_irqsave(&db->lock, flags);
1167 iow(db, DM9000_EPAR, offset);
1168 iow(db, DM9000_EPDRH, data[1]);
1169 iow(db, DM9000_EPDRL, data[0]);
1170 iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
1171 spin_unlock_irqrestore(&db->lock, flags);
1173 dm9000_wait_eeprom(db);
1175 mdelay(1); /* wait at least 150uS to clear */
1177 spin_lock_irqsave(&db->lock, flags);
1178 iow(db, DM9000_EPCR, 0);
1179 spin_unlock_irqrestore(&db->lock, flags);
1181 mutex_unlock(&db->addr_lock);
1185 * Set DM9000 multicast address
1188 dm9000_hash_table(struct net_device *dev)
1190 board_info_t *db = (board_info_t *) dev->priv;
1191 struct dev_mc_list *mcptr = dev->mc_list;
1192 int mc_cnt = dev->mc_count;
1196 unsigned long flags;
1198 dm9000_dbg(db, 1, "entering %s\n", __func__);
1200 spin_lock_irqsave(&db->lock, flags);
1202 for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
1203 iow(db, oft, dev->dev_addr[i]);
1205 /* Clear Hash Table */
1206 for (i = 0; i < 4; i++)
1207 hash_table[i] = 0x0;
1209 /* broadcast address */
1210 hash_table[3] = 0x8000;
1212 /* the multicast address in Hash Table : 64 bits */
1213 for (i = 0; i < mc_cnt; i++, mcptr = mcptr->next) {
1214 hash_val = ether_crc_le(6, mcptr->dmi_addr) & 0x3f;
1215 hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
1218 /* Write the hash table to MAC MD table */
1219 for (i = 0, oft = DM9000_MAR; i < 4; i++) {
1220 iow(db, oft++, hash_table[i]);
1221 iow(db, oft++, hash_table[i] >> 8);
1224 spin_unlock_irqrestore(&db->lock, flags);
1229 * Sleep, either by using msleep() or if we are suspending, then
1230 * use mdelay() to sleep.
1232 static void dm9000_msleep(board_info_t *db, unsigned int ms)
1241 * Read a word from phyxcer
1244 dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
1246 board_info_t *db = (board_info_t *) dev->priv;
1247 unsigned long flags;
1248 unsigned int reg_save;
1251 mutex_lock(&db->addr_lock);
1253 spin_lock_irqsave(&db->lock,flags);
1255 /* Save previous register address */
1256 reg_save = readb(db->io_addr);
1258 /* Fill the phyxcer register into REG_0C */
1259 iow(db, DM9000_EPAR, DM9000_PHY | reg);
1261 iow(db, DM9000_EPCR, 0xc); /* Issue phyxcer read command */
1263 writeb(reg_save, db->io_addr);
1264 spin_unlock_irqrestore(&db->lock,flags);
1266 dm9000_msleep(db, 1); /* Wait read complete */
1268 spin_lock_irqsave(&db->lock,flags);
1269 reg_save = readb(db->io_addr);
1271 iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer read command */
1273 /* The read data keeps on REG_0D & REG_0E */
1274 ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
1276 /* restore the previous address */
1277 writeb(reg_save, db->io_addr);
1278 spin_unlock_irqrestore(&db->lock,flags);
1280 mutex_unlock(&db->addr_lock);
1285 * Write a word to phyxcer
1288 dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg, int value)
1290 board_info_t *db = (board_info_t *) dev->priv;
1291 unsigned long flags;
1292 unsigned long reg_save;
1294 mutex_lock(&db->addr_lock);
1296 spin_lock_irqsave(&db->lock,flags);
1298 /* Save previous register address */
1299 reg_save = readb(db->io_addr);
1301 /* Fill the phyxcer register into REG_0C */
1302 iow(db, DM9000_EPAR, DM9000_PHY | reg);
1304 /* Fill the written data into REG_0D & REG_0E */
1305 iow(db, DM9000_EPDRL, value);
1306 iow(db, DM9000_EPDRH, value >> 8);
1308 iow(db, DM9000_EPCR, 0xa); /* Issue phyxcer write command */
1310 writeb(reg_save, db->io_addr);
1311 spin_unlock_irqrestore(&db->lock, flags);
1313 dm9000_msleep(db, 1); /* Wait write complete */
1315 spin_lock_irqsave(&db->lock,flags);
1316 reg_save = readb(db->io_addr);
1318 iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer write command */
1320 /* restore the previous address */
1321 writeb(reg_save, db->io_addr);
1323 spin_unlock_irqrestore(&db->lock, flags);
1324 mutex_unlock(&db->addr_lock);
1328 dm9000_drv_suspend(struct platform_device *dev, pm_message_t state)
1330 struct net_device *ndev = platform_get_drvdata(dev);
1334 db = (board_info_t *) ndev->priv;
1337 if (netif_running(ndev)) {
1338 netif_device_detach(ndev);
1339 dm9000_shutdown(ndev);
1346 dm9000_drv_resume(struct platform_device *dev)
1348 struct net_device *ndev = platform_get_drvdata(dev);
1349 board_info_t *db = (board_info_t *) ndev->priv;
1353 if (netif_running(ndev)) {
1355 dm9000_init_dm9000(ndev);
1357 netif_device_attach(ndev);
1366 dm9000_drv_remove(struct platform_device *pdev)
1368 struct net_device *ndev = platform_get_drvdata(pdev);
1370 platform_set_drvdata(pdev, NULL);
1372 unregister_netdev(ndev);
1373 dm9000_release_board(pdev, (board_info_t *) ndev->priv);
1374 free_netdev(ndev); /* free device structure */
1376 dev_dbg(&pdev->dev, "released and freed device\n");
1380 static struct platform_driver dm9000_driver = {
1383 .owner = THIS_MODULE,
1385 .probe = dm9000_probe,
1386 .remove = dm9000_drv_remove,
1387 .suspend = dm9000_drv_suspend,
1388 .resume = dm9000_drv_resume,
1394 printk(KERN_INFO "%s Ethernet Driver, V%s\n", CARDNAME, DRV_VERSION);
1396 return platform_driver_register(&dm9000_driver); /* search board and register */
1400 dm9000_cleanup(void)
1402 platform_driver_unregister(&dm9000_driver);
1405 module_init(dm9000_init);
1406 module_exit(dm9000_cleanup);
1408 MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1409 MODULE_DESCRIPTION("Davicom DM9000 network driver");
1410 MODULE_LICENSE("GPL");