drivers/net/usb/asix_common.c

   1 /*
   2  * ASIX AX8817X based USB 2.0 Ethernet Devices
   3  * Copyright (C) 2003-2006 David Hollis <dhollis@davehollis.com>
   4  * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
   5  * Copyright (C) 2006 James Painter <jamie.painter@iname.com>
   6  * Copyright (c) 2002-2003 TiVo Inc.
   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  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include "asix.h"
  23
  24 int asix_read_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
  25                   u16 size, void *data)
  26 {
  27         int ret;
  28         ret = usbnet_read_cmd(dev, cmd,
  29                                USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  30                                value, index, data, size);
  31
  32         if (ret != size && ret >= 0)
  33                 return -EINVAL;
  34         return ret;
  35 }
  36
  37 int asix_write_cmd(struct usbnet *dev, u8 cmd, u16 value, u16 index,
  38                    u16 size, void *data)
  39 {
  40         return usbnet_write_cmd(dev, cmd,
  41                                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  42                                 value, index, data, size);
  43 }
  44
  45 void asix_write_cmd_async(struct usbnet *dev, u8 cmd, u16 value, u16 index,
  46                           u16 size, void *data)
  47 {
  48         usbnet_write_cmd_async(dev, cmd,
  49                                USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  50                                value, index, data, size);
  51 }
  52
  53 int asix_rx_fixup_internal(struct usbnet *dev, struct sk_buff *skb,
  54                            struct asix_rx_fixup_info *rx)
  55 {
  56         int offset = 0;
  57
  58         while (offset + sizeof(u16) <= skb->len) {
  59                 u16 remaining = 0;
  60                 unsigned char *data;
  61
  62                 if (!rx->size) {
  63                         if ((skb->len - offset == sizeof(u16)) ||
  64                             rx->split_head) {
  65                                 if(!rx->split_head) {
  66                                         rx->header = get_unaligned_le16(
  67                                                         skb->data + offset);
  68                                         rx->split_head = true;
  69                                         offset += sizeof(u16);
  70                                         break;
  71                                 } else {
  72                                         rx->header |= (get_unaligned_le16(
  73                                                         skb->data + offset)
  74                                                         << 16);
  75                                         rx->split_head = false;
  76                                         offset += sizeof(u16);
  77                                 }
  78                         } else {
  79                                 rx->header = get_unaligned_le32(skb->data +
  80                                                                 offset);
  81                                 offset += sizeof(u32);
  82                         }
  83
  84                         /* get the packet length */
  85                         rx->size = (u16) (rx->header & 0x7ff);
  86                         if (rx->size != ((~rx->header >> 16) & 0x7ff)) {
  87                                 netdev_err(dev->net, "asix_rx_fixup() Bad Header Length 0x%x, offset %d\n",
  88                                            rx->header, offset);
  89                                 rx->size = 0;
  90                                 return 0;
  91                         }
  92                         rx->ax_skb = netdev_alloc_skb_ip_align(dev->net,
  93                                                                rx->size);
  94                         if (!rx->ax_skb) {
  95                                 rx->size = 0;
  96                                 return 0;
  97                         }
  98                 }
  99
 100                 if (rx->size > dev->net->mtu + ETH_HLEN + VLAN_HLEN) {
 101                         netdev_err(dev->net, "asix_rx_fixup() Bad RX Length %d\n",
 102                                    rx->size);
 103                         kfree_skb(rx->ax_skb);
 104                         rx->ax_skb = NULL;
 105                         rx->size = 0U;
 106
 107                         return 0;
 108                 }
 109
 110                 if (rx->size > skb->len - offset) {
 111                         remaining = rx->size - (skb->len - offset);
 112                         rx->size = skb->len - offset;
 113                 }
 114
 115                 data = skb_put(rx->ax_skb, rx->size);
 116                 memcpy(data, skb->data + offset, rx->size);
 117                 if (!remaining)
 118                         usbnet_skb_return(dev, rx->ax_skb);
 119
 120                 offset += (rx->size + 1) & 0xfffe;
 121                 rx->size = remaining;
 122         }
 123
 124         if (skb->len != offset) {
 125                 netdev_err(dev->net, "asix_rx_fixup() Bad SKB Length %d, %d\n",
 126                            skb->len, offset);
 127                 return 0;
 128         }
 129
 130         return 1;
 131 }
 132
 133 int asix_rx_fixup_common(struct usbnet *dev, struct sk_buff *skb)
 134 {
 135         struct asix_common_private *dp = dev->driver_priv;
 136         struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
 137
 138         return asix_rx_fixup_internal(dev, skb, rx);
 139 }
 140
 141 struct sk_buff *asix_tx_fixup(struct usbnet *dev, struct sk_buff *skb,
 142                               gfp_t flags)
 143 {
 144         int padlen;
 145         int headroom = skb_headroom(skb);
 146         int tailroom = skb_tailroom(skb);
 147         u32 packet_len;
 148         u32 padbytes = 0xffff0000;
 149
 150         padlen = ((skb->len + 4) & (dev->maxpacket - 1)) ? 0 : 4;
 151
 152         /* We need to push 4 bytes in front of frame (packet_len)
 153          * and maybe add 4 bytes after the end (if padlen is 4)
 154          *
 155          * Avoid skb_copy_expand() expensive call, using following rules :
 156          * - We are allowed to push 4 bytes in headroom if skb_header_cloned()
 157          *   is false (and if we have 4 bytes of headroom)
 158          * - We are allowed to put 4 bytes at tail if skb_cloned()
 159          *   is false (and if we have 4 bytes of tailroom)
 160          *
 161          * TCP packets for example are cloned, but skb_header_release()
 162          * was called in tcp stack, allowing us to use headroom for our needs.
 163          */
 164         if (!skb_header_cloned(skb) &&
 165             !(padlen && skb_cloned(skb)) &&
 166             headroom + tailroom >= 4 + padlen) {
 167                 /* following should not happen, but better be safe */
 168                 if (headroom < 4 ||
 169                     tailroom < padlen) {
 170                         skb->data = memmove(skb->head + 4, skb->data, skb->len);
 171                         skb_set_tail_pointer(skb, skb->len);
 172                 }
 173         } else {
 174                 struct sk_buff *skb2;
 175
 176                 skb2 = skb_copy_expand(skb, 4, padlen, flags);
 177                 dev_kfree_skb_any(skb);
 178                 skb = skb2;
 179                 if (!skb)
 180                         return NULL;
 181         }
 182
 183         packet_len = ((skb->len ^ 0x0000ffff) << 16) + skb->len;
 184         skb_push(skb, 4);
 185         cpu_to_le32s(&packet_len);
 186         skb_copy_to_linear_data(skb, &packet_len, sizeof(packet_len));
 187
 188         if (padlen) {
 189                 cpu_to_le32s(&padbytes);
 190                 memcpy(skb_tail_pointer(skb), &padbytes, sizeof(padbytes));
 191                 skb_put(skb, sizeof(padbytes));
 192         }
 193
 194         usbnet_set_skb_tx_stats(skb, 1, 0);
 195         return skb;
 196 }
 197
 198 int asix_set_sw_mii(struct usbnet *dev)
 199 {
 200         int ret;
 201         ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL);
 202         if (ret < 0)
 203                 netdev_err(dev->net, "Failed to enable software MII access\n");
 204         return ret;
 205 }
 206
 207 int asix_set_hw_mii(struct usbnet *dev)
 208 {
 209         int ret;
 210         ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL);
 211         if (ret < 0)
 212                 netdev_err(dev->net, "Failed to enable hardware MII access\n");
 213         return ret;
 214 }
 215
 216 int asix_read_phy_addr(struct usbnet *dev, int internal)
 217 {
 218         int offset = (internal ? 1 : 0);
 219         u8 buf[2];
 220         int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf);
 221
 222         netdev_dbg(dev->net, "asix_get_phy_addr()\n");
 223
 224         if (ret < 0) {
 225                 netdev_err(dev->net, "Error reading PHYID register: %02x\n", ret);
 226                 goto out;
 227         }
 228         netdev_dbg(dev->net, "asix_get_phy_addr() returning 0x%04x\n",
 229                    *((__le16 *)buf));
 230         ret = buf[offset];
 231
 232 out:
 233         return ret;
 234 }
 235
 236 int asix_get_phy_addr(struct usbnet *dev)
 237 {
 238         /* return the address of the internal phy */
 239         return asix_read_phy_addr(dev, 1);
 240 }
 241
 242
 243 int asix_sw_reset(struct usbnet *dev, u8 flags)
 244 {
 245         int ret;
 246
 247         ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL);
 248         if (ret < 0)
 249                 netdev_err(dev->net, "Failed to send software reset: %02x\n", ret);
 250
 251         return ret;
 252 }
 253
 254 u16 asix_read_rx_ctl(struct usbnet *dev)
 255 {
 256         __le16 v;
 257         int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, &v);
 258
 259         if (ret < 0) {
 260                 netdev_err(dev->net, "Error reading RX_CTL register: %02x\n", ret);
 261                 goto out;
 262         }
 263         ret = le16_to_cpu(v);
 264 out:
 265         return ret;
 266 }
 267
 268 int asix_write_rx_ctl(struct usbnet *dev, u16 mode)
 269 {
 270         int ret;
 271
 272         netdev_dbg(dev->net, "asix_write_rx_ctl() - mode = 0x%04x\n", mode);
 273         ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL);
 274         if (ret < 0)
 275                 netdev_err(dev->net, "Failed to write RX_CTL mode to 0x%04x: %02x\n",
 276                            mode, ret);
 277
 278         return ret;
 279 }
 280
 281 u16 asix_read_medium_status(struct usbnet *dev)
 282 {
 283         __le16 v;
 284         int ret = asix_read_cmd(dev, AX_CMD_READ_MEDIUM_STATUS, 0, 0, 2, &v);
 285
 286         if (ret < 0) {
 287                 netdev_err(dev->net, "Error reading Medium Status register: %02x\n",
 288                            ret);
 289                 return ret;     /* TODO: callers not checking for error ret */
 290         }
 291
 292         return le16_to_cpu(v);
 293
 294 }
 295
 296 int asix_write_medium_mode(struct usbnet *dev, u16 mode)
 297 {
 298         int ret;
 299
 300         netdev_dbg(dev->net, "asix_write_medium_mode() - mode = 0x%04x\n", mode);
 301         ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE, mode, 0, 0, NULL);
 302         if (ret < 0)
 303                 netdev_err(dev->net, "Failed to write Medium Mode mode to 0x%04x: %02x\n",
 304                            mode, ret);
 305
 306         return ret;
 307 }
 308
 309 int asix_write_gpio(struct usbnet *dev, u16 value, int sleep)
 310 {
 311         int ret;
 312
 313         netdev_dbg(dev->net, "asix_write_gpio() - value = 0x%04x\n", value);
 314         ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL);
 315         if (ret < 0)
 316                 netdev_err(dev->net, "Failed to write GPIO value 0x%04x: %02x\n",
 317                            value, ret);
 318
 319         if (sleep)
 320                 msleep(sleep);
 321
 322         return ret;
 323 }
 324
 325 /*
 326  * AX88772 & AX88178 have a 16-bit RX_CTL value
 327  */
 328 void asix_set_multicast(struct net_device *net)
 329 {
 330         struct usbnet *dev = netdev_priv(net);
 331         struct asix_data *data = (struct asix_data *)&dev->data;
 332         u16 rx_ctl = AX_DEFAULT_RX_CTL;
 333
 334         if (net->flags & IFF_PROMISC) {
 335                 rx_ctl |= AX_RX_CTL_PRO;
 336         } else if (net->flags & IFF_ALLMULTI ||
 337                    netdev_mc_count(net) > AX_MAX_MCAST) {
 338                 rx_ctl |= AX_RX_CTL_AMALL;
 339         } else if (netdev_mc_empty(net)) {
 340                 /* just broadcast and directed */
 341         } else {
 342                 /* We use the 20 byte dev->data
 343                  * for our 8 byte filter buffer
 344                  * to avoid allocating memory that
 345                  * is tricky to free later */
 346                 struct netdev_hw_addr *ha;
 347                 u32 crc_bits;
 348
 349                 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE);
 350
 351                 /* Build the multicast hash filter. */
 352                 netdev_for_each_mc_addr(ha, net) {
 353                         crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26;
 354                         data->multi_filter[crc_bits >> 3] |=
 355                             1 << (crc_bits & 7);
 356                 }
 357
 358                 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0,
 359                                    AX_MCAST_FILTER_SIZE, data->multi_filter);
 360
 361                 rx_ctl |= AX_RX_CTL_AM;
 362         }
 363
 364         asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL);
 365 }
 366
 367 int asix_mdio_read(struct net_device *netdev, int phy_id, int loc)
 368 {
 369         struct usbnet *dev = netdev_priv(netdev);
 370         __le16 res;
 371
 372         mutex_lock(&dev->phy_mutex);
 373         asix_set_sw_mii(dev);
 374         asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id,
 375                                 (__u16)loc, 2, &res);
 376         asix_set_hw_mii(dev);
 377         mutex_unlock(&dev->phy_mutex);
 378
 379         netdev_dbg(dev->net, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n",
 380                    phy_id, loc, le16_to_cpu(res));
 381
 382         return le16_to_cpu(res);
 383 }
 384
 385 void asix_mdio_write(struct net_device *netdev, int phy_id, int loc, int val)
 386 {
 387         struct usbnet *dev = netdev_priv(netdev);
 388         __le16 res = cpu_to_le16(val);
 389
 390         netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n",
 391                    phy_id, loc, val);
 392         mutex_lock(&dev->phy_mutex);
 393         asix_set_sw_mii(dev);
 394         asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id, (__u16)loc, 2, &res);
 395         asix_set_hw_mii(dev);
 396         mutex_unlock(&dev->phy_mutex);
 397 }
 398
 399 void asix_get_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
 400 {
 401         struct usbnet *dev = netdev_priv(net);
 402         u8 opt;
 403
 404         if (asix_read_cmd(dev, AX_CMD_READ_MONITOR_MODE, 0, 0, 1, &opt) < 0) {
 405                 wolinfo->supported = 0;
 406                 wolinfo->wolopts = 0;
 407                 return;
 408         }
 409         wolinfo->supported = WAKE_PHY | WAKE_MAGIC;
 410         wolinfo->wolopts = 0;
 411         if (opt & AX_MONITOR_LINK)
 412                 wolinfo->wolopts |= WAKE_PHY;
 413         if (opt & AX_MONITOR_MAGIC)
 414                 wolinfo->wolopts |= WAKE_MAGIC;
 415 }
 416
 417 int asix_set_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo)
 418 {
 419         struct usbnet *dev = netdev_priv(net);
 420         u8 opt = 0;
 421
 422         if (wolinfo->wolopts & WAKE_PHY)
 423                 opt |= AX_MONITOR_LINK;
 424         if (wolinfo->wolopts & WAKE_MAGIC)
 425                 opt |= AX_MONITOR_MAGIC;
 426
 427         if (asix_write_cmd(dev, AX_CMD_WRITE_MONITOR_MODE,
 428                               opt, 0, 0, NULL) < 0)
 429                 return -EINVAL;
 430
 431         return 0;
 432 }
 433
 434 int asix_get_eeprom_len(struct net_device *net)
 435 {
 436         return AX_EEPROM_LEN;
 437 }
 438
 439 int asix_get_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
 440                     u8 *data)
 441 {
 442         struct usbnet *dev = netdev_priv(net);
 443         u16 *eeprom_buff;
 444         int first_word, last_word;
 445         int i;
 446
 447         if (eeprom->len == 0)
 448                 return -EINVAL;
 449
 450         eeprom->magic = AX_EEPROM_MAGIC;
 451
 452         first_word = eeprom->offset >> 1;
 453         last_word = (eeprom->offset + eeprom->len - 1) >> 1;
 454
 455         eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
 456                               GFP_KERNEL);
 457         if (!eeprom_buff)
 458                 return -ENOMEM;
 459
 460         /* ax8817x returns 2 bytes from eeprom on read */
 461         for (i = first_word; i <= last_word; i++) {
 462                 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM, i, 0, 2,
 463                                   &(eeprom_buff[i - first_word])) < 0) {
 464                         kfree(eeprom_buff);
 465                         return -EIO;
 466                 }
 467         }
 468
 469         memcpy(data, (u8 *)eeprom_buff + (eeprom->offset & 1), eeprom->len);
 470         kfree(eeprom_buff);
 471         return 0;
 472 }
 473
 474 int asix_set_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom,
 475                     u8 *data)
 476 {
 477         struct usbnet *dev = netdev_priv(net);
 478         u16 *eeprom_buff;
 479         int first_word, last_word;
 480         int i;
 481         int ret;
 482
 483         netdev_dbg(net, "write EEPROM len %d, offset %d, magic 0x%x\n",
 484                    eeprom->len, eeprom->offset, eeprom->magic);
 485
 486         if (eeprom->len == 0)
 487                 return -EINVAL;
 488
 489         if (eeprom->magic != AX_EEPROM_MAGIC)
 490                 return -EINVAL;
 491
 492         first_word = eeprom->offset >> 1;
 493         last_word = (eeprom->offset + eeprom->len - 1) >> 1;
 494
 495         eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1),
 496                               GFP_KERNEL);
 497         if (!eeprom_buff)
 498                 return -ENOMEM;
 499
 500         /* align data to 16 bit boundaries, read the missing data from
 501            the EEPROM */
 502         if (eeprom->offset & 1) {
 503                 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, first_word, 0, 2,
 504                                     &(eeprom_buff[0]));
 505                 if (ret < 0) {
 506                         netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", first_word);
 507                         goto free;
 508                 }
 509         }
 510
 511         if ((eeprom->offset + eeprom->len) & 1) {
 512                 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, last_word, 0, 2,
 513                                     &(eeprom_buff[last_word - first_word]));
 514                 if (ret < 0) {
 515                         netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", last_word);
 516                         goto free;
 517                 }
 518         }
 519
 520         memcpy((u8 *)eeprom_buff + (eeprom->offset & 1), data, eeprom->len);
 521
 522         /* write data to EEPROM */
 523         ret = asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0x0000, 0, 0, NULL);
 524         if (ret < 0) {
 525                 netdev_err(net, "Failed to enable EEPROM write\n");
 526                 goto free;
 527         }
 528         msleep(20);
 529
 530         for (i = first_word; i <= last_word; i++) {
 531                 netdev_dbg(net, "write to EEPROM at offset 0x%02x, data 0x%04x\n",
 532                            i, eeprom_buff[i - first_word]);
 533                 ret = asix_write_cmd(dev, AX_CMD_WRITE_EEPROM, i,
 534                                      eeprom_buff[i - first_word], 0, NULL);
 535                 if (ret < 0) {
 536                         netdev_err(net, "Failed to write EEPROM at offset 0x%02x.\n",
 537                                    i);
 538                         goto free;
 539                 }
 540                 msleep(20);
 541         }
 542
 543         ret = asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0x0000, 0, 0, NULL);
 544         if (ret < 0) {
 545                 netdev_err(net, "Failed to disable EEPROM write\n");
 546                 goto free;
 547         }
 548
 549         ret = 0;
 550 free:
 551         kfree(eeprom_buff);
 552         return ret;
 553 }
 554
 555 void asix_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info)
 556 {
 557         /* Inherit standard device info */
 558         usbnet_get_drvinfo(net, info);
 559         strlcpy(info->driver, DRIVER_NAME, sizeof(info->driver));
 560         strlcpy(info->version, DRIVER_VERSION, sizeof(info->version));
 561         info->eedump_len = AX_EEPROM_LEN;
 562 }
 563
 564 int asix_set_mac_address(struct net_device *net, void *p)
 565 {
 566         struct usbnet *dev = netdev_priv(net);
 567         struct asix_data *data = (struct asix_data *)&dev->data;
 568         struct sockaddr *addr = p;
 569
 570         if (netif_running(net))
 571                 return -EBUSY;
 572         if (!is_valid_ether_addr(addr->sa_data))
 573                 return -EADDRNOTAVAIL;
 574
 575         memcpy(net->dev_addr, addr->sa_data, ETH_ALEN);
 576
 577         /* We use the 20 byte dev->data
 578          * for our 6 byte mac buffer
 579          * to avoid allocating memory that
 580          * is tricky to free later */
 581         memcpy(data->mac_addr, addr->sa_data, ETH_ALEN);
 582         asix_write_cmd_async(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,
 583                                                         data->mac_addr);
 584
 585         return 0;
 586 }