drivers: call adapter_get_required_serial() in jtag_libusb_open()
[fw/openocd] / src / jtag / drivers / arm-jtag-ew.c
index 35b6b929f18420343eb820578ce6ce6a18beb129..703378940b60ac76ee8cdb33dc106048198e7ed9 100644 (file)
@@ -13,9 +13,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -24,8 +22,8 @@
 
 #include <jtag/interface.h>
 #include <jtag/commands.h>
-#include <usb.h>
-#include "usb_common.h"
+#include "helper/system.h"
+#include "libusb_helper.h"
 
 #define USB_VID                                                0x15ba
 #define USB_PID                                                0x001e
@@ -77,7 +75,7 @@ static void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_c
 
 /* ARM-JTAG-EW lowlevel functions */
 struct armjtagew {
-       struct usb_dev_handle *usb_handle;
+       struct libusb_device_handle *usb_handle;
 };
 
 static struct armjtagew *armjtagew_usb_open(void);
@@ -105,11 +103,11 @@ static int armjtagew_execute_queue(void)
        enum scan_type type;
        uint8_t *buffer;
 
-       while (cmd != NULL) {
+       while (cmd) {
                switch (cmd->type) {
                        case JTAG_RUNTEST:
-                               DEBUG_JTAG_IO("runtest %i cycles, end in %i",
-                                               cmd->cmd.runtest->num_cycles, \
+                               LOG_DEBUG_IO("runtest %i cycles, end in %i",
+                                               cmd->cmd.runtest->num_cycles,
                                                cmd->cmd.runtest->end_state);
 
                                armjtagew_end_state(cmd->cmd.runtest->end_state);
@@ -117,15 +115,15 @@ static int armjtagew_execute_queue(void)
                                break;
 
                        case JTAG_TLR_RESET:
-                               DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
+                               LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
 
                                armjtagew_end_state(cmd->cmd.statemove->end_state);
                                armjtagew_state_move();
                                break;
 
                        case JTAG_PATHMOVE:
-                               DEBUG_JTAG_IO("pathmove: %i states, end in %i", \
-                                               cmd->cmd.pathmove->num_states, \
+                               LOG_DEBUG_IO("pathmove: %i states, end in %i",
+                                               cmd->cmd.pathmove->num_states,
                                                cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
 
                                armjtagew_path_move(cmd->cmd.pathmove->num_states,
@@ -133,12 +131,12 @@ static int armjtagew_execute_queue(void)
                                break;
 
                        case JTAG_SCAN:
-                               DEBUG_JTAG_IO("scan end in %i", cmd->cmd.scan->end_state);
+                               LOG_DEBUG_IO("scan end in %i", cmd->cmd.scan->end_state);
 
                                armjtagew_end_state(cmd->cmd.scan->end_state);
 
                                scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
-                               DEBUG_JTAG_IO("scan input, length = %d", scan_size);
+                               LOG_DEBUG_IO("scan input, length = %d", scan_size);
 
 #ifdef _DEBUG_USB_COMMS_
                                armjtagew_debug_buffer(buffer, (scan_size + 7) / 8);
@@ -150,7 +148,7 @@ static int armjtagew_execute_queue(void)
                                break;
 
                        case JTAG_RESET:
-                               DEBUG_JTAG_IO("reset trst: %i srst %i",
+                               LOG_DEBUG_IO("reset trst: %i srst %i",
                                                cmd->cmd.reset->trst,
                                                cmd->cmd.reset->srst);
 
@@ -162,7 +160,7 @@ static int armjtagew_execute_queue(void)
                                break;
 
                        case JTAG_SLEEP:
-                               DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
+                               LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
                                armjtagew_tap_execute();
                                jtag_sleep(cmd->cmd.sleep->us);
                                break;
@@ -355,7 +353,10 @@ static void armjtagew_scan(bool ir_scan,
        /* Move to appropriate scan state */
        armjtagew_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
 
-       armjtagew_state_move();
+       /* Only move if we're not already there */
+       if (tap_get_state() != tap_get_end_state())
+               armjtagew_state_move();
+
        armjtagew_end_state(saved_end_state);
 
        /* Scan */
@@ -458,10 +459,10 @@ static int armjtagew_get_version_info(void)
        auxinfo[256] = '\0';
 
        LOG_INFO(
-               "ARM-JTAG-EW firmware version %d.%d, hardware revision %c, SN=%s, Additional info: %s", \
+               "ARM-JTAG-EW firmware version %d.%d, hardware revision %c, SN=%s, Additional info: %s",
                usb_in_buffer[1],
-               usb_in_buffer[0], \
-               isgraph(usb_in_buffer[2]) ? usb_in_buffer[2] : 'X', \
+               usb_in_buffer[0],
+               isgraph(usb_in_buffer[2]) ? usb_in_buffer[2] : 'X',
                sn,
                auxinfo);
 
@@ -489,20 +490,27 @@ static const struct command_registration armjtagew_command_handlers[] = {
                .handler = &armjtagew_handle_armjtagew_info_command,
                .mode = COMMAND_EXEC,
                .help = "query armjtagew info",
+               .usage = "",
        },
        COMMAND_REGISTRATION_DONE
 };
 
-struct jtag_interface armjtagew_interface = {
+static struct jtag_interface armjtagew_interface = {
+       .execute_queue = armjtagew_execute_queue,
+};
+
+struct adapter_driver armjtagew_adapter_driver = {
        .name = "arm-jtag-ew",
-       .commands = armjtagew_command_handlers,
        .transports = jtag_only,
-       .execute_queue = armjtagew_execute_queue,
-       .speed = armjtagew_speed,
-       .speed_div = armjtagew_speed_div,
-       .khz = armjtagew_khz,
+       .commands = armjtagew_command_handlers,
+
        .init = armjtagew_init,
        .quit = armjtagew_quit,
+       .speed = armjtagew_speed,
+       .khz = armjtagew_khz,
+       .speed_div = armjtagew_speed_div,
+
+       .jtag_ops = &armjtagew_interface,
 };
 
 /**************************************************************************
@@ -645,7 +653,7 @@ static int armjtagew_tap_execute(void)
                                /* Copy to buffer */
                                buf_set_buf(tdo_buffer, first, buffer, 0, length);
 
-                               DEBUG_JTAG_IO("pending scan result, length = %d", length);
+                               LOG_DEBUG_IO("pending scan result, length = %d", length);
 
 #ifdef _DEBUG_USB_COMMS_
                                armjtagew_debug_buffer(buffer, byte_length);
@@ -656,8 +664,7 @@ static int armjtagew_tap_execute(void)
                                        return ERROR_JTAG_QUEUE_FAILED;
                                }
 
-                               if (pending_scan_result->buffer != NULL)
-                                       free(pending_scan_result->buffer);
+                               free(pending_scan_result->buffer);
                        }
                } else {
                        LOG_ERROR("armjtagew_tap_execute, wrong result %d, expected %d",
@@ -675,37 +682,39 @@ static int armjtagew_tap_execute(void)
 /****************************************************************************
  * JLink USB low-level functions */
 
-static struct armjtagew *armjtagew_usb_open()
+static struct armjtagew *armjtagew_usb_open(void)
 {
-       usb_init();
-
        const uint16_t vids[] = { USB_VID, 0 };
        const uint16_t pids[] = { USB_PID, 0 };
-       struct usb_dev_handle *dev;
-       if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
+       struct libusb_device_handle *dev;
+
+       if (jtag_libusb_open(vids, pids, &dev, NULL) != ERROR_OK)
                return NULL;
 
        struct armjtagew *result = malloc(sizeof(struct armjtagew));
        result->usb_handle = dev;
 
 #if 0
-       /* usb_set_configuration required under win32 */
-       usb_set_configuration(dev, dev->config[0].bConfigurationValue);
+       /* libusb_set_configuration required under win32 */
+       struct libusb_config_descriptor *config;
+       struct libusb_device *usb_dev = libusb_get_device(dev);
+       libusb_get_config_descriptor(usb_dev, 0, &config);
+       libusb_set_configuration(dev, config->bConfigurationValue);
 #endif
-       usb_claim_interface(dev, 0);
+       libusb_claim_interface(dev, 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(dev, 0);
+       libusb_set_interface_alt_setting(dev, 0, 0);
 #endif
        return result;
 }
 
 static void armjtagew_usb_close(struct armjtagew *armjtagew)
 {
-       usb_close(armjtagew->usb_handle);
+       libusb_close(armjtagew->usb_handle);
        free(armjtagew);
 }
 
@@ -718,13 +727,13 @@ static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, in
        if (result == out_length) {
                result = armjtagew_usb_read(armjtagew, in_length);
                if (result != in_length) {
-                       LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
+                       LOG_ERROR("jtag_libusb_bulk_read failed (requested=%d, result=%d)",
                                in_length,
                                result);
                        return -1;
                }
        } else {
-               LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
+               LOG_ERROR("jtag_libusb_bulk_write failed (requested=%d, result=%d)", out_length, result);
                return -1;
        }
        return 0;
@@ -734,6 +743,7 @@ static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, in
 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
 {
        int result;
+       int transferred;
 
        if (out_length > ARMJTAGEW_OUT_BUFFER_SIZE) {
                LOG_ERROR("armjtagew_write illegal out_length=%d (max=%d)",
@@ -742,29 +752,34 @@ static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
                return -1;
        }
 
-       result = usb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
-                       (char *)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT);
+       result = jtag_libusb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT,
+                       (char *)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT, &transferred);
 
-       DEBUG_JTAG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
+       LOG_DEBUG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
 
 #ifdef _DEBUG_USB_COMMS_
        armjtagew_debug_buffer(usb_out_buffer, out_length);
 #endif
-       return result;
+       if (result != ERROR_OK)
+               return -1;
+       return transferred;
 }
 
 /* Read data from USB into in_buffer. */
 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length)
 {
-       int result = usb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
-                       (char *)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT);
+       int transferred;
+       int result = jtag_libusb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN,
+                       (char *)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT, &transferred);
 
-       DEBUG_JTAG_IO("armjtagew_usb_read, result = %d", result);
+       LOG_DEBUG_IO("armjtagew_usb_read, result = %d", result);
 
 #ifdef _DEBUG_USB_COMMS_
        armjtagew_debug_buffer(usb_in_buffer, result);
 #endif
-       return result;
+       if (result != ERROR_OK)
+               return -1;
+       return transferred;
 }
 
 #ifdef _DEBUG_USB_COMMS_