1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
24 #include "breakpoints.h"
25 #include "algorithm.h"
35 struct command_context_s;
37 TARGET_UNKNOWN = 0: we don't know anything about the target yet
38 TARGET_RUNNING = 1: the target is executing user code
39 TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
40 debugger. on an xscale it means that the debug handler is executing
41 TARGET_RESET = 3: the target is being held in reset (only a temporary state,
42 not sure how this is used with all the recent changes)
43 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
44 behalf of the debugger (e.g. algorithm for flashing)
52 TARGET_DEBUG_RUNNING = 4,
55 extern char *target_state_strings[];
57 enum target_reset_mode
59 RESET_RUN = 0, /* reset and let target run */
60 RESET_HALT = 1, /* reset and halt target out of reset */
61 RESET_INIT = 2, /* reset and halt target out of reset, then run init script */
62 RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
63 RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
66 enum target_debug_reason
69 DBG_REASON_BREAKPOINT = 1,
70 DBG_REASON_WATCHPOINT = 2,
71 DBG_REASON_WPTANDBKPT = 3,
72 DBG_REASON_SINGLESTEP = 4,
73 DBG_REASON_NOTHALTED = 5,
74 DBG_REASON_UNDEFINED = 6
77 extern char *target_debug_reason_strings[];
81 TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
84 extern char *target_endianess_strings[];
88 typedef struct working_area_s
94 struct working_area_s **user;
95 struct working_area_s *next;
98 typedef struct target_type_s
102 /* poll current target status */
103 int (*poll)(struct target_s *target);
104 /* Invoked only from target_arch_state().
105 * Issue USER() w/architecture specific status. */
106 int (*arch_state)(struct target_s *target);
108 /* target request support */
109 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
111 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
112 int (*halt)(struct target_s *target);
113 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
114 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
116 /* target reset control. assert reset can be invoked when OpenOCD and
117 * the target is out of sync.
119 * A typical example is that the target was power cycled while OpenOCD
120 * thought the target was halted or running.
122 * assert_reset() can therefore make no assumptions whatsoever about the
123 * state of the target
125 * Before assert_reset() for the target is invoked, a TRST/tms and
126 * chain validation is executed. TRST should not be asserted
127 * during target assert unless there is no way around it due to
128 * the way reset's are configured.
131 int (*assert_reset)(struct target_s *target);
132 int (*deassert_reset)(struct target_s *target);
133 int (*soft_reset_halt)(struct target_s *target);
135 /* target register access for gdb.
137 * Danger! this function will succeed even if the target is running
138 * and return a register list with dummy values.
140 * The reason is that GDB connection will fail without a valid register
141 * list, however it is after GDB is connected that monitor commands can
142 * be run to properly initialize the target
144 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
146 /* target memory access
147 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
148 * count: number of items of <size>
150 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
151 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
153 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
154 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
156 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
158 /* target break-/watchpoint control
159 * rw: 0 = write, 1 = read, 2 = access
161 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
162 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
163 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
164 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
166 /* target algorithm support */
167 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);
169 int (*register_commands)(struct command_context_s *cmd_ctx);
170 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
171 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
174 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
175 int (*mmu)(struct target_s *target, int *enabled);
179 typedef struct target_s
181 target_type_t *type; /* target type definition (name, access functions) */
182 enum target_reset_mode reset_mode; /* what to do after a reset */
183 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
184 char *reset_script; /* script file to initialize the target after a reset */
185 char *post_halt_script; /* script file to execute after the target halted */
186 char *pre_resume_script; /* script file to execute before the target resumed */
187 char *gdb_program_script; /* script file to execute before programming vis gdb */
188 u32 working_area; /* working area (initialized RAM). Evaluated
189 upon first allocation from virtual/physical address.
191 u32 working_area_virt; /* virtual address */
192 u32 working_area_phys; /* physical address */
193 u32 working_area_size; /* size in bytes */
194 u32 backup_working_area; /* whether the content of the working area has to be preserved */
195 struct working_area_s *working_areas;/* list of allocated working areas */
196 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
197 enum target_endianess endianness; /* target endianess */
198 enum target_state state; /* the current backend-state (running, halted, ...) */
199 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
200 struct breakpoint_s *breakpoints; /* list of breakpoints */
201 struct watchpoint_s *watchpoints; /* list of watchpoints */
202 struct trace_s *trace_info; /* generic trace information */
203 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
204 u32 dbg_msg_enabled; /* debug message status */
205 void *arch_info; /* architecture specific information */
206 struct target_s *next; /* next target in list */
211 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
212 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
213 TARGET_EVENT_RESET, /* target entered reset */
214 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
215 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
216 TARGET_EVENT_GDB_PROGRAM /* target about to be be programmed by gdb */
219 typedef struct target_event_callback_s
221 int (*callback)(struct target_s *target, enum target_event event, void *priv);
223 struct target_event_callback_s *next;
224 } target_event_callback_t;
226 typedef struct target_timer_callback_s
228 int (*callback)(void *priv);
233 struct target_timer_callback_s *next;
234 } target_timer_callback_t;
236 extern int target_register_commands(struct command_context_s *cmd_ctx);
237 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
238 extern int target_init(struct command_context_s *cmd_ctx);
239 extern int target_init_reset(struct command_context_s *cmd_ctx);
240 extern int handle_target(void *priv);
241 extern int target_process_reset(struct command_context_s *cmd_ctx);
243 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
244 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
245 extern int target_call_event_callbacks(target_t *target, enum target_event event);
247 /* The period is very approximate, the callback can happen much more often
248 * or much more rarely than specified
250 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
251 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
252 extern int target_call_timer_callbacks();
253 /* invoke this to ensure that e.g. polling timer callbacks happen before
254 * a syncrhonous command completes.
256 extern int target_call_timer_callbacks_now();
258 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
259 extern int get_num_by_target(target_t *query_target);
260 extern target_t* get_target_by_num(int num);
262 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
263 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
264 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
268 * if "area" passed in to target_alloc_working_area() points to a memory
269 * location that goes out of scope (e.g. a pointer on the stack), then
270 * the caller of target_alloc_working_area() is responsible for invoking
271 * target_free_working_area() before "area" goes out of scope.
273 * target_free_all_working_areas() will NULL out the "area" pointer
274 * upon resuming or resetting the CPU.
277 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
278 extern int target_free_working_area(struct target_s *target, working_area_t *area);
279 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
280 extern int target_free_all_working_areas(struct target_s *target);
281 extern int target_free_all_working_areas_restore(struct target_s *target, int restore);
284 extern target_t *targets;
286 extern target_event_callback_t *target_event_callbacks;
287 extern target_timer_callback_t *target_timer_callbacks;
289 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
290 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
291 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
292 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
294 int target_read_u32(struct target_s *target, u32 address, u32 *value);
295 int target_read_u16(struct target_s *target, u32 address, u16 *value);
296 int target_read_u8(struct target_s *target, u32 address, u8 *value);
297 int target_write_u32(struct target_s *target, u32 address, u32 value);
298 int target_write_u16(struct target_s *target, u32 address, u16 value);
299 int target_write_u8(struct target_s *target, u32 address, u8 value);
301 /* Issues USER() statements with target state information */
302 int target_arch_state(struct target_s *target);
304 #define ERROR_TARGET_INVALID (-300)
305 #define ERROR_TARGET_INIT_FAILED (-301)
306 #define ERROR_TARGET_TIMEOUT (-302)
307 #define ERROR_TARGET_NOT_HALTED (-304)
308 #define ERROR_TARGET_FAILURE (-305)
309 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
310 #define ERROR_TARGET_DATA_ABORT (-307)
311 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
312 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
314 #endif /* TARGET_H */