src/jtag/stlink/stlink_interface.c

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Mathias Kuester                                 *
   3  *   Mathias Kuester <kesmtp@freenet.de>                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 /* project specific includes */
  26 #include <jtag/interface.h>
  27 #include <transport/transport.h>
  28 #include <helper/time_support.h>
  29
  30 #include <jtag/stlink/stlink_tcl.h>
  31 #include <jtag/stlink/stlink_layout.h>
  32 #include <jtag/stlink/stlink_transport.h>
  33 #include <jtag/stlink/stlink_interface.h>
  34
  35 #include <target/target.h>
  36
  37 static struct stlink_interface_s stlink_if = { {0, 0, 0, 0, 0, 0}, 0, 0 };
  38
  39 int stlink_interface_open(enum stlink_transports tr)
  40 {
  41         LOG_DEBUG("stlink_interface_open");
  42
  43         /* set transport mode */
  44         stlink_if.param.transport = tr;
  45
  46         return stlink_if.layout->open(&stlink_if);
  47 }
  48
  49 int stlink_interface_init_target(struct target *t)
  50 {
  51         int res;
  52
  53         LOG_DEBUG("stlink_interface_init_target");
  54
  55         /* this is the interface for the current target and we
  56          * can setup the private pointer in the tap structure
  57          * if the interface match the tap idcode
  58          */
  59         res = stlink_if.layout->api->idcode(stlink_if.fd, &t->tap->idcode);
  60
  61         if (res != ERROR_OK)
  62                 return res;
  63
  64         unsigned ii, limit = t->tap->expected_ids_cnt;
  65         int found = 0;
  66
  67         for (ii = 0; ii < limit; ii++) {
  68                 uint32_t expected = t->tap->expected_ids[ii];
  69
  70                 /* treat "-expected-id 0" as a "don't-warn" wildcard */
  71                 if (!expected || (t->tap->idcode == expected)) {
  72                         found = 1;
  73                         break;
  74                 }
  75         }
  76
  77         if (found == 0) {
  78                 LOG_ERROR("stlink_interface_init_target: target not found: idcode: 0x%08x",
  79                                 t->tap->idcode);
  80                 return ERROR_FAIL;
  81         }
  82
  83         t->tap->priv = &stlink_if;
  84         t->tap->hasidcode = 1;
  85
  86         return ERROR_OK;
  87 }
  88
  89 static int stlink_interface_init(void)
  90 {
  91         LOG_DEBUG("stlink_interface_init");
  92
  93         /* here we can initialize the layout */
  94         return stlink_layout_init(&stlink_if);
  95 }
  96
  97 static int stlink_interface_quit(void)
  98 {
  99         LOG_DEBUG("stlink_interface_quit");
 100
 101         return ERROR_OK;
 102 }
 103
 104 static int stlink_interface_speed(int speed)
 105 {
 106         LOG_DEBUG("stlink_interface_speed: ignore speed %d", speed);
 107
 108         return ERROR_OK;
 109 }
 110
 111 static int stlink_speed_div(int speed, int *khz)
 112 {
 113         *khz = speed;
 114         return ERROR_OK;
 115 }
 116
 117 static int stlink_khz(int khz, int *jtag_speed)
 118 {
 119         *jtag_speed = khz;
 120         return ERROR_OK;
 121 }
 122
 123 static int stlink_interface_execute_queue(void)
 124 {
 125         LOG_DEBUG("stlink_interface_execute_queue: ignored");
 126
 127         return ERROR_OK;
 128 }
 129
 130 COMMAND_HANDLER(stlink_interface_handle_device_desc_command)
 131 {
 132         LOG_DEBUG("stlink_interface_handle_device_desc_command");
 133
 134         if (CMD_ARGC == 1) {
 135                 stlink_if.param.device_desc = strdup(CMD_ARGV[0]);
 136         } else {
 137                 LOG_ERROR
 138                     ("expected exactly one argument to stlink_device_desc <description>");
 139         }
 140
 141         return ERROR_OK;
 142 }
 143
 144 COMMAND_HANDLER(stlink_interface_handle_serial_command)
 145 {
 146         LOG_DEBUG("stlink_interface_handle_serial_command");
 147
 148         if (CMD_ARGC == 1) {
 149                 stlink_if.param.serial = strdup(CMD_ARGV[0]);
 150         } else {
 151                 LOG_ERROR
 152                     ("expected exactly one argument to stlink_serial <serial-number>");
 153         }
 154
 155         return ERROR_OK;
 156 }
 157
 158 COMMAND_HANDLER(stlink_interface_handle_layout_command)
 159 {
 160         LOG_DEBUG("stlink_interface_handle_layout_command");
 161
 162         if (CMD_ARGC != 1) {
 163                 LOG_ERROR("Need exactly one argument to stlink_layout");
 164                 return ERROR_COMMAND_SYNTAX_ERROR;
 165         }
 166
 167         if (stlink_if.layout) {
 168                 LOG_ERROR("already specified stlink_layout %s",
 169                           stlink_if.layout->name);
 170                 return (strcmp(stlink_if.layout->name, CMD_ARGV[0]) != 0)
 171                     ? ERROR_FAIL : ERROR_OK;
 172         }
 173
 174         for (const struct stlink_layout *l = stlink_layout_get_list(); l->name;
 175              l++) {
 176                 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
 177                         stlink_if.layout = l;
 178                         return ERROR_OK;
 179                 }
 180         }
 181
 182         LOG_ERROR("No STLINK layout '%s' found", CMD_ARGV[0]);
 183         return ERROR_FAIL;
 184 }
 185
 186 COMMAND_HANDLER(stlink_interface_handle_vid_pid_command)
 187 {
 188         LOG_DEBUG("stlink_interface_handle_vid_pid_command");
 189
 190         if (CMD_ARGC != 2) {
 191                 LOG_WARNING
 192                     ("ignoring extra IDs in stlink_vid_pid (maximum is 1 pair)");
 193                 return ERROR_COMMAND_SYNTAX_ERROR;
 194         }
 195
 196         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], stlink_if.param.vid);
 197         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], stlink_if.param.pid);
 198
 199         return ERROR_OK;
 200 }
 201
 202 COMMAND_HANDLER(stlink_interface_handle_api_command)
 203 {
 204         if (CMD_ARGC != 1)
 205                 return ERROR_COMMAND_SYNTAX_ERROR;
 206
 207         unsigned new_api;
 208         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_api);
 209         if ((new_api == 0) || (new_api > 2))
 210                 return ERROR_COMMAND_SYNTAX_ERROR;
 211
 212         stlink_if.param.api = new_api;
 213
 214         return ERROR_OK;
 215 }
 216
 217 static const struct command_registration stlink_interface_command_handlers[] = {
 218         {
 219          .name = "stlink_device_desc",
 220          .handler = &stlink_interface_handle_device_desc_command,
 221          .mode = COMMAND_CONFIG,
 222          .help = "set the stlink device description of the STLINK device",
 223          .usage = "description_string",
 224          },
 225         {
 226          .name = "stlink_serial",
 227          .handler = &stlink_interface_handle_serial_command,
 228          .mode = COMMAND_CONFIG,
 229          .help = "set the serial number of the STLINK device",
 230          .usage = "serial_string",
 231          },
 232         {
 233          .name = "stlink_layout",
 234          .handler = &stlink_interface_handle_layout_command,
 235          .mode = COMMAND_CONFIG,
 236          .help = "set the layout of the STLINK to usb or sg",
 237          .usage = "layout_name",
 238          },
 239         {
 240          .name = "stlink_vid_pid",
 241          .handler = &stlink_interface_handle_vid_pid_command,
 242          .mode = COMMAND_CONFIG,
 243          .help = "the vendor and product ID of the STLINK device",
 244          .usage = "(vid pid)* ",
 245          },
 246          {
 247          .name = "stlink_api",
 248          .handler = &stlink_interface_handle_api_command,
 249          .mode = COMMAND_CONFIG,
 250          .help = "set the desired stlink api level",
 251          .usage = "api version 1 or 2",
 252          },
 253         COMMAND_REGISTRATION_DONE
 254 };
 255
 256 struct jtag_interface stlink_interface = {
 257         .name = "stlink",
 258         .supported = 0,
 259         .commands = stlink_interface_command_handlers,
 260         .transports = stlink_transports,
 261         .init = stlink_interface_init,
 262         .quit = stlink_interface_quit,
 263         .speed = stlink_interface_speed,
 264         .speed_div = stlink_speed_div,
 265         .khz = stlink_khz,
 266         .execute_queue = stlink_interface_execute_queue,
 267 };