1 /***************************************************************************
5 copyright : (C) 2003-2017 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 ***************************************************************************/
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)
32 #if defined(interface)
49 /** Parity mode for ftdi_set_line_property() */
50 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
51 /** Number of stop bits for ftdi_set_line_property() */
52 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
53 /** Number of bits for ftdi_set_line_property() */
54 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
55 /** Break type for ftdi_set_line_property2() */
56 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
58 /** MPSSE bitbang modes */
61 BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
62 BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
63 BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
64 BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
65 BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
66 /* CPU-style fifo mode gets set via EEPROM */
67 BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
68 BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
69 BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
70 BITMODE_FT1284 = 0x80, /**< FT1284 mode, available on 232H chips */
73 /** Port interface for chips with multiple interfaces */
83 /** Automatic loading / unloading of kernel modules */
84 enum ftdi_module_detach_mode
86 AUTO_DETACH_SIO_MODULE = 0,
87 DONT_DETACH_SIO_MODULE = 1
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 */
99 /* FTDI MPSSE commands */
100 #define SET_BITS_LOW 0x80
103 #define SET_BITS_HIGH 0x82
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
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)
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
135 /* Commands in Host Emulation Mode */
136 #define READ_SHORT 0x90
138 #define READ_EXTENDED 0x91
141 #define WRITE_SHORT 0x92
143 #define WRITE_EXTENDED 0x93
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 */
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)
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
175 #define SIO_RESET_SIO 0
176 #define SIO_RESET_PURGE_RX 1
177 #define SIO_RESET_PURGE_TX 2
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)
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 ))
191 #define SIO_RTS_CTS_HS (0x1 << 8)
193 /* marker for unused usb urb structures
194 (taken from libusb) */
195 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
198 #define DEPRECATED(func) func __attribute__ ((deprecated))
199 #elif defined(_MSC_VER)
200 #define DEPRECATED(func) __declspec(deprecated) func
202 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
203 #define DEPRECATED(func) func
206 struct ftdi_transfer_control
212 struct ftdi_context *ftdi;
213 struct libusb_transfer *transfer;
217 \brief Main context structure for all libftdi functions.
219 Do not access directly if possible.
224 /** libusb's context */
225 struct libusb_context *usb_ctx;
226 /** libusb's usb_dev_handle */
227 struct libusb_device_handle *usb_dev;
228 /** usb read timeout */
229 int usb_read_timeout;
230 /** usb write timeout */
231 int usb_write_timeout;
234 /** FTDI chip type */
235 enum ftdi_chip_type type;
238 /** bitbang mode state */
239 unsigned char bitbang_enabled;
240 /** pointer to read buffer for ftdi_read_data */
241 unsigned char *readbuffer;
242 /** read buffer offset */
243 unsigned int readbuffer_offset;
244 /** number of remaining data in internal read buffer */
245 unsigned int readbuffer_remaining;
246 /** read buffer chunk size */
247 unsigned int readbuffer_chunksize;
248 /** write buffer chunk size */
249 unsigned int writebuffer_chunksize;
250 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
251 unsigned int max_packet_size;
253 /* FTDI FT2232C requirecments */
254 /** FT2232C interface number: 0 or 1 */
255 int interface; /* 0 or 1 */
256 /** FT2232C index number: 1 or 2 */
257 int index; /* 1 or 2 */
259 /** FT2232C end points: 1 or 2 */
261 int out_ep; /* 1 or 2 */
263 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
264 unsigned char bitbang_mode;
266 /** Decoded eeprom structure */
267 struct ftdi_eeprom *eeprom;
269 /** String representation of last error */
270 const char *error_str;
272 /** Defines behavior in case a kernel module is already attached to the device */
273 enum ftdi_module_detach_mode module_detach_mode;
277 List all handled EEPROM values.
278 Append future new values only at the end to provide API/ABI stability*/
279 enum ftdi_eeprom_value
287 IN_IS_ISOCHRONOUS = 6,
288 OUT_IS_ISOCHRONOUS = 7,
289 SUSPEND_PULL_DOWNS = 8,
292 USE_USB_VERSION = 11,
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,
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,
337 EXTERNAL_OSCILLATOR= 56,
342 \brief list of usb devices created by ftdi_usb_find_all()
344 struct ftdi_device_list
346 /** pointer to next entry */
347 struct ftdi_device_list *next;
348 /** pointer to libusb's usb_device */
349 struct libusb_device *dev;
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
356 #define USE_SERIAL_NUM 0x08
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
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
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
381 #define INVERT_TXD 0x01
383 #define INVERT_RXD 0x02
385 #define INVERT_RTS 0x04
387 #define INVERT_CTS 0x08
389 #define INVERT_DTR 0x10
391 #define INVERT_DSR 0x20
393 #define INVERT_DCD 0x40
395 #define INVERT_RI 0x80
397 /** Interface Mode. */
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
404 #define CHANNEL_IS_RS485 0x10
414 #define DRIVER_VCP 0x08
415 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
417 #define USE_USB_VERSION_BIT 0x10
419 #define SUSPEND_DBUS7_BIT 0x80
421 /** High current drive. */
422 #define HIGH_CURRENT_DRIVE 0x10
423 #define HIGH_CURRENT_DRIVE_R 0x04
426 \brief Progress Info for streaming read
436 struct size_and_time first;
437 struct size_and_time prev;
438 struct size_and_time current;
444 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
445 FTDIProgressInfo *progress, void *userdata);
448 * Provide libftdi version information
449 * major: Library major version
450 * minor: Library minor version
451 * micro: Currently unused, ight get used for hotfixes.
452 * version_str: Version as (static) string
453 * snapshot_str: Git snapshot version if known. Otherwise "unknown" or empty string.
455 struct ftdi_version_info
460 const char *version_str;
461 const char *snapshot_str;
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);
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);
478 struct ftdi_version_info ftdi_get_library_version(void);
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);
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);
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_port(struct ftdi_context *ftdi, uint8_t bus, uint8_t port);
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);
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);
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);
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);
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);
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);
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);
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);
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);
545 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
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);
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);
556 /* init eeprom for the given FTDI type */
557 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
558 char * manufacturer, char *product,
560 int ftdi_eeprom_build(struct ftdi_context *ftdi);
561 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
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);
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);
569 int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size);
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);
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);
579 const char *ftdi_get_error_string(struct ftdi_context *ftdi);
585 #endif /* __libftdi_h__ */