flash: Add support for Atheros (ath79) SPI interface
[fw/openocd] / src / flash / nor / tcl.c
index 9628684ed6bac7eb680bf977df2aa51d24640b15..b93d12694b0edc4d4e6a95c92877f5f8b77da376 100644 (file)
@@ -70,16 +70,27 @@ COMMAND_HANDLER(handle_flash_info_command)
        struct flash_bank *p;
        int j = 0;
        int retval;
+       bool show_sectors = false;
+       bool prot_block_available;
 
-       if (CMD_ARGC != 1)
+       if (CMD_ARGC < 1 || CMD_ARGC > 2)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
+       if (CMD_ARGC == 2) {
+               if (strcmp("sectors", CMD_ARGV[1]) == 0)
+                       show_sectors = true;
+               else
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
        retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (retval != ERROR_OK)
                return retval;
 
        if (p != NULL) {
                char buf[1024];
+               int num_blocks;
+               struct flash_sector *block_array;
 
                /* attempt auto probe */
                retval = p->driver->auto_probe(p);
@@ -100,22 +111,32 @@ COMMAND_HANDLER(handle_flash_info_command)
                        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)
+               prot_block_available = p->num_prot_blocks && p->prot_blocks;
+               if (!show_sectors && prot_block_available) {
+                       block_array = p->prot_blocks;
+                       num_blocks = p->num_prot_blocks;
+               } else {
+                       block_array = p->sectors;
+                       num_blocks = p->num_sectors;
+               }
+
+               for (j = 0; j < num_blocks; j++) {
+                       char *protect_state = "";
+
+                       if (block_array[j].is_protected == 0)
                                protect_state = "not protected";
-                       else if (p->sectors[j].is_protected == 1)
+                       else if (block_array[j].is_protected == 1)
                                protect_state = "protected";
-                       else
+                       else if (!show_sectors || !prot_block_available)
                                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,
+                               block_array[j].offset,
+                               block_array[j].size,
+                               block_array[j].size >> 10,
                                protect_state);
                }
 
@@ -276,8 +297,8 @@ static int flash_check_sector_parameters(struct command_context *cmd_ctx,
        }
 
        if (!(last <= (num_sectors - 1))) {
-               command_print(cmd_ctx, "ERROR: last sector must be <= %d",
-                       (int) num_sectors - 1);
+               command_print(cmd_ctx, "ERROR: last sector must be <= %" PRIu32,
+                       num_sectors - 1);
                return ERROR_FAIL;
        }
 
@@ -320,7 +341,7 @@ COMMAND_HANDLER(handle_flash_erase_command)
                        "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_protect_command)
@@ -333,30 +354,35 @@ COMMAND_HANDLER(handle_flash_protect_command)
 
        struct flash_bank *p;
        int retval;
+       int num_blocks;
 
        retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (retval != ERROR_OK)
                return retval;
 
+       if (p->num_prot_blocks)
+               num_blocks = p->num_prot_blocks;
+       else
+               num_blocks = p->num_sectors;
+
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
        if (strcmp(CMD_ARGV[2], "last") == 0)
-               last = p->num_sectors - 1;
+               last = num_blocks - 1;
        else
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 
        bool set;
        COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 
-       retval = flash_check_sector_parameters(CMD_CTX, first, last, p->num_sectors);
+       retval = flash_check_sector_parameters(CMD_CTX, first, last, num_blocks);
        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 %d",
-                       (set) ? "set" : "cleared", (int) first,
-                       (int) last, p->bank_number);
+               command_print(CMD_CTX, "%s protection for sectors %" PRIu32
+                       " through %" PRIu32 " on flash bank %d",
+                       (set) ? "set" : "cleared", first, last, p->bank_number);
        }
 
        return retval;
@@ -573,7 +599,7 @@ 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;
+               return ERROR_FAIL;
 
        size_t filesize;
        retval = fileio_size(fileio, &filesize);
@@ -592,7 +618,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
                free(buffer);
                fileio_close(fileio);
-               return ERROR_OK;
+               return ERROR_FAIL;
        }
 
        retval = flash_driver_write(p, buffer, offset, buf_cnt);
@@ -663,9 +689,9 @@ COMMAND_HANDLER(handle_flash_read_bank_command)
        }
 
        if (duration_measure(&bench) == ERROR_OK)
-               command_print(CMD_CTX, "wrote %ld bytes to file %s from flash bank %u"
+               command_print(CMD_CTX, "wrote %zd 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,
+                       written, CMD_ARGV[1], p->bank_number, offset,
                        duration_elapsed(&bench), duration_kbps(&bench, written));
 
        return retval;
@@ -681,7 +707,7 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        size_t filesize;
        int differ;
 
-       if (CMD_ARGC != 3)
+       if (CMD_ARGC < 2 || CMD_ARGC > 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct duration bench;
@@ -692,7 +718,16 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        if (ERROR_OK != retval)
                return retval;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+       offset = 0;
+
+       if (CMD_ARGC > 2)
+               COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+
+       if (offset > p->size) {
+               LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
+                       offset);
+               return ERROR_COMMAND_ARGUMENT_INVALID;
+       }
 
        retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
        if (retval != ERROR_OK) {
@@ -743,9 +778,9 @@ COMMAND_HANDLER(handle_flash_verify_bank_command)
        }
 
        if (duration_measure(&bench) == ERROR_OK)
-               command_print(CMD_CTX, "read %ld bytes from file %s and flash bank %u"
+               command_print(CMD_CTX, "read %zd 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,
+                       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);
@@ -813,7 +848,7 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "info",
                .handler = handle_flash_info_command,
                .mode = COMMAND_EXEC,
-               .usage = "bank_id",
+               .usage = "bank_id ['sectors']",
                .help = "Print information about a flash bank.",
        },
        {
@@ -900,19 +935,20 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .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.",
+               .usage = "bank_id filename [offset]",
+               .help = "Compare the contents of a file with the contents of the "
+                       "flash bank. Allow optional offset from beginning of the bank "
+                       "(defaults to zero).",
        },
        {
                .name = "protect",
                .handler = handle_flash_protect_command,
                .mode = COMMAND_EXEC,
-               .usage = "bank_id first_sector [last_sector|'last'] "
+               .usage = "bank_id first_block [last_block|'last'] "
                        "('on'|'off')",
-               .help = "Turn protection on or off for a range of sectors "
-                       "in a given flash bank.",
+               .help = "Turn protection on or off for a range of protection "
+                       "blocks or sectors in a given flash bank. "
+                       "See 'flash info' output for a list of blocks.",
        },
        {
                .name = "padded_value",
@@ -985,9 +1021,11 @@ 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->default_padded_value = c->erased_value = 0xff;
        c->num_sectors = 0;
        c->sectors = NULL;
+       c->num_prot_blocks = 0;
+       c->prot_blocks = NULL;
        c->next = NULL;
 
        int retval;