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