#ifndef __libftdi_h__
#define __libftdi_h__
-#include <usb.h>
+#include <libusb.h>
#define FTDI_DEFAULT_EEPROM_SIZE 128
/** FTDI chip type */
-enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
+enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 };
/** Parity mode for ftdi_set_line_property() */
enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
/** Number of stop bits for ftdi_set_line_property() */
enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
/** MPSSE bitbang modes */
-enum ftdi_mpsse_mode {
- BITMODE_RESET = 0x00,
- BITMODE_BITBANG= 0x01,
- BITMODE_MPSSE = 0x02,
- BITMODE_SYNCBB = 0x04,
- BITMODE_MCU = 0x08,
- /* CPU-style fifo mode gets set via EEPROM */
- BITMODE_OPTO = 0x10,
- BITMODE_CBUS = 0x20
+enum ftdi_mpsse_mode
+{
+ BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
+ BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
+ BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
+ BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
+ BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
+ /* CPU-style fifo mode gets set via EEPROM */
+ BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
+ BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
+ BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
};
-/** Port interface for FT2232C */
-enum ftdi_interface {
+/** Port interface for chips with multiple interfaces */
+enum ftdi_interface
+{
INTERFACE_ANY = 0,
INTERFACE_A = 1,
- INTERFACE_B = 2
+ INTERFACE_B = 2,
+ INTERFACE_C = 3,
+ INTERFACE_D = 4
};
/* Shifting commands IN MPSSE Mode*/
#define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
/* Commands in MPSSE and Host Emulation Mode */
-#define SEND_IMMEDIATE 0x87
+#define SEND_IMMEDIATE 0x87
#define WAIT_ON_HIGH 0x88
#define WAIT_ON_LOW 0x89
#define SIO_SET_BAUD_RATE 3 /* Set baud rate */
#define SIO_SET_DATA 4 /* Set the data characteristics of the port */
-#define SIO_RESET_REQUEST_TYPE 0x40
-#define SIO_RESET_REQUEST SIO_RESET
+#define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
+#define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
+
+/* Requests */
+#define SIO_RESET_REQUEST SIO_RESET
+#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
+#define SIO_SET_DATA_REQUEST SIO_SET_DATA
+#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
+#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
+#define SIO_POLL_MODEM_STATUS_REQUEST 0x05
+#define SIO_SET_EVENT_CHAR_REQUEST 0x06
+#define SIO_SET_ERROR_CHAR_REQUEST 0x07
+#define SIO_SET_LATENCY_TIMER_REQUEST 0x09
+#define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
+#define SIO_SET_BITMODE_REQUEST 0x0B
+#define SIO_READ_PINS_REQUEST 0x0C
+#define SIO_READ_EEPROM_REQUEST 0x90
+#define SIO_WRITE_EEPROM_REQUEST 0x91
+#define SIO_ERASE_EEPROM_REQUEST 0x92
+
+
#define SIO_RESET_SIO 0
#define SIO_RESET_PURGE_RX 1
#define SIO_RESET_PURGE_TX 2
-#define SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
-#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
-
-#define SIO_SET_DATA_REQUEST_TYPE 0x40
-#define SIO_SET_DATA_REQUEST SIO_SET_DATA
-
-#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
-#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
-
-#define SIO_DISABLE_FLOW_CTRL 0x0
+#define SIO_DISABLE_FLOW_CTRL 0x0
#define SIO_RTS_CTS_HS (0x1 << 8)
#define SIO_DTR_DSR_HS (0x2 << 8)
#define SIO_XON_XOFF_HS (0x4 << 8)
-#define SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
-#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
-
#define SIO_SET_DTR_MASK 0x1
#define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
#define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
(taken from libusb) */
#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
+#ifdef __GNUC__
+ #define DEPRECATED(func) func __attribute__ ((deprecated))
+#elif defined(_MSC_VER)
+ #define DEPRECATED(func) __declspec(deprecated) func
+#else
+ #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
+ #define DEPRECATED(func) func
+#endif
+
+struct ftdi_transfer_control
+{
+ int completed;
+ unsigned char *buf;
+ int size;
+ int offset;
+ struct ftdi_context *ftdi;
+ struct libusb_transfer *transfer;
+};
+
/**
\brief Main context structure for all libftdi functions.
Do not access directly if possible.
*/
-struct ftdi_context {
+struct ftdi_context
+{
/* USB specific */
/** libusb's usb_dev_handle */
- struct usb_dev_handle *usb_dev;
+ struct libusb_device_handle *usb_dev;
/** usb read timeout */
int usb_read_timeout;
/** usb write timeout */
unsigned int readbuffer_chunksize;
/** write buffer chunk size */
unsigned int writebuffer_chunksize;
+ /** maximum packet size. Needed for filtering modem status bytes every n packets. */
+ unsigned int max_packet_size;
/* FTDI FT2232C requirecments */
/** FT2232C interface number: 0 or 1 */
/** String representation of last error */
char *error_str;
-
- /** Buffer needed for async communication */
- char *async_usb_buffer;
- /** Number of URB-structures we can buffer */
- unsigned int async_usb_buffer_size;
};
/**
\brief list of usb devices created by ftdi_usb_find_all()
*/
-struct ftdi_device_list {
+struct ftdi_device_list
+{
/** pointer to next entry */
struct ftdi_device_list *next;
/** pointer to libusb's usb_device */
- struct usb_device *dev;
+ struct libusb_device *dev;
};
/**
\brief FTDI eeprom structure
*/
-struct ftdi_eeprom {
+struct ftdi_eeprom
+{
/** vendor id */
int vendor_id;
/** product id */
/** self powered */
int self_powered;
- /** remote wakepu */
+ /** remote wakeup */
int remote_wakeup;
/** chip type */
int BM_type_chip;
/** serial number */
char *serial;
- /** eeprom size in bytes. This doesn't get stored in the eeprom
- but is the only way to pass it to ftdi_eeprom_build. */
- int size;
+ /** eeprom size in bytes. This doesn't get stored in the eeprom
+ but is the only way to pass it to ftdi_eeprom_build. */
+ int size;
+};
+
+/**
+ \brief Progress Info for streaming read
+*/
+struct size_and_time
+{
+ uint64_t totalBytes;
+ struct timeval time;
};
+typedef struct
+{
+ struct size_and_time first;
+ struct size_and_time prev;
+ struct size_and_time current;
+ double totalTime;
+ double totalRate;
+ double currentRate;
+} FTDIProgressInfo;
+
+typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
+ FTDIProgressInfo *progress, void *userdata);
+
+
#ifdef __cplusplus
-extern "C" {
+extern "C"
+{
#endif
int ftdi_init(struct ftdi_context *ftdi);
- struct ftdi_context *ftdi_new();
+ struct ftdi_context *ftdi_new(void);
int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
void ftdi_deinit(struct ftdi_context *ftdi);
void ftdi_free(struct ftdi_context *ftdi);
- void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
+ void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
int vendor, int product);
void ftdi_list_free(struct ftdi_device_list **devlist);
void ftdi_list_free2(struct ftdi_device_list *devlist);
- int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev,
+ int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
char * manufacturer, int mnf_len,
char * description, int desc_len,
char * serial, int serial_len);
int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
const char* description, const char* serial);
- int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
+ int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
+ const char* description, const char* serial, unsigned int index);
+ int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
+ int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
int ftdi_usb_close(struct ftdi_context *ftdi);
int ftdi_usb_reset(struct ftdi_context *ftdi);
int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
- enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
- enum ftdi_break_type break_type);
+ enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
+ enum ftdi_break_type break_type);
int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
+ int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
+ void *userdata, int packetsPerTransfer, int numTransfers);
int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
- int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
+ struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
+ int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
+
+ int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
int ftdi_disable_bitbang(struct ftdi_context *ftdi);
int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
/* init and build eeprom from ftdi_eeprom structure */
void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
- int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
+ int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
+ int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
/* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
the checksum of the eeprom is valided */
int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
int ftdi_erase_eeprom(struct ftdi_context *ftdi);
+ int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
+ int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
+
char *ftdi_get_error_string(struct ftdi_context *ftdi);
#ifdef __cplusplus