1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
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. *
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. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
25 #ifndef OPENOCD_TARGET_TARGET_TYPE_H
26 #define OPENOCD_TARGET_TARGET_TYPE_H
33 * This holds methods shared between all instances of a given target
34 * type. For example, all Cortex-M3 targets on a scan chain share
35 * the same method table.
39 * Name of this type of target. Do @b not access this
40 * field directly, use target_type_name() instead.
43 const char *deprecated_name
;
45 /* poll current target status */
46 int (*poll
)(struct target
*target
);
47 /* Invoked only from target_arch_state().
48 * Issue USER() w/architecture specific status. */
49 int (*arch_state
)(struct target
*target
);
51 /* target request support */
52 int (*target_request_data
)(struct target
*target
, uint32_t size
, uint8_t *buffer
);
54 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
55 int (*halt
)(struct target
*target
);
56 /* See target.c target_resume() for documentation. */
57 int (*resume
)(struct target
*target
, int current
, target_addr_t address
,
58 int handle_breakpoints
, int debug_execution
);
59 int (*step
)(struct target
*target
, int current
, target_addr_t address
,
60 int handle_breakpoints
);
61 /* target reset control. assert reset can be invoked when OpenOCD and
62 * the target is out of sync.
64 * A typical example is that the target was power cycled while OpenOCD
65 * thought the target was halted or running.
67 * assert_reset() can therefore make no assumptions whatsoever about the
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.
76 int (*assert_reset
)(struct target
*target
);
78 * The implementation is responsible for polling the
79 * target such that target->state reflects the
82 * Otherwise the following would fail, as there will not
83 * be any "poll" invoked inbetween the "reset run" and
88 int (*deassert_reset
)(struct target
*target
);
89 int (*soft_reset_halt
)(struct target
*target
);
92 * Target architecture for GDB.
94 * The string returned by this function will not be automatically freed;
95 * if dynamic allocation is used for this value, it must be managed by
96 * the target, ideally by caching the result for subsequent calls.
98 const char *(*get_gdb_arch
)(struct target
*target
);
101 * Target register access for GDB. Do @b not call this function
102 * directly, use target_get_gdb_reg_list() instead.
104 * Danger! this function will succeed even if the target is running
105 * and return a register list with dummy values.
107 * The reason is that GDB connection will fail without a valid register
108 * list, however it is after GDB is connected that monitor commands can
109 * be run to properly initialize the target
111 int (*get_gdb_reg_list
)(struct target
*target
, struct reg
**reg_list
[],
112 int *reg_list_size
, enum target_register_class reg_class
);
115 * Same as get_gdb_reg_list, but doesn't read the register values.
117 int (*get_gdb_reg_list_noread
)(struct target
*target
,
118 struct reg
**reg_list
[], int *reg_list_size
,
119 enum target_register_class reg_class
);
121 /* target memory access
122 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
123 * count: number of items of <size>
127 * Target memory read callback. Do @b not call this function
128 * directly, use target_read_memory() instead.
130 int (*read_memory
)(struct target
*target
, target_addr_t address
,
131 uint32_t size
, uint32_t count
, uint8_t *buffer
);
133 * Target memory write callback. Do @b not call this function
134 * directly, use target_write_memory() instead.
136 int (*write_memory
)(struct target
*target
, target_addr_t address
,
137 uint32_t size
, uint32_t count
, const uint8_t *buffer
);
139 /* Default implementation will do some fancy alignment to improve performance, target can override */
140 int (*read_buffer
)(struct target
*target
, target_addr_t address
,
141 uint32_t size
, uint8_t *buffer
);
143 /* Default implementation will do some fancy alignment to improve performance, target can override */
144 int (*write_buffer
)(struct target
*target
, target_addr_t address
,
145 uint32_t size
, const uint8_t *buffer
);
147 int (*checksum_memory
)(struct target
*target
, target_addr_t address
,
148 uint32_t count
, uint32_t *checksum
);
149 int (*blank_check_memory
)(struct target
*target
,
150 struct target_memory_check_block
*blocks
, int num_blocks
,
151 uint8_t erased_value
);
154 * target break-/watchpoint control
155 * rw: 0 = write, 1 = read, 2 = access
157 * Target must be halted while this is invoked as this
158 * will actually set up breakpoints on target.
160 * The breakpoint hardware will be set up upon adding the
163 * Upon GDB connection all breakpoints/watchpoints are cleared.
165 int (*add_breakpoint
)(struct target
*target
, struct breakpoint
*breakpoint
);
166 int (*add_context_breakpoint
)(struct target
*target
, struct breakpoint
*breakpoint
);
167 int (*add_hybrid_breakpoint
)(struct target
*target
, struct breakpoint
*breakpoint
);
169 /* remove breakpoint. hw will only be updated if the target
170 * is currently halted.
171 * However, this method can be invoked on unresponsive targets.
173 int (*remove_breakpoint
)(struct target
*target
, struct breakpoint
*breakpoint
);
175 /* add watchpoint ... see add_breakpoint() comment above. */
176 int (*add_watchpoint
)(struct target
*target
, struct watchpoint
*watchpoint
);
178 /* remove watchpoint. hw will only be updated if the target
179 * is currently halted.
180 * However, this method can be invoked on unresponsive targets.
182 int (*remove_watchpoint
)(struct target
*target
, struct watchpoint
*watchpoint
);
184 /* Find out just hit watchpoint. After the target hits a watchpoint, the
185 * information could assist gdb to locate where the modified/accessed memory is.
187 int (*hit_watchpoint
)(struct target
*target
, struct watchpoint
**hit_watchpoint
);
190 * Target algorithm support. Do @b not call this method directly,
191 * use target_run_algorithm() instead.
193 int (*run_algorithm
)(struct target
*target
, int num_mem_params
,
194 struct mem_param
*mem_params
, int num_reg_params
,
195 struct reg_param
*reg_param
, target_addr_t entry_point
,
196 target_addr_t exit_point
, int timeout_ms
, void *arch_info
);
197 int (*start_algorithm
)(struct target
*target
, int num_mem_params
,
198 struct mem_param
*mem_params
, int num_reg_params
,
199 struct reg_param
*reg_param
, target_addr_t entry_point
,
200 target_addr_t exit_point
, void *arch_info
);
201 int (*wait_algorithm
)(struct target
*target
, int num_mem_params
,
202 struct mem_param
*mem_params
, int num_reg_params
,
203 struct reg_param
*reg_param
, target_addr_t exit_point
,
204 int timeout_ms
, void *arch_info
);
206 const struct command_registration
*commands
;
208 /* called when target is created */
209 int (*target_create
)(struct target
*target
, Jim_Interp
*interp
);
211 /* called for various config parameters */
212 /* returns JIM_CONTINUE - if option not understood */
213 /* otherwise: JIM_OK, or JIM_ERR, */
214 int (*target_jim_configure
)(struct target
*target
, Jim_GetOptInfo
*goi
);
216 /* target commands specifically handled by the target */
217 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
218 int (*target_jim_commands
)(struct target
*target
, Jim_GetOptInfo
*goi
);
221 * This method is used to perform target setup that requires
224 * This may be called multiple times. It is called after the
225 * scan chain is initially validated, or later after the target
226 * is enabled by a JRC. It may also be called during some
227 * parts of the reset sequence.
229 * For one-time initialization tasks, use target_was_examined()
230 * and target_set_examined(). For example, probe the hardware
231 * before setting up chip-specific state, and then set that
232 * flag so you don't do that again.
234 int (*examine
)(struct target
*target
);
236 /* Set up structures for target.
238 * It is illegal to talk to the target at this stage as this fn is invoked
239 * before the JTAG chain has been examined/verified
241 int (*init_target
)(struct command_context
*cmd_ctx
, struct target
*target
);
244 * Free all the resources allocated by the target.
246 * @param target The target to deinit
248 void (*deinit_target
)(struct target
*target
);
250 /* translate from virtual to physical address. Default implementation is successful
251 * no-op(i.e. virtual==physical).
253 int (*virt2phys
)(struct target
*target
, target_addr_t address
, target_addr_t
*physical
);
255 /* read directly from physical memory. caches are bypassed and untouched.
257 * If the target does not support disabling caches, leaving them untouched,
258 * then minimally the actual physical memory location will be read even
259 * if cache states are unchanged, flushed, etc.
261 * Default implementation is to call read_memory.
263 int (*read_phys_memory
)(struct target
*target
, target_addr_t phys_address
,
264 uint32_t size
, uint32_t count
, uint8_t *buffer
);
267 * same as read_phys_memory, except that it writes...
269 int (*write_phys_memory
)(struct target
*target
, target_addr_t phys_address
,
270 uint32_t size
, uint32_t count
, const uint8_t *buffer
);
272 int (*mmu
)(struct target
*target
, int *enabled
);
274 /* after reset is complete, the target can check if things are properly set up.
276 * This can be used to check if e.g. DCC memory writes have been enabled for
277 * arm7/9 targets, which they really should except in the most contrived
280 int (*check_reset
)(struct target
*target
);
282 /* get GDB file-I/O parameters from target
284 int (*get_gdb_fileio_info
)(struct target
*target
, struct gdb_fileio_info
*fileio_info
);
286 /* pass GDB file-I/O response to target
288 int (*gdb_fileio_end
)(struct target
*target
, int retcode
, int fileio_errno
, bool ctrl_c
);
290 /* do target profiling
292 int (*profiling
)(struct target
*target
, uint32_t *samples
,
293 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
);
295 /* Return the number of address bits this target supports. This will
296 * typically be 32 for 32-bit targets, and 64 for 64-bit targets. If not
297 * implemented, it's assumed to be 32. */
298 unsigned (*address_bits
)(struct target
*target
);
301 #endif /* OPENOCD_TARGET_TARGET_TYPE_H */
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)