src/jtag/hla/hla_interface.c

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Mathias Kuester                                 *
   3  *   Mathias Kuester <kesmtp@freenet.de>                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2012 by Spencer Oliver                                  *
   6  *   spen@spen-soft.co.uk                                                  *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  22  ***************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 /* project specific includes */
  29 #include <jtag/interface.h>
  30 #include <transport/transport.h>
  31 #include <helper/time_support.h>
  32
  33 #include <jtag/hla/hla_tcl.h>
  34 #include <jtag/hla/hla_layout.h>
  35 #include <jtag/hla/hla_transport.h>
  36 #include <jtag/hla/hla_interface.h>
  37
  38 #include <target/target.h>
  39
  40 static struct hl_interface_s hl_if = { {0, 0, 0, 0, 0, HL_TRANSPORT_UNKNOWN, false, -1}, 0, 0 };
  41
  42 int hl_interface_open(enum hl_transports tr)
  43 {
  44         LOG_DEBUG("hl_interface_open");
  45
  46         enum reset_types jtag_reset_config = jtag_get_reset_config();
  47
  48         if (jtag_reset_config & RESET_CNCT_UNDER_SRST) {
  49                 if (jtag_reset_config & RESET_SRST_NO_GATING)
  50                         hl_if.param.connect_under_reset = true;
  51                 else
  52                         LOG_WARNING("\'srst_nogate\' reset_config option is required");
  53         }
  54
  55         /* set transport mode */
  56         hl_if.param.transport = tr;
  57
  58         int result = hl_if.layout->open(&hl_if);
  59         if (result != ERROR_OK)
  60                 return result;
  61
  62         return hl_interface_init_reset();
  63 }
  64
  65 int hl_interface_init_target(struct target *t)
  66 {
  67         int res;
  68
  69         LOG_DEBUG("hl_interface_init_target");
  70
  71         /* this is the interface for the current target and we
  72          * can setup the private pointer in the tap structure
  73          * if the interface match the tap idcode
  74          */
  75         res = hl_if.layout->api->idcode(hl_if.handle, &t->tap->idcode);
  76
  77         if (res != ERROR_OK)
  78                 return res;
  79
  80         unsigned ii, limit = t->tap->expected_ids_cnt;
  81         int found = 0;
  82
  83         for (ii = 0; ii < limit; ii++) {
  84                 uint32_t expected = t->tap->expected_ids[ii];
  85
  86                 /* treat "-expected-id 0" as a "don't-warn" wildcard */
  87                 if (!expected || !t->tap->idcode ||
  88                     (t->tap->idcode == expected)) {
  89                         found = 1;
  90                         break;
  91                 }
  92         }
  93
  94         if (found == 0) {
  95                 LOG_WARNING("UNEXPECTED idcode: 0x%08" PRIx32, t->tap->idcode);
  96                 for (ii = 0; ii < limit; ii++)
  97                         LOG_ERROR("expected %u of %u: 0x%08" PRIx32, ii + 1, limit,
  98                                 t->tap->expected_ids[ii]);
  99
 100                 return ERROR_FAIL;
 101         }
 102
 103         t->tap->priv = &hl_if;
 104         t->tap->hasidcode = 1;
 105
 106         return ERROR_OK;
 107 }
 108
 109 static int hl_interface_init(void)
 110 {
 111         LOG_DEBUG("hl_interface_init");
 112
 113         /* here we can initialize the layout */
 114         return hl_layout_init(&hl_if);
 115 }
 116
 117 static int hl_interface_quit(void)
 118 {
 119         LOG_DEBUG("hl_interface_quit");
 120
 121         if (hl_if.layout->api->close)
 122                 hl_if.layout->api->close(hl_if.handle);
 123
 124         return ERROR_OK;
 125 }
 126
 127 static int hl_interface_execute_queue(void)
 128 {
 129         LOG_DEBUG("hl_interface_execute_queue: ignored");
 130
 131         return ERROR_OK;
 132 }
 133
 134 int hl_interface_init_reset(void)
 135 {
 136         /* incase the adapter has not already handled asserting srst
 137          * we will attempt it again */
 138         if (hl_if.param.connect_under_reset) {
 139                 jtag_add_reset(0, 1);
 140                 hl_if.layout->api->assert_srst(hl_if.handle, 0);
 141         } else {
 142                 jtag_add_reset(0, 0);
 143         }
 144
 145         return ERROR_OK;
 146 }
 147
 148 static int hl_interface_khz(int khz, int *jtag_speed)
 149 {
 150         if (hl_if.layout->api->speed == NULL)
 151                 return ERROR_OK;
 152
 153         *jtag_speed = hl_if.layout->api->speed(hl_if.handle, khz, true);
 154         return ERROR_OK;
 155 }
 156
 157 static int hl_interface_speed_div(int speed, int *khz)
 158 {
 159         *khz = speed;
 160         return ERROR_OK;
 161 }
 162
 163 static int hl_interface_speed(int speed)
 164 {
 165         if (hl_if.layout->api->speed == NULL)
 166                 return ERROR_OK;
 167
 168         if (hl_if.handle == NULL) {
 169                 /* pass speed as initial param as interface not open yet */
 170                 hl_if.param.initial_interface_speed = speed;
 171                 return ERROR_OK;
 172         }
 173
 174         hl_if.layout->api->speed(hl_if.handle, speed, false);
 175
 176         return ERROR_OK;
 177 }
 178
 179 int hl_interface_override_target(const char **targetname)
 180 {
 181         if (hl_if.layout->api->override_target) {
 182                 if (hl_if.layout->api->override_target(*targetname)) {
 183                         *targetname = "hla_target";
 184                         return ERROR_OK;
 185                 } else
 186                         return ERROR_FAIL;
 187         }
 188         return ERROR_FAIL;
 189 }
 190
 191 int hl_interface_config_trace(bool enabled, enum tpio_pin_protocol pin_protocol,
 192                               uint32_t port_size, unsigned int *trace_freq)
 193 {
 194         if (hl_if.layout->api->config_trace)
 195                 return hl_if.layout->api->config_trace(hl_if.handle, enabled, pin_protocol,
 196                                                        port_size, trace_freq);
 197         else if (enabled) {
 198                 LOG_ERROR("The selected interface does not support tracing");
 199                 return ERROR_FAIL;
 200         }
 201
 202         return ERROR_OK;
 203 }
 204
 205 int hl_interface_poll_trace(uint8_t *buf, size_t *size)
 206 {
 207         if (hl_if.layout->api->poll_trace)
 208                 return hl_if.layout->api->poll_trace(hl_if.handle, buf, size);
 209
 210         return ERROR_FAIL;
 211 }
 212
 213 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
 214 {
 215         LOG_DEBUG("hl_interface_handle_device_desc_command");
 216
 217         if (CMD_ARGC == 1) {
 218                 hl_if.param.device_desc = strdup(CMD_ARGV[0]);
 219         } else {
 220                 LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
 221         }
 222
 223         return ERROR_OK;
 224 }
 225
 226 COMMAND_HANDLER(hl_interface_handle_serial_command)
 227 {
 228         LOG_DEBUG("hl_interface_handle_serial_command");
 229
 230         if (CMD_ARGC == 1) {
 231                 hl_if.param.serial = strdup(CMD_ARGV[0]);
 232         } else {
 233                 LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
 234         }
 235
 236         return ERROR_OK;
 237 }
 238
 239 COMMAND_HANDLER(hl_interface_handle_layout_command)
 240 {
 241         LOG_DEBUG("hl_interface_handle_layout_command");
 242
 243         if (CMD_ARGC != 1) {
 244                 LOG_ERROR("Need exactly one argument to stlink_layout");
 245                 return ERROR_COMMAND_SYNTAX_ERROR;
 246         }
 247
 248         if (hl_if.layout) {
 249                 LOG_ERROR("already specified hl_layout %s",
 250                                 hl_if.layout->name);
 251                 return (strcmp(hl_if.layout->name, CMD_ARGV[0]) != 0)
 252                     ? ERROR_FAIL : ERROR_OK;
 253         }
 254
 255         for (const struct hl_layout *l = hl_layout_get_list(); l->name;
 256              l++) {
 257                 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
 258                         hl_if.layout = l;
 259                         return ERROR_OK;
 260                 }
 261         }
 262
 263         LOG_ERROR("No adapter layout '%s' found", CMD_ARGV[0]);
 264         return ERROR_FAIL;
 265 }
 266
 267 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
 268 {
 269         LOG_DEBUG("hl_interface_handle_vid_pid_command");
 270
 271         if (CMD_ARGC != 2) {
 272                 LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
 273                 return ERROR_COMMAND_SYNTAX_ERROR;
 274         }
 275
 276         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
 277         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
 278
 279         return ERROR_OK;
 280 }
 281
 282 COMMAND_HANDLER(interface_handle_hla_command)
 283 {
 284         if (CMD_ARGC != 1)
 285                 return ERROR_COMMAND_SYNTAX_ERROR;
 286
 287         if (!hl_if.layout->api->custom_command) {
 288                 LOG_ERROR("The selected adapter doesn't support custom commands");
 289                 return ERROR_FAIL;
 290         }
 291
 292         hl_if.layout->api->custom_command(hl_if.handle, CMD_ARGV[0]);
 293
 294         return ERROR_OK;
 295 }
 296
 297 static const struct command_registration hl_interface_command_handlers[] = {
 298         {
 299          .name = "hla_device_desc",
 300          .handler = &hl_interface_handle_device_desc_command,
 301          .mode = COMMAND_CONFIG,
 302          .help = "set the a device description of the adapter",
 303          .usage = "description_string",
 304          },
 305         {
 306          .name = "hla_serial",
 307          .handler = &hl_interface_handle_serial_command,
 308          .mode = COMMAND_CONFIG,
 309          .help = "set the serial number of the adapter",
 310          .usage = "serial_string",
 311          },
 312         {
 313          .name = "hla_layout",
 314          .handler = &hl_interface_handle_layout_command,
 315          .mode = COMMAND_CONFIG,
 316          .help = "set the layout of the adapter",
 317          .usage = "layout_name",
 318          },
 319         {
 320          .name = "hla_vid_pid",
 321          .handler = &hl_interface_handle_vid_pid_command,
 322          .mode = COMMAND_CONFIG,
 323          .help = "the vendor and product ID of the adapter",
 324          .usage = "(vid pid)* ",
 325          },
 326          {
 327          .name = "hla_command",
 328          .handler = &interface_handle_hla_command,
 329          .mode = COMMAND_EXEC,
 330          .help = "execute a custom adapter-specific command",
 331          .usage = "hla_command <command>",
 332          },
 333         COMMAND_REGISTRATION_DONE
 334 };
 335
 336 struct jtag_interface hl_interface = {
 337         .name = "hla",
 338         .supported = 0,
 339         .commands = hl_interface_command_handlers,
 340         .transports = hl_transports,
 341         .init = hl_interface_init,
 342         .quit = hl_interface_quit,
 343         .execute_queue = hl_interface_execute_queue,
 344         .speed = &hl_interface_speed,
 345         .khz = &hl_interface_khz,
 346         .speed_div = &hl_interface_speed_div,
 347         .config_trace = &hl_interface_config_trace,
 348         .poll_trace = &hl_interface_poll_trace,
 349 };