if_usb.c revision f8e77caefea8940ee1fb09c9ebb0107ca2eadb72
1/** 2 * This file contains functions used in USB interface module. 3 */ 4#include <linux/delay.h> 5#include <linux/moduleparam.h> 6#include <linux/firmware.h> 7#include <linux/netdevice.h> 8#include <linux/usb.h> 9 10#ifdef CONFIG_OLPC 11#include <asm/olpc.h> 12#endif 13 14#define DRV_NAME "usb8xxx" 15 16#include "host.h" 17#include "decl.h" 18#include "defs.h" 19#include "dev.h" 20#include "cmd.h" 21#include "if_usb.h" 22 23#define INSANEDEBUG 0 24#define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0) 25 26#define MESSAGE_HEADER_LEN 4 27 28static char *lbs_fw_name = "usb8388.bin"; 29module_param_named(fw_name, lbs_fw_name, charp, 0644); 30 31static struct usb_device_id if_usb_table[] = { 32 /* Enter the device signature inside */ 33 { USB_DEVICE(0x1286, 0x2001) }, 34 { USB_DEVICE(0x05a3, 0x8388) }, 35 {} /* Terminating entry */ 36}; 37 38MODULE_DEVICE_TABLE(usb, if_usb_table); 39 40static void if_usb_receive(struct urb *urb); 41static void if_usb_receive_fwload(struct urb *urb); 42static int __if_usb_prog_firmware(struct if_usb_card *cardp, 43 const char *fwname, int cmd); 44static int if_usb_prog_firmware(struct if_usb_card *cardp, 45 const char *fwname, int cmd); 46static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type, 47 uint8_t *payload, uint16_t nb); 48static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, 49 uint16_t nb); 50static void if_usb_free(struct if_usb_card *cardp); 51static int if_usb_submit_rx_urb(struct if_usb_card *cardp); 52static int if_usb_reset_device(struct if_usb_card *cardp); 53 54/* sysfs hooks */ 55 56/** 57 * Set function to write firmware to device's persistent memory 58 */ 59static ssize_t if_usb_firmware_set(struct device *dev, 60 struct device_attribute *attr, const char *buf, size_t count) 61{ 62 struct lbs_private *priv = to_net_dev(dev)->priv; 63 struct if_usb_card *cardp = priv->card; 64 char fwname[FIRMWARE_NAME_MAX]; 65 int ret; 66 67 sscanf(buf, "%29s", fwname); /* FIRMWARE_NAME_MAX - 1 = 29 */ 68 ret = if_usb_prog_firmware(cardp, fwname, BOOT_CMD_UPDATE_FW); 69 if (ret == 0) 70 return count; 71 72 return ret; 73} 74 75/** 76 * lbs_flash_fw attribute to be exported per ethX interface through sysfs 77 * (/sys/class/net/ethX/lbs_flash_fw). Use this like so to write firmware to 78 * the device's persistent memory: 79 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_fw 80 */ 81static DEVICE_ATTR(lbs_flash_fw, 0200, NULL, if_usb_firmware_set); 82 83/** 84 * Set function to write firmware to device's persistent memory 85 */ 86static ssize_t if_usb_boot2_set(struct device *dev, 87 struct device_attribute *attr, const char *buf, size_t count) 88{ 89 struct lbs_private *priv = to_net_dev(dev)->priv; 90 struct if_usb_card *cardp = priv->card; 91 char fwname[FIRMWARE_NAME_MAX]; 92 int ret; 93 94 sscanf(buf, "%29s", fwname); /* FIRMWARE_NAME_MAX - 1 = 29 */ 95 ret = if_usb_prog_firmware(cardp, fwname, BOOT_CMD_UPDATE_BOOT2); 96 if (ret == 0) 97 return count; 98 99 return ret; 100} 101 102/** 103 * lbs_flash_boot2 attribute to be exported per ethX interface through sysfs 104 * (/sys/class/net/ethX/lbs_flash_boot2). Use this like so to write firmware 105 * to the device's persistent memory: 106 * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_boot2 107 */ 108static DEVICE_ATTR(lbs_flash_boot2, 0200, NULL, if_usb_boot2_set); 109 110/** 111 * @brief call back function to handle the status of the URB 112 * @param urb pointer to urb structure 113 * @return N/A 114 */ 115static void if_usb_write_bulk_callback(struct urb *urb) 116{ 117 struct if_usb_card *cardp = (struct if_usb_card *) urb->context; 118 119 /* handle the transmission complete validations */ 120 121 if (urb->status == 0) { 122 struct lbs_private *priv = cardp->priv; 123 124 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n"); 125 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n", 126 urb->actual_length); 127 128 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not 129 * passed up to the lbs level. 130 */ 131 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT) 132 lbs_host_to_card_done(priv); 133 } else { 134 /* print the failure status number for debug */ 135 lbs_pr_info("URB in failure status: %d\n", urb->status); 136 } 137 138 return; 139} 140 141/** 142 * @brief free tx/rx urb, skb and rx buffer 143 * @param cardp pointer if_usb_card 144 * @return N/A 145 */ 146static void if_usb_free(struct if_usb_card *cardp) 147{ 148 lbs_deb_enter(LBS_DEB_USB); 149 150 /* Unlink tx & rx urb */ 151 usb_kill_urb(cardp->tx_urb); 152 usb_kill_urb(cardp->rx_urb); 153 154 usb_free_urb(cardp->tx_urb); 155 cardp->tx_urb = NULL; 156 157 usb_free_urb(cardp->rx_urb); 158 cardp->rx_urb = NULL; 159 160 kfree(cardp->ep_out_buf); 161 cardp->ep_out_buf = NULL; 162 163 lbs_deb_leave(LBS_DEB_USB); 164} 165 166static void if_usb_setup_firmware(struct lbs_private *priv) 167{ 168 struct if_usb_card *cardp = priv->card; 169 struct cmd_ds_set_boot2_ver b2_cmd; 170 struct cmd_ds_802_11_fw_wake_method wake_method; 171 172 b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd)); 173 b2_cmd.action = 0; 174 b2_cmd.version = cardp->boot2_version; 175 176 if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd)) 177 lbs_deb_usb("Setting boot2 version failed\n"); 178 179 priv->wol_gpio = 2; /* Wake via GPIO2... */ 180 priv->wol_gap = 20; /* ... after 20ms */ 181 lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA); 182 183 wake_method.hdr.size = cpu_to_le16(sizeof(wake_method)); 184 wake_method.action = cpu_to_le16(CMD_ACT_GET); 185 if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) { 186 lbs_pr_info("Firmware does not seem to support PS mode\n"); 187 } else { 188 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) { 189 lbs_deb_usb("Firmware seems to support PS with wake-via-command\n"); 190 priv->ps_supported = 1; 191 } else { 192 /* The versions which boot up this way don't seem to 193 work even if we set it to the command interrupt */ 194 lbs_pr_info("Firmware doesn't wake via command interrupt; disabling PS mode\n"); 195 } 196 } 197} 198 199static void if_usb_fw_timeo(unsigned long priv) 200{ 201 struct if_usb_card *cardp = (void *)priv; 202 203 if (cardp->fwdnldover) { 204 lbs_deb_usb("Download complete, no event. Assuming success\n"); 205 } else { 206 lbs_pr_err("Download timed out\n"); 207 cardp->surprise_removed = 1; 208 } 209 wake_up(&cardp->fw_wq); 210} 211 212#ifdef CONFIG_OLPC 213static void if_usb_reset_olpc_card(struct lbs_private *priv) 214{ 215 printk(KERN_CRIT "Resetting OLPC wireless via EC...\n"); 216 olpc_ec_cmd(0x25, NULL, 0, NULL, 0); 217} 218#endif 219 220/** 221 * @brief sets the configuration values 222 * @param ifnum interface number 223 * @param id pointer to usb_device_id 224 * @return 0 on success, error code on failure 225 */ 226static int if_usb_probe(struct usb_interface *intf, 227 const struct usb_device_id *id) 228{ 229 struct usb_device *udev; 230 struct usb_host_interface *iface_desc; 231 struct usb_endpoint_descriptor *endpoint; 232 struct lbs_private *priv; 233 struct if_usb_card *cardp; 234 int i; 235 236 udev = interface_to_usbdev(intf); 237 238 cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL); 239 if (!cardp) { 240 lbs_pr_err("Out of memory allocating private data.\n"); 241 goto error; 242 } 243 244 setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp); 245 init_waitqueue_head(&cardp->fw_wq); 246 247 cardp->udev = udev; 248 iface_desc = intf->cur_altsetting; 249 250 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X" 251 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n", 252 le16_to_cpu(udev->descriptor.bcdUSB), 253 udev->descriptor.bDeviceClass, 254 udev->descriptor.bDeviceSubClass, 255 udev->descriptor.bDeviceProtocol); 256 257 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { 258 endpoint = &iface_desc->endpoint[i].desc; 259 if (usb_endpoint_is_bulk_in(endpoint)) { 260 cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize); 261 cardp->ep_in = usb_endpoint_num(endpoint); 262 263 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in); 264 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size); 265 266 } else if (usb_endpoint_is_bulk_out(endpoint)) { 267 cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize); 268 cardp->ep_out = usb_endpoint_num(endpoint); 269 270 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out); 271 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size); 272 } 273 } 274 if (!cardp->ep_out_size || !cardp->ep_in_size) { 275 lbs_deb_usbd(&udev->dev, "Endpoints not found\n"); 276 goto dealloc; 277 } 278 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) { 279 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n"); 280 goto dealloc; 281 } 282 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) { 283 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n"); 284 goto dealloc; 285 } 286 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL); 287 if (!cardp->ep_out_buf) { 288 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n"); 289 goto dealloc; 290 } 291 292 /* Upload firmware */ 293 if (__if_usb_prog_firmware(cardp, lbs_fw_name, BOOT_CMD_FW_BY_USB)) { 294 lbs_deb_usbd(&udev->dev, "FW upload failed\n"); 295 goto err_prog_firmware; 296 } 297 298 if (!(priv = lbs_add_card(cardp, &udev->dev))) 299 goto err_prog_firmware; 300 301 cardp->priv = priv; 302 cardp->priv->fw_ready = 1; 303 304 priv->hw_host_to_card = if_usb_host_to_card; 305#ifdef CONFIG_OLPC 306 if (machine_is_olpc()) 307 priv->reset_card = if_usb_reset_olpc_card; 308#endif 309 310 cardp->boot2_version = udev->descriptor.bcdDevice; 311 312 if_usb_submit_rx_urb(cardp); 313 314 if (lbs_start_card(priv)) 315 goto err_start_card; 316 317 if_usb_setup_firmware(priv); 318 319 usb_get_dev(udev); 320 usb_set_intfdata(intf, cardp); 321 322 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_fw)) 323 lbs_pr_err("cannot register lbs_flash_fw attribute\n"); 324 325 if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2)) 326 lbs_pr_err("cannot register lbs_flash_boot2 attribute\n"); 327 328 return 0; 329 330err_start_card: 331 lbs_remove_card(priv); 332err_prog_firmware: 333 if_usb_reset_device(cardp); 334dealloc: 335 if_usb_free(cardp); 336 337error: 338 return -ENOMEM; 339} 340 341/** 342 * @brief free resource and cleanup 343 * @param intf USB interface structure 344 * @return N/A 345 */ 346static void if_usb_disconnect(struct usb_interface *intf) 347{ 348 struct if_usb_card *cardp = usb_get_intfdata(intf); 349 struct lbs_private *priv = (struct lbs_private *) cardp->priv; 350 351 lbs_deb_enter(LBS_DEB_MAIN); 352 353 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2); 354 device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_fw); 355 356 cardp->surprise_removed = 1; 357 358 if (priv) { 359 priv->surpriseremoved = 1; 360 lbs_stop_card(priv); 361 lbs_remove_card(priv); 362 } 363 364 /* Unlink and free urb */ 365 if_usb_free(cardp); 366 367 usb_set_intfdata(intf, NULL); 368 usb_put_dev(interface_to_usbdev(intf)); 369 370 lbs_deb_leave(LBS_DEB_MAIN); 371} 372 373/** 374 * @brief This function download FW 375 * @param priv pointer to struct lbs_private 376 * @return 0 377 */ 378static int if_usb_send_fw_pkt(struct if_usb_card *cardp) 379{ 380 struct fwdata *fwdata = cardp->ep_out_buf; 381 const uint8_t *firmware = cardp->fw->data; 382 383 /* If we got a CRC failure on the last block, back 384 up and retry it */ 385 if (!cardp->CRC_OK) { 386 cardp->totalbytes = cardp->fwlastblksent; 387 cardp->fwseqnum--; 388 } 389 390 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n", 391 cardp->totalbytes); 392 393 /* struct fwdata (which we sent to the card) has an 394 extra __le32 field in between the header and the data, 395 which is not in the struct fwheader in the actual 396 firmware binary. Insert the seqnum in the middle... */ 397 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes], 398 sizeof(struct fwheader)); 399 400 cardp->fwlastblksent = cardp->totalbytes; 401 cardp->totalbytes += sizeof(struct fwheader); 402 403 memcpy(fwdata->data, &firmware[cardp->totalbytes], 404 le32_to_cpu(fwdata->hdr.datalength)); 405 406 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n", 407 le32_to_cpu(fwdata->hdr.datalength)); 408 409 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum); 410 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength); 411 412 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) + 413 le32_to_cpu(fwdata->hdr.datalength)); 414 415 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) { 416 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n"); 417 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n", 418 cardp->fwseqnum, cardp->totalbytes); 419 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) { 420 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n"); 421 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n"); 422 423 cardp->fwfinalblk = 1; 424 } 425 426 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n", 427 cardp->totalbytes); 428 429 return 0; 430} 431 432static int if_usb_reset_device(struct if_usb_card *cardp) 433{ 434 struct cmd_ds_command *cmd = cardp->ep_out_buf + 4; 435 int ret; 436 437 lbs_deb_enter(LBS_DEB_USB); 438 439 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST); 440 441 cmd->command = cpu_to_le16(CMD_802_11_RESET); 442 cmd->size = cpu_to_le16(sizeof(struct cmd_header)); 443 cmd->result = cpu_to_le16(0); 444 cmd->seqnum = cpu_to_le16(0x5a5a); 445 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header)); 446 447 msleep(100); 448 ret = usb_reset_device(cardp->udev); 449 msleep(100); 450 451#ifdef CONFIG_OLPC 452 if (ret && machine_is_olpc()) 453 if_usb_reset_olpc_card(NULL); 454#endif 455 456 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret); 457 458 return ret; 459} 460 461/** 462 * @brief This function transfer the data to the device. 463 * @param priv pointer to struct lbs_private 464 * @param payload pointer to payload data 465 * @param nb data length 466 * @return 0 or -1 467 */ 468static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb) 469{ 470 int ret = -1; 471 472 /* check if device is removed */ 473 if (cardp->surprise_removed) { 474 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n"); 475 goto tx_ret; 476 } 477 478 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev, 479 usb_sndbulkpipe(cardp->udev, 480 cardp->ep_out), 481 payload, nb, if_usb_write_bulk_callback, cardp); 482 483 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET; 484 485 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) { 486 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret); 487 ret = -1; 488 } else { 489 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n"); 490 ret = 0; 491 } 492 493tx_ret: 494 return ret; 495} 496 497static int __if_usb_submit_rx_urb(struct if_usb_card *cardp, 498 void (*callbackfn)(struct urb *urb)) 499{ 500 struct sk_buff *skb; 501 int ret = -1; 502 503 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) { 504 lbs_pr_err("No free skb\n"); 505 goto rx_ret; 506 } 507 508 cardp->rx_skb = skb; 509 510 /* Fill the receive configuration URB and initialise the Rx call back */ 511 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev, 512 usb_rcvbulkpipe(cardp->udev, cardp->ep_in), 513 (void *) (skb->tail + (size_t) IPFIELD_ALIGN_OFFSET), 514 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn, 515 cardp); 516 517 cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET; 518 519 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb); 520 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) { 521 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret); 522 kfree_skb(skb); 523 cardp->rx_skb = NULL; 524 ret = -1; 525 } else { 526 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n"); 527 ret = 0; 528 } 529 530rx_ret: 531 return ret; 532} 533 534static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp) 535{ 536 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload); 537} 538 539static int if_usb_submit_rx_urb(struct if_usb_card *cardp) 540{ 541 return __if_usb_submit_rx_urb(cardp, &if_usb_receive); 542} 543 544static void if_usb_receive_fwload(struct urb *urb) 545{ 546 struct if_usb_card *cardp = urb->context; 547 struct sk_buff *skb = cardp->rx_skb; 548 struct fwsyncheader *syncfwheader; 549 struct bootcmdresp bootcmdresp; 550 551 if (urb->status) { 552 lbs_deb_usbd(&cardp->udev->dev, 553 "URB status is failed during fw load\n"); 554 kfree_skb(skb); 555 return; 556 } 557 558 if (cardp->fwdnldover) { 559 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET); 560 561 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) && 562 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) { 563 lbs_pr_info("Firmware ready event received\n"); 564 wake_up(&cardp->fw_wq); 565 } else { 566 lbs_deb_usb("Waiting for confirmation; got %x %x\n", 567 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1])); 568 if_usb_submit_rx_urb_fwload(cardp); 569 } 570 kfree_skb(skb); 571 return; 572 } 573 if (cardp->bootcmdresp <= 0) { 574 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET, 575 sizeof(bootcmdresp)); 576 577 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) { 578 kfree_skb(skb); 579 if_usb_submit_rx_urb_fwload(cardp); 580 cardp->bootcmdresp = BOOT_CMD_RESP_OK; 581 lbs_deb_usbd(&cardp->udev->dev, 582 "Received valid boot command response\n"); 583 return; 584 } 585 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) { 586 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) || 587 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) || 588 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) { 589 if (!cardp->bootcmdresp) 590 lbs_pr_info("Firmware already seems alive; resetting\n"); 591 cardp->bootcmdresp = -1; 592 } else { 593 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n", 594 le32_to_cpu(bootcmdresp.magic)); 595 } 596 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) && 597 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) && 598 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) { 599 lbs_pr_info("boot cmd response cmd_tag error (%d)\n", 600 bootcmdresp.cmd); 601 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) { 602 lbs_pr_info("boot cmd response result error (%d)\n", 603 bootcmdresp.result); 604 } else { 605 cardp->bootcmdresp = 1; 606 lbs_deb_usbd(&cardp->udev->dev, 607 "Received valid boot command response\n"); 608 } 609 kfree_skb(skb); 610 if_usb_submit_rx_urb_fwload(cardp); 611 return; 612 } 613 614 syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC); 615 if (!syncfwheader) { 616 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n"); 617 kfree_skb(skb); 618 return; 619 } 620 621 memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET, 622 sizeof(struct fwsyncheader)); 623 624 if (!syncfwheader->cmd) { 625 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n"); 626 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n", 627 le32_to_cpu(syncfwheader->seqnum)); 628 cardp->CRC_OK = 1; 629 } else { 630 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n"); 631 cardp->CRC_OK = 0; 632 } 633 634 kfree_skb(skb); 635 636 /* Give device 5s to either write firmware to its RAM or eeprom */ 637 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5)); 638 639 if (cardp->fwfinalblk) { 640 cardp->fwdnldover = 1; 641 goto exit; 642 } 643 644 if_usb_send_fw_pkt(cardp); 645 646 exit: 647 if_usb_submit_rx_urb_fwload(cardp); 648 649 kfree(syncfwheader); 650 651 return; 652} 653 654#define MRVDRV_MIN_PKT_LEN 30 655 656static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb, 657 struct if_usb_card *cardp, 658 struct lbs_private *priv) 659{ 660 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN 661 || recvlength < MRVDRV_MIN_PKT_LEN) { 662 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n"); 663 kfree_skb(skb); 664 return; 665 } 666 667 skb_reserve(skb, IPFIELD_ALIGN_OFFSET); 668 skb_put(skb, recvlength); 669 skb_pull(skb, MESSAGE_HEADER_LEN); 670 671 lbs_process_rxed_packet(priv, skb); 672} 673 674static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff, 675 struct sk_buff *skb, 676 struct if_usb_card *cardp, 677 struct lbs_private *priv) 678{ 679 u8 i; 680 681 if (recvlength > LBS_CMD_BUFFER_SIZE) { 682 lbs_deb_usbd(&cardp->udev->dev, 683 "The receive buffer is too large\n"); 684 kfree_skb(skb); 685 return; 686 } 687 688 if (!in_interrupt()) 689 BUG(); 690 691 spin_lock(&priv->driver_lock); 692 693 i = (priv->resp_idx == 0) ? 1 : 0; 694 BUG_ON(priv->resp_len[i]); 695 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN); 696 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN, 697 priv->resp_len[i]); 698 kfree_skb(skb); 699 lbs_notify_command_response(priv, i); 700 701 spin_unlock(&priv->driver_lock); 702 703 lbs_deb_usbd(&cardp->udev->dev, 704 "Wake up main thread to handle cmd response\n"); 705} 706 707/** 708 * @brief This function reads of the packet into the upload buff, 709 * wake up the main thread and initialise the Rx callack. 710 * 711 * @param urb pointer to struct urb 712 * @return N/A 713 */ 714static void if_usb_receive(struct urb *urb) 715{ 716 struct if_usb_card *cardp = urb->context; 717 struct sk_buff *skb = cardp->rx_skb; 718 struct lbs_private *priv = cardp->priv; 719 int recvlength = urb->actual_length; 720 uint8_t *recvbuff = NULL; 721 uint32_t recvtype = 0; 722 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET); 723 uint32_t event; 724 725 lbs_deb_enter(LBS_DEB_USB); 726 727 if (recvlength) { 728 if (urb->status) { 729 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n", 730 urb->status); 731 kfree_skb(skb); 732 goto setup_for_next; 733 } 734 735 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET; 736 recvtype = le32_to_cpu(pkt[0]); 737 lbs_deb_usbd(&cardp->udev->dev, 738 "Recv length = 0x%x, Recv type = 0x%X\n", 739 recvlength, recvtype); 740 } else if (urb->status) { 741 kfree_skb(skb); 742 goto rx_exit; 743 } 744 745 switch (recvtype) { 746 case CMD_TYPE_DATA: 747 process_cmdtypedata(recvlength, skb, cardp, priv); 748 break; 749 750 case CMD_TYPE_REQUEST: 751 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv); 752 break; 753 754 case CMD_TYPE_INDICATION: 755 /* Event handling */ 756 event = le32_to_cpu(pkt[1]); 757 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event); 758 kfree_skb(skb); 759 760 /* Icky undocumented magic special case */ 761 if (event & 0xffff0000) { 762 u32 trycount = (event & 0xffff0000) >> 16; 763 764 lbs_send_tx_feedback(priv, trycount); 765 } else 766 lbs_queue_event(priv, event & 0xFF); 767 break; 768 769 default: 770 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n", 771 recvtype); 772 kfree_skb(skb); 773 break; 774 } 775 776setup_for_next: 777 if_usb_submit_rx_urb(cardp); 778rx_exit: 779 lbs_deb_leave(LBS_DEB_USB); 780} 781 782/** 783 * @brief This function downloads data to FW 784 * @param priv pointer to struct lbs_private structure 785 * @param type type of data 786 * @param buf pointer to data buffer 787 * @param len number of bytes 788 * @return 0 or -1 789 */ 790static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type, 791 uint8_t *payload, uint16_t nb) 792{ 793 struct if_usb_card *cardp = priv->card; 794 795 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type); 796 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb); 797 798 if (type == MVMS_CMD) { 799 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST); 800 priv->dnld_sent = DNLD_CMD_SENT; 801 } else { 802 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA); 803 priv->dnld_sent = DNLD_DATA_SENT; 804 } 805 806 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb); 807 808 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN); 809} 810 811/** 812 * @brief This function issues Boot command to the Boot2 code 813 * @param ivalue 1:Boot from FW by USB-Download 814 * 2:Boot from FW in EEPROM 815 * @return 0 816 */ 817static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue) 818{ 819 struct bootcmd *bootcmd = cardp->ep_out_buf; 820 821 /* Prepare command */ 822 bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER); 823 bootcmd->cmd = ivalue; 824 memset(bootcmd->pad, 0, sizeof(bootcmd->pad)); 825 826 /* Issue command */ 827 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd)); 828 829 return 0; 830} 831 832 833/** 834 * @brief This function checks the validity of Boot2/FW image. 835 * 836 * @param data pointer to image 837 * len image length 838 * @return 0 or -1 839 */ 840static int check_fwfile_format(const uint8_t *data, uint32_t totlen) 841{ 842 uint32_t bincmd, exit; 843 uint32_t blksize, offset, len; 844 int ret; 845 846 ret = 1; 847 exit = len = 0; 848 849 do { 850 struct fwheader *fwh = (void *)data; 851 852 bincmd = le32_to_cpu(fwh->dnldcmd); 853 blksize = le32_to_cpu(fwh->datalength); 854 switch (bincmd) { 855 case FW_HAS_DATA_TO_RECV: 856 offset = sizeof(struct fwheader) + blksize; 857 data += offset; 858 len += offset; 859 if (len >= totlen) 860 exit = 1; 861 break; 862 case FW_HAS_LAST_BLOCK: 863 exit = 1; 864 ret = 0; 865 break; 866 default: 867 exit = 1; 868 break; 869 } 870 } while (!exit); 871 872 if (ret) 873 lbs_pr_err("firmware file format check FAIL\n"); 874 else 875 lbs_deb_fw("firmware file format check PASS\n"); 876 877 return ret; 878} 879 880 881/** 882* @brief This function programs the firmware subject to cmd 883* 884* @param cardp the if_usb_card descriptor 885* fwname firmware or boot2 image file name 886* cmd either BOOT_CMD_FW_BY_USB, BOOT_CMD_UPDATE_FW, 887* or BOOT_CMD_UPDATE_BOOT2. 888* @return 0 or error code 889*/ 890static int if_usb_prog_firmware(struct if_usb_card *cardp, 891 const char *fwname, int cmd) 892{ 893 struct lbs_private *priv = cardp->priv; 894 unsigned long flags, caps; 895 int ret; 896 897 caps = priv->fwcapinfo; 898 if (((cmd == BOOT_CMD_UPDATE_FW) && !(caps & FW_CAPINFO_FIRMWARE_UPGRADE)) || 899 ((cmd == BOOT_CMD_UPDATE_BOOT2) && !(caps & FW_CAPINFO_BOOT2_UPGRADE))) 900 return -EOPNOTSUPP; 901 902 /* Ensure main thread is idle. */ 903 spin_lock_irqsave(&priv->driver_lock, flags); 904 while (priv->cur_cmd != NULL || priv->dnld_sent != DNLD_RES_RECEIVED) { 905 spin_unlock_irqrestore(&priv->driver_lock, flags); 906 if (wait_event_interruptible(priv->waitq, 907 (priv->cur_cmd == NULL && 908 priv->dnld_sent == DNLD_RES_RECEIVED))) { 909 return -ERESTARTSYS; 910 } 911 spin_lock_irqsave(&priv->driver_lock, flags); 912 } 913 priv->dnld_sent = DNLD_BOOTCMD_SENT; 914 spin_unlock_irqrestore(&priv->driver_lock, flags); 915 916 ret = __if_usb_prog_firmware(cardp, fwname, cmd); 917 918 spin_lock_irqsave(&priv->driver_lock, flags); 919 priv->dnld_sent = DNLD_RES_RECEIVED; 920 spin_unlock_irqrestore(&priv->driver_lock, flags); 921 922 wake_up_interruptible(&priv->waitq); 923 924 return ret; 925} 926 927static int __if_usb_prog_firmware(struct if_usb_card *cardp, 928 const char *fwname, int cmd) 929{ 930 int i = 0; 931 static int reset_count = 10; 932 int ret = 0; 933 934 lbs_deb_enter(LBS_DEB_USB); 935 936 ret = request_firmware(&cardp->fw, fwname, &cardp->udev->dev); 937 if (ret < 0) { 938 lbs_pr_err("request_firmware() failed with %#x\n", ret); 939 lbs_pr_err("firmware %s not found\n", fwname); 940 goto done; 941 } 942 943 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) { 944 ret = -EINVAL; 945 goto release_fw; 946 } 947 948 /* Cancel any pending usb business */ 949 usb_kill_urb(cardp->rx_urb); 950 usb_kill_urb(cardp->tx_urb); 951 952 cardp->fwlastblksent = 0; 953 cardp->fwdnldover = 0; 954 cardp->totalbytes = 0; 955 cardp->fwfinalblk = 0; 956 cardp->bootcmdresp = 0; 957 958restart: 959 if (if_usb_submit_rx_urb_fwload(cardp) < 0) { 960 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n"); 961 ret = -EIO; 962 goto release_fw; 963 } 964 965 cardp->bootcmdresp = 0; 966 do { 967 int j = 0; 968 i++; 969 if_usb_issue_boot_command(cardp, cmd); 970 /* wait for command response */ 971 do { 972 j++; 973 msleep_interruptible(100); 974 } while (cardp->bootcmdresp == 0 && j < 10); 975 } while (cardp->bootcmdresp == 0 && i < 5); 976 977 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) { 978 /* Return to normal operation */ 979 ret = -EOPNOTSUPP; 980 usb_kill_urb(cardp->rx_urb); 981 usb_kill_urb(cardp->tx_urb); 982 if (if_usb_submit_rx_urb(cardp) < 0) 983 ret = -EIO; 984 goto release_fw; 985 } else if (cardp->bootcmdresp <= 0) { 986 if (--reset_count >= 0) { 987 if_usb_reset_device(cardp); 988 goto restart; 989 } 990 ret = -EIO; 991 goto release_fw; 992 } 993 994 i = 0; 995 996 cardp->totalbytes = 0; 997 cardp->fwlastblksent = 0; 998 cardp->CRC_OK = 1; 999 cardp->fwdnldover = 0; 1000 cardp->fwseqnum = -1; 1001 cardp->totalbytes = 0; 1002 cardp->fwfinalblk = 0; 1003 1004 /* Send the first firmware packet... */ 1005 if_usb_send_fw_pkt(cardp); 1006 1007 /* ... and wait for the process to complete */ 1008 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover); 1009 1010 del_timer_sync(&cardp->fw_timeout); 1011 usb_kill_urb(cardp->rx_urb); 1012 1013 if (!cardp->fwdnldover) { 1014 lbs_pr_info("failed to load fw, resetting device!\n"); 1015 if (--reset_count >= 0) { 1016 if_usb_reset_device(cardp); 1017 goto restart; 1018 } 1019 1020 lbs_pr_info("FW download failure, time = %d ms\n", i * 100); 1021 ret = -EIO; 1022 goto release_fw; 1023 } 1024 1025 release_fw: 1026 release_firmware(cardp->fw); 1027 cardp->fw = NULL; 1028 1029 done: 1030 lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret); 1031 return ret; 1032} 1033 1034 1035#ifdef CONFIG_PM 1036static int if_usb_suspend(struct usb_interface *intf, pm_message_t message) 1037{ 1038 struct if_usb_card *cardp = usb_get_intfdata(intf); 1039 struct lbs_private *priv = cardp->priv; 1040 int ret; 1041 1042 lbs_deb_enter(LBS_DEB_USB); 1043 1044 if (priv->psstate != PS_STATE_FULL_POWER) 1045 return -1; 1046 1047 ret = lbs_suspend(priv); 1048 if (ret) 1049 goto out; 1050 1051 /* Unlink tx & rx urb */ 1052 usb_kill_urb(cardp->tx_urb); 1053 usb_kill_urb(cardp->rx_urb); 1054 1055 out: 1056 lbs_deb_leave(LBS_DEB_USB); 1057 return ret; 1058} 1059 1060static int if_usb_resume(struct usb_interface *intf) 1061{ 1062 struct if_usb_card *cardp = usb_get_intfdata(intf); 1063 struct lbs_private *priv = cardp->priv; 1064 1065 lbs_deb_enter(LBS_DEB_USB); 1066 1067 if_usb_submit_rx_urb(cardp); 1068 1069 lbs_resume(priv); 1070 1071 lbs_deb_leave(LBS_DEB_USB); 1072 return 0; 1073} 1074#else 1075#define if_usb_suspend NULL 1076#define if_usb_resume NULL 1077#endif 1078 1079static struct usb_driver if_usb_driver = { 1080 .name = DRV_NAME, 1081 .probe = if_usb_probe, 1082 .disconnect = if_usb_disconnect, 1083 .id_table = if_usb_table, 1084 .suspend = if_usb_suspend, 1085 .resume = if_usb_resume, 1086 .reset_resume = if_usb_resume, 1087}; 1088 1089static int __init if_usb_init_module(void) 1090{ 1091 int ret = 0; 1092 1093 lbs_deb_enter(LBS_DEB_MAIN); 1094 1095 ret = usb_register(&if_usb_driver); 1096 1097 lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret); 1098 return ret; 1099} 1100 1101static void __exit if_usb_exit_module(void) 1102{ 1103 lbs_deb_enter(LBS_DEB_MAIN); 1104 1105 usb_deregister(&if_usb_driver); 1106 1107 lbs_deb_leave(LBS_DEB_MAIN); 1108} 1109 1110module_init(if_usb_init_module); 1111module_exit(if_usb_exit_module); 1112 1113MODULE_DESCRIPTION("8388 USB WLAN Driver"); 1114MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc."); 1115MODULE_LICENSE("GPL"); 1116