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