1 /***************************************************************************
5 copyright : (C) 2003-2011 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
15 ***************************************************************************/
18 \mainpage libftdi API documentation
20 Library to talk to FTDI chips. You find the latest versions of libftdi at
21 http://www.intra2net.com/en/developer/libftdi/
23 The library is easy to use. Have a look at this short example:
26 More examples can be found in the "examples" directory.
28 /** \addtogroup libftdi */
39 #define ftdi_error_return(code, str) do { \
40 ftdi->error_str = str; \
44 #define ftdi_error_return_free_device_list(code, str, devs) do { \
45 libusb_free_device_list(devs,1); \
46 ftdi->error_str = str; \
52 Internal function to close usb device pointer.
53 Sets ftdi->usb_dev to NULL.
56 \param ftdi pointer to ftdi_context
60 static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
62 if (ftdi && ftdi->usb_dev)
64 libusb_close (ftdi->usb_dev);
67 ftdi->eeprom->initialized_for_connected_device = 0;
72 Initializes a ftdi_context.
74 \param ftdi pointer to ftdi_context
77 \retval -1: couldn't allocate read buffer
78 \retval -2: couldn't allocate struct buffer
79 \retval -3: libusb_init() failed
81 \remark This should be called before all functions
83 int ftdi_init(struct ftdi_context *ftdi)
85 struct ftdi_eeprom* eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
88 ftdi->usb_read_timeout = 5000;
89 ftdi->usb_write_timeout = 5000;
91 ftdi->type = TYPE_BM; /* chip type */
93 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
95 ftdi->readbuffer = NULL;
96 ftdi->readbuffer_offset = 0;
97 ftdi->readbuffer_remaining = 0;
98 ftdi->writebuffer_chunksize = 4096;
99 ftdi->max_packet_size = 0;
100 ftdi->error_str = NULL;
101 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
103 if (libusb_init(&ftdi->usb_ctx) < 0)
104 ftdi_error_return(-3, "libusb_init() failed");
106 ftdi_set_interface(ftdi, INTERFACE_ANY);
107 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
110 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
111 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
112 ftdi->eeprom = eeprom;
114 /* All fine. Now allocate the readbuffer */
115 return ftdi_read_data_set_chunksize(ftdi, 4096);
119 Allocate and initialize a new ftdi_context
121 \return a pointer to a new ftdi_context, or NULL on failure
123 struct ftdi_context *ftdi_new(void)
125 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
132 if (ftdi_init(ftdi) != 0)
142 Open selected channels on a chip, otherwise use first channel.
144 \param ftdi pointer to ftdi_context
145 \param interface Interface to use for FT2232C/2232H/4232H chips.
148 \retval -1: unknown interface
149 \retval -2: USB device unavailable
151 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
154 ftdi_error_return(-2, "USB device unavailable");
161 ftdi->index = INTERFACE_A;
167 ftdi->index = INTERFACE_B;
173 ftdi->index = INTERFACE_C;
179 ftdi->index = INTERFACE_D;
184 ftdi_error_return(-1, "Unknown interface");
190 Deinitializes a ftdi_context.
192 \param ftdi pointer to ftdi_context
194 void ftdi_deinit(struct ftdi_context *ftdi)
199 ftdi_usb_close_internal (ftdi);
201 if (ftdi->readbuffer != NULL)
203 free(ftdi->readbuffer);
204 ftdi->readbuffer = NULL;
207 if (ftdi->eeprom != NULL)
209 if (ftdi->eeprom->manufacturer != 0)
211 free(ftdi->eeprom->manufacturer);
212 ftdi->eeprom->manufacturer = 0;
214 if (ftdi->eeprom->product != 0)
216 free(ftdi->eeprom->product);
217 ftdi->eeprom->product = 0;
219 if (ftdi->eeprom->serial != 0)
221 free(ftdi->eeprom->serial);
222 ftdi->eeprom->serial = 0;
230 libusb_exit(ftdi->usb_ctx);
231 ftdi->usb_ctx = NULL;
236 Deinitialize and free an ftdi_context.
238 \param ftdi pointer to ftdi_context
240 void ftdi_free(struct ftdi_context *ftdi)
247 Use an already open libusb device.
249 \param ftdi pointer to ftdi_context
250 \param usb libusb libusb_device_handle to use
252 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
262 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
263 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
264 use. With VID:PID 0:0, search for the default devices
265 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014)
267 \param ftdi pointer to ftdi_context
268 \param devlist Pointer where to store list of found devices
269 \param vendor Vendor ID to search for
270 \param product Product ID to search for
272 \retval >0: number of devices found
273 \retval -3: out of memory
274 \retval -5: libusb_get_device_list() failed
275 \retval -6: libusb_get_device_descriptor() failed
277 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
279 struct ftdi_device_list **curdev;
281 libusb_device **devs;
285 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
286 ftdi_error_return(-5, "libusb_get_device_list() failed");
291 while ((dev = devs[i++]) != NULL)
293 struct libusb_device_descriptor desc;
295 if (libusb_get_device_descriptor(dev, &desc) < 0)
296 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
298 if (((vendor != 0 && product != 0) &&
299 desc.idVendor == vendor && desc.idProduct == product) ||
300 ((vendor == 0 && product == 0) &&
301 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
302 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014)))
304 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
306 ftdi_error_return_free_device_list(-3, "out of memory", devs);
308 (*curdev)->next = NULL;
309 (*curdev)->dev = dev;
310 libusb_ref_device(dev);
311 curdev = &(*curdev)->next;
315 libusb_free_device_list(devs,1);
320 Frees a usb device list.
322 \param devlist USB device list created by ftdi_usb_find_all()
324 void ftdi_list_free(struct ftdi_device_list **devlist)
326 struct ftdi_device_list *curdev, *next;
328 for (curdev = *devlist; curdev != NULL;)
331 libusb_unref_device(curdev->dev);
340 Frees a usb device list.
342 \param devlist USB device list created by ftdi_usb_find_all()
344 void ftdi_list_free2(struct ftdi_device_list *devlist)
346 ftdi_list_free(&devlist);
350 Return device ID strings from the usb device.
352 The parameters manufacturer, description and serial may be NULL
353 or pointer to buffers to store the fetched strings.
355 \note Use this function only in combination with ftdi_usb_find_all()
356 as it closes the internal "usb_dev" after use.
358 \param ftdi pointer to ftdi_context
359 \param dev libusb usb_dev to use
360 \param manufacturer Store manufacturer string here if not NULL
361 \param mnf_len Buffer size of manufacturer string
362 \param description Store product description string here if not NULL
363 \param desc_len Buffer size of product description string
364 \param serial Store serial string here if not NULL
365 \param serial_len Buffer size of serial string
368 \retval -1: wrong arguments
369 \retval -4: unable to open device
370 \retval -7: get product manufacturer failed
371 \retval -8: get product description failed
372 \retval -9: get serial number failed
373 \retval -11: libusb_get_device_descriptor() failed
375 int ftdi_usb_get_strings(struct ftdi_context * ftdi, struct libusb_device * dev,
376 char * manufacturer, int mnf_len, char * description, int desc_len, char * serial, int serial_len)
378 struct libusb_device_descriptor desc;
380 if ((ftdi==NULL) || (dev==NULL))
383 if (libusb_open(dev, &ftdi->usb_dev) < 0)
384 ftdi_error_return(-4, "libusb_open() failed");
386 if (libusb_get_device_descriptor(dev, &desc) < 0)
387 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
389 if (manufacturer != NULL)
391 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
393 ftdi_usb_close_internal (ftdi);
394 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
398 if (description != NULL)
400 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
402 ftdi_usb_close_internal (ftdi);
403 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
409 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
411 ftdi_usb_close_internal (ftdi);
412 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
416 ftdi_usb_close_internal (ftdi);
422 * Internal function to determine the maximum packet size.
423 * \param ftdi pointer to ftdi_context
424 * \param dev libusb usb_dev to use
425 * \retval Maximum packet size for this device
427 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
429 struct libusb_device_descriptor desc;
430 struct libusb_config_descriptor *config0;
431 unsigned int packet_size;
434 if (ftdi == NULL || dev == NULL)
437 // Determine maximum packet size. Init with default value.
438 // New hi-speed devices from FTDI use a packet size of 512 bytes
439 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
440 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
445 if (libusb_get_device_descriptor(dev, &desc) < 0)
448 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
451 if (desc.bNumConfigurations > 0)
453 if (ftdi->interface < config0->bNumInterfaces)
455 struct libusb_interface interface = config0->interface[ftdi->interface];
456 if (interface.num_altsetting > 0)
458 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
459 if (descriptor.bNumEndpoints > 0)
461 packet_size = descriptor.endpoint[0].wMaxPacketSize;
467 libusb_free_config_descriptor (config0);
472 Opens a ftdi device given by an usb_device.
474 \param ftdi pointer to ftdi_context
475 \param dev libusb usb_dev to use
478 \retval -3: unable to config device
479 \retval -4: unable to open device
480 \retval -5: unable to claim device
481 \retval -6: reset failed
482 \retval -7: set baudrate failed
483 \retval -8: ftdi context invalid
484 \retval -9: libusb_get_device_descriptor() failed
485 \retval -10: libusb_get_config_descriptor() failed
486 \retval -11: libusb_detach_kernel_driver() failed
487 \retval -12: libusb_get_configuration() failed
489 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
491 struct libusb_device_descriptor desc;
492 struct libusb_config_descriptor *config0;
493 int cfg, cfg0, detach_errno = 0;
496 ftdi_error_return(-8, "ftdi context invalid");
498 if (libusb_open(dev, &ftdi->usb_dev) < 0)
499 ftdi_error_return(-4, "libusb_open() failed");
501 if (libusb_get_device_descriptor(dev, &desc) < 0)
502 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
504 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
505 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
506 cfg0 = config0->bConfigurationValue;
507 libusb_free_config_descriptor (config0);
509 // Try to detach ftdi_sio kernel module.
511 // The return code is kept in a separate variable and only parsed
512 // if usb_set_configuration() or usb_claim_interface() fails as the
513 // detach operation might be denied and everything still works fine.
514 // Likely scenario is a static ftdi_sio kernel module.
515 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
517 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
518 detach_errno = errno;
521 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
522 ftdi_error_return(-12, "libusb_get_configuration () failed");
523 // set configuration (needed especially for windows)
524 // tolerate EBUSY: one device with one configuration, but two interfaces
525 // and libftdi sessions to both interfaces (e.g. FT2232)
526 if (desc.bNumConfigurations > 0 && cfg != cfg0)
528 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
530 ftdi_usb_close_internal (ftdi);
531 if (detach_errno == EPERM)
533 ftdi_error_return(-8, "inappropriate permissions on device!");
537 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
542 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
544 ftdi_usb_close_internal (ftdi);
545 if (detach_errno == EPERM)
547 ftdi_error_return(-8, "inappropriate permissions on device!");
551 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
555 if (ftdi_usb_reset (ftdi) != 0)
557 ftdi_usb_close_internal (ftdi);
558 ftdi_error_return(-6, "ftdi_usb_reset failed");
561 // Try to guess chip type
562 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
563 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
564 && desc.iSerialNumber == 0))
565 ftdi->type = TYPE_BM;
566 else if (desc.bcdDevice == 0x200)
567 ftdi->type = TYPE_AM;
568 else if (desc.bcdDevice == 0x500)
569 ftdi->type = TYPE_2232C;
570 else if (desc.bcdDevice == 0x600)
572 else if (desc.bcdDevice == 0x700)
573 ftdi->type = TYPE_2232H;
574 else if (desc.bcdDevice == 0x800)
575 ftdi->type = TYPE_4232H;
576 else if (desc.bcdDevice == 0x900)
577 ftdi->type = TYPE_232H;
579 // Determine maximum packet size
580 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
582 if (ftdi_set_baudrate (ftdi, 9600) != 0)
584 ftdi_usb_close_internal (ftdi);
585 ftdi_error_return(-7, "set baudrate failed");
588 ftdi_error_return(0, "all fine");
592 Opens the first device with a given vendor and product ids.
594 \param ftdi pointer to ftdi_context
595 \param vendor Vendor ID
596 \param product Product ID
598 \retval same as ftdi_usb_open_desc()
600 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
602 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
606 Opens the first device with a given, vendor id, product id,
607 description and serial.
609 \param ftdi pointer to ftdi_context
610 \param vendor Vendor ID
611 \param product Product ID
612 \param description Description to search for. Use NULL if not needed.
613 \param serial Serial to search for. Use NULL if not needed.
616 \retval -3: usb device not found
617 \retval -4: unable to open device
618 \retval -5: unable to claim device
619 \retval -6: reset failed
620 \retval -7: set baudrate failed
621 \retval -8: get product description failed
622 \retval -9: get serial number failed
623 \retval -12: libusb_get_device_list() failed
624 \retval -13: libusb_get_device_descriptor() failed
626 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
627 const char* description, const char* serial)
629 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
633 Opens the index-th device with a given, vendor id, product id,
634 description and serial.
636 \param ftdi pointer to ftdi_context
637 \param vendor Vendor ID
638 \param product Product ID
639 \param description Description to search for. Use NULL if not needed.
640 \param serial Serial to search for. Use NULL if not needed.
641 \param index Number of matching device to open if there are more than one, starts with 0.
644 \retval -1: usb_find_busses() failed
645 \retval -2: usb_find_devices() failed
646 \retval -3: usb device not found
647 \retval -4: unable to open device
648 \retval -5: unable to claim device
649 \retval -6: reset failed
650 \retval -7: set baudrate failed
651 \retval -8: get product description failed
652 \retval -9: get serial number failed
653 \retval -10: unable to close device
654 \retval -11: ftdi context invalid
656 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
657 const char* description, const char* serial, unsigned int index)
660 libusb_device **devs;
665 ftdi_error_return(-11, "ftdi context invalid");
667 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
668 ftdi_error_return(-12, "libusb_get_device_list() failed");
670 while ((dev = devs[i++]) != NULL)
672 struct libusb_device_descriptor desc;
675 if (libusb_get_device_descriptor(dev, &desc) < 0)
676 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
678 if (desc.idVendor == vendor && desc.idProduct == product)
680 if (libusb_open(dev, &ftdi->usb_dev) < 0)
681 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
683 if (description != NULL)
685 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
687 ftdi_usb_close_internal (ftdi);
688 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
690 if (strncmp(string, description, sizeof(string)) != 0)
692 ftdi_usb_close_internal (ftdi);
698 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
700 ftdi_usb_close_internal (ftdi);
701 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
703 if (strncmp(string, serial, sizeof(string)) != 0)
705 ftdi_usb_close_internal (ftdi);
710 ftdi_usb_close_internal (ftdi);
718 res = ftdi_usb_open_dev(ftdi, dev);
719 libusb_free_device_list(devs,1);
725 ftdi_error_return_free_device_list(-3, "device not found", devs);
729 Opens the ftdi-device described by a description-string.
730 Intended to be used for parsing a device-description given as commandline argument.
732 \param ftdi pointer to ftdi_context
733 \param description NULL-terminated description-string, using this format:
734 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
735 \li <tt>i:\<vendor>:\<product></tt> first device with given vendor and product id, ids can be decimal, octal (preceded by "0") or hex (preceded by "0x")
736 \li <tt>i:\<vendor>:\<product>:\<index></tt> as above with index being the number of the device (starting with 0) if there are more than one
737 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
739 \note The description format may be extended in later versions.
742 \retval -2: libusb_get_device_list() failed
743 \retval -3: usb device not found
744 \retval -4: unable to open device
745 \retval -5: unable to claim device
746 \retval -6: reset failed
747 \retval -7: set baudrate failed
748 \retval -8: get product description failed
749 \retval -9: get serial number failed
750 \retval -10: unable to close device
751 \retval -11: illegal description format
752 \retval -12: ftdi context invalid
754 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
757 ftdi_error_return(-12, "ftdi context invalid");
759 if (description[0] == 0 || description[1] != ':')
760 ftdi_error_return(-11, "illegal description format");
762 if (description[0] == 'd')
765 libusb_device **devs;
766 unsigned int bus_number, device_address;
769 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
770 ftdi_error_return(-2, "libusb_get_device_list() failed");
772 /* XXX: This doesn't handle symlinks/odd paths/etc... */
773 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
774 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
776 while ((dev = devs[i++]) != NULL)
779 if (bus_number == libusb_get_bus_number (dev)
780 && device_address == libusb_get_device_address (dev))
782 ret = ftdi_usb_open_dev(ftdi, dev);
783 libusb_free_device_list(devs,1);
789 ftdi_error_return_free_device_list(-3, "device not found", devs);
791 else if (description[0] == 'i' || description[0] == 's')
794 unsigned int product;
795 unsigned int index=0;
796 const char *serial=NULL;
797 const char *startp, *endp;
800 startp=description+2;
801 vendor=strtoul((char*)startp,(char**)&endp,0);
802 if (*endp != ':' || endp == startp || errno != 0)
803 ftdi_error_return(-11, "illegal description format");
806 product=strtoul((char*)startp,(char**)&endp,0);
807 if (endp == startp || errno != 0)
808 ftdi_error_return(-11, "illegal description format");
810 if (description[0] == 'i' && *endp != 0)
812 /* optional index field in i-mode */
814 ftdi_error_return(-11, "illegal description format");
817 index=strtoul((char*)startp,(char**)&endp,0);
818 if (*endp != 0 || endp == startp || errno != 0)
819 ftdi_error_return(-11, "illegal description format");
821 if (description[0] == 's')
824 ftdi_error_return(-11, "illegal description format");
826 /* rest of the description is the serial */
830 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
834 ftdi_error_return(-11, "illegal description format");
839 Resets the ftdi device.
841 \param ftdi pointer to ftdi_context
844 \retval -1: FTDI reset failed
845 \retval -2: USB device unavailable
847 int ftdi_usb_reset(struct ftdi_context *ftdi)
849 if (ftdi == NULL || ftdi->usb_dev == NULL)
850 ftdi_error_return(-2, "USB device unavailable");
852 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
853 SIO_RESET_REQUEST, SIO_RESET_SIO,
854 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
855 ftdi_error_return(-1,"FTDI reset failed");
857 // Invalidate data in the readbuffer
858 ftdi->readbuffer_offset = 0;
859 ftdi->readbuffer_remaining = 0;
865 Clears the read buffer on the chip and the internal read buffer.
867 \param ftdi pointer to ftdi_context
870 \retval -1: read buffer purge failed
871 \retval -2: USB device unavailable
873 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
875 if (ftdi == NULL || ftdi->usb_dev == NULL)
876 ftdi_error_return(-2, "USB device unavailable");
878 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
879 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
880 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
881 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
883 // Invalidate data in the readbuffer
884 ftdi->readbuffer_offset = 0;
885 ftdi->readbuffer_remaining = 0;
891 Clears the write buffer on the chip.
893 \param ftdi pointer to ftdi_context
896 \retval -1: write buffer purge failed
897 \retval -2: USB device unavailable
899 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
901 if (ftdi == NULL || ftdi->usb_dev == NULL)
902 ftdi_error_return(-2, "USB device unavailable");
904 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
905 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
906 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
907 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
913 Clears the buffers on the chip and the internal read buffer.
915 \param ftdi pointer to ftdi_context
918 \retval -1: read buffer purge failed
919 \retval -2: write buffer purge failed
920 \retval -3: USB device unavailable
922 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
926 if (ftdi == NULL || ftdi->usb_dev == NULL)
927 ftdi_error_return(-3, "USB device unavailable");
929 result = ftdi_usb_purge_rx_buffer(ftdi);
933 result = ftdi_usb_purge_tx_buffer(ftdi);
943 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
945 \param ftdi pointer to ftdi_context
948 \retval -1: usb_release failed
949 \retval -3: ftdi context invalid
951 int ftdi_usb_close(struct ftdi_context *ftdi)
956 ftdi_error_return(-3, "ftdi context invalid");
958 if (ftdi->usb_dev != NULL)
959 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
962 ftdi_usb_close_internal (ftdi);
968 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
969 Function is only used internally
972 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
973 unsigned short *value, unsigned short *index)
975 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
976 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
977 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
978 int divisor, best_divisor, best_baud, best_baud_diff;
979 unsigned long encoded_divisor;
988 divisor = 24000000 / baudrate;
990 if (ftdi->type == TYPE_AM)
992 // Round down to supported fraction (AM only)
993 divisor -= am_adjust_dn[divisor & 7];
996 // Try this divisor and the one above it (because division rounds down)
1000 for (i = 0; i < 2; i++)
1002 int try_divisor = divisor + i;
1006 // Round up to supported divisor value
1007 if (try_divisor <= 8)
1009 // Round up to minimum supported divisor
1012 else if (ftdi->type != TYPE_AM && try_divisor < 12)
1014 // BM doesn't support divisors 9 through 11 inclusive
1017 else if (divisor < 16)
1019 // AM doesn't support divisors 9 through 15 inclusive
1024 if (ftdi->type == TYPE_AM)
1026 // Round up to supported fraction (AM only)
1027 try_divisor += am_adjust_up[try_divisor & 7];
1028 if (try_divisor > 0x1FFF8)
1030 // Round down to maximum supported divisor value (for AM)
1031 try_divisor = 0x1FFF8;
1036 if (try_divisor > 0x1FFFF)
1038 // Round down to maximum supported divisor value (for BM)
1039 try_divisor = 0x1FFFF;
1043 // Get estimated baud rate (to nearest integer)
1044 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1045 // Get absolute difference from requested baud rate
1046 if (baud_estimate < baudrate)
1048 baud_diff = baudrate - baud_estimate;
1052 baud_diff = baud_estimate - baudrate;
1054 if (i == 0 || baud_diff < best_baud_diff)
1056 // Closest to requested baud rate so far
1057 best_divisor = try_divisor;
1058 best_baud = baud_estimate;
1059 best_baud_diff = baud_diff;
1062 // Spot on! No point trying
1067 // Encode the best divisor value
1068 encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1069 // Deal with special cases for encoded value
1070 if (encoded_divisor == 1)
1072 encoded_divisor = 0; // 3000000 baud
1074 else if (encoded_divisor == 0x4001)
1076 encoded_divisor = 1; // 2000000 baud (BM only)
1078 // Split into "value" and "index" values
1079 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1080 if (ftdi->type == TYPE_2232C || ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
1082 *index = (unsigned short)(encoded_divisor >> 8);
1084 *index |= ftdi->index;
1087 *index = (unsigned short)(encoded_divisor >> 16);
1089 // Return the nearest baud rate
1094 * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test
1095 * Do not use, it's only for the unit test framework
1097 int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi,
1098 unsigned short *value, unsigned short *index)
1100 return ftdi_convert_baudrate(baudrate, ftdi, value, index);
1104 Sets the chip baud rate
1106 \param ftdi pointer to ftdi_context
1107 \param baudrate baud rate to set
1110 \retval -1: invalid baudrate
1111 \retval -2: setting baudrate failed
1112 \retval -3: USB device unavailable
1114 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1116 unsigned short value, index;
1117 int actual_baudrate;
1119 if (ftdi == NULL || ftdi->usb_dev == NULL)
1120 ftdi_error_return(-3, "USB device unavailable");
1122 if (ftdi->bitbang_enabled)
1124 baudrate = baudrate*4;
1127 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1128 if (actual_baudrate <= 0)
1129 ftdi_error_return (-1, "Silly baudrate <= 0.");
1131 // Check within tolerance (about 5%)
1132 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1133 || ((actual_baudrate < baudrate)
1134 ? (actual_baudrate * 21 < baudrate * 20)
1135 : (baudrate * 21 < actual_baudrate * 20)))
1136 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1138 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1139 SIO_SET_BAUDRATE_REQUEST, value,
1140 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1141 ftdi_error_return (-2, "Setting new baudrate failed");
1143 ftdi->baudrate = baudrate;
1148 Set (RS232) line characteristics.
1149 The break type can only be set via ftdi_set_line_property2()
1150 and defaults to "off".
1152 \param ftdi pointer to ftdi_context
1153 \param bits Number of bits
1154 \param sbit Number of stop bits
1155 \param parity Parity mode
1158 \retval -1: Setting line property failed
1160 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1161 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1163 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1167 Set (RS232) line characteristics
1169 \param ftdi pointer to ftdi_context
1170 \param bits Number of bits
1171 \param sbit Number of stop bits
1172 \param parity Parity mode
1173 \param break_type Break type
1176 \retval -1: Setting line property failed
1177 \retval -2: USB device unavailable
1179 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1180 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1181 enum ftdi_break_type break_type)
1183 unsigned short value = bits;
1185 if (ftdi == NULL || ftdi->usb_dev == NULL)
1186 ftdi_error_return(-2, "USB device unavailable");
1191 value |= (0x00 << 8);
1194 value |= (0x01 << 8);
1197 value |= (0x02 << 8);
1200 value |= (0x03 << 8);
1203 value |= (0x04 << 8);
1210 value |= (0x00 << 11);
1213 value |= (0x01 << 11);
1216 value |= (0x02 << 11);
1223 value |= (0x00 << 14);
1226 value |= (0x01 << 14);
1230 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1231 SIO_SET_DATA_REQUEST, value,
1232 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1233 ftdi_error_return (-1, "Setting new line property failed");
1239 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1241 \param ftdi pointer to ftdi_context
1242 \param buf Buffer with the data
1243 \param size Size of the buffer
1245 \retval -666: USB device unavailable
1246 \retval <0: error code from usb_bulk_write()
1247 \retval >0: number of bytes written
1249 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1254 if (ftdi == NULL || ftdi->usb_dev == NULL)
1255 ftdi_error_return(-666, "USB device unavailable");
1257 while (offset < size)
1259 int write_size = ftdi->writebuffer_chunksize;
1261 if (offset+write_size > size)
1262 write_size = size-offset;
1264 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1265 ftdi_error_return(-1, "usb bulk write failed");
1267 offset += actual_length;
1273 static void ftdi_read_data_cb(struct libusb_transfer *transfer)
1275 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1276 struct ftdi_context *ftdi = tc->ftdi;
1277 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1279 packet_size = ftdi->max_packet_size;
1281 actual_length = transfer->actual_length;
1283 if (actual_length > 2)
1285 // skip FTDI status bytes.
1286 // Maybe stored in the future to enable modem use
1287 num_of_chunks = actual_length / packet_size;
1288 chunk_remains = actual_length % packet_size;
1289 //printf("actual_length = %X, num_of_chunks = %X, chunk_remains = %X, readbuffer_offset = %X\n", actual_length, num_of_chunks, chunk_remains, ftdi->readbuffer_offset);
1291 ftdi->readbuffer_offset += 2;
1294 if (actual_length > packet_size - 2)
1296 for (i = 1; i < num_of_chunks; i++)
1297 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1298 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1300 if (chunk_remains > 2)
1302 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1303 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1305 actual_length -= 2*num_of_chunks;
1308 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1311 if (actual_length > 0)
1313 // data still fits in buf?
1314 if (tc->offset + actual_length <= tc->size)
1316 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1317 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1318 tc->offset += actual_length;
1320 ftdi->readbuffer_offset = 0;
1321 ftdi->readbuffer_remaining = 0;
1323 /* Did we read exactly the right amount of bytes? */
1324 if (tc->offset == tc->size)
1326 //printf("read_data exact rem %d offset %d\n",
1327 //ftdi->readbuffer_remaining, offset);
1334 // only copy part of the data or size <= readbuffer_chunksize
1335 int part_size = tc->size - tc->offset;
1336 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1337 tc->offset += part_size;
1339 ftdi->readbuffer_offset += part_size;
1340 ftdi->readbuffer_remaining = actual_length - part_size;
1342 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1343 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1349 ret = libusb_submit_transfer (transfer);
1355 static void ftdi_write_data_cb(struct libusb_transfer *transfer)
1357 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1358 struct ftdi_context *ftdi = tc->ftdi;
1360 tc->offset += transfer->actual_length;
1362 if (tc->offset == tc->size)
1368 int write_size = ftdi->writebuffer_chunksize;
1371 if (tc->offset + write_size > tc->size)
1372 write_size = tc->size - tc->offset;
1374 transfer->length = write_size;
1375 transfer->buffer = tc->buf + tc->offset;
1376 ret = libusb_submit_transfer (transfer);
1384 Writes data to the chip. Does not wait for completion of the transfer
1385 nor does it make sure that the transfer was successful.
1387 Use libusb 1.0 asynchronous API.
1389 \param ftdi pointer to ftdi_context
1390 \param buf Buffer with the data
1391 \param size Size of the buffer
1393 \retval NULL: Some error happens when submit transfer
1394 \retval !NULL: Pointer to a ftdi_transfer_control
1397 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1399 struct ftdi_transfer_control *tc;
1400 struct libusb_transfer *transfer;
1401 int write_size, ret;
1403 if (ftdi == NULL || ftdi->usb_dev == NULL)
1406 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1410 transfer = libusb_alloc_transfer(0);
1423 if (size < ftdi->writebuffer_chunksize)
1426 write_size = ftdi->writebuffer_chunksize;
1428 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1429 write_size, ftdi_write_data_cb, tc,
1430 ftdi->usb_write_timeout);
1431 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1433 ret = libusb_submit_transfer(transfer);
1436 libusb_free_transfer(transfer);
1440 tc->transfer = transfer;
1446 Reads data from the chip. Does not wait for completion of the transfer
1447 nor does it make sure that the transfer was successful.
1449 Use libusb 1.0 asynchronous API.
1451 \param ftdi pointer to ftdi_context
1452 \param buf Buffer with the data
1453 \param size Size of the buffer
1455 \retval NULL: Some error happens when submit transfer
1456 \retval !NULL: Pointer to a ftdi_transfer_control
1459 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1461 struct ftdi_transfer_control *tc;
1462 struct libusb_transfer *transfer;
1465 if (ftdi == NULL || ftdi->usb_dev == NULL)
1468 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1476 if (size <= ftdi->readbuffer_remaining)
1478 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1481 ftdi->readbuffer_remaining -= size;
1482 ftdi->readbuffer_offset += size;
1484 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1488 tc->transfer = NULL;
1493 if (ftdi->readbuffer_remaining != 0)
1495 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1497 tc->offset = ftdi->readbuffer_remaining;
1502 transfer = libusb_alloc_transfer(0);
1509 ftdi->readbuffer_remaining = 0;
1510 ftdi->readbuffer_offset = 0;
1512 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, ftdi_read_data_cb, tc, ftdi->usb_read_timeout);
1513 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1515 ret = libusb_submit_transfer(transfer);
1518 libusb_free_transfer(transfer);
1522 tc->transfer = transfer;
1528 Wait for completion of the transfer.
1530 Use libusb 1.0 asynchronous API.
1532 \param tc pointer to ftdi_transfer_control
1534 \retval < 0: Some error happens
1535 \retval >= 0: Data size transferred
1538 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1542 while (!tc->completed)
1544 ret = libusb_handle_events(tc->ftdi->usb_ctx);
1547 if (ret == LIBUSB_ERROR_INTERRUPTED)
1549 libusb_cancel_transfer(tc->transfer);
1550 while (!tc->completed)
1551 if (libusb_handle_events(tc->ftdi->usb_ctx) < 0)
1553 libusb_free_transfer(tc->transfer);
1561 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
1562 * at ftdi_read_data_submit(). Therefore, we need to check it here.
1566 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1568 libusb_free_transfer(tc->transfer);
1575 Configure write buffer chunk size.
1578 \param ftdi pointer to ftdi_context
1579 \param chunksize Chunk size
1582 \retval -1: ftdi context invalid
1584 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1587 ftdi_error_return(-1, "ftdi context invalid");
1589 ftdi->writebuffer_chunksize = chunksize;
1594 Get write buffer chunk size.
1596 \param ftdi pointer to ftdi_context
1597 \param chunksize Pointer to store chunk size in
1600 \retval -1: ftdi context invalid
1602 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1605 ftdi_error_return(-1, "ftdi context invalid");
1607 *chunksize = ftdi->writebuffer_chunksize;
1612 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1614 Automatically strips the two modem status bytes transfered during every read.
1616 \param ftdi pointer to ftdi_context
1617 \param buf Buffer to store data in
1618 \param size Size of the buffer
1620 \retval -666: USB device unavailable
1621 \retval <0: error code from libusb_bulk_transfer()
1622 \retval 0: no data was available
1623 \retval >0: number of bytes read
1626 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1628 int offset = 0, ret, i, num_of_chunks, chunk_remains;
1629 int packet_size = ftdi->max_packet_size;
1630 int actual_length = 1;
1632 if (ftdi == NULL || ftdi->usb_dev == NULL)
1633 ftdi_error_return(-666, "USB device unavailable");
1635 // Packet size sanity check (avoid division by zero)
1636 if (packet_size == 0)
1637 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
1639 // everything we want is still in the readbuffer?
1640 if (size <= ftdi->readbuffer_remaining)
1642 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1645 ftdi->readbuffer_remaining -= size;
1646 ftdi->readbuffer_offset += size;
1648 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1652 // something still in the readbuffer, but not enough to satisfy 'size'?
1653 if (ftdi->readbuffer_remaining != 0)
1655 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1658 offset += ftdi->readbuffer_remaining;
1660 // do the actual USB read
1661 while (offset < size && actual_length > 0)
1663 ftdi->readbuffer_remaining = 0;
1664 ftdi->readbuffer_offset = 0;
1665 /* returns how much received */
1666 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
1668 ftdi_error_return(ret, "usb bulk read failed");
1670 if (actual_length > 2)
1672 // skip FTDI status bytes.
1673 // Maybe stored in the future to enable modem use
1674 num_of_chunks = actual_length / packet_size;
1675 chunk_remains = actual_length % packet_size;
1676 //printf("actual_length = %X, num_of_chunks = %X, chunk_remains = %X, readbuffer_offset = %X\n", actual_length, num_of_chunks, chunk_remains, ftdi->readbuffer_offset);
1678 ftdi->readbuffer_offset += 2;
1681 if (actual_length > packet_size - 2)
1683 for (i = 1; i < num_of_chunks; i++)
1684 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1685 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1687 if (chunk_remains > 2)
1689 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1690 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1692 actual_length -= 2*num_of_chunks;
1695 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1698 else if (actual_length <= 2)
1700 // no more data to read?
1703 if (actual_length > 0)
1705 // data still fits in buf?
1706 if (offset+actual_length <= size)
1708 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
1709 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1710 offset += actual_length;
1712 /* Did we read exactly the right amount of bytes? */
1714 //printf("read_data exact rem %d offset %d\n",
1715 //ftdi->readbuffer_remaining, offset);
1720 // only copy part of the data or size <= readbuffer_chunksize
1721 int part_size = size-offset;
1722 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
1724 ftdi->readbuffer_offset += part_size;
1725 ftdi->readbuffer_remaining = actual_length-part_size;
1726 offset += part_size;
1728 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1729 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1740 Configure read buffer chunk size.
1743 Automatically reallocates the buffer.
1745 \param ftdi pointer to ftdi_context
1746 \param chunksize Chunk size
1749 \retval -1: ftdi context invalid
1751 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1753 unsigned char *new_buf;
1756 ftdi_error_return(-1, "ftdi context invalid");
1758 // Invalidate all remaining data
1759 ftdi->readbuffer_offset = 0;
1760 ftdi->readbuffer_remaining = 0;
1762 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
1763 which is defined in libusb-1.0. Otherwise, each USB read request will
1764 be divided into multiple URBs. This will cause issues on Linux kernel
1765 older than 2.6.32. */
1766 if (chunksize > 16384)
1770 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
1771 ftdi_error_return(-1, "out of memory for readbuffer");
1773 ftdi->readbuffer = new_buf;
1774 ftdi->readbuffer_chunksize = chunksize;
1780 Get read buffer chunk size.
1782 \param ftdi pointer to ftdi_context
1783 \param chunksize Pointer to store chunk size in
1786 \retval -1: FTDI context invalid
1788 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1791 ftdi_error_return(-1, "FTDI context invalid");
1793 *chunksize = ftdi->readbuffer_chunksize;
1799 Enable bitbang mode.
1801 \deprecated use \ref ftdi_set_bitmode with mode BITMODE_BITBANG instead
1803 \param ftdi pointer to ftdi_context
1804 \param bitmask Bitmask to configure lines.
1805 HIGH/ON value configures a line as output.
1808 \retval -1: can't enable bitbang mode
1809 \retval -2: USB device unavailable
1811 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
1813 unsigned short usb_val;
1815 if (ftdi == NULL || ftdi->usb_dev == NULL)
1816 ftdi_error_return(-2, "USB device unavailable");
1818 usb_val = bitmask; // low byte: bitmask
1819 /* FT2232C: Set bitbang_mode to 2 to enable SPI */
1820 usb_val |= (ftdi->bitbang_mode << 8);
1822 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1823 SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index,
1824 NULL, 0, ftdi->usb_write_timeout) < 0)
1825 ftdi_error_return(-1, "unable to enter bitbang mode. Perhaps not a BM type chip?");
1827 ftdi->bitbang_enabled = 1;
1832 Disable bitbang mode.
1834 \param ftdi pointer to ftdi_context
1837 \retval -1: can't disable bitbang mode
1838 \retval -2: USB device unavailable
1840 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
1842 if (ftdi == NULL || ftdi->usb_dev == NULL)
1843 ftdi_error_return(-2, "USB device unavailable");
1845 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_BITMODE_REQUEST, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1846 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
1848 ftdi->bitbang_enabled = 0;
1853 Enable/disable bitbang modes.
1855 \param ftdi pointer to ftdi_context
1856 \param bitmask Bitmask to configure lines.
1857 HIGH/ON value configures a line as output.
1858 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
1861 \retval -1: can't enable bitbang mode
1862 \retval -2: USB device unavailable
1864 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
1866 unsigned short usb_val;
1868 if (ftdi == NULL || ftdi->usb_dev == NULL)
1869 ftdi_error_return(-2, "USB device unavailable");
1871 usb_val = bitmask; // low byte: bitmask
1872 usb_val |= (mode << 8);
1873 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1874 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?");
1876 ftdi->bitbang_mode = mode;
1877 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
1882 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
1884 \param ftdi pointer to ftdi_context
1885 \param pins Pointer to store pins into
1888 \retval -1: read pins failed
1889 \retval -2: USB device unavailable
1891 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
1893 if (ftdi == NULL || ftdi->usb_dev == NULL)
1894 ftdi_error_return(-2, "USB device unavailable");
1896 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_PINS_REQUEST, 0, ftdi->index, (unsigned char *)pins, 1, ftdi->usb_read_timeout) != 1)
1897 ftdi_error_return(-1, "read pins failed");
1905 The FTDI chip keeps data in the internal buffer for a specific
1906 amount of time if the buffer is not full yet to decrease
1907 load on the usb bus.
1909 \param ftdi pointer to ftdi_context
1910 \param latency Value between 1 and 255
1913 \retval -1: latency out of range
1914 \retval -2: unable to set latency timer
1915 \retval -3: USB device unavailable
1917 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
1919 unsigned short usb_val;
1922 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
1924 if (ftdi == NULL || ftdi->usb_dev == NULL)
1925 ftdi_error_return(-3, "USB device unavailable");
1928 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_LATENCY_TIMER_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1929 ftdi_error_return(-2, "unable to set latency timer");
1937 \param ftdi pointer to ftdi_context
1938 \param latency Pointer to store latency value in
1941 \retval -1: unable to get latency timer
1942 \retval -2: USB device unavailable
1944 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
1946 unsigned short usb_val;
1948 if (ftdi == NULL || ftdi->usb_dev == NULL)
1949 ftdi_error_return(-2, "USB device unavailable");
1951 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_GET_LATENCY_TIMER_REQUEST, 0, ftdi->index, (unsigned char *)&usb_val, 1, ftdi->usb_read_timeout) != 1)
1952 ftdi_error_return(-1, "reading latency timer failed");
1954 *latency = (unsigned char)usb_val;
1959 Poll modem status information
1961 This function allows the retrieve the two status bytes of the device.
1962 The device sends these bytes also as a header for each read access
1963 where they are discarded by ftdi_read_data(). The chip generates
1964 the two stripped status bytes in the absence of data every 40 ms.
1966 Layout of the first byte:
1967 - B0..B3 - must be 0
1968 - B4 Clear to send (CTS)
1971 - B5 Data set ready (DTS)
1974 - B6 Ring indicator (RI)
1977 - B7 Receive line signal detect (RLSD)
1981 Layout of the second byte:
1982 - B0 Data ready (DR)
1983 - B1 Overrun error (OE)
1984 - B2 Parity error (PE)
1985 - B3 Framing error (FE)
1986 - B4 Break interrupt (BI)
1987 - B5 Transmitter holding register (THRE)
1988 - B6 Transmitter empty (TEMT)
1989 - B7 Error in RCVR FIFO
1991 \param ftdi pointer to ftdi_context
1992 \param status Pointer to store status information in. Must be two bytes.
1995 \retval -1: unable to retrieve status information
1996 \retval -2: USB device unavailable
1998 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
2002 if (ftdi == NULL || ftdi->usb_dev == NULL)
2003 ftdi_error_return(-2, "USB device unavailable");
2005 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_POLL_MODEM_STATUS_REQUEST, 0, ftdi->index, (unsigned char *)usb_val, 2, ftdi->usb_read_timeout) != 2)
2006 ftdi_error_return(-1, "getting modem status failed");
2008 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
2014 Set flowcontrol for ftdi chip
2016 \param ftdi pointer to ftdi_context
2017 \param flowctrl flow control to use. should be
2018 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS
2021 \retval -1: set flow control failed
2022 \retval -2: USB device unavailable
2024 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2026 if (ftdi == NULL || ftdi->usb_dev == NULL)
2027 ftdi_error_return(-2, "USB device unavailable");
2029 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2030 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2031 NULL, 0, ftdi->usb_write_timeout) < 0)
2032 ftdi_error_return(-1, "set flow control failed");
2040 \param ftdi pointer to ftdi_context
2041 \param state state to set line to (1 or 0)
2044 \retval -1: set dtr failed
2045 \retval -2: USB device unavailable
2047 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2049 unsigned short usb_val;
2051 if (ftdi == NULL || ftdi->usb_dev == NULL)
2052 ftdi_error_return(-2, "USB device unavailable");
2055 usb_val = SIO_SET_DTR_HIGH;
2057 usb_val = SIO_SET_DTR_LOW;
2059 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2060 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2061 NULL, 0, ftdi->usb_write_timeout) < 0)
2062 ftdi_error_return(-1, "set dtr failed");
2070 \param ftdi pointer to ftdi_context
2071 \param state state to set line to (1 or 0)
2074 \retval -1: set rts failed
2075 \retval -2: USB device unavailable
2077 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2079 unsigned short usb_val;
2081 if (ftdi == NULL || ftdi->usb_dev == NULL)
2082 ftdi_error_return(-2, "USB device unavailable");
2085 usb_val = SIO_SET_RTS_HIGH;
2087 usb_val = SIO_SET_RTS_LOW;
2089 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2090 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2091 NULL, 0, ftdi->usb_write_timeout) < 0)
2092 ftdi_error_return(-1, "set of rts failed");
2098 Set dtr and rts line in one pass
2100 \param ftdi pointer to ftdi_context
2101 \param dtr DTR state to set line to (1 or 0)
2102 \param rts RTS state to set line to (1 or 0)
2105 \retval -1: set dtr/rts failed
2106 \retval -2: USB device unavailable
2108 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2110 unsigned short usb_val;
2112 if (ftdi == NULL || ftdi->usb_dev == NULL)
2113 ftdi_error_return(-2, "USB device unavailable");
2116 usb_val = SIO_SET_DTR_HIGH;
2118 usb_val = SIO_SET_DTR_LOW;
2121 usb_val |= SIO_SET_RTS_HIGH;
2123 usb_val |= SIO_SET_RTS_LOW;
2125 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2126 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2127 NULL, 0, ftdi->usb_write_timeout) < 0)
2128 ftdi_error_return(-1, "set of rts/dtr failed");
2134 Set the special event character
2136 \param ftdi pointer to ftdi_context
2137 \param eventch Event character
2138 \param enable 0 to disable the event character, non-zero otherwise
2141 \retval -1: unable to set event character
2142 \retval -2: USB device unavailable
2144 int ftdi_set_event_char(struct ftdi_context *ftdi,
2145 unsigned char eventch, unsigned char enable)
2147 unsigned short usb_val;
2149 if (ftdi == NULL || ftdi->usb_dev == NULL)
2150 ftdi_error_return(-2, "USB device unavailable");
2156 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_EVENT_CHAR_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
2157 ftdi_error_return(-1, "setting event character failed");
2165 \param ftdi pointer to ftdi_context
2166 \param errorch Error character
2167 \param enable 0 to disable the error character, non-zero otherwise
2170 \retval -1: unable to set error character
2171 \retval -2: USB device unavailable
2173 int ftdi_set_error_char(struct ftdi_context *ftdi,
2174 unsigned char errorch, unsigned char enable)
2176 unsigned short usb_val;
2178 if (ftdi == NULL || ftdi->usb_dev == NULL)
2179 ftdi_error_return(-2, "USB device unavailable");
2185 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_ERROR_CHAR_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
2186 ftdi_error_return(-1, "setting error character failed");
2192 Init eeprom with default values for the connected device
2193 \param ftdi pointer to ftdi_context
2194 \param manufacturer String to use as Manufacturer
2195 \param product String to use as Product description
2196 \param serial String to use as Serial number description
2199 \retval -1: No struct ftdi_context
2200 \retval -2: No struct ftdi_eeprom
2201 \retval -3: No connected device or device not yet opened
2203 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
2204 char * product, char * serial)
2206 struct ftdi_eeprom *eeprom;
2209 ftdi_error_return(-1, "No struct ftdi_context");
2211 if (ftdi->eeprom == NULL)
2212 ftdi_error_return(-2,"No struct ftdi_eeprom");
2214 eeprom = ftdi->eeprom;
2215 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2217 if (ftdi->usb_dev == NULL)
2218 ftdi_error_return(-3, "No connected device or device not yet opened");
2220 eeprom->vendor_id = 0x0403;
2221 eeprom->use_serial = 1;
2222 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2223 (ftdi->type == TYPE_R))
2224 eeprom->product_id = 0x6001;
2225 else if (ftdi->type == TYPE_4232H)
2226 eeprom->product_id = 0x6011;
2227 else if (ftdi->type == TYPE_232H)
2228 eeprom->product_id = 0x6014;
2230 eeprom->product_id = 0x6010;
2231 if (ftdi->type == TYPE_AM)
2232 eeprom->usb_version = 0x0101;
2234 eeprom->usb_version = 0x0200;
2235 eeprom->max_power = 100;
2237 if (eeprom->manufacturer)
2238 free (eeprom->manufacturer);
2239 eeprom->manufacturer = NULL;
2242 eeprom->manufacturer = malloc(strlen(manufacturer)+1);
2243 if (eeprom->manufacturer)
2244 strcpy(eeprom->manufacturer, manufacturer);
2247 if (eeprom->product)
2248 free (eeprom->product);
2249 eeprom->product = NULL;
2252 eeprom->product = malloc(strlen(product)+1);
2253 if (eeprom->product)
2254 strcpy(eeprom->product, product);
2258 const char* default_product;
2261 case TYPE_AM: default_product = "AM"; break;
2262 case TYPE_BM: default_product = "BM"; break;
2263 case TYPE_2232C: default_product = "Dual RS232"; break;
2264 case TYPE_R: default_product = "FT232R USB UART"; break;
2265 case TYPE_2232H: default_product = "Dual RS232-HS"; break;
2266 case TYPE_4232H: default_product = "FT4232H"; break;
2267 case TYPE_232H: default_product = "Single-RS232-HS"; break;
2269 ftdi_error_return(-3, "Unknown chip type");
2271 eeprom->product = malloc(strlen(default_product) +1);
2272 if (eeprom->product)
2273 strcpy(eeprom->product, default_product);
2277 free (eeprom->serial);
2278 eeprom->serial = NULL;
2281 eeprom->serial = malloc(strlen(serial)+1);
2283 strcpy(eeprom->serial, serial);
2287 if (ftdi->type == TYPE_R)
2289 eeprom->max_power = 90;
2290 eeprom->size = 0x80;
2291 eeprom->cbus_function[0] = CBUS_TXLED;
2292 eeprom->cbus_function[1] = CBUS_RXLED;
2293 eeprom->cbus_function[2] = CBUS_TXDEN;
2294 eeprom->cbus_function[3] = CBUS_PWREN;
2295 eeprom->cbus_function[4] = CBUS_SLEEP;
2299 if(ftdi->type == TYPE_232H)
2302 for (i=0; i<10; i++)
2303 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2307 eeprom->initialized_for_connected_device = 1;
2310 /*FTD2XX doesn't check for values not fitting in the ACBUS Signal oprtions*/
2311 void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2316 int mode_low, mode_high;
2317 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2318 mode_low = CBUSH_TRISTATE;
2320 mode_low = eeprom->cbus_function[2*i];
2321 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2322 mode_high = CBUSH_TRISTATE;
2324 mode_high = eeprom->cbus_function[2*i];
2326 output[0x18+i] = mode_high <<4 | mode_low;
2329 /* Return the bits for the encoded EEPROM Structure of a requested Mode
2332 static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2341 case CHANNEL_IS_UART: return 0;
2342 case CHANNEL_IS_FIFO: return 0x01;
2343 case CHANNEL_IS_OPTO: return 0x02;
2344 case CHANNEL_IS_CPU : return 0x04;
2352 case CHANNEL_IS_UART : return 0;
2353 case CHANNEL_IS_FIFO : return 0x01;
2354 case CHANNEL_IS_OPTO : return 0x02;
2355 case CHANNEL_IS_CPU : return 0x04;
2356 case CHANNEL_IS_FT1284 : return 0x08;
2366 Build binary buffer from ftdi_eeprom structure.
2367 Output is suitable for ftdi_write_eeprom().
2369 \param ftdi pointer to ftdi_context
2371 \retval >=0: size of eeprom user area in bytes
2372 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2373 \retval -2: Invalid eeprom or ftdi pointer
2374 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2375 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2376 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2377 \retval -6: No connected EEPROM or EEPROM Type unknown
2379 int ftdi_eeprom_build(struct ftdi_context *ftdi)
2381 unsigned char i, j, eeprom_size_mask;
2382 unsigned short checksum, value;
2383 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2385 struct ftdi_eeprom *eeprom;
2386 unsigned char * output;
2389 ftdi_error_return(-2,"No context");
2390 if (ftdi->eeprom == NULL)
2391 ftdi_error_return(-2,"No eeprom structure");
2393 eeprom= ftdi->eeprom;
2394 output = eeprom->buf;
2396 if (eeprom->chip == -1)
2397 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2399 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2400 eeprom->size = 0x100;
2402 eeprom->size = 0x80;
2404 if (eeprom->manufacturer != NULL)
2405 manufacturer_size = strlen(eeprom->manufacturer);
2406 if (eeprom->product != NULL)
2407 product_size = strlen(eeprom->product);
2408 if (eeprom->serial != NULL)
2409 serial_size = strlen(eeprom->serial);
2411 // eeprom size check
2416 user_area_size = 96; // base size for strings (total of 48 characters)
2419 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2422 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2424 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2426 user_area_size = 86;
2429 user_area_size = 80;
2435 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
2437 if (user_area_size < 0)
2438 ftdi_error_return(-1,"eeprom size exceeded");
2441 memset (ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2443 // Bytes and Bits set for all Types
2445 // Addr 02: Vendor ID
2446 output[0x02] = eeprom->vendor_id;
2447 output[0x03] = eeprom->vendor_id >> 8;
2449 // Addr 04: Product ID
2450 output[0x04] = eeprom->product_id;
2451 output[0x05] = eeprom->product_id >> 8;
2453 // Addr 06: Device release number (0400h for BM features)
2454 output[0x06] = 0x00;
2458 output[0x07] = 0x02;
2461 output[0x07] = 0x04;
2464 output[0x07] = 0x05;
2467 output[0x07] = 0x06;
2470 output[0x07] = 0x07;
2473 output[0x07] = 0x08;
2476 output[0x07] = 0x09;
2479 output[0x07] = 0x00;
2482 // Addr 08: Config descriptor
2484 // Bit 6: 1 if this device is self powered, 0 if bus powered
2485 // Bit 5: 1 if this device uses remote wakeup
2486 // Bit 4-0: reserved - 0
2488 if (eeprom->self_powered == 1)
2490 if (eeprom->remote_wakeup == 1)
2494 // Addr 09: Max power consumption: max power = value * 2 mA
2495 output[0x09] = eeprom->max_power>>1;
2497 if (ftdi->type != TYPE_AM)
2499 // Addr 0A: Chip configuration
2500 // Bit 7: 0 - reserved
2501 // Bit 6: 0 - reserved
2502 // Bit 5: 0 - reserved
2503 // Bit 4: 1 - Change USB version
2504 // Bit 3: 1 - Use the serial number string
2505 // Bit 2: 1 - Enable suspend pull downs for lower power
2506 // Bit 1: 1 - Out EndPoint is Isochronous
2507 // Bit 0: 1 - In EndPoint is Isochronous
2510 if (eeprom->in_is_isochronous == 1)
2512 if (eeprom->out_is_isochronous == 1)
2518 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
2519 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
2537 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
2538 eeprom_size_mask = eeprom->size -1;
2540 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2541 // Addr 0F: Length of manufacturer string
2542 // Output manufacturer
2543 output[0x0E] = i; // calculate offset
2544 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
2545 output[i & eeprom_size_mask] = 0x03, i++; // type: string
2546 for (j = 0; j < manufacturer_size; j++)
2548 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
2549 output[i & eeprom_size_mask] = 0x00, i++;
2551 output[0x0F] = manufacturer_size*2 + 2;
2553 // Addr 10: Offset of the product string + 0x80, calculated later
2554 // Addr 11: Length of product string
2555 output[0x10] = i | 0x80; // calculate offset
2556 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
2557 output[i & eeprom_size_mask] = 0x03, i++;
2558 for (j = 0; j < product_size; j++)
2560 output[i & eeprom_size_mask] = eeprom->product[j], i++;
2561 output[i & eeprom_size_mask] = 0x00, i++;
2563 output[0x11] = product_size*2 + 2;
2565 // Addr 12: Offset of the serial string + 0x80, calculated later
2566 // Addr 13: Length of serial string
2567 output[0x12] = i | 0x80; // calculate offset
2568 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
2569 output[i & eeprom_size_mask] = 0x03, i++;
2570 for (j = 0; j < serial_size; j++)
2572 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
2573 output[i & eeprom_size_mask] = 0x00, i++;
2576 // Legacy port name and PnP fields for FT2232 and newer chips
2577 if (ftdi->type > TYPE_BM)
2579 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
2581 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
2583 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
2587 output[0x13] = serial_size*2 + 2;
2589 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
2591 if (eeprom->use_serial)
2592 output[0x0A] |= USE_SERIAL_NUM;
2594 output[0x0A] &= ~USE_SERIAL_NUM;
2597 /* Bytes and Bits specific to (some) types
2598 Write linear, as this allows easier fixing*/
2604 output[0x0C] = eeprom->usb_version & 0xff;
2605 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2606 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2607 output[0x0A] |= USE_USB_VERSION_BIT;
2609 output[0x0A] &= ~USE_USB_VERSION_BIT;
2614 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
2615 if ( eeprom->channel_a_driver == DRIVER_VCP)
2616 output[0x00] |= DRIVER_VCP;
2618 output[0x00] &= ~DRIVER_VCP;
2620 if ( eeprom->high_current_a == HIGH_CURRENT_DRIVE)
2621 output[0x00] |= HIGH_CURRENT_DRIVE;
2623 output[0x00] &= ~HIGH_CURRENT_DRIVE;
2625 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
2626 if ( eeprom->channel_b_driver == DRIVER_VCP)
2627 output[0x01] |= DRIVER_VCP;
2629 output[0x01] &= ~DRIVER_VCP;
2631 if ( eeprom->high_current_b == HIGH_CURRENT_DRIVE)
2632 output[0x01] |= HIGH_CURRENT_DRIVE;
2634 output[0x01] &= ~HIGH_CURRENT_DRIVE;
2636 if (eeprom->in_is_isochronous == 1)
2637 output[0x0A] |= 0x1;
2639 output[0x0A] &= ~0x1;
2640 if (eeprom->out_is_isochronous == 1)
2641 output[0x0A] |= 0x2;
2643 output[0x0A] &= ~0x2;
2644 if (eeprom->suspend_pull_downs == 1)
2645 output[0x0A] |= 0x4;
2647 output[0x0A] &= ~0x4;
2648 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2649 output[0x0A] |= USE_USB_VERSION_BIT;
2651 output[0x0A] &= ~USE_USB_VERSION_BIT;
2653 output[0x0C] = eeprom->usb_version & 0xff;
2654 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2655 output[0x14] = eeprom->chip;
2658 if (eeprom->high_current == HIGH_CURRENT_DRIVE_R)
2659 output[0x00] |= HIGH_CURRENT_DRIVE_R;
2660 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
2662 if (eeprom->suspend_pull_downs == 1)
2663 output[0x0A] |= 0x4;
2665 output[0x0A] &= ~0x4;
2666 output[0x0B] = eeprom->invert;
2667 output[0x0C] = eeprom->usb_version & 0xff;
2668 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2670 if (eeprom->cbus_function[0] > CBUS_BB)
2671 output[0x14] = CBUS_TXLED;
2673 output[0x14] = eeprom->cbus_function[0];
2675 if (eeprom->cbus_function[1] > CBUS_BB)
2676 output[0x14] |= CBUS_RXLED<<4;
2678 output[0x14] |= eeprom->cbus_function[1]<<4;
2680 if (eeprom->cbus_function[2] > CBUS_BB)
2681 output[0x15] = CBUS_TXDEN;
2683 output[0x15] = eeprom->cbus_function[2];
2685 if (eeprom->cbus_function[3] > CBUS_BB)
2686 output[0x15] |= CBUS_PWREN<<4;
2688 output[0x15] |= eeprom->cbus_function[3]<<4;
2690 if (eeprom->cbus_function[4] > CBUS_CLK6)
2691 output[0x16] = CBUS_SLEEP;
2693 output[0x16] = eeprom->cbus_function[4];
2696 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
2697 if ( eeprom->channel_a_driver == DRIVER_VCP)
2698 output[0x00] |= DRIVER_VCP;
2700 output[0x00] &= ~DRIVER_VCP;
2702 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
2703 if ( eeprom->channel_b_driver == DRIVER_VCP)
2704 output[0x01] |= DRIVER_VCP;
2706 output[0x01] &= ~DRIVER_VCP;
2707 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
2708 output[0x01] |= SUSPEND_DBUS7_BIT;
2710 output[0x01] &= ~SUSPEND_DBUS7_BIT;
2712 if (eeprom->suspend_pull_downs == 1)
2713 output[0x0A] |= 0x4;
2715 output[0x0A] &= ~0x4;
2717 if (eeprom->group0_drive > DRIVE_16MA)
2718 output[0x0c] |= DRIVE_16MA;
2720 output[0x0c] |= eeprom->group0_drive;
2721 if (eeprom->group0_schmitt == IS_SCHMITT)
2722 output[0x0c] |= IS_SCHMITT;
2723 if (eeprom->group0_slew == SLOW_SLEW)
2724 output[0x0c] |= SLOW_SLEW;
2726 if (eeprom->group1_drive > DRIVE_16MA)
2727 output[0x0c] |= DRIVE_16MA<<4;
2729 output[0x0c] |= eeprom->group1_drive<<4;
2730 if (eeprom->group1_schmitt == IS_SCHMITT)
2731 output[0x0c] |= IS_SCHMITT<<4;
2732 if (eeprom->group1_slew == SLOW_SLEW)
2733 output[0x0c] |= SLOW_SLEW<<4;
2735 if (eeprom->group2_drive > DRIVE_16MA)
2736 output[0x0d] |= DRIVE_16MA;
2738 output[0x0d] |= eeprom->group2_drive;
2739 if (eeprom->group2_schmitt == IS_SCHMITT)
2740 output[0x0d] |= IS_SCHMITT;
2741 if (eeprom->group2_slew == SLOW_SLEW)
2742 output[0x0d] |= SLOW_SLEW;
2744 if (eeprom->group3_drive > DRIVE_16MA)
2745 output[0x0d] |= DRIVE_16MA<<4;
2747 output[0x0d] |= eeprom->group3_drive<<4;
2748 if (eeprom->group3_schmitt == IS_SCHMITT)
2749 output[0x0d] |= IS_SCHMITT<<4;
2750 if (eeprom->group3_slew == SLOW_SLEW)
2751 output[0x0d] |= SLOW_SLEW<<4;
2753 output[0x18] = eeprom->chip;
2757 output[0x18] = eeprom->chip;
2758 fprintf(stderr,"FIXME: Build FT4232H specific EEPROM settings\n");
2761 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
2762 if ( eeprom->channel_a_driver == DRIVER_VCP)
2763 output[0x00] |= DRIVER_VCPH;
2765 output[0x00] &= ~DRIVER_VCPH;
2766 if (eeprom->powersave)
2767 output[0x01] |= POWER_SAVE_DISABLE_H;
2769 output[0x01] &= ~POWER_SAVE_DISABLE_H;
2770 if (eeprom->clock_polarity)
2771 output[0x01] |= FT1284_CLK_IDLE_STATE;
2773 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
2774 if (eeprom->data_order)
2775 output[0x01] |= FT1284_DATA_LSB;
2777 output[0x01] &= ~FT1284_DATA_LSB;
2778 if (eeprom->flow_control)
2779 output[0x01] |= FT1284_FLOW_CONTROL;
2781 output[0x01] &= ~FT1284_FLOW_CONTROL;
2782 if (eeprom->group0_drive > DRIVE_16MA)
2783 output[0x0c] |= DRIVE_16MA;
2785 output[0x0c] |= eeprom->group0_drive;
2786 if (eeprom->group0_schmitt == IS_SCHMITT)
2787 output[0x0c] |= IS_SCHMITT;
2788 if (eeprom->group0_slew == SLOW_SLEW)
2789 output[0x0c] |= SLOW_SLEW;
2791 if (eeprom->group1_drive > DRIVE_16MA)
2792 output[0x0d] |= DRIVE_16MA;
2794 output[0x0d] |= eeprom->group1_drive;
2795 if (eeprom->group1_schmitt == IS_SCHMITT)
2796 output[0x0d] |= IS_SCHMITT;
2797 if (eeprom->group1_slew == SLOW_SLEW)
2798 output[0x0d] |= SLOW_SLEW;
2800 set_ft232h_cbus(eeprom, output);
2802 output[0x1e] = eeprom->chip;
2803 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
2808 // calculate checksum
2811 for (i = 0; i < eeprom->size/2-1; i++)
2813 value = output[i*2];
2814 value += output[(i*2)+1] << 8;
2816 checksum = value^checksum;
2817 checksum = (checksum << 1) | (checksum >> 15);
2820 output[eeprom->size-2] = checksum;
2821 output[eeprom->size-1] = checksum >> 8;
2823 return user_area_size;
2825 /* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
2828 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
2830 static unsigned char bit2type(unsigned char bits)
2834 case 0: return CHANNEL_IS_UART;
2835 case 1: return CHANNEL_IS_FIFO;
2836 case 2: return CHANNEL_IS_OPTO;
2837 case 4: return CHANNEL_IS_CPU;
2838 case 8: return CHANNEL_IS_FT1284;
2840 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
2846 Decode binary EEPROM image into an ftdi_eeprom structure.
2848 \param ftdi pointer to ftdi_context
2849 \param verbose Decode EEPROM on stdout
2852 \retval -1: something went wrong
2854 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
2855 FIXME: Strings are malloc'ed here and should be freed somewhere
2857 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
2860 unsigned short checksum, eeprom_checksum, value;
2861 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2863 struct ftdi_eeprom *eeprom;
2864 unsigned char *buf = ftdi->eeprom->buf;
2868 ftdi_error_return(-1,"No context");
2869 if (ftdi->eeprom == NULL)
2870 ftdi_error_return(-1,"No eeprom structure");
2872 eeprom = ftdi->eeprom;
2873 eeprom_size = eeprom->size;
2875 // Addr 02: Vendor ID
2876 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
2878 // Addr 04: Product ID
2879 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
2881 release = buf[0x06] + (buf[0x07]<<8);
2883 // Addr 08: Config descriptor
2885 // Bit 6: 1 if this device is self powered, 0 if bus powered
2886 // Bit 5: 1 if this device uses remote wakeup
2887 eeprom->self_powered = buf[0x08] & 0x40;
2888 eeprom->remote_wakeup = buf[0x08] & 0x20;
2890 // Addr 09: Max power consumption: max power = value * 2 mA
2891 eeprom->max_power = buf[0x09];
2893 // Addr 0A: Chip configuration
2894 // Bit 7: 0 - reserved
2895 // Bit 6: 0 - reserved
2896 // Bit 5: 0 - reserved
2897 // Bit 4: 1 - Change USB version on BM and 2232C
2898 // Bit 3: 1 - Use the serial number string
2899 // Bit 2: 1 - Enable suspend pull downs for lower power
2900 // Bit 1: 1 - Out EndPoint is Isochronous
2901 // Bit 0: 1 - In EndPoint is Isochronous
2903 eeprom->in_is_isochronous = buf[0x0A]&0x01;
2904 eeprom->out_is_isochronous = buf[0x0A]&0x02;
2905 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
2906 eeprom->use_serial = (buf[0x0A] & USE_SERIAL_NUM)?1:0;
2907 eeprom->use_usb_version = buf[0x0A] & USE_USB_VERSION_BIT;
2909 // Addr 0C: USB version low byte when 0x0A
2910 // Addr 0D: USB version high byte when 0x0A
2911 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
2913 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2914 // Addr 0F: Length of manufacturer string
2915 manufacturer_size = buf[0x0F]/2;
2916 if (eeprom->manufacturer)
2917 free(eeprom->manufacturer);
2918 if (manufacturer_size > 0)
2920 eeprom->manufacturer = malloc(manufacturer_size);
2921 if (eeprom->manufacturer)
2923 // Decode manufacturer
2924 i = buf[0x0E] & (eeprom_size -1); // offset
2925 for (j=0;j<manufacturer_size-1;j++)
2927 eeprom->manufacturer[j] = buf[2*j+i+2];
2929 eeprom->manufacturer[j] = '\0';
2932 else eeprom->manufacturer = NULL;
2934 // Addr 10: Offset of the product string + 0x80, calculated later
2935 // Addr 11: Length of product string
2936 if (eeprom->product)
2937 free(eeprom->product);
2938 product_size = buf[0x11]/2;
2939 if (product_size > 0)
2941 eeprom->product = malloc(product_size);
2942 if (eeprom->product)
2944 // Decode product name
2945 i = buf[0x10] & (eeprom_size -1); // offset
2946 for (j=0;j<product_size-1;j++)
2948 eeprom->product[j] = buf[2*j+i+2];
2950 eeprom->product[j] = '\0';
2953 else eeprom->product = NULL;
2955 // Addr 12: Offset of the serial string + 0x80, calculated later
2956 // Addr 13: Length of serial string
2958 free(eeprom->serial);
2959 serial_size = buf[0x13]/2;
2960 if (serial_size > 0)
2962 eeprom->serial = malloc(serial_size);
2966 i = buf[0x12] & (eeprom_size -1); // offset
2967 for (j=0;j<serial_size-1;j++)
2969 eeprom->serial[j] = buf[2*j+i+2];
2971 eeprom->serial[j] = '\0';
2974 else eeprom->serial = NULL;
2979 for (i = 0; i < eeprom_size/2-1; i++)
2982 value += buf[(i*2)+1] << 8;
2984 checksum = value^checksum;
2985 checksum = (checksum << 1) | (checksum >> 15);
2988 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
2990 if (eeprom_checksum != checksum)
2992 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
2993 ftdi_error_return(-1,"EEPROM checksum error");
2996 eeprom->channel_a_type = 0;
2997 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
3001 else if (ftdi->type == TYPE_2232C)
3003 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3004 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3005 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
3006 eeprom->channel_b_type = buf[0x01] & 0x7;
3007 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3008 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
3009 eeprom->chip = buf[0x14];
3011 else if (ftdi->type == TYPE_R)
3013 /* TYPE_R flags D2XX, not VCP as all others*/
3014 eeprom->channel_a_driver = (~buf[0x00]) & DRIVER_VCP;
3015 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
3016 if ( (buf[0x01]&0x40) != 0x40)
3018 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
3019 " If this happened with the\n"
3020 " EEPROM programmed by FTDI tools, please report "
3021 "to libftdi@developer.intra2net.com\n");
3023 eeprom->chip = buf[0x16];
3024 // Addr 0B: Invert data lines
3025 // Works only on FT232R, not FT245R, but no way to distinguish
3026 eeprom->invert = buf[0x0B];
3027 // Addr 14: CBUS function: CBUS0, CBUS1
3028 // Addr 15: CBUS function: CBUS2, CBUS3
3029 // Addr 16: CBUS function: CBUS5
3030 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3031 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3032 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3033 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3034 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
3036 else if ((ftdi->type == TYPE_2232H) ||(ftdi->type == TYPE_4232H))
3038 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3039 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3040 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
3041 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3043 if (ftdi->type == TYPE_2232H)
3044 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
3046 eeprom->chip = buf[0x18];
3047 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3048 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3049 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3050 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3051 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3052 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3053 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3054 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3055 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3056 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3057 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3058 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
3060 else if (ftdi->type == TYPE_232H)
3064 eeprom->channel_a_type = buf[0x00] & 0xf;
3065 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
3066 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3067 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3068 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
3069 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
3070 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3071 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3072 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3073 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3074 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3075 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3079 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3080 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3082 eeprom->chip = buf[0x1e];
3083 /*FIXME: Decipher more values*/
3088 char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
3089 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3090 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
3091 fprintf(stdout, "Release: 0x%04x\n",release);
3093 if (eeprom->self_powered)
3094 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3096 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power * 2,
3097 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
3098 if (eeprom->manufacturer)
3099 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
3100 if (eeprom->product)
3101 fprintf(stdout, "Product: %s\n",eeprom->product);
3103 fprintf(stdout, "Serial: %s\n",eeprom->serial);
3104 fprintf(stdout, "Checksum : %04x\n", checksum);
3105 if (ftdi->type == TYPE_R)
3106 fprintf(stdout, "Internal EEPROM\n");
3107 else if (eeprom->chip >= 0x46)
3108 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
3109 if (eeprom->suspend_dbus7)
3110 fprintf(stdout, "Suspend on DBUS7\n");
3111 if (eeprom->suspend_pull_downs)
3112 fprintf(stdout, "Pull IO pins low during suspend\n");
3113 if(eeprom->powersave)
3115 if(ftdi->type >= TYPE_232H)
3116 fprintf(stdout,"Enter low power state on ACBUS7\n");
3118 if (eeprom->remote_wakeup)
3119 fprintf(stdout, "Enable Remote Wake Up\n");
3120 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
3121 if (ftdi->type >= TYPE_2232C)
3122 fprintf(stdout,"Channel A has Mode %s%s%s\n",
3123 channel_mode[eeprom->channel_a_type],
3124 (eeprom->channel_a_driver)?" VCP":"",
3125 (eeprom->high_current_a)?" High Current IO":"");
3126 if (ftdi->type >= TYPE_232H)
3128 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3129 (eeprom->clock_polarity)?"HIGH":"LOW",
3130 (eeprom->data_order)?"LSB":"MSB",
3131 (eeprom->flow_control)?"":"No ");
3133 if ((ftdi->type >= TYPE_2232C) && (ftdi->type != TYPE_R) && (ftdi->type != TYPE_232H))
3134 fprintf(stdout,"Channel B has Mode %s%s%s\n",
3135 channel_mode[eeprom->channel_b_type],
3136 (eeprom->channel_b_driver)?" VCP":"",
3137 (eeprom->high_current_b)?" High Current IO":"");
3138 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3139 eeprom->use_usb_version == USE_USB_VERSION_BIT)
3140 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3142 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3144 fprintf(stdout,"%s has %d mA drive%s%s\n",
3145 (ftdi->type == TYPE_2232H)?"AL":"A",
3146 (eeprom->group0_drive+1) *4,
3147 (eeprom->group0_schmitt)?" Schmitt Input":"",
3148 (eeprom->group0_slew)?" Slow Slew":"");
3149 fprintf(stdout,"%s has %d mA drive%s%s\n",
3150 (ftdi->type == TYPE_2232H)?"AH":"B",
3151 (eeprom->group1_drive+1) *4,
3152 (eeprom->group1_schmitt)?" Schmitt Input":"",
3153 (eeprom->group1_slew)?" Slow Slew":"");
3154 fprintf(stdout,"%s has %d mA drive%s%s\n",
3155 (ftdi->type == TYPE_2232H)?"BL":"C",
3156 (eeprom->group2_drive+1) *4,
3157 (eeprom->group2_schmitt)?" Schmitt Input":"",
3158 (eeprom->group2_slew)?" Slow Slew":"");
3159 fprintf(stdout,"%s has %d mA drive%s%s\n",
3160 (ftdi->type == TYPE_2232H)?"BH":"D",
3161 (eeprom->group3_drive+1) *4,
3162 (eeprom->group3_schmitt)?" Schmitt Input":"",
3163 (eeprom->group3_slew)?" Slow Slew":"");
3165 else if (ftdi->type == TYPE_232H)
3168 char *cbush_mux[] = {"TRISTATE","RXLED","TXLED", "TXRXLED","PWREN",
3169 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3170 "CLK30","CLK15","CLK7_5"
3172 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3173 (eeprom->group0_drive+1) *4,
3174 (eeprom->group0_schmitt)?" Schmitt Input":"",
3175 (eeprom->group0_slew)?" Slow Slew":"");
3176 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3177 (eeprom->group1_drive+1) *4,
3178 (eeprom->group1_schmitt)?" Schmitt Input":"",
3179 (eeprom->group1_slew)?" Slow Slew":"");
3180 for (i=0; i<10; i++)
3182 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3183 fprintf(stdout,"C%d Function: %s\n", i,
3184 cbush_mux[eeprom->cbus_function[i]]);
3189 if (ftdi->type == TYPE_R)
3191 char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
3192 "SLEEP","CLK48","CLK24","CLK12","CLK6",
3193 "IOMODE","BB_WR","BB_RD"
3195 char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
3199 char *r_bits[] = {"TXD","RXD","RTS", "CTS","DTR","DSR","DCD","RI"};
3200 fprintf(stdout,"Inverted bits:");
3202 if ((eeprom->invert & (1<<i)) == (1<<i))
3203 fprintf(stdout," %s",r_bits[i]);
3204 fprintf(stdout,"\n");
3208 if (eeprom->cbus_function[i]<CBUS_BB)
3209 fprintf(stdout,"C%d Function: %s\n", i,
3210 cbus_mux[eeprom->cbus_function[i]]);
3214 /* Running MPROG show that C0..3 have fixed function Synchronous
3216 fprintf(stdout,"C%d BB Function: %s\n", i,
3219 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
3228 Get a value from the decoded EEPROM structure
3230 \param ftdi pointer to ftdi_context
3231 \param value_name Enum of the value to query
3232 \param value Pointer to store read value
3235 \retval -1: Value doesn't exist
3237 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3242 *value = ftdi->eeprom->vendor_id;
3245 *value = ftdi->eeprom->product_id;
3248 *value = ftdi->eeprom->self_powered;
3251 *value = ftdi->eeprom->remote_wakeup;
3254 *value = ftdi->eeprom->is_not_pnp;
3257 *value = ftdi->eeprom->suspend_dbus7;
3259 case IN_IS_ISOCHRONOUS:
3260 *value = ftdi->eeprom->in_is_isochronous;
3262 case OUT_IS_ISOCHRONOUS:
3263 *value = ftdi->eeprom->out_is_isochronous;
3265 case SUSPEND_PULL_DOWNS:
3266 *value = ftdi->eeprom->suspend_pull_downs;
3269 *value = ftdi->eeprom->use_serial;
3272 *value = ftdi->eeprom->usb_version;
3274 case USE_USB_VERSION:
3275 *value = ftdi->eeprom->use_usb_version;
3278 *value = ftdi->eeprom->max_power;
3280 case CHANNEL_A_TYPE:
3281 *value = ftdi->eeprom->channel_a_type;
3283 case CHANNEL_B_TYPE:
3284 *value = ftdi->eeprom->channel_b_type;
3286 case CHANNEL_A_DRIVER:
3287 *value = ftdi->eeprom->channel_a_driver;
3289 case CHANNEL_B_DRIVER:
3290 *value = ftdi->eeprom->channel_b_driver;
3292 case CBUS_FUNCTION_0:
3293 *value = ftdi->eeprom->cbus_function[0];
3295 case CBUS_FUNCTION_1:
3296 *value = ftdi->eeprom->cbus_function[1];
3298 case CBUS_FUNCTION_2:
3299 *value = ftdi->eeprom->cbus_function[2];
3301 case CBUS_FUNCTION_3:
3302 *value = ftdi->eeprom->cbus_function[3];
3304 case CBUS_FUNCTION_4:
3305 *value = ftdi->eeprom->cbus_function[4];
3307 case CBUS_FUNCTION_5:
3308 *value = ftdi->eeprom->cbus_function[5];
3310 case CBUS_FUNCTION_6:
3311 *value = ftdi->eeprom->cbus_function[6];
3313 case CBUS_FUNCTION_7:
3314 *value = ftdi->eeprom->cbus_function[7];
3316 case CBUS_FUNCTION_8:
3317 *value = ftdi->eeprom->cbus_function[8];
3319 case CBUS_FUNCTION_9:
3320 *value = ftdi->eeprom->cbus_function[8];
3323 *value = ftdi->eeprom->high_current;
3325 case HIGH_CURRENT_A:
3326 *value = ftdi->eeprom->high_current_a;
3328 case HIGH_CURRENT_B:
3329 *value = ftdi->eeprom->high_current_b;
3332 *value = ftdi->eeprom->invert;
3335 *value = ftdi->eeprom->group0_drive;
3337 case GROUP0_SCHMITT:
3338 *value = ftdi->eeprom->group0_schmitt;
3341 *value = ftdi->eeprom->group0_slew;
3344 *value = ftdi->eeprom->group1_drive;
3346 case GROUP1_SCHMITT:
3347 *value = ftdi->eeprom->group1_schmitt;
3350 *value = ftdi->eeprom->group1_slew;
3353 *value = ftdi->eeprom->group2_drive;
3355 case GROUP2_SCHMITT:
3356 *value = ftdi->eeprom->group2_schmitt;
3359 *value = ftdi->eeprom->group2_slew;
3362 *value = ftdi->eeprom->group3_drive;
3364 case GROUP3_SCHMITT:
3365 *value = ftdi->eeprom->group3_schmitt;
3368 *value = ftdi->eeprom->group3_slew;
3371 *value = ftdi->eeprom->powersave;
3373 case CLOCK_POLARITY:
3374 *value = ftdi->eeprom->clock_polarity;
3377 *value = ftdi->eeprom->data_order;
3380 *value = ftdi->eeprom->flow_control;
3383 *value = ftdi->eeprom->chip;
3386 *value = ftdi->eeprom->size;
3389 ftdi_error_return(-1, "Request for unknown EEPROM value");
3395 Set a value in the decoded EEPROM Structure
3396 No parameter checking is performed
3398 \param ftdi pointer to ftdi_context
3399 \param value_name Enum of the value to set
3403 \retval -1: Value doesn't exist
3404 \retval -2: Value not user settable
3406 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
3411 ftdi->eeprom->vendor_id = value;
3414 ftdi->eeprom->product_id = value;
3417 ftdi->eeprom->self_powered = value;
3420 ftdi->eeprom->remote_wakeup = value;
3423 ftdi->eeprom->is_not_pnp = value;
3426 ftdi->eeprom->suspend_dbus7 = value;
3428 case IN_IS_ISOCHRONOUS:
3429 ftdi->eeprom->in_is_isochronous = value;
3431 case OUT_IS_ISOCHRONOUS:
3432 ftdi->eeprom->out_is_isochronous = value;
3434 case SUSPEND_PULL_DOWNS:
3435 ftdi->eeprom->suspend_pull_downs = value;
3438 ftdi->eeprom->use_serial = value;
3441 ftdi->eeprom->usb_version = value;
3443 case USE_USB_VERSION:
3444 ftdi->eeprom->use_usb_version = value;
3447 ftdi->eeprom->max_power = value;
3449 case CHANNEL_A_TYPE:
3450 ftdi->eeprom->channel_a_type = value;
3452 case CHANNEL_B_TYPE:
3453 ftdi->eeprom->channel_b_type = value;
3455 case CHANNEL_A_DRIVER:
3456 ftdi->eeprom->channel_a_driver = value;
3458 case CHANNEL_B_DRIVER:
3459 ftdi->eeprom->channel_b_driver = value;
3461 case CBUS_FUNCTION_0:
3462 ftdi->eeprom->cbus_function[0] = value;
3464 case CBUS_FUNCTION_1:
3465 ftdi->eeprom->cbus_function[1] = value;
3467 case CBUS_FUNCTION_2:
3468 ftdi->eeprom->cbus_function[2] = value;
3470 case CBUS_FUNCTION_3:
3471 ftdi->eeprom->cbus_function[3] = value;
3473 case CBUS_FUNCTION_4:
3474 ftdi->eeprom->cbus_function[4] = value;
3476 case CBUS_FUNCTION_5:
3477 ftdi->eeprom->cbus_function[5] = value;
3479 case CBUS_FUNCTION_6:
3480 ftdi->eeprom->cbus_function[6] = value;
3482 case CBUS_FUNCTION_7:
3483 ftdi->eeprom->cbus_function[7] = value;
3485 case CBUS_FUNCTION_8:
3486 ftdi->eeprom->cbus_function[8] = value;
3488 case CBUS_FUNCTION_9:
3489 ftdi->eeprom->cbus_function[9] = value;
3492 ftdi->eeprom->high_current = value;
3494 case HIGH_CURRENT_A:
3495 ftdi->eeprom->high_current_a = value;
3497 case HIGH_CURRENT_B:
3498 ftdi->eeprom->high_current_b = value;
3501 ftdi->eeprom->invert = value;
3504 ftdi->eeprom->group0_drive = value;
3506 case GROUP0_SCHMITT:
3507 ftdi->eeprom->group0_schmitt = value;
3510 ftdi->eeprom->group0_slew = value;
3513 ftdi->eeprom->group1_drive = value;
3515 case GROUP1_SCHMITT:
3516 ftdi->eeprom->group1_schmitt = value;
3519 ftdi->eeprom->group1_slew = value;
3522 ftdi->eeprom->group2_drive = value;
3524 case GROUP2_SCHMITT:
3525 ftdi->eeprom->group2_schmitt = value;
3528 ftdi->eeprom->group2_slew = value;
3531 ftdi->eeprom->group3_drive = value;
3533 case GROUP3_SCHMITT:
3534 ftdi->eeprom->group3_schmitt = value;
3537 ftdi->eeprom->group3_slew = value;
3540 ftdi->eeprom->chip = value;
3543 ftdi->eeprom->powersave = value;
3545 case CLOCK_POLARITY:
3546 ftdi->eeprom->clock_polarity = value;
3549 ftdi->eeprom->data_order = value;
3552 ftdi->eeprom->flow_control = value;
3555 ftdi_error_return(-2, "EEPROM Value can't be changed");
3557 ftdi_error_return(-1, "Request to unknown EEPROM value");
3562 /** Get the read-only buffer to the binary EEPROM content
3564 \param ftdi pointer to ftdi_context
3565 \param buf buffer to receive EEPROM content
3566 \param size Size of receiving buffer
3569 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
3570 \retval -2: Not enough room to store eeprom
3572 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
3574 if (!ftdi || !(ftdi->eeprom))
3575 ftdi_error_return(-1, "No appropriate structure");
3577 if (!buf || size < ftdi->eeprom->size)
3578 ftdi_error_return(-1, "Not enough room to store eeprom");
3580 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3581 if (size > FTDI_MAX_EEPROM_SIZE)
3582 size = FTDI_MAX_EEPROM_SIZE;
3584 memcpy(buf, ftdi->eeprom->buf, size);
3589 /** Set the EEPROM content from the user-supplied prefilled buffer
3591 \param ftdi pointer to ftdi_context
3592 \param buf buffer to read EEPROM content
3593 \param size Size of buffer
3596 \retval -1: struct ftdi_contxt or ftdi_eeprom of buf missing
3598 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
3600 if (!ftdi || !(ftdi->eeprom) || !buf)
3601 ftdi_error_return(-1, "No appropriate structure");
3603 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3604 if (size > FTDI_MAX_EEPROM_SIZE)
3605 size = FTDI_MAX_EEPROM_SIZE;
3607 memcpy(ftdi->eeprom->buf, buf, size);
3613 Read eeprom location
3615 \param ftdi pointer to ftdi_context
3616 \param eeprom_addr Address of eeprom location to be read
3617 \param eeprom_val Pointer to store read eeprom location
3620 \retval -1: read failed
3621 \retval -2: USB device unavailable
3623 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
3625 if (ftdi == NULL || ftdi->usb_dev == NULL)
3626 ftdi_error_return(-2, "USB device unavailable");
3628 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, (unsigned char *)eeprom_val, 2, ftdi->usb_read_timeout) != 2)
3629 ftdi_error_return(-1, "reading eeprom failed");
3637 \param ftdi pointer to ftdi_context
3640 \retval -1: read failed
3641 \retval -2: USB device unavailable
3643 int ftdi_read_eeprom(struct ftdi_context *ftdi)
3648 if (ftdi == NULL || ftdi->usb_dev == NULL)
3649 ftdi_error_return(-2, "USB device unavailable");
3650 buf = ftdi->eeprom->buf;
3652 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
3654 if (libusb_control_transfer(
3655 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
3656 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
3657 ftdi_error_return(-1, "reading eeprom failed");
3660 if (ftdi->type == TYPE_R)
3661 ftdi->eeprom->size = 0x80;
3662 /* Guesses size of eeprom by comparing halves
3663 - will not work with blank eeprom */
3664 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
3665 ftdi->eeprom->size = -1;
3666 else if (memcmp(buf,&buf[0x80],0x80) == 0)
3667 ftdi->eeprom->size = 0x80;
3668 else if (memcmp(buf,&buf[0x40],0x40) == 0)
3669 ftdi->eeprom->size = 0x40;
3671 ftdi->eeprom->size = 0x100;
3676 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
3677 Function is only used internally
3680 static unsigned char ftdi_read_chipid_shift(unsigned char value)
3682 return ((value & 1) << 1) |
3683 ((value & 2) << 5) |
3684 ((value & 4) >> 2) |
3685 ((value & 8) << 4) |
3686 ((value & 16) >> 1) |
3687 ((value & 32) >> 1) |
3688 ((value & 64) >> 4) |
3689 ((value & 128) >> 2);
3693 Read the FTDIChip-ID from R-type devices
3695 \param ftdi pointer to ftdi_context
3696 \param chipid Pointer to store FTDIChip-ID
3699 \retval -1: read failed
3700 \retval -2: USB device unavailable
3702 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
3704 unsigned int a = 0, b = 0;
3706 if (ftdi == NULL || ftdi->usb_dev == NULL)
3707 ftdi_error_return(-2, "USB device unavailable");
3709 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, 0x43, (unsigned char *)&a, 2, ftdi->usb_read_timeout) == 2)
3711 a = a << 8 | a >> 8;
3712 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, 0x44, (unsigned char *)&b, 2, ftdi->usb_read_timeout) == 2)
3714 b = b << 8 | b >> 8;
3715 a = (a << 16) | (b & 0xFFFF);
3716 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
3717 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
3718 *chipid = a ^ 0xa5f0f7d1;
3723 ftdi_error_return(-1, "read of FTDIChip-ID failed");
3727 Write eeprom location
3729 \param ftdi pointer to ftdi_context
3730 \param eeprom_addr Address of eeprom location to be written
3731 \param eeprom_val Value to be written
3734 \retval -1: write failed
3735 \retval -2: USB device unavailable
3736 \retval -3: Invalid access to checksum protected area below 0x80
3737 \retval -4: Device can't access unprotected area
3738 \retval -5: Reading chip type failed
3740 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
3741 unsigned short eeprom_val)
3743 int chip_type_location;
3744 unsigned short chip_type;
3746 if (ftdi == NULL || ftdi->usb_dev == NULL)
3747 ftdi_error_return(-2, "USB device unavailable");
3749 if (eeprom_addr <0x80)
3750 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
3757 chip_type_location = 0x14;
3761 chip_type_location = 0x18;
3764 chip_type_location = 0x1e;
3767 ftdi_error_return(-4, "Device can't access unprotected area");
3770 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
3771 ftdi_error_return(-5, "Reading failed failed");
3772 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
3773 if ((chip_type & 0xff) != 0x66)
3775 ftdi_error_return(-6, "EEPROM is not of 93x66");
3778 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3779 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
3780 NULL, 0, ftdi->usb_write_timeout) != 0)
3781 ftdi_error_return(-1, "unable to write eeprom");
3789 \param ftdi pointer to ftdi_context
3792 \retval -1: read failed
3793 \retval -2: USB device unavailable
3794 \retval -3: EEPROM not initialized for the connected device;
3796 int ftdi_write_eeprom(struct ftdi_context *ftdi)
3798 unsigned short usb_val, status;
3800 unsigned char *eeprom;
3802 if (ftdi == NULL || ftdi->usb_dev == NULL)
3803 ftdi_error_return(-2, "USB device unavailable");
3805 if(ftdi->eeprom->initialized_for_connected_device == 0)
3806 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
3808 eeprom = ftdi->eeprom->buf;
3810 /* These commands were traced while running MProg */
3811 if ((ret = ftdi_usb_reset(ftdi)) != 0)
3813 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
3815 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
3818 for (i = 0; i < ftdi->eeprom->size/2; i++)
3820 usb_val = eeprom[i*2];
3821 usb_val += eeprom[(i*2)+1] << 8;
3822 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3823 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
3824 NULL, 0, ftdi->usb_write_timeout) < 0)
3825 ftdi_error_return(-1, "unable to write eeprom");
3834 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
3836 \param ftdi pointer to ftdi_context
3839 \retval -1: erase failed
3840 \retval -2: USB device unavailable
3841 \retval -3: Writing magic failed
3842 \retval -4: Read EEPROM failed
3843 \retval -5: Unexpected EEPROM value
3845 #define MAGIC 0x55aa
3846 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
3848 unsigned short eeprom_value;
3849 if (ftdi == NULL || ftdi->usb_dev == NULL)
3850 ftdi_error_return(-2, "USB device unavailable");
3852 if (ftdi->type == TYPE_R)
3854 ftdi->eeprom->chip = 0;
3858 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
3859 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
3860 ftdi_error_return(-1, "unable to erase eeprom");
3863 /* detect chip type by writing 0x55AA as magic at word position 0xc0
3864 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
3865 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
3866 Chip is 93x66 if magic is only read at word position 0xc0*/
3867 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3868 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
3869 NULL, 0, ftdi->usb_write_timeout) != 0)
3870 ftdi_error_return(-3, "Writing magic failed");
3871 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
3872 ftdi_error_return(-4, "Reading failed failed");
3873 if (eeprom_value == MAGIC)
3875 ftdi->eeprom->chip = 0x46;
3879 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
3880 ftdi_error_return(-4, "Reading failed failed");
3881 if (eeprom_value == MAGIC)
3882 ftdi->eeprom->chip = 0x56;
3885 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
3886 ftdi_error_return(-4, "Reading failed failed");
3887 if (eeprom_value == MAGIC)
3888 ftdi->eeprom->chip = 0x66;
3891 ftdi->eeprom->chip = -1;
3895 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
3896 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
3897 ftdi_error_return(-1, "unable to erase eeprom");
3902 Get string representation for last error code
3904 \param ftdi pointer to ftdi_context
3906 \retval Pointer to error string
3908 char *ftdi_get_error_string (struct ftdi_context *ftdi)
3913 return ftdi->error_str;
3916 /* @} end of doxygen libftdi group */