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