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 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 /* project specific includes */
  25 #include <jtag/interface.h>
  26 #include <transport/transport.h>
  27 #include <helper/time_support.h>
  28
  29 #include <jtag/stlink/stlink_tcl.h>
  30 #include <jtag/stlink/stlink_layout.h>
  31 #include <jtag/stlink/stlink_interface.h>
  32
  33 #include <target/target.h>
  34
  35 static struct stlink_interface_s stlink_if = { {0, 0, 0, 0}, 0, 0 };
  36
  37 int stlink_interface_open(void)
  38 {
  39         LOG_DEBUG("stlink_interface_open");
  40
  41         return stlink_if.layout->open(&stlink_if);
  42 }
  43
  44 int stlink_interface_init_target(struct target *t)
  45 {
  46         int res;
  47
  48         /* this is the interface for the current target and we
  49          * can setup the private pointer in the tap structure
  50          * if the interface match the tap idcode
  51          */
  52         res = stlink_if.layout->api->idcode(stlink_if.fd, &t->tap->idcode);
  53
  54         if (res != ERROR_OK)
  55                 return res;
  56
  57         unsigned ii, limit = t->tap->expected_ids_cnt;
  58         int found = 0;
  59
  60         for (ii = 0; ii < limit; ii++) {
  61                 uint32_t expected = t->tap->expected_ids[ii];
  62
  63                 if (t->tap->idcode == expected) {
  64                         found = 1;
  65                         break;
  66                 }
  67         }
  68
  69         if (found == 0) {
  70                 LOG_ERROR
  71                     ("stlink_interface_init_target: target not found: idcode: %x ",
  72                      t->tap->idcode);
  73                 return ERROR_FAIL;
  74         }
  75
  76         t->tap->priv = &stlink_if;
  77         t->tap->hasidcode = 1;
  78
  79         return ERROR_OK;
  80 }
  81
  82 static int stlink_interface_init(void)
  83 {
  84         LOG_DEBUG("stlink_interface_init");
  85
  86         /* here we can initialize the layout */
  87         return stlink_layout_init(&stlink_if);
  88 }
  89
  90 static int stlink_interface_quit(void)
  91 {
  92         LOG_DEBUG("stlink_interface_quit");
  93
  94         return ERROR_OK;
  95 }
  96
  97 static int stlink_interface_speed(int speed)
  98 {
  99         LOG_DEBUG("stlink_interface_speed: ignore speed %d", speed);
 100
 101         return ERROR_OK;
 102 }
 103
 104 static int stlink_interface_execute_queue(void)
 105 {
 106         LOG_DEBUG("stlink_interface_execute_queue: ignored");
 107
 108         return ERROR_OK;
 109 }
 110
 111 COMMAND_HANDLER(stlink_interface_handle_device_desc_command)
 112 {
 113         LOG_DEBUG("stlink_interface_handle_device_desc_command");
 114
 115         if (CMD_ARGC == 1) {
 116                 stlink_if.param.device_desc = strdup(CMD_ARGV[0]);
 117         } else {
 118                 LOG_ERROR
 119                     ("expected exactly one argument to stlink_device_desc <description>");
 120         }
 121
 122         return ERROR_OK;
 123 }
 124
 125 COMMAND_HANDLER(stlink_interface_handle_serial_command)
 126 {
 127         LOG_DEBUG("stlink_interface_handle_serial_command");
 128
 129         if (CMD_ARGC == 1) {
 130                 stlink_if.param.serial = strdup(CMD_ARGV[0]);
 131         } else {
 132                 LOG_ERROR
 133                     ("expected exactly one argument to stlink_serial <serial-number>");
 134         }
 135
 136         return ERROR_OK;
 137 }
 138
 139 COMMAND_HANDLER(stlink_interface_handle_layout_command)
 140 {
 141         LOG_DEBUG("stlink_interface_handle_layout_command");
 142
 143         if (CMD_ARGC != 1) {
 144                 LOG_ERROR("Need exactly one argument to stlink_layout");
 145                 return ERROR_COMMAND_SYNTAX_ERROR;
 146         }
 147
 148         if (stlink_if.layout) {
 149                 LOG_ERROR("already specified stlink_layout %s",
 150                           stlink_if.layout->name);
 151                 return (strcmp(stlink_if.layout->name, CMD_ARGV[0]) != 0)
 152                     ? ERROR_FAIL : ERROR_OK;
 153         }
 154
 155         for (const struct stlink_layout *l = stlink_layout_get_list(); l->name;
 156              l++) {
 157                 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
 158                         stlink_if.layout = l;
 159                         return ERROR_OK;
 160                 }
 161         }
 162
 163         LOG_ERROR("No STLINK layout '%s' found", CMD_ARGV[0]);
 164         return ERROR_FAIL;
 165 }
 166
 167 COMMAND_HANDLER(stlink_interface_handle_vid_pid_command)
 168 {
 169         LOG_DEBUG("stlink_interface_handle_vid_pid_command");
 170
 171         if (CMD_ARGC != 2) {
 172                 LOG_WARNING
 173                     ("ignoring extra IDs in stlink_vid_pid (maximum is 1 pair)");
 174                 return ERROR_COMMAND_SYNTAX_ERROR;
 175         }
 176
 177         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], stlink_if.param.vid);
 178         COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], stlink_if.param.pid);
 179
 180         return ERROR_OK;
 181 }
 182
 183 static const struct command_registration stlink_interface_command_handlers[] = {
 184         {
 185          .name = "stlink_device_desc",
 186          .handler = &stlink_interface_handle_device_desc_command,
 187          .mode = COMMAND_CONFIG,
 188          .help = "set the stlink device description of the STLINK device",
 189          .usage = "description_string",
 190          },
 191         {
 192          .name = "stlink_serial",
 193          .handler = &stlink_interface_handle_serial_command,
 194          .mode = COMMAND_CONFIG,
 195          .help = "set the serial number of the STLINK device",
 196          .usage = "serial_string",
 197          },
 198         {
 199          .name = "stlink_layout",
 200          .handler = &stlink_interface_handle_layout_command,
 201          .mode = COMMAND_CONFIG,
 202          .help = "set the layout of the STLINK to usb or sg",
 203          .usage = "layout_name",
 204          },
 205         {
 206          .name = "stlink_vid_pid",
 207          .handler = &stlink_interface_handle_vid_pid_command,
 208          .mode = COMMAND_CONFIG,
 209          .help = "the vendor and product ID of the STLINK device",
 210          .usage = "(vid pid)* ",
 211          },
 212         COMMAND_REGISTRATION_DONE
 213 };
 214
 215 struct jtag_interface stlink_interface = {
 216         .name = "stlink",
 217         .supported = 0,
 218         .commands = stlink_interface_command_handlers,
 219         .transports = stlink_transports,
 220
 221         .init = stlink_interface_init,
 222         .quit = stlink_interface_quit,
 223         .speed = stlink_interface_speed,
 224         .execute_queue = stlink_interface_execute_queue,
 225 };