ae5fbc431044227f2c9cb5dd35808ebdc2f18fbf
[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 enum target_state
38 {
39 TARGET_UNKNOWN = 0,
40 TARGET_RUNNING = 1,
41 TARGET_HALTED = 2,
42 TARGET_RESET = 3,
43 TARGET_DEBUG_RUNNING = 4,
44 };
45
46 extern char *target_state_strings[];
47
48 enum daemon_startup_mode
49 {
50 DAEMON_ATTACH, /* simply attach to the target */
51 DAEMON_RESET, /* reset target (behaviour defined by reset_mode */
52 };
53
54 extern enum daemon_startup_mode startup_mode;
55
56 enum target_reset_mode
57 {
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 */
63 };
64
65 enum target_debug_reason
66 {
67 DBG_REASON_DBGRQ = 0,
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
73 };
74
75 extern char *target_debug_reason_strings[];
76
77 enum target_endianess
78 {
79 TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
80 };
81
82 extern char *target_endianess_strings[];
83
84 struct target_s;
85
86 typedef struct working_area_s
87 {
88 u32 address;
89 u32 size;
90 int free;
91 u8 *backup;
92 struct working_area_s **user;
93 struct working_area_s *next;
94 } working_area_t;
95
96 typedef struct target_type_s
97 {
98 char *name;
99
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);
104
105 /* target request support */
106 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
107
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);
112
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);
118
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);
121
122 /* target memory access
123 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
124 * count: number of items of <size>
125 */
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);
128
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);
131
132 /* target break-/watchpoint control
133 * rw: 0 = write, 1 = read, 2 = access
134 */
135 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
136 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
137 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
138 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
139
140 /* target algorithm support */
141 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);
142
143 int (*register_commands)(struct command_context_s *cmd_ctx);
144 int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
145 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
146 int (*quit)(void);
147
148 } target_type_t;
149
150 typedef struct target_s
151 {
152 target_type_t *type; /* target type definition (name, access functions) */
153 enum target_reset_mode reset_mode; /* what to do after a reset */
154 int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
155 char *reset_script; /* script file to initialize the target after a reset */
156 char *post_halt_script; /* script file to execute after the target halted */
157 char *pre_resume_script; /* script file to execute before the target resumed */
158 u32 working_area; /* working area (initialized RAM) */
159 u32 working_area_size; /* size in bytes */
160 u32 backup_working_area; /* whether the content of the working area has to be preserved */
161 struct working_area_s *working_areas;/* list of allocated working areas */
162 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
163 enum target_endianess endianness; /* target endianess */
164 enum target_state state; /* the current backend-state (running, halted, ...) */
165 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
166 struct breakpoint_s *breakpoints; /* list of breakpoints */
167 struct watchpoint_s *watchpoints; /* list of watchpoints */
168 struct trace_s *trace_info; /* generic trace information */
169 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
170 void *arch_info; /* architecture specific information */
171 struct target_s *next; /* next target in list */
172 } target_t;
173
174 enum target_event
175 {
176 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
177 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
178 TARGET_EVENT_RESET, /* target entered reset */
179 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
180 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
181 };
182
183 typedef struct target_event_callback_s
184 {
185 int (*callback)(struct target_s *target, enum target_event event, void *priv);
186 void *priv;
187 struct target_event_callback_s *next;
188 } target_event_callback_t;
189
190 typedef struct target_timer_callback_s
191 {
192 int (*callback)(void *priv);
193 int time_ms;
194 int periodic;
195 struct timeval when;
196 void *priv;
197 struct target_timer_callback_s *next;
198 } target_timer_callback_t;
199
200 extern int target_register_commands(struct command_context_s *cmd_ctx);
201 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
202 extern int target_init(struct command_context_s *cmd_ctx);
203 extern int handle_target(void *priv);
204 extern int target_process_reset(struct command_context_s *cmd_ctx);
205
206 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
207 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
208 extern int target_call_event_callbacks(target_t *target, enum target_event event);
209
210 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
211 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
212 extern int target_call_timer_callbacks();
213
214 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
215 extern int get_num_by_target(target_t *query_target);
216 extern target_t* get_target_by_num(int num);
217
218 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
219 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
220
221 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
222 extern int target_free_working_area(struct target_s *target, working_area_t *area);
223 extern int target_free_all_working_areas(struct target_s *target);
224
225 extern target_t *targets;
226
227 extern target_event_callback_t *target_event_callbacks;
228 extern target_timer_callback_t *target_timer_callbacks;
229
230 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
231 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
232 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
233 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
234
235 int target_read_u32(struct target_s *target, u32 address, u32 *value);
236 int target_read_u16(struct target_s *target, u32 address, u16 *value);
237 int target_read_u8(struct target_s *target, u32 address, u8 *value);
238 int target_write_u32(struct target_s *target, u32 address, u32 value);
239 int target_write_u16(struct target_s *target, u32 address, u16 value);
240 int target_write_u8(struct target_s *target, u32 address, u8 value);
241
242 #define ERROR_TARGET_INVALID (-300)
243 #define ERROR_TARGET_INIT_FAILED (-301)
244 #define ERROR_TARGET_TIMEOUT (-302)
245 #define ERROR_TARGET_ALREADY_HALTED (-303)
246 #define ERROR_TARGET_NOT_HALTED (-304)
247 #define ERROR_TARGET_FAILURE (-305)
248 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
249 #define ERROR_TARGET_DATA_ABORT (-307)
250 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
251 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
252
253 #endif /* TARGET_H */