riscv: replace macro DIM() with ARRAY_SIZE()
[fw/openocd] / src / jtag / drivers / vsllink.c
index 844f6f2766f07bde5b10344dbc49a8db7b69a4cf..f08fa9165ed40191c0882abe6cc1d1a363e7bc3b 100644 (file)
@@ -12,9 +12,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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 /* Versaloon is a programming tool for multiple MCUs.
@@ -61,7 +59,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 +70,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 +82,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 +101,14 @@ static int vsllink_execute_queue(void)
        enum scan_type type;
        uint8_t *buffer;
 
-       DEBUG_JTAG_IO("-------------------------------------"
+       LOG_DEBUG_IO("-------------------------------------"
                " vsllink "
                "-------------------------------------");
 
        while (cmd != NULL) {
                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 +117,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 +125,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 +133,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 +141,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 +164,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 +201,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);
@@ -242,8 +220,10 @@ static int vsllink_execute_queue(void)
 
 static int vsllink_speed(int speed)
 {
-       if (swd_mode)
+       if (swd_mode) {
+               vsllink_swd_frequency(speed * 1000);
                return ERROR_OK;
+       }
 
        versaloon_interface.adaptors.jtag_raw.config(0, (uint16_t)speed);
        return versaloon_interface.adaptors.peripheral_commit();
@@ -265,18 +245,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)
@@ -312,7 +288,7 @@ static int vsllink_interface_init(void)
        libusb_init(&vsllink_handle->libusb_ctx);
 
        if (ERROR_OK != vsllink_usb_open(vsllink_handle)) {
-               LOG_ERROR("Can't find USB JTAG Interface!" \
+               LOG_ERROR("Can't find USB JTAG Interface!"
                        "Please check connection and permissions.");
                return ERROR_JTAG_INIT_FAILED;
        }
@@ -347,8 +323,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(jtag_get_speed_khz() * 1000);
+               vsllink_swd_switch_seq(JTAG_TO_SWD);
 
        } else {
                /* malloc buffer size for tap */
@@ -484,7 +460,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);
 
@@ -500,7 +476,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)
@@ -683,13 +659,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)
@@ -698,8 +672,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 {
@@ -728,8 +701,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
@@ -762,8 +734,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:
@@ -789,19 +760,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();
 }
@@ -843,7 +812,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;
@@ -854,7 +823,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)
@@ -901,7 +870,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];
@@ -910,46 +878,57 @@ 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[] = {
        {
                .name = "vsllink_usb_vid",
                .handler = &vsllink_handle_usb_vid_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB VID",
+               .usage = "<vid>",
        },
        {
                .name = "vsllink_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,
+               .help = "Set or disable check for USB serial",
+               .usage = "[<serial>]",
        },
        {
                .name = "vsllink_usb_bulkin",
                .handler = &vsllink_handle_usb_bulkin_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB input endpoint",
+               .usage = "<ep_in>",
        },
        {
                .name = "vsllink_usb_bulkout",
                .handler = &vsllink_handle_usb_bulkout_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB output endpoint",
+               .usage = "<ep_out>",
        },
        {
                .name = "vsllink_usb_interface",
                .handler = &vsllink_handle_usb_interface_command,
                .mode = COMMAND_CONFIG,
+               .help = "Set USB output interface",
+               .usage = "<interface>",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -958,24 +937,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,
 };