target: make "examined" flag be per-target
[openocd.git] / src / target / target.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008,2009 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef TARGET_H
27 #define TARGET_H
28
29 #include <stddef.h>
30
31 #include "breakpoints.h"
32 #include "algorithm.h"
33 #include "command.h"
34
35 struct reg;
36 struct trace;
37 struct command_context;
38
39
40 /**
41 * Cast a member of a structure out to the containing structure.
42 * @param ptr The pointer to the member.
43 * @param type The type of the container struct this is embedded in.
44 * @param member The name of the member within the struct.
45 *
46 * This is a mechanism which is used throughout the Linux kernel.
47 */
48 #define container_of(ptr, type, member) ({ \
49 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
50 (type *)( (char *)__mptr - offsetof(type,member) );})
51
52 /*
53 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
54 * TARGET_RUNNING = 1: the target is executing user code
55 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
56 * debugger. on an xscale it means that the debug handler is executing
57 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
58 * not sure how this is used with all the recent changes)
59 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
60 * behalf of the debugger (e.g. algorithm for flashing)
61 *
62 * also see: target_state_name();
63 */
64
65
66 enum target_state
67 {
68 TARGET_UNKNOWN = 0,
69 TARGET_RUNNING = 1,
70 TARGET_HALTED = 2,
71 TARGET_RESET = 3,
72 TARGET_DEBUG_RUNNING = 4,
73 };
74
75 extern const Jim_Nvp nvp_target_state[];
76
77 enum nvp_assert {
78 NVP_DEASSERT,
79 NVP_ASSERT,
80 };
81
82 extern const Jim_Nvp nvp_assert[];
83
84 enum target_reset_mode
85 {
86 RESET_UNKNOWN = 0,
87 RESET_RUN = 1, /* reset and let target run */
88 RESET_HALT = 2, /* reset and halt target out of reset */
89 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
90 };
91
92 extern const Jim_Nvp nvp_reset_mode[];
93
94 enum target_debug_reason
95 {
96 DBG_REASON_DBGRQ = 0,
97 DBG_REASON_BREAKPOINT = 1,
98 DBG_REASON_WATCHPOINT = 2,
99 DBG_REASON_WPTANDBKPT = 3,
100 DBG_REASON_SINGLESTEP = 4,
101 DBG_REASON_NOTHALTED = 5,
102 DBG_REASON_UNDEFINED = 6
103 };
104
105 extern const Jim_Nvp nvp_target_debug_reason[];
106
107 enum target_endianess
108 {
109 TARGET_ENDIAN_UNKNOWN = 0,
110 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
111 };
112
113 extern const Jim_Nvp nvp_target_endian[];
114
115 struct working_area
116 {
117 uint32_t address;
118 uint32_t size;
119 int free;
120 uint8_t *backup;
121 struct working_area **user;
122 struct working_area *next;
123 };
124
125 // target_type.h contains the full definitionof struct targe_type
126 struct target
127 {
128 struct target_type *type; /* target type definition (name, access functions) */
129 const char *cmd_name; /* tcl Name of target */
130 int target_number; /* DO NOT USE! field to be removed in 2010 */
131 struct jtag_tap *tap; /* where on the jtag chain is this */
132 const char *variant; /* what variant of this chip is it? */
133
134 /**
135 * Indicates whether this target has been examined.
136 *
137 * Do @b not access this field directly, use target_was_examined()
138 * or target_set_examined().
139 */
140 bool examined;
141
142 struct target_event_action *event_action;
143
144 int reset_halt; /* attempt resetting the CPU into the halted mode? */
145 uint32_t working_area; /* working area (initialized RAM). Evaluated
146 * upon first allocation from virtual/physical address. */
147 bool working_area_virt_spec; /* virtual address specified? */
148 uint32_t working_area_virt; /* virtual address */
149 bool working_area_phys_spec; /* virtual address specified? */
150 uint32_t working_area_phys; /* physical address */
151 uint32_t working_area_size; /* size in bytes */
152 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
153 struct working_area *working_areas;/* list of allocated working areas */
154 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
155 enum target_endianess endianness; /* target endianess */
156 // also see: target_state_name()
157 enum target_state state; /* the current backend-state (running, halted, ...) */
158 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
159 struct breakpoint *breakpoints; /* list of breakpoints */
160 struct watchpoint *watchpoints; /* list of watchpoints */
161 struct trace *trace_info; /* generic trace information */
162 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
163 uint32_t dbg_msg_enabled; /* debug message status */
164 void *arch_info; /* architecture specific information */
165 struct target *next; /* next target in list */
166
167 int display; /* display async info in telnet session. Do not display
168 * lots of halted/resumed info when stepping in debugger. */
169 bool halt_issued; /* did we transition to halted state? */
170 long long halt_issued_time; /* Note time when halt was issued */
171 };
172
173 enum target_event
174 {
175 /* LD historical names
176 * - Prior to the great TCL change
177 * - June/July/Aug 2008
178 * - Duane Ellis */
179 TARGET_EVENT_OLD_gdb_program_config,
180 TARGET_EVENT_OLD_pre_reset,
181 TARGET_EVENT_OLD_post_reset,
182 TARGET_EVENT_OLD_pre_resume,
183
184 /* allow GDB to do stuff before others handle the halted event,
185 * this is in lieu of defining ordering of invocation of events,
186 * which would be more complicated
187 *
188 * Telling GDB to halt does not mean that the target stopped running,
189 * simply that we're dropping out of GDB's waiting for step or continue.
190 *
191 * This can be useful when e.g. detecting power dropout.
192 */
193 TARGET_EVENT_GDB_HALT,
194 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
195 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
196 TARGET_EVENT_RESUME_START,
197 TARGET_EVENT_RESUME_END,
198
199 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
200 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
201
202 TARGET_EVENT_RESET_START,
203 TARGET_EVENT_RESET_ASSERT_PRE,
204 TARGET_EVENT_RESET_ASSERT_POST,
205 TARGET_EVENT_RESET_DEASSERT_PRE,
206 TARGET_EVENT_RESET_DEASSERT_POST,
207 TARGET_EVENT_RESET_HALT_PRE,
208 TARGET_EVENT_RESET_HALT_POST,
209 TARGET_EVENT_RESET_WAIT_PRE,
210 TARGET_EVENT_RESET_WAIT_POST,
211 TARGET_EVENT_RESET_INIT,
212 TARGET_EVENT_RESET_END,
213
214 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
215 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
216
217 TARGET_EVENT_EXAMINE_START,
218 TARGET_EVENT_EXAMINE_END,
219
220 TARGET_EVENT_GDB_ATTACH,
221 TARGET_EVENT_GDB_DETACH,
222
223 TARGET_EVENT_GDB_FLASH_ERASE_START,
224 TARGET_EVENT_GDB_FLASH_ERASE_END,
225 TARGET_EVENT_GDB_FLASH_WRITE_START,
226 TARGET_EVENT_GDB_FLASH_WRITE_END,
227 };
228
229 struct target_event_action {
230 enum target_event event;
231 Jim_Obj *body;
232 int has_percent;
233 struct target_event_action *next;
234 };
235
236 struct target_event_callback
237 {
238 int (*callback)(struct target *target, enum target_event event, void *priv);
239 void *priv;
240 struct target_event_callback *next;
241 };
242
243 struct target_timer_callback
244 {
245 int (*callback)(void *priv);
246 int time_ms;
247 int periodic;
248 struct timeval when;
249 void *priv;
250 struct target_timer_callback *next;
251 };
252
253 int target_register_commands(struct command_context *cmd_ctx);
254 int target_register_user_commands(struct command_context *cmd_ctx);
255 int target_init(struct command_context *cmd_ctx);
256 int target_examine(void);
257 int handle_target(void *priv);
258 int target_process_reset(struct command_context *cmd_ctx,
259 enum target_reset_mode reset_mode);
260
261 int target_register_event_callback(
262 int (*callback)(struct target *target,
263 enum target_event event, void *priv),
264 void *priv);
265 int target_unregister_event_callback(
266 int (*callback)(struct target *target,
267 enum target_event event, void *priv),
268 void *priv);
269 int target_poll(struct target *target);
270 int target_resume(struct target *target, int current, uint32_t address,
271 int handle_breakpoints, int debug_execution);
272 int target_halt(struct target *target);
273 int target_call_event_callbacks(struct target *target, enum target_event event);
274
275 /**
276 * The period is very approximate, the callback can happen much more often
277 * or much more rarely than specified
278 */
279 int target_register_timer_callback(int (*callback)(void *priv),
280 int time_ms, int periodic, void *priv);
281 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
282
283 int target_call_timer_callbacks(void);
284 /**
285 * Invoke this to ensure that e.g. polling timer callbacks happen before
286 * a syncrhonous command completes.
287 */
288 int target_call_timer_callbacks_now(void);
289
290 struct target* get_current_target(struct command_context *cmd_ctx);
291 struct target *get_target(const char *id);
292
293 /**
294 * Get the target name.
295 *
296 * This routine is a wrapper for the target->type->name field.
297 */
298 const char *target_get_name(struct target *target);
299
300 /**
301 * Examine the specified @a target, letting it perform any
302 * initialization that requires JTAG access.
303 *
304 * This routine is a wrapper for target->type->examine.
305 */
306 int target_examine_one(struct target *target);
307
308 /// @returns @c true if target_set_examined() has been called.
309 static inline bool target_was_examined(struct target *target)
310 {
311 return target->examined;
312 }
313
314 /// Sets the @c examined flag for the given target.
315 /// Use in target->type->examine() after one-time setup is done.
316 static inline void target_set_examined(struct target *target)
317 {
318 target->examined = true;
319 }
320
321 /**
322 * Add the @a breakpoint for @a target.
323 *
324 * This routine is a wrapper for target->type->add_breakpoint.
325 */
326 int target_add_breakpoint(struct target *target,
327 struct breakpoint *breakpoint);
328 /**
329 * Remove the @a breakpoint for @a target.
330 *
331 * This routine is a wrapper for target->type->remove_breakpoint.
332 */
333 int target_remove_breakpoint(struct target *target,
334 struct breakpoint *breakpoint);
335 /**
336 * Add the @a watchpoint for @a target.
337 *
338 * This routine is a wrapper for target->type->add_watchpoint.
339 */
340 int target_add_watchpoint(struct target *target,
341 struct watchpoint *watchpoint);
342 /**
343 * Remove the @a watchpoint for @a target.
344 *
345 * This routine is a wrapper for target->type->remove_watchpoint.
346 */
347 int target_remove_watchpoint(struct target *target,
348 struct watchpoint *watchpoint);
349
350 /**
351 * Obtain the registers for GDB.
352 *
353 * This routine is a wrapper for target->type->get_gdb_reg_list.
354 */
355 int target_get_gdb_reg_list(struct target *target,
356 struct reg **reg_list[], int *reg_list_size);
357
358 /**
359 * Step the target.
360 *
361 * This routine is a wrapper for target->type->step.
362 */
363 int target_step(struct target *target,
364 int current, uint32_t address, int handle_breakpoints);
365 /**
366 * Run an algorithm on the @a target given.
367 *
368 * This routine is a wrapper for target->type->run_algorithm.
369 */
370 int target_run_algorithm(struct target *target,
371 int num_mem_params, struct mem_param *mem_params,
372 int num_reg_params, struct reg_param *reg_param,
373 uint32_t entry_point, uint32_t exit_point,
374 int timeout_ms, void *arch_info);
375
376 /**
377 * Read @a count items of @a size bytes from the memory of @a target at
378 * the @a address given.
379 *
380 * This routine is a wrapper for target->type->read_memory.
381 */
382 int target_read_memory(struct target *target,
383 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
384 /**
385 * Write @a count items of @a size bytes to the memory of @a target at
386 * the @a address given.
387 *
388 * This routine is wrapper for target->type->write_memory.
389 */
390 int target_write_memory(struct target *target,
391 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
392
393 /**
394 * Write @a count items of 4 bytes to the memory of @a target at
395 * the @a address given. Because it operates only on whole words,
396 * this should be faster than target_write_memory().
397 *
398 * This routine is wrapper for target->type->bulk_write_memory.
399 */
400 int target_bulk_write_memory(struct target *target,
401 uint32_t address, uint32_t count, uint8_t *buffer);
402
403 /*
404 * Write to target memory using the virtual address.
405 *
406 * Note that this fn is used to implement software breakpoints. Targets
407 * can implement support for software breakpoints to memory marked as read
408 * only by making this fn write to ram even if it is read only(MMU or
409 * MPUs).
410 *
411 * It is sufficient to implement for writing a single word(16 or 32 in
412 * ARM32/16 bit case) to write the breakpoint to ram.
413 *
414 * The target should also take care of "other things" to make sure that
415 * software breakpoints can be written using this function. E.g.
416 * when there is a separate instruction and data cache, this fn must
417 * make sure that the instruction cache is synced up to the potential
418 * code change that can happen as a result of the memory write(typically
419 * by invalidating the cache).
420 *
421 * The high level wrapper fn in target.c will break down this memory write
422 * request to multiple write requests to the target driver to e.g. guarantee
423 * that writing 4 bytes to an aligned address happens with a single 32 bit
424 * write operation, thus making this fn suitable to e.g. write to special
425 * peripheral registers which do not support byte operations.
426 */
427 int target_write_buffer(struct target *target,
428 uint32_t address, uint32_t size, uint8_t *buffer);
429 int target_read_buffer(struct target *target,
430 uint32_t address, uint32_t size, uint8_t *buffer);
431 int target_checksum_memory(struct target *target,
432 uint32_t address, uint32_t size, uint32_t* crc);
433 int target_blank_check_memory(struct target *target,
434 uint32_t address, uint32_t size, uint32_t* blank);
435 int target_wait_state(struct target *target, enum target_state state, int ms);
436
437 /** Return the *name* of this targets current state */
438 const char *target_state_name( struct target *target );
439
440 /* DANGER!!!!!
441 *
442 * if "area" passed in to target_alloc_working_area() points to a memory
443 * location that goes out of scope (e.g. a pointer on the stack), then
444 * the caller of target_alloc_working_area() is responsible for invoking
445 * target_free_working_area() before "area" goes out of scope.
446 *
447 * target_free_all_working_areas() will NULL out the "area" pointer
448 * upon resuming or resetting the CPU.
449 *
450 */
451 int target_alloc_working_area(struct target *target,
452 uint32_t size, struct working_area **area);
453 int target_free_working_area(struct target *target, struct working_area *area);
454 int target_free_working_area_restore(struct target *target,
455 struct working_area *area, int restore);
456 void target_free_all_working_areas(struct target *target);
457 void target_free_all_working_areas_restore(struct target *target, int restore);
458
459 extern struct target *all_targets;
460
461 extern struct target_event_callback *target_event_callbacks;
462 extern struct target_timer_callback *target_timer_callbacks;
463
464 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
465 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
466 uint8_t target_buffer_get_u8 (struct target *target, const uint8_t *buffer);
467 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
468 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
469 void target_buffer_set_u8 (struct target *target, uint8_t *buffer, uint8_t value);
470
471 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
472 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
473 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
474 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
475 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
476 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
477
478 /* Issues USER() statements with target state information */
479 int target_arch_state(struct target *target);
480
481 void target_handle_event(struct target *t, enum target_event e);
482 void target_all_handle_event(enum target_event e);
483
484 #define ERROR_TARGET_INVALID (-300)
485 #define ERROR_TARGET_INIT_FAILED (-301)
486 #define ERROR_TARGET_TIMEOUT (-302)
487 #define ERROR_TARGET_NOT_HALTED (-304)
488 #define ERROR_TARGET_FAILURE (-305)
489 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
490 #define ERROR_TARGET_DATA_ABORT (-307)
491 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
492 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
493 #define ERROR_TARGET_NOT_RUNNING (-310)
494 #define ERROR_TARGET_NOT_EXAMINED (-311)
495
496 extern const Jim_Nvp nvp_error_target[];
497
498 const char *target_strerror_safe(int err);
499
500 #endif /* TARGET_H */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)