cleanup: rename armv4_5 to arm for readability
[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, write to the *
29 * Free Software Foundation, Inc., *
30 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
31 ***************************************************************************/
32 #ifndef TARGET_H
33 #define TARGET_H
34
35 #include <helper/types.h>
36
37 struct reg;
38 struct trace;
39 struct command_context;
40 struct breakpoint;
41 struct watchpoint;
42 struct mem_param;
43 struct reg_param;
44 struct target_list;
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
60 enum target_state
61 {
62 TARGET_UNKNOWN = 0,
63 TARGET_RUNNING = 1,
64 TARGET_HALTED = 2,
65 TARGET_RESET = 3,
66 TARGET_DEBUG_RUNNING = 4,
67 };
68
69 enum nvp_assert {
70 NVP_DEASSERT,
71 NVP_ASSERT,
72 };
73
74 enum target_reset_mode
75 {
76 RESET_UNKNOWN = 0,
77 RESET_RUN = 1, /* reset and let target run */
78 RESET_HALT = 2, /* reset and halt target out of reset */
79 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
80 };
81
82 enum target_debug_reason
83 {
84 DBG_REASON_DBGRQ = 0,
85 DBG_REASON_BREAKPOINT = 1,
86 DBG_REASON_WATCHPOINT = 2,
87 DBG_REASON_WPTANDBKPT = 3,
88 DBG_REASON_SINGLESTEP = 4,
89 DBG_REASON_NOTHALTED = 5,
90 DBG_REASON_UNDEFINED = 6
91 };
92
93 enum target_endianness
94 {
95 TARGET_ENDIAN_UNKNOWN = 0,
96 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
97 };
98
99 struct working_area
100 {
101 uint32_t address;
102 uint32_t size;
103 bool free;
104 uint8_t *backup;
105 struct working_area **user;
106 struct working_area *next;
107 };
108
109 struct gdb_service
110 {
111 struct target *target;
112 /* field for smp display */
113 /* element 0 coreid currently displayed ( 1 till n) */
114 /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
115 * all cores
116 core displayed */
117 int32_t core[2];
118 };
119
120 // target_type.h contains the full definitionof struct targe_type
121 struct target
122 {
123 struct target_type *type; /* target type definition (name, access functions) */
124 const char *cmd_name; /* tcl Name of target */
125 int target_number; /* DO NOT USE! field to be removed in 2010 */
126 struct jtag_tap *tap; /* where on the jtag chain is this */
127 int32_t coreid; /* which device on the TAP? */
128 const char *variant; /* what variant of this chip is it? */
129
130 /**
131 * Indicates whether this target has been examined.
132 *
133 * Do @b not access this field directly, use target_was_examined()
134 * or target_set_examined().
135 */
136 bool examined;
137
138 /** true iff the target is currently running a downloaded
139 * "algorithm" instetad of arbitrary user code. OpenOCD code
140 * invoking algorithms is trusted to maintain correctness of
141 * any cached state (e.g. for flash status), which arbitrary
142 * code will have no reason to know about.
143 */
144 bool running_alg;
145
146 struct target_event_action *event_action;
147
148 int reset_halt; /* attempt resetting the CPU into the halted mode? */
149 uint32_t working_area; /* working area (initialized RAM). Evaluated
150 * upon first allocation from virtual/physical address. */
151 bool working_area_virt_spec; /* virtual address specified? */
152 uint32_t working_area_virt; /* virtual address */
153 bool working_area_phys_spec; /* virtual address specified? */
154 uint32_t working_area_phys; /* physical address */
155 uint32_t working_area_size; /* size in bytes */
156 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
157 struct working_area *working_areas;/* list of allocated working areas */
158 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
159 enum target_endianness endianness; /* target endianness */
160 // also see: target_state_name()
161 enum target_state state; /* the current backend-state (running, halted, ...) */
162 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
163 struct breakpoint *breakpoints; /* list of breakpoints */
164 struct watchpoint *watchpoints; /* list of watchpoints */
165 struct trace *trace_info; /* generic trace information */
166 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
167 uint32_t dbg_msg_enabled; /* debug message status */
168 void *arch_info; /* architecture specific information */
169 struct target *next; /* next target in list */
170
171 int display; /* display async info in telnet session. Do not display
172 * lots of halted/resumed info when stepping in debugger. */
173 bool halt_issued; /* did we transition to halted state? */
174 long long halt_issued_time; /* Note time when halt was issued */
175
176 bool dbgbase_set; /* By default the debug base is not set */
177 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
178 system in place to support target specific options
179 currently. */
180 struct rtos *rtos; /* Instance of Real Time Operating System support */
181 bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
182 * and must be detected when symbols are offered */
183
184 int smp; /* add some target attributes for smp support */
185 struct target_list *head;
186 /* the gdb service is there in case of smp , we have only one gdb server
187 * for all smp target
188 * the target attached to the gdb is changing dynamically by changing
189 * gdb_service->target pointer */
190 struct gdb_service *gdb_service;
191 };
192
193
194 struct target_list {
195 struct target *target;
196 struct target_list *next;
197 };
198
199 /** Returns the instance-specific name of the specified target. */
200 static inline const char *target_name(struct target *target)
201 {
202 return target->cmd_name;
203 }
204
205 const char *debug_reason_name(struct target *t);
206
207 enum target_event
208 {
209 /* LD historical names
210 * - Prior to the great TCL change
211 * - June/July/Aug 2008
212 * - Duane Ellis */
213 TARGET_EVENT_OLD_gdb_program_config,
214 TARGET_EVENT_OLD_pre_resume,
215
216 /* allow GDB to do stuff before others handle the halted event,
217 * this is in lieu of defining ordering of invocation of events,
218 * which would be more complicated
219 *
220 * Telling GDB to halt does not mean that the target stopped running,
221 * simply that we're dropping out of GDB's waiting for step or continue.
222 *
223 * This can be useful when e.g. detecting power dropout.
224 */
225 TARGET_EVENT_GDB_HALT,
226 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
227 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
228 TARGET_EVENT_RESUME_START,
229 TARGET_EVENT_RESUME_END,
230
231 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
232 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
233
234 TARGET_EVENT_RESET_START,
235 TARGET_EVENT_RESET_ASSERT_PRE,
236 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
237 TARGET_EVENT_RESET_ASSERT_POST,
238 TARGET_EVENT_RESET_DEASSERT_PRE,
239 TARGET_EVENT_RESET_DEASSERT_POST,
240 TARGET_EVENT_RESET_HALT_PRE,
241 TARGET_EVENT_RESET_HALT_POST,
242 TARGET_EVENT_RESET_WAIT_PRE,
243 TARGET_EVENT_RESET_WAIT_POST,
244 TARGET_EVENT_RESET_INIT,
245 TARGET_EVENT_RESET_END,
246
247 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
248 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
249
250 TARGET_EVENT_EXAMINE_START,
251 TARGET_EVENT_EXAMINE_END,
252
253 TARGET_EVENT_GDB_ATTACH,
254 TARGET_EVENT_GDB_DETACH,
255
256 TARGET_EVENT_GDB_FLASH_ERASE_START,
257 TARGET_EVENT_GDB_FLASH_ERASE_END,
258 TARGET_EVENT_GDB_FLASH_WRITE_START,
259 TARGET_EVENT_GDB_FLASH_WRITE_END,
260 };
261
262 struct target_event_action {
263 enum target_event event;
264 struct Jim_Interp *interp;
265 struct Jim_Obj *body;
266 int has_percent;
267 struct target_event_action *next;
268 };
269
270 bool target_has_event_action(struct target *target, enum target_event event);
271
272 struct target_event_callback
273 {
274 int (*callback)(struct target *target, enum target_event event, void *priv);
275 void *priv;
276 struct target_event_callback *next;
277 };
278
279 struct target_timer_callback
280 {
281 int (*callback)(void *priv);
282 int time_ms;
283 int periodic;
284 struct timeval when;
285 void *priv;
286 struct target_timer_callback *next;
287 };
288
289 int target_register_commands(struct command_context *cmd_ctx);
290 int target_examine(void);
291
292 int target_register_event_callback(
293 int (*callback)(struct target *target,
294 enum target_event event, void *priv),
295 void *priv);
296 int target_unregister_event_callback(
297 int (*callback)(struct target *target,
298 enum target_event event, void *priv),
299 void *priv);
300 /* Poll the status of the target, detect any error conditions and report them.
301 *
302 * Also note that this fn will clear such error conditions, so a subsequent
303 * invocation will then succeed.
304 *
305 * These error conditions can be "sticky" error conditions. E.g. writing
306 * to memory could be implemented as an open loop and if memory writes
307 * fails, then a note is made of it, the error is sticky, but the memory
308 * write loop still runs to completion. This improves performance in the
309 * normal case as there is no need to verify that every single write succeed,
310 * yet it is possible to detect error condtions.
311 */
312 int target_poll(struct target *target);
313 int target_resume(struct target *target, int current, uint32_t address,
314 int handle_breakpoints, int debug_execution);
315 int target_halt(struct target *target);
316 int target_call_event_callbacks(struct target *target, enum target_event event);
317
318 /**
319 * The period is very approximate, the callback can happen much more often
320 * or much more rarely than specified
321 */
322 int target_register_timer_callback(int (*callback)(void *priv),
323 int time_ms, int periodic, void *priv);
324
325 int target_call_timer_callbacks(void);
326 /**
327 * Invoke this to ensure that e.g. polling timer callbacks happen before
328 * a syncrhonous command completes.
329 */
330 int target_call_timer_callbacks_now(void);
331
332 struct target* get_current_target(struct command_context *cmd_ctx);
333 struct target *get_target(const char *id);
334
335 /**
336 * Get the target type name.
337 *
338 * This routine is a wrapper for the target->type->name field.
339 * Note that this is not an instance-specific name for his target.
340 */
341 const char *target_type_name(struct target *target);
342
343 /**
344 * Examine the specified @a target, letting it perform any
345 * initialization that requires JTAG access.
346 *
347 * This routine is a wrapper for target->type->examine.
348 */
349 int target_examine_one(struct target *target);
350
351 /// @returns @c true if target_set_examined() has been called.
352 static inline bool target_was_examined(struct target *target)
353 {
354 return target->examined;
355 }
356
357 /// Sets the @c examined flag for the given target.
358 /// Use in target->type->examine() after one-time setup is done.
359 static inline void target_set_examined(struct target *target)
360 {
361 target->examined = true;
362 }
363
364 /**
365 * Add the @a breakpoint for @a target.
366 *
367 * This routine is a wrapper for target->type->add_breakpoint.
368 */
369 int target_add_breakpoint(struct target *target,
370 struct breakpoint *breakpoint);
371 /**
372 * Add the @a ContextID breakpoint for @a target.
373 *
374 * This routine is a wrapper for target->type->add_context_breakpoint.
375 */
376 int target_add_context_breakpoint(struct target *target,
377 struct breakpoint *breakpoint);
378 /**
379 * Add the @a ContextID & IVA breakpoint for @a target.
380 *
381 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
382 */
383 int target_add_hybrid_breakpoint(struct target *target,
384 struct breakpoint *breakpoint);
385 /**
386 * Remove the @a breakpoint for @a target.
387 *
388 * This routine is a wrapper for target->type->remove_breakpoint.
389 */
390
391 int target_remove_breakpoint(struct target *target,
392 struct breakpoint *breakpoint);
393 /**
394 * Add the @a watchpoint for @a target.
395 *
396 * This routine is a wrapper for target->type->add_watchpoint.
397 */
398 int target_add_watchpoint(struct target *target,
399 struct watchpoint *watchpoint);
400 /**
401 * Remove the @a watchpoint for @a target.
402 *
403 * This routine is a wrapper for target->type->remove_watchpoint.
404 */
405 int target_remove_watchpoint(struct target *target,
406 struct watchpoint *watchpoint);
407
408 /**
409 * Obtain the registers for GDB.
410 *
411 * This routine is a wrapper for target->type->get_gdb_reg_list.
412 */
413 int target_get_gdb_reg_list(struct target *target,
414 struct reg **reg_list[], int *reg_list_size);
415
416 /**
417 * Step the target.
418 *
419 * This routine is a wrapper for target->type->step.
420 */
421 int target_step(struct target *target,
422 int current, uint32_t address, int handle_breakpoints);
423 /**
424 * Run an algorithm on the @a target given.
425 *
426 * This routine is a wrapper for target->type->run_algorithm.
427 */
428 int target_run_algorithm(struct target *target,
429 int num_mem_params, struct mem_param *mem_params,
430 int num_reg_params, struct reg_param *reg_param,
431 uint32_t entry_point, uint32_t exit_point,
432 int timeout_ms, void *arch_info);
433
434 /**
435 * Starts an algorithm in the background on the @a target given.
436 *
437 * This routine is a wrapper for target->type->start_algorithm.
438 */
439 int target_start_algorithm(struct target *target,
440 int num_mem_params, struct mem_param *mem_params,
441 int num_reg_params, struct reg_param *reg_params,
442 uint32_t entry_point, uint32_t exit_point,
443 void *arch_info);
444
445 /**
446 * Wait for an algorithm on the @a target given.
447 *
448 * This routine is a wrapper for target->type->wait_algorithm.
449 */
450 int target_wait_algorithm(struct target *target,
451 int num_mem_params, struct mem_param *mem_params,
452 int num_reg_params, struct reg_param *reg_params,
453 uint32_t exit_point, int timeout_ms,
454 void *arch_info);
455
456 /**
457 * Read @a count items of @a size bytes from the memory of @a target at
458 * the @a address given.
459 *
460 * This routine is a wrapper for target->type->read_memory.
461 */
462 int target_read_memory(struct target *target,
463 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
464 /**
465 * Write @a count items of @a size bytes to the memory of @a target at
466 * the @a address given. @a address must be aligned to @a size
467 * in target memory.
468 *
469 * The endianness is the same in the host and target memory for this
470 * function.
471 *
472 * \todo TODO:
473 * Really @a buffer should have been defined as "const void *" and
474 * @a buffer should have been aligned to @a size in the host memory.
475 *
476 * This is not enforced via e.g. assert's today and e.g. the
477 * target_write_buffer fn breaks this assumption.
478 *
479 * This routine is wrapper for target->type->write_memory.
480 */
481 int target_write_memory(struct target *target,
482 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
483
484 /**
485 * Write @a count items of 4 bytes to the memory of @a target at
486 * the @a address given. Because it operates only on whole words,
487 * this should be faster than target_write_memory().
488 *
489 * This routine is wrapper for target->type->bulk_write_memory.
490 */
491 int target_bulk_write_memory(struct target *target,
492 uint32_t address, uint32_t count, const uint8_t *buffer);
493
494 /*
495 * Write to target memory using the virtual address.
496 *
497 * Note that this fn is used to implement software breakpoints. Targets
498 * can implement support for software breakpoints to memory marked as read
499 * only by making this fn write to ram even if it is read only(MMU or
500 * MPUs).
501 *
502 * It is sufficient to implement for writing a single word(16 or 32 in
503 * ARM32/16 bit case) to write the breakpoint to ram.
504 *
505 * The target should also take care of "other things" to make sure that
506 * software breakpoints can be written using this function. E.g.
507 * when there is a separate instruction and data cache, this fn must
508 * make sure that the instruction cache is synced up to the potential
509 * code change that can happen as a result of the memory write(typically
510 * by invalidating the cache).
511 *
512 * The high level wrapper fn in target.c will break down this memory write
513 * request to multiple write requests to the target driver to e.g. guarantee
514 * that writing 4 bytes to an aligned address happens with a single 32 bit
515 * write operation, thus making this fn suitable to e.g. write to special
516 * peripheral registers which do not support byte operations.
517 */
518 int target_write_buffer(struct target *target,
519 uint32_t address, uint32_t size, const uint8_t *buffer);
520 int target_read_buffer(struct target *target,
521 uint32_t address, uint32_t size, uint8_t *buffer);
522 int target_checksum_memory(struct target *target,
523 uint32_t address, uint32_t size, uint32_t* crc);
524 int target_blank_check_memory(struct target *target,
525 uint32_t address, uint32_t size, uint32_t* blank);
526 int target_wait_state(struct target *target, enum target_state state, int ms);
527
528 /** Return the *name* of this targets current state */
529 const char *target_state_name( struct target *target );
530
531 /* DANGER!!!!!
532 *
533 * if "area" passed in to target_alloc_working_area() points to a memory
534 * location that goes out of scope (e.g. a pointer on the stack), then
535 * the caller of target_alloc_working_area() is responsible for invoking
536 * target_free_working_area() before "area" goes out of scope.
537 *
538 * target_free_all_working_areas() will NULL out the "area" pointer
539 * upon resuming or resetting the CPU.
540 *
541 */
542 int target_alloc_working_area(struct target *target,
543 uint32_t size, struct working_area **area);
544 /* Same as target_alloc_working_area, except that no error is logged
545 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
546 *
547 * This allows the calling code to *try* to allocate target memory
548 * and have a fallback to another behavior(slower?).
549 */
550 int target_alloc_working_area_try(struct target *target,
551 uint32_t size, struct working_area **area);
552 int target_free_working_area(struct target *target, struct working_area *area);
553 void target_free_all_working_areas(struct target *target);
554
555 extern struct target *all_targets;
556
557 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
558 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
559 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
560 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
561 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
562 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
563
564 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
565 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
566 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf);
567 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf);
568
569 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
570 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
571 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
572 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
573 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
574 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
575
576 /* Issues USER() statements with target state information */
577 int target_arch_state(struct target *target);
578
579 void target_handle_event(struct target *t, enum target_event e);
580
581 #define ERROR_TARGET_INVALID (-300)
582 #define ERROR_TARGET_INIT_FAILED (-301)
583 #define ERROR_TARGET_TIMEOUT (-302)
584 #define ERROR_TARGET_NOT_HALTED (-304)
585 #define ERROR_TARGET_FAILURE (-305)
586 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
587 #define ERROR_TARGET_DATA_ABORT (-307)
588 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
589 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
590 #define ERROR_TARGET_NOT_RUNNING (-310)
591 #define ERROR_TARGET_NOT_EXAMINED (-311)
592
593 extern bool get_target_reset_nag(void);
594
595 #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)