target/xtensa: avoid IHI for writes to non-executable memory
[openocd.git] / src / flash / nor / tcl.c
index e935b3b4af2280e89183664f880bec89f1690930..720fb60a1b520c953f83049ea35245da0b866ca2 100644 (file)
@@ -1,22 +1,11 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
  *   Copyright (C) 2007,2008 Ã˜yvind Harboe <oyvind.harboe@zylin.com>       *
  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
  *   Copyright (C) 2017-2018 Tomas Vanek <vanekt@fbl.cz>                   *
- *                                                                         *
- *   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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 #ifdef HAVE_CONFIG_H
 #include "config.h"
@@ -30,7 +19,7 @@
  * Implements Tcl commands used to access NOR flash facilities.
  */
 
-COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
+COMMAND_HELPER(flash_command_get_bank_probe_optional, unsigned int name_index,
               struct flash_bank **bank, bool do_probe)
 {
        const char *name = CMD_ARGV[name_index];
@@ -62,7 +51,7 @@ COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
        struct flash_bank **bank)
 {
-       return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
+       return CALL_COMMAND_HANDLER(flash_command_get_bank_probe_optional,
                                    name_index, bank, true);
 }
 
@@ -88,8 +77,7 @@ COMMAND_HANDLER(handle_flash_info_command)
        if (retval != ERROR_OK)
                return retval;
 
-       if (p != NULL) {
-               char buf[1024];
+       if (p) {
                int num_blocks;
                struct flash_sector *block_array;
 
@@ -100,7 +88,7 @@ COMMAND_HANDLER(handle_flash_info_command)
 
                /* If the driver does not implement protection, we show the default
                 * state of is_protected array - usually protection state unknown */
-               if (p->driver->protect_check == NULL) {
+               if (!p->driver->protect_check) {
                        retval = ERROR_FLASH_OPER_UNSUPPORTED;
                } else {
                        /* We must query the hardware to avoid printing stale information! */
@@ -149,11 +137,11 @@ COMMAND_HANDLER(handle_flash_info_command)
                                protect_state);
                }
 
-               if (p->driver->info != NULL) {
-                       retval = p->driver->info(p, buf, sizeof(buf));
-                       if (retval == ERROR_OK)
-                               command_print(CMD, "%s", buf);
-                       else
+               if (p->driver->info) {
+                       /* Let the flash driver print extra custom info */
+                       retval = p->driver->info(p, CMD);
+                       command_print_sameline(CMD, "\n");
+                       if (retval != ERROR_OK)
                                LOG_ERROR("error retrieving flash info");
                }
        }
@@ -169,7 +157,7 @@ COMMAND_HANDLER(handle_flash_probe_command)
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank_probe_optional, 0, &p, false);
        if (retval != ERROR_OK)
                return retval;
 
@@ -196,7 +184,7 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
 
        struct flash_bank *p;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        retval = p->driver->erase_check(p);
@@ -287,7 +275,7 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        if (retval == ERROR_OK)
                retval = flash_erase_address_range(target, do_pad, address, length);
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD, "erased address " TARGET_ADDR_FMT " (length %" PRIu32 ")"
                        " in %fs (%0.3f KiB/s)", address, length,
                        duration_elapsed(&bench), duration_kbps(&bench, length));
@@ -335,7 +323,7 @@ COMMAND_HANDLER(handle_flash_erase_command)
 
        retval = flash_driver_erase(p, first, last);
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD, "erased sectors %" PRIu32 " "
                        "through %" PRIu32 " on flash bank %u "
                        "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
@@ -441,26 +429,27 @@ COMMAND_HANDLER(handle_flash_write_image_command)
        duration_start(&bench);
 
        if (CMD_ARGC >= 2) {
-               image.base_address_set = 1;
+               image.base_address_set = true;
                COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
        } else {
-               image.base_address_set = 0;
+               image.base_address_set = false;
                image.base_address = 0x0;
        }
 
-       image.start_address_set = 0;
+       image.start_address_set = false;
 
        retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
        if (retval != ERROR_OK)
                return retval;
 
-       retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
+       retval = flash_write_unlock_verify(target, &image, &written, auto_erase,
+               auto_unlock, true, false);
        if (retval != ERROR_OK) {
                image_close(&image);
                return retval;
        }
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD, "wrote %" PRIu32 " bytes from file %s "
                        "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
                        duration_elapsed(&bench), duration_kbps(&bench, written));
@@ -471,6 +460,58 @@ COMMAND_HANDLER(handle_flash_write_image_command)
        return retval;
 }
 
+COMMAND_HANDLER(handle_flash_verify_image_command)
+{
+       struct target *target = get_current_target(CMD_CTX);
+
+       struct image image;
+       uint32_t verified;
+
+       int retval;
+
+       if (CMD_ARGC < 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       if (!target) {
+               LOG_ERROR("no target selected");
+               return ERROR_FAIL;
+       }
+
+       struct duration bench;
+       duration_start(&bench);
+
+       if (CMD_ARGC >= 2) {
+               image.base_address_set = 1;
+               COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
+       } else {
+               image.base_address_set = 0;
+               image.base_address = 0x0;
+       }
+
+       image.start_address_set = 0;
+
+       retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
+       if (retval != ERROR_OK)
+               return retval;
+
+       retval = flash_write_unlock_verify(target, &image, &verified, false,
+               false, false, true);
+       if (retval != ERROR_OK) {
+               image_close(&image);
+               return retval;
+       }
+
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
+               command_print(CMD, "verified %" PRIu32 " bytes from file %s "
+                       "in %fs (%0.3f KiB/s)", verified, CMD_ARGV[0],
+                       duration_elapsed(&bench), duration_kbps(&bench, verified));
+       }
+
+       image_close(&image);
+
+       return retval;
+}
+
 COMMAND_HANDLER(handle_flash_fill_command)
 {
        target_addr_t address;
@@ -532,7 +573,7 @@ COMMAND_HANDLER(handle_flash_fill_command)
        uint32_t padding_at_end = aligned_end - end_addr;
 
        uint8_t *buffer = malloc(aligned_size);
-       if (buffer == NULL)
+       if (!buffer)
                return ERROR_FAIL;
 
        if (padding_at_start) {
@@ -672,7 +713,7 @@ COMMAND_HANDLER(handle_flash_md_command)
        }
 
        uint8_t *buffer = calloc(count, wordsize);
-       if (buffer == NULL) {
+       if (!buffer) {
                command_print(CMD, "No memory for flash read buffer");
                return ERROR_FAIL;
        }
@@ -702,7 +743,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
 
        struct flash_bank *bank;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        offset = 0;
@@ -747,7 +788,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        uint32_t padding_at_end = aligned_end - end_addr;
 
        buffer = malloc(aligned_size);
-       if (buffer == NULL) {
+       if (!buffer) {
                fileio_close(fileio);
                LOG_ERROR("Out of memory");
                return ERROR_FAIL;
@@ -773,6 +814,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        if (buf_cnt != length) {
                LOG_ERROR("Short read");
                free(buffer);
+               fileio_close(fileio);
                return ERROR_FAIL;
        }
 
@@ -789,7 +831,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
 
        free(buffer);
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD, "wrote %zu bytes from file %s to flash bank %u"
                        " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
                        length, CMD_ARGV[1], bank->bank_number, offset,
@@ -818,7 +860,7 @@ COMMAND_HANDLER(handle_flash_read_bank_command)
        struct flash_bank *p;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
 
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        offset = 0;
@@ -844,7 +886,7 @@ COMMAND_HANDLER(handle_flash_read_bank_command)
        }
 
        buffer = malloc(length);
-       if (buffer == NULL) {
+       if (!buffer) {
                LOG_ERROR("Out of memory");
                return ERROR_FAIL;
        }
@@ -899,7 +941,7 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
 
        struct flash_bank *p;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        offset = 0;
@@ -938,7 +980,7 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
                        "first %zu bytes of the file", length);
 
        buffer_file = malloc(length);
-       if (buffer_file == NULL) {
+       if (!buffer_file) {
                LOG_ERROR("Out of memory");
                fileio_close(fileio);
                return ERROR_FAIL;
@@ -959,7 +1001,7 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        }
 
        buffer_flash = malloc(length);
-       if (buffer_flash == NULL) {
+       if (!buffer_flash) {
                LOG_ERROR("Out of memory");
                free(buffer_file);
                return ERROR_FAIL;
@@ -1020,7 +1062,7 @@ COMMAND_HANDLER(handle_flash_padded_value_command)
 
        struct flash_bank *p;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
@@ -1142,7 +1184,15 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .mode = COMMAND_EXEC,
                .usage = "[erase] [unlock] filename [offset [file_type]]",
                .help = "Write an image to flash.  Optionally first unprotect "
-                       "and/or erase the region to be used.  Allow optional "
+                       "and/or erase the region to be used. Allow optional "
+                       "offset from beginning of bank (defaults to zero)",
+       },
+       {
+               .name = "verify_image",
+               .handler = handle_flash_verify_image_command,
+               .mode = COMMAND_EXEC,
+               .usage = "filename [offset [file_type]]",
+               .help = "Verify an image against flash. Allow optional "
                        "offset from beginning of bank (defaults to zero)",
        },
        {
@@ -1187,8 +1237,7 @@ static int flash_init_drivers(struct command_context *cmd_ctx)
        if (!flash_bank_list())
                return ERROR_OK;
 
-       struct command *parent = command_find_in_context(cmd_ctx, "flash");
-       return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
+       return register_commands(cmd_ctx, "flash", flash_exec_command_handlers);
 }
 
 COMMAND_HANDLER(handle_flash_bank_command)
@@ -1203,31 +1252,30 @@ COMMAND_HANDLER(handle_flash_bank_command)
        CMD_ARGC--;
 
        struct target *target = get_target(CMD_ARGV[5]);
-       if (target == NULL) {
+       if (!target) {
                LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
                return ERROR_FAIL;
        }
 
        const char *driver_name = CMD_ARGV[0];
        const struct flash_driver *driver = flash_driver_find_by_name(driver_name);
-       if (NULL == driver) {
+       if (!driver) {
                /* no matching flash driver found */
                LOG_ERROR("flash driver '%s' not found", driver_name);
                return ERROR_FAIL;
        }
 
        /* check the flash bank name is unique */
-       if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
+       if (get_flash_bank_by_name_noprobe(bank_name)) {
                /* flash bank name already exists  */
                LOG_ERROR("flash bank name '%s' already exists", bank_name);
                return ERROR_FAIL;
        }
 
        /* register flash specific commands */
-       if (NULL != driver->commands) {
-               int retval = register_commands(CMD_CTX, NULL,
-                               driver->commands);
-               if (ERROR_OK != retval) {
+       if (driver->commands) {
+               int retval = register_commands(CMD_CTX, NULL, driver->commands);
+               if (retval != ERROR_OK) {
                        LOG_ERROR("couldn't register '%s' commands",
                                driver_name);
                        return ERROR_FAIL;
@@ -1247,14 +1295,14 @@ COMMAND_HANDLER(handle_flash_bank_command)
 
        int retval;
        retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
-       if (ERROR_OK != retval) {
+       if (retval != ERROR_OK) {
                LOG_ERROR("'%s' driver rejected flash bank at " TARGET_ADDR_FMT
                                "; usage: %s", driver_name, c->base, driver->usage);
                free(c);
                return retval;
        }
 
-       if (driver->usage == NULL)
+       if (!driver->usage)
                LOG_DEBUG("'%s' driver usage field missing", driver_name);
 
        flash_bank_add(c);
@@ -1277,36 +1325,27 @@ COMMAND_HANDLER(handle_flash_banks_command)
        return ERROR_OK;
 }
 
-static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+COMMAND_HANDLER(handle_flash_list)
 {
-       if (argc != 1) {
-               Jim_WrongNumArgs(interp, 1, argv,
-                       "no arguments to 'flash list' command");
-               return JIM_ERR;
-       }
-
-       Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
-               Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
-
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
-
-               Jim_ListAppendElement(interp, list, elem);
+               command_print(CMD,
+                       "{\n"
+                       "    name       %s\n"
+                       "    driver     %s\n"
+                       "    base       " TARGET_ADDR_FMT "\n"
+                       "    size       0x%" PRIx32 "\n"
+                       "    bus_width  %u\n"
+                       "    chip_width %u\n"
+                       "    target     %s\n"
+                       "}",
+                       p->name, p->driver->name, p->base, p->size, p->bus_width, p->chip_width,
+                       target_name(p->target));
        }
 
-       Jim_SetResult(interp, list);
-
-       return JIM_OK;
+       return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_flash_init_command)
@@ -1353,8 +1392,9 @@ static const struct command_registration flash_config_command_handlers[] = {
        {
                .name = "list",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_flash_list,
+               .handler = handle_flash_list,
                .help = "Returns a list of details about the flash banks.",
+               .usage = "",
        },
        COMMAND_REGISTRATION_DONE
 };

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)