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