drivers/net/usb/smsc75xx.c

   1  /***************************************************************************
   2  *
   3  * Copyright (C) 2007-2010 SMSC
   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  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  *****************************************************************************/
  19
  20 #include <linux/module.h>
  21 #include <linux/kmod.h>
  22 #include <linux/netdevice.h>
  23 #include <linux/etherdevice.h>
  24 #include <linux/ethtool.h>
  25 #include <linux/mii.h>
  26 #include <linux/usb.h>
  27 #include <linux/bitrev.h>
  28 #include <linux/crc16.h>
  29 #include <linux/crc32.h>
  30 #include <linux/usb/usbnet.h>
  31 #include <linux/slab.h>
  32 #include <linux/of_net.h>
  33 #include "smsc75xx.h"
  34
  35 #define SMSC_CHIPNAME                   "smsc75xx"
  36 #define SMSC_DRIVER_VERSION             "1.0.0"
  37 #define HS_USB_PKT_SIZE                 (512)
  38 #define FS_USB_PKT_SIZE                 (64)
  39 #define DEFAULT_HS_BURST_CAP_SIZE       (16 * 1024 + 5 * HS_USB_PKT_SIZE)
  40 #define DEFAULT_FS_BURST_CAP_SIZE       (6 * 1024 + 33 * FS_USB_PKT_SIZE)
  41 #define DEFAULT_BULK_IN_DELAY           (0x00002000)
  42 #define MAX_SINGLE_PACKET_SIZE          (9000)
  43 #define LAN75XX_EEPROM_MAGIC            (0x7500)
  44 #define EEPROM_MAC_OFFSET               (0x01)
  45 #define DEFAULT_TX_CSUM_ENABLE          (true)
  46 #define DEFAULT_RX_CSUM_ENABLE          (true)
  47 #define SMSC75XX_INTERNAL_PHY_ID        (1)
  48 #define SMSC75XX_TX_OVERHEAD            (8)
  49 #define MAX_RX_FIFO_SIZE                (20 * 1024)
  50 #define MAX_TX_FIFO_SIZE                (12 * 1024)
  51 #define USB_VENDOR_ID_SMSC              (0x0424)
  52 #define USB_PRODUCT_ID_LAN7500          (0x7500)
  53 #define USB_PRODUCT_ID_LAN7505          (0x7505)
  54 #define RXW_PADDING                     2
  55 #define SUPPORTED_WAKE                  (WAKE_PHY | WAKE_UCAST | WAKE_BCAST | \
  56                                          WAKE_MCAST | WAKE_ARP | WAKE_MAGIC)
  57
  58 #define SUSPEND_SUSPEND0                (0x01)
  59 #define SUSPEND_SUSPEND1                (0x02)
  60 #define SUSPEND_SUSPEND2                (0x04)
  61 #define SUSPEND_SUSPEND3                (0x08)
  62 #define SUSPEND_ALLMODES                (SUSPEND_SUSPEND0 | SUSPEND_SUSPEND1 | \
  63                                          SUSPEND_SUSPEND2 | SUSPEND_SUSPEND3)
  64
  65 struct smsc75xx_priv {
  66         struct usbnet *dev;
  67         u32 rfe_ctl;
  68         u32 wolopts;
  69         u32 multicast_hash_table[DP_SEL_VHF_HASH_LEN];
  70         struct mutex dataport_mutex;
  71         spinlock_t rfe_ctl_lock;
  72         struct work_struct set_multicast;
  73         u8 suspend_flags;
  74 };
  75
  76 struct usb_context {
  77         struct usb_ctrlrequest req;
  78         struct usbnet *dev;
  79 };
  80
  81 static bool turbo_mode = true;
  82 module_param(turbo_mode, bool, 0644);
  83 MODULE_PARM_DESC(turbo_mode, "Enable multiple frames per Rx transaction");
  84
  85 static int smsc75xx_link_ok_nopm(struct usbnet *dev);
  86 static int smsc75xx_phy_gig_workaround(struct usbnet *dev);
  87
  88 static int __must_check __smsc75xx_read_reg(struct usbnet *dev, u32 index,
  89                                             u32 *data, int in_pm)
  90 {
  91         u32 buf;
  92         int ret;
  93         int (*fn)(struct usbnet *, u8, u8, u16, u16, void *, u16);
  94
  95         BUG_ON(!dev);
  96
  97         if (!in_pm)
  98                 fn = usbnet_read_cmd;
  99         else
 100                 fn = usbnet_read_cmd_nopm;
 101
 102         ret = fn(dev, USB_VENDOR_REQUEST_READ_REGISTER, USB_DIR_IN
 103                  | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 104                  0, index, &buf, 4);
 105         if (unlikely(ret < 0)) {
 106                 netdev_warn(dev->net, "Failed to read reg index 0x%08x: %d\n",
 107                             index, ret);
 108                 return ret;
 109         }
 110
 111         le32_to_cpus(&buf);
 112         *data = buf;
 113
 114         return ret;
 115 }
 116
 117 static int __must_check __smsc75xx_write_reg(struct usbnet *dev, u32 index,
 118                                              u32 data, int in_pm)
 119 {
 120         u32 buf;
 121         int ret;
 122         int (*fn)(struct usbnet *, u8, u8, u16, u16, const void *, u16);
 123
 124         BUG_ON(!dev);
 125
 126         if (!in_pm)
 127                 fn = usbnet_write_cmd;
 128         else
 129                 fn = usbnet_write_cmd_nopm;
 130
 131         buf = data;
 132         cpu_to_le32s(&buf);
 133
 134         ret = fn(dev, USB_VENDOR_REQUEST_WRITE_REGISTER, USB_DIR_OUT
 135                  | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 136                  0, index, &buf, 4);
 137         if (unlikely(ret < 0))
 138                 netdev_warn(dev->net, "Failed to write reg index 0x%08x: %d\n",
 139                             index, ret);
 140
 141         return ret;
 142 }
 143
 144 static int __must_check smsc75xx_read_reg_nopm(struct usbnet *dev, u32 index,
 145                                                u32 *data)
 146 {
 147         return __smsc75xx_read_reg(dev, index, data, 1);
 148 }
 149
 150 static int __must_check smsc75xx_write_reg_nopm(struct usbnet *dev, u32 index,
 151                                                 u32 data)
 152 {
 153         return __smsc75xx_write_reg(dev, index, data, 1);
 154 }
 155
 156 static int __must_check smsc75xx_read_reg(struct usbnet *dev, u32 index,
 157                                           u32 *data)
 158 {
 159         return __smsc75xx_read_reg(dev, index, data, 0);
 160 }
 161
 162 static int __must_check smsc75xx_write_reg(struct usbnet *dev, u32 index,
 163                                            u32 data)
 164 {
 165         return __smsc75xx_write_reg(dev, index, data, 0);
 166 }
 167
 168 /* Loop until the read is completed with timeout
 169  * called with phy_mutex held */
 170 static __must_check int __smsc75xx_phy_wait_not_busy(struct usbnet *dev,
 171                                                      int in_pm)
 172 {
 173         unsigned long start_time = jiffies;
 174         u32 val;
 175         int ret;
 176
 177         do {
 178                 ret = __smsc75xx_read_reg(dev, MII_ACCESS, &val, in_pm);
 179                 if (ret < 0) {
 180                         netdev_warn(dev->net, "Error reading MII_ACCESS\n");
 181                         return ret;
 182                 }
 183
 184                 if (!(val & MII_ACCESS_BUSY))
 185                         return 0;
 186         } while (!time_after(jiffies, start_time + HZ));
 187
 188         return -EIO;
 189 }
 190
 191 static int __smsc75xx_mdio_read(struct net_device *netdev, int phy_id, int idx,
 192                                 int in_pm)
 193 {
 194         struct usbnet *dev = netdev_priv(netdev);
 195         u32 val, addr;
 196         int ret;
 197
 198         mutex_lock(&dev->phy_mutex);
 199
 200         /* confirm MII not busy */
 201         ret = __smsc75xx_phy_wait_not_busy(dev, in_pm);
 202         if (ret < 0) {
 203                 netdev_warn(dev->net, "MII is busy in smsc75xx_mdio_read\n");
 204                 goto done;
 205         }
 206
 207         /* set the address, index & direction (read from PHY) */
 208         phy_id &= dev->mii.phy_id_mask;
 209         idx &= dev->mii.reg_num_mask;
 210         addr = ((phy_id << MII_ACCESS_PHY_ADDR_SHIFT) & MII_ACCESS_PHY_ADDR)
 211                 | ((idx << MII_ACCESS_REG_ADDR_SHIFT) & MII_ACCESS_REG_ADDR)
 212                 | MII_ACCESS_READ | MII_ACCESS_BUSY;
 213         ret = __smsc75xx_write_reg(dev, MII_ACCESS, addr, in_pm);
 214         if (ret < 0) {
 215                 netdev_warn(dev->net, "Error writing MII_ACCESS\n");
 216                 goto done;
 217         }
 218
 219         ret = __smsc75xx_phy_wait_not_busy(dev, in_pm);
 220         if (ret < 0) {
 221                 netdev_warn(dev->net, "Timed out reading MII reg %02X\n", idx);
 222                 goto done;
 223         }
 224
 225         ret = __smsc75xx_read_reg(dev, MII_DATA, &val, in_pm);
 226         if (ret < 0) {
 227                 netdev_warn(dev->net, "Error reading MII_DATA\n");
 228                 goto done;
 229         }
 230
 231         ret = (u16)(val & 0xFFFF);
 232
 233 done:
 234         mutex_unlock(&dev->phy_mutex);
 235         return ret;
 236 }
 237
 238 static void __smsc75xx_mdio_write(struct net_device *netdev, int phy_id,
 239                                   int idx, int regval, int in_pm)
 240 {
 241         struct usbnet *dev = netdev_priv(netdev);
 242         u32 val, addr;
 243         int ret;
 244
 245         mutex_lock(&dev->phy_mutex);
 246
 247         /* confirm MII not busy */
 248         ret = __smsc75xx_phy_wait_not_busy(dev, in_pm);
 249         if (ret < 0) {
 250                 netdev_warn(dev->net, "MII is busy in smsc75xx_mdio_write\n");
 251                 goto done;
 252         }
 253
 254         val = regval;
 255         ret = __smsc75xx_write_reg(dev, MII_DATA, val, in_pm);
 256         if (ret < 0) {
 257                 netdev_warn(dev->net, "Error writing MII_DATA\n");
 258                 goto done;
 259         }
 260
 261         /* set the address, index & direction (write to PHY) */
 262         phy_id &= dev->mii.phy_id_mask;
 263         idx &= dev->mii.reg_num_mask;
 264         addr = ((phy_id << MII_ACCESS_PHY_ADDR_SHIFT) & MII_ACCESS_PHY_ADDR)
 265                 | ((idx << MII_ACCESS_REG_ADDR_SHIFT) & MII_ACCESS_REG_ADDR)
 266                 | MII_ACCESS_WRITE | MII_ACCESS_BUSY;
 267         ret = __smsc75xx_write_reg(dev, MII_ACCESS, addr, in_pm);
 268         if (ret < 0) {
 269                 netdev_warn(dev->net, "Error writing MII_ACCESS\n");
 270                 goto done;
 271         }
 272
 273         ret = __smsc75xx_phy_wait_not_busy(dev, in_pm);
 274         if (ret < 0) {
 275                 netdev_warn(dev->net, "Timed out writing MII reg %02X\n", idx);
 276                 goto done;
 277         }
 278
 279 done:
 280         mutex_unlock(&dev->phy_mutex);
 281 }
 282
 283 static int smsc75xx_mdio_read_nopm(struct net_device *netdev, int phy_id,
 284                                    int idx)
 285 {
 286         return __smsc75xx_mdio_read(netdev, phy_id, idx, 1);
 287 }
 288
 289 static void smsc75xx_mdio_write_nopm(struct net_device *netdev, int phy_id,
 290                                      int idx, int regval)
 291 {
 292         __smsc75xx_mdio_write(netdev, phy_id, idx, regval, 1);
 293 }
 294
 295 static int smsc75xx_mdio_read(struct net_device *netdev, int phy_id, int idx)
 296 {
 297         return __smsc75xx_mdio_read(netdev, phy_id, idx, 0);
 298 }
 299
 300 static void smsc75xx_mdio_write(struct net_device *netdev, int phy_id, int idx,
 301                                 int regval)
 302 {
 303         __smsc75xx_mdio_write(netdev, phy_id, idx, regval, 0);
 304 }
 305
 306 static int smsc75xx_wait_eeprom(struct usbnet *dev)
 307 {
 308         unsigned long start_time = jiffies;
 309         u32 val;
 310         int ret;
 311
 312         do {
 313                 ret = smsc75xx_read_reg(dev, E2P_CMD, &val);
 314                 if (ret < 0) {
 315                         netdev_warn(dev->net, "Error reading E2P_CMD\n");
 316                         return ret;
 317                 }
 318
 319                 if (!(val & E2P_CMD_BUSY) || (val & E2P_CMD_TIMEOUT))
 320                         break;
 321                 udelay(40);
 322         } while (!time_after(jiffies, start_time + HZ));
 323
 324         if (val & (E2P_CMD_TIMEOUT | E2P_CMD_BUSY)) {
 325                 netdev_warn(dev->net, "EEPROM read operation timeout\n");
 326                 return -EIO;
 327         }
 328
 329         return 0;
 330 }
 331
 332 static int smsc75xx_eeprom_confirm_not_busy(struct usbnet *dev)
 333 {
 334         unsigned long start_time = jiffies;
 335         u32 val;
 336         int ret;
 337
 338         do {
 339                 ret = smsc75xx_read_reg(dev, E2P_CMD, &val);
 340                 if (ret < 0) {
 341                         netdev_warn(dev->net, "Error reading E2P_CMD\n");
 342                         return ret;
 343                 }
 344
 345                 if (!(val & E2P_CMD_BUSY))
 346                         return 0;
 347
 348                 udelay(40);
 349         } while (!time_after(jiffies, start_time + HZ));
 350
 351         netdev_warn(dev->net, "EEPROM is busy\n");
 352         return -EIO;
 353 }
 354
 355 static int smsc75xx_read_eeprom(struct usbnet *dev, u32 offset, u32 length,
 356                                 u8 *data)
 357 {
 358         u32 val;
 359         int i, ret;
 360
 361         BUG_ON(!dev);
 362         BUG_ON(!data);
 363
 364         ret = smsc75xx_eeprom_confirm_not_busy(dev);
 365         if (ret)
 366                 return ret;
 367
 368         for (i = 0; i < length; i++) {
 369                 val = E2P_CMD_BUSY | E2P_CMD_READ | (offset & E2P_CMD_ADDR);
 370                 ret = smsc75xx_write_reg(dev, E2P_CMD, val);
 371                 if (ret < 0) {
 372                         netdev_warn(dev->net, "Error writing E2P_CMD\n");
 373                         return ret;
 374                 }
 375
 376                 ret = smsc75xx_wait_eeprom(dev);
 377                 if (ret < 0)
 378                         return ret;
 379
 380                 ret = smsc75xx_read_reg(dev, E2P_DATA, &val);
 381                 if (ret < 0) {
 382                         netdev_warn(dev->net, "Error reading E2P_DATA\n");
 383                         return ret;
 384                 }
 385
 386                 data[i] = val & 0xFF;
 387                 offset++;
 388         }
 389
 390         return 0;
 391 }
 392
 393 static int smsc75xx_write_eeprom(struct usbnet *dev, u32 offset, u32 length,
 394                                  u8 *data)
 395 {
 396         u32 val;
 397         int i, ret;
 398
 399         BUG_ON(!dev);
 400         BUG_ON(!data);
 401
 402         ret = smsc75xx_eeprom_confirm_not_busy(dev);
 403         if (ret)
 404                 return ret;
 405
 406         /* Issue write/erase enable command */
 407         val = E2P_CMD_BUSY | E2P_CMD_EWEN;
 408         ret = smsc75xx_write_reg(dev, E2P_CMD, val);
 409         if (ret < 0) {
 410                 netdev_warn(dev->net, "Error writing E2P_CMD\n");
 411                 return ret;
 412         }
 413
 414         ret = smsc75xx_wait_eeprom(dev);
 415         if (ret < 0)
 416                 return ret;
 417
 418         for (i = 0; i < length; i++) {
 419
 420                 /* Fill data register */
 421                 val = data[i];
 422                 ret = smsc75xx_write_reg(dev, E2P_DATA, val);
 423                 if (ret < 0) {
 424                         netdev_warn(dev->net, "Error writing E2P_DATA\n");
 425                         return ret;
 426                 }
 427
 428                 /* Send "write" command */
 429                 val = E2P_CMD_BUSY | E2P_CMD_WRITE | (offset & E2P_CMD_ADDR);
 430                 ret = smsc75xx_write_reg(dev, E2P_CMD, val);
 431                 if (ret < 0) {
 432                         netdev_warn(dev->net, "Error writing E2P_CMD\n");
 433                         return ret;
 434                 }
 435
 436                 ret = smsc75xx_wait_eeprom(dev);
 437                 if (ret < 0)
 438                         return ret;
 439
 440                 offset++;
 441         }
 442
 443         return 0;
 444 }
 445
 446 static int smsc75xx_dataport_wait_not_busy(struct usbnet *dev)
 447 {
 448         int i, ret;
 449
 450         for (i = 0; i < 100; i++) {
 451                 u32 dp_sel;
 452                 ret = smsc75xx_read_reg(dev, DP_SEL, &dp_sel);
 453                 if (ret < 0) {
 454                         netdev_warn(dev->net, "Error reading DP_SEL\n");
 455                         return ret;
 456                 }
 457
 458                 if (dp_sel & DP_SEL_DPRDY)
 459                         return 0;
 460
 461                 udelay(40);
 462         }
 463
 464         netdev_warn(dev->net, "smsc75xx_dataport_wait_not_busy timed out\n");
 465
 466         return -EIO;
 467 }
 468
 469 static int smsc75xx_dataport_write(struct usbnet *dev, u32 ram_select, u32 addr,
 470                                    u32 length, u32 *buf)
 471 {
 472         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
 473         u32 dp_sel;
 474         int i, ret;
 475
 476         mutex_lock(&pdata->dataport_mutex);
 477
 478         ret = smsc75xx_dataport_wait_not_busy(dev);
 479         if (ret < 0) {
 480                 netdev_warn(dev->net, "smsc75xx_dataport_write busy on entry\n");
 481                 goto done;
 482         }
 483
 484         ret = smsc75xx_read_reg(dev, DP_SEL, &dp_sel);
 485         if (ret < 0) {
 486                 netdev_warn(dev->net, "Error reading DP_SEL\n");
 487                 goto done;
 488         }
 489
 490         dp_sel &= ~DP_SEL_RSEL;
 491         dp_sel |= ram_select;
 492         ret = smsc75xx_write_reg(dev, DP_SEL, dp_sel);
 493         if (ret < 0) {
 494                 netdev_warn(dev->net, "Error writing DP_SEL\n");
 495                 goto done;
 496         }
 497
 498         for (i = 0; i < length; i++) {
 499                 ret = smsc75xx_write_reg(dev, DP_ADDR, addr + i);
 500                 if (ret < 0) {
 501                         netdev_warn(dev->net, "Error writing DP_ADDR\n");
 502                         goto done;
 503                 }
 504
 505                 ret = smsc75xx_write_reg(dev, DP_DATA, buf[i]);
 506                 if (ret < 0) {
 507                         netdev_warn(dev->net, "Error writing DP_DATA\n");
 508                         goto done;
 509                 }
 510
 511                 ret = smsc75xx_write_reg(dev, DP_CMD, DP_CMD_WRITE);
 512                 if (ret < 0) {
 513                         netdev_warn(dev->net, "Error writing DP_CMD\n");
 514                         goto done;
 515                 }
 516
 517                 ret = smsc75xx_dataport_wait_not_busy(dev);
 518                 if (ret < 0) {
 519                         netdev_warn(dev->net, "smsc75xx_dataport_write timeout\n");
 520                         goto done;
 521                 }
 522         }
 523
 524 done:
 525         mutex_unlock(&pdata->dataport_mutex);
 526         return ret;
 527 }
 528
 529 /* returns hash bit number for given MAC address */
 530 static u32 smsc75xx_hash(char addr[ETH_ALEN])
 531 {
 532         return (ether_crc(ETH_ALEN, addr) >> 23) & 0x1ff;
 533 }
 534
 535 static void smsc75xx_deferred_multicast_write(struct work_struct *param)
 536 {
 537         struct smsc75xx_priv *pdata =
 538                 container_of(param, struct smsc75xx_priv, set_multicast);
 539         struct usbnet *dev = pdata->dev;
 540         int ret;
 541
 542         netif_dbg(dev, drv, dev->net, "deferred multicast write 0x%08x\n",
 543                   pdata->rfe_ctl);
 544
 545         smsc75xx_dataport_write(dev, DP_SEL_VHF, DP_SEL_VHF_VLAN_LEN,
 546                 DP_SEL_VHF_HASH_LEN, pdata->multicast_hash_table);
 547
 548         ret = smsc75xx_write_reg(dev, RFE_CTL, pdata->rfe_ctl);
 549         if (ret < 0)
 550                 netdev_warn(dev->net, "Error writing RFE_CRL\n");
 551 }
 552
 553 static void smsc75xx_set_multicast(struct net_device *netdev)
 554 {
 555         struct usbnet *dev = netdev_priv(netdev);
 556         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
 557         unsigned long flags;
 558         int i;
 559
 560         spin_lock_irqsave(&pdata->rfe_ctl_lock, flags);
 561
 562         pdata->rfe_ctl &=
 563                 ~(RFE_CTL_AU | RFE_CTL_AM | RFE_CTL_DPF | RFE_CTL_MHF);
 564         pdata->rfe_ctl |= RFE_CTL_AB;
 565
 566         for (i = 0; i < DP_SEL_VHF_HASH_LEN; i++)
 567                 pdata->multicast_hash_table[i] = 0;
 568
 569         if (dev->net->flags & IFF_PROMISC) {
 570                 netif_dbg(dev, drv, dev->net, "promiscuous mode enabled\n");
 571                 pdata->rfe_ctl |= RFE_CTL_AM | RFE_CTL_AU;
 572         } else if (dev->net->flags & IFF_ALLMULTI) {
 573                 netif_dbg(dev, drv, dev->net, "receive all multicast enabled\n");
 574                 pdata->rfe_ctl |= RFE_CTL_AM | RFE_CTL_DPF;
 575         } else if (!netdev_mc_empty(dev->net)) {
 576                 struct netdev_hw_addr *ha;
 577
 578                 netif_dbg(dev, drv, dev->net, "receive multicast hash filter\n");
 579
 580                 pdata->rfe_ctl |= RFE_CTL_MHF | RFE_CTL_DPF;
 581
 582                 netdev_for_each_mc_addr(ha, netdev) {
 583                         u32 bitnum = smsc75xx_hash(ha->addr);
 584                         pdata->multicast_hash_table[bitnum / 32] |=
 585                                 (1 << (bitnum % 32));
 586                 }
 587         } else {
 588                 netif_dbg(dev, drv, dev->net, "receive own packets only\n");
 589                 pdata->rfe_ctl |= RFE_CTL_DPF;
 590         }
 591
 592         spin_unlock_irqrestore(&pdata->rfe_ctl_lock, flags);
 593
 594         /* defer register writes to a sleepable context */
 595         schedule_work(&pdata->set_multicast);
 596 }
 597
 598 static int smsc75xx_update_flowcontrol(struct usbnet *dev, u8 duplex,
 599                                             u16 lcladv, u16 rmtadv)
 600 {
 601         u32 flow = 0, fct_flow = 0;
 602         int ret;
 603
 604         if (duplex == DUPLEX_FULL) {
 605                 u8 cap = mii_resolve_flowctrl_fdx(lcladv, rmtadv);
 606
 607                 if (cap & FLOW_CTRL_TX) {
 608                         flow = (FLOW_TX_FCEN | 0xFFFF);
 609                         /* set fct_flow thresholds to 20% and 80% */
 610                         fct_flow = (8 << 8) | 32;
 611                 }
 612
 613                 if (cap & FLOW_CTRL_RX)
 614                         flow |= FLOW_RX_FCEN;
 615
 616                 netif_dbg(dev, link, dev->net, "rx pause %s, tx pause %s\n",
 617                           (cap & FLOW_CTRL_RX ? "enabled" : "disabled"),
 618                           (cap & FLOW_CTRL_TX ? "enabled" : "disabled"));
 619         } else {
 620                 netif_dbg(dev, link, dev->net, "half duplex\n");
 621         }
 622
 623         ret = smsc75xx_write_reg(dev, FLOW, flow);
 624         if (ret < 0) {
 625                 netdev_warn(dev->net, "Error writing FLOW\n");
 626                 return ret;
 627         }
 628
 629         ret = smsc75xx_write_reg(dev, FCT_FLOW, fct_flow);
 630         if (ret < 0) {
 631                 netdev_warn(dev->net, "Error writing FCT_FLOW\n");
 632                 return ret;
 633         }
 634
 635         return 0;
 636 }
 637
 638 static int smsc75xx_link_reset(struct usbnet *dev)
 639 {
 640         struct mii_if_info *mii = &dev->mii;
 641         struct ethtool_cmd ecmd = { .cmd = ETHTOOL_GSET };
 642         u16 lcladv, rmtadv;
 643         int ret;
 644
 645         /* write to clear phy interrupt status */
 646         smsc75xx_mdio_write(dev->net, mii->phy_id, PHY_INT_SRC,
 647                 PHY_INT_SRC_CLEAR_ALL);
 648
 649         ret = smsc75xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL);
 650         if (ret < 0) {
 651                 netdev_warn(dev->net, "Error writing INT_STS\n");
 652                 return ret;
 653         }
 654
 655         mii_check_media(mii, 1, 1);
 656         mii_ethtool_gset(&dev->mii, &ecmd);
 657         lcladv = smsc75xx_mdio_read(dev->net, mii->phy_id, MII_ADVERTISE);
 658         rmtadv = smsc75xx_mdio_read(dev->net, mii->phy_id, MII_LPA);
 659
 660         netif_dbg(dev, link, dev->net, "speed: %u duplex: %d lcladv: %04x rmtadv: %04x\n",
 661                   ethtool_cmd_speed(&ecmd), ecmd.duplex, lcladv, rmtadv);
 662
 663         return smsc75xx_update_flowcontrol(dev, ecmd.duplex, lcladv, rmtadv);
 664 }
 665
 666 static void smsc75xx_status(struct usbnet *dev, struct urb *urb)
 667 {
 668         u32 intdata;
 669
 670         if (urb->actual_length != 4) {
 671                 netdev_warn(dev->net, "unexpected urb length %d\n",
 672                             urb->actual_length);
 673                 return;
 674         }
 675
 676         memcpy(&intdata, urb->transfer_buffer, 4);
 677         le32_to_cpus(&intdata);
 678
 679         netif_dbg(dev, link, dev->net, "intdata: 0x%08X\n", intdata);
 680
 681         if (intdata & INT_ENP_PHY_INT)
 682                 usbnet_defer_kevent(dev, EVENT_LINK_RESET);
 683         else
 684                 netdev_warn(dev->net, "unexpected interrupt, intdata=0x%08X\n",
 685                             intdata);
 686 }
 687
 688 static int smsc75xx_ethtool_get_eeprom_len(struct net_device *net)
 689 {
 690         return MAX_EEPROM_SIZE;
 691 }
 692
 693 static int smsc75xx_ethtool_get_eeprom(struct net_device *netdev,
 694                                        struct ethtool_eeprom *ee, u8 *data)
 695 {
 696         struct usbnet *dev = netdev_priv(netdev);
 697
 698         ee->magic = LAN75XX_EEPROM_MAGIC;
 699
 700         return smsc75xx_read_eeprom(dev, ee->offset, ee->len, data);
 701 }
 702
 703 static int smsc75xx_ethtool_set_eeprom(struct net_device *netdev,
 704                                        struct ethtool_eeprom *ee, u8 *data)
 705 {
 706         struct usbnet *dev = netdev_priv(netdev);
 707
 708         if (ee->magic != LAN75XX_EEPROM_MAGIC) {
 709                 netdev_warn(dev->net, "EEPROM: magic value mismatch: 0x%x\n",
 710                             ee->magic);
 711                 return -EINVAL;
 712         }
 713
 714         return smsc75xx_write_eeprom(dev, ee->offset, ee->len, data);
 715 }
 716
 717 static void smsc75xx_ethtool_get_wol(struct net_device *net,
 718                                      struct ethtool_wolinfo *wolinfo)
 719 {
 720         struct usbnet *dev = netdev_priv(net);
 721         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
 722
 723         wolinfo->supported = SUPPORTED_WAKE;
 724         wolinfo->wolopts = pdata->wolopts;
 725 }
 726
 727 static int smsc75xx_ethtool_set_wol(struct net_device *net,
 728                                     struct ethtool_wolinfo *wolinfo)
 729 {
 730         struct usbnet *dev = netdev_priv(net);
 731         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
 732         int ret;
 733
 734         if (wolinfo->wolopts & ~SUPPORTED_WAKE)
 735                 return -EINVAL;
 736
 737         pdata->wolopts = wolinfo->wolopts & SUPPORTED_WAKE;
 738
 739         ret = device_set_wakeup_enable(&dev->udev->dev, pdata->wolopts);
 740         if (ret < 0)
 741                 netdev_warn(dev->net, "device_set_wakeup_enable error %d\n", ret);
 742
 743         return ret;
 744 }
 745
 746 static const struct ethtool_ops smsc75xx_ethtool_ops = {
 747         .get_link       = usbnet_get_link,
 748         .nway_reset     = usbnet_nway_reset,
 749         .get_drvinfo    = usbnet_get_drvinfo,
 750         .get_msglevel   = usbnet_get_msglevel,
 751         .set_msglevel   = usbnet_set_msglevel,
 752         .get_eeprom_len = smsc75xx_ethtool_get_eeprom_len,
 753         .get_eeprom     = smsc75xx_ethtool_get_eeprom,
 754         .set_eeprom     = smsc75xx_ethtool_set_eeprom,
 755         .get_wol        = smsc75xx_ethtool_get_wol,
 756         .set_wol        = smsc75xx_ethtool_set_wol,
 757         .get_link_ksettings     = usbnet_get_link_ksettings,
 758         .set_link_ksettings     = usbnet_set_link_ksettings,
 759 };
 760
 761 static int smsc75xx_ioctl(struct net_device *netdev, struct ifreq *rq, int cmd)
 762 {
 763         struct usbnet *dev = netdev_priv(netdev);
 764
 765         if (!netif_running(netdev))
 766                 return -EINVAL;
 767
 768         return generic_mii_ioctl(&dev->mii, if_mii(rq), cmd, NULL);
 769 }
 770
 771 static void smsc75xx_init_mac_address(struct usbnet *dev)
 772 {
 773         const u8 *mac_addr;
 774
 775         /* maybe the boot loader passed the MAC address in devicetree */
 776         mac_addr = of_get_mac_address(dev->udev->dev.of_node);
 777         if (mac_addr) {
 778                 memcpy(dev->net->dev_addr, mac_addr, ETH_ALEN);
 779                 return;
 780         }
 781
 782         /* try reading mac address from EEPROM */
 783         if (smsc75xx_read_eeprom(dev, EEPROM_MAC_OFFSET, ETH_ALEN,
 784                         dev->net->dev_addr) == 0) {
 785                 if (is_valid_ether_addr(dev->net->dev_addr)) {
 786                         /* eeprom values are valid so use them */
 787                         netif_dbg(dev, ifup, dev->net,
 788                                   "MAC address read from EEPROM\n");
 789                         return;
 790                 }
 791         }
 792
 793         /* no useful static MAC address found. generate a random one */
 794         eth_hw_addr_random(dev->net);
 795         netif_dbg(dev, ifup, dev->net, "MAC address set to eth_random_addr\n");
 796 }
 797
 798 static int smsc75xx_set_mac_address(struct usbnet *dev)
 799 {
 800         u32 addr_lo = dev->net->dev_addr[0] | dev->net->dev_addr[1] << 8 |
 801                 dev->net->dev_addr[2] << 16 | dev->net->dev_addr[3] << 24;
 802         u32 addr_hi = dev->net->dev_addr[4] | dev->net->dev_addr[5] << 8;
 803
 804         int ret = smsc75xx_write_reg(dev, RX_ADDRH, addr_hi);
 805         if (ret < 0) {
 806                 netdev_warn(dev->net, "Failed to write RX_ADDRH: %d\n", ret);
 807                 return ret;
 808         }
 809
 810         ret = smsc75xx_write_reg(dev, RX_ADDRL, addr_lo);
 811         if (ret < 0) {
 812                 netdev_warn(dev->net, "Failed to write RX_ADDRL: %d\n", ret);
 813                 return ret;
 814         }
 815
 816         addr_hi |= ADDR_FILTX_FB_VALID;
 817         ret = smsc75xx_write_reg(dev, ADDR_FILTX, addr_hi);
 818         if (ret < 0) {
 819                 netdev_warn(dev->net, "Failed to write ADDR_FILTX: %d\n", ret);
 820                 return ret;
 821         }
 822
 823         ret = smsc75xx_write_reg(dev, ADDR_FILTX + 4, addr_lo);
 824         if (ret < 0)
 825                 netdev_warn(dev->net, "Failed to write ADDR_FILTX+4: %d\n", ret);
 826
 827         return ret;
 828 }
 829
 830 static int smsc75xx_phy_initialize(struct usbnet *dev)
 831 {
 832         int bmcr, ret, timeout = 0;
 833
 834         /* Initialize MII structure */
 835         dev->mii.dev = dev->net;
 836         dev->mii.mdio_read = smsc75xx_mdio_read;
 837         dev->mii.mdio_write = smsc75xx_mdio_write;
 838         dev->mii.phy_id_mask = 0x1f;
 839         dev->mii.reg_num_mask = 0x1f;
 840         dev->mii.supports_gmii = 1;
 841         dev->mii.phy_id = SMSC75XX_INTERNAL_PHY_ID;
 842
 843         /* reset phy and wait for reset to complete */
 844         smsc75xx_mdio_write(dev->net, dev->mii.phy_id, MII_BMCR, BMCR_RESET);
 845
 846         do {
 847                 msleep(10);
 848                 bmcr = smsc75xx_mdio_read(dev->net, dev->mii.phy_id, MII_BMCR);
 849                 if (bmcr < 0) {
 850                         netdev_warn(dev->net, "Error reading MII_BMCR\n");
 851                         return bmcr;
 852                 }
 853                 timeout++;
 854         } while ((bmcr & BMCR_RESET) && (timeout < 100));
 855
 856         if (timeout >= 100) {
 857                 netdev_warn(dev->net, "timeout on PHY Reset\n");
 858                 return -EIO;
 859         }
 860
 861         /* phy workaround for gig link */
 862         smsc75xx_phy_gig_workaround(dev);
 863
 864         smsc75xx_mdio_write(dev->net, dev->mii.phy_id, MII_ADVERTISE,
 865                 ADVERTISE_ALL | ADVERTISE_CSMA | ADVERTISE_PAUSE_CAP |
 866                 ADVERTISE_PAUSE_ASYM);
 867         smsc75xx_mdio_write(dev->net, dev->mii.phy_id, MII_CTRL1000,
 868                 ADVERTISE_1000FULL);
 869
 870         /* read and write to clear phy interrupt status */
 871         ret = smsc75xx_mdio_read(dev->net, dev->mii.phy_id, PHY_INT_SRC);
 872         if (ret < 0) {
 873                 netdev_warn(dev->net, "Error reading PHY_INT_SRC\n");
 874                 return ret;
 875         }
 876
 877         smsc75xx_mdio_write(dev->net, dev->mii.phy_id, PHY_INT_SRC, 0xffff);
 878
 879         smsc75xx_mdio_write(dev->net, dev->mii.phy_id, PHY_INT_MASK,
 880                 PHY_INT_MASK_DEFAULT);
 881         mii_nway_restart(&dev->mii);
 882
 883         netif_dbg(dev, ifup, dev->net, "phy initialised successfully\n");
 884         return 0;
 885 }
 886
 887 static int smsc75xx_set_rx_max_frame_length(struct usbnet *dev, int size)
 888 {
 889         int ret = 0;
 890         u32 buf;
 891         bool rxenabled;
 892
 893         ret = smsc75xx_read_reg(dev, MAC_RX, &buf);
 894         if (ret < 0) {
 895                 netdev_warn(dev->net, "Failed to read MAC_RX: %d\n", ret);
 896                 return ret;
 897         }
 898
 899         rxenabled = ((buf & MAC_RX_RXEN) != 0);
 900
 901         if (rxenabled) {
 902                 buf &= ~MAC_RX_RXEN;
 903                 ret = smsc75xx_write_reg(dev, MAC_RX, buf);
 904                 if (ret < 0) {
 905                         netdev_warn(dev->net, "Failed to write MAC_RX: %d\n", ret);
 906                         return ret;
 907                 }
 908         }
 909
 910         /* add 4 to size for FCS */
 911         buf &= ~MAC_RX_MAX_SIZE;
 912         buf |= (((size + 4) << MAC_RX_MAX_SIZE_SHIFT) & MAC_RX_MAX_SIZE);
 913
 914         ret = smsc75xx_write_reg(dev, MAC_RX, buf);
 915         if (ret < 0) {
 916                 netdev_warn(dev->net, "Failed to write MAC_RX: %d\n", ret);
 917                 return ret;
 918         }
 919
 920         if (rxenabled) {
 921                 buf |= MAC_RX_RXEN;
 922                 ret = smsc75xx_write_reg(dev, MAC_RX, buf);
 923                 if (ret < 0) {
 924                         netdev_warn(dev->net, "Failed to write MAC_RX: %d\n", ret);
 925                         return ret;
 926                 }
 927         }
 928
 929         return 0;
 930 }
 931
 932 static int smsc75xx_change_mtu(struct net_device *netdev, int new_mtu)
 933 {
 934         struct usbnet *dev = netdev_priv(netdev);
 935         int ret;
 936
 937         ret = smsc75xx_set_rx_max_frame_length(dev, new_mtu + ETH_HLEN);
 938         if (ret < 0) {
 939                 netdev_warn(dev->net, "Failed to set mac rx frame length\n");
 940                 return ret;
 941         }
 942
 943         return usbnet_change_mtu(netdev, new_mtu);
 944 }
 945
 946 /* Enable or disable Rx checksum offload engine */
 947 static int smsc75xx_set_features(struct net_device *netdev,
 948         netdev_features_t features)
 949 {
 950         struct usbnet *dev = netdev_priv(netdev);
 951         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
 952         unsigned long flags;
 953         int ret;
 954
 955         spin_lock_irqsave(&pdata->rfe_ctl_lock, flags);
 956
 957         if (features & NETIF_F_RXCSUM)
 958                 pdata->rfe_ctl |= RFE_CTL_TCPUDP_CKM | RFE_CTL_IP_CKM;
 959         else
 960                 pdata->rfe_ctl &= ~(RFE_CTL_TCPUDP_CKM | RFE_CTL_IP_CKM);
 961
 962         spin_unlock_irqrestore(&pdata->rfe_ctl_lock, flags);
 963         /* it's racing here! */
 964
 965         ret = smsc75xx_write_reg(dev, RFE_CTL, pdata->rfe_ctl);
 966         if (ret < 0) {
 967                 netdev_warn(dev->net, "Error writing RFE_CTL\n");
 968                 return ret;
 969         }
 970         return 0;
 971 }
 972
 973 static int smsc75xx_wait_ready(struct usbnet *dev, int in_pm)
 974 {
 975         int timeout = 0;
 976
 977         do {
 978                 u32 buf;
 979                 int ret;
 980
 981                 ret = __smsc75xx_read_reg(dev, PMT_CTL, &buf, in_pm);
 982
 983                 if (ret < 0) {
 984                         netdev_warn(dev->net, "Failed to read PMT_CTL: %d\n", ret);
 985                         return ret;
 986                 }
 987
 988                 if (buf & PMT_CTL_DEV_RDY)
 989                         return 0;
 990
 991                 msleep(10);
 992                 timeout++;
 993         } while (timeout < 100);
 994
 995         netdev_warn(dev->net, "timeout waiting for device ready\n");
 996         return -EIO;
 997 }
 998
 999 static int smsc75xx_phy_gig_workaround(struct usbnet *dev)
1000 {
1001         struct mii_if_info *mii = &dev->mii;
1002         int ret = 0, timeout = 0;
1003         u32 buf, link_up = 0;
1004
1005         /* Set the phy in Gig loopback */
1006         smsc75xx_mdio_write(dev->net, mii->phy_id, MII_BMCR, 0x4040);
1007
1008         /* Wait for the link up */
1009         do {
1010                 link_up = smsc75xx_link_ok_nopm(dev);
1011                 usleep_range(10000, 20000);
1012                 timeout++;
1013         } while ((!link_up) && (timeout < 1000));
1014
1015         if (timeout >= 1000) {
1016                 netdev_warn(dev->net, "Timeout waiting for PHY link up\n");
1017                 return -EIO;
1018         }
1019
1020         /* phy reset */
1021         ret = smsc75xx_read_reg(dev, PMT_CTL, &buf);
1022         if (ret < 0) {
1023                 netdev_warn(dev->net, "Failed to read PMT_CTL: %d\n", ret);
1024                 return ret;
1025         }
1026
1027         buf |= PMT_CTL_PHY_RST;
1028
1029         ret = smsc75xx_write_reg(dev, PMT_CTL, buf);
1030         if (ret < 0) {
1031                 netdev_warn(dev->net, "Failed to write PMT_CTL: %d\n", ret);
1032                 return ret;
1033         }
1034
1035         timeout = 0;
1036         do {
1037                 usleep_range(10000, 20000);
1038                 ret = smsc75xx_read_reg(dev, PMT_CTL, &buf);
1039                 if (ret < 0) {
1040                         netdev_warn(dev->net, "Failed to read PMT_CTL: %d\n",
1041                                     ret);
1042                         return ret;
1043                 }
1044                 timeout++;
1045         } while ((buf & PMT_CTL_PHY_RST) && (timeout < 100));
1046
1047         if (timeout >= 100) {
1048                 netdev_warn(dev->net, "timeout waiting for PHY Reset\n");
1049                 return -EIO;
1050         }
1051
1052         return 0;
1053 }
1054
1055 static int smsc75xx_reset(struct usbnet *dev)
1056 {
1057         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1058         u32 buf;
1059         int ret = 0, timeout;
1060
1061         netif_dbg(dev, ifup, dev->net, "entering smsc75xx_reset\n");
1062
1063         ret = smsc75xx_wait_ready(dev, 0);
1064         if (ret < 0) {
1065                 netdev_warn(dev->net, "device not ready in smsc75xx_reset\n");
1066                 return ret;
1067         }
1068
1069         ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1070         if (ret < 0) {
1071                 netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1072                 return ret;
1073         }
1074
1075         buf |= HW_CFG_LRST;
1076
1077         ret = smsc75xx_write_reg(dev, HW_CFG, buf);
1078         if (ret < 0) {
1079                 netdev_warn(dev->net, "Failed to write HW_CFG: %d\n", ret);
1080                 return ret;
1081         }
1082
1083         timeout = 0;
1084         do {
1085                 msleep(10);
1086                 ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1087                 if (ret < 0) {
1088                         netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1089                         return ret;
1090                 }
1091                 timeout++;
1092         } while ((buf & HW_CFG_LRST) && (timeout < 100));
1093
1094         if (timeout >= 100) {
1095                 netdev_warn(dev->net, "timeout on completion of Lite Reset\n");
1096                 return -EIO;
1097         }
1098
1099         netif_dbg(dev, ifup, dev->net, "Lite reset complete, resetting PHY\n");
1100
1101         ret = smsc75xx_read_reg(dev, PMT_CTL, &buf);
1102         if (ret < 0) {
1103                 netdev_warn(dev->net, "Failed to read PMT_CTL: %d\n", ret);
1104                 return ret;
1105         }
1106
1107         buf |= PMT_CTL_PHY_RST;
1108
1109         ret = smsc75xx_write_reg(dev, PMT_CTL, buf);
1110         if (ret < 0) {
1111                 netdev_warn(dev->net, "Failed to write PMT_CTL: %d\n", ret);
1112                 return ret;
1113         }
1114
1115         timeout = 0;
1116         do {
1117                 msleep(10);
1118                 ret = smsc75xx_read_reg(dev, PMT_CTL, &buf);
1119                 if (ret < 0) {
1120                         netdev_warn(dev->net, "Failed to read PMT_CTL: %d\n", ret);
1121                         return ret;
1122                 }
1123                 timeout++;
1124         } while ((buf & PMT_CTL_PHY_RST) && (timeout < 100));
1125
1126         if (timeout >= 100) {
1127                 netdev_warn(dev->net, "timeout waiting for PHY Reset\n");
1128                 return -EIO;
1129         }
1130
1131         netif_dbg(dev, ifup, dev->net, "PHY reset complete\n");
1132
1133         ret = smsc75xx_set_mac_address(dev);
1134         if (ret < 0) {
1135                 netdev_warn(dev->net, "Failed to set mac address\n");
1136                 return ret;
1137         }
1138
1139         netif_dbg(dev, ifup, dev->net, "MAC Address: %pM\n",
1140                   dev->net->dev_addr);
1141
1142         ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1143         if (ret < 0) {
1144                 netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1145                 return ret;
1146         }
1147
1148         netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG : 0x%08x\n",
1149                   buf);
1150
1151         buf |= HW_CFG_BIR;
1152
1153         ret = smsc75xx_write_reg(dev, HW_CFG, buf);
1154         if (ret < 0) {
1155                 netdev_warn(dev->net,  "Failed to write HW_CFG: %d\n", ret);
1156                 return ret;
1157         }
1158
1159         ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1160         if (ret < 0) {
1161                 netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1162                 return ret;
1163         }
1164
1165         netif_dbg(dev, ifup, dev->net, "Read Value from HW_CFG after writing HW_CFG_BIR: 0x%08x\n",
1166                   buf);
1167
1168         if (!turbo_mode) {
1169                 buf = 0;
1170                 dev->rx_urb_size = MAX_SINGLE_PACKET_SIZE;
1171         } else if (dev->udev->speed == USB_SPEED_HIGH) {
1172                 buf = DEFAULT_HS_BURST_CAP_SIZE / HS_USB_PKT_SIZE;
1173                 dev->rx_urb_size = DEFAULT_HS_BURST_CAP_SIZE;
1174         } else {
1175                 buf = DEFAULT_FS_BURST_CAP_SIZE / FS_USB_PKT_SIZE;
1176                 dev->rx_urb_size = DEFAULT_FS_BURST_CAP_SIZE;
1177         }
1178
1179         netif_dbg(dev, ifup, dev->net, "rx_urb_size=%ld\n",
1180                   (ulong)dev->rx_urb_size);
1181
1182         ret = smsc75xx_write_reg(dev, BURST_CAP, buf);
1183         if (ret < 0) {
1184                 netdev_warn(dev->net, "Failed to write BURST_CAP: %d\n", ret);
1185                 return ret;
1186         }
1187
1188         ret = smsc75xx_read_reg(dev, BURST_CAP, &buf);
1189         if (ret < 0) {
1190                 netdev_warn(dev->net, "Failed to read BURST_CAP: %d\n", ret);
1191                 return ret;
1192         }
1193
1194         netif_dbg(dev, ifup, dev->net,
1195                   "Read Value from BURST_CAP after writing: 0x%08x\n", buf);
1196
1197         ret = smsc75xx_write_reg(dev, BULK_IN_DLY, DEFAULT_BULK_IN_DELAY);
1198         if (ret < 0) {
1199                 netdev_warn(dev->net, "Failed to write BULK_IN_DLY: %d\n", ret);
1200                 return ret;
1201         }
1202
1203         ret = smsc75xx_read_reg(dev, BULK_IN_DLY, &buf);
1204         if (ret < 0) {
1205                 netdev_warn(dev->net, "Failed to read BULK_IN_DLY: %d\n", ret);
1206                 return ret;
1207         }
1208
1209         netif_dbg(dev, ifup, dev->net,
1210                   "Read Value from BULK_IN_DLY after writing: 0x%08x\n", buf);
1211
1212         if (turbo_mode) {
1213                 ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1214                 if (ret < 0) {
1215                         netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1216                         return ret;
1217                 }
1218
1219                 netif_dbg(dev, ifup, dev->net, "HW_CFG: 0x%08x\n", buf);
1220
1221                 buf |= (HW_CFG_MEF | HW_CFG_BCE);
1222
1223                 ret = smsc75xx_write_reg(dev, HW_CFG, buf);
1224                 if (ret < 0) {
1225                         netdev_warn(dev->net, "Failed to write HW_CFG: %d\n", ret);
1226                         return ret;
1227                 }
1228
1229                 ret = smsc75xx_read_reg(dev, HW_CFG, &buf);
1230                 if (ret < 0) {
1231                         netdev_warn(dev->net, "Failed to read HW_CFG: %d\n", ret);
1232                         return ret;
1233                 }
1234
1235                 netif_dbg(dev, ifup, dev->net, "HW_CFG: 0x%08x\n", buf);
1236         }
1237
1238         /* set FIFO sizes */
1239         buf = (MAX_RX_FIFO_SIZE - 512) / 512;
1240         ret = smsc75xx_write_reg(dev, FCT_RX_FIFO_END, buf);
1241         if (ret < 0) {
1242                 netdev_warn(dev->net, "Failed to write FCT_RX_FIFO_END: %d\n", ret);
1243                 return ret;
1244         }
1245
1246         netif_dbg(dev, ifup, dev->net, "FCT_RX_FIFO_END set to 0x%08x\n", buf);
1247
1248         buf = (MAX_TX_FIFO_SIZE - 512) / 512;
1249         ret = smsc75xx_write_reg(dev, FCT_TX_FIFO_END, buf);
1250         if (ret < 0) {
1251                 netdev_warn(dev->net, "Failed to write FCT_TX_FIFO_END: %d\n", ret);
1252                 return ret;
1253         }
1254
1255         netif_dbg(dev, ifup, dev->net, "FCT_TX_FIFO_END set to 0x%08x\n", buf);
1256
1257         ret = smsc75xx_write_reg(dev, INT_STS, INT_STS_CLEAR_ALL);
1258         if (ret < 0) {
1259                 netdev_warn(dev->net, "Failed to write INT_STS: %d\n", ret);
1260                 return ret;
1261         }
1262
1263         ret = smsc75xx_read_reg(dev, ID_REV, &buf);
1264         if (ret < 0) {
1265                 netdev_warn(dev->net, "Failed to read ID_REV: %d\n", ret);
1266                 return ret;
1267         }
1268
1269         netif_dbg(dev, ifup, dev->net, "ID_REV = 0x%08x\n", buf);
1270
1271         ret = smsc75xx_read_reg(dev, E2P_CMD, &buf);
1272         if (ret < 0) {
1273                 netdev_warn(dev->net, "Failed to read E2P_CMD: %d\n", ret);
1274                 return ret;
1275         }
1276
1277         /* only set default GPIO/LED settings if no EEPROM is detected */
1278         if (!(buf & E2P_CMD_LOADED)) {
1279                 ret = smsc75xx_read_reg(dev, LED_GPIO_CFG, &buf);
1280                 if (ret < 0) {
1281                         netdev_warn(dev->net, "Failed to read LED_GPIO_CFG: %d\n", ret);
1282                         return ret;
1283                 }
1284
1285                 buf &= ~(LED_GPIO_CFG_LED2_FUN_SEL | LED_GPIO_CFG_LED10_FUN_SEL);
1286                 buf |= LED_GPIO_CFG_LEDGPIO_EN | LED_GPIO_CFG_LED2_FUN_SEL;
1287
1288                 ret = smsc75xx_write_reg(dev, LED_GPIO_CFG, buf);
1289                 if (ret < 0) {
1290                         netdev_warn(dev->net, "Failed to write LED_GPIO_CFG: %d\n", ret);
1291                         return ret;
1292                 }
1293         }
1294
1295         ret = smsc75xx_write_reg(dev, FLOW, 0);
1296         if (ret < 0) {
1297                 netdev_warn(dev->net, "Failed to write FLOW: %d\n", ret);
1298                 return ret;
1299         }
1300
1301         ret = smsc75xx_write_reg(dev, FCT_FLOW, 0);
1302         if (ret < 0) {
1303                 netdev_warn(dev->net, "Failed to write FCT_FLOW: %d\n", ret);
1304                 return ret;
1305         }
1306
1307         /* Don't need rfe_ctl_lock during initialisation */
1308         ret = smsc75xx_read_reg(dev, RFE_CTL, &pdata->rfe_ctl);
1309         if (ret < 0) {
1310                 netdev_warn(dev->net, "Failed to read RFE_CTL: %d\n", ret);
1311                 return ret;
1312         }
1313
1314         pdata->rfe_ctl |= RFE_CTL_AB | RFE_CTL_DPF;
1315
1316         ret = smsc75xx_write_reg(dev, RFE_CTL, pdata->rfe_ctl);
1317         if (ret < 0) {
1318                 netdev_warn(dev->net, "Failed to write RFE_CTL: %d\n", ret);
1319                 return ret;
1320         }
1321
1322         ret = smsc75xx_read_reg(dev, RFE_CTL, &pdata->rfe_ctl);
1323         if (ret < 0) {
1324                 netdev_warn(dev->net, "Failed to read RFE_CTL: %d\n", ret);
1325                 return ret;
1326         }
1327
1328         netif_dbg(dev, ifup, dev->net, "RFE_CTL set to 0x%08x\n",
1329                   pdata->rfe_ctl);
1330
1331         /* Enable or disable checksum offload engines */
1332         smsc75xx_set_features(dev->net, dev->net->features);
1333
1334         smsc75xx_set_multicast(dev->net);
1335
1336         ret = smsc75xx_phy_initialize(dev);
1337         if (ret < 0) {
1338                 netdev_warn(dev->net, "Failed to initialize PHY: %d\n", ret);
1339                 return ret;
1340         }
1341
1342         ret = smsc75xx_read_reg(dev, INT_EP_CTL, &buf);
1343         if (ret < 0) {
1344                 netdev_warn(dev->net, "Failed to read INT_EP_CTL: %d\n", ret);
1345                 return ret;
1346         }
1347
1348         /* enable PHY interrupts */
1349         buf |= INT_ENP_PHY_INT;
1350
1351         ret = smsc75xx_write_reg(dev, INT_EP_CTL, buf);
1352         if (ret < 0) {
1353                 netdev_warn(dev->net, "Failed to write INT_EP_CTL: %d\n", ret);
1354                 return ret;
1355         }
1356
1357         /* allow mac to detect speed and duplex from phy */
1358         ret = smsc75xx_read_reg(dev, MAC_CR, &buf);
1359         if (ret < 0) {
1360                 netdev_warn(dev->net, "Failed to read MAC_CR: %d\n", ret);
1361                 return ret;
1362         }
1363
1364         buf |= (MAC_CR_ADD | MAC_CR_ASD);
1365         ret = smsc75xx_write_reg(dev, MAC_CR, buf);
1366         if (ret < 0) {
1367                 netdev_warn(dev->net, "Failed to write MAC_CR: %d\n", ret);
1368                 return ret;
1369         }
1370
1371         ret = smsc75xx_read_reg(dev, MAC_TX, &buf);
1372         if (ret < 0) {
1373                 netdev_warn(dev->net, "Failed to read MAC_TX: %d\n", ret);
1374                 return ret;
1375         }
1376
1377         buf |= MAC_TX_TXEN;
1378
1379         ret = smsc75xx_write_reg(dev, MAC_TX, buf);
1380         if (ret < 0) {
1381                 netdev_warn(dev->net, "Failed to write MAC_TX: %d\n", ret);
1382                 return ret;
1383         }
1384
1385         netif_dbg(dev, ifup, dev->net, "MAC_TX set to 0x%08x\n", buf);
1386
1387         ret = smsc75xx_read_reg(dev, FCT_TX_CTL, &buf);
1388         if (ret < 0) {
1389                 netdev_warn(dev->net, "Failed to read FCT_TX_CTL: %d\n", ret);
1390                 return ret;
1391         }
1392
1393         buf |= FCT_TX_CTL_EN;
1394
1395         ret = smsc75xx_write_reg(dev, FCT_TX_CTL, buf);
1396         if (ret < 0) {
1397                 netdev_warn(dev->net, "Failed to write FCT_TX_CTL: %d\n", ret);
1398                 return ret;
1399         }
1400
1401         netif_dbg(dev, ifup, dev->net, "FCT_TX_CTL set to 0x%08x\n", buf);
1402
1403         ret = smsc75xx_set_rx_max_frame_length(dev, dev->net->mtu + ETH_HLEN);
1404         if (ret < 0) {
1405                 netdev_warn(dev->net, "Failed to set max rx frame length\n");
1406                 return ret;
1407         }
1408
1409         ret = smsc75xx_read_reg(dev, MAC_RX, &buf);
1410         if (ret < 0) {
1411                 netdev_warn(dev->net, "Failed to read MAC_RX: %d\n", ret);
1412                 return ret;
1413         }
1414
1415         buf |= MAC_RX_RXEN;
1416
1417         ret = smsc75xx_write_reg(dev, MAC_RX, buf);
1418         if (ret < 0) {
1419                 netdev_warn(dev->net, "Failed to write MAC_RX: %d\n", ret);
1420                 return ret;
1421         }
1422
1423         netif_dbg(dev, ifup, dev->net, "MAC_RX set to 0x%08x\n", buf);
1424
1425         ret = smsc75xx_read_reg(dev, FCT_RX_CTL, &buf);
1426         if (ret < 0) {
1427                 netdev_warn(dev->net, "Failed to read FCT_RX_CTL: %d\n", ret);
1428                 return ret;
1429         }
1430
1431         buf |= FCT_RX_CTL_EN;
1432
1433         ret = smsc75xx_write_reg(dev, FCT_RX_CTL, buf);
1434         if (ret < 0) {
1435                 netdev_warn(dev->net, "Failed to write FCT_RX_CTL: %d\n", ret);
1436                 return ret;
1437         }
1438
1439         netif_dbg(dev, ifup, dev->net, "FCT_RX_CTL set to 0x%08x\n", buf);
1440
1441         netif_dbg(dev, ifup, dev->net, "smsc75xx_reset, return 0\n");
1442         return 0;
1443 }
1444
1445 static const struct net_device_ops smsc75xx_netdev_ops = {
1446         .ndo_open               = usbnet_open,
1447         .ndo_stop               = usbnet_stop,
1448         .ndo_start_xmit         = usbnet_start_xmit,
1449         .ndo_tx_timeout         = usbnet_tx_timeout,
1450         .ndo_get_stats64        = usbnet_get_stats64,
1451         .ndo_change_mtu         = smsc75xx_change_mtu,
1452         .ndo_set_mac_address    = eth_mac_addr,
1453         .ndo_validate_addr      = eth_validate_addr,
1454         .ndo_do_ioctl           = smsc75xx_ioctl,
1455         .ndo_set_rx_mode        = smsc75xx_set_multicast,
1456         .ndo_set_features       = smsc75xx_set_features,
1457 };
1458
1459 static int smsc75xx_bind(struct usbnet *dev, struct usb_interface *intf)
1460 {
1461         struct smsc75xx_priv *pdata = NULL;
1462         int ret;
1463
1464         printk(KERN_INFO SMSC_CHIPNAME " v" SMSC_DRIVER_VERSION "\n");
1465
1466         ret = usbnet_get_endpoints(dev, intf);
1467         if (ret < 0) {
1468                 netdev_warn(dev->net, "usbnet_get_endpoints failed: %d\n", ret);
1469                 return ret;
1470         }
1471
1472         dev->data[0] = (unsigned long)kzalloc(sizeof(struct smsc75xx_priv),
1473                                               GFP_KERNEL);
1474
1475         pdata = (struct smsc75xx_priv *)(dev->data[0]);
1476         if (!pdata)
1477                 return -ENOMEM;
1478
1479         pdata->dev = dev;
1480
1481         spin_lock_init(&pdata->rfe_ctl_lock);
1482         mutex_init(&pdata->dataport_mutex);
1483
1484         INIT_WORK(&pdata->set_multicast, smsc75xx_deferred_multicast_write);
1485
1486         if (DEFAULT_TX_CSUM_ENABLE)
1487                 dev->net->features |= NETIF_F_IP_CSUM | NETIF_F_IPV6_CSUM;
1488
1489         if (DEFAULT_RX_CSUM_ENABLE)
1490                 dev->net->features |= NETIF_F_RXCSUM;
1491
1492         dev->net->hw_features = NETIF_F_IP_CSUM | NETIF_F_IPV6_CSUM |
1493                                 NETIF_F_RXCSUM;
1494
1495         ret = smsc75xx_wait_ready(dev, 0);
1496         if (ret < 0) {
1497                 netdev_warn(dev->net, "device not ready in smsc75xx_bind\n");
1498                 goto free_pdata;
1499         }
1500
1501         smsc75xx_init_mac_address(dev);
1502
1503         /* Init all registers */
1504         ret = smsc75xx_reset(dev);
1505         if (ret < 0) {
1506                 netdev_warn(dev->net, "smsc75xx_reset error %d\n", ret);
1507                 goto cancel_work;
1508         }
1509
1510         dev->net->netdev_ops = &smsc75xx_netdev_ops;
1511         dev->net->ethtool_ops = &smsc75xx_ethtool_ops;
1512         dev->net->flags |= IFF_MULTICAST;
1513         dev->net->hard_header_len += SMSC75XX_TX_OVERHEAD;
1514         dev->hard_mtu = dev->net->mtu + dev->net->hard_header_len;
1515         dev->net->max_mtu = MAX_SINGLE_PACKET_SIZE;
1516         return 0;
1517
1518 cancel_work:
1519         cancel_work_sync(&pdata->set_multicast);
1520 free_pdata:
1521         kfree(pdata);
1522         dev->data[0] = 0;
1523         return ret;
1524 }
1525
1526 static void smsc75xx_unbind(struct usbnet *dev, struct usb_interface *intf)
1527 {
1528         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1529         if (pdata) {
1530                 cancel_work_sync(&pdata->set_multicast);
1531                 netif_dbg(dev, ifdown, dev->net, "free pdata\n");
1532                 kfree(pdata);
1533                 dev->data[0] = 0;
1534         }
1535 }
1536
1537 static u16 smsc_crc(const u8 *buffer, size_t len)
1538 {
1539         return bitrev16(crc16(0xFFFF, buffer, len));
1540 }
1541
1542 static int smsc75xx_write_wuff(struct usbnet *dev, int filter, u32 wuf_cfg,
1543                                u32 wuf_mask1)
1544 {
1545         int cfg_base = WUF_CFGX + filter * 4;
1546         int mask_base = WUF_MASKX + filter * 16;
1547         int ret;
1548
1549         ret = smsc75xx_write_reg(dev, cfg_base, wuf_cfg);
1550         if (ret < 0) {
1551                 netdev_warn(dev->net, "Error writing WUF_CFGX\n");
1552                 return ret;
1553         }
1554
1555         ret = smsc75xx_write_reg(dev, mask_base, wuf_mask1);
1556         if (ret < 0) {
1557                 netdev_warn(dev->net, "Error writing WUF_MASKX\n");
1558                 return ret;
1559         }
1560
1561         ret = smsc75xx_write_reg(dev, mask_base + 4, 0);
1562         if (ret < 0) {
1563                 netdev_warn(dev->net, "Error writing WUF_MASKX\n");
1564                 return ret;
1565         }
1566
1567         ret = smsc75xx_write_reg(dev, mask_base + 8, 0);
1568         if (ret < 0) {
1569                 netdev_warn(dev->net, "Error writing WUF_MASKX\n");
1570                 return ret;
1571         }
1572
1573         ret = smsc75xx_write_reg(dev, mask_base + 12, 0);
1574         if (ret < 0) {
1575                 netdev_warn(dev->net, "Error writing WUF_MASKX\n");
1576                 return ret;
1577         }
1578
1579         return 0;
1580 }
1581
1582 static int smsc75xx_enter_suspend0(struct usbnet *dev)
1583 {
1584         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1585         u32 val;
1586         int ret;
1587
1588         ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
1589         if (ret < 0) {
1590                 netdev_warn(dev->net, "Error reading PMT_CTL\n");
1591                 return ret;
1592         }
1593
1594         val &= (~(PMT_CTL_SUS_MODE | PMT_CTL_PHY_RST));
1595         val |= PMT_CTL_SUS_MODE_0 | PMT_CTL_WOL_EN | PMT_CTL_WUPS;
1596
1597         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1598         if (ret < 0) {
1599                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1600                 return ret;
1601         }
1602
1603         pdata->suspend_flags |= SUSPEND_SUSPEND0;
1604
1605         return 0;
1606 }
1607
1608 static int smsc75xx_enter_suspend1(struct usbnet *dev)
1609 {
1610         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1611         u32 val;
1612         int ret;
1613
1614         ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
1615         if (ret < 0) {
1616                 netdev_warn(dev->net, "Error reading PMT_CTL\n");
1617                 return ret;
1618         }
1619
1620         val &= ~(PMT_CTL_SUS_MODE | PMT_CTL_WUPS | PMT_CTL_PHY_RST);
1621         val |= PMT_CTL_SUS_MODE_1;
1622
1623         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1624         if (ret < 0) {
1625                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1626                 return ret;
1627         }
1628
1629         /* clear wol status, enable energy detection */
1630         val &= ~PMT_CTL_WUPS;
1631         val |= (PMT_CTL_WUPS_ED | PMT_CTL_ED_EN);
1632
1633         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1634         if (ret < 0) {
1635                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1636                 return ret;
1637         }
1638
1639         pdata->suspend_flags |= SUSPEND_SUSPEND1;
1640
1641         return 0;
1642 }
1643
1644 static int smsc75xx_enter_suspend2(struct usbnet *dev)
1645 {
1646         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1647         u32 val;
1648         int ret;
1649
1650         ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
1651         if (ret < 0) {
1652                 netdev_warn(dev->net, "Error reading PMT_CTL\n");
1653                 return ret;
1654         }
1655
1656         val &= ~(PMT_CTL_SUS_MODE | PMT_CTL_WUPS | PMT_CTL_PHY_RST);
1657         val |= PMT_CTL_SUS_MODE_2;
1658
1659         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1660         if (ret < 0) {
1661                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1662                 return ret;
1663         }
1664
1665         pdata->suspend_flags |= SUSPEND_SUSPEND2;
1666
1667         return 0;
1668 }
1669
1670 static int smsc75xx_enter_suspend3(struct usbnet *dev)
1671 {
1672         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1673         u32 val;
1674         int ret;
1675
1676         ret = smsc75xx_read_reg_nopm(dev, FCT_RX_CTL, &val);
1677         if (ret < 0) {
1678                 netdev_warn(dev->net, "Error reading FCT_RX_CTL\n");
1679                 return ret;
1680         }
1681
1682         if (val & FCT_RX_CTL_RXUSED) {
1683                 netdev_dbg(dev->net, "rx fifo not empty in autosuspend\n");
1684                 return -EBUSY;
1685         }
1686
1687         ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
1688         if (ret < 0) {
1689                 netdev_warn(dev->net, "Error reading PMT_CTL\n");
1690                 return ret;
1691         }
1692
1693         val &= ~(PMT_CTL_SUS_MODE | PMT_CTL_WUPS | PMT_CTL_PHY_RST);
1694         val |= PMT_CTL_SUS_MODE_3 | PMT_CTL_RES_CLR_WKP_EN;
1695
1696         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1697         if (ret < 0) {
1698                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1699                 return ret;
1700         }
1701
1702         /* clear wol status */
1703         val &= ~PMT_CTL_WUPS;
1704         val |= PMT_CTL_WUPS_WOL;
1705
1706         ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1707         if (ret < 0) {
1708                 netdev_warn(dev->net, "Error writing PMT_CTL\n");
1709                 return ret;
1710         }
1711
1712         pdata->suspend_flags |= SUSPEND_SUSPEND3;
1713
1714         return 0;
1715 }
1716
1717 static int smsc75xx_enable_phy_wakeup_interrupts(struct usbnet *dev, u16 mask)
1718 {
1719         struct mii_if_info *mii = &dev->mii;
1720         int ret;
1721
1722         netdev_dbg(dev->net, "enabling PHY wakeup interrupts\n");
1723
1724         /* read to clear */
1725         ret = smsc75xx_mdio_read_nopm(dev->net, mii->phy_id, PHY_INT_SRC);
1726         if (ret < 0) {
1727                 netdev_warn(dev->net, "Error reading PHY_INT_SRC\n");
1728                 return ret;
1729         }
1730
1731         /* enable interrupt source */
1732         ret = smsc75xx_mdio_read_nopm(dev->net, mii->phy_id, PHY_INT_MASK);
1733         if (ret < 0) {
1734                 netdev_warn(dev->net, "Error reading PHY_INT_MASK\n");
1735                 return ret;
1736         }
1737
1738         ret |= mask;
1739
1740         smsc75xx_mdio_write_nopm(dev->net, mii->phy_id, PHY_INT_MASK, ret);
1741
1742         return 0;
1743 }
1744
1745 static int smsc75xx_link_ok_nopm(struct usbnet *dev)
1746 {
1747         struct mii_if_info *mii = &dev->mii;
1748         int ret;
1749
1750         /* first, a dummy read, needed to latch some MII phys */
1751         ret = smsc75xx_mdio_read_nopm(dev->net, mii->phy_id, MII_BMSR);
1752         if (ret < 0) {
1753                 netdev_warn(dev->net, "Error reading MII_BMSR\n");
1754                 return ret;
1755         }
1756
1757         ret = smsc75xx_mdio_read_nopm(dev->net, mii->phy_id, MII_BMSR);
1758         if (ret < 0) {
1759                 netdev_warn(dev->net, "Error reading MII_BMSR\n");
1760                 return ret;
1761         }
1762
1763         return !!(ret & BMSR_LSTATUS);
1764 }
1765
1766 static int smsc75xx_autosuspend(struct usbnet *dev, u32 link_up)
1767 {
1768         int ret;
1769
1770         if (!netif_running(dev->net)) {
1771                 /* interface is ifconfig down so fully power down hw */
1772                 netdev_dbg(dev->net, "autosuspend entering SUSPEND2\n");
1773                 return smsc75xx_enter_suspend2(dev);
1774         }
1775
1776         if (!link_up) {
1777                 /* link is down so enter EDPD mode */
1778                 netdev_dbg(dev->net, "autosuspend entering SUSPEND1\n");
1779
1780                 /* enable PHY wakeup events for if cable is attached */
1781                 ret = smsc75xx_enable_phy_wakeup_interrupts(dev,
1782                         PHY_INT_MASK_ANEG_COMP);
1783                 if (ret < 0) {
1784                         netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1785                         return ret;
1786                 }
1787
1788                 netdev_info(dev->net, "entering SUSPEND1 mode\n");
1789                 return smsc75xx_enter_suspend1(dev);
1790         }
1791
1792         /* enable PHY wakeup events so we remote wakeup if cable is pulled */
1793         ret = smsc75xx_enable_phy_wakeup_interrupts(dev,
1794                 PHY_INT_MASK_LINK_DOWN);
1795         if (ret < 0) {
1796                 netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1797                 return ret;
1798         }
1799
1800         netdev_dbg(dev->net, "autosuspend entering SUSPEND3\n");
1801         return smsc75xx_enter_suspend3(dev);
1802 }
1803
1804 static int smsc75xx_suspend(struct usb_interface *intf, pm_message_t message)
1805 {
1806         struct usbnet *dev = usb_get_intfdata(intf);
1807         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
1808         u32 val, link_up;
1809         int ret;
1810
1811         ret = usbnet_suspend(intf, message);
1812         if (ret < 0) {
1813                 netdev_warn(dev->net, "usbnet_suspend error\n");
1814                 return ret;
1815         }
1816
1817         if (pdata->suspend_flags) {
1818                 netdev_warn(dev->net, "error during last resume\n");
1819                 pdata->suspend_flags = 0;
1820         }
1821
1822         /* determine if link is up using only _nopm functions */
1823         link_up = smsc75xx_link_ok_nopm(dev);
1824
1825         if (message.event == PM_EVENT_AUTO_SUSPEND) {
1826                 ret = smsc75xx_autosuspend(dev, link_up);
1827                 goto done;
1828         }
1829
1830         /* if we get this far we're not autosuspending */
1831         /* if no wol options set, or if link is down and we're not waking on
1832          * PHY activity, enter lowest power SUSPEND2 mode
1833          */
1834         if (!(pdata->wolopts & SUPPORTED_WAKE) ||
1835                 !(link_up || (pdata->wolopts & WAKE_PHY))) {
1836                 netdev_info(dev->net, "entering SUSPEND2 mode\n");
1837
1838                 /* disable energy detect (link up) & wake up events */
1839                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
1840                 if (ret < 0) {
1841                         netdev_warn(dev->net, "Error reading WUCSR\n");
1842                         goto done;
1843                 }
1844
1845                 val &= ~(WUCSR_MPEN | WUCSR_WUEN);
1846
1847                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
1848                 if (ret < 0) {
1849                         netdev_warn(dev->net, "Error writing WUCSR\n");
1850                         goto done;
1851                 }
1852
1853                 ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
1854                 if (ret < 0) {
1855                         netdev_warn(dev->net, "Error reading PMT_CTL\n");
1856                         goto done;
1857                 }
1858
1859                 val &= ~(PMT_CTL_ED_EN | PMT_CTL_WOL_EN);
1860
1861                 ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
1862                 if (ret < 0) {
1863                         netdev_warn(dev->net, "Error writing PMT_CTL\n");
1864                         goto done;
1865                 }
1866
1867                 ret = smsc75xx_enter_suspend2(dev);
1868                 goto done;
1869         }
1870
1871         if (pdata->wolopts & WAKE_PHY) {
1872                 ret = smsc75xx_enable_phy_wakeup_interrupts(dev,
1873                         (PHY_INT_MASK_ANEG_COMP | PHY_INT_MASK_LINK_DOWN));
1874                 if (ret < 0) {
1875                         netdev_warn(dev->net, "error enabling PHY wakeup ints\n");
1876                         goto done;
1877                 }
1878
1879                 /* if link is down then configure EDPD and enter SUSPEND1,
1880                  * otherwise enter SUSPEND0 below
1881                  */
1882                 if (!link_up) {
1883                         struct mii_if_info *mii = &dev->mii;
1884                         netdev_info(dev->net, "entering SUSPEND1 mode\n");
1885
1886                         /* enable energy detect power-down mode */
1887                         ret = smsc75xx_mdio_read_nopm(dev->net, mii->phy_id,
1888                                 PHY_MODE_CTRL_STS);
1889                         if (ret < 0) {
1890                                 netdev_warn(dev->net, "Error reading PHY_MODE_CTRL_STS\n");
1891                                 goto done;
1892                         }
1893
1894                         ret |= MODE_CTRL_STS_EDPWRDOWN;
1895
1896                         smsc75xx_mdio_write_nopm(dev->net, mii->phy_id,
1897                                 PHY_MODE_CTRL_STS, ret);
1898
1899                         /* enter SUSPEND1 mode */
1900                         ret = smsc75xx_enter_suspend1(dev);
1901                         goto done;
1902                 }
1903         }
1904
1905         if (pdata->wolopts & (WAKE_MCAST | WAKE_ARP)) {
1906                 int i, filter = 0;
1907
1908                 /* disable all filters */
1909                 for (i = 0; i < WUF_NUM; i++) {
1910                         ret = smsc75xx_write_reg_nopm(dev, WUF_CFGX + i * 4, 0);
1911                         if (ret < 0) {
1912                                 netdev_warn(dev->net, "Error writing WUF_CFGX\n");
1913                                 goto done;
1914                         }
1915                 }
1916
1917                 if (pdata->wolopts & WAKE_MCAST) {
1918                         const u8 mcast[] = {0x01, 0x00, 0x5E};
1919                         netdev_info(dev->net, "enabling multicast detection\n");
1920
1921                         val = WUF_CFGX_EN | WUF_CFGX_ATYPE_MULTICAST
1922                                 | smsc_crc(mcast, 3);
1923                         ret = smsc75xx_write_wuff(dev, filter++, val, 0x0007);
1924                         if (ret < 0) {
1925                                 netdev_warn(dev->net, "Error writing wakeup filter\n");
1926                                 goto done;
1927                         }
1928                 }
1929
1930                 if (pdata->wolopts & WAKE_ARP) {
1931                         const u8 arp[] = {0x08, 0x06};
1932                         netdev_info(dev->net, "enabling ARP detection\n");
1933
1934                         val = WUF_CFGX_EN | WUF_CFGX_ATYPE_ALL | (0x0C << 16)
1935                                 | smsc_crc(arp, 2);
1936                         ret = smsc75xx_write_wuff(dev, filter++, val, 0x0003);
1937                         if (ret < 0) {
1938                                 netdev_warn(dev->net, "Error writing wakeup filter\n");
1939                                 goto done;
1940                         }
1941                 }
1942
1943                 /* clear any pending pattern match packet status */
1944                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
1945                 if (ret < 0) {
1946                         netdev_warn(dev->net, "Error reading WUCSR\n");
1947                         goto done;
1948                 }
1949
1950                 val |= WUCSR_WUFR;
1951
1952                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
1953                 if (ret < 0) {
1954                         netdev_warn(dev->net, "Error writing WUCSR\n");
1955                         goto done;
1956                 }
1957
1958                 netdev_info(dev->net, "enabling packet match detection\n");
1959                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
1960                 if (ret < 0) {
1961                         netdev_warn(dev->net, "Error reading WUCSR\n");
1962                         goto done;
1963                 }
1964
1965                 val |= WUCSR_WUEN;
1966
1967                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
1968                 if (ret < 0) {
1969                         netdev_warn(dev->net, "Error writing WUCSR\n");
1970                         goto done;
1971                 }
1972         } else {
1973                 netdev_info(dev->net, "disabling packet match detection\n");
1974                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
1975                 if (ret < 0) {
1976                         netdev_warn(dev->net, "Error reading WUCSR\n");
1977                         goto done;
1978                 }
1979
1980                 val &= ~WUCSR_WUEN;
1981
1982                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
1983                 if (ret < 0) {
1984                         netdev_warn(dev->net, "Error writing WUCSR\n");
1985                         goto done;
1986                 }
1987         }
1988
1989         /* disable magic, bcast & unicast wakeup sources */
1990         ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
1991         if (ret < 0) {
1992                 netdev_warn(dev->net, "Error reading WUCSR\n");
1993                 goto done;
1994         }
1995
1996         val &= ~(WUCSR_MPEN | WUCSR_BCST_EN | WUCSR_PFDA_EN);
1997
1998         ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
1999         if (ret < 0) {
2000                 netdev_warn(dev->net, "Error writing WUCSR\n");
2001                 goto done;
2002         }
2003
2004         if (pdata->wolopts & WAKE_PHY) {
2005                 netdev_info(dev->net, "enabling PHY wakeup\n");
2006
2007                 ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
2008                 if (ret < 0) {
2009                         netdev_warn(dev->net, "Error reading PMT_CTL\n");
2010                         goto done;
2011                 }
2012
2013                 /* clear wol status, enable energy detection */
2014                 val &= ~PMT_CTL_WUPS;
2015                 val |= (PMT_CTL_WUPS_ED | PMT_CTL_ED_EN);
2016
2017                 ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
2018                 if (ret < 0) {
2019                         netdev_warn(dev->net, "Error writing PMT_CTL\n");
2020                         goto done;
2021                 }
2022         }
2023
2024         if (pdata->wolopts & WAKE_MAGIC) {
2025                 netdev_info(dev->net, "enabling magic packet wakeup\n");
2026                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
2027                 if (ret < 0) {
2028                         netdev_warn(dev->net, "Error reading WUCSR\n");
2029                         goto done;
2030                 }
2031
2032                 /* clear any pending magic packet status */
2033                 val |= WUCSR_MPR | WUCSR_MPEN;
2034
2035                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
2036                 if (ret < 0) {
2037                         netdev_warn(dev->net, "Error writing WUCSR\n");
2038                         goto done;
2039                 }
2040         }
2041
2042         if (pdata->wolopts & WAKE_BCAST) {
2043                 netdev_info(dev->net, "enabling broadcast detection\n");
2044                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
2045                 if (ret < 0) {
2046                         netdev_warn(dev->net, "Error reading WUCSR\n");
2047                         goto done;
2048                 }
2049
2050                 val |= WUCSR_BCAST_FR | WUCSR_BCST_EN;
2051
2052                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
2053                 if (ret < 0) {
2054                         netdev_warn(dev->net, "Error writing WUCSR\n");
2055                         goto done;
2056                 }
2057         }
2058
2059         if (pdata->wolopts & WAKE_UCAST) {
2060                 netdev_info(dev->net, "enabling unicast detection\n");
2061                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
2062                 if (ret < 0) {
2063                         netdev_warn(dev->net, "Error reading WUCSR\n");
2064                         goto done;
2065                 }
2066
2067                 val |= WUCSR_WUFR | WUCSR_PFDA_EN;
2068
2069                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
2070                 if (ret < 0) {
2071                         netdev_warn(dev->net, "Error writing WUCSR\n");
2072                         goto done;
2073                 }
2074         }
2075
2076         /* enable receiver to enable frame reception */
2077         ret = smsc75xx_read_reg_nopm(dev, MAC_RX, &val);
2078         if (ret < 0) {
2079                 netdev_warn(dev->net, "Failed to read MAC_RX: %d\n", ret);
2080                 goto done;
2081         }
2082
2083         val |= MAC_RX_RXEN;
2084
2085         ret = smsc75xx_write_reg_nopm(dev, MAC_RX, val);
2086         if (ret < 0) {
2087                 netdev_warn(dev->net, "Failed to write MAC_RX: %d\n", ret);
2088                 goto done;
2089         }
2090
2091         /* some wol options are enabled, so enter SUSPEND0 */
2092         netdev_info(dev->net, "entering SUSPEND0 mode\n");
2093         ret = smsc75xx_enter_suspend0(dev);
2094
2095 done:
2096         /*
2097          * TODO: resume() might need to handle the suspend failure
2098          * in system sleep
2099          */
2100         if (ret && PMSG_IS_AUTO(message))
2101                 usbnet_resume(intf);
2102         return ret;
2103 }
2104
2105 static int smsc75xx_resume(struct usb_interface *intf)
2106 {
2107         struct usbnet *dev = usb_get_intfdata(intf);
2108         struct smsc75xx_priv *pdata = (struct smsc75xx_priv *)(dev->data[0]);
2109         u8 suspend_flags = pdata->suspend_flags;
2110         int ret;
2111         u32 val;
2112
2113         netdev_dbg(dev->net, "resume suspend_flags=0x%02x\n", suspend_flags);
2114
2115         /* do this first to ensure it's cleared even in error case */
2116         pdata->suspend_flags = 0;
2117
2118         if (suspend_flags & SUSPEND_ALLMODES) {
2119                 /* Disable wakeup sources */
2120                 ret = smsc75xx_read_reg_nopm(dev, WUCSR, &val);
2121                 if (ret < 0) {
2122                         netdev_warn(dev->net, "Error reading WUCSR\n");
2123                         return ret;
2124                 }
2125
2126                 val &= ~(WUCSR_WUEN | WUCSR_MPEN | WUCSR_PFDA_EN
2127                         | WUCSR_BCST_EN);
2128
2129                 ret = smsc75xx_write_reg_nopm(dev, WUCSR, val);
2130                 if (ret < 0) {
2131                         netdev_warn(dev->net, "Error writing WUCSR\n");
2132                         return ret;
2133                 }
2134
2135                 /* clear wake-up status */
2136                 ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
2137                 if (ret < 0) {
2138                         netdev_warn(dev->net, "Error reading PMT_CTL\n");
2139                         return ret;
2140                 }
2141
2142                 val &= ~PMT_CTL_WOL_EN;
2143                 val |= PMT_CTL_WUPS;
2144
2145                 ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
2146                 if (ret < 0) {
2147                         netdev_warn(dev->net, "Error writing PMT_CTL\n");
2148                         return ret;
2149                 }
2150         }
2151
2152         if (suspend_flags & SUSPEND_SUSPEND2) {
2153                 netdev_info(dev->net, "resuming from SUSPEND2\n");
2154
2155                 ret = smsc75xx_read_reg_nopm(dev, PMT_CTL, &val);
2156                 if (ret < 0) {
2157                         netdev_warn(dev->net, "Error reading PMT_CTL\n");
2158                         return ret;
2159                 }
2160
2161                 val |= PMT_CTL_PHY_PWRUP;
2162
2163                 ret = smsc75xx_write_reg_nopm(dev, PMT_CTL, val);
2164                 if (ret < 0) {
2165                         netdev_warn(dev->net, "Error writing PMT_CTL\n");
2166                         return ret;
2167                 }
2168         }
2169
2170         ret = smsc75xx_wait_ready(dev, 1);
2171         if (ret < 0) {
2172                 netdev_warn(dev->net, "device not ready in smsc75xx_resume\n");
2173                 return ret;
2174         }
2175
2176         return usbnet_resume(intf);
2177 }
2178
2179 static void smsc75xx_rx_csum_offload(struct usbnet *dev, struct sk_buff *skb,
2180                                      u32 rx_cmd_a, u32 rx_cmd_b)
2181 {
2182         if (!(dev->net->features & NETIF_F_RXCSUM) ||
2183             unlikely(rx_cmd_a & RX_CMD_A_LCSM)) {
2184                 skb->ip_summed = CHECKSUM_NONE;
2185         } else {
2186                 skb->csum = ntohs((u16)(rx_cmd_b >> RX_CMD_B_CSUM_SHIFT));
2187                 skb->ip_summed = CHECKSUM_COMPLETE;
2188         }
2189 }
2190
2191 static int smsc75xx_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
2192 {
2193         /* This check is no longer done by usbnet */
2194         if (skb->len < dev->net->hard_header_len)
2195                 return 0;
2196
2197         while (skb->len > 0) {
2198                 u32 rx_cmd_a, rx_cmd_b, align_count, size;
2199                 struct sk_buff *ax_skb;
2200                 unsigned char *packet;
2201
2202                 memcpy(&rx_cmd_a, skb->data, sizeof(rx_cmd_a));
2203                 le32_to_cpus(&rx_cmd_a);
2204                 skb_pull(skb, 4);
2205
2206                 memcpy(&rx_cmd_b, skb->data, sizeof(rx_cmd_b));
2207                 le32_to_cpus(&rx_cmd_b);
2208                 skb_pull(skb, 4 + RXW_PADDING);
2209
2210                 packet = skb->data;
2211
2212                 /* get the packet length */
2213                 size = (rx_cmd_a & RX_CMD_A_LEN) - RXW_PADDING;
2214                 align_count = (4 - ((size + RXW_PADDING) % 4)) % 4;
2215
2216                 if (unlikely(rx_cmd_a & RX_CMD_A_RED)) {
2217                         netif_dbg(dev, rx_err, dev->net,
2218                                   "Error rx_cmd_a=0x%08x\n", rx_cmd_a);
2219                         dev->net->stats.rx_errors++;
2220                         dev->net->stats.rx_dropped++;
2221
2222                         if (rx_cmd_a & RX_CMD_A_FCS)
2223                                 dev->net->stats.rx_crc_errors++;
2224                         else if (rx_cmd_a & (RX_CMD_A_LONG | RX_CMD_A_RUNT))
2225                                 dev->net->stats.rx_frame_errors++;
2226                 } else {
2227                         /* MAX_SINGLE_PACKET_SIZE + 4(CRC) + 2(COE) + 4(Vlan) */
2228                         if (unlikely(size > (MAX_SINGLE_PACKET_SIZE + ETH_HLEN + 12))) {
2229                                 netif_dbg(dev, rx_err, dev->net,
2230                                           "size err rx_cmd_a=0x%08x\n",
2231                                           rx_cmd_a);
2232                                 return 0;
2233                         }
2234
2235                         /* last frame in this batch */
2236                         if (skb->len == size) {
2237                                 smsc75xx_rx_csum_offload(dev, skb, rx_cmd_a,
2238                                         rx_cmd_b);
2239
2240                                 skb_trim(skb, skb->len - 4); /* remove fcs */
2241                                 skb->truesize = size + sizeof(struct sk_buff);
2242
2243                                 return 1;
2244                         }
2245
2246                         ax_skb = skb_clone(skb, GFP_ATOMIC);
2247                         if (unlikely(!ax_skb)) {
2248                                 netdev_warn(dev->net, "Error allocating skb\n");
2249                                 return 0;
2250                         }
2251
2252                         ax_skb->len = size;
2253                         ax_skb->data = packet;
2254                         skb_set_tail_pointer(ax_skb, size);
2255
2256                         smsc75xx_rx_csum_offload(dev, ax_skb, rx_cmd_a,
2257                                 rx_cmd_b);
2258
2259                         skb_trim(ax_skb, ax_skb->len - 4); /* remove fcs */
2260                         ax_skb->truesize = size + sizeof(struct sk_buff);
2261
2262                         usbnet_skb_return(dev, ax_skb);
2263                 }
2264
2265                 skb_pull(skb, size);
2266
2267                 /* padding bytes before the next frame starts */
2268                 if (skb->len)
2269                         skb_pull(skb, align_count);
2270         }
2271
2272         return 1;
2273 }
2274
2275 static struct sk_buff *smsc75xx_tx_fixup(struct usbnet *dev,
2276                                          struct sk_buff *skb, gfp_t flags)
2277 {
2278         u32 tx_cmd_a, tx_cmd_b;
2279
2280         if (skb_cow_head(skb, SMSC75XX_TX_OVERHEAD)) {
2281                 dev_kfree_skb_any(skb);
2282                 return NULL;
2283         }
2284
2285         tx_cmd_a = (u32)(skb->len & TX_CMD_A_LEN) | TX_CMD_A_FCS;
2286
2287         if (skb->ip_summed == CHECKSUM_PARTIAL)
2288                 tx_cmd_a |= TX_CMD_A_IPE | TX_CMD_A_TPE;
2289
2290         if (skb_is_gso(skb)) {
2291                 u16 mss = max(skb_shinfo(skb)->gso_size, TX_MSS_MIN);
2292                 tx_cmd_b = (mss << TX_CMD_B_MSS_SHIFT) & TX_CMD_B_MSS;
2293
2294                 tx_cmd_a |= TX_CMD_A_LSO;
2295         } else {
2296                 tx_cmd_b = 0;
2297         }
2298
2299         skb_push(skb, 4);
2300         cpu_to_le32s(&tx_cmd_b);
2301         memcpy(skb->data, &tx_cmd_b, 4);
2302
2303         skb_push(skb, 4);
2304         cpu_to_le32s(&tx_cmd_a);
2305         memcpy(skb->data, &tx_cmd_a, 4);
2306
2307         return skb;
2308 }
2309
2310 static int smsc75xx_manage_power(struct usbnet *dev, int on)
2311 {
2312         dev->intf->needs_remote_wakeup = on;
2313         return 0;
2314 }
2315
2316 static const struct driver_info smsc75xx_info = {
2317         .description    = "smsc75xx USB 2.0 Gigabit Ethernet",
2318         .bind           = smsc75xx_bind,
2319         .unbind         = smsc75xx_unbind,
2320         .link_reset     = smsc75xx_link_reset,
2321         .reset          = smsc75xx_reset,
2322         .rx_fixup       = smsc75xx_rx_fixup,
2323         .tx_fixup       = smsc75xx_tx_fixup,
2324         .status         = smsc75xx_status,
2325         .manage_power   = smsc75xx_manage_power,
2326         .flags          = FLAG_ETHER | FLAG_SEND_ZLP | FLAG_LINK_INTR,
2327 };
2328
2329 static const struct usb_device_id products[] = {
2330         {
2331                 /* SMSC7500 USB Gigabit Ethernet Device */
2332                 USB_DEVICE(USB_VENDOR_ID_SMSC, USB_PRODUCT_ID_LAN7500),
2333                 .driver_info = (unsigned long) &smsc75xx_info,
2334         },
2335         {
2336                 /* SMSC7500 USB Gigabit Ethernet Device */
2337                 USB_DEVICE(USB_VENDOR_ID_SMSC, USB_PRODUCT_ID_LAN7505),
2338                 .driver_info = (unsigned long) &smsc75xx_info,
2339         },
2340         { },            /* END */
2341 };
2342 MODULE_DEVICE_TABLE(usb, products);
2343
2344 static struct usb_driver smsc75xx_driver = {
2345         .name           = SMSC_CHIPNAME,
2346         .id_table       = products,
2347         .probe          = usbnet_probe,
2348         .suspend        = smsc75xx_suspend,
2349         .resume         = smsc75xx_resume,
2350         .reset_resume   = smsc75xx_resume,
2351         .disconnect     = usbnet_disconnect,
2352         .disable_hub_initiated_lpm = 1,
2353         .supports_autosuspend = 1,
2354 };
2355
2356 module_usb_driver(smsc75xx_driver);
2357
2358 MODULE_AUTHOR("Nancy Lin");
2359 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
2360 MODULE_DESCRIPTION("SMSC75XX USB 2.0 Gigabit Ethernet Devices");
2361 MODULE_LICENSE("GPL");