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 },
62 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
63 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
64 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
65 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
66 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
83 /* "Driverless" devices that need ejecting */
84 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
85 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
89 MODULE_LICENSE("GPL");
90 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
91 MODULE_AUTHOR("Ulrich Kunitz");
92 MODULE_AUTHOR("Daniel Drake");
93 MODULE_VERSION("1.0");
94 MODULE_DEVICE_TABLE(usb, usb_ids);
96 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
97 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
99 /* USB device initialization */
100 static void int_urb_complete(struct urb *urb);
102 static int request_fw_file(
103 const struct firmware **fw, const char *name, struct device *device)
107 dev_dbg_f(device, "fw name %s\n", name);
109 r = request_firmware(fw, name, device);
112 "Could not load firmware file %s. Error number %d\n",
117 static inline u16 get_bcdDevice(const struct usb_device *udev)
119 return le16_to_cpu(udev->descriptor.bcdDevice);
122 enum upload_code_flags {
126 /* Ensures that MAX_TRANSFER_SIZE is even. */
127 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
129 static int upload_code(struct usb_device *udev,
130 const u8 *data, size_t size, u16 code_offset, int flags)
135 /* USB request blocks need "kmalloced" buffers.
137 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
139 dev_err(&udev->dev, "out of memory\n");
146 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
147 size : MAX_TRANSFER_SIZE;
149 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
151 memcpy(p, data, transfer_size);
152 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
153 USB_REQ_FIRMWARE_DOWNLOAD,
154 USB_DIR_OUT | USB_TYPE_VENDOR,
155 code_offset, 0, p, transfer_size, 1000 /* ms */);
158 "USB control request for firmware upload"
159 " failed. Error number %d\n", r);
162 transfer_size = r & ~1;
164 size -= transfer_size;
165 data += transfer_size;
166 code_offset += transfer_size/sizeof(u16);
169 if (flags & REBOOT) {
172 /* Use "DMA-aware" buffer. */
173 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
174 USB_REQ_FIRMWARE_CONFIRM,
175 USB_DIR_IN | USB_TYPE_VENDOR,
176 0, 0, p, sizeof(ret), 5000 /* ms */);
177 if (r != sizeof(ret)) {
179 "control request firmeware confirmation failed."
180 " Return value %d\n", r);
188 "Internal error while downloading."
189 " Firmware confirm return value %#04x\n",
194 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
204 static u16 get_word(const void *data, u16 offset)
206 const __le16 *p = data;
207 return le16_to_cpu(p[offset]);
210 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
213 scnprintf(buffer, size, "%s%s",
215 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
220 static int handle_version_mismatch(struct zd_usb *usb,
221 const struct firmware *ub_fw)
223 struct usb_device *udev = zd_usb_to_usbdev(usb);
224 const struct firmware *ur_fw = NULL;
229 r = request_fw_file(&ur_fw,
230 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
235 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
239 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
240 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
241 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
243 /* At this point, the vendor driver downloads the whole firmware
244 * image, hacks around with version IDs, and uploads it again,
245 * completely overwriting the boot code. We do not do this here as
246 * it is not required on any tested devices, and it is suspected to
249 release_firmware(ur_fw);
253 static int upload_firmware(struct zd_usb *usb)
258 struct usb_device *udev = zd_usb_to_usbdev(usb);
259 const struct firmware *ub_fw = NULL;
260 const struct firmware *uph_fw = NULL;
263 bcdDevice = get_bcdDevice(udev);
265 r = request_fw_file(&ub_fw,
266 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
271 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
273 if (fw_bcdDevice != bcdDevice) {
275 "firmware version %#06x and device bootcode version "
276 "%#06x differ\n", fw_bcdDevice, bcdDevice);
277 if (bcdDevice <= 0x4313)
278 dev_warn(&udev->dev, "device has old bootcode, please "
279 "report success or failure\n");
281 r = handle_version_mismatch(usb, ub_fw);
285 dev_dbg_f(&udev->dev,
286 "firmware device id %#06x is equal to the "
287 "actual device id\n", fw_bcdDevice);
291 r = request_fw_file(&uph_fw,
292 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
297 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
300 "Could not upload firmware code uph. Error number %d\n",
306 release_firmware(ub_fw);
307 release_firmware(uph_fw);
311 /* Read data from device address space using "firmware interface" which does
312 * not require firmware to be loaded. */
313 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
316 struct usb_device *udev = zd_usb_to_usbdev(usb);
319 /* Use "DMA-aware" buffer. */
320 buf = kmalloc(len, GFP_KERNEL);
323 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
324 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
328 "read over firmware interface failed: %d\n", r);
330 } else if (r != len) {
332 "incomplete read over firmware interface: %d/%d\n",
338 memcpy(data, buf, len);
344 #define urb_dev(urb) (&(urb)->dev->dev)
346 static inline void handle_regs_int(struct urb *urb)
348 struct zd_usb *usb = urb->context;
349 struct zd_usb_interrupt *intr = &usb->intr;
353 ZD_ASSERT(in_interrupt());
354 spin_lock(&intr->lock);
356 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
357 if (int_num == CR_INTERRUPT) {
358 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
359 memcpy(&mac->intr_buffer, urb->transfer_buffer,
360 USB_MAX_EP_INT_BUFFER);
361 schedule_work(&mac->process_intr);
362 } else if (intr->read_regs_enabled) {
363 intr->read_regs.length = len = urb->actual_length;
365 if (len > sizeof(intr->read_regs.buffer))
366 len = sizeof(intr->read_regs.buffer);
367 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
368 intr->read_regs_enabled = 0;
369 complete(&intr->read_regs.completion);
374 spin_unlock(&intr->lock);
377 static void int_urb_complete(struct urb *urb)
380 struct usb_int_header *hdr;
382 switch (urb->status) {
396 if (urb->actual_length < sizeof(hdr)) {
397 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
401 hdr = urb->transfer_buffer;
402 if (hdr->type != USB_INT_TYPE) {
403 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
408 case USB_INT_ID_REGS:
409 handle_regs_int(urb);
411 case USB_INT_ID_RETRY_FAILED:
412 zd_mac_tx_failed(zd_usb_to_hw(urb->context));
415 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
416 (unsigned int)hdr->id);
421 r = usb_submit_urb(urb, GFP_ATOMIC);
423 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
428 kfree(urb->transfer_buffer);
431 static inline int int_urb_interval(struct usb_device *udev)
433 switch (udev->speed) {
444 static inline int usb_int_enabled(struct zd_usb *usb)
447 struct zd_usb_interrupt *intr = &usb->intr;
450 spin_lock_irqsave(&intr->lock, flags);
452 spin_unlock_irqrestore(&intr->lock, flags);
456 int zd_usb_enable_int(struct zd_usb *usb)
459 struct usb_device *udev;
460 struct zd_usb_interrupt *intr = &usb->intr;
461 void *transfer_buffer = NULL;
464 dev_dbg_f(zd_usb_dev(usb), "\n");
466 urb = usb_alloc_urb(0, GFP_KERNEL);
472 ZD_ASSERT(!irqs_disabled());
473 spin_lock_irq(&intr->lock);
475 spin_unlock_irq(&intr->lock);
480 spin_unlock_irq(&intr->lock);
482 /* TODO: make it a DMA buffer */
484 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
485 if (!transfer_buffer) {
486 dev_dbg_f(zd_usb_dev(usb),
487 "couldn't allocate transfer_buffer\n");
488 goto error_set_urb_null;
491 udev = zd_usb_to_usbdev(usb);
492 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
493 transfer_buffer, USB_MAX_EP_INT_BUFFER,
494 int_urb_complete, usb,
497 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
498 r = usb_submit_urb(urb, GFP_KERNEL);
500 dev_dbg_f(zd_usb_dev(usb),
501 "Couldn't submit urb. Error number %d\n", r);
507 kfree(transfer_buffer);
509 spin_lock_irq(&intr->lock);
511 spin_unlock_irq(&intr->lock);
518 void zd_usb_disable_int(struct zd_usb *usb)
521 struct zd_usb_interrupt *intr = &usb->intr;
524 spin_lock_irqsave(&intr->lock, flags);
527 spin_unlock_irqrestore(&intr->lock, flags);
531 spin_unlock_irqrestore(&intr->lock, flags);
534 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
538 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
542 const struct rx_length_info *length_info;
544 if (length < sizeof(struct rx_length_info)) {
545 /* It's not a complete packet anyhow. */
548 length_info = (struct rx_length_info *)
549 (buffer + length - sizeof(struct rx_length_info));
551 /* It might be that three frames are merged into a single URB
552 * transaction. We have to check for the length info tag.
554 * While testing we discovered that length_info might be unaligned,
555 * because if USB transactions are merged, the last packet will not
556 * be padded. Unaligned access might also happen if the length_info
557 * structure is not present.
559 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
561 unsigned int l, k, n;
562 for (i = 0, l = 0;; i++) {
563 k = get_unaligned_le16(&length_info->length[i]);
569 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
575 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
579 static void rx_urb_complete(struct urb *urb)
582 struct zd_usb_rx *rx;
586 switch (urb->status) {
597 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
601 buffer = urb->transfer_buffer;
602 length = urb->actual_length;
606 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
607 /* If there is an old first fragment, we don't care. */
608 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
609 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
610 spin_lock(&rx->lock);
611 memcpy(rx->fragment, buffer, length);
612 rx->fragment_length = length;
613 spin_unlock(&rx->lock);
617 spin_lock(&rx->lock);
618 if (rx->fragment_length > 0) {
619 /* We are on a second fragment, we believe */
620 ZD_ASSERT(length + rx->fragment_length <=
621 ARRAY_SIZE(rx->fragment));
622 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
623 memcpy(rx->fragment+rx->fragment_length, buffer, length);
624 handle_rx_packet(usb, rx->fragment,
625 rx->fragment_length + length);
626 rx->fragment_length = 0;
627 spin_unlock(&rx->lock);
629 spin_unlock(&rx->lock);
630 handle_rx_packet(usb, buffer, length);
634 usb_submit_urb(urb, GFP_ATOMIC);
637 static struct urb *alloc_rx_urb(struct zd_usb *usb)
639 struct usb_device *udev = zd_usb_to_usbdev(usb);
643 urb = usb_alloc_urb(0, GFP_KERNEL);
646 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
653 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
654 buffer, USB_MAX_RX_SIZE,
655 rx_urb_complete, usb);
656 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
661 static void free_rx_urb(struct urb *urb)
665 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
666 urb->transfer_buffer, urb->transfer_dma);
670 int zd_usb_enable_rx(struct zd_usb *usb)
673 struct zd_usb_rx *rx = &usb->rx;
676 dev_dbg_f(zd_usb_dev(usb), "\n");
679 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
682 for (i = 0; i < RX_URBS_COUNT; i++) {
683 urbs[i] = alloc_rx_urb(usb);
688 ZD_ASSERT(!irqs_disabled());
689 spin_lock_irq(&rx->lock);
691 spin_unlock_irq(&rx->lock);
696 rx->urbs_count = RX_URBS_COUNT;
697 spin_unlock_irq(&rx->lock);
699 for (i = 0; i < RX_URBS_COUNT; i++) {
700 r = usb_submit_urb(urbs[i], GFP_KERNEL);
707 for (i = 0; i < RX_URBS_COUNT; i++) {
708 usb_kill_urb(urbs[i]);
710 spin_lock_irq(&rx->lock);
713 spin_unlock_irq(&rx->lock);
716 for (i = 0; i < RX_URBS_COUNT; i++)
717 free_rx_urb(urbs[i]);
722 void zd_usb_disable_rx(struct zd_usb *usb)
728 struct zd_usb_rx *rx = &usb->rx;
730 spin_lock_irqsave(&rx->lock, flags);
732 count = rx->urbs_count;
733 spin_unlock_irqrestore(&rx->lock, flags);
737 for (i = 0; i < count; i++) {
738 usb_kill_urb(urbs[i]);
739 free_rx_urb(urbs[i]);
743 spin_lock_irqsave(&rx->lock, flags);
746 spin_unlock_irqrestore(&rx->lock, flags);
750 * zd_usb_disable_tx - disable transmission
751 * @usb: the zd1211rw-private USB structure
753 * Frees all URBs in the free list and marks the transmission as disabled.
755 void zd_usb_disable_tx(struct zd_usb *usb)
757 struct zd_usb_tx *tx = &usb->tx;
759 struct list_head *pos, *n;
761 spin_lock_irqsave(&tx->lock, flags);
762 list_for_each_safe(pos, n, &tx->free_urb_list) {
764 usb_free_urb(list_entry(pos, struct urb, urb_list));
767 tx->submitted_urbs = 0;
768 /* The stopped state is ignored, relying on ieee80211_wake_queues()
769 * in a potentionally following zd_usb_enable_tx().
771 spin_unlock_irqrestore(&tx->lock, flags);
775 * zd_usb_enable_tx - enables transmission
776 * @usb: a &struct zd_usb pointer
778 * This function enables transmission and prepares the &zd_usb_tx data
781 void zd_usb_enable_tx(struct zd_usb *usb)
784 struct zd_usb_tx *tx = &usb->tx;
786 spin_lock_irqsave(&tx->lock, flags);
788 tx->submitted_urbs = 0;
789 ieee80211_wake_queues(zd_usb_to_hw(usb));
791 spin_unlock_irqrestore(&tx->lock, flags);
795 * alloc_tx_urb - provides an tx URB
796 * @usb: a &struct zd_usb pointer
798 * Allocates a new URB. If possible takes the urb from the free list in
801 static struct urb *alloc_tx_urb(struct zd_usb *usb)
803 struct zd_usb_tx *tx = &usb->tx;
805 struct list_head *entry;
808 spin_lock_irqsave(&tx->lock, flags);
809 if (list_empty(&tx->free_urb_list)) {
810 urb = usb_alloc_urb(0, GFP_ATOMIC);
813 entry = tx->free_urb_list.next;
815 urb = list_entry(entry, struct urb, urb_list);
817 spin_unlock_irqrestore(&tx->lock, flags);
822 * free_tx_urb - frees a used tx URB
823 * @usb: a &struct zd_usb pointer
824 * @urb: URB to be freed
826 * Frees the the transmission URB, which means to put it on the free URB
829 static void free_tx_urb(struct zd_usb *usb, struct urb *urb)
831 struct zd_usb_tx *tx = &usb->tx;
834 spin_lock_irqsave(&tx->lock, flags);
839 list_add(&urb->urb_list, &tx->free_urb_list);
841 spin_unlock_irqrestore(&tx->lock, flags);
844 static void tx_dec_submitted_urbs(struct zd_usb *usb)
846 struct zd_usb_tx *tx = &usb->tx;
849 spin_lock_irqsave(&tx->lock, flags);
850 --tx->submitted_urbs;
851 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
852 ieee80211_wake_queues(zd_usb_to_hw(usb));
855 spin_unlock_irqrestore(&tx->lock, flags);
858 static void tx_inc_submitted_urbs(struct zd_usb *usb)
860 struct zd_usb_tx *tx = &usb->tx;
863 spin_lock_irqsave(&tx->lock, flags);
864 ++tx->submitted_urbs;
865 if (!tx->stopped && tx->submitted_urbs > ZD_USB_TX_HIGH) {
866 ieee80211_stop_queues(zd_usb_to_hw(usb));
869 spin_unlock_irqrestore(&tx->lock, flags);
873 * tx_urb_complete - completes the execution of an URB
876 * This function is called if the URB has been transferred to a device or an
877 * error has happened.
879 static void tx_urb_complete(struct urb *urb)
883 struct ieee80211_tx_info *info;
886 switch (urb->status) {
895 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
898 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
902 skb = (struct sk_buff *)urb->context;
904 * grab 'usb' pointer before handing off the skb (since
905 * it might be freed by zd_mac_tx_to_dev or mac80211)
907 info = IEEE80211_SKB_CB(skb);
908 usb = &zd_hw_mac(info->driver_data[0])->chip.usb;
909 zd_mac_tx_to_dev(skb, urb->status);
910 free_tx_urb(usb, urb);
911 tx_dec_submitted_urbs(usb);
914 r = usb_submit_urb(urb, GFP_ATOMIC);
916 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
922 * zd_usb_tx: initiates transfer of a frame of the device
924 * @usb: the zd1211rw-private USB structure
925 * @skb: a &struct sk_buff pointer
927 * This function tranmits a frame to the device. It doesn't wait for
928 * completion. The frame must contain the control set and have all the
929 * control set information available.
931 * The function returns 0 if the transfer has been successfully initiated.
933 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
936 struct usb_device *udev = zd_usb_to_usbdev(usb);
939 urb = alloc_tx_urb(usb);
945 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
946 skb->data, skb->len, tx_urb_complete, skb);
948 r = usb_submit_urb(urb, GFP_ATOMIC);
951 tx_inc_submitted_urbs(usb);
954 free_tx_urb(usb, urb);
959 static inline void init_usb_interrupt(struct zd_usb *usb)
961 struct zd_usb_interrupt *intr = &usb->intr;
963 spin_lock_init(&intr->lock);
964 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
965 init_completion(&intr->read_regs.completion);
966 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
969 static inline void init_usb_rx(struct zd_usb *usb)
971 struct zd_usb_rx *rx = &usb->rx;
972 spin_lock_init(&rx->lock);
973 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
974 rx->usb_packet_size = 512;
976 rx->usb_packet_size = 64;
978 ZD_ASSERT(rx->fragment_length == 0);
981 static inline void init_usb_tx(struct zd_usb *usb)
983 struct zd_usb_tx *tx = &usb->tx;
984 spin_lock_init(&tx->lock);
987 INIT_LIST_HEAD(&tx->free_urb_list);
988 tx->submitted_urbs = 0;
991 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
992 struct usb_interface *intf)
994 memset(usb, 0, sizeof(*usb));
995 usb->intf = usb_get_intf(intf);
996 usb_set_intfdata(usb->intf, hw);
997 init_usb_interrupt(usb);
1002 void zd_usb_clear(struct zd_usb *usb)
1004 usb_set_intfdata(usb->intf, NULL);
1005 usb_put_intf(usb->intf);
1006 ZD_MEMCLEAR(usb, sizeof(*usb));
1007 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
1010 static const char *speed(enum usb_device_speed speed)
1015 case USB_SPEED_FULL:
1017 case USB_SPEED_HIGH:
1020 return "unknown speed";
1024 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
1026 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
1027 le16_to_cpu(udev->descriptor.idVendor),
1028 le16_to_cpu(udev->descriptor.idProduct),
1029 get_bcdDevice(udev),
1030 speed(udev->speed));
1033 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
1035 struct usb_device *udev = interface_to_usbdev(usb->intf);
1036 return scnprint_id(udev, buffer, size);
1040 static void print_id(struct usb_device *udev)
1044 scnprint_id(udev, buffer, sizeof(buffer));
1045 buffer[sizeof(buffer)-1] = 0;
1046 dev_dbg_f(&udev->dev, "%s\n", buffer);
1049 #define print_id(udev) do { } while (0)
1052 static int eject_installer(struct usb_interface *intf)
1054 struct usb_device *udev = interface_to_usbdev(intf);
1055 struct usb_host_interface *iface_desc = &intf->altsetting[0];
1056 struct usb_endpoint_descriptor *endpoint;
1061 /* Find bulk out endpoint */
1062 endpoint = &iface_desc->endpoint[1].desc;
1063 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
1064 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
1065 USB_ENDPOINT_XFER_BULK) {
1066 bulk_out_ep = endpoint->bEndpointAddress;
1069 "zd1211rw: Could not find bulk out endpoint\n");
1073 cmd = kzalloc(31, GFP_KERNEL);
1077 /* USB bulk command block */
1078 cmd[0] = 0x55; /* bulk command signature */
1079 cmd[1] = 0x53; /* bulk command signature */
1080 cmd[2] = 0x42; /* bulk command signature */
1081 cmd[3] = 0x43; /* bulk command signature */
1082 cmd[14] = 6; /* command length */
1084 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1085 cmd[19] = 0x2; /* eject disc */
1087 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1088 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1089 cmd, 31, NULL, 2000);
1094 /* At this point, the device disconnects and reconnects with the real
1097 usb_set_intfdata(intf, NULL);
1101 int zd_usb_init_hw(struct zd_usb *usb)
1104 struct zd_mac *mac = zd_usb_to_mac(usb);
1106 dev_dbg_f(zd_usb_dev(usb), "\n");
1108 r = upload_firmware(usb);
1110 dev_err(zd_usb_dev(usb),
1111 "couldn't load firmware. Error number %d\n", r);
1115 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1117 dev_dbg_f(zd_usb_dev(usb),
1118 "couldn't reset configuration. Error number %d\n", r);
1122 r = zd_mac_init_hw(mac->hw);
1124 dev_dbg_f(zd_usb_dev(usb),
1125 "couldn't initialize mac. Error number %d\n", r);
1129 usb->initialized = 1;
1133 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1136 struct usb_device *udev = interface_to_usbdev(intf);
1138 struct ieee80211_hw *hw = NULL;
1142 if (id->driver_info & DEVICE_INSTALLER)
1143 return eject_installer(intf);
1145 switch (udev->speed) {
1147 case USB_SPEED_FULL:
1148 case USB_SPEED_HIGH:
1151 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1156 r = usb_reset_device(udev);
1159 "couldn't reset usb device. Error number %d\n", r);
1163 hw = zd_mac_alloc_hw(intf);
1169 usb = &zd_hw_mac(hw)->chip.usb;
1170 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1172 r = zd_mac_preinit_hw(hw);
1174 dev_dbg_f(&intf->dev,
1175 "couldn't initialize mac. Error number %d\n", r);
1179 r = ieee80211_register_hw(hw);
1181 dev_dbg_f(&intf->dev,
1182 "couldn't register device. Error number %d\n", r);
1186 dev_dbg_f(&intf->dev, "successful\n");
1187 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1190 usb_reset_device(interface_to_usbdev(intf));
1192 zd_mac_clear(zd_hw_mac(hw));
1193 ieee80211_free_hw(hw);
1198 static void disconnect(struct usb_interface *intf)
1200 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1204 /* Either something really bad happened, or we're just dealing with
1205 * a DEVICE_INSTALLER. */
1209 mac = zd_hw_mac(hw);
1210 usb = &mac->chip.usb;
1212 dev_dbg_f(zd_usb_dev(usb), "\n");
1214 ieee80211_unregister_hw(hw);
1216 /* Just in case something has gone wrong! */
1217 zd_usb_disable_rx(usb);
1218 zd_usb_disable_int(usb);
1220 /* If the disconnect has been caused by a removal of the
1221 * driver module, the reset allows reloading of the driver. If the
1222 * reset will not be executed here, the upload of the firmware in the
1223 * probe function caused by the reloading of the driver will fail.
1225 usb_reset_device(interface_to_usbdev(intf));
1228 ieee80211_free_hw(hw);
1229 dev_dbg(&intf->dev, "disconnected\n");
1232 static struct usb_driver driver = {
1233 .name = KBUILD_MODNAME,
1234 .id_table = usb_ids,
1236 .disconnect = disconnect,
1239 struct workqueue_struct *zd_workqueue;
1241 static int __init usb_init(void)
1245 pr_debug("%s usb_init()\n", driver.name);
1247 zd_workqueue = create_singlethread_workqueue(driver.name);
1248 if (zd_workqueue == NULL) {
1249 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1253 r = usb_register(&driver);
1255 destroy_workqueue(zd_workqueue);
1256 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1261 pr_debug("%s initialized\n", driver.name);
1265 static void __exit usb_exit(void)
1267 pr_debug("%s usb_exit()\n", driver.name);
1268 usb_deregister(&driver);
1269 destroy_workqueue(zd_workqueue);
1272 module_init(usb_init);
1273 module_exit(usb_exit);
1275 static int usb_int_regs_length(unsigned int count)
1277 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1280 static void prepare_read_regs_int(struct zd_usb *usb)
1282 struct zd_usb_interrupt *intr = &usb->intr;
1284 spin_lock_irq(&intr->lock);
1285 intr->read_regs_enabled = 1;
1286 INIT_COMPLETION(intr->read_regs.completion);
1287 spin_unlock_irq(&intr->lock);
1290 static void disable_read_regs_int(struct zd_usb *usb)
1292 struct zd_usb_interrupt *intr = &usb->intr;
1294 spin_lock_irq(&intr->lock);
1295 intr->read_regs_enabled = 0;
1296 spin_unlock_irq(&intr->lock);
1299 static int get_results(struct zd_usb *usb, u16 *values,
1300 struct usb_req_read_regs *req, unsigned int count)
1304 struct zd_usb_interrupt *intr = &usb->intr;
1305 struct read_regs_int *rr = &intr->read_regs;
1306 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1308 spin_lock_irq(&intr->lock);
1311 /* The created block size seems to be larger than expected.
1312 * However results appear to be correct.
1314 if (rr->length < usb_int_regs_length(count)) {
1315 dev_dbg_f(zd_usb_dev(usb),
1316 "error: actual length %d less than expected %d\n",
1317 rr->length, usb_int_regs_length(count));
1320 if (rr->length > sizeof(rr->buffer)) {
1321 dev_dbg_f(zd_usb_dev(usb),
1322 "error: actual length %d exceeds buffer size %zu\n",
1323 rr->length, sizeof(rr->buffer));
1327 for (i = 0; i < count; i++) {
1328 struct reg_data *rd = ®s->regs[i];
1329 if (rd->addr != req->addr[i]) {
1330 dev_dbg_f(zd_usb_dev(usb),
1331 "rd[%d] addr %#06hx expected %#06hx\n", i,
1332 le16_to_cpu(rd->addr),
1333 le16_to_cpu(req->addr[i]));
1336 values[i] = le16_to_cpu(rd->value);
1341 spin_unlock_irq(&intr->lock);
1345 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1346 const zd_addr_t *addresses, unsigned int count)
1349 int i, req_len, actual_req_len;
1350 struct usb_device *udev;
1351 struct usb_req_read_regs *req = NULL;
1352 unsigned long timeout;
1355 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1358 if (count > USB_MAX_IOREAD16_COUNT) {
1359 dev_dbg_f(zd_usb_dev(usb),
1360 "error: count %u exceeds possible max %u\n",
1361 count, USB_MAX_IOREAD16_COUNT);
1365 dev_dbg_f(zd_usb_dev(usb),
1366 "error: io in atomic context not supported\n");
1367 return -EWOULDBLOCK;
1369 if (!usb_int_enabled(usb)) {
1370 dev_dbg_f(zd_usb_dev(usb),
1371 "error: usb interrupt not enabled\n");
1372 return -EWOULDBLOCK;
1375 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1376 req = kmalloc(req_len, GFP_KERNEL);
1379 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1380 for (i = 0; i < count; i++)
1381 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1383 udev = zd_usb_to_usbdev(usb);
1384 prepare_read_regs_int(usb);
1385 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1386 req, req_len, &actual_req_len, 1000 /* ms */);
1388 dev_dbg_f(zd_usb_dev(usb),
1389 "error in usb_bulk_msg(). Error number %d\n", r);
1392 if (req_len != actual_req_len) {
1393 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1394 " req_len %d != actual_req_len %d\n",
1395 req_len, actual_req_len);
1400 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1401 msecs_to_jiffies(1000));
1403 disable_read_regs_int(usb);
1404 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1409 r = get_results(usb, values, req, count);
1415 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1419 struct usb_device *udev;
1420 struct usb_req_write_regs *req = NULL;
1421 int i, req_len, actual_req_len;
1425 if (count > USB_MAX_IOWRITE16_COUNT) {
1426 dev_dbg_f(zd_usb_dev(usb),
1427 "error: count %u exceeds possible max %u\n",
1428 count, USB_MAX_IOWRITE16_COUNT);
1432 dev_dbg_f(zd_usb_dev(usb),
1433 "error: io in atomic context not supported\n");
1434 return -EWOULDBLOCK;
1437 req_len = sizeof(struct usb_req_write_regs) +
1438 count * sizeof(struct reg_data);
1439 req = kmalloc(req_len, GFP_KERNEL);
1443 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1444 for (i = 0; i < count; i++) {
1445 struct reg_data *rw = &req->reg_writes[i];
1446 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1447 rw->value = cpu_to_le16(ioreqs[i].value);
1450 udev = zd_usb_to_usbdev(usb);
1451 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1452 req, req_len, &actual_req_len, 1000 /* ms */);
1454 dev_dbg_f(zd_usb_dev(usb),
1455 "error in usb_bulk_msg(). Error number %d\n", r);
1458 if (req_len != actual_req_len) {
1459 dev_dbg_f(zd_usb_dev(usb),
1460 "error in usb_bulk_msg()"
1461 " req_len %d != actual_req_len %d\n",
1462 req_len, actual_req_len);
1467 /* FALL-THROUGH with r == 0 */
1473 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1476 struct usb_device *udev;
1477 struct usb_req_rfwrite *req = NULL;
1478 int i, req_len, actual_req_len;
1479 u16 bit_value_template;
1482 dev_dbg_f(zd_usb_dev(usb),
1483 "error: io in atomic context not supported\n");
1484 return -EWOULDBLOCK;
1486 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1487 dev_dbg_f(zd_usb_dev(usb),
1488 "error: bits %d are smaller than"
1489 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1490 bits, USB_MIN_RFWRITE_BIT_COUNT);
1493 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1494 dev_dbg_f(zd_usb_dev(usb),
1495 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1496 bits, USB_MAX_RFWRITE_BIT_COUNT);
1500 if (value & (~0UL << bits)) {
1501 dev_dbg_f(zd_usb_dev(usb),
1502 "error: value %#09x has bits >= %d set\n",
1508 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1510 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1512 dev_dbg_f(zd_usb_dev(usb),
1513 "error %d: Couldn't read CR203\n", r);
1516 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1518 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1519 req = kmalloc(req_len, GFP_KERNEL);
1523 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1524 /* 1: 3683a, but not used in ZYDAS driver */
1525 req->value = cpu_to_le16(2);
1526 req->bits = cpu_to_le16(bits);
1528 for (i = 0; i < bits; i++) {
1529 u16 bv = bit_value_template;
1530 if (value & (1 << (bits-1-i)))
1532 req->bit_values[i] = cpu_to_le16(bv);
1535 udev = zd_usb_to_usbdev(usb);
1536 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1537 req, req_len, &actual_req_len, 1000 /* ms */);
1539 dev_dbg_f(zd_usb_dev(usb),
1540 "error in usb_bulk_msg(). Error number %d\n", r);
1543 if (req_len != actual_req_len) {
1544 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1545 " req_len %d != actual_req_len %d\n",
1546 req_len, actual_req_len);
1551 /* FALL-THROUGH with r == 0 */