hla: add a way to pass arbitrary commands from user to layout and use for ICDI
[openocd.git] / src / jtag / hla / hla_interface.c
index 397eeeae3f259778184632f638f4be6762126b1b..ce914ea0c52204f9fefaa9481ba38c038ade791f 100644 (file)
@@ -18,7 +18,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
 
 #include <target/target.h>
 
-static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, 0}, 0, 0 };
+static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, false, NULL, 0}, 0, 0 };
 
 int hl_interface_open(enum hl_transports tr)
 {
        LOG_DEBUG("hl_interface_open");
 
+       enum reset_types jtag_reset_config = jtag_get_reset_config();
+
+       if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
+               if (jtag_reset_config & RESET_SRST_NO_GATING)
+                       hl_if.param.connect_under_reset = true;
+               else
+                       LOG_WARNING("\'srst_nogate\' reset_config option is required");
+       }
+
        /* set transport mode */
        hl_if.param.transport = tr;
 
@@ -63,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;
@@ -75,14 +84,15 @@ int hl_interface_init_target(struct target *t)
                uint32_t expected = t->tap->expected_ids[ii];
 
                /* treat "-expected-id 0" as a "don't-warn" wildcard */
-               if (!expected || (t->tap->idcode == expected)) {
+               if (!expected || !t->tap->idcode ||
+                   (t->tap->idcode == expected)) {
                        found = 1;
                        break;
                }
        }
 
        if (found == 0) {
-               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
+               LOG_ERROR("hl_interface_init_target: target not found: idcode: 0x%08" PRIx32,
                                t->tap->idcode);
                return ERROR_FAIL;
        }
@@ -105,48 +115,63 @@ 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;
+       }
+       hl_if.param.trace_source_hz = 0;
+
        return ERROR_OK;
 }
 
-static int hl_interface_speed(int speed)
+static int hl_interface_execute_queue(void)
 {
-       LOG_DEBUG("hl_interface_speed: ignore speed %d", speed);
+       LOG_DEBUG("hl_interface_execute_queue: ignored");
 
        return ERROR_OK;
 }
 
-static int hl_speed_div(int speed, int *khz)
+int hl_interface_init_reset(void)
 {
-       *khz = speed;
+       /* incase 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.handle, 0);
+       } else {
+               jtag_add_reset(0, 0);
+       }
+
        return ERROR_OK;
 }
 
-static int hl_khz(int khz, int *jtag_speed)
+static int dummy_khz(int khz, int *jtag_speed)
 {
        *jtag_speed = khz;
        return ERROR_OK;
 }
 
-static int hl_interface_execute_queue(void)
+static int dummy_speed_div(int speed, int *khz)
 {
-       LOG_DEBUG("hl_interface_execute_queue: ignored");
-
+       *khz = speed;
        return ERROR_OK;
 }
 
-int hl_interface_init_reset(void)
+static int dummy_speed(int speed)
 {
-       enum reset_types jtag_reset_config = jtag_get_reset_config();
+       return ERROR_OK;
+}
 
-       if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
-               if (jtag_reset_config & RESET_SRST_NO_GATING) {
-                       jtag_add_reset(0, 1);
-                       hl_if.layout->api->assert_srst(hl_if.fd, 0);
+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
-                       LOG_WARNING("\'srst_nogate\' reset_config option is required");
+                       return ERROR_FAIL;
        }
-
-       return ERROR_OK;
+       return ERROR_FAIL;
 }
 
 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
@@ -218,69 +243,101 @@ COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(hl_interface_handle_api_command)
+COMMAND_HANDLER(interface_handle_trace_command)
 {
-       if (CMD_ARGC != 1)
+       FILE *f = NULL;
+       unsigned source_hz;
+
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], source_hz);
+       if (source_hz == 0) {
                return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       if (CMD_ARGC == 2) {
+               f = fopen(CMD_ARGV[1], "a");
+               if (!f)
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       hl_if.param.trace_f = f;
+       hl_if.param.trace_source_hz = source_hz;
+
+       return ERROR_OK;
+}
 
-       unsigned new_api;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
-       if ((new_api == 0) || (new_api > 2))
+COMMAND_HANDLER(interface_handle_hla_command)
+{
+       if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       hl_if.param.api = new_api;
+       if (!hl_if.layout->api->custom_command) {
+               LOG_ERROR("The selected adapter doesn't support custom commands");
+               return ERROR_FAIL;
+       }
+
+       hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
 
        return ERROR_OK;
 }
 
 static const struct command_registration hl_interface_command_handlers[] = {
        {
-        .name = "stlink_device_desc",
+        .name = "hla_device_desc",
         .handler = &hl_interface_handle_device_desc_command,
         .mode = COMMAND_CONFIG,
         .help = "set the a device description of the adapter",
         .usage = "description_string",
         },
        {
-        .name = "stlink_serial",
+        .name = "hla_serial",
         .handler = &hl_interface_handle_serial_command,
         .mode = COMMAND_CONFIG,
         .help = "set the serial number of the adapter",
         .usage = "serial_string",
         },
        {
-        .name = "stlink_layout",
+        .name = "hla_layout",
         .handler = &hl_interface_handle_layout_command,
         .mode = COMMAND_CONFIG,
         .help = "set the layout of the adapter",
         .usage = "layout_name",
         },
        {
-        .name = "stlink_vid_pid",
+        .name = "hla_vid_pid",
         .handler = &hl_interface_handle_vid_pid_command,
         .mode = COMMAND_CONFIG,
         .help = "the vendor and product ID of the adapter",
         .usage = "(vid pid)* ",
         },
         {
-        .name = "stlink_api",
-        .handler = &hl_interface_handle_api_command,
+        .name = "trace",
+        .handler = &interface_handle_trace_command,
         .mode = COMMAND_CONFIG,
-        .help = "set the desired stlink api level",
-        .usage = "api version 1 or 2",
+        .help = "configure trace reception",
+        .usage = "source_lock_hz [destination_path]",
+        },
+        {
+        .name = "hla_command",
+        .handler = &interface_handle_hla_command,
+        .mode = COMMAND_EXEC,
+        .help = "execute a custom adapter-specific command",
+        .usage = "hla_command <command>",
         },
        COMMAND_REGISTRATION_DONE
 };
 
 struct jtag_interface hl_interface = {
-       .name = "stlink",
+       .name = "hla",
        .supported = 0,
        .commands = hl_interface_command_handlers,
        .transports = hl_transports,
        .init = hl_interface_init,
        .quit = hl_interface_quit,
-       .speed = hl_interface_speed,
-       .speed_div = hl_speed_div,
-       .khz = hl_khz,
        .execute_queue = hl_interface_execute_queue,
+       .speed = &dummy_speed,
+       .khz = &dummy_khz,
+       .speed_div = &dummy_speed_div,
 };

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)