From 3edcb941864d677e30d36ad77c22d86ec7ac8eb3 Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Wed, 1 Jul 2015 02:55:49 -0600 Subject: [PATCH] flash/nor/tcl: add read_bank and verify_bank The only read access to flash chips so is through the target's memory. Flashes like jtagspi do not expose a memory mapped interface to the flash. These commands use the flash_driver_read() driver API directly. Change-Id: I40b910de650114a3f676507f9f059a234377d862 Signed-off-by: Robert Jordens Reviewed-on: http://openocd.zylin.com/2842 Tested-by: jenkins Reviewed-by: Spencer Oliver --- doc/openocd.texi | 12 +++ src/flash/nor/tcl.c | 177 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 189 insertions(+) diff --git a/doc/openocd.texi b/doc/openocd.texi index 140e86b406..4430050eec 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -4644,6 +4644,18 @@ starting at @var{offset} bytes from the beginning of the bank. The @var{num} parameter is a value shown by @command{flash banks}. @end deffn +@deffn Command {flash read_bank} num filename offset length +Read @var{length} bytes from the flash bank @var{num} starting at @var{offset} +and write the contents to the binary @file{filename}. +The @var{num} parameter is a value shown by @command{flash banks}. +@end deffn + +@deffn Command {flash verify_bank} num filename offset +Compare the contents of the binary file @var{filename} with the contents of the +flash @var{num} starting at @var{offset}. Fails if the contents do not match. +The @var{num} parameter is a value shown by @command{flash banks}. +@end deffn + @deffn Command {flash write_image} [erase] [unlock] filename [offset] [type] Write the image @file{filename} to the current target's flash bank(s). Only loadable sections from the image are written. diff --git a/src/flash/nor/tcl.c b/src/flash/nor/tcl.c index 8f97ebd245..709d0c1a70 100644 --- a/src/flash/nor/tcl.c +++ b/src/flash/nor/tcl.c @@ -610,6 +610,165 @@ COMMAND_HANDLER(handle_flash_write_bank_command) return retval; } +COMMAND_HANDLER(handle_flash_read_bank_command) +{ + uint32_t offset; + uint8_t *buffer; + struct fileio fileio; + uint32_t length; + size_t written; + + if (CMD_ARGC != 4) + return ERROR_COMMAND_SYNTAX_ERROR; + + struct duration bench; + duration_start(&bench); + + struct flash_bank *p; + int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); + if (ERROR_OK != retval) + return retval; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset); + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length); + + buffer = malloc(length); + if (buffer == NULL) { + LOG_ERROR("Out of memory"); + return ERROR_FAIL; + } + + retval = flash_driver_read(p, buffer, offset, length); + if (retval != ERROR_OK) { + LOG_ERROR("Read error"); + free(buffer); + return retval; + } + + retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY); + if (retval != ERROR_OK) { + LOG_ERROR("Could not open file"); + free(buffer); + return retval; + } + + retval = fileio_write(&fileio, length, buffer, &written); + fileio_close(&fileio); + free(buffer); + if (retval != ERROR_OK) { + LOG_ERROR("Could not write file"); + return ERROR_FAIL; + } + + if (duration_measure(&bench) == ERROR_OK) + command_print(CMD_CTX, "wrote %ld bytes to file %s from flash bank %u" + " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + (long)written, CMD_ARGV[1], p->bank_number, offset, + duration_elapsed(&bench), duration_kbps(&bench, written)); + + return retval; +} + + +COMMAND_HANDLER(handle_flash_verify_bank_command) +{ + uint32_t offset; + uint8_t *buffer_file, *buffer_flash; + struct fileio fileio; + size_t read_cnt; + int filesize; + int differ; + + if (CMD_ARGC != 3) + return ERROR_COMMAND_SYNTAX_ERROR; + + struct duration bench; + duration_start(&bench); + + struct flash_bank *p; + int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); + if (ERROR_OK != retval) + return retval; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset); + + retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY); + if (retval != ERROR_OK) { + LOG_ERROR("Could not open file"); + return retval; + } + + retval = fileio_size(&fileio, &filesize); + if (retval != ERROR_OK) { + fileio_close(&fileio); + return retval; + } + + buffer_file = malloc(filesize); + if (buffer_file == NULL) { + LOG_ERROR("Out of memory"); + fileio_close(&fileio); + return ERROR_FAIL; + } + + retval = fileio_read(&fileio, filesize, buffer_file, &read_cnt); + fileio_close(&fileio); + if (retval != ERROR_OK) { + LOG_ERROR("File read failure"); + free(buffer_file); + return retval; + } + + if (read_cnt != (size_t) filesize) { + LOG_ERROR("Short read"); + free(buffer_file); + return ERROR_FAIL; + } + + buffer_flash = malloc(filesize); + if (buffer_flash == NULL) { + LOG_ERROR("Out of memory"); + free(buffer_file); + return ERROR_FAIL; + } + + retval = flash_driver_read(p, buffer_flash, offset, read_cnt); + if (retval != ERROR_OK) { + LOG_ERROR("Flash read error"); + free(buffer_flash); + free(buffer_file); + return retval; + } + + if (duration_measure(&bench) == ERROR_OK) + command_print(CMD_CTX, "read %ld bytes from file %s and flash bank %u" + " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + (long)read_cnt, CMD_ARGV[1], p->bank_number, offset, + duration_elapsed(&bench), duration_kbps(&bench, read_cnt)); + + differ = memcmp(buffer_file, buffer_flash, read_cnt); + command_print(CMD_CTX, "contents %s", differ ? "differ" : "match"); + if (differ) { + uint32_t t; + int diffs = 0; + for (t = 0; t < read_cnt; t++) { + if (buffer_flash[t] == buffer_file[t]) + continue; + command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x", + diffs, t + offset, buffer_flash[t], buffer_file[t]); + if (diffs++ >= 127) { + command_print(CMD_CTX, "More than 128 errors, the rest are not printed."); + break; + } + keep_alive(); + } + } + free(buffer_flash); + free(buffer_file); + + return differ ? ERROR_FAIL : ERROR_OK; +} + void flash_set_dirty(void) { struct flash_bank *c; @@ -726,6 +885,24 @@ static const struct command_registration flash_exec_command_handlers[] = { "and/or erase the region to be used. Allow optional " "offset from beginning of bank (defaults to zero)", }, + { + .name = "read_bank", + .handler = handle_flash_read_bank_command, + .mode = COMMAND_EXEC, + .usage = "bank_id filename offset length", + .help = "Read binary data from flash bank to file, " + "starting at specified byte offset from the " + "beginning of the bank.", + }, + { + .name = "verify_bank", + .handler = handle_flash_verify_bank_command, + .mode = COMMAND_EXEC, + .usage = "bank_id filename offset", + .help = "Read binary data from flash bank and file, " + "starting at specified byte offset from the " + "beginning of the bank. Compare the contents.", + }, { .name = "protect", .handler = handle_flash_protect_command, -- 2.30.2