git.gag.com Git - fw/openocd/blob - src/target/etm.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.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 #include "armv4_5.h"
  25 #include "etm.h"
  26 #include "etb.h"
  27 #include "image.h"
  28 #include "arm_disassembler.h"
  29 #include "register.h"
  30
  31
  32 /*
  33  * ARM "Embedded Trace Macrocell" (ETM) support -- direct JTAG access.
  34  *
  35  * ETM modules collect instruction and/or data trace information, compress
  36  * it, and transfer it to a debugging host through either a (buffered) trace
  37  * port (often a 38-pin Mictor connector) or an Embedded Trace Buffer (ETB).
  38  *
  39  * There are several generations of these modules.  Original versions have
  40  * JTAG access through a dedicated scan chain.  Recent versions have added
  41  * access via coprocessor instructions, memory addressing, and the ARM Debug
  42  * Interface v5 (ADIv5); and phased out direct JTAG access.
  43  *
  44  * This code supports up to the ETMv1.3 architecture, as seen in ETM9 and
  45  * most common ARM9 systems.  Note: "CoreSight ETM9" implements ETMv3.2,
  46  * implying non-JTAG connectivity options.
  47  *
  48  * Relevant documentation includes:
  49  *  ARM DDI 0157G ... ETM9 (r2p2) Technical Reference Manual
  50  *  ARM DDI 0315B ... CoreSight ETM9 (r0p1) Technical Reference Manual
  51  *  ARM IHI 0014O ... Embedded Trace Macrocell, Architecture Specification
  52  */
  53
  54 enum {
  55         RO,                             /* read/only */
  56         WO,                             /* write/only */
  57         RW,                             /* read/write */
  58 };
  59
  60 struct etm_reg_info {
  61         uint8_t         addr;
  62         uint8_t         size;           /* low-N of 32 bits */
  63         uint8_t         mode;           /* RO, WO, RW */
  64         uint8_t         bcd_vers;       /* 1.0, 2.0, etc */
  65         char            *name;
  66 };
  67
  68 /*
  69  * Registers 0..0x7f are JTAG-addressable using scanchain 6.
  70  * (Or on some processors, through coprocessor operations.)
  71  * Newer versions of ETM make some W/O registers R/W, and
  72  * provide definitions for some previously-unused bits.
  73  */
  74
  75 /* core registers used to version/configure the ETM */
  76 static const struct etm_reg_info etm_core[] = {
  77         /* NOTE: we "know" the order here ... */
  78         { ETM_CONFIG, 32, RO, 0x10, "ETM_config", },
  79         { ETM_ID, 32, RO, 0x20, "ETM_id", },
  80 };
  81
  82 /* basic registers that are always there given the right ETM version */
  83 static const struct etm_reg_info etm_basic[] = {
  84         /* ETM Trace Registers */
  85         { ETM_CTRL, 32, RW, 0x10, "ETM_ctrl", },
  86         { ETM_TRIG_EVENT, 17, WO, 0x10, "ETM_trig_event", },
  87         { ETM_ASIC_CTRL,  8, WO, 0x10, "ETM_asic_ctrl", },
  88         { ETM_STATUS,  3, RO, 0x11, "ETM_status", },
  89         { ETM_SYS_CONFIG,  9, RO, 0x12, "ETM_sys_config", },
  90
  91         /* TraceEnable configuration */
  92         { ETM_TRACE_RESOURCE_CTRL, 32, WO, 0x12, "ETM_trace_resource_ctrl", },
  93         { ETM_TRACE_EN_CTRL2, 16, WO, 0x12, "ETM_trace_en_ctrl2", },
  94         { ETM_TRACE_EN_EVENT, 17, WO, 0x10, "ETM_trace_en_event", },
  95         { ETM_TRACE_EN_CTRL1, 26, WO, 0x10, "ETM_trace_en_ctrl1", },
  96
  97         /* ViewData configuration (data trace) */
  98         { ETM_VIEWDATA_EVENT, 17, WO, 0x10, "ETM_viewdata_event", },
  99         { ETM_VIEWDATA_CTRL1, 32, WO, 0x10, "ETM_viewdata_ctrl1", },
 100         { ETM_VIEWDATA_CTRL2, 32, WO, 0x10, "ETM_viewdata_ctrl2", },
 101         { ETM_VIEWDATA_CTRL3, 17, WO, 0x10, "ETM_viewdata_ctrl3", },
 102
 103         /* REVISIT exclude VIEWDATA_CTRL2 when it's not there */
 104
 105         { 0x78, 12, WO, 0x20, "ETM_sync_freq", },
 106         { 0x7a, 22, RO, 0x31, "ETM_config_code_ext", },
 107         { 0x7b, 32, WO, 0x31, "ETM_ext_input_select", },
 108         { 0x7c, 32, WO, 0x34, "ETM_trace_start_stop", },
 109         { 0x7d, 8, WO, 0x34, "ETM_behavior_control", },
 110 };
 111
 112 static const struct etm_reg_info etm_fifofull[] = {
 113         /* FIFOFULL configuration */
 114         { ETM_FIFOFULL_REGION, 25, WO, 0x10, "ETM_fifofull_region", },
 115         { ETM_FIFOFULL_LEVEL,  8, WO, 0x10, "ETM_fifofull_level", },
 116 };
 117
 118 static const struct etm_reg_info etm_addr_comp[] = {
 119         /* Address comparator register pairs */
 120 #define ADDR_COMPARATOR(i) \
 121                 { ETM_ADDR_COMPARATOR_VALUE + (i) - 1, 32, WO, 0x10, \
 122                                 "ETM_addr_" #i "_comparator_value", }, \
 123                 { ETM_ADDR_ACCESS_TYPE + (i) - 1,  7, WO, 0x10, \
 124                                 "ETM_addr_" #i "_access_type", }
 125         ADDR_COMPARATOR(1),
 126         ADDR_COMPARATOR(2),
 127         ADDR_COMPARATOR(3),
 128         ADDR_COMPARATOR(4),
 129         ADDR_COMPARATOR(5),
 130         ADDR_COMPARATOR(6),
 131         ADDR_COMPARATOR(7),
 132         ADDR_COMPARATOR(8),
 133
 134         ADDR_COMPARATOR(9),
 135         ADDR_COMPARATOR(10),
 136         ADDR_COMPARATOR(11),
 137         ADDR_COMPARATOR(12),
 138         ADDR_COMPARATOR(13),
 139         ADDR_COMPARATOR(14),
 140         ADDR_COMPARATOR(15),
 141         ADDR_COMPARATOR(16),
 142 #undef ADDR_COMPARATOR
 143 };
 144
 145 static const struct etm_reg_info etm_data_comp[] = {
 146         /* Data Value Comparators (NOTE: odd addresses are reserved) */
 147 #define DATA_COMPARATOR(i) \
 148                 { ETM_DATA_COMPARATOR_VALUE + 2*(i) - 1, 32, WO, 0x10, \
 149                                 "ETM_data_" #i "_comparator_value", }, \
 150                 { ETM_DATA_COMPARATOR_MASK + 2*(i) - 1, 32, WO, 0x10, \
 151                                 "ETM_data_" #i "_comparator_mask", }
 152         DATA_COMPARATOR(1),
 153         DATA_COMPARATOR(2),
 154         DATA_COMPARATOR(3),
 155         DATA_COMPARATOR(4),
 156         DATA_COMPARATOR(5),
 157         DATA_COMPARATOR(6),
 158         DATA_COMPARATOR(7),
 159         DATA_COMPARATOR(8),
 160 #undef DATA_COMPARATOR
 161 };
 162
 163 static const struct etm_reg_info etm_counters[] = {
 164 #define ETM_COUNTER(i) \
 165                 { ETM_COUNTER_RELOAD_VALUE + (i) - 1, 16, WO, 0x10, \
 166                                 "ETM_counter_" #i "_reload_value", }, \
 167                 { ETM_COUNTER_ENABLE + (i) - 1, 18, WO, 0x10, \
 168                                 "ETM_counter_" #i "_enable", }, \
 169                 { ETM_COUNTER_RELOAD_EVENT + (i) - 1, 17, WO, 0x10, \
 170                                 "ETM_counter_" #i "_reload_event", }, \
 171                 { ETM_COUNTER_VALUE + (i) - 1, 16, RO, 0x10, \
 172                                 "ETM_counter_" #i "_value", }
 173         ETM_COUNTER(1),
 174         ETM_COUNTER(2),
 175         ETM_COUNTER(3),
 176         ETM_COUNTER(4),
 177 #undef ETM_COUNTER
 178 };
 179
 180 static const struct etm_reg_info etm_sequencer[] = {
 181 #define ETM_SEQ(i) \
 182                 { ETM_SEQUENCER_EVENT + (i), 17, WO, 0x10, \
 183                                 "ETM_sequencer_event" #i, }
 184         ETM_SEQ(0),                             /* 1->2 */
 185         ETM_SEQ(1),                             /* 2->1 */
 186         ETM_SEQ(2),                             /* 2->3 */
 187         ETM_SEQ(3),                             /* 3->1 */
 188         ETM_SEQ(4),                             /* 3->2 */
 189         ETM_SEQ(5),                             /* 1->3 */
 190 #undef ETM_SEQ
 191         /* 0x66 reserved */
 192         { ETM_SEQUENCER_STATE,  2, RO, 0x10, "ETM_sequencer_state", },
 193 };
 194
 195 static const struct etm_reg_info etm_outputs[] = {
 196 #define ETM_OUTPUT(i) \
 197                 { ETM_EXTERNAL_OUTPUT + (i) - 1, 17, WO, 0x10, \
 198                                 "ETM_external_output" #i, }
 199
 200         ETM_OUTPUT(1),
 201         ETM_OUTPUT(2),
 202         ETM_OUTPUT(3),
 203         ETM_OUTPUT(4),
 204 #undef ETM_OUTPUT
 205 };
 206
 207 #if 0
 208         /* registers from 0x6c..0x7f were added after ETMv1.3 */
 209
 210         /* Context ID Comparators */
 211         { 0x6c, 32, RO, 0x20, "ETM_contextid_comparator_value1", }
 212         { 0x6d, 32, RO, 0x20, "ETM_contextid_comparator_value2", }
 213         { 0x6e, 32, RO, 0x20, "ETM_contextid_comparator_value3", }
 214         { 0x6f, 32, RO, 0x20, "ETM_contextid_comparator_mask", }
 215 #endif
 216
 217 static int etm_get_reg(struct reg *reg);
 218 static int etm_read_reg_w_check(struct reg *reg,
 219                 uint8_t* check_value, uint8_t* check_mask);
 220 static int etm_register_user_commands(struct command_context *cmd_ctx);
 221 static int etm_set_reg_w_exec(struct reg *reg, uint8_t *buf);
 222 static int etm_write_reg(struct reg *reg, uint32_t value);
 223
 224 static const struct reg_arch_type etm_scan6_type = {
 225         .get = etm_get_reg,
 226         .set = etm_set_reg_w_exec,
 227 };
 228
 229 /* Look up register by ID ... most ETM instances only
 230  * support a subset of the possible registers.
 231  */
 232 static struct reg *etm_reg_lookup(struct etm_context *etm_ctx, unsigned id)
 233 {
 234         struct reg_cache *cache = etm_ctx->reg_cache;
 235         unsigned i;
 236
 237         for (i = 0; i < cache->num_regs; i++) {
 238                 struct etm_reg *reg = cache->reg_list[i].arch_info;
 239
 240                 if (reg->reg_info->addr == id)
 241                         return &cache->reg_list[i];
 242         }
 243
 244         /* caller asking for nonexistent register is a bug! */
 245         /* REVISIT say which of the N targets was involved */
 246         LOG_ERROR("ETM: register 0x%02x not available", id);
 247         return NULL;
 248 }
 249
 250 static void etm_reg_add(unsigned bcd_vers, struct arm_jtag *jtag_info,
 251                 struct reg_cache *cache, struct etm_reg *ereg,
 252                 const struct etm_reg_info *r, unsigned nreg)
 253 {
 254         struct reg *reg = cache->reg_list;
 255
 256         reg += cache->num_regs;
 257         ereg += cache->num_regs;
 258
 259         /* add up to "nreg" registers from "r", if supported by this
 260          * version of the ETM, to the specified cache.
 261          */
 262         for (; nreg--; r++) {
 263
 264                 /* this ETM may be too old to have some registers */
 265                 if (r->bcd_vers > bcd_vers)
 266                         continue;
 267
 268                 reg->name = r->name;
 269                 reg->size = r->size;
 270                 reg->value = &ereg->value;
 271                 reg->arch_info = ereg;
 272                 reg->type = &etm_scan6_type;
 273                 reg++;
 274                 cache->num_regs++;
 275
 276                 ereg->reg_info = r;
 277                 ereg->jtag_info = jtag_info;
 278                 ereg++;
 279         }
 280 }
 281
 282 struct reg_cache *etm_build_reg_cache(struct target *target,
 283                 struct arm_jtag *jtag_info, struct etm_context *etm_ctx)
 284 {
 285         struct reg_cache *reg_cache = malloc(sizeof(struct reg_cache));
 286         struct reg *reg_list = NULL;
 287         struct etm_reg *arch_info = NULL;
 288         unsigned bcd_vers, config;
 289
 290         /* the actual registers are kept in two arrays */
 291         reg_list = calloc(128, sizeof(struct reg));
 292         arch_info = calloc(128, sizeof(struct etm_reg));
 293
 294         /* fill in values for the reg cache */
 295         reg_cache->name = "etm registers";
 296         reg_cache->next = NULL;
 297         reg_cache->reg_list = reg_list;
 298         reg_cache->num_regs = 0;
 299
 300         /* add ETM_CONFIG, then parse its values to see
 301          * which other registers exist in this ETM
 302          */
 303         etm_reg_add(0x10, jtag_info, reg_cache, arch_info,
 304                         etm_core, 1);
 305
 306         etm_get_reg(reg_list);
 307         etm_ctx->config = buf_get_u32((void *)&arch_info->value, 0, 32);
 308         config = etm_ctx->config;
 309
 310         /* figure ETM version then add base registers */
 311         if (config & (1 << 31)) {
 312                 bcd_vers = 0x20;
 313                 LOG_WARNING("ETMv2+ support is incomplete");
 314
 315                 /* REVISIT more registers may exist; they may now be
 316                  * readable; more register bits have defined meanings;
 317                  * don't presume trace start/stop support is present;
 318                  * and include any context ID comparator registers.
 319                  */
 320                 etm_reg_add(0x20, jtag_info, reg_cache, arch_info,
 321                                 etm_core + 1, 1);
 322                 etm_get_reg(reg_list + 1);
 323                 etm_ctx->id = buf_get_u32(
 324                                 (void *)&arch_info[1].value, 0, 32);
 325                 LOG_DEBUG("ETM ID: %08x", (unsigned) etm_ctx->id);
 326                 bcd_vers = 0x10 + (((etm_ctx->id) >> 4) & 0xff);
 327
 328         } else {
 329                 switch (config >> 28) {
 330                 case 7:
 331                 case 5:
 332                 case 3:
 333                         bcd_vers = 0x13;
 334                         break;
 335                 case 4:
 336                 case 2:
 337                         bcd_vers = 0x12;
 338                         break;
 339                 case 1:
 340                         bcd_vers = 0x11;
 341                         break;
 342                 case 0:
 343                         bcd_vers = 0x10;
 344                         break;
 345                 default:
 346                         LOG_WARNING("Bad ETMv1 protocol %d", config >> 28);
 347                         goto fail;
 348                 }
 349         }
 350         etm_ctx->bcd_vers = bcd_vers;
 351         LOG_INFO("ETM v%d.%d", bcd_vers >> 4, bcd_vers & 0xf);
 352
 353         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 354                         etm_basic, ARRAY_SIZE(etm_basic));
 355
 356         /* address and data comparators; counters; outputs */
 357         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 358                         etm_addr_comp, 4 * (0x0f & (config >> 0)));
 359         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 360                         etm_data_comp, 2 * (0x0f & (config >> 4)));
 361         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 362                         etm_counters, 4 * (0x07 & (config >> 13)));
 363         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 364                         etm_outputs, (0x07 & (config >> 20)));
 365
 366         /* FIFOFULL presence is optional
 367          * REVISIT for ETMv1.2 and later, don't bother adding this
 368          * unless ETM_SYS_CONFIG says it's also *supported* ...
 369          */
 370         if (config & (1 << 23))
 371                 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 372                                 etm_fifofull, ARRAY_SIZE(etm_fifofull));
 373
 374         /* sequencer is optional (for state-dependant triggering) */
 375         if (config & (1 << 16))
 376                 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
 377                                 etm_sequencer, ARRAY_SIZE(etm_sequencer));
 378
 379         /* REVISIT could realloc and likely save half the memory
 380          * in the two chunks we allocated...
 381          */
 382
 383         /* the ETM might have an ETB connected */
 384         if (strcmp(etm_ctx->capture_driver->name, "etb") == 0)
 385         {
 386                 struct etb *etb = etm_ctx->capture_driver_priv;
 387
 388                 if (!etb)
 389                 {
 390                         LOG_ERROR("etb selected as etm capture driver, but no ETB configured");
 391                         goto fail;
 392                 }
 393
 394                 reg_cache->next = etb_build_reg_cache(etb);
 395
 396                 etb->reg_cache = reg_cache->next;
 397         }
 398
 399         etm_ctx->reg_cache = reg_cache;
 400         return reg_cache;
 401
 402 fail:
 403         free(reg_cache);
 404         free(reg_list);
 405         free(arch_info);
 406         return NULL;
 407 }
 408
 409 static int etm_read_reg(struct reg *reg)
 410 {
 411         return etm_read_reg_w_check(reg, NULL, NULL);
 412 }
 413
 414 static int etm_store_reg(struct reg *reg)
 415 {
 416         return etm_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
 417 }
 418
 419 int etm_setup(struct target *target)
 420 {
 421         int retval;
 422         uint32_t etm_ctrl_value;
 423         struct arm *arm = target_to_arm(target);
 424         struct etm_context *etm_ctx = arm->etm;
 425         struct reg *etm_ctrl_reg;
 426
 427         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
 428         if (!etm_ctrl_reg)
 429                 return ERROR_OK;
 430
 431         /* initialize some ETM control register settings */
 432         etm_get_reg(etm_ctrl_reg);
 433         etm_ctrl_value = buf_get_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size);
 434
 435         /* clear the ETM powerdown bit (0) */
 436         etm_ctrl_value &= ~0x1;
 437
 438         /* configure port width (21,6:4), mode (13,17:16) and
 439          * for older modules clocking (13)
 440          */
 441         etm_ctrl_value = (etm_ctrl_value
 442                         & ~ETM_PORT_WIDTH_MASK
 443                         & ~ETM_PORT_MODE_MASK
 444                         & ~ETM_PORT_CLOCK_MASK)
 445                 | etm_ctx->portmode;
 446
 447         buf_set_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size, etm_ctrl_value);
 448         etm_store_reg(etm_ctrl_reg);
 449
 450         if ((retval = jtag_execute_queue()) != ERROR_OK)
 451                 return retval;
 452
 453         /* REVISIT for ETMv3.0 and later, read ETM_sys_config to
 454          * verify that those width and mode settings are OK ...
 455          */
 456
 457         if ((retval = etm_ctx->capture_driver->init(etm_ctx)) != ERROR_OK)
 458         {
 459                 LOG_ERROR("ETM capture driver initialization failed");
 460                 return retval;
 461         }
 462         return ERROR_OK;
 463 }
 464
 465 static int etm_get_reg(struct reg *reg)
 466 {
 467         int retval;
 468
 469         if ((retval = etm_read_reg(reg)) != ERROR_OK)
 470         {
 471                 LOG_ERROR("BUG: error scheduling etm register read");
 472                 return retval;
 473         }
 474
 475         if ((retval = jtag_execute_queue()) != ERROR_OK)
 476         {
 477                 LOG_ERROR("register read failed");
 478                 return retval;
 479         }
 480
 481         return ERROR_OK;
 482 }
 483
 484 static int etm_read_reg_w_check(struct reg *reg,
 485                 uint8_t* check_value, uint8_t* check_mask)
 486 {
 487         struct etm_reg *etm_reg = reg->arch_info;
 488         const struct etm_reg_info *r = etm_reg->reg_info;
 489         uint8_t reg_addr = r->addr & 0x7f;
 490         struct scan_field fields[3];
 491
 492         if (etm_reg->reg_info->mode == WO) {
 493                 LOG_ERROR("BUG: can't read write-only register %s", r->name);
 494                 return ERROR_INVALID_ARGUMENTS;
 495         }
 496
 497         LOG_DEBUG("%s (%u)", r->name, reg_addr);
 498
 499         jtag_set_end_state(TAP_IDLE);
 500         arm_jtag_scann(etm_reg->jtag_info, 0x6);
 501         arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
 502
 503         fields[0].tap = etm_reg->jtag_info->tap;
 504         fields[0].num_bits = 32;
 505         fields[0].out_value = reg->value;
 506         fields[0].in_value = NULL;
 507         fields[0].check_value = NULL;
 508         fields[0].check_mask = NULL;
 509
 510         fields[1].tap = etm_reg->jtag_info->tap;
 511         fields[1].num_bits = 7;
 512         fields[1].out_value = malloc(1);
 513         buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
 514         fields[1].in_value = NULL;
 515         fields[1].check_value = NULL;
 516         fields[1].check_mask = NULL;
 517
 518         fields[2].tap = etm_reg->jtag_info->tap;
 519         fields[2].num_bits = 1;
 520         fields[2].out_value = malloc(1);
 521         buf_set_u32(fields[2].out_value, 0, 1, 0);
 522         fields[2].in_value = NULL;
 523         fields[2].check_value = NULL;
 524         fields[2].check_mask = NULL;
 525
 526         jtag_add_dr_scan(3, fields, jtag_get_end_state());
 527
 528         fields[0].in_value = reg->value;
 529         fields[0].check_value = check_value;
 530         fields[0].check_mask = check_mask;
 531
 532         jtag_add_dr_scan_check(3, fields, jtag_get_end_state());
 533
 534         free(fields[1].out_value);
 535         free(fields[2].out_value);
 536
 537         return ERROR_OK;
 538 }
 539
 540 static int etm_set_reg(struct reg *reg, uint32_t value)
 541 {
 542         int retval;
 543
 544         if ((retval = etm_write_reg(reg, value)) != ERROR_OK)
 545         {
 546                 LOG_ERROR("BUG: error scheduling etm register write");
 547                 return retval;
 548         }
 549
 550         buf_set_u32(reg->value, 0, reg->size, value);
 551         reg->valid = 1;
 552         reg->dirty = 0;
 553
 554         return ERROR_OK;
 555 }
 556
 557 static int etm_set_reg_w_exec(struct reg *reg, uint8_t *buf)
 558 {
 559         int retval;
 560
 561         etm_set_reg(reg, buf_get_u32(buf, 0, reg->size));
 562
 563         if ((retval = jtag_execute_queue()) != ERROR_OK)
 564         {
 565                 LOG_ERROR("register write failed");
 566                 return retval;
 567         }
 568         return ERROR_OK;
 569 }
 570
 571 static int etm_write_reg(struct reg *reg, uint32_t value)
 572 {
 573         struct etm_reg *etm_reg = reg->arch_info;
 574         const struct etm_reg_info *r = etm_reg->reg_info;
 575         uint8_t reg_addr = r->addr & 0x7f;
 576         struct scan_field fields[3];
 577
 578         if (etm_reg->reg_info->mode == RO) {
 579                 LOG_ERROR("BUG: can't write read--only register %s", r->name);
 580                 return ERROR_INVALID_ARGUMENTS;
 581         }
 582
 583         LOG_DEBUG("%s (%u): 0x%8.8" PRIx32 "", r->name, reg_addr, value);
 584
 585         jtag_set_end_state(TAP_IDLE);
 586         arm_jtag_scann(etm_reg->jtag_info, 0x6);
 587         arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
 588
 589         fields[0].tap = etm_reg->jtag_info->tap;
 590         fields[0].num_bits = 32;
 591         uint8_t tmp1[4];
 592         fields[0].out_value = tmp1;
 593         buf_set_u32(fields[0].out_value, 0, 32, value);
 594         fields[0].in_value = NULL;
 595
 596         fields[1].tap = etm_reg->jtag_info->tap;
 597         fields[1].num_bits = 7;
 598         uint8_t tmp2;
 599         fields[1].out_value = &tmp2;
 600         buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
 601         fields[1].in_value = NULL;
 602
 603         fields[2].tap = etm_reg->jtag_info->tap;
 604         fields[2].num_bits = 1;
 605         uint8_t tmp3;
 606         fields[2].out_value = &tmp3;
 607         buf_set_u32(fields[2].out_value, 0, 1, 1);
 608         fields[2].in_value = NULL;
 609
 610         jtag_add_dr_scan(3, fields, jtag_get_end_state());
 611
 612         return ERROR_OK;
 613 }
 614
 615
 616 /* ETM trace analysis functionality
 617  *
 618  */
 619 extern struct etm_capture_driver etm_dummy_capture_driver;
 620 #if BUILD_OOCD_TRACE == 1
 621 extern struct etm_capture_driver oocd_trace_capture_driver;
 622 #endif
 623
 624 static struct etm_capture_driver *etm_capture_drivers[] =
 625 {
 626         &etb_capture_driver,
 627         &etm_dummy_capture_driver,
 628 #if BUILD_OOCD_TRACE == 1
 629         &oocd_trace_capture_driver,
 630 #endif
 631         NULL
 632 };
 633
 634 static int etm_read_instruction(struct etm_context *ctx, struct arm_instruction *instruction)
 635 {
 636         int i;
 637         int section = -1;
 638         size_t size_read;
 639         uint32_t opcode;
 640         int retval;
 641
 642         if (!ctx->image)
 643                 return ERROR_TRACE_IMAGE_UNAVAILABLE;
 644
 645         /* search for the section the current instruction belongs to */
 646         for (i = 0; i < ctx->image->num_sections; i++)
 647         {
 648                 if ((ctx->image->sections[i].base_address <= ctx->current_pc) &&
 649                         (ctx->image->sections[i].base_address + ctx->image->sections[i].size > ctx->current_pc))
 650                 {
 651                         section = i;
 652                         break;
 653                 }
 654         }
 655
 656         if (section == -1)
 657         {
 658                 /* current instruction couldn't be found in the image */
 659                 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
 660         }
 661
 662         if (ctx->core_state == ARMV4_5_STATE_ARM)
 663         {
 664                 uint8_t buf[4];
 665                 if ((retval = image_read_section(ctx->image, section,
 666                         ctx->current_pc - ctx->image->sections[section].base_address,
 667                         4, buf, &size_read)) != ERROR_OK)
 668                 {
 669                         LOG_ERROR("error while reading instruction: %i", retval);
 670                         return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
 671                 }
 672                 opcode = target_buffer_get_u32(ctx->target, buf);
 673                 arm_evaluate_opcode(opcode, ctx->current_pc, instruction);
 674         }
 675         else if (ctx->core_state == ARMV4_5_STATE_THUMB)
 676         {
 677                 uint8_t buf[2];
 678                 if ((retval = image_read_section(ctx->image, section,
 679                         ctx->current_pc - ctx->image->sections[section].base_address,
 680                         2, buf, &size_read)) != ERROR_OK)
 681                 {
 682                         LOG_ERROR("error while reading instruction: %i", retval);
 683                         return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
 684                 }
 685                 opcode = target_buffer_get_u16(ctx->target, buf);
 686                 thumb_evaluate_opcode(opcode, ctx->current_pc, instruction);
 687         }
 688         else if (ctx->core_state == ARMV4_5_STATE_JAZELLE)
 689         {
 690                 LOG_ERROR("BUG: tracing of jazelle code not supported");
 691                 return ERROR_FAIL;
 692         }
 693         else
 694         {
 695                 LOG_ERROR("BUG: unknown core state encountered");
 696                 return ERROR_FAIL;
 697         }
 698
 699         return ERROR_OK;
 700 }
 701
 702 static int etmv1_next_packet(struct etm_context *ctx, uint8_t *packet, int apo)
 703 {
 704         while (ctx->data_index < ctx->trace_depth)
 705         {
 706                 /* if the caller specified an address packet offset, skip until the
 707                  * we reach the n-th cycle marked with tracesync */
 708                 if (apo > 0)
 709                 {
 710                         if (ctx->trace_data[ctx->data_index].flags & ETMV1_TRACESYNC_CYCLE)
 711                                 apo--;
 712
 713                         if (apo > 0)
 714                         {
 715                                 ctx->data_index++;
 716                                 ctx->data_half = 0;
 717                         }
 718                         continue;
 719                 }
 720
 721                 /* no tracedata output during a TD cycle
 722                  * or in a trigger cycle */
 723                 if ((ctx->trace_data[ctx->data_index].pipestat == STAT_TD)
 724                         || (ctx->trace_data[ctx->data_index].flags & ETMV1_TRIGGER_CYCLE))
 725                 {
 726                         ctx->data_index++;
 727                         ctx->data_half = 0;
 728                         continue;
 729                 }
 730
 731                 if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_16BIT)
 732                 {
 733                         if (ctx->data_half == 0)
 734                         {
 735                                 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
 736                                 ctx->data_half = 1;
 737                         }
 738                         else
 739                         {
 740                                 *packet = (ctx->trace_data[ctx->data_index].packet & 0xff00) >> 8;
 741                                 ctx->data_half = 0;
 742                                 ctx->data_index++;
 743                         }
 744                 }
 745                 else if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_8BIT)
 746                 {
 747                         *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
 748                         ctx->data_index++;
 749                 }
 750                 else
 751                 {
 752                         /* on a 4-bit port, a packet will be output during two consecutive cycles */
 753                         if (ctx->data_index > (ctx->trace_depth - 2))
 754                                 return -1;
 755
 756                         *packet = ctx->trace_data[ctx->data_index].packet & 0xf;
 757                         *packet |= (ctx->trace_data[ctx->data_index + 1].packet & 0xf) << 4;
 758                         ctx->data_index += 2;
 759                 }
 760
 761                 return 0;
 762         }
 763
 764         return -1;
 765 }
 766
 767 static int etmv1_branch_address(struct etm_context *ctx)
 768 {
 769         int retval;
 770         uint8_t packet;
 771         int shift = 0;
 772         int apo;
 773         uint32_t i;
 774
 775         /* quit analysis if less than two cycles are left in the trace
 776          * because we can't extract the APO */
 777         if (ctx->data_index > (ctx->trace_depth - 2))
 778                 return -1;
 779
 780         /* a BE could be output during an APO cycle, skip the current
 781          * and continue with the new one */
 782         if (ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x4)
 783                 return 1;
 784         if (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x4)
 785                 return 2;
 786
 787         /* address packet offset encoded in the next two cycles' pipestat bits */
 788         apo = ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x3;
 789         apo |= (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x3) << 2;
 790
 791         /* count number of tracesync cycles between current pipe_index and data_index
 792          * i.e. the number of tracesyncs that data_index already passed by
 793          * to subtract them from the APO */
 794         for (i = ctx->pipe_index; i < ctx->data_index; i++)
 795         {
 796                 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & ETMV1_TRACESYNC_CYCLE)
 797                         apo--;
 798         }
 799
 800         /* extract up to four 7-bit packets */
 801         do {
 802                 if ((retval = etmv1_next_packet(ctx, &packet, (shift == 0) ? apo + 1 : 0)) != 0)
 803                         return -1;
 804                 ctx->last_branch &= ~(0x7f << shift);
 805                 ctx->last_branch |= (packet & 0x7f) << shift;
 806                 shift += 7;
 807         } while ((packet & 0x80) && (shift < 28));
 808
 809         /* one last packet holding 4 bits of the address, plus the branch reason code */
 810         if ((shift == 28) && (packet & 0x80))
 811         {
 812                 if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
 813                         return -1;
 814                 ctx->last_branch &= 0x0fffffff;
 815                 ctx->last_branch |= (packet & 0x0f) << 28;
 816                 ctx->last_branch_reason = (packet & 0x70) >> 4;
 817                 shift += 4;
 818         }
 819         else
 820         {
 821                 ctx->last_branch_reason = 0;
 822         }
 823
 824         if (shift == 32)
 825         {
 826                 ctx->pc_ok = 1;
 827         }
 828
 829         /* if a full address was output, we might have branched into Jazelle state */
 830         if ((shift == 32) && (packet & 0x80))
 831         {
 832                 ctx->core_state = ARMV4_5_STATE_JAZELLE;
 833         }
 834         else
 835         {
 836                 /* if we didn't branch into Jazelle state, the current processor state is
 837                  * encoded in bit 0 of the branch target address */
 838                 if (ctx->last_branch & 0x1)
 839                 {
 840                         ctx->core_state = ARMV4_5_STATE_THUMB;
 841                         ctx->last_branch &= ~0x1;
 842                 }
 843                 else
 844                 {
 845                         ctx->core_state = ARMV4_5_STATE_ARM;
 846                         ctx->last_branch &= ~0x3;
 847                 }
 848         }
 849
 850         return 0;
 851 }
 852
 853 static int etmv1_data(struct etm_context *ctx, int size, uint32_t *data)
 854 {
 855         int j;
 856         uint8_t buf[4];
 857         int retval;
 858
 859         for (j = 0; j < size; j++)
 860         {
 861                 if ((retval = etmv1_next_packet(ctx, &buf[j], 0)) != 0)
 862                         return -1;
 863         }
 864
 865         if (size == 8)
 866         {
 867                 LOG_ERROR("TODO: add support for 64-bit values");
 868                 return -1;
 869         }
 870         else if (size == 4)
 871                 *data = target_buffer_get_u32(ctx->target, buf);
 872         else if (size == 2)
 873                 *data = target_buffer_get_u16(ctx->target, buf);
 874         else if (size == 1)
 875                 *data = buf[0];
 876         else
 877                 return -1;
 878
 879         return 0;
 880 }
 881
 882 static int etmv1_analyze_trace(struct etm_context *ctx, struct command_context *cmd_ctx)
 883 {
 884         int retval;
 885         struct arm_instruction instruction;
 886
 887         /* read the trace data if it wasn't read already */
 888         if (ctx->trace_depth == 0)
 889                 ctx->capture_driver->read_trace(ctx);
 890
 891         /* start at the beginning of the captured trace */
 892         ctx->pipe_index = 0;
 893         ctx->data_index = 0;
 894         ctx->data_half = 0;
 895
 896         /* neither the PC nor the data pointer are valid */
 897         ctx->pc_ok = 0;
 898         ctx->ptr_ok = 0;
 899
 900         while (ctx->pipe_index < ctx->trace_depth)
 901         {
 902                 uint8_t pipestat = ctx->trace_data[ctx->pipe_index].pipestat;
 903                 uint32_t next_pc = ctx->current_pc;
 904                 uint32_t old_data_index = ctx->data_index;
 905                 uint32_t old_data_half = ctx->data_half;
 906                 uint32_t old_index = ctx->pipe_index;
 907                 uint32_t last_instruction = ctx->last_instruction;
 908                 uint32_t cycles = 0;
 909                 int current_pc_ok = ctx->pc_ok;
 910
 911                 if (ctx->trace_data[ctx->pipe_index].flags & ETMV1_TRIGGER_CYCLE)
 912                 {
 913                         command_print(cmd_ctx, "--- trigger ---");
 914                 }
 915
 916                 /* instructions execute in IE/D or BE/D cycles */
 917                 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
 918                         ctx->last_instruction = ctx->pipe_index;
 919
 920                 /* if we don't have a valid pc skip until we reach an indirect branch */
 921                 if ((!ctx->pc_ok) && (pipestat != STAT_BE))
 922                 {
 923                         ctx->pipe_index++;
 924                         continue;
 925                 }
 926
 927                 /* any indirect branch could have interrupted instruction flow
 928                  * - the branch reason code could indicate a trace discontinuity
 929                  * - a branch to the exception vectors indicates an exception
 930                  */
 931                 if ((pipestat == STAT_BE) || (pipestat == STAT_BD))
 932                 {
 933                         /* backup current data index, to be able to consume the branch address
 934                          * before examining data address and values
 935                          */
 936                         old_data_index = ctx->data_index;
 937                         old_data_half = ctx->data_half;
 938
 939                         ctx->last_instruction = ctx->pipe_index;
 940
 941                         if ((retval = etmv1_branch_address(ctx)) != 0)
 942                         {
 943                                 /* negative return value from etmv1_branch_address means we ran out of packets,
 944                                  * quit analysing the trace */
 945                                 if (retval < 0)
 946                                         break;
 947
 948                                 /* a positive return values means the current branch was abandoned,
 949                                  * and a new branch was encountered in cycle ctx->pipe_index + retval;
 950                                  */
 951                                 LOG_WARNING("abandoned branch encountered, correctnes of analysis uncertain");
 952                                 ctx->pipe_index += retval;
 953                                 continue;
 954                         }
 955
 956                         /* skip over APO cycles */
 957                         ctx->pipe_index += 2;
 958
 959                         switch (ctx->last_branch_reason)
 960                         {
 961                                 case 0x0:       /* normal PC change */
 962                                         next_pc = ctx->last_branch;
 963                                         break;
 964                                 case 0x1:       /* tracing enabled */
 965                                         command_print(cmd_ctx, "--- tracing enabled at 0x%8.8" PRIx32 " ---", ctx->last_branch);
 966                                         ctx->current_pc = ctx->last_branch;
 967                                         ctx->pipe_index++;
 968                                         continue;
 969                                         break;
 970                                 case 0x2:       /* trace restarted after FIFO overflow */
 971                                         command_print(cmd_ctx, "--- trace restarted after FIFO overflow at 0x%8.8" PRIx32 " ---", ctx->last_branch);
 972                                         ctx->current_pc = ctx->last_branch;
 973                                         ctx->pipe_index++;
 974                                         continue;
 975                                         break;
 976                                 case 0x3:       /* exit from debug state */
 977                                         command_print(cmd_ctx, "--- exit from debug state at 0x%8.8" PRIx32 " ---", ctx->last_branch);
 978                                         ctx->current_pc = ctx->last_branch;
 979                                         ctx->pipe_index++;
 980                                         continue;
 981                                         break;
 982                                 case 0x4:       /* periodic synchronization point */
 983                                         next_pc = ctx->last_branch;
 984                                         /* if we had no valid PC prior to this synchronization point,
 985                                          * we have to move on with the next trace cycle
 986                                          */
 987                                         if (!current_pc_ok)
 988                                         {
 989                                                 command_print(cmd_ctx, "--- periodic synchronization point at 0x%8.8" PRIx32 " ---", next_pc);
 990                                                 ctx->current_pc = next_pc;
 991                                                 ctx->pipe_index++;
 992                                                 continue;
 993                                         }
 994                                         break;
 995                                 default:        /* reserved */
 996                                         LOG_ERROR("BUG: branch reason code 0x%" PRIx32 " is reserved", ctx->last_branch_reason);
 997                                         return ERROR_FAIL;
 998                         }
 999
1000                         /* if we got here the branch was a normal PC change
1001                          * (or a periodic synchronization point, which means the same for that matter)
1002                          * if we didn't accquire a complete PC continue with the next cycle
1003                          */
1004                         if (!ctx->pc_ok)
1005                                 continue;
1006
1007                         /* indirect branch to the exception vector means an exception occured */
1008                         if ((ctx->last_branch <= 0x20)
1009                                 || ((ctx->last_branch >= 0xffff0000) && (ctx->last_branch <= 0xffff0020)))
1010                         {
1011                                 if ((ctx->last_branch & 0xff) == 0x10)
1012                                 {
1013                                         command_print(cmd_ctx, "data abort");
1014                                 }
1015                                 else
1016                                 {
1017                                         command_print(cmd_ctx, "exception vector 0x%2.2" PRIx32 "", ctx->last_branch);
1018                                         ctx->current_pc = ctx->last_branch;
1019                                         ctx->pipe_index++;
1020                                         continue;
1021                                 }
1022                         }
1023                 }
1024
1025                 /* an instruction was executed (or not, depending on the condition flags)
1026                  * retrieve it from the image for displaying */
1027                 if (ctx->pc_ok && (pipestat != STAT_WT) && (pipestat != STAT_TD) &&
1028                         !(((pipestat == STAT_BE) || (pipestat == STAT_BD)) &&
1029                                 ((ctx->last_branch_reason != 0x0) && (ctx->last_branch_reason != 0x4))))
1030                 {
1031                         if ((retval = etm_read_instruction(ctx, &instruction)) != ERROR_OK)
1032                         {
1033                                 /* can't continue tracing with no image available */
1034                                 if (retval == ERROR_TRACE_IMAGE_UNAVAILABLE)
1035                                 {
1036                                         return retval;
1037                                 }
1038                                 else if (retval == ERROR_TRACE_INSTRUCTION_UNAVAILABLE)
1039                                 {
1040                                         /* TODO: handle incomplete images
1041                                          * for now we just quit the analsysis*/
1042                                         return retval;
1043                                 }
1044                         }
1045
1046                         cycles = old_index - last_instruction;
1047                 }
1048
1049                 if ((pipestat == STAT_ID) || (pipestat == STAT_BD))
1050                 {
1051                         uint32_t new_data_index = ctx->data_index;
1052                         uint32_t new_data_half = ctx->data_half;
1053
1054                         /* in case of a branch with data, the branch target address was consumed before
1055                          * we temporarily go back to the saved data index */
1056                         if (pipestat == STAT_BD)
1057                         {
1058                                 ctx->data_index = old_data_index;
1059                                 ctx->data_half = old_data_half;
1060                         }
1061
1062                         if (ctx->tracemode & ETMV1_TRACE_ADDR)
1063                         {
1064                                 uint8_t packet;
1065                                 int shift = 0;
1066
1067                                 do {
1068                                         if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
1069                                                 return ERROR_ETM_ANALYSIS_FAILED;
1070                                         ctx->last_ptr &= ~(0x7f << shift);
1071                                         ctx->last_ptr |= (packet & 0x7f) << shift;
1072                                         shift += 7;
1073                                 } while ((packet & 0x80) && (shift < 32));
1074
1075                                 if (shift >= 32)
1076                                         ctx->ptr_ok = 1;
1077
1078                                 if (ctx->ptr_ok)
1079                                 {
1080                                         command_print(cmd_ctx, "address: 0x%8.8" PRIx32 "", ctx->last_ptr);
1081                                 }
1082                         }
1083
1084                         if (ctx->tracemode & ETMV1_TRACE_DATA)
1085                         {
1086                                 if ((instruction.type == ARM_LDM) || (instruction.type == ARM_STM))
1087                                 {
1088                                         int i;
1089                                         for (i = 0; i < 16; i++)
1090                                         {
1091                                                 if (instruction.info.load_store_multiple.register_list & (1 << i))
1092                                                 {
1093                                                         uint32_t data;
1094                                                         if (etmv1_data(ctx, 4, &data) != 0)
1095                                                                 return ERROR_ETM_ANALYSIS_FAILED;
1096                                                         command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1097                                                 }
1098                                         }
1099                                 }
1100                                 else if ((instruction.type >= ARM_LDR) && (instruction.type <= ARM_STRH))
1101                                 {
1102                                         uint32_t data;
1103                                         if (etmv1_data(ctx, arm_access_size(&instruction), &data) != 0)
1104                                                 return ERROR_ETM_ANALYSIS_FAILED;
1105                                         command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1106                                 }
1107                         }
1108
1109                         /* restore data index after consuming BD address and data */
1110                         if (pipestat == STAT_BD)
1111                         {
1112                                 ctx->data_index = new_data_index;
1113                                 ctx->data_half = new_data_half;
1114                         }
1115                 }
1116
1117                 /* adjust PC */
1118                 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
1119                 {
1120                         if (((instruction.type == ARM_B) ||
1121                              (instruction.type == ARM_BL) ||
1122                              (instruction.type == ARM_BLX)) &&
1123                             (instruction.info.b_bl_bx_blx.target_address != 0xffffffff))
1124                         {
1125                                 next_pc = instruction.info.b_bl_bx_blx.target_address;
1126                         }
1127                         else
1128                         {
1129                                 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1130                         }
1131                 }
1132                 else if (pipestat == STAT_IN)
1133                 {
1134                         next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1135                 }
1136
1137                 if ((pipestat != STAT_TD) && (pipestat != STAT_WT))
1138                 {
1139                         char cycles_text[32] = "";
1140
1141                         /* if the trace was captured with cycle accurate tracing enabled,
1142                          * output the number of cycles since the last executed instruction
1143                          */
1144                         if (ctx->tracemode & ETMV1_CYCLE_ACCURATE)
1145                         {
1146                                 snprintf(cycles_text, 32, " (%i %s)",
1147                                          (int)cycles,
1148                                         (cycles == 1) ? "cycle" : "cycles");
1149                         }
1150
1151                         command_print(cmd_ctx, "%s%s%s",
1152                                 instruction.text,
1153                                 (pipestat == STAT_IN) ? " (not executed)" : "",
1154                                 cycles_text);
1155
1156                         ctx->current_pc = next_pc;
1157
1158                         /* packets for an instruction don't start on or before the preceding
1159                          * functional pipestat (i.e. other than WT or TD)
1160                          */
1161                         if (ctx->data_index <= ctx->pipe_index)
1162                         {
1163                                 ctx->data_index = ctx->pipe_index + 1;
1164                                 ctx->data_half = 0;
1165                         }
1166                 }
1167
1168                 ctx->pipe_index += 1;
1169         }
1170
1171         return ERROR_OK;
1172 }
1173
1174 static COMMAND_HELPER(handle_etm_tracemode_command_update,
1175                 etmv1_tracemode_t *mode)
1176 {
1177         etmv1_tracemode_t tracemode;
1178
1179         /* what parts of data access are traced? */
1180         if (strcmp(CMD_ARGV[0], "none") == 0)
1181                 tracemode = ETMV1_TRACE_NONE;
1182         else if (strcmp(CMD_ARGV[0], "data") == 0)
1183                 tracemode = ETMV1_TRACE_DATA;
1184         else if (strcmp(CMD_ARGV[0], "address") == 0)
1185                 tracemode = ETMV1_TRACE_ADDR;
1186         else if (strcmp(CMD_ARGV[0], "all") == 0)
1187                 tracemode = ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR;
1188         else
1189         {
1190                 command_print(CMD_CTX, "invalid option '%s'", CMD_ARGV[0]);
1191                 return ERROR_INVALID_ARGUMENTS;
1192         }
1193
1194         uint8_t context_id;
1195         COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], context_id);
1196         switch (context_id)
1197         {
1198         case 0:
1199                 tracemode |= ETMV1_CONTEXTID_NONE;
1200                 break;
1201         case 8:
1202                 tracemode |= ETMV1_CONTEXTID_8;
1203                 break;
1204         case 16:
1205                 tracemode |= ETMV1_CONTEXTID_16;
1206                 break;
1207         case 32:
1208                 tracemode |= ETMV1_CONTEXTID_32;
1209                 break;
1210         default:
1211                 command_print(CMD_CTX, "invalid option '%s'", CMD_ARGV[1]);
1212                 return ERROR_INVALID_ARGUMENTS;
1213         }
1214
1215         bool etmv1_cycle_accurate;
1216         COMMAND_PARSE_ENABLE(CMD_ARGV[2], etmv1_cycle_accurate);
1217         if (etmv1_cycle_accurate)
1218                 tracemode |= ETMV1_CYCLE_ACCURATE;
1219
1220         bool etmv1_branch_output;
1221         COMMAND_PARSE_ENABLE(CMD_ARGV[3], etmv1_branch_output);
1222                 tracemode |= ETMV1_BRANCH_OUTPUT;
1223
1224         /* IGNORED:
1225          *  - CPRT tracing (coprocessor register transfers)
1226          *  - debug request (causes debug entry on trigger)
1227          *  - stall on FIFOFULL (preventing tracedata lossage)
1228          */
1229         *mode = tracemode;
1230
1231         return ERROR_OK;
1232 }
1233
1234 COMMAND_HANDLER(handle_etm_tracemode_command)
1235 {
1236         struct target *target = get_current_target(CMD_CTX);
1237         struct arm *arm = target_to_arm(target);
1238         struct etm_context *etm;
1239
1240         if (!is_arm(arm)) {
1241                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1242                 return ERROR_FAIL;
1243         }
1244
1245         etm = arm->etm;
1246         if (!etm) {
1247                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1248                 return ERROR_FAIL;
1249         }
1250
1251         etmv1_tracemode_t tracemode = etm->tracemode;
1252
1253         switch (CMD_ARGC)
1254         {
1255         case 0:
1256                 break;
1257         case 4:
1258                 CALL_COMMAND_HANDLER(handle_etm_tracemode_command_update, &tracemode);
1259                 break;
1260         default:
1261                 command_print(CMD_CTX, "usage: configure trace mode "
1262                                 "<none | data | address | all> "
1263                                 "<context id bits> <cycle accurate> <branch output>");
1264                 return ERROR_FAIL;
1265         }
1266
1267         /**
1268          * todo: fail if parameters were invalid for this hardware,
1269          * or couldn't be written; display actual hardware state...
1270          */
1271
1272         command_print(CMD_CTX, "current tracemode configuration:");
1273
1274         switch (tracemode & ETMV1_TRACE_MASK)
1275         {
1276                 case ETMV1_TRACE_NONE:
1277                         command_print(CMD_CTX, "data tracing: none");
1278                         break;
1279                 case ETMV1_TRACE_DATA:
1280                         command_print(CMD_CTX, "data tracing: data only");
1281                         break;
1282                 case ETMV1_TRACE_ADDR:
1283                         command_print(CMD_CTX, "data tracing: address only");
1284                         break;
1285                 case ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR:
1286                         command_print(CMD_CTX, "data tracing: address and data");
1287                         break;
1288         }
1289
1290         switch (tracemode & ETMV1_CONTEXTID_MASK)
1291         {
1292                 case ETMV1_CONTEXTID_NONE:
1293                         command_print(CMD_CTX, "contextid tracing: none");
1294                         break;
1295                 case ETMV1_CONTEXTID_8:
1296                         command_print(CMD_CTX, "contextid tracing: 8 bit");
1297                         break;
1298                 case ETMV1_CONTEXTID_16:
1299                         command_print(CMD_CTX, "contextid tracing: 16 bit");
1300                         break;
1301                 case ETMV1_CONTEXTID_32:
1302                         command_print(CMD_CTX, "contextid tracing: 32 bit");
1303                         break;
1304         }
1305
1306         if (tracemode & ETMV1_CYCLE_ACCURATE)
1307         {
1308                 command_print(CMD_CTX, "cycle-accurate tracing enabled");
1309         }
1310         else
1311         {
1312                 command_print(CMD_CTX, "cycle-accurate tracing disabled");
1313         }
1314
1315         if (tracemode & ETMV1_BRANCH_OUTPUT)
1316         {
1317                 command_print(CMD_CTX, "full branch address output enabled");
1318         }
1319         else
1320         {
1321                 command_print(CMD_CTX, "full branch address output disabled");
1322         }
1323
1324         /* only update ETM_CTRL register if tracemode changed */
1325         if (etm->tracemode != tracemode)
1326         {
1327                 struct reg *etm_ctrl_reg;
1328
1329                 etm_ctrl_reg = etm_reg_lookup(etm, ETM_CTRL);
1330                 if (!etm_ctrl_reg)
1331                         return ERROR_FAIL;
1332
1333                 etm_get_reg(etm_ctrl_reg);
1334
1335                 buf_set_u32(etm_ctrl_reg->value, 2, 2, tracemode & ETMV1_TRACE_MASK);
1336                 buf_set_u32(etm_ctrl_reg->value, 14, 2, (tracemode & ETMV1_CONTEXTID_MASK) >> 4);
1337                 buf_set_u32(etm_ctrl_reg->value, 12, 1, (tracemode & ETMV1_CYCLE_ACCURATE) >> 8);
1338                 buf_set_u32(etm_ctrl_reg->value, 8, 1, (tracemode & ETMV1_BRANCH_OUTPUT) >> 9);
1339                 etm_store_reg(etm_ctrl_reg);
1340
1341                 etm->tracemode = tracemode;
1342
1343                 /* invalidate old trace data */
1344                 etm->capture_status = TRACE_IDLE;
1345                 if (etm->trace_depth > 0)
1346                 {
1347                         free(etm->trace_data);
1348                         etm->trace_data = NULL;
1349                 }
1350                 etm->trace_depth = 0;
1351         }
1352
1353         return ERROR_OK;
1354 }
1355
1356 COMMAND_HANDLER(handle_etm_config_command)
1357 {
1358         struct target *target;
1359         struct arm *arm;
1360         etm_portmode_t portmode = 0x0;
1361         struct etm_context *etm_ctx;
1362         int i;
1363
1364         if (CMD_ARGC != 5)
1365                 return ERROR_COMMAND_SYNTAX_ERROR;
1366
1367         target = get_target(CMD_ARGV[0]);
1368         if (!target)
1369         {
1370                 LOG_ERROR("target '%s' not defined", CMD_ARGV[0]);
1371                 return ERROR_FAIL;
1372         }
1373
1374         arm = target_to_arm(target);
1375         if (!is_arm(arm)) {
1376                 command_print(CMD_CTX, "target '%s' is '%s'; not an ARM",
1377                                 target->cmd_name, target_type_name(target));
1378                 return ERROR_FAIL;
1379         }
1380
1381         /* FIXME for ETMv3.0 and above -- and we don't yet know what ETM
1382          * version we'll be using!! -- so we can't know how to validate
1383          * params yet.  "etm config" should likely be *AFTER* hookup...
1384          *
1385          *  - Many more widths might be supported ... and we can easily
1386          *    check whether our setting "took".
1387          *
1388          *  - The "clock" and "mode" bits are interpreted differently.
1389          *    See ARM IHI 0014O table 2-17 for the old behavior, and
1390          *    table 2-18 for the new.  With ETB it's best to specify
1391          *    "normal full" ...
1392          */
1393         uint8_t port_width;
1394         COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], port_width);
1395         switch (port_width)
1396         {
1397                 /* before ETMv3.0 */
1398                 case 4:
1399                         portmode |= ETM_PORT_4BIT;
1400                         break;
1401                 case 8:
1402                         portmode |= ETM_PORT_8BIT;
1403                         break;
1404                 case 16:
1405                         portmode |= ETM_PORT_16BIT;
1406                         break;
1407                 /* ETMv3.0 and later*/
1408                 case 24:
1409                         portmode |= ETM_PORT_24BIT;
1410                         break;
1411                 case 32:
1412                         portmode |= ETM_PORT_32BIT;
1413                         break;
1414                 case 48:
1415                         portmode |= ETM_PORT_48BIT;
1416                         break;
1417                 case 64:
1418                         portmode |= ETM_PORT_64BIT;
1419                         break;
1420                 case 1:
1421                         portmode |= ETM_PORT_1BIT;
1422                         break;
1423                 case 2:
1424                         portmode |= ETM_PORT_2BIT;
1425                         break;
1426                 default:
1427                         command_print(CMD_CTX,
1428                                 "unsupported ETM port width '%s'", CMD_ARGV[1]);
1429                         return ERROR_FAIL;
1430         }
1431
1432         if (strcmp("normal", CMD_ARGV[2]) == 0)
1433         {
1434                 portmode |= ETM_PORT_NORMAL;
1435         }
1436         else if (strcmp("multiplexed", CMD_ARGV[2]) == 0)
1437         {
1438                 portmode |= ETM_PORT_MUXED;
1439         }
1440         else if (strcmp("demultiplexed", CMD_ARGV[2]) == 0)
1441         {
1442                 portmode |= ETM_PORT_DEMUXED;
1443         }
1444         else
1445         {
1446                 command_print(CMD_CTX, "unsupported ETM port mode '%s', must be 'normal', 'multiplexed' or 'demultiplexed'", CMD_ARGV[2]);
1447                 return ERROR_FAIL;
1448         }
1449
1450         if (strcmp("half", CMD_ARGV[3]) == 0)
1451         {
1452                 portmode |= ETM_PORT_HALF_CLOCK;
1453         }
1454         else if (strcmp("full", CMD_ARGV[3]) == 0)
1455         {
1456                 portmode |= ETM_PORT_FULL_CLOCK;
1457         }
1458         else
1459         {
1460                 command_print(CMD_CTX, "unsupported ETM port clocking '%s', must be 'full' or 'half'", CMD_ARGV[3]);
1461                 return ERROR_FAIL;
1462         }
1463
1464         etm_ctx = calloc(1, sizeof(struct etm_context));
1465         if (!etm_ctx) {
1466                 LOG_DEBUG("out of memory");
1467                 return ERROR_FAIL;
1468         }
1469
1470         for (i = 0; etm_capture_drivers[i]; i++)
1471         {
1472                 if (strcmp(CMD_ARGV[4], etm_capture_drivers[i]->name) == 0)
1473                 {
1474                         int retval = register_commands(CMD_CTX, NULL,
1475                                         etm_capture_drivers[i]->commands);
1476                         if (ERROR_OK != retval)
1477                         {
1478                                 free(etm_ctx);
1479                                 return retval;
1480                         }
1481
1482                         etm_ctx->capture_driver = etm_capture_drivers[i];
1483
1484                         break;
1485                 }
1486         }
1487
1488         if (!etm_capture_drivers[i])
1489         {
1490                 /* no supported capture driver found, don't register an ETM */
1491                 free(etm_ctx);
1492                 LOG_ERROR("trace capture driver '%s' not found", CMD_ARGV[4]);
1493                 return ERROR_FAIL;
1494         }
1495
1496         etm_ctx->target = target;
1497         etm_ctx->trigger_percent = 50;
1498         etm_ctx->trace_data = NULL;
1499         etm_ctx->portmode = portmode;
1500         etm_ctx->core_state = ARMV4_5_STATE_ARM;
1501
1502         arm->etm = etm_ctx;
1503
1504         return etm_register_user_commands(CMD_CTX);
1505 }
1506
1507 COMMAND_HANDLER(handle_etm_info_command)
1508 {
1509         struct target *target;
1510         struct arm *arm;
1511         struct etm_context *etm;
1512         struct reg *etm_sys_config_reg;
1513         int max_port_size;
1514         uint32_t config;
1515
1516         target = get_current_target(CMD_CTX);
1517         arm = target_to_arm(target);
1518         if (!is_arm(arm))
1519         {
1520                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1521                 return ERROR_FAIL;
1522         }
1523
1524         etm = arm->etm;
1525         if (!etm)
1526         {
1527                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1528                 return ERROR_FAIL;
1529         }
1530
1531         command_print(CMD_CTX, "ETM v%d.%d",
1532                         etm->bcd_vers >> 4, etm->bcd_vers & 0xf);
1533         command_print(CMD_CTX, "pairs of address comparators: %i",
1534                         (int) (etm->config >> 0) & 0x0f);
1535         command_print(CMD_CTX, "data comparators: %i",
1536                         (int) (etm->config >> 4) & 0x0f);
1537         command_print(CMD_CTX, "memory map decoders: %i",
1538                         (int) (etm->config >> 8) & 0x1f);
1539         command_print(CMD_CTX, "number of counters: %i",
1540                         (int) (etm->config >> 13) & 0x07);
1541         command_print(CMD_CTX, "sequencer %spresent",
1542                         (int) (etm->config & (1 << 16)) ? "" : "not ");
1543         command_print(CMD_CTX, "number of ext. inputs: %i",
1544                         (int) (etm->config >> 17) & 0x07);
1545         command_print(CMD_CTX, "number of ext. outputs: %i",
1546                         (int) (etm->config >> 20) & 0x07);
1547         command_print(CMD_CTX, "FIFO full %spresent",
1548                         (int) (etm->config & (1 << 23)) ? "" : "not ");
1549         if (etm->bcd_vers < 0x20)
1550                 command_print(CMD_CTX, "protocol version: %i",
1551                                 (int) (etm->config >> 28) & 0x07);
1552         else {
1553                 command_print(CMD_CTX,
1554                                 "coprocessor and memory access %ssupported",
1555                                 (etm->config & (1 << 26)) ? "" : "not ");
1556                 command_print(CMD_CTX, "trace start/stop %spresent",
1557                                 (etm->config & (1 << 26)) ? "" : "not ");
1558                 command_print(CMD_CTX, "number of context comparators: %i",
1559                                 (int) (etm->config >> 24) & 0x03);
1560         }
1561
1562         /* SYS_CONFIG isn't present before ETMv1.2 */
1563         etm_sys_config_reg = etm_reg_lookup(etm, ETM_SYS_CONFIG);
1564         if (!etm_sys_config_reg)
1565                 return ERROR_OK;
1566
1567         etm_get_reg(etm_sys_config_reg);
1568         config = buf_get_u32(etm_sys_config_reg->value, 0, 32);
1569
1570         LOG_DEBUG("ETM SYS CONFIG %08x", (unsigned) config);
1571
1572         max_port_size = config & 0x7;
1573         if (etm->bcd_vers >= 0x30)
1574                 max_port_size |= (config >> 6) & 0x08;
1575         switch (max_port_size)
1576         {
1577                 /* before ETMv3.0 */
1578                 case 0:
1579                         max_port_size = 4;
1580                         break;
1581                 case 1:
1582                         max_port_size = 8;
1583                         break;
1584                 case 2:
1585                         max_port_size = 16;
1586                         break;
1587                 /* ETMv3.0 and later*/
1588                 case 3:
1589                         max_port_size = 24;
1590                         break;
1591                 case 4:
1592                         max_port_size = 32;
1593                         break;
1594                 case 5:
1595                         max_port_size = 48;
1596                         break;
1597                 case 6:
1598                         max_port_size = 64;
1599                         break;
1600                 case 8:
1601                         max_port_size = 1;
1602                         break;
1603                 case 9:
1604                         max_port_size = 2;
1605                         break;
1606                 default:
1607                         LOG_ERROR("Illegal max_port_size");
1608                         return ERROR_FAIL;
1609         }
1610         command_print(CMD_CTX, "max. port size: %i", max_port_size);
1611
1612         if (etm->bcd_vers < 0x30) {
1613                 command_print(CMD_CTX, "half-rate clocking %ssupported",
1614                                 (config & (1 << 3)) ? "" : "not ");
1615                 command_print(CMD_CTX, "full-rate clocking %ssupported",
1616                                 (config & (1 << 4)) ? "" : "not ");
1617                 command_print(CMD_CTX, "normal trace format %ssupported",
1618                                 (config & (1 << 5)) ? "" : "not ");
1619                 command_print(CMD_CTX, "multiplex trace format %ssupported",
1620                                 (config & (1 << 6)) ? "" : "not ");
1621                 command_print(CMD_CTX, "demultiplex trace format %ssupported",
1622                                 (config & (1 << 7)) ? "" : "not ");
1623         } else {
1624                 /* REVISIT show which size and format are selected ... */
1625                 command_print(CMD_CTX, "current port size %ssupported",
1626                                 (config & (1 << 10)) ? "" : "not ");
1627                 command_print(CMD_CTX, "current trace format %ssupported",
1628                                 (config & (1 << 11)) ? "" : "not ");
1629         }
1630         if (etm->bcd_vers >= 0x21)
1631                 command_print(CMD_CTX, "fetch comparisons %ssupported",
1632                                 (config & (1 << 17)) ? "not " : "");
1633         command_print(CMD_CTX, "FIFO full %ssupported",
1634                         (config & (1 << 8)) ? "" : "not ");
1635
1636         return ERROR_OK;
1637 }
1638
1639 COMMAND_HANDLER(handle_etm_status_command)
1640 {
1641         struct target *target;
1642         struct arm *arm;
1643         struct etm_context *etm;
1644         trace_status_t trace_status;
1645
1646         target = get_current_target(CMD_CTX);
1647         arm = target_to_arm(target);
1648         if (!is_arm(arm))
1649         {
1650                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1651                 return ERROR_FAIL;
1652         }
1653
1654         etm = arm->etm;
1655         if (!etm)
1656         {
1657                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1658                 return ERROR_FAIL;
1659         }
1660
1661         /* ETM status */
1662         if (etm->bcd_vers >= 0x11) {
1663                 struct reg *reg;
1664
1665                 reg = etm_reg_lookup(etm, ETM_STATUS);
1666                 if (!reg)
1667                         return ERROR_FAIL;
1668                 if (etm_get_reg(reg) == ERROR_OK) {
1669                         unsigned s = buf_get_u32(reg->value, 0, reg->size);
1670
1671                         command_print(CMD_CTX, "etm: %s%s%s%s",
1672                                 /* bit(1) == progbit */
1673                                 (etm->bcd_vers >= 0x12)
1674                                         ? ((s & (1 << 1))
1675                                                 ? "disabled" : "enabled")
1676                                         : "?",
1677                                 ((s & (1 << 3)) && etm->bcd_vers >= 0x31)
1678                                         ? " triggered" : "",
1679                                 ((s & (1 << 2)) && etm->bcd_vers >= 0x12)
1680                                         ? " start/stop" : "",
1681                                 ((s & (1 << 0)) && etm->bcd_vers >= 0x11)
1682                                         ? " untraced-overflow" : "");
1683                 } /* else ignore and try showing trace port status */
1684         }
1685
1686         /* Trace Port Driver status */
1687         trace_status = etm->capture_driver->status(etm);
1688         if (trace_status == TRACE_IDLE)
1689         {
1690                 command_print(CMD_CTX, "%s: idle", etm->capture_driver->name);
1691         }
1692         else
1693         {
1694                 static char *completed = " completed";
1695                 static char *running = " is running";
1696                 static char *overflowed = ", overflowed";
1697                 static char *triggered = ", triggered";
1698
1699                 command_print(CMD_CTX, "%s: trace collection%s%s%s",
1700                         etm->capture_driver->name,
1701                         (trace_status & TRACE_RUNNING) ? running : completed,
1702                         (trace_status & TRACE_OVERFLOWED) ? overflowed : "",
1703                         (trace_status & TRACE_TRIGGERED) ? triggered : "");
1704
1705                 if (etm->trace_depth > 0)
1706                 {
1707                         command_print(CMD_CTX, "%i frames of trace data read",
1708                                         (int)(etm->trace_depth));
1709                 }
1710         }
1711
1712         return ERROR_OK;
1713 }
1714
1715 COMMAND_HANDLER(handle_etm_image_command)
1716 {
1717         struct target *target;
1718         struct arm *arm;
1719         struct etm_context *etm_ctx;
1720
1721         if (CMD_ARGC < 1)
1722         {
1723                 command_print(CMD_CTX, "usage: etm image <file> [base address] [type]");
1724                 return ERROR_FAIL;
1725         }
1726
1727         target = get_current_target(CMD_CTX);
1728         arm = target_to_arm(target);
1729         if (!is_arm(arm))
1730         {
1731                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1732                 return ERROR_FAIL;
1733         }
1734
1735         etm_ctx = arm->etm;
1736         if (!etm_ctx)
1737         {
1738                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1739                 return ERROR_FAIL;
1740         }
1741
1742         if (etm_ctx->image)
1743         {
1744                 image_close(etm_ctx->image);
1745                 free(etm_ctx->image);
1746                 command_print(CMD_CTX, "previously loaded image found and closed");
1747         }
1748
1749         etm_ctx->image = malloc(sizeof(struct image));
1750         etm_ctx->image->base_address_set = 0;
1751         etm_ctx->image->start_address_set = 0;
1752
1753         /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1754         if (CMD_ARGC >= 2)
1755         {
1756                 etm_ctx->image->base_address_set = 1;
1757                 COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], etm_ctx->image->base_address);
1758         }
1759         else
1760         {
1761                 etm_ctx->image->base_address_set = 0;
1762         }
1763
1764         if (image_open(etm_ctx->image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
1765         {
1766                 free(etm_ctx->image);
1767                 etm_ctx->image = NULL;
1768                 return ERROR_FAIL;
1769         }
1770
1771         return ERROR_OK;
1772 }
1773
1774 COMMAND_HANDLER(handle_etm_dump_command)
1775 {
1776         struct fileio file;
1777         struct target *target;
1778         struct arm *arm;
1779         struct etm_context *etm_ctx;
1780         uint32_t i;
1781
1782         if (CMD_ARGC != 1)
1783         {
1784                 command_print(CMD_CTX, "usage: etm dump <file>");
1785                 return ERROR_FAIL;
1786         }
1787
1788         target = get_current_target(CMD_CTX);
1789         arm = target_to_arm(target);
1790         if (!is_arm(arm))
1791         {
1792                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1793                 return ERROR_FAIL;
1794         }
1795
1796         etm_ctx = arm->etm;
1797         if (!etm_ctx)
1798         {
1799                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1800                 return ERROR_FAIL;
1801         }
1802
1803         if (etm_ctx->capture_driver->status == TRACE_IDLE)
1804         {
1805                 command_print(CMD_CTX, "trace capture wasn't enabled, no trace data captured");
1806                 return ERROR_OK;
1807         }
1808
1809         if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1810         {
1811                 /* TODO: if on-the-fly capture is to be supported, this needs to be changed */
1812                 command_print(CMD_CTX, "trace capture not completed");
1813                 return ERROR_FAIL;
1814         }
1815
1816         /* read the trace data if it wasn't read already */
1817         if (etm_ctx->trace_depth == 0)
1818                 etm_ctx->capture_driver->read_trace(etm_ctx);
1819
1820         if (fileio_open(&file, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1821         {
1822                 return ERROR_FAIL;
1823         }
1824
1825         fileio_write_u32(&file, etm_ctx->capture_status);
1826         fileio_write_u32(&file, etm_ctx->portmode);
1827         fileio_write_u32(&file, etm_ctx->tracemode);
1828         fileio_write_u32(&file, etm_ctx->trace_depth);
1829
1830         for (i = 0; i < etm_ctx->trace_depth; i++)
1831         {
1832                 fileio_write_u32(&file, etm_ctx->trace_data[i].pipestat);
1833                 fileio_write_u32(&file, etm_ctx->trace_data[i].packet);
1834                 fileio_write_u32(&file, etm_ctx->trace_data[i].flags);
1835         }
1836
1837         fileio_close(&file);
1838
1839         return ERROR_OK;
1840 }
1841
1842 COMMAND_HANDLER(handle_etm_load_command)
1843 {
1844         struct fileio file;
1845         struct target *target;
1846         struct arm *arm;
1847         struct etm_context *etm_ctx;
1848         uint32_t i;
1849
1850         if (CMD_ARGC != 1)
1851         {
1852                 command_print(CMD_CTX, "usage: etm load <file>");
1853                 return ERROR_FAIL;
1854         }
1855
1856         target = get_current_target(CMD_CTX);
1857         arm = target_to_arm(target);
1858         if (!is_arm(arm))
1859         {
1860                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1861                 return ERROR_FAIL;
1862         }
1863
1864         etm_ctx = arm->etm;
1865         if (!etm_ctx)
1866         {
1867                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1868                 return ERROR_FAIL;
1869         }
1870
1871         if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1872         {
1873                 command_print(CMD_CTX, "trace capture running, stop first");
1874                 return ERROR_FAIL;
1875         }
1876
1877         if (fileio_open(&file, CMD_ARGV[0], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1878         {
1879                 return ERROR_FAIL;
1880         }
1881
1882         if (file.size % 4)
1883         {
1884                 command_print(CMD_CTX, "size isn't a multiple of 4, no valid trace data");
1885                 fileio_close(&file);
1886                 return ERROR_FAIL;
1887         }
1888
1889         if (etm_ctx->trace_depth > 0)
1890         {
1891                 free(etm_ctx->trace_data);
1892                 etm_ctx->trace_data = NULL;
1893         }
1894
1895         {
1896           uint32_t tmp;
1897           fileio_read_u32(&file, &tmp); etm_ctx->capture_status = tmp;
1898           fileio_read_u32(&file, &tmp); etm_ctx->portmode = tmp;
1899           fileio_read_u32(&file, &tmp); etm_ctx->tracemode = tmp;
1900           fileio_read_u32(&file, &etm_ctx->trace_depth);
1901         }
1902         etm_ctx->trace_data = malloc(sizeof(struct etmv1_trace_data) * etm_ctx->trace_depth);
1903         if (etm_ctx->trace_data == NULL)
1904         {
1905                 command_print(CMD_CTX, "not enough memory to perform operation");
1906                 fileio_close(&file);
1907                 return ERROR_FAIL;
1908         }
1909
1910         for (i = 0; i < etm_ctx->trace_depth; i++)
1911         {
1912                 uint32_t pipestat, packet, flags;
1913                 fileio_read_u32(&file, &pipestat);
1914                 fileio_read_u32(&file, &packet);
1915                 fileio_read_u32(&file, &flags);
1916                 etm_ctx->trace_data[i].pipestat = pipestat & 0xff;
1917                 etm_ctx->trace_data[i].packet = packet & 0xffff;
1918                 etm_ctx->trace_data[i].flags = flags;
1919         }
1920
1921         fileio_close(&file);
1922
1923         return ERROR_OK;
1924 }
1925
1926 COMMAND_HANDLER(handle_etm_trigger_percent_command)
1927 {
1928         struct target *target;
1929         struct arm *arm;
1930         struct etm_context *etm_ctx;
1931
1932         target = get_current_target(CMD_CTX);
1933         arm = target_to_arm(target);
1934         if (!is_arm(arm))
1935         {
1936                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1937                 return ERROR_FAIL;
1938         }
1939
1940         etm_ctx = arm->etm;
1941         if (!etm_ctx)
1942         {
1943                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1944                 return ERROR_FAIL;
1945         }
1946
1947         if (CMD_ARGC > 0)
1948         {
1949                 uint32_t new_value;
1950                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], new_value);
1951
1952                 if ((new_value < 2) || (new_value > 100))
1953                 {
1954                         command_print(CMD_CTX, "valid settings are 2%% to 100%%");
1955                 }
1956                 else
1957                 {
1958                         etm_ctx->trigger_percent = new_value;
1959                 }
1960         }
1961
1962         command_print(CMD_CTX, "%i percent of the tracebuffer reserved for after the trigger", ((int)(etm_ctx->trigger_percent)));
1963
1964         return ERROR_OK;
1965 }
1966
1967 COMMAND_HANDLER(handle_etm_start_command)
1968 {
1969         struct target *target;
1970         struct arm *arm;
1971         struct etm_context *etm_ctx;
1972         struct reg *etm_ctrl_reg;
1973
1974         target = get_current_target(CMD_CTX);
1975         arm = target_to_arm(target);
1976         if (!is_arm(arm))
1977         {
1978                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
1979                 return ERROR_FAIL;
1980         }
1981
1982         etm_ctx = arm->etm;
1983         if (!etm_ctx)
1984         {
1985                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
1986                 return ERROR_FAIL;
1987         }
1988
1989         /* invalidate old tracing data */
1990         etm_ctx->capture_status = TRACE_IDLE;
1991         if (etm_ctx->trace_depth > 0)
1992         {
1993                 free(etm_ctx->trace_data);
1994                 etm_ctx->trace_data = NULL;
1995         }
1996         etm_ctx->trace_depth = 0;
1997
1998         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
1999         if (!etm_ctrl_reg)
2000                 return ERROR_FAIL;
2001
2002         etm_get_reg(etm_ctrl_reg);
2003
2004         /* Clear programming bit (10), set port selection bit (11) */
2005         buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x2);
2006
2007         etm_store_reg(etm_ctrl_reg);
2008         jtag_execute_queue();
2009
2010         etm_ctx->capture_driver->start_capture(etm_ctx);
2011
2012         return ERROR_OK;
2013 }
2014
2015 COMMAND_HANDLER(handle_etm_stop_command)
2016 {
2017         struct target *target;
2018         struct arm *arm;
2019         struct etm_context *etm_ctx;
2020         struct reg *etm_ctrl_reg;
2021
2022         target = get_current_target(CMD_CTX);
2023         arm = target_to_arm(target);
2024         if (!is_arm(arm))
2025         {
2026                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
2027                 return ERROR_FAIL;
2028         }
2029
2030         etm_ctx = arm->etm;
2031         if (!etm_ctx)
2032         {
2033                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
2034                 return ERROR_FAIL;
2035         }
2036
2037         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
2038         if (!etm_ctrl_reg)
2039                 return ERROR_FAIL;
2040
2041         etm_get_reg(etm_ctrl_reg);
2042
2043         /* Set programming bit (10), clear port selection bit (11) */
2044         buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x1);
2045
2046         etm_store_reg(etm_ctrl_reg);
2047         jtag_execute_queue();
2048
2049         etm_ctx->capture_driver->stop_capture(etm_ctx);
2050
2051         return ERROR_OK;
2052 }
2053
2054 COMMAND_HANDLER(handle_etm_analyze_command)
2055 {
2056         struct target *target;
2057         struct arm *arm;
2058         struct etm_context *etm_ctx;
2059         int retval;
2060
2061         target = get_current_target(CMD_CTX);
2062         arm = target_to_arm(target);
2063         if (!is_arm(arm))
2064         {
2065                 command_print(CMD_CTX, "ETM: current target isn't an ARM");
2066                 return ERROR_FAIL;
2067         }
2068
2069         etm_ctx = arm->etm;
2070         if (!etm_ctx)
2071         {
2072                 command_print(CMD_CTX, "current target doesn't have an ETM configured");
2073                 return ERROR_FAIL;
2074         }
2075
2076         if ((retval = etmv1_analyze_trace(etm_ctx, CMD_CTX)) != ERROR_OK)
2077         {
2078                 switch (retval)
2079                 {
2080                         case ERROR_ETM_ANALYSIS_FAILED:
2081                                 command_print(CMD_CTX, "further analysis failed (corrupted trace data or just end of data");
2082                                 break;
2083                         case ERROR_TRACE_INSTRUCTION_UNAVAILABLE:
2084                                 command_print(CMD_CTX, "no instruction for current address available, analysis aborted");
2085                                 break;
2086                         case ERROR_TRACE_IMAGE_UNAVAILABLE:
2087                                 command_print(CMD_CTX, "no image available for trace analysis");
2088                                 break;
2089                         default:
2090                                 command_print(CMD_CTX, "unknown error: %i", retval);
2091                 }
2092         }
2093
2094         return retval;
2095 }
2096
2097 static const struct command_registration etm_config_command_handlers[] = {
2098         {
2099                 .name = "config",
2100                 .handler = &handle_etm_config_command,
2101                 .mode = COMMAND_CONFIG,
2102                 .usage = "<target> <port_width> <port_mode> "
2103                         "<clocking> <capture_driver>",
2104         },
2105         COMMAND_REGISTRATION_DONE
2106 };
2107 const struct command_registration etm_command_handlers[] = {
2108         {
2109                 .name = "etm",
2110                 .mode = COMMAND_ANY,
2111                 .help = "Emebdded Trace Macrocell command group",
2112                 .chain = etm_config_command_handlers,
2113         },
2114         COMMAND_REGISTRATION_DONE
2115 };
2116
2117 static const struct command_registration etm_exec_command_handlers[] = {
2118         {
2119                 .name = "tracemode", handle_etm_tracemode_command,
2120                 .mode = COMMAND_EXEC,
2121                 .help = "configure/display trace mode",
2122                 .usage = "<none | data | address | all> "
2123                         "<context_id_bits> <cycle_accurate> <branch_output>",
2124         },
2125         {
2126                 .name = "info",
2127                 .handler = &handle_etm_info_command,
2128                 .mode = COMMAND_EXEC,
2129                 .help = "display info about the current target's ETM",
2130         },
2131         {
2132                 .name = "trigger_percent",
2133                 .handler = &handle_etm_trigger_percent_command,
2134                 .mode = COMMAND_EXEC,
2135                 .help = "amount (<percent>) of trace buffer "
2136                         "to be filled after the trigger occured",
2137         },
2138         {
2139                 .name = "status",
2140                 .handler = &handle_etm_status_command,
2141                 .mode = COMMAND_EXEC,
2142                 .help = "display current target's ETM status",
2143         },
2144         {
2145                 .name = "start",
2146                 .handler = &handle_etm_start_command,
2147                 .mode = COMMAND_EXEC,
2148                 .help = "start ETM trace collection",
2149         },
2150         {
2151                 .name = "stop",
2152                 .handler = &handle_etm_stop_command,
2153                 .mode = COMMAND_EXEC,
2154                 .help = "stop ETM trace collection",
2155         },
2156         {
2157                 .name = "analyze",
2158                 .handler = &handle_etm_analyze_command,
2159                 .mode = COMMAND_EXEC,
2160                 .help = "anaylze collected ETM trace",
2161         },
2162         {
2163                 .name = "image",
2164                 .handler = &handle_etm_image_command,
2165                 .mode = COMMAND_EXEC,
2166                 .help = "load image from <file> [base address]",
2167         },
2168         {
2169                 .name = "dump",
2170                 .handler = &handle_etm_dump_command,
2171                 .mode = COMMAND_EXEC,
2172                 .help = "dump captured trace data <file>",
2173         },
2174         {
2175                 .name = "load",
2176                 .handler = &handle_etm_load_command,
2177                 .mode = COMMAND_EXEC,
2178                 .help = "load trace data for analysis <file>",
2179         },
2180         COMMAND_REGISTRATION_DONE
2181 };
2182
2183 static int etm_register_user_commands(struct command_context *cmd_ctx)
2184 {
2185         struct command *etm_cmd = command_find_in_context(cmd_ctx, "etm");
2186         return register_commands(cmd_ctx, etm_cmd, etm_exec_command_handlers);
2187 }