Linux Certif

Toute la documentation sur la certification Linux LPI

ftdi.h

NAME

ftdi.h -

SYNOPSIS

#include <usb.h>

Data Structures

struct ftdi_context
Main context structure for all libftdi functions.
struct ftdi_device_list
list of usb devices created by ftdi_usb_find_all()
struct ftdi_eeprom
FTDI eeprom structure.

Defines

#define FTDI_DEFAULT_EEPROM_SIZE 128

#define MPSSE_WRITE_NEG 0x01

#define MPSSE_BITMODE 0x02

#define MPSSE_READ_NEG 0x04

#define MPSSE_LSB 0x08

#define MPSSE_DO_WRITE 0x10

#define MPSSE_DO_READ 0x20

#define MPSSE_WRITE_TMS 0x40

#define SET_BITS_LOW 0x80

#define SET_BITS_HIGH 0x82

#define GET_BITS_LOW 0x81

#define GET_BITS_HIGH 0x83

#define LOOPBACK_START 0x84

#define LOOPBACK_END 0x85

#define TCK_DIVISOR 0x86

#define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)

#define SEND_IMMEDIATE 0x87

#define WAIT_ON_HIGH 0x88

#define WAIT_ON_LOW 0x89

#define READ_SHORT 0x90

#define READ_EXTENDED 0x91

#define WRITE_SHORT 0x92

#define WRITE_EXTENDED 0x93

#define SIO_RESET 0

#define SIO_MODEM_CTRL 1

#define SIO_SET_FLOW_CTRL 2

#define SIO_SET_BAUD_RATE 3

#define SIO_SET_DATA 4

#define SIO_RESET_REQUEST_TYPE 0x40

#define SIO_RESET_REQUEST SIO_RESET

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

#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)

Enumerations

enum ftdi_chip_type { TYPE_AM = 0, TYPE_BM = 1, TYPE_2232C = 2, TYPE_R = 3 }
FTDI chip type.
enum ftdi_parity_type { NONE = 0, ODD = 1, EVEN = 2, MARK = 3, SPACE = 4 }
Parity mode for ftdi_set_line_property().
enum ftdi_stopbits_type { STOP_BIT_1 = 0, STOP_BIT_15 = 1, STOP_BIT_2 = 2 }
Number of stop bits for ftdi_set_line_property().
enum ftdi_bits_type { BITS_7 = 7, BITS_8 = 8 }
Number of bits for ftdi_set_line_property().
enum ftdi_break_type { BREAK_OFF = 0, BREAK_ON = 1 }
Break type for ftdi_set_line_property2().
enum ftdi_mpsse_mode { BITMODE_RESET = 0x00, BITMODE_BITBANG = 0x01, BITMODE_MPSSE = 0x02, BITMODE_SYNCBB = 0x04, BITMODE_MCU = 0x08, BITMODE_OPTO = 0x10, BITMODE_CBUS = 0x20 }
MPSSE bitbang modes.
enum ftdi_interface { INTERFACE_ANY = 0, INTERFACE_A = 1, INTERFACE_B = 2 }
Port interface for FT2232C.

Functions

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)

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)

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

void ftdi_eeprom_initdefaults (struct ftdi_eeprom *eeprom)

int ftdi_eeprom_build (struct ftdi_eeprom *eeprom, unsigned char *output)

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)

Define Documentation

#define FTDI_DEFAULT_EEPROM_SIZE 128

Referenced by ftdi_eeprom_initdefaults(), and ftdi_init().

#define MPSSE_WRITE_NEG 0x01

#define MPSSE_BITMODE 0x02

#define MPSSE_READ_NEG 0x04

#define MPSSE_LSB 0x08

#define MPSSE_DO_WRITE 0x10

#define MPSSE_DO_READ 0x20

#define MPSSE_WRITE_TMS 0x40

#define SET_BITS_LOW 0x80

#define SET_BITS_HIGH 0x82

#define GET_BITS_LOW 0x81

#define GET_BITS_HIGH 0x83

#define LOOPBACK_START 0x84

#define LOOPBACK_END 0x85

#define TCK_DIVISOR 0x86

#define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)

#define SEND_IMMEDIATE 0x87

#define WAIT_ON_HIGH 0x88

#define WAIT_ON_LOW 0x89

#define READ_SHORT 0x90

#define READ_EXTENDED 0x91

#define WRITE_SHORT 0x92

#define WRITE_EXTENDED 0x93

#define SIO_RESET 0

#define SIO_MODEM_CTRL 1

#define SIO_SET_FLOW_CTRL 2

#define SIO_SET_BAUD_RATE 3

#define SIO_SET_DATA 4

#define SIO_RESET_REQUEST_TYPE 0x40

Referenced by ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), and ftdi_usb_reset().

#define SIO_RESET_REQUEST SIO_RESET

Referenced by ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), and ftdi_usb_reset().

#define SIO_RESET_SIO 0

Referenced by ftdi_usb_reset().

#define SIO_RESET_PURGE_RX 1

Referenced by ftdi_usb_purge_rx_buffer().

#define SIO_RESET_PURGE_TX 2

Referenced by ftdi_usb_purge_tx_buffer().

#define SIO_SET_BAUDRATE_REQUEST_TYPE 0x40

Referenced by ftdi_set_baudrate().

#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE

Referenced by ftdi_set_baudrate().

#define SIO_SET_DATA_REQUEST_TYPE 0x40

Referenced by ftdi_set_line_property2().

#define SIO_SET_DATA_REQUEST SIO_SET_DATA

Referenced by ftdi_set_line_property2().

#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL

Referenced by ftdi_setflowctrl().

#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40

Referenced by ftdi_setflowctrl().

#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

Referenced by ftdi_setdtr(), ftdi_setdtr_rts(), and ftdi_setrts().

#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL

Referenced by ftdi_setdtr(), ftdi_setdtr_rts(), and ftdi_setrts().

#define SIO_SET_DTR_MASK 0x1

#define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))

Referenced by ftdi_setdtr(), and ftdi_setdtr_rts().

#define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))

Referenced by ftdi_setdtr(), and ftdi_setdtr_rts().

#define SIO_SET_RTS_MASK 0x2

#define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))

Referenced by ftdi_setdtr_rts(), and ftdi_setrts().

#define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))

Referenced by ftdi_setdtr_rts(), and ftdi_setrts().

#define SIO_RTS_CTS_HS (0x1 << 8)

#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)

Referenced by ftdi_init().

Enumeration Type Documentation

enum ftdi_chip_type

FTDI chip type.

Enumerator:

TYPE_AM

TYPE_BM

TYPE_2232C

TYPE_R

enum ftdi_parity_type

Parity mode for ftdi_set_line_property().

Enumerator:

NONE

ODD

EVEN

MARK

SPACE

enum ftdi_stopbits_type

Number of stop bits for ftdi_set_line_property().

Enumerator:

STOP_BIT_1

STOP_BIT_15

STOP_BIT_2

enum ftdi_bits_type

Number of bits for ftdi_set_line_property().

Enumerator:

BITS_7

BITS_8

enum ftdi_break_type

Break type for ftdi_set_line_property2().

Enumerator:

BREAK_OFF

BREAK_ON

enum ftdi_mpsse_mode

MPSSE bitbang modes.

Enumerator:

BITMODE_RESET

BITMODE_BITBANG

BITMODE_MPSSE

BITMODE_SYNCBB

BITMODE_MCU

BITMODE_OPTO

BITMODE_CBUS

enum ftdi_interface

Port interface for FT2232C.

Enumerator:

INTERFACE_ANY

INTERFACE_A

INTERFACE_B

Author

Generated automatically by Doxygen for libftdi from the source code.