libftdi: (tomj) applied FT2232 baudrate patch from Steven Turner (FTDI)
[libftdi] / ftdi / ftdi.c
index 807b0f7..37d4385 100644 (file)
 */
 int ftdi_init(struct ftdi_context *ftdi) {
     ftdi->usb_dev = NULL;
-    ftdi->usb_timeout = 5000;
+    ftdi->usb_read_timeout = 5000;
+    ftdi->usb_write_timeout = 5000;
 
+    ftdi->type = TYPE_BM;    /* chip type */
     ftdi->baudrate = -1;
     ftdi->bitbang_enabled = 0;
 
@@ -34,6 +36,12 @@ int ftdi_init(struct ftdi_context *ftdi) {
     ftdi->readbuffer_remaining = 0;
     ftdi->writebuffer_chunksize = 4096;
 
+    ftdi->interface = 0;
+    ftdi->index = 0;
+    ftdi->in_ep = 0x02;
+    ftdi->out_ep = 0x81;
+    ftdi->bitbang_mode = 1; /* 1: Normal bitbang mode, 2: SPI bitbang mode */
+
     ftdi->error_str = NULL;
 
     // all fine. Now allocate the readbuffer
@@ -85,8 +93,8 @@ int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product) {
             if (dev->descriptor.idVendor == vendor && dev->descriptor.idProduct == product) {
                 ftdi->usb_dev = usb_open(dev);
                 if (ftdi->usb_dev) {
-                    if (usb_claim_interface(ftdi->usb_dev, 0) != 0) {
-                        ftdi->error_str = "unable to claim usb device. You can still use it though...";
+                    if (usb_claim_interface(ftdi->usb_dev, ftdi->interface) != 0) {
+                        ftdi->error_str = "unable to claim usb device. Make sure ftdi_sio is unloaded!";
                         return -5;
                     }
 
@@ -112,11 +120,11 @@ int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product) {
 
 
 int ftdi_usb_reset(struct ftdi_context *ftdi) {
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 0, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "FTDI reset failed";
         return -1;
     }
-
+    // Invalidate data in the readbuffer
     ftdi->readbuffer_offset = 0;
     ftdi->readbuffer_remaining = 0;
 
@@ -124,19 +132,20 @@ int ftdi_usb_reset(struct ftdi_context *ftdi) {
 }
 
 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi) {
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 1, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 1, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "FTDI purge of RX buffer failed";
         return -1;
     }
-
+    // Invalidate data in the readbuffer
     ftdi->readbuffer_offset = 0;
     ftdi->readbuffer_remaining = 0;
 
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 2, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0, 2, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "FTDI purge of TX buffer failed";
         return -1;
     }
 
+
     return 0;
 }
 
@@ -148,7 +157,7 @@ int ftdi_usb_purge_buffers(struct ftdi_context *ftdi) {
 int ftdi_usb_close(struct ftdi_context *ftdi) {
     int rtn = 0;
 
-    if (usb_release_interface(ftdi->usb_dev, 0) != 0)
+    if (usb_release_interface(ftdi->usb_dev, ftdi->interface) != 0)
         rtn = -1;
 
     if (usb_close (ftdi->usb_dev) != 0)
@@ -159,64 +168,135 @@ int ftdi_usb_close(struct ftdi_context *ftdi) {
 
 
 /*
+    ftdi_convert_baudrate returns nearest supported baud rate to that requested.
+    Function is only used internally
+*/
+static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
+                                 unsigned short *value, unsigned short *index) {
+    static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
+    static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
+    static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
+    int divisor, best_divisor, best_baud, best_baud_diff;
+    unsigned long encoded_divisor;
+    int i;
+
+    if (baudrate <= 0) {
+        // Return error
+        return -1;
+    }
+
+    divisor = 24000000 / baudrate;
+
+    if (ftdi->type == TYPE_AM) {
+        // Round down to supported fraction (AM only)
+        divisor -= am_adjust_dn[divisor & 7];
+    }
+
+    // Try this divisor and the one above it (because division rounds down)
+    best_divisor = 0;
+    best_baud = 0;
+    best_baud_diff = 0;
+    for (i = 0; i < 2; i++) {
+        int try_divisor = divisor + i;
+        int baud_estimate;
+        int baud_diff;
+
+        // Round up to supported divisor value
+        if (try_divisor < 8) {
+            // Round up to minimum supported divisor
+            try_divisor = 8;
+        } else if (ftdi->type != TYPE_AM && try_divisor < 12) {
+            // BM doesn't support divisors 9 through 11 inclusive
+            try_divisor = 12;
+        } else if (divisor < 16) {
+            // AM doesn't support divisors 9 through 15 inclusive
+            try_divisor = 16;
+        } else {
+            if (ftdi->type == TYPE_AM) {
+                // Round up to supported fraction (AM only)
+                try_divisor += am_adjust_up[try_divisor & 7];
+                if (try_divisor > 0x1FFF8) {
+                    // Round down to maximum supported divisor value (for AM)
+                    try_divisor = 0x1FFF8;
+                }
+            } else {
+                if (try_divisor > 0x1FFFF) {
+                    // Round down to maximum supported divisor value (for BM)
+                    try_divisor = 0x1FFFF;
+                }
+            }
+        }
+        // Get estimated baud rate (to nearest integer)
+        baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
+        // Get absolute difference from requested baud rate
+        if (baud_estimate < baudrate) {
+            baud_diff = baudrate - baud_estimate;
+        } else {
+            baud_diff = baud_estimate - baudrate;
+        }
+        if (i == 0 || baud_diff < best_baud_diff) {
+            // Closest to requested baud rate so far
+            best_divisor = try_divisor;
+            best_baud = baud_estimate;
+            best_baud_diff = baud_diff;
+            if (baud_diff == 0) {
+                // Spot on! No point trying
+                break;
+            }
+        }
+    }
+    // Encode the best divisor value
+    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
+    } else if (encoded_divisor == 0x4001) {
+        encoded_divisor = 1;   // 2000000 baud (BM only)
+    }
+    // Split into "value" and "index" values
+    *value = (unsigned short)(encoded_divisor & 0xFFFF);
+    if(ftdi->type == TYPE_FT2232C) {
+        *index = (unsigned short)(encoded_divisor >> 8);
+        *index &= 0xFF00;
+        *index |= ftdi->interface;
+    }
+    else
+        *index = (unsigned short)(encoded_divisor >> 16);
+    
+    // Return the nearest baud rate
+    return best_baud;
+}
+
+/*
     ftdi_set_baudrate return codes:
      0: all fine
     -1: invalid baudrate
     -2: setting baudrate failed
 */
 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate) {
-    unsigned short ftdi_baudrate;
+    unsigned short value, index;
+    int actual_baudrate;
 
     if (ftdi->bitbang_enabled) {
         baudrate = baudrate*4;
     }
 
-    switch (baudrate) {
-    case 300:
-        ftdi_baudrate = 0x2710;
-        break;
-    case 600:
-        ftdi_baudrate = 0x1388;
-        break;
-    case 1200:
-        ftdi_baudrate = 0x09C4;
-        break;
-    case 2400:
-        ftdi_baudrate = 0x04E2;
-        break;
-    case 4800:
-        ftdi_baudrate = 0x0271;
-        break;
-    case 9600:
-        ftdi_baudrate = 0x4138;
-        break;
-    case 19200:
-        ftdi_baudrate = 0x809C;
-        break;
-    case 38400:
-        ftdi_baudrate = 0xC04E;
-        break;
-    case 57600:
-        ftdi_baudrate = 0x0034;
-        break;
-    case 115200:
-        ftdi_baudrate = 0x001A;
-        break;
-    case 230400:
-        ftdi_baudrate = 0x000D;
-        break;
-    case 460800:
-        ftdi_baudrate = 0x4006;
-        break;
-    case 921600:
-        ftdi_baudrate = 0x8003;
-        break;
-    default:
-        ftdi->error_str = "Unknown baudrate. Note: bitbang baudrates are automatically multiplied by 4";
+    actual_baudrate = convert_baudrate(baudrate, ftdi, &value, &index);
+    if (actual_baudrate <= 0) {
+        ftdi->error_str = "Silly baudrate <= 0.";
         return -1;
     }
 
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 3, ftdi_baudrate, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    // Check within tolerance (about 5%)
+    if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
+            || ((actual_baudrate < baudrate)
+                ? (actual_baudrate * 21 < baudrate * 20)
+                : (baudrate * 21 < actual_baudrate * 20))) {
+        ftdi->error_str = "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4";
+        return -1;
+    }
+
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 3, value, index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "Setting new baudrate failed";
         return -2;
     }
@@ -229,22 +309,24 @@ int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate) {
 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size) {
     int ret;
     int offset = 0;
+    int total_written = 0;
     while (offset < size) {
         int write_size = ftdi->writebuffer_chunksize;
 
         if (offset+write_size > size)
             write_size = size-offset;
 
-        ret=usb_bulk_write(ftdi->usb_dev, 2, buf+offset, write_size, ftdi->usb_timeout);
+        ret = usb_bulk_write(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, ftdi->usb_write_timeout);
         if (ret == -1) {
             ftdi->error_str = "bulk write failed";
             return -1;
         }
+        total_written += ret;
 
         offset += write_size;
     }
 
-    return 0;
+    return total_written;
 }
 
 
@@ -271,26 +353,23 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size) {
         ftdi->readbuffer_remaining -= size;
         ftdi->readbuffer_offset += size;
 
-        // printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining);
+        /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
 
         return size;
     }
-
     // something still in the readbuffer, but not enough to satisfy 'size'?
     if (ftdi->readbuffer_remaining != 0) {
         memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
 
-        // printf("Got bytes from buffer: %d\n", ftdi->readbuffer_remaining);
-
         // Fix offset
         offset += ftdi->readbuffer_remaining;
     }
-
     // do the actual USB read
     while (offset < size && ret > 0) {
         ftdi->readbuffer_remaining = 0;
         ftdi->readbuffer_offset = 0;
-        ret = usb_bulk_read (ftdi->usb_dev, 0x81, ftdi->readbuffer, ftdi->readbuffer_chunksize, ftdi->usb_timeout);
+        /* returns how much received */
+        ret = usb_bulk_read (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, ftdi->usb_read_timeout);
 
         if (ret == -1) {
             ftdi->error_str = "bulk read failed";
@@ -306,13 +385,14 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size) {
             // no more data to read?
             return offset;
         }
-
         if (ret > 0) {
             // data still fits in buf?
             if (offset+ret <= size) {
                 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, ret);
+                //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
                 offset += ret;
 
+                /* Did we read exactly the right amount of bytes? */
                 if (offset == size)
                     return offset;
             } else {
@@ -324,13 +404,13 @@ int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size) {
                 ftdi->readbuffer_remaining = ret-part_size;
                 offset += part_size;
 
-                // printf("Returning part: %d - size: %d - offset: %d - ret: %d - remaining: %d\n", part_size, size, offset, ret, ftdi->readbuffer_remaining);
+                /* printf("Returning part: %d - size: %d - offset: %d - ret: %d - remaining: %d\n",
+                part_size, size, offset, ret, ftdi->readbuffer_remaining); */
 
                 return offset;
             }
         }
     }
-
     // never reached
     return -2;
 }
@@ -365,19 +445,20 @@ int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask) {
     unsigned short usb_val;
 
     usb_val = bitmask; // low byte: bitmask
-    usb_val += 1 << 8; // high byte: enable flag
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, usb_val, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    /* FT2232C: Set bitbang_mode to 2 to enable SPI */
+    usb_val |= (ftdi->bitbang_mode << 8);
+
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "Unable to enter bitbang mode. Perhaps not a BM type chip?";
         return -1;
     }
-
     ftdi->bitbang_enabled = 1;
     return 0;
 }
 
 
 int ftdi_disable_bitbang(struct ftdi_context *ftdi) {
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, 0, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x0B, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "Unable to leave bitbang mode. Perhaps not a BM type chip?";
         return -1;
     }
@@ -389,7 +470,7 @@ int ftdi_disable_bitbang(struct ftdi_context *ftdi) {
 
 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins) {
     unsigned short usb_val;
-    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0C, 0, 0, (char *)&usb_val, 1, ftdi->usb_timeout) != 1) {
+    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0C, 0, ftdi->index, (char *)&usb_val, 1, ftdi->usb_read_timeout) != 1) {
         ftdi->error_str = "Read pins failed";
         return -1;
     }
@@ -408,7 +489,7 @@ int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency) {
     }
 
     usb_val = latency;
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x09, usb_val, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x09, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "Unable to set latency timer";
         return -2;
     }
@@ -418,7 +499,7 @@ int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency) {
 
 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency) {
     unsigned short usb_val;
-    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0A, 0, 0, (char *)&usb_val, 1, ftdi->usb_timeout) != 1) {
+    if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x0A, 0, ftdi->index, (char *)&usb_val, 1, ftdi->usb_read_timeout) != 1) {
         ftdi->error_str = "Reading latency timer failed";
         return -1;
     }
@@ -614,7 +695,7 @@ int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom) {
     int i;
 
     for (i = 0; i < 64; i++) {
-        if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x90, 0, i, eeprom+(i*2), 2, ftdi->usb_timeout) != 2) {
+        if (usb_control_msg(ftdi->usb_dev, 0xC0, 0x90, 0, i, eeprom+(i*2), 2, ftdi->usb_read_timeout) != 2) {
             ftdi->error_str = "Reading eeprom failed";
             return -1;
         }
@@ -631,7 +712,7 @@ int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom) {
     for (i = 0; i < 64; i++) {
         usb_val = eeprom[i*2];
         usb_val += eeprom[(i*2)+1] << 8;
-        if (usb_control_msg(ftdi->usb_dev, 0x40, 0x91, usb_val, i, NULL, 0, ftdi->usb_timeout) != 0) {
+        if (usb_control_msg(ftdi->usb_dev, 0x40, 0x91, usb_val, i, NULL, 0, ftdi->usb_write_timeout) != 0) {
             ftdi->error_str = "Unable to write eeprom";
             return -1;
         }
@@ -642,7 +723,7 @@ int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom) {
 
 
 int ftdi_erase_eeprom(struct ftdi_context *ftdi) {
-    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x92, 0, 0, NULL, 0, ftdi->usb_timeout) != 0) {
+    if (usb_control_msg(ftdi->usb_dev, 0x40, 0x92, 0, 0, NULL, 0, ftdi->usb_write_timeout) != 0) {
         ftdi->error_str = "Unable to erase eeprom";
         return -1;
     }