drivers/net/wireless/marvell/libertas/if_usb.c

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