1 /***************************************************************************
5 copyright : (C) 2003-2011 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
15 ***************************************************************************/
18 \mainpage libftdi API documentation
20 Library to talk to FTDI chips. You find the latest versions of libftdi at
21 http://www.intra2net.com/en/developer/libftdi/
23 The library is easy to use. Have a look at this short example:
26 More examples can be found in the "examples" directory.
28 /** \addtogroup libftdi */
39 #define ftdi_error_return(code, str) do { \
40 ftdi->error_str = str; \
44 #define ftdi_error_return_free_device_list(code, str, devs) do { \
45 libusb_free_device_list(devs,1); \
46 ftdi->error_str = str; \
52 Internal function to close usb device pointer.
53 Sets ftdi->usb_dev to NULL.
56 \param ftdi pointer to ftdi_context
60 static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
62 if (ftdi && ftdi->usb_dev)
64 libusb_close (ftdi->usb_dev);
67 ftdi->eeprom->initialized_for_connected_device = 0;
72 Initializes a ftdi_context.
74 \param ftdi pointer to ftdi_context
77 \retval -1: couldn't allocate read buffer
78 \retval -2: couldn't allocate struct buffer
79 \retval -3: libusb_init() failed
81 \remark This should be called before all functions
83 int ftdi_init(struct ftdi_context *ftdi)
85 struct ftdi_eeprom* eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
88 ftdi->usb_read_timeout = 5000;
89 ftdi->usb_write_timeout = 5000;
91 ftdi->type = TYPE_BM; /* chip type */
93 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
95 ftdi->readbuffer = NULL;
96 ftdi->readbuffer_offset = 0;
97 ftdi->readbuffer_remaining = 0;
98 ftdi->writebuffer_chunksize = 4096;
99 ftdi->max_packet_size = 0;
100 ftdi->error_str = NULL;
101 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
103 if (libusb_init(&ftdi->usb_ctx) < 0)
104 ftdi_error_return(-3, "libusb_init() failed");
106 ftdi_set_interface(ftdi, INTERFACE_ANY);
107 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
110 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
111 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
112 ftdi->eeprom = eeprom;
114 /* All fine. Now allocate the readbuffer */
115 return ftdi_read_data_set_chunksize(ftdi, 4096);
119 Allocate and initialize a new ftdi_context
121 \return a pointer to a new ftdi_context, or NULL on failure
123 struct ftdi_context *ftdi_new(void)
125 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
132 if (ftdi_init(ftdi) != 0)
142 Open selected channels on a chip, otherwise use first channel.
144 \param ftdi pointer to ftdi_context
145 \param interface Interface to use for FT2232C/2232H/4232H chips.
148 \retval -1: unknown interface
149 \retval -2: USB device unavailable
151 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
154 ftdi_error_return(-2, "USB device unavailable");
161 ftdi->index = INTERFACE_A;
167 ftdi->index = INTERFACE_B;
173 ftdi->index = INTERFACE_C;
179 ftdi->index = INTERFACE_D;
184 ftdi_error_return(-1, "Unknown interface");
190 Deinitializes a ftdi_context.
192 \param ftdi pointer to ftdi_context
194 void ftdi_deinit(struct ftdi_context *ftdi)
199 ftdi_usb_close_internal (ftdi);
201 if (ftdi->readbuffer != NULL)
203 free(ftdi->readbuffer);
204 ftdi->readbuffer = NULL;
207 if (ftdi->eeprom != NULL)
209 if (ftdi->eeprom->manufacturer != 0)
211 free(ftdi->eeprom->manufacturer);
212 ftdi->eeprom->manufacturer = 0;
214 if (ftdi->eeprom->product != 0)
216 free(ftdi->eeprom->product);
217 ftdi->eeprom->product = 0;
219 if (ftdi->eeprom->serial != 0)
221 free(ftdi->eeprom->serial);
222 ftdi->eeprom->serial = 0;
230 libusb_exit(ftdi->usb_ctx);
231 ftdi->usb_ctx = NULL;
236 Deinitialize and free an ftdi_context.
238 \param ftdi pointer to ftdi_context
240 void ftdi_free(struct ftdi_context *ftdi)
247 Use an already open libusb device.
249 \param ftdi pointer to ftdi_context
250 \param usb libusb libusb_device_handle to use
252 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
262 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
263 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
264 use. With VID:PID 0:0, search for the default devices
265 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014)
267 \param ftdi pointer to ftdi_context
268 \param devlist Pointer where to store list of found devices
269 \param vendor Vendor ID to search for
270 \param product Product ID to search for
272 \retval >0: number of devices found
273 \retval -3: out of memory
274 \retval -5: libusb_get_device_list() failed
275 \retval -6: libusb_get_device_descriptor() failed
277 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
279 struct ftdi_device_list **curdev;
281 libusb_device **devs;
285 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
286 ftdi_error_return(-5, "libusb_get_device_list() failed");
291 while ((dev = devs[i++]) != NULL)
293 struct libusb_device_descriptor desc;
295 if (libusb_get_device_descriptor(dev, &desc) < 0)
296 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
298 if (((vendor != 0 && product != 0) &&
299 desc.idVendor == vendor && desc.idProduct == product) ||
300 ((vendor == 0 && product == 0) &&
301 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
302 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014)))
304 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
306 ftdi_error_return_free_device_list(-3, "out of memory", devs);
308 (*curdev)->next = NULL;
309 (*curdev)->dev = dev;
310 libusb_ref_device(dev);
311 curdev = &(*curdev)->next;
315 libusb_free_device_list(devs,1);
320 Frees a usb device list.
322 \param devlist USB device list created by ftdi_usb_find_all()
324 void ftdi_list_free(struct ftdi_device_list **devlist)
326 struct ftdi_device_list *curdev, *next;
328 for (curdev = *devlist; curdev != NULL;)
331 libusb_unref_device(curdev->dev);
340 Frees a usb device list.
342 \param devlist USB device list created by ftdi_usb_find_all()
344 void ftdi_list_free2(struct ftdi_device_list *devlist)
346 ftdi_list_free(&devlist);
350 Return device ID strings from the usb device.
352 The parameters manufacturer, description and serial may be NULL
353 or pointer to buffers to store the fetched strings.
355 \note Use this function only in combination with ftdi_usb_find_all()
356 as it closes the internal "usb_dev" after use.
358 \param ftdi pointer to ftdi_context
359 \param dev libusb usb_dev to use
360 \param manufacturer Store manufacturer string here if not NULL
361 \param mnf_len Buffer size of manufacturer string
362 \param description Store product description string here if not NULL
363 \param desc_len Buffer size of product description string
364 \param serial Store serial string here if not NULL
365 \param serial_len Buffer size of serial string
368 \retval -1: wrong arguments
369 \retval -4: unable to open device
370 \retval -7: get product manufacturer failed
371 \retval -8: get product description failed
372 \retval -9: get serial number failed
373 \retval -11: libusb_get_device_descriptor() failed
375 int ftdi_usb_get_strings(struct ftdi_context * ftdi, struct libusb_device * dev,
376 char * manufacturer, int mnf_len, char * description, int desc_len, char * serial, int serial_len)
378 struct libusb_device_descriptor desc;
380 if ((ftdi==NULL) || (dev==NULL))
383 if (libusb_open(dev, &ftdi->usb_dev) < 0)
384 ftdi_error_return(-4, "libusb_open() failed");
386 if (libusb_get_device_descriptor(dev, &desc) < 0)
387 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
389 if (manufacturer != NULL)
391 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
393 ftdi_usb_close_internal (ftdi);
394 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
398 if (description != NULL)
400 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
402 ftdi_usb_close_internal (ftdi);
403 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
409 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
411 ftdi_usb_close_internal (ftdi);
412 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
416 ftdi_usb_close_internal (ftdi);
422 * Internal function to determine the maximum packet size.
423 * \param ftdi pointer to ftdi_context
424 * \param dev libusb usb_dev to use
425 * \retval Maximum packet size for this device
427 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
429 struct libusb_device_descriptor desc;
430 struct libusb_config_descriptor *config0;
431 unsigned int packet_size;
434 if (ftdi == NULL || dev == NULL)
437 // Determine maximum packet size. Init with default value.
438 // New hi-speed devices from FTDI use a packet size of 512 bytes
439 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
440 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
445 if (libusb_get_device_descriptor(dev, &desc) < 0)
448 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
451 if (desc.bNumConfigurations > 0)
453 if (ftdi->interface < config0->bNumInterfaces)
455 struct libusb_interface interface = config0->interface[ftdi->interface];
456 if (interface.num_altsetting > 0)
458 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
459 if (descriptor.bNumEndpoints > 0)
461 packet_size = descriptor.endpoint[0].wMaxPacketSize;
467 libusb_free_config_descriptor (config0);
472 Opens a ftdi device given by an usb_device.
474 \param ftdi pointer to ftdi_context
475 \param dev libusb usb_dev to use
478 \retval -3: unable to config device
479 \retval -4: unable to open device
480 \retval -5: unable to claim device
481 \retval -6: reset failed
482 \retval -7: set baudrate failed
483 \retval -8: ftdi context invalid
484 \retval -9: libusb_get_device_descriptor() failed
485 \retval -10: libusb_get_config_descriptor() failed
486 \retval -11: libusb_detach_kernel_driver() failed
487 \retval -12: libusb_get_configuration() failed
489 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
491 struct libusb_device_descriptor desc;
492 struct libusb_config_descriptor *config0;
493 int cfg, cfg0, detach_errno = 0;
496 ftdi_error_return(-8, "ftdi context invalid");
498 if (libusb_open(dev, &ftdi->usb_dev) < 0)
499 ftdi_error_return(-4, "libusb_open() failed");
501 if (libusb_get_device_descriptor(dev, &desc) < 0)
502 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
504 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
505 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
506 cfg0 = config0->bConfigurationValue;
507 libusb_free_config_descriptor (config0);
509 // Try to detach ftdi_sio kernel module.
511 // The return code is kept in a separate variable and only parsed
512 // if usb_set_configuration() or usb_claim_interface() fails as the
513 // detach operation might be denied and everything still works fine.
514 // Likely scenario is a static ftdi_sio kernel module.
515 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
517 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
518 detach_errno = errno;
521 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
522 ftdi_error_return(-12, "libusb_get_configuration () failed");
523 // set configuration (needed especially for windows)
524 // tolerate EBUSY: one device with one configuration, but two interfaces
525 // and libftdi sessions to both interfaces (e.g. FT2232)
526 if (desc.bNumConfigurations > 0 && cfg != cfg0)
528 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
530 ftdi_usb_close_internal (ftdi);
531 if (detach_errno == EPERM)
533 ftdi_error_return(-8, "inappropriate permissions on device!");
537 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
542 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
544 ftdi_usb_close_internal (ftdi);
545 if (detach_errno == EPERM)
547 ftdi_error_return(-8, "inappropriate permissions on device!");
551 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
555 if (ftdi_usb_reset (ftdi) != 0)
557 ftdi_usb_close_internal (ftdi);
558 ftdi_error_return(-6, "ftdi_usb_reset failed");
561 // Try to guess chip type
562 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
563 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
564 && desc.iSerialNumber == 0))
565 ftdi->type = TYPE_BM;
566 else if (desc.bcdDevice == 0x200)
567 ftdi->type = TYPE_AM;
568 else if (desc.bcdDevice == 0x500)
569 ftdi->type = TYPE_2232C;
570 else if (desc.bcdDevice == 0x600)
572 else if (desc.bcdDevice == 0x700)
573 ftdi->type = TYPE_2232H;
574 else if (desc.bcdDevice == 0x800)
575 ftdi->type = TYPE_4232H;
576 else if (desc.bcdDevice == 0x900)
577 ftdi->type = TYPE_232H;
579 // Determine maximum packet size
580 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
582 if (ftdi_set_baudrate (ftdi, 9600) != 0)
584 ftdi_usb_close_internal (ftdi);
585 ftdi_error_return(-7, "set baudrate failed");
588 ftdi_error_return(0, "all fine");
592 Opens the first device with a given vendor and product ids.
594 \param ftdi pointer to ftdi_context
595 \param vendor Vendor ID
596 \param product Product ID
598 \retval same as ftdi_usb_open_desc()
600 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
602 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
606 Opens the first device with a given, vendor id, product id,
607 description and serial.
609 \param ftdi pointer to ftdi_context
610 \param vendor Vendor ID
611 \param product Product ID
612 \param description Description to search for. Use NULL if not needed.
613 \param serial Serial to search for. Use NULL if not needed.
616 \retval -3: usb device not found
617 \retval -4: unable to open device
618 \retval -5: unable to claim device
619 \retval -6: reset failed
620 \retval -7: set baudrate failed
621 \retval -8: get product description failed
622 \retval -9: get serial number failed
623 \retval -12: libusb_get_device_list() failed
624 \retval -13: libusb_get_device_descriptor() failed
626 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
627 const char* description, const char* serial)
629 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
633 Opens the index-th device with a given, vendor id, product id,
634 description and serial.
636 \param ftdi pointer to ftdi_context
637 \param vendor Vendor ID
638 \param product Product ID
639 \param description Description to search for. Use NULL if not needed.
640 \param serial Serial to search for. Use NULL if not needed.
641 \param index Number of matching device to open if there are more than one, starts with 0.
644 \retval -1: usb_find_busses() failed
645 \retval -2: usb_find_devices() failed
646 \retval -3: usb device not found
647 \retval -4: unable to open device
648 \retval -5: unable to claim device
649 \retval -6: reset failed
650 \retval -7: set baudrate failed
651 \retval -8: get product description failed
652 \retval -9: get serial number failed
653 \retval -10: unable to close device
654 \retval -11: ftdi context invalid
656 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
657 const char* description, const char* serial, unsigned int index)
660 libusb_device **devs;
665 ftdi_error_return(-11, "ftdi context invalid");
667 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
668 ftdi_error_return(-12, "libusb_get_device_list() failed");
670 while ((dev = devs[i++]) != NULL)
672 struct libusb_device_descriptor desc;
675 if (libusb_get_device_descriptor(dev, &desc) < 0)
676 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
678 if (desc.idVendor == vendor && desc.idProduct == product)
680 if (libusb_open(dev, &ftdi->usb_dev) < 0)
681 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
683 if (description != NULL)
685 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
687 ftdi_usb_close_internal (ftdi);
688 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
690 if (strncmp(string, description, sizeof(string)) != 0)
692 ftdi_usb_close_internal (ftdi);
698 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
700 ftdi_usb_close_internal (ftdi);
701 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
703 if (strncmp(string, serial, sizeof(string)) != 0)
705 ftdi_usb_close_internal (ftdi);
710 ftdi_usb_close_internal (ftdi);
718 res = ftdi_usb_open_dev(ftdi, dev);
719 libusb_free_device_list(devs,1);
725 ftdi_error_return_free_device_list(-3, "device not found", devs);
729 Opens the ftdi-device described by a description-string.
730 Intended to be used for parsing a device-description given as commandline argument.
732 \param ftdi pointer to ftdi_context
733 \param description NULL-terminated description-string, using this format:
734 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
735 \li <tt>i:\<vendor>:\<product></tt> first device with given vendor and product id, ids can be decimal, octal (preceded by "0") or hex (preceded by "0x")
736 \li <tt>i:\<vendor>:\<product>:\<index></tt> as above with index being the number of the device (starting with 0) if there are more than one
737 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
739 \note The description format may be extended in later versions.
742 \retval -2: libusb_get_device_list() failed
743 \retval -3: usb device not found
744 \retval -4: unable to open device
745 \retval -5: unable to claim device
746 \retval -6: reset failed
747 \retval -7: set baudrate failed
748 \retval -8: get product description failed
749 \retval -9: get serial number failed
750 \retval -10: unable to close device
751 \retval -11: illegal description format
752 \retval -12: ftdi context invalid
754 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
757 ftdi_error_return(-12, "ftdi context invalid");
759 if (description[0] == 0 || description[1] != ':')
760 ftdi_error_return(-11, "illegal description format");
762 if (description[0] == 'd')
765 libusb_device **devs;
766 unsigned int bus_number, device_address;
769 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
770 ftdi_error_return(-2, "libusb_get_device_list() failed");
772 /* XXX: This doesn't handle symlinks/odd paths/etc... */
773 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
774 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
776 while ((dev = devs[i++]) != NULL)
779 if (bus_number == libusb_get_bus_number (dev)
780 && device_address == libusb_get_device_address (dev))
782 ret = ftdi_usb_open_dev(ftdi, dev);
783 libusb_free_device_list(devs,1);
789 ftdi_error_return_free_device_list(-3, "device not found", devs);
791 else if (description[0] == 'i' || description[0] == 's')
794 unsigned int product;
795 unsigned int index=0;
796 const char *serial=NULL;
797 const char *startp, *endp;
800 startp=description+2;
801 vendor=strtoul((char*)startp,(char**)&endp,0);
802 if (*endp != ':' || endp == startp || errno != 0)
803 ftdi_error_return(-11, "illegal description format");
806 product=strtoul((char*)startp,(char**)&endp,0);
807 if (endp == startp || errno != 0)
808 ftdi_error_return(-11, "illegal description format");
810 if (description[0] == 'i' && *endp != 0)
812 /* optional index field in i-mode */
814 ftdi_error_return(-11, "illegal description format");
817 index=strtoul((char*)startp,(char**)&endp,0);
818 if (*endp != 0 || endp == startp || errno != 0)
819 ftdi_error_return(-11, "illegal description format");
821 if (description[0] == 's')
824 ftdi_error_return(-11, "illegal description format");
826 /* rest of the description is the serial */
830 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
834 ftdi_error_return(-11, "illegal description format");
839 Resets the ftdi device.
841 \param ftdi pointer to ftdi_context
844 \retval -1: FTDI reset failed
845 \retval -2: USB device unavailable
847 int ftdi_usb_reset(struct ftdi_context *ftdi)
849 if (ftdi == NULL || ftdi->usb_dev == NULL)
850 ftdi_error_return(-2, "USB device unavailable");
852 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
853 SIO_RESET_REQUEST, SIO_RESET_SIO,
854 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
855 ftdi_error_return(-1,"FTDI reset failed");
857 // Invalidate data in the readbuffer
858 ftdi->readbuffer_offset = 0;
859 ftdi->readbuffer_remaining = 0;
865 Clears the read buffer on the chip and the internal read buffer.
867 \param ftdi pointer to ftdi_context
870 \retval -1: read buffer purge failed
871 \retval -2: USB device unavailable
873 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
875 if (ftdi == NULL || ftdi->usb_dev == NULL)
876 ftdi_error_return(-2, "USB device unavailable");
878 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
879 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
880 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
881 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
883 // Invalidate data in the readbuffer
884 ftdi->readbuffer_offset = 0;
885 ftdi->readbuffer_remaining = 0;
891 Clears the write buffer on the chip.
893 \param ftdi pointer to ftdi_context
896 \retval -1: write buffer purge failed
897 \retval -2: USB device unavailable
899 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
901 if (ftdi == NULL || ftdi->usb_dev == NULL)
902 ftdi_error_return(-2, "USB device unavailable");
904 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
905 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
906 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
907 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
913 Clears the buffers on the chip and the internal read buffer.
915 \param ftdi pointer to ftdi_context
918 \retval -1: read buffer purge failed
919 \retval -2: write buffer purge failed
920 \retval -3: USB device unavailable
922 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
926 if (ftdi == NULL || ftdi->usb_dev == NULL)
927 ftdi_error_return(-3, "USB device unavailable");
929 result = ftdi_usb_purge_rx_buffer(ftdi);
933 result = ftdi_usb_purge_tx_buffer(ftdi);
943 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
945 \param ftdi pointer to ftdi_context
948 \retval -1: usb_release failed
949 \retval -3: ftdi context invalid
951 int ftdi_usb_close(struct ftdi_context *ftdi)
956 ftdi_error_return(-3, "ftdi context invalid");
958 if (ftdi->usb_dev != NULL)
959 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
962 ftdi_usb_close_internal (ftdi);
968 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
969 Function is only used internally
972 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
973 unsigned short *value, unsigned short *index)
975 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
976 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
977 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
978 int divisor, best_divisor, best_baud, best_baud_diff;
979 unsigned long encoded_divisor;
988 divisor = 24000000 / baudrate;
990 if (ftdi->type == TYPE_AM)
992 // Round down to supported fraction (AM only)
993 divisor -= am_adjust_dn[divisor & 7];
996 // Try this divisor and the one above it (because division rounds down)
1000 for (i = 0; i < 2; i++)
1002 int try_divisor = divisor + i;
1006 // Round up to supported divisor value
1007 if (try_divisor <= 8)
1009 // Round up to minimum supported divisor
1012 else if (ftdi->type != TYPE_AM && try_divisor < 12)
1014 // BM doesn't support divisors 9 through 11 inclusive
1017 else if (divisor < 16)
1019 // AM doesn't support divisors 9 through 15 inclusive
1024 if (ftdi->type == TYPE_AM)
1026 // Round up to supported fraction (AM only)
1027 try_divisor += am_adjust_up[try_divisor & 7];
1028 if (try_divisor > 0x1FFF8)
1030 // Round down to maximum supported divisor value (for AM)
1031 try_divisor = 0x1FFF8;
1036 if (try_divisor > 0x1FFFF)
1038 // Round down to maximum supported divisor value (for BM)
1039 try_divisor = 0x1FFFF;
1043 // Get estimated baud rate (to nearest integer)
1044 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1045 // Get absolute difference from requested baud rate
1046 if (baud_estimate < baudrate)
1048 baud_diff = baudrate - baud_estimate;
1052 baud_diff = baud_estimate - baudrate;
1054 if (i == 0 || baud_diff < best_baud_diff)
1056 // Closest to requested baud rate so far
1057 best_divisor = try_divisor;
1058 best_baud = baud_estimate;
1059 best_baud_diff = baud_diff;
1062 // Spot on! No point trying
1067 // Encode the best divisor value
1068 encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1069 // Deal with special cases for encoded value
1070 if (encoded_divisor == 1)
1072 encoded_divisor = 0; // 3000000 baud
1074 else if (encoded_divisor == 0x4001)
1076 encoded_divisor = 1; // 2000000 baud (BM only)
1078 // Split into "value" and "index" values
1079 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1080 if (ftdi->type == TYPE_2232C || ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H )
1082 *index = (unsigned short)(encoded_divisor >> 8);
1084 *index |= ftdi->index;
1087 *index = (unsigned short)(encoded_divisor >> 16);
1089 // Return the nearest baud rate
1094 Sets the chip baud rate
1096 \param ftdi pointer to ftdi_context
1097 \param baudrate baud rate to set
1100 \retval -1: invalid baudrate
1101 \retval -2: setting baudrate failed
1102 \retval -3: USB device unavailable
1104 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1106 unsigned short value, index;
1107 int actual_baudrate;
1109 if (ftdi == NULL || ftdi->usb_dev == NULL)
1110 ftdi_error_return(-3, "USB device unavailable");
1112 if (ftdi->bitbang_enabled)
1114 baudrate = baudrate*4;
1117 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1118 if (actual_baudrate <= 0)
1119 ftdi_error_return (-1, "Silly baudrate <= 0.");
1121 // Check within tolerance (about 5%)
1122 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1123 || ((actual_baudrate < baudrate)
1124 ? (actual_baudrate * 21 < baudrate * 20)
1125 : (baudrate * 21 < actual_baudrate * 20)))
1126 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1128 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1129 SIO_SET_BAUDRATE_REQUEST, value,
1130 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1131 ftdi_error_return (-2, "Setting new baudrate failed");
1133 ftdi->baudrate = baudrate;
1138 Set (RS232) line characteristics.
1139 The break type can only be set via ftdi_set_line_property2()
1140 and defaults to "off".
1142 \param ftdi pointer to ftdi_context
1143 \param bits Number of bits
1144 \param sbit Number of stop bits
1145 \param parity Parity mode
1148 \retval -1: Setting line property failed
1150 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1151 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1153 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1157 Set (RS232) line characteristics
1159 \param ftdi pointer to ftdi_context
1160 \param bits Number of bits
1161 \param sbit Number of stop bits
1162 \param parity Parity mode
1163 \param break_type Break type
1166 \retval -1: Setting line property failed
1167 \retval -2: USB device unavailable
1169 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1170 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1171 enum ftdi_break_type break_type)
1173 unsigned short value = bits;
1175 if (ftdi == NULL || ftdi->usb_dev == NULL)
1176 ftdi_error_return(-2, "USB device unavailable");
1181 value |= (0x00 << 8);
1184 value |= (0x01 << 8);
1187 value |= (0x02 << 8);
1190 value |= (0x03 << 8);
1193 value |= (0x04 << 8);
1200 value |= (0x00 << 11);
1203 value |= (0x01 << 11);
1206 value |= (0x02 << 11);
1213 value |= (0x00 << 14);
1216 value |= (0x01 << 14);
1220 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1221 SIO_SET_DATA_REQUEST, value,
1222 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1223 ftdi_error_return (-1, "Setting new line property failed");
1229 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1231 \param ftdi pointer to ftdi_context
1232 \param buf Buffer with the data
1233 \param size Size of the buffer
1235 \retval -666: USB device unavailable
1236 \retval <0: error code from usb_bulk_write()
1237 \retval >0: number of bytes written
1239 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1244 if (ftdi == NULL || ftdi->usb_dev == NULL)
1245 ftdi_error_return(-666, "USB device unavailable");
1247 while (offset < size)
1249 int write_size = ftdi->writebuffer_chunksize;
1251 if (offset+write_size > size)
1252 write_size = size-offset;
1254 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1255 ftdi_error_return(-1, "usb bulk write failed");
1257 offset += actual_length;
1263 static void ftdi_read_data_cb(struct libusb_transfer *transfer)
1265 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1266 struct ftdi_context *ftdi = tc->ftdi;
1267 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1269 packet_size = ftdi->max_packet_size;
1271 actual_length = transfer->actual_length;
1273 if (actual_length > 2)
1275 // skip FTDI status bytes.
1276 // Maybe stored in the future to enable modem use
1277 num_of_chunks = actual_length / packet_size;
1278 chunk_remains = actual_length % packet_size;
1279 //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);
1281 ftdi->readbuffer_offset += 2;
1284 if (actual_length > packet_size - 2)
1286 for (i = 1; i < num_of_chunks; i++)
1287 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1288 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1290 if (chunk_remains > 2)
1292 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1293 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1295 actual_length -= 2*num_of_chunks;
1298 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1301 if (actual_length > 0)
1303 // data still fits in buf?
1304 if (tc->offset + actual_length <= tc->size)
1306 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1307 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1308 tc->offset += actual_length;
1310 ftdi->readbuffer_offset = 0;
1311 ftdi->readbuffer_remaining = 0;
1313 /* Did we read exactly the right amount of bytes? */
1314 if (tc->offset == tc->size)
1316 //printf("read_data exact rem %d offset %d\n",
1317 //ftdi->readbuffer_remaining, offset);
1324 // only copy part of the data or size <= readbuffer_chunksize
1325 int part_size = tc->size - tc->offset;
1326 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1327 tc->offset += part_size;
1329 ftdi->readbuffer_offset += part_size;
1330 ftdi->readbuffer_remaining = actual_length - part_size;
1332 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1333 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1339 ret = libusb_submit_transfer (transfer);
1345 static void ftdi_write_data_cb(struct libusb_transfer *transfer)
1347 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1348 struct ftdi_context *ftdi = tc->ftdi;
1350 tc->offset += transfer->actual_length;
1352 if (tc->offset == tc->size)
1358 int write_size = ftdi->writebuffer_chunksize;
1361 if (tc->offset + write_size > tc->size)
1362 write_size = tc->size - tc->offset;
1364 transfer->length = write_size;
1365 transfer->buffer = tc->buf + tc->offset;
1366 ret = libusb_submit_transfer (transfer);
1374 Writes data to the chip. Does not wait for completion of the transfer
1375 nor does it make sure that the transfer was successful.
1377 Use libusb 1.0 asynchronous API.
1379 \param ftdi pointer to ftdi_context
1380 \param buf Buffer with the data
1381 \param size Size of the buffer
1383 \retval NULL: Some error happens when submit transfer
1384 \retval !NULL: Pointer to a ftdi_transfer_control
1387 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1389 struct ftdi_transfer_control *tc;
1390 struct libusb_transfer *transfer;
1391 int write_size, ret;
1393 if (ftdi == NULL || ftdi->usb_dev == NULL)
1396 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1400 transfer = libusb_alloc_transfer(0);
1413 if (size < ftdi->writebuffer_chunksize)
1416 write_size = ftdi->writebuffer_chunksize;
1418 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1419 write_size, ftdi_write_data_cb, tc,
1420 ftdi->usb_write_timeout);
1421 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1423 ret = libusb_submit_transfer(transfer);
1426 libusb_free_transfer(transfer);
1430 tc->transfer = transfer;
1436 Reads data from the chip. Does not wait for completion of the transfer
1437 nor does it make sure that the transfer was successful.
1439 Use libusb 1.0 asynchronous API.
1441 \param ftdi pointer to ftdi_context
1442 \param buf Buffer with the data
1443 \param size Size of the buffer
1445 \retval NULL: Some error happens when submit transfer
1446 \retval !NULL: Pointer to a ftdi_transfer_control
1449 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1451 struct ftdi_transfer_control *tc;
1452 struct libusb_transfer *transfer;
1455 if (ftdi == NULL || ftdi->usb_dev == NULL)
1458 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1466 if (size <= ftdi->readbuffer_remaining)
1468 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1471 ftdi->readbuffer_remaining -= size;
1472 ftdi->readbuffer_offset += size;
1474 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1478 tc->transfer = NULL;
1483 if (ftdi->readbuffer_remaining != 0)
1485 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1487 tc->offset = ftdi->readbuffer_remaining;
1492 transfer = libusb_alloc_transfer(0);
1499 ftdi->readbuffer_remaining = 0;
1500 ftdi->readbuffer_offset = 0;
1502 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);
1503 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1505 ret = libusb_submit_transfer(transfer);
1508 libusb_free_transfer(transfer);
1512 tc->transfer = transfer;
1518 Wait for completion of the transfer.
1520 Use libusb 1.0 asynchronous API.
1522 \param tc pointer to ftdi_transfer_control
1524 \retval < 0: Some error happens
1525 \retval >= 0: Data size transferred
1528 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1532 while (!tc->completed)
1534 ret = libusb_handle_events(tc->ftdi->usb_ctx);
1537 if (ret == LIBUSB_ERROR_INTERRUPTED)
1539 libusb_cancel_transfer(tc->transfer);
1540 while (!tc->completed)
1541 if (libusb_handle_events(tc->ftdi->usb_ctx) < 0)
1543 libusb_free_transfer(tc->transfer);
1551 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
1552 * at ftdi_read_data_submit(). Therefore, we need to check it here.
1556 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1558 libusb_free_transfer(tc->transfer);
1565 Configure write buffer chunk size.
1568 \param ftdi pointer to ftdi_context
1569 \param chunksize Chunk size
1572 \retval -1: ftdi context invalid
1574 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1577 ftdi_error_return(-1, "ftdi context invalid");
1579 ftdi->writebuffer_chunksize = chunksize;
1584 Get write buffer chunk size.
1586 \param ftdi pointer to ftdi_context
1587 \param chunksize Pointer to store chunk size in
1590 \retval -1: ftdi context invalid
1592 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1595 ftdi_error_return(-1, "ftdi context invalid");
1597 *chunksize = ftdi->writebuffer_chunksize;
1602 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1604 Automatically strips the two modem status bytes transfered during every read.
1606 \param ftdi pointer to ftdi_context
1607 \param buf Buffer to store data in
1608 \param size Size of the buffer
1610 \retval -666: USB device unavailable
1611 \retval <0: error code from libusb_bulk_transfer()
1612 \retval 0: no data was available
1613 \retval >0: number of bytes read
1616 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1618 int offset = 0, ret, i, num_of_chunks, chunk_remains;
1619 int packet_size = ftdi->max_packet_size;
1620 int actual_length = 1;
1622 if (ftdi == NULL || ftdi->usb_dev == NULL)
1623 ftdi_error_return(-666, "USB device unavailable");
1625 // Packet size sanity check (avoid division by zero)
1626 if (packet_size == 0)
1627 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
1629 // everything we want is still in the readbuffer?
1630 if (size <= ftdi->readbuffer_remaining)
1632 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1635 ftdi->readbuffer_remaining -= size;
1636 ftdi->readbuffer_offset += size;
1638 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1642 // something still in the readbuffer, but not enough to satisfy 'size'?
1643 if (ftdi->readbuffer_remaining != 0)
1645 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1648 offset += ftdi->readbuffer_remaining;
1650 // do the actual USB read
1651 while (offset < size && actual_length > 0)
1653 ftdi->readbuffer_remaining = 0;
1654 ftdi->readbuffer_offset = 0;
1655 /* returns how much received */
1656 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
1658 ftdi_error_return(ret, "usb bulk read failed");
1660 if (actual_length > 2)
1662 // skip FTDI status bytes.
1663 // Maybe stored in the future to enable modem use
1664 num_of_chunks = actual_length / packet_size;
1665 chunk_remains = actual_length % packet_size;
1666 //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);
1668 ftdi->readbuffer_offset += 2;
1671 if (actual_length > packet_size - 2)
1673 for (i = 1; i < num_of_chunks; i++)
1674 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1675 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1677 if (chunk_remains > 2)
1679 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1680 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1682 actual_length -= 2*num_of_chunks;
1685 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1688 else if (actual_length <= 2)
1690 // no more data to read?
1693 if (actual_length > 0)
1695 // data still fits in buf?
1696 if (offset+actual_length <= size)
1698 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
1699 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1700 offset += actual_length;
1702 /* Did we read exactly the right amount of bytes? */
1704 //printf("read_data exact rem %d offset %d\n",
1705 //ftdi->readbuffer_remaining, offset);
1710 // only copy part of the data or size <= readbuffer_chunksize
1711 int part_size = size-offset;
1712 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
1714 ftdi->readbuffer_offset += part_size;
1715 ftdi->readbuffer_remaining = actual_length-part_size;
1716 offset += part_size;
1718 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1719 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1730 Configure read buffer chunk size.
1733 Automatically reallocates the buffer.
1735 \param ftdi pointer to ftdi_context
1736 \param chunksize Chunk size
1739 \retval -1: ftdi context invalid
1741 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1743 unsigned char *new_buf;
1746 ftdi_error_return(-1, "ftdi context invalid");
1748 // Invalidate all remaining data
1749 ftdi->readbuffer_offset = 0;
1750 ftdi->readbuffer_remaining = 0;
1752 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
1753 which is defined in libusb-1.0. Otherwise, each USB read request will
1754 be divided into multiple URBs. This will cause issues on Linux kernel
1755 older than 2.6.32. */
1756 if (chunksize > 16384)
1760 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
1761 ftdi_error_return(-1, "out of memory for readbuffer");
1763 ftdi->readbuffer = new_buf;
1764 ftdi->readbuffer_chunksize = chunksize;
1770 Get read buffer chunk size.
1772 \param ftdi pointer to ftdi_context
1773 \param chunksize Pointer to store chunk size in
1776 \retval -1: FTDI context invalid
1778 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1781 ftdi_error_return(-1, "FTDI context invalid");
1783 *chunksize = ftdi->readbuffer_chunksize;
1789 Enable bitbang mode.
1791 \deprecated use \ref ftdi_set_bitmode with mode BITMODE_BITBANG instead
1793 \param ftdi pointer to ftdi_context
1794 \param bitmask Bitmask to configure lines.
1795 HIGH/ON value configures a line as output.
1798 \retval -1: can't enable bitbang mode
1799 \retval -2: USB device unavailable
1801 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
1803 unsigned short usb_val;
1805 if (ftdi == NULL || ftdi->usb_dev == NULL)
1806 ftdi_error_return(-2, "USB device unavailable");
1808 usb_val = bitmask; // low byte: bitmask
1809 /* FT2232C: Set bitbang_mode to 2 to enable SPI */
1810 usb_val |= (ftdi->bitbang_mode << 8);
1812 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1813 SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index,
1814 NULL, 0, ftdi->usb_write_timeout) < 0)
1815 ftdi_error_return(-1, "unable to enter bitbang mode. Perhaps not a BM type chip?");
1817 ftdi->bitbang_enabled = 1;
1822 Disable bitbang mode.
1824 \param ftdi pointer to ftdi_context
1827 \retval -1: can't disable bitbang mode
1828 \retval -2: USB device unavailable
1830 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
1832 if (ftdi == NULL || ftdi->usb_dev == NULL)
1833 ftdi_error_return(-2, "USB device unavailable");
1835 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)
1836 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
1838 ftdi->bitbang_enabled = 0;
1843 Enable/disable bitbang modes.
1845 \param ftdi pointer to ftdi_context
1846 \param bitmask Bitmask to configure lines.
1847 HIGH/ON value configures a line as output.
1848 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
1851 \retval -1: can't enable bitbang mode
1852 \retval -2: USB device unavailable
1854 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
1856 unsigned short usb_val;
1858 if (ftdi == NULL || ftdi->usb_dev == NULL)
1859 ftdi_error_return(-2, "USB device unavailable");
1861 usb_val = bitmask; // low byte: bitmask
1862 usb_val |= (mode << 8);
1863 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)
1864 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?");
1866 ftdi->bitbang_mode = mode;
1867 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
1872 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
1874 \param ftdi pointer to ftdi_context
1875 \param pins Pointer to store pins into
1878 \retval -1: read pins failed
1879 \retval -2: USB device unavailable
1881 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
1883 if (ftdi == NULL || ftdi->usb_dev == NULL)
1884 ftdi_error_return(-2, "USB device unavailable");
1886 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)
1887 ftdi_error_return(-1, "read pins failed");
1895 The FTDI chip keeps data in the internal buffer for a specific
1896 amount of time if the buffer is not full yet to decrease
1897 load on the usb bus.
1899 \param ftdi pointer to ftdi_context
1900 \param latency Value between 1 and 255
1903 \retval -1: latency out of range
1904 \retval -2: unable to set latency timer
1905 \retval -3: USB device unavailable
1907 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
1909 unsigned short usb_val;
1912 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
1914 if (ftdi == NULL || ftdi->usb_dev == NULL)
1915 ftdi_error_return(-3, "USB device unavailable");
1918 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)
1919 ftdi_error_return(-2, "unable to set latency timer");
1927 \param ftdi pointer to ftdi_context
1928 \param latency Pointer to store latency value in
1931 \retval -1: unable to get latency timer
1932 \retval -2: USB device unavailable
1934 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
1936 unsigned short usb_val;
1938 if (ftdi == NULL || ftdi->usb_dev == NULL)
1939 ftdi_error_return(-2, "USB device unavailable");
1941 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)
1942 ftdi_error_return(-1, "reading latency timer failed");
1944 *latency = (unsigned char)usb_val;
1949 Poll modem status information
1951 This function allows the retrieve the two status bytes of the device.
1952 The device sends these bytes also as a header for each read access
1953 where they are discarded by ftdi_read_data(). The chip generates
1954 the two stripped status bytes in the absence of data every 40 ms.
1956 Layout of the first byte:
1957 - B0..B3 - must be 0
1958 - B4 Clear to send (CTS)
1961 - B5 Data set ready (DTS)
1964 - B6 Ring indicator (RI)
1967 - B7 Receive line signal detect (RLSD)
1971 Layout of the second byte:
1972 - B0 Data ready (DR)
1973 - B1 Overrun error (OE)
1974 - B2 Parity error (PE)
1975 - B3 Framing error (FE)
1976 - B4 Break interrupt (BI)
1977 - B5 Transmitter holding register (THRE)
1978 - B6 Transmitter empty (TEMT)
1979 - B7 Error in RCVR FIFO
1981 \param ftdi pointer to ftdi_context
1982 \param status Pointer to store status information in. Must be two bytes.
1985 \retval -1: unable to retrieve status information
1986 \retval -2: USB device unavailable
1988 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
1992 if (ftdi == NULL || ftdi->usb_dev == NULL)
1993 ftdi_error_return(-2, "USB device unavailable");
1995 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)
1996 ftdi_error_return(-1, "getting modem status failed");
1998 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
2004 Set flowcontrol for ftdi chip
2006 \param ftdi pointer to ftdi_context
2007 \param flowctrl flow control to use. should be
2008 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS
2011 \retval -1: set flow control failed
2012 \retval -2: USB device unavailable
2014 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2016 if (ftdi == NULL || ftdi->usb_dev == NULL)
2017 ftdi_error_return(-2, "USB device unavailable");
2019 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2020 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2021 NULL, 0, ftdi->usb_write_timeout) < 0)
2022 ftdi_error_return(-1, "set flow control failed");
2030 \param ftdi pointer to ftdi_context
2031 \param state state to set line to (1 or 0)
2034 \retval -1: set dtr failed
2035 \retval -2: USB device unavailable
2037 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2039 unsigned short usb_val;
2041 if (ftdi == NULL || ftdi->usb_dev == NULL)
2042 ftdi_error_return(-2, "USB device unavailable");
2045 usb_val = SIO_SET_DTR_HIGH;
2047 usb_val = SIO_SET_DTR_LOW;
2049 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2050 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2051 NULL, 0, ftdi->usb_write_timeout) < 0)
2052 ftdi_error_return(-1, "set dtr failed");
2060 \param ftdi pointer to ftdi_context
2061 \param state state to set line to (1 or 0)
2064 \retval -1: set rts failed
2065 \retval -2: USB device unavailable
2067 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2069 unsigned short usb_val;
2071 if (ftdi == NULL || ftdi->usb_dev == NULL)
2072 ftdi_error_return(-2, "USB device unavailable");
2075 usb_val = SIO_SET_RTS_HIGH;
2077 usb_val = SIO_SET_RTS_LOW;
2079 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2080 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2081 NULL, 0, ftdi->usb_write_timeout) < 0)
2082 ftdi_error_return(-1, "set of rts failed");
2088 Set dtr and rts line in one pass
2090 \param ftdi pointer to ftdi_context
2091 \param dtr DTR state to set line to (1 or 0)
2092 \param rts RTS state to set line to (1 or 0)
2095 \retval -1: set dtr/rts failed
2096 \retval -2: USB device unavailable
2098 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2100 unsigned short usb_val;
2102 if (ftdi == NULL || ftdi->usb_dev == NULL)
2103 ftdi_error_return(-2, "USB device unavailable");
2106 usb_val = SIO_SET_DTR_HIGH;
2108 usb_val = SIO_SET_DTR_LOW;
2111 usb_val |= SIO_SET_RTS_HIGH;
2113 usb_val |= SIO_SET_RTS_LOW;
2115 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2116 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2117 NULL, 0, ftdi->usb_write_timeout) < 0)
2118 ftdi_error_return(-1, "set of rts/dtr failed");
2124 Set the special event character
2126 \param ftdi pointer to ftdi_context
2127 \param eventch Event character
2128 \param enable 0 to disable the event character, non-zero otherwise
2131 \retval -1: unable to set event character
2132 \retval -2: USB device unavailable
2134 int ftdi_set_event_char(struct ftdi_context *ftdi,
2135 unsigned char eventch, unsigned char enable)
2137 unsigned short usb_val;
2139 if (ftdi == NULL || ftdi->usb_dev == NULL)
2140 ftdi_error_return(-2, "USB device unavailable");
2146 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)
2147 ftdi_error_return(-1, "setting event character failed");
2155 \param ftdi pointer to ftdi_context
2156 \param errorch Error character
2157 \param enable 0 to disable the error character, non-zero otherwise
2160 \retval -1: unable to set error character
2161 \retval -2: USB device unavailable
2163 int ftdi_set_error_char(struct ftdi_context *ftdi,
2164 unsigned char errorch, unsigned char enable)
2166 unsigned short usb_val;
2168 if (ftdi == NULL || ftdi->usb_dev == NULL)
2169 ftdi_error_return(-2, "USB device unavailable");
2175 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)
2176 ftdi_error_return(-1, "setting error character failed");
2182 Init eeprom with default values for the connected device
2183 \param ftdi pointer to ftdi_context
2184 \param manufacturer String to use as Manufacturer
2185 \param product String to use as Product description
2186 \param serial String to use as Serial number description
2189 \retval -1: No struct ftdi_context
2190 \retval -2: No struct ftdi_eeprom
2191 \retval -3: No connected device or device not yet opened
2193 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
2194 char * product, char * serial)
2196 struct ftdi_eeprom *eeprom;
2199 ftdi_error_return(-1, "No struct ftdi_context");
2201 if (ftdi->eeprom == NULL)
2202 ftdi_error_return(-2,"No struct ftdi_eeprom");
2204 eeprom = ftdi->eeprom;
2205 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2207 if (ftdi->usb_dev == NULL)
2208 ftdi_error_return(-3, "No connected device or device not yet opened");
2210 eeprom->vendor_id = 0x0403;
2211 eeprom->use_serial = USE_SERIAL_NUM;
2212 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2213 (ftdi->type == TYPE_R))
2214 eeprom->product_id = 0x6001;
2215 else if (ftdi->type == TYPE_4232H)
2216 eeprom->product_id = 0x6011;
2217 else if (ftdi->type == TYPE_232H)
2218 eeprom->product_id = 0x6014;
2220 eeprom->product_id = 0x6010;
2221 if (ftdi->type == TYPE_AM)
2222 eeprom->usb_version = 0x0101;
2224 eeprom->usb_version = 0x0200;
2225 eeprom->max_power = 100;
2227 if (eeprom->manufacturer)
2228 free (eeprom->manufacturer);
2229 eeprom->manufacturer = NULL;
2232 eeprom->manufacturer = malloc(strlen(manufacturer)+1);
2233 if (eeprom->manufacturer)
2234 strcpy(eeprom->manufacturer, manufacturer);
2237 if (eeprom->product)
2238 free (eeprom->product);
2239 eeprom->product = NULL;
2242 eeprom->product = malloc(strlen(product)+1);
2243 if (eeprom->product)
2244 strcpy(eeprom->product, product);
2248 free (eeprom->serial);
2249 eeprom->serial = NULL;
2252 eeprom->serial = malloc(strlen(serial)+1);
2254 strcpy(eeprom->serial, serial);
2258 if (ftdi->type == TYPE_R)
2260 eeprom->max_power = 90;
2261 eeprom->size = 0x80;
2262 eeprom->cbus_function[0] = CBUS_TXLED;
2263 eeprom->cbus_function[1] = CBUS_RXLED;
2264 eeprom->cbus_function[2] = CBUS_TXDEN;
2265 eeprom->cbus_function[3] = CBUS_PWREN;
2266 eeprom->cbus_function[4] = CBUS_SLEEP;
2270 if(ftdi->type == TYPE_232H)
2273 for (i=0; i<10; i++)
2274 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2278 eeprom->initialized_for_connected_device = 1;
2281 /*FTD2XX doesn't check for values not fitting in the ACBUS Signal oprtions*/
2282 void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2287 int mode_low, mode_high;
2288 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2289 mode_low = CBUSH_TRISTATE;
2291 mode_low = eeprom->cbus_function[2*i];
2292 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2293 mode_high = CBUSH_TRISTATE;
2295 mode_high = eeprom->cbus_function[2*i];
2297 output[0x18+i] = mode_high <<4 | mode_low;
2300 /* Return the bits for the encoded EEPROM Structure of a requested Mode
2303 static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2312 case CHANNEL_IS_UART: return 0;
2313 case CHANNEL_IS_FIFO: return 0x01;
2314 case CHANNEL_IS_OPTO: return 0x02;
2315 case CHANNEL_IS_CPU : return 0x04;
2323 case CHANNEL_IS_UART : return 0;
2324 case CHANNEL_IS_FIFO : return 0x01;
2325 case CHANNEL_IS_OPTO : return 0x02;
2326 case CHANNEL_IS_CPU : return 0x04;
2327 case CHANNEL_IS_FT1284 : return 0x08;
2337 Build binary buffer from ftdi_eeprom structure.
2338 Output is suitable for ftdi_write_eeprom().
2340 \param ftdi pointer to ftdi_context
2342 \retval >=0: size of eeprom user area in bytes
2343 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2344 \retval -2: Invalid eeprom or ftdi pointer
2345 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2346 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2347 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2348 \retval -6: No connected EEPROM or EEPROM Type unknown
2350 int ftdi_eeprom_build(struct ftdi_context *ftdi)
2352 unsigned char i, j, eeprom_size_mask;
2353 unsigned short checksum, value;
2354 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2356 struct ftdi_eeprom *eeprom;
2357 unsigned char * output;
2360 ftdi_error_return(-2,"No context");
2361 if (ftdi->eeprom == NULL)
2362 ftdi_error_return(-2,"No eeprom structure");
2364 eeprom= ftdi->eeprom;
2365 output = eeprom->buf;
2367 if (eeprom->chip == -1)
2368 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2370 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2371 eeprom->size = 0x100;
2373 eeprom->size = 0x80;
2375 if (eeprom->manufacturer != NULL)
2376 manufacturer_size = strlen(eeprom->manufacturer);
2377 if (eeprom->product != NULL)
2378 product_size = strlen(eeprom->product);
2379 if (eeprom->serial != NULL)
2380 serial_size = strlen(eeprom->serial);
2382 // eeprom size check
2387 user_area_size = 96; // base size for strings (total of 48 characters)
2390 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2393 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2395 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2397 user_area_size = 86;
2400 user_area_size = 80;
2406 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
2408 if (user_area_size < 0)
2409 ftdi_error_return(-1,"eeprom size exceeded");
2412 memset (ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2414 // Bytes and Bits set for all Types
2416 // Addr 02: Vendor ID
2417 output[0x02] = eeprom->vendor_id;
2418 output[0x03] = eeprom->vendor_id >> 8;
2420 // Addr 04: Product ID
2421 output[0x04] = eeprom->product_id;
2422 output[0x05] = eeprom->product_id >> 8;
2424 // Addr 06: Device release number (0400h for BM features)
2425 output[0x06] = 0x00;
2429 output[0x07] = 0x02;
2432 output[0x07] = 0x04;
2435 output[0x07] = 0x05;
2438 output[0x07] = 0x06;
2441 output[0x07] = 0x07;
2444 output[0x07] = 0x08;
2447 output[0x07] = 0x09;
2450 output[0x07] = 0x00;
2453 // Addr 08: Config descriptor
2455 // Bit 6: 1 if this device is self powered, 0 if bus powered
2456 // Bit 5: 1 if this device uses remote wakeup
2457 // Bit 4-0: reserved - 0
2459 if (eeprom->self_powered == 1)
2461 if (eeprom->remote_wakeup == 1)
2465 // Addr 09: Max power consumption: max power = value * 2 mA
2466 output[0x09] = eeprom->max_power>>1;
2468 if (ftdi->type != TYPE_AM)
2470 // Addr 0A: Chip configuration
2471 // Bit 7: 0 - reserved
2472 // Bit 6: 0 - reserved
2473 // Bit 5: 0 - reserved
2474 // Bit 4: 1 - Change USB version
2475 // Bit 3: 1 - Use the serial number string
2476 // Bit 2: 1 - Enable suspend pull downs for lower power
2477 // Bit 1: 1 - Out EndPoint is Isochronous
2478 // Bit 0: 1 - In EndPoint is Isochronous
2481 if (eeprom->in_is_isochronous == 1)
2483 if (eeprom->out_is_isochronous == 1)
2489 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
2490 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
2508 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
2509 eeprom_size_mask = eeprom->size -1;
2511 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2512 // Addr 0F: Length of manufacturer string
2513 // Output manufacturer
2514 output[0x0E] = i; // calculate offset
2515 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
2516 output[i & eeprom_size_mask] = 0x03, i++; // type: string
2517 for (j = 0; j < manufacturer_size; j++)
2519 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
2520 output[i & eeprom_size_mask] = 0x00, i++;
2522 output[0x0F] = manufacturer_size*2 + 2;
2524 // Addr 10: Offset of the product string + 0x80, calculated later
2525 // Addr 11: Length of product string
2526 output[0x10] = i | 0x80; // calculate offset
2527 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
2528 output[i & eeprom_size_mask] = 0x03, i++;
2529 for (j = 0; j < product_size; j++)
2531 output[i & eeprom_size_mask] = eeprom->product[j], i++;
2532 output[i & eeprom_size_mask] = 0x00, i++;
2534 output[0x11] = product_size*2 + 2;
2536 // Addr 12: Offset of the serial string + 0x80, calculated later
2537 // Addr 13: Length of serial string
2538 output[0x12] = i | 0x80; // calculate offset
2539 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
2540 output[i & eeprom_size_mask] = 0x03, i++;
2541 for (j = 0; j < serial_size; j++)
2543 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
2544 output[i & eeprom_size_mask] = 0x00, i++;
2547 // Legacy port name and PnP fields for FT2232 and newer chips
2548 if (ftdi->type > TYPE_BM)
2550 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
2552 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
2554 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
2558 output[0x13] = serial_size*2 + 2;
2560 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
2562 if (eeprom->use_serial == USE_SERIAL_NUM )
2563 output[0x0A] |= USE_SERIAL_NUM;
2565 output[0x0A] &= ~USE_SERIAL_NUM;
2568 /* Bytes and Bits specific to (some) types
2569 Write linear, as this allows easier fixing*/
2575 output[0x0C] = eeprom->usb_version & 0xff;
2576 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2577 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2578 output[0x0A] |= USE_USB_VERSION_BIT;
2580 output[0x0A] &= ~USE_USB_VERSION_BIT;
2585 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
2586 if ( eeprom->channel_a_driver == DRIVER_VCP)
2587 output[0x00] |= DRIVER_VCP;
2589 output[0x00] &= ~DRIVER_VCP;
2591 if ( eeprom->high_current_a == HIGH_CURRENT_DRIVE)
2592 output[0x00] |= HIGH_CURRENT_DRIVE;
2594 output[0x00] &= ~HIGH_CURRENT_DRIVE;
2596 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
2597 if ( eeprom->channel_b_driver == DRIVER_VCP)
2598 output[0x01] |= DRIVER_VCP;
2600 output[0x01] &= ~DRIVER_VCP;
2602 if ( eeprom->high_current_b == HIGH_CURRENT_DRIVE)
2603 output[0x01] |= HIGH_CURRENT_DRIVE;
2605 output[0x01] &= ~HIGH_CURRENT_DRIVE;
2607 if (eeprom->in_is_isochronous == 1)
2608 output[0x0A] |= 0x1;
2610 output[0x0A] &= ~0x1;
2611 if (eeprom->out_is_isochronous == 1)
2612 output[0x0A] |= 0x2;
2614 output[0x0A] &= ~0x2;
2615 if (eeprom->suspend_pull_downs == 1)
2616 output[0x0A] |= 0x4;
2618 output[0x0A] &= ~0x4;
2619 if (eeprom->use_usb_version == USE_USB_VERSION_BIT)
2620 output[0x0A] |= USE_USB_VERSION_BIT;
2622 output[0x0A] &= ~USE_USB_VERSION_BIT;
2624 output[0x0C] = eeprom->usb_version & 0xff;
2625 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2626 output[0x14] = eeprom->chip;
2629 if (eeprom->high_current == HIGH_CURRENT_DRIVE_R)
2630 output[0x00] |= HIGH_CURRENT_DRIVE_R;
2631 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
2633 if (eeprom->suspend_pull_downs == 1)
2634 output[0x0A] |= 0x4;
2636 output[0x0A] &= ~0x4;
2637 output[0x0B] = eeprom->invert;
2638 output[0x0C] = eeprom->usb_version & 0xff;
2639 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
2641 if (eeprom->cbus_function[0] > CBUS_BB)
2642 output[0x14] = CBUS_TXLED;
2644 output[0x14] = eeprom->cbus_function[0];
2646 if (eeprom->cbus_function[1] > CBUS_BB)
2647 output[0x14] |= CBUS_RXLED<<4;
2649 output[0x14] |= eeprom->cbus_function[1]<<4;
2651 if (eeprom->cbus_function[2] > CBUS_BB)
2652 output[0x15] = CBUS_TXDEN;
2654 output[0x15] = eeprom->cbus_function[2];
2656 if (eeprom->cbus_function[3] > CBUS_BB)
2657 output[0x15] |= CBUS_PWREN<<4;
2659 output[0x15] |= eeprom->cbus_function[3]<<4;
2661 if (eeprom->cbus_function[4] > CBUS_CLK6)
2662 output[0x16] = CBUS_SLEEP;
2664 output[0x16] = eeprom->cbus_function[4];
2667 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
2668 if ( eeprom->channel_a_driver == DRIVER_VCP)
2669 output[0x00] |= DRIVER_VCP;
2671 output[0x00] &= ~DRIVER_VCP;
2673 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
2674 if ( eeprom->channel_b_driver == DRIVER_VCP)
2675 output[0x01] |= DRIVER_VCP;
2677 output[0x01] &= ~DRIVER_VCP;
2678 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
2679 output[0x01] |= SUSPEND_DBUS7_BIT;
2681 output[0x01] &= ~SUSPEND_DBUS7_BIT;
2683 if (eeprom->suspend_pull_downs == 1)
2684 output[0x0A] |= 0x4;
2686 output[0x0A] &= ~0x4;
2688 if (eeprom->group0_drive > DRIVE_16MA)
2689 output[0x0c] |= DRIVE_16MA;
2691 output[0x0c] |= eeprom->group0_drive;
2692 if (eeprom->group0_schmitt == IS_SCHMITT)
2693 output[0x0c] |= IS_SCHMITT;
2694 if (eeprom->group0_slew == SLOW_SLEW)
2695 output[0x0c] |= SLOW_SLEW;
2697 if (eeprom->group1_drive > DRIVE_16MA)
2698 output[0x0c] |= DRIVE_16MA<<4;
2700 output[0x0c] |= eeprom->group1_drive<<4;
2701 if (eeprom->group1_schmitt == IS_SCHMITT)
2702 output[0x0c] |= IS_SCHMITT<<4;
2703 if (eeprom->group1_slew == SLOW_SLEW)
2704 output[0x0c] |= SLOW_SLEW<<4;
2706 if (eeprom->group2_drive > DRIVE_16MA)
2707 output[0x0d] |= DRIVE_16MA;
2709 output[0x0d] |= eeprom->group2_drive;
2710 if (eeprom->group2_schmitt == IS_SCHMITT)
2711 output[0x0d] |= IS_SCHMITT;
2712 if (eeprom->group2_slew == SLOW_SLEW)
2713 output[0x0d] |= SLOW_SLEW;
2715 if (eeprom->group3_drive > DRIVE_16MA)
2716 output[0x0d] |= DRIVE_16MA<<4;
2718 output[0x0d] |= eeprom->group3_drive<<4;
2719 if (eeprom->group3_schmitt == IS_SCHMITT)
2720 output[0x0d] |= IS_SCHMITT<<4;
2721 if (eeprom->group3_slew == SLOW_SLEW)
2722 output[0x0d] |= SLOW_SLEW<<4;
2724 output[0x18] = eeprom->chip;
2728 output[0x18] = eeprom->chip;
2729 fprintf(stderr,"FIXME: Build FT4232H specific EEPROM settings\n");
2732 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
2733 if ( eeprom->channel_a_driver == DRIVER_VCP)
2734 output[0x00] |= DRIVER_VCPH;
2736 output[0x00] &= ~DRIVER_VCPH;
2737 if (eeprom->powersave)
2738 output[0x01] |= POWER_SAVE_DISABLE_H;
2740 output[0x01] &= ~POWER_SAVE_DISABLE_H;
2741 if (eeprom->clock_polarity)
2742 output[0x01] |= FT1284_CLK_IDLE_STATE;
2744 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
2745 if (eeprom->data_order)
2746 output[0x01] |= FT1284_DATA_LSB;
2748 output[0x01] &= ~FT1284_DATA_LSB;
2749 if (eeprom->flow_control)
2750 output[0x01] |= FT1284_FLOW_CONTROL;
2752 output[0x01] &= ~FT1284_FLOW_CONTROL;
2753 if (eeprom->group0_drive > DRIVE_16MA)
2754 output[0x0c] |= DRIVE_16MA;
2756 output[0x0c] |= eeprom->group0_drive;
2757 if (eeprom->group0_schmitt == IS_SCHMITT)
2758 output[0x0c] |= IS_SCHMITT;
2759 if (eeprom->group0_slew == SLOW_SLEW)
2760 output[0x0c] |= SLOW_SLEW;
2762 if (eeprom->group1_drive > DRIVE_16MA)
2763 output[0x0d] |= DRIVE_16MA;
2765 output[0x0d] |= eeprom->group1_drive;
2766 if (eeprom->group1_schmitt == IS_SCHMITT)
2767 output[0x0d] |= IS_SCHMITT;
2768 if (eeprom->group1_slew == SLOW_SLEW)
2769 output[0x0d] |= SLOW_SLEW;
2771 set_ft232h_cbus(eeprom, output);
2773 output[0x1e] = eeprom->chip;
2774 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
2779 // calculate checksum
2782 for (i = 0; i < eeprom->size/2-1; i++)
2784 value = output[i*2];
2785 value += output[(i*2)+1] << 8;
2787 checksum = value^checksum;
2788 checksum = (checksum << 1) | (checksum >> 15);
2791 output[eeprom->size-2] = checksum;
2792 output[eeprom->size-1] = checksum >> 8;
2794 return user_area_size;
2796 /* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
2799 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
2801 static unsigned char bit2type(unsigned char bits)
2805 case 0: return CHANNEL_IS_UART;
2806 case 1: return CHANNEL_IS_FIFO;
2807 case 2: return CHANNEL_IS_OPTO;
2808 case 4: return CHANNEL_IS_CPU;
2809 case 8: return CHANNEL_IS_FT1284;
2811 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
2817 Decode binary EEPROM image into an ftdi_eeprom structure.
2819 \param ftdi pointer to ftdi_context
2820 \param verbose Decode EEPROM on stdout
2823 \retval -1: something went wrong
2825 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
2826 FIXME: Strings are malloc'ed here and should be freed somewhere
2828 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
2831 unsigned short checksum, eeprom_checksum, value;
2832 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2834 struct ftdi_eeprom *eeprom;
2835 unsigned char *buf = ftdi->eeprom->buf;
2839 ftdi_error_return(-1,"No context");
2840 if (ftdi->eeprom == NULL)
2841 ftdi_error_return(-1,"No eeprom structure");
2843 eeprom = ftdi->eeprom;
2844 eeprom_size = eeprom->size;
2846 // Addr 02: Vendor ID
2847 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
2849 // Addr 04: Product ID
2850 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
2852 release = buf[0x06] + (buf[0x07]<<8);
2854 // Addr 08: Config descriptor
2856 // Bit 6: 1 if this device is self powered, 0 if bus powered
2857 // Bit 5: 1 if this device uses remote wakeup
2858 eeprom->self_powered = buf[0x08] & 0x40;
2859 eeprom->remote_wakeup = buf[0x08] & 0x20;
2861 // Addr 09: Max power consumption: max power = value * 2 mA
2862 eeprom->max_power = buf[0x09];
2864 // Addr 0A: Chip configuration
2865 // Bit 7: 0 - reserved
2866 // Bit 6: 0 - reserved
2867 // Bit 5: 0 - reserved
2868 // Bit 4: 1 - Change USB version on BM and 2232C
2869 // Bit 3: 1 - Use the serial number string
2870 // Bit 2: 1 - Enable suspend pull downs for lower power
2871 // Bit 1: 1 - Out EndPoint is Isochronous
2872 // Bit 0: 1 - In EndPoint is Isochronous
2874 eeprom->in_is_isochronous = buf[0x0A]&0x01;
2875 eeprom->out_is_isochronous = buf[0x0A]&0x02;
2876 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
2877 eeprom->use_serial = buf[0x0A] & USE_SERIAL_NUM;
2878 eeprom->use_usb_version = buf[0x0A] & USE_USB_VERSION_BIT;
2880 // Addr 0C: USB version low byte when 0x0A
2881 // Addr 0D: USB version high byte when 0x0A
2882 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
2884 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2885 // Addr 0F: Length of manufacturer string
2886 manufacturer_size = buf[0x0F]/2;
2887 if (eeprom->manufacturer)
2888 free(eeprom->manufacturer);
2889 if (manufacturer_size > 0)
2891 eeprom->manufacturer = malloc(manufacturer_size);
2892 if (eeprom->manufacturer)
2894 // Decode manufacturer
2895 i = buf[0x0E] & (eeprom_size -1); // offset
2896 for (j=0;j<manufacturer_size-1;j++)
2898 eeprom->manufacturer[j] = buf[2*j+i+2];
2900 eeprom->manufacturer[j] = '\0';
2903 else eeprom->manufacturer = NULL;
2905 // Addr 10: Offset of the product string + 0x80, calculated later
2906 // Addr 11: Length of product string
2907 if (eeprom->product)
2908 free(eeprom->product);
2909 product_size = buf[0x11]/2;
2910 if (product_size > 0)
2912 eeprom->product = malloc(product_size);
2913 if (eeprom->product)
2915 // Decode product name
2916 i = buf[0x10] & (eeprom_size -1); // offset
2917 for (j=0;j<product_size-1;j++)
2919 eeprom->product[j] = buf[2*j+i+2];
2921 eeprom->product[j] = '\0';
2924 else eeprom->product = NULL;
2926 // Addr 12: Offset of the serial string + 0x80, calculated later
2927 // Addr 13: Length of serial string
2929 free(eeprom->serial);
2930 serial_size = buf[0x13]/2;
2931 if (serial_size > 0)
2933 eeprom->serial = malloc(serial_size);
2937 i = buf[0x12] & (eeprom_size -1); // offset
2938 for (j=0;j<serial_size-1;j++)
2940 eeprom->serial[j] = buf[2*j+i+2];
2942 eeprom->serial[j] = '\0';
2945 else eeprom->serial = NULL;
2950 for (i = 0; i < eeprom_size/2-1; i++)
2953 value += buf[(i*2)+1] << 8;
2955 checksum = value^checksum;
2956 checksum = (checksum << 1) | (checksum >> 15);
2959 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
2961 if (eeprom_checksum != checksum)
2963 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
2964 ftdi_error_return(-1,"EEPROM checksum error");
2967 eeprom->channel_a_type = 0;
2968 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
2972 else if (ftdi->type == TYPE_2232C)
2974 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
2975 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
2976 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
2977 eeprom->channel_b_type = buf[0x01] & 0x7;
2978 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
2979 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
2980 eeprom->chip = buf[0x14];
2982 else if (ftdi->type == TYPE_R)
2984 /* TYPE_R flags D2XX, not VCP as all others*/
2985 eeprom->channel_a_driver = (~buf[0x00]) & DRIVER_VCP;
2986 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
2987 if ( (buf[0x01]&0x40) != 0x40)
2989 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
2990 " If this happened with the\n"
2991 " EEPROM programmed by FTDI tools, please report "
2992 "to libftdi@developer.intra2net.com\n");
2994 eeprom->chip = buf[0x16];
2995 // Addr 0B: Invert data lines
2996 // Works only on FT232R, not FT245R, but no way to distinguish
2997 eeprom->invert = buf[0x0B];
2998 // Addr 14: CBUS function: CBUS0, CBUS1
2999 // Addr 15: CBUS function: CBUS2, CBUS3
3000 // Addr 16: CBUS function: CBUS5
3001 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3002 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3003 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3004 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3005 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
3007 else if ((ftdi->type == TYPE_2232H) ||(ftdi->type == TYPE_4232H))
3009 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3010 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3011 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
3012 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3014 if (ftdi->type == TYPE_2232H)
3015 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
3017 eeprom->chip = buf[0x18];
3018 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3019 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3020 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3021 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3022 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3023 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3024 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3025 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3026 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3027 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3028 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3029 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
3031 else if (ftdi->type == TYPE_232H)
3035 eeprom->channel_a_type = buf[0x00] & 0xf;
3036 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
3037 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3038 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3039 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
3040 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
3041 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3042 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3043 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3044 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3045 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3046 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3050 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3051 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3053 eeprom->chip = buf[0x1e];
3054 /*FIXME: Decipher more values*/
3059 char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
3060 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3061 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
3062 fprintf(stdout, "Release: 0x%04x\n",release);
3064 if (eeprom->self_powered)
3065 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3067 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power * 2,
3068 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
3069 if (eeprom->manufacturer)
3070 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
3071 if (eeprom->product)
3072 fprintf(stdout, "Product: %s\n",eeprom->product);
3074 fprintf(stdout, "Serial: %s\n",eeprom->serial);
3075 fprintf(stdout, "Checksum : %04x\n", checksum);
3076 if (ftdi->type == TYPE_R)
3077 fprintf(stdout, "Internal EEPROM\n");
3078 else if (eeprom->chip >= 0x46)
3079 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
3080 if (eeprom->suspend_dbus7)
3081 fprintf(stdout, "Suspend on DBUS7\n");
3082 if (eeprom->suspend_pull_downs)
3083 fprintf(stdout, "Pull IO pins low during suspend\n");
3084 if(eeprom->powersave)
3086 if(ftdi->type >= TYPE_232H)
3087 fprintf(stdout,"Enter low power state on ACBUS7\n");
3089 if (eeprom->remote_wakeup)
3090 fprintf(stdout, "Enable Remote Wake Up\n");
3091 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
3092 if (ftdi->type >= TYPE_2232C)
3093 fprintf(stdout,"Channel A has Mode %s%s%s\n",
3094 channel_mode[eeprom->channel_a_type],
3095 (eeprom->channel_a_driver)?" VCP":"",
3096 (eeprom->high_current_a)?" High Current IO":"");
3097 if (ftdi->type >= TYPE_232H)
3099 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3100 (eeprom->clock_polarity)?"HIGH":"LOW",
3101 (eeprom->data_order)?"LSB":"MSB",
3102 (eeprom->flow_control)?"":"No ");
3104 if ((ftdi->type >= TYPE_2232C) && (ftdi->type != TYPE_R) && (ftdi->type != TYPE_232H))
3105 fprintf(stdout,"Channel B has Mode %s%s%s\n",
3106 channel_mode[eeprom->channel_b_type],
3107 (eeprom->channel_b_driver)?" VCP":"",
3108 (eeprom->high_current_b)?" High Current IO":"");
3109 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3110 eeprom->use_usb_version == USE_USB_VERSION_BIT)
3111 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3113 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
3115 fprintf(stdout,"%s has %d mA drive%s%s\n",
3116 (ftdi->type == TYPE_2232H)?"AL":"A",
3117 (eeprom->group0_drive+1) *4,
3118 (eeprom->group0_schmitt)?" Schmitt Input":"",
3119 (eeprom->group0_slew)?" Slow Slew":"");
3120 fprintf(stdout,"%s has %d mA drive%s%s\n",
3121 (ftdi->type == TYPE_2232H)?"AH":"B",
3122 (eeprom->group1_drive+1) *4,
3123 (eeprom->group1_schmitt)?" Schmitt Input":"",
3124 (eeprom->group1_slew)?" Slow Slew":"");
3125 fprintf(stdout,"%s has %d mA drive%s%s\n",
3126 (ftdi->type == TYPE_2232H)?"BL":"C",
3127 (eeprom->group2_drive+1) *4,
3128 (eeprom->group2_schmitt)?" Schmitt Input":"",
3129 (eeprom->group2_slew)?" Slow Slew":"");
3130 fprintf(stdout,"%s has %d mA drive%s%s\n",
3131 (ftdi->type == TYPE_2232H)?"BH":"D",
3132 (eeprom->group3_drive+1) *4,
3133 (eeprom->group3_schmitt)?" Schmitt Input":"",
3134 (eeprom->group3_slew)?" Slow Slew":"");
3136 else if (ftdi->type == TYPE_232H)
3139 char *cbush_mux[] = {"TRISTATE","RXLED","TXLED", "TXRXLED","PWREN",
3140 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3141 "CLK30","CLK15","CLK7_5"
3143 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3144 (eeprom->group0_drive+1) *4,
3145 (eeprom->group0_schmitt)?" Schmitt Input":"",
3146 (eeprom->group0_slew)?" Slow Slew":"");
3147 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3148 (eeprom->group1_drive+1) *4,
3149 (eeprom->group1_schmitt)?" Schmitt Input":"",
3150 (eeprom->group1_slew)?" Slow Slew":"");
3151 for (i=0; i<10; i++)
3153 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3154 fprintf(stdout,"C%d Function: %s\n", i,
3155 cbush_mux[eeprom->cbus_function[i]]);
3160 if (ftdi->type == TYPE_R)
3162 char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
3163 "SLEEP","CLK48","CLK24","CLK12","CLK6",
3164 "IOMODE","BB_WR","BB_RD"
3166 char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
3170 char *r_bits[] = {"TXD","RXD","RTS", "CTS","DTR","DSR","DCD","RI"};
3171 fprintf(stdout,"Inverted bits:");
3173 if ((eeprom->invert & (1<<i)) == (1<<i))
3174 fprintf(stdout," %s",r_bits[i]);
3175 fprintf(stdout,"\n");
3179 if (eeprom->cbus_function[i]<CBUS_BB)
3180 fprintf(stdout,"C%d Function: %s\n", i,
3181 cbus_mux[eeprom->cbus_function[i]]);
3185 /* Running MPROG show that C0..3 have fixed function Synchronous
3187 fprintf(stdout,"C%d BB Function: %s\n", i,
3190 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
3199 Get a value from the decoded EEPROM structure
3201 \param ftdi pointer to ftdi_context
3202 \param value_name Enum of the value to query
3203 \param value Pointer to store read value
3206 \retval -1: Value doesn't exist
3208 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3213 *value = ftdi->eeprom->vendor_id;
3216 *value = ftdi->eeprom->product_id;
3219 *value = ftdi->eeprom->self_powered;
3222 *value = ftdi->eeprom->remote_wakeup;
3225 *value = ftdi->eeprom->is_not_pnp;
3228 *value = ftdi->eeprom->suspend_dbus7;
3230 case IN_IS_ISOCHRONOUS:
3231 *value = ftdi->eeprom->in_is_isochronous;
3233 case OUT_IS_ISOCHRONOUS:
3234 *value = ftdi->eeprom->out_is_isochronous;
3236 case SUSPEND_PULL_DOWNS:
3237 *value = ftdi->eeprom->suspend_pull_downs;
3240 *value = ftdi->eeprom->use_serial;
3243 *value = ftdi->eeprom->usb_version;
3245 case USE_USB_VERSION:
3246 *value = ftdi->eeprom->use_usb_version;
3249 *value = ftdi->eeprom->max_power;
3251 case CHANNEL_A_TYPE:
3252 *value = ftdi->eeprom->channel_a_type;
3254 case CHANNEL_B_TYPE:
3255 *value = ftdi->eeprom->channel_b_type;
3257 case CHANNEL_A_DRIVER:
3258 *value = ftdi->eeprom->channel_a_driver;
3260 case CHANNEL_B_DRIVER:
3261 *value = ftdi->eeprom->channel_b_driver;
3263 case CBUS_FUNCTION_0:
3264 *value = ftdi->eeprom->cbus_function[0];
3266 case CBUS_FUNCTION_1:
3267 *value = ftdi->eeprom->cbus_function[1];
3269 case CBUS_FUNCTION_2:
3270 *value = ftdi->eeprom->cbus_function[2];
3272 case CBUS_FUNCTION_3:
3273 *value = ftdi->eeprom->cbus_function[3];
3275 case CBUS_FUNCTION_4:
3276 *value = ftdi->eeprom->cbus_function[4];
3278 case CBUS_FUNCTION_5:
3279 *value = ftdi->eeprom->cbus_function[5];
3281 case CBUS_FUNCTION_6:
3282 *value = ftdi->eeprom->cbus_function[6];
3284 case CBUS_FUNCTION_7:
3285 *value = ftdi->eeprom->cbus_function[7];
3287 case CBUS_FUNCTION_8:
3288 *value = ftdi->eeprom->cbus_function[8];
3290 case CBUS_FUNCTION_9:
3291 *value = ftdi->eeprom->cbus_function[8];
3294 *value = ftdi->eeprom->high_current;
3296 case HIGH_CURRENT_A:
3297 *value = ftdi->eeprom->high_current_a;
3299 case HIGH_CURRENT_B:
3300 *value = ftdi->eeprom->high_current_b;
3303 *value = ftdi->eeprom->invert;
3306 *value = ftdi->eeprom->group0_drive;
3308 case GROUP0_SCHMITT:
3309 *value = ftdi->eeprom->group0_schmitt;
3312 *value = ftdi->eeprom->group0_slew;
3315 *value = ftdi->eeprom->group1_drive;
3317 case GROUP1_SCHMITT:
3318 *value = ftdi->eeprom->group1_schmitt;
3321 *value = ftdi->eeprom->group1_slew;
3324 *value = ftdi->eeprom->group2_drive;
3326 case GROUP2_SCHMITT:
3327 *value = ftdi->eeprom->group2_schmitt;
3330 *value = ftdi->eeprom->group2_slew;
3333 *value = ftdi->eeprom->group3_drive;
3335 case GROUP3_SCHMITT:
3336 *value = ftdi->eeprom->group3_schmitt;
3339 *value = ftdi->eeprom->group3_slew;
3342 *value = ftdi->eeprom->powersave;
3344 case CLOCK_POLARITY:
3345 *value = ftdi->eeprom->clock_polarity;
3348 *value = ftdi->eeprom->data_order;
3351 *value = ftdi->eeprom->flow_control;
3354 *value = ftdi->eeprom->chip;
3357 *value = ftdi->eeprom->size;
3360 ftdi_error_return(-1, "Request for unknown EEPROM value");
3366 Set a value in the decoded EEPROM Structure
3367 No parameter checking is performed
3369 \param ftdi pointer to ftdi_context
3370 \param value_name Enum of the value to set
3374 \retval -1: Value doesn't exist
3375 \retval -2: Value not user settable
3377 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
3382 ftdi->eeprom->vendor_id = value;
3385 ftdi->eeprom->product_id = value;
3388 ftdi->eeprom->self_powered = value;
3391 ftdi->eeprom->remote_wakeup = value;
3394 ftdi->eeprom->is_not_pnp = value;
3397 ftdi->eeprom->suspend_dbus7 = value;
3399 case IN_IS_ISOCHRONOUS:
3400 ftdi->eeprom->in_is_isochronous = value;
3402 case OUT_IS_ISOCHRONOUS:
3403 ftdi->eeprom->out_is_isochronous = value;
3405 case SUSPEND_PULL_DOWNS:
3406 ftdi->eeprom->suspend_pull_downs = value;
3409 ftdi->eeprom->use_serial = value;
3412 ftdi->eeprom->usb_version = value;
3414 case USE_USB_VERSION:
3415 ftdi->eeprom->use_usb_version = value;
3418 ftdi->eeprom->max_power = value;
3420 case CHANNEL_A_TYPE:
3421 ftdi->eeprom->channel_a_type = value;
3423 case CHANNEL_B_TYPE:
3424 ftdi->eeprom->channel_b_type = value;
3426 case CHANNEL_A_DRIVER:
3427 ftdi->eeprom->channel_a_driver = value;
3429 case CHANNEL_B_DRIVER:
3430 ftdi->eeprom->channel_b_driver = value;
3432 case CBUS_FUNCTION_0:
3433 ftdi->eeprom->cbus_function[0] = value;
3435 case CBUS_FUNCTION_1:
3436 ftdi->eeprom->cbus_function[1] = value;
3438 case CBUS_FUNCTION_2:
3439 ftdi->eeprom->cbus_function[2] = value;
3441 case CBUS_FUNCTION_3:
3442 ftdi->eeprom->cbus_function[3] = value;
3444 case CBUS_FUNCTION_4:
3445 ftdi->eeprom->cbus_function[4] = value;
3447 case CBUS_FUNCTION_5:
3448 ftdi->eeprom->cbus_function[5] = value;
3450 case CBUS_FUNCTION_6:
3451 ftdi->eeprom->cbus_function[6] = value;
3453 case CBUS_FUNCTION_7:
3454 ftdi->eeprom->cbus_function[7] = value;
3456 case CBUS_FUNCTION_8:
3457 ftdi->eeprom->cbus_function[8] = value;
3459 case CBUS_FUNCTION_9:
3460 ftdi->eeprom->cbus_function[9] = value;
3463 ftdi->eeprom->high_current = value;
3465 case HIGH_CURRENT_A:
3466 ftdi->eeprom->high_current_a = value;
3468 case HIGH_CURRENT_B:
3469 ftdi->eeprom->high_current_b = value;
3472 ftdi->eeprom->invert = value;
3475 ftdi->eeprom->group0_drive = value;
3477 case GROUP0_SCHMITT:
3478 ftdi->eeprom->group0_schmitt = value;
3481 ftdi->eeprom->group0_slew = value;
3484 ftdi->eeprom->group1_drive = value;
3486 case GROUP1_SCHMITT:
3487 ftdi->eeprom->group1_schmitt = value;
3490 ftdi->eeprom->group1_slew = value;
3493 ftdi->eeprom->group2_drive = value;
3495 case GROUP2_SCHMITT:
3496 ftdi->eeprom->group2_schmitt = value;
3499 ftdi->eeprom->group2_slew = value;
3502 ftdi->eeprom->group3_drive = value;
3504 case GROUP3_SCHMITT:
3505 ftdi->eeprom->group3_schmitt = value;
3508 ftdi->eeprom->group3_slew = value;
3511 ftdi->eeprom->chip = value;
3514 ftdi->eeprom->powersave = value;
3516 case CLOCK_POLARITY:
3517 ftdi->eeprom->clock_polarity = value;
3520 ftdi->eeprom->data_order = value;
3523 ftdi->eeprom->flow_control = value;
3526 ftdi_error_return(-2, "EEPROM Value can't be changed");
3528 ftdi_error_return(-1, "Request to unknown EEPROM value");
3533 /** Get the read-only buffer to the binary EEPROM content
3535 \param ftdi pointer to ftdi_context
3536 \param buf buffer to receive EEPROM content
3537 \param size Size of receiving buffer
3540 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
3541 \retval -2: Not enough room to store eeprom
3543 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
3545 if (!ftdi || !(ftdi->eeprom))
3546 ftdi_error_return(-1, "No appropriate structure");
3548 if (!buf || size < ftdi->eeprom->size)
3549 ftdi_error_return(-1, "Not enough room to store eeprom");
3551 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3552 if (size > FTDI_MAX_EEPROM_SIZE)
3553 size = FTDI_MAX_EEPROM_SIZE;
3555 memcpy(buf, ftdi->eeprom->buf, size);
3560 /** Set the EEPROM content from the user-supplied prefilled buffer
3562 \param ftdi pointer to ftdi_context
3563 \param buf buffer to read EEPROM content
3564 \param size Size of buffer
3567 \retval -1: struct ftdi_contxt or ftdi_eeprom of buf missing
3569 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
3571 if (!ftdi || !(ftdi->eeprom) || !buf)
3572 ftdi_error_return(-1, "No appropriate structure");
3574 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
3575 if (size > FTDI_MAX_EEPROM_SIZE)
3576 size = FTDI_MAX_EEPROM_SIZE;
3578 memcpy(ftdi->eeprom->buf, buf, size);
3584 Read eeprom location
3586 \param ftdi pointer to ftdi_context
3587 \param eeprom_addr Address of eeprom location to be read
3588 \param eeprom_val Pointer to store read eeprom location
3591 \retval -1: read failed
3592 \retval -2: USB device unavailable
3594 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
3596 if (ftdi == NULL || ftdi->usb_dev == NULL)
3597 ftdi_error_return(-2, "USB device unavailable");
3599 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)
3600 ftdi_error_return(-1, "reading eeprom failed");
3608 \param ftdi pointer to ftdi_context
3611 \retval -1: read failed
3612 \retval -2: USB device unavailable
3614 int ftdi_read_eeprom(struct ftdi_context *ftdi)
3619 if (ftdi == NULL || ftdi->usb_dev == NULL)
3620 ftdi_error_return(-2, "USB device unavailable");
3621 buf = ftdi->eeprom->buf;
3623 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
3625 if (libusb_control_transfer(
3626 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
3627 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
3628 ftdi_error_return(-1, "reading eeprom failed");
3631 if (ftdi->type == TYPE_R)
3632 ftdi->eeprom->size = 0x80;
3633 /* Guesses size of eeprom by comparing halves
3634 - will not work with blank eeprom */
3635 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
3636 ftdi->eeprom->size = -1;
3637 else if (memcmp(buf,&buf[0x80],0x80) == 0)
3638 ftdi->eeprom->size = 0x80;
3639 else if (memcmp(buf,&buf[0x40],0x40) == 0)
3640 ftdi->eeprom->size = 0x40;
3642 ftdi->eeprom->size = 0x100;
3647 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
3648 Function is only used internally
3651 static unsigned char ftdi_read_chipid_shift(unsigned char value)
3653 return ((value & 1) << 1) |
3654 ((value & 2) << 5) |
3655 ((value & 4) >> 2) |
3656 ((value & 8) << 4) |
3657 ((value & 16) >> 1) |
3658 ((value & 32) >> 1) |
3659 ((value & 64) >> 4) |
3660 ((value & 128) >> 2);
3664 Read the FTDIChip-ID from R-type devices
3666 \param ftdi pointer to ftdi_context
3667 \param chipid Pointer to store FTDIChip-ID
3670 \retval -1: read failed
3671 \retval -2: USB device unavailable
3673 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
3675 unsigned int a = 0, b = 0;
3677 if (ftdi == NULL || ftdi->usb_dev == NULL)
3678 ftdi_error_return(-2, "USB device unavailable");
3680 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)
3682 a = a << 8 | a >> 8;
3683 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)
3685 b = b << 8 | b >> 8;
3686 a = (a << 16) | (b & 0xFFFF);
3687 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
3688 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
3689 *chipid = a ^ 0xa5f0f7d1;
3694 ftdi_error_return(-1, "read of FTDIChip-ID failed");
3698 Write eeprom location
3700 \param ftdi pointer to ftdi_context
3701 \param eeprom_addr Address of eeprom location to be written
3702 \param eeprom_val Value to be written
3705 \retval -1: write failed
3706 \retval -2: USB device unavailable
3707 \retval -3: Invalid access to checksum protected area below 0x80
3708 \retval -4: Device can't access unprotected area
3709 \retval -5: Reading chip type failed
3711 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
3712 unsigned short eeprom_val)
3714 int chip_type_location;
3715 unsigned short chip_type;
3717 if (ftdi == NULL || ftdi->usb_dev == NULL)
3718 ftdi_error_return(-2, "USB device unavailable");
3720 if (eeprom_addr <0x80)
3721 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
3728 chip_type_location = 0x14;
3732 chip_type_location = 0x18;
3735 chip_type_location = 0x1e;
3738 ftdi_error_return(-4, "Device can't access unprotected area");
3741 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
3742 ftdi_error_return(-5, "Reading failed failed");
3743 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
3744 if ((chip_type & 0xff) != 0x66)
3746 ftdi_error_return(-6, "EEPROM is not of 93x66");
3749 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3750 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
3751 NULL, 0, ftdi->usb_write_timeout) != 0)
3752 ftdi_error_return(-1, "unable to write eeprom");
3760 \param ftdi pointer to ftdi_context
3763 \retval -1: read failed
3764 \retval -2: USB device unavailable
3765 \retval -3: EEPROM not initialized for the connected device;
3767 int ftdi_write_eeprom(struct ftdi_context *ftdi)
3769 unsigned short usb_val, status;
3771 unsigned char *eeprom;
3773 if (ftdi == NULL || ftdi->usb_dev == NULL)
3774 ftdi_error_return(-2, "USB device unavailable");
3776 if(ftdi->eeprom->initialized_for_connected_device == 0)
3777 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
3779 eeprom = ftdi->eeprom->buf;
3781 /* These commands were traced while running MProg */
3782 if ((ret = ftdi_usb_reset(ftdi)) != 0)
3784 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
3786 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
3789 for (i = 0; i < ftdi->eeprom->size/2; i++)
3791 usb_val = eeprom[i*2];
3792 usb_val += eeprom[(i*2)+1] << 8;
3793 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3794 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
3795 NULL, 0, ftdi->usb_write_timeout) < 0)
3796 ftdi_error_return(-1, "unable to write eeprom");
3805 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
3807 \param ftdi pointer to ftdi_context
3810 \retval -1: erase failed
3811 \retval -2: USB device unavailable
3812 \retval -3: Writing magic failed
3813 \retval -4: Read EEPROM failed
3814 \retval -5: Unexpected EEPROM value
3816 #define MAGIC 0x55aa
3817 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
3819 unsigned short eeprom_value;
3820 if (ftdi == NULL || ftdi->usb_dev == NULL)
3821 ftdi_error_return(-2, "USB device unavailable");
3823 if (ftdi->type == TYPE_R)
3825 ftdi->eeprom->chip = 0;
3829 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
3830 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
3831 ftdi_error_return(-1, "unable to erase eeprom");
3834 /* detect chip type by writing 0x55AA as magic at word position 0xc0
3835 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
3836 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
3837 Chip is 93x66 if magic is only read at word position 0xc0*/
3838 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
3839 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
3840 NULL, 0, ftdi->usb_write_timeout) != 0)
3841 ftdi_error_return(-3, "Writing magic failed");
3842 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
3843 ftdi_error_return(-4, "Reading failed failed");
3844 if (eeprom_value == MAGIC)
3846 ftdi->eeprom->chip = 0x46;
3850 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
3851 ftdi_error_return(-4, "Reading failed failed");
3852 if (eeprom_value == MAGIC)
3853 ftdi->eeprom->chip = 0x56;
3856 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
3857 ftdi_error_return(-4, "Reading failed failed");
3858 if (eeprom_value == MAGIC)
3859 ftdi->eeprom->chip = 0x66;
3862 ftdi->eeprom->chip = -1;
3866 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
3867 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
3868 ftdi_error_return(-1, "unable to erase eeprom");
3873 Get string representation for last error code
3875 \param ftdi pointer to ftdi_context
3877 \retval Pointer to error string
3879 char *ftdi_get_error_string (struct ftdi_context *ftdi)
3884 return ftdi->error_str;
3887 /* @} end of doxygen libftdi group */