1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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. *
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. *
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 ***************************************************************************/
27 #include "arm_disassembler.h"
32 * ARM "Embedded Trace Macrocell" (ETM) support -- direct JTAG access.
34 * ETM modules collect instruction and/or data trace information, compress
35 * it, and transfer it to a debugging host through either a (buffered) trace
36 * port (often a 38-pin Mictor connector) or an Embedded Trace Buffer (ETB).
38 * There are several generations of these modules. Original versions have
39 * JTAG access through a dedicated scan chain. Recent versions have added
40 * access via coprocessor instructions, memory addressing, and the ARM Debug
41 * Interface v5 (ADIv5); and phased out direct JTAG access.
43 * This code supports up to the ETMv1.3 architecture, as seen in ETM9 and
44 * most common ARM9 systems. Note: "CoreSight ETM9" implements ETMv3.2,
45 * implying non-JTAG connectivity options.
47 * Relevant documentation includes:
48 * ARM DDI 0157G ... ETM9 (r2p2) Technical Reference Manual
49 * ARM DDI 0315B ... CoreSight ETM9 (r0p1) Technical Reference Manual
50 * ARM IHI 0014O ... Embedded Trace Macrocell, Architecture Specification
53 #define ARRAY_SIZE(x) ((int)(sizeof(x)/sizeof((x)[0])))
63 uint8_t size; /* low-N of 32 bits */
64 uint8_t mode; /* RO, WO, RW */
65 uint8_t bcd_vers; /* 1.0, 2.0, etc */
70 * Registers 0..0x7f are JTAG-addressable using scanchain 6.
71 * (Or on some processors, through coprocessor operations.)
72 * Newer versions of ETM make some W/O registers R/W, and
73 * provide definitions for some previously-unused bits.
76 /* core registers used to version/configure the ETM */
77 static const struct etm_reg_info etm_core[] = {
78 /* NOTE: we "know" the order here ... */
79 { ETM_CONFIG, 32, RO, 0x10, "ETM_config", },
80 { ETM_ID, 32, RO, 0x20, "ETM_id", },
83 /* basic registers that are always there given the right ETM version */
84 static const struct etm_reg_info etm_basic[] = {
85 /* ETM Trace Registers */
86 { ETM_CTRL, 32, RW, 0x10, "ETM_ctrl", },
87 { ETM_TRIG_EVENT, 17, WO, 0x10, "ETM_trig_event", },
88 { ETM_ASIC_CTRL, 8, WO, 0x10, "ETM_asic_ctrl", },
89 { ETM_STATUS, 3, RO, 0x11, "ETM_status", },
90 { ETM_SYS_CONFIG, 9, RO, 0x12, "ETM_sys_config", },
92 /* TraceEnable configuration */
93 { ETM_TRACE_RESOURCE_CTRL, 32, WO, 0x12, "ETM_trace_resource_ctrl", },
94 { ETM_TRACE_EN_CTRL2, 16, WO, 0x12, "ETM_trace_en_ctrl2", },
95 { ETM_TRACE_EN_EVENT, 17, WO, 0x10, "ETM_trace_en_event", },
96 { ETM_TRACE_EN_CTRL1, 26, WO, 0x10, "ETM_trace_en_ctrl1", },
98 /* ViewData configuration (data trace) */
99 { ETM_VIEWDATA_EVENT, 17, WO, 0x10, "ETM_viewdata_event", },
100 { ETM_VIEWDATA_CTRL1, 32, WO, 0x10, "ETM_viewdata_ctrl1", },
101 { ETM_VIEWDATA_CTRL2, 32, WO, 0x10, "ETM_viewdata_ctrl2", },
102 { ETM_VIEWDATA_CTRL3, 17, WO, 0x10, "ETM_viewdata_ctrl3", },
104 /* REVISIT exclude VIEWDATA_CTRL2 when it's not there */
106 { 0x78, 12, WO, 0x20, "ETM_sync_freq", },
107 { 0x7a, 22, RO, 0x31, "ETM_config_code_ext", },
108 { 0x7b, 32, WO, 0x31, "ETM_ext_input_select", },
109 { 0x7c, 32, WO, 0x34, "ETM_trace_start_stop", },
110 { 0x7d, 8, WO, 0x34, "ETM_behavior_control", },
113 static const struct etm_reg_info etm_fifofull[] = {
114 /* FIFOFULL configuration */
115 { ETM_FIFOFULL_REGION, 25, WO, 0x10, "ETM_fifofull_region", },
116 { ETM_FIFOFULL_LEVEL, 8, WO, 0x10, "ETM_fifofull_level", },
119 static const struct etm_reg_info etm_addr_comp[] = {
120 /* Address comparator register pairs */
121 #define ADDR_COMPARATOR(i) \
122 { ETM_ADDR_COMPARATOR_VALUE + (i) - 1, 32, WO, 0x10, \
123 "ETM_addr_" #i "_comparator_value", }, \
124 { ETM_ADDR_ACCESS_TYPE + (i) - 1, 7, WO, 0x10, \
125 "ETM_addr_" #i "_access_type", }
143 #undef ADDR_COMPARATOR
146 static const struct etm_reg_info etm_data_comp[] = {
147 /* Data Value Comparators (NOTE: odd addresses are reserved) */
148 #define DATA_COMPARATOR(i) \
149 { ETM_DATA_COMPARATOR_VALUE + 2*(i) - 1, 32, WO, 0x10, \
150 "ETM_data_" #i "_comparator_value", }, \
151 { ETM_DATA_COMPARATOR_MASK + 2*(i) - 1, 32, WO, 0x10, \
152 "ETM_data_" #i "_comparator_mask", }
161 #undef DATA_COMPARATOR
164 static const struct etm_reg_info etm_counters[] = {
165 #define ETM_COUNTER(i) \
166 { ETM_COUNTER_RELOAD_VALUE + (i) - 1, 16, WO, 0x10, \
167 "ETM_counter_" #i "_reload_value", }, \
168 { ETM_COUNTER_ENABLE + (i) - 1, 18, WO, 0x10, \
169 "ETM_counter_" #i "_enable", }, \
170 { ETM_COUNTER_RELOAD_EVENT + (i) - 1, 17, WO, 0x10, \
171 "ETM_counter_" #i "_reload_event", }, \
172 { ETM_COUNTER_VALUE + (i) - 1, 16, RO, 0x10, \
173 "ETM_counter_" #i "_value", }
181 static const struct etm_reg_info etm_sequencer[] = {
183 { ETM_SEQUENCER_EVENT + (i), 17, WO, 0x10, \
184 "ETM_sequencer_event" #i, }
185 ETM_SEQ(0), /* 1->2 */
186 ETM_SEQ(1), /* 2->1 */
187 ETM_SEQ(2), /* 2->3 */
188 ETM_SEQ(3), /* 3->1 */
189 ETM_SEQ(4), /* 3->2 */
190 ETM_SEQ(5), /* 1->3 */
193 { ETM_SEQUENCER_STATE, 2, RO, 0x10, "ETM_sequencer_state", },
196 static const struct etm_reg_info etm_outputs[] = {
197 #define ETM_OUTPUT(i) \
198 { ETM_EXTERNAL_OUTPUT + (i) - 1, 17, WO, 0x10, \
199 "ETM_external_output" #i, }
209 /* registers from 0x6c..0x7f were added after ETMv1.3 */
211 /* Context ID Comparators */
212 { 0x6c, 32, RO, 0x20, "ETM_contextid_comparator_value1", }
213 { 0x6d, 32, RO, 0x20, "ETM_contextid_comparator_value2", }
214 { 0x6e, 32, RO, 0x20, "ETM_contextid_comparator_value3", }
215 { 0x6f, 32, RO, 0x20, "ETM_contextid_comparator_mask", }
218 static int etm_reg_arch_type = -1;
220 static int etm_get_reg(struct reg *reg);
221 static int etm_read_reg_w_check(struct reg *reg,
222 uint8_t* check_value, uint8_t* check_mask);
223 static int etm_register_user_commands(struct command_context *cmd_ctx);
224 static int etm_set_reg_w_exec(struct reg *reg, uint8_t *buf);
225 static int etm_write_reg(struct reg *reg, uint32_t value);
227 static struct command *etm_cmd;
230 /* Look up register by ID ... most ETM instances only
231 * support a subset of the possible registers.
233 static struct reg *etm_reg_lookup(struct etm_context *etm_ctx, unsigned id)
235 struct reg_cache *cache = etm_ctx->reg_cache;
238 for (i = 0; i < cache->num_regs; i++) {
239 struct etm_reg *reg = cache->reg_list[i].arch_info;
241 if (reg->reg_info->addr == id)
242 return &cache->reg_list[i];
245 /* caller asking for nonexistent register is a bug! */
246 /* REVISIT say which of the N targets was involved */
247 LOG_ERROR("ETM: register 0x%02x not available", id);
251 static void etm_reg_add(unsigned bcd_vers, struct arm_jtag *jtag_info,
252 struct reg_cache *cache, struct etm_reg *ereg,
253 const struct etm_reg_info *r, unsigned nreg)
255 struct reg *reg = cache->reg_list;
257 reg += cache->num_regs;
258 ereg += cache->num_regs;
260 /* add up to "nreg" registers from "r", if supported by this
261 * version of the ETM, to the specified cache.
263 for (; nreg--; r++) {
265 /* this ETM may be too old to have some registers */
266 if (r->bcd_vers > bcd_vers)
271 reg->value = &ereg->value;
272 reg->arch_info = ereg;
273 reg->arch_type = etm_reg_arch_type;
278 ereg->jtag_info = jtag_info;
283 struct reg_cache *etm_build_reg_cache(struct target *target,
284 struct arm_jtag *jtag_info, struct etm_context *etm_ctx)
286 struct reg_cache *reg_cache = malloc(sizeof(struct reg_cache));
287 struct reg *reg_list = NULL;
288 struct etm_reg *arch_info = NULL;
289 unsigned bcd_vers, config;
291 /* register a register arch-type for etm registers only once */
292 if (etm_reg_arch_type == -1)
293 etm_reg_arch_type = register_reg_arch_type(etm_get_reg,
296 /* the actual registers are kept in two arrays */
297 reg_list = calloc(128, sizeof(struct reg));
298 arch_info = calloc(128, sizeof(struct etm_reg));
300 /* fill in values for the reg cache */
301 reg_cache->name = "etm registers";
302 reg_cache->next = NULL;
303 reg_cache->reg_list = reg_list;
304 reg_cache->num_regs = 0;
306 /* add ETM_CONFIG, then parse its values to see
307 * which other registers exist in this ETM
309 etm_reg_add(0x10, jtag_info, reg_cache, arch_info,
312 etm_get_reg(reg_list);
313 etm_ctx->config = buf_get_u32((void *)&arch_info->value, 0, 32);
314 config = etm_ctx->config;
316 /* figure ETM version then add base registers */
317 if (config & (1 << 31)) {
319 LOG_WARNING("ETMv2+ support is incomplete");
321 /* REVISIT more registers may exist; they may now be
322 * readable; more register bits have defined meanings;
323 * don't presume trace start/stop support is present;
324 * and include any context ID comparator registers.
326 etm_reg_add(0x20, jtag_info, reg_cache, arch_info,
328 etm_get_reg(reg_list + 1);
329 etm_ctx->id = buf_get_u32(
330 (void *)&arch_info[1].value, 0, 32);
331 LOG_DEBUG("ETM ID: %08x", (unsigned) etm_ctx->id);
332 bcd_vers = 0x10 + (((etm_ctx->id) >> 4) & 0xff);
335 switch (config >> 28) {
352 LOG_WARNING("Bad ETMv1 protocol %d", config >> 28);
356 etm_ctx->bcd_vers = bcd_vers;
357 LOG_INFO("ETM v%d.%d", bcd_vers >> 4, bcd_vers & 0xf);
359 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
360 etm_basic, ARRAY_SIZE(etm_basic));
362 /* address and data comparators; counters; outputs */
363 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
364 etm_addr_comp, 4 * (0x0f & (config >> 0)));
365 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
366 etm_data_comp, 2 * (0x0f & (config >> 4)));
367 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
368 etm_counters, 4 * (0x07 & (config >> 13)));
369 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
370 etm_outputs, (0x07 & (config >> 20)));
372 /* FIFOFULL presence is optional
373 * REVISIT for ETMv1.2 and later, don't bother adding this
374 * unless ETM_SYS_CONFIG says it's also *supported* ...
376 if (config & (1 << 23))
377 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
378 etm_fifofull, ARRAY_SIZE(etm_fifofull));
380 /* sequencer is optional (for state-dependant triggering) */
381 if (config & (1 << 16))
382 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
383 etm_sequencer, ARRAY_SIZE(etm_sequencer));
385 /* REVISIT could realloc and likely save half the memory
386 * in the two chunks we allocated...
389 /* the ETM might have an ETB connected */
390 if (strcmp(etm_ctx->capture_driver->name, "etb") == 0)
392 struct etb *etb = etm_ctx->capture_driver_priv;
396 LOG_ERROR("etb selected as etm capture driver, but no ETB configured");
400 reg_cache->next = etb_build_reg_cache(etb);
402 etb->reg_cache = reg_cache->next;
405 etm_ctx->reg_cache = reg_cache;
415 static int etm_read_reg(struct reg *reg)
417 return etm_read_reg_w_check(reg, NULL, NULL);
420 static int etm_store_reg(struct reg *reg)
422 return etm_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
425 int etm_setup(struct target *target)
428 uint32_t etm_ctrl_value;
429 struct arm *arm = target_to_arm(target);
430 struct etm_context *etm_ctx = arm->etm;
431 struct reg *etm_ctrl_reg;
433 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
437 /* initialize some ETM control register settings */
438 etm_get_reg(etm_ctrl_reg);
439 etm_ctrl_value = buf_get_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size);
441 /* clear the ETM powerdown bit (0) */
442 etm_ctrl_value &= ~0x1;
444 /* configure port width (21,6:4), mode (13,17:16) and
445 * for older modules clocking (13)
447 etm_ctrl_value = (etm_ctrl_value
448 & ~ETM_PORT_WIDTH_MASK
449 & ~ETM_PORT_MODE_MASK
450 & ~ETM_PORT_CLOCK_MASK)
453 buf_set_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size, etm_ctrl_value);
454 etm_store_reg(etm_ctrl_reg);
456 if ((retval = jtag_execute_queue()) != ERROR_OK)
459 /* REVISIT for ETMv3.0 and later, read ETM_sys_config to
460 * verify that those width and mode settings are OK ...
463 if ((retval = etm_ctx->capture_driver->init(etm_ctx)) != ERROR_OK)
465 LOG_ERROR("ETM capture driver initialization failed");
471 static int etm_get_reg(struct reg *reg)
475 if ((retval = etm_read_reg(reg)) != ERROR_OK)
477 LOG_ERROR("BUG: error scheduling etm register read");
481 if ((retval = jtag_execute_queue()) != ERROR_OK)
483 LOG_ERROR("register read failed");
490 static int etm_read_reg_w_check(struct reg *reg,
491 uint8_t* check_value, uint8_t* check_mask)
493 struct etm_reg *etm_reg = reg->arch_info;
494 const struct etm_reg_info *r = etm_reg->reg_info;
495 uint8_t reg_addr = r->addr & 0x7f;
496 struct scan_field fields[3];
498 if (etm_reg->reg_info->mode == WO) {
499 LOG_ERROR("BUG: can't read write-only register %s", r->name);
500 return ERROR_INVALID_ARGUMENTS;
503 LOG_DEBUG("%s (%u)", r->name, reg_addr);
505 jtag_set_end_state(TAP_IDLE);
506 arm_jtag_scann(etm_reg->jtag_info, 0x6);
507 arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
509 fields[0].tap = etm_reg->jtag_info->tap;
510 fields[0].num_bits = 32;
511 fields[0].out_value = reg->value;
512 fields[0].in_value = NULL;
513 fields[0].check_value = NULL;
514 fields[0].check_mask = NULL;
516 fields[1].tap = etm_reg->jtag_info->tap;
517 fields[1].num_bits = 7;
518 fields[1].out_value = malloc(1);
519 buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
520 fields[1].in_value = NULL;
521 fields[1].check_value = NULL;
522 fields[1].check_mask = NULL;
524 fields[2].tap = etm_reg->jtag_info->tap;
525 fields[2].num_bits = 1;
526 fields[2].out_value = malloc(1);
527 buf_set_u32(fields[2].out_value, 0, 1, 0);
528 fields[2].in_value = NULL;
529 fields[2].check_value = NULL;
530 fields[2].check_mask = NULL;
532 jtag_add_dr_scan(3, fields, jtag_get_end_state());
534 fields[0].in_value = reg->value;
535 fields[0].check_value = check_value;
536 fields[0].check_mask = check_mask;
538 jtag_add_dr_scan_check(3, fields, jtag_get_end_state());
540 free(fields[1].out_value);
541 free(fields[2].out_value);
546 static int etm_set_reg(struct reg *reg, uint32_t value)
550 if ((retval = etm_write_reg(reg, value)) != ERROR_OK)
552 LOG_ERROR("BUG: error scheduling etm register write");
556 buf_set_u32(reg->value, 0, reg->size, value);
563 static int etm_set_reg_w_exec(struct reg *reg, uint8_t *buf)
567 etm_set_reg(reg, buf_get_u32(buf, 0, reg->size));
569 if ((retval = jtag_execute_queue()) != ERROR_OK)
571 LOG_ERROR("register write failed");
577 static int etm_write_reg(struct reg *reg, uint32_t value)
579 struct etm_reg *etm_reg = reg->arch_info;
580 const struct etm_reg_info *r = etm_reg->reg_info;
581 uint8_t reg_addr = r->addr & 0x7f;
582 struct scan_field fields[3];
584 if (etm_reg->reg_info->mode == RO) {
585 LOG_ERROR("BUG: can't write read--only register %s", r->name);
586 return ERROR_INVALID_ARGUMENTS;
589 LOG_DEBUG("%s (%u): 0x%8.8" PRIx32 "", r->name, reg_addr, value);
591 jtag_set_end_state(TAP_IDLE);
592 arm_jtag_scann(etm_reg->jtag_info, 0x6);
593 arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
595 fields[0].tap = etm_reg->jtag_info->tap;
596 fields[0].num_bits = 32;
598 fields[0].out_value = tmp1;
599 buf_set_u32(fields[0].out_value, 0, 32, value);
600 fields[0].in_value = NULL;
602 fields[1].tap = etm_reg->jtag_info->tap;
603 fields[1].num_bits = 7;
605 fields[1].out_value = &tmp2;
606 buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
607 fields[1].in_value = NULL;
609 fields[2].tap = etm_reg->jtag_info->tap;
610 fields[2].num_bits = 1;
612 fields[2].out_value = &tmp3;
613 buf_set_u32(fields[2].out_value, 0, 1, 1);
614 fields[2].in_value = NULL;
616 jtag_add_dr_scan(3, fields, jtag_get_end_state());
622 /* ETM trace analysis functionality
625 extern struct etm_capture_driver etm_dummy_capture_driver;
626 #if BUILD_OOCD_TRACE == 1
627 extern struct etm_capture_driver oocd_trace_capture_driver;
630 static struct etm_capture_driver *etm_capture_drivers[] =
633 &etm_dummy_capture_driver,
634 #if BUILD_OOCD_TRACE == 1
635 &oocd_trace_capture_driver,
640 static int etm_read_instruction(struct etm_context *ctx, struct arm_instruction *instruction)
649 return ERROR_TRACE_IMAGE_UNAVAILABLE;
651 /* search for the section the current instruction belongs to */
652 for (i = 0; i < ctx->image->num_sections; i++)
654 if ((ctx->image->sections[i].base_address <= ctx->current_pc) &&
655 (ctx->image->sections[i].base_address + ctx->image->sections[i].size > ctx->current_pc))
664 /* current instruction couldn't be found in the image */
665 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
668 if (ctx->core_state == ARMV4_5_STATE_ARM)
671 if ((retval = image_read_section(ctx->image, section,
672 ctx->current_pc - ctx->image->sections[section].base_address,
673 4, buf, &size_read)) != ERROR_OK)
675 LOG_ERROR("error while reading instruction: %i", retval);
676 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
678 opcode = target_buffer_get_u32(ctx->target, buf);
679 arm_evaluate_opcode(opcode, ctx->current_pc, instruction);
681 else if (ctx->core_state == ARMV4_5_STATE_THUMB)
684 if ((retval = image_read_section(ctx->image, section,
685 ctx->current_pc - ctx->image->sections[section].base_address,
686 2, buf, &size_read)) != ERROR_OK)
688 LOG_ERROR("error while reading instruction: %i", retval);
689 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
691 opcode = target_buffer_get_u16(ctx->target, buf);
692 thumb_evaluate_opcode(opcode, ctx->current_pc, instruction);
694 else if (ctx->core_state == ARMV4_5_STATE_JAZELLE)
696 LOG_ERROR("BUG: tracing of jazelle code not supported");
701 LOG_ERROR("BUG: unknown core state encountered");
708 static int etmv1_next_packet(struct etm_context *ctx, uint8_t *packet, int apo)
710 while (ctx->data_index < ctx->trace_depth)
712 /* if the caller specified an address packet offset, skip until the
713 * we reach the n-th cycle marked with tracesync */
716 if (ctx->trace_data[ctx->data_index].flags & ETMV1_TRACESYNC_CYCLE)
727 /* no tracedata output during a TD cycle
728 * or in a trigger cycle */
729 if ((ctx->trace_data[ctx->data_index].pipestat == STAT_TD)
730 || (ctx->trace_data[ctx->data_index].flags & ETMV1_TRIGGER_CYCLE))
737 if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_16BIT)
739 if (ctx->data_half == 0)
741 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
746 *packet = (ctx->trace_data[ctx->data_index].packet & 0xff00) >> 8;
751 else if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_8BIT)
753 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
758 /* on a 4-bit port, a packet will be output during two consecutive cycles */
759 if (ctx->data_index > (ctx->trace_depth - 2))
762 *packet = ctx->trace_data[ctx->data_index].packet & 0xf;
763 *packet |= (ctx->trace_data[ctx->data_index + 1].packet & 0xf) << 4;
764 ctx->data_index += 2;
773 static int etmv1_branch_address(struct etm_context *ctx)
781 /* quit analysis if less than two cycles are left in the trace
782 * because we can't extract the APO */
783 if (ctx->data_index > (ctx->trace_depth - 2))
786 /* a BE could be output during an APO cycle, skip the current
787 * and continue with the new one */
788 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x4)
790 if (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x4)
793 /* address packet offset encoded in the next two cycles' pipestat bits */
794 apo = ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x3;
795 apo |= (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x3) << 2;
797 /* count number of tracesync cycles between current pipe_index and data_index
798 * i.e. the number of tracesyncs that data_index already passed by
799 * to subtract them from the APO */
800 for (i = ctx->pipe_index; i < ctx->data_index; i++)
802 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & ETMV1_TRACESYNC_CYCLE)
806 /* extract up to four 7-bit packets */
808 if ((retval = etmv1_next_packet(ctx, &packet, (shift == 0) ? apo + 1 : 0)) != 0)
810 ctx->last_branch &= ~(0x7f << shift);
811 ctx->last_branch |= (packet & 0x7f) << shift;
813 } while ((packet & 0x80) && (shift < 28));
815 /* one last packet holding 4 bits of the address, plus the branch reason code */
816 if ((shift == 28) && (packet & 0x80))
818 if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
820 ctx->last_branch &= 0x0fffffff;
821 ctx->last_branch |= (packet & 0x0f) << 28;
822 ctx->last_branch_reason = (packet & 0x70) >> 4;
827 ctx->last_branch_reason = 0;
835 /* if a full address was output, we might have branched into Jazelle state */
836 if ((shift == 32) && (packet & 0x80))
838 ctx->core_state = ARMV4_5_STATE_JAZELLE;
842 /* if we didn't branch into Jazelle state, the current processor state is
843 * encoded in bit 0 of the branch target address */
844 if (ctx->last_branch & 0x1)
846 ctx->core_state = ARMV4_5_STATE_THUMB;
847 ctx->last_branch &= ~0x1;
851 ctx->core_state = ARMV4_5_STATE_ARM;
852 ctx->last_branch &= ~0x3;
859 static int etmv1_data(struct etm_context *ctx, int size, uint32_t *data)
865 for (j = 0; j < size; j++)
867 if ((retval = etmv1_next_packet(ctx, &buf[j], 0)) != 0)
873 LOG_ERROR("TODO: add support for 64-bit values");
877 *data = target_buffer_get_u32(ctx->target, buf);
879 *data = target_buffer_get_u16(ctx->target, buf);
888 static int etmv1_analyze_trace(struct etm_context *ctx, struct command_context *cmd_ctx)
891 struct arm_instruction instruction;
893 /* read the trace data if it wasn't read already */
894 if (ctx->trace_depth == 0)
895 ctx->capture_driver->read_trace(ctx);
897 /* start at the beginning of the captured trace */
902 /* neither the PC nor the data pointer are valid */
906 while (ctx->pipe_index < ctx->trace_depth)
908 uint8_t pipestat = ctx->trace_data[ctx->pipe_index].pipestat;
909 uint32_t next_pc = ctx->current_pc;
910 uint32_t old_data_index = ctx->data_index;
911 uint32_t old_data_half = ctx->data_half;
912 uint32_t old_index = ctx->pipe_index;
913 uint32_t last_instruction = ctx->last_instruction;
915 int current_pc_ok = ctx->pc_ok;
917 if (ctx->trace_data[ctx->pipe_index].flags & ETMV1_TRIGGER_CYCLE)
919 command_print(cmd_ctx, "--- trigger ---");
922 /* instructions execute in IE/D or BE/D cycles */
923 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
924 ctx->last_instruction = ctx->pipe_index;
926 /* if we don't have a valid pc skip until we reach an indirect branch */
927 if ((!ctx->pc_ok) && (pipestat != STAT_BE))
933 /* any indirect branch could have interrupted instruction flow
934 * - the branch reason code could indicate a trace discontinuity
935 * - a branch to the exception vectors indicates an exception
937 if ((pipestat == STAT_BE) || (pipestat == STAT_BD))
939 /* backup current data index, to be able to consume the branch address
940 * before examining data address and values
942 old_data_index = ctx->data_index;
943 old_data_half = ctx->data_half;
945 ctx->last_instruction = ctx->pipe_index;
947 if ((retval = etmv1_branch_address(ctx)) != 0)
949 /* negative return value from etmv1_branch_address means we ran out of packets,
950 * quit analysing the trace */
954 /* a positive return values means the current branch was abandoned,
955 * and a new branch was encountered in cycle ctx->pipe_index + retval;
957 LOG_WARNING("abandoned branch encountered, correctnes of analysis uncertain");
958 ctx->pipe_index += retval;
962 /* skip over APO cycles */
963 ctx->pipe_index += 2;
965 switch (ctx->last_branch_reason)
967 case 0x0: /* normal PC change */
968 next_pc = ctx->last_branch;
970 case 0x1: /* tracing enabled */
971 command_print(cmd_ctx, "--- tracing enabled at 0x%8.8" PRIx32 " ---", ctx->last_branch);
972 ctx->current_pc = ctx->last_branch;
976 case 0x2: /* trace restarted after FIFO overflow */
977 command_print(cmd_ctx, "--- trace restarted after FIFO overflow at 0x%8.8" PRIx32 " ---", ctx->last_branch);
978 ctx->current_pc = ctx->last_branch;
982 case 0x3: /* exit from debug state */
983 command_print(cmd_ctx, "--- exit from debug state at 0x%8.8" PRIx32 " ---", ctx->last_branch);
984 ctx->current_pc = ctx->last_branch;
988 case 0x4: /* periodic synchronization point */
989 next_pc = ctx->last_branch;
990 /* if we had no valid PC prior to this synchronization point,
991 * we have to move on with the next trace cycle
995 command_print(cmd_ctx, "--- periodic synchronization point at 0x%8.8" PRIx32 " ---", next_pc);
996 ctx->current_pc = next_pc;
1001 default: /* reserved */
1002 LOG_ERROR("BUG: branch reason code 0x%" PRIx32 " is reserved", ctx->last_branch_reason);
1006 /* if we got here the branch was a normal PC change
1007 * (or a periodic synchronization point, which means the same for that matter)
1008 * if we didn't accquire a complete PC continue with the next cycle
1013 /* indirect branch to the exception vector means an exception occured */
1014 if ((ctx->last_branch <= 0x20)
1015 || ((ctx->last_branch >= 0xffff0000) && (ctx->last_branch <= 0xffff0020)))
1017 if ((ctx->last_branch & 0xff) == 0x10)
1019 command_print(cmd_ctx, "data abort");
1023 command_print(cmd_ctx, "exception vector 0x%2.2" PRIx32 "", ctx->last_branch);
1024 ctx->current_pc = ctx->last_branch;
1031 /* an instruction was executed (or not, depending on the condition flags)
1032 * retrieve it from the image for displaying */
1033 if (ctx->pc_ok && (pipestat != STAT_WT) && (pipestat != STAT_TD) &&
1034 !(((pipestat == STAT_BE) || (pipestat == STAT_BD)) &&
1035 ((ctx->last_branch_reason != 0x0) && (ctx->last_branch_reason != 0x4))))
1037 if ((retval = etm_read_instruction(ctx, &instruction)) != ERROR_OK)
1039 /* can't continue tracing with no image available */
1040 if (retval == ERROR_TRACE_IMAGE_UNAVAILABLE)
1044 else if (retval == ERROR_TRACE_INSTRUCTION_UNAVAILABLE)
1046 /* TODO: handle incomplete images
1047 * for now we just quit the analsysis*/
1052 cycles = old_index - last_instruction;
1055 if ((pipestat == STAT_ID) || (pipestat == STAT_BD))
1057 uint32_t new_data_index = ctx->data_index;
1058 uint32_t new_data_half = ctx->data_half;
1060 /* in case of a branch with data, the branch target address was consumed before
1061 * we temporarily go back to the saved data index */
1062 if (pipestat == STAT_BD)
1064 ctx->data_index = old_data_index;
1065 ctx->data_half = old_data_half;
1068 if (ctx->tracemode & ETMV1_TRACE_ADDR)
1074 if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
1075 return ERROR_ETM_ANALYSIS_FAILED;
1076 ctx->last_ptr &= ~(0x7f << shift);
1077 ctx->last_ptr |= (packet & 0x7f) << shift;
1079 } while ((packet & 0x80) && (shift < 32));
1086 command_print(cmd_ctx, "address: 0x%8.8" PRIx32 "", ctx->last_ptr);
1090 if (ctx->tracemode & ETMV1_TRACE_DATA)
1092 if ((instruction.type == ARM_LDM) || (instruction.type == ARM_STM))
1095 for (i = 0; i < 16; i++)
1097 if (instruction.info.load_store_multiple.register_list & (1 << i))
1100 if (etmv1_data(ctx, 4, &data) != 0)
1101 return ERROR_ETM_ANALYSIS_FAILED;
1102 command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1106 else if ((instruction.type >= ARM_LDR) && (instruction.type <= ARM_STRH))
1109 if (etmv1_data(ctx, arm_access_size(&instruction), &data) != 0)
1110 return ERROR_ETM_ANALYSIS_FAILED;
1111 command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1115 /* restore data index after consuming BD address and data */
1116 if (pipestat == STAT_BD)
1118 ctx->data_index = new_data_index;
1119 ctx->data_half = new_data_half;
1124 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
1126 if (((instruction.type == ARM_B) ||
1127 (instruction.type == ARM_BL) ||
1128 (instruction.type == ARM_BLX)) &&
1129 (instruction.info.b_bl_bx_blx.target_address != 0xffffffff))
1131 next_pc = instruction.info.b_bl_bx_blx.target_address;
1135 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1138 else if (pipestat == STAT_IN)
1140 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1143 if ((pipestat != STAT_TD) && (pipestat != STAT_WT))
1145 char cycles_text[32] = "";
1147 /* if the trace was captured with cycle accurate tracing enabled,
1148 * output the number of cycles since the last executed instruction
1150 if (ctx->tracemode & ETMV1_CYCLE_ACCURATE)
1152 snprintf(cycles_text, 32, " (%i %s)",
1154 (cycles == 1) ? "cycle" : "cycles");
1157 command_print(cmd_ctx, "%s%s%s",
1159 (pipestat == STAT_IN) ? " (not executed)" : "",
1162 ctx->current_pc = next_pc;
1164 /* packets for an instruction don't start on or before the preceding
1165 * functional pipestat (i.e. other than WT or TD)
1167 if (ctx->data_index <= ctx->pipe_index)
1169 ctx->data_index = ctx->pipe_index + 1;
1174 ctx->pipe_index += 1;
1180 static COMMAND_HELPER(handle_etm_tracemode_command_update,
1181 etmv1_tracemode_t *mode)
1183 etmv1_tracemode_t tracemode;
1185 /* what parts of data access are traced? */
1186 if (strcmp(args[0], "none") == 0)
1187 tracemode = ETMV1_TRACE_NONE;
1188 else if (strcmp(args[0], "data") == 0)
1189 tracemode = ETMV1_TRACE_DATA;
1190 else if (strcmp(args[0], "address") == 0)
1191 tracemode = ETMV1_TRACE_ADDR;
1192 else if (strcmp(args[0], "all") == 0)
1193 tracemode = ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR;
1196 command_print(cmd_ctx, "invalid option '%s'", args[0]);
1197 return ERROR_INVALID_ARGUMENTS;
1201 COMMAND_PARSE_NUMBER(u8, args[1], context_id);
1205 tracemode |= ETMV1_CONTEXTID_NONE;
1208 tracemode |= ETMV1_CONTEXTID_8;
1211 tracemode |= ETMV1_CONTEXTID_16;
1214 tracemode |= ETMV1_CONTEXTID_32;
1217 command_print(cmd_ctx, "invalid option '%s'", args[1]);
1218 return ERROR_INVALID_ARGUMENTS;
1221 if (strcmp(args[2], "enable") == 0)
1222 tracemode |= ETMV1_CYCLE_ACCURATE;
1223 else if (strcmp(args[2], "disable") == 0)
1227 command_print(cmd_ctx, "invalid option '%s'", args[2]);
1228 return ERROR_INVALID_ARGUMENTS;
1231 if (strcmp(args[3], "enable") == 0)
1232 tracemode |= ETMV1_BRANCH_OUTPUT;
1233 else if (strcmp(args[3], "disable") == 0)
1237 command_print(cmd_ctx, "invalid option '%s'", args[3]);
1238 return ERROR_INVALID_ARGUMENTS;
1242 * - CPRT tracing (coprocessor register transfers)
1243 * - debug request (causes debug entry on trigger)
1244 * - stall on FIFOFULL (preventing tracedata lossage)
1251 COMMAND_HANDLER(handle_etm_tracemode_command)
1253 struct target *target = get_current_target(cmd_ctx);
1254 struct arm *arm = target_to_arm(target);
1255 struct etm_context *etm;
1258 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1264 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1268 etmv1_tracemode_t tracemode = etm->tracemode;
1275 CALL_COMMAND_HANDLER(handle_etm_tracemode_command_update, &tracemode);
1278 command_print(cmd_ctx, "usage: configure trace mode "
1279 "<none | data | address | all> "
1280 "<context id bits> <cycle accurate> <branch output>");
1285 * todo: fail if parameters were invalid for this hardware,
1286 * or couldn't be written; display actual hardware state...
1289 command_print(cmd_ctx, "current tracemode configuration:");
1291 switch (tracemode & ETMV1_TRACE_MASK)
1293 case ETMV1_TRACE_NONE:
1294 command_print(cmd_ctx, "data tracing: none");
1296 case ETMV1_TRACE_DATA:
1297 command_print(cmd_ctx, "data tracing: data only");
1299 case ETMV1_TRACE_ADDR:
1300 command_print(cmd_ctx, "data tracing: address only");
1302 case ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR:
1303 command_print(cmd_ctx, "data tracing: address and data");
1307 switch (tracemode & ETMV1_CONTEXTID_MASK)
1309 case ETMV1_CONTEXTID_NONE:
1310 command_print(cmd_ctx, "contextid tracing: none");
1312 case ETMV1_CONTEXTID_8:
1313 command_print(cmd_ctx, "contextid tracing: 8 bit");
1315 case ETMV1_CONTEXTID_16:
1316 command_print(cmd_ctx, "contextid tracing: 16 bit");
1318 case ETMV1_CONTEXTID_32:
1319 command_print(cmd_ctx, "contextid tracing: 32 bit");
1323 if (tracemode & ETMV1_CYCLE_ACCURATE)
1325 command_print(cmd_ctx, "cycle-accurate tracing enabled");
1329 command_print(cmd_ctx, "cycle-accurate tracing disabled");
1332 if (tracemode & ETMV1_BRANCH_OUTPUT)
1334 command_print(cmd_ctx, "full branch address output enabled");
1338 command_print(cmd_ctx, "full branch address output disabled");
1341 /* only update ETM_CTRL register if tracemode changed */
1342 if (etm->tracemode != tracemode)
1344 struct reg *etm_ctrl_reg;
1346 etm_ctrl_reg = etm_reg_lookup(etm, ETM_CTRL);
1350 etm_get_reg(etm_ctrl_reg);
1352 buf_set_u32(etm_ctrl_reg->value, 2, 2, tracemode & ETMV1_TRACE_MASK);
1353 buf_set_u32(etm_ctrl_reg->value, 14, 2, (tracemode & ETMV1_CONTEXTID_MASK) >> 4);
1354 buf_set_u32(etm_ctrl_reg->value, 12, 1, (tracemode & ETMV1_CYCLE_ACCURATE) >> 8);
1355 buf_set_u32(etm_ctrl_reg->value, 8, 1, (tracemode & ETMV1_BRANCH_OUTPUT) >> 9);
1356 etm_store_reg(etm_ctrl_reg);
1358 etm->tracemode = tracemode;
1360 /* invalidate old trace data */
1361 etm->capture_status = TRACE_IDLE;
1362 if (etm->trace_depth > 0)
1364 free(etm->trace_data);
1365 etm->trace_data = NULL;
1367 etm->trace_depth = 0;
1373 COMMAND_HANDLER(handle_etm_config_command)
1375 struct target *target;
1377 etm_portmode_t portmode = 0x0;
1378 struct etm_context *etm_ctx;
1382 return ERROR_COMMAND_SYNTAX_ERROR;
1384 target = get_target(args[0]);
1387 LOG_ERROR("target '%s' not defined", args[0]);
1391 arm = target_to_arm(target);
1393 command_print(cmd_ctx, "target '%s' is '%s'; not an ARM",
1394 target->cmd_name, target_get_name(target));
1398 /* FIXME for ETMv3.0 and above -- and we don't yet know what ETM
1399 * version we'll be using!! -- so we can't know how to validate
1400 * params yet. "etm config" should likely be *AFTER* hookup...
1402 * - Many more widths might be supported ... and we can easily
1403 * check whether our setting "took".
1405 * - The "clock" and "mode" bits are interpreted differently.
1406 * See ARM IHI 0014O table 2-17 for the old behavior, and
1407 * table 2-18 for the new. With ETB it's best to specify
1411 COMMAND_PARSE_NUMBER(u8, args[1], port_width);
1414 /* before ETMv3.0 */
1416 portmode |= ETM_PORT_4BIT;
1419 portmode |= ETM_PORT_8BIT;
1422 portmode |= ETM_PORT_16BIT;
1424 /* ETMv3.0 and later*/
1426 portmode |= ETM_PORT_24BIT;
1429 portmode |= ETM_PORT_32BIT;
1432 portmode |= ETM_PORT_48BIT;
1435 portmode |= ETM_PORT_64BIT;
1438 portmode |= ETM_PORT_1BIT;
1441 portmode |= ETM_PORT_2BIT;
1444 command_print(cmd_ctx,
1445 "unsupported ETM port width '%s'", args[1]);
1449 if (strcmp("normal", args[2]) == 0)
1451 portmode |= ETM_PORT_NORMAL;
1453 else if (strcmp("multiplexed", args[2]) == 0)
1455 portmode |= ETM_PORT_MUXED;
1457 else if (strcmp("demultiplexed", args[2]) == 0)
1459 portmode |= ETM_PORT_DEMUXED;
1463 command_print(cmd_ctx, "unsupported ETM port mode '%s', must be 'normal', 'multiplexed' or 'demultiplexed'", args[2]);
1467 if (strcmp("half", args[3]) == 0)
1469 portmode |= ETM_PORT_HALF_CLOCK;
1471 else if (strcmp("full", args[3]) == 0)
1473 portmode |= ETM_PORT_FULL_CLOCK;
1477 command_print(cmd_ctx, "unsupported ETM port clocking '%s', must be 'full' or 'half'", args[3]);
1481 etm_ctx = calloc(1, sizeof(struct etm_context));
1483 LOG_DEBUG("out of memory");
1487 for (i = 0; etm_capture_drivers[i]; i++)
1489 if (strcmp(args[4], etm_capture_drivers[i]->name) == 0)
1492 if ((retval = etm_capture_drivers[i]->register_commands(cmd_ctx)) != ERROR_OK)
1498 etm_ctx->capture_driver = etm_capture_drivers[i];
1504 if (!etm_capture_drivers[i])
1506 /* no supported capture driver found, don't register an ETM */
1508 LOG_ERROR("trace capture driver '%s' not found", args[4]);
1512 etm_ctx->target = target;
1513 etm_ctx->trigger_percent = 50;
1514 etm_ctx->trace_data = NULL;
1515 etm_ctx->portmode = portmode;
1516 etm_ctx->core_state = ARMV4_5_STATE_ARM;
1520 return etm_register_user_commands(cmd_ctx);
1523 COMMAND_HANDLER(handle_etm_info_command)
1525 struct target *target;
1527 struct etm_context *etm;
1528 struct reg *etm_sys_config_reg;
1532 target = get_current_target(cmd_ctx);
1533 arm = target_to_arm(target);
1536 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1543 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1547 command_print(cmd_ctx, "ETM v%d.%d",
1548 etm->bcd_vers >> 4, etm->bcd_vers & 0xf);
1549 command_print(cmd_ctx, "pairs of address comparators: %i",
1550 (int) (etm->config >> 0) & 0x0f);
1551 command_print(cmd_ctx, "data comparators: %i",
1552 (int) (etm->config >> 4) & 0x0f);
1553 command_print(cmd_ctx, "memory map decoders: %i",
1554 (int) (etm->config >> 8) & 0x1f);
1555 command_print(cmd_ctx, "number of counters: %i",
1556 (int) (etm->config >> 13) & 0x07);
1557 command_print(cmd_ctx, "sequencer %spresent",
1558 (int) (etm->config & (1 << 16)) ? "" : "not ");
1559 command_print(cmd_ctx, "number of ext. inputs: %i",
1560 (int) (etm->config >> 17) & 0x07);
1561 command_print(cmd_ctx, "number of ext. outputs: %i",
1562 (int) (etm->config >> 20) & 0x07);
1563 command_print(cmd_ctx, "FIFO full %spresent",
1564 (int) (etm->config & (1 << 23)) ? "" : "not ");
1565 if (etm->bcd_vers < 0x20)
1566 command_print(cmd_ctx, "protocol version: %i",
1567 (int) (etm->config >> 28) & 0x07);
1569 command_print(cmd_ctx,
1570 "coprocessor and memory access %ssupported",
1571 (etm->config & (1 << 26)) ? "" : "not ");
1572 command_print(cmd_ctx, "trace start/stop %spresent",
1573 (etm->config & (1 << 26)) ? "" : "not ");
1574 command_print(cmd_ctx, "number of context comparators: %i",
1575 (int) (etm->config >> 24) & 0x03);
1578 /* SYS_CONFIG isn't present before ETMv1.2 */
1579 etm_sys_config_reg = etm_reg_lookup(etm, ETM_SYS_CONFIG);
1580 if (!etm_sys_config_reg)
1583 etm_get_reg(etm_sys_config_reg);
1584 config = buf_get_u32(etm_sys_config_reg->value, 0, 32);
1586 LOG_DEBUG("ETM SYS CONFIG %08x", (unsigned) config);
1588 max_port_size = config & 0x7;
1589 if (etm->bcd_vers >= 0x30)
1590 max_port_size |= (config >> 6) & 0x08;
1591 switch (max_port_size)
1593 /* before ETMv3.0 */
1603 /* ETMv3.0 and later*/
1623 LOG_ERROR("Illegal max_port_size");
1626 command_print(cmd_ctx, "max. port size: %i", max_port_size);
1628 if (etm->bcd_vers < 0x30) {
1629 command_print(cmd_ctx, "half-rate clocking %ssupported",
1630 (config & (1 << 3)) ? "" : "not ");
1631 command_print(cmd_ctx, "full-rate clocking %ssupported",
1632 (config & (1 << 4)) ? "" : "not ");
1633 command_print(cmd_ctx, "normal trace format %ssupported",
1634 (config & (1 << 5)) ? "" : "not ");
1635 command_print(cmd_ctx, "multiplex trace format %ssupported",
1636 (config & (1 << 6)) ? "" : "not ");
1637 command_print(cmd_ctx, "demultiplex trace format %ssupported",
1638 (config & (1 << 7)) ? "" : "not ");
1640 /* REVISIT show which size and format are selected ... */
1641 command_print(cmd_ctx, "current port size %ssupported",
1642 (config & (1 << 10)) ? "" : "not ");
1643 command_print(cmd_ctx, "current trace format %ssupported",
1644 (config & (1 << 11)) ? "" : "not ");
1646 if (etm->bcd_vers >= 0x21)
1647 command_print(cmd_ctx, "fetch comparisons %ssupported",
1648 (config & (1 << 17)) ? "not " : "");
1649 command_print(cmd_ctx, "FIFO full %ssupported",
1650 (config & (1 << 8)) ? "" : "not ");
1655 COMMAND_HANDLER(handle_etm_status_command)
1657 struct target *target;
1659 struct etm_context *etm;
1660 trace_status_t trace_status;
1662 target = get_current_target(cmd_ctx);
1663 arm = target_to_arm(target);
1666 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1673 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1678 if (etm->bcd_vers >= 0x11) {
1681 reg = etm_reg_lookup(etm, ETM_STATUS);
1684 if (etm_get_reg(reg) == ERROR_OK) {
1685 unsigned s = buf_get_u32(reg->value, 0, reg->size);
1687 command_print(cmd_ctx, "etm: %s%s%s%s",
1688 /* bit(1) == progbit */
1689 (etm->bcd_vers >= 0x12)
1691 ? "disabled" : "enabled")
1693 ((s & (1 << 3)) && etm->bcd_vers >= 0x31)
1694 ? " triggered" : "",
1695 ((s & (1 << 2)) && etm->bcd_vers >= 0x12)
1696 ? " start/stop" : "",
1697 ((s & (1 << 0)) && etm->bcd_vers >= 0x11)
1698 ? " untraced-overflow" : "");
1699 } /* else ignore and try showing trace port status */
1702 /* Trace Port Driver status */
1703 trace_status = etm->capture_driver->status(etm);
1704 if (trace_status == TRACE_IDLE)
1706 command_print(cmd_ctx, "%s: idle", etm->capture_driver->name);
1710 static char *completed = " completed";
1711 static char *running = " is running";
1712 static char *overflowed = ", overflowed";
1713 static char *triggered = ", triggered";
1715 command_print(cmd_ctx, "%s: trace collection%s%s%s",
1716 etm->capture_driver->name,
1717 (trace_status & TRACE_RUNNING) ? running : completed,
1718 (trace_status & TRACE_OVERFLOWED) ? overflowed : "",
1719 (trace_status & TRACE_TRIGGERED) ? triggered : "");
1721 if (etm->trace_depth > 0)
1723 command_print(cmd_ctx, "%i frames of trace data read",
1724 (int)(etm->trace_depth));
1731 COMMAND_HANDLER(handle_etm_image_command)
1733 struct target *target;
1735 struct etm_context *etm_ctx;
1739 command_print(cmd_ctx, "usage: etm image <file> [base address] [type]");
1743 target = get_current_target(cmd_ctx);
1744 arm = target_to_arm(target);
1747 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1754 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1760 image_close(etm_ctx->image);
1761 free(etm_ctx->image);
1762 command_print(cmd_ctx, "previously loaded image found and closed");
1765 etm_ctx->image = malloc(sizeof(struct image));
1766 etm_ctx->image->base_address_set = 0;
1767 etm_ctx->image->start_address_set = 0;
1769 /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1772 etm_ctx->image->base_address_set = 1;
1773 COMMAND_PARSE_NUMBER(int, args[1], etm_ctx->image->base_address);
1777 etm_ctx->image->base_address_set = 0;
1780 if (image_open(etm_ctx->image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
1782 free(etm_ctx->image);
1783 etm_ctx->image = NULL;
1790 COMMAND_HANDLER(handle_etm_dump_command)
1793 struct target *target;
1795 struct etm_context *etm_ctx;
1800 command_print(cmd_ctx, "usage: etm dump <file>");
1804 target = get_current_target(cmd_ctx);
1805 arm = target_to_arm(target);
1808 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1815 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1819 if (etm_ctx->capture_driver->status == TRACE_IDLE)
1821 command_print(cmd_ctx, "trace capture wasn't enabled, no trace data captured");
1825 if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1827 /* TODO: if on-the-fly capture is to be supported, this needs to be changed */
1828 command_print(cmd_ctx, "trace capture not completed");
1832 /* read the trace data if it wasn't read already */
1833 if (etm_ctx->trace_depth == 0)
1834 etm_ctx->capture_driver->read_trace(etm_ctx);
1836 if (fileio_open(&file, args[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1841 fileio_write_u32(&file, etm_ctx->capture_status);
1842 fileio_write_u32(&file, etm_ctx->portmode);
1843 fileio_write_u32(&file, etm_ctx->tracemode);
1844 fileio_write_u32(&file, etm_ctx->trace_depth);
1846 for (i = 0; i < etm_ctx->trace_depth; i++)
1848 fileio_write_u32(&file, etm_ctx->trace_data[i].pipestat);
1849 fileio_write_u32(&file, etm_ctx->trace_data[i].packet);
1850 fileio_write_u32(&file, etm_ctx->trace_data[i].flags);
1853 fileio_close(&file);
1858 COMMAND_HANDLER(handle_etm_load_command)
1861 struct target *target;
1863 struct etm_context *etm_ctx;
1868 command_print(cmd_ctx, "usage: etm load <file>");
1872 target = get_current_target(cmd_ctx);
1873 arm = target_to_arm(target);
1876 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1883 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1887 if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1889 command_print(cmd_ctx, "trace capture running, stop first");
1893 if (fileio_open(&file, args[0], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1900 command_print(cmd_ctx, "size isn't a multiple of 4, no valid trace data");
1901 fileio_close(&file);
1905 if (etm_ctx->trace_depth > 0)
1907 free(etm_ctx->trace_data);
1908 etm_ctx->trace_data = NULL;
1913 fileio_read_u32(&file, &tmp); etm_ctx->capture_status = tmp;
1914 fileio_read_u32(&file, &tmp); etm_ctx->portmode = tmp;
1915 fileio_read_u32(&file, &tmp); etm_ctx->tracemode = tmp;
1916 fileio_read_u32(&file, &etm_ctx->trace_depth);
1918 etm_ctx->trace_data = malloc(sizeof(struct etmv1_trace_data) * etm_ctx->trace_depth);
1919 if (etm_ctx->trace_data == NULL)
1921 command_print(cmd_ctx, "not enough memory to perform operation");
1922 fileio_close(&file);
1926 for (i = 0; i < etm_ctx->trace_depth; i++)
1928 uint32_t pipestat, packet, flags;
1929 fileio_read_u32(&file, &pipestat);
1930 fileio_read_u32(&file, &packet);
1931 fileio_read_u32(&file, &flags);
1932 etm_ctx->trace_data[i].pipestat = pipestat & 0xff;
1933 etm_ctx->trace_data[i].packet = packet & 0xffff;
1934 etm_ctx->trace_data[i].flags = flags;
1937 fileio_close(&file);
1942 COMMAND_HANDLER(handle_etm_trigger_percent_command)
1944 struct target *target;
1946 struct etm_context *etm_ctx;
1948 target = get_current_target(cmd_ctx);
1949 arm = target_to_arm(target);
1952 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1959 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1966 COMMAND_PARSE_NUMBER(u32, args[0], new_value);
1968 if ((new_value < 2) || (new_value > 100))
1970 command_print(cmd_ctx, "valid settings are 2%% to 100%%");
1974 etm_ctx->trigger_percent = new_value;
1978 command_print(cmd_ctx, "%i percent of the tracebuffer reserved for after the trigger", ((int)(etm_ctx->trigger_percent)));
1983 COMMAND_HANDLER(handle_etm_start_command)
1985 struct target *target;
1987 struct etm_context *etm_ctx;
1988 struct reg *etm_ctrl_reg;
1990 target = get_current_target(cmd_ctx);
1991 arm = target_to_arm(target);
1994 command_print(cmd_ctx, "ETM: current target isn't an ARM");
2001 command_print(cmd_ctx, "current target doesn't have an ETM configured");
2005 /* invalidate old tracing data */
2006 etm_ctx->capture_status = TRACE_IDLE;
2007 if (etm_ctx->trace_depth > 0)
2009 free(etm_ctx->trace_data);
2010 etm_ctx->trace_data = NULL;
2012 etm_ctx->trace_depth = 0;
2014 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
2018 etm_get_reg(etm_ctrl_reg);
2020 /* Clear programming bit (10), set port selection bit (11) */
2021 buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x2);
2023 etm_store_reg(etm_ctrl_reg);
2024 jtag_execute_queue();
2026 etm_ctx->capture_driver->start_capture(etm_ctx);
2031 COMMAND_HANDLER(handle_etm_stop_command)
2033 struct target *target;
2035 struct etm_context *etm_ctx;
2036 struct reg *etm_ctrl_reg;
2038 target = get_current_target(cmd_ctx);
2039 arm = target_to_arm(target);
2042 command_print(cmd_ctx, "ETM: current target isn't an ARM");
2049 command_print(cmd_ctx, "current target doesn't have an ETM configured");
2053 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
2057 etm_get_reg(etm_ctrl_reg);
2059 /* Set programming bit (10), clear port selection bit (11) */
2060 buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x1);
2062 etm_store_reg(etm_ctrl_reg);
2063 jtag_execute_queue();
2065 etm_ctx->capture_driver->stop_capture(etm_ctx);
2070 COMMAND_HANDLER(handle_etm_analyze_command)
2072 struct target *target;
2074 struct etm_context *etm_ctx;
2077 target = get_current_target(cmd_ctx);
2078 arm = target_to_arm(target);
2081 command_print(cmd_ctx, "ETM: current target isn't an ARM");
2088 command_print(cmd_ctx, "current target doesn't have an ETM configured");
2092 if ((retval = etmv1_analyze_trace(etm_ctx, cmd_ctx)) != ERROR_OK)
2096 case ERROR_ETM_ANALYSIS_FAILED:
2097 command_print(cmd_ctx, "further analysis failed (corrupted trace data or just end of data");
2099 case ERROR_TRACE_INSTRUCTION_UNAVAILABLE:
2100 command_print(cmd_ctx, "no instruction for current address available, analysis aborted");
2102 case ERROR_TRACE_IMAGE_UNAVAILABLE:
2103 command_print(cmd_ctx, "no image available for trace analysis");
2106 command_print(cmd_ctx, "unknown error: %i", retval);
2113 int etm_register_commands(struct command_context *cmd_ctx)
2115 etm_cmd = register_command(cmd_ctx, NULL, "etm", NULL, COMMAND_ANY, "Embedded Trace Macrocell");
2117 register_command(cmd_ctx, etm_cmd, "config", handle_etm_config_command,
2118 COMMAND_CONFIG, "etm config <target> <port_width> <port_mode> <clocking> <capture_driver>");
2123 static int etm_register_user_commands(struct command_context *cmd_ctx)
2125 register_command(cmd_ctx, etm_cmd, "tracemode", handle_etm_tracemode_command,
2126 COMMAND_EXEC, "configure/display trace mode: "
2127 "<none | data | address | all> "
2128 "<context_id_bits> <cycle_accurate> <branch_output>");
2130 register_command(cmd_ctx, etm_cmd, "info", handle_etm_info_command,
2131 COMMAND_EXEC, "display info about the current target's ETM");
2133 register_command(cmd_ctx, etm_cmd, "trigger_percent", handle_etm_trigger_percent_command,
2134 COMMAND_EXEC, "amount (<percent>) of trace buffer to be filled after the trigger occured");
2135 register_command(cmd_ctx, etm_cmd, "status", handle_etm_status_command,
2136 COMMAND_EXEC, "display current target's ETM status");
2137 register_command(cmd_ctx, etm_cmd, "start", handle_etm_start_command,
2138 COMMAND_EXEC, "start ETM trace collection");
2139 register_command(cmd_ctx, etm_cmd, "stop", handle_etm_stop_command,
2140 COMMAND_EXEC, "stop ETM trace collection");
2142 register_command(cmd_ctx, etm_cmd, "analyze", handle_etm_analyze_command,
2143 COMMAND_EXEC, "anaylze collected ETM trace");
2145 register_command(cmd_ctx, etm_cmd, "image", handle_etm_image_command,
2146 COMMAND_EXEC, "load image from <file> [base address]");
2148 register_command(cmd_ctx, etm_cmd, "dump", handle_etm_dump_command,
2149 COMMAND_EXEC, "dump captured trace data <file>");
2150 register_command(cmd_ctx, etm_cmd, "load", handle_etm_load_command,
2151 COMMAND_EXEC, "load trace data for analysis <file>");