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"
33 #include "replacements.h"
37 struct command_context_s;
40 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
41 * TARGET_RUNNING = 1: the target is executing user code
42 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
43 * debugger. on an xscale it means that the debug handler is executing
44 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
45 * not sure how this is used with all the recent changes)
46 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
47 * behalf of the debugger (e.g. algorithm for flashing) */
55 TARGET_DEBUG_RUNNING = 4,
58 extern const Jim_Nvp nvp_target_state[];
65 extern const Jim_Nvp nvp_assert[];
67 enum target_reset_mode
70 RESET_RUN = 1, /* reset and let target run */
71 RESET_HALT = 2, /* reset and halt target out of reset */
72 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
75 extern const Jim_Nvp nvp_reset_mode[];
77 enum target_debug_reason
80 DBG_REASON_BREAKPOINT = 1,
81 DBG_REASON_WATCHPOINT = 2,
82 DBG_REASON_WPTANDBKPT = 3,
83 DBG_REASON_SINGLESTEP = 4,
84 DBG_REASON_NOTHALTED = 5,
85 DBG_REASON_UNDEFINED = 6
88 extern const Jim_Nvp nvp_target_debug_reason[];
92 TARGET_ENDIAN_UNKNOWN=0,
93 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
96 extern const Jim_Nvp nvp_target_endian[];
100 typedef struct working_area_s
106 struct working_area_s **user;
107 struct working_area_s *next;
110 typedef struct target_type_s
116 /* poll current target status */
117 int (*poll)(struct target_s *target);
118 /* Invoked only from target_arch_state().
119 * Issue USER() w/architecture specific status. */
120 int (*arch_state)(struct target_s *target);
122 /* target request support */
123 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
125 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
126 int (*halt)(struct target_s *target);
127 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
128 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
130 /* target reset control. assert reset can be invoked when OpenOCD and
131 * the target is out of sync.
133 * A typical example is that the target was power cycled while OpenOCD
134 * thought the target was halted or running.
136 * assert_reset() can therefore make no assumptions whatsoever about the
137 * state of the target
139 * Before assert_reset() for the target is invoked, a TRST/tms and
140 * chain validation is executed. TRST should not be asserted
141 * during target assert unless there is no way around it due to
142 * the way reset's are configured.
145 int (*assert_reset)(struct target_s *target);
146 int (*deassert_reset)(struct target_s *target);
147 int (*soft_reset_halt_imp)(struct target_s *target);
148 int (*soft_reset_halt)(struct target_s *target);
150 /* target register access for gdb.
152 * Danger! this function will succeed even if the target is running
153 * and return a register list with dummy values.
155 * The reason is that GDB connection will fail without a valid register
156 * list, however it is after GDB is connected that monitor commands can
157 * be run to properly initialize the target
159 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
161 /* target memory access
162 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
163 * count: number of items of <size>
165 int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
166 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
167 int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
168 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
170 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
171 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
173 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
174 int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
177 * target break-/watchpoint control
178 * rw: 0 = write, 1 = read, 2 = access
180 * Target must be halted while this is invoked as this
181 * will actually set up breakpoints on target.
183 * The breakpoint hardware will be set up upon adding the first breakpoint.
185 * Upon GDB connection all breakpoints/watchpoints are cleared.
187 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
189 /* remove breakpoint. hw will only be updated if the target is currently halted.
190 * However, this method can be invoked on unresponsive targets.
192 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
193 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
194 /* remove watchpoint. hw will only be updated if the target is currently halted.
195 * However, this method can be invoked on unresponsive targets.
197 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
199 /* target algorithm support */
200 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);
201 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);
203 int (*register_commands)(struct command_context_s *cmd_ctx);
205 /* called when target is created */
206 int (*target_create)( struct target_s *target, Jim_Interp *interp );
208 /* called for various config parameters */
209 /* returns JIM_CONTINUE - if option not understood */
210 /* otherwise: JIM_OK, or JIM_ERR, */
211 int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
213 /* target commands specifically handled by the target */
214 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
215 int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
217 /* invoked after JTAG chain has been examined & validated. During
218 * this stage the target is examined and any additional setup is
221 * invoked every time after the jtag chain has been validated/examined
223 int (*examine)(struct target_s *target);
224 /* Set up structures for target.
226 * It is illegal to talk to the target at this stage as this fn is invoked
227 * before the JTAG chain has been examined/verified
229 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
232 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
233 int (*mmu)(struct target_s *target, int *enabled);
237 /* forward decloration */
238 typedef struct target_event_action_s target_event_action_t;
240 typedef struct target_s
242 target_type_t *type; /* target type definition (name, access functions) */
243 const char *cmd_name; /* tcl Name of target */
244 int target_number; /* generaly, target index but may not be in order */
245 jtag_tap_t *tap; /* where on the jtag chain is this */
246 const char *variant; /* what varient of this chip is it? */
247 target_event_action_t *event_action;
249 int reset_halt; /* attempt resetting the CPU into the halted mode? */
250 u32 working_area; /* working area (initialized RAM). Evaluated
251 * upon first allocation from virtual/physical address. */
252 u32 working_area_virt; /* virtual address */
253 u32 working_area_phys; /* physical address */
254 u32 working_area_size; /* size in bytes */
255 u32 backup_working_area; /* whether the content of the working area has to be preserved */
256 struct working_area_s *working_areas;/* list of allocated working areas */
257 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
258 enum target_endianess endianness; /* target endianess */
259 enum target_state state; /* the current backend-state (running, halted, ...) */
260 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
261 struct breakpoint_s *breakpoints; /* list of breakpoints */
262 struct watchpoint_s *watchpoints; /* list of watchpoints */
263 struct trace_s *trace_info; /* generic trace information */
264 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
265 u32 dbg_msg_enabled; /* debug message status */
266 void *arch_info; /* architecture specific information */
267 struct target_s *next; /* next target in list */
269 int display; /* display async info in telnet session. Do not display
270 * lots of halted/resumed info when stepping in debugger. */
275 /* LD historical names
276 * - Prior to the great TCL change
277 * - June/July/Aug 2008
279 TARGET_EVENT_OLD_gdb_program_config,
280 TARGET_EVENT_OLD_pre_reset,
281 TARGET_EVENT_OLD_post_reset,
282 TARGET_EVENT_OLD_pre_resume,
284 /* allow GDB to do stuff before others handle the halted event,
285 * this is in lieu of defining ordering of invocation of events,
286 * which would be more complicated */
287 TARGET_EVENT_EARLY_HALTED,
288 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
289 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
290 TARGET_EVENT_RESUME_START,
291 TARGET_EVENT_RESUME_END,
293 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
294 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
296 TARGET_EVENT_RESET_START,
297 TARGET_EVENT_RESET_ASSERT_PRE,
298 TARGET_EVENT_RESET_ASSERT_POST,
299 TARGET_EVENT_RESET_DEASSERT_PRE,
300 TARGET_EVENT_RESET_DEASSERT_POST,
301 TARGET_EVENT_RESET_HALT_PRE,
302 TARGET_EVENT_RESET_HALT_POST,
303 TARGET_EVENT_RESET_WAIT_PRE,
304 TARGET_EVENT_RESET_WAIT_POST,
305 TARGET_EVENT_RESET_INIT,
306 TARGET_EVENT_RESET_END,
308 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
309 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
311 TARGET_EVENT_EXAMINE_START,
312 TARGET_EVENT_EXAMINE_END,
314 TARGET_EVENT_GDB_ATTACH,
315 TARGET_EVENT_GDB_DETACH,
317 TARGET_EVENT_GDB_FLASH_ERASE_START,
318 TARGET_EVENT_GDB_FLASH_ERASE_END,
319 TARGET_EVENT_GDB_FLASH_WRITE_START,
320 TARGET_EVENT_GDB_FLASH_WRITE_END,
323 extern const Jim_Nvp nvp_target_event[];
325 struct target_event_action_s {
326 enum target_event event;
329 target_event_action_t *next;
332 typedef struct target_event_callback_s
334 int (*callback)(struct target_s *target, enum target_event event, void *priv);
336 struct target_event_callback_s *next;
337 } target_event_callback_t;
339 typedef struct target_timer_callback_s
341 int (*callback)(void *priv);
346 struct target_timer_callback_s *next;
347 } target_timer_callback_t;
349 extern int target_register_commands(struct command_context_s *cmd_ctx);
350 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
351 extern int target_init(struct command_context_s *cmd_ctx);
352 extern int target_examine(void);
353 extern int handle_target(void *priv);
354 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
356 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
357 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
358 extern int target_poll(target_t *target);
359 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
360 extern int target_halt(target_t *target);
361 extern int target_call_event_callbacks(target_t *target, enum target_event event);
363 /* The period is very approximate, the callback can happen much more often
364 * or much more rarely than specified
366 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
367 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
368 extern int target_call_timer_callbacks(void);
369 /* invoke this to ensure that e.g. polling timer callbacks happen before
370 * a syncrhonous command completes.
372 extern int target_call_timer_callbacks_now(void);
374 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
375 extern int get_num_by_target(target_t *query_target);
376 extern target_t* get_target_by_num(int num);
378 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
379 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
380 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
381 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
382 extern int target_wait_state(target_t *target, enum target_state state, int ms);
386 * if "area" passed in to target_alloc_working_area() points to a memory
387 * location that goes out of scope (e.g. a pointer on the stack), then
388 * the caller of target_alloc_working_area() is responsible for invoking
389 * target_free_working_area() before "area" goes out of scope.
391 * target_free_all_working_areas() will NULL out the "area" pointer
392 * upon resuming or resetting the CPU.
395 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
396 extern int target_free_working_area(struct target_s *target, working_area_t *area);
397 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
398 extern void target_free_all_working_areas(struct target_s *target);
399 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
401 extern target_t *all_targets;
403 extern target_event_callback_t *target_event_callbacks;
404 extern target_timer_callback_t *target_timer_callbacks;
406 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
407 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
408 extern u8 target_buffer_get_u8 (target_t *target, u8 *buffer);
409 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
410 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
411 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value);
413 int target_read_u32(struct target_s *target, u32 address, u32 *value);
414 int target_read_u16(struct target_s *target, u32 address, u16 *value);
415 int target_read_u8(struct target_s *target, u32 address, u8 *value);
416 int target_write_u32(struct target_s *target, u32 address, u32 value);
417 int target_write_u16(struct target_s *target, u32 address, u16 value);
418 int target_write_u8(struct target_s *target, u32 address, u8 value);
420 /* Issues USER() statements with target state information */
421 int target_arch_state(struct target_s *target);
423 void target_handle_event( target_t *t, enum target_event e);
424 void target_all_handle_event( enum target_event e );
426 #define ERROR_TARGET_INVALID (-300)
427 #define ERROR_TARGET_INIT_FAILED (-301)
428 #define ERROR_TARGET_TIMEOUT (-302)
429 #define ERROR_TARGET_NOT_HALTED (-304)
430 #define ERROR_TARGET_FAILURE (-305)
431 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
432 #define ERROR_TARGET_DATA_ABORT (-307)
433 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
434 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
435 #define ERROR_TARGET_NOT_RUNNING (-310)
436 #define ERROR_TARGET_NOT_EXAMINED (-311)
438 extern const Jim_Nvp nvp_error_target[];
439 extern const char *target_strerror_safe( int err );
441 #endif /* TARGET_H */