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"
34 struct command_context_s;
42 TARGET_DEBUG_RUNNING = 4,
45 extern char *target_state_strings[];
47 enum daemon_startup_mode
49 DAEMON_ATTACH, /* simply attach to the target */
50 DAEMON_RESET, /* reset target (behaviour defined by reset_mode */
53 extern enum daemon_startup_mode startup_mode;
55 enum target_reset_mode
57 RESET_RUN = 0, /* reset and let target run */
58 RESET_HALT = 1, /* reset and halt target out of reset */
59 RESET_INIT = 2, /* reset and halt target out of reset, then run init script */
60 RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
61 RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
64 enum target_debug_reason
67 DBG_REASON_BREAKPOINT = 1,
68 DBG_REASON_WATCHPOINT = 2,
69 DBG_REASON_WPTANDBKPT = 3,
70 DBG_REASON_SINGLESTEP = 4,
71 DBG_REASON_NOTHALTED = 5
74 extern char *target_debug_reason_strings[];
78 TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
81 extern char *target_endianess_strings[];
85 typedef struct working_area_s
91 struct working_area_s **user;
92 struct working_area_s *next;
95 typedef struct target_type_s
99 /* poll current target status */
100 enum target_state (*poll)(struct target_s *target);
101 /* architecture specific status reply */
102 int (*arch_state)(struct target_s *target, char *buf, int buf_size);
104 /* target execution control */
105 int (*halt)(struct target_s *target);
106 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
107 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
109 /* target reset control */
110 int (*assert_reset)(struct target_s *target);
111 int (*deassert_reset)(struct target_s *target);
112 int (*soft_reset_halt)(struct target_s *target);
113 int (*prepare_reset_halt)(struct target_s *target);
115 /* target register access for gdb */
116 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
118 /* target memory access
119 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
120 * count: number of items of <size>
122 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
123 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
125 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
126 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
128 /* target break-/watchpoint control
129 * rw: 0 = write, 1 = read, 2 = access
131 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
132 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
133 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
134 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
136 /* target algorithm support */
137 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);
139 int (*register_commands)(struct command_context_s *cmd_ctx);
140 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
141 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
146 typedef struct target_s
148 target_type_t *type; /* target type definition (name, access functions) */
149 enum target_reset_mode reset_mode; /* what to do after a reset */
150 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
151 char *reset_script; /* script file to initialize the target after a reset */
152 char *post_halt_script; /* script file to execute after the target halted */
153 char *pre_resume_script; /* script file to execute before the target resumed */
154 u32 working_area; /* working area (initialized RAM) */
155 u32 working_area_size; /* size in bytes */
156 u32 backup_working_area; /* whether the content of the working area has to be preserved */
157 struct working_area_s *working_areas;/* list of allocated working areas */
158 enum target_debug_reason debug_reason; /* reason why the target entered debug state */
159 enum target_endianess endianness; /* target endianess */
160 enum target_state state; /* the current backend-state (running, halted, ...) */
161 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
162 struct breakpoint_s *breakpoints; /* list of breakpoints */
163 struct watchpoint_s *watchpoints; /* list of watchpoints */
164 void *arch_info; /* architecture specific information */
165 struct target_s *next; /* next target in list */
170 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
171 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
172 TARGET_EVENT_RESET, /* target entered reset */
173 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
174 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
177 typedef struct target_event_callback_s
179 int (*callback)(struct target_s *target, enum target_event event, void *priv);
181 struct target_event_callback_s *next;
182 } target_event_callback_t;
184 typedef struct target_timer_callback_s
186 int (*callback)(void *priv);
191 struct target_timer_callback_s *next;
192 } target_timer_callback_t;
194 extern int target_register_commands(struct command_context_s *cmd_ctx);
195 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
196 extern int target_init(struct command_context_s *cmd_ctx);
197 extern int handle_target(void *priv);
199 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
200 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
201 extern int target_call_event_callbacks(target_t *target, enum target_event event);
203 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
204 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
205 extern int target_call_timer_callbacks();
207 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
208 extern int get_num_by_target(target_t *query_target);
209 extern target_t* get_target_by_num(int num);
211 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
212 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
214 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
215 extern int target_free_working_area(struct target_s *target, working_area_t *area);
216 extern int target_free_all_working_areas(struct target_s *target);
218 extern target_t *targets;
220 extern target_event_callback_t *target_event_callbacks;
221 extern target_timer_callback_t *target_timer_callbacks;
223 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
224 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
225 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
226 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
228 int target_read_u32(struct target_s *target, u32 address, u32 *value);
229 int target_read_u16(struct target_s *target, u32 address, u16 *value);
230 int target_read_u8(struct target_s *target, u32 address, u8 *value);
231 int target_write_u32(struct target_s *target, u32 address, u32 value);
232 int target_write_u16(struct target_s *target, u32 address, u16 value);
233 int target_write_u8(struct target_s *target, u32 address, u8 value);
235 #define ERROR_TARGET_INVALID (-300)
236 #define ERROR_TARGET_INIT_FAILED (-301)
237 #define ERROR_TARGET_TIMEOUT (-302)
238 #define ERROR_TARGET_ALREADY_HALTED (-303)
239 #define ERROR_TARGET_NOT_HALTED (-304)
240 #define ERROR_TARGET_FAILURE (-305)
241 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
242 #define ERROR_TARGET_DATA_ABORT (-307)
243 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
244 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
246 #endif /* TARGET_H */