1 /***************************************************************************
5 copyright : (C) 2003-2017 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 SPDX-License-Identifier: LGPL-2.1-only
8 ***************************************************************************/
10 /***************************************************************************
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU Lesser General Public License *
14 * version 2.1 as published by the Free Software Foundation; *
16 ***************************************************************************/
19 \mainpage libftdi API documentation
21 Library to talk to FTDI chips. You find the latest versions of libftdi at
22 https://www.intra2net.com/en/developer/libftdi/
24 The library is easy to use. Have a look at this short example:
27 More examples can be found in the "examples" directory.
29 /** \addtogroup libftdi */
39 /* Prevent deprecated messages when building library */
40 #define _FTDI_DISABLE_DEPRECATED
42 #include "ftdi_version_i.h"
44 #define ftdi_error_return(code, str) do { \
46 ftdi->error_str = str; \
48 fprintf(stderr, str); \
52 #define ftdi_error_return_free_device_list(code, str, devs) do { \
53 libusb_free_device_list(devs,1); \
54 ftdi->error_str = str; \
60 Internal function to close usb device pointer.
61 Sets ftdi->usb_dev to NULL.
64 \param ftdi pointer to ftdi_context
68 static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
70 if (ftdi && ftdi->usb_dev)
72 libusb_close (ftdi->usb_dev);
75 ftdi->eeprom->initialized_for_connected_device = 0;
80 Initializes a ftdi_context.
82 \param ftdi pointer to ftdi_context
85 \retval -1: couldn't allocate read buffer
86 \retval -2: couldn't allocate struct buffer
87 \retval -3: libusb_init() failed
89 \remark This should be called before all functions
91 int ftdi_init(struct ftdi_context *ftdi)
93 struct ftdi_eeprom* eeprom;
96 ftdi->usb_read_timeout = 5000;
97 ftdi->usb_write_timeout = 5000;
99 ftdi->type = TYPE_BM; /* chip type */
101 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
103 ftdi->readbuffer = NULL;
104 ftdi->readbuffer_offset = 0;
105 ftdi->readbuffer_remaining = 0;
106 ftdi->writebuffer_chunksize = 4096;
107 ftdi->max_packet_size = 0;
108 ftdi->error_str = NULL;
109 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
111 if (libusb_init(&ftdi->usb_ctx) < 0)
112 ftdi_error_return(-3, "libusb_init() failed");
114 ftdi_set_interface(ftdi, INTERFACE_ANY);
115 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
117 eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
119 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
120 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
121 ftdi->eeprom = eeprom;
123 /* All fine. Now allocate the readbuffer */
124 return ftdi_read_data_set_chunksize(ftdi, 4096);
128 Allocate and initialize a new ftdi_context
130 \return a pointer to a new ftdi_context, or NULL on failure
132 struct ftdi_context *ftdi_new(void)
134 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
141 if (ftdi_init(ftdi) != 0)
151 Open selected channels on a chip, otherwise use first channel.
153 \param ftdi pointer to ftdi_context
154 \param interface Interface to use for FT2232C/2232H/4232H chips.
157 \retval -1: unknown interface
158 \retval -2: USB device unavailable
159 \retval -3: Device already open, interface can't be set in that state
161 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
164 ftdi_error_return(-2, "USB device unavailable");
166 if (ftdi->usb_dev != NULL)
168 int check_interface = interface;
169 if (check_interface == INTERFACE_ANY)
170 check_interface = INTERFACE_A;
172 if (ftdi->index != check_interface)
173 ftdi_error_return(-3, "Interface can not be changed on an already open device");
181 ftdi->index = INTERFACE_A;
187 ftdi->index = INTERFACE_B;
193 ftdi->index = INTERFACE_C;
199 ftdi->index = INTERFACE_D;
204 ftdi_error_return(-1, "Unknown interface");
210 Deinitializes a ftdi_context.
212 \param ftdi pointer to ftdi_context
214 void ftdi_deinit(struct ftdi_context *ftdi)
219 ftdi_usb_close_internal (ftdi);
221 if (ftdi->readbuffer != NULL)
223 free(ftdi->readbuffer);
224 ftdi->readbuffer = NULL;
227 if (ftdi->eeprom != NULL)
229 if (ftdi->eeprom->manufacturer != 0)
231 free(ftdi->eeprom->manufacturer);
232 ftdi->eeprom->manufacturer = 0;
234 if (ftdi->eeprom->product != 0)
236 free(ftdi->eeprom->product);
237 ftdi->eeprom->product = 0;
239 if (ftdi->eeprom->serial != 0)
241 free(ftdi->eeprom->serial);
242 ftdi->eeprom->serial = 0;
250 libusb_exit(ftdi->usb_ctx);
251 ftdi->usb_ctx = NULL;
256 Deinitialize and free an ftdi_context.
258 \param ftdi pointer to ftdi_context
260 void ftdi_free(struct ftdi_context *ftdi)
267 Use an already open libusb device.
269 \param ftdi pointer to ftdi_context
270 \param usb libusb libusb_device_handle to use
272 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
281 * @brief Get libftdi library version
283 * @return ftdi_version_info Library version information
285 struct ftdi_version_info ftdi_get_library_version(void)
287 struct ftdi_version_info ver;
289 ver.major = FTDI_MAJOR_VERSION;
290 ver.minor = FTDI_MINOR_VERSION;
291 ver.micro = FTDI_MICRO_VERSION;
292 ver.version_str = FTDI_VERSION_STRING;
293 ver.snapshot_str = FTDI_SNAPSHOT_VERSION;
299 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
300 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
301 use. With VID:PID 0:0, search for the default devices
302 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014, 0x403:0x6015)
304 \param ftdi pointer to ftdi_context
305 \param devlist Pointer where to store list of found devices
306 \param vendor Vendor ID to search for
307 \param product Product ID to search for
309 \retval >0: number of devices found
310 \retval -3: out of memory
311 \retval -5: libusb_get_device_list() failed
312 \retval -6: libusb_get_device_descriptor() failed
314 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
316 struct ftdi_device_list **curdev;
318 libusb_device **devs;
322 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
323 ftdi_error_return(-5, "libusb_get_device_list() failed");
328 while ((dev = devs[i++]) != NULL)
330 struct libusb_device_descriptor desc;
332 if (libusb_get_device_descriptor(dev, &desc) < 0)
333 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
335 if (((vendor || product) &&
336 desc.idVendor == vendor && desc.idProduct == product) ||
337 (!(vendor || product) &&
338 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
339 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014
340 || desc.idProduct == 0x6015)))
342 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
344 ftdi_error_return_free_device_list(-3, "out of memory", devs);
346 (*curdev)->next = NULL;
347 (*curdev)->dev = dev;
348 libusb_ref_device(dev);
349 curdev = &(*curdev)->next;
353 libusb_free_device_list(devs,1);
358 Frees a usb device list.
360 \param devlist USB device list created by ftdi_usb_find_all()
362 void ftdi_list_free(struct ftdi_device_list **devlist)
364 struct ftdi_device_list *curdev, *next;
366 for (curdev = *devlist; curdev != NULL;)
369 libusb_unref_device(curdev->dev);
378 Frees a usb device list.
380 \param devlist USB device list created by ftdi_usb_find_all()
382 void ftdi_list_free2(struct ftdi_device_list *devlist)
384 ftdi_list_free(&devlist);
388 Return device ID strings from the usb device.
390 The parameters manufacturer, description and serial may be NULL
391 or pointer to buffers to store the fetched strings.
393 \note Use this function only in combination with ftdi_usb_find_all()
394 as it closes the internal "usb_dev" after use.
396 \param ftdi pointer to ftdi_context
397 \param dev libusb usb_dev to use
398 \param manufacturer Store manufacturer string here if not NULL
399 \param mnf_len Buffer size of manufacturer string
400 \param description Store product description string here if not NULL
401 \param desc_len Buffer size of product description string
402 \param serial Store serial string here if not NULL
403 \param serial_len Buffer size of serial string
406 \retval -1: wrong arguments
407 \retval -4: unable to open device
408 \retval -7: get product manufacturer failed
409 \retval -8: get product description failed
410 \retval -9: get serial number failed
411 \retval -11: libusb_get_device_descriptor() failed
413 int ftdi_usb_get_strings(struct ftdi_context *ftdi,
414 struct libusb_device *dev,
415 char *manufacturer, int mnf_len,
416 char *description, int desc_len,
417 char *serial, int serial_len)
421 if ((ftdi==NULL) || (dev==NULL))
424 if (ftdi->usb_dev == NULL && libusb_open(dev, &ftdi->usb_dev) < 0)
425 ftdi_error_return(-4, "libusb_open() failed");
427 // ftdi->usb_dev will not be NULL when entering ftdi_usb_get_strings2(), so
428 // it won't be closed either. This allows us to close it whether we actually
429 // called libusb_open() up above or not. This matches the expected behavior
430 // (and note) for ftdi_usb_get_strings().
431 ret = ftdi_usb_get_strings2(ftdi, dev,
432 manufacturer, mnf_len,
433 description, desc_len,
436 // only close it if it was successful, as all other return codes close
437 // before returning already.
439 ftdi_usb_close_internal(ftdi);
445 Return device ID strings from the usb device.
447 The parameters manufacturer, description and serial may be NULL
448 or pointer to buffers to store the fetched strings.
450 \note The old function ftdi_usb_get_strings() always closes the device.
451 This version only closes the device if it was opened by it.
453 \param ftdi pointer to ftdi_context
454 \param dev libusb usb_dev to use
455 \param manufacturer Store manufacturer string here if not NULL
456 \param mnf_len Buffer size of manufacturer string
457 \param description Store product description string here if not NULL
458 \param desc_len Buffer size of product description string
459 \param serial Store serial string here if not NULL
460 \param serial_len Buffer size of serial string
463 \retval -1: wrong arguments
464 \retval -4: unable to open device
465 \retval -7: get product manufacturer failed
466 \retval -8: get product description failed
467 \retval -9: get serial number failed
468 \retval -11: libusb_get_device_descriptor() failed
470 int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev,
471 char *manufacturer, int mnf_len,
472 char *description, int desc_len,
473 char *serial, int serial_len)
475 struct libusb_device_descriptor desc;
478 if ((ftdi==NULL) || (dev==NULL))
481 need_open = (ftdi->usb_dev == NULL);
482 if (need_open && libusb_open(dev, &ftdi->usb_dev) < 0)
483 ftdi_error_return(-4, "libusb_open() failed");
485 if (libusb_get_device_descriptor(dev, &desc) < 0)
486 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
488 if (manufacturer != NULL)
490 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
492 ftdi_usb_close_internal (ftdi);
493 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
497 if (description != NULL)
499 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
501 ftdi_usb_close_internal (ftdi);
502 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
508 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
510 ftdi_usb_close_internal (ftdi);
511 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
516 ftdi_usb_close_internal (ftdi);
522 * Internal function to determine the maximum packet size.
523 * \param ftdi pointer to ftdi_context
524 * \param dev libusb usb_dev to use
525 * \retval Maximum packet size for this device
527 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
529 struct libusb_device_descriptor desc;
530 struct libusb_config_descriptor *config0;
531 unsigned int packet_size;
534 if (ftdi == NULL || dev == NULL)
537 // Determine maximum packet size. Init with default value.
538 // New hi-speed devices from FTDI use a packet size of 512 bytes
539 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
540 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
545 if (libusb_get_device_descriptor(dev, &desc) < 0)
548 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
551 if (desc.bNumConfigurations > 0)
553 if (ftdi->interface < config0->bNumInterfaces)
555 struct libusb_interface interface = config0->interface[ftdi->interface];
556 if (interface.num_altsetting > 0)
558 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
559 if (descriptor.bNumEndpoints > 0)
561 packet_size = descriptor.endpoint[0].wMaxPacketSize;
567 libusb_free_config_descriptor (config0);
572 Opens a ftdi device given by an usb_device.
574 \param ftdi pointer to ftdi_context
575 \param dev libusb usb_dev to use
578 \retval -3: unable to config device
579 \retval -4: unable to open device
580 \retval -5: unable to claim device
581 \retval -6: reset failed
582 \retval -7: set baudrate failed
583 \retval -8: ftdi context invalid
584 \retval -9: libusb_get_device_descriptor() failed
585 \retval -10: libusb_get_config_descriptor() failed
586 \retval -11: libusb_detach_kernel_driver() failed
587 \retval -12: libusb_get_configuration() failed
589 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
591 struct libusb_device_descriptor desc;
592 struct libusb_config_descriptor *config0;
593 int cfg, cfg0, detach_errno = 0;
596 ftdi_error_return(-8, "ftdi context invalid");
598 if (libusb_open(dev, &ftdi->usb_dev) < 0)
599 ftdi_error_return(-4, "libusb_open() failed");
601 if (libusb_get_device_descriptor(dev, &desc) < 0)
602 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
604 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
605 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
606 cfg0 = config0->bConfigurationValue;
607 libusb_free_config_descriptor (config0);
609 // Try to detach ftdi_sio kernel module.
611 // The return code is kept in a separate variable and only parsed
612 // if usb_set_configuration() or usb_claim_interface() fails as the
613 // detach operation might be denied and everything still works fine.
614 // Likely scenario is a static ftdi_sio kernel module.
615 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
617 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
618 detach_errno = errno;
620 else if (ftdi->module_detach_mode == AUTO_DETACH_REATACH_SIO_MODULE)
622 if (libusb_set_auto_detach_kernel_driver(ftdi->usb_dev, 1) != LIBUSB_SUCCESS)
623 detach_errno = errno;
626 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
627 ftdi_error_return(-12, "libusb_get_configuration () failed");
628 // set configuration (needed especially for windows)
629 // tolerate EBUSY: one device with one configuration, but two interfaces
630 // and libftdi sessions to both interfaces (e.g. FT2232)
631 if (desc.bNumConfigurations > 0 && cfg != cfg0)
633 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
635 ftdi_usb_close_internal (ftdi);
636 if (detach_errno == EPERM)
638 ftdi_error_return(-8, "inappropriate permissions on device!");
642 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
647 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
649 ftdi_usb_close_internal (ftdi);
650 if (detach_errno == EPERM)
652 ftdi_error_return(-8, "inappropriate permissions on device!");
656 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
660 if (ftdi_usb_reset (ftdi) != 0)
662 ftdi_usb_close_internal (ftdi);
663 ftdi_error_return(-6, "ftdi_usb_reset failed");
666 // Try to guess chip type
667 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
668 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
669 && desc.iSerialNumber == 0))
670 ftdi->type = TYPE_BM;
671 else if (desc.bcdDevice == 0x200)
672 ftdi->type = TYPE_AM;
673 else if (desc.bcdDevice == 0x500)
674 ftdi->type = TYPE_2232C;
675 else if (desc.bcdDevice == 0x600)
677 else if (desc.bcdDevice == 0x700)
678 ftdi->type = TYPE_2232H;
679 else if (desc.bcdDevice == 0x800)
680 ftdi->type = TYPE_4232H;
681 else if (desc.bcdDevice == 0x900)
682 ftdi->type = TYPE_232H;
683 else if (desc.bcdDevice == 0x1000)
684 ftdi->type = TYPE_230X;
686 // Determine maximum packet size
687 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
689 if (ftdi_set_baudrate (ftdi, 9600) != 0)
691 ftdi_usb_close_internal (ftdi);
692 ftdi_error_return(-7, "set baudrate failed");
695 ftdi_error_return(0, "all fine");
699 Opens the first device with a given vendor and product ids.
701 \param ftdi pointer to ftdi_context
702 \param vendor Vendor ID
703 \param product Product ID
705 \retval same as ftdi_usb_open_desc()
707 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
709 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
713 Opens the first device with a given, vendor id, product id,
714 description and serial.
716 \param ftdi pointer to ftdi_context
717 \param vendor Vendor ID
718 \param product Product ID
719 \param description Description to search for. Use NULL if not needed.
720 \param serial Serial to search for. Use NULL if not needed.
723 \retval -3: usb device not found
724 \retval -4: unable to open device
725 \retval -5: unable to claim device
726 \retval -6: reset failed
727 \retval -7: set baudrate failed
728 \retval -8: get product description failed
729 \retval -9: get serial number failed
730 \retval -12: libusb_get_device_list() failed
731 \retval -13: libusb_get_device_descriptor() failed
733 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
734 const char* description, const char* serial)
736 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
740 Opens the index-th device with a given, vendor id, product id,
741 description and serial.
743 \param ftdi pointer to ftdi_context
744 \param vendor Vendor ID
745 \param product Product ID
746 \param description Description to search for. Use NULL if not needed.
747 \param serial Serial to search for. Use NULL if not needed.
748 \param index Number of matching device to open if there are more than one, starts with 0.
751 \retval -1: usb_find_busses() failed
752 \retval -2: usb_find_devices() failed
753 \retval -3: usb device not found
754 \retval -4: unable to open device
755 \retval -5: unable to claim device
756 \retval -6: reset failed
757 \retval -7: set baudrate failed
758 \retval -8: get product description failed
759 \retval -9: get serial number failed
760 \retval -10: unable to close device
761 \retval -11: ftdi context invalid
762 \retval -12: libusb_get_device_list() failed
764 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
765 const char* description, const char* serial, unsigned int index)
768 libusb_device **devs;
773 ftdi_error_return(-11, "ftdi context invalid");
775 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
776 ftdi_error_return(-12, "libusb_get_device_list() failed");
778 while ((dev = devs[i++]) != NULL)
780 struct libusb_device_descriptor desc;
783 if (libusb_get_device_descriptor(dev, &desc) < 0)
784 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
786 if (desc.idVendor == vendor && desc.idProduct == product)
788 if (libusb_open(dev, &ftdi->usb_dev) < 0)
789 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
791 if (description != NULL)
793 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
795 ftdi_usb_close_internal (ftdi);
796 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
798 if (strncmp(string, description, sizeof(string)) != 0)
800 ftdi_usb_close_internal (ftdi);
806 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
808 ftdi_usb_close_internal (ftdi);
809 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
811 if (strncmp(string, serial, sizeof(string)) != 0)
813 ftdi_usb_close_internal (ftdi);
818 ftdi_usb_close_internal (ftdi);
826 res = ftdi_usb_open_dev(ftdi, dev);
827 libusb_free_device_list(devs,1);
833 ftdi_error_return_free_device_list(-3, "device not found", devs);
837 Opens the device at a given USB bus and device address.
839 \param ftdi pointer to ftdi_context
840 \param bus Bus number
841 \param addr Device address
844 \retval -1: usb_find_busses() failed
845 \retval -2: usb_find_devices() failed
846 \retval -3: usb device not found
847 \retval -4: unable to open device
848 \retval -5: unable to claim device
849 \retval -6: reset failed
850 \retval -7: set baudrate failed
851 \retval -8: get product description failed
852 \retval -9: get serial number failed
853 \retval -10: unable to close device
854 \retval -11: ftdi context invalid
855 \retval -12: libusb_get_device_list() failed
857 int ftdi_usb_open_bus_addr(struct ftdi_context *ftdi, uint8_t bus, uint8_t addr)
860 libusb_device **devs;
864 ftdi_error_return(-11, "ftdi context invalid");
866 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
867 ftdi_error_return(-12, "libusb_get_device_list() failed");
869 while ((dev = devs[i++]) != NULL)
871 if (libusb_get_bus_number(dev) == bus && libusb_get_device_address(dev) == addr)
874 res = ftdi_usb_open_dev(ftdi, dev);
875 libusb_free_device_list(devs,1);
881 ftdi_error_return_free_device_list(-3, "device not found", devs);
885 Opens the ftdi-device described by a description-string.
886 Intended to be used for parsing a device-description given as commandline argument.
888 \param ftdi pointer to ftdi_context
889 \param description NULL-terminated description-string, using this format:
890 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
891 \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")
892 \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
893 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
895 \note The description format may be extended in later versions.
898 \retval -2: libusb_get_device_list() failed
899 \retval -3: usb device not found
900 \retval -4: unable to open device
901 \retval -5: unable to claim device
902 \retval -6: reset failed
903 \retval -7: set baudrate failed
904 \retval -8: get product description failed
905 \retval -9: get serial number failed
906 \retval -10: unable to close device
907 \retval -11: illegal description format
908 \retval -12: ftdi context invalid
910 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
913 ftdi_error_return(-12, "ftdi context invalid");
915 if (description[0] == 0 || description[1] != ':')
916 ftdi_error_return(-11, "illegal description format");
918 if (description[0] == 'd')
921 libusb_device **devs;
922 unsigned int bus_number, device_address;
925 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
926 ftdi_error_return(-2, "libusb_get_device_list() failed");
928 /* XXX: This doesn't handle symlinks/odd paths/etc... */
929 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
930 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
932 while ((dev = devs[i++]) != NULL)
935 if (bus_number == libusb_get_bus_number (dev)
936 && device_address == libusb_get_device_address (dev))
938 ret = ftdi_usb_open_dev(ftdi, dev);
939 libusb_free_device_list(devs,1);
945 ftdi_error_return_free_device_list(-3, "device not found", devs);
947 else if (description[0] == 'i' || description[0] == 's')
950 unsigned int product;
951 unsigned int index=0;
952 const char *serial=NULL;
953 const char *startp, *endp;
956 startp=description+2;
957 vendor=strtoul((char*)startp,(char**)&endp,0);
958 if (*endp != ':' || endp == startp || errno != 0)
959 ftdi_error_return(-11, "illegal description format");
962 product=strtoul((char*)startp,(char**)&endp,0);
963 if (endp == startp || errno != 0)
964 ftdi_error_return(-11, "illegal description format");
966 if (description[0] == 'i' && *endp != 0)
968 /* optional index field in i-mode */
970 ftdi_error_return(-11, "illegal description format");
973 index=strtoul((char*)startp,(char**)&endp,0);
974 if (*endp != 0 || endp == startp || errno != 0)
975 ftdi_error_return(-11, "illegal description format");
977 if (description[0] == 's')
980 ftdi_error_return(-11, "illegal description format");
982 /* rest of the description is the serial */
986 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
990 ftdi_error_return(-11, "illegal description format");
995 Resets the ftdi device.
997 \param ftdi pointer to ftdi_context
1000 \retval -1: FTDI reset failed
1001 \retval -2: USB device unavailable
1003 int ftdi_usb_reset(struct ftdi_context *ftdi)
1005 if (ftdi == NULL || ftdi->usb_dev == NULL)
1006 ftdi_error_return(-2, "USB device unavailable");
1008 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1009 SIO_RESET_REQUEST, SIO_RESET_SIO,
1010 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1011 ftdi_error_return(-1,"FTDI reset failed");
1013 // Invalidate data in the readbuffer
1014 ftdi->readbuffer_offset = 0;
1015 ftdi->readbuffer_remaining = 0;
1021 Clears the read buffer on the chip and the internal read buffer.
1022 This is the correct behavior for an RX flush.
1024 \param ftdi pointer to ftdi_context
1027 \retval -1: read buffer purge failed
1028 \retval -2: USB device unavailable
1030 int ftdi_tciflush(struct ftdi_context *ftdi)
1032 if (ftdi == NULL || ftdi->usb_dev == NULL)
1033 ftdi_error_return(-2, "USB device unavailable");
1035 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1036 SIO_RESET_REQUEST, SIO_TCIFLUSH,
1037 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1038 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
1040 // Invalidate data in the readbuffer
1041 ftdi->readbuffer_offset = 0;
1042 ftdi->readbuffer_remaining = 0;
1049 Clears the write buffer on the chip and the internal read buffer.
1050 This is incorrect behavior for an RX flush.
1052 \param ftdi pointer to ftdi_context
1055 \retval -1: write buffer purge failed
1056 \retval -2: USB device unavailable
1058 \deprecated Use \ref ftdi_tciflush(struct ftdi_context *ftdi)
1060 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
1062 if (ftdi == NULL || ftdi->usb_dev == NULL)
1063 ftdi_error_return(-2, "USB device unavailable");
1065 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1066 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
1067 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1068 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
1070 // Invalidate data in the readbuffer
1071 ftdi->readbuffer_offset = 0;
1072 ftdi->readbuffer_remaining = 0;
1078 Clears the write buffer on the chip.
1079 This is correct behavior for a TX flush.
1081 \param ftdi pointer to ftdi_context
1084 \retval -1: write buffer purge failed
1085 \retval -2: USB device unavailable
1087 int ftdi_tcoflush(struct ftdi_context *ftdi)
1089 if (ftdi == NULL || ftdi->usb_dev == NULL)
1090 ftdi_error_return(-2, "USB device unavailable");
1092 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1093 SIO_RESET_REQUEST, SIO_TCOFLUSH,
1094 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1095 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
1102 Clears the read buffer on the chip.
1103 This is incorrect behavior for a TX flush.
1105 \param ftdi pointer to ftdi_context
1108 \retval -1: read buffer purge failed
1109 \retval -2: USB device unavailable
1111 \deprecated Use \ref ftdi_tcoflush(struct ftdi_context *ftdi)
1113 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
1115 if (ftdi == NULL || ftdi->usb_dev == NULL)
1116 ftdi_error_return(-2, "USB device unavailable");
1118 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1119 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
1120 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1121 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
1127 Clears the RX and TX FIFOs on the chip and the internal read buffer.
1128 This is correct behavior for both RX and TX flush.
1130 \param ftdi pointer to ftdi_context
1133 \retval -1: read buffer purge failed
1134 \retval -2: write buffer purge failed
1135 \retval -3: USB device unavailable
1137 int ftdi_tcioflush(struct ftdi_context *ftdi)
1141 if (ftdi == NULL || ftdi->usb_dev == NULL)
1142 ftdi_error_return(-3, "USB device unavailable");
1144 result = ftdi_tcoflush(ftdi);
1148 result = ftdi_tciflush(ftdi);
1156 Clears the buffers on the chip and the internal read buffer.
1157 While coded incorrectly, the result is satisfactory.
1159 \param ftdi pointer to ftdi_context
1162 \retval -1: read buffer purge failed
1163 \retval -2: write buffer purge failed
1164 \retval -3: USB device unavailable
1166 \deprecated Use \ref ftdi_tcioflush(struct ftdi_context *ftdi)
1168 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
1172 if (ftdi == NULL || ftdi->usb_dev == NULL)
1173 ftdi_error_return(-3, "USB device unavailable");
1175 result = ftdi_usb_purge_rx_buffer(ftdi);
1179 result = ftdi_usb_purge_tx_buffer(ftdi);
1189 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
1191 \param ftdi pointer to ftdi_context
1194 \retval -1: usb_release failed
1195 \retval -3: ftdi context invalid
1197 int ftdi_usb_close(struct ftdi_context *ftdi)
1202 ftdi_error_return(-3, "ftdi context invalid");
1204 if (ftdi->usb_dev != NULL)
1205 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
1208 ftdi_usb_close_internal (ftdi);
1213 /* ftdi_to_clkbits_AM For the AM device, convert a requested baudrate
1214 to encoded divisor and the achievable baudrate
1215 Function is only used internally
1222 From /2, 0.125/ 0.25 and 0.5 steps may be taken
1223 The fractional part has frac_code encoding
1225 static int ftdi_to_clkbits_AM(int baudrate, unsigned long *encoded_divisor)
1228 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1229 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
1230 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
1231 int divisor, best_divisor, best_baud, best_baud_diff;
1233 divisor = 24000000 / baudrate;
1235 // Round down to supported fraction (AM only)
1236 divisor -= am_adjust_dn[divisor & 7];
1238 // Try this divisor and the one above it (because division rounds down)
1242 for (i = 0; i < 2; i++)
1244 int try_divisor = divisor + i;
1248 // Round up to supported divisor value
1249 if (try_divisor <= 8)
1251 // Round up to minimum supported divisor
1254 else if (divisor < 16)
1256 // AM doesn't support divisors 9 through 15 inclusive
1261 // Round up to supported fraction (AM only)
1262 try_divisor += am_adjust_up[try_divisor & 7];
1263 if (try_divisor > 0x1FFF8)
1265 // Round down to maximum supported divisor value (for AM)
1266 try_divisor = 0x1FFF8;
1269 // Get estimated baud rate (to nearest integer)
1270 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1271 // Get absolute difference from requested baud rate
1272 if (baud_estimate < baudrate)
1274 baud_diff = baudrate - baud_estimate;
1278 baud_diff = baud_estimate - baudrate;
1280 if (i == 0 || baud_diff < best_baud_diff)
1282 // Closest to requested baud rate so far
1283 best_divisor = try_divisor;
1284 best_baud = baud_estimate;
1285 best_baud_diff = baud_diff;
1288 // Spot on! No point trying
1293 // Encode the best divisor value
1294 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1295 // Deal with special cases for encoded value
1296 if (*encoded_divisor == 1)
1298 *encoded_divisor = 0; // 3000000 baud
1300 else if (*encoded_divisor == 0x4001)
1302 *encoded_divisor = 1; // 2000000 baud (BM only)
1307 /* ftdi_to_clkbits Convert a requested baudrate for a given system clock and predivisor
1308 to encoded divisor and the achievable baudrate
1309 Function is only used internally
1316 From /2, 0.125 steps may be taken.
1317 The fractional part has frac_code encoding
1319 value[13:0] of value is the divisor
1320 index[9] mean 12 MHz Base(120 MHz/10) rate versus 3 MHz (48 MHz/16) else
1322 H Type have all features above with
1323 {index[8],value[15:14]} is the encoded subdivisor
1325 FT232R, FT2232 and FT232BM have no option for 12 MHz and with
1326 {index[0],value[15:14]} is the encoded subdivisor
1328 AM Type chips have only four fractional subdivisors at value[15:14]
1329 for subdivisors 0, 0.5, 0.25, 0.125
1331 static int ftdi_to_clkbits(int baudrate, unsigned int clk, int clk_div, unsigned long *encoded_divisor)
1333 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1335 int divisor, best_divisor;
1336 if (baudrate >= clk/clk_div)
1338 *encoded_divisor = 0;
1339 best_baud = clk/clk_div;
1341 else if (baudrate >= clk/(clk_div + clk_div/2))
1343 *encoded_divisor = 1;
1344 best_baud = clk/(clk_div + clk_div/2);
1346 else if (baudrate >= clk/(2*clk_div))
1348 *encoded_divisor = 2;
1349 best_baud = clk/(2*clk_div);
1353 /* We divide by 16 to have 3 fractional bits and one bit for rounding */
1354 divisor = clk*16/clk_div / baudrate;
1355 if (divisor & 1) /* Decide if to round up or down*/
1356 best_divisor = divisor /2 +1;
1358 best_divisor = divisor/2;
1359 if(best_divisor > 0x20000)
1360 best_divisor = 0x1ffff;
1361 best_baud = clk*16/clk_div/best_divisor;
1362 if (best_baud & 1) /* Decide if to round up or down*/
1363 best_baud = best_baud /2 +1;
1365 best_baud = best_baud /2;
1366 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 0x7] << 14);
1371 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
1372 Function is only used internally
1375 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
1376 unsigned short *value, unsigned short *index)
1379 unsigned long encoded_divisor;
1387 #define H_CLK 120000000
1388 #define C_CLK 48000000
1389 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H) || (ftdi->type == TYPE_232H))
1391 if(baudrate*10 > H_CLK /0x3fff)
1393 /* On H Devices, use 12 000 000 Baudrate when possible
1394 We have a 14 bit divisor, a 1 bit divisor switch (10 or 16)
1395 three fractional bits and a 120 MHz clock
1396 Assume AN_120 "Sub-integer divisors between 0 and 2 are not allowed" holds for
1397 DIV/10 CLK too, so /1, /1.5 and /2 can be handled the same*/
1398 best_baud = ftdi_to_clkbits(baudrate, H_CLK, 10, &encoded_divisor);
1399 encoded_divisor |= 0x20000; /* switch on CLK/10*/
1402 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1404 else if ((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C) || (ftdi->type == TYPE_R) || (ftdi->type == TYPE_230X))
1406 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1410 best_baud = ftdi_to_clkbits_AM(baudrate, &encoded_divisor);
1412 // Split into "value" and "index" values
1413 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1414 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
1416 *index = (unsigned short)(encoded_divisor >> 8);
1418 *index |= ftdi->index;
1421 *index = (unsigned short)(encoded_divisor >> 16);
1423 // Return the nearest baud rate
1428 * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test
1429 * Do not use, it's only for the unit test framework
1431 int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi,
1432 unsigned short *value, unsigned short *index)
1434 return ftdi_convert_baudrate(baudrate, ftdi, value, index);
1438 Sets the chip baud rate
1440 \param ftdi pointer to ftdi_context
1441 \param baudrate baud rate to set
1444 \retval -1: invalid baudrate
1445 \retval -2: setting baudrate failed
1446 \retval -3: USB device unavailable
1448 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1450 unsigned short value, index;
1451 int actual_baudrate;
1453 if (ftdi == NULL || ftdi->usb_dev == NULL)
1454 ftdi_error_return(-3, "USB device unavailable");
1456 if (ftdi->bitbang_enabled)
1458 baudrate = baudrate*4;
1461 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1462 if (actual_baudrate <= 0)
1463 ftdi_error_return (-1, "Silly baudrate <= 0.");
1465 // Check within tolerance (about 5%)
1466 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1467 || ((actual_baudrate < baudrate)
1468 ? (actual_baudrate * 21 < baudrate * 20)
1469 : (baudrate * 21 < actual_baudrate * 20)))
1470 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1472 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1473 SIO_SET_BAUDRATE_REQUEST, value,
1474 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1475 ftdi_error_return (-2, "Setting new baudrate failed");
1477 ftdi->baudrate = baudrate;
1482 Set (RS232) line characteristics.
1483 The break type can only be set via ftdi_set_line_property2()
1484 and defaults to "off".
1486 \param ftdi pointer to ftdi_context
1487 \param bits Number of bits
1488 \param sbit Number of stop bits
1489 \param parity Parity mode
1492 \retval -1: Setting line property failed
1494 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1495 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1497 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1501 Set (RS232) line characteristics
1503 \param ftdi pointer to ftdi_context
1504 \param bits Number of bits
1505 \param sbit Number of stop bits
1506 \param parity Parity mode
1507 \param break_type Break type
1510 \retval -1: Setting line property failed
1511 \retval -2: USB device unavailable
1513 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1514 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1515 enum ftdi_break_type break_type)
1517 unsigned short value = bits;
1519 if (ftdi == NULL || ftdi->usb_dev == NULL)
1520 ftdi_error_return(-2, "USB device unavailable");
1525 value |= (0x00 << 8);
1528 value |= (0x01 << 8);
1531 value |= (0x02 << 8);
1534 value |= (0x03 << 8);
1537 value |= (0x04 << 8);
1544 value |= (0x00 << 11);
1547 value |= (0x01 << 11);
1550 value |= (0x02 << 11);
1557 value |= (0x00 << 14);
1560 value |= (0x01 << 14);
1564 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1565 SIO_SET_DATA_REQUEST, value,
1566 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1567 ftdi_error_return (-1, "Setting new line property failed");
1573 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1575 \param ftdi pointer to ftdi_context
1576 \param buf Buffer with the data
1577 \param size Size of the buffer
1579 \retval -666: USB device unavailable
1580 \retval <0: error code from usb_bulk_write()
1581 \retval >0: number of bytes written
1583 int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size)
1588 if (ftdi == NULL || ftdi->usb_dev == NULL)
1589 ftdi_error_return(-666, "USB device unavailable");
1591 while (offset < size)
1593 int write_size = ftdi->writebuffer_chunksize;
1595 if (offset+write_size > size)
1596 write_size = size-offset;
1598 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, (unsigned char *)buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1599 ftdi_error_return(-1, "usb bulk write failed");
1601 offset += actual_length;
1607 static void LIBUSB_CALL ftdi_read_data_cb(struct libusb_transfer *transfer)
1609 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1610 struct ftdi_context *ftdi = tc->ftdi;
1611 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1613 packet_size = ftdi->max_packet_size;
1615 actual_length = transfer->actual_length;
1617 if (actual_length > 2)
1619 // skip FTDI status bytes.
1620 // Maybe stored in the future to enable modem use
1621 num_of_chunks = actual_length / packet_size;
1622 chunk_remains = actual_length % packet_size;
1623 //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);
1625 ftdi->readbuffer_offset += 2;
1628 if (actual_length > packet_size - 2)
1630 for (i = 1; i < num_of_chunks; i++)
1631 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1632 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1634 if (chunk_remains > 2)
1636 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1637 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1639 actual_length -= 2*num_of_chunks;
1642 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1645 if (actual_length > 0)
1647 // data still fits in buf?
1648 if (tc->offset + actual_length <= tc->size)
1650 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1651 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1652 tc->offset += actual_length;
1654 ftdi->readbuffer_offset = 0;
1655 ftdi->readbuffer_remaining = 0;
1657 /* Did we read exactly the right amount of bytes? */
1658 if (tc->offset == tc->size)
1660 //printf("read_data exact rem %d offset %d\n",
1661 //ftdi->readbuffer_remaining, offset);
1668 // only copy part of the data or size <= readbuffer_chunksize
1669 int part_size = tc->size - tc->offset;
1670 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1671 tc->offset += part_size;
1673 ftdi->readbuffer_offset += part_size;
1674 ftdi->readbuffer_remaining = actual_length - part_size;
1676 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1677 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1684 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1685 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1688 ret = libusb_submit_transfer (transfer);
1695 static void LIBUSB_CALL ftdi_write_data_cb(struct libusb_transfer *transfer)
1697 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1698 struct ftdi_context *ftdi = tc->ftdi;
1700 tc->offset += transfer->actual_length;
1702 if (tc->offset == tc->size)
1708 int write_size = ftdi->writebuffer_chunksize;
1711 if (tc->offset + write_size > tc->size)
1712 write_size = tc->size - tc->offset;
1714 transfer->length = write_size;
1715 transfer->buffer = tc->buf + tc->offset;
1717 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1718 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1721 ret = libusb_submit_transfer (transfer);
1730 Writes data to the chip. Does not wait for completion of the transfer
1731 nor does it make sure that the transfer was successful.
1733 Use libusb 1.0 asynchronous API.
1735 \param ftdi pointer to ftdi_context
1736 \param buf Buffer with the data
1737 \param size Size of the buffer
1739 \retval NULL: Some error happens when submit transfer
1740 \retval !NULL: Pointer to a ftdi_transfer_control
1743 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1745 struct ftdi_transfer_control *tc;
1746 struct libusb_transfer *transfer;
1747 int write_size, ret;
1749 if (ftdi == NULL || ftdi->usb_dev == NULL)
1752 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1756 transfer = libusb_alloc_transfer(0);
1769 if (size < (int)ftdi->writebuffer_chunksize)
1772 write_size = ftdi->writebuffer_chunksize;
1774 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1775 write_size, ftdi_write_data_cb, tc,
1776 ftdi->usb_write_timeout);
1777 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1779 ret = libusb_submit_transfer(transfer);
1782 libusb_free_transfer(transfer);
1786 tc->transfer = transfer;
1792 Reads data from the chip. Does not wait for completion of the transfer
1793 nor does it make sure that the transfer was successful.
1795 Use libusb 1.0 asynchronous API.
1797 \param ftdi pointer to ftdi_context
1798 \param buf Buffer with the data
1799 \param size Size of the buffer
1801 \retval NULL: Some error happens when submit transfer
1802 \retval !NULL: Pointer to a ftdi_transfer_control
1805 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1807 struct ftdi_transfer_control *tc;
1808 struct libusb_transfer *transfer;
1811 if (ftdi == NULL || ftdi->usb_dev == NULL)
1814 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1822 if (size <= (int)ftdi->readbuffer_remaining)
1824 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1827 ftdi->readbuffer_remaining -= size;
1828 ftdi->readbuffer_offset += size;
1830 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1834 tc->transfer = NULL;
1839 if (ftdi->readbuffer_remaining != 0)
1841 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1843 tc->offset = ftdi->readbuffer_remaining;
1848 transfer = libusb_alloc_transfer(0);
1855 ftdi->readbuffer_remaining = 0;
1856 ftdi->readbuffer_offset = 0;
1858 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);
1859 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1861 ret = libusb_submit_transfer(transfer);
1864 libusb_free_transfer(transfer);
1868 tc->transfer = transfer;
1874 Wait for completion of the transfer.
1876 Use libusb 1.0 asynchronous API.
1878 \param tc pointer to ftdi_transfer_control
1880 \retval < 0: Some error happens
1881 \retval >= 0: Data size transferred
1884 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1887 struct timeval to = { 0, 0 };
1888 while (!tc->completed)
1890 ret = libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1891 &to, &tc->completed);
1894 if (ret == LIBUSB_ERROR_INTERRUPTED)
1896 libusb_cancel_transfer(tc->transfer);
1897 while (!tc->completed)
1898 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1899 &to, &tc->completed) < 0)
1901 libusb_free_transfer(tc->transfer);
1909 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
1910 * at ftdi_read_data_submit(). Therefore, we need to check it here.
1914 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1916 libusb_free_transfer(tc->transfer);
1923 Cancel transfer and wait for completion.
1925 Use libusb 1.0 asynchronous API.
1927 \param tc pointer to ftdi_transfer_control
1928 \param to pointer to timeout value or NULL for infinite
1931 void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc,
1932 struct timeval * to)
1934 struct timeval tv = { 0, 0 };
1936 if (!tc->completed && tc->transfer != NULL)
1941 libusb_cancel_transfer(tc->transfer);
1942 while (!tc->completed)
1944 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx, to, &tc->completed) < 0)
1950 libusb_free_transfer(tc->transfer);
1956 Configure write buffer chunk size.
1959 \param ftdi pointer to ftdi_context
1960 \param chunksize Chunk size
1963 \retval -1: ftdi context invalid
1965 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1968 ftdi_error_return(-1, "ftdi context invalid");
1970 ftdi->writebuffer_chunksize = chunksize;
1975 Get write buffer chunk size.
1977 \param ftdi pointer to ftdi_context
1978 \param chunksize Pointer to store chunk size in
1981 \retval -1: ftdi context invalid
1983 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1986 ftdi_error_return(-1, "ftdi context invalid");
1988 *chunksize = ftdi->writebuffer_chunksize;
1993 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1995 Automatically strips the two modem status bytes transferred during every read.
1997 \param ftdi pointer to ftdi_context
1998 \param buf Buffer to store data in
1999 \param size Size of the buffer
2001 \retval -666: USB device unavailable
2002 \retval <0: error code from libusb_bulk_transfer()
2003 \retval 0: no data was available
2004 \retval >0: number of bytes read
2007 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
2009 int offset = 0, ret, i, num_of_chunks, chunk_remains;
2011 int actual_length = 1;
2013 if (ftdi == NULL || ftdi->usb_dev == NULL)
2014 ftdi_error_return(-666, "USB device unavailable");
2016 // Packet size sanity check (avoid division by zero)
2017 packet_size = ftdi->max_packet_size;
2018 if (packet_size == 0)
2019 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
2021 // everything we want is still in the readbuffer?
2022 if (size <= (int)ftdi->readbuffer_remaining)
2024 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
2027 ftdi->readbuffer_remaining -= size;
2028 ftdi->readbuffer_offset += size;
2030 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
2034 // something still in the readbuffer, but not enough to satisfy 'size'?
2035 if (ftdi->readbuffer_remaining != 0)
2037 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
2040 offset += ftdi->readbuffer_remaining;
2042 // do the actual USB read
2043 while (offset < size && actual_length > 0)
2045 ftdi->readbuffer_remaining = 0;
2046 ftdi->readbuffer_offset = 0;
2047 /* returns how much received */
2048 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
2050 ftdi_error_return(ret, "usb bulk read failed");
2052 if (actual_length > 2)
2054 // skip FTDI status bytes.
2055 // Maybe stored in the future to enable modem use
2056 num_of_chunks = actual_length / packet_size;
2057 chunk_remains = actual_length % packet_size;
2058 //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);
2060 ftdi->readbuffer_offset += 2;
2063 if (actual_length > packet_size - 2)
2065 for (i = 1; i < num_of_chunks; i++)
2066 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
2067 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
2069 if (chunk_remains > 2)
2071 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
2072 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
2074 actual_length -= 2*num_of_chunks;
2077 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
2080 else if (actual_length <= 2)
2082 // no more data to read?
2085 if (actual_length > 0)
2087 // data still fits in buf?
2088 if (offset+actual_length <= size)
2090 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
2091 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
2092 offset += actual_length;
2094 /* Did we read exactly the right amount of bytes? */
2096 //printf("read_data exact rem %d offset %d\n",
2097 //ftdi->readbuffer_remaining, offset);
2102 // only copy part of the data or size <= readbuffer_chunksize
2103 int part_size = size-offset;
2104 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
2106 ftdi->readbuffer_offset += part_size;
2107 ftdi->readbuffer_remaining = actual_length-part_size;
2108 offset += part_size;
2110 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
2111 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
2122 Configure read buffer chunk size.
2125 Automatically reallocates the buffer.
2127 \param ftdi pointer to ftdi_context
2128 \param chunksize Chunk size
2131 \retval -1: ftdi context invalid
2133 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
2135 unsigned char *new_buf;
2138 ftdi_error_return(-1, "ftdi context invalid");
2140 // Invalidate all remaining data
2141 ftdi->readbuffer_offset = 0;
2142 ftdi->readbuffer_remaining = 0;
2144 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
2145 which is defined in libusb-1.0. Otherwise, each USB read request will
2146 be divided into multiple URBs. This will cause issues on Linux kernel
2147 older than 2.6.32. */
2148 if (chunksize > 16384)
2152 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
2153 ftdi_error_return(-1, "out of memory for readbuffer");
2155 ftdi->readbuffer = new_buf;
2156 ftdi->readbuffer_chunksize = chunksize;
2162 Get read buffer chunk size.
2164 \param ftdi pointer to ftdi_context
2165 \param chunksize Pointer to store chunk size in
2168 \retval -1: FTDI context invalid
2170 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
2173 ftdi_error_return(-1, "FTDI context invalid");
2175 *chunksize = ftdi->readbuffer_chunksize;
2180 Enable/disable bitbang modes.
2182 \param ftdi pointer to ftdi_context
2183 \param bitmask Bitmask to configure lines.
2184 HIGH/ON value configures a line as output.
2185 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
2188 \retval -1: can't enable bitbang mode
2189 \retval -2: USB device unavailable
2191 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
2193 unsigned short usb_val;
2195 if (ftdi == NULL || ftdi->usb_dev == NULL)
2196 ftdi_error_return(-2, "USB device unavailable");
2198 usb_val = bitmask; // low byte: bitmask
2199 usb_val |= (mode << 8);
2200 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)
2201 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a BM/2232C type chip?");
2203 ftdi->bitbang_mode = mode;
2204 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
2209 Disable bitbang mode.
2211 \param ftdi pointer to ftdi_context
2214 \retval -1: can't disable bitbang mode
2215 \retval -2: USB device unavailable
2217 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
2219 if (ftdi == NULL || ftdi->usb_dev == NULL)
2220 ftdi_error_return(-2, "USB device unavailable");
2222 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)
2223 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
2225 ftdi->bitbang_enabled = 0;
2231 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
2233 \param ftdi pointer to ftdi_context
2234 \param pins Pointer to store pins into
2237 \retval -1: read pins failed
2238 \retval -2: USB device unavailable
2240 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
2242 if (ftdi == NULL || ftdi->usb_dev == NULL)
2243 ftdi_error_return(-2, "USB device unavailable");
2245 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)
2246 ftdi_error_return(-1, "read pins failed");
2254 The FTDI chip keeps data in the internal buffer for a specific
2255 amount of time if the buffer is not full yet to decrease
2256 load on the usb bus.
2258 \param ftdi pointer to ftdi_context
2259 \param latency Value between 1 and 255
2262 \retval -1: latency out of range
2263 \retval -2: unable to set latency timer
2264 \retval -3: USB device unavailable
2266 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
2268 unsigned short usb_val;
2271 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
2273 if (ftdi == NULL || ftdi->usb_dev == NULL)
2274 ftdi_error_return(-3, "USB device unavailable");
2277 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)
2278 ftdi_error_return(-2, "unable to set latency timer");
2286 \param ftdi pointer to ftdi_context
2287 \param latency Pointer to store latency value in
2290 \retval -1: unable to get latency timer
2291 \retval -2: USB device unavailable
2293 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
2295 unsigned short usb_val;
2297 if (ftdi == NULL || ftdi->usb_dev == NULL)
2298 ftdi_error_return(-2, "USB device unavailable");
2300 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)
2301 ftdi_error_return(-1, "reading latency timer failed");
2303 *latency = (unsigned char)usb_val;
2308 Poll modem status information
2310 This function allows the retrieve the two status bytes of the device.
2311 The device sends these bytes also as a header for each read access
2312 where they are discarded by ftdi_read_data(). The chip generates
2313 the two stripped status bytes in the absence of data every 40 ms.
2315 Layout of the first byte:
2316 - B0..B3 - must be 0
2317 - B4 Clear to send (CTS)
2320 - B5 Data set ready (DTS)
2323 - B6 Ring indicator (RI)
2326 - B7 Receive line signal detect (RLSD)
2330 Layout of the second byte:
2331 - B0 Data ready (DR)
2332 - B1 Overrun error (OE)
2333 - B2 Parity error (PE)
2334 - B3 Framing error (FE)
2335 - B4 Break interrupt (BI)
2336 - B5 Transmitter holding register (THRE)
2337 - B6 Transmitter empty (TEMT)
2338 - B7 Error in RCVR FIFO
2340 \param ftdi pointer to ftdi_context
2341 \param status Pointer to store status information in. Must be two bytes.
2344 \retval -1: unable to retrieve status information
2345 \retval -2: USB device unavailable
2347 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
2351 if (ftdi == NULL || ftdi->usb_dev == NULL)
2352 ftdi_error_return(-2, "USB device unavailable");
2354 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)
2355 ftdi_error_return(-1, "getting modem status failed");
2357 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
2363 Set flowcontrol for ftdi chip
2365 Note: Do not use this function to enable XON/XOFF mode, use ftdi_setflowctrl_xonxoff() instead.
2367 \param ftdi pointer to ftdi_context
2368 \param flowctrl flow control to use. should be
2369 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS
2372 \retval -1: set flow control failed
2373 \retval -2: USB device unavailable
2375 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2377 if (ftdi == NULL || ftdi->usb_dev == NULL)
2378 ftdi_error_return(-2, "USB device unavailable");
2380 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2381 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2382 NULL, 0, ftdi->usb_write_timeout) < 0)
2383 ftdi_error_return(-1, "set flow control failed");
2389 Set XON/XOFF flowcontrol for ftdi chip
2391 \param ftdi pointer to ftdi_context
2392 \param xon character code used to resume transmission
2393 \param xoff character code used to pause transmission
2396 \retval -1: set flow control failed
2397 \retval -2: USB device unavailable
2399 int ftdi_setflowctrl_xonxoff(struct ftdi_context *ftdi, unsigned char xon, unsigned char xoff)
2401 if (ftdi == NULL || ftdi->usb_dev == NULL)
2402 ftdi_error_return(-2, "USB device unavailable");
2404 uint16_t xonxoff = xon | (xoff << 8);
2405 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2406 SIO_SET_FLOW_CTRL_REQUEST, xonxoff, (SIO_XON_XOFF_HS | ftdi->index),
2407 NULL, 0, ftdi->usb_write_timeout) < 0)
2408 ftdi_error_return(-1, "set flow control failed");
2416 \param ftdi pointer to ftdi_context
2417 \param state state to set line to (1 or 0)
2420 \retval -1: set dtr failed
2421 \retval -2: USB device unavailable
2423 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2425 unsigned short usb_val;
2427 if (ftdi == NULL || ftdi->usb_dev == NULL)
2428 ftdi_error_return(-2, "USB device unavailable");
2431 usb_val = SIO_SET_DTR_HIGH;
2433 usb_val = SIO_SET_DTR_LOW;
2435 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2436 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2437 NULL, 0, ftdi->usb_write_timeout) < 0)
2438 ftdi_error_return(-1, "set dtr failed");
2446 \param ftdi pointer to ftdi_context
2447 \param state state to set line to (1 or 0)
2450 \retval -1: set rts failed
2451 \retval -2: USB device unavailable
2453 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2455 unsigned short usb_val;
2457 if (ftdi == NULL || ftdi->usb_dev == NULL)
2458 ftdi_error_return(-2, "USB device unavailable");
2461 usb_val = SIO_SET_RTS_HIGH;
2463 usb_val = SIO_SET_RTS_LOW;
2465 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2466 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2467 NULL, 0, ftdi->usb_write_timeout) < 0)
2468 ftdi_error_return(-1, "set of rts failed");
2474 Set dtr and rts line in one pass
2476 \param ftdi pointer to ftdi_context
2477 \param dtr DTR state to set line to (1 or 0)
2478 \param rts RTS state to set line to (1 or 0)
2481 \retval -1: set dtr/rts failed
2482 \retval -2: USB device unavailable
2484 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2486 unsigned short usb_val;
2488 if (ftdi == NULL || ftdi->usb_dev == NULL)
2489 ftdi_error_return(-2, "USB device unavailable");
2492 usb_val = SIO_SET_DTR_HIGH;
2494 usb_val = SIO_SET_DTR_LOW;
2497 usb_val |= SIO_SET_RTS_HIGH;
2499 usb_val |= SIO_SET_RTS_LOW;
2501 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2502 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2503 NULL, 0, ftdi->usb_write_timeout) < 0)
2504 ftdi_error_return(-1, "set of rts/dtr failed");
2510 Set the special event character
2512 \param ftdi pointer to ftdi_context
2513 \param eventch Event character
2514 \param enable 0 to disable the event character, non-zero otherwise
2517 \retval -1: unable to set event character
2518 \retval -2: USB device unavailable
2520 int ftdi_set_event_char(struct ftdi_context *ftdi,
2521 unsigned char eventch, unsigned char enable)
2523 unsigned short usb_val;
2525 if (ftdi == NULL || ftdi->usb_dev == NULL)
2526 ftdi_error_return(-2, "USB device unavailable");
2532 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)
2533 ftdi_error_return(-1, "setting event character failed");
2541 \param ftdi pointer to ftdi_context
2542 \param errorch Error character
2543 \param enable 0 to disable the error character, non-zero otherwise
2546 \retval -1: unable to set error character
2547 \retval -2: USB device unavailable
2549 int ftdi_set_error_char(struct ftdi_context *ftdi,
2550 unsigned char errorch, unsigned char enable)
2552 unsigned short usb_val;
2554 if (ftdi == NULL || ftdi->usb_dev == NULL)
2555 ftdi_error_return(-2, "USB device unavailable");
2561 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)
2562 ftdi_error_return(-1, "setting error character failed");
2568 Init eeprom with default values for the connected device
2569 \param ftdi pointer to ftdi_context
2570 \param manufacturer String to use as Manufacturer
2571 \param product String to use as Product description
2572 \param serial String to use as Serial number description
2575 \retval -1: No struct ftdi_context
2576 \retval -2: No struct ftdi_eeprom
2577 \retval -3: No connected device or device not yet opened
2579 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
2580 char * product, char * serial)
2582 struct ftdi_eeprom *eeprom;
2585 ftdi_error_return(-1, "No struct ftdi_context");
2587 if (ftdi->eeprom == NULL)
2588 ftdi_error_return(-2,"No struct ftdi_eeprom");
2590 eeprom = ftdi->eeprom;
2591 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2593 if (ftdi->usb_dev == NULL)
2594 ftdi_error_return(-3, "No connected device or device not yet opened");
2596 eeprom->vendor_id = 0x0403;
2597 eeprom->use_serial = 1;
2598 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2599 (ftdi->type == TYPE_R))
2600 eeprom->product_id = 0x6001;
2601 else if (ftdi->type == TYPE_4232H)
2602 eeprom->product_id = 0x6011;
2603 else if (ftdi->type == TYPE_232H)
2604 eeprom->product_id = 0x6014;
2605 else if (ftdi->type == TYPE_230X)
2606 eeprom->product_id = 0x6015;
2608 eeprom->product_id = 0x6010;
2610 if (ftdi->type == TYPE_AM)
2611 eeprom->usb_version = 0x0101;
2613 eeprom->usb_version = 0x0200;
2614 eeprom->max_power = 100;
2616 if (eeprom->manufacturer)
2617 free (eeprom->manufacturer);
2618 eeprom->manufacturer = NULL;
2621 eeprom->manufacturer = (char *)malloc(strlen(manufacturer)+1);
2622 if (eeprom->manufacturer)
2623 strcpy(eeprom->manufacturer, manufacturer);
2626 if (eeprom->product)
2627 free (eeprom->product);
2628 eeprom->product = NULL;
2631 eeprom->product = (char *)malloc(strlen(product)+1);
2632 if (eeprom->product)
2633 strcpy(eeprom->product, product);
2637 const char* default_product;
2640 case TYPE_AM: default_product = "AM"; break;
2641 case TYPE_BM: default_product = "BM"; break;
2642 case TYPE_2232C: default_product = "Dual RS232"; break;
2643 case TYPE_R: default_product = "FT232R USB UART"; break;
2644 case TYPE_2232H: default_product = "Dual RS232-HS"; break;
2645 case TYPE_4232H: default_product = "FT4232H"; break;
2646 case TYPE_232H: default_product = "Single-RS232-HS"; break;
2647 case TYPE_230X: default_product = "FT230X Basic UART"; break;
2649 ftdi_error_return(-3, "Unknown chip type");
2651 eeprom->product = (char *)malloc(strlen(default_product) +1);
2652 if (eeprom->product)
2653 strcpy(eeprom->product, default_product);
2657 free (eeprom->serial);
2658 eeprom->serial = NULL;
2661 eeprom->serial = (char *)malloc(strlen(serial)+1);
2663 strcpy(eeprom->serial, serial);
2666 if (ftdi->type == TYPE_R)
2668 eeprom->max_power = 90;
2669 eeprom->size = 0x80;
2670 eeprom->cbus_function[0] = CBUS_TXLED;
2671 eeprom->cbus_function[1] = CBUS_RXLED;
2672 eeprom->cbus_function[2] = CBUS_TXDEN;
2673 eeprom->cbus_function[3] = CBUS_PWREN;
2674 eeprom->cbus_function[4] = CBUS_SLEEP;
2676 else if (ftdi->type == TYPE_230X)
2678 eeprom->max_power = 90;
2679 eeprom->size = 0x100;
2680 eeprom->cbus_function[0] = CBUSX_TXDEN;
2681 eeprom->cbus_function[1] = CBUSX_RXLED;
2682 eeprom->cbus_function[2] = CBUSX_TXLED;
2683 eeprom->cbus_function[3] = CBUSX_SLEEP;
2687 if(ftdi->type == TYPE_232H)
2690 for (i=0; i<10; i++)
2691 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2698 eeprom->release_number = 0x0200;
2701 eeprom->release_number = 0x0400;
2704 eeprom->release_number = 0x0500;
2707 eeprom->release_number = 0x0600;
2710 eeprom->release_number = 0x0700;
2713 eeprom->release_number = 0x0800;
2716 eeprom->release_number = 0x0900;
2719 eeprom->release_number = 0x1000;
2722 eeprom->release_number = 0x00;
2727 int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, const char * manufacturer,
2728 const char * product, const char * serial)
2730 struct ftdi_eeprom *eeprom;
2733 ftdi_error_return(-1, "No struct ftdi_context");
2735 if (ftdi->eeprom == NULL)
2736 ftdi_error_return(-2,"No struct ftdi_eeprom");
2738 eeprom = ftdi->eeprom;
2740 if (ftdi->usb_dev == NULL)
2741 ftdi_error_return(-3, "No connected device or device not yet opened");
2745 if (eeprom->manufacturer)
2746 free (eeprom->manufacturer);
2747 eeprom->manufacturer = (char *)malloc(strlen(manufacturer)+1);
2748 if (eeprom->manufacturer)
2749 strcpy(eeprom->manufacturer, manufacturer);
2754 if (eeprom->product)
2755 free (eeprom->product);
2756 eeprom->product = (char *)malloc(strlen(product)+1);
2757 if (eeprom->product)
2758 strcpy(eeprom->product, product);
2764 free (eeprom->serial);
2765 eeprom->serial = (char *)malloc(strlen(serial)+1);
2768 strcpy(eeprom->serial, serial);
2769 eeprom->use_serial = 1;
2776 Return device ID strings from the eeprom. Device needs to be connected.
2778 The parameters manufacturer, description and serial may be NULL
2779 or pointer to buffers to store the fetched strings.
2781 \param ftdi pointer to ftdi_context
2782 \param manufacturer Store manufacturer string here if not NULL
2783 \param mnf_len Buffer size of manufacturer string
2784 \param product Store product description string here if not NULL
2785 \param prod_len Buffer size of product description string
2786 \param serial Store serial string here if not NULL
2787 \param serial_len Buffer size of serial string
2790 \retval -1: ftdi context invalid
2791 \retval -2: ftdi eeprom buffer invalid
2793 int ftdi_eeprom_get_strings(struct ftdi_context *ftdi,
2794 char *manufacturer, int mnf_len,
2795 char *product, int prod_len,
2796 char *serial, int serial_len)
2798 struct ftdi_eeprom *eeprom;
2801 ftdi_error_return(-1, "No struct ftdi_context");
2802 if (ftdi->eeprom == NULL)
2803 ftdi_error_return(-2, "No struct ftdi_eeprom");
2805 eeprom = ftdi->eeprom;
2809 strncpy(manufacturer, eeprom->manufacturer, mnf_len);
2811 manufacturer[mnf_len - 1] = '\0';
2816 strncpy(product, eeprom->product, prod_len);
2818 product[prod_len - 1] = '\0';
2823 strncpy(serial, eeprom->serial, serial_len);
2825 serial[serial_len - 1] = '\0';
2831 /*FTD2XX doesn't check for values not fitting in the ACBUS Signal options*/
2832 void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2837 int mode_low, mode_high;
2838 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2839 mode_low = CBUSH_TRISTATE;
2841 mode_low = eeprom->cbus_function[2*i];
2842 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2843 mode_high = CBUSH_TRISTATE;
2845 mode_high = eeprom->cbus_function[2*i+1];
2847 output[0x18+i] = (mode_high <<4) | mode_low;
2850 /* Return the bits for the encoded EEPROM Structure of a requested Mode
2853 static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2862 case CHANNEL_IS_UART: return 0;
2863 case CHANNEL_IS_FIFO: return 0x01;
2864 case CHANNEL_IS_OPTO: return 0x02;
2865 case CHANNEL_IS_CPU : return 0x04;
2873 case CHANNEL_IS_UART : return 0;
2874 case CHANNEL_IS_FIFO : return 0x01;
2875 case CHANNEL_IS_OPTO : return 0x02;
2876 case CHANNEL_IS_CPU : return 0x04;
2877 case CHANNEL_IS_FT1284 : return 0x08;
2885 case CHANNEL_IS_UART : return 0;
2886 case CHANNEL_IS_FIFO : return 0x01;
2890 case TYPE_230X: /* FT230X is only UART */
2897 Build binary buffer from ftdi_eeprom structure.
2898 Output is suitable for ftdi_write_eeprom().
2900 \param ftdi pointer to ftdi_context
2902 \retval >=0: size of eeprom user area in bytes
2903 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2904 \retval -2: Invalid eeprom or ftdi pointer
2905 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2906 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2907 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2908 \retval -6: No connected EEPROM or EEPROM Type unknown
2910 int ftdi_eeprom_build(struct ftdi_context *ftdi)
2912 unsigned char i, j, eeprom_size_mask;
2913 unsigned short checksum, value;
2914 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2915 int user_area_size, free_start, free_end;
2916 struct ftdi_eeprom *eeprom;
2917 unsigned char * output;
2920 ftdi_error_return(-2,"No context");
2921 if (ftdi->eeprom == NULL)
2922 ftdi_error_return(-2,"No eeprom structure");
2924 eeprom= ftdi->eeprom;
2925 output = eeprom->buf;
2927 if (eeprom->chip == -1)
2928 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2930 if (eeprom->size == -1)
2932 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2933 eeprom->size = 0x100;
2935 eeprom->size = 0x80;
2938 if (eeprom->manufacturer != NULL)
2939 manufacturer_size = strlen(eeprom->manufacturer);
2940 if (eeprom->product != NULL)
2941 product_size = strlen(eeprom->product);
2942 if (eeprom->serial != NULL)
2943 serial_size = strlen(eeprom->serial);
2945 // eeprom size check
2951 user_area_size = 96; // base size for strings (total of 48 characters)
2954 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2957 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2959 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2961 user_area_size = 86;
2964 user_area_size = 80;
2970 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
2972 if (user_area_size < 0)
2973 ftdi_error_return(-1,"eeprom size exceeded");
2976 if (ftdi->type == TYPE_230X)
2978 /* FT230X have a reserved section in the middle of the MTP,
2979 which cannot be written to, but must be included in the checksum */
2980 memset(ftdi->eeprom->buf, 0, 0x80);
2981 memset((ftdi->eeprom->buf + 0xa0), 0, (FTDI_MAX_EEPROM_SIZE - 0xa0));
2985 memset(ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2988 // Bytes and Bits set for all Types
2990 // Addr 02: Vendor ID
2991 output[0x02] = eeprom->vendor_id;
2992 output[0x03] = eeprom->vendor_id >> 8;
2994 // Addr 04: Product ID
2995 output[0x04] = eeprom->product_id;
2996 output[0x05] = eeprom->product_id >> 8;
2998 // Addr 06: Device release number (0400h for BM features)
2999 output[0x06] = eeprom->release_number;
3000 output[0x07] = eeprom->release_number >> 8;
3002 // Addr 08: Config descriptor
3004 // Bit 6: 1 if this device is self powered, 0 if bus powered
3005 // Bit 5: 1 if this device uses remote wakeup
3006 // Bit 4-0: reserved - 0
3008 if (eeprom->self_powered)
3010 if (eeprom->remote_wakeup)
3014 // Addr 09: Max power consumption: max power = value * 2 mA
3015 output[0x09] = eeprom->max_power / MAX_POWER_MILLIAMP_PER_UNIT;
3017 if ((ftdi->type != TYPE_AM) && (ftdi->type != TYPE_230X))
3019 // Addr 0A: Chip configuration
3020 // Bit 7: 0 - reserved
3021 // Bit 6: 0 - reserved
3022 // Bit 5: 0 - reserved
3023 // Bit 4: 1 - Change USB version
3024 // Bit 3: 1 - Use the serial number string
3025 // Bit 2: 1 - Enable suspend pull downs for lower power
3026 // Bit 1: 1 - Out EndPoint is Isochronous
3027 // Bit 0: 1 - In EndPoint is Isochronous
3030 if (eeprom->in_is_isochronous)
3032 if (eeprom->out_is_isochronous)
3038 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
3039 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
3060 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
3061 eeprom_size_mask = eeprom->size -1;
3062 free_end = i & eeprom_size_mask;
3064 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
3065 // Addr 0F: Length of manufacturer string
3066 // Output manufacturer
3067 output[0x0E] = i; // calculate offset
3068 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
3069 output[i & eeprom_size_mask] = 0x03, i++; // type: string
3070 for (j = 0; j < manufacturer_size; j++)
3072 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
3073 output[i & eeprom_size_mask] = 0x00, i++;
3075 output[0x0F] = manufacturer_size*2 + 2;
3077 // Addr 10: Offset of the product string + 0x80, calculated later
3078 // Addr 11: Length of product string
3079 output[0x10] = i | 0x80; // calculate offset
3080 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
3081 output[i & eeprom_size_mask] = 0x03, i++;
3082 for (j = 0; j < product_size; j++)
3084 output[i & eeprom_size_mask] = eeprom->product[j], i++;
3085 output[i & eeprom_size_mask] = 0x00, i++;
3087 output[0x11] = product_size*2 + 2;
3089 // Addr 12: Offset of the serial string + 0x80, calculated later
3090 // Addr 13: Length of serial string
3091 output[0x12] = i | 0x80; // calculate offset
3092 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
3093 output[i & eeprom_size_mask] = 0x03, i++;
3094 for (j = 0; j < serial_size; j++)
3096 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
3097 output[i & eeprom_size_mask] = 0x00, i++;
3100 // Legacy port name and PnP fields for FT2232 and newer chips
3101 if (ftdi->type > TYPE_BM)
3103 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
3105 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
3107 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
3111 output[0x13] = serial_size*2 + 2;
3113 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
3115 if (eeprom->use_serial)
3116 output[0x0A] |= USE_SERIAL_NUM;
3118 output[0x0A] &= ~USE_SERIAL_NUM;
3121 /* Bytes and Bits specific to (some) types
3122 Write linear, as this allows easier fixing*/
3128 output[0x0C] = eeprom->usb_version & 0xff;
3129 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
3130 if (eeprom->use_usb_version)
3131 output[0x0A] |= USE_USB_VERSION_BIT;
3133 output[0x0A] &= ~USE_USB_VERSION_BIT;
3138 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
3139 if (eeprom->channel_a_driver == DRIVER_VCP)
3140 output[0x00] |= DRIVER_VCP;
3142 output[0x00] &= ~DRIVER_VCP;
3144 if (eeprom->high_current_a)
3145 output[0x00] |= HIGH_CURRENT_DRIVE;
3147 output[0x00] &= ~HIGH_CURRENT_DRIVE;
3149 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
3150 if (eeprom->channel_b_driver == DRIVER_VCP)
3151 output[0x01] |= DRIVER_VCP;
3153 output[0x01] &= ~DRIVER_VCP;
3155 if (eeprom->high_current_b)
3156 output[0x01] |= HIGH_CURRENT_DRIVE;
3158 output[0x01] &= ~HIGH_CURRENT_DRIVE;
3160 if (eeprom->in_is_isochronous)
3161 output[0x0A] |= 0x1;
3163 output[0x0A] &= ~0x1;
3164 if (eeprom->out_is_isochronous)
3165 output[0x0A] |= 0x2;
3167 output[0x0A] &= ~0x2;
3168 if (eeprom->suspend_pull_downs)
3169 output[0x0A] |= 0x4;
3171 output[0x0A] &= ~0x4;
3172 if (eeprom->use_usb_version)
3173 output[0x0A] |= USE_USB_VERSION_BIT;
3175 output[0x0A] &= ~USE_USB_VERSION_BIT;
3177 output[0x0C] = eeprom->usb_version & 0xff;
3178 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
3179 output[0x14] = eeprom->chip;
3182 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_R);
3183 if (eeprom->high_current)
3184 output[0x00] |= HIGH_CURRENT_DRIVE_R;
3185 if (eeprom->channel_a_driver == DRIVER_VCP)
3186 output[0x00] |= DRIVER_VCP;
3187 if (eeprom->external_oscillator)
3188 output[0x00] |= 0x02;
3189 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
3191 if (eeprom->suspend_pull_downs)
3192 output[0x0A] |= 0x4;
3194 output[0x0A] &= ~0x4;
3195 output[0x0B] = eeprom->invert;
3196 output[0x0C] = eeprom->usb_version & 0xff;
3197 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
3199 if (eeprom->cbus_function[0] > CBUS_BB_RD)
3200 output[0x14] = CBUS_TXLED;
3202 output[0x14] = eeprom->cbus_function[0];
3204 if (eeprom->cbus_function[1] > CBUS_BB_RD)
3205 output[0x14] |= CBUS_RXLED<<4;
3207 output[0x14] |= eeprom->cbus_function[1]<<4;
3209 if (eeprom->cbus_function[2] > CBUS_BB_RD)
3210 output[0x15] = CBUS_TXDEN;
3212 output[0x15] = eeprom->cbus_function[2];
3214 if (eeprom->cbus_function[3] > CBUS_BB_RD)
3215 output[0x15] |= CBUS_PWREN<<4;
3217 output[0x15] |= eeprom->cbus_function[3]<<4;
3219 if (eeprom->cbus_function[4] > CBUS_CLK6)
3220 output[0x16] = CBUS_SLEEP;
3222 output[0x16] = eeprom->cbus_function[4];
3225 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
3226 if ( eeprom->channel_a_driver == DRIVER_VCP)
3227 output[0x00] |= DRIVER_VCP;
3229 output[0x00] &= ~DRIVER_VCP;
3231 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
3232 if ( eeprom->channel_b_driver == DRIVER_VCP)
3233 output[0x01] |= DRIVER_VCP;
3235 output[0x01] &= ~DRIVER_VCP;
3236 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
3237 output[0x01] |= SUSPEND_DBUS7_BIT;
3239 output[0x01] &= ~SUSPEND_DBUS7_BIT;
3241 if (eeprom->suspend_pull_downs)
3242 output[0x0A] |= 0x4;
3244 output[0x0A] &= ~0x4;
3246 if (eeprom->group0_drive > DRIVE_16MA)
3247 output[0x0c] |= DRIVE_16MA;
3249 output[0x0c] |= eeprom->group0_drive;
3250 if (eeprom->group0_schmitt == IS_SCHMITT)
3251 output[0x0c] |= IS_SCHMITT;
3252 if (eeprom->group0_slew == SLOW_SLEW)
3253 output[0x0c] |= SLOW_SLEW;
3255 if (eeprom->group1_drive > DRIVE_16MA)
3256 output[0x0c] |= DRIVE_16MA<<4;
3258 output[0x0c] |= eeprom->group1_drive<<4;
3259 if (eeprom->group1_schmitt == IS_SCHMITT)
3260 output[0x0c] |= IS_SCHMITT<<4;
3261 if (eeprom->group1_slew == SLOW_SLEW)
3262 output[0x0c] |= SLOW_SLEW<<4;
3264 if (eeprom->group2_drive > DRIVE_16MA)
3265 output[0x0d] |= DRIVE_16MA;
3267 output[0x0d] |= eeprom->group2_drive;
3268 if (eeprom->group2_schmitt == IS_SCHMITT)
3269 output[0x0d] |= IS_SCHMITT;
3270 if (eeprom->group2_slew == SLOW_SLEW)
3271 output[0x0d] |= SLOW_SLEW;
3273 if (eeprom->group3_drive > DRIVE_16MA)
3274 output[0x0d] |= DRIVE_16MA<<4;
3276 output[0x0d] |= eeprom->group3_drive<<4;
3277 if (eeprom->group3_schmitt == IS_SCHMITT)
3278 output[0x0d] |= IS_SCHMITT<<4;
3279 if (eeprom->group3_slew == SLOW_SLEW)
3280 output[0x0d] |= SLOW_SLEW<<4;
3282 output[0x18] = eeprom->chip;
3286 if (eeprom->channel_a_driver == DRIVER_VCP)
3287 output[0x00] |= DRIVER_VCP;
3289 output[0x00] &= ~DRIVER_VCP;
3290 if (eeprom->channel_b_driver == DRIVER_VCP)
3291 output[0x01] |= DRIVER_VCP;
3293 output[0x01] &= ~DRIVER_VCP;
3294 if (eeprom->channel_c_driver == DRIVER_VCP)
3295 output[0x00] |= (DRIVER_VCP << 4);
3297 output[0x00] &= ~(DRIVER_VCP << 4);
3298 if (eeprom->channel_d_driver == DRIVER_VCP)
3299 output[0x01] |= (DRIVER_VCP << 4);
3301 output[0x01] &= ~(DRIVER_VCP << 4);
3303 if (eeprom->suspend_pull_downs)
3304 output[0x0a] |= 0x4;
3306 output[0x0a] &= ~0x4;
3308 if (eeprom->channel_a_rs485enable)
3309 output[0x0b] |= CHANNEL_IS_RS485 << 0;
3311 output[0x0b] &= ~(CHANNEL_IS_RS485 << 0);
3312 if (eeprom->channel_b_rs485enable)
3313 output[0x0b] |= CHANNEL_IS_RS485 << 1;
3315 output[0x0b] &= ~(CHANNEL_IS_RS485 << 1);
3316 if (eeprom->channel_c_rs485enable)
3317 output[0x0b] |= CHANNEL_IS_RS485 << 2;
3319 output[0x0b] &= ~(CHANNEL_IS_RS485 << 2);
3320 if (eeprom->channel_d_rs485enable)
3321 output[0x0b] |= CHANNEL_IS_RS485 << 3;
3323 output[0x0b] &= ~(CHANNEL_IS_RS485 << 3);
3325 if (eeprom->group0_drive > DRIVE_16MA)
3326 output[0x0c] |= DRIVE_16MA;
3328 output[0x0c] |= eeprom->group0_drive;
3329 if (eeprom->group0_schmitt == IS_SCHMITT)
3330 output[0x0c] |= IS_SCHMITT;
3331 if (eeprom->group0_slew == SLOW_SLEW)
3332 output[0x0c] |= SLOW_SLEW;
3334 if (eeprom->group1_drive > DRIVE_16MA)
3335 output[0x0c] |= DRIVE_16MA<<4;
3337 output[0x0c] |= eeprom->group1_drive<<4;
3338 if (eeprom->group1_schmitt == IS_SCHMITT)
3339 output[0x0c] |= IS_SCHMITT<<4;
3340 if (eeprom->group1_slew == SLOW_SLEW)
3341 output[0x0c] |= SLOW_SLEW<<4;
3343 if (eeprom->group2_drive > DRIVE_16MA)
3344 output[0x0d] |= DRIVE_16MA;
3346 output[0x0d] |= eeprom->group2_drive;
3347 if (eeprom->group2_schmitt == IS_SCHMITT)
3348 output[0x0d] |= IS_SCHMITT;
3349 if (eeprom->group2_slew == SLOW_SLEW)
3350 output[0x0d] |= SLOW_SLEW;
3352 if (eeprom->group3_drive > DRIVE_16MA)
3353 output[0x0d] |= DRIVE_16MA<<4;
3355 output[0x0d] |= eeprom->group3_drive<<4;
3356 if (eeprom->group3_schmitt == IS_SCHMITT)
3357 output[0x0d] |= IS_SCHMITT<<4;
3358 if (eeprom->group3_slew == SLOW_SLEW)
3359 output[0x0d] |= SLOW_SLEW<<4;
3361 output[0x18] = eeprom->chip;
3365 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
3366 if ( eeprom->channel_a_driver == DRIVER_VCP)
3367 output[0x00] |= DRIVER_VCPH;
3369 output[0x00] &= ~DRIVER_VCPH;
3370 if (eeprom->powersave)
3371 output[0x01] |= POWER_SAVE_DISABLE_H;
3373 output[0x01] &= ~POWER_SAVE_DISABLE_H;
3375 if (eeprom->suspend_pull_downs)
3376 output[0x0a] |= 0x4;
3378 output[0x0a] &= ~0x4;
3380 if (eeprom->clock_polarity)
3381 output[0x01] |= FT1284_CLK_IDLE_STATE;
3383 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
3384 if (eeprom->data_order)
3385 output[0x01] |= FT1284_DATA_LSB;
3387 output[0x01] &= ~FT1284_DATA_LSB;
3388 if (eeprom->flow_control)
3389 output[0x01] |= FT1284_FLOW_CONTROL;
3391 output[0x01] &= ~FT1284_FLOW_CONTROL;
3392 if (eeprom->group0_drive > DRIVE_16MA)
3393 output[0x0c] |= DRIVE_16MA;
3395 output[0x0c] |= eeprom->group0_drive;
3396 if (eeprom->group0_schmitt == IS_SCHMITT)
3397 output[0x0c] |= IS_SCHMITT;
3398 if (eeprom->group0_slew == SLOW_SLEW)
3399 output[0x0c] |= SLOW_SLEW;
3401 if (eeprom->group1_drive > DRIVE_16MA)
3402 output[0x0d] |= DRIVE_16MA;
3404 output[0x0d] |= eeprom->group1_drive;
3405 if (eeprom->group1_schmitt == IS_SCHMITT)
3406 output[0x0d] |= IS_SCHMITT;
3407 if (eeprom->group1_slew == SLOW_SLEW)
3408 output[0x0d] |= SLOW_SLEW;
3410 set_ft232h_cbus(eeprom, output);
3412 output[0x1e] = eeprom->chip;
3413 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
3416 output[0x00] = 0x80; /* Actually, leave the default value */
3417 /*FIXME: Make DBUS & CBUS Control configurable*/
3418 output[0x0c] = 0; /* DBUS drive 4mA, CBUS drive 4 mA like factory default */
3419 for (j = 0; j <= 6; j++)
3421 output[0x1a + j] = eeprom->cbus_function[j];
3423 output[0x0b] = eeprom->invert;
3427 /* First address without use */
3447 /* Arbitrary user data */
3448 if (eeprom->user_data && eeprom->user_data_size >= 0)
3450 if (eeprom->user_data_addr < free_start)
3451 fprintf(stderr,"Warning, user data starts inside the generated data!\n");
3452 if (eeprom->user_data_addr + eeprom->user_data_size >= free_end)
3453 fprintf(stderr,"Warning, user data overlaps the strings area!\n");
3454 if (eeprom->user_data_addr + eeprom->user_data_size > eeprom->size)
3455 ftdi_error_return(-1,"eeprom size exceeded");
3456 memcpy(output + eeprom->user_data_addr, eeprom->user_data, eeprom->user_data_size);
3459 // calculate checksum
3462 for (i = 0; i < eeprom->size/2-1; i++)
3464 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3466 /* FT230X has a user section in the MTP which is not part of the checksum */
3469 if ((ftdi->type == TYPE_230X) && (i >= 0x40) && (i < 0x50)) {
3471 if (ftdi_read_eeprom_location(ftdi, i, &data)) {
3472 fprintf(stderr, "Reading Factory Configuration Data failed\n");
3478 value = output[i*2];
3479 value += output[(i*2)+1] << 8;
3481 checksum = value^checksum;
3482 checksum = (checksum << 1) | (checksum >> 15);
3485 output[eeprom->size-2] = checksum;
3486 output[eeprom->size-1] = checksum >> 8;
3488 eeprom->initialized_for_connected_device = 1;
3489 return user_area_size;
3491 /* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
3494 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
3496 static unsigned char bit2type(unsigned char bits)
3500 case 0: return CHANNEL_IS_UART;
3501 case 1: return CHANNEL_IS_FIFO;
3502 case 2: return CHANNEL_IS_OPTO;
3503 case 4: return CHANNEL_IS_CPU;
3504 case 8: return CHANNEL_IS_FT1284;
3506 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
3511 /* Decode 230X / 232R type chips invert bits
3512 * Prints directly to stdout.
3514 static void print_inverted_bits(int invert)
3516 const char *r_bits[] = {"TXD","RXD","RTS","CTS","DTR","DSR","DCD","RI"};
3519 fprintf(stdout,"Inverted bits:");
3521 if ((invert & (1<<i)) == (1<<i))
3522 fprintf(stdout," %s",r_bits[i]);
3524 fprintf(stdout,"\n");
3527 Decode binary EEPROM image into an ftdi_eeprom structure.
3529 For FT-X devices use AN_201 FT-X MTP memory Configuration to decode.
3531 \param ftdi pointer to ftdi_context
3532 \param verbose Decode EEPROM on stdout
3535 \retval -1: something went wrong
3537 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
3538 FIXME: Strings are malloc'ed here and should be freed somewhere
3540 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
3543 unsigned short checksum, eeprom_checksum, value;
3544 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
3546 struct ftdi_eeprom *eeprom;
3547 unsigned char *buf = NULL;
3550 ftdi_error_return(-1,"No context");
3551 if (ftdi->eeprom == NULL)
3552 ftdi_error_return(-1,"No eeprom structure");
3554 eeprom = ftdi->eeprom;
3555 eeprom_size = eeprom->size;
3556 buf = ftdi->eeprom->buf;
3558 // Addr 02: Vendor ID
3559 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
3561 // Addr 04: Product ID
3562 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
3564 // Addr 06: Device release number
3565 eeprom->release_number = buf[0x06] + (buf[0x07]<<8);
3567 // Addr 08: Config descriptor
3569 // Bit 6: 1 if this device is self powered, 0 if bus powered
3570 // Bit 5: 1 if this device uses remote wakeup
3571 eeprom->self_powered = buf[0x08] & 0x40;
3572 eeprom->remote_wakeup = buf[0x08] & 0x20;
3574 // Addr 09: Max power consumption: max power = value * 2 mA
3575 eeprom->max_power = MAX_POWER_MILLIAMP_PER_UNIT * buf[0x09];
3577 // Addr 0A: Chip configuration
3578 // Bit 7: 0 - reserved
3579 // Bit 6: 0 - reserved
3580 // Bit 5: 0 - reserved
3581 // Bit 4: 1 - Change USB version on BM and 2232C
3582 // Bit 3: 1 - Use the serial number string
3583 // Bit 2: 1 - Enable suspend pull downs for lower power
3584 // Bit 1: 1 - Out EndPoint is Isochronous
3585 // Bit 0: 1 - In EndPoint is Isochronous
3587 eeprom->in_is_isochronous = buf[0x0A]&0x01;
3588 eeprom->out_is_isochronous = buf[0x0A]&0x02;
3589 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
3590 eeprom->use_serial = !!(buf[0x0A] & USE_SERIAL_NUM);
3591 eeprom->use_usb_version = !!(buf[0x0A] & USE_USB_VERSION_BIT);
3593 // Addr 0C: USB version low byte when 0x0A
3594 // Addr 0D: USB version high byte when 0x0A
3595 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
3597 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
3598 // Addr 0F: Length of manufacturer string
3599 manufacturer_size = buf[0x0F]/2;
3600 if (eeprom->manufacturer)
3601 free(eeprom->manufacturer);
3602 if (manufacturer_size > 0)
3604 eeprom->manufacturer = (char *)malloc(manufacturer_size);
3605 if (eeprom->manufacturer)
3607 // Decode manufacturer
3608 i = buf[0x0E] & (eeprom_size -1); // offset
3609 for (j=0; j<manufacturer_size-1; j++)
3611 eeprom->manufacturer[j] = buf[2*j+i+2];
3613 eeprom->manufacturer[j] = '\0';
3616 else eeprom->manufacturer = NULL;
3618 // Addr 10: Offset of the product string + 0x80, calculated later
3619 // Addr 11: Length of product string
3620 if (eeprom->product)
3621 free(eeprom->product);
3622 product_size = buf[0x11]/2;
3623 if (product_size > 0)
3625 eeprom->product = (char *)malloc(product_size);
3626 if (eeprom->product)
3628 // Decode product name
3629 i = buf[0x10] & (eeprom_size -1); // offset
3630 for (j=0; j<product_size-1; j++)
3632 eeprom->product[j] = buf[2*j+i+2];
3634 eeprom->product[j] = '\0';
3637 else eeprom->product = NULL;
3639 // Addr 12: Offset of the serial string + 0x80, calculated later
3640 // Addr 13: Length of serial string
3642 free(eeprom->serial);
3643 serial_size = buf[0x13]/2;
3644 if (serial_size > 0)
3646 eeprom->serial = (char *)malloc(serial_size);
3650 i = buf[0x12] & (eeprom_size -1); // offset
3651 for (j=0; j<serial_size-1; j++)
3653 eeprom->serial[j] = buf[2*j+i+2];
3655 eeprom->serial[j] = '\0';
3658 else eeprom->serial = NULL;
3663 for (i = 0; i < eeprom_size/2-1; i++)
3665 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3667 /* FT230X has a user section in the MTP which is not part of the checksum */
3671 value += buf[(i*2)+1] << 8;
3673 checksum = value^checksum;
3674 checksum = (checksum << 1) | (checksum >> 15);
3677 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
3679 if (eeprom_checksum != checksum)
3681 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
3682 ftdi_error_return(-1,"EEPROM checksum error");
3685 eeprom->channel_a_type = 0;
3686 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
3690 else if (ftdi->type == TYPE_2232C)
3692 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3693 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3694 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
3695 eeprom->channel_b_type = buf[0x01] & 0x7;
3696 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3697 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
3698 eeprom->chip = buf[0x14];
3700 else if (ftdi->type == TYPE_R)
3702 /* TYPE_R flags D2XX, not VCP as all others*/
3703 eeprom->channel_a_driver = ~buf[0x00] & DRIVER_VCP;
3704 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
3705 eeprom->external_oscillator = buf[0x00] & 0x02;
3706 if ( (buf[0x01]&0x40) != 0x40)
3708 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
3709 " If this happened with the\n"
3710 " EEPROM programmed by FTDI tools, please report "
3711 "to libftdi@developer.intra2net.com\n");
3713 eeprom->chip = buf[0x16];
3714 // Addr 0B: Invert data lines
3715 // Works only on FT232R, not FT245R, but no way to distinguish
3716 eeprom->invert = buf[0x0B];
3717 // Addr 14: CBUS function: CBUS0, CBUS1
3718 // Addr 15: CBUS function: CBUS2, CBUS3
3719 // Addr 16: CBUS function: CBUS5
3720 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3721 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3722 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3723 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3724 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
3726 else if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3728 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3729 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3731 if (ftdi->type == TYPE_2232H)
3733 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3734 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
3735 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
3739 eeprom->channel_c_driver = (buf[0x00] >> 4) & DRIVER_VCP;
3740 eeprom->channel_d_driver = (buf[0x01] >> 4) & DRIVER_VCP;
3741 eeprom->channel_a_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 0);
3742 eeprom->channel_b_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 1);
3743 eeprom->channel_c_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 2);
3744 eeprom->channel_d_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 3);
3747 eeprom->chip = buf[0x18];
3748 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3749 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3750 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3751 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3752 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3753 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3754 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3755 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3756 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3757 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3758 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3759 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
3761 else if (ftdi->type == TYPE_232H)
3763 eeprom->channel_a_type = buf[0x00] & 0xf;
3764 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
3765 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3766 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3767 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
3768 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
3769 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3770 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3771 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3772 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3773 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3774 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3778 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3779 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3781 eeprom->chip = buf[0x1e];
3782 /*FIXME: Decipher more values*/
3784 else if (ftdi->type == TYPE_230X)
3788 eeprom->cbus_function[i] = buf[0x1a + i] & 0xFF;
3790 eeprom->group0_drive = buf[0x0c] & 0x03;
3791 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3792 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3793 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x03;
3794 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3795 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3797 eeprom->invert = buf[0xb];
3802 const char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
3803 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3804 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
3805 fprintf(stdout, "Release: 0x%04x\n",eeprom->release_number);
3807 if (eeprom->self_powered)
3808 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3810 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power,
3811 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
3812 if (eeprom->manufacturer)
3813 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
3814 if (eeprom->product)
3815 fprintf(stdout, "Product: %s\n",eeprom->product);
3817 fprintf(stdout, "Serial: %s\n",eeprom->serial);
3818 fprintf(stdout, "Checksum : %04x\n", checksum);
3819 if (ftdi->type == TYPE_R) {
3820 fprintf(stdout, "Internal EEPROM\n");
3821 fprintf(stdout,"Oscillator: %s\n", eeprom->external_oscillator?"External":"Internal");
3823 else if (eeprom->chip >= 0x46)
3824 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
3825 if (eeprom->suspend_dbus7)
3826 fprintf(stdout, "Suspend on DBUS7\n");
3827 if (eeprom->suspend_pull_downs)
3828 fprintf(stdout, "Pull IO pins low during suspend\n");
3829 if(eeprom->powersave)
3831 if(ftdi->type >= TYPE_232H)
3832 fprintf(stdout,"Enter low power state on ACBUS7\n");
3834 if (eeprom->remote_wakeup)
3835 fprintf(stdout, "Enable Remote Wake Up\n");
3836 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
3837 if (ftdi->type >= TYPE_2232C)
3838 fprintf(stdout,"Channel A has Mode %s%s%s\n",
3839 channel_mode[eeprom->channel_a_type],
3840 (eeprom->channel_a_driver)?" VCP":"",
3841 (eeprom->high_current_a)?" High Current IO":"");
3842 if (ftdi->type == TYPE_232H)
3844 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3845 (eeprom->clock_polarity)?"HIGH":"LOW",
3846 (eeprom->data_order)?"LSB":"MSB",
3847 (eeprom->flow_control)?"":"No ");
3849 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3850 fprintf(stdout,"Channel B has Mode %s%s%s\n",
3851 channel_mode[eeprom->channel_b_type],
3852 (eeprom->channel_b_driver)?" VCP":"",
3853 (eeprom->high_current_b)?" High Current IO":"");
3854 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3855 eeprom->use_usb_version)
3856 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3858 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3860 fprintf(stdout,"%s has %d mA drive%s%s\n",
3861 (ftdi->type == TYPE_2232H)?"AL":"A",
3862 (eeprom->group0_drive+1) *4,
3863 (eeprom->group0_schmitt)?" Schmitt Input":"",
3864 (eeprom->group0_slew)?" Slow Slew":"");
3865 fprintf(stdout,"%s has %d mA drive%s%s\n",
3866 (ftdi->type == TYPE_2232H)?"AH":"B",
3867 (eeprom->group1_drive+1) *4,
3868 (eeprom->group1_schmitt)?" Schmitt Input":"",
3869 (eeprom->group1_slew)?" Slow Slew":"");
3870 fprintf(stdout,"%s has %d mA drive%s%s\n",
3871 (ftdi->type == TYPE_2232H)?"BL":"C",
3872 (eeprom->group2_drive+1) *4,
3873 (eeprom->group2_schmitt)?" Schmitt Input":"",
3874 (eeprom->group2_slew)?" Slow Slew":"");
3875 fprintf(stdout,"%s has %d mA drive%s%s\n",
3876 (ftdi->type == TYPE_2232H)?"BH":"D",
3877 (eeprom->group3_drive+1) *4,
3878 (eeprom->group3_schmitt)?" Schmitt Input":"",
3879 (eeprom->group3_slew)?" Slow Slew":"");
3881 else if (ftdi->type == TYPE_232H)
3883 const char *cbush_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
3884 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3885 "CLK30","CLK15","CLK7_5"
3887 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3888 (eeprom->group0_drive+1) *4,
3889 (eeprom->group0_schmitt)?" Schmitt Input":"",
3890 (eeprom->group0_slew)?" Slow Slew":"");
3891 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3892 (eeprom->group1_drive+1) *4,
3893 (eeprom->group1_schmitt)?" Schmitt Input":"",
3894 (eeprom->group1_slew)?" Slow Slew":"");
3895 for (i=0; i<10; i++)
3897 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3898 fprintf(stdout,"C%d Function: %s\n", i,
3899 cbush_mux[eeprom->cbus_function[i]]);
3902 else if (ftdi->type == TYPE_230X)
3904 const char *cbusx_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
3905 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3906 "CLK24","CLK12","CLK6","BAT_DETECT","BAT_DETECT#",
3907 "I2C_TXE#", "I2C_RXF#", "VBUS_SENSE", "BB_WR#",
3908 "BBRD#", "TIME_STAMP", "AWAKE#",
3910 fprintf(stdout,"DBUS has %d mA drive%s%s\n",
3911 (eeprom->group0_drive+1) *4,
3912 (eeprom->group0_schmitt)?" Schmitt Input":"",
3913 (eeprom->group0_slew)?" Slow Slew":"");
3914 fprintf(stdout,"CBUS has %d mA drive%s%s\n",
3915 (eeprom->group1_drive+1) *4,
3916 (eeprom->group1_schmitt)?" Schmitt Input":"",
3917 (eeprom->group1_slew)?" Slow Slew":"");
3920 if (eeprom->cbus_function[i]<= CBUSX_AWAKE)
3921 fprintf(stdout,"CBUS%d Function: %s\n", i, cbusx_mux[eeprom->cbus_function[i]]);
3925 print_inverted_bits(eeprom->invert);
3928 if (ftdi->type == TYPE_R)
3930 const char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
3931 "SLEEP","CLK48","CLK24","CLK12","CLK6",
3932 "IOMODE","BB_WR","BB_RD"
3934 const char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
3937 print_inverted_bits(eeprom->invert);
3941 if (eeprom->cbus_function[i]<=CBUS_BB_RD)
3942 fprintf(stdout,"C%d Function: %s\n", i,
3943 cbus_mux[eeprom->cbus_function[i]]);
3947 /* Running MPROG show that C0..3 have fixed function Synchronous
3949 fprintf(stdout,"C%d BB Function: %s\n", i,
3952 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
3961 Get a value from the decoded EEPROM structure
3963 \param ftdi pointer to ftdi_context
3964 \param value_name Enum of the value to query
3965 \param value Pointer to store read value
3968 \retval -1: Value doesn't exist
3970 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3975 *value = ftdi->eeprom->vendor_id;
3978 *value = ftdi->eeprom->product_id;
3980 case RELEASE_NUMBER:
3981 *value = ftdi->eeprom->release_number;
3984 *value = ftdi->eeprom->self_powered;
3987 *value = ftdi->eeprom->remote_wakeup;
3990 *value = ftdi->eeprom->is_not_pnp;
3993 *value = ftdi->eeprom->suspend_dbus7;
3995 case IN_IS_ISOCHRONOUS:
3996 *value = ftdi->eeprom->in_is_isochronous;
3998 case OUT_IS_ISOCHRONOUS:
3999 *value = ftdi->eeprom->out_is_isochronous;
4001 case SUSPEND_PULL_DOWNS:
4002 *value = ftdi->eeprom->suspend_pull_downs;
4005 *value = ftdi->eeprom->use_serial;
4008 *value = ftdi->eeprom->usb_version;
4010 case USE_USB_VERSION:
4011 *value = ftdi->eeprom->use_usb_version;
4014 *value = ftdi->eeprom->max_power;
4016 case CHANNEL_A_TYPE:
4017 *value = ftdi->eeprom->channel_a_type;
4019 case CHANNEL_B_TYPE:
4020 *value = ftdi->eeprom->channel_b_type;
4022 case CHANNEL_A_DRIVER:
4023 *value = ftdi->eeprom->channel_a_driver;
4025 case CHANNEL_B_DRIVER:
4026 *value = ftdi->eeprom->channel_b_driver;
4028 case CHANNEL_C_DRIVER:
4029 *value = ftdi->eeprom->channel_c_driver;
4031 case CHANNEL_D_DRIVER:
4032 *value = ftdi->eeprom->channel_d_driver;
4034 case CHANNEL_A_RS485:
4035 *value = ftdi->eeprom->channel_a_rs485enable;
4037 case CHANNEL_B_RS485:
4038 *value = ftdi->eeprom->channel_b_rs485enable;
4040 case CHANNEL_C_RS485:
4041 *value = ftdi->eeprom->channel_c_rs485enable;
4043 case CHANNEL_D_RS485:
4044 *value = ftdi->eeprom->channel_d_rs485enable;
4046 case CBUS_FUNCTION_0:
4047 *value = ftdi->eeprom->cbus_function[0];
4049 case CBUS_FUNCTION_1:
4050 *value = ftdi->eeprom->cbus_function[1];
4052 case CBUS_FUNCTION_2:
4053 *value = ftdi->eeprom->cbus_function[2];
4055 case CBUS_FUNCTION_3:
4056 *value = ftdi->eeprom->cbus_function[3];
4058 case CBUS_FUNCTION_4:
4059 *value = ftdi->eeprom->cbus_function[4];
4061 case CBUS_FUNCTION_5:
4062 *value = ftdi->eeprom->cbus_function[5];
4064 case CBUS_FUNCTION_6:
4065 *value = ftdi->eeprom->cbus_function[6];
4067 case CBUS_FUNCTION_7:
4068 *value = ftdi->eeprom->cbus_function[7];
4070 case CBUS_FUNCTION_8:
4071 *value = ftdi->eeprom->cbus_function[8];
4073 case CBUS_FUNCTION_9:
4074 *value = ftdi->eeprom->cbus_function[9];
4077 *value = ftdi->eeprom->high_current;
4079 case HIGH_CURRENT_A:
4080 *value = ftdi->eeprom->high_current_a;
4082 case HIGH_CURRENT_B:
4083 *value = ftdi->eeprom->high_current_b;
4086 *value = ftdi->eeprom->invert;
4089 *value = ftdi->eeprom->group0_drive;
4091 case GROUP0_SCHMITT:
4092 *value = ftdi->eeprom->group0_schmitt;
4095 *value = ftdi->eeprom->group0_slew;
4098 *value = ftdi->eeprom->group1_drive;
4100 case GROUP1_SCHMITT:
4101 *value = ftdi->eeprom->group1_schmitt;
4104 *value = ftdi->eeprom->group1_slew;
4107 *value = ftdi->eeprom->group2_drive;
4109 case GROUP2_SCHMITT:
4110 *value = ftdi->eeprom->group2_schmitt;
4113 *value = ftdi->eeprom->group2_slew;
4116 *value = ftdi->eeprom->group3_drive;
4118 case GROUP3_SCHMITT:
4119 *value = ftdi->eeprom->group3_schmitt;
4122 *value = ftdi->eeprom->group3_slew;
4125 *value = ftdi->eeprom->powersave;
4127 case CLOCK_POLARITY:
4128 *value = ftdi->eeprom->clock_polarity;
4131 *value = ftdi->eeprom->data_order;
4134 *value = ftdi->eeprom->flow_control;
4137 *value = ftdi->eeprom->chip;
4140 *value = ftdi->eeprom->size;
4142 case EXTERNAL_OSCILLATOR:
4143 *value = ftdi->eeprom->external_oscillator;
4146 ftdi_error_return(-1, "Request for unknown EEPROM value");
4152 Set a value in the decoded EEPROM Structure
4153 No parameter checking is performed
4155 \param ftdi pointer to ftdi_context
4156 \param value_name Enum of the value to set
4160 \retval -1: Value doesn't exist
4161 \retval -2: Value not user settable
4163 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
4168 ftdi->eeprom->vendor_id = value;
4171 ftdi->eeprom->product_id = value;
4173 case RELEASE_NUMBER:
4174 ftdi->eeprom->release_number = value;
4177 ftdi->eeprom->self_powered = value;
4180 ftdi->eeprom->remote_wakeup = value;
4183 ftdi->eeprom->is_not_pnp = value;
4186 ftdi->eeprom->suspend_dbus7 = value;
4188 case IN_IS_ISOCHRONOUS:
4189 ftdi->eeprom->in_is_isochronous = value;
4191 case OUT_IS_ISOCHRONOUS:
4192 ftdi->eeprom->out_is_isochronous = value;
4194 case SUSPEND_PULL_DOWNS:
4195 ftdi->eeprom->suspend_pull_downs = value;
4198 ftdi->eeprom->use_serial = value;
4201 ftdi->eeprom->usb_version = value;
4203 case USE_USB_VERSION:
4204 ftdi->eeprom->use_usb_version = value;
4207 ftdi->eeprom->max_power = value;
4209 case CHANNEL_A_TYPE:
4210 ftdi->eeprom->channel_a_type = value;
4212 case CHANNEL_B_TYPE:
4213 ftdi->eeprom->channel_b_type = value;
4215 case CHANNEL_A_DRIVER:
4216 ftdi->eeprom->channel_a_driver = value;
4218 case CHANNEL_B_DRIVER:
4219 ftdi->eeprom->channel_b_driver = value;
4221 case CHANNEL_C_DRIVER:
4222 ftdi->eeprom->channel_c_driver = value;
4224 case CHANNEL_D_DRIVER:
4225 ftdi->eeprom->channel_d_driver = value;
4227 case CHANNEL_A_RS485:
4228 ftdi->eeprom->channel_a_rs485enable = value;
4230 case CHANNEL_B_RS485:
4231 ftdi->eeprom->channel_b_rs485enable = value;
4233 case CHANNEL_C_RS485:
4234 ftdi->eeprom->channel_c_rs485enable = value;
4236 case CHANNEL_D_RS485:
4237 ftdi->eeprom->channel_d_rs485enable = value;
4239 case CBUS_FUNCTION_0:
4240 ftdi->eeprom->cbus_function[0] = value;
4242 case CBUS_FUNCTION_1:
4243 ftdi->eeprom->cbus_function[1] = value;
4245 case CBUS_FUNCTION_2:
4246 ftdi->eeprom->cbus_function[2] = value;
4248 case CBUS_FUNCTION_3:
4249 ftdi->eeprom->cbus_function[3] = value;
4251 case CBUS_FUNCTION_4:
4252 ftdi->eeprom->cbus_function[4] = value;
4254 case CBUS_FUNCTION_5:
4255 ftdi->eeprom->cbus_function[5] = value;
4257 case CBUS_FUNCTION_6:
4258 ftdi->eeprom->cbus_function[6] = value;
4260 case CBUS_FUNCTION_7:
4261 ftdi->eeprom->cbus_function[7] = value;
4263 case CBUS_FUNCTION_8:
4264 ftdi->eeprom->cbus_function[8] = value;
4266 case CBUS_FUNCTION_9:
4267 ftdi->eeprom->cbus_function[9] = value;
4270 ftdi->eeprom->high_current = value;
4272 case HIGH_CURRENT_A:
4273 ftdi->eeprom->high_current_a = value;
4275 case HIGH_CURRENT_B:
4276 ftdi->eeprom->high_current_b = value;
4279 ftdi->eeprom->invert = value;
4282 ftdi->eeprom->group0_drive = value;
4284 case GROUP0_SCHMITT:
4285 ftdi->eeprom->group0_schmitt = value;
4288 ftdi->eeprom->group0_slew = value;
4291 ftdi->eeprom->group1_drive = value;
4293 case GROUP1_SCHMITT:
4294 ftdi->eeprom->group1_schmitt = value;
4297 ftdi->eeprom->group1_slew = value;
4300 ftdi->eeprom->group2_drive = value;
4302 case GROUP2_SCHMITT:
4303 ftdi->eeprom->group2_schmitt = value;
4306 ftdi->eeprom->group2_slew = value;
4309 ftdi->eeprom->group3_drive = value;
4311 case GROUP3_SCHMITT:
4312 ftdi->eeprom->group3_schmitt = value;
4315 ftdi->eeprom->group3_slew = value;
4318 ftdi->eeprom->chip = value;
4321 ftdi->eeprom->powersave = value;
4323 case CLOCK_POLARITY:
4324 ftdi->eeprom->clock_polarity = value;
4327 ftdi->eeprom->data_order = value;
4330 ftdi->eeprom->flow_control = value;
4333 ftdi_error_return(-2, "EEPROM Value can't be changed");
4335 case EXTERNAL_OSCILLATOR:
4336 ftdi->eeprom->external_oscillator = value;
4338 case USER_DATA_ADDR:
4339 ftdi->eeprom->user_data_addr = value;
4343 ftdi_error_return(-1, "Request to unknown EEPROM value");
4345 ftdi->eeprom->initialized_for_connected_device = 0;
4349 /** Get the read-only buffer to the binary EEPROM content
4351 \param ftdi pointer to ftdi_context
4352 \param buf buffer to receive EEPROM content
4353 \param size Size of receiving buffer
4356 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
4357 \retval -2: Not enough room to store eeprom
4359 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
4361 if (!ftdi || !(ftdi->eeprom))
4362 ftdi_error_return(-1, "No appropriate structure");
4364 if (!buf || size < ftdi->eeprom->size)
4365 ftdi_error_return(-1, "Not enough room to store eeprom");
4367 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4368 if (size > FTDI_MAX_EEPROM_SIZE)
4369 size = FTDI_MAX_EEPROM_SIZE;
4371 memcpy(buf, ftdi->eeprom->buf, size);
4376 /** Set the EEPROM content from the user-supplied prefilled buffer
4378 \param ftdi pointer to ftdi_context
4379 \param buf buffer to read EEPROM content
4380 \param size Size of buffer
4383 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
4385 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
4387 if (!ftdi || !(ftdi->eeprom) || !buf)
4388 ftdi_error_return(-1, "No appropriate structure");
4390 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4391 if (size > FTDI_MAX_EEPROM_SIZE)
4392 size = FTDI_MAX_EEPROM_SIZE;
4394 memcpy(ftdi->eeprom->buf, buf, size);
4399 /** Set the EEPROM user data content from the user-supplied prefilled buffer
4401 \param ftdi pointer to ftdi_context
4402 \param buf buffer to read EEPROM user data content
4403 \param size Size of buffer
4406 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
4408 int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size)
4410 if (!ftdi || !(ftdi->eeprom) || !buf)
4411 ftdi_error_return(-1, "No appropriate structure");
4413 ftdi->eeprom->user_data_size = size;
4414 ftdi->eeprom->user_data = buf;
4419 Read eeprom location
4421 \param ftdi pointer to ftdi_context
4422 \param eeprom_addr Address of eeprom location to be read
4423 \param eeprom_val Pointer to store read eeprom location
4426 \retval -1: read failed
4427 \retval -2: USB device unavailable
4429 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
4431 unsigned char buf[2];
4433 if (ftdi == NULL || ftdi->usb_dev == NULL)
4434 ftdi_error_return(-2, "USB device unavailable");
4436 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, buf, 2, ftdi->usb_read_timeout) != 2)
4437 ftdi_error_return(-1, "reading eeprom failed");
4439 *eeprom_val = (0xff & buf[0]) | (buf[1] << 8);
4447 \param ftdi pointer to ftdi_context
4450 \retval -1: read failed
4451 \retval -2: USB device unavailable
4453 int ftdi_read_eeprom(struct ftdi_context *ftdi)
4458 if (ftdi == NULL || ftdi->usb_dev == NULL)
4459 ftdi_error_return(-2, "USB device unavailable");
4460 buf = ftdi->eeprom->buf;
4462 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
4464 if (libusb_control_transfer(
4465 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
4466 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
4467 ftdi_error_return(-1, "reading eeprom failed");
4470 if (ftdi->type == TYPE_R)
4471 ftdi->eeprom->size = 0x80;
4472 /* Guesses size of eeprom by comparing halves
4473 - will not work with blank eeprom */
4474 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
4475 ftdi->eeprom->size = -1;
4476 else if (memcmp(buf,&buf[0x80],0x80) == 0)
4477 ftdi->eeprom->size = 0x80;
4478 else if (memcmp(buf,&buf[0x40],0x40) == 0)
4479 ftdi->eeprom->size = 0x40;
4481 ftdi->eeprom->size = 0x100;
4486 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
4487 Function is only used internally
4490 static unsigned char ftdi_read_chipid_shift(unsigned char value)
4492 return ((value & 1) << 1) |
4493 ((value & 2) << 5) |
4494 ((value & 4) >> 2) |
4495 ((value & 8) << 4) |
4496 ((value & 16) >> 1) |
4497 ((value & 32) >> 1) |
4498 ((value & 64) >> 4) |
4499 ((value & 128) >> 2);
4503 Read the FTDIChip-ID from R-type devices
4505 \param ftdi pointer to ftdi_context
4506 \param chipid Pointer to store FTDIChip-ID
4509 \retval -1: read failed
4510 \retval -2: USB device unavailable
4512 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
4514 unsigned int a = 0, b = 0;
4516 if (ftdi == NULL || ftdi->usb_dev == NULL)
4517 ftdi_error_return(-2, "USB device unavailable");
4519 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)
4521 a = a << 8 | a >> 8;
4522 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)
4524 b = b << 8 | b >> 8;
4525 a = (a << 16) | (b & 0xFFFF);
4526 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
4527 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
4528 *chipid = a ^ 0xa5f0f7d1;
4533 ftdi_error_return(-1, "read of FTDIChip-ID failed");
4537 Write eeprom location
4539 \param ftdi pointer to ftdi_context
4540 \param eeprom_addr Address of eeprom location to be written
4541 \param eeprom_val Value to be written
4544 \retval -1: write failed
4545 \retval -2: USB device unavailable
4546 \retval -3: Invalid access to checksum protected area below 0x80
4547 \retval -4: Device can't access unprotected area
4548 \retval -5: Reading chip type failed
4550 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
4551 unsigned short eeprom_val)
4553 int chip_type_location;
4554 unsigned short chip_type;
4556 if (ftdi == NULL || ftdi->usb_dev == NULL)
4557 ftdi_error_return(-2, "USB device unavailable");
4559 if (eeprom_addr <0x80)
4560 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
4567 chip_type_location = 0x14;
4571 chip_type_location = 0x18;
4574 chip_type_location = 0x1e;
4577 ftdi_error_return(-4, "Device can't access unprotected area");
4580 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
4581 ftdi_error_return(-5, "Reading failed");
4582 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
4583 if ((chip_type & 0xff) != 0x66)
4585 ftdi_error_return(-6, "EEPROM is not of 93x66");
4588 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4589 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
4590 NULL, 0, ftdi->usb_write_timeout) != 0)
4591 ftdi_error_return(-1, "unable to write eeprom");
4599 \param ftdi pointer to ftdi_context
4602 \retval -1: read failed
4603 \retval -2: USB device unavailable
4604 \retval -3: EEPROM not initialized for the connected device;
4606 int ftdi_write_eeprom(struct ftdi_context *ftdi)
4608 unsigned short usb_val, status;
4610 unsigned char *eeprom;
4612 if (ftdi == NULL || ftdi->usb_dev == NULL)
4613 ftdi_error_return(-2, "USB device unavailable");
4615 if(ftdi->eeprom->initialized_for_connected_device == 0)
4616 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
4618 eeprom = ftdi->eeprom->buf;
4620 /* These commands were traced while running MProg */
4621 if ((ret = ftdi_usb_reset(ftdi)) != 0)
4623 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
4625 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
4628 for (i = 0; i < ftdi->eeprom->size/2; i++)
4630 /* Do not try to write to reserved area */
4631 if ((ftdi->type == TYPE_230X) && (i == 0x40))
4635 usb_val = eeprom[i*2];
4636 usb_val += eeprom[(i*2)+1] << 8;
4637 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4638 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
4639 NULL, 0, ftdi->usb_write_timeout) < 0)
4640 ftdi_error_return(-1, "unable to write eeprom");
4649 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
4651 \param ftdi pointer to ftdi_context
4654 \retval -1: erase failed
4655 \retval -2: USB device unavailable
4656 \retval -3: Writing magic failed
4657 \retval -4: Read EEPROM failed
4658 \retval -5: Unexpected EEPROM value
4660 #define MAGIC 0x55aa
4661 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
4663 unsigned short eeprom_value;
4664 if (ftdi == NULL || ftdi->usb_dev == NULL)
4665 ftdi_error_return(-2, "USB device unavailable");
4667 if ((ftdi->type == TYPE_R) || (ftdi->type == TYPE_230X))
4669 ftdi->eeprom->chip = 0;
4673 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
4674 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4675 ftdi_error_return(-1, "unable to erase eeprom");
4678 /* detect chip type by writing 0x55AA as magic at word position 0xc0
4679 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
4680 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
4681 Chip is 93x66 if magic is only read at word position 0xc0*/
4682 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4683 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
4684 NULL, 0, ftdi->usb_write_timeout) != 0)
4685 ftdi_error_return(-3, "Writing magic failed");
4686 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
4687 ftdi_error_return(-4, "Reading failed");
4688 if (eeprom_value == MAGIC)
4690 ftdi->eeprom->chip = 0x46;
4694 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
4695 ftdi_error_return(-4, "Reading failed");
4696 if (eeprom_value == MAGIC)
4697 ftdi->eeprom->chip = 0x56;
4700 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
4701 ftdi_error_return(-4, "Reading failed");
4702 if (eeprom_value == MAGIC)
4703 ftdi->eeprom->chip = 0x66;
4706 ftdi->eeprom->chip = -1;
4710 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
4711 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4712 ftdi_error_return(-1, "unable to erase eeprom");
4717 Get string representation for last error code
4719 \param ftdi pointer to ftdi_context
4721 \retval Pointer to error string
4723 const char *ftdi_get_error_string (struct ftdi_context *ftdi)
4728 return ftdi->error_str;
4731 /* @} end of doxygen libftdi group */