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