]> git.sur5r.net Git - openocd/blob - src/target/etm.h
cleanup trailing whitespaces
[openocd] / src / target / etm.h
1 /***************************************************************************
2  *   Copyright (C) 2005, 2007 by Dominic Rath                              *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007 by Vincent Palatin                                 *
6  *   vincent.palatin_openocd@m4x.org                                       *
7  *                                                                         *
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.                                   *
12  *                                                                         *
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.                          *
17  *                                                                         *
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  ***************************************************************************/
23 #ifndef ETM_H
24 #define ETM_H
25
26 #include "trace.h"
27 #include "arm_jtag.h"
28
29 struct image;
30
31 /* ETM registers (JTAG protocol) */
32 enum
33 {
34         ETM_CTRL = 0x00,
35         ETM_CONFIG = 0x01,
36         ETM_TRIG_EVENT = 0x02,
37         ETM_ASIC_CTRL = 0x03,
38         ETM_STATUS = 0x04,
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,
68         /* N task contexts */
69         ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,
70         ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,
71         ETM_ID = 0x79,
72 };
73
74 struct etm_reg
75 {
76         uint32_t value;
77         const struct etm_reg_info *reg_info;
78         struct arm_jtag *jtag_info;
79 };
80
81 /* Subset of ETM_CTRL bit assignments.  Many of these
82  * control the configuration of trace output, which
83  * hooks up either to ETB or to an external device.
84  *
85  * NOTE that these have evolved since the ~v1.3 defns ...
86  */
87 enum
88 {
89         ETM_CTRL_POWERDOWN      = (1 << 0),
90         ETM_CTRL_MONITOR_CPRT   = (1 << 1),
91
92         /* bits 3:2 == trace type */
93         ETM_CTRL_TRACE_DATA     = (1 << 2),
94         ETM_CTRL_TRACE_ADDR     = (2 << 2),
95         ETM_CTRL_TRACE_MASK     = (3 << 2),
96
97         /* Port width (bits 21 and 6:4) */
98         ETM_PORT_4BIT           = 0x00,
99         ETM_PORT_8BIT           = 0x10,
100         ETM_PORT_16BIT          = 0x20,
101         ETM_PORT_24BIT          = 0x30,
102         ETM_PORT_32BIT          = 0x40,
103         ETM_PORT_48BIT          = 0x50,
104         ETM_PORT_64BIT          = 0x60,
105         ETM_PORT_1BIT           = 0x00 | (1 << 21),
106         ETM_PORT_2BIT           = 0x10 | (1 << 21),
107         ETM_PORT_WIDTH_MASK     = 0x70 | (1 << 21),
108
109         ETM_CTRL_FIFOFULL_STALL = (1 << 7),
110         ETM_CTRL_BRANCH_OUTPUT  = (1 << 8),
111         ETM_CTRL_DBGRQ          = (1 << 9),
112         ETM_CTRL_ETM_PROG       = (1 << 10),
113         ETM_CTRL_ETMEN          = (1 << 11),
114         ETM_CTRL_CYCLE_ACCURATE = (1 << 12),
115
116         /* Clocking modes -- up to v2.1, bit 13 */
117         ETM_PORT_FULL_CLOCK     = (0 << 13),
118         ETM_PORT_HALF_CLOCK     = (1 << 13),
119         ETM_PORT_CLOCK_MASK     = (1 << 13),
120
121         // bits 15:14 == context ID size used in tracing
122         ETM_CTRL_CONTEXTID_NONE = (0 << 14),
123         ETM_CTRL_CONTEXTID_8    = (1 << 14),
124         ETM_CTRL_CONTEXTID_16   = (2 << 14),
125         ETM_CTRL_CONTEXTID_32   = (3 << 14),
126         ETM_CTRL_CONTEXTID_MASK = (3 << 14),
127
128         /* Port modes -- bits 17:16, tied to clocking mode */
129         ETM_PORT_NORMAL         = (0 << 16),
130         ETM_PORT_MUXED          = (1 << 16),
131         ETM_PORT_DEMUXED        = (2 << 16),
132         ETM_PORT_MODE_MASK      = (3 << 16),
133
134         // bits 31:18 defined in v3.0 and later (e.g. ARM11+)
135 };
136
137 /* forward-declare ETM context */
138 struct etm_context;
139
140 struct etm_capture_driver
141 {
142         const char *name;
143         const struct command_registration *commands;
144         int (*init)(struct etm_context *etm_ctx);
145         trace_status_t (*status)(struct etm_context *etm_ctx);
146         int (*read_trace)(struct etm_context *etm_ctx);
147         int (*start_capture)(struct etm_context *etm_ctx);
148         int (*stop_capture)(struct etm_context *etm_ctx);
149 };
150
151 enum
152 {
153         ETMV1_TRACESYNC_CYCLE = 0x1,
154         ETMV1_TRIGGER_CYCLE = 0x2,
155 };
156
157 struct etmv1_trace_data
158 {
159         uint8_t pipestat;       /* bits 0-2 pipeline status */
160         uint16_t packet;                /* packet data (4, 8 or 16 bit) */
161         int flags;              /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
162 };
163
164 /* describe a trace context
165  * if support for ETMv2 or ETMv3 is to be implemented,
166  * this will have to be split into version independent elements
167  * and a version specific part
168  */
169 struct etm_context
170 {
171         struct target *target;          /* target this ETM is connected to */
172         struct reg_cache *reg_cache;            /* ETM register cache */
173         struct etm_capture_driver *capture_driver;      /* driver used to access ETM data */
174         void *capture_driver_priv;      /* capture driver private data */
175         trace_status_t capture_status;  /* current state of capture run */
176         struct etmv1_trace_data *trace_data;    /* trace data */
177         uint32_t trace_depth;           /* number of cycles to be analyzed, 0 if no data available */
178         uint32_t control;       /* shadow of ETM_CTRL */
179         int /*arm_state*/ core_state;   /* current core state */
180         struct image *image;            /* source for target opcodes */
181         uint32_t pipe_index;            /* current trace cycle */
182         uint32_t data_index;            /* cycle holding next data packet */
183         bool data_half;                 /* port half on a 16 bit port */
184         bool pc_ok;                     /* full PC has been acquired */
185         bool ptr_ok;                    /* whether last_ptr is valid */
186         uint8_t bcd_vers;               /* e.g. 0x13 == ETMv1.3 */
187         uint32_t config;                /* cache of ETM_CONFIG value */
188         uint32_t id;                    /* cache of ETM_ID value, or 0 */
189         uint32_t current_pc;            /* current program counter */
190         uint32_t last_branch;           /* last branch address output */
191         uint32_t last_branch_reason;    /* type of last branch encountered */
192         uint32_t last_ptr;              /* address of the last data access */
193         uint32_t last_instruction;      /* index of last executed (to calc timings) */
194 };
195
196 /* PIPESTAT values */
197 typedef enum
198 {
199         STAT_IE = 0x0,
200         STAT_ID = 0x1,
201         STAT_IN = 0x2,
202         STAT_WT = 0x3,
203         STAT_BE = 0x4,
204         STAT_BD = 0x5,
205         STAT_TR = 0x6,
206         STAT_TD = 0x7
207 } etmv1_pipestat_t;
208
209 /* branch reason values */
210 typedef enum
211 {
212         BR_NORMAL  = 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
213         BR_ENABLE  = 0x1, /* Trace has been enabled */
214         BR_RESTART = 0x2, /* Trace restarted after a FIFO overflow */
215         BR_NODEBUG = 0x3, /* ARM has exited for debug state */
216         BR_PERIOD  = 0x4, /* Peridioc synchronization point (ETM >= v1.2)*/
217         BR_RSVD5   = 0x5, /* reserved */
218         BR_RSVD6   = 0x6, /* reserved */
219         BR_RSVD7   = 0x7, /* reserved */
220 } etmv1_branch_reason_t;
221
222 struct reg_cache* etm_build_reg_cache(struct target *target,
223                 struct arm_jtag *jtag_info, struct etm_context *etm_ctx);
224
225 int etm_setup(struct target *target);
226
227 extern const struct command_registration etm_command_handlers[];
228
229 #define ERROR_ETM_INVALID_DRIVER        (-1300)
230 #define ERROR_ETM_PORTMODE_NOT_SUPPORTED        (-1301)
231 #define ERROR_ETM_CAPTURE_INIT_FAILED   (-1302)
232 #define ERROR_ETM_ANALYSIS_FAILED       (-1303)
233
234 #endif /* ETM_H */