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