2 Copyright (C) 2004 - 2009 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);
50 if (!test_bit(DEVICE_STATE_PRESENT
, &rt2x00dev
->flags
))
53 for (i
= 0; i
< REGISTER_BUSY_COUNT
; i
++) {
54 status
= usb_control_msg(usb_dev
, pipe
, request
, requesttype
,
55 value
, offset
, buffer
, buffer_length
,
62 * -ENODEV: Device has disappeared, no point continuing.
63 * All other errors: Try again.
65 else if (status
== -ENODEV
) {
66 clear_bit(DEVICE_STATE_PRESENT
, &rt2x00dev
->flags
);
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_req_buff_lock(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
)
86 BUG_ON(!mutex_is_locked(&rt2x00dev
->csr_mutex
));
89 * Check for Cache availability.
91 if (unlikely(!rt2x00dev
->csr
.cache
|| buffer_length
> CSR_CACHE_SIZE
)) {
92 ERROR(rt2x00dev
, "CSR cache not available.\n");
96 if (requesttype
== USB_VENDOR_REQUEST_OUT
)
97 memcpy(rt2x00dev
->csr
.cache
, buffer
, buffer_length
);
99 status
= rt2x00usb_vendor_request(rt2x00dev
, request
, requesttype
,
100 offset
, 0, rt2x00dev
->csr
.cache
,
101 buffer_length
, timeout
);
103 if (!status
&& requesttype
== USB_VENDOR_REQUEST_IN
)
104 memcpy(buffer
, rt2x00dev
->csr
.cache
, buffer_length
);
108 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_req_buff_lock
);
110 int rt2x00usb_vendor_request_buff(struct rt2x00_dev
*rt2x00dev
,
111 const u8 request
, const u8 requesttype
,
112 const u16 offset
, void *buffer
,
113 const u16 buffer_length
, const int timeout
)
117 mutex_lock(&rt2x00dev
->csr_mutex
);
119 status
= rt2x00usb_vendor_req_buff_lock(rt2x00dev
, request
,
120 requesttype
, offset
, buffer
,
121 buffer_length
, timeout
);
123 mutex_unlock(&rt2x00dev
->csr_mutex
);
127 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff
);
129 int rt2x00usb_vendor_request_large_buff(struct rt2x00_dev
*rt2x00dev
,
130 const u8 request
, const u8 requesttype
,
131 const u16 offset
, const void *buffer
,
132 const u16 buffer_length
,
139 mutex_lock(&rt2x00dev
->csr_mutex
);
144 while (len
&& !status
) {
145 bsize
= min_t(u16
, CSR_CACHE_SIZE
, len
);
146 status
= rt2x00usb_vendor_req_buff_lock(rt2x00dev
, request
,
147 requesttype
, off
, tb
,
155 mutex_unlock(&rt2x00dev
->csr_mutex
);
159 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_large_buff
);
161 int rt2x00usb_regbusy_read(struct rt2x00_dev
*rt2x00dev
,
162 const unsigned int offset
,
163 const struct rt2x00_field32 field
,
168 if (!test_bit(DEVICE_STATE_PRESENT
, &rt2x00dev
->flags
))
171 for (i
= 0; i
< REGISTER_BUSY_COUNT
; i
++) {
172 rt2x00usb_register_read_lock(rt2x00dev
, offset
, reg
);
173 if (!rt2x00_get_field32(*reg
, field
))
175 udelay(REGISTER_BUSY_DELAY
);
178 ERROR(rt2x00dev
, "Indirect register access failed: "
179 "offset=0x%.08x, value=0x%.08x\n", offset
, *reg
);
184 EXPORT_SYMBOL_GPL(rt2x00usb_regbusy_read
);
189 static void rt2x00usb_interrupt_txdone(struct urb
*urb
)
191 struct queue_entry
*entry
= (struct queue_entry
*)urb
->context
;
192 struct rt2x00_dev
*rt2x00dev
= entry
->queue
->rt2x00dev
;
193 struct txdone_entry_desc txdesc
;
195 if (!test_bit(DEVICE_STATE_ENABLED_RADIO
, &rt2x00dev
->flags
) ||
196 !test_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
))
200 * Obtain the status about this packet.
201 * Note that when the status is 0 it does not mean the
202 * frame was send out correctly. It only means the frame
203 * was succesfully pushed to the hardware, we have no
204 * way to determine the transmission status right now.
205 * (Only indirectly by looking at the failed TX counters
210 __set_bit(TXDONE_UNKNOWN
, &txdesc
.flags
);
212 __set_bit(TXDONE_FAILURE
, &txdesc
.flags
);
215 rt2x00lib_txdone(entry
, &txdesc
);
218 int rt2x00usb_write_tx_data(struct queue_entry
*entry
)
220 struct rt2x00_dev
*rt2x00dev
= entry
->queue
->rt2x00dev
;
221 struct usb_device
*usb_dev
= to_usb_device_intf(rt2x00dev
->dev
);
222 struct queue_entry_priv_usb
*entry_priv
= entry
->priv_data
;
223 struct skb_frame_desc
*skbdesc
;
227 * Add the descriptor in front of the skb.
229 skb_push(entry
->skb
, entry
->queue
->desc_size
);
230 memset(entry
->skb
->data
, 0, entry
->queue
->desc_size
);
233 * Fill in skb descriptor
235 skbdesc
= get_skb_frame_desc(entry
->skb
);
236 skbdesc
->desc
= entry
->skb
->data
;
237 skbdesc
->desc_len
= entry
->queue
->desc_size
;
240 * USB devices cannot blindly pass the skb->len as the
241 * length of the data to usb_fill_bulk_urb. Pass the skb
242 * to the driver to determine what the length should be.
244 length
= rt2x00dev
->ops
->lib
->get_tx_data_len(entry
);
246 usb_fill_bulk_urb(entry_priv
->urb
, usb_dev
,
247 usb_sndbulkpipe(usb_dev
, entry
->queue
->usb_endpoint
),
248 entry
->skb
->data
, length
,
249 rt2x00usb_interrupt_txdone
, entry
);
252 * Make sure the skb->data pointer points to the frame, not the
255 skb_pull(entry
->skb
, entry
->queue
->desc_size
);
259 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data
);
261 static inline void rt2x00usb_kick_tx_entry(struct queue_entry
*entry
)
263 struct queue_entry_priv_usb
*entry_priv
= entry
->priv_data
;
265 if (test_and_clear_bit(ENTRY_DATA_PENDING
, &entry
->flags
))
266 usb_submit_urb(entry_priv
->urb
, GFP_ATOMIC
);
269 void rt2x00usb_kick_tx_queue(struct rt2x00_dev
*rt2x00dev
,
270 const enum data_queue_qid qid
)
272 struct data_queue
*queue
= rt2x00queue_get_queue(rt2x00dev
, qid
);
273 unsigned long irqflags
;
275 unsigned int index_done
;
279 * Only protect the range we are going to loop over,
280 * if during our loop a extra entry is set to pending
281 * it should not be kicked during this run, since it
282 * is part of another TX operation.
284 spin_lock_irqsave(&queue
->lock
, irqflags
);
285 index
= queue
->index
[Q_INDEX
];
286 index_done
= queue
->index
[Q_INDEX_DONE
];
287 spin_unlock_irqrestore(&queue
->lock
, irqflags
);
290 * Start from the TX done pointer, this guarentees that we will
291 * send out all frames in the correct order.
293 if (index_done
< index
) {
294 for (i
= index_done
; i
< index
; i
++)
295 rt2x00usb_kick_tx_entry(&queue
->entries
[i
]);
297 for (i
= index_done
; i
< queue
->limit
; i
++)
298 rt2x00usb_kick_tx_entry(&queue
->entries
[i
]);
300 for (i
= 0; i
< index
; i
++)
301 rt2x00usb_kick_tx_entry(&queue
->entries
[i
]);
304 EXPORT_SYMBOL_GPL(rt2x00usb_kick_tx_queue
);
306 void rt2x00usb_kill_tx_queue(struct rt2x00_dev
*rt2x00dev
,
307 const enum data_queue_qid qid
)
309 struct data_queue
*queue
= rt2x00queue_get_queue(rt2x00dev
, qid
);
310 struct queue_entry_priv_usb
*entry_priv
;
311 struct queue_entry_priv_usb_bcn
*bcn_priv
;
316 * When killing the beacon queue, we must also kill
317 * the beacon guard byte.
320 (qid
== QID_BEACON
) &&
321 (test_bit(DRIVER_REQUIRE_BEACON_GUARD
, &rt2x00dev
->flags
));
324 * Cancel all entries.
326 for (i
= 0; i
< queue
->limit
; i
++) {
327 entry_priv
= queue
->entries
[i
].priv_data
;
328 usb_kill_urb(entry_priv
->urb
);
331 * Kill guardian urb (if required by driver).
334 bcn_priv
= queue
->entries
[i
].priv_data
;
335 usb_kill_urb(bcn_priv
->guardian_urb
);
339 EXPORT_SYMBOL_GPL(rt2x00usb_kill_tx_queue
);
344 static void rt2x00usb_interrupt_rxdone(struct urb
*urb
)
346 struct queue_entry
*entry
= (struct queue_entry
*)urb
->context
;
347 struct rt2x00_dev
*rt2x00dev
= entry
->queue
->rt2x00dev
;
348 struct skb_frame_desc
*skbdesc
= get_skb_frame_desc(entry
->skb
);
351 if (!test_bit(DEVICE_STATE_ENABLED_RADIO
, &rt2x00dev
->flags
) ||
352 !test_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
))
356 * Check if the received data is simply too small
357 * to be actually valid, or if the urb is signaling
360 if (urb
->actual_length
< entry
->queue
->desc_size
|| urb
->status
) {
361 set_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
);
362 usb_submit_urb(urb
, GFP_ATOMIC
);
367 * Fill in desc fields of the skb descriptor
370 skbdesc
->desc_len
= entry
->queue
->desc_size
;
373 * Send the frame to rt2x00lib for further processing.
375 rt2x00lib_rxdone(rt2x00dev
, entry
);
381 void rt2x00usb_disable_radio(struct rt2x00_dev
*rt2x00dev
)
383 rt2x00usb_vendor_request_sw(rt2x00dev
, USB_RX_CONTROL
, 0, 0,
387 * The USB version of kill_tx_queue also works
390 rt2x00dev
->ops
->lib
->kill_tx_queue(rt2x00dev
, QID_RX
);
392 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio
);
395 * Device initialization handlers.
397 void rt2x00usb_clear_entry(struct queue_entry
*entry
)
399 struct usb_device
*usb_dev
=
400 to_usb_device_intf(entry
->queue
->rt2x00dev
->dev
);
401 struct queue_entry_priv_usb
*entry_priv
= entry
->priv_data
;
404 if (entry
->queue
->qid
== QID_RX
) {
405 pipe
= usb_rcvbulkpipe(usb_dev
, entry
->queue
->usb_endpoint
);
406 usb_fill_bulk_urb(entry_priv
->urb
, usb_dev
, pipe
,
407 entry
->skb
->data
, entry
->skb
->len
,
408 rt2x00usb_interrupt_rxdone
, entry
);
410 set_bit(ENTRY_OWNER_DEVICE_DATA
, &entry
->flags
);
411 usb_submit_urb(entry_priv
->urb
, GFP_ATOMIC
);
416 EXPORT_SYMBOL_GPL(rt2x00usb_clear_entry
);
418 static void rt2x00usb_assign_endpoint(struct data_queue
*queue
,
419 struct usb_endpoint_descriptor
*ep_desc
)
421 struct usb_device
*usb_dev
= to_usb_device_intf(queue
->rt2x00dev
->dev
);
424 queue
->usb_endpoint
= usb_endpoint_num(ep_desc
);
426 if (queue
->qid
== QID_RX
) {
427 pipe
= usb_rcvbulkpipe(usb_dev
, queue
->usb_endpoint
);
428 queue
->usb_maxpacket
= usb_maxpacket(usb_dev
, pipe
, 0);
430 pipe
= usb_sndbulkpipe(usb_dev
, queue
->usb_endpoint
);
431 queue
->usb_maxpacket
= usb_maxpacket(usb_dev
, pipe
, 1);
434 if (!queue
->usb_maxpacket
)
435 queue
->usb_maxpacket
= 1;
438 static int rt2x00usb_find_endpoints(struct rt2x00_dev
*rt2x00dev
)
440 struct usb_interface
*intf
= to_usb_interface(rt2x00dev
->dev
);
441 struct usb_host_interface
*intf_desc
= intf
->cur_altsetting
;
442 struct usb_endpoint_descriptor
*ep_desc
;
443 struct data_queue
*queue
= rt2x00dev
->tx
;
444 struct usb_endpoint_descriptor
*tx_ep_desc
= NULL
;
448 * Walk through all available endpoints to search for "bulk in"
449 * and "bulk out" endpoints. When we find such endpoints collect
450 * the information we need from the descriptor and assign it
453 for (i
= 0; i
< intf_desc
->desc
.bNumEndpoints
; i
++) {
454 ep_desc
= &intf_desc
->endpoint
[i
].desc
;
456 if (usb_endpoint_is_bulk_in(ep_desc
)) {
457 rt2x00usb_assign_endpoint(rt2x00dev
->rx
, ep_desc
);
458 } else if (usb_endpoint_is_bulk_out(ep_desc
) &&
459 (queue
!= queue_end(rt2x00dev
))) {
460 rt2x00usb_assign_endpoint(queue
, ep_desc
);
461 queue
= queue_next(queue
);
463 tx_ep_desc
= ep_desc
;
468 * At least 1 endpoint for RX and 1 endpoint for TX must be available.
470 if (!rt2x00dev
->rx
->usb_endpoint
|| !rt2x00dev
->tx
->usb_endpoint
) {
471 ERROR(rt2x00dev
, "Bulk-in/Bulk-out endpoints not found\n");
476 * It might be possible not all queues have a dedicated endpoint.
477 * Loop through all TX queues and copy the endpoint information
478 * which we have gathered from already assigned endpoints.
480 txall_queue_for_each(rt2x00dev
, queue
) {
481 if (!queue
->usb_endpoint
)
482 rt2x00usb_assign_endpoint(queue
, tx_ep_desc
);
488 static int rt2x00usb_alloc_urb(struct rt2x00_dev
*rt2x00dev
,
489 struct data_queue
*queue
)
491 struct queue_entry_priv_usb
*entry_priv
;
492 struct queue_entry_priv_usb_bcn
*bcn_priv
;
495 for (i
= 0; i
< queue
->limit
; i
++) {
496 entry_priv
= queue
->entries
[i
].priv_data
;
497 entry_priv
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
498 if (!entry_priv
->urb
)
503 * If this is not the beacon queue or
504 * no guardian byte was required for the beacon,
507 if (rt2x00dev
->bcn
!= queue
||
508 !test_bit(DRIVER_REQUIRE_BEACON_GUARD
, &rt2x00dev
->flags
))
511 for (i
= 0; i
< queue
->limit
; i
++) {
512 bcn_priv
= queue
->entries
[i
].priv_data
;
513 bcn_priv
->guardian_urb
= usb_alloc_urb(0, GFP_KERNEL
);
514 if (!bcn_priv
->guardian_urb
)
521 static void rt2x00usb_free_urb(struct rt2x00_dev
*rt2x00dev
,
522 struct data_queue
*queue
)
524 struct queue_entry_priv_usb
*entry_priv
;
525 struct queue_entry_priv_usb_bcn
*bcn_priv
;
531 for (i
= 0; i
< queue
->limit
; i
++) {
532 entry_priv
= queue
->entries
[i
].priv_data
;
533 usb_kill_urb(entry_priv
->urb
);
534 usb_free_urb(entry_priv
->urb
);
538 * If this is not the beacon queue or
539 * no guardian byte was required for the beacon,
542 if (rt2x00dev
->bcn
!= queue
||
543 !test_bit(DRIVER_REQUIRE_BEACON_GUARD
, &rt2x00dev
->flags
))
546 for (i
= 0; i
< queue
->limit
; i
++) {
547 bcn_priv
= queue
->entries
[i
].priv_data
;
548 usb_kill_urb(bcn_priv
->guardian_urb
);
549 usb_free_urb(bcn_priv
->guardian_urb
);
553 int rt2x00usb_initialize(struct rt2x00_dev
*rt2x00dev
)
555 struct data_queue
*queue
;
559 * Find endpoints for each queue
561 status
= rt2x00usb_find_endpoints(rt2x00dev
);
568 queue_for_each(rt2x00dev
, queue
) {
569 status
= rt2x00usb_alloc_urb(rt2x00dev
, queue
);
577 rt2x00usb_uninitialize(rt2x00dev
);
581 EXPORT_SYMBOL_GPL(rt2x00usb_initialize
);
583 void rt2x00usb_uninitialize(struct rt2x00_dev
*rt2x00dev
)
585 struct data_queue
*queue
;
587 queue_for_each(rt2x00dev
, queue
)
588 rt2x00usb_free_urb(rt2x00dev
, queue
);
590 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize
);
593 * USB driver handlers.
595 static void rt2x00usb_free_reg(struct rt2x00_dev
*rt2x00dev
)
597 kfree(rt2x00dev
->rf
);
598 rt2x00dev
->rf
= NULL
;
600 kfree(rt2x00dev
->eeprom
);
601 rt2x00dev
->eeprom
= NULL
;
603 kfree(rt2x00dev
->csr
.cache
);
604 rt2x00dev
->csr
.cache
= NULL
;
607 static int rt2x00usb_alloc_reg(struct rt2x00_dev
*rt2x00dev
)
609 rt2x00dev
->csr
.cache
= kzalloc(CSR_CACHE_SIZE
, GFP_KERNEL
);
610 if (!rt2x00dev
->csr
.cache
)
613 rt2x00dev
->eeprom
= kzalloc(rt2x00dev
->ops
->eeprom_size
, GFP_KERNEL
);
614 if (!rt2x00dev
->eeprom
)
617 rt2x00dev
->rf
= kzalloc(rt2x00dev
->ops
->rf_size
, GFP_KERNEL
);
624 ERROR_PROBE("Failed to allocate registers.\n");
626 rt2x00usb_free_reg(rt2x00dev
);
631 int rt2x00usb_probe(struct usb_interface
*usb_intf
,
632 const struct usb_device_id
*id
)
634 struct usb_device
*usb_dev
= interface_to_usbdev(usb_intf
);
635 struct rt2x00_ops
*ops
= (struct rt2x00_ops
*)id
->driver_info
;
636 struct ieee80211_hw
*hw
;
637 struct rt2x00_dev
*rt2x00dev
;
640 usb_dev
= usb_get_dev(usb_dev
);
642 hw
= ieee80211_alloc_hw(sizeof(struct rt2x00_dev
), ops
->hw
);
644 ERROR_PROBE("Failed to allocate hardware.\n");
646 goto exit_put_device
;
649 usb_set_intfdata(usb_intf
, hw
);
651 rt2x00dev
= hw
->priv
;
652 rt2x00dev
->dev
= &usb_intf
->dev
;
653 rt2x00dev
->ops
= ops
;
656 retval
= rt2x00usb_alloc_reg(rt2x00dev
);
658 goto exit_free_device
;
660 retval
= rt2x00lib_probe_dev(rt2x00dev
);
667 rt2x00usb_free_reg(rt2x00dev
);
670 ieee80211_free_hw(hw
);
673 usb_put_dev(usb_dev
);
675 usb_set_intfdata(usb_intf
, NULL
);
679 EXPORT_SYMBOL_GPL(rt2x00usb_probe
);
681 void rt2x00usb_disconnect(struct usb_interface
*usb_intf
)
683 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
684 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
687 * Free all allocated data.
689 rt2x00lib_remove_dev(rt2x00dev
);
690 rt2x00usb_free_reg(rt2x00dev
);
691 ieee80211_free_hw(hw
);
694 * Free the USB device data.
696 usb_set_intfdata(usb_intf
, NULL
);
697 usb_put_dev(interface_to_usbdev(usb_intf
));
699 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect
);
702 int rt2x00usb_suspend(struct usb_interface
*usb_intf
, pm_message_t state
)
704 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
705 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
708 retval
= rt2x00lib_suspend(rt2x00dev
, state
);
713 * Decrease usbdev refcount.
715 usb_put_dev(interface_to_usbdev(usb_intf
));
719 EXPORT_SYMBOL_GPL(rt2x00usb_suspend
);
721 int rt2x00usb_resume(struct usb_interface
*usb_intf
)
723 struct ieee80211_hw
*hw
= usb_get_intfdata(usb_intf
);
724 struct rt2x00_dev
*rt2x00dev
= hw
->priv
;
726 usb_get_dev(interface_to_usbdev(usb_intf
));
728 return rt2x00lib_resume(rt2x00dev
);
730 EXPORT_SYMBOL_GPL(rt2x00usb_resume
);
731 #endif /* CONFIG_PM */
734 * rt2x00usb module information.
736 MODULE_AUTHOR(DRV_PROJECT
);
737 MODULE_VERSION(DRV_VERSION
);
738 MODULE_DESCRIPTION("rt2x00 usb library");
739 MODULE_LICENSE("GPL");