src/jtag/hla/hla_transport.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 /***************************************************************************
   4  *   Copyright (C) 2011 by Mathias Kuester                                 *
   5  *   Mathias Kuester <kesmtp@freenet.de>                                   *
   6  *                                                                         *
   7  *   Copyright (C) 2012 by Spencer Oliver                                  *
   8  *   spen@spen-soft.co.uk                                                  *
   9  ***************************************************************************/
  10
  11 #ifdef HAVE_CONFIG_H
  12 #include "config.h"
  13 #endif
  14
  15 /* project specific includes */
  16 #include <jtag/interface.h>
  17 #include <jtag/tcl.h>
  18 #include <transport/transport.h>
  19 #include <helper/time_support.h>
  20 #include <target/target.h>
  21 #include <jtag/hla/hla_transport.h>
  22 #include <jtag/hla/hla_interface.h>
  23
  24 COMMAND_HANDLER(hl_transport_jtag_command)
  25 {
  26         LOG_DEBUG("hl_transport_jtag_command");
  27
  28         return ERROR_OK;
  29 }
  30
  31 COMMAND_HANDLER(hl_transport_reset_command)
  32 {
  33         return hl_interface_init_reset();
  34 }
  35
  36 static const struct command_registration hl_swd_transport_subcommand_handlers[] = {
  37         {
  38          .name = "newdap",
  39          .mode = COMMAND_CONFIG,
  40          .handler = handle_jtag_newtap,
  41          .help = "declare a new SWD DAP",
  42          .usage = "basename dap_type ['-irlen' count] "
  43                         "['-enable'|'-disable'] "
  44                         "['-expected_id' number] "
  45                         "['-ignore-version'] "
  46                         "['-ignore-bypass'] "
  47                         "['-ircapture' number] "
  48                         "['-mask' number]",
  49          },
  50         COMMAND_REGISTRATION_DONE
  51 };
  52
  53 static const struct command_registration hl_swd_transport_command_handlers[] = {
  54         {
  55          .name = "swd",
  56          .mode = COMMAND_ANY,
  57          .help = "SWD command group",
  58          .usage = "",
  59          .chain = hl_swd_transport_subcommand_handlers,
  60          },
  61         COMMAND_REGISTRATION_DONE
  62 };
  63
  64 static const struct command_registration hl_transport_jtag_subcommand_handlers[] = {
  65         {
  66          .name = "newtap",
  67          .mode = COMMAND_CONFIG,
  68          .handler = handle_jtag_newtap,
  69          .help = "Create a new TAP instance named basename.tap_type, "
  70          "and appends it to the scan chain.",
  71          .usage = "basename tap_type '-irlen' count "
  72                         "['-enable'|'-disable'] "
  73                         "['-expected_id' number] "
  74                         "['-ignore-version'] "
  75                         "['-ignore-bypass'] "
  76                         "['-ircapture' number] "
  77                         "['-mask' number]",
  78          },
  79         {
  80          .name = "init",
  81          .mode = COMMAND_ANY,
  82          .handler = hl_transport_jtag_command,
  83          .usage = ""
  84          },
  85         {
  86          .name = "arp_init",
  87          .mode = COMMAND_ANY,
  88          .handler = hl_transport_jtag_command,
  89          .usage = ""
  90          },
  91         {
  92          .name = "arp_init-reset",
  93          .mode = COMMAND_ANY,
  94          .handler = hl_transport_reset_command,
  95          .usage = ""
  96          },
  97         {
  98          .name = "tapisenabled",
  99          .mode = COMMAND_EXEC,
 100          .handler = handle_jtag_tap_enabler,
 101          .help = "Returns a Tcl boolean (0/1) indicating whether "
 102                 "the TAP is enabled (1) or not (0).",
 103          .usage = "tap_name",
 104          },
 105         {
 106          .name = "tapenable",
 107          .mode = COMMAND_EXEC,
 108          .handler = handle_jtag_tap_enabler,
 109          .help = "Try to enable the specified TAP using the "
 110                 "'tap-enable' TAP event.",
 111          .usage = "tap_name",
 112          },
 113         {
 114          .name = "tapdisable",
 115          .mode = COMMAND_EXEC,
 116          .handler = hl_transport_jtag_command,
 117          .usage = "",
 118          },
 119         {
 120          .name = "configure",
 121          .mode = COMMAND_EXEC,
 122          .handler = hl_transport_jtag_command,
 123          .usage = "",
 124          },
 125         {
 126          .name = "cget",
 127          .mode = COMMAND_EXEC,
 128          .jim_handler = jim_jtag_configure,
 129          },
 130         {
 131          .name = "names",
 132          .mode = COMMAND_ANY,
 133          .handler = hl_transport_jtag_command,
 134          .usage = "",
 135          },
 136
 137         COMMAND_REGISTRATION_DONE
 138 };
 139
 140 static const struct command_registration hl_jtag_transport_command_handlers[] = {
 141         {
 142          .name = "jtag",
 143          .mode = COMMAND_ANY,
 144          .help = "perform jtag tap actions",
 145          .usage = "",
 146          .chain = hl_transport_jtag_subcommand_handlers,
 147          },
 148         {
 149          .name = "jtag_ntrst_delay",
 150          .mode = COMMAND_ANY,
 151          .handler = hl_transport_jtag_command,
 152          .usage = "",
 153          },
 154         COMMAND_REGISTRATION_DONE
 155 };
 156
 157
 158 static int hl_transport_init(struct command_context *cmd_ctx)
 159 {
 160         LOG_DEBUG("hl_transport_init");
 161         struct target *t = get_current_target(cmd_ctx);
 162         struct transport *transport;
 163         enum hl_transports tr;
 164
 165         if (!t) {
 166                 LOG_ERROR("no current target");
 167                 return ERROR_FAIL;
 168         }
 169
 170         transport = get_current_transport();
 171
 172         if (!transport) {
 173                 LOG_ERROR("no transport selected");
 174                 return ERROR_FAIL;
 175         }
 176
 177         LOG_DEBUG("current transport %s", transport->name);
 178
 179         /* get selected transport as enum */
 180         tr = HL_TRANSPORT_UNKNOWN;
 181
 182         if (strcmp(transport->name, "hla_swd") == 0)
 183                 tr = HL_TRANSPORT_SWD;
 184         else if (strcmp(transport->name, "hla_jtag") == 0)
 185                 tr = HL_TRANSPORT_JTAG;
 186
 187         int retval = hl_interface_open(tr);
 188
 189         if (retval != ERROR_OK)
 190                 return retval;
 191
 192         return hl_interface_init_target(t);
 193 }
 194
 195 static int hl_jtag_transport_select(struct command_context *cmd_ctx)
 196 {
 197         LOG_DEBUG("hl_jtag_transport_select");
 198
 199         /* NOTE:  interface init must already have been done.
 200          * That works with only C code ... no Tcl glue required.
 201          */
 202
 203         return register_commands(cmd_ctx, NULL, hl_jtag_transport_command_handlers);
 204 }
 205
 206 static int hl_swd_transport_select(struct command_context *cmd_ctx)
 207 {
 208         LOG_DEBUG("hl_swd_transport_select");
 209         return register_commands(cmd_ctx, NULL, hl_swd_transport_command_handlers);
 210 }
 211
 212 static struct transport hl_swd_transport = {
 213         .name = "hla_swd",
 214         .select = hl_swd_transport_select,
 215         .init = hl_transport_init,
 216         .override_target = hl_interface_override_target,
 217 };
 218
 219 static struct transport hl_jtag_transport = {
 220         .name = "hla_jtag",
 221         .select = hl_jtag_transport_select,
 222         .init = hl_transport_init,
 223         .override_target = hl_interface_override_target,
 224 };
 225
 226 const char *hl_transports[] = { "hla_swd", "hla_jtag", NULL };
 227
 228 static void hl_constructor(void) __attribute__ ((constructor));
 229 static void hl_constructor(void)
 230 {
 231         transport_register(&hl_swd_transport);
 232         transport_register(&hl_jtag_transport);
 233 }
 234
 235 bool transport_is_hla(void)
 236 {
 237         struct transport *t;
 238         t = get_current_transport();
 239         return t == &hl_swd_transport || t == &hl_jtag_transport;
 240 }