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