1 /***************************************************************************
5 copyright : (C) 2003-2014 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
15 ***************************************************************************/
18 \mainpage libftdi API documentation
20 Library to talk to FTDI chips. You find the latest versions of libftdi at
21 http://www.intra2net.com/en/developer/libftdi/
23 The library is easy to use. Have a look at this short example:
26 More examples can be found in the "examples" directory.
28 /** \addtogroup libftdi */
39 #include "ftdi_version_i.h"
41 #define ftdi_error_return(code, str) do { \
43 ftdi->error_str = str; \
45 fprintf(stderr, str); \
49 #define ftdi_error_return_free_device_list(code, str, devs) do { \
50 libusb_free_device_list(devs,1); \
51 ftdi->error_str = str; \
57 Internal function to close usb device pointer.
58 Sets ftdi->usb_dev to NULL.
61 \param ftdi pointer to ftdi_context
65 static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
67 if (ftdi && ftdi->usb_dev)
69 libusb_close (ftdi->usb_dev);
72 ftdi->eeprom->initialized_for_connected_device = 0;
77 Initializes a ftdi_context.
79 \param ftdi pointer to ftdi_context
82 \retval -1: couldn't allocate read buffer
83 \retval -2: couldn't allocate struct buffer
84 \retval -3: libusb_init() failed
86 \remark This should be called before all functions
88 int ftdi_init(struct ftdi_context *ftdi)
90 struct ftdi_eeprom* eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
93 ftdi->usb_read_timeout = 5000;
94 ftdi->usb_write_timeout = 5000;
96 ftdi->type = TYPE_BM; /* chip type */
98 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
100 ftdi->readbuffer = NULL;
101 ftdi->readbuffer_offset = 0;
102 ftdi->readbuffer_remaining = 0;
103 ftdi->writebuffer_chunksize = 4096;
104 ftdi->max_packet_size = 0;
105 ftdi->error_str = NULL;
106 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
108 if (libusb_init(&ftdi->usb_ctx) < 0)
109 ftdi_error_return(-3, "libusb_init() failed");
111 ftdi_set_interface(ftdi, INTERFACE_ANY);
112 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
115 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
116 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
117 ftdi->eeprom = eeprom;
119 /* All fine. Now allocate the readbuffer */
120 return ftdi_read_data_set_chunksize(ftdi, 4096);
124 Allocate and initialize a new ftdi_context
126 \return a pointer to a new ftdi_context, or NULL on failure
128 struct ftdi_context *ftdi_new(void)
130 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
137 if (ftdi_init(ftdi) != 0)
147 Open selected channels on a chip, otherwise use first channel.
149 \param ftdi pointer to ftdi_context
150 \param interface Interface to use for FT2232C/2232H/4232H chips.
153 \retval -1: unknown interface
154 \retval -2: USB device unavailable
155 \retval -3: Device already open, interface can't be set in that state
157 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
160 ftdi_error_return(-2, "USB device unavailable");
162 if (ftdi->usb_dev != NULL)
164 int check_interface = interface;
165 if (check_interface == INTERFACE_ANY)
166 check_interface = INTERFACE_A;
168 if (ftdi->index != check_interface)
169 ftdi_error_return(-3, "Interface can not be changed on an already open device");
177 ftdi->index = INTERFACE_A;
183 ftdi->index = INTERFACE_B;
189 ftdi->index = INTERFACE_C;
195 ftdi->index = INTERFACE_D;
200 ftdi_error_return(-1, "Unknown interface");
206 Deinitializes a ftdi_context.
208 \param ftdi pointer to ftdi_context
210 void ftdi_deinit(struct ftdi_context *ftdi)
215 ftdi_usb_close_internal (ftdi);
217 if (ftdi->readbuffer != NULL)
219 free(ftdi->readbuffer);
220 ftdi->readbuffer = NULL;
223 if (ftdi->eeprom != NULL)
225 if (ftdi->eeprom->manufacturer != 0)
227 free(ftdi->eeprom->manufacturer);
228 ftdi->eeprom->manufacturer = 0;
230 if (ftdi->eeprom->product != 0)
232 free(ftdi->eeprom->product);
233 ftdi->eeprom->product = 0;
235 if (ftdi->eeprom->serial != 0)
237 free(ftdi->eeprom->serial);
238 ftdi->eeprom->serial = 0;
246 libusb_exit(ftdi->usb_ctx);
247 ftdi->usb_ctx = NULL;
252 Deinitialize and free an ftdi_context.
254 \param ftdi pointer to ftdi_context
256 void ftdi_free(struct ftdi_context *ftdi)
263 Use an already open libusb device.
265 \param ftdi pointer to ftdi_context
266 \param usb libusb libusb_device_handle to use
268 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
277 * @brief Get libftdi library version
279 * @return ftdi_version_info Library version information
281 struct ftdi_version_info ftdi_get_library_version(void)
283 struct ftdi_version_info ver;
285 ver.major = FTDI_MAJOR_VERSION;
286 ver.minor = FTDI_MINOR_VERSION;
287 ver.micro = FTDI_MICRO_VERSION;
288 ver.version_str = FTDI_VERSION_STRING;
289 ver.snapshot_str = FTDI_SNAPSHOT_VERSION;
295 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
296 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
297 use. With VID:PID 0:0, search for the default devices
298 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014, 0x403:0x6015)
300 \param ftdi pointer to ftdi_context
301 \param devlist Pointer where to store list of found devices
302 \param vendor Vendor ID to search for
303 \param product Product ID to search for
305 \retval >0: number of devices found
306 \retval -3: out of memory
307 \retval -5: libusb_get_device_list() failed
308 \retval -6: libusb_get_device_descriptor() failed
310 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
312 struct ftdi_device_list **curdev;
314 libusb_device **devs;
318 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
319 ftdi_error_return(-5, "libusb_get_device_list() failed");
324 while ((dev = devs[i++]) != NULL)
326 struct libusb_device_descriptor desc;
328 if (libusb_get_device_descriptor(dev, &desc) < 0)
329 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
331 if (((vendor || product) &&
332 desc.idVendor == vendor && desc.idProduct == product) ||
333 (!(vendor || product) &&
334 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
335 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014
336 || desc.idProduct == 0x6015)))
338 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
340 ftdi_error_return_free_device_list(-3, "out of memory", devs);
342 (*curdev)->next = NULL;
343 (*curdev)->dev = dev;
344 libusb_ref_device(dev);
345 curdev = &(*curdev)->next;
349 libusb_free_device_list(devs,1);
354 Frees a usb device list.
356 \param devlist USB device list created by ftdi_usb_find_all()
358 void ftdi_list_free(struct ftdi_device_list **devlist)
360 struct ftdi_device_list *curdev, *next;
362 for (curdev = *devlist; curdev != NULL;)
365 libusb_unref_device(curdev->dev);
374 Frees a usb device list.
376 \param devlist USB device list created by ftdi_usb_find_all()
378 void ftdi_list_free2(struct ftdi_device_list *devlist)
380 ftdi_list_free(&devlist);
384 Return device ID strings from the usb device.
386 The parameters manufacturer, description and serial may be NULL
387 or pointer to buffers to store the fetched strings.
389 \note Use this function only in combination with ftdi_usb_find_all()
390 as it closes the internal "usb_dev" after use.
392 \param ftdi pointer to ftdi_context
393 \param dev libusb usb_dev to use
394 \param manufacturer Store manufacturer string here if not NULL
395 \param mnf_len Buffer size of manufacturer string
396 \param description Store product description string here if not NULL
397 \param desc_len Buffer size of product description string
398 \param serial Store serial string here if not NULL
399 \param serial_len Buffer size of serial string
402 \retval -1: wrong arguments
403 \retval -4: unable to open device
404 \retval -7: get product manufacturer failed
405 \retval -8: get product description failed
406 \retval -9: get serial number failed
407 \retval -11: libusb_get_device_descriptor() failed
409 int ftdi_usb_get_strings(struct ftdi_context *ftdi,
410 struct libusb_device *dev,
411 char *manufacturer, int mnf_len,
412 char *description, int desc_len,
413 char *serial, int serial_len)
417 if ((ftdi==NULL) || (dev==NULL))
420 if (ftdi->usb_dev == NULL && libusb_open(dev, &ftdi->usb_dev) < 0)
421 ftdi_error_return(-4, "libusb_open() failed");
423 // ftdi->usb_dev will not be NULL when entering ftdi_usb_get_strings2(), so
424 // it won't be closed either. This allows us to close it whether we actually
425 // called libusb_open() up above or not. This matches the expected behavior
426 // (and note) for ftdi_usb_get_strings().
427 ret = ftdi_usb_get_strings2(ftdi, dev,
428 manufacturer, mnf_len,
429 description, desc_len,
432 // only close it if it was successful, as all other return codes close
433 // before returning already.
435 ftdi_usb_close_internal(ftdi);
441 Return device ID strings from the usb device.
443 The parameters manufacturer, description and serial may be NULL
444 or pointer to buffers to store the fetched strings.
446 \note The old function ftdi_usb_get_strings() always closes the device.
447 This version only closes the device if it was opened by it.
449 \param ftdi pointer to ftdi_context
450 \param dev libusb usb_dev to use
451 \param manufacturer Store manufacturer string here if not NULL
452 \param mnf_len Buffer size of manufacturer string
453 \param description Store product description string here if not NULL
454 \param desc_len Buffer size of product description string
455 \param serial Store serial string here if not NULL
456 \param serial_len Buffer size of serial string
459 \retval -1: wrong arguments
460 \retval -4: unable to open device
461 \retval -7: get product manufacturer failed
462 \retval -8: get product description failed
463 \retval -9: get serial number failed
464 \retval -11: libusb_get_device_descriptor() failed
466 int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev,
467 char *manufacturer, int mnf_len,
468 char *description, int desc_len,
469 char *serial, int serial_len)
471 struct libusb_device_descriptor desc;
473 if ((ftdi==NULL) || (dev==NULL))
476 char need_open = (ftdi->usb_dev == NULL);
477 if (need_open && libusb_open(dev, &ftdi->usb_dev) < 0)
478 ftdi_error_return(-4, "libusb_open() failed");
480 if (libusb_get_device_descriptor(dev, &desc) < 0)
481 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
483 if (manufacturer != NULL)
485 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
487 ftdi_usb_close_internal (ftdi);
488 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
492 if (description != NULL)
494 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
496 ftdi_usb_close_internal (ftdi);
497 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
503 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
505 ftdi_usb_close_internal (ftdi);
506 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
511 ftdi_usb_close_internal (ftdi);
517 * Internal function to determine the maximum packet size.
518 * \param ftdi pointer to ftdi_context
519 * \param dev libusb usb_dev to use
520 * \retval Maximum packet size for this device
522 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
524 struct libusb_device_descriptor desc;
525 struct libusb_config_descriptor *config0;
526 unsigned int packet_size;
529 if (ftdi == NULL || dev == NULL)
532 // Determine maximum packet size. Init with default value.
533 // New hi-speed devices from FTDI use a packet size of 512 bytes
534 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
535 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
540 if (libusb_get_device_descriptor(dev, &desc) < 0)
543 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
546 if (desc.bNumConfigurations > 0)
548 if (ftdi->interface < config0->bNumInterfaces)
550 struct libusb_interface interface = config0->interface[ftdi->interface];
551 if (interface.num_altsetting > 0)
553 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
554 if (descriptor.bNumEndpoints > 0)
556 packet_size = descriptor.endpoint[0].wMaxPacketSize;
562 libusb_free_config_descriptor (config0);
567 Opens a ftdi device given by an usb_device.
569 \param ftdi pointer to ftdi_context
570 \param dev libusb usb_dev to use
573 \retval -3: unable to config device
574 \retval -4: unable to open device
575 \retval -5: unable to claim device
576 \retval -6: reset failed
577 \retval -7: set baudrate failed
578 \retval -8: ftdi context invalid
579 \retval -9: libusb_get_device_descriptor() failed
580 \retval -10: libusb_get_config_descriptor() failed
581 \retval -11: libusb_detach_kernel_driver() failed
582 \retval -12: libusb_get_configuration() failed
584 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
586 struct libusb_device_descriptor desc;
587 struct libusb_config_descriptor *config0;
588 int cfg, cfg0, detach_errno = 0;
591 ftdi_error_return(-8, "ftdi context invalid");
593 if (libusb_open(dev, &ftdi->usb_dev) < 0)
594 ftdi_error_return(-4, "libusb_open() failed");
596 if (libusb_get_device_descriptor(dev, &desc) < 0)
597 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
599 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
600 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
601 cfg0 = config0->bConfigurationValue;
602 libusb_free_config_descriptor (config0);
604 // Try to detach ftdi_sio kernel module.
606 // The return code is kept in a separate variable and only parsed
607 // if usb_set_configuration() or usb_claim_interface() fails as the
608 // detach operation might be denied and everything still works fine.
609 // Likely scenario is a static ftdi_sio kernel module.
610 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
612 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
613 detach_errno = errno;
616 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
617 ftdi_error_return(-12, "libusb_get_configuration () failed");
618 // set configuration (needed especially for windows)
619 // tolerate EBUSY: one device with one configuration, but two interfaces
620 // and libftdi sessions to both interfaces (e.g. FT2232)
621 if (desc.bNumConfigurations > 0 && cfg != cfg0)
623 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
625 ftdi_usb_close_internal (ftdi);
626 if (detach_errno == EPERM)
628 ftdi_error_return(-8, "inappropriate permissions on device!");
632 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
637 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
639 ftdi_usb_close_internal (ftdi);
640 if (detach_errno == EPERM)
642 ftdi_error_return(-8, "inappropriate permissions on device!");
646 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
650 if (ftdi_usb_reset (ftdi) != 0)
652 ftdi_usb_close_internal (ftdi);
653 ftdi_error_return(-6, "ftdi_usb_reset failed");
656 // Try to guess chip type
657 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
658 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
659 && desc.iSerialNumber == 0))
660 ftdi->type = TYPE_BM;
661 else if (desc.bcdDevice == 0x200)
662 ftdi->type = TYPE_AM;
663 else if (desc.bcdDevice == 0x500)
664 ftdi->type = TYPE_2232C;
665 else if (desc.bcdDevice == 0x600)
667 else if (desc.bcdDevice == 0x700)
668 ftdi->type = TYPE_2232H;
669 else if (desc.bcdDevice == 0x800)
670 ftdi->type = TYPE_4232H;
671 else if (desc.bcdDevice == 0x900)
672 ftdi->type = TYPE_232H;
673 else if (desc.bcdDevice == 0x1000)
674 ftdi->type = TYPE_230X;
676 // Determine maximum packet size
677 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
679 if (ftdi_set_baudrate (ftdi, 9600) != 0)
681 ftdi_usb_close_internal (ftdi);
682 ftdi_error_return(-7, "set baudrate failed");
685 ftdi_error_return(0, "all fine");
689 Opens the first device with a given vendor and product ids.
691 \param ftdi pointer to ftdi_context
692 \param vendor Vendor ID
693 \param product Product ID
695 \retval same as ftdi_usb_open_desc()
697 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
699 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
703 Opens the first device with a given, vendor id, product id,
704 description and serial.
706 \param ftdi pointer to ftdi_context
707 \param vendor Vendor ID
708 \param product Product ID
709 \param description Description to search for. Use NULL if not needed.
710 \param serial Serial to search for. Use NULL if not needed.
713 \retval -3: usb device not found
714 \retval -4: unable to open device
715 \retval -5: unable to claim device
716 \retval -6: reset failed
717 \retval -7: set baudrate failed
718 \retval -8: get product description failed
719 \retval -9: get serial number failed
720 \retval -12: libusb_get_device_list() failed
721 \retval -13: libusb_get_device_descriptor() failed
723 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
724 const char* description, const char* serial)
726 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
730 Opens the index-th device with a given, vendor id, product id,
731 description and serial.
733 \param ftdi pointer to ftdi_context
734 \param vendor Vendor ID
735 \param product Product ID
736 \param description Description to search for. Use NULL if not needed.
737 \param serial Serial to search for. Use NULL if not needed.
738 \param index Number of matching device to open if there are more than one, starts with 0.
741 \retval -1: usb_find_busses() failed
742 \retval -2: usb_find_devices() failed
743 \retval -3: usb device not found
744 \retval -4: unable to open device
745 \retval -5: unable to claim device
746 \retval -6: reset failed
747 \retval -7: set baudrate failed
748 \retval -8: get product description failed
749 \retval -9: get serial number failed
750 \retval -10: unable to close device
751 \retval -11: ftdi context invalid
753 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
754 const char* description, const char* serial, unsigned int index)
757 libusb_device **devs;
762 ftdi_error_return(-11, "ftdi context invalid");
764 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
765 ftdi_error_return(-12, "libusb_get_device_list() failed");
767 while ((dev = devs[i++]) != NULL)
769 struct libusb_device_descriptor desc;
772 if (libusb_get_device_descriptor(dev, &desc) < 0)
773 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
775 if (desc.idVendor == vendor && desc.idProduct == product)
777 if (libusb_open(dev, &ftdi->usb_dev) < 0)
778 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
780 if (description != NULL)
782 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
784 ftdi_usb_close_internal (ftdi);
785 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
787 if (strncmp(string, description, sizeof(string)) != 0)
789 ftdi_usb_close_internal (ftdi);
795 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
797 ftdi_usb_close_internal (ftdi);
798 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
800 if (strncmp(string, serial, sizeof(string)) != 0)
802 ftdi_usb_close_internal (ftdi);
807 ftdi_usb_close_internal (ftdi);
815 res = ftdi_usb_open_dev(ftdi, dev);
816 libusb_free_device_list(devs,1);
822 ftdi_error_return_free_device_list(-3, "device not found", devs);
826 Opens the ftdi-device described by a description-string.
827 Intended to be used for parsing a device-description given as commandline argument.
829 \param ftdi pointer to ftdi_context
830 \param description NULL-terminated description-string, using this format:
831 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
832 \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")
833 \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
834 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
836 \note The description format may be extended in later versions.
839 \retval -2: libusb_get_device_list() failed
840 \retval -3: usb device not found
841 \retval -4: unable to open device
842 \retval -5: unable to claim device
843 \retval -6: reset failed
844 \retval -7: set baudrate failed
845 \retval -8: get product description failed
846 \retval -9: get serial number failed
847 \retval -10: unable to close device
848 \retval -11: illegal description format
849 \retval -12: ftdi context invalid
851 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
854 ftdi_error_return(-12, "ftdi context invalid");
856 if (description[0] == 0 || description[1] != ':')
857 ftdi_error_return(-11, "illegal description format");
859 if (description[0] == 'd')
862 libusb_device **devs;
863 unsigned int bus_number, device_address;
866 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
867 ftdi_error_return(-2, "libusb_get_device_list() failed");
869 /* XXX: This doesn't handle symlinks/odd paths/etc... */
870 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
871 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
873 while ((dev = devs[i++]) != NULL)
876 if (bus_number == libusb_get_bus_number (dev)
877 && device_address == libusb_get_device_address (dev))
879 ret = ftdi_usb_open_dev(ftdi, dev);
880 libusb_free_device_list(devs,1);
886 ftdi_error_return_free_device_list(-3, "device not found", devs);
888 else if (description[0] == 'i' || description[0] == 's')
891 unsigned int product;
892 unsigned int index=0;
893 const char *serial=NULL;
894 const char *startp, *endp;
897 startp=description+2;
898 vendor=strtoul((char*)startp,(char**)&endp,0);
899 if (*endp != ':' || endp == startp || errno != 0)
900 ftdi_error_return(-11, "illegal description format");
903 product=strtoul((char*)startp,(char**)&endp,0);
904 if (endp == startp || errno != 0)
905 ftdi_error_return(-11, "illegal description format");
907 if (description[0] == 'i' && *endp != 0)
909 /* optional index field in i-mode */
911 ftdi_error_return(-11, "illegal description format");
914 index=strtoul((char*)startp,(char**)&endp,0);
915 if (*endp != 0 || endp == startp || errno != 0)
916 ftdi_error_return(-11, "illegal description format");
918 if (description[0] == 's')
921 ftdi_error_return(-11, "illegal description format");
923 /* rest of the description is the serial */
927 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
931 ftdi_error_return(-11, "illegal description format");
936 Resets the ftdi device.
938 \param ftdi pointer to ftdi_context
941 \retval -1: FTDI reset failed
942 \retval -2: USB device unavailable
944 int ftdi_usb_reset(struct ftdi_context *ftdi)
946 if (ftdi == NULL || ftdi->usb_dev == NULL)
947 ftdi_error_return(-2, "USB device unavailable");
949 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
950 SIO_RESET_REQUEST, SIO_RESET_SIO,
951 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
952 ftdi_error_return(-1,"FTDI reset failed");
954 // Invalidate data in the readbuffer
955 ftdi->readbuffer_offset = 0;
956 ftdi->readbuffer_remaining = 0;
962 Clears the read buffer on the chip and the internal read buffer.
964 \param ftdi pointer to ftdi_context
967 \retval -1: read buffer purge failed
968 \retval -2: USB device unavailable
970 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
972 if (ftdi == NULL || ftdi->usb_dev == NULL)
973 ftdi_error_return(-2, "USB device unavailable");
975 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
976 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
977 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
978 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
980 // Invalidate data in the readbuffer
981 ftdi->readbuffer_offset = 0;
982 ftdi->readbuffer_remaining = 0;
988 Clears the write buffer on the chip.
990 \param ftdi pointer to ftdi_context
993 \retval -1: write buffer purge failed
994 \retval -2: USB device unavailable
996 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
998 if (ftdi == NULL || ftdi->usb_dev == NULL)
999 ftdi_error_return(-2, "USB device unavailable");
1001 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1002 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
1003 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1004 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
1010 Clears the buffers on the chip and the internal read buffer.
1012 \param ftdi pointer to ftdi_context
1015 \retval -1: read buffer purge failed
1016 \retval -2: write buffer purge failed
1017 \retval -3: USB device unavailable
1019 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
1023 if (ftdi == NULL || ftdi->usb_dev == NULL)
1024 ftdi_error_return(-3, "USB device unavailable");
1026 result = ftdi_usb_purge_rx_buffer(ftdi);
1030 result = ftdi_usb_purge_tx_buffer(ftdi);
1040 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
1042 \param ftdi pointer to ftdi_context
1045 \retval -1: usb_release failed
1046 \retval -3: ftdi context invalid
1048 int ftdi_usb_close(struct ftdi_context *ftdi)
1053 ftdi_error_return(-3, "ftdi context invalid");
1055 if (ftdi->usb_dev != NULL)
1056 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
1059 ftdi_usb_close_internal (ftdi);
1064 /* ftdi_to_clkbits_AM For the AM device, convert a requested baudrate
1065 to encoded divisor and the achievable baudrate
1066 Function is only used internally
1073 From /2, 0.125/ 0.25 and 0.5 steps may be taken
1074 The fractional part has frac_code encoding
1076 static int ftdi_to_clkbits_AM(int baudrate, unsigned long *encoded_divisor)
1079 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1080 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
1081 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
1082 int divisor, best_divisor, best_baud, best_baud_diff;
1084 divisor = 24000000 / baudrate;
1086 // Round down to supported fraction (AM only)
1087 divisor -= am_adjust_dn[divisor & 7];
1089 // Try this divisor and the one above it (because division rounds down)
1093 for (i = 0; i < 2; i++)
1095 int try_divisor = divisor + i;
1099 // Round up to supported divisor value
1100 if (try_divisor <= 8)
1102 // Round up to minimum supported divisor
1105 else if (divisor < 16)
1107 // AM doesn't support divisors 9 through 15 inclusive
1112 // Round up to supported fraction (AM only)
1113 try_divisor += am_adjust_up[try_divisor & 7];
1114 if (try_divisor > 0x1FFF8)
1116 // Round down to maximum supported divisor value (for AM)
1117 try_divisor = 0x1FFF8;
1120 // Get estimated baud rate (to nearest integer)
1121 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1122 // Get absolute difference from requested baud rate
1123 if (baud_estimate < baudrate)
1125 baud_diff = baudrate - baud_estimate;
1129 baud_diff = baud_estimate - baudrate;
1131 if (i == 0 || baud_diff < best_baud_diff)
1133 // Closest to requested baud rate so far
1134 best_divisor = try_divisor;
1135 best_baud = baud_estimate;
1136 best_baud_diff = baud_diff;
1139 // Spot on! No point trying
1144 // Encode the best divisor value
1145 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1146 // Deal with special cases for encoded value
1147 if (*encoded_divisor == 1)
1149 *encoded_divisor = 0; // 3000000 baud
1151 else if (*encoded_divisor == 0x4001)
1153 *encoded_divisor = 1; // 2000000 baud (BM only)
1158 /* ftdi_to_clkbits Convert a requested baudrate for a given system clock and predivisor
1159 to encoded divisor and the achievable baudrate
1160 Function is only used internally
1167 From /2, 0.125 steps may be taken.
1168 The fractional part has frac_code encoding
1170 value[13:0] of value is the divisor
1171 index[9] mean 12 MHz Base(120 MHz/10) rate versus 3 MHz (48 MHz/16) else
1173 H Type have all features above with
1174 {index[8],value[15:14]} is the encoded subdivisor
1176 FT232R, FT2232 and FT232BM have no option for 12 MHz and with
1177 {index[0],value[15:14]} is the encoded subdivisor
1179 AM Type chips have only four fractional subdivisors at value[15:14]
1180 for subdivisors 0, 0.5, 0.25, 0.125
1182 static int ftdi_to_clkbits(int baudrate, unsigned int clk, int clk_div, unsigned long *encoded_divisor)
1184 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1186 int divisor, best_divisor;
1187 if (baudrate >= clk/clk_div)
1189 *encoded_divisor = 0;
1190 best_baud = clk/clk_div;
1192 else if (baudrate >= clk/(clk_div + clk_div/2))
1194 *encoded_divisor = 1;
1195 best_baud = clk/(clk_div + clk_div/2);
1197 else if (baudrate >= clk/(2*clk_div))
1199 *encoded_divisor = 2;
1200 best_baud = clk/(2*clk_div);
1204 /* We divide by 16 to have 3 fractional bits and one bit for rounding */
1205 divisor = clk*16/clk_div / baudrate;
1206 if (divisor & 1) /* Decide if to round up or down*/
1207 best_divisor = divisor /2 +1;
1209 best_divisor = divisor/2;
1210 if(best_divisor > 0x20000)
1211 best_divisor = 0x1ffff;
1212 best_baud = clk*16/clk_div/best_divisor;
1213 if (best_baud & 1) /* Decide if to round up or down*/
1214 best_baud = best_baud /2 +1;
1216 best_baud = best_baud /2;
1217 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 0x7] << 14);
1222 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
1223 Function is only used internally
1226 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
1227 unsigned short *value, unsigned short *index)
1230 unsigned long encoded_divisor;
1238 #define H_CLK 120000000
1239 #define C_CLK 48000000
1240 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H) || (ftdi->type == TYPE_232H))
1242 if(baudrate*10 > H_CLK /0x3fff)
1244 /* On H Devices, use 12 000 000 Baudrate when possible
1245 We have a 14 bit divisor, a 1 bit divisor switch (10 or 16)
1246 three fractional bits and a 120 MHz clock
1247 Assume AN_120 "Sub-integer divisors between 0 and 2 are not allowed" holds for
1248 DIV/10 CLK too, so /1, /1.5 and /2 can be handled the same*/
1249 best_baud = ftdi_to_clkbits(baudrate, H_CLK, 10, &encoded_divisor);
1250 encoded_divisor |= 0x20000; /* switch on CLK/10*/
1253 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1255 else if ((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C) || (ftdi->type == TYPE_R ))
1257 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1261 best_baud = ftdi_to_clkbits_AM(baudrate, &encoded_divisor);
1263 // Split into "value" and "index" values
1264 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1265 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
1267 *index = (unsigned short)(encoded_divisor >> 8);
1269 *index |= ftdi->index;
1272 *index = (unsigned short)(encoded_divisor >> 16);
1274 // Return the nearest baud rate
1279 * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test
1280 * Do not use, it's only for the unit test framework
1282 int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi,
1283 unsigned short *value, unsigned short *index)
1285 return ftdi_convert_baudrate(baudrate, ftdi, value, index);
1289 Sets the chip baud rate
1291 \param ftdi pointer to ftdi_context
1292 \param baudrate baud rate to set
1295 \retval -1: invalid baudrate
1296 \retval -2: setting baudrate failed
1297 \retval -3: USB device unavailable
1299 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1301 unsigned short value, index;
1302 int actual_baudrate;
1304 if (ftdi == NULL || ftdi->usb_dev == NULL)
1305 ftdi_error_return(-3, "USB device unavailable");
1307 if (ftdi->bitbang_enabled)
1309 baudrate = baudrate*4;
1312 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1313 if (actual_baudrate <= 0)
1314 ftdi_error_return (-1, "Silly baudrate <= 0.");
1316 // Check within tolerance (about 5%)
1317 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1318 || ((actual_baudrate < baudrate)
1319 ? (actual_baudrate * 21 < baudrate * 20)
1320 : (baudrate * 21 < actual_baudrate * 20)))
1321 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1323 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1324 SIO_SET_BAUDRATE_REQUEST, value,
1325 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1326 ftdi_error_return (-2, "Setting new baudrate failed");
1328 ftdi->baudrate = baudrate;
1333 Set (RS232) line characteristics.
1334 The break type can only be set via ftdi_set_line_property2()
1335 and defaults to "off".
1337 \param ftdi pointer to ftdi_context
1338 \param bits Number of bits
1339 \param sbit Number of stop bits
1340 \param parity Parity mode
1343 \retval -1: Setting line property failed
1345 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1346 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1348 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1352 Set (RS232) line characteristics
1354 \param ftdi pointer to ftdi_context
1355 \param bits Number of bits
1356 \param sbit Number of stop bits
1357 \param parity Parity mode
1358 \param break_type Break type
1361 \retval -1: Setting line property failed
1362 \retval -2: USB device unavailable
1364 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1365 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1366 enum ftdi_break_type break_type)
1368 unsigned short value = bits;
1370 if (ftdi == NULL || ftdi->usb_dev == NULL)
1371 ftdi_error_return(-2, "USB device unavailable");
1376 value |= (0x00 << 8);
1379 value |= (0x01 << 8);
1382 value |= (0x02 << 8);
1385 value |= (0x03 << 8);
1388 value |= (0x04 << 8);
1395 value |= (0x00 << 11);
1398 value |= (0x01 << 11);
1401 value |= (0x02 << 11);
1408 value |= (0x00 << 14);
1411 value |= (0x01 << 14);
1415 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1416 SIO_SET_DATA_REQUEST, value,
1417 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1418 ftdi_error_return (-1, "Setting new line property failed");
1424 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1426 \param ftdi pointer to ftdi_context
1427 \param buf Buffer with the data
1428 \param size Size of the buffer
1430 \retval -666: USB device unavailable
1431 \retval <0: error code from usb_bulk_write()
1432 \retval >0: number of bytes written
1434 int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size)
1439 if (ftdi == NULL || ftdi->usb_dev == NULL)
1440 ftdi_error_return(-666, "USB device unavailable");
1442 while (offset < size)
1444 int write_size = ftdi->writebuffer_chunksize;
1446 if (offset+write_size > size)
1447 write_size = size-offset;
1449 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, (unsigned char *)buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1450 ftdi_error_return(-1, "usb bulk write failed");
1452 offset += actual_length;
1458 static void LIBUSB_CALL ftdi_read_data_cb(struct libusb_transfer *transfer)
1460 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1461 struct ftdi_context *ftdi = tc->ftdi;
1462 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1464 packet_size = ftdi->max_packet_size;
1466 actual_length = transfer->actual_length;
1468 if (actual_length > 2)
1470 // skip FTDI status bytes.
1471 // Maybe stored in the future to enable modem use
1472 num_of_chunks = actual_length / packet_size;
1473 chunk_remains = actual_length % packet_size;
1474 //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);
1476 ftdi->readbuffer_offset += 2;
1479 if (actual_length > packet_size - 2)
1481 for (i = 1; i < num_of_chunks; i++)
1482 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1483 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1485 if (chunk_remains > 2)
1487 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1488 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1490 actual_length -= 2*num_of_chunks;
1493 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1496 if (actual_length > 0)
1498 // data still fits in buf?
1499 if (tc->offset + actual_length <= tc->size)
1501 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1502 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1503 tc->offset += actual_length;
1505 ftdi->readbuffer_offset = 0;
1506 ftdi->readbuffer_remaining = 0;
1508 /* Did we read exactly the right amount of bytes? */
1509 if (tc->offset == tc->size)
1511 //printf("read_data exact rem %d offset %d\n",
1512 //ftdi->readbuffer_remaining, offset);
1519 // only copy part of the data or size <= readbuffer_chunksize
1520 int part_size = tc->size - tc->offset;
1521 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1522 tc->offset += part_size;
1524 ftdi->readbuffer_offset += part_size;
1525 ftdi->readbuffer_remaining = actual_length - part_size;
1527 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1528 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1535 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1536 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1539 ret = libusb_submit_transfer (transfer);
1546 static void LIBUSB_CALL ftdi_write_data_cb(struct libusb_transfer *transfer)
1548 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1549 struct ftdi_context *ftdi = tc->ftdi;
1551 tc->offset += transfer->actual_length;
1553 if (tc->offset == tc->size)
1559 int write_size = ftdi->writebuffer_chunksize;
1562 if (tc->offset + write_size > tc->size)
1563 write_size = tc->size - tc->offset;
1565 transfer->length = write_size;
1566 transfer->buffer = tc->buf + tc->offset;
1568 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1569 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1572 ret = libusb_submit_transfer (transfer);
1581 Writes data to the chip. Does not wait for completion of the transfer
1582 nor does it make sure that the transfer was successful.
1584 Use libusb 1.0 asynchronous API.
1586 \param ftdi pointer to ftdi_context
1587 \param buf Buffer with the data
1588 \param size Size of the buffer
1590 \retval NULL: Some error happens when submit transfer
1591 \retval !NULL: Pointer to a ftdi_transfer_control
1594 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1596 struct ftdi_transfer_control *tc;
1597 struct libusb_transfer *transfer;
1598 int write_size, ret;
1600 if (ftdi == NULL || ftdi->usb_dev == NULL)
1603 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1607 transfer = libusb_alloc_transfer(0);
1620 if (size < (int)ftdi->writebuffer_chunksize)
1623 write_size = ftdi->writebuffer_chunksize;
1625 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1626 write_size, ftdi_write_data_cb, tc,
1627 ftdi->usb_write_timeout);
1628 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1630 ret = libusb_submit_transfer(transfer);
1633 libusb_free_transfer(transfer);
1637 tc->transfer = transfer;
1643 Reads data from the chip. Does not wait for completion of the transfer
1644 nor does it make sure that the transfer was successful.
1646 Use libusb 1.0 asynchronous API.
1648 \param ftdi pointer to ftdi_context
1649 \param buf Buffer with the data
1650 \param size Size of the buffer
1652 \retval NULL: Some error happens when submit transfer
1653 \retval !NULL: Pointer to a ftdi_transfer_control
1656 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1658 struct ftdi_transfer_control *tc;
1659 struct libusb_transfer *transfer;
1662 if (ftdi == NULL || ftdi->usb_dev == NULL)
1665 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1673 if (size <= (int)ftdi->readbuffer_remaining)
1675 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1678 ftdi->readbuffer_remaining -= size;
1679 ftdi->readbuffer_offset += size;
1681 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1685 tc->transfer = NULL;
1690 if (ftdi->readbuffer_remaining != 0)
1692 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1694 tc->offset = ftdi->readbuffer_remaining;
1699 transfer = libusb_alloc_transfer(0);
1706 ftdi->readbuffer_remaining = 0;
1707 ftdi->readbuffer_offset = 0;
1709 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);
1710 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1712 ret = libusb_submit_transfer(transfer);
1715 libusb_free_transfer(transfer);
1719 tc->transfer = transfer;
1725 Wait for completion of the transfer.
1727 Use libusb 1.0 asynchronous API.
1729 \param tc pointer to ftdi_transfer_control
1731 \retval < 0: Some error happens
1732 \retval >= 0: Data size transferred
1735 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1738 struct timeval to = { 0, 0 };
1739 while (!tc->completed)
1741 ret = libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1742 &to, &tc->completed);
1745 if (ret == LIBUSB_ERROR_INTERRUPTED)
1747 libusb_cancel_transfer(tc->transfer);
1748 while (!tc->completed)
1749 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1750 &to, &tc->completed) < 0)
1752 libusb_free_transfer(tc->transfer);
1760 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
1761 * at ftdi_read_data_submit(). Therefore, we need to check it here.
1765 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1767 libusb_free_transfer(tc->transfer);
1774 Cancel transfer and wait for completion.
1776 Use libusb 1.0 asynchronous API.
1778 \param tc pointer to ftdi_transfer_control
1779 \param to pointer to timeout value or NULL for infinite
1782 void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc,
1783 struct timeval * to)
1785 struct timeval tv = { 0, 0 };
1787 if (!tc->completed && tc->transfer != NULL)
1792 libusb_cancel_transfer(tc->transfer);
1793 while (!tc->completed)
1795 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx, to, &tc->completed) < 0)
1801 libusb_free_transfer(tc->transfer);
1807 Configure write buffer chunk size.
1810 \param ftdi pointer to ftdi_context
1811 \param chunksize Chunk size
1814 \retval -1: ftdi context invalid
1816 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1819 ftdi_error_return(-1, "ftdi context invalid");
1821 ftdi->writebuffer_chunksize = chunksize;
1826 Get write buffer chunk size.
1828 \param ftdi pointer to ftdi_context
1829 \param chunksize Pointer to store chunk size in
1832 \retval -1: ftdi context invalid
1834 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1837 ftdi_error_return(-1, "ftdi context invalid");
1839 *chunksize = ftdi->writebuffer_chunksize;
1844 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1846 Automatically strips the two modem status bytes transfered during every read.
1848 \param ftdi pointer to ftdi_context
1849 \param buf Buffer to store data in
1850 \param size Size of the buffer
1852 \retval -666: USB device unavailable
1853 \retval <0: error code from libusb_bulk_transfer()
1854 \retval 0: no data was available
1855 \retval >0: number of bytes read
1858 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1860 int offset = 0, ret, i, num_of_chunks, chunk_remains;
1861 int packet_size = ftdi->max_packet_size;
1862 int actual_length = 1;
1864 if (ftdi == NULL || ftdi->usb_dev == NULL)
1865 ftdi_error_return(-666, "USB device unavailable");
1867 // Packet size sanity check (avoid division by zero)
1868 if (packet_size == 0)
1869 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
1871 // everything we want is still in the readbuffer?
1872 if (size <= (int)ftdi->readbuffer_remaining)
1874 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1877 ftdi->readbuffer_remaining -= size;
1878 ftdi->readbuffer_offset += size;
1880 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1884 // something still in the readbuffer, but not enough to satisfy 'size'?
1885 if (ftdi->readbuffer_remaining != 0)
1887 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1890 offset += ftdi->readbuffer_remaining;
1892 // do the actual USB read
1893 while (offset < size && actual_length > 0)
1895 ftdi->readbuffer_remaining = 0;
1896 ftdi->readbuffer_offset = 0;
1897 /* returns how much received */
1898 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
1900 ftdi_error_return(ret, "usb bulk read failed");
1902 if (actual_length > 2)
1904 // skip FTDI status bytes.
1905 // Maybe stored in the future to enable modem use
1906 num_of_chunks = actual_length / packet_size;
1907 chunk_remains = actual_length % packet_size;
1908 //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);
1910 ftdi->readbuffer_offset += 2;
1913 if (actual_length > packet_size - 2)
1915 for (i = 1; i < num_of_chunks; i++)
1916 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1917 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1919 if (chunk_remains > 2)
1921 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1922 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1924 actual_length -= 2*num_of_chunks;
1927 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1930 else if (actual_length <= 2)
1932 // no more data to read?
1935 if (actual_length > 0)
1937 // data still fits in buf?
1938 if (offset+actual_length <= size)
1940 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
1941 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1942 offset += actual_length;
1944 /* Did we read exactly the right amount of bytes? */
1946 //printf("read_data exact rem %d offset %d\n",
1947 //ftdi->readbuffer_remaining, offset);
1952 // only copy part of the data or size <= readbuffer_chunksize
1953 int part_size = size-offset;
1954 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
1956 ftdi->readbuffer_offset += part_size;
1957 ftdi->readbuffer_remaining = actual_length-part_size;
1958 offset += part_size;
1960 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1961 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1972 Configure read buffer chunk size.
1975 Automatically reallocates the buffer.
1977 \param ftdi pointer to ftdi_context
1978 \param chunksize Chunk size
1981 \retval -1: ftdi context invalid
1983 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1985 unsigned char *new_buf;
1988 ftdi_error_return(-1, "ftdi context invalid");
1990 // Invalidate all remaining data
1991 ftdi->readbuffer_offset = 0;
1992 ftdi->readbuffer_remaining = 0;
1994 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
1995 which is defined in libusb-1.0. Otherwise, each USB read request will
1996 be divided into multiple URBs. This will cause issues on Linux kernel
1997 older than 2.6.32. */
1998 if (chunksize > 16384)
2002 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
2003 ftdi_error_return(-1, "out of memory for readbuffer");
2005 ftdi->readbuffer = new_buf;
2006 ftdi->readbuffer_chunksize = chunksize;
2012 Get read buffer chunk size.
2014 \param ftdi pointer to ftdi_context
2015 \param chunksize Pointer to store chunk size in
2018 \retval -1: FTDI context invalid
2020 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
2023 ftdi_error_return(-1, "FTDI context invalid");
2025 *chunksize = ftdi->readbuffer_chunksize;
2030 Enable/disable bitbang modes.
2032 \param ftdi pointer to ftdi_context
2033 \param bitmask Bitmask to configure lines.
2034 HIGH/ON value configures a line as output.
2035 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
2038 \retval -1: can't enable bitbang mode
2039 \retval -2: USB device unavailable
2041 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
2043 unsigned short usb_val;
2045 if (ftdi == NULL || ftdi->usb_dev == NULL)
2046 ftdi_error_return(-2, "USB device unavailable");
2048 usb_val = bitmask; // low byte: bitmask
2049 usb_val |= (mode << 8);
2050 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)
2051 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a BM/2232C type chip?");
2053 ftdi->bitbang_mode = mode;
2054 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
2059 Disable bitbang mode.
2061 \param ftdi pointer to ftdi_context
2064 \retval -1: can't disable bitbang mode
2065 \retval -2: USB device unavailable
2067 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
2069 if (ftdi == NULL || ftdi->usb_dev == NULL)
2070 ftdi_error_return(-2, "USB device unavailable");
2072 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)
2073 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
2075 ftdi->bitbang_enabled = 0;
2081 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
2083 \param ftdi pointer to ftdi_context
2084 \param pins Pointer to store pins into
2087 \retval -1: read pins failed
2088 \retval -2: USB device unavailable
2090 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
2092 if (ftdi == NULL || ftdi->usb_dev == NULL)
2093 ftdi_error_return(-2, "USB device unavailable");
2095 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)
2096 ftdi_error_return(-1, "read pins failed");
2104 The FTDI chip keeps data in the internal buffer for a specific
2105 amount of time if the buffer is not full yet to decrease
2106 load on the usb bus.
2108 \param ftdi pointer to ftdi_context
2109 \param latency Value between 1 and 255
2112 \retval -1: latency out of range
2113 \retval -2: unable to set latency timer
2114 \retval -3: USB device unavailable
2116 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
2118 unsigned short usb_val;
2121 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
2123 if (ftdi == NULL || ftdi->usb_dev == NULL)
2124 ftdi_error_return(-3, "USB device unavailable");
2127 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)
2128 ftdi_error_return(-2, "unable to set latency timer");
2136 \param ftdi pointer to ftdi_context
2137 \param latency Pointer to store latency value in
2140 \retval -1: unable to get latency timer
2141 \retval -2: USB device unavailable
2143 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
2145 unsigned short usb_val;
2147 if (ftdi == NULL || ftdi->usb_dev == NULL)
2148 ftdi_error_return(-2, "USB device unavailable");
2150 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)
2151 ftdi_error_return(-1, "reading latency timer failed");
2153 *latency = (unsigned char)usb_val;
2158 Poll modem status information
2160 This function allows the retrieve the two status bytes of the device.
2161 The device sends these bytes also as a header for each read access
2162 where they are discarded by ftdi_read_data(). The chip generates
2163 the two stripped status bytes in the absence of data every 40 ms.
2165 Layout of the first byte:
2166 - B0..B3 - must be 0
2167 - B4 Clear to send (CTS)
2170 - B5 Data set ready (DTS)
2173 - B6 Ring indicator (RI)
2176 - B7 Receive line signal detect (RLSD)
2180 Layout of the second byte:
2181 - B0 Data ready (DR)
2182 - B1 Overrun error (OE)
2183 - B2 Parity error (PE)
2184 - B3 Framing error (FE)
2185 - B4 Break interrupt (BI)
2186 - B5 Transmitter holding register (THRE)
2187 - B6 Transmitter empty (TEMT)
2188 - B7 Error in RCVR FIFO
2190 \param ftdi pointer to ftdi_context
2191 \param status Pointer to store status information in. Must be two bytes.
2194 \retval -1: unable to retrieve status information
2195 \retval -2: USB device unavailable
2197 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
2201 if (ftdi == NULL || ftdi->usb_dev == NULL)
2202 ftdi_error_return(-2, "USB device unavailable");
2204 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)
2205 ftdi_error_return(-1, "getting modem status failed");
2207 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
2213 Set flowcontrol for ftdi chip
2215 \param ftdi pointer to ftdi_context
2216 \param flowctrl flow control to use. should be
2217 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS
2220 \retval -1: set flow control failed
2221 \retval -2: USB device unavailable
2223 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2225 if (ftdi == NULL || ftdi->usb_dev == NULL)
2226 ftdi_error_return(-2, "USB device unavailable");
2228 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2229 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2230 NULL, 0, ftdi->usb_write_timeout) < 0)
2231 ftdi_error_return(-1, "set flow control failed");
2239 \param ftdi pointer to ftdi_context
2240 \param state state to set line to (1 or 0)
2243 \retval -1: set dtr failed
2244 \retval -2: USB device unavailable
2246 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2248 unsigned short usb_val;
2250 if (ftdi == NULL || ftdi->usb_dev == NULL)
2251 ftdi_error_return(-2, "USB device unavailable");
2254 usb_val = SIO_SET_DTR_HIGH;
2256 usb_val = SIO_SET_DTR_LOW;
2258 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2259 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2260 NULL, 0, ftdi->usb_write_timeout) < 0)
2261 ftdi_error_return(-1, "set dtr failed");
2269 \param ftdi pointer to ftdi_context
2270 \param state state to set line to (1 or 0)
2273 \retval -1: set rts failed
2274 \retval -2: USB device unavailable
2276 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2278 unsigned short usb_val;
2280 if (ftdi == NULL || ftdi->usb_dev == NULL)
2281 ftdi_error_return(-2, "USB device unavailable");
2284 usb_val = SIO_SET_RTS_HIGH;
2286 usb_val = SIO_SET_RTS_LOW;
2288 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2289 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2290 NULL, 0, ftdi->usb_write_timeout) < 0)
2291 ftdi_error_return(-1, "set of rts failed");
2297 Set dtr and rts line in one pass
2299 \param ftdi pointer to ftdi_context
2300 \param dtr DTR state to set line to (1 or 0)
2301 \param rts RTS state to set line to (1 or 0)
2304 \retval -1: set dtr/rts failed
2305 \retval -2: USB device unavailable
2307 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2309 unsigned short usb_val;
2311 if (ftdi == NULL || ftdi->usb_dev == NULL)
2312 ftdi_error_return(-2, "USB device unavailable");
2315 usb_val = SIO_SET_DTR_HIGH;
2317 usb_val = SIO_SET_DTR_LOW;
2320 usb_val |= SIO_SET_RTS_HIGH;
2322 usb_val |= SIO_SET_RTS_LOW;
2324 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2325 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2326 NULL, 0, ftdi->usb_write_timeout) < 0)
2327 ftdi_error_return(-1, "set of rts/dtr failed");
2333 Set the special event character
2335 \param ftdi pointer to ftdi_context
2336 \param eventch Event character
2337 \param enable 0 to disable the event character, non-zero otherwise
2340 \retval -1: unable to set event character
2341 \retval -2: USB device unavailable
2343 int ftdi_set_event_char(struct ftdi_context *ftdi,
2344 unsigned char eventch, unsigned char enable)
2346 unsigned short usb_val;
2348 if (ftdi == NULL || ftdi->usb_dev == NULL)
2349 ftdi_error_return(-2, "USB device unavailable");
2355 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)
2356 ftdi_error_return(-1, "setting event character failed");
2364 \param ftdi pointer to ftdi_context
2365 \param errorch Error character
2366 \param enable 0 to disable the error character, non-zero otherwise
2369 \retval -1: unable to set error character
2370 \retval -2: USB device unavailable
2372 int ftdi_set_error_char(struct ftdi_context *ftdi,
2373 unsigned char errorch, unsigned char enable)
2375 unsigned short usb_val;
2377 if (ftdi == NULL || ftdi->usb_dev == NULL)
2378 ftdi_error_return(-2, "USB device unavailable");
2384 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)
2385 ftdi_error_return(-1, "setting error character failed");
2391 Init eeprom with default values for the connected device
2392 \param ftdi pointer to ftdi_context
2393 \param manufacturer String to use as Manufacturer
2394 \param product String to use as Product description
2395 \param serial String to use as Serial number description
2398 \retval -1: No struct ftdi_context
2399 \retval -2: No struct ftdi_eeprom
2400 \retval -3: No connected device or device not yet opened
2402 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
2403 char * product, char * serial)
2405 struct ftdi_eeprom *eeprom;
2408 ftdi_error_return(-1, "No struct ftdi_context");
2410 if (ftdi->eeprom == NULL)
2411 ftdi_error_return(-2,"No struct ftdi_eeprom");
2413 eeprom = ftdi->eeprom;
2414 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2416 if (ftdi->usb_dev == NULL)
2417 ftdi_error_return(-3, "No connected device or device not yet opened");
2419 eeprom->vendor_id = 0x0403;
2420 eeprom->use_serial = 1;
2421 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2422 (ftdi->type == TYPE_R))
2423 eeprom->product_id = 0x6001;
2424 else if (ftdi->type == TYPE_4232H)
2425 eeprom->product_id = 0x6011;
2426 else if (ftdi->type == TYPE_232H)
2427 eeprom->product_id = 0x6014;
2428 else if (ftdi->type == TYPE_230X)
2429 eeprom->product_id = 0x6015;
2431 eeprom->product_id = 0x6010;
2433 if (ftdi->type == TYPE_AM)
2434 eeprom->usb_version = 0x0101;
2436 eeprom->usb_version = 0x0200;
2437 eeprom->max_power = 100;
2439 if (eeprom->manufacturer)
2440 free (eeprom->manufacturer);
2441 eeprom->manufacturer = NULL;
2444 eeprom->manufacturer = malloc(strlen(manufacturer)+1);
2445 if (eeprom->manufacturer)
2446 strcpy(eeprom->manufacturer, manufacturer);
2449 if (eeprom->product)
2450 free (eeprom->product);
2451 eeprom->product = NULL;
2454 eeprom->product = malloc(strlen(product)+1);
2455 if (eeprom->product)
2456 strcpy(eeprom->product, product);
2460 const char* default_product;
2463 case TYPE_AM: default_product = "AM"; break;
2464 case TYPE_BM: default_product = "BM"; break;
2465 case TYPE_2232C: default_product = "Dual RS232"; break;
2466 case TYPE_R: default_product = "FT232R USB UART"; break;
2467 case TYPE_2232H: default_product = "Dual RS232-HS"; break;
2468 case TYPE_4232H: default_product = "FT4232H"; break;
2469 case TYPE_232H: default_product = "Single-RS232-HS"; break;
2470 case TYPE_230X: default_product = "FT230X Basic UART"; break;
2472 ftdi_error_return(-3, "Unknown chip type");
2474 eeprom->product = malloc(strlen(default_product) +1);
2475 if (eeprom->product)
2476 strcpy(eeprom->product, default_product);
2480 free (eeprom->serial);
2481 eeprom->serial = NULL;
2484 eeprom->serial = malloc(strlen(serial)+1);
2486 strcpy(eeprom->serial, serial);
2489 if (ftdi->type == TYPE_R)
2491 eeprom->max_power = 90;
2492 eeprom->size = 0x80;
2493 eeprom->cbus_function[0] = CBUS_TXLED;
2494 eeprom->cbus_function[1] = CBUS_RXLED;
2495 eeprom->cbus_function[2] = CBUS_TXDEN;
2496 eeprom->cbus_function[3] = CBUS_PWREN;
2497 eeprom->cbus_function[4] = CBUS_SLEEP;
2499 else if (ftdi->type == TYPE_230X)
2501 eeprom->max_power = 90;
2502 eeprom->size = 0x100;
2503 eeprom->cbus_function[0] = CBUSX_TXDEN;
2504 eeprom->cbus_function[1] = CBUSX_RXLED;
2505 eeprom->cbus_function[2] = CBUSX_TXLED;
2506 eeprom->cbus_function[3] = CBUSX_SLEEP;
2510 if(ftdi->type == TYPE_232H)
2513 for (i=0; i<10; i++)
2514 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2521 eeprom->release_number = 0x0200;
2524 eeprom->release_number = 0x0400;
2527 eeprom->release_number = 0x0500;
2530 eeprom->release_number = 0x0600;
2533 eeprom->release_number = 0x0700;
2536 eeprom->release_number = 0x0800;
2539 eeprom->release_number = 0x0900;
2542 eeprom->release_number = 0x1000;
2545 eeprom->release_number = 0x00;
2550 int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer,
2551 char * product, char * serial)
2553 struct ftdi_eeprom *eeprom;
2556 ftdi_error_return(-1, "No struct ftdi_context");
2558 if (ftdi->eeprom == NULL)
2559 ftdi_error_return(-2,"No struct ftdi_eeprom");
2561 eeprom = ftdi->eeprom;
2563 if (ftdi->usb_dev == NULL)
2564 ftdi_error_return(-3, "No connected device or device not yet opened");
2568 if (eeprom->manufacturer)
2569 free (eeprom->manufacturer);
2570 eeprom->manufacturer = malloc(strlen(manufacturer)+1);
2571 if (eeprom->manufacturer)
2572 strcpy(eeprom->manufacturer, manufacturer);
2577 if (eeprom->product)
2578 free (eeprom->product);
2579 eeprom->product = malloc(strlen(product)+1);
2580 if (eeprom->product)
2581 strcpy(eeprom->product, product);
2587 free (eeprom->serial);
2588 eeprom->serial = malloc(strlen(serial)+1);
2591 strcpy(eeprom->serial, serial);
2592 eeprom->use_serial = 1;
2599 /*FTD2XX doesn't check for values not fitting in the ACBUS Signal options*/
2600 void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2605 int mode_low, mode_high;
2606 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2607 mode_low = CBUSH_TRISTATE;
2609 mode_low = eeprom->cbus_function[2*i];
2610 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2611 mode_high = CBUSH_TRISTATE;
2613 mode_high = eeprom->cbus_function[2*i+1];
2615 output[0x18+i] = (mode_high <<4) | mode_low;
2618 /* Return the bits for the encoded EEPROM Structure of a requested Mode
2621 static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2630 case CHANNEL_IS_UART: return 0;
2631 case CHANNEL_IS_FIFO: return 0x01;
2632 case CHANNEL_IS_OPTO: return 0x02;
2633 case CHANNEL_IS_CPU : return 0x04;
2641 case CHANNEL_IS_UART : return 0;
2642 case CHANNEL_IS_FIFO : return 0x01;
2643 case CHANNEL_IS_OPTO : return 0x02;
2644 case CHANNEL_IS_CPU : return 0x04;
2645 case CHANNEL_IS_FT1284 : return 0x08;
2653 case CHANNEL_IS_UART : return 0;
2654 case CHANNEL_IS_FIFO : return 0x01;
2658 case TYPE_230X: /* FT230X is only UART */
2665 Build binary buffer from ftdi_eeprom structure.
2666 Output is suitable for ftdi_write_eeprom().
2668 \param ftdi pointer to ftdi_context
2670 \retval >=0: size of eeprom user area in bytes
2671 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2672 \retval -2: Invalid eeprom or ftdi pointer
2673 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2674 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2675 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2676 \retval -6: No connected EEPROM or EEPROM Type unknown
2678 int ftdi_eeprom_build(struct ftdi_context *ftdi)
2680 unsigned char i, j, eeprom_size_mask;
2681 unsigned short checksum, value;
2682 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2683 int user_area_size, free_start, free_end;
2684 struct ftdi_eeprom *eeprom;
2685 unsigned char * output;
2688 ftdi_error_return(-2,"No context");
2689 if (ftdi->eeprom == NULL)
2690 ftdi_error_return(-2,"No eeprom structure");
2692 eeprom= ftdi->eeprom;
2693 output = eeprom->buf;
2695 if (eeprom->chip == -1)
2696 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2698 if (eeprom->size == -1)
2700 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2701 eeprom->size = 0x100;
2703 eeprom->size = 0x80;
2706 if (eeprom->manufacturer != NULL)
2707 manufacturer_size = strlen(eeprom->manufacturer);
2708 if (eeprom->product != NULL)
2709 product_size = strlen(eeprom->product);
2710 if (eeprom->serial != NULL)
2711 serial_size = strlen(eeprom->serial);
2713 // eeprom size check
2719 user_area_size = 96; // base size for strings (total of 48 characters)
2722 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2725 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2727 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2729 user_area_size = 86;
2732 user_area_size = 80;
2738 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
2740 if (user_area_size < 0)
2741 ftdi_error_return(-1,"eeprom size exceeded");
2744 if (ftdi->type == TYPE_230X)
2746 /* FT230X have a reserved section in the middle of the MTP,
2747 which cannot be written to, but must be included in the checksum */
2748 memset(ftdi->eeprom->buf, 0, 0x80);
2749 memset((ftdi->eeprom->buf + 0xa0), 0, (FTDI_MAX_EEPROM_SIZE - 0xa0));
2753 memset(ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2756 // Bytes and Bits set for all Types
2758 // Addr 02: Vendor ID
2759 output[0x02] = eeprom->vendor_id;
2760 output[0x03] = eeprom->vendor_id >> 8;
2762 // Addr 04: Product ID
2763 output[0x04] = eeprom->product_id;
2764 output[0x05] = eeprom->product_id >> 8;
2766 // Addr 06: Device release number (0400h for BM features)
2767 output[0x06] = eeprom->release_number;
2768 output[0x07] = eeprom->release_number >> 8;
2770 // Addr 08: Config descriptor
2772 // Bit 6: 1 if this device is self powered, 0 if bus powered
2773 // Bit 5: 1 if this device uses remote wakeup
2774 // Bit 4-0: reserved - 0
2776 if (eeprom->self_powered)
2778 if (eeprom->remote_wakeup)
2782 // Addr 09: Max power consumption: max power = value * 2 mA
2783 output[0x09] = eeprom->max_power / MAX_POWER_MILLIAMP_PER_UNIT;
2785 if ((ftdi->type != TYPE_AM) && (ftdi->type != TYPE_230X))
2787 // Addr 0A: Chip configuration
2788 // Bit 7: 0 - reserved
2789 // Bit 6: 0 - reserved
2790 // Bit 5: 0 - reserved
2791 // Bit 4: 1 - Change USB version
2792 // Bit 3: 1 - Use the serial number string
2793 // Bit 2: 1 - Enable suspend pull downs for lower power
2794 // Bit 1: 1 - Out EndPoint is Isochronous
2795 // Bit 0: 1 - In EndPoint is Isochronous
2798 if (eeprom->in_is_isochronous)
2800 if (eeprom->out_is_isochronous)
2806 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
2807 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
2828 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
2829 eeprom_size_mask = eeprom->size -1;
2830 free_end = i & eeprom_size_mask;
2832 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2833 // Addr 0F: Length of manufacturer string
2834 // Output manufacturer
2835 output[0x0E] = i; // calculate offset
2836 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
2837 output[i & eeprom_size_mask] = 0x03, i++; // type: string
2838 for (j = 0; j < manufacturer_size; j++)
2840 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
2841 output[i & eeprom_size_mask] = 0x00, i++;
2843 output[0x0F] = manufacturer_size*2 + 2;
2845 // Addr 10: Offset of the product string + 0x80, calculated later
2846 // Addr 11: Length of product string
2847 output[0x10] = i | 0x80; // calculate offset
2848 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
2849 output[i & eeprom_size_mask] = 0x03, i++;
2850 for (j = 0; j < product_size; j++)
2852 output[i & eeprom_size_mask] = eeprom->product[j], i++;
2853 output[i & eeprom_size_mask] = 0x00, i++;
2855 output[0x11] = product_size*2 + 2;
2857 // Addr 12: Offset of the serial string + 0x80, calculated later
2858 // Addr 13: Length of serial string
2859 output[0x12] = i | 0x80; // calculate offset
2860 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
2861 output[i & eeprom_size_mask] = 0x03, i++;
2862 for (j = 0; j < serial_size; j++)
2864 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
2865 output[i & eeprom_size_mask] = 0x00, i++;
2868 // Legacy port name and PnP fields for FT2232 and newer chips
2869 if (ftdi->type > TYPE_BM)
2871 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
2873 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
2875 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
2879 output[0x13] = serial_size*2 + 2;
2881 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
2883 if (eeprom->use_serial)
2884 output[0x0A] |= USE_SERIAL_NUM;
2886 output[0x0A] &= ~USE_SERIAL_NUM;
2889 /* Bytes and Bits specific to (some) types
2890 Write linear, as this allows easier fixing*/
2896 output[0x0C] = eeprom->usb_version & 0xff;
2897 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2898 if (eeprom->use_usb_version)
2899 output[0x0A] |= USE_USB_VERSION_BIT;
2901 output[0x0A] &= ~USE_USB_VERSION_BIT;
2906 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
2907 if ( eeprom->channel_a_driver == DRIVER_VCP)
2908 output[0x00] |= DRIVER_VCP;
2910 output[0x00] &= ~DRIVER_VCP;
2912 if ( eeprom->high_current_a == HIGH_CURRENT_DRIVE)
2913 output[0x00] |= HIGH_CURRENT_DRIVE;
2915 output[0x00] &= ~HIGH_CURRENT_DRIVE;
2917 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
2918 if ( eeprom->channel_b_driver == DRIVER_VCP)
2919 output[0x01] |= DRIVER_VCP;
2921 output[0x01] &= ~DRIVER_VCP;
2923 if ( eeprom->high_current_b == HIGH_CURRENT_DRIVE)
2924 output[0x01] |= HIGH_CURRENT_DRIVE;
2926 output[0x01] &= ~HIGH_CURRENT_DRIVE;
2928 if (eeprom->in_is_isochronous)
2929 output[0x0A] |= 0x1;
2931 output[0x0A] &= ~0x1;
2932 if (eeprom->out_is_isochronous)
2933 output[0x0A] |= 0x2;
2935 output[0x0A] &= ~0x2;
2936 if (eeprom->suspend_pull_downs)
2937 output[0x0A] |= 0x4;
2939 output[0x0A] &= ~0x4;
2940 if (eeprom->use_usb_version)
2941 output[0x0A] |= USE_USB_VERSION_BIT;
2943 output[0x0A] &= ~USE_USB_VERSION_BIT;
2945 output[0x0C] = eeprom->usb_version & 0xff;
2946 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2947 output[0x14] = eeprom->chip;
2950 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_R);
2951 if (eeprom->high_current == HIGH_CURRENT_DRIVE_R)
2952 output[0x00] |= HIGH_CURRENT_DRIVE_R;
2953 if (eeprom->external_oscillator)
2954 output[0x00] |= 0x02;
2955 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
2957 if (eeprom->suspend_pull_downs)
2958 output[0x0A] |= 0x4;
2960 output[0x0A] &= ~0x4;
2961 output[0x0B] = eeprom->invert;
2962 output[0x0C] = eeprom->usb_version & 0xff;
2963 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2965 if (eeprom->cbus_function[0] > CBUS_BB_RD)
2966 output[0x14] = CBUS_TXLED;
2968 output[0x14] = eeprom->cbus_function[0];
2970 if (eeprom->cbus_function[1] > CBUS_BB_RD)
2971 output[0x14] |= CBUS_RXLED<<4;
2973 output[0x14] |= eeprom->cbus_function[1]<<4;
2975 if (eeprom->cbus_function[2] > CBUS_BB_RD)
2976 output[0x15] = CBUS_TXDEN;
2978 output[0x15] = eeprom->cbus_function[2];
2980 if (eeprom->cbus_function[3] > CBUS_BB_RD)
2981 output[0x15] |= CBUS_PWREN<<4;
2983 output[0x15] |= eeprom->cbus_function[3]<<4;
2985 if (eeprom->cbus_function[4] > CBUS_CLK6)
2986 output[0x16] = CBUS_SLEEP;
2988 output[0x16] = eeprom->cbus_function[4];
2991 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
2992 if ( eeprom->channel_a_driver == DRIVER_VCP)
2993 output[0x00] |= DRIVER_VCP;
2995 output[0x00] &= ~DRIVER_VCP;
2997 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
2998 if ( eeprom->channel_b_driver == DRIVER_VCP)
2999 output[0x01] |= DRIVER_VCP;
3001 output[0x01] &= ~DRIVER_VCP;
3002 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
3003 output[0x01] |= SUSPEND_DBUS7_BIT;
3005 output[0x01] &= ~SUSPEND_DBUS7_BIT;
3007 if (eeprom->suspend_pull_downs)
3008 output[0x0A] |= 0x4;
3010 output[0x0A] &= ~0x4;
3012 if (eeprom->group0_drive > DRIVE_16MA)
3013 output[0x0c] |= DRIVE_16MA;
3015 output[0x0c] |= eeprom->group0_drive;
3016 if (eeprom->group0_schmitt == IS_SCHMITT)
3017 output[0x0c] |= IS_SCHMITT;
3018 if (eeprom->group0_slew == SLOW_SLEW)
3019 output[0x0c] |= SLOW_SLEW;
3021 if (eeprom->group1_drive > DRIVE_16MA)
3022 output[0x0c] |= DRIVE_16MA<<4;
3024 output[0x0c] |= eeprom->group1_drive<<4;
3025 if (eeprom->group1_schmitt == IS_SCHMITT)
3026 output[0x0c] |= IS_SCHMITT<<4;
3027 if (eeprom->group1_slew == SLOW_SLEW)
3028 output[0x0c] |= SLOW_SLEW<<4;
3030 if (eeprom->group2_drive > DRIVE_16MA)
3031 output[0x0d] |= DRIVE_16MA;
3033 output[0x0d] |= eeprom->group2_drive;
3034 if (eeprom->group2_schmitt == IS_SCHMITT)
3035 output[0x0d] |= IS_SCHMITT;
3036 if (eeprom->group2_slew == SLOW_SLEW)
3037 output[0x0d] |= SLOW_SLEW;
3039 if (eeprom->group3_drive > DRIVE_16MA)
3040 output[0x0d] |= DRIVE_16MA<<4;
3042 output[0x0d] |= eeprom->group3_drive<<4;
3043 if (eeprom->group3_schmitt == IS_SCHMITT)
3044 output[0x0d] |= IS_SCHMITT<<4;
3045 if (eeprom->group3_slew == SLOW_SLEW)
3046 output[0x0d] |= SLOW_SLEW<<4;
3048 output[0x18] = eeprom->chip;
3052 if (eeprom->channel_a_driver == DRIVER_VCP)
3053 output[0x00] |= DRIVER_VCP;
3055 output[0x00] &= ~DRIVER_VCP;
3056 if (eeprom->channel_b_driver == DRIVER_VCP)
3057 output[0x01] |= DRIVER_VCP;
3059 output[0x01] &= ~DRIVER_VCP;
3060 if (eeprom->channel_c_driver == DRIVER_VCP)
3061 output[0x00] |= (DRIVER_VCP << 4);
3063 output[0x00] &= ~(DRIVER_VCP << 4);
3064 if (eeprom->channel_d_driver == DRIVER_VCP)
3065 output[0x01] |= (DRIVER_VCP << 4);
3067 output[0x01] &= ~(DRIVER_VCP << 4);
3069 if (eeprom->suspend_pull_downs)
3070 output[0x0a] |= 0x4;
3072 output[0x0a] &= ~0x4;
3074 if (eeprom->channel_a_rs485enable)
3075 output[0x0b] |= CHANNEL_IS_RS485 << 0;
3077 output[0x0b] &= ~(CHANNEL_IS_RS485 << 0);
3078 if (eeprom->channel_b_rs485enable)
3079 output[0x0b] |= CHANNEL_IS_RS485 << 1;
3081 output[0x0b] &= ~(CHANNEL_IS_RS485 << 1);
3082 if (eeprom->channel_c_rs485enable)
3083 output[0x0b] |= CHANNEL_IS_RS485 << 2;
3085 output[0x0b] &= ~(CHANNEL_IS_RS485 << 2);
3086 if (eeprom->channel_d_rs485enable)
3087 output[0x0b] |= CHANNEL_IS_RS485 << 3;
3089 output[0x0b] &= ~(CHANNEL_IS_RS485 << 3);
3091 if (eeprom->group0_drive > DRIVE_16MA)
3092 output[0x0c] |= DRIVE_16MA;
3094 output[0x0c] |= eeprom->group0_drive;
3095 if (eeprom->group0_schmitt == IS_SCHMITT)
3096 output[0x0c] |= IS_SCHMITT;
3097 if (eeprom->group0_slew == SLOW_SLEW)
3098 output[0x0c] |= SLOW_SLEW;
3100 if (eeprom->group1_drive > DRIVE_16MA)
3101 output[0x0c] |= DRIVE_16MA<<4;
3103 output[0x0c] |= eeprom->group1_drive<<4;
3104 if (eeprom->group1_schmitt == IS_SCHMITT)
3105 output[0x0c] |= IS_SCHMITT<<4;
3106 if (eeprom->group1_slew == SLOW_SLEW)
3107 output[0x0c] |= SLOW_SLEW<<4;
3109 if (eeprom->group2_drive > DRIVE_16MA)
3110 output[0x0d] |= DRIVE_16MA;
3112 output[0x0d] |= eeprom->group2_drive;
3113 if (eeprom->group2_schmitt == IS_SCHMITT)
3114 output[0x0d] |= IS_SCHMITT;
3115 if (eeprom->group2_slew == SLOW_SLEW)
3116 output[0x0d] |= SLOW_SLEW;
3118 if (eeprom->group3_drive > DRIVE_16MA)
3119 output[0x0d] |= DRIVE_16MA<<4;
3121 output[0x0d] |= eeprom->group3_drive<<4;
3122 if (eeprom->group3_schmitt == IS_SCHMITT)
3123 output[0x0d] |= IS_SCHMITT<<4;
3124 if (eeprom->group3_slew == SLOW_SLEW)
3125 output[0x0d] |= SLOW_SLEW<<4;
3127 output[0x18] = eeprom->chip;
3131 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
3132 if ( eeprom->channel_a_driver == DRIVER_VCP)
3133 output[0x00] |= DRIVER_VCPH;
3135 output[0x00] &= ~DRIVER_VCPH;
3136 if (eeprom->powersave)
3137 output[0x01] |= POWER_SAVE_DISABLE_H;
3139 output[0x01] &= ~POWER_SAVE_DISABLE_H;
3141 if (eeprom->suspend_pull_downs)
3142 output[0x0a] |= 0x4;
3144 output[0x0a] &= ~0x4;
3146 if (eeprom->clock_polarity)
3147 output[0x01] |= FT1284_CLK_IDLE_STATE;
3149 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
3150 if (eeprom->data_order)
3151 output[0x01] |= FT1284_DATA_LSB;
3153 output[0x01] &= ~FT1284_DATA_LSB;
3154 if (eeprom->flow_control)
3155 output[0x01] |= FT1284_FLOW_CONTROL;
3157 output[0x01] &= ~FT1284_FLOW_CONTROL;
3158 if (eeprom->group0_drive > DRIVE_16MA)
3159 output[0x0c] |= DRIVE_16MA;
3161 output[0x0c] |= eeprom->group0_drive;
3162 if (eeprom->group0_schmitt == IS_SCHMITT)
3163 output[0x0c] |= IS_SCHMITT;
3164 if (eeprom->group0_slew == SLOW_SLEW)
3165 output[0x0c] |= SLOW_SLEW;
3167 if (eeprom->group1_drive > DRIVE_16MA)
3168 output[0x0d] |= DRIVE_16MA;
3170 output[0x0d] |= eeprom->group1_drive;
3171 if (eeprom->group1_schmitt == IS_SCHMITT)
3172 output[0x0d] |= IS_SCHMITT;
3173 if (eeprom->group1_slew == SLOW_SLEW)
3174 output[0x0d] |= SLOW_SLEW;
3176 set_ft232h_cbus(eeprom, output);
3178 output[0x1e] = eeprom->chip;
3179 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
3182 output[0x00] = 0x80; /* Actually, leave the default value */
3183 output[0x0a] = 0x08; /* Enable USB Serial Number */
3184 /*FIXME: Make DBUS & CBUS Control configurable*/
3185 output[0x0c] = 0; /* DBUS drive 4mA, CBUS drive 4 mA like factory default */
3186 for (j = 0; j <= 6; j++)
3188 output[0x1a + j] = eeprom->cbus_function[j];
3190 output[0x0b] = eeprom->invert;
3194 /* First address without use */
3214 /* Arbitrary user data */
3215 if (eeprom->user_data && eeprom->user_data_size >= 0)
3217 if (eeprom->user_data_addr < free_start)
3218 fprintf(stderr,"Warning, user data starts inside the generated data!\n");
3219 if (eeprom->user_data_addr + eeprom->user_data_size >= free_end)
3220 fprintf(stderr,"Warning, user data overlaps the strings area!\n");
3221 if (eeprom->user_data_addr + eeprom->user_data_size > eeprom->size)
3222 ftdi_error_return(-1,"eeprom size exceeded");
3223 memcpy(output + eeprom->user_data_addr, eeprom->user_data, eeprom->user_data_size);
3226 // calculate checksum
3229 for (i = 0; i < eeprom->size/2-1; i++)
3231 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3233 /* FT230X has a user section in the MTP which is not part of the checksum */
3236 if ((ftdi->type == TYPE_230X) && (i >= 0x40) && (i < 0x50)) {
3238 if (ftdi_read_eeprom_location(ftdi, i, &data)) {
3239 fprintf(stderr, "Reading Factory Configuration Data failed\n");
3245 value = output[i*2];
3246 value += output[(i*2)+1] << 8;
3248 checksum = value^checksum;
3249 checksum = (checksum << 1) | (checksum >> 15);
3252 output[eeprom->size-2] = checksum;
3253 output[eeprom->size-1] = checksum >> 8;
3255 eeprom->initialized_for_connected_device = 1;
3256 return user_area_size;
3258 /* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
3261 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
3263 static unsigned char bit2type(unsigned char bits)
3267 case 0: return CHANNEL_IS_UART;
3268 case 1: return CHANNEL_IS_FIFO;
3269 case 2: return CHANNEL_IS_OPTO;
3270 case 4: return CHANNEL_IS_CPU;
3271 case 8: return CHANNEL_IS_FT1284;
3273 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
3278 /* Decode 230X / 232R type chips invert bits
3279 * Prints directly to stdout.
3281 static void print_inverted_bits(int invert)
3283 char *r_bits[] = {"TXD","RXD","RTS","CTS","DTR","DSR","DCD","RI"};
3286 fprintf(stdout,"Inverted bits:");
3288 if ((invert & (1<<i)) == (1<<i))
3289 fprintf(stdout," %s",r_bits[i]);
3291 fprintf(stdout,"\n");
3294 Decode binary EEPROM image into an ftdi_eeprom structure.
3296 For FT-X devices use AN_201 FT-X MTP memory Configuration to decode.
3298 \param ftdi pointer to ftdi_context
3299 \param verbose Decode EEPROM on stdout
3302 \retval -1: something went wrong
3304 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
3305 FIXME: Strings are malloc'ed here and should be freed somewhere
3307 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
3310 unsigned short checksum, eeprom_checksum, value;
3311 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
3313 struct ftdi_eeprom *eeprom;
3314 unsigned char *buf = NULL;
3317 ftdi_error_return(-1,"No context");
3318 if (ftdi->eeprom == NULL)
3319 ftdi_error_return(-1,"No eeprom structure");
3321 eeprom = ftdi->eeprom;
3322 eeprom_size = eeprom->size;
3323 buf = ftdi->eeprom->buf;
3325 // Addr 02: Vendor ID
3326 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
3328 // Addr 04: Product ID
3329 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
3331 // Addr 06: Device release number
3332 eeprom->release_number = buf[0x06] + (buf[0x07]<<8);
3334 // Addr 08: Config descriptor
3336 // Bit 6: 1 if this device is self powered, 0 if bus powered
3337 // Bit 5: 1 if this device uses remote wakeup
3338 eeprom->self_powered = buf[0x08] & 0x40;
3339 eeprom->remote_wakeup = buf[0x08] & 0x20;
3341 // Addr 09: Max power consumption: max power = value * 2 mA
3342 eeprom->max_power = MAX_POWER_MILLIAMP_PER_UNIT * buf[0x09];
3344 // Addr 0A: Chip configuration
3345 // Bit 7: 0 - reserved
3346 // Bit 6: 0 - reserved
3347 // Bit 5: 0 - reserved
3348 // Bit 4: 1 - Change USB version on BM and 2232C
3349 // Bit 3: 1 - Use the serial number string
3350 // Bit 2: 1 - Enable suspend pull downs for lower power
3351 // Bit 1: 1 - Out EndPoint is Isochronous
3352 // Bit 0: 1 - In EndPoint is Isochronous
3354 eeprom->in_is_isochronous = buf[0x0A]&0x01;
3355 eeprom->out_is_isochronous = buf[0x0A]&0x02;
3356 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
3357 eeprom->use_serial = !!(buf[0x0A] & USE_SERIAL_NUM);
3358 eeprom->use_usb_version = !!(buf[0x0A] & USE_USB_VERSION_BIT);
3360 // Addr 0C: USB version low byte when 0x0A
3361 // Addr 0D: USB version high byte when 0x0A
3362 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
3364 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
3365 // Addr 0F: Length of manufacturer string
3366 manufacturer_size = buf[0x0F]/2;
3367 if (eeprom->manufacturer)
3368 free(eeprom->manufacturer);
3369 if (manufacturer_size > 0)
3371 eeprom->manufacturer = malloc(manufacturer_size);
3372 if (eeprom->manufacturer)
3374 // Decode manufacturer
3375 i = buf[0x0E] & (eeprom_size -1); // offset
3376 for (j=0; j<manufacturer_size-1; j++)
3378 eeprom->manufacturer[j] = buf[2*j+i+2];
3380 eeprom->manufacturer[j] = '\0';
3383 else eeprom->manufacturer = NULL;
3385 // Addr 10: Offset of the product string + 0x80, calculated later
3386 // Addr 11: Length of product string
3387 if (eeprom->product)
3388 free(eeprom->product);
3389 product_size = buf[0x11]/2;
3390 if (product_size > 0)
3392 eeprom->product = malloc(product_size);
3393 if (eeprom->product)
3395 // Decode product name
3396 i = buf[0x10] & (eeprom_size -1); // offset
3397 for (j=0; j<product_size-1; j++)
3399 eeprom->product[j] = buf[2*j+i+2];
3401 eeprom->product[j] = '\0';
3404 else eeprom->product = NULL;
3406 // Addr 12: Offset of the serial string + 0x80, calculated later
3407 // Addr 13: Length of serial string
3409 free(eeprom->serial);
3410 serial_size = buf[0x13]/2;
3411 if (serial_size > 0)
3413 eeprom->serial = malloc(serial_size);
3417 i = buf[0x12] & (eeprom_size -1); // offset
3418 for (j=0; j<serial_size-1; j++)
3420 eeprom->serial[j] = buf[2*j+i+2];
3422 eeprom->serial[j] = '\0';
3425 else eeprom->serial = NULL;
3430 for (i = 0; i < eeprom_size/2-1; i++)
3432 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3434 /* FT230X has a user section in the MTP which is not part of the checksum */
3438 value += buf[(i*2)+1] << 8;
3440 checksum = value^checksum;
3441 checksum = (checksum << 1) | (checksum >> 15);
3444 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
3446 if (eeprom_checksum != checksum)
3448 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
3449 ftdi_error_return(-1,"EEPROM checksum error");
3452 eeprom->channel_a_type = 0;
3453 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
3457 else if (ftdi->type == TYPE_2232C)
3459 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3460 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3461 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
3462 eeprom->channel_b_type = buf[0x01] & 0x7;
3463 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3464 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
3465 eeprom->chip = buf[0x14];
3467 else if (ftdi->type == TYPE_R)
3469 /* TYPE_R flags D2XX, not VCP as all others*/
3470 eeprom->channel_a_driver = ~buf[0x00] & DRIVER_VCP;
3471 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
3472 eeprom->external_oscillator = buf[0x00] & 0x02;
3473 if ( (buf[0x01]&0x40) != 0x40)
3475 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
3476 " If this happened with the\n"
3477 " EEPROM programmed by FTDI tools, please report "
3478 "to libftdi@developer.intra2net.com\n");
3480 eeprom->chip = buf[0x16];
3481 // Addr 0B: Invert data lines
3482 // Works only on FT232R, not FT245R, but no way to distinguish
3483 eeprom->invert = buf[0x0B];
3484 // Addr 14: CBUS function: CBUS0, CBUS1
3485 // Addr 15: CBUS function: CBUS2, CBUS3
3486 // Addr 16: CBUS function: CBUS5
3487 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3488 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3489 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3490 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3491 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
3493 else if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3495 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3496 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3498 if (ftdi->type == TYPE_2232H)
3500 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3501 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
3502 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
3506 eeprom->channel_c_driver = (buf[0x00] >> 4) & DRIVER_VCP;
3507 eeprom->channel_d_driver = (buf[0x01] >> 4) & DRIVER_VCP;
3508 eeprom->channel_a_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 0);
3509 eeprom->channel_b_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 1);
3510 eeprom->channel_c_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 2);
3511 eeprom->channel_d_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 3);
3514 eeprom->chip = buf[0x18];
3515 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3516 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3517 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3518 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3519 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3520 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3521 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3522 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3523 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3524 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3525 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3526 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
3528 else if (ftdi->type == TYPE_232H)
3530 eeprom->channel_a_type = buf[0x00] & 0xf;
3531 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
3532 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3533 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3534 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
3535 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
3536 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3537 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3538 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3539 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3540 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3541 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3545 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3546 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3548 eeprom->chip = buf[0x1e];
3549 /*FIXME: Decipher more values*/
3551 else if (ftdi->type == TYPE_230X)
3555 eeprom->cbus_function[i] = buf[0x1a + i] & 0xFF;
3557 eeprom->group0_drive = buf[0x0c] & 0x03;
3558 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3559 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3560 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x03;
3561 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3562 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3564 eeprom->invert = buf[0xb];
3569 char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
3570 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3571 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
3572 fprintf(stdout, "Release: 0x%04x\n",eeprom->release_number);
3574 if (eeprom->self_powered)
3575 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3577 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power,
3578 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
3579 if (eeprom->manufacturer)
3580 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
3581 if (eeprom->product)
3582 fprintf(stdout, "Product: %s\n",eeprom->product);
3584 fprintf(stdout, "Serial: %s\n",eeprom->serial);
3585 fprintf(stdout, "Checksum : %04x\n", checksum);
3586 if (ftdi->type == TYPE_R) {
3587 fprintf(stdout, "Internal EEPROM\n");
3588 fprintf(stdout,"Oscillator: %s\n", eeprom->external_oscillator?"External":"Internal");
3590 else if (eeprom->chip >= 0x46)
3591 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
3592 if (eeprom->suspend_dbus7)
3593 fprintf(stdout, "Suspend on DBUS7\n");
3594 if (eeprom->suspend_pull_downs)
3595 fprintf(stdout, "Pull IO pins low during suspend\n");
3596 if(eeprom->powersave)
3598 if(ftdi->type >= TYPE_232H)
3599 fprintf(stdout,"Enter low power state on ACBUS7\n");
3601 if (eeprom->remote_wakeup)
3602 fprintf(stdout, "Enable Remote Wake Up\n");
3603 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
3604 if (ftdi->type >= TYPE_2232C)
3605 fprintf(stdout,"Channel A has Mode %s%s%s\n",
3606 channel_mode[eeprom->channel_a_type],
3607 (eeprom->channel_a_driver)?" VCP":"",
3608 (eeprom->high_current_a)?" High Current IO":"");
3609 if (ftdi->type == TYPE_232H)
3611 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3612 (eeprom->clock_polarity)?"HIGH":"LOW",
3613 (eeprom->data_order)?"LSB":"MSB",
3614 (eeprom->flow_control)?"":"No ");
3616 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3617 fprintf(stdout,"Channel B has Mode %s%s%s\n",
3618 channel_mode[eeprom->channel_b_type],
3619 (eeprom->channel_b_driver)?" VCP":"",
3620 (eeprom->high_current_b)?" High Current IO":"");
3621 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3622 eeprom->use_usb_version)
3623 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3625 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3627 fprintf(stdout,"%s has %d mA drive%s%s\n",
3628 (ftdi->type == TYPE_2232H)?"AL":"A",
3629 (eeprom->group0_drive+1) *4,
3630 (eeprom->group0_schmitt)?" Schmitt Input":"",
3631 (eeprom->group0_slew)?" Slow Slew":"");
3632 fprintf(stdout,"%s has %d mA drive%s%s\n",
3633 (ftdi->type == TYPE_2232H)?"AH":"B",
3634 (eeprom->group1_drive+1) *4,
3635 (eeprom->group1_schmitt)?" Schmitt Input":"",
3636 (eeprom->group1_slew)?" Slow Slew":"");
3637 fprintf(stdout,"%s has %d mA drive%s%s\n",
3638 (ftdi->type == TYPE_2232H)?"BL":"C",
3639 (eeprom->group2_drive+1) *4,
3640 (eeprom->group2_schmitt)?" Schmitt Input":"",
3641 (eeprom->group2_slew)?" Slow Slew":"");
3642 fprintf(stdout,"%s has %d mA drive%s%s\n",
3643 (ftdi->type == TYPE_2232H)?"BH":"D",
3644 (eeprom->group3_drive+1) *4,
3645 (eeprom->group3_schmitt)?" Schmitt Input":"",
3646 (eeprom->group3_slew)?" Slow Slew":"");
3648 else if (ftdi->type == TYPE_232H)
3650 char *cbush_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
3651 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3652 "CLK30","CLK15","CLK7_5"
3654 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3655 (eeprom->group0_drive+1) *4,
3656 (eeprom->group0_schmitt)?" Schmitt Input":"",
3657 (eeprom->group0_slew)?" Slow Slew":"");
3658 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3659 (eeprom->group1_drive+1) *4,
3660 (eeprom->group1_schmitt)?" Schmitt Input":"",
3661 (eeprom->group1_slew)?" Slow Slew":"");
3662 for (i=0; i<10; i++)
3664 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3665 fprintf(stdout,"C%d Function: %s\n", i,
3666 cbush_mux[eeprom->cbus_function[i]]);
3669 else if (ftdi->type == TYPE_230X)
3671 char *cbusx_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
3672 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3673 "CLK24","CLK12","CLK6","BAT_DETECT","BAT_DETECT#",
3674 "I2C_TXE#", "I2C_RXF#", "VBUS_SENSE", "BB_WR#",
3675 "BBRD#", "TIME_STAMP", "AWAKE#",
3677 fprintf(stdout,"DBUS has %d mA drive%s%s\n",
3678 (eeprom->group0_drive+1) *4,
3679 (eeprom->group0_schmitt)?" Schmitt Input":"",
3680 (eeprom->group0_slew)?" Slow Slew":"");
3681 fprintf(stdout,"CBUS has %d mA drive%s%s\n",
3682 (eeprom->group1_drive+1) *4,
3683 (eeprom->group1_schmitt)?" Schmitt Input":"",
3684 (eeprom->group1_slew)?" Slow Slew":"");
3687 if (eeprom->cbus_function[i]<= CBUSX_AWAKE)
3688 fprintf(stdout,"CBUS%d Function: %s\n", i, cbusx_mux[eeprom->cbus_function[i]]);
3692 print_inverted_bits(eeprom->invert);
3695 if (ftdi->type == TYPE_R)
3697 char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
3698 "SLEEP","CLK48","CLK24","CLK12","CLK6",
3699 "IOMODE","BB_WR","BB_RD"
3701 char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
3704 print_inverted_bits(eeprom->invert);
3708 if (eeprom->cbus_function[i]<=CBUS_BB_RD)
3709 fprintf(stdout,"C%d Function: %s\n", i,
3710 cbus_mux[eeprom->cbus_function[i]]);
3714 /* Running MPROG show that C0..3 have fixed function Synchronous
3716 fprintf(stdout,"C%d BB Function: %s\n", i,
3719 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
3728 Get a value from the decoded EEPROM structure
3730 \param ftdi pointer to ftdi_context
3731 \param value_name Enum of the value to query
3732 \param value Pointer to store read value
3735 \retval -1: Value doesn't exist
3737 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3742 *value = ftdi->eeprom->vendor_id;
3745 *value = ftdi->eeprom->product_id;
3747 case RELEASE_NUMBER:
3748 *value = ftdi->eeprom->release_number;
3751 *value = ftdi->eeprom->self_powered;
3754 *value = ftdi->eeprom->remote_wakeup;
3757 *value = ftdi->eeprom->is_not_pnp;
3760 *value = ftdi->eeprom->suspend_dbus7;
3762 case IN_IS_ISOCHRONOUS:
3763 *value = ftdi->eeprom->in_is_isochronous;
3765 case OUT_IS_ISOCHRONOUS:
3766 *value = ftdi->eeprom->out_is_isochronous;
3768 case SUSPEND_PULL_DOWNS:
3769 *value = ftdi->eeprom->suspend_pull_downs;
3772 *value = ftdi->eeprom->use_serial;
3775 *value = ftdi->eeprom->usb_version;
3777 case USE_USB_VERSION:
3778 *value = ftdi->eeprom->use_usb_version;
3781 *value = ftdi->eeprom->max_power;
3783 case CHANNEL_A_TYPE:
3784 *value = ftdi->eeprom->channel_a_type;
3786 case CHANNEL_B_TYPE:
3787 *value = ftdi->eeprom->channel_b_type;
3789 case CHANNEL_A_DRIVER:
3790 *value = ftdi->eeprom->channel_a_driver;
3792 case CHANNEL_B_DRIVER:
3793 *value = ftdi->eeprom->channel_b_driver;
3795 case CHANNEL_C_DRIVER:
3796 *value = ftdi->eeprom->channel_c_driver;
3798 case CHANNEL_D_DRIVER:
3799 *value = ftdi->eeprom->channel_d_driver;
3801 case CHANNEL_A_RS485:
3802 *value = ftdi->eeprom->channel_a_rs485enable;
3804 case CHANNEL_B_RS485:
3805 *value = ftdi->eeprom->channel_b_rs485enable;
3807 case CHANNEL_C_RS485:
3808 *value = ftdi->eeprom->channel_c_rs485enable;
3810 case CHANNEL_D_RS485:
3811 *value = ftdi->eeprom->channel_d_rs485enable;
3813 case CBUS_FUNCTION_0:
3814 *value = ftdi->eeprom->cbus_function[0];
3816 case CBUS_FUNCTION_1:
3817 *value = ftdi->eeprom->cbus_function[1];
3819 case CBUS_FUNCTION_2:
3820 *value = ftdi->eeprom->cbus_function[2];
3822 case CBUS_FUNCTION_3:
3823 *value = ftdi->eeprom->cbus_function[3];
3825 case CBUS_FUNCTION_4:
3826 *value = ftdi->eeprom->cbus_function[4];
3828 case CBUS_FUNCTION_5:
3829 *value = ftdi->eeprom->cbus_function[5];
3831 case CBUS_FUNCTION_6:
3832 *value = ftdi->eeprom->cbus_function[6];
3834 case CBUS_FUNCTION_7:
3835 *value = ftdi->eeprom->cbus_function[7];
3837 case CBUS_FUNCTION_8:
3838 *value = ftdi->eeprom->cbus_function[8];
3840 case CBUS_FUNCTION_9:
3841 *value = ftdi->eeprom->cbus_function[9];
3844 *value = ftdi->eeprom->high_current;
3846 case HIGH_CURRENT_A:
3847 *value = ftdi->eeprom->high_current_a;
3849 case HIGH_CURRENT_B:
3850 *value = ftdi->eeprom->high_current_b;
3853 *value = ftdi->eeprom->invert;
3856 *value = ftdi->eeprom->group0_drive;
3858 case GROUP0_SCHMITT:
3859 *value = ftdi->eeprom->group0_schmitt;
3862 *value = ftdi->eeprom->group0_slew;
3865 *value = ftdi->eeprom->group1_drive;
3867 case GROUP1_SCHMITT:
3868 *value = ftdi->eeprom->group1_schmitt;
3871 *value = ftdi->eeprom->group1_slew;
3874 *value = ftdi->eeprom->group2_drive;
3876 case GROUP2_SCHMITT:
3877 *value = ftdi->eeprom->group2_schmitt;
3880 *value = ftdi->eeprom->group2_slew;
3883 *value = ftdi->eeprom->group3_drive;
3885 case GROUP3_SCHMITT:
3886 *value = ftdi->eeprom->group3_schmitt;
3889 *value = ftdi->eeprom->group3_slew;
3892 *value = ftdi->eeprom->powersave;
3894 case CLOCK_POLARITY:
3895 *value = ftdi->eeprom->clock_polarity;
3898 *value = ftdi->eeprom->data_order;
3901 *value = ftdi->eeprom->flow_control;
3904 *value = ftdi->eeprom->chip;
3907 *value = ftdi->eeprom->size;
3909 case EXTERNAL_OSCILLATOR:
3910 *value = ftdi->eeprom->external_oscillator;
3913 ftdi_error_return(-1, "Request for unknown EEPROM value");
3919 Set a value in the decoded EEPROM Structure
3920 No parameter checking is performed
3922 \param ftdi pointer to ftdi_context
3923 \param value_name Enum of the value to set
3927 \retval -1: Value doesn't exist
3928 \retval -2: Value not user settable
3930 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
3935 ftdi->eeprom->vendor_id = value;
3938 ftdi->eeprom->product_id = value;
3940 case RELEASE_NUMBER:
3941 ftdi->eeprom->release_number = value;
3944 ftdi->eeprom->self_powered = value;
3947 ftdi->eeprom->remote_wakeup = value;
3950 ftdi->eeprom->is_not_pnp = value;
3953 ftdi->eeprom->suspend_dbus7 = value;
3955 case IN_IS_ISOCHRONOUS:
3956 ftdi->eeprom->in_is_isochronous = value;
3958 case OUT_IS_ISOCHRONOUS:
3959 ftdi->eeprom->out_is_isochronous = value;
3961 case SUSPEND_PULL_DOWNS:
3962 ftdi->eeprom->suspend_pull_downs = value;
3965 ftdi->eeprom->use_serial = value;
3968 ftdi->eeprom->usb_version = value;
3970 case USE_USB_VERSION:
3971 ftdi->eeprom->use_usb_version = value;
3974 ftdi->eeprom->max_power = value;
3976 case CHANNEL_A_TYPE:
3977 ftdi->eeprom->channel_a_type = value;
3979 case CHANNEL_B_TYPE:
3980 ftdi->eeprom->channel_b_type = value;
3982 case CHANNEL_A_DRIVER:
3983 ftdi->eeprom->channel_a_driver = value;
3985 case CHANNEL_B_DRIVER:
3986 ftdi->eeprom->channel_b_driver = value;
3988 case CHANNEL_C_DRIVER:
3989 ftdi->eeprom->channel_c_driver = value;
3991 case CHANNEL_D_DRIVER:
3992 ftdi->eeprom->channel_d_driver = value;
3994 case CHANNEL_A_RS485:
3995 ftdi->eeprom->channel_a_rs485enable = value;
3997 case CHANNEL_B_RS485:
3998 ftdi->eeprom->channel_b_rs485enable = value;
4000 case CHANNEL_C_RS485:
4001 ftdi->eeprom->channel_c_rs485enable = value;
4003 case CHANNEL_D_RS485:
4004 ftdi->eeprom->channel_d_rs485enable = value;
4006 case CBUS_FUNCTION_0:
4007 ftdi->eeprom->cbus_function[0] = value;
4009 case CBUS_FUNCTION_1:
4010 ftdi->eeprom->cbus_function[1] = value;
4012 case CBUS_FUNCTION_2:
4013 ftdi->eeprom->cbus_function[2] = value;
4015 case CBUS_FUNCTION_3:
4016 ftdi->eeprom->cbus_function[3] = value;
4018 case CBUS_FUNCTION_4:
4019 ftdi->eeprom->cbus_function[4] = value;
4021 case CBUS_FUNCTION_5:
4022 ftdi->eeprom->cbus_function[5] = value;
4024 case CBUS_FUNCTION_6:
4025 ftdi->eeprom->cbus_function[6] = value;
4027 case CBUS_FUNCTION_7:
4028 ftdi->eeprom->cbus_function[7] = value;
4030 case CBUS_FUNCTION_8:
4031 ftdi->eeprom->cbus_function[8] = value;
4033 case CBUS_FUNCTION_9:
4034 ftdi->eeprom->cbus_function[9] = value;
4037 ftdi->eeprom->high_current = value;
4039 case HIGH_CURRENT_A:
4040 ftdi->eeprom->high_current_a = value;
4042 case HIGH_CURRENT_B:
4043 ftdi->eeprom->high_current_b = value;
4046 ftdi->eeprom->invert = value;
4049 ftdi->eeprom->group0_drive = value;
4051 case GROUP0_SCHMITT:
4052 ftdi->eeprom->group0_schmitt = value;
4055 ftdi->eeprom->group0_slew = value;
4058 ftdi->eeprom->group1_drive = value;
4060 case GROUP1_SCHMITT:
4061 ftdi->eeprom->group1_schmitt = value;
4064 ftdi->eeprom->group1_slew = value;
4067 ftdi->eeprom->group2_drive = value;
4069 case GROUP2_SCHMITT:
4070 ftdi->eeprom->group2_schmitt = value;
4073 ftdi->eeprom->group2_slew = value;
4076 ftdi->eeprom->group3_drive = value;
4078 case GROUP3_SCHMITT:
4079 ftdi->eeprom->group3_schmitt = value;
4082 ftdi->eeprom->group3_slew = value;
4085 ftdi->eeprom->chip = value;
4088 ftdi->eeprom->powersave = value;
4090 case CLOCK_POLARITY:
4091 ftdi->eeprom->clock_polarity = value;
4094 ftdi->eeprom->data_order = value;
4097 ftdi->eeprom->flow_control = value;
4100 ftdi_error_return(-2, "EEPROM Value can't be changed");
4102 case EXTERNAL_OSCILLATOR:
4103 ftdi->eeprom->external_oscillator = value;
4105 case USER_DATA_ADDR:
4106 ftdi->eeprom->user_data_addr = value;
4110 ftdi_error_return(-1, "Request to unknown EEPROM value");
4112 ftdi->eeprom->initialized_for_connected_device = 0;
4116 /** Get the read-only buffer to the binary EEPROM content
4118 \param ftdi pointer to ftdi_context
4119 \param buf buffer to receive EEPROM content
4120 \param size Size of receiving buffer
4123 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
4124 \retval -2: Not enough room to store eeprom
4126 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
4128 if (!ftdi || !(ftdi->eeprom))
4129 ftdi_error_return(-1, "No appropriate structure");
4131 if (!buf || size < ftdi->eeprom->size)
4132 ftdi_error_return(-1, "Not enough room to store eeprom");
4134 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4135 if (size > FTDI_MAX_EEPROM_SIZE)
4136 size = FTDI_MAX_EEPROM_SIZE;
4138 memcpy(buf, ftdi->eeprom->buf, size);
4143 /** Set the EEPROM content from the user-supplied prefilled buffer
4145 \param ftdi pointer to ftdi_context
4146 \param buf buffer to read EEPROM content
4147 \param size Size of buffer
4150 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
4152 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
4154 if (!ftdi || !(ftdi->eeprom) || !buf)
4155 ftdi_error_return(-1, "No appropriate structure");
4157 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4158 if (size > FTDI_MAX_EEPROM_SIZE)
4159 size = FTDI_MAX_EEPROM_SIZE;
4161 memcpy(ftdi->eeprom->buf, buf, size);
4166 /** Set the EEPROM user data content from the user-supplied prefilled buffer
4168 \param ftdi pointer to ftdi_context
4169 \param buf buffer to read EEPROM user data content
4170 \param size Size of buffer
4173 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
4175 int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size)
4177 if (!ftdi || !(ftdi->eeprom) || !buf)
4178 ftdi_error_return(-1, "No appropriate structure");
4180 ftdi->eeprom->user_data_size = size;
4181 ftdi->eeprom->user_data = buf;
4186 Read eeprom location
4188 \param ftdi pointer to ftdi_context
4189 \param eeprom_addr Address of eeprom location to be read
4190 \param eeprom_val Pointer to store read eeprom location
4193 \retval -1: read failed
4194 \retval -2: USB device unavailable
4196 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
4198 unsigned char buf[2];
4200 if (ftdi == NULL || ftdi->usb_dev == NULL)
4201 ftdi_error_return(-2, "USB device unavailable");
4203 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)
4204 ftdi_error_return(-1, "reading eeprom failed");
4206 *eeprom_val = (0xff & buf[0]) | (buf[1] << 8);
4214 \param ftdi pointer to ftdi_context
4217 \retval -1: read failed
4218 \retval -2: USB device unavailable
4220 int ftdi_read_eeprom(struct ftdi_context *ftdi)
4225 if (ftdi == NULL || ftdi->usb_dev == NULL)
4226 ftdi_error_return(-2, "USB device unavailable");
4227 buf = ftdi->eeprom->buf;
4229 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
4231 if (libusb_control_transfer(
4232 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
4233 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
4234 ftdi_error_return(-1, "reading eeprom failed");
4237 if (ftdi->type == TYPE_R)
4238 ftdi->eeprom->size = 0x80;
4239 /* Guesses size of eeprom by comparing halves
4240 - will not work with blank eeprom */
4241 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
4242 ftdi->eeprom->size = -1;
4243 else if (memcmp(buf,&buf[0x80],0x80) == 0)
4244 ftdi->eeprom->size = 0x80;
4245 else if (memcmp(buf,&buf[0x40],0x40) == 0)
4246 ftdi->eeprom->size = 0x40;
4248 ftdi->eeprom->size = 0x100;
4253 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
4254 Function is only used internally
4257 static unsigned char ftdi_read_chipid_shift(unsigned char value)
4259 return ((value & 1) << 1) |
4260 ((value & 2) << 5) |
4261 ((value & 4) >> 2) |
4262 ((value & 8) << 4) |
4263 ((value & 16) >> 1) |
4264 ((value & 32) >> 1) |
4265 ((value & 64) >> 4) |
4266 ((value & 128) >> 2);
4270 Read the FTDIChip-ID from R-type devices
4272 \param ftdi pointer to ftdi_context
4273 \param chipid Pointer to store FTDIChip-ID
4276 \retval -1: read failed
4277 \retval -2: USB device unavailable
4279 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
4281 unsigned int a = 0, b = 0;
4283 if (ftdi == NULL || ftdi->usb_dev == NULL)
4284 ftdi_error_return(-2, "USB device unavailable");
4286 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)
4288 a = a << 8 | a >> 8;
4289 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)
4291 b = b << 8 | b >> 8;
4292 a = (a << 16) | (b & 0xFFFF);
4293 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
4294 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
4295 *chipid = a ^ 0xa5f0f7d1;
4300 ftdi_error_return(-1, "read of FTDIChip-ID failed");
4304 Write eeprom location
4306 \param ftdi pointer to ftdi_context
4307 \param eeprom_addr Address of eeprom location to be written
4308 \param eeprom_val Value to be written
4311 \retval -1: write failed
4312 \retval -2: USB device unavailable
4313 \retval -3: Invalid access to checksum protected area below 0x80
4314 \retval -4: Device can't access unprotected area
4315 \retval -5: Reading chip type failed
4317 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
4318 unsigned short eeprom_val)
4320 int chip_type_location;
4321 unsigned short chip_type;
4323 if (ftdi == NULL || ftdi->usb_dev == NULL)
4324 ftdi_error_return(-2, "USB device unavailable");
4326 if (eeprom_addr <0x80)
4327 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
4334 chip_type_location = 0x14;
4338 chip_type_location = 0x18;
4341 chip_type_location = 0x1e;
4344 ftdi_error_return(-4, "Device can't access unprotected area");
4347 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
4348 ftdi_error_return(-5, "Reading failed");
4349 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
4350 if ((chip_type & 0xff) != 0x66)
4352 ftdi_error_return(-6, "EEPROM is not of 93x66");
4355 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4356 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
4357 NULL, 0, ftdi->usb_write_timeout) != 0)
4358 ftdi_error_return(-1, "unable to write eeprom");
4366 \param ftdi pointer to ftdi_context
4369 \retval -1: read failed
4370 \retval -2: USB device unavailable
4371 \retval -3: EEPROM not initialized for the connected device;
4373 int ftdi_write_eeprom(struct ftdi_context *ftdi)
4375 unsigned short usb_val, status;
4377 unsigned char *eeprom;
4379 if (ftdi == NULL || ftdi->usb_dev == NULL)
4380 ftdi_error_return(-2, "USB device unavailable");
4382 if(ftdi->eeprom->initialized_for_connected_device == 0)
4383 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
4385 eeprom = ftdi->eeprom->buf;
4387 /* These commands were traced while running MProg */
4388 if ((ret = ftdi_usb_reset(ftdi)) != 0)
4390 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
4392 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
4395 for (i = 0; i < ftdi->eeprom->size/2; i++)
4397 /* Do not try to write to reserved area */
4398 if ((ftdi->type == TYPE_230X) && (i == 0x40))
4402 usb_val = eeprom[i*2];
4403 usb_val += eeprom[(i*2)+1] << 8;
4404 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4405 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
4406 NULL, 0, ftdi->usb_write_timeout) < 0)
4407 ftdi_error_return(-1, "unable to write eeprom");
4416 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
4418 \param ftdi pointer to ftdi_context
4421 \retval -1: erase failed
4422 \retval -2: USB device unavailable
4423 \retval -3: Writing magic failed
4424 \retval -4: Read EEPROM failed
4425 \retval -5: Unexpected EEPROM value
4427 #define MAGIC 0x55aa
4428 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
4430 unsigned short eeprom_value;
4431 if (ftdi == NULL || ftdi->usb_dev == NULL)
4432 ftdi_error_return(-2, "USB device unavailable");
4434 if ((ftdi->type == TYPE_R) || (ftdi->type == TYPE_230X))
4436 ftdi->eeprom->chip = 0;
4440 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
4441 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4442 ftdi_error_return(-1, "unable to erase eeprom");
4445 /* detect chip type by writing 0x55AA as magic at word position 0xc0
4446 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
4447 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
4448 Chip is 93x66 if magic is only read at word position 0xc0*/
4449 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4450 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
4451 NULL, 0, ftdi->usb_write_timeout) != 0)
4452 ftdi_error_return(-3, "Writing magic failed");
4453 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
4454 ftdi_error_return(-4, "Reading failed");
4455 if (eeprom_value == MAGIC)
4457 ftdi->eeprom->chip = 0x46;
4461 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
4462 ftdi_error_return(-4, "Reading failed");
4463 if (eeprom_value == MAGIC)
4464 ftdi->eeprom->chip = 0x56;
4467 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
4468 ftdi_error_return(-4, "Reading failed");
4469 if (eeprom_value == MAGIC)
4470 ftdi->eeprom->chip = 0x66;
4473 ftdi->eeprom->chip = -1;
4477 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
4478 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4479 ftdi_error_return(-1, "unable to erase eeprom");
4484 Get string representation for last error code
4486 \param ftdi pointer to ftdi_context
4488 \retval Pointer to error string
4490 char *ftdi_get_error_string (struct ftdi_context *ftdi)
4495 return ftdi->error_str;
4498 /* @} end of doxygen libftdi group */