ARM: start generalized base type
[openocd/ztw.git] / src / target / etm.c
blob795e0564577eced533b2712de771dabfc35b3edd
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
24 #include "etm.h"
25 #include "etb.h"
26 #include "image.h"
27 #include "arm7_9_common.h"
28 #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])))
55 enum {
56 RO, /* read/only */
57 WO, /* write/only */
58 RW, /* read/write */
61 struct etm_reg_info {
62 uint8_t addr;
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 */
66 char *name;
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 /* basic registers that are always there given the right ETM version */
77 static const struct etm_reg_info etm_core[] = {
78 /* NOTE: we "know" ETM_CONFIG is listed first */
79 { ETM_CONFIG, 32, RO, 0x10, "ETM_config", },
81 /* ETM Trace Registers */
82 { ETM_CTRL, 32, RW, 0x10, "ETM_ctrl", },
83 { ETM_TRIG_EVENT, 17, WO, 0x10, "ETM_trig_event", },
84 { ETM_ASIC_CTRL, 8, WO, 0x10, "ETM_asic_ctrl", },
85 { ETM_STATUS, 3, RO, 0x11, "ETM_status", },
86 { ETM_SYS_CONFIG, 9, RO, 0x12, "ETM_sys_config", },
88 /* TraceEnable configuration */
89 { ETM_TRACE_RESOURCE_CTRL, 32, WO, 0x12, "ETM_trace_resource_ctrl", },
90 { ETM_TRACE_EN_CTRL2, 16, WO, 0x12, "ETM_trace_en_ctrl2", },
91 { ETM_TRACE_EN_EVENT, 17, WO, 0x10, "ETM_trace_en_event", },
92 { ETM_TRACE_EN_CTRL1, 26, WO, 0x10, "ETM_trace_en_ctrl1", },
94 /* ViewData configuration (data trace) */
95 { ETM_VIEWDATA_EVENT, 17, WO, 0x10, "ETM_viewdata_event", },
96 { ETM_VIEWDATA_CTRL1, 32, WO, 0x10, "ETM_viewdata_ctrl1", },
97 { ETM_VIEWDATA_CTRL2, 32, WO, 0x10, "ETM_viewdata_ctrl2", },
98 { ETM_VIEWDATA_CTRL3, 17, WO, 0x10, "ETM_viewdata_ctrl3", },
100 /* REVISIT exclude VIEWDATA_CTRL2 when it's not there */
102 { 0x78, 12, WO, 0x20, "ETM_sync_freq", },
103 { 0x79, 32, RO, 0x20, "ETM_id", },
106 static const struct etm_reg_info etm_fifofull[] = {
107 /* FIFOFULL configuration */
108 { ETM_FIFOFULL_REGION, 25, WO, 0x10, "ETM_fifofull_region", },
109 { ETM_FIFOFULL_LEVEL, 8, WO, 0x10, "ETM_fifofull_level", },
112 static const struct etm_reg_info etm_addr_comp[] = {
113 /* Address comparator register pairs */
114 #define ADDR_COMPARATOR(i) \
115 { ETM_ADDR_COMPARATOR_VALUE + (i) - 1, 32, WO, 0x10, \
116 "ETM_addr_" #i "_comparator_value", }, \
117 { ETM_ADDR_ACCESS_TYPE + (i) - 1, 7, WO, 0x10, \
118 "ETM_addr_" #i "_access_type", }
119 ADDR_COMPARATOR(1),
120 ADDR_COMPARATOR(2),
121 ADDR_COMPARATOR(3),
122 ADDR_COMPARATOR(4),
123 ADDR_COMPARATOR(5),
124 ADDR_COMPARATOR(6),
125 ADDR_COMPARATOR(7),
126 ADDR_COMPARATOR(8),
128 ADDR_COMPARATOR(9),
129 ADDR_COMPARATOR(10),
130 ADDR_COMPARATOR(11),
131 ADDR_COMPARATOR(12),
132 ADDR_COMPARATOR(13),
133 ADDR_COMPARATOR(14),
134 ADDR_COMPARATOR(15),
135 ADDR_COMPARATOR(16),
136 #undef ADDR_COMPARATOR
139 static const struct etm_reg_info etm_data_comp[] = {
140 /* Data Value Comparators (NOTE: odd addresses are reserved) */
141 #define DATA_COMPARATOR(i) \
142 { ETM_DATA_COMPARATOR_VALUE + 2*(i) - 1, 32, WO, 0x10, \
143 "ETM_data_" #i "_comparator_value", }, \
144 { ETM_DATA_COMPARATOR_MASK + 2*(i) - 1, 32, WO, 0x10, \
145 "ETM_data_" #i "_comparator_mask", }
146 DATA_COMPARATOR(1),
147 DATA_COMPARATOR(2),
148 DATA_COMPARATOR(3),
149 DATA_COMPARATOR(4),
150 DATA_COMPARATOR(5),
151 DATA_COMPARATOR(6),
152 DATA_COMPARATOR(7),
153 DATA_COMPARATOR(8),
154 #undef DATA_COMPARATOR
157 static const struct etm_reg_info etm_counters[] = {
158 #define ETM_COUNTER(i) \
159 { ETM_COUNTER_RELOAD_VALUE + (i) - 1, 16, WO, 0x10, \
160 "ETM_counter_" #i "_reload_value", }, \
161 { ETM_COUNTER_ENABLE + (i) - 1, 18, WO, 0x10, \
162 "ETM_counter_" #i "_enable", }, \
163 { ETM_COUNTER_RELOAD_EVENT + (i) - 1, 17, WO, 0x10, \
164 "ETM_counter_" #i "_reload_event", }, \
165 { ETM_COUNTER_VALUE + (i) - 1, 16, RO, 0x10, \
166 "ETM_counter_" #i "_value", }
167 ETM_COUNTER(1),
168 ETM_COUNTER(2),
169 ETM_COUNTER(3),
170 ETM_COUNTER(4),
171 #undef ETM_COUNTER
174 static const struct etm_reg_info etm_sequencer[] = {
175 #define ETM_SEQ(i) \
176 { ETM_SEQUENCER_EVENT + (i), 17, WO, 0x10, \
177 "ETM_sequencer_event" #i, }
178 ETM_SEQ(0), /* 1->2 */
179 ETM_SEQ(1), /* 2->1 */
180 ETM_SEQ(2), /* 2->3 */
181 ETM_SEQ(3), /* 3->1 */
182 ETM_SEQ(4), /* 3->2 */
183 ETM_SEQ(5), /* 1->3 */
184 #undef ETM_SEQ
185 /* 0x66 reserved */
186 { ETM_SEQUENCER_STATE, 2, RO, 0x10, "ETM_sequencer_state", },
189 static const struct etm_reg_info etm_outputs[] = {
190 #define ETM_OUTPUT(i) \
191 { ETM_EXTERNAL_OUTPUT + (i) - 1, 17, WO, 0x10, \
192 "ETM_external_output" #i, }
194 ETM_OUTPUT(1),
195 ETM_OUTPUT(2),
196 ETM_OUTPUT(3),
197 ETM_OUTPUT(4),
198 #undef ETM_OUTPUT
201 #if 0
202 /* registers from 0x6c..0x7f were added after ETMv1.3 */
204 /* Context ID Comparators */
205 { 0x6c, 32, RO, 0x20, "ETM_contextid_comparator_value1", }
206 { 0x6d, 32, RO, 0x20, "ETM_contextid_comparator_value2", }
207 { 0x6e, 32, RO, 0x20, "ETM_contextid_comparator_value3", }
208 { 0x6f, 32, RO, 0x20, "ETM_contextid_comparator_mask", }
209 #endif
211 static int etm_reg_arch_type = -1;
213 static int etm_get_reg(reg_t *reg);
214 static int etm_read_reg_w_check(reg_t *reg,
215 uint8_t* check_value, uint8_t* check_mask);
216 static int etm_register_user_commands(struct command_context_s *cmd_ctx);
217 static int etm_set_reg_w_exec(reg_t *reg, uint8_t *buf);
218 static int etm_write_reg(reg_t *reg, uint32_t value);
220 static command_t *etm_cmd;
223 /* Look up register by ID ... most ETM instances only
224 * support a subset of the possible registers.
226 static reg_t *etm_reg_lookup(etm_context_t *etm_ctx, unsigned id)
228 reg_cache_t *cache = etm_ctx->reg_cache;
229 int i;
231 for (i = 0; i < cache->num_regs; i++) {
232 struct etm_reg_s *reg = cache->reg_list[i].arch_info;
234 if (reg->reg_info->addr == id)
235 return &cache->reg_list[i];
238 /* caller asking for nonexistent register is a bug! */
239 /* REVISIT say which of the N targets was involved */
240 LOG_ERROR("ETM: register 0x%02x not available", id);
241 return NULL;
244 static void etm_reg_add(unsigned bcd_vers, arm_jtag_t *jtag_info,
245 reg_cache_t *cache, etm_reg_t *ereg,
246 const struct etm_reg_info *r, unsigned nreg)
248 reg_t *reg = cache->reg_list;
250 reg += cache->num_regs;
251 ereg += cache->num_regs;
253 /* add up to "nreg" registers from "r", if supported by this
254 * version of the ETM, to the specified cache.
256 for (; nreg--; r++) {
258 /* this ETM may be too old to have some registers */
259 if (r->bcd_vers > bcd_vers)
260 continue;
262 reg->name = r->name;
263 reg->size = r->size;
264 reg->value = &ereg->value;
265 reg->arch_info = ereg;
266 reg->arch_type = etm_reg_arch_type;
267 reg++;
268 cache->num_regs++;
270 ereg->reg_info = r;
271 ereg->jtag_info = jtag_info;
272 ereg++;
276 reg_cache_t *etm_build_reg_cache(target_t *target,
277 arm_jtag_t *jtag_info, etm_context_t *etm_ctx)
279 reg_cache_t *reg_cache = malloc(sizeof(reg_cache_t));
280 reg_t *reg_list = NULL;
281 etm_reg_t *arch_info = NULL;
282 unsigned bcd_vers, config;
284 /* register a register arch-type for etm registers only once */
285 if (etm_reg_arch_type == -1)
286 etm_reg_arch_type = register_reg_arch_type(etm_get_reg,
287 etm_set_reg_w_exec);
289 /* the actual registers are kept in two arrays */
290 reg_list = calloc(128, sizeof(reg_t));
291 arch_info = calloc(128, sizeof(etm_reg_t));
293 /* fill in values for the reg cache */
294 reg_cache->name = "etm registers";
295 reg_cache->next = NULL;
296 reg_cache->reg_list = reg_list;
297 reg_cache->num_regs = 0;
299 /* add ETM_CONFIG, then parse its values to see
300 * which other registers exist in this ETM
302 etm_reg_add(0x10, jtag_info, reg_cache, arch_info,
303 etm_core, 1);
305 etm_get_reg(reg_list);
306 etm_ctx->config = buf_get_u32((void *)&arch_info->value, 0, 32);
307 config = etm_ctx->config;
309 /* figure ETM version then add base registers */
310 if (config & (1 << 31)) {
311 bcd_vers = 0x20;
312 LOG_WARNING("ETMv2+ support is incomplete");
314 /* REVISIT read ID register, distinguish ETMv3.3 etc;
315 * don't presume trace start/stop support is present;
316 * and include any context ID comparator registers.
318 } else {
319 switch (config >> 28) {
320 case 7:
321 case 5:
322 case 3:
323 bcd_vers = 0x13;
324 break;
325 case 4:
326 case 2:
327 bcd_vers = 0x12;
328 break;
329 case 1:
330 bcd_vers = 0x11;
331 break;
332 case 0:
333 bcd_vers = 0x10;
334 break;
335 default:
336 LOG_WARNING("Bad ETMv1 protocol %d", config >> 28);
337 free(reg_cache);
338 free(reg_list);
339 free(arch_info);
340 return ERROR_OK;
343 etm_ctx->bcd_vers = bcd_vers;
344 LOG_INFO("ETM v%d.%d", bcd_vers >> 4, bcd_vers & 0xf);
346 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
347 etm_core + 1, ARRAY_SIZE(etm_core) - 1);
349 /* address and data comparators; counters; outputs */
350 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
351 etm_addr_comp, 4 * (0x0f & (config >> 0)));
352 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
353 etm_data_comp, 2 * (0x0f & (config >> 4)));
354 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
355 etm_counters, 4 * (0x07 & (config >> 13)));
356 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
357 etm_outputs, (0x07 & (config >> 20)));
359 /* FIFOFULL presence is optional
360 * REVISIT for ETMv1.2 and later, don't bother adding this
361 * unless ETM_SYS_CONFIG says it's also *supported* ...
363 if (config & (1 << 23))
364 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
365 etm_fifofull, ARRAY_SIZE(etm_fifofull));
367 /* sequencer is optional (for state-dependant triggering) */
368 if (config & (1 << 16))
369 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
370 etm_sequencer, ARRAY_SIZE(etm_sequencer));
372 /* REVISIT could realloc and likely save half the memory
373 * in the two chunks we allocated...
376 /* the ETM might have an ETB connected */
377 if (strcmp(etm_ctx->capture_driver->name, "etb") == 0)
379 etb_t *etb = etm_ctx->capture_driver_priv;
381 if (!etb)
383 LOG_ERROR("etb selected as etm capture driver, but no ETB configured");
384 free(reg_cache);
385 free(reg_list);
386 free(arch_info);
387 return ERROR_OK;
390 reg_cache->next = etb_build_reg_cache(etb);
392 etb->reg_cache = reg_cache->next;
396 return reg_cache;
399 static int etm_read_reg(reg_t *reg)
401 return etm_read_reg_w_check(reg, NULL, NULL);
404 static int etm_store_reg(reg_t *reg)
406 return etm_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
409 int etm_setup(target_t *target)
411 int retval;
412 uint32_t etm_ctrl_value;
413 struct arm7_9_common_s *arm7_9 = target_to_arm7_9(target);
414 etm_context_t *etm_ctx = arm7_9->etm_ctx;
415 reg_t *etm_ctrl_reg;
417 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
418 if (!etm_ctrl_reg)
419 return ERROR_OK;
421 /* initialize some ETM control register settings */
422 etm_get_reg(etm_ctrl_reg);
423 etm_ctrl_value = buf_get_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size);
425 /* clear the ETM powerdown bit (0) */
426 etm_ctrl_value &= ~0x1;
428 /* configure port width (6:4), mode (17:16) and clocking (13) */
429 etm_ctrl_value = (etm_ctrl_value &
430 ~ETM_PORT_WIDTH_MASK & ~ETM_PORT_MODE_MASK & ~ETM_PORT_CLOCK_MASK)
431 | etm_ctx->portmode;
433 buf_set_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size, etm_ctrl_value);
434 etm_store_reg(etm_ctrl_reg);
436 if ((retval = jtag_execute_queue()) != ERROR_OK)
437 return retval;
439 if ((retval = etm_ctx->capture_driver->init(etm_ctx)) != ERROR_OK)
441 LOG_ERROR("ETM capture driver initialization failed");
442 return retval;
444 return ERROR_OK;
447 static int etm_get_reg(reg_t *reg)
449 int retval;
451 if ((retval = etm_read_reg(reg)) != ERROR_OK)
453 LOG_ERROR("BUG: error scheduling etm register read");
454 return retval;
457 if ((retval = jtag_execute_queue()) != ERROR_OK)
459 LOG_ERROR("register read failed");
460 return retval;
463 return ERROR_OK;
466 static int etm_read_reg_w_check(reg_t *reg,
467 uint8_t* check_value, uint8_t* check_mask)
469 etm_reg_t *etm_reg = reg->arch_info;
470 const struct etm_reg_info *r = etm_reg->reg_info;
471 uint8_t reg_addr = r->addr & 0x7f;
472 scan_field_t fields[3];
474 if (etm_reg->reg_info->mode == WO) {
475 LOG_ERROR("BUG: can't read write-only register %s", r->name);
476 return ERROR_INVALID_ARGUMENTS;
479 LOG_DEBUG("%s (%u)", r->name, reg_addr);
481 jtag_set_end_state(TAP_IDLE);
482 arm_jtag_scann(etm_reg->jtag_info, 0x6);
483 arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
485 fields[0].tap = etm_reg->jtag_info->tap;
486 fields[0].num_bits = 32;
487 fields[0].out_value = reg->value;
488 fields[0].in_value = NULL;
489 fields[0].check_value = NULL;
490 fields[0].check_mask = NULL;
492 fields[1].tap = etm_reg->jtag_info->tap;
493 fields[1].num_bits = 7;
494 fields[1].out_value = malloc(1);
495 buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
496 fields[1].in_value = NULL;
497 fields[1].check_value = NULL;
498 fields[1].check_mask = NULL;
500 fields[2].tap = etm_reg->jtag_info->tap;
501 fields[2].num_bits = 1;
502 fields[2].out_value = malloc(1);
503 buf_set_u32(fields[2].out_value, 0, 1, 0);
504 fields[2].in_value = NULL;
505 fields[2].check_value = NULL;
506 fields[2].check_mask = NULL;
508 jtag_add_dr_scan(3, fields, jtag_get_end_state());
510 fields[0].in_value = reg->value;
511 fields[0].check_value = check_value;
512 fields[0].check_mask = check_mask;
514 jtag_add_dr_scan_check(3, fields, jtag_get_end_state());
516 free(fields[1].out_value);
517 free(fields[2].out_value);
519 return ERROR_OK;
522 static int etm_set_reg(reg_t *reg, uint32_t value)
524 int retval;
526 if ((retval = etm_write_reg(reg, value)) != ERROR_OK)
528 LOG_ERROR("BUG: error scheduling etm register write");
529 return retval;
532 buf_set_u32(reg->value, 0, reg->size, value);
533 reg->valid = 1;
534 reg->dirty = 0;
536 return ERROR_OK;
539 static int etm_set_reg_w_exec(reg_t *reg, uint8_t *buf)
541 int retval;
543 etm_set_reg(reg, buf_get_u32(buf, 0, reg->size));
545 if ((retval = jtag_execute_queue()) != ERROR_OK)
547 LOG_ERROR("register write failed");
548 return retval;
550 return ERROR_OK;
553 static int etm_write_reg(reg_t *reg, uint32_t value)
555 etm_reg_t *etm_reg = reg->arch_info;
556 const struct etm_reg_info *r = etm_reg->reg_info;
557 uint8_t reg_addr = r->addr & 0x7f;
558 scan_field_t fields[3];
560 if (etm_reg->reg_info->mode == RO) {
561 LOG_ERROR("BUG: can't write read--only register %s", r->name);
562 return ERROR_INVALID_ARGUMENTS;
565 LOG_DEBUG("%s (%u): 0x%8.8" PRIx32 "", r->name, reg_addr, value);
567 jtag_set_end_state(TAP_IDLE);
568 arm_jtag_scann(etm_reg->jtag_info, 0x6);
569 arm_jtag_set_instr(etm_reg->jtag_info, etm_reg->jtag_info->intest_instr, NULL);
571 fields[0].tap = etm_reg->jtag_info->tap;
572 fields[0].num_bits = 32;
573 uint8_t tmp1[4];
574 fields[0].out_value = tmp1;
575 buf_set_u32(fields[0].out_value, 0, 32, value);
576 fields[0].in_value = NULL;
578 fields[1].tap = etm_reg->jtag_info->tap;
579 fields[1].num_bits = 7;
580 uint8_t tmp2;
581 fields[1].out_value = &tmp2;
582 buf_set_u32(fields[1].out_value, 0, 7, reg_addr);
583 fields[1].in_value = NULL;
585 fields[2].tap = etm_reg->jtag_info->tap;
586 fields[2].num_bits = 1;
587 uint8_t tmp3;
588 fields[2].out_value = &tmp3;
589 buf_set_u32(fields[2].out_value, 0, 1, 1);
590 fields[2].in_value = NULL;
592 jtag_add_dr_scan(3, fields, jtag_get_end_state());
594 return ERROR_OK;
598 /* ETM trace analysis functionality
601 extern etm_capture_driver_t etm_dummy_capture_driver;
602 #if BUILD_OOCD_TRACE == 1
603 extern etm_capture_driver_t oocd_trace_capture_driver;
604 #endif
606 static etm_capture_driver_t *etm_capture_drivers[] =
608 &etb_capture_driver,
609 &etm_dummy_capture_driver,
610 #if BUILD_OOCD_TRACE == 1
611 &oocd_trace_capture_driver,
612 #endif
613 NULL
616 static int etm_read_instruction(etm_context_t *ctx, arm_instruction_t *instruction)
618 int i;
619 int section = -1;
620 uint32_t size_read;
621 uint32_t opcode;
622 int retval;
624 if (!ctx->image)
625 return ERROR_TRACE_IMAGE_UNAVAILABLE;
627 /* search for the section the current instruction belongs to */
628 for (i = 0; i < ctx->image->num_sections; i++)
630 if ((ctx->image->sections[i].base_address <= ctx->current_pc) &&
631 (ctx->image->sections[i].base_address + ctx->image->sections[i].size > ctx->current_pc))
633 section = i;
634 break;
638 if (section == -1)
640 /* current instruction couldn't be found in the image */
641 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
644 if (ctx->core_state == ARMV4_5_STATE_ARM)
646 uint8_t buf[4];
647 if ((retval = image_read_section(ctx->image, section,
648 ctx->current_pc - ctx->image->sections[section].base_address,
649 4, buf, &size_read)) != ERROR_OK)
651 LOG_ERROR("error while reading instruction: %i", retval);
652 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
654 opcode = target_buffer_get_u32(ctx->target, buf);
655 arm_evaluate_opcode(opcode, ctx->current_pc, instruction);
657 else if (ctx->core_state == ARMV4_5_STATE_THUMB)
659 uint8_t buf[2];
660 if ((retval = image_read_section(ctx->image, section,
661 ctx->current_pc - ctx->image->sections[section].base_address,
662 2, buf, &size_read)) != ERROR_OK)
664 LOG_ERROR("error while reading instruction: %i", retval);
665 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
667 opcode = target_buffer_get_u16(ctx->target, buf);
668 thumb_evaluate_opcode(opcode, ctx->current_pc, instruction);
670 else if (ctx->core_state == ARMV4_5_STATE_JAZELLE)
672 LOG_ERROR("BUG: tracing of jazelle code not supported");
673 return ERROR_FAIL;
675 else
677 LOG_ERROR("BUG: unknown core state encountered");
678 return ERROR_FAIL;
681 return ERROR_OK;
684 static int etmv1_next_packet(etm_context_t *ctx, uint8_t *packet, int apo)
686 while (ctx->data_index < ctx->trace_depth)
688 /* if the caller specified an address packet offset, skip until the
689 * we reach the n-th cycle marked with tracesync */
690 if (apo > 0)
692 if (ctx->trace_data[ctx->data_index].flags & ETMV1_TRACESYNC_CYCLE)
693 apo--;
695 if (apo > 0)
697 ctx->data_index++;
698 ctx->data_half = 0;
700 continue;
703 /* no tracedata output during a TD cycle
704 * or in a trigger cycle */
705 if ((ctx->trace_data[ctx->data_index].pipestat == STAT_TD)
706 || (ctx->trace_data[ctx->data_index].flags & ETMV1_TRIGGER_CYCLE))
708 ctx->data_index++;
709 ctx->data_half = 0;
710 continue;
713 if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_16BIT)
715 if (ctx->data_half == 0)
717 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
718 ctx->data_half = 1;
720 else
722 *packet = (ctx->trace_data[ctx->data_index].packet & 0xff00) >> 8;
723 ctx->data_half = 0;
724 ctx->data_index++;
727 else if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_8BIT)
729 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
730 ctx->data_index++;
732 else
734 /* on a 4-bit port, a packet will be output during two consecutive cycles */
735 if (ctx->data_index > (ctx->trace_depth - 2))
736 return -1;
738 *packet = ctx->trace_data[ctx->data_index].packet & 0xf;
739 *packet |= (ctx->trace_data[ctx->data_index + 1].packet & 0xf) << 4;
740 ctx->data_index += 2;
743 return 0;
746 return -1;
749 static int etmv1_branch_address(etm_context_t *ctx)
751 int retval;
752 uint8_t packet;
753 int shift = 0;
754 int apo;
755 uint32_t i;
757 /* quit analysis if less than two cycles are left in the trace
758 * because we can't extract the APO */
759 if (ctx->data_index > (ctx->trace_depth - 2))
760 return -1;
762 /* a BE could be output during an APO cycle, skip the current
763 * and continue with the new one */
764 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x4)
765 return 1;
766 if (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x4)
767 return 2;
769 /* address packet offset encoded in the next two cycles' pipestat bits */
770 apo = ctx->trace_data[ctx->pipe_index + 1].pipestat & 0x3;
771 apo |= (ctx->trace_data[ctx->pipe_index + 2].pipestat & 0x3) << 2;
773 /* count number of tracesync cycles between current pipe_index and data_index
774 * i.e. the number of tracesyncs that data_index already passed by
775 * to subtract them from the APO */
776 for (i = ctx->pipe_index; i < ctx->data_index; i++)
778 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & ETMV1_TRACESYNC_CYCLE)
779 apo--;
782 /* extract up to four 7-bit packets */
783 do {
784 if ((retval = etmv1_next_packet(ctx, &packet, (shift == 0) ? apo + 1 : 0)) != 0)
785 return -1;
786 ctx->last_branch &= ~(0x7f << shift);
787 ctx->last_branch |= (packet & 0x7f) << shift;
788 shift += 7;
789 } while ((packet & 0x80) && (shift < 28));
791 /* one last packet holding 4 bits of the address, plus the branch reason code */
792 if ((shift == 28) && (packet & 0x80))
794 if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
795 return -1;
796 ctx->last_branch &= 0x0fffffff;
797 ctx->last_branch |= (packet & 0x0f) << 28;
798 ctx->last_branch_reason = (packet & 0x70) >> 4;
799 shift += 4;
801 else
803 ctx->last_branch_reason = 0;
806 if (shift == 32)
808 ctx->pc_ok = 1;
811 /* if a full address was output, we might have branched into Jazelle state */
812 if ((shift == 32) && (packet & 0x80))
814 ctx->core_state = ARMV4_5_STATE_JAZELLE;
816 else
818 /* if we didn't branch into Jazelle state, the current processor state is
819 * encoded in bit 0 of the branch target address */
820 if (ctx->last_branch & 0x1)
822 ctx->core_state = ARMV4_5_STATE_THUMB;
823 ctx->last_branch &= ~0x1;
825 else
827 ctx->core_state = ARMV4_5_STATE_ARM;
828 ctx->last_branch &= ~0x3;
832 return 0;
835 static int etmv1_data(etm_context_t *ctx, int size, uint32_t *data)
837 int j;
838 uint8_t buf[4];
839 int retval;
841 for (j = 0; j < size; j++)
843 if ((retval = etmv1_next_packet(ctx, &buf[j], 0)) != 0)
844 return -1;
847 if (size == 8)
849 LOG_ERROR("TODO: add support for 64-bit values");
850 return -1;
852 else if (size == 4)
853 *data = target_buffer_get_u32(ctx->target, buf);
854 else if (size == 2)
855 *data = target_buffer_get_u16(ctx->target, buf);
856 else if (size == 1)
857 *data = buf[0];
858 else
859 return -1;
861 return 0;
864 static int etmv1_analyze_trace(etm_context_t *ctx, struct command_context_s *cmd_ctx)
866 int retval;
867 arm_instruction_t instruction;
869 /* read the trace data if it wasn't read already */
870 if (ctx->trace_depth == 0)
871 ctx->capture_driver->read_trace(ctx);
873 /* start at the beginning of the captured trace */
874 ctx->pipe_index = 0;
875 ctx->data_index = 0;
876 ctx->data_half = 0;
878 /* neither the PC nor the data pointer are valid */
879 ctx->pc_ok = 0;
880 ctx->ptr_ok = 0;
882 while (ctx->pipe_index < ctx->trace_depth)
884 uint8_t pipestat = ctx->trace_data[ctx->pipe_index].pipestat;
885 uint32_t next_pc = ctx->current_pc;
886 uint32_t old_data_index = ctx->data_index;
887 uint32_t old_data_half = ctx->data_half;
888 uint32_t old_index = ctx->pipe_index;
889 uint32_t last_instruction = ctx->last_instruction;
890 uint32_t cycles = 0;
891 int current_pc_ok = ctx->pc_ok;
893 if (ctx->trace_data[ctx->pipe_index].flags & ETMV1_TRIGGER_CYCLE)
895 command_print(cmd_ctx, "--- trigger ---");
898 /* instructions execute in IE/D or BE/D cycles */
899 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
900 ctx->last_instruction = ctx->pipe_index;
902 /* if we don't have a valid pc skip until we reach an indirect branch */
903 if ((!ctx->pc_ok) && (pipestat != STAT_BE))
905 ctx->pipe_index++;
906 continue;
909 /* any indirect branch could have interrupted instruction flow
910 * - the branch reason code could indicate a trace discontinuity
911 * - a branch to the exception vectors indicates an exception
913 if ((pipestat == STAT_BE) || (pipestat == STAT_BD))
915 /* backup current data index, to be able to consume the branch address
916 * before examining data address and values
918 old_data_index = ctx->data_index;
919 old_data_half = ctx->data_half;
921 ctx->last_instruction = ctx->pipe_index;
923 if ((retval = etmv1_branch_address(ctx)) != 0)
925 /* negative return value from etmv1_branch_address means we ran out of packets,
926 * quit analysing the trace */
927 if (retval < 0)
928 break;
930 /* a positive return values means the current branch was abandoned,
931 * and a new branch was encountered in cycle ctx->pipe_index + retval;
933 LOG_WARNING("abandoned branch encountered, correctnes of analysis uncertain");
934 ctx->pipe_index += retval;
935 continue;
938 /* skip over APO cycles */
939 ctx->pipe_index += 2;
941 switch (ctx->last_branch_reason)
943 case 0x0: /* normal PC change */
944 next_pc = ctx->last_branch;
945 break;
946 case 0x1: /* tracing enabled */
947 command_print(cmd_ctx, "--- tracing enabled at 0x%8.8" PRIx32 " ---", ctx->last_branch);
948 ctx->current_pc = ctx->last_branch;
949 ctx->pipe_index++;
950 continue;
951 break;
952 case 0x2: /* trace restarted after FIFO overflow */
953 command_print(cmd_ctx, "--- trace restarted after FIFO overflow at 0x%8.8" PRIx32 " ---", ctx->last_branch);
954 ctx->current_pc = ctx->last_branch;
955 ctx->pipe_index++;
956 continue;
957 break;
958 case 0x3: /* exit from debug state */
959 command_print(cmd_ctx, "--- exit from debug state at 0x%8.8" PRIx32 " ---", ctx->last_branch);
960 ctx->current_pc = ctx->last_branch;
961 ctx->pipe_index++;
962 continue;
963 break;
964 case 0x4: /* periodic synchronization point */
965 next_pc = ctx->last_branch;
966 /* if we had no valid PC prior to this synchronization point,
967 * we have to move on with the next trace cycle
969 if (!current_pc_ok)
971 command_print(cmd_ctx, "--- periodic synchronization point at 0x%8.8" PRIx32 " ---", next_pc);
972 ctx->current_pc = next_pc;
973 ctx->pipe_index++;
974 continue;
976 break;
977 default: /* reserved */
978 LOG_ERROR("BUG: branch reason code 0x%" PRIx32 " is reserved", ctx->last_branch_reason);
979 return ERROR_FAIL;
982 /* if we got here the branch was a normal PC change
983 * (or a periodic synchronization point, which means the same for that matter)
984 * if we didn't accquire a complete PC continue with the next cycle
986 if (!ctx->pc_ok)
987 continue;
989 /* indirect branch to the exception vector means an exception occured */
990 if ((ctx->last_branch <= 0x20)
991 || ((ctx->last_branch >= 0xffff0000) && (ctx->last_branch <= 0xffff0020)))
993 if ((ctx->last_branch & 0xff) == 0x10)
995 command_print(cmd_ctx, "data abort");
997 else
999 command_print(cmd_ctx, "exception vector 0x%2.2" PRIx32 "", ctx->last_branch);
1000 ctx->current_pc = ctx->last_branch;
1001 ctx->pipe_index++;
1002 continue;
1007 /* an instruction was executed (or not, depending on the condition flags)
1008 * retrieve it from the image for displaying */
1009 if (ctx->pc_ok && (pipestat != STAT_WT) && (pipestat != STAT_TD) &&
1010 !(((pipestat == STAT_BE) || (pipestat == STAT_BD)) &&
1011 ((ctx->last_branch_reason != 0x0) && (ctx->last_branch_reason != 0x4))))
1013 if ((retval = etm_read_instruction(ctx, &instruction)) != ERROR_OK)
1015 /* can't continue tracing with no image available */
1016 if (retval == ERROR_TRACE_IMAGE_UNAVAILABLE)
1018 return retval;
1020 else if (retval == ERROR_TRACE_INSTRUCTION_UNAVAILABLE)
1022 /* TODO: handle incomplete images
1023 * for now we just quit the analsysis*/
1024 return retval;
1028 cycles = old_index - last_instruction;
1031 if ((pipestat == STAT_ID) || (pipestat == STAT_BD))
1033 uint32_t new_data_index = ctx->data_index;
1034 uint32_t new_data_half = ctx->data_half;
1036 /* in case of a branch with data, the branch target address was consumed before
1037 * we temporarily go back to the saved data index */
1038 if (pipestat == STAT_BD)
1040 ctx->data_index = old_data_index;
1041 ctx->data_half = old_data_half;
1044 if (ctx->tracemode & ETMV1_TRACE_ADDR)
1046 uint8_t packet;
1047 int shift = 0;
1049 do {
1050 if ((retval = etmv1_next_packet(ctx, &packet, 0)) != 0)
1051 return ERROR_ETM_ANALYSIS_FAILED;
1052 ctx->last_ptr &= ~(0x7f << shift);
1053 ctx->last_ptr |= (packet & 0x7f) << shift;
1054 shift += 7;
1055 } while ((packet & 0x80) && (shift < 32));
1057 if (shift >= 32)
1058 ctx->ptr_ok = 1;
1060 if (ctx->ptr_ok)
1062 command_print(cmd_ctx, "address: 0x%8.8" PRIx32 "", ctx->last_ptr);
1066 if (ctx->tracemode & ETMV1_TRACE_DATA)
1068 if ((instruction.type == ARM_LDM) || (instruction.type == ARM_STM))
1070 int i;
1071 for (i = 0; i < 16; i++)
1073 if (instruction.info.load_store_multiple.register_list & (1 << i))
1075 uint32_t data;
1076 if (etmv1_data(ctx, 4, &data) != 0)
1077 return ERROR_ETM_ANALYSIS_FAILED;
1078 command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1082 else if ((instruction.type >= ARM_LDR) && (instruction.type <= ARM_STRH))
1084 uint32_t data;
1085 if (etmv1_data(ctx, arm_access_size(&instruction), &data) != 0)
1086 return ERROR_ETM_ANALYSIS_FAILED;
1087 command_print(cmd_ctx, "data: 0x%8.8" PRIx32 "", data);
1091 /* restore data index after consuming BD address and data */
1092 if (pipestat == STAT_BD)
1094 ctx->data_index = new_data_index;
1095 ctx->data_half = new_data_half;
1099 /* adjust PC */
1100 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
1102 if (((instruction.type == ARM_B) ||
1103 (instruction.type == ARM_BL) ||
1104 (instruction.type == ARM_BLX)) &&
1105 (instruction.info.b_bl_bx_blx.target_address != 0xffffffff))
1107 next_pc = instruction.info.b_bl_bx_blx.target_address;
1109 else
1111 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1114 else if (pipestat == STAT_IN)
1116 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1119 if ((pipestat != STAT_TD) && (pipestat != STAT_WT))
1121 char cycles_text[32] = "";
1123 /* if the trace was captured with cycle accurate tracing enabled,
1124 * output the number of cycles since the last executed instruction
1126 if (ctx->tracemode & ETMV1_CYCLE_ACCURATE)
1128 snprintf(cycles_text, 32, " (%i %s)",
1129 (int)cycles,
1130 (cycles == 1) ? "cycle" : "cycles");
1133 command_print(cmd_ctx, "%s%s%s",
1134 instruction.text,
1135 (pipestat == STAT_IN) ? " (not executed)" : "",
1136 cycles_text);
1138 ctx->current_pc = next_pc;
1140 /* packets for an instruction don't start on or before the preceding
1141 * functional pipestat (i.e. other than WT or TD)
1143 if (ctx->data_index <= ctx->pipe_index)
1145 ctx->data_index = ctx->pipe_index + 1;
1146 ctx->data_half = 0;
1150 ctx->pipe_index += 1;
1153 return ERROR_OK;
1156 static int handle_etm_tracemode_command_update(
1157 struct command_context_s *cmd_ctx,
1158 char **args, etmv1_tracemode_t *mode)
1160 etmv1_tracemode_t tracemode;
1162 /* what parts of data access are traced? */
1163 if (strcmp(args[0], "none") == 0)
1164 tracemode = ETMV1_TRACE_NONE;
1165 else if (strcmp(args[0], "data") == 0)
1166 tracemode = ETMV1_TRACE_DATA;
1167 else if (strcmp(args[0], "address") == 0)
1168 tracemode = ETMV1_TRACE_ADDR;
1169 else if (strcmp(args[0], "all") == 0)
1170 tracemode = ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR;
1171 else
1173 command_print(cmd_ctx, "invalid option '%s'", args[0]);
1174 return ERROR_INVALID_ARGUMENTS;
1177 uint8_t context_id;
1178 COMMAND_PARSE_NUMBER(u8, args[1], context_id);
1179 switch (context_id)
1181 case 0:
1182 tracemode |= ETMV1_CONTEXTID_NONE;
1183 break;
1184 case 8:
1185 tracemode |= ETMV1_CONTEXTID_8;
1186 break;
1187 case 16:
1188 tracemode |= ETMV1_CONTEXTID_16;
1189 break;
1190 case 32:
1191 tracemode |= ETMV1_CONTEXTID_32;
1192 break;
1193 default:
1194 command_print(cmd_ctx, "invalid option '%s'", args[1]);
1195 return ERROR_INVALID_ARGUMENTS;
1198 if (strcmp(args[2], "enable") == 0)
1199 tracemode |= ETMV1_CYCLE_ACCURATE;
1200 else if (strcmp(args[2], "disable") == 0)
1201 tracemode |= 0;
1202 else
1204 command_print(cmd_ctx, "invalid option '%s'", args[2]);
1205 return ERROR_INVALID_ARGUMENTS;
1208 if (strcmp(args[3], "enable") == 0)
1209 tracemode |= ETMV1_BRANCH_OUTPUT;
1210 else if (strcmp(args[3], "disable") == 0)
1211 tracemode |= 0;
1212 else
1214 command_print(cmd_ctx, "invalid option '%s'", args[3]);
1215 return ERROR_INVALID_ARGUMENTS;
1218 /* IGNORED:
1219 * - CPRT tracing (coprocessor register transfers)
1220 * - debug request (causes debug entry on trigger)
1221 * - stall on FIFOFULL (preventing tracedata lossage)
1223 *mode = tracemode;
1225 return ERROR_OK;
1228 static int handle_etm_tracemode_command(struct command_context_s *cmd_ctx,
1229 char *cmd, char **args, int argc)
1231 target_t *target = get_current_target(cmd_ctx);
1232 armv4_5_common_t *armv4_5;
1233 arm7_9_common_t *arm7_9;
1234 struct etm *etm;
1236 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1238 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1239 return ERROR_FAIL;
1242 etm = arm7_9->etm_ctx;
1243 if (!etm) {
1244 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1245 return ERROR_FAIL;
1248 etmv1_tracemode_t tracemode = etm->tracemode;
1250 switch (argc)
1252 case 0:
1253 break;
1254 case 4:
1255 handle_etm_tracemode_command_update(cmd_ctx, args, &tracemode);
1256 break;
1257 default:
1258 command_print(cmd_ctx, "usage: configure trace mode "
1259 "<none | data | address | all> "
1260 "<context id bits> <cycle accurate> <branch output>");
1261 return ERROR_FAIL;
1265 * todo: fail if parameters were invalid for this hardware,
1266 * or couldn't be written; display actual hardware state...
1269 command_print(cmd_ctx, "current tracemode configuration:");
1271 switch (tracemode & ETMV1_TRACE_MASK)
1273 case ETMV1_TRACE_NONE:
1274 command_print(cmd_ctx, "data tracing: none");
1275 break;
1276 case ETMV1_TRACE_DATA:
1277 command_print(cmd_ctx, "data tracing: data only");
1278 break;
1279 case ETMV1_TRACE_ADDR:
1280 command_print(cmd_ctx, "data tracing: address only");
1281 break;
1282 case ETMV1_TRACE_DATA | ETMV1_TRACE_ADDR:
1283 command_print(cmd_ctx, "data tracing: address and data");
1284 break;
1287 switch (tracemode & ETMV1_CONTEXTID_MASK)
1289 case ETMV1_CONTEXTID_NONE:
1290 command_print(cmd_ctx, "contextid tracing: none");
1291 break;
1292 case ETMV1_CONTEXTID_8:
1293 command_print(cmd_ctx, "contextid tracing: 8 bit");
1294 break;
1295 case ETMV1_CONTEXTID_16:
1296 command_print(cmd_ctx, "contextid tracing: 16 bit");
1297 break;
1298 case ETMV1_CONTEXTID_32:
1299 command_print(cmd_ctx, "contextid tracing: 32 bit");
1300 break;
1303 if (tracemode & ETMV1_CYCLE_ACCURATE)
1305 command_print(cmd_ctx, "cycle-accurate tracing enabled");
1307 else
1309 command_print(cmd_ctx, "cycle-accurate tracing disabled");
1312 if (tracemode & ETMV1_BRANCH_OUTPUT)
1314 command_print(cmd_ctx, "full branch address output enabled");
1316 else
1318 command_print(cmd_ctx, "full branch address output disabled");
1321 /* only update ETM_CTRL register if tracemode changed */
1322 if (etm->tracemode != tracemode)
1324 reg_t *etm_ctrl_reg;
1326 etm_ctrl_reg = etm_reg_lookup(etm, ETM_CTRL);
1327 if (!etm_ctrl_reg)
1328 return ERROR_FAIL;
1330 etm_get_reg(etm_ctrl_reg);
1332 buf_set_u32(etm_ctrl_reg->value, 2, 2, tracemode & ETMV1_TRACE_MASK);
1333 buf_set_u32(etm_ctrl_reg->value, 14, 2, (tracemode & ETMV1_CONTEXTID_MASK) >> 4);
1334 buf_set_u32(etm_ctrl_reg->value, 12, 1, (tracemode & ETMV1_CYCLE_ACCURATE) >> 8);
1335 buf_set_u32(etm_ctrl_reg->value, 8, 1, (tracemode & ETMV1_BRANCH_OUTPUT) >> 9);
1336 etm_store_reg(etm_ctrl_reg);
1338 etm->tracemode = tracemode;
1340 /* invalidate old trace data */
1341 etm->capture_status = TRACE_IDLE;
1342 if (etm->trace_depth > 0)
1344 free(etm->trace_data);
1345 etm->trace_data = NULL;
1347 etm->trace_depth = 0;
1350 return ERROR_OK;
1353 static int handle_etm_config_command(struct command_context_s *cmd_ctx,
1354 char *cmd, char **args, int argc)
1356 target_t *target;
1357 struct arm *arm;
1358 arm7_9_common_t *arm7_9;
1359 etm_portmode_t portmode = 0x0;
1360 struct etm *etm_ctx;
1361 int i;
1363 if (argc != 5)
1364 return ERROR_COMMAND_SYNTAX_ERROR;
1366 target = get_target(args[0]);
1367 if (!target)
1369 LOG_ERROR("target '%s' not defined", args[0]);
1370 return ERROR_FAIL;
1373 if (arm7_9_get_arch_pointers(target, &arm, &arm7_9) != ERROR_OK)
1375 command_print(cmd_ctx, "target '%s' is '%s'; not an ARM",
1376 target->cmd_name, target_get_name(target));
1377 return ERROR_FAIL;
1380 uint8_t port_width;
1381 COMMAND_PARSE_NUMBER(u8, args[1], port_width);
1382 switch (port_width)
1384 case 4:
1385 portmode |= ETM_PORT_4BIT;
1386 break;
1387 case 8:
1388 portmode |= ETM_PORT_8BIT;
1389 break;
1390 case 16:
1391 portmode |= ETM_PORT_16BIT;
1392 break;
1393 default:
1394 command_print(cmd_ctx, "unsupported ETM port width '%s', must be 4, 8 or 16", args[1]);
1395 return ERROR_FAIL;
1398 if (strcmp("normal", args[2]) == 0)
1400 portmode |= ETM_PORT_NORMAL;
1402 else if (strcmp("multiplexed", args[2]) == 0)
1404 portmode |= ETM_PORT_MUXED;
1406 else if (strcmp("demultiplexed", args[2]) == 0)
1408 portmode |= ETM_PORT_DEMUXED;
1410 else
1412 command_print(cmd_ctx, "unsupported ETM port mode '%s', must be 'normal', 'multiplexed' or 'demultiplexed'", args[2]);
1413 return ERROR_FAIL;
1416 if (strcmp("half", args[3]) == 0)
1418 portmode |= ETM_PORT_HALF_CLOCK;
1420 else if (strcmp("full", args[3]) == 0)
1422 portmode |= ETM_PORT_FULL_CLOCK;
1424 else
1426 command_print(cmd_ctx, "unsupported ETM port clocking '%s', must be 'full' or 'half'", args[3]);
1427 return ERROR_FAIL;
1430 etm_ctx = calloc(1, sizeof(etm_context_t));
1431 if (!etm_ctx) {
1432 LOG_DEBUG("out of memory");
1433 return ERROR_FAIL;
1436 for (i = 0; etm_capture_drivers[i]; i++)
1438 if (strcmp(args[4], etm_capture_drivers[i]->name) == 0)
1440 int retval;
1441 if ((retval = etm_capture_drivers[i]->register_commands(cmd_ctx)) != ERROR_OK)
1443 free(etm_ctx);
1444 return retval;
1447 etm_ctx->capture_driver = etm_capture_drivers[i];
1449 break;
1453 if (!etm_capture_drivers[i])
1455 /* no supported capture driver found, don't register an ETM */
1456 free(etm_ctx);
1457 LOG_ERROR("trace capture driver '%s' not found", args[4]);
1458 return ERROR_FAIL;
1461 etm_ctx->target = target;
1462 etm_ctx->trigger_percent = 50;
1463 etm_ctx->trace_data = NULL;
1464 etm_ctx->portmode = portmode;
1465 etm_ctx->core_state = ARMV4_5_STATE_ARM;
1467 arm7_9->etm_ctx = etm_ctx;
1468 arm->etm = etm_ctx;
1470 return etm_register_user_commands(cmd_ctx);
1473 static int handle_etm_info_command(struct command_context_s *cmd_ctx,
1474 char *cmd, char **args, int argc)
1476 target_t *target;
1477 armv4_5_common_t *armv4_5;
1478 arm7_9_common_t *arm7_9;
1479 etm_context_t *etm;
1480 reg_t *etm_sys_config_reg;
1482 int max_port_size;
1484 target = get_current_target(cmd_ctx);
1486 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1488 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1489 return ERROR_FAIL;
1492 etm = arm7_9->etm_ctx;
1493 if (!etm)
1495 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1496 return ERROR_FAIL;
1499 command_print(cmd_ctx, "ETM v%d.%d",
1500 etm->bcd_vers >> 4, etm->bcd_vers & 0xf);
1501 command_print(cmd_ctx, "pairs of address comparators: %i",
1502 (int) (etm->config >> 0) & 0x0f);
1503 command_print(cmd_ctx, "data comparators: %i",
1504 (int) (etm->config >> 4) & 0x0f);
1505 command_print(cmd_ctx, "memory map decoders: %i",
1506 (int) (etm->config >> 8) & 0x1f);
1507 command_print(cmd_ctx, "number of counters: %i",
1508 (int) (etm->config >> 13) & 0x07);
1509 command_print(cmd_ctx, "sequencer %spresent",
1510 (int) (etm->config & (1 << 16)) ? "" : "not ");
1511 command_print(cmd_ctx, "number of ext. inputs: %i",
1512 (int) (etm->config >> 17) & 0x07);
1513 command_print(cmd_ctx, "number of ext. outputs: %i",
1514 (int) (etm->config >> 20) & 0x07);
1515 command_print(cmd_ctx, "FIFO full %spresent",
1516 (int) (etm->config & (1 << 23)) ? "" : "not ");
1517 if (etm->bcd_vers < 0x20)
1518 command_print(cmd_ctx, "protocol version: %i",
1519 (int) (etm->config >> 28) & 0x07);
1520 else {
1521 command_print(cmd_ctx, "trace start/stop %spresent",
1522 (etm->config & (1 << 26)) ? "" : "not ");
1523 command_print(cmd_ctx, "number of context comparators: %i",
1524 (int) (etm->config >> 24) & 0x03);
1527 /* SYS_CONFIG isn't present before ETMv1.2 */
1528 etm_sys_config_reg = etm_reg_lookup(etm, ETM_SYS_CONFIG);
1529 if (!etm_sys_config_reg)
1530 return ERROR_OK;
1532 etm_get_reg(etm_sys_config_reg);
1534 switch (buf_get_u32(etm_sys_config_reg->value, 0, 3))
1536 case 0:
1537 max_port_size = 4;
1538 break;
1539 case 1:
1540 max_port_size = 8;
1541 break;
1542 case 2:
1543 max_port_size = 16;
1544 break;
1545 default:
1546 LOG_ERROR("Illegal max_port_size");
1547 return ERROR_FAIL;
1549 command_print(cmd_ctx, "max. port size: %i", max_port_size);
1551 command_print(cmd_ctx, "half-rate clocking %ssupported",
1552 (buf_get_u32(etm_sys_config_reg->value, 3, 1) == 1) ? "" : "not ");
1553 command_print(cmd_ctx, "full-rate clocking %ssupported",
1554 (buf_get_u32(etm_sys_config_reg->value, 4, 1) == 1) ? "" : "not ");
1555 command_print(cmd_ctx, "normal trace format %ssupported",
1556 (buf_get_u32(etm_sys_config_reg->value, 5, 1) == 1) ? "" : "not ");
1557 command_print(cmd_ctx, "multiplex trace format %ssupported",
1558 (buf_get_u32(etm_sys_config_reg->value, 6, 1) == 1) ? "" : "not ");
1559 command_print(cmd_ctx, "demultiplex trace format %ssupported",
1560 (buf_get_u32(etm_sys_config_reg->value, 7, 1) == 1) ? "" : "not ");
1561 command_print(cmd_ctx, "FIFO full %ssupported",
1562 (buf_get_u32(etm_sys_config_reg->value, 8, 1) == 1) ? "" : "not ");
1564 return ERROR_OK;
1567 static int handle_etm_status_command(struct command_context_s *cmd_ctx,
1568 char *cmd, char **args, int argc)
1570 target_t *target;
1571 armv4_5_common_t *armv4_5;
1572 arm7_9_common_t *arm7_9;
1573 etm_context_t *etm;
1574 trace_status_t trace_status;
1576 target = get_current_target(cmd_ctx);
1578 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1580 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1581 return ERROR_FAIL;
1584 if (!arm7_9->etm_ctx)
1586 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1587 return ERROR_FAIL;
1589 etm = arm7_9->etm_ctx;
1591 /* ETM status */
1592 if (etm->bcd_vers >= 0x11) {
1593 reg_t *reg;
1595 reg = etm_reg_lookup(etm, ETM_STATUS);
1596 if (!reg)
1597 return ERROR_FAIL;
1598 if (etm_get_reg(reg) == ERROR_OK) {
1599 unsigned s = buf_get_u32(reg->value, 0, reg->size);
1601 command_print(cmd_ctx, "etm: %s%s%s%s",
1602 /* bit(1) == progbit */
1603 (etm->bcd_vers >= 0x12)
1604 ? ((s & (1 << 1))
1605 ? "disabled" : "enabled")
1606 : "?",
1607 ((s & (1 << 3)) && etm->bcd_vers >= 0x31)
1608 ? " triggered" : "",
1609 ((s & (1 << 2)) && etm->bcd_vers >= 0x12)
1610 ? " start/stop" : "",
1611 ((s & (1 << 0)) && etm->bcd_vers >= 0x11)
1612 ? " untraced-overflow" : "");
1613 } /* else ignore and try showing trace port status */
1616 /* Trace Port Driver status */
1617 trace_status = etm->capture_driver->status(etm);
1618 if (trace_status == TRACE_IDLE)
1620 command_print(cmd_ctx, "%s: idle", etm->capture_driver->name);
1622 else
1624 static char *completed = " completed";
1625 static char *running = " is running";
1626 static char *overflowed = ", overflowed";
1627 static char *triggered = ", triggered";
1629 command_print(cmd_ctx, "%s: trace collection%s%s%s",
1630 etm->capture_driver->name,
1631 (trace_status & TRACE_RUNNING) ? running : completed,
1632 (trace_status & TRACE_OVERFLOWED) ? overflowed : "",
1633 (trace_status & TRACE_TRIGGERED) ? triggered : "");
1635 if (etm->trace_depth > 0)
1637 command_print(cmd_ctx, "%i frames of trace data read",
1638 (int)(etm->trace_depth));
1642 return ERROR_OK;
1645 static int handle_etm_image_command(struct command_context_s *cmd_ctx,
1646 char *cmd, char **args, int argc)
1648 target_t *target;
1649 armv4_5_common_t *armv4_5;
1650 arm7_9_common_t *arm7_9;
1651 etm_context_t *etm_ctx;
1653 if (argc < 1)
1655 command_print(cmd_ctx, "usage: etm image <file> [base address] [type]");
1656 return ERROR_FAIL;
1659 target = get_current_target(cmd_ctx);
1661 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1663 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1664 return ERROR_FAIL;
1667 if (!(etm_ctx = arm7_9->etm_ctx))
1669 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1670 return ERROR_FAIL;
1673 if (etm_ctx->image)
1675 image_close(etm_ctx->image);
1676 free(etm_ctx->image);
1677 command_print(cmd_ctx, "previously loaded image found and closed");
1680 etm_ctx->image = malloc(sizeof(image_t));
1681 etm_ctx->image->base_address_set = 0;
1682 etm_ctx->image->start_address_set = 0;
1684 /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1685 if (argc >= 2)
1687 etm_ctx->image->base_address_set = 1;
1688 COMMAND_PARSE_NUMBER(int, args[1], etm_ctx->image->base_address);
1690 else
1692 etm_ctx->image->base_address_set = 0;
1695 if (image_open(etm_ctx->image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
1697 free(etm_ctx->image);
1698 etm_ctx->image = NULL;
1699 return ERROR_FAIL;
1702 return ERROR_OK;
1705 static int handle_etm_dump_command(struct command_context_s *cmd_ctx,
1706 char *cmd, char **args, int argc)
1708 fileio_t file;
1709 target_t *target;
1710 armv4_5_common_t *armv4_5;
1711 arm7_9_common_t *arm7_9;
1712 etm_context_t *etm_ctx;
1713 uint32_t i;
1715 if (argc != 1)
1717 command_print(cmd_ctx, "usage: etm dump <file>");
1718 return ERROR_FAIL;
1721 target = get_current_target(cmd_ctx);
1723 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1725 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1726 return ERROR_FAIL;
1729 if (!(etm_ctx = arm7_9->etm_ctx))
1731 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1732 return ERROR_FAIL;
1735 if (etm_ctx->capture_driver->status == TRACE_IDLE)
1737 command_print(cmd_ctx, "trace capture wasn't enabled, no trace data captured");
1738 return ERROR_OK;
1741 if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1743 /* TODO: if on-the-fly capture is to be supported, this needs to be changed */
1744 command_print(cmd_ctx, "trace capture not completed");
1745 return ERROR_FAIL;
1748 /* read the trace data if it wasn't read already */
1749 if (etm_ctx->trace_depth == 0)
1750 etm_ctx->capture_driver->read_trace(etm_ctx);
1752 if (fileio_open(&file, args[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1754 return ERROR_FAIL;
1757 fileio_write_u32(&file, etm_ctx->capture_status);
1758 fileio_write_u32(&file, etm_ctx->portmode);
1759 fileio_write_u32(&file, etm_ctx->tracemode);
1760 fileio_write_u32(&file, etm_ctx->trace_depth);
1762 for (i = 0; i < etm_ctx->trace_depth; i++)
1764 fileio_write_u32(&file, etm_ctx->trace_data[i].pipestat);
1765 fileio_write_u32(&file, etm_ctx->trace_data[i].packet);
1766 fileio_write_u32(&file, etm_ctx->trace_data[i].flags);
1769 fileio_close(&file);
1771 return ERROR_OK;
1774 static int handle_etm_load_command(struct command_context_s *cmd_ctx,
1775 char *cmd, char **args, int argc)
1777 fileio_t file;
1778 target_t *target;
1779 armv4_5_common_t *armv4_5;
1780 arm7_9_common_t *arm7_9;
1781 etm_context_t *etm_ctx;
1782 uint32_t i;
1784 if (argc != 1)
1786 command_print(cmd_ctx, "usage: etm load <file>");
1787 return ERROR_FAIL;
1790 target = get_current_target(cmd_ctx);
1792 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1794 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1795 return ERROR_FAIL;
1798 if (!(etm_ctx = arm7_9->etm_ctx))
1800 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1801 return ERROR_FAIL;
1804 if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1806 command_print(cmd_ctx, "trace capture running, stop first");
1807 return ERROR_FAIL;
1810 if (fileio_open(&file, args[0], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1812 return ERROR_FAIL;
1815 if (file.size % 4)
1817 command_print(cmd_ctx, "size isn't a multiple of 4, no valid trace data");
1818 fileio_close(&file);
1819 return ERROR_FAIL;
1822 if (etm_ctx->trace_depth > 0)
1824 free(etm_ctx->trace_data);
1825 etm_ctx->trace_data = NULL;
1829 uint32_t tmp;
1830 fileio_read_u32(&file, &tmp); etm_ctx->capture_status = tmp;
1831 fileio_read_u32(&file, &tmp); etm_ctx->portmode = tmp;
1832 fileio_read_u32(&file, &tmp); etm_ctx->tracemode = tmp;
1833 fileio_read_u32(&file, &etm_ctx->trace_depth);
1835 etm_ctx->trace_data = malloc(sizeof(etmv1_trace_data_t) * etm_ctx->trace_depth);
1836 if (etm_ctx->trace_data == NULL)
1838 command_print(cmd_ctx, "not enough memory to perform operation");
1839 fileio_close(&file);
1840 return ERROR_FAIL;
1843 for (i = 0; i < etm_ctx->trace_depth; i++)
1845 uint32_t pipestat, packet, flags;
1846 fileio_read_u32(&file, &pipestat);
1847 fileio_read_u32(&file, &packet);
1848 fileio_read_u32(&file, &flags);
1849 etm_ctx->trace_data[i].pipestat = pipestat & 0xff;
1850 etm_ctx->trace_data[i].packet = packet & 0xffff;
1851 etm_ctx->trace_data[i].flags = flags;
1854 fileio_close(&file);
1856 return ERROR_OK;
1859 static int handle_etm_trigger_percent_command(struct command_context_s *cmd_ctx,
1860 char *cmd, char **args, int argc)
1862 target_t *target;
1863 armv4_5_common_t *armv4_5;
1864 arm7_9_common_t *arm7_9;
1865 etm_context_t *etm_ctx;
1867 target = get_current_target(cmd_ctx);
1869 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1871 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1872 return ERROR_FAIL;
1875 if (!(etm_ctx = arm7_9->etm_ctx))
1877 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1878 return ERROR_FAIL;
1881 if (argc > 0)
1883 uint32_t new_value;
1884 COMMAND_PARSE_NUMBER(u32, args[0], new_value);
1886 if ((new_value < 2) || (new_value > 100))
1888 command_print(cmd_ctx, "valid settings are 2%% to 100%%");
1890 else
1892 etm_ctx->trigger_percent = new_value;
1896 command_print(cmd_ctx, "%i percent of the tracebuffer reserved for after the trigger", ((int)(etm_ctx->trigger_percent)));
1898 return ERROR_OK;
1901 static int handle_etm_start_command(struct command_context_s *cmd_ctx,
1902 char *cmd, char **args, int argc)
1904 target_t *target;
1905 armv4_5_common_t *armv4_5;
1906 arm7_9_common_t *arm7_9;
1907 etm_context_t *etm_ctx;
1908 reg_t *etm_ctrl_reg;
1910 target = get_current_target(cmd_ctx);
1912 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1914 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1915 return ERROR_FAIL;
1918 etm_ctx = arm7_9->etm_ctx;
1919 if (!etm_ctx)
1921 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1922 return ERROR_FAIL;
1925 /* invalidate old tracing data */
1926 etm_ctx->capture_status = TRACE_IDLE;
1927 if (etm_ctx->trace_depth > 0)
1929 free(etm_ctx->trace_data);
1930 etm_ctx->trace_data = NULL;
1932 etm_ctx->trace_depth = 0;
1934 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
1935 if (!etm_ctrl_reg)
1936 return ERROR_FAIL;
1938 etm_get_reg(etm_ctrl_reg);
1940 /* Clear programming bit (10), set port selection bit (11) */
1941 buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x2);
1943 etm_store_reg(etm_ctrl_reg);
1944 jtag_execute_queue();
1946 etm_ctx->capture_driver->start_capture(etm_ctx);
1948 return ERROR_OK;
1951 static int handle_etm_stop_command(struct command_context_s *cmd_ctx,
1952 char *cmd, char **args, int argc)
1954 target_t *target;
1955 armv4_5_common_t *armv4_5;
1956 arm7_9_common_t *arm7_9;
1957 etm_context_t *etm_ctx;
1958 reg_t *etm_ctrl_reg;
1960 target = get_current_target(cmd_ctx);
1962 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1964 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1965 return ERROR_FAIL;
1968 if (!(etm_ctx = arm7_9->etm_ctx))
1970 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1971 return ERROR_FAIL;
1974 etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
1975 if (!etm_ctrl_reg)
1976 return ERROR_FAIL;
1978 etm_get_reg(etm_ctrl_reg);
1980 /* Set programming bit (10), clear port selection bit (11) */
1981 buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x1);
1983 etm_store_reg(etm_ctrl_reg);
1984 jtag_execute_queue();
1986 etm_ctx->capture_driver->stop_capture(etm_ctx);
1988 return ERROR_OK;
1991 static int handle_etm_analyze_command(struct command_context_s *cmd_ctx,
1992 char *cmd, char **args, int argc)
1994 target_t *target;
1995 armv4_5_common_t *armv4_5;
1996 arm7_9_common_t *arm7_9;
1997 etm_context_t *etm_ctx;
1998 int retval;
2000 target = get_current_target(cmd_ctx);
2002 if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
2004 command_print(cmd_ctx, "ETM: current target isn't an ARM");
2005 return ERROR_FAIL;
2008 if (!(etm_ctx = arm7_9->etm_ctx))
2010 command_print(cmd_ctx, "current target doesn't have an ETM configured");
2011 return ERROR_FAIL;
2014 if ((retval = etmv1_analyze_trace(etm_ctx, cmd_ctx)) != ERROR_OK)
2016 switch (retval)
2018 case ERROR_ETM_ANALYSIS_FAILED:
2019 command_print(cmd_ctx, "further analysis failed (corrupted trace data or just end of data");
2020 break;
2021 case ERROR_TRACE_INSTRUCTION_UNAVAILABLE:
2022 command_print(cmd_ctx, "no instruction for current address available, analysis aborted");
2023 break;
2024 case ERROR_TRACE_IMAGE_UNAVAILABLE:
2025 command_print(cmd_ctx, "no image available for trace analysis");
2026 break;
2027 default:
2028 command_print(cmd_ctx, "unknown error: %i", retval);
2032 return retval;
2035 int etm_register_commands(struct command_context_s *cmd_ctx)
2037 etm_cmd = register_command(cmd_ctx, NULL, "etm", NULL, COMMAND_ANY, "Embedded Trace Macrocell");
2039 register_command(cmd_ctx, etm_cmd, "config", handle_etm_config_command,
2040 COMMAND_CONFIG, "etm config <target> <port_width> <port_mode> <clocking> <capture_driver>");
2042 return ERROR_OK;
2045 static int etm_register_user_commands(struct command_context_s *cmd_ctx)
2047 register_command(cmd_ctx, etm_cmd, "tracemode", handle_etm_tracemode_command,
2048 COMMAND_EXEC, "configure/display trace mode: "
2049 "<none | data | address | all> "
2050 "<context_id_bits> <cycle_accurate> <branch_output>");
2052 register_command(cmd_ctx, etm_cmd, "info", handle_etm_info_command,
2053 COMMAND_EXEC, "display info about the current target's ETM");
2055 register_command(cmd_ctx, etm_cmd, "trigger_percent", handle_etm_trigger_percent_command,
2056 COMMAND_EXEC, "amount (<percent>) of trace buffer to be filled after the trigger occured");
2057 register_command(cmd_ctx, etm_cmd, "status", handle_etm_status_command,
2058 COMMAND_EXEC, "display current target's ETM status");
2059 register_command(cmd_ctx, etm_cmd, "start", handle_etm_start_command,
2060 COMMAND_EXEC, "start ETM trace collection");
2061 register_command(cmd_ctx, etm_cmd, "stop", handle_etm_stop_command,
2062 COMMAND_EXEC, "stop ETM trace collection");
2064 register_command(cmd_ctx, etm_cmd, "analyze", handle_etm_analyze_command,
2065 COMMAND_EXEC, "anaylze collected ETM trace");
2067 register_command(cmd_ctx, etm_cmd, "image", handle_etm_image_command,
2068 COMMAND_EXEC, "load image from <file> [base address]");
2070 register_command(cmd_ctx, etm_cmd, "dump", handle_etm_dump_command,
2071 COMMAND_EXEC, "dump captured trace data <file>");
2072 register_command(cmd_ctx, etm_cmd, "load", handle_etm_load_command,
2073 COMMAND_EXEC, "load trace data for analysis <file>");
2075 return ERROR_OK;