2 Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
3 <http://rt2x00.serialmonkey.com>
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.
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.
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.
23 Abstract: rt2x00 generic usb device routines.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/usb.h>
29 #include <linux/bug.h>
32 #include "rt2x00usb.h"
35 * Interfacing with the HW.
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,
43 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
47 (requesttype == USB_VENDOR_REQUEST_IN) ?
48 usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
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,
60 * -ENODEV: Device has disappeared, no point continuing.
61 * All other errors: Try again.
63 else if (status == -ENODEV)
68 "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
69 request, offset, status);
73 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
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)
82 BUG_ON(!mutex_is_locked(&rt2x00dev->usb_cache_mutex));
85 * Check for Cache availability.
87 if (unlikely(!rt2x00dev->csr.cache || buffer_length > CSR_CACHE_SIZE)) {
88 ERROR(rt2x00dev, "CSR cache not available.\n");
92 if (requesttype == USB_VENDOR_REQUEST_OUT)
93 memcpy(rt2x00dev->csr.cache, buffer, buffer_length);
95 status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
96 offset, 0, rt2x00dev->csr.cache,
97 buffer_length, timeout);
99 if (!status && requesttype == USB_VENDOR_REQUEST_IN)
100 memcpy(buffer, rt2x00dev->csr.cache, buffer_length);
104 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock);
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)
113 mutex_lock(&rt2x00dev->usb_cache_mutex);
115 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
116 requesttype, offset, buffer,
117 buffer_length, timeout);
119 mutex_unlock(&rt2x00dev->usb_cache_mutex);
123 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
128 static void rt2x00usb_interrupt_txdone(struct urb *urb)
130 struct queue_entry *entry = (struct queue_entry *)urb->context;
131 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
132 struct queue_entry_priv_usb_tx *priv_tx = entry->priv_data;
133 struct txdone_entry_desc txdesc;
134 __le32 *txd = (__le32 *)entry->skb->data;
137 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
138 !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
141 rt2x00_desc_read(txd, 0, &word);
144 * Remove the descriptor data from the buffer.
146 skb_pull(entry->skb, entry->queue->desc_size);
149 * Obtain the status about this packet.
151 txdesc.status = !urb->status ? TX_SUCCESS : TX_FAIL_RETRY;
153 txdesc.control = &priv_tx->control;
155 rt2x00lib_txdone(entry, &txdesc);
158 * Make this entry available for reuse.
161 rt2x00queue_index_inc(entry->queue, Q_INDEX_DONE);
164 * If the data queue was full before the txdone handler
165 * we must make sure the packet queue in the mac80211 stack
166 * is reenabled when the txdone handler has finished.
168 if (!rt2x00queue_full(entry->queue))
169 ieee80211_wake_queue(rt2x00dev->hw, priv_tx->control.queue);
172 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
173 struct data_queue *queue, struct sk_buff *skb,
174 struct ieee80211_tx_control *control)
176 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
177 struct queue_entry *entry = rt2x00queue_get_entry(queue, Q_INDEX);
178 struct queue_entry_priv_usb_tx *priv_tx = entry->priv_data;
179 struct skb_frame_desc *skbdesc;
182 if (rt2x00queue_full(queue))
185 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags)) {
187 "Arrived at non-free entry in the non-full queue %d.\n"
188 "Please file bug report to %s.\n",
189 control->queue, DRV_PROJECT);
194 * Add the descriptor in front of the skb.
196 skb_push(skb, queue->desc_size);
197 memset(skb->data, 0, queue->desc_size);
200 * Fill in skb descriptor
202 skbdesc = get_skb_frame_desc(skb);
203 skbdesc->data = skb->data + queue->desc_size;
204 skbdesc->data_len = skb->len - queue->desc_size;
205 skbdesc->desc = skb->data;
206 skbdesc->desc_len = queue->desc_size;
207 skbdesc->entry = entry;
209 rt2x00lib_write_tx_desc(rt2x00dev, skb, control);
212 * USB devices cannot blindly pass the skb->len as the
213 * length of the data to usb_fill_bulk_urb. Pass the skb
214 * to the driver to determine what the length should be.
216 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
219 * Initialize URB and send the frame to the device.
221 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
222 usb_fill_bulk_urb(priv_tx->urb, usb_dev, usb_sndbulkpipe(usb_dev, 1),
223 skb->data, length, rt2x00usb_interrupt_txdone, entry);
224 usb_submit_urb(priv_tx->urb, GFP_ATOMIC);
226 rt2x00queue_index_inc(queue, Q_INDEX);
230 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
235 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
238 unsigned int frame_size;
241 * As alignment we use 2 and not NET_IP_ALIGN because we need
242 * to be sure we have 2 bytes room in the head. (NET_IP_ALIGN
243 * can be 0 on some hardware). We use these 2 bytes for frame
244 * alignment later, we assume that the chance that
245 * header_size % 4 == 2 is bigger then header_size % 2 == 0
246 * and thus optimize alignment by reserving the 2 bytes in
249 frame_size = queue->data_size + queue->desc_size;
250 skb = dev_alloc_skb(queue->desc_size + frame_size + 2);
254 skb_reserve(skb, queue->desc_size + 2);
255 skb_put(skb, frame_size);
260 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
262 struct queue_entry *entry = (struct queue_entry *)urb->context;
263 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
265 struct skb_frame_desc *skbdesc;
266 struct rxdone_entry_desc rxdesc;
269 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
270 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
274 * Check if the received data is simply too small
275 * to be actually valid, or if the urb is signaling
278 if (urb->actual_length < entry->queue->desc_size || urb->status)
282 * Fill in skb descriptor
284 skbdesc = get_skb_frame_desc(entry->skb);
285 memset(skbdesc, 0, sizeof(*skbdesc));
286 skbdesc->entry = entry;
288 memset(&rxdesc, 0, sizeof(rxdesc));
289 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
292 * The data behind the ieee80211 header must be
293 * aligned on a 4 byte boundary.
295 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
296 if (header_size % 4 == 0) {
297 skb_push(entry->skb, 2);
298 memmove(entry->skb->data, entry->skb->data + 2,
299 entry->skb->len - 2);
300 skbdesc->data = entry->skb->data;
304 * Allocate a new sk buffer to replace the current one.
305 * If allocation fails, we should drop the current frame
306 * so we can recycle the existing sk buffer for the new frame.
308 skb = rt2x00usb_alloc_rxskb(entry->queue);
313 * Send the frame to rt2x00lib for further processing.
315 rt2x00lib_rxdone(entry, &rxdesc);
318 * Replace current entry's skb with the newly allocated one,
319 * and reinitialize the urb.
322 urb->transfer_buffer = entry->skb->data;
323 urb->transfer_buffer_length = entry->skb->len;
326 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
327 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
328 usb_submit_urb(urb, GFP_ATOMIC);
331 rt2x00queue_index_inc(entry->queue, Q_INDEX);
337 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
339 struct queue_entry_priv_usb_rx *priv_rx;
340 struct queue_entry_priv_usb_tx *priv_tx;
341 struct queue_entry_priv_usb_bcn *priv_bcn;
342 struct data_queue *queue;
345 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0x0000, 0x0000,
351 for (i = 0; i < rt2x00dev->rx->limit; i++) {
352 priv_rx = rt2x00dev->rx->entries[i].priv_data;
353 usb_kill_urb(priv_rx->urb);
356 tx_queue_for_each(rt2x00dev, queue) {
357 for (i = 0; i < queue->limit; i++) {
358 priv_tx = queue->entries[i].priv_data;
359 usb_kill_urb(priv_tx->urb);
363 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
364 priv_bcn = rt2x00dev->bcn->entries[i].priv_data;
365 usb_kill_urb(priv_bcn->urb);
367 if (priv_bcn->guardian_urb)
368 usb_kill_urb(priv_bcn->guardian_urb);
371 if (!test_bit(DRIVER_REQUIRE_ATIM_QUEUE, &rt2x00dev->flags))
374 for (i = 0; i < rt2x00dev->bcn[1].limit; i++) {
375 priv_tx = rt2x00dev->bcn[1].entries[i].priv_data;
376 usb_kill_urb(priv_tx->urb);
379 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
382 * Device initialization handlers.
384 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
385 struct queue_entry *entry)
387 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
388 struct queue_entry_priv_usb_rx *priv_rx = entry->priv_data;
390 usb_fill_bulk_urb(priv_rx->urb, usb_dev,
391 usb_rcvbulkpipe(usb_dev, 1),
392 entry->skb->data, entry->skb->len,
393 rt2x00usb_interrupt_rxdone, entry);
395 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
396 usb_submit_urb(priv_rx->urb, GFP_ATOMIC);
398 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
400 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
401 struct queue_entry *entry)
405 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
407 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
408 struct data_queue *queue)
410 struct queue_entry_priv_usb_rx *priv_rx;
411 struct queue_entry_priv_usb_tx *priv_tx;
412 struct queue_entry_priv_usb_bcn *priv_bcn;
414 unsigned int guardian =
415 test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags);
421 for (i = 0; i < queue->limit; i++) {
422 urb = usb_alloc_urb(0, GFP_KERNEL);
426 if (queue->qid == QID_RX) {
427 priv_rx = queue->entries[i].priv_data;
429 } else if (queue->qid == QID_MGMT && guardian) {
430 priv_bcn = queue->entries[i].priv_data;
433 urb = usb_alloc_urb(0, GFP_KERNEL);
437 priv_bcn->guardian_urb = urb;
439 priv_tx = queue->entries[i].priv_data;
447 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
448 struct data_queue *queue)
450 struct queue_entry_priv_usb_rx *priv_rx;
451 struct queue_entry_priv_usb_tx *priv_tx;
452 struct queue_entry_priv_usb_bcn *priv_bcn;
454 unsigned int guardian =
455 test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags);
461 for (i = 0; i < queue->limit; i++) {
462 if (queue->qid == QID_RX) {
463 priv_rx = queue->entries[i].priv_data;
465 } else if (queue->qid == QID_MGMT && guardian) {
466 priv_bcn = queue->entries[i].priv_data;
468 usb_kill_urb(priv_bcn->guardian_urb);
469 usb_free_urb(priv_bcn->guardian_urb);
473 priv_tx = queue->entries[i].priv_data;
479 if (queue->entries[i].skb)
480 kfree_skb(queue->entries[i].skb);
484 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
486 struct data_queue *queue;
488 unsigned int entry_size;
490 int uninitialized_var(status);
495 queue_for_each(rt2x00dev, queue) {
496 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
502 * For the RX queue, skb's should be allocated.
504 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
505 for (i = 0; i < rt2x00dev->rx->limit; i++) {
506 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
510 rt2x00dev->rx->entries[i].skb = skb;
516 rt2x00usb_uninitialize(rt2x00dev);
520 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
522 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
524 struct data_queue *queue;
526 queue_for_each(rt2x00dev, queue)
527 rt2x00usb_free_urb(rt2x00dev, queue);
529 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
532 * USB driver handlers.
534 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
536 kfree(rt2x00dev->rf);
537 rt2x00dev->rf = NULL;
539 kfree(rt2x00dev->eeprom);
540 rt2x00dev->eeprom = NULL;
542 kfree(rt2x00dev->csr.cache);
543 rt2x00dev->csr.cache = NULL;
546 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
548 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
549 if (!rt2x00dev->csr.cache)
552 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
553 if (!rt2x00dev->eeprom)
556 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
563 ERROR_PROBE("Failed to allocate registers.\n");
565 rt2x00usb_free_reg(rt2x00dev);
570 int rt2x00usb_probe(struct usb_interface *usb_intf,
571 const struct usb_device_id *id)
573 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
574 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
575 struct ieee80211_hw *hw;
576 struct rt2x00_dev *rt2x00dev;
579 usb_dev = usb_get_dev(usb_dev);
581 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
583 ERROR_PROBE("Failed to allocate hardware.\n");
585 goto exit_put_device;
588 usb_set_intfdata(usb_intf, hw);
590 rt2x00dev = hw->priv;
591 rt2x00dev->dev = usb_intf;
592 rt2x00dev->ops = ops;
594 mutex_init(&rt2x00dev->usb_cache_mutex);
596 rt2x00dev->usb_maxpacket =
597 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
598 if (!rt2x00dev->usb_maxpacket)
599 rt2x00dev->usb_maxpacket = 1;
601 retval = rt2x00usb_alloc_reg(rt2x00dev);
603 goto exit_free_device;
605 retval = rt2x00lib_probe_dev(rt2x00dev);
612 rt2x00usb_free_reg(rt2x00dev);
615 ieee80211_free_hw(hw);
618 usb_put_dev(usb_dev);
620 usb_set_intfdata(usb_intf, NULL);
624 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
626 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
628 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
629 struct rt2x00_dev *rt2x00dev = hw->priv;
632 * Free all allocated data.
634 rt2x00lib_remove_dev(rt2x00dev);
635 rt2x00usb_free_reg(rt2x00dev);
636 ieee80211_free_hw(hw);
639 * Free the USB device data.
641 usb_set_intfdata(usb_intf, NULL);
642 usb_put_dev(interface_to_usbdev(usb_intf));
644 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
647 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
649 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
650 struct rt2x00_dev *rt2x00dev = hw->priv;
653 retval = rt2x00lib_suspend(rt2x00dev, state);
657 rt2x00usb_free_reg(rt2x00dev);
660 * Decrease usbdev refcount.
662 usb_put_dev(interface_to_usbdev(usb_intf));
666 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
668 int rt2x00usb_resume(struct usb_interface *usb_intf)
670 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
671 struct rt2x00_dev *rt2x00dev = hw->priv;
674 usb_get_dev(interface_to_usbdev(usb_intf));
676 retval = rt2x00usb_alloc_reg(rt2x00dev);
680 retval = rt2x00lib_resume(rt2x00dev);
687 rt2x00usb_free_reg(rt2x00dev);
691 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
692 #endif /* CONFIG_PM */
695 * rt2x00usb module information.
697 MODULE_AUTHOR(DRV_PROJECT);
698 MODULE_VERSION(DRV_VERSION);
699 MODULE_DESCRIPTION("rt2x00 usb library");
700 MODULE_LICENSE("GPL");