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