openocd: fix SPDX tag format for files .c
[fw/openocd] / src / jtag / drivers / vsllink.c
index f82dff911666ad87a8f33222759705182a47b31c..255ff88a2fb04ba5f0bfa64e60783fa4903a864a 100644 (file)
@@ -1,20 +1,7 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2009-2010 by Simon Qian <SimonQian@SimonQian.com>       *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 /* Versaloon is a programming tool for multiple MCUs.
@@ -26,6 +13,7 @@
 #include "config.h"
 #endif
 
+#include <jtag/adapter.h>
 #include <jtag/interface.h>
 #include <jtag/commands.h>
 #include <jtag/swd.h>
@@ -61,7 +49,7 @@ static void vsllink_runtest(int num_cycles);
 static void vsllink_stableclocks(int num_cycles, int tms);
 static void vsllink_scan(bool ir_scan, enum scan_type type,
                uint8_t *buffer, int scan_size, struct scan_command *command);
-static void vsllink_reset(int trst, int srst);
+static int vsllink_reset(int trst, int srst);
 
 /* VSLLink tap buffer functions */
 static void vsllink_tap_append_step(int tms, int tdi);
@@ -72,10 +60,8 @@ static void vsllink_tap_append_scan(int length, uint8_t *buffer,
                struct scan_command *command);
 
 /* VSLLink SWD functions */
-static int_least32_t vsllink_swd_frequency(struct adiv5_dap *dap,
-               int_least32_t hz);
-static int vsllink_swd_switch_seq(struct adiv5_dap *dap,
-               enum swd_special_seq seq);
+static int_least32_t vsllink_swd_frequency(int_least32_t hz);
+static int vsllink_swd_switch_seq(enum swd_special_seq seq);
 
 /* VSLLink lowlevel functions */
 struct vsllink {
@@ -86,9 +72,7 @@ struct vsllink {
 static int vsllink_usb_open(struct vsllink *vsllink);
 static void vsllink_usb_close(struct vsllink *vsllink);
 
-#if defined _DEBUG_JTAG_IO_
 static void vsllink_debug_buffer(uint8_t *buffer, int length);
-#endif
 
 static int tap_length;
 static int tap_buffer_size;
@@ -107,14 +91,14 @@ static int vsllink_execute_queue(void)
        enum scan_type type;
        uint8_t *buffer;
 
-       DEBUG_JTAG_IO("-------------------------------------"
+       LOG_DEBUG_IO("-------------------------------------"
                " vsllink "
                "-------------------------------------");
 
-       while (cmd != NULL) {
+       while (cmd) {
                switch (cmd->type) {
                        case JTAG_RUNTEST:
-                               DEBUG_JTAG_IO("runtest %i cycles, end in %s",
+                               LOG_DEBUG_IO("runtest %i cycles, end in %s",
                                                cmd->cmd.runtest->num_cycles,
                                                tap_state_name(cmd->cmd.runtest->end_state));
 
@@ -123,7 +107,7 @@ static int vsllink_execute_queue(void)
                                break;
 
                        case JTAG_TLR_RESET:
-                               DEBUG_JTAG_IO("statemove end in %s",
+                               LOG_DEBUG_IO("statemove end in %s",
                                                tap_state_name(cmd->cmd.statemove->end_state));
 
                                vsllink_end_state(cmd->cmd.statemove->end_state);
@@ -131,7 +115,7 @@ static int vsllink_execute_queue(void)
                                break;
 
                        case JTAG_PATHMOVE:
-                               DEBUG_JTAG_IO("pathmove: %i states, end in %s",
+                               LOG_DEBUG_IO("pathmove: %i states, end in %s",
                                                cmd->cmd.pathmove->num_states,
                                                tap_state_name(cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]));
 
@@ -139,7 +123,7 @@ static int vsllink_execute_queue(void)
                                break;
 
                        case JTAG_SCAN:
-                               DEBUG_JTAG_IO("JTAG Scan...");
+                               LOG_DEBUG_IO("JTAG Scan...");
 
                                vsllink_end_state(cmd->cmd.scan->end_state);
 
@@ -147,23 +131,21 @@ static int vsllink_execute_queue(void)
                                                cmd->cmd.scan, &buffer);
 
                                if (cmd->cmd.scan->ir_scan)
-                                       DEBUG_JTAG_IO(
+                                       LOG_DEBUG_IO(
                                                        "JTAG Scan write IR(%d bits), "
                                                        "end in %s:",
                                                        scan_size,
                                                        tap_state_name(cmd->cmd.scan->end_state));
 
                                else
-                                       DEBUG_JTAG_IO(
+                                       LOG_DEBUG_IO(
                                                        "JTAG Scan write DR(%d bits), "
                                                        "end in %s:",
                                                        scan_size,
                                                        tap_state_name(cmd->cmd.scan->end_state));
 
-#ifdef _DEBUG_JTAG_IO_
-                               vsllink_debug_buffer(buffer,
-                                               DIV_ROUND_UP(scan_size, 8));
-#endif
+                               if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
+                                       vsllink_debug_buffer(buffer, DIV_ROUND_UP(scan_size, 8));
 
                                type = jtag_scan_type(cmd->cmd.scan);
 
@@ -172,28 +154,14 @@ static int vsllink_execute_queue(void)
                                                cmd->cmd.scan);
                                break;
 
-                       case JTAG_RESET:
-                               DEBUG_JTAG_IO("reset trst: %i srst %i",
-                                               cmd->cmd.reset->trst,
-                                               cmd->cmd.reset->srst);
-
-                               vsllink_tap_execute();
-
-                               if (cmd->cmd.reset->trst == 1)
-                                       tap_set_state(TAP_RESET);
-
-                               vsllink_reset(cmd->cmd.reset->trst,
-                                               cmd->cmd.reset->srst);
-                               break;
-
                        case JTAG_SLEEP:
-                               DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
+                               LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
                                vsllink_tap_execute();
                                jtag_sleep(cmd->cmd.sleep->us);
                                break;
 
                        case JTAG_STABLECLOCKS:
-                               DEBUG_JTAG_IO("add %d clocks",
+                               LOG_DEBUG_IO("add %d clocks",
                                                cmd->cmd.stableclocks->num_cycles);
 
                                switch (tap_get_state()) {
@@ -223,7 +191,7 @@ static int vsllink_execute_queue(void)
                                break;
 
                                case JTAG_TMS:
-                                       DEBUG_JTAG_IO("add %d jtag tms",
+                                       LOG_DEBUG_IO("add %d jtag tms",
                                                        cmd->cmd.tms->num_bits);
 
                                        vsllink_tms(cmd->cmd.tms->num_bits, cmd->cmd.tms->bits);
@@ -243,7 +211,7 @@ static int vsllink_execute_queue(void)
 static int vsllink_speed(int speed)
 {
        if (swd_mode) {
-               vsllink_swd_frequency(NULL, speed * 1000);
+               vsllink_swd_frequency(speed * 1000);
                return ERROR_OK;
        }
 
@@ -267,18 +235,14 @@ static int vsllink_speed_div(int jtag_speed, int *khz)
 
 static void vsllink_free_buffer(void)
 {
-       if (tdi_buffer != NULL) {
-               free(tdi_buffer);
-               tdi_buffer = NULL;
-       }
-       if (tdo_buffer != NULL) {
-               free(tdo_buffer);
-               tdo_buffer = NULL;
-       }
-       if (tms_buffer != NULL) {
-               free(tms_buffer);
-               tms_buffer = NULL;
-       }
+       free(tdi_buffer);
+       tdi_buffer = NULL;
+
+       free(tdo_buffer);
+       tdo_buffer = NULL;
+
+       free(tms_buffer);
+       tms_buffer = NULL;
 }
 
 static int vsllink_quit(void)
@@ -298,6 +262,7 @@ static int vsllink_quit(void)
        vsllink_free_buffer();
        vsllink_usb_close(vsllink_handle);
 
+       libusb_exit(vsllink_handle->libusb_ctx);
        free(vsllink_handle);
 
        return ERROR_OK;
@@ -306,15 +271,15 @@ static int vsllink_quit(void)
 static int vsllink_interface_init(void)
 {
        vsllink_handle = malloc(sizeof(struct vsllink));
-       if (NULL == vsllink_handle) {
+       if (!vsllink_handle) {
                LOG_ERROR("unable to allocate memory");
                return ERROR_FAIL;
        }
 
        libusb_init(&vsllink_handle->libusb_ctx);
 
-       if (ERROR_OK != vsllink_usb_open(vsllink_handle)) {
-               LOG_ERROR("Can't find USB JTAG Interface!" \
+       if (vsllink_usb_open(vsllink_handle) != ERROR_OK) {
+               LOG_ERROR("Can't find USB JTAG Interface!"
                        "Please check connection and permissions.");
                return ERROR_JTAG_INIT_FAILED;
        }
@@ -323,7 +288,7 @@ static int vsllink_interface_init(void)
                versaloon_interface.usb_setting.pid);
        versaloon_usb_device_handle = vsllink_handle->usb_device_handle;
 
-       if (ERROR_OK != versaloon_interface.init())
+       if (versaloon_interface.init() != ERROR_OK)
                return ERROR_FAIL;
        if (versaloon_interface.usb_setting.buf_size < 32) {
                versaloon_interface.fini();
@@ -336,7 +301,7 @@ static int vsllink_interface_init(void)
 static int vsllink_init(void)
 {
        int retval = vsllink_interface_init();
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        versaloon_interface.adaptors.gpio.init(0);
@@ -349,8 +314,8 @@ static int vsllink_init(void)
                versaloon_interface.adaptors.gpio.config(0, GPIO_TRST, 0,
                        GPIO_TRST, GPIO_TRST);
                versaloon_interface.adaptors.swd.init(0);
-               vsllink_swd_frequency(NULL, jtag_get_speed_khz() * 1000);
-               vsllink_swd_switch_seq(NULL, JTAG_TO_SWD);
+               vsllink_swd_frequency(adapter_get_speed_khz() * 1000);
+               vsllink_swd_switch_seq(JTAG_TO_SWD);
 
        } else {
                /* malloc buffer size for tap */
@@ -359,18 +324,18 @@ static int vsllink_init(void)
                tdi_buffer = malloc(tap_buffer_size);
                tdo_buffer = malloc(tap_buffer_size);
                tms_buffer = malloc(tap_buffer_size);
-               if ((NULL == tdi_buffer) || (NULL == tdo_buffer) || (NULL == tms_buffer)) {
+               if ((!tdi_buffer) || (!tdo_buffer) || (!tms_buffer)) {
                        vsllink_quit();
                        return ERROR_FAIL;
                }
 
                versaloon_interface.adaptors.jtag_raw.init(0);
-               versaloon_interface.adaptors.jtag_raw.config(0, jtag_get_speed_khz());
+               versaloon_interface.adaptors.jtag_raw.config(0, adapter_get_speed_khz());
                versaloon_interface.adaptors.gpio.config(0, GPIO_SRST | GPIO_TRST,
                        GPIO_TRST, GPIO_SRST, GPIO_SRST);
        }
 
-       if (ERROR_OK != versaloon_interface.adaptors.peripheral_commit())
+       if (versaloon_interface.adaptors.peripheral_commit() != ERROR_OK)
                return ERROR_FAIL;
 
        vsllink_reset(0, 0);
@@ -486,7 +451,7 @@ static void vsllink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
                vsllink_state_move();
 }
 
-static void vsllink_reset(int trst, int srst)
+static int vsllink_reset(int trst, int srst)
 {
        LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 
@@ -502,7 +467,7 @@ static void vsllink_reset(int trst, int srst)
                        versaloon_interface.adaptors.gpio.out(0, GPIO_TRST, 0);
        }
 
-       versaloon_interface.adaptors.peripheral_commit();
+       return versaloon_interface.adaptors.peripheral_commit();
 }
 
 COMMAND_HANDLER(vsllink_handle_usb_vid_command)
@@ -524,21 +489,6 @@ COMMAND_HANDLER(vsllink_handle_usb_pid_command)
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(vsllink_handle_usb_serial_command)
-{
-       if (CMD_ARGC > 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       free(versaloon_interface.usb_setting.serialstring);
-
-       if (CMD_ARGC == 1)
-               versaloon_interface.usb_setting.serialstring = strdup(CMD_ARGV[0]);
-       else
-               versaloon_interface.usb_setting.serialstring = NULL;
-
-       return ERROR_OK;
-}
-
 COMMAND_HANDLER(vsllink_handle_usb_bulkin_command)
 {
        if (CMD_ARGC != 1)
@@ -685,13 +635,11 @@ static int vsllink_jtag_execute(void)
                        command = pending_scan_result->command;
                        buf_set_buf(tdo_buffer, src_first, buffer, dest_first, length);
 
-#ifdef _DEBUG_JTAG_IO_
-                       DEBUG_JTAG_IO(
+                       LOG_DEBUG_IO(
                                "JTAG scan read(%d bits, from src %d bits to dest %d bits):",
                                length, src_first, dest_first);
-                       vsllink_debug_buffer(buffer + dest_first / 8,
-                               DIV_ROUND_UP(length, 7));
-#endif
+                       if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
+                               vsllink_debug_buffer(buffer + dest_first / 8, DIV_ROUND_UP(length, 7));
 
                        if (last) {
                                if (jtag_read_buffer(buffer, command)
@@ -700,8 +648,7 @@ static int vsllink_jtag_execute(void)
                                        return ERROR_JTAG_QUEUE_FAILED;
                                }
 
-                               if (pending_scan_result->buffer != NULL)
-                                       free(pending_scan_result->buffer);
+                               free(pending_scan_result->buffer);
                        }
                }
        } else {
@@ -730,8 +677,7 @@ static int vsllink_swd_init(void)
        return ERROR_OK;
 }
 
-static int_least32_t vsllink_swd_frequency(struct adiv5_dap *dap,
-               int_least32_t hz)
+static int_least32_t vsllink_swd_frequency(int_least32_t hz)
 {
        const int_least32_t delay2hz[] = {
                1850000, 235000, 130000, 102000, 85000, 72000
@@ -764,8 +710,7 @@ static int_least32_t vsllink_swd_frequency(struct adiv5_dap *dap,
        return hz;
 }
 
-static int vsllink_swd_switch_seq(struct adiv5_dap *dap,
-               enum swd_special_seq seq)
+static int vsllink_swd_switch_seq(enum swd_special_seq seq)
 {
        switch (seq) {
        case LINE_RESET:
@@ -791,19 +736,17 @@ static int vsllink_swd_switch_seq(struct adiv5_dap *dap,
        return ERROR_OK;
 }
 
-static void vsllink_swd_read_reg(struct adiv5_dap *dap, uint8_t cmd,
-               uint32_t *value)
+static void vsllink_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay_clk)
 {
        versaloon_interface.adaptors.swd.transact(0, cmd, value, NULL);
 }
 
-static void vsllink_swd_write_reg(struct adiv5_dap *dap, uint8_t cmd,
-               uint32_t value)
+static void vsllink_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay_clk)
 {
        versaloon_interface.adaptors.swd.transact(0, cmd, &value, NULL);
 }
 
-static int vsllink_swd_run_queue(struct adiv5_dap *dap)
+static int vsllink_swd_run_queue(void)
 {
        return versaloon_interface.adaptors.peripheral_commit();
 }
@@ -818,14 +761,14 @@ static int vsllink_check_usb_strings(
        char desc_string[256];
        int retval;
 
-       if (NULL != versaloon_interface.usb_setting.serialstring) {
+       if (adapter_get_required_serial()) {
                retval = libusb_get_string_descriptor_ascii(usb_device_handle,
                        usb_desc->iSerialNumber, (unsigned char *)desc_string,
                        sizeof(desc_string));
                if (retval < 0)
                        return ERROR_FAIL;
 
-               if (strncmp(desc_string, versaloon_interface.usb_setting.serialstring,
+               if (strncmp(desc_string, adapter_get_required_serial(),
                                sizeof(desc_string)))
                        return ERROR_FAIL;
        }
@@ -836,7 +779,7 @@ static int vsllink_check_usb_strings(
        if (retval < 0)
                return ERROR_FAIL;
 
-       if (strstr(desc_string, "Versaloon") == NULL)
+       if (!strstr(desc_string, "Versaloon"))
                return ERROR_FAIL;
 
        return ERROR_OK;
@@ -845,7 +788,7 @@ static int vsllink_check_usb_strings(
 static int vsllink_usb_open(struct vsllink *vsllink)
 {
        ssize_t num_devices, i;
-       libusb_device **usb_devices;
+       struct libusb_device **usb_devices;
        struct libusb_device_descriptor usb_desc;
        struct libusb_device_handle *usb_device_handle;
        int retval;
@@ -856,7 +799,7 @@ static int vsllink_usb_open(struct vsllink *vsllink)
                return ERROR_FAIL;
 
        for (i = 0; i < num_devices; i++) {
-               libusb_device *device = usb_devices[i];
+               struct libusb_device *device = usb_devices[i];
 
                retval = libusb_get_device_descriptor(device, &usb_desc);
                if (retval != 0)
@@ -871,7 +814,7 @@ static int vsllink_usb_open(struct vsllink *vsllink)
                        continue;
 
                retval = vsllink_check_usb_strings(usb_device_handle, &usb_desc);
-               if (ERROR_OK == retval)
+               if (retval == ERROR_OK)
                        break;
 
                libusb_close(usb_device_handle);
@@ -903,7 +846,6 @@ static void vsllink_usb_close(struct vsllink *vsllink)
 
 #define BYTES_PER_LINE  16
 
-#if defined _DEBUG_JTAG_IO_
 static void vsllink_debug_buffer(uint8_t *buffer, int length)
 {
        char line[81];
@@ -912,46 +854,61 @@ static void vsllink_debug_buffer(uint8_t *buffer, int length)
        int j;
 
        for (i = 0; i < length; i += BYTES_PER_LINE) {
-               snprintf(line, 5, "%04x", i);
+               snprintf(line, 5, "%04x", i & 0xffff);
                for (j = i; j < i + BYTES_PER_LINE && j < length; j++) {
                        snprintf(s, 4, " %02x", buffer[j]);
                        strcat(line, s);
                }
-               LOG_DEBUG("%s", line);
+               LOG_DEBUG_IO("%s", line);
        }
 }
-#endif /* _DEBUG_JTAG_IO_ */
 
-static const struct command_registration vsllink_command_handlers[] = {
+static const struct command_registration vsllink_subcommand_handlers[] = {
        {
-               .name = "vsllink_usb_vid",
+               .name = "usb_vid",
                .handler = &vsllink_handle_usb_vid_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB VID",
+               .usage = "<vid>",
        },
        {
-               .name = "vsllink_usb_pid",
+               .name = "usb_pid",
                .handler = &vsllink_handle_usb_pid_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB PID",
+               .usage = "<pid>",
        },
        {
-               .name = "vsllink_usb_serial",
-               .handler = &vsllink_handle_usb_serial_command,
-               .mode = COMMAND_CONFIG,
-       },
-       {
-               .name = "vsllink_usb_bulkin",
+               .name = "usb_bulkin",
                .handler = &vsllink_handle_usb_bulkin_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB input endpoint",
+               .usage = "<ep_in>",
        },
        {
-               .name = "vsllink_usb_bulkout",
+               .name = "usb_bulkout",
                .handler = &vsllink_handle_usb_bulkout_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB output endpoint",
+               .usage = "<ep_out>",
        },
        {
-               .name = "vsllink_usb_interface",
+               .name = "usb_interface",
                .handler = &vsllink_handle_usb_interface_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB output interface",
+               .usage = "<interface>",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static const struct command_registration vsllink_command_handlers[] = {
+       {
+               .name = "vsllink",
+               .mode = COMMAND_ANY,
+               .help = "perform vsllink management",
+               .chain = vsllink_subcommand_handlers,
+               .usage = "",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -960,24 +917,29 @@ static const char * const vsllink_transports[] = {"jtag", "swd", NULL};
 
 static const struct swd_driver vsllink_swd_driver = {
        .init = vsllink_swd_init,
-       .frequency = vsllink_swd_frequency,
        .switch_seq = vsllink_swd_switch_seq,
        .read_reg = vsllink_swd_read_reg,
        .write_reg = vsllink_swd_write_reg,
        .run = vsllink_swd_run_queue,
 };
 
-struct jtag_interface vsllink_interface = {
-       .name = "vsllink",
+static struct jtag_interface vsllink_interface = {
        .supported = DEBUG_CAP_TMS_SEQ,
-       .commands = vsllink_command_handlers,
+       .execute_queue = vsllink_execute_queue,
+};
+
+struct adapter_driver vsllink_adapter_driver = {
+       .name = "vsllink",
        .transports = vsllink_transports,
-       .swd = &vsllink_swd_driver,
+       .commands = vsllink_command_handlers,
 
        .init = vsllink_init,
        .quit = vsllink_quit,
-       .khz = vsllink_khz,
+       .reset = vsllink_reset,
        .speed = vsllink_speed,
+       .khz = vsllink_khz,
        .speed_div = vsllink_speed_div,
-       .execute_queue = vsllink_execute_queue,
+
+       .jtag_ops = &vsllink_interface,
+       .swd_ops = &vsllink_swd_driver,
 };