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;
239 if (!test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
243 * USB devices cannot blindly pass the skb->len as the
244 * length of the data to usb_fill_bulk_urb. Pass the skb
245 * to the driver to determine what the length should be.
247 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
249 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
250 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
251 entry->skb->data, length,
252 rt2x00usb_interrupt_txdone, entry);
254 if (usb_submit_urb(entry_priv->urb, GFP_ATOMIC)) {
255 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
256 rt2x00lib_dmadone(entry);
260 void rt2x00usb_kick_tx_queue(struct data_queue *queue)
262 rt2x00queue_for_each_entry(queue, Q_INDEX_DONE, Q_INDEX,
263 rt2x00usb_kick_tx_entry);
265 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
267 static void rt2x00usb_kill_tx_entry(struct queue_entry *entry)
269 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
270 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
271 struct queue_entry_priv_usb_bcn *bcn_priv = entry->priv_data;
273 if (!test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
276 usb_kill_urb(entry_priv->urb);
279 * Kill guardian urb (if required by driver).
281 if ((entry->queue->qid == QID_BEACON) &&
282 (test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags)))
283 usb_kill_urb(bcn_priv->guardian_urb);
286 void rt2x00usb_kill_tx_queue(struct data_queue *queue)
288 rt2x00queue_for_each_entry(queue, Q_INDEX_DONE, Q_INDEX,
289 rt2x00usb_kill_tx_entry);
291 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue);
293 static void rt2x00usb_watchdog_tx_dma(struct data_queue *queue)
295 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
296 unsigned short threshold = queue->threshold;
298 WARNING(queue->rt2x00dev, "TX queue %d DMA timed out,"
299 " invoke forced forced reset", queue->qid);
302 * Temporarily disable the TX queue, this will force mac80211
303 * to use the other queues until this queue has been restored.
305 * Set the queue threshold to the queue limit. This prevents the
306 * queue from being enabled during the txdone handler.
308 queue->threshold = queue->limit;
309 ieee80211_stop_queue(rt2x00dev->hw, queue->qid);
312 * Kill all entries in the queue, afterwards we need to
313 * wait a bit for all URBs to be cancelled.
315 rt2x00usb_kill_tx_queue(queue);
318 * In case that a driver has overriden the txdone_work
319 * function, we invoke the TX done through there.
321 rt2x00dev->txdone_work.func(&rt2x00dev->txdone_work);
324 * The queue has been reset, and mac80211 is allowed to use the
327 queue->threshold = threshold;
328 ieee80211_wake_queue(rt2x00dev->hw, queue->qid);
331 static void rt2x00usb_watchdog_tx_status(struct data_queue *queue)
333 WARNING(queue->rt2x00dev, "TX queue %d status timed out,"
334 " invoke forced tx handler", queue->qid);
336 ieee80211_queue_work(queue->rt2x00dev->hw, &queue->rt2x00dev->txdone_work);
339 void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev)
341 struct data_queue *queue;
343 tx_queue_for_each(rt2x00dev, queue) {
344 if (!rt2x00queue_empty(queue)) {
345 if (rt2x00queue_dma_timeout(queue))
346 rt2x00usb_watchdog_tx_dma(queue);
347 if (rt2x00queue_status_timeout(queue))
348 rt2x00usb_watchdog_tx_status(queue);
352 EXPORT_SYMBOL_GPL(rt2x00usb_watchdog);
357 static void rt2x00usb_work_rxdone(struct work_struct *work)
359 struct rt2x00_dev *rt2x00dev =
360 container_of(work, struct rt2x00_dev, rxdone_work);
361 struct queue_entry *entry;
362 struct skb_frame_desc *skbdesc;
365 while (!rt2x00queue_empty(rt2x00dev->rx)) {
366 entry = rt2x00queue_get_entry(rt2x00dev->rx, Q_INDEX_DONE);
368 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
372 * Fill in desc fields of the skb descriptor
374 skbdesc = get_skb_frame_desc(entry->skb);
376 skbdesc->desc_len = entry->queue->desc_size;
379 * Send the frame to rt2x00lib for further processing.
381 rt2x00lib_rxdone(entry);
385 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
387 struct queue_entry *entry = (struct queue_entry *)urb->context;
388 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
390 if (!test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
394 * Report the frame as DMA done
396 rt2x00lib_dmadone(entry);
399 * Check if the received data is simply too small
400 * to be actually valid, or if the urb is signaling
403 if (urb->actual_length < entry->queue->desc_size || urb->status)
404 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
407 * Schedule the delayed work for reading the RX status
410 ieee80211_queue_work(rt2x00dev->hw, &rt2x00dev->rxdone_work);
416 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
418 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
422 * The USB version of kill_tx_queue also works
425 rt2x00dev->ops->lib->kill_tx_queue(rt2x00dev->rx);
427 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
430 * Device initialization handlers.
432 void rt2x00usb_clear_entry(struct queue_entry *entry)
434 struct usb_device *usb_dev =
435 to_usb_device_intf(entry->queue->rt2x00dev->dev);
436 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
441 if (entry->queue->qid == QID_RX) {
442 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
443 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
444 entry->skb->data, entry->skb->len,
445 rt2x00usb_interrupt_rxdone, entry);
447 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
448 if (usb_submit_urb(entry_priv->urb, GFP_ATOMIC)) {
449 set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
450 rt2x00lib_dmadone(entry);
454 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
456 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
457 struct usb_endpoint_descriptor *ep_desc)
459 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
462 queue->usb_endpoint = usb_endpoint_num(ep_desc);
464 if (queue->qid == QID_RX) {
465 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
466 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
468 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
469 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
472 if (!queue->usb_maxpacket)
473 queue->usb_maxpacket = 1;
476 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
478 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
479 struct usb_host_interface *intf_desc = intf->cur_altsetting;
480 struct usb_endpoint_descriptor *ep_desc;
481 struct data_queue *queue = rt2x00dev->tx;
482 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
486 * Walk through all available endpoints to search for "bulk in"
487 * and "bulk out" endpoints. When we find such endpoints collect
488 * the information we need from the descriptor and assign it
491 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
492 ep_desc = &intf_desc->endpoint[i].desc;
494 if (usb_endpoint_is_bulk_in(ep_desc)) {
495 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
496 } else if (usb_endpoint_is_bulk_out(ep_desc) &&
497 (queue != queue_end(rt2x00dev))) {
498 rt2x00usb_assign_endpoint(queue, ep_desc);
499 queue = queue_next(queue);
501 tx_ep_desc = ep_desc;
506 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
508 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
509 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
514 * It might be possible not all queues have a dedicated endpoint.
515 * Loop through all TX queues and copy the endpoint information
516 * which we have gathered from already assigned endpoints.
518 txall_queue_for_each(rt2x00dev, queue) {
519 if (!queue->usb_endpoint)
520 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
526 static int rt2x00usb_alloc_entries(struct data_queue *queue)
528 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
529 struct queue_entry_priv_usb *entry_priv;
530 struct queue_entry_priv_usb_bcn *bcn_priv;
533 for (i = 0; i < queue->limit; i++) {
534 entry_priv = queue->entries[i].priv_data;
535 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
536 if (!entry_priv->urb)
541 * If this is not the beacon queue or
542 * no guardian byte was required for the beacon,
545 if (queue->qid != QID_BEACON ||
546 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
549 for (i = 0; i < queue->limit; i++) {
550 bcn_priv = queue->entries[i].priv_data;
551 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
552 if (!bcn_priv->guardian_urb)
559 static void rt2x00usb_free_entries(struct data_queue *queue)
561 struct rt2x00_dev *rt2x00dev = queue->rt2x00dev;
562 struct queue_entry_priv_usb *entry_priv;
563 struct queue_entry_priv_usb_bcn *bcn_priv;
569 for (i = 0; i < queue->limit; i++) {
570 entry_priv = queue->entries[i].priv_data;
571 usb_kill_urb(entry_priv->urb);
572 usb_free_urb(entry_priv->urb);
576 * If this is not the beacon queue or
577 * no guardian byte was required for the beacon,
580 if (queue->qid != QID_BEACON ||
581 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
584 for (i = 0; i < queue->limit; i++) {
585 bcn_priv = queue->entries[i].priv_data;
586 usb_kill_urb(bcn_priv->guardian_urb);
587 usb_free_urb(bcn_priv->guardian_urb);
591 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
593 struct data_queue *queue;
597 * Find endpoints for each queue
599 status = rt2x00usb_find_endpoints(rt2x00dev);
606 queue_for_each(rt2x00dev, queue) {
607 status = rt2x00usb_alloc_entries(queue);
615 rt2x00usb_uninitialize(rt2x00dev);
619 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
621 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
623 struct data_queue *queue;
625 queue_for_each(rt2x00dev, queue)
626 rt2x00usb_free_entries(queue);
628 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
631 * USB driver handlers.
633 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
635 kfree(rt2x00dev->rf);
636 rt2x00dev->rf = NULL;
638 kfree(rt2x00dev->eeprom);
639 rt2x00dev->eeprom = NULL;
641 kfree(rt2x00dev->csr.cache);
642 rt2x00dev->csr.cache = NULL;
645 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
647 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
648 if (!rt2x00dev->csr.cache)
651 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
652 if (!rt2x00dev->eeprom)
655 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
662 ERROR_PROBE("Failed to allocate registers.\n");
664 rt2x00usb_free_reg(rt2x00dev);
669 int rt2x00usb_probe(struct usb_interface *usb_intf,
670 const struct usb_device_id *id)
672 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
673 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
674 struct ieee80211_hw *hw;
675 struct rt2x00_dev *rt2x00dev;
678 usb_dev = usb_get_dev(usb_dev);
680 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
682 ERROR_PROBE("Failed to allocate hardware.\n");
684 goto exit_put_device;
687 usb_set_intfdata(usb_intf, hw);
689 rt2x00dev = hw->priv;
690 rt2x00dev->dev = &usb_intf->dev;
691 rt2x00dev->ops = ops;
694 rt2x00_set_chip_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
696 INIT_WORK(&rt2x00dev->rxdone_work, rt2x00usb_work_rxdone);
697 INIT_WORK(&rt2x00dev->txdone_work, rt2x00usb_work_txdone);
699 retval = rt2x00usb_alloc_reg(rt2x00dev);
701 goto exit_free_device;
703 retval = rt2x00lib_probe_dev(rt2x00dev);
710 rt2x00usb_free_reg(rt2x00dev);
713 ieee80211_free_hw(hw);
716 usb_put_dev(usb_dev);
718 usb_set_intfdata(usb_intf, NULL);
722 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
724 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
726 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
727 struct rt2x00_dev *rt2x00dev = hw->priv;
730 * Free all allocated data.
732 rt2x00lib_remove_dev(rt2x00dev);
733 rt2x00usb_free_reg(rt2x00dev);
734 ieee80211_free_hw(hw);
737 * Free the USB device data.
739 usb_set_intfdata(usb_intf, NULL);
740 usb_put_dev(interface_to_usbdev(usb_intf));
742 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
745 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
747 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
748 struct rt2x00_dev *rt2x00dev = hw->priv;
751 retval = rt2x00lib_suspend(rt2x00dev, state);
756 * Decrease usbdev refcount.
758 usb_put_dev(interface_to_usbdev(usb_intf));
762 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
764 int rt2x00usb_resume(struct usb_interface *usb_intf)
766 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
767 struct rt2x00_dev *rt2x00dev = hw->priv;
769 usb_get_dev(interface_to_usbdev(usb_intf));
771 return rt2x00lib_resume(rt2x00dev);
773 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
774 #endif /* CONFIG_PM */
777 * rt2x00usb module information.
779 MODULE_AUTHOR(DRV_PROJECT);
780 MODULE_VERSION(DRV_VERSION);
781 MODULE_DESCRIPTION("rt2x00 usb library");
782 MODULE_LICENSE("GPL");