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(0x0ace, 0xa211), .driver_info = DEVICE_ZD1211 },
41 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211 },
42 { USB_DEVICE(0x126f, 0xa006), .driver_info = DEVICE_ZD1211 },
43 { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
44 { USB_DEVICE(0x0df6, 0x9071), .driver_info = DEVICE_ZD1211 },
45 { USB_DEVICE(0x0df6, 0x9075), .driver_info = DEVICE_ZD1211 },
46 { USB_DEVICE(0x157e, 0x300b), .driver_info = DEVICE_ZD1211 },
47 { USB_DEVICE(0x079b, 0x004a), .driver_info = DEVICE_ZD1211 },
48 { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
49 { USB_DEVICE(0x157e, 0x3204), .driver_info = DEVICE_ZD1211 },
50 { USB_DEVICE(0x0586, 0x3402), .driver_info = DEVICE_ZD1211 },
51 { USB_DEVICE(0x0b3b, 0x5630), .driver_info = DEVICE_ZD1211 },
52 { USB_DEVICE(0x0b05, 0x170c), .driver_info = DEVICE_ZD1211 },
53 { USB_DEVICE(0x1435, 0x0711), .driver_info = DEVICE_ZD1211 },
54 { USB_DEVICE(0x0586, 0x3409), .driver_info = DEVICE_ZD1211 },
55 { USB_DEVICE(0x0b3b, 0x1630), .driver_info = DEVICE_ZD1211 },
56 { USB_DEVICE(0x0586, 0x3401), .driver_info = DEVICE_ZD1211 },
57 { USB_DEVICE(0x14ea, 0xab13), .driver_info = DEVICE_ZD1211 },
58 { USB_DEVICE(0x13b1, 0x001e), .driver_info = DEVICE_ZD1211 },
59 { USB_DEVICE(0x0586, 0x3407), .driver_info = DEVICE_ZD1211 },
60 { USB_DEVICE(0x129b, 0x1666), .driver_info = DEVICE_ZD1211 },
61 { USB_DEVICE(0x157e, 0x300a), .driver_info = DEVICE_ZD1211 },
62 { USB_DEVICE(0x0105, 0x145f), .driver_info = DEVICE_ZD1211 },
64 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
65 { USB_DEVICE(0x0ace, 0xb215), .driver_info = DEVICE_ZD1211B },
66 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x083a, 0xe506), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
83 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
84 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
85 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
86 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
87 { USB_DEVICE(0x07fa, 0x1196), .driver_info = DEVICE_ZD1211B },
88 { USB_DEVICE(0x0df6, 0x0036), .driver_info = DEVICE_ZD1211B },
89 /* "Driverless" devices that need ejecting */
90 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
91 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
95 MODULE_LICENSE("GPL");
96 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
97 MODULE_AUTHOR("Ulrich Kunitz");
98 MODULE_AUTHOR("Daniel Drake");
99 MODULE_VERSION("1.0");
100 MODULE_DEVICE_TABLE(usb, usb_ids);
102 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
103 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
105 /* USB device initialization */
106 static void int_urb_complete(struct urb *urb);
108 static int request_fw_file(
109 const struct firmware **fw, const char *name, struct device *device)
113 dev_dbg_f(device, "fw name %s\n", name);
115 r = request_firmware(fw, name, device);
118 "Could not load firmware file %s. Error number %d\n",
123 static inline u16 get_bcdDevice(const struct usb_device *udev)
125 return le16_to_cpu(udev->descriptor.bcdDevice);
128 enum upload_code_flags {
132 /* Ensures that MAX_TRANSFER_SIZE is even. */
133 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
135 static int upload_code(struct usb_device *udev,
136 const u8 *data, size_t size, u16 code_offset, int flags)
141 /* USB request blocks need "kmalloced" buffers.
143 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
145 dev_err(&udev->dev, "out of memory\n");
152 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
153 size : MAX_TRANSFER_SIZE;
155 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
157 memcpy(p, data, transfer_size);
158 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
159 USB_REQ_FIRMWARE_DOWNLOAD,
160 USB_DIR_OUT | USB_TYPE_VENDOR,
161 code_offset, 0, p, transfer_size, 1000 /* ms */);
164 "USB control request for firmware upload"
165 " failed. Error number %d\n", r);
168 transfer_size = r & ~1;
170 size -= transfer_size;
171 data += transfer_size;
172 code_offset += transfer_size/sizeof(u16);
175 if (flags & REBOOT) {
178 /* Use "DMA-aware" buffer. */
179 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
180 USB_REQ_FIRMWARE_CONFIRM,
181 USB_DIR_IN | USB_TYPE_VENDOR,
182 0, 0, p, sizeof(ret), 5000 /* ms */);
183 if (r != sizeof(ret)) {
185 "control request firmeware confirmation failed."
186 " Return value %d\n", r);
194 "Internal error while downloading."
195 " Firmware confirm return value %#04x\n",
200 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
210 static u16 get_word(const void *data, u16 offset)
212 const __le16 *p = data;
213 return le16_to_cpu(p[offset]);
216 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
219 scnprintf(buffer, size, "%s%s",
221 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
226 static int handle_version_mismatch(struct zd_usb *usb,
227 const struct firmware *ub_fw)
229 struct usb_device *udev = zd_usb_to_usbdev(usb);
230 const struct firmware *ur_fw = NULL;
235 r = request_fw_file(&ur_fw,
236 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
241 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
245 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
246 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
247 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
249 /* At this point, the vendor driver downloads the whole firmware
250 * image, hacks around with version IDs, and uploads it again,
251 * completely overwriting the boot code. We do not do this here as
252 * it is not required on any tested devices, and it is suspected to
255 release_firmware(ur_fw);
259 static int upload_firmware(struct zd_usb *usb)
264 struct usb_device *udev = zd_usb_to_usbdev(usb);
265 const struct firmware *ub_fw = NULL;
266 const struct firmware *uph_fw = NULL;
269 bcdDevice = get_bcdDevice(udev);
271 r = request_fw_file(&ub_fw,
272 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
277 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
279 if (fw_bcdDevice != bcdDevice) {
281 "firmware version %#06x and device bootcode version "
282 "%#06x differ\n", fw_bcdDevice, bcdDevice);
283 if (bcdDevice <= 0x4313)
284 dev_warn(&udev->dev, "device has old bootcode, please "
285 "report success or failure\n");
287 r = handle_version_mismatch(usb, ub_fw);
291 dev_dbg_f(&udev->dev,
292 "firmware device id %#06x is equal to the "
293 "actual device id\n", fw_bcdDevice);
297 r = request_fw_file(&uph_fw,
298 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
303 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
306 "Could not upload firmware code uph. Error number %d\n",
312 release_firmware(ub_fw);
313 release_firmware(uph_fw);
317 /* Read data from device address space using "firmware interface" which does
318 * not require firmware to be loaded. */
319 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
322 struct usb_device *udev = zd_usb_to_usbdev(usb);
325 /* Use "DMA-aware" buffer. */
326 buf = kmalloc(len, GFP_KERNEL);
329 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
330 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
334 "read over firmware interface failed: %d\n", r);
336 } else if (r != len) {
338 "incomplete read over firmware interface: %d/%d\n",
344 memcpy(data, buf, len);
350 #define urb_dev(urb) (&(urb)->dev->dev)
352 static inline void handle_regs_int(struct urb *urb)
354 struct zd_usb *usb = urb->context;
355 struct zd_usb_interrupt *intr = &usb->intr;
359 ZD_ASSERT(in_interrupt());
360 spin_lock(&intr->lock);
362 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
363 if (int_num == CR_INTERRUPT) {
364 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
365 memcpy(&mac->intr_buffer, urb->transfer_buffer,
366 USB_MAX_EP_INT_BUFFER);
367 schedule_work(&mac->process_intr);
368 } else if (intr->read_regs_enabled) {
369 intr->read_regs.length = len = urb->actual_length;
371 if (len > sizeof(intr->read_regs.buffer))
372 len = sizeof(intr->read_regs.buffer);
373 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
374 intr->read_regs_enabled = 0;
375 complete(&intr->read_regs.completion);
380 spin_unlock(&intr->lock);
383 static void int_urb_complete(struct urb *urb)
386 struct usb_int_header *hdr;
388 switch (urb->status) {
402 if (urb->actual_length < sizeof(hdr)) {
403 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
407 hdr = urb->transfer_buffer;
408 if (hdr->type != USB_INT_TYPE) {
409 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
414 case USB_INT_ID_REGS:
415 handle_regs_int(urb);
417 case USB_INT_ID_RETRY_FAILED:
418 zd_mac_tx_failed(zd_usb_to_hw(urb->context));
421 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
422 (unsigned int)hdr->id);
427 r = usb_submit_urb(urb, GFP_ATOMIC);
429 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
434 kfree(urb->transfer_buffer);
437 static inline int int_urb_interval(struct usb_device *udev)
439 switch (udev->speed) {
450 static inline int usb_int_enabled(struct zd_usb *usb)
453 struct zd_usb_interrupt *intr = &usb->intr;
456 spin_lock_irqsave(&intr->lock, flags);
458 spin_unlock_irqrestore(&intr->lock, flags);
462 int zd_usb_enable_int(struct zd_usb *usb)
465 struct usb_device *udev;
466 struct zd_usb_interrupt *intr = &usb->intr;
467 void *transfer_buffer = NULL;
470 dev_dbg_f(zd_usb_dev(usb), "\n");
472 urb = usb_alloc_urb(0, GFP_KERNEL);
478 ZD_ASSERT(!irqs_disabled());
479 spin_lock_irq(&intr->lock);
481 spin_unlock_irq(&intr->lock);
486 spin_unlock_irq(&intr->lock);
488 /* TODO: make it a DMA buffer */
490 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
491 if (!transfer_buffer) {
492 dev_dbg_f(zd_usb_dev(usb),
493 "couldn't allocate transfer_buffer\n");
494 goto error_set_urb_null;
497 udev = zd_usb_to_usbdev(usb);
498 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
499 transfer_buffer, USB_MAX_EP_INT_BUFFER,
500 int_urb_complete, usb,
503 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
504 r = usb_submit_urb(urb, GFP_KERNEL);
506 dev_dbg_f(zd_usb_dev(usb),
507 "Couldn't submit urb. Error number %d\n", r);
513 kfree(transfer_buffer);
515 spin_lock_irq(&intr->lock);
517 spin_unlock_irq(&intr->lock);
524 void zd_usb_disable_int(struct zd_usb *usb)
527 struct zd_usb_interrupt *intr = &usb->intr;
530 spin_lock_irqsave(&intr->lock, flags);
533 spin_unlock_irqrestore(&intr->lock, flags);
537 spin_unlock_irqrestore(&intr->lock, flags);
540 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
544 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
548 const struct rx_length_info *length_info;
550 if (length < sizeof(struct rx_length_info)) {
551 /* It's not a complete packet anyhow. */
554 length_info = (struct rx_length_info *)
555 (buffer + length - sizeof(struct rx_length_info));
557 /* It might be that three frames are merged into a single URB
558 * transaction. We have to check for the length info tag.
560 * While testing we discovered that length_info might be unaligned,
561 * because if USB transactions are merged, the last packet will not
562 * be padded. Unaligned access might also happen if the length_info
563 * structure is not present.
565 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
567 unsigned int l, k, n;
568 for (i = 0, l = 0;; i++) {
569 k = get_unaligned_le16(&length_info->length[i]);
575 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
581 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
585 static void rx_urb_complete(struct urb *urb)
588 struct zd_usb_rx *rx;
592 switch (urb->status) {
603 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
607 buffer = urb->transfer_buffer;
608 length = urb->actual_length;
612 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
613 /* If there is an old first fragment, we don't care. */
614 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
615 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
616 spin_lock(&rx->lock);
617 memcpy(rx->fragment, buffer, length);
618 rx->fragment_length = length;
619 spin_unlock(&rx->lock);
623 spin_lock(&rx->lock);
624 if (rx->fragment_length > 0) {
625 /* We are on a second fragment, we believe */
626 ZD_ASSERT(length + rx->fragment_length <=
627 ARRAY_SIZE(rx->fragment));
628 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
629 memcpy(rx->fragment+rx->fragment_length, buffer, length);
630 handle_rx_packet(usb, rx->fragment,
631 rx->fragment_length + length);
632 rx->fragment_length = 0;
633 spin_unlock(&rx->lock);
635 spin_unlock(&rx->lock);
636 handle_rx_packet(usb, buffer, length);
640 usb_submit_urb(urb, GFP_ATOMIC);
643 static struct urb *alloc_rx_urb(struct zd_usb *usb)
645 struct usb_device *udev = zd_usb_to_usbdev(usb);
649 urb = usb_alloc_urb(0, GFP_KERNEL);
652 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
659 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
660 buffer, USB_MAX_RX_SIZE,
661 rx_urb_complete, usb);
662 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
667 static void free_rx_urb(struct urb *urb)
671 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
672 urb->transfer_buffer, urb->transfer_dma);
676 int zd_usb_enable_rx(struct zd_usb *usb)
679 struct zd_usb_rx *rx = &usb->rx;
682 dev_dbg_f(zd_usb_dev(usb), "\n");
685 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
688 for (i = 0; i < RX_URBS_COUNT; i++) {
689 urbs[i] = alloc_rx_urb(usb);
694 ZD_ASSERT(!irqs_disabled());
695 spin_lock_irq(&rx->lock);
697 spin_unlock_irq(&rx->lock);
702 rx->urbs_count = RX_URBS_COUNT;
703 spin_unlock_irq(&rx->lock);
705 for (i = 0; i < RX_URBS_COUNT; i++) {
706 r = usb_submit_urb(urbs[i], GFP_KERNEL);
713 for (i = 0; i < RX_URBS_COUNT; i++) {
714 usb_kill_urb(urbs[i]);
716 spin_lock_irq(&rx->lock);
719 spin_unlock_irq(&rx->lock);
722 for (i = 0; i < RX_URBS_COUNT; i++)
723 free_rx_urb(urbs[i]);
728 void zd_usb_disable_rx(struct zd_usb *usb)
734 struct zd_usb_rx *rx = &usb->rx;
736 spin_lock_irqsave(&rx->lock, flags);
738 count = rx->urbs_count;
739 spin_unlock_irqrestore(&rx->lock, flags);
743 for (i = 0; i < count; i++) {
744 usb_kill_urb(urbs[i]);
745 free_rx_urb(urbs[i]);
749 spin_lock_irqsave(&rx->lock, flags);
752 spin_unlock_irqrestore(&rx->lock, flags);
756 * zd_usb_disable_tx - disable transmission
757 * @usb: the zd1211rw-private USB structure
759 * Frees all URBs in the free list and marks the transmission as disabled.
761 void zd_usb_disable_tx(struct zd_usb *usb)
763 struct zd_usb_tx *tx = &usb->tx;
765 struct list_head *pos, *n;
767 spin_lock_irqsave(&tx->lock, flags);
768 list_for_each_safe(pos, n, &tx->free_urb_list) {
770 usb_free_urb(list_entry(pos, struct urb, urb_list));
773 tx->submitted_urbs = 0;
774 /* The stopped state is ignored, relying on ieee80211_wake_queues()
775 * in a potentionally following zd_usb_enable_tx().
777 spin_unlock_irqrestore(&tx->lock, flags);
781 * zd_usb_enable_tx - enables transmission
782 * @usb: a &struct zd_usb pointer
784 * This function enables transmission and prepares the &zd_usb_tx data
787 void zd_usb_enable_tx(struct zd_usb *usb)
790 struct zd_usb_tx *tx = &usb->tx;
792 spin_lock_irqsave(&tx->lock, flags);
794 tx->submitted_urbs = 0;
795 ieee80211_wake_queues(zd_usb_to_hw(usb));
797 spin_unlock_irqrestore(&tx->lock, flags);
801 * alloc_tx_urb - provides an tx URB
802 * @usb: a &struct zd_usb pointer
804 * Allocates a new URB. If possible takes the urb from the free list in
807 static struct urb *alloc_tx_urb(struct zd_usb *usb)
809 struct zd_usb_tx *tx = &usb->tx;
811 struct list_head *entry;
814 spin_lock_irqsave(&tx->lock, flags);
815 if (list_empty(&tx->free_urb_list)) {
816 urb = usb_alloc_urb(0, GFP_ATOMIC);
819 entry = tx->free_urb_list.next;
821 urb = list_entry(entry, struct urb, urb_list);
823 spin_unlock_irqrestore(&tx->lock, flags);
828 * free_tx_urb - frees a used tx URB
829 * @usb: a &struct zd_usb pointer
830 * @urb: URB to be freed
832 * Frees the the transmission URB, which means to put it on the free URB
835 static void free_tx_urb(struct zd_usb *usb, struct urb *urb)
837 struct zd_usb_tx *tx = &usb->tx;
840 spin_lock_irqsave(&tx->lock, flags);
845 list_add(&urb->urb_list, &tx->free_urb_list);
847 spin_unlock_irqrestore(&tx->lock, flags);
850 static void tx_dec_submitted_urbs(struct zd_usb *usb)
852 struct zd_usb_tx *tx = &usb->tx;
855 spin_lock_irqsave(&tx->lock, flags);
856 --tx->submitted_urbs;
857 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
858 ieee80211_wake_queues(zd_usb_to_hw(usb));
861 spin_unlock_irqrestore(&tx->lock, flags);
864 static void tx_inc_submitted_urbs(struct zd_usb *usb)
866 struct zd_usb_tx *tx = &usb->tx;
869 spin_lock_irqsave(&tx->lock, flags);
870 ++tx->submitted_urbs;
871 if (!tx->stopped && tx->submitted_urbs > ZD_USB_TX_HIGH) {
872 ieee80211_stop_queues(zd_usb_to_hw(usb));
875 spin_unlock_irqrestore(&tx->lock, flags);
879 * tx_urb_complete - completes the execution of an URB
882 * This function is called if the URB has been transferred to a device or an
883 * error has happened.
885 static void tx_urb_complete(struct urb *urb)
889 struct ieee80211_tx_info *info;
892 switch (urb->status) {
901 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
904 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
908 skb = (struct sk_buff *)urb->context;
910 * grab 'usb' pointer before handing off the skb (since
911 * it might be freed by zd_mac_tx_to_dev or mac80211)
913 info = IEEE80211_SKB_CB(skb);
914 usb = &zd_hw_mac(info->rate_driver_data[0])->chip.usb;
915 zd_mac_tx_to_dev(skb, urb->status);
916 free_tx_urb(usb, urb);
917 tx_dec_submitted_urbs(usb);
920 r = usb_submit_urb(urb, GFP_ATOMIC);
922 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
928 * zd_usb_tx: initiates transfer of a frame of the device
930 * @usb: the zd1211rw-private USB structure
931 * @skb: a &struct sk_buff pointer
933 * This function tranmits a frame to the device. It doesn't wait for
934 * completion. The frame must contain the control set and have all the
935 * control set information available.
937 * The function returns 0 if the transfer has been successfully initiated.
939 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
942 struct usb_device *udev = zd_usb_to_usbdev(usb);
945 urb = alloc_tx_urb(usb);
951 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
952 skb->data, skb->len, tx_urb_complete, skb);
954 r = usb_submit_urb(urb, GFP_ATOMIC);
957 tx_inc_submitted_urbs(usb);
960 free_tx_urb(usb, urb);
965 static inline void init_usb_interrupt(struct zd_usb *usb)
967 struct zd_usb_interrupt *intr = &usb->intr;
969 spin_lock_init(&intr->lock);
970 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
971 init_completion(&intr->read_regs.completion);
972 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
975 static inline void init_usb_rx(struct zd_usb *usb)
977 struct zd_usb_rx *rx = &usb->rx;
978 spin_lock_init(&rx->lock);
979 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
980 rx->usb_packet_size = 512;
982 rx->usb_packet_size = 64;
984 ZD_ASSERT(rx->fragment_length == 0);
987 static inline void init_usb_tx(struct zd_usb *usb)
989 struct zd_usb_tx *tx = &usb->tx;
990 spin_lock_init(&tx->lock);
993 INIT_LIST_HEAD(&tx->free_urb_list);
994 tx->submitted_urbs = 0;
997 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
998 struct usb_interface *intf)
1000 memset(usb, 0, sizeof(*usb));
1001 usb->intf = usb_get_intf(intf);
1002 usb_set_intfdata(usb->intf, hw);
1003 init_usb_interrupt(usb);
1008 void zd_usb_clear(struct zd_usb *usb)
1010 usb_set_intfdata(usb->intf, NULL);
1011 usb_put_intf(usb->intf);
1012 ZD_MEMCLEAR(usb, sizeof(*usb));
1013 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
1016 static const char *speed(enum usb_device_speed speed)
1021 case USB_SPEED_FULL:
1023 case USB_SPEED_HIGH:
1026 return "unknown speed";
1030 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
1032 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
1033 le16_to_cpu(udev->descriptor.idVendor),
1034 le16_to_cpu(udev->descriptor.idProduct),
1035 get_bcdDevice(udev),
1036 speed(udev->speed));
1039 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
1041 struct usb_device *udev = interface_to_usbdev(usb->intf);
1042 return scnprint_id(udev, buffer, size);
1046 static void print_id(struct usb_device *udev)
1050 scnprint_id(udev, buffer, sizeof(buffer));
1051 buffer[sizeof(buffer)-1] = 0;
1052 dev_dbg_f(&udev->dev, "%s\n", buffer);
1055 #define print_id(udev) do { } while (0)
1058 static int eject_installer(struct usb_interface *intf)
1060 struct usb_device *udev = interface_to_usbdev(intf);
1061 struct usb_host_interface *iface_desc = &intf->altsetting[0];
1062 struct usb_endpoint_descriptor *endpoint;
1067 /* Find bulk out endpoint */
1068 endpoint = &iface_desc->endpoint[1].desc;
1069 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
1070 usb_endpoint_xfer_bulk(endpoint)) {
1071 bulk_out_ep = endpoint->bEndpointAddress;
1074 "zd1211rw: Could not find bulk out endpoint\n");
1078 cmd = kzalloc(31, GFP_KERNEL);
1082 /* USB bulk command block */
1083 cmd[0] = 0x55; /* bulk command signature */
1084 cmd[1] = 0x53; /* bulk command signature */
1085 cmd[2] = 0x42; /* bulk command signature */
1086 cmd[3] = 0x43; /* bulk command signature */
1087 cmd[14] = 6; /* command length */
1089 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1090 cmd[19] = 0x2; /* eject disc */
1092 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1093 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1094 cmd, 31, NULL, 2000);
1099 /* At this point, the device disconnects and reconnects with the real
1102 usb_set_intfdata(intf, NULL);
1106 int zd_usb_init_hw(struct zd_usb *usb)
1109 struct zd_mac *mac = zd_usb_to_mac(usb);
1111 dev_dbg_f(zd_usb_dev(usb), "\n");
1113 r = upload_firmware(usb);
1115 dev_err(zd_usb_dev(usb),
1116 "couldn't load firmware. Error number %d\n", r);
1120 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1122 dev_dbg_f(zd_usb_dev(usb),
1123 "couldn't reset configuration. Error number %d\n", r);
1127 r = zd_mac_init_hw(mac->hw);
1129 dev_dbg_f(zd_usb_dev(usb),
1130 "couldn't initialize mac. Error number %d\n", r);
1134 usb->initialized = 1;
1138 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1141 struct usb_device *udev = interface_to_usbdev(intf);
1143 struct ieee80211_hw *hw = NULL;
1147 if (id->driver_info & DEVICE_INSTALLER)
1148 return eject_installer(intf);
1150 switch (udev->speed) {
1152 case USB_SPEED_FULL:
1153 case USB_SPEED_HIGH:
1156 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1161 r = usb_reset_device(udev);
1164 "couldn't reset usb device. Error number %d\n", r);
1168 hw = zd_mac_alloc_hw(intf);
1174 usb = &zd_hw_mac(hw)->chip.usb;
1175 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1177 r = zd_mac_preinit_hw(hw);
1179 dev_dbg_f(&intf->dev,
1180 "couldn't initialize mac. Error number %d\n", r);
1184 r = ieee80211_register_hw(hw);
1186 dev_dbg_f(&intf->dev,
1187 "couldn't register device. Error number %d\n", r);
1191 dev_dbg_f(&intf->dev, "successful\n");
1192 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1195 usb_reset_device(interface_to_usbdev(intf));
1197 zd_mac_clear(zd_hw_mac(hw));
1198 ieee80211_free_hw(hw);
1203 static void disconnect(struct usb_interface *intf)
1205 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1209 /* Either something really bad happened, or we're just dealing with
1210 * a DEVICE_INSTALLER. */
1214 mac = zd_hw_mac(hw);
1215 usb = &mac->chip.usb;
1217 dev_dbg_f(zd_usb_dev(usb), "\n");
1219 ieee80211_unregister_hw(hw);
1221 /* Just in case something has gone wrong! */
1222 zd_usb_disable_rx(usb);
1223 zd_usb_disable_int(usb);
1225 /* If the disconnect has been caused by a removal of the
1226 * driver module, the reset allows reloading of the driver. If the
1227 * reset will not be executed here, the upload of the firmware in the
1228 * probe function caused by the reloading of the driver will fail.
1230 usb_reset_device(interface_to_usbdev(intf));
1233 ieee80211_free_hw(hw);
1234 dev_dbg(&intf->dev, "disconnected\n");
1237 static struct usb_driver driver = {
1238 .name = KBUILD_MODNAME,
1239 .id_table = usb_ids,
1241 .disconnect = disconnect,
1244 struct workqueue_struct *zd_workqueue;
1246 static int __init usb_init(void)
1250 pr_debug("%s usb_init()\n", driver.name);
1252 zd_workqueue = create_singlethread_workqueue(driver.name);
1253 if (zd_workqueue == NULL) {
1254 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1258 r = usb_register(&driver);
1260 destroy_workqueue(zd_workqueue);
1261 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1266 pr_debug("%s initialized\n", driver.name);
1270 static void __exit usb_exit(void)
1272 pr_debug("%s usb_exit()\n", driver.name);
1273 usb_deregister(&driver);
1274 destroy_workqueue(zd_workqueue);
1277 module_init(usb_init);
1278 module_exit(usb_exit);
1280 static int usb_int_regs_length(unsigned int count)
1282 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1285 static void prepare_read_regs_int(struct zd_usb *usb)
1287 struct zd_usb_interrupt *intr = &usb->intr;
1289 spin_lock_irq(&intr->lock);
1290 intr->read_regs_enabled = 1;
1291 INIT_COMPLETION(intr->read_regs.completion);
1292 spin_unlock_irq(&intr->lock);
1295 static void disable_read_regs_int(struct zd_usb *usb)
1297 struct zd_usb_interrupt *intr = &usb->intr;
1299 spin_lock_irq(&intr->lock);
1300 intr->read_regs_enabled = 0;
1301 spin_unlock_irq(&intr->lock);
1304 static int get_results(struct zd_usb *usb, u16 *values,
1305 struct usb_req_read_regs *req, unsigned int count)
1309 struct zd_usb_interrupt *intr = &usb->intr;
1310 struct read_regs_int *rr = &intr->read_regs;
1311 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1313 spin_lock_irq(&intr->lock);
1316 /* The created block size seems to be larger than expected.
1317 * However results appear to be correct.
1319 if (rr->length < usb_int_regs_length(count)) {
1320 dev_dbg_f(zd_usb_dev(usb),
1321 "error: actual length %d less than expected %d\n",
1322 rr->length, usb_int_regs_length(count));
1325 if (rr->length > sizeof(rr->buffer)) {
1326 dev_dbg_f(zd_usb_dev(usb),
1327 "error: actual length %d exceeds buffer size %zu\n",
1328 rr->length, sizeof(rr->buffer));
1332 for (i = 0; i < count; i++) {
1333 struct reg_data *rd = ®s->regs[i];
1334 if (rd->addr != req->addr[i]) {
1335 dev_dbg_f(zd_usb_dev(usb),
1336 "rd[%d] addr %#06hx expected %#06hx\n", i,
1337 le16_to_cpu(rd->addr),
1338 le16_to_cpu(req->addr[i]));
1341 values[i] = le16_to_cpu(rd->value);
1346 spin_unlock_irq(&intr->lock);
1350 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1351 const zd_addr_t *addresses, unsigned int count)
1354 int i, req_len, actual_req_len;
1355 struct usb_device *udev;
1356 struct usb_req_read_regs *req = NULL;
1357 unsigned long timeout;
1360 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1363 if (count > USB_MAX_IOREAD16_COUNT) {
1364 dev_dbg_f(zd_usb_dev(usb),
1365 "error: count %u exceeds possible max %u\n",
1366 count, USB_MAX_IOREAD16_COUNT);
1370 dev_dbg_f(zd_usb_dev(usb),
1371 "error: io in atomic context not supported\n");
1372 return -EWOULDBLOCK;
1374 if (!usb_int_enabled(usb)) {
1375 dev_dbg_f(zd_usb_dev(usb),
1376 "error: usb interrupt not enabled\n");
1377 return -EWOULDBLOCK;
1380 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1381 req = kmalloc(req_len, GFP_KERNEL);
1384 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1385 for (i = 0; i < count; i++)
1386 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1388 udev = zd_usb_to_usbdev(usb);
1389 prepare_read_regs_int(usb);
1390 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1391 req, req_len, &actual_req_len, 1000 /* ms */);
1393 dev_dbg_f(zd_usb_dev(usb),
1394 "error in usb_bulk_msg(). Error number %d\n", r);
1397 if (req_len != actual_req_len) {
1398 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1399 " req_len %d != actual_req_len %d\n",
1400 req_len, actual_req_len);
1405 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1406 msecs_to_jiffies(1000));
1408 disable_read_regs_int(usb);
1409 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1414 r = get_results(usb, values, req, count);
1420 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1424 struct usb_device *udev;
1425 struct usb_req_write_regs *req = NULL;
1426 int i, req_len, actual_req_len;
1430 if (count > USB_MAX_IOWRITE16_COUNT) {
1431 dev_dbg_f(zd_usb_dev(usb),
1432 "error: count %u exceeds possible max %u\n",
1433 count, USB_MAX_IOWRITE16_COUNT);
1437 dev_dbg_f(zd_usb_dev(usb),
1438 "error: io in atomic context not supported\n");
1439 return -EWOULDBLOCK;
1442 req_len = sizeof(struct usb_req_write_regs) +
1443 count * sizeof(struct reg_data);
1444 req = kmalloc(req_len, GFP_KERNEL);
1448 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1449 for (i = 0; i < count; i++) {
1450 struct reg_data *rw = &req->reg_writes[i];
1451 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1452 rw->value = cpu_to_le16(ioreqs[i].value);
1455 udev = zd_usb_to_usbdev(usb);
1456 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1457 req, req_len, &actual_req_len, 1000 /* ms */);
1459 dev_dbg_f(zd_usb_dev(usb),
1460 "error in usb_bulk_msg(). Error number %d\n", r);
1463 if (req_len != actual_req_len) {
1464 dev_dbg_f(zd_usb_dev(usb),
1465 "error in usb_bulk_msg()"
1466 " req_len %d != actual_req_len %d\n",
1467 req_len, actual_req_len);
1472 /* FALL-THROUGH with r == 0 */
1478 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1481 struct usb_device *udev;
1482 struct usb_req_rfwrite *req = NULL;
1483 int i, req_len, actual_req_len;
1484 u16 bit_value_template;
1487 dev_dbg_f(zd_usb_dev(usb),
1488 "error: io in atomic context not supported\n");
1489 return -EWOULDBLOCK;
1491 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1492 dev_dbg_f(zd_usb_dev(usb),
1493 "error: bits %d are smaller than"
1494 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1495 bits, USB_MIN_RFWRITE_BIT_COUNT);
1498 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1499 dev_dbg_f(zd_usb_dev(usb),
1500 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1501 bits, USB_MAX_RFWRITE_BIT_COUNT);
1505 if (value & (~0UL << bits)) {
1506 dev_dbg_f(zd_usb_dev(usb),
1507 "error: value %#09x has bits >= %d set\n",
1513 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1515 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1517 dev_dbg_f(zd_usb_dev(usb),
1518 "error %d: Couldn't read CR203\n", r);
1521 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1523 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1524 req = kmalloc(req_len, GFP_KERNEL);
1528 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1529 /* 1: 3683a, but not used in ZYDAS driver */
1530 req->value = cpu_to_le16(2);
1531 req->bits = cpu_to_le16(bits);
1533 for (i = 0; i < bits; i++) {
1534 u16 bv = bit_value_template;
1535 if (value & (1 << (bits-1-i)))
1537 req->bit_values[i] = cpu_to_le16(bv);
1540 udev = zd_usb_to_usbdev(usb);
1541 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1542 req, req_len, &actual_req_len, 1000 /* ms */);
1544 dev_dbg_f(zd_usb_dev(usb),
1545 "error in usb_bulk_msg(). Error number %d\n", r);
1548 if (req_len != actual_req_len) {
1549 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1550 " req_len %d != actual_req_len %d\n",
1551 req_len, actual_req_len);
1556 /* FALL-THROUGH with r == 0 */