1 /***************************************************************************
2 * Copyright (C) 2008 digenius technology GmbH. *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
18 ***************************************************************************/
24 #include "embeddedice.h"
28 #define asizeof(x) (sizeof(x) / sizeof((x)[0]))
30 #define NEW(type, variable, items) \
31 type * variable = malloc(sizeof(type) * items)
34 #define ARM11_REGCACHE_MODEREGS 0
35 #define ARM11_REGCACHE_FREGS 0
37 #define ARM11_REGCACHE_COUNT (20 + \
38 23 * ARM11_REGCACHE_MODEREGS + \
39 9 * ARM11_REGCACHE_FREGS)
42 typedef struct arm11_register_history_s
46 }arm11_register_history_t;
48 enum arm11_debug_version
50 ARM11_DEBUG_V6 = 0x01,
51 ARM11_DEBUG_V61 = 0x02,
52 ARM11_DEBUG_V7 = 0x03,
53 ARM11_DEBUG_V7_CP14 = 0x04,
56 typedef struct arm11_common_s
62 /** \name Processor type detection */
65 u32 device_id; /**< IDCODE readout */
66 u32 didr; /**< DIDR readout (debug capabilities) */
67 u8 implementor; /**< DIDR Implementor readout */
69 size_t brp; /**< Number of Breakpoint Register Pairs from DIDR */
70 size_t wrp; /**< Number of Watchpoint Register Pairs from DIDR */
72 enum arm11_debug_version
73 debug_version; /**< ARM debug architecture from DIDR */
77 u32 last_dscr; /**< Last retrieved DSCR value;
78 * Can be used to detect changes */
83 /** \name Shadow registers to save processor state */
86 reg_t * reg_list; /**< target register list */
87 u32 reg_values[ARM11_REGCACHE_COUNT]; /**< data for registers */
91 arm11_register_history_t
92 reg_history[ARM11_REGCACHE_COUNT]; /**< register state before last resume */
95 size_t free_brps; /**< keep track of breakpoints allocated by arm11_add_breakpoint() */
96 size_t free_wrps; /**< keep track of breakpoints allocated by arm11_add_watchpoint() */
102 * ARM11 DBGTAP instructions
104 * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
106 enum arm11_instructions
110 ARM11_RESTART = 0x04,
120 ARM11_DSCR_CORE_HALTED = 1 << 0,
121 ARM11_DSCR_CORE_RESTARTED = 1 << 1,
123 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK = 0x0F << 2,
124 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT = 0x00 << 2,
125 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT = 0x01 << 2,
126 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT = 0x02 << 2,
127 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION = 0x03 << 2,
128 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ = 0x04 << 2,
129 ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH = 0x05 << 2,
131 ARM11_DSCR_STICKY_PRECISE_DATA_ABORT = 1 << 6,
132 ARM11_DSCR_STICKY_IMPRECISE_DATA_ABORT = 1 << 7,
133 ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE = 1 << 13,
134 ARM11_DSCR_MODE_SELECT = 1 << 14,
135 ARM11_DSCR_WDTR_FULL = 1 << 29,
136 ARM11_DSCR_RDTR_FULL = 1 << 30,
141 ARM11_CPSR_T = 1 << 5,
142 ARM11_CPSR_J = 1 << 24,
153 ARM11_SC7_WCR0 = 112,
158 typedef struct arm11_reg_state_s
167 /* poll current target status */
168 int arm11_poll(struct target_s *target);
169 /* architecture specific status reply */
170 int arm11_arch_state(struct target_s *target);
172 /* target request support */
173 int arm11_target_request_data(struct target_s *target, u32 size, u8 *buffer);
175 /* target execution control */
176 int arm11_halt(struct target_s *target);
177 int arm11_resume(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
178 int arm11_step(struct target_s *target, int current, u32 address, int handle_breakpoints);
180 /* target reset control */
181 int arm11_assert_reset(struct target_s *target);
182 int arm11_deassert_reset(struct target_s *target);
183 int arm11_soft_reset_halt(struct target_s *target);
184 int arm11_prepare_reset_halt(struct target_s *target);
186 /* target register access for gdb */
187 int arm11_get_gdb_reg_list(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
189 /* target memory access
190 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
191 * count: number of items of <size>
193 int arm11_read_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
194 int arm11_write_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
196 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
197 int arm11_bulk_write_memory(struct target_s *target, u32 address, u32 count, u8 *buffer);
199 int arm11_checksum_memory(struct target_s *target, u32 address, u32 count, u32* checksum);
201 /* target break-/watchpoint control
202 * rw: 0 = write, 1 = read, 2 = access
204 int arm11_add_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
205 int arm11_remove_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
206 int arm11_add_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
207 int arm11_remove_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
209 /* target algorithm support */
210 int arm11_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);
212 int arm11_register_commands(struct command_context_s *cmd_ctx);
213 int arm11_target_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
214 int arm11_init_target(struct command_context_s *cmd_ctx, struct target_s *target);
215 int arm11_quit(void);
219 void arm11_build_reg_cache(target_t *target);
221 void arm11_record_register_history(arm11_common_t * arm11);
222 void arm11_dump_reg_changes(arm11_common_t * arm11);
227 void arm11_setup_field (arm11_common_t * arm11, int num_bits, void * in_data, void * out_data, scan_field_t * field);
228 void arm11_add_IR (arm11_common_t * arm11, u8 instr, enum tap_state state);
229 void arm11_add_debug_SCAN_N (arm11_common_t * arm11, u8 chain, enum tap_state state);
230 void arm11_add_debug_INST (arm11_common_t * arm11, u32 inst, u8 * flag, enum tap_state state);
231 u32 arm11_read_DSCR (arm11_common_t * arm11);
232 void arm11_write_DSCR (arm11_common_t * arm11, u32 dscr);
234 enum target_debug_reason arm11_get_DSCR_debug_reason(u32 dscr);
236 void arm11_run_instr_data_prepare (arm11_common_t * arm11);
237 void arm11_run_instr_data_finish (arm11_common_t * arm11);
238 void arm11_run_instr_no_data (arm11_common_t * arm11, u32 * opcode, size_t count);
239 void arm11_run_instr_no_data1 (arm11_common_t * arm11, u32 opcode);
240 void arm11_run_instr_data_to_core (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
241 void arm11_run_instr_data_to_core_noack (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
242 void arm11_run_instr_data_to_core1 (arm11_common_t * arm11, u32 opcode, u32 data);
243 void arm11_run_instr_data_from_core (arm11_common_t * arm11, u32 opcode, u32 * data, size_t count);
244 void arm11_run_instr_data_from_core_via_r0 (arm11_common_t * arm11, u32 opcode, u32 * data);
245 void arm11_run_instr_data_to_core_via_r0 (arm11_common_t * arm11, u32 opcode, u32 data);
247 int arm11_add_dr_scan_vc(int num_fields, scan_field_t *fields, enum tap_state state);
248 int arm11_add_ir_scan_vc(int num_fields, scan_field_t *fields, enum tap_state state);
251 /** Used to make a list of read/write commands for scan chain 7
253 * Use with arm11_sc7_run()
255 typedef struct arm11_sc7_action_s
257 int write; /**< Access mode: true for write, false for read. */
258 u8 address; /**< Register address mode. Use enum #arm11_sc7 */
259 u32 value; /**< If write then set this to value to be written.
260 In read mode this receives the read value when the
262 } arm11_sc7_action_t;
264 void arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t count);
266 /* Mid-level helper functions */
267 void arm11_sc7_clear_vbw(arm11_common_t * arm11);
268 void arm11_sc7_set_vcr(arm11_common_t * arm11, u32 value);
270 void arm11_read_memory_word(arm11_common_t * arm11, u32 address, u32 * result);