Duane Ellis: fix warnings
[fw/openocd] / src / target / target.h
index e028665043909984b886197ca093693b8d0b80b3..2551ede7ba07cfaeb896d070495cd8d397a63fcf 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     *
@@ -54,21 +57,11 @@ enum target_state
 
 extern char *target_state_strings[];
 
-enum daemon_startup_mode
-{
-       DAEMON_ATTACH,          /* simply attach to the target */
-       DAEMON_RESET,           /* reset target (behaviour defined by reset_mode */
-};
-
-extern enum daemon_startup_mode startup_mode;
-
 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 */
 };
 
 enum target_debug_reason
@@ -106,6 +99,8 @@ typedef struct working_area_s
 typedef struct target_type_s
 {
        char *name;
+       
+       int examined;
 
        /* poll current target status */
        int (*poll)(struct target_s *target);
@@ -121,11 +116,25 @@ typedef struct target_type_s
        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);
        
-       /* target reset control */
+       /* 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);
-       int (*prepare_reset_halt)(struct target_s *target);
        
        /* target register access for gdb.
         * 
@@ -142,13 +151,16 @@ typedef struct target_type_s
        * 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);
        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);
        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 */
        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
@@ -159,10 +171,23 @@ typedef struct target_type_s
        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);
        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);
        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
+        * 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);
        
@@ -174,15 +199,9 @@ typedef struct target_type_s
 typedef struct target_s
 {
        target_type_t *type;                            /* target type definition (name, access functions) */
-       enum target_reset_mode reset_mode;      /* what to do after a reset */
-       int run_and_halt_time;                          /* how long the target should run after a run_and_halt reset */
-       char *reset_script;                                     /* script file to initialize the target after a reset */
-       char *post_halt_script;                         /* script file to execute after the target halted */
-       char *pre_resume_script;                        /* script file to execute before the target resumed */
-       char *gdb_program_script;                       /* script file to execute before programming vis gdb */
+       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 */
@@ -231,17 +250,27 @@ 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_init_reset(struct command_context_s *cmd_ctx);
+extern int target_examine();
 extern int handle_target(void *priv);
-extern int target_process_reset(struct command_context_s *cmd_ctx);
+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 
+ * 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();
+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(void);
 
 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
 extern int get_num_by_target(target_t *query_target);
@@ -250,10 +279,25 @@ extern target_t* get_target_by_num(int num);
 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);
+
+/* DANGER!!!!!
+ * 
+ * if "area" passed in to target_alloc_working_area() points to a memory
+ * location that goes out of scope (e.g. a pointer on the stack), then
+ * the caller of target_alloc_working_area() is responsible for invoking
+ * target_free_working_area() before "area" goes out of scope.
+ * 
+ * target_free_all_working_areas() will NULL out the "area" pointer
+ * 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 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;
 
@@ -275,6 +319,8 @@ int target_write_u8(struct target_s *target, u32 address, u8 value);
 /* Issues USER() statements with target state information */
 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)
@@ -284,5 +330,6 @@ int target_arch_state(struct target_s *target);
 #define ERROR_TARGET_DATA_ABORT        (-307)
 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE    (-308)
 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
+#define ERROR_TARGET_NOT_RUNNING (-310)
 
 #endif /* TARGET_H */