src/target/target_type.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  23  ***************************************************************************/
  24
  25 #ifndef OPENOCD_TARGET_TARGET_TYPE_H
  26 #define OPENOCD_TARGET_TARGET_TYPE_H
  27
  28 #include <helper/jim-nvp.h>
  29
  30 struct target;
  31
  32 /**
  33  * This holds methods shared between all instances of a given target
  34  * type.  For example, all Cortex-M3 targets on a scan chain share
  35  * the same method table.
  36  */
  37 struct target_type {
  38         /**
  39          * Name of this type of target.  Do @b not access this
  40          * field directly, use target_type_name() instead.
  41          */
  42         const char *name;
  43
  44         /* poll current target status */
  45         int (*poll)(struct target *target);
  46         /* Invoked only from target_arch_state().
  47          * Issue USER() w/architecture specific status.  */
  48         int (*arch_state)(struct target *target);
  49
  50         /* target request support */
  51         int (*target_request_data)(struct target *target, uint32_t size, uint8_t *buffer);
  52
  53         /* halt will log a warning, but return ERROR_OK if the target is already halted. */
  54         int (*halt)(struct target *target);
  55         /* See target.c target_resume() for documentation. */
  56         int (*resume)(struct target *target, int current, target_addr_t address,
  57                         int handle_breakpoints, int debug_execution);
  58         int (*step)(struct target *target, int current, target_addr_t address,
  59                         int handle_breakpoints);
  60         /* target reset control. assert reset can be invoked when OpenOCD and
  61          * the target is out of sync.
  62          *
  63          * A typical example is that the target was power cycled while OpenOCD
  64          * thought the target was halted or running.
  65          *
  66          * assert_reset() can therefore make no assumptions whatsoever about the
  67          * state of the target
  68          *
  69          * Before assert_reset() for the target is invoked, a TRST/tms and
  70          * chain validation is executed. TRST should not be asserted
  71          * during target assert unless there is no way around it due to
  72          * the way reset's are configured.
  73          *
  74          */
  75         int (*assert_reset)(struct target *target);
  76         /**
  77          * The implementation is responsible for polling the
  78          * target such that target->state reflects the
  79          * state correctly.
  80          *
  81          * Otherwise the following would fail, as there will not
  82          * be any "poll" invoked between the "reset run" and
  83          * "halt".
  84          *
  85          * reset run; halt
  86          */
  87         int (*deassert_reset)(struct target *target);
  88         int (*soft_reset_halt)(struct target *target);
  89
  90         /**
  91          * Target architecture for GDB.
  92          *
  93          * The string returned by this function will not be automatically freed;
  94          * if dynamic allocation is used for this value, it must be managed by
  95          * the target, ideally by caching the result for subsequent calls.
  96          */
  97         const char *(*get_gdb_arch)(struct target *target);
  98
  99         /**
 100          * Target register access for GDB.  Do @b not call this function
 101          * directly, use target_get_gdb_reg_list() instead.
 102          *
 103          * Danger! this function will succeed even if the target is running
 104          * and return a register list with dummy values.
 105          *
 106          * The reason is that GDB connection will fail without a valid register
 107          * list, however it is after GDB is connected that monitor commands can
 108          * be run to properly initialize the target
 109          */
 110         int (*get_gdb_reg_list)(struct target *target, struct reg **reg_list[],
 111                         int *reg_list_size, enum target_register_class reg_class);
 112
 113         /**
 114          * Same as get_gdb_reg_list, but doesn't read the register values.
 115          * */
 116         int (*get_gdb_reg_list_noread)(struct target *target,
 117                         struct reg **reg_list[], int *reg_list_size,
 118                         enum target_register_class reg_class);
 119
 120         /* target memory access
 121         * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
 122         * count: number of items of <size>
 123         */
 124
 125         /**
 126          * Target memory read callback.  Do @b not call this function
 127          * directly, use target_read_memory() instead.
 128          */
 129         int (*read_memory)(struct target *target, target_addr_t address,
 130                         uint32_t size, uint32_t count, uint8_t *buffer);
 131         /**
 132          * Target memory write callback.  Do @b not call this function
 133          * directly, use target_write_memory() instead.
 134          */
 135         int (*write_memory)(struct target *target, target_addr_t address,
 136                         uint32_t size, uint32_t count, const uint8_t *buffer);
 137
 138         /* Default implementation will do some fancy alignment to improve performance, target can override */
 139         int (*read_buffer)(struct target *target, target_addr_t address,
 140                         uint32_t size, uint8_t *buffer);
 141
 142         /* Default implementation will do some fancy alignment to improve performance, target can override */
 143         int (*write_buffer)(struct target *target, target_addr_t address,
 144                         uint32_t size, const uint8_t *buffer);
 145
 146         int (*checksum_memory)(struct target *target, target_addr_t address,
 147                         uint32_t count, uint32_t *checksum);
 148         int (*blank_check_memory)(struct target *target,
 149                         struct target_memory_check_block *blocks, int num_blocks,
 150                         uint8_t erased_value);
 151
 152         /*
 153          * target break-/watchpoint control
 154          * rw: 0 = write, 1 = read, 2 = access
 155          *
 156          * Target must be halted while this is invoked as this
 157          * will actually set up breakpoints on target.
 158          *
 159          * The breakpoint hardware will be set up upon adding the
 160          * first breakpoint.
 161          *
 162          * Upon GDB connection all breakpoints/watchpoints are cleared.
 163          */
 164         int (*add_breakpoint)(struct target *target, struct breakpoint *breakpoint);
 165         int (*add_context_breakpoint)(struct target *target, struct breakpoint *breakpoint);
 166         int (*add_hybrid_breakpoint)(struct target *target, struct breakpoint *breakpoint);
 167
 168         /* remove breakpoint. hw will only be updated if the target
 169          * is currently halted.
 170          * However, this method can be invoked on unresponsive targets.
 171          */
 172         int (*remove_breakpoint)(struct target *target, struct breakpoint *breakpoint);
 173
 174         /* add watchpoint ... see add_breakpoint() comment above. */
 175         int (*add_watchpoint)(struct target *target, struct watchpoint *watchpoint);
 176
 177         /* remove watchpoint. hw will only be updated if the target
 178          * is currently halted.
 179          * However, this method can be invoked on unresponsive targets.
 180          */
 181         int (*remove_watchpoint)(struct target *target, struct watchpoint *watchpoint);
 182
 183         /* Find out just hit watchpoint. After the target hits a watchpoint, the
 184          * information could assist gdb to locate where the modified/accessed memory is.
 185          */
 186         int (*hit_watchpoint)(struct target *target, struct watchpoint **hit_watchpoint);
 187
 188         /**
 189          * Target algorithm support.  Do @b not call this method directly,
 190          * use target_run_algorithm() instead.
 191          */
 192         int (*run_algorithm)(struct target *target, int num_mem_params,
 193                         struct mem_param *mem_params, int num_reg_params,
 194                         struct reg_param *reg_param, target_addr_t entry_point,
 195                         target_addr_t exit_point, int timeout_ms, void *arch_info);
 196         int (*start_algorithm)(struct target *target, int num_mem_params,
 197                         struct mem_param *mem_params, int num_reg_params,
 198                         struct reg_param *reg_param, target_addr_t entry_point,
 199                         target_addr_t exit_point, void *arch_info);
 200         int (*wait_algorithm)(struct target *target, int num_mem_params,
 201                         struct mem_param *mem_params, int num_reg_params,
 202                         struct reg_param *reg_param, target_addr_t exit_point,
 203                         int timeout_ms, void *arch_info);
 204
 205         const struct command_registration *commands;
 206
 207         /* called when target is created */
 208         int (*target_create)(struct target *target, Jim_Interp *interp);
 209
 210         /* called for various config parameters */
 211         /* returns JIM_CONTINUE - if option not understood */
 212         /* otherwise: JIM_OK, or JIM_ERR, */
 213         int (*target_jim_configure)(struct target *target, struct jim_getopt_info *goi);
 214
 215         /* target commands specifically handled by the target */
 216         /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
 217         int (*target_jim_commands)(struct target *target, struct jim_getopt_info *goi);
 218
 219         /**
 220          * This method is used to perform target setup that requires
 221          * JTAG access.
 222          *
 223          * This may be called multiple times.  It is called after the
 224          * scan chain is initially validated, or later after the target
 225          * is enabled by a JRC.  It may also be called during some
 226          * parts of the reset sequence.
 227          *
 228          * For one-time initialization tasks, use target_was_examined()
 229          * and target_set_examined().  For example, probe the hardware
 230          * before setting up chip-specific state, and then set that
 231          * flag so you don't do that again.
 232          */
 233         int (*examine)(struct target *target);
 234
 235         /* Set up structures for target.
 236          *
 237          * It is illegal to talk to the target at this stage as this fn is invoked
 238          * before the JTAG chain has been examined/verified
 239          * */
 240         int (*init_target)(struct command_context *cmd_ctx, struct target *target);
 241
 242         /**
 243          * Free all the resources allocated by the target.
 244          *
 245          * @param target The target to deinit
 246          */
 247         void (*deinit_target)(struct target *target);
 248
 249         /* translate from virtual to physical address. Default implementation is successful
 250          * no-op(i.e. virtual==physical).
 251          */
 252         int (*virt2phys)(struct target *target, target_addr_t address, target_addr_t *physical);
 253
 254         /* read directly from physical memory. caches are bypassed and untouched.
 255          *
 256          * If the target does not support disabling caches, leaving them untouched,
 257          * then minimally the actual physical memory location will be read even
 258          * if cache states are unchanged, flushed, etc.
 259          *
 260          * Default implementation is to call read_memory.
 261          */
 262         int (*read_phys_memory)(struct target *target, target_addr_t phys_address,
 263                         uint32_t size, uint32_t count, uint8_t *buffer);
 264
 265         /*
 266          * same as read_phys_memory, except that it writes...
 267          */
 268         int (*write_phys_memory)(struct target *target, target_addr_t phys_address,
 269                         uint32_t size, uint32_t count, const uint8_t *buffer);
 270
 271         int (*mmu)(struct target *target, int *enabled);
 272
 273         /* after reset is complete, the target can check if things are properly set up.
 274          *
 275          * This can be used to check if e.g. DCC memory writes have been enabled for
 276          * arm7/9 targets, which they really should except in the most contrived
 277          * circumstances.
 278          */
 279         int (*check_reset)(struct target *target);
 280
 281         /* get GDB file-I/O parameters from target
 282          */
 283         int (*get_gdb_fileio_info)(struct target *target, struct gdb_fileio_info *fileio_info);
 284
 285         /* pass GDB file-I/O response to target
 286          */
 287         int (*gdb_fileio_end)(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
 288
 289         /* do target profiling
 290          */
 291         int (*profiling)(struct target *target, uint32_t *samples,
 292                         uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds);
 293
 294         /* Return the number of address bits this target supports. This will
 295          * typically be 32 for 32-bit targets, and 64 for 64-bit targets. If not
 296          * implemented, it's assumed to be 32. */
 297         unsigned (*address_bits)(struct target *target);
 298
 299         /* Return the number of system bus data bits this target supports. This
 300          * will typically be 32 for 32-bit targets, and 64 for 64-bit targets. If
 301          * not implemented, it's assumed to be 32. */
 302         unsigned int (*data_bits)(struct target *target);
 303 };
 304
 305 #endif /* OPENOCD_TARGET_TARGET_TYPE_H */