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 ***************************************************************************/
22 /* Even on 93xx66 at max 256 bytes are used (AN_121)*/
23 #define FTDI_MAX_EEPROM_SIZE 256
26 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 };
27 /** Parity mode for ftdi_set_line_property() */
28 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
29 /** Number of stop bits for ftdi_set_line_property() */
30 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
31 /** Number of bits for ftdi_set_line_property() */
32 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
33 /** Break type for ftdi_set_line_property2() */
34 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
36 /** MPSSE bitbang modes */
39 BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
40 BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
41 BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
42 BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
43 BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
44 /* CPU-style fifo mode gets set via EEPROM */
45 BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
46 BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
47 BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
48 BITMODE_FT1284 = 0x80, /**< FT1284 mode, available on 232H chips */
51 /** Port interface for chips with multiple interfaces */
61 /** Automatic loading / unloading of kernel modules */
62 enum ftdi_module_detach_mode
64 AUTO_DETACH_SIO_MODULE = 0,
65 DONT_DETACH_SIO_MODULE = 1
68 /* Shifting commands IN MPSSE Mode*/
69 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
70 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
71 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
72 #define MPSSE_LSB 0x08 /* LSB first */
73 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
74 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
75 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
77 /* FTDI MPSSE commands */
78 #define SET_BITS_LOW 0x80
81 #define SET_BITS_HIGH 0x82
84 #define GET_BITS_LOW 0x81
85 #define GET_BITS_HIGH 0x83
86 #define LOOPBACK_START 0x84
87 #define LOOPBACK_END 0x85
88 #define TCK_DIVISOR 0x86
89 /* H Type specific commands */
90 #define DIS_DIV_5 0x8a
92 #define EN_3_PHASE 0x8c
93 #define DIS_3_PHASE 0x8d
95 #define CLK_BYTES 0x8f
96 #define CLK_WAIT_HIGH 0x94
97 #define CLK_WAIT_LOW 0x95
98 #define EN_ADAPTIVE 0x96
99 #define DIS_ADAPTIVE 0x97
100 #define CLK_BYTES_OR_HIGH 0x9c
101 #define CLK_BYTES_OR_LOW 0x0d
102 /*FT232H specific commands */
103 #define DRIVE_OPEN_COLLECTOR 0x9e
105 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
106 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
108 /* Commands in MPSSE and Host Emulation Mode */
109 #define SEND_IMMEDIATE 0x87
110 #define WAIT_ON_HIGH 0x88
111 #define WAIT_ON_LOW 0x89
113 /* Commands in Host Emulation Mode */
114 #define READ_SHORT 0x90
116 #define READ_EXTENDED 0x91
119 #define WRITE_SHORT 0x92
121 #define WRITE_EXTENDED 0x93
125 /* Definitions for flow control */
126 #define SIO_RESET 0 /* Reset the port */
127 #define SIO_MODEM_CTRL 1 /* Set the modem control register */
128 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
129 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
130 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
132 #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
133 #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
136 #define SIO_RESET_REQUEST SIO_RESET
137 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
138 #define SIO_SET_DATA_REQUEST SIO_SET_DATA
139 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
140 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
141 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
142 #define SIO_SET_EVENT_CHAR_REQUEST 0x06
143 #define SIO_SET_ERROR_CHAR_REQUEST 0x07
144 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
145 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
146 #define SIO_SET_BITMODE_REQUEST 0x0B
147 #define SIO_READ_PINS_REQUEST 0x0C
148 #define SIO_READ_EEPROM_REQUEST 0x90
149 #define SIO_WRITE_EEPROM_REQUEST 0x91
150 #define SIO_ERASE_EEPROM_REQUEST 0x92
153 #define SIO_RESET_SIO 0
154 #define SIO_RESET_PURGE_RX 1
155 #define SIO_RESET_PURGE_TX 2
157 #define SIO_DISABLE_FLOW_CTRL 0x0
158 #define SIO_RTS_CTS_HS (0x1 << 8)
159 #define SIO_DTR_DSR_HS (0x2 << 8)
160 #define SIO_XON_XOFF_HS (0x4 << 8)
162 #define SIO_SET_DTR_MASK 0x1
163 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
164 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
165 #define SIO_SET_RTS_MASK 0x2
166 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
167 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
169 #define SIO_RTS_CTS_HS (0x1 << 8)
171 /* marker for unused usb urb structures
172 (taken from libusb) */
173 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
176 #define DEPRECATED(func) func __attribute__ ((deprecated))
177 #elif defined(_MSC_VER)
178 #define DEPRECATED(func) __declspec(deprecated) func
180 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
181 #define DEPRECATED(func) func
184 struct ftdi_transfer_control
190 struct ftdi_context *ftdi;
191 struct libusb_transfer *transfer;
195 \brief FTDI eeprom structure
204 /** Was the eeprom structure initialized for the actual
205 connected device? **/
206 int initialized_for_connected_device;
215 /* Suspend on DBUS7 Low */
218 /** input in isochronous transfer mode */
219 int in_is_isochronous;
220 /** output in isochronous transfer mode */
221 int out_is_isochronous;
222 /** suspend pull downs */
223 int suspend_pull_downs;
229 /** Use usb version on FT2232 devices*/
234 /** manufacturer name */
241 /* 2232D/H(/FT4432H?) specific */
242 /* Hardware type, 0 = RS232 Uart, 1 = 245 FIFO, 2 = CPU FIFO,
246 /* Driver Type, 1 = VCP */
247 int channel_a_driver;
248 int channel_b_driver;
250 /* Special function of FT232R/FT232H devices (and possibly others as well) */
251 /** CBUS pin function. See CBUS_xxx defines. */
252 int cbus_function[10];
253 /** Select hight current drive on R devices. */
255 /** Select hight current drive on A channel (2232C */
257 /** Select hight current drive on B channel (2232C). */
259 /** Select inversion of data lines (bitmask). */
262 /*2232H/4432H Group specific values */
263 /* Group0 is AL on 2322H and A on 4232H
264 Group1 is AH on 2232H and B on 4232H
265 Group2 is BL on 2322H and C on 4232H
266 Group3 is BH on 2232H and C on 4232H*/
286 /** eeprom size in bytes. This doesn't get stored in the eeprom
287 but is the only way to pass it to ftdi_eeprom_build. */
289 /* EEPROM Type 0x46 for 93xx46, 0x56 for 93xx56 and 0x66 for 93xx66*/
291 unsigned char buf[FTDI_MAX_EEPROM_SIZE];
295 \brief Main context structure for all libftdi functions.
297 Do not access directly if possible.
302 /** libusb's context */
303 struct libusb_context *usb_ctx;
304 /** libusb's usb_dev_handle */
305 struct libusb_device_handle *usb_dev;
306 /** usb read timeout */
307 int usb_read_timeout;
308 /** usb write timeout */
309 int usb_write_timeout;
312 /** FTDI chip type */
313 enum ftdi_chip_type type;
316 /** bitbang mode state */
317 unsigned char bitbang_enabled;
318 /** pointer to read buffer for ftdi_read_data */
319 unsigned char *readbuffer;
320 /** read buffer offset */
321 unsigned int readbuffer_offset;
322 /** number of remaining data in internal read buffer */
323 unsigned int readbuffer_remaining;
324 /** read buffer chunk size */
325 unsigned int readbuffer_chunksize;
326 /** write buffer chunk size */
327 unsigned int writebuffer_chunksize;
328 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
329 unsigned int max_packet_size;
331 /* FTDI FT2232C requirecments */
332 /** FT2232C interface number: 0 or 1 */
333 int interface; /* 0 or 1 */
334 /** FT2232C index number: 1 or 2 */
335 int index; /* 1 or 2 */
337 /** FT2232C end points: 1 or 2 */
339 int out_ep; /* 1 or 2 */
341 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
342 unsigned char bitbang_mode;
344 /** Decoded eeprom structure */
345 struct ftdi_eeprom *eeprom;
347 /** String representation of last error */
350 /** Defines behavior in case a kernel module is already attached to the device */
351 enum ftdi_module_detach_mode module_detach_mode;
355 List all handled EEPROM values.
356 Append future new values only at the end to provide API/ABI stability*/
357 enum ftdi_eeprom_value
365 IN_IS_ISOCHRONOUS = 6,
366 OUT_IS_ISOCHRONOUS = 7,
367 SUSPEND_PULL_DOWNS = 8,
370 USE_USB_VERSION = 11,
374 CHANNEL_A_DRIVER = 15,
375 CHANNEL_B_DRIVER = 16,
376 CBUS_FUNCTION_0 = 17,
377 CBUS_FUNCTION_1 = 18,
378 CBUS_FUNCTION_2 = 19,
379 CBUS_FUNCTION_3 = 20,
380 CBUS_FUNCTION_4 = 21,
381 CBUS_FUNCTION_5 = 22,
382 CBUS_FUNCTION_6 = 23,
383 CBUS_FUNCTION_7 = 24,
384 CBUS_FUNCTION_8 = 25,
385 CBUS_FUNCTION_9 = 26,
411 \brief list of usb devices created by ftdi_usb_find_all()
413 struct ftdi_device_list
415 /** pointer to next entry */
416 struct ftdi_device_list *next;
417 /** pointer to libusb's usb_device */
418 struct libusb_device *dev;
420 #define FT1284_CLK_IDLE_STATE 0x01
421 #define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
422 #define FT1284_FLOW_CONTROL 0x04
423 #define POWER_SAVE_DISABLE_H 0x80
425 #define USE_SERIAL_NUM 0x08
426 enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
427 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
428 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
429 CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd};
431 enum ftdi_cbush_func {/* FIXME: Recheck value, especially the last */
432 CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4,
433 CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9,
434 CBUSH_CLK30 = 0xa, CBUSH_CLK15 = 0xb, CBUSH_CLK7_5 = 0xc};
437 #define INVERT_TXD 0x01
439 #define INVERT_RXD 0x02
441 #define INVERT_RTS 0x04
443 #define INVERT_CTS 0x08
445 #define INVERT_DTR 0x10
447 #define INVERT_DSR 0x20
449 #define INVERT_DCD 0x40
451 #define INVERT_RI 0x80
453 /** Interface Mode. */
454 #define CHANNEL_IS_UART 0x0
455 #define CHANNEL_IS_FIFO 0x1
456 #define CHANNEL_IS_OPTO 0x2
457 #define CHANNEL_IS_CPU 0x4
458 #define CHANNEL_IS_FT1284 0x8
468 #define DRIVER_VCP 0x08
469 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
471 #define USE_USB_VERSION_BIT 0x10
473 #define SUSPEND_DBUS7_BIT 0x80
475 /** High current drive. */
476 #define HIGH_CURRENT_DRIVE 0x10
477 #define HIGH_CURRENT_DRIVE_R 0x04
480 \brief Progress Info for streaming read
490 struct size_and_time first;
491 struct size_and_time prev;
492 struct size_and_time current;
498 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
499 FTDIProgressInfo *progress, void *userdata);
507 int ftdi_init(struct ftdi_context *ftdi);
508 struct ftdi_context *ftdi_new(void);
509 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
511 void ftdi_deinit(struct ftdi_context *ftdi);
512 void ftdi_free(struct ftdi_context *ftdi);
513 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
515 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
516 int vendor, int product);
517 void ftdi_list_free(struct ftdi_device_list **devlist);
518 void ftdi_list_free2(struct ftdi_device_list *devlist);
519 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
520 char * manufacturer, int mnf_len,
521 char * description, int desc_len,
522 char * serial, int serial_len);
524 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
525 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
526 const char* description, const char* serial);
527 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
528 const char* description, const char* serial, unsigned int index);
529 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
530 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
532 int ftdi_usb_close(struct ftdi_context *ftdi);
533 int ftdi_usb_reset(struct ftdi_context *ftdi);
534 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
535 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
536 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
538 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
539 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
540 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
541 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
542 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
543 enum ftdi_break_type break_type);
545 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
546 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
547 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
549 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
550 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
551 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
553 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
554 void *userdata, int packetsPerTransfer, int numTransfers);
555 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
556 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
558 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
559 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
561 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
562 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
563 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
564 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
566 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
567 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
569 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
572 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
573 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
574 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
575 int ftdi_setrts(struct ftdi_context *ftdi, int state);
577 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
578 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
580 /* init eeprom for the given FTDI type */
581 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
582 char * manufacturer, char *product,
584 int ftdi_eeprom_build(struct ftdi_context *ftdi);
585 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
587 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
588 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
590 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
591 int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
593 int ftdi_read_eeprom(struct ftdi_context *ftdi);
594 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
595 int ftdi_write_eeprom(struct ftdi_context *ftdi);
596 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
598 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
599 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
601 char *ftdi_get_error_string(struct ftdi_context *ftdi);
607 #endif /* __libftdi_h__ */