drivers/net/wireless/mwifiex/usb.c

   1 /*
   2  * Marvell Wireless LAN device driver: USB specific handling
   3  *
   4  * Copyright (C) 2012, Marvell International Ltd.
   5  *
   6  * This software file (the "File") is distributed by Marvell International
   7  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
   8  * (the "License").  You may use, redistribute and/or modify this File in
   9  * accordance with the terms and conditions of the License, a copy of which
  10  * is available by writing to the Free Software Foundation, Inc.,
  11  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
  12  * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
  13  *
  14  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
  17  * this warranty disclaimer.
  18  */
  19
  20 #include "main.h"
  21 #include "usb.h"
  22
  23 #define USB_VERSION     "1.0"
  24
  25 static const char usbdriver_name[] = "usb8797";
  26
  27 static struct mwifiex_if_ops usb_ops;
  28 static struct semaphore add_remove_card_sem;
  29 static struct usb_card_rec *usb_card;
  30
  31 static struct usb_device_id mwifiex_usb_table[] = {
  32         {USB_DEVICE(USB8797_VID, USB8797_PID_1)},
  33         {USB_DEVICE_AND_INTERFACE_INFO(USB8797_VID, USB8797_PID_2,
  34                                        USB_CLASS_VENDOR_SPEC,
  35                                        USB_SUBCLASS_VENDOR_SPEC, 0xff)},
  36         { }     /* Terminating entry */
  37 };
  38
  39 MODULE_DEVICE_TABLE(usb, mwifiex_usb_table);
  40
  41 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size);
  42
  43 /* This function handles received packet. Necessary action is taken based on
  44  * cmd/event/data.
  45  */
  46 static int mwifiex_usb_recv(struct mwifiex_adapter *adapter,
  47                             struct sk_buff *skb, u8 ep)
  48 {
  49         struct device *dev = adapter->dev;
  50         u32 recv_type;
  51         __le32 tmp;
  52         int ret;
  53
  54         if (adapter->hs_activated)
  55                 mwifiex_process_hs_config(adapter);
  56
  57         if (skb->len < INTF_HEADER_LEN) {
  58                 dev_err(dev, "%s: invalid skb->len\n", __func__);
  59                 return -1;
  60         }
  61
  62         switch (ep) {
  63         case MWIFIEX_USB_EP_CMD_EVENT:
  64                 dev_dbg(dev, "%s: EP_CMD_EVENT\n", __func__);
  65                 skb_copy_from_linear_data(skb, &tmp, INTF_HEADER_LEN);
  66                 recv_type = le32_to_cpu(tmp);
  67                 skb_pull(skb, INTF_HEADER_LEN);
  68
  69                 switch (recv_type) {
  70                 case MWIFIEX_USB_TYPE_CMD:
  71                         if (skb->len > MWIFIEX_SIZE_OF_CMD_BUFFER) {
  72                                 dev_err(dev, "CMD: skb->len too large\n");
  73                                 ret = -1;
  74                                 goto exit_restore_skb;
  75                         } else if (!adapter->curr_cmd) {
  76                                 dev_dbg(dev, "CMD: no curr_cmd\n");
  77                                 if (adapter->ps_state == PS_STATE_SLEEP_CFM) {
  78                                         mwifiex_process_sleep_confirm_resp(
  79                                                         adapter, skb->data,
  80                                                         skb->len);
  81                                         ret = 0;
  82                                         goto exit_restore_skb;
  83                                 }
  84                                 ret = -1;
  85                                 goto exit_restore_skb;
  86                         }
  87
  88                         adapter->curr_cmd->resp_skb = skb;
  89                         adapter->cmd_resp_received = true;
  90                         break;
  91                 case MWIFIEX_USB_TYPE_EVENT:
  92                         if (skb->len < sizeof(u32)) {
  93                                 dev_err(dev, "EVENT: skb->len too small\n");
  94                                 ret = -1;
  95                                 goto exit_restore_skb;
  96                         }
  97                         skb_copy_from_linear_data(skb, &tmp, sizeof(u32));
  98                         adapter->event_cause = le32_to_cpu(tmp);
  99                         dev_dbg(dev, "event_cause %#x\n", adapter->event_cause);
 100
 101                         if (skb->len > MAX_EVENT_SIZE) {
 102                                 dev_err(dev, "EVENT: event body too large\n");
 103                                 ret = -1;
 104                                 goto exit_restore_skb;
 105                         }
 106
 107                         memcpy(adapter->event_body, skb->data +
 108                                MWIFIEX_EVENT_HEADER_LEN, skb->len);
 109
 110                         adapter->event_received = true;
 111                         adapter->event_skb = skb;
 112                         break;
 113                 default:
 114                         dev_err(dev, "unknown recv_type %#x\n", recv_type);
 115                         return -1;
 116                 }
 117                 break;
 118         case MWIFIEX_USB_EP_DATA:
 119                 dev_dbg(dev, "%s: EP_DATA\n", __func__);
 120                 if (skb->len > MWIFIEX_RX_DATA_BUF_SIZE) {
 121                         dev_err(dev, "DATA: skb->len too large\n");
 122                         return -1;
 123                 }
 124                 skb_queue_tail(&adapter->usb_rx_data_q, skb);
 125                 adapter->data_received = true;
 126                 break;
 127         default:
 128                 dev_err(dev, "%s: unknown endport %#x\n", __func__, ep);
 129                 return -1;
 130         }
 131
 132         return -EINPROGRESS;
 133
 134 exit_restore_skb:
 135         /* The buffer will be reused for further cmds/events */
 136         skb_push(skb, INTF_HEADER_LEN);
 137
 138         return ret;
 139 }
 140
 141 static void mwifiex_usb_rx_complete(struct urb *urb)
 142 {
 143         struct urb_context *context = (struct urb_context *)urb->context;
 144         struct mwifiex_adapter *adapter = context->adapter;
 145         struct sk_buff *skb = context->skb;
 146         struct usb_card_rec *card;
 147         int recv_length = urb->actual_length;
 148         int size, status;
 149
 150         if (!adapter || !adapter->card) {
 151                 pr_err("mwifiex adapter or card structure is not valid\n");
 152                 return;
 153         }
 154
 155         card = (struct usb_card_rec *)adapter->card;
 156         if (card->rx_cmd_ep == context->ep)
 157                 atomic_dec(&card->rx_cmd_urb_pending);
 158         else
 159                 atomic_dec(&card->rx_data_urb_pending);
 160
 161         if (recv_length) {
 162                 if (urb->status || (adapter->surprise_removed)) {
 163                         dev_err(adapter->dev,
 164                                 "URB status is failed: %d\n", urb->status);
 165                         /* Do not free skb in case of command ep */
 166                         if (card->rx_cmd_ep != context->ep)
 167                                 dev_kfree_skb_any(skb);
 168                         goto setup_for_next;
 169                 }
 170                 if (skb->len > recv_length)
 171                         skb_trim(skb, recv_length);
 172                 else
 173                         skb_put(skb, recv_length - skb->len);
 174
 175                 atomic_inc(&adapter->rx_pending);
 176                 status = mwifiex_usb_recv(adapter, skb, context->ep);
 177
 178                 dev_dbg(adapter->dev, "info: recv_length=%d, status=%d\n",
 179                         recv_length, status);
 180                 if (status == -EINPROGRESS) {
 181                         queue_work(adapter->workqueue, &adapter->main_work);
 182
 183                         /* urb for data_ep is re-submitted now;
 184                          * urb for cmd_ep will be re-submitted in callback
 185                          * mwifiex_usb_recv_complete
 186                          */
 187                         if (card->rx_cmd_ep == context->ep)
 188                                 return;
 189                 } else {
 190                         atomic_dec(&adapter->rx_pending);
 191                         if (status == -1)
 192                                 dev_err(adapter->dev,
 193                                         "received data processing failed!\n");
 194
 195                         /* Do not free skb in case of command ep */
 196                         if (card->rx_cmd_ep != context->ep)
 197                                 dev_kfree_skb_any(skb);
 198                 }
 199         } else if (urb->status) {
 200                 if (!adapter->is_suspended) {
 201                         dev_warn(adapter->dev,
 202                                  "Card is removed: %d\n", urb->status);
 203                         adapter->surprise_removed = true;
 204                 }
 205                 dev_kfree_skb_any(skb);
 206                 return;
 207         } else {
 208                 /* Do not free skb in case of command ep */
 209                 if (card->rx_cmd_ep != context->ep)
 210                         dev_kfree_skb_any(skb);
 211
 212                 /* fall through setup_for_next */
 213         }
 214
 215 setup_for_next:
 216         if (card->rx_cmd_ep == context->ep)
 217                 size = MWIFIEX_RX_CMD_BUF_SIZE;
 218         else
 219                 size = MWIFIEX_RX_DATA_BUF_SIZE;
 220
 221         mwifiex_usb_submit_rx_urb(context, size);
 222
 223         return;
 224 }
 225
 226 static void mwifiex_usb_tx_complete(struct urb *urb)
 227 {
 228         struct urb_context *context = (struct urb_context *)(urb->context);
 229         struct mwifiex_adapter *adapter = context->adapter;
 230         struct usb_card_rec *card = adapter->card;
 231
 232         dev_dbg(adapter->dev, "%s: status: %d\n", __func__, urb->status);
 233
 234         if (context->ep == card->tx_cmd_ep) {
 235                 dev_dbg(adapter->dev, "%s: CMD\n", __func__);
 236                 atomic_dec(&card->tx_cmd_urb_pending);
 237                 adapter->cmd_sent = false;
 238         } else {
 239                 dev_dbg(adapter->dev, "%s: DATA\n", __func__);
 240                 atomic_dec(&card->tx_data_urb_pending);
 241                 mwifiex_write_data_complete(adapter, context->skb, 0,
 242                                             urb->status ? -1 : 0);
 243         }
 244
 245         queue_work(adapter->workqueue, &adapter->main_work);
 246
 247         return;
 248 }
 249
 250 static int mwifiex_usb_submit_rx_urb(struct urb_context *ctx, int size)
 251 {
 252         struct mwifiex_adapter *adapter = ctx->adapter;
 253         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 254
 255         if (card->rx_cmd_ep != ctx->ep) {
 256                 ctx->skb = dev_alloc_skb(size);
 257                 if (!ctx->skb) {
 258                         dev_err(adapter->dev,
 259                                 "%s: dev_alloc_skb failed\n", __func__);
 260                         return -ENOMEM;
 261                 }
 262         }
 263
 264         usb_fill_bulk_urb(ctx->urb, card->udev,
 265                           usb_rcvbulkpipe(card->udev, ctx->ep), ctx->skb->data,
 266                           size, mwifiex_usb_rx_complete, (void *)ctx);
 267
 268         if (card->rx_cmd_ep == ctx->ep)
 269                 atomic_inc(&card->rx_cmd_urb_pending);
 270         else
 271                 atomic_inc(&card->rx_data_urb_pending);
 272
 273         if (usb_submit_urb(ctx->urb, GFP_ATOMIC)) {
 274                 dev_err(adapter->dev, "usb_submit_urb failed\n");
 275                 dev_kfree_skb_any(ctx->skb);
 276                 ctx->skb = NULL;
 277
 278                 if (card->rx_cmd_ep == ctx->ep)
 279                         atomic_dec(&card->rx_cmd_urb_pending);
 280                 else
 281                         atomic_dec(&card->rx_data_urb_pending);
 282
 283                 return -1;
 284         }
 285
 286         return 0;
 287 }
 288
 289 static void mwifiex_usb_free(struct usb_card_rec *card)
 290 {
 291         int i;
 292
 293         if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
 294                 usb_kill_urb(card->rx_cmd.urb);
 295
 296         usb_free_urb(card->rx_cmd.urb);
 297         card->rx_cmd.urb = NULL;
 298
 299         if (atomic_read(&card->rx_data_urb_pending))
 300                 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
 301                         if (card->rx_data_list[i].urb)
 302                                 usb_kill_urb(card->rx_data_list[i].urb);
 303
 304         for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
 305                 usb_free_urb(card->rx_data_list[i].urb);
 306                 card->rx_data_list[i].urb = NULL;
 307         }
 308
 309         for (i = 0; i < MWIFIEX_TX_DATA_URB; i++) {
 310                 usb_free_urb(card->tx_data_list[i].urb);
 311                 card->tx_data_list[i].urb = NULL;
 312         }
 313
 314         usb_free_urb(card->tx_cmd.urb);
 315         card->tx_cmd.urb = NULL;
 316
 317         return;
 318 }
 319
 320 /* This function probes an mwifiex device and registers it. It allocates
 321  * the card structure, initiates the device registration and initialization
 322  * procedure by adding a logical interface.
 323  */
 324 static int mwifiex_usb_probe(struct usb_interface *intf,
 325                              const struct usb_device_id *id)
 326 {
 327         struct usb_device *udev = interface_to_usbdev(intf);
 328         struct usb_host_interface *iface_desc = intf->cur_altsetting;
 329         struct usb_endpoint_descriptor *epd;
 330         int ret, i;
 331         struct usb_card_rec *card;
 332         u16 id_vendor, id_product, bcd_device, bcd_usb;
 333
 334         card = kzalloc(sizeof(struct usb_card_rec), GFP_KERNEL);
 335         if (!card)
 336                 return -ENOMEM;
 337
 338         id_vendor = le16_to_cpu(udev->descriptor.idVendor);
 339         id_product = le16_to_cpu(udev->descriptor.idProduct);
 340         bcd_device = le16_to_cpu(udev->descriptor.bcdDevice);
 341         bcd_usb = le16_to_cpu(udev->descriptor.bcdUSB);
 342         pr_debug("info: VID/PID = %X/%X, Boot2 version = %X\n",
 343                  id_vendor, id_product, bcd_device);
 344
 345         /* PID_1 is used for firmware downloading only */
 346         if (id_product == USB8797_PID_1)
 347                 card->usb_boot_state = USB8797_FW_DNLD;
 348         else
 349                 card->usb_boot_state = USB8797_FW_READY;
 350
 351         card->udev = udev;
 352         card->intf = intf;
 353         usb_card = card;
 354
 355         pr_debug("info: bcdUSB=%#x Device Class=%#x SubClass=%#x Protocol=%#x\n",
 356                  udev->descriptor.bcdUSB, udev->descriptor.bDeviceClass,
 357                  udev->descriptor.bDeviceSubClass,
 358                  udev->descriptor.bDeviceProtocol);
 359
 360         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 361                 epd = &iface_desc->endpoint[i].desc;
 362                 if (usb_endpoint_dir_in(epd) &&
 363                     usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
 364                     usb_endpoint_xfer_bulk(epd)) {
 365                         pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
 366                                  le16_to_cpu(epd->wMaxPacketSize),
 367                                  epd->bEndpointAddress);
 368                         card->rx_cmd_ep = usb_endpoint_num(epd);
 369                         atomic_set(&card->rx_cmd_urb_pending, 0);
 370                 }
 371                 if (usb_endpoint_dir_in(epd) &&
 372                     usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
 373                     usb_endpoint_xfer_bulk(epd)) {
 374                         pr_debug("info: bulk IN: max pkt size: %d, addr: %d\n",
 375                                  le16_to_cpu(epd->wMaxPacketSize),
 376                                  epd->bEndpointAddress);
 377                         card->rx_data_ep = usb_endpoint_num(epd);
 378                         atomic_set(&card->rx_data_urb_pending, 0);
 379                 }
 380                 if (usb_endpoint_dir_out(epd) &&
 381                     usb_endpoint_num(epd) == MWIFIEX_USB_EP_DATA &&
 382                     usb_endpoint_xfer_bulk(epd)) {
 383                         pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
 384                                  le16_to_cpu(epd->wMaxPacketSize),
 385                                  epd->bEndpointAddress);
 386                         card->tx_data_ep = usb_endpoint_num(epd);
 387                         atomic_set(&card->tx_data_urb_pending, 0);
 388                 }
 389                 if (usb_endpoint_dir_out(epd) &&
 390                     usb_endpoint_num(epd) == MWIFIEX_USB_EP_CMD_EVENT &&
 391                     usb_endpoint_xfer_bulk(epd)) {
 392                         pr_debug("info: bulk OUT: max pkt size: %d, addr: %d\n",
 393                                  le16_to_cpu(epd->wMaxPacketSize),
 394                                  epd->bEndpointAddress);
 395                         card->tx_cmd_ep = usb_endpoint_num(epd);
 396                         atomic_set(&card->tx_cmd_urb_pending, 0);
 397                         card->bulk_out_maxpktsize =
 398                                         le16_to_cpu(epd->wMaxPacketSize);
 399                 }
 400         }
 401
 402         usb_set_intfdata(intf, card);
 403
 404         ret = mwifiex_add_card(card, &add_remove_card_sem, &usb_ops,
 405                                MWIFIEX_USB);
 406         if (ret) {
 407                 pr_err("%s: mwifiex_add_card failed: %d\n", __func__, ret);
 408                 usb_reset_device(udev);
 409                 kfree(card);
 410                 return ret;
 411         }
 412
 413         usb_get_dev(udev);
 414
 415         return 0;
 416 }
 417
 418 /* Kernel needs to suspend all functions separately. Therefore all
 419  * registered functions must have drivers with suspend and resume
 420  * methods. Failing that the kernel simply removes the whole card.
 421  *
 422  * If already not suspended, this function allocates and sends a
 423  * 'host sleep activate' request to the firmware and turns off the traffic.
 424  */
 425 static int mwifiex_usb_suspend(struct usb_interface *intf, pm_message_t message)
 426 {
 427         struct usb_card_rec *card = usb_get_intfdata(intf);
 428         struct mwifiex_adapter *adapter;
 429         int i;
 430
 431         if (!card || !card->adapter) {
 432                 pr_err("%s: card or card->adapter is NULL\n", __func__);
 433                 return 0;
 434         }
 435         adapter = card->adapter;
 436
 437         if (unlikely(adapter->is_suspended))
 438                 dev_warn(adapter->dev, "Device already suspended\n");
 439
 440         mwifiex_enable_hs(adapter);
 441
 442         /* 'is_suspended' flag indicates device is suspended.
 443          * It must be set here before the usb_kill_urb() calls. Reason
 444          * is in the complete handlers, urb->status(= -ENOENT) and
 445          * this flag is used in combination to distinguish between a
 446          * 'suspended' state and a 'disconnect' one.
 447          */
 448         adapter->is_suspended = true;
 449
 450         for (i = 0; i < adapter->priv_num; i++)
 451                 netif_carrier_off(adapter->priv[i]->netdev);
 452
 453         if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
 454                 usb_kill_urb(card->rx_cmd.urb);
 455
 456         if (atomic_read(&card->rx_data_urb_pending))
 457                 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
 458                         if (card->rx_data_list[i].urb)
 459                                 usb_kill_urb(card->rx_data_list[i].urb);
 460
 461         for (i = 0; i < MWIFIEX_TX_DATA_URB; i++)
 462                 if (card->tx_data_list[i].urb)
 463                         usb_kill_urb(card->tx_data_list[i].urb);
 464
 465         if (card->tx_cmd.urb)
 466                 usb_kill_urb(card->tx_cmd.urb);
 467
 468         return 0;
 469 }
 470
 471 /* Kernel needs to suspend all functions separately. Therefore all
 472  * registered functions must have drivers with suspend and resume
 473  * methods. Failing that the kernel simply removes the whole card.
 474  *
 475  * If already not resumed, this function turns on the traffic and
 476  * sends a 'host sleep cancel' request to the firmware.
 477  */
 478 static int mwifiex_usb_resume(struct usb_interface *intf)
 479 {
 480         struct usb_card_rec *card = usb_get_intfdata(intf);
 481         struct mwifiex_adapter *adapter;
 482         int i;
 483
 484         if (!card || !card->adapter) {
 485                 pr_err("%s: card or card->adapter is NULL\n", __func__);
 486                 return 0;
 487         }
 488         adapter = card->adapter;
 489
 490         if (unlikely(!adapter->is_suspended)) {
 491                 dev_warn(adapter->dev, "Device already resumed\n");
 492                 return 0;
 493         }
 494
 495         /* Indicate device resumed. The netdev queue will be resumed only
 496          * after the urbs have been re-submitted
 497          */
 498         adapter->is_suspended = false;
 499
 500         if (!atomic_read(&card->rx_data_urb_pending))
 501                 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
 502                         mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
 503                                                   MWIFIEX_RX_DATA_BUF_SIZE);
 504
 505         if (!atomic_read(&card->rx_cmd_urb_pending)) {
 506                 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
 507                 if (card->rx_cmd.skb)
 508                         mwifiex_usb_submit_rx_urb(&card->rx_cmd,
 509                                                   MWIFIEX_RX_CMD_BUF_SIZE);
 510         }
 511
 512         for (i = 0; i < adapter->priv_num; i++)
 513                 if (adapter->priv[i]->media_connected)
 514                         netif_carrier_on(adapter->priv[i]->netdev);
 515
 516         /* Disable Host Sleep */
 517         if (adapter->hs_activated)
 518                 mwifiex_cancel_hs(mwifiex_get_priv(adapter,
 519                                                    MWIFIEX_BSS_ROLE_ANY),
 520                                   MWIFIEX_ASYNC_CMD);
 521
 522 #ifdef CONFIG_PM
 523         /* Resume handler may be called due to remote wakeup,
 524          * force to exit suspend anyway
 525          */
 526         usb_disable_autosuspend(card->udev);
 527 #endif /* CONFIG_PM */
 528
 529         return 0;
 530 }
 531
 532 static void mwifiex_usb_disconnect(struct usb_interface *intf)
 533 {
 534         struct usb_card_rec *card = usb_get_intfdata(intf);
 535         struct mwifiex_adapter *adapter;
 536
 537         if (!card || !card->adapter) {
 538                 pr_err("%s: card or card->adapter is NULL\n", __func__);
 539                 return;
 540         }
 541
 542         adapter = card->adapter;
 543         if (!adapter->priv_num)
 544                 return;
 545
 546         mwifiex_usb_free(card);
 547
 548         dev_dbg(adapter->dev, "%s: removing card\n", __func__);
 549         mwifiex_remove_card(adapter, &add_remove_card_sem);
 550
 551         usb_set_intfdata(intf, NULL);
 552         usb_put_dev(interface_to_usbdev(intf));
 553         kfree(card);
 554
 555         return;
 556 }
 557
 558 static struct usb_driver mwifiex_usb_driver = {
 559         .name = usbdriver_name,
 560         .probe = mwifiex_usb_probe,
 561         .disconnect = mwifiex_usb_disconnect,
 562         .id_table = mwifiex_usb_table,
 563         .suspend = mwifiex_usb_suspend,
 564         .resume = mwifiex_usb_resume,
 565         .supports_autosuspend = 1,
 566 };
 567
 568 static int mwifiex_usb_tx_init(struct mwifiex_adapter *adapter)
 569 {
 570         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 571         int i;
 572
 573         card->tx_cmd.adapter = adapter;
 574         card->tx_cmd.ep = card->tx_cmd_ep;
 575
 576         card->tx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
 577         if (!card->tx_cmd.urb) {
 578                 dev_err(adapter->dev, "tx_cmd.urb allocation failed\n");
 579                 return -ENOMEM;
 580         }
 581
 582         card->tx_data_ix = 0;
 583
 584         for (i = 0; i < MWIFIEX_TX_DATA_URB; i++) {
 585                 card->tx_data_list[i].adapter = adapter;
 586                 card->tx_data_list[i].ep = card->tx_data_ep;
 587
 588                 card->tx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
 589                 if (!card->tx_data_list[i].urb) {
 590                         dev_err(adapter->dev,
 591                                 "tx_data_list[] urb allocation failed\n");
 592                         return -ENOMEM;
 593                 }
 594         }
 595
 596         return 0;
 597 }
 598
 599 static int mwifiex_usb_rx_init(struct mwifiex_adapter *adapter)
 600 {
 601         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 602         int i;
 603
 604         card->rx_cmd.adapter = adapter;
 605         card->rx_cmd.ep = card->rx_cmd_ep;
 606
 607         card->rx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
 608         if (!card->rx_cmd.urb) {
 609                 dev_err(adapter->dev, "rx_cmd.urb allocation failed\n");
 610                 return -ENOMEM;
 611         }
 612
 613         card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
 614         if (!card->rx_cmd.skb) {
 615                 dev_err(adapter->dev, "rx_cmd.skb allocation failed\n");
 616                 return -ENOMEM;
 617         }
 618
 619         if (mwifiex_usb_submit_rx_urb(&card->rx_cmd, MWIFIEX_RX_CMD_BUF_SIZE))
 620                 return -1;
 621
 622         for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
 623                 card->rx_data_list[i].adapter = adapter;
 624                 card->rx_data_list[i].ep = card->rx_data_ep;
 625
 626                 card->rx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
 627                 if (!card->rx_data_list[i].urb) {
 628                         dev_err(adapter->dev,
 629                                 "rx_data_list[] urb allocation failed\n");
 630                         return -1;
 631                 }
 632                 if (mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
 633                                               MWIFIEX_RX_DATA_BUF_SIZE))
 634                         return -1;
 635         }
 636
 637         return 0;
 638 }
 639
 640 static int mwifiex_write_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
 641                                    u32 *len, u8 ep, u32 timeout)
 642 {
 643         struct usb_card_rec *card = adapter->card;
 644         int actual_length, ret;
 645
 646         if (!(*len % card->bulk_out_maxpktsize))
 647                 (*len)++;
 648
 649         /* Send the data block */
 650         ret = usb_bulk_msg(card->udev, usb_sndbulkpipe(card->udev, ep), pbuf,
 651                            *len, &actual_length, timeout);
 652         if (ret) {
 653                 dev_err(adapter->dev, "usb_bulk_msg for tx failed: %d\n", ret);
 654                 return ret;
 655         }
 656
 657         *len = actual_length;
 658
 659         return ret;
 660 }
 661
 662 static int mwifiex_read_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
 663                                   u32 *len, u8 ep, u32 timeout)
 664 {
 665         struct usb_card_rec *card = adapter->card;
 666         int actual_length, ret;
 667
 668         /* Receive the data response */
 669         ret = usb_bulk_msg(card->udev, usb_rcvbulkpipe(card->udev, ep), pbuf,
 670                            *len, &actual_length, timeout);
 671         if (ret) {
 672                 dev_err(adapter->dev, "usb_bulk_msg for rx failed: %d\n", ret);
 673                 return ret;
 674         }
 675
 676         *len = actual_length;
 677
 678         return ret;
 679 }
 680
 681 /* This function write a command/data packet to card. */
 682 static int mwifiex_usb_host_to_card(struct mwifiex_adapter *adapter, u8 ep,
 683                                     struct sk_buff *skb,
 684                                     struct mwifiex_tx_param *tx_param)
 685 {
 686         struct usb_card_rec *card = adapter->card;
 687         struct urb_context *context;
 688         u8 *data = (u8 *)skb->data;
 689         struct urb *tx_urb;
 690
 691         if (adapter->is_suspended) {
 692                 dev_err(adapter->dev,
 693                         "%s: not allowed while suspended\n", __func__);
 694                 return -1;
 695         }
 696
 697         if (adapter->surprise_removed) {
 698                 dev_err(adapter->dev, "%s: device removed\n", __func__);
 699                 return -1;
 700         }
 701
 702         if (ep == card->tx_data_ep &&
 703             atomic_read(&card->tx_data_urb_pending) >= MWIFIEX_TX_DATA_URB) {
 704                 return -EBUSY;
 705         }
 706
 707         dev_dbg(adapter->dev, "%s: ep=%d\n", __func__, ep);
 708
 709         if (ep == card->tx_cmd_ep) {
 710                 context = &card->tx_cmd;
 711         } else {
 712                 if (card->tx_data_ix >= MWIFIEX_TX_DATA_URB)
 713                         card->tx_data_ix = 0;
 714                 context = &card->tx_data_list[card->tx_data_ix++];
 715         }
 716
 717         context->adapter = adapter;
 718         context->ep = ep;
 719         context->skb = skb;
 720         tx_urb = context->urb;
 721
 722         usb_fill_bulk_urb(tx_urb, card->udev, usb_sndbulkpipe(card->udev, ep),
 723                           data, skb->len, mwifiex_usb_tx_complete,
 724                           (void *)context);
 725
 726         tx_urb->transfer_flags |= URB_ZERO_PACKET;
 727
 728         if (ep == card->tx_cmd_ep)
 729                 atomic_inc(&card->tx_cmd_urb_pending);
 730         else
 731                 atomic_inc(&card->tx_data_urb_pending);
 732
 733         if (usb_submit_urb(tx_urb, GFP_ATOMIC)) {
 734                 dev_err(adapter->dev, "%s: usb_submit_urb failed\n", __func__);
 735                 if (ep == card->tx_cmd_ep) {
 736                         atomic_dec(&card->tx_cmd_urb_pending);
 737                 } else {
 738                         atomic_dec(&card->tx_data_urb_pending);
 739                         if (card->tx_data_ix)
 740                                 card->tx_data_ix--;
 741                         else
 742                                 card->tx_data_ix = MWIFIEX_TX_DATA_URB;
 743                 }
 744
 745                 return -1;
 746         } else {
 747                 if (ep == card->tx_data_ep &&
 748                     atomic_read(&card->tx_data_urb_pending) ==
 749                                                         MWIFIEX_TX_DATA_URB)
 750                         return -ENOSR;
 751         }
 752
 753         return -EINPROGRESS;
 754 }
 755
 756 /* This function register usb device and initialize parameter. */
 757 static int mwifiex_register_dev(struct mwifiex_adapter *adapter)
 758 {
 759         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 760
 761         card->adapter = adapter;
 762         adapter->dev = &card->udev->dev;
 763         strcpy(adapter->fw_name, USB8797_DEFAULT_FW_NAME);
 764
 765         return 0;
 766 }
 767
 768 static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter)
 769 {
 770         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 771
 772         usb_set_intfdata(card->intf, NULL);
 773 }
 774
 775 static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter,
 776                                     struct mwifiex_fw_image *fw)
 777 {
 778         int ret = 0;
 779         u8 *firmware = fw->fw_buf, *recv_buff;
 780         u32 retries = USB8797_FW_MAX_RETRY, dlen;
 781         u32 fw_seqnum = 0, tlen = 0, dnld_cmd = 0;
 782         struct fw_data *fwdata;
 783         struct fw_sync_header sync_fw;
 784         u8 check_winner = 1;
 785
 786         if (!firmware) {
 787                 dev_err(adapter->dev,
 788                         "No firmware image found! Terminating download\n");
 789                 ret = -1;
 790                 goto fw_exit;
 791         }
 792
 793         /* Allocate memory for transmit */
 794         fwdata = kzalloc(FW_DNLD_TX_BUF_SIZE, GFP_KERNEL);
 795         if (!fwdata)
 796                 goto fw_exit;
 797
 798         /* Allocate memory for receive */
 799         recv_buff = kzalloc(FW_DNLD_RX_BUF_SIZE, GFP_KERNEL);
 800         if (!recv_buff)
 801                 goto cleanup;
 802
 803         do {
 804                 /* Send pseudo data to check winner status first */
 805                 if (check_winner) {
 806                         memset(&fwdata->fw_hdr, 0, sizeof(struct fw_header));
 807                         dlen = 0;
 808                 } else {
 809                         /* copy the header of the fw_data to get the length */
 810                         memcpy(&fwdata->fw_hdr, &firmware[tlen],
 811                                sizeof(struct fw_header));
 812
 813                         dlen = le32_to_cpu(fwdata->fw_hdr.data_len);
 814                         dnld_cmd = le32_to_cpu(fwdata->fw_hdr.dnld_cmd);
 815                         tlen += sizeof(struct fw_header);
 816
 817                         memcpy(fwdata->data, &firmware[tlen], dlen);
 818
 819                         fwdata->seq_num = cpu_to_le32(fw_seqnum);
 820                         tlen += dlen;
 821                 }
 822
 823                 /* If the send/receive fails or CRC occurs then retry */
 824                 while (retries--) {
 825                         u8 *buf = (u8 *)fwdata;
 826                         u32 len = FW_DATA_XMIT_SIZE;
 827
 828                         /* send the firmware block */
 829                         ret = mwifiex_write_data_sync(adapter, buf, &len,
 830                                                 MWIFIEX_USB_EP_CMD_EVENT,
 831                                                 MWIFIEX_USB_TIMEOUT);
 832                         if (ret) {
 833                                 dev_err(adapter->dev,
 834                                         "write_data_sync: failed: %d\n", ret);
 835                                 continue;
 836                         }
 837
 838                         buf = recv_buff;
 839                         len = FW_DNLD_RX_BUF_SIZE;
 840
 841                         /* Receive the firmware block response */
 842                         ret = mwifiex_read_data_sync(adapter, buf, &len,
 843                                                 MWIFIEX_USB_EP_CMD_EVENT,
 844                                                 MWIFIEX_USB_TIMEOUT);
 845                         if (ret) {
 846                                 dev_err(adapter->dev,
 847                                         "read_data_sync: failed: %d\n", ret);
 848                                 continue;
 849                         }
 850
 851                         memcpy(&sync_fw, recv_buff,
 852                                sizeof(struct fw_sync_header));
 853
 854                         /* check 1st firmware block resp for highest bit set */
 855                         if (check_winner) {
 856                                 if (le32_to_cpu(sync_fw.cmd) & 0x80000000) {
 857                                         dev_warn(adapter->dev,
 858                                                  "USB is not the winner %#x\n",
 859                                                  sync_fw.cmd);
 860
 861                                         /* returning success */
 862                                         ret = 0;
 863                                         goto cleanup;
 864                                 }
 865
 866                                 dev_dbg(adapter->dev,
 867                                         "USB is the winner, start to download FW\n");
 868
 869                                 check_winner = 0;
 870                                 break;
 871                         }
 872
 873                         /* check the firmware block response for CRC errors */
 874                         if (sync_fw.cmd) {
 875                                 dev_err(adapter->dev,
 876                                         "FW received block with CRC %#x\n",
 877                                         sync_fw.cmd);
 878                                 ret = -1;
 879                                 continue;
 880                         }
 881
 882                         retries = USB8797_FW_MAX_RETRY;
 883                         break;
 884                 }
 885                 fw_seqnum++;
 886         } while ((dnld_cmd != FW_HAS_LAST_BLOCK) && retries);
 887
 888 cleanup:
 889         dev_dbg(adapter->dev, "%s: %d bytes downloaded\n", __func__, tlen);
 890
 891         kfree(recv_buff);
 892         kfree(fwdata);
 893
 894         if (retries)
 895                 ret = 0;
 896 fw_exit:
 897         return ret;
 898 }
 899
 900 static int mwifiex_usb_dnld_fw(struct mwifiex_adapter *adapter,
 901                         struct mwifiex_fw_image *fw)
 902 {
 903         int ret;
 904         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 905
 906         if (card->usb_boot_state == USB8797_FW_DNLD) {
 907                 ret = mwifiex_prog_fw_w_helper(adapter, fw);
 908                 if (ret)
 909                         return -1;
 910
 911                 /* Boot state changes after successful firmware download */
 912                 if (card->usb_boot_state == USB8797_FW_DNLD)
 913                         return -1;
 914         }
 915
 916         ret = mwifiex_usb_rx_init(adapter);
 917         if (!ret)
 918                 ret = mwifiex_usb_tx_init(adapter);
 919
 920         return ret;
 921 }
 922
 923 static void mwifiex_submit_rx_urb(struct mwifiex_adapter *adapter, u8 ep)
 924 {
 925         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 926
 927         skb_push(card->rx_cmd.skb, INTF_HEADER_LEN);
 928         if ((ep == card->rx_cmd_ep) &&
 929             (!atomic_read(&card->rx_cmd_urb_pending)))
 930                 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
 931                                           MWIFIEX_RX_CMD_BUF_SIZE);
 932
 933         return;
 934 }
 935
 936 static int mwifiex_usb_cmd_event_complete(struct mwifiex_adapter *adapter,
 937                                        struct sk_buff *skb)
 938 {
 939         atomic_dec(&adapter->rx_pending);
 940         mwifiex_submit_rx_urb(adapter, MWIFIEX_USB_EP_CMD_EVENT);
 941
 942         return 0;
 943 }
 944
 945 static int mwifiex_usb_data_complete(struct mwifiex_adapter *adapter,
 946                                      struct sk_buff *skb)
 947 {
 948         atomic_dec(&adapter->rx_pending);
 949         dev_kfree_skb_any(skb);
 950
 951         return 0;
 952 }
 953
 954 /* This function wakes up the card. */
 955 static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter)
 956 {
 957         /* Simulation of HS_AWAKE event */
 958         adapter->pm_wakeup_fw_try = false;
 959         adapter->pm_wakeup_card_req = false;
 960         adapter->ps_state = PS_STATE_AWAKE;
 961
 962         return 0;
 963 }
 964
 965 static struct mwifiex_if_ops usb_ops = {
 966         .register_dev =         mwifiex_register_dev,
 967         .unregister_dev =       mwifiex_unregister_dev,
 968         .wakeup =               mwifiex_pm_wakeup_card,
 969         .wakeup_complete =      mwifiex_pm_wakeup_card_complete,
 970
 971         /* USB specific */
 972         .dnld_fw =              mwifiex_usb_dnld_fw,
 973         .cmdrsp_complete =      mwifiex_usb_cmd_event_complete,
 974         .event_complete =       mwifiex_usb_cmd_event_complete,
 975         .data_complete =        mwifiex_usb_data_complete,
 976         .host_to_card =         mwifiex_usb_host_to_card,
 977 };
 978
 979 /* This function initializes the USB driver module.
 980  *
 981  * This initiates the semaphore and registers the device with
 982  * USB bus.
 983  */
 984 static int mwifiex_usb_init_module(void)
 985 {
 986         int ret;
 987
 988         pr_debug("Marvell USB8797 Driver\n");
 989
 990         sema_init(&add_remove_card_sem, 1);
 991
 992         ret = usb_register(&mwifiex_usb_driver);
 993         if (ret)
 994                 pr_err("Driver register failed!\n");
 995         else
 996                 pr_debug("info: Driver registered successfully!\n");
 997
 998         return ret;
 999 }
1000
1001 /* This function cleans up the USB driver.
1002  *
1003  * The following major steps are followed in .disconnect for cleanup:
1004  *      - Resume the device if its suspended
1005  *      - Disconnect the device if connected
1006  *      - Shutdown the firmware
1007  *      - Unregister the device from USB bus.
1008  */
1009 static void mwifiex_usb_cleanup_module(void)
1010 {
1011         if (!down_interruptible(&add_remove_card_sem))
1012                 up(&add_remove_card_sem);
1013
1014         if (usb_card) {
1015                 struct mwifiex_adapter *adapter = usb_card->adapter;
1016                 int i;
1017
1018                 /* In case driver is removed when asynchronous FW downloading is
1019                  * in progress
1020                  */
1021                 wait_for_completion(&adapter->fw_load);
1022
1023 #ifdef CONFIG_PM
1024                 if (adapter->is_suspended)
1025                         mwifiex_usb_resume(usb_card->intf);
1026 #endif
1027                 for (i = 0; i < adapter->priv_num; i++)
1028                         if ((GET_BSS_ROLE(adapter->priv[i]) ==
1029                              MWIFIEX_BSS_ROLE_STA) &&
1030                             adapter->priv[i]->media_connected)
1031                                 mwifiex_deauthenticate(adapter->priv[i], NULL);
1032
1033                 mwifiex_init_shutdown_fw(mwifiex_get_priv(adapter,
1034                                                           MWIFIEX_BSS_ROLE_ANY),
1035                                          MWIFIEX_FUNC_SHUTDOWN);
1036         }
1037
1038         usb_deregister(&mwifiex_usb_driver);
1039 }
1040
1041 module_init(mwifiex_usb_init_module);
1042 module_exit(mwifiex_usb_cleanup_module);
1043
1044 MODULE_AUTHOR("Marvell International Ltd.");
1045 MODULE_DESCRIPTION("Marvell WiFi-Ex USB Driver version" USB_VERSION);
1046 MODULE_VERSION(USB_VERSION);
1047 MODULE_LICENSE("GPL v2");
1048 MODULE_FIRMWARE("mrvl/usb8797_uapsta.bin");