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