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