libftdi1  1.3
ftdi.h
Go to the documentation of this file.
1 /***************************************************************************
2  ftdi.h - description
3  -------------------
4  begin : Fri Apr 4 2003
5  copyright : (C) 2003-2014 by Intra2net AG and the libftdi developers
6  email : opensource@intra2net.com
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 
20 #include <stdint.h>
21 #include <sys/time.h>
22 
23 /* 'interface' might be defined as a macro on Windows, so we need to
24  * undefine it so as not to break the current libftdi API, because
25  * struct ftdi_context has an 'interface' member
26  * As this can be problematic if you include windows.h after ftdi.h
27  * in your sources, we force windows.h to be included first. */
28 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
29 #include <windows.h>
30 #if defined(interface)
31 #undef interface
32 #endif
33 #endif
34 
37 {
38  TYPE_AM=0,
39  TYPE_BM=1,
40  TYPE_2232C=2,
41  TYPE_R=3,
42  TYPE_2232H=4,
43  TYPE_4232H=5,
44  TYPE_232H=6,
45  TYPE_230X=7,
46 };
48 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
55 
58 {
59  BITMODE_RESET = 0x00,
61  BITMODE_MPSSE = 0x02,
62  BITMODE_SYNCBB = 0x04,
63  BITMODE_MCU = 0x08,
64  /* CPU-style fifo mode gets set via EEPROM */
65  BITMODE_OPTO = 0x10,
66  BITMODE_CBUS = 0x20,
67  BITMODE_SYNCFF = 0x40,
68  BITMODE_FT1284 = 0x80,
69 };
70 
73 {
79 };
80 
83 {
86 };
87 
88 /* Shifting commands IN MPSSE Mode*/
89 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
90 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
91 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
92 #define MPSSE_LSB 0x08 /* LSB first */
93 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
94 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
95 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
96 
97 /* FTDI MPSSE commands */
98 #define SET_BITS_LOW 0x80
99 /*BYTE DATA*/
100 /*BYTE Direction*/
101 #define SET_BITS_HIGH 0x82
102 /*BYTE DATA*/
103 /*BYTE Direction*/
104 #define GET_BITS_LOW 0x81
105 #define GET_BITS_HIGH 0x83
106 #define LOOPBACK_START 0x84
107 #define LOOPBACK_END 0x85
108 #define TCK_DIVISOR 0x86
109 /* H Type specific commands */
110 #define DIS_DIV_5 0x8a
111 #define EN_DIV_5 0x8b
112 #define EN_3_PHASE 0x8c
113 #define DIS_3_PHASE 0x8d
114 #define CLK_BITS 0x8e
115 #define CLK_BYTES 0x8f
116 #define CLK_WAIT_HIGH 0x94
117 #define CLK_WAIT_LOW 0x95
118 #define EN_ADAPTIVE 0x96
119 #define DIS_ADAPTIVE 0x97
120 #define CLK_BYTES_OR_HIGH 0x9c
121 #define CLK_BYTES_OR_LOW 0x9d
122 /*FT232H specific commands */
123 #define DRIVE_OPEN_COLLECTOR 0x9e
124 /* Value Low */
125 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
126 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
127 
128 /* Commands in MPSSE and Host Emulation Mode */
129 #define SEND_IMMEDIATE 0x87
130 #define WAIT_ON_HIGH 0x88
131 #define WAIT_ON_LOW 0x89
132 
133 /* Commands in Host Emulation Mode */
134 #define READ_SHORT 0x90
135 /* Address_Low */
136 #define READ_EXTENDED 0x91
137 /* Address High */
138 /* Address Low */
139 #define WRITE_SHORT 0x92
140 /* Address_Low */
141 #define WRITE_EXTENDED 0x93
142 /* Address High */
143 /* Address Low */
144 
145 /* Definitions for flow control */
146 #define SIO_RESET 0 /* Reset the port */
147 #define SIO_MODEM_CTRL 1 /* Set the modem control register */
148 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
149 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
150 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
151 
152 #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
153 #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
154 
155 /* Requests */
156 #define SIO_RESET_REQUEST SIO_RESET
157 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
158 #define SIO_SET_DATA_REQUEST SIO_SET_DATA
159 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
160 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
161 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
162 #define SIO_SET_EVENT_CHAR_REQUEST 0x06
163 #define SIO_SET_ERROR_CHAR_REQUEST 0x07
164 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
165 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
166 #define SIO_SET_BITMODE_REQUEST 0x0B
167 #define SIO_READ_PINS_REQUEST 0x0C
168 #define SIO_READ_EEPROM_REQUEST 0x90
169 #define SIO_WRITE_EEPROM_REQUEST 0x91
170 #define SIO_ERASE_EEPROM_REQUEST 0x92
171 
172 
173 #define SIO_RESET_SIO 0
174 #define SIO_RESET_PURGE_RX 1
175 #define SIO_RESET_PURGE_TX 2
176 
177 #define SIO_DISABLE_FLOW_CTRL 0x0
178 #define SIO_RTS_CTS_HS (0x1 << 8)
179 #define SIO_DTR_DSR_HS (0x2 << 8)
180 #define SIO_XON_XOFF_HS (0x4 << 8)
181 
182 #define SIO_SET_DTR_MASK 0x1
183 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
184 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
185 #define SIO_SET_RTS_MASK 0x2
186 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
187 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
188 
189 #define SIO_RTS_CTS_HS (0x1 << 8)
190 
191 /* marker for unused usb urb structures
192  (taken from libusb) */
193 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
194 
195 #ifdef __GNUC__
196 #define DEPRECATED(func) func __attribute__ ((deprecated))
197 #elif defined(_MSC_VER)
198 #define DEPRECATED(func) __declspec(deprecated) func
199 #else
200 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
201 #define DEPRECATED(func) func
202 #endif
203 
205 {
207  unsigned char *buf;
208  int size;
209  int offset;
211  struct libusb_transfer *transfer;
212 };
213 
220 {
221  /* USB specific */
223  struct libusb_context *usb_ctx;
225  struct libusb_device_handle *usb_dev;
230 
231  /* FTDI specific */
235  int baudrate;
237  unsigned char bitbang_enabled;
239  unsigned char *readbuffer;
241  unsigned int readbuffer_offset;
243  unsigned int readbuffer_remaining;
245  unsigned int readbuffer_chunksize;
247  unsigned int writebuffer_chunksize;
249  unsigned int max_packet_size;
250 
251  /* FTDI FT2232C requirecments */
253  int interface; /* 0 or 1 */
255  int index; /* 1 or 2 */
256  /* Endpoints */
258  int in_ep;
259  int out_ep; /* 1 or 2 */
260 
262  unsigned char bitbang_mode;
263 
266 
268  char *error_str;
269 
272 };
273 
278 {
291  MAX_POWER = 12,
309  INVERT = 30,
322  CHIP_SIZE = 43,
323  CHIP_TYPE = 44,
337 };
338 
343 {
347  struct libusb_device *dev;
348 };
349 #define FT1284_CLK_IDLE_STATE 0x01
350 #define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
351 #define FT1284_FLOW_CONTROL 0x04
352 #define POWER_SAVE_DISABLE_H 0x80
353 
354 #define USE_SERIAL_NUM 0x08
356 {
359  CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc
360 };
361 
363 {
367 };
368 
370 {
376 };
377 
379 #define INVERT_TXD 0x01
380 
381 #define INVERT_RXD 0x02
382 
383 #define INVERT_RTS 0x04
384 
385 #define INVERT_CTS 0x08
386 
387 #define INVERT_DTR 0x10
388 
389 #define INVERT_DSR 0x20
390 
391 #define INVERT_DCD 0x40
392 
393 #define INVERT_RI 0x80
394 
396 #define CHANNEL_IS_UART 0x0
397 #define CHANNEL_IS_FIFO 0x1
398 #define CHANNEL_IS_OPTO 0x2
399 #define CHANNEL_IS_CPU 0x4
400 #define CHANNEL_IS_FT1284 0x8
401 
402 #define CHANNEL_IS_RS485 0x10
403 
404 #define DRIVE_4MA 0
405 #define DRIVE_8MA 1
406 #define DRIVE_12MA 2
407 #define DRIVE_16MA 3
408 #define SLOW_SLEW 4
409 #define IS_SCHMITT 8
410 
412 #define DRIVER_VCP 0x08
413 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
414 
415 #define USE_USB_VERSION_BIT 0x10
416 
417 #define SUSPEND_DBUS7_BIT 0x80
418 
420 #define HIGH_CURRENT_DRIVE 0x10
421 #define HIGH_CURRENT_DRIVE_R 0x04
422 
427 {
428  uint64_t totalBytes;
429  struct timeval time;
430 };
431 
432 typedef struct
433 {
434  struct size_and_time first;
435  struct size_and_time prev;
436  struct size_and_time current;
437  double totalTime;
438  double totalRate;
439  double currentRate;
441 
442 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
443  FTDIProgressInfo *progress, void *userdata);
444 
454 {
455  int major;
456  int minor;
457  int micro;
458  const char *version_str;
459  const char *snapshot_str;
460 };
461 
462 
463 #ifdef __cplusplus
464 extern "C"
465 {
466 #endif
467 
468  int ftdi_init(struct ftdi_context *ftdi);
469  struct ftdi_context *ftdi_new(void);
471 
472  void ftdi_deinit(struct ftdi_context *ftdi);
473  void ftdi_free(struct ftdi_context *ftdi);
474  void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
475 
477 
478  int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
479  int vendor, int product);
480  void ftdi_list_free(struct ftdi_device_list **devlist);
481  void ftdi_list_free2(struct ftdi_device_list *devlist);
482  int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
483  char *manufacturer, int mnf_len,
484  char *description, int desc_len,
485  char *serial, int serial_len);
486  int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev,
487  char *manufacturer, int mnf_len,
488  char *description, int desc_len,
489  char *serial, int serial_len);
490  int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer,
491  char * product, char * serial);
492 
493  int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
494  int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
495  const char* description, const char* serial);
496  int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
497  const char* description, const char* serial, unsigned int index);
498  int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
499  int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
500 
501  int ftdi_usb_close(struct ftdi_context *ftdi);
502  int ftdi_usb_reset(struct ftdi_context *ftdi);
503  int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
504  int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
505  int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
506 
507  int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
508  int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
509  enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
510  int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
511  enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
512  enum ftdi_break_type break_type);
513 
514  int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
515  int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
516  int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
517 
518  int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size);
519  int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
520  int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
521 
522  int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
523  void *userdata, int packetsPerTransfer, int numTransfers);
524  struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
525 
526  struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
528  void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc, struct timeval * to);
529 
530  int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
532  int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
533 
534  int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
535  int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
536 
537  int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
538 
539  /* flow control */
540  int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
541  int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
542  int ftdi_setdtr(struct ftdi_context *ftdi, int state);
543  int ftdi_setrts(struct ftdi_context *ftdi, int state);
544 
545  int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
546  int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
547 
548  /* init eeprom for the given FTDI type */
550  char * manufacturer, char *product,
551  char * serial);
552  int ftdi_eeprom_build(struct ftdi_context *ftdi);
553  int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
554 
555  int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
556  int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
557 
558  int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
559  int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
560 
561  int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size);
562 
563  int ftdi_read_eeprom(struct ftdi_context *ftdi);
564  int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
565  int ftdi_write_eeprom(struct ftdi_context *ftdi);
566  int ftdi_erase_eeprom(struct ftdi_context *ftdi);
567 
568  int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
569  int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
570 
571  char *ftdi_get_error_string(struct ftdi_context *ftdi);
572 
573 #ifdef __cplusplus
574 }
575 #endif
576 
577 #endif /* __libftdi_h__ */
ftdi_readstream
int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback, void *userdata, int packetsPerTransfer, int numTransfers)
Definition: ftdi_stream.c:147
ftdi_mpsse_mode
ftdi_mpsse_mode
Definition: ftdi.h:57
CBUS_TXRXLED
@ CBUS_TXRXLED
Definition: ftdi.h:357
CBUSH_CLK15
@ CBUSH_CLK15
Definition: ftdi.h:366
BITMODE_CBUS
@ BITMODE_CBUS
Definition: ftdi.h:66
ftdi_set_eeprom_value
int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
Definition: ftdi.c:3920
GROUP2_SCHMITT
@ GROUP2_SCHMITT
Definition: ftdi.h:317
TYPE_4232H
@ TYPE_4232H
Definition: ftdi.h:55
ftdi_context::readbuffer
unsigned char * readbuffer
Definition: ftdi.h:239
CHANNEL_C_DRIVER
@ CHANNEL_C_DRIVER
Definition: ftdi.h:328
GROUP3_SLEW
@ GROUP3_SLEW
Definition: ftdi.h:321
ftdi_transfer_control::ftdi
struct ftdi_context * ftdi
Definition: ftdi.h:210
ftdi_read_data_submit
struct ftdi_transfer_control * ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1656
FTDIProgressInfo
Definition: ftdi.h:432
CBUS_RXLED
@ CBUS_RXLED
Definition: ftdi.h:357
CBUS_BB_RD
@ CBUS_BB_RD
Definition: ftdi.h:359
TYPE_BM
@ TYPE_BM
Definition: ftdi.h:51
TYPE_R
@ TYPE_R
Definition: ftdi.h:53
BITMODE_OPTO
@ BITMODE_OPTO
Definition: ftdi.h:65
HIGH_CURRENT_B
@ HIGH_CURRENT_B
Definition: ftdi.h:308
ftdi_context::module_detach_mode
enum ftdi_module_detach_mode module_detach_mode
Definition: ftdi.h:271
ftdi_get_eeprom_value
int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
Definition: ftdi.c:3727
USB_VERSION
@ USB_VERSION
Definition: ftdi.h:289
FTDIProgressInfo::totalRate
double totalRate
Definition: ftdi.h:438
ftdi_context::in_ep
int in_ep
Definition: ftdi.h:258
ftdi_usb_close
int ftdi_usb_close(struct ftdi_context *ftdi)
Definition: ftdi.c:1048
ftdi_setdtr
int ftdi_setdtr(struct ftdi_context *ftdi, int state)
Definition: ftdi.c:2246
CBUSX_BB_WR
@ CBUSX_BB_WR
Definition: ftdi.h:375
ftdi_set_usbdev
void ftdi_set_usbdev(struct ftdi_context *ftdi, struct libusb_device_handle *usbdev)
Definition: ftdi.c:268
ftdi_stopbits_type
ftdi_stopbits_type
Definition: ftdi.h:50
CBUSX_BAT_DETECT_NEG
@ CBUSX_BAT_DETECT_NEG
Definition: ftdi.h:374
AUTO_DETACH_SIO_MODULE
@ AUTO_DETACH_SIO_MODULE
Definition: ftdi.h:84
ftdi_get_latency_timer
int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
Definition: ftdi.c:2143
ftdi_set_eeprom_buf
int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char *buf, int size)
Definition: ftdi.c:4142
ftdi_usb_get_strings2
int ftdi_usb_get_strings2(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:466
GROUP1_SLEW
@ GROUP1_SLEW
Definition: ftdi.h:315
ftdi_transfer_control
Definition: ftdi.h:204
ftdi_poll_modem_status
int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
Definition: ftdi.c:2197
INTERFACE_D
@ INTERFACE_D
Definition: ftdi.h:78
ftdi_set_eeprom_user_data
int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char *buf, int size)
Definition: ftdi.c:4165
CBUSX_CLK12
@ CBUSX_CLK12
Definition: ftdi.h:373
ftdi_context::readbuffer_chunksize
unsigned int readbuffer_chunksize
Definition: ftdi.h:245
ftdi_transfer_control::completed
int completed
Definition: ftdi.h:206
CBUSX_TXDEN
@ CBUSX_TXDEN
Definition: ftdi.h:372
CBUSX_IOMODE
@ CBUSX_IOMODE
Definition: ftdi.h:372
CHANNEL_A_TYPE
@ CHANNEL_A_TYPE
Definition: ftdi.h:292
CBUSX_CLK24
@ CBUSX_CLK24
Definition: ftdi.h:373
ftdi_context::bitbang_mode
unsigned char bitbang_mode
Definition: ftdi.h:262
CBUSH_TXDEN
@ CBUSH_TXDEN
Definition: ftdi.h:365
SUSPEND_PULL_DOWNS
@ SUSPEND_PULL_DOWNS
Definition: ftdi.h:287
ftdi_set_error_char
int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable)
Definition: ftdi.c:2372
CBUSX_I2C_TXE
@ CBUSX_I2C_TXE
Definition: ftdi.h:374
CHANNEL_A_DRIVER
@ CHANNEL_A_DRIVER
Definition: ftdi.h:294
ftdi_transfer_control::transfer
struct libusb_transfer * transfer
Definition: ftdi.h:211
ftdi_usb_purge_buffers
int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
Definition: ftdi.c:1019
HIGH_CURRENT
@ HIGH_CURRENT
Definition: ftdi.h:306
CBUS_FUNCTION_3
@ CBUS_FUNCTION_3
Definition: ftdi.h:299
ftdi_transfer_data_done
int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
Definition: ftdi.c:1735
USE_USB_VERSION
@ USE_USB_VERSION
Definition: ftdi.h:290
ftdi_deinit
void ftdi_deinit(struct ftdi_context *ftdi)
Definition: ftdi.c:210
ftdi_get_error_string
char * ftdi_get_error_string(struct ftdi_context *ftdi)
Definition: ftdi.c:4476
CHANNEL_B_RS485
@ CHANNEL_B_RS485
Definition: ftdi.h:331
ftdi_eeprom_set_strings
int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char *manufacturer, char *product, char *serial)
Definition: ftdi.c:2550
CBUSX_VBUS_SENSE
@ CBUSX_VBUS_SENSE
Definition: ftdi.h:374
ftdi_read_data_set_chunksize
int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
Definition: ftdi.c:1983
ftdi_device_list::dev
struct libusb_device * dev
Definition: ftdi.h:347
size_and_time::totalBytes
uint64_t totalBytes
Definition: ftdi.h:428
NONE
@ NONE
Definition: ftdi.h:48
CHANNEL_B_TYPE
@ CHANNEL_B_TYPE
Definition: ftdi.h:293
ftdi_cbus_func
ftdi_cbus_func
Definition: ftdi.h:355
STOP_BIT_1
@ STOP_BIT_1
Definition: ftdi.h:50
ftdi_context::eeprom
struct ftdi_eeprom * eeprom
Definition: ftdi.h:265
ftdi_get_library_version
struct ftdi_version_info ftdi_get_library_version(void)
Get libftdi library version.
Definition: ftdi.c:281
ftdi_context::type
enum ftdi_chip_type type
Definition: ftdi.h:233
ftdi_context::out_ep
int out_ep
Definition: ftdi.h:259
CBUS_TXLED
@ CBUS_TXLED
Definition: ftdi.h:357
GROUP0_SCHMITT
@ GROUP0_SCHMITT
Definition: ftdi.h:311
CBUS_FUNCTION_8
@ CBUS_FUNCTION_8
Definition: ftdi.h:304
GROUP2_DRIVE
@ GROUP2_DRIVE
Definition: ftdi.h:316
ftdi_version_info::minor
int minor
Definition: ftdi.h:456
CBUSX_TXRXLED
@ CBUSX_TXRXLED
Definition: ftdi.h:371
CBUS_FUNCTION_2
@ CBUS_FUNCTION_2
Definition: ftdi.h:298
GROUP0_DRIVE
@ GROUP0_DRIVE
Definition: ftdi.h:310
PRODUCT_ID
@ PRODUCT_ID
Definition: ftdi.h:280
FTDIProgressInfo::currentRate
double currentRate
Definition: ftdi.h:439
CBUSH_SLEEP
@ CBUSH_SLEEP
Definition: ftdi.h:365
ftdi_break_type
ftdi_break_type
Definition: ftdi.h:54
GROUP1_DRIVE
@ GROUP1_DRIVE
Definition: ftdi.h:313
CBUSX_SLEEP
@ CBUSX_SLEEP
Definition: ftdi.h:372
ftdi_cbush_func
ftdi_cbush_func
Definition: ftdi.h:362
ftdi_context::bitbang_enabled
unsigned char bitbang_enabled
Definition: ftdi.h:237
ftdi_set_bitmode
int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
Definition: ftdi.c:2041
CBUSX_PWREN
@ CBUSX_PWREN
Definition: ftdi.h:371
SPACE
@ SPACE
Definition: ftdi.h:48
ftdi_write_eeprom_location
int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val)
Definition: ftdi.c:4303
ftdi_usb_open_dev
int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev)
Definition: ftdi.c:584
ftdi_write_data_set_chunksize
int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
Definition: ftdi.c:1816
CBUSH_CLK7_5
@ CBUSH_CLK7_5
Definition: ftdi.h:366
INTERFACE_ANY
@ INTERFACE_ANY
Definition: ftdi.h:74
TYPE_2232H
@ TYPE_2232H
Definition: ftdi.h:54
ftdi_setflowctrl
int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
Definition: ftdi.c:2223
MAX_POWER
@ MAX_POWER
Definition: ftdi.h:291
ftdi_parity_type
ftdi_parity_type
Definition: ftdi.h:48
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:723
INTERFACE_C
@ INTERFACE_C
Definition: ftdi.h:77
BITMODE_BITBANG
@ BITMODE_BITBANG
Definition: ftdi.h:60
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:753
EVEN
@ EVEN
Definition: ftdi.h:48
CBUSX_DRIVE_0
@ CBUSX_DRIVE_0
Definition: ftdi.h:372
CBUS_CLK6
@ CBUS_CLK6
Definition: ftdi.h:358
ftdi_new
struct ftdi_context * ftdi_new(void)
Definition: ftdi.c:128
CBUSX_AWAKE
@ CBUSX_AWAKE
Definition: ftdi.h:375
ftdi_context::readbuffer_remaining
unsigned int readbuffer_remaining
Definition: ftdi.h:243
CBUSH_RXLED
@ CBUSH_RXLED
Definition: ftdi.h:364
GROUP3_SCHMITT
@ GROUP3_SCHMITT
Definition: ftdi.h:320
VENDOR_ID
@ VENDOR_ID
Definition: ftdi.h:279
ftdi_erase_eeprom
int ftdi_erase_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4414
STOP_BIT_2
@ STOP_BIT_2
Definition: ftdi.h:50
CBUS_FUNCTION_4
@ CBUS_FUNCTION_4
Definition: ftdi.h:300
ftdi_setrts
int ftdi_setrts(struct ftdi_context *ftdi, int state)
Definition: ftdi.c:2276
CHANNEL_C_RS485
@ CHANNEL_C_RS485
Definition: ftdi.h:332
CBUSH_TRISTATE
@ CBUSH_TRISTATE
Definition: ftdi.h:364
CBUSX_RXLED
@ CBUSX_RXLED
Definition: ftdi.h:371
BITMODE_MPSSE
@ BITMODE_MPSSE
Definition: ftdi.h:61
ftdi_get_eeprom_buf
int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:4116
CBUS_CLK12
@ CBUS_CLK12
Definition: ftdi.h:358
CHIP_SIZE
@ CHIP_SIZE
Definition: ftdi.h:322
CHIP_TYPE
@ CHIP_TYPE
Definition: ftdi.h:323
ftdi_usb_open_string
int ftdi_usb_open_string(struct ftdi_context *ftdi, const char *description)
Definition: ftdi.c:851
ftdi_list_free2
void ftdi_list_free2(struct ftdi_device_list *devlist)
Definition: ftdi.c:378
GROUP3_DRIVE
@ GROUP3_DRIVE
Definition: ftdi.h:319
ftdi_set_event_char
int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable)
Definition: ftdi.c:2343
CBUSH_DRIVE1
@ CBUSH_DRIVE1
Definition: ftdi.h:365
CBUSX_I2C_RXF
@ CBUSX_I2C_RXF
Definition: ftdi.h:374
MARK
@ MARK
Definition: ftdi.h:48
ftdi_context::usb_ctx
struct libusb_context * usb_ctx
Definition: ftdi.h:223
CHANNEL_A_RS485
@ CHANNEL_A_RS485
Definition: ftdi.h:330
ftdi_read_eeprom_location
int ftdi_read_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
Definition: ftdi.c:4186
CBUSX_CLK6
@ CBUSX_CLK6
Definition: ftdi.h:373
DONT_DETACH_SIO_MODULE
@ DONT_DETACH_SIO_MODULE
Definition: ftdi.h:85
RELEASE_NUMBER
@ RELEASE_NUMBER
Definition: ftdi.h:334
FLOW_CONTROL
@ FLOW_CONTROL
Definition: ftdi.h:327
ftdi_read_chipid
int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
Definition: ftdi.c:4265
TYPE_230X
@ TYPE_230X
Definition: ftdi.h:57
ftdi_context::baudrate
int baudrate
Definition: ftdi.h:235
TYPE_232H
@ TYPE_232H
Definition: ftdi.h:56
ftdi_device_list
list of usb devices created by ftdi_usb_find_all()
Definition: ftdi.h:342
ftdi_eeprom_initdefaults
int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char *manufacturer, char *product, char *serial)
Definition: ftdi.c:2402
CBUS_FUNCTION_5
@ CBUS_FUNCTION_5
Definition: ftdi.h:301
FTDIStreamCallback
int() FTDIStreamCallback(uint8_t *buffer, int length, FTDIProgressInfo *progress, void *userdata)
Definition: ftdi.h:442
ftdi_read_eeprom
int ftdi_read_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4206
INVERT
@ INVERT
Definition: ftdi.h:309
ftdi_read_data
int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1858
ftdi_context::error_str
char * error_str
Definition: ftdi.h:268
ftdi_eeprom_value
ftdi_eeprom_value
Definition: ftdi.h:277
FTDIProgressInfo::totalTime
double totalTime
Definition: ftdi.h:437
ftdi_eeprom_build
int ftdi_eeprom_build(struct ftdi_context *ftdi)
Definition: ftdi.c:2669
INTERFACE_A
@ INTERFACE_A
Definition: ftdi.h:75
ftdi_transfer_control::offset
int offset
Definition: ftdi.h:209
ftdi_set_latency_timer
int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
Definition: ftdi.c:2116
BITMODE_FT1284
@ BITMODE_FT1284
Definition: ftdi.h:68
ftdi_chip_type
ftdi_chip_type
Definition: ftdi.h:36
ftdi_list_free
void ftdi_list_free(struct ftdi_device_list **devlist)
Definition: ftdi.c:358
CBUS_PWREN
@ CBUS_PWREN
Definition: ftdi.h:357
ftdi_context::usb_write_timeout
int usb_write_timeout
Definition: ftdi.h:229
CBUSX_BB_RD
@ CBUSX_BB_RD
Definition: ftdi.h:375
ftdi_read_pins
int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
Definition: ftdi.c:2090
ftdi_version_info::major
int major
Definition: ftdi.h:455
GROUP0_SLEW
@ GROUP0_SLEW
Definition: ftdi.h:312
ftdi_context::usb_dev
struct libusb_device_handle * usb_dev
Definition: ftdi.h:225
CBUS_TXDEN
@ CBUS_TXDEN
Definition: ftdi.h:357
ftdi_read_data_get_chunksize
int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
Definition: ftdi.c:2020
ftdi_usb_purge_rx_buffer
int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
Definition: ftdi.c:970
GROUP1_SCHMITT
@ GROUP1_SCHMITT
Definition: ftdi.h:314
BITMODE_MCU
@ BITMODE_MCU
Definition: ftdi.h:63
CHANNEL_B_DRIVER
@ CHANNEL_B_DRIVER
Definition: ftdi.h:295
ftdi_usb_purge_tx_buffer
int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
Definition: ftdi.c:996
ftdi_usb_open
int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
Definition: ftdi.c:697
CBUSX_TRISTATE
@ CBUSX_TRISTATE
Definition: ftdi.h:371
CBUS_BB_WR
@ CBUS_BB_WR
Definition: ftdi.h:359
EXTERNAL_OSCILLATOR
@ EXTERNAL_OSCILLATOR
Definition: ftdi.h:335
CBUS_CLK48
@ CBUS_CLK48
Definition: ftdi.h:358
BITMODE_RESET
@ BITMODE_RESET
Definition: ftdi.h:59
ftdi_device_list::next
struct ftdi_device_list * next
Definition: ftdi.h:345
CBUS_CLK24
@ CBUS_CLK24
Definition: ftdi.h:358
CBUS_FUNCTION_1
@ CBUS_FUNCTION_1
Definition: ftdi.h:297
CBUSH_CLK30
@ CBUSH_CLK30
Definition: ftdi.h:366
ftdi_cbusx_func
ftdi_cbusx_func
Definition: ftdi.h:369
size_and_time
Progress Info for streaming read.
Definition: ftdi.h:426
CBUSH_PWREN
@ CBUSH_PWREN
Definition: ftdi.h:364
ftdi_version_info
Definition: ftdi.h:453
ftdi_context
Main context structure for all libftdi functions.
Definition: ftdi.h:219
size_and_time::time
struct timeval time
Definition: ftdi.h:429
BREAK_OFF
@ BREAK_OFF
Definition: ftdi.h:54
CBUSX_BAT_DETECT
@ CBUSX_BAT_DETECT
Definition: ftdi.h:373
ftdi_transfer_data_cancel
void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc, struct timeval *to)
Definition: ftdi.c:1782
TYPE_AM
@ TYPE_AM
Definition: ftdi.h:50
POWER_SAVE
@ POWER_SAVE
Definition: ftdi.h:324
HIGH_CURRENT_A
@ HIGH_CURRENT_A
Definition: ftdi.h:307
ftdi_version_info::snapshot_str
const char * snapshot_str
Definition: ftdi.h:459
ftdi_set_baudrate
int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
Definition: ftdi.c:1299
CBUSX_TXLED
@ CBUSX_TXLED
Definition: ftdi.h:371
ftdi_write_data_get_chunksize
int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
Definition: ftdi.c:1834
ODD
@ ODD
Definition: ftdi.h:48
CBUSX_TIME_STAMP
@ CBUSX_TIME_STAMP
Definition: ftdi.h:375
BITMODE_SYNCBB
@ BITMODE_SYNCBB
Definition: ftdi.h:62
DATA_ORDER
@ DATA_ORDER
Definition: ftdi.h:326
ftdi_write_data_submit
struct ftdi_transfer_control * ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
Definition: ftdi.c:1594
ftdi_module_detach_mode
ftdi_module_detach_mode
Definition: ftdi.h:82
OUT_IS_ISOCHRONOUS
@ OUT_IS_ISOCHRONOUS
Definition: ftdi.h:286
ftdi_context::writebuffer_chunksize
unsigned int writebuffer_chunksize
Definition: ftdi.h:247
STOP_BIT_15
@ STOP_BIT_15
Definition: ftdi.h:50
ftdi_disable_bitbang
int ftdi_disable_bitbang(struct ftdi_context *ftdi)
Definition: ftdi.c:2067
ftdi_bits_type
ftdi_bits_type
Definition: ftdi.h:52
ftdi_transfer_control::size
int size
Definition: ftdi.h:208
ftdi_write_eeprom
int ftdi_write_eeprom(struct ftdi_context *ftdi)
Definition: ftdi.c:4359
BITS_7
@ BITS_7
Definition: ftdi.h:52
CLOCK_POLARITY
@ CLOCK_POLARITY
Definition: ftdi.h:325
USER_DATA_ADDR
@ USER_DATA_ADDR
Definition: ftdi.h:336
ftdi_set_interface
int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
Definition: ftdi.c:157
CBUSH_TXLED
@ CBUSH_TXLED
Definition: ftdi.h:364
CBUS_IOMODE
@ CBUS_IOMODE
Definition: ftdi.h:359
INTERFACE_B
@ INTERFACE_B
Definition: ftdi.h:76
ftdi_free
void ftdi_free(struct ftdi_context *ftdi)
Definition: ftdi.c:256
CBUSH_TXRXLED
@ CBUSH_TXRXLED
Definition: ftdi.h:364
CBUS_SLEEP
@ CBUS_SLEEP
Definition: ftdi.h:358
ftdi_init
int ftdi_init(struct ftdi_context *ftdi)
Definition: ftdi.c:88
USE_SERIAL
@ USE_SERIAL
Definition: ftdi.h:288
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:2307
GROUP2_SLEW
@ GROUP2_SLEW
Definition: ftdi.h:318
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
IN_IS_ISOCHRONOUS
@ IN_IS_ISOCHRONOUS
Definition: ftdi.h:285
ftdi_context::interface
int interface
Definition: ftdi.h:253
TYPE_2232C
@ TYPE_2232C
Definition: ftdi.h:52
ftdi_version_info::micro
int micro
Definition: ftdi.h:457
REMOTE_WAKEUP
@ REMOTE_WAKEUP
Definition: ftdi.h:282
CBUS_FUNCTION_9
@ CBUS_FUNCTION_9
Definition: ftdi.h:305
ftdi_context::readbuffer_offset
unsigned int readbuffer_offset
Definition: ftdi.h:241
ftdi_eeprom_decode
int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
Definition: ftdi.c:3297
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
CBUS_FUNCTION_6
@ CBUS_FUNCTION_6
Definition: ftdi.h:302
CBUS_FUNCTION_0
@ CBUS_FUNCTION_0
Definition: ftdi.h:296
ftdi_write_data
int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size)
Definition: ftdi.c:1434
ftdi_interface
ftdi_interface
Definition: ftdi.h:72
CHANNEL_D_RS485
@ CHANNEL_D_RS485
Definition: ftdi.h:333
ftdi_usb_reset
int ftdi_usb_reset(struct ftdi_context *ftdi)
Definition: ftdi.c:944
ftdi_context::max_packet_size
unsigned int max_packet_size
Definition: ftdi.h:249
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:1345
SELF_POWERED
@ SELF_POWERED
Definition: ftdi.h:281
SUSPEND_DBUS7
@ SUSPEND_DBUS7
Definition: ftdi.h:284
BITMODE_SYNCFF
@ BITMODE_SYNCFF
Definition: ftdi.h:67
CBUSX_DRIVE1
@ CBUSX_DRIVE1
Definition: ftdi.h:372
BREAK_ON
@ BREAK_ON
Definition: ftdi.h:54
ftdi_transfer_control::buf
unsigned char * buf
Definition: ftdi.h:207
CHANNEL_D_DRIVER
@ CHANNEL_D_DRIVER
Definition: ftdi.h:329
ftdi_context::usb_read_timeout
int usb_read_timeout
Definition: ftdi.h:227
BITS_8
@ BITS_8
Definition: ftdi.h:52
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:1364
ftdi_version_info::version_str
const char * version_str
Definition: ftdi.h:458
IS_NOT_PNP
@ IS_NOT_PNP
Definition: ftdi.h:283
CBUS_FUNCTION_7
@ CBUS_FUNCTION_7
Definition: ftdi.h:303
ftdi_eeprom
FTDI eeprom structure.
Definition: ftdi_i.h:30
CBUSH_DRIVE_0
@ CBUSH_DRIVE_0
Definition: ftdi.h:365
CBUSH_IOMODE
@ CBUSH_IOMODE
Definition: ftdi.h:365