8d2081189025723a9aad475d58997f3f7512bcc3
[safe/jmp/linux-2.6] / drivers / net / wireless / rt2x00 / rt2x00usb.c
1 /*
2         Copyright (C) 2004 - 2007 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 /*
27  * Set enviroment defines for rt2x00.h
28  */
29 #define DRV_NAME "rt2x00usb"
30
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/usb.h>
34
35 #include "rt2x00.h"
36 #include "rt2x00usb.h"
37
38 /*
39  * Interfacing with the HW.
40  */
41 int rt2x00usb_vendor_request(const struct rt2x00_dev *rt2x00dev,
42                              const u8 request, const u8 requesttype,
43                              const u16 offset, const u16 value,
44                              void *buffer, const u16 buffer_length,
45                              u16 timeout)
46 {
47         struct usb_device *usb_dev =
48             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
49         int status;
50         unsigned int i;
51         unsigned int pipe =
52             (requesttype == USB_VENDOR_REQUEST_IN) ?
53             usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
54
55         for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
56                 status = usb_control_msg(usb_dev, pipe, request, requesttype,
57                                          value, offset, buffer, buffer_length,
58                                          timeout);
59                 if (status >= 0)
60                         return 0;
61
62                 /*
63                  * Check for errors,
64                  * -ETIMEDOUT: We need a bit more time to complete.
65                  * -ENODEV: Device has disappeared, no point continuing.
66                  */
67                 if (status == -ETIMEDOUT)
68                         timeout *= 2;
69                 else if (status == -ENODEV)
70                         break;
71         }
72
73         ERROR(rt2x00dev,
74               "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
75               request, offset, status);
76
77         return status;
78 }
79 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
80
81 int rt2x00usb_vendor_request_buff(const struct rt2x00_dev *rt2x00dev,
82                                   const u8 request, const u8 requesttype,
83                                   const u16 offset, void *buffer,
84                                   const u16 buffer_length, u16 timeout)
85 {
86         int status;
87
88         /*
89          * Check for Cache availability.
90          */
91         if (unlikely(!rt2x00dev->csr_cache || buffer_length > CSR_CACHE_SIZE)) {
92                 ERROR(rt2x00dev, "CSR cache not available.\n");
93                 return -ENOMEM;
94         }
95
96         if (requesttype == USB_VENDOR_REQUEST_OUT)
97                 memcpy(rt2x00dev->csr_cache, buffer, buffer_length);
98
99         status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
100                                           offset, 0, rt2x00dev->csr_cache,
101                                           buffer_length, timeout);
102
103         if (!status && requesttype == USB_VENDOR_REQUEST_IN)
104                 memcpy(buffer, rt2x00dev->csr_cache, buffer_length);
105
106         return status;
107 }
108 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
109
110 /*
111  * TX data handlers.
112  */
113 static void rt2x00usb_interrupt_txdone(struct urb *urb)
114 {
115         struct data_entry *entry = (struct data_entry *)urb->context;
116         struct data_ring *ring = entry->ring;
117         struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
118         struct data_desc *txd = (struct data_desc *)entry->skb->data;
119         u32 word;
120         int tx_status;
121
122         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
123             !__test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
124                 return;
125
126         rt2x00_desc_read(txd, 0, &word);
127
128         /*
129          * Remove the descriptor data from the buffer.
130          */
131         skb_pull(entry->skb, ring->desc_size);
132
133         /*
134          * Obtain the status about this packet.
135          */
136         tx_status = !urb->status ? TX_SUCCESS : TX_FAIL_RETRY;
137
138         rt2x00lib_txdone(entry, tx_status, 0);
139
140         /*
141          * Make this entry available for reuse.
142          */
143         entry->flags = 0;
144         rt2x00_ring_index_done_inc(entry->ring);
145
146         /*
147          * If the data ring was full before the txdone handler
148          * we must make sure the packet queue in the mac80211 stack
149          * is reenabled when the txdone handler has finished.
150          */
151         if (!rt2x00_ring_full(ring))
152                 ieee80211_wake_queue(rt2x00dev->hw,
153                                      entry->tx_status.control.queue);
154 }
155
156 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
157                             struct data_ring *ring, struct sk_buff *skb,
158                             struct ieee80211_tx_control *control)
159 {
160         struct usb_device *usb_dev =
161             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
162         struct ieee80211_hdr *ieee80211hdr = (struct ieee80211_hdr *)skb->data;
163         struct data_entry *entry = rt2x00_get_data_entry(ring);
164         u32 length = skb->len;
165
166         if (rt2x00_ring_full(ring)) {
167                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
168                 return -EINVAL;
169         }
170
171         if (test_bit(ENTRY_OWNER_NIC, &entry->flags)) {
172                 ERROR(rt2x00dev,
173                       "Arrived at non-free entry in the non-full queue %d.\n"
174                       "Please file bug report to %s.\n",
175                       control->queue, DRV_PROJECT);
176                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
177                 return -EINVAL;
178         }
179
180         /*
181          * Add the descriptor in front of the skb.
182          */
183         skb_push(skb, rt2x00dev->hw->extra_tx_headroom);
184         memset(skb->data, 0x00, rt2x00dev->hw->extra_tx_headroom);
185
186         rt2x00lib_write_tx_desc(rt2x00dev, (struct data_desc *)skb->data,
187                                 ieee80211hdr, length, control);
188         memcpy(&entry->tx_status.control, control, sizeof(*control));
189         entry->skb = skb;
190
191         /*
192          * Length passed to usb_fill_urb cannot be an odd number,
193          * so add 1 byte to make it even.
194          */
195         length += rt2x00dev->hw->extra_tx_headroom;
196         if (length % 2)
197                 length++;
198
199         __set_bit(ENTRY_OWNER_NIC, &entry->flags);
200         usb_fill_bulk_urb(entry->priv, usb_dev,
201                           usb_sndbulkpipe(usb_dev, 1),
202                           skb->data, length, rt2x00usb_interrupt_txdone, entry);
203         usb_submit_urb(entry->priv, GFP_ATOMIC);
204
205         rt2x00_ring_index_inc(ring);
206
207         if (rt2x00_ring_full(ring))
208                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
209
210         return 0;
211 }
212 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
213
214 /*
215  * RX data handlers.
216  */
217 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
218 {
219         struct data_entry *entry = (struct data_entry *)urb->context;
220         struct data_ring *ring = entry->ring;
221         struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
222         struct sk_buff *skb;
223         struct rxdata_entry_desc desc;
224         int frame_size;
225
226         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
227             !test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
228                 return;
229
230         /*
231          * Check if the received data is simply too small
232          * to be actually valid, or if the urb is signaling
233          * a problem.
234          */
235         if (urb->actual_length < entry->ring->desc_size || urb->status)
236                 goto skip_entry;
237
238         memset(&desc, 0x00, sizeof(desc));
239         rt2x00dev->ops->lib->fill_rxdone(entry, &desc);
240
241         /*
242          * Allocate a new sk buffer to replace the current one.
243          * If allocation fails, we should drop the current frame
244          * so we can recycle the existing sk buffer for the new frame.
245          */
246         frame_size = entry->ring->data_size + entry->ring->desc_size;
247         skb = dev_alloc_skb(frame_size + NET_IP_ALIGN);
248         if (!skb)
249                 goto skip_entry;
250
251         skb_reserve(skb, NET_IP_ALIGN);
252         skb_put(skb, frame_size);
253
254         /*
255          * Trim the skb_buffer to only contain the valid
256          * frame data (so ignore the device's descriptor).
257          */
258         skb_trim(entry->skb, desc.size);
259
260         /*
261          * Send the frame to rt2x00lib for further processing.
262          */
263         rt2x00lib_rxdone(entry, entry->skb, &desc);
264
265         /*
266          * Replace current entry's skb with the newly allocated one,
267          * and reinitialize the urb.
268          */
269         entry->skb = skb;
270         urb->transfer_buffer = entry->skb->data;
271         urb->transfer_buffer_length = entry->skb->len;
272
273 skip_entry:
274         if (test_bit(DEVICE_ENABLED_RADIO, &ring->rt2x00dev->flags)) {
275                 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
276                 usb_submit_urb(urb, GFP_ATOMIC);
277         }
278
279         rt2x00_ring_index_inc(ring);
280 }
281
282 /*
283  * Radio handlers
284  */
285 void rt2x00usb_enable_radio(struct rt2x00_dev *rt2x00dev)
286 {
287         struct usb_device *usb_dev =
288             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
289         struct data_ring *ring;
290         struct data_entry *entry;
291         unsigned int i;
292
293         /*
294          * Initialize the TX rings
295          */
296         txringall_for_each(rt2x00dev, ring) {
297                 for (i = 0; i < ring->stats.limit; i++)
298                         ring->entry[i].flags = 0;
299
300                 rt2x00_ring_index_clear(ring);
301         }
302
303         /*
304          * Initialize and start the RX ring.
305          */
306         rt2x00_ring_index_clear(rt2x00dev->rx);
307
308         for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
309                 entry = &rt2x00dev->rx->entry[i];
310
311                 usb_fill_bulk_urb(entry->priv, usb_dev,
312                                   usb_rcvbulkpipe(usb_dev, 1),
313                                   entry->skb->data, entry->skb->len,
314                                   rt2x00usb_interrupt_rxdone, entry);
315
316                 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
317                 usb_submit_urb(entry->priv, GFP_ATOMIC);
318         }
319 }
320 EXPORT_SYMBOL_GPL(rt2x00usb_enable_radio);
321
322 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
323 {
324         struct data_ring *ring;
325         unsigned int i;
326
327         rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0x0000, 0x0000,
328                                     REGISTER_TIMEOUT);
329
330         /*
331          * Cancel all rings.
332          */
333         ring_for_each(rt2x00dev, ring) {
334                 for (i = 0; i < ring->stats.limit; i++)
335                         usb_kill_urb(ring->entry[i].priv);
336         }
337 }
338 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
339
340 /*
341  * Device initialization handlers.
342  */
343 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
344                                struct data_ring *ring)
345 {
346         unsigned int i;
347
348         /*
349          * Allocate the URB's
350          */
351         for (i = 0; i < ring->stats.limit; i++) {
352                 ring->entry[i].priv = usb_alloc_urb(0, GFP_KERNEL);
353                 if (!ring->entry[i].priv)
354                         return -ENOMEM;
355         }
356
357         return 0;
358 }
359
360 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
361                                struct data_ring *ring)
362 {
363         unsigned int i;
364
365         if (!ring->entry)
366                 return;
367
368         for (i = 0; i < ring->stats.limit; i++) {
369                 usb_kill_urb(ring->entry[i].priv);
370                 usb_free_urb(ring->entry[i].priv);
371                 if (ring->entry[i].skb)
372                         kfree_skb(ring->entry[i].skb);
373         }
374 }
375
376 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
377 {
378         struct data_ring *ring;
379         struct sk_buff *skb;
380         unsigned int entry_size;
381         unsigned int i;
382         int status;
383
384         /*
385          * Allocate DMA
386          */
387         ring_for_each(rt2x00dev, ring) {
388                 status = rt2x00usb_alloc_urb(rt2x00dev, ring);
389                 if (status)
390                         goto exit;
391         }
392
393         /*
394          * For the RX ring, skb's should be allocated.
395          */
396         entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
397         for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
398                 skb = dev_alloc_skb(NET_IP_ALIGN + entry_size);
399                 if (!skb)
400                         goto exit;
401
402                 skb_reserve(skb, NET_IP_ALIGN);
403                 skb_put(skb, entry_size);
404
405                 rt2x00dev->rx->entry[i].skb = skb;
406         }
407
408         return 0;
409
410 exit:
411         rt2x00usb_uninitialize(rt2x00dev);
412
413         return status;
414 }
415 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
416
417 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
418 {
419         struct data_ring *ring;
420
421         ring_for_each(rt2x00dev, ring)
422                 rt2x00usb_free_urb(rt2x00dev, ring);
423 }
424 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
425
426 /*
427  * USB driver handlers.
428  */
429 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
430 {
431         kfree(rt2x00dev->rf);
432         rt2x00dev->rf = NULL;
433
434         kfree(rt2x00dev->eeprom);
435         rt2x00dev->eeprom = NULL;
436
437         kfree(rt2x00dev->csr_cache);
438         rt2x00dev->csr_cache = NULL;
439 }
440
441 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
442 {
443         rt2x00dev->csr_cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
444         if (!rt2x00dev->csr_cache)
445                 goto exit;
446
447         rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
448         if (!rt2x00dev->eeprom)
449                 goto exit;
450
451         rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
452         if (!rt2x00dev->rf)
453                 goto exit;
454
455         return 0;
456
457 exit:
458         ERROR_PROBE("Failed to allocate registers.\n");
459
460         rt2x00usb_free_reg(rt2x00dev);
461
462         return -ENOMEM;
463 }
464
465 int rt2x00usb_probe(struct usb_interface *usb_intf,
466                     const struct usb_device_id *id)
467 {
468         struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
469         struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
470         struct ieee80211_hw *hw;
471         struct rt2x00_dev *rt2x00dev;
472         int retval;
473
474         usb_dev = usb_get_dev(usb_dev);
475
476         hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
477         if (!hw) {
478                 ERROR_PROBE("Failed to allocate hardware.\n");
479                 retval = -ENOMEM;
480                 goto exit_put_device;
481         }
482
483         usb_set_intfdata(usb_intf, hw);
484
485         rt2x00dev = hw->priv;
486         rt2x00dev->dev = usb_intf;
487         rt2x00dev->ops = ops;
488         rt2x00dev->hw = hw;
489
490         retval = rt2x00usb_alloc_reg(rt2x00dev);
491         if (retval)
492                 goto exit_free_device;
493
494         retval = rt2x00lib_probe_dev(rt2x00dev);
495         if (retval)
496                 goto exit_free_reg;
497
498         return 0;
499
500 exit_free_reg:
501         rt2x00usb_free_reg(rt2x00dev);
502
503 exit_free_device:
504         ieee80211_free_hw(hw);
505
506 exit_put_device:
507         usb_put_dev(usb_dev);
508
509         usb_set_intfdata(usb_intf, NULL);
510
511         return retval;
512 }
513 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
514
515 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
516 {
517         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
518         struct rt2x00_dev *rt2x00dev = hw->priv;
519
520         /*
521          * Free all allocated data.
522          */
523         rt2x00lib_remove_dev(rt2x00dev);
524         rt2x00usb_free_reg(rt2x00dev);
525         ieee80211_free_hw(hw);
526
527         /*
528          * Free the USB device data.
529          */
530         usb_set_intfdata(usb_intf, NULL);
531         usb_put_dev(interface_to_usbdev(usb_intf));
532 }
533 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
534
535 #ifdef CONFIG_PM
536 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
537 {
538         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
539         struct rt2x00_dev *rt2x00dev = hw->priv;
540         int retval;
541
542         retval = rt2x00lib_suspend(rt2x00dev, state);
543         if (retval)
544                 return retval;
545
546         rt2x00usb_free_reg(rt2x00dev);
547
548         /*
549          * Decrease usbdev refcount.
550          */
551         usb_put_dev(interface_to_usbdev(usb_intf));
552
553         return 0;
554 }
555 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
556
557 int rt2x00usb_resume(struct usb_interface *usb_intf)
558 {
559         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
560         struct rt2x00_dev *rt2x00dev = hw->priv;
561         int retval;
562
563         usb_get_dev(interface_to_usbdev(usb_intf));
564
565         retval = rt2x00usb_alloc_reg(rt2x00dev);
566         if (retval)
567                 return retval;
568
569         retval = rt2x00lib_resume(rt2x00dev);
570         if (retval)
571                 goto exit_free_reg;
572
573         return 0;
574
575 exit_free_reg:
576         rt2x00usb_free_reg(rt2x00dev);
577
578         return retval;
579 }
580 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
581 #endif /* CONFIG_PM */
582
583 /*
584  * rt2x00pci module information.
585  */
586 MODULE_AUTHOR(DRV_PROJECT);
587 MODULE_VERSION(DRV_VERSION);
588 MODULE_DESCRIPTION("rt2x00 library");
589 MODULE_LICENSE("GPL");