2 * USB FTDI client driver for Elan Digital Systems's Uxxx adapters
4 * Copyright(C) 2006 Elan Digital Systems Limited
5 * http://www.elandigitalsystems.com
7 * Author and Maintainer - Tony Olech - Elan Digital Systems
8 * tony.olech@elandigitalsystems.com
10 * This program is free software;you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation, version 2.
15 * This driver was written by Tony Olech(tony.olech@elandigitalsystems.com)
16 * based on various USB client drivers in the 2.6.15 linux kernel
17 * with constant reference to the 3rd Edition of Linux Device Drivers
18 * published by O'Reilly
20 * The U132 adapter is a USB to CardBus adapter specifically designed
21 * for PC cards that contain an OHCI host controller. Typical PC cards
22 * are the Orange Mobile 3G Option GlobeTrotter Fusion card.
24 * The U132 adapter will *NOT *work with PC cards that do not contain
25 * an OHCI controller. A simple way to test whether a PC card has an
26 * OHCI controller as an interface is to insert the PC card directly
27 * into a laptop(or desktop) with a CardBus slot and if "lspci" shows
28 * a new USB controller and "lsusb -v" shows a new OHCI Host Controller
29 * then there is a good chance that the U132 adapter will support the
30 * PC card.(you also need the specific client driver for the PC card)
32 * Please inform the Author and Maintainer about any PC cards that
33 * contain OHCI Host Controller and work when directly connected to
34 * an embedded CardBus slot but do not work when they are connected
35 * via an ELAN U132 adapter.
38 #include <linux/kernel.h>
39 #include <linux/errno.h>
40 #include <linux/init.h>
41 #include <linux/list.h>
42 #include <linux/ioctl.h>
43 #include <linux/pci_ids.h>
44 #include <linux/slab.h>
45 #include <linux/module.h>
46 #include <linux/kref.h>
47 #include <linux/mutex.h>
48 #include <asm/uaccess.h>
49 #include <linux/usb.h>
50 #include <linux/workqueue.h>
51 #include <linux/platform_device.h>
52 MODULE_AUTHOR("Tony Olech");
53 MODULE_DESCRIPTION("FTDI ELAN driver");
54 MODULE_LICENSE("GPL");
55 #define INT_MODULE_PARM(n, v) static int n = v;module_param(n, int, 0444)
56 static int distrust_firmware = 1;
57 module_param(distrust_firmware, bool, 0);
58 MODULE_PARM_DESC(distrust_firmware, "true to distrust firmware power/overcurren"
60 extern struct platform_driver u132_platform_driver;
61 static struct workqueue_struct *status_queue;
62 static struct workqueue_struct *command_queue;
63 static struct workqueue_struct *respond_queue;
65 * ftdi_module_lock exists to protect access to global variables
68 static struct mutex ftdi_module_lock;
69 static int ftdi_instances = 0;
70 static struct list_head ftdi_static_list;
72 * end of the global variables protected by ftdi_module_lock
76 #include "../core/hcd.h"
78 /* FIXME ohci.h is ONLY for internal use by the OHCI driver.
79 * If you're going to try stuff like this, you need to split
80 * out shareable stuff (register declarations?) into its own
81 * file, maybe name <linux/usb/ohci.h>
84 #include "../host/ohci.h"
85 /* Define these values to match your devices*/
86 #define USB_FTDI_ELAN_VENDOR_ID 0x0403
87 #define USB_FTDI_ELAN_PRODUCT_ID 0xd6ea
88 /* table of devices that work with this driver*/
89 static struct usb_device_id ftdi_elan_table[] = {
90 {USB_DEVICE(USB_FTDI_ELAN_VENDOR_ID, USB_FTDI_ELAN_PRODUCT_ID)},
91 { /* Terminating entry */ }
94 MODULE_DEVICE_TABLE(usb, ftdi_elan_table);
95 /* only the jtag(firmware upgrade device) interface requires
96 * a device file and corresponding minor number, but the
97 * interface is created unconditionally - I suppose it could
98 * be configured or not according to a module parameter.
99 * But since we(now) require one interface per device,
100 * and since it unlikely that a normal installation would
101 * require more than a couple of elan-ftdi devices, 8 seems
102 * like a reasonable limit to have here, and if someone
103 * really requires more than 8 devices, then they can frig the
106 #define USB_FTDI_ELAN_MINOR_BASE 192
107 #define COMMAND_BITS 5
108 #define COMMAND_SIZE (1<<COMMAND_BITS)
109 #define COMMAND_MASK (COMMAND_SIZE-1)
110 struct u132_command {
119 #define RESPOND_BITS 5
120 #define RESPOND_SIZE (1<<RESPOND_BITS)
121 #define RESPOND_MASK (RESPOND_SIZE-1)
122 struct u132_respond {
127 struct completion wait_completion;
142 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
143 int toggle_bits, int error_count, int condition_code,
144 int repeat_number, int halted, int skipped, int actual,
147 /* Structure to hold all of our device specific stuff*/
149 struct list_head ftdi_list;
150 struct semaphore u132_lock;
153 struct u132_command command[COMMAND_SIZE];
156 struct u132_respond respond[RESPOND_SIZE];
157 struct u132_target target[4];
158 char device_name[16];
159 unsigned synchronized:1;
160 unsigned enumerated:1;
161 unsigned registered:1;
162 unsigned initialized:1;
163 unsigned card_ejected:1;
169 int status_queue_delay;
170 struct semaphore sw_lock;
171 struct usb_device *udev;
172 struct usb_interface *interface;
173 struct usb_class_driver *class;
174 struct delayed_work status_work;
175 struct delayed_work command_work;
176 struct delayed_work respond_work;
177 struct u132_platform_data platform_data;
178 struct resource resources[0];
179 struct platform_device platform_dev;
180 unsigned char *bulk_in_buffer;
184 __u8 bulk_in_endpointAddr;
185 __u8 bulk_out_endpointAddr;
188 u8 response[4 + 1024];
193 #define kref_to_usb_ftdi(d) container_of(d, struct usb_ftdi, kref)
194 #define platform_device_to_usb_ftdi(d) container_of(d, struct usb_ftdi, \
196 static struct usb_driver ftdi_elan_driver;
197 static void ftdi_elan_delete(struct kref *kref)
199 struct usb_ftdi *ftdi = kref_to_usb_ftdi(kref);
200 dev_warn(&ftdi->udev->dev, "FREEING ftdi=%p\n", ftdi);
201 usb_put_dev(ftdi->udev);
202 ftdi->disconnected += 1;
203 mutex_lock(&ftdi_module_lock);
204 list_del_init(&ftdi->ftdi_list);
206 mutex_unlock(&ftdi_module_lock);
207 kfree(ftdi->bulk_in_buffer);
208 ftdi->bulk_in_buffer = NULL;
211 static void ftdi_elan_put_kref(struct usb_ftdi *ftdi)
213 kref_put(&ftdi->kref, ftdi_elan_delete);
216 static void ftdi_elan_get_kref(struct usb_ftdi *ftdi)
218 kref_get(&ftdi->kref);
221 static void ftdi_elan_init_kref(struct usb_ftdi *ftdi)
223 kref_init(&ftdi->kref);
226 static void ftdi_status_requeue_work(struct usb_ftdi *ftdi, unsigned int delta)
228 if (!queue_delayed_work(status_queue, &ftdi->status_work, delta))
229 kref_put(&ftdi->kref, ftdi_elan_delete);
232 static void ftdi_status_queue_work(struct usb_ftdi *ftdi, unsigned int delta)
234 if (queue_delayed_work(status_queue, &ftdi->status_work, delta))
235 kref_get(&ftdi->kref);
238 static void ftdi_status_cancel_work(struct usb_ftdi *ftdi)
240 if (cancel_delayed_work(&ftdi->status_work))
241 kref_put(&ftdi->kref, ftdi_elan_delete);
244 static void ftdi_command_requeue_work(struct usb_ftdi *ftdi, unsigned int delta)
246 if (!queue_delayed_work(command_queue, &ftdi->command_work, delta))
247 kref_put(&ftdi->kref, ftdi_elan_delete);
250 static void ftdi_command_queue_work(struct usb_ftdi *ftdi, unsigned int delta)
252 if (queue_delayed_work(command_queue, &ftdi->command_work, delta))
253 kref_get(&ftdi->kref);
256 static void ftdi_command_cancel_work(struct usb_ftdi *ftdi)
258 if (cancel_delayed_work(&ftdi->command_work))
259 kref_put(&ftdi->kref, ftdi_elan_delete);
262 static void ftdi_response_requeue_work(struct usb_ftdi *ftdi,
265 if (!queue_delayed_work(respond_queue, &ftdi->respond_work, delta))
266 kref_put(&ftdi->kref, ftdi_elan_delete);
269 static void ftdi_respond_queue_work(struct usb_ftdi *ftdi, unsigned int delta)
271 if (queue_delayed_work(respond_queue, &ftdi->respond_work, delta))
272 kref_get(&ftdi->kref);
275 static void ftdi_response_cancel_work(struct usb_ftdi *ftdi)
277 if (cancel_delayed_work(&ftdi->respond_work))
278 kref_put(&ftdi->kref, ftdi_elan_delete);
281 void ftdi_elan_gone_away(struct platform_device *pdev)
283 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
284 ftdi->gone_away += 1;
285 ftdi_elan_put_kref(ftdi);
289 EXPORT_SYMBOL_GPL(ftdi_elan_gone_away);
290 static void ftdi_release_platform_dev(struct device *dev)
295 static void ftdi_elan_do_callback(struct usb_ftdi *ftdi,
296 struct u132_target *target, u8 *buffer, int length);
297 static void ftdi_elan_kick_command_queue(struct usb_ftdi *ftdi);
298 static void ftdi_elan_kick_respond_queue(struct usb_ftdi *ftdi);
299 static int ftdi_elan_setupOHCI(struct usb_ftdi *ftdi);
300 static int ftdi_elan_checkingPCI(struct usb_ftdi *ftdi);
301 static int ftdi_elan_enumeratePCI(struct usb_ftdi *ftdi);
302 static int ftdi_elan_synchronize(struct usb_ftdi *ftdi);
303 static int ftdi_elan_stuck_waiting(struct usb_ftdi *ftdi);
304 static int ftdi_elan_command_engine(struct usb_ftdi *ftdi);
305 static int ftdi_elan_respond_engine(struct usb_ftdi *ftdi);
306 static int ftdi_elan_hcd_init(struct usb_ftdi *ftdi)
309 if (ftdi->platform_dev.dev.parent)
311 ftdi_elan_get_kref(ftdi);
312 ftdi->platform_data.potpg = 100;
313 ftdi->platform_data.reset = NULL;
314 ftdi->platform_dev.id = ftdi->sequence_num;
315 ftdi->platform_dev.resource = ftdi->resources;
316 ftdi->platform_dev.num_resources = ARRAY_SIZE(ftdi->resources);
317 ftdi->platform_dev.dev.platform_data = &ftdi->platform_data;
318 ftdi->platform_dev.dev.parent = NULL;
319 ftdi->platform_dev.dev.release = ftdi_release_platform_dev;
320 ftdi->platform_dev.dev.dma_mask = NULL;
321 snprintf(ftdi->device_name, sizeof(ftdi->device_name), "u132_hcd");
322 ftdi->platform_dev.name = ftdi->device_name;
323 dev_info(&ftdi->udev->dev, "requesting module '%s'\n", "u132_hcd");
324 request_module("u132_hcd");
325 dev_info(&ftdi->udev->dev, "registering '%s'\n",
326 ftdi->platform_dev.name);
327 result = platform_device_register(&ftdi->platform_dev);
331 static void ftdi_elan_abandon_completions(struct usb_ftdi *ftdi)
333 down(&ftdi->u132_lock);
334 while (ftdi->respond_next > ftdi->respond_head) {
335 struct u132_respond *respond = &ftdi->respond[RESPOND_MASK &
336 ftdi->respond_head++];
337 *respond->result = -ESHUTDOWN;
339 complete(&respond->wait_completion);
340 } up(&ftdi->u132_lock);
343 static void ftdi_elan_abandon_targets(struct usb_ftdi *ftdi)
346 down(&ftdi->u132_lock);
347 while (ed_number-- > 0) {
348 struct u132_target *target = &ftdi->target[ed_number];
349 if (target->active == 1) {
350 target->condition_code = TD_DEVNOTRESP;
351 up(&ftdi->u132_lock);
352 ftdi_elan_do_callback(ftdi, target, NULL, 0);
353 down(&ftdi->u132_lock);
359 up(&ftdi->u132_lock);
362 static void ftdi_elan_flush_targets(struct usb_ftdi *ftdi)
365 down(&ftdi->u132_lock);
366 while (ed_number-- > 0) {
367 struct u132_target *target = &ftdi->target[ed_number];
368 target->abandoning = 1;
369 wait_1:if (target->active == 1) {
370 int command_size = ftdi->command_next -
372 if (command_size < COMMAND_SIZE) {
373 struct u132_command *command = &ftdi->command[
374 COMMAND_MASK & ftdi->command_next];
375 command->header = 0x80 | (ed_number << 5) | 0x4;
376 command->length = 0x00;
377 command->address = 0x00;
378 command->width = 0x00;
379 command->follows = 0;
381 command->buffer = &command->value;
382 ftdi->command_next += 1;
383 ftdi_elan_kick_command_queue(ftdi);
385 up(&ftdi->u132_lock);
387 down(&ftdi->u132_lock);
391 wait_2:if (target->active == 1) {
392 int command_size = ftdi->command_next -
394 if (command_size < COMMAND_SIZE) {
395 struct u132_command *command = &ftdi->command[
396 COMMAND_MASK & ftdi->command_next];
397 command->header = 0x90 | (ed_number << 5);
398 command->length = 0x00;
399 command->address = 0x00;
400 command->width = 0x00;
401 command->follows = 0;
403 command->buffer = &command->value;
404 ftdi->command_next += 1;
405 ftdi_elan_kick_command_queue(ftdi);
407 up(&ftdi->u132_lock);
409 down(&ftdi->u132_lock);
417 up(&ftdi->u132_lock);
420 static void ftdi_elan_cancel_targets(struct usb_ftdi *ftdi)
423 down(&ftdi->u132_lock);
424 while (ed_number-- > 0) {
425 struct u132_target *target = &ftdi->target[ed_number];
426 target->abandoning = 1;
427 wait:if (target->active == 1) {
428 int command_size = ftdi->command_next -
430 if (command_size < COMMAND_SIZE) {
431 struct u132_command *command = &ftdi->command[
432 COMMAND_MASK & ftdi->command_next];
433 command->header = 0x80 | (ed_number << 5) | 0x4;
434 command->length = 0x00;
435 command->address = 0x00;
436 command->width = 0x00;
437 command->follows = 0;
439 command->buffer = &command->value;
440 ftdi->command_next += 1;
441 ftdi_elan_kick_command_queue(ftdi);
443 up(&ftdi->u132_lock);
445 down(&ftdi->u132_lock);
453 up(&ftdi->u132_lock);
456 static void ftdi_elan_kick_command_queue(struct usb_ftdi *ftdi)
458 ftdi_command_queue_work(ftdi, 0);
462 static void ftdi_elan_command_work(struct work_struct *work)
464 struct usb_ftdi *ftdi =
465 container_of(work, struct usb_ftdi, command_work.work);
467 if (ftdi->disconnected > 0) {
468 ftdi_elan_put_kref(ftdi);
471 int retval = ftdi_elan_command_engine(ftdi);
472 if (retval == -ESHUTDOWN) {
473 ftdi->disconnected += 1;
474 } else if (retval == -ENODEV) {
475 ftdi->disconnected += 1;
477 dev_err(&ftdi->udev->dev, "command error %d\n", retval);
478 ftdi_command_requeue_work(ftdi, msecs_to_jiffies(10));
483 static void ftdi_elan_kick_respond_queue(struct usb_ftdi *ftdi)
485 ftdi_respond_queue_work(ftdi, 0);
489 static void ftdi_elan_respond_work(struct work_struct *work)
491 struct usb_ftdi *ftdi =
492 container_of(work, struct usb_ftdi, respond_work.work);
493 if (ftdi->disconnected > 0) {
494 ftdi_elan_put_kref(ftdi);
497 int retval = ftdi_elan_respond_engine(ftdi);
499 } else if (retval == -ESHUTDOWN) {
500 ftdi->disconnected += 1;
501 } else if (retval == -ENODEV) {
502 ftdi->disconnected += 1;
503 } else if (retval == -EILSEQ) {
504 ftdi->disconnected += 1;
506 ftdi->disconnected += 1;
507 dev_err(&ftdi->udev->dev, "respond error %d\n", retval);
509 if (ftdi->disconnected > 0) {
510 ftdi_elan_abandon_completions(ftdi);
511 ftdi_elan_abandon_targets(ftdi);
513 ftdi_response_requeue_work(ftdi, msecs_to_jiffies(10));
520 * the sw_lock is initially held and will be freed
521 * after the FTDI has been synchronized
524 static void ftdi_elan_status_work(struct work_struct *work)
526 struct usb_ftdi *ftdi =
527 container_of(work, struct usb_ftdi, status_work.work);
528 int work_delay_in_msec = 0;
529 if (ftdi->disconnected > 0) {
530 ftdi_elan_put_kref(ftdi);
532 } else if (ftdi->synchronized == 0) {
533 down(&ftdi->sw_lock);
534 if (ftdi_elan_synchronize(ftdi) == 0) {
535 ftdi->synchronized = 1;
536 ftdi_command_queue_work(ftdi, 1);
537 ftdi_respond_queue_work(ftdi, 1);
539 work_delay_in_msec = 100;
541 dev_err(&ftdi->udev->dev, "synchronize failed\n");
543 work_delay_in_msec = 10 *1000;
545 } else if (ftdi->stuck_status > 0) {
546 if (ftdi_elan_stuck_waiting(ftdi) == 0) {
547 ftdi->stuck_status = 0;
548 ftdi->synchronized = 0;
549 } else if ((ftdi->stuck_status++ % 60) == 1) {
550 dev_err(&ftdi->udev->dev, "WRONG type of card inserted "
551 "- please remove\n");
553 dev_err(&ftdi->udev->dev, "WRONG type of card inserted "
554 "- checked %d times\n", ftdi->stuck_status);
555 work_delay_in_msec = 100;
556 } else if (ftdi->enumerated == 0) {
557 if (ftdi_elan_enumeratePCI(ftdi) == 0) {
558 ftdi->enumerated = 1;
559 work_delay_in_msec = 250;
561 work_delay_in_msec = 1000;
562 } else if (ftdi->initialized == 0) {
563 if (ftdi_elan_setupOHCI(ftdi) == 0) {
564 ftdi->initialized = 1;
565 work_delay_in_msec = 500;
567 dev_err(&ftdi->udev->dev, "initialized failed - trying "
568 "again in 10 seconds\n");
569 work_delay_in_msec = 1 *1000;
571 } else if (ftdi->registered == 0) {
572 work_delay_in_msec = 10;
573 if (ftdi_elan_hcd_init(ftdi) == 0) {
574 ftdi->registered = 1;
576 dev_err(&ftdi->udev->dev, "register failed\n");
577 work_delay_in_msec = 250;
579 if (ftdi_elan_checkingPCI(ftdi) == 0) {
580 work_delay_in_msec = 250;
581 } else if (ftdi->controlreg & 0x00400000) {
582 if (ftdi->gone_away > 0) {
583 dev_err(&ftdi->udev->dev, "PCI device eject con"
584 "firmed platform_dev.dev.parent=%p plat"
586 ftdi->platform_dev.dev.parent,
587 &ftdi->platform_dev.dev);
588 platform_device_unregister(&ftdi->platform_dev);
589 ftdi->platform_dev.dev.parent = NULL;
590 ftdi->registered = 0;
591 ftdi->enumerated = 0;
592 ftdi->card_ejected = 0;
593 ftdi->initialized = 0;
596 ftdi_elan_flush_targets(ftdi);
597 work_delay_in_msec = 250;
599 dev_err(&ftdi->udev->dev, "PCI device has disappeared\n"
601 ftdi_elan_cancel_targets(ftdi);
602 work_delay_in_msec = 500;
603 ftdi->enumerated = 0;
604 ftdi->initialized = 0;
607 if (ftdi->disconnected > 0) {
608 ftdi_elan_put_kref(ftdi);
611 ftdi_status_requeue_work(ftdi,
612 msecs_to_jiffies(work_delay_in_msec));
619 * file_operations for the jtag interface
621 * the usage count for the device is incremented on open()
622 * and decremented on release()
624 static int ftdi_elan_open(struct inode *inode, struct file *file)
626 int subminor = iminor(inode);
627 struct usb_interface *interface = usb_find_interface(&ftdi_elan_driver,
630 printk(KERN_ERR "can't find device for minor %d\n", subminor);
633 struct usb_ftdi *ftdi = usb_get_intfdata(interface);
637 if (down_interruptible(&ftdi->sw_lock)) {
640 ftdi_elan_get_kref(ftdi);
641 file->private_data = ftdi;
648 static int ftdi_elan_release(struct inode *inode, struct file *file)
650 struct usb_ftdi *ftdi = (struct usb_ftdi *)file->private_data;
653 up(&ftdi->sw_lock); /* decrement the count on our device */
654 ftdi_elan_put_kref(ftdi);
659 #define FTDI_ELAN_IOC_MAGIC 0xA1
660 #define FTDI_ELAN_IOCDEBUG _IOC(_IOC_WRITE, FTDI_ELAN_IOC_MAGIC, 1, 132)
661 static int ftdi_elan_ioctl(struct inode *inode, struct file *file,
662 unsigned int cmd, unsigned long arg)
665 case FTDI_ELAN_IOCDEBUG:{
667 int size = strncpy_from_user(line,
668 (const char __user *)arg, sizeof(line));
672 printk(KERN_ERR "TODO: ioctl %s\n", line);
684 * blocking bulk reads are used to get data from the device
687 static ssize_t ftdi_elan_read(struct file *file, char __user *buffer,
688 size_t count, loff_t *ppos)
690 char data[30 *3 + 4];
692 int m = (sizeof(data) - 1) / 3;
694 int retry_on_empty = 10;
695 int retry_on_timeout = 5;
696 struct usb_ftdi *ftdi = (struct usb_ftdi *)file->private_data;
697 if (ftdi->disconnected > 0) {
701 have:if (ftdi->bulk_in_left > 0) {
703 char *p = ++ftdi->bulk_in_last + ftdi->bulk_in_buffer;
704 ftdi->bulk_in_left -= 1;
705 if (bytes_read < m) {
706 d += sprintf(d, " %02X", 0x000000FF & *p);
707 } else if (bytes_read > m) {
709 d += sprintf(d, " ..");
710 if (copy_to_user(buffer++, p, 1)) {
719 more:if (count > 0) {
720 int packet_bytes = 0;
721 int retval = usb_bulk_msg(ftdi->udev,
722 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
723 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
724 &packet_bytes, msecs_to_jiffies(50));
725 if (packet_bytes > 2) {
726 ftdi->bulk_in_left = packet_bytes - 2;
727 ftdi->bulk_in_last = 1;
729 } else if (retval == -ETIMEDOUT) {
730 if (retry_on_timeout-- > 0) {
732 } else if (bytes_read > 0) {
736 } else if (retval == 0) {
737 if (retry_on_empty-- > 0) {
747 static void ftdi_elan_write_bulk_callback(struct urb *urb)
749 struct usb_ftdi *ftdi = (struct usb_ftdi *)urb->context;
750 if (urb->status && !(urb->status == -ENOENT || urb->status ==
751 -ECONNRESET || urb->status == -ESHUTDOWN)) {
752 dev_err(&ftdi->udev->dev, "urb=%p write bulk status received: %"
753 "d\n", urb, urb->status);
755 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
756 urb->transfer_buffer, urb->transfer_dma);
759 static int fill_buffer_with_all_queued_commands(struct usb_ftdi *ftdi,
760 char *buf, int command_size, int total_size)
764 int I = command_size;
765 int i = ftdi->command_head;
767 struct u132_command *command = &ftdi->command[COMMAND_MASK &
769 int F = command->follows;
770 u8 *f = command->buffer;
771 if (command->header & 0x80) {
772 ed_commands |= 1 << (0x3 & (command->header >> 5));
774 buf[b++] = command->header;
775 buf[b++] = (command->length >> 0) & 0x00FF;
776 buf[b++] = (command->length >> 8) & 0x00FF;
777 buf[b++] = command->address;
778 buf[b++] = command->width;
786 static int ftdi_elan_total_command_size(struct usb_ftdi *ftdi, int command_size)
789 int I = command_size;
790 int i = ftdi->command_head;
792 struct u132_command *command = &ftdi->command[COMMAND_MASK &
794 total_size += 5 + command->follows;
798 static int ftdi_elan_command_engine(struct usb_ftdi *ftdi)
805 int command_size = ftdi->command_next - ftdi->command_head;
806 if (command_size == 0)
808 total_size = ftdi_elan_total_command_size(ftdi, command_size);
809 urb = usb_alloc_urb(0, GFP_KERNEL);
811 dev_err(&ftdi->udev->dev, "could not get a urb to write %d comm"
812 "ands totaling %d bytes to the Uxxx\n", command_size,
816 buf = usb_buffer_alloc(ftdi->udev, total_size, GFP_KERNEL,
819 dev_err(&ftdi->udev->dev, "could not get a buffer to write %d c"
820 "ommands totaling %d bytes to the Uxxx\n", command_size,
825 ed_commands = fill_buffer_with_all_queued_commands(ftdi, buf,
826 command_size, total_size);
827 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
828 ftdi->bulk_out_endpointAddr), buf, total_size,
829 ftdi_elan_write_bulk_callback, ftdi);
830 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
832 char diag[40 *3 + 4];
836 int s = (sizeof(diag) - 1) / 3;
838 while (s-- > 0 && m-- > 0) {
839 if (s > 0 || m == 0) {
840 d += sprintf(d, " %02X", *c++);
842 d += sprintf(d, " ..");
845 retval = usb_submit_urb(urb, GFP_KERNEL);
847 dev_err(&ftdi->udev->dev, "failed %d to submit urb %p to write "
848 "%d commands totaling %d bytes to the Uxxx\n", retval,
849 urb, command_size, total_size);
850 usb_buffer_free(ftdi->udev, total_size, buf, urb->transfer_dma);
854 usb_free_urb(urb); /* release our reference to this urb,
855 the USB core will eventually free it entirely */
856 ftdi->command_head += command_size;
857 ftdi_elan_kick_respond_queue(ftdi);
861 static void ftdi_elan_do_callback(struct usb_ftdi *ftdi,
862 struct u132_target *target, u8 *buffer, int length)
864 struct urb *urb = target->urb;
865 int halted = target->halted;
866 int skipped = target->skipped;
867 int actual = target->actual;
868 int non_null = target->non_null;
869 int toggle_bits = target->toggle_bits;
870 int error_count = target->error_count;
871 int condition_code = target->condition_code;
872 int repeat_number = target->repeat_number;
873 void (*callback) (void *, struct urb *, u8 *, int, int, int, int, int,
874 int, int, int, int) = target->callback;
876 target->callback = NULL;
877 (*callback) (target->endp, urb, buffer, length, toggle_bits,
878 error_count, condition_code, repeat_number, halted, skipped,
882 static char *have_ed_set_response(struct usb_ftdi *ftdi,
883 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
886 int payload = (ed_length >> 0) & 0x07FF;
887 down(&ftdi->u132_lock);
889 target->non_null = (ed_length >> 15) & 0x0001;
890 target->repeat_number = (ed_length >> 11) & 0x000F;
891 if (ed_type == 0x02) {
892 if (payload == 0 || target->abandoning > 0) {
893 target->abandoning = 0;
894 up(&ftdi->u132_lock);
895 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
900 return ftdi->response;
902 ftdi->expected = 4 + payload;
904 up(&ftdi->u132_lock);
907 } else if (ed_type == 0x03) {
908 if (payload == 0 || target->abandoning > 0) {
909 target->abandoning = 0;
910 up(&ftdi->u132_lock);
911 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
916 return ftdi->response;
918 ftdi->expected = 4 + payload;
920 up(&ftdi->u132_lock);
923 } else if (ed_type == 0x01) {
924 target->abandoning = 0;
925 up(&ftdi->u132_lock);
926 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
931 return ftdi->response;
933 target->abandoning = 0;
934 up(&ftdi->u132_lock);
935 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
940 return ftdi->response;
944 static char *have_ed_get_response(struct usb_ftdi *ftdi,
945 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
948 down(&ftdi->u132_lock);
949 target->condition_code = TD_DEVNOTRESP;
950 target->actual = (ed_length >> 0) & 0x01FF;
951 target->non_null = (ed_length >> 15) & 0x0001;
952 target->repeat_number = (ed_length >> 11) & 0x000F;
953 up(&ftdi->u132_lock);
955 ftdi_elan_do_callback(ftdi, target, NULL, 0);
956 target->abandoning = 0;
960 return ftdi->response;
965 * The engine tries to empty the FTDI fifo
967 * all responses found in the fifo data are dispatched thus
968 * the response buffer can only ever hold a maximum sized
969 * response from the Uxxx.
972 static int ftdi_elan_respond_engine(struct usb_ftdi *ftdi)
974 u8 *b = ftdi->response + ftdi->recieved;
976 int retry_on_empty = 1;
977 int retry_on_timeout = 3;
978 int empty_packets = 0;
980 int packet_bytes = 0;
981 int retval = usb_bulk_msg(ftdi->udev,
982 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
983 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
984 &packet_bytes, msecs_to_jiffies(500));
985 char diag[30 *3 + 4];
987 int m = packet_bytes;
988 u8 *c = ftdi->bulk_in_buffer;
989 int s = (sizeof(diag) - 1) / 3;
991 while (s-- > 0 && m-- > 0) {
992 if (s > 0 || m == 0) {
993 d += sprintf(d, " %02X", *c++);
995 d += sprintf(d, " ..");
997 if (packet_bytes > 2) {
998 ftdi->bulk_in_left = packet_bytes - 2;
999 ftdi->bulk_in_last = 1;
1001 } else if (retval == -ETIMEDOUT) {
1002 if (retry_on_timeout-- > 0) {
1003 dev_err(&ftdi->udev->dev, "TIMED OUT with packe"
1004 "t_bytes = %d with total %d bytes%s\n",
1005 packet_bytes, bytes_read, diag);
1007 } else if (bytes_read > 0) {
1008 dev_err(&ftdi->udev->dev, "ONLY %d bytes%s\n",
1012 dev_err(&ftdi->udev->dev, "TIMED OUT with packe"
1013 "t_bytes = %d with total %d bytes%s\n",
1014 packet_bytes, bytes_read, diag);
1017 } else if (retval == -EILSEQ) {
1018 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes"
1019 " = %d with total %d bytes%s\n", retval,
1020 packet_bytes, bytes_read, diag);
1022 } else if (retval) {
1023 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes"
1024 " = %d with total %d bytes%s\n", retval,
1025 packet_bytes, bytes_read, diag);
1027 } else if (packet_bytes == 2) {
1028 unsigned char s0 = ftdi->bulk_in_buffer[0];
1029 unsigned char s1 = ftdi->bulk_in_buffer[1];
1031 if (s0 == 0x31 && s1 == 0x60) {
1032 if (retry_on_empty-- > 0) {
1036 } else if (s0 == 0x31 && s1 == 0x00) {
1037 if (retry_on_empty-- > 0) {
1042 if (retry_on_empty-- > 0) {
1047 } else if (packet_bytes == 1) {
1048 if (retry_on_empty-- > 0) {
1053 if (retry_on_empty-- > 0) {
1062 have:if (ftdi->bulk_in_left > 0) {
1063 u8 c = ftdi->bulk_in_buffer[++ftdi->bulk_in_last];
1065 ftdi->bulk_in_left -= 1;
1066 if (ftdi->recieved == 0 && c == 0xFF) {
1070 if (++ftdi->recieved < ftdi->expected) {
1072 } else if (ftdi->ed_found) {
1073 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1074 u16 ed_length = (ftdi->response[2] << 8) |
1076 struct u132_target *target = &ftdi->target[ed_number];
1077 int payload = (ed_length >> 0) & 0x07FF;
1078 char diag[30 *3 + 4];
1081 u8 *c = 4 + ftdi->response;
1082 int s = (sizeof(diag) - 1) / 3;
1084 while (s-- > 0 && m-- > 0) {
1085 if (s > 0 || m == 0) {
1086 d += sprintf(d, " %02X", *c++);
1088 d += sprintf(d, " ..");
1090 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
1097 } else if (ftdi->expected == 8) {
1099 int respond_head = ftdi->respond_head++;
1100 struct u132_respond *respond = &ftdi->respond[
1101 RESPOND_MASK & respond_head];
1102 u32 data = ftdi->response[7];
1104 data |= ftdi->response[6];
1106 data |= ftdi->response[5];
1108 data |= ftdi->response[4];
1109 *respond->value = data;
1110 *respond->result = 0;
1111 complete(&respond->wait_completion);
1116 buscmd = (ftdi->response[0] >> 0) & 0x0F;
1117 if (buscmd == 0x00) {
1118 } else if (buscmd == 0x02) {
1119 } else if (buscmd == 0x06) {
1120 } else if (buscmd == 0x0A) {
1122 dev_err(&ftdi->udev->dev, "Uxxx unknown(%0X) va"
1123 "lue = %08X\n", buscmd, data);
1126 if ((ftdi->response[0] & 0x80) == 0x00) {
1130 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1131 int ed_type = (ftdi->response[0] >> 0) & 0x03;
1132 u16 ed_length = (ftdi->response[2] << 8) |
1134 struct u132_target *target = &ftdi->target[
1136 target->halted = (ftdi->response[0] >> 3) &
1138 target->skipped = (ftdi->response[0] >> 2) &
1140 target->toggle_bits = (ftdi->response[3] >> 6)
1142 target->error_count = (ftdi->response[3] >> 4)
1144 target->condition_code = (ftdi->response[
1146 if ((ftdi->response[0] & 0x10) == 0x00) {
1147 b = have_ed_set_response(ftdi, target,
1148 ed_length, ed_number, ed_type,
1152 b = have_ed_get_response(ftdi, target,
1153 ed_length, ed_number, ed_type,
1165 * create a urb, and a buffer for it, and copy the data to the urb
1168 static ssize_t ftdi_elan_write(struct file *file,
1169 const char __user *user_buffer, size_t count,
1175 struct usb_ftdi *ftdi = file->private_data;
1177 if (ftdi->disconnected > 0) {
1183 urb = usb_alloc_urb(0, GFP_KERNEL);
1188 buf = usb_buffer_alloc(ftdi->udev, count, GFP_KERNEL,
1189 &urb->transfer_dma);
1194 if (copy_from_user(buf, user_buffer, count)) {
1198 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
1199 ftdi->bulk_out_endpointAddr), buf, count,
1200 ftdi_elan_write_bulk_callback, ftdi);
1201 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1202 retval = usb_submit_urb(urb, GFP_KERNEL);
1204 dev_err(&ftdi->udev->dev, "failed submitting write urb, error %"
1213 usb_buffer_free(ftdi->udev, count, buf, urb->transfer_dma);
1220 static const struct file_operations ftdi_elan_fops = {
1221 .owner = THIS_MODULE,
1222 .llseek = no_llseek,
1223 .ioctl = ftdi_elan_ioctl,
1224 .read = ftdi_elan_read,
1225 .write = ftdi_elan_write,
1226 .open = ftdi_elan_open,
1227 .release = ftdi_elan_release,
1231 * usb class driver info in order to get a minor number from the usb core,
1232 * and to have the device registered with the driver core
1234 static struct usb_class_driver ftdi_elan_jtag_class = {
1235 .name = "ftdi-%d-jtag",
1236 .fops = &ftdi_elan_fops,
1237 .minor_base = USB_FTDI_ELAN_MINOR_BASE,
1241 * the following definitions are for the
1242 * ELAN FPGA state machgine processor that
1243 * lies on the other side of the FTDI chip
1245 #define cPCIu132rd 0x0
1246 #define cPCIu132wr 0x1
1247 #define cPCIiord 0x2
1248 #define cPCIiowr 0x3
1249 #define cPCImemrd 0x6
1250 #define cPCImemwr 0x7
1251 #define cPCIcfgrd 0xA
1252 #define cPCIcfgwr 0xB
1253 #define cPCInull 0xF
1254 #define cU132cmd_status 0x0
1255 #define cU132flash 0x1
1256 #define cPIDsetup 0x0
1259 #define cPIDinonce 0x3
1260 #define cCCnoerror 0x0
1262 #define cCCbitstuff 0x2
1263 #define cCCtoggle 0x3
1264 #define cCCstall 0x4
1265 #define cCCnoresp 0x5
1266 #define cCCbadpid1 0x6
1267 #define cCCbadpid2 0x7
1268 #define cCCdataoverrun 0x8
1269 #define cCCdataunderrun 0x9
1270 #define cCCbuffoverrun 0xC
1271 #define cCCbuffunderrun 0xD
1272 #define cCCnotaccessed 0xF
1273 static int ftdi_elan_write_reg(struct usb_ftdi *ftdi, u32 data)
1275 wait:if (ftdi->disconnected > 0) {
1279 down(&ftdi->u132_lock);
1280 command_size = ftdi->command_next - ftdi->command_head;
1281 if (command_size < COMMAND_SIZE) {
1282 struct u132_command *command = &ftdi->command[
1283 COMMAND_MASK & ftdi->command_next];
1284 command->header = 0x00 | cPCIu132wr;
1285 command->length = 0x04;
1286 command->address = 0x00;
1287 command->width = 0x00;
1288 command->follows = 4;
1289 command->value = data;
1290 command->buffer = &command->value;
1291 ftdi->command_next += 1;
1292 ftdi_elan_kick_command_queue(ftdi);
1293 up(&ftdi->u132_lock);
1296 up(&ftdi->u132_lock);
1303 static int ftdi_elan_write_config(struct usb_ftdi *ftdi, int config_offset,
1306 u8 addressofs = config_offset / 4;
1307 wait:if (ftdi->disconnected > 0) {
1311 down(&ftdi->u132_lock);
1312 command_size = ftdi->command_next - ftdi->command_head;
1313 if (command_size < COMMAND_SIZE) {
1314 struct u132_command *command = &ftdi->command[
1315 COMMAND_MASK & ftdi->command_next];
1316 command->header = 0x00 | (cPCIcfgwr & 0x0F);
1317 command->length = 0x04;
1318 command->address = addressofs;
1319 command->width = 0x00 | (width & 0x0F);
1320 command->follows = 4;
1321 command->value = data;
1322 command->buffer = &command->value;
1323 ftdi->command_next += 1;
1324 ftdi_elan_kick_command_queue(ftdi);
1325 up(&ftdi->u132_lock);
1328 up(&ftdi->u132_lock);
1335 static int ftdi_elan_write_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1338 u8 addressofs = mem_offset / 4;
1339 wait:if (ftdi->disconnected > 0) {
1343 down(&ftdi->u132_lock);
1344 command_size = ftdi->command_next - ftdi->command_head;
1345 if (command_size < COMMAND_SIZE) {
1346 struct u132_command *command = &ftdi->command[
1347 COMMAND_MASK & ftdi->command_next];
1348 command->header = 0x00 | (cPCImemwr & 0x0F);
1349 command->length = 0x04;
1350 command->address = addressofs;
1351 command->width = 0x00 | (width & 0x0F);
1352 command->follows = 4;
1353 command->value = data;
1354 command->buffer = &command->value;
1355 ftdi->command_next += 1;
1356 ftdi_elan_kick_command_queue(ftdi);
1357 up(&ftdi->u132_lock);
1360 up(&ftdi->u132_lock);
1367 int usb_ftdi_elan_write_pcimem(struct platform_device *pdev, int mem_offset,
1370 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1371 return ftdi_elan_write_pcimem(ftdi, mem_offset, width, data);
1375 EXPORT_SYMBOL_GPL(usb_ftdi_elan_write_pcimem);
1376 static int ftdi_elan_read_reg(struct usb_ftdi *ftdi, u32 *data)
1378 wait:if (ftdi->disconnected > 0) {
1383 down(&ftdi->u132_lock);
1384 command_size = ftdi->command_next - ftdi->command_head;
1385 respond_size = ftdi->respond_next - ftdi->respond_head;
1386 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1388 struct u132_command *command = &ftdi->command[
1389 COMMAND_MASK & ftdi->command_next];
1390 struct u132_respond *respond = &ftdi->respond[
1391 RESPOND_MASK & ftdi->respond_next];
1392 int result = -ENODEV;
1393 respond->result = &result;
1394 respond->header = command->header = 0x00 | cPCIu132rd;
1395 command->length = 0x04;
1396 respond->address = command->address = cU132cmd_status;
1397 command->width = 0x00;
1398 command->follows = 0;
1400 command->buffer = NULL;
1401 respond->value = data;
1402 init_completion(&respond->wait_completion);
1403 ftdi->command_next += 1;
1404 ftdi->respond_next += 1;
1405 ftdi_elan_kick_command_queue(ftdi);
1406 up(&ftdi->u132_lock);
1407 wait_for_completion(&respond->wait_completion);
1410 up(&ftdi->u132_lock);
1417 static int ftdi_elan_read_config(struct usb_ftdi *ftdi, int config_offset,
1418 u8 width, u32 *data)
1420 u8 addressofs = config_offset / 4;
1421 wait:if (ftdi->disconnected > 0) {
1426 down(&ftdi->u132_lock);
1427 command_size = ftdi->command_next - ftdi->command_head;
1428 respond_size = ftdi->respond_next - ftdi->respond_head;
1429 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1431 struct u132_command *command = &ftdi->command[
1432 COMMAND_MASK & ftdi->command_next];
1433 struct u132_respond *respond = &ftdi->respond[
1434 RESPOND_MASK & ftdi->respond_next];
1435 int result = -ENODEV;
1436 respond->result = &result;
1437 respond->header = command->header = 0x00 | (cPCIcfgrd &
1439 command->length = 0x04;
1440 respond->address = command->address = addressofs;
1441 command->width = 0x00 | (width & 0x0F);
1442 command->follows = 0;
1444 command->buffer = NULL;
1445 respond->value = data;
1446 init_completion(&respond->wait_completion);
1447 ftdi->command_next += 1;
1448 ftdi->respond_next += 1;
1449 ftdi_elan_kick_command_queue(ftdi);
1450 up(&ftdi->u132_lock);
1451 wait_for_completion(&respond->wait_completion);
1454 up(&ftdi->u132_lock);
1461 static int ftdi_elan_read_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1462 u8 width, u32 *data)
1464 u8 addressofs = mem_offset / 4;
1465 wait:if (ftdi->disconnected > 0) {
1470 down(&ftdi->u132_lock);
1471 command_size = ftdi->command_next - ftdi->command_head;
1472 respond_size = ftdi->respond_next - ftdi->respond_head;
1473 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1475 struct u132_command *command = &ftdi->command[
1476 COMMAND_MASK & ftdi->command_next];
1477 struct u132_respond *respond = &ftdi->respond[
1478 RESPOND_MASK & ftdi->respond_next];
1479 int result = -ENODEV;
1480 respond->result = &result;
1481 respond->header = command->header = 0x00 | (cPCImemrd &
1483 command->length = 0x04;
1484 respond->address = command->address = addressofs;
1485 command->width = 0x00 | (width & 0x0F);
1486 command->follows = 0;
1488 command->buffer = NULL;
1489 respond->value = data;
1490 init_completion(&respond->wait_completion);
1491 ftdi->command_next += 1;
1492 ftdi->respond_next += 1;
1493 ftdi_elan_kick_command_queue(ftdi);
1494 up(&ftdi->u132_lock);
1495 wait_for_completion(&respond->wait_completion);
1498 up(&ftdi->u132_lock);
1505 int usb_ftdi_elan_read_pcimem(struct platform_device *pdev, int mem_offset,
1506 u8 width, u32 *data)
1508 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1509 if (ftdi->initialized == 0) {
1512 return ftdi_elan_read_pcimem(ftdi, mem_offset, width, data);
1516 EXPORT_SYMBOL_GPL(usb_ftdi_elan_read_pcimem);
1517 static int ftdi_elan_edset_setup(struct usb_ftdi *ftdi, u8 ed_number,
1518 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1519 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1520 int toggle_bits, int error_count, int condition_code, int repeat_number,
1521 int halted, int skipped, int actual, int non_null))
1523 u8 ed = ed_number - 1;
1524 wait:if (ftdi->disconnected > 0) {
1526 } else if (ftdi->initialized == 0) {
1530 down(&ftdi->u132_lock);
1531 command_size = ftdi->command_next - ftdi->command_head;
1532 if (command_size < COMMAND_SIZE) {
1533 struct u132_target *target = &ftdi->target[ed];
1534 struct u132_command *command = &ftdi->command[
1535 COMMAND_MASK & ftdi->command_next];
1536 command->header = 0x80 | (ed << 5);
1537 command->length = 0x8007;
1538 command->address = (toggle_bits << 6) | (ep_number << 2)
1540 command->width = usb_maxpacket(urb->dev, urb->pipe,
1541 usb_pipeout(urb->pipe));
1542 command->follows = 8;
1544 command->buffer = urb->setup_packet;
1545 target->callback = callback;
1546 target->endp = endp;
1549 ftdi->command_next += 1;
1550 ftdi_elan_kick_command_queue(ftdi);
1551 up(&ftdi->u132_lock);
1554 up(&ftdi->u132_lock);
1561 int usb_ftdi_elan_edset_setup(struct platform_device *pdev, u8 ed_number,
1562 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1563 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1564 int toggle_bits, int error_count, int condition_code, int repeat_number,
1565 int halted, int skipped, int actual, int non_null))
1567 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1568 return ftdi_elan_edset_setup(ftdi, ed_number, endp, urb, address,
1569 ep_number, toggle_bits, callback);
1573 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_setup);
1574 static int ftdi_elan_edset_input(struct usb_ftdi *ftdi, u8 ed_number,
1575 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1576 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1577 int toggle_bits, int error_count, int condition_code, int repeat_number,
1578 int halted, int skipped, int actual, int non_null))
1580 u8 ed = ed_number - 1;
1581 wait:if (ftdi->disconnected > 0) {
1583 } else if (ftdi->initialized == 0) {
1587 down(&ftdi->u132_lock);
1588 command_size = ftdi->command_next - ftdi->command_head;
1589 if (command_size < COMMAND_SIZE) {
1590 struct u132_target *target = &ftdi->target[ed];
1591 struct u132_command *command = &ftdi->command[
1592 COMMAND_MASK & ftdi->command_next];
1593 int remaining_length = urb->transfer_buffer_length -
1595 command->header = 0x82 | (ed << 5);
1596 if (remaining_length == 0) {
1597 command->length = 0x0000;
1598 } else if (remaining_length > 1024) {
1599 command->length = 0x8000 | 1023;
1601 command->length = 0x8000 | (remaining_length -
1603 command->address = (toggle_bits << 6) | (ep_number << 2)
1605 command->width = usb_maxpacket(urb->dev, urb->pipe,
1606 usb_pipeout(urb->pipe));
1607 command->follows = 0;
1609 command->buffer = NULL;
1610 target->callback = callback;
1611 target->endp = endp;
1614 ftdi->command_next += 1;
1615 ftdi_elan_kick_command_queue(ftdi);
1616 up(&ftdi->u132_lock);
1619 up(&ftdi->u132_lock);
1626 int usb_ftdi_elan_edset_input(struct platform_device *pdev, u8 ed_number,
1627 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1628 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1629 int toggle_bits, int error_count, int condition_code, int repeat_number,
1630 int halted, int skipped, int actual, int non_null))
1632 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1633 return ftdi_elan_edset_input(ftdi, ed_number, endp, urb, address,
1634 ep_number, toggle_bits, callback);
1638 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_input);
1639 static int ftdi_elan_edset_empty(struct usb_ftdi *ftdi, u8 ed_number,
1640 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1641 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1642 int toggle_bits, int error_count, int condition_code, int repeat_number,
1643 int halted, int skipped, int actual, int non_null))
1645 u8 ed = ed_number - 1;
1646 wait:if (ftdi->disconnected > 0) {
1648 } else if (ftdi->initialized == 0) {
1652 down(&ftdi->u132_lock);
1653 command_size = ftdi->command_next - ftdi->command_head;
1654 if (command_size < COMMAND_SIZE) {
1655 struct u132_target *target = &ftdi->target[ed];
1656 struct u132_command *command = &ftdi->command[
1657 COMMAND_MASK & ftdi->command_next];
1658 command->header = 0x81 | (ed << 5);
1659 command->length = 0x0000;
1660 command->address = (toggle_bits << 6) | (ep_number << 2)
1662 command->width = usb_maxpacket(urb->dev, urb->pipe,
1663 usb_pipeout(urb->pipe));
1664 command->follows = 0;
1666 command->buffer = NULL;
1667 target->callback = callback;
1668 target->endp = endp;
1671 ftdi->command_next += 1;
1672 ftdi_elan_kick_command_queue(ftdi);
1673 up(&ftdi->u132_lock);
1676 up(&ftdi->u132_lock);
1683 int usb_ftdi_elan_edset_empty(struct platform_device *pdev, u8 ed_number,
1684 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1685 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1686 int toggle_bits, int error_count, int condition_code, int repeat_number,
1687 int halted, int skipped, int actual, int non_null))
1689 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1690 return ftdi_elan_edset_empty(ftdi, ed_number, endp, urb, address,
1691 ep_number, toggle_bits, callback);
1695 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_empty);
1696 static int ftdi_elan_edset_output(struct usb_ftdi *ftdi, u8 ed_number,
1697 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1698 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1699 int toggle_bits, int error_count, int condition_code, int repeat_number,
1700 int halted, int skipped, int actual, int non_null))
1702 u8 ed = ed_number - 1;
1703 wait:if (ftdi->disconnected > 0) {
1705 } else if (ftdi->initialized == 0) {
1709 down(&ftdi->u132_lock);
1710 command_size = ftdi->command_next - ftdi->command_head;
1711 if (command_size < COMMAND_SIZE) {
1715 char data[30 *3 + 4];
1717 int m = (sizeof(data) - 1) / 3;
1719 struct u132_target *target = &ftdi->target[ed];
1720 struct u132_command *command = &ftdi->command[
1721 COMMAND_MASK & ftdi->command_next];
1722 command->header = 0x81 | (ed << 5);
1723 command->address = (toggle_bits << 6) | (ep_number << 2)
1725 command->width = usb_maxpacket(urb->dev, urb->pipe,
1726 usb_pipeout(urb->pipe));
1727 command->follows = min(1024,
1728 urb->transfer_buffer_length -
1729 urb->actual_length);
1731 command->buffer = urb->transfer_buffer +
1733 command->length = 0x8000 | (command->follows - 1);
1734 b = command->buffer;
1735 urb_size = command->follows;
1737 while (urb_size-- > 0) {
1739 } else if (i++ < m) {
1740 int w = sprintf(d, " %02X", *b++);
1744 d += sprintf(d, " ..");
1746 target->callback = callback;
1747 target->endp = endp;
1750 ftdi->command_next += 1;
1751 ftdi_elan_kick_command_queue(ftdi);
1752 up(&ftdi->u132_lock);
1755 up(&ftdi->u132_lock);
1762 int usb_ftdi_elan_edset_output(struct platform_device *pdev, u8 ed_number,
1763 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1764 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1765 int toggle_bits, int error_count, int condition_code, int repeat_number,
1766 int halted, int skipped, int actual, int non_null))
1768 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1769 return ftdi_elan_edset_output(ftdi, ed_number, endp, urb, address,
1770 ep_number, toggle_bits, callback);
1774 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_output);
1775 static int ftdi_elan_edset_single(struct usb_ftdi *ftdi, u8 ed_number,
1776 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1777 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1778 int toggle_bits, int error_count, int condition_code, int repeat_number,
1779 int halted, int skipped, int actual, int non_null))
1781 u8 ed = ed_number - 1;
1782 wait:if (ftdi->disconnected > 0) {
1784 } else if (ftdi->initialized == 0) {
1788 down(&ftdi->u132_lock);
1789 command_size = ftdi->command_next - ftdi->command_head;
1790 if (command_size < COMMAND_SIZE) {
1791 int remaining_length = urb->transfer_buffer_length -
1793 struct u132_target *target = &ftdi->target[ed];
1794 struct u132_command *command = &ftdi->command[
1795 COMMAND_MASK & ftdi->command_next];
1796 command->header = 0x83 | (ed << 5);
1797 if (remaining_length == 0) {
1798 command->length = 0x0000;
1799 } else if (remaining_length > 1024) {
1800 command->length = 0x8000 | 1023;
1802 command->length = 0x8000 | (remaining_length -
1804 command->address = (toggle_bits << 6) | (ep_number << 2)
1806 command->width = usb_maxpacket(urb->dev, urb->pipe,
1807 usb_pipeout(urb->pipe));
1808 command->follows = 0;
1810 command->buffer = NULL;
1811 target->callback = callback;
1812 target->endp = endp;
1815 ftdi->command_next += 1;
1816 ftdi_elan_kick_command_queue(ftdi);
1817 up(&ftdi->u132_lock);
1820 up(&ftdi->u132_lock);
1827 int usb_ftdi_elan_edset_single(struct platform_device *pdev, u8 ed_number,
1828 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1829 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1830 int toggle_bits, int error_count, int condition_code, int repeat_number,
1831 int halted, int skipped, int actual, int non_null))
1833 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1834 return ftdi_elan_edset_single(ftdi, ed_number, endp, urb, address,
1835 ep_number, toggle_bits, callback);
1839 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_single);
1840 static int ftdi_elan_edset_flush(struct usb_ftdi *ftdi, u8 ed_number,
1843 u8 ed = ed_number - 1;
1844 if (ftdi->disconnected > 0) {
1846 } else if (ftdi->initialized == 0) {
1849 struct u132_target *target = &ftdi->target[ed];
1850 down(&ftdi->u132_lock);
1851 if (target->abandoning > 0) {
1852 up(&ftdi->u132_lock);
1855 target->abandoning = 1;
1856 wait_1:if (target->active == 1) {
1857 int command_size = ftdi->command_next -
1859 if (command_size < COMMAND_SIZE) {
1860 struct u132_command *command =
1861 &ftdi->command[COMMAND_MASK &
1862 ftdi->command_next];
1863 command->header = 0x80 | (ed << 5) |
1865 command->length = 0x00;
1866 command->address = 0x00;
1867 command->width = 0x00;
1868 command->follows = 0;
1870 command->buffer = &command->value;
1871 ftdi->command_next += 1;
1872 ftdi_elan_kick_command_queue(ftdi);
1874 up(&ftdi->u132_lock);
1876 down(&ftdi->u132_lock);
1880 up(&ftdi->u132_lock);
1886 int usb_ftdi_elan_edset_flush(struct platform_device *pdev, u8 ed_number,
1889 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1890 return ftdi_elan_edset_flush(ftdi, ed_number, endp);
1894 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_flush);
1895 static int ftdi_elan_flush_input_fifo(struct usb_ftdi *ftdi)
1897 int retry_on_empty = 10;
1898 int retry_on_timeout = 5;
1899 int retry_on_status = 20;
1901 int packet_bytes = 0;
1902 int retval = usb_bulk_msg(ftdi->udev,
1903 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
1904 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
1905 &packet_bytes, msecs_to_jiffies(100));
1906 if (packet_bytes > 2) {
1907 char diag[30 *3 + 4];
1909 int m = (sizeof(diag) - 1) / 3;
1910 char *b = ftdi->bulk_in_buffer;
1913 while (packet_bytes-- > 0) {
1915 if (bytes_read < m) {
1916 d += sprintf(d, " %02X",
1918 } else if (bytes_read > m) {
1920 d += sprintf(d, " ..");
1925 } else if (packet_bytes > 1) {
1926 char s1 = ftdi->bulk_in_buffer[0];
1927 char s2 = ftdi->bulk_in_buffer[1];
1928 if (s1 == 0x31 && s2 == 0x60) {
1930 } else if (retry_on_status-- > 0) {
1933 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
1937 } else if (packet_bytes > 0) {
1938 char b1 = ftdi->bulk_in_buffer[0];
1939 dev_err(&ftdi->udev->dev, "only one byte flushed from F"
1940 "TDI = %02X\n", b1);
1941 if (retry_on_status-- > 0) {
1944 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
1948 } else if (retval == -ETIMEDOUT) {
1949 if (retry_on_timeout-- > 0) {
1952 dev_err(&ftdi->udev->dev, "TIMED OUT retry limi"
1956 } else if (retval == 0) {
1957 if (retry_on_empty-- > 0) {
1960 dev_err(&ftdi->udev->dev, "empty packet retry l"
1965 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
1974 * send the long flush sequence
1977 static int ftdi_elan_synchronize_flush(struct usb_ftdi *ftdi)
1984 urb = usb_alloc_urb(0, GFP_KERNEL);
1986 dev_err(&ftdi->udev->dev, "could not alloc a urb for flush sequ"
1990 buf = usb_buffer_alloc(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
1992 dev_err(&ftdi->udev->dev, "could not get a buffer for flush seq"
1999 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
2000 ftdi->bulk_out_endpointAddr), buf, i,
2001 ftdi_elan_write_bulk_callback, ftdi);
2002 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2003 retval = usb_submit_urb(urb, GFP_KERNEL);
2005 dev_err(&ftdi->udev->dev, "failed to submit urb containing the "
2006 "flush sequence\n");
2007 usb_buffer_free(ftdi->udev, i, buf, urb->transfer_dma);
2017 * send the reset sequence
2020 static int ftdi_elan_synchronize_reset(struct usb_ftdi *ftdi)
2027 urb = usb_alloc_urb(0, GFP_KERNEL);
2029 dev_err(&ftdi->udev->dev, "could not get a urb for the reset se"
2033 buf = usb_buffer_alloc(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
2035 dev_err(&ftdi->udev->dev, "could not get a buffer for the reset"
2044 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
2045 ftdi->bulk_out_endpointAddr), buf, i,
2046 ftdi_elan_write_bulk_callback, ftdi);
2047 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2048 retval = usb_submit_urb(urb, GFP_KERNEL);
2050 dev_err(&ftdi->udev->dev, "failed to submit urb containing the "
2051 "reset sequence\n");
2052 usb_buffer_free(ftdi->udev, i, buf, urb->transfer_dma);
2060 static int ftdi_elan_synchronize(struct usb_ftdi *ftdi)
2064 int retry_on_timeout = 5;
2065 int retry_on_empty = 10;
2067 retval = ftdi_elan_flush_input_fifo(ftdi);
2070 ftdi->bulk_in_left = 0;
2071 ftdi->bulk_in_last = -1;
2072 while (long_stop-- > 0) {
2075 retval = ftdi_elan_synchronize_flush(ftdi);
2078 retval = ftdi_elan_flush_input_fifo(ftdi);
2081 reset:retval = ftdi_elan_synchronize_reset(ftdi);
2087 int packet_bytes = 0;
2088 retval = usb_bulk_msg(ftdi->udev,
2089 usb_rcvbulkpipe(ftdi->udev,
2090 ftdi->bulk_in_endpointAddr),
2091 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2092 &packet_bytes, msecs_to_jiffies(500));
2093 if (packet_bytes > 2) {
2094 char diag[30 *3 + 4];
2096 int m = (sizeof(diag) - 1) / 3;
2097 char *b = ftdi->bulk_in_buffer;
2099 unsigned char c = 0;
2101 while (packet_bytes-- > 0) {
2103 if (bytes_read < m) {
2104 d += sprintf(d, " %02X", c);
2105 } else if (bytes_read > m) {
2107 d += sprintf(d, " ..");
2116 } else if (read_stop-- > 0) {
2119 dev_err(&ftdi->udev->dev, "retr"
2120 "y limit reached\n");
2124 } else if (packet_bytes > 1) {
2125 unsigned char s1 = ftdi->bulk_in_buffer[0];
2126 unsigned char s2 = ftdi->bulk_in_buffer[1];
2127 if (s1 == 0x31 && s2 == 0x00) {
2128 if (read_stuck-- > 0) {
2132 } else if (s1 == 0x31 && s2 == 0x60) {
2133 if (read_stop-- > 0) {
2136 dev_err(&ftdi->udev->dev, "retr"
2137 "y limit reached\n");
2141 if (read_stop-- > 0) {
2144 dev_err(&ftdi->udev->dev, "retr"
2145 "y limit reached\n");
2149 } else if (packet_bytes > 0) {
2150 if (read_stop-- > 0) {
2153 dev_err(&ftdi->udev->dev, "retry limit "
2157 } else if (retval == -ETIMEDOUT) {
2158 if (retry_on_timeout-- > 0) {
2161 dev_err(&ftdi->udev->dev, "TIMED OUT re"
2162 "try limit reached\n");
2165 } else if (retval == 0) {
2166 if (retry_on_empty-- > 0) {
2169 dev_err(&ftdi->udev->dev, "empty packet"
2170 " retry limit reached\n");
2175 dev_err(&ftdi->udev->dev, "error = %d\n",
2177 if (read_stop-- > 0) {
2180 dev_err(&ftdi->udev->dev, "retry limit "
2187 dev_err(&ftdi->udev->dev, "failed to synchronize\n");
2191 static int ftdi_elan_stuck_waiting(struct usb_ftdi *ftdi)
2193 int retry_on_empty = 10;
2194 int retry_on_timeout = 5;
2195 int retry_on_status = 50;
2197 int packet_bytes = 0;
2198 int retval = usb_bulk_msg(ftdi->udev,
2199 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
2200 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2201 &packet_bytes, msecs_to_jiffies(1000));
2202 if (packet_bytes > 2) {
2203 char diag[30 *3 + 4];
2205 int m = (sizeof(diag) - 1) / 3;
2206 char *b = ftdi->bulk_in_buffer;
2209 while (packet_bytes-- > 0) {
2211 if (bytes_read < m) {
2212 d += sprintf(d, " %02X",
2214 } else if (bytes_read > m) {
2216 d += sprintf(d, " ..");
2221 } else if (packet_bytes > 1) {
2222 char s1 = ftdi->bulk_in_buffer[0];
2223 char s2 = ftdi->bulk_in_buffer[1];
2224 if (s1 == 0x31 && s2 == 0x60) {
2226 } else if (retry_on_status-- > 0) {
2231 } else if (packet_bytes > 0) {
2232 char b1 = ftdi->bulk_in_buffer[0];
2233 dev_err(&ftdi->udev->dev, "only one byte flushed from F"
2234 "TDI = %02X\n", b1);
2235 if (retry_on_status-- > 0) {
2239 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
2243 } else if (retval == -ETIMEDOUT) {
2244 if (retry_on_timeout-- > 0) {
2247 dev_err(&ftdi->udev->dev, "TIMED OUT retry limi"
2251 } else if (retval == 0) {
2252 if (retry_on_empty-- > 0) {
2255 dev_err(&ftdi->udev->dev, "empty packet retry l"
2260 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
2267 static int ftdi_elan_checkingPCI(struct usb_ftdi *ftdi)
2269 int UxxxStatus = ftdi_elan_read_reg(ftdi, &ftdi->controlreg);
2272 if (ftdi->controlreg & 0x00400000) {
2273 if (ftdi->card_ejected) {
2275 ftdi->card_ejected = 1;
2276 dev_err(&ftdi->udev->dev, "CARD EJECTED - controlreg = "
2277 "%08X\n", ftdi->controlreg);
2281 u8 fn = ftdi->function - 1;
2282 int activePCIfn = fn << 8;
2287 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2291 pciVID = pcidata & 0xFFFF;
2292 pciPID = (pcidata >> 16) & 0xFFFF;
2293 if (pciVID == ftdi->platform_data.vendor && pciPID ==
2294 ftdi->platform_data.device) {
2297 dev_err(&ftdi->udev->dev, "vendor=%04X pciVID=%04X devi"
2298 "ce=%04X pciPID=%04X\n",
2299 ftdi->platform_data.vendor, pciVID,
2300 ftdi->platform_data.device, pciPID);
2307 #define ftdi_read_pcimem(ftdi, member, data) ftdi_elan_read_pcimem(ftdi, \
2308 offsetof(struct ohci_regs, member), 0, data);
2309 #define ftdi_write_pcimem(ftdi, member, data) ftdi_elan_write_pcimem(ftdi, \
2310 offsetof(struct ohci_regs, member), 0, data);
2312 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
2313 #define OHCI_INTR_INIT (OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_RD | \
2315 static int ftdi_elan_check_controller(struct usb_ftdi *ftdi, int quirk)
2329 int mask = OHCI_INTR_INIT;
2331 int reset_timeout = 30; /* ... allow extra time */
2333 retval = ftdi_write_pcimem(ftdi, intrdisable, OHCI_INTR_MIE);
2336 retval = ftdi_read_pcimem(ftdi, control, &control);
2339 retval = ftdi_read_pcimem(ftdi, roothub.a, &rh_a);
2342 num_ports = rh_a & RH_A_NDP;
2343 retval = ftdi_read_pcimem(ftdi, fminterval, &hc_fminterval);
2346 hc_fminterval &= 0x3fff;
2347 if (hc_fminterval != FI) {
2349 hc_fminterval |= FSMP(hc_fminterval) << 16;
2350 retval = ftdi_read_pcimem(ftdi, control, &hc_control);
2353 switch (hc_control & OHCI_CTRL_HCFS) {
2357 case OHCI_USB_SUSPEND:
2358 case OHCI_USB_RESUME:
2359 hc_control &= OHCI_CTRL_RWC;
2360 hc_control |= OHCI_USB_RESUME;
2364 hc_control &= OHCI_CTRL_RWC;
2365 hc_control |= OHCI_USB_RESET;
2369 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2372 retval = ftdi_read_pcimem(ftdi, control, &control);
2376 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2379 if (!(roothub_a & RH_A_NPS)) { /* power down each port */
2380 for (temp = 0; temp < num_ports; temp++) {
2381 retval = ftdi_write_pcimem(ftdi,
2382 roothub.portstatus[temp], RH_PS_LSDA);
2387 retval = ftdi_read_pcimem(ftdi, control, &control);
2390 retry:retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2393 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_HCR);
2397 retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2400 if (0 != (status & OHCI_HCR)) {
2401 if (--reset_timeout == 0) {
2402 dev_err(&ftdi->udev->dev, "USB HC reset timed o"
2411 if (quirk & OHCI_QUIRK_INITRESET) {
2412 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2415 retval = ftdi_read_pcimem(ftdi, control, &control);
2419 retval = ftdi_write_pcimem(ftdi, ed_controlhead, 0x00000000);
2422 retval = ftdi_write_pcimem(ftdi, ed_bulkhead, 0x11000000);
2425 retval = ftdi_write_pcimem(ftdi, hcca, 0x00000000);
2428 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2431 retval = ftdi_write_pcimem(ftdi, fminterval,
2432 ((fminterval & FIT) ^ FIT) | hc_fminterval);
2435 retval = ftdi_write_pcimem(ftdi, periodicstart,
2436 ((9 *hc_fminterval) / 10) & 0x3fff);
2439 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2442 retval = ftdi_read_pcimem(ftdi, periodicstart, &periodicstart);
2445 if (0 == (fminterval & 0x3fff0000) || 0 == periodicstart) {
2446 if (!(quirk & OHCI_QUIRK_INITRESET)) {
2447 quirk |= OHCI_QUIRK_INITRESET;
2450 dev_err(&ftdi->udev->dev, "init err(%08x %04x)\n",
2451 fminterval, periodicstart);
2452 } /* start controller operations */
2453 hc_control &= OHCI_CTRL_RWC;
2454 hc_control |= OHCI_CONTROL_INIT | OHCI_CTRL_BLE | OHCI_USB_OPER;
2455 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2458 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_BLF);
2461 retval = ftdi_read_pcimem(ftdi, cmdstatus, &cmdstatus);
2464 retval = ftdi_read_pcimem(ftdi, control, &control);
2467 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_DRWE);
2470 retval = ftdi_write_pcimem(ftdi, intrstatus, mask);
2473 retval = ftdi_write_pcimem(ftdi, intrdisable,
2474 OHCI_INTR_MIE | OHCI_INTR_OC | OHCI_INTR_RHSC | OHCI_INTR_FNO |
2475 OHCI_INTR_UE | OHCI_INTR_RD | OHCI_INTR_SF | OHCI_INTR_WDH |
2478 return retval; /* handle root hub init quirks ... */
2479 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2482 roothub_a &= ~(RH_A_PSM | RH_A_OCPM);
2483 if (quirk & OHCI_QUIRK_SUPERIO) {
2484 roothub_a |= RH_A_NOCP;
2485 roothub_a &= ~(RH_A_POTPGT | RH_A_NPS);
2486 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2489 } else if ((quirk & OHCI_QUIRK_AMD756) || distrust_firmware) {
2490 roothub_a |= RH_A_NPS;
2491 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2495 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_LPSC);
2498 retval = ftdi_write_pcimem(ftdi, roothub.b,
2499 (roothub_a & RH_A_NPS) ? 0 : RH_B_PPCM);
2502 retval = ftdi_read_pcimem(ftdi, control, &control);
2505 mdelay((roothub_a >> 23) & 0x1fe);
2506 for (temp = 0; temp < num_ports; temp++) {
2508 retval = ftdi_read_pcimem(ftdi, roothub.portstatus[temp],
2518 static int ftdi_elan_setup_controller(struct usb_ftdi *ftdi, int fn)
2524 int activePCIfn = fn << 8;
2525 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2529 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2533 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2537 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2541 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2546 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2550 latence_timer &= 0xFFFF00FF;
2551 latence_timer |= 0x00001600;
2552 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2556 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2561 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2565 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2569 for (reg = 0; reg <= 0x54; reg += 4) {
2570 UxxxStatus = ftdi_elan_read_pcimem(ftdi, reg, 0, &pcidata);
2577 static int ftdi_elan_close_controller(struct usb_ftdi *ftdi, int fn)
2583 int activePCIfn = fn << 8;
2584 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2588 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2592 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2596 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2600 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2605 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2609 latence_timer &= 0xFFFF00FF;
2610 latence_timer |= 0x00001600;
2611 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2615 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2620 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2624 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2631 static int ftdi_elan_found_controller(struct usb_ftdi *ftdi, int fn, int quirk)
2635 UxxxStatus = ftdi_elan_setup_controller(ftdi, fn);
2638 result = ftdi_elan_check_controller(ftdi, quirk);
2639 UxxxStatus = ftdi_elan_close_controller(ftdi, fn);
2645 static int ftdi_elan_enumeratePCI(struct usb_ftdi *ftdi)
2650 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2653 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000000L);
2657 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x100);
2660 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x500);
2663 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2666 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020CL | 0x000);
2669 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020DL | 0x000);
2673 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020FL | 0x000);
2676 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2679 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x800);
2682 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2685 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2689 sensebits = (controlreg >> 16) & 0x000F;
2690 if (0x0D == sensebits)
2696 static int ftdi_elan_setupOHCI(struct usb_ftdi *ftdi)
2702 int activePCIfn = 0;
2703 int max_devices = 0;
2704 int controllers = 0;
2705 int unrecognized = 0;
2707 for (fn = 0; (fn < 4); fn++) {
2711 activePCIfn = fn << 8;
2712 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2716 pciVID = pcidata & 0xFFFF;
2717 pciPID = (pcidata >> 16) & 0xFFFF;
2718 if ((pciVID == PCI_VENDOR_ID_OPTI) && (pciPID == 0xc861)) {
2719 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2721 } else if ((pciVID == PCI_VENDOR_ID_NEC) && (pciPID == 0x0035))
2723 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2725 } else if ((pciVID == PCI_VENDOR_ID_AL) && (pciPID == 0x5237)) {
2726 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2728 } else if ((pciVID == PCI_VENDOR_ID_ATT) && (pciPID == 0x5802))
2730 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2732 } else if (pciVID == PCI_VENDOR_ID_AMD && pciPID == 0x740c) {
2733 devices = ftdi_elan_found_controller(ftdi, fn,
2736 } else if (pciVID == PCI_VENDOR_ID_COMPAQ && pciPID == 0xa0f8) {
2737 devices = ftdi_elan_found_controller(ftdi, fn,
2738 OHCI_QUIRK_ZFMICRO);
2740 } else if (0 == pcidata) {
2743 if (devices > max_devices) {
2744 max_devices = devices;
2745 ftdi->function = fn + 1;
2746 ftdi->platform_data.vendor = pciVID;
2747 ftdi->platform_data.device = pciPID;
2750 if (ftdi->function > 0) {
2751 UxxxStatus = ftdi_elan_setup_controller(ftdi,
2752 ftdi->function - 1);
2756 } else if (controllers > 0) {
2758 } else if (unrecognized > 0) {
2761 ftdi->enumerated = 0;
2768 * we use only the first bulk-in and bulk-out endpoints
2770 static int ftdi_elan_probe(struct usb_interface *interface,
2771 const struct usb_device_id *id)
2773 struct usb_host_interface *iface_desc;
2774 struct usb_endpoint_descriptor *endpoint;
2777 int retval = -ENOMEM;
2778 struct usb_ftdi *ftdi = kmalloc(sizeof(struct usb_ftdi), GFP_KERNEL);
2780 printk(KERN_ERR "Out of memory\n");
2783 memset(ftdi, 0x00, sizeof(struct usb_ftdi));
2784 mutex_lock(&ftdi_module_lock);
2785 list_add_tail(&ftdi->ftdi_list, &ftdi_static_list);
2786 ftdi->sequence_num = ++ftdi_instances;
2787 mutex_unlock(&ftdi_module_lock);
2788 ftdi_elan_init_kref(ftdi);
2789 init_MUTEX(&ftdi->sw_lock);
2790 ftdi->udev = usb_get_dev(interface_to_usbdev(interface));
2791 ftdi->interface = interface;
2792 init_MUTEX(&ftdi->u132_lock);
2794 iface_desc = interface->cur_altsetting;
2795 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
2796 endpoint = &iface_desc->endpoint[i].desc;
2797 if (!ftdi->bulk_in_endpointAddr &&
2798 usb_endpoint_is_bulk_in(endpoint)) {
2799 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
2800 ftdi->bulk_in_size = buffer_size;
2801 ftdi->bulk_in_endpointAddr = endpoint->bEndpointAddress;
2802 ftdi->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
2803 if (!ftdi->bulk_in_buffer) {
2804 dev_err(&ftdi->udev->dev, "Could not allocate b"
2810 if (!ftdi->bulk_out_endpointAddr &&
2811 usb_endpoint_is_bulk_out(endpoint)) {
2812 ftdi->bulk_out_endpointAddr =
2813 endpoint->bEndpointAddress;
2816 if (!(ftdi->bulk_in_endpointAddr && ftdi->bulk_out_endpointAddr)) {
2817 dev_err(&ftdi->udev->dev, "Could not find both bulk-in and bulk"
2818 "-out endpoints\n");
2822 dev_info(&ftdi->udev->dev, "interface %d has I=%02X O=%02X\n",
2823 iface_desc->desc.bInterfaceNumber, ftdi->bulk_in_endpointAddr,
2824 ftdi->bulk_out_endpointAddr);
2825 usb_set_intfdata(interface, ftdi);
2826 if (iface_desc->desc.bInterfaceNumber == 0 &&
2827 ftdi->bulk_in_endpointAddr == 0x81 &&
2828 ftdi->bulk_out_endpointAddr == 0x02) {
2829 retval = usb_register_dev(interface, &ftdi_elan_jtag_class);
2831 dev_err(&ftdi->udev->dev, "Not able to get a minor for "
2833 usb_set_intfdata(interface, NULL);
2837 ftdi->class = &ftdi_elan_jtag_class;
2838 dev_info(&ftdi->udev->dev, "USB FDTI=%p JTAG interface "
2839 "%d now attached to ftdi%d\n", ftdi,
2840 iface_desc->desc.bInterfaceNumber,
2844 } else if (iface_desc->desc.bInterfaceNumber == 1 &&
2845 ftdi->bulk_in_endpointAddr == 0x83 &&
2846 ftdi->bulk_out_endpointAddr == 0x04) {
2848 dev_info(&ftdi->udev->dev, "USB FDTI=%p ELAN interface %d now a"
2849 "ctivated\n", ftdi, iface_desc->desc.bInterfaceNumber);
2850 INIT_DELAYED_WORK(&ftdi->status_work, ftdi_elan_status_work);
2851 INIT_DELAYED_WORK(&ftdi->command_work, ftdi_elan_command_work);
2852 INIT_DELAYED_WORK(&ftdi->respond_work, ftdi_elan_respond_work);
2853 ftdi_status_queue_work(ftdi, msecs_to_jiffies(3 *1000));
2856 dev_err(&ftdi->udev->dev,
2857 "Could not find ELAN's U132 device\n");
2862 ftdi_elan_put_kref(ftdi);
2867 static void ftdi_elan_disconnect(struct usb_interface *interface)
2869 struct usb_ftdi *ftdi = usb_get_intfdata(interface);
2870 ftdi->disconnected += 1;
2872 int minor = interface->minor;
2873 struct usb_class_driver *class = ftdi->class;
2874 usb_set_intfdata(interface, NULL);
2875 usb_deregister_dev(interface, class);
2876 dev_info(&ftdi->udev->dev, "USB FTDI U132 jtag interface on min"
2877 "or %d now disconnected\n", minor);
2879 ftdi_status_cancel_work(ftdi);
2880 ftdi_command_cancel_work(ftdi);
2881 ftdi_response_cancel_work(ftdi);
2882 ftdi_elan_abandon_completions(ftdi);
2883 ftdi_elan_abandon_targets(ftdi);
2884 if (ftdi->registered) {
2885 platform_device_unregister(&ftdi->platform_dev);
2886 ftdi->synchronized = 0;
2887 ftdi->enumerated = 0;
2888 ftdi->initialized = 0;
2889 ftdi->registered = 0;
2891 flush_workqueue(status_queue);
2892 flush_workqueue(command_queue);
2893 flush_workqueue(respond_queue);
2894 ftdi->disconnected += 1;
2895 usb_set_intfdata(interface, NULL);
2896 dev_info(&ftdi->udev->dev, "USB FTDI U132 host controller inter"
2897 "face now disconnected\n");
2899 ftdi_elan_put_kref(ftdi);
2902 static struct usb_driver ftdi_elan_driver = {
2903 .name = "ftdi-elan",
2904 .probe = ftdi_elan_probe,
2905 .disconnect = ftdi_elan_disconnect,
2906 .id_table = ftdi_elan_table,
2908 static int __init ftdi_elan_init(void)
2911 printk(KERN_INFO "driver %s built at %s on %s\n", ftdi_elan_driver.name,
2912 __TIME__, __DATE__);
2913 mutex_init(&ftdi_module_lock);
2914 INIT_LIST_HEAD(&ftdi_static_list);
2915 status_queue = create_singlethread_workqueue("ftdi-status-control");
2917 goto err_status_queue;
2918 command_queue = create_singlethread_workqueue("ftdi-command-engine");
2920 goto err_command_queue;
2921 respond_queue = create_singlethread_workqueue("ftdi-respond-engine");
2923 goto err_respond_queue;
2924 result = usb_register(&ftdi_elan_driver);
2926 destroy_workqueue(status_queue);
2927 destroy_workqueue(command_queue);
2928 destroy_workqueue(respond_queue);
2929 printk(KERN_ERR "usb_register failed. Error number %d\n",
2935 destroy_workqueue(command_queue);
2937 destroy_workqueue(status_queue);
2939 printk(KERN_ERR "%s couldn't create workqueue\n", ftdi_elan_driver.name);
2943 static void __exit ftdi_elan_exit(void)
2945 struct usb_ftdi *ftdi;
2946 struct usb_ftdi *temp;
2947 usb_deregister(&ftdi_elan_driver);
2948 printk(KERN_INFO "ftdi_u132 driver deregistered\n");
2949 list_for_each_entry_safe(ftdi, temp, &ftdi_static_list, ftdi_list) {
2950 ftdi_status_cancel_work(ftdi);
2951 ftdi_command_cancel_work(ftdi);
2952 ftdi_response_cancel_work(ftdi);
2953 } flush_workqueue(status_queue);
2954 destroy_workqueue(status_queue);
2955 status_queue = NULL;
2956 flush_workqueue(command_queue);
2957 destroy_workqueue(command_queue);
2958 command_queue = NULL;
2959 flush_workqueue(respond_queue);
2960 destroy_workqueue(respond_queue);
2961 respond_queue = NULL;
2965 module_init(ftdi_elan_init);
2966 module_exit(ftdi_elan_exit);