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