flash/nor/tcl: add read_bank and verify_bank
[openocd.git] / src / flash / nor / tcl.c
index 4c64a28d8458f3ce8a41f187b83dbb1f2af9a3ed..709d0c1a708906d1d350ef5c8d7f58e7959e2f9a 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"
  * Implements Tcl commands used to access NOR flash facilities.
  */
 
-COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
-               struct flash_bank **bank)
+COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
+              struct flash_bank **bank, bool do_probe)
 {
        const char *name = CMD_ARGV[name_index];
-       int retval = get_flash_bank_by_name(name, bank);
+       int retval;
+       if (do_probe) {
+               retval = get_flash_bank_by_name(name, bank);
+       } else {
+               *bank  = get_flash_bank_by_name_noprobe(name);
+               retval = ERROR_OK;
+       }
+
        if (retval != ERROR_OK)
                return retval;
        if (*bank)
@@ -44,9 +51,21 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
        unsigned bank_num;
        COMMAND_PARSE_NUMBER(uint, name, bank_num);
 
-       return get_flash_bank_by_num(bank_num, bank);
+       if (do_probe) {
+               return get_flash_bank_by_num(bank_num, bank);
+       } else {
+               *bank  = get_flash_bank_by_num_noprobe(bank_num);
+               retval = (bank) ? ERROR_OK : ERROR_FAIL;
+               return retval;
+       }
 }
 
+COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
+       struct flash_bank **bank)
+{
+       return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
+                                   name_index, bank, true);
+}
 
 COMMAND_HANDLER(handle_flash_info_command)
 {
@@ -61,12 +80,12 @@ COMMAND_HANDLER(handle_flash_info_command)
        if (retval != ERROR_OK)
                return retval;
 
-       if (p != NULL)
-       {
+       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! */
@@ -75,15 +94,15 @@ COMMAND_HANDLER(handle_flash_info_command)
                        return retval;
 
                command_print(CMD_CTX,
-                             "#%" 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++)
-               {
+                       "#%d : %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)
@@ -94,22 +113,24 @@ 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");
+               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)
@@ -118,23 +139,20 @@ COMMAND_HANDLER(handle_flash_probe_command)
        int retval;
 
        if (CMD_ARGC != 1)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
        if (retval != ERROR_OK)
                return retval;
 
-       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 (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;
        }
@@ -145,9 +163,7 @@ COMMAND_HANDLER(handle_flash_probe_command)
 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);
@@ -155,18 +171,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)
@@ -177,15 +192,15 @@ 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)
@@ -198,35 +213,27 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        bool do_unlock = false;
        struct target *target = get_current_target(CMD_CTX);
 
-       while (CMD_ARGC >= 3)
-       {
+       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)
-               {
+               else if (strcmp("unlock", CMD_ARGV[0]) == 0)
                        do_unlock = true;
-               } else
-               {
+               else
                        return ERROR_COMMAND_SYNTAX_ERROR;
-               }
                CMD_ARGC--;
                CMD_ARGV++;
        }
        if (CMD_ARGC != 2)
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
 
-       if (length <= 0)
-       {
+       if (length <= 0) {
                command_print(CMD_CTX, "Length must be >0");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
@@ -235,44 +242,40 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        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);
 
        if (do_unlock)
-       {
                retval = flash_unlock_address_range(target, address, length);
-       }
 
        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 KiB/s)", address, length,
-                               duration_elapsed(&bench), duration_kbps(&bench, length));
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
+               command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")"
+                       " in %fs (%0.3f KiB/s)", address, length,
+                       duration_elapsed(&bench), duration_kbps(&bench, length));
        }
 
        return retval;
 }
 
 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;
        }
 
@@ -300,8 +303,8 @@ COMMAND_HANDLER(handle_flash_erase_command)
        else
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 
-       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;
@@ -309,11 +312,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, p->bank_number, duration_elapsed(&bench));
+                       "through %" PRIu32 " on flash bank %d "
+                       "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
        return ERROR_OK;
@@ -343,19 +345,19 @@ COMMAND_HANDLER(handle_flash_protect_command)
        bool set;
        COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 
-       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 %" PRIu32 "",
+                       "through %i on flash bank %d",
                        (set) ? "set" : "cleared", (int) first,
                        (int) last, p->bank_number);
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_write_image_command)
@@ -367,42 +369,29 @@ 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)
-               {
+       while (CMD_ARGC) {
+               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;
        }
@@ -410,13 +399,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(llong, CMD_ARGV[1], image.base_address);
-       }
-       else
-       {
+       } else {
                image.base_address_set = 0;
                image.base_address = 0x0;
        }
@@ -425,22 +411,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))
-       {
+       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));
+                       "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
+                       duration_elapsed(&bench), duration_kbps(&bench, written));
        }
 
        image_close(&image);
@@ -463,114 +445,103 @@ COMMAND_HANDLER(handle_flash_fill_command)
        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)
-       {
+       for (wrote = 0; wrote < (count*wordsize); wrote += cur_size) {
                struct flash_bank *bank;
 
-               retval = get_flash_bank_by_addr(target, address, true, &bank );
+               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 = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
-               if (err != ERROR_OK)
-               {
+               if (err != ERROR_OK) {
                        retval = err;
                        goto done;
                }
 
-               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]);
+               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 ((retval == ERROR_OK) && (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 KiB/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:
@@ -600,28 +571,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)
-       {
+       if (retval != ERROR_OK) {
                fileio_close(&fileio);
                return retval;
        }
 
        buffer = malloc(filesize);
-       if (buffer == NULL)
-       {
+       if (buffer == NULL) {
                fileio_close(&fileio);
                LOG_ERROR("Out of memory");
                return ERROR_FAIL;
        }
        size_t buf_cnt;
-       if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK)
-       {
+       if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
                free(buffer);
                fileio_close(&fileio);
                return ERROR_OK;
@@ -632,34 +598,207 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        free(buffer);
        buffer = NULL;
 
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
-       {
+       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));
+                       " 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);
+
+       return retval;
+}
+
+COMMAND_HANDLER(handle_flash_read_bank_command)
+{
+       uint32_t offset;
+       uint8_t *buffer;
+       struct fileio fileio;
+       uint32_t length;
+       size_t written;
+
+       if (CMD_ARGC != 4)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct duration bench;
+       duration_start(&bench);
+
+       struct flash_bank *p;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
+
+       buffer = malloc(length);
+       if (buffer == NULL) {
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
        }
 
+       retval = flash_driver_read(p, buffer, offset, length);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Read error");
+               free(buffer);
+               return retval;
+       }
+
+       retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not open file");
+               free(buffer);
+               return retval;
+       }
+
+       retval = fileio_write(&fileio, length, buffer, &written);
        fileio_close(&fileio);
+       free(buffer);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not write file");
+               return ERROR_FAIL;
+       }
+
+       if (duration_measure(&bench) == ERROR_OK)
+               command_print(CMD_CTX, "wrote %ld bytes to file %s from flash bank %u"
+                       " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                       (long)written, CMD_ARGV[1], p->bank_number, offset,
+                       duration_elapsed(&bench), duration_kbps(&bench, written));
 
        return retval;
 }
 
+
+COMMAND_HANDLER(handle_flash_verify_bank_command)
+{
+       uint32_t offset;
+       uint8_t *buffer_file, *buffer_flash;
+       struct fileio fileio;
+       size_t read_cnt;
+       int filesize;
+       int differ;
+
+       if (CMD_ARGC != 3)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct duration bench;
+       duration_start(&bench);
+
+       struct flash_bank *p;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+
+       retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not open file");
+               return retval;
+       }
+
+       retval = fileio_size(&fileio, &filesize);
+       if (retval != ERROR_OK) {
+               fileio_close(&fileio);
+               return retval;
+       }
+
+       buffer_file = malloc(filesize);
+       if (buffer_file == NULL) {
+               LOG_ERROR("Out of memory");
+               fileio_close(&fileio);
+               return ERROR_FAIL;
+       }
+
+       retval = fileio_read(&fileio, filesize, buffer_file, &read_cnt);
+       fileio_close(&fileio);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("File read failure");
+               free(buffer_file);
+               return retval;
+       }
+
+       if (read_cnt != (size_t) filesize) {
+               LOG_ERROR("Short read");
+               free(buffer_file);
+               return ERROR_FAIL;
+       }
+
+       buffer_flash = malloc(filesize);
+       if (buffer_flash == NULL) {
+               LOG_ERROR("Out of memory");
+               free(buffer_file);
+               return ERROR_FAIL;
+       }
+
+       retval = flash_driver_read(p, buffer_flash, offset, read_cnt);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Flash read error");
+               free(buffer_flash);
+               free(buffer_file);
+               return retval;
+       }
+
+       if (duration_measure(&bench) == ERROR_OK)
+               command_print(CMD_CTX, "read %ld bytes from file %s and flash bank %u"
+                       " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                       (long)read_cnt, CMD_ARGV[1], p->bank_number, offset,
+                       duration_elapsed(&bench), duration_kbps(&bench, read_cnt));
+
+       differ = memcmp(buffer_file, buffer_flash, read_cnt);
+       command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
+       if (differ) {
+               uint32_t t;
+               int diffs = 0;
+               for (t = 0; t < read_cnt; t++) {
+                       if (buffer_flash[t] == buffer_file[t])
+                               continue;
+                       command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
+                                       diffs, t + offset, buffer_flash[t], buffer_file[t]);
+                       if (diffs++ >= 127) {
+                               command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
+                               break;
+                       }
+                       keep_alive();
+               }
+       }
+       free(buffer_flash);
+       free(buffer_file);
+
+       return differ ? ERROR_FAIL : ERROR_OK;
+}
+
 void flash_set_dirty(void)
 {
        struct flash_bank *c;
        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",
@@ -746,6 +885,24 @@ static const struct command_registration flash_exec_command_handlers[] = {
                        "and/or erase the region to be used.  Allow optional "
                        "offset from beginning of bank (defaults to zero)",
        },
+       {
+               .name = "read_bank",
+               .handler = handle_flash_read_bank_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id filename offset length",
+               .help = "Read binary data from flash bank to file, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank.",
+       },
+       {
+               .name = "verify_bank",
+               .handler = handle_flash_verify_bank_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id filename offset",
+               .help = "Read binary data from flash bank and file, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank. Compare the contents.",
+       },
        {
                .name = "protect",
                .handler = handle_flash_protect_command,
@@ -755,6 +912,13 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .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
 };
 
@@ -767,52 +931,45 @@ static 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> <target>");
+                       "<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)
-       {
+       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;
                }
        }
@@ -826,20 +983,23 @@ 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;
@@ -848,12 +1008,11 @@ COMMAND_HANDLER(handle_flash_bank_command)
 COMMAND_HANDLER(handle_flash_banks_command)
 {
        if (CMD_ARGC != 0)
-               return ERROR_INVALID_ARGUMENTS;
+               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 ", "
+       for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
+               LOG_USER("#%d : %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);
@@ -861,19 +1020,17 @@ COMMAND_HANDLER(handle_flash_banks_command)
        return ERROR_OK;
 }
 
-static int jim_flash_list(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)
-       {
+       if (argc != 1) {
                Jim_WrongNumArgs(interp, 1, argv,
-                               "no arguments to 'flash list' command");
+                       "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));
@@ -895,15 +1052,13 @@ static int jim_flash_list(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;
        }

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)