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 ***************************************************************************/
32 /* ETM registers (V1.3 protocol) */
37 ETM_TRIG_EVENT
= 0x02,
40 ETM_SYS_CONFIG
= 0x05,
41 ETM_TRACE_RESOURCE_CTRL
= 0x06,
42 ETM_TRACE_EN_CTRL2
= 0x07,
43 ETM_TRACE_EN_EVENT
= 0x08,
44 ETM_TRACE_EN_CTRL1
= 0x09,
45 ETM_FIFOFULL_REGION
= 0x0a,
46 ETM_FIFOFULL_LEVEL
= 0x0b,
47 ETM_VIEWDATA_EVENT
= 0x0c,
48 ETM_VIEWDATA_CTRL1
= 0x0d,
49 ETM_VIEWDATA_CTRL2
= 0x0e,
50 ETM_VIEWDATA_CTRL3
= 0x0f,
51 ETM_ADDR_COMPARATOR_VALUE
= 0x10,
52 ETM_ADDR_ACCESS_TYPE
= 0x20,
53 ETM_DATA_COMPARATOR_VALUE
= 0x30,
54 ETM_DATA_COMPARATOR_MASK
= 0x40,
55 ETM_COUNTER_INITAL_VALUE
= 0x50,
56 ETM_COUNTER_ENABLE
= 0x54,
57 ETM_COUNTER_RELOAD_VALUE
= 0x58,
58 ETM_COUNTER_VALUE
= 0x5c,
59 ETM_SEQUENCER_CTRL
= 0x60,
60 ETM_SEQUENCER_STATE
= 0x67,
61 ETM_EXTERNAL_OUTPUT
= 0x68,
62 ETM_CONTEXTID_COMPARATOR_VALUE
= 0x6c,
63 ETM_CONTEXTID_COMPARATOR_MASK
= 0x6f,
66 typedef struct etm_reg_s
69 arm_jtag_t
*jtag_info
;
77 ETM_PORT_16BIT
= 0x20,
78 ETM_PORT_WIDTH_MASK
= 0x70,
80 ETM_PORT_NORMAL
= 0x00000,
81 ETM_PORT_MUXED
= 0x10000,
82 ETM_PORT_DEMUXED
= 0x20000,
83 ETM_PORT_MODE_MASK
= 0x30000,
85 ETM_PORT_FULL_CLOCK
= 0x0000,
86 ETM_PORT_HALF_CLOCK
= 0x1000,
87 ETM_PORT_CLOCK_MASK
= 0x1000,
93 ETMV1_TRACE_NONE
= 0x00,
94 ETMV1_TRACE_DATA
= 0x01,
95 ETMV1_TRACE_ADDR
= 0x02,
96 ETMV1_TRACE_MASK
= 0x03,
98 ETMV1_CONTEXTID_NONE
= 0x00,
99 ETMV1_CONTEXTID_8
= 0x10,
100 ETMV1_CONTEXTID_16
= 0x20,
101 ETMV1_CONTEXTID_32
= 0x30,
102 ETMV1_CONTEXTID_MASK
= 0x30,
104 ETMV1_CYCLE_ACCURATE
= 0x100,
105 ETMV1_BRANCH_OUTPUT
= 0x200
108 /* forward-declare ETM context */
109 struct etm_context_s
;
111 typedef struct etm_capture_driver_s
114 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
115 int (*init
)(struct etm_context_s
*etm_ctx
);
116 trace_status_t (*status
)(struct etm_context_s
*etm_ctx
);
117 int (*read_trace
)(struct etm_context_s
*etm_ctx
);
118 int (*start_capture
)(struct etm_context_s
*etm_ctx
);
119 int (*stop_capture
)(struct etm_context_s
*etm_ctx
);
120 } etm_capture_driver_t
;
124 ETMV1_TRACESYNC_CYCLE
= 0x1,
125 ETMV1_TRIGGER_CYCLE
= 0x2,
128 typedef struct etmv1_trace_data_s
130 uint8_t pipestat
; /* bits 0-2 pipeline status */
131 uint16_t packet
; /* packet data (4, 8 or 16 bit) */
132 int flags
; /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
133 } etmv1_trace_data_t
;
135 /* describe a trace context
136 * if support for ETMv2 or ETMv3 is to be implemented,
137 * this will have to be split into version independent elements
138 * and a version specific part
140 typedef struct etm_context_s
142 target_t
*target
; /* target this ETM is connected to */
143 reg_cache_t
*reg_cache
; /* ETM register cache */
144 etm_capture_driver_t
*capture_driver
; /* driver used to access ETM data */
145 void *capture_driver_priv
; /* capture driver private data */
146 uint32_t trigger_percent
; /* percent of trace buffer to be filled after the trigger */
147 trace_status_t capture_status
; /* current state of capture run */
148 etmv1_trace_data_t
*trace_data
; /* trace data */
149 uint32_t trace_depth
; /* number of trace cycles to be analyzed, 0 if no trace data available */
150 etm_portmode_t portmode
; /* normal, multiplexed or demultiplexed */
151 etmv1_tracemode_t tracemode
; /* type of information the trace contains (data, addres, contextID, ...) */
152 armv4_5_state_t core_state
; /* current core state (ARM, Thumb, Jazelle) */
153 struct image_s
*image
; /* source for target opcodes */
154 uint32_t pipe_index
; /* current trace cycle */
155 uint32_t data_index
; /* cycle holding next data packet */
156 int data_half
; /* port half on a 16 bit port */
157 uint32_t current_pc
; /* current program counter */
158 uint32_t pc_ok
; /* full PC has been acquired */
159 uint32_t last_branch
; /* last branch address output */
160 uint32_t last_branch_reason
; /* branch reason code for the last branch encountered */
161 uint32_t last_ptr
; /* address of the last data access */
162 uint32_t ptr_ok
; /* whether last_ptr is valid */
163 uint32_t context_id
; /* context ID of the code being traced */
164 uint32_t last_instruction
; /* index of last instruction executed (to calculate cycle timings) */
167 /* PIPESTAT values */
180 /* branch reason values */
183 BR_NORMAL
= 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
184 BR_ENABLE
= 0x1, /* Trace has been enabled */
185 BR_RESTART
= 0x2, /* Trace restarted after a FIFO overflow */
186 BR_NODEBUG
= 0x3, /* ARM has exited for debug state */
187 BR_PERIOD
= 0x4, /* Peridioc synchronization point (ETM>=v1.2)*/
188 BR_RSVD5
= 0x5, /* reserved */
189 BR_RSVD6
= 0x6, /* reserved */
190 BR_RSVD7
= 0x7, /* reserved */
191 } etmv1_branch_reason_t
;
193 extern char *etmv1v1_branch_reason_strings
[];
195 extern reg_cache_t
* etm_build_reg_cache(target_t
*target
, arm_jtag_t
*jtag_info
, etm_context_t
*etm_ctx
);
196 extern int etm_read_reg(reg_t
*reg
);
197 extern int etm_write_reg(reg_t
*reg
, uint32_t value
);
198 extern int etm_read_reg_w_check(reg_t
*reg
, uint8_t* check_value
, uint8_t* check_mask
);
199 extern int etm_store_reg(reg_t
*reg
);
200 extern int etm_set_reg(reg_t
*reg
, uint32_t value
);
201 extern int etm_set_reg_w_exec(reg_t
*reg
, uint8_t *buf
);
202 extern int etm_setup(target_t
*target
);
204 int etm_register_commands(struct command_context_s
*cmd_ctx
);
205 int etm_register_user_commands(struct command_context_s
*cmd_ctx
);
206 extern etm_context_t
* etm_create_context(etm_portmode_t portmode
, char *capture_driver_name
);
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)