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 ***************************************************************************/
28 #include "arm_disassembler.h"
30 #include "etm_dummy.h"
32 #if BUILD_OOCD_TRACE == 1
33 #include "oocd_trace.h"
38 * ARM "Embedded Trace Macrocell" (ETM) support -- direct JTAG access.
40 * ETM modules collect instruction and/or data trace information, compress
41 * it, and transfer it to a debugging host through either a (buffered) trace
42 * port (often a 38-pin Mictor connector) or an Embedded Trace Buffer (ETB).
44 * There are several generations of these modules. Original versions have
45 * JTAG access through a dedicated scan chain. Recent versions have added
46 * access via coprocessor instructions, memory addressing, and the ARM Debug
47 * Interface v5 (ADIv5); and phased out direct JTAG access.
49 * This code supports up to the ETMv1.3 architecture, as seen in ETM9 and
50 * most common ARM9 systems. Note: "CoreSight ETM9" implements ETMv3.2,
51 * implying non-JTAG connectivity options.
53 * Relevant documentation includes:
54 * ARM DDI 0157G ... ETM9 (r2p2) Technical Reference Manual
55 * ARM DDI 0315B ... CoreSight ETM9 (r0p1) Technical Reference Manual
56 * ARM IHI 0014O ... Embedded Trace Macrocell, Architecture Specification
67 uint8_t size
; /* low-N of 32 bits */
68 uint8_t mode
; /* RO, WO, RW */
69 uint8_t bcd_vers
; /* 1.0, 2.0, etc */
74 * Registers 0..0x7f are JTAG-addressable using scanchain 6.
75 * (Or on some processors, through coprocessor operations.)
76 * Newer versions of ETM make some W/O registers R/W, and
77 * provide definitions for some previously-unused bits.
80 /* core registers used to version/configure the ETM */
81 static const struct etm_reg_info etm_core
[] = {
82 /* NOTE: we "know" the order here ... */
83 { ETM_CONFIG
, 32, RO
, 0x10, "ETM_config", },
84 { ETM_ID
, 32, RO
, 0x20, "ETM_id", },
87 /* basic registers that are always there given the right ETM version */
88 static const struct etm_reg_info etm_basic
[] = {
89 /* ETM Trace Registers */
90 { ETM_CTRL
, 32, RW
, 0x10, "ETM_ctrl", },
91 { ETM_TRIG_EVENT
, 17, WO
, 0x10, "ETM_trig_event", },
92 { ETM_ASIC_CTRL
, 8, WO
, 0x10, "ETM_asic_ctrl", },
93 { ETM_STATUS
, 3, RO
, 0x11, "ETM_status", },
94 { ETM_SYS_CONFIG
, 9, RO
, 0x12, "ETM_sys_config", },
96 /* TraceEnable configuration */
97 { ETM_TRACE_RESOURCE_CTRL
, 32, WO
, 0x12, "ETM_trace_resource_ctrl", },
98 { ETM_TRACE_EN_CTRL2
, 16, WO
, 0x12, "ETM_trace_en_ctrl2", },
99 { ETM_TRACE_EN_EVENT
, 17, WO
, 0x10, "ETM_trace_en_event", },
100 { ETM_TRACE_EN_CTRL1
, 26, WO
, 0x10, "ETM_trace_en_ctrl1", },
102 /* ViewData configuration (data trace) */
103 { ETM_VIEWDATA_EVENT
, 17, WO
, 0x10, "ETM_viewdata_event", },
104 { ETM_VIEWDATA_CTRL1
, 32, WO
, 0x10, "ETM_viewdata_ctrl1", },
105 { ETM_VIEWDATA_CTRL2
, 32, WO
, 0x10, "ETM_viewdata_ctrl2", },
106 { ETM_VIEWDATA_CTRL3
, 17, WO
, 0x10, "ETM_viewdata_ctrl3", },
108 /* REVISIT exclude VIEWDATA_CTRL2 when it's not there */
110 { 0x78, 12, WO
, 0x20, "ETM_sync_freq", },
111 { 0x7a, 22, RO
, 0x31, "ETM_config_code_ext", },
112 { 0x7b, 32, WO
, 0x31, "ETM_ext_input_select", },
113 { 0x7c, 32, WO
, 0x34, "ETM_trace_start_stop", },
114 { 0x7d, 8, WO
, 0x34, "ETM_behavior_control", },
117 static const struct etm_reg_info etm_fifofull
[] = {
118 /* FIFOFULL configuration */
119 { ETM_FIFOFULL_REGION
, 25, WO
, 0x10, "ETM_fifofull_region", },
120 { ETM_FIFOFULL_LEVEL
, 8, WO
, 0x10, "ETM_fifofull_level", },
123 static const struct etm_reg_info etm_addr_comp
[] = {
124 /* Address comparator register pairs */
125 #define ADDR_COMPARATOR(i) \
126 { ETM_ADDR_COMPARATOR_VALUE + (i) - 1, 32, WO, 0x10, \
127 "ETM_addr_" #i "_comparator_value", }, \
128 { ETM_ADDR_ACCESS_TYPE + (i) - 1, 7, WO, 0x10, \
129 "ETM_addr_" #i "_access_type", }
147 #undef ADDR_COMPARATOR
150 static const struct etm_reg_info etm_data_comp
[] = {
151 /* Data Value Comparators (NOTE: odd addresses are reserved) */
152 #define DATA_COMPARATOR(i) \
153 { ETM_DATA_COMPARATOR_VALUE + 2*(i) - 1, 32, WO, 0x10, \
154 "ETM_data_" #i "_comparator_value", }, \
155 { ETM_DATA_COMPARATOR_MASK + 2*(i) - 1, 32, WO, 0x10, \
156 "ETM_data_" #i "_comparator_mask", }
165 #undef DATA_COMPARATOR
168 static const struct etm_reg_info etm_counters
[] = {
169 #define ETM_COUNTER(i) \
170 { ETM_COUNTER_RELOAD_VALUE + (i) - 1, 16, WO, 0x10, \
171 "ETM_counter_" #i "_reload_value", }, \
172 { ETM_COUNTER_ENABLE + (i) - 1, 18, WO, 0x10, \
173 "ETM_counter_" #i "_enable", }, \
174 { ETM_COUNTER_RELOAD_EVENT + (i) - 1, 17, WO, 0x10, \
175 "ETM_counter_" #i "_reload_event", }, \
176 { ETM_COUNTER_VALUE + (i) - 1, 16, RO, 0x10, \
177 "ETM_counter_" #i "_value", }
185 static const struct etm_reg_info etm_sequencer
[] = {
187 { ETM_SEQUENCER_EVENT + (i), 17, WO, 0x10, \
188 "ETM_sequencer_event" #i, }
189 ETM_SEQ(0), /* 1->2 */
190 ETM_SEQ(1), /* 2->1 */
191 ETM_SEQ(2), /* 2->3 */
192 ETM_SEQ(3), /* 3->1 */
193 ETM_SEQ(4), /* 3->2 */
194 ETM_SEQ(5), /* 1->3 */
197 { ETM_SEQUENCER_STATE
, 2, RO
, 0x10, "ETM_sequencer_state", },
200 static const struct etm_reg_info etm_outputs
[] = {
201 #define ETM_OUTPUT(i) \
202 { ETM_EXTERNAL_OUTPUT + (i) - 1, 17, WO, 0x10, \
203 "ETM_external_output" #i, }
213 /* registers from 0x6c..0x7f were added after ETMv1.3 */
215 /* Context ID Comparators */
216 { 0x6c, 32, RO
, 0x20, "ETM_contextid_comparator_value1", }
217 { 0x6d, 32, RO
, 0x20, "ETM_contextid_comparator_value2", }
218 { 0x6e, 32, RO
, 0x20, "ETM_contextid_comparator_value3", }
219 { 0x6f, 32, RO
, 0x20, "ETM_contextid_comparator_mask", }
222 static int etm_get_reg(struct reg
*reg
);
223 static int etm_read_reg_w_check(struct reg
*reg
,
224 uint8_t* check_value
, uint8_t* check_mask
);
225 static int etm_register_user_commands(struct command_context
*cmd_ctx
);
226 static int etm_set_reg_w_exec(struct reg
*reg
, uint8_t *buf
);
227 static int etm_write_reg(struct reg
*reg
, uint32_t value
);
229 static const struct reg_arch_type etm_scan6_type
= {
231 .set
= etm_set_reg_w_exec
,
234 /* Look up register by ID ... most ETM instances only
235 * support a subset of the possible registers.
237 static struct reg
*etm_reg_lookup(struct etm_context
*etm_ctx
, unsigned id
)
239 struct reg_cache
*cache
= etm_ctx
->reg_cache
;
242 for (i
= 0; i
< cache
->num_regs
; i
++) {
243 struct etm_reg
*reg
= cache
->reg_list
[i
].arch_info
;
245 if (reg
->reg_info
->addr
== id
)
246 return &cache
->reg_list
[i
];
249 /* caller asking for nonexistent register is a bug! */
250 /* REVISIT say which of the N targets was involved */
251 LOG_ERROR("ETM: register 0x%02x not available", id
);
255 static void etm_reg_add(unsigned bcd_vers
, struct arm_jtag
*jtag_info
,
256 struct reg_cache
*cache
, struct etm_reg
*ereg
,
257 const struct etm_reg_info
*r
, unsigned nreg
)
259 struct reg
*reg
= cache
->reg_list
;
261 reg
+= cache
->num_regs
;
262 ereg
+= cache
->num_regs
;
264 /* add up to "nreg" registers from "r", if supported by this
265 * version of the ETM, to the specified cache.
267 for (; nreg
--; r
++) {
269 /* this ETM may be too old to have some registers */
270 if (r
->bcd_vers
> bcd_vers
)
275 reg
->value
= &ereg
->value
;
276 reg
->arch_info
= ereg
;
277 reg
->type
= &etm_scan6_type
;
282 ereg
->jtag_info
= jtag_info
;
287 struct reg_cache
*etm_build_reg_cache(struct target
*target
,
288 struct arm_jtag
*jtag_info
, struct etm_context
*etm_ctx
)
290 struct reg_cache
*reg_cache
= malloc(sizeof(struct reg_cache
));
291 struct reg
*reg_list
= NULL
;
292 struct etm_reg
*arch_info
= NULL
;
293 unsigned bcd_vers
, config
;
295 /* the actual registers are kept in two arrays */
296 reg_list
= calloc(128, sizeof(struct reg
));
297 arch_info
= calloc(128, sizeof(struct etm_reg
));
299 /* fill in values for the reg cache */
300 reg_cache
->name
= "etm registers";
301 reg_cache
->next
= NULL
;
302 reg_cache
->reg_list
= reg_list
;
303 reg_cache
->num_regs
= 0;
305 /* add ETM_CONFIG, then parse its values to see
306 * which other registers exist in this ETM
308 etm_reg_add(0x10, jtag_info
, reg_cache
, arch_info
,
311 etm_get_reg(reg_list
);
312 etm_ctx
->config
= buf_get_u32((void *)&arch_info
->value
, 0, 32);
313 config
= etm_ctx
->config
;
315 /* figure ETM version then add base registers */
316 if (config
& (1 << 31)) {
318 LOG_WARNING("ETMv2+ support is incomplete");
320 /* REVISIT more registers may exist; they may now be
321 * readable; more register bits have defined meanings;
322 * don't presume trace start/stop support is present;
323 * and include any context ID comparator registers.
325 etm_reg_add(0x20, jtag_info
, reg_cache
, arch_info
,
327 etm_get_reg(reg_list
+ 1);
328 etm_ctx
->id
= buf_get_u32(
329 (void *)&arch_info
[1].value
, 0, 32);
330 LOG_DEBUG("ETM ID: %08x", (unsigned) etm_ctx
->id
);
331 bcd_vers
= 0x10 + (((etm_ctx
->id
) >> 4) & 0xff);
334 switch (config
>> 28) {
351 LOG_WARNING("Bad ETMv1 protocol %d", config
>> 28);
355 etm_ctx
->bcd_vers
= bcd_vers
;
356 LOG_INFO("ETM v%d.%d", bcd_vers
>> 4, bcd_vers
& 0xf);
358 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
359 etm_basic
, ARRAY_SIZE(etm_basic
));
361 /* address and data comparators; counters; outputs */
362 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
363 etm_addr_comp
, 4 * (0x0f & (config
>> 0)));
364 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
365 etm_data_comp
, 2 * (0x0f & (config
>> 4)));
366 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
367 etm_counters
, 4 * (0x07 & (config
>> 13)));
368 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
369 etm_outputs
, (0x07 & (config
>> 20)));
371 /* FIFOFULL presence is optional
372 * REVISIT for ETMv1.2 and later, don't bother adding this
373 * unless ETM_SYS_CONFIG says it's also *supported* ...
375 if (config
& (1 << 23))
376 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
377 etm_fifofull
, ARRAY_SIZE(etm_fifofull
));
379 /* sequencer is optional (for state-dependant triggering) */
380 if (config
& (1 << 16))
381 etm_reg_add(bcd_vers
, jtag_info
, reg_cache
, arch_info
,
382 etm_sequencer
, ARRAY_SIZE(etm_sequencer
));
384 /* REVISIT could realloc and likely save half the memory
385 * in the two chunks we allocated...
388 /* the ETM might have an ETB connected */
389 if (strcmp(etm_ctx
->capture_driver
->name
, "etb") == 0)
391 struct etb
*etb
= etm_ctx
->capture_driver_priv
;
395 LOG_ERROR("etb selected as etm capture driver, but no ETB configured");
399 reg_cache
->next
= etb_build_reg_cache(etb
);
401 etb
->reg_cache
= reg_cache
->next
;
404 etm_ctx
->reg_cache
= reg_cache
;
414 static int etm_read_reg(struct reg
*reg
)
416 return etm_read_reg_w_check(reg
, NULL
, NULL
);
419 static int etm_store_reg(struct reg
*reg
)
421 return etm_write_reg(reg
, buf_get_u32(reg
->value
, 0, reg
->size
));
424 int etm_setup(struct target
*target
)
427 uint32_t etm_ctrl_value
;
428 struct arm
*arm
= target_to_arm(target
);
429 struct etm_context
*etm_ctx
= arm
->etm
;
430 struct reg
*etm_ctrl_reg
;
432 etm_ctrl_reg
= etm_reg_lookup(etm_ctx
, ETM_CTRL
);
436 /* initialize some ETM control register settings */
437 etm_get_reg(etm_ctrl_reg
);
438 etm_ctrl_value
= buf_get_u32(etm_ctrl_reg
->value
, 0, 32);
440 /* clear the ETM powerdown bit (0) */
441 etm_ctrl_value
&= ~ETM_CTRL_POWERDOWN
;
443 /* configure port width (21,6:4), mode (13,17:16) and
444 * for older modules clocking (13)
446 etm_ctrl_value
= (etm_ctrl_value
447 & ~ETM_PORT_WIDTH_MASK
448 & ~ETM_PORT_MODE_MASK
450 & ~ETM_PORT_CLOCK_MASK
)
453 buf_set_u32(etm_ctrl_reg
->value
, 0, 32, etm_ctrl_value
);
454 etm_store_reg(etm_ctrl_reg
);
456 etm_ctx
->control
= etm_ctrl_value
;
458 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
461 /* REVISIT for ETMv3.0 and later, read ETM_sys_config to
462 * verify that those width and mode settings are OK ...
465 if ((retval
= etm_ctx
->capture_driver
->init(etm_ctx
)) != ERROR_OK
)
467 LOG_ERROR("ETM capture driver initialization failed");
473 static int etm_get_reg(struct reg
*reg
)
477 if ((retval
= etm_read_reg(reg
)) != ERROR_OK
)
479 LOG_ERROR("BUG: error scheduling etm register read");
483 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
485 LOG_ERROR("register read failed");
492 static int etm_read_reg_w_check(struct reg
*reg
,
493 uint8_t* check_value
, uint8_t* check_mask
)
495 struct etm_reg
*etm_reg
= reg
->arch_info
;
496 const struct etm_reg_info
*r
= etm_reg
->reg_info
;
497 uint8_t reg_addr
= r
->addr
& 0x7f;
498 struct scan_field fields
[3];
500 if (etm_reg
->reg_info
->mode
== WO
) {
501 LOG_ERROR("BUG: can't read write-only register %s", r
->name
);
502 return ERROR_INVALID_ARGUMENTS
;
505 LOG_DEBUG("%s (%u)", r
->name
, reg_addr
);
507 arm_jtag_scann(etm_reg
->jtag_info
, 0x6, TAP_IDLE
);
508 arm_jtag_set_instr(etm_reg
->jtag_info
, etm_reg
->jtag_info
->intest_instr
, NULL
, TAP_IDLE
);
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].num_bits
= 7;
518 fields
[1].out_value
= &temp1
;
519 buf_set_u32(&temp1
, 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].num_bits
= 1;
526 fields
[2].out_value
= &temp2
;
527 buf_set_u32(&temp2
, 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(etm_reg
->jtag_info
->tap
, 3, fields
, TAP_IDLE
);
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(etm_reg
->jtag_info
->tap
, 3, fields
, TAP_IDLE
);
543 static int etm_set_reg(struct reg
*reg
, uint32_t value
)
547 if ((retval
= etm_write_reg(reg
, value
)) != ERROR_OK
)
549 LOG_ERROR("BUG: error scheduling etm register write");
553 buf_set_u32(reg
->value
, 0, reg
->size
, value
);
560 static int etm_set_reg_w_exec(struct reg
*reg
, uint8_t *buf
)
564 etm_set_reg(reg
, buf_get_u32(buf
, 0, reg
->size
));
566 if ((retval
= jtag_execute_queue()) != ERROR_OK
)
568 LOG_ERROR("register write failed");
574 static int etm_write_reg(struct reg
*reg
, uint32_t value
)
576 struct etm_reg
*etm_reg
= reg
->arch_info
;
577 const struct etm_reg_info
*r
= etm_reg
->reg_info
;
578 uint8_t reg_addr
= r
->addr
& 0x7f;
579 struct scan_field fields
[3];
581 if (etm_reg
->reg_info
->mode
== RO
) {
582 LOG_ERROR("BUG: can't write read--only register %s", r
->name
);
583 return ERROR_INVALID_ARGUMENTS
;
586 LOG_DEBUG("%s (%u): 0x%8.8" PRIx32
"", r
->name
, reg_addr
, value
);
588 arm_jtag_scann(etm_reg
->jtag_info
, 0x6, TAP_IDLE
);
589 arm_jtag_set_instr(etm_reg
->jtag_info
, etm_reg
->jtag_info
->intest_instr
, NULL
, TAP_IDLE
);
591 fields
[0].num_bits
= 32;
593 fields
[0].out_value
= tmp1
;
594 buf_set_u32(tmp1
, 0, 32, value
);
595 fields
[0].in_value
= NULL
;
597 fields
[1].num_bits
= 7;
599 fields
[1].out_value
= &tmp2
;
600 buf_set_u32(&tmp2
, 0, 7, reg_addr
);
601 fields
[1].in_value
= NULL
;
603 fields
[2].num_bits
= 1;
605 fields
[2].out_value
= &tmp3
;
606 buf_set_u32(&tmp3
, 0, 1, 1);
607 fields
[2].in_value
= NULL
;
609 jtag_add_dr_scan(etm_reg
->jtag_info
->tap
, 3, fields
, TAP_IDLE
);
615 /* ETM trace analysis functionality */
617 static struct etm_capture_driver
*etm_capture_drivers
[] =
620 &etm_dummy_capture_driver
,
621 #if BUILD_OOCD_TRACE == 1
622 &oocd_trace_capture_driver
,
627 static int etm_read_instruction(struct etm_context
*ctx
, struct arm_instruction
*instruction
)
636 return ERROR_TRACE_IMAGE_UNAVAILABLE
;
638 /* search for the section the current instruction belongs to */
639 for (i
= 0; i
< ctx
->image
->num_sections
; i
++)
641 if ((ctx
->image
->sections
[i
].base_address
<= ctx
->current_pc
) &&
642 (ctx
->image
->sections
[i
].base_address
+ ctx
->image
->sections
[i
].size
> ctx
->current_pc
))
651 /* current instruction couldn't be found in the image */
652 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE
;
655 if (ctx
->core_state
== ARM_STATE_ARM
)
658 if ((retval
= image_read_section(ctx
->image
, section
,
659 ctx
->current_pc
- ctx
->image
->sections
[section
].base_address
,
660 4, buf
, &size_read
)) != ERROR_OK
)
662 LOG_ERROR("error while reading instruction: %i", retval
);
663 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE
;
665 opcode
= target_buffer_get_u32(ctx
->target
, buf
);
666 arm_evaluate_opcode(opcode
, ctx
->current_pc
, instruction
);
668 else if (ctx
->core_state
== ARM_STATE_THUMB
)
671 if ((retval
= image_read_section(ctx
->image
, section
,
672 ctx
->current_pc
- ctx
->image
->sections
[section
].base_address
,
673 2, 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_u16(ctx
->target
, buf
);
679 thumb_evaluate_opcode(opcode
, ctx
->current_pc
, instruction
);
681 else if (ctx
->core_state
== ARM_STATE_JAZELLE
)
683 LOG_ERROR("BUG: tracing of jazelle code not supported");
688 LOG_ERROR("BUG: unknown core state encountered");
695 static int etmv1_next_packet(struct etm_context
*ctx
, uint8_t *packet
, int apo
)
697 while (ctx
->data_index
< ctx
->trace_depth
)
699 /* if the caller specified an address packet offset, skip until the
700 * we reach the n-th cycle marked with tracesync */
703 if (ctx
->trace_data
[ctx
->data_index
].flags
& ETMV1_TRACESYNC_CYCLE
)
714 /* no tracedata output during a TD cycle
715 * or in a trigger cycle */
716 if ((ctx
->trace_data
[ctx
->data_index
].pipestat
== STAT_TD
)
717 || (ctx
->trace_data
[ctx
->data_index
].flags
& ETMV1_TRIGGER_CYCLE
))
724 /* FIXME there are more port widths than these... */
725 if ((ctx
->control
& ETM_PORT_WIDTH_MASK
) == ETM_PORT_16BIT
)
727 if (ctx
->data_half
== 0)
729 *packet
= ctx
->trace_data
[ctx
->data_index
].packet
& 0xff;
734 *packet
= (ctx
->trace_data
[ctx
->data_index
].packet
& 0xff00) >> 8;
739 else if ((ctx
->control
& ETM_PORT_WIDTH_MASK
) == ETM_PORT_8BIT
)
741 *packet
= ctx
->trace_data
[ctx
->data_index
].packet
& 0xff;
746 /* on a 4-bit port, a packet will be output during two consecutive cycles */
747 if (ctx
->data_index
> (ctx
->trace_depth
- 2))
750 *packet
= ctx
->trace_data
[ctx
->data_index
].packet
& 0xf;
751 *packet
|= (ctx
->trace_data
[ctx
->data_index
+ 1].packet
& 0xf) << 4;
752 ctx
->data_index
+= 2;
761 static int etmv1_branch_address(struct etm_context
*ctx
)
769 /* quit analysis if less than two cycles are left in the trace
770 * because we can't extract the APO */
771 if (ctx
->data_index
> (ctx
->trace_depth
- 2))
774 /* a BE could be output during an APO cycle, skip the current
775 * and continue with the new one */
776 if (ctx
->trace_data
[ctx
->pipe_index
+ 1].pipestat
& 0x4)
778 if (ctx
->trace_data
[ctx
->pipe_index
+ 2].pipestat
& 0x4)
781 /* address packet offset encoded in the next two cycles' pipestat bits */
782 apo
= ctx
->trace_data
[ctx
->pipe_index
+ 1].pipestat
& 0x3;
783 apo
|= (ctx
->trace_data
[ctx
->pipe_index
+ 2].pipestat
& 0x3) << 2;
785 /* count number of tracesync cycles between current pipe_index and data_index
786 * i.e. the number of tracesyncs that data_index already passed by
787 * to subtract them from the APO */
788 for (i
= ctx
->pipe_index
; i
< ctx
->data_index
; i
++)
790 if (ctx
->trace_data
[ctx
->pipe_index
+ 1].pipestat
& ETMV1_TRACESYNC_CYCLE
)
794 /* extract up to four 7-bit packets */
796 if ((retval
= etmv1_next_packet(ctx
, &packet
, (shift
== 0) ? apo
+ 1 : 0)) != 0)
798 ctx
->last_branch
&= ~(0x7f << shift
);
799 ctx
->last_branch
|= (packet
& 0x7f) << shift
;
801 } while ((packet
& 0x80) && (shift
< 28));
803 /* one last packet holding 4 bits of the address, plus the branch reason code */
804 if ((shift
== 28) && (packet
& 0x80))
806 if ((retval
= etmv1_next_packet(ctx
, &packet
, 0)) != 0)
808 ctx
->last_branch
&= 0x0fffffff;
809 ctx
->last_branch
|= (packet
& 0x0f) << 28;
810 ctx
->last_branch_reason
= (packet
& 0x70) >> 4;
815 ctx
->last_branch_reason
= 0;
823 /* if a full address was output, we might have branched into Jazelle state */
824 if ((shift
== 32) && (packet
& 0x80))
826 ctx
->core_state
= ARM_STATE_JAZELLE
;
830 /* if we didn't branch into Jazelle state, the current processor state is
831 * encoded in bit 0 of the branch target address */
832 if (ctx
->last_branch
& 0x1)
834 ctx
->core_state
= ARM_STATE_THUMB
;
835 ctx
->last_branch
&= ~0x1;
839 ctx
->core_state
= ARM_STATE_ARM
;
840 ctx
->last_branch
&= ~0x3;
847 static int etmv1_data(struct etm_context
*ctx
, int size
, uint32_t *data
)
853 for (j
= 0; j
< size
; j
++)
855 if ((retval
= etmv1_next_packet(ctx
, &buf
[j
], 0)) != 0)
861 LOG_ERROR("TODO: add support for 64-bit values");
865 *data
= target_buffer_get_u32(ctx
->target
, buf
);
867 *data
= target_buffer_get_u16(ctx
->target
, buf
);
876 static int etmv1_analyze_trace(struct etm_context
*ctx
, struct command_context
*cmd_ctx
)
879 struct arm_instruction instruction
;
881 /* read the trace data if it wasn't read already */
882 if (ctx
->trace_depth
== 0)
883 ctx
->capture_driver
->read_trace(ctx
);
885 if (ctx
->trace_depth
== 0) {
886 command_print(cmd_ctx
, "Trace is empty.");
890 /* start at the beginning of the captured trace */
895 /* neither the PC nor the data pointer are valid */
899 while (ctx
->pipe_index
< ctx
->trace_depth
)
901 uint8_t pipestat
= ctx
->trace_data
[ctx
->pipe_index
].pipestat
;
902 uint32_t next_pc
= ctx
->current_pc
;
903 uint32_t old_data_index
= ctx
->data_index
;
904 uint32_t old_data_half
= ctx
->data_half
;
905 uint32_t old_index
= ctx
->pipe_index
;
906 uint32_t last_instruction
= ctx
->last_instruction
;
908 int current_pc_ok
= ctx
->pc_ok
;
910 if (ctx
->trace_data
[ctx
->pipe_index
].flags
& ETMV1_TRIGGER_CYCLE
)
912 command_print(cmd_ctx
, "--- trigger ---");
915 /* instructions execute in IE/D or BE/D cycles */
916 if ((pipestat
== STAT_IE
) || (pipestat
== STAT_ID
))
917 ctx
->last_instruction
= ctx
->pipe_index
;
919 /* if we don't have a valid pc skip until we reach an indirect branch */
920 if ((!ctx
->pc_ok
) && (pipestat
!= STAT_BE
))
926 /* any indirect branch could have interrupted instruction flow
927 * - the branch reason code could indicate a trace discontinuity
928 * - a branch to the exception vectors indicates an exception
930 if ((pipestat
== STAT_BE
) || (pipestat
== STAT_BD
))
932 /* backup current data index, to be able to consume the branch address
933 * before examining data address and values
935 old_data_index
= ctx
->data_index
;
936 old_data_half
= ctx
->data_half
;
938 ctx
->last_instruction
= ctx
->pipe_index
;
940 if ((retval
= etmv1_branch_address(ctx
)) != 0)
942 /* negative return value from etmv1_branch_address means we ran out of packets,
943 * quit analysing the trace */
947 /* a positive return values means the current branch was abandoned,
948 * and a new branch was encountered in cycle ctx->pipe_index + retval;
950 LOG_WARNING("abandoned branch encountered, correctnes of analysis uncertain");
951 ctx
->pipe_index
+= retval
;
955 /* skip over APO cycles */
956 ctx
->pipe_index
+= 2;
958 switch (ctx
->last_branch_reason
)
960 case 0x0: /* normal PC change */
961 next_pc
= ctx
->last_branch
;
963 case 0x1: /* tracing enabled */
964 command_print(cmd_ctx
, "--- tracing enabled at 0x%8.8" PRIx32
" ---", ctx
->last_branch
);
965 ctx
->current_pc
= ctx
->last_branch
;
969 case 0x2: /* trace restarted after FIFO overflow */
970 command_print(cmd_ctx
, "--- trace restarted after FIFO overflow at 0x%8.8" PRIx32
" ---", ctx
->last_branch
);
971 ctx
->current_pc
= ctx
->last_branch
;
975 case 0x3: /* exit from debug state */
976 command_print(cmd_ctx
, "--- exit from debug state at 0x%8.8" PRIx32
" ---", ctx
->last_branch
);
977 ctx
->current_pc
= ctx
->last_branch
;
981 case 0x4: /* periodic synchronization point */
982 next_pc
= ctx
->last_branch
;
983 /* if we had no valid PC prior to this synchronization point,
984 * we have to move on with the next trace cycle
988 command_print(cmd_ctx
, "--- periodic synchronization point at 0x%8.8" PRIx32
" ---", next_pc
);
989 ctx
->current_pc
= next_pc
;
994 default: /* reserved */
995 LOG_ERROR("BUG: branch reason code 0x%" PRIx32
" is reserved", ctx
->last_branch_reason
);
999 /* if we got here the branch was a normal PC change
1000 * (or a periodic synchronization point, which means the same for that matter)
1001 * if we didn't accquire a complete PC continue with the next cycle
1006 /* indirect branch to the exception vector means an exception occured */
1007 if ((ctx
->last_branch
<= 0x20)
1008 || ((ctx
->last_branch
>= 0xffff0000) && (ctx
->last_branch
<= 0xffff0020)))
1010 if ((ctx
->last_branch
& 0xff) == 0x10)
1012 command_print(cmd_ctx
, "data abort");
1016 command_print(cmd_ctx
, "exception vector 0x%2.2" PRIx32
"", ctx
->last_branch
);
1017 ctx
->current_pc
= ctx
->last_branch
;
1024 /* an instruction was executed (or not, depending on the condition flags)
1025 * retrieve it from the image for displaying */
1026 if (ctx
->pc_ok
&& (pipestat
!= STAT_WT
) && (pipestat
!= STAT_TD
) &&
1027 !(((pipestat
== STAT_BE
) || (pipestat
== STAT_BD
)) &&
1028 ((ctx
->last_branch_reason
!= 0x0) && (ctx
->last_branch_reason
!= 0x4))))
1030 if ((retval
= etm_read_instruction(ctx
, &instruction
)) != ERROR_OK
)
1032 /* can't continue tracing with no image available */
1033 if (retval
== ERROR_TRACE_IMAGE_UNAVAILABLE
)
1037 else if (retval
== ERROR_TRACE_INSTRUCTION_UNAVAILABLE
)
1039 /* TODO: handle incomplete images
1040 * for now we just quit the analsysis*/
1045 cycles
= old_index
- last_instruction
;
1048 if ((pipestat
== STAT_ID
) || (pipestat
== STAT_BD
))
1050 uint32_t new_data_index
= ctx
->data_index
;
1051 uint32_t new_data_half
= ctx
->data_half
;
1053 /* in case of a branch with data, the branch target address was consumed before
1054 * we temporarily go back to the saved data index */
1055 if (pipestat
== STAT_BD
)
1057 ctx
->data_index
= old_data_index
;
1058 ctx
->data_half
= old_data_half
;
1061 if (ctx
->control
& ETM_CTRL_TRACE_ADDR
)
1067 if ((retval
= etmv1_next_packet(ctx
, &packet
, 0)) != 0)
1068 return ERROR_ETM_ANALYSIS_FAILED
;
1069 ctx
->last_ptr
&= ~(0x7f << shift
);
1070 ctx
->last_ptr
|= (packet
& 0x7f) << shift
;
1072 } while ((packet
& 0x80) && (shift
< 32));
1079 command_print(cmd_ctx
, "address: 0x%8.8" PRIx32
"", ctx
->last_ptr
);
1083 if (ctx
->control
& ETM_CTRL_TRACE_DATA
)
1085 if ((instruction
.type
== ARM_LDM
) || (instruction
.type
== ARM_STM
))
1088 for (i
= 0; i
< 16; i
++)
1090 if (instruction
.info
.load_store_multiple
.register_list
& (1 << i
))
1093 if (etmv1_data(ctx
, 4, &data
) != 0)
1094 return ERROR_ETM_ANALYSIS_FAILED
;
1095 command_print(cmd_ctx
, "data: 0x%8.8" PRIx32
"", data
);
1099 else if ((instruction
.type
>= ARM_LDR
) && (instruction
.type
<= ARM_STRH
))
1102 if (etmv1_data(ctx
, arm_access_size(&instruction
), &data
) != 0)
1103 return ERROR_ETM_ANALYSIS_FAILED
;
1104 command_print(cmd_ctx
, "data: 0x%8.8" PRIx32
"", data
);
1108 /* restore data index after consuming BD address and data */
1109 if (pipestat
== STAT_BD
)
1111 ctx
->data_index
= new_data_index
;
1112 ctx
->data_half
= new_data_half
;
1117 if ((pipestat
== STAT_IE
) || (pipestat
== STAT_ID
))
1119 if (((instruction
.type
== ARM_B
) ||
1120 (instruction
.type
== ARM_BL
) ||
1121 (instruction
.type
== ARM_BLX
)) &&
1122 (instruction
.info
.b_bl_bx_blx
.target_address
!= 0xffffffff))
1124 next_pc
= instruction
.info
.b_bl_bx_blx
.target_address
;
1128 next_pc
+= (ctx
->core_state
== ARM_STATE_ARM
) ? 4 : 2;
1131 else if (pipestat
== STAT_IN
)
1133 next_pc
+= (ctx
->core_state
== ARM_STATE_ARM
) ? 4 : 2;
1136 if ((pipestat
!= STAT_TD
) && (pipestat
!= STAT_WT
))
1138 char cycles_text
[32] = "";
1140 /* if the trace was captured with cycle accurate tracing enabled,
1141 * output the number of cycles since the last executed instruction
1143 if (ctx
->control
& ETM_CTRL_CYCLE_ACCURATE
)
1145 snprintf(cycles_text
, 32, " (%i %s)",
1147 (cycles
== 1) ? "cycle" : "cycles");
1150 command_print(cmd_ctx
, "%s%s%s",
1152 (pipestat
== STAT_IN
) ? " (not executed)" : "",
1155 ctx
->current_pc
= next_pc
;
1157 /* packets for an instruction don't start on or before the preceding
1158 * functional pipestat (i.e. other than WT or TD)
1160 if (ctx
->data_index
<= ctx
->pipe_index
)
1162 ctx
->data_index
= ctx
->pipe_index
+ 1;
1167 ctx
->pipe_index
+= 1;
1173 static COMMAND_HELPER(handle_etm_tracemode_command_update
,
1178 /* what parts of data access are traced? */
1179 if (strcmp(CMD_ARGV
[0], "none") == 0)
1181 else if (strcmp(CMD_ARGV
[0], "data") == 0)
1182 tracemode
= ETM_CTRL_TRACE_DATA
;
1183 else if (strcmp(CMD_ARGV
[0], "address") == 0)
1184 tracemode
= ETM_CTRL_TRACE_ADDR
;
1185 else if (strcmp(CMD_ARGV
[0], "all") == 0)
1186 tracemode
= ETM_CTRL_TRACE_DATA
| ETM_CTRL_TRACE_ADDR
;
1189 command_print(CMD_CTX
, "invalid option '%s'", CMD_ARGV
[0]);
1190 return ERROR_INVALID_ARGUMENTS
;
1194 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], context_id
);
1198 tracemode
|= ETM_CTRL_CONTEXTID_NONE
;
1201 tracemode
|= ETM_CTRL_CONTEXTID_8
;
1204 tracemode
|= ETM_CTRL_CONTEXTID_16
;
1207 tracemode
|= ETM_CTRL_CONTEXTID_32
;
1210 command_print(CMD_CTX
, "invalid option '%s'", CMD_ARGV
[1]);
1211 return ERROR_INVALID_ARGUMENTS
;
1214 bool etmv1_cycle_accurate
;
1215 COMMAND_PARSE_ENABLE(CMD_ARGV
[2], etmv1_cycle_accurate
);
1216 if (etmv1_cycle_accurate
)
1217 tracemode
|= ETM_CTRL_CYCLE_ACCURATE
;
1219 bool etmv1_branch_output
;
1220 COMMAND_PARSE_ENABLE(CMD_ARGV
[3], etmv1_branch_output
);
1221 if (etmv1_branch_output
)
1222 tracemode
|= ETM_CTRL_BRANCH_OUTPUT
;
1225 * - CPRT tracing (coprocessor register transfers)
1226 * - debug request (causes debug entry on trigger)
1227 * - stall on FIFOFULL (preventing tracedata lossage)
1234 COMMAND_HANDLER(handle_etm_tracemode_command
)
1236 struct target
*target
= get_current_target(CMD_CTX
);
1237 struct arm
*arm
= target_to_arm(target
);
1238 struct etm_context
*etm
;
1241 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1247 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1251 uint32_t tracemode
= etm
->control
;
1258 CALL_COMMAND_HANDLER(handle_etm_tracemode_command_update
,
1262 command_print(CMD_CTX
, "usage: tracemode "
1263 "('none'|'data'|'address'|'all') "
1265 "('enable'|'disable') "
1266 "('enable'|'disable')"
1272 * todo: fail if parameters were invalid for this hardware,
1273 * or couldn't be written; display actual hardware state...
1276 command_print(CMD_CTX
, "current tracemode configuration:");
1278 switch (tracemode
& ETM_CTRL_TRACE_MASK
)
1281 command_print(CMD_CTX
, "data tracing: none");
1283 case ETM_CTRL_TRACE_DATA
:
1284 command_print(CMD_CTX
, "data tracing: data only");
1286 case ETM_CTRL_TRACE_ADDR
:
1287 command_print(CMD_CTX
, "data tracing: address only");
1289 case ETM_CTRL_TRACE_DATA
| ETM_CTRL_TRACE_ADDR
:
1290 command_print(CMD_CTX
, "data tracing: address and data");
1294 switch (tracemode
& ETM_CTRL_CONTEXTID_MASK
)
1296 case ETM_CTRL_CONTEXTID_NONE
:
1297 command_print(CMD_CTX
, "contextid tracing: none");
1299 case ETM_CTRL_CONTEXTID_8
:
1300 command_print(CMD_CTX
, "contextid tracing: 8 bit");
1302 case ETM_CTRL_CONTEXTID_16
:
1303 command_print(CMD_CTX
, "contextid tracing: 16 bit");
1305 case ETM_CTRL_CONTEXTID_32
:
1306 command_print(CMD_CTX
, "contextid tracing: 32 bit");
1310 if (tracemode
& ETM_CTRL_CYCLE_ACCURATE
)
1312 command_print(CMD_CTX
, "cycle-accurate tracing enabled");
1316 command_print(CMD_CTX
, "cycle-accurate tracing disabled");
1319 if (tracemode
& ETM_CTRL_BRANCH_OUTPUT
)
1321 command_print(CMD_CTX
, "full branch address output enabled");
1325 command_print(CMD_CTX
, "full branch address output disabled");
1328 #define TRACEMODE_MASK ( \
1329 ETM_CTRL_CONTEXTID_MASK \
1330 | ETM_CTRL_BRANCH_OUTPUT \
1331 | ETM_CTRL_CYCLE_ACCURATE \
1332 | ETM_CTRL_TRACE_MASK \
1335 /* only update ETM_CTRL register if tracemode changed */
1336 if ((etm
->control
& TRACEMODE_MASK
) != tracemode
)
1338 struct reg
*etm_ctrl_reg
;
1340 etm_ctrl_reg
= etm_reg_lookup(etm
, ETM_CTRL
);
1344 etm
->control
&= ~TRACEMODE_MASK
;
1345 etm
->control
|= tracemode
& TRACEMODE_MASK
;
1347 buf_set_u32(etm_ctrl_reg
->value
, 0, 32, etm
->control
);
1348 etm_store_reg(etm_ctrl_reg
);
1350 /* invalidate old trace data */
1351 etm
->capture_status
= TRACE_IDLE
;
1352 if (etm
->trace_depth
> 0)
1354 free(etm
->trace_data
);
1355 etm
->trace_data
= NULL
;
1357 etm
->trace_depth
= 0;
1360 #undef TRACEMODE_MASK
1365 COMMAND_HANDLER(handle_etm_config_command
)
1367 struct target
*target
;
1369 uint32_t portmode
= 0x0;
1370 struct etm_context
*etm_ctx
;
1374 return ERROR_COMMAND_SYNTAX_ERROR
;
1376 target
= get_target(CMD_ARGV
[0]);
1379 LOG_ERROR("target '%s' not defined", CMD_ARGV
[0]);
1383 arm
= target_to_arm(target
);
1385 command_print(CMD_CTX
, "target '%s' is '%s'; not an ARM",
1386 target_name(target
),
1387 target_type_name(target
));
1391 /* FIXME for ETMv3.0 and above -- and we don't yet know what ETM
1392 * version we'll be using!! -- so we can't know how to validate
1393 * params yet. "etm config" should likely be *AFTER* hookup...
1395 * - Many more widths might be supported ... and we can easily
1396 * check whether our setting "took".
1398 * - The "clock" and "mode" bits are interpreted differently.
1399 * See ARM IHI 0014O table 2-17 for the old behavior, and
1400 * table 2-18 for the new. With ETB it's best to specify
1404 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[1], port_width
);
1407 /* before ETMv3.0 */
1409 portmode
|= ETM_PORT_4BIT
;
1412 portmode
|= ETM_PORT_8BIT
;
1415 portmode
|= ETM_PORT_16BIT
;
1417 /* ETMv3.0 and later*/
1419 portmode
|= ETM_PORT_24BIT
;
1422 portmode
|= ETM_PORT_32BIT
;
1425 portmode
|= ETM_PORT_48BIT
;
1428 portmode
|= ETM_PORT_64BIT
;
1431 portmode
|= ETM_PORT_1BIT
;
1434 portmode
|= ETM_PORT_2BIT
;
1437 command_print(CMD_CTX
,
1438 "unsupported ETM port width '%s'", CMD_ARGV
[1]);
1442 if (strcmp("normal", CMD_ARGV
[2]) == 0)
1444 portmode
|= ETM_PORT_NORMAL
;
1446 else if (strcmp("multiplexed", CMD_ARGV
[2]) == 0)
1448 portmode
|= ETM_PORT_MUXED
;
1450 else if (strcmp("demultiplexed", CMD_ARGV
[2]) == 0)
1452 portmode
|= ETM_PORT_DEMUXED
;
1456 command_print(CMD_CTX
, "unsupported ETM port mode '%s', must be 'normal', 'multiplexed' or 'demultiplexed'", CMD_ARGV
[2]);
1460 if (strcmp("half", CMD_ARGV
[3]) == 0)
1462 portmode
|= ETM_PORT_HALF_CLOCK
;
1464 else if (strcmp("full", CMD_ARGV
[3]) == 0)
1466 portmode
|= ETM_PORT_FULL_CLOCK
;
1470 command_print(CMD_CTX
, "unsupported ETM port clocking '%s', must be 'full' or 'half'", CMD_ARGV
[3]);
1474 etm_ctx
= calloc(1, sizeof(struct etm_context
));
1476 LOG_DEBUG("out of memory");
1480 for (i
= 0; etm_capture_drivers
[i
]; i
++)
1482 if (strcmp(CMD_ARGV
[4], etm_capture_drivers
[i
]->name
) == 0)
1484 int retval
= register_commands(CMD_CTX
, NULL
,
1485 etm_capture_drivers
[i
]->commands
);
1486 if (ERROR_OK
!= retval
)
1492 etm_ctx
->capture_driver
= etm_capture_drivers
[i
];
1498 if (!etm_capture_drivers
[i
])
1500 /* no supported capture driver found, don't register an ETM */
1502 LOG_ERROR("trace capture driver '%s' not found", CMD_ARGV
[4]);
1506 etm_ctx
->target
= target
;
1507 etm_ctx
->trace_data
= NULL
;
1508 etm_ctx
->control
= portmode
;
1509 etm_ctx
->core_state
= ARM_STATE_ARM
;
1513 return etm_register_user_commands(CMD_CTX
);
1516 COMMAND_HANDLER(handle_etm_info_command
)
1518 struct target
*target
;
1520 struct etm_context
*etm
;
1521 struct reg
*etm_sys_config_reg
;
1525 target
= get_current_target(CMD_CTX
);
1526 arm
= target_to_arm(target
);
1529 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1536 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1540 command_print(CMD_CTX
, "ETM v%d.%d",
1541 etm
->bcd_vers
>> 4, etm
->bcd_vers
& 0xf);
1542 command_print(CMD_CTX
, "pairs of address comparators: %i",
1543 (int) (etm
->config
>> 0) & 0x0f);
1544 command_print(CMD_CTX
, "data comparators: %i",
1545 (int) (etm
->config
>> 4) & 0x0f);
1546 command_print(CMD_CTX
, "memory map decoders: %i",
1547 (int) (etm
->config
>> 8) & 0x1f);
1548 command_print(CMD_CTX
, "number of counters: %i",
1549 (int) (etm
->config
>> 13) & 0x07);
1550 command_print(CMD_CTX
, "sequencer %spresent",
1551 (int) (etm
->config
& (1 << 16)) ? "" : "not ");
1552 command_print(CMD_CTX
, "number of ext. inputs: %i",
1553 (int) (etm
->config
>> 17) & 0x07);
1554 command_print(CMD_CTX
, "number of ext. outputs: %i",
1555 (int) (etm
->config
>> 20) & 0x07);
1556 command_print(CMD_CTX
, "FIFO full %spresent",
1557 (int) (etm
->config
& (1 << 23)) ? "" : "not ");
1558 if (etm
->bcd_vers
< 0x20)
1559 command_print(CMD_CTX
, "protocol version: %i",
1560 (int) (etm
->config
>> 28) & 0x07);
1562 command_print(CMD_CTX
,
1563 "coprocessor and memory access %ssupported",
1564 (etm
->config
& (1 << 26)) ? "" : "not ");
1565 command_print(CMD_CTX
, "trace start/stop %spresent",
1566 (etm
->config
& (1 << 26)) ? "" : "not ");
1567 command_print(CMD_CTX
, "number of context comparators: %i",
1568 (int) (etm
->config
>> 24) & 0x03);
1571 /* SYS_CONFIG isn't present before ETMv1.2 */
1572 etm_sys_config_reg
= etm_reg_lookup(etm
, ETM_SYS_CONFIG
);
1573 if (!etm_sys_config_reg
)
1576 etm_get_reg(etm_sys_config_reg
);
1577 config
= buf_get_u32(etm_sys_config_reg
->value
, 0, 32);
1579 LOG_DEBUG("ETM SYS CONFIG %08x", (unsigned) config
);
1581 max_port_size
= config
& 0x7;
1582 if (etm
->bcd_vers
>= 0x30)
1583 max_port_size
|= (config
>> 6) & 0x08;
1584 switch (max_port_size
)
1586 /* before ETMv3.0 */
1596 /* ETMv3.0 and later*/
1616 LOG_ERROR("Illegal max_port_size");
1619 command_print(CMD_CTX
, "max. port size: %i", max_port_size
);
1621 if (etm
->bcd_vers
< 0x30) {
1622 command_print(CMD_CTX
, "half-rate clocking %ssupported",
1623 (config
& (1 << 3)) ? "" : "not ");
1624 command_print(CMD_CTX
, "full-rate clocking %ssupported",
1625 (config
& (1 << 4)) ? "" : "not ");
1626 command_print(CMD_CTX
, "normal trace format %ssupported",
1627 (config
& (1 << 5)) ? "" : "not ");
1628 command_print(CMD_CTX
, "multiplex trace format %ssupported",
1629 (config
& (1 << 6)) ? "" : "not ");
1630 command_print(CMD_CTX
, "demultiplex trace format %ssupported",
1631 (config
& (1 << 7)) ? "" : "not ");
1633 /* REVISIT show which size and format are selected ... */
1634 command_print(CMD_CTX
, "current port size %ssupported",
1635 (config
& (1 << 10)) ? "" : "not ");
1636 command_print(CMD_CTX
, "current trace format %ssupported",
1637 (config
& (1 << 11)) ? "" : "not ");
1639 if (etm
->bcd_vers
>= 0x21)
1640 command_print(CMD_CTX
, "fetch comparisons %ssupported",
1641 (config
& (1 << 17)) ? "not " : "");
1642 command_print(CMD_CTX
, "FIFO full %ssupported",
1643 (config
& (1 << 8)) ? "" : "not ");
1648 COMMAND_HANDLER(handle_etm_status_command
)
1650 struct target
*target
;
1652 struct etm_context
*etm
;
1653 trace_status_t trace_status
;
1655 target
= get_current_target(CMD_CTX
);
1656 arm
= target_to_arm(target
);
1659 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1666 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1671 if (etm
->bcd_vers
>= 0x11) {
1674 reg
= etm_reg_lookup(etm
, ETM_STATUS
);
1677 if (etm_get_reg(reg
) == ERROR_OK
) {
1678 unsigned s
= buf_get_u32(reg
->value
, 0, reg
->size
);
1680 command_print(CMD_CTX
, "etm: %s%s%s%s",
1681 /* bit(1) == progbit */
1682 (etm
->bcd_vers
>= 0x12)
1684 ? "disabled" : "enabled")
1686 ((s
& (1 << 3)) && etm
->bcd_vers
>= 0x31)
1687 ? " triggered" : "",
1688 ((s
& (1 << 2)) && etm
->bcd_vers
>= 0x12)
1689 ? " start/stop" : "",
1690 ((s
& (1 << 0)) && etm
->bcd_vers
>= 0x11)
1691 ? " untraced-overflow" : "");
1692 } /* else ignore and try showing trace port status */
1695 /* Trace Port Driver status */
1696 trace_status
= etm
->capture_driver
->status(etm
);
1697 if (trace_status
== TRACE_IDLE
)
1699 command_print(CMD_CTX
, "%s: idle", etm
->capture_driver
->name
);
1703 static char *completed
= " completed";
1704 static char *running
= " is running";
1705 static char *overflowed
= ", overflowed";
1706 static char *triggered
= ", triggered";
1708 command_print(CMD_CTX
, "%s: trace collection%s%s%s",
1709 etm
->capture_driver
->name
,
1710 (trace_status
& TRACE_RUNNING
) ? running
: completed
,
1711 (trace_status
& TRACE_OVERFLOWED
) ? overflowed
: "",
1712 (trace_status
& TRACE_TRIGGERED
) ? triggered
: "");
1714 if (etm
->trace_depth
> 0)
1716 command_print(CMD_CTX
, "%i frames of trace data read",
1717 (int)(etm
->trace_depth
));
1724 COMMAND_HANDLER(handle_etm_image_command
)
1726 struct target
*target
;
1728 struct etm_context
*etm_ctx
;
1732 command_print(CMD_CTX
, "usage: etm image <file> [base address] [type]");
1736 target
= get_current_target(CMD_CTX
);
1737 arm
= target_to_arm(target
);
1740 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1747 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1753 image_close(etm_ctx
->image
);
1754 free(etm_ctx
->image
);
1755 command_print(CMD_CTX
, "previously loaded image found and closed");
1758 etm_ctx
->image
= malloc(sizeof(struct image
));
1759 etm_ctx
->image
->base_address_set
= 0;
1760 etm_ctx
->image
->start_address_set
= 0;
1762 /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1765 etm_ctx
->image
->base_address_set
= 1;
1766 COMMAND_PARSE_NUMBER(llong
, CMD_ARGV
[1], etm_ctx
->image
->base_address
);
1770 etm_ctx
->image
->base_address_set
= 0;
1773 if (image_open(etm_ctx
->image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
) != ERROR_OK
)
1775 free(etm_ctx
->image
);
1776 etm_ctx
->image
= NULL
;
1783 COMMAND_HANDLER(handle_etm_dump_command
)
1786 struct target
*target
;
1788 struct etm_context
*etm_ctx
;
1793 command_print(CMD_CTX
, "usage: etm dump <file>");
1797 target
= get_current_target(CMD_CTX
);
1798 arm
= target_to_arm(target
);
1801 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1808 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1812 if (etm_ctx
->capture_driver
->status
== TRACE_IDLE
)
1814 command_print(CMD_CTX
, "trace capture wasn't enabled, no trace data captured");
1818 if (etm_ctx
->capture_driver
->status(etm_ctx
) & TRACE_RUNNING
)
1820 /* TODO: if on-the-fly capture is to be supported, this needs to be changed */
1821 command_print(CMD_CTX
, "trace capture not completed");
1825 /* read the trace data if it wasn't read already */
1826 if (etm_ctx
->trace_depth
== 0)
1827 etm_ctx
->capture_driver
->read_trace(etm_ctx
);
1829 if (fileio_open(&file
, CMD_ARGV
[0], FILEIO_WRITE
, FILEIO_BINARY
) != ERROR_OK
)
1834 fileio_write_u32(&file
, etm_ctx
->capture_status
);
1835 fileio_write_u32(&file
, etm_ctx
->control
);
1836 fileio_write_u32(&file
, etm_ctx
->trace_depth
);
1838 for (i
= 0; i
< etm_ctx
->trace_depth
; i
++)
1840 fileio_write_u32(&file
, etm_ctx
->trace_data
[i
].pipestat
);
1841 fileio_write_u32(&file
, etm_ctx
->trace_data
[i
].packet
);
1842 fileio_write_u32(&file
, etm_ctx
->trace_data
[i
].flags
);
1845 fileio_close(&file
);
1850 COMMAND_HANDLER(handle_etm_load_command
)
1853 struct target
*target
;
1855 struct etm_context
*etm_ctx
;
1860 command_print(CMD_CTX
, "usage: etm load <file>");
1864 target
= get_current_target(CMD_CTX
);
1865 arm
= target_to_arm(target
);
1868 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1875 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1879 if (etm_ctx
->capture_driver
->status(etm_ctx
) & TRACE_RUNNING
)
1881 command_print(CMD_CTX
, "trace capture running, stop first");
1885 if (fileio_open(&file
, CMD_ARGV
[0], FILEIO_READ
, FILEIO_BINARY
) != ERROR_OK
)
1892 command_print(CMD_CTX
, "size isn't a multiple of 4, no valid trace data");
1893 fileio_close(&file
);
1897 if (etm_ctx
->trace_depth
> 0)
1899 free(etm_ctx
->trace_data
);
1900 etm_ctx
->trace_data
= NULL
;
1905 fileio_read_u32(&file
, &tmp
); etm_ctx
->capture_status
= tmp
;
1906 fileio_read_u32(&file
, &tmp
); etm_ctx
->control
= tmp
;
1907 fileio_read_u32(&file
, &etm_ctx
->trace_depth
);
1909 etm_ctx
->trace_data
= malloc(sizeof(struct etmv1_trace_data
) * etm_ctx
->trace_depth
);
1910 if (etm_ctx
->trace_data
== NULL
)
1912 command_print(CMD_CTX
, "not enough memory to perform operation");
1913 fileio_close(&file
);
1917 for (i
= 0; i
< etm_ctx
->trace_depth
; i
++)
1919 uint32_t pipestat
, packet
, flags
;
1920 fileio_read_u32(&file
, &pipestat
);
1921 fileio_read_u32(&file
, &packet
);
1922 fileio_read_u32(&file
, &flags
);
1923 etm_ctx
->trace_data
[i
].pipestat
= pipestat
& 0xff;
1924 etm_ctx
->trace_data
[i
].packet
= packet
& 0xffff;
1925 etm_ctx
->trace_data
[i
].flags
= flags
;
1928 fileio_close(&file
);
1933 COMMAND_HANDLER(handle_etm_start_command
)
1935 struct target
*target
;
1937 struct etm_context
*etm_ctx
;
1938 struct reg
*etm_ctrl_reg
;
1940 target
= get_current_target(CMD_CTX
);
1941 arm
= target_to_arm(target
);
1944 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1951 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
1955 /* invalidate old tracing data */
1956 etm_ctx
->capture_status
= TRACE_IDLE
;
1957 if (etm_ctx
->trace_depth
> 0)
1959 free(etm_ctx
->trace_data
);
1960 etm_ctx
->trace_data
= NULL
;
1962 etm_ctx
->trace_depth
= 0;
1964 etm_ctrl_reg
= etm_reg_lookup(etm_ctx
, ETM_CTRL
);
1968 etm_get_reg(etm_ctrl_reg
);
1970 /* Clear programming bit (10), set port selection bit (11) */
1971 buf_set_u32(etm_ctrl_reg
->value
, 10, 2, 0x2);
1973 etm_store_reg(etm_ctrl_reg
);
1974 jtag_execute_queue();
1976 etm_ctx
->capture_driver
->start_capture(etm_ctx
);
1981 COMMAND_HANDLER(handle_etm_stop_command
)
1983 struct target
*target
;
1985 struct etm_context
*etm_ctx
;
1986 struct reg
*etm_ctrl_reg
;
1988 target
= get_current_target(CMD_CTX
);
1989 arm
= target_to_arm(target
);
1992 command_print(CMD_CTX
, "ETM: current target isn't an ARM");
1999 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
2003 etm_ctrl_reg
= etm_reg_lookup(etm_ctx
, ETM_CTRL
);
2007 etm_get_reg(etm_ctrl_reg
);
2009 /* Set programming bit (10), clear port selection bit (11) */
2010 buf_set_u32(etm_ctrl_reg
->value
, 10, 2, 0x1);
2012 etm_store_reg(etm_ctrl_reg
);
2013 jtag_execute_queue();
2015 etm_ctx
->capture_driver
->stop_capture(etm_ctx
);
2020 COMMAND_HANDLER(handle_etm_trigger_debug_command
)
2022 struct target
*target
;
2024 struct etm_context
*etm
;
2026 target
= get_current_target(CMD_CTX
);
2027 arm
= target_to_arm(target
);
2030 command_print(CMD_CTX
, "ETM: %s isn't an ARM",
2031 target_name(target
));
2038 command_print(CMD_CTX
, "ETM: no ETM configured for %s",
2039 target_name(target
));
2043 if (CMD_ARGC
== 1) {
2044 struct reg
*etm_ctrl_reg
;
2047 etm_ctrl_reg
= etm_reg_lookup(etm
, ETM_CTRL
);
2051 COMMAND_PARSE_ENABLE(CMD_ARGV
[0], dbgrq
);
2053 etm
->control
|= ETM_CTRL_DBGRQ
;
2055 etm
->control
&= ~ETM_CTRL_DBGRQ
;
2057 /* etm->control will be written to hardware
2058 * the next time an "etm start" is issued.
2060 buf_set_u32(etm_ctrl_reg
->value
, 0, 32, etm
->control
);
2063 command_print(CMD_CTX
, "ETM: %s debug halt",
2064 (etm
->control
& ETM_CTRL_DBGRQ
)
2066 : "does not trigger");
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 static const struct command_registration etm_config_command_handlers
[] = {
2115 /* NOTE: with ADIv5, ETMs are accessed by DAP operations,
2116 * possibly over SWD, not JTAG scanchain 6 of 'target'.
2118 * Also, these parameters don't match ETM v3+ modules...
2121 .handler
= handle_etm_config_command
,
2122 .mode
= COMMAND_CONFIG
,
2123 .help
= "Set up ETM output port.",
2124 .usage
= "target port_width port_mode clocking capture_driver",
2126 COMMAND_REGISTRATION_DONE
2128 const struct command_registration etm_command_handlers
[] = {
2131 .mode
= COMMAND_ANY
,
2132 .help
= "Emebdded Trace Macrocell command group",
2133 .chain
= etm_config_command_handlers
,
2135 COMMAND_REGISTRATION_DONE
2138 static const struct command_registration etm_exec_command_handlers
[] = {
2140 .name
= "tracemode",
2141 .handler
= handle_etm_tracemode_command
,
2142 .mode
= COMMAND_EXEC
,
2143 .help
= "configure/display trace mode",
2144 .usage
= "('none'|'data'|'address'|'all') "
2146 "['enable'|'disable'] "
2147 "['enable'|'disable']",
2151 .handler
= handle_etm_info_command
,
2152 .mode
= COMMAND_EXEC
,
2153 .help
= "display info about the current target's ETM",
2157 .handler
= handle_etm_status_command
,
2158 .mode
= COMMAND_EXEC
,
2159 .help
= "display current target's ETM status",
2163 .handler
= handle_etm_start_command
,
2164 .mode
= COMMAND_EXEC
,
2165 .help
= "start ETM trace collection",
2169 .handler
= handle_etm_stop_command
,
2170 .mode
= COMMAND_EXEC
,
2171 .help
= "stop ETM trace collection",
2174 .name
= "trigger_debug",
2175 .handler
= handle_etm_trigger_debug_command
,
2176 .mode
= COMMAND_EXEC
,
2177 .help
= "enable/disable debug entry on trigger",
2178 .usage
= "['enable'|'disable']",
2182 .handler
= handle_etm_analyze_command
,
2183 .mode
= COMMAND_EXEC
,
2184 .help
= "analyze collected ETM trace",
2188 .handler
= handle_etm_image_command
,
2189 .mode
= COMMAND_EXEC
,
2190 .help
= "load image from file with optional offset",
2191 .usage
= "filename [offset]",
2195 .handler
= handle_etm_dump_command
,
2196 .mode
= COMMAND_EXEC
,
2197 .help
= "dump captured trace data to file",
2198 .usage
= "filename",
2202 .handler
= handle_etm_load_command
,
2203 .mode
= COMMAND_EXEC
,
2204 .help
= "load trace data for analysis <file>",
2206 COMMAND_REGISTRATION_DONE
2209 static int etm_register_user_commands(struct command_context
*cmd_ctx
)
2211 struct command
*etm_cmd
= command_find_in_context(cmd_ctx
, "etm");
2212 return register_commands(cmd_ctx
, etm_cmd
, etm_exec_command_handlers
);
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)