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, NULL, 0}, 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_ERROR("hl_interface_init_target: target not found: idcode: 0x%08x",
  96                                 t->tap->idcode);
  97                 return ERROR_FAIL;
  98         }
  99
 100         t->tap->priv = &hl_if;
 101         t->tap->hasidcode = 1;
 102
 103         return ERROR_OK;
 104 }
 105
 106 static int hl_interface_init(void)
 107 {
 108         LOG_DEBUG("hl_interface_init");
 109
 110         /* here we can initialize the layout */
 111         return hl_layout_init(&hl_if);
 112 }
 113
 114 static int hl_interface_quit(void)
 115 {
 116         LOG_DEBUG("hl_interface_quit");
 117
 118         if (hl_if.param.trace_f) {
 119                 fclose(hl_if.param.trace_f);
 120                 hl_if.param.trace_f = NULL;
 121         }
 122         hl_if.param.trace_source_hz = 0;
 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 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
 149 {
 150         LOG_DEBUG("hl_interface_handle_device_desc_command");
 151
 152         if (CMD_ARGC == 1) {
 153                 hl_if.param.device_desc = strdup(CMD_ARGV[0]);
 154         } else {
 155                 LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
 156         }
 157
 158         return ERROR_OK;
 159 }
 160
 161 COMMAND_HANDLER(hl_interface_handle_serial_command)
 162 {
 163         LOG_DEBUG("hl_interface_handle_serial_command");
 164
 165         if (CMD_ARGC == 1) {
 166                 hl_if.param.serial = strdup(CMD_ARGV[0]);
 167         } else {
 168                 LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
 169         }
 170
 171         return ERROR_OK;
 172 }
 173
 174 COMMAND_HANDLER(hl_interface_handle_layout_command)
 175 {
 176         LOG_DEBUG("hl_interface_handle_layout_command");
 177
 178         if (CMD_ARGC != 1) {
 179                 LOG_ERROR("Need exactly one argument to stlink_layout");
 180                 return ERROR_COMMAND_SYNTAX_ERROR;
 181         }
 182
 183         if (hl_if.layout) {
 184                 LOG_ERROR("already specified hl_layout %s",
 185                                 hl_if.layout->name);
 186                 return (strcmp(hl_if.layout->name, CMD_ARGV[0]) != 0)
 187                     ? ERROR_FAIL : ERROR_OK;
 188         }
 189
 190         for (const struct hl_layout *l = hl_layout_get_list(); l->name;
 191              l++) {
 192                 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
 193                         hl_if.layout = l;
 194                         return ERROR_OK;
 195                 }
 196         }
 197
 198         LOG_ERROR("No adapter layout '%s' found", CMD_ARGV[0]);
 199         return ERROR_FAIL;
 200 }
 201
 202 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
 203 {
 204         LOG_DEBUG("hl_interface_handle_vid_pid_command");
 205
 206         if (CMD_ARGC != 2) {
 207                 LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
 208                 return ERROR_COMMAND_SYNTAX_ERROR;
 209         }
 210
 211         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
 212         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
 213
 214         return ERROR_OK;
 215 }
 216
 217 COMMAND_HANDLER(stlink_interface_handle_api_command)
 218 {
 219         if (CMD_ARGC != 1)
 220                 return ERROR_COMMAND_SYNTAX_ERROR;
 221
 222         unsigned new_api;
 223         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
 224         if ((new_api == 0) || (new_api > 2))
 225                 return ERROR_COMMAND_SYNTAX_ERROR;
 226
 227         hl_if.param.api = new_api;
 228
 229         return ERROR_OK;
 230 }
 231
 232 COMMAND_HANDLER(interface_handle_trace_command)
 233 {
 234         FILE *f = NULL;
 235         unsigned source_hz;
 236
 237         if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
 238                 return ERROR_COMMAND_SYNTAX_ERROR;
 239
 240         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], source_hz);
 241         if (source_hz == 0) {
 242                 return ERROR_COMMAND_SYNTAX_ERROR;
 243         }
 244
 245         if (CMD_ARGC == 2) {
 246                 f = fopen(CMD_ARGV[1], "a");
 247                 if (!f)
 248                         return ERROR_COMMAND_SYNTAX_ERROR;
 249         }
 250
 251         hl_if.param.trace_f = f;
 252         hl_if.param.trace_source_hz = source_hz;
 253
 254         return ERROR_OK;
 255 }
 256
 257 static const struct command_registration hl_interface_command_handlers[] = {
 258         {
 259          .name = "hla_device_desc",
 260          .handler = &hl_interface_handle_device_desc_command,
 261          .mode = COMMAND_CONFIG,
 262          .help = "set the a device description of the adapter",
 263          .usage = "description_string",
 264          },
 265         {
 266          .name = "hla_serial",
 267          .handler = &hl_interface_handle_serial_command,
 268          .mode = COMMAND_CONFIG,
 269          .help = "set the serial number of the adapter",
 270          .usage = "serial_string",
 271          },
 272         {
 273          .name = "hla_layout",
 274          .handler = &hl_interface_handle_layout_command,
 275          .mode = COMMAND_CONFIG,
 276          .help = "set the layout of the adapter",
 277          .usage = "layout_name",
 278          },
 279         {
 280          .name = "hla_vid_pid",
 281          .handler = &hl_interface_handle_vid_pid_command,
 282          .mode = COMMAND_CONFIG,
 283          .help = "the vendor and product ID of the adapter",
 284          .usage = "(vid pid)* ",
 285          },
 286          {
 287          .name = "stlink_api",
 288          .handler = &stlink_interface_handle_api_command,
 289          .mode = COMMAND_CONFIG,
 290          .help = "set the desired stlink api level",
 291          .usage = "api version 1 or 2",
 292          },
 293          {
 294          .name = "trace",
 295          .handler = &interface_handle_trace_command,
 296          .mode = COMMAND_CONFIG,
 297          .help = "configure trace reception",
 298          .usage = "source_lock_hz [destination_path]",
 299          },
 300         COMMAND_REGISTRATION_DONE
 301 };
 302
 303 struct jtag_interface hl_interface = {
 304         .name = "hla",
 305         .supported = 0,
 306         .commands = hl_interface_command_handlers,
 307         .transports = hl_transports,
 308         .init = hl_interface_init,
 309         .quit = hl_interface_quit,
 310         .execute_queue = hl_interface_execute_queue,
 311 };