git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Revisit eeprom_initdefualts Symbolic constant for USE_SERIAL_NUM
[libftdi] / src / ftdi.h
... / ...
CommitLineData
1/***************************************************************************
2 ftdi.h - description
3 -------------------
4 begin : Fri Apr 4 2003
5 copyright : (C) 2003 by Intra2net AG
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/* Evne 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 /** release */
186 int release;
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 /** fake usb version */
201 int change_usb_version;
202 /** usb version */
203 int 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. */
227 int high_current_a;
228 /** Select hight current drive on B port (2232C). */
229 int high_current_b;
230 /** Select inversion of data lines (bitmask). */
231 int invert;
232
233 /*2232H/4432H Group specific values */
234 /* Group0 is AL on 2322H and A on 4232H
235 Group1 is AH on 2232H and B on 4232H
236 Group2 is BL on 2322H and C on 4232H
237 Group3 is BH on 2232H and C on 4232H*/
238 int group0_drive;
239 int group0_schmitt;
240 int group0_slew;
241 int group1_drive;
242 int group1_schmitt;
243 int group1_slew;
244 int group2_drive;
245 int group2_schmitt;
246 int group2_slew;
247 int group3_drive;
248 int group3_schmitt;
249 int group3_slew;
250
251
252 /** eeprom size in bytes. This doesn't get stored in the eeprom
253 but is the only way to pass it to ftdi_eeprom_build. */
254 int size;
255 /* EEPROM Type 46 for 93xx46, 56 for 93xx56 and 66 for 93xx66*/
256 int chip;
257};
258
259/**
260 \brief Main context structure for all libftdi functions.
261
262 Do not access directly if possible.
263*/
264struct ftdi_context
265{
266 /* USB specific */
267 /** libusb's context */
268 struct libusb_context *usb_ctx;
269 /** libusb's usb_dev_handle */
270 struct libusb_device_handle *usb_dev;
271 /** usb read timeout */
272 int usb_read_timeout;
273 /** usb write timeout */
274 int usb_write_timeout;
275
276 /* FTDI specific */
277 /** FTDI chip type */
278 enum ftdi_chip_type type;
279 /** baudrate */
280 int baudrate;
281 /** bitbang mode state */
282 unsigned char bitbang_enabled;
283 /** pointer to read buffer for ftdi_read_data */
284 unsigned char *readbuffer;
285 /** read buffer offset */
286 unsigned int readbuffer_offset;
287 /** number of remaining data in internal read buffer */
288 unsigned int readbuffer_remaining;
289 /** read buffer chunk size */
290 unsigned int readbuffer_chunksize;
291 /** write buffer chunk size */
292 unsigned int writebuffer_chunksize;
293 /** maximum packet size. Needed for filtering modem status bytes every n packets. */
294 unsigned int max_packet_size;
295
296 /* FTDI FT2232C requirecments */
297 /** FT2232C interface number: 0 or 1 */
298 int interface; /* 0 or 1 */
299 /** FT2232C index number: 1 or 2 */
300 int index; /* 1 or 2 */
301 /* Endpoints */
302 /** FT2232C end points: 1 or 2 */
303 int in_ep;
304 int out_ep; /* 1 or 2 */
305
306 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
307 unsigned char bitbang_mode;
308
309 /** Decoded eeprom structure */
310 struct ftdi_eeprom *eeprom;
311
312 /** String representation of last error */
313 char *error_str;
314};
315
316/**
317 \brief list of usb devices created by ftdi_usb_find_all()
318*/
319struct ftdi_device_list
320{
321 /** pointer to next entry */
322 struct ftdi_device_list *next;
323 /** pointer to libusb's usb_device */
324 struct libusb_device *dev;
325};
326
327#define USE_SERIAL_NUM 0x08
328
329/** TXDEN */
330#define CBUS_TXDEN 0
331/** PWREN# */
332#define CBUS_PWREN 1
333/** RXLED# */
334#define CBUS_RXLED 2
335/** TXLED#*/
336#define CBUS_TXLED 3
337/** RXLED# & TXLED# */
338#define CBUS_TXRXLED 4
339/** SLEEP# */
340#define CBUS_SLEEP 5
341/** 48 MHz clock */
342#define CBUS_CLK48 6
343/** 24 MHz clock */
344#define CBUS_CLK24 7
345/** 12 MHz clock */
346#define CBUS_CLK12 8
347/** 6 MHz clock */
348#define CBUS_CLK6 9
349/** Bitbang IO Mode*/
350#define CBUS_IOMODE 10
351/** Bitbang IO WR#*/
352#define CBUS_BB_WR 11
353/** Bitbang IO RD#*/
354#define CBUS_BB_RD 12
355
356
357/** Invert TXD# */
358#define INVERT_TXD 0x01
359/** Invert RXD# */
360#define INVERT_RXD 0x02
361/** Invert RTS# */
362#define INVERT_RTS 0x04
363/** Invert CTS# */
364#define INVERT_CTS 0x08
365/** Invert DTR# */
366#define INVERT_DTR 0x10
367/** Invert DSR# */
368#define INVERT_DSR 0x20
369/** Invert DCD# */
370#define INVERT_DCD 0x40
371/** Invert RI# */
372#define INVERT_RI 0x80
373
374/** Interface Mode. */
375#define CHANNEL_IS_UART 0x0
376#define CHANNEL_IS_245 0x1
377#define CHANNEL_IS_CPU 0x2
378#define CHANNEL_IS_OPTO 0x4
379
380#define DRIVE_4MA 0
381#define DRIVE_8MA 1
382#define DRIVE_12MA 2
383#define DRIVE_16MA 3
384#define SLOW_SLEW 4
385#define IS_SCHMITT 8
386
387/** Driver Type. */
388#define DRIVER_VCP 0x08
389
390#define SUSPEND_DBUS7 0x80
391
392/** High current drive. */
393#define HIGH_CURRENT_DRIVE 0x10
394
395/**
396 \brief Progress Info for streaming read
397*/
398struct size_and_time
399{
400 uint64_t totalBytes;
401 struct timeval time;
402};
403
404typedef struct
405{
406 struct size_and_time first;
407 struct size_and_time prev;
408 struct size_and_time current;
409 double totalTime;
410 double totalRate;
411 double currentRate;
412} FTDIProgressInfo;
413
414typedef int (FTDIStreamCallback)(uint8_t *buffer, int length,
415 FTDIProgressInfo *progress, void *userdata);
416
417
418#ifdef __cplusplus
419extern "C"
420{
421#endif
422
423 int ftdi_init(struct ftdi_context *ftdi);
424 struct ftdi_context *ftdi_new(void);
425 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
426
427 void ftdi_deinit(struct ftdi_context *ftdi);
428 void ftdi_free(struct ftdi_context *ftdi);
429 void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev);
430
431 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
432 int vendor, int product);
433 void ftdi_list_free(struct ftdi_device_list **devlist);
434 void ftdi_list_free2(struct ftdi_device_list *devlist);
435 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev,
436 char * manufacturer, int mnf_len,
437 char * description, int desc_len,
438 char * serial, int serial_len);
439
440 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
441 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
442 const char* description, const char* serial);
443 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
444 const char* description, const char* serial, unsigned int index);
445 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev);
446 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
447
448 int ftdi_usb_close(struct ftdi_context *ftdi);
449 int ftdi_usb_reset(struct ftdi_context *ftdi);
450 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
451 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
452 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
453
454 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
455 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
456 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
457 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
458 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
459 enum ftdi_break_type break_type);
460
461 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
462 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
463 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
464
465 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
466 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
467 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
468
469 int ftdi_readstream(struct ftdi_context *ftdi, FTDIStreamCallback *callback,
470 void *userdata, int packetsPerTransfer, int numTransfers);
471 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
472 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
473
474 struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size);
475 int ftdi_transfer_data_done(struct ftdi_transfer_control *tc);
476
477 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
478 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
479 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
480 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
481
482 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
483 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
484
485 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
486
487 /* flow control */
488 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
489 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
490 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
491 int ftdi_setrts(struct ftdi_context *ftdi, int state);
492
493 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
494 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
495
496 /* set eeprom size */
497 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
498
499 /* init and build eeprom from ftdi_eeprom structure */
500 void ftdi_eeprom_initdefaults(struct ftdi_context *ftdi);
501 void ftdi_eeprom_free(struct ftdi_context *ftdi);
502 int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output);
503 int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *output, int size, int verbose);
504
505 /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
506 the checksum of the eeprom is valided */
507 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
508 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
509 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
510 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
511
512 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
513 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
514
515 char *ftdi_get_error_string(struct ftdi_context *ftdi);
516
517#ifdef __cplusplus
518}
519#endif
520
521#endif /* __libftdi_h__ */
A library to talk to FTDI chips