ULINK driver: port from libusb-0.1 to libusb-1.0 API
[openocd.git] / src / jtag / drivers / ulink.c
index 4de1a77035dfb6bef35e9db5c8d01e81ba0fe1b0..94f6c31534df78c39f1c332ab8d9935e65a9a98a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2011 by Martin Schmoelzer                               *
+ *   Copyright (C) 2011-2013 by Martin Schmoelzer                          *
  *   <martin.schmoelzer@student.tuwien.ac.at>                              *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,7 +15,7 @@
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -26,8 +26,7 @@
 #include <jtag/interface.h>
 #include <jtag/commands.h>
 #include <target/image.h>
-#include <helper/types.h>
-#include "usb_common.h"
+#include <libusb-1.0/libusb.h>
 #include "OpenULINK/include/msgtypes.h"
 
 /** USB Vendor ID of ULINK device in unconfigured state (no firmware loaded
@@ -64,7 +63,7 @@
 #define ULINK_RENUMERATION_DELAY 1500000
 
 /** Default location of OpenULINK firmware image. */
-#define ULINK_FIRMWARE_FILE      PKGLIBDIR "/OpenULINK/ulink_firmware.hex"
+#define ULINK_FIRMWARE_FILE      PKGDATADIR "/OpenULINK/ulink_firmware.hex"
 
 /** Maximum size of a single firmware section. Entire EZ-USB code space = 8kB */
 #define SECTION_BUFFERSIZE       8192
@@ -147,7 +146,8 @@ struct ulink_cmd {
 
 /** Describes one driver instance */
 struct ulink {
-       struct usb_dev_handle *usb_handle;
+       struct libusb_context *libusb_ctx;
+       struct libusb_device_handle *usb_device_handle;
        enum ulink_type type;
 
        int delay_scan_in;      /* /< Delay value for SCAN_IN commands */
@@ -168,7 +168,7 @@ int ulink_usb_open(struct ulink **device);
 int ulink_usb_close(struct ulink **device);
 
 /* ULINK MCU (Cypress EZ-USB) specific functions */
-int ulink_cpu_reset(struct ulink *device, char reset_bit);
+int ulink_cpu_reset(struct ulink *device, unsigned char reset_bit);
 int ulink_load_firmware_and_renumerate(struct ulink **device, char *filename,
                uint32_t delay);
 int ulink_load_firmware(struct ulink *device, char *filename);
@@ -259,30 +259,46 @@ struct ulink *ulink_handle;
 /**
  * Opens the ULINK device and claims its USB interface.
  *
+ * Currently, only the original ULINK is supported
+ *
  * @param device pointer to struct ulink identifying ULINK driver instance.
  * @return on success: ERROR_OK
  * @return on failure: ERROR_FAIL
  */
 int ulink_usb_open(struct ulink **device)
 {
-       int ret;
-       struct usb_dev_handle *usb_handle;
+       ssize_t num_devices, i;
+       bool found;
+       libusb_device **usb_devices;
+       struct libusb_device_descriptor usb_desc;
+       struct libusb_device_handle *usb_device_handle;
 
-       /* Currently, only original ULINK is supported */
-       uint16_t vids[] = { ULINK_VID, 0 };
-       uint16_t pids[] = { ULINK_PID, 0 };
+       num_devices = libusb_get_device_list((*device)->libusb_ctx, &usb_devices);
 
-       ret = jtag_usb_open(vids, pids, &usb_handle);
+       if (num_devices <= 0)
+               return ERROR_FAIL;
 
-       if (ret != ERROR_OK)
-               return ret;
+       found = false;
+       for (i = 0; i < num_devices; i++) {
+               if (libusb_get_device_descriptor(usb_devices[i], &usb_desc) != 0)
+                       continue;
+               else if (usb_desc.idVendor == ULINK_VID && usb_desc.idProduct == ULINK_PID) {
+                       found = true;
+                       break;
+               }
+       }
 
-       ret = usb_claim_interface(usb_handle, 0);
+       if (!found)
+               return ERROR_FAIL;
 
-       if (ret != 0)
-               return ret;
+       if (libusb_open(usb_devices[i], &usb_device_handle) != 0)
+               return ERROR_FAIL;
+       libusb_free_device_list(usb_devices, 1);
 
-       (*device)->usb_handle = usb_handle;
+       if (libusb_claim_interface(usb_device_handle, 0) != 0)
+               return ERROR_FAIL;
+
+       (*device)->usb_device_handle = usb_device_handle;
        (*device)->type = ULINK_1;
 
        return ERROR_OK;
@@ -297,13 +313,12 @@ int ulink_usb_open(struct ulink **device)
  */
 int ulink_usb_close(struct ulink **device)
 {
-       if (usb_release_interface((*device)->usb_handle, 0) != 0)
+       if (libusb_release_interface((*device)->usb_device_handle, 0) != 0)
                return ERROR_FAIL;
 
-       if (usb_close((*device)->usb_handle) != 0)
-               return ERROR_FAIL;
+       libusb_close((*device)->usb_device_handle);
 
-       (*device)->usb_handle = NULL;
+       (*device)->usb_device_handle = NULL;
 
        return ERROR_OK;
 }
@@ -319,12 +334,12 @@ int ulink_usb_close(struct ulink **device)
  * @return on success: ERROR_OK
  * @return on failure: ERROR_FAIL
  */
-int ulink_cpu_reset(struct ulink *device, char reset_bit)
+int ulink_cpu_reset(struct ulink *device, unsigned char reset_bit)
 {
        int ret;
 
-       ret = usb_control_msg(device->usb_handle,
-                       (USB_ENDPOINT_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE),
+       ret = libusb_control_transfer(device->usb_device_handle,
+                       (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE),
                        REQUEST_FIRMWARE_LOAD, CPUCS_REG, 0, &reset_bit, 1, USB_TIMEOUT);
 
        /* usb_control_msg() returns the number of bytes transferred during the
@@ -468,9 +483,9 @@ int ulink_write_firmware_section(struct ulink *device,
                else
                        chunk_size = bytes_remaining;
 
-               ret = usb_control_msg(device->usb_handle,
-                               (USB_ENDPOINT_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE),
-                               REQUEST_FIRMWARE_LOAD, addr, FIRMWARE_ADDR, (char *)data_ptr,
+               ret = libusb_control_transfer(device->usb_device_handle,
+                               (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE),
+                               REQUEST_FIRMWARE_LOAD, addr, FIRMWARE_ADDR, (unsigned char *)data_ptr,
                                chunk_size, USB_TIMEOUT);
 
                if (ret != (int)chunk_size) {
@@ -533,6 +548,7 @@ int ulink_allocate_payload(struct ulink_cmd *ulink_cmd, int size,
            case PAYLOAD_DIRECTION_OUT:
                    if (ulink_cmd->payload_out != NULL) {
                            LOG_ERROR("BUG: Duplicate payload allocation for OpenULINK command");
+                           free(payload);
                            return ERROR_FAIL;
                    } else {
                            ulink_cmd->payload_out = payload;
@@ -542,6 +558,7 @@ int ulink_allocate_payload(struct ulink_cmd *ulink_cmd, int size,
            case PAYLOAD_DIRECTION_IN:
                    if (ulink_cmd->payload_in_start != NULL) {
                            LOG_ERROR("BUG: Duplicate payload allocation for OpenULINK command");
+                           free(payload);
                            return ERROR_FAIL;
                    } else {
                            ulink_cmd->payload_in_start = payload;
@@ -693,7 +710,7 @@ int ulink_append_queue(struct ulink *device, struct ulink_cmd *ulink_cmd)
 int ulink_execute_queued_commands(struct ulink *device, int timeout)
 {
        struct ulink_cmd *current;
-       int ret, i, index_out, index_in, count_out, count_in;
+       int ret, i, index_out, index_in, count_out, count_in, transferred;
        uint8_t buffer[64];
 
 #ifdef _DEBUG_JTAG_IO_
@@ -718,20 +735,20 @@ int ulink_execute_queued_commands(struct ulink *device, int timeout)
        }
 
        /* Send packet to ULINK */
-       ret = usb_bulk_write(device->usb_handle, (2 | USB_ENDPOINT_OUT),
-                       (char *)buffer, count_out, timeout);
-       if (ret < 0)
+       ret = libusb_bulk_transfer(device->usb_device_handle, (2 | LIBUSB_ENDPOINT_OUT),
+                       (unsigned char *)buffer, count_out, &transferred, timeout);
+       if (ret != 0)
                return ERROR_FAIL;
-       if (ret != count_out)
+       if (transferred != count_out)
                return ERROR_FAIL;
 
        /* Wait for response if commands contain IN payload data */
        if (count_in > 0) {
-               ret = usb_bulk_read(device->usb_handle, (2 | USB_ENDPOINT_IN),
-                               (char *)buffer, 64, timeout);
-               if (ret < 0)
+               ret = libusb_bulk_transfer(device->usb_device_handle, (2 | LIBUSB_ENDPOINT_IN),
+                               (unsigned char *)buffer, 64, &transferred, timeout);
+               if (ret != 0)
                        return ERROR_FAIL;
-               if (ret != count_in)
+               if (transferred != count_in)
                        return ERROR_FAIL;
 
                /* Write back IN payload data */
@@ -897,6 +914,7 @@ int ulink_append_scan_cmd(struct ulink *device, enum scan_type scan_type,
        if (scan_size_bits > (58 * 8)) {
                LOG_ERROR("BUG: Tried to create CMD_SCAN_IO OpenULINK command with too"
                        " large payload");
+               free(cmd);
                return ERROR_FAIL;
        }
 
@@ -935,8 +953,10 @@ int ulink_append_scan_cmd(struct ulink *device, enum scan_type scan_type,
                    break;
        }
 
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        /* Build payload_out that is common to all scan types */
        cmd->payload_out[0] = scan_size_bytes & 0xFF;
@@ -994,8 +1014,10 @@ int ulink_append_clock_tms_cmd(struct ulink *device, uint8_t count,
 
        /* CMD_CLOCK_TMS has two OUT payload bytes and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = count;
        cmd->payload_out[1] = sequence;
@@ -1028,8 +1050,10 @@ int ulink_append_clock_tck_cmd(struct ulink *device, uint16_t count)
 
        /* CMD_CLOCK_TCK has two OUT payload bytes and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = count & 0xff;
        cmd->payload_out[1] = (count >> 8) & 0xff;
@@ -1058,8 +1082,10 @@ int ulink_append_get_signals_cmd(struct ulink *device)
        /* CMD_GET_SIGNALS has two IN payload bytes */
        ret = ulink_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_IN);
 
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        return ulink_append_queue(device, cmd);
 }
@@ -1095,8 +1121,10 @@ int ulink_append_set_signals_cmd(struct ulink *device, uint8_t low,
        /* CMD_SET_SIGNALS has two OUT payload bytes and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
 
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = low;
        cmd->payload_out[1] = high;
@@ -1125,8 +1153,10 @@ int ulink_append_sleep_cmd(struct ulink *device, uint32_t us)
        /* CMD_SLEEP_US has two OUT payload bytes and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
 
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = us & 0x00ff;
        cmd->payload_out[1] = (us >> 8) & 0x00ff;
@@ -1160,8 +1190,10 @@ int ulink_append_configure_tck_cmd(struct ulink *device, int delay_scan_in,
        /* CMD_CONFIGURE_TCK_FREQ has five OUT payload bytes and zero
         * IN payload bytes */
        ret = ulink_allocate_payload(cmd, 5, PAYLOAD_DIRECTION_OUT);
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        if (delay_scan_in < 0)
                cmd->payload_out[0] = 0;
@@ -1218,8 +1250,10 @@ int ulink_append_led_cmd(struct ulink *device, uint8_t led_state)
 
        /* CMD_SET_LEDS has one OUT payload byte and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 1, PAYLOAD_DIRECTION_OUT);
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = led_state;
 
@@ -1246,8 +1280,10 @@ int ulink_append_test_cmd(struct ulink *device)
 
        /* CMD_TEST has one OUT payload byte and zero IN payload bytes */
        ret = ulink_allocate_payload(cmd, 1, PAYLOAD_DIRECTION_OUT);
-       if (ret != ERROR_OK)
+       if (ret != ERROR_OK) {
+               free(cmd);
                return ret;
+       }
 
        cmd->payload_out[0] = 0xAA;
 
@@ -2122,26 +2158,28 @@ static int ulink_speed_div(int speed, int *khz)
  */
 static int ulink_init(void)
 {
-       int ret;
+       int ret, transferred;
        char str_manufacturer[20];
        bool download_firmware = false;
-       uint8_t *dummy;
+       unsigned char *dummy;
        uint8_t input_signals, output_signals;
 
        ulink_handle = calloc(1, sizeof(struct ulink));
        if (ulink_handle == NULL)
                return ERROR_FAIL;
 
-       usb_init();
+       libusb_init(&ulink_handle->libusb_ctx);
 
        ret = ulink_usb_open(&ulink_handle);
        if (ret != ERROR_OK) {
                LOG_ERROR("Could not open ULINK device");
+               free(ulink_handle);
+               ulink_handle = NULL;
                return ret;
        }
 
        /* Get String Descriptor to determine if firmware needs to be loaded */
-       ret = usb_get_string_simple(ulink_handle->usb_handle, 1, str_manufacturer, 20);
+       ret = libusb_get_string_descriptor_ascii(ulink_handle->usb_device_handle, 1, (unsigned char *)str_manufacturer, 20);
        if (ret < 0) {
                /* Could not get descriptor -> Unconfigured or original Keil firmware */
                download_firmware = true;
@@ -2158,6 +2196,8 @@ static int ulink_init(void)
                                ULINK_FIRMWARE_FILE, ULINK_RENUMERATION_DELAY);
                if (ret != ERROR_OK) {
                        LOG_ERROR("Could not download firmware and re-numerate ULINK");
+                       free(ulink_handle);
+                       ulink_handle = NULL;
                        return ret;
                }
        } else
@@ -2178,15 +2218,17 @@ static int ulink_init(void)
                 * shut down by the user via Ctrl-C. Try to retrieve this Bulk IN packet. */
                dummy = calloc(64, sizeof(uint8_t));
 
-               ret = usb_bulk_read(ulink_handle->usb_handle, (2 | USB_ENDPOINT_IN),
-                               (char *)dummy, 64, 200);
+               ret = libusb_bulk_transfer(ulink_handle->usb_device_handle, (2 | LIBUSB_ENDPOINT_IN),
+                               dummy, 64, &transferred, 200);
 
                free(dummy);
 
-               if (ret < 0) {
+               if (ret != 0 || transferred == 0) {
                        /* Bulk IN transfer failed -> unrecoverable error condition */
                        LOG_ERROR("Cannot communicate with ULINK device. Disconnect ULINK from "
                                "the USB port and re-connect, then re-run OpenOCD");
+                       free(ulink_handle);
+                       ulink_handle = NULL;
                        return ERROR_FAIL;
                }
 #ifdef _DEBUG_USB_COMMS_

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)