types: write memory now uses const
[openocd/ntfreak.git] / src / target / target.h
blobfd7de560e3e375c113b7144a8b0852a838b63ab4
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 * 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
29 #include <helper/types.h>
31 struct reg;
32 struct trace;
33 struct command_context;
34 struct breakpoint;
35 struct watchpoint;
36 struct mem_param;
37 struct reg_param;
41 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
42 * TARGET_RUNNING = 1: the target is executing user code
43 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
44 * debugger. on an xscale it means that the debug handler is executing
45 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
46 * not sure how this is used with all the recent changes)
47 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
48 * behalf of the debugger (e.g. algorithm for flashing)
50 * also see: target_state_name();
54 enum target_state
56 TARGET_UNKNOWN = 0,
57 TARGET_RUNNING = 1,
58 TARGET_HALTED = 2,
59 TARGET_RESET = 3,
60 TARGET_DEBUG_RUNNING = 4,
63 enum nvp_assert {
64 NVP_DEASSERT,
65 NVP_ASSERT,
68 enum target_reset_mode
70 RESET_UNKNOWN = 0,
71 RESET_RUN = 1, /* reset and let target run */
72 RESET_HALT = 2, /* reset and halt target out of reset */
73 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
76 enum target_debug_reason
78 DBG_REASON_DBGRQ = 0,
79 DBG_REASON_BREAKPOINT = 1,
80 DBG_REASON_WATCHPOINT = 2,
81 DBG_REASON_WPTANDBKPT = 3,
82 DBG_REASON_SINGLESTEP = 4,
83 DBG_REASON_NOTHALTED = 5,
84 DBG_REASON_UNDEFINED = 6
87 enum target_endianness
89 TARGET_ENDIAN_UNKNOWN = 0,
90 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
93 struct working_area
95 uint32_t address;
96 uint32_t size;
97 bool free;
98 uint8_t *backup;
99 struct working_area **user;
100 struct working_area *next;
103 // target_type.h contains the full definitionof struct targe_type
104 struct target
106 struct target_type *type; /* target type definition (name, access functions) */
107 const char *cmd_name; /* tcl Name of target */
108 int target_number; /* DO NOT USE! field to be removed in 2010 */
109 struct jtag_tap *tap; /* where on the jtag chain is this */
110 int coreid; /* which device on the TAP? */
111 const char *variant; /* what variant of this chip is it? */
114 * Indicates whether this target has been examined.
116 * Do @b not access this field directly, use target_was_examined()
117 * or target_set_examined().
119 bool examined;
121 /** true iff the target is currently running a downloaded
122 * "algorithm" instetad of arbitrary user code. OpenOCD code
123 * invoking algorithms is trusted to maintain correctness of
124 * any cached state (e.g. for flash status), which arbitrary
125 * code will have no reason to know about.
127 bool running_alg;
129 struct target_event_action *event_action;
131 int reset_halt; /* attempt resetting the CPU into the halted mode? */
132 uint32_t working_area; /* working area (initialized RAM). Evaluated
133 * upon first allocation from virtual/physical address. */
134 bool working_area_virt_spec; /* virtual address specified? */
135 uint32_t working_area_virt; /* virtual address */
136 bool working_area_phys_spec; /* virtual address specified? */
137 uint32_t working_area_phys; /* physical address */
138 uint32_t working_area_size; /* size in bytes */
139 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
140 struct working_area *working_areas;/* list of allocated working areas */
141 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
142 enum target_endianness endianness; /* target endianness */
143 // also see: target_state_name()
144 enum target_state state; /* the current backend-state (running, halted, ...) */
145 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
146 struct breakpoint *breakpoints; /* list of breakpoints */
147 struct watchpoint *watchpoints; /* list of watchpoints */
148 struct trace *trace_info; /* generic trace information */
149 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
150 uint32_t dbg_msg_enabled; /* debug message status */
151 void *arch_info; /* architecture specific information */
152 struct target *next; /* next target in list */
154 int display; /* display async info in telnet session. Do not display
155 * lots of halted/resumed info when stepping in debugger. */
156 bool halt_issued; /* did we transition to halted state? */
157 long long halt_issued_time; /* Note time when halt was issued */
159 bool dbgbase_set; /* By default the debug base is not set */
160 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
161 system in place to support target specific options
162 currently. */
165 /** Returns the instance-specific name of the specified target. */
166 static inline const char *target_name(struct target *target)
168 return target->cmd_name;
171 const char *debug_reason_name(struct target *t);
173 enum target_event
175 /* LD historical names
176 * - Prior to the great TCL change
177 * - June/July/Aug 2008
178 * - Duane Ellis */
179 TARGET_EVENT_OLD_gdb_program_config,
180 TARGET_EVENT_OLD_pre_resume,
182 /* allow GDB to do stuff before others handle the halted event,
183 * this is in lieu of defining ordering of invocation of events,
184 * which would be more complicated
186 * Telling GDB to halt does not mean that the target stopped running,
187 * simply that we're dropping out of GDB's waiting for step or continue.
189 * This can be useful when e.g. detecting power dropout.
191 TARGET_EVENT_GDB_HALT,
192 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
193 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
194 TARGET_EVENT_RESUME_START,
195 TARGET_EVENT_RESUME_END,
197 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
198 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
200 TARGET_EVENT_RESET_START,
201 TARGET_EVENT_RESET_ASSERT_PRE,
202 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
203 TARGET_EVENT_RESET_ASSERT_POST,
204 TARGET_EVENT_RESET_DEASSERT_PRE,
205 TARGET_EVENT_RESET_DEASSERT_POST,
206 TARGET_EVENT_RESET_HALT_PRE,
207 TARGET_EVENT_RESET_HALT_POST,
208 TARGET_EVENT_RESET_WAIT_PRE,
209 TARGET_EVENT_RESET_WAIT_POST,
210 TARGET_EVENT_RESET_INIT,
211 TARGET_EVENT_RESET_END,
213 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
214 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
216 TARGET_EVENT_EXAMINE_START,
217 TARGET_EVENT_EXAMINE_END,
219 TARGET_EVENT_GDB_ATTACH,
220 TARGET_EVENT_GDB_DETACH,
222 TARGET_EVENT_GDB_FLASH_ERASE_START,
223 TARGET_EVENT_GDB_FLASH_ERASE_END,
224 TARGET_EVENT_GDB_FLASH_WRITE_START,
225 TARGET_EVENT_GDB_FLASH_WRITE_END,
228 struct target_event_action {
229 enum target_event event;
230 struct Jim_Interp *interp;
231 struct Jim_Obj *body;
232 int has_percent;
233 struct target_event_action *next;
236 bool target_has_event_action(struct target *target, enum target_event event);
238 struct target_event_callback
240 int (*callback)(struct target *target, enum target_event event, void *priv);
241 void *priv;
242 struct target_event_callback *next;
245 struct target_timer_callback
247 int (*callback)(void *priv);
248 int time_ms;
249 int periodic;
250 struct timeval when;
251 void *priv;
252 struct target_timer_callback *next;
255 int target_register_commands(struct command_context *cmd_ctx);
256 int target_examine(void);
258 int target_register_event_callback(
259 int (*callback)(struct target *target,
260 enum target_event event, void *priv),
261 void *priv);
262 int target_unregister_event_callback(
263 int (*callback)(struct target *target,
264 enum target_event event, void *priv),
265 void *priv);
266 /* Poll the status of the target, detect any error conditions and report them.
268 * Also note that this fn will clear such error conditions, so a subsequent
269 * invocation will then succeed.
271 * These error conditions can be "sticky" error conditions. E.g. writing
272 * to memory could be implemented as an open loop and if memory writes
273 * fails, then a note is made of it, the error is sticky, but the memory
274 * write loop still runs to completion. This improves performance in the
275 * normal case as there is no need to verify that every single write succeed,
276 * yet it is possible to detect error condtions.
278 int target_poll(struct target *target);
279 int target_resume(struct target *target, int current, uint32_t address,
280 int handle_breakpoints, int debug_execution);
281 int target_halt(struct target *target);
282 int target_call_event_callbacks(struct target *target, enum target_event event);
285 * The period is very approximate, the callback can happen much more often
286 * or much more rarely than specified
288 int target_register_timer_callback(int (*callback)(void *priv),
289 int time_ms, int periodic, void *priv);
291 int target_call_timer_callbacks(void);
293 * Invoke this to ensure that e.g. polling timer callbacks happen before
294 * a syncrhonous command completes.
296 int target_call_timer_callbacks_now(void);
298 struct target* get_current_target(struct command_context *cmd_ctx);
299 struct target *get_target(const char *id);
302 * Get the target type name.
304 * This routine is a wrapper for the target->type->name field.
305 * Note that this is not an instance-specific name for his target.
307 const char *target_type_name(struct target *target);
310 * Examine the specified @a target, letting it perform any
311 * initialization that requires JTAG access.
313 * This routine is a wrapper for target->type->examine.
315 int target_examine_one(struct target *target);
317 /// @returns @c true if target_set_examined() has been called.
318 static inline bool target_was_examined(struct target *target)
320 return target->examined;
323 /// Sets the @c examined flag for the given target.
324 /// Use in target->type->examine() after one-time setup is done.
325 static inline void target_set_examined(struct target *target)
327 target->examined = true;
331 * Add the @a breakpoint for @a target.
333 * This routine is a wrapper for target->type->add_breakpoint.
335 int target_add_breakpoint(struct target *target,
336 struct breakpoint *breakpoint);
338 * Remove the @a breakpoint for @a target.
340 * This routine is a wrapper for target->type->remove_breakpoint.
342 int target_remove_breakpoint(struct target *target,
343 struct breakpoint *breakpoint);
345 * Add the @a watchpoint for @a target.
347 * This routine is a wrapper for target->type->add_watchpoint.
349 int target_add_watchpoint(struct target *target,
350 struct watchpoint *watchpoint);
352 * Remove the @a watchpoint for @a target.
354 * This routine is a wrapper for target->type->remove_watchpoint.
356 int target_remove_watchpoint(struct target *target,
357 struct watchpoint *watchpoint);
360 * Obtain the registers for GDB.
362 * This routine is a wrapper for target->type->get_gdb_reg_list.
364 int target_get_gdb_reg_list(struct target *target,
365 struct reg **reg_list[], int *reg_list_size);
368 * Step the target.
370 * This routine is a wrapper for target->type->step.
372 int target_step(struct target *target,
373 int current, uint32_t address, int handle_breakpoints);
375 * Run an algorithm on the @a target given.
377 * This routine is a wrapper for target->type->run_algorithm.
379 int target_run_algorithm(struct target *target,
380 int num_mem_params, struct mem_param *mem_params,
381 int num_reg_params, struct reg_param *reg_param,
382 uint32_t entry_point, uint32_t exit_point,
383 int timeout_ms, void *arch_info);
386 * Read @a count items of @a size bytes from the memory of @a target at
387 * the @a address given.
389 * This routine is a wrapper for target->type->read_memory.
391 int target_read_memory(struct target *target,
392 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
394 * Write @a count items of @a size bytes to the memory of @a target at
395 * the @a address given. @a address must be aligned to @a size
396 * in target memory.
398 * The endianness is the same in the host and target memory for this
399 * function.
401 * \todo TODO:
402 * Really @a buffer should have been defined as "const void *" and
403 * @a buffer should have been aligned to @a size in the host memory.
405 * This is not enforced via e.g. assert's today and e.g. the
406 * target_write_buffer fn breaks this assumption.
408 * This routine is wrapper for target->type->write_memory.
410 int target_write_memory(struct target *target,
411 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
414 * Write @a count items of 4 bytes to the memory of @a target at
415 * the @a address given. Because it operates only on whole words,
416 * this should be faster than target_write_memory().
418 * This routine is wrapper for target->type->bulk_write_memory.
420 int target_bulk_write_memory(struct target *target,
421 uint32_t address, uint32_t count, const uint8_t *buffer);
424 * Write to target memory using the virtual address.
426 * Note that this fn is used to implement software breakpoints. Targets
427 * can implement support for software breakpoints to memory marked as read
428 * only by making this fn write to ram even if it is read only(MMU or
429 * MPUs).
431 * It is sufficient to implement for writing a single word(16 or 32 in
432 * ARM32/16 bit case) to write the breakpoint to ram.
434 * The target should also take care of "other things" to make sure that
435 * software breakpoints can be written using this function. E.g.
436 * when there is a separate instruction and data cache, this fn must
437 * make sure that the instruction cache is synced up to the potential
438 * code change that can happen as a result of the memory write(typically
439 * by invalidating the cache).
441 * The high level wrapper fn in target.c will break down this memory write
442 * request to multiple write requests to the target driver to e.g. guarantee
443 * that writing 4 bytes to an aligned address happens with a single 32 bit
444 * write operation, thus making this fn suitable to e.g. write to special
445 * peripheral registers which do not support byte operations.
447 int target_write_buffer(struct target *target,
448 uint32_t address, uint32_t size, const uint8_t *buffer);
449 int target_read_buffer(struct target *target,
450 uint32_t address, uint32_t size, uint8_t *buffer);
451 int target_checksum_memory(struct target *target,
452 uint32_t address, uint32_t size, uint32_t* crc);
453 int target_blank_check_memory(struct target *target,
454 uint32_t address, uint32_t size, uint32_t* blank);
455 int target_wait_state(struct target *target, enum target_state state, int ms);
457 /** Return the *name* of this targets current state */
458 const char *target_state_name( struct target *target );
460 /* DANGER!!!!!
462 * if "area" passed in to target_alloc_working_area() points to a memory
463 * location that goes out of scope (e.g. a pointer on the stack), then
464 * the caller of target_alloc_working_area() is responsible for invoking
465 * target_free_working_area() before "area" goes out of scope.
467 * target_free_all_working_areas() will NULL out the "area" pointer
468 * upon resuming or resetting the CPU.
471 int target_alloc_working_area(struct target *target,
472 uint32_t size, struct working_area **area);
473 /* Same as target_alloc_working_area, except that no error is logged
474 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
476 * This allows the calling code to *try* to allocate target memory
477 * and have a fallback to another behavior(slower?).
479 int target_alloc_working_area_try(struct target *target,
480 uint32_t size, struct working_area **area);
481 int target_free_working_area(struct target *target, struct working_area *area);
482 void target_free_all_working_areas(struct target *target);
484 extern struct target *all_targets;
486 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
487 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
488 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
489 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
490 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
491 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
493 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
494 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
495 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
496 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
497 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
498 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
500 /* Issues USER() statements with target state information */
501 int target_arch_state(struct target *target);
503 void target_handle_event(struct target *t, enum target_event e);
505 #define ERROR_TARGET_INVALID (-300)
506 #define ERROR_TARGET_INIT_FAILED (-301)
507 #define ERROR_TARGET_TIMEOUT (-302)
508 #define ERROR_TARGET_NOT_HALTED (-304)
509 #define ERROR_TARGET_FAILURE (-305)
510 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
511 #define ERROR_TARGET_DATA_ABORT (-307)
512 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
513 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
514 #define ERROR_TARGET_NOT_RUNNING (-310)
515 #define ERROR_TARGET_NOT_EXAMINED (-311)
517 extern bool get_target_reset_nag(void);
519 #endif /* TARGET_H */