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 enum target_state (*poll)(struct target_s *target);
102 /* architecture specific status reply */
103 int (*arch_state)(struct target_s *target, char *buf, int buf_size);
105 /* target request support */
106 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
108 /* target execution control */
109 int (*halt)(struct target_s *target);
110 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
111 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
113 /* target reset control */
114 int (*assert_reset)(struct target_s *target);
115 int (*deassert_reset)(struct target_s *target);
116 int (*soft_reset_halt)(struct target_s *target);
117 int (*prepare_reset_halt)(struct target_s *target);
119 /* target register access for gdb */
120 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
122 /* target memory access
123 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
124 * count: number of items of <size>
126 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
127 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
129 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
130 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
132 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
134 /* target break-/watchpoint control
135 * rw: 0 = write, 1 = read, 2 = access
137 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
138 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
139 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
140 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
142 /* target algorithm support */
143 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);
145 int (*register_commands)(struct command_context_s *cmd_ctx);
146 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
147 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
152 typedef struct target_s
154 target_type_t *type; /* target type definition (name, access functions) */
155 enum target_reset_mode reset_mode; /* what to do after a reset */
156 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
157 char *reset_script; /* script file to initialize the target after a reset */
158 char *post_halt_script; /* script file to execute after the target halted */
159 char *pre_resume_script; /* script file to execute before the target resumed */
160 char *gdb_program_script; /* script file to execute before programming vis gdb */
161 u32 working_area; /* working area (initialized RAM) */
162 u32 working_area_size; /* size in bytes */
163 u32 backup_working_area; /* whether the content of the working area has to be preserved */
164 struct working_area_s *working_areas;/* list of allocated working areas */
165 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
166 enum target_endianess endianness; /* target endianess */
167 enum target_state state; /* the current backend-state (running, halted, ...) */
168 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
169 struct breakpoint_s *breakpoints; /* list of breakpoints */
170 struct watchpoint_s *watchpoints; /* list of watchpoints */
171 struct trace_s *trace_info; /* generic trace information */
172 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
173 void *arch_info; /* architecture specific information */
174 struct target_s *next; /* next target in list */
179 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
180 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
181 TARGET_EVENT_RESET, /* target entered reset */
182 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
183 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
184 TARGET_EVENT_GDB_PROGRAM /* target about to be be programmed by gdb */
187 typedef struct target_event_callback_s
189 int (*callback)(struct target_s *target, enum target_event event, void *priv);
191 struct target_event_callback_s *next;
192 } target_event_callback_t;
194 typedef struct target_timer_callback_s
196 int (*callback)(void *priv);
201 struct target_timer_callback_s *next;
202 } target_timer_callback_t;
204 extern int target_register_commands(struct command_context_s *cmd_ctx);
205 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
206 extern int target_init(struct command_context_s *cmd_ctx);
207 extern int handle_target(void *priv);
208 extern int target_process_reset(struct command_context_s *cmd_ctx);
210 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
211 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
212 extern int target_call_event_callbacks(target_t *target, enum target_event event);
214 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
215 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
216 extern int target_call_timer_callbacks();
218 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
219 extern int get_num_by_target(target_t *query_target);
220 extern target_t* get_target_by_num(int num);
222 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
223 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
224 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
226 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
227 extern int target_free_working_area(struct target_s *target, working_area_t *area);
228 extern int target_free_all_working_areas(struct target_s *target);
230 extern target_t *targets;
232 extern target_event_callback_t *target_event_callbacks;
233 extern target_timer_callback_t *target_timer_callbacks;
235 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
236 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
237 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
238 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
240 int target_read_u32(struct target_s *target, u32 address, u32 *value);
241 int target_read_u16(struct target_s *target, u32 address, u16 *value);
242 int target_read_u8(struct target_s *target, u32 address, u8 *value);
243 int target_write_u32(struct target_s *target, u32 address, u32 value);
244 int target_write_u16(struct target_s *target, u32 address, u16 value);
245 int target_write_u8(struct target_s *target, u32 address, u8 value);
247 #define ERROR_TARGET_INVALID (-300)
248 #define ERROR_TARGET_INIT_FAILED (-301)
249 #define ERROR_TARGET_TIMEOUT (-302)
250 #define ERROR_TARGET_ALREADY_HALTED (-303)
251 #define ERROR_TARGET_NOT_HALTED (-304)
252 #define ERROR_TARGET_FAILURE (-305)
253 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
254 #define ERROR_TARGET_DATA_ABORT (-307)
255 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
256 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
258 #endif /* TARGET_H */