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