dae5f19e717ae7084787e764f14107239c6b7d3c
[openocd.git] / src / target / target.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
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. *
9 * *
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. *
14 * *
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 ***************************************************************************/
20 #ifndef TARGET_H
21 #define TARGET_H
22
23 #include "register.h"
24 #include "breakpoints.h"
25 #include "algorithm.h"
26 #include "trace.h"
27
28 #include "command.h"
29 #include "types.h"
30
31 #include <sys/time.h>
32 #include <time.h>
33
34 struct reg_s;
35 struct command_context_s;
36 /*
37 TARGET_UNKNOWN = 0: we don't know anything about the target yet
38 TARGET_RUNNING = 1: the target is executing user code
39 TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
40 debugger. on an xscale it means that the debug handler is executing
41 TARGET_RESET = 3: the target is being held in reset (only a temporary state,
42 not sure how this is used with all the recent changes)
43 TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
44 behalf of the debugger (e.g. algorithm for flashing)
45 */
46 enum target_state
47 {
48 TARGET_UNKNOWN = 0,
49 TARGET_RUNNING = 1,
50 TARGET_HALTED = 2,
51 TARGET_RESET = 3,
52 TARGET_DEBUG_RUNNING = 4,
53 };
54
55 extern char *target_state_strings[];
56
57 enum daemon_startup_mode
58 {
59 DAEMON_ATTACH, /* simply attach to the target */
60 DAEMON_RESET, /* reset target (behaviour defined by reset_mode */
61 };
62
63 extern enum daemon_startup_mode startup_mode;
64
65 enum target_reset_mode
66 {
67 RESET_RUN = 0, /* reset and let target run */
68 RESET_HALT = 1, /* reset and halt target out of reset */
69 RESET_INIT = 2, /* reset and halt target out of reset, then run init script */
70 RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
71 RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
72 };
73
74 enum target_debug_reason
75 {
76 DBG_REASON_DBGRQ = 0,
77 DBG_REASON_BREAKPOINT = 1,
78 DBG_REASON_WATCHPOINT = 2,
79 DBG_REASON_WPTANDBKPT = 3,
80 DBG_REASON_SINGLESTEP = 4,
81 DBG_REASON_NOTHALTED = 5,
82 DBG_REASON_UNDEFINED = 6
83 };
84
85 extern char *target_debug_reason_strings[];
86
87 enum target_endianess
88 {
89 TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
90 };
91
92 extern char *target_endianess_strings[];
93
94 struct target_s;
95
96 typedef struct working_area_s
97 {
98 u32 address;
99 u32 size;
100 int free;
101 u8 *backup;
102 struct working_area_s **user;
103 struct working_area_s *next;
104 } working_area_t;
105
106 typedef struct target_type_s
107 {
108 char *name;
109
110 /* poll current target status */
111 int (*poll)(struct target_s *target);
112 /* Invoked only from target_arch_state().
113 * Issue USER() w/architecture specific status. */
114 int (*arch_state)(struct target_s *target);
115
116 /* target request support */
117 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
118
119 /* target execution control */
120 int (*halt)(struct target_s *target);
121 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
122 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
123
124 /* target reset control */
125 int (*assert_reset)(struct target_s *target);
126 int (*deassert_reset)(struct target_s *target);
127 int (*soft_reset_halt)(struct target_s *target);
128 int (*prepare_reset_halt)(struct target_s *target);
129
130 /* target register access for gdb */
131 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
132
133 /* target memory access
134 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
135 * count: number of items of <size>
136 */
137 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
138 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
139
140 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
141 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
142
143 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
144
145 /* target break-/watchpoint control
146 * rw: 0 = write, 1 = read, 2 = access
147 */
148 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
149 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
150 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
151 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
152
153 /* target algorithm support */
154 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);
155
156 int (*register_commands)(struct command_context_s *cmd_ctx);
157 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
158 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
159 int (*quit)(void);
160
161 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
162 int (*mmu)(struct target_s *target, int *enabled);
163
164 } target_type_t;
165
166 typedef struct target_s
167 {
168 target_type_t *type; /* target type definition (name, access functions) */
169 enum target_reset_mode reset_mode; /* what to do after a reset */
170 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
171 char *reset_script; /* script file to initialize the target after a reset */
172 char *post_halt_script; /* script file to execute after the target halted */
173 char *pre_resume_script; /* script file to execute before the target resumed */
174 char *gdb_program_script; /* script file to execute before programming vis gdb */
175 u32 working_area; /* working area (initialized RAM). Evaluated
176 upon first allocation from virtual/physical address.
177 */
178 u32 working_area_virt; /* virtual address */
179 u32 working_area_phys; /* physical address */
180 u32 working_area_size; /* size in bytes */
181 u32 backup_working_area; /* whether the content of the working area has to be preserved */
182 struct working_area_s *working_areas;/* list of allocated working areas */
183 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
184 enum target_endianess endianness; /* target endianess */
185 enum target_state state; /* the current backend-state (running, halted, ...) */
186 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
187 struct breakpoint_s *breakpoints; /* list of breakpoints */
188 struct watchpoint_s *watchpoints; /* list of watchpoints */
189 struct trace_s *trace_info; /* generic trace information */
190 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
191 u32 dbg_msg_enabled; /* debug message status */
192 void *arch_info; /* architecture specific information */
193 struct target_s *next; /* next target in list */
194 } target_t;
195
196 enum target_event
197 {
198 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
199 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
200 TARGET_EVENT_RESET, /* target entered reset */
201 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
202 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
203 TARGET_EVENT_GDB_PROGRAM /* target about to be be programmed by gdb */
204 };
205
206 typedef struct target_event_callback_s
207 {
208 int (*callback)(struct target_s *target, enum target_event event, void *priv);
209 void *priv;
210 struct target_event_callback_s *next;
211 } target_event_callback_t;
212
213 typedef struct target_timer_callback_s
214 {
215 int (*callback)(void *priv);
216 int time_ms;
217 int periodic;
218 struct timeval when;
219 void *priv;
220 struct target_timer_callback_s *next;
221 } target_timer_callback_t;
222
223 extern int target_register_commands(struct command_context_s *cmd_ctx);
224 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
225 extern int target_init(struct command_context_s *cmd_ctx);
226 extern int target_init_reset(struct command_context_s *cmd_ctx);
227 extern int handle_target(void *priv);
228 extern int target_process_reset(struct command_context_s *cmd_ctx);
229
230 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
231 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
232 extern int target_call_event_callbacks(target_t *target, enum target_event event);
233
234 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
235 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
236 extern int target_call_timer_callbacks();
237
238 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
239 extern int get_num_by_target(target_t *query_target);
240 extern target_t* get_target_by_num(int num);
241
242 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
243 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
244 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
245
246 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
247 extern int target_free_working_area(struct target_s *target, working_area_t *area);
248 extern int target_free_all_working_areas(struct target_s *target);
249
250 extern target_t *targets;
251
252 extern target_event_callback_t *target_event_callbacks;
253 extern target_timer_callback_t *target_timer_callbacks;
254
255 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
256 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
257 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
258 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
259
260 int target_read_u32(struct target_s *target, u32 address, u32 *value);
261 int target_read_u16(struct target_s *target, u32 address, u16 *value);
262 int target_read_u8(struct target_s *target, u32 address, u8 *value);
263 int target_write_u32(struct target_s *target, u32 address, u32 value);
264 int target_write_u16(struct target_s *target, u32 address, u16 value);
265 int target_write_u8(struct target_s *target, u32 address, u8 value);
266
267 /* Issues USER() statements with target state information */
268 int target_arch_state(struct target_s *target);
269
270 #define ERROR_TARGET_INVALID (-300)
271 #define ERROR_TARGET_INIT_FAILED (-301)
272 #define ERROR_TARGET_TIMEOUT (-302)
273 #define ERROR_TARGET_ALREADY_HALTED (-303)
274 #define ERROR_TARGET_NOT_HALTED (-304)
275 #define ERROR_TARGET_FAILURE (-305)
276 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
277 #define ERROR_TARGET_DATA_ABORT (-307)
278 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
279 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
280
281 #endif /* TARGET_H */