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/slab.h>
28 #include <linux/skbuff.h>
29 #include <linux/usb.h>
30 #include <linux/workqueue.h>
31 #include <net/mac80211.h>
32 #include <asm/unaligned.h>
38 static struct usb_device_id usb_ids[] = {
40 { USB_DEVICE(0x0105, 0x145f), .driver_info = DEVICE_ZD1211 },
41 { USB_DEVICE(0x0586, 0x3401), .driver_info = DEVICE_ZD1211 },
42 { USB_DEVICE(0x0586, 0x3402), .driver_info = DEVICE_ZD1211 },
43 { USB_DEVICE(0x0586, 0x3407), .driver_info = DEVICE_ZD1211 },
44 { USB_DEVICE(0x0586, 0x3409), .driver_info = DEVICE_ZD1211 },
45 { USB_DEVICE(0x079b, 0x004a), .driver_info = DEVICE_ZD1211 },
46 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211 },
47 { USB_DEVICE(0x0ace, 0x1211), .driver_info = DEVICE_ZD1211 },
48 { USB_DEVICE(0x0ace, 0xa211), .driver_info = DEVICE_ZD1211 },
49 { USB_DEVICE(0x0b05, 0x170c), .driver_info = DEVICE_ZD1211 },
50 { USB_DEVICE(0x0b3b, 0x1630), .driver_info = DEVICE_ZD1211 },
51 { USB_DEVICE(0x0b3b, 0x5630), .driver_info = DEVICE_ZD1211 },
52 { USB_DEVICE(0x0df6, 0x9071), .driver_info = DEVICE_ZD1211 },
53 { USB_DEVICE(0x0df6, 0x9075), .driver_info = DEVICE_ZD1211 },
54 { USB_DEVICE(0x126f, 0xa006), .driver_info = DEVICE_ZD1211 },
55 { USB_DEVICE(0x129b, 0x1666), .driver_info = DEVICE_ZD1211 },
56 { USB_DEVICE(0x13b1, 0x001e), .driver_info = DEVICE_ZD1211 },
57 { USB_DEVICE(0x1435, 0x0711), .driver_info = DEVICE_ZD1211 },
58 { USB_DEVICE(0x14ea, 0xab10), .driver_info = DEVICE_ZD1211 },
59 { USB_DEVICE(0x14ea, 0xab13), .driver_info = DEVICE_ZD1211 },
60 { USB_DEVICE(0x157e, 0x300a), .driver_info = DEVICE_ZD1211 },
61 { USB_DEVICE(0x157e, 0x300b), .driver_info = DEVICE_ZD1211 },
62 { USB_DEVICE(0x157e, 0x3204), .driver_info = DEVICE_ZD1211 },
63 { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
64 { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
66 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x0409, 0x0248), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x054c, 0x0257), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x07fa, 0x1196), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x083a, 0xe501), .driver_info = DEVICE_ZD1211B },
83 { USB_DEVICE(0x083a, 0xe503), .driver_info = DEVICE_ZD1211B },
84 { USB_DEVICE(0x083a, 0xe506), .driver_info = DEVICE_ZD1211B },
85 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
86 { USB_DEVICE(0x0ace, 0xb215), .driver_info = DEVICE_ZD1211B },
87 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
88 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
89 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
90 { USB_DEVICE(0x0df6, 0x0036), .driver_info = DEVICE_ZD1211B },
91 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
92 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
93 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
94 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
95 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
96 { USB_DEVICE(0x2019, 0xed01), .driver_info = DEVICE_ZD1211B },
97 /* "Driverless" devices that need ejecting */
98 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
99 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
103 MODULE_LICENSE("GPL");
104 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
105 MODULE_AUTHOR("Ulrich Kunitz");
106 MODULE_AUTHOR("Daniel Drake");
107 MODULE_VERSION("1.0");
108 MODULE_DEVICE_TABLE(usb, usb_ids);
110 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
111 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
113 /* USB device initialization */
114 static void int_urb_complete(struct urb *urb);
116 static int request_fw_file(
117 const struct firmware **fw, const char *name, struct device *device)
121 dev_dbg_f(device, "fw name %s\n", name);
123 r = request_firmware(fw, name, device);
126 "Could not load firmware file %s. Error number %d\n",
131 static inline u16 get_bcdDevice(const struct usb_device *udev)
133 return le16_to_cpu(udev->descriptor.bcdDevice);
136 enum upload_code_flags {
140 /* Ensures that MAX_TRANSFER_SIZE is even. */
141 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
143 static int upload_code(struct usb_device *udev,
144 const u8 *data, size_t size, u16 code_offset, int flags)
149 /* USB request blocks need "kmalloced" buffers.
151 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
153 dev_err(&udev->dev, "out of memory\n");
160 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
161 size : MAX_TRANSFER_SIZE;
163 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
165 memcpy(p, data, transfer_size);
166 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
167 USB_REQ_FIRMWARE_DOWNLOAD,
168 USB_DIR_OUT | USB_TYPE_VENDOR,
169 code_offset, 0, p, transfer_size, 1000 /* ms */);
172 "USB control request for firmware upload"
173 " failed. Error number %d\n", r);
176 transfer_size = r & ~1;
178 size -= transfer_size;
179 data += transfer_size;
180 code_offset += transfer_size/sizeof(u16);
183 if (flags & REBOOT) {
186 /* Use "DMA-aware" buffer. */
187 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
188 USB_REQ_FIRMWARE_CONFIRM,
189 USB_DIR_IN | USB_TYPE_VENDOR,
190 0, 0, p, sizeof(ret), 5000 /* ms */);
191 if (r != sizeof(ret)) {
193 "control request firmeware confirmation failed."
194 " Return value %d\n", r);
202 "Internal error while downloading."
203 " Firmware confirm return value %#04x\n",
208 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
218 static u16 get_word(const void *data, u16 offset)
220 const __le16 *p = data;
221 return le16_to_cpu(p[offset]);
224 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
227 scnprintf(buffer, size, "%s%s",
229 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
234 static int handle_version_mismatch(struct zd_usb *usb,
235 const struct firmware *ub_fw)
237 struct usb_device *udev = zd_usb_to_usbdev(usb);
238 const struct firmware *ur_fw = NULL;
243 r = request_fw_file(&ur_fw,
244 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
249 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
253 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
254 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
255 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
257 /* At this point, the vendor driver downloads the whole firmware
258 * image, hacks around with version IDs, and uploads it again,
259 * completely overwriting the boot code. We do not do this here as
260 * it is not required on any tested devices, and it is suspected to
263 release_firmware(ur_fw);
267 static int upload_firmware(struct zd_usb *usb)
272 struct usb_device *udev = zd_usb_to_usbdev(usb);
273 const struct firmware *ub_fw = NULL;
274 const struct firmware *uph_fw = NULL;
277 bcdDevice = get_bcdDevice(udev);
279 r = request_fw_file(&ub_fw,
280 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
285 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
287 if (fw_bcdDevice != bcdDevice) {
289 "firmware version %#06x and device bootcode version "
290 "%#06x differ\n", fw_bcdDevice, bcdDevice);
291 if (bcdDevice <= 0x4313)
292 dev_warn(&udev->dev, "device has old bootcode, please "
293 "report success or failure\n");
295 r = handle_version_mismatch(usb, ub_fw);
299 dev_dbg_f(&udev->dev,
300 "firmware device id %#06x is equal to the "
301 "actual device id\n", fw_bcdDevice);
305 r = request_fw_file(&uph_fw,
306 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
311 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
314 "Could not upload firmware code uph. Error number %d\n",
320 release_firmware(ub_fw);
321 release_firmware(uph_fw);
325 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "ur");
326 MODULE_FIRMWARE(FW_ZD1211_PREFIX "ur");
327 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "ub");
328 MODULE_FIRMWARE(FW_ZD1211_PREFIX "ub");
329 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "uphr");
330 MODULE_FIRMWARE(FW_ZD1211_PREFIX "uphr");
332 /* Read data from device address space using "firmware interface" which does
333 * not require firmware to be loaded. */
334 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
337 struct usb_device *udev = zd_usb_to_usbdev(usb);
340 /* Use "DMA-aware" buffer. */
341 buf = kmalloc(len, GFP_KERNEL);
344 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
345 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
349 "read over firmware interface failed: %d\n", r);
351 } else if (r != len) {
353 "incomplete read over firmware interface: %d/%d\n",
359 memcpy(data, buf, len);
365 #define urb_dev(urb) (&(urb)->dev->dev)
367 static inline void handle_regs_int(struct urb *urb)
369 struct zd_usb *usb = urb->context;
370 struct zd_usb_interrupt *intr = &usb->intr;
374 ZD_ASSERT(in_interrupt());
375 spin_lock(&intr->lock);
377 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
378 if (int_num == CR_INTERRUPT) {
379 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
380 spin_lock(&mac->lock);
381 memcpy(&mac->intr_buffer, urb->transfer_buffer,
382 USB_MAX_EP_INT_BUFFER);
383 spin_unlock(&mac->lock);
384 schedule_work(&mac->process_intr);
385 } else if (intr->read_regs_enabled) {
386 intr->read_regs.length = len = urb->actual_length;
388 if (len > sizeof(intr->read_regs.buffer))
389 len = sizeof(intr->read_regs.buffer);
390 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
391 intr->read_regs_enabled = 0;
392 complete(&intr->read_regs.completion);
397 spin_unlock(&intr->lock);
400 static void int_urb_complete(struct urb *urb)
403 struct usb_int_header *hdr;
405 switch (urb->status) {
419 if (urb->actual_length < sizeof(hdr)) {
420 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
424 hdr = urb->transfer_buffer;
425 if (hdr->type != USB_INT_TYPE) {
426 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
431 case USB_INT_ID_REGS:
432 handle_regs_int(urb);
434 case USB_INT_ID_RETRY_FAILED:
435 zd_mac_tx_failed(urb);
438 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
439 (unsigned int)hdr->id);
444 r = usb_submit_urb(urb, GFP_ATOMIC);
446 dev_dbg_f(urb_dev(urb), "error: resubmit urb %p err code %d\n",
448 /* TODO: add worker to reset intr->urb */
453 static inline int int_urb_interval(struct usb_device *udev)
455 switch (udev->speed) {
466 static inline int usb_int_enabled(struct zd_usb *usb)
469 struct zd_usb_interrupt *intr = &usb->intr;
472 spin_lock_irqsave(&intr->lock, flags);
474 spin_unlock_irqrestore(&intr->lock, flags);
478 int zd_usb_enable_int(struct zd_usb *usb)
481 struct usb_device *udev = zd_usb_to_usbdev(usb);
482 struct zd_usb_interrupt *intr = &usb->intr;
485 dev_dbg_f(zd_usb_dev(usb), "\n");
487 urb = usb_alloc_urb(0, GFP_KERNEL);
493 ZD_ASSERT(!irqs_disabled());
494 spin_lock_irq(&intr->lock);
496 spin_unlock_irq(&intr->lock);
501 spin_unlock_irq(&intr->lock);
504 intr->buffer = usb_alloc_coherent(udev, USB_MAX_EP_INT_BUFFER,
505 GFP_KERNEL, &intr->buffer_dma);
507 dev_dbg_f(zd_usb_dev(usb),
508 "couldn't allocate transfer_buffer\n");
509 goto error_set_urb_null;
512 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
513 intr->buffer, USB_MAX_EP_INT_BUFFER,
514 int_urb_complete, usb,
516 urb->transfer_dma = intr->buffer_dma;
517 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
519 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
520 r = usb_submit_urb(urb, GFP_KERNEL);
522 dev_dbg_f(zd_usb_dev(usb),
523 "Couldn't submit urb. Error number %d\n", r);
529 usb_free_coherent(udev, USB_MAX_EP_INT_BUFFER,
530 intr->buffer, intr->buffer_dma);
532 spin_lock_irq(&intr->lock);
534 spin_unlock_irq(&intr->lock);
541 void zd_usb_disable_int(struct zd_usb *usb)
544 struct usb_device *udev = zd_usb_to_usbdev(usb);
545 struct zd_usb_interrupt *intr = &usb->intr;
548 dma_addr_t buffer_dma;
550 spin_lock_irqsave(&intr->lock, flags);
553 spin_unlock_irqrestore(&intr->lock, flags);
557 buffer = intr->buffer;
558 buffer_dma = intr->buffer_dma;
560 spin_unlock_irqrestore(&intr->lock, flags);
563 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
567 usb_free_coherent(udev, USB_MAX_EP_INT_BUFFER,
571 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
575 const struct rx_length_info *length_info;
577 if (length < sizeof(struct rx_length_info)) {
578 /* It's not a complete packet anyhow. */
579 printk("%s: invalid, small RX packet : %d\n",
583 length_info = (struct rx_length_info *)
584 (buffer + length - sizeof(struct rx_length_info));
586 /* It might be that three frames are merged into a single URB
587 * transaction. We have to check for the length info tag.
589 * While testing we discovered that length_info might be unaligned,
590 * because if USB transactions are merged, the last packet will not
591 * be padded. Unaligned access might also happen if the length_info
592 * structure is not present.
594 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
596 unsigned int l, k, n;
597 for (i = 0, l = 0;; i++) {
598 k = get_unaligned_le16(&length_info->length[i]);
604 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
610 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
614 static void rx_urb_complete(struct urb *urb)
617 struct zd_usb_rx *rx;
621 switch (urb->status) {
632 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
636 buffer = urb->transfer_buffer;
637 length = urb->actual_length;
641 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
642 /* If there is an old first fragment, we don't care. */
643 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
644 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
645 spin_lock(&rx->lock);
646 memcpy(rx->fragment, buffer, length);
647 rx->fragment_length = length;
648 spin_unlock(&rx->lock);
652 spin_lock(&rx->lock);
653 if (rx->fragment_length > 0) {
654 /* We are on a second fragment, we believe */
655 ZD_ASSERT(length + rx->fragment_length <=
656 ARRAY_SIZE(rx->fragment));
657 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
658 memcpy(rx->fragment+rx->fragment_length, buffer, length);
659 handle_rx_packet(usb, rx->fragment,
660 rx->fragment_length + length);
661 rx->fragment_length = 0;
662 spin_unlock(&rx->lock);
664 spin_unlock(&rx->lock);
665 handle_rx_packet(usb, buffer, length);
669 usb_submit_urb(urb, GFP_ATOMIC);
672 static struct urb *alloc_rx_urb(struct zd_usb *usb)
674 struct usb_device *udev = zd_usb_to_usbdev(usb);
678 urb = usb_alloc_urb(0, GFP_KERNEL);
681 buffer = usb_alloc_coherent(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
688 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
689 buffer, USB_MAX_RX_SIZE,
690 rx_urb_complete, usb);
691 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
696 static void free_rx_urb(struct urb *urb)
700 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
701 urb->transfer_buffer, urb->transfer_dma);
705 int zd_usb_enable_rx(struct zd_usb *usb)
708 struct zd_usb_rx *rx = &usb->rx;
711 dev_dbg_f(zd_usb_dev(usb), "\n");
714 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
717 for (i = 0; i < RX_URBS_COUNT; i++) {
718 urbs[i] = alloc_rx_urb(usb);
723 ZD_ASSERT(!irqs_disabled());
724 spin_lock_irq(&rx->lock);
726 spin_unlock_irq(&rx->lock);
731 rx->urbs_count = RX_URBS_COUNT;
732 spin_unlock_irq(&rx->lock);
734 for (i = 0; i < RX_URBS_COUNT; i++) {
735 r = usb_submit_urb(urbs[i], GFP_KERNEL);
742 for (i = 0; i < RX_URBS_COUNT; i++) {
743 usb_kill_urb(urbs[i]);
745 spin_lock_irq(&rx->lock);
748 spin_unlock_irq(&rx->lock);
751 for (i = 0; i < RX_URBS_COUNT; i++)
752 free_rx_urb(urbs[i]);
757 void zd_usb_disable_rx(struct zd_usb *usb)
763 struct zd_usb_rx *rx = &usb->rx;
765 spin_lock_irqsave(&rx->lock, flags);
767 count = rx->urbs_count;
768 spin_unlock_irqrestore(&rx->lock, flags);
772 for (i = 0; i < count; i++) {
773 usb_kill_urb(urbs[i]);
774 free_rx_urb(urbs[i]);
778 spin_lock_irqsave(&rx->lock, flags);
781 spin_unlock_irqrestore(&rx->lock, flags);
785 * zd_usb_disable_tx - disable transmission
786 * @usb: the zd1211rw-private USB structure
788 * Frees all URBs in the free list and marks the transmission as disabled.
790 void zd_usb_disable_tx(struct zd_usb *usb)
792 struct zd_usb_tx *tx = &usb->tx;
795 atomic_set(&tx->enabled, 0);
797 /* kill all submitted tx-urbs */
798 usb_kill_anchored_urbs(&tx->submitted);
800 spin_lock_irqsave(&tx->lock, flags);
801 WARN_ON(tx->submitted_urbs != 0);
802 tx->submitted_urbs = 0;
803 spin_unlock_irqrestore(&tx->lock, flags);
805 /* The stopped state is ignored, relying on ieee80211_wake_queues()
806 * in a potentionally following zd_usb_enable_tx().
811 * zd_usb_enable_tx - enables transmission
812 * @usb: a &struct zd_usb pointer
814 * This function enables transmission and prepares the &zd_usb_tx data
817 void zd_usb_enable_tx(struct zd_usb *usb)
820 struct zd_usb_tx *tx = &usb->tx;
822 spin_lock_irqsave(&tx->lock, flags);
823 atomic_set(&tx->enabled, 1);
824 tx->submitted_urbs = 0;
825 ieee80211_wake_queues(zd_usb_to_hw(usb));
827 spin_unlock_irqrestore(&tx->lock, flags);
830 static void tx_dec_submitted_urbs(struct zd_usb *usb)
832 struct zd_usb_tx *tx = &usb->tx;
835 spin_lock_irqsave(&tx->lock, flags);
836 --tx->submitted_urbs;
837 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
838 ieee80211_wake_queues(zd_usb_to_hw(usb));
841 spin_unlock_irqrestore(&tx->lock, flags);
844 static void tx_inc_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_HIGH) {
852 ieee80211_stop_queues(zd_usb_to_hw(usb));
855 spin_unlock_irqrestore(&tx->lock, flags);
859 * tx_urb_complete - completes the execution of an URB
862 * This function is called if the URB has been transferred to a device or an
863 * error has happened.
865 static void tx_urb_complete(struct urb *urb)
869 struct ieee80211_tx_info *info;
871 struct zd_usb_tx *tx;
873 skb = (struct sk_buff *)urb->context;
874 info = IEEE80211_SKB_CB(skb);
876 * grab 'usb' pointer before handing off the skb (since
877 * it might be freed by zd_mac_tx_to_dev or mac80211)
879 usb = &zd_hw_mac(info->rate_driver_data[0])->chip.usb;
882 switch (urb->status) {
891 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
894 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
898 zd_mac_tx_to_dev(skb, urb->status);
900 tx_dec_submitted_urbs(usb);
903 usb_anchor_urb(urb, &tx->submitted);
904 r = usb_submit_urb(urb, GFP_ATOMIC);
906 usb_unanchor_urb(urb);
907 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
913 * zd_usb_tx: initiates transfer of a frame of the device
915 * @usb: the zd1211rw-private USB structure
916 * @skb: a &struct sk_buff pointer
918 * This function tranmits a frame to the device. It doesn't wait for
919 * completion. The frame must contain the control set and have all the
920 * control set information available.
922 * The function returns 0 if the transfer has been successfully initiated.
924 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
927 struct usb_device *udev = zd_usb_to_usbdev(usb);
929 struct zd_usb_tx *tx = &usb->tx;
931 if (!atomic_read(&tx->enabled)) {
936 urb = usb_alloc_urb(0, GFP_ATOMIC);
942 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
943 skb->data, skb->len, tx_urb_complete, skb);
945 usb_anchor_urb(urb, &tx->submitted);
946 r = usb_submit_urb(urb, GFP_ATOMIC);
948 usb_unanchor_urb(urb);
951 tx_inc_submitted_urbs(usb);
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);
985 atomic_set(&tx->enabled, 0);
987 init_usb_anchor(&tx->submitted);
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 for (r = 1; r >= 0; r--) {
1063 endpoint = &iface_desc->endpoint[r].desc;
1064 if (usb_endpoint_dir_out(endpoint) &&
1065 usb_endpoint_xfer_bulk(endpoint)) {
1066 bulk_out_ep = endpoint->bEndpointAddress;
1072 "zd1211rw: Could not find bulk out endpoint\n");
1076 cmd = kzalloc(31, GFP_KERNEL);
1080 /* USB bulk command block */
1081 cmd[0] = 0x55; /* bulk command signature */
1082 cmd[1] = 0x53; /* bulk command signature */
1083 cmd[2] = 0x42; /* bulk command signature */
1084 cmd[3] = 0x43; /* bulk command signature */
1085 cmd[14] = 6; /* command length */
1087 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1088 cmd[19] = 0x2; /* eject disc */
1090 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1091 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1092 cmd, 31, NULL, 2000);
1097 /* At this point, the device disconnects and reconnects with the real
1100 usb_set_intfdata(intf, NULL);
1104 int zd_usb_init_hw(struct zd_usb *usb)
1107 struct zd_mac *mac = zd_usb_to_mac(usb);
1109 dev_dbg_f(zd_usb_dev(usb), "\n");
1111 r = upload_firmware(usb);
1113 dev_err(zd_usb_dev(usb),
1114 "couldn't load firmware. Error number %d\n", r);
1118 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1120 dev_dbg_f(zd_usb_dev(usb),
1121 "couldn't reset configuration. Error number %d\n", r);
1125 r = zd_mac_init_hw(mac->hw);
1127 dev_dbg_f(zd_usb_dev(usb),
1128 "couldn't initialize mac. Error number %d\n", r);
1132 usb->initialized = 1;
1136 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1139 struct usb_device *udev = interface_to_usbdev(intf);
1141 struct ieee80211_hw *hw = NULL;
1145 if (id->driver_info & DEVICE_INSTALLER)
1146 return eject_installer(intf);
1148 switch (udev->speed) {
1150 case USB_SPEED_FULL:
1151 case USB_SPEED_HIGH:
1154 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1159 r = usb_reset_device(udev);
1162 "couldn't reset usb device. Error number %d\n", r);
1166 hw = zd_mac_alloc_hw(intf);
1172 usb = &zd_hw_mac(hw)->chip.usb;
1173 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1175 r = zd_mac_preinit_hw(hw);
1177 dev_dbg_f(&intf->dev,
1178 "couldn't initialize mac. Error number %d\n", r);
1182 r = ieee80211_register_hw(hw);
1184 dev_dbg_f(&intf->dev,
1185 "couldn't register device. Error number %d\n", r);
1189 dev_dbg_f(&intf->dev, "successful\n");
1190 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1193 usb_reset_device(interface_to_usbdev(intf));
1195 zd_mac_clear(zd_hw_mac(hw));
1196 ieee80211_free_hw(hw);
1201 static void disconnect(struct usb_interface *intf)
1203 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1207 /* Either something really bad happened, or we're just dealing with
1208 * a DEVICE_INSTALLER. */
1212 mac = zd_hw_mac(hw);
1213 usb = &mac->chip.usb;
1215 dev_dbg_f(zd_usb_dev(usb), "\n");
1217 ieee80211_unregister_hw(hw);
1219 /* Just in case something has gone wrong! */
1220 zd_usb_disable_tx(usb);
1221 zd_usb_disable_rx(usb);
1222 zd_usb_disable_int(usb);
1224 /* If the disconnect has been caused by a removal of the
1225 * driver module, the reset allows reloading of the driver. If the
1226 * reset will not be executed here, the upload of the firmware in the
1227 * probe function caused by the reloading of the driver will fail.
1229 usb_reset_device(interface_to_usbdev(intf));
1232 ieee80211_free_hw(hw);
1233 dev_dbg(&intf->dev, "disconnected\n");
1236 static struct usb_driver driver = {
1237 .name = KBUILD_MODNAME,
1238 .id_table = usb_ids,
1240 .disconnect = disconnect,
1243 struct workqueue_struct *zd_workqueue;
1245 static int __init usb_init(void)
1249 pr_debug("%s usb_init()\n", driver.name);
1251 zd_workqueue = create_singlethread_workqueue(driver.name);
1252 if (zd_workqueue == NULL) {
1253 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1257 r = usb_register(&driver);
1259 destroy_workqueue(zd_workqueue);
1260 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1265 pr_debug("%s initialized\n", driver.name);
1269 static void __exit usb_exit(void)
1271 pr_debug("%s usb_exit()\n", driver.name);
1272 usb_deregister(&driver);
1273 destroy_workqueue(zd_workqueue);
1276 module_init(usb_init);
1277 module_exit(usb_exit);
1279 static int usb_int_regs_length(unsigned int count)
1281 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1284 static void prepare_read_regs_int(struct zd_usb *usb)
1286 struct zd_usb_interrupt *intr = &usb->intr;
1288 spin_lock_irq(&intr->lock);
1289 intr->read_regs_enabled = 1;
1290 INIT_COMPLETION(intr->read_regs.completion);
1291 spin_unlock_irq(&intr->lock);
1294 static void disable_read_regs_int(struct zd_usb *usb)
1296 struct zd_usb_interrupt *intr = &usb->intr;
1298 spin_lock_irq(&intr->lock);
1299 intr->read_regs_enabled = 0;
1300 spin_unlock_irq(&intr->lock);
1303 static int get_results(struct zd_usb *usb, u16 *values,
1304 struct usb_req_read_regs *req, unsigned int count)
1308 struct zd_usb_interrupt *intr = &usb->intr;
1309 struct read_regs_int *rr = &intr->read_regs;
1310 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1312 spin_lock_irq(&intr->lock);
1315 /* The created block size seems to be larger than expected.
1316 * However results appear to be correct.
1318 if (rr->length < usb_int_regs_length(count)) {
1319 dev_dbg_f(zd_usb_dev(usb),
1320 "error: actual length %d less than expected %d\n",
1321 rr->length, usb_int_regs_length(count));
1324 if (rr->length > sizeof(rr->buffer)) {
1325 dev_dbg_f(zd_usb_dev(usb),
1326 "error: actual length %d exceeds buffer size %zu\n",
1327 rr->length, sizeof(rr->buffer));
1331 for (i = 0; i < count; i++) {
1332 struct reg_data *rd = ®s->regs[i];
1333 if (rd->addr != req->addr[i]) {
1334 dev_dbg_f(zd_usb_dev(usb),
1335 "rd[%d] addr %#06hx expected %#06hx\n", i,
1336 le16_to_cpu(rd->addr),
1337 le16_to_cpu(req->addr[i]));
1340 values[i] = le16_to_cpu(rd->value);
1345 spin_unlock_irq(&intr->lock);
1349 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1350 const zd_addr_t *addresses, unsigned int count)
1353 int i, req_len, actual_req_len;
1354 struct usb_device *udev;
1355 struct usb_req_read_regs *req = NULL;
1356 unsigned long timeout;
1359 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1362 if (count > USB_MAX_IOREAD16_COUNT) {
1363 dev_dbg_f(zd_usb_dev(usb),
1364 "error: count %u exceeds possible max %u\n",
1365 count, USB_MAX_IOREAD16_COUNT);
1369 dev_dbg_f(zd_usb_dev(usb),
1370 "error: io in atomic context not supported\n");
1371 return -EWOULDBLOCK;
1373 if (!usb_int_enabled(usb)) {
1374 dev_dbg_f(zd_usb_dev(usb),
1375 "error: usb interrupt not enabled\n");
1376 return -EWOULDBLOCK;
1379 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1380 BUILD_BUG_ON(sizeof(struct usb_req_read_regs) + USB_MAX_IOREAD16_COUNT *
1381 sizeof(__le16) > sizeof(usb->req_buf));
1382 BUG_ON(sizeof(struct usb_req_read_regs) + count * sizeof(__le16) >
1383 sizeof(usb->req_buf));
1385 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1386 req = (void *)usb->req_buf;
1388 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1389 for (i = 0; i < count; i++)
1390 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1392 udev = zd_usb_to_usbdev(usb);
1393 prepare_read_regs_int(usb);
1394 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1395 req, req_len, &actual_req_len, 1000 /* ms */);
1397 dev_dbg_f(zd_usb_dev(usb),
1398 "error in usb_bulk_msg(). Error number %d\n", r);
1401 if (req_len != actual_req_len) {
1402 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1403 " req_len %d != actual_req_len %d\n",
1404 req_len, actual_req_len);
1409 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1410 msecs_to_jiffies(1000));
1412 disable_read_regs_int(usb);
1413 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1418 r = get_results(usb, values, req, count);
1423 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1427 struct usb_device *udev;
1428 struct usb_req_write_regs *req = NULL;
1429 int i, req_len, actual_req_len;
1433 if (count > USB_MAX_IOWRITE16_COUNT) {
1434 dev_dbg_f(zd_usb_dev(usb),
1435 "error: count %u exceeds possible max %u\n",
1436 count, USB_MAX_IOWRITE16_COUNT);
1440 dev_dbg_f(zd_usb_dev(usb),
1441 "error: io in atomic context not supported\n");
1442 return -EWOULDBLOCK;
1445 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1446 BUILD_BUG_ON(sizeof(struct usb_req_write_regs) +
1447 USB_MAX_IOWRITE16_COUNT * sizeof(struct reg_data) >
1448 sizeof(usb->req_buf));
1449 BUG_ON(sizeof(struct usb_req_write_regs) +
1450 count * sizeof(struct reg_data) >
1451 sizeof(usb->req_buf));
1453 req_len = sizeof(struct usb_req_write_regs) +
1454 count * sizeof(struct reg_data);
1455 req = (void *)usb->req_buf;
1457 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1458 for (i = 0; i < count; i++) {
1459 struct reg_data *rw = &req->reg_writes[i];
1460 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1461 rw->value = cpu_to_le16(ioreqs[i].value);
1464 udev = zd_usb_to_usbdev(usb);
1465 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1466 req, req_len, &actual_req_len, 1000 /* ms */);
1468 dev_dbg_f(zd_usb_dev(usb),
1469 "error in usb_bulk_msg(). Error number %d\n", r);
1472 if (req_len != actual_req_len) {
1473 dev_dbg_f(zd_usb_dev(usb),
1474 "error in usb_bulk_msg()"
1475 " req_len %d != actual_req_len %d\n",
1476 req_len, actual_req_len);
1481 /* FALL-THROUGH with r == 0 */
1486 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1489 struct usb_device *udev;
1490 struct usb_req_rfwrite *req = NULL;
1491 int i, req_len, actual_req_len;
1492 u16 bit_value_template;
1495 dev_dbg_f(zd_usb_dev(usb),
1496 "error: io in atomic context not supported\n");
1497 return -EWOULDBLOCK;
1499 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1500 dev_dbg_f(zd_usb_dev(usb),
1501 "error: bits %d are smaller than"
1502 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1503 bits, USB_MIN_RFWRITE_BIT_COUNT);
1506 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1507 dev_dbg_f(zd_usb_dev(usb),
1508 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1509 bits, USB_MAX_RFWRITE_BIT_COUNT);
1513 if (value & (~0UL << bits)) {
1514 dev_dbg_f(zd_usb_dev(usb),
1515 "error: value %#09x has bits >= %d set\n",
1521 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1523 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1525 dev_dbg_f(zd_usb_dev(usb),
1526 "error %d: Couldn't read CR203\n", r);
1529 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1531 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1532 BUILD_BUG_ON(sizeof(struct usb_req_rfwrite) +
1533 USB_MAX_RFWRITE_BIT_COUNT * sizeof(__le16) >
1534 sizeof(usb->req_buf));
1535 BUG_ON(sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16) >
1536 sizeof(usb->req_buf));
1538 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1539 req = (void *)usb->req_buf;
1541 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1542 /* 1: 3683a, but not used in ZYDAS driver */
1543 req->value = cpu_to_le16(2);
1544 req->bits = cpu_to_le16(bits);
1546 for (i = 0; i < bits; i++) {
1547 u16 bv = bit_value_template;
1548 if (value & (1 << (bits-1-i)))
1550 req->bit_values[i] = cpu_to_le16(bv);
1553 udev = zd_usb_to_usbdev(usb);
1554 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1555 req, req_len, &actual_req_len, 1000 /* ms */);
1557 dev_dbg_f(zd_usb_dev(usb),
1558 "error in usb_bulk_msg(). Error number %d\n", r);
1561 if (req_len != actual_req_len) {
1562 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1563 " req_len %d != actual_req_len %d\n",
1564 req_len, actual_req_len);
1569 /* FALL-THROUGH with r == 0 */