command_handler: change to 'argc' to CMD_ARGC
[openocd.git] / src / flash / nand.c
index 9cc08022783801e04f8b91e59fc34c1b5befedc7..9231b9adaa69b28963346e9e794d56d325d2b70c 100644 (file)
@@ -210,7 +210,7 @@ COMMAND_HANDLER(handle_nand_device_command)
        int i;
        int retval;
 
-       if (argc < 1)
+       if (CMD_ARGC < 1)
        {
                LOG_WARNING("incomplete flash device nand configuration");
                return ERROR_FLASH_BANK_INVALID;
@@ -304,9 +304,10 @@ struct nand_device *get_nand_device_by_num(int num)
        return NULL;
 }
 
-int nand_command_get_device_by_num(struct command_context *cmd_ctx,
-               const char *str, struct nand_device **nand)
+COMMAND_HELPER(nand_command_get_device_by_num, unsigned name_index,
+               struct nand_device **nand)
 {
+       const char *str = args[name_index];
        unsigned num;
        COMMAND_PARSE_NUMBER(uint, str, num);
        *nand = get_nand_device_by_num(num);
@@ -1077,11 +1078,11 @@ COMMAND_HANDLER(handle_nand_info_command)
        int last = -1;
 
        struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
-       switch (argc) {
+       switch (CMD_ARGC) {
        default:
                return ERROR_COMMAND_SYNTAX_ERROR;
        case 1:
@@ -1146,13 +1147,13 @@ COMMAND_HANDLER(handle_nand_info_command)
 
 COMMAND_HANDLER(handle_nand_probe_command)
 {
-       if (argc != 1)
+       if (CMD_ARGC != 1)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1174,14 +1175,14 @@ COMMAND_HANDLER(handle_nand_probe_command)
 
 COMMAND_HANDLER(handle_nand_erase_command)
 {
-       if (argc != 1 && argc != 3)
+       if (CMD_ARGC != 1 && CMD_ARGC != 3)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        }
 
        struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1189,7 +1190,7 @@ COMMAND_HANDLER(handle_nand_erase_command)
        unsigned long length;
 
        /* erase specified part of the chip; or else everything */
-       if (argc == 3) {
+       if (CMD_ARGC == 3) {
                unsigned long size = p->erase_size * p->num_blocks;
 
                COMMAND_PARSE_NUMBER(ulong, args[1], offset);
@@ -1233,18 +1234,18 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
        int first = -1;
        int last = -1;
 
-       if ((argc < 1) || (argc > 3) || (argc == 2))
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 3) || (CMD_ARGC == 2))
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        }
 
        struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
-       if (argc == 3)
+       if (CMD_ARGC == 3)
        {
                unsigned long offset;
                unsigned long length;
@@ -1375,24 +1376,24 @@ static int nand_fileio_cleanup(struct nand_fileio_state *state)
        }
        return ERROR_OK;
 }
-int nand_fileio_finish(struct nand_fileio_state *state)
+static int nand_fileio_finish(struct nand_fileio_state *state)
 {
        nand_fileio_cleanup(state);
        return duration_measure(&state->bench);
 }
 
-COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
+static COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
                struct nand_device **dev, enum fileio_access filemode,
                bool need_size, bool sw_ecc)
 {
        nand_fileio_init(state);
 
        unsigned minargs = need_size ? 4 : 3;
-       if (argc < minargs)
+       if (CMD_ARGC < minargs)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct nand_device *nand;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &nand);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &nand);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1413,9 +1414,9 @@ COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
                        }
        }
 
-       if (argc > minargs)
+       if (CMD_ARGC > minargs)
        {
-               for (unsigned i = minargs; i < argc; i++)
+               for (unsigned i = minargs; i < CMD_ARGC; i++)
                {
                        if (!strcmp(args[i], "oob_raw"))
                                state->oob_format |= NAND_OOB_RAW;
@@ -1449,11 +1450,11 @@ COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
  * @returns If no error occurred, returns number of bytes consumed;
  * otherwise, returns a negative error code.)
  */
-int nand_fileio_read(struct nand_device *nand,
+static int nand_fileio_read(struct nand_device *nand,
                struct nand_fileio_state *s)
 {
-       uint32_t total_read = 0;
-       uint32_t one_read;
+       size_t total_read = 0;
+       size_t one_read;
 
        if (NULL != s->page)
        {
@@ -1503,296 +1504,155 @@ int nand_fileio_read(struct nand_device *nand,
 
 COMMAND_HANDLER(handle_nand_write_command)
 {
-       uint32_t offset;
-       uint32_t binary_size;
-       uint32_t buf_cnt;
-       enum oob_formats oob_format = NAND_OOB_NONE;
-
-       struct fileio fileio;
-
-
-       if (argc < 3)
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *nand = NULL;
+       struct nand_fileio_state s;
+       int retval = CALL_COMMAND_HANDLER(nand_fileio_parse_args,
+                       &s, &nand, FILEIO_READ, false, true);
        if (ERROR_OK != retval)
                return retval;
 
-       uint8_t *page = NULL;
-       uint32_t page_size = 0;
-       uint8_t *oob = NULL;
-       uint32_t oob_size = 0;
-       const int *eccpos = NULL;
-
-       COMMAND_PARSE_NUMBER(u32, args[2], offset);
-
-       if (argc > 3)
+       uint32_t total_bytes = s.size;
+       while (s.size > 0)
        {
-               for (unsigned i = 3; i < argc; i++)
+               int bytes_read = nand_fileio_read(nand, &s);
+               if (bytes_read <= 0)
                {
-                       if (!strcmp(args[i], "oob_raw"))
-                               oob_format |= NAND_OOB_RAW;
-                       else if (!strcmp(args[i], "oob_only"))
-                               oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
-                       else if (!strcmp(args[i], "oob_softecc"))
-                               oob_format |= NAND_OOB_SW_ECC;
-                       else if (!strcmp(args[i], "oob_softecc_kw"))
-                               oob_format |= NAND_OOB_SW_ECC_KW;
-                       else
-                       {
-                               command_print(cmd_ctx, "unknown option: %s", args[i]);
-                               return ERROR_COMMAND_SYNTAX_ERROR;
-                       }
+                       command_print(cmd_ctx, "error while reading file");
+                       return nand_fileio_cleanup(&s);
                }
-       }
-
-       struct duration bench;
-       duration_start(&bench);
+               s.size -= bytes_read;
 
-       if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
-       {
-               return ERROR_OK;
+               retval = nand_write_page(nand, s.address / nand->page_size,
+                               s.page, s.page_size, s.oob, s.oob_size);
+               if (ERROR_OK != retval)
+               {
+                       command_print(cmd_ctx, "failed writing file %s "
+                               "to NAND flash %s at offset 0x%8.8" PRIx32,
+                               args[1], args[0], s.address);
+                       return nand_fileio_cleanup(&s);
+               }
+               s.address += s.page_size;
        }
 
-       buf_cnt = binary_size = fileio.size;
-
-       if (!(oob_format & NAND_OOB_ONLY))
+       if (nand_fileio_finish(&s))
        {
-               page_size = p->page_size;
-               page = malloc(p->page_size);
+               command_print(cmd_ctx, "wrote file %s to NAND flash %s up to "
+                               "offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
+                               args[1], args[0], s.address, duration_elapsed(&s.bench),
+                               duration_kbps(&s.bench, total_bytes));
        }
+       return ERROR_OK;
+}
 
-       if (oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC | NAND_OOB_SW_ECC_KW))
-       {
-               if (p->page_size == 512) {
-                       oob_size = 16;
-                       eccpos = nand_oob_16.eccpos;
-               } else if (p->page_size == 2048) {
-                       oob_size = 64;
-                       eccpos = nand_oob_64.eccpos;
-               }
-               oob = malloc(oob_size);
-       }
+COMMAND_HANDLER(handle_nand_verify_command)
+{
+       struct nand_device *nand = NULL;
+       struct nand_fileio_state file;
+       int retval = CALL_COMMAND_HANDLER(nand_fileio_parse_args,
+                       &file, &nand, FILEIO_READ, false, true);
+       if (ERROR_OK != retval)
+               return retval;
 
-       if (offset % p->page_size)
-       {
-               command_print(cmd_ctx, "only page size aligned offsets and sizes are supported");
-               fileio_close(&fileio);
-               free(oob);
-               free(page);
-               return ERROR_OK;
-       }
+       struct nand_fileio_state dev;
+       nand_fileio_init(&dev);
+       dev.address = file.address;
+       dev.size = file.size;
+       dev.oob_format = file.oob_format;
+       retval = nand_fileio_start(cmd_ctx, nand, NULL, FILEIO_NONE, &dev);
+       if (ERROR_OK != retval)
+               return retval;
 
-       while (buf_cnt > 0)
+       while (file.size > 0)
        {
-               uint32_t size_read;
-
-               if (NULL != page)
+               int retval = nand_read_page(nand, dev.address / dev.page_size,
+                               dev.page, dev.page_size, dev.oob, dev.oob_size);
+               if (ERROR_OK != retval)
                {
-                       fileio_read(&fileio, page_size, page, &size_read);
-                       buf_cnt -= size_read;
-                       if (size_read < page_size)
-                       {
-                               memset(page + size_read, 0xff, page_size - size_read);
-                       }
+                       command_print(cmd_ctx, "reading NAND flash page failed");
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
 
-               if (oob_format & NAND_OOB_SW_ECC)
+               int bytes_read = nand_fileio_read(nand, &file);
+               if (bytes_read <= 0)
                {
-                       uint32_t i, j;
-                       uint8_t ecc[3];
-                       memset(oob, 0xff, oob_size);
-                       for (i = 0, j = 0; i < page_size; i += 256) {
-                               nand_calculate_ecc(p, page + i, ecc);
-                               oob[eccpos[j++]] = ecc[0];
-                               oob[eccpos[j++]] = ecc[1];
-                               oob[eccpos[j++]] = ecc[2];
-                       }
-               } else if (oob_format & NAND_OOB_SW_ECC_KW)
-               {
-                       /*
-                        * In this case eccpos is not used as
-                        * the ECC data is always stored contigously
-                        * at the end of the OOB area.  It consists
-                        * of 10 bytes per 512-byte data block.
-                        */
-                       uint32_t i;
-                       uint8_t *ecc = oob + oob_size - page_size/512 * 10;
-                       memset(oob, 0xff, oob_size);
-                       for (i = 0; i < page_size; i += 512) {
-                               nand_calculate_ecc_kw(p, page + i, ecc);
-                               ecc += 10;
-                       }
-               }
-               else if (NULL != oob)
-               {
-                       fileio_read(&fileio, oob_size, oob, &size_read);
-                       buf_cnt -= size_read;
-                       if (size_read < oob_size)
-                       {
-                               memset(oob + size_read, 0xff, oob_size - size_read);
-                       }
+                       command_print(cmd_ctx, "error while reading file");
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
 
-               if (nand_write_page(p, offset / p->page_size, page, page_size, oob, oob_size) != ERROR_OK)
+               if ((dev.page && memcmp(dev.page, file.page, dev.page_size)) ||
+                   (dev.oob && memcmp(dev.oob, file.oob, dev.oob_size)) )
                {
-                       command_print(cmd_ctx, "failed writing file %s to NAND flash %s at offset 0x%8.8" PRIx32 "",
-                               args[1], args[0], offset);
-
-                       fileio_close(&fileio);
-                       free(oob);
-                       free(page);
-
-                       return ERROR_OK;
+                       command_print(cmd_ctx, "NAND flash contents differ "
+                                               "at 0x%8.8" PRIx32, dev.address);
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
-               offset += page_size;
+
+               file.size -= bytes_read;
+               file.address += nand->page_size;
        }
 
-       fileio_close(&fileio);
-       free(oob);
-       free(page);
-       oob = NULL;
-       page = NULL;
-       if (duration_measure(&bench) == ERROR_OK)
+       if (nand_fileio_finish(&file) == ERROR_OK)
        {
-               command_print(cmd_ctx, "wrote file %s to NAND flash %s "
-                       "up to offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
-                       args[1], args[0], offset, duration_elapsed(&bench),
-                       duration_kbps(&bench, fileio.size));
+               command_print(cmd_ctx, "verified file %s in NAND flash %s "
+                               "up to offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
+                               args[1], args[0], dev.address, duration_elapsed(&file.bench),
+                               duration_kbps(&file.bench, dev.size));
        }
 
-       return ERROR_OK;
+       return nand_fileio_cleanup(&dev);
 }
 
 COMMAND_HANDLER(handle_nand_dump_command)
 {
-       if (argc < 4)
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *nand = NULL;
+       struct nand_fileio_state s;
+       int retval = CALL_COMMAND_HANDLER(nand_fileio_parse_args,
+                       &s, &nand, FILEIO_WRITE, true, false);
        if (ERROR_OK != retval)
                return retval;
 
-       if (NULL == p->device)
-       {
-               command_print(cmd_ctx, "#%s: not probed", args[0]);
-               return ERROR_OK;
-       }
-
-       struct fileio fileio;
-
-       uint8_t *page = NULL;
-       uint32_t page_size = 0;
-       uint8_t *oob = NULL;
-       uint32_t oob_size = 0;
-       uint32_t address;
-       COMMAND_PARSE_NUMBER(u32, args[2], address);
-       uint32_t size;
-       COMMAND_PARSE_NUMBER(u32, args[3], size);
-       uint32_t bytes_done = 0;
-       enum oob_formats oob_format = NAND_OOB_NONE;
-
-       if (argc > 4)
-       {
-               for (unsigned i = 4; i < argc; i++)
-               {
-                       if (!strcmp(args[i], "oob_raw"))
-                               oob_format |= NAND_OOB_RAW;
-                       else if (!strcmp(args[i], "oob_only"))
-                               oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
-                       else
-                               command_print(cmd_ctx, "unknown option: '%s'", args[i]);
-               }
-       }
-
-       if ((address % p->page_size) || (size % p->page_size))
-       {
-               command_print(cmd_ctx, "only page size aligned addresses and sizes are supported");
-               return ERROR_OK;
-       }
-
-       if (!(oob_format & NAND_OOB_ONLY))
-       {
-               page_size = p->page_size;
-               page = malloc(p->page_size);
-       }
-
-       if (oob_format & NAND_OOB_RAW)
-       {
-               if (p->page_size == 512)
-                       oob_size = 16;
-               else if (p->page_size == 2048)
-                       oob_size = 64;
-               oob = malloc(oob_size);
-       }
-
-       if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
+       while (s.size > 0)
        {
-               return ERROR_OK;
-       }
-
-       struct duration bench;
-       duration_start(&bench);
-
-       while (size > 0)
-       {
-               uint32_t size_written;
-               if ((retval = nand_read_page(p, address / p->page_size, page, page_size, oob, oob_size)) != ERROR_OK)
+               size_t size_written;
+               int retval = nand_read_page(nand, s.address / nand->page_size,
+                               s.page, s.page_size, s.oob, s.oob_size);
+               if (ERROR_OK != retval)
                {
                        command_print(cmd_ctx, "reading NAND flash page failed");
-                       free(page);
-                       free(oob);
-                       fileio_close(&fileio);
-                       return ERROR_OK;
+                       return nand_fileio_cleanup(&s);
                }
 
-               if (NULL != page)
-               {
-                       fileio_write(&fileio, page_size, page, &size_written);
-                       bytes_done += page_size;
-               }
+               if (NULL != s.page)
+                       fileio_write(&s.fileio, s.page_size, s.page, &size_written);
 
-               if (NULL != oob)
-               {
-                       fileio_write(&fileio, oob_size, oob, &size_written);
-                       bytes_done += oob_size;
-               }
+               if (NULL != s.oob)
+                       fileio_write(&s.fileio, s.oob_size, s.oob, &size_written);
 
-               size -= p->page_size;
-               address += p->page_size;
+               s.size -= nand->page_size;
+               s.address += nand->page_size;
        }
 
-       free(page);
-       page = NULL;
-       free(oob);
-       oob = NULL;
-       fileio_close(&fileio);
-
-       if (duration_measure(&bench) == ERROR_OK)
+       if (nand_fileio_finish(&s) == ERROR_OK)
        {
-               command_print(cmd_ctx, "dumped %lld byte in %fs (%0.3f kb/s)",
-                       fileio.size, duration_elapsed(&bench),
-                       duration_kbps(&bench, fileio.size));
+               command_print(cmd_ctx, "dumped %zu bytes in %fs (%0.3f kb/s)", 
+                               s.fileio.size, duration_elapsed(&s.bench),
+                               duration_kbps(&s.bench, s.fileio.size));
        }
-
        return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_nand_raw_access_command)
 {
-       if ((argc < 1) || (argc > 2))
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        struct nand_device *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1802,7 +1662,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
                return ERROR_OK;
        }
 
-       if (argc == 2)
+       if (CMD_ARGC == 2)
        {
                if (strcmp("enable", args[1]) == 0)
                        p->use_raw = 1;
@@ -1843,6 +1703,10 @@ int nand_init(struct command_context *cmd_ctx)
                        handle_nand_dump_command, COMMAND_EXEC,
                        "dump from NAND flash device <num> <filename> "
                         "<offset> <length> [oob_raw | oob_only]");
+       register_command(cmd_ctx, nand_cmd, "verify",
+                       &handle_nand_verify_command, COMMAND_EXEC,
+                       "verify NAND flash device <num> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]");
        register_command(cmd_ctx, nand_cmd, "write",
                        handle_nand_write_command, COMMAND_EXEC,
                        "write to NAND flash device <num> <filename> <offset> "

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)