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 | #ifdef HAVE_LIBUSB
|
---|
20 | #include <usb.h>
|
---|
21 |
|
---|
22 | #define FTDI_DEFAULT_EEPROM_SIZE 128
|
---|
23 |
|
---|
24 | /** FTDI chip type */
|
---|
25 | enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 };
|
---|
26 | /** Parity mode for ftdi_set_line_property() */
|
---|
27 | enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
|
---|
28 | /** Number of stop bits for ftdi_set_line_property() */
|
---|
29 | enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
|
---|
30 | /** Number of bits for ftdi_set_line_property() */
|
---|
31 | enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
|
---|
32 | /** Break type for ftdi_set_line_property2() */
|
---|
33 | enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
|
---|
34 |
|
---|
35 | /** MPSSE bitbang modes */
|
---|
36 | enum ftdi_mpsse_mode
|
---|
37 | {
|
---|
38 | BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */
|
---|
39 | BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */
|
---|
40 | BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */
|
---|
41 | BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */
|
---|
42 | BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */
|
---|
43 | /* CPU-style fifo mode gets set via EEPROM */
|
---|
44 | BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */
|
---|
45 | BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
|
---|
46 | BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
|
---|
47 | };
|
---|
48 |
|
---|
49 | /** Port interface for chips with multiple interfaces */
|
---|
50 | enum ftdi_interface
|
---|
51 | {
|
---|
52 | INTERFACE_ANY = 0,
|
---|
53 | INTERFACE_A = 1,
|
---|
54 | INTERFACE_B = 2,
|
---|
55 | INTERFACE_C = 3,
|
---|
56 | INTERFACE_D = 4
|
---|
57 | };
|
---|
58 |
|
---|
59 | /* Shifting commands IN MPSSE Mode*/
|
---|
60 | #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/
|
---|
61 | #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */
|
---|
62 | #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */
|
---|
63 | #define MPSSE_LSB 0x08 /* LSB first */
|
---|
64 | #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */
|
---|
65 | #define MPSSE_DO_READ 0x20 /* Read TDO/DI */
|
---|
66 | #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */
|
---|
67 |
|
---|
68 | /* FTDI MPSSE commands */
|
---|
69 | #define SET_BITS_LOW 0x80
|
---|
70 | /*BYTE DATA*/
|
---|
71 | /*BYTE Direction*/
|
---|
72 | #define SET_BITS_HIGH 0x82
|
---|
73 | /*BYTE DATA*/
|
---|
74 | /*BYTE Direction*/
|
---|
75 | #define GET_BITS_LOW 0x81
|
---|
76 | #define GET_BITS_HIGH 0x83
|
---|
77 | #define LOOPBACK_START 0x84
|
---|
78 | #define LOOPBACK_END 0x85
|
---|
79 | #define TCK_DIVISOR 0x86
|
---|
80 | /* Value Low */
|
---|
81 | /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
|
---|
82 | #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
|
---|
83 |
|
---|
84 | /* Commands in MPSSE and Host Emulation Mode */
|
---|
85 | #define SEND_IMMEDIATE 0x87
|
---|
86 | #define WAIT_ON_HIGH 0x88
|
---|
87 | #define WAIT_ON_LOW 0x89
|
---|
88 |
|
---|
89 | /* Commands in Host Emulation Mode */
|
---|
90 | #define READ_SHORT 0x90
|
---|
91 | /* Address_Low */
|
---|
92 | #define READ_EXTENDED 0x91
|
---|
93 | /* Address High */
|
---|
94 | /* Address Low */
|
---|
95 | #define WRITE_SHORT 0x92
|
---|
96 | /* Address_Low */
|
---|
97 | #define WRITE_EXTENDED 0x93
|
---|
98 | /* Address High */
|
---|
99 | /* Address Low */
|
---|
100 |
|
---|
101 | /* Definitions for flow control */
|
---|
102 | #define SIO_RESET 0 /* Reset the port */
|
---|
103 | #define SIO_MODEM_CTRL 1 /* Set the modem control register */
|
---|
104 | #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
|
---|
105 | #define SIO_SET_BAUD_RATE 3 /* Set baud rate */
|
---|
106 | #define SIO_SET_DATA 4 /* Set the data characteristics of the port */
|
---|
107 |
|
---|
108 | #define FTDI_DEVICE_OUT_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_OUT)
|
---|
109 | #define FTDI_DEVICE_IN_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_IN)
|
---|
110 |
|
---|
111 | /* Requests */
|
---|
112 | #define SIO_RESET_REQUEST SIO_RESET
|
---|
113 | #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
|
---|
114 | #define SIO_SET_DATA_REQUEST SIO_SET_DATA
|
---|
115 | #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
|
---|
116 | #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
|
---|
117 | #define SIO_POLL_MODEM_STATUS_REQUEST 0x05
|
---|
118 | #define SIO_SET_EVENT_CHAR_REQUEST 0x06
|
---|
119 | #define SIO_SET_ERROR_CHAR_REQUEST 0x07
|
---|
120 | #define SIO_SET_LATENCY_TIMER_REQUEST 0x09
|
---|
121 | #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
|
---|
122 | #define SIO_SET_BITMODE_REQUEST 0x0B
|
---|
123 | #define SIO_READ_PINS_REQUEST 0x0C
|
---|
124 | #define SIO_READ_EEPROM_REQUEST 0x90
|
---|
125 | #define SIO_WRITE_EEPROM_REQUEST 0x91
|
---|
126 | #define SIO_ERASE_EEPROM_REQUEST 0x92
|
---|
127 |
|
---|
128 |
|
---|
129 | #define SIO_RESET_SIO 0
|
---|
130 | #define SIO_RESET_PURGE_RX 1
|
---|
131 | #define SIO_RESET_PURGE_TX 2
|
---|
132 |
|
---|
133 | #define SIO_DISABLE_FLOW_CTRL 0x0
|
---|
134 | #define SIO_RTS_CTS_HS (0x1 << 8)
|
---|
135 | #define SIO_DTR_DSR_HS (0x2 << 8)
|
---|
136 | #define SIO_XON_XOFF_HS (0x4 << 8)
|
---|
137 |
|
---|
138 | #define SIO_SET_DTR_MASK 0x1
|
---|
139 | #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
|
---|
140 | #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
|
---|
141 | #define SIO_SET_RTS_MASK 0x2
|
---|
142 | #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
|
---|
143 | #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
|
---|
144 |
|
---|
145 | #define SIO_RTS_CTS_HS (0x1 << 8)
|
---|
146 |
|
---|
147 | /* marker for unused usb urb structures
|
---|
148 | (taken from libusb) */
|
---|
149 | #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
|
---|
150 |
|
---|
151 | #ifdef __GNUC__
|
---|
152 | #define DEPRECATED(func) func __attribute__ ((deprecated))
|
---|
153 | #elif defined(_MSC_VER)
|
---|
154 | #define DEPRECATED(func) __declspec(deprecated) func
|
---|
155 | #else
|
---|
156 | #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
|
---|
157 | #define DEPRECATED(func) func
|
---|
158 | #endif
|
---|
159 |
|
---|
160 |
|
---|
161 | /**
|
---|
162 | \brief Main context structure for all libftdi functions.
|
---|
163 |
|
---|
164 | Do not access directly if possible.
|
---|
165 | */
|
---|
166 | struct ftdi_context
|
---|
167 | {
|
---|
168 | /* USB specific */
|
---|
169 | /** libusb's usb_dev_handle */
|
---|
170 | struct usb_dev_handle *usb_dev;
|
---|
171 | /** usb read timeout */
|
---|
172 | int usb_read_timeout;
|
---|
173 | /** usb write timeout */
|
---|
174 | int usb_write_timeout;
|
---|
175 |
|
---|
176 | /* FTDI specific */
|
---|
177 | /** FTDI chip type */
|
---|
178 | enum ftdi_chip_type type;
|
---|
179 | /** baudrate */
|
---|
180 | int baudrate;
|
---|
181 | /** bitbang mode state */
|
---|
182 | unsigned char bitbang_enabled;
|
---|
183 | /** pointer to read buffer for ftdi_read_data */
|
---|
184 | unsigned char *readbuffer;
|
---|
185 | /** read buffer offset */
|
---|
186 | unsigned int readbuffer_offset;
|
---|
187 | /** number of remaining data in internal read buffer */
|
---|
188 | unsigned int readbuffer_remaining;
|
---|
189 | /** read buffer chunk size */
|
---|
190 | unsigned int readbuffer_chunksize;
|
---|
191 | /** write buffer chunk size */
|
---|
192 | unsigned int writebuffer_chunksize;
|
---|
193 | /** maximum packet size. Needed for filtering modem status bytes every n packets. */
|
---|
194 | unsigned int max_packet_size;
|
---|
195 |
|
---|
196 | /* FTDI FT2232C requirecments */
|
---|
197 | /** FT2232C interface number: 0 or 1 */
|
---|
198 | int interface; /* 0 or 1 */
|
---|
199 | /** FT2232C index number: 1 or 2 */
|
---|
200 | int index; /* 1 or 2 */
|
---|
201 | /* Endpoints */
|
---|
202 | /** FT2232C end points: 1 or 2 */
|
---|
203 | int in_ep;
|
---|
204 | int out_ep; /* 1 or 2 */
|
---|
205 |
|
---|
206 | /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
|
---|
207 | unsigned char bitbang_mode;
|
---|
208 |
|
---|
209 | /** EEPROM size. Default is 128 bytes for 232BM and 245BM chips */
|
---|
210 | int eeprom_size;
|
---|
211 |
|
---|
212 | /** String representation of last error */
|
---|
213 | char *error_str;
|
---|
214 |
|
---|
215 | /** Buffer needed for async communication */
|
---|
216 | char *async_usb_buffer;
|
---|
217 | /** Number of URB-structures we can buffer */
|
---|
218 | unsigned int async_usb_buffer_size;
|
---|
219 | };
|
---|
220 |
|
---|
221 | /**
|
---|
222 | \brief list of usb devices created by ftdi_usb_find_all()
|
---|
223 | */
|
---|
224 | struct ftdi_device_list
|
---|
225 | {
|
---|
226 | /** pointer to next entry */
|
---|
227 | struct ftdi_device_list *next;
|
---|
228 | /** pointer to libusb's usb_device */
|
---|
229 | struct usb_device *dev;
|
---|
230 | };
|
---|
231 |
|
---|
232 | /**
|
---|
233 | \brief FTDI eeprom structure
|
---|
234 | */
|
---|
235 | struct ftdi_eeprom
|
---|
236 | {
|
---|
237 | /** vendor id */
|
---|
238 | int vendor_id;
|
---|
239 | /** product id */
|
---|
240 | int product_id;
|
---|
241 |
|
---|
242 | /** self powered */
|
---|
243 | int self_powered;
|
---|
244 | /** remote wakeup */
|
---|
245 | int remote_wakeup;
|
---|
246 | /** chip type */
|
---|
247 | int BM_type_chip;
|
---|
248 |
|
---|
249 | /** input in isochronous transfer mode */
|
---|
250 | int in_is_isochronous;
|
---|
251 | /** output in isochronous transfer mode */
|
---|
252 | int out_is_isochronous;
|
---|
253 | /** suspend pull downs */
|
---|
254 | int suspend_pull_downs;
|
---|
255 |
|
---|
256 | /** use serial */
|
---|
257 | int use_serial;
|
---|
258 | /** fake usb version */
|
---|
259 | int change_usb_version;
|
---|
260 | /** usb version */
|
---|
261 | int usb_version;
|
---|
262 | /** maximum power */
|
---|
263 | int max_power;
|
---|
264 |
|
---|
265 | /** manufacturer name */
|
---|
266 | char *manufacturer;
|
---|
267 | /** product name */
|
---|
268 | char *product;
|
---|
269 | /** serial number */
|
---|
270 | char *serial;
|
---|
271 |
|
---|
272 | /** eeprom size in bytes. This doesn't get stored in the eeprom
|
---|
273 | but is the only way to pass it to ftdi_eeprom_build. */
|
---|
274 | int size;
|
---|
275 | };
|
---|
276 |
|
---|
277 | #ifdef __cplusplus
|
---|
278 | extern "C"
|
---|
279 | {
|
---|
280 | #endif
|
---|
281 |
|
---|
282 | int ftdi_init(struct ftdi_context *ftdi);
|
---|
283 | struct ftdi_context *ftdi_new(void);
|
---|
284 | int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
|
---|
285 |
|
---|
286 | void ftdi_deinit(struct ftdi_context *ftdi);
|
---|
287 | void ftdi_free(struct ftdi_context *ftdi);
|
---|
288 | void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
|
---|
289 |
|
---|
290 | int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
|
---|
291 | int vendor, int product);
|
---|
292 | void ftdi_list_free(struct ftdi_device_list **devlist);
|
---|
293 | void ftdi_list_free2(struct ftdi_device_list *devlist);
|
---|
294 | int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev,
|
---|
295 | char * manufacturer, int mnf_len,
|
---|
296 | char * description, int desc_len,
|
---|
297 | char * serial, int serial_len);
|
---|
298 |
|
---|
299 | int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
|
---|
300 | int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
|
---|
301 | const char* description, const char* serial);
|
---|
302 | int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
|
---|
303 | const char* description, const char* serial, unsigned int index);
|
---|
304 | int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
|
---|
305 | int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
|
---|
306 |
|
---|
307 | int ftdi_usb_close(struct ftdi_context *ftdi);
|
---|
308 | int ftdi_usb_reset(struct ftdi_context *ftdi);
|
---|
309 | int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
|
---|
310 | int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
|
---|
311 | int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
|
---|
312 |
|
---|
313 | int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
|
---|
314 | int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
|
---|
315 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
|
---|
316 | int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
|
---|
317 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
|
---|
318 | enum ftdi_break_type break_type);
|
---|
319 |
|
---|
320 | int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
|
---|
321 | int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
|
---|
322 | int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
|
---|
323 |
|
---|
324 | int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
|
---|
325 | int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
|
---|
326 | int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
|
---|
327 |
|
---|
328 | int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
|
---|
329 | void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
|
---|
330 |
|
---|
331 | int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask));
|
---|
332 | int ftdi_disable_bitbang(struct ftdi_context *ftdi);
|
---|
333 | int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
|
---|
334 | int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
|
---|
335 |
|
---|
336 | int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
|
---|
337 | int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
|
---|
338 |
|
---|
339 | int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
|
---|
340 |
|
---|
341 | /* flow control */
|
---|
342 | int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
|
---|
343 | int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
|
---|
344 | int ftdi_setdtr(struct ftdi_context *ftdi, int state);
|
---|
345 | int ftdi_setrts(struct ftdi_context *ftdi, int state);
|
---|
346 |
|
---|
347 | int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
|
---|
348 | int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
|
---|
349 |
|
---|
350 | /* set eeprom size */
|
---|
351 | void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
|
---|
352 |
|
---|
353 | /* init and build eeprom from ftdi_eeprom structure */
|
---|
354 | void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
|
---|
355 | int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
|
---|
356 | int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
|
---|
357 |
|
---|
358 | /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
|
---|
359 | the checksum of the eeprom is valided */
|
---|
360 | int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
|
---|
361 | int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
|
---|
362 | int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize);
|
---|
363 | int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
|
---|
364 | int ftdi_erase_eeprom(struct ftdi_context *ftdi);
|
---|
365 |
|
---|
366 | int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
|
---|
367 | int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
|
---|
368 |
|
---|
369 | char *ftdi_get_error_string(struct ftdi_context *ftdi);
|
---|
370 |
|
---|
371 | #ifdef __cplusplus
|
---|
372 | }
|
---|
373 | #endif
|
---|
374 |
|
---|
375 | #endif // HAVE_LIBUSB
|
---|
376 | #endif /* __libftdi_h__ */
|
---|