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->desc = entry->skb->data;
196 skbdesc->desc_len = entry->queue->desc_size;
197 skbdesc->entry = entry;
200 * USB devices cannot blindly pass the skb->len as the
201 * length of the data to usb_fill_bulk_urb. Pass the skb
202 * to the driver to determine what the length should be.
204 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
206 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
207 usb_sndbulkpipe(usb_dev, 1),
208 entry->skb->data, length,
209 rt2x00usb_interrupt_txdone, entry);
213 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
215 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
217 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
219 if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
220 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
223 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
224 const enum data_queue_qid qid)
226 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
227 unsigned long irqflags;
229 unsigned int index_done;
233 * Only protect the range we are going to loop over,
234 * if during our loop a extra entry is set to pending
235 * it should not be kicked during this run, since it
236 * is part of another TX operation.
238 spin_lock_irqsave(&queue->lock, irqflags);
239 index = queue->index[Q_INDEX];
240 index_done = queue->index[Q_INDEX_DONE];
241 spin_unlock_irqrestore(&queue->lock, irqflags);
244 * Start from the TX done pointer, this guarentees that we will
245 * send out all frames in the correct order.
247 if (index_done < index) {
248 for (i = index_done; i < index; i++)
249 rt2x00usb_kick_tx_entry(&queue->entries[i]);
251 for (i = index_done; i < queue->limit; i++)
252 rt2x00usb_kick_tx_entry(&queue->entries[i]);
254 for (i = 0; i < index; i++)
255 rt2x00usb_kick_tx_entry(&queue->entries[i]);
258 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
263 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
266 unsigned int frame_size;
267 unsigned int reserved_size;
270 * The frame size includes descriptor size, because the
271 * hardware directly receive the frame into the skbuffer.
273 frame_size = queue->data_size + queue->desc_size;
276 * For the allocation we should keep a few things in mind:
277 * 1) 4byte alignment of 802.11 payload
279 * For (1) we need at most 4 bytes to guarentee the correct
280 * alignment. We are going to optimize the fact that the chance
281 * that the 802.11 header_size % 4 == 2 is much bigger then
282 * anything else. However since we need to move the frame up
283 * to 3 bytes to the front, which means we need to preallocate
291 skb = dev_alloc_skb(frame_size + reserved_size);
295 skb_reserve(skb, reserved_size);
296 skb_put(skb, frame_size);
301 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
303 struct queue_entry *entry = (struct queue_entry *)urb->context;
304 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
306 struct skb_frame_desc *skbdesc;
307 struct rxdone_entry_desc rxdesc;
308 unsigned int header_size;
311 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
312 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
316 * Check if the received data is simply too small
317 * to be actually valid, or if the urb is signaling
320 if (urb->actual_length < entry->queue->desc_size || urb->status)
324 * Fill in skb descriptor
326 skbdesc = get_skb_frame_desc(entry->skb);
327 memset(skbdesc, 0, sizeof(*skbdesc));
328 skbdesc->entry = entry;
330 memset(&rxdesc, 0, sizeof(rxdesc));
331 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
333 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
336 * The data behind the ieee80211 header must be
337 * aligned on a 4 byte boundary. We already reserved
338 * 2 bytes for header_size % 4 == 2 optimization.
339 * To determine the number of bytes which the data
340 * should be moved to the left, we must add these
341 * 2 bytes to the header_size.
343 align = (header_size + 2) % 4;
346 skb_push(entry->skb, align);
347 /* Move entire frame in 1 command */
348 memmove(entry->skb->data, entry->skb->data + align,
352 /* Update data pointers, trim buffer to correct size */
353 skb_trim(entry->skb, rxdesc.size);
356 * Allocate a new sk buffer to replace the current one.
357 * If allocation fails, we should drop the current frame
358 * so we can recycle the existing sk buffer for the new frame.
360 skb = rt2x00usb_alloc_rxskb(entry->queue);
365 * Send the frame to rt2x00lib for further processing.
367 rt2x00lib_rxdone(entry, &rxdesc);
370 * Replace current entry's skb with the newly allocated one,
371 * and reinitialize the urb.
374 urb->transfer_buffer = entry->skb->data;
375 urb->transfer_buffer_length = entry->skb->len;
378 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
379 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
380 usb_submit_urb(urb, GFP_ATOMIC);
383 rt2x00queue_index_inc(entry->queue, Q_INDEX);
389 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
391 struct queue_entry_priv_usb *entry_priv;
392 struct queue_entry_priv_usb_bcn *bcn_priv;
395 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
401 for (i = 0; i < rt2x00dev->rx->limit; i++) {
402 entry_priv = rt2x00dev->rx->entries[i].priv_data;
403 usb_kill_urb(entry_priv->urb);
409 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
410 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
411 if (bcn_priv->guardian_urb)
412 usb_kill_urb(bcn_priv->guardian_urb);
415 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
418 * Device initialization handlers.
420 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
421 struct queue_entry *entry)
423 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
424 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
426 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
427 usb_rcvbulkpipe(usb_dev, 1),
428 entry->skb->data, entry->skb->len,
429 rt2x00usb_interrupt_rxdone, entry);
431 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
432 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
434 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
436 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
437 struct queue_entry *entry)
441 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
443 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
444 struct data_queue *queue)
446 struct queue_entry_priv_usb *entry_priv;
447 struct queue_entry_priv_usb_bcn *bcn_priv;
450 for (i = 0; i < queue->limit; i++) {
451 entry_priv = queue->entries[i].priv_data;
452 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
453 if (!entry_priv->urb)
458 * If this is not the beacon queue or
459 * no guardian byte was required for the beacon,
462 if (rt2x00dev->bcn != queue ||
463 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
466 for (i = 0; i < queue->limit; i++) {
467 bcn_priv = queue->entries[i].priv_data;
468 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
469 if (!bcn_priv->guardian_urb)
476 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
477 struct data_queue *queue)
479 struct queue_entry_priv_usb *entry_priv;
480 struct queue_entry_priv_usb_bcn *bcn_priv;
486 for (i = 0; i < queue->limit; i++) {
487 entry_priv = queue->entries[i].priv_data;
488 usb_kill_urb(entry_priv->urb);
489 usb_free_urb(entry_priv->urb);
490 if (queue->entries[i].skb)
491 kfree_skb(queue->entries[i].skb);
495 * If this is not the beacon queue or
496 * no guardian byte was required for the beacon,
499 if (rt2x00dev->bcn != queue ||
500 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
503 for (i = 0; i < queue->limit; i++) {
504 bcn_priv = queue->entries[i].priv_data;
505 usb_kill_urb(bcn_priv->guardian_urb);
506 usb_free_urb(bcn_priv->guardian_urb);
510 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
512 struct data_queue *queue;
514 unsigned int entry_size;
516 int uninitialized_var(status);
521 queue_for_each(rt2x00dev, queue) {
522 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
528 * For the RX queue, skb's should be allocated.
530 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
531 for (i = 0; i < rt2x00dev->rx->limit; i++) {
532 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
536 rt2x00dev->rx->entries[i].skb = skb;
542 rt2x00usb_uninitialize(rt2x00dev);
546 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
548 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
550 struct data_queue *queue;
552 queue_for_each(rt2x00dev, queue)
553 rt2x00usb_free_urb(rt2x00dev, queue);
555 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
558 * USB driver handlers.
560 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
562 kfree(rt2x00dev->rf);
563 rt2x00dev->rf = NULL;
565 kfree(rt2x00dev->eeprom);
566 rt2x00dev->eeprom = NULL;
568 kfree(rt2x00dev->csr.cache);
569 rt2x00dev->csr.cache = NULL;
572 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
574 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
575 if (!rt2x00dev->csr.cache)
578 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
579 if (!rt2x00dev->eeprom)
582 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
589 ERROR_PROBE("Failed to allocate registers.\n");
591 rt2x00usb_free_reg(rt2x00dev);
596 int rt2x00usb_probe(struct usb_interface *usb_intf,
597 const struct usb_device_id *id)
599 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
600 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
601 struct ieee80211_hw *hw;
602 struct rt2x00_dev *rt2x00dev;
605 usb_dev = usb_get_dev(usb_dev);
607 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
609 ERROR_PROBE("Failed to allocate hardware.\n");
611 goto exit_put_device;
614 usb_set_intfdata(usb_intf, hw);
616 rt2x00dev = hw->priv;
617 rt2x00dev->dev = usb_intf;
618 rt2x00dev->ops = ops;
620 mutex_init(&rt2x00dev->usb_cache_mutex);
622 rt2x00dev->usb_maxpacket =
623 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
624 if (!rt2x00dev->usb_maxpacket)
625 rt2x00dev->usb_maxpacket = 1;
627 retval = rt2x00usb_alloc_reg(rt2x00dev);
629 goto exit_free_device;
631 retval = rt2x00lib_probe_dev(rt2x00dev);
638 rt2x00usb_free_reg(rt2x00dev);
641 ieee80211_free_hw(hw);
644 usb_put_dev(usb_dev);
646 usb_set_intfdata(usb_intf, NULL);
650 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
652 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
654 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
655 struct rt2x00_dev *rt2x00dev = hw->priv;
658 * Free all allocated data.
660 rt2x00lib_remove_dev(rt2x00dev);
661 rt2x00usb_free_reg(rt2x00dev);
662 ieee80211_free_hw(hw);
665 * Free the USB device data.
667 usb_set_intfdata(usb_intf, NULL);
668 usb_put_dev(interface_to_usbdev(usb_intf));
670 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
673 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
675 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
676 struct rt2x00_dev *rt2x00dev = hw->priv;
679 retval = rt2x00lib_suspend(rt2x00dev, state);
683 rt2x00usb_free_reg(rt2x00dev);
686 * Decrease usbdev refcount.
688 usb_put_dev(interface_to_usbdev(usb_intf));
692 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
694 int rt2x00usb_resume(struct usb_interface *usb_intf)
696 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
697 struct rt2x00_dev *rt2x00dev = hw->priv;
700 usb_get_dev(interface_to_usbdev(usb_intf));
702 retval = rt2x00usb_alloc_reg(rt2x00dev);
706 retval = rt2x00lib_resume(rt2x00dev);
713 rt2x00usb_free_reg(rt2x00dev);
717 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
718 #endif /* CONFIG_PM */
721 * rt2x00usb module information.
723 MODULE_AUTHOR(DRV_PROJECT);
724 MODULE_VERSION(DRV_VERSION);
725 MODULE_DESCRIPTION("rt2x00 usb library");
726 MODULE_LICENSE("GPL");