openocd: src/jtag: replace the GPL-2.0-or-later license tag
[openocd.git] / src / jtag / hla / hla_interface.c
index 02d0f2fb08b9b22730a532a772297fe55bb50e47..667f2a7c0ba46e07c3f88dee719224fc26c2da73 100644 (file)
@@ -1,24 +1,11 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2011 by Mathias Kuester                                 *
  *   Mathias Kuester <kesmtp@freenet.de>                                   *
  *                                                                         *
  *   Copyright (C) 2012 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   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.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 
 #include <target/target.h>
 
-static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, false, NULL, 0}, 0, 0 };
+static struct hl_interface_s hl_if = {
+       .param = {
+               .device_desc = NULL,
+               .vid = { 0 },
+               .pid = { 0 },
+               .transport = HL_TRANSPORT_UNKNOWN,
+               .connect_under_reset = false,
+               .initial_interface_speed = -1,
+               .use_stlink_tcp = false,
+               .stlink_tcp_port = 7184,
+       },
+       .layout = NULL,
+       .handle = NULL,
+};
 
 int hl_interface_open(enum hl_transports tr)
 {
@@ -72,7 +72,7 @@ int hl_interface_init_target(struct target *t)
         * can setup the private pointer in the tap structure
         * if the interface match the tap idcode
         */
-       res = hl_if.layout->api->idcode(hl_if.fd, &t->tap->idcode);
+       res = hl_if.layout->api->idcode(hl_if.handle, &t->tap->idcode);
 
        if (res != ERROR_OK)
                return res;
@@ -92,8 +92,11 @@ int hl_interface_init_target(struct target *t)
        }
 
        if (found == 0) {
-               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
-                               t->tap->idcode);
+               LOG_WARNING("UNEXPECTED idcode: 0x%08" PRIx32, t->tap->idcode);
+               for (ii = 0; ii < limit; ii++)
+                       LOG_ERROR("expected %u of %u: 0x%08" PRIx32, ii + 1, limit,
+                               t->tap->expected_ids[ii]);
+
                return ERROR_FAIL;
        }
 
@@ -115,56 +118,108 @@ static int hl_interface_quit(void)
 {
        LOG_DEBUG("hl_interface_quit");
 
-       if (hl_if.param.trace_f) {
-               fclose(hl_if.param.trace_f);
-               hl_if.param.trace_f = NULL;
-       }
+       if (hl_if.layout->api->close)
+               hl_if.layout->api->close(hl_if.handle);
+
+       jtag_command_queue_reset();
+
+       free((void *)hl_if.param.device_desc);
 
        return ERROR_OK;
 }
 
-static int hl_interface_execute_queue(void)
+static int hl_interface_reset(int req_trst, int req_srst)
 {
-       LOG_DEBUG("hl_interface_execute_queue: ignored");
-
-       return ERROR_OK;
+       return hl_if.layout->api->assert_srst(hl_if.handle, req_srst ? 0 : 1);
 }
 
 int hl_interface_init_reset(void)
 {
-       /* incase the adapter has not already handled asserting srst
+       /* in case the adapter has not already handled asserting srst
         * we will attempt it again */
        if (hl_if.param.connect_under_reset) {
-               jtag_add_reset(0, 1);
-               hl_if.layout->api->assert_srst(hl_if.fd, 0);
+               adapter_assert_reset();
        } else {
-               jtag_add_reset(0, 0);
+               adapter_deassert_reset();
        }
 
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(hl_interface_handle_device_desc_command)
+static int hl_interface_khz(int khz, int *jtag_speed)
 {
-       LOG_DEBUG("hl_interface_handle_device_desc_command");
+       if (!hl_if.layout->api->speed)
+               return ERROR_OK;
 
-       if (CMD_ARGC == 1) {
-               hl_if.param.device_desc = strdup(CMD_ARGV[0]);
-       } else {
-               LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
+       *jtag_speed = hl_if.layout->api->speed(hl_if.handle, khz, true);
+       return ERROR_OK;
+}
+
+static int hl_interface_speed_div(int speed, int *khz)
+{
+       *khz = speed;
+       return ERROR_OK;
+}
+
+static int hl_interface_speed(int speed)
+{
+       if (!hl_if.layout->api->speed)
+               return ERROR_OK;
+
+       if (!hl_if.handle) {
+               /* pass speed as initial param as interface not open yet */
+               hl_if.param.initial_interface_speed = speed;
+               return ERROR_OK;
        }
 
+       hl_if.layout->api->speed(hl_if.handle, speed, false);
+
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(hl_interface_handle_serial_command)
+int hl_interface_override_target(const char **targetname)
+{
+       if (hl_if.layout->api->override_target) {
+               if (hl_if.layout->api->override_target(*targetname)) {
+                       *targetname = "hla_target";
+                       return ERROR_OK;
+               } else
+                       return ERROR_FAIL;
+       }
+       return ERROR_FAIL;
+}
+
+static int hl_interface_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
+               uint32_t port_size, unsigned int *trace_freq,
+               unsigned int traceclkin_freq, uint16_t *prescaler)
 {
-       LOG_DEBUG("hl_interface_handle_serial_command");
+       if (hl_if.layout->api->config_trace)
+               return hl_if.layout->api->config_trace(hl_if.handle, enabled,
+                       pin_protocol, port_size, trace_freq, traceclkin_freq, prescaler);
+       else if (enabled) {
+               LOG_ERROR("The selected interface does not support tracing");
+               return ERROR_FAIL;
+       }
+
+       return ERROR_OK;
+}
+
+static int hl_interface_poll_trace(uint8_t *buf, size_t *size)
+{
+       if (hl_if.layout->api->poll_trace)
+               return hl_if.layout->api->poll_trace(hl_if.handle, buf, size);
+
+       return ERROR_FAIL;
+}
+
+COMMAND_HANDLER(hl_interface_handle_device_desc_command)
+{
+       LOG_DEBUG("hl_interface_handle_device_desc_command");
 
        if (CMD_ARGC == 1) {
-               hl_if.param.serial = strdup(CMD_ARGV[0]);
+               hl_if.param.device_desc = strdup(CMD_ARGV[0]);
        } else {
-               LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
+               LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
        }
 
        return ERROR_OK;
@@ -200,54 +255,67 @@ COMMAND_HANDLER(hl_interface_handle_layout_command)
 
 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
 {
-       LOG_DEBUG("hl_interface_handle_vid_pid_command");
-
-       if (CMD_ARGC != 2) {
-               LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
+       if (CMD_ARGC > HLA_MAX_USB_IDS * 2) {
+               LOG_WARNING("ignoring extra IDs in hla_vid_pid "
+                       "(maximum is %d pairs)", HLA_MAX_USB_IDS);
+               CMD_ARGC = HLA_MAX_USB_IDS * 2;
+       }
+       if (CMD_ARGC < 2 || (CMD_ARGC & 1)) {
+               LOG_WARNING("incomplete hla_vid_pid configuration directive");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
-       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
+       unsigned i;
+       for (i = 0; i < CMD_ARGC; i += 2) {
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i], hl_if.param.vid[i / 2]);
+               COMMAND_PARSE_NUMBER(u16, CMD_ARGV[i + 1], hl_if.param.pid[i / 2]);
+       }
+
+       /*
+        * Explicitly terminate, in case there are multiple instances of
+        * hla_vid_pid.
+        */
+       hl_if.param.vid[i / 2] = hl_if.param.pid[i / 2] = 0;
 
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(stlink_interface_handle_api_command)
+COMMAND_HANDLER(hl_interface_handle_stlink_backend_command)
 {
-       if (CMD_ARGC != 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       /* default values */
+       bool use_stlink_tcp = false;
+       uint16_t stlink_tcp_port = 7184;
 
-       unsigned new_api;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
-       if ((new_api == 0) || (new_api > 2))
+       if (CMD_ARGC == 0 || CMD_ARGC > 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       else if (strcmp(CMD_ARGV[0], "usb") == 0) {
+               if (CMD_ARGC > 1)
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+               /* else use_stlink_tcp = false (already the case ) */
+       } else if (strcmp(CMD_ARGV[0], "tcp") == 0) {
+               use_stlink_tcp = true;
+               if (CMD_ARGC == 2)
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], stlink_tcp_port);
+       } else
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       hl_if.param.api = new_api;
+       hl_if.param.use_stlink_tcp = use_stlink_tcp;
+       hl_if.param.stlink_tcp_port = stlink_tcp_port;
 
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(interface_handle_trace_command)
+COMMAND_HANDLER(interface_handle_hla_command)
 {
-       FILE *f;
-       unsigned source_hz;
-
-       if (CMD_ARGC != 2)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       f = fopen(CMD_ARGV[0], "a");
-       if (!f)
+       if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], source_hz);
-       if (source_hz == 0) {
-               fclose(f);
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       if (!hl_if.layout->api->custom_command) {
+               LOG_ERROR("The selected adapter doesn't support custom commands");
+               return ERROR_FAIL;
        }
 
-       hl_if.param.trace_f = f;
-       hl_if.param.trace_source_hz = source_hz;
+       hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
 
        return ERROR_OK;
 }
@@ -257,16 +325,9 @@ static const struct command_registration hl_interface_command_handlers[] = {
         .name = "hla_device_desc",
         .handler = &hl_interface_handle_device_desc_command,
         .mode = COMMAND_CONFIG,
-        .help = "set the device description of the adapter",
+        .help = "set the device description of the adapter",
         .usage = "description_string",
         },
-       {
-        .name = "hla_serial",
-        .handler = &hl_interface_handle_serial_command,
-        .mode = COMMAND_CONFIG,
-        .help = "set the serial number of the adapter",
-        .usage = "serial_string",
-        },
        {
         .name = "hla_layout",
         .handler = &hl_interface_handle_layout_command,
@@ -279,31 +340,38 @@ static const struct command_registration hl_interface_command_handlers[] = {
         .handler = &hl_interface_handle_vid_pid_command,
         .mode = COMMAND_CONFIG,
         .help = "the vendor and product ID of the adapter",
-        .usage = "(vid pid)* ",
+        .usage = "(vid pid)*",
         },
-        {
-        .name = "stlink_api",
-        .handler = &stlink_interface_handle_api_command,
+       {
+        .name = "hla_stlink_backend",
+        .handler = &hl_interface_handle_stlink_backend_command,
         .mode = COMMAND_CONFIG,
-        .help = "set the desired stlink api level",
-        .usage = "api version 1 or 2",
-        },
+        .help = "select which ST-Link backend to use",
+        .usage = "usb | tcp [port]",
+       },
         {
-        .name = "trace",
-        .handler = &interface_handle_trace_command,
-        .mode = COMMAND_CONFIG,
-        .help = "configure trace reception",
-        .usage = "destination_path source_lock_hz",
+        .name = "hla_command",
+        .handler = &interface_handle_hla_command,
+        .mode = COMMAND_EXEC,
+        .help = "execute a custom adapter-specific command",
+        .usage = "<command>",
         },
        COMMAND_REGISTRATION_DONE
 };
 
-struct jtag_interface hl_interface = {
+struct adapter_driver hl_adapter_driver = {
        .name = "hla",
-       .supported = 0,
-       .commands = hl_interface_command_handlers,
        .transports = hl_transports,
+       .commands = hl_interface_command_handlers,
+
        .init = hl_interface_init,
        .quit = hl_interface_quit,
-       .execute_queue = hl_interface_execute_queue,
+       .reset = hl_interface_reset,
+       .speed = &hl_interface_speed,
+       .khz = &hl_interface_khz,
+       .speed_div = &hl_interface_speed_div,
+       .config_trace = &hl_interface_config_trace,
+       .poll_trace = &hl_interface_poll_trace,
+
+       /* no ops for HLA, targets hla_target and stm8 intercept them all */
 };

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)