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