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