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 *entry_priv = 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.
150 * Note that when the status is 0 it does not mean the
151 * frame was send out correctly. It only means the frame
152 * was succesfully pushed to the hardware, we have no
153 * way to determine the transmission status right now.
154 * (Only indirectly by looking at the failed TX counters
158 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
160 __set_bit(TXDONE_FAILURE, &txdesc.flags);
162 txdesc.control = &entry_priv->control;
164 rt2x00lib_txdone(entry, &txdesc);
167 * Make this entry available for reuse.
170 rt2x00queue_index_inc(entry->queue, Q_INDEX_DONE);
173 * If the data queue was full before the txdone handler
174 * we must make sure the packet queue in the mac80211 stack
175 * is reenabled when the txdone handler has finished.
177 if (!rt2x00queue_full(entry->queue))
178 ieee80211_wake_queue(rt2x00dev->hw, entry_priv->control.queue);
181 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
182 struct data_queue *queue, struct sk_buff *skb,
183 struct ieee80211_tx_control *control)
185 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
186 struct queue_entry *entry = rt2x00queue_get_entry(queue, Q_INDEX);
187 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
188 struct skb_frame_desc *skbdesc;
189 struct txentry_desc txdesc;
192 if (rt2x00queue_full(queue))
195 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags)) {
197 "Arrived at non-free entry in the non-full queue %d.\n"
198 "Please file bug report to %s.\n",
199 entry->queue->qid, DRV_PROJECT);
204 * Copy all TX descriptor information into txdesc,
205 * after that we are free to use the skb->cb array
206 * for our information.
209 rt2x00queue_create_tx_descriptor(entry, &txdesc, control);
212 * Add the descriptor in front of the skb.
214 skb_push(skb, queue->desc_size);
215 memset(skb->data, 0, queue->desc_size);
218 * Fill in skb descriptor
220 skbdesc = get_skb_frame_desc(skb);
221 skbdesc->data = skb->data + queue->desc_size;
222 skbdesc->data_len = skb->len - queue->desc_size;
223 skbdesc->desc = skb->data;
224 skbdesc->desc_len = queue->desc_size;
225 skbdesc->entry = entry;
227 memcpy(&entry_priv->control, control, sizeof(entry_priv->control));
228 rt2x00queue_write_tx_descriptor(entry, &txdesc);
231 * USB devices cannot blindly pass the skb->len as the
232 * length of the data to usb_fill_bulk_urb. Pass the skb
233 * to the driver to determine what the length should be.
235 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
238 * Initialize URB and send the frame to the device.
240 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
241 usb_fill_bulk_urb(entry_priv->urb, usb_dev, usb_sndbulkpipe(usb_dev, 1),
242 skb->data, length, rt2x00usb_interrupt_txdone, entry);
243 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
245 rt2x00queue_index_inc(queue, Q_INDEX);
249 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
254 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
257 unsigned int frame_size;
258 unsigned int reserved_size;
261 * The frame size includes descriptor size, because the
262 * hardware directly receive the frame into the skbuffer.
264 frame_size = queue->data_size + queue->desc_size;
267 * For the allocation we should keep a few things in mind:
268 * 1) 4byte alignment of 802.11 payload
270 * For (1) we need at most 4 bytes to guarentee the correct
271 * alignment. We are going to optimize the fact that the chance
272 * that the 802.11 header_size % 4 == 2 is much bigger then
273 * anything else. However since we need to move the frame up
274 * to 3 bytes to the front, which means we need to preallocate
282 skb = dev_alloc_skb(frame_size + reserved_size);
286 skb_reserve(skb, reserved_size);
287 skb_put(skb, frame_size);
292 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
294 struct queue_entry *entry = (struct queue_entry *)urb->context;
295 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
297 struct skb_frame_desc *skbdesc;
298 struct rxdone_entry_desc rxdesc;
299 unsigned int header_size;
302 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
303 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
307 * Check if the received data is simply too small
308 * to be actually valid, or if the urb is signaling
311 if (urb->actual_length < entry->queue->desc_size || urb->status)
315 * Fill in skb descriptor
317 skbdesc = get_skb_frame_desc(entry->skb);
318 memset(skbdesc, 0, sizeof(*skbdesc));
319 skbdesc->entry = entry;
321 memset(&rxdesc, 0, sizeof(rxdesc));
322 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
324 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
327 * The data behind the ieee80211 header must be
328 * aligned on a 4 byte boundary. We already reserved
329 * 2 bytes for header_size % 4 == 2 optimization.
330 * To determine the number of bytes which the data
331 * should be moved to the left, we must add these
332 * 2 bytes to the header_size.
334 align = (header_size + 2) % 4;
337 skb_push(entry->skb, align);
338 /* Move entire frame in 1 command */
339 memmove(entry->skb->data, entry->skb->data + align,
343 /* Update data pointers, trim buffer to correct size */
344 skbdesc->data = entry->skb->data;
345 skb_trim(entry->skb, rxdesc.size);
348 * Allocate a new sk buffer to replace the current one.
349 * If allocation fails, we should drop the current frame
350 * so we can recycle the existing sk buffer for the new frame.
352 skb = rt2x00usb_alloc_rxskb(entry->queue);
357 * Send the frame to rt2x00lib for further processing.
359 rt2x00lib_rxdone(entry, &rxdesc);
362 * Replace current entry's skb with the newly allocated one,
363 * and reinitialize the urb.
366 urb->transfer_buffer = entry->skb->data;
367 urb->transfer_buffer_length = entry->skb->len;
370 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
371 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
372 usb_submit_urb(urb, GFP_ATOMIC);
375 rt2x00queue_index_inc(entry->queue, Q_INDEX);
381 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
383 struct queue_entry_priv_usb *entry_priv;
384 struct queue_entry_priv_usb_bcn *bcn_priv;
387 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
393 for (i = 0; i < rt2x00dev->rx->limit; i++) {
394 entry_priv = rt2x00dev->rx->entries[i].priv_data;
395 usb_kill_urb(entry_priv->urb);
401 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
402 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
403 if (bcn_priv->guardian_urb)
404 usb_kill_urb(bcn_priv->guardian_urb);
407 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
410 * Device initialization handlers.
412 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
413 struct queue_entry *entry)
415 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
416 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
418 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
419 usb_rcvbulkpipe(usb_dev, 1),
420 entry->skb->data, entry->skb->len,
421 rt2x00usb_interrupt_rxdone, entry);
423 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
424 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
426 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
428 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
429 struct queue_entry *entry)
433 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
435 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
436 struct data_queue *queue)
438 struct queue_entry_priv_usb *entry_priv;
439 struct queue_entry_priv_usb_bcn *bcn_priv;
442 for (i = 0; i < queue->limit; i++) {
443 entry_priv = queue->entries[i].priv_data;
444 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
445 if (!entry_priv->urb)
450 * If this is not the beacon queue or
451 * no guardian byte was required for the beacon,
454 if (rt2x00dev->bcn != queue ||
455 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
458 for (i = 0; i < queue->limit; i++) {
459 bcn_priv = queue->entries[i].priv_data;
460 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
461 if (!bcn_priv->guardian_urb)
468 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
469 struct data_queue *queue)
471 struct queue_entry_priv_usb *entry_priv;
472 struct queue_entry_priv_usb_bcn *bcn_priv;
478 for (i = 0; i < queue->limit; i++) {
479 entry_priv = queue->entries[i].priv_data;
480 usb_kill_urb(entry_priv->urb);
481 usb_free_urb(entry_priv->urb);
482 if (queue->entries[i].skb)
483 kfree_skb(queue->entries[i].skb);
487 * If this is not the beacon queue or
488 * no guardian byte was required for the beacon,
491 if (rt2x00dev->bcn != queue ||
492 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
495 for (i = 0; i < queue->limit; i++) {
496 bcn_priv = queue->entries[i].priv_data;
497 usb_kill_urb(bcn_priv->guardian_urb);
498 usb_free_urb(bcn_priv->guardian_urb);
502 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
504 struct data_queue *queue;
506 unsigned int entry_size;
508 int uninitialized_var(status);
513 queue_for_each(rt2x00dev, queue) {
514 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
520 * For the RX queue, skb's should be allocated.
522 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
523 for (i = 0; i < rt2x00dev->rx->limit; i++) {
524 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
528 rt2x00dev->rx->entries[i].skb = skb;
534 rt2x00usb_uninitialize(rt2x00dev);
538 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
540 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
542 struct data_queue *queue;
544 queue_for_each(rt2x00dev, queue)
545 rt2x00usb_free_urb(rt2x00dev, queue);
547 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
550 * USB driver handlers.
552 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
554 kfree(rt2x00dev->rf);
555 rt2x00dev->rf = NULL;
557 kfree(rt2x00dev->eeprom);
558 rt2x00dev->eeprom = NULL;
560 kfree(rt2x00dev->csr.cache);
561 rt2x00dev->csr.cache = NULL;
564 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
566 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
567 if (!rt2x00dev->csr.cache)
570 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
571 if (!rt2x00dev->eeprom)
574 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
581 ERROR_PROBE("Failed to allocate registers.\n");
583 rt2x00usb_free_reg(rt2x00dev);
588 int rt2x00usb_probe(struct usb_interface *usb_intf,
589 const struct usb_device_id *id)
591 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
592 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
593 struct ieee80211_hw *hw;
594 struct rt2x00_dev *rt2x00dev;
597 usb_dev = usb_get_dev(usb_dev);
599 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
601 ERROR_PROBE("Failed to allocate hardware.\n");
603 goto exit_put_device;
606 usb_set_intfdata(usb_intf, hw);
608 rt2x00dev = hw->priv;
609 rt2x00dev->dev = usb_intf;
610 rt2x00dev->ops = ops;
612 mutex_init(&rt2x00dev->usb_cache_mutex);
614 rt2x00dev->usb_maxpacket =
615 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
616 if (!rt2x00dev->usb_maxpacket)
617 rt2x00dev->usb_maxpacket = 1;
619 retval = rt2x00usb_alloc_reg(rt2x00dev);
621 goto exit_free_device;
623 retval = rt2x00lib_probe_dev(rt2x00dev);
630 rt2x00usb_free_reg(rt2x00dev);
633 ieee80211_free_hw(hw);
636 usb_put_dev(usb_dev);
638 usb_set_intfdata(usb_intf, NULL);
642 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
644 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
646 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
647 struct rt2x00_dev *rt2x00dev = hw->priv;
650 * Free all allocated data.
652 rt2x00lib_remove_dev(rt2x00dev);
653 rt2x00usb_free_reg(rt2x00dev);
654 ieee80211_free_hw(hw);
657 * Free the USB device data.
659 usb_set_intfdata(usb_intf, NULL);
660 usb_put_dev(interface_to_usbdev(usb_intf));
662 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
665 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
667 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
668 struct rt2x00_dev *rt2x00dev = hw->priv;
671 retval = rt2x00lib_suspend(rt2x00dev, state);
675 rt2x00usb_free_reg(rt2x00dev);
678 * Decrease usbdev refcount.
680 usb_put_dev(interface_to_usbdev(usb_intf));
684 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
686 int rt2x00usb_resume(struct usb_interface *usb_intf)
688 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
689 struct rt2x00_dev *rt2x00dev = hw->priv;
692 usb_get_dev(interface_to_usbdev(usb_intf));
694 retval = rt2x00usb_alloc_reg(rt2x00dev);
698 retval = rt2x00lib_resume(rt2x00dev);
705 rt2x00usb_free_reg(rt2x00dev);
709 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
710 #endif /* CONFIG_PM */
713 * rt2x00usb module information.
715 MODULE_AUTHOR(DRV_PROJECT);
716 MODULE_VERSION(DRV_VERSION);
717 MODULE_DESCRIPTION("rt2x00 usb library");
718 MODULE_LICENSE("GPL");