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;
43 TARGET_DEBUG_RUNNING = 4,
46 extern char *target_state_strings[];
48 enum daemon_startup_mode
50 DAEMON_ATTACH, /* simply attach to the target */
51 DAEMON_RESET, /* reset target (behaviour defined by reset_mode */
54 extern enum daemon_startup_mode startup_mode;
56 enum target_reset_mode
58 RESET_RUN = 0, /* reset and let target run */
59 RESET_HALT = 1, /* reset and halt target out of reset */
60 RESET_INIT = 2, /* reset and halt target out of reset, then run init script */
61 RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
62 RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
65 enum target_debug_reason
68 DBG_REASON_BREAKPOINT = 1,
69 DBG_REASON_WATCHPOINT = 2,
70 DBG_REASON_WPTANDBKPT = 3,
71 DBG_REASON_SINGLESTEP = 4,
72 DBG_REASON_NOTHALTED = 5
75 extern char *target_debug_reason_strings[];
79 TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
82 extern char *target_endianess_strings[];
86 typedef struct working_area_s
92 struct working_area_s **user;
93 struct working_area_s *next;
96 typedef struct target_type_s
100 /* poll current target status */
101 int (*poll)(struct target_s *target);
102 /* Invoked only from target_arch_state().
103 * Issue USER() w/architecture specific status. */
104 int (*arch_state)(struct target_s *target);
106 /* target request support */
107 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
109 /* target execution control */
110 int (*halt)(struct target_s *target);
111 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
112 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
114 /* target reset control */
115 int (*assert_reset)(struct target_s *target);
116 int (*deassert_reset)(struct target_s *target);
117 int (*soft_reset_halt)(struct target_s *target);
118 int (*prepare_reset_halt)(struct target_s *target);
120 /* target register access for gdb */
121 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
123 /* target memory access
124 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
125 * count: number of items of <size>
127 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
128 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
130 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
131 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
133 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
135 /* target break-/watchpoint control
136 * rw: 0 = write, 1 = read, 2 = access
138 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
139 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
140 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
141 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
143 /* target algorithm support */
144 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);
146 int (*register_commands)(struct command_context_s *cmd_ctx);
147 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
148 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
151 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
152 int (*mmu)(struct target_s *target, int *enabled);
156 typedef struct target_s
158 target_type_t *type; /* target type definition (name, access functions) */
159 enum target_reset_mode reset_mode; /* what to do after a reset */
160 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
161 char *reset_script; /* script file to initialize the target after a reset */
162 char *post_halt_script; /* script file to execute after the target halted */
163 char *pre_resume_script; /* script file to execute before the target resumed */
164 char *gdb_program_script; /* script file to execute before programming vis gdb */
165 u32 working_area; /* working area (initialized RAM). Evaluated
166 upon first allocation from virtual/physical address.
168 u32 working_area_virt; /* virtual address */
169 u32 working_area_phys; /* physical address */
170 u32 working_area_size; /* size in bytes */
171 u32 backup_working_area; /* whether the content of the working area has to be preserved */
172 struct working_area_s *working_areas;/* list of allocated working areas */
173 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
174 enum target_endianess endianness; /* target endianess */
175 enum target_state state; /* the current backend-state (running, halted, ...) */
176 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
177 struct breakpoint_s *breakpoints; /* list of breakpoints */
178 struct watchpoint_s *watchpoints; /* list of watchpoints */
179 struct trace_s *trace_info; /* generic trace information */
180 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
181 u32 dbg_msg_enabled; /* debug message status */
182 void *arch_info; /* architecture specific information */
183 struct target_s *next; /* next target in list */
188 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
189 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
190 TARGET_EVENT_RESET, /* target entered reset */
191 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
192 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
193 TARGET_EVENT_GDB_PROGRAM /* target about to be be programmed by gdb */
196 typedef struct target_event_callback_s
198 int (*callback)(struct target_s *target, enum target_event event, void *priv);
200 struct target_event_callback_s *next;
201 } target_event_callback_t;
203 typedef struct target_timer_callback_s
205 int (*callback)(void *priv);
210 struct target_timer_callback_s *next;
211 } target_timer_callback_t;
213 extern int target_register_commands(struct command_context_s *cmd_ctx);
214 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
215 extern int target_init(struct command_context_s *cmd_ctx);
216 extern int target_init_reset(struct command_context_s *cmd_ctx);
217 extern int handle_target(void *priv);
218 extern int target_process_reset(struct command_context_s *cmd_ctx);
220 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
221 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
222 extern int target_call_event_callbacks(target_t *target, enum target_event event);
224 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
225 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
226 extern int target_call_timer_callbacks();
228 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
229 extern int get_num_by_target(target_t *query_target);
230 extern target_t* get_target_by_num(int num);
232 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
233 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
234 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
236 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
237 extern int target_free_working_area(struct target_s *target, working_area_t *area);
238 extern int target_free_all_working_areas(struct target_s *target);
240 extern target_t *targets;
242 extern target_event_callback_t *target_event_callbacks;
243 extern target_timer_callback_t *target_timer_callbacks;
245 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
246 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
247 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
248 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
250 int target_read_u32(struct target_s *target, u32 address, u32 *value);
251 int target_read_u16(struct target_s *target, u32 address, u16 *value);
252 int target_read_u8(struct target_s *target, u32 address, u8 *value);
253 int target_write_u32(struct target_s *target, u32 address, u32 value);
254 int target_write_u16(struct target_s *target, u32 address, u16 value);
255 int target_write_u8(struct target_s *target, u32 address, u8 value);
257 #define ERROR_TARGET_INVALID (-300)
258 #define ERROR_TARGET_INIT_FAILED (-301)
259 #define ERROR_TARGET_TIMEOUT (-302)
260 #define ERROR_TARGET_ALREADY_HALTED (-303)
261 #define ERROR_TARGET_NOT_HALTED (-304)
262 #define ERROR_TARGET_FAILURE (-305)
263 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
264 #define ERROR_TARGET_DATA_ABORT (-307)
265 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
266 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
268 #endif /* TARGET_H */