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,
220 struct txentry_desc *txdesc)
222 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
223 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
224 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
225 struct skb_frame_desc *skbdesc;
229 * Add the descriptor in front of the skb.
231 skb_push(entry->skb, entry->queue->desc_size);
232 memset(entry->skb->data, 0, entry->queue->desc_size);
235 * Fill in skb descriptor
237 skbdesc = get_skb_frame_desc(entry->skb);
238 skbdesc->desc = entry->skb->data;
239 skbdesc->desc_len = entry->queue->desc_size;
242 * USB devices cannot blindly pass the skb->len as the
243 * length of the data to usb_fill_bulk_urb. Pass the skb
244 * to the driver to determine what the length should be.
246 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
248 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
249 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
250 entry->skb->data, length,
251 rt2x00usb_interrupt_txdone, entry);
254 * Make sure the skb->data pointer points to the frame, not the
257 skb_pull(entry->skb, entry->queue->desc_size);
261 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
263 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
265 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
267 if (test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
268 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
271 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
272 const enum data_queue_qid qid)
274 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
275 unsigned long irqflags;
277 unsigned int index_done;
281 * Only protect the range we are going to loop over,
282 * if during our loop a extra entry is set to pending
283 * it should not be kicked during this run, since it
284 * is part of another TX operation.
286 spin_lock_irqsave(&queue->lock, irqflags);
287 index = queue->index[Q_INDEX];
288 index_done = queue->index[Q_INDEX_DONE];
289 spin_unlock_irqrestore(&queue->lock, irqflags);
292 * Start from the TX done pointer, this guarentees that we will
293 * send out all frames in the correct order.
295 if (index_done < index) {
296 for (i = index_done; i < index; i++)
297 rt2x00usb_kick_tx_entry(&queue->entries[i]);
299 for (i = index_done; i < queue->limit; i++)
300 rt2x00usb_kick_tx_entry(&queue->entries[i]);
302 for (i = 0; i < index; i++)
303 rt2x00usb_kick_tx_entry(&queue->entries[i]);
306 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
308 void rt2x00usb_kill_tx_queue(struct rt2x00_dev *rt2x00dev,
309 const enum data_queue_qid qid)
311 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
312 struct queue_entry_priv_usb *entry_priv;
313 struct queue_entry_priv_usb_bcn *bcn_priv;
318 * When killing the beacon queue, we must also kill
319 * the beacon guard byte.
322 (qid == QID_BEACON) &&
323 (test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags));
326 * Cancel all entries.
328 for (i = 0; i < queue->limit; i++) {
329 entry_priv = queue->entries[i].priv_data;
330 usb_kill_urb(entry_priv->urb);
333 * Kill guardian urb (if required by driver).
336 bcn_priv = queue->entries[i].priv_data;
337 usb_kill_urb(bcn_priv->guardian_urb);
341 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue);
346 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
348 struct queue_entry *entry = (struct queue_entry *)urb->context;
349 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
350 struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
353 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
354 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
358 * Check if the received data is simply too small
359 * to be actually valid, or if the urb is signaling
362 if (urb->actual_length < entry->queue->desc_size || urb->status) {
363 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
364 usb_submit_urb(urb, GFP_ATOMIC);
369 * Fill in desc fields of the skb descriptor
372 skbdesc->desc_len = entry->queue->desc_size;
375 * Send the frame to rt2x00lib for further processing.
377 rt2x00lib_rxdone(rt2x00dev, entry);
383 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
385 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
389 * The USB version of kill_tx_queue also works
392 rt2x00dev->ops->lib->kill_tx_queue(rt2x00dev, QID_RX);
394 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
397 * Device initialization handlers.
399 void rt2x00usb_clear_entry(struct queue_entry *entry)
401 struct usb_device *usb_dev =
402 to_usb_device_intf(entry->queue->rt2x00dev->dev);
403 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
406 if (entry->queue->qid == QID_RX) {
407 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
408 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
409 entry->skb->data, entry->skb->len,
410 rt2x00usb_interrupt_rxdone, entry);
412 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
413 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
418 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
420 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
421 struct usb_endpoint_descriptor *ep_desc)
423 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
426 queue->usb_endpoint = usb_endpoint_num(ep_desc);
428 if (queue->qid == QID_RX) {
429 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
430 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
432 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
433 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
436 if (!queue->usb_maxpacket)
437 queue->usb_maxpacket = 1;
440 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
442 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
443 struct usb_host_interface *intf_desc = intf->cur_altsetting;
444 struct usb_endpoint_descriptor *ep_desc;
445 struct data_queue *queue = rt2x00dev->tx;
446 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
450 * Walk through all available endpoints to search for "bulk in"
451 * and "bulk out" endpoints. When we find such endpoints collect
452 * the information we need from the descriptor and assign it
455 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
456 ep_desc = &intf_desc->endpoint[i].desc;
458 if (usb_endpoint_is_bulk_in(ep_desc)) {
459 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
460 } else if (usb_endpoint_is_bulk_out(ep_desc) &&
461 (queue != queue_end(rt2x00dev))) {
462 rt2x00usb_assign_endpoint(queue, ep_desc);
463 queue = queue_next(queue);
465 tx_ep_desc = ep_desc;
470 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
472 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
473 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
478 * It might be possible not all queues have a dedicated endpoint.
479 * Loop through all TX queues and copy the endpoint information
480 * which we have gathered from already assigned endpoints.
482 txall_queue_for_each(rt2x00dev, queue) {
483 if (!queue->usb_endpoint)
484 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
490 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
491 struct data_queue *queue)
493 struct queue_entry_priv_usb *entry_priv;
494 struct queue_entry_priv_usb_bcn *bcn_priv;
497 for (i = 0; i < queue->limit; i++) {
498 entry_priv = queue->entries[i].priv_data;
499 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
500 if (!entry_priv->urb)
505 * If this is not the beacon queue or
506 * no guardian byte was required for the beacon,
509 if (rt2x00dev->bcn != queue ||
510 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
513 for (i = 0; i < queue->limit; i++) {
514 bcn_priv = queue->entries[i].priv_data;
515 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
516 if (!bcn_priv->guardian_urb)
523 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
524 struct data_queue *queue)
526 struct queue_entry_priv_usb *entry_priv;
527 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 usb_kill_urb(entry_priv->urb);
536 usb_free_urb(entry_priv->urb);
540 * If this is not the beacon queue or
541 * no guardian byte was required for the beacon,
544 if (rt2x00dev->bcn != queue ||
545 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
548 for (i = 0; i < queue->limit; i++) {
549 bcn_priv = queue->entries[i].priv_data;
550 usb_kill_urb(bcn_priv->guardian_urb);
551 usb_free_urb(bcn_priv->guardian_urb);
555 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
557 struct data_queue *queue;
561 * Find endpoints for each queue
563 status = rt2x00usb_find_endpoints(rt2x00dev);
570 queue_for_each(rt2x00dev, queue) {
571 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
579 rt2x00usb_uninitialize(rt2x00dev);
583 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
585 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
587 struct data_queue *queue;
589 queue_for_each(rt2x00dev, queue)
590 rt2x00usb_free_urb(rt2x00dev, queue);
592 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
595 * USB driver handlers.
597 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
599 kfree(rt2x00dev->rf);
600 rt2x00dev->rf = NULL;
602 kfree(rt2x00dev->eeprom);
603 rt2x00dev->eeprom = NULL;
605 kfree(rt2x00dev->csr.cache);
606 rt2x00dev->csr.cache = NULL;
609 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
611 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
612 if (!rt2x00dev->csr.cache)
615 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
616 if (!rt2x00dev->eeprom)
619 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
626 ERROR_PROBE("Failed to allocate registers.\n");
628 rt2x00usb_free_reg(rt2x00dev);
633 int rt2x00usb_probe(struct usb_interface *usb_intf,
634 const struct usb_device_id *id)
636 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
637 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
638 struct ieee80211_hw *hw;
639 struct rt2x00_dev *rt2x00dev;
642 usb_dev = usb_get_dev(usb_dev);
644 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
646 ERROR_PROBE("Failed to allocate hardware.\n");
648 goto exit_put_device;
651 usb_set_intfdata(usb_intf, hw);
653 rt2x00dev = hw->priv;
654 rt2x00dev->dev = &usb_intf->dev;
655 rt2x00dev->ops = ops;
658 rt2x00_set_chip_intf(rt2x00dev, RT2X00_CHIP_INTF_USB);
660 retval = rt2x00usb_alloc_reg(rt2x00dev);
662 goto exit_free_device;
664 retval = rt2x00lib_probe_dev(rt2x00dev);
671 rt2x00usb_free_reg(rt2x00dev);
674 ieee80211_free_hw(hw);
677 usb_put_dev(usb_dev);
679 usb_set_intfdata(usb_intf, NULL);
683 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
685 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
687 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
688 struct rt2x00_dev *rt2x00dev = hw->priv;
691 * Free all allocated data.
693 rt2x00lib_remove_dev(rt2x00dev);
694 rt2x00usb_free_reg(rt2x00dev);
695 ieee80211_free_hw(hw);
698 * Free the USB device data.
700 usb_set_intfdata(usb_intf, NULL);
701 usb_put_dev(interface_to_usbdev(usb_intf));
703 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
706 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
708 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
709 struct rt2x00_dev *rt2x00dev = hw->priv;
712 retval = rt2x00lib_suspend(rt2x00dev, state);
717 * Decrease usbdev refcount.
719 usb_put_dev(interface_to_usbdev(usb_intf));
723 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
725 int rt2x00usb_resume(struct usb_interface *usb_intf)
727 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
728 struct rt2x00_dev *rt2x00dev = hw->priv;
730 usb_get_dev(interface_to_usbdev(usb_intf));
732 return rt2x00lib_resume(rt2x00dev);
734 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
735 #endif /* CONFIG_PM */
738 * rt2x00usb module information.
740 MODULE_AUTHOR(DRV_PROJECT);
741 MODULE_VERSION(DRV_VERSION);
742 MODULE_DESCRIPTION("rt2x00 usb library");
743 MODULE_LICENSE("GPL");