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
= rt2x00dev_usb_dev(rt2x00dev
);
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
->usb_cache_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
->usb_cache_mutex
);
115 status
= rt2x00usb_vendor_req_buff_lock(rt2x00dev
, request
,
116 requesttype
, offset
, buffer
,
117 buffer_length
, timeout
);
119 mutex_unlock(&rt2x00dev
->usb_cache_mutex
);
123 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff
);
128 static void rt2x00usb_interrupt_txdone(struct urb
*urb
)
130 struct queue_entry
*entry
= (struct queue_entry
*)urb
->context
;
131 struct rt2x00_dev
*rt2x00dev
= entry
->queue
->rt2x00dev
;
132 struct queue_entry_priv_usb_tx
*priv_tx
= entry
->priv_data
;
133 struct txdone_entry_desc txdesc
;
134 __le32
*txd
= (__le32
*)entry
->skb
->data
;
137 if (!test_bit(DEVICE_ENABLED_RADIO
, &rt2x00dev
->flags
) ||
138 !__test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
))
141 rt2x00_desc_read(txd
, 0, &word
);
144 * Remove the descriptor data from the buffer.
146 skb_pull(entry
->skb
, entry
->queue
->desc_size
);
149 * Obtain the status about this packet.
151 txdesc
.status
= !urb
->status
? TX_SUCCESS
: TX_FAIL_RETRY
;
153 txdesc
.control
= &priv_tx
->control
;
155 rt2x00lib_txdone(entry
, &txdesc
);
158 * Make this entry available for reuse.
161 rt2x00queue_index_inc(entry
->queue
, Q_INDEX_DONE
);
164 * If the data queue was full before the txdone handler
165 * we must make sure the packet queue in the mac80211 stack
166 * is reenabled when the txdone handler has finished.
168 if (!rt2x00queue_full(entry
->queue
))
169 ieee80211_wake_queue(rt2x00dev
->hw
, priv_tx
->control
.queue
);
172 int rt2x00usb_write_tx_data(struct rt2x00_dev
*rt2x00dev
,
173 struct data_queue
*queue
, struct sk_buff
*skb
,
174 struct ieee80211_tx_control
*control
)
176 struct usb_device
*usb_dev
= rt2x00dev_usb_dev(rt2x00dev
);
177 struct queue_entry
*entry
= rt2x00queue_get_entry(queue
, Q_INDEX
);
178 struct queue_entry_priv_usb_tx
*priv_tx
= entry
->priv_data
;
179 struct skb_frame_desc
*skbdesc
;
182 if (rt2x00queue_full(queue
))
185 if (test_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
)) {
187 "Arrived at non-free entry in the non-full queue %d.\n"
188 "Please file bug report to %s.\n",
189 control
->queue
, DRV_PROJECT
);
194 * Add the descriptor in front of the skb.
196 skb_push(skb
, queue
->desc_size
);
197 memset(skb
->data
, 0, queue
->desc_size
);
200 * Fill in skb descriptor
202 skbdesc
= get_skb_frame_desc(skb
);
203 skbdesc
->data
= skb
->data
+ queue
->desc_size
;
204 skbdesc
->data_len
= skb
->len
- queue
->desc_size
;
205 skbdesc
->desc
= skb
->data
;
206 skbdesc
->desc_len
= queue
->desc_size
;
207 skbdesc
->entry
= entry
;
209 memcpy(&priv_tx
->control
, control
, sizeof(priv_tx
->control
));
210 rt2x00lib_write_tx_desc(rt2x00dev
, skb
, control
);
213 * USB devices cannot blindly pass the skb->len as the
214 * length of the data to usb_fill_bulk_urb. Pass the skb
215 * to the driver to determine what the length should be.
217 length
= rt2x00dev
->ops
->lib
->get_tx_data_len(rt2x00dev
, skb
);
220 * Initialize URB and send the frame to the device.
222 __set_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
);
223 usb_fill_bulk_urb(priv_tx
->urb
, usb_dev
, usb_sndbulkpipe(usb_dev
, 1),
224 skb
->data
, length
, rt2x00usb_interrupt_txdone
, entry
);
225 usb_submit_urb(priv_tx
->urb
, GFP_ATOMIC
);
227 rt2x00queue_index_inc(queue
, Q_INDEX
);
231 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data
);
236 static struct sk_buff
* rt2x00usb_alloc_rxskb(struct data_queue
*queue
)
239 unsigned int frame_size
;
242 * As alignment we use 2 and not NET_IP_ALIGN because we need
243 * to be sure we have 2 bytes room in the head. (NET_IP_ALIGN
244 * can be 0 on some hardware). We use these 2 bytes for frame
245 * alignment later, we assume that the chance that
246 * header_size % 4 == 2 is bigger then header_size % 2 == 0
247 * and thus optimize alignment by reserving the 2 bytes in
250 frame_size
= queue
->data_size
+ queue
->desc_size
;
251 skb
= dev_alloc_skb(queue
->desc_size
+ frame_size
+ 2);
255 skb_reserve(skb
, queue
->desc_size
+ 2);
256 skb_put(skb
, frame_size
);
261 static void rt2x00usb_interrupt_rxdone(struct urb
*urb
)
263 struct queue_entry
*entry
= (struct queue_entry
*)urb
->context
;
264 struct rt2x00_dev
*rt2x00dev
= entry
->queue
->rt2x00dev
;
266 struct skb_frame_desc
*skbdesc
;
267 struct rxdone_entry_desc rxdesc
;
270 if (!test_bit(DEVICE_ENABLED_RADIO
, &rt2x00dev
->flags
) ||
271 !test_and_clear_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
))
275 * Check if the received data is simply too small
276 * to be actually valid, or if the urb is signaling
279 if (urb
->actual_length
< entry
->queue
->desc_size
|| urb
->status
)
283 * Fill in skb descriptor
285 skbdesc
= get_skb_frame_desc(entry
->skb
);
286 memset(skbdesc
, 0, sizeof(*skbdesc
));
287 skbdesc
->entry
= entry
;
289 memset(&rxdesc
, 0, sizeof(rxdesc
));
290 rt2x00dev
->ops
->lib
->fill_rxdone(entry
, &rxdesc
);
293 * The data behind the ieee80211 header must be
294 * aligned on a 4 byte boundary.
296 header_size
= ieee80211_get_hdrlen_from_skb(entry
->skb
);
297 if (header_size
% 4 == 0) {
298 skb_push(entry
->skb
, 2);
299 memmove(entry
->skb
->data
, entry
->skb
->data
+ 2,
300 entry
->skb
->len
- 2);
301 skbdesc
->data
= entry
->skb
->data
;
302 skb_trim(entry
->skb
,entry
->skb
->len
- 2);
306 * Allocate a new sk buffer to replace the current one.
307 * If allocation fails, we should drop the current frame
308 * so we can recycle the existing sk buffer for the new frame.
310 skb
= rt2x00usb_alloc_rxskb(entry
->queue
);
315 * Send the frame to rt2x00lib for further processing.
317 rt2x00lib_rxdone(entry
, &rxdesc
);
320 * Replace current entry's skb with the newly allocated one,
321 * and reinitialize the urb.
324 urb
->transfer_buffer
= entry
->skb
->data
;
325 urb
->transfer_buffer_length
= entry
->skb
->len
;
328 if (test_bit(DEVICE_ENABLED_RADIO
, &entry
->queue
->rt2x00dev
->flags
)) {
329 __set_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
);
330 usb_submit_urb(urb
, GFP_ATOMIC
);
333 rt2x00queue_index_inc(entry
->queue
, Q_INDEX
);
339 void rt2x00usb_disable_radio(struct rt2x00_dev
*rt2x00dev
)
341 struct queue_entry_priv_usb_rx
*priv_rx
;
342 struct queue_entry_priv_usb_tx
*priv_tx
;
343 struct queue_entry_priv_usb_bcn
*priv_bcn
;
344 struct data_queue
*queue
;
347 rt2x00usb_vendor_request_sw(rt2x00dev
, USB_RX_CONTROL
, 0x0000, 0x0000,
353 for (i
= 0; i
< rt2x00dev
->rx
->limit
; i
++) {
354 priv_rx
= rt2x00dev
->rx
->entries
[i
].priv_data
;
355 usb_kill_urb(priv_rx
->urb
);
358 tx_queue_for_each(rt2x00dev
, queue
) {
359 for (i
= 0; i
< queue
->limit
; i
++) {
360 priv_tx
= queue
->entries
[i
].priv_data
;
361 usb_kill_urb(priv_tx
->urb
);
365 for (i
= 0; i
< rt2x00dev
->bcn
->limit
; i
++) {
366 priv_bcn
= rt2x00dev
->bcn
->entries
[i
].priv_data
;
367 usb_kill_urb(priv_bcn
->urb
);
369 if (priv_bcn
->guardian_urb
)
370 usb_kill_urb(priv_bcn
->guardian_urb
);
373 if (!test_bit(DRIVER_REQUIRE_ATIM_QUEUE
, &rt2x00dev
->flags
))
376 for (i
= 0; i
< rt2x00dev
->bcn
[1].limit
; i
++) {
377 priv_tx
= rt2x00dev
->bcn
[1].entries
[i
].priv_data
;
378 usb_kill_urb(priv_tx
->urb
);
381 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio
);
384 * Device initialization handlers.
386 void rt2x00usb_init_rxentry(struct rt2x00_dev
*rt2x00dev
,
387 struct queue_entry
*entry
)
389 struct usb_device
*usb_dev
= rt2x00dev_usb_dev(rt2x00dev
);
390 struct queue_entry_priv_usb_rx
*priv_rx
= entry
->priv_data
;
392 usb_fill_bulk_urb(priv_rx
->urb
, usb_dev
,
393 usb_rcvbulkpipe(usb_dev
, 1),
394 entry
->skb
->data
, entry
->skb
->len
,
395 rt2x00usb_interrupt_rxdone
, entry
);
397 __set_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
);
398 usb_submit_urb(priv_rx
->urb
, GFP_ATOMIC
);
400 EXPORT_SYMBOL_GPL(rt2x00usb_init_rxentry
);
402 void rt2x00usb_init_txentry(struct rt2x00_dev
*rt2x00dev
,
403 struct queue_entry
*entry
)
407 EXPORT_SYMBOL_GPL(rt2x00usb_init_txentry
);
409 static int rt2x00usb_alloc_urb(struct rt2x00_dev
*rt2x00dev
,
410 struct data_queue
*queue
)
412 struct queue_entry_priv_usb_rx
*priv_rx
;
413 struct queue_entry_priv_usb_tx
*priv_tx
;
414 struct queue_entry_priv_usb_bcn
*priv_bcn
;
416 unsigned int guardian
=
417 test_bit(DRIVER_REQUIRE_BEACON_GUARD
, &rt2x00dev
->flags
);
423 for (i
= 0; i
< queue
->limit
; i
++) {
424 urb
= usb_alloc_urb(0, GFP_KERNEL
);
428 if (queue
->qid
== QID_RX
) {
429 priv_rx
= queue
->entries
[i
].priv_data
;
431 } else if (queue
->qid
== QID_MGMT
&& guardian
) {
432 priv_bcn
= queue
->entries
[i
].priv_data
;
435 urb
= usb_alloc_urb(0, GFP_KERNEL
);
439 priv_bcn
->guardian_urb
= urb
;
441 priv_tx
= queue
->entries
[i
].priv_data
;
449 static void rt2x00usb_free_urb(struct rt2x00_dev
*rt2x00dev
,
450 struct data_queue
*queue
)
452 struct queue_entry_priv_usb_rx
*priv_rx
;
453 struct queue_entry_priv_usb_tx
*priv_tx
;
454 struct queue_entry_priv_usb_bcn
*priv_bcn
;
456 unsigned int guardian
=
457 test_bit(DRIVER_REQUIRE_BEACON_GUARD
, &rt2x00dev
->flags
);
463 for (i
= 0; i
< queue
->limit
; i
++) {
464 if (queue
->qid
== QID_RX
) {
465 priv_rx
= queue
->entries
[i
].priv_data
;
467 } else if (queue
->qid
== QID_MGMT
&& guardian
) {
468 priv_bcn
= queue
->entries
[i
].priv_data
;
470 usb_kill_urb(priv_bcn
->guardian_urb
);
471 usb_free_urb(priv_bcn
->guardian_urb
);
475 priv_tx
= queue
->entries
[i
].priv_data
;
481 if (queue
->entries
[i
].skb
)
482 kfree_skb(queue
->entries
[i
].skb
);
486 int rt2x00usb_initialize(struct rt2x00_dev
*rt2x00dev
)
488 struct data_queue
*queue
;
490 unsigned int entry_size
;
492 int uninitialized_var(status
);
497 queue_for_each(rt2x00dev
, queue
) {
498 status
= rt2x00usb_alloc_urb(rt2x00dev
, queue
);
504 * For the RX queue, skb's should be allocated.
506 entry_size
= rt2x00dev
->rx
->data_size
+ rt2x00dev
->rx
->desc_size
;
507 for (i
= 0; i
< rt2x00dev
->rx
->limit
; i
++) {
508 skb
= rt2x00usb_alloc_rxskb(rt2x00dev
->rx
);
512 rt2x00dev
->rx
->entries
[i
].skb
= skb
;
518 rt2x00usb_uninitialize(rt2x00dev
);
522 EXPORT_SYMBOL_GPL(rt2x00usb_initialize
);
524 void rt2x00usb_uninitialize(struct rt2x00_dev
*rt2x00dev
)
526 struct data_queue
*queue
;
528 queue_for_each(rt2x00dev
, queue
)
529 rt2x00usb_free_urb(rt2x00dev
, queue
);
531 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize
);
534 * USB driver handlers.
536 static void rt2x00usb_free_reg(struct rt2x00_dev
*rt2x00dev
)
538 kfree(rt2x00dev
->rf
);
539 rt2x00dev
->rf
= NULL
;
541 kfree(rt2x00dev
->eeprom
);
542 rt2x00dev
->eeprom
= NULL
;
544 kfree(rt2x00dev
->csr
.cache
);
545 rt2x00dev
->csr
.cache
= NULL
;
548 static int rt2x00usb_alloc_reg(struct rt2x00_dev
*rt2x00dev
)
550 rt2x00dev
->csr
.cache
= kzalloc(CSR_CACHE_SIZE
, GFP_KERNEL
);
551 if (!rt2x00dev
->csr
.cache
)
554 rt2x00dev
->eeprom
= kzalloc(rt2x00dev
->ops
->eeprom_size
, GFP_KERNEL
);
555 if (!rt2x00dev
->eeprom
)
558 rt2x00dev
->rf
= kzalloc(rt2x00dev
->ops
->rf_size
, GFP_KERNEL
);
565 ERROR_PROBE("Failed to allocate registers.\n");
567 rt2x00usb_free_reg(rt2x00dev
);
572 int rt2x00usb_probe(struct usb_interface
*usb_intf
,
573 const struct usb_device_id
*id
)
575 struct usb_device
*usb_dev
= interface_to_usbdev(usb_intf
);
576 struct rt2x00_ops
*ops
= (struct rt2x00_ops
*)id
->driver_info
;
577 struct ieee80211_hw
*hw
;
578 struct rt2x00_dev
*rt2x00dev
;
581 usb_dev
= usb_get_dev(usb_dev
);
583 hw
= ieee80211_alloc_hw(sizeof(struct rt2x00_dev
), ops
->hw
);
585 ERROR_PROBE("Failed to allocate hardware.\n");
587 goto exit_put_device
;
590 usb_set_intfdata(usb_intf
, hw
);
592 rt2x00dev
= hw
->priv
;
593 rt2x00dev
->dev
= usb_intf
;
594 rt2x00dev
->ops
= ops
;
596 mutex_init(&rt2x00dev
->usb_cache_mutex
);
598 rt2x00dev
->usb_maxpacket
=
599 usb_maxpacket(usb_dev
, usb_sndbulkpipe(usb_dev
, 1), 1);
600 if (!rt2x00dev
->usb_maxpacket
)
601 rt2x00dev
->usb_maxpacket
= 1;
603 retval
= rt2x00usb_alloc_reg(rt2x00dev
);
605 goto exit_free_device
;
607 retval
= rt2x00lib_probe_dev(rt2x00dev
);
614 rt2x00usb_free_reg(rt2x00dev
);
617 ieee80211_free_hw(hw
);
620 usb_put_dev(usb_dev
);
622 usb_set_intfdata(usb_intf
, NULL
);
626 EXPORT_SYMBOL_GPL(rt2x00usb_probe
);
628 void rt2x00usb_disconnect(struct usb_interface
*usb_intf
)
630 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
631 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
634 * Free all allocated data.
636 rt2x00lib_remove_dev(rt2x00dev
);
637 rt2x00usb_free_reg(rt2x00dev
);
638 ieee80211_free_hw(hw
);
641 * Free the USB device data.
643 usb_set_intfdata(usb_intf
, NULL
);
644 usb_put_dev(interface_to_usbdev(usb_intf
));
646 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect
);
649 int rt2x00usb_suspend(struct usb_interface
*usb_intf
, pm_message_t state
)
651 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
652 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
655 retval
= rt2x00lib_suspend(rt2x00dev
, state
);
659 rt2x00usb_free_reg(rt2x00dev
);
662 * Decrease usbdev refcount.
664 usb_put_dev(interface_to_usbdev(usb_intf
));
668 EXPORT_SYMBOL_GPL(rt2x00usb_suspend
);
670 int rt2x00usb_resume(struct usb_interface
*usb_intf
)
672 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
673 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
676 usb_get_dev(interface_to_usbdev(usb_intf
));
678 retval
= rt2x00usb_alloc_reg(rt2x00dev
);
682 retval
= rt2x00lib_resume(rt2x00dev
);
689 rt2x00usb_free_reg(rt2x00dev
);
693 EXPORT_SYMBOL_GPL(rt2x00usb_resume
);
694 #endif /* CONFIG_PM */
697 * rt2x00usb module information.
699 MODULE_AUTHOR(DRV_PROJECT
);
700 MODULE_VERSION(DRV_VERSION
);
701 MODULE_DESCRIPTION("rt2x00 usb library");
702 MODULE_LICENSE("GPL");