2 Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
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/usb.h>
29 #include <linux/bug.h>
32 #include "rt2x00usb.h"
35 * Interfacing with the HW.
37 int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
38 const u8 request, const u8 requesttype,
39 const u16 offset, const u16 value,
40 void *buffer, const u16 buffer_length,
43 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
47 (requesttype == USB_VENDOR_REQUEST_IN) ?
48 usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
51 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
52 status = usb_control_msg(usb_dev, pipe, request, requesttype,
53 value, offset, buffer, buffer_length,
60 * -ENODEV: Device has disappeared, no point continuing.
61 * All other errors: Try again.
63 else if (status == -ENODEV)
68 "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
69 request, offset, status);
73 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
75 int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
76 const u8 request, const u8 requesttype,
77 const u16 offset, void *buffer,
78 const u16 buffer_length, const int timeout)
82 BUG_ON(!mutex_is_locked(&rt2x00dev->csr_mutex));
85 * Check for Cache availability.
87 if (unlikely(!rt2x00dev->csr.cache || buffer_length > CSR_CACHE_SIZE)) {
88 ERROR(rt2x00dev, "CSR cache not available.\n");
92 if (requesttype == USB_VENDOR_REQUEST_OUT)
93 memcpy(rt2x00dev->csr.cache, buffer, buffer_length);
95 status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
96 offset, 0, rt2x00dev->csr.cache,
97 buffer_length, timeout);
99 if (!status && requesttype == USB_VENDOR_REQUEST_IN)
100 memcpy(buffer, rt2x00dev->csr.cache, buffer_length);
104 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock);
106 int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
107 const u8 request, const u8 requesttype,
108 const u16 offset, void *buffer,
109 const u16 buffer_length, const int timeout)
113 mutex_lock(&rt2x00dev->csr_mutex);
115 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
116 requesttype, offset, buffer,
117 buffer_length, timeout);
119 mutex_unlock(&rt2x00dev->csr_mutex);
123 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
125 int rt2x00usb_vendor_request_large_buff(struct rt2x00_dev *rt2x00dev,
126 const u8 request, const u8 requesttype,
127 const u16 offset, const void *buffer,
128 const u16 buffer_length,
135 mutex_lock(&rt2x00dev->csr_mutex);
140 while (len && !status) {
141 bsize = min_t(u16, CSR_CACHE_SIZE, len);
142 status = rt2x00usb_vendor_req_buff_lock(rt2x00dev, request,
143 requesttype, off, tb,
151 mutex_unlock(&rt2x00dev->csr_mutex);
155 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_large_buff);
157 int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
158 const unsigned int offset,
159 struct rt2x00_field32 field,
164 for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
165 rt2x00usb_register_read_lock(rt2x00dev, offset, reg);
166 if (!rt2x00_get_field32(*reg, field))
168 udelay(REGISTER_BUSY_DELAY);
171 ERROR(rt2x00dev, "Indirect register access failed: "
172 "offset=0x%.08x, value=0x%.08x\n", offset, *reg);
177 EXPORT_SYMBOL_GPL(rt2x00usb_regbusy_read);
182 static void rt2x00usb_interrupt_txdone(struct urb *urb)
184 struct queue_entry *entry = (struct queue_entry *)urb->context;
185 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
186 struct txdone_entry_desc txdesc;
188 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
189 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
193 * Obtain the status about this packet.
194 * Note that when the status is 0 it does not mean the
195 * frame was send out correctly. It only means the frame
196 * was succesfully pushed to the hardware, we have no
197 * way to determine the transmission status right now.
198 * (Only indirectly by looking at the failed TX counters
203 __set_bit(TXDONE_UNKNOWN, &txdesc.flags);
205 __set_bit(TXDONE_FAILURE, &txdesc.flags);
208 rt2x00lib_txdone(entry, &txdesc);
211 int rt2x00usb_write_tx_data(struct queue_entry *entry)
213 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
214 struct usb_device *usb_dev = to_usb_device_intf(rt2x00dev->dev);
215 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
216 struct skb_frame_desc *skbdesc;
220 * Add the descriptor in front of the skb.
222 skb_push(entry->skb, entry->queue->desc_size);
223 memset(entry->skb->data, 0, entry->queue->desc_size);
226 * Fill in skb descriptor
228 skbdesc = get_skb_frame_desc(entry->skb);
229 skbdesc->desc = entry->skb->data;
230 skbdesc->desc_len = entry->queue->desc_size;
233 * USB devices cannot blindly pass the skb->len as the
234 * length of the data to usb_fill_bulk_urb. Pass the skb
235 * to the driver to determine what the length should be.
237 length = rt2x00dev->ops->lib->get_tx_data_len(entry);
239 usb_fill_bulk_urb(entry_priv->urb, usb_dev,
240 usb_sndbulkpipe(usb_dev, entry->queue->usb_endpoint),
241 entry->skb->data, length,
242 rt2x00usb_interrupt_txdone, entry);
245 * Make sure the skb->data pointer points to the frame, not the
248 skb_pull(entry->skb, entry->queue->desc_size);
252 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
254 static inline void rt2x00usb_kick_tx_entry(struct queue_entry *entry)
256 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
258 if (test_and_clear_bit(ENTRY_DATA_PENDING, &entry->flags))
259 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
262 void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
263 const enum data_queue_qid qid)
265 struct data_queue *queue = rt2x00queue_get_queue(rt2x00dev, qid);
266 unsigned long irqflags;
268 unsigned int index_done;
272 * Only protect the range we are going to loop over,
273 * if during our loop a extra entry is set to pending
274 * it should not be kicked during this run, since it
275 * is part of another TX operation.
277 spin_lock_irqsave(&queue->lock, irqflags);
278 index = queue->index[Q_INDEX];
279 index_done = queue->index[Q_INDEX_DONE];
280 spin_unlock_irqrestore(&queue->lock, irqflags);
283 * Start from the TX done pointer, this guarentees that we will
284 * send out all frames in the correct order.
286 if (index_done < index) {
287 for (i = index_done; i < index; i++)
288 rt2x00usb_kick_tx_entry(&queue->entries[i]);
290 for (i = index_done; i < queue->limit; i++)
291 rt2x00usb_kick_tx_entry(&queue->entries[i]);
293 for (i = 0; i < index; i++)
294 rt2x00usb_kick_tx_entry(&queue->entries[i]);
297 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue);
302 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
304 struct queue_entry *entry = (struct queue_entry *)urb->context;
305 struct rt2x00_dev *rt2x00dev = entry->queue->rt2x00dev;
306 struct skb_frame_desc *skbdesc = get_skb_frame_desc(entry->skb);
309 if (!test_bit(DEVICE_STATE_ENABLED_RADIO, &rt2x00dev->flags) ||
310 !test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))
314 * Check if the received data is simply too small
315 * to be actually valid, or if the urb is signaling
318 if (urb->actual_length < entry->queue->desc_size || urb->status) {
319 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
320 usb_submit_urb(urb, GFP_ATOMIC);
325 * Fill in desc fields of the skb descriptor
328 skbdesc->desc_len = entry->queue->desc_size;
331 * Send the frame to rt2x00lib for further processing.
333 rt2x00lib_rxdone(rt2x00dev, entry);
339 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
341 struct queue_entry_priv_usb *entry_priv;
342 struct queue_entry_priv_usb_bcn *bcn_priv;
343 struct data_queue *queue;
346 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0, 0,
352 queue_for_each(rt2x00dev, queue) {
353 for (i = 0; i < queue->limit; i++) {
354 entry_priv = queue->entries[i].priv_data;
355 usb_kill_urb(entry_priv->urb);
360 * Kill guardian urb (if required by driver).
362 if (!test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
365 for (i = 0; i < rt2x00dev->bcn->limit; i++) {
366 bcn_priv = rt2x00dev->bcn->entries[i].priv_data;
367 if (bcn_priv->guardian_urb)
368 usb_kill_urb(bcn_priv->guardian_urb);
371 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
374 * Device initialization handlers.
376 void rt2x00usb_clear_entry(struct queue_entry *entry)
378 struct usb_device *usb_dev =
379 to_usb_device_intf(entry->queue->rt2x00dev->dev);
380 struct queue_entry_priv_usb *entry_priv = entry->priv_data;
383 if (entry->queue->qid == QID_RX) {
384 pipe = usb_rcvbulkpipe(usb_dev, entry->queue->usb_endpoint);
385 usb_fill_bulk_urb(entry_priv->urb, usb_dev, pipe,
386 entry->skb->data, entry->skb->len,
387 rt2x00usb_interrupt_rxdone, entry);
389 set_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
390 usb_submit_urb(entry_priv->urb, GFP_ATOMIC);
395 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry);
397 static void rt2x00usb_assign_endpoint(struct data_queue *queue,
398 struct usb_endpoint_descriptor *ep_desc)
400 struct usb_device *usb_dev = to_usb_device_intf(queue->rt2x00dev->dev);
403 queue->usb_endpoint = usb_endpoint_num(ep_desc);
405 if (queue->qid == QID_RX) {
406 pipe = usb_rcvbulkpipe(usb_dev, queue->usb_endpoint);
407 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 0);
409 pipe = usb_sndbulkpipe(usb_dev, queue->usb_endpoint);
410 queue->usb_maxpacket = usb_maxpacket(usb_dev, pipe, 1);
413 if (!queue->usb_maxpacket)
414 queue->usb_maxpacket = 1;
417 static int rt2x00usb_find_endpoints(struct rt2x00_dev *rt2x00dev)
419 struct usb_interface *intf = to_usb_interface(rt2x00dev->dev);
420 struct usb_host_interface *intf_desc = intf->cur_altsetting;
421 struct usb_endpoint_descriptor *ep_desc;
422 struct data_queue *queue = rt2x00dev->tx;
423 struct usb_endpoint_descriptor *tx_ep_desc = NULL;
427 * Walk through all available endpoints to search for "bulk in"
428 * and "bulk out" endpoints. When we find such endpoints collect
429 * the information we need from the descriptor and assign it
432 for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
433 ep_desc = &intf_desc->endpoint[i].desc;
435 if (usb_endpoint_is_bulk_in(ep_desc)) {
436 rt2x00usb_assign_endpoint(rt2x00dev->rx, ep_desc);
437 } else if (usb_endpoint_is_bulk_out(ep_desc)) {
438 rt2x00usb_assign_endpoint(queue, ep_desc);
440 if (queue != queue_end(rt2x00dev))
441 queue = queue_next(queue);
442 tx_ep_desc = ep_desc;
447 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
449 if (!rt2x00dev->rx->usb_endpoint || !rt2x00dev->tx->usb_endpoint) {
450 ERROR(rt2x00dev, "Bulk-in/Bulk-out endpoints not found\n");
455 * It might be possible not all queues have a dedicated endpoint.
456 * Loop through all TX queues and copy the endpoint information
457 * which we have gathered from already assigned endpoints.
459 txall_queue_for_each(rt2x00dev, queue) {
460 if (!queue->usb_endpoint)
461 rt2x00usb_assign_endpoint(queue, tx_ep_desc);
467 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
468 struct data_queue *queue)
470 struct queue_entry_priv_usb *entry_priv;
471 struct queue_entry_priv_usb_bcn *bcn_priv;
474 for (i = 0; i < queue->limit; i++) {
475 entry_priv = queue->entries[i].priv_data;
476 entry_priv->urb = usb_alloc_urb(0, GFP_KERNEL);
477 if (!entry_priv->urb)
482 * If this is not the beacon queue or
483 * no guardian byte was required for the beacon,
486 if (rt2x00dev->bcn != queue ||
487 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
490 for (i = 0; i < queue->limit; i++) {
491 bcn_priv = queue->entries[i].priv_data;
492 bcn_priv->guardian_urb = usb_alloc_urb(0, GFP_KERNEL);
493 if (!bcn_priv->guardian_urb)
500 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
501 struct data_queue *queue)
503 struct queue_entry_priv_usb *entry_priv;
504 struct queue_entry_priv_usb_bcn *bcn_priv;
510 for (i = 0; i < queue->limit; i++) {
511 entry_priv = queue->entries[i].priv_data;
512 usb_kill_urb(entry_priv->urb);
513 usb_free_urb(entry_priv->urb);
517 * If this is not the beacon queue or
518 * no guardian byte was required for the beacon,
521 if (rt2x00dev->bcn != queue ||
522 !test_bit(DRIVER_REQUIRE_BEACON_GUARD, &rt2x00dev->flags))
525 for (i = 0; i < queue->limit; i++) {
526 bcn_priv = queue->entries[i].priv_data;
527 usb_kill_urb(bcn_priv->guardian_urb);
528 usb_free_urb(bcn_priv->guardian_urb);
532 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
534 struct data_queue *queue;
538 * Find endpoints for each queue
540 status = rt2x00usb_find_endpoints(rt2x00dev);
547 queue_for_each(rt2x00dev, queue) {
548 status = rt2x00usb_alloc_urb(rt2x00dev, queue);
556 rt2x00usb_uninitialize(rt2x00dev);
560 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
562 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
564 struct data_queue *queue;
566 queue_for_each(rt2x00dev, queue)
567 rt2x00usb_free_urb(rt2x00dev, queue);
569 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
572 * USB driver handlers.
574 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
576 kfree(rt2x00dev->rf);
577 rt2x00dev->rf = NULL;
579 kfree(rt2x00dev->eeprom);
580 rt2x00dev->eeprom = NULL;
582 kfree(rt2x00dev->csr.cache);
583 rt2x00dev->csr.cache = NULL;
586 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
588 rt2x00dev->csr.cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
589 if (!rt2x00dev->csr.cache)
592 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
593 if (!rt2x00dev->eeprom)
596 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
603 ERROR_PROBE("Failed to allocate registers.\n");
605 rt2x00usb_free_reg(rt2x00dev);
610 int rt2x00usb_probe(struct usb_interface *usb_intf,
611 const struct usb_device_id *id)
613 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
614 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
615 struct ieee80211_hw *hw;
616 struct rt2x00_dev *rt2x00dev;
619 usb_dev = usb_get_dev(usb_dev);
621 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
623 ERROR_PROBE("Failed to allocate hardware.\n");
625 goto exit_put_device;
628 usb_set_intfdata(usb_intf, hw);
630 rt2x00dev = hw->priv;
631 rt2x00dev->dev = &usb_intf->dev;
632 rt2x00dev->ops = ops;
635 retval = rt2x00usb_alloc_reg(rt2x00dev);
637 goto exit_free_device;
639 retval = rt2x00lib_probe_dev(rt2x00dev);
646 rt2x00usb_free_reg(rt2x00dev);
649 ieee80211_free_hw(hw);
652 usb_put_dev(usb_dev);
654 usb_set_intfdata(usb_intf, NULL);
658 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
660 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
662 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
663 struct rt2x00_dev *rt2x00dev = hw->priv;
666 * Free all allocated data.
668 rt2x00lib_remove_dev(rt2x00dev);
669 rt2x00usb_free_reg(rt2x00dev);
670 ieee80211_free_hw(hw);
673 * Free the USB device data.
675 usb_set_intfdata(usb_intf, NULL);
676 usb_put_dev(interface_to_usbdev(usb_intf));
678 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
681 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
683 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
684 struct rt2x00_dev *rt2x00dev = hw->priv;
687 retval = rt2x00lib_suspend(rt2x00dev, state);
691 rt2x00usb_free_reg(rt2x00dev);
694 * Decrease usbdev refcount.
696 usb_put_dev(interface_to_usbdev(usb_intf));
700 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
702 int rt2x00usb_resume(struct usb_interface *usb_intf)
704 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
705 struct rt2x00_dev *rt2x00dev = hw->priv;
708 usb_get_dev(interface_to_usbdev(usb_intf));
710 retval = rt2x00usb_alloc_reg(rt2x00dev);
714 retval = rt2x00lib_resume(rt2x00dev);
721 rt2x00usb_free_reg(rt2x00dev);
725 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
726 #endif /* CONFIG_PM */
729 * rt2x00usb module information.
731 MODULE_AUTHOR(DRV_PROJECT);
732 MODULE_VERSION(DRV_VERSION);
733 MODULE_DESCRIPTION("rt2x00 usb library");
734 MODULE_LICENSE("GPL");