SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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         priv->boot2_version = udev->descriptor.bcdDevice;
 223
 224         if (libertas_activate_card(priv))
 225                 goto err_activate_card;
 226
 227         list_add_tail(&cardp->list, &usb_devices);
 228
 229         usb_get_dev(udev);
 230         usb_set_intfdata(intf, cardp);
 231
 232         return 0;
 233
 234 err_activate_card:
 235         libertas_remove_mesh(priv);
 236 err_add_mesh:
 237         free_netdev(priv->dev);
 238         kfree(priv->adapter);
 239 dealloc:
 240         if_usb_free(cardp);
 241
 242 error:
 243         return -ENOMEM;
 244 }
 245
 246 /**
 247  *  @brief free resource and cleanup
 248  *  @param intf         USB interface structure
 249  *  @return             N/A
 250  */
 251 static void if_usb_disconnect(struct usb_interface *intf)
 252 {
 253         struct usb_card_rec *cardp = usb_get_intfdata(intf);
 254         wlan_private *priv = (wlan_private *) cardp->priv;
 255         wlan_adapter *adapter = NULL;
 256
 257         adapter = priv->adapter;
 258
 259         /*
 260          * Update Surprise removed to TRUE
 261          */
 262         adapter->surpriseremoved = 1;
 263
 264         list_del(&cardp->list);
 265
 266         /* card is removed and we can call wlan_remove_card */
 267         lbs_deb_usbd(&cardp->udev->dev, "call remove card\n");
 268         libertas_remove_mesh(priv);
 269         libertas_remove_card(priv);
 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         return;
 278 }
 279
 280 /**
 281  *  @brief  This function download FW
 282  *  @param priv         pointer to wlan_private
 283  *  @return             0
 284  */
 285 static int if_prog_firmware(wlan_private * priv)
 286 {
 287         struct usb_card_rec *cardp = priv->card;
 288         struct FWData *fwdata;
 289         struct fwheader *fwheader;
 290         u8 *firmware = priv->firmware->data;
 291
 292         fwdata = kmalloc(sizeof(struct FWData), GFP_ATOMIC);
 293
 294         if (!fwdata)
 295                 return -1;
 296
 297         fwheader = &fwdata->fwheader;
 298
 299         if (!cardp->CRC_OK) {
 300                 cardp->totalbytes = cardp->fwlastblksent;
 301                 cardp->fwseqnum = cardp->lastseqnum - 1;
 302         }
 303
 304         /*
 305         lbs_deb_usbd(&cardp->udev->dev, "totalbytes = %d\n",
 306                     cardp->totalbytes);
 307         */
 308
 309         memcpy(fwheader, &firmware[cardp->totalbytes],
 310                sizeof(struct fwheader));
 311
 312         cardp->fwlastblksent = cardp->totalbytes;
 313         cardp->totalbytes += sizeof(struct fwheader);
 314
 315         /* lbs_deb_usbd(&cardp->udev->dev,"Copy Data\n"); */
 316         memcpy(fwdata->data, &firmware[cardp->totalbytes],
 317                le32_to_cpu(fwdata->fwheader.datalength));
 318
 319         /*
 320         lbs_deb_usbd(&cardp->udev->dev,
 321                     "Data length = %d\n", le32_to_cpu(fwdata->fwheader.datalength));
 322         */
 323
 324         cardp->fwseqnum = cardp->fwseqnum + 1;
 325
 326         fwdata->seqnum = cpu_to_le32(cardp->fwseqnum);
 327         cardp->lastseqnum = cardp->fwseqnum;
 328         cardp->totalbytes += le32_to_cpu(fwdata->fwheader.datalength);
 329
 330         if (fwheader->dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
 331                 /*
 332                 lbs_deb_usbd(&cardp->udev->dev, "There are data to follow\n");
 333                 lbs_deb_usbd(&cardp->udev->dev,
 334                             "seqnum = %d totalbytes = %d\n", cardp->fwseqnum,
 335                             cardp->totalbytes);
 336                 */
 337                 memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
 338                 usb_tx_block(priv, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
 339
 340         } else if (fwdata->fwheader.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
 341                 /*
 342                 lbs_deb_usbd(&cardp->udev->dev,
 343                             "Host has finished FW downloading\n");
 344                 lbs_deb_usbd(&cardp->udev->dev,
 345                             "Donwloading FW JUMP BLOCK\n");
 346                 */
 347                 memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
 348                 usb_tx_block(priv, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
 349                 cardp->fwfinalblk = 1;
 350         }
 351
 352         /*
 353         lbs_deb_usbd(&cardp->udev->dev,
 354                     "The firmware download is done size is %d\n",
 355                     cardp->totalbytes);
 356         */
 357
 358         kfree(fwdata);
 359
 360         return 0;
 361 }
 362
 363 static int if_usb_reset_device(wlan_private *priv)
 364 {
 365         int ret;
 366         struct usb_card_rec *cardp = priv->card;
 367
 368         lbs_deb_enter(LBS_DEB_USB);
 369
 370         /* Try a USB port reset first, if that fails send the reset
 371          * command to the firmware.
 372          */
 373         ret = usb_reset_device(cardp->udev);
 374         if (!ret) {
 375                 msleep(10);
 376                 ret = libertas_reset_device(priv);
 377                 msleep(10);
 378         }
 379
 380         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
 381
 382         return ret;
 383 }
 384
 385 /**
 386  *  @brief This function transfer the data to the device.
 387  *  @param priv         pointer to wlan_private
 388  *  @param payload      pointer to payload data
 389  *  @param nb           data length
 390  *  @return             0 or -1
 391  */
 392 static int usb_tx_block(wlan_private * priv, u8 * payload, u16 nb)
 393 {
 394         /* pointer to card structure */
 395         struct usb_card_rec *cardp = priv->card;
 396         int ret = -1;
 397
 398         /* check if device is removed */
 399         if (priv->adapter->surpriseremoved) {
 400                 lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
 401                 goto tx_ret;
 402         }
 403
 404         usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
 405                           usb_sndbulkpipe(cardp->udev,
 406                                           cardp->bulk_out_endpointAddr),
 407                           payload, nb, if_usb_write_bulk_callback, priv);
 408
 409         cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
 410
 411         if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
 412                 /*  transfer failed */
 413                 lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed\n");
 414                 ret = -1;
 415         } else {
 416                 /* lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb success\n"); */
 417                 ret = 0;
 418         }
 419
 420 tx_ret:
 421         return ret;
 422 }
 423
 424 static int __if_usb_submit_rx_urb(wlan_private * priv,
 425                                   void (*callbackfn)
 426                                   (struct urb *urb))
 427 {
 428         struct usb_card_rec *cardp = priv->card;
 429         struct sk_buff *skb;
 430         struct read_cb_info *rinfo = &cardp->rinfo;
 431         int ret = -1;
 432
 433         if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
 434                 lbs_pr_err("No free skb\n");
 435                 goto rx_ret;
 436         }
 437
 438         rinfo->skb = skb;
 439
 440         /* Fill the receive configuration URB and initialise the Rx call back */
 441         usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
 442                           usb_rcvbulkpipe(cardp->udev,
 443                                           cardp->bulk_in_endpointAddr),
 444                           (void *) (skb->tail + (size_t) IPFIELD_ALIGN_OFFSET),
 445                           MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
 446                           rinfo);
 447
 448         cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
 449
 450         /* lbs_deb_usbd(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb); */
 451         if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
 452                 /* handle failure conditions */
 453                 lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed\n");
 454                 ret = -1;
 455         } else {
 456                 /* lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB success\n"); */
 457                 ret = 0;
 458         }
 459
 460 rx_ret:
 461         return ret;
 462 }
 463
 464 static inline int if_usb_submit_rx_urb_fwload(wlan_private * priv)
 465 {
 466         return __if_usb_submit_rx_urb(priv, &if_usb_receive_fwload);
 467 }
 468
 469 static inline int if_usb_submit_rx_urb(wlan_private * priv)
 470 {
 471         return __if_usb_submit_rx_urb(priv, &if_usb_receive);
 472 }
 473
 474 static void if_usb_receive_fwload(struct urb *urb)
 475 {
 476         struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
 477         wlan_private *priv = rinfo->priv;
 478         struct sk_buff *skb = rinfo->skb;
 479         struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
 480         struct fwsyncheader *syncfwheader;
 481         struct bootcmdrespStr bootcmdresp;
 482
 483         if (urb->status) {
 484                 lbs_deb_usbd(&cardp->udev->dev,
 485                             "URB status is failed during fw load\n");
 486                 kfree_skb(skb);
 487                 return;
 488         }
 489
 490         if (cardp->bootcmdresp == 0) {
 491                 memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
 492                         sizeof(bootcmdresp));
 493                 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
 494                         kfree_skb(skb);
 495                         if_usb_submit_rx_urb_fwload(priv);
 496                         cardp->bootcmdresp = 1;
 497                         lbs_deb_usbd(&cardp->udev->dev,
 498                                     "Received valid boot command response\n");
 499                         return;
 500                 }
 501                 if (bootcmdresp.u32magicnumber != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
 502                         lbs_pr_info(
 503                                 "boot cmd response wrong magic number (0x%x)\n",
 504                                 le32_to_cpu(bootcmdresp.u32magicnumber));
 505                 } else if (bootcmdresp.u8cmd_tag != BOOT_CMD_FW_BY_USB) {
 506                         lbs_pr_info(
 507                                 "boot cmd response cmd_tag error (%d)\n",
 508                                 bootcmdresp.u8cmd_tag);
 509                 } else if (bootcmdresp.u8result != BOOT_CMD_RESP_OK) {
 510                         lbs_pr_info(
 511                                 "boot cmd response result error (%d)\n",
 512                                 bootcmdresp.u8result);
 513                 } else {
 514                         cardp->bootcmdresp = 1;
 515                         lbs_deb_usbd(&cardp->udev->dev,
 516                                     "Received valid boot command response\n");
 517                 }
 518                 kfree_skb(skb);
 519                 if_usb_submit_rx_urb_fwload(priv);
 520                 return;
 521         }
 522
 523         syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
 524         if (!syncfwheader) {
 525                 lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
 526                 kfree_skb(skb);
 527                 return;
 528         }
 529
 530         memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
 531                         sizeof(struct fwsyncheader));
 532
 533         if (!syncfwheader->cmd) {
 534                 /*
 535                 lbs_deb_usbd(&cardp->udev->dev,
 536                             "FW received Blk with correct CRC\n");
 537                 lbs_deb_usbd(&cardp->udev->dev,
 538                             "FW received Blk seqnum = %d\n",
 539                        syncfwheader->seqnum);
 540                 */
 541                 cardp->CRC_OK = 1;
 542         } else {
 543                 lbs_deb_usbd(&cardp->udev->dev,
 544                             "FW received Blk with CRC error\n");
 545                 cardp->CRC_OK = 0;
 546         }
 547
 548         kfree_skb(skb);
 549
 550         if (cardp->fwfinalblk) {
 551                 cardp->fwdnldover = 1;
 552                 goto exit;
 553         }
 554
 555         if_prog_firmware(priv);
 556
 557         if_usb_submit_rx_urb_fwload(priv);
 558 exit:
 559         kfree(syncfwheader);
 560
 561         return;
 562
 563 }
 564
 565 #define MRVDRV_MIN_PKT_LEN      30
 566
 567 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
 568                                        struct usb_card_rec *cardp,
 569                                        wlan_private *priv)
 570 {
 571         if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE +
 572             MESSAGE_HEADER_LEN || recvlength < MRVDRV_MIN_PKT_LEN) {
 573                 lbs_deb_usbd(&cardp->udev->dev,
 574                             "Packet length is Invalid\n");
 575                 kfree_skb(skb);
 576                 return;
 577         }
 578
 579         skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
 580         skb_put(skb, recvlength);
 581         skb_pull(skb, MESSAGE_HEADER_LEN);
 582         libertas_process_rxed_packet(priv, skb);
 583         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
 584 }
 585
 586 static inline void process_cmdrequest(int recvlength, u8 *recvbuff,
 587                                       struct sk_buff *skb,
 588                                       struct usb_card_rec *cardp,
 589                                       wlan_private *priv)
 590 {
 591         u8 *cmdbuf;
 592         if (recvlength > MRVDRV_SIZE_OF_CMD_BUFFER) {
 593                 lbs_deb_usbd(&cardp->udev->dev,
 594                             "The receive buffer is too large\n");
 595                 kfree_skb(skb);
 596                 return;
 597         }
 598
 599         if (!in_interrupt())
 600                 BUG();
 601
 602         spin_lock(&priv->adapter->driver_lock);
 603         /* take care of cur_cmd = NULL case by reading the
 604          * data to clear the interrupt */
 605         if (!priv->adapter->cur_cmd) {
 606                 cmdbuf = priv->upld_buf;
 607                 priv->adapter->hisregcpy &= ~MRVDRV_CMD_UPLD_RDY;
 608         } else
 609                 cmdbuf = priv->adapter->cur_cmd->bufvirtualaddr;
 610
 611         cardp->usb_int_cause |= MRVDRV_CMD_UPLD_RDY;
 612         priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
 613         memcpy(cmdbuf, recvbuff + MESSAGE_HEADER_LEN,
 614                priv->upld_len);
 615
 616         kfree_skb(skb);
 617         libertas_interrupt(priv->dev);
 618         spin_unlock(&priv->adapter->driver_lock);
 619
 620         lbs_deb_usbd(&cardp->udev->dev,
 621                     "Wake up main thread to handle cmd response\n");
 622
 623         return;
 624 }
 625
 626 /**
 627  *  @brief This function reads of the packet into the upload buff,
 628  *  wake up the main thread and initialise the Rx callack.
 629  *
 630  *  @param urb          pointer to struct urb
 631  *  @return             N/A
 632  */
 633 static void if_usb_receive(struct urb *urb)
 634 {
 635         struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
 636         wlan_private *priv = rinfo->priv;
 637         struct sk_buff *skb = rinfo->skb;
 638         struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
 639
 640         int recvlength = urb->actual_length;
 641         u8 *recvbuff = NULL;
 642         u32 recvtype = 0;
 643
 644         lbs_deb_enter(LBS_DEB_USB);
 645
 646         if (recvlength) {
 647                 __le32 tmp;
 648
 649                 if (urb->status) {
 650                         lbs_deb_usbd(&cardp->udev->dev,
 651                                     "URB status is failed\n");
 652                         kfree_skb(skb);
 653                         goto setup_for_next;
 654                 }
 655
 656                 recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
 657                 memcpy(&tmp, recvbuff, sizeof(u32));
 658                 recvtype = le32_to_cpu(tmp);
 659                 lbs_deb_usbd(&cardp->udev->dev,
 660                             "Recv length = 0x%x, Recv type = 0x%X\n",
 661                             recvlength, recvtype);
 662         } else if (urb->status)
 663                 goto rx_exit;
 664
 665         switch (recvtype) {
 666         case CMD_TYPE_DATA:
 667                 process_cmdtypedata(recvlength, skb, cardp, priv);
 668                 break;
 669
 670         case CMD_TYPE_REQUEST:
 671                 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
 672                 break;
 673
 674         case CMD_TYPE_INDICATION:
 675                 /* Event cause handling */
 676                 spin_lock(&priv->adapter->driver_lock);
 677                 cardp->usb_event_cause = le32_to_cpu(*(__le32 *) (recvbuff + MESSAGE_HEADER_LEN));
 678                 lbs_deb_usbd(&cardp->udev->dev,"**EVENT** 0x%X\n",
 679                             cardp->usb_event_cause);
 680                 if (cardp->usb_event_cause & 0xffff0000) {
 681                         libertas_send_tx_feedback(priv);
 682                         spin_unlock(&priv->adapter->driver_lock);
 683                         break;
 684                 }
 685                 cardp->usb_event_cause <<= 3;
 686                 cardp->usb_int_cause |= MRVDRV_CARDEVENT;
 687                 kfree_skb(skb);
 688                 libertas_interrupt(priv->dev);
 689                 spin_unlock(&priv->adapter->driver_lock);
 690                 goto rx_exit;
 691         default:
 692                 lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
 693                              recvtype);
 694                 kfree_skb(skb);
 695                 break;
 696         }
 697
 698 setup_for_next:
 699         if_usb_submit_rx_urb(priv);
 700 rx_exit:
 701         lbs_deb_leave(LBS_DEB_USB);
 702 }
 703
 704 /**
 705  *  @brief This function downloads data to FW
 706  *  @param priv         pointer to wlan_private structure
 707  *  @param type         type of data
 708  *  @param buf          pointer to data buffer
 709  *  @param len          number of bytes
 710  *  @return             0 or -1
 711  */
 712 static int if_usb_host_to_card(wlan_private * priv, u8 type, u8 * payload, u16 nb)
 713 {
 714         struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
 715
 716         lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
 717         lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
 718
 719         if (type == MVMS_CMD) {
 720                 __le32 tmp = cpu_to_le32(CMD_TYPE_REQUEST);
 721                 priv->dnld_sent = DNLD_CMD_SENT;
 722                 memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
 723                        MESSAGE_HEADER_LEN);
 724
 725         } else {
 726                 __le32 tmp = cpu_to_le32(CMD_TYPE_DATA);
 727                 priv->dnld_sent = DNLD_DATA_SENT;
 728                 memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
 729                        MESSAGE_HEADER_LEN);
 730         }
 731
 732         memcpy((cardp->bulk_out_buffer + MESSAGE_HEADER_LEN), payload, nb);
 733
 734         return usb_tx_block(priv, cardp->bulk_out_buffer,
 735                             nb + MESSAGE_HEADER_LEN);
 736 }
 737
 738 /* called with adapter->driver_lock held */
 739 static int if_usb_get_int_status(wlan_private * priv, u8 * ireg)
 740 {
 741         struct usb_card_rec *cardp = priv->card;
 742
 743         *ireg = cardp->usb_int_cause;
 744         cardp->usb_int_cause = 0;
 745
 746         lbs_deb_usbd(&cardp->udev->dev,"Int cause is 0x%X\n", *ireg);
 747
 748         return 0;
 749 }
 750
 751 static int if_usb_read_event_cause(wlan_private * priv)
 752 {
 753         struct usb_card_rec *cardp = priv->card;
 754         priv->adapter->eventcause = cardp->usb_event_cause;
 755         /* Re-submit rx urb here to avoid event lost issue */
 756         if_usb_submit_rx_urb(priv);
 757         return 0;
 758 }
 759
 760 static int if_usb_unregister_dev(wlan_private * priv)
 761 {
 762         int ret = 0;
 763
 764         /* Need to send a Reset command to device before USB resources freed
 765          * and wlan_remove_card() called, then device can handle FW download
 766          * again.
 767          */
 768         if (priv)
 769                 libertas_reset_device(priv);
 770
 771         return ret;
 772 }
 773
 774
 775 /**
 776  *  @brief  This function register usb device and initialize parameter
 777  *  @param              priv pointer to wlan_private
 778  *  @return             0 or -1
 779  */
 780 static int if_usb_register_dev(wlan_private * priv)
 781 {
 782         struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
 783
 784         lbs_deb_enter(LBS_DEB_USB);
 785
 786         cardp->priv = priv;
 787         cardp->eth_dev = priv->dev;
 788         priv->hotplug_device = &(cardp->udev->dev);
 789
 790         lbs_deb_usbd(&cardp->udev->dev, "udev pointer is at %p\n",
 791                     cardp->udev);
 792
 793         lbs_deb_leave(LBS_DEB_USB);
 794         return 0;
 795 }
 796
 797 /**
 798  *  @brief This function issues Boot command to the Boot2 code
 799  *  @param ivalue   1:Boot from FW by USB-Download
 800  *                  2:Boot from FW in EEPROM
 801  *  @return             0
 802  */
 803 static int if_usb_issue_boot_command(wlan_private *priv, int ivalue)
 804 {
 805         struct usb_card_rec     *cardp = priv->card;
 806         struct bootcmdstr       sbootcmd;
 807         int i;
 808
 809         /* Prepare command */
 810         sbootcmd.u32magicnumber = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
 811         sbootcmd.u8cmd_tag = ivalue;
 812         for (i=0; i<11; i++)
 813                 sbootcmd.au8dumy[i]=0x00;
 814         memcpy(cardp->bulk_out_buffer, &sbootcmd, sizeof(struct bootcmdstr));
 815
 816         /* Issue command */
 817         usb_tx_block(priv, cardp->bulk_out_buffer, sizeof(struct bootcmdstr));
 818
 819         return 0;
 820 }
 821
 822
 823 static int if_usb_do_prog_firmware(wlan_private * priv)
 824 {
 825         struct usb_card_rec *cardp = priv->card;
 826         int i = 0;
 827         static int reset_count = 10;
 828         int ret = 0;
 829
 830         lbs_deb_enter(LBS_DEB_USB);
 831
 832         cardp->rinfo.priv = priv;
 833
 834 restart:
 835         if (if_usb_submit_rx_urb_fwload(priv) < 0) {
 836                 lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
 837                 ret = -1;
 838                 goto done;
 839         }
 840
 841         cardp->bootcmdresp = 0;
 842         do {
 843                 int j = 0;
 844                 i++;
 845                 /* Issue Boot command = 1, Boot from Download-FW */
 846                 if_usb_issue_boot_command(priv, BOOT_CMD_FW_BY_USB);
 847                 /* wait for command response */
 848                 do {
 849                         j++;
 850                         msleep_interruptible(100);
 851                 } while (cardp->bootcmdresp == 0 && j < 10);
 852         } while (cardp->bootcmdresp == 0 && i < 5);
 853
 854         if (cardp->bootcmdresp == 0) {
 855                 if (--reset_count >= 0) {
 856                         if_usb_reset_device(priv);
 857                         goto restart;
 858                 }
 859                 return -1;
 860         }
 861
 862         i = 0;
 863         priv->adapter->fw_ready = 0;
 864
 865         cardp->totalbytes = 0;
 866         cardp->fwlastblksent = 0;
 867         cardp->CRC_OK = 1;
 868         cardp->fwdnldover = 0;
 869         cardp->fwseqnum = -1;
 870         cardp->totalbytes = 0;
 871         cardp->fwfinalblk = 0;
 872
 873         if_prog_firmware(priv);
 874
 875         do {
 876                 lbs_deb_usbd(&cardp->udev->dev,"Wlan sched timeout\n");
 877                 i++;
 878                 msleep_interruptible(100);
 879                 if (priv->adapter->surpriseremoved || i >= 20)
 880                         break;
 881         } while (!cardp->fwdnldover);
 882
 883         if (!cardp->fwdnldover) {
 884                 lbs_pr_info("failed to load fw, resetting device!\n");
 885                 if (--reset_count >= 0) {
 886                         if_usb_reset_device(priv);
 887                         goto restart;
 888                 }
 889
 890                 lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
 891                 ret = -1;
 892                 goto done;
 893         }
 894
 895         if_usb_submit_rx_urb(priv);
 896
 897         /* Delay 200 ms to waiting for the FW ready */
 898         msleep_interruptible(200);
 899
 900         priv->adapter->fw_ready = 1;
 901
 902 done:
 903         lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
 904         return ret;
 905 }
 906
 907 /**
 908  *  @brief This function checks the validity of Boot2/FW image.
 909  *
 910  *  @param data              pointer to image
 911  *         len               image length
 912  *  @return     0 or -1
 913  */
 914 static int check_fwfile_format(u8 *data, u32 totlen)
 915 {
 916         u32 bincmd, exit;
 917         u32 blksize, offset, len;
 918         int ret;
 919
 920         ret = 1;
 921         exit = len = 0;
 922
 923         do {
 924                 struct fwheader *fwh = (void *)data;
 925
 926                 bincmd = le32_to_cpu(fwh->dnldcmd);
 927                 blksize = le32_to_cpu(fwh->datalength);
 928                 switch (bincmd) {
 929                 case FW_HAS_DATA_TO_RECV:
 930                         offset = sizeof(struct fwheader) + blksize;
 931                         data += offset;
 932                         len += offset;
 933                         if (len >= totlen)
 934                                 exit = 1;
 935                         break;
 936                 case FW_HAS_LAST_BLOCK:
 937                         exit = 1;
 938                         ret = 0;
 939                         break;
 940                 default:
 941                         exit = 1;
 942                         break;
 943                 }
 944         } while (!exit);
 945
 946         if (ret)
 947                 lbs_pr_err("firmware file format check FAIL\n");
 948         else
 949                 lbs_deb_fw("firmware file format check PASS\n");
 950
 951         return ret;
 952 }
 953
 954
 955 static int if_usb_prog_firmware(wlan_private *priv)
 956 {
 957         int ret = -1;
 958
 959         lbs_deb_enter(LBS_DEB_FW);
 960
 961         if ((ret = request_firmware(&priv->firmware, libertas_fw_name,
 962                                     priv->hotplug_device)) < 0) {
 963                 lbs_pr_err("request_firmware() failed with %#x\n", ret);
 964                 lbs_pr_err("firmware %s not found\n", libertas_fw_name);
 965                 goto done;
 966         }
 967
 968         if (check_fwfile_format(priv->firmware->data, priv->firmware->size)) {
 969                 release_firmware(priv->firmware);
 970                 goto done;
 971         }
 972
 973         ret = if_usb_do_prog_firmware(priv);
 974
 975         release_firmware(priv->firmware);
 976 done:
 977         return ret;
 978 }
 979
 980
 981 #ifdef CONFIG_PM
 982 static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
 983 {
 984         struct usb_card_rec *cardp = usb_get_intfdata(intf);
 985         wlan_private *priv = cardp->priv;
 986
 987         lbs_deb_enter(LBS_DEB_USB);
 988
 989         if (priv->adapter->psstate != PS_STATE_FULL_POWER)
 990                 return -1;
 991
 992         if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
 993                 /* Mesh autostart must be activated while sleeping
 994                  * On resume it will go back to the current state
 995                  */
 996                 struct cmd_ds_mesh_access mesh_access;
 997                 memset(&mesh_access, 0, sizeof(mesh_access));
 998                 mesh_access.data[0] = cpu_to_le32(1);
 999                 libertas_prepare_and_send_command(priv,
1000                                 CMD_MESH_ACCESS,
1001                                 CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
1002                                 CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
1003         }
1004
1005         netif_device_detach(cardp->eth_dev);
1006         netif_device_detach(priv->mesh_dev);
1007
1008         /* Unlink tx & rx urb */
1009         usb_kill_urb(cardp->tx_urb);
1010         usb_kill_urb(cardp->rx_urb);
1011
1012         cardp->rx_urb_recall = 1;
1013
1014         lbs_deb_leave(LBS_DEB_USB);
1015         return 0;
1016 }
1017
1018 static int if_usb_resume(struct usb_interface *intf)
1019 {
1020         struct usb_card_rec *cardp = usb_get_intfdata(intf);
1021         wlan_private *priv = cardp->priv;
1022
1023         lbs_deb_enter(LBS_DEB_USB);
1024
1025         cardp->rx_urb_recall = 0;
1026
1027         if_usb_submit_rx_urb(cardp->priv);
1028
1029         netif_device_attach(cardp->eth_dev);
1030         netif_device_attach(priv->mesh_dev);
1031
1032         if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
1033                 /* Mesh autostart was activated while sleeping
1034                  * Disable it if appropriate
1035                  */
1036                 struct cmd_ds_mesh_access mesh_access;
1037                 memset(&mesh_access, 0, sizeof(mesh_access));
1038                 mesh_access.data[0] = cpu_to_le32(0);
1039                 libertas_prepare_and_send_command(priv,
1040                                 CMD_MESH_ACCESS,
1041                                 CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
1042                                 CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
1043         }
1044
1045         lbs_deb_leave(LBS_DEB_USB);
1046         return 0;
1047 }
1048 #else
1049 #define if_usb_suspend NULL
1050 #define if_usb_resume NULL
1051 #endif
1052
1053 static struct usb_driver if_usb_driver = {
1054         /* driver name */
1055         .name = usbdriver_name,
1056         /* probe function name */
1057         .probe = if_usb_probe,
1058         /* disconnect function  name */
1059         .disconnect = if_usb_disconnect,
1060         /* device signature table */
1061         .id_table = if_usb_table,
1062         .suspend = if_usb_suspend,
1063         .resume = if_usb_resume,
1064 };
1065
1066 static int if_usb_init_module(void)
1067 {
1068         int ret = 0;
1069
1070         lbs_deb_enter(LBS_DEB_MAIN);
1071
1072         if (libertas_fw_name == NULL) {
1073                 libertas_fw_name = default_fw_name;
1074         }
1075
1076         ret = usb_register(&if_usb_driver);
1077
1078         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
1079         return ret;
1080 }
1081
1082 static void if_usb_exit_module(void)
1083 {
1084         struct usb_card_rec *cardp, *cardp_temp;
1085
1086         lbs_deb_enter(LBS_DEB_MAIN);
1087
1088         list_for_each_entry_safe(cardp, cardp_temp, &usb_devices, list)
1089                 libertas_reset_device((wlan_private *) cardp->priv);
1090
1091         /* API unregisters the driver from USB subsystem */
1092         usb_deregister(&if_usb_driver);
1093
1094         lbs_deb_leave(LBS_DEB_MAIN);
1095 }
1096
1097 module_init(if_usb_init_module);
1098 module_exit(if_usb_exit_module);
1099
1100 MODULE_DESCRIPTION("8388 USB WLAN Driver");
1101 MODULE_AUTHOR("Marvell International Ltd.");
1102 MODULE_LICENSE("GPL");