1 /***************************************************************************
2 * Copyright (C) 2005, 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007 by Vincent Palatin *
6 * vincent.palatin_openocd@m4x.org *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
30 /* ETM registers (JTAG protocol) */
34 ETM_TRIG_EVENT
= 0x02,
37 ETM_SYS_CONFIG
= 0x05,
38 ETM_TRACE_RESOURCE_CTRL
= 0x06,
39 ETM_TRACE_EN_CTRL2
= 0x07,
40 ETM_TRACE_EN_EVENT
= 0x08,
41 ETM_TRACE_EN_CTRL1
= 0x09,
42 /* optional FIFOFULL */
43 ETM_FIFOFULL_REGION
= 0x0a,
44 ETM_FIFOFULL_LEVEL
= 0x0b,
45 /* viewdata support */
46 ETM_VIEWDATA_EVENT
= 0x0c,
47 ETM_VIEWDATA_CTRL1
= 0x0d,
48 ETM_VIEWDATA_CTRL2
= 0x0e, /* optional */
49 ETM_VIEWDATA_CTRL3
= 0x0f,
50 /* N pairs of ADDR_{COMPARATOR,ACCESS} registers */
51 ETM_ADDR_COMPARATOR_VALUE
= 0x10,
52 ETM_ADDR_ACCESS_TYPE
= 0x20,
53 /* N pairs of DATA_COMPARATOR_{VALUE,MASK} registers */
54 ETM_DATA_COMPARATOR_VALUE
= 0x30,
55 ETM_DATA_COMPARATOR_MASK
= 0x40,
56 /* N quads of COUNTER_{RELOAD_{VALUE,EVENT},ENABLE,VALUE} registers */
57 ETM_COUNTER_RELOAD_VALUE
= 0x50,
58 ETM_COUNTER_ENABLE
= 0x54,
59 ETM_COUNTER_RELOAD_EVENT
= 0x58,
60 ETM_COUNTER_VALUE
= 0x5c,
61 /* 6 sequencer event transitions */
62 ETM_SEQUENCER_EVENT
= 0x60,
63 ETM_SEQUENCER_STATE
= 0x67,
64 /* N triggered outputs */
65 ETM_EXTERNAL_OUTPUT
= 0x68,
67 ETM_CONTEXTID_COMPARATOR_VALUE
= 0x6c,
68 ETM_CONTEXTID_COMPARATOR_MASK
= 0x6f,
74 const struct etm_reg_info
*reg_info
;
75 struct arm_jtag
*jtag_info
;
78 /* Subset of ETM_CTRL bit assignments. Many of these
79 * control the configuration of trace output, which
80 * hooks up either to ETB or to an external device.
82 * NOTE that these have evolved since the ~v1.3 defns ...
85 ETM_CTRL_POWERDOWN
= (1 << 0),
86 ETM_CTRL_MONITOR_CPRT
= (1 << 1),
88 /* bits 3:2 == trace type */
89 ETM_CTRL_TRACE_DATA
= (1 << 2),
90 ETM_CTRL_TRACE_ADDR
= (2 << 2),
91 ETM_CTRL_TRACE_MASK
= (3 << 2),
93 /* Port width (bits 21 and 6:4) */
96 ETM_PORT_16BIT
= 0x20,
97 ETM_PORT_24BIT
= 0x30,
98 ETM_PORT_32BIT
= 0x40,
99 ETM_PORT_48BIT
= 0x50,
100 ETM_PORT_64BIT
= 0x60,
101 ETM_PORT_1BIT
= 0x00 | (1 << 21),
102 ETM_PORT_2BIT
= 0x10 | (1 << 21),
103 ETM_PORT_WIDTH_MASK
= 0x70 | (1 << 21),
105 ETM_CTRL_FIFOFULL_STALL
= (1 << 7),
106 ETM_CTRL_BRANCH_OUTPUT
= (1 << 8),
107 ETM_CTRL_DBGRQ
= (1 << 9),
108 ETM_CTRL_ETM_PROG
= (1 << 10),
109 ETM_CTRL_ETMEN
= (1 << 11),
110 ETM_CTRL_CYCLE_ACCURATE
= (1 << 12),
112 /* Clocking modes -- up to v2.1, bit 13 */
113 ETM_PORT_FULL_CLOCK
= (0 << 13),
114 ETM_PORT_HALF_CLOCK
= (1 << 13),
115 ETM_PORT_CLOCK_MASK
= (1 << 13),
117 /* bits 15:14 == context ID size used in tracing */
118 ETM_CTRL_CONTEXTID_NONE
= (0 << 14),
119 ETM_CTRL_CONTEXTID_8
= (1 << 14),
120 ETM_CTRL_CONTEXTID_16
= (2 << 14),
121 ETM_CTRL_CONTEXTID_32
= (3 << 14),
122 ETM_CTRL_CONTEXTID_MASK
= (3 << 14),
124 /* Port modes -- bits 17:16, tied to clocking mode */
125 ETM_PORT_NORMAL
= (0 << 16),
126 ETM_PORT_MUXED
= (1 << 16),
127 ETM_PORT_DEMUXED
= (2 << 16),
128 ETM_PORT_MODE_MASK
= (3 << 16),
130 /* bits 31:18 defined in v3.0 and later (e.g. ARM11+) */
133 /* forward-declare ETM context */
136 struct etm_capture_driver
{
138 const struct command_registration
*commands
;
139 int (*init
)(struct etm_context
*etm_ctx
);
140 trace_status_t (*status
)(struct etm_context
*etm_ctx
);
141 int (*read_trace
)(struct etm_context
*etm_ctx
);
142 int (*start_capture
)(struct etm_context
*etm_ctx
);
143 int (*stop_capture
)(struct etm_context
*etm_ctx
);
147 ETMV1_TRACESYNC_CYCLE
= 0x1,
148 ETMV1_TRIGGER_CYCLE
= 0x2,
151 struct etmv1_trace_data
{
152 uint8_t pipestat
; /* bits 0-2 pipeline status */
153 uint16_t packet
; /* packet data (4, 8 or 16 bit) */
154 int flags
; /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
157 /* describe a trace context
158 * if support for ETMv2 or ETMv3 is to be implemented,
159 * this will have to be split into version independent elements
160 * and a version specific part
163 struct target
*target
; /* target this ETM is connected to */
164 struct reg_cache
*reg_cache
; /* ETM register cache */
165 struct etm_capture_driver
*capture_driver
; /* driver used to access ETM data */
166 void *capture_driver_priv
; /* capture driver private data */
167 trace_status_t capture_status
; /* current state of capture run */
168 struct etmv1_trace_data
*trace_data
; /* trace data */
169 uint32_t trace_depth
; /* number of cycles to be analyzed, 0 if no data available */
170 uint32_t control
; /* shadow of ETM_CTRL */
171 int /*arm_state*/ core_state
; /* current core state */
172 struct image
*image
; /* source for target opcodes */
173 uint32_t pipe_index
; /* current trace cycle */
174 uint32_t data_index
; /* cycle holding next data packet */
175 bool data_half
; /* port half on a 16 bit port */
176 bool pc_ok
; /* full PC has been acquired */
177 bool ptr_ok
; /* whether last_ptr is valid */
178 uint8_t bcd_vers
; /* e.g. 0x13 == ETMv1.3 */
179 uint32_t config
; /* cache of ETM_CONFIG value */
180 uint32_t id
; /* cache of ETM_ID value, or 0 */
181 uint32_t current_pc
; /* current program counter */
182 uint32_t last_branch
; /* last branch address output */
183 uint32_t last_branch_reason
; /* type of last branch encountered */
184 uint32_t last_ptr
; /* address of the last data access */
185 uint32_t last_instruction
; /* index of last executed (to calc timings) */
188 /* PIPESTAT values */
200 /* branch reason values */
202 BR_NORMAL
= 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
203 BR_ENABLE
= 0x1, /* Trace has been enabled */
204 BR_RESTART
= 0x2, /* Trace restarted after a FIFO overflow */
205 BR_NODEBUG
= 0x3, /* ARM has exited for debug state */
206 BR_PERIOD
= 0x4, /* Peridioc synchronization point (ETM >= v1.2)*/
207 BR_RSVD5
= 0x5, /* reserved */
208 BR_RSVD6
= 0x6, /* reserved */
209 BR_RSVD7
= 0x7, /* reserved */
210 } etmv1_branch_reason_t
;
212 struct reg_cache
*etm_build_reg_cache(struct target
*target
,
213 struct arm_jtag
*jtag_info
, struct etm_context
*etm_ctx
);
215 int etm_setup(struct target
*target
);
217 extern const struct command_registration etm_command_handlers
[];
219 #define ERROR_ETM_INVALID_DRIVER (-1300)
220 #define ERROR_ETM_PORTMODE_NOT_SUPPORTED (-1301)
221 #define ERROR_ETM_CAPTURE_INIT_FAILED (-1302)
222 #define ERROR_ETM_ANALYSIS_FAILED (-1303)