diff options
Diffstat (limited to 'src/flash/nor/tcl.c')
| -rw-r--r-- | src/flash/nor/tcl.c | 725 |
1 files changed, 725 insertions, 0 deletions
diff --git a/src/flash/nor/tcl.c b/src/flash/nor/tcl.c index b00516d9..6598652c 100644 --- a/src/flash/nor/tcl.c +++ b/src/flash/nor/tcl.c @@ -23,6 +23,731 @@ #include "config.h" #endif #include "imp.h" +#include <helper/time_support.h> +#include <target/image.h> + +COMMAND_HELPER(flash_command_get_bank, unsigned name_index, + struct flash_bank **bank) +{ + const char *name = CMD_ARGV[name_index]; + *bank = get_flash_bank_by_name(name); + if (*bank) + return ERROR_OK; + + unsigned bank_num; + COMMAND_PARSE_NUMBER(uint, name, bank_num); + + *bank = get_flash_bank_by_num(bank_num); + if (!*bank) + { + command_print(CMD_CTX, "flash bank '%s' not found", name); + return ERROR_INVALID_ARGUMENTS; + } + return ERROR_OK; +} + + +COMMAND_HANDLER(handle_flash_info_command) +{ + struct flash_bank *p; + uint32_t i = 0; + int j = 0; + int retval; + + if (CMD_ARGC != 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + unsigned bank_nr; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr); + + for (p = flash_bank_list(); p; p = p->next, i++) + { + if (i != bank_nr) + continue; + + char buf[1024]; + + /* attempt auto probe */ + if ((retval = p->driver->auto_probe(p)) != ERROR_OK) + return retval; + + command_print(CMD_CTX, + "#%" PRIi32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i", + i, + p->driver->name, + p->base, + 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) + protect_state = "not protected"; + else if (p->sectors[j].is_protected == 1) + protect_state = "protected"; + else + 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, + 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 (%d)", retval); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_probe_command) +{ + int retval; + + if (CMD_ARGC != 1) + { + return ERROR_COMMAND_SYNTAX_ERROR; + } + + unsigned bank_nr; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr); + struct flash_bank *p = get_flash_bank_by_num_noprobe(bank_nr); + if (p) + { + if ((retval = p->driver->probe(p)) == ERROR_OK) + { + command_print(CMD_CTX, "flash '%s' found at 0x%8.8" PRIx32, p->driver->name, p->base); + } + else if (retval == ERROR_FLASH_BANK_INVALID) + { + command_print(CMD_CTX, "probing failed for flash bank '#%s' at 0x%8.8" PRIx32, + CMD_ARGV[0], p->base); + } + else + { + command_print(CMD_CTX, "unknown error when probing flash bank '#%s' at 0x%8.8" PRIx32, + CMD_ARGV[0], p->base); + } + } + else + { + command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_erase_check_command) +{ + if (CMD_ARGC != 1) + { + 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; + + int j; + if ((retval = p->driver->erase_check(p)) == ERROR_OK) + { + command_print(CMD_CTX, "successfully checked erase state"); + } + else + { + command_print(CMD_CTX, "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32, + CMD_ARGV[0], p->base); + } + + for (j = 0; j < p->num_sectors; j++) + { + char *erase_state; + + if (p->sectors[j].is_erased == 0) + erase_state = "not erased"; + else if (p->sectors[j].is_erased == 1) + erase_state = "erased"; + else + erase_state = "erase 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, + erase_state); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_erase_address_command) +{ + struct flash_bank *p; + int retval; + int address; + int length; + + struct target *target = get_current_target(CMD_CTX); + + if (CMD_ARGC != 2) + return ERROR_COMMAND_SYNTAX_ERROR; + + COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], address); + COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], length); + if (length <= 0) + { + command_print(CMD_CTX, "Length must be >0"); + return ERROR_COMMAND_SYNTAX_ERROR; + } + + p = get_flash_bank_by_addr(target, address); + if (p == NULL) + { + return ERROR_FAIL; + } + + /* We can't know if we did a resume + halt, in which case we no longer know the erased state */ + flash_set_dirty(); + + struct duration bench; + duration_start(&bench); + + retval = flash_erase_address_range(target, address, length); + + if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) + { + command_print(CMD_CTX, "erased address 0x%8.8x (length %i)" + " in %fs (%0.3f kb/s)", address, length, + duration_elapsed(&bench), duration_kbps(&bench, length)); + } + + return retval; +} + +COMMAND_HANDLER(handle_flash_protect_check_command) +{ + if (CMD_ARGC != 1) + 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; + + if ((retval = p->driver->protect_check(p)) == ERROR_OK) + { + command_print(CMD_CTX, "successfully checked protect state"); + } + else if (retval == ERROR_FLASH_OPERATION_FAILED) + { + command_print(CMD_CTX, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8" PRIx32, CMD_ARGV[0], p->base); + } + else + { + command_print(CMD_CTX, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8" PRIx32, CMD_ARGV[0], p->base); + } + + return ERROR_OK; +} + +static int flash_check_sector_parameters(struct command_context *cmd_ctx, + uint32_t first, uint32_t last, uint32_t num_sectors) +{ + if (!(first <= last)) { + command_print(cmd_ctx, "ERROR: " + "first sector must be <= last sector"); + return ERROR_FAIL; + } + + if (!(last <= (num_sectors - 1))) { + command_print(cmd_ctx, "ERROR: last sector must be <= %d", + (int) num_sectors - 1); + return ERROR_FAIL; + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_erase_command) +{ + if (CMD_ARGC != 3) + return ERROR_COMMAND_SYNTAX_ERROR; + + uint32_t bank_nr; + uint32_t first; + uint32_t last; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr); + struct flash_bank *p = get_flash_bank_by_num(bank_nr); + if (!p) + return ERROR_OK; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first); + if (strcmp(CMD_ARGV[2], "last") == 0) + last = p->num_sectors - 1; + else + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last); + + int retval; + if ((retval = flash_check_sector_parameters(CMD_CTX, + first, last, p->num_sectors)) != ERROR_OK) + return retval; + + struct duration bench; + duration_start(&bench); + + retval = flash_driver_erase(p, first, last); + + if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) + { + command_print(CMD_CTX, "erased sectors %" PRIu32 " " + "through %" PRIu32" on flash bank %" PRIu32 " " + "in %fs", first, last, bank_nr, duration_elapsed(&bench)); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_protect_command) +{ + if (CMD_ARGC != 4) + return ERROR_COMMAND_SYNTAX_ERROR; + + uint32_t bank_nr; + uint32_t first; + uint32_t last; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr); + struct flash_bank *p = get_flash_bank_by_num(bank_nr); + if (!p) + return ERROR_OK; + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first); + if (strcmp(CMD_ARGV[2], "last") == 0) + last = p->num_sectors - 1; + else + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last); + + bool set; + COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set); + + int retval; + if ((retval = flash_check_sector_parameters(CMD_CTX, + first, last, p->num_sectors)) != 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 %i", + (set) ? "set" : "cleared", (int) first, + (int) last, (int) bank_nr); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_flash_write_image_command) +{ + struct target *target = get_current_target(CMD_CTX); + + struct image image; + uint32_t written; + + 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 (;;) + { + if (strcmp(CMD_ARGV[0], "erase") == 0) + { + auto_erase = 1; + CMD_ARGV++; + CMD_ARGC--; + command_print(CMD_CTX, "auto erase enabled"); + } else if (strcmp(CMD_ARGV[0], "unlock") == 0) + { + auto_unlock = true; + CMD_ARGV++; + CMD_ARGC--; + command_print(CMD_CTX, "auto unlock enabled"); + } else + { + break; + } + } + + 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(int, 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(target, &image, &written, auto_erase, auto_unlock); + if (retval != ERROR_OK) + { + image_close(&image); + return retval; + } + + if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) + { + command_print(CMD_CTX, "wrote %" PRIu32 " byte from file %s " + "in %fs (%0.3f kb/s)", written, CMD_ARGV[0], + duration_elapsed(&bench), duration_kbps(&bench, written)); + } + + image_close(&image); + + return retval; +} + +COMMAND_HANDLER(handle_flash_fill_command) +{ + int err = ERROR_OK; + uint32_t address; + uint32_t pattern; + uint32_t count; + uint32_t wrote = 0; + uint32_t cur_size = 0; + uint32_t chunk_count; + struct target *target = get_current_target(CMD_CTX); + uint32_t i; + uint32_t wordsize; + int retval = ERROR_OK; + + static size_t const chunksize = 1024; + uint8_t *chunk = malloc(chunksize); + if (chunk == NULL) + return ERROR_FAIL; + + uint8_t *readback = malloc(chunksize); + if (readback == NULL) + { + free(chunk); + return ERROR_FAIL; + } + + + if (CMD_ARGC != 3) + { + retval = ERROR_COMMAND_SYNTAX_ERROR; + goto done; + } + + + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address); + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern); + COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count); + + if (count == 0) + goto done; + + switch (CMD_NAME[4]) + { + case 'w': + wordsize = 4; + break; + case 'h': + wordsize = 2; + break; + case 'b': + wordsize = 1; + break; + default: + retval = ERROR_COMMAND_SYNTAX_ERROR; + goto done; + } + + chunk_count = MIN(count, (chunksize / wordsize)); + switch (wordsize) + { + case 4: + for (i = 0; i < chunk_count; i++) + { + target_buffer_set_u32(target, chunk + i * wordsize, pattern); + } + break; + case 2: + for (i = 0; i < chunk_count; i++) + { + target_buffer_set_u16(target, chunk + i * wordsize, pattern); + } + break; + case 1: + memset(chunk, pattern, chunk_count); + break; + default: + LOG_ERROR("BUG: can't happen"); + exit(-1); + } + + struct duration bench; + duration_start(&bench); + + for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) + { + cur_size = MIN((count*wordsize - wrote), sizeof(chunk)); + struct flash_bank *bank; + bank = get_flash_bank_by_addr(target, address); + if (bank == NULL) + { + retval = ERROR_FAIL; + goto done; + } + err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size); + if (err != ERROR_OK) + { + retval = err; + goto done; + } + + err = target_read_buffer(target, address + wrote, cur_size, readback); + if (err != ERROR_OK) + { + retval = err; + goto done; + } + + unsigned i; + for (i = 0; i < cur_size; i++) + { + if (readback[i]!=chunk[i]) + { + LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x", + address + wrote + i, readback[i], chunk[i]); + retval = ERROR_FAIL; + goto done; + } + } + } + + if (duration_measure(&bench) == ERROR_OK) + { + command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32 + " in %fs (%0.3f kb/s)", wrote, address, + duration_elapsed(&bench), duration_kbps(&bench, wrote)); + } + + done: + free(readback); + free(chunk); + + return retval; +} + +COMMAND_HANDLER(handle_flash_write_bank_command) +{ + uint32_t offset; + uint8_t *buffer; + struct fileio fileio; + + 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); + + if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK) + { + return ERROR_OK; + } + + buffer = malloc(fileio.size); + size_t buf_cnt; + if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK) + { + free(buffer); + fileio_close(&fileio); + return ERROR_OK; + } + + retval = flash_driver_write(p, buffer, offset, buf_cnt); + + free(buffer); + buffer = NULL; + + if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) + { + command_print(CMD_CTX, "wrote %zu byte from file %s to flash bank %u" + " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)", + fileio.size, CMD_ARGV[1], p->bank_number, offset, + duration_elapsed(&bench), duration_kbps(&bench, fileio.size)); + } + + fileio_close(&fileio); + + return retval; +} + +void flash_set_dirty(void) +{ + struct flash_bank *c; + int i; + + /* set all flash to require erasing */ + for (c = flash_bank_list(); c; c = c->next) + { + for (i = 0; i < c->num_sectors; i++) + { + c->sectors[i].is_erased = 0; + } + } +} + +static const struct command_registration flash_exec_command_handlers[] = { + { + .name = "probe", + .handler = &handle_flash_probe_command, + .mode = COMMAND_EXEC, + .usage = "<bank>", + .help = "identify flash bank", + }, + { + .name = "info", + .handler = &handle_flash_info_command, + .mode = COMMAND_EXEC, + .usage = "<bank>", + .help = "print bank information", + }, + { + .name = "erase_check", + .handler = &handle_flash_erase_check_command, + .mode = COMMAND_EXEC, + .usage = "<bank>", + .help = "check erase state of sectors", + }, + { + .name = "protect_check", + .handler = &handle_flash_protect_check_command, + .mode = COMMAND_EXEC, + .usage = "<bank>", + .help = "check protection state of sectors", + }, + { + .name = "erase_sector", + .handler = &handle_flash_erase_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <first> <last>", + .help = "erase sectors", + }, + { + .name = "erase_address", + .handler = &handle_flash_erase_address_command, + .mode = COMMAND_EXEC, + .usage = "<address> <length>", + .help = "erase address range", + + }, + { + .name = "fillw", + .handler = &handle_flash_fill_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <address> <word_pattern> <count>", + .help = "fill with pattern (no autoerase)", + }, + { + .name = "fillh", + .handler = &handle_flash_fill_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <address> <halfword_pattern> <count>", + .help = "fill with pattern", + }, + { + .name = "fillb", + .handler = &handle_flash_fill_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <address> <byte_pattern> <count>", + .help = "fill with pattern", + + }, + { + .name = "write_bank", + .handler = &handle_flash_write_bank_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <file> <offset>", + .help = "write binary data", + }, + { + .name = "write_image", + .handler = &handle_flash_write_image_command, + .mode = COMMAND_EXEC, + .usage = "<bank> [erase] [unlock] <file> [offset] [type]", + .help = "write an image to flash" + }, + { + .name = "protect", + .handler = &handle_flash_protect_command, + .mode = COMMAND_EXEC, + .usage = "<bank> <first> <last> <on | off>", + .help = "set protection of sectors", + }, + COMMAND_REGISTRATION_DONE +}; + +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); +} + COMMAND_HANDLER(handle_flash_bank_command) { |