documentation improvements, small fix setting bitbang_enabled on all bitbang modes
[libftdi] / src / ftdi.h
index 3bb8e7a..b518f96 100644 (file)
@@ -22,7 +22,7 @@
 #define FTDI_DEFAULT_EEPROM_SIZE 128
 
 /** FTDI chip type */
-enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
+enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 };
 /** Parity mode for ftdi_set_line_property() */
 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
 /** Number of stop bits for ftdi_set_line_property() */
@@ -33,22 +33,27 @@ enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
 
 /** MPSSE bitbang modes */
-enum ftdi_mpsse_mode {
-    BITMODE_RESET  = 0x00,
-    BITMODE_BITBANG= 0x01,
-    BITMODE_MPSSE  = 0x02,
-    BITMODE_SYNCBB = 0x04,
-    BITMODE_MCU    = 0x08,
-    /* CPU-style fifo mode gets set via EEPROM */
-    BITMODE_OPTO   = 0x10,
-    BITMODE_CBUS   = 0x20
+enum ftdi_mpsse_mode
+{
+    BITMODE_RESET  = 0x00,    /**< switch off bitbang mode, back to regular serial/FIFO */
+    BITMODE_BITBANG= 0x01,    /**< classical asynchronous bitbang mode, introduced with B-type chips */
+    BITMODE_MPSSE  = 0x02,    /**< MPSSE mode, available on 2232x chips */
+    BITMODE_SYNCBB = 0x04,    /**< synchronous bitbang mode, available on 2232x and R-type chips  */
+    BITMODE_MCU    = 0x08,    /**< MCU Host Bus Emulation mode, available on 2232x chips */
+                              /* CPU-style fifo mode gets set via EEPROM */
+    BITMODE_OPTO   = 0x10,    /**< Fast Opto-Isolated Serial Interface Mode, available on 2232x chips  */
+    BITMODE_CBUS   = 0x20,    /**< Bitbang on CBUS pins of R-type chips, configure in EEPROM before */
+    BITMODE_SYNCFF = 0x40,    /**< Single Channel Synchronous FIFO mode, available on 2232H chips */
 };
 
-/** Port interface for FT2232C */
-enum ftdi_interface {
+/** Port interface for chips with multiple interfaces */
+enum ftdi_interface
+{
     INTERFACE_ANY = 0,
     INTERFACE_A   = 1,
-    INTERFACE_B   = 2
+    INTERFACE_B   = 2,
+    INTERFACE_C   = 3,
+    INTERFACE_D   = 4
 };
 
 /* Shifting commands IN MPSSE Mode*/
@@ -77,7 +82,7 @@ enum ftdi_interface {
 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
 
 /* Commands in MPSSE and Host Emulation Mode */
-#define SEND_IMMEDIATE 0x87 
+#define SEND_IMMEDIATE 0x87
 #define WAIT_ON_HIGH   0x88
 #define WAIT_ON_LOW    0x89
 
@@ -125,7 +130,7 @@ enum ftdi_interface {
 #define SIO_RESET_PURGE_RX 1
 #define SIO_RESET_PURGE_TX 2
 
-#define SIO_DISABLE_FLOW_CTRL 0x0 
+#define SIO_DISABLE_FLOW_CTRL 0x0
 #define SIO_RTS_CTS_HS (0x1 << 8)
 #define SIO_DTR_DSR_HS (0x2 << 8)
 #define SIO_XON_XOFF_HS (0x4 << 8)
@@ -148,7 +153,8 @@ enum ftdi_interface {
 
     Do not access directly if possible.
 */
-struct ftdi_context {
+struct ftdi_context
+{
     /* USB specific */
     /** libusb's usb_dev_handle */
     struct usb_dev_handle *usb_dev;
@@ -174,6 +180,8 @@ struct ftdi_context {
     unsigned int readbuffer_chunksize;
     /** write buffer chunk size */
     unsigned int writebuffer_chunksize;
+    /** maximum packet size. Needed for filtering modem status bytes every n packets. */
+    unsigned int max_packet_size;
 
     /* FTDI FT2232C requirecments */
     /** FT2232C interface number: 0 or 1 */
@@ -203,7 +211,8 @@ struct ftdi_context {
 /**
     \brief list of usb devices created by ftdi_usb_find_all()
 */
-struct ftdi_device_list {
+struct ftdi_device_list
+{
     /** pointer to next entry */
     struct ftdi_device_list *next;
     /** pointer to libusb's usb_device */
@@ -213,7 +222,8 @@ struct ftdi_device_list {
 /**
     \brief FTDI eeprom structure
 */
-struct ftdi_eeprom {
+struct ftdi_eeprom
+{
     /** vendor id */
     int vendor_id;
     /** product id */
@@ -249,17 +259,18 @@ struct ftdi_eeprom {
     /** serial number */
     char *serial;
 
-  /** eeprom size in bytes. This doesn't get stored in the eeprom
-      but is the only way to pass it to ftdi_eeprom_build. */
-  int size;
+    /** eeprom size in bytes. This doesn't get stored in the eeprom
+        but is the only way to pass it to ftdi_eeprom_build. */
+    int size;
 };
 
 #ifdef __cplusplus
-extern "C" {
+extern "C"
+{
 #endif
 
     int ftdi_init(struct ftdi_context *ftdi);
-    struct ftdi_context *ftdi_new();
+    struct ftdi_context *ftdi_new(void);
     int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
 
     void ftdi_deinit(struct ftdi_context *ftdi);
@@ -278,7 +289,10 @@ extern "C" {
     int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
     int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
                            const char* description, const char* serial);
+    int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
+                           const char* description, const char* serial, unsigned int index);
     int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev);
+    int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description);
 
     int ftdi_usb_close(struct ftdi_context *ftdi);
     int ftdi_usb_reset(struct ftdi_context *ftdi);
@@ -290,8 +304,8 @@ extern "C" {
     int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
     int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
-                               enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
-                               enum ftdi_break_type break_type);
+                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
+                                enum ftdi_break_type break_type);
 
     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
     int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
@@ -328,8 +342,8 @@ extern "C" {
 
     /* init and build eeprom from ftdi_eeprom structure */
     void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
-    int  ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
-    void ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
+    int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
+    int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
 
     /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
        the checksum of the eeprom is valided */
@@ -339,6 +353,9 @@ extern "C" {
     int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
     int ftdi_erase_eeprom(struct ftdi_context *ftdi);
 
+    int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val);
+    int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val);
+
     char *ftdi_get_error_string(struct ftdi_context *ftdi);
 
 #ifdef __cplusplus