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 enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2 };
  23 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
  24 enum ftdi_stopbits_type { STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2 };
  25 enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
  26
  27 enum ftdi_mpsse_mode {
  28     BITMODE_RESET  = 0x00,
  29     BITMODE_BITBANG= 0x01,
  30     BITMODE_MPSSE  = 0x02,
  31     BITMODE_SYNCBB = 0x04,
  32     BITMODE_MCU    = 0x08,
  33     BITMODE_OPTO   = 0x10
  34 };
  35
  36 /* Port interface code for FT2232C */
  37 enum ftdi_interface {
  38     INTERFACE_ANY = 0,
  39     INTERFACE_A   = 1,
  40     INTERFACE_B   = 2
  41 };
  42
  43 /* Shifting commands IN MPSSE Mode*/
  44 #define MPSSE_WRITE_NEG 0x01   /* Write TDI/DO on negative TCK/SK edge*/
  45 #define MPSSE_BITMODE   0x02   /* Write bits, not bytes */
  46 #define MPSSE_READ_NEG  0x04   /* Sample TDO/DI on negative TCK/SK edge */
  47 #define MPSSE_LSB       0x08   /* LSB first */
  48 #define MPSSE_DO_WRITE  0x10   /* Write TDI/DO */
  49 #define MPSSE_DO_READ   0x20   /* Read TDO/DI */
  50 #define MPSSE_WRITE_TMS 0x40   /* Write TMS/CS */
  51
  52 /* FTDI MPSSE commands */
  53 #define SET_BITS_LOW   0x80
  54 /*BYTE DATA*/
  55 /*BYTE Direction*/
  56 #define SET_BITS_HIGH  0x82
  57 /*BYTE DATA*/
  58 /*BYTE Direction*/
  59 #define GET_BITS_LOW   0x81
  60 #define GET_BITS_HIGH  0x83
  61 #define LOOPBACK_START 0x84
  62 #define LOOPBACK_END   0x85
  63 #define TCK_DIVISOR    0x86
  64 /* Value Low */
  65 /* Value HIGH */ /*rate is 12000000/((1+value)*2) */
  66 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
  67
  68 /* Commands in MPSSE and Host Emulation Mode */
  69 #define SEND_IMMEDIATE 0x87
  70 #define WAIT_ON_HIGH   0x88
  71 #define WAIT_ON_LOW    0x89
  72
  73 /* Commands in Host Emulation Mode */
  74 #define READ_SHORT     0x90
  75 /* Address_Low */
  76 #define READ_EXTENDED  0x91
  77 /* Address High */
  78 /* Address Low  */
  79 #define WRITE_SHORT    0x92
  80 /* Address_Low */
  81 #define WRITE_EXTENDED 0x93
  82 /* Address High */
  83 /* Address Low  */
  84
  85 struct ftdi_context {
  86     // USB specific
  87     struct usb_dev_handle *usb_dev;
  88     int usb_read_timeout;
  89     int usb_write_timeout;
  90
  91     // FTDI specific
  92     enum ftdi_chip_type type;
  93     int baudrate;
  94     unsigned char bitbang_enabled;
  95     unsigned char *readbuffer;
  96     unsigned int readbuffer_offset;
  97     unsigned int readbuffer_remaining;
  98     unsigned int readbuffer_chunksize;
  99     unsigned int writebuffer_chunksize;
 100
 101     // FTDI FT2232C requirecments
 102     int interface;   // 0 or 1
 103     int index;       // 1 or 2
 104     // Endpoints
 105     int in_ep;
 106     int out_ep;      // 1 or 2
 107
 108     /* 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
 109     unsigned char bitbang_mode;
 110
 111     // misc
 112     char *error_str;
 113 };
 114
 115 struct ftdi_eeprom {
 116     int vendor_id;
 117     int product_id;
 118
 119     int self_powered;
 120     int remote_wakeup;
 121     int BM_type_chip;
 122
 123     int in_is_isochronous;
 124     int out_is_isochronous;
 125     int suspend_pull_downs;
 126
 127     int use_serial;
 128     int change_usb_version;
 129     int usb_version;
 130     int max_power;
 131
 132     char *manufacturer;
 133     char *product;
 134     char *serial;
 135 };
 136
 137 #ifdef __cplusplus
 138 extern "C" {
 139 #endif
 140
 141     int ftdi_init(struct ftdi_context *ftdi);
 142     int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
 143
 144     void ftdi_deinit(struct ftdi_context *ftdi);
 145     void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
 146     int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
 147     int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
 148                            const char* description, const char* serial);
 149     int ftdi_usb_close(struct ftdi_context *ftdi);
 150     int ftdi_usb_reset(struct ftdi_context *ftdi);
 151     int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
 152
 153     int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
 154     int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
 155                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
 156
 157     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
 158     int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
 159     int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 160
 161     int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
 162     int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
 163     int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
 164
 165     int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
 166     int ftdi_disable_bitbang(struct ftdi_context *ftdi);
 167     int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode);
 168     int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
 169
 170     int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
 171     int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
 172
 173     // init and build eeprom from ftdi_eeprom structure
 174     void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
 175     int  ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
 176
 177     // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
 178     // the checksum of the eeprom is valided
 179     int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
 180     int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
 181     int ftdi_erase_eeprom(struct ftdi_context *ftdi);
 182
 183     char *ftdi_get_error_string(struct ftdi_context *ftdi);
 184
 185 #ifdef __cplusplus
 186 }
 187 #endif
 188
 189 #endif /* __libftdi_h__ */