git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Increase version
[libftdi] / src / ftdi.h
... / ...
CommitLineData
1/***************************************************************************
2 ftdi.h - description
3 -------------------
4 begin : Fri Apr 4 2003
5 copyright : (C) 2003 by Intra2net AG
6 email : opensource@intra2net.com
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
20#include <usb.h>
21
22#define FTDI_DEFAULT_EEPROM_SIZE 128
23
24/// FTDI chip type
25enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
26/// Parity mode for ftdi_set_line_property()
27enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
28/// Number of stop bits for ftdi_set_line_property()
29enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
30/// Number of bits ftdi_set_line_property()
31enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
32
33/// MPSSE bitbang modes
34enum ftdi_mpsse_mode {
35 BITMODE_RESET = 0x00,
36 BITMODE_BITBANG= 0x01,
37 BITMODE_MPSSE = 0x02,
38 BITMODE_SYNCBB = 0x04,
39 BITMODE_MCU = 0x08,
40 // CPU-style fifo mode gets set via EEPROM
41 BITMODE_OPTO = 0x10,
42 BITMODE_CBUS = 0x20
43};
44
45/// Port interface for FT2232C
46enum 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 */
93
94/* Definitions for flow control */
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
118/* marker for unused usb urb structures
119 (taken from libusb) */
120#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
121
122/**
123 \brief Main context structure for all libftdi functions.
124
125 Do not access directly if possible.
126*/
127struct ftdi_context {
128 // USB specific
129 /// libusb's usb_dev_handle
130 struct usb_dev_handle *usb_dev;
131 /// usb read timeout
132 int usb_read_timeout;
133 /// usb write timeout
134 int usb_write_timeout;
135
136 // FTDI specific
137 /// FTDI chip type
138 enum ftdi_chip_type type;
139 /// baudrate
140 int baudrate;
141 /// bitbang mode state
142 unsigned char bitbang_enabled;
143 /// pointer to read buffer for ftdi_read_data
144 unsigned char *readbuffer;
145 /// read buffer offset
146 unsigned int readbuffer_offset;
147 /// number of remaining data in internal read buffer
148 unsigned int readbuffer_remaining;
149 /// read buffer chunk size
150 unsigned int readbuffer_chunksize;
151 /// write buffer chunk size
152 unsigned int writebuffer_chunksize;
153
154 // FTDI FT2232C requirecments
155 /// FT2232C interface number: 0 or 1
156 int interface; // 0 or 1
157 /// FT2232C index number: 1 or 2
158 int index; // 1 or 2
159 // Endpoints
160 /// FT2232C end points: 1 or 2
161 int in_ep;
162 int out_ep; // 1 or 2
163
164 /// Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
165 unsigned char bitbang_mode;
166
167 /// EEPROM size. Default is 128 bytes for 232BM and 245BM chips
168 int eeprom_size;
169
170 /// String representation of last error
171 char *error_str;
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;
177};
178
179/**
180 \brief list of usb devices created by ftdi_usb_find_all()
181*/
182struct ftdi_device_list {
183 /// pointer to next entry
184 struct ftdi_device_list *next;
185 /// pointer to libusb's usb_device
186 struct usb_device *dev;
187};
188
189/**
190 \brief FTDI eeprom structure
191*/
192struct ftdi_eeprom {
193 /// vendor id
194 int vendor_id;
195 /// product id
196 int product_id;
197
198 /// self powered
199 int self_powered;
200 /// remote wakepu
201 int remote_wakeup;
202 /// chip type
203 int BM_type_chip;
204
205 /// input in isochronous transfer mode
206 int in_is_isochronous;
207 /// output in isochronous transfer mode
208 int out_is_isochronous;
209 /// suspend pull downs
210 int suspend_pull_downs;
211
212 /// use serial
213 int use_serial;
214 /// fake usb version
215 int change_usb_version;
216 /// usb version
217 int usb_version;
218 /// maximum power
219 int max_power;
220
221 /// manufacturer name
222 char *manufacturer;
223 /// product name
224 char *product;
225 /// serial number
226 char *serial;
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;
231};
232
233#ifdef __cplusplus
234extern "C" {
235#endif
236
237 int ftdi_init(struct ftdi_context *ftdi);
238 struct ftdi_context *ftdi_new();
239 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
240
241 void ftdi_deinit(struct ftdi_context *ftdi);
242 void ftdi_free(struct ftdi_context *ftdi);
243 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
244
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);
248 void ftdi_list_free2(struct ftdi_device_list *devlist);
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);
253
254 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
255 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
256 const char* description, const char* serial);
257 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
258
259 int ftdi_usb_close(struct ftdi_context *ftdi);
260 int ftdi_usb_reset(struct ftdi_context *ftdi);
261 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
262 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
263 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
264
265 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
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);
268
269 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
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);
276
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
280 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
281 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
282 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
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
288 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
289
290 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
291 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
292
293 // set eeprom size
294 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
295
296 // init and build eeprom from ftdi_eeprom structure
297 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
298 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
299
300 // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
301 // the checksum of the eeprom is valided
302 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
303 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
304 int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize);
305 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
306 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
307
308 char *ftdi_get_error_string(struct ftdi_context *ftdi);
309
310 // flow control
311 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
312 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
313 int ftdi_setrts(struct ftdi_context *ftdi, int state);
314
315#ifdef __cplusplus
316}
317#endif
318
319#endif /* __libftdi_h__ */
A library to talk to FTDI chips