developer.intra2net.com Git - libftdi/blob - src/ftdi.h

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