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 /// FTDI chip type
  23 enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
  24 /// Parity mode for ftdi_set_line_property()
  25 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
  26 /// Number of stop bits for ftdi_set_line_property()
  27 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
  28 /// Number of bits ftdi_set_line_property()
  29 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
  30
  31 /// MPSSE bitbang modes
  32 enum ftdi_mpsse_mode {
  33     BITMODE_RESET  = 0x00,
  34     BITMODE_BITBANG= 0x01,
  35     BITMODE_MPSSE  = 0x02,
  36     BITMODE_SYNCBB = 0x04,
  37     BITMODE_MCU    = 0x08,
  38     // CPU-style fifo mode gets set via EEPROM
  39     BITMODE_OPTO   = 0x10,
  40     BITMODE_CBUS   = 0x20
  41 };
  42
  43 /// Port interface for FT2232C
  44 enum ftdi_interface {
  45     INTERFACE_ANY = 0,
  46     INTERFACE_A   = 1,
  47     INTERFACE_B   = 2
  48 };
  49
  50 /* Shifting commands IN MPSSE Mode*/
  51 #define MPSSE_WRITE_NEG 0x01   /* Write TDI/DO on negative TCK/SK edge*/
  52 #define MPSSE_BITMODE   0x02   /* Write bits, not bytes */
  53 #define MPSSE_READ_NEG  0x04   /* Sample TDO/DI on negative TCK/SK edge */
  54 #define MPSSE_LSB       0x08   /* LSB first */
  55 #define MPSSE_DO_WRITE  0x10   /* Write TDI/DO */
  56 #define MPSSE_DO_READ   0x20   /* Read TDO/DI */
  57 #define MPSSE_WRITE_TMS 0x40   /* Write TMS/CS */
  58
  59 /* FTDI MPSSE commands */
  60 #define SET_BITS_LOW   0x80
  61 /*BYTE DATA*/
  62 /*BYTE Direction*/
  63 #define SET_BITS_HIGH  0x82
  64 /*BYTE DATA*/
  65 /*BYTE Direction*/
  66 #define GET_BITS_LOW   0x81
  67 #define GET_BITS_HIGH  0x83
  68 #define LOOPBACK_START 0x84
  69 #define LOOPBACK_END   0x85
  70 #define TCK_DIVISOR    0x86
  71 /* Value Low */
  72 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
  73 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
  74
  75 /* Commands in MPSSE and Host Emulation Mode */
  76 #define SEND_IMMEDIATE 0x87
  77 #define WAIT_ON_HIGH   0x88
  78 #define WAIT_ON_LOW    0x89
  79
  80 /* Commands in Host Emulation Mode */
  81 #define READ_SHORT     0x90
  82 /* Address_Low */
  83 #define READ_EXTENDED  0x91
  84 /* Address High */
  85 /* Address Low  */
  86 #define WRITE_SHORT    0x92
  87 /* Address_Low */
  88 #define WRITE_EXTENDED 0x93
  89 /* Address High */
  90 /* Address Low  */
  91
  92 /* Definitions for flow control */
  93 #define SIO_MODEM_CTRL     1 /* Set the modem control register */
  94 #define SIO_SET_FLOW_CTRL  2 /* Set flow control register */
  95
  96 #define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
  97 #define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
  98
  99 #define SIO_DISABLE_FLOW_CTRL 0x0
 100 #define SIO_RTS_CTS_HS (0x1 << 8)
 101 #define SIO_DTR_DSR_HS (0x2 << 8)
 102 #define SIO_XON_XOFF_HS (0x4 << 8)
 103
 104 #define SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
 105 #define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
 106
 107 #define SIO_SET_DTR_MASK 0x1
 108 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK  << 8))
 109 #define SIO_SET_DTR_LOW  ( 0 | ( SIO_SET_DTR_MASK  << 8))
 110 #define SIO_SET_RTS_MASK 0x2
 111 #define SIO_SET_RTS_HIGH ( 2 | ( SIO_SET_RTS_MASK << 8 ))
 112 #define SIO_SET_RTS_LOW ( 0 | ( SIO_SET_RTS_MASK << 8 ))
 113
 114 #define SIO_RTS_CTS_HS (0x1 << 8)
 115
 116 /* marker for unused usb urb structures
 117    (taken from libusb) */
 118 #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1)
 119
 120 /**
 121     \brief Main context structure for all libftdi functions.
 122
 123     Do not access directly if possible.
 124 */
 125 struct ftdi_context {
 126     // USB specific
 127     /// libusb's usb_dev_handle
 128     struct usb_dev_handle *usb_dev;
 129     /// usb read timeout
 130     int usb_read_timeout;
 131     /// usb write timeout
 132     int usb_write_timeout;
 133
 134     // FTDI specific
 135     /// FTDI chip type
 136     enum ftdi_chip_type type;
 137     /// baudrate
 138     int baudrate;
 139     /// bitbang mode state
 140     unsigned char bitbang_enabled;
 141     /// pointer to read buffer for ftdi_read_data
 142     unsigned char *readbuffer;
 143     /// read buffer offset
 144     unsigned int readbuffer_offset;
 145     /// number of remaining data in internal read buffer
 146     unsigned int readbuffer_remaining;
 147     /// read buffer chunk size
 148     unsigned int readbuffer_chunksize;
 149     /// write buffer chunk size
 150     unsigned int writebuffer_chunksize;
 151
 152     // FTDI FT2232C requirecments
 153     /// FT2232C interface number: 0 or 1
 154     int interface;   // 0 or 1
 155     /// FT2232C index number: 1 or 2
 156     int index;       // 1 or 2
 157     // Endpoints
 158     /// FT2232C end points: 1 or 2
 159     int in_ep;
 160     int out_ep;      // 1 or 2
 161
 162     /// Bitbang mode. 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode
 163     unsigned char bitbang_mode;
 164
 165     /// String representation of last error
 166     char *error_str;
 167
 168     /// Buffer needed for async communication
 169     char *async_usb_buffer;
 170     /// Number of URB-structures we can buffer
 171     unsigned int async_usb_buffer_size;
 172 };
 173
 174 /**
 175     \brief list of usb devices created by ftdi_usb_find_all()
 176 */
 177 struct ftdi_device_list {
 178     /// pointer to next entry
 179     struct ftdi_device_list *next;
 180     /// pointer to libusb's usb_device
 181     struct usb_device *dev;
 182 };
 183
 184 /**
 185     \brief FTDI eeprom structure
 186 */
 187 struct ftdi_eeprom {
 188     /// vendor id
 189     int vendor_id;
 190     /// product id
 191     int product_id;
 192
 193     /// self powered
 194     int self_powered;
 195     /// remote wakepu
 196     int remote_wakeup;
 197     /// chip type
 198     int BM_type_chip;
 199
 200     /// input in isochronous transfer mode
 201     int in_is_isochronous;
 202     /// output in isochronous transfer mode
 203     int out_is_isochronous;
 204     /// suspend pull downs
 205     int suspend_pull_downs;
 206
 207     /// use serial
 208     int use_serial;
 209     /// fake usb version
 210     int change_usb_version;
 211     /// usb version
 212     int usb_version;
 213     /// maximum power
 214     int max_power;
 215
 216     /// manufacturer name
 217     char *manufacturer;
 218     /// product name
 219     char *product;
 220     /// serial number
 221     char *serial;
 222 };
 223
 224 #ifdef __cplusplus
 225 extern "C" {
 226 #endif
 227
 228     int ftdi_init(struct ftdi_context *ftdi);
 229     int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
 230
 231     void ftdi_deinit(struct ftdi_context *ftdi);
 232     void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
 233
 234     int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
 235                           int vendor, int product);
 236     void ftdi_list_free(struct ftdi_device_list **devlist);
 237     int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev,
 238                              char * manufacturer, int mnf_len,
 239                              char * description, int desc_len,
 240                              char * serial, int serial_len);
 241
 242     int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
 243     int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
 244                            const char* description, const char* serial);
 245     int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
 246
 247     int ftdi_usb_close(struct ftdi_context *ftdi);
 248     int ftdi_usb_reset(struct ftdi_context *ftdi);
 249     int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
 250
 251     int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
 252     int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
 253                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
 254
 255     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
 256     int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
 257     int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 258
 259     int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
 260     int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
 261     int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 262
 263     int ftdi_write_data_async(struct ftdi_context *ftdi, unsigned char *buf, int size);
 264     void ftdi_async_complete(struct ftdi_context *ftdi, int wait_for_more);
 265
 266     int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
 267     int ftdi_disable_bitbang(struct ftdi_context *ftdi);
 268     int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
 269     int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
 270
 271     int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
 272     int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
 273
 274     // init and build eeprom from ftdi_eeprom structure
 275     void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
 276     int  ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
 277
 278     // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
 279     // the checksum of the eeprom is valided
 280     int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
 281     int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid);
 282     int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
 283     int ftdi_erase_eeprom(struct ftdi_context *ftdi);
 284
 285     char *ftdi_get_error_string(struct ftdi_context *ftdi);
 286
 287     // flow control
 288     int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl);
 289     int ftdi_setdtr(struct ftdi_context *ftdi, int state);
 290     int ftdi_setrts(struct ftdi_context *ftdi, int state);
 291
 292 #ifdef __cplusplus
 293 }
 294 #endif
 295
 296 #endif /* __libftdi_h__ */