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