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 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 131 int 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 139 struct 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 192 usbnet_set_skb_tx_stats(skb, 1, 0); 193 return skb; 194 } 195 196 int asix_set_sw_mii(struct usbnet *dev) 197 { 198 int ret; 199 ret = asix_write_cmd(dev, AX_CMD_SET_SW_MII, 0x0000, 0, 0, NULL); 200 if (ret < 0) 201 netdev_err(dev->net, "Failed to enable software MII access\n"); 202 return ret; 203 } 204 205 int asix_set_hw_mii(struct usbnet *dev) 206 { 207 int ret; 208 ret = asix_write_cmd(dev, AX_CMD_SET_HW_MII, 0x0000, 0, 0, NULL); 209 if (ret < 0) 210 netdev_err(dev->net, "Failed to enable hardware MII access\n"); 211 return ret; 212 } 213 214 int asix_read_phy_addr(struct usbnet *dev, int internal) 215 { 216 int offset = (internal ? 1 : 0); 217 u8 buf[2]; 218 int ret = asix_read_cmd(dev, AX_CMD_READ_PHY_ID, 0, 0, 2, buf); 219 220 netdev_dbg(dev->net, "asix_get_phy_addr()\n"); 221 222 if (ret < 0) { 223 netdev_err(dev->net, "Error reading PHYID register: %02x\n", ret); 224 goto out; 225 } 226 netdev_dbg(dev->net, "asix_get_phy_addr() returning 0x%04x\n", 227 *((__le16 *)buf)); 228 ret = buf[offset]; 229 230 out: 231 return ret; 232 } 233 234 int asix_get_phy_addr(struct usbnet *dev) 235 { 236 /* return the address of the internal phy */ 237 return asix_read_phy_addr(dev, 1); 238 } 239 240 241 int asix_sw_reset(struct usbnet *dev, u8 flags) 242 { 243 int ret; 244 245 ret = asix_write_cmd(dev, AX_CMD_SW_RESET, flags, 0, 0, NULL); 246 if (ret < 0) 247 netdev_err(dev->net, "Failed to send software reset: %02x\n", ret); 248 249 return ret; 250 } 251 252 u16 asix_read_rx_ctl(struct usbnet *dev) 253 { 254 __le16 v; 255 int ret = asix_read_cmd(dev, AX_CMD_READ_RX_CTL, 0, 0, 2, &v); 256 257 if (ret < 0) { 258 netdev_err(dev->net, "Error reading RX_CTL register: %02x\n", ret); 259 goto out; 260 } 261 ret = le16_to_cpu(v); 262 out: 263 return ret; 264 } 265 266 int asix_write_rx_ctl(struct usbnet *dev, u16 mode) 267 { 268 int ret; 269 270 netdev_dbg(dev->net, "asix_write_rx_ctl() - mode = 0x%04x\n", mode); 271 ret = asix_write_cmd(dev, AX_CMD_WRITE_RX_CTL, mode, 0, 0, NULL); 272 if (ret < 0) 273 netdev_err(dev->net, "Failed to write RX_CTL mode to 0x%04x: %02x\n", 274 mode, ret); 275 276 return ret; 277 } 278 279 u16 asix_read_medium_status(struct usbnet *dev) 280 { 281 __le16 v; 282 int ret = asix_read_cmd(dev, AX_CMD_READ_MEDIUM_STATUS, 0, 0, 2, &v); 283 284 if (ret < 0) { 285 netdev_err(dev->net, "Error reading Medium Status register: %02x\n", 286 ret); 287 return ret; /* TODO: callers not checking for error ret */ 288 } 289 290 return le16_to_cpu(v); 291 292 } 293 294 int asix_write_medium_mode(struct usbnet *dev, u16 mode) 295 { 296 int ret; 297 298 netdev_dbg(dev->net, "asix_write_medium_mode() - mode = 0x%04x\n", mode); 299 ret = asix_write_cmd(dev, AX_CMD_WRITE_MEDIUM_MODE, mode, 0, 0, NULL); 300 if (ret < 0) 301 netdev_err(dev->net, "Failed to write Medium Mode mode to 0x%04x: %02x\n", 302 mode, ret); 303 304 return ret; 305 } 306 307 int asix_write_gpio(struct usbnet *dev, u16 value, int sleep) 308 { 309 int ret; 310 311 netdev_dbg(dev->net, "asix_write_gpio() - value = 0x%04x\n", value); 312 ret = asix_write_cmd(dev, AX_CMD_WRITE_GPIOS, value, 0, 0, NULL); 313 if (ret < 0) 314 netdev_err(dev->net, "Failed to write GPIO value 0x%04x: %02x\n", 315 value, ret); 316 317 if (sleep) 318 msleep(sleep); 319 320 return ret; 321 } 322 323 /* 324 * AX88772 & AX88178 have a 16-bit RX_CTL value 325 */ 326 void asix_set_multicast(struct net_device *net) 327 { 328 struct usbnet *dev = netdev_priv(net); 329 struct asix_data *data = (struct asix_data *)&dev->data; 330 u16 rx_ctl = AX_DEFAULT_RX_CTL; 331 332 if (net->flags & IFF_PROMISC) { 333 rx_ctl |= AX_RX_CTL_PRO; 334 } else if (net->flags & IFF_ALLMULTI || 335 netdev_mc_count(net) > AX_MAX_MCAST) { 336 rx_ctl |= AX_RX_CTL_AMALL; 337 } else if (netdev_mc_empty(net)) { 338 /* just broadcast and directed */ 339 } else { 340 /* We use the 20 byte dev->data 341 * for our 8 byte filter buffer 342 * to avoid allocating memory that 343 * is tricky to free later */ 344 struct netdev_hw_addr *ha; 345 u32 crc_bits; 346 347 memset(data->multi_filter, 0, AX_MCAST_FILTER_SIZE); 348 349 /* Build the multicast hash filter. */ 350 netdev_for_each_mc_addr(ha, net) { 351 crc_bits = ether_crc(ETH_ALEN, ha->addr) >> 26; 352 data->multi_filter[crc_bits >> 3] |= 353 1 << (crc_bits & 7); 354 } 355 356 asix_write_cmd_async(dev, AX_CMD_WRITE_MULTI_FILTER, 0, 0, 357 AX_MCAST_FILTER_SIZE, data->multi_filter); 358 359 rx_ctl |= AX_RX_CTL_AM; 360 } 361 362 asix_write_cmd_async(dev, AX_CMD_WRITE_RX_CTL, rx_ctl, 0, 0, NULL); 363 } 364 365 int asix_mdio_read(struct net_device *netdev, int phy_id, int loc) 366 { 367 struct usbnet *dev = netdev_priv(netdev); 368 __le16 res; 369 370 mutex_lock(&dev->phy_mutex); 371 asix_set_sw_mii(dev); 372 asix_read_cmd(dev, AX_CMD_READ_MII_REG, phy_id, 373 (__u16)loc, 2, &res); 374 asix_set_hw_mii(dev); 375 mutex_unlock(&dev->phy_mutex); 376 377 netdev_dbg(dev->net, "asix_mdio_read() phy_id=0x%02x, loc=0x%02x, returns=0x%04x\n", 378 phy_id, loc, le16_to_cpu(res)); 379 380 return le16_to_cpu(res); 381 } 382 383 void asix_mdio_write(struct net_device *netdev, int phy_id, int loc, int val) 384 { 385 struct usbnet *dev = netdev_priv(netdev); 386 __le16 res = cpu_to_le16(val); 387 388 netdev_dbg(dev->net, "asix_mdio_write() phy_id=0x%02x, loc=0x%02x, val=0x%04x\n", 389 phy_id, loc, val); 390 mutex_lock(&dev->phy_mutex); 391 asix_set_sw_mii(dev); 392 asix_write_cmd(dev, AX_CMD_WRITE_MII_REG, phy_id, (__u16)loc, 2, &res); 393 asix_set_hw_mii(dev); 394 mutex_unlock(&dev->phy_mutex); 395 } 396 397 void asix_get_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo) 398 { 399 struct usbnet *dev = netdev_priv(net); 400 u8 opt; 401 402 if (asix_read_cmd(dev, AX_CMD_READ_MONITOR_MODE, 0, 0, 1, &opt) < 0) { 403 wolinfo->supported = 0; 404 wolinfo->wolopts = 0; 405 return; 406 } 407 wolinfo->supported = WAKE_PHY | WAKE_MAGIC; 408 wolinfo->wolopts = 0; 409 if (opt & AX_MONITOR_LINK) 410 wolinfo->wolopts |= WAKE_PHY; 411 if (opt & AX_MONITOR_MAGIC) 412 wolinfo->wolopts |= WAKE_MAGIC; 413 } 414 415 int asix_set_wol(struct net_device *net, struct ethtool_wolinfo *wolinfo) 416 { 417 struct usbnet *dev = netdev_priv(net); 418 u8 opt = 0; 419 420 if (wolinfo->wolopts & WAKE_PHY) 421 opt |= AX_MONITOR_LINK; 422 if (wolinfo->wolopts & WAKE_MAGIC) 423 opt |= AX_MONITOR_MAGIC; 424 425 if (asix_write_cmd(dev, AX_CMD_WRITE_MONITOR_MODE, 426 opt, 0, 0, NULL) < 0) 427 return -EINVAL; 428 429 return 0; 430 } 431 432 int asix_get_eeprom_len(struct net_device *net) 433 { 434 return AX_EEPROM_LEN; 435 } 436 437 int asix_get_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom, 438 u8 *data) 439 { 440 struct usbnet *dev = netdev_priv(net); 441 u16 *eeprom_buff; 442 int first_word, last_word; 443 int i; 444 445 if (eeprom->len == 0) 446 return -EINVAL; 447 448 eeprom->magic = AX_EEPROM_MAGIC; 449 450 first_word = eeprom->offset >> 1; 451 last_word = (eeprom->offset + eeprom->len - 1) >> 1; 452 453 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1), 454 GFP_KERNEL); 455 if (!eeprom_buff) 456 return -ENOMEM; 457 458 /* ax8817x returns 2 bytes from eeprom on read */ 459 for (i = first_word; i <= last_word; i++) { 460 if (asix_read_cmd(dev, AX_CMD_READ_EEPROM, i, 0, 2, 461 &(eeprom_buff[i - first_word])) < 0) { 462 kfree(eeprom_buff); 463 return -EIO; 464 } 465 } 466 467 memcpy(data, (u8 *)eeprom_buff + (eeprom->offset & 1), eeprom->len); 468 kfree(eeprom_buff); 469 return 0; 470 } 471 472 int asix_set_eeprom(struct net_device *net, struct ethtool_eeprom *eeprom, 473 u8 *data) 474 { 475 struct usbnet *dev = netdev_priv(net); 476 u16 *eeprom_buff; 477 int first_word, last_word; 478 int i; 479 int ret; 480 481 netdev_dbg(net, "write EEPROM len %d, offset %d, magic 0x%x\n", 482 eeprom->len, eeprom->offset, eeprom->magic); 483 484 if (eeprom->len == 0) 485 return -EINVAL; 486 487 if (eeprom->magic != AX_EEPROM_MAGIC) 488 return -EINVAL; 489 490 first_word = eeprom->offset >> 1; 491 last_word = (eeprom->offset + eeprom->len - 1) >> 1; 492 493 eeprom_buff = kmalloc(sizeof(u16) * (last_word - first_word + 1), 494 GFP_KERNEL); 495 if (!eeprom_buff) 496 return -ENOMEM; 497 498 /* align data to 16 bit boundaries, read the missing data from 499 the EEPROM */ 500 if (eeprom->offset & 1) { 501 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, first_word, 0, 2, 502 &(eeprom_buff[0])); 503 if (ret < 0) { 504 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", first_word); 505 goto free; 506 } 507 } 508 509 if ((eeprom->offset + eeprom->len) & 1) { 510 ret = asix_read_cmd(dev, AX_CMD_READ_EEPROM, last_word, 0, 2, 511 &(eeprom_buff[last_word - first_word])); 512 if (ret < 0) { 513 netdev_err(net, "Failed to read EEPROM at offset 0x%02x.\n", last_word); 514 goto free; 515 } 516 } 517 518 memcpy((u8 *)eeprom_buff + (eeprom->offset & 1), data, eeprom->len); 519 520 /* write data to EEPROM */ 521 ret = asix_write_cmd(dev, AX_CMD_WRITE_ENABLE, 0x0000, 0, 0, NULL); 522 if (ret < 0) { 523 netdev_err(net, "Failed to enable EEPROM write\n"); 524 goto free; 525 } 526 msleep(20); 527 528 for (i = first_word; i <= last_word; i++) { 529 netdev_dbg(net, "write to EEPROM at offset 0x%02x, data 0x%04x\n", 530 i, eeprom_buff[i - first_word]); 531 ret = asix_write_cmd(dev, AX_CMD_WRITE_EEPROM, i, 532 eeprom_buff[i - first_word], 0, NULL); 533 if (ret < 0) { 534 netdev_err(net, "Failed to write EEPROM at offset 0x%02x.\n", 535 i); 536 goto free; 537 } 538 msleep(20); 539 } 540 541 ret = asix_write_cmd(dev, AX_CMD_WRITE_DISABLE, 0x0000, 0, 0, NULL); 542 if (ret < 0) { 543 netdev_err(net, "Failed to disable EEPROM write\n"); 544 goto free; 545 } 546 547 ret = 0; 548 free: 549 kfree(eeprom_buff); 550 return ret; 551 } 552 553 void asix_get_drvinfo(struct net_device *net, struct ethtool_drvinfo *info) 554 { 555 /* Inherit standard device info */ 556 usbnet_get_drvinfo(net, info); 557 strlcpy(info->driver, DRIVER_NAME, sizeof(info->driver)); 558 strlcpy(info->version, DRIVER_VERSION, sizeof(info->version)); 559 info->eedump_len = AX_EEPROM_LEN; 560 } 561 562 int asix_set_mac_address(struct net_device *net, void *p) 563 { 564 struct usbnet *dev = netdev_priv(net); 565 struct asix_data *data = (struct asix_data *)&dev->data; 566 struct sockaddr *addr = p; 567 568 if (netif_running(net)) 569 return -EBUSY; 570 if (!is_valid_ether_addr(addr->sa_data)) 571 return -EADDRNOTAVAIL; 572 573 memcpy(net->dev_addr, addr->sa_data, ETH_ALEN); 574 575 /* We use the 20 byte dev->data 576 * for our 6 byte mac buffer 577 * to avoid allocating memory that 578 * is tricky to free later */ 579 memcpy(data->mac_addr, addr->sa_data, ETH_ALEN); 580 asix_write_cmd_async(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN, 581 data->mac_addr); 582 583 return 0; 584 } 585