Small documentation update

[libftdi] / src / ftdi.h

diff --git a/src/ftdi.h b/src/ftdi.h
index 1040e2e..fd0d357 100644 (file)
--- a/src/ftdi.h
+++ b/src/ftdi.h
@@ -35,7 +35,9 @@ enum ftdi_mpsse_mode {
     BITMODE_MPSSE  = 0x02,
     BITMODE_SYNCBB = 0x04,
     BITMODE_MCU    = 0x08,
-    BITMODE_OPTO   = 0x10
+    // CPU-style fifo mode gets set via EEPROM
+    BITMODE_OPTO   = 0x10,
+    BITMODE_CBUS   = 0x20
 };
 
 /// Port interface for FT2232C
@@ -112,7 +114,7 @@ enum ftdi_interface {
 #define SIO_RTS_CTS_HS (0x1 << 8)
 
 /**
-    Main context structure for all libftdi functions.
+    \brief Main context structure for all libftdi functions.
 
     Do not access directly if possible.
 */
@@ -161,7 +163,7 @@ struct ftdi_context {
 };
 
 /**
-    Single linked list of usb devices created by ftdi_usb_find_all()
+    \brief list of usb devices created by ftdi_usb_find_all()
 */
 struct ftdi_device_list {
     /// pointer to next entry
@@ -171,7 +173,7 @@ struct ftdi_device_list {
 };
 
 /**
-    FTDI eeprom structure
+    \brief FTDI eeprom structure
 */
 struct ftdi_eeprom {
     /// vendor id
@@ -223,6 +225,10 @@ extern "C" {
     int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist,
                           int vendor, int product);
     void ftdi_list_free(struct ftdi_device_list **devlist);
+    int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct usb_device *dev,
+                             char * manufacturer, int mnf_len,
+                             char * description, int desc_len,
+                             char * serial, int serial_len);
 
     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,