Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/linville/wireles...
[pandora-kernel.git] / drivers / net / wireless / rt2x00 / rt2x00usb.c
1 /*
2         Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
3         <http://rt2x00.serialmonkey.com>
4
5         This program is free software; you can redistribute it and/or modify
6         it under the terms of the GNU General Public License as published by
7         the Free Software Foundation; either version 2 of the License, or
8         (at your option) any later version.
9
10         This program is distributed in the hope that it will be useful,
11         but WITHOUT ANY WARRANTY; without even the implied warranty of
12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13         GNU General Public License for more details.
14
15         You should have received a copy of the GNU General Public License
16         along with this program; if not, write to the
17         Free Software Foundation, Inc.,
18         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21 /*
22         Module: rt2x00usb
23         Abstract: rt2x00 generic usb device routines.
24  */
25
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/usb.h>
29 #include <linux/bug.h>
30
31 #include "rt2x00.h"
32 #include "rt2x00usb.h"
33
34 /*
35  * Interfacing with the HW.
36  */
37 int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
38                              const u8 request, const u8 requesttype,
39                              const u16 offset, const u16 value,
40                              void *buffer, const u16 buffer_length,
41                              const int timeout)
42 {
43         struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
44         int status;
45         unsigned int i;
46         unsigned int pipe =
47             (requesttype == USB_VENDOR_REQUEST_IN) ?
48             usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
49
50
51         for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
52                 status = usb_control_msg(usb_dev, pipe, request, requesttype,
53                                          value, offset, buffer, buffer_length,
54                                          timeout);
55                 if (status >= 0)
56                         return 0;
57
58                 /*
59                  * Check for errors
60                  * -ENODEV: Device has disappeared, no point continuing.
61                  * All other errors: Try again.
62                  */
63                 else if (status == -ENODEV)
64                         break;
65         }
66
67         ERROR(rt2x00dev,
68               "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
69               request, offset, status);
70
71         return status;
72 }
73 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
74
75 int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
76                                    const u8 request, const u8 requesttype,
77                                    const u16 offset, void *buffer,
78                                    const u16 buffer_length, const int timeout)
79 {
80         int status;
81
82         BUG_ON(!mutex_is_locked(&rt2x00dev->usb_cache_mutex));
83
84         /*
85          * Check for Cache availability.
86          */
87         if (unlikely(!rt2x00dev->csr.cache || buffer_length > CSR_CACHE_SIZE)) {
88                 ERROR(rt2x00dev, "CSR cache not available.\n");
89                 return -ENOMEM;
90         }
91
92         if (requesttype == USB_VENDOR_REQUEST_OUT)
93                 memcpy(rt2x00dev->csr.cache, buffer, buffer_length);
94
95         status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
96                                           offset, 0, rt2x00dev->csr.cache,
97                                           buffer_length, timeout);
98
99         if (!status && requesttype == USB_VENDOR_REQUEST_IN)
100                 memcpy(buffer, rt2x00dev->csr.cache, buffer_length);
101
102         return status;
103 }
104 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock);
105
106 int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
107                                   const u8 request, const u8 requesttype,
108                                   const u16 offset, void *buffer,
109                                   const u16 buffer_length, const int timeout)
110 {
111         int status;
112
113         mutex_lock(&rt2x00dev->usb_cache_mutex);
114
115         status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
116                                                 requesttype, offset, buffer,
117                                                 buffer_length, timeout);
118
119         mutex_unlock(&rt2x00dev->usb_cache_mutex);
120
121         return status;
122 }
123 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
124
125 /*
126  * TX data handlers.
127  */
128 static void rt2x00usb_interrupt_txdone(struct urb *urb)
129 {
130         struct queue_entry *entry = (struct queue_entry *)urb->context;
131         struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
132         struct txdone_entry_desc txdesc;
133         enum data_queue_qid qid = skb_get_queue_mapping(entry->skb);
134
135         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
136             !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
137                 return;
138
139         /*
140          * Remove the descriptor data from the buffer.
141          */
142         skb_pull(entry->skb, entry->queue->desc_size);
143
144         /*
145          * Obtain the status about this packet.
146          * Note that when the status is 0 it does not mean the
147          * frame was send out correctly. It only means the frame
148          * was succesfully pushed to the hardware, we have no
149          * way to determine the transmission status right now.
150          * (Only indirectly by looking at the failed TX counters
151          * in the register).
152          */
153         if (!urb->status)
154                 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
155         else
156                 __set_bit(TXDONE_FAILURE, &txdesc.flags);
157         txdesc.retry = 0;
158
159         rt2x00lib_txdone(entry, &txdesc);
160
161         /*
162          * Make this entry available for reuse.
163          */
164         entry->flags = 0;
165         rt2x00queue_index_inc(entry->queue, Q_INDEX_DONE);
166
167         /*
168          * If the data queue was below the threshold before the txdone
169          * handler we must make sure the packet queue in the mac80211 stack
170          * is reenabled when the txdone handler has finished.
171          */
172         if (!rt2x00queue_threshold(entry->queue))
173                 ieee80211_wake_queue(rt2x00dev->hw, qid);
174 }
175
176 int rt2x00usb_write_tx_data(struct queue_entry *entry)
177 {
178         struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
179         struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
180         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
181         struct skb_frame_desc *skbdesc;
182         u32 length;
183
184         /*
185          * Add the descriptor in front of the skb.
186          */
187         skb_push(entry->skb, entry->queue->desc_size);
188         memset(entry->skb->data, 0, entry->queue->desc_size);
189
190         /*
191          * Fill in skb descriptor
192          */
193         skbdesc = get_skb_frame_desc(entry->skb);
194         memset(skbdesc, 0, sizeof(*skbdesc));
195         skbdesc->desc = entry->skb->data;
196         skbdesc->desc_len = entry->queue->desc_size;
197         skbdesc->entry = entry;
198
199         /*
200          * USB devices cannot blindly pass the skb->len as the
201          * length of the data to usb_fill_bulk_urb. Pass the skb
202          * to the driver to determine what the length should be.
203          */
204         length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
205
206         usb_fill_bulk_urb(entry_priv->urb, usb_dev,
207                           usb_sndbulkpipe(usb_dev, 1),
208                           entry->skb->data, length,
209                           rt2x00usb_interrupt_txdone, entry);
210
211         return 0;
212 }
213 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
214
215 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
216 {
217         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
218
219         if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
220                 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
221 }
222
223 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
224                              const enum data_queue_qid qid)
225 {
226         struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
227         unsigned long irqflags;
228         unsigned int index;
229         unsigned int index_done;
230         unsigned int i;
231
232         /*
233          * Only protect the range we are going to loop over,
234          * if during our loop a extra entry is set to pending
235          * it should not be kicked during this run, since it
236          * is part of another TX operation.
237          */
238         spin_lock_irqsave(&queue->lock, irqflags);
239         index = queue->index[Q_INDEX];
240         index_done = queue->index[Q_INDEX_DONE];
241         spin_unlock_irqrestore(&queue->lock, irqflags);
242
243         /*
244          * Start from the TX done pointer, this guarentees that we will
245          * send out all frames in the correct order.
246          */
247         if (index_done < index) {
248                 for (i = index_done; i < index; i++)
249                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
250         } else {
251                 for (i = index_done; i < queue->limit; i++)
252                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
253
254                 for (i = 0; i < index; i++)
255                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
256         }
257 }
258 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
259
260 /*
261  * RX data handlers.
262  */
263 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
264 {
265         struct queue_entry *entry = (struct queue_entry *)urb->context;
266         struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
267         struct sk_buff *skb;
268         struct skb_frame_desc *skbdesc;
269         struct rxdone_entry_desc rxdesc;
270         u8 rxd[32];
271
272         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
273             !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
274                 return;
275
276         /*
277          * Check if the received data is simply too small
278          * to be actually valid, or if the urb is signaling
279          * a problem.
280          */
281         if (urb->actual_length < entry->queue->desc_size || urb->status)
282                 goto skip_entry;
283
284         /*
285          * Fill in skb descriptor
286          */
287         skbdesc = get_skb_frame_desc(entry->skb);
288         memset(skbdesc, 0, sizeof(*skbdesc));
289         skbdesc->entry = entry;
290         skbdesc->desc = rxd;
291         skbdesc->desc_len = entry->queue->desc_size;
292
293         memset(&rxdesc, 0, sizeof(rxdesc));
294         rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
295
296         /*
297          * Allocate a new sk buffer to replace the current one.
298          * If allocation fails, we should drop the current frame
299          * so we can recycle the existing sk buffer for the new frame.
300          */
301         skb = rt2x00queue_alloc_rxskb(entry->queue);
302         if (!skb)
303                 goto skip_entry;
304
305         /*
306          * Send the frame to rt2x00lib for further processing.
307          */
308         rt2x00lib_rxdone(entry, &rxdesc);
309
310         /*
311          * Replace current entry's skb with the newly allocated one,
312          * and reinitialize the urb.
313          */
314         entry->skb = skb;
315         urb->transfer_buffer = entry->skb->data;
316         urb->transfer_buffer_length = entry->skb->len;
317
318 skip_entry:
319         if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
320                 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
321                 usb_submit_urb(urb, GFP_ATOMIC);
322         }
323
324         rt2x00queue_index_inc(entry->queue, Q_INDEX);
325 }
326
327 /*
328  * Radio handlers
329  */
330 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
331 {
332         struct queue_entry_priv_usb *entry_priv;
333         struct queue_entry_priv_usb_bcn *bcn_priv;
334         unsigned int i;
335
336         rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
337                                     REGISTER_TIMEOUT);
338
339         /*
340          * Cancel all queues.
341          */
342         for (i = 0; i < rt2x00dev->rx->limit; i++) {
343                 entry_priv = rt2x00dev->rx->entries[i].priv_data;
344                 usb_kill_urb(entry_priv->urb);
345         }
346
347         /*
348          * Kill guardian urb.
349          */
350         for (i = 0; i < rt2x00dev->bcn->limit; i++) {
351                 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
352                 if (bcn_priv->guardian_urb)
353                         usb_kill_urb(bcn_priv->guardian_urb);
354         }
355 }
356 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
357
358 /*
359  * Device initialization handlers.
360  */
361 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
362                             struct queue_entry *entry)
363 {
364         struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
365         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
366
367         usb_fill_bulk_urb(entry_priv->urb, usb_dev,
368                           usb_rcvbulkpipe(usb_dev, 1),
369                           entry->skb->data, entry->skb->len,
370                           rt2x00usb_interrupt_rxdone, entry);
371
372         __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
373         usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
374 }
375 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
376
377 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
378                             struct queue_entry *entry)
379 {
380         entry->flags = 0;
381 }
382 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
383
384 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
385                                struct data_queue *queue)
386 {
387         struct queue_entry_priv_usb *entry_priv;
388         struct queue_entry_priv_usb_bcn *bcn_priv;
389         unsigned int i;
390
391         for (i = 0; i < queue->limit; i++) {
392                 entry_priv = queue->entries[i].priv_data;
393                 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
394                 if (!entry_priv->urb)
395                         return -ENOMEM;
396         }
397
398         /*
399          * If this is not the beacon queue or
400          * no guardian byte was required for the beacon,
401          * then we are done.
402          */
403         if (rt2x00dev->bcn != queue ||
404             !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
405                 return 0;
406
407         for (i = 0; i < queue->limit; i++) {
408                 bcn_priv = queue->entries[i].priv_data;
409                 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
410                 if (!bcn_priv->guardian_urb)
411                         return -ENOMEM;
412         }
413
414         return 0;
415 }
416
417 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
418                                struct data_queue *queue)
419 {
420         struct queue_entry_priv_usb *entry_priv;
421         struct queue_entry_priv_usb_bcn *bcn_priv;
422         unsigned int i;
423
424         if (!queue->entries)
425                 return;
426
427         for (i = 0; i < queue->limit; i++) {
428                 entry_priv = queue->entries[i].priv_data;
429                 usb_kill_urb(entry_priv->urb);
430                 usb_free_urb(entry_priv->urb);
431                 if (queue->entries[i].skb)
432                         kfree_skb(queue->entries[i].skb);
433         }
434
435         /*
436          * If this is not the beacon queue or
437          * no guardian byte was required for the beacon,
438          * then we are done.
439          */
440         if (rt2x00dev->bcn != queue ||
441             !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
442                 return;
443
444         for (i = 0; i < queue->limit; i++) {
445                 bcn_priv = queue->entries[i].priv_data;
446                 usb_kill_urb(bcn_priv->guardian_urb);
447                 usb_free_urb(bcn_priv->guardian_urb);
448         }
449 }
450
451 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
452 {
453         struct data_queue *queue;
454         struct sk_buff *skb;
455         unsigned int entry_size;
456         unsigned int i;
457         int uninitialized_var(status);
458
459         /*
460          * Allocate DMA
461          */
462         queue_for_each(rt2x00dev, queue) {
463                 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
464                 if (status)
465                         goto exit;
466         }
467
468         /*
469          * For the RX queue, skb's should be allocated.
470          */
471         entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
472         for (i = 0; i < rt2x00dev->rx->limit; i++) {
473                 skb = rt2x00queue_alloc_rxskb(rt2x00dev->rx);
474                 if (!skb)
475                         goto exit;
476
477                 rt2x00dev->rx->entries[i].skb = skb;
478         }
479
480         return 0;
481
482 exit:
483         rt2x00usb_uninitialize(rt2x00dev);
484
485         return status;
486 }
487 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
488
489 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
490 {
491         struct data_queue *queue;
492
493         queue_for_each(rt2x00dev, queue)
494                 rt2x00usb_free_urb(rt2x00dev, queue);
495 }
496 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
497
498 /*
499  * USB driver handlers.
500  */
501 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
502 {
503         kfree(rt2x00dev->rf);
504         rt2x00dev->rf = NULL;
505
506         kfree(rt2x00dev->eeprom);
507         rt2x00dev->eeprom = NULL;
508
509         kfree(rt2x00dev->csr.cache);
510         rt2x00dev->csr.cache = NULL;
511 }
512
513 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
514 {
515         rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
516         if (!rt2x00dev->csr.cache)
517                 goto exit;
518
519         rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
520         if (!rt2x00dev->eeprom)
521                 goto exit;
522
523         rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
524         if (!rt2x00dev->rf)
525                 goto exit;
526
527         return 0;
528
529 exit:
530         ERROR_PROBE("Failed to allocate registers.\n");
531
532         rt2x00usb_free_reg(rt2x00dev);
533
534         return -ENOMEM;
535 }
536
537 int rt2x00usb_probe(struct usb_interface *usb_intf,
538                     const struct usb_device_id *id)
539 {
540         struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
541         struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
542         struct ieee80211_hw *hw;
543         struct rt2x00_dev *rt2x00dev;
544         int retval;
545
546         usb_dev = usb_get_dev(usb_dev);
547
548         hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
549         if (!hw) {
550                 ERROR_PROBE("Failed to allocate hardware.\n");
551                 retval = -ENOMEM;
552                 goto exit_put_device;
553         }
554
555         usb_set_intfdata(usb_intf, hw);
556
557         rt2x00dev = hw->priv;
558         rt2x00dev->dev = usb_intf;
559         rt2x00dev->ops = ops;
560         rt2x00dev->hw = hw;
561         mutex_init(&rt2x00dev->usb_cache_mutex);
562
563         rt2x00dev->usb_maxpacket =
564             usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
565         if (!rt2x00dev->usb_maxpacket)
566                 rt2x00dev->usb_maxpacket = 1;
567
568         retval = rt2x00usb_alloc_reg(rt2x00dev);
569         if (retval)
570                 goto exit_free_device;
571
572         retval = rt2x00lib_probe_dev(rt2x00dev);
573         if (retval)
574                 goto exit_free_reg;
575
576         return 0;
577
578 exit_free_reg:
579         rt2x00usb_free_reg(rt2x00dev);
580
581 exit_free_device:
582         ieee80211_free_hw(hw);
583
584 exit_put_device:
585         usb_put_dev(usb_dev);
586
587         usb_set_intfdata(usb_intf, NULL);
588
589         return retval;
590 }
591 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
592
593 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
594 {
595         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
596         struct rt2x00_dev *rt2x00dev = hw->priv;
597
598         /*
599          * Free all allocated data.
600          */
601         rt2x00lib_remove_dev(rt2x00dev);
602         rt2x00usb_free_reg(rt2x00dev);
603         ieee80211_free_hw(hw);
604
605         /*
606          * Free the USB device data.
607          */
608         usb_set_intfdata(usb_intf, NULL);
609         usb_put_dev(interface_to_usbdev(usb_intf));
610 }
611 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
612
613 #ifdef CONFIG_PM
614 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
615 {
616         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
617         struct rt2x00_dev *rt2x00dev = hw->priv;
618         int retval;
619
620         retval = rt2x00lib_suspend(rt2x00dev, state);
621         if (retval)
622                 return retval;
623
624         rt2x00usb_free_reg(rt2x00dev);
625
626         /*
627          * Decrease usbdev refcount.
628          */
629         usb_put_dev(interface_to_usbdev(usb_intf));
630
631         return 0;
632 }
633 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
634
635 int rt2x00usb_resume(struct usb_interface *usb_intf)
636 {
637         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
638         struct rt2x00_dev *rt2x00dev = hw->priv;
639         int retval;
640
641         usb_get_dev(interface_to_usbdev(usb_intf));
642
643         retval = rt2x00usb_alloc_reg(rt2x00dev);
644         if (retval)
645                 return retval;
646
647         retval = rt2x00lib_resume(rt2x00dev);
648         if (retval)
649                 goto exit_free_reg;
650
651         return 0;
652
653 exit_free_reg:
654         rt2x00usb_free_reg(rt2x00dev);
655
656         return retval;
657 }
658 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
659 #endif /* CONFIG_PM */
660
661 /*
662  * rt2x00usb module information.
663  */
664 MODULE_AUTHOR(DRV_PROJECT);
665 MODULE_VERSION(DRV_VERSION);
666 MODULE_DESCRIPTION("rt2x00 usb library");
667 MODULE_LICENSE("GPL");