* 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 *
* spen@spen-soft.co.uk *
* *
+ * Copyright (C) 2011 by Broadcom Corporation *
+ * Evan Hunter - ehunter@broadcom.com *
+ * *
+ * Copyright (C) ST-Ericsson SA 2011 *
+ * michel.jaouen@stericsson.com : smp minimum support *
+ * *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
+
#ifndef TARGET_H
#define TARGET_H
-#include "breakpoints.h"
-#include "algorithm.h"
-#include "command.h"
-
-struct reg_s;
-struct trace_s;
-struct command_context_s;
+struct reg;
+struct trace;
+struct command_context;
+struct breakpoint;
+struct watchpoint;
+struct mem_param;
+struct reg_param;
+struct target_list;
/*
* TARGET_UNKNOWN = 0: we don't know anything about the target yet
* TARGET_RESET = 3: the target is being held in reset (only a temporary state,
* not sure how this is used with all the recent changes)
* TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
- * behalf of the debugger (e.g. algorithm for flashing) */
+ * behalf of the debugger (e.g. algorithm for flashing)
+ *
+ * also see: target_state_name();
+ */
-enum target_state
-{
+enum target_state {
TARGET_UNKNOWN = 0,
TARGET_RUNNING = 1,
TARGET_HALTED = 2,
TARGET_DEBUG_RUNNING = 4,
};
-extern const Jim_Nvp nvp_target_state[];
-
enum nvp_assert {
NVP_DEASSERT,
NVP_ASSERT,
};
-extern const Jim_Nvp nvp_assert[];
-
-enum target_reset_mode
-{
+enum target_reset_mode {
RESET_UNKNOWN = 0,
RESET_RUN = 1, /* reset and let target run */
RESET_HALT = 2, /* reset and halt target out of reset */
RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
};
-extern const Jim_Nvp nvp_reset_mode[];
-
-enum target_debug_reason
-{
+enum target_debug_reason {
DBG_REASON_DBGRQ = 0,
DBG_REASON_BREAKPOINT = 1,
DBG_REASON_WATCHPOINT = 2,
DBG_REASON_UNDEFINED = 6
};
-extern const Jim_Nvp nvp_target_debug_reason[];
-
-enum target_endianess
-{
- TARGET_ENDIAN_UNKNOWN=0,
+enum target_endianness {
+ TARGET_ENDIAN_UNKNOWN = 0,
TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
};
-extern const Jim_Nvp nvp_target_endian[];
+struct working_area {
+ uint32_t address;
+ uint32_t size;
+ bool free;
+ uint8_t *backup;
+ struct working_area **user;
+ struct working_area *next;
+};
-struct target_s;
+struct gdb_service {
+ struct target *target;
+ /* field for smp display */
+ /* element 0 coreid currently displayed ( 1 till n) */
+ /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
+ * all cores core displayed */
+ int32_t core[2];
+};
-typedef struct working_area_s
-{
- u32 address;
- u32 size;
- int free;
- u8 *backup;
- struct working_area_s **user;
- struct working_area_s *next;
-} working_area_t;
-
-typedef struct target_type_s
-{
- char *name;
+/* target back off timer */
+struct backoff_timer {
+ int times;
+ int count;
+};
+
+/* target_type.h contains the full definition of struct target_type */
+struct target {
+ struct target_type *type; /* target type definition (name, access functions) */
+ const char *cmd_name; /* tcl Name of target */
+ int target_number; /* DO NOT USE! field to be removed in 2010 */
+ struct jtag_tap *tap; /* where on the jtag chain is this */
+ int32_t coreid; /* which device on the TAP? */
+ const char *variant; /* what variant of this chip is it? */
/**
* 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().
+ * or target_set_examined().
*/
- int examined;
-
- /* poll current target status */
- int (*poll)(struct target_s *target);
- /* Invoked only from target_arch_state().
- * Issue USER() w/architecture specific status. */
- int (*arch_state)(struct target_s *target);
-
- /* target request support */
- int (*target_request_data)(struct target_s *target, u32 size, u8 *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, u32 address, int handle_breakpoints, int debug_execution);
- int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
+ bool examined;
- /* 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_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);
-
- /* target register access for gdb.
- *
- * 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_s *target, struct reg_s **reg_list[], int *reg_list_size);
-
- /* 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, u32 address, u32 size, u32 count, u8 *buffer);
/**
- * Target memory read callback. Do @b not call this function
- * directly, use target_read_memory() instead.
+ * true if the target is currently running a downloaded
+ * "algorithm" instead of arbitrary user code. OpenOCD code
+ * invoking algorithms is trusted to maintain correctness of
+ * any cached state (e.g. for flash status), which arbitrary
+ * code will have no reason to know about.
*/
- int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
- int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
- /**
- * Target memory write callback. Do @b not call this function
- * directly, use target_write_memory() instead.
- */
- int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
+ bool running_alg;
- /**
- * 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, u32 address, u32 count, u8 *buffer);
-
- int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
- int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
-
- /*
- * 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_s *target, breakpoint_t *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_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.
- * However, this method can be invoked on unresponsive targets.
- */
- int (*remove_watchpoint)(struct target_s *target, watchpoint_t *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, u32 entry_point, u32 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, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
-
- int (*register_commands)(struct command_context_s *cmd_ctx);
-
- /* called when target is created */
- int (*target_create)( struct target_s *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 );
-
- /* 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 );
-
- /* invoked after JTAG chain has been examined & validated. During
- * this stage the target is examined and any additional setup is
- * performed.
- *
- * invoked every time after the jtag chain has been validated/examined
- */
- int (*examine)(struct target_s *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 (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
- int (*mmu)(struct target_s *target, int *enabled);
-
-} target_type_t;
-
-/* forward decloration */
-typedef struct target_event_action_s target_event_action_t;
-
-typedef struct target_s
-{
- target_type_t *type; /* target type definition (name, access functions) */
- const char *cmd_name; /* tcl Name of target */
- int target_number; /* generaly, target index but may not be in order */
- jtag_tap_t *tap; /* where on the jtag chain is this */
- const char *variant; /* what varient of this chip is it? */
- target_event_action_t *event_action;
+ struct target_event_action *event_action;
int reset_halt; /* attempt resetting the CPU into the halted mode? */
- u32 working_area; /* working area (initialized RAM). Evaluated
+ uint32_t working_area; /* working area (initialised RAM). Evaluated
* upon first allocation from virtual/physical address. */
- u32 working_area_virt; /* virtual address */
- u32 working_area_phys; /* physical address */
- u32 working_area_size; /* size in bytes */
- u32 backup_working_area; /* whether the content of the working area has to be preserved */
- struct working_area_s *working_areas;/* list of allocated working areas */
+ bool working_area_virt_spec; /* virtual address specified? */
+ uint32_t working_area_virt; /* virtual address */
+ bool working_area_phys_spec; /* virtual address specified? */
+ uint32_t working_area_phys; /* physical address */
+ uint32_t working_area_size; /* size in bytes */
+ uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
+ struct working_area *working_areas;/* list of allocated working areas */
enum target_debug_reason debug_reason;/* reason why the target entered debug state */
- enum target_endianess endianness; /* target endianess */
+ enum target_endianness endianness; /* target endianness */
+ /* also see: target_state_name() */
enum target_state state; /* the current backend-state (running, halted, ...) */
- struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
- struct breakpoint_s *breakpoints; /* list of breakpoints */
- struct watchpoint_s *watchpoints; /* list of watchpoints */
- struct trace_s *trace_info; /* generic trace information */
- struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
- u32 dbg_msg_enabled; /* debug message status */
+ struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
+ struct breakpoint *breakpoints; /* list of breakpoints */
+ struct watchpoint *watchpoints; /* list of watchpoints */
+ struct trace *trace_info; /* generic trace information */
+ struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
+ uint32_t dbg_msg_enabled; /* debug message status */
void *arch_info; /* architecture specific information */
- struct target_s *next; /* next target in list */
+ struct target *next; /* next target in list */
int display; /* display async info in telnet session. Do not display
* lots of halted/resumed info when stepping in debugger. */
-} target_t;
+ bool halt_issued; /* did we transition to halted state? */
+ long long halt_issued_time; /* Note time when halt was issued */
+
+ bool dbgbase_set; /* By default the debug base is not set */
+ uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
+ * system in place to support target specific options
+ * currently. */
+ struct rtos *rtos; /* Instance of Real Time Operating System support */
+ bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
+ * and must be detected when symbols are offered */
+ struct backoff_timer backoff;
+ int smp; /* add some target attributes for smp support */
+ struct target_list *head;
+ /* the gdb service is there in case of smp, we have only one gdb server
+ * for all smp target
+ * the target attached to the gdb is changing dynamically by changing
+ * gdb_service->target pointer */
+ struct gdb_service *gdb_service;
+};
+
+struct target_list {
+ struct target *target;
+ struct target_list *next;
+};
-enum target_event
+/** Returns the instance-specific name of the specified target. */
+static inline const char *target_name(struct target *target)
{
- /* LD historical names
- * - Prior to the great TCL change
- * - June/July/Aug 2008
- * - Duane Ellis */
- TARGET_EVENT_OLD_gdb_program_config,
- TARGET_EVENT_OLD_pre_reset,
- TARGET_EVENT_OLD_post_reset,
- TARGET_EVENT_OLD_pre_resume,
+ return target->cmd_name;
+}
+
+const char *debug_reason_name(struct target *t);
+
+enum target_event {
/* allow GDB to do stuff before others handle the halted event,
* this is in lieu of defining ordering of invocation of events,
- * which would be more complicated */
- TARGET_EVENT_EARLY_HALTED,
+ * which would be more complicated
+ *
+ * Telling GDB to halt does not mean that the target stopped running,
+ * simply that we're dropping out of GDB's waiting for step or continue.
+ *
+ * This can be useful when e.g. detecting power dropout.
+ */
+ TARGET_EVENT_GDB_HALT,
TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
TARGET_EVENT_RESUMED, /* target resumed to normal execution */
TARGET_EVENT_RESUME_START,
TARGET_EVENT_RESET_START,
TARGET_EVENT_RESET_ASSERT_PRE,
+ TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
TARGET_EVENT_RESET_ASSERT_POST,
TARGET_EVENT_RESET_DEASSERT_PRE,
TARGET_EVENT_RESET_DEASSERT_POST,
TARGET_EVENT_GDB_FLASH_WRITE_END,
};
-struct target_event_action_s {
+struct target_event_action {
enum target_event event;
- Jim_Obj *body;
+ struct Jim_Interp *interp;
+ struct Jim_Obj *body;
int has_percent;
- target_event_action_t *next;
- };
+ struct target_event_action *next;
+};
-typedef struct target_event_callback_s
-{
- int (*callback)(struct target_s *target, enum target_event event, void *priv);
+bool target_has_event_action(struct target *target, enum target_event event);
+
+struct target_event_callback {
+ int (*callback)(struct target *target, enum target_event event, void *priv);
void *priv;
- struct target_event_callback_s *next;
-} target_event_callback_t;
+ struct target_event_callback *next;
+};
-typedef struct target_timer_callback_s
-{
+struct target_timer_callback {
int (*callback)(void *priv);
int time_ms;
int periodic;
struct timeval when;
void *priv;
- struct target_timer_callback_s *next;
-} target_timer_callback_t;
-
-extern int target_register_commands(struct command_context_s *cmd_ctx);
-extern int target_register_user_commands(struct command_context_s *cmd_ctx);
-extern int target_init(struct command_context_s *cmd_ctx);
-extern int target_examine(void);
-extern int handle_target(void *priv);
-extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
-
-extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
-extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
-extern int target_poll(target_t *target);
-extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
-extern int target_halt(target_t *target);
-extern int target_call_event_callbacks(target_t *target, enum target_event event);
-
-/* The period is very approximate, the callback can happen much more often
+ struct target_timer_callback *next;
+};
+
+int target_register_commands(struct command_context *cmd_ctx);
+int target_examine(void);
+
+int target_register_event_callback(
+ int (*callback)(struct target *target,
+ enum target_event event, void *priv),
+ void *priv);
+int target_unregister_event_callback(
+ int (*callback)(struct target *target,
+ enum target_event event, void *priv),
+ void *priv);
+
+/* Poll the status of the target, detect any error conditions and report them.
+ *
+ * Also note that this fn will clear such error conditions, so a subsequent
+ * invocation will then succeed.
+ *
+ * These error conditions can be "sticky" error conditions. E.g. writing
+ * to memory could be implemented as an open loop and if memory writes
+ * fails, then a note is made of it, the error is sticky, but the memory
+ * write loop still runs to completion. This improves performance in the
+ * normal case as there is no need to verify that every single write succeed,
+ * yet it is possible to detect error conditions.
+ */
+int target_poll(struct target *target);
+int target_resume(struct target *target, int current, uint32_t address,
+ int handle_breakpoints, int debug_execution);
+int target_halt(struct target *target);
+int target_call_event_callbacks(struct target *target, enum target_event event);
+
+/**
+ * The period is very approximate, the callback can happen much more often
* or much more rarely than specified
*/
-extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
-extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
-extern int target_call_timer_callbacks(void);
-/* invoke this to ensure that e.g. polling timer callbacks happen before
- * a syncrhonous command completes.
+int target_register_timer_callback(int (*callback)(void *priv),
+ int time_ms, int periodic, void *priv);
+
+int target_call_timer_callbacks(void);
+/**
+ * Invoke this to ensure that e.g. polling timer callbacks happen before
+ * a synchronous command completes.
+ */
+int target_call_timer_callbacks_now(void);
+
+struct target *get_current_target(struct command_context *cmd_ctx);
+struct target *get_target(const char *id);
+
+/**
+ * Get the target type name.
+ *
+ * This routine is a wrapper for the target->type->name field.
+ * Note that this is not an instance-specific name for his target.
+ */
+const char *target_type_name(struct target *target);
+
+/**
+ * Examine the specified @a target, letting it perform any
+ * Initialisation that requires JTAG access.
+ *
+ * This routine is a wrapper for target->type->examine.
*/
-extern int target_call_timer_callbacks_now(void);
+int target_examine_one(struct target *target);
-extern target_t* get_current_target(struct command_context_s *cmd_ctx);
-extern int get_num_by_target(target_t *query_target);
-extern target_t *get_target(const char *id);
+/** @returns @c true if target_set_examined() has been called. */
+static inline bool target_was_examined(struct target *target)
+{
+ return target->examined;
+}
-/// @returns @c true if the target has been examined.
-extern bool target_was_examined(struct target_s *target);
-/// Sets the @c examined flag for the given target.
-extern void target_set_examined(struct target_s *target);
-/// Reset the @c examined flag for the given target.
-extern void target_reset_examined(struct target_s *target);
+/** Sets the @c examined flag for the given target. */
+/** Use in target->type->examine() after one-time setup is done. */
+static inline void target_set_examined(struct target *target)
+{
+ target->examined = true;
+}
+/**
+ * Add the @a breakpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->add_breakpoint.
+ */
+int target_add_breakpoint(struct target *target,
+ struct breakpoint *breakpoint);
+/**
+ * Add the @a ContextID breakpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->add_context_breakpoint.
+ */
+int target_add_context_breakpoint(struct target *target,
+ struct breakpoint *breakpoint);
+/**
+ * Add the @a ContextID & IVA breakpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->add_hybrid_breakpoint.
+ */
+int target_add_hybrid_breakpoint(struct target *target,
+ struct breakpoint *breakpoint);
+/**
+ * Remove the @a breakpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->remove_breakpoint.
+ */
+
+int target_remove_breakpoint(struct target *target,
+ struct breakpoint *breakpoint);
+/**
+ * Add the @a watchpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->add_watchpoint.
+ */
+int target_add_watchpoint(struct target *target,
+ struct watchpoint *watchpoint);
+/**
+ * Remove the @a watchpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->remove_watchpoint.
+ */
+int target_remove_watchpoint(struct target *target,
+ struct watchpoint *watchpoint);
+
+/**
+ * Obtain the registers for GDB.
+ *
+ * This routine is a wrapper for target->type->get_gdb_reg_list.
+ */
+int target_get_gdb_reg_list(struct target *target,
+ struct reg **reg_list[], int *reg_list_size);
+
+/**
+ * Step the target.
+ *
+ * This routine is a wrapper for target->type->step.
+ */
+int target_step(struct target *target,
+ int current, uint32_t address, int handle_breakpoints);
/**
* Run an algorithm on the @a target given.
*
* This routine is a wrapper for target->type->run_algorithm.
*/
-extern int target_run_algorithm(struct target_s *target,
- int num_mem_params, mem_param_t *mem_params,
- int num_reg_params, reg_param_t *reg_param,
- u32 entry_point, u32 exit_point,
+int target_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);
/**
- * Read @count items of @a size bytes from the memory of @a target at
+ * Starts an algorithm in the background on the @a target given.
+ *
+ * This routine is a wrapper for target->type->start_algorithm.
+ */
+int target_start_algorithm(struct target *target,
+ int num_mem_params, struct mem_param *mem_params,
+ int num_reg_params, struct reg_param *reg_params,
+ uint32_t entry_point, uint32_t exit_point,
+ void *arch_info);
+
+/**
+ * Wait for an algorithm on the @a target given.
+ *
+ * This routine is a wrapper for target->type->wait_algorithm.
+ */
+int target_wait_algorithm(struct target *target,
+ int num_mem_params, struct mem_param *mem_params,
+ int num_reg_params, struct reg_param *reg_params,
+ uint32_t exit_point, int timeout_ms,
+ void *arch_info);
+
+/**
+ * This routine is a wrapper for asynchronous algorithms.
+ *
+ */
+int target_run_flash_async_algorithm(struct target *target,
+ uint8_t *buffer, uint32_t count, int block_size,
+ int num_mem_params, struct mem_param *mem_params,
+ int num_reg_params, struct reg_param *reg_params,
+ uint32_t buffer_start, uint32_t buffer_size,
+ uint32_t entry_point, uint32_t exit_point,
+ void *arch_info);
+
+/**
+ * Read @a count items of @a size bytes from the memory of @a target at
* the @a address given.
*
* This routine is a wrapper for target->type->read_memory.
*/
-extern int target_read_memory(struct target_s *target,
- u32 address, u32 size, u32 count, u8 *buffer);
+int target_read_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+int target_read_phys_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
/**
- * Write @count items of @a size bytes to the memory of @a target at
- * the @a address given.
+ * Write @a count items of @a size bytes to the memory of @a target at
+ * the @a address given. @a address must be aligned to @a size
+ * in target memory.
+ *
+ * The endianness is the same in the host and target memory for this
+ * function.
+ *
+ * \todo TODO:
+ * Really @a buffer should have been defined as "const void *" and
+ * @a buffer should have been aligned to @a size in the host memory.
+ *
+ * This is not enforced via e.g. assert's today and e.g. the
+ * target_write_buffer fn breaks this assumption.
*
* This routine is wrapper for target->type->write_memory.
*/
-extern int target_write_memory(struct target_s *target,
- u32 address, u32 size, u32 count, u8 *buffer);
+int target_write_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
+int target_write_phys_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
-/**
- * Write @count items of 4 bytes to the memory of @a target at
- * the @a address given. Because it operates only on whole words,
- * this should be faster than target_write_memory().
+/*
+ * Write to target memory using the virtual address.
+ *
+ * Note that this fn is used to implement software breakpoints. Targets
+ * can implement support for software breakpoints to memory marked as read
+ * only by making this fn write to ram even if it is read only(MMU or
+ * MPUs).
+ *
+ * It is sufficient to implement for writing a single word(16 or 32 in
+ * ARM32/16 bit case) to write the breakpoint to ram.
*
- * This routine is wrapper for target->type->bulk_write_memory.
+ * The target should also take care of "other things" to make sure that
+ * software breakpoints can be written using this function. E.g.
+ * when there is a separate instruction and data cache, this fn must
+ * make sure that the instruction cache is synced up to the potential
+ * code change that can happen as a result of the memory write(typically
+ * by invalidating the cache).
+ *
+ * The high level wrapper fn in target.c will break down this memory write
+ * request to multiple write requests to the target driver to e.g. guarantee
+ * that writing 4 bytes to an aligned address happens with a single 32 bit
+ * write operation, thus making this fn suitable to e.g. write to special
+ * peripheral registers which do not support byte operations.
*/
-extern int target_bulk_write_memory(struct target_s *target,
- u32 address, u32 count, u8 *buffer);
-
-extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
-extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
-extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
-extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
-extern int target_wait_state(target_t *target, enum target_state state, int ms);
+int target_write_buffer(struct target *target,
+ uint32_t address, uint32_t size, const uint8_t *buffer);
+int target_read_buffer(struct target *target,
+ uint32_t address, uint32_t size, uint8_t *buffer);
+int target_checksum_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t *crc);
+int target_blank_check_memory(struct target *target,
+ uint32_t address, uint32_t size, uint32_t *blank);
+int target_wait_state(struct target *target, enum target_state state, int ms);
+
+/** Return the *name* of this targets current state */
+const char *target_state_name(struct target *target);
/* DANGER!!!!!
*
* upon resuming or resetting the CPU.
*
*/
-extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
-extern int target_free_working_area(struct target_s *target, working_area_t *area);
-extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
-extern void target_free_all_working_areas(struct target_s *target);
-extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
-
-extern target_t *all_targets;
-
-extern target_event_callback_t *target_event_callbacks;
-extern target_timer_callback_t *target_timer_callbacks;
-
-extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
-extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
-extern u8 target_buffer_get_u8 (target_t *target, const u8 *buffer);
-extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
-extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
-extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value);
-
-int target_read_u32(struct target_s *target, u32 address, u32 *value);
-int target_read_u16(struct target_s *target, u32 address, u16 *value);
-int target_read_u8(struct target_s *target, u32 address, u8 *value);
-int target_write_u32(struct target_s *target, u32 address, u32 value);
-int target_write_u16(struct target_s *target, u32 address, u16 value);
-int target_write_u8(struct target_s *target, u32 address, u8 value);
+int target_alloc_working_area(struct target *target,
+ uint32_t size, struct working_area **area);
+/* Same as target_alloc_working_area, except that no error is logged
+ * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
+ *
+ * This allows the calling code to *try* to allocate target memory
+ * and have a fallback to another behaviour(slower?).
+ */
+int target_alloc_working_area_try(struct target *target,
+ uint32_t size, struct working_area **area);
+int target_free_working_area(struct target *target, struct working_area *area);
+void target_free_all_working_areas(struct target *target);
+uint32_t target_get_working_area_avail(struct target *target);
+
+extern struct target *all_targets;
+
+uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
+uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
+uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
+void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
+void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
+void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
+
+void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
+void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
+void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf);
+void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf);
+
+int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
+int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
+int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
+int target_write_u32(struct target *target, uint32_t address, uint32_t value);
+int target_write_u16(struct target *target, uint32_t address, uint16_t value);
+int target_write_u8(struct target *target, uint32_t address, uint8_t value);
/* Issues USER() statements with target state information */
-int target_arch_state(struct target_s *target);
+int target_arch_state(struct target *target);
-void target_handle_event( target_t *t, enum target_event e);
-void target_all_handle_event( enum target_event e );
+void target_handle_event(struct target *t, enum target_event e);
#define ERROR_TARGET_INVALID (-300)
#define ERROR_TARGET_INIT_FAILED (-301)
#define ERROR_TARGET_NOT_RUNNING (-310)
#define ERROR_TARGET_NOT_EXAMINED (-311)
-extern const Jim_Nvp nvp_error_target[];
-extern const char *target_strerror_safe( int err );
+extern bool get_target_reset_nag(void);
#endif /* TARGET_H */
Code Review / openocd.git / blobdiff