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