1 /***************************************************************************
5 copyright : (C) 2003-2014 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
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; *
15 ***************************************************************************/
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)
30 #if defined(interface)
47 /** Parity mode for ftdi_set_line_property() */
48 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
49 /** Number of stop bits for ftdi_set_line_property() */
50 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
51 /** Number of bits for ftdi_set_line_property() */
52 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
53 /** Break type for ftdi_set_line_property2() */
54 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
56 /** MPSSE bitbang modes */
59 BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
60 BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
61 BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
62 BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
63 BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
64 /* CPU-style fifo mode gets set via EEPROM */
65 BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
66 BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
67 BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
68 BITMODE_FT1284 = 0x80, /**< FT1284 mode, available on 232H chips */
71 /** Port interface for chips with multiple interfaces */
81 /** Automatic loading / unloading of kernel modules */
82 enum ftdi_module_detach_mode
84 AUTO_DETACH_SIO_MODULE = 0,
85 DONT_DETACH_SIO_MODULE = 1
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 */
97 /* FTDI MPSSE commands */
98 #define SET_BITS_LOW 0x80
101 #define SET_BITS_HIGH 0x82
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 0x0d
122 /*FT232H specific commands */
123 #define DRIVE_OPEN_COLLECTOR 0x9e
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)
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
133 /* Commands in Host Emulation Mode */
134 #define READ_SHORT 0x90
136 #define READ_EXTENDED 0x91
139 #define WRITE_SHORT 0x92
141 #define WRITE_EXTENDED 0x93
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 */
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)
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
173 #define SIO_RESET_SIO 0
174 #define SIO_RESET_PURGE_RX 1
175 #define SIO_RESET_PURGE_TX 2
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)
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 ))
189 #define SIO_RTS_CTS_HS (0x1 << 8)
191 /* marker for unused usb urb structures
192 (taken from libusb) */
193 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
196 #define DEPRECATED(func) func __attribute__ ((deprecated))
197 #elif defined(_MSC_VER)
198 #define DEPRECATED(func) __declspec(deprecated) func
200 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
201 #define DEPRECATED(func) func
204 struct ftdi_transfer_control
210 struct ftdi_context *ftdi;
211 struct libusb_transfer *transfer;
215 \brief Main context structure for all libftdi functions.
217 Do not access directly if possible.
222 /** libusb's context */
223 struct libusb_context *usb_ctx;
224 /** libusb's usb_dev_handle */
225 struct libusb_device_handle *usb_dev;
226 /** usb read timeout */
227 int usb_read_timeout;
228 /** usb write timeout */
229 int usb_write_timeout;
232 /** FTDI chip type */
233 enum ftdi_chip_type type;
236 /** bitbang mode state */
237 unsigned char bitbang_enabled;
238 /** pointer to read buffer for ftdi_read_data */
239 unsigned char *readbuffer;
240 /** read buffer offset */
241 unsigned int readbuffer_offset;
242 /** number of remaining data in internal read buffer */
243 unsigned int readbuffer_remaining;
244 /** read buffer chunk size */
245 unsigned int readbuffer_chunksize;
246 /** write buffer chunk size */
247 unsigned int writebuffer_chunksize;
248 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
249 unsigned int max_packet_size;
251 /* FTDI FT2232C requirecments */
252 /** FT2232C interface number: 0 or 1 */
253 int interface; /* 0 or 1 */
254 /** FT2232C index number: 1 or 2 */
255 int index; /* 1 or 2 */
257 /** FT2232C end points: 1 or 2 */
259 int out_ep; /* 1 or 2 */
261 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
262 unsigned char bitbang_mode;
264 /** Decoded eeprom structure */
265 struct ftdi_eeprom *eeprom;
267 /** String representation of last error */
270 /** Defines behavior in case a kernel module is already attached to the device */
271 enum ftdi_module_detach_mode module_detach_mode;
275 List all handled EEPROM values.
276 Append future new values only at the end to provide API/ABI stability*/
277 enum ftdi_eeprom_value
285 IN_IS_ISOCHRONOUS = 6,
286 OUT_IS_ISOCHRONOUS = 7,
287 SUSPEND_PULL_DOWNS = 8,
290 USE_USB_VERSION = 11,
294 CHANNEL_A_DRIVER = 15,
295 CHANNEL_B_DRIVER = 16,
296 CBUS_FUNCTION_0 = 17,
297 CBUS_FUNCTION_1 = 18,
298 CBUS_FUNCTION_2 = 19,
299 CBUS_FUNCTION_3 = 20,
300 CBUS_FUNCTION_4 = 21,
301 CBUS_FUNCTION_5 = 22,
302 CBUS_FUNCTION_6 = 23,
303 CBUS_FUNCTION_7 = 24,
304 CBUS_FUNCTION_8 = 25,
305 CBUS_FUNCTION_9 = 26,
328 CHANNEL_C_DRIVER = 49,
329 CHANNEL_D_DRIVER = 50,
330 CHANNEL_A_RS485 = 51,
331 CHANNEL_B_RS485 = 52,
332 CHANNEL_C_RS485 = 53,
333 CHANNEL_D_RS485 = 54,
338 \brief list of usb devices created by ftdi_usb_find_all()
340 struct ftdi_device_list
342 /** pointer to next entry */
343 struct ftdi_device_list *next;
344 /** pointer to libusb's usb_device */
345 struct libusb_device *dev;
347 #define FT1284_CLK_IDLE_STATE 0x01
348 #define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
349 #define FT1284_FLOW_CONTROL 0x04
350 #define POWER_SAVE_DISABLE_H 0x80
352 #define USE_SERIAL_NUM 0x08
353 enum ftdi_cbus_func /* FIXME: Recheck value, especially the last */
355 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
356 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
357 CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd
360 enum ftdi_cbush_func /* FIXME: Recheck value, especially the last */
362 CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4,
363 CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9,
364 CBUSH_CLK30 = 10, CBUSH_CLK15 = 11, CBUSH_CLK7_5 = 12, CBUSH_BAT_DETECT = 13,
365 CBUSH_BAT_DETECT_NEG = 14, CBUSH_I2C_TXE = 15, CBUSH_I2C_RXF = 16, CBUSH_VBUS_SENSE = 17,
366 CBUSH_BB_WR = 18, CBUSH_BB_RD = 19, CBUSH_TIME_STAMP = 20, CBUSH_AWAKE = 21,
370 #define INVERT_TXD 0x01
372 #define INVERT_RXD 0x02
374 #define INVERT_RTS 0x04
376 #define INVERT_CTS 0x08
378 #define INVERT_DTR 0x10
380 #define INVERT_DSR 0x20
382 #define INVERT_DCD 0x40
384 #define INVERT_RI 0x80
386 /** Interface Mode. */
387 #define CHANNEL_IS_UART 0x0
388 #define CHANNEL_IS_FIFO 0x1
389 #define CHANNEL_IS_OPTO 0x2
390 #define CHANNEL_IS_CPU 0x4
391 #define CHANNEL_IS_FT1284 0x8
393 #define CHANNEL_IS_RS485 0x10
403 #define DRIVER_VCP 0x08
404 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
406 #define USE_USB_VERSION_BIT 0x10
408 #define SUSPEND_DBUS7_BIT 0x80
410 /** High current drive. */
411 #define HIGH_CURRENT_DRIVE 0x10
412 #define HIGH_CURRENT_DRIVE_R 0x04
415 \brief Progress Info for streaming read
425 struct size_and_time first;
426 struct size_and_time prev;
427 struct size_and_time current;
433 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
434 FTDIProgressInfo *progress, void *userdata);
437 * Provide libftdi version information
438 * major: Library major version
439 * minor: Library minor version
440 * micro: Currently unused, ight get used for hotfixes.
441 * version_str: Version as (static) string
442 * snapshot_str: Git snapshot version if known. Otherwise "unknown" or empty string.
444 struct ftdi_version_info
449 const char *version_str;
450 const char *snapshot_str;
459 int ftdi_init(struct ftdi_context *ftdi);
460 struct ftdi_context *ftdi_new(void);
461 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
463 void ftdi_deinit(struct ftdi_context *ftdi);
464 void ftdi_free(struct ftdi_context *ftdi);
465 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
467 struct ftdi_version_info ftdi_get_library_version(void);
469 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
470 int vendor, int product);
471 void ftdi_list_free(struct ftdi_device_list **devlist);
472 void ftdi_list_free2(struct ftdi_device_list *devlist);
473 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
474 char * manufacturer, int mnf_len,
475 char * description, int desc_len,
476 char * serial, int serial_len);
477 int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer,
478 char * product, char * serial);
480 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
481 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
482 const char* description, const char* serial);
483 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
484 const char* description, const char* serial, unsigned int index);
485 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
486 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
488 int ftdi_usb_close(struct ftdi_context *ftdi);
489 int ftdi_usb_reset(struct ftdi_context *ftdi);
490 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
491 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
492 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
494 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
495 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
496 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
497 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
498 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
499 enum ftdi_break_type break_type);
501 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
502 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
503 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
505 int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size);
506 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
507 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
509 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
510 void *userdata, int packetsPerTransfer, int numTransfers);
511 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
513 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
514 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
516 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
517 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
518 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
520 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
521 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
523 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
526 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
527 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
528 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
529 int ftdi_setrts(struct ftdi_context *ftdi, int state);
531 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
532 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
534 /* init eeprom for the given FTDI type */
535 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
536 char * manufacturer, char *product,
538 int ftdi_eeprom_build(struct ftdi_context *ftdi);
539 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
541 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
542 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
544 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
545 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
547 int ftdi_read_eeprom(struct ftdi_context *ftdi);
548 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
549 int ftdi_write_eeprom(struct ftdi_context *ftdi);
550 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
552 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
553 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
555 char *ftdi_get_error_string(struct ftdi_context *ftdi);
561 #endif /* __libftdi_h__ */