git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
On FT2232D, eeprom->change_usb_version was not set with changed version
[libftdi] / src / ftdi.h
... / ...
CommitLineData
1/***************************************************************************
2 ftdi.h - description
3 -------------------
4 begin : Fri Apr 4 2003
5 copyright : (C) 2003 by Intra2net AG
6 email : opensource@intra2net.com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
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; *
14 * *
15 ***************************************************************************/
16
17#ifndef __libftdi_h__
18#define __libftdi_h__
19
20#include <libusb.h>
21
22/* Evne on 93xx66 at max 256 bytes are used (AN_121)*/
23#define FTDI_MAX_EEPROM_SIZE 256
24
25/** FTDI chip type */
26enum 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() */
28enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
29/** Number of stop bits for ftdi_set_line_property() */
30enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
31/** Number of bits for ftdi_set_line_property() */
32enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
33/** Break type for ftdi_set_line_property2() */
34enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
35
36/** MPSSE bitbang modes */
37enum ftdi_mpsse_mode
38{
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};
49
50/** Port interface for chips with multiple interfaces */
51enum ftdi_interface
52{
53 INTERFACE_ANY = 0,
54 INTERFACE_A = 1,
55 INTERFACE_B = 2,
56 INTERFACE_C = 3,
57 INTERFACE_D = 4
58};
59
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 */
68
69/* FTDI MPSSE commands */
70#define SET_BITS_LOW 0x80
71/*BYTE DATA*/
72/*BYTE Direction*/
73#define SET_BITS_HIGH 0x82
74/*BYTE DATA*/
75/*BYTE Direction*/
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
81/* Value Low */
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)
84
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
89
90/* Commands in Host Emulation Mode */
91#define READ_SHORT 0x90
92/* Address_Low */
93#define READ_EXTENDED 0x91
94/* Address High */
95/* Address Low */
96#define WRITE_SHORT 0x92
97/* Address_Low */
98#define WRITE_EXTENDED 0x93
99/* Address High */
100/* Address Low */
101
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 */
108
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)
111
112/* Requests */
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
128
129
130#define SIO_RESET_SIO 0
131#define SIO_RESET_PURGE_RX 1
132#define SIO_RESET_PURGE_TX 2
133
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)
138
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 ))
145
146#define SIO_RTS_CTS_HS (0x1 << 8)
147
148/* marker for unused usb urb structures
149 (taken from libusb) */
150#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
151
152#ifdef __GNUC__
153 #define DEPRECATED(func) func __attribute__ ((deprecated))
154#elif defined(_MSC_VER)
155 #define DEPRECATED(func) __declspec(deprecated) func
156#else
157 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
158 #define DEPRECATED(func) func
159#endif
160
161struct ftdi_transfer_control
162{
163 int completed;
164 unsigned char *buf;
165 int size;
166 int offset;
167 struct ftdi_context *ftdi;
168 struct libusb_transfer *transfer;
169};
170
171/**
172 \brief FTDI eeprom structure
173*/
174struct ftdi_eeprom
175{
176 /** vendor id */
177 int vendor_id;
178 /** product id */
179 int product_id;
180
181 /** self powered */
182 int self_powered;
183 /** remote wakeup */
184 int remote_wakeup;
185 /** release */
186 int release;
187
188 /** input in isochronous transfer mode */
189 int in_is_isochronous;
190 /** output in isochronous transfer mode */
191 int out_is_isochronous;
192 /** suspend pull downs */
193 int suspend_pull_downs;
194
195 /** use serial */
196 int use_serial;
197 /** fake usb version */
198 int change_usb_version;
199 /** usb version */
200 int usb_version;
201 /** maximum power */
202 int max_power;
203
204 /** manufacturer name */
205 char *manufacturer;
206 /** product name */
207 char *product;
208 /** serial number */
209 char *serial;
210
211 /* Special function of FT232R devices (and possibly others as well) */
212 /** CBUS pin function. See CBUS_xxx defines. */
213 int cbus_function[5];
214 /** Select hight current drive. */
215 int high_current;
216 /** Select inversion of data lines (bitmask). */
217 int invert;
218
219 /** eeprom size in bytes. This doesn't get stored in the eeprom
220 but is the only way to pass it to ftdi_eeprom_build. */
221 int size;
222 /* EEPROM Type 46 for 93xx46, 56 for 93xx56 and 66 for 93xx66*/
223 int chip;
224};
225
226/**
227 \brief Main context structure for all libftdi functions.
228
229 Do not access directly if possible.
230*/
231struct ftdi_context
232{
233 /* USB specific */
234 /** libusb's context */
235 struct libusb_context *usb_ctx;
236 /** libusb's usb_dev_handle */
237 struct libusb_device_handle *usb_dev;
238 /** usb read timeout */
239 int usb_read_timeout;
240 /** usb write timeout */
241 int usb_write_timeout;
242
243 /* FTDI specific */
244 /** FTDI chip type */
245 enum ftdi_chip_type type;
246 /** baudrate */
247 int baudrate;
248 /** bitbang mode state */
249 unsigned char bitbang_enabled;
250 /** pointer to read buffer for ftdi_read_data */
251 unsigned char *readbuffer;
252 /** read buffer offset */
253 unsigned int readbuffer_offset;
254 /** number of remaining data in internal read buffer */
255 unsigned int readbuffer_remaining;
256 /** read buffer chunk size */
257 unsigned int readbuffer_chunksize;
258 /** write buffer chunk size */
259 unsigned int writebuffer_chunksize;
260 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
261 unsigned int max_packet_size;
262
263 /* FTDI FT2232C requirecments */
264 /** FT2232C interface number: 0 or 1 */
265 int interface; /* 0 or 1 */
266 /** FT2232C index number: 1 or 2 */
267 int index; /* 1 or 2 */
268 /* Endpoints */
269 /** FT2232C end points: 1 or 2 */
270 int in_ep;
271 int out_ep; /* 1 or 2 */
272
273 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
274 unsigned char bitbang_mode;
275
276 /** Decoded eeprom structure */
277 struct ftdi_eeprom *eeprom;
278
279 /** String representation of last error */
280 char *error_str;
281};
282
283/**
284 \brief list of usb devices created by ftdi_usb_find_all()
285*/
286struct ftdi_device_list
287{
288 /** pointer to next entry */
289 struct ftdi_device_list *next;
290 /** pointer to libusb's usb_device */
291 struct libusb_device *dev;
292};
293
294/** TXDEN */
295#define CBUS_TXDEN 0
296/** PWREN# */
297#define CBUS_PWREN 1
298/** RXLED# */
299#define CBUS_RXLED 2
300/** TXLED#*/
301#define CBUS_TXLED 3
302/** RXLED# & TXLED# */
303#define CBUS_TXRXLED 4
304/** SLEEP# */
305#define CBUS_SLEEP 5
306/** 48 MHz clock */
307#define CBUS_CLK48 6
308/** 24 MHz clock */
309#define CBUS_CLK24 7
310/** 12 MHz clock */
311#define CBUS_CLK12 8
312/** 6 MHz clock */
313#define CBUS_CLK6 9
314/** Bitbang IO Mode*/
315#define CBUS_IOMODE 10
316/** Bitbang IO WR#*/
317#define CBUS_BB_WR 11
318/** Bitbang IO RD#*/
319#define CBUS_BB_RD 12
320
321
322/** Invert TXD# */
323#define INVERT_TXD 0x01
324/** Invert RXD# */
325#define INVERT_RXD 0x02
326/** Invert RTS# */
327#define INVERT_RTS 0x04
328/** Invert CTS# */
329#define INVERT_CTS 0x08
330/** Invert DTR# */
331#define INVERT_DTR 0x10
332/** Invert DSR# */
333#define INVERT_DSR 0x20
334/** Invert DCD# */
335#define INVERT_DCD 0x40
336/** Invert RI# */
337#define INVERT_RI 0x80
338
339/** High current drive. */
340#define HIGH_CURRENT_DRIVE 0x04
341
342/**
343 \brief Progress Info for streaming read
344*/
345struct size_and_time
346{
347 uint64_t totalBytes;
348 struct timeval time;
349};
350
351typedef struct
352{
353 struct size_and_time first;
354 struct size_and_time prev;
355 struct size_and_time current;
356 double totalTime;
357 double totalRate;
358 double currentRate;
359} FTDIProgressInfo;
360
361typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
362 FTDIProgressInfo *progress, void *userdata);
363
364
365#ifdef __cplusplus
366extern "C"
367{
368#endif
369
370 int ftdi_init(struct ftdi_context *ftdi);
371 struct ftdi_context *ftdi_new(void);
372 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
373
374 void ftdi_deinit(struct ftdi_context *ftdi);
375 void ftdi_free(struct ftdi_context *ftdi);
376 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
377
378 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
379 int vendor, int product);
380 void ftdi_list_free(struct ftdi_device_list **devlist);
381 void ftdi_list_free2(struct ftdi_device_list *devlist);
382 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
383 char * manufacturer, int mnf_len,
384 char * description, int desc_len,
385 char * serial, int serial_len);
386
387 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
388 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
389 const char* description, const char* serial);
390 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
391 const char* description, const char* serial, unsigned int index);
392 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
393 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
394
395 int ftdi_usb_close(struct ftdi_context *ftdi);
396 int ftdi_usb_reset(struct ftdi_context *ftdi);
397 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
398 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
399 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
400
401 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
402 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
403 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
404 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
405 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
406 enum ftdi_break_type break_type);
407
408 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
409 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
410 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
411
412 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
413 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
414 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
415
416 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
417 void *userdata, int packetsPerTransfer, int numTransfers);
418 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
419 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
420
421 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
422 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
423
424 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
425 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
426 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
427 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
428
429 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
430 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
431
432 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
433
434 /* flow control */
435 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
436 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
437 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
438 int ftdi_setrts(struct ftdi_context *ftdi, int state);
439
440 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
441 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
442
443 /* set eeprom size */
444 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
445
446 /* init and build eeprom from ftdi_eeprom structure */
447 void ftdi_eeprom_initdefaults(struct ftdi_context *ftdi);
448 void ftdi_eeprom_free(struct ftdi_context *ftdi);
449 int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output);
450 int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *output, int size, int verbose);
451
452 /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
453 the checksum of the eeprom is valided */
454 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
455 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
456 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
457 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
458
459 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
460 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
461
462 char *ftdi_get_error_string(struct ftdi_context *ftdi);
463
464#ifdef __cplusplus
465}
466#endif
467
468#endif /* __libftdi_h__ */
A library to talk to FTDI chips