git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Added .gitignore file
[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 for ftdi_set_line_property()
31enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
32/// Break type for ftdi_set_line_property2()
33enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
34
35/// MPSSE bitbang modes
36enum ftdi_mpsse_mode {
37 BITMODE_RESET = 0x00,
38 BITMODE_BITBANG= 0x01,
39 BITMODE_MPSSE = 0x02,
40 BITMODE_SYNCBB = 0x04,
41 BITMODE_MCU = 0x08,
42 // CPU-style fifo mode gets set via EEPROM
43 BITMODE_OPTO = 0x10,
44 BITMODE_CBUS = 0x20
45};
46
47/// Port interface for FT2232C
48enum 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 */
95
96/* Definitions for flow control */
97#define SIO_RESET 0 /* Reset the port */
98#define SIO_MODEM_CTRL 1 /* Set the modem control register */
99#define SIO_SET_FLOW_CTRL 2 /* Set flow control register */
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
114
115#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
116#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
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
135/* marker for unused usb urb structures
136 (taken from libusb) */
137#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
138
139/**
140 \brief Main context structure for all libftdi functions.
141
142 Do not access directly if possible.
143*/
144struct ftdi_context {
145 // USB specific
146 /// libusb's usb_dev_handle
147 struct usb_dev_handle *usb_dev;
148 /// usb read timeout
149 int usb_read_timeout;
150 /// usb write timeout
151 int usb_write_timeout;
152
153 // FTDI specific
154 /// FTDI chip type
155 enum ftdi_chip_type type;
156 /// baudrate
157 int baudrate;
158 /// bitbang mode state
159 unsigned char bitbang_enabled;
160 /// pointer to read buffer for ftdi_read_data
161 unsigned char *readbuffer;
162 /// read buffer offset
163 unsigned int readbuffer_offset;
164 /// number of remaining data in internal read buffer
165 unsigned int readbuffer_remaining;
166 /// read buffer chunk size
167 unsigned int readbuffer_chunksize;
168 /// write buffer chunk size
169 unsigned int writebuffer_chunksize;
170
171 // FTDI FT2232C requirecments
172 /// FT2232C interface number: 0 or 1
173 int interface; // 0 or 1
174 /// FT2232C index number: 1 or 2
175 int index; // 1 or 2
176 // Endpoints
177 /// FT2232C end points: 1 or 2
178 int in_ep;
179 int out_ep; // 1 or 2
180
181 /// Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
182 unsigned char bitbang_mode;
183
184 /// EEPROM size. Default is 128 bytes for 232BM and 245BM chips
185 int eeprom_size;
186
187 /// String representation of last error
188 char *error_str;
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;
194};
195
196/**
197 \brief list of usb devices created by ftdi_usb_find_all()
198*/
199struct ftdi_device_list {
200 /// pointer to next entry
201 struct ftdi_device_list *next;
202 /// pointer to libusb's usb_device
203 struct usb_device *dev;
204};
205
206/**
207 \brief FTDI eeprom structure
208*/
209struct ftdi_eeprom {
210 /// vendor id
211 int vendor_id;
212 /// product id
213 int product_id;
214
215 /// self powered
216 int self_powered;
217 /// remote wakepu
218 int remote_wakeup;
219 /// chip type
220 int BM_type_chip;
221
222 /// input in isochronous transfer mode
223 int in_is_isochronous;
224 /// output in isochronous transfer mode
225 int out_is_isochronous;
226 /// suspend pull downs
227 int suspend_pull_downs;
228
229 /// use serial
230 int use_serial;
231 /// fake usb version
232 int change_usb_version;
233 /// usb version
234 int usb_version;
235 /// maximum power
236 int max_power;
237
238 /// manufacturer name
239 char *manufacturer;
240 /// product name
241 char *product;
242 /// serial number
243 char *serial;
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;
248};
249
250#ifdef __cplusplus
251extern "C" {
252#endif
253
254 int ftdi_init(struct ftdi_context *ftdi);
255 struct ftdi_context *ftdi_new();
256 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
257
258 void ftdi_deinit(struct ftdi_context *ftdi);
259 void ftdi_free(struct ftdi_context *ftdi);
260 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
261
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);
265 void ftdi_list_free2(struct ftdi_device_list *devlist);
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);
270
271 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
272 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
273 const char* description, const char* serial);
274 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
275
276 int ftdi_usb_close(struct ftdi_context *ftdi);
277 int ftdi_usb_reset(struct ftdi_context *ftdi);
278 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
279 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
280 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
281
282 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
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);
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);
288
289 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
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);
296
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
300 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
301 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
302 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
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
308 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
309
310 // flow control
311 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
312 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
313 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
314 int ftdi_setrts(struct ftdi_context *ftdi, int state);
315
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
319 // set eeprom size
320 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
321
322 // init and build eeprom from ftdi_eeprom structure
323 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
324 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
325
326 // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
327 // the checksum of the eeprom is valided
328 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
329 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
330 int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize);
331 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
332 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
333
334 char *ftdi_get_error_string(struct ftdi_context *ftdi);
335
336#ifdef __cplusplus
337}
338#endif
339
340#endif /* __libftdi_h__ */
A library to talk to FTDI chips