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