Commit | Line | Data |
---|---|---|
a3da1d95 GE |
1 | /*************************************************************************** |
2 | ftdi.h - description | |
3 | ------------------- | |
4 | begin : Fri Apr 4 2003 | |
b25d9165 | 5 | copyright : (C) 2003-2013 by Intra2net AG and the libftdi developers |
5fdb1cb1 | 6 | email : opensource@intra2net.com |
a3da1d95 GE |
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 | ||
fec55667 AL |
20 | #include <stdint.h> |
21 | #include <sys/time.h> | |
0e302db6 | 22 | |
91c9886b | 23 | /** FTDI chip type */ |
c7e4c09e | 24 | 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 }; |
91c9886b | 25 | /** Parity mode for ftdi_set_line_property() */ |
2f73e59f | 26 | enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 }; |
91c9886b | 27 | /** Number of stop bits for ftdi_set_line_property() */ |
2f73e59f | 28 | enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 }; |
91c9886b | 29 | /** Number of bits for ftdi_set_line_property() */ |
2f73e59f | 30 | enum ftdi_bits_type { BITS_7=7, BITS_8=8 }; |
91c9886b | 31 | /** Break type for ftdi_set_line_property2() */ |
6c32e222 | 32 | enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 }; |
2f73e59f | 33 | |
91c9886b | 34 | /** MPSSE bitbang modes */ |
22d12cda TJ |
35 | enum ftdi_mpsse_mode |
36 | { | |
418aaa72 GE |
37 | BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */ |
38 | BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */ | |
39 | BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */ | |
40 | BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */ | |
41 | BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */ | |
42 | /* CPU-style fifo mode gets set via EEPROM */ | |
43 | BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */ | |
44 | BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */ | |
45 | BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */ | |
7a172caf | 46 | BITMODE_FT1284 = 0x80, /**< FT1284 mode, available on 232H chips */ |
c4446c36 TJ |
47 | }; |
48 | ||
418aaa72 | 49 | /** Port interface for chips with multiple interfaces */ |
22d12cda TJ |
50 | enum ftdi_interface |
51 | { | |
c4446c36 TJ |
52 | INTERFACE_ANY = 0, |
53 | INTERFACE_A = 1, | |
f9d69895 AH |
54 | INTERFACE_B = 2, |
55 | INTERFACE_C = 3, | |
56 | INTERFACE_D = 4 | |
c4446c36 TJ |
57 | }; |
58 | ||
a3d86bdb TJ |
59 | /** Automatic loading / unloading of kernel modules */ |
60 | enum ftdi_module_detach_mode | |
61 | { | |
62 | AUTO_DETACH_SIO_MODULE = 0, | |
63 | DONT_DETACH_SIO_MODULE = 1 | |
64 | }; | |
65 | ||
c4446c36 TJ |
66 | /* Shifting commands IN MPSSE Mode*/ |
67 | #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/ | |
68 | #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */ | |
69 | #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */ | |
70 | #define MPSSE_LSB 0x08 /* LSB first */ | |
71 | #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */ | |
72 | #define MPSSE_DO_READ 0x20 /* Read TDO/DI */ | |
73 | #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */ | |
74 | ||
75 | /* FTDI MPSSE commands */ | |
76 | #define SET_BITS_LOW 0x80 | |
77 | /*BYTE DATA*/ | |
78 | /*BYTE Direction*/ | |
79 | #define SET_BITS_HIGH 0x82 | |
80 | /*BYTE DATA*/ | |
81 | /*BYTE Direction*/ | |
82 | #define GET_BITS_LOW 0x81 | |
83 | #define GET_BITS_HIGH 0x83 | |
84 | #define LOOPBACK_START 0x84 | |
85 | #define LOOPBACK_END 0x85 | |
86 | #define TCK_DIVISOR 0x86 | |
c7e4c09e UB |
87 | /* H Type specific commands */ |
88 | #define DIS_DIV_5 0x8a | |
89 | #define EN_DIV_5 0x8b | |
90 | #define EN_3_PHASE 0x8c | |
91 | #define DIS_3_PHASE 0x8d | |
92 | #define CLK_BITS 0x8e | |
93 | #define CLK_BYTES 0x8f | |
94 | #define CLK_WAIT_HIGH 0x94 | |
95 | #define CLK_WAIT_LOW 0x95 | |
96 | #define EN_ADAPTIVE 0x96 | |
97 | #define DIS_ADAPTIVE 0x97 | |
98 | #define CLK_BYTES_OR_HIGH 0x9c | |
99 | #define CLK_BYTES_OR_LOW 0x0d | |
100 | /*FT232H specific commands */ | |
101 | #define DRIVE_OPEN_COLLECTOR 0x9e | |
c4446c36 TJ |
102 | /* Value Low */ |
103 | /* Value HIGH */ /*rate is 12000000/((1+value)*2) */ | |
104 | #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1) | |
105 | ||
106 | /* Commands in MPSSE and Host Emulation Mode */ | |
22d12cda | 107 | #define SEND_IMMEDIATE 0x87 |
c4446c36 TJ |
108 | #define WAIT_ON_HIGH 0x88 |
109 | #define WAIT_ON_LOW 0x89 | |
110 | ||
111 | /* Commands in Host Emulation Mode */ | |
112 | #define READ_SHORT 0x90 | |
113 | /* Address_Low */ | |
114 | #define READ_EXTENDED 0x91 | |
115 | /* Address High */ | |
116 | /* Address Low */ | |
117 | #define WRITE_SHORT 0x92 | |
118 | /* Address_Low */ | |
119 | #define WRITE_EXTENDED 0x93 | |
120 | /* Address High */ | |
121 | /* Address Low */ | |
53ad271d | 122 | |
a01d31e2 | 123 | /* Definitions for flow control */ |
9ecfef2a | 124 | #define SIO_RESET 0 /* Reset the port */ |
a01d31e2 TJ |
125 | #define SIO_MODEM_CTRL 1 /* Set the modem control register */ |
126 | #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */ | |
9ecfef2a TJ |
127 | #define SIO_SET_BAUD_RATE 3 /* Set baud rate */ |
128 | #define SIO_SET_DATA 4 /* Set the data characteristics of the port */ | |
129 | ||
579b006f JZ |
130 | #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT) |
131 | #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN) | |
a5e1bd8c MK |
132 | |
133 | /* Requests */ | |
134 | #define SIO_RESET_REQUEST SIO_RESET | |
135 | #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE | |
136 | #define SIO_SET_DATA_REQUEST SIO_SET_DATA | |
137 | #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL | |
138 | #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL | |
139 | #define SIO_POLL_MODEM_STATUS_REQUEST 0x05 | |
140 | #define SIO_SET_EVENT_CHAR_REQUEST 0x06 | |
141 | #define SIO_SET_ERROR_CHAR_REQUEST 0x07 | |
142 | #define SIO_SET_LATENCY_TIMER_REQUEST 0x09 | |
143 | #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A | |
144 | #define SIO_SET_BITMODE_REQUEST 0x0B | |
145 | #define SIO_READ_PINS_REQUEST 0x0C | |
146 | #define SIO_READ_EEPROM_REQUEST 0x90 | |
147 | #define SIO_WRITE_EEPROM_REQUEST 0x91 | |
148 | #define SIO_ERASE_EEPROM_REQUEST 0x92 | |
149 | ||
150 | ||
9ecfef2a TJ |
151 | #define SIO_RESET_SIO 0 |
152 | #define SIO_RESET_PURGE_RX 1 | |
153 | #define SIO_RESET_PURGE_TX 2 | |
154 | ||
22d12cda | 155 | #define SIO_DISABLE_FLOW_CTRL 0x0 |
a01d31e2 TJ |
156 | #define SIO_RTS_CTS_HS (0x1 << 8) |
157 | #define SIO_DTR_DSR_HS (0x2 << 8) | |
158 | #define SIO_XON_XOFF_HS (0x4 << 8) | |
159 | ||
a01d31e2 TJ |
160 | #define SIO_SET_DTR_MASK 0x1 |
161 | #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8)) | |
162 | #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8)) | |
163 | #define SIO_SET_RTS_MASK 0x2 | |
164 | #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 )) | |
165 | #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 )) | |
166 | ||
167 | #define SIO_RTS_CTS_HS (0x1 << 8) | |
168 | ||
7cc9950e GE |
169 | /* marker for unused usb urb structures |
170 | (taken from libusb) */ | |
171 | #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1) | |
172 | ||
fd282db3 GE |
173 | #ifdef __GNUC__ |
174 | #define DEPRECATED(func) func __attribute__ ((deprecated)) | |
175 | #elif defined(_MSC_VER) | |
176 | #define DEPRECATED(func) __declspec(deprecated) func | |
177 | #else | |
178 | #pragma message("WARNING: You need to implement DEPRECATED for this compiler") | |
179 | #define DEPRECATED(func) func | |
180 | #endif | |
181 | ||
579b006f JZ |
182 | struct ftdi_transfer_control |
183 | { | |
184 | int completed; | |
185 | unsigned char *buf; | |
186 | int size; | |
187 | int offset; | |
188 | struct ftdi_context *ftdi; | |
189 | struct libusb_transfer *transfer; | |
190 | }; | |
fd282db3 | 191 | |
9bec2387 | 192 | /** |
b5ec1820 | 193 | \brief Main context structure for all libftdi functions. |
a01d31e2 | 194 | |
9bec2387 TJ |
195 | Do not access directly if possible. |
196 | */ | |
22d12cda TJ |
197 | struct ftdi_context |
198 | { | |
91c9886b | 199 | /* USB specific */ |
02212d8e UB |
200 | /** libusb's context */ |
201 | struct libusb_context *usb_ctx; | |
91c9886b | 202 | /** libusb's usb_dev_handle */ |
579b006f | 203 | struct libusb_device_handle *usb_dev; |
91c9886b | 204 | /** usb read timeout */ |
545820ce | 205 | int usb_read_timeout; |
91c9886b | 206 | /** usb write timeout */ |
545820ce | 207 | int usb_write_timeout; |
a3da1d95 | 208 | |
91c9886b MJ |
209 | /* FTDI specific */ |
210 | /** FTDI chip type */ | |
53ad271d | 211 | enum ftdi_chip_type type; |
91c9886b | 212 | /** baudrate */ |
a3da1d95 | 213 | int baudrate; |
91c9886b | 214 | /** bitbang mode state */ |
a3da1d95 | 215 | unsigned char bitbang_enabled; |
91c9886b | 216 | /** pointer to read buffer for ftdi_read_data */ |
948f9ada | 217 | unsigned char *readbuffer; |
91c9886b | 218 | /** read buffer offset */ |
4ece2c24 | 219 | unsigned int readbuffer_offset; |
91c9886b | 220 | /** number of remaining data in internal read buffer */ |
4ece2c24 | 221 | unsigned int readbuffer_remaining; |
91c9886b | 222 | /** read buffer chunk size */ |
948f9ada | 223 | unsigned int readbuffer_chunksize; |
91c9886b | 224 | /** write buffer chunk size */ |
948f9ada | 225 | unsigned int writebuffer_chunksize; |
e2f12a4f TJ |
226 | /** maximum packet size. Needed for filtering modem status bytes every n packets. */ |
227 | unsigned int max_packet_size; | |
d9f0cce7 | 228 | |
91c9886b MJ |
229 | /* FTDI FT2232C requirecments */ |
230 | /** FT2232C interface number: 0 or 1 */ | |
231 | int interface; /* 0 or 1 */ | |
232 | /** FT2232C index number: 1 or 2 */ | |
233 | int index; /* 1 or 2 */ | |
234 | /* Endpoints */ | |
235 | /** FT2232C end points: 1 or 2 */ | |
545820ce | 236 | int in_ep; |
91c9886b | 237 | int out_ep; /* 1 or 2 */ |
c3d95b87 | 238 | |
91c9886b | 239 | /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */ |
3119537f | 240 | unsigned char bitbang_mode; |
545820ce | 241 | |
c0a96aed UB |
242 | /** Decoded eeprom structure */ |
243 | struct ftdi_eeprom *eeprom; | |
c201f80f | 244 | |
91c9886b | 245 | /** String representation of last error */ |
a3da1d95 | 246 | char *error_str; |
a3d86bdb TJ |
247 | |
248 | /** Defines behavior in case a kernel module is already attached to the device */ | |
249 | enum ftdi_module_detach_mode module_detach_mode; | |
a3da1d95 GE |
250 | }; |
251 | ||
9bec2387 | 252 | /** |
44ef02bd UB |
253 | List all handled EEPROM values. |
254 | Append future new values only at the end to provide API/ABI stability*/ | |
255 | enum ftdi_eeprom_value | |
256 | { | |
257 | VENDOR_ID = 0, | |
258 | PRODUCT_ID = 1, | |
259 | SELF_POWERED = 2, | |
260 | REMOTE_WAKEUP = 3, | |
261 | IS_NOT_PNP = 4, | |
262 | SUSPEND_DBUS7 = 5, | |
263 | IN_IS_ISOCHRONOUS = 6, | |
264 | OUT_IS_ISOCHRONOUS = 7, | |
265 | SUSPEND_PULL_DOWNS = 8, | |
266 | USE_SERIAL = 9, | |
267 | USB_VERSION = 10, | |
268 | USE_USB_VERSION = 11, | |
269 | MAX_POWER = 12, | |
270 | CHANNEL_A_TYPE = 13, | |
271 | CHANNEL_B_TYPE = 14, | |
272 | CHANNEL_A_DRIVER = 15, | |
273 | CHANNEL_B_DRIVER = 16, | |
274 | CBUS_FUNCTION_0 = 17, | |
275 | CBUS_FUNCTION_1 = 18, | |
276 | CBUS_FUNCTION_2 = 19, | |
277 | CBUS_FUNCTION_3 = 20, | |
278 | CBUS_FUNCTION_4 = 21, | |
263d3ba0 UB |
279 | CBUS_FUNCTION_5 = 22, |
280 | CBUS_FUNCTION_6 = 23, | |
281 | CBUS_FUNCTION_7 = 24, | |
282 | CBUS_FUNCTION_8 = 25, | |
283 | CBUS_FUNCTION_9 = 26, | |
284 | HIGH_CURRENT = 27, | |
285 | HIGH_CURRENT_A = 28, | |
286 | HIGH_CURRENT_B = 29, | |
287 | INVERT = 30, | |
288 | GROUP0_DRIVE = 31, | |
289 | GROUP0_SCHMITT = 32, | |
290 | GROUP0_SLEW = 33, | |
291 | GROUP1_DRIVE = 34, | |
292 | GROUP1_SCHMITT = 35, | |
293 | GROUP1_SLEW = 36, | |
294 | GROUP2_DRIVE = 37, | |
295 | GROUP2_SCHMITT = 38, | |
296 | GROUP2_SLEW = 39, | |
297 | GROUP3_DRIVE = 40, | |
298 | GROUP3_SCHMITT = 41, | |
299 | GROUP3_SLEW = 42, | |
300 | CHIP_SIZE = 43, | |
301 | CHIP_TYPE = 44, | |
302 | POWER_SAVE = 45, | |
303 | CLOCK_POLARITY = 46, | |
304 | DATA_ORDER = 47, | |
be4bae37 AL |
305 | FLOW_CONTROL = 48, |
306 | CHANNEL_C_DRIVER = 49, | |
307 | CHANNEL_D_DRIVER = 50, | |
308 | CHANNEL_A_RS485 = 51, | |
309 | CHANNEL_B_RS485 = 52, | |
310 | CHANNEL_C_RS485 = 53, | |
311 | CHANNEL_D_RS485 = 54, | |
44ef02bd UB |
312 | }; |
313 | ||
314 | /** | |
b5ec1820 | 315 | \brief list of usb devices created by ftdi_usb_find_all() |
9bec2387 | 316 | */ |
22d12cda TJ |
317 | struct ftdi_device_list |
318 | { | |
91c9886b | 319 | /** pointer to next entry */ |
edb82cbf | 320 | struct ftdi_device_list *next; |
91c9886b | 321 | /** pointer to libusb's usb_device */ |
579b006f | 322 | struct libusb_device *dev; |
edb82cbf | 323 | }; |
18199b76 | 324 | #define FT1284_CLK_IDLE_STATE 0x01 |
7a172caf | 325 | #define FT1284_DATA_LSB 0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/ |
18199b76 | 326 | #define FT1284_FLOW_CONTROL 0x04 |
837a71d6 UB |
327 | #define POWER_SAVE_DISABLE_H 0x80 |
328 | ||
a02587d5 | 329 | #define USE_SERIAL_NUM 0x08 |
45619eaa UB |
330 | enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */ |
331 | CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4, | |
332 | CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9, | |
2c2953e6 | 333 | CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd}; |
f505134f | 334 | |
263d3ba0 UB |
335 | enum ftdi_cbush_func {/* FIXME: Recheck value, especially the last */ |
336 | CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4, | |
337 | CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9, | |
338 | CBUSH_CLK30 = 0xa, CBUSH_CLK15 = 0xb, CBUSH_CLK7_5 = 0xc}; | |
339 | ||
f505134f HK |
340 | /** Invert TXD# */ |
341 | #define INVERT_TXD 0x01 | |
342 | /** Invert RXD# */ | |
343 | #define INVERT_RXD 0x02 | |
344 | /** Invert RTS# */ | |
345 | #define INVERT_RTS 0x04 | |
346 | /** Invert CTS# */ | |
347 | #define INVERT_CTS 0x08 | |
348 | /** Invert DTR# */ | |
349 | #define INVERT_DTR 0x10 | |
350 | /** Invert DSR# */ | |
351 | #define INVERT_DSR 0x20 | |
352 | /** Invert DCD# */ | |
353 | #define INVERT_DCD 0x40 | |
354 | /** Invert RI# */ | |
355 | #define INVERT_RI 0x80 | |
356 | ||
308f1fa7 UB |
357 | /** Interface Mode. */ |
358 | #define CHANNEL_IS_UART 0x0 | |
c8f69686 UB |
359 | #define CHANNEL_IS_FIFO 0x1 |
360 | #define CHANNEL_IS_OPTO 0x2 | |
361 | #define CHANNEL_IS_CPU 0x4 | |
362 | #define CHANNEL_IS_FT1284 0x8 | |
308f1fa7 | 363 | |
be4bae37 AL |
364 | #define CHANNEL_IS_RS485 0x10 |
365 | ||
db099ec5 UB |
366 | #define DRIVE_4MA 0 |
367 | #define DRIVE_8MA 1 | |
368 | #define DRIVE_12MA 2 | |
369 | #define DRIVE_16MA 3 | |
370 | #define SLOW_SLEW 4 | |
371 | #define IS_SCHMITT 8 | |
372 | ||
308f1fa7 | 373 | /** Driver Type. */ |
2cde7c52 | 374 | #define DRIVER_VCP 0x08 |
ac4a82a5 | 375 | #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */ |
308f1fa7 | 376 | |
caec1294 UB |
377 | #define USE_USB_VERSION_BIT 0x10 |
378 | ||
ec0dcd3f | 379 | #define SUSPEND_DBUS7_BIT 0x80 |
02e4a740 | 380 | |
f505134f | 381 | /** High current drive. */ |
ca41c8ee | 382 | #define HIGH_CURRENT_DRIVE 0x10 |
75388926 | 383 | #define HIGH_CURRENT_DRIVE_R 0x04 |
f505134f | 384 | |
9bec2387 | 385 | /** |
40da63b1 UB |
386 | \brief Progress Info for streaming read |
387 | */ | |
388 | struct size_and_time | |
389 | { | |
390 | uint64_t totalBytes; | |
391 | struct timeval time; | |
392 | }; | |
393 | ||
394 | typedef struct | |
395 | { | |
396 | struct size_and_time first; | |
397 | struct size_and_time prev; | |
398 | struct size_and_time current; | |
399 | double totalTime; | |
400 | double totalRate; | |
401 | double currentRate; | |
402 | } FTDIProgressInfo; | |
403 | ||
404 | typedef int (FTDIStreamCallback)(uint8_t *buffer, int length, | |
405 | FTDIProgressInfo *progress, void *userdata); | |
406 | ||
0220adfa TJ |
407 | /** |
408 | * Provide libftdi version information | |
409 | * major: Library major version | |
410 | * minor: Library minor version | |
411 | * micro: Currently unused, ight get used for hotfixes. | |
412 | * version_str: Version as (static) string | |
413 | * snapshot_str: Git snapshot version if known. Otherwise "unknown" or empty string. | |
414 | */ | |
415 | struct ftdi_version_info | |
416 | { | |
417 | int major; | |
418 | int minor; | |
419 | int micro; | |
420 | const char *version_str; | |
421 | const char *snapshot_str; | |
422 | }; | |
423 | ||
40da63b1 | 424 | |
a3da1d95 | 425 | #ifdef __cplusplus |
22d12cda TJ |
426 | extern "C" |
427 | { | |
a3da1d95 GE |
428 | #endif |
429 | ||
430 | int ftdi_init(struct ftdi_context *ftdi); | |
672ac008 | 431 | struct ftdi_context *ftdi_new(void); |
0ce2f5fa | 432 | int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface); |
c4446c36 | 433 | |
948f9ada | 434 | void ftdi_deinit(struct ftdi_context *ftdi); |
cef378aa | 435 | void ftdi_free(struct ftdi_context *ftdi); |
579b006f | 436 | void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev); |
a01d31e2 | 437 | |
0220adfa TJ |
438 | struct ftdi_version_info ftdi_get_library_version(); |
439 | ||
edb82cbf TJ |
440 | int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, |
441 | int vendor, int product); | |
442 | void ftdi_list_free(struct ftdi_device_list **devlist); | |
cef378aa | 443 | void ftdi_list_free2(struct ftdi_device_list *devlist); |
579b006f | 444 | int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev, |
474786c0 TJ |
445 | char * manufacturer, int mnf_len, |
446 | char * description, int desc_len, | |
447 | char * serial, int serial_len); | |
a01d31e2 | 448 | |
a3da1d95 | 449 | int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product); |
a8f46ddc TJ |
450 | int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, |
451 | const char* description, const char* serial); | |
5ebbdab9 GE |
452 | int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, |
453 | const char* description, const char* serial, unsigned int index); | |
579b006f | 454 | int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev); |
5ebbdab9 | 455 | int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description); |
1941414d | 456 | |
a3da1d95 GE |
457 | int ftdi_usb_close(struct ftdi_context *ftdi); |
458 | int ftdi_usb_reset(struct ftdi_context *ftdi); | |
1189b11a TJ |
459 | int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi); |
460 | int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi); | |
a60be878 | 461 | int ftdi_usb_purge_buffers(struct ftdi_context *ftdi); |
a3da1d95 GE |
462 | |
463 | int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate); | |
2f73e59f TJ |
464 | int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
465 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity); | |
6c32e222 | 466 | int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
22d12cda TJ |
467 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, |
468 | enum ftdi_break_type break_type); | |
948f9ada | 469 | |
be5d7eec | 470 | int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size); |
948f9ada TJ |
471 | int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); |
472 | int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); | |
473 | ||
474 | int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size); | |
475 | int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); | |
476 | int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); | |
a3da1d95 | 477 | |
1ec530dc | 478 | int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback, |
50f4957a | 479 | void *userdata, int packetsPerTransfer, int numTransfers); |
1ec530dc | 480 | struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size); |
7cc9950e | 481 | |
866a6dbb JZ |
482 | struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size); |
483 | int ftdi_transfer_data_done(struct ftdi_transfer_control *tc); | |
484 | ||
c4446c36 | 485 | int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode); |
2d790e37 | 486 | int ftdi_disable_bitbang(struct ftdi_context *ftdi); |
a3da1d95 GE |
487 | int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins); |
488 | ||
489 | int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency); | |
490 | int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency); | |
491 | ||
1189b11a TJ |
492 | int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status); |
493 | ||
91c9886b | 494 | /* flow control */ |
a7fb8440 | 495 | int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl); |
9ecfef2a | 496 | int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts); |
a7fb8440 TJ |
497 | int ftdi_setdtr(struct ftdi_context *ftdi, int state); |
498 | int ftdi_setrts(struct ftdi_context *ftdi, int state); | |
499 | ||
1189b11a TJ |
500 | int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable); |
501 | int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable); | |
502 | ||
f14f84d3 UB |
503 | /* init eeprom for the given FTDI type */ |
504 | int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, | |
74e8e79d UB |
505 | char * manufacturer, char *product, |
506 | char * serial); | |
a35aa9bd UB |
507 | int ftdi_eeprom_build(struct ftdi_context *ftdi); |
508 | int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose); | |
b8aa7b35 | 509 | |
44ef02bd UB |
510 | int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value); |
511 | int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value); | |
512 | ||
513 | int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size); | |
672fd368 | 514 | int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size); |
44ef02bd | 515 | |
a35aa9bd | 516 | int ftdi_read_eeprom(struct ftdi_context *ftdi); |
cb6250fa | 517 | int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid); |
a35aa9bd | 518 | int ftdi_write_eeprom(struct ftdi_context *ftdi); |
b8aa7b35 | 519 | int ftdi_erase_eeprom(struct ftdi_context *ftdi); |
a3da1d95 | 520 | |
c1c70e13 OS |
521 | int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val); |
522 | int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val); | |
523 | ||
c3d95b87 | 524 | char *ftdi_get_error_string(struct ftdi_context *ftdi); |
c1c70e13 | 525 | |
a3da1d95 GE |
526 | #ifdef __cplusplus |
527 | } | |
528 | #endif | |
529 | ||
530 | #endif /* __libftdi_h__ */ |