drivers/net/wireless/ath/carl9170/usb.c

   1 /*
   2  * Atheros CARL9170 driver
   3  *
   4  * USB - frontend
   5  *
   6  * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
   7  * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; see the file COPYING.  If not, see
  21  * http://www.gnu.org/licenses/.
  22  *
  23  * This file incorporates work covered by the following copyright and
  24  * permission notice:
  25  *    Copyright (c) 2007-2008 Atheros Communications, Inc.
  26  *
  27  *    Permission to use, copy, modify, and/or distribute this software for any
  28  *    purpose with or without fee is hereby granted, provided that the above
  29  *    copyright notice and this permission notice appear in all copies.
  30  *
  31  *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  32  *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  33  *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  34  *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  35  *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  36  *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  37  *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  38  */
  39
  40 #include <linux/module.h>
  41 #include <linux/slab.h>
  42 #include <linux/usb.h>
  43 #include <linux/firmware.h>
  44 #include <linux/etherdevice.h>
  45 #include <linux/device.h>
  46 #include <net/mac80211.h>
  47 #include "carl9170.h"
  48 #include "cmd.h"
  49 #include "hw.h"
  50 #include "fwcmd.h"
  51
  52 MODULE_AUTHOR("Johannes Berg <johannes@sipsolutions.net>");
  53 MODULE_AUTHOR("Christian Lamparter <chunkeey@googlemail.com>");
  54 MODULE_LICENSE("GPL");
  55 MODULE_DESCRIPTION("Atheros AR9170 802.11n USB wireless");
  56 MODULE_FIRMWARE(CARL9170FW_NAME);
  57 MODULE_ALIAS("ar9170usb");
  58 MODULE_ALIAS("arusb_lnx");
  59
  60 /*
  61  * Note:
  62  *
  63  * Always update our wiki's device list (located at:
  64  * http://wireless.kernel.org/en/users/Drivers/ar9170/devices ),
  65  * whenever you add a new device.
  66  */
  67 static struct usb_device_id carl9170_usb_ids[] = {
  68         /* Atheros 9170 */
  69         { USB_DEVICE(0x0cf3, 0x9170) },
  70         /* Atheros TG121N */
  71         { USB_DEVICE(0x0cf3, 0x1001) },
  72         /* TP-Link TL-WN821N v2 */
  73         { USB_DEVICE(0x0cf3, 0x1002), .driver_info = CARL9170_WPS_BUTTON |
  74                  CARL9170_ONE_LED },
  75         /* 3Com Dual Band 802.11n USB Adapter */
  76         { USB_DEVICE(0x0cf3, 0x1010) },
  77         /* H3C Dual Band 802.11n USB Adapter */
  78         { USB_DEVICE(0x0cf3, 0x1011) },
  79         /* Cace Airpcap NX */
  80         { USB_DEVICE(0xcace, 0x0300) },
  81         /* D-Link DWA 160 A1 */
  82         { USB_DEVICE(0x07d1, 0x3c10) },
  83         /* D-Link DWA 160 A2 */
  84         { USB_DEVICE(0x07d1, 0x3a09) },
  85         /* D-Link DWA 130 D */
  86         { USB_DEVICE(0x07d1, 0x3a0f) },
  87         /* Netgear WNA1000 */
  88         { USB_DEVICE(0x0846, 0x9040) },
  89         /* Netgear WNDA3100 (v1) */
  90         { USB_DEVICE(0x0846, 0x9010) },
  91         /* Netgear WN111 v2 */
  92         { USB_DEVICE(0x0846, 0x9001), .driver_info = CARL9170_ONE_LED },
  93         /* Zydas ZD1221 */
  94         { USB_DEVICE(0x0ace, 0x1221) },
  95         /* Proxim ORiNOCO 802.11n USB */
  96         { USB_DEVICE(0x1435, 0x0804) },
  97         /* WNC Generic 11n USB Dongle */
  98         { USB_DEVICE(0x1435, 0x0326) },
  99         /* ZyXEL NWD271N */
 100         { USB_DEVICE(0x0586, 0x3417) },
 101         /* Z-Com UB81 BG */
 102         { USB_DEVICE(0x0cde, 0x0023) },
 103         /* Z-Com UB82 ABG */
 104         { USB_DEVICE(0x0cde, 0x0026) },
 105         /* Sphairon Homelink 1202 */
 106         { USB_DEVICE(0x0cde, 0x0027) },
 107         /* Arcadyan WN7512 */
 108         { USB_DEVICE(0x083a, 0xf522) },
 109         /* Planex GWUS300 */
 110         { USB_DEVICE(0x2019, 0x5304) },
 111         /* IO-Data WNGDNUS2 */
 112         { USB_DEVICE(0x04bb, 0x093f) },
 113         /* NEC WL300NU-G */
 114         { USB_DEVICE(0x0409, 0x0249) },
 115         /* AVM FRITZ!WLAN USB Stick N */
 116         { USB_DEVICE(0x057c, 0x8401) },
 117         /* AVM FRITZ!WLAN USB Stick N 2.4 */
 118         { USB_DEVICE(0x057c, 0x8402) },
 119         /* Qwest/Actiontec 802AIN Wireless N USB Network Adapter */
 120         { USB_DEVICE(0x1668, 0x1200) },
 121         /* Airlive X.USB a/b/g/n */
 122         { USB_DEVICE(0x1b75, 0x9170) },
 123
 124         /* terminate */
 125         {}
 126 };
 127 MODULE_DEVICE_TABLE(usb, carl9170_usb_ids);
 128
 129 static void carl9170_usb_submit_data_urb(struct ar9170 *ar)
 130 {
 131         struct urb *urb;
 132         int err;
 133
 134         if (atomic_inc_return(&ar->tx_anch_urbs) > AR9170_NUM_TX_URBS)
 135                 goto err_acc;
 136
 137         urb = usb_get_from_anchor(&ar->tx_wait);
 138         if (!urb)
 139                 goto err_acc;
 140
 141         usb_anchor_urb(urb, &ar->tx_anch);
 142
 143         err = usb_submit_urb(urb, GFP_ATOMIC);
 144         if (unlikely(err)) {
 145                 if (net_ratelimit()) {
 146                         dev_err(&ar->udev->dev, "tx submit failed (%d)\n",
 147                                 urb->status);
 148                 }
 149
 150                 usb_unanchor_urb(urb);
 151                 usb_anchor_urb(urb, &ar->tx_err);
 152         }
 153
 154         usb_free_urb(urb);
 155
 156         if (likely(err == 0))
 157                 return;
 158
 159 err_acc:
 160         atomic_dec(&ar->tx_anch_urbs);
 161 }
 162
 163 static void carl9170_usb_tx_data_complete(struct urb *urb)
 164 {
 165         struct ar9170 *ar = (struct ar9170 *)
 166               usb_get_intfdata(usb_ifnum_to_if(urb->dev, 0));
 167
 168         if (WARN_ON_ONCE(!ar)) {
 169                 dev_kfree_skb_irq(urb->context);
 170                 return;
 171         }
 172
 173         atomic_dec(&ar->tx_anch_urbs);
 174
 175         switch (urb->status) {
 176         /* everything is fine */
 177         case 0:
 178                 carl9170_tx_callback(ar, (void *)urb->context);
 179                 break;
 180
 181         /* disconnect */
 182         case -ENOENT:
 183         case -ECONNRESET:
 184         case -ENODEV:
 185         case -ESHUTDOWN:
 186                 /*
 187                  * Defer the frame clean-up to the tasklet worker.
 188                  * This is necessary, because carl9170_tx_drop
 189                  * does not work in an irqsave context.
 190                  */
 191                 usb_anchor_urb(urb, &ar->tx_err);
 192                 return;
 193
 194         /* a random transmission error has occurred? */
 195         default:
 196                 if (net_ratelimit()) {
 197                         dev_err(&ar->udev->dev, "tx failed (%d)\n",
 198                                 urb->status);
 199                 }
 200
 201                 usb_anchor_urb(urb, &ar->tx_err);
 202                 break;
 203         }
 204
 205         if (likely(IS_STARTED(ar)))
 206                 carl9170_usb_submit_data_urb(ar);
 207 }
 208
 209 static int carl9170_usb_submit_cmd_urb(struct ar9170 *ar)
 210 {
 211         struct urb *urb;
 212         int err;
 213
 214         if (atomic_inc_return(&ar->tx_cmd_urbs) != 1) {
 215                 atomic_dec(&ar->tx_cmd_urbs);
 216                 return 0;
 217         }
 218
 219         urb = usb_get_from_anchor(&ar->tx_cmd);
 220         if (!urb) {
 221                 atomic_dec(&ar->tx_cmd_urbs);
 222                 return 0;
 223         }
 224
 225         usb_anchor_urb(urb, &ar->tx_anch);
 226         err = usb_submit_urb(urb, GFP_ATOMIC);
 227         if (unlikely(err)) {
 228                 usb_unanchor_urb(urb);
 229                 atomic_dec(&ar->tx_cmd_urbs);
 230         }
 231         usb_free_urb(urb);
 232
 233         return err;
 234 }
 235
 236 static void carl9170_usb_cmd_complete(struct urb *urb)
 237 {
 238         struct ar9170 *ar = urb->context;
 239         int err = 0;
 240
 241         if (WARN_ON_ONCE(!ar))
 242                 return;
 243
 244         atomic_dec(&ar->tx_cmd_urbs);
 245
 246         switch (urb->status) {
 247         /* everything is fine */
 248         case 0:
 249                 break;
 250
 251         /* disconnect */
 252         case -ENOENT:
 253         case -ECONNRESET:
 254         case -ENODEV:
 255         case -ESHUTDOWN:
 256                 return;
 257
 258         default:
 259                 err = urb->status;
 260                 break;
 261         }
 262
 263         if (!IS_INITIALIZED(ar))
 264                 return;
 265
 266         if (err)
 267                 dev_err(&ar->udev->dev, "submit cmd cb failed (%d).\n", err);
 268
 269         err = carl9170_usb_submit_cmd_urb(ar);
 270         if (err)
 271                 dev_err(&ar->udev->dev, "submit cmd failed (%d).\n", err);
 272 }
 273
 274 static void carl9170_usb_rx_irq_complete(struct urb *urb)
 275 {
 276         struct ar9170 *ar = urb->context;
 277
 278         if (WARN_ON_ONCE(!ar))
 279                 return;
 280
 281         switch (urb->status) {
 282         /* everything is fine */
 283         case 0:
 284                 break;
 285
 286         /* disconnect */
 287         case -ENOENT:
 288         case -ECONNRESET:
 289         case -ENODEV:
 290         case -ESHUTDOWN:
 291                 return;
 292
 293         default:
 294                 goto resubmit;
 295         }
 296
 297         carl9170_handle_command_response(ar, urb->transfer_buffer,
 298                                          urb->actual_length);
 299
 300 resubmit:
 301         usb_anchor_urb(urb, &ar->rx_anch);
 302         if (unlikely(usb_submit_urb(urb, GFP_ATOMIC)))
 303                 usb_unanchor_urb(urb);
 304 }
 305
 306 static int carl9170_usb_submit_rx_urb(struct ar9170 *ar, gfp_t gfp)
 307 {
 308         struct urb *urb;
 309         int err = 0, runs = 0;
 310
 311         while ((atomic_read(&ar->rx_anch_urbs) < AR9170_NUM_RX_URBS) &&
 312                 (runs++ < AR9170_NUM_RX_URBS)) {
 313                 err = -ENOSPC;
 314                 urb = usb_get_from_anchor(&ar->rx_pool);
 315                 if (urb) {
 316                         usb_anchor_urb(urb, &ar->rx_anch);
 317                         err = usb_submit_urb(urb, gfp);
 318                         if (unlikely(err)) {
 319                                 usb_unanchor_urb(urb);
 320                                 usb_anchor_urb(urb, &ar->rx_pool);
 321                         } else {
 322                                 atomic_dec(&ar->rx_pool_urbs);
 323                                 atomic_inc(&ar->rx_anch_urbs);
 324                         }
 325                         usb_free_urb(urb);
 326                 }
 327         }
 328
 329         return err;
 330 }
 331
 332 static void carl9170_usb_rx_work(struct ar9170 *ar)
 333 {
 334         struct urb *urb;
 335         int i;
 336
 337         for (i = 0; i < AR9170_NUM_RX_URBS_POOL; i++) {
 338                 urb = usb_get_from_anchor(&ar->rx_work);
 339                 if (!urb)
 340                         break;
 341
 342                 atomic_dec(&ar->rx_work_urbs);
 343                 if (IS_INITIALIZED(ar)) {
 344                         carl9170_rx(ar, urb->transfer_buffer,
 345                                     urb->actual_length);
 346                 }
 347
 348                 usb_anchor_urb(urb, &ar->rx_pool);
 349                 atomic_inc(&ar->rx_pool_urbs);
 350
 351                 usb_free_urb(urb);
 352
 353                 carl9170_usb_submit_rx_urb(ar, GFP_ATOMIC);
 354         }
 355 }
 356
 357 void carl9170_usb_handle_tx_err(struct ar9170 *ar)
 358 {
 359         struct urb *urb;
 360
 361         while ((urb = usb_get_from_anchor(&ar->tx_err))) {
 362                 struct sk_buff *skb = (void *)urb->context;
 363
 364                 carl9170_tx_drop(ar, skb);
 365                 carl9170_tx_callback(ar, skb);
 366                 usb_free_urb(urb);
 367         }
 368 }
 369
 370 static void carl9170_usb_tasklet(unsigned long data)
 371 {
 372         struct ar9170 *ar = (struct ar9170 *) data;
 373
 374         if (!IS_INITIALIZED(ar))
 375                 return;
 376
 377         carl9170_usb_rx_work(ar);
 378
 379         /*
 380          * Strictly speaking: The tx scheduler is not part of the USB system.
 381          * But the rx worker returns frames back to the mac80211-stack and
 382          * this is the _perfect_ place to generate the next transmissions.
 383          */
 384         if (IS_STARTED(ar))
 385                 carl9170_tx_scheduler(ar);
 386 }
 387
 388 static void carl9170_usb_rx_complete(struct urb *urb)
 389 {
 390         struct ar9170 *ar = (struct ar9170 *)urb->context;
 391         int err;
 392
 393         if (WARN_ON_ONCE(!ar))
 394                 return;
 395
 396         atomic_dec(&ar->rx_anch_urbs);
 397
 398         switch (urb->status) {
 399         case 0:
 400                 /* rx path */
 401                 usb_anchor_urb(urb, &ar->rx_work);
 402                 atomic_inc(&ar->rx_work_urbs);
 403                 break;
 404
 405         case -ENOENT:
 406         case -ECONNRESET:
 407         case -ENODEV:
 408         case -ESHUTDOWN:
 409                 /* handle disconnect events*/
 410                 return;
 411
 412         default:
 413                 /* handle all other errors */
 414                 usb_anchor_urb(urb, &ar->rx_pool);
 415                 atomic_inc(&ar->rx_pool_urbs);
 416                 break;
 417         }
 418
 419         err = carl9170_usb_submit_rx_urb(ar, GFP_ATOMIC);
 420         if (unlikely(err)) {
 421                 /*
 422                  * usb_submit_rx_urb reported a problem.
 423                  * In case this is due to a rx buffer shortage,
 424                  * elevate the tasklet worker priority to
 425                  * the highest available level.
 426                  */
 427                 tasklet_hi_schedule(&ar->usb_tasklet);
 428
 429                 if (atomic_read(&ar->rx_anch_urbs) == 0) {
 430                         /*
 431                          * The system is too slow to cope with
 432                          * the enormous workload. We have simply
 433                          * run out of active rx urbs and this
 434                          * unfortunatly leads to an unpredictable
 435                          * device.
 436                          */
 437
 438                         carl9170_restart(ar, CARL9170_RR_SLOW_SYSTEM);
 439                 }
 440         } else {
 441                 /*
 442                  * Using anything less than _high_ priority absolutely
 443                  * kills the rx performance my UP-System...
 444                  */
 445                 tasklet_hi_schedule(&ar->usb_tasklet);
 446         }
 447 }
 448
 449 static struct urb *carl9170_usb_alloc_rx_urb(struct ar9170 *ar, gfp_t gfp)
 450 {
 451         struct urb *urb;
 452         void *buf;
 453
 454         buf = kmalloc(ar->fw.rx_size, gfp);
 455         if (!buf)
 456                 return NULL;
 457
 458         urb = usb_alloc_urb(0, gfp);
 459         if (!urb) {
 460                 kfree(buf);
 461                 return NULL;
 462         }
 463
 464         usb_fill_bulk_urb(urb, ar->udev, usb_rcvbulkpipe(ar->udev,
 465                           AR9170_USB_EP_RX), buf, ar->fw.rx_size,
 466                           carl9170_usb_rx_complete, ar);
 467
 468         urb->transfer_flags |= URB_FREE_BUFFER;
 469
 470         return urb;
 471 }
 472
 473 static int carl9170_usb_send_rx_irq_urb(struct ar9170 *ar)
 474 {
 475         struct urb *urb = NULL;
 476         void *ibuf;
 477         int err = -ENOMEM;
 478
 479         urb = usb_alloc_urb(0, GFP_KERNEL);
 480         if (!urb)
 481                 goto out;
 482
 483         ibuf = kmalloc(AR9170_USB_EP_CTRL_MAX, GFP_KERNEL);
 484         if (!ibuf)
 485                 goto out;
 486
 487         usb_fill_int_urb(urb, ar->udev, usb_rcvintpipe(ar->udev,
 488                          AR9170_USB_EP_IRQ), ibuf, AR9170_USB_EP_CTRL_MAX,
 489                          carl9170_usb_rx_irq_complete, ar, 1);
 490
 491         urb->transfer_flags |= URB_FREE_BUFFER;
 492
 493         usb_anchor_urb(urb, &ar->rx_anch);
 494         err = usb_submit_urb(urb, GFP_KERNEL);
 495         if (err)
 496                 usb_unanchor_urb(urb);
 497
 498 out:
 499         usb_free_urb(urb);
 500         return err;
 501 }
 502
 503 static int carl9170_usb_init_rx_bulk_urbs(struct ar9170 *ar)
 504 {
 505         struct urb *urb;
 506         int i, err = -EINVAL;
 507
 508         /*
 509          * The driver actively maintains a second shadow
 510          * pool for inactive, but fully-prepared rx urbs.
 511          *
 512          * The pool should help the driver to master huge
 513          * workload spikes without running the risk of
 514          * undersupplying the hardware or wasting time by
 515          * processing rx data (streams) inside the urb
 516          * completion (hardirq context).
 517          */
 518         for (i = 0; i < AR9170_NUM_RX_URBS_POOL; i++) {
 519                 urb = carl9170_usb_alloc_rx_urb(ar, GFP_KERNEL);
 520                 if (!urb) {
 521                         err = -ENOMEM;
 522                         goto err_out;
 523                 }
 524
 525                 usb_anchor_urb(urb, &ar->rx_pool);
 526                 atomic_inc(&ar->rx_pool_urbs);
 527                 usb_free_urb(urb);
 528         }
 529
 530         err = carl9170_usb_submit_rx_urb(ar, GFP_KERNEL);
 531         if (err)
 532                 goto err_out;
 533
 534         /* the device now waiting for the firmware. */
 535         carl9170_set_state_when(ar, CARL9170_STOPPED, CARL9170_IDLE);
 536         return 0;
 537
 538 err_out:
 539
 540         usb_scuttle_anchored_urbs(&ar->rx_pool);
 541         usb_scuttle_anchored_urbs(&ar->rx_work);
 542         usb_kill_anchored_urbs(&ar->rx_anch);
 543         return err;
 544 }
 545
 546 static int carl9170_usb_flush(struct ar9170 *ar)
 547 {
 548         struct urb *urb;
 549         int ret, err = 0;
 550
 551         while ((urb = usb_get_from_anchor(&ar->tx_wait))) {
 552                 struct sk_buff *skb = (void *)urb->context;
 553                 carl9170_tx_drop(ar, skb);
 554                 carl9170_tx_callback(ar, skb);
 555                 usb_free_urb(urb);
 556         }
 557
 558         ret = usb_wait_anchor_empty_timeout(&ar->tx_cmd, 1000);
 559         if (ret == 0)
 560                 err = -ETIMEDOUT;
 561
 562         /* lets wait a while until the tx - queues are dried out */
 563         ret = usb_wait_anchor_empty_timeout(&ar->tx_anch, 1000);
 564         if (ret == 0)
 565                 err = -ETIMEDOUT;
 566
 567         usb_kill_anchored_urbs(&ar->tx_anch);
 568         carl9170_usb_handle_tx_err(ar);
 569
 570         return err;
 571 }
 572
 573 static void carl9170_usb_cancel_urbs(struct ar9170 *ar)
 574 {
 575         int err;
 576
 577         carl9170_set_state(ar, CARL9170_UNKNOWN_STATE);
 578
 579         err = carl9170_usb_flush(ar);
 580         if (err)
 581                 dev_err(&ar->udev->dev, "stuck tx urbs!\n");
 582
 583         usb_poison_anchored_urbs(&ar->tx_anch);
 584         carl9170_usb_handle_tx_err(ar);
 585         usb_poison_anchored_urbs(&ar->rx_anch);
 586
 587         tasklet_kill(&ar->usb_tasklet);
 588
 589         usb_scuttle_anchored_urbs(&ar->rx_work);
 590         usb_scuttle_anchored_urbs(&ar->rx_pool);
 591         usb_scuttle_anchored_urbs(&ar->tx_cmd);
 592 }
 593
 594 int __carl9170_exec_cmd(struct ar9170 *ar, struct carl9170_cmd *cmd,
 595                         const bool free_buf)
 596 {
 597         struct urb *urb;
 598         int err = 0;
 599
 600         if (!IS_INITIALIZED(ar)) {
 601                 err = -EPERM;
 602                 goto err_free;
 603         }
 604
 605         if (WARN_ON(cmd->hdr.len > CARL9170_MAX_CMD_LEN - 4)) {
 606                 err = -EINVAL;
 607                 goto err_free;
 608         }
 609
 610         urb = usb_alloc_urb(0, GFP_ATOMIC);
 611         if (!urb) {
 612                 err = -ENOMEM;
 613                 goto err_free;
 614         }
 615
 616         usb_fill_int_urb(urb, ar->udev, usb_sndintpipe(ar->udev,
 617                 AR9170_USB_EP_CMD), cmd, cmd->hdr.len + 4,
 618                 carl9170_usb_cmd_complete, ar, 1);
 619
 620         if (free_buf)
 621                 urb->transfer_flags |= URB_FREE_BUFFER;
 622
 623         usb_anchor_urb(urb, &ar->tx_cmd);
 624         usb_free_urb(urb);
 625
 626         return carl9170_usb_submit_cmd_urb(ar);
 627
 628 err_free:
 629         if (free_buf)
 630                 kfree(cmd);
 631
 632         return err;
 633 }
 634
 635 int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids cmd,
 636         unsigned int plen, void *payload, unsigned int outlen, void *out)
 637 {
 638         int err = -ENOMEM;
 639
 640         if (!IS_ACCEPTING_CMD(ar))
 641                 return -EIO;
 642
 643         if (!(cmd & CARL9170_CMD_ASYNC_FLAG))
 644                 might_sleep();
 645
 646         ar->cmd.hdr.len = plen;
 647         ar->cmd.hdr.cmd = cmd;
 648         /* writing multiple regs fills this buffer already */
 649         if (plen && payload != (u8 *)(ar->cmd.data))
 650                 memcpy(ar->cmd.data, payload, plen);
 651
 652         spin_lock_bh(&ar->cmd_lock);
 653         ar->readbuf = (u8 *)out;
 654         ar->readlen = outlen;
 655         spin_unlock_bh(&ar->cmd_lock);
 656
 657         err = __carl9170_exec_cmd(ar, &ar->cmd, false);
 658
 659         if (!(cmd & CARL9170_CMD_ASYNC_FLAG)) {
 660                 err = wait_for_completion_timeout(&ar->cmd_wait, HZ);
 661                 if (err == 0) {
 662                         err = -ETIMEDOUT;
 663                         goto err_unbuf;
 664                 }
 665
 666                 if (ar->readlen != outlen) {
 667                         err = -EMSGSIZE;
 668                         goto err_unbuf;
 669                 }
 670         }
 671
 672         return 0;
 673
 674 err_unbuf:
 675         /* Maybe the device was removed in the moment we were waiting? */
 676         if (IS_STARTED(ar)) {
 677                 dev_err(&ar->udev->dev, "no command feedback "
 678                         "received (%d).\n", err);
 679
 680                 /* provide some maybe useful debug information */
 681                 print_hex_dump_bytes("carl9170 cmd: ", DUMP_PREFIX_NONE,
 682                                      &ar->cmd, plen + 4);
 683
 684                 carl9170_restart(ar, CARL9170_RR_COMMAND_TIMEOUT);
 685         }
 686
 687         /* invalidate to avoid completing the next command prematurely */
 688         spin_lock_bh(&ar->cmd_lock);
 689         ar->readbuf = NULL;
 690         ar->readlen = 0;
 691         spin_unlock_bh(&ar->cmd_lock);
 692
 693         return err;
 694 }
 695
 696 void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb)
 697 {
 698         struct urb *urb;
 699         struct ar9170_stream *tx_stream;
 700         void *data;
 701         unsigned int len;
 702
 703         if (!IS_STARTED(ar))
 704                 goto err_drop;
 705
 706         urb = usb_alloc_urb(0, GFP_ATOMIC);
 707         if (!urb)
 708                 goto err_drop;
 709
 710         if (ar->fw.tx_stream) {
 711                 tx_stream = (void *) (skb->data - sizeof(*tx_stream));
 712
 713                 len = skb->len + sizeof(*tx_stream);
 714                 tx_stream->length = cpu_to_le16(len);
 715                 tx_stream->tag = cpu_to_le16(AR9170_TX_STREAM_TAG);
 716                 data = tx_stream;
 717         } else {
 718                 data = skb->data;
 719                 len = skb->len;
 720         }
 721
 722         usb_fill_bulk_urb(urb, ar->udev, usb_sndbulkpipe(ar->udev,
 723                 AR9170_USB_EP_TX), data, len,
 724                 carl9170_usb_tx_data_complete, skb);
 725
 726         urb->transfer_flags |= URB_ZERO_PACKET;
 727
 728         usb_anchor_urb(urb, &ar->tx_wait);
 729
 730         usb_free_urb(urb);
 731
 732         carl9170_usb_submit_data_urb(ar);
 733         return;
 734
 735 err_drop:
 736         carl9170_tx_drop(ar, skb);
 737         carl9170_tx_callback(ar, skb);
 738 }
 739
 740 static void carl9170_release_firmware(struct ar9170 *ar)
 741 {
 742         if (ar->fw.fw) {
 743                 release_firmware(ar->fw.fw);
 744                 memset(&ar->fw, 0, sizeof(ar->fw));
 745         }
 746 }
 747
 748 void carl9170_usb_stop(struct ar9170 *ar)
 749 {
 750         int ret;
 751
 752         carl9170_set_state_when(ar, CARL9170_IDLE, CARL9170_STOPPED);
 753
 754         ret = carl9170_usb_flush(ar);
 755         if (ret)
 756                 dev_err(&ar->udev->dev, "kill pending tx urbs.\n");
 757
 758         usb_poison_anchored_urbs(&ar->tx_anch);
 759         carl9170_usb_handle_tx_err(ar);
 760
 761         /* kill any pending command */
 762         spin_lock_bh(&ar->cmd_lock);
 763         ar->readlen = 0;
 764         spin_unlock_bh(&ar->cmd_lock);
 765         complete_all(&ar->cmd_wait);
 766
 767         /* This is required to prevent an early completion on _start */
 768         INIT_COMPLETION(ar->cmd_wait);
 769
 770         /*
 771          * Note:
 772          * So far we freed all tx urbs, but we won't dare to touch any rx urbs.
 773          * Else we would end up with a unresponsive device...
 774          */
 775 }
 776
 777 int carl9170_usb_open(struct ar9170 *ar)
 778 {
 779         usb_unpoison_anchored_urbs(&ar->tx_anch);
 780
 781         carl9170_set_state_when(ar, CARL9170_STOPPED, CARL9170_IDLE);
 782         return 0;
 783 }
 784
 785 static int carl9170_usb_load_firmware(struct ar9170 *ar)
 786 {
 787         const u8 *data;
 788         u8 *buf;
 789         unsigned int transfer;
 790         size_t len;
 791         u32 addr;
 792         int err = 0;
 793
 794         buf = kmalloc(4096, GFP_KERNEL);
 795         if (!buf) {
 796                 err = -ENOMEM;
 797                 goto err_out;
 798         }
 799
 800         data = ar->fw.fw->data;
 801         len = ar->fw.fw->size;
 802         addr = ar->fw.address;
 803
 804         /* this removes the miniboot image */
 805         data += ar->fw.offset;
 806         len -= ar->fw.offset;
 807
 808         while (len) {
 809                 transfer = min_t(unsigned int, len, 4096u);
 810                 memcpy(buf, data, transfer);
 811
 812                 err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
 813                                       0x30 /* FW DL */, 0x40 | USB_DIR_OUT,
 814                                       addr >> 8, 0, buf, transfer, 100);
 815
 816                 if (err < 0) {
 817                         kfree(buf);
 818                         goto err_out;
 819                 }
 820
 821                 len -= transfer;
 822                 data += transfer;
 823                 addr += transfer;
 824         }
 825         kfree(buf);
 826
 827         err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
 828                               0x31 /* FW DL COMPLETE */,
 829                               0x40 | USB_DIR_OUT, 0, 0, NULL, 0, 200);
 830
 831         if (wait_for_completion_timeout(&ar->fw_boot_wait, HZ) == 0) {
 832                 err = -ETIMEDOUT;
 833                 goto err_out;
 834         }
 835
 836         err = carl9170_echo_test(ar, 0x4a110123);
 837         if (err)
 838                 goto err_out;
 839
 840         /* firmware restarts cmd counter */
 841         ar->cmd_seq = -1;
 842
 843         return 0;
 844
 845 err_out:
 846         dev_err(&ar->udev->dev, "firmware upload failed (%d).\n", err);
 847         return err;
 848 }
 849
 850 int carl9170_usb_restart(struct ar9170 *ar)
 851 {
 852         int err = 0;
 853
 854         if (ar->intf->condition != USB_INTERFACE_BOUND)
 855                 return 0;
 856
 857         /* Disable command response sequence counter. */
 858         ar->cmd_seq = -2;
 859
 860         err = carl9170_reboot(ar);
 861
 862         carl9170_usb_stop(ar);
 863
 864         if (err)
 865                 goto err_out;
 866
 867         tasklet_schedule(&ar->usb_tasklet);
 868
 869         /* The reboot procedure can take quite a while to complete. */
 870         msleep(1100);
 871
 872         err = carl9170_usb_open(ar);
 873         if (err)
 874                 goto err_out;
 875
 876         err = carl9170_usb_load_firmware(ar);
 877         if (err)
 878                 goto err_out;
 879
 880         return 0;
 881
 882 err_out:
 883         carl9170_usb_cancel_urbs(ar);
 884         return err;
 885 }
 886
 887 void carl9170_usb_reset(struct ar9170 *ar)
 888 {
 889         /*
 890          * This is the last resort to get the device going again
 891          * without any *user replugging action*.
 892          *
 893          * But there is a catch: usb_reset really is like a physical
 894          * *reconnect*. The mac80211 state will be lost in the process.
 895          * Therefore a userspace application, which is monitoring
 896          * the link must step in.
 897          */
 898         carl9170_usb_cancel_urbs(ar);
 899
 900         carl9170_usb_stop(ar);
 901
 902         usb_queue_reset_device(ar->intf);
 903 }
 904
 905 static int carl9170_usb_init_device(struct ar9170 *ar)
 906 {
 907         int err;
 908
 909         err = carl9170_usb_send_rx_irq_urb(ar);
 910         if (err)
 911                 goto err_out;
 912
 913         err = carl9170_usb_init_rx_bulk_urbs(ar);
 914         if (err)
 915                 goto err_unrx;
 916
 917         mutex_lock(&ar->mutex);
 918         err = carl9170_usb_load_firmware(ar);
 919         mutex_unlock(&ar->mutex);
 920         if (err)
 921                 goto err_unrx;
 922
 923         return 0;
 924
 925 err_unrx:
 926         carl9170_usb_cancel_urbs(ar);
 927
 928 err_out:
 929         return err;
 930 }
 931
 932 static void carl9170_usb_firmware_failed(struct ar9170 *ar)
 933 {
 934         struct device *parent = ar->udev->dev.parent;
 935         struct usb_device *udev;
 936
 937         /*
 938          * Store a copy of the usb_device pointer locally.
 939          * This is because device_release_driver initiates
 940          * carl9170_usb_disconnect, which in turn frees our
 941          * driver context (ar).
 942          */
 943         udev = ar->udev;
 944
 945         complete(&ar->fw_load_wait);
 946
 947         /* unbind anything failed */
 948         if (parent)
 949                 device_lock(parent);
 950
 951         device_release_driver(&udev->dev);
 952         if (parent)
 953                 device_unlock(parent);
 954
 955         usb_put_dev(udev);
 956 }
 957
 958 static void carl9170_usb_firmware_finish(struct ar9170 *ar)
 959 {
 960         int err;
 961
 962         err = carl9170_parse_firmware(ar);
 963         if (err)
 964                 goto err_freefw;
 965
 966         err = carl9170_usb_init_device(ar);
 967         if (err)
 968                 goto err_freefw;
 969
 970         err = carl9170_usb_open(ar);
 971         if (err)
 972                 goto err_unrx;
 973
 974         err = carl9170_register(ar);
 975
 976         carl9170_usb_stop(ar);
 977         if (err)
 978                 goto err_unrx;
 979
 980         complete(&ar->fw_load_wait);
 981         usb_put_dev(ar->udev);
 982         return;
 983
 984 err_unrx:
 985         carl9170_usb_cancel_urbs(ar);
 986
 987 err_freefw:
 988         carl9170_release_firmware(ar);
 989         carl9170_usb_firmware_failed(ar);
 990 }
 991
 992 static void carl9170_usb_firmware_step2(const struct firmware *fw,
 993                                         void *context)
 994 {
 995         struct ar9170 *ar = context;
 996
 997         if (fw) {
 998                 ar->fw.fw = fw;
 999                 carl9170_usb_firmware_finish(ar);
1000                 return;
1001         }
1002
1003         dev_err(&ar->udev->dev, "firmware not found.\n");
1004         carl9170_usb_firmware_failed(ar);
1005 }
1006
1007 static int carl9170_usb_probe(struct usb_interface *intf,
1008                               const struct usb_device_id *id)
1009 {
1010         struct ar9170 *ar;
1011         struct usb_device *udev;
1012         int err;
1013
1014         err = usb_reset_device(interface_to_usbdev(intf));
1015         if (err)
1016                 return err;
1017
1018         ar = carl9170_alloc(sizeof(*ar));
1019         if (IS_ERR(ar))
1020                 return PTR_ERR(ar);
1021
1022         udev = interface_to_usbdev(intf);
1023         usb_get_dev(udev);
1024         ar->udev = udev;
1025         ar->intf = intf;
1026         ar->features = id->driver_info;
1027
1028         usb_set_intfdata(intf, ar);
1029         SET_IEEE80211_DEV(ar->hw, &intf->dev);
1030
1031         init_usb_anchor(&ar->rx_anch);
1032         init_usb_anchor(&ar->rx_pool);
1033         init_usb_anchor(&ar->rx_work);
1034         init_usb_anchor(&ar->tx_wait);
1035         init_usb_anchor(&ar->tx_anch);
1036         init_usb_anchor(&ar->tx_cmd);
1037         init_usb_anchor(&ar->tx_err);
1038         init_completion(&ar->cmd_wait);
1039         init_completion(&ar->fw_boot_wait);
1040         init_completion(&ar->fw_load_wait);
1041         tasklet_init(&ar->usb_tasklet, carl9170_usb_tasklet,
1042                      (unsigned long)ar);
1043
1044         atomic_set(&ar->tx_cmd_urbs, 0);
1045         atomic_set(&ar->tx_anch_urbs, 0);
1046         atomic_set(&ar->rx_work_urbs, 0);
1047         atomic_set(&ar->rx_anch_urbs, 0);
1048         atomic_set(&ar->rx_pool_urbs, 0);
1049         ar->cmd_seq = -2;
1050
1051         usb_get_dev(ar->udev);
1052
1053         carl9170_set_state(ar, CARL9170_STOPPED);
1054
1055         return request_firmware_nowait(THIS_MODULE, 1, CARL9170FW_NAME,
1056                 &ar->udev->dev, GFP_KERNEL, ar, carl9170_usb_firmware_step2);
1057 }
1058
1059 static void carl9170_usb_disconnect(struct usb_interface *intf)
1060 {
1061         struct ar9170 *ar = usb_get_intfdata(intf);
1062         struct usb_device *udev;
1063
1064         if (WARN_ON(!ar))
1065                 return;
1066
1067         udev = ar->udev;
1068         wait_for_completion(&ar->fw_load_wait);
1069
1070         if (IS_INITIALIZED(ar)) {
1071                 carl9170_reboot(ar);
1072                 carl9170_usb_stop(ar);
1073         }
1074
1075         carl9170_usb_cancel_urbs(ar);
1076         carl9170_unregister(ar);
1077
1078         usb_set_intfdata(intf, NULL);
1079
1080         carl9170_release_firmware(ar);
1081         carl9170_free(ar);
1082         usb_put_dev(udev);
1083 }
1084
1085 #ifdef CONFIG_PM
1086 static int carl9170_usb_suspend(struct usb_interface *intf,
1087                                 pm_message_t message)
1088 {
1089         struct ar9170 *ar = usb_get_intfdata(intf);
1090
1091         if (!ar)
1092                 return -ENODEV;
1093
1094         carl9170_usb_cancel_urbs(ar);
1095
1096         /*
1097          * firmware automatically reboots for usb suspend.
1098          */
1099
1100         return 0;
1101 }
1102
1103 static int carl9170_usb_resume(struct usb_interface *intf)
1104 {
1105         struct ar9170 *ar = usb_get_intfdata(intf);
1106         int err;
1107
1108         if (!ar)
1109                 return -ENODEV;
1110
1111         usb_unpoison_anchored_urbs(&ar->rx_anch);
1112
1113         err = carl9170_usb_init_device(ar);
1114         if (err)
1115                 goto err_unrx;
1116
1117         err = carl9170_usb_open(ar);
1118         if (err)
1119                 goto err_unrx;
1120
1121         return 0;
1122
1123 err_unrx:
1124         carl9170_usb_cancel_urbs(ar);
1125
1126         return err;
1127 }
1128 #endif /* CONFIG_PM */
1129
1130 static struct usb_driver carl9170_driver = {
1131         .name = KBUILD_MODNAME,
1132         .probe = carl9170_usb_probe,
1133         .disconnect = carl9170_usb_disconnect,
1134         .id_table = carl9170_usb_ids,
1135         .soft_unbind = 1,
1136 #ifdef CONFIG_PM
1137         .suspend = carl9170_usb_suspend,
1138         .resume = carl9170_usb_resume,
1139 #endif /* CONFIG_PM */
1140 };
1141
1142 static int __init carl9170_usb_init(void)
1143 {
1144         return usb_register(&carl9170_driver);
1145 }
1146
1147 static void __exit carl9170_usb_exit(void)
1148 {
1149         usb_deregister(&carl9170_driver);
1150 }
1151
1152 module_init(carl9170_usb_init);
1153 module_exit(carl9170_usb_exit);