7a6a05478185e6a5c198ac259271658d60e5fa53
[openocd.git] / src / target / arm720t.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2009 by √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "arm720t.h"
28 #include <helper/time_support.h>
29 #include "target_type.h"
30 #include "register.h"
31 #include "arm_opcodes.h"
32
33
34 /*
35 * ARM720 is an ARM7TDMI-S with MMU and ETM7. For information, see
36 * ARM DDI 0229C especially Chapter 9 about debug support.
37 */
38
39 #if 0
40 #define _DEBUG_INSTRUCTION_EXECUTION_
41 #endif
42
43 static int arm720t_scan_cp15(struct target *target,
44 uint32_t out, uint32_t *in, int instruction, int clock_arg)
45 {
46 int retval;
47 struct arm720t_common *arm720t = target_to_arm720(target);
48 struct arm_jtag *jtag_info;
49 struct scan_field fields[2];
50 uint8_t out_buf[4];
51 uint8_t instruction_buf = instruction;
52
53 jtag_info = &arm720t->arm7_9_common.jtag_info;
54
55 buf_set_u32(out_buf, 0, 32, flip_u32(out, 32));
56
57 if ((retval = arm_jtag_scann(jtag_info, 0xf, TAP_DRPAUSE)) != ERROR_OK)
58 {
59 return retval;
60 }
61 if ((retval = arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL, TAP_DRPAUSE)) != ERROR_OK)
62 {
63 return retval;
64 }
65
66 fields[0].num_bits = 1;
67 fields[0].out_value = &instruction_buf;
68 fields[0].in_value = NULL;
69
70 fields[1].num_bits = 32;
71 fields[1].out_value = out_buf;
72 fields[1].in_value = NULL;
73
74 if (in)
75 {
76 fields[1].in_value = (uint8_t *)in;
77 jtag_add_dr_scan(jtag_info->tap, 2, fields, TAP_DRPAUSE);
78 jtag_add_callback(arm7flip32, (jtag_callback_data_t)in);
79 } else
80 {
81 jtag_add_dr_scan(jtag_info->tap, 2, fields, TAP_DRPAUSE);
82 }
83
84 if (clock_arg)
85 jtag_add_runtest(0, TAP_DRPAUSE);
86
87 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
88 if ((retval = jtag_execute_queue()) != ERROR_OK)
89 {
90 return retval;
91 }
92
93 if (in)
94 LOG_DEBUG("out: %8.8x, in: %8.8x, instruction: %i, clock: %i", out, *in, instruction, clock);
95 else
96 LOG_DEBUG("out: %8.8x, instruction: %i, clock: %i", out, instruction, clock_arg);
97 #else
98 LOG_DEBUG("out: %8.8" PRIx32 ", instruction: %i, clock: %i", out, instruction, clock_arg);
99 #endif
100
101 return ERROR_OK;
102 }
103
104 static int arm720t_read_cp15(struct target *target, uint32_t opcode, uint32_t *value)
105 {
106 /* fetch CP15 opcode */
107 arm720t_scan_cp15(target, opcode, NULL, 1, 1);
108 /* "DECODE" stage */
109 arm720t_scan_cp15(target, ARMV4_5_NOP, NULL, 1, 1);
110 /* "EXECUTE" stage (1) */
111 arm720t_scan_cp15(target, ARMV4_5_NOP, NULL, 1, 0);
112 arm720t_scan_cp15(target, 0x0, NULL, 0, 1);
113 /* "EXECUTE" stage (2) */
114 arm720t_scan_cp15(target, 0x0, NULL, 0, 1);
115 /* "EXECUTE" stage (3), CDATA is read */
116 arm720t_scan_cp15(target, ARMV4_5_NOP, value, 1, 1);
117
118 return ERROR_OK;
119 }
120
121 static int arm720t_write_cp15(struct target *target, uint32_t opcode, uint32_t value)
122 {
123 /* fetch CP15 opcode */
124 arm720t_scan_cp15(target, opcode, NULL, 1, 1);
125 /* "DECODE" stage */
126 arm720t_scan_cp15(target, ARMV4_5_NOP, NULL, 1, 1);
127 /* "EXECUTE" stage (1) */
128 arm720t_scan_cp15(target, ARMV4_5_NOP, NULL, 1, 0);
129 arm720t_scan_cp15(target, 0x0, NULL, 0, 1);
130 /* "EXECUTE" stage (2) */
131 arm720t_scan_cp15(target, value, NULL, 0, 1);
132 arm720t_scan_cp15(target, ARMV4_5_NOP, NULL, 1, 1);
133
134 return ERROR_OK;
135 }
136
137 static int arm720t_get_ttb(struct target *target, uint32_t *result)
138 {
139 uint32_t ttb = 0x0;
140
141 int retval;
142
143 retval = arm720t_read_cp15(target, 0xee120f10, &ttb);
144 if (retval != ERROR_OK)
145 return retval;
146 retval = jtag_execute_queue();
147 if (retval != ERROR_OK)
148 return retval;
149
150 ttb &= 0xffffc000;
151
152 *result = ttb;
153
154 return ERROR_OK;
155 }
156
157 static int arm720t_disable_mmu_caches(struct target *target,
158 int mmu, int d_u_cache, int i_cache)
159 {
160 uint32_t cp15_control;
161 int retval;
162
163 /* read cp15 control register */
164 retval = arm720t_read_cp15(target, 0xee110f10, &cp15_control);
165 if (retval != ERROR_OK)
166 return retval;
167 retval = jtag_execute_queue();
168 if (retval != ERROR_OK)
169 return retval;
170
171 if (mmu)
172 cp15_control &= ~0x1U;
173
174 if (d_u_cache || i_cache)
175 cp15_control &= ~0x4U;
176
177 retval = arm720t_write_cp15(target, 0xee010f10, cp15_control);
178 return retval;
179 }
180
181 static int arm720t_enable_mmu_caches(struct target *target,
182 int mmu, int d_u_cache, int i_cache)
183 {
184 uint32_t cp15_control;
185 int retval;
186
187 /* read cp15 control register */
188 retval = arm720t_read_cp15(target, 0xee110f10, &cp15_control);
189 if (retval != ERROR_OK)
190 return retval;
191 retval = jtag_execute_queue();
192 if (retval != ERROR_OK)
193 return retval;
194
195 if (mmu)
196 cp15_control |= 0x1U;
197
198 if (d_u_cache || i_cache)
199 cp15_control |= 0x4U;
200
201 retval = arm720t_write_cp15(target, 0xee010f10, cp15_control);
202 return retval;
203 }
204
205 static int arm720t_post_debug_entry(struct target *target)
206 {
207 struct arm720t_common *arm720t = target_to_arm720(target);
208 int retval;
209
210 /* examine cp15 control reg */
211 retval = arm720t_read_cp15(target, 0xee110f10, &arm720t->cp15_control_reg);
212 if (retval != ERROR_OK)
213 return retval;
214 retval = jtag_execute_queue();
215 if (retval != ERROR_OK)
216 return retval;
217 LOG_DEBUG("cp15_control_reg: %8.8" PRIx32 "", arm720t->cp15_control_reg);
218
219 arm720t->armv4_5_mmu.mmu_enabled = (arm720t->cp15_control_reg & 0x1U) ? 1 : 0;
220 arm720t->armv4_5_mmu.armv4_5_cache.d_u_cache_enabled = (arm720t->cp15_control_reg & 0x4U) ? 1 : 0;
221 arm720t->armv4_5_mmu.armv4_5_cache.i_cache_enabled = 0;
222
223 /* save i/d fault status and address register */
224 retval = arm720t_read_cp15(target, 0xee150f10, &arm720t->fsr_reg);
225 if (retval != ERROR_OK)
226 return retval;
227 retval = arm720t_read_cp15(target, 0xee160f10, &arm720t->far_reg);
228 if (retval != ERROR_OK)
229 return retval;
230 retval = jtag_execute_queue();
231 return retval;
232 }
233
234 static void arm720t_pre_restore_context(struct target *target)
235 {
236 struct arm720t_common *arm720t = target_to_arm720(target);
237
238 /* restore i/d fault status and address register */
239 arm720t_write_cp15(target, 0xee050f10, arm720t->fsr_reg);
240 arm720t_write_cp15(target, 0xee060f10, arm720t->far_reg);
241 }
242
243 static int arm720t_verify_pointer(struct command_context *cmd_ctx,
244 struct arm720t_common *arm720t)
245 {
246 if (arm720t->common_magic != ARM720T_COMMON_MAGIC) {
247 command_print(cmd_ctx, "target is not an ARM720");
248 return ERROR_TARGET_INVALID;
249 }
250 return ERROR_OK;
251 }
252
253 static int arm720t_arch_state(struct target *target)
254 {
255 struct arm720t_common *arm720t = target_to_arm720(target);
256
257 static const char *state[] =
258 {
259 "disabled", "enabled"
260 };
261
262 arm_arch_state(target);
263 LOG_USER("MMU: %s, Cache: %s",
264 state[arm720t->armv4_5_mmu.mmu_enabled],
265 state[arm720t->armv4_5_mmu.armv4_5_cache.d_u_cache_enabled]);
266
267 return ERROR_OK;
268 }
269
270 static int arm720_mmu(struct target *target, int *enabled)
271 {
272 if (target->state != TARGET_HALTED) {
273 LOG_ERROR("%s: target not halted", __func__);
274 return ERROR_TARGET_INVALID;
275 }
276
277 *enabled = target_to_arm720(target)->armv4_5_mmu.mmu_enabled;
278 return ERROR_OK;
279 }
280
281 static int arm720_virt2phys(struct target *target,
282 uint32_t virtual, uint32_t *physical)
283 {
284 uint32_t cb;
285 struct arm720t_common *arm720t = target_to_arm720(target);
286
287 uint32_t ret;
288 int retval = armv4_5_mmu_translate_va(target,
289 &arm720t->armv4_5_mmu, virtual, &cb, &ret);
290 if (retval != ERROR_OK)
291 return retval;
292 *physical = ret;
293 return ERROR_OK;
294 }
295
296 static int arm720t_read_memory(struct target *target,
297 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
298 {
299 int retval;
300 struct arm720t_common *arm720t = target_to_arm720(target);
301
302 /* disable cache, but leave MMU enabled */
303 if (arm720t->armv4_5_mmu.armv4_5_cache.d_u_cache_enabled)
304 {
305 retval = arm720t_disable_mmu_caches(target, 0, 1, 0);
306 if (retval != ERROR_OK)
307 return retval;
308 }
309 retval = arm7_9_read_memory(target, address, size, count, buffer);
310
311 if (arm720t->armv4_5_mmu.armv4_5_cache.d_u_cache_enabled)
312 {
313 retval = arm720t_enable_mmu_caches(target, 0, 1, 0);
314 if (retval != ERROR_OK)
315 return retval;
316 }
317
318 return retval;
319 }
320
321 static int arm720t_read_phys_memory(struct target *target,
322 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
323 {
324 struct arm720t_common *arm720t = target_to_arm720(target);
325
326 return armv4_5_mmu_read_physical(target, &arm720t->armv4_5_mmu, address, size, count, buffer);
327 }
328
329 static int arm720t_write_phys_memory(struct target *target,
330 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
331 {
332 struct arm720t_common *arm720t = target_to_arm720(target);
333
334 return armv4_5_mmu_write_physical(target, &arm720t->armv4_5_mmu, address, size, count, buffer);
335 }
336
337 static int arm720t_soft_reset_halt(struct target *target)
338 {
339 int retval = ERROR_OK;
340 struct arm720t_common *arm720t = target_to_arm720(target);
341 struct reg *dbg_stat = &arm720t->arm7_9_common
342 .eice_cache->reg_list[EICE_DBG_STAT];
343 struct arm *armv4_5 = &arm720t->arm7_9_common
344 .armv4_5_common;
345
346 if ((retval = target_halt(target)) != ERROR_OK)
347 {
348 return retval;
349 }
350
351 long long then = timeval_ms();
352 int timeout;
353 while (!(timeout = ((timeval_ms()-then) > 1000)))
354 {
355 if (buf_get_u32(dbg_stat->value, EICE_DBG_STATUS_DBGACK, 1) == 0)
356 {
357 embeddedice_read_reg(dbg_stat);
358 if ((retval = jtag_execute_queue()) != ERROR_OK)
359 {
360 return retval;
361 }
362 } else
363 {
364 break;
365 }
366 if (debug_level >= 3)
367 {
368 alive_sleep(100);
369 } else
370 {
371 keep_alive();
372 }
373 }
374 if (timeout)
375 {
376 LOG_ERROR("Failed to halt CPU after 1 sec");
377 return ERROR_TARGET_TIMEOUT;
378 }
379
380 target->state = TARGET_HALTED;
381
382 /* SVC, ARM state, IRQ and FIQ disabled */
383 uint32_t cpsr;
384
385 cpsr = buf_get_u32(armv4_5->cpsr->value, 0, 32);
386 cpsr &= ~0xff;
387 cpsr |= 0xd3;
388 arm_set_cpsr(armv4_5, cpsr);
389 armv4_5->cpsr->dirty = 1;
390
391 /* start fetching from 0x0 */
392 buf_set_u32(armv4_5->pc->value, 0, 32, 0x0);
393 armv4_5->pc->dirty = 1;
394 armv4_5->pc->valid = 1;
395
396 retval = arm720t_disable_mmu_caches(target, 1, 1, 1);
397 if (retval != ERROR_OK)
398 return retval;
399 arm720t->armv4_5_mmu.mmu_enabled = 0;
400 arm720t->armv4_5_mmu.armv4_5_cache.d_u_cache_enabled = 0;
401 arm720t->armv4_5_mmu.armv4_5_cache.i_cache_enabled = 0;
402
403 if ((retval = target_call_event_callbacks(target, TARGET_EVENT_HALTED)) != ERROR_OK)
404 {
405 return retval;
406 }
407
408 return ERROR_OK;
409 }
410
411 static int arm720t_init_target(struct command_context *cmd_ctx, struct target *target)
412 {
413 return arm7tdmi_init_target(cmd_ctx, target);
414 }
415
416 /* FIXME remove forward decls */
417 static int arm720t_mrc(struct target *target, int cpnum,
418 uint32_t op1, uint32_t op2,
419 uint32_t CRn, uint32_t CRm,
420 uint32_t *value);
421 static int arm720t_mcr(struct target *target, int cpnum,
422 uint32_t op1, uint32_t op2,
423 uint32_t CRn, uint32_t CRm,
424 uint32_t value);
425
426 static int arm720t_init_arch_info(struct target *target,
427 struct arm720t_common *arm720t, struct jtag_tap *tap)
428 {
429 struct arm7_9_common *arm7_9 = &arm720t->arm7_9_common;
430
431 arm7_9->armv4_5_common.mrc = arm720t_mrc;
432 arm7_9->armv4_5_common.mcr = arm720t_mcr;
433
434 arm7tdmi_init_arch_info(target, arm7_9, tap);
435
436 arm720t->common_magic = ARM720T_COMMON_MAGIC;
437
438 arm7_9->post_debug_entry = arm720t_post_debug_entry;
439 arm7_9->pre_restore_context = arm720t_pre_restore_context;
440
441 arm720t->armv4_5_mmu.armv4_5_cache.ctype = -1;
442 arm720t->armv4_5_mmu.get_ttb = arm720t_get_ttb;
443 arm720t->armv4_5_mmu.read_memory = arm7_9_read_memory;
444 arm720t->armv4_5_mmu.write_memory = arm7_9_write_memory;
445 arm720t->armv4_5_mmu.disable_mmu_caches = arm720t_disable_mmu_caches;
446 arm720t->armv4_5_mmu.enable_mmu_caches = arm720t_enable_mmu_caches;
447 arm720t->armv4_5_mmu.has_tiny_pages = 0;
448 arm720t->armv4_5_mmu.mmu_enabled = 0;
449
450 return ERROR_OK;
451 }
452
453 static int arm720t_target_create(struct target *target, Jim_Interp *interp)
454 {
455 struct arm720t_common *arm720t = calloc(1, sizeof(*arm720t));
456
457 arm720t->arm7_9_common.armv4_5_common.is_armv4 = true;
458 return arm720t_init_arch_info(target, arm720t, target->tap);
459 }
460
461 COMMAND_HANDLER(arm720t_handle_cp15_command)
462 {
463 int retval;
464 struct target *target = get_current_target(CMD_CTX);
465 struct arm720t_common *arm720t = target_to_arm720(target);
466
467 retval = arm720t_verify_pointer(CMD_CTX, arm720t);
468 if (retval != ERROR_OK)
469 return retval;
470
471
472 if (target->state != TARGET_HALTED)
473 {
474 command_print(CMD_CTX, "target must be stopped for \"%s\" command", CMD_NAME);
475 return ERROR_OK;
476 }
477
478 /* one or more argument, access a single register (write if second argument is given */
479 if (CMD_ARGC >= 1)
480 {
481 uint32_t opcode;
482 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], opcode);
483
484 if (CMD_ARGC == 1)
485 {
486 uint32_t value;
487 if ((retval = arm720t_read_cp15(target, opcode, &value)) != ERROR_OK)
488 {
489 command_print(CMD_CTX, "couldn't access cp15 with opcode 0x%8.8" PRIx32 "", opcode);
490 return ERROR_OK;
491 }
492
493 if ((retval = jtag_execute_queue()) != ERROR_OK)
494 {
495 return retval;
496 }
497
498 command_print(CMD_CTX, "0x%8.8" PRIx32 ": 0x%8.8" PRIx32 "", opcode, value);
499 }
500 else if (CMD_ARGC == 2)
501 {
502 uint32_t value;
503 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
504
505 if ((retval = arm720t_write_cp15(target, opcode, value)) != ERROR_OK)
506 {
507 command_print(CMD_CTX, "couldn't access cp15 with opcode 0x%8.8" PRIx32 "", opcode);
508 return ERROR_OK;
509 }
510 command_print(CMD_CTX, "0x%8.8" PRIx32 ": 0x%8.8" PRIx32 "", opcode, value);
511 }
512 }
513
514 return ERROR_OK;
515 }
516
517 static int arm720t_mrc(struct target *target, int cpnum,
518 uint32_t op1, uint32_t op2,
519 uint32_t CRn, uint32_t CRm,
520 uint32_t *value)
521 {
522 if (cpnum!=15)
523 {
524 LOG_ERROR("Only cp15 is supported");
525 return ERROR_FAIL;
526 }
527
528 /* read "to" r0 */
529 return arm720t_read_cp15(target,
530 ARMV4_5_MRC(cpnum, op1, 0, CRn, CRm, op2),
531 value);
532
533 }
534
535 static int arm720t_mcr(struct target *target, int cpnum,
536 uint32_t op1, uint32_t op2,
537 uint32_t CRn, uint32_t CRm,
538 uint32_t value)
539 {
540 if (cpnum!=15)
541 {
542 LOG_ERROR("Only cp15 is supported");
543 return ERROR_FAIL;
544 }
545
546 /* write "from" r0 */
547 return arm720t_write_cp15(target,
548 ARMV4_5_MCR(cpnum, op1, 0, CRn, CRm, op2),
549 value);
550 }
551
552 static const struct command_registration arm720t_exec_command_handlers[] = {
553 {
554 .name = "cp15",
555 .handler = arm720t_handle_cp15_command,
556 .mode = COMMAND_EXEC,
557 /* prefer using less error-prone "arm mcr" or "arm mrc" */
558 .help = "display/modify cp15 register using ARM opcode"
559 " (DEPRECATED)",
560 .usage = "instruction [value]",
561 },
562 COMMAND_REGISTRATION_DONE
563 };
564
565 static const struct command_registration arm720t_command_handlers[] = {
566 {
567 .chain = arm7_9_command_handlers,
568 },
569 {
570 .name = "arm720t",
571 .mode = COMMAND_ANY,
572 .help = "arm720t command group",
573 .usage = "",
574 .chain = arm720t_exec_command_handlers,
575 },
576 COMMAND_REGISTRATION_DONE
577 };
578
579 /** Holds methods for ARM720 targets. */
580 struct target_type arm720t_target =
581 {
582 .name = "arm720t",
583
584 .poll = arm7_9_poll,
585 .arch_state = arm720t_arch_state,
586
587 .halt = arm7_9_halt,
588 .resume = arm7_9_resume,
589 .step = arm7_9_step,
590
591 .assert_reset = arm7_9_assert_reset,
592 .deassert_reset = arm7_9_deassert_reset,
593 .soft_reset_halt = arm720t_soft_reset_halt,
594
595 .get_gdb_reg_list = arm_get_gdb_reg_list,
596
597 .read_memory = arm720t_read_memory,
598 .write_memory = arm7_9_write_memory,
599 .read_phys_memory = arm720t_read_phys_memory,
600 .write_phys_memory = arm720t_write_phys_memory,
601 .mmu = arm720_mmu,
602 .virt2phys = arm720_virt2phys,
603
604 .bulk_write_memory = arm7_9_bulk_write_memory,
605
606 .checksum_memory = arm_checksum_memory,
607 .blank_check_memory = arm_blank_check_memory,
608
609 .run_algorithm = armv4_5_run_algorithm,
610
611 .add_breakpoint = arm7_9_add_breakpoint,
612 .remove_breakpoint = arm7_9_remove_breakpoint,
613 .add_watchpoint = arm7_9_add_watchpoint,
614 .remove_watchpoint = arm7_9_remove_watchpoint,
615
616 .commands = arm720t_command_handlers,
617 .target_create = arm720t_target_create,
618 .init_target = arm720t_init_target,
619 .examine = arm7_9_examine,
620 .check_reset = arm7_9_check_reset,
621 };