2 Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
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/slab.h>
29 #include <linux/usb.h>
30 #include <linux/bug.h>
33 #include "rt2x00usb.h"
36 * Interfacing with the HW.
38 int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
39 const u8 request, const u8 requesttype,
40 const u16 offset, const u16 value,
41 void *buffer, const u16 buffer_length,
44 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
48 (requesttype == USB_VENDOR_REQUEST_IN) ?
49 usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
51 if (!test_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags))
54 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
55 status = usb_control_msg(usb_dev, pipe, request, requesttype,
56 value, offset, buffer, buffer_length,
63 * -ENODEV: Device has disappeared, no point continuing.
64 * All other errors: Try again.
66 else if (status == -ENODEV) {
67 clear_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags);
73 "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
74 request, offset, status);
78 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
80 int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
81 const u8 request, const u8 requesttype,
82 const u16 offset, void *buffer,
83 const u16 buffer_length, const int timeout)
87 BUG_ON(!mutex_is_locked(&rt2x00dev->csr_mutex));
90 * Check for Cache availability.
92 if (unlikely(!rt2x00dev->csr.cache || buffer_length > CSR_CACHE_SIZE)) {
93 ERROR(rt2x00dev, "CSR cache not available.\n");
97 if (requesttype == USB_VENDOR_REQUEST_OUT)
98 memcpy(rt2x00dev->csr.cache, buffer, buffer_length);
100 status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
101 offset, 0, rt2x00dev->csr.cache,
102 buffer_length, timeout);
104 if (!status && requesttype == USB_VENDOR_REQUEST_IN)
105 memcpy(buffer, rt2x00dev->csr.cache, buffer_length);
109 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock);
111 int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
112 const u8 request, const u8 requesttype,
113 const u16 offset, void *buffer,
114 const u16 buffer_length, const int timeout)
118 mutex_lock(&rt2x00dev->csr_mutex);
120 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
121 requesttype, offset, buffer,
122 buffer_length, timeout);
124 mutex_unlock(&rt2x00dev->csr_mutex);
128 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
130 int rt2x00usb_vendor_request_large_buff(struct rt2x00_dev *rt2x00dev,
131 const u8 request, const u8 requesttype,
132 const u16 offset, const void *buffer,
133 const u16 buffer_length,
140 mutex_lock(&rt2x00dev->csr_mutex);
145 while (len && !status) {
146 bsize = min_t(u16, CSR_CACHE_SIZE, len);
147 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
148 requesttype, off, tb,
156 mutex_unlock(&rt2x00dev->csr_mutex);
160 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_large_buff);
162 int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
163 const unsigned int offset,
164 const struct rt2x00_field32 field,
169 if (!test_bit(DEVICE_STATE_PRESENT, &rt2x00dev->flags))
172 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
173 rt2x00usb_register_read_lock(rt2x00dev, offset, reg);
174 if (!rt2x00_get_field32(*reg, field))
176 udelay(REGISTER_BUSY_DELAY);
179 ERROR(rt2x00dev, "Indirect register access failed: "
180 "offset=0x%.08x, value=0x%.08x\n", offset, *reg);
185 EXPORT_SYMBOL_GPL(rt2x00usb_regbusy_read);
190 static void rt2x00usb_interrupt_txdone(struct urb *urb)
192 struct queue_entry *entry = (struct queue_entry *)urb->context;
193 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
194 struct txdone_entry_desc txdesc;
196 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
197 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
201 * Obtain the status about this packet.
202 * Note that when the status is 0 it does not mean the
203 * frame was send out correctly. It only means the frame
204 * was succesfully pushed to the hardware, we have no
205 * way to determine the transmission status right now.
206 * (Only indirectly by looking at the failed TX counters
211 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
213 __set_bit(TXDONE_FAILURE, &txdesc.flags);
216 rt2x00lib_txdone(entry, &txdesc);
219 int rt2x00usb_write_tx_data(struct queue_entry *entry)
221 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
222 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
223 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
224 struct skb_frame_desc *skbdesc;
228 * Add the descriptor in front of the skb.
230 skb_push(entry->skb, entry->queue->desc_size);
231 memset(entry->skb->data, 0, entry->queue->desc_size);
234 * Fill in skb descriptor
236 skbdesc = get_skb_frame_desc(entry->skb);
237 skbdesc->desc = entry->skb->data;
238 skbdesc->desc_len = entry->queue->desc_size;
241 * USB devices cannot blindly pass the skb->len as the
242 * length of the data to usb_fill_bulk_urb. Pass the skb
243 * to the driver to determine what the length should be.
245 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
247 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
248 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
249 entry->skb->data, length,
250 rt2x00usb_interrupt_txdone, entry);
253 * Make sure the skb->data pointer points to the frame, not the
256 skb_pull(entry->skb, entry->queue->desc_size);
260 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
262 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
264 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
266 if (test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
267 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
270 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
271 const enum data_queue_qid qid)
273 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
274 unsigned long irqflags;
276 unsigned int index_done;
280 * Only protect the range we are going to loop over,
281 * if during our loop a extra entry is set to pending
282 * it should not be kicked during this run, since it
283 * is part of another TX operation.
285 spin_lock_irqsave(&queue->lock, irqflags);
286 index = queue->index[Q_INDEX];
287 index_done = queue->index[Q_INDEX_DONE];
288 spin_unlock_irqrestore(&queue->lock, irqflags);
291 * Start from the TX done pointer, this guarentees that we will
292 * send out all frames in the correct order.
294 if (index_done < index) {
295 for (i = index_done; i < index; i++)
296 rt2x00usb_kick_tx_entry(&queue->entries[i]);
298 for (i = index_done; i < queue->limit; i++)
299 rt2x00usb_kick_tx_entry(&queue->entries[i]);
301 for (i = 0; i < index; i++)
302 rt2x00usb_kick_tx_entry(&queue->entries[i]);
305 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
307 void rt2x00usb_kill_tx_queue(struct rt2x00_dev *rt2x00dev,
308 const enum data_queue_qid qid)
310 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
311 struct queue_entry_priv_usb *entry_priv;
312 struct queue_entry_priv_usb_bcn *bcn_priv;
317 * When killing the beacon queue, we must also kill
318 * the beacon guard byte.
321 (qid == QID_BEACON) &&
322 (test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags));
325 * Cancel all entries.
327 for (i = 0; i < queue->limit; i++) {
328 entry_priv = queue->entries[i].priv_data;
329 usb_kill_urb(entry_priv->urb);
332 * Kill guardian urb (if required by driver).
335 bcn_priv = queue->entries[i].priv_data;
336 usb_kill_urb(bcn_priv->guardian_urb);
340 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue);
345 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
347 struct queue_entry *entry = (struct queue_entry *)urb->context;
348 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
349 struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
352 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
353 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
357 * Check if the received data is simply too small
358 * to be actually valid, or if the urb is signaling
361 if (urb->actual_length < entry->queue->desc_size || urb->status) {
362 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
363 usb_submit_urb(urb, GFP_ATOMIC);
368 * Fill in desc fields of the skb descriptor
371 skbdesc->desc_len = entry->queue->desc_size;
374 * Send the frame to rt2x00lib for further processing.
376 rt2x00lib_rxdone(rt2x00dev, entry);
382 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
384 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
388 * The USB version of kill_tx_queue also works
391 rt2x00dev->ops->lib->kill_tx_queue(rt2x00dev, QID_RX);
393 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
396 * Device initialization handlers.
398 void rt2x00usb_clear_entry(struct queue_entry *entry)
400 struct usb_device *usb_dev =
401 to_usb_device_intf(entry->queue->rt2x00dev->dev);
402 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
405 if (entry->queue->qid == QID_RX) {
406 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
407 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
408 entry->skb->data, entry->skb->len,
409 rt2x00usb_interrupt_rxdone, entry);
411 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
412 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
417 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
419 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
420 struct usb_endpoint_descriptor *ep_desc)
422 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
425 queue->usb_endpoint = usb_endpoint_num(ep_desc);
427 if (queue->qid == QID_RX) {
428 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
429 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
431 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
432 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
435 if (!queue->usb_maxpacket)
436 queue->usb_maxpacket = 1;
439 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
441 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
442 struct usb_host_interface *intf_desc = intf->cur_altsetting;
443 struct usb_endpoint_descriptor *ep_desc;
444 struct data_queue *queue = rt2x00dev->tx;
445 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
449 * Walk through all available endpoints to search for "bulk in"
450 * and "bulk out" endpoints. When we find such endpoints collect
451 * the information we need from the descriptor and assign it
454 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
455 ep_desc = &intf_desc->endpoint[i].desc;
457 if (usb_endpoint_is_bulk_in(ep_desc)) {
458 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
459 } else if (usb_endpoint_is_bulk_out(ep_desc) &&
460 (queue != queue_end(rt2x00dev))) {
461 rt2x00usb_assign_endpoint(queue, ep_desc);
462 queue = queue_next(queue);
464 tx_ep_desc = ep_desc;
469 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
471 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
472 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
477 * It might be possible not all queues have a dedicated endpoint.
478 * Loop through all TX queues and copy the endpoint information
479 * which we have gathered from already assigned endpoints.
481 txall_queue_for_each(rt2x00dev, queue) {
482 if (!queue->usb_endpoint)
483 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
489 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
490 struct data_queue *queue)
492 struct queue_entry_priv_usb *entry_priv;
493 struct queue_entry_priv_usb_bcn *bcn_priv;
496 for (i = 0; i < queue->limit; i++) {
497 entry_priv = queue->entries[i].priv_data;
498 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
499 if (!entry_priv->urb)
504 * If this is not the beacon queue or
505 * no guardian byte was required for the beacon,
508 if (rt2x00dev->bcn != queue ||
509 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
512 for (i = 0; i < queue->limit; i++) {
513 bcn_priv = queue->entries[i].priv_data;
514 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
515 if (!bcn_priv->guardian_urb)
522 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
523 struct data_queue *queue)
525 struct queue_entry_priv_usb *entry_priv;
526 struct queue_entry_priv_usb_bcn *bcn_priv;
532 for (i = 0; i < queue->limit; i++) {
533 entry_priv = queue->entries[i].priv_data;
534 usb_kill_urb(entry_priv->urb);
535 usb_free_urb(entry_priv->urb);
539 * If this is not the beacon queue or
540 * no guardian byte was required for the beacon,
543 if (rt2x00dev->bcn != queue ||
544 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
547 for (i = 0; i < queue->limit; i++) {
548 bcn_priv = queue->entries[i].priv_data;
549 usb_kill_urb(bcn_priv->guardian_urb);
550 usb_free_urb(bcn_priv->guardian_urb);
554 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
556 struct data_queue *queue;
560 * Find endpoints for each queue
562 status = rt2x00usb_find_endpoints(rt2x00dev);
569 queue_for_each(rt2x00dev, queue) {
570 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
578 rt2x00usb_uninitialize(rt2x00dev);
582 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
584 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
586 struct data_queue *queue;
588 queue_for_each(rt2x00dev, queue)
589 rt2x00usb_free_urb(rt2x00dev, queue);
591 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
594 * USB driver handlers.
596 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
598 kfree(rt2x00dev->rf);
599 rt2x00dev->rf = NULL;
601 kfree(rt2x00dev->eeprom);
602 rt2x00dev->eeprom = NULL;
604 kfree(rt2x00dev->csr.cache);
605 rt2x00dev->csr.cache = NULL;
608 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
610 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
611 if (!rt2x00dev->csr.cache)
614 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
615 if (!rt2x00dev->eeprom)
618 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
625 ERROR_PROBE("Failed to allocate registers.\n");
627 rt2x00usb_free_reg(rt2x00dev);
632 int rt2x00usb_probe(struct usb_interface *usb_intf,
633 const struct usb_device_id *id)
635 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
636 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
637 struct ieee80211_hw *hw;
638 struct rt2x00_dev *rt2x00dev;
641 usb_dev = usb_get_dev(usb_dev);
643 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
645 ERROR_PROBE("Failed to allocate hardware.\n");
647 goto exit_put_device;
650 usb_set_intfdata(usb_intf, hw);
652 rt2x00dev = hw->priv;
653 rt2x00dev->dev = &usb_intf->dev;
654 rt2x00dev->ops = ops;
657 rt2x00_set_chip_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
659 retval = rt2x00usb_alloc_reg(rt2x00dev);
661 goto exit_free_device;
663 retval = rt2x00lib_probe_dev(rt2x00dev);
670 rt2x00usb_free_reg(rt2x00dev);
673 ieee80211_free_hw(hw);
676 usb_put_dev(usb_dev);
678 usb_set_intfdata(usb_intf, NULL);
682 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
684 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
686 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
687 struct rt2x00_dev *rt2x00dev = hw->priv;
690 * Free all allocated data.
692 rt2x00lib_remove_dev(rt2x00dev);
693 rt2x00usb_free_reg(rt2x00dev);
694 ieee80211_free_hw(hw);
697 * Free the USB device data.
699 usb_set_intfdata(usb_intf, NULL);
700 usb_put_dev(interface_to_usbdev(usb_intf));
702 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
705 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
707 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
708 struct rt2x00_dev *rt2x00dev = hw->priv;
711 retval = rt2x00lib_suspend(rt2x00dev, state);
716 * Decrease usbdev refcount.
718 usb_put_dev(interface_to_usbdev(usb_intf));
722 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
724 int rt2x00usb_resume(struct usb_interface *usb_intf)
726 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
727 struct rt2x00_dev *rt2x00dev = hw->priv;
729 usb_get_dev(interface_to_usbdev(usb_intf));
731 return rt2x00lib_resume(rt2x00dev);
733 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
734 #endif /* CONFIG_PM */
737 * rt2x00usb module information.
739 MODULE_AUTHOR(DRV_PROJECT);
740 MODULE_VERSION(DRV_VERSION);
741 MODULE_DESCRIPTION("rt2x00 usb library");
742 MODULE_LICENSE("GPL");