flash/nor: fix doc/help and range test for flash protect
[openocd.git] / src / flash / nor / tcl.c
index cf0daf34b77c5a37f61a1641fbad5c8601340572..0b72a1232d5246b5fc54dcb39b006b40fae516f0 100644 (file)
@@ -15,9 +15,7 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 #ifdef HAVE_CONFIG_H
 #include "config.h"
  ***************************************************************************/
 #ifdef HAVE_CONFIG_H
 #include "config.h"
@@ -72,16 +70,27 @@ COMMAND_HANDLER(handle_flash_info_command)
        struct flash_bank *p;
        int j = 0;
        int retval;
        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;
 
                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];
        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);
 
                /* attempt auto probe */
                retval = p->driver->auto_probe(p);
@@ -102,22 +111,32 @@ COMMAND_HANDLER(handle_flash_info_command)
                        p->size,
                        p->bus_width,
                        p->chip_width);
                        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";
                                protect_state = "not protected";
-                       else if (p->sectors[j].is_protected == 1)
+                       else if (block_array[j].is_protected == 1)
                                protect_state = "protected";
                                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,
                                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);
                }
 
                                protect_state);
                }
 
@@ -162,6 +181,7 @@ COMMAND_HANDLER(handle_flash_probe_command)
 
 COMMAND_HANDLER(handle_flash_erase_check_command)
 {
 
 COMMAND_HANDLER(handle_flash_erase_check_command)
 {
+       bool blank = true;
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
@@ -187,10 +207,11 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
                if (p->sectors[j].is_erased == 0)
                        erase_state = "not erased";
                else if (p->sectors[j].is_erased == 1)
                if (p->sectors[j].is_erased == 0)
                        erase_state = "not erased";
                else if (p->sectors[j].is_erased == 1)
-                       erase_state = "erased";
+                       continue;
                else
                        erase_state = "erase state unknown";
 
                else
                        erase_state = "erase state unknown";
 
+               blank = false;
                command_print(CMD_CTX,
                        "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
                        j,
                command_print(CMD_CTX,
                        "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
                        j,
@@ -200,6 +221,8 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
                        erase_state);
        }
 
                        erase_state);
        }
 
+       if (blank)
+               command_print(CMD_CTX, "\tBank is erased");
        return retval;
 }
 
        return retval;
 }
 
@@ -318,7 +341,7 @@ COMMAND_HANDLER(handle_flash_erase_command)
                        "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
                        "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_protect_command)
 }
 
 COMMAND_HANDLER(handle_flash_protect_command)
@@ -331,21 +354,27 @@ COMMAND_HANDLER(handle_flash_protect_command)
 
        struct flash_bank *p;
        int retval;
 
        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;
 
 
        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)
        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);
 
        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;
 
        if (retval != ERROR_OK)
                return retval;
 
@@ -571,7 +600,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)
        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);
 
        size_t filesize;
        retval = fileio_size(fileio, &filesize);
@@ -590,7 +619,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
                free(buffer);
                fileio_close(fileio);
        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);
        }
 
        retval = flash_driver_write(p, buffer, offset, buf_cnt);
@@ -811,7 +840,7 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "info",
                .handler = handle_flash_info_command,
                .mode = COMMAND_EXEC,
                .name = "info",
                .handler = handle_flash_info_command,
                .mode = COMMAND_EXEC,
-               .usage = "bank_id",
+               .usage = "bank_id ['sectors']",
                .help = "Print information about a flash bank.",
        },
        {
                .help = "Print information about a flash bank.",
        },
        {
@@ -907,10 +936,11 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "protect",
                .handler = handle_flash_protect_command,
                .mode = COMMAND_EXEC,
                .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')",
                        "('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",
        },
        {
                .name = "padded_value",
@@ -983,9 +1013,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);
        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_sectors = 0;
        c->sectors = NULL;
+       c->num_prot_blocks = 0;
+       c->prot_blocks = NULL;
        c->next = NULL;
 
        int retval;
        c->next = NULL;
 
        int retval;

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)