]> git.sur5r.net Git - openocd/blobdiff - src/target/target.h
flash: Constify write buffer
[openocd] / src / target / target.h
index b3025dcb575ffbd71c860f7914a0b3b1626c67fe..8e1c8f95da5dac0f8f0542e3276b2cce58a9f99f 100644 (file)
@@ -27,7 +27,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifndef TARGET_H
@@ -41,6 +41,7 @@ struct watchpoint;
 struct mem_param;
 struct reg_param;
 struct target_list;
+struct gdb_fileio_info;
 
 /*
  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
@@ -55,7 +56,6 @@ struct target_list;
  * also see: target_state_name();
  */
 
-
 enum target_state {
        TARGET_UNKNOWN = 0,
        TARGET_RUNNING = 1,
@@ -83,7 +83,8 @@ enum target_debug_reason {
        DBG_REASON_WPTANDBKPT = 3,
        DBG_REASON_SINGLESTEP = 4,
        DBG_REASON_NOTHALTED = 5,
-       DBG_REASON_UNDEFINED = 6
+       DBG_REASON_EXIT = 6,
+       DBG_REASON_UNDEFINED = 7,
 };
 
 enum target_endianness {
@@ -109,14 +110,26 @@ struct gdb_service {
        int32_t core[2];
 };
 
-/* target_type.h contains the full definitionof struct targe_type */
+/* target back off timer */
+struct backoff_timer {
+       int times;
+       int count;
+};
+
+/* split target registers into multiple class */
+enum target_register_class {
+       REG_CLASS_ALL,
+       REG_CLASS_GENERAL,
+};
+
+/* 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? */
+       char *variant;                                          /* what variant of this chip is it? */
 
        /**
         * Indicates whether this target has been examined.
@@ -126,18 +139,19 @@ struct target {
         */
        bool examined;
 
-       /** true iff the  target is currently running a downloaded
-        *  "algorithm" instetad 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.
+       /**
+        * 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.
         */
        bool running_alg;
 
        struct target_event_action *event_action;
 
        int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
-       uint32_t working_area;                          /* working area (initialized RAM). Evaluated
+       uint32_t working_area;                          /* working area (initialised RAM). Evaluated
                                                                                 * upon first allocation from virtual/physical address. */
        bool working_area_virt_spec;            /* virtual address specified? */
        uint32_t working_area_virt;                     /* virtual address */
@@ -166,19 +180,22 @@ struct target {
 
        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. */
+                                                                                * 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 */
-
-       int smp;                                                        /*  add some target attributes for smp support */
+       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 */
+       /* 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;
+
+       /* file-I/O information for host to do syscall */
+       struct gdb_fileio_info *fileio_info;
 };
 
 struct target_list {
@@ -186,6 +203,14 @@ struct target_list {
        struct target_list *next;
 };
 
+struct gdb_fileio_info {
+       char *identifier;
+       uint32_t param_1;
+       uint32_t param_2;
+       uint32_t param_3;
+       uint32_t param_4;
+};
+
 /** Returns the instance-specific name of the specified target. */
 static inline const char *target_name(struct target *target)
 {
@@ -195,12 +220,6 @@ static inline const char *target_name(struct target *target)
 const char *debug_reason_name(struct target *t);
 
 enum target_event {
-       /* 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_resume,
 
        /* allow GDB to do stuff before others handle the halted event,
         * this is in lieu of defining ordering of invocation of events,
@@ -284,6 +303,7 @@ 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
@@ -294,7 +314,7 @@ int target_unregister_event_callback(
  * 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 condtions.
+ * 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,
@@ -308,11 +328,11 @@ int target_call_event_callbacks(struct target *target, enum target_event event);
  */
 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.
+ * a synchronous command completes.
  */
 int target_call_timer_callbacks_now(void);
 
@@ -329,7 +349,7 @@ const char *target_type_name(struct target *target);
 
 /**
  * Examine the specified @a target, letting it perform any
- * initialization that requires JTAG access.
+ * Initialisation that requires JTAG access.
  *
  * This routine is a wrapper for target->type->examine.
  */
@@ -392,13 +412,22 @@ int target_add_watchpoint(struct target *target,
 int target_remove_watchpoint(struct target *target,
                struct watchpoint *watchpoint);
 
+/**
+ * Find out the just hit @a watchpoint for @a target.
+ *
+ * This routine is a wrapper for target->type->hit_watchpoint.
+ */
+int target_hit_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);
+               struct reg **reg_list[], int *reg_list_size,
+               enum target_register_class reg_class);
 
 /**
  * Step the target.
@@ -445,7 +474,7 @@ int target_wait_algorithm(struct target *target,
  *
  */
 int target_run_flash_async_algorithm(struct target *target,
-               uint8_t *buffer, uint32_t count, int block_size,
+               const 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,
@@ -460,6 +489,8 @@ int target_run_flash_async_algorithm(struct target *target,
  */
 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 @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
@@ -479,16 +510,8 @@ int target_read_memory(struct target *target,
  */
 int target_write_memory(struct target *target,
                uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
-
-/**
- * Write @a 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().
- *
- * This routine is wrapper for target->type->bulk_write_memory.
- */
-int target_bulk_write_memory(struct target *target,
-               uint32_t address, 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 to target memory using the virtual address.
@@ -524,6 +547,22 @@ 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);
 
+/**
+ * Obtain file-I/O information from target for GDB to do syscall.
+ *
+ * This routine is a wrapper for target->type->get_gdb_fileio_info.
+ */
+int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
+
+/**
+ * Pass GDB file-I/O response to target after finishing host syscall.
+ *
+ * This routine is a wrapper for target->type->gdb_fileio_end.
+ */
+int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
+
+
+
 /** Return the *name* of this targets current state */
 const char *target_state_name(struct target *target);
 
@@ -544,7 +583,7 @@ int target_alloc_working_area(struct target *target,
  * 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 behavior(slower?).
+ * and have a fallback to another behaviour(slower?).
  */
 int target_alloc_working_area_try(struct target *target,
                uint32_t size, struct working_area **area);
@@ -554,21 +593,27 @@ uint32_t target_get_working_area_avail(struct target *target);
 
 extern struct target *all_targets;
 
+uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
 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_u64(struct target *target, uint8_t *buffer, uint64_t value);
 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_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
 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);
+void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
+void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
+void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
 
+int target_read_u64(struct target *target, uint64_t address, uint64_t *value);
 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_u64(struct target *target, uint64_t address, uint64_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);