target_t -> struct target
[openocd.git] / src / flash / flash.c
index 5ca26622beebd6a35367c942a68b1b069adde58b..5374532cea8ff0f2286eb5c9fb4056d0e4b77785 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
 #include "image.h"
 #include "time_support.h"
 
-/* command handlers */
-static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int flash_write_unlock(struct target *target, struct image *image, uint32_t *written, int erase, bool unlock);
 
 /* flash drivers
  */
-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 aduc702x_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;
-extern flash_driver_t ecosflash_flash;
-extern flash_driver_t lpc288x_flash;
-extern flash_driver_t ocl_flash;
-extern flash_driver_t pic32mx_flash;
-extern flash_driver_t avr_flash;
-
-flash_driver_t *flash_drivers[] = {
+extern struct flash_driver lpc2000_flash;
+extern struct flash_driver lpc288x_flash;
+extern struct flash_driver lpc2900_flash;
+extern struct flash_driver cfi_flash;
+extern struct flash_driver at91sam3_flash;
+extern struct flash_driver at91sam7_flash;
+extern struct flash_driver str7x_flash;
+extern struct flash_driver str9x_flash;
+extern struct flash_driver aduc702x_flash;
+extern struct flash_driver stellaris_flash;
+extern struct flash_driver str9xpec_flash;
+extern struct flash_driver stm32x_flash;
+extern struct flash_driver tms470_flash;
+extern struct flash_driver ecosflash_flash;
+extern struct flash_driver ocl_flash;
+extern struct flash_driver pic32mx_flash;
+extern struct flash_driver avr_flash;
+extern struct flash_driver faux_flash;
+
+struct flash_driver *flash_drivers[] = {
        &lpc2000_flash,
+       &lpc288x_flash,
+       &lpc2900_flash,
        &cfi_flash,
        &at91sam7_flash,
+       &at91sam3_flash,
        &str7x_flash,
        &str9x_flash,
        &aduc702x_flash,
@@ -74,10 +69,10 @@ flash_driver_t *flash_drivers[] = {
        &stm32x_flash,
        &tms470_flash,
        &ecosflash_flash,
-       &lpc288x_flash,
        &ocl_flash,
        &pic32mx_flash,
        &avr_flash,
+       &faux_flash,
        NULL,
 };
 
@@ -92,7 +87,7 @@ static int flash_driver_write(struct flash_bank_s *bank, uint8_t *buffer, uint32
        retval = bank->driver->write(bank, buffer, offset, count);
        if (retval != ERROR_OK)
        {
-               LOG_ERROR("error writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32 " (%d)", 
+               LOG_ERROR("error writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32 " (%d)",
                          bank->base, offset, retval);
        }
 
@@ -125,14 +120,6 @@ int flash_driver_protect(struct flash_bank_s *bank, int set, int first, int last
        return retval;
 }
 
-int flash_register_commands(struct command_context_s *cmd_ctx)
-{
-       flash_cmd = register_command(cmd_ctx, NULL, "flash", NULL, COMMAND_ANY, NULL);
-
-       register_command(cmd_ctx, flash_cmd, "bank", handle_flash_bank_command, COMMAND_CONFIG, "flash bank <driver> <base> <size> <chip_width> <bus_width> <target> [driver_options ...]");
-       return ERROR_OK;
-}
-
 static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        flash_bank_t *p;
@@ -166,43 +153,6 @@ static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
-int flash_init_drivers(struct command_context_s *cmd_ctx)
-{
-       register_jim(cmd_ctx, "ocd_flash_banks", jim_flash_banks, "return information about the flash banks");
-
-       if (flash_banks)
-       {
-               register_command(cmd_ctx, flash_cmd, "info", handle_flash_info_command, COMMAND_EXEC,
-                                                "print info about flash bank <num>");
-               register_command(cmd_ctx, flash_cmd, "probe", handle_flash_probe_command, COMMAND_EXEC,
-                                                "identify flash bank <num>");
-               register_command(cmd_ctx, flash_cmd, "erase_check", handle_flash_erase_check_command, COMMAND_EXEC,
-                                                "check erase state of sectors in flash bank <num>");
-               register_command(cmd_ctx, flash_cmd, "protect_check", handle_flash_protect_check_command, COMMAND_EXEC,
-                                                "check protection state of sectors in flash bank <num>");
-               register_command(cmd_ctx, flash_cmd, "erase_sector", handle_flash_erase_command, COMMAND_EXEC,
-                                                "erase sectors at <bank> <first> <last>");
-               register_command(cmd_ctx, flash_cmd, "erase_address", handle_flash_erase_address_command, COMMAND_EXEC,
-                                                "erase address range <address> <length>");
-
-               register_command(cmd_ctx, flash_cmd, "fillw", handle_flash_fill_command, COMMAND_EXEC,
-                                                "fill with pattern (no autoerase) <address> <word_pattern> <count>");
-               register_command(cmd_ctx, flash_cmd, "fillh", handle_flash_fill_command, COMMAND_EXEC,
-                                                "fill with pattern <address> <halfword_pattern> <count>");
-               register_command(cmd_ctx, flash_cmd, "fillb", handle_flash_fill_command, COMMAND_EXEC,
-                                                "fill with pattern <address> <byte_pattern> <count>");
-
-               register_command(cmd_ctx, flash_cmd, "write_bank", handle_flash_write_bank_command, COMMAND_EXEC,
-                                                "write binary data to <bank> <file> <offset>");
-               register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
-                                                "write_image [erase] <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>");
-       }
-
-       return ERROR_OK;
-}
-
 flash_bank_t *get_flash_bank_by_num_noprobe(int num)
 {
        flash_bank_t *p;
@@ -248,12 +198,29 @@ flash_bank_t *get_flash_bank_by_num(int num)
        return p;
 }
 
-static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+int flash_command_get_bank_by_num(
+       struct command_context_s *cmd_ctx, const char *str, flash_bank_t **bank)
+{
+       unsigned bank_num;
+       COMMAND_PARSE_NUMBER(uint, str, bank_num);
+
+       *bank = get_flash_bank_by_num(bank_num);
+       if (!*bank)
+       {
+               command_print(cmd_ctx,
+                       "flash bank '#%u' not found", bank_num);
+               return ERROR_INVALID_ARGUMENTS;
+       }
+       return ERROR_OK;
+}
+
+
+COMMAND_HANDLER(handle_flash_bank_command)
 {
        int retval;
        int i;
        int found = 0;
-       target_t *target;
+       struct target *target;
 
        if (argc < 6)
        {
@@ -268,54 +235,55 @@ static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cm
 
        for (i = 0; flash_drivers[i]; i++)
        {
-               if (strcmp(args[0], flash_drivers[i]->name) == 0)
-               {
-                       flash_bank_t *p, *c;
+               if (strcmp(args[0], flash_drivers[i]->name) != 0)
+                       continue;
 
-                       /* register flash specific commands */
-                       if (flash_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
-                       {
-                               LOG_ERROR("couldn't register '%s' commands", args[0]);
-                               return ERROR_FAIL;
-                       }
+               flash_bank_t *p, *c;
 
-                       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 ((retval = flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
-                       {
-                               LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 , args[0], c->base);
-                               free(c);
-                               return retval;
-                       }
+               /* register flash specific commands */
+               if (flash_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
+               {
+                       LOG_ERROR("couldn't register '%s' commands", args[0]);
+                       return ERROR_FAIL;
+               }
 
-                       /* put flash bank in linked list */
-                       if (flash_banks)
-                       {
-                               int     bank_num = 0;
-                               /* find last flash bank */
-                               for (p = flash_banks; p && p->next; p = p->next) bank_num++;
-                               if (p)
-                                       p->next = c;
-                               c->bank_number = bank_num + 1;
-                       }
-                       else
-                       {
-                               flash_banks = c;
-                               c->bank_number = 0;
-                       }
+               c = malloc(sizeof(flash_bank_t));
+               c->target = target;
+               c->driver = flash_drivers[i];
+               c->driver_priv = NULL;
+               COMMAND_PARSE_NUMBER(u32, args[1], c->base);
+               COMMAND_PARSE_NUMBER(u32, args[2], c->size);
+               COMMAND_PARSE_NUMBER(int, args[3], c->chip_width);
+               COMMAND_PARSE_NUMBER(int, args[4], c->bus_width);
+               c->num_sectors = 0;
+               c->sectors = NULL;
+               c->next = NULL;
+
+               retval = CALL_COMMAND_HANDLER(flash_drivers[i]->flash_bank_command, c);
+               if (ERROR_OK != retval)
+               {
+                       LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 , args[0], c->base);
+                       free(c);
+                       return retval;
+               }
 
-                       found = 1;
+               /* put flash bank in linked list */
+               if (flash_banks)
+               {
+                       int     bank_num = 0;
+                       /* find last flash bank */
+                       for (p = flash_banks; p && p->next; p = p->next) bank_num++;
+                       if (p)
+                               p->next = c;
+                       c->bank_number = bank_num + 1;
                }
+               else
+               {
+                       flash_banks = c;
+                       c->bank_number = 0;
+               }
+
+               found = 1;
        }
 
        /* no matching flash driver found */
@@ -328,7 +296,7 @@ static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cm
        return ERROR_OK;
 }
 
-static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_info_command)
 {
        flash_bank_t *p;
        uint32_t i = 0;
@@ -336,62 +304,62 @@ static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cm
        int retval;
 
        if (argc != 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
+
+       unsigned bank_nr;
+       COMMAND_PARSE_NUMBER(uint, args[0], bank_nr);
 
        for (p = flash_banks; p; p = p->next, i++)
        {
-               if (i == strtoul(args[0], NULL, 0))
-               {
-                       char buf[1024];
+               if (i != bank_nr)
+                       continue;
 
-                       /* attempt auto probe */
-                       if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
-                               return retval;
+               char buf[1024];
 
-                       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);
-                       }
+               /* attempt auto probe */
+               if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
+                       return retval;
 
-                       *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);
+               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;
 }
 
-static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_probe_command)
 {
-       flash_bank_t *p;
        int retval;
 
        if (argc != 1)
@@ -399,7 +367,9 @@ static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *c
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_flash_bank_by_num_noprobe(strtoul(args[0], NULL, 0));
+       unsigned bank_nr;
+       COMMAND_PARSE_NUMBER(uint, args[0], bank_nr);
+       flash_bank_t *p = get_flash_bank_by_num_noprobe(bank_nr);
        if (p)
        {
                if ((retval = p->driver->probe(p)) == ERROR_OK)
@@ -425,72 +395,66 @@ static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *c
        return ERROR_OK;
 }
 
-static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_erase_check_command)
 {
-       flash_bank_t *p;
-       int retval;
-
        if (argc != 1)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (p)
+       flash_bank_t *p;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       int j;
+       if ((retval = p->driver->erase_check(p)) == ERROR_OK)
        {
-               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,
-                               args[0], p->base);
-               }
+               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,
+                       args[0], p->base);
+       }
 
-               for (j = 0; j < p->num_sectors; j++)
-               {
-                       char *erase_state;
+       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";
+               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);
-               }
+               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;
 }
 
-static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_erase_address_command)
 {
        flash_bank_t *p;
        int retval;
        int address;
        int length;
-       duration_t duration;
-       char *duration_text;
 
-       target_t *target = get_current_target(cmd_ctx);
+       struct target *target = get_current_target(cmd_ctx);
 
        if (argc != 2)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       address = strtoul(args[0], NULL, 0);
-       length = strtoul(args[1], NULL, 0);
+       COMMAND_PARSE_NUMBER(int, args[0], address);
+       COMMAND_PARSE_NUMBER(int, args[1], length);
        if (length <= 0)
        {
                command_print(cmd_ctx, "Length must be >0");
@@ -506,145 +470,157 @@ static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx,
        /* 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);
+       struct duration bench;
+       duration_start(&bench);
+
+       retval = flash_erase_address_range(target, address, length);
 
-       if ((retval = flash_erase_address_range(target, address, length)) == ERROR_OK)
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
-               {
-                       return retval;
-               }
-               command_print(cmd_ctx, "erased address 0x%8.8x length %i in %s", address, length, duration_text);
-               free(duration_text);
+               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;
 }
 
-static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_protect_check_command)
 {
+       if (argc != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
        flash_bank_t *p;
-       int retval;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
 
-       if (argc != 1)
+       if ((retval = p->driver->protect_check(p)) == ERROR_OK)
        {
-               return ERROR_COMMAND_SYNTAX_ERROR;
+               command_print(cmd_ctx, "successfully checked protect state");
        }
-
-       p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (p)
+       else if (retval == ERROR_FLASH_OPERATION_FAILED)
        {
-               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, args[0], p->base);
-               }
-               else
-               {
-                       command_print(cmd_ctx, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8" PRIx32, args[0], p->base);
-               }
+               command_print(cmd_ctx, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8" PRIx32, args[0], p->base);
        }
        else
        {
-               return ERROR_COMMAND_SYNTAX_ERROR;
+               command_print(cmd_ctx, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8" PRIx32, args[0], p->base);
        }
 
        return ERROR_OK;
 }
 
-static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int flash_check_sector_parameters(struct command_context_s *cmd_ctx,
+               uint32_t first, uint32_t last, uint32_t num_sectors)
 {
-       if (argc > 2)
-       {
-               int first = strtoul(args[1], NULL, 0);
-               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;
+       if (!(first <= last)) {
+               command_print(cmd_ctx, "ERROR: "
+                               "first sector must be <= last sector");
+               return ERROR_FAIL;
+       }
 
-               duration_start_measure(&duration);
+       if (!(last <= (num_sectors - 1))) {
+               command_print(cmd_ctx, "ERROR: last sector must be <= %d",
+                               (int) num_sectors - 1);
+               return ERROR_FAIL;
+       }
 
-               if (!p)
-               {
-                       return ERROR_COMMAND_SYNTAX_ERROR;
-               }
+       return ERROR_OK;
+}
 
-               if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK)
-               {
-                       if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
-                       {
-                               return retval;
-                       }
+COMMAND_HANDLER(handle_flash_erase_command)
+{
+       if (argc != 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-                       command_print(cmd_ctx, "erased sectors %i through %i on flash bank %li in %s",
-                               first, last, strtoul(args[0], 0, 0), duration_text);
-                       free(duration_text);
-               }
-       }
+       uint32_t bank_nr;
+       uint32_t first;
+       uint32_t last;
+
+       COMMAND_PARSE_NUMBER(u32, args[0], bank_nr);
+       flash_bank_t *p = get_flash_bank_by_num(bank_nr);
+       if (!p)
+               return ERROR_OK;
+
+       COMMAND_PARSE_NUMBER(u32, args[1], first);
+       if (strcmp(args[2], "last") == 0)
+               last = p->num_sectors - 1;
        else
+               COMMAND_PARSE_NUMBER(u32, args[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))
        {
-               return ERROR_COMMAND_SYNTAX_ERROR;
+               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;
 }
 
-static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_protect_command)
 {
-       if (argc > 3)
-       {
-               int first = strtoul(args[1], NULL, 0);
-               int last = strtoul(args[2], NULL, 0);
-               int set;
-               int retval;
-               flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-               if (!p)
-               {
-                       command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-                       return ERROR_OK;
-               }
+       if (argc != 3)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-               if (strcmp(args[3], "on") == 0)
-                       set = 1;
-               else if (strcmp(args[3], "off") == 0)
-                       set = 0;
-               else
-               {
-                       return ERROR_COMMAND_SYNTAX_ERROR;
-               }
+       uint32_t bank_nr;
+       uint32_t first;
+       uint32_t last;
+       int set;
 
-               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 %li",
-                               (set) ? "set" : "cleared", first,
-                               last, strtoul(args[0], 0, 0));
-               }
-       }
+       COMMAND_PARSE_NUMBER(u32, args[0], bank_nr);
+       flash_bank_t *p = get_flash_bank_by_num(bank_nr);
+       if (!p)
+               return ERROR_OK;
+
+       COMMAND_PARSE_NUMBER(u32, args[1], first);
+       if (strcmp(args[2], "last") == 0)
+               last = p->num_sectors - 1;
+       else
+               COMMAND_PARSE_NUMBER(u32, args[2], last);
+
+       if (strcmp(args[3], "on") == 0)
+               set = 1;
+       else if (strcmp(args[3], "off") == 0)
+               set = 0;
        else
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
 
+       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;
 }
 
-static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_write_image_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
+       struct target *target = get_current_target(cmd_ctx);
 
-       image_t image;
+       struct image image;
        uint32_t written;
 
-       duration_t duration;
-       char *duration_text;
-
-       int retval, retvaltemp;
+       int retval;
 
        if (argc < 1)
        {
@@ -653,13 +629,26 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
 
        /* flash auto-erase is disabled by default*/
        int auto_erase = 0;
+       bool auto_unlock = false;
 
-       if (strcmp(args[0], "erase") == 0)
+       for (;;)
        {
-               auto_erase = 1;
-               args++;
-               argc--;
-               command_print(cmd_ctx, "auto erase enabled");
+               if (strcmp(args[0], "erase") == 0)
+               {
+                       auto_erase = 1;
+                       args++;
+                       argc--;
+                       command_print(cmd_ctx, "auto erase enabled");
+               } else if (strcmp(args[0], "unlock") == 0)
+               {
+                       auto_unlock = true;
+                       args++;
+                       argc--;
+                       command_print(cmd_ctx, "auto unlock enabled");
+               } else
+               {
+                       break;
+               }
        }
 
        if (argc < 1)
@@ -673,12 +662,13 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
                return ERROR_FAIL;
        }
 
-       duration_start_measure(&duration);
+       struct duration bench;
+       duration_start(&bench);
 
        if (argc >= 2)
        {
                image.base_address_set = 1;
-               image.base_address = strtoul(args[1], NULL, 0);
+               COMMAND_PARSE_NUMBER(int, args[1], image.base_address);
        }
        else
        {
@@ -694,37 +684,28 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
                return retval;
        }
 
-       retval = flash_write(target, &image, &written, auto_erase);
+       retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
        if (retval != ERROR_OK)
        {
                image_close(&image);
                return retval;
        }
 
-       if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
-       {
-               image_close(&image);
-               return retvaltemp;
-       }
-       if (retval == ERROR_OK)
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               command_print(cmd_ctx, 
-                                         "wrote %" PRIu32 " 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)));
+               command_print(cmd_ctx, "wrote %" PRIu32 " byte from file %s "
+                               "in %fs (%0.3f kb/s)", written, args[0],
+                               duration_elapsed(&bench), duration_kbps(&bench, written));
        }
-       free(duration_text);
 
        image_close(&image);
 
        return retval;
 }
 
-static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_fill_command)
 {
-       int err = ERROR_OK, retval;
+       int err = ERROR_OK;
        uint32_t address;
        uint32_t pattern;
        uint32_t count;
@@ -733,25 +714,21 @@ static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cm
        uint32_t wrote = 0;
        uint32_t cur_size = 0;
        uint32_t chunk_count;
-       char *duration_text;
-       duration_t duration;
-       target_t *target = get_current_target(cmd_ctx);
+       struct target *target = get_current_target(cmd_ctx);
        uint32_t i;
        uint32_t wordsize;
 
        if (argc != 3)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       address = strtoul(args[0], NULL, 0);
-       pattern = strtoul(args[1], NULL, 0);
-       count   = strtoul(args[2], NULL, 0);
+       COMMAND_PARSE_NUMBER(u32, args[0], address);
+       COMMAND_PARSE_NUMBER(u32, args[1], pattern);
+       COMMAND_PARSE_NUMBER(u32, args[2], count);
 
        if (count == 0)
                return ERROR_OK;
 
-       switch (cmd[4])
+       switch (CMD_NAME[4])
        {
        case 'w':
                wordsize = 4;
@@ -789,11 +766,12 @@ static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cm
                exit(-1);
        }
 
-       duration_start_measure(&duration);
+       struct duration bench;
+       duration_start(&bench);
 
        for (wrote = 0; wrote < (count*wordsize); wrote += cur_size)
        {
-               cur_size = MIN( (count*wordsize - wrote), sizeof(chunk) );
+               cur_size = MIN((count*wordsize - wrote), sizeof(chunk));
                flash_bank_t *bank;
                bank = get_flash_bank_by_addr(target, address);
                if (bank == NULL)
@@ -813,63 +791,41 @@ static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cm
                {
                        if (readback[i]!=chunk[i])
                        {
-                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x", 
+                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
                                                  address + wrote + i, readback[i], chunk[i]);
                                return ERROR_FAIL;
                        }
                }
-
-       }
-
-       if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
-       {
-               return retval;
        }
 
-       if (err == ERROR_OK)
+       if (duration_measure(&bench) == ERROR_OK)
        {
-               float speed;
-               speed = wrote / 1024.0;
-               speed/=((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0));
-               command_print(cmd_ctx, 
-                                         "wrote %" PRId32 " bytes to 0x%8.8" PRIx32 " in %s (%f kb/s)",
-                                         count*wordsize, 
-                                         address, 
-                                         duration_text,
-                                         speed);
+               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));
        }
-       free(duration_text);
        return ERROR_OK;
 }
 
-static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_flash_write_bank_command)
 {
        uint32_t offset;
        uint8_t *buffer;
        uint32_t buf_cnt;
-
-       fileio_t fileio;
-
-       duration_t duration;
-       char *duration_text;
-
-       int retval, retvaltemp;
-       flash_bank_t *p;
+       struct fileio fileio;
 
        if (argc != 3)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       duration_start_measure(&duration);
+       struct duration bench;
+       duration_start(&bench);
 
-       offset = strtoul(args[2], NULL, 0);
-       p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!p)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
+       flash_bank_t *p;
+       int retval = flash_command_get_bank_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u32, args[2], offset);
 
        if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
        {
@@ -889,23 +845,13 @@ static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, ch
        free(buffer);
        buffer = NULL;
 
-       if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               fileio_close(&fileio);
-               return retvaltemp;
+               command_print(cmd_ctx, "wrote %lld byte from file %s to flash bank %u"
+                               " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
+                               fileio.size, args[1], p->bank_number, offset,
+                               duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
        }
-       if (retval == ERROR_OK)
-       {
-       command_print(cmd_ctx, 
-                                 "wrote  %lld byte from file %s to flash bank %li at offset 0x%8.8" PRIx32 " 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);
 
@@ -928,7 +874,7 @@ void flash_set_dirty(void)
 }
 
 /* lookup flash bank by address */
-flash_bank_t *get_flash_bank_by_addr(target_t *target, uint32_t addr)
+struct flash_bank_s *get_flash_bank_by_addr(struct target *target, uint32_t addr)
 {
        flash_bank_t *c;
 
@@ -952,7 +898,8 @@ flash_bank_t *get_flash_bank_by_addr(target_t *target, uint32_t addr)
 }
 
 /* erase given flash region, selects proper bank according to target and address */
-int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
+static int flash_iterate_address_range(struct target *target, uint32_t addr, uint32_t length,
+               int (*callback)(struct flash_bank_s *bank, int first, int last))
 {
        flash_bank_t *c;
        int first = -1;
@@ -974,7 +921,7 @@ int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
                if (addr != c->base)
                        return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
 
-               return flash_driver_erase(c, 0, c->num_sectors - 1);
+               return callback(c, 0, c->num_sectors - 1);
        }
 
        /* check whether it fits */
@@ -994,14 +941,32 @@ int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
                }
        }
 
-       if ( first == -1 || last == -1 )
+       if (first == -1 || last == -1)
                return ERROR_OK;
 
-       return flash_driver_erase(c, first, last);
+       return callback(c, first, last);
 }
 
+
+
+int flash_erase_address_range(struct target *target, uint32_t addr, uint32_t length)
+{
+       return flash_iterate_address_range(target, addr, length, &flash_driver_erase);
+}
+
+static int flash_driver_unprotect(struct flash_bank_s *bank, int first, int last)
+{
+       return flash_driver_protect(bank, 0, first, last);
+}
+
+static int flash_unlock_address_range(struct target *target, uint32_t addr, uint32_t length)
+{
+       return flash_iterate_address_range(target, addr, length, &flash_driver_unprotect);
+}
+
+
 /* write (optional verify) an image to flash memory of the given target */
-int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
+static int flash_write_unlock(struct target *target, struct image *image, uint32_t *written, int erase, bool unlock)
 {
        int retval = ERROR_OK;
 
@@ -1076,7 +1041,7 @@ int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
                        run_size += pad_bytes;
                        padding[section_last] = 0;
 
-                       LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes );
+                       LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes);
                }
 
                /* fit the run into bank constraints */
@@ -1124,10 +1089,17 @@ int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
 
                retval = ERROR_OK;
 
-               if (erase)
+               if (unlock)
                {
-                       /* calculate and erase sectors */
-                       retval = flash_erase_address_range( target, run_address, run_size );
+                       retval = flash_unlock_address_range(target, run_address, run_size);
+               }
+               if (retval == ERROR_OK)
+               {
+                       if (erase)
+                       {
+                               /* calculate and erase sectors */
+                               retval = flash_erase_address_range(target, run_address, run_size);
+                       }
                }
 
                if (retval == ERROR_OK)
@@ -1153,9 +1125,14 @@ int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
        return retval;
 }
 
+int flash_write(struct target *target, struct image *image, uint32_t *written, int erase)
+{
+       return flash_write_unlock(target, image, written, erase, false);
+}
+
 int default_flash_mem_blank_check(struct flash_bank_s *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        uint8_t buffer[1024];
        int buffer_size = sizeof(buffer);
        int i;
@@ -1202,7 +1179,7 @@ int default_flash_mem_blank_check(struct flash_bank_s *bank)
 
 int default_flash_blank_check(struct flash_bank_s *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        int i;
        int retval;
        int fast_check = 0;
@@ -1239,3 +1216,65 @@ int default_flash_blank_check(struct flash_bank_s *bank)
 
        return ERROR_OK;
 }
+
+int flash_init_drivers(struct command_context_s *cmd_ctx)
+{
+       register_jim(cmd_ctx, "ocd_flash_banks",
+                       jim_flash_banks, "return information about the flash banks");
+
+       if (!flash_banks)
+               return ERROR_OK;
+
+       register_command(cmd_ctx, flash_cmd, "info",
+                       handle_flash_info_command, COMMAND_EXEC,
+                       "print info about flash bank <num>");
+       register_command(cmd_ctx, flash_cmd, "probe",
+                       handle_flash_probe_command, COMMAND_EXEC,
+                       "identify flash bank <num>");
+       register_command(cmd_ctx, flash_cmd, "erase_check",
+                       handle_flash_erase_check_command, COMMAND_EXEC,
+                       "check erase state of sectors in flash bank <num>");
+       register_command(cmd_ctx, flash_cmd, "protect_check",
+                       handle_flash_protect_check_command, COMMAND_EXEC,
+                       "check protection state of sectors in flash bank <num>");
+       register_command(cmd_ctx, flash_cmd, "erase_sector",
+                       handle_flash_erase_command, COMMAND_EXEC,
+                       "erase sectors at <bank> <first> <last>");
+       register_command(cmd_ctx, flash_cmd, "erase_address",
+                       handle_flash_erase_address_command, COMMAND_EXEC,
+                       "erase address range <address> <length>");
+
+       register_command(cmd_ctx, flash_cmd, "fillw",
+                       handle_flash_fill_command, COMMAND_EXEC,
+                       "fill with pattern (no autoerase) <address> <word_pattern> <count>");
+       register_command(cmd_ctx, flash_cmd, "fillh",
+                       handle_flash_fill_command, COMMAND_EXEC,
+                       "fill with pattern <address> <halfword_pattern> <count>");
+       register_command(cmd_ctx, flash_cmd, "fillb",
+                       handle_flash_fill_command, COMMAND_EXEC,
+                       "fill with pattern <address> <byte_pattern> <count>");
+
+       register_command(cmd_ctx, flash_cmd, "write_bank",
+                       handle_flash_write_bank_command, COMMAND_EXEC,
+                       "write binary data to <bank> <file> <offset>");
+       register_command(cmd_ctx, flash_cmd, "write_image",
+                       handle_flash_write_image_command, COMMAND_EXEC,
+                       "write_image [erase] [unlock] <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>");
+
+       return ERROR_OK;
+}
+
+int flash_register_commands(struct command_context_s *cmd_ctx)
+{
+       flash_cmd = register_command(cmd_ctx, NULL, "flash",
+                       NULL, COMMAND_ANY, NULL);
+
+       register_command(cmd_ctx, flash_cmd, "bank",
+                       handle_flash_bank_command, COMMAND_CONFIG,
+                       "flash bank <driver> <base> <size> "
+                       "<chip_width> <bus_width> <target> [driver_options ...]");
+       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)