git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Fix small typo
[libftdi] / src / ftdi.h
... / ...
CommitLineData
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 */
26enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 };
27/** Parity mode for ftdi_set_line_property() */
28enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
29/** Number of stop bits for ftdi_set_line_property() */
30enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
31/** Number of bits for ftdi_set_line_property() */
32enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
33/** Break type for ftdi_set_line_property2() */
34enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
35
36/** MPSSE bitbang modes */
37enum 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};
49
50/** Port interface for chips with multiple interfaces */
51enum ftdi_interface
52{
53 INTERFACE_ANY = 0,
54 INTERFACE_A = 1,
55 INTERFACE_B = 2,
56 INTERFACE_C = 3,
57 INTERFACE_D = 4
58};
59
60/* Shifting commands IN MPSSE Mode*/
61#define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
62#define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
63#define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
64#define MPSSE_LSB 0x08 /* LSB first */
65#define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
66#define MPSSE_DO_READ 0x20 /* Read TDO/DI */
67#define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
68
69/* FTDI MPSSE commands */
70#define SET_BITS_LOW 0x80
71/*BYTE DATA*/
72/*BYTE Direction*/
73#define SET_BITS_HIGH 0x82
74/*BYTE DATA*/
75/*BYTE Direction*/
76#define GET_BITS_LOW 0x81
77#define GET_BITS_HIGH 0x83
78#define LOOPBACK_START 0x84
79#define LOOPBACK_END 0x85
80#define TCK_DIVISOR 0x86
81/* Value Low */
82/* Value HIGH */ /*rate is 12000000/((1+value)*2) */
83#define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
84
85/* Commands in MPSSE and Host Emulation Mode */
86#define SEND_IMMEDIATE 0x87
87#define WAIT_ON_HIGH 0x88
88#define WAIT_ON_LOW 0x89
89
90/* Commands in Host Emulation Mode */
91#define READ_SHORT 0x90
92/* Address_Low */
93#define READ_EXTENDED 0x91
94/* Address High */
95/* Address Low */
96#define WRITE_SHORT 0x92
97/* Address_Low */
98#define WRITE_EXTENDED 0x93
99/* Address High */
100/* Address Low */
101
102/* Definitions for flow control */
103#define SIO_RESET 0 /* Reset the port */
104#define SIO_MODEM_CTRL 1 /* Set the modem control register */
105#define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
106#define SIO_SET_BAUD_RATE 3 /* Set baud rate */
107#define SIO_SET_DATA 4 /* Set the data characteristics of the port */
108
109#define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT)
110#define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN)
111
112/* Requests */
113#define SIO_RESET_REQUEST SIO_RESET
114#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
115#define SIO_SET_DATA_REQUEST SIO_SET_DATA
116#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
117#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
118#define SIO_POLL_MODEM_STATUS_REQUEST 0x05
119#define SIO_SET_EVENT_CHAR_REQUEST 0x06
120#define SIO_SET_ERROR_CHAR_REQUEST 0x07
121#define SIO_SET_LATENCY_TIMER_REQUEST 0x09
122#define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
123#define SIO_SET_BITMODE_REQUEST 0x0B
124#define SIO_READ_PINS_REQUEST 0x0C
125#define SIO_READ_EEPROM_REQUEST 0x90
126#define SIO_WRITE_EEPROM_REQUEST 0x91
127#define SIO_ERASE_EEPROM_REQUEST 0x92
128
129
130#define SIO_RESET_SIO 0
131#define SIO_RESET_PURGE_RX 1
132#define SIO_RESET_PURGE_TX 2
133
134#define SIO_DISABLE_FLOW_CTRL 0x0
135#define SIO_RTS_CTS_HS (0x1 << 8)
136#define SIO_DTR_DSR_HS (0x2 << 8)
137#define SIO_XON_XOFF_HS (0x4 << 8)
138
139#define SIO_SET_DTR_MASK 0x1
140#define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
141#define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
142#define SIO_SET_RTS_MASK 0x2
143#define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
144#define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
145
146#define SIO_RTS_CTS_HS (0x1 << 8)
147
148/* marker for unused usb urb structures
149 (taken from libusb) */
150#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
151
152#ifdef __GNUC__
153 #define DEPRECATED(func) func __attribute__ ((deprecated))
154#elif defined(_MSC_VER)
155 #define DEPRECATED(func) __declspec(deprecated) func
156#else
157 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
158 #define DEPRECATED(func) func
159#endif
160
161struct ftdi_transfer_control
162{
163 int completed;
164 unsigned char *buf;
165 int size;
166 int offset;
167 struct ftdi_context *ftdi;
168 struct libusb_transfer *transfer;
169};
170
171/**
172 \brief FTDI eeprom structure
173*/
174struct ftdi_eeprom
175{
176 /** vendor id */
177 int vendor_id;
178 /** product id */
179 int product_id;
180
181 /** self powered */
182 int self_powered;
183 /** remote wakeup */
184 int remote_wakeup;
185
186 int is_not_pnp;
187
188 /* Suspend on DBUS7 Low */
189 int suspend_dbus7;
190
191 /** input in isochronous transfer mode */
192 int in_is_isochronous;
193 /** output in isochronous transfer mode */
194 int out_is_isochronous;
195 /** suspend pull downs */
196 int suspend_pull_downs;
197
198 /** use serial */
199 int use_serial;
200 /** usb version */
201 int usb_version;
202 /** Use usb version on FT2232 devices*/
203 int use_usb_version;
204 /** maximum power */
205 int max_power;
206
207 /** manufacturer name */
208 char *manufacturer;
209 /** product name */
210 char *product;
211 /** serial number */
212 char *serial;
213
214 /* 2232D/H(/FT4432H?) specific */
215 /* Hardware type, 0 = RS232 Uart, 1 = 245 FIFO, 2 = CPU FIFO,
216 4 = OPTO Isolate */
217 int channel_a_type;
218 int channel_b_type;
219 /* Driver Type, 1 = VCP */
220 int channel_a_driver;
221 int channel_b_driver;
222
223 /* Special function of FT232R devices (and possibly others as well) */
224 /** CBUS pin function. See CBUS_xxx defines. */
225 int cbus_function[5];
226 /** Select hight current drive on R devices. */
227 int high_current;
228 /** Select hight current drive on A channel (2232C */
229 int high_current_a;
230 /** Select hight current drive on B channel (2232C). */
231 int high_current_b;
232 /** Select inversion of data lines (bitmask). */
233 int invert;
234
235 /*2232H/4432H Group specific values */
236 /* Group0 is AL on 2322H and A on 4232H
237 Group1 is AH on 2232H and B on 4232H
238 Group2 is BL on 2322H and C on 4232H
239 Group3 is BH on 2232H and C on 4232H*/
240 int group0_drive;
241 int group0_schmitt;
242 int group0_slew;
243 int group1_drive;
244 int group1_schmitt;
245 int group1_slew;
246 int group2_drive;
247 int group2_schmitt;
248 int group2_slew;
249 int group3_drive;
250 int group3_schmitt;
251 int group3_slew;
252
253 /** eeprom size in bytes. This doesn't get stored in the eeprom
254 but is the only way to pass it to ftdi_eeprom_build. */
255 int size;
256 /* EEPROM Type 0x46 for 93xx46, 0x56 for 93xx56 and 0x66 for 93xx66*/
257 int chip;
258 unsigned char buf[FTDI_MAX_EEPROM_SIZE];
259};
260
261/**
262 \brief Main context structure for all libftdi functions.
263
264 Do not access directly if possible.
265*/
266struct ftdi_context
267{
268 /* USB specific */
269 /** libusb's context */
270 struct libusb_context *usb_ctx;
271 /** libusb's usb_dev_handle */
272 struct libusb_device_handle *usb_dev;
273 /** usb read timeout */
274 int usb_read_timeout;
275 /** usb write timeout */
276 int usb_write_timeout;
277
278 /* FTDI specific */
279 /** FTDI chip type */
280 enum ftdi_chip_type type;
281 /** baudrate */
282 int baudrate;
283 /** bitbang mode state */
284 unsigned char bitbang_enabled;
285 /** pointer to read buffer for ftdi_read_data */
286 unsigned char *readbuffer;
287 /** read buffer offset */
288 unsigned int readbuffer_offset;
289 /** number of remaining data in internal read buffer */
290 unsigned int readbuffer_remaining;
291 /** read buffer chunk size */
292 unsigned int readbuffer_chunksize;
293 /** write buffer chunk size */
294 unsigned int writebuffer_chunksize;
295 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
296 unsigned int max_packet_size;
297
298 /* FTDI FT2232C requirecments */
299 /** FT2232C interface number: 0 or 1 */
300 int interface; /* 0 or 1 */
301 /** FT2232C index number: 1 or 2 */
302 int index; /* 1 or 2 */
303 /* Endpoints */
304 /** FT2232C end points: 1 or 2 */
305 int in_ep;
306 int out_ep; /* 1 or 2 */
307
308 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
309 unsigned char bitbang_mode;
310
311 /** Decoded eeprom structure */
312 struct ftdi_eeprom *eeprom;
313
314 /** String representation of last error */
315 char *error_str;
316};
317
318/**
319 List all handled EEPROM values.
320 Append future new values only at the end to provide API/ABI stability*/
321enum ftdi_eeprom_value
322{
323 VENDOR_ID = 0,
324 PRODUCT_ID = 1,
325 SELF_POWERED = 2,
326 REMOTE_WAKEUP = 3,
327 IS_NOT_PNP = 4,
328 SUSPEND_DBUS7 = 5,
329 IN_IS_ISOCHRONOUS = 6,
330 OUT_IS_ISOCHRONOUS = 7,
331 SUSPEND_PULL_DOWNS = 8,
332 USE_SERIAL = 9,
333 USB_VERSION = 10,
334 USE_USB_VERSION = 11,
335 MAX_POWER = 12,
336 CHANNEL_A_TYPE = 13,
337 CHANNEL_B_TYPE = 14,
338 CHANNEL_A_DRIVER = 15,
339 CHANNEL_B_DRIVER = 16,
340 CBUS_FUNCTION_0 = 17,
341 CBUS_FUNCTION_1 = 18,
342 CBUS_FUNCTION_2 = 19,
343 CBUS_FUNCTION_3 = 20,
344 CBUS_FUNCTION_4 = 21,
345 HIGH_CURRENT = 22,
346 HIGH_CURRENT_A = 23,
347 HIGH_CURRENT_B = 24,
348 INVERT = 25,
349 GROUP0_DRIVE = 26,
350 GROUP0_SCHMITT = 27,
351 GROUP0_SLEW = 28,
352 GROUP1_DRIVE = 29,
353 GROUP1_SCHMITT = 30,
354 GROUP1_SLEW = 31,
355 GROUP2_DRIVE = 32,
356 GROUP2_SCHMITT = 33,
357 GROUP2_SLEW = 34,
358 GROUP3_DRIVE = 35,
359 GROUP3_SCHMITT = 36,
360 GROUP3_SLEW = 37,
361 CHIP_SIZE = 38,
362 CHIP_TYPE = 39
363};
364
365/**
366 \brief list of usb devices created by ftdi_usb_find_all()
367*/
368struct ftdi_device_list
369{
370 /** pointer to next entry */
371 struct ftdi_device_list *next;
372 /** pointer to libusb's usb_device */
373 struct libusb_device *dev;
374};
375
376#define USE_SERIAL_NUM 0x08
377enum ftdi_cbus_func {/* FIXME: Recheck value, especially the last */
378 CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4,
379 CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9,
380 CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd};
381
382/** Invert TXD# */
383#define INVERT_TXD 0x01
384/** Invert RXD# */
385#define INVERT_RXD 0x02
386/** Invert RTS# */
387#define INVERT_RTS 0x04
388/** Invert CTS# */
389#define INVERT_CTS 0x08
390/** Invert DTR# */
391#define INVERT_DTR 0x10
392/** Invert DSR# */
393#define INVERT_DSR 0x20
394/** Invert DCD# */
395#define INVERT_DCD 0x40
396/** Invert RI# */
397#define INVERT_RI 0x80
398
399/** Interface Mode. */
400#define CHANNEL_IS_UART 0x0
401#define CHANNEL_IS_245 0x1
402#define CHANNEL_IS_CPU 0x2
403#define CHANNEL_IS_OPTO 0x4
404
405#define DRIVE_4MA 0
406#define DRIVE_8MA 1
407#define DRIVE_12MA 2
408#define DRIVE_16MA 3
409#define SLOW_SLEW 4
410#define IS_SCHMITT 8
411
412/** Driver Type. */
413#define DRIVER_VCP 0x08
414
415#define USE_USB_VERSION_BIT 0x10
416
417#define SUSPEND_DBUS7_BIT 0x80
418
419/** High current drive. */
420#define HIGH_CURRENT_DRIVE 0x10
421#define HIGH_CURRENT_DRIVE_R 0x04
422
423/**
424 \brief Progress Info for streaming read
425*/
426struct size_and_time
427{
428 uint64_t totalBytes;
429 struct timeval time;
430};
431
432typedef struct
433{
434 struct size_and_time first;
435 struct size_and_time prev;
436 struct size_and_time current;
437 double totalTime;
438 double totalRate;
439 double currentRate;
440} FTDIProgressInfo;
441
442typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
443 FTDIProgressInfo *progress, void *userdata);
444
445
446#ifdef __cplusplus
447extern "C"
448{
449#endif
450
451 int ftdi_init(struct ftdi_context *ftdi);
452 struct ftdi_context *ftdi_new(void);
453 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
454
455 void ftdi_deinit(struct ftdi_context *ftdi);
456 void ftdi_free(struct ftdi_context *ftdi);
457 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
458
459 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
460 int vendor, int product);
461 void ftdi_list_free(struct ftdi_device_list **devlist);
462 void ftdi_list_free2(struct ftdi_device_list *devlist);
463 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
464 char * manufacturer, int mnf_len,
465 char * description, int desc_len,
466 char * serial, int serial_len);
467
468 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
469 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
470 const char* description, const char* serial);
471 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
472 const char* description, const char* serial, unsigned int index);
473 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
474 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
475
476 int ftdi_usb_close(struct ftdi_context *ftdi);
477 int ftdi_usb_reset(struct ftdi_context *ftdi);
478 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
479 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
480 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
481
482 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
483 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
484 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
485 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
486 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
487 enum ftdi_break_type break_type);
488
489 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
490 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
491 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
492
493 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
494 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
495 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
496
497 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
498 void *userdata, int packetsPerTransfer, int numTransfers);
499 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
500 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
501
502 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
503 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
504
505 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
506 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
507 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
508 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
509
510 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
511 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
512
513 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
514
515 /* flow control */
516 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
517 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
518 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
519 int ftdi_setrts(struct ftdi_context *ftdi, int state);
520
521 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
522 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
523
524 /* init eeprom for the given FTDI type */
525 int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi,
526 char * manufacturer, char *product,
527 char * serial);
528 int ftdi_eeprom_build(struct ftdi_context *ftdi);
529 int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose);
530
531 int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value);
532 int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value);
533
534 int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size);
535
536 int ftdi_read_eeprom(struct ftdi_context *ftdi);
537 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
538 int ftdi_write_eeprom(struct ftdi_context *ftdi);
539 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
540
541 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
542 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
543
544 char *ftdi_get_error_string(struct ftdi_context *ftdi);
545
546#ifdef __cplusplus
547}
548#endif
549
550#endif /* __libftdi_h__ */
A library to talk to FTDI chips