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 full before the txdone handler
169 * we must make sure the packet queue in the mac80211 stack
170 * is reenabled when the txdone handler has finished.
172 if (!rt2x00queue_full(entry->queue))
173 ieee80211_wake_queue(rt2x00dev->hw, qid);
176 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
177 struct data_queue *queue, struct sk_buff *skb)
179 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
180 struct queue_entry *entry = rt2x00queue_get_entry(queue, Q_INDEX);
181 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
182 struct skb_frame_desc *skbdesc;
183 struct txentry_desc txdesc;
186 if (rt2x00queue_full(queue))
189 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags)) {
191 "Arrived at non-free entry in the non-full queue %d.\n"
192 "Please file bug report to %s.\n",
193 entry->queue->qid, DRV_PROJECT);
198 * Copy all TX descriptor information into txdesc,
199 * after that we are free to use the skb->cb array
200 * for our information.
203 rt2x00queue_create_tx_descriptor(entry, &txdesc);
206 * Add the descriptor in front of the skb.
208 skb_push(skb, queue->desc_size);
209 memset(skb->data, 0, queue->desc_size);
212 * Fill in skb descriptor
214 skbdesc = get_skb_frame_desc(skb);
215 memset(skbdesc, 0, sizeof(*skbdesc));
216 skbdesc->data = skb->data + queue->desc_size;
217 skbdesc->data_len = skb->len - queue->desc_size;
218 skbdesc->desc = skb->data;
219 skbdesc->desc_len = queue->desc_size;
220 skbdesc->entry = entry;
222 rt2x00queue_write_tx_descriptor(entry, &txdesc);
225 * USB devices cannot blindly pass the skb->len as the
226 * length of the data to usb_fill_bulk_urb. Pass the skb
227 * to the driver to determine what the length should be.
229 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
232 * Initialize URB and send the frame to the device.
234 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
235 __set_bit(ENTRY_DATA_PENDING, &entry->flags);
237 usb_fill_bulk_urb(entry_priv->urb, usb_dev, usb_sndbulkpipe(usb_dev, 1),
238 skb->data, length, rt2x00usb_interrupt_txdone, entry);
240 rt2x00queue_index_inc(queue, Q_INDEX);
244 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
246 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
248 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
250 if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
251 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
254 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
255 const enum data_queue_qid qid)
257 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
258 unsigned long irqflags;
260 unsigned int index_done;
264 * Only protect the range we are going to loop over,
265 * if during our loop a extra entry is set to pending
266 * it should not be kicked during this run, since it
267 * is part of another TX operation.
269 spin_lock_irqsave(&queue->lock, irqflags);
270 index = queue->index[Q_INDEX];
271 index_done = queue->index[Q_INDEX_DONE];
272 spin_unlock_irqrestore(&queue->lock, irqflags);
275 * Start from the TX done pointer, this guarentees that we will
276 * send out all frames in the correct order.
278 if (index_done < index) {
279 for (i = index_done; i < index; i++)
280 rt2x00usb_kick_tx_entry(&queue->entries[i]);
282 for (i = index_done; i < queue->limit; i++)
283 rt2x00usb_kick_tx_entry(&queue->entries[i]);
285 for (i = 0; i < index; i++)
286 rt2x00usb_kick_tx_entry(&queue->entries[i]);
289 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
294 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
297 unsigned int frame_size;
298 unsigned int reserved_size;
301 * The frame size includes descriptor size, because the
302 * hardware directly receive the frame into the skbuffer.
304 frame_size = queue->data_size + queue->desc_size;
307 * For the allocation we should keep a few things in mind:
308 * 1) 4byte alignment of 802.11 payload
310 * For (1) we need at most 4 bytes to guarentee the correct
311 * alignment. We are going to optimize the fact that the chance
312 * that the 802.11 header_size % 4 == 2 is much bigger then
313 * anything else. However since we need to move the frame up
314 * to 3 bytes to the front, which means we need to preallocate
322 skb = dev_alloc_skb(frame_size + reserved_size);
326 skb_reserve(skb, reserved_size);
327 skb_put(skb, frame_size);
332 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
334 struct queue_entry *entry = (struct queue_entry *)urb->context;
335 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
337 struct skb_frame_desc *skbdesc;
338 struct rxdone_entry_desc rxdesc;
339 unsigned int header_size;
342 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
343 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
347 * Check if the received data is simply too small
348 * to be actually valid, or if the urb is signaling
351 if (urb->actual_length < entry->queue->desc_size || urb->status)
355 * Fill in skb descriptor
357 skbdesc = get_skb_frame_desc(entry->skb);
358 memset(skbdesc, 0, sizeof(*skbdesc));
359 skbdesc->entry = entry;
361 memset(&rxdesc, 0, sizeof(rxdesc));
362 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
364 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
367 * The data behind the ieee80211 header must be
368 * aligned on a 4 byte boundary. We already reserved
369 * 2 bytes for header_size % 4 == 2 optimization.
370 * To determine the number of bytes which the data
371 * should be moved to the left, we must add these
372 * 2 bytes to the header_size.
374 align = (header_size + 2) % 4;
377 skb_push(entry->skb, align);
378 /* Move entire frame in 1 command */
379 memmove(entry->skb->data, entry->skb->data + align,
383 /* Update data pointers, trim buffer to correct size */
384 skbdesc->data = entry->skb->data;
385 skb_trim(entry->skb, rxdesc.size);
388 * Allocate a new sk buffer to replace the current one.
389 * If allocation fails, we should drop the current frame
390 * so we can recycle the existing sk buffer for the new frame.
392 skb = rt2x00usb_alloc_rxskb(entry->queue);
397 * Send the frame to rt2x00lib for further processing.
399 rt2x00lib_rxdone(entry, &rxdesc);
402 * Replace current entry's skb with the newly allocated one,
403 * and reinitialize the urb.
406 urb->transfer_buffer = entry->skb->data;
407 urb->transfer_buffer_length = entry->skb->len;
410 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
411 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
412 usb_submit_urb(urb, GFP_ATOMIC);
415 rt2x00queue_index_inc(entry->queue, Q_INDEX);
421 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
423 struct queue_entry_priv_usb *entry_priv;
424 struct queue_entry_priv_usb_bcn *bcn_priv;
427 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
433 for (i = 0; i < rt2x00dev->rx->limit; i++) {
434 entry_priv = rt2x00dev->rx->entries[i].priv_data;
435 usb_kill_urb(entry_priv->urb);
441 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
442 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
443 if (bcn_priv->guardian_urb)
444 usb_kill_urb(bcn_priv->guardian_urb);
447 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
450 * Device initialization handlers.
452 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
453 struct queue_entry *entry)
455 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
456 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
458 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
459 usb_rcvbulkpipe(usb_dev, 1),
460 entry->skb->data, entry->skb->len,
461 rt2x00usb_interrupt_rxdone, entry);
463 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
464 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
466 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
468 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
469 struct queue_entry *entry)
473 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
475 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
476 struct data_queue *queue)
478 struct queue_entry_priv_usb *entry_priv;
479 struct queue_entry_priv_usb_bcn *bcn_priv;
482 for (i = 0; i < queue->limit; i++) {
483 entry_priv = queue->entries[i].priv_data;
484 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
485 if (!entry_priv->urb)
490 * If this is not the beacon queue or
491 * no guardian byte was required for the beacon,
494 if (rt2x00dev->bcn != queue ||
495 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
498 for (i = 0; i < queue->limit; i++) {
499 bcn_priv = queue->entries[i].priv_data;
500 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
501 if (!bcn_priv->guardian_urb)
508 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
509 struct data_queue *queue)
511 struct queue_entry_priv_usb *entry_priv;
512 struct queue_entry_priv_usb_bcn *bcn_priv;
518 for (i = 0; i < queue->limit; i++) {
519 entry_priv = queue->entries[i].priv_data;
520 usb_kill_urb(entry_priv->urb);
521 usb_free_urb(entry_priv->urb);
522 if (queue->entries[i].skb)
523 kfree_skb(queue->entries[i].skb);
527 * If this is not the beacon queue or
528 * no guardian byte was required for the beacon,
531 if (rt2x00dev->bcn != queue ||
532 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
535 for (i = 0; i < queue->limit; i++) {
536 bcn_priv = queue->entries[i].priv_data;
537 usb_kill_urb(bcn_priv->guardian_urb);
538 usb_free_urb(bcn_priv->guardian_urb);
542 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
544 struct data_queue *queue;
546 unsigned int entry_size;
548 int uninitialized_var(status);
553 queue_for_each(rt2x00dev, queue) {
554 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
560 * For the RX queue, skb's should be allocated.
562 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
563 for (i = 0; i < rt2x00dev->rx->limit; i++) {
564 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
568 rt2x00dev->rx->entries[i].skb = skb;
574 rt2x00usb_uninitialize(rt2x00dev);
578 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
580 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
582 struct data_queue *queue;
584 queue_for_each(rt2x00dev, queue)
585 rt2x00usb_free_urb(rt2x00dev, queue);
587 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
590 * USB driver handlers.
592 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
594 kfree(rt2x00dev->rf);
595 rt2x00dev->rf = NULL;
597 kfree(rt2x00dev->eeprom);
598 rt2x00dev->eeprom = NULL;
600 kfree(rt2x00dev->csr.cache);
601 rt2x00dev->csr.cache = NULL;
604 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
606 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
607 if (!rt2x00dev->csr.cache)
610 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
611 if (!rt2x00dev->eeprom)
614 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
621 ERROR_PROBE("Failed to allocate registers.\n");
623 rt2x00usb_free_reg(rt2x00dev);
628 int rt2x00usb_probe(struct usb_interface *usb_intf,
629 const struct usb_device_id *id)
631 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
632 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
633 struct ieee80211_hw *hw;
634 struct rt2x00_dev *rt2x00dev;
637 usb_dev = usb_get_dev(usb_dev);
639 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
641 ERROR_PROBE("Failed to allocate hardware.\n");
643 goto exit_put_device;
646 usb_set_intfdata(usb_intf, hw);
648 rt2x00dev = hw->priv;
649 rt2x00dev->dev = usb_intf;
650 rt2x00dev->ops = ops;
652 mutex_init(&rt2x00dev->usb_cache_mutex);
654 rt2x00dev->usb_maxpacket =
655 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
656 if (!rt2x00dev->usb_maxpacket)
657 rt2x00dev->usb_maxpacket = 1;
659 retval = rt2x00usb_alloc_reg(rt2x00dev);
661 goto exit_free_device;
663 retval = rt2x00lib_probe_dev(rt2x00dev);
670 rt2x00usb_free_reg(rt2x00dev);
673 ieee80211_free_hw(hw);
676 usb_put_dev(usb_dev);
678 usb_set_intfdata(usb_intf, NULL);
682 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
684 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
686 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
687 struct rt2x00_dev *rt2x00dev = hw->priv;
690 * Free all allocated data.
692 rt2x00lib_remove_dev(rt2x00dev);
693 rt2x00usb_free_reg(rt2x00dev);
694 ieee80211_free_hw(hw);
697 * Free the USB device data.
699 usb_set_intfdata(usb_intf, NULL);
700 usb_put_dev(interface_to_usbdev(usb_intf));
702 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
705 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
707 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
708 struct rt2x00_dev *rt2x00dev = hw->priv;
711 retval = rt2x00lib_suspend(rt2x00dev, state);
715 rt2x00usb_free_reg(rt2x00dev);
718 * Decrease usbdev refcount.
720 usb_put_dev(interface_to_usbdev(usb_intf));
724 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
726 int rt2x00usb_resume(struct usb_interface *usb_intf)
728 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
729 struct rt2x00_dev *rt2x00dev = hw->priv;
732 usb_get_dev(interface_to_usbdev(usb_intf));
734 retval = rt2x00usb_alloc_reg(rt2x00dev);
738 retval = rt2x00lib_resume(rt2x00dev);
745 rt2x00usb_free_reg(rt2x00dev);
749 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
750 #endif /* CONFIG_PM */
753 * rt2x00usb module information.
755 MODULE_AUTHOR(DRV_PROJECT);
756 MODULE_VERSION(DRV_VERSION);
757 MODULE_DESCRIPTION("rt2x00 usb library");
758 MODULE_LICENSE("GPL");