drivers/net/wireless/libertas/if_usb.c

   1 /**
   2   * This file contains functions used in USB interface module.
   3   */
   4 #include <linux/delay.h>
   5 #include <linux/moduleparam.h>
   6 #include <linux/firmware.h>
   7 #include <linux/netdevice.h>
   8 #include <linux/usb.h>
   9
  10 #define DRV_NAME "usb8xxx"
  11
  12 #include "host.h"
  13 #include "decl.h"
  14 #include "defs.h"
  15 #include "dev.h"
  16 #include "if_usb.h"
  17
  18 #define MESSAGE_HEADER_LEN      4
  19
  20 static char *lbs_fw_name = "usb8388.bin";
  21 module_param_named(fw_name, lbs_fw_name, charp, 0644);
  22
  23 static struct usb_device_id if_usb_table[] = {
  24         /* Enter the device signature inside */
  25         { USB_DEVICE(0x1286, 0x2001) },
  26         { USB_DEVICE(0x05a3, 0x8388) },
  27         {}      /* Terminating entry */
  28 };
  29
  30 MODULE_DEVICE_TABLE(usb, if_usb_table);
  31
  32 static void if_usb_receive(struct urb *urb);
  33 static void if_usb_receive_fwload(struct urb *urb);
  34 static int if_usb_prog_firmware(struct usb_card_rec *cardp);
  35 static int if_usb_host_to_card(struct lbs_private *priv,
  36         u8 type,
  37         u8 *payload,
  38         u16 nb);
  39 static int if_usb_get_int_status(struct lbs_private *priv, u8 *);
  40 static int if_usb_read_event_cause(struct lbs_private *);
  41 static int usb_tx_block(struct usb_card_rec *cardp, u8 *payload, u16 nb);
  42 static void if_usb_free(struct usb_card_rec *cardp);
  43 static int if_usb_submit_rx_urb(struct usb_card_rec *cardp);
  44 static int if_usb_reset_device(struct usb_card_rec *cardp);
  45
  46 /**
  47  *  @brief  call back function to handle the status of the URB
  48  *  @param urb          pointer to urb structure
  49  *  @return             N/A
  50  */
  51 static void if_usb_write_bulk_callback(struct urb *urb)
  52 {
  53         struct usb_card_rec *cardp = (struct usb_card_rec *) urb->context;
  54
  55         /* handle the transmission complete validations */
  56
  57         if (urb->status == 0) {
  58                 struct lbs_private *priv = cardp->priv;
  59
  60                 /*
  61                 lbs_deb_usbd(&urb->dev->dev, "URB status is successfull\n");
  62                 lbs_deb_usbd(&urb->dev->dev, "Actual length transmitted %d\n",
  63                        urb->actual_length);
  64                 */
  65
  66                 /* Used for both firmware TX and regular TX.  priv isn't
  67                  * valid at firmware load time.
  68                  */
  69                 if (priv)
  70                         lbs_host_to_card_done(priv);
  71         } else {
  72                 /* print the failure status number for debug */
  73                 lbs_pr_info("URB in failure status: %d\n", urb->status);
  74         }
  75
  76         return;
  77 }
  78
  79 /**
  80  *  @brief  free tx/rx urb, skb and rx buffer
  81  *  @param cardp        pointer usb_card_rec
  82  *  @return             N/A
  83  */
  84 static void if_usb_free(struct usb_card_rec *cardp)
  85 {
  86         lbs_deb_enter(LBS_DEB_USB);
  87
  88         /* Unlink tx & rx urb */
  89         usb_kill_urb(cardp->tx_urb);
  90         usb_kill_urb(cardp->rx_urb);
  91
  92         usb_free_urb(cardp->tx_urb);
  93         cardp->tx_urb = NULL;
  94
  95         usb_free_urb(cardp->rx_urb);
  96         cardp->rx_urb = NULL;
  97
  98         kfree(cardp->bulk_out_buffer);
  99         cardp->bulk_out_buffer = NULL;
 100
 101         lbs_deb_leave(LBS_DEB_USB);
 102 }
 103
 104 /**
 105  *  @brief sets the configuration values
 106  *  @param ifnum        interface number
 107  *  @param id           pointer to usb_device_id
 108  *  @return             0 on success, error code on failure
 109  */
 110 static int if_usb_probe(struct usb_interface *intf,
 111                         const struct usb_device_id *id)
 112 {
 113         struct usb_device *udev;
 114         struct usb_host_interface *iface_desc;
 115         struct usb_endpoint_descriptor *endpoint;
 116         struct lbs_private *priv;
 117         struct usb_card_rec *cardp;
 118         int i;
 119
 120         udev = interface_to_usbdev(intf);
 121
 122         cardp = kzalloc(sizeof(struct usb_card_rec), GFP_KERNEL);
 123         if (!cardp) {
 124                 lbs_pr_err("Out of memory allocating private data.\n");
 125                 goto error;
 126         }
 127
 128         cardp->udev = udev;
 129         iface_desc = intf->cur_altsetting;
 130
 131         lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
 132                " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
 133                      le16_to_cpu(udev->descriptor.bcdUSB),
 134                      udev->descriptor.bDeviceClass,
 135                      udev->descriptor.bDeviceSubClass,
 136                      udev->descriptor.bDeviceProtocol);
 137
 138         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 139                 endpoint = &iface_desc->endpoint[i].desc;
 140                 if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
 141                     && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 142                         USB_ENDPOINT_XFER_BULK)) {
 143                         /* we found a bulk in endpoint */
 144                         lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n",
 145                                      le16_to_cpu(endpoint->wMaxPacketSize));
 146                         if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
 147                                 lbs_deb_usbd(&udev->dev,
 148                                        "Rx URB allocation failed\n");
 149                                 goto dealloc;
 150                         }
 151                         cardp->rx_urb_recall = 0;
 152
 153                         cardp->bulk_in_size =
 154                                 le16_to_cpu(endpoint->wMaxPacketSize);
 155                         cardp->bulk_in_endpointAddr =
 156                             (endpoint->
 157                              bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 158                         lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n",
 159                                endpoint->bEndpointAddress);
 160                 }
 161
 162                 if (((endpoint->
 163                       bEndpointAddress & USB_ENDPOINT_DIR_MASK) ==
 164                      USB_DIR_OUT)
 165                     && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 166                         USB_ENDPOINT_XFER_BULK)) {
 167                         /* We found bulk out endpoint */
 168                         if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
 169                                 lbs_deb_usbd(&udev->dev,
 170                                        "Tx URB allocation failed\n");
 171                                 goto dealloc;
 172                         }
 173
 174                         cardp->bulk_out_size =
 175                                 le16_to_cpu(endpoint->wMaxPacketSize);
 176                         lbs_deb_usbd(&udev->dev,
 177                                      "Bulk out size is %d\n",
 178                                      le16_to_cpu(endpoint->wMaxPacketSize));
 179                         cardp->bulk_out_endpointAddr =
 180                             endpoint->bEndpointAddress;
 181                         lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n",
 182                                     endpoint->bEndpointAddress);
 183                         cardp->bulk_out_buffer =
 184                             kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE,
 185                                     GFP_KERNEL);
 186
 187                         if (!cardp->bulk_out_buffer) {
 188                                 lbs_deb_usbd(&udev->dev,
 189                                        "Could not allocate buffer\n");
 190                                 goto dealloc;
 191                         }
 192                 }
 193         }
 194
 195         /* Upload firmware */
 196         cardp->rinfo.cardp = cardp;
 197         if (if_usb_prog_firmware(cardp)) {
 198                 lbs_deb_usbd(&udev->dev, "FW upload failed");
 199                 goto err_prog_firmware;
 200         }
 201
 202         if (!(priv = lbs_add_card(cardp, &udev->dev)))
 203                 goto err_prog_firmware;
 204
 205         cardp->priv = priv;
 206
 207         if (lbs_add_mesh(priv, &udev->dev))
 208                 goto err_add_mesh;
 209
 210         cardp->eth_dev = priv->dev;
 211
 212         priv->hw_host_to_card = if_usb_host_to_card;
 213         priv->hw_get_int_status = if_usb_get_int_status;
 214         priv->hw_read_event_cause = if_usb_read_event_cause;
 215         priv->boot2_version = udev->descriptor.bcdDevice;
 216
 217         /* Delay 200 ms to waiting for the FW ready */
 218         if_usb_submit_rx_urb(cardp);
 219         msleep_interruptible(200);
 220         priv->adapter->fw_ready = 1;
 221
 222         if (lbs_start_card(priv))
 223                 goto err_start_card;
 224
 225         usb_get_dev(udev);
 226         usb_set_intfdata(intf, cardp);
 227
 228         return 0;
 229
 230 err_start_card:
 231         lbs_remove_mesh(priv);
 232 err_add_mesh:
 233         lbs_remove_card(priv);
 234 err_prog_firmware:
 235         if_usb_reset_device(cardp);
 236 dealloc:
 237         if_usb_free(cardp);
 238
 239 error:
 240         return -ENOMEM;
 241 }
 242
 243 /**
 244  *  @brief free resource and cleanup
 245  *  @param intf         USB interface structure
 246  *  @return             N/A
 247  */
 248 static void if_usb_disconnect(struct usb_interface *intf)
 249 {
 250         struct usb_card_rec *cardp = usb_get_intfdata(intf);
 251         struct lbs_private *priv = (struct lbs_private *) cardp->priv;
 252
 253         lbs_deb_enter(LBS_DEB_MAIN);
 254
 255         /* Update Surprise removed to TRUE */
 256         cardp->surprise_removed = 1;
 257
 258         if (priv) {
 259                 struct lbs_adapter *adapter = priv->adapter;
 260
 261                 adapter->surpriseremoved = 1;
 262                 lbs_stop_card(priv);
 263                 lbs_remove_mesh(priv);
 264                 lbs_remove_card(priv);
 265         }
 266
 267         /* this is (apparently?) necessary for future usage of the device */
 268         lbs_prepare_and_send_command(priv, CMD_802_11_RESET, CMD_ACT_HALT,
 269                         0, 0, NULL);
 270
 271         /* Unlink and free urb */
 272         if_usb_free(cardp);
 273
 274         usb_set_intfdata(intf, NULL);
 275         usb_put_dev(interface_to_usbdev(intf));
 276
 277         lbs_deb_leave(LBS_DEB_MAIN);
 278 }
 279
 280 /**
 281  *  @brief  This function download FW
 282  *  @param priv         pointer to struct lbs_private
 283  *  @return             0
 284  */
 285 static int if_prog_firmware(struct usb_card_rec *cardp)
 286 {
 287         struct FWData *fwdata;
 288         struct fwheader *fwheader;
 289         u8 *firmware = cardp->fw->data;
 290
 291         fwdata = kmalloc(sizeof(struct FWData), GFP_ATOMIC);
 292
 293         if (!fwdata)
 294                 return -1;
 295
 296         fwheader = &fwdata->fwheader;
 297
 298         if (!cardp->CRC_OK) {
 299                 cardp->totalbytes = cardp->fwlastblksent;
 300                 cardp->fwseqnum = cardp->lastseqnum - 1;
 301         }
 302
 303         /*
 304         lbs_deb_usbd(&cardp->udev->dev, "totalbytes = %d\n",
 305                     cardp->totalbytes);
 306         */
 307
 308         memcpy(fwheader, &firmware[cardp->totalbytes],
 309                sizeof(struct fwheader));
 310
 311         cardp->fwlastblksent = cardp->totalbytes;
 312         cardp->totalbytes += sizeof(struct fwheader);
 313
 314         /* lbs_deb_usbd(&cardp->udev->dev,"Copy Data\n"); */
 315         memcpy(fwdata->data, &firmware[cardp->totalbytes],
 316                le32_to_cpu(fwdata->fwheader.datalength));
 317
 318         /*
 319         lbs_deb_usbd(&cardp->udev->dev,
 320                     "Data length = %d\n", le32_to_cpu(fwdata->fwheader.datalength));
 321         */
 322
 323         cardp->fwseqnum = cardp->fwseqnum + 1;
 324
 325         fwdata->seqnum = cpu_to_le32(cardp->fwseqnum);
 326         cardp->lastseqnum = cardp->fwseqnum;
 327         cardp->totalbytes += le32_to_cpu(fwdata->fwheader.datalength);
 328
 329         if (fwheader->dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
 330                 /*
 331                 lbs_deb_usbd(&cardp->udev->dev, "There are data to follow\n");
 332                 lbs_deb_usbd(&cardp->udev->dev,
 333                             "seqnum = %d totalbytes = %d\n", cardp->fwseqnum,
 334                             cardp->totalbytes);
 335                 */
 336                 memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
 337                 usb_tx_block(cardp, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
 338
 339         } else if (fwdata->fwheader.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
 340                 /*
 341                 lbs_deb_usbd(&cardp->udev->dev,
 342                             "Host has finished FW downloading\n");
 343                 lbs_deb_usbd(&cardp->udev->dev,
 344                             "Donwloading FW JUMP BLOCK\n");
 345                 */
 346                 memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
 347                 usb_tx_block(cardp, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
 348                 cardp->fwfinalblk = 1;
 349         }
 350
 351         /*
 352         lbs_deb_usbd(&cardp->udev->dev,
 353                     "The firmware download is done size is %d\n",
 354                     cardp->totalbytes);
 355         */
 356
 357         kfree(fwdata);
 358
 359         return 0;
 360 }
 361
 362 static int if_usb_reset_device(struct usb_card_rec *cardp)
 363 {
 364         int ret;
 365         struct lbs_private *priv = cardp->priv;
 366
 367         lbs_deb_enter(LBS_DEB_USB);
 368
 369         /* Try a USB port reset first, if that fails send the reset
 370          * command to the firmware.
 371          */
 372         ret = usb_reset_device(cardp->udev);
 373         if (!ret && priv) {
 374                 msleep(10);
 375                 ret = lbs_reset_device(priv);
 376                 msleep(10);
 377         }
 378
 379         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
 380
 381         return ret;
 382 }
 383
 384 /**
 385  *  @brief This function transfer the data to the device.
 386  *  @param priv         pointer to struct lbs_private
 387  *  @param payload      pointer to payload data
 388  *  @param nb           data length
 389  *  @return             0 or -1
 390  */
 391 static int usb_tx_block(struct usb_card_rec *cardp, u8 * payload, u16 nb)
 392 {
 393         int ret = -1;
 394
 395         /* check if device is removed */
 396         if (cardp->surprise_removed) {
 397                 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
 398                 goto tx_ret;
 399         }
 400
 401         usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
 402                           usb_sndbulkpipe(cardp->udev,
 403                                           cardp->bulk_out_endpointAddr),
 404                           payload, nb, if_usb_write_bulk_callback, cardp);
 405
 406         cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
 407
 408         if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
 409                 /*  transfer failed */
 410                 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed\n");
 411                 ret = -1;
 412         } else {
 413                 /* lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb success\n"); */
 414                 ret = 0;
 415         }
 416
 417 tx_ret:
 418         return ret;
 419 }
 420
 421 static int __if_usb_submit_rx_urb(struct usb_card_rec *cardp,
 422                                   void (*callbackfn)(struct urb *urb))
 423 {
 424         struct sk_buff *skb;
 425         struct read_cb_info *rinfo = &cardp->rinfo;
 426         int ret = -1;
 427
 428         if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
 429                 lbs_pr_err("No free skb\n");
 430                 goto rx_ret;
 431         }
 432
 433         rinfo->skb = skb;
 434
 435         /* Fill the receive configuration URB and initialise the Rx call back */
 436         usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
 437                           usb_rcvbulkpipe(cardp->udev,
 438                                           cardp->bulk_in_endpointAddr),
 439                           (void *) (skb->tail + (size_t) IPFIELD_ALIGN_OFFSET),
 440                           MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
 441                           rinfo);
 442
 443         cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
 444
 445         /* lbs_deb_usbd(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb); */
 446         if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
 447                 /* handle failure conditions */
 448                 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed\n");
 449                 kfree_skb(skb);
 450                 rinfo->skb = NULL;
 451                 ret = -1;
 452         } else {
 453                 /* lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB success\n"); */
 454                 ret = 0;
 455         }
 456
 457 rx_ret:
 458         return ret;
 459 }
 460
 461 static int if_usb_submit_rx_urb_fwload(struct usb_card_rec *cardp)
 462 {
 463         return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
 464 }
 465
 466 static int if_usb_submit_rx_urb(struct usb_card_rec *cardp)
 467 {
 468         return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
 469 }
 470
 471 static void if_usb_receive_fwload(struct urb *urb)
 472 {
 473         struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
 474         struct sk_buff *skb = rinfo->skb;
 475         struct usb_card_rec *cardp = (struct usb_card_rec *)rinfo->cardp;
 476         struct fwsyncheader *syncfwheader;
 477         struct bootcmdrespStr bootcmdresp;
 478
 479         if (urb->status) {
 480                 lbs_deb_usbd(&cardp->udev->dev,
 481                             "URB status is failed during fw load\n");
 482                 kfree_skb(skb);
 483                 return;
 484         }
 485
 486         if (cardp->bootcmdresp == 0) {
 487                 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
 488                         sizeof(bootcmdresp));
 489                 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
 490                         kfree_skb(skb);
 491                         if_usb_submit_rx_urb_fwload(cardp);
 492                         cardp->bootcmdresp = 1;
 493                         lbs_deb_usbd(&cardp->udev->dev,
 494                                     "Received valid boot command response\n");
 495                         return;
 496                 }
 497                 if (bootcmdresp.u32magicnumber != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
 498                         lbs_pr_info(
 499                                 "boot cmd response wrong magic number (0x%x)\n",
 500                                 le32_to_cpu(bootcmdresp.u32magicnumber));
 501                 } else if (bootcmdresp.u8cmd_tag != BOOT_CMD_FW_BY_USB) {
 502                         lbs_pr_info(
 503                                 "boot cmd response cmd_tag error (%d)\n",
 504                                 bootcmdresp.u8cmd_tag);
 505                 } else if (bootcmdresp.u8result != BOOT_CMD_RESP_OK) {
 506                         lbs_pr_info(
 507                                 "boot cmd response result error (%d)\n",
 508                                 bootcmdresp.u8result);
 509                 } else {
 510                         cardp->bootcmdresp = 1;
 511                         lbs_deb_usbd(&cardp->udev->dev,
 512                                     "Received valid boot command response\n");
 513                 }
 514                 kfree_skb(skb);
 515                 if_usb_submit_rx_urb_fwload(cardp);
 516                 return;
 517         }
 518
 519         syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
 520         if (!syncfwheader) {
 521                 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
 522                 kfree_skb(skb);
 523                 return;
 524         }
 525
 526         memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
 527                         sizeof(struct fwsyncheader));
 528
 529         if (!syncfwheader->cmd) {
 530                 /*
 531                 lbs_deb_usbd(&cardp->udev->dev,
 532                             "FW received Blk with correct CRC\n");
 533                 lbs_deb_usbd(&cardp->udev->dev,
 534                             "FW received Blk seqnum = %d\n",
 535                        syncfwheader->seqnum);
 536                 */
 537                 cardp->CRC_OK = 1;
 538         } else {
 539                 lbs_deb_usbd(&cardp->udev->dev,
 540                             "FW received Blk with CRC error\n");
 541                 cardp->CRC_OK = 0;
 542         }
 543
 544         kfree_skb(skb);
 545
 546         if (cardp->fwfinalblk) {
 547                 cardp->fwdnldover = 1;
 548                 goto exit;
 549         }
 550
 551         if_prog_firmware(cardp);
 552
 553         if_usb_submit_rx_urb_fwload(cardp);
 554 exit:
 555         kfree(syncfwheader);
 556
 557         return;
 558
 559 }
 560
 561 #define MRVDRV_MIN_PKT_LEN      30
 562
 563 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
 564                                        struct usb_card_rec *cardp,
 565                                        struct lbs_private *priv)
 566 {
 567         if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE +
 568             MESSAGE_HEADER_LEN || recvlength < MRVDRV_MIN_PKT_LEN) {
 569                 lbs_deb_usbd(&cardp->udev->dev,
 570                             "Packet length is Invalid\n");
 571                 kfree_skb(skb);
 572                 return;
 573         }
 574
 575         skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
 576         skb_put(skb, recvlength);
 577         skb_pull(skb, MESSAGE_HEADER_LEN);
 578         lbs_process_rxed_packet(priv, skb);
 579         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
 580 }
 581
 582 static inline void process_cmdrequest(int recvlength, u8 *recvbuff,
 583                                       struct sk_buff *skb,
 584                                       struct usb_card_rec *cardp,
 585                                       struct lbs_private *priv)
 586 {
 587         u8 *cmdbuf;
 588         if (recvlength > MRVDRV_SIZE_OF_CMD_BUFFER) {
 589                 lbs_deb_usbd(&cardp->udev->dev,
 590                             "The receive buffer is too large\n");
 591                 kfree_skb(skb);
 592                 return;
 593         }
 594
 595         if (!in_interrupt())
 596                 BUG();
 597
 598         spin_lock(&priv->adapter->driver_lock);
 599         /* take care of cur_cmd = NULL case by reading the
 600          * data to clear the interrupt */
 601         if (!priv->adapter->cur_cmd) {
 602                 cmdbuf = priv->upld_buf;
 603                 priv->adapter->hisregcpy &= ~MRVDRV_CMD_UPLD_RDY;
 604         } else
 605                 cmdbuf = priv->adapter->cur_cmd->bufvirtualaddr;
 606
 607         cardp->usb_int_cause |= MRVDRV_CMD_UPLD_RDY;
 608         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
 609         memcpy(cmdbuf, recvbuff + MESSAGE_HEADER_LEN,
 610                priv->upld_len);
 611
 612         kfree_skb(skb);
 613         lbs_interrupt(priv->dev);
 614         spin_unlock(&priv->adapter->driver_lock);
 615
 616         lbs_deb_usbd(&cardp->udev->dev,
 617                     "Wake up main thread to handle cmd response\n");
 618
 619         return;
 620 }
 621
 622 /**
 623  *  @brief This function reads of the packet into the upload buff,
 624  *  wake up the main thread and initialise the Rx callack.
 625  *
 626  *  @param urb          pointer to struct urb
 627  *  @return             N/A
 628  */
 629 static void if_usb_receive(struct urb *urb)
 630 {
 631         struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
 632         struct sk_buff *skb = rinfo->skb;
 633         struct usb_card_rec *cardp = (struct usb_card_rec *) rinfo->cardp;
 634         struct lbs_private *priv = cardp->priv;
 635
 636         int recvlength = urb->actual_length;
 637         u8 *recvbuff = NULL;
 638         u32 recvtype = 0;
 639
 640         lbs_deb_enter(LBS_DEB_USB);
 641
 642         if (recvlength) {
 643                 __le32 tmp;
 644
 645                 if (urb->status) {
 646                         lbs_deb_usbd(&cardp->udev->dev,
 647                                     "URB status is failed\n");
 648                         kfree_skb(skb);
 649                         goto setup_for_next;
 650                 }
 651
 652                 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
 653                 memcpy(&tmp, recvbuff, sizeof(u32));
 654                 recvtype = le32_to_cpu(tmp);
 655                 lbs_deb_usbd(&cardp->udev->dev,
 656                             "Recv length = 0x%x, Recv type = 0x%X\n",
 657                             recvlength, recvtype);
 658         } else if (urb->status) {
 659                 kfree_skb(skb);
 660                 goto rx_exit;
 661         }
 662
 663         switch (recvtype) {
 664         case CMD_TYPE_DATA:
 665                 process_cmdtypedata(recvlength, skb, cardp, priv);
 666                 break;
 667
 668         case CMD_TYPE_REQUEST:
 669                 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
 670                 break;
 671
 672         case CMD_TYPE_INDICATION:
 673                 /* Event cause handling */
 674                 spin_lock(&priv->adapter->driver_lock);
 675                 cardp->usb_event_cause = le32_to_cpu(*(__le32 *) (recvbuff + MESSAGE_HEADER_LEN));
 676                 lbs_deb_usbd(&cardp->udev->dev,"**EVENT** 0x%X\n",
 677                             cardp->usb_event_cause);
 678                 if (cardp->usb_event_cause & 0xffff0000) {
 679                         lbs_send_tx_feedback(priv);
 680                         spin_unlock(&priv->adapter->driver_lock);
 681                         break;
 682                 }
 683                 cardp->usb_event_cause <<= 3;
 684                 cardp->usb_int_cause |= MRVDRV_CARDEVENT;
 685                 kfree_skb(skb);
 686                 lbs_interrupt(priv->dev);
 687                 spin_unlock(&priv->adapter->driver_lock);
 688                 goto rx_exit;
 689         default:
 690                 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
 691                              recvtype);
 692                 kfree_skb(skb);
 693                 break;
 694         }
 695
 696 setup_for_next:
 697         if_usb_submit_rx_urb(cardp);
 698 rx_exit:
 699         lbs_deb_leave(LBS_DEB_USB);
 700 }
 701
 702 /**
 703  *  @brief This function downloads data to FW
 704  *  @param priv         pointer to struct lbs_private structure
 705  *  @param type         type of data
 706  *  @param buf          pointer to data buffer
 707  *  @param len          number of bytes
 708  *  @return             0 or -1
 709  */
 710 static int if_usb_host_to_card(struct lbs_private *priv,
 711         u8 type,
 712         u8 *payload,
 713         u16 nb)
 714 {
 715         struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
 716
 717         lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
 718         lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
 719
 720         if (type == MVMS_CMD) {
 721                 __le32 tmp = cpu_to_le32(CMD_TYPE_REQUEST);
 722                 priv->dnld_sent = DNLD_CMD_SENT;
 723                 memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
 724                        MESSAGE_HEADER_LEN);
 725
 726         } else {
 727                 __le32 tmp = cpu_to_le32(CMD_TYPE_DATA);
 728                 priv->dnld_sent = DNLD_DATA_SENT;
 729                 memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
 730                        MESSAGE_HEADER_LEN);
 731         }
 732
 733         memcpy((cardp->bulk_out_buffer + MESSAGE_HEADER_LEN), payload, nb);
 734
 735         return usb_tx_block(cardp, cardp->bulk_out_buffer,
 736                             nb + MESSAGE_HEADER_LEN);
 737 }
 738
 739 /* called with adapter->driver_lock held */
 740 static int if_usb_get_int_status(struct lbs_private *priv, u8 *ireg)
 741 {
 742         struct usb_card_rec *cardp = priv->card;
 743
 744         *ireg = cardp->usb_int_cause;
 745         cardp->usb_int_cause = 0;
 746
 747         lbs_deb_usbd(&cardp->udev->dev,"Int cause is 0x%X\n", *ireg);
 748
 749         return 0;
 750 }
 751
 752 static int if_usb_read_event_cause(struct lbs_private *priv)
 753 {
 754         struct usb_card_rec *cardp = priv->card;
 755
 756         priv->adapter->eventcause = cardp->usb_event_cause;
 757         /* Re-submit rx urb here to avoid event lost issue */
 758         if_usb_submit_rx_urb(cardp);
 759         return 0;
 760 }
 761
 762 /**
 763  *  @brief This function issues Boot command to the Boot2 code
 764  *  @param ivalue   1:Boot from FW by USB-Download
 765  *                  2:Boot from FW in EEPROM
 766  *  @return             0
 767  */
 768 static int if_usb_issue_boot_command(struct usb_card_rec *cardp, int ivalue)
 769 {
 770         struct bootcmdstr sbootcmd;
 771         int i;
 772
 773         /* Prepare command */
 774         sbootcmd.u32magicnumber = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
 775         sbootcmd.u8cmd_tag = ivalue;
 776         for (i=0; i<11; i++)
 777                 sbootcmd.au8dumy[i]=0x00;
 778         memcpy(cardp->bulk_out_buffer, &sbootcmd, sizeof(struct bootcmdstr));
 779
 780         /* Issue command */
 781         usb_tx_block(cardp, cardp->bulk_out_buffer, sizeof(struct bootcmdstr));
 782
 783         return 0;
 784 }
 785
 786
 787 /**
 788  *  @brief This function checks the validity of Boot2/FW image.
 789  *
 790  *  @param data              pointer to image
 791  *         len               image length
 792  *  @return     0 or -1
 793  */
 794 static int check_fwfile_format(u8 *data, u32 totlen)
 795 {
 796         u32 bincmd, exit;
 797         u32 blksize, offset, len;
 798         int ret;
 799
 800         ret = 1;
 801         exit = len = 0;
 802
 803         do {
 804                 struct fwheader *fwh = (void *)data;
 805
 806                 bincmd = le32_to_cpu(fwh->dnldcmd);
 807                 blksize = le32_to_cpu(fwh->datalength);
 808                 switch (bincmd) {
 809                 case FW_HAS_DATA_TO_RECV:
 810                         offset = sizeof(struct fwheader) + blksize;
 811                         data += offset;
 812                         len += offset;
 813                         if (len >= totlen)
 814                                 exit = 1;
 815                         break;
 816                 case FW_HAS_LAST_BLOCK:
 817                         exit = 1;
 818                         ret = 0;
 819                         break;
 820                 default:
 821                         exit = 1;
 822                         break;
 823                 }
 824         } while (!exit);
 825
 826         if (ret)
 827                 lbs_pr_err("firmware file format check FAIL\n");
 828         else
 829                 lbs_deb_fw("firmware file format check PASS\n");
 830
 831         return ret;
 832 }
 833
 834
 835 static int if_usb_prog_firmware(struct usb_card_rec *cardp)
 836 {
 837         int i = 0;
 838         static int reset_count = 10;
 839         int ret = 0;
 840
 841         lbs_deb_enter(LBS_DEB_USB);
 842
 843         if ((ret = request_firmware(&cardp->fw, lbs_fw_name,
 844                                     &cardp->udev->dev)) < 0) {
 845                 lbs_pr_err("request_firmware() failed with %#x\n", ret);
 846                 lbs_pr_err("firmware %s not found\n", lbs_fw_name);
 847                 goto done;
 848         }
 849
 850         if (check_fwfile_format(cardp->fw->data, cardp->fw->size))
 851                 goto release_fw;
 852
 853 restart:
 854         if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
 855                 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
 856                 ret = -1;
 857                 goto release_fw;
 858         }
 859
 860         cardp->bootcmdresp = 0;
 861         do {
 862                 int j = 0;
 863                 i++;
 864                 /* Issue Boot command = 1, Boot from Download-FW */
 865                 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
 866                 /* wait for command response */
 867                 do {
 868                         j++;
 869                         msleep_interruptible(100);
 870                 } while (cardp->bootcmdresp == 0 && j < 10);
 871         } while (cardp->bootcmdresp == 0 && i < 5);
 872
 873         if (cardp->bootcmdresp == 0) {
 874                 if (--reset_count >= 0) {
 875                         if_usb_reset_device(cardp);
 876                         goto restart;
 877                 }
 878                 return -1;
 879         }
 880
 881         i = 0;
 882
 883         cardp->totalbytes = 0;
 884         cardp->fwlastblksent = 0;
 885         cardp->CRC_OK = 1;
 886         cardp->fwdnldover = 0;
 887         cardp->fwseqnum = -1;
 888         cardp->totalbytes = 0;
 889         cardp->fwfinalblk = 0;
 890
 891         if_prog_firmware(cardp);
 892
 893         do {
 894                 lbs_deb_usbd(&cardp->udev->dev,"Wlan sched timeout\n");
 895                 i++;
 896                 msleep_interruptible(100);
 897                 if (cardp->surprise_removed || i >= 20)
 898                         break;
 899         } while (!cardp->fwdnldover);
 900
 901         if (!cardp->fwdnldover) {
 902                 lbs_pr_info("failed to load fw, resetting device!\n");
 903                 if (--reset_count >= 0) {
 904                         if_usb_reset_device(cardp);
 905                         goto restart;
 906                 }
 907
 908                 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
 909                 ret = -1;
 910                 goto release_fw;
 911         }
 912
 913 release_fw:
 914         release_firmware(cardp->fw);
 915         cardp->fw = NULL;
 916
 917 done:
 918         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
 919         return ret;
 920 }
 921
 922
 923 #ifdef CONFIG_PM
 924 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
 925 {
 926         struct usb_card_rec *cardp = usb_get_intfdata(intf);
 927         struct lbs_private *priv = cardp->priv;
 928
 929         lbs_deb_enter(LBS_DEB_USB);
 930
 931         if (priv->adapter->psstate != PS_STATE_FULL_POWER)
 932                 return -1;
 933
 934         if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
 935                 /* Mesh autostart must be activated while sleeping
 936                  * On resume it will go back to the current state
 937                  */
 938                 struct cmd_ds_mesh_access mesh_access;
 939                 memset(&mesh_access, 0, sizeof(mesh_access));
 940                 mesh_access.data[0] = cpu_to_le32(1);
 941                 lbs_prepare_and_send_command(priv,
 942                                 CMD_MESH_ACCESS,
 943                                 CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
 944                                 CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
 945         }
 946
 947         netif_device_detach(cardp->eth_dev);
 948         netif_device_detach(priv->mesh_dev);
 949
 950         /* Unlink tx & rx urb */
 951         usb_kill_urb(cardp->tx_urb);
 952         usb_kill_urb(cardp->rx_urb);
 953
 954         cardp->rx_urb_recall = 1;
 955
 956         lbs_deb_leave(LBS_DEB_USB);
 957         return 0;
 958 }
 959
 960 static int if_usb_resume(struct usb_interface *intf)
 961 {
 962         struct usb_card_rec *cardp = usb_get_intfdata(intf);
 963         struct lbs_private *priv = cardp->priv;
 964
 965         lbs_deb_enter(LBS_DEB_USB);
 966
 967         cardp->rx_urb_recall = 0;
 968
 969         if_usb_submit_rx_urb(cardp->priv);
 970
 971         netif_device_attach(cardp->eth_dev);
 972         netif_device_attach(priv->mesh_dev);
 973
 974         if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
 975                 /* Mesh autostart was activated while sleeping
 976                  * Disable it if appropriate
 977                  */
 978                 struct cmd_ds_mesh_access mesh_access;
 979                 memset(&mesh_access, 0, sizeof(mesh_access));
 980                 mesh_access.data[0] = cpu_to_le32(0);
 981                 lbs_prepare_and_send_command(priv,
 982                                 CMD_MESH_ACCESS,
 983                                 CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
 984                                 CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
 985         }
 986
 987         lbs_deb_leave(LBS_DEB_USB);
 988         return 0;
 989 }
 990 #else
 991 #define if_usb_suspend NULL
 992 #define if_usb_resume NULL
 993 #endif
 994
 995 static struct usb_driver if_usb_driver = {
 996         .name = DRV_NAME,
 997         .probe = if_usb_probe,
 998         .disconnect = if_usb_disconnect,
 999         .id_table = if_usb_table,
1000         .suspend = if_usb_suspend,
1001         .resume = if_usb_resume,
1002 };
1003
1004 static int __init if_usb_init_module(void)
1005 {
1006         int ret = 0;
1007
1008         lbs_deb_enter(LBS_DEB_MAIN);
1009
1010         ret = usb_register(&if_usb_driver);
1011
1012         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1013         return ret;
1014 }
1015
1016 static void __exit if_usb_exit_module(void)
1017 {
1018         lbs_deb_enter(LBS_DEB_MAIN);
1019
1020         usb_deregister(&if_usb_driver);
1021
1022         lbs_deb_leave(LBS_DEB_MAIN);
1023 }
1024
1025 module_init(if_usb_init_module);
1026 module_exit(if_usb_exit_module);
1027
1028 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1029 MODULE_AUTHOR("Marvell International Ltd.");
1030 MODULE_LICENSE("GPL");