ftdi_eeprom_build needs to know EEPROM chip type
[libftdi] / src / ftdi.c
index 5b3a24e..65a626f 100644 (file)
@@ -2186,34 +2186,37 @@ void ftdi_eeprom_initdefaults(struct ftdi_context *ftdi)
         return;
 
     eeprom = ftdi->eeprom;
+    memset(eeprom, 0, sizeof(struct ftdi_eeprom));
 
     eeprom->vendor_id = 0x0403;
-    eeprom->product_id = 0x6001;
-
-    eeprom->self_powered = 1;
-    eeprom->remote_wakeup = 1;
-    eeprom->release = 0;
-
-    eeprom->in_is_isochronous = 0;
-    eeprom->out_is_isochronous = 0;
-    eeprom->suspend_pull_downs = 0;
-
-    eeprom->use_serial = 0;
-    eeprom->change_usb_version = 0;
+    eeprom->use_serial = USE_SERIAL_NUM;
+    if((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
+       (ftdi->type == TYPE_R))
+        eeprom->product_id = 0x6001;
+    else
+        eeprom->product_id = 0x6010;
+    switch (ftdi->type)
+    {
+    case TYPE_2232C:
+        eeprom->release = 0x500;
+        break;
+    case TYPE_2232H:
+        eeprom->release = 0x200;
+        break;
+    default:
+        eeprom->release = 0;
+    }
     eeprom->usb_version = 0x0200;
-    eeprom->max_power = 0;
+    eeprom->max_power = 100;
 
     eeprom->manufacturer = NULL;
     eeprom->product = NULL;
     eeprom->serial = NULL;
-    for (i=0; i < 5; i++)
-    {
-        eeprom->cbus_function[i] = 0;
-    }
-    eeprom->high_current = 0;
-    eeprom->invert = 0;
 
-    eeprom->size = FTDI_MAX_EEPROM_SIZE;
+    if(ftdi->type == TYPE_R)
+        eeprom->size = 0x80;
+    else
+        eeprom->size = -1;
 }
 
 /**
@@ -2258,6 +2261,7 @@ void ftdi_eeprom_free(struct ftdi_context *ftdi)
     \retval -3: Invalid cbus function setting
     \retval -4: Chip doesn't support invert
     \retval -5: Chip doesn't support high current drive
+    \retval -6: No connected EEPROM or EEPROM Type unknown
 */
 int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output)
 {
@@ -2275,6 +2279,9 @@ int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output)
 
     eeprom= ftdi->eeprom;
 
+    if(eeprom->chip == -1)
+        ftdi_error_return(-5,"No connected EEPROM or EEPROM Type unknown");
+
     if (eeprom->manufacturer != NULL)
         manufacturer_size = strlen(eeprom->manufacturer);
     if (eeprom->product != NULL)
@@ -2291,21 +2298,31 @@ int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output)
     if (ftdi->type != TYPE_R)
     {
         if (eeprom->invert) return -4;
-        if (eeprom->high_current) return -5;
+        if (eeprom->high_current_a) return -5;
     }
 
-    size_check = eeprom->size;
-    size_check -= 28; // 28 are always in use (fixed)
+    size_check = 0x80;
+    switch(ftdi->type)
+    {
+    case TYPE_2232H:
+    case TYPE_4232H:
+        size_check -= 4;
+    case TYPE_R:
+        size_check -= 4;
+    case TYPE_2232C:
+        size_check -= 4;
+    case TYPE_AM:
+    case TYPE_BM:
+        size_check -= 0x14*2;
+    }
 
-    // Top half of a 256byte eeprom is used just for strings and checksum
-    // it seems that the FTDI chip will not read these strings from the lower half
-    // Each string starts with two bytes; offset and type (0x03 for string)
-    // the checksum needs two bytes, so without the string data that 8 bytes from the top half
-    if (eeprom->size>=256) size_check = 120;
     size_check -= manufacturer_size*2;
     size_check -= product_size*2;
     size_check -= serial_size*2;
 
+    /* Space for the string type and pointer bytes */
+    size_check -= -6;
+
     // eeprom size exceeded?
     if (size_check < 0)
         return (-1);
@@ -2314,7 +2331,7 @@ int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output)
     memset (output, 0, eeprom->size);
 
     // Addr 00: High current IO
-    output[0x00] = eeprom->high_current ? HIGH_CURRENT_DRIVE : 0;
+    output[0x00] = eeprom->high_current_a ? HIGH_CURRENT_DRIVE : 0;
     // Addr 01: IN endpoint size (for R type devices, different for FT2232)
     if (ftdi->type == TYPE_R) {
         output[0x01] = 0x40;
@@ -2499,13 +2516,27 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
     if (ftdi == NULL)
         ftdi_error_return(-1,"No context");
     if (ftdi->eeprom == NULL)
-        ftdi_error_return(-1,"No eeprom");
+        ftdi_error_return(-1,"No eeprom structure");
  
     eeprom_size = ftdi->eeprom->size;
     if(ftdi->type == TYPE_R)
         eeprom_size = 0x80;
     eeprom = ftdi->eeprom;
 
+    // Addr 00: Channel A setting
+
+    eeprom->channel_a_type   = buf[0x00] & 0x7;
+    eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
+    eeprom->high_current_a   = buf[0x00] & HIGH_CURRENT_DRIVE;
+
+    // Addr 01: Channel B setting
+
+    eeprom->channel_b_type   = buf[0x01] & 0x7;
+    eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
+    eeprom->high_current_b   = buf[0x01] & HIGH_CURRENT_DRIVE;
+
+    eeprom->suspend_dbus7    = buf[0x01] & SUSPEND_DBUS7;
+
     // Addr 02: Vendor ID
     eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
 
@@ -2530,6 +2561,7 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
     // Bit 6: 0 - reserved
     // Bit 5: 0 - reserved
     // Bit 4: 1 - Change USB version
+    //            Not seen on FT2232(D)
     // Bit 3: 1 - Use the serial number string
     // Bit 2: 1 - Enable suspend pull downs for lower power
     // Bit 1: 1 - Out EndPoint is Isochronous
@@ -2538,15 +2570,13 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
     eeprom->in_is_isochronous  = buf[0x0A]&0x01;
     eeprom->out_is_isochronous = buf[0x0A]&0x02;
     eeprom->suspend_pull_downs = buf[0x0A]&0x04;
-    eeprom->use_serial         = buf[0x0A]&0x08;
+    eeprom->use_serial         = buf[0x0A] & USE_SERIAL_NUM;
     eeprom->change_usb_version = buf[0x0A]&0x10;
 
-    // Addr 0B: Invert data lines
-    eeprom->invert = buf[0x0B];
 
     // Addr 0C: USB version low byte when 0x0A bit 4 is set
     // Addr 0D: USB version high byte when 0x0A bit 4 is set
-    if (eeprom->change_usb_version == 1)
+    if ((eeprom->change_usb_version == 1) || ftdi->type == TYPE_2232C)
     {
         eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
     }
@@ -2628,30 +2658,49 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
         ftdi_error_return(-1,"EEPROM checksum error");
     }
 
-    if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C))
+    else if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
     {
-        eeprom->chip = buf[14];
+        eeprom->chip = -1;
     }
-    if(ftdi->type == TYPE_2232C)
+    else if(ftdi->type == TYPE_2232C)
     {
+        eeprom->chip = buf[0x14];
     }
-    if(ftdi->type == TYPE_R)
+    else if(ftdi->type == TYPE_R)
     {
+        eeprom->chip = buf[0x16];
+        // Addr 0B: Invert data lines
+        // Works only on FT232R, not FT245R, but no way to distinguish
+        eeprom->invert = buf[0x0B];
         // Addr 14: CBUS function: CBUS0, CBUS1
         // Addr 15: CBUS function: CBUS2, CBUS3
         // Addr 16: CBUS function: CBUS5
-        if (ftdi->type == TYPE_R) {
-            eeprom->cbus_function[0] = buf[0x14] & 0x0f;
-            eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
-            eeprom->cbus_function[2] = buf[0x15] & 0x0f;
-            eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
-            eeprom->cbus_function[4] = buf[0x16] & 0x0f;
-        } else {
-        for (j=0; j<5; j++) eeprom->cbus_function[j] = 0;
-        }
+        eeprom->cbus_function[0] = buf[0x14] & 0x0f;
+        eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
+        eeprom->cbus_function[2] = buf[0x15] & 0x0f;
+        eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
+        eeprom->cbus_function[4] = buf[0x16] & 0x0f;
+    }
+    else if ((ftdi->type == TYPE_2232H) ||(ftdi->type == TYPE_4232H)) 
+    {
+        eeprom->chip = buf[0x18];
+        eeprom->group0_drive   =  buf[0x0c]       & DRIVE_16MA;
+        eeprom->group0_schmitt =  buf[0x0c]       & IS_SCHMITT;
+        eeprom->group0_slew    =  buf[0x0c]       & SLOW_SLEW;
+        eeprom->group1_drive   = (buf[0x0c] >> 4) & 0x3;
+        eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
+        eeprom->group1_slew    = (buf[0x0c] >> 4) & SLOW_SLEW;
+        eeprom->group2_drive   =  buf[0x0d]       & DRIVE_16MA;
+        eeprom->group2_schmitt =  buf[0x0d]       & IS_SCHMITT;
+        eeprom->group2_slew    =  buf[0x0d]       & SLOW_SLEW;
+        eeprom->group3_drive   = (buf[0x0d] >> 4) & DRIVE_16MA;
+        eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
+        eeprom->group3_slew    = (buf[0x0d] >> 4) & SLOW_SLEW;
     }
+    
     if(verbose)
     {
+        char *channel_mode[] = {"UART","245","CPU", "unknown", "OPTO"};
         fprintf(stdout, "VID:     0x%04x\n",eeprom->vendor_id);
         fprintf(stdout, "PID:     0x%04x\n",eeprom->product_id);
         fprintf(stdout, "Release: 0x%04x\n",eeprom->release);
@@ -2659,7 +2708,7 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
         if(eeprom->self_powered)
             fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
         else
-            fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power*2,
+            fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power * 2,
                     (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
         if(eeprom->manufacturer)
             fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
@@ -2667,7 +2716,50 @@ int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size,
             fprintf(stdout, "Product:      %s\n",eeprom->product);
         if(eeprom->serial)
             fprintf(stdout, "Serial:       %s\n",eeprom->serial);
-        fprintf(stderr,     "Checksum      : %04x %04x\n", checksum);
+        fprintf(stdout,     "Checksum      : %04x\n", checksum);
+        if (ftdi->type == TYPE_R)
+            fprintf(stdout,     "Internal EEPROM\n");
+        else if (eeprom->chip >= 0x46)
+            fprintf(stdout,     "Attached EEPROM: 93x%02x\n", eeprom->chip);
+        if(eeprom->suspend_dbus7)
+            fprintf(stdout, "Suspend on DBUS7\n");            
+        if(eeprom->suspend_pull_downs)
+            fprintf(stdout, "Pull IO pins low during suspend\n");
+        if(eeprom->remote_wakeup)
+            fprintf(stdout, "Enable Remote Wake Up\n");
+        if (ftdi->type >= TYPE_2232C)
+            fprintf(stdout,"Channel A has Mode %s%s%s\n", 
+                    channel_mode[eeprom->channel_a_type],
+                    (eeprom->channel_a_driver)?" VCP":"",
+                    (eeprom->high_current_a)?" High Currenr IO":"");
+        if (ftdi->type >= TYPE_2232C)
+            fprintf(stdout,"Channel B has Mode %s%s%s\n", 
+                    channel_mode[eeprom->channel_b_type],
+                    (eeprom->channel_b_driver)?" VCP":"",
+                    (eeprom->high_current_b)?" High Currenr IO":"");
+        if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H)) 
+        {
+            fprintf(stdout,"%s has %d mA drive%s%s\n",
+                    (ftdi->type == TYPE_2232H)?"AL":"A",
+                    (eeprom->group0_drive+1) *4,
+                    (eeprom->group0_schmitt)?" Schmitt Input":"",
+                    (eeprom->group0_slew)?" Slow Slew":"");
+            fprintf(stdout,"%s has %d mA drive%s%s\n",
+                    (ftdi->type == TYPE_2232H)?"AH":"B",
+                    (eeprom->group1_drive+1) *4,
+                    (eeprom->group1_schmitt)?" Schmitt Input":"",
+                    (eeprom->group1_slew)?" Slow Slew":"");
+            fprintf(stdout,"%s has %d mA drive%s%s\n",
+                    (ftdi->type == TYPE_2232H)?"BL":"C",
+                    (eeprom->group2_drive+1) *4,
+                    (eeprom->group2_schmitt)?" Schmitt Input":"",
+                    (eeprom->group2_slew)?" Slow Slew":"");
+            fprintf(stdout,"%s has %d mA drive%s%s\n",
+                    (ftdi->type == TYPE_2232H)?"BH":"D",
+                    (eeprom->group3_drive+1) *4,
+                    (eeprom->group3_schmitt)?" Schmitt Input":"",
+                    (eeprom->group3_slew)?" Slow Slew":"");
+        }
 
     }
 
@@ -2858,15 +2950,61 @@ int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom)
     \retval  0: all fine
     \retval -1: erase failed
     \retval -2: USB device unavailable
+    \retval -3: Writing magic failed
+    \retval -4: Read EEPROM failed
+    \retval -5: Unexpected EEPROM value
 */
+#define MAGIC 0x55aa
 int ftdi_erase_eeprom(struct ftdi_context *ftdi)
 {
+    unsigned short eeprom_value;
     if (ftdi == NULL || ftdi->usb_dev == NULL)
         ftdi_error_return(-2, "USB device unavailable");
 
-    if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST, 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
+    if(ftdi->type == TYPE_R)
+    {
+        ftdi->eeprom->chip = 0;
+        return 0;
+    }
+
+    if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST, 
+                                0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
         ftdi_error_return(-1, "unable to erase eeprom");
 
+    
+    /* detect chip type by writing 0x55AA as magic at word position 0xc0
+       Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
+       Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
+       Chip is 93x66 if magic is only read at word position 0xc0*/
+    if( ftdi_write_eeprom_location(ftdi, 0xc0, MAGIC))
+        ftdi_error_return(-3, "Writing magic failed");
+    if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value)) 
+        ftdi_error_return(-4, "Reading failed failed");
+    if(eeprom_value == MAGIC)
+    {
+        ftdi->eeprom->chip = 0x46;
+    }
+    else 
+    {
+        if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value)) 
+            ftdi_error_return(-4, "Reading failed failed");
+        if(eeprom_value == MAGIC)
+            ftdi->eeprom->chip = 0x56;
+        else 
+        {
+            if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value)) 
+                ftdi_error_return(-4, "Reading failed failed");
+            if(eeprom_value == MAGIC)
+                ftdi->eeprom->chip = 0x66;
+            else
+            {
+                ftdi->eeprom->chip = -1;
+            }
+        }
+    }
+    if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST, 
+                                0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
+        ftdi_error_return(-1, "unable to erase eeprom");
     return 0;
 }