fc062dabd6cadd6db587ed3a9c57f8594fd6f99d
[openocd.git] / src / target / target_type.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef TARGET_TYPE_H
27 #define TARGET_TYPE_H
28
29 #include <helper/types.h>
30 #include <jim-nvp.h>
31
32 struct target;
33
34 /**
35 * This holds methods shared between all instances of a given target
36 * type. For example, all Cortex-M3 targets on a scan chain share
37 * the same method table.
38 */
39 struct target_type
40 {
41 /**
42 * Name of this type of target. Do @b not access this
43 * field directly, use target_type_name() instead.
44 */
45 const char *name;
46
47 /* poll current target status */
48 int (*poll)(struct target *target);
49 /* Invoked only from target_arch_state().
50 * Issue USER() w/architecture specific status. */
51 int (*arch_state)(struct target *target);
52
53 /* target request support */
54 int (*target_request_data)(struct target *target, uint32_t size, uint8_t *buffer);
55
56 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
57 int (*halt)(struct target *target);
58 int (*resume)(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
59 int (*step)(struct target *target, int current, uint32_t address, int handle_breakpoints);
60
61 /* target reset control. assert reset can be invoked when OpenOCD and
62 * the target is out of sync.
63 *
64 * A typical example is that the target was power cycled while OpenOCD
65 * thought the target was halted or running.
66 *
67 * assert_reset() can therefore make no assumptions whatsoever about the
68 * state of the target
69 *
70 * Before assert_reset() for the target is invoked, a TRST/tms and
71 * chain validation is executed. TRST should not be asserted
72 * during target assert unless there is no way around it due to
73 * the way reset's are configured.
74 *
75 */
76 int (*assert_reset)(struct target *target);
77 /**
78 * The implementation is responsible for polling the
79 * target such that target->state reflects the
80 * state correctly.
81 *
82 * Otherwise the following would fail, as there will not
83 * be any "poll" invoked inbetween the "reset run" and
84 * "halt".
85 *
86 * reset run; halt
87 */
88 int (*deassert_reset)(struct target *target);
89 int (*soft_reset_halt_imp)(struct target *target);
90 int (*soft_reset_halt)(struct target *target);
91
92 /**
93 * Target register access for GDB. Do @b not call this function
94 * directly, use target_get_gdb_reg_list() instead.
95 *
96 * Danger! this function will succeed even if the target is running
97 * and return a register list with dummy values.
98 *
99 * The reason is that GDB connection will fail without a valid register
100 * list, however it is after GDB is connected that monitor commands can
101 * be run to properly initialize the target
102 */
103 int (*get_gdb_reg_list)(struct target *target, struct reg **reg_list[], int *reg_list_size);
104
105 /* target memory access
106 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
107 * count: number of items of <size>
108 */
109 int (*read_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
110 /**
111 * Target memory read callback. Do @b not call this function
112 * directly, use target_read_memory() instead.
113 */
114 int (*read_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
115 int (*write_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
116 /**
117 * Target memory write callback. Do @b not call this function
118 * directly, use target_write_memory() instead.
119 */
120 int (*write_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
121
122 /* Default implementation will do some fancy alignment to improve performance, target can override */
123 int (*read_buffer)(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer);
124
125 /* Default implementation will do some fancy alignment to improve performance, target can override */
126 int (*write_buffer)(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer);
127
128 /**
129 * Write target memory in multiples of 4 bytes, optimized for
130 * writing large quantities of data. Do @b not call this
131 * function directly, use target_bulk_write_memory() instead.
132 */
133 int (*bulk_write_memory)(struct target *target, uint32_t address, uint32_t count, const uint8_t *buffer);
134
135 int (*checksum_memory)(struct target *target, uint32_t address, uint32_t count, uint32_t* checksum);
136 int (*blank_check_memory)(struct target *target, uint32_t address, uint32_t count, uint32_t* blank);
137
138 /*
139 * target break-/watchpoint control
140 * rw: 0 = write, 1 = read, 2 = access
141 *
142 * Target must be halted while this is invoked as this
143 * will actually set up breakpoints on target.
144 *
145 * The breakpoint hardware will be set up upon adding the
146 * first breakpoint.
147 *
148 * Upon GDB connection all breakpoints/watchpoints are cleared.
149 */
150 int (*add_breakpoint)(struct target *target, struct breakpoint *breakpoint);
151 int (*add_context_breakpoint)(struct target *target, struct breakpoint *breakpoint);
152 int (*add_hybrid_breakpoint)(struct target *target, struct breakpoint *breakpoint);
153
154 /* remove breakpoint. hw will only be updated if the target
155 * is currently halted.
156 * However, this method can be invoked on unresponsive targets.
157 */
158 int (*remove_breakpoint)(struct target *target, struct breakpoint *breakpoint);
159
160 /* add watchpoint ... see add_breakpoint() comment above. */
161 int (*add_watchpoint)(struct target *target, struct watchpoint *watchpoint);
162
163 /* remove watchpoint. hw will only be updated if the target
164 * is currently halted.
165 * However, this method can be invoked on unresponsive targets.
166 */
167 int (*remove_watchpoint)(struct target *target, struct watchpoint *watchpoint);
168
169 /**
170 * Target algorithm support. Do @b not call this method directly,
171 * use target_run_algorithm() instead.
172 */
173 int (*run_algorithm)(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
174
175 const struct command_registration *commands;
176
177 /* called when target is created */
178 int (*target_create)(struct target *target, Jim_Interp *interp);
179
180 /* called for various config parameters */
181 /* returns JIM_CONTINUE - if option not understood */
182 /* otherwise: JIM_OK, or JIM_ERR, */
183 int (*target_jim_configure)(struct target *target, Jim_GetOptInfo *goi);
184
185 /* target commands specifically handled by the target */
186 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
187 int (*target_jim_commands)(struct target *target, Jim_GetOptInfo *goi);
188
189 /**
190 * This method is used to perform target setup that requires
191 * JTAG access.
192 *
193 * This may be called multiple times. It is called after the
194 * scan chain is initially validated, or later after the target
195 * is enabled by a JRC. It may also be called during some
196 * parts of the reset sequence.
197 *
198 * For one-time initialization tasks, use target_was_examined()
199 * and target_set_examined(). For example, probe the hardware
200 * before setting up chip-specific state, and then set that
201 * flag so you don't do that again.
202 */
203 int (*examine)(struct target *target);
204
205 /* Set up structures for target.
206 *
207 * It is illegal to talk to the target at this stage as this fn is invoked
208 * before the JTAG chain has been examined/verified
209 * */
210 int (*init_target)(struct command_context *cmd_ctx, struct target *target);
211
212 /* translate from virtual to physical address. Default implementation is successful
213 * no-op(i.e. virtual==physical).
214 */
215 int (*virt2phys)(struct target *target, uint32_t address, uint32_t *physical);
216
217 /* read directly from physical memory. caches are bypassed and untouched.
218 *
219 * If the target does not support disabling caches, leaving them untouched,
220 * then minimally the actual physical memory location will be read even
221 * if cache states are unchanged, flushed, etc.
222 *
223 * Default implementation is to call read_memory.
224 */
225 int (*read_phys_memory)(struct target *target, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
226
227 /*
228 * same as read_phys_memory, except that it writes...
229 */
230 int (*write_phys_memory)(struct target *target, uint32_t phys_address, uint32_t size, uint32_t count, const uint8_t *buffer);
231
232 int (*mmu)(struct target *target, int *enabled);
233
234 /* after reset is complete, the target can check if things are properly set up.
235 *
236 * This can be used to check if e.g. DCC memory writes have been enabled for
237 * arm7/9 targets, which they really should except in the most contrived
238 * circumstances.
239 */
240 int (*check_reset)(struct target *target);
241 };
242
243 #endif // TARGET_TYPE_H