Minor behavior fixes for the two JTAG reset events (C/internal,
[fw/openocd] / src / jtag / jlink.c
index d7bcba432d4c7149d2b5019fec7017113aff498e..1ec73b2d24be103df3ac4e7907dc01d839074b59 100644 (file)
@@ -50,7 +50,7 @@ static unsigned int jlink_hw_jtag_version = 2;
 //#define JLINK_TAP_BUFFER_SIZE 384
 
 #define JLINK_IN_BUFFER_SIZE                   2048
-#define JLINK_OUT_BUFFER_SIZE                  2*2048+4
+#define JLINK_OUT_BUFFER_SIZE                  2*2048 + 4
 #define JLINK_EMU_RESULT_BUFFER_SIZE   64
 
 /* Global USB buffers */
@@ -299,13 +299,12 @@ static int jlink_register_commands(struct command_context_s *cmd_ctx)
                "query jlink info");
        register_command(cmd_ctx, NULL, "jlink_hw_jtag",
                &jlink_handle_jlink_hw_jtag_command, COMMAND_EXEC,
-               "set/get jlink hw jtag command version [2|3]");
+               "set/get jlink hw jtag command version [2 | 3]");
        return ERROR_OK;
 }
 
 static int jlink_init(void)
 {
-       int check_cnt;
        int i;
 
        jlink_jtag_handle = jlink_usb_open();
@@ -315,24 +314,28 @@ static int jlink_init(void)
                LOG_ERROR("Cannot find jlink Interface! Please check connection and permissions.");
                return ERROR_JTAG_INIT_FAILED;
        }
+       
+       /*
+        *  The next three instructions were added after discovering a problem while using an oscilloscope.  For the V8
+        *      SAM-ICE dongle (and likely other j-link device variants), the reset line to the target microprocessor was found to
+        *      cycle only intermittently during emulator startup (even after encountering the downstream reset instruction later
+        *      in the code).  This was found to create two issues:  1) In general it is a bad practice to not reset a CPU to a known
+        *      state when starting an emulator and 2) something critical happens inside the dongle when it does the first read
+        *      following a new USB session.  Keeping the processor in reset during the first read collecting version information
+        *      seems to prevent errant "J-Link command EMU_CMD_VERSION failed" issues.
+        */
+       
+       LOG_INFO("J-Link initialization started / target CPU reset initiated");
+       jlink_simple_command(EMU_CMD_HW_TRST0);
+       jlink_simple_command(EMU_CMD_HW_RESET0);
+       usleep(1000);
 
        jlink_hw_jtag_version = 2;
-       check_cnt = 0;
-       while (check_cnt < 3)
-       {
-               if (jlink_get_version_info() == ERROR_OK)
-               {
-                       /* attempt to get status */
-                       jlink_get_status();
-                       break;
-               }
 
-               check_cnt++;
-       }
-
-       if (check_cnt == 3)
+       if (jlink_get_version_info() == ERROR_OK)
        {
-               LOG_INFO("J-Link initial read failed, don't worry");
+               /* attempt to get status */
+               jlink_get_status();
        }
 
        LOG_INFO("J-Link JTAG Interface ready");
@@ -496,12 +499,10 @@ static void jlink_reset(int trst, int srst)
        {
                jlink_simple_command(EMU_CMD_HW_TRST0);
        }
+
        if (trst == 0)
        {
                jlink_simple_command(EMU_CMD_HW_TRST1);
-               jtag_sleep(5000);
-               jlink_end_state(TAP_RESET);
-               jlink_state_move();
        }
 }
 
@@ -549,7 +550,7 @@ static int jlink_get_version_info(void)
 {
        int result;
        int len;
-       u32 jlink_caps, jlink_max_size;
+       uint32_t jlink_caps, jlink_max_size;
 
        /* query hardware version */
        jlink_simple_command(EMU_CMD_VERSION);
@@ -589,7 +590,7 @@ static int jlink_get_version_info(void)
        }
 
        jlink_caps = buf_get_u32(usb_in_buffer, 0, 32);
-       LOG_INFO("JLink caps 0x%x", jlink_caps);
+       LOG_INFO("JLink caps 0x%x", (unsigned)jlink_caps);
 
        if (jlink_caps & (1 << EMU_CAP_GET_HW_VERSION))
        {
@@ -603,12 +604,12 @@ static int jlink_get_version_info(void)
                        return ERROR_JTAG_DEVICE_ERROR;
                }
 
-               u32 jlink_hw_version = buf_get_u32(usb_in_buffer, 0, 32);
-               u32 major_revision = (jlink_hw_version / 10000) % 100;
+               uint32_t jlink_hw_version = buf_get_u32(usb_in_buffer, 0, 32);
+               uint32_t major_revision = (jlink_hw_version / 10000) % 100;
                if (major_revision >= 5)
                        jlink_hw_jtag_version = 3;
 
-               LOG_INFO("JLink hw version %i", jlink_hw_version);
+               LOG_INFO("JLink hw version %i", (int)jlink_hw_version);
        }
 
        if (jlink_caps & (1 << EMU_CAP_GET_MAX_BLOCK_SIZE))
@@ -624,7 +625,7 @@ static int jlink_get_version_info(void)
                }
 
                jlink_max_size = buf_get_u32(usb_in_buffer, 0, 32);
-               LOG_INFO("JLink max mem block %i", jlink_max_size);
+               LOG_INFO("JLink max mem block %i", (int)jlink_max_size);
        }
 
        return ERROR_OK;
@@ -669,7 +670,7 @@ static int jlink_handle_jlink_hw_jtag_command(struct command_context_s *cmd_ctx,
 /* J-Link tap functions */
 
 
-static unsigned tap_length=0;
+static unsigned tap_length = 0;
 static uint8_t tms_buffer[JLINK_TAP_BUFFER_SIZE];
 static uint8_t tdi_buffer[JLINK_TAP_BUFFER_SIZE];
 static uint8_t tdo_buffer[JLINK_TAP_BUFFER_SIZE];
@@ -711,7 +712,7 @@ static void jlink_tap_append_step(int tms, int tdi)
        if (index >= JLINK_TAP_BUFFER_SIZE)
        {
                LOG_ERROR("jlink_tap_append_step: overflow");
-               *(u32 *)0xFFFFFFFF = 0;
+               *(uint32_t *)0xFFFFFFFF = 0;
                exit(-1);
        }
 
@@ -751,7 +752,7 @@ static void jlink_tap_append_scan(int length, uint8_t *buffer, scan_command_t *c
        for (i = 0; i < length; i++)
        {
                int tms = (i < (length - 1)) ? 0 : 1;
-               int tdi = (buffer[i / 8] & (1 << (i % 8)))!=0;
+               int tdi = (buffer[i / 8] & (1 << (i % 8))) != 0;
                jlink_tap_append_step(tms, tdi);
        }
        pending_scan_results_length++;
@@ -770,7 +771,7 @@ static int jlink_tap_execute(void)
 
        /* JLink returns an extra NULL in packet when size of in message is a multiple of 64, creates problems with usb comms */
        /* WARNING This will interfere with tap state counting */
-       while ((TAP_SCAN_BYTES(tap_length)%64)==0)
+       while ((TAP_SCAN_BYTES(tap_length)%64) == 0)
        {
                jlink_tap_append_step((tap_get_state() == TAP_RESET)?1:0, 0);
        }
@@ -832,13 +833,37 @@ static int jlink_tap_execute(void)
        return ERROR_OK;
 }
 
+static struct usb_device* find_jlink_device(void)
+{
+       struct usb_bus *busses;
+       struct usb_bus *bus;
+       struct usb_device *dev;
+
+       usb_find_busses();
+       usb_find_devices();
+
+       busses = usb_get_busses();
+
+       /* find jlink_jtag device in usb bus */
+
+       for (bus = busses; bus; bus = bus->next)
+       {
+               for (dev = bus->devices; dev; dev = dev->next)
+               {
+                       if ((dev->descriptor.idVendor == VID) && (dev->descriptor.idProduct == PID)) {
+                               return dev;
+                       }
+               }
+       }
+
+       return NULL;
+}
+
 /*****************************************************************************/
 /* JLink USB low-level functions */
 
 static jlink_jtag_t* jlink_usb_open()
 {
-       struct usb_bus *busses;
-       struct usb_bus *bus;
        struct usb_device *dev;
 
        jlink_jtag_t *result;
@@ -846,47 +871,81 @@ static jlink_jtag_t* jlink_usb_open()
        result = (jlink_jtag_t*) malloc(sizeof(jlink_jtag_t));
 
        usb_init();
-       usb_find_busses();
-       usb_find_devices();
 
-       busses = usb_get_busses();
+       if ((dev = find_jlink_device()) == NULL) {
+               free(result);
+               return NULL;
+       }
 
-       /* find jlink_jtag device in usb bus */
+       result->usb_handle = usb_open(dev);
 
-       for (bus = busses; bus; bus = bus->next)
+       if (result->usb_handle)
        {
-               for (dev = bus->devices; dev; dev = dev->next)
+       
+               /* BE ***VERY CAREFUL*** ABOUT MAKING CHANGES IN THIS AREA!!!!!!!!!!!
+                * The behavior of libusb is not completely consistent across Windows, Linux, and Mac OS X platforms.  The actions taken
+                * in the following compiler conditionals may not agree with published documentation for libusb, but were found
+                * to be necessary through trials and tribulations.  Even little tweaks can break one or more platforms, so if you do make changes
+                * test them carefully on all platforms before committing them!
+                */
+
+#if IS_WIN32 == 0
+
+               usb_reset(result->usb_handle);
+
+#if IS_DARWIN == 0
+
+               int timeout = 5;
+
+               /* reopen jlink after usb_reset
+                * on win32 this may take a second or two to re-enumerate */
+               while ((dev = find_jlink_device()) == NULL)
                {
-                       if ((dev->descriptor.idVendor == VID) && (dev->descriptor.idProduct == PID))
-                       {
-                               result->usb_handle = usb_open(dev);
+                       usleep(1000);
+                       timeout--;
+                       if (!timeout) {
+                               break;
+                       }
+               }
 
-                               /* usb_set_configuration required under win32 */
-                               usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
-                               usb_claim_interface(result->usb_handle, 0);
+               if (dev == NULL)
+               {
+                       free(result);
+                       return NULL;
+               }
+
+               result->usb_handle = usb_open(dev);
+#endif
+
+#endif
+
+               if (result->usb_handle)
+               {
+                       /* usb_set_configuration required under win32 */
+                       usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
+                       usb_claim_interface(result->usb_handle, 0);
 
 #if 0
-                               /*
-                                * This makes problems under Mac OS X. And is not needed
-                                * under Windows. Hopefully this will not break a linux build
-                                */
-                               usb_set_altinterface(result->usb_handle, 0);
+                       /*
+                        * This makes problems under Mac OS X. And is not needed
+                        * under Windows. Hopefully this will not break a linux build
+                        */
+                       usb_set_altinterface(result->usb_handle, 0);
 #endif
-                               struct usb_interface *iface = dev->config->interface;
-                               struct usb_interface_descriptor *desc = iface->altsetting;
-                               for (int i = 0; i < desc->bNumEndpoints; i++)
-                               {
-                                       uint8_t epnum = desc->endpoint[i].bEndpointAddress;
-                                       bool is_input = epnum & 0x80;
-                                       LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum);
-                                       if (is_input)
-                                               jlink_read_ep = epnum;
-                                       else
-                                               jlink_write_ep = epnum;
-                               }
-
-                               return result;
+                       struct usb_interface *iface = dev->config->interface;
+                       struct usb_interface_descriptor *desc = iface->altsetting;
+                       for (int i = 0; i < desc->bNumEndpoints; i++)
+                       {
+                               uint8_t epnum = desc->endpoint[i].bEndpointAddress;
+                               bool is_input = epnum & 0x80;
+                               LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum);
+                               if (is_input)
+                                       jlink_read_ep = epnum;
+                               else
+                                       jlink_write_ep = epnum;
                        }
+
+                       return result;
                }
        }
 
@@ -931,13 +990,13 @@ static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_le
                result2 = jlink_usb_read_emu_result(jlink_jtag);
                if (1 != result2)
                {
-                       LOG_ERROR("jlink_usb_read_emu_result retried requested=1, result=%d, in_length=%i", result2,in_length);
-                       /* Try again once, should only happen if (in_length%64==0) */
+                       LOG_ERROR("jlink_usb_read_emu_result retried requested = 1, result=%d, in_length=%i", result2,in_length);
+                       /* Try again once, should only happen if (in_length%64 == 0) */
                        result2 = jlink_usb_read_emu_result(jlink_jtag);
                        if (1 != result2)
                        {
                                LOG_ERROR("jlink_usb_read_emu_result failed "
-                                       "(requested=1, result=%d)", result2);
+                                       "(requested = 1, result=%d)", result2);
                                return ERROR_JTAG_DEVICE_ERROR;
                        }
                }