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