X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Ftarget%2Ftarget_type.h;h=a26c2e7d875a7145041b9ba3c5ffe343ea4d8520;hb=d74f11dcd43914702ea7b011c4bbb7da8d4a2f5c;hp=10fcd4fd28592f2f430900bf34256c1562984cb5;hpb=3e71449adec41bf2a9f498d027aae0ba6e83721f;p=openocd.git
diff --git a/src/target/target_type.h b/src/target/target_type.h
index 10fcd4fd28..a26c2e7d87 100644
--- a/src/target/target_type.h
+++ b/src/target/target_type.h
@@ -19,14 +19,13 @@
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see . *
***************************************************************************/
-#ifndef TARGET_TYPE_H
-#define TARGET_TYPE_H
-#include
+#ifndef OPENOCD_TARGET_TARGET_TYPE_H
+#define OPENOCD_TARGET_TARGET_TYPE_H
+
+#include
struct target;
@@ -35,13 +34,12 @@ struct target;
* type. For example, all Cortex-M3 targets on a scan chain share
* the same method table.
*/
-struct target_type
-{
+struct target_type {
/**
* Name of this type of target. Do @b not access this
* field directly, use target_type_name() instead.
*/
- char *name;
+ const char *name;
/* poll current target status */
int (*poll)(struct target *target);
@@ -54,9 +52,11 @@ struct target_type
/* halt will log a warning, but return ERROR_OK if the target is already halted. */
int (*halt)(struct target *target);
- int (*resume)(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
- int (*step)(struct target *target, int current, uint32_t address, int handle_breakpoints);
-
+ /* 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.
*
@@ -79,15 +79,23 @@ struct target_type
* state correctly.
*
* Otherwise the following would fail, as there will not
- * be any "poll" invoked inbetween the "reset run" and
+ * be any "poll" invoked between the "reset run" and
* "halt".
*
* reset run; halt
- */
+ */
int (*deassert_reset)(struct target *target);
- int (*soft_reset_halt_imp)(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.
@@ -99,34 +107,47 @@ struct target_type
* 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);
+ 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
*/
- int (*read_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+
/**
* Target memory read callback. Do @b not call this function
* directly, use target_read_memory() instead.
*/
- int (*read_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
- int (*write_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+ 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, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+ int (*write_memory)(struct target *target, target_addr_t address,
+ uint32_t size, uint32_t count, const uint8_t *buffer);
- /**
- * Write target memory in multiples of 4 bytes, optimized for
- * writing large quantities of data. Do @b not call this
- * function directly, use target_bulk_write_memory() instead.
- */
- int (*bulk_write_memory)(struct target *target, uint32_t address, uint32_t count, 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, uint32_t address, uint32_t count, uint32_t* checksum);
- int (*blank_check_memory)(struct target *target, uint32_t address, uint32_t count, uint32_t* blank);
+ 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
@@ -141,6 +162,8 @@ struct target_type
* 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.
@@ -157,11 +180,27 @@ struct target_type
*/
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, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
+ 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;
@@ -171,11 +210,11 @@ struct target_type
/* 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, Jim_GetOptInfo *goi);
+ 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, Jim_GetOptInfo *goi);
+ int (*target_jim_commands)(struct target *target, struct jim_getopt_info *goi);
/**
* This method is used to perform target setup that requires
@@ -200,10 +239,28 @@ struct target_type
* */
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, uint32_t address, uint32_t *physical);
+ int (*virt2phys)(struct target *target, target_addr_t address, target_addr_t *physical);
/* read directly from physical memory. caches are bypassed and untouched.
*
@@ -213,12 +270,14 @@ struct target_type
*
* Default implementation is to call read_memory.
*/
- int (*read_phys_memory)(struct target *target, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
+ 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, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
+ 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);
@@ -229,6 +288,29 @@ struct target_type
* 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);
+
+ /* 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);
};
-#endif // TARGET_TYPE_H
+#endif /* OPENOCD_TARGET_TARGET_TYPE_H */