Add target_run_algorithm wrapper:
[fw/openocd] / src / target / target.h
index c2ca257238f6e977bdab1222f132ac1d6a392672..c319a25b2ea728a3656378918af7cba28be82e32 100644 (file)
 #ifndef TARGET_H
 #define TARGET_H
 
-#include "register.h"
 #include "breakpoints.h"
 #include "algorithm.h"
-#include "trace.h"
-
 #include "command.h"
-#include "types.h"
-
-#include <sys/time.h>
-#include <time.h>
 
 struct reg_s;
+struct trace_s;
 struct command_context_s;
+
 /*
-TARGET_UNKNOWN = 0: we don't know anything about the target yet
-TARGET_RUNNING = 1: the target is executing user code
-TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
-debugger. on an xscale it means that the debug handler is executing
-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)
-*/
+ * TARGET_UNKNOWN = 0: we don't know anything about the target yet
+ * TARGET_RUNNING = 1: the target is executing user code
+ * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
+ * debugger. on an xscale it means that the debug handler is executing
+ * 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) */
+
 enum target_state
 {
        TARGET_UNKNOWN = 0,
@@ -166,8 +161,16 @@ typedef struct target_type_s
        * 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.
+        */
        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);
 
        /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
@@ -201,6 +204,10 @@ typedef struct target_type_s
 
        /* 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);
@@ -228,7 +235,7 @@ typedef struct target_type_s
         *
         * 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);
 
@@ -237,21 +244,21 @@ typedef struct target_type_s
 
 } target_type_t;
 
-// forward decloration
+/* 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 */
-       int chain_position;                 /* where on the jtag chain is this */
-       const char *variant;                /* what varient of this chip is it? */
+       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;
 
        int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
        u32 working_area;                                       /* working area (initialized RAM). Evaluated
-                                                                                  upon first allocation from virtual/physical address. */
+                                                                                * 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 */
@@ -269,27 +276,27 @@ typedef struct target_s
        void *arch_info;                                        /* architecture specific information */
        struct target_s *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. */
+       int display;                                            /* display async info in telnet session. Do not display
+                                                                                * lots of halted/resumed info when stepping in debugger. */
 } target_t;
 
 enum target_event
 {
-       // OLD historical names
-       //  - Prior to the great TCL change
-       //  - June/July/Aug 2008
-       //  - Duane Ellis
+       /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,
 
        /* 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,
-       TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
-       TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
+        * this is in lieu of defining ordering of invocation of events,
+        * which would be more complicated */
+       TARGET_EVENT_EARLY_HALTED,
+       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_RESUME_END,
 
@@ -308,14 +315,12 @@ enum target_event
        TARGET_EVENT_RESET_INIT,
        TARGET_EVENT_RESET_END,
 
-
-       TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
-       TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
+       TARGET_EVENT_DEBUG_HALTED,      /* target entered debug state, but was executing on behalf of the debugger */
+       TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
 
        TARGET_EVENT_EXAMINE_START,
        TARGET_EVENT_EXAMINE_END,
 
-
        TARGET_EVENT_GDB_ATTACH,
        TARGET_EVENT_GDB_DETACH,
 
@@ -325,12 +330,10 @@ enum target_event
        TARGET_EVENT_GDB_FLASH_WRITE_END,
 };
 
-extern const Jim_Nvp nvp_target_event[];
-
 struct target_event_action_s {
        enum target_event event;
        Jim_Obj *body;
-       int      has_percent;
+       int has_percent;
        target_event_action_t *next;
  };
 
@@ -378,7 +381,35 @@ extern int target_call_timer_callbacks_now(void);
 
 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_by_num(int num);
+extern target_t *get_target(const char *id);
+
+/**
+ * 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 timeout_ms, void *arch_info);
+
+/**
+ * Read @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);
+/**
+ * Write @count items of @a size bytes to the memory of @a target at
+ * the @a address given.
+ *
+ * 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);
 
 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);
@@ -408,9 +439,9 @@ 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, u8 *buffer);
-extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
-extern u8  target_buffer_get_u8 (target_t *target, u8 *buffer);
+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);
@@ -428,7 +459,6 @@ int target_arch_state(struct target_s *target);
 void target_handle_event( target_t *t, enum target_event e);
 void target_all_handle_event( enum target_event e );
 
-
 #define ERROR_TARGET_INVALID   (-300)
 #define ERROR_TARGET_INIT_FAILED (-301)
 #define ERROR_TARGET_TIMEOUT   (-302)