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_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
212 !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
216 * Check if the frame was correctly uploaded
219 __set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
222 * Schedule the delayed work for reading the TX status
225 ieee80211_queue_work(rt2x00dev->hw, &rt2x00dev->txdone_work);
228 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
230 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
231 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
232 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
235 if (!test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
239 * USB devices cannot blindly pass the skb->len as the
240 * length of the data to usb_fill_bulk_urb. Pass the skb
241 * to the driver to determine what the length should be.
243 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
245 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
246 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
247 entry->skb->data, length,
248 rt2x00usb_interrupt_txdone, entry);
250 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
253 void rt2x00usb_kick_tx_queue(struct data_queue *queue)
255 unsigned long irqflags;
257 unsigned int index_done;
261 * Only protect the range we are going to loop over,
262 * if during our loop a extra entry is set to pending
263 * it should not be kicked during this run, since it
264 * is part of another TX operation.
266 spin_lock_irqsave(&queue->lock, irqflags);
267 index = queue->index[Q_INDEX];
268 index_done = queue->index[Q_INDEX_DONE];
269 spin_unlock_irqrestore(&queue->lock, irqflags);
272 * Start from the TX done pointer, this guarentees that we will
273 * send out all frames in the correct order.
275 if (index_done < index) {
276 for (i = index_done; i < index; i++)
277 rt2x00usb_kick_tx_entry(&queue->entries[i]);
279 for (i = index_done; i < queue->limit; i++)
280 rt2x00usb_kick_tx_entry(&queue->entries[i]);
282 for (i = 0; i < index; i++)
283 rt2x00usb_kick_tx_entry(&queue->entries[i]);
286 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
288 void rt2x00usb_kill_tx_queue(struct data_queue *queue)
290 struct queue_entry_priv_usb *entry_priv;
291 struct queue_entry_priv_usb_bcn *bcn_priv;
296 * When killing the beacon queue, we must also kill
297 * the beacon guard byte.
300 (queue->qid == QID_BEACON) &&
301 (test_bit(DRIVER_REQUIRE_BEACON_GUARD, &queue->rt2x00dev->flags));
304 * Cancel all entries.
306 for (i = 0; i < queue->limit; i++) {
307 entry_priv = queue->entries[i].priv_data;
308 usb_kill_urb(entry_priv->urb);
311 * Kill guardian urb (if required by driver).
314 bcn_priv = queue->entries[i].priv_data;
315 usb_kill_urb(bcn_priv->guardian_urb);
319 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue);
321 static void rt2x00usb_watchdog_reset_tx(struct data_queue *queue)
323 struct queue_entry *entry;
324 struct queue_entry_priv_usb *entry_priv;
325 unsigned short threshold = queue->threshold;
327 WARNING(queue->rt2x00dev, "TX queue %d timed out, invoke reset", queue->qid);
330 * Temporarily disable the TX queue, this will force mac80211
331 * to use the other queues until this queue has been restored.
333 * Set the queue threshold to the queue limit. This prevents the
334 * queue from being enabled during the txdone handler.
336 queue->threshold = queue->limit;
337 ieee80211_stop_queue(queue->rt2x00dev->hw, queue->qid);
340 * Reset all currently uploaded TX frames.
342 while (!rt2x00queue_empty(queue)) {
343 entry = rt2x00queue_get_entry(queue, Q_INDEX_DONE);
344 entry_priv = entry->priv_data;
345 usb_kill_urb(entry_priv->urb);
348 * We need a short delay here to wait for
349 * the URB to be canceled
353 } while (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags));
356 * Invoke the TX done handler
358 rt2x00usb_work_txdone_entry(entry);
362 * The queue has been reset, and mac80211 is allowed to use the
365 queue->threshold = threshold;
366 ieee80211_wake_queue(queue->rt2x00dev->hw, queue->qid);
369 void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev)
371 struct data_queue *queue;
373 tx_queue_for_each(rt2x00dev, queue) {
374 if (rt2x00queue_timeout(queue))
375 rt2x00usb_watchdog_reset_tx(queue);
378 EXPORT_SYMBOL_GPL(rt2x00usb_watchdog);
383 static void rt2x00usb_work_rxdone(struct work_struct *work)
385 struct rt2x00_dev *rt2x00dev =
386 container_of(work, struct rt2x00_dev, rxdone_work);
387 struct queue_entry *entry;
388 struct skb_frame_desc *skbdesc;
391 while (!rt2x00queue_empty(rt2x00dev->rx)) {
392 entry = rt2x00queue_get_entry(rt2x00dev->rx, Q_INDEX_DONE);
394 if (test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
398 * Fill in desc fields of the skb descriptor
400 skbdesc = get_skb_frame_desc(entry->skb);
402 skbdesc->desc_len = entry->queue->desc_size;
405 * Send the frame to rt2x00lib for further processing.
407 rt2x00lib_rxdone(rt2x00dev, entry);
411 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
413 struct queue_entry *entry = (struct queue_entry *)urb->context;
414 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
416 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
417 !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
421 * Check if the received data is simply too small
422 * to be actually valid, or if the urb is signaling
425 if (urb->actual_length < entry->queue->desc_size || urb->status)
426 __set_bit(ENTRY_DATA_IO_FAILED, &entry->flags);
429 * Schedule the delayed work for reading the RX status
432 ieee80211_queue_work(rt2x00dev->hw, &rt2x00dev->rxdone_work);
438 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
440 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
444 * The USB version of kill_tx_queue also works
447 rt2x00dev->ops->lib->kill_tx_queue(rt2x00dev->rx);
449 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
452 * Device initialization handlers.
454 void rt2x00usb_clear_entry(struct queue_entry *entry)
456 struct usb_device *usb_dev =
457 to_usb_device_intf(entry->queue->rt2x00dev->dev);
458 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
463 if (entry->queue->qid == QID_RX) {
464 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
465 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
466 entry->skb->data, entry->skb->len,
467 rt2x00usb_interrupt_rxdone, entry);
469 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
470 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
473 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
475 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
476 struct usb_endpoint_descriptor *ep_desc)
478 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
481 queue->usb_endpoint = usb_endpoint_num(ep_desc);
483 if (queue->qid == QID_RX) {
484 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
485 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
487 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
488 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
491 if (!queue->usb_maxpacket)
492 queue->usb_maxpacket = 1;
495 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
497 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
498 struct usb_host_interface *intf_desc = intf->cur_altsetting;
499 struct usb_endpoint_descriptor *ep_desc;
500 struct data_queue *queue = rt2x00dev->tx;
501 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
505 * Walk through all available endpoints to search for "bulk in"
506 * and "bulk out" endpoints. When we find such endpoints collect
507 * the information we need from the descriptor and assign it
510 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
511 ep_desc = &intf_desc->endpoint[i].desc;
513 if (usb_endpoint_is_bulk_in(ep_desc)) {
514 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
515 } else if (usb_endpoint_is_bulk_out(ep_desc) &&
516 (queue != queue_end(rt2x00dev))) {
517 rt2x00usb_assign_endpoint(queue, ep_desc);
518 queue = queue_next(queue);
520 tx_ep_desc = ep_desc;
525 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
527 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
528 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
533 * It might be possible not all queues have a dedicated endpoint.
534 * Loop through all TX queues and copy the endpoint information
535 * which we have gathered from already assigned endpoints.
537 txall_queue_for_each(rt2x00dev, queue) {
538 if (!queue->usb_endpoint)
539 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
545 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
546 struct data_queue *queue)
548 struct queue_entry_priv_usb *entry_priv;
549 struct queue_entry_priv_usb_bcn *bcn_priv;
552 for (i = 0; i < queue->limit; i++) {
553 entry_priv = queue->entries[i].priv_data;
554 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
555 if (!entry_priv->urb)
560 * If this is not the beacon queue or
561 * no guardian byte was required for the beacon,
564 if (rt2x00dev->bcn != queue ||
565 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
568 for (i = 0; i < queue->limit; i++) {
569 bcn_priv = queue->entries[i].priv_data;
570 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
571 if (!bcn_priv->guardian_urb)
578 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
579 struct data_queue *queue)
581 struct queue_entry_priv_usb *entry_priv;
582 struct queue_entry_priv_usb_bcn *bcn_priv;
588 for (i = 0; i < queue->limit; i++) {
589 entry_priv = queue->entries[i].priv_data;
590 usb_kill_urb(entry_priv->urb);
591 usb_free_urb(entry_priv->urb);
595 * If this is not the beacon queue or
596 * no guardian byte was required for the beacon,
599 if (rt2x00dev->bcn != queue ||
600 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
603 for (i = 0; i < queue->limit; i++) {
604 bcn_priv = queue->entries[i].priv_data;
605 usb_kill_urb(bcn_priv->guardian_urb);
606 usb_free_urb(bcn_priv->guardian_urb);
610 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
612 struct data_queue *queue;
616 * Find endpoints for each queue
618 status = rt2x00usb_find_endpoints(rt2x00dev);
625 queue_for_each(rt2x00dev, queue) {
626 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
634 rt2x00usb_uninitialize(rt2x00dev);
638 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
640 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
642 struct data_queue *queue;
644 queue_for_each(rt2x00dev, queue)
645 rt2x00usb_free_urb(rt2x00dev, queue);
647 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
650 * USB driver handlers.
652 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
654 kfree(rt2x00dev->rf);
655 rt2x00dev->rf = NULL;
657 kfree(rt2x00dev->eeprom);
658 rt2x00dev->eeprom = NULL;
660 kfree(rt2x00dev->csr.cache);
661 rt2x00dev->csr.cache = NULL;
664 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
666 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
667 if (!rt2x00dev->csr.cache)
670 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
671 if (!rt2x00dev->eeprom)
674 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
681 ERROR_PROBE("Failed to allocate registers.\n");
683 rt2x00usb_free_reg(rt2x00dev);
688 int rt2x00usb_probe(struct usb_interface *usb_intf,
689 const struct usb_device_id *id)
691 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
692 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
693 struct ieee80211_hw *hw;
694 struct rt2x00_dev *rt2x00dev;
697 usb_dev = usb_get_dev(usb_dev);
699 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
701 ERROR_PROBE("Failed to allocate hardware.\n");
703 goto exit_put_device;
706 usb_set_intfdata(usb_intf, hw);
708 rt2x00dev = hw->priv;
709 rt2x00dev->dev = &usb_intf->dev;
710 rt2x00dev->ops = ops;
713 rt2x00_set_chip_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
715 INIT_WORK(&rt2x00dev->rxdone_work, rt2x00usb_work_rxdone);
716 INIT_WORK(&rt2x00dev->txdone_work, rt2x00usb_work_txdone);
718 retval = rt2x00usb_alloc_reg(rt2x00dev);
720 goto exit_free_device;
722 retval = rt2x00lib_probe_dev(rt2x00dev);
729 rt2x00usb_free_reg(rt2x00dev);
732 ieee80211_free_hw(hw);
735 usb_put_dev(usb_dev);
737 usb_set_intfdata(usb_intf, NULL);
741 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
743 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
745 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
746 struct rt2x00_dev *rt2x00dev = hw->priv;
749 * Free all allocated data.
751 rt2x00lib_remove_dev(rt2x00dev);
752 rt2x00usb_free_reg(rt2x00dev);
753 ieee80211_free_hw(hw);
756 * Free the USB device data.
758 usb_set_intfdata(usb_intf, NULL);
759 usb_put_dev(interface_to_usbdev(usb_intf));
761 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
764 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
766 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
767 struct rt2x00_dev *rt2x00dev = hw->priv;
770 retval = rt2x00lib_suspend(rt2x00dev, state);
775 * Decrease usbdev refcount.
777 usb_put_dev(interface_to_usbdev(usb_intf));
781 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
783 int rt2x00usb_resume(struct usb_interface *usb_intf)
785 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
786 struct rt2x00_dev *rt2x00dev = hw->priv;
788 usb_get_dev(interface_to_usbdev(usb_intf));
790 return rt2x00lib_resume(rt2x00dev);
792 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
793 #endif /* CONFIG_PM */
796 * rt2x00usb module information.
798 MODULE_AUTHOR(DRV_PROJECT);
799 MODULE_VERSION(DRV_VERSION);
800 MODULE_DESCRIPTION("rt2x00 usb library");
801 MODULE_LICENSE("GPL");