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, see <http://www.gnu.org/licenses/>.
21 #include <linux/kernel.h>
22 #include <linux/init.h>
23 #include <linux/firmware.h>
24 #include <linux/device.h>
25 #include <linux/errno.h>
26 #include <linux/slab.h>
27 #include <linux/skbuff.h>
28 #include <linux/usb.h>
29 #include <linux/workqueue.h>
30 #include <linux/module.h>
31 #include <net/mac80211.h>
32 #include <asm/unaligned.h>
38 static const 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(0x157e, 0x3207), .driver_info = DEVICE_ZD1211 },
64 { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
65 { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
67 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x0409, 0x0248), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x0471, 0x1237), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x054c, 0x0257), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
78 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
79 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
80 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211B },
81 { USB_DEVICE(0x07fa, 0x1196), .driver_info = DEVICE_ZD1211B },
82 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
83 { USB_DEVICE(0x083a, 0xe501), .driver_info = DEVICE_ZD1211B },
84 { USB_DEVICE(0x083a, 0xe503), .driver_info = DEVICE_ZD1211B },
85 { USB_DEVICE(0x083a, 0xe506), .driver_info = DEVICE_ZD1211B },
86 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
87 { USB_DEVICE(0x0ace, 0xb215), .driver_info = DEVICE_ZD1211B },
88 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
89 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
90 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
91 { USB_DEVICE(0x0df6, 0x0036), .driver_info = DEVICE_ZD1211B },
92 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
93 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
94 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
95 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
96 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
97 { USB_DEVICE(0x2019, 0xed01), .driver_info = DEVICE_ZD1211B },
98 /* "Driverless" devices that need ejecting */
99 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
100 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
104 MODULE_LICENSE("GPL");
105 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
106 MODULE_AUTHOR("Ulrich Kunitz");
107 MODULE_AUTHOR("Daniel Drake");
108 MODULE_VERSION("1.0");
109 MODULE_DEVICE_TABLE(usb, usb_ids);
111 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
112 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
114 static bool check_read_regs(struct zd_usb *usb, struct usb_req_read_regs *req,
117 /* USB device initialization */
118 static void int_urb_complete(struct urb *urb);
120 static int request_fw_file(
121 const struct firmware **fw, const char *name, struct device *device)
125 dev_dbg_f(device, "fw name %s\n", name);
127 r = request_firmware(fw, name, device);
130 "Could not load firmware file %s. Error number %d\n",
135 static inline u16 get_bcdDevice(const struct usb_device *udev)
137 return le16_to_cpu(udev->descriptor.bcdDevice);
140 enum upload_code_flags {
144 /* Ensures that MAX_TRANSFER_SIZE is even. */
145 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
147 static int upload_code(struct usb_device *udev,
148 const u8 *data, size_t size, u16 code_offset, int flags)
153 /* USB request blocks need "kmalloced" buffers.
155 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
163 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
164 size : MAX_TRANSFER_SIZE;
166 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
168 memcpy(p, data, transfer_size);
169 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
170 USB_REQ_FIRMWARE_DOWNLOAD,
171 USB_DIR_OUT | USB_TYPE_VENDOR,
172 code_offset, 0, p, transfer_size, 1000 /* ms */);
175 "USB control request for firmware upload"
176 " failed. Error number %d\n", r);
179 transfer_size = r & ~1;
181 size -= transfer_size;
182 data += transfer_size;
183 code_offset += transfer_size/sizeof(u16);
186 if (flags & REBOOT) {
189 /* Use "DMA-aware" buffer. */
190 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
191 USB_REQ_FIRMWARE_CONFIRM,
192 USB_DIR_IN | USB_TYPE_VENDOR,
193 0, 0, p, sizeof(ret), 5000 /* ms */);
194 if (r != sizeof(ret)) {
196 "control request firmware confirmation failed."
197 " Return value %d\n", r);
205 "Internal error while downloading."
206 " Firmware confirm return value %#04x\n",
211 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
221 static u16 get_word(const void *data, u16 offset)
223 const __le16 *p = data;
224 return le16_to_cpu(p[offset]);
227 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
230 scnprintf(buffer, size, "%s%s",
232 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
237 static int handle_version_mismatch(struct zd_usb *usb,
238 const struct firmware *ub_fw)
240 struct usb_device *udev = zd_usb_to_usbdev(usb);
241 const struct firmware *ur_fw = NULL;
246 r = request_fw_file(&ur_fw,
247 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
252 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
256 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
257 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
258 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
260 /* At this point, the vendor driver downloads the whole firmware
261 * image, hacks around with version IDs, and uploads it again,
262 * completely overwriting the boot code. We do not do this here as
263 * it is not required on any tested devices, and it is suspected to
266 release_firmware(ur_fw);
270 static int upload_firmware(struct zd_usb *usb)
275 struct usb_device *udev = zd_usb_to_usbdev(usb);
276 const struct firmware *ub_fw = NULL;
277 const struct firmware *uph_fw = NULL;
280 bcdDevice = get_bcdDevice(udev);
282 r = request_fw_file(&ub_fw,
283 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
288 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
290 if (fw_bcdDevice != bcdDevice) {
292 "firmware version %#06x and device bootcode version "
293 "%#06x differ\n", fw_bcdDevice, bcdDevice);
294 if (bcdDevice <= 0x4313)
295 dev_warn(&udev->dev, "device has old bootcode, please "
296 "report success or failure\n");
298 r = handle_version_mismatch(usb, ub_fw);
302 dev_dbg_f(&udev->dev,
303 "firmware device id %#06x is equal to the "
304 "actual device id\n", fw_bcdDevice);
308 r = request_fw_file(&uph_fw,
309 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
314 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
317 "Could not upload firmware code uph. Error number %d\n",
323 release_firmware(ub_fw);
324 release_firmware(uph_fw);
328 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "ur");
329 MODULE_FIRMWARE(FW_ZD1211_PREFIX "ur");
330 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "ub");
331 MODULE_FIRMWARE(FW_ZD1211_PREFIX "ub");
332 MODULE_FIRMWARE(FW_ZD1211B_PREFIX "uphr");
333 MODULE_FIRMWARE(FW_ZD1211_PREFIX "uphr");
335 /* Read data from device address space using "firmware interface" which does
336 * not require firmware to be loaded. */
337 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
340 struct usb_device *udev = zd_usb_to_usbdev(usb);
343 /* Use "DMA-aware" buffer. */
344 buf = kmalloc(len, GFP_KERNEL);
347 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
348 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
352 "read over firmware interface failed: %d\n", r);
354 } else if (r != len) {
356 "incomplete read over firmware interface: %d/%d\n",
362 memcpy(data, buf, len);
368 #define urb_dev(urb) (&(urb)->dev->dev)
370 static inline void handle_regs_int_override(struct urb *urb)
372 struct zd_usb *usb = urb->context;
373 struct zd_usb_interrupt *intr = &usb->intr;
376 spin_lock_irqsave(&intr->lock, flags);
377 if (atomic_read(&intr->read_regs_enabled)) {
378 atomic_set(&intr->read_regs_enabled, 0);
379 intr->read_regs_int_overridden = 1;
380 complete(&intr->read_regs.completion);
382 spin_unlock_irqrestore(&intr->lock, flags);
385 static inline void handle_regs_int(struct urb *urb)
387 struct zd_usb *usb = urb->context;
388 struct zd_usb_interrupt *intr = &usb->intr;
393 ZD_ASSERT(in_interrupt());
394 spin_lock_irqsave(&intr->lock, flags);
396 int_num = le16_to_cpu(*(__le16 *)(urb->transfer_buffer+2));
397 if (int_num == CR_INTERRUPT) {
398 struct zd_mac *mac = zd_hw_mac(zd_usb_to_hw(urb->context));
399 spin_lock(&mac->lock);
400 memcpy(&mac->intr_buffer, urb->transfer_buffer,
401 USB_MAX_EP_INT_BUFFER);
402 spin_unlock(&mac->lock);
403 schedule_work(&mac->process_intr);
404 } else if (atomic_read(&intr->read_regs_enabled)) {
405 len = urb->actual_length;
406 intr->read_regs.length = urb->actual_length;
407 if (len > sizeof(intr->read_regs.buffer))
408 len = sizeof(intr->read_regs.buffer);
410 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
412 /* Sometimes USB_INT_ID_REGS is not overridden, but comes after
413 * USB_INT_ID_RETRY_FAILED. Read-reg retry then gets this
414 * delayed USB_INT_ID_REGS, but leaves USB_INT_ID_REGS of
415 * retry unhandled. Next read-reg command then might catch
416 * this wrong USB_INT_ID_REGS. Fix by ignoring wrong reads.
418 if (!check_read_regs(usb, intr->read_regs.req,
419 intr->read_regs.req_count))
422 atomic_set(&intr->read_regs_enabled, 0);
423 intr->read_regs_int_overridden = 0;
424 complete(&intr->read_regs.completion);
430 spin_unlock_irqrestore(&intr->lock, flags);
432 /* CR_INTERRUPT might override read_reg too. */
433 if (int_num == CR_INTERRUPT && atomic_read(&intr->read_regs_enabled))
434 handle_regs_int_override(urb);
437 static void int_urb_complete(struct urb *urb)
440 struct usb_int_header *hdr;
442 struct zd_usb_interrupt *intr;
444 switch (urb->status) {
453 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
456 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
460 if (urb->actual_length < sizeof(hdr)) {
461 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
465 hdr = urb->transfer_buffer;
466 if (hdr->type != USB_INT_TYPE) {
467 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
471 /* USB_INT_ID_RETRY_FAILED triggered by tx-urb submit can override
472 * pending USB_INT_ID_REGS causing read command timeout.
476 if (hdr->id != USB_INT_ID_REGS && atomic_read(&intr->read_regs_enabled))
477 handle_regs_int_override(urb);
480 case USB_INT_ID_REGS:
481 handle_regs_int(urb);
483 case USB_INT_ID_RETRY_FAILED:
484 zd_mac_tx_failed(urb);
487 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
488 (unsigned int)hdr->id);
493 r = usb_submit_urb(urb, GFP_ATOMIC);
495 dev_dbg_f(urb_dev(urb), "error: resubmit urb %p err code %d\n",
497 /* TODO: add worker to reset intr->urb */
502 static inline int int_urb_interval(struct usb_device *udev)
504 switch (udev->speed) {
515 static inline int usb_int_enabled(struct zd_usb *usb)
518 struct zd_usb_interrupt *intr = &usb->intr;
521 spin_lock_irqsave(&intr->lock, flags);
523 spin_unlock_irqrestore(&intr->lock, flags);
527 int zd_usb_enable_int(struct zd_usb *usb)
530 struct usb_device *udev = zd_usb_to_usbdev(usb);
531 struct zd_usb_interrupt *intr = &usb->intr;
534 dev_dbg_f(zd_usb_dev(usb), "\n");
536 urb = usb_alloc_urb(0, GFP_KERNEL);
542 ZD_ASSERT(!irqs_disabled());
543 spin_lock_irq(&intr->lock);
545 spin_unlock_irq(&intr->lock);
550 spin_unlock_irq(&intr->lock);
553 intr->buffer = usb_alloc_coherent(udev, USB_MAX_EP_INT_BUFFER,
554 GFP_KERNEL, &intr->buffer_dma);
556 dev_dbg_f(zd_usb_dev(usb),
557 "couldn't allocate transfer_buffer\n");
558 goto error_set_urb_null;
561 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
562 intr->buffer, USB_MAX_EP_INT_BUFFER,
563 int_urb_complete, usb,
565 urb->transfer_dma = intr->buffer_dma;
566 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
568 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
569 r = usb_submit_urb(urb, GFP_KERNEL);
571 dev_dbg_f(zd_usb_dev(usb),
572 "Couldn't submit urb. Error number %d\n", r);
578 usb_free_coherent(udev, USB_MAX_EP_INT_BUFFER,
579 intr->buffer, intr->buffer_dma);
581 spin_lock_irq(&intr->lock);
583 spin_unlock_irq(&intr->lock);
590 void zd_usb_disable_int(struct zd_usb *usb)
593 struct usb_device *udev = zd_usb_to_usbdev(usb);
594 struct zd_usb_interrupt *intr = &usb->intr;
597 dma_addr_t buffer_dma;
599 spin_lock_irqsave(&intr->lock, flags);
602 spin_unlock_irqrestore(&intr->lock, flags);
606 buffer = intr->buffer;
607 buffer_dma = intr->buffer_dma;
609 spin_unlock_irqrestore(&intr->lock, flags);
612 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
616 usb_free_coherent(udev, USB_MAX_EP_INT_BUFFER,
620 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
624 const struct rx_length_info *length_info;
626 if (length < sizeof(struct rx_length_info)) {
627 /* It's not a complete packet anyhow. */
628 dev_dbg_f(zd_usb_dev(usb), "invalid, small RX packet : %d\n",
632 length_info = (struct rx_length_info *)
633 (buffer + length - sizeof(struct rx_length_info));
635 /* It might be that three frames are merged into a single URB
636 * transaction. We have to check for the length info tag.
638 * While testing we discovered that length_info might be unaligned,
639 * because if USB transactions are merged, the last packet will not
640 * be padded. Unaligned access might also happen if the length_info
641 * structure is not present.
643 if (get_unaligned_le16(&length_info->tag) == RX_LENGTH_INFO_TAG)
645 unsigned int l, k, n;
646 for (i = 0, l = 0;; i++) {
647 k = get_unaligned_le16(&length_info->length[i]);
653 zd_mac_rx(zd_usb_to_hw(usb), buffer+l, k);
659 zd_mac_rx(zd_usb_to_hw(usb), buffer, length);
663 static void rx_urb_complete(struct urb *urb)
667 struct zd_usb_rx *rx;
672 switch (urb->status) {
681 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
684 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
688 buffer = urb->transfer_buffer;
689 length = urb->actual_length;
693 tasklet_schedule(&rx->reset_timer_tasklet);
695 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
696 /* If there is an old first fragment, we don't care. */
697 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
698 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
699 spin_lock_irqsave(&rx->lock, flags);
700 memcpy(rx->fragment, buffer, length);
701 rx->fragment_length = length;
702 spin_unlock_irqrestore(&rx->lock, flags);
706 spin_lock_irqsave(&rx->lock, flags);
707 if (rx->fragment_length > 0) {
708 /* We are on a second fragment, we believe */
709 ZD_ASSERT(length + rx->fragment_length <=
710 ARRAY_SIZE(rx->fragment));
711 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
712 memcpy(rx->fragment+rx->fragment_length, buffer, length);
713 handle_rx_packet(usb, rx->fragment,
714 rx->fragment_length + length);
715 rx->fragment_length = 0;
716 spin_unlock_irqrestore(&rx->lock, flags);
718 spin_unlock_irqrestore(&rx->lock, flags);
719 handle_rx_packet(usb, buffer, length);
723 r = usb_submit_urb(urb, GFP_ATOMIC);
725 dev_dbg_f(urb_dev(urb), "urb %p resubmit error %d\n", urb, r);
728 static struct urb *alloc_rx_urb(struct zd_usb *usb)
730 struct usb_device *udev = zd_usb_to_usbdev(usb);
734 urb = usb_alloc_urb(0, GFP_KERNEL);
737 buffer = usb_alloc_coherent(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
744 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
745 buffer, USB_MAX_RX_SIZE,
746 rx_urb_complete, usb);
747 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
752 static void free_rx_urb(struct urb *urb)
756 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
757 urb->transfer_buffer, urb->transfer_dma);
761 static int __zd_usb_enable_rx(struct zd_usb *usb)
764 struct zd_usb_rx *rx = &usb->rx;
767 dev_dbg_f(zd_usb_dev(usb), "\n");
770 urbs = kcalloc(RX_URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
773 for (i = 0; i < RX_URBS_COUNT; i++) {
774 urbs[i] = alloc_rx_urb(usb);
779 ZD_ASSERT(!irqs_disabled());
780 spin_lock_irq(&rx->lock);
782 spin_unlock_irq(&rx->lock);
787 rx->urbs_count = RX_URBS_COUNT;
788 spin_unlock_irq(&rx->lock);
790 for (i = 0; i < RX_URBS_COUNT; i++) {
791 r = usb_submit_urb(urbs[i], GFP_KERNEL);
798 for (i = 0; i < RX_URBS_COUNT; i++) {
799 usb_kill_urb(urbs[i]);
801 spin_lock_irq(&rx->lock);
804 spin_unlock_irq(&rx->lock);
807 for (i = 0; i < RX_URBS_COUNT; i++)
808 free_rx_urb(urbs[i]);
813 int zd_usb_enable_rx(struct zd_usb *usb)
816 struct zd_usb_rx *rx = &usb->rx;
818 mutex_lock(&rx->setup_mutex);
819 r = __zd_usb_enable_rx(usb);
820 mutex_unlock(&rx->setup_mutex);
822 zd_usb_reset_rx_idle_timer(usb);
827 static void __zd_usb_disable_rx(struct zd_usb *usb)
833 struct zd_usb_rx *rx = &usb->rx;
835 spin_lock_irqsave(&rx->lock, flags);
837 count = rx->urbs_count;
838 spin_unlock_irqrestore(&rx->lock, flags);
842 for (i = 0; i < count; i++) {
843 usb_kill_urb(urbs[i]);
844 free_rx_urb(urbs[i]);
848 spin_lock_irqsave(&rx->lock, flags);
851 spin_unlock_irqrestore(&rx->lock, flags);
854 void zd_usb_disable_rx(struct zd_usb *usb)
856 struct zd_usb_rx *rx = &usb->rx;
858 mutex_lock(&rx->setup_mutex);
859 __zd_usb_disable_rx(usb);
860 mutex_unlock(&rx->setup_mutex);
862 tasklet_kill(&rx->reset_timer_tasklet);
863 cancel_delayed_work_sync(&rx->idle_work);
866 static void zd_usb_reset_rx(struct zd_usb *usb)
869 struct zd_usb_rx *rx = &usb->rx;
872 mutex_lock(&rx->setup_mutex);
874 spin_lock_irqsave(&rx->lock, flags);
875 do_reset = rx->urbs != NULL;
876 spin_unlock_irqrestore(&rx->lock, flags);
879 __zd_usb_disable_rx(usb);
880 __zd_usb_enable_rx(usb);
883 mutex_unlock(&rx->setup_mutex);
886 zd_usb_reset_rx_idle_timer(usb);
890 * zd_usb_disable_tx - disable transmission
891 * @usb: the zd1211rw-private USB structure
893 * Frees all URBs in the free list and marks the transmission as disabled.
895 void zd_usb_disable_tx(struct zd_usb *usb)
897 struct zd_usb_tx *tx = &usb->tx;
900 atomic_set(&tx->enabled, 0);
902 /* kill all submitted tx-urbs */
903 usb_kill_anchored_urbs(&tx->submitted);
905 spin_lock_irqsave(&tx->lock, flags);
906 WARN_ON(!skb_queue_empty(&tx->submitted_skbs));
907 WARN_ON(tx->submitted_urbs != 0);
908 tx->submitted_urbs = 0;
909 spin_unlock_irqrestore(&tx->lock, flags);
911 /* The stopped state is ignored, relying on ieee80211_wake_queues()
912 * in a potentionally following zd_usb_enable_tx().
917 * zd_usb_enable_tx - enables transmission
918 * @usb: a &struct zd_usb pointer
920 * This function enables transmission and prepares the &zd_usb_tx data
923 void zd_usb_enable_tx(struct zd_usb *usb)
926 struct zd_usb_tx *tx = &usb->tx;
928 spin_lock_irqsave(&tx->lock, flags);
929 atomic_set(&tx->enabled, 1);
930 tx->submitted_urbs = 0;
931 ieee80211_wake_queues(zd_usb_to_hw(usb));
933 spin_unlock_irqrestore(&tx->lock, flags);
936 static void tx_dec_submitted_urbs(struct zd_usb *usb)
938 struct zd_usb_tx *tx = &usb->tx;
941 spin_lock_irqsave(&tx->lock, flags);
942 --tx->submitted_urbs;
943 if (tx->stopped && tx->submitted_urbs <= ZD_USB_TX_LOW) {
944 ieee80211_wake_queues(zd_usb_to_hw(usb));
947 spin_unlock_irqrestore(&tx->lock, flags);
950 static void tx_inc_submitted_urbs(struct zd_usb *usb)
952 struct zd_usb_tx *tx = &usb->tx;
955 spin_lock_irqsave(&tx->lock, flags);
956 ++tx->submitted_urbs;
957 if (!tx->stopped && tx->submitted_urbs > ZD_USB_TX_HIGH) {
958 ieee80211_stop_queues(zd_usb_to_hw(usb));
961 spin_unlock_irqrestore(&tx->lock, flags);
965 * tx_urb_complete - completes the execution of an URB
968 * This function is called if the URB has been transferred to a device or an
969 * error has happened.
971 static void tx_urb_complete(struct urb *urb)
975 struct ieee80211_tx_info *info;
977 struct zd_usb_tx *tx;
979 skb = (struct sk_buff *)urb->context;
980 info = IEEE80211_SKB_CB(skb);
982 * grab 'usb' pointer before handing off the skb (since
983 * it might be freed by zd_mac_tx_to_dev or mac80211)
985 usb = &zd_hw_mac(info->rate_driver_data[0])->chip.usb;
988 switch (urb->status) {
997 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
1000 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
1004 skb_unlink(skb, &usb->tx.submitted_skbs);
1005 zd_mac_tx_to_dev(skb, urb->status);
1007 tx_dec_submitted_urbs(usb);
1010 usb_anchor_urb(urb, &tx->submitted);
1011 r = usb_submit_urb(urb, GFP_ATOMIC);
1013 usb_unanchor_urb(urb);
1014 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
1020 * zd_usb_tx: initiates transfer of a frame of the device
1022 * @usb: the zd1211rw-private USB structure
1023 * @skb: a &struct sk_buff pointer
1025 * This function tranmits a frame to the device. It doesn't wait for
1026 * completion. The frame must contain the control set and have all the
1027 * control set information available.
1029 * The function returns 0 if the transfer has been successfully initiated.
1031 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb)
1034 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1035 struct usb_device *udev = zd_usb_to_usbdev(usb);
1037 struct zd_usb_tx *tx = &usb->tx;
1039 if (!atomic_read(&tx->enabled)) {
1044 urb = usb_alloc_urb(0, GFP_ATOMIC);
1050 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
1051 skb->data, skb->len, tx_urb_complete, skb);
1053 info->rate_driver_data[1] = (void *)jiffies;
1054 skb_queue_tail(&tx->submitted_skbs, skb);
1055 usb_anchor_urb(urb, &tx->submitted);
1057 r = usb_submit_urb(urb, GFP_ATOMIC);
1059 dev_dbg_f(zd_usb_dev(usb), "error submit urb %p %d\n", urb, r);
1060 usb_unanchor_urb(urb);
1061 skb_unlink(skb, &tx->submitted_skbs);
1064 tx_inc_submitted_urbs(usb);
1072 static bool zd_tx_timeout(struct zd_usb *usb)
1074 struct zd_usb_tx *tx = &usb->tx;
1075 struct sk_buff_head *q = &tx->submitted_skbs;
1076 struct sk_buff *skb, *skbnext;
1077 struct ieee80211_tx_info *info;
1078 unsigned long flags, trans_start;
1079 bool have_timedout = false;
1081 spin_lock_irqsave(&q->lock, flags);
1082 skb_queue_walk_safe(q, skb, skbnext) {
1083 info = IEEE80211_SKB_CB(skb);
1084 trans_start = (unsigned long)info->rate_driver_data[1];
1086 if (time_is_before_jiffies(trans_start + ZD_TX_TIMEOUT)) {
1087 have_timedout = true;
1091 spin_unlock_irqrestore(&q->lock, flags);
1093 return have_timedout;
1096 static void zd_tx_watchdog_handler(struct work_struct *work)
1098 struct zd_usb *usb =
1099 container_of(work, struct zd_usb, tx.watchdog_work.work);
1100 struct zd_usb_tx *tx = &usb->tx;
1102 if (!atomic_read(&tx->enabled) || !tx->watchdog_enabled)
1104 if (!zd_tx_timeout(usb))
1107 /* TX halted, try reset */
1108 dev_warn(zd_usb_dev(usb), "TX-stall detected, resetting device...");
1110 usb_queue_reset_device(usb->intf);
1112 /* reset will stop this worker, don't rearm */
1115 queue_delayed_work(zd_workqueue, &tx->watchdog_work,
1116 ZD_TX_WATCHDOG_INTERVAL);
1119 void zd_tx_watchdog_enable(struct zd_usb *usb)
1121 struct zd_usb_tx *tx = &usb->tx;
1123 if (!tx->watchdog_enabled) {
1124 dev_dbg_f(zd_usb_dev(usb), "\n");
1125 queue_delayed_work(zd_workqueue, &tx->watchdog_work,
1126 ZD_TX_WATCHDOG_INTERVAL);
1127 tx->watchdog_enabled = 1;
1131 void zd_tx_watchdog_disable(struct zd_usb *usb)
1133 struct zd_usb_tx *tx = &usb->tx;
1135 if (tx->watchdog_enabled) {
1136 dev_dbg_f(zd_usb_dev(usb), "\n");
1137 tx->watchdog_enabled = 0;
1138 cancel_delayed_work_sync(&tx->watchdog_work);
1142 static void zd_rx_idle_timer_handler(struct work_struct *work)
1144 struct zd_usb *usb =
1145 container_of(work, struct zd_usb, rx.idle_work.work);
1146 struct zd_mac *mac = zd_usb_to_mac(usb);
1148 if (!test_bit(ZD_DEVICE_RUNNING, &mac->flags))
1151 dev_dbg_f(zd_usb_dev(usb), "\n");
1153 /* 30 seconds since last rx, reset rx */
1154 zd_usb_reset_rx(usb);
1157 static void zd_usb_reset_rx_idle_timer_tasklet(unsigned long param)
1159 struct zd_usb *usb = (struct zd_usb *)param;
1161 zd_usb_reset_rx_idle_timer(usb);
1164 void zd_usb_reset_rx_idle_timer(struct zd_usb *usb)
1166 struct zd_usb_rx *rx = &usb->rx;
1168 mod_delayed_work(zd_workqueue, &rx->idle_work, ZD_RX_IDLE_INTERVAL);
1171 static inline void init_usb_interrupt(struct zd_usb *usb)
1173 struct zd_usb_interrupt *intr = &usb->intr;
1175 spin_lock_init(&intr->lock);
1176 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
1177 init_completion(&intr->read_regs.completion);
1178 atomic_set(&intr->read_regs_enabled, 0);
1179 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
1182 static inline void init_usb_rx(struct zd_usb *usb)
1184 struct zd_usb_rx *rx = &usb->rx;
1186 spin_lock_init(&rx->lock);
1187 mutex_init(&rx->setup_mutex);
1188 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
1189 rx->usb_packet_size = 512;
1191 rx->usb_packet_size = 64;
1193 ZD_ASSERT(rx->fragment_length == 0);
1194 INIT_DELAYED_WORK(&rx->idle_work, zd_rx_idle_timer_handler);
1195 rx->reset_timer_tasklet.func = zd_usb_reset_rx_idle_timer_tasklet;
1196 rx->reset_timer_tasklet.data = (unsigned long)usb;
1199 static inline void init_usb_tx(struct zd_usb *usb)
1201 struct zd_usb_tx *tx = &usb->tx;
1203 spin_lock_init(&tx->lock);
1204 atomic_set(&tx->enabled, 0);
1206 skb_queue_head_init(&tx->submitted_skbs);
1207 init_usb_anchor(&tx->submitted);
1208 tx->submitted_urbs = 0;
1209 tx->watchdog_enabled = 0;
1210 INIT_DELAYED_WORK(&tx->watchdog_work, zd_tx_watchdog_handler);
1213 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
1214 struct usb_interface *intf)
1216 memset(usb, 0, sizeof(*usb));
1217 usb->intf = usb_get_intf(intf);
1218 usb_set_intfdata(usb->intf, hw);
1219 init_usb_anchor(&usb->submitted_cmds);
1220 init_usb_interrupt(usb);
1225 void zd_usb_clear(struct zd_usb *usb)
1227 usb_set_intfdata(usb->intf, NULL);
1228 usb_put_intf(usb->intf);
1229 ZD_MEMCLEAR(usb, sizeof(*usb));
1230 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
1233 static const char *speed(enum usb_device_speed speed)
1238 case USB_SPEED_FULL:
1240 case USB_SPEED_HIGH:
1243 return "unknown speed";
1247 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
1249 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
1250 le16_to_cpu(udev->descriptor.idVendor),
1251 le16_to_cpu(udev->descriptor.idProduct),
1252 get_bcdDevice(udev),
1253 speed(udev->speed));
1256 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
1258 struct usb_device *udev = interface_to_usbdev(usb->intf);
1259 return scnprint_id(udev, buffer, size);
1263 static void print_id(struct usb_device *udev)
1267 scnprint_id(udev, buffer, sizeof(buffer));
1268 buffer[sizeof(buffer)-1] = 0;
1269 dev_dbg_f(&udev->dev, "%s\n", buffer);
1272 #define print_id(udev) do { } while (0)
1275 static int eject_installer(struct usb_interface *intf)
1277 struct usb_device *udev = interface_to_usbdev(intf);
1278 struct usb_host_interface *iface_desc = &intf->altsetting[0];
1279 struct usb_endpoint_descriptor *endpoint;
1284 if (iface_desc->desc.bNumEndpoints < 2)
1287 /* Find bulk out endpoint */
1288 for (r = 1; r >= 0; r--) {
1289 endpoint = &iface_desc->endpoint[r].desc;
1290 if (usb_endpoint_dir_out(endpoint) &&
1291 usb_endpoint_xfer_bulk(endpoint)) {
1292 bulk_out_ep = endpoint->bEndpointAddress;
1298 "zd1211rw: Could not find bulk out endpoint\n");
1302 cmd = kzalloc(31, GFP_KERNEL);
1306 /* USB bulk command block */
1307 cmd[0] = 0x55; /* bulk command signature */
1308 cmd[1] = 0x53; /* bulk command signature */
1309 cmd[2] = 0x42; /* bulk command signature */
1310 cmd[3] = 0x43; /* bulk command signature */
1311 cmd[14] = 6; /* command length */
1313 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
1314 cmd[19] = 0x2; /* eject disc */
1316 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
1317 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
1318 cmd, 31, NULL, 2000);
1323 /* At this point, the device disconnects and reconnects with the real
1326 usb_set_intfdata(intf, NULL);
1330 int zd_usb_init_hw(struct zd_usb *usb)
1333 struct zd_mac *mac = zd_usb_to_mac(usb);
1335 dev_dbg_f(zd_usb_dev(usb), "\n");
1337 r = upload_firmware(usb);
1339 dev_err(zd_usb_dev(usb),
1340 "couldn't load firmware. Error number %d\n", r);
1344 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
1346 dev_dbg_f(zd_usb_dev(usb),
1347 "couldn't reset configuration. Error number %d\n", r);
1351 r = zd_mac_init_hw(mac->hw);
1353 dev_dbg_f(zd_usb_dev(usb),
1354 "couldn't initialize mac. Error number %d\n", r);
1358 usb->initialized = 1;
1362 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
1365 struct usb_device *udev = interface_to_usbdev(intf);
1367 struct ieee80211_hw *hw = NULL;
1371 if (id->driver_info & DEVICE_INSTALLER)
1372 return eject_installer(intf);
1374 switch (udev->speed) {
1376 case USB_SPEED_FULL:
1377 case USB_SPEED_HIGH:
1380 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1385 r = usb_reset_device(udev);
1388 "couldn't reset usb device. Error number %d\n", r);
1392 hw = zd_mac_alloc_hw(intf);
1398 usb = &zd_hw_mac(hw)->chip.usb;
1399 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1401 r = zd_mac_preinit_hw(hw);
1403 dev_dbg_f(&intf->dev,
1404 "couldn't initialize mac. Error number %d\n", r);
1408 r = ieee80211_register_hw(hw);
1410 dev_dbg_f(&intf->dev,
1411 "couldn't register device. Error number %d\n", r);
1415 dev_dbg_f(&intf->dev, "successful\n");
1416 dev_info(&intf->dev, "%s\n", wiphy_name(hw->wiphy));
1419 usb_reset_device(interface_to_usbdev(intf));
1421 zd_mac_clear(zd_hw_mac(hw));
1422 ieee80211_free_hw(hw);
1427 static void disconnect(struct usb_interface *intf)
1429 struct ieee80211_hw *hw = zd_intf_to_hw(intf);
1433 /* Either something really bad happened, or we're just dealing with
1434 * a DEVICE_INSTALLER. */
1438 mac = zd_hw_mac(hw);
1439 usb = &mac->chip.usb;
1441 dev_dbg_f(zd_usb_dev(usb), "\n");
1443 ieee80211_unregister_hw(hw);
1445 /* Just in case something has gone wrong! */
1446 zd_usb_disable_tx(usb);
1447 zd_usb_disable_rx(usb);
1448 zd_usb_disable_int(usb);
1450 /* If the disconnect has been caused by a removal of the
1451 * driver module, the reset allows reloading of the driver. If the
1452 * reset will not be executed here, the upload of the firmware in the
1453 * probe function caused by the reloading of the driver will fail.
1455 usb_reset_device(interface_to_usbdev(intf));
1458 ieee80211_free_hw(hw);
1459 dev_dbg(&intf->dev, "disconnected\n");
1462 static void zd_usb_resume(struct zd_usb *usb)
1464 struct zd_mac *mac = zd_usb_to_mac(usb);
1467 dev_dbg_f(zd_usb_dev(usb), "\n");
1469 r = zd_op_start(zd_usb_to_hw(usb));
1471 dev_warn(zd_usb_dev(usb), "Device resume failed "
1472 "with error code %d. Retrying...\n", r);
1473 if (usb->was_running)
1474 set_bit(ZD_DEVICE_RUNNING, &mac->flags);
1475 usb_queue_reset_device(usb->intf);
1479 if (mac->type != NL80211_IFTYPE_UNSPECIFIED) {
1480 r = zd_restore_settings(mac);
1482 dev_dbg(zd_usb_dev(usb),
1483 "failed to restore settings, %d\n", r);
1489 static void zd_usb_stop(struct zd_usb *usb)
1491 dev_dbg_f(zd_usb_dev(usb), "\n");
1493 zd_op_stop(zd_usb_to_hw(usb));
1495 zd_usb_disable_tx(usb);
1496 zd_usb_disable_rx(usb);
1497 zd_usb_disable_int(usb);
1499 usb->initialized = 0;
1502 static int pre_reset(struct usb_interface *intf)
1504 struct ieee80211_hw *hw = usb_get_intfdata(intf);
1508 if (!hw || intf->condition != USB_INTERFACE_BOUND)
1511 mac = zd_hw_mac(hw);
1512 usb = &mac->chip.usb;
1514 usb->was_running = test_bit(ZD_DEVICE_RUNNING, &mac->flags);
1518 mutex_lock(&mac->chip.mutex);
1522 static int post_reset(struct usb_interface *intf)
1524 struct ieee80211_hw *hw = usb_get_intfdata(intf);
1528 if (!hw || intf->condition != USB_INTERFACE_BOUND)
1531 mac = zd_hw_mac(hw);
1532 usb = &mac->chip.usb;
1534 mutex_unlock(&mac->chip.mutex);
1536 if (usb->was_running)
1541 static struct usb_driver driver = {
1542 .name = KBUILD_MODNAME,
1543 .id_table = usb_ids,
1545 .disconnect = disconnect,
1546 .pre_reset = pre_reset,
1547 .post_reset = post_reset,
1548 .disable_hub_initiated_lpm = 1,
1551 struct workqueue_struct *zd_workqueue;
1553 static int __init usb_init(void)
1557 pr_debug("%s usb_init()\n", driver.name);
1559 zd_workqueue = create_singlethread_workqueue(driver.name);
1560 if (zd_workqueue == NULL) {
1561 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1565 r = usb_register(&driver);
1567 destroy_workqueue(zd_workqueue);
1568 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1573 pr_debug("%s initialized\n", driver.name);
1577 static void __exit usb_exit(void)
1579 pr_debug("%s usb_exit()\n", driver.name);
1580 usb_deregister(&driver);
1581 destroy_workqueue(zd_workqueue);
1584 module_init(usb_init);
1585 module_exit(usb_exit);
1587 static int zd_ep_regs_out_msg(struct usb_device *udev, void *data, int len,
1588 int *actual_length, int timeout)
1590 /* In USB 2.0 mode EP_REGS_OUT endpoint is interrupt type. However in
1591 * USB 1.1 mode endpoint is bulk. Select correct type URB by endpoint
1594 struct usb_host_endpoint *ep;
1597 pipe = usb_sndintpipe(udev, EP_REGS_OUT);
1598 ep = usb_pipe_endpoint(udev, pipe);
1602 if (usb_endpoint_xfer_int(&ep->desc)) {
1603 return usb_interrupt_msg(udev, pipe, data, len,
1604 actual_length, timeout);
1606 pipe = usb_sndbulkpipe(udev, EP_REGS_OUT);
1607 return usb_bulk_msg(udev, pipe, data, len, actual_length,
1612 static int usb_int_regs_length(unsigned int count)
1614 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1617 static void prepare_read_regs_int(struct zd_usb *usb,
1618 struct usb_req_read_regs *req,
1621 struct zd_usb_interrupt *intr = &usb->intr;
1623 spin_lock_irq(&intr->lock);
1624 atomic_set(&intr->read_regs_enabled, 1);
1625 intr->read_regs.req = req;
1626 intr->read_regs.req_count = count;
1627 reinit_completion(&intr->read_regs.completion);
1628 spin_unlock_irq(&intr->lock);
1631 static void disable_read_regs_int(struct zd_usb *usb)
1633 struct zd_usb_interrupt *intr = &usb->intr;
1635 spin_lock_irq(&intr->lock);
1636 atomic_set(&intr->read_regs_enabled, 0);
1637 spin_unlock_irq(&intr->lock);
1640 static bool check_read_regs(struct zd_usb *usb, struct usb_req_read_regs *req,
1644 struct zd_usb_interrupt *intr = &usb->intr;
1645 struct read_regs_int *rr = &intr->read_regs;
1646 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1648 /* The created block size seems to be larger than expected.
1649 * However results appear to be correct.
1651 if (rr->length < usb_int_regs_length(count)) {
1652 dev_dbg_f(zd_usb_dev(usb),
1653 "error: actual length %d less than expected %d\n",
1654 rr->length, usb_int_regs_length(count));
1658 if (rr->length > sizeof(rr->buffer)) {
1659 dev_dbg_f(zd_usb_dev(usb),
1660 "error: actual length %d exceeds buffer size %zu\n",
1661 rr->length, sizeof(rr->buffer));
1665 for (i = 0; i < count; i++) {
1666 struct reg_data *rd = ®s->regs[i];
1667 if (rd->addr != req->addr[i]) {
1668 dev_dbg_f(zd_usb_dev(usb),
1669 "rd[%d] addr %#06hx expected %#06hx\n", i,
1670 le16_to_cpu(rd->addr),
1671 le16_to_cpu(req->addr[i]));
1679 static int get_results(struct zd_usb *usb, u16 *values,
1680 struct usb_req_read_regs *req, unsigned int count,
1685 struct zd_usb_interrupt *intr = &usb->intr;
1686 struct read_regs_int *rr = &intr->read_regs;
1687 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1689 spin_lock_irq(&intr->lock);
1693 /* Read failed because firmware bug? */
1694 *retry = !!intr->read_regs_int_overridden;
1698 if (!check_read_regs(usb, req, count)) {
1699 dev_dbg_f(zd_usb_dev(usb), "error: invalid read regs\n");
1703 for (i = 0; i < count; i++) {
1704 struct reg_data *rd = ®s->regs[i];
1705 values[i] = le16_to_cpu(rd->value);
1710 spin_unlock_irq(&intr->lock);
1714 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1715 const zd_addr_t *addresses, unsigned int count)
1717 int r, i, req_len, actual_req_len, try_count = 0;
1718 struct usb_device *udev;
1719 struct usb_req_read_regs *req = NULL;
1720 unsigned long timeout;
1724 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1727 if (count > USB_MAX_IOREAD16_COUNT) {
1728 dev_dbg_f(zd_usb_dev(usb),
1729 "error: count %u exceeds possible max %u\n",
1730 count, USB_MAX_IOREAD16_COUNT);
1734 dev_dbg_f(zd_usb_dev(usb),
1735 "error: io in atomic context not supported\n");
1736 return -EWOULDBLOCK;
1738 if (!usb_int_enabled(usb)) {
1739 dev_dbg_f(zd_usb_dev(usb),
1740 "error: usb interrupt not enabled\n");
1741 return -EWOULDBLOCK;
1744 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1745 BUILD_BUG_ON(sizeof(struct usb_req_read_regs) + USB_MAX_IOREAD16_COUNT *
1746 sizeof(__le16) > sizeof(usb->req_buf));
1747 BUG_ON(sizeof(struct usb_req_read_regs) + count * sizeof(__le16) >
1748 sizeof(usb->req_buf));
1750 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1751 req = (void *)usb->req_buf;
1753 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1754 for (i = 0; i < count; i++)
1755 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1759 udev = zd_usb_to_usbdev(usb);
1760 prepare_read_regs_int(usb, req, count);
1761 r = zd_ep_regs_out_msg(udev, req, req_len, &actual_req_len, 50 /*ms*/);
1763 dev_dbg_f(zd_usb_dev(usb),
1764 "error in zd_ep_regs_out_msg(). Error number %d\n", r);
1767 if (req_len != actual_req_len) {
1768 dev_dbg_f(zd_usb_dev(usb), "error in zd_ep_regs_out_msg()\n"
1769 " req_len %d != actual_req_len %d\n",
1770 req_len, actual_req_len);
1775 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1776 msecs_to_jiffies(50));
1778 disable_read_regs_int(usb);
1779 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1784 r = get_results(usb, values, req, count, &retry);
1785 if (retry && try_count < 20) {
1786 dev_dbg_f(zd_usb_dev(usb), "read retry, tries so far: %d\n",
1794 static void iowrite16v_urb_complete(struct urb *urb)
1796 struct zd_usb *usb = urb->context;
1798 if (urb->status && !usb->cmd_error)
1799 usb->cmd_error = urb->status;
1801 if (!usb->cmd_error &&
1802 urb->actual_length != urb->transfer_buffer_length)
1803 usb->cmd_error = -EIO;
1806 static int zd_submit_waiting_urb(struct zd_usb *usb, bool last)
1809 struct urb *urb = usb->urb_async_waiting;
1814 usb->urb_async_waiting = NULL;
1817 urb->transfer_flags |= URB_NO_INTERRUPT;
1819 usb_anchor_urb(urb, &usb->submitted_cmds);
1820 r = usb_submit_urb(urb, GFP_KERNEL);
1822 usb_unanchor_urb(urb);
1823 dev_dbg_f(zd_usb_dev(usb),
1824 "error in usb_submit_urb(). Error number %d\n", r);
1828 /* fall-through with r == 0 */
1834 void zd_usb_iowrite16v_async_start(struct zd_usb *usb)
1836 ZD_ASSERT(usb_anchor_empty(&usb->submitted_cmds));
1837 ZD_ASSERT(usb->urb_async_waiting == NULL);
1838 ZD_ASSERT(!usb->in_async);
1840 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1844 usb->urb_async_waiting = NULL;
1847 int zd_usb_iowrite16v_async_end(struct zd_usb *usb, unsigned int timeout)
1851 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1852 ZD_ASSERT(usb->in_async);
1854 /* Submit last iowrite16v URB */
1855 r = zd_submit_waiting_urb(usb, true);
1857 dev_dbg_f(zd_usb_dev(usb),
1858 "error in zd_submit_waiting_usb(). "
1859 "Error number %d\n", r);
1861 usb_kill_anchored_urbs(&usb->submitted_cmds);
1866 timeout = usb_wait_anchor_empty_timeout(&usb->submitted_cmds,
1869 usb_kill_anchored_urbs(&usb->submitted_cmds);
1870 if (usb->cmd_error == -ENOENT) {
1871 dev_dbg_f(zd_usb_dev(usb), "timed out");
1883 int zd_usb_iowrite16v_async(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1887 struct usb_device *udev;
1888 struct usb_req_write_regs *req = NULL;
1891 struct usb_host_endpoint *ep;
1893 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
1894 ZD_ASSERT(usb->in_async);
1898 if (count > USB_MAX_IOWRITE16_COUNT) {
1899 dev_dbg_f(zd_usb_dev(usb),
1900 "error: count %u exceeds possible max %u\n",
1901 count, USB_MAX_IOWRITE16_COUNT);
1905 dev_dbg_f(zd_usb_dev(usb),
1906 "error: io in atomic context not supported\n");
1907 return -EWOULDBLOCK;
1910 udev = zd_usb_to_usbdev(usb);
1912 ep = usb_pipe_endpoint(udev, usb_sndintpipe(udev, EP_REGS_OUT));
1916 urb = usb_alloc_urb(0, GFP_KERNEL);
1920 req_len = struct_size(req, reg_writes, count);
1921 req = kmalloc(req_len, GFP_KERNEL);
1927 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1928 for (i = 0; i < count; i++) {
1929 struct reg_data *rw = &req->reg_writes[i];
1930 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1931 rw->value = cpu_to_le16(ioreqs[i].value);
1934 /* In USB 2.0 mode endpoint is interrupt type. However in USB 1.1 mode
1935 * endpoint is bulk. Select correct type URB by endpoint descriptor.
1937 if (usb_endpoint_xfer_int(&ep->desc))
1938 usb_fill_int_urb(urb, udev, usb_sndintpipe(udev, EP_REGS_OUT),
1939 req, req_len, iowrite16v_urb_complete, usb,
1940 ep->desc.bInterval);
1942 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1943 req, req_len, iowrite16v_urb_complete, usb);
1945 urb->transfer_flags |= URB_FREE_BUFFER;
1947 /* Submit previous URB */
1948 r = zd_submit_waiting_urb(usb, false);
1950 dev_dbg_f(zd_usb_dev(usb),
1951 "error in zd_submit_waiting_usb(). "
1952 "Error number %d\n", r);
1956 /* Delay submit so that URB_NO_INTERRUPT flag can be set for all URBs
1957 * of currect batch except for very last.
1959 usb->urb_async_waiting = urb;
1966 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1971 zd_usb_iowrite16v_async_start(usb);
1972 r = zd_usb_iowrite16v_async(usb, ioreqs, count);
1974 zd_usb_iowrite16v_async_end(usb, 0);
1977 return zd_usb_iowrite16v_async_end(usb, 50 /* ms */);
1980 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1983 struct usb_device *udev;
1984 struct usb_req_rfwrite *req = NULL;
1985 int i, req_len, actual_req_len;
1986 u16 bit_value_template;
1989 dev_dbg_f(zd_usb_dev(usb),
1990 "error: io in atomic context not supported\n");
1991 return -EWOULDBLOCK;
1993 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1994 dev_dbg_f(zd_usb_dev(usb),
1995 "error: bits %d are smaller than"
1996 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1997 bits, USB_MIN_RFWRITE_BIT_COUNT);
2000 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
2001 dev_dbg_f(zd_usb_dev(usb),
2002 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
2003 bits, USB_MAX_RFWRITE_BIT_COUNT);
2007 if (value & (~0UL << bits)) {
2008 dev_dbg_f(zd_usb_dev(usb),
2009 "error: value %#09x has bits >= %d set\n",
2015 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
2017 r = zd_usb_ioread16(usb, &bit_value_template, ZD_CR203);
2019 dev_dbg_f(zd_usb_dev(usb),
2020 "error %d: Couldn't read ZD_CR203\n", r);
2023 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
2025 ZD_ASSERT(mutex_is_locked(&zd_usb_to_chip(usb)->mutex));
2026 BUILD_BUG_ON(sizeof(struct usb_req_rfwrite) +
2027 USB_MAX_RFWRITE_BIT_COUNT * sizeof(__le16) >
2028 sizeof(usb->req_buf));
2029 BUG_ON(sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16) >
2030 sizeof(usb->req_buf));
2032 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
2033 req = (void *)usb->req_buf;
2035 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
2036 /* 1: 3683a, but not used in ZYDAS driver */
2037 req->value = cpu_to_le16(2);
2038 req->bits = cpu_to_le16(bits);
2040 for (i = 0; i < bits; i++) {
2041 u16 bv = bit_value_template;
2042 if (value & (1 << (bits-1-i)))
2044 req->bit_values[i] = cpu_to_le16(bv);
2047 udev = zd_usb_to_usbdev(usb);
2048 r = zd_ep_regs_out_msg(udev, req, req_len, &actual_req_len, 50 /*ms*/);
2050 dev_dbg_f(zd_usb_dev(usb),
2051 "error in zd_ep_regs_out_msg(). Error number %d\n", r);
2054 if (req_len != actual_req_len) {
2055 dev_dbg_f(zd_usb_dev(usb), "error in zd_ep_regs_out_msg()"
2056 " req_len %d != actual_req_len %d\n",
2057 req_len, actual_req_len);
2062 /* FALL-THROUGH with r == 0 */