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         /* NEC WL300NU-AG */
 116         { USB_DEVICE(0x0409, 0x02b4) },
 117         /* AVM FRITZ!WLAN USB Stick N */
 118         { USB_DEVICE(0x057c, 0x8401) },
 119         /* AVM FRITZ!WLAN USB Stick N 2.4 */
 120         { USB_DEVICE(0x057c, 0x8402) },
 121         /* Qwest/Actiontec 802AIN Wireless N USB Network Adapter */
 122         { USB_DEVICE(0x1668, 0x1200) },
 123         /* Airlive X.USB a/b/g/n */
 124         { USB_DEVICE(0x1b75, 0x9170) },
 125
 126         /* terminate */
 127         {}
 128 };
 129 MODULE_DEVICE_TABLE(usb, carl9170_usb_ids);
 130
 131 static void carl9170_usb_submit_data_urb(struct ar9170 *ar)
 132 {
 133         struct urb *urb;
 134         int err;
 135
 136         if (atomic_inc_return(&ar->tx_anch_urbs) > AR9170_NUM_TX_URBS)
 137                 goto err_acc;
 138
 139         urb = usb_get_from_anchor(&ar->tx_wait);
 140         if (!urb)
 141                 goto err_acc;
 142
 143         usb_anchor_urb(urb, &ar->tx_anch);
 144
 145         err = usb_submit_urb(urb, GFP_ATOMIC);
 146         if (unlikely(err)) {
 147                 if (net_ratelimit()) {
 148                         dev_err(&ar->udev->dev, "tx submit failed (%d)\n",
 149                                 urb->status);
 150                 }
 151
 152                 usb_unanchor_urb(urb);
 153                 usb_anchor_urb(urb, &ar->tx_err);
 154         }
 155
 156         usb_free_urb(urb);
 157
 158         if (likely(err == 0))
 159                 return;
 160
 161 err_acc:
 162         atomic_dec(&ar->tx_anch_urbs);
 163 }
 164
 165 static void carl9170_usb_tx_data_complete(struct urb *urb)
 166 {
 167         struct ar9170 *ar = usb_get_intfdata(usb_ifnum_to_if(urb->dev, 0));
 168
 169         if (WARN_ON_ONCE(!ar)) {
 170                 dev_kfree_skb_irq(urb->context);
 171                 return;
 172         }
 173
 174         atomic_dec(&ar->tx_anch_urbs);
 175
 176         switch (urb->status) {
 177         /* everything is fine */
 178         case 0:
 179                 carl9170_tx_callback(ar, (void *)urb->context);
 180                 break;
 181
 182         /* disconnect */
 183         case -ENOENT:
 184         case -ECONNRESET:
 185         case -ENODEV:
 186         case -ESHUTDOWN:
 187                 /*
 188                  * Defer the frame clean-up to the tasklet worker.
 189                  * This is necessary, because carl9170_tx_drop
 190                  * does not work in an irqsave context.
 191                  */
 192                 usb_anchor_urb(urb, &ar->tx_err);
 193                 return;
 194
 195         /* a random transmission error has occurred? */
 196         default:
 197                 if (net_ratelimit()) {
 198                         dev_err(&ar->udev->dev, "tx failed (%d)\n",
 199                                 urb->status);
 200                 }
 201
 202                 usb_anchor_urb(urb, &ar->tx_err);
 203                 break;
 204         }
 205
 206         if (likely(IS_STARTED(ar)))
 207                 carl9170_usb_submit_data_urb(ar);
 208 }
 209
 210 static int carl9170_usb_submit_cmd_urb(struct ar9170 *ar)
 211 {
 212         struct urb *urb;
 213         int err;
 214
 215         if (atomic_inc_return(&ar->tx_cmd_urbs) != 1) {
 216                 atomic_dec(&ar->tx_cmd_urbs);
 217                 return 0;
 218         }
 219
 220         urb = usb_get_from_anchor(&ar->tx_cmd);
 221         if (!urb) {
 222                 atomic_dec(&ar->tx_cmd_urbs);
 223                 return 0;
 224         }
 225
 226         usb_anchor_urb(urb, &ar->tx_anch);
 227         err = usb_submit_urb(urb, GFP_ATOMIC);
 228         if (unlikely(err)) {
 229                 usb_unanchor_urb(urb);
 230                 atomic_dec(&ar->tx_cmd_urbs);
 231         }
 232         usb_free_urb(urb);
 233
 234         return err;
 235 }
 236
 237 static void carl9170_usb_cmd_complete(struct urb *urb)
 238 {
 239         struct ar9170 *ar = urb->context;
 240         int err = 0;
 241
 242         if (WARN_ON_ONCE(!ar))
 243                 return;
 244
 245         atomic_dec(&ar->tx_cmd_urbs);
 246
 247         switch (urb->status) {
 248         /* everything is fine */
 249         case 0:
 250                 break;
 251
 252         /* disconnect */
 253         case -ENOENT:
 254         case -ECONNRESET:
 255         case -ENODEV:
 256         case -ESHUTDOWN:
 257                 return;
 258
 259         default:
 260                 err = urb->status;
 261                 break;
 262         }
 263
 264         if (!IS_INITIALIZED(ar))
 265                 return;
 266
 267         if (err)
 268                 dev_err(&ar->udev->dev, "submit cmd cb failed (%d).\n", err);
 269
 270         err = carl9170_usb_submit_cmd_urb(ar);
 271         if (err)
 272                 dev_err(&ar->udev->dev, "submit cmd failed (%d).\n", err);
 273 }
 274
 275 static void carl9170_usb_rx_irq_complete(struct urb *urb)
 276 {
 277         struct ar9170 *ar = urb->context;
 278
 279         if (WARN_ON_ONCE(!ar))
 280                 return;
 281
 282         switch (urb->status) {
 283         /* everything is fine */
 284         case 0:
 285                 break;
 286
 287         /* disconnect */
 288         case -ENOENT:
 289         case -ECONNRESET:
 290         case -ENODEV:
 291         case -ESHUTDOWN:
 292                 return;
 293
 294         default:
 295                 goto resubmit;
 296         }
 297
 298         /*
 299          * While the carl9170 firmware does not use this EP, the
 300          * firmware loader in the EEPROM unfortunately does.
 301          * Therefore we need to be ready to handle out-of-band
 302          * responses and traps in case the firmware crashed and
 303          * the loader took over again.
 304          */
 305         carl9170_handle_command_response(ar, urb->transfer_buffer,
 306                                          urb->actual_length);
 307
 308 resubmit:
 309         usb_anchor_urb(urb, &ar->rx_anch);
 310         if (unlikely(usb_submit_urb(urb, GFP_ATOMIC)))
 311                 usb_unanchor_urb(urb);
 312 }
 313
 314 static int carl9170_usb_submit_rx_urb(struct ar9170 *ar, gfp_t gfp)
 315 {
 316         struct urb *urb;
 317         int err = 0, runs = 0;
 318
 319         while ((atomic_read(&ar->rx_anch_urbs) < AR9170_NUM_RX_URBS) &&
 320                 (runs++ < AR9170_NUM_RX_URBS)) {
 321                 err = -ENOSPC;
 322                 urb = usb_get_from_anchor(&ar->rx_pool);
 323                 if (urb) {
 324                         usb_anchor_urb(urb, &ar->rx_anch);
 325                         err = usb_submit_urb(urb, gfp);
 326                         if (unlikely(err)) {
 327                                 usb_unanchor_urb(urb);
 328                                 usb_anchor_urb(urb, &ar->rx_pool);
 329                         } else {
 330                                 atomic_dec(&ar->rx_pool_urbs);
 331                                 atomic_inc(&ar->rx_anch_urbs);
 332                         }
 333                         usb_free_urb(urb);
 334                 }
 335         }
 336
 337         return err;
 338 }
 339
 340 static void carl9170_usb_rx_work(struct ar9170 *ar)
 341 {
 342         struct urb *urb;
 343         int i;
 344
 345         for (i = 0; i < AR9170_NUM_RX_URBS_POOL; i++) {
 346                 urb = usb_get_from_anchor(&ar->rx_work);
 347                 if (!urb)
 348                         break;
 349
 350                 atomic_dec(&ar->rx_work_urbs);
 351                 if (IS_INITIALIZED(ar)) {
 352                         carl9170_rx(ar, urb->transfer_buffer,
 353                                     urb->actual_length);
 354                 }
 355
 356                 usb_anchor_urb(urb, &ar->rx_pool);
 357                 atomic_inc(&ar->rx_pool_urbs);
 358
 359                 usb_free_urb(urb);
 360
 361                 carl9170_usb_submit_rx_urb(ar, GFP_ATOMIC);
 362         }
 363 }
 364
 365 void carl9170_usb_handle_tx_err(struct ar9170 *ar)
 366 {
 367         struct urb *urb;
 368
 369         while ((urb = usb_get_from_anchor(&ar->tx_err))) {
 370                 struct sk_buff *skb = (void *)urb->context;
 371
 372                 carl9170_tx_drop(ar, skb);
 373                 carl9170_tx_callback(ar, skb);
 374                 usb_free_urb(urb);
 375         }
 376 }
 377
 378 static void carl9170_usb_tasklet(unsigned long data)
 379 {
 380         struct ar9170 *ar = (struct ar9170 *) data;
 381
 382         if (!IS_INITIALIZED(ar))
 383                 return;
 384
 385         carl9170_usb_rx_work(ar);
 386
 387         /*
 388          * Strictly speaking: The tx scheduler is not part of the USB system.
 389          * But the rx worker returns frames back to the mac80211-stack and
 390          * this is the _perfect_ place to generate the next transmissions.
 391          */
 392         if (IS_STARTED(ar))
 393                 carl9170_tx_scheduler(ar);
 394 }
 395
 396 static void carl9170_usb_rx_complete(struct urb *urb)
 397 {
 398         struct ar9170 *ar = (struct ar9170 *)urb->context;
 399         int err;
 400
 401         if (WARN_ON_ONCE(!ar))
 402                 return;
 403
 404         atomic_dec(&ar->rx_anch_urbs);
 405
 406         switch (urb->status) {
 407         case 0:
 408                 /* rx path */
 409                 usb_anchor_urb(urb, &ar->rx_work);
 410                 atomic_inc(&ar->rx_work_urbs);
 411                 break;
 412
 413         case -ENOENT:
 414         case -ECONNRESET:
 415         case -ENODEV:
 416         case -ESHUTDOWN:
 417                 /* handle disconnect events*/
 418                 return;
 419
 420         default:
 421                 /* handle all other errors */
 422                 usb_anchor_urb(urb, &ar->rx_pool);
 423                 atomic_inc(&ar->rx_pool_urbs);
 424                 break;
 425         }
 426
 427         err = carl9170_usb_submit_rx_urb(ar, GFP_ATOMIC);
 428         if (unlikely(err)) {
 429                 /*
 430                  * usb_submit_rx_urb reported a problem.
 431                  * In case this is due to a rx buffer shortage,
 432                  * elevate the tasklet worker priority to
 433                  * the highest available level.
 434                  */
 435                 tasklet_hi_schedule(&ar->usb_tasklet);
 436
 437                 if (atomic_read(&ar->rx_anch_urbs) == 0) {
 438                         /*
 439                          * The system is too slow to cope with
 440                          * the enormous workload. We have simply
 441                          * run out of active rx urbs and this
 442                          * unfortunately leads to an unpredictable
 443                          * device.
 444                          */
 445
 446                         ieee80211_queue_work(ar->hw, &ar->ping_work);
 447                 }
 448         } else {
 449                 /*
 450                  * Using anything less than _high_ priority absolutely
 451                  * kills the rx performance my UP-System...
 452                  */
 453                 tasklet_hi_schedule(&ar->usb_tasklet);
 454         }
 455 }
 456
 457 static struct urb *carl9170_usb_alloc_rx_urb(struct ar9170 *ar, gfp_t gfp)
 458 {
 459         struct urb *urb;
 460         void *buf;
 461
 462         buf = kmalloc(ar->fw.rx_size, gfp);
 463         if (!buf)
 464                 return NULL;
 465
 466         urb = usb_alloc_urb(0, gfp);
 467         if (!urb) {
 468                 kfree(buf);
 469                 return NULL;
 470         }
 471
 472         usb_fill_bulk_urb(urb, ar->udev, usb_rcvbulkpipe(ar->udev,
 473                           AR9170_USB_EP_RX), buf, ar->fw.rx_size,
 474                           carl9170_usb_rx_complete, ar);
 475
 476         urb->transfer_flags |= URB_FREE_BUFFER;
 477
 478         return urb;
 479 }
 480
 481 static int carl9170_usb_send_rx_irq_urb(struct ar9170 *ar)
 482 {
 483         struct urb *urb = NULL;
 484         void *ibuf;
 485         int err = -ENOMEM;
 486
 487         urb = usb_alloc_urb(0, GFP_KERNEL);
 488         if (!urb)
 489                 goto out;
 490
 491         ibuf = kmalloc(AR9170_USB_EP_CTRL_MAX, GFP_KERNEL);
 492         if (!ibuf)
 493                 goto out;
 494
 495         usb_fill_int_urb(urb, ar->udev, usb_rcvintpipe(ar->udev,
 496                          AR9170_USB_EP_IRQ), ibuf, AR9170_USB_EP_CTRL_MAX,
 497                          carl9170_usb_rx_irq_complete, ar, 1);
 498
 499         urb->transfer_flags |= URB_FREE_BUFFER;
 500
 501         usb_anchor_urb(urb, &ar->rx_anch);
 502         err = usb_submit_urb(urb, GFP_KERNEL);
 503         if (err)
 504                 usb_unanchor_urb(urb);
 505
 506 out:
 507         usb_free_urb(urb);
 508         return err;
 509 }
 510
 511 static int carl9170_usb_init_rx_bulk_urbs(struct ar9170 *ar)
 512 {
 513         struct urb *urb;
 514         int i, err = -EINVAL;
 515
 516         /*
 517          * The driver actively maintains a second shadow
 518          * pool for inactive, but fully-prepared rx urbs.
 519          *
 520          * The pool should help the driver to master huge
 521          * workload spikes without running the risk of
 522          * undersupplying the hardware or wasting time by
 523          * processing rx data (streams) inside the urb
 524          * completion (hardirq context).
 525          */
 526         for (i = 0; i < AR9170_NUM_RX_URBS_POOL; i++) {
 527                 urb = carl9170_usb_alloc_rx_urb(ar, GFP_KERNEL);
 528                 if (!urb) {
 529                         err = -ENOMEM;
 530                         goto err_out;
 531                 }
 532
 533                 usb_anchor_urb(urb, &ar->rx_pool);
 534                 atomic_inc(&ar->rx_pool_urbs);
 535                 usb_free_urb(urb);
 536         }
 537
 538         err = carl9170_usb_submit_rx_urb(ar, GFP_KERNEL);
 539         if (err)
 540                 goto err_out;
 541
 542         /* the device now waiting for the firmware. */
 543         carl9170_set_state_when(ar, CARL9170_STOPPED, CARL9170_IDLE);
 544         return 0;
 545
 546 err_out:
 547
 548         usb_scuttle_anchored_urbs(&ar->rx_pool);
 549         usb_scuttle_anchored_urbs(&ar->rx_work);
 550         usb_kill_anchored_urbs(&ar->rx_anch);
 551         return err;
 552 }
 553
 554 static int carl9170_usb_flush(struct ar9170 *ar)
 555 {
 556         struct urb *urb;
 557         int ret, err = 0;
 558
 559         while ((urb = usb_get_from_anchor(&ar->tx_wait))) {
 560                 struct sk_buff *skb = (void *)urb->context;
 561                 carl9170_tx_drop(ar, skb);
 562                 carl9170_tx_callback(ar, skb);
 563                 usb_free_urb(urb);
 564         }
 565
 566         ret = usb_wait_anchor_empty_timeout(&ar->tx_cmd, 1000);
 567         if (ret == 0)
 568                 err = -ETIMEDOUT;
 569
 570         /* lets wait a while until the tx - queues are dried out */
 571         ret = usb_wait_anchor_empty_timeout(&ar->tx_anch, 1000);
 572         if (ret == 0)
 573                 err = -ETIMEDOUT;
 574
 575         usb_kill_anchored_urbs(&ar->tx_anch);
 576         carl9170_usb_handle_tx_err(ar);
 577
 578         return err;
 579 }
 580
 581 static void carl9170_usb_cancel_urbs(struct ar9170 *ar)
 582 {
 583         int err;
 584
 585         carl9170_set_state(ar, CARL9170_UNKNOWN_STATE);
 586
 587         err = carl9170_usb_flush(ar);
 588         if (err)
 589                 dev_err(&ar->udev->dev, "stuck tx urbs!\n");
 590
 591         usb_poison_anchored_urbs(&ar->tx_anch);
 592         carl9170_usb_handle_tx_err(ar);
 593         usb_poison_anchored_urbs(&ar->rx_anch);
 594
 595         tasklet_kill(&ar->usb_tasklet);
 596
 597         usb_scuttle_anchored_urbs(&ar->rx_work);
 598         usb_scuttle_anchored_urbs(&ar->rx_pool);
 599         usb_scuttle_anchored_urbs(&ar->tx_cmd);
 600 }
 601
 602 int __carl9170_exec_cmd(struct ar9170 *ar, struct carl9170_cmd *cmd,
 603                         const bool free_buf)
 604 {
 605         struct urb *urb;
 606         int err = 0;
 607
 608         if (!IS_INITIALIZED(ar)) {
 609                 err = -EPERM;
 610                 goto err_free;
 611         }
 612
 613         if (WARN_ON(cmd->hdr.len > CARL9170_MAX_CMD_LEN - 4)) {
 614                 err = -EINVAL;
 615                 goto err_free;
 616         }
 617
 618         urb = usb_alloc_urb(0, GFP_ATOMIC);
 619         if (!urb) {
 620                 err = -ENOMEM;
 621                 goto err_free;
 622         }
 623
 624         usb_fill_int_urb(urb, ar->udev, usb_sndintpipe(ar->udev,
 625                 AR9170_USB_EP_CMD), cmd, cmd->hdr.len + 4,
 626                 carl9170_usb_cmd_complete, ar, 1);
 627
 628         if (free_buf)
 629                 urb->transfer_flags |= URB_FREE_BUFFER;
 630
 631         usb_anchor_urb(urb, &ar->tx_cmd);
 632         usb_free_urb(urb);
 633
 634         return carl9170_usb_submit_cmd_urb(ar);
 635
 636 err_free:
 637         if (free_buf)
 638                 kfree(cmd);
 639
 640         return err;
 641 }
 642
 643 int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids cmd,
 644         unsigned int plen, void *payload, unsigned int outlen, void *out)
 645 {
 646         int err = -ENOMEM;
 647
 648         if (!IS_ACCEPTING_CMD(ar))
 649                 return -EIO;
 650
 651         if (!(cmd & CARL9170_CMD_ASYNC_FLAG))
 652                 might_sleep();
 653
 654         ar->cmd.hdr.len = plen;
 655         ar->cmd.hdr.cmd = cmd;
 656         /* writing multiple regs fills this buffer already */
 657         if (plen && payload != (u8 *)(ar->cmd.data))
 658                 memcpy(ar->cmd.data, payload, plen);
 659
 660         spin_lock_bh(&ar->cmd_lock);
 661         ar->readbuf = (u8 *)out;
 662         ar->readlen = outlen;
 663         spin_unlock_bh(&ar->cmd_lock);
 664
 665         err = __carl9170_exec_cmd(ar, &ar->cmd, false);
 666
 667         if (!(cmd & CARL9170_CMD_ASYNC_FLAG)) {
 668                 err = wait_for_completion_timeout(&ar->cmd_wait, HZ);
 669                 if (err == 0) {
 670                         err = -ETIMEDOUT;
 671                         goto err_unbuf;
 672                 }
 673
 674                 if (ar->readlen != outlen) {
 675                         err = -EMSGSIZE;
 676                         goto err_unbuf;
 677                 }
 678         }
 679
 680         return 0;
 681
 682 err_unbuf:
 683         /* Maybe the device was removed in the moment we were waiting? */
 684         if (IS_STARTED(ar)) {
 685                 dev_err(&ar->udev->dev, "no command feedback "
 686                         "received (%d).\n", err);
 687
 688                 /* provide some maybe useful debug information */
 689                 print_hex_dump_bytes("carl9170 cmd: ", DUMP_PREFIX_NONE,
 690                                      &ar->cmd, plen + 4);
 691
 692                 carl9170_restart(ar, CARL9170_RR_COMMAND_TIMEOUT);
 693         }
 694
 695         /* invalidate to avoid completing the next command prematurely */
 696         spin_lock_bh(&ar->cmd_lock);
 697         ar->readbuf = NULL;
 698         ar->readlen = 0;
 699         spin_unlock_bh(&ar->cmd_lock);
 700
 701         return err;
 702 }
 703
 704 void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb)
 705 {
 706         struct urb *urb;
 707         struct ar9170_stream *tx_stream;
 708         void *data;
 709         unsigned int len;
 710
 711         if (!IS_STARTED(ar))
 712                 goto err_drop;
 713
 714         urb = usb_alloc_urb(0, GFP_ATOMIC);
 715         if (!urb)
 716                 goto err_drop;
 717
 718         if (ar->fw.tx_stream) {
 719                 tx_stream = (void *) (skb->data - sizeof(*tx_stream));
 720
 721                 len = skb->len + sizeof(*tx_stream);
 722                 tx_stream->length = cpu_to_le16(len);
 723                 tx_stream->tag = cpu_to_le16(AR9170_TX_STREAM_TAG);
 724                 data = tx_stream;
 725         } else {
 726                 data = skb->data;
 727                 len = skb->len;
 728         }
 729
 730         usb_fill_bulk_urb(urb, ar->udev, usb_sndbulkpipe(ar->udev,
 731                 AR9170_USB_EP_TX), data, len,
 732                 carl9170_usb_tx_data_complete, skb);
 733
 734         urb->transfer_flags |= URB_ZERO_PACKET;
 735
 736         usb_anchor_urb(urb, &ar->tx_wait);
 737
 738         usb_free_urb(urb);
 739
 740         carl9170_usb_submit_data_urb(ar);
 741         return;
 742
 743 err_drop:
 744         carl9170_tx_drop(ar, skb);
 745         carl9170_tx_callback(ar, skb);
 746 }
 747
 748 static void carl9170_release_firmware(struct ar9170 *ar)
 749 {
 750         if (ar->fw.fw) {
 751                 release_firmware(ar->fw.fw);
 752                 memset(&ar->fw, 0, sizeof(ar->fw));
 753         }
 754 }
 755
 756 void carl9170_usb_stop(struct ar9170 *ar)
 757 {
 758         int ret;
 759
 760         carl9170_set_state_when(ar, CARL9170_IDLE, CARL9170_STOPPED);
 761
 762         ret = carl9170_usb_flush(ar);
 763         if (ret)
 764                 dev_err(&ar->udev->dev, "kill pending tx urbs.\n");
 765
 766         usb_poison_anchored_urbs(&ar->tx_anch);
 767         carl9170_usb_handle_tx_err(ar);
 768
 769         /* kill any pending command */
 770         spin_lock_bh(&ar->cmd_lock);
 771         ar->readlen = 0;
 772         spin_unlock_bh(&ar->cmd_lock);
 773         complete_all(&ar->cmd_wait);
 774
 775         /* This is required to prevent an early completion on _start */
 776         INIT_COMPLETION(ar->cmd_wait);
 777
 778         /*
 779          * Note:
 780          * So far we freed all tx urbs, but we won't dare to touch any rx urbs.
 781          * Else we would end up with a unresponsive device...
 782          */
 783 }
 784
 785 int carl9170_usb_open(struct ar9170 *ar)
 786 {
 787         usb_unpoison_anchored_urbs(&ar->tx_anch);
 788
 789         carl9170_set_state_when(ar, CARL9170_STOPPED, CARL9170_IDLE);
 790         return 0;
 791 }
 792
 793 static int carl9170_usb_load_firmware(struct ar9170 *ar)
 794 {
 795         const u8 *data;
 796         u8 *buf;
 797         unsigned int transfer;
 798         size_t len;
 799         u32 addr;
 800         int err = 0;
 801
 802         buf = kmalloc(4096, GFP_KERNEL);
 803         if (!buf) {
 804                 err = -ENOMEM;
 805                 goto err_out;
 806         }
 807
 808         data = ar->fw.fw->data;
 809         len = ar->fw.fw->size;
 810         addr = ar->fw.address;
 811
 812         /* this removes the miniboot image */
 813         data += ar->fw.offset;
 814         len -= ar->fw.offset;
 815
 816         while (len) {
 817                 transfer = min_t(unsigned int, len, 4096u);
 818                 memcpy(buf, data, transfer);
 819
 820                 err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
 821                                       0x30 /* FW DL */, 0x40 | USB_DIR_OUT,
 822                                       addr >> 8, 0, buf, transfer, 100);
 823
 824                 if (err < 0) {
 825                         kfree(buf);
 826                         goto err_out;
 827                 }
 828
 829                 len -= transfer;
 830                 data += transfer;
 831                 addr += transfer;
 832         }
 833         kfree(buf);
 834
 835         err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
 836                               0x31 /* FW DL COMPLETE */,
 837                               0x40 | USB_DIR_OUT, 0, 0, NULL, 0, 200);
 838
 839         if (wait_for_completion_timeout(&ar->fw_boot_wait, HZ) == 0) {
 840                 err = -ETIMEDOUT;
 841                 goto err_out;
 842         }
 843
 844         err = carl9170_echo_test(ar, 0x4a110123);
 845         if (err)
 846                 goto err_out;
 847
 848         /* now, start the command response counter */
 849         ar->cmd_seq = -1;
 850
 851         return 0;
 852
 853 err_out:
 854         dev_err(&ar->udev->dev, "firmware upload failed (%d).\n", err);
 855         return err;
 856 }
 857
 858 int carl9170_usb_restart(struct ar9170 *ar)
 859 {
 860         int err = 0;
 861
 862         if (ar->intf->condition != USB_INTERFACE_BOUND)
 863                 return 0;
 864
 865         /*
 866          * Disable the command response sequence counter check.
 867          * We already know that the device/firmware is in a bad state.
 868          * So, no extra points are awarded to anyone who reminds the
 869          * driver about that.
 870          */
 871         ar->cmd_seq = -2;
 872
 873         err = carl9170_reboot(ar);
 874
 875         carl9170_usb_stop(ar);
 876
 877         if (err)
 878                 goto err_out;
 879
 880         tasklet_schedule(&ar->usb_tasklet);
 881
 882         /* The reboot procedure can take quite a while to complete. */
 883         msleep(1100);
 884
 885         err = carl9170_usb_open(ar);
 886         if (err)
 887                 goto err_out;
 888
 889         err = carl9170_usb_load_firmware(ar);
 890         if (err)
 891                 goto err_out;
 892
 893         return 0;
 894
 895 err_out:
 896         carl9170_usb_cancel_urbs(ar);
 897         return err;
 898 }
 899
 900 void carl9170_usb_reset(struct ar9170 *ar)
 901 {
 902         /*
 903          * This is the last resort to get the device going again
 904          * without any *user replugging action*.
 905          *
 906          * But there is a catch: usb_reset really is like a physical
 907          * *reconnect*. The mac80211 state will be lost in the process.
 908          * Therefore a userspace application, which is monitoring
 909          * the link must step in.
 910          */
 911         carl9170_usb_cancel_urbs(ar);
 912
 913         carl9170_usb_stop(ar);
 914
 915         usb_queue_reset_device(ar->intf);
 916 }
 917
 918 static int carl9170_usb_init_device(struct ar9170 *ar)
 919 {
 920         int err;
 921
 922         /*
 923          * The carl9170 firmware let's the driver know when it's
 924          * ready for action. But we have to be prepared to gracefully
 925          * handle all spurious [flushed] messages after each (re-)boot.
 926          * Thus the command response counter remains disabled until it
 927          * can be safely synchronized.
 928          */
 929         ar->cmd_seq = -2;
 930
 931         err = carl9170_usb_send_rx_irq_urb(ar);
 932         if (err)
 933                 goto err_out;
 934
 935         err = carl9170_usb_init_rx_bulk_urbs(ar);
 936         if (err)
 937                 goto err_unrx;
 938
 939         err = carl9170_usb_open(ar);
 940         if (err)
 941                 goto err_unrx;
 942
 943         mutex_lock(&ar->mutex);
 944         err = carl9170_usb_load_firmware(ar);
 945         mutex_unlock(&ar->mutex);
 946         if (err)
 947                 goto err_stop;
 948
 949         return 0;
 950
 951 err_stop:
 952         carl9170_usb_stop(ar);
 953
 954 err_unrx:
 955         carl9170_usb_cancel_urbs(ar);
 956
 957 err_out:
 958         return err;
 959 }
 960
 961 static void carl9170_usb_firmware_failed(struct ar9170 *ar)
 962 {
 963         struct device *parent = ar->udev->dev.parent;
 964         struct usb_device *udev;
 965
 966         /*
 967          * Store a copy of the usb_device pointer locally.
 968          * This is because device_release_driver initiates
 969          * carl9170_usb_disconnect, which in turn frees our
 970          * driver context (ar).
 971          */
 972         udev = ar->udev;
 973
 974         complete(&ar->fw_load_wait);
 975
 976         /* unbind anything failed */
 977         if (parent)
 978                 device_lock(parent);
 979
 980         device_release_driver(&udev->dev);
 981         if (parent)
 982                 device_unlock(parent);
 983
 984         usb_put_dev(udev);
 985 }
 986
 987 static void carl9170_usb_firmware_finish(struct ar9170 *ar)
 988 {
 989         int err;
 990
 991         err = carl9170_parse_firmware(ar);
 992         if (err)
 993                 goto err_freefw;
 994
 995         err = carl9170_usb_init_device(ar);
 996         if (err)
 997                 goto err_freefw;
 998
 999         err = carl9170_register(ar);
1000
1001         carl9170_usb_stop(ar);
1002         if (err)
1003                 goto err_unrx;
1004
1005         complete(&ar->fw_load_wait);
1006         usb_put_dev(ar->udev);
1007         return;
1008
1009 err_unrx:
1010         carl9170_usb_cancel_urbs(ar);
1011
1012 err_freefw:
1013         carl9170_release_firmware(ar);
1014         carl9170_usb_firmware_failed(ar);
1015 }
1016
1017 static void carl9170_usb_firmware_step2(const struct firmware *fw,
1018                                         void *context)
1019 {
1020         struct ar9170 *ar = context;
1021
1022         if (fw) {
1023                 ar->fw.fw = fw;
1024                 carl9170_usb_firmware_finish(ar);
1025                 return;
1026         }
1027
1028         dev_err(&ar->udev->dev, "firmware not found.\n");
1029         carl9170_usb_firmware_failed(ar);
1030 }
1031
1032 static int carl9170_usb_probe(struct usb_interface *intf,
1033                               const struct usb_device_id *id)
1034 {
1035         struct ar9170 *ar;
1036         struct usb_device *udev;
1037         int err;
1038
1039         err = usb_reset_device(interface_to_usbdev(intf));
1040         if (err)
1041                 return err;
1042
1043         ar = carl9170_alloc(sizeof(*ar));
1044         if (IS_ERR(ar))
1045                 return PTR_ERR(ar);
1046
1047         udev = interface_to_usbdev(intf);
1048         usb_get_dev(udev);
1049         ar->udev = udev;
1050         ar->intf = intf;
1051         ar->features = id->driver_info;
1052
1053         usb_set_intfdata(intf, ar);
1054         SET_IEEE80211_DEV(ar->hw, &intf->dev);
1055
1056         init_usb_anchor(&ar->rx_anch);
1057         init_usb_anchor(&ar->rx_pool);
1058         init_usb_anchor(&ar->rx_work);
1059         init_usb_anchor(&ar->tx_wait);
1060         init_usb_anchor(&ar->tx_anch);
1061         init_usb_anchor(&ar->tx_cmd);
1062         init_usb_anchor(&ar->tx_err);
1063         init_completion(&ar->cmd_wait);
1064         init_completion(&ar->fw_boot_wait);
1065         init_completion(&ar->fw_load_wait);
1066         tasklet_init(&ar->usb_tasklet, carl9170_usb_tasklet,
1067                      (unsigned long)ar);
1068
1069         atomic_set(&ar->tx_cmd_urbs, 0);
1070         atomic_set(&ar->tx_anch_urbs, 0);
1071         atomic_set(&ar->rx_work_urbs, 0);
1072         atomic_set(&ar->rx_anch_urbs, 0);
1073         atomic_set(&ar->rx_pool_urbs, 0);
1074
1075         usb_get_dev(ar->udev);
1076
1077         carl9170_set_state(ar, CARL9170_STOPPED);
1078
1079         return request_firmware_nowait(THIS_MODULE, 1, CARL9170FW_NAME,
1080                 &ar->udev->dev, GFP_KERNEL, ar, carl9170_usb_firmware_step2);
1081 }
1082
1083 static void carl9170_usb_disconnect(struct usb_interface *intf)
1084 {
1085         struct ar9170 *ar = usb_get_intfdata(intf);
1086         struct usb_device *udev;
1087
1088         if (WARN_ON(!ar))
1089                 return;
1090
1091         udev = ar->udev;
1092         wait_for_completion(&ar->fw_load_wait);
1093
1094         if (IS_INITIALIZED(ar)) {
1095                 carl9170_reboot(ar);
1096                 carl9170_usb_stop(ar);
1097         }
1098
1099         carl9170_usb_cancel_urbs(ar);
1100         carl9170_unregister(ar);
1101
1102         usb_set_intfdata(intf, NULL);
1103
1104         carl9170_release_firmware(ar);
1105         carl9170_free(ar);
1106         usb_put_dev(udev);
1107 }
1108
1109 #ifdef CONFIG_PM
1110 static int carl9170_usb_suspend(struct usb_interface *intf,
1111                                 pm_message_t message)
1112 {
1113         struct ar9170 *ar = usb_get_intfdata(intf);
1114
1115         if (!ar)
1116                 return -ENODEV;
1117
1118         carl9170_usb_cancel_urbs(ar);
1119
1120         return 0;
1121 }
1122
1123 static int carl9170_usb_resume(struct usb_interface *intf)
1124 {
1125         struct ar9170 *ar = usb_get_intfdata(intf);
1126         int err;
1127
1128         if (!ar)
1129                 return -ENODEV;
1130
1131         usb_unpoison_anchored_urbs(&ar->rx_anch);
1132         carl9170_set_state(ar, CARL9170_STOPPED);
1133
1134         /*
1135          * The USB documentation demands that [for suspend] all traffic
1136          * to and from the device has to stop. This would be fine, but
1137          * there's a catch: the device[usb phy] does not come back.
1138          *
1139          * Upon resume the firmware will "kill" itself and the
1140          * boot-code sorts out the magic voodoo.
1141          * Not very nice, but there's not much what could go wrong.
1142          */
1143         msleep(1100);
1144
1145         err = carl9170_usb_init_device(ar);
1146         if (err)
1147                 goto err_unrx;
1148
1149         return 0;
1150
1151 err_unrx:
1152         carl9170_usb_cancel_urbs(ar);
1153
1154         return err;
1155 }
1156 #endif /* CONFIG_PM */
1157
1158 static struct usb_driver carl9170_driver = {
1159         .name = KBUILD_MODNAME,
1160         .probe = carl9170_usb_probe,
1161         .disconnect = carl9170_usb_disconnect,
1162         .id_table = carl9170_usb_ids,
1163         .soft_unbind = 1,
1164 #ifdef CONFIG_PM
1165         .suspend = carl9170_usb_suspend,
1166         .resume = carl9170_usb_resume,
1167         .reset_resume = carl9170_usb_resume,
1168 #endif /* CONFIG_PM */
1169         .disable_hub_initiated_lpm = 1,
1170 };
1171
1172 module_usb_driver(carl9170_driver);