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