Version:  2.0.40 2.2.26 2.4.37 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10

Linux/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         if (ar->usb_ep_cmd_is_bulk)
625                 usb_fill_bulk_urb(urb, ar->udev,
626                                   usb_sndbulkpipe(ar->udev, AR9170_USB_EP_CMD),
627                                   cmd, cmd->hdr.len + 4,
628                                   carl9170_usb_cmd_complete, ar);
629         else
630                 usb_fill_int_urb(urb, ar->udev,
631                                  usb_sndintpipe(ar->udev, AR9170_USB_EP_CMD),
632                                  cmd, cmd->hdr.len + 4,
633                                  carl9170_usb_cmd_complete, ar, 1);
634 
635         if (free_buf)
636                 urb->transfer_flags |= URB_FREE_BUFFER;
637 
638         usb_anchor_urb(urb, &ar->tx_cmd);
639         usb_free_urb(urb);
640 
641         return carl9170_usb_submit_cmd_urb(ar);
642 
643 err_free:
644         if (free_buf)
645                 kfree(cmd);
646 
647         return err;
648 }
649 
650 int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids cmd,
651         unsigned int plen, void *payload, unsigned int outlen, void *out)
652 {
653         int err = -ENOMEM;
654         unsigned long time_left;
655 
656         if (!IS_ACCEPTING_CMD(ar))
657                 return -EIO;
658 
659         if (!(cmd & CARL9170_CMD_ASYNC_FLAG))
660                 might_sleep();
661 
662         ar->cmd.hdr.len = plen;
663         ar->cmd.hdr.cmd = cmd;
664         /* writing multiple regs fills this buffer already */
665         if (plen && payload != (u8 *)(ar->cmd.data))
666                 memcpy(ar->cmd.data, payload, plen);
667 
668         spin_lock_bh(&ar->cmd_lock);
669         ar->readbuf = (u8 *)out;
670         ar->readlen = outlen;
671         spin_unlock_bh(&ar->cmd_lock);
672 
673         reinit_completion(&ar->cmd_wait);
674         err = __carl9170_exec_cmd(ar, &ar->cmd, false);
675 
676         if (!(cmd & CARL9170_CMD_ASYNC_FLAG)) {
677                 time_left = wait_for_completion_timeout(&ar->cmd_wait, HZ);
678                 if (time_left == 0) {
679                         err = -ETIMEDOUT;
680                         goto err_unbuf;
681                 }
682 
683                 if (ar->readlen != outlen) {
684                         err = -EMSGSIZE;
685                         goto err_unbuf;
686                 }
687         }
688 
689         return 0;
690 
691 err_unbuf:
692         /* Maybe the device was removed in the moment we were waiting? */
693         if (IS_STARTED(ar)) {
694                 dev_err(&ar->udev->dev, "no command feedback "
695                         "received (%d).\n", err);
696 
697                 /* provide some maybe useful debug information */
698                 print_hex_dump_bytes("carl9170 cmd: ", DUMP_PREFIX_NONE,
699                                      &ar->cmd, plen + 4);
700 
701                 carl9170_restart(ar, CARL9170_RR_COMMAND_TIMEOUT);
702         }
703 
704         /* invalidate to avoid completing the next command prematurely */
705         spin_lock_bh(&ar->cmd_lock);
706         ar->readbuf = NULL;
707         ar->readlen = 0;
708         spin_unlock_bh(&ar->cmd_lock);
709 
710         return err;
711 }
712 
713 void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb)
714 {
715         struct urb *urb;
716         struct ar9170_stream *tx_stream;
717         void *data;
718         unsigned int len;
719 
720         if (!IS_STARTED(ar))
721                 goto err_drop;
722 
723         urb = usb_alloc_urb(0, GFP_ATOMIC);
724         if (!urb)
725                 goto err_drop;
726 
727         if (ar->fw.tx_stream) {
728                 tx_stream = (void *) (skb->data - sizeof(*tx_stream));
729 
730                 len = skb->len + sizeof(*tx_stream);
731                 tx_stream->length = cpu_to_le16(len);
732                 tx_stream->tag = cpu_to_le16(AR9170_TX_STREAM_TAG);
733                 data = tx_stream;
734         } else {
735                 data = skb->data;
736                 len = skb->len;
737         }
738 
739         usb_fill_bulk_urb(urb, ar->udev, usb_sndbulkpipe(ar->udev,
740                 AR9170_USB_EP_TX), data, len,
741                 carl9170_usb_tx_data_complete, skb);
742 
743         urb->transfer_flags |= URB_ZERO_PACKET;
744 
745         usb_anchor_urb(urb, &ar->tx_wait);
746 
747         usb_free_urb(urb);
748 
749         carl9170_usb_submit_data_urb(ar);
750         return;
751 
752 err_drop:
753         carl9170_tx_drop(ar, skb);
754         carl9170_tx_callback(ar, skb);
755 }
756 
757 static void carl9170_release_firmware(struct ar9170 *ar)
758 {
759         if (ar->fw.fw) {
760                 release_firmware(ar->fw.fw);
761                 memset(&ar->fw, 0, sizeof(ar->fw));
762         }
763 }
764 
765 void carl9170_usb_stop(struct ar9170 *ar)
766 {
767         int ret;
768 
769         carl9170_set_state_when(ar, CARL9170_IDLE, CARL9170_STOPPED);
770 
771         ret = carl9170_usb_flush(ar);
772         if (ret)
773                 dev_err(&ar->udev->dev, "kill pending tx urbs.\n");
774 
775         usb_poison_anchored_urbs(&ar->tx_anch);
776         carl9170_usb_handle_tx_err(ar);
777 
778         /* kill any pending command */
779         spin_lock_bh(&ar->cmd_lock);
780         ar->readlen = 0;
781         spin_unlock_bh(&ar->cmd_lock);
782         complete(&ar->cmd_wait);
783 
784         /*
785          * Note:
786          * So far we freed all tx urbs, but we won't dare to touch any rx urbs.
787          * Else we would end up with a unresponsive device...
788          */
789 }
790 
791 int carl9170_usb_open(struct ar9170 *ar)
792 {
793         usb_unpoison_anchored_urbs(&ar->tx_anch);
794 
795         carl9170_set_state_when(ar, CARL9170_STOPPED, CARL9170_IDLE);
796         return 0;
797 }
798 
799 static int carl9170_usb_load_firmware(struct ar9170 *ar)
800 {
801         const u8 *data;
802         u8 *buf;
803         unsigned int transfer;
804         size_t len;
805         u32 addr;
806         int err = 0;
807 
808         buf = kmalloc(4096, GFP_KERNEL);
809         if (!buf) {
810                 err = -ENOMEM;
811                 goto err_out;
812         }
813 
814         data = ar->fw.fw->data;
815         len = ar->fw.fw->size;
816         addr = ar->fw.address;
817 
818         /* this removes the miniboot image */
819         data += ar->fw.offset;
820         len -= ar->fw.offset;
821 
822         while (len) {
823                 transfer = min_t(unsigned int, len, 4096u);
824                 memcpy(buf, data, transfer);
825 
826                 err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
827                                       0x30 /* FW DL */, 0x40 | USB_DIR_OUT,
828                                       addr >> 8, 0, buf, transfer, 100);
829 
830                 if (err < 0) {
831                         kfree(buf);
832                         goto err_out;
833                 }
834 
835                 len -= transfer;
836                 data += transfer;
837                 addr += transfer;
838         }
839         kfree(buf);
840 
841         err = usb_control_msg(ar->udev, usb_sndctrlpipe(ar->udev, 0),
842                               0x31 /* FW DL COMPLETE */,
843                               0x40 | USB_DIR_OUT, 0, 0, NULL, 0, 200);
844 
845         if (wait_for_completion_timeout(&ar->fw_boot_wait, HZ) == 0) {
846                 err = -ETIMEDOUT;
847                 goto err_out;
848         }
849 
850         err = carl9170_echo_test(ar, 0x4a110123);
851         if (err)
852                 goto err_out;
853 
854         /* now, start the command response counter */
855         ar->cmd_seq = -1;
856 
857         return 0;
858 
859 err_out:
860         dev_err(&ar->udev->dev, "firmware upload failed (%d).\n", err);
861         return err;
862 }
863 
864 int carl9170_usb_restart(struct ar9170 *ar)
865 {
866         int err = 0;
867 
868         if (ar->intf->condition != USB_INTERFACE_BOUND)
869                 return 0;
870 
871         /*
872          * Disable the command response sequence counter check.
873          * We already know that the device/firmware is in a bad state.
874          * So, no extra points are awarded to anyone who reminds the
875          * driver about that.
876          */
877         ar->cmd_seq = -2;
878 
879         err = carl9170_reboot(ar);
880 
881         carl9170_usb_stop(ar);
882 
883         if (err)
884                 goto err_out;
885 
886         tasklet_schedule(&ar->usb_tasklet);
887 
888         /* The reboot procedure can take quite a while to complete. */
889         msleep(1100);
890 
891         err = carl9170_usb_open(ar);
892         if (err)
893                 goto err_out;
894 
895         err = carl9170_usb_load_firmware(ar);
896         if (err)
897                 goto err_out;
898 
899         return 0;
900 
901 err_out:
902         carl9170_usb_cancel_urbs(ar);
903         return err;
904 }
905 
906 void carl9170_usb_reset(struct ar9170 *ar)
907 {
908         /*
909          * This is the last resort to get the device going again
910          * without any *user replugging action*.
911          *
912          * But there is a catch: usb_reset really is like a physical
913          * *reconnect*. The mac80211 state will be lost in the process.
914          * Therefore a userspace application, which is monitoring
915          * the link must step in.
916          */
917         carl9170_usb_cancel_urbs(ar);
918 
919         carl9170_usb_stop(ar);
920 
921         usb_queue_reset_device(ar->intf);
922 }
923 
924 static int carl9170_usb_init_device(struct ar9170 *ar)
925 {
926         int err;
927 
928         /*
929          * The carl9170 firmware let's the driver know when it's
930          * ready for action. But we have to be prepared to gracefully
931          * handle all spurious [flushed] messages after each (re-)boot.
932          * Thus the command response counter remains disabled until it
933          * can be safely synchronized.
934          */
935         ar->cmd_seq = -2;
936 
937         err = carl9170_usb_send_rx_irq_urb(ar);
938         if (err)
939                 goto err_out;
940 
941         err = carl9170_usb_init_rx_bulk_urbs(ar);
942         if (err)
943                 goto err_unrx;
944 
945         err = carl9170_usb_open(ar);
946         if (err)
947                 goto err_unrx;
948 
949         mutex_lock(&ar->mutex);
950         err = carl9170_usb_load_firmware(ar);
951         mutex_unlock(&ar->mutex);
952         if (err)
953                 goto err_stop;
954 
955         return 0;
956 
957 err_stop:
958         carl9170_usb_stop(ar);
959 
960 err_unrx:
961         carl9170_usb_cancel_urbs(ar);
962 
963 err_out:
964         return err;
965 }
966 
967 static void carl9170_usb_firmware_failed(struct ar9170 *ar)
968 {
969         struct device *parent = ar->udev->dev.parent;
970         struct usb_device *udev;
971 
972         /*
973          * Store a copy of the usb_device pointer locally.
974          * This is because device_release_driver initiates
975          * carl9170_usb_disconnect, which in turn frees our
976          * driver context (ar).
977          */
978         udev = ar->udev;
979 
980         complete(&ar->fw_load_wait);
981 
982         /* unbind anything failed */
983         if (parent)
984                 device_lock(parent);
985 
986         device_release_driver(&udev->dev);
987         if (parent)
988                 device_unlock(parent);
989 
990         usb_put_dev(udev);
991 }
992 
993 static void carl9170_usb_firmware_finish(struct ar9170 *ar)
994 {
995         int err;
996 
997         err = carl9170_parse_firmware(ar);
998         if (err)
999                 goto err_freefw;
1000 
1001         err = carl9170_usb_init_device(ar);
1002         if (err)
1003                 goto err_freefw;
1004 
1005         err = carl9170_register(ar);
1006 
1007         carl9170_usb_stop(ar);
1008         if (err)
1009                 goto err_unrx;
1010 
1011         complete(&ar->fw_load_wait);
1012         usb_put_dev(ar->udev);
1013         return;
1014 
1015 err_unrx:
1016         carl9170_usb_cancel_urbs(ar);
1017 
1018 err_freefw:
1019         carl9170_release_firmware(ar);
1020         carl9170_usb_firmware_failed(ar);
1021 }
1022 
1023 static void carl9170_usb_firmware_step2(const struct firmware *fw,
1024                                         void *context)
1025 {
1026         struct ar9170 *ar = context;
1027 
1028         if (fw) {
1029                 ar->fw.fw = fw;
1030                 carl9170_usb_firmware_finish(ar);
1031                 return;
1032         }
1033 
1034         dev_err(&ar->udev->dev, "firmware not found.\n");
1035         carl9170_usb_firmware_failed(ar);
1036 }
1037 
1038 static int carl9170_usb_probe(struct usb_interface *intf,
1039                               const struct usb_device_id *id)
1040 {
1041         struct usb_endpoint_descriptor *ep;
1042         struct ar9170 *ar;
1043         struct usb_device *udev;
1044         int i, err;
1045 
1046         err = usb_reset_device(interface_to_usbdev(intf));
1047         if (err)
1048                 return err;
1049 
1050         ar = carl9170_alloc(sizeof(*ar));
1051         if (IS_ERR(ar))
1052                 return PTR_ERR(ar);
1053 
1054         udev = interface_to_usbdev(intf);
1055         usb_get_dev(udev);
1056         ar->udev = udev;
1057         ar->intf = intf;
1058         ar->features = id->driver_info;
1059 
1060         /* We need to remember the type of endpoint 4 because it differs
1061          * between high- and full-speed configuration. The high-speed
1062          * configuration specifies it as interrupt and the full-speed
1063          * configuration as bulk endpoint. This information is required
1064          * later when sending urbs to that endpoint.
1065          */
1066         for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; ++i) {
1067                 ep = &intf->cur_altsetting->endpoint[i].desc;
1068 
1069                 if (usb_endpoint_num(ep) == AR9170_USB_EP_CMD &&
1070                     usb_endpoint_dir_out(ep) &&
1071                     usb_endpoint_type(ep) == USB_ENDPOINT_XFER_BULK)
1072                         ar->usb_ep_cmd_is_bulk = true;
1073         }
1074 
1075         usb_set_intfdata(intf, ar);
1076         SET_IEEE80211_DEV(ar->hw, &intf->dev);
1077 
1078         init_usb_anchor(&ar->rx_anch);
1079         init_usb_anchor(&ar->rx_pool);
1080         init_usb_anchor(&ar->rx_work);
1081         init_usb_anchor(&ar->tx_wait);
1082         init_usb_anchor(&ar->tx_anch);
1083         init_usb_anchor(&ar->tx_cmd);
1084         init_usb_anchor(&ar->tx_err);
1085         init_completion(&ar->cmd_wait);
1086         init_completion(&ar->fw_boot_wait);
1087         init_completion(&ar->fw_load_wait);
1088         tasklet_init(&ar->usb_tasklet, carl9170_usb_tasklet,
1089                      (unsigned long)ar);
1090 
1091         atomic_set(&ar->tx_cmd_urbs, 0);
1092         atomic_set(&ar->tx_anch_urbs, 0);
1093         atomic_set(&ar->rx_work_urbs, 0);
1094         atomic_set(&ar->rx_anch_urbs, 0);
1095         atomic_set(&ar->rx_pool_urbs, 0);
1096 
1097         usb_get_dev(ar->udev);
1098 
1099         carl9170_set_state(ar, CARL9170_STOPPED);
1100 
1101         err = request_firmware_nowait(THIS_MODULE, 1, CARL9170FW_NAME,
1102                 &ar->udev->dev, GFP_KERNEL, ar, carl9170_usb_firmware_step2);
1103         if (err) {
1104                 usb_put_dev(udev);
1105                 usb_put_dev(udev);
1106                 carl9170_free(ar);
1107         }
1108         return err;
1109 }
1110 
1111 static void carl9170_usb_disconnect(struct usb_interface *intf)
1112 {
1113         struct ar9170 *ar = usb_get_intfdata(intf);
1114         struct usb_device *udev;
1115 
1116         if (WARN_ON(!ar))
1117                 return;
1118 
1119         udev = ar->udev;
1120         wait_for_completion(&ar->fw_load_wait);
1121 
1122         if (IS_INITIALIZED(ar)) {
1123                 carl9170_reboot(ar);
1124                 carl9170_usb_stop(ar);
1125         }
1126 
1127         carl9170_usb_cancel_urbs(ar);
1128         carl9170_unregister(ar);
1129 
1130         usb_set_intfdata(intf, NULL);
1131 
1132         carl9170_release_firmware(ar);
1133         carl9170_free(ar);
1134         usb_put_dev(udev);
1135 }
1136 
1137 #ifdef CONFIG_PM
1138 static int carl9170_usb_suspend(struct usb_interface *intf,
1139                                 pm_message_t message)
1140 {
1141         struct ar9170 *ar = usb_get_intfdata(intf);
1142 
1143         if (!ar)
1144                 return -ENODEV;
1145 
1146         carl9170_usb_cancel_urbs(ar);
1147 
1148         return 0;
1149 }
1150 
1151 static int carl9170_usb_resume(struct usb_interface *intf)
1152 {
1153         struct ar9170 *ar = usb_get_intfdata(intf);
1154         int err;
1155 
1156         if (!ar)
1157                 return -ENODEV;
1158 
1159         usb_unpoison_anchored_urbs(&ar->rx_anch);
1160         carl9170_set_state(ar, CARL9170_STOPPED);
1161 
1162         /*
1163          * The USB documentation demands that [for suspend] all traffic
1164          * to and from the device has to stop. This would be fine, but
1165          * there's a catch: the device[usb phy] does not come back.
1166          *
1167          * Upon resume the firmware will "kill" itself and the
1168          * boot-code sorts out the magic voodoo.
1169          * Not very nice, but there's not much what could go wrong.
1170          */
1171         msleep(1100);
1172 
1173         err = carl9170_usb_init_device(ar);
1174         if (err)
1175                 goto err_unrx;
1176 
1177         return 0;
1178 
1179 err_unrx:
1180         carl9170_usb_cancel_urbs(ar);
1181 
1182         return err;
1183 }
1184 #endif /* CONFIG_PM */
1185 
1186 static struct usb_driver carl9170_driver = {
1187         .name = KBUILD_MODNAME,
1188         .probe = carl9170_usb_probe,
1189         .disconnect = carl9170_usb_disconnect,
1190         .id_table = carl9170_usb_ids,
1191         .soft_unbind = 1,
1192 #ifdef CONFIG_PM
1193         .suspend = carl9170_usb_suspend,
1194         .resume = carl9170_usb_resume,
1195         .reset_resume = carl9170_usb_resume,
1196 #endif /* CONFIG_PM */
1197         .disable_hub_initiated_lpm = 1,
1198 };
1199 
1200 module_usb_driver(carl9170_driver);
1201 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us