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 /* "Driverless" devices that need ejecting */
78 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
79 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
83 MODULE_LICENSE("GPL");
84 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
85 MODULE_AUTHOR("Ulrich Kunitz");
86 MODULE_AUTHOR("Daniel Drake");
87 MODULE_VERSION("1.0");
88 MODULE_DEVICE_TABLE(usb, usb_ids);
90 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
91 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
93 /* USB device initialization */
95 static int request_fw_file(
96 const struct firmware **fw, const char *name, struct device *device)
100 dev_dbg_f(device, "fw name %s\n", name);
102 r = request_firmware(fw, name, device);
105 "Could not load firmware file %s. Error number %d\n",
110 static inline u16 get_bcdDevice(const struct usb_device *udev)
112 return le16_to_cpu(udev->descriptor.bcdDevice);
115 enum upload_code_flags {
119 /* Ensures that MAX_TRANSFER_SIZE is even. */
120 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
122 static int upload_code(struct usb_device *udev,
123 const u8 *data, size_t size, u16 code_offset, int flags)
128 /* USB request blocks need "kmalloced" buffers.
130 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
132 dev_err(&udev->dev, "out of memory\n");
139 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
140 size : MAX_TRANSFER_SIZE;
142 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
144 memcpy(p, data, transfer_size);
145 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
146 USB_REQ_FIRMWARE_DOWNLOAD,
147 USB_DIR_OUT | USB_TYPE_VENDOR,
148 code_offset, 0, p, transfer_size, 1000 /* ms */);
151 "USB control request for firmware upload"
152 " failed. Error number %d\n", r);
155 transfer_size = r & ~1;
157 size -= transfer_size;
158 data += transfer_size;
159 code_offset += transfer_size/sizeof(u16);
162 if (flags & REBOOT) {
165 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
166 USB_REQ_FIRMWARE_CONFIRM,
167 USB_DIR_IN | USB_TYPE_VENDOR,
168 0, 0, &ret, sizeof(ret), 5000 /* ms */);
169 if (r != sizeof(ret)) {
171 "control request firmeware confirmation failed."
172 " Return value %d\n", r);
179 "Internal error while downloading."
180 " Firmware confirm return value %#04x\n",
185 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
195 static u16 get_word(const void *data, u16 offset)
197 const __le16 *p = data;
198 return le16_to_cpu(p[offset]);
201 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
204 scnprintf(buffer, size, "%s%s",
206 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
211 static int handle_version_mismatch(struct zd_usb *usb,
212 const struct firmware *ub_fw)
214 struct usb_device *udev = zd_usb_to_usbdev(usb);
215 const struct firmware *ur_fw = NULL;
220 r = request_fw_file(&ur_fw,
221 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
226 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
230 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
231 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
232 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
234 /* At this point, the vendor driver downloads the whole firmware
235 * image, hacks around with version IDs, and uploads it again,
236 * completely overwriting the boot code. We do not do this here as
237 * it is not required on any tested devices, and it is suspected to
240 release_firmware(ur_fw);
244 static int upload_firmware(struct zd_usb *usb)
249 struct usb_device *udev = zd_usb_to_usbdev(usb);
250 const struct firmware *ub_fw = NULL;
251 const struct firmware *uph_fw = NULL;
254 bcdDevice = get_bcdDevice(udev);
256 r = request_fw_file(&ub_fw,
257 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
262 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
264 if (fw_bcdDevice != bcdDevice) {
266 "firmware version %#06x and device bootcode version "
267 "%#06x differ\n", fw_bcdDevice, bcdDevice);
268 if (bcdDevice <= 0x4313)
269 dev_warn(&udev->dev, "device has old bootcode, please "
270 "report success or failure\n");
272 r = handle_version_mismatch(usb, ub_fw);
276 dev_dbg_f(&udev->dev,
277 "firmware device id %#06x is equal to the "
278 "actual device id\n", fw_bcdDevice);
282 r = request_fw_file(&uph_fw,
283 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
288 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
291 "Could not upload firmware code uph. Error number %d\n",
297 release_firmware(ub_fw);
298 release_firmware(uph_fw);
302 /* Read data from device address space using "firmware interface" which does
303 * not require firmware to be loaded. */
304 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
307 struct usb_device *udev = zd_usb_to_usbdev(usb);
309 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
310 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
314 "read over firmware interface failed: %d\n", r);
316 } else if (r != len) {
318 "incomplete read over firmware interface: %d/%d\n",
326 #define urb_dev(urb) (&(urb)->dev->dev)
328 static inline void handle_regs_int(struct urb *urb)
330 struct zd_usb *usb = urb->context;
331 struct zd_usb_interrupt *intr = &usb->intr;
334 ZD_ASSERT(in_interrupt());
335 spin_lock(&intr->lock);
337 if (intr->read_regs_enabled) {
338 intr->read_regs.length = len = urb->actual_length;
340 if (len > sizeof(intr->read_regs.buffer))
341 len = sizeof(intr->read_regs.buffer);
342 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
343 intr->read_regs_enabled = 0;
344 complete(&intr->read_regs.completion);
348 dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
350 spin_unlock(&intr->lock);
353 static inline void handle_retry_failed_int(struct urb *urb)
355 struct zd_usb *usb = urb->context;
356 struct zd_mac *mac = zd_usb_to_mac(usb);
357 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
359 ieee->stats.tx_errors++;
360 ieee->ieee_stats.tx_retry_limit_exceeded++;
361 dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
365 static void int_urb_complete(struct urb *urb)
368 struct usb_int_header *hdr;
370 switch (urb->status) {
384 if (urb->actual_length < sizeof(hdr)) {
385 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
389 hdr = urb->transfer_buffer;
390 if (hdr->type != USB_INT_TYPE) {
391 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
396 case USB_INT_ID_REGS:
397 handle_regs_int(urb);
399 case USB_INT_ID_RETRY_FAILED:
400 handle_retry_failed_int(urb);
403 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
404 (unsigned int)hdr->id);
409 r = usb_submit_urb(urb, GFP_ATOMIC);
411 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
416 kfree(urb->transfer_buffer);
419 static inline int int_urb_interval(struct usb_device *udev)
421 switch (udev->speed) {
432 static inline int usb_int_enabled(struct zd_usb *usb)
435 struct zd_usb_interrupt *intr = &usb->intr;
438 spin_lock_irqsave(&intr->lock, flags);
440 spin_unlock_irqrestore(&intr->lock, flags);
444 int zd_usb_enable_int(struct zd_usb *usb)
447 struct usb_device *udev;
448 struct zd_usb_interrupt *intr = &usb->intr;
449 void *transfer_buffer = NULL;
452 dev_dbg_f(zd_usb_dev(usb), "\n");
454 urb = usb_alloc_urb(0, GFP_KERNEL);
460 ZD_ASSERT(!irqs_disabled());
461 spin_lock_irq(&intr->lock);
463 spin_unlock_irq(&intr->lock);
468 spin_unlock_irq(&intr->lock);
470 /* TODO: make it a DMA buffer */
472 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
473 if (!transfer_buffer) {
474 dev_dbg_f(zd_usb_dev(usb),
475 "couldn't allocate transfer_buffer\n");
476 goto error_set_urb_null;
479 udev = zd_usb_to_usbdev(usb);
480 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
481 transfer_buffer, USB_MAX_EP_INT_BUFFER,
482 int_urb_complete, usb,
485 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
486 r = usb_submit_urb(urb, GFP_KERNEL);
488 dev_dbg_f(zd_usb_dev(usb),
489 "Couldn't submit urb. Error number %d\n", r);
495 kfree(transfer_buffer);
497 spin_lock_irq(&intr->lock);
499 spin_unlock_irq(&intr->lock);
506 void zd_usb_disable_int(struct zd_usb *usb)
509 struct zd_usb_interrupt *intr = &usb->intr;
512 spin_lock_irqsave(&intr->lock, flags);
515 spin_unlock_irqrestore(&intr->lock, flags);
519 spin_unlock_irqrestore(&intr->lock, flags);
522 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
526 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
530 struct zd_mac *mac = zd_usb_to_mac(usb);
531 const struct rx_length_info *length_info;
533 if (length < sizeof(struct rx_length_info)) {
534 /* It's not a complete packet anyhow. */
535 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
536 ieee->stats.rx_errors++;
537 ieee->stats.rx_length_errors++;
540 length_info = (struct rx_length_info *)
541 (buffer + length - sizeof(struct rx_length_info));
543 /* It might be that three frames are merged into a single URB
544 * transaction. We have to check for the length info tag.
546 * While testing we discovered that length_info might be unaligned,
547 * because if USB transactions are merged, the last packet will not
548 * be padded. Unaligned access might also happen if the length_info
549 * structure is not present.
551 if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
553 unsigned int l, k, n;
554 for (i = 0, l = 0;; i++) {
555 k = le16_to_cpu(get_unaligned(&length_info->length[i]));
561 zd_mac_rx_irq(mac, buffer+l, k);
567 zd_mac_rx_irq(mac, buffer, length);
571 static void rx_urb_complete(struct urb *urb)
574 struct zd_usb_rx *rx;
578 switch (urb->status) {
589 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
593 buffer = urb->transfer_buffer;
594 length = urb->actual_length;
598 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
599 /* If there is an old first fragment, we don't care. */
600 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
601 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
602 spin_lock(&rx->lock);
603 memcpy(rx->fragment, buffer, length);
604 rx->fragment_length = length;
605 spin_unlock(&rx->lock);
609 spin_lock(&rx->lock);
610 if (rx->fragment_length > 0) {
611 /* We are on a second fragment, we believe */
612 ZD_ASSERT(length + rx->fragment_length <=
613 ARRAY_SIZE(rx->fragment));
614 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
615 memcpy(rx->fragment+rx->fragment_length, buffer, length);
616 handle_rx_packet(usb, rx->fragment,
617 rx->fragment_length + length);
618 rx->fragment_length = 0;
619 spin_unlock(&rx->lock);
621 spin_unlock(&rx->lock);
622 handle_rx_packet(usb, buffer, length);
626 usb_submit_urb(urb, GFP_ATOMIC);
629 static struct urb *alloc_urb(struct zd_usb *usb)
631 struct usb_device *udev = zd_usb_to_usbdev(usb);
635 urb = usb_alloc_urb(0, GFP_KERNEL);
638 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
645 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
646 buffer, USB_MAX_RX_SIZE,
647 rx_urb_complete, usb);
648 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
653 static void free_urb(struct urb *urb)
657 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
658 urb->transfer_buffer, urb->transfer_dma);
662 int zd_usb_enable_rx(struct zd_usb *usb)
665 struct zd_usb_rx *rx = &usb->rx;
668 dev_dbg_f(zd_usb_dev(usb), "\n");
671 urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
674 for (i = 0; i < URBS_COUNT; i++) {
675 urbs[i] = alloc_urb(usb);
680 ZD_ASSERT(!irqs_disabled());
681 spin_lock_irq(&rx->lock);
683 spin_unlock_irq(&rx->lock);
688 rx->urbs_count = URBS_COUNT;
689 spin_unlock_irq(&rx->lock);
691 for (i = 0; i < URBS_COUNT; i++) {
692 r = usb_submit_urb(urbs[i], GFP_KERNEL);
699 for (i = 0; i < URBS_COUNT; i++) {
700 usb_kill_urb(urbs[i]);
702 spin_lock_irq(&rx->lock);
705 spin_unlock_irq(&rx->lock);
708 for (i = 0; i < URBS_COUNT; i++)
714 void zd_usb_disable_rx(struct zd_usb *usb)
720 struct zd_usb_rx *rx = &usb->rx;
722 spin_lock_irqsave(&rx->lock, flags);
724 count = rx->urbs_count;
725 spin_unlock_irqrestore(&rx->lock, flags);
729 for (i = 0; i < count; i++) {
730 usb_kill_urb(urbs[i]);
735 spin_lock_irqsave(&rx->lock, flags);
738 spin_unlock_irqrestore(&rx->lock, flags);
741 static void tx_urb_complete(struct urb *urb)
745 switch (urb->status) {
754 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
757 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
761 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
762 urb->transfer_buffer, urb->transfer_dma);
766 r = usb_submit_urb(urb, GFP_ATOMIC);
768 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
773 /* Puts the frame on the USB endpoint. It doesn't wait for
774 * completion. The frame must contain the control set.
776 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
779 struct usb_device *udev = zd_usb_to_usbdev(usb);
783 urb = usb_alloc_urb(0, GFP_ATOMIC);
789 buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
795 memcpy(buffer, frame, length);
797 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
798 buffer, length, tx_urb_complete, NULL);
799 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
801 r = usb_submit_urb(urb, GFP_ATOMIC);
806 usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
814 static inline void init_usb_interrupt(struct zd_usb *usb)
816 struct zd_usb_interrupt *intr = &usb->intr;
818 spin_lock_init(&intr->lock);
819 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
820 init_completion(&intr->read_regs.completion);
821 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
824 static inline void init_usb_rx(struct zd_usb *usb)
826 struct zd_usb_rx *rx = &usb->rx;
827 spin_lock_init(&rx->lock);
828 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
829 rx->usb_packet_size = 512;
831 rx->usb_packet_size = 64;
833 ZD_ASSERT(rx->fragment_length == 0);
836 static inline void init_usb_tx(struct zd_usb *usb)
838 /* FIXME: at this point we will allocate a fixed number of urb's for
839 * use in a cyclic scheme */
842 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
843 struct usb_interface *intf)
845 memset(usb, 0, sizeof(*usb));
846 usb->intf = usb_get_intf(intf);
847 usb_set_intfdata(usb->intf, netdev);
848 init_usb_interrupt(usb);
853 void zd_usb_clear(struct zd_usb *usb)
855 usb_set_intfdata(usb->intf, NULL);
856 usb_put_intf(usb->intf);
857 ZD_MEMCLEAR(usb, sizeof(*usb));
858 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
861 static const char *speed(enum usb_device_speed speed)
871 return "unknown speed";
875 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
877 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
878 le16_to_cpu(udev->descriptor.idVendor),
879 le16_to_cpu(udev->descriptor.idProduct),
884 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
886 struct usb_device *udev = interface_to_usbdev(usb->intf);
887 return scnprint_id(udev, buffer, size);
891 static void print_id(struct usb_device *udev)
895 scnprint_id(udev, buffer, sizeof(buffer));
896 buffer[sizeof(buffer)-1] = 0;
897 dev_dbg_f(&udev->dev, "%s\n", buffer);
900 #define print_id(udev) do { } while (0)
903 static int eject_installer(struct usb_interface *intf)
905 struct usb_device *udev = interface_to_usbdev(intf);
906 struct usb_host_interface *iface_desc = &intf->altsetting[0];
907 struct usb_endpoint_descriptor *endpoint;
912 /* Find bulk out endpoint */
913 endpoint = &iface_desc->endpoint[1].desc;
914 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
915 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
916 USB_ENDPOINT_XFER_BULK) {
917 bulk_out_ep = endpoint->bEndpointAddress;
920 "zd1211rw: Could not find bulk out endpoint\n");
924 cmd = kzalloc(31, GFP_KERNEL);
928 /* USB bulk command block */
929 cmd[0] = 0x55; /* bulk command signature */
930 cmd[1] = 0x53; /* bulk command signature */
931 cmd[2] = 0x42; /* bulk command signature */
932 cmd[3] = 0x43; /* bulk command signature */
933 cmd[14] = 6; /* command length */
935 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
936 cmd[19] = 0x2; /* eject disc */
938 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
939 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
940 cmd, 31, NULL, 2000);
945 /* At this point, the device disconnects and reconnects with the real
948 usb_set_intfdata(intf, NULL);
952 int zd_usb_init_hw(struct zd_usb *usb)
955 struct zd_mac *mac = zd_usb_to_mac(usb);
957 dev_dbg_f(zd_usb_dev(usb), "\n");
959 r = upload_firmware(usb);
961 dev_err(zd_usb_dev(usb),
962 "couldn't load firmware. Error number %d\n", r);
966 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
968 dev_dbg_f(zd_usb_dev(usb),
969 "couldn't reset configuration. Error number %d\n", r);
973 r = zd_mac_init_hw(mac);
975 dev_dbg_f(zd_usb_dev(usb),
976 "couldn't initialize mac. Error number %d\n", r);
980 usb->initialized = 1;
984 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
988 struct usb_device *udev = interface_to_usbdev(intf);
989 struct net_device *netdev = NULL;
993 if (id->driver_info & DEVICE_INSTALLER)
994 return eject_installer(intf);
996 switch (udev->speed) {
1002 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1007 usb_reset_device(interface_to_usbdev(intf));
1009 netdev = zd_netdev_alloc(intf);
1010 if (netdev == NULL) {
1015 usb = &zd_netdev_mac(netdev)->chip.usb;
1016 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1018 r = zd_mac_preinit_hw(zd_netdev_mac(netdev));
1020 dev_dbg_f(&intf->dev,
1021 "couldn't initialize mac. Error number %d\n", r);
1025 r = register_netdev(netdev);
1027 dev_dbg_f(&intf->dev,
1028 "couldn't register netdev. Error number %d\n", r);
1032 dev_dbg_f(&intf->dev, "successful\n");
1033 dev_info(&intf->dev,"%s\n", netdev->name);
1036 usb_reset_device(interface_to_usbdev(intf));
1037 zd_netdev_free(netdev);
1041 static void disconnect(struct usb_interface *intf)
1043 struct net_device *netdev = zd_intf_to_netdev(intf);
1044 struct zd_mac *mac = zd_netdev_mac(netdev);
1045 struct zd_usb *usb = &mac->chip.usb;
1047 /* Either something really bad happened, or we're just dealing with
1048 * a DEVICE_INSTALLER. */
1052 dev_dbg_f(zd_usb_dev(usb), "\n");
1054 zd_netdev_disconnect(netdev);
1056 /* Just in case something has gone wrong! */
1057 zd_usb_disable_rx(usb);
1058 zd_usb_disable_int(usb);
1060 /* If the disconnect has been caused by a removal of the
1061 * driver module, the reset allows reloading of the driver. If the
1062 * reset will not be executed here, the upload of the firmware in the
1063 * probe function caused by the reloading of the driver will fail.
1065 usb_reset_device(interface_to_usbdev(intf));
1067 zd_netdev_free(netdev);
1068 dev_dbg(&intf->dev, "disconnected\n");
1071 static struct usb_driver driver = {
1073 .id_table = usb_ids,
1075 .disconnect = disconnect,
1078 struct workqueue_struct *zd_workqueue;
1080 static int __init usb_init(void)
1084 pr_debug("%s usb_init()\n", driver.name);
1086 zd_workqueue = create_singlethread_workqueue(driver.name);
1087 if (zd_workqueue == NULL) {
1088 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1092 r = usb_register(&driver);
1094 destroy_workqueue(zd_workqueue);
1095 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1100 pr_debug("%s initialized\n", driver.name);
1104 static void __exit usb_exit(void)
1106 pr_debug("%s usb_exit()\n", driver.name);
1107 usb_deregister(&driver);
1108 destroy_workqueue(zd_workqueue);
1111 module_init(usb_init);
1112 module_exit(usb_exit);
1114 static int usb_int_regs_length(unsigned int count)
1116 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1119 static void prepare_read_regs_int(struct zd_usb *usb)
1121 struct zd_usb_interrupt *intr = &usb->intr;
1123 spin_lock_irq(&intr->lock);
1124 intr->read_regs_enabled = 1;
1125 INIT_COMPLETION(intr->read_regs.completion);
1126 spin_unlock_irq(&intr->lock);
1129 static void disable_read_regs_int(struct zd_usb *usb)
1131 struct zd_usb_interrupt *intr = &usb->intr;
1133 spin_lock_irq(&intr->lock);
1134 intr->read_regs_enabled = 0;
1135 spin_unlock_irq(&intr->lock);
1138 static int get_results(struct zd_usb *usb, u16 *values,
1139 struct usb_req_read_regs *req, unsigned int count)
1143 struct zd_usb_interrupt *intr = &usb->intr;
1144 struct read_regs_int *rr = &intr->read_regs;
1145 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1147 spin_lock_irq(&intr->lock);
1150 /* The created block size seems to be larger than expected.
1151 * However results appear to be correct.
1153 if (rr->length < usb_int_regs_length(count)) {
1154 dev_dbg_f(zd_usb_dev(usb),
1155 "error: actual length %d less than expected %d\n",
1156 rr->length, usb_int_regs_length(count));
1159 if (rr->length > sizeof(rr->buffer)) {
1160 dev_dbg_f(zd_usb_dev(usb),
1161 "error: actual length %d exceeds buffer size %zu\n",
1162 rr->length, sizeof(rr->buffer));
1166 for (i = 0; i < count; i++) {
1167 struct reg_data *rd = ®s->regs[i];
1168 if (rd->addr != req->addr[i]) {
1169 dev_dbg_f(zd_usb_dev(usb),
1170 "rd[%d] addr %#06hx expected %#06hx\n", i,
1171 le16_to_cpu(rd->addr),
1172 le16_to_cpu(req->addr[i]));
1175 values[i] = le16_to_cpu(rd->value);
1180 spin_unlock_irq(&intr->lock);
1184 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1185 const zd_addr_t *addresses, unsigned int count)
1188 int i, req_len, actual_req_len;
1189 struct usb_device *udev;
1190 struct usb_req_read_regs *req = NULL;
1191 unsigned long timeout;
1194 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1197 if (count > USB_MAX_IOREAD16_COUNT) {
1198 dev_dbg_f(zd_usb_dev(usb),
1199 "error: count %u exceeds possible max %u\n",
1200 count, USB_MAX_IOREAD16_COUNT);
1204 dev_dbg_f(zd_usb_dev(usb),
1205 "error: io in atomic context not supported\n");
1206 return -EWOULDBLOCK;
1208 if (!usb_int_enabled(usb)) {
1209 dev_dbg_f(zd_usb_dev(usb),
1210 "error: usb interrupt not enabled\n");
1211 return -EWOULDBLOCK;
1214 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1215 req = kmalloc(req_len, GFP_KERNEL);
1218 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1219 for (i = 0; i < count; i++)
1220 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1222 udev = zd_usb_to_usbdev(usb);
1223 prepare_read_regs_int(usb);
1224 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1225 req, req_len, &actual_req_len, 1000 /* ms */);
1227 dev_dbg_f(zd_usb_dev(usb),
1228 "error in usb_bulk_msg(). Error number %d\n", r);
1231 if (req_len != actual_req_len) {
1232 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1233 " req_len %d != actual_req_len %d\n",
1234 req_len, actual_req_len);
1239 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1240 msecs_to_jiffies(1000));
1242 disable_read_regs_int(usb);
1243 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1248 r = get_results(usb, values, req, count);
1254 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1258 struct usb_device *udev;
1259 struct usb_req_write_regs *req = NULL;
1260 int i, req_len, actual_req_len;
1264 if (count > USB_MAX_IOWRITE16_COUNT) {
1265 dev_dbg_f(zd_usb_dev(usb),
1266 "error: count %u exceeds possible max %u\n",
1267 count, USB_MAX_IOWRITE16_COUNT);
1271 dev_dbg_f(zd_usb_dev(usb),
1272 "error: io in atomic context not supported\n");
1273 return -EWOULDBLOCK;
1276 req_len = sizeof(struct usb_req_write_regs) +
1277 count * sizeof(struct reg_data);
1278 req = kmalloc(req_len, GFP_KERNEL);
1282 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1283 for (i = 0; i < count; i++) {
1284 struct reg_data *rw = &req->reg_writes[i];
1285 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1286 rw->value = cpu_to_le16(ioreqs[i].value);
1289 udev = zd_usb_to_usbdev(usb);
1290 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1291 req, req_len, &actual_req_len, 1000 /* ms */);
1293 dev_dbg_f(zd_usb_dev(usb),
1294 "error in usb_bulk_msg(). Error number %d\n", r);
1297 if (req_len != actual_req_len) {
1298 dev_dbg_f(zd_usb_dev(usb),
1299 "error in usb_bulk_msg()"
1300 " req_len %d != actual_req_len %d\n",
1301 req_len, actual_req_len);
1306 /* FALL-THROUGH with r == 0 */
1312 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1315 struct usb_device *udev;
1316 struct usb_req_rfwrite *req = NULL;
1317 int i, req_len, actual_req_len;
1318 u16 bit_value_template;
1321 dev_dbg_f(zd_usb_dev(usb),
1322 "error: io in atomic context not supported\n");
1323 return -EWOULDBLOCK;
1325 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1326 dev_dbg_f(zd_usb_dev(usb),
1327 "error: bits %d are smaller than"
1328 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1329 bits, USB_MIN_RFWRITE_BIT_COUNT);
1332 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1333 dev_dbg_f(zd_usb_dev(usb),
1334 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1335 bits, USB_MAX_RFWRITE_BIT_COUNT);
1339 if (value & (~0UL << bits)) {
1340 dev_dbg_f(zd_usb_dev(usb),
1341 "error: value %#09x has bits >= %d set\n",
1347 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1349 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1351 dev_dbg_f(zd_usb_dev(usb),
1352 "error %d: Couldn't read CR203\n", r);
1355 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1357 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1358 req = kmalloc(req_len, GFP_KERNEL);
1362 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1363 /* 1: 3683a, but not used in ZYDAS driver */
1364 req->value = cpu_to_le16(2);
1365 req->bits = cpu_to_le16(bits);
1367 for (i = 0; i < bits; i++) {
1368 u16 bv = bit_value_template;
1369 if (value & (1 << (bits-1-i)))
1371 req->bit_values[i] = cpu_to_le16(bv);
1374 udev = zd_usb_to_usbdev(usb);
1375 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1376 req, req_len, &actual_req_len, 1000 /* ms */);
1378 dev_dbg_f(zd_usb_dev(usb),
1379 "error in usb_bulk_msg(). Error number %d\n", r);
1382 if (req_len != actual_req_len) {
1383 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1384 " req_len %d != actual_req_len %d\n",
1385 req_len, actual_req_len);
1390 /* FALL-THROUGH with r == 0 */