[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_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 (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_OUT)
#define FTDI_DEVICE_IN_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_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)

/**
    \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 wakeup */
    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_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);

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