]> git.sur5r.net Git - openocd/blob - src/target/target.h
- added missing AT91RM9200 files
[openocd] / 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
27 #include "command.h"
28 #include "types.h"
29
30 #include <sys/time.h>
31 #include <time.h>
32
33 struct reg_s;
34 struct command_context_s;
35
36 enum target_state
37 {
38         TARGET_UNKNOWN = 0,
39         TARGET_RUNNING = 1,
40         TARGET_HALTED = 2,
41         TARGET_RESET = 3,
42         TARGET_DEBUG_RUNNING = 4,
43 };
44
45 extern char *target_state_strings[];
46
47 enum daemon_startup_mode
48 {
49         DAEMON_ATTACH,          /* simply attach to the target */
50         DAEMON_RESET,           /* reset target (behaviour defined by reset_mode */
51 };
52
53 enum target_reset_mode
54 {
55         RESET_RUN = 0,          /* reset and let target run */
56         RESET_HALT = 1,         /* reset and halt target out of reset */
57         RESET_INIT = 2,         /* reset and halt target out of reset, then run init script */
58         RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
59         RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
60 };
61
62 enum target_debug_reason
63 {
64         DBG_REASON_DBGRQ = 0,
65         DBG_REASON_BREAKPOINT = 1,
66         DBG_REASON_WATCHPOINT = 2,
67         DBG_REASON_WPTANDBKPT = 3,
68         DBG_REASON_SINGLESTEP = 4,
69         DBG_REASON_NOTHALTED = 5
70 };
71
72 extern char *target_debug_reason_strings[];
73
74 enum target_endianess
75 {
76         TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
77 };
78
79 extern char *target_endianess_strings[];
80
81 struct target_s;
82
83 typedef struct working_area_s
84 {
85         u32 address;
86         u32 size;
87         int free;
88         u8 *backup;
89         struct working_area_s **user;
90         struct working_area_s *next;
91 } working_area_t;
92
93 typedef struct target_type_s
94 {
95         char *name;
96
97         /* poll current target status */
98         enum target_state (*poll)(struct target_s *target);
99         /* architecture specific status reply */
100         int (*arch_state)(struct target_s *target, char *buf, int buf_size);
101
102         /* target execution control */
103         int (*halt)(struct target_s *target);
104         int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
105         int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
106         
107         /* target reset control */
108         int (*assert_reset)(struct target_s *target);
109         int (*deassert_reset)(struct target_s *target);
110         int (*soft_reset_halt)(struct target_s *target);
111         
112         /* target register access for gdb */
113         int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
114         
115         /* target memory access 
116         * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
117         * count: number of items of <size>
118         */
119         int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
120         int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
121         
122         /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
123         int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
124         
125         /* target break-/watchpoint control 
126         * rw: 0 = write, 1 = read, 2 = access
127         */
128         int (*add_breakpoint)(struct target_s *target, u32 address, u32 length, enum breakpoint_type type);
129         int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
130         int (*add_watchpoint)(struct target_s *target, u32 address, u32 length, enum watchpoint_rw rw);
131         int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
132
133         /* target algorithm support */
134         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);
135         
136         int (*register_commands)(struct command_context_s *cmd_ctx);
137         int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
138         int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
139         int (*quit)(void);
140         
141 } target_type_t;
142
143 typedef struct target_s
144 {
145         target_type_t *type;                            /* target type definition (name, access functions) */
146         enum target_reset_mode reset_mode;      /* what to do after a reset */
147         int run_and_halt_time;                          /* how long the target should run after a run_and_halt reset */
148         char *reset_script;                                     /* script file to initialize the target after a reset */
149         char *post_halt_script;                         /* script file to execute after the target halted */
150         char *pre_resume_script;                        /* script file to execute before the target resumed */
151         u32 working_area;                                       /* working area (initialized RAM) */
152         u32 working_area_size;                          /* size in bytes */
153         u32 backup_working_area;                        /* whether the content of the working area has to be preserved */
154         struct working_area_s *working_areas;/* list of allocated working areas */
155         enum target_debug_reason debug_reason; /* reason why the target entered debug state */
156         enum target_endianess endianness;       /* target endianess */
157         enum target_state state;                        /* the current backend-state (running, halted, ...) */
158         struct reg_cache_s *reg_cache;          /* the first register cache of the target (core regs) */
159         struct breakpoint_s *breakpoints;       /* list of breakpoints */
160         struct watchpoint_s *watchpoints;       /* list of watchpoints */
161         void *arch_info;                                        /* architecture specific information */
162         struct target_s *next;                          /* next target in list */
163 } target_t;
164
165 enum target_event
166 {
167         TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
168         TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
169         TARGET_EVENT_RESET,                     /* target entered reset */
170         TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
171         TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
172 };
173
174 typedef struct target_event_callback_s
175 {
176         int (*callback)(struct target_s *target, enum target_event event, void *priv);
177         void *priv;
178         struct target_event_callback_s *next;
179 } target_event_callback_t;
180
181 typedef struct target_timer_callback_s
182 {
183         int (*callback)(void *priv);
184         int time_ms;
185         int periodic;
186         struct timeval when;
187         void *priv;
188         struct target_timer_callback_s *next;
189 } target_timer_callback_t;
190
191 extern int target_register_commands(struct command_context_s *cmd_ctx);
192 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
193 extern int target_init(struct command_context_s *cmd_ctx);
194 extern int handle_target(void *priv);
195
196 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
197 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
198 extern int target_call_event_callbacks(target_t *target, enum target_event event);
199
200 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
201 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
202 extern int target_call_timer_callbacks();
203
204 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
205 extern int get_num_by_target(target_t *query_target);
206 extern target_t* get_target_by_num(int num);
207
208 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
209 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
210
211 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
212 extern int target_free_working_area(struct target_s *target, working_area_t *area);
213 extern int target_free_all_working_areas(struct target_s *target);
214
215 extern target_t *targets;
216
217 extern target_event_callback_t *target_event_callbacks;
218 extern target_timer_callback_t *target_timer_callbacks;
219
220 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
221 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
222 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
223 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
224
225 void target_read_u32(struct target_s *target, u32 address, u32 *value);
226 void target_read_u16(struct target_s *target, u32 address, u16 *value);
227 void target_read_u8(struct target_s *target, u32 address, u8 *value);
228 void target_write_u32(struct target_s *target, u32 address, u32 value);
229 void target_write_u16(struct target_s *target, u32 address, u16 value);
230 void target_write_u8(struct target_s *target, u32 address, u8 value);
231
232 #define ERROR_TARGET_INVALID    (-300)
233 #define ERROR_TARGET_INIT_FAILED (-301)
234 #define ERROR_TARGET_TIMEOUT    (-302)
235 #define ERROR_TARGET_ALREADY_HALTED (-303)
236 #define ERROR_TARGET_NOT_HALTED (-304)
237 #define ERROR_TARGET_FAILURE    (-305)
238 #define ERROR_TARGET_UNALIGNED_ACCESS   (-306)
239 #define ERROR_TARGET_DATA_ABORT (-307)
240 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE     (-308)
241 #define ERROR_TARGET_TRANSLATION_FAULT  (-309)
242
243 #endif /* TARGET_H */