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