2 Copyright (C) 2004 - 2007 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.
27 * Set enviroment defines for rt2x00.h
29 #define DRV_NAME "rt2x00usb"
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/usb.h>
36 #include "rt2x00usb.h"
39 * Interfacing with the HW.
41 int rt2x00usb_vendor_request(const struct rt2x00_dev *rt2x00dev,
42 const u8 request, const u8 requesttype,
43 const u16 offset, const u16 value,
44 void *buffer, const u16 buffer_length,
47 struct usb_device *usb_dev =
48 interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
52 (requesttype == USB_VENDOR_REQUEST_IN) ?
53 usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
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)
72 "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
73 request, offset, status);
77 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
79 int rt2x00usb_vendor_request_buff(const struct rt2x00_dev *rt2x00dev,
80 const u8 request, const u8 requesttype,
81 const u16 offset, void *buffer,
82 const u16 buffer_length, const int timeout)
87 * Check for Cache availability.
89 if (unlikely(!rt2x00dev->csr_cache || buffer_length > CSR_CACHE_SIZE)) {
90 ERROR(rt2x00dev, "CSR cache not available.\n");
94 if (requesttype == USB_VENDOR_REQUEST_OUT)
95 memcpy(rt2x00dev->csr_cache, buffer, buffer_length);
97 status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
98 offset, 0, rt2x00dev->csr_cache,
99 buffer_length, timeout);
101 if (!status && requesttype == USB_VENDOR_REQUEST_IN)
102 memcpy(buffer, rt2x00dev->csr_cache, buffer_length);
106 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
111 static void rt2x00usb_interrupt_txdone(struct urb *urb)
113 struct data_entry *entry = (struct data_entry *)urb->context;
114 struct data_ring *ring = entry->ring;
115 struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
116 struct data_desc *txd = (struct data_desc *)entry->skb->data;
120 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
121 !__test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
124 rt2x00_desc_read(txd, 0, &word);
127 * Remove the descriptor data from the buffer.
129 skb_pull(entry->skb, ring->desc_size);
132 * Obtain the status about this packet.
134 tx_status = !urb->status ? TX_SUCCESS : TX_FAIL_RETRY;
136 rt2x00lib_txdone(entry, tx_status, 0);
139 * Make this entry available for reuse.
142 rt2x00_ring_index_done_inc(entry->ring);
145 * If the data ring was full before the txdone handler
146 * we must make sure the packet queue in the mac80211 stack
147 * is reenabled when the txdone handler has finished.
149 if (!rt2x00_ring_full(ring))
150 ieee80211_wake_queue(rt2x00dev->hw,
151 entry->tx_status.control.queue);
154 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
155 struct data_ring *ring, struct sk_buff *skb,
156 struct ieee80211_tx_control *control)
158 struct usb_device *usb_dev =
159 interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
160 struct data_entry *entry = rt2x00_get_data_entry(ring);
161 int pipe = usb_sndbulkpipe(usb_dev, 1);
164 if (rt2x00_ring_full(ring)) {
165 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
169 if (test_bit(ENTRY_OWNER_NIC, &entry->flags)) {
171 "Arrived at non-free entry in the non-full queue %d.\n"
172 "Please file bug report to %s.\n",
173 control->queue, DRV_PROJECT);
174 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
179 * Add the descriptor in front of the skb.
181 skb_push(skb, ring->desc_size);
182 memset(skb->data, 0, ring->desc_size);
184 rt2x00lib_write_tx_desc(rt2x00dev, (struct data_desc *)skb->data,
185 (struct ieee80211_hdr *)(skb->data +
187 skb->len - ring->desc_size, control);
188 memcpy(&entry->tx_status.control, control, sizeof(*control));
192 * USB devices cannot blindly pass the skb->len as the
193 * length of the data to usb_fill_bulk_urb. Pass the skb
194 * to the driver to determine what the length should be.
196 length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
199 * Initialize URB and send the frame to the device.
201 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
202 usb_fill_bulk_urb(entry->priv, usb_dev, pipe,
203 skb->data, length, rt2x00usb_interrupt_txdone, entry);
204 usb_submit_urb(entry->priv, GFP_ATOMIC);
206 rt2x00_ring_index_inc(ring);
208 if (rt2x00_ring_full(ring))
209 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
213 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
218 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
220 struct data_entry *entry = (struct data_entry *)urb->context;
221 struct data_ring *ring = entry->ring;
222 struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
224 struct rxdata_entry_desc desc;
227 if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
228 !test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
232 * Check if the received data is simply too small
233 * to be actually valid, or if the urb is signaling
236 if (urb->actual_length < entry->ring->desc_size || urb->status)
239 memset(&desc, 0x00, sizeof(desc));
240 rt2x00dev->ops->lib->fill_rxdone(entry, &desc);
243 * Allocate a new sk buffer to replace the current one.
244 * If allocation fails, we should drop the current frame
245 * so we can recycle the existing sk buffer for the new frame.
247 frame_size = entry->ring->data_size + entry->ring->desc_size;
248 skb = dev_alloc_skb(frame_size + NET_IP_ALIGN);
252 skb_reserve(skb, NET_IP_ALIGN);
253 skb_put(skb, frame_size);
256 * Trim the skb_buffer to only contain the valid
257 * frame data (so ignore the device's descriptor).
259 skb_trim(entry->skb, desc.size);
262 * Send the frame to rt2x00lib for further processing.
264 rt2x00lib_rxdone(entry, entry->skb, &desc);
267 * Replace current entry's skb with the newly allocated one,
268 * and reinitialize the urb.
271 urb->transfer_buffer = entry->skb->data;
272 urb->transfer_buffer_length = entry->skb->len;
275 if (test_bit(DEVICE_ENABLED_RADIO, &ring->rt2x00dev->flags)) {
276 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
277 usb_submit_urb(urb, GFP_ATOMIC);
280 rt2x00_ring_index_inc(ring);
286 void rt2x00usb_enable_radio(struct rt2x00_dev *rt2x00dev)
288 struct usb_device *usb_dev =
289 interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
290 struct data_ring *ring;
291 struct data_entry *entry;
295 * Initialize the TX rings
297 txringall_for_each(rt2x00dev, ring) {
298 for (i = 0; i < ring->stats.limit; i++)
299 ring->entry[i].flags = 0;
301 rt2x00_ring_index_clear(ring);
305 * Initialize and start the RX ring.
307 rt2x00_ring_index_clear(rt2x00dev->rx);
309 for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
310 entry = &rt2x00dev->rx->entry[i];
312 usb_fill_bulk_urb(entry->priv, usb_dev,
313 usb_rcvbulkpipe(usb_dev, 1),
314 entry->skb->data, entry->skb->len,
315 rt2x00usb_interrupt_rxdone, entry);
317 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
318 usb_submit_urb(entry->priv, GFP_ATOMIC);
321 EXPORT_SYMBOL_GPL(rt2x00usb_enable_radio);
323 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
325 struct data_ring *ring;
328 rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0x0000, 0x0000,
334 ring_for_each(rt2x00dev, ring) {
335 for (i = 0; i < ring->stats.limit; i++)
336 usb_kill_urb(ring->entry[i].priv);
339 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
342 * Device initialization handlers.
344 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
345 struct data_ring *ring)
352 for (i = 0; i < ring->stats.limit; i++) {
353 ring->entry[i].priv = usb_alloc_urb(0, GFP_KERNEL);
354 if (!ring->entry[i].priv)
361 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
362 struct data_ring *ring)
369 for (i = 0; i < ring->stats.limit; i++) {
370 usb_kill_urb(ring->entry[i].priv);
371 usb_free_urb(ring->entry[i].priv);
372 if (ring->entry[i].skb)
373 kfree_skb(ring->entry[i].skb);
377 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
379 struct data_ring *ring;
381 unsigned int entry_size;
388 ring_for_each(rt2x00dev, ring) {
389 status = rt2x00usb_alloc_urb(rt2x00dev, ring);
395 * For the RX ring, skb's should be allocated.
397 entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
398 for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
399 skb = dev_alloc_skb(NET_IP_ALIGN + entry_size);
403 skb_reserve(skb, NET_IP_ALIGN);
404 skb_put(skb, entry_size);
406 rt2x00dev->rx->entry[i].skb = skb;
412 rt2x00usb_uninitialize(rt2x00dev);
416 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
418 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
420 struct data_ring *ring;
422 ring_for_each(rt2x00dev, ring)
423 rt2x00usb_free_urb(rt2x00dev, ring);
425 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
428 * USB driver handlers.
430 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
432 kfree(rt2x00dev->rf);
433 rt2x00dev->rf = NULL;
435 kfree(rt2x00dev->eeprom);
436 rt2x00dev->eeprom = NULL;
438 kfree(rt2x00dev->csr_cache);
439 rt2x00dev->csr_cache = NULL;
442 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
444 rt2x00dev->csr_cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
445 if (!rt2x00dev->csr_cache)
448 rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
449 if (!rt2x00dev->eeprom)
452 rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
459 ERROR_PROBE("Failed to allocate registers.\n");
461 rt2x00usb_free_reg(rt2x00dev);
466 int rt2x00usb_probe(struct usb_interface *usb_intf,
467 const struct usb_device_id *id)
469 struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
470 struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
471 struct ieee80211_hw *hw;
472 struct rt2x00_dev *rt2x00dev;
475 usb_dev = usb_get_dev(usb_dev);
477 hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
479 ERROR_PROBE("Failed to allocate hardware.\n");
481 goto exit_put_device;
484 usb_set_intfdata(usb_intf, hw);
486 rt2x00dev = hw->priv;
487 rt2x00dev->dev = usb_intf;
488 rt2x00dev->ops = ops;
491 rt2x00dev->usb_maxpacket =
492 usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
493 if (!rt2x00dev->usb_maxpacket)
494 rt2x00dev->usb_maxpacket = 1;
496 retval = rt2x00usb_alloc_reg(rt2x00dev);
498 goto exit_free_device;
500 retval = rt2x00lib_probe_dev(rt2x00dev);
507 rt2x00usb_free_reg(rt2x00dev);
510 ieee80211_free_hw(hw);
513 usb_put_dev(usb_dev);
515 usb_set_intfdata(usb_intf, NULL);
519 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
521 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
523 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
524 struct rt2x00_dev *rt2x00dev = hw->priv;
527 * Free all allocated data.
529 rt2x00lib_remove_dev(rt2x00dev);
530 rt2x00usb_free_reg(rt2x00dev);
531 ieee80211_free_hw(hw);
534 * Free the USB device data.
536 usb_set_intfdata(usb_intf, NULL);
537 usb_put_dev(interface_to_usbdev(usb_intf));
539 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
542 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
544 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
545 struct rt2x00_dev *rt2x00dev = hw->priv;
548 retval = rt2x00lib_suspend(rt2x00dev, state);
552 rt2x00usb_free_reg(rt2x00dev);
555 * Decrease usbdev refcount.
557 usb_put_dev(interface_to_usbdev(usb_intf));
561 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
563 int rt2x00usb_resume(struct usb_interface *usb_intf)
565 struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
566 struct rt2x00_dev *rt2x00dev = hw->priv;
569 usb_get_dev(interface_to_usbdev(usb_intf));
571 retval = rt2x00usb_alloc_reg(rt2x00dev);
575 retval = rt2x00lib_resume(rt2x00dev);
582 rt2x00usb_free_reg(rt2x00dev);
586 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
587 #endif /* CONFIG_PM */
590 * rt2x00pci module information.
592 MODULE_AUTHOR(DRV_PROJECT);
593 MODULE_VERSION(DRV_VERSION);
594 MODULE_DESCRIPTION("rt2x00 library");
595 MODULE_LICENSE("GPL");