drivers/net/enc28j60.c

   1 /*
   2  * Microchip ENC28J60 ethernet driver (MAC + PHY)
   3  *
   4  * Copyright (C) 2007 Eurek srl
   5  * Author: Claudio Lanconelli <lanconelli.claudio@eptar.com>
   6  * based on enc28j60.c written by David Anders for 2.4 kernel version
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * $Id: enc28j60.c,v 1.22 2007/12/20 10:47:01 claudio Exp $
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/kernel.h>
  18 #include <linux/types.h>
  19 #include <linux/fcntl.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/slab.h>
  22 #include <linux/string.h>
  23 #include <linux/errno.h>
  24 #include <linux/init.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/etherdevice.h>
  27 #include <linux/ethtool.h>
  28 #include <linux/tcp.h>
  29 #include <linux/skbuff.h>
  30 #include <linux/delay.h>
  31 #include <linux/spi/spi.h>
  32
  33 #include "enc28j60_hw.h"
  34
  35 #define DRV_NAME        "enc28j60"
  36 #define DRV_VERSION     "1.01"
  37
  38 #define SPI_OPLEN       1
  39
  40 #define ENC28J60_MSG_DEFAULT    \
  41         (NETIF_MSG_PROBE | NETIF_MSG_IFUP | NETIF_MSG_IFDOWN | NETIF_MSG_LINK)
  42
  43 /* Buffer size required for the largest SPI transfer (i.e., reading a
  44  * frame). */
  45 #define SPI_TRANSFER_BUF_LEN    (4 + MAX_FRAMELEN)
  46
  47 #define TX_TIMEOUT      (4 * HZ)
  48
  49 /* Max TX retries in case of collision as suggested by errata datasheet */
  50 #define MAX_TX_RETRYCOUNT       16
  51
  52 enum {
  53         RXFILTER_NORMAL,
  54         RXFILTER_MULTI,
  55         RXFILTER_PROMISC
  56 };
  57
  58 /* Driver local data */
  59 struct enc28j60_net {
  60         struct net_device *netdev;
  61         struct spi_device *spi;
  62         struct mutex lock;
  63         struct sk_buff *tx_skb;
  64         struct work_struct tx_work;
  65         struct work_struct irq_work;
  66         struct work_struct setrx_work;
  67         struct work_struct restart_work;
  68         u8 bank;                /* current register bank selected */
  69         u16 next_pk_ptr;        /* next packet pointer within FIFO */
  70         u16 max_pk_counter;     /* statistics: max packet counter */
  71         u16 tx_retry_count;
  72         bool hw_enable;
  73         bool full_duplex;
  74         int rxfilter;
  75         u32 msg_enable;
  76         u8 spi_transfer_buf[SPI_TRANSFER_BUF_LEN];
  77 };
  78
  79 /* use ethtool to change the level for any given device */
  80 static struct {
  81         u32 msg_enable;
  82 } debug = { -1 };
  83
  84 /*
  85  * SPI read buffer
  86  * wait for the SPI transfer and copy received data to destination
  87  */
  88 static int
  89 spi_read_buf(struct enc28j60_net *priv, int len, u8 *data)
  90 {
  91         u8 *rx_buf = priv->spi_transfer_buf + 4;
  92         u8 *tx_buf = priv->spi_transfer_buf;
  93         struct spi_transfer t = {
  94                 .tx_buf = tx_buf,
  95                 .rx_buf = rx_buf,
  96                 .len = SPI_OPLEN + len,
  97         };
  98         struct spi_message msg;
  99         int ret;
 100
 101         tx_buf[0] = ENC28J60_READ_BUF_MEM;
 102         tx_buf[1] = tx_buf[2] = tx_buf[3] = 0;  /* don't care */
 103
 104         spi_message_init(&msg);
 105         spi_message_add_tail(&t, &msg);
 106         ret = spi_sync(priv->spi, &msg);
 107         if (ret == 0) {
 108                 memcpy(data, &rx_buf[SPI_OPLEN], len);
 109                 ret = msg.status;
 110         }
 111         if (ret && netif_msg_drv(priv))
 112                 printk(KERN_DEBUG DRV_NAME ": %s() failed: ret = %d\n",
 113                         __FUNCTION__, ret);
 114
 115         return ret;
 116 }
 117
 118 /*
 119  * SPI write buffer
 120  */
 121 static int spi_write_buf(struct enc28j60_net *priv, int len,
 122                          const u8 *data)
 123 {
 124         int ret;
 125
 126         if (len > SPI_TRANSFER_BUF_LEN - 1 || len <= 0)
 127                 ret = -EINVAL;
 128         else {
 129                 priv->spi_transfer_buf[0] = ENC28J60_WRITE_BUF_MEM;
 130                 memcpy(&priv->spi_transfer_buf[1], data, len);
 131                 ret = spi_write(priv->spi, priv->spi_transfer_buf, len + 1);
 132                 if (ret && netif_msg_drv(priv))
 133                         printk(KERN_DEBUG DRV_NAME ": %s() failed: ret = %d\n",
 134                                 __FUNCTION__, ret);
 135         }
 136         return ret;
 137 }
 138
 139 /*
 140  * basic SPI read operation
 141  */
 142 static u8 spi_read_op(struct enc28j60_net *priv, u8 op,
 143                            u8 addr)
 144 {
 145         u8 tx_buf[2];
 146         u8 rx_buf[4];
 147         u8 val = 0;
 148         int ret;
 149         int slen = SPI_OPLEN;
 150
 151         /* do dummy read if needed */
 152         if (addr & SPRD_MASK)
 153                 slen++;
 154
 155         tx_buf[0] = op | (addr & ADDR_MASK);
 156         ret = spi_write_then_read(priv->spi, tx_buf, 1, rx_buf, slen);
 157         if (ret)
 158                 printk(KERN_DEBUG DRV_NAME ": %s() failed: ret = %d\n",
 159                         __FUNCTION__, ret);
 160         else
 161                 val = rx_buf[slen - 1];
 162
 163         return val;
 164 }
 165
 166 /*
 167  * basic SPI write operation
 168  */
 169 static int spi_write_op(struct enc28j60_net *priv, u8 op,
 170                         u8 addr, u8 val)
 171 {
 172         int ret;
 173
 174         priv->spi_transfer_buf[0] = op | (addr & ADDR_MASK);
 175         priv->spi_transfer_buf[1] = val;
 176         ret = spi_write(priv->spi, priv->spi_transfer_buf, 2);
 177         if (ret && netif_msg_drv(priv))
 178                 printk(KERN_DEBUG DRV_NAME ": %s() failed: ret = %d\n",
 179                         __FUNCTION__, ret);
 180         return ret;
 181 }
 182
 183 static void enc28j60_soft_reset(struct enc28j60_net *priv)
 184 {
 185         if (netif_msg_hw(priv))
 186                 printk(KERN_DEBUG DRV_NAME ": %s() enter\n", __FUNCTION__);
 187
 188         spi_write_op(priv, ENC28J60_SOFT_RESET, 0, ENC28J60_SOFT_RESET);
 189         /* Errata workaround #1, CLKRDY check is unreliable,
 190          * delay at least 1 mS instead */
 191         udelay(2000);
 192 }
 193
 194 /*
 195  * select the current register bank if necessary
 196  */
 197 static void enc28j60_set_bank(struct enc28j60_net *priv, u8 addr)
 198 {
 199         if ((addr & BANK_MASK) != priv->bank) {
 200                 u8 b = (addr & BANK_MASK) >> 5;
 201
 202                 if (b != (ECON1_BSEL1 | ECON1_BSEL0))
 203                         spi_write_op(priv, ENC28J60_BIT_FIELD_CLR, ECON1,
 204                                      ECON1_BSEL1 | ECON1_BSEL0);
 205                 if (b != 0)
 206                         spi_write_op(priv, ENC28J60_BIT_FIELD_SET, ECON1, b);
 207                 priv->bank = (addr & BANK_MASK);
 208         }
 209 }
 210
 211 /*
 212  * Register access routines through the SPI bus.
 213  * Every register access comes in two flavours:
 214  * - nolock_xxx: caller needs to invoke mutex_lock, usually to access
 215  *   atomically more than one register
 216  * - locked_xxx: caller doesn't need to invoke mutex_lock, single access
 217  *
 218  * Some registers can be accessed through the bit field clear and
 219  * bit field set to avoid a read modify write cycle.
 220  */
 221
 222 /*
 223  * Register bit field Set
 224  */
 225 static void nolock_reg_bfset(struct enc28j60_net *priv,
 226                                       u8 addr, u8 mask)
 227 {
 228         enc28j60_set_bank(priv, addr);
 229         spi_write_op(priv, ENC28J60_BIT_FIELD_SET, addr, mask);
 230 }
 231
 232 static void locked_reg_bfset(struct enc28j60_net *priv,
 233                                       u8 addr, u8 mask)
 234 {
 235         mutex_lock(&priv->lock);
 236         nolock_reg_bfset(priv, addr, mask);
 237         mutex_unlock(&priv->lock);
 238 }
 239
 240 /*
 241  * Register bit field Clear
 242  */
 243 static void nolock_reg_bfclr(struct enc28j60_net *priv,
 244                                       u8 addr, u8 mask)
 245 {
 246         enc28j60_set_bank(priv, addr);
 247         spi_write_op(priv, ENC28J60_BIT_FIELD_CLR, addr, mask);
 248 }
 249
 250 static void locked_reg_bfclr(struct enc28j60_net *priv,
 251                                       u8 addr, u8 mask)
 252 {
 253         mutex_lock(&priv->lock);
 254         nolock_reg_bfclr(priv, addr, mask);
 255         mutex_unlock(&priv->lock);
 256 }
 257
 258 /*
 259  * Register byte read
 260  */
 261 static int nolock_regb_read(struct enc28j60_net *priv,
 262                                      u8 address)
 263 {
 264         enc28j60_set_bank(priv, address);
 265         return spi_read_op(priv, ENC28J60_READ_CTRL_REG, address);
 266 }
 267
 268 static int locked_regb_read(struct enc28j60_net *priv,
 269                                      u8 address)
 270 {
 271         int ret;
 272
 273         mutex_lock(&priv->lock);
 274         ret = nolock_regb_read(priv, address);
 275         mutex_unlock(&priv->lock);
 276
 277         return ret;
 278 }
 279
 280 /*
 281  * Register word read
 282  */
 283 static int nolock_regw_read(struct enc28j60_net *priv,
 284                                      u8 address)
 285 {
 286         int rl, rh;
 287
 288         enc28j60_set_bank(priv, address);
 289         rl = spi_read_op(priv, ENC28J60_READ_CTRL_REG, address);
 290         rh = spi_read_op(priv, ENC28J60_READ_CTRL_REG, address + 1);
 291
 292         return (rh << 8) | rl;
 293 }
 294
 295 static int locked_regw_read(struct enc28j60_net *priv,
 296                                      u8 address)
 297 {
 298         int ret;
 299
 300         mutex_lock(&priv->lock);
 301         ret = nolock_regw_read(priv, address);
 302         mutex_unlock(&priv->lock);
 303
 304         return ret;
 305 }
 306
 307 /*
 308  * Register byte write
 309  */
 310 static void nolock_regb_write(struct enc28j60_net *priv,
 311                                        u8 address, u8 data)
 312 {
 313         enc28j60_set_bank(priv, address);
 314         spi_write_op(priv, ENC28J60_WRITE_CTRL_REG, address, data);
 315 }
 316
 317 static void locked_regb_write(struct enc28j60_net *priv,
 318                                        u8 address, u8 data)
 319 {
 320         mutex_lock(&priv->lock);
 321         nolock_regb_write(priv, address, data);
 322         mutex_unlock(&priv->lock);
 323 }
 324
 325 /*
 326  * Register word write
 327  */
 328 static void nolock_regw_write(struct enc28j60_net *priv,
 329                                        u8 address, u16 data)
 330 {
 331         enc28j60_set_bank(priv, address);
 332         spi_write_op(priv, ENC28J60_WRITE_CTRL_REG, address, (u8) data);
 333         spi_write_op(priv, ENC28J60_WRITE_CTRL_REG, address + 1,
 334                      (u8) (data >> 8));
 335 }
 336
 337 static void locked_regw_write(struct enc28j60_net *priv,
 338                                        u8 address, u16 data)
 339 {
 340         mutex_lock(&priv->lock);
 341         nolock_regw_write(priv, address, data);
 342         mutex_unlock(&priv->lock);
 343 }
 344
 345 /*
 346  * Buffer memory read
 347  * Select the starting address and execute a SPI buffer read
 348  */
 349 static void enc28j60_mem_read(struct enc28j60_net *priv,
 350                                      u16 addr, int len, u8 *data)
 351 {
 352         mutex_lock(&priv->lock);
 353         nolock_regw_write(priv, ERDPTL, addr);
 354 #ifdef CONFIG_ENC28J60_WRITEVERIFY
 355         if (netif_msg_drv(priv)) {
 356                 u16 reg;
 357                 reg = nolock_regw_read(priv, ERDPTL);
 358                 if (reg != addr)
 359                         printk(KERN_DEBUG DRV_NAME ": %s() error writing ERDPT "
 360                                 "(0x%04x - 0x%04x)\n", __FUNCTION__, reg, addr);
 361         }
 362 #endif
 363         spi_read_buf(priv, len, data);
 364         mutex_unlock(&priv->lock);
 365 }
 366
 367 /*
 368  * Write packet to enc28j60 TX buffer memory
 369  */
 370 static void
 371 enc28j60_packet_write(struct enc28j60_net *priv, int len, const u8 *data)
 372 {
 373         mutex_lock(&priv->lock);
 374         /* Set the write pointer to start of transmit buffer area */
 375         nolock_regw_write(priv, EWRPTL, TXSTART_INIT);
 376 #ifdef CONFIG_ENC28J60_WRITEVERIFY
 377         if (netif_msg_drv(priv)) {
 378                 u16 reg;
 379                 reg = nolock_regw_read(priv, EWRPTL);
 380                 if (reg != TXSTART_INIT)
 381                         printk(KERN_DEBUG DRV_NAME
 382                                 ": %s() ERWPT:0x%04x != 0x%04x\n",
 383                                 __FUNCTION__, reg, TXSTART_INIT);
 384         }
 385 #endif
 386         /* Set the TXND pointer to correspond to the packet size given */
 387         nolock_regw_write(priv, ETXNDL, TXSTART_INIT + len);
 388         /* write per-packet control byte */
 389         spi_write_op(priv, ENC28J60_WRITE_BUF_MEM, 0, 0x00);
 390         if (netif_msg_hw(priv))
 391                 printk(KERN_DEBUG DRV_NAME
 392                         ": %s() after control byte ERWPT:0x%04x\n",
 393                         __FUNCTION__, nolock_regw_read(priv, EWRPTL));
 394         /* copy the packet into the transmit buffer */
 395         spi_write_buf(priv, len, data);
 396         if (netif_msg_hw(priv))
 397                 printk(KERN_DEBUG DRV_NAME
 398                          ": %s() after write packet ERWPT:0x%04x, len=%d\n",
 399                          __FUNCTION__, nolock_regw_read(priv, EWRPTL), len);
 400         mutex_unlock(&priv->lock);
 401 }
 402
 403 /*
 404  * Wait until the PHY operation is complete.
 405  */
 406 static int wait_phy_ready(struct enc28j60_net *priv)
 407 {
 408         unsigned long timeout = jiffies + 20 * HZ / 1000;
 409         int ret = 1;
 410
 411         /* 20 msec timeout read */
 412         while (nolock_regb_read(priv, MISTAT) & MISTAT_BUSY) {
 413                 if (time_after(jiffies, timeout)) {
 414                         if (netif_msg_drv(priv))
 415                                 printk(KERN_DEBUG DRV_NAME
 416                                         ": PHY ready timeout!\n");
 417                         ret = 0;
 418                         break;
 419                 }
 420                 cpu_relax();
 421         }
 422         return ret;
 423 }
 424
 425 /*
 426  * PHY register read
 427  * PHY registers are not accessed directly, but through the MII
 428  */
 429 static u16 enc28j60_phy_read(struct enc28j60_net *priv, u8 address)
 430 {
 431         u16 ret;
 432
 433         mutex_lock(&priv->lock);
 434         /* set the PHY register address */
 435         nolock_regb_write(priv, MIREGADR, address);
 436         /* start the register read operation */
 437         nolock_regb_write(priv, MICMD, MICMD_MIIRD);
 438         /* wait until the PHY read completes */
 439         wait_phy_ready(priv);
 440         /* quit reading */
 441         nolock_regb_write(priv, MICMD, 0x00);
 442         /* return the data */
 443         ret  = nolock_regw_read(priv, MIRDL);
 444         mutex_unlock(&priv->lock);
 445
 446         return ret;
 447 }
 448
 449 static int enc28j60_phy_write(struct enc28j60_net *priv, u8 address, u16 data)
 450 {
 451         int ret;
 452
 453         mutex_lock(&priv->lock);
 454         /* set the PHY register address */
 455         nolock_regb_write(priv, MIREGADR, address);
 456         /* write the PHY data */
 457         nolock_regw_write(priv, MIWRL, data);
 458         /* wait until the PHY write completes and return */
 459         ret = wait_phy_ready(priv);
 460         mutex_unlock(&priv->lock);
 461
 462         return ret;
 463 }
 464
 465 /*
 466  * Program the hardware MAC address from dev->dev_addr.
 467  */
 468 static int enc28j60_set_hw_macaddr(struct net_device *ndev)
 469 {
 470         int ret;
 471         struct enc28j60_net *priv = netdev_priv(ndev);
 472
 473         mutex_lock(&priv->lock);
 474         if (!priv->hw_enable) {
 475                 if (netif_msg_drv(priv)) {
 476                         DECLARE_MAC_BUF(mac);
 477                         printk(KERN_INFO DRV_NAME
 478                                 ": %s: Setting MAC address to %s\n",
 479                                 ndev->name, print_mac(mac, ndev->dev_addr));
 480                 }
 481                 /* NOTE: MAC address in ENC28J60 is byte-backward */
 482                 nolock_regb_write(priv, MAADR5, ndev->dev_addr[0]);
 483                 nolock_regb_write(priv, MAADR4, ndev->dev_addr[1]);
 484                 nolock_regb_write(priv, MAADR3, ndev->dev_addr[2]);
 485                 nolock_regb_write(priv, MAADR2, ndev->dev_addr[3]);
 486                 nolock_regb_write(priv, MAADR1, ndev->dev_addr[4]);
 487                 nolock_regb_write(priv, MAADR0, ndev->dev_addr[5]);
 488                 ret = 0;
 489         } else {
 490                 if (netif_msg_drv(priv))
 491                         printk(KERN_DEBUG DRV_NAME
 492                                 ": %s() Hardware must be disabled to set "
 493                                 "Mac address\n", __FUNCTION__);
 494                 ret = -EBUSY;
 495         }
 496         mutex_unlock(&priv->lock);
 497         return ret;
 498 }
 499
 500 /*
 501  * Store the new hardware address in dev->dev_addr, and update the MAC.
 502  */
 503 static int enc28j60_set_mac_address(struct net_device *dev, void *addr)
 504 {
 505         struct sockaddr *address = addr;
 506
 507         if (netif_running(dev))
 508                 return -EBUSY;
 509         if (!is_valid_ether_addr(address->sa_data))
 510                 return -EADDRNOTAVAIL;
 511
 512         memcpy(dev->dev_addr, address->sa_data, dev->addr_len);
 513         return enc28j60_set_hw_macaddr(dev);
 514 }
 515
 516 /*
 517  * Debug routine to dump useful register contents
 518  */
 519 static void enc28j60_dump_regs(struct enc28j60_net *priv, const char *msg)
 520 {
 521         mutex_lock(&priv->lock);
 522         printk(KERN_DEBUG DRV_NAME " %s\n"
 523                 "HwRevID: 0x%02x\n"
 524                 "Cntrl: ECON1 ECON2 ESTAT  EIR  EIE\n"
 525                 "       0x%02x  0x%02x  0x%02x  0x%02x  0x%02x\n"
 526                 "MAC  : MACON1 MACON3 MACON4\n"
 527                 "       0x%02x   0x%02x   0x%02x\n"
 528                 "Rx   : ERXST  ERXND  ERXWRPT ERXRDPT ERXFCON EPKTCNT MAMXFL\n"
 529                 "       0x%04x 0x%04x 0x%04x  0x%04x  "
 530                 "0x%02x    0x%02x    0x%04x\n"
 531                 "Tx   : ETXST  ETXND  MACLCON1 MACLCON2 MAPHSUP\n"
 532                 "       0x%04x 0x%04x 0x%02x     0x%02x     0x%02x\n",
 533                 msg, nolock_regb_read(priv, EREVID),
 534                 nolock_regb_read(priv, ECON1), nolock_regb_read(priv, ECON2),
 535                 nolock_regb_read(priv, ESTAT), nolock_regb_read(priv, EIR),
 536                 nolock_regb_read(priv, EIE), nolock_regb_read(priv, MACON1),
 537                 nolock_regb_read(priv, MACON3), nolock_regb_read(priv, MACON4),
 538                 nolock_regw_read(priv, ERXSTL), nolock_regw_read(priv, ERXNDL),
 539                 nolock_regw_read(priv, ERXWRPTL),
 540                 nolock_regw_read(priv, ERXRDPTL),
 541                 nolock_regb_read(priv, ERXFCON),
 542                 nolock_regb_read(priv, EPKTCNT),
 543                 nolock_regw_read(priv, MAMXFLL), nolock_regw_read(priv, ETXSTL),
 544                 nolock_regw_read(priv, ETXNDL),
 545                 nolock_regb_read(priv, MACLCON1),
 546                 nolock_regb_read(priv, MACLCON2),
 547                 nolock_regb_read(priv, MAPHSUP));
 548         mutex_unlock(&priv->lock);
 549 }
 550
 551 /*
 552  * ERXRDPT need to be set always at odd addresses, refer to errata datasheet
 553  */
 554 static u16 erxrdpt_workaround(u16 next_packet_ptr, u16 start, u16 end)
 555 {
 556         u16 erxrdpt;
 557
 558         if ((next_packet_ptr - 1 < start) || (next_packet_ptr - 1 > end))
 559                 erxrdpt = end;
 560         else
 561                 erxrdpt = next_packet_ptr - 1;
 562
 563         return erxrdpt;
 564 }
 565
 566 static void nolock_rxfifo_init(struct enc28j60_net *priv, u16 start, u16 end)
 567 {
 568         u16 erxrdpt;
 569
 570         if (start > 0x1FFF || end > 0x1FFF || start > end) {
 571                 if (netif_msg_drv(priv))
 572                         printk(KERN_ERR DRV_NAME ": %s(%d, %d) RXFIFO "
 573                                 "bad parameters!\n", __FUNCTION__, start, end);
 574                 return;
 575         }
 576         /* set receive buffer start + end */
 577         priv->next_pk_ptr = start;
 578         nolock_regw_write(priv, ERXSTL, start);
 579         erxrdpt = erxrdpt_workaround(priv->next_pk_ptr, start, end);
 580         nolock_regw_write(priv, ERXRDPTL, erxrdpt);
 581         nolock_regw_write(priv, ERXNDL, end);
 582 }
 583
 584 static void nolock_txfifo_init(struct enc28j60_net *priv, u16 start, u16 end)
 585 {
 586         if (start > 0x1FFF || end > 0x1FFF || start > end) {
 587                 if (netif_msg_drv(priv))
 588                         printk(KERN_ERR DRV_NAME ": %s(%d, %d) TXFIFO "
 589                                 "bad parameters!\n", __FUNCTION__, start, end);
 590                 return;
 591         }
 592         /* set transmit buffer start + end */
 593         nolock_regw_write(priv, ETXSTL, start);
 594         nolock_regw_write(priv, ETXNDL, end);
 595 }
 596
 597 static int enc28j60_hw_init(struct enc28j60_net *priv)
 598 {
 599         u8 reg;
 600
 601         if (netif_msg_drv(priv))
 602                 printk(KERN_DEBUG DRV_NAME ": %s() - %s\n", __FUNCTION__,
 603                         priv->full_duplex ? "FullDuplex" : "HalfDuplex");
 604
 605         mutex_lock(&priv->lock);
 606         /* first reset the chip */
 607         enc28j60_soft_reset(priv);
 608         /* Clear ECON1 */
 609         spi_write_op(priv, ENC28J60_WRITE_CTRL_REG, ECON1, 0x00);
 610         priv->bank = 0;
 611         priv->hw_enable = false;
 612         priv->tx_retry_count = 0;
 613         priv->max_pk_counter = 0;
 614         priv->rxfilter = RXFILTER_NORMAL;
 615         /* enable address auto increment */
 616         nolock_regb_write(priv, ECON2, ECON2_AUTOINC);
 617
 618         nolock_rxfifo_init(priv, RXSTART_INIT, RXEND_INIT);
 619         nolock_txfifo_init(priv, TXSTART_INIT, TXEND_INIT);
 620         mutex_unlock(&priv->lock);
 621
 622         /*
 623          * Check the RevID.
 624          * If it's 0x00 or 0xFF probably the enc28j60 is not mounted or
 625          * damaged
 626          */
 627         reg = locked_regb_read(priv, EREVID);
 628         if (netif_msg_drv(priv))
 629                 printk(KERN_INFO DRV_NAME ": chip RevID: 0x%02x\n", reg);
 630         if (reg == 0x00 || reg == 0xff) {
 631                 if (netif_msg_drv(priv))
 632                         printk(KERN_DEBUG DRV_NAME ": %s() Invalid RevId %d\n",
 633                                 __FUNCTION__, reg);
 634                 return 0;
 635         }
 636
 637         /* default filter mode: (unicast OR broadcast) AND crc valid */
 638         locked_regb_write(priv, ERXFCON,
 639                             ERXFCON_UCEN | ERXFCON_CRCEN | ERXFCON_BCEN);
 640
 641         /* enable MAC receive */
 642         locked_regb_write(priv, MACON1,
 643                             MACON1_MARXEN | MACON1_TXPAUS | MACON1_RXPAUS);
 644         /* enable automatic padding and CRC operations */
 645         if (priv->full_duplex) {
 646                 locked_regb_write(priv, MACON3,
 647                                     MACON3_PADCFG0 | MACON3_TXCRCEN |
 648                                     MACON3_FRMLNEN | MACON3_FULDPX);
 649                 /* set inter-frame gap (non-back-to-back) */
 650                 locked_regb_write(priv, MAIPGL, 0x12);
 651                 /* set inter-frame gap (back-to-back) */
 652                 locked_regb_write(priv, MABBIPG, 0x15);
 653         } else {
 654                 locked_regb_write(priv, MACON3,
 655                                     MACON3_PADCFG0 | MACON3_TXCRCEN |
 656                                     MACON3_FRMLNEN);
 657                 locked_regb_write(priv, MACON4, 1 << 6);        /* DEFER bit */
 658                 /* set inter-frame gap (non-back-to-back) */
 659                 locked_regw_write(priv, MAIPGL, 0x0C12);
 660                 /* set inter-frame gap (back-to-back) */
 661                 locked_regb_write(priv, MABBIPG, 0x12);
 662         }
 663         /*
 664          * MACLCON1 (default)
 665          * MACLCON2 (default)
 666          * Set the maximum packet size which the controller will accept
 667          */
 668         locked_regw_write(priv, MAMXFLL, MAX_FRAMELEN);
 669
 670         /* Configure LEDs */
 671         if (!enc28j60_phy_write(priv, PHLCON, ENC28J60_LAMPS_MODE))
 672                 return 0;
 673
 674         if (priv->full_duplex) {
 675                 if (!enc28j60_phy_write(priv, PHCON1, PHCON1_PDPXMD))
 676                         return 0;
 677                 if (!enc28j60_phy_write(priv, PHCON2, 0x00))
 678                         return 0;
 679         } else {
 680                 if (!enc28j60_phy_write(priv, PHCON1, 0x00))
 681                         return 0;
 682                 if (!enc28j60_phy_write(priv, PHCON2, PHCON2_HDLDIS))
 683                         return 0;
 684         }
 685         if (netif_msg_hw(priv))
 686                 enc28j60_dump_regs(priv, "Hw initialized.");
 687
 688         return 1;
 689 }
 690
 691 static void enc28j60_hw_enable(struct enc28j60_net *priv)
 692 {
 693         /* enable interrutps */
 694         if (netif_msg_hw(priv))
 695                 printk(KERN_DEBUG DRV_NAME ": %s() enabling interrupts.\n",
 696                         __FUNCTION__);
 697
 698         enc28j60_phy_write(priv, PHIE, PHIE_PGEIE | PHIE_PLNKIE);
 699
 700         mutex_lock(&priv->lock);
 701         nolock_reg_bfclr(priv, EIR, EIR_DMAIF | EIR_LINKIF |
 702                          EIR_TXIF | EIR_TXERIF | EIR_RXERIF | EIR_PKTIF);
 703         nolock_regb_write(priv, EIE, EIE_INTIE | EIE_PKTIE | EIE_LINKIE |
 704                           EIE_TXIE | EIE_TXERIE | EIE_RXERIE);
 705
 706         /* enable receive logic */
 707         nolock_reg_bfset(priv, ECON1, ECON1_RXEN);
 708         priv->hw_enable = true;
 709         mutex_unlock(&priv->lock);
 710 }
 711
 712 static void enc28j60_hw_disable(struct enc28j60_net *priv)
 713 {
 714         mutex_lock(&priv->lock);
 715         /* disable interrutps and packet reception */
 716         nolock_regb_write(priv, EIE, 0x00);
 717         nolock_reg_bfclr(priv, ECON1, ECON1_RXEN);
 718         priv->hw_enable = false;
 719         mutex_unlock(&priv->lock);
 720 }
 721
 722 static int
 723 enc28j60_setlink(struct net_device *ndev, u8 autoneg, u16 speed, u8 duplex)
 724 {
 725         struct enc28j60_net *priv = netdev_priv(ndev);
 726         int ret = 0;
 727
 728         if (!priv->hw_enable) {
 729                 if (autoneg == AUTONEG_DISABLE && speed == SPEED_10) {
 730                         priv->full_duplex = (duplex == DUPLEX_FULL);
 731                         if (!enc28j60_hw_init(priv)) {
 732                                 if (netif_msg_drv(priv))
 733                                         dev_err(&ndev->dev,
 734                                                 "hw_reset() failed\n");
 735                                 ret = -EINVAL;
 736                         }
 737                 } else {
 738                         if (netif_msg_link(priv))
 739                                 dev_warn(&ndev->dev,
 740                                         "unsupported link setting\n");
 741                         ret = -EOPNOTSUPP;
 742                 }
 743         } else {
 744                 if (netif_msg_link(priv))
 745                         dev_warn(&ndev->dev, "Warning: hw must be disabled "
 746                                 "to set link mode\n");
 747                 ret = -EBUSY;
 748         }
 749         return ret;
 750 }
 751
 752 /*
 753  * Read the Transmit Status Vector
 754  */
 755 static void enc28j60_read_tsv(struct enc28j60_net *priv, u8 tsv[TSV_SIZE])
 756 {
 757         int endptr;
 758
 759         endptr = locked_regw_read(priv, ETXNDL);
 760         if (netif_msg_hw(priv))
 761                 printk(KERN_DEBUG DRV_NAME ": reading TSV at addr:0x%04x\n",
 762                          endptr + 1);
 763         enc28j60_mem_read(priv, endptr + 1, sizeof(tsv), tsv);
 764 }
 765
 766 static void enc28j60_dump_tsv(struct enc28j60_net *priv, const char *msg,
 767                                 u8 tsv[TSV_SIZE])
 768 {
 769         u16 tmp1, tmp2;
 770
 771         printk(KERN_DEBUG DRV_NAME ": %s - TSV:\n", msg);
 772         tmp1 = tsv[1];
 773         tmp1 <<= 8;
 774         tmp1 |= tsv[0];
 775
 776         tmp2 = tsv[5];
 777         tmp2 <<= 8;
 778         tmp2 |= tsv[4];
 779
 780         printk(KERN_DEBUG DRV_NAME ": ByteCount: %d, CollisionCount: %d,"
 781                 " TotByteOnWire: %d\n", tmp1, tsv[2] & 0x0f, tmp2);
 782         printk(KERN_DEBUG DRV_NAME ": TxDone: %d, CRCErr:%d, LenChkErr: %d,"
 783                 " LenOutOfRange: %d\n", TSV_GETBIT(tsv, TSV_TXDONE),
 784                 TSV_GETBIT(tsv, TSV_TXCRCERROR),
 785                 TSV_GETBIT(tsv, TSV_TXLENCHKERROR),
 786                 TSV_GETBIT(tsv, TSV_TXLENOUTOFRANGE));
 787         printk(KERN_DEBUG DRV_NAME ": Multicast: %d, Broadcast: %d, "
 788                 "PacketDefer: %d, ExDefer: %d\n",
 789                 TSV_GETBIT(tsv, TSV_TXMULTICAST),
 790                 TSV_GETBIT(tsv, TSV_TXBROADCAST),
 791                 TSV_GETBIT(tsv, TSV_TXPACKETDEFER),
 792                 TSV_GETBIT(tsv, TSV_TXEXDEFER));
 793         printk(KERN_DEBUG DRV_NAME ": ExCollision: %d, LateCollision: %d, "
 794                  "Giant: %d, Underrun: %d\n",
 795                  TSV_GETBIT(tsv, TSV_TXEXCOLLISION),
 796                  TSV_GETBIT(tsv, TSV_TXLATECOLLISION),
 797                  TSV_GETBIT(tsv, TSV_TXGIANT), TSV_GETBIT(tsv, TSV_TXUNDERRUN));
 798         printk(KERN_DEBUG DRV_NAME ": ControlFrame: %d, PauseFrame: %d, "
 799                  "BackPressApp: %d, VLanTagFrame: %d\n",
 800                  TSV_GETBIT(tsv, TSV_TXCONTROLFRAME),
 801                  TSV_GETBIT(tsv, TSV_TXPAUSEFRAME),
 802                  TSV_GETBIT(tsv, TSV_BACKPRESSUREAPP),
 803                  TSV_GETBIT(tsv, TSV_TXVLANTAGFRAME));
 804 }
 805
 806 /*
 807  * Receive Status vector
 808  */
 809 static void enc28j60_dump_rsv(struct enc28j60_net *priv, const char *msg,
 810                               u16 pk_ptr, int len, u16 sts)
 811 {
 812         printk(KERN_DEBUG DRV_NAME ": %s - NextPk: 0x%04x - RSV:\n",
 813                 msg, pk_ptr);
 814         printk(KERN_DEBUG DRV_NAME ": ByteCount: %d, DribbleNibble: %d\n", len,
 815                  RSV_GETBIT(sts, RSV_DRIBBLENIBBLE));
 816         printk(KERN_DEBUG DRV_NAME ": RxOK: %d, CRCErr:%d, LenChkErr: %d,"
 817                  " LenOutOfRange: %d\n", RSV_GETBIT(sts, RSV_RXOK),
 818                  RSV_GETBIT(sts, RSV_CRCERROR),
 819                  RSV_GETBIT(sts, RSV_LENCHECKERR),
 820                  RSV_GETBIT(sts, RSV_LENOUTOFRANGE));
 821         printk(KERN_DEBUG DRV_NAME ": Multicast: %d, Broadcast: %d, "
 822                  "LongDropEvent: %d, CarrierEvent: %d\n",
 823                  RSV_GETBIT(sts, RSV_RXMULTICAST),
 824                  RSV_GETBIT(sts, RSV_RXBROADCAST),
 825                  RSV_GETBIT(sts, RSV_RXLONGEVDROPEV),
 826                  RSV_GETBIT(sts, RSV_CARRIEREV));
 827         printk(KERN_DEBUG DRV_NAME ": ControlFrame: %d, PauseFrame: %d,"
 828                  " UnknownOp: %d, VLanTagFrame: %d\n",
 829                  RSV_GETBIT(sts, RSV_RXCONTROLFRAME),
 830                  RSV_GETBIT(sts, RSV_RXPAUSEFRAME),
 831                  RSV_GETBIT(sts, RSV_RXUNKNOWNOPCODE),
 832                  RSV_GETBIT(sts, RSV_RXTYPEVLAN));
 833 }
 834
 835 static void dump_packet(const char *msg, int len, const char *data)
 836 {
 837         printk(KERN_DEBUG DRV_NAME ": %s - packet len:%d\n", msg, len);
 838         print_hex_dump(KERN_DEBUG, "pk data: ", DUMP_PREFIX_OFFSET, 16, 1,
 839                         data, len, true);
 840 }
 841
 842 /*
 843  * Hardware receive function.
 844  * Read the buffer memory, update the FIFO pointer to free the buffer,
 845  * check the status vector and decrement the packet counter.
 846  */
 847 static void enc28j60_hw_rx(struct net_device *ndev)
 848 {
 849         struct enc28j60_net *priv = netdev_priv(ndev);
 850         struct sk_buff *skb = NULL;
 851         u16 erxrdpt, next_packet, rxstat;
 852         u8 rsv[RSV_SIZE];
 853         int len;
 854
 855         if (netif_msg_rx_status(priv))
 856                 printk(KERN_DEBUG DRV_NAME ": RX pk_addr:0x%04x\n",
 857                         priv->next_pk_ptr);
 858
 859         if (unlikely(priv->next_pk_ptr > RXEND_INIT)) {
 860                 if (netif_msg_rx_err(priv))
 861                         dev_err(&ndev->dev,
 862                                 "%s() Invalid packet address!! 0x%04x\n",
 863                                 __FUNCTION__, priv->next_pk_ptr);
 864                 /* packet address corrupted: reset RX logic */
 865                 mutex_lock(&priv->lock);
 866                 nolock_reg_bfclr(priv, ECON1, ECON1_RXEN);
 867                 nolock_reg_bfset(priv, ECON1, ECON1_RXRST);
 868                 nolock_reg_bfclr(priv, ECON1, ECON1_RXRST);
 869                 nolock_rxfifo_init(priv, RXSTART_INIT, RXEND_INIT);
 870                 nolock_reg_bfclr(priv, EIR, EIR_RXERIF);
 871                 nolock_reg_bfset(priv, ECON1, ECON1_RXEN);
 872                 mutex_unlock(&priv->lock);
 873                 ndev->stats.rx_errors++;
 874                 return;
 875         }
 876         /* Read next packet pointer and rx status vector */
 877         enc28j60_mem_read(priv, priv->next_pk_ptr, sizeof(rsv), rsv);
 878
 879         next_packet = rsv[1];
 880         next_packet <<= 8;
 881         next_packet |= rsv[0];
 882
 883         len = rsv[3];
 884         len <<= 8;
 885         len |= rsv[2];
 886
 887         rxstat = rsv[5];
 888         rxstat <<= 8;
 889         rxstat |= rsv[4];
 890
 891         if (netif_msg_rx_status(priv))
 892                 enc28j60_dump_rsv(priv, __FUNCTION__, next_packet, len, rxstat);
 893
 894         if (!RSV_GETBIT(rxstat, RSV_RXOK)) {
 895                 if (netif_msg_rx_err(priv))
 896                         dev_err(&ndev->dev, "Rx Error (%04x)\n", rxstat);
 897                 ndev->stats.rx_errors++;
 898                 if (RSV_GETBIT(rxstat, RSV_CRCERROR))
 899                         ndev->stats.rx_crc_errors++;
 900                 if (RSV_GETBIT(rxstat, RSV_LENCHECKERR))
 901                         ndev->stats.rx_frame_errors++;
 902         } else {
 903                 skb = dev_alloc_skb(len + NET_IP_ALIGN);
 904                 if (!skb) {
 905                         if (netif_msg_rx_err(priv))
 906                                 dev_err(&ndev->dev,
 907                                         "out of memory for Rx'd frame\n");
 908                         ndev->stats.rx_dropped++;
 909                 } else {
 910                         skb->dev = ndev;
 911                         skb_reserve(skb, NET_IP_ALIGN);
 912                         /* copy the packet from the receive buffer */
 913                         enc28j60_mem_read(priv, priv->next_pk_ptr + sizeof(rsv),
 914                                         len, skb_put(skb, len));
 915                         if (netif_msg_pktdata(priv))
 916                                 dump_packet(__FUNCTION__, skb->len, skb->data);
 917                         skb->protocol = eth_type_trans(skb, ndev);
 918                         /* update statistics */
 919                         ndev->stats.rx_packets++;
 920                         ndev->stats.rx_bytes += len;
 921                         ndev->last_rx = jiffies;
 922                         netif_rx(skb);
 923                 }
 924         }
 925         /*
 926          * Move the RX read pointer to the start of the next
 927          * received packet.
 928          * This frees the memory we just read out
 929          */
 930         erxrdpt = erxrdpt_workaround(next_packet, RXSTART_INIT, RXEND_INIT);
 931         if (netif_msg_hw(priv))
 932                 printk(KERN_DEBUG DRV_NAME ": %s() ERXRDPT:0x%04x\n",
 933                         __FUNCTION__, erxrdpt);
 934
 935         mutex_lock(&priv->lock);
 936         nolock_regw_write(priv, ERXRDPTL, erxrdpt);
 937 #ifdef CONFIG_ENC28J60_WRITEVERIFY
 938         if (netif_msg_drv(priv)) {
 939                 u16 reg;
 940                 reg = nolock_regw_read(priv, ERXRDPTL);
 941                 if (reg != erxrdpt)
 942                         printk(KERN_DEBUG DRV_NAME ": %s() ERXRDPT verify "
 943                                 "error (0x%04x - 0x%04x)\n", __FUNCTION__,
 944                                 reg, erxrdpt);
 945         }
 946 #endif
 947         priv->next_pk_ptr = next_packet;
 948         /* we are done with this packet, decrement the packet counter */
 949         nolock_reg_bfset(priv, ECON2, ECON2_PKTDEC);
 950         mutex_unlock(&priv->lock);
 951 }
 952
 953 /*
 954  * Calculate free space in RxFIFO
 955  */
 956 static int enc28j60_get_free_rxfifo(struct enc28j60_net *priv)
 957 {
 958         int epkcnt, erxst, erxnd, erxwr, erxrd;
 959         int free_space;
 960
 961         mutex_lock(&priv->lock);
 962         epkcnt = nolock_regb_read(priv, EPKTCNT);
 963         if (epkcnt >= 255)
 964                 free_space = -1;
 965         else {
 966                 erxst = nolock_regw_read(priv, ERXSTL);
 967                 erxnd = nolock_regw_read(priv, ERXNDL);
 968                 erxwr = nolock_regw_read(priv, ERXWRPTL);
 969                 erxrd = nolock_regw_read(priv, ERXRDPTL);
 970
 971                 if (erxwr > erxrd)
 972                         free_space = (erxnd - erxst) - (erxwr - erxrd);
 973                 else if (erxwr == erxrd)
 974                         free_space = (erxnd - erxst);
 975                 else
 976                         free_space = erxrd - erxwr - 1;
 977         }
 978         mutex_unlock(&priv->lock);
 979         if (netif_msg_rx_status(priv))
 980                 printk(KERN_DEBUG DRV_NAME ": %s() free_space = %d\n",
 981                         __FUNCTION__, free_space);
 982         return free_space;
 983 }
 984
 985 /*
 986  * Access the PHY to determine link status
 987  */
 988 static void enc28j60_check_link_status(struct net_device *ndev)
 989 {
 990         struct enc28j60_net *priv = netdev_priv(ndev);
 991         u16 reg;
 992         int duplex;
 993
 994         reg = enc28j60_phy_read(priv, PHSTAT2);
 995         if (netif_msg_hw(priv))
 996                 printk(KERN_DEBUG DRV_NAME ": %s() PHSTAT1: %04x, "
 997                         "PHSTAT2: %04x\n", __FUNCTION__,
 998                         enc28j60_phy_read(priv, PHSTAT1), reg);
 999         duplex = reg & PHSTAT2_DPXSTAT;
1000
1001         if (reg & PHSTAT2_LSTAT) {
1002                 netif_carrier_on(ndev);
1003                 if (netif_msg_ifup(priv))
1004                         dev_info(&ndev->dev, "link up - %s\n",
1005                                 duplex ? "Full duplex" : "Half duplex");
1006         } else {
1007                 if (netif_msg_ifdown(priv))
1008                         dev_info(&ndev->dev, "link down\n");
1009                 netif_carrier_off(ndev);
1010         }
1011 }
1012
1013 static void enc28j60_tx_clear(struct net_device *ndev, bool err)
1014 {
1015         struct enc28j60_net *priv = netdev_priv(ndev);
1016
1017         if (err)
1018                 ndev->stats.tx_errors++;
1019         else
1020                 ndev->stats.tx_packets++;
1021
1022         if (priv->tx_skb) {
1023                 if (!err)
1024                         ndev->stats.tx_bytes += priv->tx_skb->len;
1025                 dev_kfree_skb(priv->tx_skb);
1026                 priv->tx_skb = NULL;
1027         }
1028         locked_reg_bfclr(priv, ECON1, ECON1_TXRTS);
1029         netif_wake_queue(ndev);
1030 }
1031
1032 /*
1033  * RX handler
1034  * ignore PKTIF because is unreliable! (look at the errata datasheet)
1035  * check EPKTCNT is the suggested workaround.
1036  * We don't need to clear interrupt flag, automatically done when
1037  * enc28j60_hw_rx() decrements the packet counter.
1038  * Returns how many packet processed.
1039  */
1040 static int enc28j60_rx_interrupt(struct net_device *ndev)
1041 {
1042         struct enc28j60_net *priv = netdev_priv(ndev);
1043         int pk_counter, ret;
1044
1045         pk_counter = locked_regb_read(priv, EPKTCNT);
1046         if (pk_counter && netif_msg_intr(priv))
1047                 printk(KERN_DEBUG DRV_NAME ": intRX, pk_cnt: %d\n", pk_counter);
1048         if (pk_counter > priv->max_pk_counter) {
1049                 /* update statistics */
1050                 priv->max_pk_counter = pk_counter;
1051                 if (netif_msg_rx_status(priv) && priv->max_pk_counter > 1)
1052                         printk(KERN_DEBUG DRV_NAME ": RX max_pk_cnt: %d\n",
1053                                 priv->max_pk_counter);
1054         }
1055         ret = pk_counter;
1056         while (pk_counter-- > 0)
1057                 enc28j60_hw_rx(ndev);
1058
1059         return ret;
1060 }
1061
1062 static void enc28j60_irq_work_handler(struct work_struct *work)
1063 {
1064         struct enc28j60_net *priv =
1065                 container_of(work, struct enc28j60_net, irq_work);
1066         struct net_device *ndev = priv->netdev;
1067         int intflags, loop;
1068
1069         if (netif_msg_intr(priv))
1070                 printk(KERN_DEBUG DRV_NAME ": %s() enter\n", __FUNCTION__);
1071         /* disable further interrupts */
1072         locked_reg_bfclr(priv, EIE, EIE_INTIE);
1073
1074         do {
1075                 loop = 0;
1076                 intflags = locked_regb_read(priv, EIR);
1077                 /* DMA interrupt handler (not currently used) */
1078                 if ((intflags & EIR_DMAIF) != 0) {
1079                         loop++;
1080                         if (netif_msg_intr(priv))
1081                                 printk(KERN_DEBUG DRV_NAME
1082                                         ": intDMA(%d)\n", loop);
1083                         locked_reg_bfclr(priv, EIR, EIR_DMAIF);
1084                 }
1085                 /* LINK changed handler */
1086                 if ((intflags & EIR_LINKIF) != 0) {
1087                         loop++;
1088                         if (netif_msg_intr(priv))
1089                                 printk(KERN_DEBUG DRV_NAME
1090                                         ": intLINK(%d)\n", loop);
1091                         enc28j60_check_link_status(ndev);
1092                         /* read PHIR to clear the flag */
1093                         enc28j60_phy_read(priv, PHIR);
1094                 }
1095                 /* TX complete handler */
1096                 if ((intflags & EIR_TXIF) != 0) {
1097                         bool err = false;
1098                         loop++;
1099                         if (netif_msg_intr(priv))
1100                                 printk(KERN_DEBUG DRV_NAME
1101                                         ": intTX(%d)\n", loop);
1102                         priv->tx_retry_count = 0;
1103                         if (locked_regb_read(priv, ESTAT) & ESTAT_TXABRT) {
1104                                 if (netif_msg_tx_err(priv))
1105                                         dev_err(&ndev->dev,
1106                                                 "Tx Error (aborted)\n");
1107                                 err = true;
1108                         }
1109                         if (netif_msg_tx_done(priv)) {
1110                                 u8 tsv[TSV_SIZE];
1111                                 enc28j60_read_tsv(priv, tsv);
1112                                 enc28j60_dump_tsv(priv, "Tx Done", tsv);
1113                         }
1114                         enc28j60_tx_clear(ndev, err);
1115                         locked_reg_bfclr(priv, EIR, EIR_TXIF);
1116                 }
1117                 /* TX Error handler */
1118                 if ((intflags & EIR_TXERIF) != 0) {
1119                         u8 tsv[TSV_SIZE];
1120
1121                         loop++;
1122                         if (netif_msg_intr(priv))
1123                                 printk(KERN_DEBUG DRV_NAME
1124                                         ": intTXErr(%d)\n", loop);
1125                         locked_reg_bfclr(priv, ECON1, ECON1_TXRTS);
1126                         enc28j60_read_tsv(priv, tsv);
1127                         if (netif_msg_tx_err(priv))
1128                                 enc28j60_dump_tsv(priv, "Tx Error", tsv);
1129                         /* Reset TX logic */
1130                         mutex_lock(&priv->lock);
1131                         nolock_reg_bfset(priv, ECON1, ECON1_TXRST);
1132                         nolock_reg_bfclr(priv, ECON1, ECON1_TXRST);
1133                         nolock_txfifo_init(priv, TXSTART_INIT, TXEND_INIT);
1134                         mutex_unlock(&priv->lock);
1135                         /* Transmit Late collision check for retransmit */
1136                         if (TSV_GETBIT(tsv, TSV_TXLATECOLLISION)) {
1137                                 if (netif_msg_tx_err(priv))
1138                                         printk(KERN_DEBUG DRV_NAME
1139                                                 ": LateCollision TXErr (%d)\n",
1140                                                 priv->tx_retry_count);
1141                                 if (priv->tx_retry_count++ < MAX_TX_RETRYCOUNT)
1142                                         locked_reg_bfset(priv, ECON1,
1143                                                            ECON1_TXRTS);
1144                                 else
1145                                         enc28j60_tx_clear(ndev, true);
1146                         } else
1147                                 enc28j60_tx_clear(ndev, true);
1148                         locked_reg_bfclr(priv, EIR, EIR_TXERIF);
1149                 }
1150                 /* RX Error handler */
1151                 if ((intflags & EIR_RXERIF) != 0) {
1152                         loop++;
1153                         if (netif_msg_intr(priv))
1154                                 printk(KERN_DEBUG DRV_NAME
1155                                         ": intRXErr(%d)\n", loop);
1156                         /* Check free FIFO space to flag RX overrun */
1157                         if (enc28j60_get_free_rxfifo(priv) <= 0) {
1158                                 if (netif_msg_rx_err(priv))
1159                                         printk(KERN_DEBUG DRV_NAME
1160                                                 ": RX Overrun\n");
1161                                 ndev->stats.rx_dropped++;
1162                         }
1163                         locked_reg_bfclr(priv, EIR, EIR_RXERIF);
1164                 }
1165                 /* RX handler */
1166                 if (enc28j60_rx_interrupt(ndev))
1167                         loop++;
1168         } while (loop);
1169
1170         /* re-enable interrupts */
1171         locked_reg_bfset(priv, EIE, EIE_INTIE);
1172         if (netif_msg_intr(priv))
1173                 printk(KERN_DEBUG DRV_NAME ": %s() exit\n", __FUNCTION__);
1174 }
1175
1176 /*
1177  * Hardware transmit function.
1178  * Fill the buffer memory and send the contents of the transmit buffer
1179  * onto the network
1180  */
1181 static void enc28j60_hw_tx(struct enc28j60_net *priv)
1182 {
1183         if (netif_msg_tx_queued(priv))
1184                 printk(KERN_DEBUG DRV_NAME
1185                         ": Tx Packet Len:%d\n", priv->tx_skb->len);
1186
1187         if (netif_msg_pktdata(priv))
1188                 dump_packet(__FUNCTION__,
1189                             priv->tx_skb->len, priv->tx_skb->data);
1190         enc28j60_packet_write(priv, priv->tx_skb->len, priv->tx_skb->data);
1191
1192 #ifdef CONFIG_ENC28J60_WRITEVERIFY
1193         /* readback and verify written data */
1194         if (netif_msg_drv(priv)) {
1195                 int test_len, k;
1196                 u8 test_buf[64]; /* limit the test to the first 64 bytes */
1197                 int okflag;
1198
1199                 test_len = priv->tx_skb->len;
1200                 if (test_len > sizeof(test_buf))
1201                         test_len = sizeof(test_buf);
1202
1203                 /* + 1 to skip control byte */
1204                 enc28j60_mem_read(priv, TXSTART_INIT + 1, test_len, test_buf);
1205                 okflag = 1;
1206                 for (k = 0; k < test_len; k++) {
1207                         if (priv->tx_skb->data[k] != test_buf[k]) {
1208                                 printk(KERN_DEBUG DRV_NAME
1209                                          ": Error, %d location differ: "
1210                                          "0x%02x-0x%02x\n", k,
1211                                          priv->tx_skb->data[k], test_buf[k]);
1212                                 okflag = 0;
1213                         }
1214                 }
1215                 if (!okflag)
1216                         printk(KERN_DEBUG DRV_NAME ": Tx write buffer, "
1217                                 "verify ERROR!\n");
1218         }
1219 #endif
1220         /* set TX request flag */
1221         locked_reg_bfset(priv, ECON1, ECON1_TXRTS);
1222 }
1223
1224 static int enc28j60_send_packet(struct sk_buff *skb, struct net_device *dev)
1225 {
1226         struct enc28j60_net *priv = netdev_priv(dev);
1227
1228         if (netif_msg_tx_queued(priv))
1229                 printk(KERN_DEBUG DRV_NAME ": %s() enter\n", __FUNCTION__);
1230
1231         /* If some error occurs while trying to transmit this
1232          * packet, you should return '1' from this function.
1233          * In such a case you _may not_ do anything to the
1234          * SKB, it is still owned by the network queueing
1235          * layer when an error is returned.  This means you
1236          * may not modify any SKB fields, you may not free
1237          * the SKB, etc.
1238          */
1239         netif_stop_queue(dev);
1240
1241         /* save the timestamp */
1242         priv->netdev->trans_start = jiffies;
1243         /* Remember the skb for deferred processing */
1244         priv->tx_skb = skb;
1245         schedule_work(&priv->tx_work);
1246
1247         return 0;
1248 }
1249
1250 static void enc28j60_tx_work_handler(struct work_struct *work)
1251 {
1252         struct enc28j60_net *priv =
1253                 container_of(work, struct enc28j60_net, tx_work);
1254
1255         /* actual delivery of data */
1256         enc28j60_hw_tx(priv);
1257 }
1258
1259 static irqreturn_t enc28j60_irq(int irq, void *dev_id)
1260 {
1261         struct enc28j60_net *priv = dev_id;
1262
1263         /*
1264          * Can't do anything in interrupt context because we need to
1265          * block (spi_sync() is blocking) so fire of the interrupt
1266          * handling workqueue.
1267          * Remember that we access enc28j60 registers through SPI bus
1268          * via spi_sync() call.
1269          */
1270         schedule_work(&priv->irq_work);
1271
1272         return IRQ_HANDLED;
1273 }
1274
1275 static void enc28j60_tx_timeout(struct net_device *ndev)
1276 {
1277         struct enc28j60_net *priv = netdev_priv(ndev);
1278
1279         if (netif_msg_timer(priv))
1280                 dev_err(&ndev->dev, DRV_NAME " tx timeout\n");
1281
1282         ndev->stats.tx_errors++;
1283         /* can't restart safely under softirq */
1284         schedule_work(&priv->restart_work);
1285 }
1286
1287 /*
1288  * Open/initialize the board. This is called (in the current kernel)
1289  * sometime after booting when the 'ifconfig' program is run.
1290  *
1291  * This routine should set everything up anew at each open, even
1292  * registers that "should" only need to be set once at boot, so that
1293  * there is non-reboot way to recover if something goes wrong.
1294  */
1295 static int enc28j60_net_open(struct net_device *dev)
1296 {
1297         struct enc28j60_net *priv = netdev_priv(dev);
1298
1299         if (netif_msg_drv(priv))
1300                 printk(KERN_DEBUG DRV_NAME ": %s() enter\n", __FUNCTION__);
1301
1302         if (!is_valid_ether_addr(dev->dev_addr)) {
1303                 if (netif_msg_ifup(priv)) {
1304                         DECLARE_MAC_BUF(mac);
1305                         dev_err(&dev->dev, "invalid MAC address %s\n",
1306                                 print_mac(mac, dev->dev_addr));
1307                 }
1308                 return -EADDRNOTAVAIL;
1309         }
1310         /* Reset the hardware here */
1311         enc28j60_hw_disable(priv);
1312         if (!enc28j60_hw_init(priv)) {
1313                 if (netif_msg_ifup(priv))
1314                         dev_err(&dev->dev, "hw_reset() failed\n");
1315                 return -EINVAL;
1316         }
1317         /* Update the MAC address (in case user has changed it) */
1318         enc28j60_set_hw_macaddr(dev);
1319         /* Enable interrupts */
1320         enc28j60_hw_enable(priv);
1321         /* check link status */
1322         enc28j60_check_link_status(dev);
1323         /* We are now ready to accept transmit requests from
1324          * the queueing layer of the networking.
1325          */
1326         netif_start_queue(dev);
1327
1328         return 0;
1329 }
1330
1331 /* The inverse routine to net_open(). */
1332 static int enc28j60_net_close(struct net_device *dev)
1333 {
1334         struct enc28j60_net *priv = netdev_priv(dev);
1335
1336         if (netif_msg_drv(priv))
1337                 printk(KERN_DEBUG DRV_NAME ": %s() enter\n", __FUNCTION__);
1338
1339         enc28j60_hw_disable(priv);
1340         netif_stop_queue(dev);
1341
1342         return 0;
1343 }
1344
1345 /*
1346  * Set or clear the multicast filter for this adapter
1347  * num_addrs == -1      Promiscuous mode, receive all packets
1348  * num_addrs == 0       Normal mode, filter out multicast packets
1349  * num_addrs > 0        Multicast mode, receive normal and MC packets
1350  */
1351 static void enc28j60_set_multicast_list(struct net_device *dev)
1352 {
1353         struct enc28j60_net *priv = netdev_priv(dev);
1354         int oldfilter = priv->rxfilter;
1355
1356         if (dev->flags & IFF_PROMISC) {
1357                 if (netif_msg_link(priv))
1358                         dev_info(&dev->dev, "promiscuous mode\n");
1359                 priv->rxfilter = RXFILTER_PROMISC;
1360         } else if ((dev->flags & IFF_ALLMULTI) || dev->mc_count) {
1361                 if (netif_msg_link(priv))
1362                         dev_info(&dev->dev, "%smulticast mode\n",
1363                                 (dev->flags & IFF_ALLMULTI) ? "all-" : "");
1364                 priv->rxfilter = RXFILTER_MULTI;
1365         } else {
1366                 if (netif_msg_link(priv))
1367                         dev_info(&dev->dev, "normal mode\n");
1368                 priv->rxfilter = RXFILTER_NORMAL;
1369         }
1370
1371         if (oldfilter != priv->rxfilter)
1372                 schedule_work(&priv->setrx_work);
1373 }
1374
1375 static void enc28j60_setrx_work_handler(struct work_struct *work)
1376 {
1377         struct enc28j60_net *priv =
1378                 container_of(work, struct enc28j60_net, setrx_work);
1379
1380         if (priv->rxfilter == RXFILTER_PROMISC) {
1381                 if (netif_msg_drv(priv))
1382                         printk(KERN_DEBUG DRV_NAME ": promiscuous mode\n");
1383                 locked_regb_write(priv, ERXFCON, 0x00);
1384         } else if (priv->rxfilter == RXFILTER_MULTI) {
1385                 if (netif_msg_drv(priv))
1386                         printk(KERN_DEBUG DRV_NAME ": multicast mode\n");
1387                 locked_regb_write(priv, ERXFCON,
1388                                         ERXFCON_UCEN | ERXFCON_CRCEN |
1389                                         ERXFCON_BCEN | ERXFCON_MCEN);
1390         } else {
1391                 if (netif_msg_drv(priv))
1392                         printk(KERN_DEBUG DRV_NAME ": normal mode\n");
1393                 locked_regb_write(priv, ERXFCON,
1394                                         ERXFCON_UCEN | ERXFCON_CRCEN |
1395                                         ERXFCON_BCEN);
1396         }
1397 }
1398
1399 static void enc28j60_restart_work_handler(struct work_struct *work)
1400 {
1401         struct enc28j60_net *priv =
1402                         container_of(work, struct enc28j60_net, restart_work);
1403         struct net_device *ndev = priv->netdev;
1404         int ret;
1405
1406         rtnl_lock();
1407         if (netif_running(ndev)) {
1408                 enc28j60_net_close(ndev);
1409                 ret = enc28j60_net_open(ndev);
1410                 if (unlikely(ret)) {
1411                         dev_info(&ndev->dev, " could not restart %d\n", ret);
1412                         dev_close(ndev);
1413                 }
1414         }
1415         rtnl_unlock();
1416 }
1417
1418 /* ......................... ETHTOOL SUPPORT ........................... */
1419
1420 static void
1421 enc28j60_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1422 {
1423         strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
1424         strlcpy(info->version, DRV_VERSION, sizeof(info->version));
1425         strlcpy(info->bus_info,
1426                 dev->dev.parent->bus_id, sizeof(info->bus_info));
1427 }
1428
1429 static int
1430 enc28j60_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1431 {
1432         struct enc28j60_net *priv = netdev_priv(dev);
1433
1434         cmd->transceiver = XCVR_INTERNAL;
1435         cmd->supported  = SUPPORTED_10baseT_Half
1436                         | SUPPORTED_10baseT_Full
1437                         | SUPPORTED_TP;
1438         cmd->speed      = SPEED_10;
1439         cmd->duplex     = priv->full_duplex ? DUPLEX_FULL : DUPLEX_HALF;
1440         cmd->port       = PORT_TP;
1441         cmd->autoneg    = AUTONEG_DISABLE;
1442
1443         return 0;
1444 }
1445
1446 static int
1447 enc28j60_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1448 {
1449         return enc28j60_setlink(dev, cmd->autoneg, cmd->speed, cmd->duplex);
1450 }
1451
1452 static u32 enc28j60_get_msglevel(struct net_device *dev)
1453 {
1454         struct enc28j60_net *priv = netdev_priv(dev);
1455         return priv->msg_enable;
1456 }
1457
1458 static void enc28j60_set_msglevel(struct net_device *dev, u32 val)
1459 {
1460         struct enc28j60_net *priv = netdev_priv(dev);
1461         priv->msg_enable = val;
1462 }
1463
1464 static const struct ethtool_ops enc28j60_ethtool_ops = {
1465         .get_settings   = enc28j60_get_settings,
1466         .set_settings   = enc28j60_set_settings,
1467         .get_drvinfo    = enc28j60_get_drvinfo,
1468         .get_msglevel   = enc28j60_get_msglevel,
1469         .set_msglevel   = enc28j60_set_msglevel,
1470 };
1471
1472 static int enc28j60_chipset_init(struct net_device *dev)
1473 {
1474         struct enc28j60_net *priv = netdev_priv(dev);
1475
1476         return enc28j60_hw_init(priv);
1477 }
1478
1479 static int __devinit enc28j60_probe(struct spi_device *spi)
1480 {
1481         struct net_device *dev;
1482         struct enc28j60_net *priv;
1483         int ret = 0;
1484
1485         if (netif_msg_drv(&debug))
1486                 dev_info(&spi->dev, DRV_NAME " Ethernet driver %s loaded\n",
1487                         DRV_VERSION);
1488
1489         dev = alloc_etherdev(sizeof(struct enc28j60_net));
1490         if (!dev) {
1491                 if (netif_msg_drv(&debug))
1492                         dev_err(&spi->dev, DRV_NAME
1493                                 ": unable to alloc new ethernet\n");
1494                 ret = -ENOMEM;
1495                 goto error_alloc;
1496         }
1497         priv = netdev_priv(dev);
1498
1499         priv->netdev = dev;     /* priv to netdev reference */
1500         priv->spi = spi;        /* priv to spi reference */
1501         priv->msg_enable = netif_msg_init(debug.msg_enable,
1502                                                 ENC28J60_MSG_DEFAULT);
1503         mutex_init(&priv->lock);
1504         INIT_WORK(&priv->tx_work, enc28j60_tx_work_handler);
1505         INIT_WORK(&priv->setrx_work, enc28j60_setrx_work_handler);
1506         INIT_WORK(&priv->irq_work, enc28j60_irq_work_handler);
1507         INIT_WORK(&priv->restart_work, enc28j60_restart_work_handler);
1508         dev_set_drvdata(&spi->dev, priv);       /* spi to priv reference */
1509         SET_NETDEV_DEV(dev, &spi->dev);
1510
1511         if (!enc28j60_chipset_init(dev)) {
1512                 if (netif_msg_probe(priv))
1513                         dev_info(&spi->dev, DRV_NAME " chip not found\n");
1514                 ret = -EIO;
1515                 goto error_irq;
1516         }
1517         random_ether_addr(dev->dev_addr);
1518         enc28j60_set_hw_macaddr(dev);
1519
1520         ret = request_irq(spi->irq, enc28j60_irq, IRQF_TRIGGER_FALLING,
1521                           DRV_NAME, priv);
1522         if (ret < 0) {
1523                 if (netif_msg_probe(priv))
1524                         dev_err(&spi->dev, DRV_NAME ": request irq %d failed "
1525                                 "(ret = %d)\n", spi->irq, ret);
1526                 goto error_irq;
1527         }
1528
1529         dev->if_port = IF_PORT_10BASET;
1530         dev->irq = spi->irq;
1531         dev->open = enc28j60_net_open;
1532         dev->stop = enc28j60_net_close;
1533         dev->hard_start_xmit = enc28j60_send_packet;
1534         dev->set_multicast_list = &enc28j60_set_multicast_list;
1535         dev->set_mac_address = enc28j60_set_mac_address;
1536         dev->tx_timeout = &enc28j60_tx_timeout;
1537         dev->watchdog_timeo = TX_TIMEOUT;
1538         SET_ETHTOOL_OPS(dev, &enc28j60_ethtool_ops);
1539
1540         ret = register_netdev(dev);
1541         if (ret) {
1542                 if (netif_msg_probe(priv))
1543                         dev_err(&spi->dev, "register netdev " DRV_NAME
1544                                 " failed (ret = %d)\n", ret);
1545                 goto error_register;
1546         }
1547         dev_info(&dev->dev, DRV_NAME " driver registered\n");
1548
1549         return 0;
1550
1551 error_register:
1552         free_irq(spi->irq, priv);
1553 error_irq:
1554         free_netdev(dev);
1555 error_alloc:
1556         return ret;
1557 }
1558
1559 static int enc28j60_remove(struct spi_device *spi)
1560 {
1561         struct enc28j60_net *priv = dev_get_drvdata(&spi->dev);
1562
1563         if (netif_msg_drv(priv))
1564                 printk(KERN_DEBUG DRV_NAME ": remove\n");
1565
1566         unregister_netdev(priv->netdev);
1567         free_irq(spi->irq, priv);
1568         free_netdev(priv->netdev);
1569
1570         return 0;
1571 }
1572
1573 static struct spi_driver enc28j60_driver = {
1574         .driver = {
1575                    .name = DRV_NAME,
1576                    .bus = &spi_bus_type,
1577                    .owner = THIS_MODULE,
1578                    },
1579         .probe = enc28j60_probe,
1580         .remove = __devexit_p(enc28j60_remove),
1581 };
1582
1583 static int __init enc28j60_init(void)
1584 {
1585         return spi_register_driver(&enc28j60_driver);
1586 }
1587
1588 module_init(enc28j60_init);
1589
1590 static void __exit enc28j60_exit(void)
1591 {
1592         spi_unregister_driver(&enc28j60_driver);
1593 }
1594
1595 module_exit(enc28j60_exit);
1596
1597 MODULE_DESCRIPTION(DRV_NAME " ethernet driver");
1598 MODULE_AUTHOR("Claudio Lanconelli <lanconelli.claudio@eptar.com>");
1599 MODULE_LICENSE("GPL");
1600 module_param_named(debug, debug.msg_enable, int, 0);
1601 MODULE_PARM_DESC(debug, "Debug verbosity level (0=none, ..., ffff=all)");