LXR linux/drivers/net/usb/asix

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