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(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(0x054c, 0x0257), .driver_info = DEVICE_ZD1211B },
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, 0xe503), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x083a, 0xe506), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
83 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
84 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
85 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
86 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
87 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
88 { USB_DEVICE(0x07fa, 0x1196), .driver_info = DEVICE_ZD1211B },
89 { USB_DEVICE(0x0df6, 0x0036), .driver_info = DEVICE_ZD1211B },
90 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211B },
91 /* "Driverless" devices that need ejecting */
92 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
93 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
97 MODULE_LICENSE("GPL");
98 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
99 MODULE_AUTHOR("Ulrich Kunitz");
100 MODULE_AUTHOR("Daniel Drake");
101 MODULE_VERSION("1.0");
102 MODULE_DEVICE_TABLE(usb, usb_ids);
104 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
105 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
107 /* USB device initialization */
108 static void int_urb_complete(struct urb *urb);
110 static int request_fw_file(
111 const struct firmware **fw, const char *name, struct device *device)
115 dev_dbg_f(device, "fw name %s\n", name);
117 r = request_firmware(fw, name, device);
120 "Could not load firmware file %s. Error number %d\n",
125 static inline u16 get_bcdDevice(const struct usb_device *udev)
127 return le16_to_cpu(udev->descriptor.bcdDevice);
130 enum upload_code_flags {
134 /* Ensures that MAX_TRANSFER_SIZE is even. */
135 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
137 static int upload_code(struct usb_device *udev,
138 const u8 *data, size_t size, u16 code_offset, int flags)
143 /* USB request blocks need "kmalloced" buffers.
145 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
147 dev_err(&udev->dev, "out of memory\n");
154 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
155 size : MAX_TRANSFER_SIZE;
157 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
159 memcpy(p, data, transfer_size);
160 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
161 USB_REQ_FIRMWARE_DOWNLOAD,
162 USB_DIR_OUT | USB_TYPE_VENDOR,
163 code_offset, 0, p, transfer_size, 1000 /* ms */);
166 "USB control request for firmware upload"
167 " failed. Error number %d\n", r);
170 transfer_size = r & ~1;
172 size -= transfer_size;
173 data += transfer_size;
174 code_offset += transfer_size/sizeof(u16);
177 if (flags & REBOOT) {
180 /* Use "DMA-aware" buffer. */
181 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
182 USB_REQ_FIRMWARE_CONFIRM,
183 USB_DIR_IN | USB_TYPE_VENDOR,
184 0, 0, p, sizeof(ret), 5000 /* ms */);
185 if (r != sizeof(ret)) {
187 "control request firmeware confirmation failed."
188 " Return value %d\n", r);
196 "Internal error while downloading."
197 " Firmware confirm return value %#04x\n",
202 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
212 static u16 get_word(const void *data, u16 offset)
214 const __le16 *p = data;
215 return le16_to_cpu(p[offset]);
218 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
221 scnprintf(buffer, size, "%s%s",
223 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
228 static int handle_version_mismatch(struct zd_usb *usb,
229 const struct firmware *ub_fw)
231 struct usb_device *udev = zd_usb_to_usbdev(usb);
232 const struct firmware *ur_fw = NULL;
237 r = request_fw_file(&ur_fw,
238 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
243 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
247 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
248 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
249 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
251 /* At this point, the vendor driver downloads the whole firmware
252 * image, hacks around with version IDs, and uploads it again,
253 * completely overwriting the boot code. We do not do this here as
254 * it is not required on any tested devices, and it is suspected to
257 release_firmware(ur_fw);
261 static int upload_firmware(struct zd_usb *usb)
266 struct usb_device *udev = zd_usb_to_usbdev(usb);
267 const struct firmware *ub_fw = NULL;
268 const struct firmware *uph_fw = NULL;
271 bcdDevice = get_bcdDevice(udev);
273 r = request_fw_file(&ub_fw,
274 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
279 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
281 if (fw_bcdDevice != bcdDevice) {
283 "firmware version %#06x and device bootcode version "
284 "%#06x differ\n", fw_bcdDevice, bcdDevice);
285 if (bcdDevice <= 0x4313)
286 dev_warn(&udev->dev, "device has old bootcode, please "
287 "report success or failure\n");
289 r = handle_version_mismatch(usb, ub_fw);
293 dev_dbg_f(&udev->dev,
294 "firmware device id %#06x is equal to the "
295 "actual device id\n", fw_bcdDevice);
299 r = request_fw_file(&uph_fw,
300 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
305 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
308 "Could not upload firmware code uph. Error number %d\n",
314 release_firmware(ub_fw);
315 release_firmware(uph_fw);
319 /* Read data from device address space using "firmware interface" which does
320 * not require firmware to be loaded. */
321 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
324 struct usb_device *udev = zd_usb_to_usbdev(usb);
327 /* Use "DMA-aware" buffer. */
328 buf = kmalloc(len, GFP_KERNEL);
331 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
332 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
336 "read over firmware interface failed: %d\n", r);
338 } else if (r != len) {
340 "incomplete read over firmware interface: %d/%d\n",
346 memcpy(data, buf, len);
352 #define urb_dev(urb) (&(urb)->dev->dev)
354 static inline void handle_regs_int(struct urb *urb)
356 struct zd_usb *usb = urb->context;
357 struct zd_usb_interrupt *intr = &usb->intr;
361 ZD_ASSERT(in_interrupt());
362 spin_lock(&intr->lock);
364 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
365 if (int_num == CR_INTERRUPT) {
366 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
367 memcpy(&mac->intr_buffer, urb->transfer_buffer,
368 USB_MAX_EP_INT_BUFFER);
369 schedule_work(&mac->process_intr);
370 } else if (intr->read_regs_enabled) {
371 intr->read_regs.length = len = urb->actual_length;
373 if (len > sizeof(intr->read_regs.buffer))
374 len = sizeof(intr->read_regs.buffer);
375 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
376 intr->read_regs_enabled = 0;
377 complete(&intr->read_regs.completion);
382 spin_unlock(&intr->lock);
385 static void int_urb_complete(struct urb *urb)
388 struct usb_int_header *hdr;
390 switch (urb->status) {
404 if (urb->actual_length < sizeof(hdr)) {
405 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
409 hdr = urb->transfer_buffer;
410 if (hdr->type != USB_INT_TYPE) {
411 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
416 case USB_INT_ID_REGS:
417 handle_regs_int(urb);
419 case USB_INT_ID_RETRY_FAILED:
420 zd_mac_tx_failed(zd_usb_to_hw(urb->context));
423 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
424 (unsigned int)hdr->id);
429 r = usb_submit_urb(urb, GFP_ATOMIC);
431 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
436 kfree(urb->transfer_buffer);
439 static inline int int_urb_interval(struct usb_device *udev)
441 switch (udev->speed) {
452 static inline int usb_int_enabled(struct zd_usb *usb)
455 struct zd_usb_interrupt *intr = &usb->intr;
458 spin_lock_irqsave(&intr->lock, flags);
460 spin_unlock_irqrestore(&intr->lock, flags);
464 int zd_usb_enable_int(struct zd_usb *usb)
467 struct usb_device *udev;
468 struct zd_usb_interrupt *intr = &usb->intr;
469 void *transfer_buffer = NULL;
472 dev_dbg_f(zd_usb_dev(usb), "\n");
474 urb = usb_alloc_urb(0, GFP_KERNEL);
480 ZD_ASSERT(!irqs_disabled());
481 spin_lock_irq(&intr->lock);
483 spin_unlock_irq(&intr->lock);
488 spin_unlock_irq(&intr->lock);
490 /* TODO: make it a DMA buffer */
492 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
493 if (!transfer_buffer) {
494 dev_dbg_f(zd_usb_dev(usb),
495 "couldn't allocate transfer_buffer\n");
496 goto error_set_urb_null;
499 udev = zd_usb_to_usbdev(usb);
500 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
501 transfer_buffer, USB_MAX_EP_INT_BUFFER,
502 int_urb_complete, usb,
505 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
506 r = usb_submit_urb(urb, GFP_KERNEL);
508 dev_dbg_f(zd_usb_dev(usb),
509 "Couldn't submit urb. Error number %d\n", r);
515 kfree(transfer_buffer);
517 spin_lock_irq(&intr->lock);
519 spin_unlock_irq(&intr->lock);
526 void zd_usb_disable_int(struct zd_usb *usb)
529 struct zd_usb_interrupt *intr = &usb->intr;
532 spin_lock_irqsave(&intr->lock, flags);
535 spin_unlock_irqrestore(&intr->lock, flags);
539 spin_unlock_irqrestore(&intr->lock, flags);
542 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
546 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
550 const struct rx_length_info *length_info;
552 if (length < sizeof(struct rx_length_info)) {
553 /* It's not a complete packet anyhow. */
556 length_info = (struct rx_length_info *)
557 (buffer + length - sizeof(struct rx_length_info));
559 /* It might be that three frames are merged into a single URB
560 * transaction. We have to check for the length info tag.
562 * While testing we discovered that length_info might be unaligned,
563 * because if USB transactions are merged, the last packet will not
564 * be padded. Unaligned access might also happen if the length_info
565 * structure is not present.
567 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
569 unsigned int l, k, n;
570 for (i = 0, l = 0;; i++) {
571 k = get_unaligned_le16(&length_info->length[i]);
577 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
583 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
587 static void rx_urb_complete(struct urb *urb)
590 struct zd_usb_rx *rx;
594 switch (urb->status) {
605 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
609 buffer = urb->transfer_buffer;
610 length = urb->actual_length;
614 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
615 /* If there is an old first fragment, we don't care. */
616 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
617 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
618 spin_lock(&rx->lock);
619 memcpy(rx->fragment, buffer, length);
620 rx->fragment_length = length;
621 spin_unlock(&rx->lock);
625 spin_lock(&rx->lock);
626 if (rx->fragment_length > 0) {
627 /* We are on a second fragment, we believe */
628 ZD_ASSERT(length + rx->fragment_length <=
629 ARRAY_SIZE(rx->fragment));
630 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
631 memcpy(rx->fragment+rx->fragment_length, buffer, length);
632 handle_rx_packet(usb, rx->fragment,
633 rx->fragment_length + length);
634 rx->fragment_length = 0;
635 spin_unlock(&rx->lock);
637 spin_unlock(&rx->lock);
638 handle_rx_packet(usb, buffer, length);
642 usb_submit_urb(urb, GFP_ATOMIC);
645 static struct urb *alloc_rx_urb(struct zd_usb *usb)
647 struct usb_device *udev = zd_usb_to_usbdev(usb);
651 urb = usb_alloc_urb(0, GFP_KERNEL);
654 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
661 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
662 buffer, USB_MAX_RX_SIZE,
663 rx_urb_complete, usb);
664 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
669 static void free_rx_urb(struct urb *urb)
673 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
674 urb->transfer_buffer, urb->transfer_dma);
678 int zd_usb_enable_rx(struct zd_usb *usb)
681 struct zd_usb_rx *rx = &usb->rx;
684 dev_dbg_f(zd_usb_dev(usb), "\n");
687 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
690 for (i = 0; i < RX_URBS_COUNT; i++) {
691 urbs[i] = alloc_rx_urb(usb);
696 ZD_ASSERT(!irqs_disabled());
697 spin_lock_irq(&rx->lock);
699 spin_unlock_irq(&rx->lock);
704 rx->urbs_count = RX_URBS_COUNT;
705 spin_unlock_irq(&rx->lock);
707 for (i = 0; i < RX_URBS_COUNT; i++) {
708 r = usb_submit_urb(urbs[i], GFP_KERNEL);
715 for (i = 0; i < RX_URBS_COUNT; i++) {
716 usb_kill_urb(urbs[i]);
718 spin_lock_irq(&rx->lock);
721 spin_unlock_irq(&rx->lock);
724 for (i = 0; i < RX_URBS_COUNT; i++)
725 free_rx_urb(urbs[i]);
730 void zd_usb_disable_rx(struct zd_usb *usb)
736 struct zd_usb_rx *rx = &usb->rx;
738 spin_lock_irqsave(&rx->lock, flags);
740 count = rx->urbs_count;
741 spin_unlock_irqrestore(&rx->lock, flags);
745 for (i = 0; i < count; i++) {
746 usb_kill_urb(urbs[i]);
747 free_rx_urb(urbs[i]);
751 spin_lock_irqsave(&rx->lock, flags);
754 spin_unlock_irqrestore(&rx->lock, flags);
758 * zd_usb_disable_tx - disable transmission
759 * @usb: the zd1211rw-private USB structure
761 * Frees all URBs in the free list and marks the transmission as disabled.
763 void zd_usb_disable_tx(struct zd_usb *usb)
765 struct zd_usb_tx *tx = &usb->tx;
767 struct list_head *pos, *n;
769 spin_lock_irqsave(&tx->lock, flags);
770 list_for_each_safe(pos, n, &tx->free_urb_list) {
772 usb_free_urb(list_entry(pos, struct urb, urb_list));
775 tx->submitted_urbs = 0;
776 /* The stopped state is ignored, relying on ieee80211_wake_queues()
777 * in a potentionally following zd_usb_enable_tx().
779 spin_unlock_irqrestore(&tx->lock, flags);
783 * zd_usb_enable_tx - enables transmission
784 * @usb: a &struct zd_usb pointer
786 * This function enables transmission and prepares the &zd_usb_tx data
789 void zd_usb_enable_tx(struct zd_usb *usb)
792 struct zd_usb_tx *tx = &usb->tx;
794 spin_lock_irqsave(&tx->lock, flags);
796 tx->submitted_urbs = 0;
797 ieee80211_wake_queues(zd_usb_to_hw(usb));
799 spin_unlock_irqrestore(&tx->lock, flags);
803 * alloc_tx_urb - provides an tx URB
804 * @usb: a &struct zd_usb pointer
806 * Allocates a new URB. If possible takes the urb from the free list in
809 static struct urb *alloc_tx_urb(struct zd_usb *usb)
811 struct zd_usb_tx *tx = &usb->tx;
813 struct list_head *entry;
816 spin_lock_irqsave(&tx->lock, flags);
817 if (list_empty(&tx->free_urb_list)) {
818 urb = usb_alloc_urb(0, GFP_ATOMIC);
821 entry = tx->free_urb_list.next;
823 urb = list_entry(entry, struct urb, urb_list);
825 spin_unlock_irqrestore(&tx->lock, flags);
830 * free_tx_urb - frees a used tx URB
831 * @usb: a &struct zd_usb pointer
832 * @urb: URB to be freed
834 * Frees the the transmission URB, which means to put it on the free URB
837 static void free_tx_urb(struct zd_usb *usb, struct urb *urb)
839 struct zd_usb_tx *tx = &usb->tx;
842 spin_lock_irqsave(&tx->lock, flags);
847 list_add(&urb->urb_list, &tx->free_urb_list);
849 spin_unlock_irqrestore(&tx->lock, flags);
852 static void tx_dec_submitted_urbs(struct zd_usb *usb)
854 struct zd_usb_tx *tx = &usb->tx;
857 spin_lock_irqsave(&tx->lock, flags);
858 --tx->submitted_urbs;
859 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
860 ieee80211_wake_queues(zd_usb_to_hw(usb));
863 spin_unlock_irqrestore(&tx->lock, flags);
866 static void tx_inc_submitted_urbs(struct zd_usb *usb)
868 struct zd_usb_tx *tx = &usb->tx;
871 spin_lock_irqsave(&tx->lock, flags);
872 ++tx->submitted_urbs;
873 if (!tx->stopped && tx->submitted_urbs > ZD_USB_TX_HIGH) {
874 ieee80211_stop_queues(zd_usb_to_hw(usb));
877 spin_unlock_irqrestore(&tx->lock, flags);
881 * tx_urb_complete - completes the execution of an URB
884 * This function is called if the URB has been transferred to a device or an
885 * error has happened.
887 static void tx_urb_complete(struct urb *urb)
891 struct ieee80211_tx_info *info;
894 switch (urb->status) {
903 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
906 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
910 skb = (struct sk_buff *)urb->context;
912 * grab 'usb' pointer before handing off the skb (since
913 * it might be freed by zd_mac_tx_to_dev or mac80211)
915 info = IEEE80211_SKB_CB(skb);
916 usb = &zd_hw_mac(info->rate_driver_data[0])->chip.usb;
917 zd_mac_tx_to_dev(skb, urb->status);
918 free_tx_urb(usb, urb);
919 tx_dec_submitted_urbs(usb);
922 r = usb_submit_urb(urb, GFP_ATOMIC);
924 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
930 * zd_usb_tx: initiates transfer of a frame of the device
932 * @usb: the zd1211rw-private USB structure
933 * @skb: a &struct sk_buff pointer
935 * This function tranmits a frame to the device. It doesn't wait for
936 * completion. The frame must contain the control set and have all the
937 * control set information available.
939 * The function returns 0 if the transfer has been successfully initiated.
941 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
944 struct usb_device *udev = zd_usb_to_usbdev(usb);
947 urb = alloc_tx_urb(usb);
953 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
954 skb->data, skb->len, tx_urb_complete, skb);
956 r = usb_submit_urb(urb, GFP_ATOMIC);
959 tx_inc_submitted_urbs(usb);
962 free_tx_urb(usb, urb);
967 static inline void init_usb_interrupt(struct zd_usb *usb)
969 struct zd_usb_interrupt *intr = &usb->intr;
971 spin_lock_init(&intr->lock);
972 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
973 init_completion(&intr->read_regs.completion);
974 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
977 static inline void init_usb_rx(struct zd_usb *usb)
979 struct zd_usb_rx *rx = &usb->rx;
980 spin_lock_init(&rx->lock);
981 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
982 rx->usb_packet_size = 512;
984 rx->usb_packet_size = 64;
986 ZD_ASSERT(rx->fragment_length == 0);
989 static inline void init_usb_tx(struct zd_usb *usb)
991 struct zd_usb_tx *tx = &usb->tx;
992 spin_lock_init(&tx->lock);
995 INIT_LIST_HEAD(&tx->free_urb_list);
996 tx->submitted_urbs = 0;
999 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
1000 struct usb_interface *intf)
1002 memset(usb, 0, sizeof(*usb));
1003 usb->intf = usb_get_intf(intf);
1004 usb_set_intfdata(usb->intf, hw);
1005 init_usb_interrupt(usb);
1010 void zd_usb_clear(struct zd_usb *usb)
1012 usb_set_intfdata(usb->intf, NULL);
1013 usb_put_intf(usb->intf);
1014 ZD_MEMCLEAR(usb, sizeof(*usb));
1015 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
1018 static const char *speed(enum usb_device_speed speed)
1023 case USB_SPEED_FULL:
1025 case USB_SPEED_HIGH:
1028 return "unknown speed";
1032 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
1034 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
1035 le16_to_cpu(udev->descriptor.idVendor),
1036 le16_to_cpu(udev->descriptor.idProduct),
1037 get_bcdDevice(udev),
1038 speed(udev->speed));
1041 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
1043 struct usb_device *udev = interface_to_usbdev(usb->intf);
1044 return scnprint_id(udev, buffer, size);
1048 static void print_id(struct usb_device *udev)
1052 scnprint_id(udev, buffer, sizeof(buffer));
1053 buffer[sizeof(buffer)-1] = 0;
1054 dev_dbg_f(&udev->dev, "%s\n", buffer);
1057 #define print_id(udev) do { } while (0)
1060 static int eject_installer(struct usb_interface *intf)
1062 struct usb_device *udev = interface_to_usbdev(intf);
1063 struct usb_host_interface *iface_desc = &intf->altsetting[0];
1064 struct usb_endpoint_descriptor *endpoint;
1069 /* Find bulk out endpoint */
1070 endpoint = &iface_desc->endpoint[1].desc;
1071 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
1072 usb_endpoint_xfer_bulk(endpoint)) {
1073 bulk_out_ep = endpoint->bEndpointAddress;
1076 "zd1211rw: Could not find bulk out endpoint\n");
1080 cmd = kzalloc(31, GFP_KERNEL);
1084 /* USB bulk command block */
1085 cmd[0] = 0x55; /* bulk command signature */
1086 cmd[1] = 0x53; /* bulk command signature */
1087 cmd[2] = 0x42; /* bulk command signature */
1088 cmd[3] = 0x43; /* bulk command signature */
1089 cmd[14] = 6; /* command length */
1091 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1092 cmd[19] = 0x2; /* eject disc */
1094 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1095 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1096 cmd, 31, NULL, 2000);
1101 /* At this point, the device disconnects and reconnects with the real
1104 usb_set_intfdata(intf, NULL);
1108 int zd_usb_init_hw(struct zd_usb *usb)
1111 struct zd_mac *mac = zd_usb_to_mac(usb);
1113 dev_dbg_f(zd_usb_dev(usb), "\n");
1115 r = upload_firmware(usb);
1117 dev_err(zd_usb_dev(usb),
1118 "couldn't load firmware. Error number %d\n", r);
1122 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1124 dev_dbg_f(zd_usb_dev(usb),
1125 "couldn't reset configuration. Error number %d\n", r);
1129 r = zd_mac_init_hw(mac->hw);
1131 dev_dbg_f(zd_usb_dev(usb),
1132 "couldn't initialize mac. Error number %d\n", r);
1136 usb->initialized = 1;
1140 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1143 struct usb_device *udev = interface_to_usbdev(intf);
1145 struct ieee80211_hw *hw = NULL;
1149 if (id->driver_info & DEVICE_INSTALLER)
1150 return eject_installer(intf);
1152 switch (udev->speed) {
1154 case USB_SPEED_FULL:
1155 case USB_SPEED_HIGH:
1158 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1163 r = usb_reset_device(udev);
1166 "couldn't reset usb device. Error number %d\n", r);
1170 hw = zd_mac_alloc_hw(intf);
1176 usb = &zd_hw_mac(hw)->chip.usb;
1177 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1179 r = zd_mac_preinit_hw(hw);
1181 dev_dbg_f(&intf->dev,
1182 "couldn't initialize mac. Error number %d\n", r);
1186 r = ieee80211_register_hw(hw);
1188 dev_dbg_f(&intf->dev,
1189 "couldn't register device. Error number %d\n", r);
1193 dev_dbg_f(&intf->dev, "successful\n");
1194 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1197 usb_reset_device(interface_to_usbdev(intf));
1199 zd_mac_clear(zd_hw_mac(hw));
1200 ieee80211_free_hw(hw);
1205 static void disconnect(struct usb_interface *intf)
1207 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1211 /* Either something really bad happened, or we're just dealing with
1212 * a DEVICE_INSTALLER. */
1216 mac = zd_hw_mac(hw);
1217 usb = &mac->chip.usb;
1219 dev_dbg_f(zd_usb_dev(usb), "\n");
1221 ieee80211_unregister_hw(hw);
1223 /* Just in case something has gone wrong! */
1224 zd_usb_disable_rx(usb);
1225 zd_usb_disable_int(usb);
1227 /* If the disconnect has been caused by a removal of the
1228 * driver module, the reset allows reloading of the driver. If the
1229 * reset will not be executed here, the upload of the firmware in the
1230 * probe function caused by the reloading of the driver will fail.
1232 usb_reset_device(interface_to_usbdev(intf));
1235 ieee80211_free_hw(hw);
1236 dev_dbg(&intf->dev, "disconnected\n");
1239 static struct usb_driver driver = {
1240 .name = KBUILD_MODNAME,
1241 .id_table = usb_ids,
1243 .disconnect = disconnect,
1246 struct workqueue_struct *zd_workqueue;
1248 static int __init usb_init(void)
1252 pr_debug("%s usb_init()\n", driver.name);
1254 zd_workqueue = create_singlethread_workqueue(driver.name);
1255 if (zd_workqueue == NULL) {
1256 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1260 r = usb_register(&driver);
1262 destroy_workqueue(zd_workqueue);
1263 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1268 pr_debug("%s initialized\n", driver.name);
1272 static void __exit usb_exit(void)
1274 pr_debug("%s usb_exit()\n", driver.name);
1275 usb_deregister(&driver);
1276 destroy_workqueue(zd_workqueue);
1279 module_init(usb_init);
1280 module_exit(usb_exit);
1282 static int usb_int_regs_length(unsigned int count)
1284 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1287 static void prepare_read_regs_int(struct zd_usb *usb)
1289 struct zd_usb_interrupt *intr = &usb->intr;
1291 spin_lock_irq(&intr->lock);
1292 intr->read_regs_enabled = 1;
1293 INIT_COMPLETION(intr->read_regs.completion);
1294 spin_unlock_irq(&intr->lock);
1297 static void disable_read_regs_int(struct zd_usb *usb)
1299 struct zd_usb_interrupt *intr = &usb->intr;
1301 spin_lock_irq(&intr->lock);
1302 intr->read_regs_enabled = 0;
1303 spin_unlock_irq(&intr->lock);
1306 static int get_results(struct zd_usb *usb, u16 *values,
1307 struct usb_req_read_regs *req, unsigned int count)
1311 struct zd_usb_interrupt *intr = &usb->intr;
1312 struct read_regs_int *rr = &intr->read_regs;
1313 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1315 spin_lock_irq(&intr->lock);
1318 /* The created block size seems to be larger than expected.
1319 * However results appear to be correct.
1321 if (rr->length < usb_int_regs_length(count)) {
1322 dev_dbg_f(zd_usb_dev(usb),
1323 "error: actual length %d less than expected %d\n",
1324 rr->length, usb_int_regs_length(count));
1327 if (rr->length > sizeof(rr->buffer)) {
1328 dev_dbg_f(zd_usb_dev(usb),
1329 "error: actual length %d exceeds buffer size %zu\n",
1330 rr->length, sizeof(rr->buffer));
1334 for (i = 0; i < count; i++) {
1335 struct reg_data *rd = ®s->regs[i];
1336 if (rd->addr != req->addr[i]) {
1337 dev_dbg_f(zd_usb_dev(usb),
1338 "rd[%d] addr %#06hx expected %#06hx\n", i,
1339 le16_to_cpu(rd->addr),
1340 le16_to_cpu(req->addr[i]));
1343 values[i] = le16_to_cpu(rd->value);
1348 spin_unlock_irq(&intr->lock);
1352 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1353 const zd_addr_t *addresses, unsigned int count)
1356 int i, req_len, actual_req_len;
1357 struct usb_device *udev;
1358 struct usb_req_read_regs *req = NULL;
1359 unsigned long timeout;
1362 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1365 if (count > USB_MAX_IOREAD16_COUNT) {
1366 dev_dbg_f(zd_usb_dev(usb),
1367 "error: count %u exceeds possible max %u\n",
1368 count, USB_MAX_IOREAD16_COUNT);
1372 dev_dbg_f(zd_usb_dev(usb),
1373 "error: io in atomic context not supported\n");
1374 return -EWOULDBLOCK;
1376 if (!usb_int_enabled(usb)) {
1377 dev_dbg_f(zd_usb_dev(usb),
1378 "error: usb interrupt not enabled\n");
1379 return -EWOULDBLOCK;
1382 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1383 req = kmalloc(req_len, GFP_KERNEL);
1386 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1387 for (i = 0; i < count; i++)
1388 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1390 udev = zd_usb_to_usbdev(usb);
1391 prepare_read_regs_int(usb);
1392 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1393 req, req_len, &actual_req_len, 1000 /* ms */);
1395 dev_dbg_f(zd_usb_dev(usb),
1396 "error in usb_bulk_msg(). Error number %d\n", r);
1399 if (req_len != actual_req_len) {
1400 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1401 " req_len %d != actual_req_len %d\n",
1402 req_len, actual_req_len);
1407 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1408 msecs_to_jiffies(1000));
1410 disable_read_regs_int(usb);
1411 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1416 r = get_results(usb, values, req, count);
1422 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1426 struct usb_device *udev;
1427 struct usb_req_write_regs *req = NULL;
1428 int i, req_len, actual_req_len;
1432 if (count > USB_MAX_IOWRITE16_COUNT) {
1433 dev_dbg_f(zd_usb_dev(usb),
1434 "error: count %u exceeds possible max %u\n",
1435 count, USB_MAX_IOWRITE16_COUNT);
1439 dev_dbg_f(zd_usb_dev(usb),
1440 "error: io in atomic context not supported\n");
1441 return -EWOULDBLOCK;
1444 req_len = sizeof(struct usb_req_write_regs) +
1445 count * sizeof(struct reg_data);
1446 req = kmalloc(req_len, GFP_KERNEL);
1450 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1451 for (i = 0; i < count; i++) {
1452 struct reg_data *rw = &req->reg_writes[i];
1453 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1454 rw->value = cpu_to_le16(ioreqs[i].value);
1457 udev = zd_usb_to_usbdev(usb);
1458 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1459 req, req_len, &actual_req_len, 1000 /* ms */);
1461 dev_dbg_f(zd_usb_dev(usb),
1462 "error in usb_bulk_msg(). Error number %d\n", r);
1465 if (req_len != actual_req_len) {
1466 dev_dbg_f(zd_usb_dev(usb),
1467 "error in usb_bulk_msg()"
1468 " req_len %d != actual_req_len %d\n",
1469 req_len, actual_req_len);
1474 /* FALL-THROUGH with r == 0 */
1480 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1483 struct usb_device *udev;
1484 struct usb_req_rfwrite *req = NULL;
1485 int i, req_len, actual_req_len;
1486 u16 bit_value_template;
1489 dev_dbg_f(zd_usb_dev(usb),
1490 "error: io in atomic context not supported\n");
1491 return -EWOULDBLOCK;
1493 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1494 dev_dbg_f(zd_usb_dev(usb),
1495 "error: bits %d are smaller than"
1496 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1497 bits, USB_MIN_RFWRITE_BIT_COUNT);
1500 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1501 dev_dbg_f(zd_usb_dev(usb),
1502 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1503 bits, USB_MAX_RFWRITE_BIT_COUNT);
1507 if (value & (~0UL << bits)) {
1508 dev_dbg_f(zd_usb_dev(usb),
1509 "error: value %#09x has bits >= %d set\n",
1515 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1517 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1519 dev_dbg_f(zd_usb_dev(usb),
1520 "error %d: Couldn't read CR203\n", r);
1523 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1525 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1526 req = kmalloc(req_len, GFP_KERNEL);
1530 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1531 /* 1: 3683a, but not used in ZYDAS driver */
1532 req->value = cpu_to_le16(2);
1533 req->bits = cpu_to_le16(bits);
1535 for (i = 0; i < bits; i++) {
1536 u16 bv = bit_value_template;
1537 if (value & (1 << (bits-1-i)))
1539 req->bit_values[i] = cpu_to_le16(bv);
1542 udev = zd_usb_to_usbdev(usb);
1543 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1544 req, req_len, &actual_req_len, 1000 /* ms */);
1546 dev_dbg_f(zd_usb_dev(usb),
1547 "error in usb_bulk_msg(). Error number %d\n", r);
1550 if (req_len != actual_req_len) {
1551 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1552 " req_len %d != actual_req_len %d\n",
1553 req_len, actual_req_len);
1558 /* FALL-THROUGH with r == 0 */