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 txdone_entry_desc txdesc;
133 enum data_queue_qid qid = skb_get_queue_mapping(entry->skb);
135 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
136 !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
140 * Remove the descriptor data from the buffer.
142 skb_pull(entry->skb, entry->queue->desc_size);
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
154 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
156 __set_bit(TXDONE_FAILURE, &txdesc.flags);
159 rt2x00lib_txdone(entry, &txdesc);
162 * Make this entry available for reuse.
165 rt2x00queue_index_inc(entry->queue, Q_INDEX_DONE);
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.
172 if (!rt2x00queue_threshold(entry->queue))
173 ieee80211_wake_queue(rt2x00dev->hw, qid);
176 int rt2x00usb_write_tx_data(struct queue_entry *entry)
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;
185 * Add the descriptor in front of the skb.
187 skb_push(entry->skb, entry->queue->desc_size);
188 memset(entry->skb->data, 0, entry->queue->desc_size);
191 * Fill in skb descriptor
193 skbdesc = get_skb_frame_desc(entry->skb);
194 memset(skbdesc, 0, sizeof(*skbdesc));
195 skbdesc->data = entry->skb->data + entry->queue->desc_size;
196 skbdesc->data_len = entry->skb->len - entry->queue->desc_size;
197 skbdesc->desc = entry->skb->data;
198 skbdesc->desc_len = entry->queue->desc_size;
199 skbdesc->entry = entry;
202 * USB devices cannot blindly pass the skb->len as the
203 * length of the data to usb_fill_bulk_urb. Pass the skb
204 * to the driver to determine what the length should be.
206 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
208 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
209 usb_sndbulkpipe(usb_dev, 1),
210 entry->skb->data, length,
211 rt2x00usb_interrupt_txdone, entry);
215 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
217 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
219 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
221 if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
222 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
225 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
226 const enum data_queue_qid qid)
228 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
229 unsigned long irqflags;
231 unsigned int index_done;
235 * Only protect the range we are going to loop over,
236 * if during our loop a extra entry is set to pending
237 * it should not be kicked during this run, since it
238 * is part of another TX operation.
240 spin_lock_irqsave(&queue->lock, irqflags);
241 index = queue->index[Q_INDEX];
242 index_done = queue->index[Q_INDEX_DONE];
243 spin_unlock_irqrestore(&queue->lock, irqflags);
246 * Start from the TX done pointer, this guarentees that we will
247 * send out all frames in the correct order.
249 if (index_done < index) {
250 for (i = index_done; i < index; i++)
251 rt2x00usb_kick_tx_entry(&queue->entries[i]);
253 for (i = index_done; i < queue->limit; i++)
254 rt2x00usb_kick_tx_entry(&queue->entries[i]);
256 for (i = 0; i < index; i++)
257 rt2x00usb_kick_tx_entry(&queue->entries[i]);
260 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
265 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
268 unsigned int frame_size;
269 unsigned int reserved_size;
272 * The frame size includes descriptor size, because the
273 * hardware directly receive the frame into the skbuffer.
275 frame_size = queue->data_size + queue->desc_size;
278 * For the allocation we should keep a few things in mind:
279 * 1) 4byte alignment of 802.11 payload
281 * For (1) we need at most 4 bytes to guarentee the correct
282 * alignment. We are going to optimize the fact that the chance
283 * that the 802.11 header_size % 4 == 2 is much bigger then
284 * anything else. However since we need to move the frame up
285 * to 3 bytes to the front, which means we need to preallocate
293 skb = dev_alloc_skb(frame_size + reserved_size);
297 skb_reserve(skb, reserved_size);
298 skb_put(skb, frame_size);
303 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
305 struct queue_entry *entry = (struct queue_entry *)urb->context;
306 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
308 struct skb_frame_desc *skbdesc;
309 struct rxdone_entry_desc rxdesc;
310 unsigned int header_size;
313 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
314 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
318 * Check if the received data is simply too small
319 * to be actually valid, or if the urb is signaling
322 if (urb->actual_length < entry->queue->desc_size || urb->status)
326 * Fill in skb descriptor
328 skbdesc = get_skb_frame_desc(entry->skb);
329 memset(skbdesc, 0, sizeof(*skbdesc));
330 skbdesc->entry = entry;
332 memset(&rxdesc, 0, sizeof(rxdesc));
333 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
335 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
338 * The data behind the ieee80211 header must be
339 * aligned on a 4 byte boundary. We already reserved
340 * 2 bytes for header_size % 4 == 2 optimization.
341 * To determine the number of bytes which the data
342 * should be moved to the left, we must add these
343 * 2 bytes to the header_size.
345 align = (header_size + 2) % 4;
348 skb_push(entry->skb, align);
349 /* Move entire frame in 1 command */
350 memmove(entry->skb->data, entry->skb->data + align,
354 /* Update data pointers, trim buffer to correct size */
355 skbdesc->data = entry->skb->data;
356 skb_trim(entry->skb, rxdesc.size);
359 * Allocate a new sk buffer to replace the current one.
360 * If allocation fails, we should drop the current frame
361 * so we can recycle the existing sk buffer for the new frame.
363 skb = rt2x00usb_alloc_rxskb(entry->queue);
368 * Send the frame to rt2x00lib for further processing.
370 rt2x00lib_rxdone(entry, &rxdesc);
373 * Replace current entry's skb with the newly allocated one,
374 * and reinitialize the urb.
377 urb->transfer_buffer = entry->skb->data;
378 urb->transfer_buffer_length = entry->skb->len;
381 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
382 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
383 usb_submit_urb(urb, GFP_ATOMIC);
386 rt2x00queue_index_inc(entry->queue, Q_INDEX);
392 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
394 struct queue_entry_priv_usb *entry_priv;
395 struct queue_entry_priv_usb_bcn *bcn_priv;
398 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
404 for (i = 0; i < rt2x00dev->rx->limit; i++) {
405 entry_priv = rt2x00dev->rx->entries[i].priv_data;
406 usb_kill_urb(entry_priv->urb);
412 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
413 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
414 if (bcn_priv->guardian_urb)
415 usb_kill_urb(bcn_priv->guardian_urb);
418 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
421 * Device initialization handlers.
423 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
424 struct queue_entry *entry)
426 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
427 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
429 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
430 usb_rcvbulkpipe(usb_dev, 1),
431 entry->skb->data, entry->skb->len,
432 rt2x00usb_interrupt_rxdone, entry);
434 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
435 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
437 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
439 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
440 struct queue_entry *entry)
444 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
446 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
447 struct data_queue *queue)
449 struct queue_entry_priv_usb *entry_priv;
450 struct queue_entry_priv_usb_bcn *bcn_priv;
453 for (i = 0; i < queue->limit; i++) {
454 entry_priv = queue->entries[i].priv_data;
455 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
456 if (!entry_priv->urb)
461 * If this is not the beacon queue or
462 * no guardian byte was required for the beacon,
465 if (rt2x00dev->bcn != queue ||
466 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
469 for (i = 0; i < queue->limit; i++) {
470 bcn_priv = queue->entries[i].priv_data;
471 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
472 if (!bcn_priv->guardian_urb)
479 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
480 struct data_queue *queue)
482 struct queue_entry_priv_usb *entry_priv;
483 struct queue_entry_priv_usb_bcn *bcn_priv;
489 for (i = 0; i < queue->limit; i++) {
490 entry_priv = queue->entries[i].priv_data;
491 usb_kill_urb(entry_priv->urb);
492 usb_free_urb(entry_priv->urb);
493 if (queue->entries[i].skb)
494 kfree_skb(queue->entries[i].skb);
498 * If this is not the beacon queue or
499 * no guardian byte was required for the beacon,
502 if (rt2x00dev->bcn != queue ||
503 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
506 for (i = 0; i < queue->limit; i++) {
507 bcn_priv = queue->entries[i].priv_data;
508 usb_kill_urb(bcn_priv->guardian_urb);
509 usb_free_urb(bcn_priv->guardian_urb);
513 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
515 struct data_queue *queue;
517 unsigned int entry_size;
519 int uninitialized_var(status);
524 queue_for_each(rt2x00dev, queue) {
525 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
531 * For the RX queue, skb's should be allocated.
533 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
534 for (i = 0; i < rt2x00dev->rx->limit; i++) {
535 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
539 rt2x00dev->rx->entries[i].skb = skb;
545 rt2x00usb_uninitialize(rt2x00dev);
549 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
551 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
553 struct data_queue *queue;
555 queue_for_each(rt2x00dev, queue)
556 rt2x00usb_free_urb(rt2x00dev, queue);
558 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
561 * USB driver handlers.
563 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
565 kfree(rt2x00dev->rf);
566 rt2x00dev->rf = NULL;
568 kfree(rt2x00dev->eeprom);
569 rt2x00dev->eeprom = NULL;
571 kfree(rt2x00dev->csr.cache);
572 rt2x00dev->csr.cache = NULL;
575 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
577 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
578 if (!rt2x00dev->csr.cache)
581 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
582 if (!rt2x00dev->eeprom)
585 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
592 ERROR_PROBE("Failed to allocate registers.\n");
594 rt2x00usb_free_reg(rt2x00dev);
599 int rt2x00usb_probe(struct usb_interface *usb_intf,
600 const struct usb_device_id *id)
602 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
603 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
604 struct ieee80211_hw *hw;
605 struct rt2x00_dev *rt2x00dev;
608 usb_dev = usb_get_dev(usb_dev);
610 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
612 ERROR_PROBE("Failed to allocate hardware.\n");
614 goto exit_put_device;
617 usb_set_intfdata(usb_intf, hw);
619 rt2x00dev = hw->priv;
620 rt2x00dev->dev = usb_intf;
621 rt2x00dev->ops = ops;
623 mutex_init(&rt2x00dev->usb_cache_mutex);
625 rt2x00dev->usb_maxpacket =
626 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
627 if (!rt2x00dev->usb_maxpacket)
628 rt2x00dev->usb_maxpacket = 1;
630 retval = rt2x00usb_alloc_reg(rt2x00dev);
632 goto exit_free_device;
634 retval = rt2x00lib_probe_dev(rt2x00dev);
641 rt2x00usb_free_reg(rt2x00dev);
644 ieee80211_free_hw(hw);
647 usb_put_dev(usb_dev);
649 usb_set_intfdata(usb_intf, NULL);
653 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
655 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
657 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
658 struct rt2x00_dev *rt2x00dev = hw->priv;
661 * Free all allocated data.
663 rt2x00lib_remove_dev(rt2x00dev);
664 rt2x00usb_free_reg(rt2x00dev);
665 ieee80211_free_hw(hw);
668 * Free the USB device data.
670 usb_set_intfdata(usb_intf, NULL);
671 usb_put_dev(interface_to_usbdev(usb_intf));
673 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
676 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
678 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
679 struct rt2x00_dev *rt2x00dev = hw->priv;
682 retval = rt2x00lib_suspend(rt2x00dev, state);
686 rt2x00usb_free_reg(rt2x00dev);
689 * Decrease usbdev refcount.
691 usb_put_dev(interface_to_usbdev(usb_intf));
695 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
697 int rt2x00usb_resume(struct usb_interface *usb_intf)
699 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
700 struct rt2x00_dev *rt2x00dev = hw->priv;
703 usb_get_dev(interface_to_usbdev(usb_intf));
705 retval = rt2x00usb_alloc_reg(rt2x00dev);
709 retval = rt2x00lib_resume(rt2x00dev);
716 rt2x00usb_free_reg(rt2x00dev);
720 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
721 #endif /* CONFIG_PM */
724 * rt2x00usb module information.
726 MODULE_AUTHOR(DRV_PROJECT);
727 MODULE_VERSION(DRV_VERSION);
728 MODULE_DESCRIPTION("rt2x00 usb library");
729 MODULE_LICENSE("GPL");