drivers/net/ethernet/davicom/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/interrupt.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/crc32.h>
  30 #include <linux/mii.h>
  31 #include <linux/of.h>
  32 #include <linux/of_net.h>
  33 #include <linux/ethtool.h>
  34 #include <linux/dm9000.h>
  35 #include <linux/delay.h>
  36 #include <linux/platform_device.h>
  37 #include <linux/irq.h>
  38 #include <linux/slab.h>
  39 #include <linux/regulator/consumer.h>
  40 #include <linux/gpio.h>
  41 #include <linux/of_gpio.h>
  42
  43 #include <asm/delay.h>
  44 #include <asm/irq.h>
  45 #include <asm/io.h>
  46
  47 #include "dm9000.h"
  48
  49 /* Board/System/Debug information/definition ---------------- */
  50
  51 #define DM9000_PHY              0x40    /* PHY address 0x01 */
  52
  53 #define CARDNAME        "dm9000"
  54 #define DRV_VERSION     "1.31"
  55
  56 /*
  57  * Transmit timeout, default 5 seconds.
  58  */
  59 static int watchdog = 5000;
  60 module_param(watchdog, int, 0400);
  61 MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
  62
  63 /*
  64  * Debug messages level
  65  */
  66 static int debug;
  67 module_param(debug, int, 0644);
  68 MODULE_PARM_DESC(debug, "dm9000 debug level (0-4)");
  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 /* The driver supports the original DM9000E, and now the two newer
  89  * devices, DM9000A and DM9000B.
  90  */
  91
  92 enum dm9000_type {
  93         TYPE_DM9000E,   /* original DM9000 */
  94         TYPE_DM9000A,
  95         TYPE_DM9000B
  96 };
  97
  98 /* Structure/enum declaration ------------------------------- */
  99 struct board_info {
 100
 101         void __iomem    *io_addr;       /* Register I/O base address */
 102         void __iomem    *io_data;       /* Data I/O address */
 103         u16              irq;           /* IRQ */
 104
 105         u16             tx_pkt_cnt;
 106         u16             queue_pkt_len;
 107         u16             queue_start_addr;
 108         u16             queue_ip_summed;
 109         u16             dbug_cnt;
 110         u8              io_mode;                /* 0:word, 2:byte */
 111         u8              phy_addr;
 112         u8              imr_all;
 113
 114         unsigned int    flags;
 115         unsigned int    in_timeout:1;
 116         unsigned int    in_suspend:1;
 117         unsigned int    wake_supported:1;
 118
 119         enum dm9000_type type;
 120
 121         void (*inblk)(void __iomem *port, void *data, int length);
 122         void (*outblk)(void __iomem *port, void *data, int length);
 123         void (*dumpblk)(void __iomem *port, int length);
 124
 125         struct device   *dev;        /* parent device */
 126
 127         struct resource *addr_res;   /* resources found */
 128         struct resource *data_res;
 129         struct resource *addr_req;   /* resources requested */
 130         struct resource *data_req;
 131         struct resource *irq_res;
 132
 133         int              irq_wake;
 134
 135         struct mutex     addr_lock;     /* phy and eeprom access lock */
 136
 137         struct delayed_work phy_poll;
 138         struct net_device  *ndev;
 139
 140         spinlock_t      lock;
 141
 142         struct mii_if_info mii;
 143         u32             msg_enable;
 144         u32             wake_state;
 145
 146         int             ip_summed;
 147
 148         struct regulator *power_supply;
 149 };
 150
 151 /* debug code */
 152
 153 #define dm9000_dbg(db, lev, msg...) do {                \
 154         if ((lev) < debug) {                            \
 155                 dev_dbg(db->dev, msg);                  \
 156         }                                               \
 157 } while (0)
 158
 159 static inline struct board_info *to_dm9000_board(struct net_device *dev)
 160 {
 161         return netdev_priv(dev);
 162 }
 163
 164 /* DM9000 network board routine ---------------------------- */
 165
 166 /*
 167  *   Read a byte from I/O port
 168  */
 169 static u8
 170 ior(struct board_info *db, int reg)
 171 {
 172         writeb(reg, db->io_addr);
 173         return readb(db->io_data);
 174 }
 175
 176 /*
 177  *   Write a byte to I/O port
 178  */
 179
 180 static void
 181 iow(struct board_info *db, int reg, int value)
 182 {
 183         writeb(reg, db->io_addr);
 184         writeb(value, db->io_data);
 185 }
 186
 187 static void
 188 dm9000_reset(struct board_info *db)
 189 {
 190         dev_dbg(db->dev, "resetting device\n");
 191
 192         /* Reset DM9000, see DM9000 Application Notes V1.22 Jun 11, 2004 page 29
 193          * The essential point is that we have to do a double reset, and the
 194          * instruction is to set LBK into MAC internal loopback mode.
 195          */
 196         iow(db, DM9000_NCR, NCR_RST | NCR_MAC_LBK);
 197         udelay(100); /* Application note says at least 20 us */
 198         if (ior(db, DM9000_NCR) & 1)
 199                 dev_err(db->dev, "dm9000 did not respond to first reset\n");
 200
 201         iow(db, DM9000_NCR, 0);
 202         iow(db, DM9000_NCR, NCR_RST | NCR_MAC_LBK);
 203         udelay(100);
 204         if (ior(db, DM9000_NCR) & 1)
 205                 dev_err(db->dev, "dm9000 did not respond to second reset\n");
 206 }
 207
 208 /* routines for sending block to chip */
 209
 210 static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
 211 {
 212         iowrite8_rep(reg, data, count);
 213 }
 214
 215 static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
 216 {
 217         iowrite16_rep(reg, data, (count+1) >> 1);
 218 }
 219
 220 static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
 221 {
 222         iowrite32_rep(reg, data, (count+3) >> 2);
 223 }
 224
 225 /* input block from chip to memory */
 226
 227 static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
 228 {
 229         ioread8_rep(reg, data, count);
 230 }
 231
 232
 233 static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
 234 {
 235         ioread16_rep(reg, data, (count+1) >> 1);
 236 }
 237
 238 static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
 239 {
 240         ioread32_rep(reg, data, (count+3) >> 2);
 241 }
 242
 243 /* dump block from chip to null */
 244
 245 static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
 246 {
 247         int i;
 248         int tmp;
 249
 250         for (i = 0; i < count; i++)
 251                 tmp = readb(reg);
 252 }
 253
 254 static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
 255 {
 256         int i;
 257         int tmp;
 258
 259         count = (count + 1) >> 1;
 260
 261         for (i = 0; i < count; i++)
 262                 tmp = readw(reg);
 263 }
 264
 265 static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
 266 {
 267         int i;
 268         int tmp;
 269
 270         count = (count + 3) >> 2;
 271
 272         for (i = 0; i < count; i++)
 273                 tmp = readl(reg);
 274 }
 275
 276 /*
 277  * Sleep, either by using msleep() or if we are suspending, then
 278  * use mdelay() to sleep.
 279  */
 280 static void dm9000_msleep(struct board_info *db, unsigned int ms)
 281 {
 282         if (db->in_suspend || db->in_timeout)
 283                 mdelay(ms);
 284         else
 285                 msleep(ms);
 286 }
 287
 288 /* Read a word from phyxcer */
 289 static int
 290 dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
 291 {
 292         struct board_info *db = netdev_priv(dev);
 293         unsigned long flags;
 294         unsigned int reg_save;
 295         int ret;
 296
 297         mutex_lock(&db->addr_lock);
 298
 299         spin_lock_irqsave(&db->lock, flags);
 300
 301         /* Save previous register address */
 302         reg_save = readb(db->io_addr);
 303
 304         /* Fill the phyxcer register into REG_0C */
 305         iow(db, DM9000_EPAR, DM9000_PHY | reg);
 306
 307         /* Issue phyxcer read command */
 308         iow(db, DM9000_EPCR, EPCR_ERPRR | EPCR_EPOS);
 309
 310         writeb(reg_save, db->io_addr);
 311         spin_unlock_irqrestore(&db->lock, flags);
 312
 313         dm9000_msleep(db, 1);           /* Wait read complete */
 314
 315         spin_lock_irqsave(&db->lock, flags);
 316         reg_save = readb(db->io_addr);
 317
 318         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer read command */
 319
 320         /* The read data keeps on REG_0D & REG_0E */
 321         ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
 322
 323         /* restore the previous address */
 324         writeb(reg_save, db->io_addr);
 325         spin_unlock_irqrestore(&db->lock, flags);
 326
 327         mutex_unlock(&db->addr_lock);
 328
 329         dm9000_dbg(db, 5, "phy_read[%02x] -> %04x\n", reg, ret);
 330         return ret;
 331 }
 332
 333 /* Write a word to phyxcer */
 334 static void
 335 dm9000_phy_write(struct net_device *dev,
 336                  int phyaddr_unused, int reg, int value)
 337 {
 338         struct board_info *db = netdev_priv(dev);
 339         unsigned long flags;
 340         unsigned long reg_save;
 341
 342         dm9000_dbg(db, 5, "phy_write[%02x] = %04x\n", reg, value);
 343         if (!db->in_timeout)
 344                 mutex_lock(&db->addr_lock);
 345
 346         spin_lock_irqsave(&db->lock, flags);
 347
 348         /* Save previous register address */
 349         reg_save = readb(db->io_addr);
 350
 351         /* Fill the phyxcer register into REG_0C */
 352         iow(db, DM9000_EPAR, DM9000_PHY | reg);
 353
 354         /* Fill the written data into REG_0D & REG_0E */
 355         iow(db, DM9000_EPDRL, value);
 356         iow(db, DM9000_EPDRH, value >> 8);
 357
 358         /* Issue phyxcer write command */
 359         iow(db, DM9000_EPCR, EPCR_EPOS | EPCR_ERPRW);
 360
 361         writeb(reg_save, db->io_addr);
 362         spin_unlock_irqrestore(&db->lock, flags);
 363
 364         dm9000_msleep(db, 1);           /* Wait write complete */
 365
 366         spin_lock_irqsave(&db->lock, flags);
 367         reg_save = readb(db->io_addr);
 368
 369         iow(db, DM9000_EPCR, 0x0);      /* Clear phyxcer write command */
 370
 371         /* restore the previous address */
 372         writeb(reg_save, db->io_addr);
 373
 374         spin_unlock_irqrestore(&db->lock, flags);
 375         if (!db->in_timeout)
 376                 mutex_unlock(&db->addr_lock);
 377 }
 378
 379 /* dm9000_set_io
 380  *
 381  * select the specified set of io routines to use with the
 382  * device
 383  */
 384
 385 static void dm9000_set_io(struct board_info *db, int byte_width)
 386 {
 387         /* use the size of the data resource to work out what IO
 388          * routines we want to use
 389          */
 390
 391         switch (byte_width) {
 392         case 1:
 393                 db->dumpblk = dm9000_dumpblk_8bit;
 394                 db->outblk  = dm9000_outblk_8bit;
 395                 db->inblk   = dm9000_inblk_8bit;
 396                 break;
 397
 398
 399         case 3:
 400                 dev_dbg(db->dev, ": 3 byte IO, falling back to 16bit\n");
 401         case 2:
 402                 db->dumpblk = dm9000_dumpblk_16bit;
 403                 db->outblk  = dm9000_outblk_16bit;
 404                 db->inblk   = dm9000_inblk_16bit;
 405                 break;
 406
 407         case 4:
 408         default:
 409                 db->dumpblk = dm9000_dumpblk_32bit;
 410                 db->outblk  = dm9000_outblk_32bit;
 411                 db->inblk   = dm9000_inblk_32bit;
 412                 break;
 413         }
 414 }
 415
 416 static void dm9000_schedule_poll(struct board_info *db)
 417 {
 418         if (db->type == TYPE_DM9000E)
 419                 schedule_delayed_work(&db->phy_poll, HZ * 2);
 420 }
 421
 422 static int dm9000_ioctl(struct net_device *dev, struct ifreq *req, int cmd)
 423 {
 424         struct board_info *dm = to_dm9000_board(dev);
 425
 426         if (!netif_running(dev))
 427                 return -EINVAL;
 428
 429         return generic_mii_ioctl(&dm->mii, if_mii(req), cmd, NULL);
 430 }
 431
 432 static unsigned int
 433 dm9000_read_locked(struct board_info *db, int reg)
 434 {
 435         unsigned long flags;
 436         unsigned int ret;
 437
 438         spin_lock_irqsave(&db->lock, flags);
 439         ret = ior(db, reg);
 440         spin_unlock_irqrestore(&db->lock, flags);
 441
 442         return ret;
 443 }
 444
 445 static int dm9000_wait_eeprom(struct board_info *db)
 446 {
 447         unsigned int status;
 448         int timeout = 8;        /* wait max 8msec */
 449
 450         /* The DM9000 data sheets say we should be able to
 451          * poll the ERRE bit in EPCR to wait for the EEPROM
 452          * operation. From testing several chips, this bit
 453          * does not seem to work.
 454          *
 455          * We attempt to use the bit, but fall back to the
 456          * timeout (which is why we do not return an error
 457          * on expiry) to say that the EEPROM operation has
 458          * completed.
 459          */
 460
 461         while (1) {
 462                 status = dm9000_read_locked(db, DM9000_EPCR);
 463
 464                 if ((status & EPCR_ERRE) == 0)
 465                         break;
 466
 467                 msleep(1);
 468
 469                 if (timeout-- < 0) {
 470                         dev_dbg(db->dev, "timeout waiting EEPROM\n");
 471                         break;
 472                 }
 473         }
 474
 475         return 0;
 476 }
 477
 478 /*
 479  *  Read a word data from EEPROM
 480  */
 481 static void
 482 dm9000_read_eeprom(struct board_info *db, int offset, u8 *to)
 483 {
 484         unsigned long flags;
 485
 486         if (db->flags & DM9000_PLATF_NO_EEPROM) {
 487                 to[0] = 0xff;
 488                 to[1] = 0xff;
 489                 return;
 490         }
 491
 492         mutex_lock(&db->addr_lock);
 493
 494         spin_lock_irqsave(&db->lock, flags);
 495
 496         iow(db, DM9000_EPAR, offset);
 497         iow(db, DM9000_EPCR, EPCR_ERPRR);
 498
 499         spin_unlock_irqrestore(&db->lock, flags);
 500
 501         dm9000_wait_eeprom(db);
 502
 503         /* delay for at-least 150uS */
 504         msleep(1);
 505
 506         spin_lock_irqsave(&db->lock, flags);
 507
 508         iow(db, DM9000_EPCR, 0x0);
 509
 510         to[0] = ior(db, DM9000_EPDRL);
 511         to[1] = ior(db, DM9000_EPDRH);
 512
 513         spin_unlock_irqrestore(&db->lock, flags);
 514
 515         mutex_unlock(&db->addr_lock);
 516 }
 517
 518 /*
 519  * Write a word data to SROM
 520  */
 521 static void
 522 dm9000_write_eeprom(struct board_info *db, int offset, u8 *data)
 523 {
 524         unsigned long flags;
 525
 526         if (db->flags & DM9000_PLATF_NO_EEPROM)
 527                 return;
 528
 529         mutex_lock(&db->addr_lock);
 530
 531         spin_lock_irqsave(&db->lock, flags);
 532         iow(db, DM9000_EPAR, offset);
 533         iow(db, DM9000_EPDRH, data[1]);
 534         iow(db, DM9000_EPDRL, data[0]);
 535         iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
 536         spin_unlock_irqrestore(&db->lock, flags);
 537
 538         dm9000_wait_eeprom(db);
 539
 540         mdelay(1);      /* wait at least 150uS to clear */
 541
 542         spin_lock_irqsave(&db->lock, flags);
 543         iow(db, DM9000_EPCR, 0);
 544         spin_unlock_irqrestore(&db->lock, flags);
 545
 546         mutex_unlock(&db->addr_lock);
 547 }
 548
 549 /* ethtool ops */
 550
 551 static void dm9000_get_drvinfo(struct net_device *dev,
 552                                struct ethtool_drvinfo *info)
 553 {
 554         struct board_info *dm = to_dm9000_board(dev);
 555
 556         strlcpy(info->driver, CARDNAME, sizeof(info->driver));
 557         strlcpy(info->version, DRV_VERSION, sizeof(info->version));
 558         strlcpy(info->bus_info, to_platform_device(dm->dev)->name,
 559                 sizeof(info->bus_info));
 560 }
 561
 562 static u32 dm9000_get_msglevel(struct net_device *dev)
 563 {
 564         struct board_info *dm = to_dm9000_board(dev);
 565
 566         return dm->msg_enable;
 567 }
 568
 569 static void dm9000_set_msglevel(struct net_device *dev, u32 value)
 570 {
 571         struct board_info *dm = to_dm9000_board(dev);
 572
 573         dm->msg_enable = value;
 574 }
 575
 576 static int dm9000_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
 577 {
 578         struct board_info *dm = to_dm9000_board(dev);
 579
 580         mii_ethtool_gset(&dm->mii, cmd);
 581         return 0;
 582 }
 583
 584 static int dm9000_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
 585 {
 586         struct board_info *dm = to_dm9000_board(dev);
 587
 588         return mii_ethtool_sset(&dm->mii, cmd);
 589 }
 590
 591 static int dm9000_nway_reset(struct net_device *dev)
 592 {
 593         struct board_info *dm = to_dm9000_board(dev);
 594         return mii_nway_restart(&dm->mii);
 595 }
 596
 597 static int dm9000_set_features(struct net_device *dev,
 598         netdev_features_t features)
 599 {
 600         struct board_info *dm = to_dm9000_board(dev);
 601         netdev_features_t changed = dev->features ^ features;
 602         unsigned long flags;
 603
 604         if (!(changed & NETIF_F_RXCSUM))
 605                 return 0;
 606
 607         spin_lock_irqsave(&dm->lock, flags);
 608         iow(dm, DM9000_RCSR, (features & NETIF_F_RXCSUM) ? RCSR_CSUM : 0);
 609         spin_unlock_irqrestore(&dm->lock, flags);
 610
 611         return 0;
 612 }
 613
 614 static u32 dm9000_get_link(struct net_device *dev)
 615 {
 616         struct board_info *dm = to_dm9000_board(dev);
 617         u32 ret;
 618
 619         if (dm->flags & DM9000_PLATF_EXT_PHY)
 620                 ret = mii_link_ok(&dm->mii);
 621         else
 622                 ret = dm9000_read_locked(dm, DM9000_NSR) & NSR_LINKST ? 1 : 0;
 623
 624         return ret;
 625 }
 626
 627 #define DM_EEPROM_MAGIC         (0x444D394B)
 628
 629 static int dm9000_get_eeprom_len(struct net_device *dev)
 630 {
 631         return 128;
 632 }
 633
 634 static int dm9000_get_eeprom(struct net_device *dev,
 635                              struct ethtool_eeprom *ee, u8 *data)
 636 {
 637         struct board_info *dm = to_dm9000_board(dev);
 638         int offset = ee->offset;
 639         int len = ee->len;
 640         int i;
 641
 642         /* EEPROM access is aligned to two bytes */
 643
 644         if ((len & 1) != 0 || (offset & 1) != 0)
 645                 return -EINVAL;
 646
 647         if (dm->flags & DM9000_PLATF_NO_EEPROM)
 648                 return -ENOENT;
 649
 650         ee->magic = DM_EEPROM_MAGIC;
 651
 652         for (i = 0; i < len; i += 2)
 653                 dm9000_read_eeprom(dm, (offset + i) / 2, data + i);
 654
 655         return 0;
 656 }
 657
 658 static int dm9000_set_eeprom(struct net_device *dev,
 659                              struct ethtool_eeprom *ee, u8 *data)
 660 {
 661         struct board_info *dm = to_dm9000_board(dev);
 662         int offset = ee->offset;
 663         int len = ee->len;
 664         int done;
 665
 666         /* EEPROM access is aligned to two bytes */
 667
 668         if (dm->flags & DM9000_PLATF_NO_EEPROM)
 669                 return -ENOENT;
 670
 671         if (ee->magic != DM_EEPROM_MAGIC)
 672                 return -EINVAL;
 673
 674         while (len > 0) {
 675                 if (len & 1 || offset & 1) {
 676                         int which = offset & 1;
 677                         u8 tmp[2];
 678
 679                         dm9000_read_eeprom(dm, offset / 2, tmp);
 680                         tmp[which] = *data;
 681                         dm9000_write_eeprom(dm, offset / 2, tmp);
 682
 683                         done = 1;
 684                 } else {
 685                         dm9000_write_eeprom(dm, offset / 2, data);
 686                         done = 2;
 687                 }
 688
 689                 data += done;
 690                 offset += done;
 691                 len -= done;
 692         }
 693
 694         return 0;
 695 }
 696
 697 static void dm9000_get_wol(struct net_device *dev, struct ethtool_wolinfo *w)
 698 {
 699         struct board_info *dm = to_dm9000_board(dev);
 700
 701         memset(w, 0, sizeof(struct ethtool_wolinfo));
 702
 703         /* note, we could probably support wake-phy too */
 704         w->supported = dm->wake_supported ? WAKE_MAGIC : 0;
 705         w->wolopts = dm->wake_state;
 706 }
 707
 708 static int dm9000_set_wol(struct net_device *dev, struct ethtool_wolinfo *w)
 709 {
 710         struct board_info *dm = to_dm9000_board(dev);
 711         unsigned long flags;
 712         u32 opts = w->wolopts;
 713         u32 wcr = 0;
 714
 715         if (!dm->wake_supported)
 716                 return -EOPNOTSUPP;
 717
 718         if (opts & ~WAKE_MAGIC)
 719                 return -EINVAL;
 720
 721         if (opts & WAKE_MAGIC)
 722                 wcr |= WCR_MAGICEN;
 723
 724         mutex_lock(&dm->addr_lock);
 725
 726         spin_lock_irqsave(&dm->lock, flags);
 727         iow(dm, DM9000_WCR, wcr);
 728         spin_unlock_irqrestore(&dm->lock, flags);
 729
 730         mutex_unlock(&dm->addr_lock);
 731
 732         if (dm->wake_state != opts) {
 733                 /* change in wol state, update IRQ state */
 734
 735                 if (!dm->wake_state)
 736                         irq_set_irq_wake(dm->irq_wake, 1);
 737                 else if (dm->wake_state && !opts)
 738                         irq_set_irq_wake(dm->irq_wake, 0);
 739         }
 740
 741         dm->wake_state = opts;
 742         return 0;
 743 }
 744
 745 static const struct ethtool_ops dm9000_ethtool_ops = {
 746         .get_drvinfo            = dm9000_get_drvinfo,
 747         .get_settings           = dm9000_get_settings,
 748         .set_settings           = dm9000_set_settings,
 749         .get_msglevel           = dm9000_get_msglevel,
 750         .set_msglevel           = dm9000_set_msglevel,
 751         .nway_reset             = dm9000_nway_reset,
 752         .get_link               = dm9000_get_link,
 753         .get_wol                = dm9000_get_wol,
 754         .set_wol                = dm9000_set_wol,
 755         .get_eeprom_len         = dm9000_get_eeprom_len,
 756         .get_eeprom             = dm9000_get_eeprom,
 757         .set_eeprom             = dm9000_set_eeprom,
 758 };
 759
 760 static void dm9000_show_carrier(struct board_info *db,
 761                                 unsigned carrier, unsigned nsr)
 762 {
 763         int lpa;
 764         struct net_device *ndev = db->ndev;
 765         struct mii_if_info *mii = &db->mii;
 766         unsigned ncr = dm9000_read_locked(db, DM9000_NCR);
 767
 768         if (carrier) {
 769                 lpa = mii->mdio_read(mii->dev, mii->phy_id, MII_LPA);
 770                 dev_info(db->dev,
 771                          "%s: link up, %dMbps, %s-duplex, lpa 0x%04X\n",
 772                          ndev->name, (nsr & NSR_SPEED) ? 10 : 100,
 773                          (ncr & NCR_FDX) ? "full" : "half", lpa);
 774         } else {
 775                 dev_info(db->dev, "%s: link down\n", ndev->name);
 776         }
 777 }
 778
 779 static void
 780 dm9000_poll_work(struct work_struct *w)
 781 {
 782         struct delayed_work *dw = to_delayed_work(w);
 783         struct board_info *db = container_of(dw, struct board_info, phy_poll);
 784         struct net_device *ndev = db->ndev;
 785
 786         if (db->flags & DM9000_PLATF_SIMPLE_PHY &&
 787             !(db->flags & DM9000_PLATF_EXT_PHY)) {
 788                 unsigned nsr = dm9000_read_locked(db, DM9000_NSR);
 789                 unsigned old_carrier = netif_carrier_ok(ndev) ? 1 : 0;
 790                 unsigned new_carrier;
 791
 792                 new_carrier = (nsr & NSR_LINKST) ? 1 : 0;
 793
 794                 if (old_carrier != new_carrier) {
 795                         if (netif_msg_link(db))
 796                                 dm9000_show_carrier(db, new_carrier, nsr);
 797
 798                         if (!new_carrier)
 799                                 netif_carrier_off(ndev);
 800                         else
 801                                 netif_carrier_on(ndev);
 802                 }
 803         } else
 804                 mii_check_media(&db->mii, netif_msg_link(db), 0);
 805
 806         if (netif_running(ndev))
 807                 dm9000_schedule_poll(db);
 808 }
 809
 810 /* dm9000_release_board
 811  *
 812  * release a board, and any mapped resources
 813  */
 814
 815 static void
 816 dm9000_release_board(struct platform_device *pdev, struct board_info *db)
 817 {
 818         /* unmap our resources */
 819
 820         iounmap(db->io_addr);
 821         iounmap(db->io_data);
 822
 823         /* release the resources */
 824
 825         if (db->data_req)
 826                 release_resource(db->data_req);
 827         kfree(db->data_req);
 828
 829         if (db->addr_req)
 830                 release_resource(db->addr_req);
 831         kfree(db->addr_req);
 832 }
 833
 834 static unsigned char dm9000_type_to_char(enum dm9000_type type)
 835 {
 836         switch (type) {
 837         case TYPE_DM9000E: return 'e';
 838         case TYPE_DM9000A: return 'a';
 839         case TYPE_DM9000B: return 'b';
 840         }
 841
 842         return '?';
 843 }
 844
 845 /*
 846  *  Set DM9000 multicast address
 847  */
 848 static void
 849 dm9000_hash_table_unlocked(struct net_device *dev)
 850 {
 851         struct board_info *db = netdev_priv(dev);
 852         struct netdev_hw_addr *ha;
 853         int i, oft;
 854         u32 hash_val;
 855         u16 hash_table[4] = { 0, 0, 0, 0x8000 }; /* broadcast address */
 856         u8 rcr = RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN;
 857
 858         dm9000_dbg(db, 1, "entering %s\n", __func__);
 859
 860         for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
 861                 iow(db, oft, dev->dev_addr[i]);
 862
 863         if (dev->flags & IFF_PROMISC)
 864                 rcr |= RCR_PRMSC;
 865
 866         if (dev->flags & IFF_ALLMULTI)
 867                 rcr |= RCR_ALL;
 868
 869         /* the multicast address in Hash Table : 64 bits */
 870         netdev_for_each_mc_addr(ha, dev) {
 871                 hash_val = ether_crc_le(6, ha->addr) & 0x3f;
 872                 hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
 873         }
 874
 875         /* Write the hash table to MAC MD table */
 876         for (i = 0, oft = DM9000_MAR; i < 4; i++) {
 877                 iow(db, oft++, hash_table[i]);
 878                 iow(db, oft++, hash_table[i] >> 8);
 879         }
 880
 881         iow(db, DM9000_RCR, rcr);
 882 }
 883
 884 static void
 885 dm9000_hash_table(struct net_device *dev)
 886 {
 887         struct board_info *db = netdev_priv(dev);
 888         unsigned long flags;
 889
 890         spin_lock_irqsave(&db->lock, flags);
 891         dm9000_hash_table_unlocked(dev);
 892         spin_unlock_irqrestore(&db->lock, flags);
 893 }
 894
 895 static void
 896 dm9000_mask_interrupts(struct board_info *db)
 897 {
 898         iow(db, DM9000_IMR, IMR_PAR);
 899 }
 900
 901 static void
 902 dm9000_unmask_interrupts(struct board_info *db)
 903 {
 904         iow(db, DM9000_IMR, db->imr_all);
 905 }
 906
 907 /*
 908  * Initialize dm9000 board
 909  */
 910 static void
 911 dm9000_init_dm9000(struct net_device *dev)
 912 {
 913         struct board_info *db = netdev_priv(dev);
 914         unsigned int imr;
 915         unsigned int ncr;
 916
 917         dm9000_dbg(db, 1, "entering %s\n", __func__);
 918
 919         dm9000_reset(db);
 920         dm9000_mask_interrupts(db);
 921
 922         /* I/O mode */
 923         db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
 924
 925         /* Checksum mode */
 926         if (dev->hw_features & NETIF_F_RXCSUM)
 927                 iow(db, DM9000_RCSR,
 928                         (dev->features & NETIF_F_RXCSUM) ? RCSR_CSUM : 0);
 929
 930         iow(db, DM9000_GPCR, GPCR_GEP_CNTL);    /* Let GPIO0 output */
 931         iow(db, DM9000_GPR, 0);
 932
 933         /* If we are dealing with DM9000B, some extra steps are required: a
 934          * manual phy reset, and setting init params.
 935          */
 936         if (db->type == TYPE_DM9000B) {
 937                 dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET);
 938                 dm9000_phy_write(dev, 0, MII_DM_DSPCR, DSPCR_INIT_PARAM);
 939         }
 940
 941         ncr = (db->flags & DM9000_PLATF_EXT_PHY) ? NCR_EXT_PHY : 0;
 942
 943         /* if wol is needed, then always set NCR_WAKEEN otherwise we end
 944          * up dumping the wake events if we disable this. There is already
 945          * a wake-mask in DM9000_WCR */
 946         if (db->wake_supported)
 947                 ncr |= NCR_WAKEEN;
 948
 949         iow(db, DM9000_NCR, ncr);
 950
 951         /* Program operating register */
 952         iow(db, DM9000_TCR, 0);         /* TX Polling clear */
 953         iow(db, DM9000_BPTR, 0x3f);     /* Less 3Kb, 200us */
 954         iow(db, DM9000_FCR, 0xff);      /* Flow Control */
 955         iow(db, DM9000_SMCR, 0);        /* Special Mode */
 956         /* clear TX status */
 957         iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
 958         iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
 959
 960         /* Set address filter table */
 961         dm9000_hash_table_unlocked(dev);
 962
 963         imr = IMR_PAR | IMR_PTM | IMR_PRM;
 964         if (db->type != TYPE_DM9000E)
 965                 imr |= IMR_LNKCHNG;
 966
 967         db->imr_all = imr;
 968
 969         /* Init Driver variable */
 970         db->tx_pkt_cnt = 0;
 971         db->queue_pkt_len = 0;
 972         dev->trans_start = jiffies;
 973 }
 974
 975 /* Our watchdog timed out. Called by the networking layer */
 976 static void dm9000_timeout(struct net_device *dev)
 977 {
 978         struct board_info *db = netdev_priv(dev);
 979         u8 reg_save;
 980         unsigned long flags;
 981
 982         /* Save previous register address */
 983         spin_lock_irqsave(&db->lock, flags);
 984         db->in_timeout = 1;
 985         reg_save = readb(db->io_addr);
 986
 987         netif_stop_queue(dev);
 988         dm9000_init_dm9000(dev);
 989         dm9000_unmask_interrupts(db);
 990         /* We can accept TX packets again */
 991         dev->trans_start = jiffies; /* prevent tx timeout */
 992         netif_wake_queue(dev);
 993
 994         /* Restore previous register address */
 995         writeb(reg_save, db->io_addr);
 996         db->in_timeout = 0;
 997         spin_unlock_irqrestore(&db->lock, flags);
 998 }
 999
1000 static void dm9000_send_packet(struct net_device *dev,
1001                                int ip_summed,
1002                                u16 pkt_len)
1003 {
1004         struct board_info *dm = to_dm9000_board(dev);
1005
1006         /* The DM9000 is not smart enough to leave fragmented packets alone. */
1007         if (dm->ip_summed != ip_summed) {
1008                 if (ip_summed == CHECKSUM_NONE)
1009                         iow(dm, DM9000_TCCR, 0);
1010                 else
1011                         iow(dm, DM9000_TCCR, TCCR_IP | TCCR_UDP | TCCR_TCP);
1012                 dm->ip_summed = ip_summed;
1013         }
1014
1015         /* Set TX length to DM9000 */
1016         iow(dm, DM9000_TXPLL, pkt_len);
1017         iow(dm, DM9000_TXPLH, pkt_len >> 8);
1018
1019         /* Issue TX polling command */
1020         iow(dm, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
1021 }
1022
1023 /*
1024  *  Hardware start transmission.
1025  *  Send a packet to media from the upper layer.
1026  */
1027 static int
1028 dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
1029 {
1030         unsigned long flags;
1031         struct board_info *db = netdev_priv(dev);
1032
1033         dm9000_dbg(db, 3, "%s:\n", __func__);
1034
1035         if (db->tx_pkt_cnt > 1)
1036                 return NETDEV_TX_BUSY;
1037
1038         spin_lock_irqsave(&db->lock, flags);
1039
1040         /* Move data to DM9000 TX RAM */
1041         writeb(DM9000_MWCMD, db->io_addr);
1042
1043         (db->outblk)(db->io_data, skb->data, skb->len);
1044         dev->stats.tx_bytes += skb->len;
1045
1046         db->tx_pkt_cnt++;
1047         /* TX control: First packet immediately send, second packet queue */
1048         if (db->tx_pkt_cnt == 1) {
1049                 dm9000_send_packet(dev, skb->ip_summed, skb->len);
1050         } else {
1051                 /* Second packet */
1052                 db->queue_pkt_len = skb->len;
1053                 db->queue_ip_summed = skb->ip_summed;
1054                 netif_stop_queue(dev);
1055         }
1056
1057         spin_unlock_irqrestore(&db->lock, flags);
1058
1059         /* free this SKB */
1060         dev_consume_skb_any(skb);
1061
1062         return NETDEV_TX_OK;
1063 }
1064
1065 /*
1066  * DM9000 interrupt handler
1067  * receive the packet to upper layer, free the transmitted packet
1068  */
1069
1070 static void dm9000_tx_done(struct net_device *dev, struct board_info *db)
1071 {
1072         int tx_status = ior(db, DM9000_NSR);    /* Got TX status */
1073
1074         if (tx_status & (NSR_TX2END | NSR_TX1END)) {
1075                 /* One packet sent complete */
1076                 db->tx_pkt_cnt--;
1077                 dev->stats.tx_packets++;
1078
1079                 if (netif_msg_tx_done(db))
1080                         dev_dbg(db->dev, "tx done, NSR %02x\n", tx_status);
1081
1082                 /* Queue packet check & send */
1083                 if (db->tx_pkt_cnt > 0)
1084                         dm9000_send_packet(dev, db->queue_ip_summed,
1085                                            db->queue_pkt_len);
1086                 netif_wake_queue(dev);
1087         }
1088 }
1089
1090 struct dm9000_rxhdr {
1091         u8      RxPktReady;
1092         u8      RxStatus;
1093         __le16  RxLen;
1094 } __packed;
1095
1096 /*
1097  *  Received a packet and pass to upper layer
1098  */
1099 static void
1100 dm9000_rx(struct net_device *dev)
1101 {
1102         struct board_info *db = netdev_priv(dev);
1103         struct dm9000_rxhdr rxhdr;
1104         struct sk_buff *skb;
1105         u8 rxbyte, *rdptr;
1106         bool GoodPacket;
1107         int RxLen;
1108
1109         /* Check packet ready or not */
1110         do {
1111                 ior(db, DM9000_MRCMDX); /* Dummy read */
1112
1113                 /* Get most updated data */
1114                 rxbyte = readb(db->io_data);
1115
1116                 /* Status check: this byte must be 0 or 1 */
1117                 if (rxbyte & DM9000_PKT_ERR) {
1118                         dev_warn(db->dev, "status check fail: %d\n", rxbyte);
1119                         iow(db, DM9000_RCR, 0x00);      /* Stop Device */
1120                         return;
1121                 }
1122
1123                 if (!(rxbyte & DM9000_PKT_RDY))
1124                         return;
1125
1126                 /* A packet ready now  & Get status/length */
1127                 GoodPacket = true;
1128                 writeb(DM9000_MRCMD, db->io_addr);
1129
1130                 (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
1131
1132                 RxLen = le16_to_cpu(rxhdr.RxLen);
1133
1134                 if (netif_msg_rx_status(db))
1135                         dev_dbg(db->dev, "RX: status %02x, length %04x\n",
1136                                 rxhdr.RxStatus, RxLen);
1137
1138                 /* Packet Status check */
1139                 if (RxLen < 0x40) {
1140                         GoodPacket = false;
1141                         if (netif_msg_rx_err(db))
1142                                 dev_dbg(db->dev, "RX: Bad Packet (runt)\n");
1143                 }
1144
1145                 if (RxLen > DM9000_PKT_MAX) {
1146                         dev_dbg(db->dev, "RST: RX Len:%x\n", RxLen);
1147                 }
1148
1149                 /* rxhdr.RxStatus is identical to RSR register. */
1150                 if (rxhdr.RxStatus & (RSR_FOE | RSR_CE | RSR_AE |
1151                                       RSR_PLE | RSR_RWTO |
1152                                       RSR_LCS | RSR_RF)) {
1153                         GoodPacket = false;
1154                         if (rxhdr.RxStatus & RSR_FOE) {
1155                                 if (netif_msg_rx_err(db))
1156                                         dev_dbg(db->dev, "fifo error\n");
1157                                 dev->stats.rx_fifo_errors++;
1158                         }
1159                         if (rxhdr.RxStatus & RSR_CE) {
1160                                 if (netif_msg_rx_err(db))
1161                                         dev_dbg(db->dev, "crc error\n");
1162                                 dev->stats.rx_crc_errors++;
1163                         }
1164                         if (rxhdr.RxStatus & RSR_RF) {
1165                                 if (netif_msg_rx_err(db))
1166                                         dev_dbg(db->dev, "length error\n");
1167                                 dev->stats.rx_length_errors++;
1168                         }
1169                 }
1170
1171                 /* Move data from DM9000 */
1172                 if (GoodPacket &&
1173                     ((skb = netdev_alloc_skb(dev, RxLen + 4)) != NULL)) {
1174                         skb_reserve(skb, 2);
1175                         rdptr = (u8 *) skb_put(skb, RxLen - 4);
1176
1177                         /* Read received packet from RX SRAM */
1178
1179                         (db->inblk)(db->io_data, rdptr, RxLen);
1180                         dev->stats.rx_bytes += RxLen;
1181
1182                         /* Pass to upper layer */
1183                         skb->protocol = eth_type_trans(skb, dev);
1184                         if (dev->features & NETIF_F_RXCSUM) {
1185                                 if ((((rxbyte & 0x1c) << 3) & rxbyte) == 0)
1186                                         skb->ip_summed = CHECKSUM_UNNECESSARY;
1187                                 else
1188                                         skb_checksum_none_assert(skb);
1189                         }
1190                         netif_rx(skb);
1191                         dev->stats.rx_packets++;
1192
1193                 } else {
1194                         /* need to dump the packet's data */
1195
1196                         (db->dumpblk)(db->io_data, RxLen);
1197                 }
1198         } while (rxbyte & DM9000_PKT_RDY);
1199 }
1200
1201 static irqreturn_t dm9000_interrupt(int irq, void *dev_id)
1202 {
1203         struct net_device *dev = dev_id;
1204         struct board_info *db = netdev_priv(dev);
1205         int int_status;
1206         unsigned long flags;
1207         u8 reg_save;
1208
1209         dm9000_dbg(db, 3, "entering %s\n", __func__);
1210
1211         /* A real interrupt coming */
1212
1213         /* holders of db->lock must always block IRQs */
1214         spin_lock_irqsave(&db->lock, flags);
1215
1216         /* Save previous register address */
1217         reg_save = readb(db->io_addr);
1218
1219         dm9000_mask_interrupts(db);
1220         /* Got DM9000 interrupt status */
1221         int_status = ior(db, DM9000_ISR);       /* Got ISR */
1222         iow(db, DM9000_ISR, int_status);        /* Clear ISR status */
1223
1224         if (netif_msg_intr(db))
1225                 dev_dbg(db->dev, "interrupt status %02x\n", int_status);
1226
1227         /* Received the coming packet */
1228         if (int_status & ISR_PRS)
1229                 dm9000_rx(dev);
1230
1231         /* Transmit Interrupt check */
1232         if (int_status & ISR_PTS)
1233                 dm9000_tx_done(dev, db);
1234
1235         if (db->type != TYPE_DM9000E) {
1236                 if (int_status & ISR_LNKCHNG) {
1237                         /* fire a link-change request */
1238                         schedule_delayed_work(&db->phy_poll, 1);
1239                 }
1240         }
1241
1242         dm9000_unmask_interrupts(db);
1243         /* Restore previous register address */
1244         writeb(reg_save, db->io_addr);
1245
1246         spin_unlock_irqrestore(&db->lock, flags);
1247
1248         return IRQ_HANDLED;
1249 }
1250
1251 static irqreturn_t dm9000_wol_interrupt(int irq, void *dev_id)
1252 {
1253         struct net_device *dev = dev_id;
1254         struct board_info *db = netdev_priv(dev);
1255         unsigned long flags;
1256         unsigned nsr, wcr;
1257
1258         spin_lock_irqsave(&db->lock, flags);
1259
1260         nsr = ior(db, DM9000_NSR);
1261         wcr = ior(db, DM9000_WCR);
1262
1263         dev_dbg(db->dev, "%s: NSR=0x%02x, WCR=0x%02x\n", __func__, nsr, wcr);
1264
1265         if (nsr & NSR_WAKEST) {
1266                 /* clear, so we can avoid */
1267                 iow(db, DM9000_NSR, NSR_WAKEST);
1268
1269                 if (wcr & WCR_LINKST)
1270                         dev_info(db->dev, "wake by link status change\n");
1271                 if (wcr & WCR_SAMPLEST)
1272                         dev_info(db->dev, "wake by sample packet\n");
1273                 if (wcr & WCR_MAGICST)
1274                         dev_info(db->dev, "wake by magic packet\n");
1275                 if (!(wcr & (WCR_LINKST | WCR_SAMPLEST | WCR_MAGICST)))
1276                         dev_err(db->dev, "wake signalled with no reason? "
1277                                 "NSR=0x%02x, WSR=0x%02x\n", nsr, wcr);
1278         }
1279
1280         spin_unlock_irqrestore(&db->lock, flags);
1281
1282         return (nsr & NSR_WAKEST) ? IRQ_HANDLED : IRQ_NONE;
1283 }
1284
1285 #ifdef CONFIG_NET_POLL_CONTROLLER
1286 /*
1287  *Used by netconsole
1288  */
1289 static void dm9000_poll_controller(struct net_device *dev)
1290 {
1291         disable_irq(dev->irq);
1292         dm9000_interrupt(dev->irq, dev);
1293         enable_irq(dev->irq);
1294 }
1295 #endif
1296
1297 /*
1298  *  Open the interface.
1299  *  The interface is opened whenever "ifconfig" actives it.
1300  */
1301 static int
1302 dm9000_open(struct net_device *dev)
1303 {
1304         struct board_info *db = netdev_priv(dev);
1305         unsigned long irqflags = db->irq_res->flags & IRQF_TRIGGER_MASK;
1306
1307         if (netif_msg_ifup(db))
1308                 dev_dbg(db->dev, "enabling %s\n", dev->name);
1309
1310         /* If there is no IRQ type specified, default to something that
1311          * may work, and tell the user that this is a problem */
1312
1313         if (irqflags == IRQF_TRIGGER_NONE)
1314                 irqflags = irq_get_trigger_type(dev->irq);
1315
1316         if (irqflags == IRQF_TRIGGER_NONE)
1317                 dev_warn(db->dev, "WARNING: no IRQ resource flags set.\n");
1318
1319         irqflags |= IRQF_SHARED;
1320
1321         /* GPIO0 on pre-activate PHY, Reg 1F is not set by reset */
1322         iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
1323         mdelay(1); /* delay needs by DM9000B */
1324
1325         /* Initialize DM9000 board */
1326         dm9000_init_dm9000(dev);
1327
1328         if (request_irq(dev->irq, dm9000_interrupt, irqflags, dev->name, dev))
1329                 return -EAGAIN;
1330         /* Now that we have an interrupt handler hooked up we can unmask
1331          * our interrupts
1332          */
1333         dm9000_unmask_interrupts(db);
1334
1335         /* Init driver variable */
1336         db->dbug_cnt = 0;
1337
1338         mii_check_media(&db->mii, netif_msg_link(db), 1);
1339         netif_start_queue(dev);
1340
1341         /* Poll initial link status */
1342         schedule_delayed_work(&db->phy_poll, 1);
1343
1344         return 0;
1345 }
1346
1347 static void
1348 dm9000_shutdown(struct net_device *dev)
1349 {
1350         struct board_info *db = netdev_priv(dev);
1351
1352         /* RESET device */
1353         dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
1354         iow(db, DM9000_GPR, 0x01);      /* Power-Down PHY */
1355         dm9000_mask_interrupts(db);
1356         iow(db, DM9000_RCR, 0x00);      /* Disable RX */
1357 }
1358
1359 /*
1360  * Stop the interface.
1361  * The interface is stopped when it is brought.
1362  */
1363 static int
1364 dm9000_stop(struct net_device *ndev)
1365 {
1366         struct board_info *db = netdev_priv(ndev);
1367
1368         if (netif_msg_ifdown(db))
1369                 dev_dbg(db->dev, "shutting down %s\n", ndev->name);
1370
1371         cancel_delayed_work_sync(&db->phy_poll);
1372
1373         netif_stop_queue(ndev);
1374         netif_carrier_off(ndev);
1375
1376         /* free interrupt */
1377         free_irq(ndev->irq, ndev);
1378
1379         dm9000_shutdown(ndev);
1380
1381         return 0;
1382 }
1383
1384 static const struct net_device_ops dm9000_netdev_ops = {
1385         .ndo_open               = dm9000_open,
1386         .ndo_stop               = dm9000_stop,
1387         .ndo_start_xmit         = dm9000_start_xmit,
1388         .ndo_tx_timeout         = dm9000_timeout,
1389         .ndo_set_rx_mode        = dm9000_hash_table,
1390         .ndo_do_ioctl           = dm9000_ioctl,
1391         .ndo_change_mtu         = eth_change_mtu,
1392         .ndo_set_features       = dm9000_set_features,
1393         .ndo_validate_addr      = eth_validate_addr,
1394         .ndo_set_mac_address    = eth_mac_addr,
1395 #ifdef CONFIG_NET_POLL_CONTROLLER
1396         .ndo_poll_controller    = dm9000_poll_controller,
1397 #endif
1398 };
1399
1400 static struct dm9000_plat_data *dm9000_parse_dt(struct device *dev)
1401 {
1402         struct dm9000_plat_data *pdata;
1403         struct device_node *np = dev->of_node;
1404         const void *mac_addr;
1405
1406         if (!IS_ENABLED(CONFIG_OF) || !np)
1407                 return ERR_PTR(-ENXIO);
1408
1409         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
1410         if (!pdata)
1411                 return ERR_PTR(-ENOMEM);
1412
1413         if (of_find_property(np, "davicom,ext-phy", NULL))
1414                 pdata->flags |= DM9000_PLATF_EXT_PHY;
1415         if (of_find_property(np, "davicom,no-eeprom", NULL))
1416                 pdata->flags |= DM9000_PLATF_NO_EEPROM;
1417
1418         mac_addr = of_get_mac_address(np);
1419         if (mac_addr)
1420                 memcpy(pdata->dev_addr, mac_addr, sizeof(pdata->dev_addr));
1421
1422         return pdata;
1423 }
1424
1425 /*
1426  * Search DM9000 board, allocate space and register it
1427  */
1428 static int
1429 dm9000_probe(struct platform_device *pdev)
1430 {
1431         struct dm9000_plat_data *pdata = dev_get_platdata(&pdev->dev);
1432         struct board_info *db;  /* Point a board information structure */
1433         struct net_device *ndev;
1434         struct device *dev = &pdev->dev;
1435         const unsigned char *mac_src;
1436         int ret = 0;
1437         int iosize;
1438         int i;
1439         u32 id_val;
1440         int reset_gpios;
1441         enum of_gpio_flags flags;
1442         struct regulator *power;
1443
1444         power = devm_regulator_get(dev, "vcc");
1445         if (IS_ERR(power)) {
1446                 if (PTR_ERR(power) == -EPROBE_DEFER)
1447                         return -EPROBE_DEFER;
1448                 dev_dbg(dev, "no regulator provided\n");
1449         } else {
1450                 ret = regulator_enable(power);
1451                 if (ret != 0) {
1452                         dev_err(dev,
1453                                 "Failed to enable power regulator: %d\n", ret);
1454                         return ret;
1455                 }
1456                 dev_dbg(dev, "regulator enabled\n");
1457         }
1458
1459         reset_gpios = of_get_named_gpio_flags(dev->of_node, "reset-gpios", 0,
1460                                               &flags);
1461         if (gpio_is_valid(reset_gpios)) {
1462                 ret = devm_gpio_request_one(dev, reset_gpios, flags,
1463                                             "dm9000_reset");
1464                 if (ret) {
1465                         dev_err(dev, "failed to request reset gpio %d: %d\n",
1466                                 reset_gpios, ret);
1467                         goto out_regulator_disable;
1468                 }
1469
1470                 /* According to manual PWRST# Low Period Min 1ms */
1471                 msleep(2);
1472                 gpio_set_value(reset_gpios, 1);
1473                 /* Needs 3ms to read eeprom when PWRST is deasserted */
1474                 msleep(4);
1475         }
1476
1477         if (!pdata) {
1478                 pdata = dm9000_parse_dt(&pdev->dev);
1479                 if (IS_ERR(pdata)) {
1480                         ret = PTR_ERR(pdata);
1481                         goto out_regulator_disable;
1482                 }
1483         }
1484
1485         /* Init network device */
1486         ndev = alloc_etherdev(sizeof(struct board_info));
1487         if (!ndev) {
1488                 ret = -ENOMEM;
1489                 goto out_regulator_disable;
1490         }
1491
1492         SET_NETDEV_DEV(ndev, &pdev->dev);
1493
1494         dev_dbg(&pdev->dev, "dm9000_probe()\n");
1495
1496         /* setup board info structure */
1497         db = netdev_priv(ndev);
1498
1499         db->dev = &pdev->dev;
1500         db->ndev = ndev;
1501         if (!IS_ERR(power))
1502                 db->power_supply = power;
1503
1504         spin_lock_init(&db->lock);
1505         mutex_init(&db->addr_lock);
1506
1507         INIT_DELAYED_WORK(&db->phy_poll, dm9000_poll_work);
1508
1509         db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1510         db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1511         db->irq_res  = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
1512
1513         if (db->addr_res == NULL || db->data_res == NULL ||
1514             db->irq_res == NULL) {
1515                 dev_err(db->dev, "insufficient resources\n");
1516                 ret = -ENOENT;
1517                 goto out;
1518         }
1519
1520         db->irq_wake = platform_get_irq(pdev, 1);
1521         if (db->irq_wake >= 0) {
1522                 dev_dbg(db->dev, "wakeup irq %d\n", db->irq_wake);
1523
1524                 ret = request_irq(db->irq_wake, dm9000_wol_interrupt,
1525                                   IRQF_SHARED, dev_name(db->dev), ndev);
1526                 if (ret) {
1527                         dev_err(db->dev, "cannot get wakeup irq (%d)\n", ret);
1528                 } else {
1529
1530                         /* test to see if irq is really wakeup capable */
1531                         ret = irq_set_irq_wake(db->irq_wake, 1);
1532                         if (ret) {
1533                                 dev_err(db->dev, "irq %d cannot set wakeup (%d)\n",
1534                                         db->irq_wake, ret);
1535                                 ret = 0;
1536                         } else {
1537                                 irq_set_irq_wake(db->irq_wake, 0);
1538                                 db->wake_supported = 1;
1539                         }
1540                 }
1541         }
1542
1543         iosize = resource_size(db->addr_res);
1544         db->addr_req = request_mem_region(db->addr_res->start, iosize,
1545                                           pdev->name);
1546
1547         if (db->addr_req == NULL) {
1548                 dev_err(db->dev, "cannot claim address reg area\n");
1549                 ret = -EIO;
1550                 goto out;
1551         }
1552
1553         db->io_addr = ioremap(db->addr_res->start, iosize);
1554
1555         if (db->io_addr == NULL) {
1556                 dev_err(db->dev, "failed to ioremap address reg\n");
1557                 ret = -EINVAL;
1558                 goto out;
1559         }
1560
1561         iosize = resource_size(db->data_res);
1562         db->data_req = request_mem_region(db->data_res->start, iosize,
1563                                           pdev->name);
1564
1565         if (db->data_req == NULL) {
1566                 dev_err(db->dev, "cannot claim data reg area\n");
1567                 ret = -EIO;
1568                 goto out;
1569         }
1570
1571         db->io_data = ioremap(db->data_res->start, iosize);
1572
1573         if (db->io_data == NULL) {
1574                 dev_err(db->dev, "failed to ioremap data reg\n");
1575                 ret = -EINVAL;
1576                 goto out;
1577         }
1578
1579         /* fill in parameters for net-dev structure */
1580         ndev->base_addr = (unsigned long)db->io_addr;
1581         ndev->irq       = db->irq_res->start;
1582
1583         /* ensure at least we have a default set of IO routines */
1584         dm9000_set_io(db, iosize);
1585
1586         /* check to see if anything is being over-ridden */
1587         if (pdata != NULL) {
1588                 /* check to see if the driver wants to over-ride the
1589                  * default IO width */
1590
1591                 if (pdata->flags & DM9000_PLATF_8BITONLY)
1592                         dm9000_set_io(db, 1);
1593
1594                 if (pdata->flags & DM9000_PLATF_16BITONLY)
1595                         dm9000_set_io(db, 2);
1596
1597                 if (pdata->flags & DM9000_PLATF_32BITONLY)
1598                         dm9000_set_io(db, 4);
1599
1600                 /* check to see if there are any IO routine
1601                  * over-rides */
1602
1603                 if (pdata->inblk != NULL)
1604                         db->inblk = pdata->inblk;
1605
1606                 if (pdata->outblk != NULL)
1607                         db->outblk = pdata->outblk;
1608
1609                 if (pdata->dumpblk != NULL)
1610                         db->dumpblk = pdata->dumpblk;
1611
1612                 db->flags = pdata->flags;
1613         }
1614
1615 #ifdef CONFIG_DM9000_FORCE_SIMPLE_PHY_POLL
1616         db->flags |= DM9000_PLATF_SIMPLE_PHY;
1617 #endif
1618
1619         dm9000_reset(db);
1620
1621         /* try multiple times, DM9000 sometimes gets the read wrong */
1622         for (i = 0; i < 8; i++) {
1623                 id_val  = ior(db, DM9000_VIDL);
1624                 id_val |= (u32)ior(db, DM9000_VIDH) << 8;
1625                 id_val |= (u32)ior(db, DM9000_PIDL) << 16;
1626                 id_val |= (u32)ior(db, DM9000_PIDH) << 24;
1627
1628                 if (id_val == DM9000_ID)
1629                         break;
1630                 dev_err(db->dev, "read wrong id 0x%08x\n", id_val);
1631         }
1632
1633         if (id_val != DM9000_ID) {
1634                 dev_err(db->dev, "wrong id: 0x%08x\n", id_val);
1635                 ret = -ENODEV;
1636                 goto out;
1637         }
1638
1639         /* Identify what type of DM9000 we are working on */
1640
1641         id_val = ior(db, DM9000_CHIPR);
1642         dev_dbg(db->dev, "dm9000 revision 0x%02x\n", id_val);
1643
1644         switch (id_val) {
1645         case CHIPR_DM9000A:
1646                 db->type = TYPE_DM9000A;
1647                 break;
1648         case CHIPR_DM9000B:
1649                 db->type = TYPE_DM9000B;
1650                 break;
1651         default:
1652                 dev_dbg(db->dev, "ID %02x => defaulting to DM9000E\n", id_val);
1653                 db->type = TYPE_DM9000E;
1654         }
1655
1656         /* dm9000a/b are capable of hardware checksum offload */
1657         if (db->type == TYPE_DM9000A || db->type == TYPE_DM9000B) {
1658                 ndev->hw_features = NETIF_F_RXCSUM | NETIF_F_IP_CSUM;
1659                 ndev->features |= ndev->hw_features;
1660         }
1661
1662         /* from this point we assume that we have found a DM9000 */
1663
1664         ndev->netdev_ops        = &dm9000_netdev_ops;
1665         ndev->watchdog_timeo    = msecs_to_jiffies(watchdog);
1666         ndev->ethtool_ops       = &dm9000_ethtool_ops;
1667
1668         db->msg_enable       = NETIF_MSG_LINK;
1669         db->mii.phy_id_mask  = 0x1f;
1670         db->mii.reg_num_mask = 0x1f;
1671         db->mii.force_media  = 0;
1672         db->mii.full_duplex  = 0;
1673         db->mii.dev          = ndev;
1674         db->mii.mdio_read    = dm9000_phy_read;
1675         db->mii.mdio_write   = dm9000_phy_write;
1676
1677         mac_src = "eeprom";
1678
1679         /* try reading the node address from the attached EEPROM */
1680         for (i = 0; i < 6; i += 2)
1681                 dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);
1682
1683         if (!is_valid_ether_addr(ndev->dev_addr) && pdata != NULL) {
1684                 mac_src = "platform data";
1685                 memcpy(ndev->dev_addr, pdata->dev_addr, ETH_ALEN);
1686         }
1687
1688         if (!is_valid_ether_addr(ndev->dev_addr)) {
1689                 /* try reading from mac */
1690
1691                 mac_src = "chip";
1692                 for (i = 0; i < 6; i++)
1693                         ndev->dev_addr[i] = ior(db, i+DM9000_PAR);
1694         }
1695
1696         if (!is_valid_ether_addr(ndev->dev_addr)) {
1697                 dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
1698                          "set using ifconfig\n", ndev->name);
1699
1700                 eth_hw_addr_random(ndev);
1701                 mac_src = "random";
1702         }
1703
1704
1705         platform_set_drvdata(pdev, ndev);
1706         ret = register_netdev(ndev);
1707
1708         if (ret == 0)
1709                 printk(KERN_INFO "%s: dm9000%c at %p,%p IRQ %d MAC: %pM (%s)\n",
1710                        ndev->name, dm9000_type_to_char(db->type),
1711                        db->io_addr, db->io_data, ndev->irq,
1712                        ndev->dev_addr, mac_src);
1713         return 0;
1714
1715 out:
1716         dev_err(db->dev, "not found (%d).\n", ret);
1717
1718         dm9000_release_board(pdev, db);
1719         free_netdev(ndev);
1720
1721 out_regulator_disable:
1722         if (!IS_ERR(power))
1723                 regulator_disable(power);
1724
1725         return ret;
1726 }
1727
1728 static int
1729 dm9000_drv_suspend(struct device *dev)
1730 {
1731         struct platform_device *pdev = to_platform_device(dev);
1732         struct net_device *ndev = platform_get_drvdata(pdev);
1733         struct board_info *db;
1734
1735         if (ndev) {
1736                 db = netdev_priv(ndev);
1737                 db->in_suspend = 1;
1738
1739                 if (!netif_running(ndev))
1740                         return 0;
1741
1742                 netif_device_detach(ndev);
1743
1744                 /* only shutdown if not using WoL */
1745                 if (!db->wake_state)
1746                         dm9000_shutdown(ndev);
1747         }
1748         return 0;
1749 }
1750
1751 static int
1752 dm9000_drv_resume(struct device *dev)
1753 {
1754         struct platform_device *pdev = to_platform_device(dev);
1755         struct net_device *ndev = platform_get_drvdata(pdev);
1756         struct board_info *db = netdev_priv(ndev);
1757
1758         if (ndev) {
1759                 if (netif_running(ndev)) {
1760                         /* reset if we were not in wake mode to ensure if
1761                          * the device was powered off it is in a known state */
1762                         if (!db->wake_state) {
1763                                 dm9000_init_dm9000(ndev);
1764                                 dm9000_unmask_interrupts(db);
1765                         }
1766
1767                         netif_device_attach(ndev);
1768                 }
1769
1770                 db->in_suspend = 0;
1771         }
1772         return 0;
1773 }
1774
1775 static const struct dev_pm_ops dm9000_drv_pm_ops = {
1776         .suspend        = dm9000_drv_suspend,
1777         .resume         = dm9000_drv_resume,
1778 };
1779
1780 static int
1781 dm9000_drv_remove(struct platform_device *pdev)
1782 {
1783         struct net_device *ndev = platform_get_drvdata(pdev);
1784         struct board_info *dm = to_dm9000_board(ndev);
1785
1786         unregister_netdev(ndev);
1787         dm9000_release_board(pdev, dm);
1788         free_netdev(ndev);              /* free device structure */
1789         if (dm->power_supply)
1790                 regulator_disable(dm->power_supply);
1791
1792         dev_dbg(&pdev->dev, "released and freed device\n");
1793         return 0;
1794 }
1795
1796 #ifdef CONFIG_OF
1797 static const struct of_device_id dm9000_of_matches[] = {
1798         { .compatible = "davicom,dm9000", },
1799         { /* sentinel */ }
1800 };
1801 MODULE_DEVICE_TABLE(of, dm9000_of_matches);
1802 #endif
1803
1804 static struct platform_driver dm9000_driver = {
1805         .driver = {
1806                 .name    = "dm9000",
1807                 .pm      = &dm9000_drv_pm_ops,
1808                 .of_match_table = of_match_ptr(dm9000_of_matches),
1809         },
1810         .probe   = dm9000_probe,
1811         .remove  = dm9000_drv_remove,
1812 };
1813
1814 module_platform_driver(dm9000_driver);
1815
1816 MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1817 MODULE_DESCRIPTION("Davicom DM9000 network driver");
1818 MODULE_LICENSE("GPL");
1819 MODULE_ALIAS("platform:dm9000");