3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/firmware.h>
22 #include <linux/device.h>
23 #include <linux/errno.h>
24 #include <linux/skbuff.h>
25 #include <linux/usb.h>
26 #include <linux/workqueue.h>
27 #include <net/ieee80211.h>
28 #include <asm/unaligned.h>
31 #include "zd_netdev.h"
36 static struct usb_device_id usb_ids[] = {
38 { USB_DEVICE(0x0ace, 0x1211), .driver_info = DEVICE_ZD1211 },
39 { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211 },
40 { USB_DEVICE(0x126f, 0xa006), .driver_info = DEVICE_ZD1211 },
41 { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
42 { USB_DEVICE(0x0df6, 0x9071), .driver_info = DEVICE_ZD1211 },
43 { USB_DEVICE(0x0df6, 0x9075), .driver_info = DEVICE_ZD1211 },
44 { USB_DEVICE(0x157e, 0x300b), .driver_info = DEVICE_ZD1211 },
45 { USB_DEVICE(0x079b, 0x004a), .driver_info = DEVICE_ZD1211 },
46 { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
47 { USB_DEVICE(0x157e, 0x3204), .driver_info = DEVICE_ZD1211 },
48 { USB_DEVICE(0x0586, 0x3402), .driver_info = DEVICE_ZD1211 },
49 { USB_DEVICE(0x0b3b, 0x5630), .driver_info = DEVICE_ZD1211 },
50 { USB_DEVICE(0x0b05, 0x170c), .driver_info = DEVICE_ZD1211 },
51 { USB_DEVICE(0x1435, 0x0711), .driver_info = DEVICE_ZD1211 },
52 { USB_DEVICE(0x0586, 0x3409), .driver_info = DEVICE_ZD1211 },
53 { USB_DEVICE(0x0b3b, 0x1630), .driver_info = DEVICE_ZD1211 },
54 { USB_DEVICE(0x0586, 0x3401), .driver_info = DEVICE_ZD1211 },
55 { USB_DEVICE(0x14ea, 0xab13), .driver_info = DEVICE_ZD1211 },
56 { USB_DEVICE(0x13b1, 0x001e), .driver_info = DEVICE_ZD1211 },
57 { USB_DEVICE(0x0586, 0x3407), .driver_info = DEVICE_ZD1211 },
59 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
60 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
61 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
62 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
63 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
64 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
65 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
66 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
73 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
74 { USB_DEVICE(0x0411, 0x00da), .driver_info = DEVICE_ZD1211B },
75 { USB_DEVICE(0x2019, 0x5303), .driver_info = DEVICE_ZD1211B },
76 { USB_DEVICE(0x129b, 0x1667), .driver_info = DEVICE_ZD1211B },
77 { USB_DEVICE(0x0cde, 0x001a), .driver_info = DEVICE_ZD1211B },
78 /* "Driverless" devices that need ejecting */
79 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
80 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
84 MODULE_LICENSE("GPL");
85 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
86 MODULE_AUTHOR("Ulrich Kunitz");
87 MODULE_AUTHOR("Daniel Drake");
88 MODULE_VERSION("1.0");
89 MODULE_DEVICE_TABLE(usb, usb_ids);
91 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
92 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
94 /* USB device initialization */
96 static int request_fw_file(
97 const struct firmware **fw, const char *name, struct device *device)
101 dev_dbg_f(device, "fw name %s\n", name);
103 r = request_firmware(fw, name, device);
106 "Could not load firmware file %s. Error number %d\n",
111 static inline u16 get_bcdDevice(const struct usb_device *udev)
113 return le16_to_cpu(udev->descriptor.bcdDevice);
116 enum upload_code_flags {
120 /* Ensures that MAX_TRANSFER_SIZE is even. */
121 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
123 static int upload_code(struct usb_device *udev,
124 const u8 *data, size_t size, u16 code_offset, int flags)
129 /* USB request blocks need "kmalloced" buffers.
131 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
133 dev_err(&udev->dev, "out of memory\n");
140 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
141 size : MAX_TRANSFER_SIZE;
143 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
145 memcpy(p, data, transfer_size);
146 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
147 USB_REQ_FIRMWARE_DOWNLOAD,
148 USB_DIR_OUT | USB_TYPE_VENDOR,
149 code_offset, 0, p, transfer_size, 1000 /* ms */);
152 "USB control request for firmware upload"
153 " failed. Error number %d\n", r);
156 transfer_size = r & ~1;
158 size -= transfer_size;
159 data += transfer_size;
160 code_offset += transfer_size/sizeof(u16);
163 if (flags & REBOOT) {
166 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
167 USB_REQ_FIRMWARE_CONFIRM,
168 USB_DIR_IN | USB_TYPE_VENDOR,
169 0, 0, &ret, sizeof(ret), 5000 /* ms */);
170 if (r != sizeof(ret)) {
172 "control request firmeware confirmation failed."
173 " Return value %d\n", r);
180 "Internal error while downloading."
181 " Firmware confirm return value %#04x\n",
186 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
196 static u16 get_word(const void *data, u16 offset)
198 const __le16 *p = data;
199 return le16_to_cpu(p[offset]);
202 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
205 scnprintf(buffer, size, "%s%s",
207 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
212 static int handle_version_mismatch(struct zd_usb *usb,
213 const struct firmware *ub_fw)
215 struct usb_device *udev = zd_usb_to_usbdev(usb);
216 const struct firmware *ur_fw = NULL;
221 r = request_fw_file(&ur_fw,
222 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
227 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
231 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
232 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
233 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
235 /* At this point, the vendor driver downloads the whole firmware
236 * image, hacks around with version IDs, and uploads it again,
237 * completely overwriting the boot code. We do not do this here as
238 * it is not required on any tested devices, and it is suspected to
241 release_firmware(ur_fw);
245 static int upload_firmware(struct zd_usb *usb)
250 struct usb_device *udev = zd_usb_to_usbdev(usb);
251 const struct firmware *ub_fw = NULL;
252 const struct firmware *uph_fw = NULL;
255 bcdDevice = get_bcdDevice(udev);
257 r = request_fw_file(&ub_fw,
258 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
263 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
265 if (fw_bcdDevice != bcdDevice) {
267 "firmware version %#06x and device bootcode version "
268 "%#06x differ\n", fw_bcdDevice, bcdDevice);
269 if (bcdDevice <= 0x4313)
270 dev_warn(&udev->dev, "device has old bootcode, please "
271 "report success or failure\n");
273 r = handle_version_mismatch(usb, ub_fw);
277 dev_dbg_f(&udev->dev,
278 "firmware device id %#06x is equal to the "
279 "actual device id\n", fw_bcdDevice);
283 r = request_fw_file(&uph_fw,
284 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
289 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
292 "Could not upload firmware code uph. Error number %d\n",
298 release_firmware(ub_fw);
299 release_firmware(uph_fw);
303 /* Read data from device address space using "firmware interface" which does
304 * not require firmware to be loaded. */
305 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
308 struct usb_device *udev = zd_usb_to_usbdev(usb);
310 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
311 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
315 "read over firmware interface failed: %d\n", r);
317 } else if (r != len) {
319 "incomplete read over firmware interface: %d/%d\n",
327 #define urb_dev(urb) (&(urb)->dev->dev)
329 static inline void handle_regs_int(struct urb *urb)
331 struct zd_usb *usb = urb->context;
332 struct zd_usb_interrupt *intr = &usb->intr;
335 ZD_ASSERT(in_interrupt());
336 spin_lock(&intr->lock);
338 if (intr->read_regs_enabled) {
339 intr->read_regs.length = len = urb->actual_length;
341 if (len > sizeof(intr->read_regs.buffer))
342 len = sizeof(intr->read_regs.buffer);
343 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
344 intr->read_regs_enabled = 0;
345 complete(&intr->read_regs.completion);
349 dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
351 spin_unlock(&intr->lock);
354 static inline void handle_retry_failed_int(struct urb *urb)
356 struct zd_usb *usb = urb->context;
357 struct zd_mac *mac = zd_usb_to_mac(usb);
358 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
360 ieee->stats.tx_errors++;
361 ieee->ieee_stats.tx_retry_limit_exceeded++;
362 dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
366 static void int_urb_complete(struct urb *urb)
369 struct usb_int_header *hdr;
371 switch (urb->status) {
385 if (urb->actual_length < sizeof(hdr)) {
386 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
390 hdr = urb->transfer_buffer;
391 if (hdr->type != USB_INT_TYPE) {
392 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
397 case USB_INT_ID_REGS:
398 handle_regs_int(urb);
400 case USB_INT_ID_RETRY_FAILED:
401 handle_retry_failed_int(urb);
404 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
405 (unsigned int)hdr->id);
410 r = usb_submit_urb(urb, GFP_ATOMIC);
412 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
417 kfree(urb->transfer_buffer);
420 static inline int int_urb_interval(struct usb_device *udev)
422 switch (udev->speed) {
433 static inline int usb_int_enabled(struct zd_usb *usb)
436 struct zd_usb_interrupt *intr = &usb->intr;
439 spin_lock_irqsave(&intr->lock, flags);
441 spin_unlock_irqrestore(&intr->lock, flags);
445 int zd_usb_enable_int(struct zd_usb *usb)
448 struct usb_device *udev;
449 struct zd_usb_interrupt *intr = &usb->intr;
450 void *transfer_buffer = NULL;
453 dev_dbg_f(zd_usb_dev(usb), "\n");
455 urb = usb_alloc_urb(0, GFP_KERNEL);
461 ZD_ASSERT(!irqs_disabled());
462 spin_lock_irq(&intr->lock);
464 spin_unlock_irq(&intr->lock);
469 spin_unlock_irq(&intr->lock);
471 /* TODO: make it a DMA buffer */
473 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
474 if (!transfer_buffer) {
475 dev_dbg_f(zd_usb_dev(usb),
476 "couldn't allocate transfer_buffer\n");
477 goto error_set_urb_null;
480 udev = zd_usb_to_usbdev(usb);
481 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
482 transfer_buffer, USB_MAX_EP_INT_BUFFER,
483 int_urb_complete, usb,
486 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
487 r = usb_submit_urb(urb, GFP_KERNEL);
489 dev_dbg_f(zd_usb_dev(usb),
490 "Couldn't submit urb. Error number %d\n", r);
496 kfree(transfer_buffer);
498 spin_lock_irq(&intr->lock);
500 spin_unlock_irq(&intr->lock);
507 void zd_usb_disable_int(struct zd_usb *usb)
510 struct zd_usb_interrupt *intr = &usb->intr;
513 spin_lock_irqsave(&intr->lock, flags);
516 spin_unlock_irqrestore(&intr->lock, flags);
520 spin_unlock_irqrestore(&intr->lock, flags);
523 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
527 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
531 struct zd_mac *mac = zd_usb_to_mac(usb);
532 const struct rx_length_info *length_info;
534 if (length < sizeof(struct rx_length_info)) {
535 /* It's not a complete packet anyhow. */
536 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
537 ieee->stats.rx_errors++;
538 ieee->stats.rx_length_errors++;
541 length_info = (struct rx_length_info *)
542 (buffer + length - sizeof(struct rx_length_info));
544 /* It might be that three frames are merged into a single URB
545 * transaction. We have to check for the length info tag.
547 * While testing we discovered that length_info might be unaligned,
548 * because if USB transactions are merged, the last packet will not
549 * be padded. Unaligned access might also happen if the length_info
550 * structure is not present.
552 if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
554 unsigned int l, k, n;
555 for (i = 0, l = 0;; i++) {
556 k = le16_to_cpu(get_unaligned(&length_info->length[i]));
562 zd_mac_rx_irq(mac, buffer+l, k);
568 zd_mac_rx_irq(mac, buffer, length);
572 static void rx_urb_complete(struct urb *urb)
575 struct zd_usb_rx *rx;
579 switch (urb->status) {
590 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
594 buffer = urb->transfer_buffer;
595 length = urb->actual_length;
599 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
600 /* If there is an old first fragment, we don't care. */
601 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
602 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
603 spin_lock(&rx->lock);
604 memcpy(rx->fragment, buffer, length);
605 rx->fragment_length = length;
606 spin_unlock(&rx->lock);
610 spin_lock(&rx->lock);
611 if (rx->fragment_length > 0) {
612 /* We are on a second fragment, we believe */
613 ZD_ASSERT(length + rx->fragment_length <=
614 ARRAY_SIZE(rx->fragment));
615 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
616 memcpy(rx->fragment+rx->fragment_length, buffer, length);
617 handle_rx_packet(usb, rx->fragment,
618 rx->fragment_length + length);
619 rx->fragment_length = 0;
620 spin_unlock(&rx->lock);
622 spin_unlock(&rx->lock);
623 handle_rx_packet(usb, buffer, length);
627 usb_submit_urb(urb, GFP_ATOMIC);
630 static struct urb *alloc_urb(struct zd_usb *usb)
632 struct usb_device *udev = zd_usb_to_usbdev(usb);
636 urb = usb_alloc_urb(0, GFP_KERNEL);
639 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
646 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
647 buffer, USB_MAX_RX_SIZE,
648 rx_urb_complete, usb);
649 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
654 static void free_urb(struct urb *urb)
658 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
659 urb->transfer_buffer, urb->transfer_dma);
663 int zd_usb_enable_rx(struct zd_usb *usb)
666 struct zd_usb_rx *rx = &usb->rx;
669 dev_dbg_f(zd_usb_dev(usb), "\n");
672 urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
675 for (i = 0; i < URBS_COUNT; i++) {
676 urbs[i] = alloc_urb(usb);
681 ZD_ASSERT(!irqs_disabled());
682 spin_lock_irq(&rx->lock);
684 spin_unlock_irq(&rx->lock);
689 rx->urbs_count = URBS_COUNT;
690 spin_unlock_irq(&rx->lock);
692 for (i = 0; i < URBS_COUNT; i++) {
693 r = usb_submit_urb(urbs[i], GFP_KERNEL);
700 for (i = 0; i < URBS_COUNT; i++) {
701 usb_kill_urb(urbs[i]);
703 spin_lock_irq(&rx->lock);
706 spin_unlock_irq(&rx->lock);
709 for (i = 0; i < URBS_COUNT; i++)
715 void zd_usb_disable_rx(struct zd_usb *usb)
721 struct zd_usb_rx *rx = &usb->rx;
723 spin_lock_irqsave(&rx->lock, flags);
725 count = rx->urbs_count;
726 spin_unlock_irqrestore(&rx->lock, flags);
730 for (i = 0; i < count; i++) {
731 usb_kill_urb(urbs[i]);
736 spin_lock_irqsave(&rx->lock, flags);
739 spin_unlock_irqrestore(&rx->lock, flags);
742 static void tx_urb_complete(struct urb *urb)
746 switch (urb->status) {
755 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
758 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
762 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
763 urb->transfer_buffer, urb->transfer_dma);
767 r = usb_submit_urb(urb, GFP_ATOMIC);
769 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
774 /* Puts the frame on the USB endpoint. It doesn't wait for
775 * completion. The frame must contain the control set.
777 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
780 struct usb_device *udev = zd_usb_to_usbdev(usb);
784 urb = usb_alloc_urb(0, GFP_ATOMIC);
790 buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
796 memcpy(buffer, frame, length);
798 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
799 buffer, length, tx_urb_complete, NULL);
800 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
802 r = usb_submit_urb(urb, GFP_ATOMIC);
807 usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
815 static inline void init_usb_interrupt(struct zd_usb *usb)
817 struct zd_usb_interrupt *intr = &usb->intr;
819 spin_lock_init(&intr->lock);
820 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
821 init_completion(&intr->read_regs.completion);
822 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
825 static inline void init_usb_rx(struct zd_usb *usb)
827 struct zd_usb_rx *rx = &usb->rx;
828 spin_lock_init(&rx->lock);
829 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
830 rx->usb_packet_size = 512;
832 rx->usb_packet_size = 64;
834 ZD_ASSERT(rx->fragment_length == 0);
837 static inline void init_usb_tx(struct zd_usb *usb)
839 /* FIXME: at this point we will allocate a fixed number of urb's for
840 * use in a cyclic scheme */
843 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
844 struct usb_interface *intf)
846 memset(usb, 0, sizeof(*usb));
847 usb->intf = usb_get_intf(intf);
848 usb_set_intfdata(usb->intf, netdev);
849 init_usb_interrupt(usb);
854 void zd_usb_clear(struct zd_usb *usb)
856 usb_set_intfdata(usb->intf, NULL);
857 usb_put_intf(usb->intf);
858 ZD_MEMCLEAR(usb, sizeof(*usb));
859 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
862 static const char *speed(enum usb_device_speed speed)
872 return "unknown speed";
876 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
878 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
879 le16_to_cpu(udev->descriptor.idVendor),
880 le16_to_cpu(udev->descriptor.idProduct),
885 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
887 struct usb_device *udev = interface_to_usbdev(usb->intf);
888 return scnprint_id(udev, buffer, size);
892 static void print_id(struct usb_device *udev)
896 scnprint_id(udev, buffer, sizeof(buffer));
897 buffer[sizeof(buffer)-1] = 0;
898 dev_dbg_f(&udev->dev, "%s\n", buffer);
901 #define print_id(udev) do { } while (0)
904 static int eject_installer(struct usb_interface *intf)
906 struct usb_device *udev = interface_to_usbdev(intf);
907 struct usb_host_interface *iface_desc = &intf->altsetting[0];
908 struct usb_endpoint_descriptor *endpoint;
913 /* Find bulk out endpoint */
914 endpoint = &iface_desc->endpoint[1].desc;
915 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
916 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
917 USB_ENDPOINT_XFER_BULK) {
918 bulk_out_ep = endpoint->bEndpointAddress;
921 "zd1211rw: Could not find bulk out endpoint\n");
925 cmd = kzalloc(31, GFP_KERNEL);
929 /* USB bulk command block */
930 cmd[0] = 0x55; /* bulk command signature */
931 cmd[1] = 0x53; /* bulk command signature */
932 cmd[2] = 0x42; /* bulk command signature */
933 cmd[3] = 0x43; /* bulk command signature */
934 cmd[14] = 6; /* command length */
936 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
937 cmd[19] = 0x2; /* eject disc */
939 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
940 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
941 cmd, 31, NULL, 2000);
946 /* At this point, the device disconnects and reconnects with the real
949 usb_set_intfdata(intf, NULL);
953 int zd_usb_init_hw(struct zd_usb *usb)
956 struct zd_mac *mac = zd_usb_to_mac(usb);
958 dev_dbg_f(zd_usb_dev(usb), "\n");
960 r = upload_firmware(usb);
962 dev_err(zd_usb_dev(usb),
963 "couldn't load firmware. Error number %d\n", r);
967 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
969 dev_dbg_f(zd_usb_dev(usb),
970 "couldn't reset configuration. Error number %d\n", r);
974 r = zd_mac_init_hw(mac);
976 dev_dbg_f(zd_usb_dev(usb),
977 "couldn't initialize mac. Error number %d\n", r);
981 usb->initialized = 1;
985 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
989 struct usb_device *udev = interface_to_usbdev(intf);
990 struct net_device *netdev = NULL;
994 if (id->driver_info & DEVICE_INSTALLER)
995 return eject_installer(intf);
997 switch (udev->speed) {
1000 case USB_SPEED_HIGH:
1003 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1008 usb_reset_device(interface_to_usbdev(intf));
1010 netdev = zd_netdev_alloc(intf);
1011 if (netdev == NULL) {
1016 usb = &zd_netdev_mac(netdev)->chip.usb;
1017 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1019 r = zd_mac_preinit_hw(zd_netdev_mac(netdev));
1021 dev_dbg_f(&intf->dev,
1022 "couldn't initialize mac. Error number %d\n", r);
1026 r = register_netdev(netdev);
1028 dev_dbg_f(&intf->dev,
1029 "couldn't register netdev. Error number %d\n", r);
1033 dev_dbg_f(&intf->dev, "successful\n");
1034 dev_info(&intf->dev,"%s\n", netdev->name);
1037 usb_reset_device(interface_to_usbdev(intf));
1038 zd_netdev_free(netdev);
1042 static void disconnect(struct usb_interface *intf)
1044 struct net_device *netdev = zd_intf_to_netdev(intf);
1045 struct zd_mac *mac = zd_netdev_mac(netdev);
1046 struct zd_usb *usb = &mac->chip.usb;
1048 /* Either something really bad happened, or we're just dealing with
1049 * a DEVICE_INSTALLER. */
1053 dev_dbg_f(zd_usb_dev(usb), "\n");
1055 zd_netdev_disconnect(netdev);
1057 /* Just in case something has gone wrong! */
1058 zd_usb_disable_rx(usb);
1059 zd_usb_disable_int(usb);
1061 /* If the disconnect has been caused by a removal of the
1062 * driver module, the reset allows reloading of the driver. If the
1063 * reset will not be executed here, the upload of the firmware in the
1064 * probe function caused by the reloading of the driver will fail.
1066 usb_reset_device(interface_to_usbdev(intf));
1068 zd_netdev_free(netdev);
1069 dev_dbg(&intf->dev, "disconnected\n");
1072 static struct usb_driver driver = {
1074 .id_table = usb_ids,
1076 .disconnect = disconnect,
1079 struct workqueue_struct *zd_workqueue;
1081 static int __init usb_init(void)
1085 pr_debug("%s usb_init()\n", driver.name);
1087 zd_workqueue = create_singlethread_workqueue(driver.name);
1088 if (zd_workqueue == NULL) {
1089 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1093 r = usb_register(&driver);
1095 destroy_workqueue(zd_workqueue);
1096 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1101 pr_debug("%s initialized\n", driver.name);
1105 static void __exit usb_exit(void)
1107 pr_debug("%s usb_exit()\n", driver.name);
1108 usb_deregister(&driver);
1109 destroy_workqueue(zd_workqueue);
1112 module_init(usb_init);
1113 module_exit(usb_exit);
1115 static int usb_int_regs_length(unsigned int count)
1117 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1120 static void prepare_read_regs_int(struct zd_usb *usb)
1122 struct zd_usb_interrupt *intr = &usb->intr;
1124 spin_lock_irq(&intr->lock);
1125 intr->read_regs_enabled = 1;
1126 INIT_COMPLETION(intr->read_regs.completion);
1127 spin_unlock_irq(&intr->lock);
1130 static void disable_read_regs_int(struct zd_usb *usb)
1132 struct zd_usb_interrupt *intr = &usb->intr;
1134 spin_lock_irq(&intr->lock);
1135 intr->read_regs_enabled = 0;
1136 spin_unlock_irq(&intr->lock);
1139 static int get_results(struct zd_usb *usb, u16 *values,
1140 struct usb_req_read_regs *req, unsigned int count)
1144 struct zd_usb_interrupt *intr = &usb->intr;
1145 struct read_regs_int *rr = &intr->read_regs;
1146 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1148 spin_lock_irq(&intr->lock);
1151 /* The created block size seems to be larger than expected.
1152 * However results appear to be correct.
1154 if (rr->length < usb_int_regs_length(count)) {
1155 dev_dbg_f(zd_usb_dev(usb),
1156 "error: actual length %d less than expected %d\n",
1157 rr->length, usb_int_regs_length(count));
1160 if (rr->length > sizeof(rr->buffer)) {
1161 dev_dbg_f(zd_usb_dev(usb),
1162 "error: actual length %d exceeds buffer size %zu\n",
1163 rr->length, sizeof(rr->buffer));
1167 for (i = 0; i < count; i++) {
1168 struct reg_data *rd = ®s->regs[i];
1169 if (rd->addr != req->addr[i]) {
1170 dev_dbg_f(zd_usb_dev(usb),
1171 "rd[%d] addr %#06hx expected %#06hx\n", i,
1172 le16_to_cpu(rd->addr),
1173 le16_to_cpu(req->addr[i]));
1176 values[i] = le16_to_cpu(rd->value);
1181 spin_unlock_irq(&intr->lock);
1185 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1186 const zd_addr_t *addresses, unsigned int count)
1189 int i, req_len, actual_req_len;
1190 struct usb_device *udev;
1191 struct usb_req_read_regs *req = NULL;
1192 unsigned long timeout;
1195 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1198 if (count > USB_MAX_IOREAD16_COUNT) {
1199 dev_dbg_f(zd_usb_dev(usb),
1200 "error: count %u exceeds possible max %u\n",
1201 count, USB_MAX_IOREAD16_COUNT);
1205 dev_dbg_f(zd_usb_dev(usb),
1206 "error: io in atomic context not supported\n");
1207 return -EWOULDBLOCK;
1209 if (!usb_int_enabled(usb)) {
1210 dev_dbg_f(zd_usb_dev(usb),
1211 "error: usb interrupt not enabled\n");
1212 return -EWOULDBLOCK;
1215 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1216 req = kmalloc(req_len, GFP_KERNEL);
1219 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1220 for (i = 0; i < count; i++)
1221 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1223 udev = zd_usb_to_usbdev(usb);
1224 prepare_read_regs_int(usb);
1225 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1226 req, req_len, &actual_req_len, 1000 /* ms */);
1228 dev_dbg_f(zd_usb_dev(usb),
1229 "error in usb_bulk_msg(). Error number %d\n", r);
1232 if (req_len != actual_req_len) {
1233 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1234 " req_len %d != actual_req_len %d\n",
1235 req_len, actual_req_len);
1240 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1241 msecs_to_jiffies(1000));
1243 disable_read_regs_int(usb);
1244 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1249 r = get_results(usb, values, req, count);
1255 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1259 struct usb_device *udev;
1260 struct usb_req_write_regs *req = NULL;
1261 int i, req_len, actual_req_len;
1265 if (count > USB_MAX_IOWRITE16_COUNT) {
1266 dev_dbg_f(zd_usb_dev(usb),
1267 "error: count %u exceeds possible max %u\n",
1268 count, USB_MAX_IOWRITE16_COUNT);
1272 dev_dbg_f(zd_usb_dev(usb),
1273 "error: io in atomic context not supported\n");
1274 return -EWOULDBLOCK;
1277 req_len = sizeof(struct usb_req_write_regs) +
1278 count * sizeof(struct reg_data);
1279 req = kmalloc(req_len, GFP_KERNEL);
1283 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1284 for (i = 0; i < count; i++) {
1285 struct reg_data *rw = &req->reg_writes[i];
1286 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1287 rw->value = cpu_to_le16(ioreqs[i].value);
1290 udev = zd_usb_to_usbdev(usb);
1291 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1292 req, req_len, &actual_req_len, 1000 /* ms */);
1294 dev_dbg_f(zd_usb_dev(usb),
1295 "error in usb_bulk_msg(). Error number %d\n", r);
1298 if (req_len != actual_req_len) {
1299 dev_dbg_f(zd_usb_dev(usb),
1300 "error in usb_bulk_msg()"
1301 " req_len %d != actual_req_len %d\n",
1302 req_len, actual_req_len);
1307 /* FALL-THROUGH with r == 0 */
1313 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1316 struct usb_device *udev;
1317 struct usb_req_rfwrite *req = NULL;
1318 int i, req_len, actual_req_len;
1319 u16 bit_value_template;
1322 dev_dbg_f(zd_usb_dev(usb),
1323 "error: io in atomic context not supported\n");
1324 return -EWOULDBLOCK;
1326 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1327 dev_dbg_f(zd_usb_dev(usb),
1328 "error: bits %d are smaller than"
1329 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1330 bits, USB_MIN_RFWRITE_BIT_COUNT);
1333 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1334 dev_dbg_f(zd_usb_dev(usb),
1335 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1336 bits, USB_MAX_RFWRITE_BIT_COUNT);
1340 if (value & (~0UL << bits)) {
1341 dev_dbg_f(zd_usb_dev(usb),
1342 "error: value %#09x has bits >= %d set\n",
1348 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1350 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1352 dev_dbg_f(zd_usb_dev(usb),
1353 "error %d: Couldn't read CR203\n", r);
1356 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1358 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1359 req = kmalloc(req_len, GFP_KERNEL);
1363 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1364 /* 1: 3683a, but not used in ZYDAS driver */
1365 req->value = cpu_to_le16(2);
1366 req->bits = cpu_to_le16(bits);
1368 for (i = 0; i < bits; i++) {
1369 u16 bv = bit_value_template;
1370 if (value & (1 << (bits-1-i)))
1372 req->bit_values[i] = cpu_to_le16(bv);
1375 udev = zd_usb_to_usbdev(usb);
1376 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1377 req, req_len, &actual_req_len, 1000 /* ms */);
1379 dev_dbg_f(zd_usb_dev(usb),
1380 "error in usb_bulk_msg(). Error number %d\n", r);
1383 if (req_len != actual_req_len) {
1384 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1385 " req_len %d != actual_req_len %d\n",
1386 req_len, actual_req_len);
1391 /* FALL-THROUGH with r == 0 */