1 /***************************************************************************
5 copyright : (C) 2003-2011 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
15 ***************************************************************************/
18 \mainpage libftdi API documentation
20 Library to talk to FTDI chips. You find the latest versions of libftdi at
21 http://www.intra2net.com/en/developer/libftdi/
23 The library is easy to use. Have a look at this short example:
26 More examples can be found in the "examples" directory.
28 /** \addtogroup libftdi */
39 #include "ftdi_version_i.h"
41 #define ftdi_error_return(code, str) do { \
42 ftdi->error_str = str; \
46 #define ftdi_error_return_free_device_list(code, str, devs) do { \
47 libusb_free_device_list(devs,1); \
48 ftdi->error_str = str; \
54 Internal function to close usb device pointer.
55 Sets ftdi->usb_dev to NULL.
58 \param ftdi pointer to ftdi_context
62 static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
64 if (ftdi && ftdi->usb_dev)
66 libusb_close (ftdi->usb_dev);
69 ftdi->eeprom->initialized_for_connected_device = 0;
74 Initializes a ftdi_context.
76 \param ftdi pointer to ftdi_context
79 \retval -1: couldn't allocate read buffer
80 \retval -2: couldn't allocate struct buffer
81 \retval -3: libusb_init() failed
83 \remark This should be called before all functions
85 int ftdi_init(struct ftdi_context *ftdi)
87 struct ftdi_eeprom* eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
90 ftdi->usb_read_timeout = 5000;
91 ftdi->usb_write_timeout = 5000;
93 ftdi->type = TYPE_BM; /* chip type */
95 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
97 ftdi->readbuffer = NULL;
98 ftdi->readbuffer_offset = 0;
99 ftdi->readbuffer_remaining = 0;
100 ftdi->writebuffer_chunksize = 4096;
101 ftdi->max_packet_size = 0;
102 ftdi->error_str = NULL;
103 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
105 if (libusb_init(&ftdi->usb_ctx) < 0)
106 ftdi_error_return(-3, "libusb_init() failed");
108 ftdi_set_interface(ftdi, INTERFACE_ANY);
109 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
112 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
113 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
114 ftdi->eeprom = eeprom;
116 /* All fine. Now allocate the readbuffer */
117 return ftdi_read_data_set_chunksize(ftdi, 4096);
121 Allocate and initialize a new ftdi_context
123 \return a pointer to a new ftdi_context, or NULL on failure
125 struct ftdi_context *ftdi_new(void)
127 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
134 if (ftdi_init(ftdi) != 0)
144 Open selected channels on a chip, otherwise use first channel.
146 \param ftdi pointer to ftdi_context
147 \param interface Interface to use for FT2232C/2232H/4232H chips.
150 \retval -1: unknown interface
151 \retval -2: USB device unavailable
153 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
156 ftdi_error_return(-2, "USB device unavailable");
163 ftdi->index = INTERFACE_A;
169 ftdi->index = INTERFACE_B;
175 ftdi->index = INTERFACE_C;
181 ftdi->index = INTERFACE_D;
186 ftdi_error_return(-1, "Unknown interface");
192 Deinitializes a ftdi_context.
194 \param ftdi pointer to ftdi_context
196 void ftdi_deinit(struct ftdi_context *ftdi)
201 ftdi_usb_close_internal (ftdi);
203 if (ftdi->readbuffer != NULL)
205 free(ftdi->readbuffer);
206 ftdi->readbuffer = NULL;
209 if (ftdi->eeprom != NULL)
211 if (ftdi->eeprom->manufacturer != 0)
213 free(ftdi->eeprom->manufacturer);
214 ftdi->eeprom->manufacturer = 0;
216 if (ftdi->eeprom->product != 0)
218 free(ftdi->eeprom->product);
219 ftdi->eeprom->product = 0;
221 if (ftdi->eeprom->serial != 0)
223 free(ftdi->eeprom->serial);
224 ftdi->eeprom->serial = 0;
232 libusb_exit(ftdi->usb_ctx);
233 ftdi->usb_ctx = NULL;
238 Deinitialize and free an ftdi_context.
240 \param ftdi pointer to ftdi_context
242 void ftdi_free(struct ftdi_context *ftdi)
249 Use an already open libusb device.
251 \param ftdi pointer to ftdi_context
252 \param usb libusb libusb_device_handle to use
254 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
263 * @brief Get libftdi library version
265 * @return ftdi_version_info Library version information
267 struct ftdi_version_info ftdi_get_library_version()
269 struct ftdi_version_info ver;
271 ver.major = FTDI_MAJOR_VERSION;
272 ver.minor = FTDI_MINOR_VERSION;
273 ver.micro = FTDI_MICRO_VERSION;
274 ver.version_str = FTDI_VERSION_STRING;
275 ver.snapshot_str = FTDI_SNAPSHOT_VERSION;
281 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
282 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
283 use. With VID:PID 0:0, search for the default devices
284 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014)
286 \param ftdi pointer to ftdi_context
287 \param devlist Pointer where to store list of found devices
288 \param vendor Vendor ID to search for
289 \param product Product ID to search for
291 \retval >0: number of devices found
292 \retval -3: out of memory
293 \retval -5: libusb_get_device_list() failed
294 \retval -6: libusb_get_device_descriptor() failed
296 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
298 struct ftdi_device_list **curdev;
300 libusb_device **devs;
304 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
305 ftdi_error_return(-5, "libusb_get_device_list() failed");
310 while ((dev = devs[i++]) != NULL)
312 struct libusb_device_descriptor desc;
314 if (libusb_get_device_descriptor(dev, &desc) < 0)
315 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
317 if (((vendor != 0 && product != 0) &&
318 desc.idVendor == vendor && desc.idProduct == product) ||
319 ((vendor == 0 && product == 0) &&
320 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
321 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014)))
323 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
325 ftdi_error_return_free_device_list(-3, "out of memory", devs);
327 (*curdev)->next = NULL;
328 (*curdev)->dev = dev;
329 libusb_ref_device(dev);
330 curdev = &(*curdev)->next;
334 libusb_free_device_list(devs,1);
339 Frees a usb device list.
341 \param devlist USB device list created by ftdi_usb_find_all()
343 void ftdi_list_free(struct ftdi_device_list **devlist)
345 struct ftdi_device_list *curdev, *next;
347 for (curdev = *devlist; curdev != NULL;)
350 libusb_unref_device(curdev->dev);
359 Frees a usb device list.
361 \param devlist USB device list created by ftdi_usb_find_all()
363 void ftdi_list_free2(struct ftdi_device_list *devlist)
365 ftdi_list_free(&devlist);
369 Return device ID strings from the usb device.
371 The parameters manufacturer, description and serial may be NULL
372 or pointer to buffers to store the fetched strings.
374 \note Use this function only in combination with ftdi_usb_find_all()
375 as it closes the internal "usb_dev" after use.
377 \param ftdi pointer to ftdi_context
378 \param dev libusb usb_dev to use
379 \param manufacturer Store manufacturer string here if not NULL
380 \param mnf_len Buffer size of manufacturer string
381 \param description Store product description string here if not NULL
382 \param desc_len Buffer size of product description string
383 \param serial Store serial string here if not NULL
384 \param serial_len Buffer size of serial string
387 \retval -1: wrong arguments
388 \retval -4: unable to open device
389 \retval -7: get product manufacturer failed
390 \retval -8: get product description failed
391 \retval -9: get serial number failed
392 \retval -11: libusb_get_device_descriptor() failed
394 int ftdi_usb_get_strings(struct ftdi_context * ftdi, struct libusb_device * dev,
395 char * manufacturer, int mnf_len, char * description, int desc_len, char * serial, int serial_len)
397 struct libusb_device_descriptor desc;
399 if ((ftdi==NULL) || (dev==NULL))
402 if (libusb_open(dev, &ftdi->usb_dev) < 0)
403 ftdi_error_return(-4, "libusb_open() failed");
405 if (libusb_get_device_descriptor(dev, &desc) < 0)
406 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
408 if (manufacturer != NULL)
410 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
412 ftdi_usb_close_internal (ftdi);
413 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
417 if (description != NULL)
419 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
421 ftdi_usb_close_internal (ftdi);
422 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
428 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
430 ftdi_usb_close_internal (ftdi);
431 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
435 ftdi_usb_close_internal (ftdi);
441 * Internal function to determine the maximum packet size.
442 * \param ftdi pointer to ftdi_context
443 * \param dev libusb usb_dev to use
444 * \retval Maximum packet size for this device
446 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
448 struct libusb_device_descriptor desc;
449 struct libusb_config_descriptor *config0;
450 unsigned int packet_size;
453 if (ftdi == NULL || dev == NULL)
456 // Determine maximum packet size. Init with default value.
457 // New hi-speed devices from FTDI use a packet size of 512 bytes
458 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
459 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
464 if (libusb_get_device_descriptor(dev, &desc) < 0)
467 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
470 if (desc.bNumConfigurations > 0)
472 if (ftdi->interface < config0->bNumInterfaces)
474 struct libusb_interface interface = config0->interface[ftdi->interface];
475 if (interface.num_altsetting > 0)
477 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
478 if (descriptor.bNumEndpoints > 0)
480 packet_size = descriptor.endpoint[0].wMaxPacketSize;
486 libusb_free_config_descriptor (config0);
491 Opens a ftdi device given by an usb_device.
493 \param ftdi pointer to ftdi_context
494 \param dev libusb usb_dev to use
497 \retval -3: unable to config device
498 \retval -4: unable to open device
499 \retval -5: unable to claim device
500 \retval -6: reset failed
501 \retval -7: set baudrate failed
502 \retval -8: ftdi context invalid
503 \retval -9: libusb_get_device_descriptor() failed
504 \retval -10: libusb_get_config_descriptor() failed
505 \retval -11: libusb_detach_kernel_driver() failed
506 \retval -12: libusb_get_configuration() failed
508 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
510 struct libusb_device_descriptor desc;
511 struct libusb_config_descriptor *config0;
512 int cfg, cfg0, detach_errno = 0;
515 ftdi_error_return(-8, "ftdi context invalid");
517 if (libusb_open(dev, &ftdi->usb_dev) < 0)
518 ftdi_error_return(-4, "libusb_open() failed");
520 if (libusb_get_device_descriptor(dev, &desc) < 0)
521 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
523 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
524 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
525 cfg0 = config0->bConfigurationValue;
526 libusb_free_config_descriptor (config0);
528 // Try to detach ftdi_sio kernel module.
530 // The return code is kept in a separate variable and only parsed
531 // if usb_set_configuration() or usb_claim_interface() fails as the
532 // detach operation might be denied and everything still works fine.
533 // Likely scenario is a static ftdi_sio kernel module.
534 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
536 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
537 detach_errno = errno;
540 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
541 ftdi_error_return(-12, "libusb_get_configuration () failed");
542 // set configuration (needed especially for windows)
543 // tolerate EBUSY: one device with one configuration, but two interfaces
544 // and libftdi sessions to both interfaces (e.g. FT2232)
545 if (desc.bNumConfigurations > 0 && cfg != cfg0)
547 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
549 ftdi_usb_close_internal (ftdi);
550 if (detach_errno == EPERM)
552 ftdi_error_return(-8, "inappropriate permissions on device!");
556 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
561 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
563 ftdi_usb_close_internal (ftdi);
564 if (detach_errno == EPERM)
566 ftdi_error_return(-8, "inappropriate permissions on device!");
570 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
574 if (ftdi_usb_reset (ftdi) != 0)
576 ftdi_usb_close_internal (ftdi);
577 ftdi_error_return(-6, "ftdi_usb_reset failed");
580 // Try to guess chip type
581 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
582 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
583 && desc.iSerialNumber == 0))
584 ftdi->type = TYPE_BM;
585 else if (desc.bcdDevice == 0x200)
586 ftdi->type = TYPE_AM;
587 else if (desc.bcdDevice == 0x500)
588 ftdi->type = TYPE_2232C;
589 else if (desc.bcdDevice == 0x600)
591 else if (desc.bcdDevice == 0x700)
592 ftdi->type = TYPE_2232H;
593 else if (desc.bcdDevice == 0x800)
594 ftdi->type = TYPE_4232H;
595 else if (desc.bcdDevice == 0x900)
596 ftdi->type = TYPE_232H;
598 // Determine maximum packet size
599 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
601 if (ftdi_set_baudrate (ftdi, 9600) != 0)
603 ftdi_usb_close_internal (ftdi);
604 ftdi_error_return(-7, "set baudrate failed");
607 ftdi_error_return(0, "all fine");
611 Opens the first device with a given vendor and product ids.
613 \param ftdi pointer to ftdi_context
614 \param vendor Vendor ID
615 \param product Product ID
617 \retval same as ftdi_usb_open_desc()
619 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
621 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
625 Opens the first device with a given, vendor id, product id,
626 description and serial.
628 \param ftdi pointer to ftdi_context
629 \param vendor Vendor ID
630 \param product Product ID
631 \param description Description to search for. Use NULL if not needed.
632 \param serial Serial to search for. Use NULL if not needed.
635 \retval -3: usb device not found
636 \retval -4: unable to open device
637 \retval -5: unable to claim device
638 \retval -6: reset failed
639 \retval -7: set baudrate failed
640 \retval -8: get product description failed
641 \retval -9: get serial number failed
642 \retval -12: libusb_get_device_list() failed
643 \retval -13: libusb_get_device_descriptor() failed
645 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
646 const char* description, const char* serial)
648 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
652 Opens the index-th device with a given, vendor id, product id,
653 description and serial.
655 \param ftdi pointer to ftdi_context
656 \param vendor Vendor ID
657 \param product Product ID
658 \param description Description to search for. Use NULL if not needed.
659 \param serial Serial to search for. Use NULL if not needed.
660 \param index Number of matching device to open if there are more than one, starts with 0.
663 \retval -1: usb_find_busses() failed
664 \retval -2: usb_find_devices() failed
665 \retval -3: usb device not found
666 \retval -4: unable to open device
667 \retval -5: unable to claim device
668 \retval -6: reset failed
669 \retval -7: set baudrate failed
670 \retval -8: get product description failed
671 \retval -9: get serial number failed
672 \retval -10: unable to close device
673 \retval -11: ftdi context invalid
675 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
676 const char* description, const char* serial, unsigned int index)
679 libusb_device **devs;
684 ftdi_error_return(-11, "ftdi context invalid");
686 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
687 ftdi_error_return(-12, "libusb_get_device_list() failed");
689 while ((dev = devs[i++]) != NULL)
691 struct libusb_device_descriptor desc;
694 if (libusb_get_device_descriptor(dev, &desc) < 0)
695 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
697 if (desc.idVendor == vendor && desc.idProduct == product)
699 if (libusb_open(dev, &ftdi->usb_dev) < 0)
700 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
702 if (description != NULL)
704 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
706 ftdi_usb_close_internal (ftdi);
707 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
709 if (strncmp(string, description, sizeof(string)) != 0)
711 ftdi_usb_close_internal (ftdi);
717 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
719 ftdi_usb_close_internal (ftdi);
720 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
722 if (strncmp(string, serial, sizeof(string)) != 0)
724 ftdi_usb_close_internal (ftdi);
729 ftdi_usb_close_internal (ftdi);
737 res = ftdi_usb_open_dev(ftdi, dev);
738 libusb_free_device_list(devs,1);
744 ftdi_error_return_free_device_list(-3, "device not found", devs);
748 Opens the ftdi-device described by a description-string.
749 Intended to be used for parsing a device-description given as commandline argument.
751 \param ftdi pointer to ftdi_context
752 \param description NULL-terminated description-string, using this format:
753 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
754 \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")
755 \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
756 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
758 \note The description format may be extended in later versions.
761 \retval -2: libusb_get_device_list() failed
762 \retval -3: usb device not found
763 \retval -4: unable to open device
764 \retval -5: unable to claim device
765 \retval -6: reset failed
766 \retval -7: set baudrate failed
767 \retval -8: get product description failed
768 \retval -9: get serial number failed
769 \retval -10: unable to close device
770 \retval -11: illegal description format
771 \retval -12: ftdi context invalid
773 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
776 ftdi_error_return(-12, "ftdi context invalid");
778 if (description[0] == 0 || description[1] != ':')
779 ftdi_error_return(-11, "illegal description format");
781 if (description[0] == 'd')
784 libusb_device **devs;
785 unsigned int bus_number, device_address;
788 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
789 ftdi_error_return(-2, "libusb_get_device_list() failed");
791 /* XXX: This doesn't handle symlinks/odd paths/etc... */
792 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
793 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
795 while ((dev = devs[i++]) != NULL)
798 if (bus_number == libusb_get_bus_number (dev)
799 && device_address == libusb_get_device_address (dev))
801 ret = ftdi_usb_open_dev(ftdi, dev);
802 libusb_free_device_list(devs,1);
808 ftdi_error_return_free_device_list(-3, "device not found", devs);
810 else if (description[0] == 'i' || description[0] == 's')
813 unsigned int product;
814 unsigned int index=0;
815 const char *serial=NULL;
816 const char *startp, *endp;
819 startp=description+2;
820 vendor=strtoul((char*)startp,(char**)&endp,0);
821 if (*endp != ':' || endp == startp || errno != 0)
822 ftdi_error_return(-11, "illegal description format");
825 product=strtoul((char*)startp,(char**)&endp,0);
826 if (endp == startp || errno != 0)
827 ftdi_error_return(-11, "illegal description format");
829 if (description[0] == 'i' && *endp != 0)
831 /* optional index field in i-mode */
833 ftdi_error_return(-11, "illegal description format");
836 index=strtoul((char*)startp,(char**)&endp,0);
837 if (*endp != 0 || endp == startp || errno != 0)
838 ftdi_error_return(-11, "illegal description format");
840 if (description[0] == 's')
843 ftdi_error_return(-11, "illegal description format");
845 /* rest of the description is the serial */
849 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
853 ftdi_error_return(-11, "illegal description format");
858 Resets the ftdi device.
860 \param ftdi pointer to ftdi_context
863 \retval -1: FTDI reset failed
864 \retval -2: USB device unavailable
866 int ftdi_usb_reset(struct ftdi_context *ftdi)
868 if (ftdi == NULL || ftdi->usb_dev == NULL)
869 ftdi_error_return(-2, "USB device unavailable");
871 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
872 SIO_RESET_REQUEST, SIO_RESET_SIO,
873 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
874 ftdi_error_return(-1,"FTDI reset failed");
876 // Invalidate data in the readbuffer
877 ftdi->readbuffer_offset = 0;
878 ftdi->readbuffer_remaining = 0;
884 Clears the read buffer on the chip and the internal read buffer.
886 \param ftdi pointer to ftdi_context
889 \retval -1: read buffer purge failed
890 \retval -2: USB device unavailable
892 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
894 if (ftdi == NULL || ftdi->usb_dev == NULL)
895 ftdi_error_return(-2, "USB device unavailable");
897 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
898 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
899 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
900 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
902 // Invalidate data in the readbuffer
903 ftdi->readbuffer_offset = 0;
904 ftdi->readbuffer_remaining = 0;
910 Clears the write buffer on the chip.
912 \param ftdi pointer to ftdi_context
915 \retval -1: write buffer purge failed
916 \retval -2: USB device unavailable
918 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
920 if (ftdi == NULL || ftdi->usb_dev == NULL)
921 ftdi_error_return(-2, "USB device unavailable");
923 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
924 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
925 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
926 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
932 Clears the buffers on the chip and the internal read buffer.
934 \param ftdi pointer to ftdi_context
937 \retval -1: read buffer purge failed
938 \retval -2: write buffer purge failed
939 \retval -3: USB device unavailable
941 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
945 if (ftdi == NULL || ftdi->usb_dev == NULL)
946 ftdi_error_return(-3, "USB device unavailable");
948 result = ftdi_usb_purge_rx_buffer(ftdi);
952 result = ftdi_usb_purge_tx_buffer(ftdi);
962 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
964 \param ftdi pointer to ftdi_context
967 \retval -1: usb_release failed
968 \retval -3: ftdi context invalid
970 int ftdi_usb_close(struct ftdi_context *ftdi)
975 ftdi_error_return(-3, "ftdi context invalid");
977 if (ftdi->usb_dev != NULL)
978 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
981 ftdi_usb_close_internal (ftdi);
986 /* ftdi_to_clkbits_AM For the AM device, convert a requested baudrate
987 to encoded divisor and the achievable baudrate
988 Function is only used internally
995 From /2, 0.125/ 0.25 and 0.5 steps may be taken
996 The fractional part has frac_code encoding
998 static int ftdi_to_clkbits_AM(int baudrate, unsigned long *encoded_divisor)
1001 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1002 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
1003 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
1004 int divisor, best_divisor, best_baud, best_baud_diff;
1005 divisor = 24000000 / baudrate;
1008 // Round down to supported fraction (AM only)
1009 divisor -= am_adjust_dn[divisor & 7];
1011 // Try this divisor and the one above it (because division rounds down)
1015 for (i = 0; i < 2; i++)
1017 int try_divisor = divisor + i;
1021 // Round up to supported divisor value
1022 if (try_divisor <= 8)
1024 // Round up to minimum supported divisor
1027 else if (divisor < 16)
1029 // AM doesn't support divisors 9 through 15 inclusive
1034 // Round up to supported fraction (AM only)
1035 try_divisor += am_adjust_up[try_divisor & 7];
1036 if (try_divisor > 0x1FFF8)
1038 // Round down to maximum supported divisor value (for AM)
1039 try_divisor = 0x1FFF8;
1042 // Get estimated baud rate (to nearest integer)
1043 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1044 // Get absolute difference from requested baud rate
1045 if (baud_estimate < baudrate)
1047 baud_diff = baudrate - baud_estimate;
1051 baud_diff = baud_estimate - baudrate;
1053 if (i == 0 || baud_diff < best_baud_diff)
1055 // Closest to requested baud rate so far
1056 best_divisor = try_divisor;
1057 best_baud = baud_estimate;
1058 best_baud_diff = baud_diff;
1061 // Spot on! No point trying
1066 // Encode the best divisor value
1067 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1068 // Deal with special cases for encoded value
1069 if (*encoded_divisor == 1)
1071 *encoded_divisor = 0; // 3000000 baud
1073 else if (*encoded_divisor == 0x4001)
1075 *encoded_divisor = 1; // 2000000 baud (BM only)
1080 /* ftdi_to_clkbits Convert a requested baudrate for a given system clock and predivisor
1081 to encoded divisor and the achievable baudrate
1082 Function is only used internally
1089 From /2, 0.125 steps may be taken.
1090 The fractional part has frac_code encoding
1092 value[13:0] of value is the divisor
1093 index[9] mean 12 MHz Base(120 MHz/10) rate versus 3 MHz (48 MHz/16) else
1095 H Type have all features above with
1096 {index[8],value[15:14]} is the encoded subdivisor
1098 FT232R, FT2232 and FT232BM have no option for 12 MHz and with
1099 {index[0],value[15:14]} is the encoded subdivisor
1101 AM Type chips have only four fractional subdivisors at value[15:14]
1102 for subdivisors 0, 0.5, 0.25, 0.125
1104 static int ftdi_to_clkbits(int baudrate, unsigned int clk, int clk_div, unsigned long *encoded_divisor)
1106 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1108 int divisor, best_divisor;
1109 if (baudrate >= clk/clk_div)
1111 *encoded_divisor = 0;
1112 best_baud = clk/clk_div;
1114 else if (baudrate >= clk/(clk_div + clk_div/2))
1116 *encoded_divisor = 1;
1117 best_baud = clk/(clk_div + clk_div/2);
1119 else if (baudrate >= clk/(2*clk_div))
1121 *encoded_divisor = 2;
1122 best_baud = clk/(2*clk_div);
1126 /* We divide by 16 to have 3 fractional bits and one bit for rounding */
1127 divisor = clk*16/clk_div / baudrate;
1128 if (divisor & 1) /* Decide if to round up or down*/
1129 best_divisor = divisor /2 +1;
1131 best_divisor = divisor/2;
1132 if(best_divisor > 0x20000)
1133 best_divisor = 0x1ffff;
1134 best_baud = clk*16/clk_div/best_divisor;
1135 if (best_baud & 1) /* Decide if to round up or down*/
1136 best_baud = best_baud /2 +1;
1138 best_baud = best_baud /2;
1139 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 0x7] << 14);
1144 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
1145 Function is only used internally
1148 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
1149 unsigned short *value, unsigned short *index)
1152 unsigned long encoded_divisor;
1160 #define H_CLK 120000000
1161 #define C_CLK 48000000
1162 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H) || (ftdi->type == TYPE_232H ))
1164 if(baudrate*10 > H_CLK /0x3fff)
1166 /* On H Devices, use 12 000 000 Baudrate when possible
1167 We have a 14 bit divisor, a 1 bit divisor switch (10 or 16)
1168 three fractional bits and a 120 MHz clock
1169 Assume AN_120 "Sub-integer divisors between 0 and 2 are not allowed" holds for
1170 DIV/10 CLK too, so /1, /1.5 and /2 can be handled the same*/
1171 best_baud = ftdi_to_clkbits(baudrate, H_CLK, 10, &encoded_divisor);
1172 encoded_divisor |= 0x20000; /* switch on CLK/10*/
1175 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1177 else if ((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C) || (ftdi->type == TYPE_R ))
1179 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1183 best_baud = ftdi_to_clkbits_AM(baudrate, &encoded_divisor);
1185 // Split into "value" and "index" values
1186 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1187 if (ftdi->type == TYPE_2232H ||
1188 ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
1190 *index = (unsigned short)(encoded_divisor >> 8);
1192 *index |= ftdi->index;
1195 *index = (unsigned short)(encoded_divisor >> 16);
1197 // Return the nearest baud rate
1202 * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test
1203 * Do not use, it's only for the unit test framework
1205 int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi,
1206 unsigned short *value, unsigned short *index)
1208 return ftdi_convert_baudrate(baudrate, ftdi, value, index);
1212 Sets the chip baud rate
1214 \param ftdi pointer to ftdi_context
1215 \param baudrate baud rate to set
1218 \retval -1: invalid baudrate
1219 \retval -2: setting baudrate failed
1220 \retval -3: USB device unavailable
1222 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1224 unsigned short value, index;
1225 int actual_baudrate;
1227 if (ftdi == NULL || ftdi->usb_dev == NULL)
1228 ftdi_error_return(-3, "USB device unavailable");
1230 if (ftdi->bitbang_enabled)
1232 baudrate = baudrate*4;
1235 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1236 if (actual_baudrate <= 0)
1237 ftdi_error_return (-1, "Silly baudrate <= 0.");
1239 // Check within tolerance (about 5%)
1240 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1241 || ((actual_baudrate < baudrate)
1242 ? (actual_baudrate * 21 < baudrate * 20)
1243 : (baudrate * 21 < actual_baudrate * 20)))
1244 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1246 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1247 SIO_SET_BAUDRATE_REQUEST, value,
1248 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1249 ftdi_error_return (-2, "Setting new baudrate failed");
1251 ftdi->baudrate = baudrate;
1256 Set (RS232) line characteristics.
1257 The break type can only be set via ftdi_set_line_property2()
1258 and defaults to "off".
1260 \param ftdi pointer to ftdi_context
1261 \param bits Number of bits
1262 \param sbit Number of stop bits
1263 \param parity Parity mode
1266 \retval -1: Setting line property failed
1268 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1269 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1271 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1275 Set (RS232) line characteristics
1277 \param ftdi pointer to ftdi_context
1278 \param bits Number of bits
1279 \param sbit Number of stop bits
1280 \param parity Parity mode
1281 \param break_type Break type
1284 \retval -1: Setting line property failed
1285 \retval -2: USB device unavailable
1287 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1288 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1289 enum ftdi_break_type break_type)
1291 unsigned short value = bits;
1293 if (ftdi == NULL || ftdi->usb_dev == NULL)
1294 ftdi_error_return(-2, "USB device unavailable");
1299 value |= (0x00 << 8);
1302 value |= (0x01 << 8);
1305 value |= (0x02 << 8);
1308 value |= (0x03 << 8);
1311 value |= (0x04 << 8);
1318 value |= (0x00 << 11);
1321 value |= (0x01 << 11);
1324 value |= (0x02 << 11);
1331 value |= (0x00 << 14);
1334 value |= (0x01 << 14);
1338 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1339 SIO_SET_DATA_REQUEST, value,
1340 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1341 ftdi_error_return (-1, "Setting new line property failed");
1347 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1349 \param ftdi pointer to ftdi_context
1350 \param buf Buffer with the data
1351 \param size Size of the buffer
1353 \retval -666: USB device unavailable
1354 \retval <0: error code from usb_bulk_write()
1355 \retval >0: number of bytes written
1357 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1362 if (ftdi == NULL || ftdi->usb_dev == NULL)
1363 ftdi_error_return(-666, "USB device unavailable");
1365 while (offset < size)
1367 int write_size = ftdi->writebuffer_chunksize;
1369 if (offset+write_size > size)
1370 write_size = size-offset;
1372 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1373 ftdi_error_return(-1, "usb bulk write failed");
1375 offset += actual_length;
1381 static void ftdi_read_data_cb(struct libusb_transfer *transfer)
1383 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1384 struct ftdi_context *ftdi = tc->ftdi;
1385 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1387 packet_size = ftdi->max_packet_size;
1389 actual_length = transfer->actual_length;
1391 if (actual_length > 2)
1393 // skip FTDI status bytes.
1394 // Maybe stored in the future to enable modem use
1395 num_of_chunks = actual_length / packet_size;
1396 chunk_remains = actual_length % packet_size;
1397 //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);
1399 ftdi->readbuffer_offset += 2;
1402 if (actual_length > packet_size - 2)
1404 for (i = 1; i < num_of_chunks; i++)
1405 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1406 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1408 if (chunk_remains > 2)
1410 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1411 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1413 actual_length -= 2*num_of_chunks;
1416 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1419 if (actual_length > 0)
1421 // data still fits in buf?
1422 if (tc->offset + actual_length <= tc->size)
1424 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1425 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1426 tc->offset += actual_length;
1428 ftdi->readbuffer_offset = 0;
1429 ftdi->readbuffer_remaining = 0;
1431 /* Did we read exactly the right amount of bytes? */
1432 if (tc->offset == tc->size)
1434 //printf("read_data exact rem %d offset %d\n",
1435 //ftdi->readbuffer_remaining, offset);
1442 // only copy part of the data or size <= readbuffer_chunksize
1443 int part_size = tc->size - tc->offset;
1444 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1445 tc->offset += part_size;
1447 ftdi->readbuffer_offset += part_size;
1448 ftdi->readbuffer_remaining = actual_length - part_size;
1450 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1451 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1457 ret = libusb_submit_transfer (transfer);
1463 static void ftdi_write_data_cb(struct libusb_transfer *transfer)
1465 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1466 struct ftdi_context *ftdi = tc->ftdi;
1468 tc->offset += transfer->actual_length;
1470 if (tc->offset == tc->size)
1476 int write_size = ftdi->writebuffer_chunksize;
1479 if (tc->offset + write_size > tc->size)
1480 write_size = tc->size - tc->offset;
1482 transfer->length = write_size;
1483 transfer->buffer = tc->buf + tc->offset;
1484 ret = libusb_submit_transfer (transfer);
1492 Writes data to the chip. Does not wait for completion of the transfer
1493 nor does it make sure that the transfer was successful.
1495 Use libusb 1.0 asynchronous API.
1497 \param ftdi pointer to ftdi_context
1498 \param buf Buffer with the data
1499 \param size Size of the buffer
1501 \retval NULL: Some error happens when submit transfer
1502 \retval !NULL: Pointer to a ftdi_transfer_control
1505 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1507 struct ftdi_transfer_control *tc;
1508 struct libusb_transfer *transfer;
1509 int write_size, ret;
1511 if (ftdi == NULL || ftdi->usb_dev == NULL)
1514 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1518 transfer = libusb_alloc_transfer(0);
1531 if (size < ftdi->writebuffer_chunksize)
1534 write_size = ftdi->writebuffer_chunksize;
1536 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1537 write_size, ftdi_write_data_cb, tc,
1538 ftdi->usb_write_timeout);
1539 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1541 ret = libusb_submit_transfer(transfer);
1544 libusb_free_transfer(transfer);
1548 tc->transfer = transfer;
1554 Reads data from the chip. Does not wait for completion of the transfer
1555 nor does it make sure that the transfer was successful.
1557 Use libusb 1.0 asynchronous API.
1559 \param ftdi pointer to ftdi_context
1560 \param buf Buffer with the data
1561 \param size Size of the buffer
1563 \retval NULL: Some error happens when submit transfer
1564 \retval !NULL: Pointer to a ftdi_transfer_control
1567 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1569 struct ftdi_transfer_control *tc;
1570 struct libusb_transfer *transfer;
1573 if (ftdi == NULL || ftdi->usb_dev == NULL)
1576 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1584 if (size <= ftdi->readbuffer_remaining)
1586 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1589 ftdi->readbuffer_remaining -= size;
1590 ftdi->readbuffer_offset += size;
1592 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1596 tc->transfer = NULL;
1601 if (ftdi->readbuffer_remaining != 0)
1603 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1605 tc->offset = ftdi->readbuffer_remaining;
1610 transfer = libusb_alloc_transfer(0);
1617 ftdi->readbuffer_remaining = 0;
1618 ftdi->readbuffer_offset = 0;
1620 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);
1621 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1623 ret = libusb_submit_transfer(transfer);
1626 libusb_free_transfer(transfer);
1630 tc->transfer = transfer;
1636 Wait for completion of the transfer.
1638 Use libusb 1.0 asynchronous API.
1640 \param tc pointer to ftdi_transfer_control
1642 \retval < 0: Some error happens
1643 \retval >= 0: Data size transferred
1646 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1650 while (!tc->completed)
1652 ret = libusb_handle_events(tc->ftdi->usb_ctx);
1655 if (ret == LIBUSB_ERROR_INTERRUPTED)
1657 libusb_cancel_transfer(tc->transfer);
1658 while (!tc->completed)
1659 if (libusb_handle_events(tc->ftdi->usb_ctx) < 0)
1661 libusb_free_transfer(tc->transfer);
1669 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
1670 * at ftdi_read_data_submit(). Therefore, we need to check it here.
1674 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1676 libusb_free_transfer(tc->transfer);
1683 Configure write buffer chunk size.
1686 \param ftdi pointer to ftdi_context
1687 \param chunksize Chunk size
1690 \retval -1: ftdi context invalid
1692 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1695 ftdi_error_return(-1, "ftdi context invalid");
1697 ftdi->writebuffer_chunksize = chunksize;
1702 Get write buffer chunk size.
1704 \param ftdi pointer to ftdi_context
1705 \param chunksize Pointer to store chunk size in
1708 \retval -1: ftdi context invalid
1710 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1713 ftdi_error_return(-1, "ftdi context invalid");
1715 *chunksize = ftdi->writebuffer_chunksize;
1720 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1722 Automatically strips the two modem status bytes transfered during every read.
1724 \param ftdi pointer to ftdi_context
1725 \param buf Buffer to store data in
1726 \param size Size of the buffer
1728 \retval -666: USB device unavailable
1729 \retval <0: error code from libusb_bulk_transfer()
1730 \retval 0: no data was available
1731 \retval >0: number of bytes read
1734 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1736 int offset = 0, ret, i, num_of_chunks, chunk_remains;
1737 int packet_size = ftdi->max_packet_size;
1738 int actual_length = 1;
1740 if (ftdi == NULL || ftdi->usb_dev == NULL)
1741 ftdi_error_return(-666, "USB device unavailable");
1743 // Packet size sanity check (avoid division by zero)
1744 if (packet_size == 0)
1745 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
1747 // everything we want is still in the readbuffer?
1748 if (size <= ftdi->readbuffer_remaining)
1750 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1753 ftdi->readbuffer_remaining -= size;
1754 ftdi->readbuffer_offset += size;
1756 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1760 // something still in the readbuffer, but not enough to satisfy 'size'?
1761 if (ftdi->readbuffer_remaining != 0)
1763 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1766 offset += ftdi->readbuffer_remaining;
1768 // do the actual USB read
1769 while (offset < size && actual_length > 0)
1771 ftdi->readbuffer_remaining = 0;
1772 ftdi->readbuffer_offset = 0;
1773 /* returns how much received */
1774 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
1776 ftdi_error_return(ret, "usb bulk read failed");
1778 if (actual_length > 2)
1780 // skip FTDI status bytes.
1781 // Maybe stored in the future to enable modem use
1782 num_of_chunks = actual_length / packet_size;
1783 chunk_remains = actual_length % packet_size;
1784 //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);
1786 ftdi->readbuffer_offset += 2;
1789 if (actual_length > packet_size - 2)
1791 for (i = 1; i < num_of_chunks; i++)
1792 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1793 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1795 if (chunk_remains > 2)
1797 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1798 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1800 actual_length -= 2*num_of_chunks;
1803 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1806 else if (actual_length <= 2)
1808 // no more data to read?
1811 if (actual_length > 0)
1813 // data still fits in buf?
1814 if (offset+actual_length <= size)
1816 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
1817 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1818 offset += actual_length;
1820 /* Did we read exactly the right amount of bytes? */
1822 //printf("read_data exact rem %d offset %d\n",
1823 //ftdi->readbuffer_remaining, offset);
1828 // only copy part of the data or size <= readbuffer_chunksize
1829 int part_size = size-offset;
1830 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
1832 ftdi->readbuffer_offset += part_size;
1833 ftdi->readbuffer_remaining = actual_length-part_size;
1834 offset += part_size;
1836 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1837 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1848 Configure read buffer chunk size.
1851 Automatically reallocates the buffer.
1853 \param ftdi pointer to ftdi_context
1854 \param chunksize Chunk size
1857 \retval -1: ftdi context invalid
1859 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1861 unsigned char *new_buf;
1864 ftdi_error_return(-1, "ftdi context invalid");
1866 // Invalidate all remaining data
1867 ftdi->readbuffer_offset = 0;
1868 ftdi->readbuffer_remaining = 0;
1870 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
1871 which is defined in libusb-1.0. Otherwise, each USB read request will
1872 be divided into multiple URBs. This will cause issues on Linux kernel
1873 older than 2.6.32. */
1874 if (chunksize > 16384)
1878 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
1879 ftdi_error_return(-1, "out of memory for readbuffer");
1881 ftdi->readbuffer = new_buf;
1882 ftdi->readbuffer_chunksize = chunksize;
1888 Get read buffer chunk size.
1890 \param ftdi pointer to ftdi_context
1891 \param chunksize Pointer to store chunk size in
1894 \retval -1: FTDI context invalid
1896 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1899 ftdi_error_return(-1, "FTDI context invalid");
1901 *chunksize = ftdi->readbuffer_chunksize;
1907 Enable bitbang mode.
1909 \deprecated use \ref ftdi_set_bitmode with mode BITMODE_BITBANG instead
1911 \param ftdi pointer to ftdi_context
1912 \param bitmask Bitmask to configure lines.
1913 HIGH/ON value configures a line as output.
1916 \retval -1: can't enable bitbang mode
1917 \retval -2: USB device unavailable
1919 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
1921 unsigned short usb_val;
1923 if (ftdi == NULL || ftdi->usb_dev == NULL)
1924 ftdi_error_return(-2, "USB device unavailable");
1926 usb_val = bitmask; // low byte: bitmask
1927 /* FT2232C: Set bitbang_mode to 2 to enable SPI */
1928 usb_val |= (ftdi->bitbang_mode << 8);
1930 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1931 SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index,
1932 NULL, 0, ftdi->usb_write_timeout) < 0)
1933 ftdi_error_return(-1, "unable to enter bitbang mode. Perhaps not a BM type chip?");
1935 ftdi->bitbang_enabled = 1;
1940 Disable bitbang mode.
1942 \param ftdi pointer to ftdi_context
1945 \retval -1: can't disable bitbang mode
1946 \retval -2: USB device unavailable
1948 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
1950 if (ftdi == NULL || ftdi->usb_dev == NULL)
1951 ftdi_error_return(-2, "USB device unavailable");
1953 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)
1954 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
1956 ftdi->bitbang_enabled = 0;
1961 Enable/disable bitbang modes.
1963 \param ftdi pointer to ftdi_context
1964 \param bitmask Bitmask to configure lines.
1965 HIGH/ON value configures a line as output.
1966 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
1969 \retval -1: can't enable bitbang mode
1970 \retval -2: USB device unavailable
1972 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
1974 unsigned short usb_val;
1976 if (ftdi == NULL || ftdi->usb_dev == NULL)
1977 ftdi_error_return(-2, "USB device unavailable");
1979 usb_val = bitmask; // low byte: bitmask
1980 usb_val |= (mode << 8);
1981 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)
1982 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?");
1984 ftdi->bitbang_mode = mode;
1985 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
1990 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
1992 \param ftdi pointer to ftdi_context
1993 \param pins Pointer to store pins into
1996 \retval -1: read pins failed
1997 \retval -2: USB device unavailable
1999 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
2001 if (ftdi == NULL || ftdi->usb_dev == NULL)
2002 ftdi_error_return(-2, "USB device unavailable");
2004 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)
2005 ftdi_error_return(-1, "read pins failed");
2013 The FTDI chip keeps data in the internal buffer for a specific
2014 amount of time if the buffer is not full yet to decrease
2015 load on the usb bus.
2017 \param ftdi pointer to ftdi_context
2018 \param latency Value between 1 and 255
2021 \retval -1: latency out of range
2022 \retval -2: unable to set latency timer
2023 \retval -3: USB device unavailable
2025 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
2027 unsigned short usb_val;
2030 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
2032 if (ftdi == NULL || ftdi->usb_dev == NULL)
2033 ftdi_error_return(-3, "USB device unavailable");
2036 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)
2037 ftdi_error_return(-2, "unable to set latency timer");
2045 \param ftdi pointer to ftdi_context
2046 \param latency Pointer to store latency value in
2049 \retval -1: unable to get latency timer
2050 \retval -2: USB device unavailable
2052 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
2054 unsigned short usb_val;
2056 if (ftdi == NULL || ftdi->usb_dev == NULL)
2057 ftdi_error_return(-2, "USB device unavailable");
2059 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)
2060 ftdi_error_return(-1, "reading latency timer failed");
2062 *latency = (unsigned char)usb_val;
2067 Poll modem status information
2069 This function allows the retrieve the two status bytes of the device.
2070 The device sends these bytes also as a header for each read access
2071 where they are discarded by ftdi_read_data(). The chip generates
2072 the two stripped status bytes in the absence of data every 40 ms.
2074 Layout of the first byte:
2075 - B0..B3 - must be 0
2076 - B4 Clear to send (CTS)
2079 - B5 Data set ready (DTS)
2082 - B6 Ring indicator (RI)
2085 - B7 Receive line signal detect (RLSD)
2089 Layout of the second byte:
2090 - B0 Data ready (DR)
2091 - B1 Overrun error (OE)
2092 - B2 Parity error (PE)
2093 - B3 Framing error (FE)
2094 - B4 Break interrupt (BI)
2095 - B5 Transmitter holding register (THRE)
2096 - B6 Transmitter empty (TEMT)
2097 - B7 Error in RCVR FIFO
2099 \param ftdi pointer to ftdi_context
2100 \param status Pointer to store status information in. Must be two bytes.
2103 \retval -1: unable to retrieve status information
2104 \retval -2: USB device unavailable
2106 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
2110 if (ftdi == NULL || ftdi->usb_dev == NULL)
2111 ftdi_error_return(-2, "USB device unavailable");
2113 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)
2114 ftdi_error_return(-1, "getting modem status failed");
2116 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
2122 Set flowcontrol for ftdi chip
2124 \param ftdi pointer to ftdi_context
2125 \param flowctrl flow control to use. should be
2126 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS
2129 \retval -1: set flow control failed
2130 \retval -2: USB device unavailable
2132 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2134 if (ftdi == NULL || ftdi->usb_dev == NULL)
2135 ftdi_error_return(-2, "USB device unavailable");
2137 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2138 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2139 NULL, 0, ftdi->usb_write_timeout) < 0)
2140 ftdi_error_return(-1, "set flow control failed");
2148 \param ftdi pointer to ftdi_context
2149 \param state state to set line to (1 or 0)
2152 \retval -1: set dtr failed
2153 \retval -2: USB device unavailable
2155 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2157 unsigned short usb_val;
2159 if (ftdi == NULL || ftdi->usb_dev == NULL)
2160 ftdi_error_return(-2, "USB device unavailable");
2163 usb_val = SIO_SET_DTR_HIGH;
2165 usb_val = SIO_SET_DTR_LOW;
2167 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2168 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2169 NULL, 0, ftdi->usb_write_timeout) < 0)
2170 ftdi_error_return(-1, "set dtr failed");
2178 \param ftdi pointer to ftdi_context
2179 \param state state to set line to (1 or 0)
2182 \retval -1: set rts failed
2183 \retval -2: USB device unavailable
2185 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2187 unsigned short usb_val;
2189 if (ftdi == NULL || ftdi->usb_dev == NULL)
2190 ftdi_error_return(-2, "USB device unavailable");
2193 usb_val = SIO_SET_RTS_HIGH;
2195 usb_val = SIO_SET_RTS_LOW;
2197 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2198 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2199 NULL, 0, ftdi->usb_write_timeout) < 0)
2200 ftdi_error_return(-1, "set of rts failed");
2206 Set dtr and rts line in one pass
2208 \param ftdi pointer to ftdi_context
2209 \param dtr DTR state to set line to (1 or 0)
2210 \param rts RTS state to set line to (1 or 0)
2213 \retval -1: set dtr/rts failed
2214 \retval -2: USB device unavailable
2216 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2218 unsigned short usb_val;
2220 if (ftdi == NULL || ftdi->usb_dev == NULL)
2221 ftdi_error_return(-2, "USB device unavailable");
2224 usb_val = SIO_SET_DTR_HIGH;
2226 usb_val = SIO_SET_DTR_LOW;
2229 usb_val |= SIO_SET_RTS_HIGH;
2231 usb_val |= SIO_SET_RTS_LOW;
2233 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2234 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2235 NULL, 0, ftdi->usb_write_timeout) < 0)
2236 ftdi_error_return(-1, "set of rts/dtr failed");
2242 Set the special event character
2244 \param ftdi pointer to ftdi_context
2245 \param eventch Event character
2246 \param enable 0 to disable the event character, non-zero otherwise
2249 \retval -1: unable to set event character
2250 \retval -2: USB device unavailable
2252 int ftdi_set_event_char(struct ftdi_context *ftdi,
2253 unsigned char eventch, unsigned char enable)
2255 unsigned short usb_val;
2257 if (ftdi == NULL || ftdi->usb_dev == NULL)
2258 ftdi_error_return(-2, "USB device unavailable");
2264 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)
2265 ftdi_error_return(-1, "setting event character failed");
2273 \param ftdi pointer to ftdi_context
2274 \param errorch Error character
2275 \param enable 0 to disable the error character, non-zero otherwise
2278 \retval -1: unable to set error character
2279 \retval -2: USB device unavailable
2281 int ftdi_set_error_char(struct ftdi_context *ftdi,
2282 unsigned char errorch, unsigned char enable)
2284 unsigned short usb_val;
2286 if (ftdi == NULL || ftdi->usb_dev == NULL)
2287 ftdi_error_return(-2, "USB device unavailable");
2293 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)
2294 ftdi_error_return(-1, "setting error character failed");
2300 Init eeprom with default values for the connected device
2301 \param ftdi pointer to ftdi_context
2302 \param manufacturer String to use as Manufacturer
2303 \param product String to use as Product description
2304 \param serial String to use as Serial number description
2307 \retval -1: No struct ftdi_context
2308 \retval -2: No struct ftdi_eeprom
2309 \retval -3: No connected device or device not yet opened
2311 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
2312 char * product, char * serial)
2314 struct ftdi_eeprom *eeprom;
2317 ftdi_error_return(-1, "No struct ftdi_context");
2319 if (ftdi->eeprom == NULL)
2320 ftdi_error_return(-2,"No struct ftdi_eeprom");
2322 eeprom = ftdi->eeprom;
2323 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2325 if (ftdi->usb_dev == NULL)
2326 ftdi_error_return(-3, "No connected device or device not yet opened");
2328 eeprom->vendor_id = 0x0403;
2329 eeprom->use_serial = 1;
2330 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2331 (ftdi->type == TYPE_R))
2332 eeprom->product_id = 0x6001;
2333 else if (ftdi->type == TYPE_4232H)
2334 eeprom->product_id = 0x6011;
2335 else if (ftdi->type == TYPE_232H)
2336 eeprom->product_id = 0x6014;
2338 eeprom->product_id = 0x6010;
2339 if (ftdi->type == TYPE_AM)
2340 eeprom->usb_version = 0x0101;
2342 eeprom->usb_version = 0x0200;
2343 eeprom->max_power = 100;
2345 if (eeprom->manufacturer)
2346 free (eeprom->manufacturer);
2347 eeprom->manufacturer = NULL;
2350 eeprom->manufacturer = malloc(strlen(manufacturer)+1);
2351 if (eeprom->manufacturer)
2352 strcpy(eeprom->manufacturer, manufacturer);
2355 if (eeprom->product)
2356 free (eeprom->product);
2357 eeprom->product = NULL;
2360 eeprom->product = malloc(strlen(product)+1);
2361 if (eeprom->product)
2362 strcpy(eeprom->product, product);
2366 const char* default_product;
2369 case TYPE_AM: default_product = "AM"; break;
2370 case TYPE_BM: default_product = "BM"; break;
2371 case TYPE_2232C: default_product = "Dual RS232"; break;
2372 case TYPE_R: default_product = "FT232R USB UART"; break;
2373 case TYPE_2232H: default_product = "Dual RS232-HS"; break;
2374 case TYPE_4232H: default_product = "FT4232H"; break;
2375 case TYPE_232H: default_product = "Single-RS232-HS"; break;
2377 ftdi_error_return(-3, "Unknown chip type");
2379 eeprom->product = malloc(strlen(default_product) +1);
2380 if (eeprom->product)
2381 strcpy(eeprom->product, default_product);
2385 free (eeprom->serial);
2386 eeprom->serial = NULL;
2389 eeprom->serial = malloc(strlen(serial)+1);
2391 strcpy(eeprom->serial, serial);
2395 if (ftdi->type == TYPE_R)
2397 eeprom->max_power = 90;
2398 eeprom->size = 0x80;
2399 eeprom->cbus_function[0] = CBUS_TXLED;
2400 eeprom->cbus_function[1] = CBUS_RXLED;
2401 eeprom->cbus_function[2] = CBUS_TXDEN;
2402 eeprom->cbus_function[3] = CBUS_PWREN;
2403 eeprom->cbus_function[4] = CBUS_SLEEP;
2407 if(ftdi->type == TYPE_232H)
2410 for (i=0; i<10; i++)
2411 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2415 eeprom->initialized_for_connected_device = 1;
2418 /*FTD2XX doesn't check for values not fitting in the ACBUS Signal oprtions*/
2419 void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2424 int mode_low, mode_high;
2425 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2426 mode_low = CBUSH_TRISTATE;
2428 mode_low = eeprom->cbus_function[2*i];
2429 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2430 mode_high = CBUSH_TRISTATE;
2432 mode_high = eeprom->cbus_function[2*i];
2434 output[0x18+i] = mode_high <<4 | mode_low;
2437 /* Return the bits for the encoded EEPROM Structure of a requested Mode
2440 static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2449 case CHANNEL_IS_UART: return 0;
2450 case CHANNEL_IS_FIFO: return 0x01;
2451 case CHANNEL_IS_OPTO: return 0x02;
2452 case CHANNEL_IS_CPU : return 0x04;
2460 case CHANNEL_IS_UART : return 0;
2461 case CHANNEL_IS_FIFO : return 0x01;
2462 case CHANNEL_IS_OPTO : return 0x02;
2463 case CHANNEL_IS_CPU : return 0x04;
2464 case CHANNEL_IS_FT1284 : return 0x08;
2474 Build binary buffer from ftdi_eeprom structure.
2475 Output is suitable for ftdi_write_eeprom().
2477 \param ftdi pointer to ftdi_context
2479 \retval >=0: size of eeprom user area in bytes
2480 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2481 \retval -2: Invalid eeprom or ftdi pointer
2482 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2483 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2484 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2485 \retval -6: No connected EEPROM or EEPROM Type unknown
2487 int ftdi_eeprom_build(struct ftdi_context *ftdi)
2489 unsigned char i, j, eeprom_size_mask;
2490 unsigned short checksum, value;
2491 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2493 struct ftdi_eeprom *eeprom;
2494 unsigned char * output;
2497 ftdi_error_return(-2,"No context");
2498 if (ftdi->eeprom == NULL)
2499 ftdi_error_return(-2,"No eeprom structure");
2501 eeprom= ftdi->eeprom;
2502 output = eeprom->buf;
2504 if (eeprom->chip == -1)
2505 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2507 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2508 eeprom->size = 0x100;
2510 eeprom->size = 0x80;
2512 if (eeprom->manufacturer != NULL)
2513 manufacturer_size = strlen(eeprom->manufacturer);
2514 if (eeprom->product != NULL)
2515 product_size = strlen(eeprom->product);
2516 if (eeprom->serial != NULL)
2517 serial_size = strlen(eeprom->serial);
2519 // eeprom size check
2524 user_area_size = 96; // base size for strings (total of 48 characters)
2527 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2530 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2532 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2534 user_area_size = 86;
2537 user_area_size = 80;
2543 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
2545 if (user_area_size < 0)
2546 ftdi_error_return(-1,"eeprom size exceeded");
2549 memset (ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2551 // Bytes and Bits set for all Types
2553 // Addr 02: Vendor ID
2554 output[0x02] = eeprom->vendor_id;
2555 output[0x03] = eeprom->vendor_id >> 8;
2557 // Addr 04: Product ID
2558 output[0x04] = eeprom->product_id;
2559 output[0x05] = eeprom->product_id >> 8;
2561 // Addr 06: Device release number (0400h for BM features)
2562 output[0x06] = 0x00;
2566 output[0x07] = 0x02;
2569 output[0x07] = 0x04;
2572 output[0x07] = 0x05;
2575 output[0x07] = 0x06;
2578 output[0x07] = 0x07;
2581 output[0x07] = 0x08;
2584 output[0x07] = 0x09;
2587 output[0x07] = 0x00;
2590 // Addr 08: Config descriptor
2592 // Bit 6: 1 if this device is self powered, 0 if bus powered
2593 // Bit 5: 1 if this device uses remote wakeup
2594 // Bit 4-0: reserved - 0
2596 if (eeprom->self_powered == 1)
2598 if (eeprom->remote_wakeup == 1)
2602 // Addr 09: Max power consumption: max power = value * 2 mA
2603 output[0x09] = eeprom->max_power>>1;
2605 if (ftdi->type != TYPE_AM)
2607 // Addr 0A: Chip configuration
2608 // Bit 7: 0 - reserved
2609 // Bit 6: 0 - reserved
2610 // Bit 5: 0 - reserved
2611 // Bit 4: 1 - Change USB version
2612 // Bit 3: 1 - Use the serial number string
2613 // Bit 2: 1 - Enable suspend pull downs for lower power
2614 // Bit 1: 1 - Out EndPoint is Isochronous
2615 // Bit 0: 1 - In EndPoint is Isochronous
2618 if (eeprom->in_is_isochronous == 1)
2620 if (eeprom->out_is_isochronous == 1)
2626 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
2627 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
2645 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
2646 eeprom_size_mask = eeprom->size -1;
2648 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2649 // Addr 0F: Length of manufacturer string
2650 // Output manufacturer
2651 output[0x0E] = i; // calculate offset
2652 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
2653 output[i & eeprom_size_mask] = 0x03, i++; // type: string
2654 for (j = 0; j < manufacturer_size; j++)
2656 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
2657 output[i & eeprom_size_mask] = 0x00, i++;
2659 output[0x0F] = manufacturer_size*2 + 2;
2661 // Addr 10: Offset of the product string + 0x80, calculated later
2662 // Addr 11: Length of product string
2663 output[0x10] = i | 0x80; // calculate offset
2664 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
2665 output[i & eeprom_size_mask] = 0x03, i++;
2666 for (j = 0; j < product_size; j++)
2668 output[i & eeprom_size_mask] = eeprom->product[j], i++;
2669 output[i & eeprom_size_mask] = 0x00, i++;
2671 output[0x11] = product_size*2 + 2;
2673 // Addr 12: Offset of the serial string + 0x80, calculated later
2674 // Addr 13: Length of serial string
2675 output[0x12] = i | 0x80; // calculate offset
2676 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
2677 output[i & eeprom_size_mask] = 0x03, i++;
2678 for (j = 0; j < serial_size; j++)
2680 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
2681 output[i & eeprom_size_mask] = 0x00, i++;
2684 // Legacy port name and PnP fields for FT2232 and newer chips
2685 if (ftdi->type > TYPE_BM)
2687 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
2689 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
2691 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
2695 output[0x13] = serial_size*2 + 2;
2697 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
2699 if (eeprom->use_serial)
2700 output[0x0A] |= USE_SERIAL_NUM;
2702 output[0x0A] &= ~USE_SERIAL_NUM;
2705 /* Bytes and Bits specific to (some) types
2706 Write linear, as this allows easier fixing*/
2712 output[0x0C] = eeprom->usb_version & 0xff;
2713 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2714 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2715 output[0x0A] |= USE_USB_VERSION_BIT;
2717 output[0x0A] &= ~USE_USB_VERSION_BIT;
2722 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
2723 if ( eeprom->channel_a_driver == DRIVER_VCP)
2724 output[0x00] |= DRIVER_VCP;
2726 output[0x00] &= ~DRIVER_VCP;
2728 if ( eeprom->high_current_a == HIGH_CURRENT_DRIVE)
2729 output[0x00] |= HIGH_CURRENT_DRIVE;
2731 output[0x00] &= ~HIGH_CURRENT_DRIVE;
2733 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
2734 if ( eeprom->channel_b_driver == DRIVER_VCP)
2735 output[0x01] |= DRIVER_VCP;
2737 output[0x01] &= ~DRIVER_VCP;
2739 if ( eeprom->high_current_b == HIGH_CURRENT_DRIVE)
2740 output[0x01] |= HIGH_CURRENT_DRIVE;
2742 output[0x01] &= ~HIGH_CURRENT_DRIVE;
2744 if (eeprom->in_is_isochronous == 1)
2745 output[0x0A] |= 0x1;
2747 output[0x0A] &= ~0x1;
2748 if (eeprom->out_is_isochronous == 1)
2749 output[0x0A] |= 0x2;
2751 output[0x0A] &= ~0x2;
2752 if (eeprom->suspend_pull_downs == 1)
2753 output[0x0A] |= 0x4;
2755 output[0x0A] &= ~0x4;
2756 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2757 output[0x0A] |= USE_USB_VERSION_BIT;
2759 output[0x0A] &= ~USE_USB_VERSION_BIT;
2761 output[0x0C] = eeprom->usb_version & 0xff;
2762 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2763 output[0x14] = eeprom->chip;
2766 if (eeprom->high_current == HIGH_CURRENT_DRIVE_R)
2767 output[0x00] |= HIGH_CURRENT_DRIVE_R;
2768 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
2770 if (eeprom->suspend_pull_downs == 1)
2771 output[0x0A] |= 0x4;
2773 output[0x0A] &= ~0x4;
2774 output[0x0B] = eeprom->invert;
2775 output[0x0C] = eeprom->usb_version & 0xff;
2776 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2778 if (eeprom->cbus_function[0] > CBUS_BB)
2779 output[0x14] = CBUS_TXLED;
2781 output[0x14] = eeprom->cbus_function[0];
2783 if (eeprom->cbus_function[1] > CBUS_BB)
2784 output[0x14] |= CBUS_RXLED<<4;
2786 output[0x14] |= eeprom->cbus_function[1]<<4;
2788 if (eeprom->cbus_function[2] > CBUS_BB)
2789 output[0x15] = CBUS_TXDEN;
2791 output[0x15] = eeprom->cbus_function[2];
2793 if (eeprom->cbus_function[3] > CBUS_BB)
2794 output[0x15] |= CBUS_PWREN<<4;
2796 output[0x15] |= eeprom->cbus_function[3]<<4;
2798 if (eeprom->cbus_function[4] > CBUS_CLK6)
2799 output[0x16] = CBUS_SLEEP;
2801 output[0x16] = eeprom->cbus_function[4];
2804 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
2805 if ( eeprom->channel_a_driver == DRIVER_VCP)
2806 output[0x00] |= DRIVER_VCP;
2808 output[0x00] &= ~DRIVER_VCP;
2810 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
2811 if ( eeprom->channel_b_driver == DRIVER_VCP)
2812 output[0x01] |= DRIVER_VCP;
2814 output[0x01] &= ~DRIVER_VCP;
2815 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
2816 output[0x01] |= SUSPEND_DBUS7_BIT;
2818 output[0x01] &= ~SUSPEND_DBUS7_BIT;
2820 if (eeprom->suspend_pull_downs == 1)
2821 output[0x0A] |= 0x4;
2823 output[0x0A] &= ~0x4;
2825 if (eeprom->group0_drive > DRIVE_16MA)
2826 output[0x0c] |= DRIVE_16MA;
2828 output[0x0c] |= eeprom->group0_drive;
2829 if (eeprom->group0_schmitt == IS_SCHMITT)
2830 output[0x0c] |= IS_SCHMITT;
2831 if (eeprom->group0_slew == SLOW_SLEW)
2832 output[0x0c] |= SLOW_SLEW;
2834 if (eeprom->group1_drive > DRIVE_16MA)
2835 output[0x0c] |= DRIVE_16MA<<4;
2837 output[0x0c] |= eeprom->group1_drive<<4;
2838 if (eeprom->group1_schmitt == IS_SCHMITT)
2839 output[0x0c] |= IS_SCHMITT<<4;
2840 if (eeprom->group1_slew == SLOW_SLEW)
2841 output[0x0c] |= SLOW_SLEW<<4;
2843 if (eeprom->group2_drive > DRIVE_16MA)
2844 output[0x0d] |= DRIVE_16MA;
2846 output[0x0d] |= eeprom->group2_drive;
2847 if (eeprom->group2_schmitt == IS_SCHMITT)
2848 output[0x0d] |= IS_SCHMITT;
2849 if (eeprom->group2_slew == SLOW_SLEW)
2850 output[0x0d] |= SLOW_SLEW;
2852 if (eeprom->group3_drive > DRIVE_16MA)
2853 output[0x0d] |= DRIVE_16MA<<4;
2855 output[0x0d] |= eeprom->group3_drive<<4;
2856 if (eeprom->group3_schmitt == IS_SCHMITT)
2857 output[0x0d] |= IS_SCHMITT<<4;
2858 if (eeprom->group3_slew == SLOW_SLEW)
2859 output[0x0d] |= SLOW_SLEW<<4;
2861 output[0x18] = eeprom->chip;
2865 output[0x18] = eeprom->chip;
2866 fprintf(stderr,"FIXME: Build FT4232H specific EEPROM settings\n");
2869 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
2870 if ( eeprom->channel_a_driver == DRIVER_VCP)
2871 output[0x00] |= DRIVER_VCPH;
2873 output[0x00] &= ~DRIVER_VCPH;
2874 if (eeprom->powersave)
2875 output[0x01] |= POWER_SAVE_DISABLE_H;
2877 output[0x01] &= ~POWER_SAVE_DISABLE_H;
2878 if (eeprom->clock_polarity)
2879 output[0x01] |= FT1284_CLK_IDLE_STATE;
2881 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
2882 if (eeprom->data_order)
2883 output[0x01] |= FT1284_DATA_LSB;
2885 output[0x01] &= ~FT1284_DATA_LSB;
2886 if (eeprom->flow_control)
2887 output[0x01] |= FT1284_FLOW_CONTROL;
2889 output[0x01] &= ~FT1284_FLOW_CONTROL;
2890 if (eeprom->group0_drive > DRIVE_16MA)
2891 output[0x0c] |= DRIVE_16MA;
2893 output[0x0c] |= eeprom->group0_drive;
2894 if (eeprom->group0_schmitt == IS_SCHMITT)
2895 output[0x0c] |= IS_SCHMITT;
2896 if (eeprom->group0_slew == SLOW_SLEW)
2897 output[0x0c] |= SLOW_SLEW;
2899 if (eeprom->group1_drive > DRIVE_16MA)
2900 output[0x0d] |= DRIVE_16MA;
2902 output[0x0d] |= eeprom->group1_drive;
2903 if (eeprom->group1_schmitt == IS_SCHMITT)
2904 output[0x0d] |= IS_SCHMITT;
2905 if (eeprom->group1_slew == SLOW_SLEW)
2906 output[0x0d] |= SLOW_SLEW;
2908 set_ft232h_cbus(eeprom, output);
2910 output[0x1e] = eeprom->chip;
2911 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
2916 // calculate checksum
2919 for (i = 0; i < eeprom->size/2-1; i++)
2921 value = output[i*2];
2922 value += output[(i*2)+1] << 8;
2924 checksum = value^checksum;
2925 checksum = (checksum << 1) | (checksum >> 15);
2928 output[eeprom->size-2] = checksum;
2929 output[eeprom->size-1] = checksum >> 8;
2931 return user_area_size;
2933 /* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
2936 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
2938 static unsigned char bit2type(unsigned char bits)
2942 case 0: return CHANNEL_IS_UART;
2943 case 1: return CHANNEL_IS_FIFO;
2944 case 2: return CHANNEL_IS_OPTO;
2945 case 4: return CHANNEL_IS_CPU;
2946 case 8: return CHANNEL_IS_FT1284;
2948 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
2954 Decode binary EEPROM image into an ftdi_eeprom structure.
2956 \param ftdi pointer to ftdi_context
2957 \param verbose Decode EEPROM on stdout
2960 \retval -1: something went wrong
2962 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
2963 FIXME: Strings are malloc'ed here and should be freed somewhere
2965 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
2968 unsigned short checksum, eeprom_checksum, value;
2969 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2971 struct ftdi_eeprom *eeprom;
2972 unsigned char *buf = ftdi->eeprom->buf;
2976 ftdi_error_return(-1,"No context");
2977 if (ftdi->eeprom == NULL)
2978 ftdi_error_return(-1,"No eeprom structure");
2980 eeprom = ftdi->eeprom;
2981 eeprom_size = eeprom->size;
2983 // Addr 02: Vendor ID
2984 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
2986 // Addr 04: Product ID
2987 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
2989 release = buf[0x06] + (buf[0x07]<<8);
2991 // Addr 08: Config descriptor
2993 // Bit 6: 1 if this device is self powered, 0 if bus powered
2994 // Bit 5: 1 if this device uses remote wakeup
2995 eeprom->self_powered = buf[0x08] & 0x40;
2996 eeprom->remote_wakeup = buf[0x08] & 0x20;
2998 // Addr 09: Max power consumption: max power = value * 2 mA
2999 eeprom->max_power = buf[0x09];
3001 // Addr 0A: Chip configuration
3002 // Bit 7: 0 - reserved
3003 // Bit 6: 0 - reserved
3004 // Bit 5: 0 - reserved
3005 // Bit 4: 1 - Change USB version on BM and 2232C
3006 // Bit 3: 1 - Use the serial number string
3007 // Bit 2: 1 - Enable suspend pull downs for lower power
3008 // Bit 1: 1 - Out EndPoint is Isochronous
3009 // Bit 0: 1 - In EndPoint is Isochronous
3011 eeprom->in_is_isochronous = buf[0x0A]&0x01;
3012 eeprom->out_is_isochronous = buf[0x0A]&0x02;
3013 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
3014 eeprom->use_serial = (buf[0x0A] & USE_SERIAL_NUM)?1:0;
3015 eeprom->use_usb_version = buf[0x0A] & USE_USB_VERSION_BIT;
3017 // Addr 0C: USB version low byte when 0x0A
3018 // Addr 0D: USB version high byte when 0x0A
3019 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
3021 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
3022 // Addr 0F: Length of manufacturer string
3023 manufacturer_size = buf[0x0F]/2;
3024 if (eeprom->manufacturer)
3025 free(eeprom->manufacturer);
3026 if (manufacturer_size > 0)
3028 eeprom->manufacturer = malloc(manufacturer_size);
3029 if (eeprom->manufacturer)
3031 // Decode manufacturer
3032 i = buf[0x0E] & (eeprom_size -1); // offset
3033 for (j=0;j<manufacturer_size-1;j++)
3035 eeprom->manufacturer[j] = buf[2*j+i+2];
3037 eeprom->manufacturer[j] = '\0';
3040 else eeprom->manufacturer = NULL;
3042 // Addr 10: Offset of the product string + 0x80, calculated later
3043 // Addr 11: Length of product string
3044 if (eeprom->product)
3045 free(eeprom->product);
3046 product_size = buf[0x11]/2;
3047 if (product_size > 0)
3049 eeprom->product = malloc(product_size);
3050 if (eeprom->product)
3052 // Decode product name
3053 i = buf[0x10] & (eeprom_size -1); // offset
3054 for (j=0;j<product_size-1;j++)
3056 eeprom->product[j] = buf[2*j+i+2];
3058 eeprom->product[j] = '\0';
3061 else eeprom->product = NULL;
3063 // Addr 12: Offset of the serial string + 0x80, calculated later
3064 // Addr 13: Length of serial string
3066 free(eeprom->serial);
3067 serial_size = buf[0x13]/2;
3068 if (serial_size > 0)
3070 eeprom->serial = malloc(serial_size);
3074 i = buf[0x12] & (eeprom_size -1); // offset
3075 for (j=0;j<serial_size-1;j++)
3077 eeprom->serial[j] = buf[2*j+i+2];
3079 eeprom->serial[j] = '\0';
3082 else eeprom->serial = NULL;
3087 for (i = 0; i < eeprom_size/2-1; i++)
3090 value += buf[(i*2)+1] << 8;
3092 checksum = value^checksum;
3093 checksum = (checksum << 1) | (checksum >> 15);
3096 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
3098 if (eeprom_checksum != checksum)
3100 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
3101 ftdi_error_return(-1,"EEPROM checksum error");
3104 eeprom->channel_a_type = 0;
3105 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
3109 else if (ftdi->type == TYPE_2232C)
3111 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3112 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3113 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
3114 eeprom->channel_b_type = buf[0x01] & 0x7;
3115 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3116 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
3117 eeprom->chip = buf[0x14];
3119 else if (ftdi->type == TYPE_R)
3121 /* TYPE_R flags D2XX, not VCP as all others*/
3122 eeprom->channel_a_driver = (~buf[0x00]) & DRIVER_VCP;
3123 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
3124 if ( (buf[0x01]&0x40) != 0x40)
3126 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
3127 " If this happened with the\n"
3128 " EEPROM programmed by FTDI tools, please report "
3129 "to libftdi@developer.intra2net.com\n");
3131 eeprom->chip = buf[0x16];
3132 // Addr 0B: Invert data lines
3133 // Works only on FT232R, not FT245R, but no way to distinguish
3134 eeprom->invert = buf[0x0B];
3135 // Addr 14: CBUS function: CBUS0, CBUS1
3136 // Addr 15: CBUS function: CBUS2, CBUS3
3137 // Addr 16: CBUS function: CBUS5
3138 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3139 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3140 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3141 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3142 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
3144 else if ((ftdi->type == TYPE_2232H) ||(ftdi->type == TYPE_4232H))
3146 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3147 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3148 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
3149 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3151 if (ftdi->type == TYPE_2232H)
3152 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
3154 eeprom->chip = buf[0x18];
3155 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3156 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3157 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3158 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3159 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3160 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3161 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3162 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3163 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3164 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3165 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3166 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
3168 else if (ftdi->type == TYPE_232H)
3172 eeprom->channel_a_type = buf[0x00] & 0xf;
3173 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
3174 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3175 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3176 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
3177 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
3178 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3179 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3180 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3181 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3182 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3183 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3187 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3188 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3190 eeprom->chip = buf[0x1e];
3191 /*FIXME: Decipher more values*/
3196 char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
3197 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3198 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
3199 fprintf(stdout, "Release: 0x%04x\n",release);
3201 if (eeprom->self_powered)
3202 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3204 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power * 2,
3205 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
3206 if (eeprom->manufacturer)
3207 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
3208 if (eeprom->product)
3209 fprintf(stdout, "Product: %s\n",eeprom->product);
3211 fprintf(stdout, "Serial: %s\n",eeprom->serial);
3212 fprintf(stdout, "Checksum : %04x\n", checksum);
3213 if (ftdi->type == TYPE_R)
3214 fprintf(stdout, "Internal EEPROM\n");
3215 else if (eeprom->chip >= 0x46)
3216 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
3217 if (eeprom->suspend_dbus7)
3218 fprintf(stdout, "Suspend on DBUS7\n");
3219 if (eeprom->suspend_pull_downs)
3220 fprintf(stdout, "Pull IO pins low during suspend\n");
3221 if(eeprom->powersave)
3223 if(ftdi->type >= TYPE_232H)
3224 fprintf(stdout,"Enter low power state on ACBUS7\n");
3226 if (eeprom->remote_wakeup)
3227 fprintf(stdout, "Enable Remote Wake Up\n");
3228 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
3229 if (ftdi->type >= TYPE_2232C)
3230 fprintf(stdout,"Channel A has Mode %s%s%s\n",
3231 channel_mode[eeprom->channel_a_type],
3232 (eeprom->channel_a_driver)?" VCP":"",
3233 (eeprom->high_current_a)?" High Current IO":"");
3234 if (ftdi->type >= TYPE_232H)
3236 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3237 (eeprom->clock_polarity)?"HIGH":"LOW",
3238 (eeprom->data_order)?"LSB":"MSB",
3239 (eeprom->flow_control)?"":"No ");
3241 if ((ftdi->type >= TYPE_2232C) && (ftdi->type != TYPE_R) && (ftdi->type != TYPE_232H))
3242 fprintf(stdout,"Channel B has Mode %s%s%s\n",
3243 channel_mode[eeprom->channel_b_type],
3244 (eeprom->channel_b_driver)?" VCP":"",
3245 (eeprom->high_current_b)?" High Current IO":"");
3246 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3247 eeprom->use_usb_version == USE_USB_VERSION_BIT)
3248 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3250 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3252 fprintf(stdout,"%s has %d mA drive%s%s\n",
3253 (ftdi->type == TYPE_2232H)?"AL":"A",
3254 (eeprom->group0_drive+1) *4,
3255 (eeprom->group0_schmitt)?" Schmitt Input":"",
3256 (eeprom->group0_slew)?" Slow Slew":"");
3257 fprintf(stdout,"%s has %d mA drive%s%s\n",
3258 (ftdi->type == TYPE_2232H)?"AH":"B",
3259 (eeprom->group1_drive+1) *4,
3260 (eeprom->group1_schmitt)?" Schmitt Input":"",
3261 (eeprom->group1_slew)?" Slow Slew":"");
3262 fprintf(stdout,"%s has %d mA drive%s%s\n",
3263 (ftdi->type == TYPE_2232H)?"BL":"C",
3264 (eeprom->group2_drive+1) *4,
3265 (eeprom->group2_schmitt)?" Schmitt Input":"",
3266 (eeprom->group2_slew)?" Slow Slew":"");
3267 fprintf(stdout,"%s has %d mA drive%s%s\n",
3268 (ftdi->type == TYPE_2232H)?"BH":"D",
3269 (eeprom->group3_drive+1) *4,
3270 (eeprom->group3_schmitt)?" Schmitt Input":"",
3271 (eeprom->group3_slew)?" Slow Slew":"");
3273 else if (ftdi->type == TYPE_232H)
3276 char *cbush_mux[] = {"TRISTATE","RXLED","TXLED", "TXRXLED","PWREN",
3277 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3278 "CLK30","CLK15","CLK7_5"
3280 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3281 (eeprom->group0_drive+1) *4,
3282 (eeprom->group0_schmitt)?" Schmitt Input":"",
3283 (eeprom->group0_slew)?" Slow Slew":"");
3284 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3285 (eeprom->group1_drive+1) *4,
3286 (eeprom->group1_schmitt)?" Schmitt Input":"",
3287 (eeprom->group1_slew)?" Slow Slew":"");
3288 for (i=0; i<10; i++)
3290 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3291 fprintf(stdout,"C%d Function: %s\n", i,
3292 cbush_mux[eeprom->cbus_function[i]]);
3297 if (ftdi->type == TYPE_R)
3299 char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
3300 "SLEEP","CLK48","CLK24","CLK12","CLK6",
3301 "IOMODE","BB_WR","BB_RD"
3303 char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
3307 char *r_bits[] = {"TXD","RXD","RTS", "CTS","DTR","DSR","DCD","RI"};
3308 fprintf(stdout,"Inverted bits:");
3310 if ((eeprom->invert & (1<<i)) == (1<<i))
3311 fprintf(stdout," %s",r_bits[i]);
3312 fprintf(stdout,"\n");
3316 if (eeprom->cbus_function[i]<CBUS_BB)
3317 fprintf(stdout,"C%d Function: %s\n", i,
3318 cbus_mux[eeprom->cbus_function[i]]);
3322 /* Running MPROG show that C0..3 have fixed function Synchronous
3324 fprintf(stdout,"C%d BB Function: %s\n", i,
3327 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
3336 Get a value from the decoded EEPROM structure
3338 \param ftdi pointer to ftdi_context
3339 \param value_name Enum of the value to query
3340 \param value Pointer to store read value
3343 \retval -1: Value doesn't exist
3345 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3350 *value = ftdi->eeprom->vendor_id;
3353 *value = ftdi->eeprom->product_id;
3356 *value = ftdi->eeprom->self_powered;
3359 *value = ftdi->eeprom->remote_wakeup;
3362 *value = ftdi->eeprom->is_not_pnp;
3365 *value = ftdi->eeprom->suspend_dbus7;
3367 case IN_IS_ISOCHRONOUS:
3368 *value = ftdi->eeprom->in_is_isochronous;
3370 case OUT_IS_ISOCHRONOUS:
3371 *value = ftdi->eeprom->out_is_isochronous;
3373 case SUSPEND_PULL_DOWNS:
3374 *value = ftdi->eeprom->suspend_pull_downs;
3377 *value = ftdi->eeprom->use_serial;
3380 *value = ftdi->eeprom->usb_version;
3382 case USE_USB_VERSION:
3383 *value = ftdi->eeprom->use_usb_version;
3386 *value = ftdi->eeprom->max_power;
3388 case CHANNEL_A_TYPE:
3389 *value = ftdi->eeprom->channel_a_type;
3391 case CHANNEL_B_TYPE:
3392 *value = ftdi->eeprom->channel_b_type;
3394 case CHANNEL_A_DRIVER:
3395 *value = ftdi->eeprom->channel_a_driver;
3397 case CHANNEL_B_DRIVER:
3398 *value = ftdi->eeprom->channel_b_driver;
3400 case CBUS_FUNCTION_0:
3401 *value = ftdi->eeprom->cbus_function[0];
3403 case CBUS_FUNCTION_1:
3404 *value = ftdi->eeprom->cbus_function[1];
3406 case CBUS_FUNCTION_2:
3407 *value = ftdi->eeprom->cbus_function[2];
3409 case CBUS_FUNCTION_3:
3410 *value = ftdi->eeprom->cbus_function[3];
3412 case CBUS_FUNCTION_4:
3413 *value = ftdi->eeprom->cbus_function[4];
3415 case CBUS_FUNCTION_5:
3416 *value = ftdi->eeprom->cbus_function[5];
3418 case CBUS_FUNCTION_6:
3419 *value = ftdi->eeprom->cbus_function[6];
3421 case CBUS_FUNCTION_7:
3422 *value = ftdi->eeprom->cbus_function[7];
3424 case CBUS_FUNCTION_8:
3425 *value = ftdi->eeprom->cbus_function[8];
3427 case CBUS_FUNCTION_9:
3428 *value = ftdi->eeprom->cbus_function[8];
3431 *value = ftdi->eeprom->high_current;
3433 case HIGH_CURRENT_A:
3434 *value = ftdi->eeprom->high_current_a;
3436 case HIGH_CURRENT_B:
3437 *value = ftdi->eeprom->high_current_b;
3440 *value = ftdi->eeprom->invert;
3443 *value = ftdi->eeprom->group0_drive;
3445 case GROUP0_SCHMITT:
3446 *value = ftdi->eeprom->group0_schmitt;
3449 *value = ftdi->eeprom->group0_slew;
3452 *value = ftdi->eeprom->group1_drive;
3454 case GROUP1_SCHMITT:
3455 *value = ftdi->eeprom->group1_schmitt;
3458 *value = ftdi->eeprom->group1_slew;
3461 *value = ftdi->eeprom->group2_drive;
3463 case GROUP2_SCHMITT:
3464 *value = ftdi->eeprom->group2_schmitt;
3467 *value = ftdi->eeprom->group2_slew;
3470 *value = ftdi->eeprom->group3_drive;
3472 case GROUP3_SCHMITT:
3473 *value = ftdi->eeprom->group3_schmitt;
3476 *value = ftdi->eeprom->group3_slew;
3479 *value = ftdi->eeprom->powersave;
3481 case CLOCK_POLARITY:
3482 *value = ftdi->eeprom->clock_polarity;
3485 *value = ftdi->eeprom->data_order;
3488 *value = ftdi->eeprom->flow_control;
3491 *value = ftdi->eeprom->chip;
3494 *value = ftdi->eeprom->size;
3497 ftdi_error_return(-1, "Request for unknown EEPROM value");
3503 Set a value in the decoded EEPROM Structure
3504 No parameter checking is performed
3506 \param ftdi pointer to ftdi_context
3507 \param value_name Enum of the value to set
3511 \retval -1: Value doesn't exist
3512 \retval -2: Value not user settable
3514 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
3519 ftdi->eeprom->vendor_id = value;
3522 ftdi->eeprom->product_id = value;
3525 ftdi->eeprom->self_powered = value;
3528 ftdi->eeprom->remote_wakeup = value;
3531 ftdi->eeprom->is_not_pnp = value;
3534 ftdi->eeprom->suspend_dbus7 = value;
3536 case IN_IS_ISOCHRONOUS:
3537 ftdi->eeprom->in_is_isochronous = value;
3539 case OUT_IS_ISOCHRONOUS:
3540 ftdi->eeprom->out_is_isochronous = value;
3542 case SUSPEND_PULL_DOWNS:
3543 ftdi->eeprom->suspend_pull_downs = value;
3546 ftdi->eeprom->use_serial = value;
3549 ftdi->eeprom->usb_version = value;
3551 case USE_USB_VERSION:
3552 ftdi->eeprom->use_usb_version = value;
3555 ftdi->eeprom->max_power = value;
3557 case CHANNEL_A_TYPE:
3558 ftdi->eeprom->channel_a_type = value;
3560 case CHANNEL_B_TYPE:
3561 ftdi->eeprom->channel_b_type = value;
3563 case CHANNEL_A_DRIVER:
3564 ftdi->eeprom->channel_a_driver = value;
3566 case CHANNEL_B_DRIVER:
3567 ftdi->eeprom->channel_b_driver = value;
3569 case CBUS_FUNCTION_0:
3570 ftdi->eeprom->cbus_function[0] = value;
3572 case CBUS_FUNCTION_1:
3573 ftdi->eeprom->cbus_function[1] = value;
3575 case CBUS_FUNCTION_2:
3576 ftdi->eeprom->cbus_function[2] = value;
3578 case CBUS_FUNCTION_3:
3579 ftdi->eeprom->cbus_function[3] = value;
3581 case CBUS_FUNCTION_4:
3582 ftdi->eeprom->cbus_function[4] = value;
3584 case CBUS_FUNCTION_5:
3585 ftdi->eeprom->cbus_function[5] = value;
3587 case CBUS_FUNCTION_6:
3588 ftdi->eeprom->cbus_function[6] = value;
3590 case CBUS_FUNCTION_7:
3591 ftdi->eeprom->cbus_function[7] = value;
3593 case CBUS_FUNCTION_8:
3594 ftdi->eeprom->cbus_function[8] = value;
3596 case CBUS_FUNCTION_9:
3597 ftdi->eeprom->cbus_function[9] = value;
3600 ftdi->eeprom->high_current = value;
3602 case HIGH_CURRENT_A:
3603 ftdi->eeprom->high_current_a = value;
3605 case HIGH_CURRENT_B:
3606 ftdi->eeprom->high_current_b = value;
3609 ftdi->eeprom->invert = value;
3612 ftdi->eeprom->group0_drive = value;
3614 case GROUP0_SCHMITT:
3615 ftdi->eeprom->group0_schmitt = value;
3618 ftdi->eeprom->group0_slew = value;
3621 ftdi->eeprom->group1_drive = value;
3623 case GROUP1_SCHMITT:
3624 ftdi->eeprom->group1_schmitt = value;
3627 ftdi->eeprom->group1_slew = value;
3630 ftdi->eeprom->group2_drive = value;
3632 case GROUP2_SCHMITT:
3633 ftdi->eeprom->group2_schmitt = value;
3636 ftdi->eeprom->group2_slew = value;
3639 ftdi->eeprom->group3_drive = value;
3641 case GROUP3_SCHMITT:
3642 ftdi->eeprom->group3_schmitt = value;
3645 ftdi->eeprom->group3_slew = value;
3648 ftdi->eeprom->chip = value;
3651 ftdi->eeprom->powersave = value;
3653 case CLOCK_POLARITY:
3654 ftdi->eeprom->clock_polarity = value;
3657 ftdi->eeprom->data_order = value;
3660 ftdi->eeprom->flow_control = value;
3663 ftdi_error_return(-2, "EEPROM Value can't be changed");
3665 ftdi_error_return(-1, "Request to unknown EEPROM value");
3670 /** Get the read-only buffer to the binary EEPROM content
3672 \param ftdi pointer to ftdi_context
3673 \param buf buffer to receive EEPROM content
3674 \param size Size of receiving buffer
3677 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
3678 \retval -2: Not enough room to store eeprom
3680 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
3682 if (!ftdi || !(ftdi->eeprom))
3683 ftdi_error_return(-1, "No appropriate structure");
3685 if (!buf || size < ftdi->eeprom->size)
3686 ftdi_error_return(-1, "Not enough room to store eeprom");
3688 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3689 if (size > FTDI_MAX_EEPROM_SIZE)
3690 size = FTDI_MAX_EEPROM_SIZE;
3692 memcpy(buf, ftdi->eeprom->buf, size);
3697 /** Set the EEPROM content from the user-supplied prefilled buffer
3699 \param ftdi pointer to ftdi_context
3700 \param buf buffer to read EEPROM content
3701 \param size Size of buffer
3704 \retval -1: struct ftdi_contxt or ftdi_eeprom of buf missing
3706 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
3708 if (!ftdi || !(ftdi->eeprom) || !buf)
3709 ftdi_error_return(-1, "No appropriate structure");
3711 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3712 if (size > FTDI_MAX_EEPROM_SIZE)
3713 size = FTDI_MAX_EEPROM_SIZE;
3715 memcpy(ftdi->eeprom->buf, buf, size);
3721 Read eeprom location
3723 \param ftdi pointer to ftdi_context
3724 \param eeprom_addr Address of eeprom location to be read
3725 \param eeprom_val Pointer to store read eeprom location
3728 \retval -1: read failed
3729 \retval -2: USB device unavailable
3731 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
3733 if (ftdi == NULL || ftdi->usb_dev == NULL)
3734 ftdi_error_return(-2, "USB device unavailable");
3736 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, (unsigned char *)eeprom_val, 2, ftdi->usb_read_timeout) != 2)
3737 ftdi_error_return(-1, "reading eeprom failed");
3745 \param ftdi pointer to ftdi_context
3748 \retval -1: read failed
3749 \retval -2: USB device unavailable
3751 int ftdi_read_eeprom(struct ftdi_context *ftdi)
3756 if (ftdi == NULL || ftdi->usb_dev == NULL)
3757 ftdi_error_return(-2, "USB device unavailable");
3758 buf = ftdi->eeprom->buf;
3760 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
3762 if (libusb_control_transfer(
3763 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
3764 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
3765 ftdi_error_return(-1, "reading eeprom failed");
3768 if (ftdi->type == TYPE_R)
3769 ftdi->eeprom->size = 0x80;
3770 /* Guesses size of eeprom by comparing halves
3771 - will not work with blank eeprom */
3772 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
3773 ftdi->eeprom->size = -1;
3774 else if (memcmp(buf,&buf[0x80],0x80) == 0)
3775 ftdi->eeprom->size = 0x80;
3776 else if (memcmp(buf,&buf[0x40],0x40) == 0)
3777 ftdi->eeprom->size = 0x40;
3779 ftdi->eeprom->size = 0x100;
3784 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
3785 Function is only used internally
3788 static unsigned char ftdi_read_chipid_shift(unsigned char value)
3790 return ((value & 1) << 1) |
3791 ((value & 2) << 5) |
3792 ((value & 4) >> 2) |
3793 ((value & 8) << 4) |
3794 ((value & 16) >> 1) |
3795 ((value & 32) >> 1) |
3796 ((value & 64) >> 4) |
3797 ((value & 128) >> 2);
3801 Read the FTDIChip-ID from R-type devices
3803 \param ftdi pointer to ftdi_context
3804 \param chipid Pointer to store FTDIChip-ID
3807 \retval -1: read failed
3808 \retval -2: USB device unavailable
3810 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
3812 unsigned int a = 0, b = 0;
3814 if (ftdi == NULL || ftdi->usb_dev == NULL)
3815 ftdi_error_return(-2, "USB device unavailable");
3817 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)
3819 a = a << 8 | a >> 8;
3820 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)
3822 b = b << 8 | b >> 8;
3823 a = (a << 16) | (b & 0xFFFF);
3824 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
3825 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
3826 *chipid = a ^ 0xa5f0f7d1;
3831 ftdi_error_return(-1, "read of FTDIChip-ID failed");
3835 Write eeprom location
3837 \param ftdi pointer to ftdi_context
3838 \param eeprom_addr Address of eeprom location to be written
3839 \param eeprom_val Value to be written
3842 \retval -1: write failed
3843 \retval -2: USB device unavailable
3844 \retval -3: Invalid access to checksum protected area below 0x80
3845 \retval -4: Device can't access unprotected area
3846 \retval -5: Reading chip type failed
3848 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
3849 unsigned short eeprom_val)
3851 int chip_type_location;
3852 unsigned short chip_type;
3854 if (ftdi == NULL || ftdi->usb_dev == NULL)
3855 ftdi_error_return(-2, "USB device unavailable");
3857 if (eeprom_addr <0x80)
3858 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
3865 chip_type_location = 0x14;
3869 chip_type_location = 0x18;
3872 chip_type_location = 0x1e;
3875 ftdi_error_return(-4, "Device can't access unprotected area");
3878 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
3879 ftdi_error_return(-5, "Reading failed failed");
3880 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
3881 if ((chip_type & 0xff) != 0x66)
3883 ftdi_error_return(-6, "EEPROM is not of 93x66");
3886 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3887 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
3888 NULL, 0, ftdi->usb_write_timeout) != 0)
3889 ftdi_error_return(-1, "unable to write eeprom");
3897 \param ftdi pointer to ftdi_context
3900 \retval -1: read failed
3901 \retval -2: USB device unavailable
3902 \retval -3: EEPROM not initialized for the connected device;
3904 int ftdi_write_eeprom(struct ftdi_context *ftdi)
3906 unsigned short usb_val, status;
3908 unsigned char *eeprom;
3910 if (ftdi == NULL || ftdi->usb_dev == NULL)
3911 ftdi_error_return(-2, "USB device unavailable");
3913 if(ftdi->eeprom->initialized_for_connected_device == 0)
3914 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
3916 eeprom = ftdi->eeprom->buf;
3918 /* These commands were traced while running MProg */
3919 if ((ret = ftdi_usb_reset(ftdi)) != 0)
3921 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
3923 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
3926 for (i = 0; i < ftdi->eeprom->size/2; i++)
3928 usb_val = eeprom[i*2];
3929 usb_val += eeprom[(i*2)+1] << 8;
3930 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3931 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
3932 NULL, 0, ftdi->usb_write_timeout) < 0)
3933 ftdi_error_return(-1, "unable to write eeprom");
3942 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
3944 \param ftdi pointer to ftdi_context
3947 \retval -1: erase failed
3948 \retval -2: USB device unavailable
3949 \retval -3: Writing magic failed
3950 \retval -4: Read EEPROM failed
3951 \retval -5: Unexpected EEPROM value
3953 #define MAGIC 0x55aa
3954 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
3956 unsigned short eeprom_value;
3957 if (ftdi == NULL || ftdi->usb_dev == NULL)
3958 ftdi_error_return(-2, "USB device unavailable");
3960 if (ftdi->type == TYPE_R)
3962 ftdi->eeprom->chip = 0;
3966 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
3967 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
3968 ftdi_error_return(-1, "unable to erase eeprom");
3971 /* detect chip type by writing 0x55AA as magic at word position 0xc0
3972 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
3973 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
3974 Chip is 93x66 if magic is only read at word position 0xc0*/
3975 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3976 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
3977 NULL, 0, ftdi->usb_write_timeout) != 0)
3978 ftdi_error_return(-3, "Writing magic failed");
3979 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
3980 ftdi_error_return(-4, "Reading failed failed");
3981 if (eeprom_value == MAGIC)
3983 ftdi->eeprom->chip = 0x46;
3987 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
3988 ftdi_error_return(-4, "Reading failed failed");
3989 if (eeprom_value == MAGIC)
3990 ftdi->eeprom->chip = 0x56;
3993 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
3994 ftdi_error_return(-4, "Reading failed failed");
3995 if (eeprom_value == MAGIC)
3996 ftdi->eeprom->chip = 0x66;
3999 ftdi->eeprom->chip = -1;
4003 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
4004 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4005 ftdi_error_return(-1, "unable to erase eeprom");
4010 Get string representation for last error code
4012 \param ftdi pointer to ftdi_context
4014 \retval Pointer to error string
4016 char *ftdi_get_error_string (struct ftdi_context *ftdi)
4021 return ftdi->error_str;
4024 /* @} end of doxygen libftdi group */