[netdrvr] sfc: Remove unused macro EFX_XAUI_RETRAIN_MAX
[linux-2.6] / drivers / net / dm9000.c
1 /*
2  *      Davicom DM9000 Fast Ethernet driver for Linux.
3  *      Copyright (C) 1997  Sten Wang
4  *
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.
9  *
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.
14  *
15  * (C) Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
16  *
17  * Additional updates, Copyright:
18  *      Ben Dooks <ben@simtec.co.uk>
19  *      Sascha Hauer <s.hauer@pengutronix.de>
20  */
21
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>
36
37 #include <asm/delay.h>
38 #include <asm/irq.h>
39 #include <asm/io.h>
40
41 #include "dm9000.h"
42
43 /* Board/System/Debug information/definition ---------------- */
44
45 #define DM9000_PHY              0x40    /* PHY address 0x01 */
46
47 #define CARDNAME "dm9000"
48 #define PFX CARDNAME ": "
49 #define DRV_VERSION     "1.30"
50
51 #ifdef CONFIG_BLACKFIN
52 #define readsb  insb
53 #define readsw  insw
54 #define readsl  insl
55 #define writesb outsb
56 #define writesw outsw
57 #define writesl outsl
58 #define DEFAULT_TRIGGER IRQF_TRIGGER_HIGH
59 #else
60 #define DEFAULT_TRIGGER (0)
61 #endif
62
63 /*
64  * Transmit timeout, default 5 seconds.
65  */
66 static int watchdog = 5000;
67 module_param(watchdog, int, 0400);
68 MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
69
70 /* DM9000 register address locking.
71  *
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.
75  *
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.
80  *
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
85  * these two devices.
86  */
87
88 /* Structure/enum declaration ------------------------------- */
89 typedef struct board_info {
90
91         void __iomem *io_addr;  /* Register I/O base address */
92         void __iomem *io_data;  /* Data I/O address */
93         u16 irq;                /* IRQ */
94
95         u16 tx_pkt_cnt;
96         u16 queue_pkt_len;
97         u16 queue_start_addr;
98         u16 dbug_cnt;
99         u8 io_mode;             /* 0:word, 2:byte */
100         u8 phy_addr;
101         unsigned int flags;
102         unsigned int in_suspend :1;
103
104         int debug_level;
105
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);
109
110         struct device   *dev;        /* parent device */
111
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;
117
118         struct mutex     addr_lock;     /* phy and eeprom access lock */
119
120         spinlock_t lock;
121
122         struct mii_if_info mii;
123         u32 msg_enable;
124 } board_info_t;
125
126 /* debug code */
127
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);                  \
132         }                                               \
133 } while (0)
134
135 static inline board_info_t *to_dm9000_board(struct net_device *dev)
136 {
137         return dev->priv;
138 }
139
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);
146
147 static void dm9000_init_dm9000(struct net_device *);
148
149 static irqreturn_t dm9000_interrupt(int, void *);
150
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,
153                            int value);
154
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 *);
159
160 /* DM9000 network board routine ---------------------------- */
161
162 static void
163 dm9000_reset(board_info_t * db)
164 {
165         dev_dbg(db->dev, "resetting device\n");
166
167         /* RESET device */
168         writeb(DM9000_NCR, db->io_addr);
169         udelay(200);
170         writeb(NCR_RST, db->io_data);
171         udelay(200);
172 }
173
174 /*
175  *   Read a byte from I/O port
176  */
177 static u8
178 ior(board_info_t * db, int reg)
179 {
180         writeb(reg, db->io_addr);
181         return readb(db->io_data);
182 }
183
184 /*
185  *   Write a byte to I/O port
186  */
187
188 static void
189 iow(board_info_t * db, int reg, int value)
190 {
191         writeb(reg, db->io_addr);
192         writeb(value, db->io_data);
193 }
194
195 /* routines for sending block to chip */
196
197 static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
198 {
199         writesb(reg, data, count);
200 }
201
202 static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
203 {
204         writesw(reg, data, (count+1) >> 1);
205 }
206
207 static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
208 {
209         writesl(reg, data, (count+3) >> 2);
210 }
211
212 /* input block from chip to memory */
213
214 static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
215 {
216         readsb(reg, data, count);
217 }
218
219
220 static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
221 {
222         readsw(reg, data, (count+1) >> 1);
223 }
224
225 static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
226 {
227         readsl(reg, data, (count+3) >> 2);
228 }
229
230 /* dump block from chip to null */
231
232 static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
233 {
234         int i;
235         int tmp;
236
237         for (i = 0; i < count; i++)
238                 tmp = readb(reg);
239 }
240
241 static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
242 {
243         int i;
244         int tmp;
245
246         count = (count + 1) >> 1;
247
248         for (i = 0; i < count; i++)
249                 tmp = readw(reg);
250 }
251
252 static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
253 {
254         int i;
255         int tmp;
256
257         count = (count + 3) >> 2;
258
259         for (i = 0; i < count; i++)
260                 tmp = readl(reg);
261 }
262
263 /* dm9000_set_io
264  *
265  * select the specified set of io routines to use with the
266  * device
267  */
268
269 static void dm9000_set_io(struct board_info *db, int byte_width)
270 {
271         /* use the size of the data resource to work out what IO
272          * routines we want to use
273          */
274
275         switch (byte_width) {
276         case 1:
277                 db->dumpblk = dm9000_dumpblk_8bit;
278                 db->outblk  = dm9000_outblk_8bit;
279                 db->inblk   = dm9000_inblk_8bit;
280                 break;
281
282
283         case 3:
284                 dev_dbg(db->dev, ": 3 byte IO, falling back to 16bit\n");
285         case 2:
286                 db->dumpblk = dm9000_dumpblk_16bit;
287                 db->outblk  = dm9000_outblk_16bit;
288                 db->inblk   = dm9000_inblk_16bit;
289                 break;
290
291         case 4:
292         default:
293                 db->dumpblk = dm9000_dumpblk_32bit;
294                 db->outblk  = dm9000_outblk_32bit;
295                 db->inblk   = dm9000_inblk_32bit;
296                 break;
297         }
298 }
299
300
301 /* Our watchdog timed out. Called by the networking layer */
302 static void dm9000_timeout(struct net_device *dev)
303 {
304         board_info_t *db = (board_info_t *) dev->priv;
305         u8 reg_save;
306         unsigned long flags;
307
308         /* Save previous register address */
309         reg_save = readb(db->io_addr);
310         spin_lock_irqsave(&db->lock,flags);
311
312         netif_stop_queue(dev);
313         dm9000_reset(db);
314         dm9000_init_dm9000(dev);
315         /* We can accept TX packets again */
316         dev->trans_start = jiffies;
317         netif_wake_queue(dev);
318
319         /* Restore previous register address */
320         writeb(reg_save, db->io_addr);
321         spin_unlock_irqrestore(&db->lock,flags);
322 }
323
324 #ifdef CONFIG_NET_POLL_CONTROLLER
325 /*
326  *Used by netconsole
327  */
328 static void dm9000_poll_controller(struct net_device *dev)
329 {
330         disable_irq(dev->irq);
331         dm9000_interrupt(dev->irq,dev);
332         enable_irq(dev->irq);
333 }
334 #endif
335
336 static int dm9000_ioctl(struct net_device *dev, struct ifreq *req, int cmd)
337 {
338         board_info_t *dm = to_dm9000_board(dev);
339
340         if (!netif_running(dev))
341                 return -EINVAL;
342
343         return generic_mii_ioctl(&dm->mii, if_mii(req), cmd, NULL);
344 }
345
346 /* ethtool ops */
347
348 static void dm9000_get_drvinfo(struct net_device *dev,
349                                struct ethtool_drvinfo *info)
350 {
351         board_info_t *dm = to_dm9000_board(dev);
352
353         strcpy(info->driver, CARDNAME);
354         strcpy(info->version, DRV_VERSION);
355         strcpy(info->bus_info, to_platform_device(dm->dev)->name);
356 }
357
358 static u32 dm9000_get_msglevel(struct net_device *dev)
359 {
360         board_info_t *dm = to_dm9000_board(dev);
361
362         return dm->msg_enable;
363 }
364
365 static void dm9000_set_msglevel(struct net_device *dev, u32 value)
366 {
367         board_info_t *dm = to_dm9000_board(dev);
368
369         dm->msg_enable = value;
370 }
371
372 static int dm9000_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
373 {
374         board_info_t *dm = to_dm9000_board(dev);
375
376         mii_ethtool_gset(&dm->mii, cmd);
377         return 0;
378 }
379
380 static int dm9000_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
381 {
382         board_info_t *dm = to_dm9000_board(dev);
383
384         return mii_ethtool_sset(&dm->mii, cmd);
385 }
386
387 static int dm9000_nway_reset(struct net_device *dev)
388 {
389         board_info_t *dm = to_dm9000_board(dev);
390         return mii_nway_restart(&dm->mii);
391 }
392
393 static u32 dm9000_get_link(struct net_device *dev)
394 {
395         board_info_t *dm = to_dm9000_board(dev);
396         return mii_link_ok(&dm->mii);
397 }
398
399 #define DM_EEPROM_MAGIC         (0x444D394B)
400
401 static int dm9000_get_eeprom_len(struct net_device *dev)
402 {
403         return 128;
404 }
405
406 static int dm9000_get_eeprom(struct net_device *dev,
407                              struct ethtool_eeprom *ee, u8 *data)
408 {
409         board_info_t *dm = to_dm9000_board(dev);
410         int offset = ee->offset;
411         int len = ee->len;
412         int i;
413
414         /* EEPROM access is aligned to two bytes */
415
416         if ((len & 1) != 0 || (offset & 1) != 0)
417                 return -EINVAL;
418
419         if (dm->flags & DM9000_PLATF_NO_EEPROM)
420                 return -ENOENT;
421
422         ee->magic = DM_EEPROM_MAGIC;
423
424         for (i = 0; i < len; i += 2)
425                 dm9000_read_eeprom(dm, (offset + i) / 2, data + i);
426
427         return 0;
428 }
429
430 static int dm9000_set_eeprom(struct net_device *dev,
431                              struct ethtool_eeprom *ee, u8 *data)
432 {
433         board_info_t *dm = to_dm9000_board(dev);
434         int offset = ee->offset;
435         int len = ee->len;
436         int i;
437
438         /* EEPROM access is aligned to two bytes */
439
440         if ((len & 1) != 0 || (offset & 1) != 0)
441                 return -EINVAL;
442
443         if (dm->flags & DM9000_PLATF_NO_EEPROM)
444                 return -ENOENT;
445
446         if (ee->magic != DM_EEPROM_MAGIC)
447                 return -EINVAL;
448
449         for (i = 0; i < len; i += 2)
450                 dm9000_write_eeprom(dm, (offset + i) / 2, data + i);
451
452         return 0;
453 }
454
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,
466 };
467
468
469 /* dm9000_release_board
470  *
471  * release a board, and any mapped resources
472  */
473
474 static void
475 dm9000_release_board(struct platform_device *pdev, struct board_info *db)
476 {
477         if (db->data_res == NULL) {
478                 if (db->addr_res != NULL)
479                         release_mem_region((unsigned long)db->io_addr, 4);
480                 return;
481         }
482
483         /* unmap our resources */
484
485         iounmap(db->io_addr);
486         iounmap(db->io_data);
487
488         /* release the resources */
489
490         if (db->data_req != NULL) {
491                 release_resource(db->data_req);
492                 kfree(db->data_req);
493         }
494
495         if (db->addr_req != NULL) {
496                 release_resource(db->addr_req);
497                 kfree(db->addr_req);
498         }
499 }
500
501 #define res_size(_r) (((_r)->end - (_r)->start) + 1)
502
503 /*
504  * Search DM9000 board, allocate space and register it
505  */
506 static int
507 dm9000_probe(struct platform_device *pdev)
508 {
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;
512         const unsigned char *mac_src;
513         unsigned long base;
514         int ret = 0;
515         int iosize;
516         int i;
517         u32 id_val;
518
519         /* Init network device */
520         ndev = alloc_etherdev(sizeof (struct board_info));
521         if (!ndev) {
522                 dev_err(&pdev->dev, "could not allocate device.\n");
523                 return -ENOMEM;
524         }
525
526         SET_NETDEV_DEV(ndev, &pdev->dev);
527
528         dev_dbg(&pdev->dev, "dm9000_probe()");
529
530         /* setup board info structure */
531         db = (struct board_info *) ndev->priv;
532         memset(db, 0, sizeof (*db));
533
534         db->dev = &pdev->dev;
535
536         spin_lock_init(&db->lock);
537         mutex_init(&db->addr_lock);
538
539         if (pdev->num_resources < 2) {
540                 ret = -ENODEV;
541                 goto out;
542         } else if (pdev->num_resources == 2) {
543                 base = pdev->resource[0].start;
544
545                 if (!request_mem_region(base, 4, ndev->name)) {
546                         ret = -EBUSY;
547                         goto out;
548                 }
549
550                 ndev->base_addr = base;
551                 ndev->irq = pdev->resource[1].start;
552                 db->io_addr = (void __iomem *)base;
553                 db->io_data = (void __iomem *)(base + 4);
554
555                 /* ensure at least we have a default set of IO routines */
556                 dm9000_set_io(db, 2);
557
558         } else {
559                 db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
560                 db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
561                 db->irq_res  = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
562
563                 if (db->addr_res == NULL || db->data_res == NULL ||
564                     db->irq_res == NULL) {
565                         dev_err(db->dev, "insufficient resources\n");
566                         ret = -ENOENT;
567                         goto out;
568                 }
569
570                 i = res_size(db->addr_res);
571                 db->addr_req = request_mem_region(db->addr_res->start, i,
572                                                   pdev->name);
573
574                 if (db->addr_req == NULL) {
575                         dev_err(db->dev, "cannot claim address reg area\n");
576                         ret = -EIO;
577                         goto out;
578                 }
579
580                 db->io_addr = ioremap(db->addr_res->start, i);
581
582                 if (db->io_addr == NULL) {
583                         dev_err(db->dev, "failed to ioremap address reg\n");
584                         ret = -EINVAL;
585                         goto out;
586                 }
587
588                 iosize = res_size(db->data_res);
589                 db->data_req = request_mem_region(db->data_res->start, iosize,
590                                                   pdev->name);
591
592                 if (db->data_req == NULL) {
593                         dev_err(db->dev, "cannot claim data reg area\n");
594                         ret = -EIO;
595                         goto out;
596                 }
597
598                 db->io_data = ioremap(db->data_res->start, iosize);
599
600                 if (db->io_data == NULL) {
601                         dev_err(db->dev,"failed to ioremap data reg\n");
602                         ret = -EINVAL;
603                         goto out;
604                 }
605
606                 /* fill in parameters for net-dev structure */
607
608                 ndev->base_addr = (unsigned long)db->io_addr;
609                 ndev->irq       = db->irq_res->start;
610
611                 /* ensure at least we have a default set of IO routines */
612                 dm9000_set_io(db, iosize);
613         }
614
615         /* check to see if anything is being over-ridden */
616         if (pdata != NULL) {
617                 /* check to see if the driver wants to over-ride the
618                  * default IO width */
619
620                 if (pdata->flags & DM9000_PLATF_8BITONLY)
621                         dm9000_set_io(db, 1);
622
623                 if (pdata->flags & DM9000_PLATF_16BITONLY)
624                         dm9000_set_io(db, 2);
625
626                 if (pdata->flags & DM9000_PLATF_32BITONLY)
627                         dm9000_set_io(db, 4);
628
629                 /* check to see if there are any IO routine
630                  * over-rides */
631
632                 if (pdata->inblk != NULL)
633                         db->inblk = pdata->inblk;
634
635                 if (pdata->outblk != NULL)
636                         db->outblk = pdata->outblk;
637
638                 if (pdata->dumpblk != NULL)
639                         db->dumpblk = pdata->dumpblk;
640
641                 db->flags = pdata->flags;
642         }
643
644         dm9000_reset(db);
645
646         /* try two times, DM9000 sometimes gets the first read wrong */
647         for (i = 0; i < 8; i++) {
648                 id_val  = ior(db, DM9000_VIDL);
649                 id_val |= (u32)ior(db, DM9000_VIDH) << 8;
650                 id_val |= (u32)ior(db, DM9000_PIDL) << 16;
651                 id_val |= (u32)ior(db, DM9000_PIDH) << 24;
652
653                 if (id_val == DM9000_ID)
654                         break;
655                 dev_err(db->dev, "read wrong id 0x%08x\n", id_val);
656         }
657
658         if (id_val != DM9000_ID) {
659                 dev_err(db->dev, "wrong id: 0x%08x\n", id_val);
660                 ret = -ENODEV;
661                 goto out;
662         }
663
664         /* from this point we assume that we have found a DM9000 */
665
666         /* driver system function */
667         ether_setup(ndev);
668
669         ndev->open               = &dm9000_open;
670         ndev->hard_start_xmit    = &dm9000_start_xmit;
671         ndev->tx_timeout         = &dm9000_timeout;
672         ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
673         ndev->stop               = &dm9000_stop;
674         ndev->set_multicast_list = &dm9000_hash_table;
675         ndev->ethtool_ops        = &dm9000_ethtool_ops;
676         ndev->do_ioctl           = &dm9000_ioctl;
677
678 #ifdef CONFIG_NET_POLL_CONTROLLER
679         ndev->poll_controller    = &dm9000_poll_controller;
680 #endif
681
682         db->msg_enable       = NETIF_MSG_LINK;
683         db->mii.phy_id_mask  = 0x1f;
684         db->mii.reg_num_mask = 0x1f;
685         db->mii.force_media  = 0;
686         db->mii.full_duplex  = 0;
687         db->mii.dev          = ndev;
688         db->mii.mdio_read    = dm9000_phy_read;
689         db->mii.mdio_write   = dm9000_phy_write;
690
691         mac_src = "eeprom";
692
693         /* try reading the node address from the attached EEPROM */
694         for (i = 0; i < 6; i += 2)
695                 dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);
696
697         if (!is_valid_ether_addr(ndev->dev_addr)) {
698                 /* try reading from mac */
699                 
700                 mac_src = "chip";
701                 for (i = 0; i < 6; i++)
702                         ndev->dev_addr[i] = ior(db, i+DM9000_PAR);
703         }
704
705         if (!is_valid_ether_addr(ndev->dev_addr))
706                 dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
707                          "set using ifconfig\n", ndev->name);
708
709         platform_set_drvdata(pdev, ndev);
710         ret = register_netdev(ndev);
711
712         if (ret == 0) {
713                 DECLARE_MAC_BUF(mac);
714                 printk("%s: dm9000 at %p,%p IRQ %d MAC: %s (%s)\n",
715                        ndev->name,  db->io_addr, db->io_data, ndev->irq,
716                        print_mac(mac, ndev->dev_addr), mac_src);
717         }
718         return 0;
719
720 out:
721         dev_err(db->dev, "not found (%d).\n", ret);
722
723         dm9000_release_board(pdev, db);
724         free_netdev(ndev);
725
726         return ret;
727 }
728
729 /*
730  *  Open the interface.
731  *  The interface is opened whenever "ifconfig" actives it.
732  */
733 static int
734 dm9000_open(struct net_device *dev)
735 {
736         board_info_t *db = (board_info_t *) dev->priv;
737         unsigned long irqflags = db->irq_res->flags & IRQF_TRIGGER_MASK;
738
739         if (netif_msg_ifup(db))
740                 dev_dbg(db->dev, "enabling %s\n", dev->name);
741
742         /* If there is no IRQ type specified, default to something that
743          * may work, and tell the user that this is a problem */
744
745         if (irqflags == IRQF_TRIGGER_NONE) {
746                 dev_warn(db->dev, "WARNING: no IRQ resource flags set.\n");
747                 irqflags = DEFAULT_TRIGGER;
748         }
749         
750         irqflags |= IRQF_SHARED;
751
752         if (request_irq(dev->irq, &dm9000_interrupt, irqflags, dev->name, dev))
753                 return -EAGAIN;
754
755         /* Initialize DM9000 board */
756         dm9000_reset(db);
757         dm9000_init_dm9000(dev);
758
759         /* Init driver variable */
760         db->dbug_cnt = 0;
761
762         mii_check_media(&db->mii, netif_msg_link(db), 1);
763         netif_start_queue(dev);
764
765         return 0;
766 }
767
768 /*
769  * Initilize dm9000 board
770  */
771 static void
772 dm9000_init_dm9000(struct net_device *dev)
773 {
774         board_info_t *db = (board_info_t *) dev->priv;
775
776         dm9000_dbg(db, 1, "entering %s\n", __func__);
777
778         /* I/O mode */
779         db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
780
781         /* GPIO0 on pre-activate PHY */
782         iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
783         iow(db, DM9000_GPCR, GPCR_GEP_CNTL);    /* Let GPIO0 output */
784         iow(db, DM9000_GPR, 0); /* Enable PHY */
785
786         if (db->flags & DM9000_PLATF_EXT_PHY)
787                 iow(db, DM9000_NCR, NCR_EXT_PHY);
788
789         /* Program operating register */
790         iow(db, DM9000_TCR, 0);         /* TX Polling clear */
791         iow(db, DM9000_BPTR, 0x3f);     /* Less 3Kb, 200us */
792         iow(db, DM9000_FCR, 0xff);      /* Flow Control */
793         iow(db, DM9000_SMCR, 0);        /* Special Mode */
794         /* clear TX status */
795         iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
796         iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
797
798         /* Set address filter table */
799         dm9000_hash_table(dev);
800
801         /* Enable TX/RX interrupt mask */
802         iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
803
804         /* Init Driver variable */
805         db->tx_pkt_cnt = 0;
806         db->queue_pkt_len = 0;
807         dev->trans_start = 0;
808 }
809
810 /*
811  *  Hardware start transmission.
812  *  Send a packet to media from the upper layer.
813  */
814 static int
815 dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
816 {
817         unsigned long flags;
818         board_info_t *db = (board_info_t *) dev->priv;
819
820         dm9000_dbg(db, 3, "%s:\n", __func__);
821
822         if (db->tx_pkt_cnt > 1)
823                 return 1;
824
825         spin_lock_irqsave(&db->lock, flags);
826
827         /* Move data to DM9000 TX RAM */
828         writeb(DM9000_MWCMD, db->io_addr);
829
830         (db->outblk)(db->io_data, skb->data, skb->len);
831         dev->stats.tx_bytes += skb->len;
832
833         db->tx_pkt_cnt++;
834         /* TX control: First packet immediately send, second packet queue */
835         if (db->tx_pkt_cnt == 1) {
836                 /* Set TX length to DM9000 */
837                 iow(db, DM9000_TXPLL, skb->len);
838                 iow(db, DM9000_TXPLH, skb->len >> 8);
839
840                 /* Issue TX polling command */
841                 iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
842
843                 dev->trans_start = jiffies;     /* save the time stamp */
844         } else {
845                 /* Second packet */
846                 db->queue_pkt_len = skb->len;
847                 netif_stop_queue(dev);
848         }
849
850         spin_unlock_irqrestore(&db->lock, flags);
851
852         /* free this SKB */
853         dev_kfree_skb(skb);
854
855         return 0;
856 }
857
858 static void
859 dm9000_shutdown(struct net_device *dev)
860 {
861         board_info_t *db = (board_info_t *) dev->priv;
862
863         /* RESET device */
864         dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
865         iow(db, DM9000_GPR, 0x01);      /* Power-Down PHY */
866         iow(db, DM9000_IMR, IMR_PAR);   /* Disable all interrupt */
867         iow(db, DM9000_RCR, 0x00);      /* Disable RX */
868 }
869
870 /*
871  * Stop the interface.
872  * The interface is stopped when it is brought.
873  */
874 static int
875 dm9000_stop(struct net_device *ndev)
876 {
877         board_info_t *db = (board_info_t *) ndev->priv;
878
879         if (netif_msg_ifdown(db))
880                 dev_dbg(db->dev, "shutting down %s\n", ndev->name);
881
882         netif_stop_queue(ndev);
883         netif_carrier_off(ndev);
884
885         /* free interrupt */
886         free_irq(ndev->irq, ndev);
887
888         dm9000_shutdown(ndev);
889
890         return 0;
891 }
892
893 /*
894  * DM9000 interrupt handler
895  * receive the packet to upper layer, free the transmitted packet
896  */
897
898 static void
899 dm9000_tx_done(struct net_device *dev, board_info_t * db)
900 {
901         int tx_status = ior(db, DM9000_NSR);    /* Got TX status */
902
903         if (tx_status & (NSR_TX2END | NSR_TX1END)) {
904                 /* One packet sent complete */
905                 db->tx_pkt_cnt--;
906                 dev->stats.tx_packets++;
907
908                 if (netif_msg_tx_done(db))
909                         dev_dbg(db->dev, "tx done, NSR %02x\n", tx_status);
910
911                 /* Queue packet check & send */
912                 if (db->tx_pkt_cnt > 0) {
913                         iow(db, DM9000_TXPLL, db->queue_pkt_len);
914                         iow(db, DM9000_TXPLH, db->queue_pkt_len >> 8);
915                         iow(db, DM9000_TCR, TCR_TXREQ);
916                         dev->trans_start = jiffies;
917                 }
918                 netif_wake_queue(dev);
919         }
920 }
921
922 static irqreturn_t
923 dm9000_interrupt(int irq, void *dev_id)
924 {
925         struct net_device *dev = dev_id;
926         board_info_t *db = (board_info_t *) dev->priv;
927         int int_status;
928         u8 reg_save;
929
930         dm9000_dbg(db, 3, "entering %s\n", __func__);
931
932         /* A real interrupt coming */
933
934         spin_lock(&db->lock);
935
936         /* Save previous register address */
937         reg_save = readb(db->io_addr);
938
939         /* Disable all interrupts */
940         iow(db, DM9000_IMR, IMR_PAR);
941
942         /* Got DM9000 interrupt status */
943         int_status = ior(db, DM9000_ISR);       /* Got ISR */
944         iow(db, DM9000_ISR, int_status);        /* Clear ISR status */
945
946         if (netif_msg_intr(db))
947                 dev_dbg(db->dev, "interrupt status %02x\n", int_status);
948
949         /* Received the coming packet */
950         if (int_status & ISR_PRS)
951                 dm9000_rx(dev);
952
953         /* Trnasmit Interrupt check */
954         if (int_status & ISR_PTS)
955                 dm9000_tx_done(dev, db);
956
957         /* Re-enable interrupt mask */
958         iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
959
960         /* Restore previous register address */
961         writeb(reg_save, db->io_addr);
962
963         spin_unlock(&db->lock);
964
965         return IRQ_HANDLED;
966 }
967
968 struct dm9000_rxhdr {
969         u8      RxPktReady;
970         u8      RxStatus;
971         __le16  RxLen;
972 } __attribute__((__packed__));
973
974 /*
975  *  Received a packet and pass to upper layer
976  */
977 static void
978 dm9000_rx(struct net_device *dev)
979 {
980         board_info_t *db = (board_info_t *) dev->priv;
981         struct dm9000_rxhdr rxhdr;
982         struct sk_buff *skb;
983         u8 rxbyte, *rdptr;
984         bool GoodPacket;
985         int RxLen;
986
987         /* Check packet ready or not */
988         do {
989                 ior(db, DM9000_MRCMDX); /* Dummy read */
990
991                 /* Get most updated data */
992                 rxbyte = readb(db->io_data);
993
994                 /* Status check: this byte must be 0 or 1 */
995                 if (rxbyte > DM9000_PKT_RDY) {
996                         dev_warn(db->dev, "status check fail: %d\n", rxbyte);
997                         iow(db, DM9000_RCR, 0x00);      /* Stop Device */
998                         iow(db, DM9000_ISR, IMR_PAR);   /* Stop INT request */
999                         return;
1000                 }
1001
1002                 if (rxbyte != DM9000_PKT_RDY)
1003                         return;
1004
1005                 /* A packet ready now  & Get status/length */
1006                 GoodPacket = true;
1007                 writeb(DM9000_MRCMD, db->io_addr);
1008
1009                 (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
1010
1011                 RxLen = le16_to_cpu(rxhdr.RxLen);
1012
1013                 if (netif_msg_rx_status(db))
1014                         dev_dbg(db->dev, "RX: status %02x, length %04x\n",
1015                                 rxhdr.RxStatus, RxLen);
1016
1017                 /* Packet Status check */
1018                 if (RxLen < 0x40) {
1019                         GoodPacket = false;
1020                         if (netif_msg_rx_err(db))
1021                                 dev_dbg(db->dev, "RX: Bad Packet (runt)\n");
1022                 }
1023
1024                 if (RxLen > DM9000_PKT_MAX) {
1025                         dev_dbg(db->dev, "RST: RX Len:%x\n", RxLen);
1026                 }
1027
1028                 if (rxhdr.RxStatus & 0xbf) {
1029                         GoodPacket = false;
1030                         if (rxhdr.RxStatus & 0x01) {
1031                                 if (netif_msg_rx_err(db))
1032                                         dev_dbg(db->dev, "fifo error\n");
1033                                 dev->stats.rx_fifo_errors++;
1034                         }
1035                         if (rxhdr.RxStatus & 0x02) {
1036                                 if (netif_msg_rx_err(db))
1037                                         dev_dbg(db->dev, "crc error\n");
1038                                 dev->stats.rx_crc_errors++;
1039                         }
1040                         if (rxhdr.RxStatus & 0x80) {
1041                                 if (netif_msg_rx_err(db))
1042                                         dev_dbg(db->dev, "length error\n");
1043                                 dev->stats.rx_length_errors++;
1044                         }
1045                 }
1046
1047                 /* Move data from DM9000 */
1048                 if (GoodPacket
1049                     && ((skb = dev_alloc_skb(RxLen + 4)) != NULL)) {
1050                         skb_reserve(skb, 2);
1051                         rdptr = (u8 *) skb_put(skb, RxLen - 4);
1052
1053                         /* Read received packet from RX SRAM */
1054
1055                         (db->inblk)(db->io_data, rdptr, RxLen);
1056                         dev->stats.rx_bytes += RxLen;
1057
1058                         /* Pass to upper layer */
1059                         skb->protocol = eth_type_trans(skb, dev);
1060                         netif_rx(skb);
1061                         dev->stats.rx_packets++;
1062
1063                 } else {
1064                         /* need to dump the packet's data */
1065
1066                         (db->dumpblk)(db->io_data, RxLen);
1067                 }
1068         } while (rxbyte == DM9000_PKT_RDY);
1069 }
1070
1071 static unsigned int
1072 dm9000_read_locked(board_info_t *db, int reg)
1073 {
1074         unsigned long flags;
1075         unsigned int ret;
1076
1077         spin_lock_irqsave(&db->lock, flags);
1078         ret = ior(db, reg);
1079         spin_unlock_irqrestore(&db->lock, flags);
1080
1081         return ret;
1082 }
1083
1084 static int dm9000_wait_eeprom(board_info_t *db)
1085 {
1086         unsigned int status;
1087         int timeout = 8;        /* wait max 8msec */
1088
1089         /* The DM9000 data sheets say we should be able to
1090          * poll the ERRE bit in EPCR to wait for the EEPROM
1091          * operation. From testing several chips, this bit
1092          * does not seem to work. 
1093          *
1094          * We attempt to use the bit, but fall back to the
1095          * timeout (which is why we do not return an error
1096          * on expiry) to say that the EEPROM operation has
1097          * completed.
1098          */
1099
1100         while (1) {
1101                 status = dm9000_read_locked(db, DM9000_EPCR);
1102
1103                 if ((status & EPCR_ERRE) == 0)
1104                         break;
1105
1106                 if (timeout-- < 0) {
1107                         dev_dbg(db->dev, "timeout waiting EEPROM\n");
1108                         break;
1109                 }
1110         }
1111
1112         return 0;
1113 }
1114
1115 /*
1116  *  Read a word data from EEPROM
1117  */
1118 static void
1119 dm9000_read_eeprom(board_info_t *db, int offset, u8 *to)
1120 {
1121         unsigned long flags;
1122
1123         if (db->flags & DM9000_PLATF_NO_EEPROM) {
1124                 to[0] = 0xff;
1125                 to[1] = 0xff;
1126                 return;
1127         }
1128
1129         mutex_lock(&db->addr_lock);
1130
1131         spin_lock_irqsave(&db->lock, flags);
1132
1133         iow(db, DM9000_EPAR, offset);
1134         iow(db, DM9000_EPCR, EPCR_ERPRR);
1135
1136         spin_unlock_irqrestore(&db->lock, flags);
1137
1138         dm9000_wait_eeprom(db);
1139
1140         /* delay for at-least 150uS */
1141         msleep(1);
1142
1143         spin_lock_irqsave(&db->lock, flags);
1144
1145         iow(db, DM9000_EPCR, 0x0);
1146
1147         to[0] = ior(db, DM9000_EPDRL);
1148         to[1] = ior(db, DM9000_EPDRH);
1149
1150         spin_unlock_irqrestore(&db->lock, flags);
1151
1152         mutex_unlock(&db->addr_lock);
1153 }
1154
1155 /*
1156  * Write a word data to SROM
1157  */
1158 static void
1159 dm9000_write_eeprom(board_info_t *db, int offset, u8 *data)
1160 {
1161         unsigned long flags;
1162
1163         if (db->flags & DM9000_PLATF_NO_EEPROM)
1164                 return;
1165
1166         mutex_lock(&db->addr_lock);
1167
1168         spin_lock_irqsave(&db->lock, flags);
1169         iow(db, DM9000_EPAR, offset);
1170         iow(db, DM9000_EPDRH, data[1]);
1171         iow(db, DM9000_EPDRL, data[0]);
1172         iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
1173         spin_unlock_irqrestore(&db->lock, flags);
1174
1175         dm9000_wait_eeprom(db);
1176
1177         mdelay(1);      /* wait at least 150uS to clear */
1178
1179         spin_lock_irqsave(&db->lock, flags);
1180         iow(db, DM9000_EPCR, 0);
1181         spin_unlock_irqrestore(&db->lock, flags);
1182
1183         mutex_unlock(&db->addr_lock);
1184 }
1185
1186 /*
1187  *  Set DM9000 multicast address
1188  */
1189 static void
1190 dm9000_hash_table(struct net_device *dev)
1191 {
1192         board_info_t *db = (board_info_t *) dev->priv;
1193         struct dev_mc_list *mcptr = dev->mc_list;
1194         int mc_cnt = dev->mc_count;
1195         int i, oft;
1196         u32 hash_val;
1197         u16 hash_table[4];
1198         u8 rcr = RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN;
1199         unsigned long flags;
1200
1201         dm9000_dbg(db, 1, "entering %s\n", __func__);
1202
1203         spin_lock_irqsave(&db->lock, flags);
1204
1205         for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
1206                 iow(db, oft, dev->dev_addr[i]);
1207
1208         /* Clear Hash Table */
1209         for (i = 0; i < 4; i++)
1210                 hash_table[i] = 0x0;
1211
1212         /* broadcast address */
1213         hash_table[3] = 0x8000;
1214
1215         if (dev->flags & IFF_PROMISC)
1216                 rcr |= RCR_PRMSC;
1217
1218         if (dev->flags & IFF_ALLMULTI)
1219                 rcr |= RCR_ALL;
1220
1221         /* the multicast address in Hash Table : 64 bits */
1222         for (i = 0; i < mc_cnt; i++, mcptr = mcptr->next) {
1223                 hash_val = ether_crc_le(6, mcptr->dmi_addr) & 0x3f;
1224                 hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
1225         }
1226
1227         /* Write the hash table to MAC MD table */
1228         for (i = 0, oft = DM9000_MAR; i < 4; i++) {
1229                 iow(db, oft++, hash_table[i]);
1230                 iow(db, oft++, hash_table[i] >> 8);
1231         }
1232
1233         iow(db, DM9000_RCR, rcr);
1234         spin_unlock_irqrestore(&db->lock, flags);
1235 }
1236
1237
1238 /*
1239  * Sleep, either by using msleep() or if we are suspending, then
1240  * use mdelay() to sleep.
1241  */
1242 static void dm9000_msleep(board_info_t *db, unsigned int ms)
1243 {
1244         if (db->in_suspend)
1245                 mdelay(ms);
1246         else
1247                 msleep(ms);
1248 }
1249
1250 /*
1251  *   Read a word from phyxcer
1252  */
1253 static int
1254 dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
1255 {
1256         board_info_t *db = (board_info_t *) dev->priv;
1257         unsigned long flags;
1258         unsigned int reg_save;
1259         int ret;
1260
1261         mutex_lock(&db->addr_lock);
1262
1263         spin_lock_irqsave(&db->lock,flags);
1264
1265         /* Save previous register address */
1266         reg_save = readb(db->io_addr);
1267
1268         /* Fill the phyxcer register into REG_0C */
1269         iow(db, DM9000_EPAR, DM9000_PHY | reg);
1270
1271         iow(db, DM9000_EPCR, 0xc);      /* Issue phyxcer read command */
1272
1273         writeb(reg_save, db->io_addr);
1274         spin_unlock_irqrestore(&db->lock,flags);
1275
1276         dm9000_msleep(db, 1);           /* Wait read complete */
1277
1278         spin_lock_irqsave(&db->lock,flags);
1279         reg_save = readb(db->io_addr);
1280
1281         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer read command */
1282
1283         /* The read data keeps on REG_0D & REG_0E */
1284         ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
1285
1286         /* restore the previous address */
1287         writeb(reg_save, db->io_addr);
1288         spin_unlock_irqrestore(&db->lock,flags);
1289
1290         mutex_unlock(&db->addr_lock);
1291         return ret;
1292 }
1293
1294 /*
1295  *   Write a word to phyxcer
1296  */
1297 static void
1298 dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg, int value)
1299 {
1300         board_info_t *db = (board_info_t *) dev->priv;
1301         unsigned long flags;
1302         unsigned long reg_save;
1303
1304         mutex_lock(&db->addr_lock);
1305
1306         spin_lock_irqsave(&db->lock,flags);
1307
1308         /* Save previous register address */
1309         reg_save = readb(db->io_addr);
1310
1311         /* Fill the phyxcer register into REG_0C */
1312         iow(db, DM9000_EPAR, DM9000_PHY | reg);
1313
1314         /* Fill the written data into REG_0D & REG_0E */
1315         iow(db, DM9000_EPDRL, value);
1316         iow(db, DM9000_EPDRH, value >> 8);
1317
1318         iow(db, DM9000_EPCR, 0xa);      /* Issue phyxcer write command */
1319
1320         writeb(reg_save, db->io_addr);
1321         spin_unlock_irqrestore(&db->lock, flags);
1322
1323         dm9000_msleep(db, 1);           /* Wait write complete */
1324
1325         spin_lock_irqsave(&db->lock,flags);
1326         reg_save = readb(db->io_addr);
1327
1328         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer write command */
1329
1330         /* restore the previous address */
1331         writeb(reg_save, db->io_addr);
1332
1333         spin_unlock_irqrestore(&db->lock, flags);
1334         mutex_unlock(&db->addr_lock);
1335 }
1336
1337 static int
1338 dm9000_drv_suspend(struct platform_device *dev, pm_message_t state)
1339 {
1340         struct net_device *ndev = platform_get_drvdata(dev);
1341         board_info_t *db;
1342
1343         if (ndev) {
1344                 db = (board_info_t *) ndev->priv;
1345                 db->in_suspend = 1;
1346
1347                 if (netif_running(ndev)) {
1348                         netif_device_detach(ndev);
1349                         dm9000_shutdown(ndev);
1350                 }
1351         }
1352         return 0;
1353 }
1354
1355 static int
1356 dm9000_drv_resume(struct platform_device *dev)
1357 {
1358         struct net_device *ndev = platform_get_drvdata(dev);
1359         board_info_t *db = (board_info_t *) ndev->priv;
1360
1361         if (ndev) {
1362
1363                 if (netif_running(ndev)) {
1364                         dm9000_reset(db);
1365                         dm9000_init_dm9000(ndev);
1366
1367                         netif_device_attach(ndev);
1368                 }
1369
1370                 db->in_suspend = 0;
1371         }
1372         return 0;
1373 }
1374
1375 static int
1376 dm9000_drv_remove(struct platform_device *pdev)
1377 {
1378         struct net_device *ndev = platform_get_drvdata(pdev);
1379
1380         platform_set_drvdata(pdev, NULL);
1381
1382         unregister_netdev(ndev);
1383         dm9000_release_board(pdev, (board_info_t *) ndev->priv);
1384         free_netdev(ndev);              /* free device structure */
1385
1386         dev_dbg(&pdev->dev, "released and freed device\n");
1387         return 0;
1388 }
1389
1390 static struct platform_driver dm9000_driver = {
1391         .driver = {
1392                 .name    = "dm9000",
1393                 .owner   = THIS_MODULE,
1394         },
1395         .probe   = dm9000_probe,
1396         .remove  = dm9000_drv_remove,
1397         .suspend = dm9000_drv_suspend,
1398         .resume  = dm9000_drv_resume,
1399 };
1400
1401 static int __init
1402 dm9000_init(void)
1403 {
1404         printk(KERN_INFO "%s Ethernet Driver, V%s\n", CARDNAME, DRV_VERSION);
1405
1406         return platform_driver_register(&dm9000_driver);        /* search board and register */
1407 }
1408
1409 static void __exit
1410 dm9000_cleanup(void)
1411 {
1412         platform_driver_unregister(&dm9000_driver);
1413 }
1414
1415 module_init(dm9000_init);
1416 module_exit(dm9000_cleanup);
1417
1418 MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1419 MODULE_DESCRIPTION("Davicom DM9000 network driver");
1420 MODULE_LICENSE("GPL");
1421 MODULE_ALIAS("platform:dm9000");