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