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