flash: add padded_value cmd
[openocd.git] / src / flash / nor / tcl.c
index d417ca0f6f92e4ba0f69536032b89a866d2b7a5f..5bc0958be7fd11c02aa8494d65cc0b297c136f7f 100644 (file)
@@ -17,7 +17,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #include <helper/time_support.h>
 #include <target/image.h>
 
+/**
+ * @file
+ * Implements Tcl commands used to access NOR flash facilities.
+ */
+
 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
-               struct flash_bank **bank)
+       struct flash_bank **bank)
 {
        const char *name = CMD_ARGV[name_index];
-       *bank = get_flash_bank_by_name(name);
+       int retval = get_flash_bank_by_name(name, bank);
+       if (retval != ERROR_OK)
+               return retval;
        if (*bank)
                return ERROR_OK;
 
        unsigned bank_num;
        COMMAND_PARSE_NUMBER(uint, name, bank_num);
 
-       *bank = get_flash_bank_by_num(bank_num);
-       if (!*bank)
-       {
-               command_print(CMD_CTX, "flash bank '%s' not found", name);
-               return ERROR_INVALID_ARGUMENTS;
-       }
-       return ERROR_OK;
+       return get_flash_bank_by_num(bank_num, bank);
 }
 
-
 COMMAND_HANDLER(handle_flash_info_command)
 {
        struct flash_bank *p;
-       uint32_t i = 0;
        int j = 0;
        int retval;
 
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       unsigned bank_nr;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr);
-
-       for (p = flash_bank_list(); p; p = p->next, i++)
-       {
-               if (i != bank_nr)
-                       continue;
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
+       if (p != NULL) {
                char buf[1024];
 
                /* attempt auto probe */
-               if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
+               retval = p->driver->auto_probe(p);
+               if (retval != ERROR_OK)
+                       return retval;
+
+               /* We must query the hardware to avoid printing stale information! */
+               retval = p->driver->protect_check(p);
+               if (retval != ERROR_OK)
                        return retval;
 
                command_print(CMD_CTX,
-                             "#%" PRIi32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i",
-                             i,
-                             p->driver->name,
-                             p->base,
-                             p->size,
-                             p->bus_width,
-                             p->chip_width);
-               for (j = 0; j < p->num_sectors; j++)
-               {
+                       "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
+                       ", buswidth %i, chipwidth %i",
+                       p->bank_number,
+                       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)
@@ -91,67 +93,57 @@ COMMAND_HANDLER(handle_flash_info_command)
                                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);
+                               "\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);
+               if (p->driver->info != NULL) {
+                       retval = p->driver->info(p, buf, sizeof(buf));
+                       if (retval == ERROR_OK)
+                               command_print(CMD_CTX, "%s", buf);
+                       else
+                               LOG_ERROR("error retrieving flash info");
+               }
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_probe_command)
 {
+       struct flash_bank *p;
        int retval;
 
        if (CMD_ARGC != 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       unsigned bank_nr;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num_noprobe(bank_nr);
-       if (p)
-       {
-               if ((retval = p->driver->probe(p)) == ERROR_OK)
-               {
-                       command_print(CMD_CTX, "flash '%s' found at 0x%8.8" PRIx32, p->driver->name, p->base);
-               }
-               else if (retval == ERROR_FLASH_BANK_INVALID)
-               {
-                       command_print(CMD_CTX, "probing failed for flash bank '#%s' at 0x%8.8" PRIx32,
-                                                 CMD_ARGV[0], p->base);
-               }
-               else
-               {
-                       command_print(CMD_CTX, "unknown error when probing flash bank '#%s' at 0x%8.8" PRIx32,
-                                                 CMD_ARGV[0], p->base);
-               }
-       }
-       else
-       {
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
+
+       if (p) {
+               retval = p->driver->probe(p);
+               if (retval == ERROR_OK)
+                       command_print(CMD_CTX,
+                               "flash '%s' found at 0x%8.8" PRIx32,
+                               p->driver->name,
+                               p->base);
+       } else {
                command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
+               retval = ERROR_FAIL;
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_erase_check_command)
 {
        if (CMD_ARGC != 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
        struct flash_bank *p;
        int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
@@ -159,18 +151,17 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
                return retval;
 
        int j;
-       if ((retval = p->driver->erase_check(p)) == ERROR_OK)
-       {
+       retval = p->driver->erase_check(p);
+       if (retval == ERROR_OK)
                command_print(CMD_CTX, "successfully checked erase state");
-       }
-       else
-       {
-               command_print(CMD_CTX, "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
-                       CMD_ARGV[0], p->base);
+       else {
+               command_print(CMD_CTX,
+                       "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
+                       CMD_ARGV[0],
+                       p->base);
        }
 
-       for (j = 0; j < p->num_sectors; j++)
-       {
+       for (j = 0; j < p->num_sectors; j++) {
                char *erase_state;
 
                if (p->sectors[j].is_erased == 0)
@@ -181,99 +172,90 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
                        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);
+                       "\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;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_erase_address_command)
 {
        struct flash_bank *p;
-       int retval;
-       int address;
-       int length;
-
+       int retval = ERROR_OK;
+       uint32_t address;
+       uint32_t length;
+       bool do_pad = false;
+       bool do_unlock = false;
        struct target *target = get_current_target(CMD_CTX);
 
+       while (CMD_ARGC >= 3) {
+               /* Optionally pad out the address range to block/sector
+                * boundaries.  We can't know if there's data in that part
+                * of the flash; only do padding if we're told to.
+                */
+               if (strcmp("pad", CMD_ARGV[0]) == 0)
+                       do_pad = true;
+               else if (strcmp("unlock", CMD_ARGV[0]) == 0)
+                       do_unlock = true;
+               else
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+               CMD_ARGC--;
+               CMD_ARGV++;
+       }
        if (CMD_ARGC != 2)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], address);
-       COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], length);
-       if (length <= 0)
-       {
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
+
+       if (length <= 0) {
                command_print(CMD_CTX, "Length must be >0");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_flash_bank_by_addr(target, address);
-       if (p == NULL)
-       {
-               return ERROR_FAIL;
-       }
+       retval = get_flash_bank_by_addr(target, address, true, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
-       /* We can't know if we did a resume + halt, in which case we no longer know the erased state */
+       /* We can't know if we did a resume + halt, in which case we no longer know the erased state
+        **/
        flash_set_dirty();
 
        struct duration bench;
        duration_start(&bench);
 
-       retval = flash_erase_address_range(target, address, length);
+       if (do_unlock)
+               retval = flash_unlock_address_range(target, address, length);
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
-       {
+       if (retval == ERROR_OK)
+               retval = flash_erase_address_range(target, do_pad, address, length);
+
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
-                               " in %fs (%0.3f kb/s)", address, length,
-                               duration_elapsed(&bench), duration_kbps(&bench, length));
+                       " in %fs (%0.3f KiB/s)", address, length,
+                       duration_elapsed(&bench), duration_kbps(&bench, length));
        }
 
        return retval;
 }
 
-COMMAND_HANDLER(handle_flash_protect_check_command)
-{
-       if (CMD_ARGC != 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       struct flash_bank *p;
-       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if ((retval = p->driver->protect_check(p)) == ERROR_OK)
-       {
-               command_print(CMD_CTX, "successfully checked protect state");
-       }
-       else if (retval == ERROR_FLASH_OPERATION_FAILED)
-       {
-               command_print(CMD_CTX, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8" PRIx32, CMD_ARGV[0], p->base);
-       }
-       else
-       {
-               command_print(CMD_CTX, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8" PRIx32, CMD_ARGV[0], p->base);
-       }
-
-       return ERROR_OK;
-}
-
 static int flash_check_sector_parameters(struct command_context *cmd_ctx,
-               uint32_t first, uint32_t last, uint32_t num_sectors)
+       uint32_t first, uint32_t last, uint32_t num_sectors)
 {
        if (!(first <= last)) {
                command_print(cmd_ctx, "ERROR: "
-                               "first sector must be <= last sector");
+                       "first sector must be <= last sector");
                return ERROR_FAIL;
        }
 
        if (!(last <= (num_sectors - 1))) {
                command_print(cmd_ctx, "ERROR: last sector must be <= %d",
-                               (int) num_sectors - 1);
+                       (int) num_sectors - 1);
                return ERROR_FAIL;
        }
 
@@ -285,14 +267,15 @@ COMMAND_HANDLER(handle_flash_erase_command)
        if (CMD_ARGC != 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       uint32_t bank_nr;
        uint32_t first;
        uint32_t last;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num(bank_nr);
-       if (!p)
-               return ERROR_OK;
+       struct flash_bank *p;
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
        if (strcmp(CMD_ARGV[2], "last") == 0)
@@ -300,9 +283,8 @@ COMMAND_HANDLER(handle_flash_erase_command)
        else
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 
-       int retval;
-       if ((retval = flash_check_sector_parameters(CMD_CTX,
-                       first, last, p->num_sectors)) != ERROR_OK)
+       retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
+       if (retval != ERROR_OK)
                return retval;
 
        struct duration bench;
@@ -310,11 +292,10 @@ COMMAND_HANDLER(handle_flash_erase_command)
 
        retval = flash_driver_erase(p, first, last);
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
-       {
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD_CTX, "erased sectors %" PRIu32 " "
-                               "through %" PRIu32" on flash bank %" PRIu32 " "
-                               "in %fs", first, last, bank_nr, duration_elapsed(&bench));
+                       "through %" PRIu32 " on flash bank %" PRIu32 " "
+                       "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
        return ERROR_OK;
@@ -325,14 +306,15 @@ COMMAND_HANDLER(handle_flash_protect_command)
        if (CMD_ARGC != 4)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       uint32_t bank_nr;
        uint32_t first;
        uint32_t last;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num(bank_nr);
-       if (!p)
-               return ERROR_OK;
+       struct flash_bank *p;
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
        if (strcmp(CMD_ARGV[2], "last") == 0)
@@ -343,20 +325,19 @@ COMMAND_HANDLER(handle_flash_protect_command)
        bool set;
        COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 
-       int retval;
-       if ((retval = flash_check_sector_parameters(CMD_CTX,
-                       first, last, p->num_sectors)) != ERROR_OK)
+       retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
+       if (retval != 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",
+                       "through %i on flash bank %" PRIu32 "",
                        (set) ? "set" : "cleared", (int) first,
-                       (int) last, (int) bank_nr);
+                       (int) last, p->bank_number);
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_write_image_command)
@@ -369,41 +350,31 @@ COMMAND_HANDLER(handle_flash_write_image_command)
        int retval;
 
        if (CMD_ARGC < 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
        /* flash auto-erase is disabled by default*/
        int auto_erase = 0;
        bool auto_unlock = false;
 
-       for (;;)
-       {
-               if (strcmp(CMD_ARGV[0], "erase") == 0)
-               {
+       for (;; ) {
+               if (strcmp(CMD_ARGV[0], "erase") == 0) {
                        auto_erase = 1;
                        CMD_ARGV++;
                        CMD_ARGC--;
                        command_print(CMD_CTX, "auto erase enabled");
-               } else if (strcmp(CMD_ARGV[0], "unlock") == 0)
-               {
+               } else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
                        auto_unlock = true;
                        CMD_ARGV++;
                        CMD_ARGC--;
                        command_print(CMD_CTX, "auto unlock enabled");
                } else
-               {
                        break;
-               }
        }
 
        if (CMD_ARGC < 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       if (!target)
-       {
+       if (!target) {
                LOG_ERROR("no target selected");
                return ERROR_FAIL;
        }
@@ -411,13 +382,10 @@ COMMAND_HANDLER(handle_flash_write_image_command)
        struct duration bench;
        duration_start(&bench);
 
-       if (CMD_ARGC >= 2)
-       {
+       if (CMD_ARGC >= 2) {
                image.base_address_set = 1;
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], image.base_address);
-       }
-       else
-       {
+               COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
+       } else {
                image.base_address_set = 0;
                image.base_address = 0x0;
        }
@@ -426,22 +394,18 @@ COMMAND_HANDLER(handle_flash_write_image_command)
 
        retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
        if (retval != ERROR_OK)
-       {
                return retval;
-       }
 
        retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
-       if (retval != ERROR_OK)
-       {
+       if (retval != ERROR_OK) {
                image_close(&image);
                return retval;
        }
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
-       {
-               command_print(CMD_CTX, "wrote %" PRIu32 " byte from file %s "
-                               "in %fs (%0.3f kb/s)", written, CMD_ARGV[0],
-                               duration_elapsed(&bench), duration_kbps(&bench, written));
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+               command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
+                       "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
+                       duration_elapsed(&bench), duration_kbps(&bench, written));
        }
 
        image_close(&image);
@@ -459,124 +423,111 @@ COMMAND_HANDLER(handle_flash_fill_command)
        uint32_t cur_size = 0;
        uint32_t chunk_count;
        struct target *target = get_current_target(CMD_CTX);
-       uint32_t i;
+       unsigned i;
        uint32_t wordsize;
        int retval = ERROR_OK;
 
        static size_t const chunksize = 1024;
-       uint8_t *chunk = malloc(chunksize);
-       if (chunk == NULL)
-               return ERROR_FAIL;
+       uint8_t *chunk = NULL, *readback = NULL;
 
-       uint8_t *readback = malloc(chunksize);
-       if (readback == NULL)
-       {
-               free(chunk);
-               return ERROR_FAIL;
-       }
-
-
-       if (CMD_ARGC != 3)
-       {
+       if (CMD_ARGC != 3) {
                retval = ERROR_COMMAND_SYNTAX_ERROR;
                goto done;
        }
 
-
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
 
+       chunk = malloc(chunksize);
+       if (chunk == NULL)
+               return ERROR_FAIL;
+
+       readback = malloc(chunksize);
+       if (readback == NULL) {
+               free(chunk);
+               return ERROR_FAIL;
+       }
+
        if (count == 0)
                goto done;
 
-       switch (CMD_NAME[4])
-       {
-       case 'w':
-               wordsize = 4;
-               break;
-       case 'h':
-               wordsize = 2;
-               break;
-       case 'b':
-               wordsize = 1;
-               break;
-       default:
-               retval = ERROR_COMMAND_SYNTAX_ERROR;
-               goto done;
+       switch (CMD_NAME[4]) {
+               case 'w':
+                       wordsize = 4;
+                       break;
+               case 'h':
+                       wordsize = 2;
+                       break;
+               case 'b':
+                       wordsize = 1;
+                       break;
+               default:
+                       retval = ERROR_COMMAND_SYNTAX_ERROR;
+                       goto done;
        }
 
        chunk_count = MIN(count, (chunksize / wordsize));
-       switch (wordsize)
-       {
-       case 4:
-               for (i = 0; i < chunk_count; i++)
-               {
-                       target_buffer_set_u32(target, chunk + i * wordsize, pattern);
-               }
-               break;
-       case 2:
-               for (i = 0; i < chunk_count; i++)
-               {
-                       target_buffer_set_u16(target, chunk + i * wordsize, pattern);
-               }
-               break;
-       case 1:
-               memset(chunk, pattern, chunk_count);
-               break;
-       default:
-               LOG_ERROR("BUG: can't happen");
-               exit(-1);
+       switch (wordsize) {
+               case 4:
+                       for (i = 0; i < chunk_count; i++)
+                               target_buffer_set_u32(target, chunk + i * wordsize, pattern);
+                       break;
+               case 2:
+                       for (i = 0; i < chunk_count; i++)
+                               target_buffer_set_u16(target, chunk + i * wordsize, pattern);
+                       break;
+               case 1:
+                       memset(chunk, pattern, chunk_count);
+                       break;
+               default:
+                       LOG_ERROR("BUG: can't happen");
+                       exit(-1);
        }
 
        struct duration bench;
        duration_start(&bench);
 
-       for (wrote = 0; wrote < (count*wordsize); wrote += cur_size)
-       {
-               cur_size = MIN((count*wordsize - wrote), sizeof(chunk));
+       for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) {
                struct flash_bank *bank;
-               bank = get_flash_bank_by_addr(target, address);
-               if (bank == NULL)
-               {
-                       retval = ERROR_FAIL;
+
+               retval = get_flash_bank_by_addr(target, address, true, &bank);
+               if (retval != ERROR_OK)
                        goto done;
-               }
+
+               cur_size = MIN((count * wordsize - wrote), chunksize);
                err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
-               if (err != ERROR_OK)
-               {
+               if (err != ERROR_OK) {
                        retval = err;
                        goto done;
                }
 
-               err = target_read_buffer(target, address + wrote, cur_size, readback);
-               if (err != ERROR_OK)
-               {
+               err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
+               if (err != ERROR_OK) {
                        retval = err;
                        goto done;
                }
 
-               unsigned i;
-               for (i = 0; i < cur_size; i++)
-               {
-                       if (readback[i]!=chunk[i])
-                       {
-                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
-                                                 address + wrote + i, readback[i], chunk[i]);
+               for (i = 0; i < cur_size; i++) {
+                       if (readback[i] != chunk[i]) {
+                               LOG_ERROR(
+                                       "Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
+                                       address + wrote + i,
+                                       readback[i],
+                                       chunk[i]);
                                retval = ERROR_FAIL;
                                goto done;
                        }
                }
        }
 
-       if (duration_measure(&bench) == ERROR_OK)
-       {
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
-                               " in %fs (%0.3f kb/s)", wrote, address,
-                               duration_elapsed(&bench), duration_kbps(&bench, wrote));
+                       " in %fs (%0.3f KiB/s)", wrote, address,
+                       duration_elapsed(&bench), duration_kbps(&bench, wrote));
        }
 
-       done:
+done:
        free(readback);
        free(chunk);
 
@@ -603,14 +554,23 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
 
        if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
-       {
                return ERROR_OK;
+
+       int filesize;
+       retval = fileio_size(&fileio, &filesize);
+       if (retval != ERROR_OK) {
+               fileio_close(&fileio);
+               return retval;
        }
 
-       buffer = malloc(fileio.size);
+       buffer = malloc(filesize);
+       if (buffer == NULL) {
+               fileio_close(&fileio);
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
+       }
        size_t buf_cnt;
-       if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
-       {
+       if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
                free(buffer);
                fileio_close(&fileio);
                return ERROR_OK;
@@ -621,12 +581,11 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        free(buffer);
        buffer = NULL;
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
-       {
-               command_print(CMD_CTX, "wrote %zu byte from file %s to flash bank %u"
-                               " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
-                               fileio.size, CMD_ARGV[1], p->bank_number, offset,
-                               duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+               command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
+                       " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                       (long)filesize, CMD_ARGV[1], p->bank_number, offset,
+                       duration_elapsed(&bench), duration_kbps(&bench, filesize));
        }
 
        fileio_close(&fileio);
@@ -640,106 +599,136 @@ void flash_set_dirty(void)
        int i;
 
        /* set all flash to require erasing */
-       for (c = flash_bank_list(); c; c = c->next)
-       {
+       for (c = flash_bank_list(); c; c = c->next) {
                for (i = 0; i < c->num_sectors; i++)
-               {
                        c->sectors[i].is_erased = 0;
-               }
        }
 }
 
+COMMAND_HANDLER(handle_flash_padded_value_command)
+{
+       if (CMD_ARGC != 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct flash_bank *p;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
+
+       command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
+                       p->default_padded_value, p->bank_number);
+
+       return retval;
+}
+
 static const struct command_registration flash_exec_command_handlers[] = {
        {
                .name = "probe",
-               .handler = &handle_flash_probe_command,
+               .handler = handle_flash_probe_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "identify flash bank",
+               .usage = "bank_id",
+               .help = "Identify a flash bank.",
        },
        {
                .name = "info",
-               .handler = &handle_flash_info_command,
+               .handler = handle_flash_info_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "print bank information",
+               .usage = "bank_id",
+               .help = "Print information about a flash bank.",
        },
        {
                .name = "erase_check",
-               .handler = &handle_flash_erase_check_command,
+               .handler = handle_flash_erase_check_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "check erase state of sectors",
-       },
-       {
-               .name = "protect_check",
-               .handler = &handle_flash_protect_check_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "check protection state of sectors",
+               .usage = "bank_id",
+               .help = "Check erase state of all blocks in a "
+                       "flash bank.",
        },
        {
                .name = "erase_sector",
-               .handler = &handle_flash_erase_command,
+               .handler = handle_flash_erase_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <first> <last>",
-               .help = "erase sectors",
+               .usage = "bank_id first_sector_num last_sector_num",
+               .help = "Erase a range of sectors in a flash bank.",
        },
        {
                .name = "erase_address",
-               .handler = &handle_flash_erase_address_command,
+               .handler = handle_flash_erase_address_command,
                .mode = COMMAND_EXEC,
-               .usage = "<address> <length>",
-               .help = "erase address range",
+               .usage = "['pad'] ['unlock'] address length",
+               .help = "Erase flash sectors starting at address and "
+                       "continuing for length bytes.  If 'pad' is specified, "
+                       "data outside that range may also be erased: the start "
+                       "address may be decreased, and length increased, so "
+                       "that all of the first and last sectors are erased. "
+                       "If 'unlock' is specified, then the flash is unprotected "
+                       "before erasing.",
 
        },
        {
                .name = "fillw",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <word_pattern> <count>",
-               .help = "fill with pattern (no autoerase)",
+               .usage = "address value n",
+               .help = "Fill n words with 32-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "fillh",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <halfword_pattern> <count>",
-               .help = "fill with pattern",
+               .usage = "address value n",
+               .help = "Fill n halfwords with 16-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "fillb",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <byte_pattern> <count>",
-               .help = "fill with pattern",
-
+               .usage = "address value n",
+               .help = "Fill n bytes with 8-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "write_bank",
-               .handler = &handle_flash_write_bank_command,
+               .handler = handle_flash_write_bank_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <file> <offset>",
-               .help = "write binary data",
+               .usage = "bank_id filename offset",
+               .help = "Write binary data from file to flash bank, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank.",
        },
        {
                .name = "write_image",
-               .handler = &handle_flash_write_image_command,
+               .handler = handle_flash_write_image_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> [erase] [unlock] <file> [offset] [type]",
-               .help = "write an image to flash"
+               .usage = "[erase] [unlock] filename [offset [file_type]]",
+               .help = "Write an image to flash.  Optionally first unprotect "
+                       "and/or erase the region to be used.  Allow optional "
+                       "offset from beginning of bank (defaults to zero)",
        },
        {
                .name = "protect",
-               .handler = &handle_flash_protect_command,
+               .handler = handle_flash_protect_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <first> <last> <on | off>",
-               .help = "set protection of sectors",
+               .usage = "bank_id first_sector [last_sector|'last'] "
+                       "('on'|'off')",
+               .help = "Turn protection on or off for a range of sectors "
+                       "in a given flash bank.",
+       },
+       {
+               .name = "padded_value",
+               .handler = handle_flash_padded_value_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id value",
+               .help = "Set default flash padded value",
        },
        COMMAND_REGISTRATION_DONE
 };
 
-int flash_init_drivers(struct command_context *cmd_ctx)
+static int flash_init_drivers(struct command_context *cmd_ctx)
 {
        if (!flash_bank_list())
                return ERROR_OK;
@@ -748,44 +737,45 @@ int flash_init_drivers(struct command_context *cmd_ctx)
        return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
 }
 
-
 COMMAND_HANDLER(handle_flash_bank_command)
 {
-       if (CMD_ARGC < 7)
-       {
+       if (CMD_ARGC < 7) {
                LOG_ERROR("usage: flash bank <name> <driver> "
-                               "<base> <size> <chip_width> <bus_width>");
+                       "<base> <size> <chip_width> <bus_width> <target>");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
-       // save bank name and advance arguments for compatibility
+       /* save bank name and advance arguments for compatibility */
        const char *bank_name = *CMD_ARGV++;
        CMD_ARGC--;
 
-       struct target *target;
-       if ((target = get_target(CMD_ARGV[5])) == NULL)
-       {
+       struct target *target = get_target(CMD_ARGV[5]);
+       if (target == NULL) {
                LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
                return ERROR_FAIL;
        }
 
        const char *driver_name = CMD_ARGV[0];
        struct flash_driver *driver = flash_driver_find_by_name(driver_name);
-       if (NULL == driver)
-       {
+       if (NULL == driver) {
                /* no matching flash driver found */
                LOG_ERROR("flash driver '%s' not found", driver_name);
                return ERROR_FAIL;
        }
 
+       /* check the flash bank name is unique */
+       if (get_flash_bank_by_name_noprobe(bank_name) != NULL) {
+               /* flash bank name already exists  */
+               LOG_ERROR("flash bank name '%s' already exists", bank_name);
+               return ERROR_FAIL;
+       }
+
        /* register flash specific commands */
-       if (NULL != driver->commands)
-       {
+       if (NULL != driver->commands) {
                int retval = register_commands(CMD_CTX, NULL,
                                driver->commands);
-               if (ERROR_OK != retval)
-               {
+               if (ERROR_OK != retval) {
                        LOG_ERROR("couldn't register '%s' commands",
-                                       driver_name);
+                               driver_name);
                        return ERROR_FAIL;
                }
        }
@@ -799,38 +789,54 @@ COMMAND_HANDLER(handle_flash_bank_command)
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
        COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
        COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
+       c->default_padded_value = 0xff;
        c->num_sectors = 0;
        c->sectors = NULL;
        c->next = NULL;
 
        int retval;
        retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
-       if (ERROR_OK != retval)
-       {
-               LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32,
-                               driver_name, c->base);
+       if (ERROR_OK != retval) {
+               LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "Usage %s",
+                       driver_name, c->base, driver->usage);
                free(c);
                return retval;
        }
 
+       if (driver->usage == NULL)
+               LOG_DEBUG("'%s' driver usage field missing", driver_name);
+
        flash_bank_add(c);
 
        return ERROR_OK;
-
 }
 
+COMMAND_HANDLER(handle_flash_banks_command)
+{
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       unsigned n = 0;
+       for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
+               LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
+                       "buswidth %u, chipwidth %u", p->bank_number,
+                       p->name, p->driver->name, p->base, p->size,
+                       p->bus_width, p->chip_width);
+       }
+       return ERROR_OK;
+}
 
-static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
 {
        if (argc != 1) {
-               Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
+               Jim_WrongNumArgs(interp, 1, argv,
+                       "no arguments to 'flash list' command");
                return JIM_ERR;
        }
 
        Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
 
-       for (struct flash_bank *p = flash_bank_list(); p; p = p->next)
-       {
+       for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
                Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
 
                Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
@@ -852,15 +858,13 @@ static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
-
 COMMAND_HANDLER(handle_flash_init_command)
 {
        if (CMD_ARGC != 0)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       static bool flash_initialized = false;
-       if (flash_initialized)
-       {
+       static bool flash_initialized;
+       if (flash_initialized) {
                LOG_INFO("'flash init' has already been called");
                return ERROR_OK;
        }
@@ -873,10 +877,10 @@ COMMAND_HANDLER(handle_flash_init_command)
 static const struct command_registration flash_config_command_handlers[] = {
        {
                .name = "bank",
-               .handler = &handle_flash_bank_command,
+               .handler = handle_flash_bank_command,
                .mode = COMMAND_CONFIG,
-               .usage = "<name> <driver> <base> <size> "
-                       "<chip_width> <bus_width> <target> "
+               .usage = "bank_id driver_name base_address size_bytes "
+                       "chip_width_bytes bus_width_bytes target "
                        "[driver_options ...]",
                .help = "Define a new bank with the given name, "
                        "using the specified NOR flash driver.",
@@ -884,14 +888,20 @@ static const struct command_registration flash_config_command_handlers[] = {
        {
                .name = "init",
                .mode = COMMAND_CONFIG,
-               .handler = &handle_flash_init_command,
-               .help = "initialize flash devices",
+               .handler = handle_flash_init_command,
+               .help = "Initialize flash devices.",
        },
        {
                .name = "banks",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_flash_banks,
-               .help = "return information about the flash banks",
+               .handler = handle_flash_banks_command,
+               .help = "Display table with information about flash banks.",
+       },
+       {
+               .name = "list",
+               .mode = COMMAND_ANY,
+               .jim_handler = jim_flash_list,
+               .help = "Returns a list of details about the flash banks.",
        },
        COMMAND_REGISTRATION_DONE
 };

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)