ftdi.h
Go to the documentation of this file.
/***************************************************************************
ftdi.h - description
-------------------
begin : Fri Apr 4 2003
copyright : (C) 2003-2014 by Intra2net AG and the libftdi developers
email : opensource@intra2net.com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License *
* version 2.1 as published by the Free Software Foundation; *
* *
***************************************************************************/
#ifndef __libftdi_h__
#define __libftdi_h__
#include <stdint.h>
#include <sys/time.h>
/* 'interface' might be defined as a macro on Windows, so we need to
* undefine it so as not to break the current libftdi API, because
* struct ftdi_context has an 'interface' member
* As this can be problematic if you include windows.h after ftdi.h
* in your sources, we force windows.h to be included first. */
#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
#include <windows.h>
#if defined(interface)
#undef interface
#endif
#endif
enum ftdi_chip_type
{
TYPE_AM=0,
TYPE_BM=1,
TYPE_2232C=2,
TYPE_R=3,
TYPE_2232H=4,
TYPE_4232H=5,
TYPE_232H=6,
TYPE_230X=7,
};
enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
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,
BITMODE_SYNCFF = 0x40,
BITMODE_FT1284 = 0x80,
};
enum ftdi_interface
{
INTERFACE_ANY = 0,
INTERFACE_A = 1,
INTERFACE_B = 2,
INTERFACE_C = 3,
INTERFACE_D = 4
};
enum ftdi_module_detach_mode
{
AUTO_DETACH_SIO_MODULE = 0,
DONT_DETACH_SIO_MODULE = 1
};
/* Shifting commands IN MPSSE Mode*/
#define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
#define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
#define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
#define MPSSE_LSB 0x08 /* LSB first */
#define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
#define MPSSE_DO_READ 0x20 /* Read TDO/DI */
#define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
/* FTDI MPSSE commands */
#define SET_BITS_LOW 0x80
/*BYTE DATA*/
/*BYTE Direction*/
#define SET_BITS_HIGH 0x82
/*BYTE DATA*/
/*BYTE Direction*/
#define GET_BITS_LOW 0x81
#define GET_BITS_HIGH 0x83
#define LOOPBACK_START 0x84
#define LOOPBACK_END 0x85
#define TCK_DIVISOR 0x86
/* H Type specific commands */
#define DIS_DIV_5 0x8a
#define EN_DIV_5 0x8b
#define EN_3_PHASE 0x8c
#define DIS_3_PHASE 0x8d
#define CLK_BITS 0x8e
#define CLK_BYTES 0x8f
#define CLK_WAIT_HIGH 0x94
#define CLK_WAIT_LOW 0x95
#define EN_ADAPTIVE 0x96
#define DIS_ADAPTIVE 0x97
#define CLK_BYTES_OR_HIGH 0x9c
#define CLK_BYTES_OR_LOW 0x9d
/*FT232H specific commands */
#define DRIVE_OPEN_COLLECTOR 0x9e
/* Value Low */
/* Value HIGH */ /*rate is 12000000/((1+value)*2) */
#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 WAIT_ON_HIGH 0x88
#define WAIT_ON_LOW 0x89
/* Commands in Host Emulation Mode */
#define READ_SHORT 0x90
/* Address_Low */
#define READ_EXTENDED 0x91
/* Address High */
/* Address Low */
#define WRITE_SHORT 0x92
/* Address_Low */
#define WRITE_EXTENDED 0x93
/* Address High */
/* Address Low */
/* Definitions for flow control */
#define SIO_RESET 0 /* Reset the port */
#define SIO_MODEM_CTRL 1 /* Set the modem control register */
#define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
#define SIO_SET_BAUD_RATE 3 /* Set baud rate */
#define SIO_SET_DATA 4 /* Set the data characteristics of the port */
#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_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_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))
#define SIO_SET_RTS_MASK 0x2
#define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
#define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
#define SIO_RTS_CTS_HS (0x1 << 8)
/* marker for unused usb urb structures
(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;
};
struct ftdi_context
{
/* USB specific */
struct libusb_context *usb_ctx;
struct libusb_device_handle *usb_dev;
int usb_read_timeout;
int usb_write_timeout;
/* FTDI specific */
enum ftdi_chip_type type;
int baudrate;
unsigned char bitbang_enabled;
unsigned char *readbuffer;
unsigned int readbuffer_offset;
unsigned int readbuffer_remaining;
unsigned int readbuffer_chunksize;
unsigned int writebuffer_chunksize;
unsigned int max_packet_size;
/* FTDI FT2232C requirecments */
int interface; /* 0 or 1 */
int index; /* 1 or 2 */
/* Endpoints */
int in_ep;
int out_ep; /* 1 or 2 */
unsigned char bitbang_mode;
struct ftdi_eeprom *eeprom;
char *error_str;
enum ftdi_module_detach_mode module_detach_mode;
};
enum ftdi_eeprom_value
{
VENDOR_ID = 0,
PRODUCT_ID = 1,
SELF_POWERED = 2,
REMOTE_WAKEUP = 3,
IS_NOT_PNP = 4,
SUSPEND_DBUS7 = 5,
IN_IS_ISOCHRONOUS = 6,
OUT_IS_ISOCHRONOUS = 7,
SUSPEND_PULL_DOWNS = 8,
USE_SERIAL = 9,
USB_VERSION = 10,
USE_USB_VERSION = 11,
MAX_POWER = 12,
CHANNEL_A_TYPE = 13,
CHANNEL_B_TYPE = 14,
CHANNEL_A_DRIVER = 15,
CHANNEL_B_DRIVER = 16,
CBUS_FUNCTION_0 = 17,
CBUS_FUNCTION_1 = 18,
CBUS_FUNCTION_2 = 19,
CBUS_FUNCTION_3 = 20,
CBUS_FUNCTION_4 = 21,
CBUS_FUNCTION_5 = 22,
CBUS_FUNCTION_6 = 23,
CBUS_FUNCTION_7 = 24,
CBUS_FUNCTION_8 = 25,
CBUS_FUNCTION_9 = 26,
HIGH_CURRENT = 27,
HIGH_CURRENT_A = 28,
HIGH_CURRENT_B = 29,
INVERT = 30,
GROUP0_DRIVE = 31,
GROUP0_SCHMITT = 32,
GROUP0_SLEW = 33,
GROUP1_DRIVE = 34,
GROUP1_SCHMITT = 35,
GROUP1_SLEW = 36,
GROUP2_DRIVE = 37,
GROUP2_SCHMITT = 38,
GROUP2_SLEW = 39,
GROUP3_DRIVE = 40,
GROUP3_SCHMITT = 41,
GROUP3_SLEW = 42,
CHIP_SIZE = 43,
CHIP_TYPE = 44,
POWER_SAVE = 45,
CLOCK_POLARITY = 46,
DATA_ORDER = 47,
FLOW_CONTROL = 48,
CHANNEL_C_DRIVER = 49,
CHANNEL_D_DRIVER = 50,
CHANNEL_A_RS485 = 51,
CHANNEL_B_RS485 = 52,
CHANNEL_C_RS485 = 53,
CHANNEL_D_RS485 = 54,
RELEASE_NUMBER = 55,
};
struct ftdi_device_list
{
struct ftdi_device_list *next;
struct libusb_device *dev;
};
#define FT1284_CLK_IDLE_STATE 0x01
#define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
#define FT1284_FLOW_CONTROL 0x04
#define POWER_SAVE_DISABLE_H 0x80
#define USE_SERIAL_NUM 0x08
enum ftdi_cbus_func /* FIXME: Recheck value, especially the last */
{
CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd
};
enum ftdi_cbush_func /* FIXME: Recheck value, especially the last */
{
CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4,
CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9,
CBUSH_CLK30 = 10, CBUSH_CLK15 = 11, CBUSH_CLK7_5 = 12, CBUSH_BAT_DETECT = 13,
CBUSH_BAT_DETECT_NEG = 14, CBUSH_I2C_TXE = 15, CBUSH_I2C_RXF = 16, CBUSH_VBUS_SENSE = 17,
CBUSH_BB_WR = 18, CBUSH_BB_RD = 19, CBUSH_TIME_STAMP = 20, CBUSH_AWAKE = 21,
};
#define INVERT_TXD 0x01
#define INVERT_RXD 0x02
#define INVERT_RTS 0x04
#define INVERT_CTS 0x08
#define INVERT_DTR 0x10
#define INVERT_DSR 0x20
#define INVERT_DCD 0x40
#define INVERT_RI 0x80
#define CHANNEL_IS_UART 0x0
#define CHANNEL_IS_FIFO 0x1
#define CHANNEL_IS_OPTO 0x2
#define CHANNEL_IS_CPU 0x4
#define CHANNEL_IS_FT1284 0x8
#define CHANNEL_IS_RS485 0x10
#define DRIVE_4MA 0
#define DRIVE_8MA 1
#define DRIVE_12MA 2
#define DRIVE_16MA 3
#define SLOW_SLEW 4
#define IS_SCHMITT 8
#define DRIVER_VCP 0x08
#define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
#define USE_USB_VERSION_BIT 0x10
#define SUSPEND_DBUS7_BIT 0x80
#define HIGH_CURRENT_DRIVE 0x10
#define HIGH_CURRENT_DRIVE_R 0x04
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);
struct ftdi_version_info
{
int major;
int minor;
int micro;
const char *version_str;
const char *snapshot_str;
};
#ifdef __cplusplus
extern "C"
{
#endif
int ftdi_init(struct ftdi_context *ftdi);
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, struct libusb_device_handle *usbdev);
struct ftdi_version_info ftdi_get_library_version(void);
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 libusb_device *dev,
char * manufacturer, int mnf_len,
char * description, int desc_len,
char * serial, int serial_len);
int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer,
char * product, char * serial);
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_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_usb_purge_rx_buffer(struct ftdi_context *ftdi);
int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
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);
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_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size);
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);
struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
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 ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
int ftdi_disable_bitbang(struct ftdi_context *ftdi);
int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
/* flow control */
int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
int ftdi_setdtr(struct ftdi_context *ftdi, int state);
int ftdi_setrts(struct ftdi_context *ftdi, int state);
int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
/* init eeprom for the given FTDI type */
int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
char * manufacturer, char *product,
char * serial);
int ftdi_eeprom_build(struct ftdi_context *ftdi);
int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
int ftdi_read_eeprom(struct ftdi_context *ftdi);
int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
int ftdi_write_eeprom(struct ftdi_context *ftdi);
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
}
#endif
#endif /* __libftdi_h__ */
ftdi_write_data_submit
struct ftdi_transfer_control * ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1521
ftdi_read_pins
int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
Definition: ftdi.c:1982
IN_IS_ISOCHRONOUS
Definition: ftdi.h:285
ftdi_usb_open
int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
Definition: ftdi.c:636
ftdi_transfer_control::completed
int completed
Definition: ftdi.h:206
ftdi_context::module_detach_mode
enum ftdi_module_detach_mode module_detach_mode
Definition: ftdi.h:271
ftdi_chip_type
ftdi_chip_type
Definition: ftdi.h:36
CBUS_FUNCTION_9
Definition: ftdi.h:305
NONE
Definition: ftdi.h:48
CHANNEL_B_TYPE
Definition: ftdi.h:293
POWER_SAVE
Definition: ftdi.h:324
ftdi_device_list
list of usb devices created by ftdi_usb_find_all()
Definition: ftdi.h:340
REMOTE_WAKEUP
Definition: ftdi.h:282
STOP_BIT_1
Definition: ftdi.h:50
ftdi_device_list::next
struct ftdi_device_list * next
Definition: ftdi.h:343
BITMODE_SYNCBB
Definition: ftdi.h:62
CBUS_FUNCTION_6
Definition: ftdi.h:302
ftdi_version_info::minor
int minor
Definition: ftdi.h:447
ftdi_eeprom_set_strings
int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char *manufacturer, char *product, char *serial)
Definition: ftdi.c:2442
ftdi_read_data_get_chunksize
int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
Definition: ftdi.c:1912
DATA_ORDER
Definition: ftdi.h:326
ftdi_readstream
int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback, void *userdata, int packetsPerTransfer, int numTransfers)
Definition: ftdi_stream.c:147
ftdi_list_free2
void ftdi_list_free2(struct ftdi_device_list *devlist)
Definition: ftdi.c:378
GROUP0_SCHMITT
Definition: ftdi.h:311
ftdi_usb_purge_tx_buffer
int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
Definition: ftdi.c:935
ftdi_read_eeprom_location
int ftdi_read_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
Definition: ftdi.c:4012
ftdi_deinit
void ftdi_deinit(struct ftdi_context *ftdi)
Definition: ftdi.c:210
BITS_7
Definition: ftdi.h:52
ftdi_set_usbdev
void ftdi_set_usbdev(struct ftdi_context *ftdi, struct libusb_device_handle *usbdev)
Definition: ftdi.c:268
USE_USB_VERSION
Definition: ftdi.h:290
CBUSH_TXLED
Definition: ftdi.h:362
USE_SERIAL
Definition: ftdi.h:288
ftdi_eeprom_value
ftdi_eeprom_value
Definition: ftdi.h:277
SUSPEND_DBUS7
Definition: ftdi.h:284
ftdi_interface
ftdi_interface
Definition: ftdi.h:72
GROUP2_SLEW
Definition: ftdi.h:318
GROUP1_DRIVE
Definition: ftdi.h:313
ftdi_usb_open_desc_index
int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, const char *description, const char *serial, unsigned int index)
Definition: ftdi.c:692
BREAK_ON
Definition: ftdi.h:54
ftdi_transfer_control::transfer
struct libusb_transfer * transfer
Definition: ftdi.h:211
ftdi_set_baudrate
int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
Definition: ftdi.c:1238
TYPE_2232H
Definition: ftdi.h:42
MAX_POWER
Definition: ftdi.h:291
ftdi_write_data
int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size)
Definition: ftdi.c:1373
CBUS_FUNCTION_0
Definition: ftdi.h:296
CBUS_TXLED
Definition: ftdi.h:355
CBUS_FUNCTION_8
Definition: ftdi.h:304
GROUP2_DRIVE
Definition: ftdi.h:316
ftdi_context
Main context structure for all libftdi functions.
Definition: ftdi.h:219
CBUSH_AWAKE
Definition: ftdi.h:366
PRODUCT_ID
Definition: ftdi.h:280
GROUP0_DRIVE
Definition: ftdi.h:310
CBUSH_VBUS_SENSE
Definition: ftdi.h:365
CBUSH_SLEEP
Definition: ftdi.h:363
BITMODE_SYNCFF
Definition: ftdi.h:67
size_and_time::time
struct timeval time
Definition: ftdi.h:420
ftdi_version_info::version_str
const char * version_str
Definition: ftdi.h:449
ftdi_set_event_char
int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable)
Definition: ftdi.c:2235
CBUS_BB_RD
Definition: ftdi.h:357
HIGH_CURRENT_B
Definition: ftdi.h:308
TYPE_R
Definition: ftdi.h:41
BITMODE_OPTO
Definition: ftdi.h:65
USB_VERSION
Definition: ftdi.h:289
FTDIProgressInfo::totalRate
double totalRate
Definition: ftdi.h:429
ftdi_set_bitmode
int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
Definition: ftdi.c:1933
ftdi_list_free
void ftdi_list_free(struct ftdi_device_list **devlist)
Definition: ftdi.c:358
ftdi_context::type
enum ftdi_chip_type type
Definition: ftdi.h:233
FTDIStreamCallback
int( FTDIStreamCallback)(uint8_t *buffer, int length, FTDIProgressInfo *progress, void *userdata)
Definition: ftdi.h:433
CBUSH_I2C_RXF
Definition: ftdi.h:365
CBUS_CLK12
Definition: ftdi.h:356
ftdi_set_line_property
int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
Definition: ftdi.c:1284
size_and_time
Progress Info for streaming read.
Definition: ftdi.h:417
INTERFACE_D
Definition: ftdi.h:78
ftdi_usb_purge_rx_buffer
int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
Definition: ftdi.c:909
ftdi_new
struct ftdi_context * ftdi_new(void)
Definition: ftdi.c:128
GROUP3_SLEW
Definition: ftdi.h:321
DONT_DETACH_SIO_MODULE
Definition: ftdi.h:85
ftdi_cbush_func
ftdi_cbush_func
Definition: ftdi.h:360
CHANNEL_C_DRIVER
Definition: ftdi.h:328
ftdi_version_info::major
int major
Definition: ftdi.h:446
ftdi_erase_eeprom
int ftdi_erase_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4240
TYPE_230X
Definition: ftdi.h:45
CBUS_RXLED
Definition: ftdi.h:355
TYPE_BM
Definition: ftdi.h:39
ftdi_set_interface
int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
Definition: ftdi.c:157
CBUS_FUNCTION_4
Definition: ftdi.h:300
SUSPEND_PULL_DOWNS
Definition: ftdi.h:287
ftdi_eeprom_initdefaults
int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char *manufacturer, char *product, char *serial)
Definition: ftdi.c:2294
ftdi_transfer_data_done
int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
Definition: ftdi.c:1662
BITMODE_MPSSE
Definition: ftdi.h:61
ftdi_context::readbuffer_remaining
unsigned int readbuffer_remaining
Definition: ftdi.h:243
ftdi_version_info::micro
int micro
Definition: ftdi.h:448
CHIP_SIZE
Definition: ftdi.h:322
ftdi_set_error_char
int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable)
Definition: ftdi.c:2264
GROUP1_SLEW
Definition: ftdi.h:315
ftdi_eeprom_decode
int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
Definition: ftdi.c:3154
INTERFACE_A
Definition: ftdi.h:75
BITMODE_FT1284
Definition: ftdi.h:68
GROUP3_DRIVE
Definition: ftdi.h:319
HIGH_CURRENT
Definition: ftdi.h:306
ftdi_transfer_control::offset
int offset
Definition: ftdi.h:209
ftdi_context::out_ep
int out_ep
Definition: ftdi.h:259
CHANNEL_A_RS485
Definition: ftdi.h:330
CBUS_PWREN
Definition: ftdi.h:355
ftdi_device_list::dev
struct libusb_device * dev
Definition: ftdi.h:345
ftdi_get_eeprom_value
int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
Definition: ftdi.c:3581
FLOW_CONTROL
Definition: ftdi.h:327
CBUS_TXDEN
Definition: ftdi.h:355
ftdi_bits_type
ftdi_bits_type
Definition: ftdi.h:52
CHANNEL_A_TYPE
Definition: ftdi.h:292
TYPE_232H
Definition: ftdi.h:44
CHANNEL_B_DRIVER
Definition: ftdi.h:295
ftdi_init
int ftdi_init(struct ftdi_context *ftdi)
Definition: ftdi.c:88
ftdi_context::error_str
char * error_str
Definition: ftdi.h:268
CBUSH_BAT_DETECT_NEG
Definition: ftdi.h:365
ftdi_context::readbuffer
unsigned char * readbuffer
Definition: ftdi.h:239
CBUSH_PWREN
Definition: ftdi.h:362
ftdi_read_data_submit
struct ftdi_transfer_control * ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1583
ftdi_context::usb_ctx
struct libusb_context * usb_ctx
Definition: ftdi.h:223
ftdi_context::usb_write_timeout
int usb_write_timeout
Definition: ftdi.h:229
FTDIProgressInfo::currentRate
double currentRate
Definition: ftdi.h:430
ftdi_context::writebuffer_chunksize
unsigned int writebuffer_chunksize
Definition: ftdi.h:247
TYPE_AM
Definition: ftdi.h:38
HIGH_CURRENT_A
Definition: ftdi.h:307
ODD
Definition: ftdi.h:48
CBUSH_CLK7_5
Definition: ftdi.h:364
ftdi_poll_modem_status
int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
Definition: ftdi.c:2089
CBUS_BB_WR
Definition: ftdi.h:357
OUT_IS_ISOCHRONOUS
Definition: ftdi.h:286
ftdi_context::usb_read_timeout
int usb_read_timeout
Definition: ftdi.h:227
ftdi_context::index
int index
Definition: ftdi.h:255
ftdi_setdtr_rts
int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
Definition: ftdi.c:2199
STOP_BIT_15
Definition: ftdi.h:50
FTDIProgressInfo
Definition: ftdi.h:423
ftdi_context::in_ep
int in_ep
Definition: ftdi.h:258
CBUS_FUNCTION_1
Definition: ftdi.h:297
CBUS_CLK24
Definition: ftdi.h:356
BITMODE_BITBANG
Definition: ftdi.h:60
CLOCK_POLARITY
Definition: ftdi.h:325
CBUS_CLK6
Definition: ftdi.h:356
ftdi_cbus_func
ftdi_cbus_func
Definition: ftdi.h:353
CBUS_FUNCTION_2
Definition: ftdi.h:298
ftdi_set_eeprom_buf
int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char *buf, int size)
Definition: ftdi.c:3987
ftdi_write_data_set_chunksize
int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
Definition: ftdi.c:1708
ftdi_context::bitbang_mode
unsigned char bitbang_mode
Definition: ftdi.h:262
ftdi_usb_open_dev
int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev)
Definition: ftdi.c:523
ftdi_transfer_control::ftdi
struct ftdi_context * ftdi
Definition: ftdi.h:210
ftdi_set_eeprom_value
int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
Definition: ftdi.c:3771
VENDOR_ID
Definition: ftdi.h:279
SPACE
Definition: ftdi.h:48
STOP_BIT_2
Definition: ftdi.h:50
ftdi_version_info::snapshot_str
const char * snapshot_str
Definition: ftdi.h:450
INTERFACE_ANY
Definition: ftdi.h:74
CBUSH_BAT_DETECT
Definition: ftdi.h:364
CBUSH_TRISTATE
Definition: ftdi.h:362
INTERFACE_C
Definition: ftdi.h:77
EVEN
Definition: ftdi.h:48
ftdi_transfer_control::size
int size
Definition: ftdi.h:208
ftdi_setflowctrl
int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
Definition: ftdi.c:2115
FTDIProgressInfo::totalTime
double totalTime
Definition: ftdi.h:428
CBUS_SLEEP
Definition: ftdi.h:356
ftdi_usb_open_desc
int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, const char *description, const char *serial)
Definition: ftdi.c:662
INTERFACE_B
Definition: ftdi.h:76
SELF_POWERED
Definition: ftdi.h:281
CBUSH_BB_RD
Definition: ftdi.h:366
MARK
Definition: ftdi.h:48
CBUSH_RXLED
Definition: ftdi.h:362
GROUP3_SCHMITT
Definition: ftdi.h:320
ftdi_context::usb_dev
struct libusb_device_handle * usb_dev
Definition: ftdi.h:225
ftdi_context::interface
int interface
Definition: ftdi.h:253
ftdi_break_type
ftdi_break_type
Definition: ftdi.h:54
RELEASE_NUMBER
Definition: ftdi.h:334
TYPE_2232C
Definition: ftdi.h:40
BITS_8
Definition: ftdi.h:52
CHANNEL_D_DRIVER
Definition: ftdi.h:329
ftdi_version_info
Definition: ftdi.h:444
ftdi_usb_close
int ftdi_usb_close(struct ftdi_context *ftdi)
Definition: ftdi.c:987
ftdi_context::max_packet_size
unsigned int max_packet_size
Definition: ftdi.h:249
ftdi_setrts
int ftdi_setrts(struct ftdi_context *ftdi, int state)
Definition: ftdi.c:2168
CBUSH_IOMODE
Definition: ftdi.h:363
IS_NOT_PNP
Definition: ftdi.h:283
CBUSH_DRIVE_0
Definition: ftdi.h:363
ftdi_usb_reset
int ftdi_usb_reset(struct ftdi_context *ftdi)
Definition: ftdi.c:883
ftdi_get_latency_timer
int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
Definition: ftdi.c:2035
CHANNEL_C_RS485
Definition: ftdi.h:332
ftdi_usb_get_strings
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)
Definition: ftdi.c:409
CBUS_FUNCTION_5
Definition: ftdi.h:301
BITMODE_CBUS
Definition: ftdi.h:66
ftdi_parity_type
ftdi_parity_type
Definition: ftdi.h:48
CHANNEL_D_RS485
Definition: ftdi.h:333
CHIP_TYPE
Definition: ftdi.h:323
ftdi_transfer_control::buf
unsigned char * buf
Definition: ftdi.h:207
ftdi_read_data_set_chunksize
int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
Definition: ftdi.c:1875
ftdi_write_data_get_chunksize
int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
Definition: ftdi.c:1726
ftdi_context::bitbang_enabled
unsigned char bitbang_enabled
Definition: ftdi.h:237
CBUSH_TIME_STAMP
Definition: ftdi.h:366
ftdi_write_eeprom
int ftdi_write_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4185
ftdi_usb_open_string
int ftdi_usb_open_string(struct ftdi_context *ftdi, const char *description)
Definition: ftdi.c:790
ftdi_disable_bitbang
int ftdi_disable_bitbang(struct ftdi_context *ftdi)
Definition: ftdi.c:1959
ftdi_setdtr
int ftdi_setdtr(struct ftdi_context *ftdi, int state)
Definition: ftdi.c:2138
ftdi_set_latency_timer
int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
Definition: ftdi.c:2008
CBUSH_I2C_TXE
Definition: ftdi.h:365
ftdi_eeprom
FTDI eeprom structure.
Definition: ftdi_i.h:30
ftdi_stopbits_type
ftdi_stopbits_type
Definition: ftdi.h:50
size_and_time::totalBytes
uint64_t totalBytes
Definition: ftdi.h:419
CBUS_BB
Definition: ftdi.h:357
GROUP0_SLEW
Definition: ftdi.h:312
ftdi_context::readbuffer_chunksize
unsigned int readbuffer_chunksize
Definition: ftdi.h:245
ftdi_read_eeprom
int ftdi_read_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4032
ftdi_get_error_string
char * ftdi_get_error_string(struct ftdi_context *ftdi)
Definition: ftdi.c:4302
GROUP1_SCHMITT
Definition: ftdi.h:314
ftdi_context::baudrate
int baudrate
Definition: ftdi.h:235
CBUS_FUNCTION_7
Definition: ftdi.h:303
CBUS_TXRXLED
Definition: ftdi.h:355
CBUS_CLK48
Definition: ftdi.h:356
ftdi_eeprom_build
int ftdi_eeprom_build(struct ftdi_context *ftdi)
Definition: ftdi.c:2561
INVERT
Definition: ftdi.h:309
CBUSH_CLK15
Definition: ftdi.h:364
ftdi_usb_purge_buffers
int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
Definition: ftdi.c:958
GROUP2_SCHMITT
Definition: ftdi.h:317
CBUSH_CLK30
Definition: ftdi.h:364
ftdi_read_data
int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1750
ftdi_write_eeprom_location
int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val)
Definition: ftdi.c:4129
TYPE_4232H
Definition: ftdi.h:43
ftdi_get_eeprom_buf
int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:3961
BREAK_OFF
Definition: ftdi.h:54
CBUSH_TXDEN
Definition: ftdi.h:363
ftdi_context::readbuffer_offset
unsigned int readbuffer_offset
Definition: ftdi.h:241
CBUSG_DRIVE1
Definition: ftdi.h:363
ftdi_free
void ftdi_free(struct ftdi_context *ftdi)
Definition: ftdi.c:256
ftdi_read_chipid
int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
Definition: ftdi.c:4091
BITMODE_MCU
Definition: ftdi.h:63
ftdi_mpsse_mode
ftdi_mpsse_mode
Definition: ftdi.h:57
CBUSH_BB_WR
Definition: ftdi.h:366
ftdi_usb_find_all
int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
Definition: ftdi.c:310
AUTO_DETACH_SIO_MODULE
Definition: ftdi.h:84
CHANNEL_A_DRIVER
Definition: ftdi.h:294
ftdi_module_detach_mode
ftdi_module_detach_mode
Definition: ftdi.h:82
ftdi_set_line_property2
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)
Definition: ftdi.c:1303
CBUS_FUNCTION_3
Definition: ftdi.h:299
BITMODE_RESET
Definition: ftdi.h:59
CBUS_IOMODE
Definition: ftdi.h:357
ftdi_context::eeprom
struct ftdi_eeprom * eeprom
Definition: ftdi.h:265
CBUSH_TXRXLED
Definition: ftdi.h:362
ftdi_transfer_control
Definition: ftdi.h:204
CHANNEL_B_RS485
Definition: ftdi.h:331