1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
/***************************************************************************
* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
* Copyright (C) 2007-2010 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2008 by Spencer Oliver *
* spen@spen-soft.co.uk *
***************************************************************************/
#ifndef OPENOCD_TARGET_TARGET_TYPE_H
#define OPENOCD_TARGET_TARGET_TYPE_H
#include <helper/jim-nvp.h>
struct target;
/**
* This holds methods shared between all instances of a given target
* type. For example, all Cortex-M3 targets on a scan chain share
* the same method table.
*/
struct target_type {
/**
* Name of this type of target. Do @b not access this
* field directly, use target_type_name() instead.
*/
const char *name;
/* poll current target status */
int (*poll)(struct target *target);
/* Invoked only from target_arch_state().
* Issue USER() w/architecture specific status. */
int (*arch_state)(struct target *target);
/* target request support */
int (*target_request_data)(struct target *target, uint32_t size, uint8_t *buffer);
/* halt will log a warning, but return ERROR_OK if the target is already halted. */
int (*halt)(struct target *target);
/* See target.c target_resume() for documentation. */
int (*resume)(struct target *target, int current, target_addr_t address,
int handle_breakpoints, int debug_execution);
int (*step)(struct target *target, int current, target_addr_t address,
int handle_breakpoints);
/* target reset control. assert reset can be invoked when OpenOCD and
* the target is out of sync.
*
* A typical example is that the target was power cycled while OpenOCD
* thought the target was halted or running.
*
* assert_reset() can therefore make no assumptions whatsoever about the
* state of the target
*
* Before assert_reset() for the target is invoked, a TRST/tms and
* chain validation is executed. TRST should not be asserted
* during target assert unless there is no way around it due to
* the way reset's are configured.
*
*/
int (*assert_reset)(struct target *target);
/**
* The implementation is responsible for polling the
* target such that target->state reflects the
* state correctly.
*
* Otherwise the following would fail, as there will not
* be any "poll" invoked between the "reset run" and
* "halt".
*
* reset run; halt
*/
int (*deassert_reset)(struct target *target);
int (*soft_reset_halt)(struct target *target);
/**
* Target architecture for GDB.
*
* The string returned by this function will not be automatically freed;
* if dynamic allocation is used for this value, it must be managed by
* the target, ideally by caching the result for subsequent calls.
*/
const char *(*get_gdb_arch)(struct target *target);
/**
* Target register access for GDB. Do @b not call this function
* directly, use target_get_gdb_reg_list() instead.
*
* Danger! this function will succeed even if the target is running
* and return a register list with dummy values.
*
* The reason is that GDB connection will fail without a valid register
* list, however it is after GDB is connected that monitor commands can
* be run to properly initialize the target
*/
int (*get_gdb_reg_list)(struct target *target, struct reg **reg_list[],
int *reg_list_size, enum target_register_class reg_class);
/**
* Same as get_gdb_reg_list, but doesn't read the register values.
* */
int (*get_gdb_reg_list_noread)(struct target *target,
struct reg **reg_list[], int *reg_list_size,
enum target_register_class reg_class);
/* target memory access
* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
* count: number of items of <size>
*/
/**
* Target memory read callback. Do @b not call this function
* directly, use target_read_memory() instead.
*/
int (*read_memory)(struct target *target, target_addr_t address,
uint32_t size, uint32_t count, uint8_t *buffer);
/**
* Target memory write callback. Do @b not call this function
* directly, use target_write_memory() instead.
*/
int (*write_memory)(struct target *target, target_addr_t address,
uint32_t size, uint32_t count, const uint8_t *buffer);
/* Default implementation will do some fancy alignment to improve performance, target can override */
int (*read_buffer)(struct target *target, target_addr_t address,
uint32_t size, uint8_t *buffer);
/* Default implementation will do some fancy alignment to improve performance, target can override */
int (*write_buffer)(struct target *target, target_addr_t address,
uint32_t size, const uint8_t *buffer);
int (*checksum_memory)(struct target *target, target_addr_t address,
uint32_t count, uint32_t *checksum);
int (*blank_check_memory)(struct target *target,
struct target_memory_check_block *blocks, int num_blocks,
uint8_t erased_value);
/*
* target break-/watchpoint control
* rw: 0 = write, 1 = read, 2 = access
*
* Target must be halted while this is invoked as this
* will actually set up breakpoints on target.
*
* The breakpoint hardware will be set up upon adding the
* first breakpoint.
*
* Upon GDB connection all breakpoints/watchpoints are cleared.
*/
int (*add_breakpoint)(struct target *target, struct breakpoint *breakpoint);
int (*add_context_breakpoint)(struct target *target, struct breakpoint *breakpoint);
int (*add_hybrid_breakpoint)(struct target *target, struct breakpoint *breakpoint);
/* remove breakpoint. hw will only be updated if the target
* is currently halted.
* However, this method can be invoked on unresponsive targets.
*/
int (*remove_breakpoint)(struct target *target, struct breakpoint *breakpoint);
/* add watchpoint ... see add_breakpoint() comment above. */
int (*add_watchpoint)(struct target *target, struct watchpoint *watchpoint);
/* remove watchpoint. hw will only be updated if the target
* is currently halted.
* However, this method can be invoked on unresponsive targets.
*/
int (*remove_watchpoint)(struct target *target, struct watchpoint *watchpoint);
/* Find out just hit watchpoint. After the target hits a watchpoint, the
* information could assist gdb to locate where the modified/accessed memory is.
*/
int (*hit_watchpoint)(struct target *target, struct watchpoint **hit_watchpoint);
/**
* Target algorithm support. Do @b not call this method directly,
* use target_run_algorithm() instead.
*/
int (*run_algorithm)(struct target *target, int num_mem_params,
struct mem_param *mem_params, int num_reg_params,
struct reg_param *reg_param, target_addr_t entry_point,
target_addr_t exit_point, int timeout_ms, void *arch_info);
int (*start_algorithm)(struct target *target, int num_mem_params,
struct mem_param *mem_params, int num_reg_params,
struct reg_param *reg_param, target_addr_t entry_point,
target_addr_t exit_point, void *arch_info);
int (*wait_algorithm)(struct target *target, int num_mem_params,
struct mem_param *mem_params, int num_reg_params,
struct reg_param *reg_param, target_addr_t exit_point,
int timeout_ms, void *arch_info);
const struct command_registration *commands;
/* called when target is created */
int (*target_create)(struct target *target, Jim_Interp *interp);
/* called for various config parameters */
/* returns JIM_CONTINUE - if option not understood */
/* otherwise: JIM_OK, or JIM_ERR, */
int (*target_jim_configure)(struct target *target, struct jim_getopt_info *goi);
/* target commands specifically handled by the target */
/* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
int (*target_jim_commands)(struct target *target, struct jim_getopt_info *goi);
/**
* This method is used to perform target setup that requires
* JTAG access.
*
* This may be called multiple times. It is called after the
* scan chain is initially validated, or later after the target
* is enabled by a JRC. It may also be called during some
* parts of the reset sequence.
*
* For one-time initialization tasks, use target_was_examined()
* and target_set_examined(). For example, probe the hardware
* before setting up chip-specific state, and then set that
* flag so you don't do that again.
*/
int (*examine)(struct target *target);
/* Set up structures for target.
*
* It is illegal to talk to the target at this stage as this fn is invoked
* before the JTAG chain has been examined/verified
* */
int (*init_target)(struct command_context *cmd_ctx, struct target *target);
/**
* Free all the resources allocated by the target.
*
* WARNING: deinit_target is called unconditionally regardless the target has
* ever been examined/initialised or not.
* If a problem has prevented establishing JTAG/SWD/... communication
* or
* if the target was created with -defer-examine flag and has never been
* examined
* then it is not possible to communicate with the target.
*
* If you need to talk to the target during deinit, first check if
* target_was_examined()!
*
* @param target The target to deinit
*/
void (*deinit_target)(struct target *target);
/* translate from virtual to physical address. Default implementation is successful
* no-op(i.e. virtual==physical).
*/
int (*virt2phys)(struct target *target, target_addr_t address, target_addr_t *physical);
/* read directly from physical memory. caches are bypassed and untouched.
*
* If the target does not support disabling caches, leaving them untouched,
* then minimally the actual physical memory location will be read even
* if cache states are unchanged, flushed, etc.
*
* Default implementation is to call read_memory.
*/
int (*read_phys_memory)(struct target *target, target_addr_t phys_address,
uint32_t size, uint32_t count, uint8_t *buffer);
/*
* same as read_phys_memory, except that it writes...
*/
int (*write_phys_memory)(struct target *target, target_addr_t phys_address,
uint32_t size, uint32_t count, const uint8_t *buffer);
int (*mmu)(struct target *target, int *enabled);
/* after reset is complete, the target can check if things are properly set up.
*
* This can be used to check if e.g. DCC memory writes have been enabled for
* arm7/9 targets, which they really should except in the most contrived
* circumstances.
*/
int (*check_reset)(struct target *target);
/* get GDB file-I/O parameters from target
*/
int (*get_gdb_fileio_info)(struct target *target, struct gdb_fileio_info *fileio_info);
/* pass GDB file-I/O response to target
*/
int (*gdb_fileio_end)(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
/* Parse target-specific GDB query commands.
* The string pointer "response_p" is always assigned by the called function
* to a pointer to a NULL-terminated string, even when the function returns
* an error. The string memory is not freed by the caller, so this function
* must pay attention for possible memory leaks if the string memory is
* dynamically allocated.
*/
int (*gdb_query_custom)(struct target *target, const char *packet, char **response_p);
/* do target profiling
*/
int (*profiling)(struct target *target, uint32_t *samples,
uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds);
/* Return the number of address bits this target supports. This will
* typically be 32 for 32-bit targets, and 64 for 64-bit targets. If not
* implemented, it's assumed to be 32. */
unsigned (*address_bits)(struct target *target);
/* Return the number of system bus data bits this target supports. This
* will typically be 32 for 32-bit targets, and 64 for 64-bit targets. If
* not implemented, it's assumed to be 32. */
unsigned int (*data_bits)(struct target *target);
};
extern struct target_type aarch64_target;
extern struct target_type arcv2_target;
extern struct target_type arm11_target;
extern struct target_type arm720t_target;
extern struct target_type arm7tdmi_target;
extern struct target_type arm920t_target;
extern struct target_type arm926ejs_target;
extern struct target_type arm946e_target;
extern struct target_type arm966e_target;
extern struct target_type arm9tdmi_target;
extern struct target_type armv8r_target;
extern struct target_type avr32_ap7k_target;
extern struct target_type avr_target;
extern struct target_type cortexa_target;
extern struct target_type cortexm_target;
extern struct target_type cortexr4_target;
extern struct target_type dragonite_target;
extern struct target_type dsp563xx_target;
extern struct target_type dsp5680xx_target;
extern struct target_type esirisc_target;
extern struct target_type esp32s2_target;
extern struct target_type esp32s3_target;
extern struct target_type esp32_target;
extern struct target_type fa526_target;
extern struct target_type feroceon_target;
extern struct target_type hla_target;
extern struct target_type ls1_sap_target;
extern struct target_type mem_ap_target;
extern struct target_type mips_m4k_target;
extern struct target_type mips_mips64_target;
extern struct target_type or1k_target;
extern struct target_type quark_d20xx_target;
extern struct target_type quark_x10xx_target;
extern struct target_type riscv_target;
extern struct target_type stm8_target;
extern struct target_type testee_target;
extern struct target_type xscale_target;
extern struct target_type xtensa_chip_target;
#endif /* OPENOCD_TARGET_TARGET_TYPE_H */
|