libftdi1: ftdi.h Source File

libftdi1 1.4

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