1 /* ZD1211 USB-WLAN driver for Linux
3 * Copyright (C) 2005-2007 Ulrich Kunitz <kune@deine-taler.de>
4 * Copyright (C) 2006-2007 Daniel Drake <dsd@gentoo.org>
5 * Copyright (C) 2006-2007 Michael Wu <flamingice@sourmilk.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/firmware.h>
25 #include <linux/device.h>
26 #include <linux/errno.h>
27 #include <linux/skbuff.h>
28 #include <linux/usb.h>
29 #include <linux/workqueue.h>
30 #include <net/mac80211.h>
31 #include <asm/unaligned.h>
37 static struct usb_device_id usb_ids[] = {
39 { USB_DEVICE(0x0ace, 0x1211), .driver_info = DEVICE_ZD1211 },
40 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211 },
41 { USB_DEVICE(0x126f, 0xa006), .driver_info = DEVICE_ZD1211 },
42 { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
43 { USB_DEVICE(0x0df6, 0x9071), .driver_info = DEVICE_ZD1211 },
44 { USB_DEVICE(0x0df6, 0x9075), .driver_info = DEVICE_ZD1211 },
45 { USB_DEVICE(0x157e, 0x300b), .driver_info = DEVICE_ZD1211 },
46 { USB_DEVICE(0x079b, 0x004a), .driver_info = DEVICE_ZD1211 },
47 { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
48 { USB_DEVICE(0x157e, 0x3204), .driver_info = DEVICE_ZD1211 },
49 { USB_DEVICE(0x0586, 0x3402), .driver_info = DEVICE_ZD1211 },
50 { USB_DEVICE(0x0b3b, 0x5630), .driver_info = DEVICE_ZD1211 },
51 { USB_DEVICE(0x0b05, 0x170c), .driver_info = DEVICE_ZD1211 },
52 { USB_DEVICE(0x1435, 0x0711), .driver_info = DEVICE_ZD1211 },
53 { USB_DEVICE(0x0586, 0x3409), .driver_info = DEVICE_ZD1211 },
54 { USB_DEVICE(0x0b3b, 0x1630), .driver_info = DEVICE_ZD1211 },
55 { USB_DEVICE(0x0586, 0x3401), .driver_info = DEVICE_ZD1211 },
56 { USB_DEVICE(0x14ea, 0xab13), .driver_info = DEVICE_ZD1211 },
57 { USB_DEVICE(0x13b1, 0x001e), .driver_info = DEVICE_ZD1211 },
58 { USB_DEVICE(0x0586, 0x3407), .driver_info = DEVICE_ZD1211 },
59 { USB_DEVICE(0x129b, 0x1666), .driver_info = DEVICE_ZD1211 },
60 { USB_DEVICE(0x157e, 0x300a), .driver_info = DEVICE_ZD1211 },
61 { USB_DEVICE(0x0105, 0x145f), .driver_info = DEVICE_ZD1211 },
63 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
64 { USB_DEVICE(0x0ace, 0xb215), .driver_info = DEVICE_ZD1211B },
65 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
66 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x083a, 0xe506), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
83 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
84 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
85 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
86 { USB_DEVICE(0x07fa, 0x1196), .driver_info = DEVICE_ZD1211B },
87 /* "Driverless" devices that need ejecting */
88 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
89 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
93 MODULE_LICENSE("GPL");
94 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
95 MODULE_AUTHOR("Ulrich Kunitz");
96 MODULE_AUTHOR("Daniel Drake");
97 MODULE_VERSION("1.0");
98 MODULE_DEVICE_TABLE(usb, usb_ids);
100 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
101 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
103 /* USB device initialization */
104 static void int_urb_complete(struct urb *urb);
106 static int request_fw_file(
107 const struct firmware **fw, const char *name, struct device *device)
111 dev_dbg_f(device, "fw name %s\n", name);
113 r = request_firmware(fw, name, device);
116 "Could not load firmware file %s. Error number %d\n",
121 static inline u16 get_bcdDevice(const struct usb_device *udev)
123 return le16_to_cpu(udev->descriptor.bcdDevice);
126 enum upload_code_flags {
130 /* Ensures that MAX_TRANSFER_SIZE is even. */
131 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
133 static int upload_code(struct usb_device *udev,
134 const u8 *data, size_t size, u16 code_offset, int flags)
139 /* USB request blocks need "kmalloced" buffers.
141 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
143 dev_err(&udev->dev, "out of memory\n");
150 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
151 size : MAX_TRANSFER_SIZE;
153 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
155 memcpy(p, data, transfer_size);
156 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
157 USB_REQ_FIRMWARE_DOWNLOAD,
158 USB_DIR_OUT | USB_TYPE_VENDOR,
159 code_offset, 0, p, transfer_size, 1000 /* ms */);
162 "USB control request for firmware upload"
163 " failed. Error number %d\n", r);
166 transfer_size = r & ~1;
168 size -= transfer_size;
169 data += transfer_size;
170 code_offset += transfer_size/sizeof(u16);
173 if (flags & REBOOT) {
176 /* Use "DMA-aware" buffer. */
177 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
178 USB_REQ_FIRMWARE_CONFIRM,
179 USB_DIR_IN | USB_TYPE_VENDOR,
180 0, 0, p, sizeof(ret), 5000 /* ms */);
181 if (r != sizeof(ret)) {
183 "control request firmeware confirmation failed."
184 " Return value %d\n", r);
192 "Internal error while downloading."
193 " Firmware confirm return value %#04x\n",
198 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
208 static u16 get_word(const void *data, u16 offset)
210 const __le16 *p = data;
211 return le16_to_cpu(p[offset]);
214 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
217 scnprintf(buffer, size, "%s%s",
219 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
224 static int handle_version_mismatch(struct zd_usb *usb,
225 const struct firmware *ub_fw)
227 struct usb_device *udev = zd_usb_to_usbdev(usb);
228 const struct firmware *ur_fw = NULL;
233 r = request_fw_file(&ur_fw,
234 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
239 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
243 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
244 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
245 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
247 /* At this point, the vendor driver downloads the whole firmware
248 * image, hacks around with version IDs, and uploads it again,
249 * completely overwriting the boot code. We do not do this here as
250 * it is not required on any tested devices, and it is suspected to
253 release_firmware(ur_fw);
257 static int upload_firmware(struct zd_usb *usb)
262 struct usb_device *udev = zd_usb_to_usbdev(usb);
263 const struct firmware *ub_fw = NULL;
264 const struct firmware *uph_fw = NULL;
267 bcdDevice = get_bcdDevice(udev);
269 r = request_fw_file(&ub_fw,
270 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
275 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
277 if (fw_bcdDevice != bcdDevice) {
279 "firmware version %#06x and device bootcode version "
280 "%#06x differ\n", fw_bcdDevice, bcdDevice);
281 if (bcdDevice <= 0x4313)
282 dev_warn(&udev->dev, "device has old bootcode, please "
283 "report success or failure\n");
285 r = handle_version_mismatch(usb, ub_fw);
289 dev_dbg_f(&udev->dev,
290 "firmware device id %#06x is equal to the "
291 "actual device id\n", fw_bcdDevice);
295 r = request_fw_file(&uph_fw,
296 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
301 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
304 "Could not upload firmware code uph. Error number %d\n",
310 release_firmware(ub_fw);
311 release_firmware(uph_fw);
315 /* Read data from device address space using "firmware interface" which does
316 * not require firmware to be loaded. */
317 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
320 struct usb_device *udev = zd_usb_to_usbdev(usb);
323 /* Use "DMA-aware" buffer. */
324 buf = kmalloc(len, GFP_KERNEL);
327 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
328 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
332 "read over firmware interface failed: %d\n", r);
334 } else if (r != len) {
336 "incomplete read over firmware interface: %d/%d\n",
342 memcpy(data, buf, len);
348 #define urb_dev(urb) (&(urb)->dev->dev)
350 static inline void handle_regs_int(struct urb *urb)
352 struct zd_usb *usb = urb->context;
353 struct zd_usb_interrupt *intr = &usb->intr;
357 ZD_ASSERT(in_interrupt());
358 spin_lock(&intr->lock);
360 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
361 if (int_num == CR_INTERRUPT) {
362 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
363 memcpy(&mac->intr_buffer, urb->transfer_buffer,
364 USB_MAX_EP_INT_BUFFER);
365 schedule_work(&mac->process_intr);
366 } else if (intr->read_regs_enabled) {
367 intr->read_regs.length = len = urb->actual_length;
369 if (len > sizeof(intr->read_regs.buffer))
370 len = sizeof(intr->read_regs.buffer);
371 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
372 intr->read_regs_enabled = 0;
373 complete(&intr->read_regs.completion);
378 spin_unlock(&intr->lock);
381 static void int_urb_complete(struct urb *urb)
384 struct usb_int_header *hdr;
386 switch (urb->status) {
400 if (urb->actual_length < sizeof(hdr)) {
401 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
405 hdr = urb->transfer_buffer;
406 if (hdr->type != USB_INT_TYPE) {
407 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
412 case USB_INT_ID_REGS:
413 handle_regs_int(urb);
415 case USB_INT_ID_RETRY_FAILED:
416 zd_mac_tx_failed(zd_usb_to_hw(urb->context));
419 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
420 (unsigned int)hdr->id);
425 r = usb_submit_urb(urb, GFP_ATOMIC);
427 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
432 kfree(urb->transfer_buffer);
435 static inline int int_urb_interval(struct usb_device *udev)
437 switch (udev->speed) {
448 static inline int usb_int_enabled(struct zd_usb *usb)
451 struct zd_usb_interrupt *intr = &usb->intr;
454 spin_lock_irqsave(&intr->lock, flags);
456 spin_unlock_irqrestore(&intr->lock, flags);
460 int zd_usb_enable_int(struct zd_usb *usb)
463 struct usb_device *udev;
464 struct zd_usb_interrupt *intr = &usb->intr;
465 void *transfer_buffer = NULL;
468 dev_dbg_f(zd_usb_dev(usb), "\n");
470 urb = usb_alloc_urb(0, GFP_KERNEL);
476 ZD_ASSERT(!irqs_disabled());
477 spin_lock_irq(&intr->lock);
479 spin_unlock_irq(&intr->lock);
484 spin_unlock_irq(&intr->lock);
486 /* TODO: make it a DMA buffer */
488 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
489 if (!transfer_buffer) {
490 dev_dbg_f(zd_usb_dev(usb),
491 "couldn't allocate transfer_buffer\n");
492 goto error_set_urb_null;
495 udev = zd_usb_to_usbdev(usb);
496 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
497 transfer_buffer, USB_MAX_EP_INT_BUFFER,
498 int_urb_complete, usb,
501 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
502 r = usb_submit_urb(urb, GFP_KERNEL);
504 dev_dbg_f(zd_usb_dev(usb),
505 "Couldn't submit urb. Error number %d\n", r);
511 kfree(transfer_buffer);
513 spin_lock_irq(&intr->lock);
515 spin_unlock_irq(&intr->lock);
522 void zd_usb_disable_int(struct zd_usb *usb)
525 struct zd_usb_interrupt *intr = &usb->intr;
528 spin_lock_irqsave(&intr->lock, flags);
531 spin_unlock_irqrestore(&intr->lock, flags);
535 spin_unlock_irqrestore(&intr->lock, flags);
538 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
542 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
546 const struct rx_length_info *length_info;
548 if (length < sizeof(struct rx_length_info)) {
549 /* It's not a complete packet anyhow. */
552 length_info = (struct rx_length_info *)
553 (buffer + length - sizeof(struct rx_length_info));
555 /* It might be that three frames are merged into a single URB
556 * transaction. We have to check for the length info tag.
558 * While testing we discovered that length_info might be unaligned,
559 * because if USB transactions are merged, the last packet will not
560 * be padded. Unaligned access might also happen if the length_info
561 * structure is not present.
563 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
565 unsigned int l, k, n;
566 for (i = 0, l = 0;; i++) {
567 k = get_unaligned_le16(&length_info->length[i]);
573 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
579 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
583 static void rx_urb_complete(struct urb *urb)
586 struct zd_usb_rx *rx;
590 switch (urb->status) {
601 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
605 buffer = urb->transfer_buffer;
606 length = urb->actual_length;
610 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
611 /* If there is an old first fragment, we don't care. */
612 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
613 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
614 spin_lock(&rx->lock);
615 memcpy(rx->fragment, buffer, length);
616 rx->fragment_length = length;
617 spin_unlock(&rx->lock);
621 spin_lock(&rx->lock);
622 if (rx->fragment_length > 0) {
623 /* We are on a second fragment, we believe */
624 ZD_ASSERT(length + rx->fragment_length <=
625 ARRAY_SIZE(rx->fragment));
626 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
627 memcpy(rx->fragment+rx->fragment_length, buffer, length);
628 handle_rx_packet(usb, rx->fragment,
629 rx->fragment_length + length);
630 rx->fragment_length = 0;
631 spin_unlock(&rx->lock);
633 spin_unlock(&rx->lock);
634 handle_rx_packet(usb, buffer, length);
638 usb_submit_urb(urb, GFP_ATOMIC);
641 static struct urb *alloc_rx_urb(struct zd_usb *usb)
643 struct usb_device *udev = zd_usb_to_usbdev(usb);
647 urb = usb_alloc_urb(0, GFP_KERNEL);
650 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
657 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
658 buffer, USB_MAX_RX_SIZE,
659 rx_urb_complete, usb);
660 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
665 static void free_rx_urb(struct urb *urb)
669 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
670 urb->transfer_buffer, urb->transfer_dma);
674 int zd_usb_enable_rx(struct zd_usb *usb)
677 struct zd_usb_rx *rx = &usb->rx;
680 dev_dbg_f(zd_usb_dev(usb), "\n");
683 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
686 for (i = 0; i < RX_URBS_COUNT; i++) {
687 urbs[i] = alloc_rx_urb(usb);
692 ZD_ASSERT(!irqs_disabled());
693 spin_lock_irq(&rx->lock);
695 spin_unlock_irq(&rx->lock);
700 rx->urbs_count = RX_URBS_COUNT;
701 spin_unlock_irq(&rx->lock);
703 for (i = 0; i < RX_URBS_COUNT; i++) {
704 r = usb_submit_urb(urbs[i], GFP_KERNEL);
711 for (i = 0; i < RX_URBS_COUNT; i++) {
712 usb_kill_urb(urbs[i]);
714 spin_lock_irq(&rx->lock);
717 spin_unlock_irq(&rx->lock);
720 for (i = 0; i < RX_URBS_COUNT; i++)
721 free_rx_urb(urbs[i]);
726 void zd_usb_disable_rx(struct zd_usb *usb)
732 struct zd_usb_rx *rx = &usb->rx;
734 spin_lock_irqsave(&rx->lock, flags);
736 count = rx->urbs_count;
737 spin_unlock_irqrestore(&rx->lock, flags);
741 for (i = 0; i < count; i++) {
742 usb_kill_urb(urbs[i]);
743 free_rx_urb(urbs[i]);
747 spin_lock_irqsave(&rx->lock, flags);
750 spin_unlock_irqrestore(&rx->lock, flags);
754 * zd_usb_disable_tx - disable transmission
755 * @usb: the zd1211rw-private USB structure
757 * Frees all URBs in the free list and marks the transmission as disabled.
759 void zd_usb_disable_tx(struct zd_usb *usb)
761 struct zd_usb_tx *tx = &usb->tx;
763 struct list_head *pos, *n;
765 spin_lock_irqsave(&tx->lock, flags);
766 list_for_each_safe(pos, n, &tx->free_urb_list) {
768 usb_free_urb(list_entry(pos, struct urb, urb_list));
771 tx->submitted_urbs = 0;
772 /* The stopped state is ignored, relying on ieee80211_wake_queues()
773 * in a potentionally following zd_usb_enable_tx().
775 spin_unlock_irqrestore(&tx->lock, flags);
779 * zd_usb_enable_tx - enables transmission
780 * @usb: a &struct zd_usb pointer
782 * This function enables transmission and prepares the &zd_usb_tx data
785 void zd_usb_enable_tx(struct zd_usb *usb)
788 struct zd_usb_tx *tx = &usb->tx;
790 spin_lock_irqsave(&tx->lock, flags);
792 tx->submitted_urbs = 0;
793 ieee80211_wake_queues(zd_usb_to_hw(usb));
795 spin_unlock_irqrestore(&tx->lock, flags);
799 * alloc_tx_urb - provides an tx URB
800 * @usb: a &struct zd_usb pointer
802 * Allocates a new URB. If possible takes the urb from the free list in
805 static struct urb *alloc_tx_urb(struct zd_usb *usb)
807 struct zd_usb_tx *tx = &usb->tx;
809 struct list_head *entry;
812 spin_lock_irqsave(&tx->lock, flags);
813 if (list_empty(&tx->free_urb_list)) {
814 urb = usb_alloc_urb(0, GFP_ATOMIC);
817 entry = tx->free_urb_list.next;
819 urb = list_entry(entry, struct urb, urb_list);
821 spin_unlock_irqrestore(&tx->lock, flags);
826 * free_tx_urb - frees a used tx URB
827 * @usb: a &struct zd_usb pointer
828 * @urb: URB to be freed
830 * Frees the the transmission URB, which means to put it on the free URB
833 static void free_tx_urb(struct zd_usb *usb, struct urb *urb)
835 struct zd_usb_tx *tx = &usb->tx;
838 spin_lock_irqsave(&tx->lock, flags);
843 list_add(&urb->urb_list, &tx->free_urb_list);
845 spin_unlock_irqrestore(&tx->lock, flags);
848 static void tx_dec_submitted_urbs(struct zd_usb *usb)
850 struct zd_usb_tx *tx = &usb->tx;
853 spin_lock_irqsave(&tx->lock, flags);
854 --tx->submitted_urbs;
855 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
856 ieee80211_wake_queues(zd_usb_to_hw(usb));
859 spin_unlock_irqrestore(&tx->lock, flags);
862 static void tx_inc_submitted_urbs(struct zd_usb *usb)
864 struct zd_usb_tx *tx = &usb->tx;
867 spin_lock_irqsave(&tx->lock, flags);
868 ++tx->submitted_urbs;
869 if (!tx->stopped && tx->submitted_urbs > ZD_USB_TX_HIGH) {
870 ieee80211_stop_queues(zd_usb_to_hw(usb));
873 spin_unlock_irqrestore(&tx->lock, flags);
877 * tx_urb_complete - completes the execution of an URB
880 * This function is called if the URB has been transferred to a device or an
881 * error has happened.
883 static void tx_urb_complete(struct urb *urb)
887 struct ieee80211_tx_info *info;
890 switch (urb->status) {
899 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
902 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
906 skb = (struct sk_buff *)urb->context;
908 * grab 'usb' pointer before handing off the skb (since
909 * it might be freed by zd_mac_tx_to_dev or mac80211)
911 info = IEEE80211_SKB_CB(skb);
912 usb = &zd_hw_mac(info->rate_driver_data[0])->chip.usb;
913 zd_mac_tx_to_dev(skb, urb->status);
914 free_tx_urb(usb, urb);
915 tx_dec_submitted_urbs(usb);
918 r = usb_submit_urb(urb, GFP_ATOMIC);
920 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
926 * zd_usb_tx: initiates transfer of a frame of the device
928 * @usb: the zd1211rw-private USB structure
929 * @skb: a &struct sk_buff pointer
931 * This function tranmits a frame to the device. It doesn't wait for
932 * completion. The frame must contain the control set and have all the
933 * control set information available.
935 * The function returns 0 if the transfer has been successfully initiated.
937 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
940 struct usb_device *udev = zd_usb_to_usbdev(usb);
943 urb = alloc_tx_urb(usb);
949 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
950 skb->data, skb->len, tx_urb_complete, skb);
952 r = usb_submit_urb(urb, GFP_ATOMIC);
955 tx_inc_submitted_urbs(usb);
958 free_tx_urb(usb, urb);
963 static inline void init_usb_interrupt(struct zd_usb *usb)
965 struct zd_usb_interrupt *intr = &usb->intr;
967 spin_lock_init(&intr->lock);
968 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
969 init_completion(&intr->read_regs.completion);
970 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
973 static inline void init_usb_rx(struct zd_usb *usb)
975 struct zd_usb_rx *rx = &usb->rx;
976 spin_lock_init(&rx->lock);
977 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
978 rx->usb_packet_size = 512;
980 rx->usb_packet_size = 64;
982 ZD_ASSERT(rx->fragment_length == 0);
985 static inline void init_usb_tx(struct zd_usb *usb)
987 struct zd_usb_tx *tx = &usb->tx;
988 spin_lock_init(&tx->lock);
991 INIT_LIST_HEAD(&tx->free_urb_list);
992 tx->submitted_urbs = 0;
995 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
996 struct usb_interface *intf)
998 memset(usb, 0, sizeof(*usb));
999 usb->intf = usb_get_intf(intf);
1000 usb_set_intfdata(usb->intf, hw);
1001 init_usb_interrupt(usb);
1006 void zd_usb_clear(struct zd_usb *usb)
1008 usb_set_intfdata(usb->intf, NULL);
1009 usb_put_intf(usb->intf);
1010 ZD_MEMCLEAR(usb, sizeof(*usb));
1011 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
1014 static const char *speed(enum usb_device_speed speed)
1019 case USB_SPEED_FULL:
1021 case USB_SPEED_HIGH:
1024 return "unknown speed";
1028 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
1030 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
1031 le16_to_cpu(udev->descriptor.idVendor),
1032 le16_to_cpu(udev->descriptor.idProduct),
1033 get_bcdDevice(udev),
1034 speed(udev->speed));
1037 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
1039 struct usb_device *udev = interface_to_usbdev(usb->intf);
1040 return scnprint_id(udev, buffer, size);
1044 static void print_id(struct usb_device *udev)
1048 scnprint_id(udev, buffer, sizeof(buffer));
1049 buffer[sizeof(buffer)-1] = 0;
1050 dev_dbg_f(&udev->dev, "%s\n", buffer);
1053 #define print_id(udev) do { } while (0)
1056 static int eject_installer(struct usb_interface *intf)
1058 struct usb_device *udev = interface_to_usbdev(intf);
1059 struct usb_host_interface *iface_desc = &intf->altsetting[0];
1060 struct usb_endpoint_descriptor *endpoint;
1065 /* Find bulk out endpoint */
1066 endpoint = &iface_desc->endpoint[1].desc;
1067 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
1068 usb_endpoint_xfer_bulk(endpoint)) {
1069 bulk_out_ep = endpoint->bEndpointAddress;
1072 "zd1211rw: Could not find bulk out endpoint\n");
1076 cmd = kzalloc(31, GFP_KERNEL);
1080 /* USB bulk command block */
1081 cmd[0] = 0x55; /* bulk command signature */
1082 cmd[1] = 0x53; /* bulk command signature */
1083 cmd[2] = 0x42; /* bulk command signature */
1084 cmd[3] = 0x43; /* bulk command signature */
1085 cmd[14] = 6; /* command length */
1087 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1088 cmd[19] = 0x2; /* eject disc */
1090 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1091 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1092 cmd, 31, NULL, 2000);
1097 /* At this point, the device disconnects and reconnects with the real
1100 usb_set_intfdata(intf, NULL);
1104 int zd_usb_init_hw(struct zd_usb *usb)
1107 struct zd_mac *mac = zd_usb_to_mac(usb);
1109 dev_dbg_f(zd_usb_dev(usb), "\n");
1111 r = upload_firmware(usb);
1113 dev_err(zd_usb_dev(usb),
1114 "couldn't load firmware. Error number %d\n", r);
1118 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1120 dev_dbg_f(zd_usb_dev(usb),
1121 "couldn't reset configuration. Error number %d\n", r);
1125 r = zd_mac_init_hw(mac->hw);
1127 dev_dbg_f(zd_usb_dev(usb),
1128 "couldn't initialize mac. Error number %d\n", r);
1132 usb->initialized = 1;
1136 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1139 struct usb_device *udev = interface_to_usbdev(intf);
1141 struct ieee80211_hw *hw = NULL;
1145 if (id->driver_info & DEVICE_INSTALLER)
1146 return eject_installer(intf);
1148 switch (udev->speed) {
1150 case USB_SPEED_FULL:
1151 case USB_SPEED_HIGH:
1154 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1159 r = usb_reset_device(udev);
1162 "couldn't reset usb device. Error number %d\n", r);
1166 hw = zd_mac_alloc_hw(intf);
1172 usb = &zd_hw_mac(hw)->chip.usb;
1173 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1175 r = zd_mac_preinit_hw(hw);
1177 dev_dbg_f(&intf->dev,
1178 "couldn't initialize mac. Error number %d\n", r);
1182 r = ieee80211_register_hw(hw);
1184 dev_dbg_f(&intf->dev,
1185 "couldn't register device. Error number %d\n", r);
1189 dev_dbg_f(&intf->dev, "successful\n");
1190 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1193 usb_reset_device(interface_to_usbdev(intf));
1195 zd_mac_clear(zd_hw_mac(hw));
1196 ieee80211_free_hw(hw);
1201 static void disconnect(struct usb_interface *intf)
1203 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1207 /* Either something really bad happened, or we're just dealing with
1208 * a DEVICE_INSTALLER. */
1212 mac = zd_hw_mac(hw);
1213 usb = &mac->chip.usb;
1215 dev_dbg_f(zd_usb_dev(usb), "\n");
1217 ieee80211_unregister_hw(hw);
1219 /* Just in case something has gone wrong! */
1220 zd_usb_disable_rx(usb);
1221 zd_usb_disable_int(usb);
1223 /* If the disconnect has been caused by a removal of the
1224 * driver module, the reset allows reloading of the driver. If the
1225 * reset will not be executed here, the upload of the firmware in the
1226 * probe function caused by the reloading of the driver will fail.
1228 usb_reset_device(interface_to_usbdev(intf));
1231 ieee80211_free_hw(hw);
1232 dev_dbg(&intf->dev, "disconnected\n");
1235 static struct usb_driver driver = {
1236 .name = KBUILD_MODNAME,
1237 .id_table = usb_ids,
1239 .disconnect = disconnect,
1242 struct workqueue_struct *zd_workqueue;
1244 static int __init usb_init(void)
1248 pr_debug("%s usb_init()\n", driver.name);
1250 zd_workqueue = create_singlethread_workqueue(driver.name);
1251 if (zd_workqueue == NULL) {
1252 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1256 r = usb_register(&driver);
1258 destroy_workqueue(zd_workqueue);
1259 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1264 pr_debug("%s initialized\n", driver.name);
1268 static void __exit usb_exit(void)
1270 pr_debug("%s usb_exit()\n", driver.name);
1271 usb_deregister(&driver);
1272 destroy_workqueue(zd_workqueue);
1275 module_init(usb_init);
1276 module_exit(usb_exit);
1278 static int usb_int_regs_length(unsigned int count)
1280 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1283 static void prepare_read_regs_int(struct zd_usb *usb)
1285 struct zd_usb_interrupt *intr = &usb->intr;
1287 spin_lock_irq(&intr->lock);
1288 intr->read_regs_enabled = 1;
1289 INIT_COMPLETION(intr->read_regs.completion);
1290 spin_unlock_irq(&intr->lock);
1293 static void disable_read_regs_int(struct zd_usb *usb)
1295 struct zd_usb_interrupt *intr = &usb->intr;
1297 spin_lock_irq(&intr->lock);
1298 intr->read_regs_enabled = 0;
1299 spin_unlock_irq(&intr->lock);
1302 static int get_results(struct zd_usb *usb, u16 *values,
1303 struct usb_req_read_regs *req, unsigned int count)
1307 struct zd_usb_interrupt *intr = &usb->intr;
1308 struct read_regs_int *rr = &intr->read_regs;
1309 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1311 spin_lock_irq(&intr->lock);
1314 /* The created block size seems to be larger than expected.
1315 * However results appear to be correct.
1317 if (rr->length < usb_int_regs_length(count)) {
1318 dev_dbg_f(zd_usb_dev(usb),
1319 "error: actual length %d less than expected %d\n",
1320 rr->length, usb_int_regs_length(count));
1323 if (rr->length > sizeof(rr->buffer)) {
1324 dev_dbg_f(zd_usb_dev(usb),
1325 "error: actual length %d exceeds buffer size %zu\n",
1326 rr->length, sizeof(rr->buffer));
1330 for (i = 0; i < count; i++) {
1331 struct reg_data *rd = ®s->regs[i];
1332 if (rd->addr != req->addr[i]) {
1333 dev_dbg_f(zd_usb_dev(usb),
1334 "rd[%d] addr %#06hx expected %#06hx\n", i,
1335 le16_to_cpu(rd->addr),
1336 le16_to_cpu(req->addr[i]));
1339 values[i] = le16_to_cpu(rd->value);
1344 spin_unlock_irq(&intr->lock);
1348 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1349 const zd_addr_t *addresses, unsigned int count)
1352 int i, req_len, actual_req_len;
1353 struct usb_device *udev;
1354 struct usb_req_read_regs *req = NULL;
1355 unsigned long timeout;
1358 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1361 if (count > USB_MAX_IOREAD16_COUNT) {
1362 dev_dbg_f(zd_usb_dev(usb),
1363 "error: count %u exceeds possible max %u\n",
1364 count, USB_MAX_IOREAD16_COUNT);
1368 dev_dbg_f(zd_usb_dev(usb),
1369 "error: io in atomic context not supported\n");
1370 return -EWOULDBLOCK;
1372 if (!usb_int_enabled(usb)) {
1373 dev_dbg_f(zd_usb_dev(usb),
1374 "error: usb interrupt not enabled\n");
1375 return -EWOULDBLOCK;
1378 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1379 req = kmalloc(req_len, GFP_KERNEL);
1382 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1383 for (i = 0; i < count; i++)
1384 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1386 udev = zd_usb_to_usbdev(usb);
1387 prepare_read_regs_int(usb);
1388 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1389 req, req_len, &actual_req_len, 1000 /* ms */);
1391 dev_dbg_f(zd_usb_dev(usb),
1392 "error in usb_bulk_msg(). Error number %d\n", r);
1395 if (req_len != actual_req_len) {
1396 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1397 " req_len %d != actual_req_len %d\n",
1398 req_len, actual_req_len);
1403 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1404 msecs_to_jiffies(1000));
1406 disable_read_regs_int(usb);
1407 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1412 r = get_results(usb, values, req, count);
1418 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1422 struct usb_device *udev;
1423 struct usb_req_write_regs *req = NULL;
1424 int i, req_len, actual_req_len;
1428 if (count > USB_MAX_IOWRITE16_COUNT) {
1429 dev_dbg_f(zd_usb_dev(usb),
1430 "error: count %u exceeds possible max %u\n",
1431 count, USB_MAX_IOWRITE16_COUNT);
1435 dev_dbg_f(zd_usb_dev(usb),
1436 "error: io in atomic context not supported\n");
1437 return -EWOULDBLOCK;
1440 req_len = sizeof(struct usb_req_write_regs) +
1441 count * sizeof(struct reg_data);
1442 req = kmalloc(req_len, GFP_KERNEL);
1446 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1447 for (i = 0; i < count; i++) {
1448 struct reg_data *rw = &req->reg_writes[i];
1449 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1450 rw->value = cpu_to_le16(ioreqs[i].value);
1453 udev = zd_usb_to_usbdev(usb);
1454 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1455 req, req_len, &actual_req_len, 1000 /* ms */);
1457 dev_dbg_f(zd_usb_dev(usb),
1458 "error in usb_bulk_msg(). Error number %d\n", r);
1461 if (req_len != actual_req_len) {
1462 dev_dbg_f(zd_usb_dev(usb),
1463 "error in usb_bulk_msg()"
1464 " req_len %d != actual_req_len %d\n",
1465 req_len, actual_req_len);
1470 /* FALL-THROUGH with r == 0 */
1476 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1479 struct usb_device *udev;
1480 struct usb_req_rfwrite *req = NULL;
1481 int i, req_len, actual_req_len;
1482 u16 bit_value_template;
1485 dev_dbg_f(zd_usb_dev(usb),
1486 "error: io in atomic context not supported\n");
1487 return -EWOULDBLOCK;
1489 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1490 dev_dbg_f(zd_usb_dev(usb),
1491 "error: bits %d are smaller than"
1492 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1493 bits, USB_MIN_RFWRITE_BIT_COUNT);
1496 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1497 dev_dbg_f(zd_usb_dev(usb),
1498 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1499 bits, USB_MAX_RFWRITE_BIT_COUNT);
1503 if (value & (~0UL << bits)) {
1504 dev_dbg_f(zd_usb_dev(usb),
1505 "error: value %#09x has bits >= %d set\n",
1511 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1513 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1515 dev_dbg_f(zd_usb_dev(usb),
1516 "error %d: Couldn't read CR203\n", r);
1519 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1521 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1522 req = kmalloc(req_len, GFP_KERNEL);
1526 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1527 /* 1: 3683a, but not used in ZYDAS driver */
1528 req->value = cpu_to_le16(2);
1529 req->bits = cpu_to_le16(bits);
1531 for (i = 0; i < bits; i++) {
1532 u16 bv = bit_value_template;
1533 if (value & (1 << (bits-1-i)))
1535 req->bit_values[i] = cpu_to_le16(bv);
1538 udev = zd_usb_to_usbdev(usb);
1539 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1540 req, req_len, &actual_req_len, 1000 /* ms */);
1542 dev_dbg_f(zd_usb_dev(usb),
1543 "error in usb_bulk_msg(). Error number %d\n", r);
1546 if (req_len != actual_req_len) {
1547 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1548 " req_len %d != actual_req_len %d\n",
1549 req_len, actual_req_len);
1554 /* FALL-THROUGH with r == 0 */