1 /***************************************************************************
5 copyright : (C) 2003-2011 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 enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5, TYPE_232H=6 };
24 /** Parity mode for ftdi_set_line_property() */
25 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
26 /** Number of stop bits for ftdi_set_line_property() */
27 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
28 /** Number of bits for ftdi_set_line_property() */
29 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
30 /** Break type for ftdi_set_line_property2() */
31 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
33 /** MPSSE bitbang modes */
36 BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
37 BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
38 BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
39 BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
40 BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
41 /* CPU-style fifo mode gets set via EEPROM */
42 BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
43 BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
44 BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
45 BITMODE_FT1284 = 0x80, /**< FT1284 mode, available on 232H chips */
48 /** Port interface for chips with multiple interfaces */
58 /** Automatic loading / unloading of kernel modules */
59 enum ftdi_module_detach_mode
61 AUTO_DETACH_SIO_MODULE = 0,
62 DONT_DETACH_SIO_MODULE = 1
65 /* Shifting commands IN MPSSE Mode*/
66 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
67 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
68 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
69 #define MPSSE_LSB 0x08 /* LSB first */
70 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
71 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
72 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
74 /* FTDI MPSSE commands */
75 #define SET_BITS_LOW 0x80
78 #define SET_BITS_HIGH 0x82
81 #define GET_BITS_LOW 0x81
82 #define GET_BITS_HIGH 0x83
83 #define LOOPBACK_START 0x84
84 #define LOOPBACK_END 0x85
85 #define TCK_DIVISOR 0x86
86 /* H Type specific commands */
87 #define DIS_DIV_5 0x8a
89 #define EN_3_PHASE 0x8c
90 #define DIS_3_PHASE 0x8d
92 #define CLK_BYTES 0x8f
93 #define CLK_WAIT_HIGH 0x94
94 #define CLK_WAIT_LOW 0x95
95 #define EN_ADAPTIVE 0x96
96 #define DIS_ADAPTIVE 0x97
97 #define CLK_BYTES_OR_HIGH 0x9c
98 #define CLK_BYTES_OR_LOW 0x0d
99 /*FT232H specific commands */
100 #define DRIVE_OPEN_COLLECTOR 0x9e
102 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
103 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
105 /* Commands in MPSSE and Host Emulation Mode */
106 #define SEND_IMMEDIATE 0x87
107 #define WAIT_ON_HIGH 0x88
108 #define WAIT_ON_LOW 0x89
110 /* Commands in Host Emulation Mode */
111 #define READ_SHORT 0x90
113 #define READ_EXTENDED 0x91
116 #define WRITE_SHORT 0x92
118 #define WRITE_EXTENDED 0x93
122 /* Definitions for flow control */
123 #define SIO_RESET 0 /* Reset the port */
124 #define SIO_MODEM_CTRL 1 /* Set the modem control register */
125 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
126 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
127 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
129 #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
130 #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
133 #define SIO_RESET_REQUEST SIO_RESET
134 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
135 #define SIO_SET_DATA_REQUEST SIO_SET_DATA
136 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
137 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
138 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
139 #define SIO_SET_EVENT_CHAR_REQUEST 0x06
140 #define SIO_SET_ERROR_CHAR_REQUEST 0x07
141 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
142 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
143 #define SIO_SET_BITMODE_REQUEST 0x0B
144 #define SIO_READ_PINS_REQUEST 0x0C
145 #define SIO_READ_EEPROM_REQUEST 0x90
146 #define SIO_WRITE_EEPROM_REQUEST 0x91
147 #define SIO_ERASE_EEPROM_REQUEST 0x92
150 #define SIO_RESET_SIO 0
151 #define SIO_RESET_PURGE_RX 1
152 #define SIO_RESET_PURGE_TX 2
154 #define SIO_DISABLE_FLOW_CTRL 0x0
155 #define SIO_RTS_CTS_HS (0x1 << 8)
156 #define SIO_DTR_DSR_HS (0x2 << 8)
157 #define SIO_XON_XOFF_HS (0x4 << 8)
159 #define SIO_SET_DTR_MASK 0x1
160 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
161 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
162 #define SIO_SET_RTS_MASK 0x2
163 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
164 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
166 #define SIO_RTS_CTS_HS (0x1 << 8)
168 /* marker for unused usb urb structures
169 (taken from libusb) */
170 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
173 #define DEPRECATED(func) func __attribute__ ((deprecated))
174 #elif defined(_MSC_VER)
175 #define DEPRECATED(func) __declspec(deprecated) func
177 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
178 #define DEPRECATED(func) func
181 struct ftdi_transfer_control
187 struct ftdi_context *ftdi;
188 struct libusb_transfer *transfer;
192 \brief Main context structure for all libftdi functions.
194 Do not access directly if possible.
199 /** libusb's context */
200 struct libusb_context *usb_ctx;
201 /** libusb's usb_dev_handle */
202 struct libusb_device_handle *usb_dev;
203 /** usb read timeout */
204 int usb_read_timeout;
205 /** usb write timeout */
206 int usb_write_timeout;
209 /** FTDI chip type */
210 enum ftdi_chip_type type;
213 /** bitbang mode state */
214 unsigned char bitbang_enabled;
215 /** pointer to read buffer for ftdi_read_data */
216 unsigned char *readbuffer;
217 /** read buffer offset */
218 unsigned int readbuffer_offset;
219 /** number of remaining data in internal read buffer */
220 unsigned int readbuffer_remaining;
221 /** read buffer chunk size */
222 unsigned int readbuffer_chunksize;
223 /** write buffer chunk size */
224 unsigned int writebuffer_chunksize;
225 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
226 unsigned int max_packet_size;
228 /* FTDI FT2232C requirecments */
229 /** FT2232C interface number: 0 or 1 */
230 int interface; /* 0 or 1 */
231 /** FT2232C index number: 1 or 2 */
232 int index; /* 1 or 2 */
234 /** FT2232C end points: 1 or 2 */
236 int out_ep; /* 1 or 2 */
238 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
239 unsigned char bitbang_mode;
241 /** Decoded eeprom structure */
242 struct ftdi_eeprom *eeprom;
244 /** String representation of last error */
247 /** Defines behavior in case a kernel module is already attached to the device */
248 enum ftdi_module_detach_mode module_detach_mode;
252 List all handled EEPROM values.
253 Append future new values only at the end to provide API/ABI stability*/
254 enum ftdi_eeprom_value
262 IN_IS_ISOCHRONOUS = 6,
263 OUT_IS_ISOCHRONOUS = 7,
264 SUSPEND_PULL_DOWNS = 8,
267 USE_USB_VERSION = 11,
271 CHANNEL_A_DRIVER = 15,
272 CHANNEL_B_DRIVER = 16,
273 CBUS_FUNCTION_0 = 17,
274 CBUS_FUNCTION_1 = 18,
275 CBUS_FUNCTION_2 = 19,
276 CBUS_FUNCTION_3 = 20,
277 CBUS_FUNCTION_4 = 21,
278 CBUS_FUNCTION_5 = 22,
279 CBUS_FUNCTION_6 = 23,
280 CBUS_FUNCTION_7 = 24,
281 CBUS_FUNCTION_8 = 25,
282 CBUS_FUNCTION_9 = 26,
308 \brief list of usb devices created by ftdi_usb_find_all()
310 struct ftdi_device_list
312 /** pointer to next entry */
313 struct ftdi_device_list *next;
314 /** pointer to libusb's usb_device */
315 struct libusb_device *dev;
317 #define FT1284_CLK_IDLE_STATE 0x01
318 #define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
319 #define FT1284_FLOW_CONTROL 0x04
320 #define POWER_SAVE_DISABLE_H 0x80
322 #define USE_SERIAL_NUM 0x08
323 enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
324 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
325 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
326 CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd};
328 enum ftdi_cbush_func {/* FIXME: Recheck value, especially the last */
329 CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4,
330 CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9,
331 CBUSH_CLK30 = 0xa, CBUSH_CLK15 = 0xb, CBUSH_CLK7_5 = 0xc};
334 #define INVERT_TXD 0x01
336 #define INVERT_RXD 0x02
338 #define INVERT_RTS 0x04
340 #define INVERT_CTS 0x08
342 #define INVERT_DTR 0x10
344 #define INVERT_DSR 0x20
346 #define INVERT_DCD 0x40
348 #define INVERT_RI 0x80
350 /** Interface Mode. */
351 #define CHANNEL_IS_UART 0x0
352 #define CHANNEL_IS_FIFO 0x1
353 #define CHANNEL_IS_OPTO 0x2
354 #define CHANNEL_IS_CPU 0x4
355 #define CHANNEL_IS_FT1284 0x8
365 #define DRIVER_VCP 0x08
366 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
368 #define USE_USB_VERSION_BIT 0x10
370 #define SUSPEND_DBUS7_BIT 0x80
372 /** High current drive. */
373 #define HIGH_CURRENT_DRIVE 0x10
374 #define HIGH_CURRENT_DRIVE_R 0x04
377 \brief Progress Info for streaming read
387 struct size_and_time first;
388 struct size_and_time prev;
389 struct size_and_time current;
395 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
396 FTDIProgressInfo *progress, void *userdata);
399 * Provide libftdi version information
400 * major: Library major version
401 * minor: Library minor version
402 * micro: Currently unused, ight get used for hotfixes.
403 * version_str: Version as (static) string
404 * snapshot_str: Git snapshot version if known. Otherwise "unknown" or empty string.
406 struct ftdi_version_info
411 const char *version_str;
412 const char *snapshot_str;
421 int ftdi_init(struct ftdi_context *ftdi);
422 struct ftdi_context *ftdi_new(void);
423 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
425 void ftdi_deinit(struct ftdi_context *ftdi);
426 void ftdi_free(struct ftdi_context *ftdi);
427 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
429 struct ftdi_version_info ftdi_get_library_version();
431 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
432 int vendor, int product);
433 void ftdi_list_free(struct ftdi_device_list **devlist);
434 void ftdi_list_free2(struct ftdi_device_list *devlist);
435 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
436 char * manufacturer, int mnf_len,
437 char * description, int desc_len,
438 char * serial, int serial_len);
440 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
441 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
442 const char* description, const char* serial);
443 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
444 const char* description, const char* serial, unsigned int index);
445 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
446 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
448 int ftdi_usb_close(struct ftdi_context *ftdi);
449 int ftdi_usb_reset(struct ftdi_context *ftdi);
450 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
451 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
452 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
454 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
455 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
456 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
457 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
458 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
459 enum ftdi_break_type break_type);
461 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
462 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
463 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
465 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
466 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
467 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
469 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
470 void *userdata, int packetsPerTransfer, int numTransfers);
471 struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
472 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
474 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
475 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
477 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
478 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
479 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
481 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
482 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
484 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
487 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
488 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
489 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
490 int ftdi_setrts(struct ftdi_context *ftdi, int state);
492 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
493 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
495 /* init eeprom for the given FTDI type */
496 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
497 char * manufacturer, char *product,
499 int ftdi_eeprom_build(struct ftdi_context *ftdi);
500 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
502 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
503 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
505 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
506 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
508 int ftdi_read_eeprom(struct ftdi_context *ftdi);
509 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
510 int ftdi_write_eeprom(struct ftdi_context *ftdi);
511 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
513 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
514 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
516 char *ftdi_get_error_string(struct ftdi_context *ftdi);
522 #endif /* __libftdi_h__ */