Increase copyright year to 2014
[libftdi] / ftdi_eeprom / main.c
index 81e6e93..2592796 100644 (file)
@@ -2,7 +2,7 @@
                              main.c  -  description
                            -------------------
     begin                : Mon Apr  7 12:05:22 CEST 2003
-    copyright            : (C) 2003,2008 by Intra2net AG
+    copyright            : (C) 2003-2014 by Intra2net AG and the libftdi developers
     email                : opensource@intra2net.com
  ***************************************************************************/
 
  *                                                                         *
  ***************************************************************************/
 
+/*
+ TODO:
+    - Merge Uwe's eeprom tool. Current features:
+        - Init eeprom defaults based upon eeprom type
+        - Read -> Already there
+        - Write -> Already there
+        - Erase -> Already there
+        - Decode on stdout
+        - Ability to find device by PID/VID, product name or serial
+
+ TODO nice-to-have:
+    - Out-of-the-box compatibility with FTDI's eeprom tool configuration files
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
 #include <string.h>
 
 #include <confuse.h>
+#include <libusb.h>
 #include <ftdi.h>
+#include <ftdi_eeprom_version.h>
 
-int str_to_cbus(char *str, int max_allowed)
+static int str_to_cbus(char *str, int max_allowed)
 {
-    #define MAX_OPTION 14
-    const char* options[MAX_OPTION] = {
-     "TXDEN", "PWREN", "RXLED", "TXLED", "TXRXLED", "SLEEP",
-     "CLK48", "CLK24", "CLK12", "CLK6",
-     "IO_MODE", "BITBANG_WR", "BITBANG_RD", "SPECIAL"};
+#define MAX_OPTION 14
+    const char* options[MAX_OPTION] =
+    {
+        "TXDEN", "PWREN", "RXLED", "TXLED", "TXRXLED", "SLEEP",
+        "CLK48", "CLK24", "CLK12", "CLK6",
+        "IO_MODE", "BITBANG_WR", "BITBANG_RD", "SPECIAL"
+    };
     int i;
     max_allowed += 1;
     if (max_allowed > MAX_OPTION) max_allowed = MAX_OPTION;
-    for (i=0; i<max_allowed; i++) {
-        if (!(strcmp(options[i], str))) {
+    for (i=0; i<max_allowed; i++)
+    {
+        if (!(strcmp(options[i], str)))
+        {
             return i;
         }
     }
@@ -44,6 +64,42 @@ int str_to_cbus(char *str, int max_allowed)
     return 0;
 }
 
+/**
+ * @brief Set eeprom value
+ *
+ * \param ftdi pointer to ftdi_context
+ * \param value_name Enum of the value to set
+ * \param value Value to set
+ *
+ * Function will abort the program on error
+ **/
+static void eeprom_set_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
+{
+    if (ftdi_set_eeprom_value(ftdi, value_name, value) < 0)
+    {
+        printf("Unable to set eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
+        exit (-1);
+    }
+}
+
+/**
+ * @brief Get eeprom value
+ *
+ * \param ftdi pointer to ftdi_context
+ * \param value_name Enum of the value to get
+ * \param value Value to get
+ *
+ * Function will abort the program on error
+ **/
+static void eeprom_get_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
+{
+    if (ftdi_get_eeprom_value(ftdi, value_name, value) < 0)
+    {
+        printf("Unable to get eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
+        exit (-1);
+    }
+}
+
 int main(int argc, char *argv[])
 {
     /*
@@ -55,17 +111,18 @@ int main(int argc, char *argv[])
         CFG_INT("product_id", 0, 0),
         CFG_BOOL("self_powered", cfg_true, 0),
         CFG_BOOL("remote_wakeup", cfg_true, 0),
-        CFG_STR_LIST("chip_type", "{BM,R,other}", 0),
         CFG_BOOL("in_is_isochronous", cfg_false, 0),
         CFG_BOOL("out_is_isochronous", cfg_false, 0),
         CFG_BOOL("suspend_pull_downs", cfg_false, 0),
         CFG_BOOL("use_serial", cfg_false, 0),
         CFG_BOOL("change_usb_version", cfg_false, 0),
         CFG_INT("usb_version", 0, 0),
+        CFG_INT("default_pid", 0x6001, 0),
         CFG_INT("max_power", 0, 0),
         CFG_STR("manufacturer", "Acme Inc.", 0),
         CFG_STR("product", "USB Serial Converter", 0),
         CFG_STR("serial", "08-15", 0),
+        CFG_INT("eeprom_type", 0x00, 0),
         CFG_STR("filename", "", 0),
         CFG_BOOL("flash_raw", cfg_false, 0),
         CFG_BOOL("high_current", cfg_false, 0),
@@ -90,17 +147,19 @@ int main(int argc, char *argv[])
     normal variables
     */
     int _read = 0, _erase = 0, _flash = 0;
-    unsigned char eeprom_buf[128];
+
+    const int max_eeprom_size = 256;
+    int my_eeprom_size = 0;
+    unsigned char *eeprom_buf = NULL;
     char *filename;
     int size_check;
     int i, argc_filename;
     FILE *fp;
 
-    struct ftdi_context ftdi;
-    struct ftdi_eeprom eeprom;
+    struct ftdi_context *ftdi = NULL;
 
-    printf("\nFTDI eeprom generator v%s\n", VERSION);
-    printf ("(c) Intra2net AG <opensource@intra2net.com>\n");
+    printf("\nFTDI eeprom generator v%s\n", EEPROM_VERSION_STRING);
+    printf ("(c) Intra2net AG and the libftdi developers <opensource@intra2net.com>\n");
 
     if (argc != 2 && argc != 3)
     {
@@ -116,11 +175,15 @@ int main(int argc, char *argv[])
     {
         if (strcmp(argv[1], "--read-eeprom") == 0)
             _read = 1;
-        if (strcmp(argv[1], "--erase-eeprom") == 0)
+        else if (strcmp(argv[1], "--erase-eeprom") == 0)
             _erase = 1;
-        if (strcmp(argv[1], "--flash-eeprom") == 0)
+        else if (strcmp(argv[1], "--flash-eeprom") == 0)
             _flash = 1;
-
+        else
+        {
+            printf ("Can't open configuration file\n");
+            exit (-1);
+        }
         argc_filename = 2;
     }
     else
@@ -142,106 +205,60 @@ int main(int argc, char *argv[])
     if (cfg_getbool(cfg, "self_powered") && cfg_getint(cfg, "max_power") > 0)
         printf("Hint: Self powered devices should have a max_power setting of 0.\n");
 
-    ftdi_init(&ftdi);
-    ftdi_eeprom_initdefaults (&eeprom);
-    eeprom.vendor_id = cfg_getint(cfg, "vendor_id");
-    eeprom.product_id = cfg_getint(cfg, "product_id");
-    char *type = cfg_getstr(cfg, "chip_type");
-    if (!strcmp(type, "BM")) {
-        eeprom.chip_type = TYPE_BM;
-    } else if (!strcmp(type, "R")) {
-        eeprom.chip_type = TYPE_R;
-    } else {
-        eeprom.chip_type = TYPE_AM;
+    if ((ftdi = ftdi_new()) == 0)
+    {
+        fprintf(stderr, "Failed to allocate ftdi structure :%s \n",
+                ftdi_get_error_string(ftdi));
+        return EXIT_FAILURE;
     }
 
-    eeprom.self_powered = cfg_getbool(cfg, "self_powered");
-    eeprom.remote_wakeup = cfg_getbool(cfg, "remote_wakeup");
-    eeprom.max_power = cfg_getint(cfg, "max_power");
-
-    eeprom.in_is_isochronous = cfg_getbool(cfg, "in_is_isochronous");
-    eeprom.out_is_isochronous = cfg_getbool(cfg, "out_is_isochronous");
-    eeprom.suspend_pull_downs = cfg_getbool(cfg, "suspend_pull_downs");
-
-    eeprom.use_serial = cfg_getbool(cfg, "use_serial");
-    eeprom.change_usb_version = cfg_getbool(cfg, "change_usb_version");
-    eeprom.usb_version = cfg_getint(cfg, "usb_version");
-
-
-    eeprom.manufacturer = cfg_getstr(cfg, "manufacturer");
-    eeprom.product = cfg_getstr(cfg, "product");
-    eeprom.serial = cfg_getstr(cfg, "serial");
-    eeprom.high_current = cfg_getbool(cfg, "high_current");
-    eeprom.cbus_function[0] = str_to_cbus(cfg_getstr(cfg, "cbus0"), 13);
-    eeprom.cbus_function[1] = str_to_cbus(cfg_getstr(cfg, "cbus1"), 13);
-    eeprom.cbus_function[2] = str_to_cbus(cfg_getstr(cfg, "cbus2"), 13);
-    eeprom.cbus_function[3] = str_to_cbus(cfg_getstr(cfg, "cbus3"), 13);
-    eeprom.cbus_function[4] = str_to_cbus(cfg_getstr(cfg, "cbus4"), 9);
-    int invert = 0;
-    if (cfg_getbool(cfg, "invert_rxd")) invert |= INVERT_RXD;
-    if (cfg_getbool(cfg, "invert_txd")) invert |= INVERT_TXD;
-    if (cfg_getbool(cfg, "invert_rts")) invert |= INVERT_RTS;
-    if (cfg_getbool(cfg, "invert_cts")) invert |= INVERT_CTS;
-    if (cfg_getbool(cfg, "invert_dtr")) invert |= INVERT_DTR;
-    if (cfg_getbool(cfg, "invert_dsr")) invert |= INVERT_DSR;
-    if (cfg_getbool(cfg, "invert_dcd")) invert |= INVERT_DCD;
-    if (cfg_getbool(cfg, "invert_ri")) invert |= INVERT_RI;
-    eeprom.invert = invert;
-
     if (_read > 0 || _erase > 0 || _flash > 0)
     {
-        i = ftdi_usb_open(&ftdi, eeprom.vendor_id, eeprom.product_id);
+        int vendor_id = cfg_getint(cfg, "vendor_id");
+        int product_id = cfg_getint(cfg, "product_id");
 
-        if (i == 0)
-        {
-            printf("EEPROM size: %d\n", ftdi.eeprom_size);
-        }
-        else
+        i = ftdi_usb_open(ftdi, vendor_id, product_id);
+
+        if (i != 0)
         {
-            printf("Unable to find FTDI devices under given vendor/product id: 0x%X/0x%X\n", eeprom.vendor_id, eeprom.product_id);
-            printf("Error code: %d (%s)\n", i, ftdi_get_error_string(&ftdi));
-            printf("Retrying with default FTDI id.\n");
+            int default_pid = cfg_getint(cfg, "default_pid");
+            printf("Unable to find FTDI devices under given vendor/product id: 0x%X/0x%X\n", vendor_id, product_id);
+            printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
+            printf("Retrying with default FTDI pid=%#04x.\n", default_pid);
 
-            i = ftdi_usb_open(&ftdi, 0x0403, 0x6001);
+            i = ftdi_usb_open(ftdi, 0x0403, default_pid);
             if (i != 0)
             {
-                printf("Error: %s\n", ftdi.error_str);
+                printf("Error: %s\n", ftdi->error_str);
                 exit (-1);
             }
         }
     }
+    ftdi_eeprom_initdefaults (ftdi, cfg_getstr(cfg, "manufacturer"),
+                              cfg_getstr(cfg, "product"),
+                              cfg_getstr(cfg, "serial"));
+
+    printf("FTDI read eeprom: %d\n", ftdi_read_eeprom(ftdi));
+    eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
+    printf("EEPROM size: %d\n", my_eeprom_size);
 
     if (_read > 0)
     {
-        printf("FTDI read eeprom: %d\n", ftdi_read_eeprom(&ftdi, eeprom_buf));
-
-        ftdi_eeprom_decode(&eeprom, eeprom_buf, ftdi.eeprom_size);
-        /* Debug output */
-        /*
-        const char* chip_types[] = {"other", "BM", "R"};
-        printf("vendor_id = \"%04x\"\n", eeprom.vendor_id);
-        printf("product_id = \"%04x\"\n", eeprom.product_id);
-        printf("chip_type = \"%s\"\n",
-          (eeprom.chip_type > 0x06) || (eeprom.chip_type & 0x01) ? "unknown":
-          chip_types[eeprom.chip_type>>1]);
-        printf("self_powered = \"%s\"\n", eeprom.self_powered?"true":"false");
-        printf("remote_wakeup = \"%s\"\n", eeprom.remote_wakeup?"true":"false");
-        printf("max_power = \"%d\"\n", eeprom.max_power);
-        printf("in_is_isochronous = \"%s\"\n", eeprom.in_is_isochronous?"true":"false");
-        printf("out_is_isochronous = \"%s\"\n", eeprom.out_is_isochronous?"true":"false");
-        printf("suspend_pull_downs = \"%s\"\n", eeprom.suspend_pull_downs?"true":"false");
-        printf("use_serial = \"%s\"\n", eeprom.use_serial?"true":"false");
-        printf("change_usb_version = \"%s\"\n", eeprom.change_usb_version?"true":"false");
-        printf("usb_version = \"%d\"\n", eeprom.usb_version);
-        printf("manufacturer = \"%s\"\n", eeprom.manufacturer);
-        printf("product = \"%s\"\n", eeprom.product);
-        printf("serial = \"%s\"\n", eeprom.serial);
-        */
+        ftdi_eeprom_decode(ftdi, 0 /* debug: 1 */);
+
+        eeprom_buf = malloc(my_eeprom_size);
+        ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
 
+        if (eeprom_buf == NULL)
+        {
+            fprintf(stderr, "Malloc failed, aborting\n");
+            goto cleanup;
+        }
         if (filename != NULL && strlen(filename) > 0)
         {
+
             FILE *fp = fopen (filename, "wb");
-            fwrite (eeprom_buf, 1, 128, fp);
+            fwrite (eeprom_buf, 1, my_eeprom_size, fp);
             fclose (fp);
         }
         else
@@ -252,24 +269,69 @@ int main(int argc, char *argv[])
         goto cleanup;
     }
 
+    eeprom_set_value(ftdi, VENDOR_ID, cfg_getint(cfg, "vendor_id"));
+    eeprom_set_value(ftdi, PRODUCT_ID, cfg_getint(cfg, "product_id"));
+
+    eeprom_set_value(ftdi, SELF_POWERED, cfg_getbool(cfg, "self_powered"));
+    eeprom_set_value(ftdi, REMOTE_WAKEUP, cfg_getbool(cfg, "remote_wakeup"));
+    eeprom_set_value(ftdi, MAX_POWER, cfg_getint(cfg, "max_power"));
+
+    eeprom_set_value(ftdi, IN_IS_ISOCHRONOUS, cfg_getbool(cfg, "in_is_isochronous"));
+    eeprom_set_value(ftdi, OUT_IS_ISOCHRONOUS, cfg_getbool(cfg, "out_is_isochronous"));
+    eeprom_set_value(ftdi, SUSPEND_PULL_DOWNS, cfg_getbool(cfg, "suspend_pull_downs"));
+
+    eeprom_set_value(ftdi, USE_SERIAL, cfg_getbool(cfg, "use_serial"));
+    eeprom_set_value(ftdi, USE_USB_VERSION, cfg_getbool(cfg, "change_usb_version"));
+    eeprom_set_value(ftdi, USB_VERSION, cfg_getint(cfg, "usb_version"));
+    eeprom_set_value(ftdi, CHIP_TYPE, cfg_getint(cfg, "eeprom_type"));
+
+    eeprom_set_value(ftdi, HIGH_CURRENT, cfg_getbool(cfg, "high_current"));
+    eeprom_set_value(ftdi, CBUS_FUNCTION_0, str_to_cbus(cfg_getstr(cfg, "cbus0"), 13));
+    eeprom_set_value(ftdi, CBUS_FUNCTION_1, str_to_cbus(cfg_getstr(cfg, "cbus1"), 13));
+    eeprom_set_value(ftdi, CBUS_FUNCTION_2, str_to_cbus(cfg_getstr(cfg, "cbus2"), 13));
+    eeprom_set_value(ftdi, CBUS_FUNCTION_3, str_to_cbus(cfg_getstr(cfg, "cbus3"), 13));
+    eeprom_set_value(ftdi, CBUS_FUNCTION_4, str_to_cbus(cfg_getstr(cfg, "cbus4"), 9));
+    int invert = 0;
+    if (cfg_getbool(cfg, "invert_rxd")) invert |= INVERT_RXD;
+    if (cfg_getbool(cfg, "invert_txd")) invert |= INVERT_TXD;
+    if (cfg_getbool(cfg, "invert_rts")) invert |= INVERT_RTS;
+    if (cfg_getbool(cfg, "invert_cts")) invert |= INVERT_CTS;
+    if (cfg_getbool(cfg, "invert_dtr")) invert |= INVERT_DTR;
+    if (cfg_getbool(cfg, "invert_dsr")) invert |= INVERT_DSR;
+    if (cfg_getbool(cfg, "invert_dcd")) invert |= INVERT_DCD;
+    if (cfg_getbool(cfg, "invert_ri")) invert |= INVERT_RI;
+    eeprom_set_value(ftdi, INVERT, invert);
+
+    eeprom_set_value(ftdi, CHANNEL_A_DRIVER, DRIVER_VCP);
+    eeprom_set_value(ftdi, CHANNEL_B_DRIVER, DRIVER_VCP);
+    eeprom_set_value(ftdi, CHANNEL_C_DRIVER, DRIVER_VCP);
+    eeprom_set_value(ftdi, CHANNEL_D_DRIVER, DRIVER_VCP);
+    eeprom_set_value(ftdi, CHANNEL_A_RS485, 0);
+    eeprom_set_value(ftdi, CHANNEL_B_RS485, 0);
+    eeprom_set_value(ftdi, CHANNEL_C_RS485, 0);
+    eeprom_set_value(ftdi, CHANNEL_D_RS485, 0);
+
     if (_erase > 0)
     {
-        printf("FTDI erase eeprom: %d\n", ftdi_erase_eeprom(&ftdi));
+        printf("FTDI erase eeprom: %d\n", ftdi_erase_eeprom(ftdi));
     }
 
-    size_check = ftdi_eeprom_build(&eeprom, eeprom_buf);
+    size_check = ftdi_eeprom_build(ftdi);
+    eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
 
     if (size_check == -1)
     {
         printf ("Sorry, the eeprom can only contain 128 bytes (100 bytes for your strings).\n");
         printf ("You need to short your string by: %d bytes\n", size_check);
         goto cleanup;
-    } else if (size_check < 0) {
+    }
+    else if (size_check < 0)
+    {
         printf ("ftdi_eeprom_build(): error: %d\n", size_check);
     }
     else
     {
-        printf ("Used eeprom space: %d bytes\n", 128-size_check);
+        printf ("Used eeprom space: %d bytes\n", my_eeprom_size-size_check);
     }
 
     if (_flash > 0)
@@ -278,16 +340,30 @@ int main(int argc, char *argv[])
         {
             if (filename != NULL && strlen(filename) > 0)
             {
+                eeprom_buf = malloc(max_eeprom_size);
                 FILE *fp = fopen(filename, "rb");
-                fread(eeprom_buf, 1, 128, fp);
+                if (fp == NULL)
+                {
+                    printf ("Can't open eeprom file %s.\n", filename);
+                    exit (-1);
+                }
+                my_eeprom_size = fread(eeprom_buf, 1, max_eeprom_size, fp);
                 fclose(fp);
+                if (my_eeprom_size < 128)
+                {
+                    printf ("Can't read eeprom file %s.\n", filename);
+                    exit (-1);
+                }
+
+                ftdi_set_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
             }
         }
-        printf ("FTDI write eeprom: %d\n", ftdi_write_eeprom(&ftdi, eeprom_buf));
+        printf ("FTDI write eeprom: %d\n", ftdi_write_eeprom(ftdi));
+        libusb_reset_device(ftdi->usb_dev);
     }
 
     // Write to file?
-    if (filename != NULL && strlen(filename) > 0)
+    if (filename != NULL && strlen(filename) > 0 && !cfg_getbool(cfg, "flash_raw"))
     {
         fp = fopen(filename, "w");
         if (fp == NULL)
@@ -298,17 +374,24 @@ int main(int argc, char *argv[])
         else
             printf ("Writing to file: %s\n", filename);
 
-        fwrite(eeprom_buf, 128, 1, fp);
+        if (eeprom_buf == NULL)
+            eeprom_buf = malloc(my_eeprom_size);
+        ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
+
+        fwrite(eeprom_buf, my_eeprom_size, 1, fp);
         fclose(fp);
     }
 
 cleanup:
+    if (eeprom_buf)
+        free(eeprom_buf);
     if (_read > 0 || _erase > 0 || _flash > 0)
     {
-        printf("FTDI close: %d\n", ftdi_usb_close(&ftdi));
+        printf("FTDI close: %d\n", ftdi_usb_close(ftdi));
     }
 
-    ftdi_deinit (&ftdi);
+    ftdi_deinit (ftdi);
+    ftdi_free (ftdi);
 
     cfg_free(cfg);