fe7e1a7db8e18993f0832ebce8460e013cd9a2e2
[openocd.git] / src / target / target.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * Copyright (C) 2011 by Broadcom Corporation *
12 * Evan Hunter - ehunter@broadcom.com *
13 * *
14 * Copyright (C) ST-Ericsson SA 2011 *
15 * michel.jaouen@stericsson.com : smp minimum support *
16 * *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
21 * *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
26 * *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
29 ***************************************************************************/
30
31 #ifndef OPENOCD_TARGET_TARGET_H
32 #define OPENOCD_TARGET_TARGET_H
33
34 #include <helper/list.h>
35
36 struct reg;
37 struct trace;
38 struct command_context;
39 struct breakpoint;
40 struct watchpoint;
41 struct mem_param;
42 struct reg_param;
43 struct target_list;
44 struct gdb_fileio_info;
45
46 /*
47 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
48 * TARGET_RUNNING = 1: the target is executing user code
49 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
50 * debugger. on an xscale it means that the debug handler is executing
51 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
52 * not sure how this is used with all the recent changes)
53 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
54 * behalf of the debugger (e.g. algorithm for flashing)
55 *
56 * also see: target_state_name();
57 */
58
59 enum target_state {
60 TARGET_UNKNOWN = 0,
61 TARGET_RUNNING = 1,
62 TARGET_HALTED = 2,
63 TARGET_RESET = 3,
64 TARGET_DEBUG_RUNNING = 4,
65 };
66
67 enum nvp_assert {
68 NVP_DEASSERT,
69 NVP_ASSERT,
70 };
71
72 enum target_reset_mode {
73 RESET_UNKNOWN = 0,
74 RESET_RUN = 1, /* reset and let target run */
75 RESET_HALT = 2, /* reset and halt target out of reset */
76 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
77 };
78
79 enum target_debug_reason {
80 DBG_REASON_DBGRQ = 0,
81 DBG_REASON_BREAKPOINT = 1,
82 DBG_REASON_WATCHPOINT = 2,
83 DBG_REASON_WPTANDBKPT = 3,
84 DBG_REASON_SINGLESTEP = 4,
85 DBG_REASON_NOTHALTED = 5,
86 DBG_REASON_EXIT = 6,
87 DBG_REASON_UNDEFINED = 7,
88 };
89
90 enum target_endianness {
91 TARGET_ENDIAN_UNKNOWN = 0,
92 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
93 };
94
95 struct working_area {
96 target_addr_t address;
97 uint32_t size;
98 bool free;
99 uint8_t *backup;
100 struct working_area **user;
101 struct working_area *next;
102 };
103
104 struct gdb_service {
105 struct target *target;
106 /* field for smp display */
107 /* element 0 coreid currently displayed ( 1 till n) */
108 /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
109 * all cores core displayed */
110 int32_t core[2];
111 };
112
113 /* target back off timer */
114 struct backoff_timer {
115 int times;
116 int count;
117 };
118
119 /* split target registers into multiple class */
120 enum target_register_class {
121 REG_CLASS_ALL,
122 REG_CLASS_GENERAL,
123 };
124
125 /* target_type.h contains the full definition of struct target_type */
126 struct target {
127 struct target_type *type; /* target type definition (name, access functions) */
128 char *cmd_name; /* tcl Name of target */
129 int target_number; /* DO NOT USE! field to be removed in 2010 */
130 struct jtag_tap *tap; /* where on the jtag chain is this */
131 int32_t coreid; /* which device on the TAP? */
132
133 /** Should we defer examine to later */
134 bool defer_examine;
135
136 /**
137 * Indicates whether this target has been examined.
138 *
139 * Do @b not access this field directly, use target_was_examined()
140 * or target_set_examined().
141 */
142 bool examined;
143
144 /**
145 * true if the target is currently running a downloaded
146 * "algorithm" instead of arbitrary user code. OpenOCD code
147 * invoking algorithms is trusted to maintain correctness of
148 * any cached state (e.g. for flash status), which arbitrary
149 * code will have no reason to know about.
150 */
151 bool running_alg;
152
153 struct target_event_action *event_action;
154
155 int reset_halt; /* attempt resetting the CPU into the halted mode? */
156 target_addr_t working_area; /* working area (initialised RAM). Evaluated
157 * upon first allocation from virtual/physical address. */
158 bool working_area_virt_spec; /* virtual address specified? */
159 target_addr_t working_area_virt; /* virtual address */
160 bool working_area_phys_spec; /* physical address specified? */
161 target_addr_t working_area_phys; /* physical address */
162 uint32_t working_area_size; /* size in bytes */
163 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
164 struct working_area *working_areas;/* list of allocated working areas */
165 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
166 enum target_endianness endianness; /* target endianness */
167 /* also see: target_state_name() */
168 enum target_state state; /* the current backend-state (running, halted, ...) */
169 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
170 struct breakpoint *breakpoints; /* list of breakpoints */
171 struct watchpoint *watchpoints; /* list of watchpoints */
172 struct trace *trace_info; /* generic trace information */
173 struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
174 uint32_t dbg_msg_enabled; /* debug message status */
175 void *arch_info; /* architecture specific information */
176 void *private_config; /* pointer to target specific config data (for jim_configure hook) */
177 struct target *next; /* next target in list */
178
179 bool verbose_halt_msg; /* display async info in telnet session. Do not display
180 * lots of halted/resumed info when stepping in debugger. */
181 bool halt_issued; /* did we transition to halted state? */
182 int64_t halt_issued_time; /* Note time when halt was issued */
183
184 /* ARM v7/v8 targets with ADIv5 interface */
185 bool dbgbase_set; /* By default the debug base is not set */
186 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
187 * system in place to support target specific options
188 * currently. */
189 bool has_dap; /* set to true if target has ADIv5 support */
190 bool dap_configured; /* set to true if ADIv5 DAP is configured */
191 bool tap_configured; /* set to true if JTAG tap has been configured
192 * through -chain-position */
193
194 struct rtos *rtos; /* Instance of Real Time Operating System support */
195 bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
196 * and must be detected when symbols are offered */
197 struct backoff_timer backoff;
198 int smp; /* add some target attributes for smp support */
199 struct target_list *head;
200 /* the gdb service is there in case of smp, we have only one gdb server
201 * for all smp target
202 * the target attached to the gdb is changing dynamically by changing
203 * gdb_service->target pointer */
204 struct gdb_service *gdb_service;
205
206 /* file-I/O information for host to do syscall */
207 struct gdb_fileio_info *fileio_info;
208
209 char *gdb_port_override; /* target-specific override for gdb_port */
210
211 /* The semihosting information, extracted from the target. */
212 struct semihosting *semihosting;
213 };
214
215 struct target_list {
216 struct target *target;
217 struct target_list *next;
218 };
219
220 struct gdb_fileio_info {
221 char *identifier;
222 uint64_t param_1;
223 uint64_t param_2;
224 uint64_t param_3;
225 uint64_t param_4;
226 };
227
228 /** Returns the instance-specific name of the specified target. */
229 static inline const char *target_name(struct target *target)
230 {
231 return target->cmd_name;
232 }
233
234 const char *debug_reason_name(struct target *t);
235
236 enum target_event {
237
238 /* allow GDB to do stuff before others handle the halted event,
239 * this is in lieu of defining ordering of invocation of events,
240 * which would be more complicated
241 *
242 * Telling GDB to halt does not mean that the target stopped running,
243 * simply that we're dropping out of GDB's waiting for step or continue.
244 *
245 * This can be useful when e.g. detecting power dropout.
246 */
247 TARGET_EVENT_GDB_HALT,
248 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
249 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
250 TARGET_EVENT_RESUME_START,
251 TARGET_EVENT_RESUME_END,
252
253 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
254 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
255
256 TARGET_EVENT_RESET_START,
257 TARGET_EVENT_RESET_ASSERT_PRE,
258 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
259 TARGET_EVENT_RESET_ASSERT_POST,
260 TARGET_EVENT_RESET_DEASSERT_PRE,
261 TARGET_EVENT_RESET_DEASSERT_POST,
262 TARGET_EVENT_RESET_INIT,
263 TARGET_EVENT_RESET_END,
264
265 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
266 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
267
268 TARGET_EVENT_EXAMINE_START,
269 TARGET_EVENT_EXAMINE_END,
270
271 TARGET_EVENT_GDB_ATTACH,
272 TARGET_EVENT_GDB_DETACH,
273
274 TARGET_EVENT_GDB_FLASH_ERASE_START,
275 TARGET_EVENT_GDB_FLASH_ERASE_END,
276 TARGET_EVENT_GDB_FLASH_WRITE_START,
277 TARGET_EVENT_GDB_FLASH_WRITE_END,
278
279 TARGET_EVENT_TRACE_CONFIG,
280 };
281
282 struct target_event_action {
283 enum target_event event;
284 struct Jim_Interp *interp;
285 struct Jim_Obj *body;
286 int has_percent;
287 struct target_event_action *next;
288 };
289
290 bool target_has_event_action(struct target *target, enum target_event event);
291
292 struct target_event_callback {
293 int (*callback)(struct target *target, enum target_event event, void *priv);
294 void *priv;
295 struct target_event_callback *next;
296 };
297
298 struct target_reset_callback {
299 struct list_head list;
300 void *priv;
301 int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
302 };
303
304 struct target_trace_callback {
305 struct list_head list;
306 void *priv;
307 int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
308 };
309
310 struct target_timer_callback {
311 int (*callback)(void *priv);
312 int time_ms;
313 int periodic;
314 bool removed;
315 struct timeval when;
316 void *priv;
317 struct target_timer_callback *next;
318 };
319
320 struct target_memory_check_block {
321 target_addr_t address;
322 uint32_t size;
323 uint32_t result;
324 };
325
326 int target_register_commands(struct command_context *cmd_ctx);
327 int target_examine(void);
328
329 int target_register_event_callback(
330 int (*callback)(struct target *target,
331 enum target_event event, void *priv),
332 void *priv);
333 int target_unregister_event_callback(
334 int (*callback)(struct target *target,
335 enum target_event event, void *priv),
336 void *priv);
337
338 int target_register_reset_callback(
339 int (*callback)(struct target *target,
340 enum target_reset_mode reset_mode, void *priv),
341 void *priv);
342 int target_unregister_reset_callback(
343 int (*callback)(struct target *target,
344 enum target_reset_mode reset_mode, void *priv),
345 void *priv);
346
347 int target_register_trace_callback(
348 int (*callback)(struct target *target,
349 size_t len, uint8_t *data, void *priv),
350 void *priv);
351 int target_unregister_trace_callback(
352 int (*callback)(struct target *target,
353 size_t len, uint8_t *data, void *priv),
354 void *priv);
355
356 /* Poll the status of the target, detect any error conditions and report them.
357 *
358 * Also note that this fn will clear such error conditions, so a subsequent
359 * invocation will then succeed.
360 *
361 * These error conditions can be "sticky" error conditions. E.g. writing
362 * to memory could be implemented as an open loop and if memory writes
363 * fails, then a note is made of it, the error is sticky, but the memory
364 * write loop still runs to completion. This improves performance in the
365 * normal case as there is no need to verify that every single write succeed,
366 * yet it is possible to detect error conditions.
367 */
368 int target_poll(struct target *target);
369 int target_resume(struct target *target, int current, target_addr_t address,
370 int handle_breakpoints, int debug_execution);
371 int target_halt(struct target *target);
372 int target_call_event_callbacks(struct target *target, enum target_event event);
373 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
374 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
375
376 /**
377 * The period is very approximate, the callback can happen much more often
378 * or much more rarely than specified
379 */
380 int target_register_timer_callback(int (*callback)(void *priv),
381 int time_ms, int periodic, void *priv);
382 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
383 int target_call_timer_callbacks(void);
384 /**
385 * Invoke this to ensure that e.g. polling timer callbacks happen before
386 * a synchronous command completes.
387 */
388 int target_call_timer_callbacks_now(void);
389
390 struct target *get_target_by_num(int num);
391 struct target *get_current_target(struct command_context *cmd_ctx);
392 struct target *get_target(const char *id);
393
394 /**
395 * Get the target type name.
396 *
397 * This routine is a wrapper for the target->type->name field.
398 * Note that this is not an instance-specific name for his target.
399 */
400 const char *target_type_name(struct target *target);
401
402 /**
403 * Examine the specified @a target, letting it perform any
404 * Initialisation that requires JTAG access.
405 *
406 * This routine is a wrapper for target->type->examine.
407 */
408 int target_examine_one(struct target *target);
409
410 /** @returns @c true if target_set_examined() has been called. */
411 static inline bool target_was_examined(struct target *target)
412 {
413 return target->examined;
414 }
415
416 /** Sets the @c examined flag for the given target. */
417 /** Use in target->type->examine() after one-time setup is done. */
418 static inline void target_set_examined(struct target *target)