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