more documentation. Let's find out how we can group things with doxygen
[libftdi] / src / ftdi.c
index ae8dde8..0b8b269 100644 (file)
 
 #include <usb.h>
 #include <string.h>
-#include <sys/utsname.h>
+#include <errno.h>
 
 #include "ftdi.h"
 
-#define ftdi_error_return(code, str) {  \
-       ftdi->error_str = str;          \
-        return code;                    \
-   }                  
+#define ftdi_error_return(code, str) do {  \
+        ftdi->error_str = str;             \
+        return code;                       \
+   } while(0);
 
 
-/* ftdi_init return codes:
-   0: all fine
-  -1: couldn't allocate read buffer
+/**
+    Initializes a ftdi_context.
+
+    \param ftdi pointer to ftdi_context
+
+    \retval  0: all fine
+    \retval -1: couldn't allocate read buffer
+
+    \remark This should be called before all functions
 */
 int ftdi_init(struct ftdi_context *ftdi)
 {
@@ -57,7 +63,39 @@ int ftdi_init(struct ftdi_context *ftdi)
     return ftdi_read_data_set_chunksize(ftdi, 4096);
 }
 
+/**
+    Open selected channels on a chip, otherwise use first channel.
+
+    \param ftdi pointer to ftdi_context
+    \param interface Interface to use for FT2232C chips.
+
+    \retval  0: all fine
+    \retval -1: unknown interface
+*/
+int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
+{
+    switch (interface) {
+    case INTERFACE_ANY:
+    case INTERFACE_A:
+        /* ftdi_usb_open_desc cares to set the right index, depending on the found chip */
+        break;
+    case INTERFACE_B:
+        ftdi->interface = 1;
+        ftdi->index     = INTERFACE_B;
+        ftdi->in_ep     = 0x04;
+        ftdi->out_ep    = 0x83;
+        break;
+    default:
+        ftdi_error_return(-1, "Unknown interface");
+    }
+    return 0;
+}
+
+/**
+    Deinitializes a ftdi_context.
 
+    \param ftdi pointer to ftdi_context
+*/
 void ftdi_deinit(struct ftdi_context *ftdi)
 {
     if (ftdi->readbuffer != NULL) {
@@ -66,31 +104,179 @@ void ftdi_deinit(struct ftdi_context *ftdi)
     }
 }
 
+/**
+    Use an already open libusb device.
 
+    \param ftdi pointer to ftdi_context
+    \param usb libusb usb_dev_handle to use
+*/
 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usb)
 {
     ftdi->usb_dev = usb;
 }
 
 
-/* ftdi_usb_open return codes:
-   0: all fine
-  -1: usb_find_busses() failed
-  -2: usb_find_devices() failed
-  -3: usb device not found
-  -4: unable to open device
-  -5: unable to claim device
-  -6: reset failed
-  -7: set baudrate failed
-  -8: get product description failed
-  -9: get serial number failed
-  -10: unable to close device
+/**
+    Finds all ftdi devices on the usb bus. Creates a new ftdi_device_list which
+    needs to be deallocated by ftdi_list_free() after use.
+
+    \param ftdi pointer to ftdi_context
+    \param devlist Pointer where to store list of found devices
+    \param vendor Vendor ID to search for
+    \param product Product ID to search for
+
+    \retval >0: number of devices found
+    \retval -1: usb_find_busses() failed
+    \retval -2: usb_find_devices() failed
+    \retval -3: out of memory
+*/
+int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
+{
+    struct ftdi_device_list **curdev;
+    struct usb_bus *bus;
+    struct usb_device *dev;
+    int count = 0;
+
+    usb_init();
+    if (usb_find_busses() < 0)
+        ftdi_error_return(-1, "usb_find_busses() failed");
+    if (usb_find_devices() < 0)
+        ftdi_error_return(-2, "usb_find_devices() failed");
+
+    curdev = devlist;
+    for (bus = usb_busses; bus; bus = bus->next) {
+        for (dev = bus->devices; dev; dev = dev->next) {
+            if (dev->descriptor.idVendor == vendor
+                    && dev->descriptor.idProduct == product)
+            {
+                *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
+                if (!*curdev)
+                    ftdi_error_return(-3, "out of memory");
+
+                (*curdev)->next = NULL;
+                (*curdev)->dev = dev;
+
+                curdev = &(*curdev)->next;
+                count++;
+            }
+        }
+    }
+
+    return count;
+}
+
+/**
+    Frees a usb device list.
+
+    \param devlist USB device list created by ftdi_usb_find_all()
+*/
+void ftdi_list_free(struct ftdi_device_list **devlist)
+{
+    struct ftdi_device_list **curdev;
+    for (; *devlist == NULL; devlist = curdev) {
+        curdev = &(*devlist)->next;
+        free(*devlist);
+    }
+
+    devlist = NULL;
+}
+
+/**
+    Opens a ftdi device given by a usb_device.
+
+    \param ftdi pointer to ftdi_context
+    \param dev libusb usb_dev to use
+
+    \retval  0: all fine
+    \retval -4: unable to open device
+    \retval -5: unable to claim device
+    \retval -6: reset failed
+    \retval -7: set baudrate failed
+*/
+int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev)
+{
+    int detach_errno = 0;
+    if (!(ftdi->usb_dev = usb_open(dev)))
+        ftdi_error_return(-4, "usb_open() failed");
+
+#ifdef LIBUSB_HAS_GET_DRIVER_NP
+    // Try to detach ftdi_sio kernel module
+    // Returns ENODATA if driver is not loaded
+    if (usb_detach_kernel_driver_np(ftdi->usb_dev, ftdi->interface) != 0 && errno != ENODATA)
+        detach_errno = errno;
+#endif
+
+    if (usb_claim_interface(ftdi->usb_dev, ftdi->interface) != 0) {
+        usb_close (ftdi->usb_dev);
+        if (detach_errno == EPERM) {
+            ftdi_error_return(-8, "inappropriate permissions on device!");
+        } else {
+            ftdi_error_return(-5, "unable to claim usb device. Make sure ftdi_sio is unloaded!");
+        }
+    }
+
+    if (ftdi_usb_reset (ftdi) != 0) {
+        usb_close (ftdi->usb_dev);
+        ftdi_error_return(-6, "ftdi_usb_reset failed");
+    }
+
+    if (ftdi_set_baudrate (ftdi, 9600) != 0) {
+        usb_close (ftdi->usb_dev);
+        ftdi_error_return(-7, "set baudrate failed");
+    }
+
+    // Try to guess chip type
+    // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
+    if (dev->descriptor.bcdDevice == 0x400 || (dev->descriptor.bcdDevice == 0x200
+            && dev->descriptor.iSerialNumber == 0))
+        ftdi->type = TYPE_BM;
+    else if (dev->descriptor.bcdDevice == 0x200)
+        ftdi->type = TYPE_AM;
+    else if (dev->descriptor.bcdDevice == 0x500) {
+        ftdi->type = TYPE_2232C;
+        if (!ftdi->index)
+            ftdi->index = INTERFACE_A;
+    }
+
+    ftdi_error_return(0, "all fine");
+}
+
+/**
+    Opens the first device with a given vendor and product ids.
+
+    \param ftdi pointer to ftdi_context
+    \param vendor Vendor ID
+    \param product Product ID
+
+    \retval same as ftdi_usb_open_desc()
 */
 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
 {
     return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
 }
 
+/**
+    Opens the first device with a given, vendor id, product id,
+    description and serial.
+
+    \param ftdi pointer to ftdi_context
+    \param vendor Vendor ID
+    \param product Product ID
+    \param description Description to search for. Use NULL if not needed.
+    \param serial Serial to search for. Use NULL if not needed.
+
+    \retval  0: all fine
+    \retval -1: usb_find_busses() failed
+    \retval -2: usb_find_devices() failed
+    \retval -3: usb device not found
+    \retval -4: unable to open device
+    \retval -5: unable to claim device
+    \retval -6: reset failed
+    \retval -7: set baudrate failed
+    \retval -8: get product description failed
+    \retval -9: get serial number failed
+    \retval -10: unable to close device
+*/
 int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
                        const char* description, const char* serial)
 {
@@ -102,9 +288,8 @@ int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
 
     if (usb_find_busses() < 0)
         ftdi_error_return(-1, "usb_find_busses() failed");
-
     if (usb_find_devices() < 0)
-        ftdi_error_return(-2,"usb_find_devices() failed");
+        ftdi_error_return(-2, "usb_find_devices() failed");
 
     for (bus = usb_busses; bus; bus = bus->next) {
         for (dev = bus->devices; dev; dev = dev->next) {
@@ -119,8 +304,8 @@ int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
                         ftdi_error_return(-8, "unable to fetch product description");
                     }
                     if (strncmp(string, description, sizeof(string)) != 0) {
-                        if (usb_close (ftdi->usb_dev) < 0)
-                            ftdi_error_return(-10, "product description not matching");
+                        if (usb_close (ftdi->usb_dev) != 0)
+                            ftdi_error_return(-10, "unable to close device");
                         continue;
                     }
                 }
@@ -130,39 +315,16 @@ int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
                         ftdi_error_return(-9, "unable to fetch serial number");
                     }
                     if (strncmp(string, serial, sizeof(string)) != 0) {
-                        ftdi->error_str = "serial number not matching\n";
                         if (usb_close (ftdi->usb_dev) != 0)
-                            ftdi_error_return(-10, "unable to fetch serial number");
+                            ftdi_error_return(-10, "unable to close device");
                         continue;
                     }
                 }
 
-                if (usb_claim_interface(ftdi->usb_dev, ftdi->interface) != 0) {
-                    usb_close (ftdi->usb_dev);
-                    ftdi_error_return(-5, "unable to claim usb device. Make sure ftdi_sio is unloaded!");
-                }
-
-                if (ftdi_usb_reset (ftdi) != 0) {
-                    usb_close (ftdi->usb_dev);
-                    ftdi_error_return(-6, "ftdi_usb_reset failed");
-                }
-
-                if (ftdi_set_baudrate (ftdi, 9600) != 0) {
-                    usb_close (ftdi->usb_dev);
-                    ftdi_error_return(-7, "set baudrate failed");
-                }
+                if (usb_close (ftdi->usb_dev) != 0)
+                    ftdi_error_return(-10, "unable to close device");
 
-                // Try to guess chip type
-                // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
-                if (dev->descriptor.bcdDevice == 0x400 || (dev->descriptor.bcdDevice == 0x200
-                        && dev->descriptor.iSerialNumber == 0))
-                    ftdi->type = TYPE_BM;
-                else if (dev->descriptor.bcdDevice == 0x200)
-                    ftdi->type = TYPE_AM;
-                else if (dev->descriptor.bcdDevice == 0x500)
-                    ftdi->type = TYPE_2232C;
-
-                ftdi_error_return(0, "all fine");
+                return ftdi_usb_open_dev(ftdi, dev);
             }
         }
     }
@@ -171,27 +333,19 @@ int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
     ftdi_error_return(-3, "device not found");
 }
 
+/**
+    Resets the ftdi device.
+
+    \param ftdi pointer to ftdi_context
 
+    \retval  0: all fine
+    \retval -1: FTDI reset failed
+*/
 int ftdi_usb_reset(struct ftdi_context *ftdi)
 {
-#if defined(__linux__)
-    struct utsname kernelver;
-    int k_major, k_minor, k_myver;
-#endif
-
     if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0)
         ftdi_error_return(-1,"FTDI reset failed");
 
-#if defined(__linux__)
-    /* Kernel 2.6 (maybe higher versions, too) need an additional usb_reset */
-    if (uname(&kernelver) == 0 && sscanf(kernelver.release, "%d.%d", &k_major, &k_minor) == 2) {
-        k_myver = k_major*10 + k_minor;
-
-        if (k_myver >= 26 && usb_reset(ftdi->usb_dev) != 0)
-            ftdi_error_return(-2, "USB reset failed");
-    }
-#endif
-
     // Invalidate data in the readbuffer
     ftdi->readbuffer_offset = 0;
     ftdi->readbuffer_remaining = 0;
@@ -199,6 +353,15 @@ int ftdi_usb_reset(struct ftdi_context *ftdi)
     return 0;
 }
 
+/**
+    Clears the buffers on the chip.
+
+    \param ftdi pointer to ftdi_context
+
+    \retval  0: all fine
+    \retval -1: write buffer purge failed
+    \retval -2: read buffer purge failed
+*/
 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
 {
     if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 1, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0)
@@ -214,10 +377,14 @@ int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
     return 0;
 }
 
-/* ftdi_usb_close return codes
-    0: all fine
-   -1: usb_release failed
-   -2: usb_close failed
+/**
+    Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
+
+    \param ftdi pointer to ftdi_context
+
+    \retval  0: all fine
+    \retval -1: usb_release failed
+    \retval -2: usb_close failed
 */
 int ftdi_usb_close(struct ftdi_context *ftdi)
 {
@@ -232,7 +399,6 @@ int ftdi_usb_close(struct ftdi_context *ftdi)
     return rtn;
 }
 
-
 /*
     ftdi_convert_baudrate returns nearest supported baud rate to that requested.
     Function is only used internally
@@ -269,7 +435,7 @@ static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
         int baud_diff;
 
         // Round up to supported divisor value
-        if (try_divisor < 8) {
+        if (try_divisor <= 8) {
             // Round up to minimum supported divisor
             try_divisor = 8;
         } else if (ftdi->type != TYPE_AM && try_divisor < 12) {
@@ -316,16 +482,16 @@ static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
     encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
     // Deal with special cases for encoded value
     if (encoded_divisor == 1) {
-        encoded_divisor = 0;   // 3000000 baud
+        encoded_divisor = 0;    // 3000000 baud
     } else if (encoded_divisor == 0x4001) {
-        encoded_divisor = 1;   // 2000000 baud (BM only)
+        encoded_divisor = 1;    // 2000000 baud (BM only)
     }
     // Split into "value" and "index" values
     *value = (unsigned short)(encoded_divisor & 0xFFFF);
     if(ftdi->type == TYPE_2232C) {
         *index = (unsigned short)(encoded_divisor >> 8);
         *index &= 0xFF00;
-        *index |= ftdi->interface;
+        *index |= ftdi->index;
     }
     else
         *index = (unsigned short)(encoded_divisor >> 16);
@@ -334,11 +500,15 @@ static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
     return best_baud;
 }
 
-/*
-    ftdi_set_baudrate return codes:
-     0: all fine
-    -1: invalid baudrate
-    -2: setting baudrate failed
+/**
+    Sets the chip baud rate
+
+    \param ftdi pointer to ftdi_context
+    \param baudrate baud rate to set
+
+    \retval  0: all fine
+    \retval -1: invalid baudrate
+    \retval -2: setting baudrate failed
 */
 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
 {
@@ -367,7 +537,68 @@ int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
     return 0;
 }
 
+/**
+    Set (RS232) line characteristics by Alain Abbas
+
+    \param ftdi pointer to ftdi_context
+    \param bits Number of bits
+    \param sbit Number of stop bits
+    \param parity Parity mode
+
+    \retval  0: all fine
+    \retval -1: Setting line property failed
+*/
+int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
+                           enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
+{
+    unsigned short value = bits;
+
+    switch(parity) {
+    case NONE:
+        value |= (0x00 << 8);
+        break;
+    case ODD:
+        value |= (0x01 << 8);
+        break;
+    case EVEN:
+        value |= (0x02 << 8);
+        break;
+    case MARK:
+        value |= (0x03 << 8);
+        break;
+    case SPACE:
+        value |= (0x04 << 8);
+        break;
+    }
 
+    switch(sbit) {
+    case STOP_BIT_1:
+        value |= (0x00 << 11);
+        break;
+    case STOP_BIT_15:
+        value |= (0x01 << 11);
+        break;
+    case STOP_BIT_2:
+        value |= (0x02 << 11);
+        break;
+    }
+
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x04, value, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0)
+        ftdi_error_return (-1, "Setting new line property failed");
+
+    return 0;
+}
+
+/**
+    Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
+
+    \param ftdi pointer to ftdi_context
+    \param buf Buffer with the data
+    \param size Size of the buffer
+
+    \retval <0: error code from usb_bulk_write()
+    \retval >0: number of bytes written
+*/
 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
 {
     int ret;
@@ -391,21 +622,50 @@ int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
     return total_written;
 }
 
+/**
+    Configure write buffer chunk size.
+    Default is 4096.
 
+    \param ftdi pointer to ftdi_context
+    \param chunksize Chunk size
+
+    \retval 0: all fine
+*/
 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
 {
     ftdi->writebuffer_chunksize = chunksize;
     return 0;
 }
 
+/**
+    Get write buffer chunk size.
+
+    \param ftdi pointer to ftdi_context
+    \param chunksize Pointer to store chunk size in
 
+    \retval 0: all fine
+*/
 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
 {
     *chunksize = ftdi->writebuffer_chunksize;
     return 0;
 }
 
+/**
+    Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
+
+    Automatically strips the two modem status bytes transfered during every read.
+
+    \param ftdi pointer to ftdi_context
+    \param buf Buffer to store data in
+    \param size Size of the buffer
 
+    \retval <0: error code from usb_bulk_read()
+    \retval >0: number of bytes read
+
+    \remark This function is not useful in bitbang mode.
+            Use ftdi_read_pins() to get the current state of the pins.
+*/
 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
 {
     int offset = 0, ret = 1, i, num_of_chunks, chunk_remains;
@@ -448,7 +708,7 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
             ftdi->readbuffer_offset += 2;
             ret -= 2;
 
-            if (ret > 64) {
+            if (ret > 62) {
                 for (i = 1; i < num_of_chunks; i++)
                     memmove (ftdi->readbuffer+ftdi->readbuffer_offset+62*i,
                              ftdi->readbuffer+ftdi->readbuffer_offset+64*i,
@@ -474,6 +734,8 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
 
                 /* Did we read exactly the right amount of bytes? */
                 if (offset == size)
+                    //printf("read_data exact rem %d offset %d\n",
+                    //ftdi->readbuffer_remaining, offset);
                     return offset;
             } else {
                 // only copy part of the data or size <= readbuffer_chunksize
@@ -495,7 +757,17 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
     return -127;
 }
 
+/**
+    Configure read buffer chunk size.
+    Default is 4096.
+
+    Automatically reallocates the buffer.
 
+    \param ftdi pointer to ftdi_context
+    \param chunksize Chunk size
+
+    \retval 0: all fine
+*/
 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
 {
     unsigned char *new_buf;
@@ -513,7 +785,14 @@ int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksi
     return 0;
 }
 
+/**
+    Get read buffer chunk size.
+
+    \param ftdi pointer to ftdi_context
+    \param chunksize Pointer to store chunk size in
 
+    \retval 0: all fine
+*/
 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
 {
     *chunksize = ftdi->readbuffer_chunksize;
@@ -521,7 +800,18 @@ int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunks
 }
 
 
+/**
+    Enable bitbang mode.
+
+    For advanced bitbang modes of the FT2232C chip use ftdi_set_bitmode().
 
+    \param ftdi pointer to ftdi_context
+    \param bitmask Bitmask to configure lines.
+           HIGH/ON value configures a line as output.
+
+    \retval  0: all fine
+    \retval -1: can't enable bitbang mode
+*/
 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
 {
     unsigned short usb_val;
@@ -537,7 +827,14 @@ int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask)
     return 0;
 }
 
+/**
+    Disable bitbang mode.
+
+    \param ftdi pointer to ftdi_context
 
+    \retval  0: all fine
+    \retval -1: can't disable bitbang mode
+*/
 int ftdi_disable_bitbang(struct ftdi_context *ftdi)
 {
     if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0)
@@ -547,18 +844,62 @@ int ftdi_disable_bitbang(struct ftdi_context *ftdi)
     return 0;
 }
 
+/**
+    Enable advanced bitbang mode for FT2232C chips.
 
-int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
+    \param ftdi pointer to ftdi_context
+    \param bitmask Bitmask to configure lines.
+           HIGH/ON value configures a line as output.
+    \param mode Bitbang mode: 1 for normal mode, 2 for SPI mode
+
+    \retval  0: all fine
+    \retval -1: can't enable bitbang mode
+*/
+int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
 {
     unsigned short usb_val;
-    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0C, 0, ftdi->index, (char *)&usb_val, 1, ftdi->usb_read_timeout) != 1)
+
+    usb_val = bitmask; // low byte: bitmask
+    usb_val |= (mode << 8);
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0)
+        ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?");
+
+    ftdi->bitbang_mode = mode;
+    ftdi->bitbang_enabled = (mode == BITMODE_BITBANG || mode == BITMODE_SYNCBB)?1:0;
+    return 0;
+}
+
+/**
+    Directly read pin state. Useful for bitbang mode.
+
+    \param ftdi pointer to ftdi_context
+    \param pins Pointer to store pins into
+
+    \retval  0: all fine
+    \retval -1: read pins failed
+*/
+int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
+{
+    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0C, 0, ftdi->index, (char *)pins, 1, ftdi->usb_read_timeout) != 1)
         ftdi_error_return(-1, "read pins failed");
 
-    *pins = (unsigned char)usb_val;
     return 0;
 }
 
+/**
+    Set latency timer
+
+    The FTDI chip keeps data in the internal buffer for a specific
+    amount of time if the buffer is not full yet to decrease
+    load on the usb bus.
+
+    \param ftdi pointer to ftdi_context
+    \param latency Value between 1 and 255
 
+    \retval  0: all fine
+    \retval -1: latency out of range
+    \retval -2: unable to set latency timer
+*/
 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
 {
     unsigned short usb_val;
@@ -573,7 +914,15 @@ int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
     return 0;
 }
 
+/**
+    Get latency timer
+
+    \param ftdi pointer to ftdi_context
+    \param latency Pointer to store latency value in
 
+    \retval  0: all fine
+    \retval -1: unable to get latency timer
+*/
 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
 {
     unsigned short usb_val;
@@ -584,7 +933,11 @@ int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
     return 0;
 }
 
+/**
+    Init eeprom with default values.
 
+    \param eeprom Pointer to ftdi_eeprom
+*/
 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom)
 {
     eeprom->vendor_id = 0x0403;
@@ -608,11 +961,15 @@ void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom)
     eeprom->serial = NULL;
 }
 
+/**
+   Build binary output from ftdi_eeprom structure.
+   Output is suitable for ftdi_write_eeprom().
 
-/*
-    ftdi_eeprom_build return codes:
-    positive value: used eeprom size
-    -1: eeprom size (128 bytes) exceeded by custom strings
+   \param eeprom Pointer to ftdi_eeprom
+   \param output Buffer of 128 bytes to store eeprom image to
+
+   \retval >0: used eeprom size
+   \retval -1: eeprom size (128 bytes) exceeded by custom strings
 */
 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output)
 {
@@ -768,7 +1125,15 @@ int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output)
     return size_check;
 }
 
+/**
+    Read eeprom
+
+    \param ftdi pointer to ftdi_context
+    \param eeprom Pointer to store eeprom into
 
+    \retval  0: all fine
+    \retval -1: read failed
+*/
 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
 {
     int i;
@@ -781,7 +1146,15 @@ int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
     return 0;
 }
 
+/**
+    Write eeprom
 
+    \param ftdi pointer to ftdi_context
+    \param eeprom Pointer to read eeprom from
+
+    \retval  0: all fine
+    \retval -1: read failed
+*/
 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
 {
     unsigned short usb_val;
@@ -797,7 +1170,14 @@ int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
     return 0;
 }
 
+/**
+    Erase eeprom
+
+    \param ftdi pointer to ftdi_context
 
+    \retval  0: all fine
+    \retval -1: erase failed
+*/
 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
 {
     if (usb_control_msg(ftdi->usb_dev, 0x40, 0x92, 0, 0, NULL, 0, ftdi->usb_write_timeout) != 0)
@@ -806,8 +1186,90 @@ int ftdi_erase_eeprom(struct ftdi_context *ftdi)
     return 0;
 }
 
+/**
+    Get string representation for last error code
+
+    \param ftdi pointer to ftdi_context
 
+    \retval Pointer to error string
+*/
 char *ftdi_get_error_string (struct ftdi_context *ftdi)
 {
     return ftdi->error_str;
 }
+
+/*
+    Flow control code by Lorenz Moesenlechner (lorenz@hcilab.org)
+    and Matthias Kranz  (matthias@hcilab.org)
+*/
+/**
+    Set flowcontrol for ftdi chip
+
+    \param ftdi pointer to ftdi_context
+    \param flowctrl flow control to use. should be 
+           SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS   
+
+    \retval  0: all fine
+    \retval -1: set flow control failed
+*/
+int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
+{
+    if (usb_control_msg(ftdi->usb_dev, SIO_SET_FLOW_CTRL_REQUEST_TYPE,
+                        SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->interface),
+                        NULL, 0, ftdi->usb_write_timeout) != 0)
+        ftdi_error_return(-1, "set flow control failed");
+
+    return 0;
+}
+
+/**
+    Set dtr line
+
+    \param ftdi pointer to ftdi_context
+    \param state state to set line to (1 or 0)
+
+    \retval  0: all fine
+    \retval -1: set dtr failed
+*/
+int ftdi_setdtr(struct ftdi_context *ftdi, int state)
+{
+    unsigned short usb_val;
+
+    if (state)
+        usb_val = SIO_SET_DTR_HIGH;
+    else
+        usb_val = SIO_SET_DTR_LOW;
+
+    if (usb_control_msg(ftdi->usb_dev, SIO_SET_MODEM_CTRL_REQUEST_TYPE,
+                        SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->interface,
+                        NULL, 0, ftdi->usb_write_timeout) != 0)
+        ftdi_error_return(-1, "set dtr failed");
+
+    return 0;
+}
+
+/**
+    Set rts line
+
+    \param ftdi pointer to ftdi_context
+    \param state state to set line to (1 or 0)
+
+    \retval  0: all fine
+    \retval -1 set rts failed
+*/
+int ftdi_setrts(struct ftdi_context *ftdi, int state)
+{
+    unsigned short usb_val;
+
+    if (state)
+        usb_val = SIO_SET_RTS_HIGH;
+    else
+        usb_val = SIO_SET_RTS_LOW;
+
+    if (usb_control_msg(ftdi->usb_dev, SIO_SET_MODEM_CTRL_REQUEST_TYPE,
+                        SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->interface,
+                        NULL, 0, ftdi->usb_write_timeout) != 0)
+        ftdi_error_return(-1, "set of rts failed");
+
+    return 0;
+}