duan ellis target tcl work in progress
[fw/openocd] / src / target / target.h
index 05dbbb91cf3674e1dd19f5ecd8e6e1db063190fe..968d7ab8afaeffd21c6a9eeb9b92ddac206960f0 100644 (file)
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
  *   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     *
@@ -52,17 +55,25 @@ enum target_state
        TARGET_DEBUG_RUNNING = 4,
 };
 
-extern char *target_state_strings[];
+extern const Jim_Nvp nvp_target_state[];
+
+enum nvp_assert {
+       NVP_DEASSERT,
+       NVP_ASSERT,
+};
+
+extern const Jim_Nvp nvp_assert[];
 
 enum target_reset_mode
 {
-       RESET_RUN = 0,          /* reset and let target run */
-       RESET_HALT = 1,         /* reset and halt target out of reset */
-       RESET_INIT = 2,         /* reset and halt target out of reset, then run init script */
-       RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
-       RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
+       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
 {
        DBG_REASON_DBGRQ = 0,
@@ -74,14 +85,15 @@ enum target_debug_reason
        DBG_REASON_UNDEFINED = 6
 };
 
-extern char *target_debug_reason_strings[];
+extern const Jim_Nvp nvp_target_debug_reason[];
 
 enum target_endianess
 {
-       TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
+       TARGET_ENDIAN_UNKNOWN=0,
+       TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
 };
 
-extern char *target_endianess_strings[];
+extern const Jim_Nvp nvp_target_endian[];
 
 struct target_s;
 
@@ -161,12 +173,27 @@ typedef struct target_type_s
        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 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 */
@@ -174,6 +201,19 @@ typedef struct target_type_s
        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_jim_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 );
+
+       /* old init function */
        int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
        /* invoked after JTAG chain has been examined & validated. During
         * this stage the target is examined and any additional setup is
@@ -181,7 +221,7 @@ typedef struct target_type_s
         * 
         * invoked every time after the jtag chain has been validated/examined
         */
-       int (*examine)(struct command_context_s *cmd_ctx, struct target_s *target);
+       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
@@ -195,11 +235,20 @@ typedef struct target_type_s
        
 } 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 */
+       int chain_position;                 /* where on the jtag chain is this */
+       const char *variant;                /* what varient of this chip is it? */
+       enum target_reset_mode reset_mode;  /* how should this target be reset */
+       target_event_action_t *event_action;
+
        int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
-       int run_and_halt_time;                          /* how long the target should run after a run_and_halt reset */
        u32 working_area;                                       /* working area (initialized RAM). Evaluated 
                                                                                   upon first allocation from virtual/physical address. */
        u32 working_area_virt;                          /* virtual address */
@@ -222,14 +271,36 @@ typedef struct target_s
 
 enum target_event
 {
-       TARGET_EVENT_HALTED,            /* target entered debug state from normal execution or reset */
-       TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
-       TARGET_EVENT_RESET,                     /* target entered reset */
-       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_GDB_PROGRAM        /* target about to be be programmed by gdb */
+       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,
+
+       TARGET_EVENT_RESET_START,
+       TARGET_EVENT_RESET,                     /* target entered reset */
+       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_GDB_ATTACH,
+       TARGET_EVENT_GDB_DETACH,
+
+       TARGET_EVENT_GDB_FLASH_ERASE_START,
+       TARGET_EVENT_GDB_FLASH_ERASE_END,
+       TARGET_EVENT_GDB_FLASH_WRITE_START,
+       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;
+       target_event_action_t *next;
+ };
+
 typedef struct target_event_callback_s
 {
        int (*callback)(struct target_s *target, enum target_event event, void *priv);
@@ -250,7 +321,7 @@ typedef struct target_timer_callback_s
 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(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);
 
@@ -266,11 +337,11 @@ extern int target_call_event_callbacks(target_t *target, enum target_event event
  */
 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();
+extern 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();
+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);
@@ -299,15 +370,17 @@ extern int target_free_working_area_restore(struct target_s *target, working_are
 extern int target_free_all_working_areas(struct target_s *target);
 extern int target_free_all_working_areas_restore(struct target_s *target, int restore);
 
-extern target_t *targets;
+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 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);
@@ -321,6 +394,7 @@ int target_arch_state(struct target_s *target);
 
 int target_invoke_script(struct command_context_s *cmd_ctx, target_t *target, char *name);
 
+
 #define ERROR_TARGET_INVALID   (-300)
 #define ERROR_TARGET_INIT_FAILED (-301)
 #define ERROR_TARGET_TIMEOUT   (-302)
@@ -331,5 +405,14 @@ int target_invoke_script(struct command_context_s *cmd_ctx, target_t *target, ch
 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE    (-308)
 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
 #define ERROR_TARGET_NOT_RUNNING (-310)
+#define ERROR_TARGET_NOT_EXAMINED (-311)
 
 #endif /* TARGET_H */
+
+
+/*
+ * Local Variables: ***
+ * c-basic-offset: 4 ***
+ * tab-width: 4 ***
+ * End: ***
+ */