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