[libftdi] / src / ftdi.h

/***************************************************************************
                          ftdi.h  -  description
                             -------------------
    begin                : Fri Apr 4 2003
    copyright            : (C) 2003 by Intra2net AG
    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 <usb.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 };
/// 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_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
/// Number of bits for ftdi_set_line_property()
enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
/// Break type for ftdi_set_line_property2()
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
};

/// Port interface for FT2232C
enum ftdi_interface {
    INTERFACE_ANY = 0,
    INTERFACE_A   = 1,
    INTERFACE_B   = 2
};

/* 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
/* 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_MODEM_CTRL     1 /* Set the modem control register */
#define SIO_SET_FLOW_CTRL  2 /* Set flow control register */

#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL

#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))
#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)

/**
    \brief Main context structure for all libftdi functions.

    Do not access directly if possible.
*/
struct ftdi_context {
    // USB specific
    /// libusb's usb_dev_handle
    struct usb_dev_handle *usb_dev;
    /// usb read timeout
    int usb_read_timeout;
    /// usb write timeout
    int usb_write_timeout;

    // FTDI specific
    /// FTDI chip type
    enum ftdi_chip_type type;
    /// baudrate
    int baudrate;
    /// bitbang mode state
    unsigned char bitbang_enabled;
    /// pointer to read buffer for ftdi_read_data
    unsigned char *readbuffer;
    /// read buffer offset
    unsigned int readbuffer_offset;
    /// number of remaining data in internal read buffer
    unsigned int readbuffer_remaining;
    /// read buffer chunk size
    unsigned int readbuffer_chunksize;
    /// write buffer chunk size
    unsigned int writebuffer_chunksize;

    // FTDI FT2232C requirecments
    /// FT2232C interface number: 0 or 1
    int interface;   // 0 or 1
    /// FT2232C index number: 1 or 2
    int index;       // 1 or 2
    // Endpoints
    /// FT2232C end points: 1 or 2
    int in_ep;
    int out_ep;      // 1 or 2

    /// Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
    unsigned char bitbang_mode;

    /// EEPROM size. Default is 128 bytes for 232BM and 245BM chips
    int eeprom_size;

    /// 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 {
    /// pointer to next entry
    struct ftdi_device_list *next;
    /// pointer to libusb's usb_device
    struct usb_device *dev;
};

/**
    \brief FTDI eeprom structure
*/
struct ftdi_eeprom {
    /// vendor id
    int vendor_id;
    /// product id
    int product_id;

    /// self powered
    int self_powered;
    /// remote wakepu
    int remote_wakeup;
    /// chip type
    int BM_type_chip;

    /// input in isochronous transfer mode
    int in_is_isochronous;
    /// output in isochronous transfer mode
    int out_is_isochronous;
    /// suspend pull downs
    int suspend_pull_downs;

    /// use serial
    int use_serial;
    /// fake usb version
    int change_usb_version;
    /// usb version
    int usb_version;
    /// maximum power
    int max_power;

    /// manufacturer name
    char *manufacturer;
    /// product name
    char *product;
    /// 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;
};

#ifdef __cplusplus
extern "C" {
#endif

    int ftdi_init(struct ftdi_context *ftdi);
    struct ftdi_context *ftdi_new();
    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);

    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,
                             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_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, 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_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);
    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);

    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(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);

    // set eeprom size
    void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);

    // 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);

    // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
    // the checksum of the eeprom is valided
    int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
    int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
    int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize);
    int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
    int ftdi_erase_eeprom(struct ftdi_context *ftdi);

    char *ftdi_get_error_string(struct ftdi_context *ftdi);

#ifdef __cplusplus
}
#endif

#endif /* __libftdi_h__ */
Commit	Line	Data
a3da1d95 GE	1	/***************************************************************************
	2	ftdi.h - description
	3	-------------------
	4	begin : Fri Apr 4 2003
	5	copyright : (C) 2003 by Intra2net AG
5fdb1cb1	6	email : opensource@intra2net.com
a3da1d95 GE	7	***************************************************************************/
	8
	9	/***************************************************************************
	10	* *
	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; *
	14	* *
	15	***************************************************************************/
	16
	17	#ifndef __libftdi_h__
	18	#define __libftdi_h__
	19
98452d97	20	#include <usb.h>
0e302db6	21
c201f80f TJ	22	#define FTDI_DEFAULT_EEPROM_SIZE 128
c201f80f TJ	23
9bec2387	24	/// FTDI chip type
cb6250fa	25	enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
9bec2387	26	/// Parity mode for ftdi_set_line_property()
2f73e59f	27	enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
9bec2387	28	/// Number of stop bits for ftdi_set_line_property()
2f73e59f	29	enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
6c32e222	30	/// Number of bits for ftdi_set_line_property()
2f73e59f	31	enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
6c32e222 TJ	32	/// Break type for ftdi_set_line_property2()
6c32e222 TJ	33	enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
2f73e59f	34
9bec2387	35	/// MPSSE bitbang modes
c4446c36 TJ	36	enum ftdi_mpsse_mode {
	37	BITMODE_RESET = 0x00,
	38	BITMODE_BITBANG= 0x01,
	39	BITMODE_MPSSE = 0x02,
	40	BITMODE_SYNCBB = 0x04,
	41	BITMODE_MCU = 0x08,
8144d211 TJ	42	// CPU-style fifo mode gets set via EEPROM
	43	BITMODE_OPTO = 0x10,
	44	BITMODE_CBUS = 0x20
c4446c36 TJ	45	};
c4446c36 TJ	46
9bec2387	47	/// Port interface for FT2232C
c4446c36 TJ	48	enum ftdi_interface {
	49	INTERFACE_ANY = 0,
	50	INTERFACE_A = 1,
	51	INTERFACE_B = 2
	52	};
	53
	54	/* Shifting commands IN MPSSE Mode*/
	55	#define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
	56	#define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
	57	#define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
	58	#define MPSSE_LSB 0x08 /* LSB first */
	59	#define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
	60	#define MPSSE_DO_READ 0x20 /* Read TDO/DI */
	61	#define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
	62
	63	/* FTDI MPSSE commands */
	64	#define SET_BITS_LOW 0x80
	65	/BYTE DATA/
	66	/BYTE Direction/
	67	#define SET_BITS_HIGH 0x82
	68	/BYTE DATA/
	69	/BYTE Direction/
	70	#define GET_BITS_LOW 0x81
	71	#define GET_BITS_HIGH 0x83
	72	#define LOOPBACK_START 0x84
	73	#define LOOPBACK_END 0x85
	74	#define TCK_DIVISOR 0x86
	75	/* Value Low */
	76	/* Value HIGH / /rate is 12000000/((1+value)2) /
	77	#define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
	78
	79	/* Commands in MPSSE and Host Emulation Mode */
	80	#define SEND_IMMEDIATE 0x87
	81	#define WAIT_ON_HIGH 0x88
	82	#define WAIT_ON_LOW 0x89
	83
	84	/* Commands in Host Emulation Mode */
	85	#define READ_SHORT 0x90
	86	/* Address_Low */
	87	#define READ_EXTENDED 0x91
	88	/* Address High */
	89	/* Address Low */
	90	#define WRITE_SHORT 0x92
	91	/* Address_Low */
	92	#define WRITE_EXTENDED 0x93
	93	/* Address High */
	94	/* Address Low */
53ad271d	95
a01d31e2	96	/* Definitions for flow control */
a01d31e2 TJ	97	#define SIO_MODEM_CTRL 1 /* Set the modem control register */
	98	#define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
	99
	100	#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
	101	#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
	102
	103	#define SIO_DISABLE_FLOW_CTRL 0x0
	104	#define SIO_RTS_CTS_HS (0x1 << 8)
	105	#define SIO_DTR_DSR_HS (0x2 << 8)
	106	#define SIO_XON_XOFF_HS (0x4 << 8)
	107
	108	#define SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
	109	#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
	110
	111	#define SIO_SET_DTR_MASK 0x1
	112	#define SIO_SET_DTR_HIGH ( 1 \| ( SIO_SET_DTR_MASK << 8))
	113	#define SIO_SET_DTR_LOW ( 0 \| ( SIO_SET_DTR_MASK << 8))
	114	#define SIO_SET_RTS_MASK 0x2
	115	#define SIO_SET_RTS_HIGH ( 2 \| ( SIO_SET_RTS_MASK << 8 ))
	116	#define SIO_SET_RTS_LOW ( 0 \| ( SIO_SET_RTS_MASK << 8 ))
	117
	118	#define SIO_RTS_CTS_HS (0x1 << 8)
	119
7cc9950e GE	120	/* marker for unused usb urb structures
	121	(taken from libusb) */
	122	#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
	123
9bec2387	124	/**
b5ec1820	125	\brief Main context structure for all libftdi functions.
a01d31e2	126
9bec2387 TJ	127	Do not access directly if possible.
9bec2387 TJ	128	*/
a3da1d95 GE	129	struct ftdi_context {
a3da1d95 GE	130	// USB specific
9bec2387	131	/// libusb's usb_dev_handle
98452d97	132	struct usb_dev_handle *usb_dev;
9bec2387	133	/// usb read timeout
545820ce	134	int usb_read_timeout;
9bec2387	135	/// usb write timeout
545820ce	136	int usb_write_timeout;
a3da1d95 GE	137
a3da1d95 GE	138	// FTDI specific
9bec2387	139	/// FTDI chip type
53ad271d	140	enum ftdi_chip_type type;
9bec2387	141	/// baudrate
a3da1d95	142	int baudrate;
9bec2387	143	/// bitbang mode state
a3da1d95	144	unsigned char bitbang_enabled;
9bec2387	145	/// pointer to read buffer for ftdi_read_data
948f9ada	146	unsigned char *readbuffer;
9bec2387	147	/// read buffer offset
4ece2c24	148	unsigned int readbuffer_offset;
9bec2387	149	/// number of remaining data in internal read buffer
4ece2c24	150	unsigned int readbuffer_remaining;
9bec2387	151	/// read buffer chunk size
948f9ada	152	unsigned int readbuffer_chunksize;
9bec2387	153	/// write buffer chunk size
948f9ada	154	unsigned int writebuffer_chunksize;
d9f0cce7	155
545820ce	156	// FTDI FT2232C requirecments
9bec2387	157	/// FT2232C interface number: 0 or 1
545820ce	158	int interface; // 0 or 1
9bec2387	159	/// FT2232C index number: 1 or 2
545820ce TJ	160	int index; // 1 or 2
545820ce TJ	161	// Endpoints
9bec2387	162	/// FT2232C end points: 1 or 2
545820ce TJ	163	int in_ep;
545820ce TJ	164	int out_ep; // 1 or 2
c3d95b87	165
9bec2387	166	/// Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
3119537f	167	unsigned char bitbang_mode;
545820ce	168
c201f80f TJ	169	/// EEPROM size. Default is 128 bytes for 232BM and 245BM chips
	170	int eeprom_size;
	171
9bec2387	172	/// String representation of last error
a3da1d95	173	char *error_str;
7cc9950e GE	174
	175	/// Buffer needed for async communication
	176	char *async_usb_buffer;
	177	/// Number of URB-structures we can buffer
	178	unsigned int async_usb_buffer_size;
a3da1d95 GE	179	};
a3da1d95 GE	180
9bec2387	181	/**
b5ec1820	182	\brief list of usb devices created by ftdi_usb_find_all()
9bec2387	183	*/
edb82cbf	184	struct ftdi_device_list {
9bec2387	185	/// pointer to next entry
edb82cbf	186	struct ftdi_device_list *next;
9bec2387	187	/// pointer to libusb's usb_device
edb82cbf TJ	188	struct usb_device *dev;
	189	};
	190
9bec2387	191	/**
b5ec1820	192	\brief FTDI eeprom structure
9bec2387	193	*/
b8aa7b35	194	struct ftdi_eeprom {
9bec2387	195	/// vendor id
d9f0cce7	196	int vendor_id;
9bec2387	197	/// product id
b8aa7b35 TJ	198	int product_id;
b8aa7b35 TJ	199
9bec2387	200	/// self powered
d9f0cce7	201	int self_powered;
9bec2387	202	/// remote wakepu
b8aa7b35	203	int remote_wakeup;
9bec2387	204	/// chip type
b8aa7b35 TJ	205	int BM_type_chip;
b8aa7b35 TJ	206
9bec2387	207	/// input in isochronous transfer mode
b8aa7b35	208	int in_is_isochronous;
9bec2387	209	/// output in isochronous transfer mode
b8aa7b35	210	int out_is_isochronous;
9bec2387	211	/// suspend pull downs
b8aa7b35 TJ	212	int suspend_pull_downs;
b8aa7b35 TJ	213
9bec2387	214	/// use serial
b8aa7b35	215	int use_serial;
9bec2387	216	/// fake usb version
b8aa7b35	217	int change_usb_version;
9bec2387	218	/// usb version
b8aa7b35	219	int usb_version;
9bec2387	220	/// maximum power
b8aa7b35	221	int max_power;
d9f0cce7	222
9bec2387	223	/// manufacturer name
b8aa7b35	224	char *manufacturer;
9bec2387	225	/// product name
b8aa7b35	226	char *product;
9bec2387	227	/// serial number
b8aa7b35	228	char *serial;
c201f80f TJ	229
	230	/// eeprom size in bytes. This doesn't get stored in the eeprom
	231	/// but is the only way to pass it to ftdi_eeprom_build.
	232	int size;
b8aa7b35 TJ	233	};
b8aa7b35 TJ	234
a3da1d95 GE	235	#ifdef __cplusplus
	236	extern "C" {
	237	#endif
	238
	239	int ftdi_init(struct ftdi_context *ftdi);
cef378aa	240	struct ftdi_context *ftdi_new();
0ce2f5fa	241	int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
c4446c36	242
948f9ada	243	void ftdi_deinit(struct ftdi_context *ftdi);
cef378aa	244	void ftdi_free(struct ftdi_context *ftdi);
98452d97	245	void ftdi_set_usbdev (struct ftdi_context ftdi, usb_dev_handle usbdev);
a01d31e2	246
edb82cbf TJ	247	int ftdi_usb_find_all(struct ftdi_context ftdi, struct ftdi_device_list *devlist,
	248	int vendor, int product);
	249	void ftdi_list_free(struct ftdi_device_list **devlist);
cef378aa	250	void ftdi_list_free2(struct ftdi_device_list *devlist);
474786c0 TJ	251	int ftdi_usb_get_strings(struct ftdi_context ftdi, struct usb_device dev,
	252	char * manufacturer, int mnf_len,
	253	char * description, int desc_len,
	254	char * serial, int serial_len);
a01d31e2	255
a3da1d95	256	int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
a8f46ddc TJ	257	int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
a8f46ddc TJ	258	const char* description, const char* serial);
edb82cbf	259	int ftdi_usb_open_dev(struct ftdi_context ftdi, struct usb_device dev);
1941414d	260
a3da1d95 GE	261	int ftdi_usb_close(struct ftdi_context *ftdi);
a3da1d95 GE	262	int ftdi_usb_reset(struct ftdi_context *ftdi);
1189b11a TJ	263	int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
1189b11a TJ	264	int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
a60be878	265	int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
a3da1d95 GE	266
a3da1d95 GE	267	int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
2f73e59f TJ	268	int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
2f73e59f TJ	269	enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
6c32e222 TJ	270	int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
	271	enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
	272	enum ftdi_break_type break_type);
948f9ada	273
be5d7eec	274	int ftdi_read_data(struct ftdi_context ftdi, unsigned char buf, int size);
948f9ada TJ	275	int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
	276	int ftdi_read_data_get_chunksize(struct ftdi_context ftdi, unsigned int chunksize);
	277
	278	int ftdi_write_data(struct ftdi_context ftdi, unsigned char buf, int size);
	279	int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
	280	int ftdi_write_data_get_chunksize(struct ftdi_context ftdi, unsigned int chunksize);
a3da1d95	281
7cc9950e GE	282	int ftdi_write_data_async(struct ftdi_context ftdi, unsigned char buf, int size);
	283	void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
	284
a3da1d95 GE	285	int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
a3da1d95 GE	286	int ftdi_disable_bitbang(struct ftdi_context *ftdi);
c4446c36	287	int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
a3da1d95 GE	288	int ftdi_read_pins(struct ftdi_context ftdi, unsigned char pins);
	289
	290	int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
	291	int ftdi_get_latency_timer(struct ftdi_context ftdi, unsigned char latency);
	292
1189b11a TJ	293	int ftdi_poll_modem_status(struct ftdi_context ftdi, unsigned short status);
1189b11a TJ	294
a7fb8440 TJ	295	// flow control
	296	int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
	297	int ftdi_setdtr(struct ftdi_context *ftdi, int state);
	298	int ftdi_setrts(struct ftdi_context *ftdi, int state);
	299
1189b11a TJ	300	int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
	301	int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
	302
c201f80f TJ	303	// set eeprom size
	304	void ftdi_eeprom_setsize(struct ftdi_context ftdi, struct ftdi_eeprom eeprom, int size);
	305
98452d97	306	// init and build eeprom from ftdi_eeprom structure
b8aa7b35 TJ	307	void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
	308	int ftdi_eeprom_build(struct ftdi_eeprom eeprom, unsigned char output);
	309
98452d97 TJ	310	// "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
98452d97 TJ	311	// the checksum of the eeprom is valided
be5d7eec	312	int ftdi_read_eeprom(struct ftdi_context ftdi, unsigned char eeprom);
cb6250fa	313	int ftdi_read_chipid(struct ftdi_context ftdi, unsigned int chipid);
c201f80f	314	int ftdi_read_eeprom_getsize(struct ftdi_context ftdi, unsigned char eeprom, int maxsize);
be5d7eec	315	int ftdi_write_eeprom(struct ftdi_context ftdi, unsigned char eeprom);
b8aa7b35	316	int ftdi_erase_eeprom(struct ftdi_context *ftdi);
a3da1d95	317
c3d95b87 TJ	318	char ftdi_get_error_string(struct ftdi_context ftdi);
c3d95b87 TJ	319
a3da1d95 GE	320	#ifdef __cplusplus
	321	}
	322	#endif
	323
	324	#endif /* __libftdi_h__ */