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