ft2232: remove ft2232_large_scan memory leak
[fw/openocd] / src / jtag / drivers / ft2232.c
index 3a156bfea7d048194d97e2925fa883fa5e069b9c..fed829856036d17c2eec0ef8f80a656b7dba1eb3 100644 (file)
@@ -114,7 +114,7 @@ enum ftdi_interface {
 #endif
 
 /* max TCK for the high speed devices 30000 kHz */
-#define        FTDI_2232H_4232H_MAX_TCK        30000
+#define        FTDI_x232H_MAX_TCK      30000
 /* max TCK for the full speed devices 6000 kHz */
 #define FTDI_2232C_MAX_TCK 6000
 /* this speed value tells that RTCK is requested */
@@ -133,9 +133,9 @@ enum ftdi_interface {
 
 #ifndef BUILD_FT2232_HIGHSPEED
  #if BUILD_FT2232_FTD2XX == 1
-       enum { FT_DEVICE_2232H = 6, FT_DEVICE_4232H };
+       enum { FT_DEVICE_2232H = 6, FT_DEVICE_4232H, FT_DEVICE_232H };
  #elif BUILD_FT2232_LIBFTDI == 1
-       enum { TYPE_2232H = 4, TYPE_4232H = 5 };
+       enum ftdi_chip_type { TYPE_2232H = 4, TYPE_4232H = 5, TYPE_232H = 6 };
  #endif
 #endif
 
@@ -156,6 +156,7 @@ static char *ft2232_device_desc;
 static char *ft2232_serial;
 static uint8_t ft2232_latency = 2;
 static unsigned ft2232_max_tck = FTDI_2232C_MAX_TCK;
+static int ft2232_channel = INTERFACE_ANY;
 
 #define MAX_USB_IDS 8
 /* vid = pid = 0 marks the end of the list */
@@ -193,6 +194,7 @@ static int redbee_init(void);
 static int lisa_l_init(void);
 static int flossjtag_init(void);
 static int xds100v2_init(void);
+static int digilent_hs1_init(void);
 
 /* reset procedures for supported layouts */
 static void ftx23_reset(int trst, int srst);
@@ -211,6 +213,7 @@ static void signalyzer_h_reset(int trst, int srst);
 static void ktlink_reset(int trst, int srst);
 static void redbee_reset(int trst, int srst);
 static void xds100v2_reset(int trst, int srst);
+static void digilent_hs1_reset(int trst, int srst);
 
 /* blink procedures for layouts that support a blinking led */
 static void olimex_jtag_blink(void);
@@ -337,6 +340,11 @@ static const struct ft2232_layout  ft2232_layouts[] = {
                .init = xds100v2_init,
                .reset = xds100v2_reset,
        },
+       { .name = "digilent-hs1",
+               .init = digilent_hs1_init,
+               .reset = digilent_hs1_reset,
+               .channel = INTERFACE_A,
+       },
        { .name = NULL, /* END OF TABLE */ },
 };
 
@@ -591,19 +599,27 @@ static int ft2232_read(uint8_t *buf, uint32_t size, uint32_t *bytes_read)
 static bool ft2232_device_is_highspeed(void)
 {
 #if BUILD_FT2232_FTD2XX == 1
-       return (ftdi_device == FT_DEVICE_2232H) || (ftdi_device == FT_DEVICE_4232H);
+       return (ftdi_device == FT_DEVICE_2232H) || (ftdi_device == FT_DEVICE_4232H)
+ #ifdef HAS_ENUM_FT232H
+               || (ftdi_device == FT_DEVICE_232H)
+ #endif
+       ;
 #elif BUILD_FT2232_LIBFTDI == 1
-       return (ftdi_device == TYPE_2232H || ftdi_device == TYPE_4232H);
+       return (ftdi_device == TYPE_2232H || ftdi_device == TYPE_4232H
+ #ifdef HAS_ENUM_FT232H
+               || ftdi_device == TYPE_232H
+ #endif
+       );
 #endif
 }
 
 /*
- * Commands that only apply to the FT2232H and FT4232H devices.
+ * Commands that only apply to the highspeed FTx232H devices (FT2232H, FT4232H, FT232H).
  * See chapter 6 in http://www.ftdichip.com/Documents/AppNotes/
  * AN_108_Command_Processor_for_MPSSE_and_MCU_Host_Bus_Emulation_Modes.pdf
  */
 
-static int ft2232h_ft4232h_adaptive_clocking(bool enable)
+static int ftx232h_adaptive_clocking(bool enable)
 {
        uint8_t buf = enable ? 0x96 : 0x97;
        LOG_DEBUG("%2.2x", buf);
@@ -626,7 +642,7 @@ static int ft2232h_ft4232h_adaptive_clocking(bool enable)
  * This result in a JTAG clock speed range of 91.553Hz-6MHz
  * respective 457.763Hz-30MHz.
  */
-static int ft2232h_ft4232h_clk_divide_by_5(bool enable)
+static int ftx232h_clk_divide_by_5(bool enable)
 {
        uint32_t bytes_written;
        uint8_t buf = enable ?  0x8b : 0x8a;
@@ -636,7 +652,7 @@ static int ft2232h_ft4232h_clk_divide_by_5(bool enable)
                        , enable ? "enable" : "disable");
                return ERROR_JTAG_INIT_FAILED;
        }
-       ft2232_max_tck = enable ? FTDI_2232C_MAX_TCK : FTDI_2232H_4232H_MAX_TCK;
+       ft2232_max_tck = enable ? FTDI_2232C_MAX_TCK : FTDI_x232H_MAX_TCK;
        LOG_INFO("max TCK change to: %u kHz", ft2232_max_tck);
 
        return ERROR_OK;
@@ -651,7 +667,7 @@ static int ft2232_speed(int speed)
        retval = ERROR_OK;
        bool enable_adaptive_clocking = (RTCK_SPEED == speed);
        if (ft2232_device_is_highspeed())
-               retval = ft2232h_ft4232h_adaptive_clocking(enable_adaptive_clocking);
+               retval = ftx232h_adaptive_clocking(enable_adaptive_clocking);
        else if (enable_adaptive_clocking) {
                LOG_ERROR("ft2232 device %lu does not support RTCK"
                        , (long unsigned int)ftdi_device);
@@ -1045,7 +1061,8 @@ static void ft2232_add_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
                        /* LOG_DEBUG("added TDI bits (i %i)", bits_left - 1); */
                }
                buffer_write(0x0);
-               buffer_write(last_bit);
+               if (type != SCAN_IN)
+                       buffer_write(last_bit);
        } else {
                int tms_bits;
                int tms_count;
@@ -1091,6 +1108,11 @@ static int ft2232_large_scan(struct scan_command *cmd,
        int retval;
        int thisrun_read = 0;
 
+       if (!receive_buffer) {
+               LOG_ERROR("failed to allocate memory");
+               exit(-1);
+       }
+
        if (cmd->ir_scan) {
                LOG_ERROR("BUG: large IR scans are not supported");
                exit(-1);
@@ -1256,6 +1278,8 @@ static int ft2232_large_scan(struct scan_command *cmd,
                        (int)bytes_read);
        }
 
+       free(receive_buffer);
+
        return ERROR_OK;
 }
 
@@ -2165,7 +2189,7 @@ static int ft2232_init_ftd2xx(uint16_t vid, uint16_t pid, int more, int *try_mor
                return ERROR_JTAG_INIT_FAILED;
        } else {
                static const char *type_str[] = {
-                       "BM", "AM", "100AX", "UNKNOWN", "2232C", "232R", "2232H", "4232H"
+                       "BM", "AM", "100AX", "UNKNOWN", "2232C", "232R", "2232H", "4232H", "232H"
                };
                unsigned no_of_known_types = ARRAY_SIZE(type_str) - 1;
                unsigned type_index = ((unsigned)ftdi_device <= no_of_known_types)
@@ -2251,7 +2275,7 @@ static int ft2232_init_libftdi(uint16_t vid, uint16_t pid, int more, int *try_mo
 
        ftdi_device = ftdic.type;
        static const char *type_str[] = {
-               "AM", "BM", "2232C", "R", "2232H", "4232H", "Unknown"
+               "AM", "BM", "2232C", "R", "2232H", "4232H", "232H", "Unknown"
        };
        unsigned no_of_known_types = ARRAY_SIZE(type_str) - 1;
        unsigned type_index = ((unsigned)ftdi_device < no_of_known_types)
@@ -2343,7 +2367,7 @@ static int ft2232_init(void)
                                more, &try_more);
 #elif BUILD_FT2232_LIBFTDI == 1
                retval = ft2232_init_libftdi(ft2232_vid[i], ft2232_pid[i],
-                               more, &try_more, layout->channel);
+                               more, &try_more, ft2232_channel);
 #endif
                if (retval >= 0)
                        break;
@@ -2368,7 +2392,7 @@ static int ft2232_init(void)
  #endif
 #endif
                /* make sure the legacy mode is disabled */
-               if (ft2232h_ft4232h_clk_divide_by_5(false) != ERROR_OK)
+               if (ftx232h_clk_divide_by_5(false) != ERROR_OK)
                        return ERROR_JTAG_INIT_FAILED;
        }
 
@@ -3188,6 +3212,7 @@ COMMAND_HANDLER(ft2232_handle_layout_command)
        for (const struct ft2232_layout *l = ft2232_layouts; l->name; l++) {
                if (strcmp(l->name, CMD_ARGV[0]) == 0) {
                        layout = l;
+                       ft2232_channel = l->channel;
                        return ERROR_OK;
                }
        }
@@ -3236,6 +3261,18 @@ COMMAND_HANDLER(ft2232_handle_latency_command)
        return ERROR_OK;
 }
 
+COMMAND_HANDLER(ft2232_handle_channel_command)
+{
+       if (CMD_ARGC == 1) {
+               ft2232_channel = atoi(CMD_ARGV[0]);
+               if (ft2232_channel < 0 || ft2232_channel > 4)
+                       LOG_ERROR("ft2232_channel must be in the 0 to 4 range");
+       } else
+               LOG_ERROR("expected exactly one argument to ft2232_channel <ch>");
+
+       return ERROR_OK;
+}
+
 static int ft2232_stableclocks(int num_cycles, struct jtag_command *cmd)
 {
        int retval = 0;
@@ -4179,6 +4216,33 @@ static void ktlink_blink(void)
        buffer_write(high_direction);
 }
 
+/********************************************************************
+ * Support for Digilent HS-1
+ * JTAG adapter from Digilent
+ * http://www.digilent.com
+ * Author: Stephane Bonnet bonnetst@hds.utc.fr
+ *******************************************************************/
+
+static int digilent_hs1_init(void)
+{
+       /* the adapter only supports the base JTAG signals, no nTRST
+          nor nSRST */
+       low_output      = 0x88;
+       low_direction   = 0x8b;
+
+       /* initialize low byte for jtag */
+       if (ft2232_set_data_bits_low_byte(low_output, low_direction) != ERROR_OK) {
+               LOG_ERROR("couldn't initialize FT2232 with 'digilent_hs1' layout");
+               return ERROR_JTAG_INIT_FAILED;
+       }
+       return ERROR_OK;
+}
+
+static void digilent_hs1_reset(int trst, int srst)
+{
+       /* Dummy function, no reset signals supported. */
+}
+
 static const struct command_registration ft2232_command_handlers[] = {
        {
                .name = "ft2232_device_desc",
@@ -4216,6 +4280,13 @@ static const struct command_registration ft2232_command_handlers[] = {
                .help = "set the FT2232 latency timer to a new value",
                .usage = "value",
        },
+       {
+               .name = "ft2232_channel",
+               .handler = &ft2232_handle_channel_command,
+               .mode = COMMAND_CONFIG,
+               .help = "set the FT2232 channel to a new value",
+               .usage = "value",
+       },
        COMMAND_REGISTRATION_DONE
 };