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