Add ftdi_set_eeprom_buf() as proposed in ftdi_eeprom
[libftdi] / src / ftdi.h
1 /***************************************************************************
2                           ftdi.h  -  description
3                              -------------------
4     begin                : Fri Apr 4 2003
5     copyright            : (C) 2003-2011 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 <libusb.h>
21
22 /* Even on 93xx66 at max 256 bytes are used (AN_121)*/
23 #define FTDI_MAX_EEPROM_SIZE 256
24
25 /** FTDI chip type */
26 enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5, TYPE_232H=6 };
27 /** Parity mode for ftdi_set_line_property() */
28 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
29 /** Number of stop bits for ftdi_set_line_property() */
30 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
31 /** Number of bits for ftdi_set_line_property() */
32 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
33 /** Break type for ftdi_set_line_property2() */
34 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
35
36 /** MPSSE bitbang modes */
37 enum ftdi_mpsse_mode
38 {
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 */
48     BITMODE_FT1284 = 0x80,    /**< FT1284 mode, available on 232H chips */
49 };
50
51 /** Port interface for chips with multiple interfaces */
52 enum ftdi_interface
53 {
54     INTERFACE_ANY = 0,
55     INTERFACE_A   = 1,
56     INTERFACE_B   = 2,
57     INTERFACE_C   = 3,
58     INTERFACE_D   = 4
59 };
60
61 /** Automatic loading / unloading of kernel modules */
62 enum ftdi_module_detach_mode
63 {
64     AUTO_DETACH_SIO_MODULE = 0,
65     DONT_DETACH_SIO_MODULE = 1
66 };
67
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
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
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 */
109 #define SEND_IMMEDIATE 0x87
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  */
124
125 /* Definitions for flow control */
126 #define SIO_RESET          0 /* Reset the port */
127 #define SIO_MODEM_CTRL     1 /* Set the modem control register */
128 #define SIO_SET_FLOW_CTRL  2 /* Set flow control register */
129 #define SIO_SET_BAUD_RATE  3 /* Set baud rate */
130 #define SIO_SET_DATA       4 /* Set the data characteristics of the port */
131
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)
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
153 #define SIO_RESET_SIO 0
154 #define SIO_RESET_PURGE_RX 1
155 #define SIO_RESET_PURGE_TX 2
156
157 #define SIO_DISABLE_FLOW_CTRL 0x0
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
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
171 /* marker for unused usb urb structures
172    (taken from libusb) */
173 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
174
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
184 struct 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 };
193
194 /**
195     \brief FTDI eeprom structure
196 */
197 struct ftdi_eeprom
198 {
199     /** vendor id */
200     int vendor_id;
201     /** product id */
202     int product_id;
203
204     /** self powered */
205     int self_powered;
206     /** remote wakeup */
207     int remote_wakeup;
208
209     int is_not_pnp;
210
211     /* Suspend on DBUS7 Low */
212     int suspend_dbus7;
213
214     /** input in isochronous transfer mode */
215     int in_is_isochronous;
216     /** output in isochronous transfer mode */
217     int out_is_isochronous;
218     /** suspend pull downs */
219     int suspend_pull_downs;
220
221     /** use serial */
222     int use_serial;
223     /** usb version */
224     int usb_version;
225     /** Use usb version on FT2232 devices*/
226     int use_usb_version;
227      /** maximum power */
228     int max_power;
229
230     /** manufacturer name */
231     char *manufacturer;
232     /** product name */
233     char *product;
234     /** serial number */
235     char *serial;
236
237     /* 2232D/H(/FT4432H?) specific */
238     /* Hardware type, 0 = RS232 Uart, 1 = 245 FIFO, 2 = CPU FIFO, 
239        4 = OPTO Isolate */
240     int channel_a_type;
241     int channel_b_type;
242     /*  Driver Type, 1 = VCP */
243     int channel_a_driver;
244     int channel_b_driver;
245
246     /* Special function of FT232R/FT232H devices (and possibly others as well) */
247     /** CBUS pin function. See CBUS_xxx defines. */
248     int cbus_function[9];
249     /** Select hight current drive on R devices. */
250     int high_current;
251     /** Select hight current drive on A channel (2232C */
252     int high_current_a;
253     /** Select hight current drive on B channel (2232C). */
254     int high_current_b;
255     /** Select inversion of data lines (bitmask). */
256     int invert;
257
258     /*2232H/4432H Group specific values */
259     /* Group0 is AL on 2322H and A on 4232H
260        Group1 is AH on 2232H and B on 4232H
261        Group2 is BL on 2322H and C on 4232H
262        Group3 is BH on 2232H and C on 4232H*/
263     int group0_drive;
264     int group0_schmitt;
265     int group0_slew;
266     int group1_drive;
267     int group1_schmitt;
268     int group1_slew;
269     int group2_drive;
270     int group2_schmitt;
271     int group2_slew;
272     int group3_drive;
273     int group3_schmitt;
274     int group3_slew;
275
276     int powersave;
277     
278     int clock_polarity;
279     int data_order;
280     int flow_control;
281
282     /** eeprom size in bytes. This doesn't get stored in the eeprom
283         but is the only way to pass it to ftdi_eeprom_build. */
284     int size;
285     /* EEPROM Type 0x46 for 93xx46, 0x56 for 93xx56 and 0x66 for 93xx66*/
286     int chip;
287     unsigned char buf[FTDI_MAX_EEPROM_SIZE];
288 };
289
290 /**
291     \brief Main context structure for all libftdi functions.
292
293     Do not access directly if possible.
294 */
295 struct ftdi_context
296 {
297     /* USB specific */
298     /** libusb's context */
299     struct libusb_context *usb_ctx;
300     /** libusb's usb_dev_handle */
301     struct libusb_device_handle *usb_dev;
302     /** usb read timeout */
303     int usb_read_timeout;
304     /** usb write timeout */
305     int usb_write_timeout;
306
307     /* FTDI specific */
308     /** FTDI chip type */
309     enum ftdi_chip_type type;
310     /** baudrate */
311     int baudrate;
312     /** bitbang mode state */
313     unsigned char bitbang_enabled;
314     /** pointer to read buffer for ftdi_read_data */
315     unsigned char *readbuffer;
316     /** read buffer offset */
317     unsigned int readbuffer_offset;
318     /** number of remaining data in internal read buffer */
319     unsigned int readbuffer_remaining;
320     /** read buffer chunk size */
321     unsigned int readbuffer_chunksize;
322     /** write buffer chunk size */
323     unsigned int writebuffer_chunksize;
324     /** maximum packet size. Needed for filtering modem status bytes every n packets. */
325     unsigned int max_packet_size;
326
327     /* FTDI FT2232C requirecments */
328     /** FT2232C interface number: 0 or 1 */
329     int interface;   /* 0 or 1 */
330     /** FT2232C index number: 1 or 2 */
331     int index;       /* 1 or 2 */
332     /* Endpoints */
333     /** FT2232C end points: 1 or 2 */
334     int in_ep;
335     int out_ep;      /* 1 or 2 */
336
337     /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
338     unsigned char bitbang_mode;
339
340     /** Decoded eeprom structure */
341     struct ftdi_eeprom *eeprom;
342
343     /** String representation of last error */
344     char *error_str;
345
346     /** Defines behavior in case a kernel module is already attached to the device */
347     enum ftdi_module_detach_mode module_detach_mode;
348 };
349
350 /**
351  List all handled EEPROM values.
352    Append future new values only at the end to provide API/ABI stability*/
353 enum ftdi_eeprom_value
354 {
355     VENDOR_ID          = 0,
356     PRODUCT_ID         = 1,
357     SELF_POWERED       = 2,
358     REMOTE_WAKEUP      = 3,
359     IS_NOT_PNP         = 4,
360     SUSPEND_DBUS7      = 5,
361     IN_IS_ISOCHRONOUS  = 6,
362     OUT_IS_ISOCHRONOUS = 7,
363     SUSPEND_PULL_DOWNS = 8,
364     USE_SERIAL         = 9,
365     USB_VERSION        = 10,
366     USE_USB_VERSION    = 11,
367     MAX_POWER          = 12,
368     CHANNEL_A_TYPE     = 13,
369     CHANNEL_B_TYPE     = 14,
370     CHANNEL_A_DRIVER   = 15,
371     CHANNEL_B_DRIVER   = 16,
372     CBUS_FUNCTION_0    = 17,
373     CBUS_FUNCTION_1    = 18,
374     CBUS_FUNCTION_2    = 19,
375     CBUS_FUNCTION_3    = 20,
376     CBUS_FUNCTION_4    = 21,
377     CBUS_FUNCTION_5    = 22,
378     CBUS_FUNCTION_6    = 23,
379     CBUS_FUNCTION_7    = 24,
380     CBUS_FUNCTION_8    = 25,
381     CBUS_FUNCTION_9    = 26,
382     HIGH_CURRENT       = 27,
383     HIGH_CURRENT_A     = 28,
384     HIGH_CURRENT_B     = 29,
385     INVERT             = 30,
386     GROUP0_DRIVE       = 31,
387     GROUP0_SCHMITT     = 32,
388     GROUP0_SLEW        = 33,
389     GROUP1_DRIVE       = 34,
390     GROUP1_SCHMITT     = 35,
391     GROUP1_SLEW        = 36,
392     GROUP2_DRIVE       = 37,
393     GROUP2_SCHMITT     = 38,
394     GROUP2_SLEW        = 39,
395     GROUP3_DRIVE       = 40,
396     GROUP3_SCHMITT     = 41,
397     GROUP3_SLEW        = 42,
398     CHIP_SIZE          = 43,
399     CHIP_TYPE          = 44,
400     POWER_SAVE         = 45,
401     CLOCK_POLARITY     = 46,
402     DATA_ORDER         = 47,
403     FLOW_CONTROL       = 48
404 };
405
406 /**
407     \brief list of usb devices created by ftdi_usb_find_all()
408 */
409 struct ftdi_device_list
410 {
411     /** pointer to next entry */
412     struct ftdi_device_list *next;
413     /** pointer to libusb's usb_device */
414     struct libusb_device *dev;
415 };
416 #define FT1284_CLK_IDLE_STATE 0x01
417 #define FT1284_DATA_LSB       0x02 /* DS_FT232H 1.3 amd ftd2xx.h 1.0.4 disagree here*/
418 #define FT1284_FLOW_CONTROL   0x04
419 #define POWER_SAVE_DISABLE_H 0x80
420
421 #define USE_SERIAL_NUM 0x08
422 enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
423     CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
424     CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 =  9,
425     CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB   = 0xd};
426
427 enum ftdi_cbush_func {/* FIXME: Recheck value, especially the last */
428     CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4,
429     CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN =  9,
430     CBUSH_CLK30 = 0xa, CBUSH_CLK15 = 0xb, CBUSH_CLK7_5 = 0xc};
431
432 /** Invert TXD# */
433 #define INVERT_TXD 0x01
434 /** Invert RXD# */
435 #define INVERT_RXD 0x02
436 /** Invert RTS# */
437 #define INVERT_RTS 0x04
438 /** Invert CTS# */
439 #define INVERT_CTS 0x08
440 /** Invert DTR# */
441 #define INVERT_DTR 0x10
442 /** Invert DSR# */
443 #define INVERT_DSR 0x20
444 /** Invert DCD# */
445 #define INVERT_DCD 0x40
446 /** Invert RI# */
447 #define INVERT_RI  0x80
448
449 /** Interface Mode. */
450 #define CHANNEL_IS_UART 0x0
451 #define CHANNEL_IS_245  0x1
452 #define CHANNEL_IS_CPU  0x2
453 #define CHANNEL_IS_OPTO 0x3
454 #define CHANNEL_IS_FT1284 0x4
455
456 #define DRIVE_4MA  0
457 #define DRIVE_8MA  1
458 #define DRIVE_12MA 2
459 #define DRIVE_16MA 3
460 #define SLOW_SLEW  4
461 #define IS_SCHMITT 8
462
463 /** Driver Type. */
464 #define DRIVER_VCP 0x08
465 #define DRIVER_VCPH 0x10 /* FT232H has moved the VCP bit */
466
467 #define USE_USB_VERSION_BIT 0x10
468
469 #define SUSPEND_DBUS7_BIT 0x80
470
471 /** High current drive. */
472 #define HIGH_CURRENT_DRIVE   0x10
473 #define HIGH_CURRENT_DRIVE_R 0x04
474
475 /**
476     \brief Progress Info for streaming read
477 */
478 struct size_and_time
479 {
480         uint64_t totalBytes;
481         struct timeval time;
482 };
483
484 typedef struct
485 {
486     struct size_and_time first;
487     struct size_and_time prev;
488     struct size_and_time current;
489     double totalTime;
490     double totalRate;
491     double currentRate;
492 } FTDIProgressInfo;
493
494 typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
495                                  FTDIProgressInfo *progress, void *userdata);
496
497
498 #ifdef __cplusplus
499 extern "C"
500 {
501 #endif
502
503     int ftdi_init(struct ftdi_context *ftdi);
504     struct ftdi_context *ftdi_new(void);
505     int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
506
507     void ftdi_deinit(struct ftdi_context *ftdi);
508     void ftdi_free(struct ftdi_context *ftdi);
509     void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
510
511     int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
512                           int vendor, int product);
513     void ftdi_list_free(struct ftdi_device_list **devlist);
514     void ftdi_list_free2(struct ftdi_device_list *devlist);
515     int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
516                              char * manufacturer, int mnf_len,
517                              char * description, int desc_len,
518                              char * serial, int serial_len);
519
520     int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
521     int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
522                            const char* description, const char* serial);
523     int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
524                            const char* description, const char* serial, unsigned int index);
525     int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
526     int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
527
528     int ftdi_usb_close(struct ftdi_context *ftdi);
529     int ftdi_usb_reset(struct ftdi_context *ftdi);
530     int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
531     int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
532     int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
533
534     int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
535     int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
536                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
537     int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
538                                 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
539                                 enum ftdi_break_type break_type);
540
541     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
542     int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
543     int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
544
545     int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
546     int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
547     int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
548
549     int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback, 
550                         void *userdata, int packetsPerTransfer, int numTransfers);
551     int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
552     void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
553
554     struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
555     int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
556
557     int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
558     int ftdi_disable_bitbang(struct ftdi_context *ftdi);
559     int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
560     int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
561
562     int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
563     int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
564
565     int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
566
567     /* flow control */
568     int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
569     int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
570     int ftdi_setdtr(struct ftdi_context *ftdi, int state);
571     int ftdi_setrts(struct ftdi_context *ftdi, int state);
572
573     int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
574     int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
575
576     /* init eeprom for the given FTDI type */
577     int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, 
578                                   char * manufacturer, char *product, 
579                                   char * serial);
580     int ftdi_eeprom_build(struct ftdi_context *ftdi);
581     int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
582
583     int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
584     int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int  value);
585
586     int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
587     int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size);
588
589     int ftdi_read_eeprom(struct ftdi_context *ftdi);
590     int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
591     int ftdi_write_eeprom(struct ftdi_context *ftdi);
592     int ftdi_erase_eeprom(struct ftdi_context *ftdi);
593
594     int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
595     int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
596
597     char *ftdi_get_error_string(struct ftdi_context *ftdi);
598
599 #ifdef __cplusplus
600 }
601 #endif
602
603 #endif /* __libftdi_h__ */