openocd: fix SPDX tag format for files .c
[fw/openocd] / src / target / arm946e.c
index a7a57b743fb76ac3a120f1838a6ed4c993de2c3f..06dab4e977494c47f2625f8791c7bcd984295add 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,21 +9,6 @@
  *                                                                         *
  *   Copyright (C) 2010 by Drasko DRASKOVIC                                *
  *   drasko.draskovic@gmail.com                                            *
- *                                                                         *
- *   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.             *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 /**
  * flag to give info about cache manipulation during debug :
  * "0" -       cache lines are invalidated "on the fly", for affected addresses.
- *                     This is prefered from performance point of view.
+ *                     This is preferred from performance point of view.
  * "1" -       cache is invalidated and switched off on debug_entry, and switched back on on restore.
  *                     It is kept off during debugging.
  */
 static uint8_t arm946e_preserve_cache;
 
-int arm946e_post_debug_entry(struct target *target);
-void arm946e_pre_restore_context(struct target *target);
+static int arm946e_post_debug_entry(struct target *target);
+static void arm946e_pre_restore_context(struct target *target);
 static int arm946e_read_cp15(struct target *target, int reg_addr, uint32_t *value);
 
-int arm946e_init_arch_info(struct target *target,
+static int arm946e_init_arch_info(struct target *target,
        struct arm946e_common *arm946e,
        struct jtag_tap *tap)
 {
@@ -101,11 +88,21 @@ static int arm946e_target_create(struct target *target, Jim_Interp *interp)
        return ERROR_OK;
 }
 
-static int arm946e_verify_pointer(struct command_context *cmd_ctx,
+static void arm946e_deinit_target(struct target *target)
+{
+       struct arm *arm = target_to_arm(target);
+       struct arm946e_common *arm946e = target_to_arm946(target);
+
+       arm7_9_deinit(target);
+       arm_free_reg_cache(arm);
+       free(arm946e);
+}
+
+static int arm946e_verify_pointer(struct command_invocation *cmd,
        struct arm946e_common *arm946e)
 {
        if (arm946e->common_magic != ARM946E_COMMON_MAGIC) {
-               command_print(cmd_ctx, "target is not an ARM946");
+               command_print(cmd, "target is not an ARM946");
                return ERROR_TARGET_INVALID;
        }
        return ERROR_OK;
@@ -139,7 +136,7 @@ static int arm946e_read_cp15(struct target *target, int reg_addr, uint32_t *valu
        retval = arm_jtag_scann(jtag_info, 0xf, TAP_IDLE);
        if (retval != ERROR_OK)
                return retval;
-       retval = arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL, TAP_IDLE);
+       retval = arm_jtag_set_instr(jtag_info->tap, jtag_info->intest_instr, NULL, TAP_IDLE);
        if (retval != ERROR_OK)
                return retval;
 
@@ -176,7 +173,7 @@ static int arm946e_read_cp15(struct target *target, int reg_addr, uint32_t *valu
        return ERROR_OK;
 }
 
-int arm946e_write_cp15(struct target *target, int reg_addr, uint32_t value)
+static int arm946e_write_cp15(struct target *target, int reg_addr, uint32_t value)
 {
        int retval = ERROR_OK;
        struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
@@ -191,7 +188,7 @@ int arm946e_write_cp15(struct target *target, int reg_addr, uint32_t value)
        retval = arm_jtag_scann(jtag_info, 0xf, TAP_IDLE);
        if (retval != ERROR_OK)
                return retval;
-       retval = arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL, TAP_IDLE);
+       retval = arm_jtag_set_instr(jtag_info->tap, jtag_info->intest_instr, NULL, TAP_IDLE);
        if (retval != ERROR_OK)
                return retval;
 
@@ -242,7 +239,7 @@ static uint32_t arm946e_cp15_get_csize(struct target *target, int idsel)
        return csize ? 1 << (12 + (csize-3)) : 0;
 }
 
-uint32_t arm946e_invalidate_whole_dcache(struct target *target)
+static uint32_t arm946e_invalidate_whole_dcache(struct target *target)
 {
        uint32_t csize = arm946e_cp15_get_csize(target, GET_DCACHE_SIZE);
        if (csize == 0)
@@ -253,7 +250,7 @@ uint32_t arm946e_invalidate_whole_dcache(struct target *target)
         */
        int nb_idx = (csize / (4*8*NB_CACHE_WAYS));     /* gives nb of lines (indexes) in the cache */
 
-       /* Loop for all segmentde (i.e. ways) */
+       /* Loop for all segments (i.e. ways) */
        uint32_t seg;
        for (seg = 0; seg < NB_CACHE_WAYS; seg++) {
                /* Loop for all indexes */
@@ -269,7 +266,11 @@ uint32_t arm946e_invalidate_whole_dcache(struct target *target)
 
                        /* Read dtag */
                        uint32_t dtag;
-                       arm946e_read_cp15(target, 0x16, (uint32_t *) &dtag);
+                       retval = arm946e_read_cp15(target, 0x16, &dtag);
+                       if (retval != ERROR_OK) {
+                               LOG_DEBUG("ERROR reading dtag");
+                               return retval;
+                       }
 
                        /* Check cache line VALID bit */
                        if (!(dtag >> 4 & 0x1))
@@ -294,7 +295,7 @@ uint32_t arm946e_invalidate_whole_dcache(struct target *target)
        return ERROR_OK;
 }
 
-uint32_t arm946e_invalidate_whole_icache(struct target *target)
+static uint32_t arm946e_invalidate_whole_icache(struct target *target)
 {
        /* Check cache presence before flushing - avoid undefined behavior */
        uint32_t csize = arm946e_cp15_get_csize(target, GET_ICACHE_SIZE);
@@ -315,7 +316,7 @@ uint32_t arm946e_invalidate_whole_icache(struct target *target)
        return ERROR_OK;
 }
 
-int arm946e_post_debug_entry(struct target *target)
+static int arm946e_post_debug_entry(struct target *target)
 {
        uint32_t ctr_reg = 0x0;
        uint32_t retval = ERROR_OK;
@@ -323,7 +324,7 @@ int arm946e_post_debug_entry(struct target *target)
 
        /* See if CACHES are enabled, and save that info
         * in the context bits, so that arm946e_pre_restore_context() can use them */
-       arm946e_read_cp15(target, CP15_CTL, (uint32_t *) &ctr_reg);
+       arm946e_read_cp15(target, CP15_CTL, &ctr_reg);
 
        /* Save control reg in the context */
        arm946e->cp15_control_reg = ctr_reg;
@@ -356,7 +357,7 @@ int arm946e_post_debug_entry(struct target *target)
        return ERROR_OK;
 }
 
-void arm946e_pre_restore_context(struct target *target)
+static void arm946e_pre_restore_context(struct target *target)
 {
        uint32_t ctr_reg = 0x0;
        uint32_t retval;
@@ -364,7 +365,7 @@ void arm946e_pre_restore_context(struct target *target)
        if (arm946e_preserve_cache) {
                struct arm946e_common *arm946e = target_to_arm946(target);
                /* Get the contents of the CTR reg */
-               arm946e_read_cp15(target, CP15_CTL, (uint32_t *) &ctr_reg);
+               arm946e_read_cp15(target, CP15_CTL, &ctr_reg);
 
                /**
                 * Read-modify-write CP15 control
@@ -381,7 +382,7 @@ void arm946e_pre_restore_context(struct target *target)
        }       /* if preserve_cache */
 }
 
-uint32_t arm946e_invalidate_dcache(struct target *target, uint32_t address,
+static uint32_t arm946e_invalidate_dcache(struct target *target, uint32_t address,
        uint32_t size, uint32_t count)
 {
        uint32_t cur_addr = 0x0;
@@ -412,7 +413,11 @@ uint32_t arm946e_invalidate_dcache(struct target *target, uint32_t address,
                        }
 
                        /* Read dtag */
-                       arm946e_read_cp15(target, 0x16, (uint32_t *) &dtag);
+                       retval = arm946e_read_cp15(target, 0x16, &dtag);
+                       if (retval != ERROR_OK) {
+                               LOG_DEBUG("ERROR reading dtag");
+                               return retval;
+                       }
 
                        /* Check cache line VALID bit */
                        if (!(dtag >> 4 & 0x1))
@@ -442,7 +447,7 @@ uint32_t arm946e_invalidate_dcache(struct target *target, uint32_t address,
        return ERROR_OK;
 }
 
-uint32_t arm946e_invalidate_icache(struct target *target, uint32_t address,
+static uint32_t arm946e_invalidate_icache(struct target *target, uint32_t address,
        uint32_t size, uint32_t count)
 {
        uint32_t cur_addr = 0x0;
@@ -465,7 +470,11 @@ uint32_t arm946e_invalidate_icache(struct target *target, uint32_t address,
                        }
 
                        /* Read itag */
-                       arm946e_read_cp15(target, 0x17, (uint32_t *) &itag);
+                       retval = arm946e_read_cp15(target, 0x17, &itag);
+                       if (retval != ERROR_OK) {
+                               LOG_DEBUG("ERROR reading itag");
+                               return retval;
+                       }
 
                        /* Check cache line VALID bit */
                        if (!(itag >> 4 & 0x1))
@@ -489,7 +498,7 @@ uint32_t arm946e_invalidate_icache(struct target *target, uint32_t address,
 }
 
 /** Writes a buffer, in the specified word size, with current MMU settings. */
-int arm946e_write_memory(struct target *target, uint32_t address,
+static int arm946e_write_memory(struct target *target, target_addr_t address,
        uint32_t size, uint32_t count, const uint8_t *buffer)
 {
        int retval;
@@ -504,7 +513,7 @@ int arm946e_write_memory(struct target *target, uint32_t address,
        /**
         * Write memory
         */
-       retval = arm7_9_write_memory(target, address, size, count, buffer);
+       retval = arm7_9_write_memory_opt(target, address, size, count, buffer);
        if (retval != ERROR_OK)
                return retval;
 
@@ -537,7 +546,7 @@ int arm946e_write_memory(struct target *target, uint32_t address,
 
 }
 
-int arm946e_read_memory(struct target *target, uint32_t address,
+static int arm946e_read_memory(struct target *target, target_addr_t address,
        uint32_t size, uint32_t count, uint8_t *buffer)
 {
        int retval;
@@ -551,84 +560,167 @@ int arm946e_read_memory(struct target *target, uint32_t address,
        return ERROR_OK;
 }
 
-static int jim_arm946e_cp15(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+COMMAND_HANDLER(arm946e_handle_cp15)
 {
        /* one or two arguments, access a single register (write if second argument is given) */
-       if (argc < 2 || argc > 3) {
-               Jim_WrongNumArgs(interp, 1, argv, "addr [value]");
-               return JIM_ERR;
-       }
-
-       struct command_context *cmd_ctx = current_command_context(interp);
-       assert(cmd_ctx != NULL);
+       if (CMD_ARGC < 1 || CMD_ARGC > 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       struct target *target = get_current_target(cmd_ctx);
-       if (target == NULL) {
-               LOG_ERROR("arm946e: no current target");
-               return JIM_ERR;
-       }
+       struct target *target = get_current_target(CMD_CTX);
 
        struct arm946e_common *arm946e = target_to_arm946(target);
-       int retval = arm946e_verify_pointer(cmd_ctx, arm946e);
+       int retval = arm946e_verify_pointer(CMD, arm946e);
        if (retval != ERROR_OK)
-               return JIM_ERR;
+               return retval;
 
        if (target->state != TARGET_HALTED) {
-               command_print(cmd_ctx, "target %s must be stopped for \"cp15\" command", target_name(target));
-               return JIM_ERR;
+               command_print(CMD, "target must be stopped for \"%s\" command", CMD_NAME);
+               return ERROR_TARGET_NOT_HALTED;
        }
 
-       long l;
        uint32_t address;
-       retval = Jim_GetLong(interp, argv[1], &l);
-       address = l;
-       if (JIM_OK != retval)
-               return retval;
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
 
-       if (argc == 2) {
+       if (CMD_ARGC == 1) {
                uint32_t value;
                retval = arm946e_read_cp15(target, address, &value);
                if (retval != ERROR_OK) {
-                       command_print(cmd_ctx, "%s cp15 reg %" PRIi32 " access failed", target_name(target), address);
-                       return JIM_ERR;
+                       command_print(CMD, "%s cp15 reg %" PRIu32 " access failed", target_name(target), address);
+                       return retval;
                }
                retval = jtag_execute_queue();
                if (retval != ERROR_OK)
-                       return JIM_ERR;
-               char buf[20];
-               sprintf(buf, "0x%08x", value);
+                       return retval;
+
                /* Return value in hex format */
-               Jim_SetResultString(interp, buf, -1);
-       } else if (argc == 3) {
+               command_print(CMD, "0x%08" PRIx32, value);
+       } else if (CMD_ARGC == 2) {
                uint32_t value;
-               retval = Jim_GetLong(interp, argv[2], &l);
-               value = l;
-               if (JIM_OK != retval)
-                       return retval;
+               COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
+
                retval = arm946e_write_cp15(target, address, value);
                if (retval != ERROR_OK) {
-                       command_print(cmd_ctx, "%s cp15 reg %" PRIi32 " access failed", target_name(target), address);
-                       return JIM_ERR;
+                       command_print(CMD, "%s cp15 reg %" PRIu32 " access failed", target_name(target), address);
+                       return retval;
                }
                if (address == CP15_CTL)
                        arm946e_update_cp15_caches(target, value);
        }
 
-       return JIM_OK;
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(arm946e_handle_idcache)
+{
+       if (CMD_ARGC > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       int retval;
+       struct target *target = get_current_target(CMD_CTX);
+       struct arm946e_common *arm946e = target_to_arm946(target);
+
+       retval = arm946e_verify_pointer(CMD, arm946e);
+       if (retval != ERROR_OK)
+               return retval;
+
+       if (target->state != TARGET_HALTED) {
+               command_print(CMD, "target must be stopped for \"%s\" command", CMD_NAME);
+               return ERROR_TARGET_NOT_HALTED;
+       }
+
+       bool icache = (strcmp(CMD_NAME, "icache") == 0);
+       uint32_t csize = arm946e_cp15_get_csize(target, icache ? GET_ICACHE_SIZE : GET_DCACHE_SIZE) / 1024;
+       if (CMD_ARGC == 0) {
+               bool  bena = ((arm946e->cp15_control_reg & (icache ? CP15_CTL_ICACHE : CP15_CTL_DCACHE)) != 0)
+                         && (arm946e->cp15_control_reg & 0x1);
+               if (csize == 0)
+                       command_print(CMD, "%s-cache absent", icache ? "I" : "D");
+               else
+                       command_print(CMD, "%s-cache size: %" PRIu32 "K, %s",
+                                     icache ? "I" : "D", csize, bena ? "enabled" : "disabled");
+               return ERROR_OK;
+       }
+
+       bool flush = false;
+       bool enable = false;
+       retval = command_parse_bool_arg(CMD_ARGV[0], &enable);
+       if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
+               if (strcmp(CMD_ARGV[0], "flush") == 0) {
+                       flush = true;
+                       retval = ERROR_OK;
+               } else
+                       return retval;
+       }
+
+       /* Do not invalidate or change state, if cache is absent */
+       if (csize == 0) {
+               command_print(CMD, "%s-cache absent, '%s' operation undefined", icache ? "I" : "D", CMD_ARGV[0]);
+               return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
+       }
+
+       /* NOTE: flushing entire cache will not preserve lock-down cache regions */
+       if (icache) {
+               if ((arm946e->cp15_control_reg & CP15_CTL_ICACHE) && !enable)
+                       retval = arm946e_invalidate_whole_icache(target);
+       } else {
+               if ((arm946e->cp15_control_reg & CP15_CTL_DCACHE) && !enable)
+                       retval = arm946e_invalidate_whole_dcache(target);
+       }
+
+       if (retval != ERROR_OK || flush)
+               return retval;
+
+       uint32_t value;
+       retval = arm946e_read_cp15(target, CP15_CTL, &value);
+       if (retval != ERROR_OK)
+               return retval;
+
+       uint32_t vnew = value;
+       uint32_t cmask = icache ? CP15_CTL_ICACHE : CP15_CTL_DCACHE;
+       if (enable) {
+               if ((value & 0x1) == 0)
+                       LOG_WARNING("arm946e: MPU must be enabled for cache to operate");
+               vnew |= cmask;
+       } else
+               vnew &= ~cmask;
+
+       if (vnew == value)
+               return ERROR_OK;
+
+       retval = arm946e_write_cp15(target, CP15_CTL, vnew);
+       if (retval != ERROR_OK)
+               return retval;
+
+       arm946e_update_cp15_caches(target, vnew);
+       return ERROR_OK;
 }
 
 static const struct command_registration arm946e_exec_command_handlers[] = {
        {
                .name = "cp15",
-               .jim_handler = jim_arm946e_cp15,
+               .handler = arm946e_handle_cp15,
                .mode = COMMAND_EXEC,
                .usage = "regnum [value]",
                .help = "read/modify cp15 register",
        },
+       {
+               .name = "icache",
+               .handler = arm946e_handle_idcache,
+               .mode = COMMAND_EXEC,
+               .usage = "['enable'|'disable'|'flush']",
+               .help = "I-cache info and operations",
+       },
+       {
+               .name = "dcache",
+               .handler = arm946e_handle_idcache,
+               .mode = COMMAND_EXEC,
+               .usage = "['enable'|'disable'|'flush']",
+               .help = "D-cache info and operations",
+       },
        COMMAND_REGISTRATION_DONE
 };
 
-const struct command_registration arm946e_command_handlers[] = {
+static const struct command_registration arm946e_command_handlers[] = {
        {
                .chain = arm9tdmi_command_handlers,
        },
@@ -659,6 +751,7 @@ struct target_type arm946e_target = {
        .deassert_reset = arm7_9_deassert_reset,
        .soft_reset_halt = arm7_9_soft_reset_halt,
 
+       .get_gdb_arch = arm_get_gdb_arch,
        .get_gdb_reg_list = arm_get_gdb_reg_list,
 
        /* .read_memory = arm7_9_read_memory, */
@@ -666,8 +759,6 @@ struct target_type arm946e_target = {
        .read_memory = arm946e_read_memory,
        .write_memory = arm946e_write_memory,
 
-       .bulk_write_memory = arm7_9_bulk_write_memory,
-
        .checksum_memory = arm_checksum_memory,
        .blank_check_memory = arm_blank_check_memory,
 
@@ -684,6 +775,7 @@ struct target_type arm946e_target = {
        .commands = arm946e_command_handlers,
        .target_create = arm946e_target_create,
        .init_target = arm9tdmi_init_target,
+       .deinit_target = arm946e_deinit_target,
        .examine = arm7_9_examine,
        .check_reset = arm7_9_check_reset,
 };