Revert "target: remove unused working area 'user' field"
[fw/openocd] / src / target / target.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007-2010 Ã˜yvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
10  *                                                                         *
11  *   Copyright (C) 2011 by Broadcom Corporation                            *
12  *   Evan Hunter - ehunter@broadcom.com                                    *
13  *                                                                         *
14  *   Copyright (C) ST-Ericsson SA 2011                                     *
15  *   michel.jaouen@stericsson.com : smp minimum support                    *
16  *                                                                         *
17  *   This program is free software; you can redistribute it and/or modify  *
18  *   it under the terms of the GNU General Public License as published by  *
19  *   the Free Software Foundation; either version 2 of the License, or     *
20  *   (at your option) any later version.                                   *
21  *                                                                         *
22  *   This program is distributed in the hope that it will be useful,       *
23  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
24  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
25  *   GNU General Public License for more details.                          *
26  *                                                                         *
27  *   You should have received a copy of the GNU General Public License     *
28  *   along with this program; if not, write to the                         *
29  *   Free Software Foundation, Inc.,                                       *
30  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
31  ***************************************************************************/
32
33 #ifndef TARGET_H
34 #define TARGET_H
35
36 struct reg;
37 struct trace;
38 struct command_context;
39 struct breakpoint;
40 struct watchpoint;
41 struct mem_param;
42 struct reg_param;
43 struct target_list;
44
45 /*
46  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
47  * TARGET_RUNNING = 1: the target is executing user code
48  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
49  * debugger. on an xscale it means that the debug handler is executing
50  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
51  * not sure how this is used with all the recent changes)
52  * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
53  * behalf of the debugger (e.g. algorithm for flashing)
54  *
55  * also see: target_state_name();
56  */
57
58 enum target_state {
59         TARGET_UNKNOWN = 0,
60         TARGET_RUNNING = 1,
61         TARGET_HALTED = 2,
62         TARGET_RESET = 3,
63         TARGET_DEBUG_RUNNING = 4,
64 };
65
66 enum nvp_assert {
67         NVP_DEASSERT,
68         NVP_ASSERT,
69 };
70
71 enum target_reset_mode {
72         RESET_UNKNOWN = 0,
73         RESET_RUN = 1,          /* reset and let target run */
74         RESET_HALT = 2,         /* reset and halt target out of reset */
75         RESET_INIT = 3,         /* reset and halt target out of reset, then run init script */
76 };
77
78 enum target_debug_reason {
79         DBG_REASON_DBGRQ = 0,
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
86 };
87
88 enum target_endianness {
89         TARGET_ENDIAN_UNKNOWN = 0,
90         TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
91 };
92
93 struct working_area {
94         uint32_t address;
95         uint32_t size;
96         bool free;
97         uint8_t *backup;
98         struct working_area **user;
99         struct working_area *next;
100 };
101
102 struct gdb_service {
103         struct target *target;
104         /*  field for smp display  */
105         /*  element 0 coreid currently displayed ( 1 till n) */
106         /*  element 1 coreid to be displayed at next resume 1 till n 0 means resume
107          *  all cores core displayed  */
108         int32_t core[2];
109 };
110
111 /* target_type.h contains the full definition of struct target_type */
112 struct target {
113         struct target_type *type;                       /* target type definition (name, access functions) */
114         const char *cmd_name;                           /* tcl Name of target */
115         int target_number;                                      /* DO NOT USE!  field to be removed in 2010 */
116         struct jtag_tap *tap;                           /* where on the jtag chain is this */
117         int32_t coreid;                                         /* which device on the TAP? */
118         const char *variant;                            /* what variant of this chip is it? */
119
120         /**
121          * Indicates whether this target has been examined.
122          *
123          * Do @b not access this field directly, use target_was_examined()
124          * or target_set_examined().
125          */
126         bool examined;
127
128         /**
129          * true if the  target is currently running a downloaded
130          * "algorithm" instead of arbitrary user code. OpenOCD code
131          * invoking algorithms is trusted to maintain correctness of
132          * any cached state (e.g. for flash status), which arbitrary
133          * code will have no reason to know about.
134          */
135         bool running_alg;
136
137         struct target_event_action *event_action;
138
139         int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
140         uint32_t working_area;                          /* working area (initialised RAM). Evaluated
141                                                                                  * upon first allocation from virtual/physical address. */
142         bool working_area_virt_spec;            /* virtual address specified? */
143         uint32_t working_area_virt;                     /* virtual address */
144         bool working_area_phys_spec;            /* virtual address specified? */
145         uint32_t working_area_phys;                     /* physical address */
146         uint32_t working_area_size;                     /* size in bytes */
147         uint32_t backup_working_area;           /* whether the content of the working area has to be preserved */
148         struct working_area *working_areas;/* list of allocated working areas */
149         enum target_debug_reason debug_reason;/* reason why the target entered debug state */
150         enum target_endianness endianness;      /* target endianness */
151         /* also see: target_state_name() */
152         enum target_state state;                        /* the current backend-state (running, halted, ...) */
153         struct reg_cache *reg_cache;            /* the first register cache of the target (core regs) */
154         struct breakpoint *breakpoints;         /* list of breakpoints */
155         struct watchpoint *watchpoints;         /* list of watchpoints */
156         struct trace *trace_info;                       /* generic trace information */
157         struct debug_msg_receiver *dbgmsg;      /* list of debug message receivers */
158         uint32_t dbg_msg_enabled;                       /* debug message status */
159         void *arch_info;                                        /* architecture specific information */
160         struct target *next;                            /* next target in list */
161
162         int display;                                            /* display async info in telnet session. Do not display
163                                                                                  * lots of halted/resumed info when stepping in debugger. */
164         bool halt_issued;                                       /* did we transition to halted state? */
165         long long halt_issued_time;                     /* Note time when halt was issued */
166
167         bool dbgbase_set;                                       /* By default the debug base is not set */
168         uint32_t dbgbase;                                       /* Really a Cortex-A specific option, but there is no
169                                                                                  * system in place to support target specific options
170                                                                                  * currently. */
171         struct rtos *rtos;                                      /* Instance of Real Time Operating System support */
172         bool rtos_auto_detect;                          /* A flag that indicates that the RTOS has been specified as "auto"
173                                                                                  * and must be detected when symbols are offered */
174
175         int smp;                                                        /* add some target attributes for smp support */
176         struct target_list *head;
177         /* the gdb service is there in case of smp, we have only one gdb server
178          * for all smp target
179          * the target attached to the gdb is changing dynamically by changing
180          * gdb_service->target pointer */
181         struct gdb_service *gdb_service;
182 };
183
184 struct target_list {
185         struct target *target;
186         struct target_list *next;
187 };
188
189 /** Returns the instance-specific name of the specified target. */
190 static inline const char *target_name(struct target *target)
191 {
192         return target->cmd_name;
193 }
194
195 const char *debug_reason_name(struct target *t);
196
197 enum target_event {
198
199         /* allow GDB to do stuff before others handle the halted event,
200          * this is in lieu of defining ordering of invocation of events,
201          * which would be more complicated
202          *
203          * Telling GDB to halt does not mean that the target stopped running,
204          * simply that we're dropping out of GDB's waiting for step or continue.
205          *
206          * This can be useful when e.g. detecting power dropout.
207          */
208         TARGET_EVENT_GDB_HALT,
209         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
210         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
211         TARGET_EVENT_RESUME_START,
212         TARGET_EVENT_RESUME_END,
213
214         TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
215         TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
216
217         TARGET_EVENT_RESET_START,
218         TARGET_EVENT_RESET_ASSERT_PRE,
219         TARGET_EVENT_RESET_ASSERT,      /* C code uses this instead of SRST */
220         TARGET_EVENT_RESET_ASSERT_POST,
221         TARGET_EVENT_RESET_DEASSERT_PRE,
222         TARGET_EVENT_RESET_DEASSERT_POST,
223         TARGET_EVENT_RESET_HALT_PRE,
224         TARGET_EVENT_RESET_HALT_POST,
225         TARGET_EVENT_RESET_WAIT_PRE,
226         TARGET_EVENT_RESET_WAIT_POST,
227         TARGET_EVENT_RESET_INIT,
228         TARGET_EVENT_RESET_END,
229
230         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
231         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
232
233         TARGET_EVENT_EXAMINE_START,
234         TARGET_EVENT_EXAMINE_END,
235
236         TARGET_EVENT_GDB_ATTACH,
237         TARGET_EVENT_GDB_DETACH,
238
239         TARGET_EVENT_GDB_FLASH_ERASE_START,
240         TARGET_EVENT_GDB_FLASH_ERASE_END,
241         TARGET_EVENT_GDB_FLASH_WRITE_START,
242         TARGET_EVENT_GDB_FLASH_WRITE_END,
243 };
244
245 struct target_event_action {
246         enum target_event event;
247         struct Jim_Interp *interp;
248         struct Jim_Obj *body;
249         int has_percent;
250         struct target_event_action *next;
251 };
252
253 bool target_has_event_action(struct target *target, enum target_event event);
254
255 struct target_event_callback {
256         int (*callback)(struct target *target, enum target_event event, void *priv);
257         void *priv;
258         struct target_event_callback *next;
259 };
260
261 struct target_timer_callback {
262         int (*callback)(void *priv);
263         int time_ms;
264         int periodic;
265         struct timeval when;
266         void *priv;
267         struct target_timer_callback *next;
268 };
269
270 int target_register_commands(struct command_context *cmd_ctx);
271 int target_examine(void);
272
273 int target_register_event_callback(
274                 int (*callback)(struct target *target,
275                 enum target_event event, void *priv),
276                 void *priv);
277 int target_unregister_event_callback(
278                 int (*callback)(struct target *target,
279                 enum target_event event, void *priv),
280                 void *priv);
281
282 /* Poll the status of the target, detect any error conditions and report them.
283  *
284  * Also note that this fn will clear such error conditions, so a subsequent
285  * invocation will then succeed.
286  *
287  * These error conditions can be "sticky" error conditions. E.g. writing
288  * to memory could be implemented as an open loop and if memory writes
289  * fails, then a note is made of it, the error is sticky, but the memory
290  * write loop still runs to completion. This improves performance in the
291  * normal case as there is no need to verify that every single write succeed,
292  * yet it is possible to detect error conditions.
293  */
294 int target_poll(struct target *target);
295 int target_resume(struct target *target, int current, uint32_t address,
296                 int handle_breakpoints, int debug_execution);
297 int target_halt(struct target *target);
298 int target_call_event_callbacks(struct target *target, enum target_event event);
299
300 /**
301  * The period is very approximate, the callback can happen much more often
302  * or much more rarely than specified
303  */
304 int target_register_timer_callback(int (*callback)(void *priv),
305                 int time_ms, int periodic, void *priv);
306
307 int target_call_timer_callbacks(void);
308 /**
309  * Invoke this to ensure that e.g. polling timer callbacks happen before
310  * a synchronous command completes.
311  */
312 int target_call_timer_callbacks_now(void);
313
314 struct target *get_current_target(struct command_context *cmd_ctx);
315 struct target *get_target(const char *id);
316
317 /**
318  * Get the target type name.
319  *
320  * This routine is a wrapper for the target->type->name field.
321  * Note that this is not an instance-specific name for his target.
322  */
323 const char *target_type_name(struct target *target);
324
325 /**
326  * Examine the specified @a target, letting it perform any
327  * Initialisation that requires JTAG access.
328  *
329  * This routine is a wrapper for target->type->examine.
330  */
331 int target_examine_one(struct target *target);
332
333 /** @returns @c true if target_set_examined() has been called. */
334 static inline bool target_was_examined(struct target *target)
335 {
336         return target->examined;
337 }
338
339 /** Sets the @c examined flag for the given target. */
340 /** Use in target->type->examine() after one-time setup is done. */
341 static inline void target_set_examined(struct target *target)
342 {
343         target->examined = true;
344 }
345
346 /**
347  * Add the @a breakpoint for @a target.
348  *
349  * This routine is a wrapper for target->type->add_breakpoint.
350  */
351 int target_add_breakpoint(struct target *target,
352                 struct breakpoint *breakpoint);
353 /**
354  * Add the @a ContextID breakpoint  for @a target.
355  *
356  * This routine is a wrapper for target->type->add_context_breakpoint.
357  */
358 int target_add_context_breakpoint(struct target *target,
359                 struct breakpoint *breakpoint);
360 /**
361  * Add the @a ContextID & IVA breakpoint  for @a target.
362  *
363  * This routine is a wrapper for target->type->add_hybrid_breakpoint.
364  */
365 int target_add_hybrid_breakpoint(struct target *target,
366                 struct breakpoint *breakpoint);
367 /**
368  * Remove the @a breakpoint for @a target.
369  *
370  * This routine is a wrapper for target->type->remove_breakpoint.
371  */
372
373 int target_remove_breakpoint(struct target *target,
374                 struct breakpoint *breakpoint);
375 /**
376  * Add the @a watchpoint for @a target.
377  *
378  * This routine is a wrapper for target->type->add_watchpoint.
379  */
380 int target_add_watchpoint(struct target *target,
381                 struct watchpoint *watchpoint);
382 /**
383  * Remove the @a watchpoint for @a target.
384  *
385  * This routine is a wrapper for target->type->remove_watchpoint.
386  */
387 int target_remove_watchpoint(struct target *target,
388                 struct watchpoint *watchpoint);
389
390 /**
391  * Obtain the registers for GDB.
392  *
393  * This routine is a wrapper for target->type->get_gdb_reg_list.
394  */
395 int target_get_gdb_reg_list(struct target *target,
396                 struct reg **reg_list[], int *reg_list_size);
397
398 /**
399  * Step the target.
400  *
401  * This routine is a wrapper for target->type->step.
402  */
403 int target_step(struct target *target,
404                 int current, uint32_t address, int handle_breakpoints);
405 /**
406  * Run an algorithm on the @a target given.
407  *
408  * This routine is a wrapper for target->type->run_algorithm.
409  */
410 int target_run_algorithm(struct target *target,
411                 int num_mem_params, struct mem_param *mem_params,
412                 int num_reg_params, struct reg_param *reg_param,
413                 uint32_t entry_point, uint32_t exit_point,
414                 int timeout_ms, void *arch_info);
415
416 /**
417  * Starts an algorithm in the background on the @a target given.
418  *
419  * This routine is a wrapper for target->type->start_algorithm.
420  */
421 int target_start_algorithm(struct target *target,
422                 int num_mem_params, struct mem_param *mem_params,
423                 int num_reg_params, struct reg_param *reg_params,
424                 uint32_t entry_point, uint32_t exit_point,
425                 void *arch_info);
426
427 /**
428  * Wait for an algorithm on the @a target given.
429  *
430  * This routine is a wrapper for target->type->wait_algorithm.
431  */
432 int target_wait_algorithm(struct target *target,
433                 int num_mem_params, struct mem_param *mem_params,
434                 int num_reg_params, struct reg_param *reg_params,
435                 uint32_t exit_point, int timeout_ms,
436                 void *arch_info);
437
438 /**
439  * This routine is a wrapper for asynchronous algorithms.
440  *
441  */
442 int target_run_flash_async_algorithm(struct target *target,
443                 uint8_t *buffer, uint32_t count, int block_size,
444                 int num_mem_params, struct mem_param *mem_params,
445                 int num_reg_params, struct reg_param *reg_params,
446                 uint32_t buffer_start, uint32_t buffer_size,
447                 uint32_t entry_point, uint32_t exit_point,
448                 void *arch_info);
449
450 /**
451  * Read @a count items of @a size bytes from the memory of @a target at
452  * the @a address given.
453  *
454  * This routine is a wrapper for target->type->read_memory.
455  */
456 int target_read_memory(struct target *target,
457                 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
458 /**
459  * Write @a count items of @a size bytes to the memory of @a target at
460  * the @a address given. @a address must be aligned to @a size
461  * in target memory.
462  *
463  * The endianness is the same in the host and target memory for this
464  * function.
465  *
466  * \todo TODO:
467  * Really @a buffer should have been defined as "const void *" and
468  * @a buffer should have been aligned to @a size in the host memory.
469  *
470  * This is not enforced via e.g. assert's today and e.g. the
471  * target_write_buffer fn breaks this assumption.
472  *
473  * This routine is wrapper for target->type->write_memory.
474  */
475 int target_write_memory(struct target *target,
476                 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
477
478 /**
479  * Write @a count items of 4 bytes to the memory of @a target at
480  * the @a address given.  Because it operates only on whole words,
481  * this should be faster than target_write_memory().
482  *
483  * This routine is wrapper for target->type->bulk_write_memory.
484  */
485 int target_bulk_write_memory(struct target *target,
486                 uint32_t address, uint32_t count, const uint8_t *buffer);
487
488 /*
489  * Write to target memory using the virtual address.
490  *
491  * Note that this fn is used to implement software breakpoints. Targets
492  * can implement support for software breakpoints to memory marked as read
493  * only by making this fn write to ram even if it is read only(MMU or
494  * MPUs).
495  *
496  * It is sufficient to implement for writing a single word(16 or 32 in
497  * ARM32/16 bit case) to write the breakpoint to ram.
498  *
499  * The target should also take care of "other things" to make sure that
500  * software breakpoints can be written using this function. E.g.
501  * when there is a separate instruction and data cache, this fn must
502  * make sure that the instruction cache is synced up to the potential
503  * code change that can happen as a result of the memory write(typically
504  * by invalidating the cache).
505  *
506  * The high level wrapper fn in target.c will break down this memory write
507  * request to multiple write requests to the target driver to e.g. guarantee
508  * that writing 4 bytes to an aligned address happens with a single 32 bit
509  * write operation, thus making this fn suitable to e.g. write to special
510  * peripheral registers which do not support byte operations.
511  */
512 int target_write_buffer(struct target *target,
513                 uint32_t address, uint32_t size, const uint8_t *buffer);
514 int target_read_buffer(struct target *target,
515                 uint32_t address, uint32_t size, uint8_t *buffer);
516 int target_checksum_memory(struct target *target,
517                 uint32_t address, uint32_t size, uint32_t *crc);
518 int target_blank_check_memory(struct target *target,
519                 uint32_t address, uint32_t size, uint32_t *blank);
520 int target_wait_state(struct target *target, enum target_state state, int ms);
521
522 /** Return the *name* of this targets current state */
523 const char *target_state_name(struct target *target);
524
525 /* DANGER!!!!!
526  *
527  * if "area" passed in to target_alloc_working_area() points to a memory
528  * location that goes out of scope (e.g. a pointer on the stack), then
529  * the caller of target_alloc_working_area() is responsible for invoking
530  * target_free_working_area() before "area" goes out of scope.
531  *
532  * target_free_all_working_areas() will NULL out the "area" pointer
533  * upon resuming or resetting the CPU.
534  *
535  */
536 int target_alloc_working_area(struct target *target,
537                 uint32_t size, struct working_area **area);
538 /* Same as target_alloc_working_area, except that no error is logged
539  * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
540  *
541  * This allows the calling code to *try* to allocate target memory
542  * and have a fallback to another behaviour(slower?).
543  */
544 int target_alloc_working_area_try(struct target *target,
545                 uint32_t size, struct working_area **area);
546 int target_free_working_area(struct target *target, struct working_area *area);
547 void target_free_all_working_areas(struct target *target);
548 uint32_t target_get_working_area_avail(struct target *target);
549
550 extern struct target *all_targets;
551
552 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
553 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
554 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
555 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
556 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
557 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
558
559 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
560 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
561 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf);
562 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf);
563
564 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
565 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
566 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
567 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
568 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
569 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
570
571 /* Issues USER() statements with target state information */
572 int target_arch_state(struct target *target);
573
574 void target_handle_event(struct target *t, enum target_event e);
575
576 #define ERROR_TARGET_INVALID    (-300)
577 #define ERROR_TARGET_INIT_FAILED (-301)
578 #define ERROR_TARGET_TIMEOUT    (-302)
579 #define ERROR_TARGET_NOT_HALTED (-304)
580 #define ERROR_TARGET_FAILURE    (-305)
581 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
582 #define ERROR_TARGET_DATA_ABORT (-307)
583 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
584 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
585 #define ERROR_TARGET_NOT_RUNNING (-310)
586 #define ERROR_TARGET_NOT_EXAMINED (-311)
587
588 extern bool get_target_reset_nag(void);
589
590 #endif /* TARGET_H */