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

   1 /*
   2  * Atheros AR9170 driver
   3  *
   4  * USB - frontend
   5  *
   6  * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
   7  * Copyright 2009, Christian Lamparter <chunkeey@web.de>
   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 <net/mac80211.h>
  46 #include "ar9170.h"
  47 #include "cmd.h"
  48 #include "hw.h"
  49 #include "usb.h"
  50
  51 MODULE_AUTHOR("Johannes Berg <johannes@sipsolutions.net>");
  52 MODULE_AUTHOR("Christian Lamparter <chunkeey@web.de>");
  53 MODULE_LICENSE("GPL");
  54 MODULE_DESCRIPTION("Atheros AR9170 802.11n USB wireless");
  55 MODULE_FIRMWARE("ar9170.fw");
  56 MODULE_FIRMWARE("ar9170-1.fw");
  57 MODULE_FIRMWARE("ar9170-2.fw");
  58
  59 enum ar9170_requirements {
  60         AR9170_REQ_FW1_ONLY = 1,
  61 };
  62
  63 static struct usb_device_id ar9170_usb_ids[] = {
  64         /* Atheros 9170 */
  65         { USB_DEVICE(0x0cf3, 0x9170) },
  66         /* Atheros TG121N */
  67         { USB_DEVICE(0x0cf3, 0x1001) },
  68         /* TP-Link TL-WN821N v2 */
  69         { USB_DEVICE(0x0cf3, 0x1002) },
  70         /* 3Com Dual Band 802.11n USB Adapter */
  71         { USB_DEVICE(0x0cf3, 0x1010) },
  72         /* H3C Dual Band 802.11n USB Adapter */
  73         { USB_DEVICE(0x0cf3, 0x1011) },
  74         /* Cace Airpcap NX */
  75         { USB_DEVICE(0xcace, 0x0300) },
  76         /* D-Link DWA 160 A1 */
  77         { USB_DEVICE(0x07d1, 0x3c10) },
  78         /* D-Link DWA 160 A2 */
  79         { USB_DEVICE(0x07d1, 0x3a09) },
  80         /* Netgear WNA1000 */
  81         { USB_DEVICE(0x0846, 0x9040) },
  82         /* Netgear WNDA3100 */
  83         { USB_DEVICE(0x0846, 0x9010) },
  84         /* Netgear WN111 v2 */
  85         { USB_DEVICE(0x0846, 0x9001) },
  86         /* Zydas ZD1221 */
  87         { USB_DEVICE(0x0ace, 0x1221) },
  88         /* Proxim ORiNOCO 802.11n USB */
  89         { USB_DEVICE(0x1435, 0x0804) },
  90         /* WNC Generic 11n USB Dongle */
  91         { USB_DEVICE(0x1435, 0x0326) },
  92         /* ZyXEL NWD271N */
  93         { USB_DEVICE(0x0586, 0x3417) },
  94         /* Z-Com UB81 BG */
  95         { USB_DEVICE(0x0cde, 0x0023) },
  96         /* Z-Com UB82 ABG */
  97         { USB_DEVICE(0x0cde, 0x0026) },
  98         /* Sphairon Homelink 1202 */
  99         { USB_DEVICE(0x0cde, 0x0027) },
 100         /* Arcadyan WN7512 */
 101         { USB_DEVICE(0x083a, 0xf522) },
 102         /* Planex GWUS300 */
 103         { USB_DEVICE(0x2019, 0x5304) },
 104         /* IO-Data WNGDNUS2 */
 105         { USB_DEVICE(0x04bb, 0x093f) },
 106         /* AVM FRITZ!WLAN USB Stick N */
 107         { USB_DEVICE(0x057C, 0x8401) },
 108         /* NEC WL300NU-G */
 109         { USB_DEVICE(0x0409, 0x0249) },
 110         /* AVM FRITZ!WLAN USB Stick N 2.4 */
 111         { USB_DEVICE(0x057C, 0x8402), .driver_info = AR9170_REQ_FW1_ONLY },
 112
 113         /* terminate */
 114         {}
 115 };
 116 MODULE_DEVICE_TABLE(usb, ar9170_usb_ids);
 117
 118 static void ar9170_usb_submit_urb(struct ar9170_usb *aru)
 119 {
 120         struct urb *urb;
 121         unsigned long flags;
 122         int err;
 123
 124         if (unlikely(!IS_STARTED(&aru->common)))
 125                 return ;
 126
 127         spin_lock_irqsave(&aru->tx_urb_lock, flags);
 128         if (atomic_read(&aru->tx_submitted_urbs) >= AR9170_NUM_TX_URBS) {
 129                 spin_unlock_irqrestore(&aru->tx_urb_lock, flags);
 130                 return ;
 131         }
 132         atomic_inc(&aru->tx_submitted_urbs);
 133
 134         urb = usb_get_from_anchor(&aru->tx_pending);
 135         if (!urb) {
 136                 atomic_dec(&aru->tx_submitted_urbs);
 137                 spin_unlock_irqrestore(&aru->tx_urb_lock, flags);
 138
 139                 return ;
 140         }
 141         spin_unlock_irqrestore(&aru->tx_urb_lock, flags);
 142
 143         aru->tx_pending_urbs--;
 144         usb_anchor_urb(urb, &aru->tx_submitted);
 145
 146         err = usb_submit_urb(urb, GFP_ATOMIC);
 147         if (unlikely(err)) {
 148                 if (ar9170_nag_limiter(&aru->common))
 149                         dev_err(&aru->udev->dev, "submit_urb failed (%d).\n",
 150                                 err);
 151
 152                 usb_unanchor_urb(urb);
 153                 atomic_dec(&aru->tx_submitted_urbs);
 154                 ar9170_tx_callback(&aru->common, urb->context);
 155         }
 156
 157         usb_free_urb(urb);
 158 }
 159
 160 static void ar9170_usb_tx_urb_complete_frame(struct urb *urb)
 161 {
 162         struct sk_buff *skb = urb->context;
 163         struct ar9170_usb *aru = (struct ar9170_usb *)
 164               usb_get_intfdata(usb_ifnum_to_if(urb->dev, 0));
 165
 166         if (unlikely(!aru)) {
 167                 dev_kfree_skb_irq(skb);
 168                 return ;
 169         }
 170
 171         atomic_dec(&aru->tx_submitted_urbs);
 172
 173         ar9170_tx_callback(&aru->common, skb);
 174
 175         ar9170_usb_submit_urb(aru);
 176 }
 177
 178 static void ar9170_usb_tx_urb_complete(struct urb *urb)
 179 {
 180 }
 181
 182 static void ar9170_usb_irq_completed(struct urb *urb)
 183 {
 184         struct ar9170_usb *aru = urb->context;
 185
 186         switch (urb->status) {
 187         /* everything is fine */
 188         case 0:
 189                 break;
 190
 191         /* disconnect */
 192         case -ENOENT:
 193         case -ECONNRESET:
 194         case -ENODEV:
 195         case -ESHUTDOWN:
 196                 goto free;
 197
 198         default:
 199                 goto resubmit;
 200         }
 201
 202         ar9170_handle_command_response(&aru->common, urb->transfer_buffer,
 203                                        urb->actual_length);
 204
 205 resubmit:
 206         usb_anchor_urb(urb, &aru->rx_submitted);
 207         if (usb_submit_urb(urb, GFP_ATOMIC)) {
 208                 usb_unanchor_urb(urb);
 209                 goto free;
 210         }
 211
 212         return;
 213
 214 free:
 215         usb_buffer_free(aru->udev, 64, urb->transfer_buffer, urb->transfer_dma);
 216 }
 217
 218 static void ar9170_usb_rx_completed(struct urb *urb)
 219 {
 220         struct sk_buff *skb = urb->context;
 221         struct ar9170_usb *aru = (struct ar9170_usb *)
 222                 usb_get_intfdata(usb_ifnum_to_if(urb->dev, 0));
 223         int err;
 224
 225         if (!aru)
 226                 goto free;
 227
 228         switch (urb->status) {
 229         /* everything is fine */
 230         case 0:
 231                 break;
 232
 233         /* disconnect */
 234         case -ENOENT:
 235         case -ECONNRESET:
 236         case -ENODEV:
 237         case -ESHUTDOWN:
 238                 goto free;
 239
 240         default:
 241                 goto resubmit;
 242         }
 243
 244         skb_put(skb, urb->actual_length);
 245         ar9170_rx(&aru->common, skb);
 246
 247 resubmit:
 248         skb_reset_tail_pointer(skb);
 249         skb_trim(skb, 0);
 250
 251         usb_anchor_urb(urb, &aru->rx_submitted);
 252         err = usb_submit_urb(urb, GFP_ATOMIC);
 253         if (unlikely(err)) {
 254                 usb_unanchor_urb(urb);
 255                 goto free;
 256         }
 257
 258         return ;
 259
 260 free:
 261         dev_kfree_skb_irq(skb);
 262 }
 263
 264 static int ar9170_usb_prep_rx_urb(struct ar9170_usb *aru,
 265                                   struct urb *urb, gfp_t gfp)
 266 {
 267         struct sk_buff *skb;
 268
 269         skb = __dev_alloc_skb(AR9170_MAX_RX_BUFFER_SIZE + 32, gfp);
 270         if (!skb)
 271                 return -ENOMEM;
 272
 273         /* reserve some space for mac80211's radiotap */
 274         skb_reserve(skb, 32);
 275
 276         usb_fill_bulk_urb(urb, aru->udev,
 277                           usb_rcvbulkpipe(aru->udev, AR9170_EP_RX),
 278                           skb->data, min(skb_tailroom(skb),
 279                           AR9170_MAX_RX_BUFFER_SIZE),
 280                           ar9170_usb_rx_completed, skb);
 281
 282         return 0;
 283 }
 284
 285 static int ar9170_usb_alloc_rx_irq_urb(struct ar9170_usb *aru)
 286 {
 287         struct urb *urb = NULL;
 288         void *ibuf;
 289         int err = -ENOMEM;
 290
 291         /* initialize interrupt endpoint */
 292         urb = usb_alloc_urb(0, GFP_KERNEL);
 293         if (!urb)
 294                 goto out;
 295
 296         ibuf = usb_buffer_alloc(aru->udev, 64, GFP_KERNEL, &urb->transfer_dma);
 297         if (!ibuf)
 298                 goto out;
 299
 300         usb_fill_int_urb(urb, aru->udev,
 301                          usb_rcvintpipe(aru->udev, AR9170_EP_IRQ), ibuf,
 302                          64, ar9170_usb_irq_completed, aru, 1);
 303         urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 304
 305         usb_anchor_urb(urb, &aru->rx_submitted);
 306         err = usb_submit_urb(urb, GFP_KERNEL);
 307         if (err) {
 308                 usb_unanchor_urb(urb);
 309                 usb_buffer_free(aru->udev, 64, urb->transfer_buffer,
 310                                 urb->transfer_dma);
 311         }
 312
 313 out:
 314         usb_free_urb(urb);
 315         return err;
 316 }
 317
 318 static int ar9170_usb_alloc_rx_bulk_urbs(struct ar9170_usb *aru)
 319 {
 320         struct urb *urb;
 321         int i;
 322         int err = -EINVAL;
 323
 324         for (i = 0; i < AR9170_NUM_RX_URBS; i++) {
 325                 err = -ENOMEM;
 326                 urb = usb_alloc_urb(0, GFP_KERNEL);
 327                 if (!urb)
 328                         goto err_out;
 329
 330                 err = ar9170_usb_prep_rx_urb(aru, urb, GFP_KERNEL);
 331                 if (err) {
 332                         usb_free_urb(urb);
 333                         goto err_out;
 334                 }
 335
 336                 usb_anchor_urb(urb, &aru->rx_submitted);
 337                 err = usb_submit_urb(urb, GFP_KERNEL);
 338                 if (err) {
 339                         usb_unanchor_urb(urb);
 340                         dev_kfree_skb_any((void *) urb->transfer_buffer);
 341                         usb_free_urb(urb);
 342                         goto err_out;
 343                 }
 344                 usb_free_urb(urb);
 345         }
 346
 347         /* the device now waiting for a firmware. */
 348         aru->common.state = AR9170_IDLE;
 349         return 0;
 350
 351 err_out:
 352
 353         usb_kill_anchored_urbs(&aru->rx_submitted);
 354         return err;
 355 }
 356
 357 static int ar9170_usb_flush(struct ar9170 *ar)
 358 {
 359         struct ar9170_usb *aru = (void *) ar;
 360         struct urb *urb;
 361         int ret, err = 0;
 362
 363         if (IS_STARTED(ar))
 364                 aru->common.state = AR9170_IDLE;
 365
 366         usb_wait_anchor_empty_timeout(&aru->tx_pending,
 367                                             msecs_to_jiffies(800));
 368         while ((urb = usb_get_from_anchor(&aru->tx_pending))) {
 369                 ar9170_tx_callback(&aru->common, (void *) urb->context);
 370                 usb_free_urb(urb);
 371         }
 372
 373         /* lets wait a while until the tx - queues are dried out */
 374         ret = usb_wait_anchor_empty_timeout(&aru->tx_submitted,
 375                                             msecs_to_jiffies(100));
 376         if (ret == 0)
 377                 err = -ETIMEDOUT;
 378
 379         usb_kill_anchored_urbs(&aru->tx_submitted);
 380
 381         if (IS_ACCEPTING_CMD(ar))
 382                 aru->common.state = AR9170_STARTED;
 383
 384         return err;
 385 }
 386
 387 static void ar9170_usb_cancel_urbs(struct ar9170_usb *aru)
 388 {
 389         int err;
 390
 391         aru->common.state = AR9170_UNKNOWN_STATE;
 392
 393         err = ar9170_usb_flush(&aru->common);
 394         if (err)
 395                 dev_err(&aru->udev->dev, "stuck tx urbs!\n");
 396
 397         usb_poison_anchored_urbs(&aru->tx_submitted);
 398         usb_poison_anchored_urbs(&aru->rx_submitted);
 399 }
 400
 401 static int ar9170_usb_exec_cmd(struct ar9170 *ar, enum ar9170_cmd cmd,
 402                                unsigned int plen, void *payload,
 403                                unsigned int outlen, void *out)
 404 {
 405         struct ar9170_usb *aru = (void *) ar;
 406         struct urb *urb = NULL;
 407         unsigned long flags;
 408         int err = -ENOMEM;
 409
 410         if (unlikely(!IS_ACCEPTING_CMD(ar)))
 411                 return -EPERM;
 412
 413         if (WARN_ON(plen > AR9170_MAX_CMD_LEN - 4))
 414                 return -EINVAL;
 415
 416         urb = usb_alloc_urb(0, GFP_ATOMIC);
 417         if (unlikely(!urb))
 418                 goto err_free;
 419
 420         ar->cmdbuf[0] = cpu_to_le32(plen);
 421         ar->cmdbuf[0] |= cpu_to_le32(cmd << 8);
 422         /* writing multiple regs fills this buffer already */
 423         if (plen && payload != (u8 *)(&ar->cmdbuf[1]))
 424                 memcpy(&ar->cmdbuf[1], payload, plen);
 425
 426         spin_lock_irqsave(&aru->common.cmdlock, flags);
 427         aru->readbuf = (u8 *)out;
 428         aru->readlen = outlen;
 429         spin_unlock_irqrestore(&aru->common.cmdlock, flags);
 430
 431         usb_fill_int_urb(urb, aru->udev,
 432                          usb_sndintpipe(aru->udev, AR9170_EP_CMD),
 433                          aru->common.cmdbuf, plen + 4,
 434                          ar9170_usb_tx_urb_complete, NULL, 1);
 435
 436         usb_anchor_urb(urb, &aru->tx_submitted);
 437         err = usb_submit_urb(urb, GFP_ATOMIC);
 438         if (unlikely(err)) {
 439                 usb_unanchor_urb(urb);
 440                 usb_free_urb(urb);
 441                 goto err_unbuf;
 442         }
 443         usb_free_urb(urb);
 444
 445         err = wait_for_completion_timeout(&aru->cmd_wait, HZ);
 446         if (err == 0) {
 447                 err = -ETIMEDOUT;
 448                 goto err_unbuf;
 449         }
 450
 451         if (aru->readlen != outlen) {
 452                 err = -EMSGSIZE;
 453                 goto err_unbuf;
 454         }
 455
 456         return 0;
 457
 458 err_unbuf:
 459         /* Maybe the device was removed in the second we were waiting? */
 460         if (IS_STARTED(ar)) {
 461                 dev_err(&aru->udev->dev, "no command feedback "
 462                                          "received (%d).\n", err);
 463
 464                 /* provide some maybe useful debug information */
 465                 print_hex_dump_bytes("ar9170 cmd: ", DUMP_PREFIX_NONE,
 466                                      aru->common.cmdbuf, plen + 4);
 467                 dump_stack();
 468         }
 469
 470         /* invalidate to avoid completing the next prematurely */
 471         spin_lock_irqsave(&aru->common.cmdlock, flags);
 472         aru->readbuf = NULL;
 473         aru->readlen = 0;
 474         spin_unlock_irqrestore(&aru->common.cmdlock, flags);
 475
 476 err_free:
 477
 478         return err;
 479 }
 480
 481 static int ar9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb)
 482 {
 483         struct ar9170_usb *aru = (struct ar9170_usb *) ar;
 484         struct urb *urb;
 485
 486         if (unlikely(!IS_STARTED(ar))) {
 487                 /* Seriously, what were you drink... err... thinking!? */
 488                 return -EPERM;
 489         }
 490
 491         urb = usb_alloc_urb(0, GFP_ATOMIC);
 492         if (unlikely(!urb))
 493                 return -ENOMEM;
 494
 495         usb_fill_bulk_urb(urb, aru->udev,
 496                           usb_sndbulkpipe(aru->udev, AR9170_EP_TX),
 497                           skb->data, skb->len,
 498                           ar9170_usb_tx_urb_complete_frame, skb);
 499         urb->transfer_flags |= URB_ZERO_PACKET;
 500
 501         usb_anchor_urb(urb, &aru->tx_pending);
 502         aru->tx_pending_urbs++;
 503
 504         usb_free_urb(urb);
 505
 506         ar9170_usb_submit_urb(aru);
 507         return 0;
 508 }
 509
 510 static void ar9170_usb_callback_cmd(struct ar9170 *ar, u32 len , void *buffer)
 511 {
 512         struct ar9170_usb *aru = (void *) ar;
 513         unsigned long flags;
 514         u32 in, out;
 515
 516         if (unlikely(!buffer))
 517                 return ;
 518
 519         in = le32_to_cpup((__le32 *)buffer);
 520         out = le32_to_cpu(ar->cmdbuf[0]);
 521
 522         /* mask off length byte */
 523         out &= ~0xFF;
 524
 525         if (aru->readlen >= 0) {
 526                 /* add expected length */
 527                 out |= aru->readlen;
 528         } else {
 529                 /* add obtained length */
 530                 out |= in & 0xFF;
 531         }
 532
 533         /*
 534          * Some commands (e.g: AR9170_CMD_FREQUENCY) have a variable response
 535          * length and we cannot predict the correct length in advance.
 536          * So we only check if we provided enough space for the data.
 537          */
 538         if (unlikely(out < in)) {
 539                 dev_warn(&aru->udev->dev, "received invalid command response "
 540                                           "got %d bytes, instead of %d bytes "
 541                                           "and the resp length is %d bytes\n",
 542                          in, out, len);
 543                 print_hex_dump_bytes("ar9170 invalid resp: ",
 544                                      DUMP_PREFIX_OFFSET, buffer, len);
 545                 /*
 546                  * Do not complete, then the command times out,
 547                  * and we get a stack trace from there.
 548                  */
 549                 return ;
 550         }
 551
 552         spin_lock_irqsave(&aru->common.cmdlock, flags);
 553         if (aru->readbuf && len > 0) {
 554                 memcpy(aru->readbuf, buffer + 4, len - 4);
 555                 aru->readbuf = NULL;
 556         }
 557         complete(&aru->cmd_wait);
 558         spin_unlock_irqrestore(&aru->common.cmdlock, flags);
 559 }
 560
 561 static int ar9170_usb_upload(struct ar9170_usb *aru, const void *data,
 562                              size_t len, u32 addr, bool complete)
 563 {
 564         int transfer, err;
 565         u8 *buf = kmalloc(4096, GFP_KERNEL);
 566
 567         if (!buf)
 568                 return -ENOMEM;
 569
 570         while (len) {
 571                 transfer = min_t(int, len, 4096);
 572                 memcpy(buf, data, transfer);
 573
 574                 err = usb_control_msg(aru->udev, usb_sndctrlpipe(aru->udev, 0),
 575                                       0x30 /* FW DL */, 0x40 | USB_DIR_OUT,
 576                                       addr >> 8, 0, buf, transfer, 1000);
 577
 578                 if (err < 0) {
 579                         kfree(buf);
 580                         return err;
 581                 }
 582
 583                 len -= transfer;
 584                 data += transfer;
 585                 addr += transfer;
 586         }
 587         kfree(buf);
 588
 589         if (complete) {
 590                 err = usb_control_msg(aru->udev, usb_sndctrlpipe(aru->udev, 0),
 591                                       0x31 /* FW DL COMPLETE */,
 592                                       0x40 | USB_DIR_OUT, 0, 0, NULL, 0, 5000);
 593         }
 594
 595         return 0;
 596 }
 597
 598 static int ar9170_usb_reset(struct ar9170_usb *aru)
 599 {
 600         int ret, lock = (aru->intf->condition != USB_INTERFACE_BINDING);
 601
 602         if (lock) {
 603                 ret = usb_lock_device_for_reset(aru->udev, aru->intf);
 604                 if (ret < 0) {
 605                         dev_err(&aru->udev->dev, "unable to lock device "
 606                                 "for reset (%d).\n", ret);
 607                         return ret;
 608                 }
 609         }
 610
 611         ret = usb_reset_device(aru->udev);
 612         if (lock)
 613                 usb_unlock_device(aru->udev);
 614
 615         /* let it rest - for a second - */
 616         msleep(1000);
 617
 618         return ret;
 619 }
 620
 621 static int ar9170_usb_upload_firmware(struct ar9170_usb *aru)
 622 {
 623         int err;
 624
 625         if (!aru->init_values)
 626                 goto upload_fw_start;
 627
 628         /* First, upload initial values to device RAM */
 629         err = ar9170_usb_upload(aru, aru->init_values->data,
 630                                 aru->init_values->size, 0x102800, false);
 631         if (err) {
 632                 dev_err(&aru->udev->dev, "firmware part 1 "
 633                         "upload failed (%d).\n", err);
 634                 return err;
 635         }
 636
 637 upload_fw_start:
 638
 639         /* Then, upload the firmware itself and start it */
 640         return ar9170_usb_upload(aru, aru->firmware->data, aru->firmware->size,
 641                                 0x200000, true);
 642 }
 643
 644 static int ar9170_usb_init_transport(struct ar9170_usb *aru)
 645 {
 646         struct ar9170 *ar = (void *) &aru->common;
 647         int err;
 648
 649         ar9170_regwrite_begin(ar);
 650
 651         /* Set USB Rx stream mode MAX packet number to 2 */
 652         ar9170_regwrite(AR9170_USB_REG_MAX_AGG_UPLOAD, 0x4);
 653
 654         /* Set USB Rx stream mode timeout to 10us */
 655         ar9170_regwrite(AR9170_USB_REG_UPLOAD_TIME_CTL, 0x80);
 656
 657         ar9170_regwrite_finish();
 658
 659         err = ar9170_regwrite_result();
 660         if (err)
 661                 dev_err(&aru->udev->dev, "USB setup failed (%d).\n", err);
 662
 663         return err;
 664 }
 665
 666 static void ar9170_usb_stop(struct ar9170 *ar)
 667 {
 668         struct ar9170_usb *aru = (void *) ar;
 669         int ret;
 670
 671         if (IS_ACCEPTING_CMD(ar))
 672                 aru->common.state = AR9170_STOPPED;
 673
 674         ret = ar9170_usb_flush(ar);
 675         if (ret)
 676                 dev_err(&aru->udev->dev, "kill pending tx urbs.\n");
 677
 678         usb_poison_anchored_urbs(&aru->tx_submitted);
 679
 680         /*
 681          * Note:
 682          * So far we freed all tx urbs, but we won't dare to touch any rx urbs.
 683          * Else we would end up with a unresponsive device...
 684          */
 685 }
 686
 687 static int ar9170_usb_open(struct ar9170 *ar)
 688 {
 689         struct ar9170_usb *aru = (void *) ar;
 690         int err;
 691
 692         usb_unpoison_anchored_urbs(&aru->tx_submitted);
 693         err = ar9170_usb_init_transport(aru);
 694         if (err) {
 695                 usb_poison_anchored_urbs(&aru->tx_submitted);
 696                 return err;
 697         }
 698
 699         aru->common.state = AR9170_IDLE;
 700         return 0;
 701 }
 702
 703 static int ar9170_usb_init_device(struct ar9170_usb *aru)
 704 {
 705         int err;
 706
 707         err = ar9170_usb_alloc_rx_irq_urb(aru);
 708         if (err)
 709                 goto err_out;
 710
 711         err = ar9170_usb_alloc_rx_bulk_urbs(aru);
 712         if (err)
 713                 goto err_unrx;
 714
 715         err = ar9170_usb_upload_firmware(aru);
 716         if (err) {
 717                 err = ar9170_echo_test(&aru->common, 0x60d43110);
 718                 if (err) {
 719                         /* force user invention, by disabling the device */
 720                         err = usb_driver_set_configuration(aru->udev, -1);
 721                         dev_err(&aru->udev->dev, "device is in a bad state. "
 722                                                  "please reconnect it!\n");
 723                         goto err_unrx;
 724                 }
 725         }
 726
 727         return 0;
 728
 729 err_unrx:
 730         ar9170_usb_cancel_urbs(aru);
 731
 732 err_out:
 733         return err;
 734 }
 735
 736 static void ar9170_usb_firmware_failed(struct ar9170_usb *aru)
 737 {
 738         struct device *parent = aru->udev->dev.parent;
 739
 740         complete(&aru->firmware_loading_complete);
 741
 742         /* unbind anything failed */
 743         if (parent)
 744                 down(&parent->sem);
 745         device_release_driver(&aru->udev->dev);
 746         if (parent)
 747                 up(&parent->sem);
 748
 749         usb_put_dev(aru->udev);
 750 }
 751
 752 static void ar9170_usb_firmware_finish(const struct firmware *fw, void *context)
 753 {
 754         struct ar9170_usb *aru = context;
 755         int err;
 756
 757         aru->firmware = fw;
 758
 759         if (!fw) {
 760                 dev_err(&aru->udev->dev, "firmware file not found.\n");
 761                 goto err_freefw;
 762         }
 763
 764         err = ar9170_usb_init_device(aru);
 765         if (err)
 766                 goto err_freefw;
 767
 768         err = ar9170_usb_open(&aru->common);
 769         if (err)
 770                 goto err_unrx;
 771
 772         err = ar9170_register(&aru->common, &aru->udev->dev);
 773
 774         ar9170_usb_stop(&aru->common);
 775         if (err)
 776                 goto err_unrx;
 777
 778         complete(&aru->firmware_loading_complete);
 779         usb_put_dev(aru->udev);
 780         return;
 781
 782  err_unrx:
 783         ar9170_usb_cancel_urbs(aru);
 784
 785  err_freefw:
 786         ar9170_usb_firmware_failed(aru);
 787 }
 788
 789 static void ar9170_usb_firmware_inits(const struct firmware *fw,
 790                                       void *context)
 791 {
 792         struct ar9170_usb *aru = context;
 793         int err;
 794
 795         if (!fw) {
 796                 dev_err(&aru->udev->dev, "file with init values not found.\n");
 797                 ar9170_usb_firmware_failed(aru);
 798                 return;
 799         }
 800
 801         aru->init_values = fw;
 802
 803         /* ok so we have the init values -- get code for two-stage */
 804
 805         err = request_firmware_nowait(THIS_MODULE, 1, "ar9170-2.fw",
 806                                       &aru->udev->dev, GFP_KERNEL, aru,
 807                                       ar9170_usb_firmware_finish);
 808         if (err)
 809                 ar9170_usb_firmware_failed(aru);
 810 }
 811
 812 static void ar9170_usb_firmware_step2(const struct firmware *fw, void *context)
 813 {
 814         struct ar9170_usb *aru = context;
 815         int err;
 816
 817         if (fw) {
 818                 ar9170_usb_firmware_finish(fw, context);
 819                 return;
 820         }
 821
 822         if (aru->req_one_stage_fw) {
 823                 dev_err(&aru->udev->dev, "ar9170.fw firmware file "
 824                         "not found and is required for this device\n");
 825                 ar9170_usb_firmware_failed(aru);
 826                 return;
 827         }
 828
 829         dev_err(&aru->udev->dev, "ar9170.fw firmware file "
 830                 "not found, trying old firmware...\n");
 831
 832         err = request_firmware_nowait(THIS_MODULE, 1, "ar9170-1.fw",
 833                                       &aru->udev->dev, GFP_KERNEL, aru,
 834                                       ar9170_usb_firmware_inits);
 835         if (err)
 836                 ar9170_usb_firmware_failed(aru);
 837 }
 838
 839 static bool ar9170_requires_one_stage(const struct usb_device_id *id)
 840 {
 841         if (!id->driver_info)
 842                 return false;
 843         if (id->driver_info == AR9170_REQ_FW1_ONLY)
 844                 return true;
 845         return false;
 846 }
 847
 848 static int ar9170_usb_probe(struct usb_interface *intf,
 849                         const struct usb_device_id *id)
 850 {
 851         struct ar9170_usb *aru;
 852         struct ar9170 *ar;
 853         struct usb_device *udev;
 854         int err;
 855
 856         aru = ar9170_alloc(sizeof(*aru));
 857         if (IS_ERR(aru)) {
 858                 err = PTR_ERR(aru);
 859                 goto out;
 860         }
 861
 862         udev = interface_to_usbdev(intf);
 863         usb_get_dev(udev);
 864         aru->udev = udev;
 865         aru->intf = intf;
 866         ar = &aru->common;
 867
 868         aru->req_one_stage_fw = ar9170_requires_one_stage(id);
 869
 870         usb_set_intfdata(intf, aru);
 871         SET_IEEE80211_DEV(ar->hw, &intf->dev);
 872
 873         init_usb_anchor(&aru->rx_submitted);
 874         init_usb_anchor(&aru->tx_pending);
 875         init_usb_anchor(&aru->tx_submitted);
 876         init_completion(&aru->cmd_wait);
 877         init_completion(&aru->firmware_loading_complete);
 878         spin_lock_init(&aru->tx_urb_lock);
 879
 880         aru->tx_pending_urbs = 0;
 881         atomic_set(&aru->tx_submitted_urbs, 0);
 882
 883         aru->common.stop = ar9170_usb_stop;
 884         aru->common.flush = ar9170_usb_flush;
 885         aru->common.open = ar9170_usb_open;
 886         aru->common.tx = ar9170_usb_tx;
 887         aru->common.exec_cmd = ar9170_usb_exec_cmd;
 888         aru->common.callback_cmd = ar9170_usb_callback_cmd;
 889
 890 #ifdef CONFIG_PM
 891         udev->reset_resume = 1;
 892 #endif /* CONFIG_PM */
 893         err = ar9170_usb_reset(aru);
 894         if (err)
 895                 goto err_freehw;
 896
 897         usb_get_dev(aru->udev);
 898         return request_firmware_nowait(THIS_MODULE, 1, "ar9170.fw",
 899                                        &aru->udev->dev, GFP_KERNEL, aru,
 900                                        ar9170_usb_firmware_step2);
 901 err_freehw:
 902         usb_set_intfdata(intf, NULL);
 903         usb_put_dev(udev);
 904         ieee80211_free_hw(ar->hw);
 905 out:
 906         return err;
 907 }
 908
 909 static void ar9170_usb_disconnect(struct usb_interface *intf)
 910 {
 911         struct ar9170_usb *aru = usb_get_intfdata(intf);
 912
 913         if (!aru)
 914                 return;
 915
 916         aru->common.state = AR9170_IDLE;
 917
 918         wait_for_completion(&aru->firmware_loading_complete);
 919
 920         ar9170_unregister(&aru->common);
 921         ar9170_usb_cancel_urbs(aru);
 922
 923         usb_put_dev(aru->udev);
 924         usb_set_intfdata(intf, NULL);
 925         ieee80211_free_hw(aru->common.hw);
 926
 927         release_firmware(aru->init_values);
 928         release_firmware(aru->firmware);
 929 }
 930
 931 #ifdef CONFIG_PM
 932 static int ar9170_suspend(struct usb_interface *intf,
 933                           pm_message_t  message)
 934 {
 935         struct ar9170_usb *aru = usb_get_intfdata(intf);
 936
 937         if (!aru)
 938                 return -ENODEV;
 939
 940         aru->common.state = AR9170_IDLE;
 941         ar9170_usb_cancel_urbs(aru);
 942
 943         return 0;
 944 }
 945
 946 static int ar9170_resume(struct usb_interface *intf)
 947 {
 948         struct ar9170_usb *aru = usb_get_intfdata(intf);
 949         int err;
 950
 951         if (!aru)
 952                 return -ENODEV;
 953
 954         usb_unpoison_anchored_urbs(&aru->rx_submitted);
 955         usb_unpoison_anchored_urbs(&aru->tx_submitted);
 956
 957         err = ar9170_usb_init_device(aru);
 958         if (err)
 959                 goto err_unrx;
 960
 961         err = ar9170_usb_open(&aru->common);
 962         if (err)
 963                 goto err_unrx;
 964
 965         return 0;
 966
 967 err_unrx:
 968         aru->common.state = AR9170_IDLE;
 969         ar9170_usb_cancel_urbs(aru);
 970
 971         return err;
 972 }
 973 #endif /* CONFIG_PM */
 974
 975 static struct usb_driver ar9170_driver = {
 976         .name = "ar9170usb",
 977         .probe = ar9170_usb_probe,
 978         .disconnect = ar9170_usb_disconnect,
 979         .id_table = ar9170_usb_ids,
 980         .soft_unbind = 1,
 981 #ifdef CONFIG_PM
 982         .suspend = ar9170_suspend,
 983         .resume = ar9170_resume,
 984         .reset_resume = ar9170_resume,
 985 #endif /* CONFIG_PM */
 986 };
 987
 988 static int __init ar9170_init(void)
 989 {
 990         return usb_register(&ar9170_driver);
 991 }
 992
 993 static void __exit ar9170_exit(void)
 994 {
 995         usb_deregister(&ar9170_driver);
 996 }
 997
 998 module_init(ar9170_init);
 999 module_exit(ar9170_exit);