- update jtag_speed setting when changing it during runtime with a FT2232 based interface
[openocd.git] / src / flash / flash.c
index 3c368f3f3532552295fbf1efc369fc006e39f7f5..9ca5f157be9aa1449aa8f1c66d2e2cd2e4dc58c4 100644 (file)
 
 #include "flash.h"
 #include "command.h"
-#include "log.h"
 #include "target.h"
 #include "time_support.h"
+#include "fileio.h"
+#include "image.h"
+#include "log.h"
 
 #include <string.h>
 #include <unistd.h>
@@ -33,9 +35,7 @@
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <errno.h>
-
-#include <fileio.h>
-#include <image.h>
+#include <inttypes.h>
 
 /* command handlers */
 int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
@@ -46,6 +46,8 @@ int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cm
 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);
 
 /* flash drivers
@@ -56,6 +58,8 @@ extern flash_driver_t at91sam7_flash;
 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;
 
 flash_driver_t *flash_drivers[] =
 {
@@ -65,6 +69,8 @@ flash_driver_t *flash_drivers[] =
        &str7x_flash,
        &str9x_flash,
        &stellaris_flash,
+       &str9xpec_flash,
+       &stm32x_flash,
        NULL,
 };
 
@@ -96,8 +102,12 @@ int flash_init(struct command_context_s *cmd_ctx)
                                                 "check protection state of sectors in flash bank <num>");
                register_command(cmd_ctx, flash_cmd, "erase", handle_flash_erase_command, COMMAND_EXEC,
                                                 "erase sectors at <bank> <first> <last>");
-               register_command(cmd_ctx, flash_cmd, "write", handle_flash_write_command, COMMAND_EXEC,
+               register_command(cmd_ctx, flash_cmd, "write", handle_flash_write_binary_command, COMMAND_EXEC,
+                                                "DEPRECATED, use 'write_binary' or 'write_image' instead");
+               register_command(cmd_ctx, flash_cmd, "write_binary", handle_flash_write_binary_command, COMMAND_EXEC,
                                                 "write binary <bank> <file> <offset>");
+               register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
+                                                "write image <file> [offset] [type]");
                register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC,
                                                 "set protection of sectors at <bank> <first> <last> <on|off>");
        }
@@ -121,16 +131,24 @@ flash_bank_t *get_flash_bank_by_num(int num)
        return NULL;
 }
 
-/* flash_bank <driver> <base> <size> <chip_width> <bus_width> [driver_options ...]
+/* flash_bank <driver> <base> <size> <chip_width> <bus_width> <target> [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> <base> <size> <chip_width> <bus_width> <target> [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;
        }
        
@@ -148,6 +166,7 @@ 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);
@@ -222,9 +241,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];
                        
@@ -373,9 +392,10 @@ int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, cha
                int last = strtoul(args[2], NULL, 0);
                int retval;
                flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-               struct timeval start, end, duration;
-
-               gettimeofday(&start, NULL);
+               duration_t duration;
+               char *duration_text;
+       
+               duration_start_measure(&duration);
        
                if (!p)
                {
@@ -411,10 +431,10 @@ int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, cha
                }
                else
                {
-                       gettimeofday(&end, NULL);       
-                       timeval_subtract(&duration, &end, &start);
-               
-                       command_print(cmd_ctx, "erased sectors %i through %i on flash bank %i in %is %ius", first, last, strtoul(args[0], 0, 0), duration.tv_sec, duration.tv_usec);
+                       duration_stop_measure(&duration, &duration_text);       
+                       
+                       command_print(cmd_ctx, "erased sectors %i through %i on flash bank %i in %s", first, last, strtoul(args[0], 0, 0), duration_text);
+                       free(duration_text);
                }
        }
        else
@@ -489,15 +509,96 @@ 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 (!strcmp(cmd, "write"))
+       {
+               command_print(cmd_ctx, "'flash write' has been deprecated in favor of 'flash write_binary' and 'flash write_image'");
+               DEBUG("'flash write' has been deprecated in favor of 'flash write_binary' and 'flash write_image'");
+       }
+
+       if (argc < 1)
+       {
+               command_print(cmd_ctx, "usage: flash write <file> [offset] [type]");
+               return ERROR_OK;
+       }
+       
+       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;
+
+       if (image_open(&image, args[0], (argc == 4) ? args[2] : NULL) != ERROR_OK)
+       {
+               command_print(cmd_ctx, "flash write error: %s", image.error_str);
+               return ERROR_OK;
+       }
+       
+       failed = malloc(sizeof(int) * image.num_sections);
+
+       if ((retval = flash_write(target, &image, &written, &error_str, failed)) != ERROR_OK)
+       {
+               command_print(cmd_ctx, "failed writing image %s: %s", args[0], error_str);
+               free(error_str);
+       }
+       
+       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);
+
+       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;
@@ -507,17 +608,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 <bank> <file> <offset> [type]");
+               command_print(cmd_ctx, "usage: flash write <bank> <file> <offset>");
                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)
@@ -526,69 +622,277 @@ 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 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)
        {
-               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, "flash write error: %s", fileio.error_str);
+               return ERROR_OK;
+       }
+       
+       if ((retval = p->driver->write(p, buffer, offset, 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 <bank> <file> <offset>");
+                               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;
+}
+
+/* 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(target_t *target, u32 addr, u32 length)
+{
+       flash_bank_t *c;
+       unsigned long sector_size;
+       int first;
+       int last;
+
+       if ((c = get_flash_bank_by_addr(target, addr)) == NULL)
+               return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */
+       /* sanity checks */
+       if (c->size == 0 || c->num_sectors == 0 || c->size % c->num_sectors)
+               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;
                
-               if ((retval = p->driver->write(p, buffer, offset, buf_cnt)) != ERROR_OK)
+               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;
+
+       /* calculate sector size */
+       sector_size = c->size / c->num_sectors;
+
+       /* check alignment */
+       if ((addr - c->base) % sector_size || length % sector_size)
+               return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
+
+       first = (addr - c->base) / sector_size;
+       last = first + length / sector_size - 1;
+       return c->driver->erase(c, first, last);
+}
+
+/* write 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 retval;
+       int i;
+
+       int section;
+       u32 section_offset;
+
+       section = 0;
+       section_offset = 0;
+
+       if (written)
+               *written = 0;
+       
+       if (failed != NULL)
+               for (i = 0; i < image->num_sections; i++)
+                       failed[i] = 0;
+
+       /* loop until we reach end of the image */
+       while (section < image->num_sections)
+       {
+               flash_bank_t *c;
+               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)
+               {
+                       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))
                {
-                       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));
+                       if (image->sections[section_last + 1].base_address < (run_address + run_size))
+                       {
+                               WARNING("section %d out of order", 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 = 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 <bank> <file> <offset>");
-                                       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);
-
-       image_close(&image);
-       
        return ERROR_OK;
 }

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)