]> git.sur5r.net Git - openocd/blobdiff - src/jtag/jlink.c
scan_command_t -> struct scan_command
[openocd] / src / jtag / jlink.c
index b41731d2dc4e2255dfc976185479c76535f6d0ef..140949a445d7cd03b1479525f90710ffab05134a 100644 (file)
@@ -100,7 +100,7 @@ static void jlink_end_state(tap_state_t state);
 static void jlink_state_move(void);
 static void jlink_path_move(int num_states, tap_state_t *path);
 static void jlink_runtest(int num_cycles);
-static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command);
+static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command);
 static void jlink_reset(int trst, int srst);
 static void jlink_simple_command(uint8_t command);
 static int jlink_get_status(void);
@@ -110,20 +110,19 @@ static void jlink_tap_init(void);
 static int jlink_tap_execute(void);
 static void jlink_tap_ensure_space(int scans, int bits);
 static void jlink_tap_append_step(int tms, int tdi);
-static void jlink_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command);
+static void jlink_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command);
 
 /* Jlink lowlevel functions */
-typedef struct jlink_jtag
-{
+struct jlink {
        struct usb_dev_handle* usb_handle;
-} jlink_jtag_t;
+};
 
-static jlink_jtag_t *jlink_usb_open(void);
-static void jlink_usb_close(jlink_jtag_t *jlink_jtag);
-static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length);
-static int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length);
-static int jlink_usb_read(jlink_jtag_t *jlink_jtag, int expected_size);
-static int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag);
+static struct jlink *jlink_usb_open(void);
+static void jlink_usb_close(struct jlink *jlink);
+static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length);
+static int jlink_usb_write(struct jlink *jlink, int out_length);
+static int jlink_usb_read(struct jlink *jlink, int expected_size);
+static int jlink_usb_read_emu_result(struct jlink *jlink);
 
 /* helper functions */
 static int jlink_get_version_info(void);
@@ -134,12 +133,12 @@ static void jlink_debug_buffer(uint8_t *buffer, int length);
 
 static enum tap_state jlink_last_state = TAP_RESET;
 
-static jlink_jtag_t* jlink_jtag_handle;
+static struct jlink* jlink_handle;
 
 /***************************************************************************/
 /* External interface implementation */
 
-jtag_interface_t jlink_interface =
+struct jtag_interface jlink_interface =
 {
        .name = "jlink",
        .execute_queue = jlink_execute_queue,
@@ -267,7 +266,7 @@ static int jlink_speed(int speed)
        usb_out_buffer[1] = (speed >> 0) & 0xff;
        usb_out_buffer[2] = (speed >> 8) & 0xff;
 
-       result = jlink_usb_write(jlink_jtag_handle, 3);
+       result = jlink_usb_write(jlink_handle, 3);
        if (result != 3)
        {
                LOG_ERROR("J-Link setting speed failed (%d)", result);
@@ -307,14 +306,14 @@ static int jlink_init(void)
 {
        int i;
 
-       jlink_jtag_handle = jlink_usb_open();
+       jlink_handle = jlink_usb_open();
 
-       if (jlink_jtag_handle == 0)
+       if (jlink_handle == 0)
        {
                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
@@ -324,11 +323,11 @@ static int jlink_init(void)
         *      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);
-       sleep(1);
+       usleep(1000);
 
        jlink_hw_jtag_version = 2;
 
@@ -357,7 +356,7 @@ static int jlink_init(void)
 
 static int jlink_quit(void)
 {
-       jlink_usb_close(jlink_jtag_handle);
+       jlink_usb_close(jlink_handle);
        return ERROR_OK;
 }
 
@@ -450,7 +449,7 @@ static void jlink_runtest(int num_cycles)
        }
 }
 
-static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command)
+static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command)
 {
        tap_state_t saved_end_state;
 
@@ -499,12 +498,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();
        }
 }
 
@@ -515,7 +512,7 @@ static void jlink_simple_command(uint8_t command)
        DEBUG_JTAG_IO("0x%02x", command);
 
        usb_out_buffer[0] = command;
-       result = jlink_usb_write(jlink_jtag_handle, 1);
+       result = jlink_usb_write(jlink_handle, 1);
 
        if (result != 1)
        {
@@ -529,7 +526,7 @@ static int jlink_get_status(void)
 
        jlink_simple_command(EMU_CMD_GET_STATE);
 
-       result = jlink_usb_read(jlink_jtag_handle, 8);
+       result = jlink_usb_read(jlink_handle, 8);
        if (result != 8)
        {
                LOG_ERROR("J-Link command EMU_CMD_GET_STATE failed (%d)\n", result);
@@ -557,7 +554,7 @@ static int jlink_get_version_info(void)
        /* query hardware version */
        jlink_simple_command(EMU_CMD_VERSION);
 
-       result = jlink_usb_read(jlink_jtag_handle, 2);
+       result = jlink_usb_read(jlink_handle, 2);
        if (2 != result)
        {
                LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)\n", result);
@@ -571,7 +568,7 @@ static int jlink_get_version_info(void)
                len = JLINK_IN_BUFFER_SIZE;
        }
 
-       result = jlink_usb_read(jlink_jtag_handle, len);
+       result = jlink_usb_read(jlink_handle, len);
        if (result != len)
        {
                LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)\n", result);
@@ -584,7 +581,7 @@ static int jlink_get_version_info(void)
        /* query hardware capabilities */
        jlink_simple_command(EMU_CMD_GET_CAPS);
 
-       result = jlink_usb_read(jlink_jtag_handle, 4);
+       result = jlink_usb_read(jlink_handle, 4);
        if (4 != result)
        {
                LOG_ERROR("J-Link command EMU_CMD_GET_CAPS failed (%d)\n", result);
@@ -599,7 +596,7 @@ static int jlink_get_version_info(void)
                /* query hardware version */
                jlink_simple_command(EMU_CMD_GET_HW_VERSION);
 
-               result = jlink_usb_read(jlink_jtag_handle, 4);
+               result = jlink_usb_read(jlink_handle, 4);
                if (4 != result)
                {
                        LOG_ERROR("J-Link command EMU_CMD_GET_HW_VERSION failed (%d)\n", result);
@@ -619,7 +616,7 @@ static int jlink_get_version_info(void)
                /* query hardware maximum memory block */
                jlink_simple_command(EMU_CMD_GET_MAX_MEM_BLOCK);
 
-               result = jlink_usb_read(jlink_jtag_handle, 4);
+               result = jlink_usb_read(jlink_handle, 4);
                if (4 != result)
                {
                        LOG_ERROR("J-Link command EMU_CMD_GET_MAX_MEM_BLOCK failed (%d)\n", result);
@@ -677,18 +674,17 @@ 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];
 
-typedef struct
-{
+struct pending_scan_result {
        int first;      /* First bit position in tdo_buffer to read */
        int length; /* Number of bits to read */
-       scan_command_t *command; /* Corresponding scan command */
+       struct scan_command *command; /* Corresponding scan command */
        uint8_t *buffer;
-} pending_scan_result_t;
+};
 
 #define MAX_PENDING_SCAN_RESULTS 256
 
 static int pending_scan_results_length;
-static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
+static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
 
 static void jlink_tap_init(void)
 {
@@ -740,9 +736,9 @@ static void jlink_tap_append_step(int tms, int tdi)
        tap_length++;
 }
 
-static void jlink_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command)
+static void jlink_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
 {
-       pending_scan_result_t *pending_scan_result =
+       struct pending_scan_result *pending_scan_result =
                &pending_scan_results_buffer[pending_scan_results_length];
        int i;
 
@@ -792,7 +788,7 @@ static int jlink_tap_execute(void)
        jlink_last_state = jtag_debug_state_machine(tms_buffer, tdi_buffer,
                        tap_length, jlink_last_state);
 
-       result = jlink_usb_message(jlink_jtag_handle, 4 + 2 * byte_length, byte_length);
+       result = jlink_usb_message(jlink_handle, 4 + 2 * byte_length, byte_length);
        if (result != byte_length)
        {
                LOG_ERROR("jlink_tap_execute, wrong result %d (expected %d)", result, byte_length);
@@ -804,11 +800,11 @@ static int jlink_tap_execute(void)
 
        for (i = 0; i < pending_scan_results_length; i++)
        {
-               pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
+               struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
                uint8_t *buffer = pending_scan_result->buffer;
                int length = pending_scan_result->length;
                int first = pending_scan_result->first;
-               scan_command_t *command = pending_scan_result->command;
+               struct scan_command *command = pending_scan_result->command;
 
                /* Copy to buffer */
                buf_set_buf(tdo_buffer, first, buffer, 0, length);
@@ -835,70 +831,119 @@ static int jlink_tap_execute(void)
        return ERROR_OK;
 }
 
-/*****************************************************************************/
-/* JLink USB low-level functions */
-
-static jlink_jtag_t* jlink_usb_open()
+static struct usb_device* find_jlink_device(void)
 {
        struct usb_bus *busses;
        struct usb_bus *bus;
        struct usb_device *dev;
 
-       jlink_jtag_t *result;
-
-       result = (jlink_jtag_t*) malloc(sizeof(jlink_jtag_t));
-
-       usb_init();
        usb_find_busses();
        usb_find_devices();
 
        busses = usb_get_busses();
 
-       /* find jlink_jtag device in usb bus */
+       /* find jlink 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))
-                       {
-                               result->usb_handle = usb_open(dev);
-                               
-                               /*
-                                *      Some j-link dongles experience intermittent communication issues at startup to varying degrees
-                                *      depending on the host operating system.  Troubleshooting this problem all the way back to libusb
-                                *      revealed that without a usb reset, the hardware can start in an uncertain state causing a litany
-                                *      of annoying problems.  The next step was added to the original code to address this problem.
-                                */
-                               
-                               usb_reset(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 ((dev->descriptor.idVendor == VID) && (dev->descriptor.idProduct == PID)) {
+                               return dev;
+                       }
+               }
+       }
+
+       return NULL;
+}
+
+/*****************************************************************************/
+/* JLink USB low-level functions */
+
+static struct jlink* jlink_usb_open()
+{
+       struct usb_device *dev;
+
+       struct jlink *result;
+
+       result = (struct jlink*) malloc(sizeof(struct jlink));
+
+       usb_init();
+
+       if ((dev = find_jlink_device()) == NULL) {
+               free(result);
+               return NULL;
+       }
+
+       result->usb_handle = usb_open(dev);
+
+       if (result->usb_handle)
+       {
+
+               /* 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)
+               {
+                       usleep(1000);
+                       timeout--;
+                       if (!timeout) {
+                               break;
+                       }
+               }
+
+               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;
                }
        }
 
@@ -906,18 +951,18 @@ static jlink_jtag_t* jlink_usb_open()
        return NULL;
 }
 
-static void jlink_usb_close(jlink_jtag_t *jlink_jtag)
+static void jlink_usb_close(struct jlink *jlink)
 {
-       usb_close(jlink_jtag->usb_handle);
-       free(jlink_jtag);
+       usb_close(jlink->usb_handle);
+       free(jlink);
 }
 
 /* Send a message and receive the reply. */
-static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length)
+static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length)
 {
        int result;
 
-       result = jlink_usb_write(jlink_jtag, out_length);
+       result = jlink_usb_write(jlink, out_length);
        if (result != out_length)
        {
                LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)",
@@ -925,7 +970,7 @@ static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_le
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
-       result = jlink_usb_read(jlink_jtag, in_length);
+       result = jlink_usb_read(jlink, in_length);
        if ((result != in_length) && (result != (in_length + 1)))
        {
                LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
@@ -940,12 +985,12 @@ static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_le
        if (result == in_length)
        {
                /* Must read the result from the EMU too */
-               result2 = jlink_usb_read_emu_result(jlink_jtag);
+               result2 = jlink_usb_read_emu_result(jlink);
                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) */
-                       result2 = jlink_usb_read_emu_result(jlink_jtag);
+                       result2 = jlink_usb_read_emu_result(jlink);
                        if (1 != result2)
                        {
                                LOG_ERROR("jlink_usb_read_emu_result failed "
@@ -1013,17 +1058,17 @@ static inline int usb_bulk_read_ex(usb_dev_handle *dev, int ep,
 }
 
 /* Write data from out_buffer to USB. */
-static int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length)
+static int jlink_usb_write(struct jlink *jlink, int out_length)
 {
        int result;
 
        if (out_length > JLINK_OUT_BUFFER_SIZE)
        {
-               LOG_ERROR("jlink_jtag_write illegal out_length=%d (max=%d)", out_length, JLINK_OUT_BUFFER_SIZE);
+               LOG_ERROR("jlink_write illegal out_length=%d (max=%d)", out_length, JLINK_OUT_BUFFER_SIZE);
                return -1;
        }
 
-       result = usb_bulk_write_ex(jlink_jtag->usb_handle, jlink_write_ep,
+       result = usb_bulk_write_ex(jlink->usb_handle, jlink_write_ep,
                (char *)usb_out_buffer, out_length, JLINK_USB_TIMEOUT);
 
        DEBUG_JTAG_IO("jlink_usb_write, out_length = %d, result = %d", out_length, result);
@@ -1035,9 +1080,9 @@ static int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length)
 }
 
 /* Read data from USB into in_buffer. */
-static int jlink_usb_read(jlink_jtag_t *jlink_jtag, int expected_size)
+static int jlink_usb_read(struct jlink *jlink, int expected_size)
 {
-       int result = usb_bulk_read_ex(jlink_jtag->usb_handle, jlink_read_ep,
+       int result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
                (char *)usb_in_buffer, expected_size, JLINK_USB_TIMEOUT);
 
        DEBUG_JTAG_IO("jlink_usb_read, result = %d", result);
@@ -1049,9 +1094,9 @@ static int jlink_usb_read(jlink_jtag_t *jlink_jtag, int expected_size)
 }
 
 /* Read the result from the previous EMU cmd into result_buffer. */
-static int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag)
+static int jlink_usb_read_emu_result(struct jlink *jlink)
 {
-       int result = usb_bulk_read_ex(jlink_jtag->usb_handle, jlink_read_ep,
+       int result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
                (char *)usb_emu_result_buffer, 1 /* JLINK_EMU_RESULT_BUFFER_SIZE */,
                JLINK_USB_TIMEOUT);