* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * Copyright (C) 2007,2008 Øyvind Harboe *
+ * Copyright (C) 2007-2010 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2008 by Spencer Oliver *
* 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 <http://www.gnu.org/licenses/>. *
***************************************************************************/
-#ifndef TARGET_TYPE_H
-#define TARGET_TYPE_H
-#include "types.h"
+#ifndef OPENOCD_TARGET_TARGET_TYPE_H
+#define OPENOCD_TARGET_TARGET_TYPE_H
-struct target_s;
+#include <jim-nvp.h>
-struct target_type_s
-{
- /**
- * Name of the target. Do @b not access this field directly, use
- * target_get_name() instead.
- */
- char *name;
+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 {
/**
- * Indicates whether this target has been examined.
- *
- * Do @b not access this field directly, use target_was_examined()
- * target_set_examined(), and target_reset_examined().
+ * Name of this type of target. Do @b not access this
+ * field directly, use target_type_name() instead.
*/
- int examined;
+ const char *name;
+ const char *deprecated_name;
/* poll current target status */
- int (*poll)(struct target_s *target);
+ int (*poll)(struct target *target);
/* Invoked only from target_arch_state().
* Issue USER() w/architecture specific status. */
- int (*arch_state)(struct target_s *target);
+ int (*arch_state)(struct target *target);
/* target request support */
- int (*target_request_data)(struct target_s *target, uint32_t size, uint8_t *buffer);
+ 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_s *target);
- int (*resume)(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
- int (*step)(struct target_s *target, int current, uint32_t address, int handle_breakpoints);
-
+ 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.
*
* the way reset's are configured.
*
*/
- int (*assert_reset)(struct target_s *target);
- int (*deassert_reset)(struct target_s *target);
- int (*soft_reset_halt_imp)(struct target_s *target);
- int (*soft_reset_halt)(struct target_s *target);
+ 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 inbetween 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
* 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_s *target, struct reg_s **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);
/* target memory access
* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
* count: number of items of <size>
*/
- int (*read_memory_imp)(struct target_s *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_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
- int (*write_memory_imp)(struct target_s *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_s *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_s *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);
- int (*checksum_memory)(struct target_s *target, uint32_t address, uint32_t count, uint32_t* checksum);
- int (*blank_check_memory)(struct target_s *target, uint32_t address, uint32_t count, uint32_t* blank);
+ /* 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
* 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.
+ * 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_s *target, breakpoint_t *breakpoint);
+ 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.
+ /* 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_s *target, breakpoint_t *breakpoint);
- int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
- /* remove watchpoint. hw will only be updated if the target is currently halted.
+ 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_s *target, watchpoint_t *watchpoint);
+ 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 */
- int (*run_algorithm_imp)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
/**
* Target algorithm support. Do @b not call this method directly,
* use target_run_algorithm() instead.
*/
- 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, 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);
- int (*register_commands)(struct command_context_s *cmd_ctx);
+ const struct command_registration *commands;
/* called when target is created */
- int (*target_create)(struct target_s *target, Jim_Interp *interp);
+ 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_s *target, Jim_GetOptInfo *goi);
+ int (*target_jim_configure)(struct target *target, Jim_GetOptInfo *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_s *target, Jim_GetOptInfo *goi);
+ int (*target_jim_commands)(struct target *target, Jim_GetOptInfo *goi);
- /* invoked after JTAG chain has been examined & validated. During
- * this stage the target is examined and any additional setup is
- * performed.
+ /**
+ * This method is used to perform target setup that requires
+ * JTAG access.
*
- * invoked every time after the jtag chain has been validated/examined
+ * 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_s *target);
+ 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_s *cmd_ctx, struct target_s *target);
- int (*quit)(void);
+ int (*init_target)(struct command_context *cmd_ctx, struct target *target);
- int (*virt2phys)(struct target_s *target, uint32_t address, uint32_t *physical);
- int (*mmu)(struct target_s *target, int *enabled);
+ /**
+ * Free all the resources allocated by the target.
+ *
+ * @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);
+
+ /* 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);
};
-#endif // TARGET_TYPE_H
+#endif /* OPENOCD_TARGET_TARGET_TYPE_H */
Code Review / openocd.git / blobdiff