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.
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 = &priv_tx->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, priv_tx->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_tx *priv_tx = entry->priv_data;
188 struct skb_frame_desc *skbdesc;
191 if (rt2x00queue_full(queue))
194 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags)) {
196 "Arrived at non-free entry in the non-full queue %d.\n"
197 "Please file bug report to %s.\n",
198 entry->queue->qid, DRV_PROJECT);
203 * Add the descriptor in front of the skb.
205 skb_push(skb, queue->desc_size);
206 memset(skb->data, 0, queue->desc_size);
209 * Fill in skb descriptor
211 skbdesc = get_skb_frame_desc(skb);
212 skbdesc->data = skb->data + queue->desc_size;
213 skbdesc->data_len = skb->len - queue->desc_size;
214 skbdesc->desc = skb->data;
215 skbdesc->desc_len = queue->desc_size;
216 skbdesc->entry = entry;
218 memcpy(&priv_tx->control, control, sizeof(priv_tx->control));
219 rt2x00lib_write_tx_desc(rt2x00dev, skb, control);
222 * USB devices cannot blindly pass the skb->len as the
223 * length of the data to usb_fill_bulk_urb. Pass the skb
224 * to the driver to determine what the length should be.
226 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
229 * Initialize URB and send the frame to the device.
231 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
232 usb_fill_bulk_urb(priv_tx->urb, usb_dev, usb_sndbulkpipe(usb_dev, 1),
233 skb->data, length, rt2x00usb_interrupt_txdone, entry);
234 usb_submit_urb(priv_tx->urb, GFP_ATOMIC);
236 rt2x00queue_index_inc(queue, Q_INDEX);
240 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
245 static struct sk_buff* rt2x00usb_alloc_rxskb(struct data_queue *queue)
248 unsigned int frame_size;
249 unsigned int reserved_size;
252 * The frame size includes descriptor size, because the
253 * hardware directly receive the frame into the skbuffer.
255 frame_size = queue->data_size + queue->desc_size;
258 * For the allocation we should keep a few things in mind:
259 * 1) 4byte alignment of 802.11 payload
261 * For (1) we need at most 4 bytes to guarentee the correct
262 * alignment. We are going to optimize the fact that the chance
263 * that the 802.11 header_size % 4 == 2 is much bigger then
264 * anything else. However since we need to move the frame up
265 * to 3 bytes to the front, which means we need to preallocate
273 skb = dev_alloc_skb(frame_size + reserved_size);
277 skb_reserve(skb, reserved_size);
278 skb_put(skb, frame_size);
283 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
285 struct queue_entry *entry = (struct queue_entry *)urb->context;
286 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
288 struct skb_frame_desc *skbdesc;
289 struct rxdone_entry_desc rxdesc;
290 unsigned int header_size;
293 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
294 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
298 * Check if the received data is simply too small
299 * to be actually valid, or if the urb is signaling
302 if (urb->actual_length < entry->queue->desc_size || urb->status)
306 * Fill in skb descriptor
308 skbdesc = get_skb_frame_desc(entry->skb);
309 memset(skbdesc, 0, sizeof(*skbdesc));
310 skbdesc->entry = entry;
312 memset(&rxdesc, 0, sizeof(rxdesc));
313 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
315 header_size = ieee80211_get_hdrlen_from_skb(entry->skb);
318 * The data behind the ieee80211 header must be
319 * aligned on a 4 byte boundary. We already reserved
320 * 2 bytes for header_size % 4 == 2 optimization.
321 * To determine the number of bytes which the data
322 * should be moved to the left, we must add these
323 * 2 bytes to the header_size.
325 align = (header_size + 2) % 4;
328 skb_push(entry->skb, align);
329 /* Move entire frame in 1 command */
330 memmove(entry->skb->data, entry->skb->data + align,
334 /* Update data pointers, trim buffer to correct size */
335 skbdesc->data = entry->skb->data;
336 skb_trim(entry->skb, rxdesc.size);
339 * Allocate a new sk buffer to replace the current one.
340 * If allocation fails, we should drop the current frame
341 * so we can recycle the existing sk buffer for the new frame.
343 skb = rt2x00usb_alloc_rxskb(entry->queue);
348 * Send the frame to rt2x00lib for further processing.
350 rt2x00lib_rxdone(entry, &rxdesc);
353 * Replace current entry's skb with the newly allocated one,
354 * and reinitialize the urb.
357 urb->transfer_buffer = entry->skb->data;
358 urb->transfer_buffer_length = entry->skb->len;
361 if (test_bit(DEVICE_ENABLED_RADIO, &entry->queue->rt2x00dev->flags)) {
362 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
363 usb_submit_urb(urb, GFP_ATOMIC);
366 rt2x00queue_index_inc(entry->queue, Q_INDEX);
372 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
374 struct queue_entry_priv_usb_rx *priv_rx;
375 struct queue_entry_priv_usb_tx *priv_tx;
376 struct queue_entry_priv_usb_bcn *priv_bcn;
377 struct data_queue *queue;
380 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
386 for (i = 0; i < rt2x00dev->rx->limit; i++) {
387 priv_rx = rt2x00dev->rx->entries[i].priv_data;
388 usb_kill_urb(priv_rx->urb);
391 tx_queue_for_each(rt2x00dev, queue) {
392 for (i = 0; i < queue->limit; i++) {
393 priv_tx = queue->entries[i].priv_data;
394 usb_kill_urb(priv_tx->urb);
398 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
399 priv_bcn = rt2x00dev->bcn->entries[i].priv_data;
400 usb_kill_urb(priv_bcn->urb);
402 if (priv_bcn->guardian_urb)
403 usb_kill_urb(priv_bcn->guardian_urb);
406 if (!test_bit(DRIVER_REQUIRE_ATIM_QUEUE, &rt2x00dev->flags))
409 for (i = 0; i < rt2x00dev->bcn[1].limit; i++) {
410 priv_tx = rt2x00dev->bcn[1].entries[i].priv_data;
411 usb_kill_urb(priv_tx->urb);
414 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
417 * Device initialization handlers.
419 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
420 struct queue_entry *entry)
422 struct usb_device *usb_dev = rt2x00dev_usb_dev(rt2x00dev);
423 struct queue_entry_priv_usb_rx *priv_rx = entry->priv_data;
425 usb_fill_bulk_urb(priv_rx->urb, usb_dev,
426 usb_rcvbulkpipe(usb_dev, 1),
427 entry->skb->data, entry->skb->len,
428 rt2x00usb_interrupt_rxdone, entry);
430 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
431 usb_submit_urb(priv_rx->urb, GFP_ATOMIC);
433 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
435 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
436 struct queue_entry *entry)
440 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
442 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
443 struct data_queue *queue)
445 struct queue_entry_priv_usb_rx *priv_rx;
446 struct queue_entry_priv_usb_tx *priv_tx;
447 struct queue_entry_priv_usb_bcn *priv_bcn;
449 unsigned int guardian =
450 test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags);
456 for (i = 0; i < queue->limit; i++) {
457 urb = usb_alloc_urb(0, GFP_KERNEL);
461 if (queue->qid == QID_RX) {
462 priv_rx = queue->entries[i].priv_data;
464 } else if (queue->qid == QID_MGMT && guardian) {
465 priv_bcn = queue->entries[i].priv_data;
468 urb = usb_alloc_urb(0, GFP_KERNEL);
472 priv_bcn->guardian_urb = urb;
474 priv_tx = queue->entries[i].priv_data;
482 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
483 struct data_queue *queue)
485 struct queue_entry_priv_usb_rx *priv_rx;
486 struct queue_entry_priv_usb_tx *priv_tx;
487 struct queue_entry_priv_usb_bcn *priv_bcn;
489 unsigned int guardian =
490 test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags);
496 for (i = 0; i < queue->limit; i++) {
497 if (queue->qid == QID_RX) {
498 priv_rx = queue->entries[i].priv_data;
500 } else if (queue->qid == QID_MGMT && guardian) {
501 priv_bcn = queue->entries[i].priv_data;
503 usb_kill_urb(priv_bcn->guardian_urb);
504 usb_free_urb(priv_bcn->guardian_urb);
508 priv_tx = queue->entries[i].priv_data;
514 if (queue->entries[i].skb)
515 kfree_skb(queue->entries[i].skb);
519 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
521 struct data_queue *queue;
523 unsigned int entry_size;
525 int uninitialized_var(status);
530 queue_for_each(rt2x00dev, queue) {
531 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
537 * For the RX queue, skb's should be allocated.
539 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
540 for (i = 0; i < rt2x00dev->rx->limit; i++) {
541 skb = rt2x00usb_alloc_rxskb(rt2x00dev->rx);
545 rt2x00dev->rx->entries[i].skb = skb;
551 rt2x00usb_uninitialize(rt2x00dev);
555 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
557 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
559 struct data_queue *queue;
561 queue_for_each(rt2x00dev, queue)
562 rt2x00usb_free_urb(rt2x00dev, queue);
564 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
567 * USB driver handlers.
569 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
571 kfree(rt2x00dev->rf);
572 rt2x00dev->rf = NULL;
574 kfree(rt2x00dev->eeprom);
575 rt2x00dev->eeprom = NULL;
577 kfree(rt2x00dev->csr.cache);
578 rt2x00dev->csr.cache = NULL;
581 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
583 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
584 if (!rt2x00dev->csr.cache)
587 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
588 if (!rt2x00dev->eeprom)
591 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
598 ERROR_PROBE("Failed to allocate registers.\n");
600 rt2x00usb_free_reg(rt2x00dev);
605 int rt2x00usb_probe(struct usb_interface *usb_intf,
606 const struct usb_device_id *id)
608 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
609 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
610 struct ieee80211_hw *hw;
611 struct rt2x00_dev *rt2x00dev;
614 usb_dev = usb_get_dev(usb_dev);
616 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
618 ERROR_PROBE("Failed to allocate hardware.\n");
620 goto exit_put_device;
623 usb_set_intfdata(usb_intf, hw);
625 rt2x00dev = hw->priv;
626 rt2x00dev->dev = usb_intf;
627 rt2x00dev->ops = ops;
629 mutex_init(&rt2x00dev->usb_cache_mutex);
631 rt2x00dev->usb_maxpacket =
632 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
633 if (!rt2x00dev->usb_maxpacket)
634 rt2x00dev->usb_maxpacket = 1;
636 retval = rt2x00usb_alloc_reg(rt2x00dev);
638 goto exit_free_device;
640 retval = rt2x00lib_probe_dev(rt2x00dev);
647 rt2x00usb_free_reg(rt2x00dev);
650 ieee80211_free_hw(hw);
653 usb_put_dev(usb_dev);
655 usb_set_intfdata(usb_intf, NULL);
659 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
661 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
663 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
664 struct rt2x00_dev *rt2x00dev = hw->priv;
667 * Free all allocated data.
669 rt2x00lib_remove_dev(rt2x00dev);
670 rt2x00usb_free_reg(rt2x00dev);
671 ieee80211_free_hw(hw);
674 * Free the USB device data.
676 usb_set_intfdata(usb_intf, NULL);
677 usb_put_dev(interface_to_usbdev(usb_intf));
679 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
682 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
684 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
685 struct rt2x00_dev *rt2x00dev = hw->priv;
688 retval = rt2x00lib_suspend(rt2x00dev, state);
692 rt2x00usb_free_reg(rt2x00dev);
695 * Decrease usbdev refcount.
697 usb_put_dev(interface_to_usbdev(usb_intf));
701 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
703 int rt2x00usb_resume(struct usb_interface *usb_intf)
705 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
706 struct rt2x00_dev *rt2x00dev = hw->priv;
709 usb_get_dev(interface_to_usbdev(usb_intf));
711 retval = rt2x00usb_alloc_reg(rt2x00dev);
715 retval = rt2x00lib_resume(rt2x00dev);
722 rt2x00usb_free_reg(rt2x00dev);
726 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
727 #endif /* CONFIG_PM */
730 * rt2x00usb module information.
732 MODULE_AUTHOR(DRV_PROJECT);
733 MODULE_VERSION(DRV_VERSION);
734 MODULE_DESCRIPTION("rt2x00 usb library");
735 MODULE_LICENSE("GPL");