drivers/net/wireless/libertas/if_usb.c

   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/slab.h>
   9 #include <linux/usb.h>
  10
  11 #ifdef CONFIG_OLPC
  12 #include <asm/olpc.h>
  13 #endif
  14
  15 #define DRV_NAME "usb8xxx"
  16
  17 #include "host.h"
  18 #include "decl.h"
  19 #include "defs.h"
  20 #include "dev.h"
  21 #include "cmd.h"
  22 #include "if_usb.h"
  23
  24 #define INSANEDEBUG     0
  25 #define lbs_deb_usb2(...) do { if (INSANEDEBUG) lbs_deb_usbd(__VA_ARGS__); } while (0)
  26
  27 #define MESSAGE_HEADER_LEN      4
  28
  29 static char *lbs_fw_name = "usb8388.bin";
  30 module_param_named(fw_name, lbs_fw_name, charp, 0644);
  31
  32 MODULE_FIRMWARE("usb8388.bin");
  33
  34 static struct usb_device_id if_usb_table[] = {
  35         /* Enter the device signature inside */
  36         { USB_DEVICE(0x1286, 0x2001) },
  37         { USB_DEVICE(0x05a3, 0x8388) },
  38         {}      /* Terminating entry */
  39 };
  40
  41 MODULE_DEVICE_TABLE(usb, if_usb_table);
  42
  43 static void if_usb_receive(struct urb *urb);
  44 static void if_usb_receive_fwload(struct urb *urb);
  45 static int __if_usb_prog_firmware(struct if_usb_card *cardp,
  46                                         const char *fwname, int cmd);
  47 static int if_usb_prog_firmware(struct if_usb_card *cardp,
  48                                         const char *fwname, int cmd);
  49 static int if_usb_host_to_card(struct lbs_private *priv, uint8_t type,
  50                                uint8_t *payload, uint16_t nb);
  51 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
  52                         uint16_t nb);
  53 static void if_usb_free(struct if_usb_card *cardp);
  54 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
  55 static int if_usb_reset_device(struct if_usb_card *cardp);
  56
  57 /* sysfs hooks */
  58
  59 /**
  60  *  Set function to write firmware to device's persistent memory
  61  */
  62 static ssize_t if_usb_firmware_set(struct device *dev,
  63                 struct device_attribute *attr, const char *buf, size_t count)
  64 {
  65         struct lbs_private *priv = to_net_dev(dev)->ml_priv;
  66         struct if_usb_card *cardp = priv->card;
  67         int ret;
  68
  69         ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_FW);
  70         if (ret == 0)
  71                 return count;
  72
  73         return ret;
  74 }
  75
  76 /**
  77  * lbs_flash_fw attribute to be exported per ethX interface through sysfs
  78  * (/sys/class/net/ethX/lbs_flash_fw).  Use this like so to write firmware to
  79  * the device's persistent memory:
  80  * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_fw
  81  */
  82 static DEVICE_ATTR(lbs_flash_fw, 0200, NULL, if_usb_firmware_set);
  83
  84 /**
  85  *  Set function to write firmware to device's persistent memory
  86  */
  87 static ssize_t if_usb_boot2_set(struct device *dev,
  88                 struct device_attribute *attr, const char *buf, size_t count)
  89 {
  90         struct lbs_private *priv = to_net_dev(dev)->ml_priv;
  91         struct if_usb_card *cardp = priv->card;
  92         int ret;
  93
  94         ret = if_usb_prog_firmware(cardp, buf, BOOT_CMD_UPDATE_BOOT2);
  95         if (ret == 0)
  96                 return count;
  97
  98         return ret;
  99 }
 100
 101 /**
 102  * lbs_flash_boot2 attribute to be exported per ethX interface through sysfs
 103  * (/sys/class/net/ethX/lbs_flash_boot2).  Use this like so to write firmware
 104  * to the device's persistent memory:
 105  * echo usb8388-5.126.0.p5.bin > /sys/class/net/ethX/lbs_flash_boot2
 106  */
 107 static DEVICE_ATTR(lbs_flash_boot2, 0200, NULL, if_usb_boot2_set);
 108
 109 /**
 110  *  @brief  call back function to handle the status of the URB
 111  *  @param urb          pointer to urb structure
 112  *  @return             N/A
 113  */
 114 static void if_usb_write_bulk_callback(struct urb *urb)
 115 {
 116         struct if_usb_card *cardp = (struct if_usb_card *) urb->context;
 117
 118         /* handle the transmission complete validations */
 119
 120         if (urb->status == 0) {
 121                 struct lbs_private *priv = cardp->priv;
 122
 123                 lbs_deb_usb2(&urb->dev->dev, "URB status is successful\n");
 124                 lbs_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
 125                              urb->actual_length);
 126
 127                 /* Boot commands such as UPDATE_FW and UPDATE_BOOT2 are not
 128                  * passed up to the lbs level.
 129                  */
 130                 if (priv && priv->dnld_sent != DNLD_BOOTCMD_SENT)
 131                         lbs_host_to_card_done(priv);
 132         } else {
 133                 /* print the failure status number for debug */
 134                 lbs_pr_info("URB in failure status: %d\n", urb->status);
 135         }
 136 }
 137
 138 /**
 139  *  @brief  free tx/rx urb, skb and rx buffer
 140  *  @param cardp        pointer if_usb_card
 141  *  @return             N/A
 142  */
 143 static void if_usb_free(struct if_usb_card *cardp)
 144 {
 145         lbs_deb_enter(LBS_DEB_USB);
 146
 147         /* Unlink tx & rx urb */
 148         usb_kill_urb(cardp->tx_urb);
 149         usb_kill_urb(cardp->rx_urb);
 150
 151         usb_free_urb(cardp->tx_urb);
 152         cardp->tx_urb = NULL;
 153
 154         usb_free_urb(cardp->rx_urb);
 155         cardp->rx_urb = NULL;
 156
 157         kfree(cardp->ep_out_buf);
 158         cardp->ep_out_buf = NULL;
 159
 160         lbs_deb_leave(LBS_DEB_USB);
 161 }
 162
 163 static void if_usb_setup_firmware(struct lbs_private *priv)
 164 {
 165         struct if_usb_card *cardp = priv->card;
 166         struct cmd_ds_set_boot2_ver b2_cmd;
 167         struct cmd_ds_802_11_fw_wake_method wake_method;
 168
 169         b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
 170         b2_cmd.action = 0;
 171         b2_cmd.version = cardp->boot2_version;
 172
 173         if (lbs_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
 174                 lbs_deb_usb("Setting boot2 version failed\n");
 175
 176         priv->wol_gpio = 2; /* Wake via GPIO2... */
 177         priv->wol_gap = 20; /* ... after 20ms    */
 178         lbs_host_sleep_cfg(priv, EHS_WAKE_ON_UNICAST_DATA,
 179                         (struct wol_config *) NULL);
 180
 181         wake_method.hdr.size = cpu_to_le16(sizeof(wake_method));
 182         wake_method.action = cpu_to_le16(CMD_ACT_GET);
 183         if (lbs_cmd_with_response(priv, CMD_802_11_FW_WAKE_METHOD, &wake_method)) {
 184                 lbs_pr_info("Firmware does not seem to support PS mode\n");
 185                 priv->fwcapinfo &= ~FW_CAPINFO_PS;
 186         } else {
 187                 if (le16_to_cpu(wake_method.method) == CMD_WAKE_METHOD_COMMAND_INT) {
 188                         lbs_deb_usb("Firmware seems to support PS with wake-via-command\n");
 189                 } else {
 190                         /* The versions which boot up this way don't seem to
 191                            work even if we set it to the command interrupt */
 192                         priv->fwcapinfo &= ~FW_CAPINFO_PS;
 193                         lbs_pr_info("Firmware doesn't wake via command interrupt; disabling PS mode\n");
 194                 }
 195         }
 196 }
 197
 198 static void if_usb_fw_timeo(unsigned long priv)
 199 {
 200         struct if_usb_card *cardp = (void *)priv;
 201
 202         if (cardp->fwdnldover) {
 203                 lbs_deb_usb("Download complete, no event. Assuming success\n");
 204         } else {
 205                 lbs_pr_err("Download timed out\n");
 206                 cardp->surprise_removed = 1;
 207         }
 208         wake_up(&cardp->fw_wq);
 209 }
 210
 211 #ifdef CONFIG_OLPC
 212 static void if_usb_reset_olpc_card(struct lbs_private *priv)
 213 {
 214         printk(KERN_CRIT "Resetting OLPC wireless via EC...\n");
 215         olpc_ec_cmd(0x25, NULL, 0, NULL, 0);
 216 }
 217 #endif
 218
 219 /**
 220  *  @brief sets the configuration values
 221  *  @param ifnum        interface number
 222  *  @param id           pointer to usb_device_id
 223  *  @return             0 on success, error code on failure
 224  */
 225 static int if_usb_probe(struct usb_interface *intf,
 226                         const struct usb_device_id *id)
 227 {
 228         struct usb_device *udev;
 229         struct usb_host_interface *iface_desc;
 230         struct usb_endpoint_descriptor *endpoint;
 231         struct lbs_private *priv;
 232         struct if_usb_card *cardp;
 233         int i;
 234
 235         udev = interface_to_usbdev(intf);
 236
 237         cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
 238         if (!cardp) {
 239                 lbs_pr_err("Out of memory allocating private data.\n");
 240                 goto error;
 241         }
 242
 243         setup_timer(&cardp->fw_timeout, if_usb_fw_timeo, (unsigned long)cardp);
 244         init_waitqueue_head(&cardp->fw_wq);
 245
 246         cardp->udev = udev;
 247         iface_desc = intf->cur_altsetting;
 248
 249         lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
 250                      " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
 251                      le16_to_cpu(udev->descriptor.bcdUSB),
 252                      udev->descriptor.bDeviceClass,
 253                      udev->descriptor.bDeviceSubClass,
 254                      udev->descriptor.bDeviceProtocol);
 255
 256         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 257                 endpoint = &iface_desc->endpoint[i].desc;
 258                 if (usb_endpoint_is_bulk_in(endpoint)) {
 259                         cardp->ep_in_size = le16_to_cpu(endpoint->wMaxPacketSize);
 260                         cardp->ep_in = usb_endpoint_num(endpoint);
 261
 262                         lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n", cardp->ep_in);
 263                         lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n", cardp->ep_in_size);
 264
 265                 } else if (usb_endpoint_is_bulk_out(endpoint)) {
 266                         cardp->ep_out_size = le16_to_cpu(endpoint->wMaxPacketSize);
 267                         cardp->ep_out = usb_endpoint_num(endpoint);
 268
 269                         lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n", cardp->ep_out);
 270                         lbs_deb_usbd(&udev->dev, "Bulk out size is %d\n", cardp->ep_out_size);
 271                 }
 272         }
 273         if (!cardp->ep_out_size || !cardp->ep_in_size) {
 274                 lbs_deb_usbd(&udev->dev, "Endpoints not found\n");
 275                 goto dealloc;
 276         }
 277         if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
 278                 lbs_deb_usbd(&udev->dev, "Rx URB allocation failed\n");
 279                 goto dealloc;
 280         }
 281         if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
 282                 lbs_deb_usbd(&udev->dev, "Tx URB allocation failed\n");
 283                 goto dealloc;
 284         }
 285         cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE, GFP_KERNEL);
 286         if (!cardp->ep_out_buf) {
 287                 lbs_deb_usbd(&udev->dev, "Could not allocate buffer\n");
 288                 goto dealloc;
 289         }
 290
 291         /* Upload firmware */
 292         kparam_block_sysfs_write(fw_name);
 293         if (__if_usb_prog_firmware(cardp, lbs_fw_name, BOOT_CMD_FW_BY_USB)) {
 294                 kparam_unblock_sysfs_write(fw_name);
 295                 lbs_deb_usbd(&udev->dev, "FW upload failed\n");
 296                 goto err_prog_firmware;
 297         }
 298         kparam_unblock_sysfs_write(fw_name);
 299
 300         if (!(priv = lbs_add_card(cardp, &udev->dev)))
 301                 goto err_prog_firmware;
 302
 303         cardp->priv = priv;
 304         cardp->priv->fw_ready = 1;
 305
 306         priv->hw_host_to_card = if_usb_host_to_card;
 307         priv->enter_deep_sleep = NULL;
 308         priv->exit_deep_sleep = NULL;
 309         priv->reset_deep_sleep_wakeup = NULL;
 310 #ifdef CONFIG_OLPC
 311         if (machine_is_olpc())
 312                 priv->reset_card = if_usb_reset_olpc_card;
 313 #endif
 314
 315         cardp->boot2_version = udev->descriptor.bcdDevice;
 316
 317         if_usb_submit_rx_urb(cardp);
 318
 319         if (lbs_start_card(priv))
 320                 goto err_start_card;
 321
 322         if_usb_setup_firmware(priv);
 323
 324         usb_get_dev(udev);
 325         usb_set_intfdata(intf, cardp);
 326
 327         if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_fw))
 328                 lbs_pr_err("cannot register lbs_flash_fw attribute\n");
 329
 330         if (device_create_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2))
 331                 lbs_pr_err("cannot register lbs_flash_boot2 attribute\n");
 332
 333         return 0;
 334
 335 err_start_card:
 336         lbs_remove_card(priv);
 337 err_prog_firmware:
 338         if_usb_reset_device(cardp);
 339 dealloc:
 340         if_usb_free(cardp);
 341
 342 error:
 343         return -ENOMEM;
 344 }
 345
 346 /**
 347  *  @brief free resource and cleanup
 348  *  @param intf         USB interface structure
 349  *  @return             N/A
 350  */
 351 static void if_usb_disconnect(struct usb_interface *intf)
 352 {
 353         struct if_usb_card *cardp = usb_get_intfdata(intf);
 354         struct lbs_private *priv = (struct lbs_private *) cardp->priv;
 355
 356         lbs_deb_enter(LBS_DEB_MAIN);
 357
 358         device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_boot2);
 359         device_remove_file(&priv->dev->dev, &dev_attr_lbs_flash_fw);
 360
 361         cardp->surprise_removed = 1;
 362
 363         if (priv) {
 364                 priv->surpriseremoved = 1;
 365                 lbs_stop_card(priv);
 366                 lbs_remove_card(priv);
 367         }
 368
 369         /* Unlink and free urb */
 370         if_usb_free(cardp);
 371
 372         usb_set_intfdata(intf, NULL);
 373         usb_put_dev(interface_to_usbdev(intf));
 374
 375         lbs_deb_leave(LBS_DEB_MAIN);
 376 }
 377
 378 /**
 379  *  @brief  This function download FW
 380  *  @param priv         pointer to struct lbs_private
 381  *  @return             0
 382  */
 383 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
 384 {
 385         struct fwdata *fwdata = cardp->ep_out_buf;
 386         const uint8_t *firmware = cardp->fw->data;
 387
 388         /* If we got a CRC failure on the last block, back
 389            up and retry it */
 390         if (!cardp->CRC_OK) {
 391                 cardp->totalbytes = cardp->fwlastblksent;
 392                 cardp->fwseqnum--;
 393         }
 394
 395         lbs_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
 396                      cardp->totalbytes);
 397
 398         /* struct fwdata (which we sent to the card) has an
 399            extra __le32 field in between the header and the data,
 400            which is not in the struct fwheader in the actual
 401            firmware binary. Insert the seqnum in the middle... */
 402         memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
 403                sizeof(struct fwheader));
 404
 405         cardp->fwlastblksent = cardp->totalbytes;
 406         cardp->totalbytes += sizeof(struct fwheader);
 407
 408         memcpy(fwdata->data, &firmware[cardp->totalbytes],
 409                le32_to_cpu(fwdata->hdr.datalength));
 410
 411         lbs_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
 412                      le32_to_cpu(fwdata->hdr.datalength));
 413
 414         fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
 415         cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
 416
 417         usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
 418                      le32_to_cpu(fwdata->hdr.datalength));
 419
 420         if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
 421                 lbs_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
 422                 lbs_deb_usb2(&cardp->udev->dev, "seqnum = %d totalbytes = %d\n",
 423                              cardp->fwseqnum, cardp->totalbytes);
 424         } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
 425                 lbs_deb_usb2(&cardp->udev->dev, "Host has finished FW downloading\n");
 426                 lbs_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
 427
 428                 cardp->fwfinalblk = 1;
 429         }
 430
 431         lbs_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
 432                      cardp->totalbytes);
 433
 434         return 0;
 435 }
 436
 437 static int if_usb_reset_device(struct if_usb_card *cardp)
 438 {
 439         struct cmd_header *cmd = cardp->ep_out_buf + 4;
 440         int ret;
 441
 442         lbs_deb_enter(LBS_DEB_USB);
 443
 444         *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
 445
 446         cmd->command = cpu_to_le16(CMD_802_11_RESET);
 447         cmd->size = cpu_to_le16(sizeof(cmd));
 448         cmd->result = cpu_to_le16(0);
 449         cmd->seqnum = cpu_to_le16(0x5a5a);
 450         usb_tx_block(cardp, cardp->ep_out_buf, 4 + sizeof(struct cmd_header));
 451
 452         msleep(100);
 453         ret = usb_reset_device(cardp->udev);
 454         msleep(100);
 455
 456 #ifdef CONFIG_OLPC
 457         if (ret && machine_is_olpc())
 458                 if_usb_reset_olpc_card(NULL);
 459 #endif
 460
 461         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
 462
 463         return ret;
 464 }
 465
 466 /**
 467  *  @brief This function transfer the data to the device.
 468  *  @param priv         pointer to struct lbs_private
 469  *  @param payload      pointer to payload data
 470  *  @param nb           data length
 471  *  @return             0 or -1
 472  */
 473 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload, uint16_t nb)
 474 {
 475         int ret = -1;
 476
 477         /* check if device is removed */
 478         if (cardp->surprise_removed) {
 479                 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
 480                 goto tx_ret;
 481         }
 482
 483         usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
 484                           usb_sndbulkpipe(cardp->udev,
 485                                           cardp->ep_out),
 486                           payload, nb, if_usb_write_bulk_callback, cardp);
 487
 488         cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
 489
 490         if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
 491                 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed: %d\n", ret);
 492                 ret = -1;
 493         } else {
 494                 lbs_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
 495                 ret = 0;
 496         }
 497
 498 tx_ret:
 499         return ret;
 500 }
 501
 502 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
 503                                   void (*callbackfn)(struct urb *urb))
 504 {
 505         struct sk_buff *skb;
 506         int ret = -1;
 507
 508         if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
 509                 lbs_pr_err("No free skb\n");
 510                 goto rx_ret;
 511         }
 512
 513         cardp->rx_skb = skb;
 514
 515         /* Fill the receive configuration URB and initialise the Rx call back */
 516         usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
 517                           usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
 518                           skb->data + IPFIELD_ALIGN_OFFSET,
 519                           MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
 520                           cardp);
 521
 522         cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
 523
 524         lbs_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb);
 525         if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
 526                 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed: %d\n", ret);
 527                 kfree_skb(skb);
 528                 cardp->rx_skb = NULL;
 529                 ret = -1;
 530         } else {
 531                 lbs_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
 532                 ret = 0;
 533         }
 534
 535 rx_ret:
 536         return ret;
 537 }
 538
 539 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
 540 {
 541         return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
 542 }
 543
 544 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
 545 {
 546         return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
 547 }
 548
 549 static void if_usb_receive_fwload(struct urb *urb)
 550 {
 551         struct if_usb_card *cardp = urb->context;
 552         struct sk_buff *skb = cardp->rx_skb;
 553         struct fwsyncheader *syncfwheader;
 554         struct bootcmdresp bootcmdresp;
 555
 556         if (urb->status) {
 557                 lbs_deb_usbd(&cardp->udev->dev,
 558                              "URB status is failed during fw load\n");
 559                 kfree_skb(skb);
 560                 return;
 561         }
 562
 563         if (cardp->fwdnldover) {
 564                 __le32 *tmp = (__le32 *)(skb->data + IPFIELD_ALIGN_OFFSET);
 565
 566                 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
 567                     tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
 568                         lbs_pr_info("Firmware ready event received\n");
 569                         wake_up(&cardp->fw_wq);
 570                 } else {
 571                         lbs_deb_usb("Waiting for confirmation; got %x %x\n",
 572                                     le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
 573                         if_usb_submit_rx_urb_fwload(cardp);
 574                 }
 575                 kfree_skb(skb);
 576                 return;
 577         }
 578         if (cardp->bootcmdresp <= 0) {
 579                 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
 580                         sizeof(bootcmdresp));
 581
 582                 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
 583                         kfree_skb(skb);
 584                         if_usb_submit_rx_urb_fwload(cardp);
 585                         cardp->bootcmdresp = BOOT_CMD_RESP_OK;
 586                         lbs_deb_usbd(&cardp->udev->dev,
 587                                      "Received valid boot command response\n");
 588                         return;
 589                 }
 590                 if (bootcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
 591                         if (bootcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
 592                             bootcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
 593                             bootcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
 594                                 if (!cardp->bootcmdresp)
 595                                         lbs_pr_info("Firmware already seems alive; resetting\n");
 596                                 cardp->bootcmdresp = -1;
 597                         } else {
 598                                 lbs_pr_info("boot cmd response wrong magic number (0x%x)\n",
 599                                             le32_to_cpu(bootcmdresp.magic));
 600                         }
 601                 } else if ((bootcmdresp.cmd != BOOT_CMD_FW_BY_USB) &&
 602                            (bootcmdresp.cmd != BOOT_CMD_UPDATE_FW) &&
 603                            (bootcmdresp.cmd != BOOT_CMD_UPDATE_BOOT2)) {
 604                         lbs_pr_info("boot cmd response cmd_tag error (%d)\n",
 605                                     bootcmdresp.cmd);
 606                 } else if (bootcmdresp.result != BOOT_CMD_RESP_OK) {
 607                         lbs_pr_info("boot cmd response result error (%d)\n",
 608                                     bootcmdresp.result);
 609                 } else {
 610                         cardp->bootcmdresp = 1;
 611                         lbs_deb_usbd(&cardp->udev->dev,
 612                                      "Received valid boot command response\n");
 613                 }
 614                 kfree_skb(skb);
 615                 if_usb_submit_rx_urb_fwload(cardp);
 616                 return;
 617         }
 618
 619         syncfwheader = kmemdup(skb->data + IPFIELD_ALIGN_OFFSET,
 620                                sizeof(struct fwsyncheader), GFP_ATOMIC);
 621         if (!syncfwheader) {
 622                 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
 623                 kfree_skb(skb);
 624                 return;
 625         }
 626
 627         if (!syncfwheader->cmd) {
 628                 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk with correct CRC\n");
 629                 lbs_deb_usb2(&cardp->udev->dev, "FW received Blk seqnum = %d\n",
 630                              le32_to_cpu(syncfwheader->seqnum));
 631                 cardp->CRC_OK = 1;
 632         } else {
 633                 lbs_deb_usbd(&cardp->udev->dev, "FW received Blk with CRC error\n");
 634                 cardp->CRC_OK = 0;
 635         }
 636
 637         kfree_skb(skb);
 638
 639         /* Give device 5s to either write firmware to its RAM or eeprom */
 640         mod_timer(&cardp->fw_timeout, jiffies + (HZ*5));
 641
 642         if (cardp->fwfinalblk) {
 643                 cardp->fwdnldover = 1;
 644                 goto exit;
 645         }
 646
 647         if_usb_send_fw_pkt(cardp);
 648
 649  exit:
 650         if_usb_submit_rx_urb_fwload(cardp);
 651
 652         kfree(syncfwheader);
 653 }
 654
 655 #define MRVDRV_MIN_PKT_LEN      30
 656
 657 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
 658                                        struct if_usb_card *cardp,
 659                                        struct lbs_private *priv)
 660 {
 661         if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
 662             || recvlength < MRVDRV_MIN_PKT_LEN) {
 663                 lbs_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
 664                 kfree_skb(skb);
 665                 return;
 666         }
 667
 668         skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
 669         skb_put(skb, recvlength);
 670         skb_pull(skb, MESSAGE_HEADER_LEN);
 671
 672         lbs_process_rxed_packet(priv, skb);
 673 }
 674
 675 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
 676                                       struct sk_buff *skb,
 677                                       struct if_usb_card *cardp,
 678                                       struct lbs_private *priv)
 679 {
 680         u8 i;
 681
 682         if (recvlength > LBS_CMD_BUFFER_SIZE) {
 683                 lbs_deb_usbd(&cardp->udev->dev,
 684                              "The receive buffer is too large\n");
 685                 kfree_skb(skb);
 686                 return;
 687         }
 688
 689         BUG_ON(!in_interrupt());
 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  */
 714 static 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
 776 setup_for_next:
 777         if_usb_submit_rx_urb(cardp);
 778 rx_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  */
 790 static 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  */
 817 static 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  */
 840 static 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 */
 890 static 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
 927 static 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
 958 restart:
 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
1036 static 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         if (priv->wol_criteria == EHS_REMOVE_WAKEUP) {
1048                 lbs_pr_info("Suspend attempt without "
1049                                                 "configuring wake params!\n");
1050                 return -ENOSYS;
1051         }
1052
1053         ret = lbs_suspend(priv);
1054         if (ret)
1055                 goto out;
1056
1057         /* Unlink tx & rx urb */
1058         usb_kill_urb(cardp->tx_urb);
1059         usb_kill_urb(cardp->rx_urb);
1060
1061  out:
1062         lbs_deb_leave(LBS_DEB_USB);
1063         return ret;
1064 }
1065
1066 static int if_usb_resume(struct usb_interface *intf)
1067 {
1068         struct if_usb_card *cardp = usb_get_intfdata(intf);
1069         struct lbs_private *priv = cardp->priv;
1070
1071         lbs_deb_enter(LBS_DEB_USB);
1072
1073         if_usb_submit_rx_urb(cardp);
1074
1075         lbs_resume(priv);
1076
1077         lbs_deb_leave(LBS_DEB_USB);
1078         return 0;
1079 }
1080 #else
1081 #define if_usb_suspend NULL
1082 #define if_usb_resume NULL
1083 #endif
1084
1085 static struct usb_driver if_usb_driver = {
1086         .name = DRV_NAME,
1087         .probe = if_usb_probe,
1088         .disconnect = if_usb_disconnect,
1089         .id_table = if_usb_table,
1090         .suspend = if_usb_suspend,
1091         .resume = if_usb_resume,
1092         .reset_resume = if_usb_resume,
1093 };
1094
1095 static int __init if_usb_init_module(void)
1096 {
1097         int ret = 0;
1098
1099         lbs_deb_enter(LBS_DEB_MAIN);
1100
1101         ret = usb_register(&if_usb_driver);
1102
1103         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1104         return ret;
1105 }
1106
1107 static void __exit if_usb_exit_module(void)
1108 {
1109         lbs_deb_enter(LBS_DEB_MAIN);
1110
1111         usb_deregister(&if_usb_driver);
1112
1113         lbs_deb_leave(LBS_DEB_MAIN);
1114 }
1115
1116 module_init(if_usb_init_module);
1117 module_exit(if_usb_exit_module);
1118
1119 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1120 MODULE_AUTHOR("Marvell International Ltd. and Red Hat, Inc.");
1121 MODULE_LICENSE("GPL");