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

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