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