ETM cleanup
[fw/openocd] / src / target / etm.c
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include "etm.h"
25 #include "etb.h"
26 #include "image.h"
27 #include "arm7_9_common.h"
28 #include "arm_disassembler.h"
29
30
31 /*
32  * ARM "Embedded Trace Macrocell" (ETM) support -- direct JTAG access.
33  *
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).
37  *
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.
42  *
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.
46  *
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
51  */
52
53 #define ARRAY_SIZE(x)   ((int)(sizeof(x)/sizeof((x)[0])))
54
55 enum {
56         RO,                             /* read/only */
57         WO,                             /* write/only */
58         RW,                             /* read/write */
59 };
60
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;
67 };
68
69 /*
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.
74  */
75
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", },
80
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", },
87
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", },
93
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", },
99
100         /* REVISIT exclude VIEWDATA_CTRL2 when it's not there */
101
102         { 0x78, 12, WO, 0x20, "ETM_sync_freq", },
103         { 0x79, 32, RO, 0x20, "ETM_id", },
104 };
105
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", },
110 };
111
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),
127
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
137 };
138
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
155 };
156
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
172 };
173
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", },
187 };
188
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, }
193
194         ETM_OUTPUT(1),
195         ETM_OUTPUT(2),
196         ETM_OUTPUT(3),
197         ETM_OUTPUT(4),
198 #undef ETM_OUTPUT
199 };
200
201 #if 0
202         /* registers from 0x6c..0x7f were added after ETMv1.3 */
203
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
210
211 static int etm_reg_arch_type = -1;
212
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);
219
220 static command_t *etm_cmd;
221
222
223 /* Look up register by ID ... most ETM instances only
224  * support a subset of the possible registers.
225  */
226 static reg_t *etm_reg_lookup(etm_context_t *etm_ctx, unsigned id)
227 {
228         reg_cache_t *cache = etm_ctx->reg_cache;
229         int i;
230
231         for (i = 0; i < cache->num_regs; i++) {
232                 struct etm_reg_s *reg = cache->reg_list[i].arch_info;
233
234                 if (reg->reg_info->addr == id)
235                         return &cache->reg_list[i];
236         }
237
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;
242 }
243
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)
247 {
248         reg_t *reg = cache->reg_list;
249
250         reg += cache->num_regs;
251         ereg += cache->num_regs;
252
253         /* add up to "nreg" registers from "r", if supported by this
254          * version of the ETM, to the specified cache.
255          */
256         for (; nreg--; r++) {
257
258                 /* this ETM may be too old to have some registers */
259                 if (r->bcd_vers > bcd_vers)
260                         continue;
261
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++;
269
270                 ereg->reg_info = r;
271                 ereg->jtag_info = jtag_info;
272                 ereg++;
273         }
274 }
275
276 reg_cache_t *etm_build_reg_cache(target_t *target,
277                 arm_jtag_t *jtag_info, etm_context_t *etm_ctx)
278 {
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;
283
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);
288
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));
292
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;
298
299         /* add ETM_CONFIG, then parse its values to see
300          * which other registers exist in this ETM
301          */
302         etm_reg_add(0x10, jtag_info, reg_cache, arch_info,
303                         etm_core, 1);
304
305         etm_get_reg(reg_list);
306         etm_ctx->config = buf_get_u32((void *)&arch_info->value, 0, 32);
307         config = etm_ctx->config;
308
309         /* figure ETM version then add base registers */
310         if (config & (1 << 31)) {
311                 bcd_vers = 0x20;
312                 LOG_WARNING("ETMv2+ support is incomplete");
313
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.
317                  */
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;
341                 }
342         }
343         etm_ctx->bcd_vers = bcd_vers;
344         LOG_INFO("ETM v%d.%d", bcd_vers >> 4, bcd_vers & 0xf);
345
346         etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
347                         etm_core + 1, ARRAY_SIZE(etm_core) - 1);
348
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)));
358
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* ...
362          */
363         if (config & (1 << 23))
364                 etm_reg_add(bcd_vers, jtag_info, reg_cache, arch_info,
365                                 etm_fifofull, ARRAY_SIZE(etm_fifofull));
366
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));
371
372         /* REVISIT could realloc and likely save half the memory
373          * in the two chunks we allocated...
374          */
375
376         /* the ETM might have an ETB connected */
377         if (strcmp(etm_ctx->capture_driver->name, "etb") == 0)
378         {
379                 etb_t *etb = etm_ctx->capture_driver_priv;
380
381                 if (!etb)
382                 {
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;
388                 }
389
390                 reg_cache->next = etb_build_reg_cache(etb);
391
392                 etb->reg_cache = reg_cache->next;
393         }
394
395
396         return reg_cache;
397 }
398
399 static int etm_read_reg(reg_t *reg)
400 {
401         return etm_read_reg_w_check(reg, NULL, NULL);
402 }
403
404 static int etm_store_reg(reg_t *reg)
405 {
406         return etm_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
407 }
408
409 int etm_setup(target_t *target)
410 {
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;
416
417         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
418         if (!etm_ctrl_reg)
419                 return ERROR_OK;
420
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);
424
425         /* clear the ETM powerdown bit (0) */
426         etm_ctrl_value &= ~0x1;
427
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;
432
433         buf_set_u32(etm_ctrl_reg->value, 0, etm_ctrl_reg->size, etm_ctrl_value);
434         etm_store_reg(etm_ctrl_reg);
435
436         if ((retval = jtag_execute_queue()) != ERROR_OK)
437                 return retval;
438
439         if ((retval = etm_ctx->capture_driver->init(etm_ctx)) != ERROR_OK)
440         {
441                 LOG_ERROR("ETM capture driver initialization failed");
442                 return retval;
443         }
444         return ERROR_OK;
445 }
446
447 static int etm_get_reg(reg_t *reg)
448 {
449         int retval;
450
451         if ((retval = etm_read_reg(reg)) != ERROR_OK)
452         {
453                 LOG_ERROR("BUG: error scheduling etm register read");
454                 return retval;
455         }
456
457         if ((retval = jtag_execute_queue()) != ERROR_OK)
458         {
459                 LOG_ERROR("register read failed");
460                 return retval;
461         }
462
463         return ERROR_OK;
464 }
465
466 static int etm_read_reg_w_check(reg_t *reg,
467                 uint8_t* check_value, uint8_t* check_mask)
468 {
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];
473
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;
477         }
478
479         LOG_DEBUG("%s (%u)", r->name, reg_addr);
480
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);
484
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;
491
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;
499
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;
507
508         jtag_add_dr_scan(3, fields, jtag_get_end_state());
509
510         fields[0].in_value = reg->value;
511         fields[0].check_value = check_value;
512         fields[0].check_mask = check_mask;
513
514         jtag_add_dr_scan_check(3, fields, jtag_get_end_state());
515
516         free(fields[1].out_value);
517         free(fields[2].out_value);
518
519         return ERROR_OK;
520 }
521
522 static int etm_set_reg(reg_t *reg, uint32_t value)
523 {
524         int retval;
525
526         if ((retval = etm_write_reg(reg, value)) != ERROR_OK)
527         {
528                 LOG_ERROR("BUG: error scheduling etm register write");
529                 return retval;
530         }
531
532         buf_set_u32(reg->value, 0, reg->size, value);
533         reg->valid = 1;
534         reg->dirty = 0;
535
536         return ERROR_OK;
537 }
538
539 static int etm_set_reg_w_exec(reg_t *reg, uint8_t *buf)
540 {
541         int retval;
542
543         etm_set_reg(reg, buf_get_u32(buf, 0, reg->size));
544
545         if ((retval = jtag_execute_queue()) != ERROR_OK)
546         {
547                 LOG_ERROR("register write failed");
548                 return retval;
549         }
550         return ERROR_OK;
551 }
552
553 static int etm_write_reg(reg_t *reg, uint32_t value)
554 {
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];
559
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;
563         }
564
565         LOG_DEBUG("%s (%u): 0x%8.8" PRIx32 "", r->name, reg_addr, value);
566
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);
570
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;
577
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;
584
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;
591
592         jtag_add_dr_scan(3, fields, jtag_get_end_state());
593
594         return ERROR_OK;
595 }
596
597
598 /* ETM trace analysis functionality
599  *
600  */
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
605
606 static etm_capture_driver_t *etm_capture_drivers[] =
607 {
608         &etb_capture_driver,
609         &etm_dummy_capture_driver,
610 #if BUILD_OOCD_TRACE == 1
611         &oocd_trace_capture_driver,
612 #endif
613         NULL
614 };
615
616 static int etm_read_instruction(etm_context_t *ctx, arm_instruction_t *instruction)
617 {
618         int i;
619         int section = -1;
620         uint32_t size_read;
621         uint32_t opcode;
622         int retval;
623
624         if (!ctx->image)
625                 return ERROR_TRACE_IMAGE_UNAVAILABLE;
626
627         /* search for the section the current instruction belongs to */
628         for (i = 0; i < ctx->image->num_sections; i++)
629         {
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))
632                 {
633                         section = i;
634                         break;
635                 }
636         }
637
638         if (section == -1)
639         {
640                 /* current instruction couldn't be found in the image */
641                 return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
642         }
643
644         if (ctx->core_state == ARMV4_5_STATE_ARM)
645         {
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)
650                 {
651                         LOG_ERROR("error while reading instruction: %i", retval);
652                         return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
653                 }
654                 opcode = target_buffer_get_u32(ctx->target, buf);
655                 arm_evaluate_opcode(opcode, ctx->current_pc, instruction);
656         }
657         else if (ctx->core_state == ARMV4_5_STATE_THUMB)
658         {
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)
663                 {
664                         LOG_ERROR("error while reading instruction: %i", retval);
665                         return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
666                 }
667                 opcode = target_buffer_get_u16(ctx->target, buf);
668                 thumb_evaluate_opcode(opcode, ctx->current_pc, instruction);
669         }
670         else if (ctx->core_state == ARMV4_5_STATE_JAZELLE)
671         {
672                 LOG_ERROR("BUG: tracing of jazelle code not supported");
673                 return ERROR_FAIL;
674         }
675         else
676         {
677                 LOG_ERROR("BUG: unknown core state encountered");
678                 return ERROR_FAIL;
679         }
680
681         return ERROR_OK;
682 }
683
684 static int etmv1_next_packet(etm_context_t *ctx, uint8_t *packet, int apo)
685 {
686         while (ctx->data_index < ctx->trace_depth)
687         {
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)
691                 {
692                         if (ctx->trace_data[ctx->data_index].flags & ETMV1_TRACESYNC_CYCLE)
693                                 apo--;
694
695                         if (apo > 0)
696                         {
697                                 ctx->data_index++;
698                                 ctx->data_half = 0;
699                         }
700                         continue;
701                 }
702
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))
707                 {
708                         ctx->data_index++;
709                         ctx->data_half = 0;
710                         continue;
711                 }
712
713                 if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_16BIT)
714                 {
715                         if (ctx->data_half == 0)
716                         {
717                                 *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
718                                 ctx->data_half = 1;
719                         }
720                         else
721                         {
722                                 *packet = (ctx->trace_data[ctx->data_index].packet & 0xff00) >> 8;
723                                 ctx->data_half = 0;
724                                 ctx->data_index++;
725                         }
726                 }
727                 else if ((ctx->portmode & ETM_PORT_WIDTH_MASK) == ETM_PORT_8BIT)
728                 {
729                         *packet = ctx->trace_data[ctx->data_index].packet & 0xff;
730                         ctx->data_index++;
731                 }
732                 else
733                 {
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;
737
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;
741                 }
742
743                 return 0;
744         }
745
746         return -1;
747 }
748
749 static int etmv1_branch_address(etm_context_t *ctx)
750 {
751         int retval;
752         uint8_t packet;
753         int shift = 0;
754         int apo;
755         uint32_t i;
756
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;
761
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;
768
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;
772
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++)
777         {
778                 if (ctx->trace_data[ctx->pipe_index + 1].pipestat & ETMV1_TRACESYNC_CYCLE)
779                         apo--;
780         }
781
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));
790
791         /* one last packet holding 4 bits of the address, plus the branch reason code */
792         if ((shift == 28) && (packet & 0x80))
793         {
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;
800         }
801         else
802         {
803                 ctx->last_branch_reason = 0;
804         }
805
806         if (shift == 32)
807         {
808                 ctx->pc_ok = 1;
809         }
810
811         /* if a full address was output, we might have branched into Jazelle state */
812         if ((shift == 32) && (packet & 0x80))
813         {
814                 ctx->core_state = ARMV4_5_STATE_JAZELLE;
815         }
816         else
817         {
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)
821                 {
822                         ctx->core_state = ARMV4_5_STATE_THUMB;
823                         ctx->last_branch &= ~0x1;
824                 }
825                 else
826                 {
827                         ctx->core_state = ARMV4_5_STATE_ARM;
828                         ctx->last_branch &= ~0x3;
829                 }
830         }
831
832         return 0;
833 }
834
835 static int etmv1_data(etm_context_t *ctx, int size, uint32_t *data)
836 {
837         int j;
838         uint8_t buf[4];
839         int retval;
840
841         for (j = 0; j < size; j++)
842         {
843                 if ((retval = etmv1_next_packet(ctx, &buf[j], 0)) != 0)
844                         return -1;
845         }
846
847         if (size == 8)
848         {
849                 LOG_ERROR("TODO: add support for 64-bit values");
850                 return -1;
851         }
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;
860
861         return 0;
862 }
863
864 static int etmv1_analyze_trace(etm_context_t *ctx, struct command_context_s *cmd_ctx)
865 {
866         int retval;
867         arm_instruction_t instruction;
868
869         /* read the trace data if it wasn't read already */
870         if (ctx->trace_depth == 0)
871                 ctx->capture_driver->read_trace(ctx);
872
873         /* start at the beginning of the captured trace */
874         ctx->pipe_index = 0;
875         ctx->data_index = 0;
876         ctx->data_half = 0;
877
878         /* neither the PC nor the data pointer are valid */
879         ctx->pc_ok = 0;
880         ctx->ptr_ok = 0;
881
882         while (ctx->pipe_index < ctx->trace_depth)
883         {
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;
892
893                 if (ctx->trace_data[ctx->pipe_index].flags & ETMV1_TRIGGER_CYCLE)
894                 {
895                         command_print(cmd_ctx, "--- trigger ---");
896                 }
897
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;
901
902                 /* if we don't have a valid pc skip until we reach an indirect branch */
903                 if ((!ctx->pc_ok) && (pipestat != STAT_BE))
904                 {
905                         ctx->pipe_index++;
906                         continue;
907                 }
908
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
912                  */
913                 if ((pipestat == STAT_BE) || (pipestat == STAT_BD))
914                 {
915                         /* backup current data index, to be able to consume the branch address
916                          * before examining data address and values
917                          */
918                         old_data_index = ctx->data_index;
919                         old_data_half = ctx->data_half;
920
921                         ctx->last_instruction = ctx->pipe_index;
922
923                         if ((retval = etmv1_branch_address(ctx)) != 0)
924                         {
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;
929
930                                 /* a positive return values means the current branch was abandoned,
931                                  * and a new branch was encountered in cycle ctx->pipe_index + retval;
932                                  */
933                                 LOG_WARNING("abandoned branch encountered, correctnes of analysis uncertain");
934                                 ctx->pipe_index += retval;
935                                 continue;
936                         }
937
938                         /* skip over APO cycles */
939                         ctx->pipe_index += 2;
940
941                         switch (ctx->last_branch_reason)
942                         {
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
968                                          */
969                                         if (!current_pc_ok)
970                                         {
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;
975                                         }
976                                         break;
977                                 default:        /* reserved */
978                                         LOG_ERROR("BUG: branch reason code 0x%" PRIx32 " is reserved", ctx->last_branch_reason);
979                                         return ERROR_FAIL;
980                         }
981
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
985                          */
986                         if (!ctx->pc_ok)
987                                 continue;
988
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)))
992                         {
993                                 if ((ctx->last_branch & 0xff) == 0x10)
994                                 {
995                                         command_print(cmd_ctx, "data abort");
996                                 }
997                                 else
998                                 {
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;
1003                                 }
1004                         }
1005                 }
1006
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))))
1012                 {
1013                         if ((retval = etm_read_instruction(ctx, &instruction)) != ERROR_OK)
1014                         {
1015                                 /* can't continue tracing with no image available */
1016                                 if (retval == ERROR_TRACE_IMAGE_UNAVAILABLE)
1017                                 {
1018                                         return retval;
1019                                 }
1020                                 else if (retval == ERROR_TRACE_INSTRUCTION_UNAVAILABLE)
1021                                 {
1022                                         /* TODO: handle incomplete images
1023                                          * for now we just quit the analsysis*/
1024                                         return retval;
1025                                 }
1026                         }
1027
1028                         cycles = old_index - last_instruction;
1029                 }
1030
1031                 if ((pipestat == STAT_ID) || (pipestat == STAT_BD))
1032                 {
1033                         uint32_t new_data_index = ctx->data_index;
1034                         uint32_t new_data_half = ctx->data_half;
1035
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)
1039                         {
1040                                 ctx->data_index = old_data_index;
1041                                 ctx->data_half = old_data_half;
1042                         }
1043
1044                         if (ctx->tracemode & ETMV1_TRACE_ADDR)
1045                         {
1046                                 uint8_t packet;
1047                                 int shift = 0;
1048
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));
1056
1057                                 if (shift >= 32)
1058                                         ctx->ptr_ok = 1;
1059
1060                                 if (ctx->ptr_ok)
1061                                 {
1062                                         command_print(cmd_ctx, "address: 0x%8.8" PRIx32 "", ctx->last_ptr);
1063                                 }
1064                         }
1065
1066                         if (ctx->tracemode & ETMV1_TRACE_DATA)
1067                         {
1068                                 if ((instruction.type == ARM_LDM) || (instruction.type == ARM_STM))
1069                                 {
1070                                         int i;
1071                                         for (i = 0; i < 16; i++)
1072                                         {
1073                                                 if (instruction.info.load_store_multiple.register_list & (1 << i))
1074                                                 {
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);
1079                                                 }
1080                                         }
1081                                 }
1082                                 else if ((instruction.type >= ARM_LDR) && (instruction.type <= ARM_STRH))
1083                                 {
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);
1088                                 }
1089                         }
1090
1091                         /* restore data index after consuming BD address and data */
1092                         if (pipestat == STAT_BD)
1093                         {
1094                                 ctx->data_index = new_data_index;
1095                                 ctx->data_half = new_data_half;
1096                         }
1097                 }
1098
1099                 /* adjust PC */
1100                 if ((pipestat == STAT_IE) || (pipestat == STAT_ID))
1101                 {
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))
1106                         {
1107                                 next_pc = instruction.info.b_bl_bx_blx.target_address;
1108                         }
1109                         else
1110                         {
1111                                 next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1112                         }
1113                 }
1114                 else if (pipestat == STAT_IN)
1115                 {
1116                         next_pc += (ctx->core_state == ARMV4_5_STATE_ARM) ? 4 : 2;
1117                 }
1118
1119                 if ((pipestat != STAT_TD) && (pipestat != STAT_WT))
1120                 {
1121                         char cycles_text[32] = "";
1122
1123                         /* if the trace was captured with cycle accurate tracing enabled,
1124                          * output the number of cycles since the last executed instruction
1125                          */
1126                         if (ctx->tracemode & ETMV1_CYCLE_ACCURATE)
1127                         {
1128                                 snprintf(cycles_text, 32, " (%i %s)",
1129                                          (int)cycles,
1130                                         (cycles == 1) ? "cycle" : "cycles");
1131                         }
1132
1133                         command_print(cmd_ctx, "%s%s%s",
1134                                 instruction.text,
1135                                 (pipestat == STAT_IN) ? " (not executed)" : "",
1136                                 cycles_text);
1137
1138                         ctx->current_pc = next_pc;
1139
1140                         /* packets for an instruction don't start on or before the preceding
1141                          * functional pipestat (i.e. other than WT or TD)
1142                          */
1143                         if (ctx->data_index <= ctx->pipe_index)
1144                         {
1145                                 ctx->data_index = ctx->pipe_index + 1;
1146                                 ctx->data_half = 0;
1147                         }
1148                 }
1149
1150                 ctx->pipe_index += 1;
1151         }
1152
1153         return ERROR_OK;
1154 }
1155
1156 static int handle_etm_tracemode_command_update(
1157                 struct command_context_s *cmd_ctx,
1158                 char **args, etmv1_tracemode_t *mode)
1159 {
1160         etmv1_tracemode_t tracemode;
1161
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
1172         {
1173                 command_print(cmd_ctx, "invalid option '%s'", args[0]);
1174                 return ERROR_INVALID_ARGUMENTS;
1175         }
1176
1177         uint8_t context_id;
1178         COMMAND_PARSE_NUMBER(u8, args[1], context_id);
1179         switch (context_id)
1180         {
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;
1196         }
1197
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
1203         {
1204                 command_print(cmd_ctx, "invalid option '%s'", args[2]);
1205                 return ERROR_INVALID_ARGUMENTS;
1206         }
1207
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
1213         {
1214                 command_print(cmd_ctx, "invalid option '%s'", args[3]);
1215                 return ERROR_INVALID_ARGUMENTS;
1216         }
1217
1218         /* IGNORED:
1219          *  - CPRT tracing (coprocessor register transfers)
1220          *  - debug request (causes debug entry on trigger)
1221          *  - stall on FIFOFULL (preventing tracedata lossage)
1222          */
1223         *mode = tracemode;
1224
1225         return ERROR_OK;
1226 }
1227
1228 static int handle_etm_tracemode_command(struct command_context_s *cmd_ctx,
1229                 char *cmd, char **args, int argc)
1230 {
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;
1235
1236         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1237         {
1238                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1239                 return ERROR_FAIL;
1240         }
1241
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;
1246         }
1247
1248         etmv1_tracemode_t tracemode = etm->tracemode;
1249
1250         switch (argc)
1251         {
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;
1262         }
1263
1264         /**
1265          * todo: fail if parameters were invalid for this hardware,
1266          * or couldn't be written; display actual hardware state...
1267          */
1268
1269         command_print(cmd_ctx, "current tracemode configuration:");
1270
1271         switch (tracemode & ETMV1_TRACE_MASK)
1272         {
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;
1285         }
1286
1287         switch (tracemode & ETMV1_CONTEXTID_MASK)
1288         {
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;
1301         }
1302
1303         if (tracemode & ETMV1_CYCLE_ACCURATE)
1304         {
1305                 command_print(cmd_ctx, "cycle-accurate tracing enabled");
1306         }
1307         else
1308         {
1309                 command_print(cmd_ctx, "cycle-accurate tracing disabled");
1310         }
1311
1312         if (tracemode & ETMV1_BRANCH_OUTPUT)
1313         {
1314                 command_print(cmd_ctx, "full branch address output enabled");
1315         }
1316         else
1317         {
1318                 command_print(cmd_ctx, "full branch address output disabled");
1319         }
1320
1321         /* only update ETM_CTRL register if tracemode changed */
1322         if (etm->tracemode != tracemode)
1323         {
1324                 reg_t *etm_ctrl_reg;
1325
1326                 etm_ctrl_reg = etm_reg_lookup(etm, ETM_CTRL);
1327                 if (!etm_ctrl_reg)
1328                         return ERROR_FAIL;
1329
1330                 etm_get_reg(etm_ctrl_reg);
1331
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);
1337
1338                 etm->tracemode = tracemode;
1339
1340                 /* invalidate old trace data */
1341                 etm->capture_status = TRACE_IDLE;
1342                 if (etm->trace_depth > 0)
1343                 {
1344                         free(etm->trace_data);
1345                         etm->trace_data = NULL;
1346                 }
1347                 etm->trace_depth = 0;
1348         }
1349
1350         return ERROR_OK;
1351 }
1352
1353 static int handle_etm_config_command(struct command_context_s *cmd_ctx,
1354                 char *cmd, char **args, int argc)
1355 {
1356         target_t *target;
1357         armv4_5_common_t *armv4_5;
1358         arm7_9_common_t *arm7_9;
1359         etm_portmode_t portmode = 0x0;
1360         struct etm *etm_ctx;
1361         int i;
1362
1363         if (argc != 5)
1364                 return ERROR_COMMAND_SYNTAX_ERROR;
1365
1366         target = get_target(args[0]);
1367         if (!target)
1368         {
1369                 LOG_ERROR("target '%s' not defined", args[0]);
1370                 return ERROR_FAIL;
1371         }
1372
1373         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1374         {
1375                 command_print(cmd_ctx, "target '%s' is '%s'; not an ARM",
1376                                 target->cmd_name, target_get_name(target));
1377                 return ERROR_FAIL;
1378         }
1379
1380         uint8_t port_width;
1381         COMMAND_PARSE_NUMBER(u8, args[1], port_width);
1382         switch (port_width)
1383         {
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;
1396         }
1397
1398         if (strcmp("normal", args[2]) == 0)
1399         {
1400                 portmode |= ETM_PORT_NORMAL;
1401         }
1402         else if (strcmp("multiplexed", args[2]) == 0)
1403         {
1404                 portmode |= ETM_PORT_MUXED;
1405         }
1406         else if (strcmp("demultiplexed", args[2]) == 0)
1407         {
1408                 portmode |= ETM_PORT_DEMUXED;
1409         }
1410         else
1411         {
1412                 command_print(cmd_ctx, "unsupported ETM port mode '%s', must be 'normal', 'multiplexed' or 'demultiplexed'", args[2]);
1413                 return ERROR_FAIL;
1414         }
1415
1416         if (strcmp("half", args[3]) == 0)
1417         {
1418                 portmode |= ETM_PORT_HALF_CLOCK;
1419         }
1420         else if (strcmp("full", args[3]) == 0)
1421         {
1422                 portmode |= ETM_PORT_FULL_CLOCK;
1423         }
1424         else
1425         {
1426                 command_print(cmd_ctx, "unsupported ETM port clocking '%s', must be 'full' or 'half'", args[3]);
1427                 return ERROR_FAIL;
1428         }
1429
1430         etm_ctx = calloc(1, sizeof(etm_context_t));
1431         if (!etm_ctx) {
1432                 LOG_DEBUG("out of memory");
1433                 return ERROR_FAIL;
1434         }
1435
1436         for (i = 0; etm_capture_drivers[i]; i++)
1437         {
1438                 if (strcmp(args[4], etm_capture_drivers[i]->name) == 0)
1439                 {
1440                         int retval;
1441                         if ((retval = etm_capture_drivers[i]->register_commands(cmd_ctx)) != ERROR_OK)
1442                         {
1443                                 free(etm_ctx);
1444                                 return retval;
1445                         }
1446
1447                         etm_ctx->capture_driver = etm_capture_drivers[i];
1448
1449                         break;
1450                 }
1451         }
1452
1453         if (!etm_capture_drivers[i])
1454         {
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;
1459         }
1460
1461         etm_ctx->target = target;
1462         etm_ctx->trigger_percent = 50;
1463         etm_ctx->trace_data = NULL;
1464         etm_ctx->trace_depth = 0;
1465         etm_ctx->portmode = portmode;
1466         etm_ctx->tracemode = 0x0;
1467         etm_ctx->core_state = ARMV4_5_STATE_ARM;
1468         etm_ctx->image = NULL;
1469         etm_ctx->pipe_index = 0;
1470         etm_ctx->data_index = 0;
1471         etm_ctx->current_pc = 0x0;
1472         etm_ctx->pc_ok = 0;
1473         etm_ctx->last_branch = 0x0;
1474         etm_ctx->last_branch_reason = 0x0;
1475         etm_ctx->last_ptr = 0x0;
1476         etm_ctx->ptr_ok = 0x0;
1477         etm_ctx->last_instruction = 0;
1478
1479         arm7_9->etm_ctx = etm_ctx;
1480
1481         return etm_register_user_commands(cmd_ctx);
1482 }
1483
1484 static int handle_etm_info_command(struct command_context_s *cmd_ctx,
1485                 char *cmd, char **args, int argc)
1486 {
1487         target_t *target;
1488         armv4_5_common_t *armv4_5;
1489         arm7_9_common_t *arm7_9;
1490         etm_context_t *etm;
1491         reg_t *etm_sys_config_reg;
1492
1493         int max_port_size;
1494
1495         target = get_current_target(cmd_ctx);
1496
1497         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1498         {
1499                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1500                 return ERROR_FAIL;
1501         }
1502
1503         etm = arm7_9->etm_ctx;
1504         if (!etm)
1505         {
1506                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1507                 return ERROR_FAIL;
1508         }
1509
1510         command_print(cmd_ctx, "ETM v%d.%d",
1511                         etm->bcd_vers >> 4, etm->bcd_vers & 0xf);
1512         command_print(cmd_ctx, "pairs of address comparators: %i",
1513                         (int) (etm->config >> 0) & 0x0f);
1514         command_print(cmd_ctx, "data comparators: %i",
1515                         (int) (etm->config >> 4) & 0x0f);
1516         command_print(cmd_ctx, "memory map decoders: %i",
1517                         (int) (etm->config >> 8) & 0x1f);
1518         command_print(cmd_ctx, "number of counters: %i",
1519                         (int) (etm->config >> 13) & 0x07);
1520         command_print(cmd_ctx, "sequencer %spresent",
1521                         (int) (etm->config & (1 << 16)) ? "" : "not ");
1522         command_print(cmd_ctx, "number of ext. inputs: %i",
1523                         (int) (etm->config >> 17) & 0x07);
1524         command_print(cmd_ctx, "number of ext. outputs: %i",
1525                         (int) (etm->config >> 20) & 0x07);
1526         command_print(cmd_ctx, "FIFO full %spresent",
1527                         (int) (etm->config & (1 << 23)) ? "" : "not ");
1528         if (etm->bcd_vers < 0x20)
1529                 command_print(cmd_ctx, "protocol version: %i",
1530                                 (int) (etm->config >> 28) & 0x07);
1531         else {
1532                 command_print(cmd_ctx, "trace start/stop %spresent",
1533                                 (etm->config & (1 << 26)) ? "" : "not ");
1534                 command_print(cmd_ctx, "number of context comparators: %i",
1535                                 (int) (etm->config >> 24) & 0x03);
1536         }
1537
1538         /* SYS_CONFIG isn't present before ETMv1.2 */
1539         etm_sys_config_reg = etm_reg_lookup(etm, ETM_SYS_CONFIG);
1540         if (!etm_sys_config_reg)
1541                 return ERROR_OK;
1542
1543         etm_get_reg(etm_sys_config_reg);
1544
1545         switch (buf_get_u32(etm_sys_config_reg->value, 0, 3))
1546         {
1547                 case 0:
1548                         max_port_size = 4;
1549                         break;
1550                 case 1:
1551                         max_port_size = 8;
1552                         break;
1553                 case 2:
1554                         max_port_size = 16;
1555                         break;
1556                 default:
1557                         LOG_ERROR("Illegal max_port_size");
1558                         return ERROR_FAIL;
1559         }
1560         command_print(cmd_ctx, "max. port size: %i", max_port_size);
1561
1562         command_print(cmd_ctx, "half-rate clocking %ssupported",
1563                         (buf_get_u32(etm_sys_config_reg->value, 3, 1) == 1) ? "" : "not ");
1564         command_print(cmd_ctx, "full-rate clocking %ssupported",
1565                         (buf_get_u32(etm_sys_config_reg->value, 4, 1) == 1) ? "" : "not ");
1566         command_print(cmd_ctx, "normal trace format %ssupported",
1567                         (buf_get_u32(etm_sys_config_reg->value, 5, 1) == 1) ? "" : "not ");
1568         command_print(cmd_ctx, "multiplex trace format %ssupported",
1569                         (buf_get_u32(etm_sys_config_reg->value, 6, 1) == 1) ? "" : "not ");
1570         command_print(cmd_ctx, "demultiplex trace format %ssupported",
1571                         (buf_get_u32(etm_sys_config_reg->value, 7, 1) == 1) ? "" : "not ");
1572         command_print(cmd_ctx, "FIFO full %ssupported",
1573                         (buf_get_u32(etm_sys_config_reg->value, 8, 1) == 1) ? "" : "not ");
1574
1575         return ERROR_OK;
1576 }
1577
1578 static int handle_etm_status_command(struct command_context_s *cmd_ctx,
1579                 char *cmd, char **args, int argc)
1580 {
1581         target_t *target;
1582         armv4_5_common_t *armv4_5;
1583         arm7_9_common_t *arm7_9;
1584         etm_context_t *etm;
1585         trace_status_t trace_status;
1586
1587         target = get_current_target(cmd_ctx);
1588
1589         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1590         {
1591                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1592                 return ERROR_FAIL;
1593         }
1594
1595         if (!arm7_9->etm_ctx)
1596         {
1597                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1598                 return ERROR_FAIL;
1599         }
1600         etm = arm7_9->etm_ctx;
1601
1602         /* ETM status */
1603         if (etm->bcd_vers >= 0x11) {
1604                 reg_t *reg;
1605
1606                 reg = etm_reg_lookup(etm, ETM_STATUS);
1607                 if (!reg)
1608                         return ERROR_FAIL;
1609                 if (etm_get_reg(reg) == ERROR_OK) {
1610                         unsigned s = buf_get_u32(reg->value, 0, reg->size);
1611
1612                         command_print(cmd_ctx, "etm: %s%s%s%s",
1613                                 /* bit(1) == progbit */
1614                                 (etm->bcd_vers >= 0x12)
1615                                         ? ((s & (1 << 1))
1616                                                 ? "disabled" : "enabled")
1617                                         : "?",
1618                                 ((s & (1 << 3)) && etm->bcd_vers >= 0x31)
1619                                         ? " triggered" : "",
1620                                 ((s & (1 << 2)) && etm->bcd_vers >= 0x12)
1621                                         ? " start/stop" : "",
1622                                 ((s & (1 << 0)) && etm->bcd_vers >= 0x11)
1623                                         ? " untraced-overflow" : "");
1624                 } /* else ignore and try showing trace port status */
1625         }
1626
1627         /* Trace Port Driver status */
1628         trace_status = etm->capture_driver->status(etm);
1629         if (trace_status == TRACE_IDLE)
1630         {
1631                 command_print(cmd_ctx, "%s: idle", etm->capture_driver->name);
1632         }
1633         else
1634         {
1635                 static char *completed = " completed";
1636                 static char *running = " is running";
1637                 static char *overflowed = ", overflowed";
1638                 static char *triggered = ", triggered";
1639
1640                 command_print(cmd_ctx, "%s: trace collection%s%s%s",
1641                         etm->capture_driver->name,
1642                         (trace_status & TRACE_RUNNING) ? running : completed,
1643                         (trace_status & TRACE_OVERFLOWED) ? overflowed : "",
1644                         (trace_status & TRACE_TRIGGERED) ? triggered : "");
1645
1646                 if (etm->trace_depth > 0)
1647                 {
1648                         command_print(cmd_ctx, "%i frames of trace data read",
1649                                         (int)(etm->trace_depth));
1650                 }
1651         }
1652
1653         return ERROR_OK;
1654 }
1655
1656 static int handle_etm_image_command(struct command_context_s *cmd_ctx,
1657                 char *cmd, char **args, int argc)
1658 {
1659         target_t *target;
1660         armv4_5_common_t *armv4_5;
1661         arm7_9_common_t *arm7_9;
1662         etm_context_t *etm_ctx;
1663
1664         if (argc < 1)
1665         {
1666                 command_print(cmd_ctx, "usage: etm image <file> [base address] [type]");
1667                 return ERROR_FAIL;
1668         }
1669
1670         target = get_current_target(cmd_ctx);
1671
1672         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1673         {
1674                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1675                 return ERROR_FAIL;
1676         }
1677
1678         if (!(etm_ctx = arm7_9->etm_ctx))
1679         {
1680                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1681                 return ERROR_FAIL;
1682         }
1683
1684         if (etm_ctx->image)
1685         {
1686                 image_close(etm_ctx->image);
1687                 free(etm_ctx->image);
1688                 command_print(cmd_ctx, "previously loaded image found and closed");
1689         }
1690
1691         etm_ctx->image = malloc(sizeof(image_t));
1692         etm_ctx->image->base_address_set = 0;
1693         etm_ctx->image->start_address_set = 0;
1694
1695         /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1696         if (argc >= 2)
1697         {
1698                 etm_ctx->image->base_address_set = 1;
1699                 COMMAND_PARSE_NUMBER(int, args[1], etm_ctx->image->base_address);
1700         }
1701         else
1702         {
1703                 etm_ctx->image->base_address_set = 0;
1704         }
1705
1706         if (image_open(etm_ctx->image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
1707         {
1708                 free(etm_ctx->image);
1709                 etm_ctx->image = NULL;
1710                 return ERROR_FAIL;
1711         }
1712
1713         return ERROR_OK;
1714 }
1715
1716 static int handle_etm_dump_command(struct command_context_s *cmd_ctx,
1717                 char *cmd, char **args, int argc)
1718 {
1719         fileio_t file;
1720         target_t *target;
1721         armv4_5_common_t *armv4_5;
1722         arm7_9_common_t *arm7_9;
1723         etm_context_t *etm_ctx;
1724         uint32_t i;
1725
1726         if (argc != 1)
1727         {
1728                 command_print(cmd_ctx, "usage: etm dump <file>");
1729                 return ERROR_FAIL;
1730         }
1731
1732         target = get_current_target(cmd_ctx);
1733
1734         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1735         {
1736                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1737                 return ERROR_FAIL;
1738         }
1739
1740         if (!(etm_ctx = arm7_9->etm_ctx))
1741         {
1742                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1743                 return ERROR_FAIL;
1744         }
1745
1746         if (etm_ctx->capture_driver->status == TRACE_IDLE)
1747         {
1748                 command_print(cmd_ctx, "trace capture wasn't enabled, no trace data captured");
1749                 return ERROR_OK;
1750         }
1751
1752         if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1753         {
1754                 /* TODO: if on-the-fly capture is to be supported, this needs to be changed */
1755                 command_print(cmd_ctx, "trace capture not completed");
1756                 return ERROR_FAIL;
1757         }
1758
1759         /* read the trace data if it wasn't read already */
1760         if (etm_ctx->trace_depth == 0)
1761                 etm_ctx->capture_driver->read_trace(etm_ctx);
1762
1763         if (fileio_open(&file, args[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
1764         {
1765                 return ERROR_FAIL;
1766         }
1767
1768         fileio_write_u32(&file, etm_ctx->capture_status);
1769         fileio_write_u32(&file, etm_ctx->portmode);
1770         fileio_write_u32(&file, etm_ctx->tracemode);
1771         fileio_write_u32(&file, etm_ctx->trace_depth);
1772
1773         for (i = 0; i < etm_ctx->trace_depth; i++)
1774         {
1775                 fileio_write_u32(&file, etm_ctx->trace_data[i].pipestat);
1776                 fileio_write_u32(&file, etm_ctx->trace_data[i].packet);
1777                 fileio_write_u32(&file, etm_ctx->trace_data[i].flags);
1778         }
1779
1780         fileio_close(&file);
1781
1782         return ERROR_OK;
1783 }
1784
1785 static int handle_etm_load_command(struct command_context_s *cmd_ctx,
1786                 char *cmd, char **args, int argc)
1787 {
1788         fileio_t file;
1789         target_t *target;
1790         armv4_5_common_t *armv4_5;
1791         arm7_9_common_t *arm7_9;
1792         etm_context_t *etm_ctx;
1793         uint32_t i;
1794
1795         if (argc != 1)
1796         {
1797                 command_print(cmd_ctx, "usage: etm load <file>");
1798                 return ERROR_FAIL;
1799         }
1800
1801         target = get_current_target(cmd_ctx);
1802
1803         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1804         {
1805                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1806                 return ERROR_FAIL;
1807         }
1808
1809         if (!(etm_ctx = arm7_9->etm_ctx))
1810         {
1811                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1812                 return ERROR_FAIL;
1813         }
1814
1815         if (etm_ctx->capture_driver->status(etm_ctx) & TRACE_RUNNING)
1816         {
1817                 command_print(cmd_ctx, "trace capture running, stop first");
1818                 return ERROR_FAIL;
1819         }
1820
1821         if (fileio_open(&file, args[0], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
1822         {
1823                 return ERROR_FAIL;
1824         }
1825
1826         if (file.size % 4)
1827         {
1828                 command_print(cmd_ctx, "size isn't a multiple of 4, no valid trace data");
1829                 fileio_close(&file);
1830                 return ERROR_FAIL;
1831         }
1832
1833         if (etm_ctx->trace_depth > 0)
1834         {
1835                 free(etm_ctx->trace_data);
1836                 etm_ctx->trace_data = NULL;
1837         }
1838
1839         {
1840           uint32_t tmp;
1841           fileio_read_u32(&file, &tmp); etm_ctx->capture_status = tmp;
1842           fileio_read_u32(&file, &tmp); etm_ctx->portmode = tmp;
1843           fileio_read_u32(&file, &tmp); etm_ctx->tracemode = tmp;
1844           fileio_read_u32(&file, &etm_ctx->trace_depth);
1845         }
1846         etm_ctx->trace_data = malloc(sizeof(etmv1_trace_data_t) * etm_ctx->trace_depth);
1847         if (etm_ctx->trace_data == NULL)
1848         {
1849                 command_print(cmd_ctx, "not enough memory to perform operation");
1850                 fileio_close(&file);
1851                 return ERROR_FAIL;
1852         }
1853
1854         for (i = 0; i < etm_ctx->trace_depth; i++)
1855         {
1856                 uint32_t pipestat, packet, flags;
1857                 fileio_read_u32(&file, &pipestat);
1858                 fileio_read_u32(&file, &packet);
1859                 fileio_read_u32(&file, &flags);
1860                 etm_ctx->trace_data[i].pipestat = pipestat & 0xff;
1861                 etm_ctx->trace_data[i].packet = packet & 0xffff;
1862                 etm_ctx->trace_data[i].flags = flags;
1863         }
1864
1865         fileio_close(&file);
1866
1867         return ERROR_OK;
1868 }
1869
1870 static int handle_etm_trigger_percent_command(struct command_context_s *cmd_ctx,
1871                 char *cmd, char **args, int argc)
1872 {
1873         target_t *target;
1874         armv4_5_common_t *armv4_5;
1875         arm7_9_common_t *arm7_9;
1876         etm_context_t *etm_ctx;
1877
1878         target = get_current_target(cmd_ctx);
1879
1880         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1881         {
1882                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1883                 return ERROR_FAIL;
1884         }
1885
1886         if (!(etm_ctx = arm7_9->etm_ctx))
1887         {
1888                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1889                 return ERROR_FAIL;
1890         }
1891
1892         if (argc > 0)
1893         {
1894                 uint32_t new_value;
1895                 COMMAND_PARSE_NUMBER(u32, args[0], new_value);
1896
1897                 if ((new_value < 2) || (new_value > 100))
1898                 {
1899                         command_print(cmd_ctx, "valid settings are 2%% to 100%%");
1900                 }
1901                 else
1902                 {
1903                         etm_ctx->trigger_percent = new_value;
1904                 }
1905         }
1906
1907         command_print(cmd_ctx, "%i percent of the tracebuffer reserved for after the trigger", ((int)(etm_ctx->trigger_percent)));
1908
1909         return ERROR_OK;
1910 }
1911
1912 static int handle_etm_start_command(struct command_context_s *cmd_ctx,
1913                 char *cmd, char **args, int argc)
1914 {
1915         target_t *target;
1916         armv4_5_common_t *armv4_5;
1917         arm7_9_common_t *arm7_9;
1918         etm_context_t *etm_ctx;
1919         reg_t *etm_ctrl_reg;
1920
1921         target = get_current_target(cmd_ctx);
1922
1923         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1924         {
1925                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1926                 return ERROR_FAIL;
1927         }
1928
1929         etm_ctx = arm7_9->etm_ctx;
1930         if (!etm_ctx)
1931         {
1932                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1933                 return ERROR_FAIL;
1934         }
1935
1936         /* invalidate old tracing data */
1937         etm_ctx->capture_status = TRACE_IDLE;
1938         if (etm_ctx->trace_depth > 0)
1939         {
1940                 free(etm_ctx->trace_data);
1941                 etm_ctx->trace_data = NULL;
1942         }
1943         etm_ctx->trace_depth = 0;
1944
1945         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
1946         if (!etm_ctrl_reg)
1947                 return ERROR_FAIL;
1948
1949         etm_get_reg(etm_ctrl_reg);
1950
1951         /* Clear programming bit (10), set port selection bit (11) */
1952         buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x2);
1953
1954         etm_store_reg(etm_ctrl_reg);
1955         jtag_execute_queue();
1956
1957         etm_ctx->capture_driver->start_capture(etm_ctx);
1958
1959         return ERROR_OK;
1960 }
1961
1962 static int handle_etm_stop_command(struct command_context_s *cmd_ctx,
1963                 char *cmd, char **args, int argc)
1964 {
1965         target_t *target;
1966         armv4_5_common_t *armv4_5;
1967         arm7_9_common_t *arm7_9;
1968         etm_context_t *etm_ctx;
1969         reg_t *etm_ctrl_reg;
1970
1971         target = get_current_target(cmd_ctx);
1972
1973         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
1974         {
1975                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
1976                 return ERROR_FAIL;
1977         }
1978
1979         if (!(etm_ctx = arm7_9->etm_ctx))
1980         {
1981                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
1982                 return ERROR_FAIL;
1983         }
1984
1985         etm_ctrl_reg = etm_reg_lookup(etm_ctx, ETM_CTRL);
1986         if (!etm_ctrl_reg)
1987                 return ERROR_FAIL;
1988
1989         etm_get_reg(etm_ctrl_reg);
1990
1991         /* Set programming bit (10), clear port selection bit (11) */
1992         buf_set_u32(etm_ctrl_reg->value, 10, 2, 0x1);
1993
1994         etm_store_reg(etm_ctrl_reg);
1995         jtag_execute_queue();
1996
1997         etm_ctx->capture_driver->stop_capture(etm_ctx);
1998
1999         return ERROR_OK;
2000 }
2001
2002 static int handle_etm_analyze_command(struct command_context_s *cmd_ctx,
2003                 char *cmd, char **args, int argc)
2004 {
2005         target_t *target;
2006         armv4_5_common_t *armv4_5;
2007         arm7_9_common_t *arm7_9;
2008         etm_context_t *etm_ctx;
2009         int retval;
2010
2011         target = get_current_target(cmd_ctx);
2012
2013         if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
2014         {
2015                 command_print(cmd_ctx, "ETM: current target isn't an ARM");
2016                 return ERROR_FAIL;
2017         }
2018
2019         if (!(etm_ctx = arm7_9->etm_ctx))
2020         {
2021                 command_print(cmd_ctx, "current target doesn't have an ETM configured");
2022                 return ERROR_FAIL;
2023         }
2024
2025         if ((retval = etmv1_analyze_trace(etm_ctx, cmd_ctx)) != ERROR_OK)
2026         {
2027                 switch (retval)
2028                 {
2029                         case ERROR_ETM_ANALYSIS_FAILED:
2030                                 command_print(cmd_ctx, "further analysis failed (corrupted trace data or just end of data");
2031                                 break;
2032                         case ERROR_TRACE_INSTRUCTION_UNAVAILABLE:
2033                                 command_print(cmd_ctx, "no instruction for current address available, analysis aborted");
2034                                 break;
2035                         case ERROR_TRACE_IMAGE_UNAVAILABLE:
2036                                 command_print(cmd_ctx, "no image available for trace analysis");
2037                                 break;
2038                         default:
2039                                 command_print(cmd_ctx, "unknown error: %i", retval);
2040                 }
2041         }
2042
2043         return retval;
2044 }
2045
2046 int etm_register_commands(struct command_context_s *cmd_ctx)
2047 {
2048         etm_cmd = register_command(cmd_ctx, NULL, "etm", NULL, COMMAND_ANY, "Embedded Trace Macrocell");
2049
2050         register_command(cmd_ctx, etm_cmd, "config", handle_etm_config_command,
2051                 COMMAND_CONFIG, "etm config <target> <port_width> <port_mode> <clocking> <capture_driver>");
2052
2053         return ERROR_OK;
2054 }
2055
2056 static int etm_register_user_commands(struct command_context_s *cmd_ctx)
2057 {
2058         register_command(cmd_ctx, etm_cmd, "tracemode", handle_etm_tracemode_command,
2059                 COMMAND_EXEC, "configure/display trace mode: "
2060                         "<none | data | address | all> "
2061                         "<context_id_bits> <cycle_accurate> <branch_output>");
2062
2063         register_command(cmd_ctx, etm_cmd, "info", handle_etm_info_command,
2064                 COMMAND_EXEC, "display info about the current target's ETM");
2065
2066         register_command(cmd_ctx, etm_cmd, "trigger_percent", handle_etm_trigger_percent_command,
2067                 COMMAND_EXEC, "amount (<percent>) of trace buffer to be filled after the trigger occured");
2068         register_command(cmd_ctx, etm_cmd, "status", handle_etm_status_command,
2069                 COMMAND_EXEC, "display current target's ETM status");
2070         register_command(cmd_ctx, etm_cmd, "start", handle_etm_start_command,
2071                 COMMAND_EXEC, "start ETM trace collection");
2072         register_command(cmd_ctx, etm_cmd, "stop", handle_etm_stop_command,
2073                 COMMAND_EXEC, "stop ETM trace collection");
2074
2075         register_command(cmd_ctx, etm_cmd, "analyze", handle_etm_analyze_command,
2076                 COMMAND_EXEC, "anaylze collected ETM trace");
2077
2078         register_command(cmd_ctx, etm_cmd, "image", handle_etm_image_command,
2079                 COMMAND_EXEC, "load image from <file> [base address]");
2080
2081         register_command(cmd_ctx, etm_cmd, "dump", handle_etm_dump_command,
2082                 COMMAND_EXEC, "dump captured trace data <file>");
2083         register_command(cmd_ctx, etm_cmd, "load", handle_etm_load_command,
2084                 COMMAND_EXEC, "load trace data for analysis <file>");
2085
2086         return ERROR_OK;
2087 }