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 mutex 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 mutex_lock(&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 } mutex_unlock(&ftdi->u132_lock);
343 static void ftdi_elan_abandon_targets(struct usb_ftdi *ftdi)
346 mutex_lock(&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 mutex_unlock(&ftdi->u132_lock);
352 ftdi_elan_do_callback(ftdi, target, NULL, 0);
353 mutex_lock(&ftdi->u132_lock);
359 mutex_unlock(&ftdi->u132_lock);
362 static void ftdi_elan_flush_targets(struct usb_ftdi *ftdi)
365 mutex_lock(&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 mutex_unlock(&ftdi->u132_lock);
387 mutex_lock(&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 mutex_unlock(&ftdi->u132_lock);
409 mutex_lock(&ftdi->u132_lock);
417 mutex_unlock(&ftdi->u132_lock);
420 static void ftdi_elan_cancel_targets(struct usb_ftdi *ftdi)
423 mutex_lock(&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 mutex_unlock(&ftdi->u132_lock);
445 mutex_lock(&ftdi->u132_lock);
453 mutex_unlock(&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);
661 * blocking bulk reads are used to get data from the device
664 static ssize_t ftdi_elan_read(struct file *file, char __user *buffer,
665 size_t count, loff_t *ppos)
667 char data[30 *3 + 4];
669 int m = (sizeof(data) - 1) / 3;
671 int retry_on_empty = 10;
672 int retry_on_timeout = 5;
673 struct usb_ftdi *ftdi = (struct usb_ftdi *)file->private_data;
674 if (ftdi->disconnected > 0) {
678 have:if (ftdi->bulk_in_left > 0) {
680 char *p = ++ftdi->bulk_in_last + ftdi->bulk_in_buffer;
681 ftdi->bulk_in_left -= 1;
682 if (bytes_read < m) {
683 d += sprintf(d, " %02X", 0x000000FF & *p);
684 } else if (bytes_read > m) {
686 d += sprintf(d, " ..");
687 if (copy_to_user(buffer++, p, 1)) {
696 more:if (count > 0) {
697 int packet_bytes = 0;
698 int retval = usb_bulk_msg(ftdi->udev,
699 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
700 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
702 if (packet_bytes > 2) {
703 ftdi->bulk_in_left = packet_bytes - 2;
704 ftdi->bulk_in_last = 1;
706 } else if (retval == -ETIMEDOUT) {
707 if (retry_on_timeout-- > 0) {
709 } else if (bytes_read > 0) {
713 } else if (retval == 0) {
714 if (retry_on_empty-- > 0) {
724 static void ftdi_elan_write_bulk_callback(struct urb *urb)
726 struct usb_ftdi *ftdi = urb->context;
727 int status = urb->status;
729 if (status && !(status == -ENOENT || status == -ECONNRESET ||
730 status == -ESHUTDOWN)) {
731 dev_err(&ftdi->udev->dev, "urb=%p write bulk status received: %"
734 usb_buffer_free(urb->dev, urb->transfer_buffer_length,
735 urb->transfer_buffer, urb->transfer_dma);
738 static int fill_buffer_with_all_queued_commands(struct usb_ftdi *ftdi,
739 char *buf, int command_size, int total_size)
743 int I = command_size;
744 int i = ftdi->command_head;
746 struct u132_command *command = &ftdi->command[COMMAND_MASK &
748 int F = command->follows;
749 u8 *f = command->buffer;
750 if (command->header & 0x80) {
751 ed_commands |= 1 << (0x3 & (command->header >> 5));
753 buf[b++] = command->header;
754 buf[b++] = (command->length >> 0) & 0x00FF;
755 buf[b++] = (command->length >> 8) & 0x00FF;
756 buf[b++] = command->address;
757 buf[b++] = command->width;
765 static int ftdi_elan_total_command_size(struct usb_ftdi *ftdi, int command_size)
768 int I = command_size;
769 int i = ftdi->command_head;
771 struct u132_command *command = &ftdi->command[COMMAND_MASK &
773 total_size += 5 + command->follows;
777 static int ftdi_elan_command_engine(struct usb_ftdi *ftdi)
784 int command_size = ftdi->command_next - ftdi->command_head;
785 if (command_size == 0)
787 total_size = ftdi_elan_total_command_size(ftdi, command_size);
788 urb = usb_alloc_urb(0, GFP_KERNEL);
790 dev_err(&ftdi->udev->dev, "could not get a urb to write %d comm"
791 "ands totaling %d bytes to the Uxxx\n", command_size,
795 buf = usb_buffer_alloc(ftdi->udev, total_size, GFP_KERNEL,
798 dev_err(&ftdi->udev->dev, "could not get a buffer to write %d c"
799 "ommands totaling %d bytes to the Uxxx\n", command_size,
804 ed_commands = fill_buffer_with_all_queued_commands(ftdi, buf,
805 command_size, total_size);
806 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
807 ftdi->bulk_out_endpointAddr), buf, total_size,
808 ftdi_elan_write_bulk_callback, ftdi);
809 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
811 char diag[40 *3 + 4];
815 int s = (sizeof(diag) - 1) / 3;
817 while (s-- > 0 && m-- > 0) {
818 if (s > 0 || m == 0) {
819 d += sprintf(d, " %02X", *c++);
821 d += sprintf(d, " ..");
824 retval = usb_submit_urb(urb, GFP_KERNEL);
826 dev_err(&ftdi->udev->dev, "failed %d to submit urb %p to write "
827 "%d commands totaling %d bytes to the Uxxx\n", retval,
828 urb, command_size, total_size);
829 usb_buffer_free(ftdi->udev, total_size, buf, urb->transfer_dma);
833 usb_free_urb(urb); /* release our reference to this urb,
834 the USB core will eventually free it entirely */
835 ftdi->command_head += command_size;
836 ftdi_elan_kick_respond_queue(ftdi);
840 static void ftdi_elan_do_callback(struct usb_ftdi *ftdi,
841 struct u132_target *target, u8 *buffer, int length)
843 struct urb *urb = target->urb;
844 int halted = target->halted;
845 int skipped = target->skipped;
846 int actual = target->actual;
847 int non_null = target->non_null;
848 int toggle_bits = target->toggle_bits;
849 int error_count = target->error_count;
850 int condition_code = target->condition_code;
851 int repeat_number = target->repeat_number;
852 void (*callback) (void *, struct urb *, u8 *, int, int, int, int, int,
853 int, int, int, int) = target->callback;
855 target->callback = NULL;
856 (*callback) (target->endp, urb, buffer, length, toggle_bits,
857 error_count, condition_code, repeat_number, halted, skipped,
861 static char *have_ed_set_response(struct usb_ftdi *ftdi,
862 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
865 int payload = (ed_length >> 0) & 0x07FF;
866 mutex_lock(&ftdi->u132_lock);
868 target->non_null = (ed_length >> 15) & 0x0001;
869 target->repeat_number = (ed_length >> 11) & 0x000F;
870 if (ed_type == 0x02) {
871 if (payload == 0 || target->abandoning > 0) {
872 target->abandoning = 0;
873 mutex_unlock(&ftdi->u132_lock);
874 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
879 return ftdi->response;
881 ftdi->expected = 4 + payload;
883 mutex_unlock(&ftdi->u132_lock);
886 } else if (ed_type == 0x03) {
887 if (payload == 0 || target->abandoning > 0) {
888 target->abandoning = 0;
889 mutex_unlock(&ftdi->u132_lock);
890 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
895 return ftdi->response;
897 ftdi->expected = 4 + payload;
899 mutex_unlock(&ftdi->u132_lock);
902 } else if (ed_type == 0x01) {
903 target->abandoning = 0;
904 mutex_unlock(&ftdi->u132_lock);
905 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
910 return ftdi->response;
912 target->abandoning = 0;
913 mutex_unlock(&ftdi->u132_lock);
914 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
919 return ftdi->response;
923 static char *have_ed_get_response(struct usb_ftdi *ftdi,
924 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
927 mutex_lock(&ftdi->u132_lock);
928 target->condition_code = TD_DEVNOTRESP;
929 target->actual = (ed_length >> 0) & 0x01FF;
930 target->non_null = (ed_length >> 15) & 0x0001;
931 target->repeat_number = (ed_length >> 11) & 0x000F;
932 mutex_unlock(&ftdi->u132_lock);
934 ftdi_elan_do_callback(ftdi, target, NULL, 0);
935 target->abandoning = 0;
939 return ftdi->response;
944 * The engine tries to empty the FTDI fifo
946 * all responses found in the fifo data are dispatched thus
947 * the response buffer can only ever hold a maximum sized
948 * response from the Uxxx.
951 static int ftdi_elan_respond_engine(struct usb_ftdi *ftdi)
953 u8 *b = ftdi->response + ftdi->recieved;
955 int retry_on_empty = 1;
956 int retry_on_timeout = 3;
957 int empty_packets = 0;
959 int packet_bytes = 0;
960 int retval = usb_bulk_msg(ftdi->udev,
961 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
962 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
964 char diag[30 *3 + 4];
966 int m = packet_bytes;
967 u8 *c = ftdi->bulk_in_buffer;
968 int s = (sizeof(diag) - 1) / 3;
970 while (s-- > 0 && m-- > 0) {
971 if (s > 0 || m == 0) {
972 d += sprintf(d, " %02X", *c++);
974 d += sprintf(d, " ..");
976 if (packet_bytes > 2) {
977 ftdi->bulk_in_left = packet_bytes - 2;
978 ftdi->bulk_in_last = 1;
980 } else if (retval == -ETIMEDOUT) {
981 if (retry_on_timeout-- > 0) {
982 dev_err(&ftdi->udev->dev, "TIMED OUT with packe"
983 "t_bytes = %d with total %d bytes%s\n",
984 packet_bytes, bytes_read, diag);
986 } else if (bytes_read > 0) {
987 dev_err(&ftdi->udev->dev, "ONLY %d bytes%s\n",
991 dev_err(&ftdi->udev->dev, "TIMED OUT with packe"
992 "t_bytes = %d with total %d bytes%s\n",
993 packet_bytes, bytes_read, diag);
996 } else if (retval == -EILSEQ) {
997 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes"
998 " = %d with total %d bytes%s\n", retval,
999 packet_bytes, bytes_read, diag);
1001 } else if (retval) {
1002 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes"
1003 " = %d with total %d bytes%s\n", retval,
1004 packet_bytes, bytes_read, diag);
1006 } else if (packet_bytes == 2) {
1007 unsigned char s0 = ftdi->bulk_in_buffer[0];
1008 unsigned char s1 = ftdi->bulk_in_buffer[1];
1010 if (s0 == 0x31 && s1 == 0x60) {
1011 if (retry_on_empty-- > 0) {
1015 } else if (s0 == 0x31 && s1 == 0x00) {
1016 if (retry_on_empty-- > 0) {
1021 if (retry_on_empty-- > 0) {
1026 } else if (packet_bytes == 1) {
1027 if (retry_on_empty-- > 0) {
1032 if (retry_on_empty-- > 0) {
1041 have:if (ftdi->bulk_in_left > 0) {
1042 u8 c = ftdi->bulk_in_buffer[++ftdi->bulk_in_last];
1044 ftdi->bulk_in_left -= 1;
1045 if (ftdi->recieved == 0 && c == 0xFF) {
1049 if (++ftdi->recieved < ftdi->expected) {
1051 } else if (ftdi->ed_found) {
1052 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1053 u16 ed_length = (ftdi->response[2] << 8) |
1055 struct u132_target *target = &ftdi->target[ed_number];
1056 int payload = (ed_length >> 0) & 0x07FF;
1057 char diag[30 *3 + 4];
1060 u8 *c = 4 + ftdi->response;
1061 int s = (sizeof(diag) - 1) / 3;
1063 while (s-- > 0 && m-- > 0) {
1064 if (s > 0 || m == 0) {
1065 d += sprintf(d, " %02X", *c++);
1067 d += sprintf(d, " ..");
1069 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
1076 } else if (ftdi->expected == 8) {
1078 int respond_head = ftdi->respond_head++;
1079 struct u132_respond *respond = &ftdi->respond[
1080 RESPOND_MASK & respond_head];
1081 u32 data = ftdi->response[7];
1083 data |= ftdi->response[6];
1085 data |= ftdi->response[5];
1087 data |= ftdi->response[4];
1088 *respond->value = data;
1089 *respond->result = 0;
1090 complete(&respond->wait_completion);
1095 buscmd = (ftdi->response[0] >> 0) & 0x0F;
1096 if (buscmd == 0x00) {
1097 } else if (buscmd == 0x02) {
1098 } else if (buscmd == 0x06) {
1099 } else if (buscmd == 0x0A) {
1101 dev_err(&ftdi->udev->dev, "Uxxx unknown(%0X) va"
1102 "lue = %08X\n", buscmd, data);
1105 if ((ftdi->response[0] & 0x80) == 0x00) {
1109 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1110 int ed_type = (ftdi->response[0] >> 0) & 0x03;
1111 u16 ed_length = (ftdi->response[2] << 8) |
1113 struct u132_target *target = &ftdi->target[
1115 target->halted = (ftdi->response[0] >> 3) &
1117 target->skipped = (ftdi->response[0] >> 2) &
1119 target->toggle_bits = (ftdi->response[3] >> 6)
1121 target->error_count = (ftdi->response[3] >> 4)
1123 target->condition_code = (ftdi->response[
1125 if ((ftdi->response[0] & 0x10) == 0x00) {
1126 b = have_ed_set_response(ftdi, target,
1127 ed_length, ed_number, ed_type,
1131 b = have_ed_get_response(ftdi, target,
1132 ed_length, ed_number, ed_type,
1144 * create a urb, and a buffer for it, and copy the data to the urb
1147 static ssize_t ftdi_elan_write(struct file *file,
1148 const char __user *user_buffer, size_t count,
1154 struct usb_ftdi *ftdi = file->private_data;
1156 if (ftdi->disconnected > 0) {
1162 urb = usb_alloc_urb(0, GFP_KERNEL);
1167 buf = usb_buffer_alloc(ftdi->udev, count, GFP_KERNEL,
1168 &urb->transfer_dma);
1173 if (copy_from_user(buf, user_buffer, count)) {
1177 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
1178 ftdi->bulk_out_endpointAddr), buf, count,
1179 ftdi_elan_write_bulk_callback, ftdi);
1180 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1181 retval = usb_submit_urb(urb, GFP_KERNEL);
1183 dev_err(&ftdi->udev->dev, "failed submitting write urb, error %"
1192 usb_buffer_free(ftdi->udev, count, buf, urb->transfer_dma);
1199 static const struct file_operations ftdi_elan_fops = {
1200 .owner = THIS_MODULE,
1201 .llseek = no_llseek,
1202 .read = ftdi_elan_read,
1203 .write = ftdi_elan_write,
1204 .open = ftdi_elan_open,
1205 .release = ftdi_elan_release,
1209 * usb class driver info in order to get a minor number from the usb core,
1210 * and to have the device registered with the driver core
1212 static struct usb_class_driver ftdi_elan_jtag_class = {
1213 .name = "ftdi-%d-jtag",
1214 .fops = &ftdi_elan_fops,
1215 .minor_base = USB_FTDI_ELAN_MINOR_BASE,
1219 * the following definitions are for the
1220 * ELAN FPGA state machgine processor that
1221 * lies on the other side of the FTDI chip
1223 #define cPCIu132rd 0x0
1224 #define cPCIu132wr 0x1
1225 #define cPCIiord 0x2
1226 #define cPCIiowr 0x3
1227 #define cPCImemrd 0x6
1228 #define cPCImemwr 0x7
1229 #define cPCIcfgrd 0xA
1230 #define cPCIcfgwr 0xB
1231 #define cPCInull 0xF
1232 #define cU132cmd_status 0x0
1233 #define cU132flash 0x1
1234 #define cPIDsetup 0x0
1237 #define cPIDinonce 0x3
1238 #define cCCnoerror 0x0
1240 #define cCCbitstuff 0x2
1241 #define cCCtoggle 0x3
1242 #define cCCstall 0x4
1243 #define cCCnoresp 0x5
1244 #define cCCbadpid1 0x6
1245 #define cCCbadpid2 0x7
1246 #define cCCdataoverrun 0x8
1247 #define cCCdataunderrun 0x9
1248 #define cCCbuffoverrun 0xC
1249 #define cCCbuffunderrun 0xD
1250 #define cCCnotaccessed 0xF
1251 static int ftdi_elan_write_reg(struct usb_ftdi *ftdi, u32 data)
1253 wait:if (ftdi->disconnected > 0) {
1257 mutex_lock(&ftdi->u132_lock);
1258 command_size = ftdi->command_next - ftdi->command_head;
1259 if (command_size < COMMAND_SIZE) {
1260 struct u132_command *command = &ftdi->command[
1261 COMMAND_MASK & ftdi->command_next];
1262 command->header = 0x00 | cPCIu132wr;
1263 command->length = 0x04;
1264 command->address = 0x00;
1265 command->width = 0x00;
1266 command->follows = 4;
1267 command->value = data;
1268 command->buffer = &command->value;
1269 ftdi->command_next += 1;
1270 ftdi_elan_kick_command_queue(ftdi);
1271 mutex_unlock(&ftdi->u132_lock);
1274 mutex_unlock(&ftdi->u132_lock);
1281 static int ftdi_elan_write_config(struct usb_ftdi *ftdi, int config_offset,
1284 u8 addressofs = config_offset / 4;
1285 wait:if (ftdi->disconnected > 0) {
1289 mutex_lock(&ftdi->u132_lock);
1290 command_size = ftdi->command_next - ftdi->command_head;
1291 if (command_size < COMMAND_SIZE) {
1292 struct u132_command *command = &ftdi->command[
1293 COMMAND_MASK & ftdi->command_next];
1294 command->header = 0x00 | (cPCIcfgwr & 0x0F);
1295 command->length = 0x04;
1296 command->address = addressofs;
1297 command->width = 0x00 | (width & 0x0F);
1298 command->follows = 4;
1299 command->value = data;
1300 command->buffer = &command->value;
1301 ftdi->command_next += 1;
1302 ftdi_elan_kick_command_queue(ftdi);
1303 mutex_unlock(&ftdi->u132_lock);
1306 mutex_unlock(&ftdi->u132_lock);
1313 static int ftdi_elan_write_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1316 u8 addressofs = mem_offset / 4;
1317 wait:if (ftdi->disconnected > 0) {
1321 mutex_lock(&ftdi->u132_lock);
1322 command_size = ftdi->command_next - ftdi->command_head;
1323 if (command_size < COMMAND_SIZE) {
1324 struct u132_command *command = &ftdi->command[
1325 COMMAND_MASK & ftdi->command_next];
1326 command->header = 0x00 | (cPCImemwr & 0x0F);
1327 command->length = 0x04;
1328 command->address = addressofs;
1329 command->width = 0x00 | (width & 0x0F);
1330 command->follows = 4;
1331 command->value = data;
1332 command->buffer = &command->value;
1333 ftdi->command_next += 1;
1334 ftdi_elan_kick_command_queue(ftdi);
1335 mutex_unlock(&ftdi->u132_lock);
1338 mutex_unlock(&ftdi->u132_lock);
1345 int usb_ftdi_elan_write_pcimem(struct platform_device *pdev, int mem_offset,
1348 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1349 return ftdi_elan_write_pcimem(ftdi, mem_offset, width, data);
1353 EXPORT_SYMBOL_GPL(usb_ftdi_elan_write_pcimem);
1354 static int ftdi_elan_read_reg(struct usb_ftdi *ftdi, u32 *data)
1356 wait:if (ftdi->disconnected > 0) {
1361 mutex_lock(&ftdi->u132_lock);
1362 command_size = ftdi->command_next - ftdi->command_head;
1363 respond_size = ftdi->respond_next - ftdi->respond_head;
1364 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1366 struct u132_command *command = &ftdi->command[
1367 COMMAND_MASK & ftdi->command_next];
1368 struct u132_respond *respond = &ftdi->respond[
1369 RESPOND_MASK & ftdi->respond_next];
1370 int result = -ENODEV;
1371 respond->result = &result;
1372 respond->header = command->header = 0x00 | cPCIu132rd;
1373 command->length = 0x04;
1374 respond->address = command->address = cU132cmd_status;
1375 command->width = 0x00;
1376 command->follows = 0;
1378 command->buffer = NULL;
1379 respond->value = data;
1380 init_completion(&respond->wait_completion);
1381 ftdi->command_next += 1;
1382 ftdi->respond_next += 1;
1383 ftdi_elan_kick_command_queue(ftdi);
1384 mutex_unlock(&ftdi->u132_lock);
1385 wait_for_completion(&respond->wait_completion);
1388 mutex_unlock(&ftdi->u132_lock);
1395 static int ftdi_elan_read_config(struct usb_ftdi *ftdi, int config_offset,
1396 u8 width, u32 *data)
1398 u8 addressofs = config_offset / 4;
1399 wait:if (ftdi->disconnected > 0) {
1404 mutex_lock(&ftdi->u132_lock);
1405 command_size = ftdi->command_next - ftdi->command_head;
1406 respond_size = ftdi->respond_next - ftdi->respond_head;
1407 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1409 struct u132_command *command = &ftdi->command[
1410 COMMAND_MASK & ftdi->command_next];
1411 struct u132_respond *respond = &ftdi->respond[
1412 RESPOND_MASK & ftdi->respond_next];
1413 int result = -ENODEV;
1414 respond->result = &result;
1415 respond->header = command->header = 0x00 | (cPCIcfgrd &
1417 command->length = 0x04;
1418 respond->address = command->address = addressofs;
1419 command->width = 0x00 | (width & 0x0F);
1420 command->follows = 0;
1422 command->buffer = NULL;
1423 respond->value = data;
1424 init_completion(&respond->wait_completion);
1425 ftdi->command_next += 1;
1426 ftdi->respond_next += 1;
1427 ftdi_elan_kick_command_queue(ftdi);
1428 mutex_unlock(&ftdi->u132_lock);
1429 wait_for_completion(&respond->wait_completion);
1432 mutex_unlock(&ftdi->u132_lock);
1439 static int ftdi_elan_read_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1440 u8 width, u32 *data)
1442 u8 addressofs = mem_offset / 4;
1443 wait:if (ftdi->disconnected > 0) {
1448 mutex_lock(&ftdi->u132_lock);
1449 command_size = ftdi->command_next - ftdi->command_head;
1450 respond_size = ftdi->respond_next - ftdi->respond_head;
1451 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1453 struct u132_command *command = &ftdi->command[
1454 COMMAND_MASK & ftdi->command_next];
1455 struct u132_respond *respond = &ftdi->respond[
1456 RESPOND_MASK & ftdi->respond_next];
1457 int result = -ENODEV;
1458 respond->result = &result;
1459 respond->header = command->header = 0x00 | (cPCImemrd &
1461 command->length = 0x04;
1462 respond->address = command->address = addressofs;
1463 command->width = 0x00 | (width & 0x0F);
1464 command->follows = 0;
1466 command->buffer = NULL;
1467 respond->value = data;
1468 init_completion(&respond->wait_completion);
1469 ftdi->command_next += 1;
1470 ftdi->respond_next += 1;
1471 ftdi_elan_kick_command_queue(ftdi);
1472 mutex_unlock(&ftdi->u132_lock);
1473 wait_for_completion(&respond->wait_completion);
1476 mutex_unlock(&ftdi->u132_lock);
1483 int usb_ftdi_elan_read_pcimem(struct platform_device *pdev, int mem_offset,
1484 u8 width, u32 *data)
1486 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1487 if (ftdi->initialized == 0) {
1490 return ftdi_elan_read_pcimem(ftdi, mem_offset, width, data);
1494 EXPORT_SYMBOL_GPL(usb_ftdi_elan_read_pcimem);
1495 static int ftdi_elan_edset_setup(struct usb_ftdi *ftdi, u8 ed_number,
1496 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1497 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1498 int toggle_bits, int error_count, int condition_code, int repeat_number,
1499 int halted, int skipped, int actual, int non_null))
1501 u8 ed = ed_number - 1;
1502 wait:if (ftdi->disconnected > 0) {
1504 } else if (ftdi->initialized == 0) {
1508 mutex_lock(&ftdi->u132_lock);
1509 command_size = ftdi->command_next - ftdi->command_head;
1510 if (command_size < COMMAND_SIZE) {
1511 struct u132_target *target = &ftdi->target[ed];
1512 struct u132_command *command = &ftdi->command[
1513 COMMAND_MASK & ftdi->command_next];
1514 command->header = 0x80 | (ed << 5);
1515 command->length = 0x8007;
1516 command->address = (toggle_bits << 6) | (ep_number << 2)
1518 command->width = usb_maxpacket(urb->dev, urb->pipe,
1519 usb_pipeout(urb->pipe));
1520 command->follows = 8;
1522 command->buffer = urb->setup_packet;
1523 target->callback = callback;
1524 target->endp = endp;
1527 ftdi->command_next += 1;
1528 ftdi_elan_kick_command_queue(ftdi);
1529 mutex_unlock(&ftdi->u132_lock);
1532 mutex_unlock(&ftdi->u132_lock);
1539 int usb_ftdi_elan_edset_setup(struct platform_device *pdev, u8 ed_number,
1540 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1541 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1542 int toggle_bits, int error_count, int condition_code, int repeat_number,
1543 int halted, int skipped, int actual, int non_null))
1545 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1546 return ftdi_elan_edset_setup(ftdi, ed_number, endp, urb, address,
1547 ep_number, toggle_bits, callback);
1551 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_setup);
1552 static int ftdi_elan_edset_input(struct usb_ftdi *ftdi, u8 ed_number,
1553 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1554 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1555 int toggle_bits, int error_count, int condition_code, int repeat_number,
1556 int halted, int skipped, int actual, int non_null))
1558 u8 ed = ed_number - 1;
1559 wait:if (ftdi->disconnected > 0) {
1561 } else if (ftdi->initialized == 0) {
1565 mutex_lock(&ftdi->u132_lock);
1566 command_size = ftdi->command_next - ftdi->command_head;
1567 if (command_size < COMMAND_SIZE) {
1568 struct u132_target *target = &ftdi->target[ed];
1569 struct u132_command *command = &ftdi->command[
1570 COMMAND_MASK & ftdi->command_next];
1571 int remaining_length = urb->transfer_buffer_length -
1573 command->header = 0x82 | (ed << 5);
1574 if (remaining_length == 0) {
1575 command->length = 0x0000;
1576 } else if (remaining_length > 1024) {
1577 command->length = 0x8000 | 1023;
1579 command->length = 0x8000 | (remaining_length -
1581 command->address = (toggle_bits << 6) | (ep_number << 2)
1583 command->width = usb_maxpacket(urb->dev, urb->pipe,
1584 usb_pipeout(urb->pipe));
1585 command->follows = 0;
1587 command->buffer = NULL;
1588 target->callback = callback;
1589 target->endp = endp;
1592 ftdi->command_next += 1;
1593 ftdi_elan_kick_command_queue(ftdi);
1594 mutex_unlock(&ftdi->u132_lock);
1597 mutex_unlock(&ftdi->u132_lock);
1604 int usb_ftdi_elan_edset_input(struct platform_device *pdev, u8 ed_number,
1605 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1606 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1607 int toggle_bits, int error_count, int condition_code, int repeat_number,
1608 int halted, int skipped, int actual, int non_null))
1610 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1611 return ftdi_elan_edset_input(ftdi, ed_number, endp, urb, address,
1612 ep_number, toggle_bits, callback);
1616 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_input);
1617 static int ftdi_elan_edset_empty(struct usb_ftdi *ftdi, u8 ed_number,
1618 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1619 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1620 int toggle_bits, int error_count, int condition_code, int repeat_number,
1621 int halted, int skipped, int actual, int non_null))
1623 u8 ed = ed_number - 1;
1624 wait:if (ftdi->disconnected > 0) {
1626 } else if (ftdi->initialized == 0) {
1630 mutex_lock(&ftdi->u132_lock);
1631 command_size = ftdi->command_next - ftdi->command_head;
1632 if (command_size < COMMAND_SIZE) {
1633 struct u132_target *target = &ftdi->target[ed];
1634 struct u132_command *command = &ftdi->command[
1635 COMMAND_MASK & ftdi->command_next];
1636 command->header = 0x81 | (ed << 5);
1637 command->length = 0x0000;
1638 command->address = (toggle_bits << 6) | (ep_number << 2)
1640 command->width = usb_maxpacket(urb->dev, urb->pipe,
1641 usb_pipeout(urb->pipe));
1642 command->follows = 0;
1644 command->buffer = NULL;
1645 target->callback = callback;
1646 target->endp = endp;
1649 ftdi->command_next += 1;
1650 ftdi_elan_kick_command_queue(ftdi);
1651 mutex_unlock(&ftdi->u132_lock);
1654 mutex_unlock(&ftdi->u132_lock);
1661 int usb_ftdi_elan_edset_empty(struct platform_device *pdev, u8 ed_number,
1662 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1663 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1664 int toggle_bits, int error_count, int condition_code, int repeat_number,
1665 int halted, int skipped, int actual, int non_null))
1667 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1668 return ftdi_elan_edset_empty(ftdi, ed_number, endp, urb, address,
1669 ep_number, toggle_bits, callback);
1673 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_empty);
1674 static int ftdi_elan_edset_output(struct usb_ftdi *ftdi, u8 ed_number,
1675 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1676 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1677 int toggle_bits, int error_count, int condition_code, int repeat_number,
1678 int halted, int skipped, int actual, int non_null))
1680 u8 ed = ed_number - 1;
1681 wait:if (ftdi->disconnected > 0) {
1683 } else if (ftdi->initialized == 0) {
1687 mutex_lock(&ftdi->u132_lock);
1688 command_size = ftdi->command_next - ftdi->command_head;
1689 if (command_size < COMMAND_SIZE) {
1693 char data[30 *3 + 4];
1695 int m = (sizeof(data) - 1) / 3;
1697 struct u132_target *target = &ftdi->target[ed];
1698 struct u132_command *command = &ftdi->command[
1699 COMMAND_MASK & ftdi->command_next];
1700 command->header = 0x81 | (ed << 5);
1701 command->address = (toggle_bits << 6) | (ep_number << 2)
1703 command->width = usb_maxpacket(urb->dev, urb->pipe,
1704 usb_pipeout(urb->pipe));
1705 command->follows = min(1024,
1706 urb->transfer_buffer_length -
1707 urb->actual_length);
1709 command->buffer = urb->transfer_buffer +
1711 command->length = 0x8000 | (command->follows - 1);
1712 b = command->buffer;
1713 urb_size = command->follows;
1715 while (urb_size-- > 0) {
1717 } else if (i++ < m) {
1718 int w = sprintf(d, " %02X", *b++);
1722 d += sprintf(d, " ..");
1724 target->callback = callback;
1725 target->endp = endp;
1728 ftdi->command_next += 1;
1729 ftdi_elan_kick_command_queue(ftdi);
1730 mutex_unlock(&ftdi->u132_lock);
1733 mutex_unlock(&ftdi->u132_lock);
1740 int usb_ftdi_elan_edset_output(struct platform_device *pdev, u8 ed_number,
1741 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1742 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1743 int toggle_bits, int error_count, int condition_code, int repeat_number,
1744 int halted, int skipped, int actual, int non_null))
1746 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1747 return ftdi_elan_edset_output(ftdi, ed_number, endp, urb, address,
1748 ep_number, toggle_bits, callback);
1752 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_output);
1753 static int ftdi_elan_edset_single(struct usb_ftdi *ftdi, u8 ed_number,
1754 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1755 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1756 int toggle_bits, int error_count, int condition_code, int repeat_number,
1757 int halted, int skipped, int actual, int non_null))
1759 u8 ed = ed_number - 1;
1760 wait:if (ftdi->disconnected > 0) {
1762 } else if (ftdi->initialized == 0) {
1766 mutex_lock(&ftdi->u132_lock);
1767 command_size = ftdi->command_next - ftdi->command_head;
1768 if (command_size < COMMAND_SIZE) {
1769 int remaining_length = urb->transfer_buffer_length -
1771 struct u132_target *target = &ftdi->target[ed];
1772 struct u132_command *command = &ftdi->command[
1773 COMMAND_MASK & ftdi->command_next];
1774 command->header = 0x83 | (ed << 5);
1775 if (remaining_length == 0) {
1776 command->length = 0x0000;
1777 } else if (remaining_length > 1024) {
1778 command->length = 0x8000 | 1023;
1780 command->length = 0x8000 | (remaining_length -
1782 command->address = (toggle_bits << 6) | (ep_number << 2)
1784 command->width = usb_maxpacket(urb->dev, urb->pipe,
1785 usb_pipeout(urb->pipe));
1786 command->follows = 0;
1788 command->buffer = NULL;
1789 target->callback = callback;
1790 target->endp = endp;
1793 ftdi->command_next += 1;
1794 ftdi_elan_kick_command_queue(ftdi);
1795 mutex_unlock(&ftdi->u132_lock);
1798 mutex_unlock(&ftdi->u132_lock);
1805 int usb_ftdi_elan_edset_single(struct platform_device *pdev, u8 ed_number,
1806 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1807 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1808 int toggle_bits, int error_count, int condition_code, int repeat_number,
1809 int halted, int skipped, int actual, int non_null))
1811 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1812 return ftdi_elan_edset_single(ftdi, ed_number, endp, urb, address,
1813 ep_number, toggle_bits, callback);
1817 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_single);
1818 static int ftdi_elan_edset_flush(struct usb_ftdi *ftdi, u8 ed_number,
1821 u8 ed = ed_number - 1;
1822 if (ftdi->disconnected > 0) {
1824 } else if (ftdi->initialized == 0) {
1827 struct u132_target *target = &ftdi->target[ed];
1828 mutex_lock(&ftdi->u132_lock);
1829 if (target->abandoning > 0) {
1830 mutex_unlock(&ftdi->u132_lock);
1833 target->abandoning = 1;
1834 wait_1:if (target->active == 1) {
1835 int command_size = ftdi->command_next -
1837 if (command_size < COMMAND_SIZE) {
1838 struct u132_command *command =
1839 &ftdi->command[COMMAND_MASK &
1840 ftdi->command_next];
1841 command->header = 0x80 | (ed << 5) |
1843 command->length = 0x00;
1844 command->address = 0x00;
1845 command->width = 0x00;
1846 command->follows = 0;
1848 command->buffer = &command->value;
1849 ftdi->command_next += 1;
1850 ftdi_elan_kick_command_queue(ftdi);
1852 mutex_unlock(&ftdi->u132_lock);
1854 mutex_lock(&ftdi->u132_lock);
1858 mutex_unlock(&ftdi->u132_lock);
1864 int usb_ftdi_elan_edset_flush(struct platform_device *pdev, u8 ed_number,
1867 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1868 return ftdi_elan_edset_flush(ftdi, ed_number, endp);
1872 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_flush);
1873 static int ftdi_elan_flush_input_fifo(struct usb_ftdi *ftdi)
1875 int retry_on_empty = 10;
1876 int retry_on_timeout = 5;
1877 int retry_on_status = 20;
1879 int packet_bytes = 0;
1880 int retval = usb_bulk_msg(ftdi->udev,
1881 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
1882 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
1883 &packet_bytes, 100);
1884 if (packet_bytes > 2) {
1885 char diag[30 *3 + 4];
1887 int m = (sizeof(diag) - 1) / 3;
1888 char *b = ftdi->bulk_in_buffer;
1891 while (packet_bytes-- > 0) {
1893 if (bytes_read < m) {
1894 d += sprintf(d, " %02X",
1896 } else if (bytes_read > m) {
1898 d += sprintf(d, " ..");
1903 } else if (packet_bytes > 1) {
1904 char s1 = ftdi->bulk_in_buffer[0];
1905 char s2 = ftdi->bulk_in_buffer[1];
1906 if (s1 == 0x31 && s2 == 0x60) {
1908 } else if (retry_on_status-- > 0) {
1911 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
1915 } else if (packet_bytes > 0) {
1916 char b1 = ftdi->bulk_in_buffer[0];
1917 dev_err(&ftdi->udev->dev, "only one byte flushed from F"
1918 "TDI = %02X\n", b1);
1919 if (retry_on_status-- > 0) {
1922 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
1926 } else if (retval == -ETIMEDOUT) {
1927 if (retry_on_timeout-- > 0) {
1930 dev_err(&ftdi->udev->dev, "TIMED OUT retry limi"
1934 } else if (retval == 0) {
1935 if (retry_on_empty-- > 0) {
1938 dev_err(&ftdi->udev->dev, "empty packet retry l"
1943 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
1952 * send the long flush sequence
1955 static int ftdi_elan_synchronize_flush(struct usb_ftdi *ftdi)
1962 urb = usb_alloc_urb(0, GFP_KERNEL);
1964 dev_err(&ftdi->udev->dev, "could not alloc a urb for flush sequ"
1968 buf = usb_buffer_alloc(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
1970 dev_err(&ftdi->udev->dev, "could not get a buffer for flush seq"
1977 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
1978 ftdi->bulk_out_endpointAddr), buf, i,
1979 ftdi_elan_write_bulk_callback, ftdi);
1980 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1981 retval = usb_submit_urb(urb, GFP_KERNEL);
1983 dev_err(&ftdi->udev->dev, "failed to submit urb containing the "
1984 "flush sequence\n");
1985 usb_buffer_free(ftdi->udev, i, buf, urb->transfer_dma);
1995 * send the reset sequence
1998 static int ftdi_elan_synchronize_reset(struct usb_ftdi *ftdi)
2005 urb = usb_alloc_urb(0, GFP_KERNEL);
2007 dev_err(&ftdi->udev->dev, "could not get a urb for the reset se"
2011 buf = usb_buffer_alloc(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
2013 dev_err(&ftdi->udev->dev, "could not get a buffer for the reset"
2022 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
2023 ftdi->bulk_out_endpointAddr), buf, i,
2024 ftdi_elan_write_bulk_callback, ftdi);
2025 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2026 retval = usb_submit_urb(urb, GFP_KERNEL);
2028 dev_err(&ftdi->udev->dev, "failed to submit urb containing the "
2029 "reset sequence\n");
2030 usb_buffer_free(ftdi->udev, i, buf, urb->transfer_dma);
2038 static int ftdi_elan_synchronize(struct usb_ftdi *ftdi)
2042 int retry_on_timeout = 5;
2043 int retry_on_empty = 10;
2045 retval = ftdi_elan_flush_input_fifo(ftdi);
2048 ftdi->bulk_in_left = 0;
2049 ftdi->bulk_in_last = -1;
2050 while (long_stop-- > 0) {
2053 retval = ftdi_elan_synchronize_flush(ftdi);
2056 retval = ftdi_elan_flush_input_fifo(ftdi);
2059 reset:retval = ftdi_elan_synchronize_reset(ftdi);
2065 int packet_bytes = 0;
2066 retval = usb_bulk_msg(ftdi->udev,
2067 usb_rcvbulkpipe(ftdi->udev,
2068 ftdi->bulk_in_endpointAddr),
2069 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2070 &packet_bytes, 500);
2071 if (packet_bytes > 2) {
2072 char diag[30 *3 + 4];
2074 int m = (sizeof(diag) - 1) / 3;
2075 char *b = ftdi->bulk_in_buffer;
2077 unsigned char c = 0;
2079 while (packet_bytes-- > 0) {
2081 if (bytes_read < m) {
2082 d += sprintf(d, " %02X", c);
2083 } else if (bytes_read > m) {
2085 d += sprintf(d, " ..");
2094 } else if (read_stop-- > 0) {
2097 dev_err(&ftdi->udev->dev, "retr"
2098 "y limit reached\n");
2102 } else if (packet_bytes > 1) {
2103 unsigned char s1 = ftdi->bulk_in_buffer[0];
2104 unsigned char s2 = ftdi->bulk_in_buffer[1];
2105 if (s1 == 0x31 && s2 == 0x00) {
2106 if (read_stuck-- > 0) {
2110 } else if (s1 == 0x31 && s2 == 0x60) {
2111 if (read_stop-- > 0) {
2114 dev_err(&ftdi->udev->dev, "retr"
2115 "y limit reached\n");
2119 if (read_stop-- > 0) {
2122 dev_err(&ftdi->udev->dev, "retr"
2123 "y limit reached\n");
2127 } else if (packet_bytes > 0) {
2128 if (read_stop-- > 0) {
2131 dev_err(&ftdi->udev->dev, "retry limit "
2135 } else if (retval == -ETIMEDOUT) {
2136 if (retry_on_timeout-- > 0) {
2139 dev_err(&ftdi->udev->dev, "TIMED OUT re"
2140 "try limit reached\n");
2143 } else if (retval == 0) {
2144 if (retry_on_empty-- > 0) {
2147 dev_err(&ftdi->udev->dev, "empty packet"
2148 " retry limit reached\n");
2153 dev_err(&ftdi->udev->dev, "error = %d\n",
2155 if (read_stop-- > 0) {
2158 dev_err(&ftdi->udev->dev, "retry limit "
2165 dev_err(&ftdi->udev->dev, "failed to synchronize\n");
2169 static int ftdi_elan_stuck_waiting(struct usb_ftdi *ftdi)
2171 int retry_on_empty = 10;
2172 int retry_on_timeout = 5;
2173 int retry_on_status = 50;
2175 int packet_bytes = 0;
2176 int retval = usb_bulk_msg(ftdi->udev,
2177 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
2178 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2179 &packet_bytes, 1000);
2180 if (packet_bytes > 2) {
2181 char diag[30 *3 + 4];
2183 int m = (sizeof(diag) - 1) / 3;
2184 char *b = ftdi->bulk_in_buffer;
2187 while (packet_bytes-- > 0) {
2189 if (bytes_read < m) {
2190 d += sprintf(d, " %02X",
2192 } else if (bytes_read > m) {
2194 d += sprintf(d, " ..");
2199 } else if (packet_bytes > 1) {
2200 char s1 = ftdi->bulk_in_buffer[0];
2201 char s2 = ftdi->bulk_in_buffer[1];
2202 if (s1 == 0x31 && s2 == 0x60) {
2204 } else if (retry_on_status-- > 0) {
2209 } else if (packet_bytes > 0) {
2210 char b1 = ftdi->bulk_in_buffer[0];
2211 dev_err(&ftdi->udev->dev, "only one byte flushed from F"
2212 "TDI = %02X\n", b1);
2213 if (retry_on_status-- > 0) {
2217 dev_err(&ftdi->udev->dev, "STATUS ERROR retry l"
2221 } else if (retval == -ETIMEDOUT) {
2222 if (retry_on_timeout-- > 0) {
2225 dev_err(&ftdi->udev->dev, "TIMED OUT retry limi"
2229 } else if (retval == 0) {
2230 if (retry_on_empty-- > 0) {
2233 dev_err(&ftdi->udev->dev, "empty packet retry l"
2238 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
2245 static int ftdi_elan_checkingPCI(struct usb_ftdi *ftdi)
2247 int UxxxStatus = ftdi_elan_read_reg(ftdi, &ftdi->controlreg);
2250 if (ftdi->controlreg & 0x00400000) {
2251 if (ftdi->card_ejected) {
2253 ftdi->card_ejected = 1;
2254 dev_err(&ftdi->udev->dev, "CARD EJECTED - controlreg = "
2255 "%08X\n", ftdi->controlreg);
2259 u8 fn = ftdi->function - 1;
2260 int activePCIfn = fn << 8;
2265 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2269 pciVID = pcidata & 0xFFFF;
2270 pciPID = (pcidata >> 16) & 0xFFFF;
2271 if (pciVID == ftdi->platform_data.vendor && pciPID ==
2272 ftdi->platform_data.device) {
2275 dev_err(&ftdi->udev->dev, "vendor=%04X pciVID=%04X devi"
2276 "ce=%04X pciPID=%04X\n",
2277 ftdi->platform_data.vendor, pciVID,
2278 ftdi->platform_data.device, pciPID);
2285 #define ftdi_read_pcimem(ftdi, member, data) ftdi_elan_read_pcimem(ftdi, \
2286 offsetof(struct ohci_regs, member), 0, data);
2287 #define ftdi_write_pcimem(ftdi, member, data) ftdi_elan_write_pcimem(ftdi, \
2288 offsetof(struct ohci_regs, member), 0, data);
2290 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
2291 #define OHCI_INTR_INIT (OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_RD | \
2293 static int ftdi_elan_check_controller(struct usb_ftdi *ftdi, int quirk)
2307 int mask = OHCI_INTR_INIT;
2309 int reset_timeout = 30; /* ... allow extra time */
2311 retval = ftdi_write_pcimem(ftdi, intrdisable, OHCI_INTR_MIE);
2314 retval = ftdi_read_pcimem(ftdi, control, &control);
2317 retval = ftdi_read_pcimem(ftdi, roothub.a, &rh_a);
2320 num_ports = rh_a & RH_A_NDP;
2321 retval = ftdi_read_pcimem(ftdi, fminterval, &hc_fminterval);
2324 hc_fminterval &= 0x3fff;
2325 if (hc_fminterval != FI) {
2327 hc_fminterval |= FSMP(hc_fminterval) << 16;
2328 retval = ftdi_read_pcimem(ftdi, control, &hc_control);
2331 switch (hc_control & OHCI_CTRL_HCFS) {
2335 case OHCI_USB_SUSPEND:
2336 case OHCI_USB_RESUME:
2337 hc_control &= OHCI_CTRL_RWC;
2338 hc_control |= OHCI_USB_RESUME;
2342 hc_control &= OHCI_CTRL_RWC;
2343 hc_control |= OHCI_USB_RESET;
2347 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2350 retval = ftdi_read_pcimem(ftdi, control, &control);
2354 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2357 if (!(roothub_a & RH_A_NPS)) { /* power down each port */
2358 for (temp = 0; temp < num_ports; temp++) {
2359 retval = ftdi_write_pcimem(ftdi,
2360 roothub.portstatus[temp], RH_PS_LSDA);
2365 retval = ftdi_read_pcimem(ftdi, control, &control);
2368 retry:retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2371 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_HCR);
2375 retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2378 if (0 != (status & OHCI_HCR)) {
2379 if (--reset_timeout == 0) {
2380 dev_err(&ftdi->udev->dev, "USB HC reset timed o"
2389 if (quirk & OHCI_QUIRK_INITRESET) {
2390 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2393 retval = ftdi_read_pcimem(ftdi, control, &control);
2397 retval = ftdi_write_pcimem(ftdi, ed_controlhead, 0x00000000);
2400 retval = ftdi_write_pcimem(ftdi, ed_bulkhead, 0x11000000);
2403 retval = ftdi_write_pcimem(ftdi, hcca, 0x00000000);
2406 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2409 retval = ftdi_write_pcimem(ftdi, fminterval,
2410 ((fminterval & FIT) ^ FIT) | hc_fminterval);
2413 retval = ftdi_write_pcimem(ftdi, periodicstart,
2414 ((9 *hc_fminterval) / 10) & 0x3fff);
2417 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2420 retval = ftdi_read_pcimem(ftdi, periodicstart, &periodicstart);
2423 if (0 == (fminterval & 0x3fff0000) || 0 == periodicstart) {
2424 if (!(quirk & OHCI_QUIRK_INITRESET)) {
2425 quirk |= OHCI_QUIRK_INITRESET;
2428 dev_err(&ftdi->udev->dev, "init err(%08x %04x)\n",
2429 fminterval, periodicstart);
2430 } /* start controller operations */
2431 hc_control &= OHCI_CTRL_RWC;
2432 hc_control |= OHCI_CONTROL_INIT | OHCI_CTRL_BLE | OHCI_USB_OPER;
2433 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2436 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_BLF);
2439 retval = ftdi_read_pcimem(ftdi, cmdstatus, &cmdstatus);
2442 retval = ftdi_read_pcimem(ftdi, control, &control);
2445 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_DRWE);
2448 retval = ftdi_write_pcimem(ftdi, intrstatus, mask);
2451 retval = ftdi_write_pcimem(ftdi, intrdisable,
2452 OHCI_INTR_MIE | OHCI_INTR_OC | OHCI_INTR_RHSC | OHCI_INTR_FNO |
2453 OHCI_INTR_UE | OHCI_INTR_RD | OHCI_INTR_SF | OHCI_INTR_WDH |
2456 return retval; /* handle root hub init quirks ... */
2457 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2460 roothub_a &= ~(RH_A_PSM | RH_A_OCPM);
2461 if (quirk & OHCI_QUIRK_SUPERIO) {
2462 roothub_a |= RH_A_NOCP;
2463 roothub_a &= ~(RH_A_POTPGT | RH_A_NPS);
2464 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2467 } else if ((quirk & OHCI_QUIRK_AMD756) || distrust_firmware) {
2468 roothub_a |= RH_A_NPS;
2469 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2473 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_LPSC);
2476 retval = ftdi_write_pcimem(ftdi, roothub.b,
2477 (roothub_a & RH_A_NPS) ? 0 : RH_B_PPCM);
2480 retval = ftdi_read_pcimem(ftdi, control, &control);
2483 mdelay((roothub_a >> 23) & 0x1fe);
2484 for (temp = 0; temp < num_ports; temp++) {
2486 retval = ftdi_read_pcimem(ftdi, roothub.portstatus[temp],
2496 static int ftdi_elan_setup_controller(struct usb_ftdi *ftdi, int fn)
2502 int activePCIfn = fn << 8;
2503 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2507 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2511 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2515 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2519 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2524 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2528 latence_timer &= 0xFFFF00FF;
2529 latence_timer |= 0x00001600;
2530 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2534 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2539 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2543 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2547 for (reg = 0; reg <= 0x54; reg += 4) {
2548 UxxxStatus = ftdi_elan_read_pcimem(ftdi, reg, 0, &pcidata);
2555 static int ftdi_elan_close_controller(struct usb_ftdi *ftdi, int fn)
2561 int activePCIfn = fn << 8;
2562 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2566 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2570 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2574 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2578 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2583 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2587 latence_timer &= 0xFFFF00FF;
2588 latence_timer |= 0x00001600;
2589 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2593 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2598 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2602 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2609 static int ftdi_elan_found_controller(struct usb_ftdi *ftdi, int fn, int quirk)
2613 UxxxStatus = ftdi_elan_setup_controller(ftdi, fn);
2616 result = ftdi_elan_check_controller(ftdi, quirk);
2617 UxxxStatus = ftdi_elan_close_controller(ftdi, fn);
2623 static int ftdi_elan_enumeratePCI(struct usb_ftdi *ftdi)
2628 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2631 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000000L);
2635 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x100);
2638 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x500);
2641 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2644 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020CL | 0x000);
2647 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020DL | 0x000);
2651 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020FL | 0x000);
2654 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2657 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x800);
2660 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2663 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2667 sensebits = (controlreg >> 16) & 0x000F;
2668 if (0x0D == sensebits)
2674 static int ftdi_elan_setupOHCI(struct usb_ftdi *ftdi)
2680 int activePCIfn = 0;
2681 int max_devices = 0;
2682 int controllers = 0;
2683 int unrecognized = 0;
2685 for (fn = 0; (fn < 4); fn++) {
2689 activePCIfn = fn << 8;
2690 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2694 pciVID = pcidata & 0xFFFF;
2695 pciPID = (pcidata >> 16) & 0xFFFF;
2696 if ((pciVID == PCI_VENDOR_ID_OPTI) && (pciPID == 0xc861)) {
2697 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2699 } else if ((pciVID == PCI_VENDOR_ID_NEC) && (pciPID == 0x0035))
2701 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2703 } else if ((pciVID == PCI_VENDOR_ID_AL) && (pciPID == 0x5237)) {
2704 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2706 } else if ((pciVID == PCI_VENDOR_ID_ATT) && (pciPID == 0x5802))
2708 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2710 } else if (pciVID == PCI_VENDOR_ID_AMD && pciPID == 0x740c) {
2711 devices = ftdi_elan_found_controller(ftdi, fn,
2714 } else if (pciVID == PCI_VENDOR_ID_COMPAQ && pciPID == 0xa0f8) {
2715 devices = ftdi_elan_found_controller(ftdi, fn,
2716 OHCI_QUIRK_ZFMICRO);
2718 } else if (0 == pcidata) {
2721 if (devices > max_devices) {
2722 max_devices = devices;
2723 ftdi->function = fn + 1;
2724 ftdi->platform_data.vendor = pciVID;
2725 ftdi->platform_data.device = pciPID;
2728 if (ftdi->function > 0) {
2729 UxxxStatus = ftdi_elan_setup_controller(ftdi,
2730 ftdi->function - 1);
2734 } else if (controllers > 0) {
2736 } else if (unrecognized > 0) {
2739 ftdi->enumerated = 0;
2746 * we use only the first bulk-in and bulk-out endpoints
2748 static int ftdi_elan_probe(struct usb_interface *interface,
2749 const struct usb_device_id *id)
2751 struct usb_host_interface *iface_desc;
2752 struct usb_endpoint_descriptor *endpoint;
2755 int retval = -ENOMEM;
2756 struct usb_ftdi *ftdi;
2758 ftdi = kzalloc(sizeof(struct usb_ftdi), GFP_KERNEL);
2760 printk(KERN_ERR "Out of memory\n");
2764 mutex_lock(&ftdi_module_lock);
2765 list_add_tail(&ftdi->ftdi_list, &ftdi_static_list);
2766 ftdi->sequence_num = ++ftdi_instances;
2767 mutex_unlock(&ftdi_module_lock);
2768 ftdi_elan_init_kref(ftdi);
2769 init_MUTEX(&ftdi->sw_lock);
2770 ftdi->udev = usb_get_dev(interface_to_usbdev(interface));
2771 ftdi->interface = interface;
2772 mutex_init(&ftdi->u132_lock);
2774 iface_desc = interface->cur_altsetting;
2775 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
2776 endpoint = &iface_desc->endpoint[i].desc;
2777 if (!ftdi->bulk_in_endpointAddr &&
2778 usb_endpoint_is_bulk_in(endpoint)) {
2779 buffer_size = le16_to_cpu(endpoint->wMaxPacketSize);
2780 ftdi->bulk_in_size = buffer_size;
2781 ftdi->bulk_in_endpointAddr = endpoint->bEndpointAddress;
2782 ftdi->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
2783 if (!ftdi->bulk_in_buffer) {
2784 dev_err(&ftdi->udev->dev, "Could not allocate b"
2790 if (!ftdi->bulk_out_endpointAddr &&
2791 usb_endpoint_is_bulk_out(endpoint)) {
2792 ftdi->bulk_out_endpointAddr =
2793 endpoint->bEndpointAddress;
2796 if (!(ftdi->bulk_in_endpointAddr && ftdi->bulk_out_endpointAddr)) {
2797 dev_err(&ftdi->udev->dev, "Could not find both bulk-in and bulk"
2798 "-out endpoints\n");
2802 dev_info(&ftdi->udev->dev, "interface %d has I=%02X O=%02X\n",
2803 iface_desc->desc.bInterfaceNumber, ftdi->bulk_in_endpointAddr,
2804 ftdi->bulk_out_endpointAddr);
2805 usb_set_intfdata(interface, ftdi);
2806 if (iface_desc->desc.bInterfaceNumber == 0 &&
2807 ftdi->bulk_in_endpointAddr == 0x81 &&
2808 ftdi->bulk_out_endpointAddr == 0x02) {
2809 retval = usb_register_dev(interface, &ftdi_elan_jtag_class);
2811 dev_err(&ftdi->udev->dev, "Not able to get a minor for "
2813 usb_set_intfdata(interface, NULL);
2817 ftdi->class = &ftdi_elan_jtag_class;
2818 dev_info(&ftdi->udev->dev, "USB FDTI=%p JTAG interface "
2819 "%d now attached to ftdi%d\n", ftdi,
2820 iface_desc->desc.bInterfaceNumber,
2824 } else if (iface_desc->desc.bInterfaceNumber == 1 &&
2825 ftdi->bulk_in_endpointAddr == 0x83 &&
2826 ftdi->bulk_out_endpointAddr == 0x04) {
2828 dev_info(&ftdi->udev->dev, "USB FDTI=%p ELAN interface %d now a"
2829 "ctivated\n", ftdi, iface_desc->desc.bInterfaceNumber);
2830 INIT_DELAYED_WORK(&ftdi->status_work, ftdi_elan_status_work);
2831 INIT_DELAYED_WORK(&ftdi->command_work, ftdi_elan_command_work);
2832 INIT_DELAYED_WORK(&ftdi->respond_work, ftdi_elan_respond_work);
2833 ftdi_status_queue_work(ftdi, msecs_to_jiffies(3 *1000));
2836 dev_err(&ftdi->udev->dev,
2837 "Could not find ELAN's U132 device\n");
2842 ftdi_elan_put_kref(ftdi);
2847 static void ftdi_elan_disconnect(struct usb_interface *interface)
2849 struct usb_ftdi *ftdi = usb_get_intfdata(interface);
2850 ftdi->disconnected += 1;
2852 int minor = interface->minor;
2853 struct usb_class_driver *class = ftdi->class;
2854 usb_set_intfdata(interface, NULL);
2855 usb_deregister_dev(interface, class);
2856 dev_info(&ftdi->udev->dev, "USB FTDI U132 jtag interface on min"
2857 "or %d now disconnected\n", minor);
2859 ftdi_status_cancel_work(ftdi);
2860 ftdi_command_cancel_work(ftdi);
2861 ftdi_response_cancel_work(ftdi);
2862 ftdi_elan_abandon_completions(ftdi);
2863 ftdi_elan_abandon_targets(ftdi);
2864 if (ftdi->registered) {
2865 platform_device_unregister(&ftdi->platform_dev);
2866 ftdi->synchronized = 0;
2867 ftdi->enumerated = 0;
2868 ftdi->initialized = 0;
2869 ftdi->registered = 0;
2871 flush_workqueue(status_queue);
2872 flush_workqueue(command_queue);
2873 flush_workqueue(respond_queue);
2874 ftdi->disconnected += 1;
2875 usb_set_intfdata(interface, NULL);
2876 dev_info(&ftdi->udev->dev, "USB FTDI U132 host controller inter"
2877 "face now disconnected\n");
2879 ftdi_elan_put_kref(ftdi);
2882 static struct usb_driver ftdi_elan_driver = {
2883 .name = "ftdi-elan",
2884 .probe = ftdi_elan_probe,
2885 .disconnect = ftdi_elan_disconnect,
2886 .id_table = ftdi_elan_table,
2888 static int __init ftdi_elan_init(void)
2891 printk(KERN_INFO "driver %s built at %s on %s\n", ftdi_elan_driver.name,
2892 __TIME__, __DATE__);
2893 mutex_init(&ftdi_module_lock);
2894 INIT_LIST_HEAD(&ftdi_static_list);
2895 status_queue = create_singlethread_workqueue("ftdi-status-control");
2897 goto err_status_queue;
2898 command_queue = create_singlethread_workqueue("ftdi-command-engine");
2900 goto err_command_queue;
2901 respond_queue = create_singlethread_workqueue("ftdi-respond-engine");
2903 goto err_respond_queue;
2904 result = usb_register(&ftdi_elan_driver);
2906 destroy_workqueue(status_queue);
2907 destroy_workqueue(command_queue);
2908 destroy_workqueue(respond_queue);
2909 printk(KERN_ERR "usb_register failed. Error number %d\n",
2915 destroy_workqueue(command_queue);
2917 destroy_workqueue(status_queue);
2919 printk(KERN_ERR "%s couldn't create workqueue\n", ftdi_elan_driver.name);
2923 static void __exit ftdi_elan_exit(void)
2925 struct usb_ftdi *ftdi;
2926 struct usb_ftdi *temp;
2927 usb_deregister(&ftdi_elan_driver);
2928 printk(KERN_INFO "ftdi_u132 driver deregistered\n");
2929 list_for_each_entry_safe(ftdi, temp, &ftdi_static_list, ftdi_list) {
2930 ftdi_status_cancel_work(ftdi);
2931 ftdi_command_cancel_work(ftdi);
2932 ftdi_response_cancel_work(ftdi);
2933 } flush_workqueue(status_queue);
2934 destroy_workqueue(status_queue);
2935 status_queue = NULL;
2936 flush_workqueue(command_queue);
2937 destroy_workqueue(command_queue);
2938 command_queue = NULL;
2939 flush_workqueue(respond_queue);
2940 destroy_workqueue(respond_queue);
2941 respond_queue = NULL;
2945 module_init(ftdi_elan_init);
2946 module_exit(ftdi_elan_exit);