drivers/net/wireless/marvell/libertas_tf/if_usb.c

   1 /*
   2  *  Copyright (C) 2008, cozybit Inc.
   3  *  Copyright (C) 2003-2006, Marvell International Ltd.
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2 of the License, or (at
   8  *  your option) any later version.
   9  */
  10 #define DRV_NAME "lbtf_usb"
  11
  12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  13
  14 #include "libertas_tf.h"
  15 #include "if_usb.h"
  16
  17 #include <linux/delay.h>
  18 #include <linux/module.h>
  19 #include <linux/firmware.h>
  20 #include <linux/netdevice.h>
  21 #include <linux/slab.h>
  22 #include <linux/usb.h>
  23
  24 #define INSANEDEBUG     0
  25 #define lbtf_deb_usb2(...) do { if (INSANEDEBUG) lbtf_deb_usbd(__VA_ARGS__); } while (0)
  26
  27 #define MESSAGE_HEADER_LEN      4
  28
  29 static char *lbtf_fw_name = "lbtf_usb.bin";
  30 module_param_named(fw_name, lbtf_fw_name, charp, 0644);
  31
  32 MODULE_FIRMWARE("lbtf_usb.bin");
  33
  34 static const struct usb_device_id if_usb_table[] = {
  35         /* Enter the device signature inside */
  36         { USB_DEVICE(0x1286, 0x2001) },
  37         { USB_DEVICE(0x05a3, 0x8388) },
  38         {}      /* Terminating entry */
  39 };
  40
  41 MODULE_DEVICE_TABLE(usb, if_usb_table);
  42
  43 static void if_usb_receive(struct urb *urb);
  44 static void if_usb_receive_fwload(struct urb *urb);
  45 static int if_usb_prog_firmware(struct if_usb_card *cardp);
  46 static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,
  47                                uint8_t *payload, uint16_t nb);
  48 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
  49                         uint16_t nb, u8 data);
  50 static void if_usb_free(struct if_usb_card *cardp);
  51 static int if_usb_submit_rx_urb(struct if_usb_card *cardp);
  52 static int if_usb_reset_device(struct if_usb_card *cardp);
  53
  54 /**
  55  *  if_usb_wrike_bulk_callback -  call back to handle URB status
  56  *
  57  *  @param urb          pointer to urb structure
  58  */
  59 static void if_usb_write_bulk_callback(struct urb *urb)
  60 {
  61         if (urb->status != 0) {
  62                 /* print the failure status number for debug */
  63                 pr_info("URB in failure status: %d\n", urb->status);
  64         } else {
  65                 lbtf_deb_usb2(&urb->dev->dev, "URB status is successful\n");
  66                 lbtf_deb_usb2(&urb->dev->dev, "Actual length transmitted %d\n",
  67                              urb->actual_length);
  68         }
  69 }
  70
  71 /**
  72  *  if_usb_free - free tx/rx urb, skb and rx buffer
  73  *
  74  *  @param cardp        pointer if_usb_card
  75  */
  76 static void if_usb_free(struct if_usb_card *cardp)
  77 {
  78         lbtf_deb_enter(LBTF_DEB_USB);
  79
  80         /* Unlink tx & rx urb */
  81         usb_kill_urb(cardp->tx_urb);
  82         usb_kill_urb(cardp->rx_urb);
  83         usb_kill_urb(cardp->cmd_urb);
  84
  85         usb_free_urb(cardp->tx_urb);
  86         cardp->tx_urb = NULL;
  87
  88         usb_free_urb(cardp->rx_urb);
  89         cardp->rx_urb = NULL;
  90
  91         usb_free_urb(cardp->cmd_urb);
  92         cardp->cmd_urb = NULL;
  93
  94         kfree(cardp->ep_out_buf);
  95         cardp->ep_out_buf = NULL;
  96
  97         lbtf_deb_leave(LBTF_DEB_USB);
  98 }
  99
 100 static void if_usb_setup_firmware(struct lbtf_private *priv)
 101 {
 102         struct if_usb_card *cardp = priv->card;
 103         struct cmd_ds_set_boot2_ver b2_cmd;
 104
 105         lbtf_deb_enter(LBTF_DEB_USB);
 106
 107         if_usb_submit_rx_urb(cardp);
 108         b2_cmd.hdr.size = cpu_to_le16(sizeof(b2_cmd));
 109         b2_cmd.action = 0;
 110         b2_cmd.version = cardp->boot2_version;
 111
 112         if (lbtf_cmd_with_response(priv, CMD_SET_BOOT2_VER, &b2_cmd))
 113                 lbtf_deb_usb("Setting boot2 version failed\n");
 114
 115         lbtf_deb_leave(LBTF_DEB_USB);
 116 }
 117
 118 static void if_usb_fw_timeo(struct timer_list *t)
 119 {
 120         struct if_usb_card *cardp = from_timer(cardp, t, fw_timeout);
 121
 122         lbtf_deb_enter(LBTF_DEB_USB);
 123         if (!cardp->fwdnldover) {
 124                 /* Download timed out */
 125                 cardp->priv->surpriseremoved = 1;
 126                 pr_err("Download timed out\n");
 127         } else {
 128                 lbtf_deb_usb("Download complete, no event. Assuming success\n");
 129         }
 130         wake_up(&cardp->fw_wq);
 131         lbtf_deb_leave(LBTF_DEB_USB);
 132 }
 133
 134 /**
 135  *  if_usb_probe - sets the configuration values
 136  *
 137  *  @ifnum      interface number
 138  *  @id         pointer to usb_device_id
 139  *
 140  *  Returns: 0 on success, error code on failure
 141  */
 142 static int if_usb_probe(struct usb_interface *intf,
 143                         const struct usb_device_id *id)
 144 {
 145         struct usb_device *udev;
 146         struct usb_host_interface *iface_desc;
 147         struct usb_endpoint_descriptor *endpoint;
 148         struct lbtf_private *priv;
 149         struct if_usb_card *cardp;
 150         int i;
 151
 152         lbtf_deb_enter(LBTF_DEB_USB);
 153         udev = interface_to_usbdev(intf);
 154
 155         cardp = kzalloc(sizeof(struct if_usb_card), GFP_KERNEL);
 156         if (!cardp)
 157                 goto error;
 158
 159         timer_setup(&cardp->fw_timeout, if_usb_fw_timeo, 0);
 160         init_waitqueue_head(&cardp->fw_wq);
 161
 162         cardp->udev = udev;
 163         iface_desc = intf->cur_altsetting;
 164
 165         lbtf_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
 166                      " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
 167                      le16_to_cpu(udev->descriptor.bcdUSB),
 168                      udev->descriptor.bDeviceClass,
 169                      udev->descriptor.bDeviceSubClass,
 170                      udev->descriptor.bDeviceProtocol);
 171
 172         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 173                 endpoint = &iface_desc->endpoint[i].desc;
 174                 if (usb_endpoint_is_bulk_in(endpoint)) {
 175                         cardp->ep_in_size =
 176                                 le16_to_cpu(endpoint->wMaxPacketSize);
 177                         cardp->ep_in = usb_endpoint_num(endpoint);
 178
 179                         lbtf_deb_usbd(&udev->dev, "in_endpoint = %d\n",
 180                                 cardp->ep_in);
 181                         lbtf_deb_usbd(&udev->dev, "Bulk in size is %d\n",
 182                                 cardp->ep_in_size);
 183                 } else if (usb_endpoint_is_bulk_out(endpoint)) {
 184                         cardp->ep_out_size =
 185                                 le16_to_cpu(endpoint->wMaxPacketSize);
 186                         cardp->ep_out = usb_endpoint_num(endpoint);
 187
 188                         lbtf_deb_usbd(&udev->dev, "out_endpoint = %d\n",
 189                                 cardp->ep_out);
 190                         lbtf_deb_usbd(&udev->dev, "Bulk out size is %d\n",
 191                                 cardp->ep_out_size);
 192                 }
 193         }
 194         if (!cardp->ep_out_size || !cardp->ep_in_size) {
 195                 lbtf_deb_usbd(&udev->dev, "Endpoints not found\n");
 196                 /* Endpoints not found */
 197                 goto dealloc;
 198         }
 199
 200         cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
 201         if (!cardp->rx_urb)
 202                 goto dealloc;
 203
 204         cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
 205         if (!cardp->tx_urb)
 206                 goto dealloc;
 207
 208         cardp->cmd_urb = usb_alloc_urb(0, GFP_KERNEL);
 209         if (!cardp->cmd_urb)
 210                 goto dealloc;
 211
 212         cardp->ep_out_buf = kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE,
 213                                     GFP_KERNEL);
 214         if (!cardp->ep_out_buf) {
 215                 lbtf_deb_usbd(&udev->dev, "Could not allocate buffer\n");
 216                 goto dealloc;
 217         }
 218
 219         priv = lbtf_add_card(cardp, &udev->dev);
 220         if (!priv)
 221                 goto dealloc;
 222
 223         cardp->priv = priv;
 224
 225         priv->hw_host_to_card = if_usb_host_to_card;
 226         priv->hw_prog_firmware = if_usb_prog_firmware;
 227         priv->hw_reset_device = if_usb_reset_device;
 228         cardp->boot2_version = udev->descriptor.bcdDevice;
 229
 230         usb_get_dev(udev);
 231         usb_set_intfdata(intf, cardp);
 232
 233         return 0;
 234
 235 dealloc:
 236         if_usb_free(cardp);
 237 error:
 238 lbtf_deb_leave(LBTF_DEB_MAIN);
 239         return -ENOMEM;
 240 }
 241
 242 /**
 243  *  if_usb_disconnect -  free resource and cleanup
 244  *
 245  *  @intf       USB interface structure
 246  */
 247 static void if_usb_disconnect(struct usb_interface *intf)
 248 {
 249         struct if_usb_card *cardp = usb_get_intfdata(intf);
 250         struct lbtf_private *priv = cardp->priv;
 251
 252         lbtf_deb_enter(LBTF_DEB_MAIN);
 253
 254         if_usb_reset_device(cardp);
 255
 256         if (priv)
 257                 lbtf_remove_card(priv);
 258
 259         /* Unlink and free urb */
 260         if_usb_free(cardp);
 261
 262         usb_set_intfdata(intf, NULL);
 263         usb_put_dev(interface_to_usbdev(intf));
 264
 265         lbtf_deb_leave(LBTF_DEB_MAIN);
 266 }
 267
 268 /**
 269  *  if_usb_send_fw_pkt -  This function downloads the FW
 270  *
 271  *  @priv       pointer to struct lbtf_private
 272  *
 273  *  Returns: 0
 274  */
 275 static int if_usb_send_fw_pkt(struct if_usb_card *cardp)
 276 {
 277         struct fwdata *fwdata = cardp->ep_out_buf;
 278         u8 *firmware = (u8 *) cardp->fw->data;
 279
 280         lbtf_deb_enter(LBTF_DEB_FW);
 281
 282         /* If we got a CRC failure on the last block, back
 283            up and retry it */
 284         if (!cardp->CRC_OK) {
 285                 cardp->totalbytes = cardp->fwlastblksent;
 286                 cardp->fwseqnum--;
 287         }
 288
 289         lbtf_deb_usb2(&cardp->udev->dev, "totalbytes = %d\n",
 290                      cardp->totalbytes);
 291
 292         /* struct fwdata (which we sent to the card) has an
 293            extra __le32 field in between the header and the data,
 294            which is not in the struct fwheader in the actual
 295            firmware binary. Insert the seqnum in the middle... */
 296         memcpy(&fwdata->hdr, &firmware[cardp->totalbytes],
 297                sizeof(struct fwheader));
 298
 299         cardp->fwlastblksent = cardp->totalbytes;
 300         cardp->totalbytes += sizeof(struct fwheader);
 301
 302         memcpy(fwdata->data, &firmware[cardp->totalbytes],
 303                le32_to_cpu(fwdata->hdr.datalength));
 304
 305         lbtf_deb_usb2(&cardp->udev->dev, "Data length = %d\n",
 306                      le32_to_cpu(fwdata->hdr.datalength));
 307
 308         fwdata->seqnum = cpu_to_le32(++cardp->fwseqnum);
 309         cardp->totalbytes += le32_to_cpu(fwdata->hdr.datalength);
 310
 311         usb_tx_block(cardp, cardp->ep_out_buf, sizeof(struct fwdata) +
 312                      le32_to_cpu(fwdata->hdr.datalength), 0);
 313
 314         if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
 315                 lbtf_deb_usb2(&cardp->udev->dev, "There are data to follow\n");
 316                 lbtf_deb_usb2(&cardp->udev->dev,
 317                         "seqnum = %d totalbytes = %d\n",
 318                         cardp->fwseqnum, cardp->totalbytes);
 319         } else if (fwdata->hdr.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
 320                 lbtf_deb_usb2(&cardp->udev->dev,
 321                         "Host has finished FW downloading\n");
 322                 lbtf_deb_usb2(&cardp->udev->dev, "Donwloading FW JUMP BLOCK\n");
 323
 324                 /* Host has finished FW downloading
 325                  * Donwloading FW JUMP BLOCK
 326                  */
 327                 cardp->fwfinalblk = 1;
 328         }
 329
 330         lbtf_deb_usb2(&cardp->udev->dev, "Firmware download done; size %d\n",
 331                      cardp->totalbytes);
 332
 333         lbtf_deb_leave(LBTF_DEB_FW);
 334         return 0;
 335 }
 336
 337 static int if_usb_reset_device(struct if_usb_card *cardp)
 338 {
 339         struct cmd_ds_802_11_reset *cmd = cardp->ep_out_buf + 4;
 340         int ret;
 341
 342         lbtf_deb_enter(LBTF_DEB_USB);
 343
 344         *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
 345
 346         cmd->hdr.command = cpu_to_le16(CMD_802_11_RESET);
 347         cmd->hdr.size = cpu_to_le16(sizeof(struct cmd_ds_802_11_reset));
 348         cmd->hdr.result = cpu_to_le16(0);
 349         cmd->hdr.seqnum = cpu_to_le16(0x5a5a);
 350         cmd->action = cpu_to_le16(CMD_ACT_HALT);
 351         usb_tx_block(cardp, cardp->ep_out_buf,
 352                      4 + sizeof(struct cmd_ds_802_11_reset), 0);
 353
 354         msleep(100);
 355         ret = usb_reset_device(cardp->udev);
 356         msleep(100);
 357
 358         lbtf_deb_leave_args(LBTF_DEB_USB, "ret %d", ret);
 359
 360         return ret;
 361 }
 362
 363 /**
 364  *  usb_tx_block - transfer data to the device
 365  *
 366  *  @priv       pointer to struct lbtf_private
 367  *  @payload    pointer to payload data
 368  *  @nb         data length
 369  *  @data       non-zero for data, zero for commands
 370  *
 371  *  Returns: 0 on success, nonzero otherwise.
 372  */
 373 static int usb_tx_block(struct if_usb_card *cardp, uint8_t *payload,
 374                         uint16_t nb, u8 data)
 375 {
 376         int ret = -1;
 377         struct urb *urb;
 378
 379         lbtf_deb_enter(LBTF_DEB_USB);
 380         /* check if device is removed */
 381         if (cardp->priv->surpriseremoved) {
 382                 lbtf_deb_usbd(&cardp->udev->dev, "Device removed\n");
 383                 goto tx_ret;
 384         }
 385
 386         if (data)
 387                 urb = cardp->tx_urb;
 388         else
 389                 urb = cardp->cmd_urb;
 390
 391         usb_fill_bulk_urb(urb, cardp->udev,
 392                           usb_sndbulkpipe(cardp->udev,
 393                                           cardp->ep_out),
 394                           payload, nb, if_usb_write_bulk_callback, cardp);
 395
 396         urb->transfer_flags |= URB_ZERO_PACKET;
 397
 398         if (usb_submit_urb(urb, GFP_ATOMIC)) {
 399                 lbtf_deb_usbd(&cardp->udev->dev,
 400                         "usb_submit_urb failed: %d\n", ret);
 401                 goto tx_ret;
 402         }
 403
 404         lbtf_deb_usb2(&cardp->udev->dev, "usb_submit_urb success\n");
 405
 406         ret = 0;
 407
 408 tx_ret:
 409         lbtf_deb_leave(LBTF_DEB_USB);
 410         return ret;
 411 }
 412
 413 static int __if_usb_submit_rx_urb(struct if_usb_card *cardp,
 414                                   void (*callbackfn)(struct urb *urb))
 415 {
 416         struct sk_buff *skb;
 417         int ret = -1;
 418
 419         lbtf_deb_enter(LBTF_DEB_USB);
 420
 421         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
 422         if (!skb) {
 423                 pr_err("No free skb\n");
 424                 lbtf_deb_leave(LBTF_DEB_USB);
 425                 return -1;
 426         }
 427
 428         cardp->rx_skb = skb;
 429
 430         /* Fill the receive configuration URB and initialise the Rx call back */
 431         usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
 432                           usb_rcvbulkpipe(cardp->udev, cardp->ep_in),
 433                           skb_tail_pointer(skb),
 434                           MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn, cardp);
 435
 436         lbtf_deb_usb2(&cardp->udev->dev, "Pointer for rx_urb %p\n",
 437                 cardp->rx_urb);
 438         ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC);
 439         if (ret) {
 440                 lbtf_deb_usbd(&cardp->udev->dev,
 441                         "Submit Rx URB failed: %d\n", ret);
 442                 kfree_skb(skb);
 443                 cardp->rx_skb = NULL;
 444                 lbtf_deb_leave(LBTF_DEB_USB);
 445                 return -1;
 446         } else {
 447                 lbtf_deb_usb2(&cardp->udev->dev, "Submit Rx URB success\n");
 448                 lbtf_deb_leave(LBTF_DEB_USB);
 449                 return 0;
 450         }
 451 }
 452
 453 static int if_usb_submit_rx_urb_fwload(struct if_usb_card *cardp)
 454 {
 455         return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
 456 }
 457
 458 static int if_usb_submit_rx_urb(struct if_usb_card *cardp)
 459 {
 460         return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
 461 }
 462
 463 static void if_usb_receive_fwload(struct urb *urb)
 464 {
 465         struct if_usb_card *cardp = urb->context;
 466         struct sk_buff *skb = cardp->rx_skb;
 467         struct fwsyncheader *syncfwheader;
 468         struct bootcmdresp bcmdresp;
 469
 470         lbtf_deb_enter(LBTF_DEB_USB);
 471         if (urb->status) {
 472                 lbtf_deb_usbd(&cardp->udev->dev,
 473                              "URB status is failed during fw load\n");
 474                 kfree_skb(skb);
 475                 lbtf_deb_leave(LBTF_DEB_USB);
 476                 return;
 477         }
 478
 479         if (cardp->fwdnldover) {
 480                 __le32 *tmp = (__le32 *)(skb->data);
 481
 482                 if (tmp[0] == cpu_to_le32(CMD_TYPE_INDICATION) &&
 483                     tmp[1] == cpu_to_le32(MACREG_INT_CODE_FIRMWARE_READY)) {
 484                         /* Firmware ready event received */
 485                         pr_info("Firmware ready event received\n");
 486                         wake_up(&cardp->fw_wq);
 487                 } else {
 488                         lbtf_deb_usb("Waiting for confirmation; got %x %x\n",
 489                                     le32_to_cpu(tmp[0]), le32_to_cpu(tmp[1]));
 490                         if_usb_submit_rx_urb_fwload(cardp);
 491                 }
 492                 kfree_skb(skb);
 493                 lbtf_deb_leave(LBTF_DEB_USB);
 494                 return;
 495         }
 496         if (cardp->bootcmdresp <= 0) {
 497                 memcpy(&bcmdresp, skb->data, sizeof(bcmdresp));
 498
 499                 if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
 500                         kfree_skb(skb);
 501                         if_usb_submit_rx_urb_fwload(cardp);
 502                         cardp->bootcmdresp = 1;
 503                         /* Received valid boot command response */
 504                         lbtf_deb_usbd(&cardp->udev->dev,
 505                                      "Received valid boot command response\n");
 506                         lbtf_deb_leave(LBTF_DEB_USB);
 507                         return;
 508                 }
 509                 if (bcmdresp.magic != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
 510                         if (bcmdresp.magic == cpu_to_le32(CMD_TYPE_REQUEST) ||
 511                             bcmdresp.magic == cpu_to_le32(CMD_TYPE_DATA) ||
 512                             bcmdresp.magic == cpu_to_le32(CMD_TYPE_INDICATION)) {
 513                                 if (!cardp->bootcmdresp)
 514                                         pr_info("Firmware already seems alive; resetting\n");
 515                                 cardp->bootcmdresp = -1;
 516                         } else {
 517                                 pr_info("boot cmd response wrong magic number (0x%x)\n",
 518                                             le32_to_cpu(bcmdresp.magic));
 519                         }
 520                 } else if (bcmdresp.cmd != BOOT_CMD_FW_BY_USB) {
 521                         pr_info("boot cmd response cmd_tag error (%d)\n",
 522                                 bcmdresp.cmd);
 523                 } else if (bcmdresp.result != BOOT_CMD_RESP_OK) {
 524                         pr_info("boot cmd response result error (%d)\n",
 525                                 bcmdresp.result);
 526                 } else {
 527                         cardp->bootcmdresp = 1;
 528                         lbtf_deb_usbd(&cardp->udev->dev,
 529                                 "Received valid boot command response\n");
 530                 }
 531
 532                 kfree_skb(skb);
 533                 if_usb_submit_rx_urb_fwload(cardp);
 534                 lbtf_deb_leave(LBTF_DEB_USB);
 535                 return;
 536         }
 537
 538         syncfwheader = kmemdup(skb->data, sizeof(struct fwsyncheader),
 539                                GFP_ATOMIC);
 540         if (!syncfwheader) {
 541                 lbtf_deb_usbd(&cardp->udev->dev,
 542                         "Failure to allocate syncfwheader\n");
 543                 kfree_skb(skb);
 544                 lbtf_deb_leave(LBTF_DEB_USB);
 545                 return;
 546         }
 547
 548         if (!syncfwheader->cmd) {
 549                 lbtf_deb_usb2(&cardp->udev->dev,
 550                         "FW received Blk with correct CRC\n");
 551                 lbtf_deb_usb2(&cardp->udev->dev,
 552                         "FW received Blk seqnum = %d\n",
 553                         le32_to_cpu(syncfwheader->seqnum));
 554                 cardp->CRC_OK = 1;
 555         } else {
 556                 lbtf_deb_usbd(&cardp->udev->dev,
 557                         "FW received Blk with CRC error\n");
 558                 cardp->CRC_OK = 0;
 559         }
 560
 561         kfree_skb(skb);
 562
 563         /* reschedule timer for 200ms hence */
 564         mod_timer(&cardp->fw_timeout, jiffies + (HZ/5));
 565
 566         if (cardp->fwfinalblk) {
 567                 cardp->fwdnldover = 1;
 568                 goto exit;
 569         }
 570
 571         if_usb_send_fw_pkt(cardp);
 572
 573  exit:
 574         if_usb_submit_rx_urb_fwload(cardp);
 575
 576         kfree(syncfwheader);
 577
 578         lbtf_deb_leave(LBTF_DEB_USB);
 579 }
 580
 581 #define MRVDRV_MIN_PKT_LEN      30
 582
 583 static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
 584                                        struct if_usb_card *cardp,
 585                                        struct lbtf_private *priv)
 586 {
 587         if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + MESSAGE_HEADER_LEN
 588             || recvlength < MRVDRV_MIN_PKT_LEN) {
 589                 lbtf_deb_usbd(&cardp->udev->dev, "Packet length is Invalid\n");
 590                 kfree_skb(skb);
 591                 return;
 592         }
 593
 594         skb_put(skb, recvlength);
 595         skb_pull(skb, MESSAGE_HEADER_LEN);
 596         lbtf_rx(priv, skb);
 597 }
 598
 599 static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
 600                                       struct sk_buff *skb,
 601                                       struct if_usb_card *cardp,
 602                                       struct lbtf_private *priv)
 603 {
 604         unsigned long flags;
 605
 606         if (recvlength < MESSAGE_HEADER_LEN ||
 607             recvlength > LBS_CMD_BUFFER_SIZE) {
 608                 lbtf_deb_usbd(&cardp->udev->dev,
 609                              "The receive buffer is invalid: %d\n", recvlength);
 610                 kfree_skb(skb);
 611                 return;
 612         }
 613
 614         spin_lock_irqsave(&priv->driver_lock, flags);
 615         memcpy(priv->cmd_resp_buff, recvbuff + MESSAGE_HEADER_LEN,
 616                recvlength - MESSAGE_HEADER_LEN);
 617         kfree_skb(skb);
 618         lbtf_cmd_response_rx(priv);
 619         spin_unlock_irqrestore(&priv->driver_lock, flags);
 620 }
 621
 622 /**
 623  *  if_usb_receive - read data received from the device.
 624  *
 625  *  @urb                pointer to struct urb
 626  */
 627 static void if_usb_receive(struct urb *urb)
 628 {
 629         struct if_usb_card *cardp = urb->context;
 630         struct sk_buff *skb = cardp->rx_skb;
 631         struct lbtf_private *priv = cardp->priv;
 632         int recvlength = urb->actual_length;
 633         uint8_t *recvbuff = NULL;
 634         uint32_t recvtype = 0;
 635         __le32 *pkt = (__le32 *) skb->data;
 636
 637         lbtf_deb_enter(LBTF_DEB_USB);
 638
 639         if (recvlength) {
 640                 if (urb->status) {
 641                         lbtf_deb_usbd(&cardp->udev->dev, "RX URB failed: %d\n",
 642                                      urb->status);
 643                         kfree_skb(skb);
 644                         goto setup_for_next;
 645                 }
 646
 647                 recvbuff = skb->data;
 648                 recvtype = le32_to_cpu(pkt[0]);
 649                 lbtf_deb_usbd(&cardp->udev->dev,
 650                             "Recv length = 0x%x, Recv type = 0x%X\n",
 651                             recvlength, recvtype);
 652         } else if (urb->status) {
 653                 kfree_skb(skb);
 654                 lbtf_deb_leave(LBTF_DEB_USB);
 655                 return;
 656         }
 657
 658         switch (recvtype) {
 659         case CMD_TYPE_DATA:
 660                 process_cmdtypedata(recvlength, skb, cardp, priv);
 661                 break;
 662
 663         case CMD_TYPE_REQUEST:
 664                 process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
 665                 break;
 666
 667         case CMD_TYPE_INDICATION:
 668         {
 669                 /* Event cause handling */
 670                 u32 event_cause = le32_to_cpu(pkt[1]);
 671                 lbtf_deb_usbd(&cardp->udev->dev, "**EVENT** 0x%X\n",
 672                         event_cause);
 673
 674                 /* Icky undocumented magic special case */
 675                 if (event_cause & 0xffff0000) {
 676                         u16 tmp;
 677                         u8 retrycnt;
 678                         u8 failure;
 679
 680                         tmp = event_cause >> 16;
 681                         retrycnt = tmp & 0x00ff;
 682                         failure = (tmp & 0xff00) >> 8;
 683                         lbtf_send_tx_feedback(priv, retrycnt, failure);
 684                 } else if (event_cause == LBTF_EVENT_BCN_SENT)
 685                         lbtf_bcn_sent(priv);
 686                 else
 687                         lbtf_deb_usbd(&cardp->udev->dev,
 688                                "Unsupported notification %d received\n",
 689                                event_cause);
 690                 kfree_skb(skb);
 691                 break;
 692         }
 693         default:
 694                 lbtf_deb_usbd(&cardp->udev->dev,
 695                         "libertastf: unknown command type 0x%X\n", recvtype);
 696                 kfree_skb(skb);
 697                 break;
 698         }
 699
 700 setup_for_next:
 701         if_usb_submit_rx_urb(cardp);
 702         lbtf_deb_leave(LBTF_DEB_USB);
 703 }
 704
 705 /**
 706  *  if_usb_host_to_card -  Download data to the device
 707  *
 708  *  @priv               pointer to struct lbtf_private structure
 709  *  @type               type of data
 710  *  @buf                pointer to data buffer
 711  *  @len                number of bytes
 712  *
 713  *  Returns: 0 on success, nonzero otherwise
 714  */
 715 static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,
 716                                uint8_t *payload, uint16_t nb)
 717 {
 718         struct if_usb_card *cardp = priv->card;
 719         u8 data = 0;
 720
 721         lbtf_deb_usbd(&cardp->udev->dev, "*** type = %u\n", type);
 722         lbtf_deb_usbd(&cardp->udev->dev, "size after = %d\n", nb);
 723
 724         if (type == MVMS_CMD) {
 725                 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_REQUEST);
 726         } else {
 727                 *(__le32 *)cardp->ep_out_buf = cpu_to_le32(CMD_TYPE_DATA);
 728                 data = 1;
 729         }
 730
 731         memcpy((cardp->ep_out_buf + MESSAGE_HEADER_LEN), payload, nb);
 732
 733         return usb_tx_block(cardp, cardp->ep_out_buf, nb + MESSAGE_HEADER_LEN,
 734                             data);
 735 }
 736
 737 /**
 738  *  if_usb_issue_boot_command - Issue boot command to Boot2.
 739  *
 740  *  @ivalue   1 boots from FW by USB-Download, 2 boots from FW in EEPROM.
 741  *
 742  *  Returns: 0
 743  */
 744 static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
 745 {
 746         struct bootcmd *bootcmd = cardp->ep_out_buf;
 747
 748         /* Prepare command */
 749         bootcmd->magic = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
 750         bootcmd->cmd = ivalue;
 751         memset(bootcmd->pad, 0, sizeof(bootcmd->pad));
 752
 753         /* Issue command */
 754         usb_tx_block(cardp, cardp->ep_out_buf, sizeof(*bootcmd), 0);
 755
 756         return 0;
 757 }
 758
 759
 760 /**
 761  *  check_fwfile_format - Check the validity of Boot2/FW image.
 762  *
 763  *  @data       pointer to image
 764  *  @totlen     image length
 765  *
 766  *  Returns: 0 if the image is valid, nonzero otherwise.
 767  */
 768 static int check_fwfile_format(const u8 *data, u32 totlen)
 769 {
 770         u32 bincmd, exit;
 771         u32 blksize, offset, len;
 772         int ret;
 773
 774         ret = 1;
 775         exit = len = 0;
 776
 777         do {
 778                 struct fwheader *fwh = (void *) data;
 779
 780                 bincmd = le32_to_cpu(fwh->dnldcmd);
 781                 blksize = le32_to_cpu(fwh->datalength);
 782                 switch (bincmd) {
 783                 case FW_HAS_DATA_TO_RECV:
 784                         offset = sizeof(struct fwheader) + blksize;
 785                         data += offset;
 786                         len += offset;
 787                         if (len >= totlen)
 788                                 exit = 1;
 789                         break;
 790                 case FW_HAS_LAST_BLOCK:
 791                         exit = 1;
 792                         ret = 0;
 793                         break;
 794                 default:
 795                         exit = 1;
 796                         break;
 797                 }
 798         } while (!exit);
 799
 800         if (ret)
 801                 pr_err("firmware file format check FAIL\n");
 802         else
 803                 lbtf_deb_fw("firmware file format check PASS\n");
 804
 805         return ret;
 806 }
 807
 808
 809 static int if_usb_prog_firmware(struct if_usb_card *cardp)
 810 {
 811         int i = 0;
 812         static int reset_count = 10;
 813         int ret = 0;
 814
 815         lbtf_deb_enter(LBTF_DEB_USB);
 816
 817         kernel_param_lock(THIS_MODULE);
 818         ret = request_firmware(&cardp->fw, lbtf_fw_name, &cardp->udev->dev);
 819         if (ret < 0) {
 820                 pr_err("request_firmware() failed with %#x\n", ret);
 821                 pr_err("firmware %s not found\n", lbtf_fw_name);
 822                 kernel_param_unlock(THIS_MODULE);
 823                 goto done;
 824         }
 825         kernel_param_unlock(THIS_MODULE);
 826
 827         if (check_fwfile_format(cardp->fw->data, cardp->fw->size))
 828                 goto release_fw;
 829
 830 restart:
 831         if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
 832                 lbtf_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
 833                 ret = -1;
 834                 goto release_fw;
 835         }
 836
 837         cardp->bootcmdresp = 0;
 838         do {
 839                 int j = 0;
 840                 i++;
 841                 /* Issue Boot command = 1, Boot from Download-FW */
 842                 if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
 843                 /* wait for command response */
 844                 do {
 845                         j++;
 846                         msleep_interruptible(100);
 847                 } while (cardp->bootcmdresp == 0 && j < 10);
 848         } while (cardp->bootcmdresp == 0 && i < 5);
 849
 850         if (cardp->bootcmdresp <= 0) {
 851                 if (--reset_count >= 0) {
 852                         if_usb_reset_device(cardp);
 853                         goto restart;
 854                 }
 855                 return -1;
 856         }
 857
 858         i = 0;
 859
 860         cardp->totalbytes = 0;
 861         cardp->fwlastblksent = 0;
 862         cardp->CRC_OK = 1;
 863         cardp->fwdnldover = 0;
 864         cardp->fwseqnum = -1;
 865         cardp->totalbytes = 0;
 866         cardp->fwfinalblk = 0;
 867
 868         /* Send the first firmware packet... */
 869         if_usb_send_fw_pkt(cardp);
 870
 871         /* ... and wait for the process to complete */
 872         wait_event_interruptible(cardp->fw_wq, cardp->priv->surpriseremoved ||
 873                                                cardp->fwdnldover);
 874
 875         del_timer_sync(&cardp->fw_timeout);
 876         usb_kill_urb(cardp->rx_urb);
 877
 878         if (!cardp->fwdnldover) {
 879                 pr_info("failed to load fw, resetting device!\n");
 880                 if (--reset_count >= 0) {
 881                         if_usb_reset_device(cardp);
 882                         goto restart;
 883                 }
 884
 885                 pr_info("FW download failure, time = %d ms\n", i * 100);
 886                 ret = -1;
 887                 goto release_fw;
 888         }
 889
 890         cardp->priv->fw_ready = 1;
 891
 892  release_fw:
 893         release_firmware(cardp->fw);
 894         cardp->fw = NULL;
 895
 896         if_usb_setup_firmware(cardp->priv);
 897
 898  done:
 899         lbtf_deb_leave_args(LBTF_DEB_USB, "ret %d", ret);
 900         return ret;
 901 }
 902
 903
 904 #define if_usb_suspend NULL
 905 #define if_usb_resume NULL
 906
 907 static struct usb_driver if_usb_driver = {
 908         .name = DRV_NAME,
 909         .probe = if_usb_probe,
 910         .disconnect = if_usb_disconnect,
 911         .id_table = if_usb_table,
 912         .suspend = if_usb_suspend,
 913         .resume = if_usb_resume,
 914         .disable_hub_initiated_lpm = 1,
 915 };
 916
 917 module_usb_driver(if_usb_driver);
 918
 919 MODULE_DESCRIPTION("8388 USB WLAN Thinfirm Driver");
 920 MODULE_AUTHOR("Cozybit Inc.");
 921 MODULE_LICENSE("GPL");