reg_t -> struct reg
[fw/openocd] / src / target / target_type.h
index dd69d8c2074709824fc4906aaef98aa6ba6826f7..37e438deea41216b0b1e2093deb5176f17a2cdc4 100644 (file)
@@ -1,3 +1,28 @@
+/***************************************************************************
+ *   Copyright (C) 2005 by Dominic Rath                                    *
+ *   Dominic.Rath@gmx.de                                                   *
+ *                                                                         *
+ *   Copyright (C) 2007,2008,2009 Ã˜yvind Harboe                            *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
+ *   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     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   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.             *
+ ***************************************************************************/
 #ifndef TARGET_TYPE_H
 #define TARGET_TYPE_H
 
@@ -5,7 +30,7 @@
 
 struct target_s;
 
-struct target_type_s
+struct target_type
 {
        /**
         * Name of the target.  Do @b not access this field directly, use
@@ -66,7 +91,7 @@ struct target_type_s
         * list, however it is after GDB is connected that monitor commands can
         * be run to properly initialize the target
         */
-       int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
+       int (*get_gdb_reg_list)(struct target_s *target, struct reg **reg_list[], int *reg_list_size);
 
        /* target memory access
        * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
@@ -106,39 +131,39 @@ struct target_type_s
         *
         * Upon GDB connection all breakpoints/watchpoints are cleared.
         */
-       int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
+       int (*add_breakpoint)(struct target_s *target, struct breakpoint *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);
+       int (*remove_breakpoint)(struct target_s *target, struct breakpoint *breakpoint);
+       int (*add_watchpoint)(struct target_s *target, struct watchpoint *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);
+       int (*remove_watchpoint)(struct target_s *target, struct watchpoint *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, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
+       int (*run_algorithm_imp)(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);
        /**
         * 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, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
+       int (*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);
 
        int (*register_commands)(struct command_context_s *cmd_ctx);
 
        /* called when target is created */
-       int (*target_create)( struct target_s *target, Jim_Interp *interp );
+       int (*target_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 );
+       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 );
+       int (*target_jim_commands)(struct target_s *target, Jim_GetOptInfo *goi);
 
        /* invoked after JTAG chain has been examined & validated. During
         * this stage the target is examined and any additional setup is
@@ -153,11 +178,34 @@ struct target_type_s
         * before the JTAG chain has been examined/verified
         * */
        int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
-       int (*quit)(void);
 
+       /* translate from virtual to physical address. Default implementation is successful
+        * no-op(i.e. virtual==physical).
+        */
        int (*virt2phys)(struct target_s *target, uint32_t address, uint32_t *physical);
+
+       /* read directly from physical memory. caches are bypassed and untouched.
+        *
+        * If the target does not support disabling caches, leaving them untouched,
+        * then minimally the actual physical memory location will be read even
+        * if cache states are unchanged, flushed, etc.
+        *
+        * Default implementation is to call read_memory.
+        */
+       int (*read_phys_memory)(struct target_s *target, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
+
+       /*
+        * same as read_phys_memory, except that it writes...
+        */
+       int (*write_phys_memory)(struct target_s *target, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
+
        int (*mmu)(struct target_s *target, int *enabled);
 
+       /* Read coprocessor - arm specific. Default implementation returns error. */
+       int (*mrc)(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value);
+
+       /* Write coprocessor. Default implementation returns error.  */
+       int (*mcr)(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value);
 };
 
 #endif // TARGET_TYPE_H