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, const 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_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
167 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
171 * Obtain the status about this packet.
172 * Note that when the status is 0 it does not mean the
173 * frame was send out correctly. It only means the frame
174 * was succesfully pushed to the hardware, we have no
175 * way to determine the transmission status right now.
176 * (Only indirectly by looking at the failed TX counters
181 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
183 __set_bit(TXDONE_FAILURE, &txdesc.flags);
186 rt2x00lib_txdone(entry, &txdesc);
189 int rt2x00usb_write_tx_data(struct queue_entry *entry)
191 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
192 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
193 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
194 struct skb_frame_desc *skbdesc;
198 * Add the descriptor in front of the skb.
200 skb_push(entry->skb, entry->queue->desc_size);
201 memset(entry->skb->data, 0, entry->queue->desc_size);
204 * Fill in skb descriptor
206 skbdesc = get_skb_frame_desc(entry->skb);
207 skbdesc->desc = entry->skb->data;
208 skbdesc->desc_len = entry->queue->desc_size;
211 * USB devices cannot blindly pass the skb->len as the
212 * length of the data to usb_fill_bulk_urb. Pass the skb
213 * to the driver to determine what the length should be.
215 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, entry->skb);
217 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
218 usb_sndbulkpipe(usb_dev, 1),
219 entry->skb->data, length,
220 rt2x00usb_interrupt_txdone, entry);
223 * Make sure the skb->data pointer points to the frame, not the
226 skb_pull(entry->skb, entry->queue->desc_size);
230 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
232 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
234 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
236 if (test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
237 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
240 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
241 const enum data_queue_qid qid)
243 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
244 unsigned long irqflags;
246 unsigned int index_done;
250 * Only protect the range we are going to loop over,
251 * if during our loop a extra entry is set to pending
252 * it should not be kicked during this run, since it
253 * is part of another TX operation.
255 spin_lock_irqsave(&queue->lock, irqflags);
256 index = queue->index[Q_INDEX];
257 index_done = queue->index[Q_INDEX_DONE];
258 spin_unlock_irqrestore(&queue->lock, irqflags);
261 * Start from the TX done pointer, this guarentees that we will
262 * send out all frames in the correct order.
264 if (index_done < index) {
265 for (i = index_done; i < index; i++)
266 rt2x00usb_kick_tx_entry(&queue->entries[i]);
268 for (i = index_done; i < queue->limit; i++)
269 rt2x00usb_kick_tx_entry(&queue->entries[i]);
271 for (i = 0; i < index; i++)
272 rt2x00usb_kick_tx_entry(&queue->entries[i]);
275 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
280 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
282 struct queue_entry *entry = (struct queue_entry *)urb->context;
283 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
284 struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
287 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
288 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
292 * Check if the received data is simply too small
293 * to be actually valid, or if the urb is signaling
296 if (urb->actual_length < entry->queue->desc_size || urb->status) {
297 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
298 usb_submit_urb(urb, GFP_ATOMIC);
303 * Fill in desc fields of the skb descriptor
306 skbdesc->desc_len = entry->queue->desc_size;
309 * Send the frame to rt2x00lib for further processing.
311 rt2x00lib_rxdone(rt2x00dev, entry);
317 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
319 struct queue_entry_priv_usb *entry_priv;
320 struct queue_entry_priv_usb_bcn *bcn_priv;
321 struct data_queue *queue;
324 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
330 queue_for_each(rt2x00dev, queue) {
331 for (i = 0; i < queue->limit; i++) {
332 entry_priv = queue->entries[i].priv_data;
333 usb_kill_urb(entry_priv->urb);
338 * Kill guardian urb (if required by driver).
340 if (!test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
343 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
344 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
345 if (bcn_priv->guardian_urb)
346 usb_kill_urb(bcn_priv->guardian_urb);
349 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
352 * Device initialization handlers.
354 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
355 struct queue_entry *entry)
357 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
358 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
360 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
361 usb_rcvbulkpipe(usb_dev, 1),
362 entry->skb->data, entry->skb->len,
363 rt2x00usb_interrupt_rxdone, entry);
365 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
366 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
368 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry);
370 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
371 struct queue_entry *entry)
375 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry);
377 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
378 struct data_queue *queue)
380 struct queue_entry_priv_usb *entry_priv;
381 struct queue_entry_priv_usb_bcn *bcn_priv;
384 for (i = 0; i < queue->limit; i++) {
385 entry_priv = queue->entries[i].priv_data;
386 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
387 if (!entry_priv->urb)
392 * If this is not the beacon queue or
393 * no guardian byte was required for the beacon,
396 if (rt2x00dev->bcn != queue ||
397 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
400 for (i = 0; i < queue->limit; i++) {
401 bcn_priv = queue->entries[i].priv_data;
402 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
403 if (!bcn_priv->guardian_urb)
410 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
411 struct data_queue *queue)
413 struct queue_entry_priv_usb *entry_priv;
414 struct queue_entry_priv_usb_bcn *bcn_priv;
420 for (i = 0; i < queue->limit; i++) {
421 entry_priv = queue->entries[i].priv_data;
422 usb_kill_urb(entry_priv->urb);
423 usb_free_urb(entry_priv->urb);
427 * If this is not the beacon queue or
428 * no guardian byte was required for the beacon,
431 if (rt2x00dev->bcn != queue ||
432 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
435 for (i = 0; i < queue->limit; i++) {
436 bcn_priv = queue->entries[i].priv_data;
437 usb_kill_urb(bcn_priv->guardian_urb);
438 usb_free_urb(bcn_priv->guardian_urb);
442 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
444 struct data_queue *queue;
450 queue_for_each(rt2x00dev, queue) {
451 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
459 rt2x00usb_uninitialize(rt2x00dev);
463 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
465 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
467 struct data_queue *queue;
469 queue_for_each(rt2x00dev, queue)
470 rt2x00usb_free_urb(rt2x00dev, queue);
472 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
475 * USB driver handlers.
477 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
479 kfree(rt2x00dev->rf);
480 rt2x00dev->rf = NULL;
482 kfree(rt2x00dev->eeprom);
483 rt2x00dev->eeprom = NULL;
485 kfree(rt2x00dev->csr.cache);
486 rt2x00dev->csr.cache = NULL;
489 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
491 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
492 if (!rt2x00dev->csr.cache)
495 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
496 if (!rt2x00dev->eeprom)
499 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
506 ERROR_PROBE("Failed to allocate registers.\n");
508 rt2x00usb_free_reg(rt2x00dev);
513 int rt2x00usb_probe(struct usb_interface *usb_intf,
514 const struct usb_device_id *id)
516 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
517 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
518 struct ieee80211_hw *hw;
519 struct rt2x00_dev *rt2x00dev;
522 usb_dev = usb_get_dev(usb_dev);
524 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
526 ERROR_PROBE("Failed to allocate hardware.\n");
528 goto exit_put_device;
531 usb_set_intfdata(usb_intf, hw);
533 rt2x00dev = hw->priv;
534 rt2x00dev->dev = &usb_intf->dev;
535 rt2x00dev->ops = ops;
537 mutex_init(&rt2x00dev->usb_cache_mutex);
539 rt2x00dev->usb_maxpacket =
540 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
541 if (!rt2x00dev->usb_maxpacket)
542 rt2x00dev->usb_maxpacket = 1;
544 retval = rt2x00usb_alloc_reg(rt2x00dev);
546 goto exit_free_device;
548 retval = rt2x00lib_probe_dev(rt2x00dev);
555 rt2x00usb_free_reg(rt2x00dev);
558 ieee80211_free_hw(hw);
561 usb_put_dev(usb_dev);
563 usb_set_intfdata(usb_intf, NULL);
567 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
569 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
571 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
572 struct rt2x00_dev *rt2x00dev = hw->priv;
575 * Free all allocated data.
577 rt2x00lib_remove_dev(rt2x00dev);
578 rt2x00usb_free_reg(rt2x00dev);
579 ieee80211_free_hw(hw);
582 * Free the USB device data.
584 usb_set_intfdata(usb_intf, NULL);
585 usb_put_dev(interface_to_usbdev(usb_intf));
587 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
590 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
592 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
593 struct rt2x00_dev *rt2x00dev = hw->priv;
596 retval = rt2x00lib_suspend(rt2x00dev, state);
600 rt2x00usb_free_reg(rt2x00dev);
603 * Decrease usbdev refcount.
605 usb_put_dev(interface_to_usbdev(usb_intf));
609 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
611 int rt2x00usb_resume(struct usb_interface *usb_intf)
613 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
614 struct rt2x00_dev *rt2x00dev = hw->priv;
617 usb_get_dev(interface_to_usbdev(usb_intf));
619 retval = rt2x00usb_alloc_reg(rt2x00dev);
623 retval = rt2x00lib_resume(rt2x00dev);
630 rt2x00usb_free_reg(rt2x00dev);
634 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
635 #endif /* CONFIG_PM */
638 * rt2x00usb module information.
640 MODULE_AUTHOR(DRV_PROJECT);
641 MODULE_VERSION(DRV_VERSION);
642 MODULE_DESCRIPTION("rt2x00 usb library");
643 MODULE_LICENSE("GPL");