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, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
31 /* ETM registers (JTAG protocol) */
36 ETM_TRIG_EVENT = 0x02,
39 ETM_SYS_CONFIG = 0x05,
40 ETM_TRACE_RESOURCE_CTRL = 0x06,
41 ETM_TRACE_EN_CTRL2 = 0x07,
42 ETM_TRACE_EN_EVENT = 0x08,
43 ETM_TRACE_EN_CTRL1 = 0x09,
44 /* optional FIFOFULL */
45 ETM_FIFOFULL_REGION = 0x0a,
46 ETM_FIFOFULL_LEVEL = 0x0b,
47 /* viewdata support */
48 ETM_VIEWDATA_EVENT = 0x0c,
49 ETM_VIEWDATA_CTRL1 = 0x0d,
50 ETM_VIEWDATA_CTRL2 = 0x0e, /* optional */
51 ETM_VIEWDATA_CTRL3 = 0x0f,
52 /* N pairs of ADDR_{COMPARATOR,ACCESS} registers */
53 ETM_ADDR_COMPARATOR_VALUE = 0x10,
54 ETM_ADDR_ACCESS_TYPE = 0x20,
55 /* N pairs of DATA_COMPARATOR_{VALUE,MASK} registers */
56 ETM_DATA_COMPARATOR_VALUE = 0x30,
57 ETM_DATA_COMPARATOR_MASK = 0x40,
58 /* N quads of COUNTER_{RELOAD_{VALUE,EVENT},ENABLE,VALUE} registers */
59 ETM_COUNTER_RELOAD_VALUE = 0x50,
60 ETM_COUNTER_ENABLE = 0x54,
61 ETM_COUNTER_RELOAD_EVENT = 0x58,
62 ETM_COUNTER_VALUE = 0x5c,
63 /* 6 sequencer event transitions */
64 ETM_SEQUENCER_EVENT = 0x60,
65 ETM_SEQUENCER_STATE = 0x67,
66 /* N triggered outputs */
67 ETM_EXTERNAL_OUTPUT = 0x68,
69 ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,
70 ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,
73 typedef struct etm_reg_s
76 const struct etm_reg_info *reg_info;
77 arm_jtag_t *jtag_info;
85 ETM_PORT_16BIT = 0x20,
86 ETM_PORT_WIDTH_MASK = 0x70,
88 ETM_PORT_NORMAL = 0x00000,
89 ETM_PORT_MUXED = 0x10000,
90 ETM_PORT_DEMUXED = 0x20000,
91 ETM_PORT_MODE_MASK = 0x30000,
93 ETM_PORT_FULL_CLOCK = 0x0000,
94 ETM_PORT_HALF_CLOCK = 0x1000,
95 ETM_PORT_CLOCK_MASK = 0x1000,
101 ETMV1_TRACE_NONE = 0x00,
102 ETMV1_TRACE_DATA = 0x01,
103 ETMV1_TRACE_ADDR = 0x02,
104 ETMV1_TRACE_MASK = 0x03,
106 ETMV1_CONTEXTID_NONE = 0x00,
107 ETMV1_CONTEXTID_8 = 0x10,
108 ETMV1_CONTEXTID_16 = 0x20,
109 ETMV1_CONTEXTID_32 = 0x30,
110 ETMV1_CONTEXTID_MASK = 0x30,
112 ETMV1_CYCLE_ACCURATE = 0x100,
113 ETMV1_BRANCH_OUTPUT = 0x200
116 /* forward-declare ETM context */
119 typedef struct etm_capture_driver_s
122 int (*register_commands)(struct command_context_s *cmd_ctx);
123 int (*init)(struct etm *etm_ctx);
124 trace_status_t (*status)(struct etm *etm_ctx);
125 int (*read_trace)(struct etm *etm_ctx);
126 int (*start_capture)(struct etm *etm_ctx);
127 int (*stop_capture)(struct etm *etm_ctx);
128 } etm_capture_driver_t;
132 ETMV1_TRACESYNC_CYCLE = 0x1,
133 ETMV1_TRIGGER_CYCLE = 0x2,
136 typedef struct etmv1_trace_data_s
138 uint8_t pipestat; /* bits 0-2 pipeline status */
139 uint16_t packet; /* packet data (4, 8 or 16 bit) */
140 int flags; /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
141 } etmv1_trace_data_t;
143 /* describe a trace context
144 * if support for ETMv2 or ETMv3 is to be implemented,
145 * this will have to be split into version independent elements
146 * and a version specific part
150 target_t *target; /* target this ETM is connected to */
151 reg_cache_t *reg_cache; /* ETM register cache */
152 etm_capture_driver_t *capture_driver; /* driver used to access ETM data */
153 void *capture_driver_priv; /* capture driver private data */
154 uint32_t trigger_percent; /* how much trace buffer to fill after trigger */
155 trace_status_t capture_status; /* current state of capture run */
156 etmv1_trace_data_t *trace_data; /* trace data */
157 uint32_t trace_depth; /* number of cycles to be analyzed, 0 if no data available */
158 etm_portmode_t portmode; /* normal, multiplexed or demultiplexed */
159 etmv1_tracemode_t tracemode; /* type of info trace contains */
160 int /*armv4_5_state_t*/ core_state; /* current core state */
161 struct image_s *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 current_pc; /* current program counter */
170 uint32_t last_branch; /* last branch address output */
171 uint32_t last_branch_reason; /* type of last branch encountered */
172 uint32_t last_ptr; /* address of the last data access */
173 uint32_t last_instruction; /* index of last executed (to calc timings) */
176 /* PIPESTAT values */
189 /* branch reason values */
192 BR_NORMAL = 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
193 BR_ENABLE = 0x1, /* Trace has been enabled */
194 BR_RESTART = 0x2, /* Trace restarted after a FIFO overflow */
195 BR_NODEBUG = 0x3, /* ARM has exited for debug state */
196 BR_PERIOD = 0x4, /* Peridioc synchronization point (ETM >= v1.2)*/
197 BR_RSVD5 = 0x5, /* reserved */
198 BR_RSVD6 = 0x6, /* reserved */
199 BR_RSVD7 = 0x7, /* reserved */
200 } etmv1_branch_reason_t;
202 reg_cache_t* etm_build_reg_cache(target_t *target,
203 arm_jtag_t *jtag_info, etm_context_t *etm_ctx);
205 int etm_setup(target_t *target);
207 int etm_register_commands(struct command_context_s *cmd_ctx);
209 #define ERROR_ETM_INVALID_DRIVER (-1300)
210 #define ERROR_ETM_PORTMODE_NOT_SUPPORTED (-1301)
211 #define ERROR_ETM_CAPTURE_INIT_FAILED (-1302)
212 #define ERROR_ETM_ANALYSIS_FAILED (-1303)