1 /***************************************************************************
5 copyright : (C) 2003-2010 by Intra2net AG
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);
70 Initializes a ftdi_context.
72 \param ftdi pointer to ftdi_context
75 \retval -1: couldn't allocate read buffer
77 \remark This should be called before all functions
79 int ftdi_init(struct ftdi_context *ftdi)
83 ftdi->usb_read_timeout = 5000;
84 ftdi->usb_write_timeout = 5000;
86 ftdi->type = TYPE_BM; /* chip type */
88 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
90 ftdi->readbuffer = NULL;
91 ftdi->readbuffer_offset = 0;
92 ftdi->readbuffer_remaining = 0;
93 ftdi->writebuffer_chunksize = 4096;
94 ftdi->max_packet_size = 0;
100 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
102 ftdi->error_str = NULL;
104 ftdi->eeprom_size = FTDI_DEFAULT_EEPROM_SIZE;
106 /* All fine. Now allocate the readbuffer */
107 return ftdi_read_data_set_chunksize(ftdi, 4096);
111 Allocate and initialize a new ftdi_context
113 \return a pointer to a new ftdi_context, or NULL on failure
115 struct ftdi_context *ftdi_new(void)
117 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
124 if (ftdi_init(ftdi) != 0)
134 Open selected channels on a chip, otherwise use first channel.
136 \param ftdi pointer to ftdi_context
137 \param interface Interface to use for FT2232C/2232H/4232H chips.
140 \retval -1: unknown interface
141 \retval -2: USB device unavailable
143 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
146 ftdi_error_return(-2, "USB device unavailable");
152 /* ftdi_usb_open_desc cares to set the right index, depending on the found chip */
156 ftdi->index = INTERFACE_B;
162 ftdi->index = INTERFACE_C;
168 ftdi->index = INTERFACE_D;
173 ftdi_error_return(-1, "Unknown interface");
179 Deinitializes a ftdi_context.
181 \param ftdi pointer to ftdi_context
183 void ftdi_deinit(struct ftdi_context *ftdi)
188 ftdi_usb_close_internal (ftdi);
190 if (ftdi->readbuffer != NULL)
192 free(ftdi->readbuffer);
193 ftdi->readbuffer = NULL;
195 libusb_exit(ftdi->usb_ctx);
199 Deinitialize and free an ftdi_context.
201 \param ftdi pointer to ftdi_context
203 void ftdi_free(struct ftdi_context *ftdi)
210 Use an already open libusb device.
212 \param ftdi pointer to ftdi_context
213 \param usb libusb libusb_device_handle to use
215 void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
225 Finds all ftdi devices on the usb bus. Creates a new ftdi_device_list which
226 needs to be deallocated by ftdi_list_free() after use.
228 \param ftdi pointer to ftdi_context
229 \param devlist Pointer where to store list of found devices
230 \param vendor Vendor ID to search for
231 \param product Product ID to search for
233 \retval >0: number of devices found
234 \retval -3: out of memory
235 \retval -4: libusb_init() failed
236 \retval -5: libusb_get_device_list() failed
237 \retval -6: libusb_get_device_descriptor() failed
239 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
241 struct ftdi_device_list **curdev;
243 libusb_device **devs;
247 if (libusb_init(&ftdi->usb_ctx) < 0)
248 ftdi_error_return(-4, "libusb_init() failed");
250 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
251 ftdi_error_return(-5, "libusb_get_device_list() failed");
256 while ((dev = devs[i++]) != NULL)
258 struct libusb_device_descriptor desc;
260 if (libusb_get_device_descriptor(dev, &desc) < 0)
261 ftdi_error_return(-6, "libusb_get_device_descriptor() failed");
263 if (desc.idVendor == vendor && desc.idProduct == product)
265 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
267 ftdi_error_return(-3, "out of memory");
269 (*curdev)->next = NULL;
270 (*curdev)->dev = dev;
272 curdev = &(*curdev)->next;
281 Frees a usb device list.
283 \param devlist USB device list created by ftdi_usb_find_all()
285 void ftdi_list_free(struct ftdi_device_list **devlist)
287 struct ftdi_device_list *curdev, *next;
289 for (curdev = *devlist; curdev != NULL;)
300 Frees a usb device list.
302 \param devlist USB device list created by ftdi_usb_find_all()
304 void ftdi_list_free2(struct ftdi_device_list *devlist)
306 ftdi_list_free(&devlist);
310 Return device ID strings from the usb device.
312 The parameters manufacturer, description and serial may be NULL
313 or pointer to buffers to store the fetched strings.
315 \note Use this function only in combination with ftdi_usb_find_all()
316 as it closes the internal "usb_dev" after use.
318 \param ftdi pointer to ftdi_context
319 \param dev libusb usb_dev to use
320 \param manufacturer Store manufacturer string here if not NULL
321 \param mnf_len Buffer size of manufacturer string
322 \param description Store product description string here if not NULL
323 \param desc_len Buffer size of product description string
324 \param serial Store serial string here if not NULL
325 \param serial_len Buffer size of serial string
328 \retval -1: wrong arguments
329 \retval -4: unable to open device
330 \retval -7: get product manufacturer failed
331 \retval -8: get product description failed
332 \retval -9: get serial number failed
333 \retval -11: libusb_get_device_descriptor() failed
335 int ftdi_usb_get_strings(struct ftdi_context * ftdi, struct libusb_device * dev,
336 char * manufacturer, int mnf_len, char * description, int desc_len, char * serial, int serial_len)
338 struct libusb_device_descriptor desc;
340 if ((ftdi==NULL) || (dev==NULL))
343 if (libusb_open(dev, &ftdi->usb_dev) < 0)
344 ftdi_error_return(-4, "libusb_open() failed");
346 if (libusb_get_device_descriptor(dev, &desc) < 0)
347 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
349 if (manufacturer != NULL)
351 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
353 ftdi_usb_close_internal (ftdi);
354 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
358 if (description != NULL)
360 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
362 ftdi_usb_close_internal (ftdi);
363 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
369 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
371 ftdi_usb_close_internal (ftdi);
372 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
376 ftdi_usb_close_internal (ftdi);
382 * Internal function to determine the maximum packet size.
383 * \param ftdi pointer to ftdi_context
384 * \param dev libusb usb_dev to use
385 * \retval Maximum packet size for this device
387 static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
389 struct libusb_device_descriptor desc;
390 struct libusb_config_descriptor *config0;
391 unsigned int packet_size;
394 if (ftdi == NULL || dev == NULL)
397 // Determine maximum packet size. Init with default value.
398 // New hi-speed devices from FTDI use a packet size of 512 bytes
399 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
400 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H)
405 if (libusb_get_device_descriptor(dev, &desc) < 0)
408 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
411 if (desc.bNumConfigurations > 0)
413 if (ftdi->interface < config0->bNumInterfaces)
415 struct libusb_interface interface = config0->interface[ftdi->interface];
416 if (interface.num_altsetting > 0)
418 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
419 if (descriptor.bNumEndpoints > 0)
421 packet_size = descriptor.endpoint[0].wMaxPacketSize;
427 libusb_free_config_descriptor (config0);
432 Opens a ftdi device given by an usb_device.
434 \param ftdi pointer to ftdi_context
435 \param dev libusb usb_dev to use
438 \retval -3: unable to config device
439 \retval -4: unable to open device
440 \retval -5: unable to claim device
441 \retval -6: reset failed
442 \retval -7: set baudrate failed
443 \retval -8: ftdi context invalid
444 \retval -9: libusb_get_device_descriptor() failed
445 \retval -10: libusb_get_config_descriptor() failed
446 \retval -11: libusb_etach_kernel_driver() failed
447 \retval -12: libusb_get_configuration() failed
449 int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
451 struct libusb_device_descriptor desc;
452 struct libusb_config_descriptor *config0;
453 int cfg, cfg0, detach_errno = 0;
456 ftdi_error_return(-8, "ftdi context invalid");
458 if (libusb_open(dev, &ftdi->usb_dev) < 0)
459 ftdi_error_return(-4, "libusb_open() failed");
461 if (libusb_get_device_descriptor(dev, &desc) < 0)
462 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
464 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
465 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
466 cfg0 = config0->bConfigurationValue;
467 libusb_free_config_descriptor (config0);
469 // Try to detach ftdi_sio kernel module.
471 // The return code is kept in a separate variable and only parsed
472 // if usb_set_configuration() or usb_claim_interface() fails as the
473 // detach operation might be denied and everything still works fine.
474 // Likely scenario is a static ftdi_sio kernel module.
475 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
476 detach_errno = errno;
478 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
479 ftdi_error_return(-12, "libusb_get_configuration () failed");
480 // set configuration (needed especially for windows)
481 // tolerate EBUSY: one device with one configuration, but two interfaces
482 // and libftdi sessions to both interfaces (e.g. FT2232)
483 if (desc.bNumConfigurations > 0 && cfg != cfg0)
485 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
487 ftdi_usb_close_internal (ftdi);
488 if(detach_errno == EPERM)
490 ftdi_error_return(-8, "inappropriate permissions on device!");
494 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
499 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
501 ftdi_usb_close_internal (ftdi);
502 if(detach_errno == EPERM)
504 ftdi_error_return(-8, "inappropriate permissions on device!");
508 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
512 if (ftdi_usb_reset (ftdi) != 0)
514 ftdi_usb_close_internal (ftdi);
515 ftdi_error_return(-6, "ftdi_usb_reset failed");
518 // Try to guess chip type
519 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
520 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
521 && desc.iSerialNumber == 0))
522 ftdi->type = TYPE_BM;
523 else if (desc.bcdDevice == 0x200)
524 ftdi->type = TYPE_AM;
525 else if (desc.bcdDevice == 0x500)
526 ftdi->type = TYPE_2232C;
527 else if (desc.bcdDevice == 0x600)
529 else if (desc.bcdDevice == 0x700)
530 ftdi->type = TYPE_2232H;
531 else if (desc.bcdDevice == 0x800)
532 ftdi->type = TYPE_4232H;
534 // Set default interface on dual/quad type chips
541 ftdi->index = INTERFACE_A;
547 // Determine maximum packet size
548 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
550 if (ftdi_set_baudrate (ftdi, 9600) != 0)
552 ftdi_usb_close_internal (ftdi);
553 ftdi_error_return(-7, "set baudrate failed");
556 ftdi_error_return(0, "all fine");
560 Opens the first device with a given vendor and product ids.
562 \param ftdi pointer to ftdi_context
563 \param vendor Vendor ID
564 \param product Product ID
566 \retval same as ftdi_usb_open_desc()
568 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
570 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
574 Opens the first device with a given, vendor id, product id,
575 description and serial.
577 \param ftdi pointer to ftdi_context
578 \param vendor Vendor ID
579 \param product Product ID
580 \param description Description to search for. Use NULL if not needed.
581 \param serial Serial to search for. Use NULL if not needed.
584 \retval -3: usb device not found
585 \retval -4: unable to open device
586 \retval -5: unable to claim device
587 \retval -6: reset failed
588 \retval -7: set baudrate failed
589 \retval -8: get product description failed
590 \retval -9: get serial number failed
591 \retval -11: libusb_init() failed
592 \retval -12: libusb_get_device_list() failed
593 \retval -13: libusb_get_device_descriptor() failed
595 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
596 const char* description, const char* serial)
598 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
602 Opens the index-th device with a given, vendor id, product id,
603 description and serial.
605 \param ftdi pointer to ftdi_context
606 \param vendor Vendor ID
607 \param product Product ID
608 \param description Description to search for. Use NULL if not needed.
609 \param serial Serial to search for. Use NULL if not needed.
610 \param index Number of matching device to open if there are more than one, starts with 0.
613 \retval -1: usb_find_busses() failed
614 \retval -2: usb_find_devices() failed
615 \retval -3: usb device not found
616 \retval -4: unable to open device
617 \retval -5: unable to claim device
618 \retval -6: reset failed
619 \retval -7: set baudrate failed
620 \retval -8: get product description failed
621 \retval -9: get serial number failed
622 \retval -10: unable to close device
623 \retval -11: ftdi context invalid
625 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
626 const char* description, const char* serial, unsigned int index)
629 libusb_device **devs;
633 if (libusb_init(&ftdi->usb_ctx) < 0)
634 ftdi_error_return(-11, "libusb_init() failed");
637 ftdi_error_return(-11, "ftdi context invalid");
639 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
640 ftdi_error_return(-12, "libusb_get_device_list() failed");
642 while ((dev = devs[i++]) != NULL)
644 struct libusb_device_descriptor desc;
647 if (libusb_get_device_descriptor(dev, &desc) < 0)
648 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
650 if (desc.idVendor == vendor && desc.idProduct == product)
652 if (libusb_open(dev, &ftdi->usb_dev) < 0)
653 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
655 if (description != NULL)
657 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
659 libusb_close (ftdi->usb_dev);
660 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
662 if (strncmp(string, description, sizeof(string)) != 0)
664 libusb_close (ftdi->usb_dev);
670 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
672 ftdi_usb_close_internal (ftdi);
673 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
675 if (strncmp(string, serial, sizeof(string)) != 0)
677 ftdi_usb_close_internal (ftdi);
682 ftdi_usb_close_internal (ftdi);
690 res = ftdi_usb_open_dev(ftdi, dev);
691 libusb_free_device_list(devs,1);
697 ftdi_error_return_free_device_list(-3, "device not found", devs);
701 Opens the ftdi-device described by a description-string.
702 Intended to be used for parsing a device-description given as commandline argument.
704 \param ftdi pointer to ftdi_context
705 \param description NULL-terminated description-string, using this format:
706 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
707 \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")
708 \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
709 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
711 \note The description format may be extended in later versions.
714 \retval -1: libusb_init() failed
715 \retval -2: libusb_get_device_list() failed
716 \retval -3: usb device not found
717 \retval -4: unable to open device
718 \retval -5: unable to claim device
719 \retval -6: reset failed
720 \retval -7: set baudrate failed
721 \retval -8: get product description failed
722 \retval -9: get serial number failed
723 \retval -10: unable to close device
724 \retval -11: illegal description format
725 \retval -12: ftdi context invalid
727 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
730 ftdi_error_return(-12, "ftdi context invalid");
732 if (description[0] == 0 || description[1] != ':')
733 ftdi_error_return(-11, "illegal description format");
735 if (description[0] == 'd')
738 libusb_device **devs;
739 unsigned int bus_number, device_address;
742 if (libusb_init (&ftdi->usb_ctx) < 0)
743 ftdi_error_return(-1, "libusb_init() failed");
745 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
746 ftdi_error_return(-2, "libusb_get_device_list() failed");
748 /* XXX: This doesn't handle symlinks/odd paths/etc... */
749 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
750 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
752 while ((dev = devs[i++]) != NULL)
755 if (bus_number == libusb_get_bus_number (dev)
756 && device_address == libusb_get_device_address (dev))
758 ret = ftdi_usb_open_dev(ftdi, dev);
759 libusb_free_device_list(devs,1);
765 ftdi_error_return_free_device_list(-3, "device not found", devs);
767 else if (description[0] == 'i' || description[0] == 's')
770 unsigned int product;
771 unsigned int index=0;
772 const char *serial=NULL;
773 const char *startp, *endp;
776 startp=description+2;
777 vendor=strtoul((char*)startp,(char**)&endp,0);
778 if (*endp != ':' || endp == startp || errno != 0)
779 ftdi_error_return(-11, "illegal description format");
782 product=strtoul((char*)startp,(char**)&endp,0);
783 if (endp == startp || errno != 0)
784 ftdi_error_return(-11, "illegal description format");
786 if (description[0] == 'i' && *endp != 0)
788 /* optional index field in i-mode */
790 ftdi_error_return(-11, "illegal description format");
793 index=strtoul((char*)startp,(char**)&endp,0);
794 if (*endp != 0 || endp == startp || errno != 0)
795 ftdi_error_return(-11, "illegal description format");
797 if (description[0] == 's')
800 ftdi_error_return(-11, "illegal description format");
802 /* rest of the description is the serial */
806 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
810 ftdi_error_return(-11, "illegal description format");
815 Resets the ftdi device.
817 \param ftdi pointer to ftdi_context
820 \retval -1: FTDI reset failed
821 \retval -2: USB device unavailable
823 int ftdi_usb_reset(struct ftdi_context *ftdi)
825 if (ftdi == NULL || ftdi->usb_dev == NULL)
826 ftdi_error_return(-2, "USB device unavailable");
828 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
829 SIO_RESET_REQUEST, SIO_RESET_SIO,
830 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
831 ftdi_error_return(-1,"FTDI reset failed");
833 // Invalidate data in the readbuffer
834 ftdi->readbuffer_offset = 0;
835 ftdi->readbuffer_remaining = 0;
841 Clears the read buffer on the chip and the internal read buffer.
843 \param ftdi pointer to ftdi_context
846 \retval -1: read buffer purge failed
847 \retval -2: USB device unavailable
849 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
851 if (ftdi == NULL || ftdi->usb_dev == NULL)
852 ftdi_error_return(-2, "USB device unavailable");
854 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
855 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
856 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
857 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
859 // Invalidate data in the readbuffer
860 ftdi->readbuffer_offset = 0;
861 ftdi->readbuffer_remaining = 0;
867 Clears the write buffer on the chip.
869 \param ftdi pointer to ftdi_context
872 \retval -1: write buffer purge failed
873 \retval -2: USB device unavailable
875 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
877 if (ftdi == NULL || ftdi->usb_dev == NULL)
878 ftdi_error_return(-2, "USB device unavailable");
880 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
881 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
882 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
883 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
889 Clears the buffers on the chip and the internal read buffer.
891 \param ftdi pointer to ftdi_context
894 \retval -1: read buffer purge failed
895 \retval -2: write buffer purge failed
896 \retval -3: USB device unavailable
898 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
902 if (ftdi == NULL || ftdi->usb_dev == NULL)
903 ftdi_error_return(-3, "USB device unavailable");
905 result = ftdi_usb_purge_rx_buffer(ftdi);
909 result = ftdi_usb_purge_tx_buffer(ftdi);
919 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
921 \param ftdi pointer to ftdi_context
924 \retval -1: usb_release failed
925 \retval -3: ftdi context invalid
927 int ftdi_usb_close(struct ftdi_context *ftdi)
932 ftdi_error_return(-3, "ftdi context invalid");
934 if (ftdi->usb_dev != NULL)
935 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
938 ftdi_usb_close_internal (ftdi);
944 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
945 Function is only used internally
948 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
949 unsigned short *value, unsigned short *index)
951 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
952 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
953 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
954 int divisor, best_divisor, best_baud, best_baud_diff;
955 unsigned long encoded_divisor;
964 divisor = 24000000 / baudrate;
966 if (ftdi->type == TYPE_AM)
968 // Round down to supported fraction (AM only)
969 divisor -= am_adjust_dn[divisor & 7];
972 // Try this divisor and the one above it (because division rounds down)
976 for (i = 0; i < 2; i++)
978 int try_divisor = divisor + i;
982 // Round up to supported divisor value
983 if (try_divisor <= 8)
985 // Round up to minimum supported divisor
988 else if (ftdi->type != TYPE_AM && try_divisor < 12)
990 // BM doesn't support divisors 9 through 11 inclusive
993 else if (divisor < 16)
995 // AM doesn't support divisors 9 through 15 inclusive
1000 if (ftdi->type == TYPE_AM)
1002 // Round up to supported fraction (AM only)
1003 try_divisor += am_adjust_up[try_divisor & 7];
1004 if (try_divisor > 0x1FFF8)
1006 // Round down to maximum supported divisor value (for AM)
1007 try_divisor = 0x1FFF8;
1012 if (try_divisor > 0x1FFFF)
1014 // Round down to maximum supported divisor value (for BM)
1015 try_divisor = 0x1FFFF;
1019 // Get estimated baud rate (to nearest integer)
1020 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1021 // Get absolute difference from requested baud rate
1022 if (baud_estimate < baudrate)
1024 baud_diff = baudrate - baud_estimate;
1028 baud_diff = baud_estimate - baudrate;
1030 if (i == 0 || baud_diff < best_baud_diff)
1032 // Closest to requested baud rate so far
1033 best_divisor = try_divisor;
1034 best_baud = baud_estimate;
1035 best_baud_diff = baud_diff;
1038 // Spot on! No point trying
1043 // Encode the best divisor value
1044 encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
1045 // Deal with special cases for encoded value
1046 if (encoded_divisor == 1)
1048 encoded_divisor = 0; // 3000000 baud
1050 else if (encoded_divisor == 0x4001)
1052 encoded_divisor = 1; // 2000000 baud (BM only)
1054 // Split into "value" and "index" values
1055 *value = (unsigned short)(encoded_divisor & 0xFFFF);
1056 if (ftdi->type == TYPE_2232C || ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H)
1058 *index = (unsigned short)(encoded_divisor >> 8);
1060 *index |= ftdi->index;
1063 *index = (unsigned short)(encoded_divisor >> 16);
1065 // Return the nearest baud rate
1070 Sets the chip baud rate
1072 \param ftdi pointer to ftdi_context
1073 \param baudrate baud rate to set
1076 \retval -1: invalid baudrate
1077 \retval -2: setting baudrate failed
1078 \retval -3: USB device unavailable
1080 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1082 unsigned short value, index;
1083 int actual_baudrate;
1085 if (ftdi == NULL || ftdi->usb_dev == NULL)
1086 ftdi_error_return(-3, "USB device unavailable");
1088 if (ftdi->bitbang_enabled)
1090 baudrate = baudrate*4;
1093 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
1094 if (actual_baudrate <= 0)
1095 ftdi_error_return (-1, "Silly baudrate <= 0.");
1097 // Check within tolerance (about 5%)
1098 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1099 || ((actual_baudrate < baudrate)
1100 ? (actual_baudrate * 21 < baudrate * 20)
1101 : (baudrate * 21 < actual_baudrate * 20)))
1102 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
1104 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1105 SIO_SET_BAUDRATE_REQUEST, value,
1106 index, NULL, 0, ftdi->usb_write_timeout) < 0)
1107 ftdi_error_return (-2, "Setting new baudrate failed");
1109 ftdi->baudrate = baudrate;
1114 Set (RS232) line characteristics.
1115 The break type can only be set via ftdi_set_line_property2()
1116 and defaults to "off".
1118 \param ftdi pointer to ftdi_context
1119 \param bits Number of bits
1120 \param sbit Number of stop bits
1121 \param parity Parity mode
1124 \retval -1: Setting line property failed
1126 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1127 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
1129 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1133 Set (RS232) line characteristics
1135 \param ftdi pointer to ftdi_context
1136 \param bits Number of bits
1137 \param sbit Number of stop bits
1138 \param parity Parity mode
1139 \param break_type Break type
1142 \retval -1: Setting line property failed
1143 \retval -2: USB device unavailable
1145 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
1146 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1147 enum ftdi_break_type break_type)
1149 unsigned short value = bits;
1151 if (ftdi == NULL || ftdi->usb_dev == NULL)
1152 ftdi_error_return(-2, "USB device unavailable");
1157 value |= (0x00 << 8);
1160 value |= (0x01 << 8);
1163 value |= (0x02 << 8);
1166 value |= (0x03 << 8);
1169 value |= (0x04 << 8);
1176 value |= (0x00 << 11);
1179 value |= (0x01 << 11);
1182 value |= (0x02 << 11);
1189 value |= (0x00 << 14);
1192 value |= (0x01 << 14);
1196 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1197 SIO_SET_DATA_REQUEST, value,
1198 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1199 ftdi_error_return (-1, "Setting new line property failed");
1205 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1207 \param ftdi pointer to ftdi_context
1208 \param buf Buffer with the data
1209 \param size Size of the buffer
1211 \retval -666: USB device unavailable
1212 \retval <0: error code from usb_bulk_write()
1213 \retval >0: number of bytes written
1215 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1220 if (ftdi == NULL || ftdi->usb_dev == NULL)
1221 ftdi_error_return(-666, "USB device unavailable");
1223 while (offset < size)
1225 int write_size = ftdi->writebuffer_chunksize;
1227 if (offset+write_size > size)
1228 write_size = size-offset;
1230 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
1231 ftdi_error_return(-1, "usb bulk write failed");
1233 offset += actual_length;
1239 static void ftdi_read_data_cb(struct libusb_transfer *transfer)
1241 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1242 struct ftdi_context *ftdi = tc->ftdi;
1243 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
1245 packet_size = ftdi->max_packet_size;
1247 actual_length = transfer->actual_length;
1249 if (actual_length > 2)
1251 // skip FTDI status bytes.
1252 // Maybe stored in the future to enable modem use
1253 num_of_chunks = actual_length / packet_size;
1254 chunk_remains = actual_length % packet_size;
1255 //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);
1257 ftdi->readbuffer_offset += 2;
1260 if (actual_length > packet_size - 2)
1262 for (i = 1; i < num_of_chunks; i++)
1263 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1264 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1266 if (chunk_remains > 2)
1268 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1269 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1271 actual_length -= 2*num_of_chunks;
1274 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1277 if (actual_length > 0)
1279 // data still fits in buf?
1280 if (tc->offset + actual_length <= tc->size)
1282 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1283 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1284 tc->offset += actual_length;
1286 ftdi->readbuffer_offset = 0;
1287 ftdi->readbuffer_remaining = 0;
1289 /* Did we read exactly the right amount of bytes? */
1290 if (tc->offset == tc->size)
1292 //printf("read_data exact rem %d offset %d\n",
1293 //ftdi->readbuffer_remaining, offset);
1300 // only copy part of the data or size <= readbuffer_chunksize
1301 int part_size = tc->size - tc->offset;
1302 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1303 tc->offset += part_size;
1305 ftdi->readbuffer_offset += part_size;
1306 ftdi->readbuffer_remaining = actual_length - part_size;
1308 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1309 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1315 ret = libusb_submit_transfer (transfer);
1321 static void ftdi_write_data_cb(struct libusb_transfer *transfer)
1323 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1324 struct ftdi_context *ftdi = tc->ftdi;
1326 tc->offset = transfer->actual_length;
1328 if (tc->offset == tc->size)
1334 int write_size = ftdi->writebuffer_chunksize;
1337 if (tc->offset + write_size > tc->size)
1338 write_size = tc->size - tc->offset;
1340 transfer->length = write_size;
1341 transfer->buffer = tc->buf + tc->offset;
1342 ret = libusb_submit_transfer (transfer);
1350 Writes data to the chip. Does not wait for completion of the transfer
1351 nor does it make sure that the transfer was successful.
1353 Use libusb 1.0 asynchronous API.
1355 \param ftdi pointer to ftdi_context
1356 \param buf Buffer with the data
1357 \param size Size of the buffer
1359 \retval NULL: Some error happens when submit transfer
1360 \retval !NULL: Pointer to a ftdi_transfer_control
1363 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1365 struct ftdi_transfer_control *tc;
1366 struct libusb_transfer *transfer = libusb_alloc_transfer(0);
1367 int write_size, ret;
1369 if (ftdi == NULL || ftdi->usb_dev == NULL)
1371 libusb_free_transfer(transfer);
1375 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1377 if (!tc || !transfer)
1386 if (size < ftdi->writebuffer_chunksize)
1389 write_size = ftdi->writebuffer_chunksize;
1391 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf, write_size, ftdi_write_data_cb, tc, ftdi->usb_write_timeout);
1392 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1394 ret = libusb_submit_transfer(transfer);
1397 libusb_free_transfer(transfer);
1399 tc->transfer = NULL;
1402 tc->transfer = transfer;
1408 Reads data from the chip. Does not wait for completion of the transfer
1409 nor does it make sure that the transfer was successful.
1411 Use libusb 1.0 asynchronous API.
1413 \param ftdi pointer to ftdi_context
1414 \param buf Buffer with the data
1415 \param size Size of the buffer
1417 \retval NULL: Some error happens when submit transfer
1418 \retval !NULL: Pointer to a ftdi_transfer_control
1421 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
1423 struct ftdi_transfer_control *tc;
1424 struct libusb_transfer *transfer;
1427 if (ftdi == NULL || ftdi->usb_dev == NULL)
1430 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1438 if (size <= ftdi->readbuffer_remaining)
1440 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1443 ftdi->readbuffer_remaining -= size;
1444 ftdi->readbuffer_offset += size;
1446 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1450 tc->transfer = NULL;
1455 if (ftdi->readbuffer_remaining != 0)
1457 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1459 tc->offset = ftdi->readbuffer_remaining;
1464 transfer = libusb_alloc_transfer(0);
1471 ftdi->readbuffer_remaining = 0;
1472 ftdi->readbuffer_offset = 0;
1474 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);
1475 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1477 ret = libusb_submit_transfer(transfer);
1480 libusb_free_transfer(transfer);
1484 tc->transfer = transfer;
1490 Wait for completion of the transfer.
1492 Use libusb 1.0 asynchronous API.
1494 \param tc pointer to ftdi_transfer_control
1496 \retval < 0: Some error happens
1497 \retval >= 0: Data size transferred
1500 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
1504 while (!tc->completed)
1506 ret = libusb_handle_events(tc->ftdi->usb_ctx);
1509 if (ret == LIBUSB_ERROR_INTERRUPTED)
1511 libusb_cancel_transfer(tc->transfer);
1512 while (!tc->completed)
1513 if (libusb_handle_events(tc->ftdi->usb_ctx) < 0)
1515 libusb_free_transfer(tc->transfer);
1522 if (tc->transfer->status == LIBUSB_TRANSFER_COMPLETED)
1527 libusb_free_transfer(tc->transfer);
1533 Configure write buffer chunk size.
1536 \param ftdi pointer to ftdi_context
1537 \param chunksize Chunk size
1540 \retval -1: ftdi context invalid
1542 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1545 ftdi_error_return(-1, "ftdi context invalid");
1547 ftdi->writebuffer_chunksize = chunksize;
1552 Get write buffer chunk size.
1554 \param ftdi pointer to ftdi_context
1555 \param chunksize Pointer to store chunk size in
1558 \retval -1: ftdi context invalid
1560 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1563 ftdi_error_return(-1, "ftdi context invalid");
1565 *chunksize = ftdi->writebuffer_chunksize;
1570 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1572 Automatically strips the two modem status bytes transfered during every read.
1574 \param ftdi pointer to ftdi_context
1575 \param buf Buffer to store data in
1576 \param size Size of the buffer
1578 \retval -666: USB device unavailable
1579 \retval <0: error code from libusb_bulk_transfer()
1580 \retval 0: no data was available
1581 \retval >0: number of bytes read
1584 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1586 int offset = 0, ret, i, num_of_chunks, chunk_remains;
1587 int packet_size = ftdi->max_packet_size;
1588 int actual_length = 1;
1590 if (ftdi == NULL || ftdi->usb_dev == NULL)
1591 ftdi_error_return(-666, "USB device unavailable");
1593 // Packet size sanity check (avoid division by zero)
1594 if (packet_size == 0)
1595 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
1597 // everything we want is still in the readbuffer?
1598 if (size <= ftdi->readbuffer_remaining)
1600 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1603 ftdi->readbuffer_remaining -= size;
1604 ftdi->readbuffer_offset += size;
1606 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
1610 // something still in the readbuffer, but not enough to satisfy 'size'?
1611 if (ftdi->readbuffer_remaining != 0)
1613 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
1616 offset += ftdi->readbuffer_remaining;
1618 // do the actual USB read
1619 while (offset < size && actual_length > 0)
1621 ftdi->readbuffer_remaining = 0;
1622 ftdi->readbuffer_offset = 0;
1623 /* returns how much received */
1624 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
1626 ftdi_error_return(ret, "usb bulk read failed");
1628 if (actual_length > 2)
1630 // skip FTDI status bytes.
1631 // Maybe stored in the future to enable modem use
1632 num_of_chunks = actual_length / packet_size;
1633 chunk_remains = actual_length % packet_size;
1634 //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);
1636 ftdi->readbuffer_offset += 2;
1639 if (actual_length > packet_size - 2)
1641 for (i = 1; i < num_of_chunks; i++)
1642 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1643 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1645 if (chunk_remains > 2)
1647 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1648 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1650 actual_length -= 2*num_of_chunks;
1653 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1656 else if (actual_length <= 2)
1658 // no more data to read?
1661 if (actual_length > 0)
1663 // data still fits in buf?
1664 if (offset+actual_length <= size)
1666 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
1667 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1668 offset += actual_length;
1670 /* Did we read exactly the right amount of bytes? */
1672 //printf("read_data exact rem %d offset %d\n",
1673 //ftdi->readbuffer_remaining, offset);
1678 // only copy part of the data or size <= readbuffer_chunksize
1679 int part_size = size-offset;
1680 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
1682 ftdi->readbuffer_offset += part_size;
1683 ftdi->readbuffer_remaining = actual_length-part_size;
1684 offset += part_size;
1686 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1687 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1698 Configure read buffer chunk size.
1701 Automatically reallocates the buffer.
1703 \param ftdi pointer to ftdi_context
1704 \param chunksize Chunk size
1707 \retval -1: ftdi context invalid
1709 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1711 unsigned char *new_buf;
1714 ftdi_error_return(-1, "ftdi context invalid");
1716 // Invalidate all remaining data
1717 ftdi->readbuffer_offset = 0;
1718 ftdi->readbuffer_remaining = 0;
1720 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
1721 which is defined in libusb-1.0. Otherwise, each USB read request will
1722 be divided into multiple URBs. This will cause issues on Linux kernel
1723 older than 2.6.32. */
1724 if (chunksize > 16384)
1728 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
1729 ftdi_error_return(-1, "out of memory for readbuffer");
1731 ftdi->readbuffer = new_buf;
1732 ftdi->readbuffer_chunksize = chunksize;
1738 Get read buffer chunk size.
1740 \param ftdi pointer to ftdi_context
1741 \param chunksize Pointer to store chunk size in
1744 \retval -1: FTDI context invalid
1746 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1749 ftdi_error_return(-1, "FTDI context invalid");
1751 *chunksize = ftdi->readbuffer_chunksize;
1757 Enable bitbang mode.
1759 \deprecated use \ref ftdi_set_bitmode with mode BITMODE_BITBANG instead
1761 \param ftdi pointer to ftdi_context
1762 \param bitmask Bitmask to configure lines.
1763 HIGH/ON value configures a line as output.
1766 \retval -1: can't enable bitbang mode
1767 \retval -2: USB device unavailable
1769 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
1771 unsigned short usb_val;
1773 if (ftdi == NULL || ftdi->usb_dev == NULL)
1774 ftdi_error_return(-2, "USB device unavailable");
1776 usb_val = bitmask; // low byte: bitmask
1777 /* FT2232C: Set bitbang_mode to 2 to enable SPI */
1778 usb_val |= (ftdi->bitbang_mode << 8);
1780 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1781 SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index,
1782 NULL, 0, ftdi->usb_write_timeout) < 0)
1783 ftdi_error_return(-1, "unable to enter bitbang mode. Perhaps not a BM type chip?");
1785 ftdi->bitbang_enabled = 1;
1790 Disable bitbang mode.
1792 \param ftdi pointer to ftdi_context
1795 \retval -1: can't disable bitbang mode
1796 \retval -2: USB device unavailable
1798 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
1800 if (ftdi == NULL || ftdi->usb_dev == NULL)
1801 ftdi_error_return(-2, "USB device unavailable");
1803 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)
1804 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
1806 ftdi->bitbang_enabled = 0;
1811 Enable/disable bitbang modes.
1813 \param ftdi pointer to ftdi_context
1814 \param bitmask Bitmask to configure lines.
1815 HIGH/ON value configures a line as output.
1816 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
1819 \retval -1: can't enable bitbang mode
1820 \retval -2: USB device unavailable
1822 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
1824 unsigned short usb_val;
1826 if (ftdi == NULL || ftdi->usb_dev == NULL)
1827 ftdi_error_return(-2, "USB device unavailable");
1829 usb_val = bitmask; // low byte: bitmask
1830 usb_val |= (mode << 8);
1831 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)
1832 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?");
1834 ftdi->bitbang_mode = mode;
1835 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
1840 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
1842 \param ftdi pointer to ftdi_context
1843 \param pins Pointer to store pins into
1846 \retval -1: read pins failed
1847 \retval -2: USB device unavailable
1849 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
1851 if (ftdi == NULL || ftdi->usb_dev == NULL)
1852 ftdi_error_return(-2, "USB device unavailable");
1854 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)
1855 ftdi_error_return(-1, "read pins failed");
1863 The FTDI chip keeps data in the internal buffer for a specific
1864 amount of time if the buffer is not full yet to decrease
1865 load on the usb bus.
1867 \param ftdi pointer to ftdi_context
1868 \param latency Value between 1 and 255
1871 \retval -1: latency out of range
1872 \retval -2: unable to set latency timer
1873 \retval -3: USB device unavailable
1875 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
1877 unsigned short usb_val;
1880 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
1882 if (ftdi == NULL || ftdi->usb_dev == NULL)
1883 ftdi_error_return(-3, "USB device unavailable");
1886 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)
1887 ftdi_error_return(-2, "unable to set latency timer");
1895 \param ftdi pointer to ftdi_context
1896 \param latency Pointer to store latency value in
1899 \retval -1: unable to get latency timer
1900 \retval -2: USB device unavailable
1902 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
1904 unsigned short usb_val;
1906 if (ftdi == NULL || ftdi->usb_dev == NULL)
1907 ftdi_error_return(-2, "USB device unavailable");
1909 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)
1910 ftdi_error_return(-1, "reading latency timer failed");
1912 *latency = (unsigned char)usb_val;
1917 Poll modem status information
1919 This function allows the retrieve the two status bytes of the device.
1920 The device sends these bytes also as a header for each read access
1921 where they are discarded by ftdi_read_data(). The chip generates
1922 the two stripped status bytes in the absence of data every 40 ms.
1924 Layout of the first byte:
1925 - B0..B3 - must be 0
1926 - B4 Clear to send (CTS)
1929 - B5 Data set ready (DTS)
1932 - B6 Ring indicator (RI)
1935 - B7 Receive line signal detect (RLSD)
1939 Layout of the second byte:
1940 - B0 Data ready (DR)
1941 - B1 Overrun error (OE)
1942 - B2 Parity error (PE)
1943 - B3 Framing error (FE)
1944 - B4 Break interrupt (BI)
1945 - B5 Transmitter holding register (THRE)
1946 - B6 Transmitter empty (TEMT)
1947 - B7 Error in RCVR FIFO
1949 \param ftdi pointer to ftdi_context
1950 \param status Pointer to store status information in. Must be two bytes.
1953 \retval -1: unable to retrieve status information
1954 \retval -2: USB device unavailable
1956 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
1960 if (ftdi == NULL || ftdi->usb_dev == NULL)
1961 ftdi_error_return(-2, "USB device unavailable");
1963 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)
1964 ftdi_error_return(-1, "getting modem status failed");
1966 *status = (usb_val[1] << 8) | usb_val[0];
1972 Set flowcontrol for ftdi chip
1974 \param ftdi pointer to ftdi_context
1975 \param flowctrl flow control to use. should be
1976 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS
1979 \retval -1: set flow control failed
1980 \retval -2: USB device unavailable
1982 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
1984 if (ftdi == NULL || ftdi->usb_dev == NULL)
1985 ftdi_error_return(-2, "USB device unavailable");
1987 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1988 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
1989 NULL, 0, ftdi->usb_write_timeout) < 0)
1990 ftdi_error_return(-1, "set flow control failed");
1998 \param ftdi pointer to ftdi_context
1999 \param state state to set line to (1 or 0)
2002 \retval -1: set dtr failed
2003 \retval -2: USB device unavailable
2005 int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2007 unsigned short usb_val;
2009 if (ftdi == NULL || ftdi->usb_dev == NULL)
2010 ftdi_error_return(-2, "USB device unavailable");
2013 usb_val = SIO_SET_DTR_HIGH;
2015 usb_val = SIO_SET_DTR_LOW;
2017 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2018 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2019 NULL, 0, ftdi->usb_write_timeout) < 0)
2020 ftdi_error_return(-1, "set dtr failed");
2028 \param ftdi pointer to ftdi_context
2029 \param state state to set line to (1 or 0)
2032 \retval -1: set rts failed
2033 \retval -2: USB device unavailable
2035 int ftdi_setrts(struct ftdi_context *ftdi, int state)
2037 unsigned short usb_val;
2039 if (ftdi == NULL || ftdi->usb_dev == NULL)
2040 ftdi_error_return(-2, "USB device unavailable");
2043 usb_val = SIO_SET_RTS_HIGH;
2045 usb_val = SIO_SET_RTS_LOW;
2047 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2048 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2049 NULL, 0, ftdi->usb_write_timeout) < 0)
2050 ftdi_error_return(-1, "set of rts failed");
2056 Set dtr and rts line in one pass
2058 \param ftdi pointer to ftdi_context
2059 \param dtr DTR state to set line to (1 or 0)
2060 \param rts RTS state to set line to (1 or 0)
2063 \retval -1: set dtr/rts failed
2064 \retval -2: USB device unavailable
2066 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2068 unsigned short usb_val;
2070 if (ftdi == NULL || ftdi->usb_dev == NULL)
2071 ftdi_error_return(-2, "USB device unavailable");
2074 usb_val = SIO_SET_DTR_HIGH;
2076 usb_val = SIO_SET_DTR_LOW;
2079 usb_val |= SIO_SET_RTS_HIGH;
2081 usb_val |= SIO_SET_RTS_LOW;
2083 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2084 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2085 NULL, 0, ftdi->usb_write_timeout) < 0)
2086 ftdi_error_return(-1, "set of rts/dtr failed");
2092 Set the special event character
2094 \param ftdi pointer to ftdi_context
2095 \param eventch Event character
2096 \param enable 0 to disable the event character, non-zero otherwise
2099 \retval -1: unable to set event character
2100 \retval -2: USB device unavailable
2102 int ftdi_set_event_char(struct ftdi_context *ftdi,
2103 unsigned char eventch, unsigned char enable)
2105 unsigned short usb_val;
2107 if (ftdi == NULL || ftdi->usb_dev == NULL)
2108 ftdi_error_return(-2, "USB device unavailable");
2114 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)
2115 ftdi_error_return(-1, "setting event character failed");
2123 \param ftdi pointer to ftdi_context
2124 \param errorch Error character
2125 \param enable 0 to disable the error character, non-zero otherwise
2128 \retval -1: unable to set error character
2129 \retval -2: USB device unavailable
2131 int ftdi_set_error_char(struct ftdi_context *ftdi,
2132 unsigned char errorch, unsigned char enable)
2134 unsigned short usb_val;
2136 if (ftdi == NULL || ftdi->usb_dev == NULL)
2137 ftdi_error_return(-2, "USB device unavailable");
2143 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)
2144 ftdi_error_return(-1, "setting error character failed");
2152 \param ftdi pointer to ftdi_context
2153 \param eeprom Pointer to ftdi_eeprom
2157 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size)
2162 ftdi->eeprom_size=size;
2167 Init eeprom with default values.
2169 \param eeprom Pointer to ftdi_eeprom
2171 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom)
2176 eeprom->vendor_id = 0x0403;
2177 eeprom->product_id = 0x6001;
2179 eeprom->self_powered = 1;
2180 eeprom->remote_wakeup = 1;
2181 eeprom->BM_type_chip = 1;
2183 eeprom->in_is_isochronous = 0;
2184 eeprom->out_is_isochronous = 0;
2185 eeprom->suspend_pull_downs = 0;
2187 eeprom->use_serial = 0;
2188 eeprom->change_usb_version = 0;
2189 eeprom->usb_version = 0x0200;
2190 eeprom->max_power = 0;
2192 eeprom->manufacturer = NULL;
2193 eeprom->product = NULL;
2194 eeprom->serial = NULL;
2196 eeprom->size = FTDI_DEFAULT_EEPROM_SIZE;
2200 Frees allocated memory in eeprom.
2202 \param eeprom Pointer to ftdi_eeprom
2204 void ftdi_eeprom_free(struct ftdi_eeprom *eeprom)
2206 if (eeprom->manufacturer != 0) {
2207 free(eeprom->manufacturer);
2208 eeprom->manufacturer = 0;
2210 if (eeprom->product != 0) {
2211 free(eeprom->product);
2212 eeprom->product = 0;
2214 if (eeprom->serial != 0) {
2215 free(eeprom->serial);
2221 Build binary output from ftdi_eeprom structure.
2222 Output is suitable for ftdi_write_eeprom().
2224 \param eeprom Pointer to ftdi_eeprom
2225 \param output Buffer of 128 bytes to store eeprom image to
2227 \retval >0: used eeprom size
2228 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2229 \retval -2: Invalid eeprom pointer
2231 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output)
2234 unsigned short checksum, value;
2235 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2241 if (eeprom->manufacturer != NULL)
2242 manufacturer_size = strlen(eeprom->manufacturer);
2243 if (eeprom->product != NULL)
2244 product_size = strlen(eeprom->product);
2245 if (eeprom->serial != NULL)
2246 serial_size = strlen(eeprom->serial);
2248 size_check = eeprom->size;
2249 size_check -= 28; // 28 are always in use (fixed)
2251 // Top half of a 256byte eeprom is used just for strings and checksum
2252 // it seems that the FTDI chip will not read these strings from the lower half
2253 // Each string starts with two bytes; offset and type (0x03 for string)
2254 // the checksum needs two bytes, so without the string data that 8 bytes from the top half
2255 if (eeprom->size>=256)size_check = 120;
2256 size_check -= manufacturer_size*2;
2257 size_check -= product_size*2;
2258 size_check -= serial_size*2;
2260 // eeprom size exceeded?
2265 memset (output, 0, eeprom->size);
2267 // Addr 00: Stay 00 00
2268 // Addr 02: Vendor ID
2269 output[0x02] = eeprom->vendor_id;
2270 output[0x03] = eeprom->vendor_id >> 8;
2272 // Addr 04: Product ID
2273 output[0x04] = eeprom->product_id;
2274 output[0x05] = eeprom->product_id >> 8;
2276 // Addr 06: Device release number (0400h for BM features)
2277 output[0x06] = 0x00;
2279 if (eeprom->BM_type_chip == 1)
2280 output[0x07] = 0x04;
2282 output[0x07] = 0x02;
2284 // Addr 08: Config descriptor
2286 // Bit 6: 1 if this device is self powered, 0 if bus powered
2287 // Bit 5: 1 if this device uses remote wakeup
2288 // Bit 4: 1 if this device is battery powered
2290 if (eeprom->self_powered == 1)
2292 if (eeprom->remote_wakeup == 1)
2296 // Addr 09: Max power consumption: max power = value * 2 mA
2297 output[0x09] = eeprom->max_power;
2299 // Addr 0A: Chip configuration
2300 // Bit 7: 0 - reserved
2301 // Bit 6: 0 - reserved
2302 // Bit 5: 0 - reserved
2303 // Bit 4: 1 - Change USB version
2304 // Bit 3: 1 - Use the serial number string
2305 // Bit 2: 1 - Enable suspend pull downs for lower power
2306 // Bit 1: 1 - Out EndPoint is Isochronous
2307 // Bit 0: 1 - In EndPoint is Isochronous
2310 if (eeprom->in_is_isochronous == 1)
2312 if (eeprom->out_is_isochronous == 1)
2314 if (eeprom->suspend_pull_downs == 1)
2316 if (eeprom->use_serial == 1)
2318 if (eeprom->change_usb_version == 1)
2322 // Addr 0B: reserved
2323 output[0x0B] = 0x00;
2325 // Addr 0C: USB version low byte when 0x0A bit 4 is set
2326 // Addr 0D: USB version high byte when 0x0A bit 4 is set
2327 if (eeprom->change_usb_version == 1)
2329 output[0x0C] = eeprom->usb_version;
2330 output[0x0D] = eeprom->usb_version >> 8;
2334 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2335 // Addr 0F: Length of manufacturer string
2336 output[0x0F] = manufacturer_size*2 + 2;
2338 // Addr 10: Offset of the product string + 0x80, calculated later
2339 // Addr 11: Length of product string
2340 output[0x11] = product_size*2 + 2;
2342 // Addr 12: Offset of the serial string + 0x80, calculated later
2343 // Addr 13: Length of serial string
2344 output[0x13] = serial_size*2 + 2;
2348 if (eeprom->size>=256) i = 0x80;
2351 // Output manufacturer
2352 output[0x0E] = i | 0x80; // calculate offset
2353 output[i++] = manufacturer_size*2 + 2;
2354 output[i++] = 0x03; // type: string
2355 for (j = 0; j < manufacturer_size; j++)
2357 output[i] = eeprom->manufacturer[j], i++;
2358 output[i] = 0x00, i++;
2361 // Output product name
2362 output[0x10] = i | 0x80; // calculate offset
2363 output[i] = product_size*2 + 2, i++;
2364 output[i] = 0x03, i++;
2365 for (j = 0; j < product_size; j++)
2367 output[i] = eeprom->product[j], i++;
2368 output[i] = 0x00, i++;
2372 output[0x12] = i | 0x80; // calculate offset
2373 output[i] = serial_size*2 + 2, i++;
2374 output[i] = 0x03, i++;
2375 for (j = 0; j < serial_size; j++)
2377 output[i] = eeprom->serial[j], i++;
2378 output[i] = 0x00, i++;
2381 // calculate checksum
2384 for (i = 0; i < eeprom->size/2-1; i++)
2386 value = output[i*2];
2387 value += output[(i*2)+1] << 8;
2389 checksum = value^checksum;
2390 checksum = (checksum << 1) | (checksum >> 15);
2393 output[eeprom->size-2] = checksum;
2394 output[eeprom->size-1] = checksum >> 8;
2400 Decode binary EEPROM image into an ftdi_eeprom structure.
2402 \param eeprom Pointer to ftdi_eeprom which will be filled in.
2403 \param buf Buffer of \a size bytes of raw eeprom data
2404 \param size size size of eeprom data in bytes
2407 \retval -1: something went wrong
2409 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
2410 FIXME: Strings are malloc'ed here and should be freed somewhere
2412 int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *buf, int size)
2415 unsigned short checksum, eeprom_checksum, value;
2416 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
2417 int eeprom_size = 128;
2422 size_check = eeprom->size;
2423 size_check -= 28; // 28 are always in use (fixed)
2425 // Top half of a 256byte eeprom is used just for strings and checksum
2426 // it seems that the FTDI chip will not read these strings from the lower half
2427 // Each string starts with two bytes; offset and type (0x03 for string)
2428 // the checksum needs two bytes, so without the string data that 8 bytes from the top half
2429 if (eeprom->size>=256)size_check = 120;
2430 size_check -= manufacturer_size*2;
2431 size_check -= product_size*2;
2432 size_check -= serial_size*2;
2434 // eeprom size exceeded?
2439 // empty eeprom struct
2440 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
2442 // Addr 00: Stay 00 00
2444 // Addr 02: Vendor ID
2445 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
2447 // Addr 04: Product ID
2448 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
2450 value = buf[0x06] + (buf[0x07]<<8);
2454 eeprom->BM_type_chip = 1;
2457 eeprom->BM_type_chip = 0;
2459 default: // Unknown device
2460 eeprom->BM_type_chip = 0;
2464 // Addr 08: Config descriptor
2466 // Bit 6: 1 if this device is self powered, 0 if bus powered
2467 // Bit 5: 1 if this device uses remote wakeup
2468 // Bit 4: 1 if this device is battery powered
2470 if (j&0x40) eeprom->self_powered = 1;
2471 if (j&0x20) eeprom->remote_wakeup = 1;
2473 // Addr 09: Max power consumption: max power = value * 2 mA
2474 eeprom->max_power = buf[0x09];
2476 // Addr 0A: Chip configuration
2477 // Bit 7: 0 - reserved
2478 // Bit 6: 0 - reserved
2479 // Bit 5: 0 - reserved
2480 // Bit 4: 1 - Change USB version
2481 // Bit 3: 1 - Use the serial number string
2482 // Bit 2: 1 - Enable suspend pull downs for lower power
2483 // Bit 1: 1 - Out EndPoint is Isochronous
2484 // Bit 0: 1 - In EndPoint is Isochronous
2487 if (j&0x01) eeprom->in_is_isochronous = 1;
2488 if (j&0x02) eeprom->out_is_isochronous = 1;
2489 if (j&0x04) eeprom->suspend_pull_downs = 1;
2490 if (j&0x08) eeprom->use_serial = 1;
2491 if (j&0x10) eeprom->change_usb_version = 1;
2493 // Addr 0B: reserved
2495 // Addr 0C: USB version low byte when 0x0A bit 4 is set
2496 // Addr 0D: USB version high byte when 0x0A bit 4 is set
2497 if (eeprom->change_usb_version == 1)
2499 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
2502 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2503 // Addr 0F: Length of manufacturer string
2504 manufacturer_size = buf[0x0F]/2;
2505 if (manufacturer_size > 0) eeprom->manufacturer = malloc(manufacturer_size);
2506 else eeprom->manufacturer = NULL;
2508 // Addr 10: Offset of the product string + 0x80, calculated later
2509 // Addr 11: Length of product string
2510 product_size = buf[0x11]/2;
2511 if (product_size > 0) eeprom->product = malloc(product_size);
2512 else eeprom->product = NULL;
2514 // Addr 12: Offset of the serial string + 0x80, calculated later
2515 // Addr 13: Length of serial string
2516 serial_size = buf[0x13]/2;
2517 if (serial_size > 0) eeprom->serial = malloc(serial_size);
2518 else eeprom->serial = NULL;
2520 // Decode manufacturer
2521 i = buf[0x0E] & 0x7f; // offset
2522 for (j=0;j<manufacturer_size-1;j++)
2524 eeprom->manufacturer[j] = buf[2*j+i+2];
2526 eeprom->manufacturer[j] = '\0';
2528 // Decode product name
2529 i = buf[0x10] & 0x7f; // offset
2530 for (j=0;j<product_size-1;j++)
2532 eeprom->product[j] = buf[2*j+i+2];
2534 eeprom->product[j] = '\0';
2537 i = buf[0x12] & 0x7f; // offset
2538 for (j=0;j<serial_size-1;j++)
2540 eeprom->serial[j] = buf[2*j+i+2];
2542 eeprom->serial[j] = '\0';
2547 for (i = 0; i < eeprom_size/2-1; i++)
2550 value += buf[(i*2)+1] << 8;
2552 checksum = value^checksum;
2553 checksum = (checksum << 1) | (checksum >> 15);
2556 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
2558 if (eeprom_checksum != checksum)
2560 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
2568 Read eeprom location
2570 \param ftdi pointer to ftdi_context
2571 \param eeprom_addr Address of eeprom location to be read
2572 \param eeprom_val Pointer to store read eeprom location
2575 \retval -1: read failed
2576 \retval -2: USB device unavailable
2578 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
2580 if (ftdi == NULL || ftdi->usb_dev == NULL)
2581 ftdi_error_return(-2, "USB device unavailable");
2583 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, (char *)eeprom_val, 2, ftdi->usb_read_timeout) != 2)
2584 ftdi_error_return(-1, "reading eeprom failed");
2592 \param ftdi pointer to ftdi_context
2593 \param eeprom Pointer to store eeprom into
2596 \retval -1: read failed
2597 \retval -2: USB device unavailable
2599 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
2603 if (ftdi == NULL || ftdi->usb_dev == NULL)
2604 ftdi_error_return(-2, "USB device unavailable");
2606 for (i = 0; i < ftdi->eeprom_size/2; i++)
2608 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, i, eeprom+(i*2), 2, ftdi->usb_read_timeout) != 2)
2609 ftdi_error_return(-1, "reading eeprom failed");
2616 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
2617 Function is only used internally
2620 static unsigned char ftdi_read_chipid_shift(unsigned char value)
2622 return ((value & 1) << 1) |
2623 ((value & 2) << 5) |
2624 ((value & 4) >> 2) |
2625 ((value & 8) << 4) |
2626 ((value & 16) >> 1) |
2627 ((value & 32) >> 1) |
2628 ((value & 64) >> 4) |
2629 ((value & 128) >> 2);
2633 Read the FTDIChip-ID from R-type devices
2635 \param ftdi pointer to ftdi_context
2636 \param chipid Pointer to store FTDIChip-ID
2639 \retval -1: read failed
2640 \retval -2: USB device unavailable
2642 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
2644 unsigned int a = 0, b = 0;
2646 if (ftdi == NULL || ftdi->usb_dev == NULL)
2647 ftdi_error_return(-2, "USB device unavailable");
2649 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)
2651 a = a << 8 | a >> 8;
2652 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)
2654 b = b << 8 | b >> 8;
2655 a = (a << 16) | (b & 0xFFFF);
2656 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
2657 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
2658 *chipid = a ^ 0xa5f0f7d1;
2663 ftdi_error_return(-1, "read of FTDIChip-ID failed");
2667 Guesses size of eeprom by reading eeprom and comparing halves - will not work with blank eeprom
2668 Call this function then do a write then call again to see if size changes, if so write again.
2670 \param ftdi pointer to ftdi_context
2671 \param eeprom Pointer to store eeprom into
2672 \param maxsize the size of the buffer to read into
2674 \retval -1: eeprom read failed
2675 \retval -2: USB device unavailable
2676 \retval >=0: size of eeprom
2678 int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize)
2680 int i=0,j,minsize=32;
2683 if (ftdi == NULL || ftdi->usb_dev == NULL)
2684 ftdi_error_return(-2, "USB device unavailable");
2688 for (j = 0; i < maxsize/2 && j<size; j++)
2690 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,
2691 SIO_READ_EEPROM_REQUEST, 0, i,
2692 eeprom+(i*2), 2, ftdi->usb_read_timeout) != 2)
2693 ftdi_error_return(-1, "eeprom read failed");
2698 while (size<=maxsize && memcmp(eeprom,&eeprom[size/2],size/2)!=0);
2704 Write eeprom location
2706 \param ftdi pointer to ftdi_context
2707 \param eeprom_addr Address of eeprom location to be written
2708 \param eeprom_val Value to be written
2711 \retval -1: read failed
2712 \retval -2: USB device unavailable
2714 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val)
2716 if (ftdi == NULL || ftdi->usb_dev == NULL)
2717 ftdi_error_return(-2, "USB device unavailable");
2719 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2720 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
2721 NULL, 0, ftdi->usb_write_timeout) != 0)
2722 ftdi_error_return(-1, "unable to write eeprom");
2730 \param ftdi pointer to ftdi_context
2731 \param eeprom Pointer to read eeprom from
2734 \retval -1: read failed
2735 \retval -2: USB device unavailable
2737 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
2739 unsigned short usb_val, status;
2742 if (ftdi == NULL || ftdi->usb_dev == NULL)
2743 ftdi_error_return(-2, "USB device unavailable");
2745 /* These commands were traced while running MProg */
2746 if ((ret = ftdi_usb_reset(ftdi)) != 0)
2748 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
2750 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
2753 for (i = 0; i < ftdi->eeprom_size/2; i++)
2755 usb_val = eeprom[i*2];
2756 usb_val += eeprom[(i*2)+1] << 8;
2757 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2758 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
2759 NULL, 0, ftdi->usb_write_timeout) < 0)
2760 ftdi_error_return(-1, "unable to write eeprom");
2769 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
2771 \param ftdi pointer to ftdi_context
2774 \retval -1: erase failed
2775 \retval -2: USB device unavailable
2777 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
2779 if (ftdi == NULL || ftdi->usb_dev == NULL)
2780 ftdi_error_return(-2, "USB device unavailable");
2782 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST, 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
2783 ftdi_error_return(-1, "unable to erase eeprom");
2789 Get string representation for last error code
2791 \param ftdi pointer to ftdi_context
2793 \retval Pointer to error string
2795 char *ftdi_get_error_string (struct ftdi_context *ftdi)
2800 return ftdi->error_str;
2803 /* @} end of doxygen libftdi group */