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 };
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 */
50 /** Port interface for chips with multiple interfaces */
60 /** Automatic loading / unloading of kernel modules */
61 enum ftdi_module_detach_mode
63 AUTO_DETACH_SIO_MODULE = 0,
64 DONT_DETACH_SIO_MODULE = 1
67 /* Shifting commands IN MPSSE Mode*/
68 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
69 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
70 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
71 #define MPSSE_LSB 0x08 /* LSB first */
72 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
73 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
74 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
76 /* FTDI MPSSE commands */
77 #define SET_BITS_LOW 0x80
80 #define SET_BITS_HIGH 0x82
83 #define GET_BITS_LOW 0x81
84 #define GET_BITS_HIGH 0x83
85 #define LOOPBACK_START 0x84
86 #define LOOPBACK_END 0x85
87 #define TCK_DIVISOR 0x86
89 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
90 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
92 /* Commands in MPSSE and Host Emulation Mode */
93 #define SEND_IMMEDIATE 0x87
94 #define WAIT_ON_HIGH 0x88
95 #define WAIT_ON_LOW 0x89
97 /* Commands in Host Emulation Mode */
98 #define READ_SHORT 0x90
100 #define READ_EXTENDED 0x91
103 #define WRITE_SHORT 0x92
105 #define WRITE_EXTENDED 0x93
109 /* Definitions for flow control */
110 #define SIO_RESET 0 /* Reset the port */
111 #define SIO_MODEM_CTRL 1 /* Set the modem control register */
112 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
113 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
114 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
116 #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
117 #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
120 #define SIO_RESET_REQUEST SIO_RESET
121 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
122 #define SIO_SET_DATA_REQUEST SIO_SET_DATA
123 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
124 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
125 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
126 #define SIO_SET_EVENT_CHAR_REQUEST 0x06
127 #define SIO_SET_ERROR_CHAR_REQUEST 0x07
128 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
129 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
130 #define SIO_SET_BITMODE_REQUEST 0x0B
131 #define SIO_READ_PINS_REQUEST 0x0C
132 #define SIO_READ_EEPROM_REQUEST 0x90
133 #define SIO_WRITE_EEPROM_REQUEST 0x91
134 #define SIO_ERASE_EEPROM_REQUEST 0x92
137 #define SIO_RESET_SIO 0
138 #define SIO_RESET_PURGE_RX 1
139 #define SIO_RESET_PURGE_TX 2
141 #define SIO_DISABLE_FLOW_CTRL 0x0
142 #define SIO_RTS_CTS_HS (0x1 << 8)
143 #define SIO_DTR_DSR_HS (0x2 << 8)
144 #define SIO_XON_XOFF_HS (0x4 << 8)
146 #define SIO_SET_DTR_MASK 0x1
147 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
148 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
149 #define SIO_SET_RTS_MASK 0x2
150 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
151 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
153 #define SIO_RTS_CTS_HS (0x1 << 8)
155 /* marker for unused usb urb structures
156 (taken from libusb) */
157 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
160 #define DEPRECATED(func) func __attribute__ ((deprecated))
161 #elif defined(_MSC_VER)
162 #define DEPRECATED(func) __declspec(deprecated) func
164 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
165 #define DEPRECATED(func) func
168 struct ftdi_transfer_control
174 struct ftdi_context *ftdi;
175 struct libusb_transfer *transfer;
179 \brief FTDI eeprom structure
195 /* Suspend on DBUS7 Low */
198 /** input in isochronous transfer mode */
199 int in_is_isochronous;
200 /** output in isochronous transfer mode */
201 int out_is_isochronous;
202 /** suspend pull downs */
203 int suspend_pull_downs;
209 /** Use usb version on FT2232 devices*/
214 /** manufacturer name */
221 /* 2232D/H(/FT4432H?) specific */
222 /* Hardware type, 0 = RS232 Uart, 1 = 245 FIFO, 2 = CPU FIFO,
226 /* Driver Type, 1 = VCP */
227 int channel_a_driver;
228 int channel_b_driver;
230 /* Special function of FT232R devices (and possibly others as well) */
231 /** CBUS pin function. See CBUS_xxx defines. */
232 int cbus_function[5];
233 /** Select hight current drive on R devices. */
235 /** Select hight current drive on A channel (2232C */
237 /** Select hight current drive on B channel (2232C). */
239 /** Select inversion of data lines (bitmask). */
242 /*2232H/4432H Group specific values */
243 /* Group0 is AL on 2322H and A on 4232H
244 Group1 is AH on 2232H and B on 4232H
245 Group2 is BL on 2322H and C on 4232H
246 Group3 is BH on 2232H and C on 4232H*/
260 /** eeprom size in bytes. This doesn't get stored in the eeprom
261 but is the only way to pass it to ftdi_eeprom_build. */
263 /* EEPROM Type 0x46 for 93xx46, 0x56 for 93xx56 and 0x66 for 93xx66*/
265 unsigned char buf[FTDI_MAX_EEPROM_SIZE];
269 \brief Main context structure for all libftdi functions.
271 Do not access directly if possible.
276 /** libusb's context */
277 struct libusb_context *usb_ctx;
278 /** libusb's usb_dev_handle */
279 struct libusb_device_handle *usb_dev;
280 /** usb read timeout */
281 int usb_read_timeout;
282 /** usb write timeout */
283 int usb_write_timeout;
286 /** FTDI chip type */
287 enum ftdi_chip_type type;
290 /** bitbang mode state */
291 unsigned char bitbang_enabled;
292 /** pointer to read buffer for ftdi_read_data */
293 unsigned char *readbuffer;
294 /** read buffer offset */
295 unsigned int readbuffer_offset;
296 /** number of remaining data in internal read buffer */
297 unsigned int readbuffer_remaining;
298 /** read buffer chunk size */
299 unsigned int readbuffer_chunksize;
300 /** write buffer chunk size */
301 unsigned int writebuffer_chunksize;
302 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
303 unsigned int max_packet_size;
305 /* FTDI FT2232C requirecments */
306 /** FT2232C interface number: 0 or 1 */
307 int interface; /* 0 or 1 */
308 /** FT2232C index number: 1 or 2 */
309 int index; /* 1 or 2 */
311 /** FT2232C end points: 1 or 2 */
313 int out_ep; /* 1 or 2 */
315 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
316 unsigned char bitbang_mode;
318 /** Decoded eeprom structure */
319 struct ftdi_eeprom *eeprom;
321 /** String representation of last error */
324 /** Defines behavior in case a kernel module is already attached to the device */
325 enum ftdi_module_detach_mode module_detach_mode;
329 List all handled EEPROM values.
330 Append future new values only at the end to provide API/ABI stability*/
331 enum ftdi_eeprom_value
339 IN_IS_ISOCHRONOUS = 6,
340 OUT_IS_ISOCHRONOUS = 7,
341 SUSPEND_PULL_DOWNS = 8,
344 USE_USB_VERSION = 11,
348 CHANNEL_A_DRIVER = 15,
349 CHANNEL_B_DRIVER = 16,
350 CBUS_FUNCTION_0 = 17,
351 CBUS_FUNCTION_1 = 18,
352 CBUS_FUNCTION_2 = 19,
353 CBUS_FUNCTION_3 = 20,
354 CBUS_FUNCTION_4 = 21,
376 \brief list of usb devices created by ftdi_usb_find_all()
378 struct ftdi_device_list
380 /** pointer to next entry */
381 struct ftdi_device_list *next;
382 /** pointer to libusb's usb_device */
383 struct libusb_device *dev;
386 #define USE_SERIAL_NUM 0x08
387 enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
388 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
389 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
390 CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd};
393 #define INVERT_TXD 0x01
395 #define INVERT_RXD 0x02
397 #define INVERT_RTS 0x04
399 #define INVERT_CTS 0x08
401 #define INVERT_DTR 0x10
403 #define INVERT_DSR 0x20
405 #define INVERT_DCD 0x40
407 #define INVERT_RI 0x80
409 /** Interface Mode. */
410 #define CHANNEL_IS_UART 0x0
411 #define CHANNEL_IS_245 0x1
412 #define CHANNEL_IS_CPU 0x2
413 #define CHANNEL_IS_OPTO 0x4
423 #define DRIVER_VCP 0x08
425 #define USE_USB_VERSION_BIT 0x10
427 #define SUSPEND_DBUS7_BIT 0x80
429 /** High current drive. */
430 #define HIGH_CURRENT_DRIVE 0x10
431 #define HIGH_CURRENT_DRIVE_R 0x04
434 \brief Progress Info for streaming read
444 struct size_and_time first;
445 struct size_and_time prev;
446 struct size_and_time current;
452 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
453 FTDIProgressInfo *progress, void *userdata);
461 int ftdi_init(struct ftdi_context *ftdi);
462 struct ftdi_context *ftdi_new(void);
463 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
465 void ftdi_deinit(struct ftdi_context *ftdi);
466 void ftdi_free(struct ftdi_context *ftdi);
467 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
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);
478 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
479 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
480 const char* description, const char* serial);
481 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
482 const char* description, const char* serial, unsigned int index);
483 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
484 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
486 int ftdi_usb_close(struct ftdi_context *ftdi);
487 int ftdi_usb_reset(struct ftdi_context *ftdi);
488 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
489 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
490 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
492 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
493 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
494 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
495 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
496 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
497 enum ftdi_break_type break_type);
499 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
500 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
501 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
503 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
504 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
505 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
507 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
508 void *userdata, int packetsPerTransfer, int numTransfers);
509 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
510 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
512 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
513 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
515 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
516 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
517 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
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);
546 int ftdi_read_eeprom(struct ftdi_context *ftdi);
547 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
548 int ftdi_write_eeprom(struct ftdi_context *ftdi);
549 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
551 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
552 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
554 char *ftdi_get_error_string(struct ftdi_context *ftdi);
560 #endif /* __libftdi_h__ */