914d62fd0af1fd87cca79a1d4f5a306e96981af4
[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 varient of this chip is it? */
133 struct target_event_action *event_action;
134
135 int reset_halt; /* attempt resetting the CPU into the halted mode? */
136 uint32_t working_area; /* working area (initialized RAM). Evaluated
137 * upon first allocation from virtual/physical address. */
138 bool working_area_virt_spec; /* virtual address specified? */
139 uint32_t working_area_virt; /* virtual address */
140 bool working_area_phys_spec; /* virtual address specified? */
141 uint32_t working_area_phys; /* physical address */
142 uint32_t working_area_size; /* size in bytes */
143 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
144 struct working_area *working_areas;/* list of allocated working areas */
145 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
146 enum target_endianess endianness; /* target endianess */
147 // also see: target_state_name()
148 enum target_state state; /* the current backend-state (running, halted, ...) */
149 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
150 struct breakpoint *breakpoints; /* list of breakpoints */
151 struct watchpoint *watchpoints; /* list of watchpoints */
152 struct trace *trace_info; /* generic trace information */
153 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
154 uint32_t dbg_msg_enabled; /* debug message status */
155 void *arch_info; /* architecture specific information */
156 struct target *next; /* next target in list */
157
158 int display; /* display async info in telnet session. Do not display
159 * lots of halted/resumed info when stepping in debugger. */
160 bool halt_issued; /* did we transition to halted state? */
161 long long halt_issued_time; /* Note time when halt was issued */
162 };
163
164 enum target_event
165 {
166 /* LD historical names
167 * - Prior to the great TCL change
168 * - June/July/Aug 2008
169 * - Duane Ellis */
170 TARGET_EVENT_OLD_gdb_program_config,
171 TARGET_EVENT_OLD_pre_reset,
172 TARGET_EVENT_OLD_post_reset,
173 TARGET_EVENT_OLD_pre_resume,
174
175 /* allow GDB to do stuff before others handle the halted event,
176 * this is in lieu of defining ordering of invocation of events,
177 * which would be more complicated
178 *
179 * Telling GDB to halt does not mean that the target stopped running,
180 * simply that we're dropping out of GDB's waiting for step or continue.
181 *
182 * This can be useful when e.g. detecting power dropout.
183 */
184 TARGET_EVENT_GDB_HALT,
185 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
186 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
187 TARGET_EVENT_RESUME_START,
188 TARGET_EVENT_RESUME_END,
189
190 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
191 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
192
193 TARGET_EVENT_RESET_START,
194 TARGET_EVENT_RESET_ASSERT_PRE,
195 TARGET_EVENT_RESET_ASSERT_POST,
196 TARGET_EVENT_RESET_DEASSERT_PRE,
197 TARGET_EVENT_RESET_DEASSERT_POST,
198 TARGET_EVENT_RESET_HALT_PRE,
199 TARGET_EVENT_RESET_HALT_POST,
200 TARGET_EVENT_RESET_WAIT_PRE,
201 TARGET_EVENT_RESET_WAIT_POST,
202 TARGET_EVENT_RESET_INIT,
203 TARGET_EVENT_RESET_END,
204
205 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
206 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
207
208 TARGET_EVENT_EXAMINE_START,
209 TARGET_EVENT_EXAMINE_END,
210
211 TARGET_EVENT_GDB_ATTACH,
212 TARGET_EVENT_GDB_DETACH,
213
214 TARGET_EVENT_GDB_FLASH_ERASE_START,
215 TARGET_EVENT_GDB_FLASH_ERASE_END,
216 TARGET_EVENT_GDB_FLASH_WRITE_START,
217 TARGET_EVENT_GDB_FLASH_WRITE_END,
218 };
219
220 struct target_event_action {
221 enum target_event event;
222 Jim_Obj *body;
223 int has_percent;
224 struct target_event_action *next;
225 };
226
227 struct target_event_callback
228 {
229 int (*callback)(struct target *target, enum target_event event, void *priv);
230 void *priv;
231 struct target_event_callback *next;
232 };
233
234 struct target_timer_callback
235 {
236 int (*callback)(void *priv);
237 int time_ms;
238 int periodic;
239 struct timeval when;
240 void *priv;
241 struct target_timer_callback *next;
242 };
243
244 int target_register_commands(struct command_context *cmd_ctx);
245 int target_register_user_commands(struct command_context *cmd_ctx);
246 int target_init(struct command_context *cmd_ctx);
247 int target_examine(void);
248 int handle_target(void *priv);
249 int target_process_reset(struct command_context *cmd_ctx,
250 enum target_reset_mode reset_mode);
251
252 int target_register_event_callback(
253 int (*callback)(struct target *target,
254 enum target_event event, void *priv),
255 void *priv);
256 int target_unregister_event_callback(
257 int (*callback)(struct target *target,
258 enum target_event event, void *priv),
259 void *priv);
260 int target_poll(struct target *target);
261 int target_resume(struct target *target, int current, uint32_t address,
262 int handle_breakpoints, int debug_execution);
263 int target_halt(struct target *target);
264 int target_call_event_callbacks(struct target *target, enum target_event event);
265
266 /**
267 * The period is very approximate, the callback can happen much more often
268 * or much more rarely than specified
269 */
270 int target_register_timer_callback(int (*callback)(void *priv),
271 int time_ms, int periodic, void *priv);
272 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
273
274 int target_call_timer_callbacks(void);
275 /**
276 * Invoke this to ensure that e.g. polling timer callbacks happen before
277 * a syncrhonous command completes.
278 */
279 int target_call_timer_callbacks_now(void);
280
281 struct target* get_current_target(struct command_context *cmd_ctx);
282 struct target *get_target(const char *id);
283
284 /**
285 * Get the target name.
286 *
287 * This routine is a wrapper for the target->type->name field.
288 */
289 const char *target_get_name(struct target *target);
290
291 /**
292 * Examine the specified @a target.
293 *
294 * This routine is a wrapper for target->type->examine.
295 */
296 int target_examine_one(struct target *target);
297 /// @returns @c true if the target has been examined.
298 bool target_was_examined(struct target *target);
299 /// Sets the @c examined flag for the given target.
300 void target_set_examined(struct target *target);
301 /// Reset the @c examined flag for the given target.
302 void target_reset_examined(struct target *target);
303
304
305 /**
306 * Add the @a breakpoint for @a target.
307 *
308 * This routine is a wrapper for target->type->add_breakpoint.
309 */
310 int target_add_breakpoint(struct target *target,
311 struct breakpoint *breakpoint);
312 /**
313 * Remove the @a breakpoint for @a target.
314 *
315 * This routine is a wrapper for target->type->remove_breakpoint.
316 */
317 int target_remove_breakpoint(struct target *target,
318 struct breakpoint *breakpoint);
319 /**
320 * Add the @a watchpoint for @a target.
321 *
322 * This routine is a wrapper for target->type->add_watchpoint.
323 */
324 int target_add_watchpoint(struct target *target,
325 struct watchpoint *watchpoint);
326 /**
327 * Remove the @a watchpoint for @a target.
328 *
329 * This routine is a wrapper for target->type->remove_watchpoint.
330 */
331 int target_remove_watchpoint(struct target *target,
332 struct watchpoint *watchpoint);
333
334 /**
335 * Obtain the registers for GDB.
336 *
337 * This routine is a wrapper for target->type->get_gdb_reg_list.
338 */
339 int target_get_gdb_reg_list(struct target *target,
340 struct reg **reg_list[], int *reg_list_size);
341
342 /**
343 * Step the target.
344 *
345 * This routine is a wrapper for target->type->step.
346 */
347 int target_step(struct target *target,
348 int current, uint32_t address, int handle_breakpoints);
349 /**
350 * Run an algorithm on the @a target given.
351 *
352 * This routine is a wrapper for target->type->run_algorithm.
353 */
354 int target_run_algorithm(struct target *target,
355 int num_mem_params, struct mem_param *mem_params,
356 int num_reg_params, struct reg_param *reg_param,
357 uint32_t entry_point, uint32_t exit_point,
358 int timeout_ms, void *arch_info);
359
360 /**
361 * Read @a count items of @a size bytes from the memory of @a target at
362 * the @a address given.
363 *
364 * This routine is a wrapper for target->type->read_memory.
365 */
366 int target_read_memory(struct target *target,
367 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
368 /**
369 * Write @a count items of @a size bytes to the memory of @a target at
370 * the @a address given.
371 *
372 * This routine is wrapper for target->type->write_memory.
373 */
374 int target_write_memory(struct target *target,
375 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
376
377 /**
378 * Write @a count items of 4 bytes to the memory of @a target at
379 * the @a address given. Because it operates only on whole words,
380 * this should be faster than target_write_memory().
381 *
382 * This routine is wrapper for target->type->bulk_write_memory.
383 */
384 int target_bulk_write_memory(struct target *target,
385 uint32_t address, uint32_t count, uint8_t *buffer);
386
387 /*
388 * Write to target memory using the virtual address.
389 *
390 * Note that this fn is used to implement software breakpoints. Targets
391 * can implement support for software breakpoints to memory marked as read
392 * only by making this fn write to ram even if it is read only(MMU or
393 * MPUs).
394 *
395 * It is sufficient to implement for writing a single word(16 or 32 in
396 * ARM32/16 bit case) to write the breakpoint to ram.
397 *
398 * The target should also take care of "other things" to make sure that
399 * software breakpoints can be written using this function. E.g.
400 * when there is a separate instruction and data cache, this fn must
401 * make sure that the instruction cache is synced up to the potential
402 * code change that can happen as a result of the memory write(typically
403 * by invalidating the cache).
404 *
405 * The high level wrapper fn in target.c will break down this memory write
406 * request to multiple write requests to the target driver to e.g. guarantee
407 * that writing 4 bytes to an aligned address happens with a single 32 bit
408 * write operation, thus making this fn suitable to e.g. write to special
409 * peripheral registers which do not support byte operations.
410 */
411 int target_write_buffer(struct target *target,
412 uint32_t address, uint32_t size, uint8_t *buffer);
413 int target_read_buffer(struct target *target,
414 uint32_t address, uint32_t size, uint8_t *buffer);
415 int target_checksum_memory(struct target *target,
416 uint32_t address, uint32_t size, uint32_t* crc);
417 int target_blank_check_memory(struct target *target,
418 uint32_t address, uint32_t size, uint32_t* blank);
419 int target_wait_state(struct target *target, enum target_state state, int ms);
420
421 /** Return the *name* of this targets current state */
422 const char *target_state_name( struct target *target );
423
424 /* DANGER!!!!!
425 *
426 * if "area" passed in to target_alloc_working_area() points to a memory
427 * location that goes out of scope (e.g. a pointer on the stack), then
428 * the caller of target_alloc_working_area() is responsible for invoking
429 * target_free_working_area() before "area" goes out of scope.
430 *
431 * target_free_all_working_areas() will NULL out the "area" pointer
432 * upon resuming or resetting the CPU.
433 *
434 */
435 int target_alloc_working_area(struct target *target,
436 uint32_t size, struct working_area **area);
437 int target_free_working_area(struct target *target, struct working_area *area);
438 int target_free_working_area_restore(struct target *target,
439 struct working_area *area, int restore);
440 void target_free_all_working_areas(struct target *target);
441 void target_free_all_working_areas_restore(struct target *target, int restore);
442
443 extern struct target *all_targets;
444
445 extern struct target_event_callback *target_event_callbacks;
446 extern struct target_timer_callback *target_timer_callbacks;
447
448 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
449 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
450 uint8_t target_buffer_get_u8 (struct target *target, const uint8_t *buffer);
451 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
452 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
453 void target_buffer_set_u8 (struct target *target, uint8_t *buffer, uint8_t value);
454
455 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
456 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
457 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
458 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
459 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
460 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
461
462 /* Issues USER() statements with target state information */
463 int target_arch_state(struct target *target);
464
465 void target_handle_event(struct target *t, enum target_event e);
466 void target_all_handle_event(enum target_event e);
467
468 #define ERROR_TARGET_INVALID (-300)
469 #define ERROR_TARGET_INIT_FAILED (-301)
470 #define ERROR_TARGET_TIMEOUT (-302)
471 #define ERROR_TARGET_NOT_HALTED (-304)
472 #define ERROR_TARGET_FAILURE (-305)
473 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
474 #define ERROR_TARGET_DATA_ABORT (-307)
475 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
476 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
477 #define ERROR_TARGET_NOT_RUNNING (-310)
478 #define ERROR_TARGET_NOT_EXAMINED (-311)
479
480 extern const Jim_Nvp nvp_error_target[];
481
482 const char *target_strerror_safe(int err);
483
484 #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)