X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fflash.c;h=2e7cc4537e2f7e41421bbe6b8536d71d22ef5217;hp=eaa1e17eecb2011a67768fddcd388d2c8b51d711;hb=1796e1602e9ffe1cbf35f1b001cb6a534bb2f738;hpb=4b97f3cbb9603c13f69f8d3b5371c12045593126 diff --git a/src/flash/flash.c b/src/flash/flash.c index eaa1e17eec..2e7cc4537e 100644 --- a/src/flash/flash.c +++ b/src/flash/flash.c @@ -25,6 +25,9 @@ #include "command.h" #include "target.h" #include "time_support.h" +#include "fileio.h" +#include "image.h" +#include "log.h" #include #include @@ -32,10 +35,7 @@ #include #include #include - -#include -#include -#include "log.h" +#include /* command handlers */ int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); @@ -43,10 +43,15 @@ int handle_flash_banks_command(struct command_context_s *cmd_ctx, char *cmd, cha int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_flash_write_binary_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_flash_auto_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr); /* flash drivers */ @@ -57,6 +62,8 @@ extern flash_driver_t str7x_flash; extern flash_driver_t str9x_flash; extern flash_driver_t stellaris_flash; extern flash_driver_t str9xpec_flash; +extern flash_driver_t stm32x_flash; +extern flash_driver_t tms470_flash; flash_driver_t *flash_drivers[] = { @@ -67,11 +74,14 @@ flash_driver_t *flash_drivers[] = &str9x_flash, &stellaris_flash, &str9xpec_flash, + &stm32x_flash, + &tms470_flash, NULL, }; flash_bank_t *flash_banks; static command_t *flash_cmd; +static int auto_erase = 0; int flash_register_commands(struct command_context_s *cmd_ctx) { @@ -82,7 +92,7 @@ int flash_register_commands(struct command_context_s *cmd_ctx) return ERROR_OK; } -int flash_init(struct command_context_s *cmd_ctx) +int flash_init_drivers(struct command_context_s *cmd_ctx) { if (flash_banks) { @@ -97,11 +107,21 @@ int flash_init(struct command_context_s *cmd_ctx) register_command(cmd_ctx, flash_cmd, "protect_check", handle_flash_protect_check_command, COMMAND_EXEC, "check protection state of sectors in flash bank "); register_command(cmd_ctx, flash_cmd, "erase", handle_flash_erase_command, COMMAND_EXEC, + "DEPRECATED, use 'erase_sector' instead"); + register_command(cmd_ctx, flash_cmd, "erase_sector", handle_flash_erase_command, COMMAND_EXEC, "erase sectors at "); - register_command(cmd_ctx, flash_cmd, "write", handle_flash_write_command, COMMAND_EXEC, + register_command(cmd_ctx, flash_cmd, "erase_address", handle_flash_erase_address_command, COMMAND_EXEC, + "erase address range
"); + register_command(cmd_ctx, flash_cmd, "write", handle_flash_write_binary_command, COMMAND_EXEC, + "DEPRECATED, use 'write_binary' instead"); + register_command(cmd_ctx, flash_cmd, "write_binary", handle_flash_write_binary_command, COMMAND_EXEC, "write binary "); + register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC, + "write_image [offset] [type]"); register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC, "set protection of sectors at "); + register_command(cmd_ctx, flash_cmd, "auto_erase", handle_flash_auto_erase_command, COMMAND_EXEC, + "auto erase flash sectors "); } return ERROR_OK; @@ -123,16 +143,24 @@ flash_bank_t *get_flash_bank_by_num(int num) return NULL; } -/* flash_bank [driver_options ...] +/* flash_bank [driver_options ...] */ int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { int i; int found = 0; + target_t *target; - if (argc < 5) + if (argc < 6) { WARNING("incomplete flash_bank configuration"); + WARNING("flash_bank [driver_options ...]"); + return ERROR_OK; + } + + if ((target = get_target_by_num(strtoul(args[5], NULL, 0))) == NULL) + { + ERROR("target %lu not defined", strtoul(args[5], NULL, 0)); return ERROR_OK; } @@ -150,12 +178,15 @@ int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char } c = malloc(sizeof(flash_bank_t)); + c->target = target; c->driver = flash_drivers[i]; c->driver_priv = NULL; c->base = strtoul(args[1], NULL, 0); c->size = strtoul(args[2], NULL, 0); c->chip_width = strtoul(args[3], NULL, 0); c->bus_width = strtoul(args[4], NULL, 0); + c->num_sectors = 0; + c->sectors = NULL; c->next = NULL; if (flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c) != ERROR_OK) @@ -224,9 +255,9 @@ int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char return ERROR_OK; } - for (p = flash_banks; p; p = p->next) + for (p = flash_banks; p; p = p->next, i++) { - if (i++ == strtoul(args[0], NULL, 0)) + if (i == strtoul(args[0], NULL, 0)) { char buf[1024]; @@ -250,8 +281,8 @@ int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char else protect_state = "protection state unknown"; - command_print(cmd_ctx, "\t#%i: 0x%8.8x (0x%xkB) %s, %s", - j, p->sectors[j].offset, p->sectors[j].size, + command_print(cmd_ctx, "\t#%i: 0x%8.8x (0x%x %ikB) %s, %s", + j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10, erase_state, protect_state); } @@ -332,6 +363,76 @@ int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cm return ERROR_OK; } +int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + flash_bank_t *p; + int retval; + int address; + int length; + duration_t duration; + char *duration_text; + + target_t *target = get_current_target(cmd_ctx); + + if (argc != 2) + { + command_print(cmd_ctx, "usage: flash erase_address
"); + return ERROR_OK; + } + + address = strtoul(args[0], NULL, 0); + length = strtoul(args[1], NULL, 0); + if (length <= 0) + { + command_print(cmd_ctx, "Length must be >0"); + return ERROR_INVALID_ARGUMENTS; + } + + p = get_flash_bank_by_addr(target, address); + if (p == NULL) + { + command_print(cmd_ctx, "No flash at that address"); + return ERROR_INVALID_ARGUMENTS; + } + + /* We can't know if we did a resume + halt, in which case we no longer know the erased state */ + flash_set_dirty(); + + duration_start_measure(&duration); + + if ((retval = flash_erase_address_range(target, address, length)) != ERROR_OK) + { + switch (retval) + { + case ERROR_TARGET_NOT_HALTED: + command_print(cmd_ctx, "can't work with this flash while target is running"); + break; + case ERROR_INVALID_ARGUMENTS: + command_print(cmd_ctx, "usage: flash erase_address
"); + break; + case ERROR_FLASH_BANK_INVALID: + command_print(cmd_ctx, "no '%s' flash found at 0x%8.8x", p->driver->name, p->base); + break; + case ERROR_FLASH_OPERATION_FAILED: + command_print(cmd_ctx, "flash erase error"); + break; + case ERROR_FLASH_SECTOR_INVALID: + command_print(cmd_ctx, "sector number(s) invalid"); + break; + default: + command_print(cmd_ctx, "unknown error"); + } + } + else + { + duration_stop_measure(&duration, &duration_text); + command_print(cmd_ctx, "erased address 0x%8.8x length %i in %s", address, length, duration_text); + free(duration_text); + } + + return retval; +} + int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { flash_bank_t *p; @@ -492,15 +593,102 @@ int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, c return ERROR_OK; } -int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + target_t *target = get_current_target(cmd_ctx); + + image_t image; + u32 written; + char *error_str; + int *failed; + + int i; + + duration_t duration; + char *duration_text; + + int retval; + + if (argc < 1) + { + command_print(cmd_ctx, "usage: flash %s [offset] [type]", cmd); + return ERROR_INVALID_ARGUMENTS; + } + + if (!target) + { + ERROR("no target selected"); + return ERROR_OK; + } + + duration_start_measure(&duration); + + if (argc >= 2) + { + image.base_address_set = 1; + image.base_address = strtoul(args[1], NULL, 0); + } + else + { + image.base_address_set = 0; + image.base_address = 0x0; + } + + image.start_address_set = 0; + + retval = image_open(&image, args[0], (argc == 3) ? args[2] : NULL); + if (retval != ERROR_OK) + { + command_print(cmd_ctx, "image_open error: %s", image.error_str); + return retval; + } + + failed = malloc(sizeof(int) * image.num_sections); + + error_str = NULL; + + retval = flash_write(target, &image, &written, &error_str, failed, auto_erase); + + if (retval != ERROR_OK) + { + if (error_str) + { + command_print(cmd_ctx, "failed writing image %s: %s", args[0], error_str); + free(error_str); + } + image_close(&image); + free(failed); + return retval; + } + + for (i = 0; i < image.num_sections; i++) + { + if (failed[i]) + { + command_print(cmd_ctx, "didn't write section at 0x%8.8x, size 0x%8.8x", + image.sections[i].base_address, image.sections[i].size); + } + } + + duration_stop_measure(&duration, &duration_text); + command_print(cmd_ctx, "wrote %u byte from file %s in %s (%f kb/s)", + written, args[0], duration_text, + (float)written / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0))); + free(duration_text); + free(failed); + + image_close(&image); + + return ERROR_OK; +} + +int handle_flash_write_binary_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { u32 offset; u8 *buffer; u32 buf_cnt; - u32 image_size; - int i; - image_t image; + fileio_t fileio; duration_t duration; char *duration_text; @@ -510,17 +698,12 @@ int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, cha if (argc < 3) { - command_print(cmd_ctx, "usage: flash write [type]"); + command_print(cmd_ctx, "usage: flash write_binary "); return ERROR_OK; } duration_start_measure(&duration); - image.base_address_set = 1; - image.base_address = strtoul(args[1], NULL, 0); - - image.start_address_set = 0; - offset = strtoul(args[2], NULL, 0); p = get_flash_bank_by_num(strtoul(args[0], NULL, 0)); if (!p) @@ -529,69 +712,336 @@ int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, cha return ERROR_OK; } - if (image_open(&image, args[1], (argc == 4) ? args[3] : NULL) != ERROR_OK) + if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK) { - command_print(cmd_ctx, "flash write error: %s", image.error_str); + command_print(cmd_ctx, "flash write_binary error: %s", fileio.error_str); return ERROR_OK; } - image_size = 0x0; - for (i = 0; i < image.num_sections; i++) + buffer = malloc(fileio.size); + if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK) + { + command_print(cmd_ctx, "flash write_binary error: %s", fileio.error_str); + return ERROR_OK; + } + + if ((retval = p->driver->write(p, buffer, offset, buf_cnt)) != ERROR_OK) { - buffer = malloc(image.sections[i].size); - if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK) + command_print(cmd_ctx, "failed writing file %s to flash bank %i at offset 0x%8.8x", + args[1], strtoul(args[0], NULL, 0), strtoul(args[2], NULL, 0)); + + switch (retval) { - ERROR("image_read_section failed with error code: %i", retval); - command_print(cmd_ctx, "image reading failed, flash write aborted"); - free(buffer); - image_close(&image); - return ERROR_OK; + case ERROR_TARGET_NOT_HALTED: + command_print(cmd_ctx, "can't work with this flash while target is running"); + break; + case ERROR_INVALID_ARGUMENTS: + command_print(cmd_ctx, "usage: flash write "); + break; + case ERROR_FLASH_BANK_INVALID: + command_print(cmd_ctx, "no '%s' flash found at 0x%8.8x", p->driver->name, p->base); + break; + case ERROR_FLASH_OPERATION_FAILED: + command_print(cmd_ctx, "flash program error"); + break; + case ERROR_FLASH_DST_BREAKS_ALIGNMENT: + command_print(cmd_ctx, "offset breaks required alignment"); + break; + case ERROR_FLASH_DST_OUT_OF_BANK: + command_print(cmd_ctx, "destination is out of flash bank (offset and/or file too large)"); + break; + case ERROR_FLASH_SECTOR_NOT_ERASED: + command_print(cmd_ctx, "destination sector(s) not erased"); + break; + default: + command_print(cmd_ctx, "unknown error"); } + } + + free(buffer); + + duration_stop_measure(&duration, &duration_text); + command_print(cmd_ctx, "wrote %"PRIi64" byte from file %s to flash bank %i at offset 0x%8.8x in %s (%f kb/s)", + fileio.size, args[1], strtoul(args[0], NULL, 0), offset, duration_text, + (float)fileio.size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0))); + free(duration_text); + + fileio_close(&fileio); + + return ERROR_OK; +} + +void flash_set_dirty(void) +{ + flash_bank_t *c; + int i; + + /* set all flash to require erasing */ + for (c = flash_banks; c; c = c->next) + { + for (i = 0; i < c->num_sectors; i++) + { + c->sectors[i].is_erased = 0; + } + } +} + +/* lookup flash bank by address */ +flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr) +{ + flash_bank_t *c; + + /* cycle through bank list */ + for (c = flash_banks; c; c = c->next) + { + /* check whether address belongs to this flash bank */ + if ((addr >= c->base) && (addr < c->base + c->size) && target == c->target) + return c; + } + + return NULL; +} + +/* erase given flash region, selects proper bank according to target and address */ +int flash_erase_address_range(target_t *target, u32 addr, u32 length) +{ + flash_bank_t *c; + int first = -1; + int last = -1; + int i; + + if ((c = get_flash_bank_by_addr(target, addr)) == NULL) + return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */ + + if (c->size == 0 || c->num_sectors == 0) + return ERROR_FLASH_BANK_INVALID; + + if (length == 0) + { + /* special case, erase whole bank when length is zero */ + if (addr != c->base) + return ERROR_FLASH_DST_BREAKS_ALIGNMENT; + + return c->driver->erase(c, 0, c->num_sectors - 1); + } + + /* check whether it fits */ + if (addr + length > c->base + c->size) + return ERROR_FLASH_DST_BREAKS_ALIGNMENT; + + addr -= c->base; + + for (i = 0; i < c->num_sectors; i++) + { + /* check whether sector overlaps with the given range and is not yet erased */ + if (addr < c->sectors[i].offset + c->sectors[i].size && addr + length > c->sectors[i].offset && c->sectors[i].is_erased != 1) { + /* if first is not set yet then this is the first sector */ + if (first == -1) + first = i; + last = i; /* and it is the last one so far in any case */ + } + } + + if( first == -1 || last == -1 ) + return ERROR_OK; + + return c->driver->erase(c, first, last); +} + +/* write (optional verify) an image to flash memory of the given target */ +int flash_write(target_t *target, image_t *image, u32 *written, char **error_str, int *failed, int erase) +{ + int retval; + int i; + + int section; + u32 section_offset; + flash_bank_t *c; + + section = 0; + section_offset = 0; + + if (written) + *written = 0; + + if (failed != NULL) + for (i = 0; i < image->num_sections; i++) + failed[i] = 0; + + if (erase) + { + /* assume all sectors need erasing - stops any problems + * when flash_write is called multiple times */ - if ((retval = p->driver->write(p, buffer, offset, buf_cnt)) != ERROR_OK) + flash_set_dirty(); + } + + /* loop until we reach end of the image */ + while (section < image->num_sections) + { + u32 buffer_size; + u8 *buffer; + int section_first; + int section_last; + u32 run_address = image->sections[section].base_address + section_offset; + u32 run_size = image->sections[section].size - section_offset; + + if (image->sections[section].size == 0) { - command_print(cmd_ctx, "failed writing file %s to flash bank %i at offset 0x%8.8x", - args[1], strtoul(args[0], NULL, 0), strtoul(args[2], NULL, 0)); + WARNING("empty section %d", section); + section++; + section_offset = 0; + continue; + } + + /* find the corresponding flash bank */ + if ((c = get_flash_bank_by_addr(target, run_address)) == NULL) + { + if (failed == NULL) + { + if (error_str == NULL) + return ERROR_FLASH_DST_OUT_OF_BANK; /* abort operation */ + *error_str = malloc(FLASH_MAX_ERROR_STR); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "no flash mapped at requested address"); + return ERROR_FLASH_DST_OUT_OF_BANK; /* abort operation */ + } + failed[section] = ERROR_FLASH_DST_OUT_OF_BANK; /* mark the section as failed */ + section++; /* and skip it */ + section_offset = 0; + continue; + } + + /* collect consecutive sections which fall into the same bank */ + section_first = section; + section_last = section; + while ((run_address + run_size < c->base + c->size) + && (section_last + 1 < image->num_sections)) + { + if (image->sections[section_last + 1].base_address < (run_address + run_size)) + { + DEBUG("section %d out of order(very slightly surprising, but supported)", section_last + 1); + break; + } + if (image->sections[section_last + 1].base_address != (run_address + run_size)) + break; + run_size += image->sections[++section_last].size; + } + + /* fit the run into bank constraints */ + if (run_address + run_size > c->base + c->size) + run_size = c->base + c->size - run_address; + + /* allocate buffer */ + buffer = malloc(run_size); + buffer_size = 0; + + /* read sections to the buffer */ + while (buffer_size < run_size) + { + u32 size_read; + + if (buffer_size - run_size <= image->sections[section].size - section_offset) + size_read = buffer_size - run_size; + else + size_read = image->sections[section].size - section_offset; + + if ((retval = image_read_section(image, section, section_offset, + size_read, buffer + buffer_size, &size_read)) != ERROR_OK || size_read == 0) + { + free(buffer); + + if (error_str == NULL) + return ERROR_IMAGE_TEMPORARILY_UNAVAILABLE; + + *error_str = malloc(FLASH_MAX_ERROR_STR); + + /* if image_read_section returned an error there's an error string we can pass on */ + if (retval != ERROR_OK) + snprintf(*error_str, FLASH_MAX_ERROR_STR, "error reading from image: %s", image->error_str); + else + snprintf(*error_str, FLASH_MAX_ERROR_STR, "error reading from image"); + + return ERROR_IMAGE_TEMPORARILY_UNAVAILABLE; + } + + buffer_size += size_read; + section_offset += size_read; + + if (section_offset >= image->sections[section].size) + { + section++; + section_offset = 0; + } + } + + retval = ERROR_OK; + + if (erase) + { + /* calculate and erase sectors */ + retval = flash_erase_address_range( target, run_address, run_size ); + } + + if (retval == ERROR_OK) + { + /* write flash sectors */ + retval = c->driver->write(c, buffer, run_address - c->base, run_size); + } + + free(buffer); + + if (retval != ERROR_OK) + { + if (error_str == NULL) + return retval; /* abort operation */ + + *error_str = malloc(FLASH_MAX_ERROR_STR); switch (retval) { case ERROR_TARGET_NOT_HALTED: - command_print(cmd_ctx, "can't work with this flash while target is running"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "can't flash image while target is running"); break; case ERROR_INVALID_ARGUMENTS: - command_print(cmd_ctx, "usage: flash write "); - break; - case ERROR_FLASH_BANK_INVALID: - command_print(cmd_ctx, "no '%s' flash found at 0x%8.8x", p->driver->name, p->base); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "flash driver can't fulfill request"); break; case ERROR_FLASH_OPERATION_FAILED: - command_print(cmd_ctx, "flash program error"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "flash program error"); break; case ERROR_FLASH_DST_BREAKS_ALIGNMENT: - command_print(cmd_ctx, "offset breaks required alignment"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "offset breaks required alignment"); break; case ERROR_FLASH_DST_OUT_OF_BANK: - command_print(cmd_ctx, "destination is out of flash bank (offset and/or file too large)"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "no flash mapped at requested address"); break; case ERROR_FLASH_SECTOR_NOT_ERASED: - command_print(cmd_ctx, "destination sector(s) not erased"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "destination sector(s) not erased"); break; default: - command_print(cmd_ctx, "unknown error"); + snprintf(*error_str, FLASH_MAX_ERROR_STR, "unknown error: %i", retval); } + + return retval; /* abort operation */ } - image_size += buf_cnt; - free(buffer); + if (written != NULL) + *written += run_size; /* add run size to total written counter */ } - - duration_stop_measure(&duration, &duration_text); - command_print(cmd_ctx, "wrote %u byte from file %s to flash bank %i at offset 0x%8.8x in %s (%f kb/s)", - image_size, args[1], strtoul(args[0], NULL, 0), offset, duration_text, - (float)image_size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0))); - free(duration_text); + return ERROR_OK; +} - image_close(&image); +int handle_flash_auto_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + if (argc != 1) + { + command_print(cmd_ctx, "usage: flash auto_erase "); + return ERROR_OK; + } + + if (strcmp(args[0], "on") == 0) + auto_erase = 1; + else if (strcmp(args[0], "off") == 0) + auto_erase = 0; return ERROR_OK; }