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