| 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 <libusb.h> |
| 21 | |
| 22 | #define FTDI_DEFAULT_EEPROM_SIZE 128 |
| 23 | |
| 24 | /** FTDI chip type */ |
| 25 | enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 }; |
| 26 | /** Parity mode for ftdi_set_line_property() */ |
| 27 | enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 }; |
| 28 | /** Number of stop bits for ftdi_set_line_property() */ |
| 29 | enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 }; |
| 30 | /** Number of bits for ftdi_set_line_property() */ |
| 31 | enum ftdi_bits_type { BITS_7=7, BITS_8=8 }; |
| 32 | /** Break type for ftdi_set_line_property2() */ |
| 33 | enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 }; |
| 34 | |
| 35 | /** MPSSE bitbang modes */ |
| 36 | enum ftdi_mpsse_mode |
| 37 | { |
| 38 | BITMODE_RESET = 0x00, /**< switch off bitbang mode, back to regular serial/FIFO */ |
| 39 | BITMODE_BITBANG= 0x01, /**< classical asynchronous bitbang mode, introduced with B-type chips */ |
| 40 | BITMODE_MPSSE = 0x02, /**< MPSSE mode, available on 2232x chips */ |
| 41 | BITMODE_SYNCBB = 0x04, /**< synchronous bitbang mode, available on 2232x and R-type chips */ |
| 42 | BITMODE_MCU = 0x08, /**< MCU Host Bus Emulation mode, available on 2232x chips */ |
| 43 | /* CPU-style fifo mode gets set via EEPROM */ |
| 44 | BITMODE_OPTO = 0x10, /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips */ |
| 45 | BITMODE_CBUS = 0x20, /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */ |
| 46 | BITMODE_SYNCFF = 0x40, /**< Single Channel Synchronous FIFO mode, available on 2232H chips */ |
| 47 | }; |
| 48 | |
| 49 | /** Port interface for chips with multiple interfaces */ |
| 50 | enum ftdi_interface |
| 51 | { |
| 52 | INTERFACE_ANY = 0, |
| 53 | INTERFACE_A = 1, |
| 54 | INTERFACE_B = 2, |
| 55 | INTERFACE_C = 3, |
| 56 | INTERFACE_D = 4 |
| 57 | }; |
| 58 | |
| 59 | /* Shifting commands IN MPSSE Mode*/ |
| 60 | #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/ |
| 61 | #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */ |
| 62 | #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */ |
| 63 | #define MPSSE_LSB 0x08 /* LSB first */ |
| 64 | #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */ |
| 65 | #define MPSSE_DO_READ 0x20 /* Read TDO/DI */ |
| 66 | #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */ |
| 67 | |
| 68 | /* FTDI MPSSE commands */ |
| 69 | #define SET_BITS_LOW 0x80 |
| 70 | /*BYTE DATA*/ |
| 71 | /*BYTE Direction*/ |
| 72 | #define SET_BITS_HIGH 0x82 |
| 73 | /*BYTE DATA*/ |
| 74 | /*BYTE Direction*/ |
| 75 | #define GET_BITS_LOW 0x81 |
| 76 | #define GET_BITS_HIGH 0x83 |
| 77 | #define LOOPBACK_START 0x84 |
| 78 | #define LOOPBACK_END 0x85 |
| 79 | #define TCK_DIVISOR 0x86 |
| 80 | /* Value Low */ |
| 81 | /* Value HIGH */ /*rate is 12000000/((1+value)*2) */ |
| 82 | #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1) |
| 83 | |
| 84 | /* Commands in MPSSE and Host Emulation Mode */ |
| 85 | #define SEND_IMMEDIATE 0x87 |
| 86 | #define WAIT_ON_HIGH 0x88 |
| 87 | #define WAIT_ON_LOW 0x89 |
| 88 | |
| 89 | /* Commands in Host Emulation Mode */ |
| 90 | #define READ_SHORT 0x90 |
| 91 | /* Address_Low */ |
| 92 | #define READ_EXTENDED 0x91 |
| 93 | /* Address High */ |
| 94 | /* Address Low */ |
| 95 | #define WRITE_SHORT 0x92 |
| 96 | /* Address_Low */ |
| 97 | #define WRITE_EXTENDED 0x93 |
| 98 | /* Address High */ |
| 99 | /* Address Low */ |
| 100 | |
| 101 | /* Definitions for flow control */ |
| 102 | #define SIO_RESET 0 /* Reset the port */ |
| 103 | #define SIO_MODEM_CTRL 1 /* Set the modem control register */ |
| 104 | #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */ |
| 105 | #define SIO_SET_BAUD_RATE 3 /* Set baud rate */ |
| 106 | #define SIO_SET_DATA 4 /* Set the data characteristics of the port */ |
| 107 | |
| 108 | #define FTDI_DEVICE_OUT_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT) |
| 109 | #define FTDI_DEVICE_IN_REQTYPE (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN) |
| 110 | |
| 111 | /* Requests */ |
| 112 | #define SIO_RESET_REQUEST SIO_RESET |
| 113 | #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE |
| 114 | #define SIO_SET_DATA_REQUEST SIO_SET_DATA |
| 115 | #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL |
| 116 | #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL |
| 117 | #define SIO_POLL_MODEM_STATUS_REQUEST 0x05 |
| 118 | #define SIO_SET_EVENT_CHAR_REQUEST 0x06 |
| 119 | #define SIO_SET_ERROR_CHAR_REQUEST 0x07 |
| 120 | #define SIO_SET_LATENCY_TIMER_REQUEST 0x09 |
| 121 | #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A |
| 122 | #define SIO_SET_BITMODE_REQUEST 0x0B |
| 123 | #define SIO_READ_PINS_REQUEST 0x0C |
| 124 | #define SIO_READ_EEPROM_REQUEST 0x90 |
| 125 | #define SIO_WRITE_EEPROM_REQUEST 0x91 |
| 126 | #define SIO_ERASE_EEPROM_REQUEST 0x92 |
| 127 | |
| 128 | |
| 129 | #define SIO_RESET_SIO 0 |
| 130 | #define SIO_RESET_PURGE_RX 1 |
| 131 | #define SIO_RESET_PURGE_TX 2 |
| 132 | |
| 133 | #define SIO_DISABLE_FLOW_CTRL 0x0 |
| 134 | #define SIO_RTS_CTS_HS (0x1 << 8) |
| 135 | #define SIO_DTR_DSR_HS (0x2 << 8) |
| 136 | #define SIO_XON_XOFF_HS (0x4 << 8) |
| 137 | |
| 138 | #define SIO_SET_DTR_MASK 0x1 |
| 139 | #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8)) |
| 140 | #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8)) |
| 141 | #define SIO_SET_RTS_MASK 0x2 |
| 142 | #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 )) |
| 143 | #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 )) |
| 144 | |
| 145 | #define SIO_RTS_CTS_HS (0x1 << 8) |
| 146 | |
| 147 | /* marker for unused usb urb structures |
| 148 | (taken from libusb) */ |
| 149 | #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1) |
| 150 | |
| 151 | #ifdef __GNUC__ |
| 152 | #define DEPRECATED(func) func __attribute__ ((deprecated)) |
| 153 | #elif defined(_MSC_VER) |
| 154 | #define DEPRECATED(func) __declspec(deprecated) func |
| 155 | #else |
| 156 | #pragma message("WARNING: You need to implement DEPRECATED for this compiler") |
| 157 | #define DEPRECATED(func) func |
| 158 | #endif |
| 159 | |
| 160 | struct ftdi_transfer_control |
| 161 | { |
| 162 | int completed; |
| 163 | unsigned char *buf; |
| 164 | int size; |
| 165 | int offset; |
| 166 | struct ftdi_context *ftdi; |
| 167 | struct libusb_transfer *transfer; |
| 168 | }; |
| 169 | |
| 170 | /** |
| 171 | \brief Main context structure for all libftdi functions. |
| 172 | |
| 173 | Do not access directly if possible. |
| 174 | */ |
| 175 | struct ftdi_context |
| 176 | { |
| 177 | /* USB specific */ |
| 178 | /** libusb's usb_dev_handle */ |
| 179 | struct libusb_device_handle *usb_dev; |
| 180 | /** usb read timeout */ |
| 181 | int usb_read_timeout; |
| 182 | /** usb write timeout */ |
| 183 | int usb_write_timeout; |
| 184 | |
| 185 | /* FTDI specific */ |
| 186 | /** FTDI chip type */ |
| 187 | enum ftdi_chip_type type; |
| 188 | /** baudrate */ |
| 189 | int baudrate; |
| 190 | /** bitbang mode state */ |
| 191 | unsigned char bitbang_enabled; |
| 192 | /** pointer to read buffer for ftdi_read_data */ |
| 193 | unsigned char *readbuffer; |
| 194 | /** read buffer offset */ |
| 195 | unsigned int readbuffer_offset; |
| 196 | /** number of remaining data in internal read buffer */ |
| 197 | unsigned int readbuffer_remaining; |
| 198 | /** read buffer chunk size */ |
| 199 | unsigned int readbuffer_chunksize; |
| 200 | /** write buffer chunk size */ |
| 201 | unsigned int writebuffer_chunksize; |
| 202 | /** maximum packet size. Needed for filtering modem status bytes every n packets. */ |
| 203 | unsigned int max_packet_size; |
| 204 | |
| 205 | /* FTDI FT2232C requirecments */ |
| 206 | /** FT2232C interface number: 0 or 1 */ |
| 207 | int interface; /* 0 or 1 */ |
| 208 | /** FT2232C index number: 1 or 2 */ |
| 209 | int index; /* 1 or 2 */ |
| 210 | /* Endpoints */ |
| 211 | /** FT2232C end points: 1 or 2 */ |
| 212 | int in_ep; |
| 213 | int out_ep; /* 1 or 2 */ |
| 214 | |
| 215 | /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */ |
| 216 | unsigned char bitbang_mode; |
| 217 | |
| 218 | /** EEPROM size. Default is 128 bytes for 232BM and 245BM chips */ |
| 219 | int eeprom_size; |
| 220 | |
| 221 | /** String representation of last error */ |
| 222 | char *error_str; |
| 223 | }; |
| 224 | |
| 225 | /** |
| 226 | \brief list of usb devices created by ftdi_usb_find_all() |
| 227 | */ |
| 228 | struct ftdi_device_list |
| 229 | { |
| 230 | /** pointer to next entry */ |
| 231 | struct ftdi_device_list *next; |
| 232 | /** pointer to libusb's usb_device */ |
| 233 | struct libusb_device *dev; |
| 234 | }; |
| 235 | |
| 236 | /** |
| 237 | \brief FTDI eeprom structure |
| 238 | */ |
| 239 | struct ftdi_eeprom |
| 240 | { |
| 241 | /** vendor id */ |
| 242 | int vendor_id; |
| 243 | /** product id */ |
| 244 | int product_id; |
| 245 | |
| 246 | /** self powered */ |
| 247 | int self_powered; |
| 248 | /** remote wakeup */ |
| 249 | int remote_wakeup; |
| 250 | /** chip type */ |
| 251 | int BM_type_chip; |
| 252 | |
| 253 | /** input in isochronous transfer mode */ |
| 254 | int in_is_isochronous; |
| 255 | /** output in isochronous transfer mode */ |
| 256 | int out_is_isochronous; |
| 257 | /** suspend pull downs */ |
| 258 | int suspend_pull_downs; |
| 259 | |
| 260 | /** use serial */ |
| 261 | int use_serial; |
| 262 | /** fake usb version */ |
| 263 | int change_usb_version; |
| 264 | /** usb version */ |
| 265 | int usb_version; |
| 266 | /** maximum power */ |
| 267 | int max_power; |
| 268 | |
| 269 | /** manufacturer name */ |
| 270 | char *manufacturer; |
| 271 | /** product name */ |
| 272 | char *product; |
| 273 | /** serial number */ |
| 274 | char *serial; |
| 275 | |
| 276 | /** eeprom size in bytes. This doesn't get stored in the eeprom |
| 277 | but is the only way to pass it to ftdi_eeprom_build. */ |
| 278 | int size; |
| 279 | }; |
| 280 | |
| 281 | #ifdef __cplusplus |
| 282 | extern "C" |
| 283 | { |
| 284 | #endif |
| 285 | |
| 286 | int ftdi_init(struct ftdi_context *ftdi); |
| 287 | struct ftdi_context *ftdi_new(void); |
| 288 | int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface); |
| 289 | |
| 290 | void ftdi_deinit(struct ftdi_context *ftdi); |
| 291 | void ftdi_free(struct ftdi_context *ftdi); |
| 292 | void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev); |
| 293 | |
| 294 | int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, |
| 295 | int vendor, int product); |
| 296 | void ftdi_list_free(struct ftdi_device_list **devlist); |
| 297 | void ftdi_list_free2(struct ftdi_device_list *devlist); |
| 298 | int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev, |
| 299 | char * manufacturer, int mnf_len, |
| 300 | char * description, int desc_len, |
| 301 | char * serial, int serial_len); |
| 302 | |
| 303 | int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product); |
| 304 | int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, |
| 305 | const char* description, const char* serial); |
| 306 | int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, |
| 307 | const char* description, const char* serial, unsigned int index); |
| 308 | int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev); |
| 309 | int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description); |
| 310 | |
| 311 | int ftdi_usb_close(struct ftdi_context *ftdi); |
| 312 | int ftdi_usb_reset(struct ftdi_context *ftdi); |
| 313 | int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi); |
| 314 | int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi); |
| 315 | int ftdi_usb_purge_buffers(struct ftdi_context *ftdi); |
| 316 | |
| 317 | int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate); |
| 318 | int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
| 319 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity); |
| 320 | int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
| 321 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, |
| 322 | enum ftdi_break_type break_type); |
| 323 | |
| 324 | int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size); |
| 325 | int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); |
| 326 | int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); |
| 327 | |
| 328 | int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size); |
| 329 | int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); |
| 330 | int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); |
| 331 | |
| 332 | int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size); |
| 333 | void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more); |
| 334 | |
| 335 | int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)); |
| 336 | int ftdi_disable_bitbang(struct ftdi_context *ftdi); |
| 337 | int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode); |
| 338 | int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins); |
| 339 | |
| 340 | int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency); |
| 341 | int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency); |
| 342 | |
| 343 | int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status); |
| 344 | |
| 345 | /* flow control */ |
| 346 | int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl); |
| 347 | int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts); |
| 348 | int ftdi_setdtr(struct ftdi_context *ftdi, int state); |
| 349 | int ftdi_setrts(struct ftdi_context *ftdi, int state); |
| 350 | |
| 351 | int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable); |
| 352 | int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable); |
| 353 | |
| 354 | /* set eeprom size */ |
| 355 | void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size); |
| 356 | |
| 357 | /* init and build eeprom from ftdi_eeprom structure */ |
| 358 | void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom); |
| 359 | int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output); |
| 360 | int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size); |
| 361 | |
| 362 | /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator) |
| 363 | the checksum of the eeprom is valided */ |
| 364 | int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom); |
| 365 | int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid); |
| 366 | int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize); |
| 367 | int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom); |
| 368 | int ftdi_erase_eeprom(struct ftdi_context *ftdi); |
| 369 | |
| 370 | int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val); |
| 371 | int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val); |
| 372 | |
| 373 | char *ftdi_get_error_string(struct ftdi_context *ftdi); |
| 374 | |
| 375 | #ifdef __cplusplus |
| 376 | } |
| 377 | #endif |
| 378 | |
| 379 | #endif /* __libftdi_h__ */ |