Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6] / 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 = to_usb_device_intf(rt2x00dev->dev);
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
134         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
135             !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
136                 return;
137
138         /*
139          * Remove the descriptor data from the buffer.
140          */
141         skb_pull(entry->skb, entry->queue->desc_size);
142
143         /*
144          * Obtain the status about this packet.
145          * Note that when the status is 0 it does not mean the
146          * frame was send out correctly. It only means the frame
147          * was succesfully pushed to the hardware, we have no
148          * way to determine the transmission status right now.
149          * (Only indirectly by looking at the failed TX counters
150          * in the register).
151          */
152         if (!urb->status)
153                 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
154         else
155                 __set_bit(TXDONE_FAILURE, &txdesc.flags);
156         txdesc.retry = 0;
157
158         rt2x00lib_txdone(entry, &txdesc);
159 }
160
161 int rt2x00usb_write_tx_data(struct queue_entry *entry)
162 {
163         struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
164         struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
165         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
166         struct skb_frame_desc *skbdesc;
167         u32 length;
168
169         /*
170          * Add the descriptor in front of the skb.
171          */
172         skb_push(entry->skb, entry->queue->desc_size);
173         memset(entry->skb->data, 0, entry->queue->desc_size);
174
175         /*
176          * Fill in skb descriptor
177          */
178         skbdesc = get_skb_frame_desc(entry->skb);
179         skbdesc->desc = entry->skb->data;
180         skbdesc->desc_len = entry->queue->desc_size;
181
182         /*
183          * USB devices cannot blindly pass the skb->len as the
184          * length of the data to usb_fill_bulk_urb. Pass the skb
185          * to the driver to determine what the length should be.
186          */
187         length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
188
189         usb_fill_bulk_urb(entry_priv->urb, usb_dev,
190                           usb_sndbulkpipe(usb_dev, 1),
191                           entry->skb->data, length,
192                           rt2x00usb_interrupt_txdone, entry);
193
194         return 0;
195 }
196 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
197
198 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
199 {
200         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
201
202         if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
203                 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
204 }
205
206 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
207                              const enum data_queue_qid qid)
208 {
209         struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
210         unsigned long irqflags;
211         unsigned int index;
212         unsigned int index_done;
213         unsigned int i;
214
215         /*
216          * Only protect the range we are going to loop over,
217          * if during our loop a extra entry is set to pending
218          * it should not be kicked during this run, since it
219          * is part of another TX operation.
220          */
221         spin_lock_irqsave(&queue->lock, irqflags);
222         index = queue->index[Q_INDEX];
223         index_done = queue->index[Q_INDEX_DONE];
224         spin_unlock_irqrestore(&queue->lock, irqflags);
225
226         /*
227          * Start from the TX done pointer, this guarentees that we will
228          * send out all frames in the correct order.
229          */
230         if (index_done < index) {
231                 for (i = index_done; i < index; i++)
232                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
233         } else {
234                 for (i = index_done; i < queue->limit; i++)
235                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
236
237                 for (i = 0; i < index; i++)
238                         rt2x00usb_kick_tx_entry(&queue->entries[i]);
239         }
240 }
241 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
242
243 /*
244  * RX data handlers.
245  */
246 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
247 {
248         struct queue_entry *entry = (struct queue_entry *)urb->context;
249         struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
250         struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
251         u8 rxd[32];
252
253         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
254             !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
255                 return;
256
257         /*
258          * Check if the received data is simply too small
259          * to be actually valid, or if the urb is signaling
260          * a problem.
261          */
262         if (urb->actual_length < entry->queue->desc_size || urb->status) {
263                 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
264                 usb_submit_urb(urb, GFP_ATOMIC);
265                 return;
266         }
267
268         /*
269          * Fill in desc fields of the skb descriptor
270          */
271         skbdesc->desc = rxd;
272         skbdesc->desc_len = entry->queue->desc_size;
273
274         /*
275          * Send the frame to rt2x00lib for further processing.
276          */
277         rt2x00lib_rxdone(rt2x00dev, entry);
278 }
279
280 /*
281  * Radio handlers
282  */
283 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
284 {
285         struct queue_entry_priv_usb *entry_priv;
286         struct queue_entry_priv_usb_bcn *bcn_priv;
287         struct data_queue *queue;
288         unsigned int i;
289
290         rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
291                                     REGISTER_TIMEOUT);
292
293         /*
294          * Cancel all queues.
295          */
296         queue_for_each(rt2x00dev, queue) {
297                 for (i = 0; i < queue->limit; i++) {
298                         entry_priv = queue->entries[i].priv_data;
299                         usb_kill_urb(entry_priv->urb);
300                 }
301         }
302
303         /*
304          * Kill guardian urb (if required by driver).
305          */
306         if (!test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
307                 return;
308
309         for (i = 0; i < rt2x00dev->bcn->limit; i++) {
310                 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
311                 if (bcn_priv->guardian_urb)
312                         usb_kill_urb(bcn_priv->guardian_urb);
313         }
314 }
315 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
316
317 /*
318  * Device initialization handlers.
319  */
320 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
321                             struct queue_entry *entry)
322 {
323         struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
324         struct queue_entry_priv_usb *entry_priv = entry->priv_data;
325
326         usb_fill_bulk_urb(entry_priv->urb, usb_dev,
327                           usb_rcvbulkpipe(usb_dev, 1),
328                           entry->skb->data, entry->skb->len,
329                           rt2x00usb_interrupt_rxdone, entry);
330
331         __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
332         usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
333 }
334 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
335
336 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
337                             struct queue_entry *entry)
338 {
339         entry->flags = 0;
340 }
341 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
342
343 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
344                                struct data_queue *queue)
345 {
346         struct queue_entry_priv_usb *entry_priv;
347         struct queue_entry_priv_usb_bcn *bcn_priv;
348         unsigned int i;
349
350         for (i = 0; i < queue->limit; i++) {
351                 entry_priv = queue->entries[i].priv_data;
352                 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
353                 if (!entry_priv->urb)
354                         return -ENOMEM;
355         }
356
357         /*
358          * If this is not the beacon queue or
359          * no guardian byte was required for the beacon,
360          * then we are done.
361          */
362         if (rt2x00dev->bcn != queue ||
363             !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
364                 return 0;
365
366         for (i = 0; i < queue->limit; i++) {
367                 bcn_priv = queue->entries[i].priv_data;
368                 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
369                 if (!bcn_priv->guardian_urb)
370                         return -ENOMEM;
371         }
372
373         return 0;
374 }
375
376 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
377                                struct data_queue *queue)
378 {
379         struct queue_entry_priv_usb *entry_priv;
380         struct queue_entry_priv_usb_bcn *bcn_priv;
381         unsigned int i;
382
383         if (!queue->entries)
384                 return;
385
386         for (i = 0; i < queue->limit; i++) {
387                 entry_priv = queue->entries[i].priv_data;
388                 usb_kill_urb(entry_priv->urb);
389                 usb_free_urb(entry_priv->urb);
390         }
391
392         /*
393          * If this is not the beacon queue or
394          * no guardian byte was required for the beacon,
395          * then we are done.
396          */
397         if (rt2x00dev->bcn != queue ||
398             !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
399                 return;
400
401         for (i = 0; i < queue->limit; i++) {
402                 bcn_priv = queue->entries[i].priv_data;
403                 usb_kill_urb(bcn_priv->guardian_urb);
404                 usb_free_urb(bcn_priv->guardian_urb);
405         }
406 }
407
408 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
409 {
410         struct data_queue *queue;
411         int status;
412
413         /*
414          * Allocate DMA
415          */
416         queue_for_each(rt2x00dev, queue) {
417                 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
418                 if (status)
419                         goto exit;
420         }
421
422         return 0;
423
424 exit:
425         rt2x00usb_uninitialize(rt2x00dev);
426
427         return status;
428 }
429 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
430
431 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
432 {
433         struct data_queue *queue;
434
435         queue_for_each(rt2x00dev, queue)
436                 rt2x00usb_free_urb(rt2x00dev, queue);
437 }
438 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
439
440 /*
441  * USB driver handlers.
442  */
443 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
444 {
445         kfree(rt2x00dev->rf);
446         rt2x00dev->rf = NULL;
447
448         kfree(rt2x00dev->eeprom);
449         rt2x00dev->eeprom = NULL;
450
451         kfree(rt2x00dev->csr.cache);
452         rt2x00dev->csr.cache = NULL;
453 }
454
455 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
456 {
457         rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
458         if (!rt2x00dev->csr.cache)
459                 goto exit;
460
461         rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
462         if (!rt2x00dev->eeprom)
463                 goto exit;
464
465         rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
466         if (!rt2x00dev->rf)
467                 goto exit;
468
469         return 0;
470
471 exit:
472         ERROR_PROBE("Failed to allocate registers.\n");
473
474         rt2x00usb_free_reg(rt2x00dev);
475
476         return -ENOMEM;
477 }
478
479 int rt2x00usb_probe(struct usb_interface *usb_intf,
480                     const struct usb_device_id *id)
481 {
482         struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
483         struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
484         struct ieee80211_hw *hw;
485         struct rt2x00_dev *rt2x00dev;
486         int retval;
487
488         usb_dev = usb_get_dev(usb_dev);
489
490         hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
491         if (!hw) {
492                 ERROR_PROBE("Failed to allocate hardware.\n");
493                 retval = -ENOMEM;
494                 goto exit_put_device;
495         }
496
497         usb_set_intfdata(usb_intf, hw);
498
499         rt2x00dev = hw->priv;
500         rt2x00dev->dev = &usb_intf->dev;
501         rt2x00dev->ops = ops;
502         rt2x00dev->hw = hw;
503         mutex_init(&rt2x00dev->usb_cache_mutex);
504
505         rt2x00dev->usb_maxpacket =
506             usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
507         if (!rt2x00dev->usb_maxpacket)
508                 rt2x00dev->usb_maxpacket = 1;
509
510         retval = rt2x00usb_alloc_reg(rt2x00dev);
511         if (retval)
512                 goto exit_free_device;
513
514         retval = rt2x00lib_probe_dev(rt2x00dev);
515         if (retval)
516                 goto exit_free_reg;
517
518         return 0;
519
520 exit_free_reg:
521         rt2x00usb_free_reg(rt2x00dev);
522
523 exit_free_device:
524         ieee80211_free_hw(hw);
525
526 exit_put_device:
527         usb_put_dev(usb_dev);
528
529         usb_set_intfdata(usb_intf, NULL);
530
531         return retval;
532 }
533 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
534
535 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
536 {
537         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
538         struct rt2x00_dev *rt2x00dev = hw->priv;
539
540         /*
541          * Free all allocated data.
542          */
543         rt2x00lib_remove_dev(rt2x00dev);
544         rt2x00usb_free_reg(rt2x00dev);
545         ieee80211_free_hw(hw);
546
547         /*
548          * Free the USB device data.
549          */
550         usb_set_intfdata(usb_intf, NULL);
551         usb_put_dev(interface_to_usbdev(usb_intf));
552 }
553 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
554
555 #ifdef CONFIG_PM
556 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
557 {
558         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
559         struct rt2x00_dev *rt2x00dev = hw->priv;
560         int retval;
561
562         retval = rt2x00lib_suspend(rt2x00dev, state);
563         if (retval)
564                 return retval;
565
566         rt2x00usb_free_reg(rt2x00dev);
567
568         /*
569          * Decrease usbdev refcount.
570          */
571         usb_put_dev(interface_to_usbdev(usb_intf));
572
573         return 0;
574 }
575 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
576
577 int rt2x00usb_resume(struct usb_interface *usb_intf)
578 {
579         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
580         struct rt2x00_dev *rt2x00dev = hw->priv;
581         int retval;
582
583         usb_get_dev(interface_to_usbdev(usb_intf));
584
585         retval = rt2x00usb_alloc_reg(rt2x00dev);
586         if (retval)
587                 return retval;
588
589         retval = rt2x00lib_resume(rt2x00dev);
590         if (retval)
591                 goto exit_free_reg;
592
593         return 0;
594
595 exit_free_reg:
596         rt2x00usb_free_reg(rt2x00dev);
597
598         return retval;
599 }
600 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
601 #endif /* CONFIG_PM */
602
603 /*
604  * rt2x00usb module information.
605  */
606 MODULE_AUTHOR(DRV_PROJECT);
607 MODULE_VERSION(DRV_VERSION);
608 MODULE_DESCRIPTION("rt2x00 usb library");
609 MODULE_LICENSE("GPL");