- Fixes '=' whitespace
[openocd.git] / src / target / target.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ė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
28
29 #include "breakpoints.h"
30 #include "algorithm.h"
31 #include "command.h"
32
33 struct reg_s;
34 struct trace_s;
35 struct command_context_s;
36
37 /*
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) */
46
47 enum target_state
48 {
49 TARGET_UNKNOWN = 0,
50 TARGET_RUNNING = 1,
51 TARGET_HALTED = 2,
52 TARGET_RESET = 3,
53 TARGET_DEBUG_RUNNING = 4,
54 };
55
56 extern const Jim_Nvp nvp_target_state[];
57
58 enum nvp_assert {
59 NVP_DEASSERT,
60 NVP_ASSERT,
61 };
62
63 extern const Jim_Nvp nvp_assert[];
64
65 enum target_reset_mode
66 {
67 RESET_UNKNOWN = 0,
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 */
71 };
72
73 extern const Jim_Nvp nvp_reset_mode[];
74
75 enum target_debug_reason
76 {
77 DBG_REASON_DBGRQ = 0,
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
84 };
85
86 extern const Jim_Nvp nvp_target_debug_reason[];
87
88 enum target_endianess
89 {
90 TARGET_ENDIAN_UNKNOWN = 0,
91 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
92 };
93
94 extern const Jim_Nvp nvp_target_endian[];
95
96 struct target_s;
97
98 typedef struct working_area_s
99 {
100 uint32_t address;
101 uint32_t size;
102 int free;
103 uint8_t *backup;
104 struct working_area_s **user;
105 struct working_area_s *next;
106 } working_area_t;
107
108 // target_type.h contains the full definitionof struct target_type_s
109 struct target_type_s;
110 typedef struct target_type_s target_type_t;
111
112 /* forward decloration */
113 typedef struct target_event_action_s target_event_action_t;
114
115 typedef struct target_s
116 {
117 target_type_t *type; /* target type definition (name, access functions) */
118 const char *cmd_name; /* tcl Name of target */
119 int target_number; /* generaly, target index but may not be in order */
120 jtag_tap_t *tap; /* where on the jtag chain is this */
121 const char *variant; /* what varient of this chip is it? */
122 target_event_action_t *event_action;
123
124 int reset_halt; /* attempt resetting the CPU into the halted mode? */
125 uint32_t working_area; /* working area (initialized RAM). Evaluated
126 * upon first allocation from virtual/physical address. */
127 uint32_t working_area_virt; /* virtual address */
128 uint32_t working_area_phys; /* physical address */
129 uint32_t working_area_size; /* size in bytes */
130 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
131 struct working_area_s *working_areas;/* list of allocated working areas */
132 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
133 enum target_endianess endianness; /* target endianess */
134 enum target_state state; /* the current backend-state (running, halted, ...) */
135 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
136 struct breakpoint_s *breakpoints; /* list of breakpoints */
137 struct watchpoint_s *watchpoints; /* list of watchpoints */
138 struct trace_s *trace_info; /* generic trace information */
139 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
140 uint32_t dbg_msg_enabled; /* debug message status */
141 void *arch_info; /* architecture specific information */
142 struct target_s *next; /* next target in list */
143
144 int display; /* display async info in telnet session. Do not display
145 * lots of halted/resumed info when stepping in debugger. */
146 } target_t;
147
148 enum target_event
149 {
150 /* LD historical names
151 * - Prior to the great TCL change
152 * - June/July/Aug 2008
153 * - Duane Ellis */
154 TARGET_EVENT_OLD_gdb_program_config,
155 TARGET_EVENT_OLD_pre_reset,
156 TARGET_EVENT_OLD_post_reset,
157 TARGET_EVENT_OLD_pre_resume,
158
159 /* allow GDB to do stuff before others handle the halted event,
160 * this is in lieu of defining ordering of invocation of events,
161 * which would be more complicated */
162 TARGET_EVENT_EARLY_HALTED,
163 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
164 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
165 TARGET_EVENT_RESUME_START,
166 TARGET_EVENT_RESUME_END,
167
168 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
169 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
170
171 TARGET_EVENT_RESET_START,
172 TARGET_EVENT_RESET_ASSERT_PRE,
173 TARGET_EVENT_RESET_ASSERT_POST,
174 TARGET_EVENT_RESET_DEASSERT_PRE,
175 TARGET_EVENT_RESET_DEASSERT_POST,
176 TARGET_EVENT_RESET_HALT_PRE,
177 TARGET_EVENT_RESET_HALT_POST,
178 TARGET_EVENT_RESET_WAIT_PRE,
179 TARGET_EVENT_RESET_WAIT_POST,
180 TARGET_EVENT_RESET_INIT,
181 TARGET_EVENT_RESET_END,
182
183 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
184 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
185
186 TARGET_EVENT_EXAMINE_START,
187 TARGET_EVENT_EXAMINE_END,
188
189 TARGET_EVENT_GDB_ATTACH,
190 TARGET_EVENT_GDB_DETACH,
191
192 TARGET_EVENT_GDB_FLASH_ERASE_START,
193 TARGET_EVENT_GDB_FLASH_ERASE_END,
194 TARGET_EVENT_GDB_FLASH_WRITE_START,
195 TARGET_EVENT_GDB_FLASH_WRITE_END,
196 };
197
198 struct target_event_action_s {
199 enum target_event event;
200 Jim_Obj *body;
201 int has_percent;
202 target_event_action_t *next;
203 };
204
205 typedef struct target_event_callback_s
206 {
207 int (*callback)(struct target_s *target, enum target_event event, void *priv);
208 void *priv;
209 struct target_event_callback_s *next;
210 } target_event_callback_t;
211
212 typedef struct target_timer_callback_s
213 {
214 int (*callback)(void *priv);
215 int time_ms;
216 int periodic;
217 struct timeval when;
218 void *priv;
219 struct target_timer_callback_s *next;
220 } target_timer_callback_t;
221
222 extern int target_register_commands(struct command_context_s *cmd_ctx);
223 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
224 extern int target_init(struct command_context_s *cmd_ctx);
225 extern int target_examine(void);
226 extern int handle_target(void *priv);
227 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
228
229 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
230 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
231 extern int target_poll(target_t *target);
232 extern int target_resume(target_t *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
233 extern int target_halt(target_t *target);
234 extern int target_call_event_callbacks(target_t *target, enum target_event event);
235
236 /* The period is very approximate, the callback can happen much more often
237 * or much more rarely than specified
238 */
239 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
240 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
241 extern int target_call_timer_callbacks(void);
242 /* invoke this to ensure that e.g. polling timer callbacks happen before
243 * a syncrhonous command completes.
244 */
245 extern int target_call_timer_callbacks_now(void);
246
247 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
248 extern int get_num_by_target(target_t *query_target);
249 extern target_t *get_target(const char *id);
250
251 /**
252 * Get the target name.
253 *
254 * This routine is a wrapper for the target->type->name field.
255 */
256 extern const char *target_get_name(struct target_s *target);
257
258 /**
259 * Examine the specified @a target.
260 *
261 * This routine is a wrapper for target->type->examine.
262 */
263 extern int target_examine_one(struct target_s *target);
264 /// @returns @c true if the target has been examined.
265 extern bool target_was_examined(struct target_s *target);
266 /// Sets the @c examined flag for the given target.
267 extern void target_set_examined(struct target_s *target);
268 /// Reset the @c examined flag for the given target.
269 extern void target_reset_examined(struct target_s *target);
270
271
272 /**
273 * Add the @a breakpoint for @a target.
274 *
275 * This routine is a wrapper for target->type->add_breakpoint.
276 */
277 extern int target_add_breakpoint(struct target_s *target,
278 struct breakpoint_s *breakpoint);
279 /**
280 * Remove the @a breakpoint for @a target.
281 *
282 * This routine is a wrapper for target->type->remove_breakpoint.
283 */
284 extern int target_remove_breakpoint(struct target_s *target,
285 struct breakpoint_s *breakpoint);
286 /**
287 * Add the @a watchpoint for @a target.
288 *
289 * This routine is a wrapper for target->type->add_watchpoint.
290 */
291 extern int target_add_watchpoint(struct target_s *target,
292 struct watchpoint_s *watchpoint);
293 /**
294 * Remove the @a watchpoint for @a target.
295 *
296 * This routine is a wrapper for target->type->remove_watchpoint.
297 */
298 extern int target_remove_watchpoint(struct target_s *target,
299 struct watchpoint_s *watchpoint);
300
301 /**
302 * Obtain the registers for GDB.
303 *
304 * This routine is a wrapper for target->type->get_gdb_reg_list.
305 */
306 extern int target_get_gdb_reg_list(struct target_s *target,
307 struct reg_s **reg_list[], int *reg_list_size);
308
309 /**
310 * Step the target.
311 *
312 * This routine is a wrapper for target->type->step.
313 */
314 int target_step(struct target_s *target,
315 int current, uint32_t address, int handle_breakpoints);
316 /**
317 * Run an algorithm on the @a target given.
318 *
319 * This routine is a wrapper for target->type->run_algorithm.
320 */
321 extern int target_run_algorithm(struct target_s *target,
322 int num_mem_params, mem_param_t *mem_params,
323 int num_reg_params, reg_param_t *reg_param,
324 uint32_t entry_point, uint32_t exit_point,
325 int timeout_ms, void *arch_info);
326
327 /**
328 * Read @a count items of @a size bytes from the memory of @a target at
329 * the @a address given.
330 *
331 * This routine is a wrapper for target->type->read_memory.
332 */
333 extern int target_read_memory(struct target_s *target,
334 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
335 /**
336 * Write @a count items of @a size bytes to the memory of @a target at
337 * the @a address given.
338 *
339 * This routine is wrapper for target->type->write_memory.
340 */
341 extern int target_write_memory(struct target_s *target,
342 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
343
344 /**
345 * Write @a count items of 4 bytes to the memory of @a target at
346 * the @a address given. Because it operates only on whole words,
347 * this should be faster than target_write_memory().
348 *
349 * This routine is wrapper for target->type->bulk_write_memory.
350 */
351 extern int target_bulk_write_memory(struct target_s *target,
352 uint32_t address, uint32_t count, uint8_t *buffer);
353
354 extern int target_write_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
355 extern int target_read_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
356 extern int target_checksum_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* crc);
357 extern int target_blank_check_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* blank);
358 extern int target_wait_state(target_t *target, enum target_state state, int ms);
359
360 /* DANGER!!!!!
361 *
362 * if "area" passed in to target_alloc_working_area() points to a memory
363 * location that goes out of scope (e.g. a pointer on the stack), then
364 * the caller of target_alloc_working_area() is responsible for invoking
365 * target_free_working_area() before "area" goes out of scope.
366 *
367 * target_free_all_working_areas() will NULL out the "area" pointer
368 * upon resuming or resetting the CPU.
369 *
370 */
371 extern int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area);
372 extern int target_free_working_area(struct target_s *target, working_area_t *area);
373 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
374 extern void target_free_all_working_areas(struct target_s *target);
375 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
376
377 extern target_t *all_targets;
378
379 extern target_event_callback_t *target_event_callbacks;
380 extern target_timer_callback_t *target_timer_callbacks;
381
382 extern uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer);
383 extern uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer);
384 extern uint8_t target_buffer_get_u8 (target_t *target, const uint8_t *buffer);
385 extern void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value);
386 extern void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value);
387 extern void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t value);
388
389 int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value);
390 int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value);
391 int target_read_u8(struct target_s *target, uint32_t address, uint8_t *value);
392 int target_write_u32(struct target_s *target, uint32_t address, uint32_t value);
393 int target_write_u16(struct target_s *target, uint32_t address, uint16_t value);
394 int target_write_u8(struct target_s *target, uint32_t address, uint8_t value);
395
396 /* Issues USER() statements with target state information */
397 int target_arch_state(struct target_s *target);
398
399 void target_handle_event( target_t *t, enum target_event e);
400 void target_all_handle_event( enum target_event e );
401
402 #define ERROR_TARGET_INVALID (-300)
403 #define ERROR_TARGET_INIT_FAILED (-301)
404 #define ERROR_TARGET_TIMEOUT (-302)
405 #define ERROR_TARGET_NOT_HALTED (-304)
406 #define ERROR_TARGET_FAILURE (-305)
407 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
408 #define ERROR_TARGET_DATA_ABORT (-307)
409 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
410 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
411 #define ERROR_TARGET_NOT_RUNNING (-310)
412 #define ERROR_TARGET_NOT_EXAMINED (-311)
413
414 extern const Jim_Nvp nvp_error_target[];
415 extern const char *target_strerror_safe( int err );
416
417 #endif /* TARGET_H */