src/target/arm_dap.c

   1 /***************************************************************************
   2  *   Copyright (C) 2016 by Matthias Welwarsky                              *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *                                                                         *
  18  ***************************************************************************/
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 #include <stdlib.h>
  25 #include <stdint.h>
  26 #include "target/arm_adi_v5.h"
  27 #include "target/arm.h"
  28 #include "helper/list.h"
  29 #include "helper/command.h"
  30 #include "transport/transport.h"
  31 #include "jtag/interface.h"
  32
  33 static LIST_HEAD(all_dap);
  34
  35 extern const struct dap_ops swd_dap_ops;
  36 extern const struct dap_ops jtag_dp_ops;
  37 extern struct jtag_interface *jtag_interface;
  38
  39 /* DAP command support */
  40 struct arm_dap_object {
  41         struct list_head lh;
  42         struct adiv5_dap dap;
  43         char *name;
  44         const struct swd_driver *swd;
  45 };
  46
  47 static void dap_instance_init(struct adiv5_dap *dap)
  48 {
  49         int i;
  50         /* Set up with safe defaults */
  51         for (i = 0; i <= 255; i++) {
  52                 dap->ap[i].dap = dap;
  53                 dap->ap[i].ap_num = i;
  54                 /* memaccess_tck max is 255 */
  55                 dap->ap[i].memaccess_tck = 255;
  56                 /* Number of bits for tar autoincrement, impl. dep. at least 10 */
  57                 dap->ap[i].tar_autoincr_block = (1<<10);
  58         }
  59         INIT_LIST_HEAD(&dap->cmd_journal);
  60 }
  61
  62 const char *adiv5_dap_name(struct adiv5_dap *self)
  63 {
  64         struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
  65         return obj->name;
  66 }
  67
  68 const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self)
  69 {
  70         struct arm_dap_object *obj = container_of(self, struct arm_dap_object, dap);
  71         return obj->swd;
  72 }
  73
  74 struct adiv5_dap *adiv5_get_dap(struct arm_dap_object *obj)
  75 {
  76         return &obj->dap;
  77 }
  78 struct adiv5_dap *dap_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
  79 {
  80         struct arm_dap_object *obj = NULL;
  81         const char *name;
  82         bool found = false;
  83
  84         name = Jim_GetString(o, NULL);
  85
  86         list_for_each_entry(obj, &all_dap, lh) {
  87                 if (!strcmp(name, obj->name)) {
  88                         found = true;
  89                         break;
  90                 }
  91         }
  92
  93         if (found)
  94                 return &obj->dap;
  95         return NULL;
  96 }
  97
  98 static int dap_init_all(void)
  99 {
 100         struct arm_dap_object *obj;
 101         int retval;
 102
 103         LOG_DEBUG("Initializing all DAPs ...");
 104
 105         list_for_each_entry(obj, &all_dap, lh) {
 106                 struct adiv5_dap *dap = &obj->dap;
 107
 108                 /* with hla, dap is just a dummy */
 109                 if (transport_is_hla())
 110                         continue;
 111
 112                 /* skip taps that are disabled */
 113                 if (!dap->tap->enabled)
 114                         continue;
 115
 116                 if (transport_is_swd()) {
 117                         dap->ops = &swd_dap_ops;
 118                         obj->swd = jtag_interface->swd;
 119                 } else
 120                         dap->ops = &jtag_dp_ops;
 121
 122                 retval = dap->ops->connect(dap);
 123                 if (retval != ERROR_OK)
 124                         return retval;
 125         }
 126
 127         return ERROR_OK;
 128 }
 129
 130 int dap_cleanup_all(void)
 131 {
 132         struct arm_dap_object *obj, *tmp;
 133
 134         list_for_each_entry_safe(obj, tmp, &all_dap, lh) {
 135                 free(obj->name);
 136                 free(obj);
 137         }
 138
 139         return ERROR_OK;
 140 }
 141
 142 enum dap_cfg_param {
 143         CFG_CHAIN_POSITION,
 144 };
 145
 146 static const Jim_Nvp nvp_config_opts[] = {
 147         { .name = "-chain-position",   .value = CFG_CHAIN_POSITION },
 148         { .name = NULL, .value = -1 }
 149 };
 150
 151 static int dap_configure(Jim_GetOptInfo *goi, struct arm_dap_object *dap)
 152 {
 153         struct jtag_tap *tap = NULL;
 154         Jim_Nvp *n;
 155         int e;
 156
 157         /* parse config or cget options ... */
 158         while (goi->argc > 0) {
 159                 Jim_SetEmptyResult(goi->interp);
 160
 161                 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
 162                 if (e != JIM_OK) {
 163                         Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
 164                         return e;
 165                 }
 166                 switch (n->value) {
 167                 case CFG_CHAIN_POSITION: {
 168                         Jim_Obj *o_t;
 169                         e = Jim_GetOpt_Obj(goi, &o_t);
 170                         if (e != JIM_OK)
 171                                 return e;
 172                         tap = jtag_tap_by_jim_obj(goi->interp, o_t);
 173                         if (tap == NULL) {
 174                                 Jim_SetResultString(goi->interp, "-chain-position is invalid", -1);
 175                                 return JIM_ERR;
 176                         }
 177                         /* loop for more */
 178                         break;
 179                 }
 180                 default:
 181                         break;
 182                 }
 183         }
 184
 185         if (tap == NULL) {
 186                 Jim_SetResultString(goi->interp, "-chain-position required when creating DAP", -1);
 187                 return JIM_ERR;
 188         }
 189
 190         dap_instance_init(&dap->dap);
 191         dap->dap.tap = tap;
 192
 193         return JIM_OK;
 194 }
 195
 196 static int dap_create(Jim_GetOptInfo *goi)
 197 {
 198         struct command_context *cmd_ctx;
 199         static struct arm_dap_object *dap;
 200         Jim_Obj *new_cmd;
 201         Jim_Cmd *cmd;
 202         const char *cp;
 203         int e;
 204
 205         cmd_ctx = current_command_context(goi->interp);
 206         assert(cmd_ctx != NULL);
 207
 208         if (goi->argc < 3) {
 209                 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ..options...");
 210                 return JIM_ERR;
 211         }
 212         /* COMMAND */
 213         Jim_GetOpt_Obj(goi, &new_cmd);
 214         /* does this command exist? */
 215         cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
 216         if (cmd) {
 217                 cp = Jim_GetString(new_cmd, NULL);
 218                 Jim_SetResultFormatted(goi->interp, "Command: %s Exists", cp);
 219                 return JIM_ERR;
 220         }
 221
 222         /* Create it */
 223         dap = calloc(1, sizeof(struct arm_dap_object));
 224         if (dap == NULL)
 225                 return JIM_ERR;
 226
 227         e = dap_configure(goi, dap);
 228         if (e != JIM_OK) {
 229                 free(dap);
 230                 return e;
 231         }
 232
 233         cp = Jim_GetString(new_cmd, NULL);
 234         dap->name = strdup(cp);
 235
 236         struct command_registration dap_commands[] = {
 237                 {
 238                         .name = cp,
 239                         .mode = COMMAND_ANY,
 240                         .help = "dap instance command group",
 241                         .usage = "",
 242                         .chain = dap_instance_commands,
 243                 },
 244                 COMMAND_REGISTRATION_DONE
 245         };
 246
 247         /* don't expose the instance commands when using hla */
 248         if (transport_is_hla())
 249                 dap_commands[0].chain = NULL;
 250
 251         e = register_commands(cmd_ctx, NULL, dap_commands);
 252         if (ERROR_OK != e)
 253                 return JIM_ERR;
 254
 255         struct command *c = command_find_in_context(cmd_ctx, cp);
 256         assert(c);
 257         command_set_handler_data(c, dap);
 258
 259         list_add_tail(&dap->lh, &all_dap);
 260
 261         return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
 262 }
 263
 264 static int jim_dap_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 265 {
 266         Jim_GetOptInfo goi;
 267         Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
 268         if (goi.argc < 2) {
 269                 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
 270                         "<name> [<dap_options> ...]");
 271                 return JIM_ERR;
 272         }
 273         return dap_create(&goi);
 274 }
 275
 276 static int jim_dap_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 277 {
 278         struct arm_dap_object *obj;
 279
 280         if (argc != 1) {
 281                 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
 282                 return JIM_ERR;
 283         }
 284         Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
 285         list_for_each_entry(obj, &all_dap, lh) {
 286                 Jim_ListAppendElement(interp, Jim_GetResult(interp),
 287                         Jim_NewStringObj(interp, obj->name, -1));
 288         }
 289         return JIM_OK;
 290 }
 291
 292 COMMAND_HANDLER(handle_dap_init)
 293 {
 294         return dap_init_all();
 295 }
 296
 297 COMMAND_HANDLER(handle_dap_info_command)
 298 {
 299         struct target *target = get_current_target(CMD_CTX);
 300         struct arm *arm = target_to_arm(target);
 301         struct adiv5_dap *dap = arm->dap;
 302         uint32_t apsel;
 303
 304         switch (CMD_ARGC) {
 305                 case 0:
 306                         apsel = dap->apsel;
 307                         break;
 308                 case 1:
 309                         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
 310                         if (apsel >= 256)
 311                                 return ERROR_COMMAND_SYNTAX_ERROR;
 312                         break;
 313                 default:
 314                         return ERROR_COMMAND_SYNTAX_ERROR;
 315         }
 316
 317         return dap_info_command(CMD_CTX, &dap->ap[apsel]);
 318 }
 319
 320 static const struct command_registration dap_subcommand_handlers[] = {
 321         {
 322                 .name = "create",
 323                 .mode = COMMAND_ANY,
 324                 .jim_handler = jim_dap_create,
 325                 .usage = "name '-chain-position' name",
 326                 .help = "Creates a new DAP instance",
 327         },
 328         {
 329                 .name = "names",
 330                 .mode = COMMAND_ANY,
 331                 .jim_handler = jim_dap_names,
 332                 .usage = "",
 333                 .help = "Lists all registered DAP instances by name",
 334         },
 335         {
 336                 .name = "init",
 337                 .mode = COMMAND_ANY,
 338                 .handler = handle_dap_init,
 339                 .usage = "",
 340                 .help = "Initialize all registered DAP instances"
 341         },
 342         {
 343                 .name = "info",
 344                 .handler = handle_dap_info_command,
 345                 .mode = COMMAND_EXEC,
 346                 .help = "display ROM table for MEM-AP of current target "
 347                 "(default currently selected AP)",
 348                 .usage = "[ap_num]",
 349         },
 350         COMMAND_REGISTRATION_DONE
 351 };
 352
 353 static const struct command_registration dap_commands[] = {
 354         {
 355                 .name = "dap",
 356                 .mode = COMMAND_CONFIG,
 357                 .help = "DAP commands",
 358                 .chain = dap_subcommand_handlers,
 359         },
 360         COMMAND_REGISTRATION_DONE
 361 };
 362
 363 int dap_register_commands(struct command_context *cmd_ctx)
 364 {
 365         return register_commands(cmd_ctx, NULL, dap_commands);
 366 }