X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fnor%2Ftcl.c;h=b93d12694b0edc4d4e6a95c92877f5f8b77da376;hp=57c3be508de6551c64bfdd3267bcc4cf04932a1c;hb=45f0e6d0626e4541158198c271519175ae79f5b5;hpb=08d4411b59dd8bd0e7d8009003b71d23acbf6eee diff --git a/src/flash/nor/tcl.c b/src/flash/nor/tcl.c index 57c3be508d..b93d12694b 100644 --- a/src/flash/nor/tcl.c +++ b/src/flash/nor/tcl.c @@ -15,9 +15,7 @@ * 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., * - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * + * along with this program. If not, see . * ***************************************************************************/ #ifdef HAVE_CONFIG_H #include "config.h" @@ -31,11 +29,18 @@ * Implements Tcl commands used to access NOR flash facilities. */ -COMMAND_HELPER(flash_command_get_bank, unsigned name_index, - struct flash_bank **bank) +COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index, + struct flash_bank **bank, bool do_probe) { const char *name = CMD_ARGV[name_index]; - int retval = get_flash_bank_by_name(name, bank); + int retval; + if (do_probe) { + retval = get_flash_bank_by_name(name, bank); + } else { + *bank = get_flash_bank_by_name_noprobe(name); + retval = ERROR_OK; + } + if (retval != ERROR_OK) return retval; if (*bank) @@ -44,7 +49,20 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index, unsigned bank_num; COMMAND_PARSE_NUMBER(uint, name, bank_num); - return get_flash_bank_by_num(bank_num, bank); + if (do_probe) { + return get_flash_bank_by_num(bank_num, bank); + } else { + *bank = get_flash_bank_by_num_noprobe(bank_num); + retval = (bank) ? ERROR_OK : ERROR_FAIL; + return retval; + } +} + +COMMAND_HELPER(flash_command_get_bank, unsigned name_index, + struct flash_bank **bank) +{ + return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, + name_index, bank, true); } COMMAND_HANDLER(handle_flash_info_command) @@ -52,16 +70,27 @@ COMMAND_HANDLER(handle_flash_info_command) struct flash_bank *p; int j = 0; int retval; + bool show_sectors = false; + bool prot_block_available; - if (CMD_ARGC != 1) + if (CMD_ARGC < 1 || CMD_ARGC > 2) return ERROR_COMMAND_SYNTAX_ERROR; + if (CMD_ARGC == 2) { + if (strcmp("sectors", CMD_ARGV[1]) == 0) + show_sectors = true; + else + return ERROR_COMMAND_SYNTAX_ERROR; + } + retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); if (retval != ERROR_OK) return retval; if (p != NULL) { char buf[1024]; + int num_blocks; + struct flash_sector *block_array; /* attempt auto probe */ retval = p->driver->auto_probe(p); @@ -74,7 +103,7 @@ COMMAND_HANDLER(handle_flash_info_command) return retval; command_print(CMD_CTX, - "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 + "#%d : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i", p->bank_number, p->driver->name, @@ -82,31 +111,42 @@ COMMAND_HANDLER(handle_flash_info_command) p->size, p->bus_width, p->chip_width); - for (j = 0; j < p->num_sectors; j++) { - char *protect_state; - if (p->sectors[j].is_protected == 0) + prot_block_available = p->num_prot_blocks && p->prot_blocks; + if (!show_sectors && prot_block_available) { + block_array = p->prot_blocks; + num_blocks = p->num_prot_blocks; + } else { + block_array = p->sectors; + num_blocks = p->num_sectors; + } + + for (j = 0; j < num_blocks; j++) { + char *protect_state = ""; + + if (block_array[j].is_protected == 0) protect_state = "not protected"; - else if (p->sectors[j].is_protected == 1) + else if (block_array[j].is_protected == 1) protect_state = "protected"; - else + else if (!show_sectors || !prot_block_available) protect_state = "protection state unknown"; command_print(CMD_CTX, "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s", j, - p->sectors[j].offset, - p->sectors[j].size, - p->sectors[j].size >> 10, + block_array[j].offset, + block_array[j].size, + block_array[j].size >> 10, protect_state); } - *buf = '\0'; /* initialize buffer, otherwise it migh contain garbage if driver - *function fails */ - retval = p->driver->info(p, buf, sizeof(buf)); - command_print(CMD_CTX, "%s", buf); - if (retval != ERROR_OK) - LOG_ERROR("error retrieving flash info"); + if (p->driver->info != NULL) { + retval = p->driver->info(p, buf, sizeof(buf)); + if (retval == ERROR_OK) + command_print(CMD_CTX, "%s", buf); + else + LOG_ERROR("error retrieving flash info"); + } } return retval; @@ -120,7 +160,7 @@ COMMAND_HANDLER(handle_flash_probe_command) if (CMD_ARGC != 1) return ERROR_COMMAND_SYNTAX_ERROR; - retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); + retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false); if (retval != ERROR_OK) return retval; @@ -141,6 +181,7 @@ COMMAND_HANDLER(handle_flash_probe_command) COMMAND_HANDLER(handle_flash_erase_check_command) { + bool blank = true; if (CMD_ARGC != 1) return ERROR_COMMAND_SYNTAX_ERROR; @@ -166,10 +207,11 @@ COMMAND_HANDLER(handle_flash_erase_check_command) if (p->sectors[j].is_erased == 0) erase_state = "not erased"; else if (p->sectors[j].is_erased == 1) - erase_state = "erased"; + continue; else erase_state = "erase state unknown"; + blank = false; command_print(CMD_CTX, "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s", j, @@ -179,6 +221,8 @@ COMMAND_HANDLER(handle_flash_erase_check_command) erase_state); } + if (blank) + command_print(CMD_CTX, "\tBank is erased"); return retval; } @@ -235,7 +279,7 @@ COMMAND_HANDLER(handle_flash_erase_address_command) retval = flash_erase_address_range(target, do_pad, address, length); if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) { - command_print(CMD_CTX, "erased address 0x%8.8x (length %i)" + command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")" " in %fs (%0.3f KiB/s)", address, length, duration_elapsed(&bench), duration_kbps(&bench, length)); } @@ -253,8 +297,8 @@ static int flash_check_sector_parameters(struct command_context *cmd_ctx, } if (!(last <= (num_sectors - 1))) { - command_print(cmd_ctx, "ERROR: last sector must be <= %d", - (int) num_sectors - 1); + command_print(cmd_ctx, "ERROR: last sector must be <= %" PRIu32, + num_sectors - 1); return ERROR_FAIL; } @@ -293,11 +337,11 @@ COMMAND_HANDLER(handle_flash_erase_command) if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) { command_print(CMD_CTX, "erased sectors %" PRIu32 " " - "through %" PRIu32 " on flash bank %" PRIu32 " " + "through %" PRIu32 " on flash bank %d " "in %fs", first, last, p->bank_number, duration_elapsed(&bench)); } - return ERROR_OK; + return retval; } COMMAND_HANDLER(handle_flash_protect_command) @@ -310,30 +354,35 @@ COMMAND_HANDLER(handle_flash_protect_command) struct flash_bank *p; int retval; + int num_blocks; retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); if (retval != ERROR_OK) return retval; + if (p->num_prot_blocks) + num_blocks = p->num_prot_blocks; + else + num_blocks = p->num_sectors; + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first); if (strcmp(CMD_ARGV[2], "last") == 0) - last = p->num_sectors - 1; + last = num_blocks - 1; else COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last); bool set; COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set); - retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors); + retval = flash_check_sector_parameters(CMD_CTX, first, last, num_blocks); if (retval != ERROR_OK) return retval; retval = flash_driver_protect(p, set, first, last); if (retval == ERROR_OK) { - command_print(CMD_CTX, "%s protection for sectors %i " - "through %i on flash bank %" PRIu32 "", - (set) ? "set" : "cleared", (int) first, - (int) last, p->bank_number); + command_print(CMD_CTX, "%s protection for sectors %" PRIu32 + " through %" PRIu32 " on flash bank %d", + (set) ? "set" : "cleared", first, last, p->bank_number); } return retval; @@ -348,14 +397,11 @@ COMMAND_HANDLER(handle_flash_write_image_command) int retval; - if (CMD_ARGC < 1) - return ERROR_COMMAND_SYNTAX_ERROR; - /* flash auto-erase is disabled by default*/ int auto_erase = 0; bool auto_unlock = false; - for (;; ) { + while (CMD_ARGC) { if (strcmp(CMD_ARGV[0], "erase") == 0) { auto_erase = 1; CMD_ARGV++; @@ -537,7 +583,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command) { uint32_t offset; uint8_t *buffer; - struct fileio fileio; + struct fileio *fileio; if (CMD_ARGC != 3) return ERROR_COMMAND_SYNTAX_ERROR; @@ -553,26 +599,26 @@ COMMAND_HANDLER(handle_flash_write_bank_command) COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset); if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK) - return ERROR_OK; + return ERROR_FAIL; - int filesize; - retval = fileio_size(&fileio, &filesize); + size_t filesize; + retval = fileio_size(fileio, &filesize); if (retval != ERROR_OK) { - fileio_close(&fileio); + fileio_close(fileio); return retval; } buffer = malloc(filesize); if (buffer == NULL) { - fileio_close(&fileio); + fileio_close(fileio); LOG_ERROR("Out of memory"); return ERROR_FAIL; } size_t buf_cnt; - if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK) { + if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) { free(buffer); - fileio_close(&fileio); - return ERROR_OK; + fileio_close(fileio); + return ERROR_FAIL; } retval = flash_driver_write(p, buffer, offset, buf_cnt); @@ -581,17 +627,185 @@ COMMAND_HANDLER(handle_flash_write_bank_command) buffer = NULL; if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) { - command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u" + command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u" " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", - (long)filesize, CMD_ARGV[1], p->bank_number, offset, + filesize, CMD_ARGV[1], p->bank_number, offset, duration_elapsed(&bench), duration_kbps(&bench, filesize)); } - fileio_close(&fileio); + fileio_close(fileio); 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 %zd bytes to file %s from flash bank %u" + " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + 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; + size_t filesize; + int differ; + + if (CMD_ARGC < 2 || 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; + + offset = 0; + + if (CMD_ARGC > 2) + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset); + + if (offset > p->size) { + LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank", + offset); + return ERROR_COMMAND_ARGUMENT_INVALID; + } + + 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 != 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 %zd bytes from file %s and flash bank %u" + " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + 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; @@ -604,6 +818,24 @@ void flash_set_dirty(void) } } +COMMAND_HANDLER(handle_flash_padded_value_command) +{ + if (CMD_ARGC != 2) + return ERROR_COMMAND_SYNTAX_ERROR; + + struct flash_bank *p; + int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p); + if (ERROR_OK != retval) + return retval; + + COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value); + + command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \ + p->default_padded_value, p->bank_number); + + return retval; +} + static const struct command_registration flash_exec_command_handlers[] = { { .name = "probe", @@ -616,7 +848,7 @@ static const struct command_registration flash_exec_command_handlers[] = { .name = "info", .handler = handle_flash_info_command, .mode = COMMAND_EXEC, - .usage = "bank_id", + .usage = "bank_id ['sectors']", .help = "Print information about a flash bank.", }, { @@ -690,14 +922,40 @@ 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 = "Compare the contents of a file with the contents of the " + "flash bank. Allow optional offset from beginning of the bank " + "(defaults to zero).", + }, { .name = "protect", .handler = handle_flash_protect_command, .mode = COMMAND_EXEC, - .usage = "bank_id first_sector [last_sector|'last'] " + .usage = "bank_id first_block [last_block|'last'] " "('on'|'off')", - .help = "Turn protection on or off for a range of sectors " - "in a given flash bank.", + .help = "Turn protection on or off for a range of protection " + "blocks or sectors in a given flash bank. " + "See 'flash info' output for a list of blocks.", + }, + { + .name = "padded_value", + .handler = handle_flash_padded_value_command, + .mode = COMMAND_EXEC, + .usage = "bank_id value", + .help = "Set default flash padded value", }, COMMAND_REGISTRATION_DONE }; @@ -711,7 +969,6 @@ static int flash_init_drivers(struct command_context *cmd_ctx) return register_commands(cmd_ctx, parent, flash_exec_command_handlers); } - COMMAND_HANDLER(handle_flash_bank_command) { if (CMD_ARGC < 7) { @@ -764,14 +1021,17 @@ COMMAND_HANDLER(handle_flash_bank_command) COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size); COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width); COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width); + c->default_padded_value = c->erased_value = 0xff; c->num_sectors = 0; c->sectors = NULL; + c->num_prot_blocks = 0; + c->prot_blocks = NULL; c->next = NULL; int retval; retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c); if (ERROR_OK != retval) { - LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "Usage %s", + LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "; usage: %s", driver_name, c->base, driver->usage); free(c); return retval; @@ -792,7 +1052,7 @@ COMMAND_HANDLER(handle_flash_banks_command) unsigned n = 0; for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) { - LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", " + LOG_USER("#%d : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", " "buswidth %u, chipwidth %u", p->bank_number, p->name, p->driver->name, p->base, p->size, p->bus_width, p->chip_width);