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         if (atomic_read(&card->rx_cmd_urb_pending) && card->rx_cmd.urb)
 451                 usb_kill_urb(card->rx_cmd.urb);
 452
 453         if (atomic_read(&card->rx_data_urb_pending))
 454                 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
 455                         if (card->rx_data_list[i].urb)
 456                                 usb_kill_urb(card->rx_data_list[i].urb);
 457
 458         for (i = 0; i < MWIFIEX_TX_DATA_URB; i++)
 459                 if (card->tx_data_list[i].urb)
 460                         usb_kill_urb(card->tx_data_list[i].urb);
 461
 462         if (card->tx_cmd.urb)
 463                 usb_kill_urb(card->tx_cmd.urb);
 464
 465         return 0;
 466 }
 467
 468 /* Kernel needs to suspend all functions separately. Therefore all
 469  * registered functions must have drivers with suspend and resume
 470  * methods. Failing that the kernel simply removes the whole card.
 471  *
 472  * If already not resumed, this function turns on the traffic and
 473  * sends a 'host sleep cancel' request to the firmware.
 474  */
 475 static int mwifiex_usb_resume(struct usb_interface *intf)
 476 {
 477         struct usb_card_rec *card = usb_get_intfdata(intf);
 478         struct mwifiex_adapter *adapter;
 479         int i;
 480
 481         if (!card || !card->adapter) {
 482                 pr_err("%s: card or card->adapter is NULL\n", __func__);
 483                 return 0;
 484         }
 485         adapter = card->adapter;
 486
 487         if (unlikely(!adapter->is_suspended)) {
 488                 dev_warn(adapter->dev, "Device already resumed\n");
 489                 return 0;
 490         }
 491
 492         /* Indicate device resumed. The netdev queue will be resumed only
 493          * after the urbs have been re-submitted
 494          */
 495         adapter->is_suspended = false;
 496
 497         if (!atomic_read(&card->rx_data_urb_pending))
 498                 for (i = 0; i < MWIFIEX_RX_DATA_URB; i++)
 499                         mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
 500                                                   MWIFIEX_RX_DATA_BUF_SIZE);
 501
 502         if (!atomic_read(&card->rx_cmd_urb_pending)) {
 503                 card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
 504                 if (card->rx_cmd.skb)
 505                         mwifiex_usb_submit_rx_urb(&card->rx_cmd,
 506                                                   MWIFIEX_RX_CMD_BUF_SIZE);
 507         }
 508
 509         /* Disable Host Sleep */
 510         if (adapter->hs_activated)
 511                 mwifiex_cancel_hs(mwifiex_get_priv(adapter,
 512                                                    MWIFIEX_BSS_ROLE_ANY),
 513                                   MWIFIEX_ASYNC_CMD);
 514
 515 #ifdef CONFIG_PM
 516         /* Resume handler may be called due to remote wakeup,
 517          * force to exit suspend anyway
 518          */
 519         usb_disable_autosuspend(card->udev);
 520 #endif /* CONFIG_PM */
 521
 522         return 0;
 523 }
 524
 525 static void mwifiex_usb_disconnect(struct usb_interface *intf)
 526 {
 527         struct usb_card_rec *card = usb_get_intfdata(intf);
 528         struct mwifiex_adapter *adapter;
 529
 530         if (!card || !card->adapter) {
 531                 pr_err("%s: card or card->adapter is NULL\n", __func__);
 532                 return;
 533         }
 534
 535         adapter = card->adapter;
 536         if (!adapter->priv_num)
 537                 return;
 538
 539         mwifiex_usb_free(card);
 540
 541         dev_dbg(adapter->dev, "%s: removing card\n", __func__);
 542         mwifiex_remove_card(adapter, &add_remove_card_sem);
 543
 544         usb_set_intfdata(intf, NULL);
 545         usb_put_dev(interface_to_usbdev(intf));
 546         kfree(card);
 547
 548         return;
 549 }
 550
 551 static struct usb_driver mwifiex_usb_driver = {
 552         .name = usbdriver_name,
 553         .probe = mwifiex_usb_probe,
 554         .disconnect = mwifiex_usb_disconnect,
 555         .id_table = mwifiex_usb_table,
 556         .suspend = mwifiex_usb_suspend,
 557         .resume = mwifiex_usb_resume,
 558         .supports_autosuspend = 1,
 559 };
 560
 561 static int mwifiex_usb_tx_init(struct mwifiex_adapter *adapter)
 562 {
 563         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 564         int i;
 565
 566         card->tx_cmd.adapter = adapter;
 567         card->tx_cmd.ep = card->tx_cmd_ep;
 568
 569         card->tx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
 570         if (!card->tx_cmd.urb) {
 571                 dev_err(adapter->dev, "tx_cmd.urb allocation failed\n");
 572                 return -ENOMEM;
 573         }
 574
 575         card->tx_data_ix = 0;
 576
 577         for (i = 0; i < MWIFIEX_TX_DATA_URB; i++) {
 578                 card->tx_data_list[i].adapter = adapter;
 579                 card->tx_data_list[i].ep = card->tx_data_ep;
 580
 581                 card->tx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
 582                 if (!card->tx_data_list[i].urb) {
 583                         dev_err(adapter->dev,
 584                                 "tx_data_list[] urb allocation failed\n");
 585                         return -ENOMEM;
 586                 }
 587         }
 588
 589         return 0;
 590 }
 591
 592 static int mwifiex_usb_rx_init(struct mwifiex_adapter *adapter)
 593 {
 594         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 595         int i;
 596
 597         card->rx_cmd.adapter = adapter;
 598         card->rx_cmd.ep = card->rx_cmd_ep;
 599
 600         card->rx_cmd.urb = usb_alloc_urb(0, GFP_KERNEL);
 601         if (!card->rx_cmd.urb) {
 602                 dev_err(adapter->dev, "rx_cmd.urb allocation failed\n");
 603                 return -ENOMEM;
 604         }
 605
 606         card->rx_cmd.skb = dev_alloc_skb(MWIFIEX_RX_CMD_BUF_SIZE);
 607         if (!card->rx_cmd.skb) {
 608                 dev_err(adapter->dev, "rx_cmd.skb allocation failed\n");
 609                 return -ENOMEM;
 610         }
 611
 612         if (mwifiex_usb_submit_rx_urb(&card->rx_cmd, MWIFIEX_RX_CMD_BUF_SIZE))
 613                 return -1;
 614
 615         for (i = 0; i < MWIFIEX_RX_DATA_URB; i++) {
 616                 card->rx_data_list[i].adapter = adapter;
 617                 card->rx_data_list[i].ep = card->rx_data_ep;
 618
 619                 card->rx_data_list[i].urb = usb_alloc_urb(0, GFP_KERNEL);
 620                 if (!card->rx_data_list[i].urb) {
 621                         dev_err(adapter->dev,
 622                                 "rx_data_list[] urb allocation failed\n");
 623                         return -1;
 624                 }
 625                 if (mwifiex_usb_submit_rx_urb(&card->rx_data_list[i],
 626                                               MWIFIEX_RX_DATA_BUF_SIZE))
 627                         return -1;
 628         }
 629
 630         return 0;
 631 }
 632
 633 static int mwifiex_write_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
 634                                    u32 *len, u8 ep, u32 timeout)
 635 {
 636         struct usb_card_rec *card = adapter->card;
 637         int actual_length, ret;
 638
 639         if (!(*len % card->bulk_out_maxpktsize))
 640                 (*len)++;
 641
 642         /* Send the data block */
 643         ret = usb_bulk_msg(card->udev, usb_sndbulkpipe(card->udev, ep), pbuf,
 644                            *len, &actual_length, timeout);
 645         if (ret) {
 646                 dev_err(adapter->dev, "usb_bulk_msg for tx failed: %d\n", ret);
 647                 return ret;
 648         }
 649
 650         *len = actual_length;
 651
 652         return ret;
 653 }
 654
 655 static int mwifiex_read_data_sync(struct mwifiex_adapter *adapter, u8 *pbuf,
 656                                   u32 *len, u8 ep, u32 timeout)
 657 {
 658         struct usb_card_rec *card = adapter->card;
 659         int actual_length, ret;
 660
 661         /* Receive the data response */
 662         ret = usb_bulk_msg(card->udev, usb_rcvbulkpipe(card->udev, ep), pbuf,
 663                            *len, &actual_length, timeout);
 664         if (ret) {
 665                 dev_err(adapter->dev, "usb_bulk_msg for rx failed: %d\n", ret);
 666                 return ret;
 667         }
 668
 669         *len = actual_length;
 670
 671         return ret;
 672 }
 673
 674 /* This function write a command/data packet to card. */
 675 static int mwifiex_usb_host_to_card(struct mwifiex_adapter *adapter, u8 ep,
 676                                     struct sk_buff *skb,
 677                                     struct mwifiex_tx_param *tx_param)
 678 {
 679         struct usb_card_rec *card = adapter->card;
 680         struct urb_context *context;
 681         u8 *data = (u8 *)skb->data;
 682         struct urb *tx_urb;
 683
 684         if (adapter->is_suspended) {
 685                 dev_err(adapter->dev,
 686                         "%s: not allowed while suspended\n", __func__);
 687                 return -1;
 688         }
 689
 690         if (adapter->surprise_removed) {
 691                 dev_err(adapter->dev, "%s: device removed\n", __func__);
 692                 return -1;
 693         }
 694
 695         if (ep == card->tx_data_ep &&
 696             atomic_read(&card->tx_data_urb_pending) >= MWIFIEX_TX_DATA_URB) {
 697                 return -EBUSY;
 698         }
 699
 700         dev_dbg(adapter->dev, "%s: ep=%d\n", __func__, ep);
 701
 702         if (ep == card->tx_cmd_ep) {
 703                 context = &card->tx_cmd;
 704         } else {
 705                 if (card->tx_data_ix >= MWIFIEX_TX_DATA_URB)
 706                         card->tx_data_ix = 0;
 707                 context = &card->tx_data_list[card->tx_data_ix++];
 708         }
 709
 710         context->adapter = adapter;
 711         context->ep = ep;
 712         context->skb = skb;
 713         tx_urb = context->urb;
 714
 715         usb_fill_bulk_urb(tx_urb, card->udev, usb_sndbulkpipe(card->udev, ep),
 716                           data, skb->len, mwifiex_usb_tx_complete,
 717                           (void *)context);
 718
 719         tx_urb->transfer_flags |= URB_ZERO_PACKET;
 720
 721         if (ep == card->tx_cmd_ep)
 722                 atomic_inc(&card->tx_cmd_urb_pending);
 723         else
 724                 atomic_inc(&card->tx_data_urb_pending);
 725
 726         if (usb_submit_urb(tx_urb, GFP_ATOMIC)) {
 727                 dev_err(adapter->dev, "%s: usb_submit_urb failed\n", __func__);
 728                 if (ep == card->tx_cmd_ep) {
 729                         atomic_dec(&card->tx_cmd_urb_pending);
 730                 } else {
 731                         atomic_dec(&card->tx_data_urb_pending);
 732                         if (card->tx_data_ix)
 733                                 card->tx_data_ix--;
 734                         else
 735                                 card->tx_data_ix = MWIFIEX_TX_DATA_URB;
 736                 }
 737
 738                 return -1;
 739         } else {
 740                 if (ep == card->tx_data_ep &&
 741                     atomic_read(&card->tx_data_urb_pending) ==
 742                                                         MWIFIEX_TX_DATA_URB)
 743                         return -ENOSR;
 744         }
 745
 746         return -EINPROGRESS;
 747 }
 748
 749 /* This function register usb device and initialize parameter. */
 750 static int mwifiex_register_dev(struct mwifiex_adapter *adapter)
 751 {
 752         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 753
 754         card->adapter = adapter;
 755         adapter->dev = &card->udev->dev;
 756         strcpy(adapter->fw_name, USB8797_DEFAULT_FW_NAME);
 757
 758         return 0;
 759 }
 760
 761 static void mwifiex_unregister_dev(struct mwifiex_adapter *adapter)
 762 {
 763         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 764
 765         usb_set_intfdata(card->intf, NULL);
 766 }
 767
 768 static int mwifiex_prog_fw_w_helper(struct mwifiex_adapter *adapter,
 769                                     struct mwifiex_fw_image *fw)
 770 {
 771         int ret = 0;
 772         u8 *firmware = fw->fw_buf, *recv_buff;
 773         u32 retries = USB8797_FW_MAX_RETRY, dlen;
 774         u32 fw_seqnum = 0, tlen = 0, dnld_cmd = 0;
 775         struct fw_data *fwdata;
 776         struct fw_sync_header sync_fw;
 777         u8 check_winner = 1;
 778
 779         if (!firmware) {
 780                 dev_err(adapter->dev,
 781                         "No firmware image found! Terminating download\n");
 782                 ret = -1;
 783                 goto fw_exit;
 784         }
 785
 786         /* Allocate memory for transmit */
 787         fwdata = kzalloc(FW_DNLD_TX_BUF_SIZE, GFP_KERNEL);
 788         if (!fwdata)
 789                 goto fw_exit;
 790
 791         /* Allocate memory for receive */
 792         recv_buff = kzalloc(FW_DNLD_RX_BUF_SIZE, GFP_KERNEL);
 793         if (!recv_buff)
 794                 goto cleanup;
 795
 796         do {
 797                 /* Send pseudo data to check winner status first */
 798                 if (check_winner) {
 799                         memset(&fwdata->fw_hdr, 0, sizeof(struct fw_header));
 800                         dlen = 0;
 801                 } else {
 802                         /* copy the header of the fw_data to get the length */
 803                         memcpy(&fwdata->fw_hdr, &firmware[tlen],
 804                                sizeof(struct fw_header));
 805
 806                         dlen = le32_to_cpu(fwdata->fw_hdr.data_len);
 807                         dnld_cmd = le32_to_cpu(fwdata->fw_hdr.dnld_cmd);
 808                         tlen += sizeof(struct fw_header);
 809
 810                         memcpy(fwdata->data, &firmware[tlen], dlen);
 811
 812                         fwdata->seq_num = cpu_to_le32(fw_seqnum);
 813                         tlen += dlen;
 814                 }
 815
 816                 /* If the send/receive fails or CRC occurs then retry */
 817                 while (retries--) {
 818                         u8 *buf = (u8 *)fwdata;
 819                         u32 len = FW_DATA_XMIT_SIZE;
 820
 821                         /* send the firmware block */
 822                         ret = mwifiex_write_data_sync(adapter, buf, &len,
 823                                                 MWIFIEX_USB_EP_CMD_EVENT,
 824                                                 MWIFIEX_USB_TIMEOUT);
 825                         if (ret) {
 826                                 dev_err(adapter->dev,
 827                                         "write_data_sync: failed: %d\n", ret);
 828                                 continue;
 829                         }
 830
 831                         buf = recv_buff;
 832                         len = FW_DNLD_RX_BUF_SIZE;
 833
 834                         /* Receive the firmware block response */
 835                         ret = mwifiex_read_data_sync(adapter, buf, &len,
 836                                                 MWIFIEX_USB_EP_CMD_EVENT,
 837                                                 MWIFIEX_USB_TIMEOUT);
 838                         if (ret) {
 839                                 dev_err(adapter->dev,
 840                                         "read_data_sync: failed: %d\n", ret);
 841                                 continue;
 842                         }
 843
 844                         memcpy(&sync_fw, recv_buff,
 845                                sizeof(struct fw_sync_header));
 846
 847                         /* check 1st firmware block resp for highest bit set */
 848                         if (check_winner) {
 849                                 if (le32_to_cpu(sync_fw.cmd) & 0x80000000) {
 850                                         dev_warn(adapter->dev,
 851                                                  "USB is not the winner %#x\n",
 852                                                  sync_fw.cmd);
 853
 854                                         /* returning success */
 855                                         ret = 0;
 856                                         goto cleanup;
 857                                 }
 858
 859                                 dev_dbg(adapter->dev,
 860                                         "USB is the winner, start to download FW\n");
 861
 862                                 check_winner = 0;
 863                                 break;
 864                         }
 865
 866                         /* check the firmware block response for CRC errors */
 867                         if (sync_fw.cmd) {
 868                                 dev_err(adapter->dev,
 869                                         "FW received block with CRC %#x\n",
 870                                         sync_fw.cmd);
 871                                 ret = -1;
 872                                 continue;
 873                         }
 874
 875                         retries = USB8797_FW_MAX_RETRY;
 876                         break;
 877                 }
 878                 fw_seqnum++;
 879         } while ((dnld_cmd != FW_HAS_LAST_BLOCK) && retries);
 880
 881 cleanup:
 882         dev_dbg(adapter->dev, "%s: %d bytes downloaded\n", __func__, tlen);
 883
 884         kfree(recv_buff);
 885         kfree(fwdata);
 886
 887         if (retries)
 888                 ret = 0;
 889 fw_exit:
 890         return ret;
 891 }
 892
 893 static int mwifiex_usb_dnld_fw(struct mwifiex_adapter *adapter,
 894                         struct mwifiex_fw_image *fw)
 895 {
 896         int ret;
 897         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 898
 899         if (card->usb_boot_state == USB8797_FW_DNLD) {
 900                 ret = mwifiex_prog_fw_w_helper(adapter, fw);
 901                 if (ret)
 902                         return -1;
 903
 904                 /* Boot state changes after successful firmware download */
 905                 if (card->usb_boot_state == USB8797_FW_DNLD)
 906                         return -1;
 907         }
 908
 909         ret = mwifiex_usb_rx_init(adapter);
 910         if (!ret)
 911                 ret = mwifiex_usb_tx_init(adapter);
 912
 913         return ret;
 914 }
 915
 916 static void mwifiex_submit_rx_urb(struct mwifiex_adapter *adapter, u8 ep)
 917 {
 918         struct usb_card_rec *card = (struct usb_card_rec *)adapter->card;
 919
 920         skb_push(card->rx_cmd.skb, INTF_HEADER_LEN);
 921         if ((ep == card->rx_cmd_ep) &&
 922             (!atomic_read(&card->rx_cmd_urb_pending)))
 923                 mwifiex_usb_submit_rx_urb(&card->rx_cmd,
 924                                           MWIFIEX_RX_CMD_BUF_SIZE);
 925
 926         return;
 927 }
 928
 929 static int mwifiex_usb_cmd_event_complete(struct mwifiex_adapter *adapter,
 930                                        struct sk_buff *skb)
 931 {
 932         atomic_dec(&adapter->rx_pending);
 933         mwifiex_submit_rx_urb(adapter, MWIFIEX_USB_EP_CMD_EVENT);
 934
 935         return 0;
 936 }
 937
 938 static int mwifiex_usb_data_complete(struct mwifiex_adapter *adapter,
 939                                      struct sk_buff *skb)
 940 {
 941         atomic_dec(&adapter->rx_pending);
 942         dev_kfree_skb_any(skb);
 943
 944         return 0;
 945 }
 946
 947 /* This function wakes up the card. */
 948 static int mwifiex_pm_wakeup_card(struct mwifiex_adapter *adapter)
 949 {
 950         /* Simulation of HS_AWAKE event */
 951         adapter->pm_wakeup_fw_try = false;
 952         adapter->pm_wakeup_card_req = false;
 953         adapter->ps_state = PS_STATE_AWAKE;
 954
 955         return 0;
 956 }
 957
 958 static struct mwifiex_if_ops usb_ops = {
 959         .register_dev =         mwifiex_register_dev,
 960         .unregister_dev =       mwifiex_unregister_dev,
 961         .wakeup =               mwifiex_pm_wakeup_card,
 962         .wakeup_complete =      mwifiex_pm_wakeup_card_complete,
 963
 964         /* USB specific */
 965         .dnld_fw =              mwifiex_usb_dnld_fw,
 966         .cmdrsp_complete =      mwifiex_usb_cmd_event_complete,
 967         .event_complete =       mwifiex_usb_cmd_event_complete,
 968         .data_complete =        mwifiex_usb_data_complete,
 969         .host_to_card =         mwifiex_usb_host_to_card,
 970 };
 971
 972 /* This function initializes the USB driver module.
 973  *
 974  * This initiates the semaphore and registers the device with
 975  * USB bus.
 976  */
 977 static int mwifiex_usb_init_module(void)
 978 {
 979         int ret;
 980
 981         pr_debug("Marvell USB8797 Driver\n");
 982
 983         sema_init(&add_remove_card_sem, 1);
 984
 985         ret = usb_register(&mwifiex_usb_driver);
 986         if (ret)
 987                 pr_err("Driver register failed!\n");
 988         else
 989                 pr_debug("info: Driver registered successfully!\n");
 990
 991         return ret;
 992 }
 993
 994 /* This function cleans up the USB driver.
 995  *
 996  * The following major steps are followed in .disconnect for cleanup:
 997  *      - Resume the device if its suspended
 998  *      - Disconnect the device if connected
 999  *      - Shutdown the firmware
1000  *      - Unregister the device from USB bus.
1001  */
1002 static void mwifiex_usb_cleanup_module(void)
1003 {
1004         if (!down_interruptible(&add_remove_card_sem))
1005                 up(&add_remove_card_sem);
1006
1007         if (usb_card) {
1008                 struct mwifiex_adapter *adapter = usb_card->adapter;
1009                 int i;
1010
1011                 /* In case driver is removed when asynchronous FW downloading is
1012                  * in progress
1013                  */
1014                 wait_for_completion(&adapter->fw_load);
1015
1016 #ifdef CONFIG_PM
1017                 if (adapter->is_suspended)
1018                         mwifiex_usb_resume(usb_card->intf);
1019 #endif
1020                 for (i = 0; i < adapter->priv_num; i++)
1021                         if ((GET_BSS_ROLE(adapter->priv[i]) ==
1022                              MWIFIEX_BSS_ROLE_STA) &&
1023                             adapter->priv[i]->media_connected)
1024                                 mwifiex_deauthenticate(adapter->priv[i], NULL);
1025
1026                 mwifiex_init_shutdown_fw(mwifiex_get_priv(adapter,
1027                                                           MWIFIEX_BSS_ROLE_ANY),
1028                                          MWIFIEX_FUNC_SHUTDOWN);
1029         }
1030
1031         usb_deregister(&mwifiex_usb_driver);
1032 }
1033
1034 module_init(mwifiex_usb_init_module);
1035 module_exit(mwifiex_usb_cleanup_module);
1036
1037 MODULE_AUTHOR("Marvell International Ltd.");
1038 MODULE_DESCRIPTION("Marvell WiFi-Ex USB Driver version" USB_VERSION);
1039 MODULE_VERSION(USB_VERSION);
1040 MODULE_LICENSE("GPL v2");
1041 MODULE_FIRMWARE("mrvl/usb8797_uapsta.bin");