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 <asm/unaligned.h>
19 #include <linux/kernel.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/firmware.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/skbuff.h>
26 #include <linux/usb.h>
27 #include <linux/workqueue.h>
28 #include <net/ieee80211.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 /* "Driverless" devices that need ejecting */
75 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
76 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
80 MODULE_LICENSE("GPL");
81 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
82 MODULE_AUTHOR("Ulrich Kunitz");
83 MODULE_AUTHOR("Daniel Drake");
84 MODULE_VERSION("1.0");
85 MODULE_DEVICE_TABLE(usb, usb_ids);
87 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
88 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
90 /* USB device initialization */
92 static int request_fw_file(
93 const struct firmware **fw, const char *name, struct device *device)
97 dev_dbg_f(device, "fw name %s\n", name);
99 r = request_firmware(fw, name, device);
102 "Could not load firmware file %s. Error number %d\n",
107 static inline u16 get_bcdDevice(const struct usb_device *udev)
109 return le16_to_cpu(udev->descriptor.bcdDevice);
112 enum upload_code_flags {
116 /* Ensures that MAX_TRANSFER_SIZE is even. */
117 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
119 static int upload_code(struct usb_device *udev,
120 const u8 *data, size_t size, u16 code_offset, int flags)
125 /* USB request blocks need "kmalloced" buffers.
127 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
129 dev_err(&udev->dev, "out of memory\n");
136 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
137 size : MAX_TRANSFER_SIZE;
139 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
141 memcpy(p, data, transfer_size);
142 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
143 USB_REQ_FIRMWARE_DOWNLOAD,
144 USB_DIR_OUT | USB_TYPE_VENDOR,
145 code_offset, 0, p, transfer_size, 1000 /* ms */);
148 "USB control request for firmware upload"
149 " failed. Error number %d\n", r);
152 transfer_size = r & ~1;
154 size -= transfer_size;
155 data += transfer_size;
156 code_offset += transfer_size/sizeof(u16);
159 if (flags & REBOOT) {
162 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
163 USB_REQ_FIRMWARE_CONFIRM,
164 USB_DIR_IN | USB_TYPE_VENDOR,
165 0, 0, &ret, sizeof(ret), 5000 /* ms */);
166 if (r != sizeof(ret)) {
168 "control request firmeware confirmation failed."
169 " Return value %d\n", r);
176 "Internal error while downloading."
177 " Firmware confirm return value %#04x\n",
182 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
192 static u16 get_word(const void *data, u16 offset)
194 const __le16 *p = data;
195 return le16_to_cpu(p[offset]);
198 static char *get_fw_name(char *buffer, size_t size, u8 device_type,
201 scnprintf(buffer, size, "%s%s",
202 device_type == DEVICE_ZD1211B ?
203 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
208 static int handle_version_mismatch(struct usb_device *udev, u8 device_type,
209 const struct firmware *ub_fw)
211 const struct firmware *ur_fw = NULL;
216 r = request_fw_file(&ur_fw,
217 get_fw_name(fw_name, sizeof(fw_name), device_type, "ur"),
222 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
226 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
227 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
228 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
230 /* At this point, the vendor driver downloads the whole firmware
231 * image, hacks around with version IDs, and uploads it again,
232 * completely overwriting the boot code. We do not do this here as
233 * it is not required on any tested devices, and it is suspected to
236 release_firmware(ur_fw);
240 static int upload_firmware(struct usb_device *udev, u8 device_type)
245 const struct firmware *ub_fw = NULL;
246 const struct firmware *uph_fw = NULL;
249 bcdDevice = get_bcdDevice(udev);
251 r = request_fw_file(&ub_fw,
252 get_fw_name(fw_name, sizeof(fw_name), device_type, "ub"),
257 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
259 if (fw_bcdDevice != bcdDevice) {
261 "firmware version %#06x and device bootcode version "
262 "%#06x differ\n", fw_bcdDevice, bcdDevice);
263 if (bcdDevice <= 0x4313)
264 dev_warn(&udev->dev, "device has old bootcode, please "
265 "report success or failure\n");
267 r = handle_version_mismatch(udev, device_type, ub_fw);
271 dev_dbg_f(&udev->dev,
272 "firmware device id %#06x is equal to the "
273 "actual device id\n", fw_bcdDevice);
277 r = request_fw_file(&uph_fw,
278 get_fw_name(fw_name, sizeof(fw_name), device_type, "uphr"),
283 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
286 "Could not upload firmware code uph. Error number %d\n",
292 release_firmware(ub_fw);
293 release_firmware(uph_fw);
297 #define urb_dev(urb) (&(urb)->dev->dev)
299 static inline void handle_regs_int(struct urb *urb)
301 struct zd_usb *usb = urb->context;
302 struct zd_usb_interrupt *intr = &usb->intr;
305 ZD_ASSERT(in_interrupt());
306 spin_lock(&intr->lock);
308 if (intr->read_regs_enabled) {
309 intr->read_regs.length = len = urb->actual_length;
311 if (len > sizeof(intr->read_regs.buffer))
312 len = sizeof(intr->read_regs.buffer);
313 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
314 intr->read_regs_enabled = 0;
315 complete(&intr->read_regs.completion);
319 dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
321 spin_unlock(&intr->lock);
324 static inline void handle_retry_failed_int(struct urb *urb)
326 struct zd_usb *usb = urb->context;
327 struct zd_mac *mac = zd_usb_to_mac(usb);
328 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
330 ieee->stats.tx_errors++;
331 ieee->ieee_stats.tx_retry_limit_exceeded++;
332 dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
336 static void int_urb_complete(struct urb *urb)
339 struct usb_int_header *hdr;
341 switch (urb->status) {
355 if (urb->actual_length < sizeof(hdr)) {
356 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
360 hdr = urb->transfer_buffer;
361 if (hdr->type != USB_INT_TYPE) {
362 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
367 case USB_INT_ID_REGS:
368 handle_regs_int(urb);
370 case USB_INT_ID_RETRY_FAILED:
371 handle_retry_failed_int(urb);
374 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
375 (unsigned int)hdr->id);
380 r = usb_submit_urb(urb, GFP_ATOMIC);
382 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
387 kfree(urb->transfer_buffer);
390 static inline int int_urb_interval(struct usb_device *udev)
392 switch (udev->speed) {
403 static inline int usb_int_enabled(struct zd_usb *usb)
406 struct zd_usb_interrupt *intr = &usb->intr;
409 spin_lock_irqsave(&intr->lock, flags);
411 spin_unlock_irqrestore(&intr->lock, flags);
415 int zd_usb_enable_int(struct zd_usb *usb)
418 struct usb_device *udev;
419 struct zd_usb_interrupt *intr = &usb->intr;
420 void *transfer_buffer = NULL;
423 dev_dbg_f(zd_usb_dev(usb), "\n");
425 urb = usb_alloc_urb(0, GFP_KERNEL);
431 ZD_ASSERT(!irqs_disabled());
432 spin_lock_irq(&intr->lock);
434 spin_unlock_irq(&intr->lock);
439 spin_unlock_irq(&intr->lock);
441 /* TODO: make it a DMA buffer */
443 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
444 if (!transfer_buffer) {
445 dev_dbg_f(zd_usb_dev(usb),
446 "couldn't allocate transfer_buffer\n");
447 goto error_set_urb_null;
450 udev = zd_usb_to_usbdev(usb);
451 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
452 transfer_buffer, USB_MAX_EP_INT_BUFFER,
453 int_urb_complete, usb,
456 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
457 r = usb_submit_urb(urb, GFP_KERNEL);
459 dev_dbg_f(zd_usb_dev(usb),
460 "Couldn't submit urb. Error number %d\n", r);
466 kfree(transfer_buffer);
468 spin_lock_irq(&intr->lock);
470 spin_unlock_irq(&intr->lock);
477 void zd_usb_disable_int(struct zd_usb *usb)
480 struct zd_usb_interrupt *intr = &usb->intr;
483 spin_lock_irqsave(&intr->lock, flags);
486 spin_unlock_irqrestore(&intr->lock, flags);
490 spin_unlock_irqrestore(&intr->lock, flags);
493 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
497 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
501 struct zd_mac *mac = zd_usb_to_mac(usb);
502 const struct rx_length_info *length_info;
504 if (length < sizeof(struct rx_length_info)) {
505 /* It's not a complete packet anyhow. */
506 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
507 ieee->stats.rx_errors++;
508 ieee->stats.rx_length_errors++;
511 length_info = (struct rx_length_info *)
512 (buffer + length - sizeof(struct rx_length_info));
514 /* It might be that three frames are merged into a single URB
515 * transaction. We have to check for the length info tag.
517 * While testing we discovered that length_info might be unaligned,
518 * because if USB transactions are merged, the last packet will not
519 * be padded. Unaligned access might also happen if the length_info
520 * structure is not present.
522 if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
524 unsigned int l, k, n;
525 for (i = 0, l = 0;; i++) {
526 k = le16_to_cpu(get_unaligned(&length_info->length[i]));
532 zd_mac_rx_irq(mac, buffer+l, k);
538 zd_mac_rx_irq(mac, buffer, length);
542 static void rx_urb_complete(struct urb *urb)
545 struct zd_usb_rx *rx;
549 switch (urb->status) {
560 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
564 buffer = urb->transfer_buffer;
565 length = urb->actual_length;
569 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
570 /* If there is an old first fragment, we don't care. */
571 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
572 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
573 spin_lock(&rx->lock);
574 memcpy(rx->fragment, buffer, length);
575 rx->fragment_length = length;
576 spin_unlock(&rx->lock);
580 spin_lock(&rx->lock);
581 if (rx->fragment_length > 0) {
582 /* We are on a second fragment, we believe */
583 ZD_ASSERT(length + rx->fragment_length <=
584 ARRAY_SIZE(rx->fragment));
585 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
586 memcpy(rx->fragment+rx->fragment_length, buffer, length);
587 handle_rx_packet(usb, rx->fragment,
588 rx->fragment_length + length);
589 rx->fragment_length = 0;
590 spin_unlock(&rx->lock);
592 spin_unlock(&rx->lock);
593 handle_rx_packet(usb, buffer, length);
597 usb_submit_urb(urb, GFP_ATOMIC);
600 static struct urb *alloc_urb(struct zd_usb *usb)
602 struct usb_device *udev = zd_usb_to_usbdev(usb);
606 urb = usb_alloc_urb(0, GFP_KERNEL);
609 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
616 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
617 buffer, USB_MAX_RX_SIZE,
618 rx_urb_complete, usb);
619 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
624 static void free_urb(struct urb *urb)
628 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
629 urb->transfer_buffer, urb->transfer_dma);
633 int zd_usb_enable_rx(struct zd_usb *usb)
636 struct zd_usb_rx *rx = &usb->rx;
639 dev_dbg_f(zd_usb_dev(usb), "\n");
642 urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
645 for (i = 0; i < URBS_COUNT; i++) {
646 urbs[i] = alloc_urb(usb);
651 ZD_ASSERT(!irqs_disabled());
652 spin_lock_irq(&rx->lock);
654 spin_unlock_irq(&rx->lock);
659 rx->urbs_count = URBS_COUNT;
660 spin_unlock_irq(&rx->lock);
662 for (i = 0; i < URBS_COUNT; i++) {
663 r = usb_submit_urb(urbs[i], GFP_KERNEL);
670 for (i = 0; i < URBS_COUNT; i++) {
671 usb_kill_urb(urbs[i]);
673 spin_lock_irq(&rx->lock);
676 spin_unlock_irq(&rx->lock);
679 for (i = 0; i < URBS_COUNT; i++)
685 void zd_usb_disable_rx(struct zd_usb *usb)
691 struct zd_usb_rx *rx = &usb->rx;
693 spin_lock_irqsave(&rx->lock, flags);
695 count = rx->urbs_count;
696 spin_unlock_irqrestore(&rx->lock, flags);
700 for (i = 0; i < count; i++) {
701 usb_kill_urb(urbs[i]);
706 spin_lock_irqsave(&rx->lock, flags);
709 spin_unlock_irqrestore(&rx->lock, flags);
712 static void tx_urb_complete(struct urb *urb)
716 switch (urb->status) {
725 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
728 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
732 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
733 urb->transfer_buffer, urb->transfer_dma);
737 r = usb_submit_urb(urb, GFP_ATOMIC);
739 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
744 /* Puts the frame on the USB endpoint. It doesn't wait for
745 * completion. The frame must contain the control set.
747 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
750 struct usb_device *udev = zd_usb_to_usbdev(usb);
754 urb = usb_alloc_urb(0, GFP_ATOMIC);
760 buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
766 memcpy(buffer, frame, length);
768 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
769 buffer, length, tx_urb_complete, NULL);
770 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
772 r = usb_submit_urb(urb, GFP_ATOMIC);
777 usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
785 static inline void init_usb_interrupt(struct zd_usb *usb)
787 struct zd_usb_interrupt *intr = &usb->intr;
789 spin_lock_init(&intr->lock);
790 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
791 init_completion(&intr->read_regs.completion);
792 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
795 static inline void init_usb_rx(struct zd_usb *usb)
797 struct zd_usb_rx *rx = &usb->rx;
798 spin_lock_init(&rx->lock);
799 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
800 rx->usb_packet_size = 512;
802 rx->usb_packet_size = 64;
804 ZD_ASSERT(rx->fragment_length == 0);
807 static inline void init_usb_tx(struct zd_usb *usb)
809 /* FIXME: at this point we will allocate a fixed number of urb's for
810 * use in a cyclic scheme */
813 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
814 struct usb_interface *intf)
816 memset(usb, 0, sizeof(*usb));
817 usb->intf = usb_get_intf(intf);
818 usb_set_intfdata(usb->intf, netdev);
819 init_usb_interrupt(usb);
824 void zd_usb_clear(struct zd_usb *usb)
826 usb_set_intfdata(usb->intf, NULL);
827 usb_put_intf(usb->intf);
828 ZD_MEMCLEAR(usb, sizeof(*usb));
829 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
832 static const char *speed(enum usb_device_speed speed)
842 return "unknown speed";
846 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
848 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
849 le16_to_cpu(udev->descriptor.idVendor),
850 le16_to_cpu(udev->descriptor.idProduct),
855 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
857 struct usb_device *udev = interface_to_usbdev(usb->intf);
858 return scnprint_id(udev, buffer, size);
862 static void print_id(struct usb_device *udev)
866 scnprint_id(udev, buffer, sizeof(buffer));
867 buffer[sizeof(buffer)-1] = 0;
868 dev_dbg_f(&udev->dev, "%s\n", buffer);
871 #define print_id(udev) do { } while (0)
874 static int eject_installer(struct usb_interface *intf)
876 struct usb_device *udev = interface_to_usbdev(intf);
877 struct usb_host_interface *iface_desc = &intf->altsetting[0];
878 struct usb_endpoint_descriptor *endpoint;
883 /* Find bulk out endpoint */
884 endpoint = &iface_desc->endpoint[1].desc;
885 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
886 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
887 USB_ENDPOINT_XFER_BULK) {
888 bulk_out_ep = endpoint->bEndpointAddress;
891 "zd1211rw: Could not find bulk out endpoint\n");
895 cmd = kzalloc(31, GFP_KERNEL);
899 /* USB bulk command block */
900 cmd[0] = 0x55; /* bulk command signature */
901 cmd[1] = 0x53; /* bulk command signature */
902 cmd[2] = 0x42; /* bulk command signature */
903 cmd[3] = 0x43; /* bulk command signature */
904 cmd[14] = 6; /* command length */
906 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
907 cmd[19] = 0x2; /* eject disc */
909 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
910 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
911 cmd, 31, NULL, 2000);
916 /* At this point, the device disconnects and reconnects with the real
919 usb_set_intfdata(intf, NULL);
923 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
926 struct usb_device *udev = interface_to_usbdev(intf);
927 struct net_device *netdev = NULL;
931 if (id->driver_info & DEVICE_INSTALLER)
932 return eject_installer(intf);
934 switch (udev->speed) {
940 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
945 usb_reset_device(interface_to_usbdev(intf));
947 netdev = zd_netdev_alloc(intf);
948 if (netdev == NULL) {
953 r = upload_firmware(udev, id->driver_info);
956 "couldn't load firmware. Error number %d\n", r);
960 r = usb_reset_configuration(udev);
962 dev_dbg_f(&intf->dev,
963 "couldn't reset configuration. Error number %d\n", r);
967 /* At this point the interrupt endpoint is not generally enabled. We
968 * save the USB bandwidth until the network device is opened. But
969 * notify that the initialization of the MAC will require the
970 * interrupts to be temporary enabled.
972 r = zd_mac_init_hw(zd_netdev_mac(netdev), id->driver_info);
974 dev_dbg_f(&intf->dev,
975 "couldn't initialize mac. Error number %d\n", r);
979 r = register_netdev(netdev);
981 dev_dbg_f(&intf->dev,
982 "couldn't register netdev. Error number %d\n", r);
986 dev_dbg_f(&intf->dev, "successful\n");
987 dev_info(&intf->dev,"%s\n", netdev->name);
990 usb_reset_device(interface_to_usbdev(intf));
991 zd_netdev_free(netdev);
995 static void disconnect(struct usb_interface *intf)
997 struct net_device *netdev = zd_intf_to_netdev(intf);
998 struct zd_mac *mac = zd_netdev_mac(netdev);
999 struct zd_usb *usb = &mac->chip.usb;
1001 /* Either something really bad happened, or we're just dealing with
1002 * a DEVICE_INSTALLER. */
1006 dev_dbg_f(zd_usb_dev(usb), "\n");
1008 zd_netdev_disconnect(netdev);
1010 /* Just in case something has gone wrong! */
1011 zd_usb_disable_rx(usb);
1012 zd_usb_disable_int(usb);
1014 /* If the disconnect has been caused by a removal of the
1015 * driver module, the reset allows reloading of the driver. If the
1016 * reset will not be executed here, the upload of the firmware in the
1017 * probe function caused by the reloading of the driver will fail.
1019 usb_reset_device(interface_to_usbdev(intf));
1021 zd_netdev_free(netdev);
1022 dev_dbg(&intf->dev, "disconnected\n");
1025 static struct usb_driver driver = {
1027 .id_table = usb_ids,
1029 .disconnect = disconnect,
1032 struct workqueue_struct *zd_workqueue;
1034 static int __init usb_init(void)
1038 pr_debug("%s usb_init()\n", driver.name);
1040 zd_workqueue = create_singlethread_workqueue(driver.name);
1041 if (zd_workqueue == NULL) {
1042 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1046 r = usb_register(&driver);
1048 destroy_workqueue(zd_workqueue);
1049 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1054 pr_debug("%s initialized\n", driver.name);
1058 static void __exit usb_exit(void)
1060 pr_debug("%s usb_exit()\n", driver.name);
1061 usb_deregister(&driver);
1062 destroy_workqueue(zd_workqueue);
1065 module_init(usb_init);
1066 module_exit(usb_exit);
1068 static int usb_int_regs_length(unsigned int count)
1070 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1073 static void prepare_read_regs_int(struct zd_usb *usb)
1075 struct zd_usb_interrupt *intr = &usb->intr;
1077 spin_lock_irq(&intr->lock);
1078 intr->read_regs_enabled = 1;
1079 INIT_COMPLETION(intr->read_regs.completion);
1080 spin_unlock_irq(&intr->lock);
1083 static void disable_read_regs_int(struct zd_usb *usb)
1085 struct zd_usb_interrupt *intr = &usb->intr;
1087 spin_lock_irq(&intr->lock);
1088 intr->read_regs_enabled = 0;
1089 spin_unlock_irq(&intr->lock);
1092 static int get_results(struct zd_usb *usb, u16 *values,
1093 struct usb_req_read_regs *req, unsigned int count)
1097 struct zd_usb_interrupt *intr = &usb->intr;
1098 struct read_regs_int *rr = &intr->read_regs;
1099 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1101 spin_lock_irq(&intr->lock);
1104 /* The created block size seems to be larger than expected.
1105 * However results appear to be correct.
1107 if (rr->length < usb_int_regs_length(count)) {
1108 dev_dbg_f(zd_usb_dev(usb),
1109 "error: actual length %d less than expected %d\n",
1110 rr->length, usb_int_regs_length(count));
1113 if (rr->length > sizeof(rr->buffer)) {
1114 dev_dbg_f(zd_usb_dev(usb),
1115 "error: actual length %d exceeds buffer size %zu\n",
1116 rr->length, sizeof(rr->buffer));
1120 for (i = 0; i < count; i++) {
1121 struct reg_data *rd = ®s->regs[i];
1122 if (rd->addr != req->addr[i]) {
1123 dev_dbg_f(zd_usb_dev(usb),
1124 "rd[%d] addr %#06hx expected %#06hx\n", i,
1125 le16_to_cpu(rd->addr),
1126 le16_to_cpu(req->addr[i]));
1129 values[i] = le16_to_cpu(rd->value);
1134 spin_unlock_irq(&intr->lock);
1138 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1139 const zd_addr_t *addresses, unsigned int count)
1142 int i, req_len, actual_req_len;
1143 struct usb_device *udev;
1144 struct usb_req_read_regs *req = NULL;
1145 unsigned long timeout;
1148 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1151 if (count > USB_MAX_IOREAD16_COUNT) {
1152 dev_dbg_f(zd_usb_dev(usb),
1153 "error: count %u exceeds possible max %u\n",
1154 count, USB_MAX_IOREAD16_COUNT);
1158 dev_dbg_f(zd_usb_dev(usb),
1159 "error: io in atomic context not supported\n");
1160 return -EWOULDBLOCK;
1162 if (!usb_int_enabled(usb)) {
1163 dev_dbg_f(zd_usb_dev(usb),
1164 "error: usb interrupt not enabled\n");
1165 return -EWOULDBLOCK;
1168 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1169 req = kmalloc(req_len, GFP_KERNEL);
1172 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1173 for (i = 0; i < count; i++)
1174 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1176 udev = zd_usb_to_usbdev(usb);
1177 prepare_read_regs_int(usb);
1178 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1179 req, req_len, &actual_req_len, 1000 /* ms */);
1181 dev_dbg_f(zd_usb_dev(usb),
1182 "error in usb_bulk_msg(). Error number %d\n", r);
1185 if (req_len != actual_req_len) {
1186 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1187 " req_len %d != actual_req_len %d\n",
1188 req_len, actual_req_len);
1193 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1194 msecs_to_jiffies(1000));
1196 disable_read_regs_int(usb);
1197 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1202 r = get_results(usb, values, req, count);
1208 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1212 struct usb_device *udev;
1213 struct usb_req_write_regs *req = NULL;
1214 int i, req_len, actual_req_len;
1218 if (count > USB_MAX_IOWRITE16_COUNT) {
1219 dev_dbg_f(zd_usb_dev(usb),
1220 "error: count %u exceeds possible max %u\n",
1221 count, USB_MAX_IOWRITE16_COUNT);
1225 dev_dbg_f(zd_usb_dev(usb),
1226 "error: io in atomic context not supported\n");
1227 return -EWOULDBLOCK;
1230 req_len = sizeof(struct usb_req_write_regs) +
1231 count * sizeof(struct reg_data);
1232 req = kmalloc(req_len, GFP_KERNEL);
1236 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1237 for (i = 0; i < count; i++) {
1238 struct reg_data *rw = &req->reg_writes[i];
1239 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1240 rw->value = cpu_to_le16(ioreqs[i].value);
1243 udev = zd_usb_to_usbdev(usb);
1244 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1245 req, req_len, &actual_req_len, 1000 /* ms */);
1247 dev_dbg_f(zd_usb_dev(usb),
1248 "error in usb_bulk_msg(). Error number %d\n", r);
1251 if (req_len != actual_req_len) {
1252 dev_dbg_f(zd_usb_dev(usb),
1253 "error in usb_bulk_msg()"
1254 " req_len %d != actual_req_len %d\n",
1255 req_len, actual_req_len);
1260 /* FALL-THROUGH with r == 0 */
1266 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1269 struct usb_device *udev;
1270 struct usb_req_rfwrite *req = NULL;
1271 int i, req_len, actual_req_len;
1272 u16 bit_value_template;
1275 dev_dbg_f(zd_usb_dev(usb),
1276 "error: io in atomic context not supported\n");
1277 return -EWOULDBLOCK;
1279 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1280 dev_dbg_f(zd_usb_dev(usb),
1281 "error: bits %d are smaller than"
1282 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1283 bits, USB_MIN_RFWRITE_BIT_COUNT);
1286 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1287 dev_dbg_f(zd_usb_dev(usb),
1288 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1289 bits, USB_MAX_RFWRITE_BIT_COUNT);
1293 if (value & (~0UL << bits)) {
1294 dev_dbg_f(zd_usb_dev(usb),
1295 "error: value %#09x has bits >= %d set\n",
1301 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1303 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1305 dev_dbg_f(zd_usb_dev(usb),
1306 "error %d: Couldn't read CR203\n", r);
1309 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1311 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1312 req = kmalloc(req_len, GFP_KERNEL);
1316 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1317 /* 1: 3683a, but not used in ZYDAS driver */
1318 req->value = cpu_to_le16(2);
1319 req->bits = cpu_to_le16(bits);
1321 for (i = 0; i < bits; i++) {
1322 u16 bv = bit_value_template;
1323 if (value & (1 << (bits-1-i)))
1325 req->bit_values[i] = cpu_to_le16(bv);
1328 udev = zd_usb_to_usbdev(usb);
1329 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1330 req, req_len, &actual_req_len, 1000 /* ms */);
1332 dev_dbg_f(zd_usb_dev(usb),
1333 "error in usb_bulk_msg(). Error number %d\n", r);
1336 if (req_len != actual_req_len) {
1337 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1338 " req_len %d != actual_req_len %d\n",
1339 req_len, actual_req_len);
1344 /* FALL-THROUGH with r == 0 */