- initialize num_sectors and sectors in handle_flash_bank_command.
[fw/openocd] / src / flash / flash.c
index 7d199cfccf68f36bacc964ee5b630aca3d97d7c2..6c1fbd91539a29b639f3f580e260ad8b84d4dd1e 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,6 +35,7 @@
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <errno.h>
+#include <inttypes.h>
 
 /* command handlers */
 int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
@@ -43,7 +46,10 @@ 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);
+int handle_flash_auto_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 /* flash drivers
  */
@@ -51,6 +57,10 @@ extern flash_driver_t lpc2000_flash;
 extern flash_driver_t cfi_flash;
 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[] =
 {
@@ -58,11 +68,16 @@ flash_driver_t *flash_drivers[] =
        &cfi_flash,
        &at91sam7_flash,
        &str7x_flash,
+       &str9x_flash,
+       &stellaris_flash,
+       &str9xpec_flash,
+       &stm32x_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)
 {
@@ -89,10 +104,16 @@ 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>");
+               register_command(cmd_ctx, flash_cmd, "auto_erase", handle_flash_auto_erase_command, COMMAND_EXEC,
+                                                "auto erase flash sectors <on|off>");
        }
        
        return ERROR_OK;
@@ -114,16 +135,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;
        }
        
@@ -141,12 +170,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->bus_width = strtoul(args[4], NULL, 0);\r
+                       c->num_sectors = 0;\r
+                       c->sectors = NULL;
                        c->next = NULL;
                        
                        if (flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c) != ERROR_OK)
@@ -215,9 +247,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];
                        
@@ -241,8 +273,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);
                        }
                        
@@ -366,6 +398,11 @@ 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));
+               duration_t duration;
+               char *duration_text;
+       
+               duration_start_measure(&duration);
+       
                if (!p)
                {
                        command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
@@ -398,6 +435,13 @@ int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        command_print(cmd_ctx, "unknown error");
                        }
                }
+               else
+               {
+                       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
        {
@@ -458,6 +502,10 @@ int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, c
                                        command_print(cmd_ctx, "unknown error");
                        }
                }
+               else
+               {
+                       command_print(cmd_ctx, "%s protection for sectors %i through %i on flash bank %i", (set) ? "set" : "cleared", first, last, strtoul(args[0], 0, 0));
+               }
        }
        else
        {
@@ -467,26 +515,122 @@ 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);
+
+       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)
 {
-       FILE *binary;
        u32 offset;
-       struct stat binary_stat;
-       u32 binary_size;
        u8 *buffer;
        u32 buf_cnt;
+
+       fileio_t fileio;
+       
+       duration_t duration;
+       char *duration_text;
+       
        int retval;
        flash_bank_t *p;
-       struct timeval start, end, duration;
 
-       gettimeofday(&start, NULL);
-               
        if (argc < 3)
        {
                command_print(cmd_ctx, "usage: flash write <bank> <file> <offset>");
                return ERROR_OK;
        }
        
+       duration_start_measure(&duration);
+       
        offset = strtoul(args[2], NULL, 0);
        p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
        if (!p)
@@ -495,36 +639,19 @@ int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, cha
                return ERROR_OK;
        }
        
-       if (stat(args[1], &binary_stat) == -1)
-       {
-               ERROR("couldn't stat() %s: %s", args[1], strerror(errno));
-               return ERROR_OK;
-       }
-
-       if (S_ISDIR(binary_stat.st_mode))
+       if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
        {
-               ERROR("%s is a directory", args[1]);
-               command_print(cmd_ctx,"%s is a directory", args[1]);
+               command_print(cmd_ctx, "flash write error: %s", fileio.error_str);
                return ERROR_OK;
        }
-               
-       if (binary_stat.st_size == 0){
-               ERROR("Empty file %s", args[1]);
-               command_print(cmd_ctx,"Empty file %s", args[1]);
-               return ERROR_OK;
-       }
-               
-       if (!(binary = fopen(args[1], "rb")))
+       
+       buffer = malloc(fileio.size);
+       if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
        {
-               ERROR("couldn't open %s: %s", args[1], strerror(errno));
-               command_print(cmd_ctx, "couldn't open %s", args[1]);
+               command_print(cmd_ctx, "flash write error: %s", fileio.error_str);
                return ERROR_OK;
        }
-
-       binary_size = binary_stat.st_size;
-       buffer = malloc(binary_size);
-       buf_cnt = fread(buffer, 1, binary_size, binary);
-
+       
        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",
@@ -556,16 +683,270 @@ int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                command_print(cmd_ctx, "unknown error");
                }
        }
-       else
+
+       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)
        {
-               gettimeofday(&end, NULL);       
-               timeval_subtract(&duration, &end, &start);
+               /* 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;
+       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;
                
-               command_print(cmd_ctx, "wrote file %s to flash bank %i at offset 0x%8.8x in %is %ius", args[1], strtoul(args[0], NULL, 0), strtoul(args[2], NULL, 0), duration.tv_sec, duration.tv_usec);
+               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;
        
-       free(buffer);
-       fclose(binary);
+       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 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;
+
+       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))
+               {
+                       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,
+                                       run_size, 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( 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:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "can't flash image while target is running");
+                                       break;
+                               case ERROR_INVALID_ARGUMENTS:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "flash driver can't fulfill request");
+                                       break;
+                               case ERROR_FLASH_OPERATION_FAILED:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "flash program error");
+                                       break;
+                               case ERROR_FLASH_DST_BREAKS_ALIGNMENT:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "offset breaks required alignment");
+                                       break;
+                               case ERROR_FLASH_DST_OUT_OF_BANK:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "no flash mapped at requested address");
+                                       break;
+                               case ERROR_FLASH_SECTOR_NOT_ERASED:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "destination sector(s) not erased");
+                                       break;
+                               default:
+                                       snprintf(*error_str, FLASH_MAX_ERROR_STR, "unknown error: %i", retval);
+                       }
+
+                       return retval; /* abort operation */
+               }
+
+               if (written != NULL)
+                       *written += run_size; /* add run size to total written counter */
+       }
+
+       return ERROR_OK;
+}
+
+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 <on|off>");
+               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;
 }
+
+