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_anchored_urbs(&cardp->tx_submitted); 118 usb_kill_anchored_urbs(&cardp->rx_submitted); 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 = timer_container_of(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_endpoint_descriptor *ep_in, *ep_out; 197 struct usb_device *udev; 198 struct usb_host_interface *iface_desc; 199 struct lbs_private *priv; 200 struct if_usb_card *cardp; 201 int r = -ENOMEM; 202 203 udev = interface_to_usbdev(intf); 204 205 cardp = kzalloc_obj(struct if_usb_card); 206 if (!cardp) 207 goto error; 208 209 timer_setup(&cardp->fw_timeout, if_usb_fw_timeo, 0); 210 init_waitqueue_head(&cardp->fw_wq); 211 212 cardp->udev = udev; 213 cardp->model = (uint32_t) id->driver_info; 214 iface_desc = intf->cur_altsetting; 215 216 lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X" 217 " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n", 218 le16_to_cpu(udev->descriptor.bcdUSB), 219 udev->descriptor.bDeviceClass, 220 udev->descriptor.bDeviceSubClass, 221 udev->descriptor.bDeviceProtocol); 222 223 init_usb_anchor(&cardp->rx_submitted); 224 init_usb_anchor(&cardp->tx_submitted); 225 226 if (usb_find_common_endpoints_reverse(iface_desc, &ep_in, &ep_out, NULL, NULL)) { 227 lbs_deb_usbd(&udev->dev, "Endpoints not found\n"); 228 goto dealloc; 229 } 230 231 cardp->ep_in_size = usb_endpoint_maxp(ep_in); 232 cardp->ep_in = usb_endpoint_num(ep_in); 233 234 lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in); 235 lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size); 236 237 cardp->ep_out_size = usb_endpoint_maxp(ep_out); 238 cardp->ep_out = usb_endpoint_num(ep_out); 239 240 lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out); 241 lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size); 242 243 if (!cardp->ep_out_size || !cardp->ep_in_size) { 244 lbs_deb_usbd(&udev->dev, "Endpoints not valid\n"); 245 goto dealloc; 246 } 247 if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) { 248 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n"); 249 goto dealloc; 250 } 251 if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) { 252 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n"); 253 goto dealloc; 254 } 255 cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL); 256 if (!cardp->ep_out_buf) { 257 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n"); 258 goto dealloc; 259 } 260 261 priv = lbs_add_card(cardp, &intf->dev); 262 if (IS_ERR(priv)) { 263 r = PTR_ERR(priv); 264 goto err_add_card; 265 } 266 267 cardp->priv = priv; 268 269 priv->hw_host_to_card = if_usb_host_to_card; 270 priv->enter_deep_sleep = NULL; 271 priv->exit_deep_sleep = NULL; 272 priv->reset_deep_sleep_wakeup = NULL; 273 priv->is_polling = false; 274 #ifdef CONFIG_OLPC 275 if (machine_is_olpc()) 276 priv->reset_card = if_usb_reset_olpc_card; 277 #endif 278 279 cardp->boot2_version = udev->descriptor.bcdDevice; 280 281 usb_set_intfdata(intf, cardp); 282 283 r = lbs_get_firmware_async(priv, &udev->dev, cardp->model, 284 fw_table, if_usb_prog_firmware); 285 if (r) 286 goto err_get_fw; 287 288 return 0; 289 290 err_get_fw: 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 } 325 326 /** 327 * if_usb_send_fw_pkt - download FW 328 * @cardp: pointer to &struct if_usb_card 329 * returns: 0 330 */ 331 static int if_usb_send_fw_pkt(struct if_usb_card *cardp) 332 { 333 struct fwdata *fwdata = cardp->ep_out_buf; 334 const uint8_t *firmware = cardp->fw->data; 335 336 /* If we got a CRC failure on the last block, back 337 up and retry it */ 338 if (!cardp->CRC_OK) { 339 cardp->totalbytes = cardp->fwlastblksent; 340 cardp->fwseqnum--; 341 } 342 343 lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n", 344 cardp->totalbytes); 345 346 /* struct fwdata (which we sent to the card) has an 347 extra __le32 field in between the header and the data, 348 which is not in the struct fwheader in the actual 349 firmware binary. Insert the seqnum in the middle... */ 350 memcpy(&fwdata->hdr, &firmware[cardp->totalbytes], 351 sizeof(struct fwheader)); 352 353 cardp->fwlastblksent = cardp->totalbytes; 354 cardp->totalbytes += sizeof(struct fwheader); 355 356 memcpy(fwdata->data, &firmware[cardp->totalbytes], 357 le32_to_cpu(fwdata->hdr.datalength)); 358 359 lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n", 360 le32_to_cpu(fwdata->hdr.datalength)); 361 362 fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum); 363 cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength); 364 365 usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) + 366 le32_to_cpu(fwdata->hdr.datalength)); 367 368 if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) { 369 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n"); 370 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n", 371 cardp->fwseqnum, cardp->totalbytes); 372 } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) { 373 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n"); 374 lbs_deb_usb2(&cardp->udev->dev, "Downloading FW JUMP BLOCK\n"); 375 376 cardp->fwfinalblk = 1; 377 } 378 379 lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n", 380 cardp->totalbytes); 381 382 return 0; 383 } 384 385 static int if_usb_reset_device(struct if_usb_card *cardp) 386 { 387 struct cmd_header *cmd = cardp->ep_out_buf + 4; 388 int ret; 389 390 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST); 391 392 cmd->command = cpu_to_le16(CMD_802_11_RESET); 393 cmd->size = cpu_to_le16(sizeof(cmd)); 394 cmd->result = cpu_to_le16(0); 395 cmd->seqnum = cpu_to_le16(0x5a5a); 396 usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header)); 397 398 msleep(100); 399 ret = usb_reset_device(cardp->udev); 400 msleep(100); 401 402 #ifdef CONFIG_OLPC 403 if (ret && machine_is_olpc()) 404 if_usb_reset_olpc_card(NULL); 405 #endif 406 407 return ret; 408 } 409 410 /** 411 * usb_tx_block - transfer the data to the device 412 * @cardp: pointer to &struct if_usb_card 413 * @payload: pointer to payload data 414 * @nb: data length 415 * returns: 0 for success or negative error code 416 */ 417 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb) 418 { 419 int ret; 420 421 /* check if device is removed */ 422 if (cardp->surprise_removed) { 423 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n"); 424 ret = -ENODEV; 425 goto tx_ret; 426 } 427 428 /* check if there are pending URBs */ 429 if (!usb_anchor_empty(&cardp->tx_submitted)) { 430 lbs_deb_usbd(&cardp->udev->dev, "%s failed: pending URB\n", __func__); 431 ret = -EBUSY; 432 goto tx_ret; 433 } 434 435 usb_fill_bulk_urb(cardp->tx_urb, cardp->udev, 436 usb_sndbulkpipe(cardp->udev, 437 cardp->ep_out), 438 payload, nb, if_usb_write_bulk_callback, cardp); 439 440 cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET; 441 442 usb_anchor_urb(cardp->tx_urb, &cardp->tx_submitted); 443 if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) { 444 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret); 445 usb_unanchor_urb(cardp->tx_urb); 446 } else { 447 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n"); 448 ret = 0; 449 } 450 451 tx_ret: 452 return ret; 453 } 454 455 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp, 456 void (*callbackfn)(struct urb *urb)) 457 { 458 struct sk_buff *skb; 459 int ret = -1; 460 461 if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) { 462 pr_err("No free skb\n"); 463 goto rx_ret; 464 } 465 466 cardp->rx_skb = skb; 467 468 /* Fill the receive configuration URB and initialise the Rx call back */ 469 usb_fill_bulk_urb(cardp->rx_urb, cardp->udev, 470 usb_rcvbulkpipe(cardp->udev, cardp->ep_in), 471 skb->data + IPFIELD_ALIGN_OFFSET, 472 MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn, 473 cardp); 474 475 lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb); 476 usb_anchor_urb(cardp->rx_urb, &cardp->rx_submitted); 477 if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) { 478 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret); 479 usb_unanchor_urb(cardp->rx_urb); 480 kfree_skb(skb); 481 cardp->rx_skb = NULL; 482 ret = -1; 483 } else { 484 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n"); 485 ret = 0; 486 } 487 488 rx_ret: 489 return ret; 490 } 491 492 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp) 493 { 494 return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload); 495 } 496 497 static int if_usb_submit_rx_urb(struct if_usb_card *cardp) 498 { 499 return __if_usb_submit_rx_urb(cardp, &if_usb_receive); 500 } 501 502 static void if_usb_receive_fwload(struct urb *urb) 503 { 504 struct if_usb_card *cardp = urb->context; 505 struct sk_buff *skb = cardp->rx_skb; 506 struct fwsyncheader *syncfwheader; 507 struct bootcmdresp bootcmdresp; 508 509 if (urb->status) { 510 lbs_deb_usbd(&cardp->udev->dev, 511 "URB status is failed during fw load\n"); 512 kfree_skb(skb); 513 return; 514 } 515 516 if (cardp->fwdnldover) { 517 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET); 518 519 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) && 520 tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) { 521 pr_info("Firmware ready event received\n"); 522 wake_up(&cardp->fw_wq); 523 } else { 524 lbs_deb_usb("Waiting for confirmation; got %x %x\n", 525 le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1])); 526 if_usb_submit_rx_urb_fwload(cardp); 527 } 528 kfree_skb(skb); 529 return; 530 } 531 if (cardp->bootcmdresp <= 0) { 532 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET, 533 sizeof(bootcmdresp)); 534 535 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) { 536 kfree_skb(skb); 537 if_usb_submit_rx_urb_fwload(cardp); 538 cardp->bootcmdresp = BOOT_CMD_RESP_OK; 539 lbs_deb_usbd(&cardp->udev->dev, 540 "Received valid boot command response\n"); 541 return; 542 } 543 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) { 544 if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) || 545 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) || 546 bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) { 547 if (!cardp->bootcmdresp) 548 pr_info("Firmware already seems alive; resetting\n"); 549 cardp->bootcmdresp = -1; 550 } else { 551 pr_info("boot cmd response wrong magic number (0x%x)\n", 552 le32_to_cpu(bootcmdresp.magic)); 553 } 554 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) && 555 (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) && 556 (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) { 557 pr_info("boot cmd response cmd_tag error (%d)\n", 558 bootcmdresp.cmd); 559 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) { 560 pr_info("boot cmd response result error (%d)\n", 561 bootcmdresp.result); 562 } else { 563 cardp->bootcmdresp = 1; 564 lbs_deb_usbd(&cardp->udev->dev, 565 "Received valid boot command response\n"); 566 } 567 kfree_skb(skb); 568 if_usb_submit_rx_urb_fwload(cardp); 569 return; 570 } 571 572 syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET, 573 sizeof(struct fwsyncheader), GFP_ATOMIC); 574 if (!syncfwheader) { 575 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n"); 576 kfree_skb(skb); 577 return; 578 } 579 580 if (!syncfwheader->cmd) { 581 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n"); 582 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n", 583 le32_to_cpu(syncfwheader->seqnum)); 584 cardp->CRC_OK = 1; 585 } else { 586 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n"); 587 cardp->CRC_OK = 0; 588 } 589 590 kfree_skb(skb); 591 592 /* Give device 5s to either write firmware to its RAM or eeprom */ 593 mod_timer(&cardp->fw_timeout, jiffies + (HZ*5)); 594 595 if (cardp->fwfinalblk) { 596 cardp->fwdnldover = 1; 597 goto exit; 598 } 599 600 if_usb_send_fw_pkt(cardp); 601 602 exit: 603 if_usb_submit_rx_urb_fwload(cardp); 604 605 kfree(syncfwheader); 606 } 607 608 #define MRVDRV_MIN_PKT_LEN 30 609 610 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb, 611 struct if_usb_card *cardp, 612 struct lbs_private *priv) 613 { 614 if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN 615 || recvlength < MRVDRV_MIN_PKT_LEN) { 616 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n"); 617 kfree_skb(skb); 618 return; 619 } 620 621 skb_reserve(skb, IPFIELD_ALIGN_OFFSET); 622 skb_put(skb, recvlength); 623 skb_pull(skb, MESSAGE_HEADER_LEN); 624 625 lbs_process_rxed_packet(priv, skb); 626 } 627 628 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff, 629 struct sk_buff *skb, 630 struct if_usb_card *cardp, 631 struct lbs_private *priv) 632 { 633 unsigned long flags; 634 u8 i; 635 636 if (recvlength > LBS_CMD_BUFFER_SIZE) { 637 lbs_deb_usbd(&cardp->udev->dev, 638 "The receive buffer is too large\n"); 639 kfree_skb(skb); 640 return; 641 } 642 643 spin_lock_irqsave(&priv->driver_lock, flags); 644 645 i = (priv->resp_idx == 0) ? 1 : 0; 646 BUG_ON(priv->resp_len[i]); 647 priv->resp_len[i] = (recvlength - MESSAGE_HEADER_LEN); 648 memcpy(priv->resp_buf[i], recvbuff + MESSAGE_HEADER_LEN, 649 priv->resp_len[i]); 650 dev_kfree_skb_irq(skb); 651 lbs_notify_command_response(priv, i); 652 653 spin_unlock_irqrestore(&priv->driver_lock, flags); 654 655 lbs_deb_usbd(&cardp->udev->dev, 656 "Wake up main thread to handle cmd response\n"); 657 } 658 659 /** 660 * if_usb_receive - read the packet into the upload buffer, 661 * wake up the main thread and initialise the Rx callack 662 * 663 * @urb: pointer to &struct urb 664 * returns: N/A 665 */ 666 static void if_usb_receive(struct urb *urb) 667 { 668 struct if_usb_card *cardp = urb->context; 669 struct sk_buff *skb = cardp->rx_skb; 670 struct lbs_private *priv = cardp->priv; 671 int recvlength = urb->actual_length; 672 uint8_t *recvbuff = NULL; 673 uint32_t recvtype = 0; 674 __le32 *pkt = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET); 675 uint32_t event; 676 677 if (recvlength) { 678 if (urb->status) { 679 lbs_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n", 680 urb->status); 681 kfree_skb(skb); 682 goto setup_for_next; 683 } 684 685 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET; 686 recvtype = le32_to_cpu(pkt[0]); 687 lbs_deb_usbd(&cardp->udev->dev, 688 "Recv length = 0x%x, Recv type = 0x%X\n", 689 recvlength, recvtype); 690 } else if (urb->status) { 691 kfree_skb(skb); 692 return; 693 } 694 695 switch (recvtype) { 696 case CMD_TYPE_DATA: 697 process_cmdtypedata(recvlength, skb, cardp, priv); 698 break; 699 700 case CMD_TYPE_REQUEST: 701 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv); 702 break; 703 704 case CMD_TYPE_INDICATION: 705 /* Event handling */ 706 event = le32_to_cpu(pkt[1]); 707 lbs_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n", event); 708 kfree_skb(skb); 709 710 /* Icky undocumented magic special case */ 711 if (event & 0xffff0000) { 712 u32 trycount = (event & 0xffff0000) >> 16; 713 714 lbs_send_tx_feedback(priv, trycount); 715 } else 716 lbs_queue_event(priv, event & 0xFF); 717 break; 718 719 default: 720 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n", 721 recvtype); 722 kfree_skb(skb); 723 break; 724 } 725 726 setup_for_next: 727 if_usb_submit_rx_urb(cardp); 728 } 729 730 /** 731 * if_usb_host_to_card - downloads data to FW 732 * @priv: pointer to &struct lbs_private structure 733 * @type: type of data 734 * @payload: pointer to data buffer 735 * @nb: number of bytes 736 * returns: 0 for success or negative error code 737 */ 738 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type, 739 uint8_t *payload, uint16_t nb) 740 { 741 struct if_usb_card *cardp = priv->card; 742 743 lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type); 744 lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb); 745 746 if (type == MVMS_CMD) { 747 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST); 748 priv->dnld_sent = DNLD_CMD_SENT; 749 } else { 750 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA); 751 priv->dnld_sent = DNLD_DATA_SENT; 752 } 753 754 memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb); 755 756 return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN); 757 } 758 759 /** 760 * if_usb_issue_boot_command - issues Boot command to the Boot2 code 761 * @cardp: pointer to &if_usb_card 762 * @ivalue: 1:Boot from FW by USB-Download 763 * 2:Boot from FW in EEPROM 764 * returns: 0 for success or negative error code 765 */ 766 static 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 * check_fwfile_format - check the validity of Boot2/FW image 784 * 785 * @data: pointer to image 786 * @totlen: image length 787 * returns: 0 (good) or 1 (failure) 788 */ 789 static int check_fwfile_format(const 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 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 static void if_usb_prog_firmware(struct lbs_private *priv, int ret, 830 const struct firmware *fw, 831 const struct firmware *unused) 832 { 833 struct if_usb_card *cardp = priv->card; 834 int i = 0; 835 static int reset_count = 10; 836 837 if (ret) { 838 pr_err("failed to find firmware (%d)\n", ret); 839 goto done; 840 } 841 842 cardp->fw = fw; 843 if (check_fwfile_format(cardp->fw->data, cardp->fw->size)) { 844 ret = -EINVAL; 845 goto done; 846 } 847 848 /* Cancel any pending usb business */ 849 usb_kill_anchored_urbs(&cardp->rx_submitted); 850 usb_kill_anchored_urbs(&cardp->tx_submitted); 851 852 cardp->fwlastblksent = 0; 853 cardp->fwdnldover = 0; 854 cardp->totalbytes = 0; 855 cardp->fwfinalblk = 0; 856 cardp->bootcmdresp = 0; 857 858 restart: 859 if (if_usb_submit_rx_urb_fwload(cardp) < 0) { 860 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n"); 861 ret = -EIO; 862 goto done; 863 } 864 865 cardp->bootcmdresp = 0; 866 do { 867 int j = 0; 868 i++; 869 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB); 870 /* wait for command response */ 871 do { 872 j++; 873 msleep_interruptible(100); 874 } while (cardp->bootcmdresp == 0 && j < 10); 875 } while (cardp->bootcmdresp == 0 && i < 5); 876 877 if (cardp->bootcmdresp == BOOT_CMD_RESP_NOT_SUPPORTED) { 878 /* Return to normal operation */ 879 ret = -EOPNOTSUPP; 880 usb_kill_anchored_urbs(&cardp->rx_submitted); 881 usb_kill_anchored_urbs(&cardp->tx_submitted); 882 if (if_usb_submit_rx_urb(cardp) < 0) 883 ret = -EIO; 884 goto done; 885 } else if (cardp->bootcmdresp <= 0) { 886 if (--reset_count >= 0) { 887 if_usb_reset_device(cardp); 888 goto restart; 889 } 890 ret = -EIO; 891 goto done; 892 } 893 894 i = 0; 895 896 cardp->totalbytes = 0; 897 cardp->fwlastblksent = 0; 898 cardp->CRC_OK = 1; 899 cardp->fwdnldover = 0; 900 cardp->fwseqnum = -1; 901 cardp->totalbytes = 0; 902 cardp->fwfinalblk = 0; 903 904 /* Send the first firmware packet... */ 905 if_usb_send_fw_pkt(cardp); 906 907 /* ... and wait for the process to complete */ 908 wait_event_interruptible(cardp->fw_wq, cardp->surprise_removed || cardp->fwdnldover); 909 910 timer_delete_sync(&cardp->fw_timeout); 911 usb_kill_anchored_urbs(&cardp->rx_submitted); 912 913 if (!cardp->fwdnldover) { 914 pr_info("failed to load fw, resetting device!\n"); 915 if (--reset_count >= 0) { 916 if_usb_reset_device(cardp); 917 goto restart; 918 } 919 920 pr_info("FW download failure, time = %d ms\n", i * 100); 921 ret = -EIO; 922 goto done; 923 } 924 925 cardp->priv->fw_ready = 1; 926 if_usb_submit_rx_urb(cardp); 927 928 if (lbs_start_card(priv)) 929 goto done; 930 931 if_usb_setup_firmware(priv); 932 933 /* 934 * EHS_REMOVE_WAKEUP is not supported on all versions of the firmware. 935 */ 936 priv->wol_criteria = EHS_REMOVE_WAKEUP; 937 if (lbs_host_sleep_cfg(priv, priv->wol_criteria, NULL)) 938 priv->ehs_remove_supported = false; 939 940 done: 941 cardp->fw = NULL; 942 } 943 944 945 #ifdef CONFIG_PM 946 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message) 947 { 948 struct if_usb_card *cardp = usb_get_intfdata(intf); 949 struct lbs_private *priv = cardp->priv; 950 int ret; 951 952 if (priv->psstate != PS_STATE_FULL_POWER) { 953 ret = -1; 954 goto out; 955 } 956 957 #ifdef CONFIG_OLPC 958 if (machine_is_olpc()) { 959 if (priv->wol_criteria == EHS_REMOVE_WAKEUP) 960 olpc_ec_wakeup_clear(EC_SCI_SRC_WLAN); 961 else 962 olpc_ec_wakeup_set(EC_SCI_SRC_WLAN); 963 } 964 #endif 965 966 ret = lbs_suspend(priv); 967 if (ret) 968 goto out; 969 970 /* Unlink tx & rx urb */ 971 usb_kill_anchored_urbs(&cardp->tx_submitted); 972 usb_kill_anchored_urbs(&cardp->rx_submitted); 973 974 out: 975 return ret; 976 } 977 978 static int if_usb_resume(struct usb_interface *intf) 979 { 980 struct if_usb_card *cardp = usb_get_intfdata(intf); 981 struct lbs_private *priv = cardp->priv; 982 983 if_usb_submit_rx_urb(cardp); 984 985 lbs_resume(priv); 986 987 return 0; 988 } 989 #else 990 #define if_usb_suspend NULL 991 #define if_usb_resume NULL 992 #endif 993 994 static struct usb_driver if_usb_driver = { 995 .name = DRV_NAME, 996 .probe = if_usb_probe, 997 .disconnect = if_usb_disconnect, 998 .id_table = if_usb_table, 999 .suspend = if_usb_suspend, 1000 .resume = if_usb_resume, 1001 .reset_resume = if_usb_resume, 1002 .disable_hub_initiated_lpm = 1, 1003 }; 1004 1005 module_usb_driver(if_usb_driver); 1006 1007 MODULE_DESCRIPTION("8388 USB WLAN Driver"); 1008 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc."); 1009 MODULE_LICENSE("GPL"); 1010