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