ftdi_context Struct Reference

Main context structure for all libftdi functions. More...

#include <ftdi.h>

Data Fields
struct usb_dev_handle *	usb_dev
	libusb's usb_dev_handle
int	usb_read_timeout
	usb read timeout
int	usb_write_timeout
	usb write timeout
enum ftdi_chip_type	type
	FTDI chip type.
int	baudrate
	baudrate
unsigned char	bitbang_enabled
	bitbang mode state
unsigned char *	readbuffer
	pointer to read buffer for ftdi_read_data
unsigned int	readbuffer_offset
	read buffer offset
unsigned int	readbuffer_remaining
	number of remaining data in internal read buffer
unsigned int	readbuffer_chunksize
	read buffer chunk size
unsigned int	writebuffer_chunksize
	write buffer chunk size
int	interface
	FT2232C interface number: 0 or 1.
int	index
	FT2232C index number: 1 or 2.
int	in_ep
	FT2232C end points: 1 or 2.
int	out_ep
unsigned char	bitbang_mode
	Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode.
int	eeprom_size
	EEPROM size. Default is 128 bytes for 232BM and 245BM chips.
char *	error_str
	String representation of last error.
char *	async_usb_buffer
	Buffer needed for async communication.
unsigned int	async_usb_buffer_size
	Number of URB-structures we can buffer.

---

Detailed Description

Main context structure for all libftdi functions.

Do not access directly if possible.

---

Field Documentation

struct usb_dev_handle* ftdi_context::usb_dev [read]

libusb's usb_dev_handle

Referenced by ftdi_disable_bitbang(), ftdi_enable_bitbang(), ftdi_erase_eeprom(), ftdi_get_latency_timer(), ftdi_init(), ftdi_poll_modem_status(), ftdi_read_chipid(), ftdi_read_data(), ftdi_read_eeprom(), ftdi_read_eeprom_getsize(), ftdi_read_pins(), ftdi_set_baudrate(), ftdi_set_bitmode(), ftdi_set_error_char(), ftdi_set_event_char(), ftdi_set_latency_timer(), ftdi_set_line_property(), ftdi_set_usbdev(), ftdi_setdtr(), ftdi_setflowctrl(), ftdi_setrts(), ftdi_usb_close(), ftdi_usb_get_strings(), ftdi_usb_open_desc(), ftdi_usb_open_dev(), ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), ftdi_usb_reset(), ftdi_write_data(), and ftdi_write_eeprom().

int ftdi_context::usb_read_timeout

usb read timeout

Referenced by ftdi_get_latency_timer(), ftdi_init(), ftdi_poll_modem_status(), ftdi_read_chipid(), ftdi_read_data(), ftdi_read_eeprom(), ftdi_read_eeprom_getsize(), and ftdi_read_pins().

int ftdi_context::usb_write_timeout

usb write timeout

Referenced by ftdi_async_complete(), ftdi_disable_bitbang(), ftdi_enable_bitbang(), ftdi_erase_eeprom(), ftdi_init(), ftdi_set_baudrate(), ftdi_set_bitmode(), ftdi_set_error_char(), ftdi_set_event_char(), ftdi_set_latency_timer(), ftdi_set_line_property(), ftdi_setdtr(), ftdi_setflowctrl(), ftdi_setrts(), ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), ftdi_usb_reset(), ftdi_write_data(), and ftdi_write_eeprom().

enum ftdi_chip_type ftdi_context::type

FTDI chip type.

Referenced by ftdi_init(), and ftdi_usb_open_dev().

int ftdi_context::baudrate

baudrate

Referenced by ftdi_init(), and ftdi_set_baudrate().

unsigned char ftdi_context::bitbang_enabled

bitbang mode state

Referenced by ftdi_disable_bitbang(), ftdi_enable_bitbang(), ftdi_init(), ftdi_set_baudrate(), and ftdi_set_bitmode().

unsigned char* ftdi_context::readbuffer

pointer to read buffer for ftdi_read_data

Referenced by ftdi_deinit(), ftdi_init(), ftdi_read_data(), and ftdi_read_data_set_chunksize().

unsigned int ftdi_context::readbuffer_offset

read buffer offset

Referenced by ftdi_init(), ftdi_read_data(), ftdi_read_data_set_chunksize(), ftdi_usb_purge_rx_buffer(), and ftdi_usb_reset().

unsigned int ftdi_context::readbuffer_remaining

number of remaining data in internal read buffer

Referenced by ftdi_init(), ftdi_read_data(), ftdi_read_data_set_chunksize(), ftdi_usb_purge_rx_buffer(), and ftdi_usb_reset().

unsigned int ftdi_context::readbuffer_chunksize

read buffer chunk size

Referenced by ftdi_read_data(), ftdi_read_data_get_chunksize(), and ftdi_read_data_set_chunksize().

unsigned int ftdi_context::writebuffer_chunksize

write buffer chunk size

Referenced by ftdi_init(), ftdi_write_data(), ftdi_write_data_async(), ftdi_write_data_get_chunksize(), and ftdi_write_data_set_chunksize().

int ftdi_context::interface

FT2232C interface number: 0 or 1.

Referenced by ftdi_init(), ftdi_set_interface(), ftdi_setdtr(), ftdi_setflowctrl(), ftdi_setrts(), ftdi_usb_close(), and ftdi_usb_open_dev().

int ftdi_context::index

FT2232C index number: 1 or 2.

Referenced by ftdi_disable_bitbang(), ftdi_enable_bitbang(), ftdi_get_latency_timer(), ftdi_init(), ftdi_poll_modem_status(), ftdi_read_pins(), ftdi_set_bitmode(), ftdi_set_error_char(), ftdi_set_event_char(), ftdi_set_interface(), ftdi_set_latency_timer(), ftdi_set_line_property(), ftdi_usb_open_dev(), ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), and ftdi_usb_reset().

int ftdi_context::in_ep

FT2232C end points: 1 or 2.

Referenced by ftdi_init(), ftdi_set_interface(), ftdi_write_data(), and ftdi_write_data_async().

int ftdi_context::out_ep

Referenced by ftdi_init(), ftdi_read_data(), and ftdi_set_interface().

unsigned char ftdi_context::bitbang_mode

Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode.

Referenced by ftdi_enable_bitbang(), ftdi_init(), and ftdi_set_bitmode().

int ftdi_context::eeprom_size

EEPROM size. Default is 128 bytes for 232BM and 245BM chips.

Referenced by ftdi_eeprom_setsize(), ftdi_init(), ftdi_read_eeprom(), and ftdi_write_eeprom().

char* ftdi_context::error_str

String representation of last error.

Referenced by ftdi_get_error_string(), and ftdi_init().

char* ftdi_context::async_usb_buffer

Buffer needed for async communication.

Referenced by ftdi_deinit(), and ftdi_init().

unsigned int ftdi_context::async_usb_buffer_size

Number of URB-structures we can buffer.

Referenced by ftdi_init().

---

The documentation for this struct was generated from the following file:

• ftdi.h