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 */ 25 enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5, TYPE_232H = 6 }; 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 /** Automatic loading / unloading of kernel modules */ 60 enum ftdi_module_detach_mode 61 { 62 AUTO_DETACH_SIO_MODULE = 0, 63 DONT_DETACH_SIO_MODULE = 1 64 }; 65 66 /* Shifting commands IN MPSSE Mode*/ 67 #define MPSSE_WRITE_NEG 0x01 /* Write TDI/DO on negative TCK/SK edge*/ 68 #define MPSSE_BITMODE 0x02 /* Write bits, not bytes */ 69 #define MPSSE_READ_NEG 0x04 /* Sample TDO/DI on negative TCK/SK edge */ 70 #define MPSSE_LSB 0x08 /* LSB first */ 71 #define MPSSE_DO_WRITE 0x10 /* Write TDI/DO */ 72 #define MPSSE_DO_READ 0x20 /* Read TDO/DI */ 73 #define MPSSE_WRITE_TMS 0x40 /* Write TMS/CS */ 74 75 /* FTDI MPSSE commands */ 76 #define SET_BITS_LOW 0x80 77 /*BYTE DATA*/ 78 /*BYTE Direction*/ 79 #define SET_BITS_HIGH 0x82 80 /*BYTE DATA*/ 81 /*BYTE Direction*/ 82 #define GET_BITS_LOW 0x81 83 #define GET_BITS_HIGH 0x83 84 #define LOOPBACK_START 0x84 85 #define LOOPBACK_END 0x85 86 #define TCK_DIVISOR 0x86 87 /* H Type specific commands */ 88 #define DIS_DIV_5 0x8a 89 #define EN_DIV_5 0x8b 90 #define EN_3_PHASE 0x8c 91 #define DIS_3_PHASE 0x8d 92 #define CLK_BITS 0x8e 93 #define CLK_BYTES 0x8f 94 #define CLK_WAIT_HIGH 0x94 95 #define CLK_WAIT_LOW 0x95 96 #define EN_ADAPTIVE 0x96 97 #define DIS_ADAPTIVE 0x97 98 #define CLK_BYTES_OR_HIGH 0x9c 99 #define CLK_BYTES_OR_LOW 0x0d 100 /*FT232H specific commands */ 101 #define DRIVE_OPEN_COLLECTOR 0x9e 102 /* Value Low */ 103 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */ 104 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1) 105 106 /* Commands in MPSSE and Host Emulation Mode */ 107 #define SEND_IMMEDIATE 0x87 108 #define WAIT_ON_HIGH 0x88 109 #define WAIT_ON_LOW 0x89 110 111 /* Commands in Host Emulation Mode */ 112 #define READ_SHORT 0x90 113 /* Address_Low */ 114 #define READ_EXTENDED 0x91 115 /* Address High */ 116 /* Address Low */ 117 #define WRITE_SHORT 0x92 118 /* Address_Low */ 119 #define WRITE_EXTENDED 0x93 120 /* Address High */ 121 /* Address Low */ 122 123 /* Definitions for flow control */ 124 #define SIO_RESET 0 /* Reset the port */ 125 #define SIO_MODEM_CTRL 1 /* Set the modem control register */ 126 #define SIO_SET_FLOW_CTRL 2 /* Set flow control register */ 127 #define SIO_SET_BAUD_RATE 3 /* Set baud rate */ 128 #define SIO_SET_DATA 4 /* Set the data characteristics of the port */ 129 130 #define FTDI_DEVICE_OUT_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_OUT) 131 #define FTDI_DEVICE_IN_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_IN) 132 133 /* Requests */ 134 #define SIO_RESET_REQUEST SIO_RESET 135 #define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE 136 #define SIO_SET_DATA_REQUEST SIO_SET_DATA 137 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL 138 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL 139 #define SIO_POLL_MODEM_STATUS_REQUEST 0x05 140 #define SIO_SET_EVENT_CHAR_REQUEST 0x06 141 #define SIO_SET_ERROR_CHAR_REQUEST 0x07 142 #define SIO_SET_LATENCY_TIMER_REQUEST 0x09 143 #define SIO_GET_LATENCY_TIMER_REQUEST 0x0A 144 #define SIO_SET_BITMODE_REQUEST 0x0B 145 #define SIO_READ_PINS_REQUEST 0x0C 146 #define SIO_READ_EEPROM_REQUEST 0x90 147 #define SIO_WRITE_EEPROM_REQUEST 0x91 148 #define SIO_ERASE_EEPROM_REQUEST 0x92 149 150 151 #define SIO_RESET_SIO 0 152 #define SIO_RESET_PURGE_RX 1 153 #define SIO_RESET_PURGE_TX 2 154 155 #define SIO_DISABLE_FLOW_CTRL 0x0 156 #define SIO_RTS_CTS_HS (0x1 << 8) 157 #define SIO_DTR_DSR_HS (0x2 << 8) 158 #define SIO_XON_XOFF_HS (0x4 << 8) 159 160 #define SIO_SET_DTR_MASK 0x1 161 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK << 8)) 162 #define SIO_SET_DTR_LOW ( 0 | ( SIO_SET_DTR_MASK << 8)) 163 #define SIO_SET_RTS_MASK 0x2 164 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 )) 165 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 )) 166 167 #define SIO_RTS_CTS_HS (0x1 << 8) 168 169 /* marker for unused usb urb structures 170 (taken from libusb) */ 171 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1) 172 173 #ifdef __GNUC__ 174 #define DEPRECATED(func) func __attribute__ ((deprecated)) 175 #elif defined(_MSC_VER) 176 #define DEPRECATED(func) __declspec(deprecated) func 177 #else 178 #pragma message("WARNING: You need to implement DEPRECATED for this compiler") 179 #define DEPRECATED(func) func 180 #endif 181 182 183 /** 184 \brief Main context structure for all libftdi functions. 185 186 Do not access directly if possible. 187 */ 188 struct ftdi_context 189 { 190 /* USB specific */ 191 /** libusb's usb_dev_handle */ 192 struct usb_dev_handle *usb_dev; 193 /** usb read timeout */ 194 int usb_read_timeout; 195 /** usb write timeout */ 196 int usb_write_timeout; 197 198 /* FTDI specific */ 199 /** FTDI chip type */ 200 enum ftdi_chip_type type; 201 /** baudrate */ 202 int baudrate; 203 /** bitbang mode state */ 204 unsigned char bitbang_enabled; 205 /** pointer to read buffer for ftdi_read_data */ 206 unsigned char *readbuffer; 207 /** read buffer offset */ 208 unsigned int readbuffer_offset; 209 /** number of remaining data in internal read buffer */ 210 unsigned int readbuffer_remaining; 211 /** read buffer chunk size */ 212 unsigned int readbuffer_chunksize; 213 /** write buffer chunk size */ 214 unsigned int writebuffer_chunksize; 215 /** maximum packet size. Needed for filtering modem status bytes every n packets. */ 216 unsigned int max_packet_size; 217 218 /* FTDI FT2232C requirecments */ 219 /** FT2232C interface number: 0 or 1 */ 220 int interface; /* 0 or 1 */ 221 /** FT2232C index number: 1 or 2 */ 222 int index; /* 1 or 2 */ 223 /* Endpoints */ 224 /** FT2232C end points: 1 or 2 */ 225 int in_ep; 226 int out_ep; /* 1 or 2 */ 227 228 /** Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */ 229 unsigned char bitbang_mode; 230 231 /** EEPROM size. Default is 128 bytes for 232BM and 245BM chips */ 232 int eeprom_size; 233 234 /** String representation of last error */ 235 char *error_str; 236 237 /** Buffer needed for async communication */ 238 char *async_usb_buffer; 239 /** Number of URB-structures we can buffer */ 240 unsigned int async_usb_buffer_size; 241 242 /** Defines behavior in case a kernel module is already attached to the device */ 243 enum ftdi_module_detach_mode module_detach_mode; 244 }; 245 246 /** 247 \brief list of usb devices created by ftdi_usb_find_all() 248 */ 249 struct ftdi_device_list 250 { 251 /** pointer to next entry */ 252 struct ftdi_device_list *next; 253 /** pointer to libusb's usb_device */ 254 struct usb_device *dev; 255 }; 256 257 258 /** TXDEN */ 259 #define CBUS_TXDEN 0 260 /** PWREN# */ 261 #define CBUS_PWREN 1 262 /** RXLED# */ 263 #define CBUS_RXLED 2 264 /** TXLED#*/ 265 #define CBUS_TXLED 3 266 /** RXLED# & TXLED# */ 267 #define CBUS_TXRXLED 4 268 /** SLEEP# */ 269 #define CBUS_SLEEP 5 270 /** 48 MHz clock */ 271 #define CBUS_CLK48 6 272 /** 24 MHz clock */ 273 #define CBUS_CLK24 7 274 /** 12 MHz clock */ 275 #define CBUS_CLK12 8 276 /** 6 MHz clock */ 277 #define CBUS_CLK6 9 278 /** Bitbang IO Mode*/ 279 #define CBUS_IOMODE 10 280 /** Bitbang IO WR#*/ 281 #define CBUS_BB_WR 11 282 /** Bitbang IO RD#*/ 283 #define CBUS_BB_RD 12 284 285 286 /** Invert TXD# */ 287 #define INVERT_TXD 0x01 288 /** Invert RXD# */ 289 #define INVERT_RXD 0x02 290 /** Invert RTS# */ 291 #define INVERT_RTS 0x04 292 /** Invert CTS# */ 293 #define INVERT_CTS 0x08 294 /** Invert DTR# */ 295 #define INVERT_DTR 0x10 296 /** Invert DSR# */ 297 #define INVERT_DSR 0x20 298 /** Invert DCD# */ 299 #define INVERT_DCD 0x40 300 /** Invert RI# */ 301 #define INVERT_RI 0x80 302 303 /** High current drive. */ 304 #define HIGH_CURRENT_DRIVE 0x04 305 306 /** 307 \brief FTDI eeprom structure 308 */ 309 struct ftdi_eeprom 310 { 311 /** vendor id */ 312 int vendor_id; 313 /** product id */ 314 int product_id; 315 316 /** self powered */ 317 int self_powered; 318 /** remote wakeup */ 319 int remote_wakeup; 320 /** chip type */ 321 int chip_type; 322 323 /** input in isochronous transfer mode */ 324 int in_is_isochronous; 325 /** output in isochronous transfer mode */ 326 int out_is_isochronous; 327 /** suspend pull downs */ 328 int suspend_pull_downs; 329 330 /** use serial */ 331 int use_serial; 332 /** fake usb version */ 333 int change_usb_version; 334 /** usb version */ 335 int usb_version; 336 /** maximum power */ 337 int max_power; 338 339 /** manufacturer name */ 340 char *manufacturer; 341 /** product name */ 342 char *product; 343 /** serial number */ 344 char *serial; 345 346 /* Special function of FT232R devices (and possibly others as well) */ 347 /** CBUS pin function. See CBUS_xxx defines. */ 348 int cbus_function[5]; 349 /** Select hight current drive. */ 350 int high_current; 351 /** Select inversion of data lines (bitmask). */ 352 int invert; 353 354 /** eeprom size in bytes. This doesn't get stored in the eeprom 355 but is the only way to pass it to ftdi_eeprom_build. */ 356 int size; 357 }; 358 359 #ifdef __cplusplus 360 extern "C" 361 { 362 #endif 363 364 int ftdi_init(struct ftdi_context *ftdi); 365 struct ftdi_context *ftdi_new(void); 366 int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface); 367 368 void ftdi_deinit(struct ftdi_context *ftdi); 369 void ftdi_free(struct ftdi_context *ftdi); 370 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev); 371 372 int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, 373 int vendor, int product); 374 void ftdi_list_free(struct ftdi_device_list **devlist); 375 void ftdi_list_free2(struct ftdi_device_list *devlist); 376 int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev, 377 char * manufacturer, int mnf_len, 378 char * description, int desc_len, 379 char * serial, int serial_len); 380 381 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product); 382 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, 383 const char* description, const char* serial); 384 int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, 385 const char* description, const char* serial, unsigned int index); 386 int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev); 387 int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description); 388 389 int ftdi_usb_close(struct ftdi_context *ftdi); 390 int ftdi_usb_reset(struct ftdi_context *ftdi); 391 int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi); 392 int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi); 393 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi); 394 395 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate); 396 int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, 397 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity); 398 int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits, 399 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, 400 enum ftdi_break_type break_type); 401 402 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size); 403 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); 404 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); 405 406 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size); 407 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); 408 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); 409 410 int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size); 411 void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more); 412 413 int DEPRECATED(ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)); 414 int ftdi_disable_bitbang(struct ftdi_context *ftdi); 415 int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode); 416 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins); 417 418 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency); 419 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency); 420 421 int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status); 422 423 /* flow control */ 424 int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl); 425 int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts); 426 int ftdi_setdtr(struct ftdi_context *ftdi, int state); 427 int ftdi_setrts(struct ftdi_context *ftdi, int state); 428 429 int ftdi_set_event_char(struct ftdi_context *ftdi, unsigned char eventch, unsigned char enable); 430 int ftdi_set_error_char(struct ftdi_context *ftdi, unsigned char errorch, unsigned char enable); 431 432 /* set eeprom size */ 433 void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size); 434 435 /* init and build eeprom from ftdi_eeprom structure */ 436 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom); 437 void ftdi_eeprom_free(struct ftdi_eeprom *eeprom); 438 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output); 439 int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size); 440 441 /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator) 442 the checksum of the eeprom is valided */ 443 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom); 444 int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid); 445 int ftdi_read_eeprom_getsize(struct ftdi_context *ftdi, unsigned char *eeprom, int maxsize); 446 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom); 447 int ftdi_erase_eeprom(struct ftdi_context *ftdi); 448 449 int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val); 450 int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val); 451 452 char *ftdi_get_error_string(struct ftdi_context *ftdi); 453 454 #ifdef __cplusplus 455 } 456 #endif 457 458 #endif /* __libftdi_h__ */ 459