1 /***************************************************************************
5 copyright : (C) 2003 by Intra2net AG
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 /* Evne 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 /* Shifting commands IN MPSSE Mode*/
61 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
62 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
63 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
64 #define MPSSE_LSB 0x08 /* LSB first */
65 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
66 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
67 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
69 /* FTDI MPSSE commands */
70 #define SET_BITS_LOW 0x80
73 #define SET_BITS_HIGH 0x82
76 #define GET_BITS_LOW 0x81
77 #define GET_BITS_HIGH 0x83
78 #define LOOPBACK_START 0x84
79 #define LOOPBACK_END 0x85
80 #define TCK_DIVISOR 0x86
82 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
83 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
85 /* Commands in MPSSE and Host Emulation Mode */
86 #define SEND_IMMEDIATE 0x87
87 #define WAIT_ON_HIGH 0x88
88 #define WAIT_ON_LOW 0x89
90 /* Commands in Host Emulation Mode */
91 #define READ_SHORT 0x90
93 #define READ_EXTENDED 0x91
96 #define WRITE_SHORT 0x92
98 #define WRITE_EXTENDED 0x93
102 /* Definitions for flow control */
103 #define SIO_RESET 0 /* Reset the port */
104 #define SIO_MODEM_CTRL 1 /* Set the modem control register */
105 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
106 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
107 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
109 #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
110 #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
113 #define SIO_RESET_REQUEST SIO_RESET
114 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
115 #define SIO_SET_DATA_REQUEST SIO_SET_DATA
116 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
117 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
118 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
119 #define SIO_SET_EVENT_CHAR_REQUEST 0x06
120 #define SIO_SET_ERROR_CHAR_REQUEST 0x07
121 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
122 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
123 #define SIO_SET_BITMODE_REQUEST 0x0B
124 #define SIO_READ_PINS_REQUEST 0x0C
125 #define SIO_READ_EEPROM_REQUEST 0x90
126 #define SIO_WRITE_EEPROM_REQUEST 0x91
127 #define SIO_ERASE_EEPROM_REQUEST 0x92
130 #define SIO_RESET_SIO 0
131 #define SIO_RESET_PURGE_RX 1
132 #define SIO_RESET_PURGE_TX 2
134 #define SIO_DISABLE_FLOW_CTRL 0x0
135 #define SIO_RTS_CTS_HS (0x1 << 8)
136 #define SIO_DTR_DSR_HS (0x2 << 8)
137 #define SIO_XON_XOFF_HS (0x4 << 8)
139 #define SIO_SET_DTR_MASK 0x1
140 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
141 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
142 #define SIO_SET_RTS_MASK 0x2
143 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
144 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
146 #define SIO_RTS_CTS_HS (0x1 << 8)
148 /* marker for unused usb urb structures
149 (taken from libusb) */
150 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
153 #define DEPRECATED(func) func __attribute__ ((deprecated))
154 #elif defined(_MSC_VER)
155 #define DEPRECATED(func) __declspec(deprecated) func
157 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
158 #define DEPRECATED(func) func
161 struct ftdi_transfer_control
167 struct ftdi_context *ftdi;
168 struct libusb_transfer *transfer;
172 \brief FTDI eeprom structure
188 /* Suspend on DBUS7 Low */
191 /** input in isochronous transfer mode */
192 int in_is_isochronous;
193 /** output in isochronous transfer mode */
194 int out_is_isochronous;
195 /** suspend pull downs */
196 int suspend_pull_downs;
200 /** fake usb version */
201 int change_usb_version;
207 /** manufacturer name */
214 /* 2232D/H(/FT4432H?) specific */
215 /* Hardware type, 0 = RS232 Uart, 1 = 245 FIFO, 2 = CPU FIFO,
219 /* Driver Type, 1 = VCP */
220 int channel_a_driver;
221 int channel_b_driver;
223 /* Special function of FT232R devices (and possibly others as well) */
224 /** CBUS pin function. See CBUS_xxx defines. */
225 int cbus_function[5];
226 /** Select hight current drive. */
228 /** Select hight current drive on B port (2232C). */
230 /** Select inversion of data lines (bitmask). */
233 /*2232H/4432H Group specific values */
234 /* Group0 is AL on 2322H and A on 4232H
235 Group1 is AH on 2232H and B on 4232H
236 Group2 is BL on 2322H and C on 4232H
237 Group3 is BH on 2232H and C on 4232H*/
252 /** eeprom size in bytes. This doesn't get stored in the eeprom
253 but is the only way to pass it to ftdi_eeprom_build. */
255 /* EEPROM Type 46 for 93xx46, 56 for 93xx56 and 66 for 93xx66*/
260 \brief Main context structure for all libftdi functions.
262 Do not access directly if possible.
267 /** libusb's context */
268 struct libusb_context *usb_ctx;
269 /** libusb's usb_dev_handle */
270 struct libusb_device_handle *usb_dev;
271 /** usb read timeout */
272 int usb_read_timeout;
273 /** usb write timeout */
274 int usb_write_timeout;
277 /** FTDI chip type */
278 enum ftdi_chip_type type;
281 /** bitbang mode state */
282 unsigned char bitbang_enabled;
283 /** pointer to read buffer for ftdi_read_data */
284 unsigned char *readbuffer;
285 /** read buffer offset */
286 unsigned int readbuffer_offset;
287 /** number of remaining data in internal read buffer */
288 unsigned int readbuffer_remaining;
289 /** read buffer chunk size */
290 unsigned int readbuffer_chunksize;
291 /** write buffer chunk size */
292 unsigned int writebuffer_chunksize;
293 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
294 unsigned int max_packet_size;
296 /* FTDI FT2232C requirecments */
297 /** FT2232C interface number: 0 or 1 */
298 int interface; /* 0 or 1 */
299 /** FT2232C index number: 1 or 2 */
300 int index; /* 1 or 2 */
302 /** FT2232C end points: 1 or 2 */
304 int out_ep; /* 1 or 2 */
306 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
307 unsigned char bitbang_mode;
309 /** Decoded eeprom structure */
310 struct ftdi_eeprom *eeprom;
312 /** String representation of last error */
317 \brief list of usb devices created by ftdi_usb_find_all()
319 struct ftdi_device_list
321 /** pointer to next entry */
322 struct ftdi_device_list *next;
323 /** pointer to libusb's usb_device */
324 struct libusb_device *dev;
327 #define USE_SERIAL_NUM 0x08
328 enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
329 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
330 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
331 CBUS_IOMODE = 10, CBUS_BB_WR = 11, CBUS_BB_RD = 12, CBUS_BB_RXF = 13, CBUS_BB_TXE = 14};
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_245 0x1
353 #define CHANNEL_IS_CPU 0x2
354 #define CHANNEL_IS_OPTO 0x4
364 #define DRIVER_VCP 0x08
366 #define SUSPEND_DBUS7 0x80
368 /** High current drive. */
369 #define HIGH_CURRENT_DRIVE 0x10
372 \brief Progress Info for streaming read
382 struct size_and_time first;
383 struct size_and_time prev;
384 struct size_and_time current;
390 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
391 FTDIProgressInfo *progress, void *userdata);
399 int ftdi_init(struct ftdi_context *ftdi);
400 struct ftdi_context *ftdi_new(void);
401 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
403 void ftdi_deinit(struct ftdi_context *ftdi);
404 void ftdi_free(struct ftdi_context *ftdi);
405 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
407 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
408 int vendor, int product);
409 void ftdi_list_free(struct ftdi_device_list **devlist);
410 void ftdi_list_free2(struct ftdi_device_list *devlist);
411 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
412 char * manufacturer, int mnf_len,
413 char * description, int desc_len,
414 char * serial, int serial_len);
416 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
417 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
418 const char* description, const char* serial);
419 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
420 const char* description, const char* serial, unsigned int index);
421 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
422 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
424 int ftdi_usb_close(struct ftdi_context *ftdi);
425 int ftdi_usb_reset(struct ftdi_context *ftdi);
426 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
427 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
428 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
430 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
431 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
432 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
433 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
434 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
435 enum ftdi_break_type break_type);
437 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
438 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
439 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
441 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
442 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
443 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
445 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
446 void *userdata, int packetsPerTransfer, int numTransfers);
447 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
448 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
450 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
451 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
453 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
454 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
455 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
456 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
458 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
459 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
461 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
464 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
465 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
466 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
467 int ftdi_setrts(struct ftdi_context *ftdi, int state);
469 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
470 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
472 /* set eeprom size */
473 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
475 /* init and build eeprom from ftdi_eeprom structure */
476 void ftdi_eeprom_initdefaults(struct ftdi_context *ftdi);
477 void ftdi_eeprom_free(struct ftdi_context *ftdi);
478 int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output);
479 int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *output, int size, int verbose);
481 /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
482 the checksum of the eeprom is valided */
483 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
484 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
485 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
486 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
488 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
489 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
491 char *ftdi_get_error_string(struct ftdi_context *ftdi);
497 #endif /* __libftdi_h__ */