target: don't implicitly include "breakpoint.h"
[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,2009 √ė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 <stddef.h>
30
31 #include "algorithm.h"
32 #include "command.h"
33
34 struct reg;
35 struct trace;
36 struct command_context;
37 struct breakpoint;
38 struct watchpoint;
39
40
41 /**
42 * Cast a member of a structure out to the containing structure.
43 * @param ptr The pointer to the member.
44 * @param type The type of the container struct this is embedded in.
45 * @param member The name of the member within the struct.
46 *
47 * This is a mechanism which is used throughout the Linux kernel.
48 */
49 #define container_of(ptr, type, member) ({ \
50 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
51 (type *)( (char *)__mptr - offsetof(type,member) );})
52
53 /*
54 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
55 * TARGET_RUNNING = 1: the target is executing user code
56 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
57 * debugger. on an xscale it means that the debug handler is executing
58 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
59 * not sure how this is used with all the recent changes)
60 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
61 * behalf of the debugger (e.g. algorithm for flashing)
62 *
63 * also see: target_state_name();
64 */
65
66
67 enum target_state
68 {
69 TARGET_UNKNOWN = 0,
70 TARGET_RUNNING = 1,
71 TARGET_HALTED = 2,
72 TARGET_RESET = 3,
73 TARGET_DEBUG_RUNNING = 4,
74 };
75
76 extern const Jim_Nvp nvp_target_state[];
77
78 enum nvp_assert {
79 NVP_DEASSERT,
80 NVP_ASSERT,
81 };
82
83 extern const Jim_Nvp nvp_assert[];
84
85 enum target_reset_mode
86 {
87 RESET_UNKNOWN = 0,
88 RESET_RUN = 1, /* reset and let target run */
89 RESET_HALT = 2, /* reset and halt target out of reset */
90 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
91 };
92
93 extern const Jim_Nvp nvp_reset_mode[];
94
95 enum target_debug_reason
96 {
97 DBG_REASON_DBGRQ = 0,
98 DBG_REASON_BREAKPOINT = 1,
99 DBG_REASON_WATCHPOINT = 2,
100 DBG_REASON_WPTANDBKPT = 3,
101 DBG_REASON_SINGLESTEP = 4,
102 DBG_REASON_NOTHALTED = 5,
103 DBG_REASON_UNDEFINED = 6
104 };
105
106 extern const Jim_Nvp nvp_target_debug_reason[];
107
108 enum target_endianess
109 {
110 TARGET_ENDIAN_UNKNOWN = 0,
111 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
112 };
113
114 extern const Jim_Nvp nvp_target_endian[];
115
116 struct working_area
117 {
118 uint32_t address;
119 uint32_t size;
120 int free;
121 uint8_t *backup;
122 struct working_area **user;
123 struct working_area *next;
124 };
125
126 // target_type.h contains the full definitionof struct targe_type
127 struct target
128 {
129 struct target_type *type; /* target type definition (name, access functions) */
130 const char *cmd_name; /* tcl Name of target */
131 int target_number; /* DO NOT USE! field to be removed in 2010 */
132 struct jtag_tap *tap; /* where on the jtag chain is this */
133 const char *variant; /* what variant of this chip is it? */
134
135 /**
136 * Indicates whether this target has been examined.
137 *
138 * Do @b not access this field directly, use target_was_examined()
139 * or target_set_examined().
140 */
141 bool examined;
142
143 struct target_event_action *event_action;
144
145 int reset_halt; /* attempt resetting the CPU into the halted mode? */
146 uint32_t working_area; /* working area (initialized RAM). Evaluated
147 * upon first allocation from virtual/physical address. */
148 bool working_area_virt_spec; /* virtual address specified? */
149 uint32_t working_area_virt; /* virtual address */
150 bool working_area_phys_spec; /* virtual address specified? */
151 uint32_t working_area_phys; /* physical address */
152 uint32_t working_area_size; /* size in bytes */
153 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
154 struct working_area *working_areas;/* list of allocated working areas */
155 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
156 enum target_endianess endianness; /* target endianess */
157 // also see: target_state_name()
158 enum target_state state; /* the current backend-state (running, halted, ...) */
159 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
160 struct breakpoint *breakpoints; /* list of breakpoints */
161 struct watchpoint *watchpoints; /* list of watchpoints */
162 struct trace *trace_info; /* generic trace information */
163 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
164 uint32_t dbg_msg_enabled; /* debug message status */
165 void *arch_info; /* architecture specific information */
166 struct target *next; /* next target in list */
167
168 int display; /* display async info in telnet session. Do not display
169 * lots of halted/resumed info when stepping in debugger. */
170 bool halt_issued; /* did we transition to halted state? */
171 long long halt_issued_time; /* Note time when halt was issued */
172 };
173
174 enum target_event
175 {
176 /* LD historical names
177 * - Prior to the great TCL change
178 * - June/July/Aug 2008
179 * - Duane Ellis */
180 TARGET_EVENT_OLD_gdb_program_config,
181 TARGET_EVENT_OLD_pre_reset,
182 TARGET_EVENT_OLD_post_reset,
183 TARGET_EVENT_OLD_pre_resume,
184
185 /* allow GDB to do stuff before others handle the halted event,
186 * this is in lieu of defining ordering of invocation of events,
187 * which would be more complicated
188 *
189 * Telling GDB to halt does not mean that the target stopped running,
190 * simply that we're dropping out of GDB's waiting for step or continue.
191 *
192 * This can be useful when e.g. detecting power dropout.
193 */
194 TARGET_EVENT_GDB_HALT,
195 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
196 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
197 TARGET_EVENT_RESUME_START,
198 TARGET_EVENT_RESUME_END,
199
200 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
201 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
202
203 TARGET_EVENT_RESET_START,
204 TARGET_EVENT_RESET_ASSERT_PRE,
205 TARGET_EVENT_RESET_ASSERT_POST,
206 TARGET_EVENT_RESET_DEASSERT_PRE,
207 TARGET_EVENT_RESET_DEASSERT_POST,
208 TARGET_EVENT_RESET_HALT_PRE,
209 TARGET_EVENT_RESET_HALT_POST,
210 TARGET_EVENT_RESET_WAIT_PRE,
211 TARGET_EVENT_RESET_WAIT_POST,
212 TARGET_EVENT_RESET_INIT,
213 TARGET_EVENT_RESET_END,
214
215 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
216 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
217
218 TARGET_EVENT_EXAMINE_START,
219 TARGET_EVENT_EXAMINE_END,
220
221 TARGET_EVENT_GDB_ATTACH,
222 TARGET_EVENT_GDB_DETACH,
223
224 TARGET_EVENT_GDB_FLASH_ERASE_START,
225 TARGET_EVENT_GDB_FLASH_ERASE_END,
226 TARGET_EVENT_GDB_FLASH_WRITE_START,
227 TARGET_EVENT_GDB_FLASH_WRITE_END,
228 };
229
230 struct target_event_action {
231 enum target_event event;
232 Jim_Obj *body;
233 int has_percent;
234 struct target_event_action *next;
235 };
236
237 struct target_event_callback
238 {
239 int (*callback)(struct target *target, enum target_event event, void *priv);
240 void *priv;
241 struct target_event_callback *next;
242 };
243
244 struct target_timer_callback
245 {
246 int (*callback)(void *priv);
247 int time_ms;
248 int periodic;
249 struct timeval when;
250 void *priv;
251 struct target_timer_callback *next;
252 };
253
254 int target_register_commands(struct command_context *cmd_ctx);
255 int target_register_user_commands(struct command_context *cmd_ctx);
256 int target_init(struct command_context *cmd_ctx);
257 int target_examine(void);
258 int handle_target(void *priv);
259 int target_process_reset(struct command_context *cmd_ctx,
260 enum target_reset_mode reset_mode);
261
262 int target_register_event_callback(
263 int (*callback)(struct target *target,
264 enum target_event event, void *priv),
265 void *priv);
266 int target_unregister_event_callback(
267 int (*callback)(struct target *target,
268 enum target_event event, void *priv),
269 void *priv);
270 int target_poll(struct target *target);
271 int target_resume(struct target *target, int current, uint32_t address,
272 int handle_breakpoints, int debug_execution);
273 int target_halt(struct target *target);
274 int target_call_event_callbacks(struct target *target, enum target_event event);
275
276 /**
277 * The period is very approximate, the callback can happen much more often
278 * or much more rarely than specified
279 */
280 int target_register_timer_callback(int (*callback)(void *priv),
281 int time_ms, int periodic, void *priv);
282 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
283
284 int target_call_timer_callbacks(void);
285 /**
286 * Invoke this to ensure that e.g. polling timer callbacks happen before
287 * a syncrhonous command completes.
288 */
289 int target_call_timer_callbacks_now(void);
290
291 struct target* get_current_target(struct command_context *cmd_ctx);
292 struct target *get_target(const char *id);
293
294 /**
295 * Get the target name.
296 *
297 * This routine is a wrapper for the target->type->name field.
298 */
299 const char *target_get_name(struct target *target);
300
301 /**
302 * Examine the specified @a target, letting it perform any
303 * initialization that requires JTAG access.
304 *
305 * This routine is a wrapper for target->type->examine.
306 */
307 int target_examine_one(struct target *target);
308
309 /// @returns @c true if target_set_examined() has been called.
310 static inline bool target_was_examined(struct target *target)
311 {
312 return target->examined;
313 }
314
315 /// Sets the @c examined flag for the given target.
316 /// Use in target->type->examine() after one-time setup is done.
317 static inline void target_set_examined(struct target *target)
318 {
319 target->examined = true;
320 }
321
322 /**
323 * Add the @a breakpoint for @a target.
324 *
325 * This routine is a wrapper for target->type->add_breakpoint.
326 */
327 int target_add_breakpoint(struct target *target,
328 struct breakpoint *breakpoint);
329 /**
330 * Remove the @a breakpoint for @a target.
331 *
332 * This routine is a wrapper for target->type->remove_breakpoint.
333 */
334 int target_remove_breakpoint(struct target *target,
335 struct breakpoint *breakpoint);
336 /**
337 * Add the @a watchpoint for @a target.
338 *
339 * This routine is a wrapper for target->type->add_watchpoint.
340 */
341 int target_add_watchpoint(struct target *target,
342 struct watchpoint *watchpoint);
343 /**
344 * Remove the @a watchpoint for @a target.
345 *
346 * This routine is a wrapper for target->type->remove_watchpoint.
347 */
348 int target_remove_watchpoint(struct target *target,
349 struct watchpoint *watchpoint);
350
351 /**
352 * Obtain the registers for GDB.
353 *
354 * This routine is a wrapper for target->type->get_gdb_reg_list.
355 */
356 int target_get_gdb_reg_list(struct target *target,
357 struct reg **reg_list[], int *reg_list_size);
358
359 /**
360 * Step the target.
361 *
362 * This routine is a wrapper for target->type->step.
363 */
364 int target_step(struct target *target,
365 int current, uint32_t address, int handle_breakpoints);
366 /**
367 * Run an algorithm on the @a target given.
368 *
369 * This routine is a wrapper for target->type->run_algorithm.
370 */
371 int target_run_algorithm(struct target *target,
372 int num_mem_params, struct mem_param *mem_params,
373 int num_reg_params, struct reg_param *reg_param,
374 uint32_t entry_point, uint32_t exit_point,
375 int timeout_ms, void *arch_info);
376
377 /**
378 * Read @a count items of @a size bytes from the memory of @a target at
379 * the @a address given.
380 *
381 * This routine is a wrapper for target->type->read_memory.
382 */
383 int target_read_memory(struct target *target,
384 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
385 /**
386 * Write @a count items of @a size bytes to the memory of @a target at
387 * the @a address given.
388 *
389 * This routine is wrapper for target->type->write_memory.
390 */
391 int target_write_memory(struct target *target,
392 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
393
394 /**
395 * Write @a count items of 4 bytes to the memory of @a target at
396 * the @a address given. Because it operates only on whole words,
397 * this should be faster than target_write_memory().
398 *
399 * This routine is wrapper for target->type->bulk_write_memory.
400 */
401 int target_bulk_write_memory(struct target *target,
402 uint32_t address, uint32_t count, uint8_t *buffer);
403
404 /*
405 * Write to target memory using the virtual address.
406 *
407 * Note that this fn is used to implement software breakpoints. Targets
408 * can implement support for software breakpoints to memory marked as read
409 * only by making this fn write to ram even if it is read only(MMU or
410 * MPUs).
411 *
412 * It is sufficient to implement for writing a single word(16 or 32 in
413 * ARM32/16 bit case) to write the breakpoint to ram.
414 *
415 * The target should also take care of "other things" to make sure that
416 * software breakpoints can be written using this function. E.g.
417 * when there is a separate instruction and data cache, this fn must
418 * make sure that the instruction cache is synced up to the potential
419 * code change that can happen as a result of the memory write(typically
420 * by invalidating the cache).
421 *
422 * The high level wrapper fn in target.c will break down this memory write
423 * request to multiple write requests to the target driver to e.g. guarantee
424 * that writing 4 bytes to an aligned address happens with a single 32 bit
425 * write operation, thus making this fn suitable to e.g. write to special
426 * peripheral registers which do not support byte operations.
427 */
428 int target_write_buffer(struct target *target,
429 uint32_t address, uint32_t size, uint8_t *buffer);
430 int target_read_buffer(struct target *target,
431 uint32_t address, uint32_t size, uint8_t *buffer);
432 int target_checksum_memory(struct target *target,
433 uint32_t address, uint32_t size, uint32_t* crc);
434 int target_blank_check_memory(struct target *target,
435 uint32_t address, uint32_t size, uint32_t* blank);
436 int target_wait_state(struct target *target, enum target_state state, int ms);
437
438 /** Return the *name* of this targets current state */
439 const char *target_state_name( struct target *target );
440
441 /* DANGER!!!!!
442 *
443 * if "area" passed in to target_alloc_working_area() points to a memory
444 * location that goes out of scope (e.g. a pointer on the stack), then
445 * the caller of target_alloc_working_area() is responsible for invoking
446 * target_free_working_area() before "area" goes out of scope.
447 *
448 * target_free_all_working_areas() will NULL out the "area" pointer
449 * upon resuming or resetting the CPU.
450 *
451 */
452 int target_alloc_working_area(struct target *target,
453 uint32_t size, struct working_area **area);
454 int target_free_working_area(struct target *target, struct working_area *area);
455 int target_free_working_area_restore(struct target *target,
456 struct working_area *area, int restore);
457 void target_free_all_working_areas(struct target *target);
458 void target_free_all_working_areas_restore(struct target *target, int restore);
459
460 extern struct target *all_targets;
461
462 extern struct target_event_callback *target_event_callbacks;
463 extern struct target_timer_callback *target_timer_callbacks;
464
465 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
466 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
467 uint8_t target_buffer_get_u8 (struct target *target, const uint8_t *buffer);
468 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
469 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
470 void target_buffer_set_u8 (struct target *target, uint8_t *buffer, uint8_t value);
471
472 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
473 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
474 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
475 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
476 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
477 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
478
479 /* Issues USER() statements with target state information */
480 int target_arch_state(struct target *target);
481
482 void target_handle_event(struct target *t, enum target_event e);
483 void target_all_handle_event(enum target_event e);
484
485 #define ERROR_TARGET_INVALID (-300)
486 #define ERROR_TARGET_INIT_FAILED (-301)
487 #define ERROR_TARGET_TIMEOUT (-302)
488 #define ERROR_TARGET_NOT_HALTED (-304)
489 #define ERROR_TARGET_FAILURE (-305)
490 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
491 #define ERROR_TARGET_DATA_ABORT (-307)
492 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
493 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
494 #define ERROR_TARGET_NOT_RUNNING (-310)
495 #define ERROR_TARGET_NOT_EXAMINED (-311)
496
497 extern const Jim_Nvp nvp_error_target[];
498
499 const char *target_strerror_safe(int err);
500
501 #endif /* TARGET_H */