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.fd, &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
 123         return ERROR_OK;
 124 }
 125
 126 static int hl_interface_execute_queue(void)
 127 {
 128         LOG_DEBUG("hl_interface_execute_queue: ignored");
 129
 130         return ERROR_OK;
 131 }
 132
 133 int hl_interface_init_reset(void)
 134 {
 135         /* incase the adapter has not already handled asserting srst
 136          * we will attempt it again */
 137         if (hl_if.param.connect_under_reset) {
 138                 jtag_add_reset(0, 1);
 139                 hl_if.layout->api->assert_srst(hl_if.fd, 0);
 140         } else {
 141                 jtag_add_reset(0, 0);
 142         }
 143
 144         return ERROR_OK;
 145 }
 146
 147 COMMAND_HANDLER(hl_interface_handle_device_desc_command)
 148 {
 149         LOG_DEBUG("hl_interface_handle_device_desc_command");
 150
 151         if (CMD_ARGC == 1) {
 152                 hl_if.param.device_desc = strdup(CMD_ARGV[0]);
 153         } else {
 154                 LOG_ERROR("expected exactly one argument to hl_device_desc <description>");
 155         }
 156
 157         return ERROR_OK;
 158 }
 159
 160 COMMAND_HANDLER(hl_interface_handle_serial_command)
 161 {
 162         LOG_DEBUG("hl_interface_handle_serial_command");
 163
 164         if (CMD_ARGC == 1) {
 165                 hl_if.param.serial = strdup(CMD_ARGV[0]);
 166         } else {
 167                 LOG_ERROR("expected exactly one argument to hl_serial <serial-number>");
 168         }
 169
 170         return ERROR_OK;
 171 }
 172
 173 COMMAND_HANDLER(hl_interface_handle_layout_command)
 174 {
 175         LOG_DEBUG("hl_interface_handle_layout_command");
 176
 177         if (CMD_ARGC != 1) {
 178                 LOG_ERROR("Need exactly one argument to stlink_layout");
 179                 return ERROR_COMMAND_SYNTAX_ERROR;
 180         }
 181
 182         if (hl_if.layout) {
 183                 LOG_ERROR("already specified hl_layout %s",
 184                                 hl_if.layout->name);
 185                 return (strcmp(hl_if.layout->name, CMD_ARGV[0]) != 0)
 186                     ? ERROR_FAIL : ERROR_OK;
 187         }
 188
 189         for (const struct hl_layout *l = hl_layout_get_list(); l->name;
 190              l++) {
 191                 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
 192                         hl_if.layout = l;
 193                         return ERROR_OK;
 194                 }
 195         }
 196
 197         LOG_ERROR("No adapter layout '%s' found", CMD_ARGV[0]);
 198         return ERROR_FAIL;
 199 }
 200
 201 COMMAND_HANDLER(hl_interface_handle_vid_pid_command)
 202 {
 203         LOG_DEBUG("hl_interface_handle_vid_pid_command");
 204
 205         if (CMD_ARGC != 2) {
 206                 LOG_WARNING("ignoring extra IDs in hl_vid_pid (maximum is 1 pair)");
 207                 return ERROR_COMMAND_SYNTAX_ERROR;
 208         }
 209
 210         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], hl_if.param.vid);
 211         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], hl_if.param.pid);
 212
 213         return ERROR_OK;
 214 }
 215
 216 COMMAND_HANDLER(stlink_interface_handle_api_command)
 217 {
 218         if (CMD_ARGC != 1)
 219                 return ERROR_COMMAND_SYNTAX_ERROR;
 220
 221         unsigned new_api;
 222         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
 223         if ((new_api == 0) || (new_api > 2))
 224                 return ERROR_COMMAND_SYNTAX_ERROR;
 225
 226         hl_if.param.api = new_api;
 227
 228         return ERROR_OK;
 229 }
 230
 231 COMMAND_HANDLER(interface_handle_trace_command)
 232 {
 233         FILE *f;
 234         unsigned source_hz;
 235
 236         if (CMD_ARGC != 2)
 237                 return ERROR_COMMAND_SYNTAX_ERROR;
 238
 239         f = fopen(CMD_ARGV[0], "a");
 240         if (!f)
 241                 return ERROR_COMMAND_SYNTAX_ERROR;
 242
 243         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], source_hz);
 244         if (source_hz == 0) {
 245                 fclose(f);
 246                 return ERROR_COMMAND_SYNTAX_ERROR;
 247         }
 248
 249         hl_if.param.trace_f = f;
 250         hl_if.param.trace_source_hz = source_hz;
 251
 252         return ERROR_OK;
 253 }
 254
 255 static const struct command_registration hl_interface_command_handlers[] = {
 256         {
 257          .name = "hla_device_desc",
 258          .handler = &hl_interface_handle_device_desc_command,
 259          .mode = COMMAND_CONFIG,
 260          .help = "set the a device description of the adapter",
 261          .usage = "description_string",
 262          },
 263         {
 264          .name = "hla_serial",
 265          .handler = &hl_interface_handle_serial_command,
 266          .mode = COMMAND_CONFIG,
 267          .help = "set the serial number of the adapter",
 268          .usage = "serial_string",
 269          },
 270         {
 271          .name = "hla_layout",
 272          .handler = &hl_interface_handle_layout_command,
 273          .mode = COMMAND_CONFIG,
 274          .help = "set the layout of the adapter",
 275          .usage = "layout_name",
 276          },
 277         {
 278          .name = "hla_vid_pid",
 279          .handler = &hl_interface_handle_vid_pid_command,
 280          .mode = COMMAND_CONFIG,
 281          .help = "the vendor and product ID of the adapter",
 282          .usage = "(vid pid)* ",
 283          },
 284          {
 285          .name = "stlink_api",
 286          .handler = &stlink_interface_handle_api_command,
 287          .mode = COMMAND_CONFIG,
 288          .help = "set the desired stlink api level",
 289          .usage = "api version 1 or 2",
 290          },
 291          {
 292          .name = "trace",
 293          .handler = &interface_handle_trace_command,
 294          .mode = COMMAND_CONFIG,
 295          .help = "configure trace reception",
 296          .usage = "destination_path source_lock_hz",
 297          },
 298         COMMAND_REGISTRATION_DONE
 299 };
 300
 301 struct jtag_interface hl_interface = {
 302         .name = "hla",
 303         .supported = 0,
 304         .commands = hl_interface_command_handlers,
 305         .transports = hl_transports,
 306         .init = hl_interface_init,
 307         .quit = hl_interface_quit,
 308         .execute_queue = hl_interface_execute_queue,
 309 };