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 { USB_DEVICE(0x0586, 0x340a), .driver_info = DEVICE_ZD1211B },
79 /* "Driverless" devices that need ejecting */
80 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
81 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
85 MODULE_LICENSE("GPL");
86 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
87 MODULE_AUTHOR("Ulrich Kunitz");
88 MODULE_AUTHOR("Daniel Drake");
89 MODULE_VERSION("1.0");
90 MODULE_DEVICE_TABLE(usb, usb_ids);
92 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
93 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
95 /* USB device initialization */
97 static int request_fw_file(
98 const struct firmware **fw, const char *name, struct device *device)
102 dev_dbg_f(device, "fw name %s\n", name);
104 r = request_firmware(fw, name, device);
107 "Could not load firmware file %s. Error number %d\n",
112 static inline u16 get_bcdDevice(const struct usb_device *udev)
114 return le16_to_cpu(udev->descriptor.bcdDevice);
117 enum upload_code_flags {
121 /* Ensures that MAX_TRANSFER_SIZE is even. */
122 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
124 static int upload_code(struct usb_device *udev,
125 const u8 *data, size_t size, u16 code_offset, int flags)
130 /* USB request blocks need "kmalloced" buffers.
132 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
134 dev_err(&udev->dev, "out of memory\n");
141 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
142 size : MAX_TRANSFER_SIZE;
144 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
146 memcpy(p, data, transfer_size);
147 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
148 USB_REQ_FIRMWARE_DOWNLOAD,
149 USB_DIR_OUT | USB_TYPE_VENDOR,
150 code_offset, 0, p, transfer_size, 1000 /* ms */);
153 "USB control request for firmware upload"
154 " failed. Error number %d\n", r);
157 transfer_size = r & ~1;
159 size -= transfer_size;
160 data += transfer_size;
161 code_offset += transfer_size/sizeof(u16);
164 if (flags & REBOOT) {
167 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
168 USB_REQ_FIRMWARE_CONFIRM,
169 USB_DIR_IN | USB_TYPE_VENDOR,
170 0, 0, &ret, sizeof(ret), 5000 /* ms */);
171 if (r != sizeof(ret)) {
173 "control request firmeware confirmation failed."
174 " Return value %d\n", r);
181 "Internal error while downloading."
182 " Firmware confirm return value %#04x\n",
187 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
197 static u16 get_word(const void *data, u16 offset)
199 const __le16 *p = data;
200 return le16_to_cpu(p[offset]);
203 static char *get_fw_name(struct zd_usb *usb, char *buffer, size_t size,
206 scnprintf(buffer, size, "%s%s",
208 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
213 static int handle_version_mismatch(struct zd_usb *usb,
214 const struct firmware *ub_fw)
216 struct usb_device *udev = zd_usb_to_usbdev(usb);
217 const struct firmware *ur_fw = NULL;
222 r = request_fw_file(&ur_fw,
223 get_fw_name(usb, fw_name, sizeof(fw_name), "ur"),
228 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
232 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
233 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
234 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
236 /* At this point, the vendor driver downloads the whole firmware
237 * image, hacks around with version IDs, and uploads it again,
238 * completely overwriting the boot code. We do not do this here as
239 * it is not required on any tested devices, and it is suspected to
242 release_firmware(ur_fw);
246 static int upload_firmware(struct zd_usb *usb)
251 struct usb_device *udev = zd_usb_to_usbdev(usb);
252 const struct firmware *ub_fw = NULL;
253 const struct firmware *uph_fw = NULL;
256 bcdDevice = get_bcdDevice(udev);
258 r = request_fw_file(&ub_fw,
259 get_fw_name(usb, fw_name, sizeof(fw_name), "ub"),
264 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
266 if (fw_bcdDevice != bcdDevice) {
268 "firmware version %#06x and device bootcode version "
269 "%#06x differ\n", fw_bcdDevice, bcdDevice);
270 if (bcdDevice <= 0x4313)
271 dev_warn(&udev->dev, "device has old bootcode, please "
272 "report success or failure\n");
274 r = handle_version_mismatch(usb, ub_fw);
278 dev_dbg_f(&udev->dev,
279 "firmware device id %#06x is equal to the "
280 "actual device id\n", fw_bcdDevice);
284 r = request_fw_file(&uph_fw,
285 get_fw_name(usb, fw_name, sizeof(fw_name), "uphr"),
290 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
293 "Could not upload firmware code uph. Error number %d\n",
299 release_firmware(ub_fw);
300 release_firmware(uph_fw);
304 /* Read data from device address space using "firmware interface" which does
305 * not require firmware to be loaded. */
306 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len)
309 struct usb_device *udev = zd_usb_to_usbdev(usb);
311 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
312 USB_REQ_FIRMWARE_READ_DATA, USB_DIR_IN | 0x40, addr, 0,
316 "read over firmware interface failed: %d\n", r);
318 } else if (r != len) {
320 "incomplete read over firmware interface: %d/%d\n",
328 #define urb_dev(urb) (&(urb)->dev->dev)
330 static inline void handle_regs_int(struct urb *urb)
332 struct zd_usb *usb = urb->context;
333 struct zd_usb_interrupt *intr = &usb->intr;
336 ZD_ASSERT(in_interrupt());
337 spin_lock(&intr->lock);
339 if (intr->read_regs_enabled) {
340 intr->read_regs.length = len = urb->actual_length;
342 if (len > sizeof(intr->read_regs.buffer))
343 len = sizeof(intr->read_regs.buffer);
344 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
345 intr->read_regs_enabled = 0;
346 complete(&intr->read_regs.completion);
350 dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
352 spin_unlock(&intr->lock);
355 static inline void handle_retry_failed_int(struct urb *urb)
357 struct zd_usb *usb = urb->context;
358 struct zd_mac *mac = zd_usb_to_mac(usb);
359 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
361 ieee->stats.tx_errors++;
362 ieee->ieee_stats.tx_retry_limit_exceeded++;
363 dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
367 static void int_urb_complete(struct urb *urb)
370 struct usb_int_header *hdr;
372 switch (urb->status) {
386 if (urb->actual_length < sizeof(hdr)) {
387 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
391 hdr = urb->transfer_buffer;
392 if (hdr->type != USB_INT_TYPE) {
393 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
398 case USB_INT_ID_REGS:
399 handle_regs_int(urb);
401 case USB_INT_ID_RETRY_FAILED:
402 handle_retry_failed_int(urb);
405 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
406 (unsigned int)hdr->id);
411 r = usb_submit_urb(urb, GFP_ATOMIC);
413 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
418 kfree(urb->transfer_buffer);
421 static inline int int_urb_interval(struct usb_device *udev)
423 switch (udev->speed) {
434 static inline int usb_int_enabled(struct zd_usb *usb)
437 struct zd_usb_interrupt *intr = &usb->intr;
440 spin_lock_irqsave(&intr->lock, flags);
442 spin_unlock_irqrestore(&intr->lock, flags);
446 int zd_usb_enable_int(struct zd_usb *usb)
449 struct usb_device *udev;
450 struct zd_usb_interrupt *intr = &usb->intr;
451 void *transfer_buffer = NULL;
454 dev_dbg_f(zd_usb_dev(usb), "\n");
456 urb = usb_alloc_urb(0, GFP_KERNEL);
462 ZD_ASSERT(!irqs_disabled());
463 spin_lock_irq(&intr->lock);
465 spin_unlock_irq(&intr->lock);
470 spin_unlock_irq(&intr->lock);
472 /* TODO: make it a DMA buffer */
474 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
475 if (!transfer_buffer) {
476 dev_dbg_f(zd_usb_dev(usb),
477 "couldn't allocate transfer_buffer\n");
478 goto error_set_urb_null;
481 udev = zd_usb_to_usbdev(usb);
482 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
483 transfer_buffer, USB_MAX_EP_INT_BUFFER,
484 int_urb_complete, usb,
487 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
488 r = usb_submit_urb(urb, GFP_KERNEL);
490 dev_dbg_f(zd_usb_dev(usb),
491 "Couldn't submit urb. Error number %d\n", r);
497 kfree(transfer_buffer);
499 spin_lock_irq(&intr->lock);
501 spin_unlock_irq(&intr->lock);
508 void zd_usb_disable_int(struct zd_usb *usb)
511 struct zd_usb_interrupt *intr = &usb->intr;
514 spin_lock_irqsave(&intr->lock, flags);
517 spin_unlock_irqrestore(&intr->lock, flags);
521 spin_unlock_irqrestore(&intr->lock, flags);
524 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
528 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
532 struct zd_mac *mac = zd_usb_to_mac(usb);
533 const struct rx_length_info *length_info;
535 if (length < sizeof(struct rx_length_info)) {
536 /* It's not a complete packet anyhow. */
537 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
538 ieee->stats.rx_errors++;
539 ieee->stats.rx_length_errors++;
542 length_info = (struct rx_length_info *)
543 (buffer + length - sizeof(struct rx_length_info));
545 /* It might be that three frames are merged into a single URB
546 * transaction. We have to check for the length info tag.
548 * While testing we discovered that length_info might be unaligned,
549 * because if USB transactions are merged, the last packet will not
550 * be padded. Unaligned access might also happen if the length_info
551 * structure is not present.
553 if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
555 unsigned int l, k, n;
556 for (i = 0, l = 0;; i++) {
557 k = le16_to_cpu(get_unaligned(&length_info->length[i]));
563 zd_mac_rx_irq(mac, buffer+l, k);
569 zd_mac_rx_irq(mac, buffer, length);
573 static void rx_urb_complete(struct urb *urb)
576 struct zd_usb_rx *rx;
580 switch (urb->status) {
591 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
595 buffer = urb->transfer_buffer;
596 length = urb->actual_length;
600 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
601 /* If there is an old first fragment, we don't care. */
602 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
603 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
604 spin_lock(&rx->lock);
605 memcpy(rx->fragment, buffer, length);
606 rx->fragment_length = length;
607 spin_unlock(&rx->lock);
611 spin_lock(&rx->lock);
612 if (rx->fragment_length > 0) {
613 /* We are on a second fragment, we believe */
614 ZD_ASSERT(length + rx->fragment_length <=
615 ARRAY_SIZE(rx->fragment));
616 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
617 memcpy(rx->fragment+rx->fragment_length, buffer, length);
618 handle_rx_packet(usb, rx->fragment,
619 rx->fragment_length + length);
620 rx->fragment_length = 0;
621 spin_unlock(&rx->lock);
623 spin_unlock(&rx->lock);
624 handle_rx_packet(usb, buffer, length);
628 usb_submit_urb(urb, GFP_ATOMIC);
631 static struct urb *alloc_urb(struct zd_usb *usb)
633 struct usb_device *udev = zd_usb_to_usbdev(usb);
637 urb = usb_alloc_urb(0, GFP_KERNEL);
640 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
647 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
648 buffer, USB_MAX_RX_SIZE,
649 rx_urb_complete, usb);
650 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
655 static void free_urb(struct urb *urb)
659 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
660 urb->transfer_buffer, urb->transfer_dma);
664 int zd_usb_enable_rx(struct zd_usb *usb)
667 struct zd_usb_rx *rx = &usb->rx;
670 dev_dbg_f(zd_usb_dev(usb), "\n");
673 urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
676 for (i = 0; i < URBS_COUNT; i++) {
677 urbs[i] = alloc_urb(usb);
682 ZD_ASSERT(!irqs_disabled());
683 spin_lock_irq(&rx->lock);
685 spin_unlock_irq(&rx->lock);
690 rx->urbs_count = URBS_COUNT;
691 spin_unlock_irq(&rx->lock);
693 for (i = 0; i < URBS_COUNT; i++) {
694 r = usb_submit_urb(urbs[i], GFP_KERNEL);
701 for (i = 0; i < URBS_COUNT; i++) {
702 usb_kill_urb(urbs[i]);
704 spin_lock_irq(&rx->lock);
707 spin_unlock_irq(&rx->lock);
710 for (i = 0; i < URBS_COUNT; i++)
716 void zd_usb_disable_rx(struct zd_usb *usb)
722 struct zd_usb_rx *rx = &usb->rx;
724 spin_lock_irqsave(&rx->lock, flags);
726 count = rx->urbs_count;
727 spin_unlock_irqrestore(&rx->lock, flags);
731 for (i = 0; i < count; i++) {
732 usb_kill_urb(urbs[i]);
737 spin_lock_irqsave(&rx->lock, flags);
740 spin_unlock_irqrestore(&rx->lock, flags);
743 static void tx_urb_complete(struct urb *urb)
747 switch (urb->status) {
756 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
759 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
763 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
764 urb->transfer_buffer, urb->transfer_dma);
768 r = usb_submit_urb(urb, GFP_ATOMIC);
770 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
775 /* Puts the frame on the USB endpoint. It doesn't wait for
776 * completion. The frame must contain the control set.
778 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
781 struct usb_device *udev = zd_usb_to_usbdev(usb);
785 urb = usb_alloc_urb(0, GFP_ATOMIC);
791 buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
797 memcpy(buffer, frame, length);
799 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
800 buffer, length, tx_urb_complete, NULL);
801 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
803 r = usb_submit_urb(urb, GFP_ATOMIC);
808 usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
816 static inline void init_usb_interrupt(struct zd_usb *usb)
818 struct zd_usb_interrupt *intr = &usb->intr;
820 spin_lock_init(&intr->lock);
821 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
822 init_completion(&intr->read_regs.completion);
823 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
826 static inline void init_usb_rx(struct zd_usb *usb)
828 struct zd_usb_rx *rx = &usb->rx;
829 spin_lock_init(&rx->lock);
830 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
831 rx->usb_packet_size = 512;
833 rx->usb_packet_size = 64;
835 ZD_ASSERT(rx->fragment_length == 0);
838 static inline void init_usb_tx(struct zd_usb *usb)
840 /* FIXME: at this point we will allocate a fixed number of urb's for
841 * use in a cyclic scheme */
844 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
845 struct usb_interface *intf)
847 memset(usb, 0, sizeof(*usb));
848 usb->intf = usb_get_intf(intf);
849 usb_set_intfdata(usb->intf, netdev);
850 init_usb_interrupt(usb);
855 void zd_usb_clear(struct zd_usb *usb)
857 usb_set_intfdata(usb->intf, NULL);
858 usb_put_intf(usb->intf);
859 ZD_MEMCLEAR(usb, sizeof(*usb));
860 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
863 static const char *speed(enum usb_device_speed speed)
873 return "unknown speed";
877 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
879 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
880 le16_to_cpu(udev->descriptor.idVendor),
881 le16_to_cpu(udev->descriptor.idProduct),
886 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
888 struct usb_device *udev = interface_to_usbdev(usb->intf);
889 return scnprint_id(udev, buffer, size);
893 static void print_id(struct usb_device *udev)
897 scnprint_id(udev, buffer, sizeof(buffer));
898 buffer[sizeof(buffer)-1] = 0;
899 dev_dbg_f(&udev->dev, "%s\n", buffer);
902 #define print_id(udev) do { } while (0)
905 static int eject_installer(struct usb_interface *intf)
907 struct usb_device *udev = interface_to_usbdev(intf);
908 struct usb_host_interface *iface_desc = &intf->altsetting[0];
909 struct usb_endpoint_descriptor *endpoint;
914 /* Find bulk out endpoint */
915 endpoint = &iface_desc->endpoint[1].desc;
916 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
917 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
918 USB_ENDPOINT_XFER_BULK) {
919 bulk_out_ep = endpoint->bEndpointAddress;
922 "zd1211rw: Could not find bulk out endpoint\n");
926 cmd = kzalloc(31, GFP_KERNEL);
930 /* USB bulk command block */
931 cmd[0] = 0x55; /* bulk command signature */
932 cmd[1] = 0x53; /* bulk command signature */
933 cmd[2] = 0x42; /* bulk command signature */
934 cmd[3] = 0x43; /* bulk command signature */
935 cmd[14] = 6; /* command length */
937 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
938 cmd[19] = 0x2; /* eject disc */
940 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
941 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
942 cmd, 31, NULL, 2000);
947 /* At this point, the device disconnects and reconnects with the real
950 usb_set_intfdata(intf, NULL);
954 int zd_usb_init_hw(struct zd_usb *usb)
957 struct zd_mac *mac = zd_usb_to_mac(usb);
959 dev_dbg_f(zd_usb_dev(usb), "\n");
961 r = upload_firmware(usb);
963 dev_err(zd_usb_dev(usb),
964 "couldn't load firmware. Error number %d\n", r);
968 r = usb_reset_configuration(zd_usb_to_usbdev(usb));
970 dev_dbg_f(zd_usb_dev(usb),
971 "couldn't reset configuration. Error number %d\n", r);
975 r = zd_mac_init_hw(mac);
977 dev_dbg_f(zd_usb_dev(usb),
978 "couldn't initialize mac. Error number %d\n", r);
982 usb->initialized = 1;
986 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
990 struct usb_device *udev = interface_to_usbdev(intf);
991 struct net_device *netdev = NULL;
995 if (id->driver_info & DEVICE_INSTALLER)
996 return eject_installer(intf);
998 switch (udev->speed) {
1000 case USB_SPEED_FULL:
1001 case USB_SPEED_HIGH:
1004 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
1009 usb_reset_device(interface_to_usbdev(intf));
1011 netdev = zd_netdev_alloc(intf);
1012 if (netdev == NULL) {
1017 usb = &zd_netdev_mac(netdev)->chip.usb;
1018 usb->is_zd1211b = (id->driver_info == DEVICE_ZD1211B) != 0;
1020 r = zd_mac_preinit_hw(zd_netdev_mac(netdev));
1022 dev_dbg_f(&intf->dev,
1023 "couldn't initialize mac. Error number %d\n", r);
1027 r = register_netdev(netdev);
1029 dev_dbg_f(&intf->dev,
1030 "couldn't register netdev. Error number %d\n", r);
1034 dev_dbg_f(&intf->dev, "successful\n");
1035 dev_info(&intf->dev,"%s\n", netdev->name);
1038 usb_reset_device(interface_to_usbdev(intf));
1039 zd_netdev_free(netdev);
1043 static void disconnect(struct usb_interface *intf)
1045 struct net_device *netdev = zd_intf_to_netdev(intf);
1046 struct zd_mac *mac = zd_netdev_mac(netdev);
1047 struct zd_usb *usb = &mac->chip.usb;
1049 /* Either something really bad happened, or we're just dealing with
1050 * a DEVICE_INSTALLER. */
1054 dev_dbg_f(zd_usb_dev(usb), "\n");
1056 zd_netdev_disconnect(netdev);
1058 /* Just in case something has gone wrong! */
1059 zd_usb_disable_rx(usb);
1060 zd_usb_disable_int(usb);
1062 /* If the disconnect has been caused by a removal of the
1063 * driver module, the reset allows reloading of the driver. If the
1064 * reset will not be executed here, the upload of the firmware in the
1065 * probe function caused by the reloading of the driver will fail.
1067 usb_reset_device(interface_to_usbdev(intf));
1069 zd_netdev_free(netdev);
1070 dev_dbg(&intf->dev, "disconnected\n");
1073 static struct usb_driver driver = {
1075 .id_table = usb_ids,
1077 .disconnect = disconnect,
1080 struct workqueue_struct *zd_workqueue;
1082 static int __init usb_init(void)
1086 pr_debug("%s usb_init()\n", driver.name);
1088 zd_workqueue = create_singlethread_workqueue(driver.name);
1089 if (zd_workqueue == NULL) {
1090 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1094 r = usb_register(&driver);
1096 destroy_workqueue(zd_workqueue);
1097 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1102 pr_debug("%s initialized\n", driver.name);
1106 static void __exit usb_exit(void)
1108 pr_debug("%s usb_exit()\n", driver.name);
1109 usb_deregister(&driver);
1110 destroy_workqueue(zd_workqueue);
1113 module_init(usb_init);
1114 module_exit(usb_exit);
1116 static int usb_int_regs_length(unsigned int count)
1118 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1121 static void prepare_read_regs_int(struct zd_usb *usb)
1123 struct zd_usb_interrupt *intr = &usb->intr;
1125 spin_lock_irq(&intr->lock);
1126 intr->read_regs_enabled = 1;
1127 INIT_COMPLETION(intr->read_regs.completion);
1128 spin_unlock_irq(&intr->lock);
1131 static void disable_read_regs_int(struct zd_usb *usb)
1133 struct zd_usb_interrupt *intr = &usb->intr;
1135 spin_lock_irq(&intr->lock);
1136 intr->read_regs_enabled = 0;
1137 spin_unlock_irq(&intr->lock);
1140 static int get_results(struct zd_usb *usb, u16 *values,
1141 struct usb_req_read_regs *req, unsigned int count)
1145 struct zd_usb_interrupt *intr = &usb->intr;
1146 struct read_regs_int *rr = &intr->read_regs;
1147 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1149 spin_lock_irq(&intr->lock);
1152 /* The created block size seems to be larger than expected.
1153 * However results appear to be correct.
1155 if (rr->length < usb_int_regs_length(count)) {
1156 dev_dbg_f(zd_usb_dev(usb),
1157 "error: actual length %d less than expected %d\n",
1158 rr->length, usb_int_regs_length(count));
1161 if (rr->length > sizeof(rr->buffer)) {
1162 dev_dbg_f(zd_usb_dev(usb),
1163 "error: actual length %d exceeds buffer size %zu\n",
1164 rr->length, sizeof(rr->buffer));
1168 for (i = 0; i < count; i++) {
1169 struct reg_data *rd = ®s->regs[i];
1170 if (rd->addr != req->addr[i]) {
1171 dev_dbg_f(zd_usb_dev(usb),
1172 "rd[%d] addr %#06hx expected %#06hx\n", i,
1173 le16_to_cpu(rd->addr),
1174 le16_to_cpu(req->addr[i]));
1177 values[i] = le16_to_cpu(rd->value);
1182 spin_unlock_irq(&intr->lock);
1186 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1187 const zd_addr_t *addresses, unsigned int count)
1190 int i, req_len, actual_req_len;
1191 struct usb_device *udev;
1192 struct usb_req_read_regs *req = NULL;
1193 unsigned long timeout;
1196 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1199 if (count > USB_MAX_IOREAD16_COUNT) {
1200 dev_dbg_f(zd_usb_dev(usb),
1201 "error: count %u exceeds possible max %u\n",
1202 count, USB_MAX_IOREAD16_COUNT);
1206 dev_dbg_f(zd_usb_dev(usb),
1207 "error: io in atomic context not supported\n");
1208 return -EWOULDBLOCK;
1210 if (!usb_int_enabled(usb)) {
1211 dev_dbg_f(zd_usb_dev(usb),
1212 "error: usb interrupt not enabled\n");
1213 return -EWOULDBLOCK;
1216 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1217 req = kmalloc(req_len, GFP_KERNEL);
1220 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1221 for (i = 0; i < count; i++)
1222 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1224 udev = zd_usb_to_usbdev(usb);
1225 prepare_read_regs_int(usb);
1226 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1227 req, req_len, &actual_req_len, 1000 /* ms */);
1229 dev_dbg_f(zd_usb_dev(usb),
1230 "error in usb_bulk_msg(). Error number %d\n", r);
1233 if (req_len != actual_req_len) {
1234 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1235 " req_len %d != actual_req_len %d\n",
1236 req_len, actual_req_len);
1241 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1242 msecs_to_jiffies(1000));
1244 disable_read_regs_int(usb);
1245 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1250 r = get_results(usb, values, req, count);
1256 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1260 struct usb_device *udev;
1261 struct usb_req_write_regs *req = NULL;
1262 int i, req_len, actual_req_len;
1266 if (count > USB_MAX_IOWRITE16_COUNT) {
1267 dev_dbg_f(zd_usb_dev(usb),
1268 "error: count %u exceeds possible max %u\n",
1269 count, USB_MAX_IOWRITE16_COUNT);
1273 dev_dbg_f(zd_usb_dev(usb),
1274 "error: io in atomic context not supported\n");
1275 return -EWOULDBLOCK;
1278 req_len = sizeof(struct usb_req_write_regs) +
1279 count * sizeof(struct reg_data);
1280 req = kmalloc(req_len, GFP_KERNEL);
1284 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1285 for (i = 0; i < count; i++) {
1286 struct reg_data *rw = &req->reg_writes[i];
1287 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1288 rw->value = cpu_to_le16(ioreqs[i].value);
1291 udev = zd_usb_to_usbdev(usb);
1292 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1293 req, req_len, &actual_req_len, 1000 /* ms */);
1295 dev_dbg_f(zd_usb_dev(usb),
1296 "error in usb_bulk_msg(). Error number %d\n", r);
1299 if (req_len != actual_req_len) {
1300 dev_dbg_f(zd_usb_dev(usb),
1301 "error in usb_bulk_msg()"
1302 " req_len %d != actual_req_len %d\n",
1303 req_len, actual_req_len);
1308 /* FALL-THROUGH with r == 0 */
1314 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1317 struct usb_device *udev;
1318 struct usb_req_rfwrite *req = NULL;
1319 int i, req_len, actual_req_len;
1320 u16 bit_value_template;
1323 dev_dbg_f(zd_usb_dev(usb),
1324 "error: io in atomic context not supported\n");
1325 return -EWOULDBLOCK;
1327 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1328 dev_dbg_f(zd_usb_dev(usb),
1329 "error: bits %d are smaller than"
1330 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1331 bits, USB_MIN_RFWRITE_BIT_COUNT);
1334 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1335 dev_dbg_f(zd_usb_dev(usb),
1336 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1337 bits, USB_MAX_RFWRITE_BIT_COUNT);
1341 if (value & (~0UL << bits)) {
1342 dev_dbg_f(zd_usb_dev(usb),
1343 "error: value %#09x has bits >= %d set\n",
1349 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1351 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1353 dev_dbg_f(zd_usb_dev(usb),
1354 "error %d: Couldn't read CR203\n", r);
1357 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1359 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1360 req = kmalloc(req_len, GFP_KERNEL);
1364 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1365 /* 1: 3683a, but not used in ZYDAS driver */
1366 req->value = cpu_to_le16(2);
1367 req->bits = cpu_to_le16(bits);
1369 for (i = 0; i < bits; i++) {
1370 u16 bv = bit_value_template;
1371 if (value & (1 << (bits-1-i)))
1373 req->bit_values[i] = cpu_to_le16(bv);
1376 udev = zd_usb_to_usbdev(usb);
1377 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1378 req, req_len, &actual_req_len, 1000 /* ms */);
1380 dev_dbg_f(zd_usb_dev(usb),
1381 "error in usb_bulk_msg(). Error number %d\n", r);
1384 if (req_len != actual_req_len) {
1385 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1386 " req_len %d != actual_req_len %d\n",
1387 req_len, actual_req_len);
1392 /* FALL-THROUGH with r == 0 */