44f382a22c39341e70e2776972ddb1cc94abb0cb
[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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
31 ***************************************************************************/
32
33 #ifndef TARGET_H
34 #define TARGET_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 uint32_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 const 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 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 /**
143 * true if the target is currently running a downloaded
144 * "algorithm" instead of arbitrary user code. OpenOCD code
145 * invoking algorithms is trusted to maintain correctness of
146 * any cached state (e.g. for flash status), which arbitrary
147 * code will have no reason to know about.
148 */
149 bool running_alg;
150
151 struct target_event_action *event_action;
152
153 int reset_halt; /* attempt resetting the CPU into the halted mode? */
154 uint32_t working_area; /* working area (initialised RAM). Evaluated
155 * upon first allocation from virtual/physical address. */
156 bool working_area_virt_spec; /* virtual address specified? */
157 uint32_t working_area_virt; /* virtual address */
158 bool working_area_phys_spec; /* virtual address specified? */
159 uint32_t working_area_phys; /* physical address */
160 uint32_t working_area_size; /* size in bytes */
161 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
162 struct working_area *working_areas;/* list of allocated working areas */
163 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
164 enum target_endianness endianness; /* target endianness */
165 /* also see: target_state_name() */
166 enum target_state state; /* the current backend-state (running, halted, ...) */
167 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
168 struct breakpoint *breakpoints; /* list of breakpoints */
169 struct watchpoint *watchpoints; /* list of watchpoints */
170 struct trace *trace_info; /* generic trace information */
171 struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
172 uint32_t dbg_msg_enabled; /* debug message status */
173 void *arch_info; /* architecture specific information */
174 struct target *next; /* next target in list */
175
176 int display; /* display async info in telnet session. Do not display
177 * lots of halted/resumed info when stepping in debugger. */
178 bool halt_issued; /* did we transition to halted state? */
179 long long halt_issued_time; /* Note time when halt was issued */
180
181 bool dbgbase_set; /* By default the debug base is not set */
182 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
183 * system in place to support target specific options
184 * currently. */
185 struct rtos *rtos; /* Instance of Real Time Operating System support */
186 bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
187 * and must be detected when symbols are offered */
188 struct backoff_timer backoff;
189 int smp; /* add some target attributes for smp support */
190 struct target_list *head;
191 /* the gdb service is there in case of smp, we have only one gdb server
192 * for all smp target
193 * the target attached to the gdb is changing dynamically by changing
194 * gdb_service->target pointer */
195 struct gdb_service *gdb_service;
196
197 /* file-I/O information for host to do syscall */
198 struct gdb_fileio_info *fileio_info;
199 };
200
201 struct target_list {
202 struct target *target;
203 struct target_list *next;
204 };
205
206 struct gdb_fileio_info {
207 char *identifier;
208 uint32_t param_1;
209 uint32_t param_2;
210 uint32_t param_3;
211 uint32_t param_4;
212 };
213
214 /** Returns the instance-specific name of the specified target. */
215 static inline const char *target_name(struct target *target)
216 {
217 return target->cmd_name;
218 }
219
220 const char *debug_reason_name(struct target *t);
221
222 enum target_event {
223
224 /* allow GDB to do stuff before others handle the halted event,
225 * this is in lieu of defining ordering of invocation of events,
226 * which would be more complicated
227 *
228 * Telling GDB to halt does not mean that the target stopped running,
229 * simply that we're dropping out of GDB's waiting for step or continue.
230 *
231 * This can be useful when e.g. detecting power dropout.
232 */
233 TARGET_EVENT_GDB_HALT,
234 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
235 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
236 TARGET_EVENT_RESUME_START,
237 TARGET_EVENT_RESUME_END,
238
239 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
240 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
241
242 TARGET_EVENT_RESET_START,
243 TARGET_EVENT_RESET_ASSERT_PRE,
244 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
245 TARGET_EVENT_RESET_ASSERT_POST,
246 TARGET_EVENT_RESET_DEASSERT_PRE,
247 TARGET_EVENT_RESET_DEASSERT_POST,
248 TARGET_EVENT_RESET_HALT_PRE,
249 TARGET_EVENT_RESET_HALT_POST,
250 TARGET_EVENT_RESET_WAIT_PRE,
251 TARGET_EVENT_RESET_WAIT_POST,
252 TARGET_EVENT_RESET_INIT,
253 TARGET_EVENT_RESET_END,
254
255 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
256 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
257
258 TARGET_EVENT_EXAMINE_START,
259 TARGET_EVENT_EXAMINE_END,
260
261 TARGET_EVENT_GDB_ATTACH,
262 TARGET_EVENT_GDB_DETACH,
263
264 TARGET_EVENT_GDB_FLASH_ERASE_START,
265 TARGET_EVENT_GDB_FLASH_ERASE_END,
266 TARGET_EVENT_GDB_FLASH_WRITE_START,
267 TARGET_EVENT_GDB_FLASH_WRITE_END,
268 };
269
270 struct target_event_action {
271 enum target_event event;
272 struct Jim_Interp *interp;
273 struct Jim_Obj *body;
274 int has_percent;
275 struct target_event_action *next;
276 };
277
278 bool target_has_event_action(struct target *target, enum target_event event);
279
280 struct target_event_callback {
281 int (*callback)(struct target *target, enum target_event event, void *priv);
282 void *priv;
283 struct target_event_callback *next;
284 };
285
286 struct target_timer_callback {
287 int (*callback)(void *priv);
288 int time_ms;
289 int periodic;
290 struct timeval when;
291 void *priv;
292 struct target_timer_callback *next;
293 };
294
295 int target_register_commands(struct command_context *cmd_ctx);
296 int target_examine(void);
297
298 int target_register_event_callback(
299 int (*callback)(struct target *target,
300 enum target_event event, void *priv),
301 void *priv);
302 int target_unregister_event_callback(
303 int (*callback)(struct target *target,
304 enum target_event event, void *priv),
305 void *priv);
306
307 /* Poll the status of the target, detect any error conditions and report them.
308 *
309 * Also note that this fn will clear such error conditions, so a subsequent
310 * invocation will then succeed.
311 *
312 * These error conditions can be "sticky" error conditions. E.g. writing
313 * to memory could be implemented as an open loop and if memory writes
314 * fails, then a note is made of it, the error is sticky, but the memory
315 * write loop still runs to completion. This improves performance in the
316 * normal case as there is no need to verify that every single write succeed,
317 * yet it is possible to detect error conditions.
318 */
319 int target_poll(struct target *target);
320 int target_resume(struct target *target, int current, uint32_t address,
321 int handle_breakpoints, int debug_execution);
322 int target_halt(struct target *target);
323 int target_call_event_callbacks(struct target *target, enum target_event event);
324
325 /**
326 * The period is very approximate, the callback can happen much more often
327 * or much more rarely than specified
328 */
329 int target_register_timer_callback(int (*callback)(void *priv),
330 int time_ms, int periodic, void *priv);
331
332 int target_call_timer_callbacks(void);
333 /**
334 * Invoke this to ensure that e.g. polling timer callbacks happen before
335 * a synchronous command completes.
336 */
337 int target_call_timer_callbacks_now(void);
338
339 struct target *get_current_target(struct command_context *cmd_ctx);
340 struct target *get_target(const char *id);
341
342 /**
343 * Get the target type name.
344 *
345 * This routine is a wrapper for the target->type->name field.
346 * Note that this is not an instance-specific name for his target.
347 */
348 const char *target_type_name(struct target *target);
349
350 /**
351 * Examine the specified @a target, letting it perform any
352 * Initialisation that requires JTAG access.
353 *
354 * This routine is a wrapper for target->type->examine.
355 */
356 int target_examine_one(struct target *target);
357
358 /** @returns @c true if target_set_examined() has been called. */
359 static inline bool target_was_examined(struct target *target)
360 {
361 return target->examined;
362 }
363
364 /** Sets the @c examined flag for the given target. */
365 /** Use in target->type->examine() after one-time setup is done. */
366 static inline void target_set_examined(struct target *target)
367 {
368 target->examined = true;
369 }
370
371 /**
372 * Add the @a breakpoint for @a target.
373 *
374 * This routine is a wrapper for target->type->add_breakpoint.
375 */
376 int target_add_breakpoint(struct target *target,
377 struct breakpoint *breakpoint);
378 /**
379 * Add the @a ContextID breakpoint for @a target.
380 *
381 * This routine is a wrapper for target->type->add_context_breakpoint.
382 */
383 int target_add_context_breakpoint(struct target *target,
384 struct breakpoint *breakpoint);
385 /**
386 * Add the @a ContextID & IVA breakpoint for @a target.
387 *
388 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
389 */
390 int target_add_hybrid_breakpoint(struct target *target,
391 struct breakpoint *breakpoint);
392 /**
393 * Remove the @a breakpoint for @a target.
394 *
395 * This routine is a wrapper for target->type->remove_breakpoint.
396 */
397
398 int target_remove_breakpoint(struct target *target,
399 struct breakpoint *breakpoint);
400 /**
401 * Add the @a watchpoint for @a target.
402 *
403 * This routine is a wrapper for target->type->add_watchpoint.
404 */
405 int target_add_watchpoint(struct target *target,
406 struct watchpoint *watchpoint);
407 /**
408 * Remove the @a watchpoint for @a target.
409 *
410 * This routine is a wrapper for target->type->remove_watchpoint.
411 */
412 int target_remove_watchpoint(struct target *target,
413 struct watchpoint *watchpoint);
414
415 /**
416 * Find out the just hit @a watchpoint for @a target.
417 *
418 * This routine is a wrapper for target->type->hit_watchpoint.
419 */
420 int target_hit_watchpoint(struct target *target,
421 struct watchpoint **watchpoint);
422
423 /**
424 * Obtain the registers for GDB.
425 *
426 * This routine is a wrapper for target->type->get_gdb_reg_list.
427 */
428 int target_get_gdb_reg_list(struct target *target,
429 struct reg **reg_list[], int *reg_list_size,
430 enum target_register_class reg_class);
431
432 /**
433 * Step the target.
434 *
435 * This routine is a wrapper for target->type->step.
436 */
437 int target_step(struct target *target,
438 int current, uint32_t address, int handle_breakpoints);
439 /**
440 * Run an algorithm on the @a target given.
441 *
442 * This routine is a wrapper for target->type->run_algorithm.
443 */
444 int target_run_algorithm(struct target *target,
445 int num_mem_params, struct mem_param *mem_params,
446 int num_reg_params, struct reg_param *reg_param,
447 uint32_t entry_point, uint32_t exit_point,
448 int timeout_ms, void *arch_info);
449
450 /**
451 * Starts an algorithm in the background on the @a target given.
452 *
453 * This routine is a wrapper for target->type->start_algorithm.
454 */
455 int target_start_algorithm(struct target *target,
456 int num_mem_params, struct mem_param *mem_params,
457 int num_reg_params, struct reg_param *reg_params,
458 uint32_t entry_point, uint32_t exit_point,
459 void *arch_info);
460
461 /**
462 * Wait for an algorithm on the @a target given.
463 *
464 * This routine is a wrapper for target->type->wait_algorithm.
465 */
466 int target_wait_algorithm(struct target *target,
467 int num_mem_params, struct mem_param *mem_params,
468 int num_reg_params, struct reg_param *reg_params,
469 uint32_t exit_point, int timeout_ms,
470 void *arch_info);
471
472 /**
473 * This routine is a wrapper for asynchronous algorithms.
474 *
475 */
476 int target_run_flash_async_algorithm(struct target *target,
477 uint8_t *buffer, uint32_t count, int block_size,
478 int num_mem_params, struct mem_param *mem_params,
479 int num_reg_params, struct reg_param *reg_params,
480 uint32_t buffer_start, uint32_t buffer_size,
481 uint32_t entry_point, uint32_t exit_point,
482 void *arch_info);
483
484 /**
485 * Read @a count items of @a size bytes from the memory of @a target at
486 * the @a address given.
487 *
488 * This routine is a wrapper for target->type->read_memory.
489 */
490 int target_read_memory(struct target *target,
491 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
492 int target_read_phys_memory(struct target *target,
493 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
494 /**
495 * Write @a count items of @a size bytes to the memory of @a target at
496 * the @a address given. @a address must be aligned to @a size
497 * in target memory.
498 *
499 * The endianness is the same in the host and target memory for this
500 * function.
501 *
502 * \todo TODO:
503 * Really @a buffer should have been defined as "const void *" and
504 * @a buffer should have been aligned to @a size in the host memory.
505 *
506 * This is not enforced via e.g. assert's today and e.g. the
507 * target_write_buffer fn breaks this assumption.
508 *
509 * This routine is wrapper for target->type->write_memory.
510 */
511 int target_write_memory(struct target *target,
512 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
513 int target_write_phys_memory(struct target *target,
514 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
515
516 /*
517 * Write to target memory using the virtual address.
518 *
519 * Note that this fn is used to implement software breakpoints. Targets
520 * can implement support for software breakpoints to memory marked as read
521 * only by making this fn write to ram even if it is read only(MMU or
522 * MPUs).
523 *
524 * It is sufficient to implement for writing a single word(16 or 32 in
525 * ARM32/16 bit case) to write the breakpoint to ram.
526 *
527 * The target should also take care of "other things" to make sure that
528 * software breakpoints can be written using this function. E.g.
529 * when there is a separate instruction and data cache, this fn must
530 * make sure that the instruction cache is synced up to the potential
531 * code change that can happen as a result of the memory write(typically
532 * by invalidating the cache).
533 *
534 * The high level wrapper fn in target.c will break down this memory write
535 * request to multiple write requests to the target driver to e.g. guarantee
536 * that writing 4 bytes to an aligned address happens with a single 32 bit
537 * write operation, thus making this fn suitable to e.g. write to special
538 * peripheral registers which do not support byte operations.
539 */
540 int target_write_buffer(struct target *target,
541 uint32_t address, uint32_t size, const uint8_t *buffer);
542 int target_read_buffer(struct target *target,
543 uint32_t address, uint32_t size, uint8_t *buffer);
544 int target_checksum_memory(struct target *target,
545 uint32_t address, uint32_t size, uint32_t *crc);
546 int target_blank_check_memory(struct target *target,
547 uint32_t address, uint32_t size, uint32_t *blank);
548 int target_wait_state(struct target *target, enum target_state state, int ms);
549
550 /**
551 * Obtain file-I/O information from target for GDB to do syscall.
552 *
553 * This routine is a wrapper for target->type->get_gdb_fileio_info.
554 */
555 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
556
557 /**
558 * Pass GDB file-I/O response to target after finishing host syscall.
559 *
560 * This routine is a wrapper for target->type->gdb_fileio_end.
561 */
562 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
563
564
565
566 /** Return the *name* of this targets current state */
567 const char *target_state_name(struct target *target);
568
569 /* DANGER!!!!!
570 *
571 * if "area" passed in to target_alloc_working_area() points to a memory
572 * location that goes out of scope (e.g. a pointer on the stack), then
573 * the caller of target_alloc_working_area() is responsible for invoking
574 * target_free_working_area() before "area" goes out of scope.
575 *
576 * target_free_all_working_areas() will NULL out the "area" pointer
577 * upon resuming or resetting the CPU.
578 *
579 */
580 int target_alloc_working_area(struct target *target,
581 uint32_t size, struct working_area **area);
582 /* Same as target_alloc_working_area, except that no error is logged
583 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
584 *
585 * This allows the calling code to *try* to allocate target memory
586 * and have a fallback to another behaviour(slower?).
587 */
588 int target_alloc_working_area_try(struct target *target,
589 uint32_t size, struct working_area **area);
590 int target_free_working_area(struct target *target, struct working_area *area);
591 void target_free_all_working_areas(struct target *target);
592 uint32_t target_get_working_area_avail(struct target *target);
593
594 extern struct target *all_targets;
595
596 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
597 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
598 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
599 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
600 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
601 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
602
603 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
604 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
605 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf);
606 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf);
607
608 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
609 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
610 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
611 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
612 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
613 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
614
615 /* Issues USER() statements with target state information */
616 int target_arch_state(struct target *target);
617
618 void target_handle_event(struct target *t, enum target_event e);
619
620 #define ERROR_TARGET_INVALID (-300)
621 #define ERROR_TARGET_INIT_FAILED (-301)
622 #define ERROR_TARGET_TIMEOUT (-302)
623 #define ERROR_TARGET_NOT_HALTED (-304)
624 #define ERROR_TARGET_FAILURE (-305)
625 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
626 #define ERROR_TARGET_DATA_ABORT (-307)
627 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
628 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
629 #define ERROR_TARGET_NOT_RUNNING (-310)
630 #define ERROR_TARGET_NOT_EXAMINED (-311)
631
632 extern bool get_target_reset_nag(void);
633
634 #endif /* TARGET_H */