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 = to_usb_device_intf(rt2x00dev->dev);
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);
125 int rt2x00usb_vendor_request_large_buff(struct rt2x00_dev *rt2x00dev,
126 const u8 request, const u8 requesttype,
127 const u16 offset, void *buffer,
128 const u16 buffer_length,
135 mutex_lock(&rt2x00dev->usb_cache_mutex);
140 while (len && !status) {
141 bsize = min_t(u16, CSR_CACHE_SIZE, len);
142 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
143 requesttype, off, tb,
151 mutex_unlock(&rt2x00dev->usb_cache_mutex);
155 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_large_buff);
160 static void rt2x00usb_interrupt_txdone(struct urb *urb)
162 struct queue_entry *entry = (struct queue_entry *)urb->context;
163 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
164 struct txdone_entry_desc txdesc;
166 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
167 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
171 * Remove the descriptor data from the buffer.
173 skb_pull(entry->skb, entry->queue->desc_size);
176 * Obtain the status about this packet.
177 * Note that when the status is 0 it does not mean the
178 * frame was send out correctly. It only means the frame
179 * was succesfully pushed to the hardware, we have no
180 * way to determine the transmission status right now.
181 * (Only indirectly by looking at the failed TX counters
185 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
187 __set_bit(TXDONE_FAILURE, &txdesc.flags);
190 rt2x00lib_txdone(entry, &txdesc);
193 int rt2x00usb_write_tx_data(struct queue_entry *entry)
195 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
196 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
197 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
198 struct skb_frame_desc *skbdesc;
202 * Add the descriptor in front of the skb.
204 skb_push(entry->skb, entry->queue->desc_size);
205 memset(entry->skb->data, 0, entry->queue->desc_size);
208 * Fill in skb descriptor
210 skbdesc = get_skb_frame_desc(entry->skb);
211 skbdesc->desc = entry->skb->data;
212 skbdesc->desc_len = entry->queue->desc_size;
215 * USB devices cannot blindly pass the skb->len as the
216 * length of the data to usb_fill_bulk_urb. Pass the skb
217 * to the driver to determine what the length should be.
219 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
221 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
222 usb_sndbulkpipe(usb_dev, 1),
223 entry->skb->data, length,
224 rt2x00usb_interrupt_txdone, entry);
228 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
230 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
232 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
234 if (__test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
235 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
238 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
239 const enum data_queue_qid qid)
241 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
242 unsigned long irqflags;
244 unsigned int index_done;
248 * Only protect the range we are going to loop over,
249 * if during our loop a extra entry is set to pending
250 * it should not be kicked during this run, since it
251 * is part of another TX operation.
253 spin_lock_irqsave(&queue->lock, irqflags);
254 index = queue->index[Q_INDEX];
255 index_done = queue->index[Q_INDEX_DONE];
256 spin_unlock_irqrestore(&queue->lock, irqflags);
259 * Start from the TX done pointer, this guarentees that we will
260 * send out all frames in the correct order.
262 if (index_done < index) {
263 for (i = index_done; i < index; i++)
264 rt2x00usb_kick_tx_entry(&queue->entries[i]);
266 for (i = index_done; i < queue->limit; i++)
267 rt2x00usb_kick_tx_entry(&queue->entries[i]);
269 for (i = 0; i < index; i++)
270 rt2x00usb_kick_tx_entry(&queue->entries[i]);
273 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
278 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
280 struct queue_entry *entry = (struct queue_entry *)urb->context;
281 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
282 struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
285 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
286 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
290 * Check if the received data is simply too small
291 * to be actually valid, or if the urb is signaling
294 if (urb->actual_length < entry->queue->desc_size || urb->status) {
295 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
296 usb_submit_urb(urb, GFP_ATOMIC);
301 * Fill in desc fields of the skb descriptor
304 skbdesc->desc_len = entry->queue->desc_size;
307 * Send the frame to rt2x00lib for further processing.
309 rt2x00lib_rxdone(rt2x00dev, entry);
315 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
317 struct queue_entry_priv_usb *entry_priv;
318 struct queue_entry_priv_usb_bcn *bcn_priv;
319 struct data_queue *queue;
322 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
328 queue_for_each(rt2x00dev, queue) {
329 for (i = 0; i < queue->limit; i++) {
330 entry_priv = queue->entries[i].priv_data;
331 usb_kill_urb(entry_priv->urb);
336 * Kill guardian urb (if required by driver).
338 if (!test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
341 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
342 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
343 if (bcn_priv->guardian_urb)
344 usb_kill_urb(bcn_priv->guardian_urb);
347 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
350 * Device initialization handlers.
352 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
353 struct queue_entry *entry)
355 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
356 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
358 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
359 usb_rcvbulkpipe(usb_dev, 1),
360 entry->skb->data, entry->skb->len,
361 rt2x00usb_interrupt_rxdone, entry);
363 __set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
364 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
366 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
368 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
369 struct queue_entry *entry)
373 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
375 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
376 struct data_queue *queue)
378 struct queue_entry_priv_usb *entry_priv;
379 struct queue_entry_priv_usb_bcn *bcn_priv;
382 for (i = 0; i < queue->limit; i++) {
383 entry_priv = queue->entries[i].priv_data;
384 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
385 if (!entry_priv->urb)
390 * If this is not the beacon queue or
391 * no guardian byte was required for the beacon,
394 if (rt2x00dev->bcn != queue ||
395 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
398 for (i = 0; i < queue->limit; i++) {
399 bcn_priv = queue->entries[i].priv_data;
400 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
401 if (!bcn_priv->guardian_urb)
408 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
409 struct data_queue *queue)
411 struct queue_entry_priv_usb *entry_priv;
412 struct queue_entry_priv_usb_bcn *bcn_priv;
418 for (i = 0; i < queue->limit; i++) {
419 entry_priv = queue->entries[i].priv_data;
420 usb_kill_urb(entry_priv->urb);
421 usb_free_urb(entry_priv->urb);
425 * If this is not the beacon queue or
426 * no guardian byte was required for the beacon,
429 if (rt2x00dev->bcn != queue ||
430 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
433 for (i = 0; i < queue->limit; i++) {
434 bcn_priv = queue->entries[i].priv_data;
435 usb_kill_urb(bcn_priv->guardian_urb);
436 usb_free_urb(bcn_priv->guardian_urb);
440 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
442 struct data_queue *queue;
448 queue_for_each(rt2x00dev, queue) {
449 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
457 rt2x00usb_uninitialize(rt2x00dev);
461 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
463 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
465 struct data_queue *queue;
467 queue_for_each(rt2x00dev, queue)
468 rt2x00usb_free_urb(rt2x00dev, queue);
470 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
473 * USB driver handlers.
475 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
477 kfree(rt2x00dev->rf);
478 rt2x00dev->rf = NULL;
480 kfree(rt2x00dev->eeprom);
481 rt2x00dev->eeprom = NULL;
483 kfree(rt2x00dev->csr.cache);
484 rt2x00dev->csr.cache = NULL;
487 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
489 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
490 if (!rt2x00dev->csr.cache)
493 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
494 if (!rt2x00dev->eeprom)
497 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
504 ERROR_PROBE("Failed to allocate registers.\n");
506 rt2x00usb_free_reg(rt2x00dev);
511 int rt2x00usb_probe(struct usb_interface *usb_intf,
512 const struct usb_device_id *id)
514 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
515 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
516 struct ieee80211_hw *hw;
517 struct rt2x00_dev *rt2x00dev;
520 usb_dev = usb_get_dev(usb_dev);
522 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
524 ERROR_PROBE("Failed to allocate hardware.\n");
526 goto exit_put_device;
529 usb_set_intfdata(usb_intf, hw);
531 rt2x00dev = hw->priv;
532 rt2x00dev->dev = &usb_intf->dev;
533 rt2x00dev->ops = ops;
535 mutex_init(&rt2x00dev->usb_cache_mutex);
537 rt2x00dev->usb_maxpacket =
538 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
539 if (!rt2x00dev->usb_maxpacket)
540 rt2x00dev->usb_maxpacket = 1;
542 retval = rt2x00usb_alloc_reg(rt2x00dev);
544 goto exit_free_device;
546 retval = rt2x00lib_probe_dev(rt2x00dev);
553 rt2x00usb_free_reg(rt2x00dev);
556 ieee80211_free_hw(hw);
559 usb_put_dev(usb_dev);
561 usb_set_intfdata(usb_intf, NULL);
565 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
567 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
569 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
570 struct rt2x00_dev *rt2x00dev = hw->priv;
573 * Free all allocated data.
575 rt2x00lib_remove_dev(rt2x00dev);
576 rt2x00usb_free_reg(rt2x00dev);
577 ieee80211_free_hw(hw);
580 * Free the USB device data.
582 usb_set_intfdata(usb_intf, NULL);
583 usb_put_dev(interface_to_usbdev(usb_intf));
585 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
588 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
590 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
591 struct rt2x00_dev *rt2x00dev = hw->priv;
594 retval = rt2x00lib_suspend(rt2x00dev, state);
598 rt2x00usb_free_reg(rt2x00dev);
601 * Decrease usbdev refcount.
603 usb_put_dev(interface_to_usbdev(usb_intf));
607 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
609 int rt2x00usb_resume(struct usb_interface *usb_intf)
611 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
612 struct rt2x00_dev *rt2x00dev = hw->priv;
615 usb_get_dev(interface_to_usbdev(usb_intf));
617 retval = rt2x00usb_alloc_reg(rt2x00dev);
621 retval = rt2x00lib_resume(rt2x00dev);
628 rt2x00usb_free_reg(rt2x00dev);
632 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
633 #endif /* CONFIG_PM */
636 * rt2x00usb module information.
638 MODULE_AUTHOR(DRV_PROJECT);
639 MODULE_VERSION(DRV_VERSION);
640 MODULE_DESCRIPTION("rt2x00 usb library");
641 MODULE_LICENSE("GPL");