1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2005, 2007 by Dominic Rath *
5 * Dominic.Rath@gmx.de *
7 * Copyright (C) 2007 by Vincent Palatin *
8 * vincent.palatin_openocd@m4x.org *
9 ***************************************************************************/
11 #ifndef OPENOCD_TARGET_ETM_H
12 #define OPENOCD_TARGET_ETM_H
19 /* ETM registers (JTAG protocol) */
23 ETM_TRIG_EVENT
= 0x02,
26 ETM_SYS_CONFIG
= 0x05,
27 ETM_TRACE_RESOURCE_CTRL
= 0x06,
28 ETM_TRACE_EN_CTRL2
= 0x07,
29 ETM_TRACE_EN_EVENT
= 0x08,
30 ETM_TRACE_EN_CTRL1
= 0x09,
31 /* optional FIFOFULL */
32 ETM_FIFOFULL_REGION
= 0x0a,
33 ETM_FIFOFULL_LEVEL
= 0x0b,
34 /* viewdata support */
35 ETM_VIEWDATA_EVENT
= 0x0c,
36 ETM_VIEWDATA_CTRL1
= 0x0d,
37 ETM_VIEWDATA_CTRL2
= 0x0e, /* optional */
38 ETM_VIEWDATA_CTRL3
= 0x0f,
39 /* N pairs of ADDR_{COMPARATOR,ACCESS} registers */
40 ETM_ADDR_COMPARATOR_VALUE
= 0x10,
41 ETM_ADDR_ACCESS_TYPE
= 0x20,
42 /* N pairs of DATA_COMPARATOR_{VALUE,MASK} registers */
43 ETM_DATA_COMPARATOR_VALUE
= 0x30,
44 ETM_DATA_COMPARATOR_MASK
= 0x40,
45 /* N quads of COUNTER_{RELOAD_{VALUE,EVENT},ENABLE,VALUE} registers */
46 ETM_COUNTER_RELOAD_VALUE
= 0x50,
47 ETM_COUNTER_ENABLE
= 0x54,
48 ETM_COUNTER_RELOAD_EVENT
= 0x58,
49 ETM_COUNTER_VALUE
= 0x5c,
50 /* 6 sequencer event transitions */
51 ETM_SEQUENCER_EVENT
= 0x60,
52 ETM_SEQUENCER_STATE
= 0x67,
53 /* N triggered outputs */
54 ETM_EXTERNAL_OUTPUT
= 0x68,
56 ETM_CONTEXTID_COMPARATOR_VALUE
= 0x6c,
57 ETM_CONTEXTID_COMPARATOR_MASK
= 0x6f,
63 const struct etm_reg_info
*reg_info
;
64 struct arm_jtag
*jtag_info
;
67 /* Subset of ETM_CTRL bit assignments. Many of these
68 * control the configuration of trace output, which
69 * hooks up either to ETB or to an external device.
71 * NOTE that these have evolved since the ~v1.3 defns ...
74 ETM_CTRL_POWERDOWN
= (1 << 0),
75 ETM_CTRL_MONITOR_CPRT
= (1 << 1),
77 /* bits 3:2 == trace type */
78 ETM_CTRL_TRACE_DATA
= (1 << 2),
79 ETM_CTRL_TRACE_ADDR
= (2 << 2),
80 ETM_CTRL_TRACE_MASK
= (3 << 2),
82 /* Port width (bits 21 and 6:4) */
85 ETM_PORT_16BIT
= 0x20,
86 ETM_PORT_24BIT
= 0x30,
87 ETM_PORT_32BIT
= 0x40,
88 ETM_PORT_48BIT
= 0x50,
89 ETM_PORT_64BIT
= 0x60,
90 ETM_PORT_1BIT
= 0x00 | (1 << 21),
91 ETM_PORT_2BIT
= 0x10 | (1 << 21),
92 ETM_PORT_WIDTH_MASK
= 0x70 | (1 << 21),
94 ETM_CTRL_FIFOFULL_STALL
= (1 << 7),
95 ETM_CTRL_BRANCH_OUTPUT
= (1 << 8),
96 ETM_CTRL_DBGRQ
= (1 << 9),
97 ETM_CTRL_ETM_PROG
= (1 << 10),
98 ETM_CTRL_ETMEN
= (1 << 11),
99 ETM_CTRL_CYCLE_ACCURATE
= (1 << 12),
101 /* Clocking modes -- up to v2.1, bit 13 */
102 ETM_PORT_FULL_CLOCK
= (0 << 13),
103 ETM_PORT_HALF_CLOCK
= (1 << 13),
104 ETM_PORT_CLOCK_MASK
= (1 << 13),
106 /* bits 15:14 == context ID size used in tracing */
107 ETM_CTRL_CONTEXTID_NONE
= (0 << 14),
108 ETM_CTRL_CONTEXTID_8
= (1 << 14),
109 ETM_CTRL_CONTEXTID_16
= (2 << 14),
110 ETM_CTRL_CONTEXTID_32
= (3 << 14),
111 ETM_CTRL_CONTEXTID_MASK
= (3 << 14),
113 /* Port modes -- bits 17:16, tied to clocking mode */
114 ETM_PORT_NORMAL
= (0 << 16),
115 ETM_PORT_MUXED
= (1 << 16),
116 ETM_PORT_DEMUXED
= (2 << 16),
117 ETM_PORT_MODE_MASK
= (3 << 16),
119 /* bits 31:18 defined in v3.0 and later (e.g. ARM11+) */
122 /* forward-declare ETM context */
125 struct etm_capture_driver
{
127 const struct command_registration
*commands
;
128 int (*init
)(struct etm_context
*etm_ctx
);
129 trace_status_t (*status
)(struct etm_context
*etm_ctx
);
130 int (*read_trace
)(struct etm_context
*etm_ctx
);
131 int (*start_capture
)(struct etm_context
*etm_ctx
);
132 int (*stop_capture
)(struct etm_context
*etm_ctx
);
136 ETMV1_TRACESYNC_CYCLE
= 0x1,
137 ETMV1_TRIGGER_CYCLE
= 0x2,
140 struct etmv1_trace_data
{
141 uint8_t pipestat
; /* bits 0-2 pipeline status */
142 uint16_t packet
; /* packet data (4, 8 or 16 bit) */
143 int flags
; /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
146 /* describe a trace context
147 * if support for ETMv2 or ETMv3 is to be implemented,
148 * this will have to be split into version independent elements
149 * and a version specific part
152 struct target
*target
; /* target this ETM is connected to */
153 struct reg_cache
*reg_cache
; /* ETM register cache */
154 struct etm_capture_driver
*capture_driver
; /* driver used to access ETM data */
155 void *capture_driver_priv
; /* capture driver private data */
156 trace_status_t capture_status
; /* current state of capture run */
157 struct etmv1_trace_data
*trace_data
; /* trace data */
158 uint32_t trace_depth
; /* number of cycles to be analyzed, 0 if no data available */
159 uint32_t control
; /* shadow of ETM_CTRL */
160 int /*arm_state*/ core_state
; /* current core state */
161 struct image
*image
; /* source for target opcodes */
162 uint32_t pipe_index
; /* current trace cycle */
163 uint32_t data_index
; /* cycle holding next data packet */
164 bool data_half
; /* port half on a 16 bit port */
165 bool pc_ok
; /* full PC has been acquired */
166 bool ptr_ok
; /* whether last_ptr is valid */
167 uint8_t bcd_vers
; /* e.g. 0x13 == ETMv1.3 */
168 uint32_t config
; /* cache of ETM_CONFIG value */
169 uint32_t id
; /* cache of ETM_ID value, or 0 */
170 uint32_t current_pc
; /* current program counter */
171 uint32_t last_branch
; /* last branch address output */
172 uint32_t last_branch_reason
; /* type of last branch encountered */
173 uint32_t last_ptr
; /* address of the last data access */
174 uint32_t last_instruction
; /* index of last executed (to calc timings) */
177 /* PIPESTAT values */
189 /* branch reason values */
191 BR_NORMAL
= 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
192 BR_ENABLE
= 0x1, /* Trace has been enabled */
193 BR_RESTART
= 0x2, /* Trace restarted after a FIFO overflow */
194 BR_NODEBUG
= 0x3, /* ARM has exited for debug state */
195 BR_PERIOD
= 0x4, /* Periodic synchronization point (ETM >= v1.2)*/
196 BR_RSVD5
= 0x5, /* reserved */
197 BR_RSVD6
= 0x6, /* reserved */
198 BR_RSVD7
= 0x7, /* reserved */
199 } etmv1_branch_reason_t
;
201 struct reg_cache
*etm_build_reg_cache(struct target
*target
,
202 struct arm_jtag
*jtag_info
, struct etm_context
*etm_ctx
);
204 int etm_setup(struct target
*target
);
206 extern const struct command_registration etm_command_handlers
[];
208 #define ERROR_ETM_INVALID_DRIVER (-1300)
209 #define ERROR_ETM_PORTMODE_NOT_SUPPORTED (-1301)
210 #define ERROR_ETM_CAPTURE_INIT_FAILED (-1302)
211 #define ERROR_ETM_ANALYSIS_FAILED (-1303)
213 #endif /* OPENOCD_TARGET_ETM_H */
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)