2 Copyright (C) 2010 Willow Garage <http://www.willowgarage.com>
3 Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
4 <http://rt2x00.serialmonkey.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the
18 Free Software Foundation, Inc.,
19 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 Abstract: rt2x00 generic usb device routines.
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/usb.h>
31 #include <linux/bug.h>
34 #include "rt2x00usb.h"
37 * Interfacing with the HW.
39 int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
40 const u8 request, const u8 requesttype,
41 const u16 offset, const u16 value,
42 void *buffer, const u16 buffer_length,
45 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
49 (requesttype == USB_VENDOR_REQUEST_IN) ?
50 usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
52 if (!test_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags))
55 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
56 status = usb_control_msg(usb_dev, pipe, request, requesttype,
57 value, offset, buffer, buffer_length,
64 * -ENODEV: Device has disappeared, no point continuing.
65 * All other errors: Try again.
67 else if (status == -ENODEV) {
68 clear_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags);
74 "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
75 request, offset, status);
79 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
81 int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
82 const u8 request, const u8 requesttype,
83 const u16 offset, void *buffer,
84 const u16 buffer_length, const int timeout)
88 BUG_ON(!mutex_is_locked(&rt2x00dev->csr_mutex));
91 * Check for Cache availability.
93 if (unlikely(!rt2x00dev->csr.cache || buffer_length > CSR_CACHE_SIZE)) {
94 ERROR(rt2x00dev, "CSR cache not available.\n");
98 if (requesttype == USB_VENDOR_REQUEST_OUT)
99 memcpy(rt2x00dev->csr.cache, buffer, buffer_length);
101 status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
102 offset, 0, rt2x00dev->csr.cache,
103 buffer_length, timeout);
105 if (!status && requesttype == USB_VENDOR_REQUEST_IN)
106 memcpy(buffer, rt2x00dev->csr.cache, buffer_length);
110 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock);
112 int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
113 const u8 request, const u8 requesttype,
114 const u16 offset, void *buffer,
115 const u16 buffer_length, const int timeout)
121 mutex_lock(&rt2x00dev->csr_mutex);
126 while (len && !status) {
127 bsize = min_t(u16, CSR_CACHE_SIZE, len);
128 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
129 requesttype, off, tb,
137 mutex_unlock(&rt2x00dev->csr_mutex);
141 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
143 int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
144 const unsigned int offset,
145 const struct rt2x00_field32 field,
150 if (!test_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags))
153 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
154 rt2x00usb_register_read_lock(rt2x00dev, offset, reg);
155 if (!rt2x00_get_field32(*reg, field))
157 udelay(REGISTER_BUSY_DELAY);
160 ERROR(rt2x00dev, "Indirect register access failed: "
161 "offset=0x%.08x, value=0x%.08x\n", offset, *reg);
166 EXPORT_SYMBOL_GPL(rt2x00usb_regbusy_read);
171 static void rt2x00usb_work_txdone_entry(struct queue_entry *entry)
174 * If the transfer to hardware succeeded, it does not mean the
175 * frame was send out correctly. It only means the frame
176 * was succesfully pushed to the hardware, we have no
177 * way to determine the transmission status right now.
178 * (Only indirectly by looking at the failed TX counters
181 if (test_bit(ENTRY_DATA_IO_FAILED, &entry->flags))
182 rt2x00lib_txdone_noinfo(entry, TXDONE_FAILURE);
184 rt2x00lib_txdone_noinfo(entry, TXDONE_UNKNOWN);
187 static void rt2x00usb_work_txdone(struct work_struct *work)
189 struct rt2x00_dev *rt2x00dev =
190 container_of(work, struct rt2x00_dev, txdone_work);
191 struct data_queue *queue;
192 struct queue_entry *entry;
194 tx_queue_for_each(rt2x00dev, queue) {
195 while (!rt2x00queue_empty(queue)) {
196 entry = rt2x00queue_get_entry(queue, Q_INDEX_DONE);
198 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
201 rt2x00usb_work_txdone_entry(entry);
206 static void rt2x00usb_interrupt_txdone(struct urb *urb)
208 struct queue_entry *entry = (struct queue_entry *)urb->context;
209 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
211 if (!test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
215 * Report the frame as DMA done
217 rt2x00lib_dmadone(entry);
220 * Check if the frame was correctly uploaded
223 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
226 * Schedule the delayed work for reading the TX status
229 ieee80211_queue_work(rt2x00dev->hw, &rt2x00dev->txdone_work);
232 static void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
234 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
235 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
236 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
240 if (!test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
244 * USB devices cannot blindly pass the skb->len as the
245 * length of the data to usb_fill_bulk_urb. Pass the skb
246 * to the driver to determine what the length should be.
248 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
250 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
251 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
252 entry->skb->data, length,
253 rt2x00usb_interrupt_txdone, entry);
255 status = usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
257 if (status == -ENODEV)
258 clear_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags);
259 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
260 rt2x00lib_dmadone(entry);
264 void rt2x00usb_kick_tx_queue(struct data_queue *queue)
266 rt2x00queue_for_each_entry(queue, Q_INDEX_DONE, Q_INDEX,
267 rt2x00usb_kick_tx_entry);
269 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
271 static void rt2x00usb_kill_tx_entry(struct queue_entry *entry)
273 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
274 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
275 struct queue_entry_priv_usb_bcn *bcn_priv = entry->priv_data;
277 if (!test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
280 usb_kill_urb(entry_priv->urb);
283 * Kill guardian urb (if required by driver).
285 if ((entry->queue->qid == QID_BEACON) &&
286 (test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags)))
287 usb_kill_urb(bcn_priv->guardian_urb);
290 void rt2x00usb_kill_tx_queue(struct data_queue *queue)
292 rt2x00queue_for_each_entry(queue, Q_INDEX_DONE, Q_INDEX,
293 rt2x00usb_kill_tx_entry);
295 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue);
297 static void rt2x00usb_watchdog_tx_dma(struct data_queue *queue)
299 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
300 unsigned short threshold = queue->threshold;
302 WARNING(queue->rt2x00dev, "TX queue %d DMA timed out,"
303 " invoke forced forced reset", queue->qid);
306 * Temporarily disable the TX queue, this will force mac80211
307 * to use the other queues until this queue has been restored.
309 * Set the queue threshold to the queue limit. This prevents the
310 * queue from being enabled during the txdone handler.
312 queue->threshold = queue->limit;
313 ieee80211_stop_queue(rt2x00dev->hw, queue->qid);
316 * Kill all entries in the queue, afterwards we need to
317 * wait a bit for all URBs to be cancelled.
319 rt2x00usb_kill_tx_queue(queue);
322 * In case that a driver has overriden the txdone_work
323 * function, we invoke the TX done through there.
325 rt2x00dev->txdone_work.func(&rt2x00dev->txdone_work);
328 * The queue has been reset, and mac80211 is allowed to use the
331 queue->threshold = threshold;
332 ieee80211_wake_queue(rt2x00dev->hw, queue->qid);
335 static void rt2x00usb_watchdog_tx_status(struct data_queue *queue)
337 WARNING(queue->rt2x00dev, "TX queue %d status timed out,"
338 " invoke forced tx handler", queue->qid);
340 ieee80211_queue_work(queue->rt2x00dev->hw, &queue->rt2x00dev->txdone_work);
343 void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev)
345 struct data_queue *queue;
347 tx_queue_for_each(rt2x00dev, queue) {
348 if (!rt2x00queue_empty(queue)) {
349 if (rt2x00queue_dma_timeout(queue))
350 rt2x00usb_watchdog_tx_dma(queue);
351 if (rt2x00queue_status_timeout(queue))
352 rt2x00usb_watchdog_tx_status(queue);
356 EXPORT_SYMBOL_GPL(rt2x00usb_watchdog);
361 static void rt2x00usb_work_rxdone(struct work_struct *work)
363 struct rt2x00_dev *rt2x00dev =
364 container_of(work, struct rt2x00_dev, rxdone_work);
365 struct queue_entry *entry;
366 struct skb_frame_desc *skbdesc;
369 while (!rt2x00queue_empty(rt2x00dev->rx)) {
370 entry = rt2x00queue_get_entry(rt2x00dev->rx, Q_INDEX_DONE);
372 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
376 * Fill in desc fields of the skb descriptor
378 skbdesc = get_skb_frame_desc(entry->skb);
380 skbdesc->desc_len = entry->queue->desc_size;
383 * Send the frame to rt2x00lib for further processing.
385 rt2x00lib_rxdone(entry);
389 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
391 struct queue_entry *entry = (struct queue_entry *)urb->context;
392 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
394 if (!test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
398 * Report the frame as DMA done
400 rt2x00lib_dmadone(entry);
403 * Check if the received data is simply too small
404 * to be actually valid, or if the urb is signaling
407 if (urb->actual_length < entry->queue->desc_size || urb->status)
408 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
411 * Schedule the delayed work for reading the RX status
414 ieee80211_queue_work(rt2x00dev->hw, &rt2x00dev->rxdone_work);
420 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
422 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
426 * The USB version of kill_tx_queue also works
429 rt2x00dev->ops->lib->kill_tx_queue(rt2x00dev->rx);
431 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
434 * Device initialization handlers.
436 void rt2x00usb_clear_entry(struct queue_entry *entry)
438 struct usb_device *usb_dev =
439 to_usb_device_intf(entry->queue->rt2x00dev->dev);
440 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
446 if (entry->queue->qid == QID_RX) {
447 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
448 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
449 entry->skb->data, entry->skb->len,
450 rt2x00usb_interrupt_rxdone, entry);
452 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
454 status = usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
456 if (status == -ENODEV)
457 clear_bit(DEVICE_STATE_PRESENT,
458 &entry->queue->rt2x00dev->flags);
459 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
460 rt2x00lib_dmadone(entry);
464 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
466 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
467 struct usb_endpoint_descriptor *ep_desc)
469 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
472 queue->usb_endpoint = usb_endpoint_num(ep_desc);
474 if (queue->qid == QID_RX) {
475 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
476 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
478 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
479 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
482 if (!queue->usb_maxpacket)
483 queue->usb_maxpacket = 1;
486 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
488 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
489 struct usb_host_interface *intf_desc = intf->cur_altsetting;
490 struct usb_endpoint_descriptor *ep_desc;
491 struct data_queue *queue = rt2x00dev->tx;
492 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
496 * Walk through all available endpoints to search for "bulk in"
497 * and "bulk out" endpoints. When we find such endpoints collect
498 * the information we need from the descriptor and assign it
501 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
502 ep_desc = &intf_desc->endpoint[i].desc;
504 if (usb_endpoint_is_bulk_in(ep_desc)) {
505 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
506 } else if (usb_endpoint_is_bulk_out(ep_desc) &&
507 (queue != queue_end(rt2x00dev))) {
508 rt2x00usb_assign_endpoint(queue, ep_desc);
509 queue = queue_next(queue);
511 tx_ep_desc = ep_desc;
516 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
518 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
519 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
524 * It might be possible not all queues have a dedicated endpoint.
525 * Loop through all TX queues and copy the endpoint information
526 * which we have gathered from already assigned endpoints.
528 txall_queue_for_each(rt2x00dev, queue) {
529 if (!queue->usb_endpoint)
530 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
536 static int rt2x00usb_alloc_entries(struct data_queue *queue)
538 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
539 struct queue_entry_priv_usb *entry_priv;
540 struct queue_entry_priv_usb_bcn *bcn_priv;
543 for (i = 0; i < queue->limit; i++) {
544 entry_priv = queue->entries[i].priv_data;
545 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
546 if (!entry_priv->urb)
551 * If this is not the beacon queue or
552 * no guardian byte was required for the beacon,
555 if (queue->qid != QID_BEACON ||
556 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
559 for (i = 0; i < queue->limit; i++) {
560 bcn_priv = queue->entries[i].priv_data;
561 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
562 if (!bcn_priv->guardian_urb)
569 static void rt2x00usb_free_entries(struct data_queue *queue)
571 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
572 struct queue_entry_priv_usb *entry_priv;
573 struct queue_entry_priv_usb_bcn *bcn_priv;
579 for (i = 0; i < queue->limit; i++) {
580 entry_priv = queue->entries[i].priv_data;
581 usb_kill_urb(entry_priv->urb);
582 usb_free_urb(entry_priv->urb);
586 * If this is not the beacon queue or
587 * no guardian byte was required for the beacon,
590 if (queue->qid != QID_BEACON ||
591 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
594 for (i = 0; i < queue->limit; i++) {
595 bcn_priv = queue->entries[i].priv_data;
596 usb_kill_urb(bcn_priv->guardian_urb);
597 usb_free_urb(bcn_priv->guardian_urb);
601 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
603 struct data_queue *queue;
607 * Find endpoints for each queue
609 status = rt2x00usb_find_endpoints(rt2x00dev);
616 queue_for_each(rt2x00dev, queue) {
617 status = rt2x00usb_alloc_entries(queue);
625 rt2x00usb_uninitialize(rt2x00dev);
629 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
631 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
633 struct data_queue *queue;
635 queue_for_each(rt2x00dev, queue)
636 rt2x00usb_free_entries(queue);
638 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
641 * USB driver handlers.
643 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
645 kfree(rt2x00dev->rf);
646 rt2x00dev->rf = NULL;
648 kfree(rt2x00dev->eeprom);
649 rt2x00dev->eeprom = NULL;
651 kfree(rt2x00dev->csr.cache);
652 rt2x00dev->csr.cache = NULL;
655 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
657 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
658 if (!rt2x00dev->csr.cache)
661 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
662 if (!rt2x00dev->eeprom)
665 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
672 ERROR_PROBE("Failed to allocate registers.\n");
674 rt2x00usb_free_reg(rt2x00dev);
679 int rt2x00usb_probe(struct usb_interface *usb_intf,
680 const struct usb_device_id *id)
682 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
683 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
684 struct ieee80211_hw *hw;
685 struct rt2x00_dev *rt2x00dev;
688 usb_dev = usb_get_dev(usb_dev);
690 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
692 ERROR_PROBE("Failed to allocate hardware.\n");
694 goto exit_put_device;
697 usb_set_intfdata(usb_intf, hw);
699 rt2x00dev = hw->priv;
700 rt2x00dev->dev = &usb_intf->dev;
701 rt2x00dev->ops = ops;
704 rt2x00_set_chip_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
706 INIT_WORK(&rt2x00dev->rxdone_work, rt2x00usb_work_rxdone);
707 INIT_WORK(&rt2x00dev->txdone_work, rt2x00usb_work_txdone);
709 retval = rt2x00usb_alloc_reg(rt2x00dev);
711 goto exit_free_device;
713 retval = rt2x00lib_probe_dev(rt2x00dev);
720 rt2x00usb_free_reg(rt2x00dev);
723 ieee80211_free_hw(hw);
726 usb_put_dev(usb_dev);
728 usb_set_intfdata(usb_intf, NULL);
732 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
734 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
736 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
737 struct rt2x00_dev *rt2x00dev = hw->priv;
740 * Free all allocated data.
742 rt2x00lib_remove_dev(rt2x00dev);
743 rt2x00usb_free_reg(rt2x00dev);
744 ieee80211_free_hw(hw);
747 * Free the USB device data.
749 usb_set_intfdata(usb_intf, NULL);
750 usb_put_dev(interface_to_usbdev(usb_intf));
752 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
755 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
757 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
758 struct rt2x00_dev *rt2x00dev = hw->priv;
761 retval = rt2x00lib_suspend(rt2x00dev, state);
766 * Decrease usbdev refcount.
768 usb_put_dev(interface_to_usbdev(usb_intf));
772 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
774 int rt2x00usb_resume(struct usb_interface *usb_intf)
776 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
777 struct rt2x00_dev *rt2x00dev = hw->priv;
779 usb_get_dev(interface_to_usbdev(usb_intf));
781 return rt2x00lib_resume(rt2x00dev);
783 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
784 #endif /* CONFIG_PM */
787 * rt2x00usb module information.
789 MODULE_AUTHOR(DRV_PROJECT);
790 MODULE_VERSION(DRV_VERSION);
791 MODULE_DESCRIPTION("rt2x00 usb library");
792 MODULE_LICENSE("GPL");