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 },
58 { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
59 { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
60 { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
61 { USB_DEVICE(0x1582, 0x6003), .driver_info = DEVICE_ZD1211B },
62 { USB_DEVICE(0x050d, 0x705c), .driver_info = DEVICE_ZD1211B },
63 { USB_DEVICE(0x083a, 0x4505), .driver_info = DEVICE_ZD1211B },
64 { USB_DEVICE(0x0471, 0x1236), .driver_info = DEVICE_ZD1211B },
65 { USB_DEVICE(0x13b1, 0x0024), .driver_info = DEVICE_ZD1211B },
66 { USB_DEVICE(0x0586, 0x340f), .driver_info = DEVICE_ZD1211B },
67 { USB_DEVICE(0x0b05, 0x171b), .driver_info = DEVICE_ZD1211B },
68 { USB_DEVICE(0x0586, 0x3410), .driver_info = DEVICE_ZD1211B },
69 { USB_DEVICE(0x0baf, 0x0121), .driver_info = DEVICE_ZD1211B },
70 { USB_DEVICE(0x0586, 0x3412), .driver_info = DEVICE_ZD1211B },
71 { USB_DEVICE(0x0586, 0x3413), .driver_info = DEVICE_ZD1211B },
72 { USB_DEVICE(0x0053, 0x5301), .driver_info = DEVICE_ZD1211B },
73 /* "Driverless" devices that need ejecting */
74 { USB_DEVICE(0x0ace, 0x2011), .driver_info = DEVICE_INSTALLER },
75 { USB_DEVICE(0x0ace, 0x20ff), .driver_info = DEVICE_INSTALLER },
79 MODULE_LICENSE("GPL");
80 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
81 MODULE_AUTHOR("Ulrich Kunitz");
82 MODULE_AUTHOR("Daniel Drake");
83 MODULE_VERSION("1.0");
84 MODULE_DEVICE_TABLE(usb, usb_ids);
86 #define FW_ZD1211_PREFIX "zd1211/zd1211_"
87 #define FW_ZD1211B_PREFIX "zd1211/zd1211b_"
89 /* USB device initialization */
91 static int request_fw_file(
92 const struct firmware **fw, const char *name, struct device *device)
96 dev_dbg_f(device, "fw name %s\n", name);
98 r = request_firmware(fw, name, device);
101 "Could not load firmware file %s. Error number %d\n",
106 static inline u16 get_bcdDevice(const struct usb_device *udev)
108 return le16_to_cpu(udev->descriptor.bcdDevice);
111 enum upload_code_flags {
115 /* Ensures that MAX_TRANSFER_SIZE is even. */
116 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
118 static int upload_code(struct usb_device *udev,
119 const u8 *data, size_t size, u16 code_offset, int flags)
124 /* USB request blocks need "kmalloced" buffers.
126 p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
128 dev_err(&udev->dev, "out of memory\n");
135 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
136 size : MAX_TRANSFER_SIZE;
138 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
140 memcpy(p, data, transfer_size);
141 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
142 USB_REQ_FIRMWARE_DOWNLOAD,
143 USB_DIR_OUT | USB_TYPE_VENDOR,
144 code_offset, 0, p, transfer_size, 1000 /* ms */);
147 "USB control request for firmware upload"
148 " failed. Error number %d\n", r);
151 transfer_size = r & ~1;
153 size -= transfer_size;
154 data += transfer_size;
155 code_offset += transfer_size/sizeof(u16);
158 if (flags & REBOOT) {
161 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
162 USB_REQ_FIRMWARE_CONFIRM,
163 USB_DIR_IN | USB_TYPE_VENDOR,
164 0, 0, &ret, sizeof(ret), 5000 /* ms */);
165 if (r != sizeof(ret)) {
167 "control request firmeware confirmation failed."
168 " Return value %d\n", r);
175 "Internal error while downloading."
176 " Firmware confirm return value %#04x\n",
181 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
191 static u16 get_word(const void *data, u16 offset)
193 const __le16 *p = data;
194 return le16_to_cpu(p[offset]);
197 static char *get_fw_name(char *buffer, size_t size, u8 device_type,
200 scnprintf(buffer, size, "%s%s",
201 device_type == DEVICE_ZD1211B ?
202 FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
207 static int handle_version_mismatch(struct usb_device *udev, u8 device_type,
208 const struct firmware *ub_fw)
210 const struct firmware *ur_fw = NULL;
215 r = request_fw_file(&ur_fw,
216 get_fw_name(fw_name, sizeof(fw_name), device_type, "ur"),
221 r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START, REBOOT);
225 offset = (E2P_BOOT_CODE_OFFSET * sizeof(u16));
226 r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
227 E2P_START + E2P_BOOT_CODE_OFFSET, REBOOT);
229 /* At this point, the vendor driver downloads the whole firmware
230 * image, hacks around with version IDs, and uploads it again,
231 * completely overwriting the boot code. We do not do this here as
232 * it is not required on any tested devices, and it is suspected to
235 release_firmware(ur_fw);
239 static int upload_firmware(struct usb_device *udev, u8 device_type)
244 const struct firmware *ub_fw = NULL;
245 const struct firmware *uph_fw = NULL;
248 bcdDevice = get_bcdDevice(udev);
250 r = request_fw_file(&ub_fw,
251 get_fw_name(fw_name, sizeof(fw_name), device_type, "ub"),
256 fw_bcdDevice = get_word(ub_fw->data, E2P_DATA_OFFSET);
258 if (fw_bcdDevice != bcdDevice) {
260 "firmware version %#06x and device bootcode version "
261 "%#06x differ\n", fw_bcdDevice, bcdDevice);
262 if (bcdDevice <= 0x4313)
263 dev_warn(&udev->dev, "device has old bootcode, please "
264 "report success or failure\n");
266 r = handle_version_mismatch(udev, device_type, ub_fw);
270 dev_dbg_f(&udev->dev,
271 "firmware device id %#06x is equal to the "
272 "actual device id\n", fw_bcdDevice);
276 r = request_fw_file(&uph_fw,
277 get_fw_name(fw_name, sizeof(fw_name), device_type, "uphr"),
282 r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START, REBOOT);
285 "Could not upload firmware code uph. Error number %d\n",
291 release_firmware(ub_fw);
292 release_firmware(uph_fw);
296 #define urb_dev(urb) (&(urb)->dev->dev)
298 static inline void handle_regs_int(struct urb *urb)
300 struct zd_usb *usb = urb->context;
301 struct zd_usb_interrupt *intr = &usb->intr;
304 ZD_ASSERT(in_interrupt());
305 spin_lock(&intr->lock);
307 if (intr->read_regs_enabled) {
308 intr->read_regs.length = len = urb->actual_length;
310 if (len > sizeof(intr->read_regs.buffer))
311 len = sizeof(intr->read_regs.buffer);
312 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
313 intr->read_regs_enabled = 0;
314 complete(&intr->read_regs.completion);
318 dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
320 spin_unlock(&intr->lock);
323 static inline void handle_retry_failed_int(struct urb *urb)
325 struct zd_usb *usb = urb->context;
326 struct zd_mac *mac = zd_usb_to_mac(usb);
327 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
329 ieee->stats.tx_errors++;
330 ieee->ieee_stats.tx_retry_limit_exceeded++;
331 dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
335 static void int_urb_complete(struct urb *urb)
338 struct usb_int_header *hdr;
340 switch (urb->status) {
354 if (urb->actual_length < sizeof(hdr)) {
355 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
359 hdr = urb->transfer_buffer;
360 if (hdr->type != USB_INT_TYPE) {
361 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
366 case USB_INT_ID_REGS:
367 handle_regs_int(urb);
369 case USB_INT_ID_RETRY_FAILED:
370 handle_retry_failed_int(urb);
373 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
374 (unsigned int)hdr->id);
379 r = usb_submit_urb(urb, GFP_ATOMIC);
381 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
386 kfree(urb->transfer_buffer);
389 static inline int int_urb_interval(struct usb_device *udev)
391 switch (udev->speed) {
402 static inline int usb_int_enabled(struct zd_usb *usb)
405 struct zd_usb_interrupt *intr = &usb->intr;
408 spin_lock_irqsave(&intr->lock, flags);
410 spin_unlock_irqrestore(&intr->lock, flags);
414 int zd_usb_enable_int(struct zd_usb *usb)
417 struct usb_device *udev;
418 struct zd_usb_interrupt *intr = &usb->intr;
419 void *transfer_buffer = NULL;
422 dev_dbg_f(zd_usb_dev(usb), "\n");
424 urb = usb_alloc_urb(0, GFP_KERNEL);
430 ZD_ASSERT(!irqs_disabled());
431 spin_lock_irq(&intr->lock);
433 spin_unlock_irq(&intr->lock);
438 spin_unlock_irq(&intr->lock);
440 /* TODO: make it a DMA buffer */
442 transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_KERNEL);
443 if (!transfer_buffer) {
444 dev_dbg_f(zd_usb_dev(usb),
445 "couldn't allocate transfer_buffer\n");
446 goto error_set_urb_null;
449 udev = zd_usb_to_usbdev(usb);
450 usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
451 transfer_buffer, USB_MAX_EP_INT_BUFFER,
452 int_urb_complete, usb,
455 dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
456 r = usb_submit_urb(urb, GFP_KERNEL);
458 dev_dbg_f(zd_usb_dev(usb),
459 "Couldn't submit urb. Error number %d\n", r);
465 kfree(transfer_buffer);
467 spin_lock_irq(&intr->lock);
469 spin_unlock_irq(&intr->lock);
476 void zd_usb_disable_int(struct zd_usb *usb)
479 struct zd_usb_interrupt *intr = &usb->intr;
482 spin_lock_irqsave(&intr->lock, flags);
485 spin_unlock_irqrestore(&intr->lock, flags);
489 spin_unlock_irqrestore(&intr->lock, flags);
492 dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
496 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
500 struct zd_mac *mac = zd_usb_to_mac(usb);
501 const struct rx_length_info *length_info;
503 if (length < sizeof(struct rx_length_info)) {
504 /* It's not a complete packet anyhow. */
505 struct ieee80211_device *ieee = zd_mac_to_ieee80211(mac);
506 ieee->stats.rx_errors++;
507 ieee->stats.rx_length_errors++;
510 length_info = (struct rx_length_info *)
511 (buffer + length - sizeof(struct rx_length_info));
513 /* It might be that three frames are merged into a single URB
514 * transaction. We have to check for the length info tag.
516 * While testing we discovered that length_info might be unaligned,
517 * because if USB transactions are merged, the last packet will not
518 * be padded. Unaligned access might also happen if the length_info
519 * structure is not present.
521 if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
523 unsigned int l, k, n;
524 for (i = 0, l = 0;; i++) {
525 k = le16_to_cpu(get_unaligned(&length_info->length[i]));
531 zd_mac_rx_irq(mac, buffer+l, k);
537 zd_mac_rx_irq(mac, buffer, length);
541 static void rx_urb_complete(struct urb *urb)
544 struct zd_usb_rx *rx;
548 switch (urb->status) {
559 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
563 buffer = urb->transfer_buffer;
564 length = urb->actual_length;
568 if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
569 /* If there is an old first fragment, we don't care. */
570 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
571 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
572 spin_lock(&rx->lock);
573 memcpy(rx->fragment, buffer, length);
574 rx->fragment_length = length;
575 spin_unlock(&rx->lock);
579 spin_lock(&rx->lock);
580 if (rx->fragment_length > 0) {
581 /* We are on a second fragment, we believe */
582 ZD_ASSERT(length + rx->fragment_length <=
583 ARRAY_SIZE(rx->fragment));
584 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
585 memcpy(rx->fragment+rx->fragment_length, buffer, length);
586 handle_rx_packet(usb, rx->fragment,
587 rx->fragment_length + length);
588 rx->fragment_length = 0;
589 spin_unlock(&rx->lock);
591 spin_unlock(&rx->lock);
592 handle_rx_packet(usb, buffer, length);
596 usb_submit_urb(urb, GFP_ATOMIC);
599 static struct urb *alloc_urb(struct zd_usb *usb)
601 struct usb_device *udev = zd_usb_to_usbdev(usb);
605 urb = usb_alloc_urb(0, GFP_KERNEL);
608 buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_KERNEL,
615 usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
616 buffer, USB_MAX_RX_SIZE,
617 rx_urb_complete, usb);
618 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
623 static void free_urb(struct urb *urb)
627 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
628 urb->transfer_buffer, urb->transfer_dma);
632 int zd_usb_enable_rx(struct zd_usb *usb)
635 struct zd_usb_rx *rx = &usb->rx;
638 dev_dbg_f(zd_usb_dev(usb), "\n");
641 urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_KERNEL);
644 for (i = 0; i < URBS_COUNT; i++) {
645 urbs[i] = alloc_urb(usb);
650 ZD_ASSERT(!irqs_disabled());
651 spin_lock_irq(&rx->lock);
653 spin_unlock_irq(&rx->lock);
658 rx->urbs_count = URBS_COUNT;
659 spin_unlock_irq(&rx->lock);
661 for (i = 0; i < URBS_COUNT; i++) {
662 r = usb_submit_urb(urbs[i], GFP_KERNEL);
669 for (i = 0; i < URBS_COUNT; i++) {
670 usb_kill_urb(urbs[i]);
672 spin_lock_irq(&rx->lock);
675 spin_unlock_irq(&rx->lock);
678 for (i = 0; i < URBS_COUNT; i++)
684 void zd_usb_disable_rx(struct zd_usb *usb)
690 struct zd_usb_rx *rx = &usb->rx;
692 spin_lock_irqsave(&rx->lock, flags);
694 count = rx->urbs_count;
695 spin_unlock_irqrestore(&rx->lock, flags);
699 for (i = 0; i < count; i++) {
700 usb_kill_urb(urbs[i]);
705 spin_lock_irqsave(&rx->lock, flags);
708 spin_unlock_irqrestore(&rx->lock, flags);
711 static void tx_urb_complete(struct urb *urb)
715 switch (urb->status) {
724 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
727 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
731 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
732 urb->transfer_buffer, urb->transfer_dma);
736 r = usb_submit_urb(urb, GFP_ATOMIC);
738 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
743 /* Puts the frame on the USB endpoint. It doesn't wait for
744 * completion. The frame must contain the control set.
746 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
749 struct usb_device *udev = zd_usb_to_usbdev(usb);
753 urb = usb_alloc_urb(0, GFP_ATOMIC);
759 buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
765 memcpy(buffer, frame, length);
767 usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
768 buffer, length, tx_urb_complete, NULL);
769 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
771 r = usb_submit_urb(urb, GFP_ATOMIC);
776 usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
784 static inline void init_usb_interrupt(struct zd_usb *usb)
786 struct zd_usb_interrupt *intr = &usb->intr;
788 spin_lock_init(&intr->lock);
789 intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
790 init_completion(&intr->read_regs.completion);
791 intr->read_regs.cr_int_addr = cpu_to_le16((u16)CR_INTERRUPT);
794 static inline void init_usb_rx(struct zd_usb *usb)
796 struct zd_usb_rx *rx = &usb->rx;
797 spin_lock_init(&rx->lock);
798 if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
799 rx->usb_packet_size = 512;
801 rx->usb_packet_size = 64;
803 ZD_ASSERT(rx->fragment_length == 0);
806 static inline void init_usb_tx(struct zd_usb *usb)
808 /* FIXME: at this point we will allocate a fixed number of urb's for
809 * use in a cyclic scheme */
812 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
813 struct usb_interface *intf)
815 memset(usb, 0, sizeof(*usb));
816 usb->intf = usb_get_intf(intf);
817 usb_set_intfdata(usb->intf, netdev);
818 init_usb_interrupt(usb);
823 void zd_usb_clear(struct zd_usb *usb)
825 usb_set_intfdata(usb->intf, NULL);
826 usb_put_intf(usb->intf);
827 ZD_MEMCLEAR(usb, sizeof(*usb));
828 /* FIXME: usb_interrupt, usb_tx, usb_rx? */
831 static const char *speed(enum usb_device_speed speed)
841 return "unknown speed";
845 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
847 return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
848 le16_to_cpu(udev->descriptor.idVendor),
849 le16_to_cpu(udev->descriptor.idProduct),
854 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
856 struct usb_device *udev = interface_to_usbdev(usb->intf);
857 return scnprint_id(udev, buffer, size);
861 static void print_id(struct usb_device *udev)
865 scnprint_id(udev, buffer, sizeof(buffer));
866 buffer[sizeof(buffer)-1] = 0;
867 dev_dbg_f(&udev->dev, "%s\n", buffer);
870 #define print_id(udev) do { } while (0)
873 static int eject_installer(struct usb_interface *intf)
875 struct usb_device *udev = interface_to_usbdev(intf);
876 struct usb_host_interface *iface_desc = &intf->altsetting[0];
877 struct usb_endpoint_descriptor *endpoint;
882 /* Find bulk out endpoint */
883 endpoint = &iface_desc->endpoint[1].desc;
884 if ((endpoint->bEndpointAddress & USB_TYPE_MASK) == USB_DIR_OUT &&
885 (endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
886 USB_ENDPOINT_XFER_BULK) {
887 bulk_out_ep = endpoint->bEndpointAddress;
890 "zd1211rw: Could not find bulk out endpoint\n");
894 cmd = kzalloc(31, GFP_KERNEL);
898 /* USB bulk command block */
899 cmd[0] = 0x55; /* bulk command signature */
900 cmd[1] = 0x53; /* bulk command signature */
901 cmd[2] = 0x42; /* bulk command signature */
902 cmd[3] = 0x43; /* bulk command signature */
903 cmd[14] = 6; /* command length */
905 cmd[15] = 0x1b; /* SCSI command: START STOP UNIT */
906 cmd[19] = 0x2; /* eject disc */
908 dev_info(&udev->dev, "Ejecting virtual installer media...\n");
909 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, bulk_out_ep),
910 cmd, 31, NULL, 2000);
915 /* At this point, the device disconnects and reconnects with the real
918 usb_set_intfdata(intf, NULL);
922 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
925 struct usb_device *udev = interface_to_usbdev(intf);
926 struct net_device *netdev = NULL;
930 if (id->driver_info & DEVICE_INSTALLER)
931 return eject_installer(intf);
933 switch (udev->speed) {
939 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
944 usb_reset_device(interface_to_usbdev(intf));
946 netdev = zd_netdev_alloc(intf);
947 if (netdev == NULL) {
952 r = upload_firmware(udev, id->driver_info);
955 "couldn't load firmware. Error number %d\n", r);
959 r = usb_reset_configuration(udev);
961 dev_dbg_f(&intf->dev,
962 "couldn't reset configuration. Error number %d\n", r);
966 /* At this point the interrupt endpoint is not generally enabled. We
967 * save the USB bandwidth until the network device is opened. But
968 * notify that the initialization of the MAC will require the
969 * interrupts to be temporary enabled.
971 r = zd_mac_init_hw(zd_netdev_mac(netdev), id->driver_info);
973 dev_dbg_f(&intf->dev,
974 "couldn't initialize mac. Error number %d\n", r);
978 r = register_netdev(netdev);
980 dev_dbg_f(&intf->dev,
981 "couldn't register netdev. Error number %d\n", r);
985 dev_dbg_f(&intf->dev, "successful\n");
986 dev_info(&intf->dev,"%s\n", netdev->name);
989 usb_reset_device(interface_to_usbdev(intf));
990 zd_netdev_free(netdev);
994 static void disconnect(struct usb_interface *intf)
996 struct net_device *netdev = zd_intf_to_netdev(intf);
997 struct zd_mac *mac = zd_netdev_mac(netdev);
998 struct zd_usb *usb = &mac->chip.usb;
1000 /* Either something really bad happened, or we're just dealing with
1001 * a DEVICE_INSTALLER. */
1005 dev_dbg_f(zd_usb_dev(usb), "\n");
1007 zd_netdev_disconnect(netdev);
1009 /* Just in case something has gone wrong! */
1010 zd_usb_disable_rx(usb);
1011 zd_usb_disable_int(usb);
1013 /* If the disconnect has been caused by a removal of the
1014 * driver module, the reset allows reloading of the driver. If the
1015 * reset will not be executed here, the upload of the firmware in the
1016 * probe function caused by the reloading of the driver will fail.
1018 usb_reset_device(interface_to_usbdev(intf));
1020 zd_netdev_free(netdev);
1021 dev_dbg(&intf->dev, "disconnected\n");
1024 static struct usb_driver driver = {
1026 .id_table = usb_ids,
1028 .disconnect = disconnect,
1031 struct workqueue_struct *zd_workqueue;
1033 static int __init usb_init(void)
1037 pr_debug("%s usb_init()\n", driver.name);
1039 zd_workqueue = create_singlethread_workqueue(driver.name);
1040 if (zd_workqueue == NULL) {
1041 printk(KERN_ERR "%s couldn't create workqueue\n", driver.name);
1045 r = usb_register(&driver);
1047 destroy_workqueue(zd_workqueue);
1048 printk(KERN_ERR "%s usb_register() failed. Error number %d\n",
1053 pr_debug("%s initialized\n", driver.name);
1057 static void __exit usb_exit(void)
1059 pr_debug("%s usb_exit()\n", driver.name);
1060 usb_deregister(&driver);
1061 destroy_workqueue(zd_workqueue);
1064 module_init(usb_init);
1065 module_exit(usb_exit);
1067 static int usb_int_regs_length(unsigned int count)
1069 return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1072 static void prepare_read_regs_int(struct zd_usb *usb)
1074 struct zd_usb_interrupt *intr = &usb->intr;
1076 spin_lock_irq(&intr->lock);
1077 intr->read_regs_enabled = 1;
1078 INIT_COMPLETION(intr->read_regs.completion);
1079 spin_unlock_irq(&intr->lock);
1082 static void disable_read_regs_int(struct zd_usb *usb)
1084 struct zd_usb_interrupt *intr = &usb->intr;
1086 spin_lock_irq(&intr->lock);
1087 intr->read_regs_enabled = 0;
1088 spin_unlock_irq(&intr->lock);
1091 static int get_results(struct zd_usb *usb, u16 *values,
1092 struct usb_req_read_regs *req, unsigned int count)
1096 struct zd_usb_interrupt *intr = &usb->intr;
1097 struct read_regs_int *rr = &intr->read_regs;
1098 struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1100 spin_lock_irq(&intr->lock);
1103 /* The created block size seems to be larger than expected.
1104 * However results appear to be correct.
1106 if (rr->length < usb_int_regs_length(count)) {
1107 dev_dbg_f(zd_usb_dev(usb),
1108 "error: actual length %d less than expected %d\n",
1109 rr->length, usb_int_regs_length(count));
1112 if (rr->length > sizeof(rr->buffer)) {
1113 dev_dbg_f(zd_usb_dev(usb),
1114 "error: actual length %d exceeds buffer size %zu\n",
1115 rr->length, sizeof(rr->buffer));
1119 for (i = 0; i < count; i++) {
1120 struct reg_data *rd = ®s->regs[i];
1121 if (rd->addr != req->addr[i]) {
1122 dev_dbg_f(zd_usb_dev(usb),
1123 "rd[%d] addr %#06hx expected %#06hx\n", i,
1124 le16_to_cpu(rd->addr),
1125 le16_to_cpu(req->addr[i]));
1128 values[i] = le16_to_cpu(rd->value);
1133 spin_unlock_irq(&intr->lock);
1137 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1138 const zd_addr_t *addresses, unsigned int count)
1141 int i, req_len, actual_req_len;
1142 struct usb_device *udev;
1143 struct usb_req_read_regs *req = NULL;
1144 unsigned long timeout;
1147 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1150 if (count > USB_MAX_IOREAD16_COUNT) {
1151 dev_dbg_f(zd_usb_dev(usb),
1152 "error: count %u exceeds possible max %u\n",
1153 count, USB_MAX_IOREAD16_COUNT);
1157 dev_dbg_f(zd_usb_dev(usb),
1158 "error: io in atomic context not supported\n");
1159 return -EWOULDBLOCK;
1161 if (!usb_int_enabled(usb)) {
1162 dev_dbg_f(zd_usb_dev(usb),
1163 "error: usb interrupt not enabled\n");
1164 return -EWOULDBLOCK;
1167 req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1168 req = kmalloc(req_len, GFP_KERNEL);
1171 req->id = cpu_to_le16(USB_REQ_READ_REGS);
1172 for (i = 0; i < count; i++)
1173 req->addr[i] = cpu_to_le16((u16)addresses[i]);
1175 udev = zd_usb_to_usbdev(usb);
1176 prepare_read_regs_int(usb);
1177 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1178 req, req_len, &actual_req_len, 1000 /* ms */);
1180 dev_dbg_f(zd_usb_dev(usb),
1181 "error in usb_bulk_msg(). Error number %d\n", r);
1184 if (req_len != actual_req_len) {
1185 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1186 " req_len %d != actual_req_len %d\n",
1187 req_len, actual_req_len);
1192 timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1193 msecs_to_jiffies(1000));
1195 disable_read_regs_int(usb);
1196 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1201 r = get_results(usb, values, req, count);
1207 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1211 struct usb_device *udev;
1212 struct usb_req_write_regs *req = NULL;
1213 int i, req_len, actual_req_len;
1217 if (count > USB_MAX_IOWRITE16_COUNT) {
1218 dev_dbg_f(zd_usb_dev(usb),
1219 "error: count %u exceeds possible max %u\n",
1220 count, USB_MAX_IOWRITE16_COUNT);
1224 dev_dbg_f(zd_usb_dev(usb),
1225 "error: io in atomic context not supported\n");
1226 return -EWOULDBLOCK;
1229 req_len = sizeof(struct usb_req_write_regs) +
1230 count * sizeof(struct reg_data);
1231 req = kmalloc(req_len, GFP_KERNEL);
1235 req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1236 for (i = 0; i < count; i++) {
1237 struct reg_data *rw = &req->reg_writes[i];
1238 rw->addr = cpu_to_le16((u16)ioreqs[i].addr);
1239 rw->value = cpu_to_le16(ioreqs[i].value);
1242 udev = zd_usb_to_usbdev(usb);
1243 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1244 req, req_len, &actual_req_len, 1000 /* ms */);
1246 dev_dbg_f(zd_usb_dev(usb),
1247 "error in usb_bulk_msg(). Error number %d\n", r);
1250 if (req_len != actual_req_len) {
1251 dev_dbg_f(zd_usb_dev(usb),
1252 "error in usb_bulk_msg()"
1253 " req_len %d != actual_req_len %d\n",
1254 req_len, actual_req_len);
1259 /* FALL-THROUGH with r == 0 */
1265 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1268 struct usb_device *udev;
1269 struct usb_req_rfwrite *req = NULL;
1270 int i, req_len, actual_req_len;
1271 u16 bit_value_template;
1274 dev_dbg_f(zd_usb_dev(usb),
1275 "error: io in atomic context not supported\n");
1276 return -EWOULDBLOCK;
1278 if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1279 dev_dbg_f(zd_usb_dev(usb),
1280 "error: bits %d are smaller than"
1281 " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1282 bits, USB_MIN_RFWRITE_BIT_COUNT);
1285 if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1286 dev_dbg_f(zd_usb_dev(usb),
1287 "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1288 bits, USB_MAX_RFWRITE_BIT_COUNT);
1292 if (value & (~0UL << bits)) {
1293 dev_dbg_f(zd_usb_dev(usb),
1294 "error: value %#09x has bits >= %d set\n",
1300 dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1302 r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1304 dev_dbg_f(zd_usb_dev(usb),
1305 "error %d: Couldn't read CR203\n", r);
1308 bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1310 req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1311 req = kmalloc(req_len, GFP_KERNEL);
1315 req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1316 /* 1: 3683a, but not used in ZYDAS driver */
1317 req->value = cpu_to_le16(2);
1318 req->bits = cpu_to_le16(bits);
1320 for (i = 0; i < bits; i++) {
1321 u16 bv = bit_value_template;
1322 if (value & (1 << (bits-1-i)))
1324 req->bit_values[i] = cpu_to_le16(bv);
1327 udev = zd_usb_to_usbdev(usb);
1328 r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1329 req, req_len, &actual_req_len, 1000 /* ms */);
1331 dev_dbg_f(zd_usb_dev(usb),
1332 "error in usb_bulk_msg(). Error number %d\n", r);
1335 if (req_len != actual_req_len) {
1336 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1337 " req_len %d != actual_req_len %d\n",
1338 req_len, actual_req_len);
1343 /* FALL-THROUGH with r == 0 */