* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * Copyright (C) 2007,2008 Øyvind Harboe *
+ * Copyright (C) 2007,2008,2009 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2008 by Spencer Oliver *
#ifndef TARGET_H
#define TARGET_H
+#include <stddef.h>
+
#include "breakpoints.h"
#include "algorithm.h"
#include "command.h"
struct trace_s;
struct command_context_s;
+
+/**
+ * Cast a member of a structure out to the containing structure.
+ * @param ptr The pointer to the member.
+ * @param type The type of the container struct this is embedded in.
+ * @param member The name of the member within the struct.
+ *
+ * This is a mechanism which is used throughout the Linux kernel.
+ */
+#define container_of(ptr, type, member) ({ \
+ const typeof( ((type *)0)->member ) *__mptr = (ptr); \
+ (type *)( (char *)__mptr - offsetof(type,member) );})
+
/*
* TARGET_UNKNOWN = 0: we don't know anything about the target yet
* TARGET_RUNNING = 1: the target is executing user code
struct target_s;
-typedef struct working_area_s
+struct working_area
{
uint32_t address;
uint32_t size;
int free;
uint8_t *backup;
- struct working_area_s **user;
- struct working_area_s *next;
-} working_area_t;
+ struct working_area **user;
+ struct working_area *next;
+};
// target_type.h contains the full definitionof struct target_type_s
struct target_type_s;
target_type_t *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 */
- jtag_tap_t *tap; /* where on the jtag chain is this */
+ struct jtag_tap *tap; /* where on the jtag chain is this */
const char *variant; /* what varient of this chip is it? */
target_event_action_t *event_action;
int reset_halt; /* attempt resetting the CPU into the halted mode? */
uint32_t working_area; /* working area (initialized RAM). Evaluated
* upon first allocation from virtual/physical address. */
- uint32_t working_area_virt; /* virtual address */
- uint32_t working_area_phys; /* physical address */
- uint32_t working_area_size; /* size in bytes */
+ 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_s *working_areas;/* list of allocated working areas */
+ 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 */
// 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 reg_cache *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 watchpoint *watchpoints; /* list of watchpoints */
struct trace_s *trace_info; /* generic trace information */
struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
uint32_t dbg_msg_enabled; /* debug message status */
target_event_action_t *next;
};
-typedef struct target_event_callback_s
+struct target_event_callback
{
int (*callback)(struct target_s *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, uint32_t 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_s *cmd_ctx);
+int target_register_user_commands(struct command_context_s *cmd_ctx);
+int target_init(struct command_context_s *cmd_ctx);
+int target_examine(void);
+int handle_target(void *priv);
+int target_process_reset(struct command_context_s *cmd_ctx,
+ enum target_reset_mode reset_mode);
+
+int target_register_event_callback(
+ int (*callback)(struct target_s *target,
+ enum target_event event, void *priv),
+ void *priv);
+int target_unregister_event_callback(
+ int (*callback)(struct target_s *target,
+ enum target_event event, void *priv),
+ void *priv);
+int target_poll(target_t *target);
+int target_resume(target_t *target, int current, uint32_t address,
+ int handle_breakpoints, int debug_execution);
+int target_halt(target_t *target);
+int target_call_event_callbacks(target_t *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
+int target_register_timer_callback(int (*callback)(void *priv),
+ int time_ms, int periodic, void *priv);
+int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
+
+int target_call_timer_callbacks(void);
+/**
+ * Invoke this to ensure that e.g. polling timer callbacks happen before
* a syncrhonous command completes.
*/
-extern int target_call_timer_callbacks_now(void);
+int target_call_timer_callbacks_now(void);
-extern target_t* get_current_target(struct command_context_s *cmd_ctx);
-extern target_t *get_target(const char *id);
+target_t* get_current_target(struct command_context_s *cmd_ctx);
+target_t *get_target(const char *id);
/**
* Get the target name.
*
* This routine is a wrapper for the target->type->name field.
*/
-extern const char *target_get_name(struct target_s *target);
+const char *target_get_name(struct target_s *target);
/**
* Examine the specified @a target.
*
* This routine is a wrapper for target->type->examine.
*/
-extern int target_examine_one(struct target_s *target);
+int target_examine_one(struct target_s *target);
/// @returns @c true if the target has been examined.
-extern bool target_was_examined(struct target_s *target);
+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);
+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);
+void target_reset_examined(struct target_s *target);
/**
*
* This routine is a wrapper for target->type->add_breakpoint.
*/
-extern int target_add_breakpoint(struct target_s *target,
+int target_add_breakpoint(struct target_s *target,
struct breakpoint_s *breakpoint);
/**
* Remove the @a breakpoint for @a target.
*
* This routine is a wrapper for target->type->remove_breakpoint.
*/
-extern int target_remove_breakpoint(struct target_s *target,
+int target_remove_breakpoint(struct target_s *target,
struct breakpoint_s *breakpoint);
/**
* Add the @a watchpoint for @a target.
*
* This routine is a wrapper for target->type->add_watchpoint.
*/
-extern int target_add_watchpoint(struct target_s *target,
- struct watchpoint_s *watchpoint);
+int target_add_watchpoint(struct target_s *target,
+ struct watchpoint *watchpoint);
/**
* Remove the @a watchpoint for @a target.
*
* This routine is a wrapper for target->type->remove_watchpoint.
*/
-extern int target_remove_watchpoint(struct target_s *target,
- struct watchpoint_s *watchpoint);
+int target_remove_watchpoint(struct target_s *target,
+ struct watchpoint *watchpoint);
/**
* Obtain the registers for GDB.
*
* This routine is a wrapper for target->type->get_gdb_reg_list.
*/
-extern int target_get_gdb_reg_list(struct target_s *target,
+int target_get_gdb_reg_list(struct target_s *target,
struct reg_s **reg_list[], int *reg_list_size);
/**
*
* 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,
+int target_run_algorithm(struct target_s *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);
*
* This routine is a wrapper for target->type->read_memory.
*/
-extern int target_read_memory(struct target_s *target,
+int target_read_memory(struct target_s *target,
uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
/**
* Write @a count items of @a size bytes to the memory of @a target at
*
* This routine is wrapper for target->type->write_memory.
*/
-extern int target_write_memory(struct target_s *target,
+int target_write_memory(struct target_s *target,
uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
/**
*
* This routine is wrapper for target->type->bulk_write_memory.
*/
-extern int target_bulk_write_memory(struct target_s *target,
+int target_bulk_write_memory(struct target_s *target,
uint32_t address, uint32_t count, uint8_t *buffer);
-extern int target_write_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
-extern int target_read_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
-extern int target_checksum_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* crc);
-extern int target_blank_check_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* blank);
-extern int target_wait_state(target_t *target, enum target_state state, int ms);
+/*
+ * 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.
+ *
+ * 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.
+ */
+int target_write_buffer(struct target_s *target,
+ uint32_t address, uint32_t size, uint8_t *buffer);
+int target_read_buffer(struct target_s *target,
+ uint32_t address, uint32_t size, uint8_t *buffer);
+int target_checksum_memory(struct target_s *target,
+ uint32_t address, uint32_t size, uint32_t* crc);
+int target_blank_check_memory(struct target_s *target,
+ uint32_t address, uint32_t size, uint32_t* blank);
+int target_wait_state(target_t *target, enum target_state state, int ms);
/** Return the *name* of this targets current state */
const char *target_state_name( target_t *target );
* upon resuming or resetting the CPU.
*
*/
-extern int target_alloc_working_area(struct target_s *target, uint32_t 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);
+int target_alloc_working_area(struct target_s *target,
+ uint32_t size, struct working_area **area);
+int target_free_working_area(struct target_s *target, struct working_area *area);
+int target_free_working_area_restore(struct target_s *target,
+ struct working_area *area, int restore);
+void target_free_all_working_areas(struct target_s *target);
+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 struct target_event_callback *target_event_callbacks;
+extern struct target_timer_callback *target_timer_callbacks;
-extern uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer);
-extern uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer);
-extern uint8_t target_buffer_get_u8 (target_t *target, const uint8_t *buffer);
-extern void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value);
-extern void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value);
-extern void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t value);
+uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer);
+uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer);
+uint8_t target_buffer_get_u8 (target_t *target, const uint8_t *buffer);
+void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value);
+void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value);
+void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t value);
int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value);
int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value);
#define ERROR_TARGET_NOT_EXAMINED (-311)
extern const Jim_Nvp nvp_error_target[];
-extern const char *target_strerror_safe(int err);
+
+const char *target_strerror_safe(int err);
#endif /* TARGET_H */
Code Review / openocd.git / blobdiff