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