1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
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. *
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. *
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 ***************************************************************************/
29 #include "breakpoints.h"
30 #include "algorithm.h"
35 struct command_context_s;
38 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
39 * TARGET_RUNNING = 1: the target is executing user code
40 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
41 * debugger. on an xscale it means that the debug handler is executing
42 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
43 * not sure how this is used with all the recent changes)
44 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
45 * behalf of the debugger (e.g. algorithm for flashing) */
53 TARGET_DEBUG_RUNNING = 4,
56 extern const Jim_Nvp nvp_target_state[];
63 extern const Jim_Nvp nvp_assert[];
65 enum target_reset_mode
68 RESET_RUN = 1, /* reset and let target run */
69 RESET_HALT = 2, /* reset and halt target out of reset */
70 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
73 extern const Jim_Nvp nvp_reset_mode[];
75 enum target_debug_reason
78 DBG_REASON_BREAKPOINT = 1,
79 DBG_REASON_WATCHPOINT = 2,
80 DBG_REASON_WPTANDBKPT = 3,
81 DBG_REASON_SINGLESTEP = 4,
82 DBG_REASON_NOTHALTED = 5,
83 DBG_REASON_UNDEFINED = 6
86 extern const Jim_Nvp nvp_target_debug_reason[];
90 TARGET_ENDIAN_UNKNOWN=0,
91 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
94 extern const Jim_Nvp nvp_target_endian[];
98 typedef struct working_area_s
104 struct working_area_s **user;
105 struct working_area_s *next;
108 typedef struct target_type_s
113 * Indicates whether this target has been examined.
115 * Do @b not access this field directly, use target_was_examined()
116 * target_set_examined(), and target_reset_examined().
120 /* poll current target status */
121 int (*poll)(struct target_s *target);
122 /* Invoked only from target_arch_state().
123 * Issue USER() w/architecture specific status. */
124 int (*arch_state)(struct target_s *target);
126 /* target request support */
127 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
129 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
130 int (*halt)(struct target_s *target);
131 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
132 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
134 /* target reset control. assert reset can be invoked when OpenOCD and
135 * the target is out of sync.
137 * A typical example is that the target was power cycled while OpenOCD
138 * thought the target was halted or running.
140 * assert_reset() can therefore make no assumptions whatsoever about the
141 * state of the target
143 * Before assert_reset() for the target is invoked, a TRST/tms and
144 * chain validation is executed. TRST should not be asserted
145 * during target assert unless there is no way around it due to
146 * the way reset's are configured.
149 int (*assert_reset)(struct target_s *target);
150 int (*deassert_reset)(struct target_s *target);
151 int (*soft_reset_halt_imp)(struct target_s *target);
152 int (*soft_reset_halt)(struct target_s *target);
154 /* target register access for gdb.
156 * Danger! this function will succeed even if the target is running
157 * and return a register list with dummy values.
159 * The reason is that GDB connection will fail without a valid register
160 * list, however it is after GDB is connected that monitor commands can
161 * be run to properly initialize the target
163 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
165 /* target memory access
166 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
167 * count: number of items of <size>
169 int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
171 * Target memory read callback. Do @b not call this function
172 * directly, use target_read_memory() instead.
174 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
175 int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
177 * Target memory write callback. Do @b not call this function
178 * directly, use target_write_memory() instead.
180 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
183 * Write target memory in multiples of 4 bytes, optimized for
184 * writing large quantities of data. Do @b not call this
185 * function directly, use target_bulk_write_memory() instead.
187 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
189 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
190 int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
193 * target break-/watchpoint control
194 * rw: 0 = write, 1 = read, 2 = access
196 * Target must be halted while this is invoked as this
197 * will actually set up breakpoints on target.
199 * The breakpoint hardware will be set up upon adding the first breakpoint.
201 * Upon GDB connection all breakpoints/watchpoints are cleared.
203 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
205 /* remove breakpoint. hw will only be updated if the target is currently halted.
206 * However, this method can be invoked on unresponsive targets.
208 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
209 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
210 /* remove watchpoint. hw will only be updated if the target is currently halted.
211 * However, this method can be invoked on unresponsive targets.
213 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
215 /* target algorithm support */
216 int (*run_algorithm_imp)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
218 * Target algorithm support. Do @b not call this method directly,
219 * use target_run_algorithm() instead.
221 int (*run_algorithm)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
223 int (*register_commands)(struct command_context_s *cmd_ctx);
225 /* called when target is created */
226 int (*target_create)( struct target_s *target, Jim_Interp *interp );
228 /* called for various config parameters */
229 /* returns JIM_CONTINUE - if option not understood */
230 /* otherwise: JIM_OK, or JIM_ERR, */
231 int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
233 /* target commands specifically handled by the target */
234 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
235 int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
237 /* invoked after JTAG chain has been examined & validated. During
238 * this stage the target is examined and any additional setup is
241 * invoked every time after the jtag chain has been validated/examined
243 int (*examine)(struct target_s *target);
244 /* Set up structures for target.
246 * It is illegal to talk to the target at this stage as this fn is invoked
247 * before the JTAG chain has been examined/verified
249 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
252 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
253 int (*mmu)(struct target_s *target, int *enabled);
257 /* forward decloration */
258 typedef struct target_event_action_s target_event_action_t;
260 typedef struct target_s
262 target_type_t *type; /* target type definition (name, access functions) */
263 const char *cmd_name; /* tcl Name of target */
264 int target_number; /* generaly, target index but may not be in order */
265 jtag_tap_t *tap; /* where on the jtag chain is this */
266 const char *variant; /* what varient of this chip is it? */
267 target_event_action_t *event_action;
269 int reset_halt; /* attempt resetting the CPU into the halted mode? */
270 u32 working_area; /* working area (initialized RAM). Evaluated
271 * upon first allocation from virtual/physical address. */
272 u32 working_area_virt; /* virtual address */
273 u32 working_area_phys; /* physical address */
274 u32 working_area_size; /* size in bytes */
275 u32 backup_working_area; /* whether the content of the working area has to be preserved */
276 struct working_area_s *working_areas;/* list of allocated working areas */
277 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
278 enum target_endianess endianness; /* target endianess */
279 enum target_state state; /* the current backend-state (running, halted, ...) */
280 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
281 struct breakpoint_s *breakpoints; /* list of breakpoints */
282 struct watchpoint_s *watchpoints; /* list of watchpoints */
283 struct trace_s *trace_info; /* generic trace information */
284 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
285 u32 dbg_msg_enabled; /* debug message status */
286 void *arch_info; /* architecture specific information */
287 struct target_s *next; /* next target in list */
289 int display; /* display async info in telnet session. Do not display
290 * lots of halted/resumed info when stepping in debugger. */
295 /* LD historical names
296 * - Prior to the great TCL change
297 * - June/July/Aug 2008
299 TARGET_EVENT_OLD_gdb_program_config,
300 TARGET_EVENT_OLD_pre_reset,
301 TARGET_EVENT_OLD_post_reset,
302 TARGET_EVENT_OLD_pre_resume,
304 /* allow GDB to do stuff before others handle the halted event,
305 * this is in lieu of defining ordering of invocation of events,
306 * which would be more complicated */
307 TARGET_EVENT_EARLY_HALTED,
308 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
309 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
310 TARGET_EVENT_RESUME_START,
311 TARGET_EVENT_RESUME_END,
313 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
314 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
316 TARGET_EVENT_RESET_START,
317 TARGET_EVENT_RESET_ASSERT_PRE,
318 TARGET_EVENT_RESET_ASSERT_POST,
319 TARGET_EVENT_RESET_DEASSERT_PRE,
320 TARGET_EVENT_RESET_DEASSERT_POST,
321 TARGET_EVENT_RESET_HALT_PRE,
322 TARGET_EVENT_RESET_HALT_POST,
323 TARGET_EVENT_RESET_WAIT_PRE,
324 TARGET_EVENT_RESET_WAIT_POST,
325 TARGET_EVENT_RESET_INIT,
326 TARGET_EVENT_RESET_END,
328 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
329 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
331 TARGET_EVENT_EXAMINE_START,
332 TARGET_EVENT_EXAMINE_END,
334 TARGET_EVENT_GDB_ATTACH,
335 TARGET_EVENT_GDB_DETACH,
337 TARGET_EVENT_GDB_FLASH_ERASE_START,
338 TARGET_EVENT_GDB_FLASH_ERASE_END,
339 TARGET_EVENT_GDB_FLASH_WRITE_START,
340 TARGET_EVENT_GDB_FLASH_WRITE_END,
343 struct target_event_action_s {
344 enum target_event event;
347 target_event_action_t *next;
350 typedef struct target_event_callback_s
352 int (*callback)(struct target_s *target, enum target_event event, void *priv);
354 struct target_event_callback_s *next;
355 } target_event_callback_t;
357 typedef struct target_timer_callback_s
359 int (*callback)(void *priv);
364 struct target_timer_callback_s *next;
365 } target_timer_callback_t;
367 extern int target_register_commands(struct command_context_s *cmd_ctx);
368 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
369 extern int target_init(struct command_context_s *cmd_ctx);
370 extern int target_examine(void);
371 extern int handle_target(void *priv);
372 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
374 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
375 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
376 extern int target_poll(target_t *target);
377 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
378 extern int target_halt(target_t *target);
379 extern int target_call_event_callbacks(target_t *target, enum target_event event);
381 /* The period is very approximate, the callback can happen much more often
382 * or much more rarely than specified
384 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
385 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
386 extern int target_call_timer_callbacks(void);
387 /* invoke this to ensure that e.g. polling timer callbacks happen before
388 * a syncrhonous command completes.
390 extern int target_call_timer_callbacks_now(void);
392 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
393 extern int get_num_by_target(target_t *query_target);
394 extern target_t *get_target(const char *id);
396 /// @returns @c true if the target has been examined.
397 extern bool target_was_examined(struct target_s *target);
398 /// Sets the @c examined flag for the given target.
399 extern void target_set_examined(struct target_s *target);
400 /// Reset the @c examined flag for the given target.
401 extern void target_reset_examined(struct target_s *target);
404 * Run an algorithm on the @a target given.
406 * This routine is a wrapper for target->type->run_algorithm.
408 extern int target_run_algorithm(struct target_s *target,
409 int num_mem_params, mem_param_t *mem_params,
410 int num_reg_params, reg_param_t *reg_param,
411 u32 entry_point, u32 exit_point,
412 int timeout_ms, void *arch_info);
415 * Read @count items of @a size bytes from the memory of @a target at
416 * the @a address given.
418 * This routine is a wrapper for target->type->read_memory.
420 extern int target_read_memory(struct target_s *target,
421 u32 address, u32 size, u32 count, u8 *buffer);
423 * Write @count items of @a size bytes to the memory of @a target at
424 * the @a address given.
426 * This routine is wrapper for target->type->write_memory.
428 extern int target_write_memory(struct target_s *target,
429 u32 address, u32 size, u32 count, u8 *buffer);
432 * Write @count items of 4 bytes to the memory of @a target at
433 * the @a address given. Because it operates only on whole words,
434 * this should be faster than target_write_memory().
436 * This routine is wrapper for target->type->bulk_write_memory.
438 extern int target_bulk_write_memory(struct target_s *target,
439 u32 address, u32 count, u8 *buffer);
441 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
442 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
443 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
444 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
445 extern int target_wait_state(target_t *target, enum target_state state, int ms);
449 * if "area" passed in to target_alloc_working_area() points to a memory
450 * location that goes out of scope (e.g. a pointer on the stack), then
451 * the caller of target_alloc_working_area() is responsible for invoking
452 * target_free_working_area() before "area" goes out of scope.
454 * target_free_all_working_areas() will NULL out the "area" pointer
455 * upon resuming or resetting the CPU.
458 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
459 extern int target_free_working_area(struct target_s *target, working_area_t *area);
460 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
461 extern void target_free_all_working_areas(struct target_s *target);
462 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
464 extern target_t *all_targets;
466 extern target_event_callback_t *target_event_callbacks;
467 extern target_timer_callback_t *target_timer_callbacks;
469 extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
470 extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
471 extern u8 target_buffer_get_u8 (target_t *target, const u8 *buffer);
472 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
473 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
474 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value);
476 int target_read_u32(struct target_s *target, u32 address, u32 *value);
477 int target_read_u16(struct target_s *target, u32 address, u16 *value);
478 int target_read_u8(struct target_s *target, u32 address, u8 *value);
479 int target_write_u32(struct target_s *target, u32 address, u32 value);
480 int target_write_u16(struct target_s *target, u32 address, u16 value);
481 int target_write_u8(struct target_s *target, u32 address, u8 value);
483 /* Issues USER() statements with target state information */
484 int target_arch_state(struct target_s *target);
486 void target_handle_event( target_t *t, enum target_event e);
487 void target_all_handle_event( enum target_event e );
489 #define ERROR_TARGET_INVALID (-300)
490 #define ERROR_TARGET_INIT_FAILED (-301)
491 #define ERROR_TARGET_TIMEOUT (-302)
492 #define ERROR_TARGET_NOT_HALTED (-304)
493 #define ERROR_TARGET_FAILURE (-305)
494 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
495 #define ERROR_TARGET_DATA_ABORT (-307)
496 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
497 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
498 #define ERROR_TARGET_NOT_RUNNING (-310)
499 #define ERROR_TARGET_NOT_EXAMINED (-311)
501 extern const Jim_Nvp nvp_error_target[];
502 extern const char *target_strerror_safe( int err );
504 #endif /* TARGET_H */