[PATCH] DRIVER MODEL: Get rid of the obsolete tri-level suspend/resume callbacks
[linux-2.6.git] / drivers / net / dm9000.c
1 /*
2  *   dm9000.c: Version 1.2 03/18/2003
3  *
4  *         A Davicom DM9000 ISA NIC fast Ethernet driver for Linux.
5  *      Copyright (C) 1997  Sten Wang
6  *
7  *      This program is free software; you can redistribute it and/or
8  *      modify it under the terms of the GNU General Public License
9  *      as published by the Free Software Foundation; either version 2
10  *      of the License, or (at your option) any later version.
11  *
12  *      This program is distributed in the hope that it will be useful,
13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *      GNU General Public License for more details.
16  *
17  *   (C)Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
18  *
19  * V0.11        06/20/2001      REG_0A bit3=1, default enable BP with DA match
20  *      06/22/2001      Support DM9801 progrmming
21  *                      E3: R25 = ((R24 + NF) & 0x00ff) | 0xf000
22  *                      E4: R25 = ((R24 + NF) & 0x00ff) | 0xc200
23  *                              R17 = (R17 & 0xfff0) | NF + 3
24  *                      E5: R25 = ((R24 + NF - 3) & 0x00ff) | 0xc200
25  *                              R17 = (R17 & 0xfff0) | NF
26  *
27  * v1.00                modify by simon 2001.9.5
28  *                         change for kernel 2.4.x
29  *
30  * v1.1   11/09/2001            fix force mode bug
31  *
32  * v1.2   03/18/2003       Weilun Huang <weilun_huang@davicom.com.tw>:
33  *                      Fixed phy reset.
34  *                      Added tx/rx 32 bit mode.
35  *                      Cleaned up for kernel merge.
36  *
37  *        03/03/2004    Sascha Hauer <s.hauer@pengutronix.de>
38  *                      Port to 2.6 kernel
39  *
40  *        24-Sep-2004   Ben Dooks <ben@simtec.co.uk>
41  *                      Cleanup of code to remove ifdefs
42  *                      Allowed platform device data to influence access width
43  *                      Reformatting areas of code
44  *
45  *        17-Mar-2005   Sascha Hauer <s.hauer@pengutronix.de>
46  *                      * removed 2.4 style module parameters
47  *                      * removed removed unused stat counter and fixed
48  *                        net_device_stats
49  *                      * introduced tx_timeout function
50  *                      * reworked locking
51  *
52  *        01-Jul-2005   Ben Dooks <ben@simtec.co.uk>
53  *                      * fixed spinlock call without pointer
54  *                      * ensure spinlock is initialised
55  */
56
57 #include <linux/module.h>
58 #include <linux/ioport.h>
59 #include <linux/netdevice.h>
60 #include <linux/etherdevice.h>
61 #include <linux/init.h>
62 #include <linux/skbuff.h>
63 #include <linux/version.h>
64 #include <linux/spinlock.h>
65 #include <linux/crc32.h>
66 #include <linux/mii.h>
67 #include <linux/dm9000.h>
68 #include <linux/delay.h>
69
70 #include <asm/delay.h>
71 #include <asm/irq.h>
72 #include <asm/io.h>
73
74 #include "dm9000.h"
75
76 /* Board/System/Debug information/definition ---------------- */
77
78 #define DM9000_PHY              0x40    /* PHY address 0x01 */
79
80 #define TRUE                    1
81 #define FALSE                   0
82
83 #define CARDNAME "dm9000"
84 #define PFX CARDNAME ": "
85
86 #define DM9000_TIMER_WUT  jiffies+(HZ*2)        /* timer wakeup time : 2 second */
87
88 #define DM9000_DEBUG 0
89
90 #if DM9000_DEBUG > 2
91 #define PRINTK3(args...)  printk(CARDNAME ": " args)
92 #else
93 #define PRINTK3(args...)  do { } while(0)
94 #endif
95
96 #if DM9000_DEBUG > 1
97 #define PRINTK2(args...)  printk(CARDNAME ": " args)
98 #else
99 #define PRINTK2(args...)  do { } while(0)
100 #endif
101
102 #if DM9000_DEBUG > 0
103 #define PRINTK1(args...)  printk(CARDNAME ": " args)
104 #define PRINTK(args...)   printk(CARDNAME ": " args)
105 #else
106 #define PRINTK1(args...)  do { } while(0)
107 #define PRINTK(args...)   printk(KERN_DEBUG args)
108 #endif
109
110 /*
111  * Transmit timeout, default 5 seconds.
112  */
113 static int watchdog = 5000;
114 module_param(watchdog, int, 0400);
115 MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
116
117 /* Structure/enum declaration ------------------------------- */
118 typedef struct board_info {
119
120         void __iomem *io_addr;  /* Register I/O base address */
121         void __iomem *io_data;  /* Data I/O address */
122         u16 irq;                /* IRQ */
123
124         u16 tx_pkt_cnt;
125         u16 queue_pkt_len;
126         u16 queue_start_addr;
127         u16 dbug_cnt;
128         u8 io_mode;             /* 0:word, 2:byte */
129         u8 phy_addr;
130
131         void (*inblk)(void __iomem *port, void *data, int length);
132         void (*outblk)(void __iomem *port, void *data, int length);
133         void (*dumpblk)(void __iomem *port, int length);
134
135         struct resource *addr_res;   /* resources found */
136         struct resource *data_res;
137         struct resource *addr_req;   /* resources requested */
138         struct resource *data_req;
139         struct resource *irq_res;
140
141         struct timer_list timer;
142         struct net_device_stats stats;
143         unsigned char srom[128];
144         spinlock_t lock;
145
146         struct mii_if_info mii;
147         u32 msg_enable;
148 } board_info_t;
149
150 /* function declaration ------------------------------------- */
151 static int dm9000_probe(struct device *);
152 static int dm9000_open(struct net_device *);
153 static int dm9000_start_xmit(struct sk_buff *, struct net_device *);
154 static int dm9000_stop(struct net_device *);
155
156
157 static void dm9000_timer(unsigned long);
158 static void dm9000_init_dm9000(struct net_device *);
159
160 static struct net_device_stats *dm9000_get_stats(struct net_device *);
161
162 static irqreturn_t dm9000_interrupt(int, void *, struct pt_regs *);
163
164 static int dm9000_phy_read(struct net_device *dev, int phyaddr_unsused, int reg);
165 static void dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg,
166                            int value);
167 static u16 read_srom_word(board_info_t *, int);
168 static void dm9000_rx(struct net_device *);
169 static void dm9000_hash_table(struct net_device *);
170
171 //#define DM9000_PROGRAM_EEPROM
172 #ifdef DM9000_PROGRAM_EEPROM
173 static void program_eeprom(board_info_t * db);
174 #endif
175 /* DM9000 network board routine ---------------------------- */
176
177 static void
178 dm9000_reset(board_info_t * db)
179 {
180         PRINTK1("dm9000x: resetting\n");
181         /* RESET device */
182         writeb(DM9000_NCR, db->io_addr);
183         udelay(200);
184         writeb(NCR_RST, db->io_data);
185         udelay(200);
186 }
187
188 /*
189  *   Read a byte from I/O port
190  */
191 static u8
192 ior(board_info_t * db, int reg)
193 {
194         writeb(reg, db->io_addr);
195         return readb(db->io_data);
196 }
197
198 /*
199  *   Write a byte to I/O port
200  */
201
202 static void
203 iow(board_info_t * db, int reg, int value)
204 {
205         writeb(reg, db->io_addr);
206         writeb(value, db->io_data);
207 }
208
209 /* routines for sending block to chip */
210
211 static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
212 {
213         writesb(reg, data, count);
214 }
215
216 static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
217 {
218         writesw(reg, data, (count+1) >> 1);
219 }
220
221 static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
222 {
223         writesl(reg, data, (count+3) >> 2);
224 }
225
226 /* input block from chip to memory */
227
228 static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
229 {
230         readsb(reg, data, count);
231 }
232
233
234 static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
235 {
236         readsw(reg, data, (count+1) >> 1);
237 }
238
239 static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
240 {
241         readsl(reg, data, (count+3) >> 2);
242 }
243
244 /* dump block from chip to null */
245
246 static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
247 {
248         int i;
249         int tmp;
250
251         for (i = 0; i < count; i++)
252                 tmp = readb(reg);
253 }
254
255 static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
256 {
257         int i;
258         int tmp;
259
260         count = (count + 1) >> 1;
261
262         for (i = 0; i < count; i++)
263                 tmp = readw(reg);
264 }
265
266 static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
267 {
268         int i;
269         int tmp;
270
271         count = (count + 3) >> 2;
272
273         for (i = 0; i < count; i++)
274                 tmp = readl(reg);
275 }
276
277 /* dm9000_set_io
278  *
279  * select the specified set of io routines to use with the
280  * device
281  */
282
283 static void dm9000_set_io(struct board_info *db, int byte_width)
284 {
285         /* use the size of the data resource to work out what IO
286          * routines we want to use
287          */
288
289         switch (byte_width) {
290         case 1:
291                 db->dumpblk = dm9000_dumpblk_8bit;
292                 db->outblk  = dm9000_outblk_8bit;
293                 db->inblk   = dm9000_inblk_8bit;
294                 break;
295
296         case 2:
297                 db->dumpblk = dm9000_dumpblk_16bit;
298                 db->outblk  = dm9000_outblk_16bit;
299                 db->inblk   = dm9000_inblk_16bit;
300                 break;
301
302         case 3:
303                 printk(KERN_ERR PFX ": 3 byte IO, falling back to 16bit\n");
304                 db->dumpblk = dm9000_dumpblk_16bit;
305                 db->outblk  = dm9000_outblk_16bit;
306                 db->inblk   = dm9000_inblk_16bit;
307                 break;
308
309         case 4:
310         default:
311                 db->dumpblk = dm9000_dumpblk_32bit;
312                 db->outblk  = dm9000_outblk_32bit;
313                 db->inblk   = dm9000_inblk_32bit;
314                 break;
315         }
316 }
317
318
319 /* Our watchdog timed out. Called by the networking layer */
320 static void dm9000_timeout(struct net_device *dev)
321 {
322         board_info_t *db = (board_info_t *) dev->priv;
323         u8 reg_save;
324         unsigned long flags;
325
326         /* Save previous register address */
327         reg_save = readb(db->io_addr);
328         spin_lock_irqsave(&db->lock,flags);
329
330         netif_stop_queue(dev);
331         dm9000_reset(db);
332         dm9000_init_dm9000(dev);
333         /* We can accept TX packets again */
334         dev->trans_start = jiffies;
335         netif_wake_queue(dev);
336
337         /* Restore previous register address */
338         writeb(reg_save, db->io_addr);
339         spin_unlock_irqrestore(&db->lock,flags);
340 }
341
342
343 /* dm9000_release_board
344  *
345  * release a board, and any mapped resources
346  */
347
348 static void
349 dm9000_release_board(struct platform_device *pdev, struct board_info *db)
350 {
351         if (db->data_res == NULL) {
352                 if (db->addr_res != NULL)
353                         release_mem_region((unsigned long)db->io_addr, 4);
354                 return;
355         }
356
357         /* unmap our resources */
358
359         iounmap(db->io_addr);
360         iounmap(db->io_data);
361
362         /* release the resources */
363
364         if (db->data_req != NULL) {
365                 release_resource(db->data_req);
366                 kfree(db->data_req);
367         }
368
369         if (db->addr_res != NULL) {
370                 release_resource(db->addr_res);
371                 kfree(db->addr_req);
372         }
373 }
374
375 #define res_size(_r) (((_r)->end - (_r)->start) + 1)
376
377 /*
378  * Search DM9000 board, allocate space and register it
379  */
380 static int
381 dm9000_probe(struct device *dev)
382 {
383         struct platform_device *pdev = to_platform_device(dev);
384         struct dm9000_plat_data *pdata = pdev->dev.platform_data;
385         struct board_info *db;  /* Point a board information structure */
386         struct net_device *ndev;
387         unsigned long base;
388         int ret = 0;
389         int iosize;
390         int i;
391         u32 id_val;
392
393         /* Init network device */
394         ndev = alloc_etherdev(sizeof (struct board_info));
395         if (!ndev) {
396                 printk("%s: could not allocate device.\n", CARDNAME);
397                 return -ENOMEM;
398         }
399
400         SET_MODULE_OWNER(ndev);
401         SET_NETDEV_DEV(ndev, dev);
402
403         PRINTK2("dm9000_probe()");
404
405         /* setup board info structure */
406         db = (struct board_info *) ndev->priv;
407         memset(db, 0, sizeof (*db));
408
409         spin_lock_init(&db->lock);
410
411         if (pdev->num_resources < 2) {
412                 ret = -ENODEV;
413                 goto out;
414         }
415
416         switch (pdev->num_resources) {
417         case 2:
418                 base = pdev->resource[0].start;
419
420                 if (!request_mem_region(base, 4, ndev->name)) {
421                         ret = -EBUSY;
422                         goto out;
423                 }
424
425                 ndev->base_addr = base;
426                 ndev->irq = pdev->resource[1].start;
427                 db->io_addr = (void *)base;
428                 db->io_data = (void *)(base + 4);
429
430                 break;
431
432         case 3:
433                 db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
434                 db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
435                 db->irq_res  = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
436
437                 if (db->addr_res == NULL || db->data_res == NULL) {
438                         printk(KERN_ERR PFX "insufficient resources\n");
439                         ret = -ENOENT;
440                         goto out;
441                 }
442
443                 i = res_size(db->addr_res);
444                 db->addr_req = request_mem_region(db->addr_res->start, i,
445                                                   pdev->name);
446
447                 if (db->addr_req == NULL) {
448                         printk(KERN_ERR PFX "cannot claim address reg area\n");
449                         ret = -EIO;
450                         goto out;
451                 }
452
453                 db->io_addr = ioremap(db->addr_res->start, i);
454
455                 if (db->io_addr == NULL) {
456                         printk(KERN_ERR "failed to ioremap address reg\n");
457                         ret = -EINVAL;
458                         goto out;
459                 }
460
461                 iosize = res_size(db->data_res);
462                 db->data_req = request_mem_region(db->data_res->start, iosize,
463                                                   pdev->name);
464
465                 if (db->data_req == NULL) {
466                         printk(KERN_ERR PFX "cannot claim data reg area\n");
467                         ret = -EIO;
468                         goto out;
469                 }
470
471                 db->io_data = ioremap(db->data_res->start, iosize);
472
473                 if (db->io_data == NULL) {
474                         printk(KERN_ERR "failed to ioremap data reg\n");
475                         ret = -EINVAL;
476                         goto out;
477                 }
478
479                 /* fill in parameters for net-dev structure */
480
481                 ndev->base_addr = (unsigned long)db->io_addr;
482                 ndev->irq       = db->irq_res->start;
483
484                 /* ensure at least we have a default set of IO routines */
485                 dm9000_set_io(db, iosize);
486
487         }
488
489         /* check to see if anything is being over-ridden */
490         if (pdata != NULL) {
491                 /* check to see if the driver wants to over-ride the
492                  * default IO width */
493
494                 if (pdata->flags & DM9000_PLATF_8BITONLY)
495                         dm9000_set_io(db, 1);
496
497                 if (pdata->flags & DM9000_PLATF_16BITONLY)
498                         dm9000_set_io(db, 2);
499
500                 if (pdata->flags & DM9000_PLATF_32BITONLY)
501                         dm9000_set_io(db, 4);
502
503                 /* check to see if there are any IO routine
504                  * over-rides */
505
506                 if (pdata->inblk != NULL)
507                         db->inblk = pdata->inblk;
508
509                 if (pdata->outblk != NULL)
510                         db->outblk = pdata->outblk;
511
512                 if (pdata->dumpblk != NULL)
513                         db->dumpblk = pdata->dumpblk;
514         }
515
516         dm9000_reset(db);
517
518         /* try two times, DM9000 sometimes gets the first read wrong */
519         for (i = 0; i < 2; i++) {
520                 id_val  = ior(db, DM9000_VIDL);
521                 id_val |= (u32)ior(db, DM9000_VIDH) << 8;
522                 id_val |= (u32)ior(db, DM9000_PIDL) << 16;
523                 id_val |= (u32)ior(db, DM9000_PIDH) << 24;
524
525                 if (id_val == DM9000_ID)
526                         break;
527                 printk("%s: read wrong id 0x%08x\n", CARDNAME, id_val);
528         }
529
530         if (id_val != DM9000_ID) {
531                 printk("%s: wrong id: 0x%08x\n", CARDNAME, id_val);
532                 goto release;
533         }
534
535         /* from this point we assume that we have found a DM9000 */
536
537         /* driver system function */
538         ether_setup(ndev);
539
540         ndev->open               = &dm9000_open;
541         ndev->hard_start_xmit    = &dm9000_start_xmit;
542         ndev->tx_timeout         = &dm9000_timeout;
543         ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
544         ndev->stop               = &dm9000_stop;
545         ndev->get_stats          = &dm9000_get_stats;
546         ndev->set_multicast_list = &dm9000_hash_table;
547
548 #ifdef DM9000_PROGRAM_EEPROM
549         program_eeprom(db);
550 #endif
551         db->msg_enable       = NETIF_MSG_LINK;
552         db->mii.phy_id_mask  = 0x1f;
553         db->mii.reg_num_mask = 0x1f;
554         db->mii.force_media  = 0;
555         db->mii.full_duplex  = 0;
556         db->mii.dev          = ndev;
557         db->mii.mdio_read    = dm9000_phy_read;
558         db->mii.mdio_write   = dm9000_phy_write;
559
560         /* Read SROM content */
561         for (i = 0; i < 64; i++)
562                 ((u16 *) db->srom)[i] = read_srom_word(db, i);
563
564         /* Set Node Address */
565         for (i = 0; i < 6; i++)
566                 ndev->dev_addr[i] = db->srom[i];
567
568         if (!is_valid_ether_addr(ndev->dev_addr))
569                 printk("%s: Invalid ethernet MAC address.  Please "
570                        "set using ifconfig\n", ndev->name);
571
572         dev_set_drvdata(dev, ndev);
573         ret = register_netdev(ndev);
574
575         if (ret == 0) {
576                 printk("%s: dm9000 at %p,%p IRQ %d MAC: ",
577                        ndev->name,  db->io_addr, db->io_data, ndev->irq);
578                 for (i = 0; i < 5; i++)
579                         printk("%02x:", ndev->dev_addr[i]);
580                 printk("%02x\n", ndev->dev_addr[5]);
581         }
582         return 0;
583
584  release:
585  out:
586         printk("%s: not found (%d).\n", CARDNAME, ret);
587
588         dm9000_release_board(pdev, db);
589         kfree(ndev);
590
591         return ret;
592 }
593
594 /*
595  *  Open the interface.
596  *  The interface is opened whenever "ifconfig" actives it.
597  */
598 static int
599 dm9000_open(struct net_device *dev)
600 {
601         board_info_t *db = (board_info_t *) dev->priv;
602
603         PRINTK2("entering dm9000_open\n");
604
605         if (request_irq(dev->irq, &dm9000_interrupt, SA_SHIRQ, dev->name, dev))
606                 return -EAGAIN;
607
608         /* Initialize DM9000 board */
609         dm9000_reset(db);
610         dm9000_init_dm9000(dev);
611
612         /* Init driver variable */
613         db->dbug_cnt = 0;
614
615         /* set and active a timer process */
616         init_timer(&db->timer);
617         db->timer.expires  = DM9000_TIMER_WUT;
618         db->timer.data     = (unsigned long) dev;
619         db->timer.function = &dm9000_timer;
620         add_timer(&db->timer);
621
622         mii_check_media(&db->mii, netif_msg_link(db), 1);
623         netif_start_queue(dev);
624
625         return 0;
626 }
627
628 /*
629  * Initilize dm9000 board
630  */
631 static void
632 dm9000_init_dm9000(struct net_device *dev)
633 {
634         board_info_t *db = (board_info_t *) dev->priv;
635
636         PRINTK1("entering %s\n",__FUNCTION__);
637
638         /* I/O mode */
639         db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
640
641         /* GPIO0 on pre-activate PHY */
642         iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
643         iow(db, DM9000_GPCR, GPCR_GEP_CNTL);    /* Let GPIO0 output */
644         iow(db, DM9000_GPR, 0); /* Enable PHY */
645
646         /* Program operating register */
647         iow(db, DM9000_TCR, 0);         /* TX Polling clear */
648         iow(db, DM9000_BPTR, 0x3f);     /* Less 3Kb, 200us */
649         iow(db, DM9000_FCR, 0xff);      /* Flow Control */
650         iow(db, DM9000_SMCR, 0);        /* Special Mode */
651         /* clear TX status */
652         iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
653         iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
654
655         /* Set address filter table */
656         dm9000_hash_table(dev);
657
658         /* Activate DM9000 */
659         iow(db, DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);
660         /* Enable TX/RX interrupt mask */
661         iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
662
663         /* Init Driver variable */
664         db->tx_pkt_cnt = 0;
665         db->queue_pkt_len = 0;
666         dev->trans_start = 0;
667         spin_lock_init(&db->lock);
668 }
669
670 /*
671  *  Hardware start transmission.
672  *  Send a packet to media from the upper layer.
673  */
674 static int
675 dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
676 {
677         board_info_t *db = (board_info_t *) dev->priv;
678
679         PRINTK3("dm9000_start_xmit\n");
680
681         if (db->tx_pkt_cnt > 1)
682                 return 1;
683
684         netif_stop_queue(dev);
685
686         /* Disable all interrupts */
687         iow(db, DM9000_IMR, IMR_PAR);
688
689         /* Move data to DM9000 TX RAM */
690         writeb(DM9000_MWCMD, db->io_addr);
691
692         (db->outblk)(db->io_data, skb->data, skb->len);
693         db->stats.tx_bytes += skb->len;
694
695         /* TX control: First packet immediately send, second packet queue */
696         if (db->tx_pkt_cnt == 0) {
697
698                 /* First Packet */
699                 db->tx_pkt_cnt++;
700
701                 /* Set TX length to DM9000 */
702                 iow(db, DM9000_TXPLL, skb->len & 0xff);
703                 iow(db, DM9000_TXPLH, (skb->len >> 8) & 0xff);
704
705                 /* Issue TX polling command */
706                 iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
707
708                 dev->trans_start = jiffies;     /* save the time stamp */
709
710         } else {
711                 /* Second packet */
712                 db->tx_pkt_cnt++;
713                 db->queue_pkt_len = skb->len;
714         }
715
716         /* free this SKB */
717         dev_kfree_skb(skb);
718
719         /* Re-enable resource check */
720         if (db->tx_pkt_cnt == 1)
721                 netif_wake_queue(dev);
722
723         /* Re-enable interrupt */
724         iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
725
726         return 0;
727 }
728
729 static void
730 dm9000_shutdown(struct net_device *dev)
731 {
732         board_info_t *db = (board_info_t *) dev->priv;
733
734         /* RESET device */
735         dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
736         iow(db, DM9000_GPR, 0x01);      /* Power-Down PHY */
737         iow(db, DM9000_IMR, IMR_PAR);   /* Disable all interrupt */
738         iow(db, DM9000_RCR, 0x00);      /* Disable RX */
739 }
740
741 /*
742  * Stop the interface.
743  * The interface is stopped when it is brought.
744  */
745 static int
746 dm9000_stop(struct net_device *ndev)
747 {
748         board_info_t *db = (board_info_t *) ndev->priv;
749
750         PRINTK1("entering %s\n",__FUNCTION__);
751
752         /* deleted timer */
753         del_timer(&db->timer);
754
755         netif_stop_queue(ndev);
756         netif_carrier_off(ndev);
757
758         /* free interrupt */
759         free_irq(ndev->irq, ndev);
760
761         dm9000_shutdown(ndev);
762
763         return 0;
764 }
765
766 /*
767  * DM9000 interrupt handler
768  * receive the packet to upper layer, free the transmitted packet
769  */
770
771 void
772 dm9000_tx_done(struct net_device *dev, board_info_t * db)
773 {
774         int tx_status = ior(db, DM9000_NSR);    /* Got TX status */
775
776         if (tx_status & (NSR_TX2END | NSR_TX1END)) {
777                 /* One packet sent complete */
778                 db->tx_pkt_cnt--;
779                 db->stats.tx_packets++;
780
781                 /* Queue packet check & send */
782                 if (db->tx_pkt_cnt > 0) {
783                         iow(db, DM9000_TXPLL, db->queue_pkt_len & 0xff);
784                         iow(db, DM9000_TXPLH, (db->queue_pkt_len >> 8) & 0xff);
785                         iow(db, DM9000_TCR, TCR_TXREQ);
786                         dev->trans_start = jiffies;
787                 }
788                 netif_wake_queue(dev);
789         }
790 }
791
792 static irqreturn_t
793 dm9000_interrupt(int irq, void *dev_id, struct pt_regs *regs)
794 {
795         struct net_device *dev = dev_id;
796         board_info_t *db;
797         int int_status;
798         u8 reg_save;
799
800         PRINTK3("entering %s\n",__FUNCTION__);
801
802         if (!dev) {
803                 PRINTK1("dm9000_interrupt() without DEVICE arg\n");
804                 return IRQ_HANDLED;
805         }
806
807         /* A real interrupt coming */
808         db = (board_info_t *) dev->priv;
809         spin_lock(&db->lock);
810
811         /* Save previous register address */
812         reg_save = readb(db->io_addr);
813
814         /* Disable all interrupts */
815         iow(db, DM9000_IMR, IMR_PAR);
816
817         /* Got DM9000 interrupt status */
818         int_status = ior(db, DM9000_ISR);       /* Got ISR */
819         iow(db, DM9000_ISR, int_status);        /* Clear ISR status */
820
821         /* Received the coming packet */
822         if (int_status & ISR_PRS)
823                 dm9000_rx(dev);
824
825         /* Trnasmit Interrupt check */
826         if (int_status & ISR_PTS)
827                 dm9000_tx_done(dev, db);
828
829         /* Re-enable interrupt mask */
830         iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
831
832         /* Restore previous register address */
833         writeb(reg_save, db->io_addr);
834
835         spin_unlock(&db->lock);
836
837         return IRQ_HANDLED;
838 }
839
840 /*
841  *  Get statistics from driver.
842  */
843 static struct net_device_stats *
844 dm9000_get_stats(struct net_device *dev)
845 {
846         board_info_t *db = (board_info_t *) dev->priv;
847         return &db->stats;
848 }
849
850
851 /*
852  *  A periodic timer routine
853  *  Dynamic media sense, allocated Rx buffer...
854  */
855 static void
856 dm9000_timer(unsigned long data)
857 {
858         struct net_device *dev = (struct net_device *) data;
859         board_info_t *db = (board_info_t *) dev->priv;
860
861         PRINTK3("dm9000_timer()\n");
862
863         mii_check_media(&db->mii, netif_msg_link(db), 0);
864
865         /* Set timer again */
866         db->timer.expires = DM9000_TIMER_WUT;
867         add_timer(&db->timer);
868 }
869
870 struct dm9000_rxhdr {
871         u16     RxStatus;
872         u16     RxLen;
873 } __attribute__((__packed__));
874
875 /*
876  *  Received a packet and pass to upper layer
877  */
878 static void
879 dm9000_rx(struct net_device *dev)
880 {
881         board_info_t *db = (board_info_t *) dev->priv;
882         struct dm9000_rxhdr rxhdr;
883         struct sk_buff *skb;
884         u8 rxbyte, *rdptr;
885         int GoodPacket;
886         int RxLen;
887
888         /* Check packet ready or not */
889         do {
890                 ior(db, DM9000_MRCMDX); /* Dummy read */
891
892                 /* Get most updated data */
893                 rxbyte = readb(db->io_data);
894
895                 /* Status check: this byte must be 0 or 1 */
896                 if (rxbyte > DM9000_PKT_RDY) {
897                         printk("status check failed: %d\n", rxbyte);
898                         iow(db, DM9000_RCR, 0x00);      /* Stop Device */
899                         iow(db, DM9000_ISR, IMR_PAR);   /* Stop INT request */
900                         return;
901                 }
902
903                 if (rxbyte != DM9000_PKT_RDY)
904                         return;
905
906                 /* A packet ready now  & Get status/length */
907                 GoodPacket = TRUE;
908                 writeb(DM9000_MRCMD, db->io_addr);
909
910                 (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
911
912                 RxLen = rxhdr.RxLen;
913
914                 /* Packet Status check */
915                 if (RxLen < 0x40) {
916                         GoodPacket = FALSE;
917                         PRINTK1("Bad Packet received (runt)\n");
918                 }
919
920                 if (RxLen > DM9000_PKT_MAX) {
921                         PRINTK1("RST: RX Len:%x\n", RxLen);
922                 }
923
924                 if (rxhdr.RxStatus & 0xbf00) {
925                         GoodPacket = FALSE;
926                         if (rxhdr.RxStatus & 0x100) {
927                                 PRINTK1("fifo error\n");
928                                 db->stats.rx_fifo_errors++;
929                         }
930                         if (rxhdr.RxStatus & 0x200) {
931                                 PRINTK1("crc error\n");
932                                 db->stats.rx_crc_errors++;
933                         }
934                         if (rxhdr.RxStatus & 0x8000) {
935                                 PRINTK1("length error\n");
936                                 db->stats.rx_length_errors++;
937                         }
938                 }
939
940                 /* Move data from DM9000 */
941                 if (GoodPacket
942                     && ((skb = dev_alloc_skb(RxLen + 4)) != NULL)) {
943                         skb->dev = dev;
944                         skb_reserve(skb, 2);
945                         rdptr = (u8 *) skb_put(skb, RxLen - 4);
946
947                         /* Read received packet from RX SRAM */
948
949                         (db->inblk)(db->io_data, rdptr, RxLen);
950                         db->stats.rx_bytes += RxLen;
951
952                         /* Pass to upper layer */
953                         skb->protocol = eth_type_trans(skb, dev);
954                         netif_rx(skb);
955                         db->stats.rx_packets++;
956
957                 } else {
958                         /* need to dump the packet's data */
959
960                         (db->dumpblk)(db->io_data, RxLen);
961                 }
962         } while (rxbyte == DM9000_PKT_RDY);
963 }
964
965 /*
966  *  Read a word data from SROM
967  */
968 static u16
969 read_srom_word(board_info_t * db, int offset)
970 {
971         iow(db, DM9000_EPAR, offset);
972         iow(db, DM9000_EPCR, EPCR_ERPRR);
973         mdelay(8);              /* according to the datasheet 200us should be enough,
974                                    but it doesn't work */
975         iow(db, DM9000_EPCR, 0x0);
976         return (ior(db, DM9000_EPDRL) + (ior(db, DM9000_EPDRH) << 8));
977 }
978
979 #ifdef DM9000_PROGRAM_EEPROM
980 /*
981  * Write a word data to SROM
982  */
983 static void
984 write_srom_word(board_info_t * db, int offset, u16 val)
985 {
986         iow(db, DM9000_EPAR, offset);
987         iow(db, DM9000_EPDRH, ((val >> 8) & 0xff));
988         iow(db, DM9000_EPDRL, (val & 0xff));
989         iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
990         mdelay(8);              /* same shit */
991         iow(db, DM9000_EPCR, 0);
992 }
993
994 /*
995  * Only for development:
996  * Here we write static data to the eeprom in case
997  * we don't have valid content on a new board
998  */
999 static void
1000 program_eeprom(board_info_t * db)
1001 {
1002         u16 eeprom[] = { 0x0c00, 0x007f, 0x1300,        /* MAC Address */
1003                 0x0000,         /* Autoload: accept nothing */
1004                 0x0a46, 0x9000, /* Vendor / Product ID */
1005                 0x0000,         /* pin control */
1006                 0x0000,
1007         };                      /* Wake-up mode control */
1008         int i;
1009         for (i = 0; i < 8; i++)
1010                 write_srom_word(db, i, eeprom[i]);
1011 }
1012 #endif
1013
1014
1015 /*
1016  *  Calculate the CRC valude of the Rx packet
1017  *  flag = 1 : return the reverse CRC (for the received packet CRC)
1018  *         0 : return the normal CRC (for Hash Table index)
1019  */
1020
1021 static unsigned long
1022 cal_CRC(unsigned char *Data, unsigned int Len, u8 flag)
1023 {
1024
1025        u32 crc = ether_crc_le(Len, Data);
1026
1027        if (flag)
1028                return ~crc;
1029
1030        return crc;
1031 }
1032
1033 /*
1034  *  Set DM9000 multicast address
1035  */
1036 static void
1037 dm9000_hash_table(struct net_device *dev)
1038 {
1039         board_info_t *db = (board_info_t *) dev->priv;
1040         struct dev_mc_list *mcptr = dev->mc_list;
1041         int mc_cnt = dev->mc_count;
1042         u32 hash_val;
1043         u16 i, oft, hash_table[4];
1044         unsigned long flags;
1045
1046         PRINTK2("dm9000_hash_table()\n");
1047
1048         spin_lock_irqsave(&db->lock,flags);
1049
1050         for (i = 0, oft = 0x10; i < 6; i++, oft++)
1051                 iow(db, oft, dev->dev_addr[i]);
1052
1053         /* Clear Hash Table */
1054         for (i = 0; i < 4; i++)
1055                 hash_table[i] = 0x0;
1056
1057         /* broadcast address */
1058         hash_table[3] = 0x8000;
1059
1060         /* the multicast address in Hash Table : 64 bits */
1061         for (i = 0; i < mc_cnt; i++, mcptr = mcptr->next) {
1062                 hash_val = cal_CRC((char *) mcptr->dmi_addr, 6, 0) & 0x3f;
1063                 hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
1064         }
1065
1066         /* Write the hash table to MAC MD table */
1067         for (i = 0, oft = 0x16; i < 4; i++) {
1068                 iow(db, oft++, hash_table[i] & 0xff);
1069                 iow(db, oft++, (hash_table[i] >> 8) & 0xff);
1070         }
1071
1072         spin_unlock_irqrestore(&db->lock,flags);
1073 }
1074
1075
1076 /*
1077  *   Read a word from phyxcer
1078  */
1079 static int
1080 dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
1081 {
1082         board_info_t *db = (board_info_t *) dev->priv;
1083         unsigned long flags;
1084         unsigned int reg_save;
1085         int ret;
1086
1087         spin_lock_irqsave(&db->lock,flags);
1088
1089         /* Save previous register address */
1090         reg_save = readb(db->io_addr);
1091
1092         /* Fill the phyxcer register into REG_0C */
1093         iow(db, DM9000_EPAR, DM9000_PHY | reg);
1094
1095         iow(db, DM9000_EPCR, 0xc);      /* Issue phyxcer read command */
1096         udelay(100);            /* Wait read complete */
1097         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer read command */
1098
1099         /* The read data keeps on REG_0D & REG_0E */
1100         ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
1101
1102         /* restore the previous address */
1103         writeb(reg_save, db->io_addr);
1104
1105         spin_unlock_irqrestore(&db->lock,flags);
1106
1107         return ret;
1108 }
1109
1110 /*
1111  *   Write a word to phyxcer
1112  */
1113 static void
1114 dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg, int value)
1115 {
1116         board_info_t *db = (board_info_t *) dev->priv;
1117         unsigned long flags;
1118         unsigned long reg_save;
1119
1120         spin_lock_irqsave(&db->lock,flags);
1121
1122         /* Save previous register address */
1123         reg_save = readb(db->io_addr);
1124
1125         /* Fill the phyxcer register into REG_0C */
1126         iow(db, DM9000_EPAR, DM9000_PHY | reg);
1127
1128         /* Fill the written data into REG_0D & REG_0E */
1129         iow(db, DM9000_EPDRL, (value & 0xff));
1130         iow(db, DM9000_EPDRH, ((value >> 8) & 0xff));
1131
1132         iow(db, DM9000_EPCR, 0xa);      /* Issue phyxcer write command */
1133         udelay(500);            /* Wait write complete */
1134         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer write command */
1135
1136         /* restore the previous address */
1137         writeb(reg_save, db->io_addr);
1138
1139         spin_unlock_irqrestore(&db->lock,flags);
1140 }
1141
1142 static int
1143 dm9000_drv_suspend(struct device *dev, pm_message_t state)
1144 {
1145         struct net_device *ndev = dev_get_drvdata(dev);
1146
1147         if (ndev) {
1148                 if (netif_running(ndev)) {
1149                         netif_device_detach(ndev);
1150                         dm9000_shutdown(ndev);
1151                 }
1152         }
1153         return 0;
1154 }
1155
1156 static int
1157 dm9000_drv_resume(struct device *dev)
1158 {
1159         struct net_device *ndev = dev_get_drvdata(dev);
1160         board_info_t *db = (board_info_t *) ndev->priv;
1161
1162         if (ndev) {
1163
1164                 if (netif_running(ndev)) {
1165                         dm9000_reset(db);
1166                         dm9000_init_dm9000(ndev);
1167
1168                         netif_device_attach(ndev);
1169                 }
1170         }
1171         return 0;
1172 }
1173
1174 static int
1175 dm9000_drv_remove(struct device *dev)
1176 {
1177         struct platform_device *pdev = to_platform_device(dev);
1178         struct net_device *ndev = dev_get_drvdata(dev);
1179
1180         dev_set_drvdata(dev, NULL);
1181
1182         unregister_netdev(ndev);
1183         dm9000_release_board(pdev, (board_info_t *) ndev->priv);
1184         kfree(ndev);            /* free device structure */
1185
1186         PRINTK1("clean_module() exit\n");
1187
1188         return 0;
1189 }
1190
1191 static struct device_driver dm9000_driver = {
1192         .name    = "dm9000",
1193         .bus     = &platform_bus_type,
1194         .probe   = dm9000_probe,
1195         .remove  = dm9000_drv_remove,
1196         .suspend = dm9000_drv_suspend,
1197         .resume  = dm9000_drv_resume,
1198 };
1199
1200 static int __init
1201 dm9000_init(void)
1202 {
1203         printk(KERN_INFO "%s Ethernet Driver\n", CARDNAME);
1204
1205         return driver_register(&dm9000_driver); /* search board and register */
1206 }
1207
1208 static void __exit
1209 dm9000_cleanup(void)
1210 {
1211         driver_unregister(&dm9000_driver);
1212 }
1213
1214 module_init(dm9000_init);
1215 module_exit(dm9000_cleanup);
1216
1217 MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1218 MODULE_DESCRIPTION("Davicom DM9000 network driver");
1219 MODULE_LICENSE("GPL");