git://developer.intra2net.com / libftdi / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Updated ChangeLog and AUTHORS
[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 FTDI_DEVICE_OUT_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_OUT)
104#define FTDI_DEVICE_IN_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_IN)
105
106/* Requests */
107#define SIO_RESET_REQUEST SIO_RESET
108#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
109#define SIO_SET_DATA_REQUEST SIO_SET_DATA
110#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
111#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
112#define SIO_POLL_MODEM_STATUS_REQUEST 0x05
113#define SIO_SET_EVENT_CHAR_REQUEST 0x06
114#define SIO_SET_ERROR_CHAR_REQUEST 0x07
115#define SIO_SET_LATENCY_TIMER_REQUEST 0x09
116#define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
117#define SIO_SET_BITMODE_REQUEST 0x0B
118#define SIO_READ_PINS_REQUEST 0x0C
119#define SIO_READ_EEPROM_REQUEST 0x90
120#define SIO_WRITE_EEPROM_REQUEST 0x91
121#define SIO_ERASE_EEPROM_REQUEST 0x92
122
123
124#define SIO_RESET_SIO 0
125#define SIO_RESET_PURGE_RX 1
126#define SIO_RESET_PURGE_TX 2
127
128#define SIO_DISABLE_FLOW_CTRL 0x0
129#define SIO_RTS_CTS_HS (0x1 << 8)
130#define SIO_DTR_DSR_HS (0x2 << 8)
131#define SIO_XON_XOFF_HS (0x4 << 8)
132
133#define SIO_SET_DTR_MASK 0x1
134#define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8))
135#define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8))
136#define SIO_SET_RTS_MASK 0x2
137#define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
138#define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
139
140#define SIO_RTS_CTS_HS (0x1 << 8)
141
142/* marker for unused usb urb structures
143 (taken from libusb) */
144#define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
145
146/**
147 \brief Main context structure for all libftdi functions.
148
149 Do not access directly if possible.
150*/
151struct ftdi_context {
152 /* USB specific */
153 /** libusb's usb_dev_handle */
154 struct usb_dev_handle *usb_dev;
155 /** usb read timeout */
156 int usb_read_timeout;
157 /** usb write timeout */
158 int usb_write_timeout;
159
160 /* FTDI specific */
161 /** FTDI chip type */
162 enum ftdi_chip_type type;
163 /** baudrate */
164 int baudrate;
165 /** bitbang mode state */
166 unsigned char bitbang_enabled;
167 /** pointer to read buffer for ftdi_read_data */
168 unsigned char *readbuffer;
169 /** read buffer offset */
170 unsigned int readbuffer_offset;
171 /** number of remaining data in internal read buffer */
172 unsigned int readbuffer_remaining;
173 /** read buffer chunk size */
174 unsigned int readbuffer_chunksize;
175 /** write buffer chunk size */
176 unsigned int writebuffer_chunksize;
177
178 /* FTDI FT2232C requirecments */
179 /** FT2232C interface number: 0 or 1 */
180 int interface; /* 0 or 1 */
181 /** FT2232C index number: 1 or 2 */
182 int index; /* 1 or 2 */
183 /* Endpoints */
184 /** FT2232C end points: 1 or 2 */
185 int in_ep;
186 int out_ep; /* 1 or 2 */
187
188 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
189 unsigned char bitbang_mode;
190
191 /** EEPROM size. Default is 128 bytes for 232BM and 245BM chips */
192 int eeprom_size;
193
194 /** String representation of last error */
195 char *error_str;
196
197 /** Buffer needed for async communication */
198 char *async_usb_buffer;
199 /** Number of URB-structures we can buffer */
200 unsigned int async_usb_buffer_size;
201};
202
203/**
204 \brief list of usb devices created by ftdi_usb_find_all()
205*/
206struct ftdi_device_list {
207 /** pointer to next entry */
208 struct ftdi_device_list *next;
209 /** pointer to libusb's usb_device */
210 struct usb_device *dev;
211};
212
213/**
214 \brief FTDI eeprom structure
215*/
216struct ftdi_eeprom {
217 /** vendor id */
218 int vendor_id;
219 /** product id */
220 int product_id;
221
222 /** self powered */
223 int self_powered;
224 /** remote wakeup */
225 int remote_wakeup;
226 /** chip type */
227 int BM_type_chip;
228
229 /** input in isochronous transfer mode */
230 int in_is_isochronous;
231 /** output in isochronous transfer mode */
232 int out_is_isochronous;
233 /** suspend pull downs */
234 int suspend_pull_downs;
235
236 /** use serial */
237 int use_serial;
238 /** fake usb version */
239 int change_usb_version;
240 /** usb version */
241 int usb_version;
242 /** maximum power */
243 int max_power;
244
245 /** manufacturer name */
246 char *manufacturer;
247 /** product name */
248 char *product;
249 /** serial number */
250 char *serial;
251
252 /** eeprom size in bytes. This doesn't get stored in the eeprom
253 but is the only way to pass it to ftdi_eeprom_build. */
254 int size;
255};
256
257#ifdef __cplusplus
258extern "C" {
259#endif
260
261 int ftdi_init(struct ftdi_context *ftdi);
262 struct ftdi_context *ftdi_new();
263 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
264
265 void ftdi_deinit(struct ftdi_context *ftdi);
266 void ftdi_free(struct ftdi_context *ftdi);
267 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
268
269 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
270 int vendor, int product);
271 void ftdi_list_free(struct ftdi_device_list **devlist);
272 void ftdi_list_free2(struct ftdi_device_list *devlist);
273 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev,
274 char * manufacturer, int mnf_len,
275 char * description, int desc_len,
276 char * serial, int serial_len);
277
278 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
279 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
280 const char* description, const char* serial);
281 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
282
283 int ftdi_usb_close(struct ftdi_context *ftdi);
284 int ftdi_usb_reset(struct ftdi_context *ftdi);
285 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi);
286 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi);
287 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
288
289 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
290 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
291 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
292 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
293 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
294 enum ftdi_break_type break_type);
295
296 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
297 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
298 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
299
300 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
301 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
302 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
303
304 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
305 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
306
307 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
308 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
309 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
310 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
311
312 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
313 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
314
315 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status);
316
317 /* flow control */
318 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
319 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts);
320 int ftdi_setdtr(struct ftdi_context *ftdi, int state);
321 int ftdi_setrts(struct ftdi_context *ftdi, int state);
322
323 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable);
324 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable);
325
326 /* set eeprom size */
327 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size);
328
329 /* init and build eeprom from ftdi_eeprom structure */
330 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
331 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
332 int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
333
334 /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
335 the checksum of the eeprom is valided */
336 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
337 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
338 int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize);
339 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
340 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
341
342 char *ftdi_get_error_string(struct ftdi_context *ftdi);
343
344#ifdef __cplusplus
345}
346#endif
347
348#endif /* __libftdi_h__ */
A library to talk to FTDI chips