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 bool 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 <linux/usb/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 const 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);
461 static void ftdi_elan_command_work(struct work_struct *work)
463 struct usb_ftdi *ftdi =
464 container_of(work, struct usb_ftdi, command_work.work);
466 if (ftdi->disconnected > 0) {
467 ftdi_elan_put_kref(ftdi);
470 int retval = ftdi_elan_command_engine(ftdi);
471 if (retval == -ESHUTDOWN) {
472 ftdi->disconnected += 1;
473 } else if (retval == -ENODEV) {
474 ftdi->disconnected += 1;
476 dev_err(&ftdi->udev->dev, "command error %d\n", retval);
477 ftdi_command_requeue_work(ftdi, msecs_to_jiffies(10));
482 static void ftdi_elan_kick_respond_queue(struct usb_ftdi *ftdi)
484 ftdi_respond_queue_work(ftdi, 0);
487 static void ftdi_elan_respond_work(struct work_struct *work)
489 struct usb_ftdi *ftdi =
490 container_of(work, struct usb_ftdi, respond_work.work);
491 if (ftdi->disconnected > 0) {
492 ftdi_elan_put_kref(ftdi);
495 int retval = ftdi_elan_respond_engine(ftdi);
497 } else if (retval == -ESHUTDOWN) {
498 ftdi->disconnected += 1;
499 } else if (retval == -ENODEV) {
500 ftdi->disconnected += 1;
501 } else if (retval == -EILSEQ) {
502 ftdi->disconnected += 1;
504 ftdi->disconnected += 1;
505 dev_err(&ftdi->udev->dev, "respond error %d\n", retval);
507 if (ftdi->disconnected > 0) {
508 ftdi_elan_abandon_completions(ftdi);
509 ftdi_elan_abandon_targets(ftdi);
511 ftdi_response_requeue_work(ftdi, msecs_to_jiffies(10));
518 * the sw_lock is initially held and will be freed
519 * after the FTDI has been synchronized
522 static void ftdi_elan_status_work(struct work_struct *work)
524 struct usb_ftdi *ftdi =
525 container_of(work, struct usb_ftdi, status_work.work);
526 int work_delay_in_msec = 0;
527 if (ftdi->disconnected > 0) {
528 ftdi_elan_put_kref(ftdi);
530 } else if (ftdi->synchronized == 0) {
531 down(&ftdi->sw_lock);
532 if (ftdi_elan_synchronize(ftdi) == 0) {
533 ftdi->synchronized = 1;
534 ftdi_command_queue_work(ftdi, 1);
535 ftdi_respond_queue_work(ftdi, 1);
537 work_delay_in_msec = 100;
539 dev_err(&ftdi->udev->dev, "synchronize failed\n");
541 work_delay_in_msec = 10 *1000;
543 } else if (ftdi->stuck_status > 0) {
544 if (ftdi_elan_stuck_waiting(ftdi) == 0) {
545 ftdi->stuck_status = 0;
546 ftdi->synchronized = 0;
547 } else if ((ftdi->stuck_status++ % 60) == 1) {
548 dev_err(&ftdi->udev->dev, "WRONG type of card inserted - please remove\n");
550 dev_err(&ftdi->udev->dev, "WRONG type of card inserted - checked %d times\n",
552 work_delay_in_msec = 100;
553 } else if (ftdi->enumerated == 0) {
554 if (ftdi_elan_enumeratePCI(ftdi) == 0) {
555 ftdi->enumerated = 1;
556 work_delay_in_msec = 250;
558 work_delay_in_msec = 1000;
559 } else if (ftdi->initialized == 0) {
560 if (ftdi_elan_setupOHCI(ftdi) == 0) {
561 ftdi->initialized = 1;
562 work_delay_in_msec = 500;
564 dev_err(&ftdi->udev->dev, "initialized failed - trying again in 10 seconds\n");
565 work_delay_in_msec = 1 *1000;
567 } else if (ftdi->registered == 0) {
568 work_delay_in_msec = 10;
569 if (ftdi_elan_hcd_init(ftdi) == 0) {
570 ftdi->registered = 1;
572 dev_err(&ftdi->udev->dev, "register failed\n");
573 work_delay_in_msec = 250;
575 if (ftdi_elan_checkingPCI(ftdi) == 0) {
576 work_delay_in_msec = 250;
577 } else if (ftdi->controlreg & 0x00400000) {
578 if (ftdi->gone_away > 0) {
579 dev_err(&ftdi->udev->dev, "PCI device eject confirmed platform_dev.dev.parent=%p platform_dev.dev=%p\n",
580 ftdi->platform_dev.dev.parent,
581 &ftdi->platform_dev.dev);
582 platform_device_unregister(&ftdi->platform_dev);
583 ftdi->platform_dev.dev.parent = NULL;
584 ftdi->registered = 0;
585 ftdi->enumerated = 0;
586 ftdi->card_ejected = 0;
587 ftdi->initialized = 0;
590 ftdi_elan_flush_targets(ftdi);
591 work_delay_in_msec = 250;
593 dev_err(&ftdi->udev->dev, "PCI device has disappeared\n"
595 ftdi_elan_cancel_targets(ftdi);
596 work_delay_in_msec = 500;
597 ftdi->enumerated = 0;
598 ftdi->initialized = 0;
601 if (ftdi->disconnected > 0) {
602 ftdi_elan_put_kref(ftdi);
605 ftdi_status_requeue_work(ftdi,
606 msecs_to_jiffies(work_delay_in_msec));
613 * file_operations for the jtag interface
615 * the usage count for the device is incremented on open()
616 * and decremented on release()
618 static int ftdi_elan_open(struct inode *inode, struct file *file)
621 struct usb_interface *interface;
623 subminor = iminor(inode);
624 interface = usb_find_interface(&ftdi_elan_driver, subminor);
627 printk(KERN_ERR "can't find device for minor %d\n", subminor);
630 struct usb_ftdi *ftdi = usb_get_intfdata(interface);
634 if (down_interruptible(&ftdi->sw_lock)) {
637 ftdi_elan_get_kref(ftdi);
638 file->private_data = ftdi;
645 static int ftdi_elan_release(struct inode *inode, struct file *file)
647 struct usb_ftdi *ftdi = file->private_data;
650 up(&ftdi->sw_lock); /* decrement the count on our device */
651 ftdi_elan_put_kref(ftdi);
658 * blocking bulk reads are used to get data from the device
661 static ssize_t ftdi_elan_read(struct file *file, char __user *buffer,
662 size_t count, loff_t *ppos)
664 char data[30 *3 + 4];
666 int m = (sizeof(data) - 1) / 3;
668 int retry_on_empty = 10;
669 int retry_on_timeout = 5;
670 struct usb_ftdi *ftdi = file->private_data;
671 if (ftdi->disconnected > 0) {
675 have:if (ftdi->bulk_in_left > 0) {
677 char *p = ++ftdi->bulk_in_last + ftdi->bulk_in_buffer;
678 ftdi->bulk_in_left -= 1;
679 if (bytes_read < m) {
680 d += sprintf(d, " %02X", 0x000000FF & *p);
681 } else if (bytes_read > m) {
683 d += sprintf(d, " ..");
684 if (copy_to_user(buffer++, p, 1)) {
693 more:if (count > 0) {
694 int packet_bytes = 0;
695 int retval = usb_bulk_msg(ftdi->udev,
696 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
697 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
699 if (packet_bytes > 2) {
700 ftdi->bulk_in_left = packet_bytes - 2;
701 ftdi->bulk_in_last = 1;
703 } else if (retval == -ETIMEDOUT) {
704 if (retry_on_timeout-- > 0) {
706 } else if (bytes_read > 0) {
710 } else if (retval == 0) {
711 if (retry_on_empty-- > 0) {
721 static void ftdi_elan_write_bulk_callback(struct urb *urb)
723 struct usb_ftdi *ftdi = urb->context;
724 int status = urb->status;
726 if (status && !(status == -ENOENT || status == -ECONNRESET ||
727 status == -ESHUTDOWN)) {
728 dev_err(&ftdi->udev->dev,
729 "urb=%p write bulk status received: %d\n", urb, status);
731 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
732 urb->transfer_buffer, urb->transfer_dma);
735 static int fill_buffer_with_all_queued_commands(struct usb_ftdi *ftdi,
736 char *buf, int command_size, int total_size)
740 int I = command_size;
741 int i = ftdi->command_head;
743 struct u132_command *command = &ftdi->command[COMMAND_MASK &
745 int F = command->follows;
746 u8 *f = command->buffer;
747 if (command->header & 0x80) {
748 ed_commands |= 1 << (0x3 & (command->header >> 5));
750 buf[b++] = command->header;
751 buf[b++] = (command->length >> 0) & 0x00FF;
752 buf[b++] = (command->length >> 8) & 0x00FF;
753 buf[b++] = command->address;
754 buf[b++] = command->width;
762 static int ftdi_elan_total_command_size(struct usb_ftdi *ftdi, int command_size)
765 int I = command_size;
766 int i = ftdi->command_head;
768 struct u132_command *command = &ftdi->command[COMMAND_MASK &
770 total_size += 5 + command->follows;
774 static int ftdi_elan_command_engine(struct usb_ftdi *ftdi)
781 int command_size = ftdi->command_next - ftdi->command_head;
782 if (command_size == 0)
784 total_size = ftdi_elan_total_command_size(ftdi, command_size);
785 urb = usb_alloc_urb(0, GFP_KERNEL);
787 dev_err(&ftdi->udev->dev, "could not get a urb to write %d commands totaling %d bytes to the Uxxx\n",
788 command_size, total_size);
791 buf = usb_alloc_coherent(ftdi->udev, total_size, GFP_KERNEL,
794 dev_err(&ftdi->udev->dev, "could not get a buffer to write %d commands totaling %d bytes to the Uxxx\n",
795 command_size, total_size);
799 ed_commands = fill_buffer_with_all_queued_commands(ftdi, buf,
800 command_size, total_size);
801 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
802 ftdi->bulk_out_endpointAddr), buf, total_size,
803 ftdi_elan_write_bulk_callback, ftdi);
804 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
806 char diag[40 *3 + 4];
810 int s = (sizeof(diag) - 1) / 3;
812 while (s-- > 0 && m-- > 0) {
813 if (s > 0 || m == 0) {
814 d += sprintf(d, " %02X", *c++);
816 d += sprintf(d, " ..");
819 retval = usb_submit_urb(urb, GFP_KERNEL);
821 dev_err(&ftdi->udev->dev, "failed %d to submit urb %p to write %d commands totaling %d bytes to the Uxxx\n",
822 retval, urb, command_size, total_size);
823 usb_free_coherent(ftdi->udev, total_size, buf, urb->transfer_dma);
827 usb_free_urb(urb); /* release our reference to this urb,
828 the USB core will eventually free it entirely */
829 ftdi->command_head += command_size;
830 ftdi_elan_kick_respond_queue(ftdi);
834 static void ftdi_elan_do_callback(struct usb_ftdi *ftdi,
835 struct u132_target *target, u8 *buffer, int length)
837 struct urb *urb = target->urb;
838 int halted = target->halted;
839 int skipped = target->skipped;
840 int actual = target->actual;
841 int non_null = target->non_null;
842 int toggle_bits = target->toggle_bits;
843 int error_count = target->error_count;
844 int condition_code = target->condition_code;
845 int repeat_number = target->repeat_number;
846 void (*callback) (void *, struct urb *, u8 *, int, int, int, int, int,
847 int, int, int, int) = target->callback;
849 target->callback = NULL;
850 (*callback) (target->endp, urb, buffer, length, toggle_bits,
851 error_count, condition_code, repeat_number, halted, skipped,
855 static char *have_ed_set_response(struct usb_ftdi *ftdi,
856 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
859 int payload = (ed_length >> 0) & 0x07FF;
860 mutex_lock(&ftdi->u132_lock);
862 target->non_null = (ed_length >> 15) & 0x0001;
863 target->repeat_number = (ed_length >> 11) & 0x000F;
864 if (ed_type == 0x02) {
865 if (payload == 0 || target->abandoning > 0) {
866 target->abandoning = 0;
867 mutex_unlock(&ftdi->u132_lock);
868 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
873 return ftdi->response;
875 ftdi->expected = 4 + payload;
877 mutex_unlock(&ftdi->u132_lock);
880 } else if (ed_type == 0x03) {
881 if (payload == 0 || target->abandoning > 0) {
882 target->abandoning = 0;
883 mutex_unlock(&ftdi->u132_lock);
884 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
889 return ftdi->response;
891 ftdi->expected = 4 + payload;
893 mutex_unlock(&ftdi->u132_lock);
896 } else if (ed_type == 0x01) {
897 target->abandoning = 0;
898 mutex_unlock(&ftdi->u132_lock);
899 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
904 return ftdi->response;
906 target->abandoning = 0;
907 mutex_unlock(&ftdi->u132_lock);
908 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
913 return ftdi->response;
917 static char *have_ed_get_response(struct usb_ftdi *ftdi,
918 struct u132_target *target, u16 ed_length, int ed_number, int ed_type,
921 mutex_lock(&ftdi->u132_lock);
922 target->condition_code = TD_DEVNOTRESP;
923 target->actual = (ed_length >> 0) & 0x01FF;
924 target->non_null = (ed_length >> 15) & 0x0001;
925 target->repeat_number = (ed_length >> 11) & 0x000F;
926 mutex_unlock(&ftdi->u132_lock);
928 ftdi_elan_do_callback(ftdi, target, NULL, 0);
929 target->abandoning = 0;
933 return ftdi->response;
938 * The engine tries to empty the FTDI fifo
940 * all responses found in the fifo data are dispatched thus
941 * the response buffer can only ever hold a maximum sized
942 * response from the Uxxx.
945 static int ftdi_elan_respond_engine(struct usb_ftdi *ftdi)
947 u8 *b = ftdi->response + ftdi->received;
949 int retry_on_empty = 1;
950 int retry_on_timeout = 3;
951 int empty_packets = 0;
953 int packet_bytes = 0;
954 int retval = usb_bulk_msg(ftdi->udev,
955 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
956 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
958 char diag[30 *3 + 4];
960 int m = packet_bytes;
961 u8 *c = ftdi->bulk_in_buffer;
962 int s = (sizeof(diag) - 1) / 3;
964 while (s-- > 0 && m-- > 0) {
965 if (s > 0 || m == 0) {
966 d += sprintf(d, " %02X", *c++);
968 d += sprintf(d, " ..");
970 if (packet_bytes > 2) {
971 ftdi->bulk_in_left = packet_bytes - 2;
972 ftdi->bulk_in_last = 1;
974 } else if (retval == -ETIMEDOUT) {
975 if (retry_on_timeout-- > 0) {
976 dev_err(&ftdi->udev->dev, "TIMED OUT with packet_bytes = %d with total %d bytes%s\n",
977 packet_bytes, bytes_read, diag);
979 } else if (bytes_read > 0) {
980 dev_err(&ftdi->udev->dev, "ONLY %d bytes%s\n",
984 dev_err(&ftdi->udev->dev, "TIMED OUT with packet_bytes = %d with total %d bytes%s\n",
985 packet_bytes, bytes_read, diag);
988 } else if (retval == -EILSEQ) {
989 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes = %d with total %d bytes%s\n",
990 retval, packet_bytes, bytes_read, diag);
993 dev_err(&ftdi->udev->dev, "error = %d with packet_bytes = %d with total %d bytes%s\n",
994 retval, packet_bytes, bytes_read, diag);
996 } else if (packet_bytes == 2) {
997 unsigned char s0 = ftdi->bulk_in_buffer[0];
998 unsigned char s1 = ftdi->bulk_in_buffer[1];
1000 if (s0 == 0x31 && s1 == 0x60) {
1001 if (retry_on_empty-- > 0) {
1005 } else if (s0 == 0x31 && s1 == 0x00) {
1006 if (retry_on_empty-- > 0) {
1011 if (retry_on_empty-- > 0) {
1016 } else if (packet_bytes == 1) {
1017 if (retry_on_empty-- > 0) {
1022 if (retry_on_empty-- > 0) {
1031 have:if (ftdi->bulk_in_left > 0) {
1032 u8 c = ftdi->bulk_in_buffer[++ftdi->bulk_in_last];
1034 ftdi->bulk_in_left -= 1;
1035 if (ftdi->received == 0 && c == 0xFF) {
1039 if (++ftdi->received < ftdi->expected) {
1041 } else if (ftdi->ed_found) {
1042 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1043 u16 ed_length = (ftdi->response[2] << 8) |
1045 struct u132_target *target = &ftdi->target[ed_number];
1046 int payload = (ed_length >> 0) & 0x07FF;
1047 char diag[30 *3 + 4];
1050 u8 *c = 4 + ftdi->response;
1051 int s = (sizeof(diag) - 1) / 3;
1053 while (s-- > 0 && m-- > 0) {
1054 if (s > 0 || m == 0) {
1055 d += sprintf(d, " %02X", *c++);
1057 d += sprintf(d, " ..");
1059 ftdi_elan_do_callback(ftdi, target, 4 + ftdi->response,
1066 } else if (ftdi->expected == 8) {
1068 int respond_head = ftdi->respond_head++;
1069 struct u132_respond *respond = &ftdi->respond[
1070 RESPOND_MASK & respond_head];
1071 u32 data = ftdi->response[7];
1073 data |= ftdi->response[6];
1075 data |= ftdi->response[5];
1077 data |= ftdi->response[4];
1078 *respond->value = data;
1079 *respond->result = 0;
1080 complete(&respond->wait_completion);
1085 buscmd = (ftdi->response[0] >> 0) & 0x0F;
1086 if (buscmd == 0x00) {
1087 } else if (buscmd == 0x02) {
1088 } else if (buscmd == 0x06) {
1089 } else if (buscmd == 0x0A) {
1091 dev_err(&ftdi->udev->dev, "Uxxx unknown(%0X) value = %08X\n",
1095 if ((ftdi->response[0] & 0x80) == 0x00) {
1099 int ed_number = (ftdi->response[0] >> 5) & 0x03;
1100 int ed_type = (ftdi->response[0] >> 0) & 0x03;
1101 u16 ed_length = (ftdi->response[2] << 8) |
1103 struct u132_target *target = &ftdi->target[
1105 target->halted = (ftdi->response[0] >> 3) &
1107 target->skipped = (ftdi->response[0] >> 2) &
1109 target->toggle_bits = (ftdi->response[3] >> 6)
1111 target->error_count = (ftdi->response[3] >> 4)
1113 target->condition_code = (ftdi->response[
1115 if ((ftdi->response[0] & 0x10) == 0x00) {
1116 b = have_ed_set_response(ftdi, target,
1117 ed_length, ed_number, ed_type,
1121 b = have_ed_get_response(ftdi, target,
1122 ed_length, ed_number, ed_type,
1134 * create a urb, and a buffer for it, and copy the data to the urb
1137 static ssize_t ftdi_elan_write(struct file *file,
1138 const char __user *user_buffer, size_t count,
1144 struct usb_ftdi *ftdi = file->private_data;
1146 if (ftdi->disconnected > 0) {
1152 urb = usb_alloc_urb(0, GFP_KERNEL);
1157 buf = usb_alloc_coherent(ftdi->udev, count, GFP_KERNEL,
1158 &urb->transfer_dma);
1163 if (copy_from_user(buf, user_buffer, count)) {
1167 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
1168 ftdi->bulk_out_endpointAddr), buf, count,
1169 ftdi_elan_write_bulk_callback, ftdi);
1170 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1171 retval = usb_submit_urb(urb, GFP_KERNEL);
1173 dev_err(&ftdi->udev->dev,
1174 "failed submitting write urb, error %d\n", retval);
1182 usb_free_coherent(ftdi->udev, count, buf, urb->transfer_dma);
1189 static const struct file_operations ftdi_elan_fops = {
1190 .owner = THIS_MODULE,
1191 .llseek = no_llseek,
1192 .read = ftdi_elan_read,
1193 .write = ftdi_elan_write,
1194 .open = ftdi_elan_open,
1195 .release = ftdi_elan_release,
1199 * usb class driver info in order to get a minor number from the usb core,
1200 * and to have the device registered with the driver core
1202 static struct usb_class_driver ftdi_elan_jtag_class = {
1203 .name = "ftdi-%d-jtag",
1204 .fops = &ftdi_elan_fops,
1205 .minor_base = USB_FTDI_ELAN_MINOR_BASE,
1209 * the following definitions are for the
1210 * ELAN FPGA state machgine processor that
1211 * lies on the other side of the FTDI chip
1213 #define cPCIu132rd 0x0
1214 #define cPCIu132wr 0x1
1215 #define cPCIiord 0x2
1216 #define cPCIiowr 0x3
1217 #define cPCImemrd 0x6
1218 #define cPCImemwr 0x7
1219 #define cPCIcfgrd 0xA
1220 #define cPCIcfgwr 0xB
1221 #define cPCInull 0xF
1222 #define cU132cmd_status 0x0
1223 #define cU132flash 0x1
1224 #define cPIDsetup 0x0
1227 #define cPIDinonce 0x3
1228 #define cCCnoerror 0x0
1230 #define cCCbitstuff 0x2
1231 #define cCCtoggle 0x3
1232 #define cCCstall 0x4
1233 #define cCCnoresp 0x5
1234 #define cCCbadpid1 0x6
1235 #define cCCbadpid2 0x7
1236 #define cCCdataoverrun 0x8
1237 #define cCCdataunderrun 0x9
1238 #define cCCbuffoverrun 0xC
1239 #define cCCbuffunderrun 0xD
1240 #define cCCnotaccessed 0xF
1241 static int ftdi_elan_write_reg(struct usb_ftdi *ftdi, u32 data)
1243 wait:if (ftdi->disconnected > 0) {
1247 mutex_lock(&ftdi->u132_lock);
1248 command_size = ftdi->command_next - ftdi->command_head;
1249 if (command_size < COMMAND_SIZE) {
1250 struct u132_command *command = &ftdi->command[
1251 COMMAND_MASK & ftdi->command_next];
1252 command->header = 0x00 | cPCIu132wr;
1253 command->length = 0x04;
1254 command->address = 0x00;
1255 command->width = 0x00;
1256 command->follows = 4;
1257 command->value = data;
1258 command->buffer = &command->value;
1259 ftdi->command_next += 1;
1260 ftdi_elan_kick_command_queue(ftdi);
1261 mutex_unlock(&ftdi->u132_lock);
1264 mutex_unlock(&ftdi->u132_lock);
1271 static int ftdi_elan_write_config(struct usb_ftdi *ftdi, int config_offset,
1274 u8 addressofs = config_offset / 4;
1275 wait:if (ftdi->disconnected > 0) {
1279 mutex_lock(&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 | (cPCIcfgwr & 0x0F);
1285 command->length = 0x04;
1286 command->address = addressofs;
1287 command->width = 0x00 | (width & 0x0F);
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 mutex_unlock(&ftdi->u132_lock);
1296 mutex_unlock(&ftdi->u132_lock);
1303 static int ftdi_elan_write_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1306 u8 addressofs = mem_offset / 4;
1307 wait:if (ftdi->disconnected > 0) {
1311 mutex_lock(&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 | (cPCImemwr & 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 mutex_unlock(&ftdi->u132_lock);
1328 mutex_unlock(&ftdi->u132_lock);
1335 int usb_ftdi_elan_write_pcimem(struct platform_device *pdev, int mem_offset,
1338 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1339 return ftdi_elan_write_pcimem(ftdi, mem_offset, width, data);
1343 EXPORT_SYMBOL_GPL(usb_ftdi_elan_write_pcimem);
1344 static int ftdi_elan_read_reg(struct usb_ftdi *ftdi, u32 *data)
1346 wait:if (ftdi->disconnected > 0) {
1351 mutex_lock(&ftdi->u132_lock);
1352 command_size = ftdi->command_next - ftdi->command_head;
1353 respond_size = ftdi->respond_next - ftdi->respond_head;
1354 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1356 struct u132_command *command = &ftdi->command[
1357 COMMAND_MASK & ftdi->command_next];
1358 struct u132_respond *respond = &ftdi->respond[
1359 RESPOND_MASK & ftdi->respond_next];
1360 int result = -ENODEV;
1361 respond->result = &result;
1362 respond->header = command->header = 0x00 | cPCIu132rd;
1363 command->length = 0x04;
1364 respond->address = command->address = cU132cmd_status;
1365 command->width = 0x00;
1366 command->follows = 0;
1368 command->buffer = NULL;
1369 respond->value = data;
1370 init_completion(&respond->wait_completion);
1371 ftdi->command_next += 1;
1372 ftdi->respond_next += 1;
1373 ftdi_elan_kick_command_queue(ftdi);
1374 mutex_unlock(&ftdi->u132_lock);
1375 wait_for_completion(&respond->wait_completion);
1378 mutex_unlock(&ftdi->u132_lock);
1385 static int ftdi_elan_read_config(struct usb_ftdi *ftdi, int config_offset,
1386 u8 width, u32 *data)
1388 u8 addressofs = config_offset / 4;
1389 wait:if (ftdi->disconnected > 0) {
1394 mutex_lock(&ftdi->u132_lock);
1395 command_size = ftdi->command_next - ftdi->command_head;
1396 respond_size = ftdi->respond_next - ftdi->respond_head;
1397 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1399 struct u132_command *command = &ftdi->command[
1400 COMMAND_MASK & ftdi->command_next];
1401 struct u132_respond *respond = &ftdi->respond[
1402 RESPOND_MASK & ftdi->respond_next];
1403 int result = -ENODEV;
1404 respond->result = &result;
1405 respond->header = command->header = 0x00 | (cPCIcfgrd &
1407 command->length = 0x04;
1408 respond->address = command->address = addressofs;
1409 command->width = 0x00 | (width & 0x0F);
1410 command->follows = 0;
1412 command->buffer = NULL;
1413 respond->value = data;
1414 init_completion(&respond->wait_completion);
1415 ftdi->command_next += 1;
1416 ftdi->respond_next += 1;
1417 ftdi_elan_kick_command_queue(ftdi);
1418 mutex_unlock(&ftdi->u132_lock);
1419 wait_for_completion(&respond->wait_completion);
1422 mutex_unlock(&ftdi->u132_lock);
1429 static int ftdi_elan_read_pcimem(struct usb_ftdi *ftdi, int mem_offset,
1430 u8 width, u32 *data)
1432 u8 addressofs = mem_offset / 4;
1433 wait:if (ftdi->disconnected > 0) {
1438 mutex_lock(&ftdi->u132_lock);
1439 command_size = ftdi->command_next - ftdi->command_head;
1440 respond_size = ftdi->respond_next - ftdi->respond_head;
1441 if (command_size < COMMAND_SIZE && respond_size < RESPOND_SIZE)
1443 struct u132_command *command = &ftdi->command[
1444 COMMAND_MASK & ftdi->command_next];
1445 struct u132_respond *respond = &ftdi->respond[
1446 RESPOND_MASK & ftdi->respond_next];
1447 int result = -ENODEV;
1448 respond->result = &result;
1449 respond->header = command->header = 0x00 | (cPCImemrd &
1451 command->length = 0x04;
1452 respond->address = command->address = addressofs;
1453 command->width = 0x00 | (width & 0x0F);
1454 command->follows = 0;
1456 command->buffer = NULL;
1457 respond->value = data;
1458 init_completion(&respond->wait_completion);
1459 ftdi->command_next += 1;
1460 ftdi->respond_next += 1;
1461 ftdi_elan_kick_command_queue(ftdi);
1462 mutex_unlock(&ftdi->u132_lock);
1463 wait_for_completion(&respond->wait_completion);
1466 mutex_unlock(&ftdi->u132_lock);
1473 int usb_ftdi_elan_read_pcimem(struct platform_device *pdev, int mem_offset,
1474 u8 width, u32 *data)
1476 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1477 if (ftdi->initialized == 0) {
1480 return ftdi_elan_read_pcimem(ftdi, mem_offset, width, data);
1484 EXPORT_SYMBOL_GPL(usb_ftdi_elan_read_pcimem);
1485 static int ftdi_elan_edset_setup(struct usb_ftdi *ftdi, u8 ed_number,
1486 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1487 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1488 int toggle_bits, int error_count, int condition_code, int repeat_number,
1489 int halted, int skipped, int actual, int non_null))
1491 u8 ed = ed_number - 1;
1492 wait:if (ftdi->disconnected > 0) {
1494 } else if (ftdi->initialized == 0) {
1498 mutex_lock(&ftdi->u132_lock);
1499 command_size = ftdi->command_next - ftdi->command_head;
1500 if (command_size < COMMAND_SIZE) {
1501 struct u132_target *target = &ftdi->target[ed];
1502 struct u132_command *command = &ftdi->command[
1503 COMMAND_MASK & ftdi->command_next];
1504 command->header = 0x80 | (ed << 5);
1505 command->length = 0x8007;
1506 command->address = (toggle_bits << 6) | (ep_number << 2)
1508 command->width = usb_maxpacket(urb->dev, urb->pipe,
1509 usb_pipeout(urb->pipe));
1510 command->follows = 8;
1512 command->buffer = urb->setup_packet;
1513 target->callback = callback;
1514 target->endp = endp;
1517 ftdi->command_next += 1;
1518 ftdi_elan_kick_command_queue(ftdi);
1519 mutex_unlock(&ftdi->u132_lock);
1522 mutex_unlock(&ftdi->u132_lock);
1529 int usb_ftdi_elan_edset_setup(struct platform_device *pdev, u8 ed_number,
1530 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1531 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1532 int toggle_bits, int error_count, int condition_code, int repeat_number,
1533 int halted, int skipped, int actual, int non_null))
1535 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1536 return ftdi_elan_edset_setup(ftdi, ed_number, endp, urb, address,
1537 ep_number, toggle_bits, callback);
1541 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_setup);
1542 static int ftdi_elan_edset_input(struct usb_ftdi *ftdi, u8 ed_number,
1543 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1544 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1545 int toggle_bits, int error_count, int condition_code, int repeat_number,
1546 int halted, int skipped, int actual, int non_null))
1548 u8 ed = ed_number - 1;
1549 wait:if (ftdi->disconnected > 0) {
1551 } else if (ftdi->initialized == 0) {
1555 mutex_lock(&ftdi->u132_lock);
1556 command_size = ftdi->command_next - ftdi->command_head;
1557 if (command_size < COMMAND_SIZE) {
1558 struct u132_target *target = &ftdi->target[ed];
1559 struct u132_command *command = &ftdi->command[
1560 COMMAND_MASK & ftdi->command_next];
1561 u32 remaining_length = urb->transfer_buffer_length -
1563 command->header = 0x82 | (ed << 5);
1564 if (remaining_length == 0) {
1565 command->length = 0x0000;
1566 } else if (remaining_length > 1024) {
1567 command->length = 0x8000 | 1023;
1569 command->length = 0x8000 | (remaining_length -
1571 command->address = (toggle_bits << 6) | (ep_number << 2)
1573 command->width = usb_maxpacket(urb->dev, urb->pipe,
1574 usb_pipeout(urb->pipe));
1575 command->follows = 0;
1577 command->buffer = NULL;
1578 target->callback = callback;
1579 target->endp = endp;
1582 ftdi->command_next += 1;
1583 ftdi_elan_kick_command_queue(ftdi);
1584 mutex_unlock(&ftdi->u132_lock);
1587 mutex_unlock(&ftdi->u132_lock);
1594 int usb_ftdi_elan_edset_input(struct platform_device *pdev, u8 ed_number,
1595 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1596 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1597 int toggle_bits, int error_count, int condition_code, int repeat_number,
1598 int halted, int skipped, int actual, int non_null))
1600 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1601 return ftdi_elan_edset_input(ftdi, ed_number, endp, urb, address,
1602 ep_number, toggle_bits, callback);
1606 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_input);
1607 static int ftdi_elan_edset_empty(struct usb_ftdi *ftdi, u8 ed_number,
1608 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1609 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1610 int toggle_bits, int error_count, int condition_code, int repeat_number,
1611 int halted, int skipped, int actual, int non_null))
1613 u8 ed = ed_number - 1;
1614 wait:if (ftdi->disconnected > 0) {
1616 } else if (ftdi->initialized == 0) {
1620 mutex_lock(&ftdi->u132_lock);
1621 command_size = ftdi->command_next - ftdi->command_head;
1622 if (command_size < COMMAND_SIZE) {
1623 struct u132_target *target = &ftdi->target[ed];
1624 struct u132_command *command = &ftdi->command[
1625 COMMAND_MASK & ftdi->command_next];
1626 command->header = 0x81 | (ed << 5);
1627 command->length = 0x0000;
1628 command->address = (toggle_bits << 6) | (ep_number << 2)
1630 command->width = usb_maxpacket(urb->dev, urb->pipe,
1631 usb_pipeout(urb->pipe));
1632 command->follows = 0;
1634 command->buffer = NULL;
1635 target->callback = callback;
1636 target->endp = endp;
1639 ftdi->command_next += 1;
1640 ftdi_elan_kick_command_queue(ftdi);
1641 mutex_unlock(&ftdi->u132_lock);
1644 mutex_unlock(&ftdi->u132_lock);
1651 int usb_ftdi_elan_edset_empty(struct platform_device *pdev, u8 ed_number,
1652 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1653 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1654 int toggle_bits, int error_count, int condition_code, int repeat_number,
1655 int halted, int skipped, int actual, int non_null))
1657 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1658 return ftdi_elan_edset_empty(ftdi, ed_number, endp, urb, address,
1659 ep_number, toggle_bits, callback);
1663 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_empty);
1664 static int ftdi_elan_edset_output(struct usb_ftdi *ftdi, u8 ed_number,
1665 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1666 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1667 int toggle_bits, int error_count, int condition_code, int repeat_number,
1668 int halted, int skipped, int actual, int non_null))
1670 u8 ed = ed_number - 1;
1671 wait:if (ftdi->disconnected > 0) {
1673 } else if (ftdi->initialized == 0) {
1677 mutex_lock(&ftdi->u132_lock);
1678 command_size = ftdi->command_next - ftdi->command_head;
1679 if (command_size < COMMAND_SIZE) {
1683 char data[30 *3 + 4];
1685 int m = (sizeof(data) - 1) / 3;
1687 struct u132_target *target = &ftdi->target[ed];
1688 struct u132_command *command = &ftdi->command[
1689 COMMAND_MASK & ftdi->command_next];
1690 command->header = 0x81 | (ed << 5);
1691 command->address = (toggle_bits << 6) | (ep_number << 2)
1693 command->width = usb_maxpacket(urb->dev, urb->pipe,
1694 usb_pipeout(urb->pipe));
1695 command->follows = min_t(u32, 1024,
1696 urb->transfer_buffer_length -
1697 urb->actual_length);
1699 command->buffer = urb->transfer_buffer +
1701 command->length = 0x8000 | (command->follows - 1);
1702 b = command->buffer;
1703 urb_size = command->follows;
1705 while (urb_size-- > 0) {
1707 } else if (i++ < m) {
1708 int w = sprintf(d, " %02X", *b++);
1712 d += sprintf(d, " ..");
1714 target->callback = callback;
1715 target->endp = endp;
1718 ftdi->command_next += 1;
1719 ftdi_elan_kick_command_queue(ftdi);
1720 mutex_unlock(&ftdi->u132_lock);
1723 mutex_unlock(&ftdi->u132_lock);
1730 int usb_ftdi_elan_edset_output(struct platform_device *pdev, u8 ed_number,
1731 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1732 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1733 int toggle_bits, int error_count, int condition_code, int repeat_number,
1734 int halted, int skipped, int actual, int non_null))
1736 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1737 return ftdi_elan_edset_output(ftdi, ed_number, endp, urb, address,
1738 ep_number, toggle_bits, callback);
1742 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_output);
1743 static int ftdi_elan_edset_single(struct usb_ftdi *ftdi, u8 ed_number,
1744 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1745 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1746 int toggle_bits, int error_count, int condition_code, int repeat_number,
1747 int halted, int skipped, int actual, int non_null))
1749 u8 ed = ed_number - 1;
1750 wait:if (ftdi->disconnected > 0) {
1752 } else if (ftdi->initialized == 0) {
1756 mutex_lock(&ftdi->u132_lock);
1757 command_size = ftdi->command_next - ftdi->command_head;
1758 if (command_size < COMMAND_SIZE) {
1759 u32 remaining_length = urb->transfer_buffer_length -
1761 struct u132_target *target = &ftdi->target[ed];
1762 struct u132_command *command = &ftdi->command[
1763 COMMAND_MASK & ftdi->command_next];
1764 command->header = 0x83 | (ed << 5);
1765 if (remaining_length == 0) {
1766 command->length = 0x0000;
1767 } else if (remaining_length > 1024) {
1768 command->length = 0x8000 | 1023;
1770 command->length = 0x8000 | (remaining_length -
1772 command->address = (toggle_bits << 6) | (ep_number << 2)
1774 command->width = usb_maxpacket(urb->dev, urb->pipe,
1775 usb_pipeout(urb->pipe));
1776 command->follows = 0;
1778 command->buffer = NULL;
1779 target->callback = callback;
1780 target->endp = endp;
1783 ftdi->command_next += 1;
1784 ftdi_elan_kick_command_queue(ftdi);
1785 mutex_unlock(&ftdi->u132_lock);
1788 mutex_unlock(&ftdi->u132_lock);
1795 int usb_ftdi_elan_edset_single(struct platform_device *pdev, u8 ed_number,
1796 void *endp, struct urb *urb, u8 address, u8 ep_number, u8 toggle_bits,
1797 void (*callback) (void *endp, struct urb *urb, u8 *buf, int len,
1798 int toggle_bits, int error_count, int condition_code, int repeat_number,
1799 int halted, int skipped, int actual, int non_null))
1801 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1802 return ftdi_elan_edset_single(ftdi, ed_number, endp, urb, address,
1803 ep_number, toggle_bits, callback);
1807 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_single);
1808 static int ftdi_elan_edset_flush(struct usb_ftdi *ftdi, u8 ed_number,
1811 u8 ed = ed_number - 1;
1812 if (ftdi->disconnected > 0) {
1814 } else if (ftdi->initialized == 0) {
1817 struct u132_target *target = &ftdi->target[ed];
1818 mutex_lock(&ftdi->u132_lock);
1819 if (target->abandoning > 0) {
1820 mutex_unlock(&ftdi->u132_lock);
1823 target->abandoning = 1;
1824 wait_1:if (target->active == 1) {
1825 int command_size = ftdi->command_next -
1827 if (command_size < COMMAND_SIZE) {
1828 struct u132_command *command =
1829 &ftdi->command[COMMAND_MASK &
1830 ftdi->command_next];
1831 command->header = 0x80 | (ed << 5) |
1833 command->length = 0x00;
1834 command->address = 0x00;
1835 command->width = 0x00;
1836 command->follows = 0;
1838 command->buffer = &command->value;
1839 ftdi->command_next += 1;
1840 ftdi_elan_kick_command_queue(ftdi);
1842 mutex_unlock(&ftdi->u132_lock);
1844 mutex_lock(&ftdi->u132_lock);
1848 mutex_unlock(&ftdi->u132_lock);
1854 int usb_ftdi_elan_edset_flush(struct platform_device *pdev, u8 ed_number,
1857 struct usb_ftdi *ftdi = platform_device_to_usb_ftdi(pdev);
1858 return ftdi_elan_edset_flush(ftdi, ed_number, endp);
1862 EXPORT_SYMBOL_GPL(usb_ftdi_elan_edset_flush);
1863 static int ftdi_elan_flush_input_fifo(struct usb_ftdi *ftdi)
1865 int retry_on_empty = 10;
1866 int retry_on_timeout = 5;
1867 int retry_on_status = 20;
1869 int packet_bytes = 0;
1870 int retval = usb_bulk_msg(ftdi->udev,
1871 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
1872 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
1873 &packet_bytes, 100);
1874 if (packet_bytes > 2) {
1875 char diag[30 *3 + 4];
1877 int m = (sizeof(diag) - 1) / 3;
1878 char *b = ftdi->bulk_in_buffer;
1881 while (packet_bytes-- > 0) {
1883 if (bytes_read < m) {
1884 d += sprintf(d, " %02X",
1886 } else if (bytes_read > m) {
1888 d += sprintf(d, " ..");
1893 } else if (packet_bytes > 1) {
1894 char s1 = ftdi->bulk_in_buffer[0];
1895 char s2 = ftdi->bulk_in_buffer[1];
1896 if (s1 == 0x31 && s2 == 0x60) {
1898 } else if (retry_on_status-- > 0) {
1901 dev_err(&ftdi->udev->dev, "STATUS ERROR retry limit reached\n");
1904 } else if (packet_bytes > 0) {
1905 char b1 = ftdi->bulk_in_buffer[0];
1906 dev_err(&ftdi->udev->dev, "only one byte flushed from FTDI = %02X\n",
1908 if (retry_on_status-- > 0) {
1911 dev_err(&ftdi->udev->dev, "STATUS ERROR retry limit reached\n");
1914 } else if (retval == -ETIMEDOUT) {
1915 if (retry_on_timeout-- > 0) {
1918 dev_err(&ftdi->udev->dev, "TIMED OUT retry limit reached\n");
1921 } else if (retval == 0) {
1922 if (retry_on_empty-- > 0) {
1925 dev_err(&ftdi->udev->dev, "empty packet retry limit reached\n");
1929 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
1938 * send the long flush sequence
1941 static int ftdi_elan_synchronize_flush(struct usb_ftdi *ftdi)
1948 urb = usb_alloc_urb(0, GFP_KERNEL);
1950 dev_err(&ftdi->udev->dev, "could not alloc a urb for flush sequence\n");
1953 buf = usb_alloc_coherent(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
1955 dev_err(&ftdi->udev->dev, "could not get a buffer for flush sequence\n");
1961 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
1962 ftdi->bulk_out_endpointAddr), buf, i,
1963 ftdi_elan_write_bulk_callback, ftdi);
1964 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1965 retval = usb_submit_urb(urb, GFP_KERNEL);
1967 dev_err(&ftdi->udev->dev, "failed to submit urb containing the flush sequence\n");
1968 usb_free_coherent(ftdi->udev, i, buf, urb->transfer_dma);
1978 * send the reset sequence
1981 static int ftdi_elan_synchronize_reset(struct usb_ftdi *ftdi)
1988 urb = usb_alloc_urb(0, GFP_KERNEL);
1990 dev_err(&ftdi->udev->dev, "could not get a urb for the reset sequence\n");
1993 buf = usb_alloc_coherent(ftdi->udev, I, GFP_KERNEL, &urb->transfer_dma);
1995 dev_err(&ftdi->udev->dev, "could not get a buffer for the reset sequence\n");
2003 usb_fill_bulk_urb(urb, ftdi->udev, usb_sndbulkpipe(ftdi->udev,
2004 ftdi->bulk_out_endpointAddr), buf, i,
2005 ftdi_elan_write_bulk_callback, ftdi);
2006 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2007 retval = usb_submit_urb(urb, GFP_KERNEL);
2009 dev_err(&ftdi->udev->dev, "failed to submit urb containing the reset sequence\n");
2010 usb_free_coherent(ftdi->udev, i, buf, urb->transfer_dma);
2018 static int ftdi_elan_synchronize(struct usb_ftdi *ftdi)
2022 int retry_on_timeout = 5;
2023 int retry_on_empty = 10;
2025 retval = ftdi_elan_flush_input_fifo(ftdi);
2028 ftdi->bulk_in_left = 0;
2029 ftdi->bulk_in_last = -1;
2030 while (long_stop-- > 0) {
2033 retval = ftdi_elan_synchronize_flush(ftdi);
2036 retval = ftdi_elan_flush_input_fifo(ftdi);
2039 reset:retval = ftdi_elan_synchronize_reset(ftdi);
2045 int packet_bytes = 0;
2046 retval = usb_bulk_msg(ftdi->udev,
2047 usb_rcvbulkpipe(ftdi->udev,
2048 ftdi->bulk_in_endpointAddr),
2049 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2050 &packet_bytes, 500);
2051 if (packet_bytes > 2) {
2052 char diag[30 *3 + 4];
2054 int m = (sizeof(diag) - 1) / 3;
2055 char *b = ftdi->bulk_in_buffer;
2057 unsigned char c = 0;
2059 while (packet_bytes-- > 0) {
2061 if (bytes_read < m) {
2062 d += sprintf(d, " %02X", c);
2063 } else if (bytes_read > m) {
2065 d += sprintf(d, " ..");
2074 } else if (read_stop-- > 0) {
2077 dev_err(&ftdi->udev->dev, "retry limit reached\n");
2081 } else if (packet_bytes > 1) {
2082 unsigned char s1 = ftdi->bulk_in_buffer[0];
2083 unsigned char s2 = ftdi->bulk_in_buffer[1];
2084 if (s1 == 0x31 && s2 == 0x00) {
2085 if (read_stuck-- > 0) {
2089 } else if (s1 == 0x31 && s2 == 0x60) {
2090 if (read_stop-- > 0) {
2093 dev_err(&ftdi->udev->dev, "retry limit reached\n");
2097 if (read_stop-- > 0) {
2100 dev_err(&ftdi->udev->dev, "retry limit reached\n");
2104 } else if (packet_bytes > 0) {
2105 if (read_stop-- > 0) {
2108 dev_err(&ftdi->udev->dev, "retry limit reached\n");
2111 } else if (retval == -ETIMEDOUT) {
2112 if (retry_on_timeout-- > 0) {
2115 dev_err(&ftdi->udev->dev, "TIMED OUT retry limit reached\n");
2118 } else if (retval == 0) {
2119 if (retry_on_empty-- > 0) {
2122 dev_err(&ftdi->udev->dev, "empty packet retry limit reached\n");
2127 dev_err(&ftdi->udev->dev, "error = %d\n",
2129 if (read_stop-- > 0) {
2132 dev_err(&ftdi->udev->dev, "retry limit reached\n");
2138 dev_err(&ftdi->udev->dev, "failed to synchronize\n");
2142 static int ftdi_elan_stuck_waiting(struct usb_ftdi *ftdi)
2144 int retry_on_empty = 10;
2145 int retry_on_timeout = 5;
2146 int retry_on_status = 50;
2148 int packet_bytes = 0;
2149 int retval = usb_bulk_msg(ftdi->udev,
2150 usb_rcvbulkpipe(ftdi->udev, ftdi->bulk_in_endpointAddr),
2151 ftdi->bulk_in_buffer, ftdi->bulk_in_size,
2152 &packet_bytes, 1000);
2153 if (packet_bytes > 2) {
2154 char diag[30 *3 + 4];
2156 int m = (sizeof(diag) - 1) / 3;
2157 char *b = ftdi->bulk_in_buffer;
2160 while (packet_bytes-- > 0) {
2162 if (bytes_read < m) {
2163 d += sprintf(d, " %02X",
2165 } else if (bytes_read > m) {
2167 d += sprintf(d, " ..");
2172 } else if (packet_bytes > 1) {
2173 char s1 = ftdi->bulk_in_buffer[0];
2174 char s2 = ftdi->bulk_in_buffer[1];
2175 if (s1 == 0x31 && s2 == 0x60) {
2177 } else if (retry_on_status-- > 0) {
2182 } else if (packet_bytes > 0) {
2183 char b1 = ftdi->bulk_in_buffer[0];
2184 dev_err(&ftdi->udev->dev, "only one byte flushed from FTDI = %02X\n", b1);
2185 if (retry_on_status-- > 0) {
2189 dev_err(&ftdi->udev->dev, "STATUS ERROR retry limit reached\n");
2192 } else if (retval == -ETIMEDOUT) {
2193 if (retry_on_timeout-- > 0) {
2196 dev_err(&ftdi->udev->dev, "TIMED OUT retry limit reached\n");
2199 } else if (retval == 0) {
2200 if (retry_on_empty-- > 0) {
2203 dev_err(&ftdi->udev->dev, "empty packet retry limit reached\n");
2207 dev_err(&ftdi->udev->dev, "error = %d\n", retval);
2214 static int ftdi_elan_checkingPCI(struct usb_ftdi *ftdi)
2216 int UxxxStatus = ftdi_elan_read_reg(ftdi, &ftdi->controlreg);
2219 if (ftdi->controlreg & 0x00400000) {
2220 if (ftdi->card_ejected) {
2222 ftdi->card_ejected = 1;
2223 dev_err(&ftdi->udev->dev, "CARD EJECTED - controlreg = %08X\n",
2228 u8 fn = ftdi->function - 1;
2229 int activePCIfn = fn << 8;
2234 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2238 pciVID = pcidata & 0xFFFF;
2239 pciPID = (pcidata >> 16) & 0xFFFF;
2240 if (pciVID == ftdi->platform_data.vendor && pciPID ==
2241 ftdi->platform_data.device) {
2244 dev_err(&ftdi->udev->dev, "vendor=%04X pciVID=%04X device=%04X pciPID=%04X\n",
2245 ftdi->platform_data.vendor, pciVID,
2246 ftdi->platform_data.device, pciPID);
2253 #define ftdi_read_pcimem(ftdi, member, data) ftdi_elan_read_pcimem(ftdi, \
2254 offsetof(struct ohci_regs, member), 0, data);
2255 #define ftdi_write_pcimem(ftdi, member, data) ftdi_elan_write_pcimem(ftdi, \
2256 offsetof(struct ohci_regs, member), 0, data);
2258 #define OHCI_CONTROL_INIT OHCI_CTRL_CBSR
2259 #define OHCI_INTR_INIT (OHCI_INTR_MIE | OHCI_INTR_UE | OHCI_INTR_RD | \
2261 static int ftdi_elan_check_controller(struct usb_ftdi *ftdi, int quirk)
2275 int mask = OHCI_INTR_INIT;
2277 int reset_timeout = 30; /* ... allow extra time */
2279 retval = ftdi_write_pcimem(ftdi, intrdisable, OHCI_INTR_MIE);
2282 retval = ftdi_read_pcimem(ftdi, control, &control);
2285 retval = ftdi_read_pcimem(ftdi, roothub.a, &rh_a);
2288 num_ports = rh_a & RH_A_NDP;
2289 retval = ftdi_read_pcimem(ftdi, fminterval, &hc_fminterval);
2292 hc_fminterval &= 0x3fff;
2293 if (hc_fminterval != FI) {
2295 hc_fminterval |= FSMP(hc_fminterval) << 16;
2296 retval = ftdi_read_pcimem(ftdi, control, &hc_control);
2299 switch (hc_control & OHCI_CTRL_HCFS) {
2303 case OHCI_USB_SUSPEND:
2304 case OHCI_USB_RESUME:
2305 hc_control &= OHCI_CTRL_RWC;
2306 hc_control |= OHCI_USB_RESUME;
2310 hc_control &= OHCI_CTRL_RWC;
2311 hc_control |= OHCI_USB_RESET;
2315 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2318 retval = ftdi_read_pcimem(ftdi, control, &control);
2322 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2325 if (!(roothub_a & RH_A_NPS)) { /* power down each port */
2326 for (temp = 0; temp < num_ports; temp++) {
2327 retval = ftdi_write_pcimem(ftdi,
2328 roothub.portstatus[temp], RH_PS_LSDA);
2333 retval = ftdi_read_pcimem(ftdi, control, &control);
2336 retry:retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2339 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_HCR);
2343 retval = ftdi_read_pcimem(ftdi, cmdstatus, &status);
2346 if (0 != (status & OHCI_HCR)) {
2347 if (--reset_timeout == 0) {
2348 dev_err(&ftdi->udev->dev, "USB HC reset timed out!\n");
2356 if (quirk & OHCI_QUIRK_INITRESET) {
2357 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2360 retval = ftdi_read_pcimem(ftdi, control, &control);
2364 retval = ftdi_write_pcimem(ftdi, ed_controlhead, 0x00000000);
2367 retval = ftdi_write_pcimem(ftdi, ed_bulkhead, 0x11000000);
2370 retval = ftdi_write_pcimem(ftdi, hcca, 0x00000000);
2373 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2376 retval = ftdi_write_pcimem(ftdi, fminterval,
2377 ((fminterval & FIT) ^ FIT) | hc_fminterval);
2380 retval = ftdi_write_pcimem(ftdi, periodicstart,
2381 ((9 *hc_fminterval) / 10) & 0x3fff);
2384 retval = ftdi_read_pcimem(ftdi, fminterval, &fminterval);
2387 retval = ftdi_read_pcimem(ftdi, periodicstart, &periodicstart);
2390 if (0 == (fminterval & 0x3fff0000) || 0 == periodicstart) {
2391 if (!(quirk & OHCI_QUIRK_INITRESET)) {
2392 quirk |= OHCI_QUIRK_INITRESET;
2395 dev_err(&ftdi->udev->dev, "init err(%08x %04x)\n",
2396 fminterval, periodicstart);
2397 } /* start controller operations */
2398 hc_control &= OHCI_CTRL_RWC;
2399 hc_control |= OHCI_CONTROL_INIT | OHCI_CTRL_BLE | OHCI_USB_OPER;
2400 retval = ftdi_write_pcimem(ftdi, control, hc_control);
2403 retval = ftdi_write_pcimem(ftdi, cmdstatus, OHCI_BLF);
2406 retval = ftdi_read_pcimem(ftdi, cmdstatus, &cmdstatus);
2409 retval = ftdi_read_pcimem(ftdi, control, &control);
2412 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_DRWE);
2415 retval = ftdi_write_pcimem(ftdi, intrstatus, mask);
2418 retval = ftdi_write_pcimem(ftdi, intrdisable,
2419 OHCI_INTR_MIE | OHCI_INTR_OC | OHCI_INTR_RHSC | OHCI_INTR_FNO |
2420 OHCI_INTR_UE | OHCI_INTR_RD | OHCI_INTR_SF | OHCI_INTR_WDH |
2423 return retval; /* handle root hub init quirks ... */
2424 retval = ftdi_read_pcimem(ftdi, roothub.a, &roothub_a);
2427 roothub_a &= ~(RH_A_PSM | RH_A_OCPM);
2428 if (quirk & OHCI_QUIRK_SUPERIO) {
2429 roothub_a |= RH_A_NOCP;
2430 roothub_a &= ~(RH_A_POTPGT | RH_A_NPS);
2431 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2434 } else if ((quirk & OHCI_QUIRK_AMD756) || distrust_firmware) {
2435 roothub_a |= RH_A_NPS;
2436 retval = ftdi_write_pcimem(ftdi, roothub.a, roothub_a);
2440 retval = ftdi_write_pcimem(ftdi, roothub.status, RH_HS_LPSC);
2443 retval = ftdi_write_pcimem(ftdi, roothub.b,
2444 (roothub_a & RH_A_NPS) ? 0 : RH_B_PPCM);
2447 retval = ftdi_read_pcimem(ftdi, control, &control);
2450 mdelay((roothub_a >> 23) & 0x1fe);
2451 for (temp = 0; temp < num_ports; temp++) {
2453 retval = ftdi_read_pcimem(ftdi, roothub.portstatus[temp],
2463 static int ftdi_elan_setup_controller(struct usb_ftdi *ftdi, int fn)
2469 int activePCIfn = fn << 8;
2470 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2474 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2478 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2482 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2486 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2491 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2495 latence_timer &= 0xFFFF00FF;
2496 latence_timer |= 0x00001600;
2497 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2501 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2506 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2510 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2514 for (reg = 0; reg <= 0x54; reg += 4) {
2515 UxxxStatus = ftdi_elan_read_pcimem(ftdi, reg, 0, &pcidata);
2522 static int ftdi_elan_close_controller(struct usb_ftdi *ftdi, int fn)
2528 int activePCIfn = fn << 8;
2529 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x2800);
2533 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2537 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2541 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0,
2545 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2550 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2554 latence_timer &= 0xFFFF00FF;
2555 latence_timer |= 0x00001600;
2556 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2560 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2565 UxxxStatus = ftdi_elan_write_config(ftdi, activePCIfn | reg, 0x00,
2569 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2576 static int ftdi_elan_found_controller(struct usb_ftdi *ftdi, int fn, int quirk)
2580 UxxxStatus = ftdi_elan_setup_controller(ftdi, fn);
2583 result = ftdi_elan_check_controller(ftdi, quirk);
2584 UxxxStatus = ftdi_elan_close_controller(ftdi, fn);
2590 static int ftdi_elan_enumeratePCI(struct usb_ftdi *ftdi)
2595 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2598 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000000L);
2602 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x100);
2605 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x00000200L | 0x500);
2608 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2611 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020CL | 0x000);
2614 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020DL | 0x000);
2618 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000020FL | 0x000);
2621 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2624 UxxxStatus = ftdi_elan_write_reg(ftdi, 0x0000025FL | 0x800);
2627 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2630 UxxxStatus = ftdi_elan_read_reg(ftdi, &controlreg);
2634 sensebits = (controlreg >> 16) & 0x000F;
2635 if (0x0D == sensebits)
2641 static int ftdi_elan_setupOHCI(struct usb_ftdi *ftdi)
2647 int activePCIfn = 0;
2648 int max_devices = 0;
2649 int controllers = 0;
2650 int unrecognized = 0;
2652 for (fn = 0; (fn < 4); fn++) {
2656 activePCIfn = fn << 8;
2657 UxxxStatus = ftdi_elan_read_config(ftdi, activePCIfn | reg, 0,
2661 pciVID = pcidata & 0xFFFF;
2662 pciPID = (pcidata >> 16) & 0xFFFF;
2663 if ((pciVID == PCI_VENDOR_ID_OPTI) && (pciPID == 0xc861)) {
2664 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2666 } else if ((pciVID == PCI_VENDOR_ID_NEC) && (pciPID == 0x0035))
2668 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2670 } else if ((pciVID == PCI_VENDOR_ID_AL) && (pciPID == 0x5237)) {
2671 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2673 } else if ((pciVID == PCI_VENDOR_ID_ATT) && (pciPID == 0x5802))
2675 devices = ftdi_elan_found_controller(ftdi, fn, 0);
2677 } else if (pciVID == PCI_VENDOR_ID_AMD && pciPID == 0x740c) {
2678 devices = ftdi_elan_found_controller(ftdi, fn,
2681 } else if (pciVID == PCI_VENDOR_ID_COMPAQ && pciPID == 0xa0f8) {
2682 devices = ftdi_elan_found_controller(ftdi, fn,
2683 OHCI_QUIRK_ZFMICRO);
2685 } else if (0 == pcidata) {
2688 if (devices > max_devices) {
2689 max_devices = devices;
2690 ftdi->function = fn + 1;
2691 ftdi->platform_data.vendor = pciVID;
2692 ftdi->platform_data.device = pciPID;
2695 if (ftdi->function > 0) {
2696 UxxxStatus = ftdi_elan_setup_controller(ftdi,
2697 ftdi->function - 1);
2701 } else if (controllers > 0) {
2703 } else if (unrecognized > 0) {
2706 ftdi->enumerated = 0;
2713 * we use only the first bulk-in and bulk-out endpoints
2715 static int ftdi_elan_probe(struct usb_interface *interface,
2716 const struct usb_device_id *id)
2718 struct usb_host_interface *iface_desc;
2719 struct usb_endpoint_descriptor *endpoint;
2722 int retval = -ENOMEM;
2723 struct usb_ftdi *ftdi;
2725 ftdi = kzalloc(sizeof(struct usb_ftdi), GFP_KERNEL);
2727 printk(KERN_ERR "Out of memory\n");
2731 mutex_lock(&ftdi_module_lock);
2732 list_add_tail(&ftdi->ftdi_list, &ftdi_static_list);
2733 ftdi->sequence_num = ++ftdi_instances;
2734 mutex_unlock(&ftdi_module_lock);
2735 ftdi_elan_init_kref(ftdi);
2736 sema_init(&ftdi->sw_lock, 1);
2737 ftdi->udev = usb_get_dev(interface_to_usbdev(interface));
2738 ftdi->interface = interface;
2739 mutex_init(&ftdi->u132_lock);
2741 iface_desc = interface->cur_altsetting;
2742 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
2743 endpoint = &iface_desc->endpoint[i].desc;
2744 if (!ftdi->bulk_in_endpointAddr &&
2745 usb_endpoint_is_bulk_in(endpoint)) {
2746 buffer_size = usb_endpoint_maxp(endpoint);
2747 ftdi->bulk_in_size = buffer_size;
2748 ftdi->bulk_in_endpointAddr = endpoint->bEndpointAddress;
2749 ftdi->bulk_in_buffer = kmalloc(buffer_size, GFP_KERNEL);
2750 if (!ftdi->bulk_in_buffer) {
2751 dev_err(&ftdi->udev->dev, "Could not allocate bulk_in_buffer\n");
2756 if (!ftdi->bulk_out_endpointAddr &&
2757 usb_endpoint_is_bulk_out(endpoint)) {
2758 ftdi->bulk_out_endpointAddr =
2759 endpoint->bEndpointAddress;
2762 if (!(ftdi->bulk_in_endpointAddr && ftdi->bulk_out_endpointAddr)) {
2763 dev_err(&ftdi->udev->dev, "Could not find both bulk-in and bulk-out endpoints\n");
2767 dev_info(&ftdi->udev->dev, "interface %d has I=%02X O=%02X\n",
2768 iface_desc->desc.bInterfaceNumber, ftdi->bulk_in_endpointAddr,
2769 ftdi->bulk_out_endpointAddr);
2770 usb_set_intfdata(interface, ftdi);
2771 if (iface_desc->desc.bInterfaceNumber == 0 &&
2772 ftdi->bulk_in_endpointAddr == 0x81 &&
2773 ftdi->bulk_out_endpointAddr == 0x02) {
2774 retval = usb_register_dev(interface, &ftdi_elan_jtag_class);
2776 dev_err(&ftdi->udev->dev, "Not able to get a minor for this device\n");
2777 usb_set_intfdata(interface, NULL);
2781 ftdi->class = &ftdi_elan_jtag_class;
2782 dev_info(&ftdi->udev->dev, "USB FDTI=%p JTAG interface %d now attached to ftdi%d\n",
2783 ftdi, iface_desc->desc.bInterfaceNumber,
2787 } else if (iface_desc->desc.bInterfaceNumber == 1 &&
2788 ftdi->bulk_in_endpointAddr == 0x83 &&
2789 ftdi->bulk_out_endpointAddr == 0x04) {
2791 dev_info(&ftdi->udev->dev, "USB FDTI=%p ELAN interface %d now activated\n",
2792 ftdi, iface_desc->desc.bInterfaceNumber);
2793 INIT_DELAYED_WORK(&ftdi->status_work, ftdi_elan_status_work);
2794 INIT_DELAYED_WORK(&ftdi->command_work, ftdi_elan_command_work);
2795 INIT_DELAYED_WORK(&ftdi->respond_work, ftdi_elan_respond_work);
2796 ftdi_status_queue_work(ftdi, msecs_to_jiffies(3 *1000));
2799 dev_err(&ftdi->udev->dev,
2800 "Could not find ELAN's U132 device\n");
2805 ftdi_elan_put_kref(ftdi);
2810 static void ftdi_elan_disconnect(struct usb_interface *interface)
2812 struct usb_ftdi *ftdi = usb_get_intfdata(interface);
2813 ftdi->disconnected += 1;
2815 int minor = interface->minor;
2816 struct usb_class_driver *class = ftdi->class;
2817 usb_set_intfdata(interface, NULL);
2818 usb_deregister_dev(interface, class);
2819 dev_info(&ftdi->udev->dev, "USB FTDI U132 jtag interface on minor %d now disconnected\n",
2822 ftdi_status_cancel_work(ftdi);
2823 ftdi_command_cancel_work(ftdi);
2824 ftdi_response_cancel_work(ftdi);
2825 ftdi_elan_abandon_completions(ftdi);
2826 ftdi_elan_abandon_targets(ftdi);
2827 if (ftdi->registered) {
2828 platform_device_unregister(&ftdi->platform_dev);
2829 ftdi->synchronized = 0;
2830 ftdi->enumerated = 0;
2831 ftdi->initialized = 0;
2832 ftdi->registered = 0;
2834 flush_workqueue(status_queue);
2835 flush_workqueue(command_queue);
2836 flush_workqueue(respond_queue);
2837 ftdi->disconnected += 1;
2838 usb_set_intfdata(interface, NULL);
2839 dev_info(&ftdi->udev->dev, "USB FTDI U132 host controller interface now disconnected\n");
2841 ftdi_elan_put_kref(ftdi);
2844 static struct usb_driver ftdi_elan_driver = {
2845 .name = "ftdi-elan",
2846 .probe = ftdi_elan_probe,
2847 .disconnect = ftdi_elan_disconnect,
2848 .id_table = ftdi_elan_table,
2850 static int __init ftdi_elan_init(void)
2853 printk(KERN_INFO "driver %s\n", ftdi_elan_driver.name);
2854 mutex_init(&ftdi_module_lock);
2855 INIT_LIST_HEAD(&ftdi_static_list);
2856 status_queue = create_singlethread_workqueue("ftdi-status-control");
2858 goto err_status_queue;
2859 command_queue = create_singlethread_workqueue("ftdi-command-engine");
2861 goto err_command_queue;
2862 respond_queue = create_singlethread_workqueue("ftdi-respond-engine");
2864 goto err_respond_queue;
2865 result = usb_register(&ftdi_elan_driver);
2867 destroy_workqueue(status_queue);
2868 destroy_workqueue(command_queue);
2869 destroy_workqueue(respond_queue);
2870 printk(KERN_ERR "usb_register failed. Error number %d\n",
2876 destroy_workqueue(command_queue);
2878 destroy_workqueue(status_queue);
2880 printk(KERN_ERR "%s couldn't create workqueue\n", ftdi_elan_driver.name);
2884 static void __exit ftdi_elan_exit(void)
2886 struct usb_ftdi *ftdi;
2887 struct usb_ftdi *temp;
2888 usb_deregister(&ftdi_elan_driver);
2889 printk(KERN_INFO "ftdi_u132 driver deregistered\n");
2890 list_for_each_entry_safe(ftdi, temp, &ftdi_static_list, ftdi_list) {
2891 ftdi_status_cancel_work(ftdi);
2892 ftdi_command_cancel_work(ftdi);
2893 ftdi_response_cancel_work(ftdi);
2894 } flush_workqueue(status_queue);
2895 destroy_workqueue(status_queue);
2896 status_queue = NULL;
2897 flush_workqueue(command_queue);
2898 destroy_workqueue(command_queue);
2899 command_queue = NULL;
2900 flush_workqueue(respond_queue);
2901 destroy_workqueue(respond_queue);
2902 respond_queue = NULL;
2906 module_init(ftdi_elan_init);
2907 module_exit(ftdi_elan_exit);