add const keyword to some APIs
[openocd.git] / src / flash / nand.c
index 9851e7895da060237f06e184add13aab5d7e00d2..c1be276d1e6b2894a966a33cf9b600213dbc2914 100644 (file)
 #include "time_support.h"
 #include "fileio.h"
 
-static int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-
-static int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-
 static int nand_read_page(struct nand_device_s *device, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
 //static int nand_read_plain(struct nand_device_s *device, uint32_t address, uint8_t *data, uint32_t data_size);
 
@@ -52,6 +42,7 @@ extern nand_flash_controller_t s3c2410_nand_controller;
 extern nand_flash_controller_t s3c2412_nand_controller;
 extern nand_flash_controller_t s3c2440_nand_controller;
 extern nand_flash_controller_t s3c2443_nand_controller;
+extern nand_flash_controller_t imx31_nand_flash_controller;
 
 /* extern nand_flash_controller_t boundary_scan_nand_controller; */
 
@@ -64,6 +55,7 @@ static nand_flash_controller_t *nand_flash_controllers[] =
        &s3c2412_nand_controller,
        &s3c2440_nand_controller,
        &s3c2443_nand_controller,
+       &imx31_nand_flash_controller,
 /*     &boundary_scan_nand_controller, */
        NULL
 };
@@ -295,32 +287,6 @@ int nand_register_commands(struct command_context_s *cmd_ctx)
        return ERROR_OK;
 }
 
-int nand_init(struct command_context_s *cmd_ctx)
-{
-       if (nand_devices)
-       {
-               register_command(cmd_ctx, nand_cmd, "list", handle_nand_list_command, COMMAND_EXEC,
-                                                "list configured NAND flash devices");
-               register_command(cmd_ctx, nand_cmd, "info", handle_nand_info_command, COMMAND_EXEC,
-                                                "print info about NAND flash device <num>");
-               register_command(cmd_ctx, nand_cmd, "probe", handle_nand_probe_command, COMMAND_EXEC,
-                                                "identify NAND flash device <num>");
-               register_command(cmd_ctx, nand_cmd, "check_bad_blocks", handle_nand_check_bad_blocks_command, COMMAND_EXEC,
-                                                "check NAND flash device <num> for bad blocks [<offset> <length>]");
-               register_command(cmd_ctx, nand_cmd, "erase", handle_nand_erase_command, COMMAND_EXEC,
-                                                "erase blocks on NAND flash device <num> <offset> <length>");
-               register_command(cmd_ctx, nand_cmd, "dump", 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, "write", handle_nand_write_command, COMMAND_EXEC,
-                                                "write to NAND flash device <num> <filename> <offset> [oob_raw|oob_only|oob_softecc|oob_softecc_kw]");
-               register_command(cmd_ctx, nand_cmd, "raw_access", handle_nand_raw_access_command, COMMAND_EXEC,
-                                                "raw access to NAND flash device <num> ['enable'|'disable']");
-       }
-
-       return ERROR_OK;
-}
-
 nand_device_t *get_nand_device_by_num(int num)
 {
        nand_device_t *p;
@@ -337,6 +303,19 @@ nand_device_t *get_nand_device_by_num(int num)
        return NULL;
 }
 
+int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,
+               const char *str, nand_device_t **device)
+{
+       unsigned num;
+       COMMAND_PARSE_NUMBER(uint, str, num);
+       *device = get_nand_device_by_num(num);
+       if (!*device) {
+               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", str);
+               return ERROR_INVALID_ARGUMENTS;
+       }
+       return ERROR_OK;
+}
+
 static int nand_build_bbt(struct nand_device_s *device, int first, int last)
 {
        uint32_t page = 0x0;
@@ -635,7 +614,7 @@ int nand_probe(struct nand_device_s *device)
        return ERROR_OK;
 }
 
-int nand_erase(struct nand_device_s *device, int first_block, int last_block)
+static int nand_erase(struct nand_device_s *device, int first_block, int last_block)
 {
        int i;
        uint32_t page;
@@ -710,8 +689,11 @@ int nand_erase(struct nand_device_s *device, int first_block, int last_block)
 
                if (status & 0x1)
                {
-                       LOG_ERROR("erase operation didn't pass, status: 0x%2.2x", status);
-                       return ERROR_NAND_OPERATION_FAILED;
+                       LOG_ERROR("didn't erase %sblock %d; status: 0x%2.2x",
+                                       (device->blocks[i].is_bad == 1)
+                                               ? "bad " : "",
+                                       i, status);
+                       /* continue; other blocks might still be erasable */
                }
 
                device->blocks[i].is_erased = 1;
@@ -736,7 +718,7 @@ static int nand_read_plain(struct nand_device_s *device, uint32_t address, uint8
 
        page = malloc(device->page_size);
 
-       while (data_size > 0 )
+       while (data_size > 0)
        {
                uint32_t thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
                uint32_t page_address;
@@ -773,7 +755,7 @@ static int nand_write_plain(struct nand_device_s *device, uint32_t address, uint
 
        page = malloc(device->page_size);
 
-       while (data_size > 0 )
+       while (data_size > 0)
        {
                uint32_t thisrun_size = (data_size > device->page_size) ? device->page_size : data_size;
                uint32_t page_address;
@@ -1073,8 +1055,12 @@ int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char
        for (p = nand_devices, i = 0; p; p = p->next, i++)
        {
                if (p->device)
-                       command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
-                               i, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
+                       command_print(cmd_ctx, "#%i: %s (%s) "
+                               "pagesize: %i, buswidth: %i,\n\t"
+                               "blocksize: %i, blocks: %i",
+                               i, p->device->name, p->manufacturer->name,
+                               p->page_size, p->bus_width,
+                               p->erase_size, p->num_blocks);
                else
                        command_print(cmd_ctx, "#%i: not probed", i);
        }
@@ -1084,12 +1070,16 @@ int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char
 
 static int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
        int i = 0;
        int j = 0;
        int first = -1;
        int last = -1;
 
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
+
        switch (argc) {
        default:
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -1098,59 +1088,56 @@ static int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd
                last = INT32_MAX;
                break;
        case 2:
-               first = last = strtoul(args[1], NULL, 0);
+               COMMAND_PARSE_NUMBER(int, args[1], i);
+               first = last = i;
+               i = 0;
                break;
        case 3:
-               first = strtoul(args[1], NULL, 0);
-               last = strtoul(args[2], NULL, 0);
+               COMMAND_PARSE_NUMBER(int, args[1], first);
+               COMMAND_PARSE_NUMBER(int, args[2], last);
                break;
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
+       if (NULL == p->device)
        {
-               if (p->device)
-               {
-                       if (first >= p->num_blocks)
-                               first = p->num_blocks - 1;
+               command_print(cmd_ctx, "#%s: not probed", args[0]);
+               return ERROR_OK;
+       }
 
-                       if (last >= p->num_blocks)
-                               last = p->num_blocks - 1;
+       if (first >= p->num_blocks)
+               first = p->num_blocks - 1;
 
-                       command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
-                               i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
+       if (last >= p->num_blocks)
+               last = p->num_blocks - 1;
 
-                       for (j = first; j <= last; j++)
-                       {
-                               char *erase_state, *bad_state;
+       command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i",
+               i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size);
 
-                               if (p->blocks[j].is_erased == 0)
-                                       erase_state = "not erased";
-                               else if (p->blocks[j].is_erased == 1)
-                                       erase_state = "erased";
-                               else
-                                       erase_state = "erase state unknown";
+       for (j = first; j <= last; j++)
+       {
+               char *erase_state, *bad_state;
 
-                               if (p->blocks[j].is_bad == 0)
-                                       bad_state = "";
-                               else if (p->blocks[j].is_bad == 1)
-                                       bad_state = " (marked bad)";
-                               else
-                                       bad_state = " (block condition unknown)";
-
-                               command_print(cmd_ctx, 
-                                             "\t#%i: 0x%8.8" PRIx32 " (%" PRId32 "kB) %s%s",
-                                             j,
-                                             p->blocks[j].offset, 
-                                             p->blocks[j].size / 1024,
-                                             erase_state, 
-                                             bad_state);
-                       }
-               }
+               if (p->blocks[j].is_erased == 0)
+                       erase_state = "not erased";
+               else if (p->blocks[j].is_erased == 1)
+                       erase_state = "erased";
                else
-               {
-                       command_print(cmd_ctx, "#%s: not probed", args[0]);
-               }
+                       erase_state = "erase state unknown";
+
+               if (p->blocks[j].is_bad == 0)
+                       bad_state = "";
+               else if (p->blocks[j].is_bad == 1)
+                       bad_state = " (marked bad)";
+               else
+                       bad_state = " (block condition unknown)";
+
+               command_print(cmd_ctx,
+                             "\t#%i: 0x%8.8" PRIx32 " (%" PRId32 "kB) %s%s",
+                             j,
+                             p->blocks[j].offset,
+                             p->blocks[j].size / 1024,
+                             erase_state,
+                             bad_state);
        }
 
        return ERROR_OK;
@@ -1158,33 +1145,27 @@ static int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd
 
 static int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
-       int retval;
-
        if (argc != 1)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if ((retval = nand_probe(p)) == ERROR_OK)
        {
-               if ((retval = nand_probe(p)) == ERROR_OK)
-               {
-                       command_print(cmd_ctx, "NAND flash device '%s' found", p->device->name);
-               }
-               else if (retval == ERROR_NAND_OPERATION_FAILED)
-               {
-                       command_print(cmd_ctx, "probing failed for NAND flash device");
-               }
-               else
-               {
-                       command_print(cmd_ctx, "unknown error when probing NAND flash device");
-               }
+               command_print(cmd_ctx, "NAND flash device '%s' found", p->device->name);
+       }
+       else if (retval == ERROR_NAND_OPERATION_FAILED)
+       {
+               command_print(cmd_ctx, "probing failed for NAND flash device");
        }
        else
        {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
+               command_print(cmd_ctx, "unknown error when probing NAND flash device");
        }
 
        return ERROR_OK;
@@ -1192,56 +1173,55 @@ static int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cm
 
 static int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
-       int retval;
-
-       if (argc != 3)
+       if (argc != 1 && argc != 3)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
-       {
-               char *cp;
-               unsigned long offset;
-               unsigned long length;
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
 
-               offset = strtoul(args[1], &cp, 0);
-               if (*cp || offset == ULONG_MAX || offset % p->erase_size)
-               {
+       unsigned long offset;
+       unsigned long length;
+
+       /* erase specified part of the chip; or else everything */
+       if (argc == 3) {
+               unsigned long size = p->erase_size * p->num_blocks;
+
+               COMMAND_PARSE_NUMBER(ulong, args[1], offset);
+               if ((offset % p->erase_size) != 0 || offset >= size)
                        return ERROR_INVALID_ARGUMENTS;
-               }
-               offset /= p->erase_size;
 
-               length = strtoul(args[2], &cp, 0);
-               if (*cp || length == ULONG_MAX || length % p->erase_size)
-               {
+               COMMAND_PARSE_NUMBER(ulong, args[2], length);
+               if ((length == 0) || (length % p->erase_size) != 0
+                               || (length + offset) > size)
                        return ERROR_INVALID_ARGUMENTS;
-               }
-               length -= 1;
+
+               offset /= p->erase_size;
                length /= p->erase_size;
+       } else {
+               offset = 0;
+               length = p->num_blocks;
+       }
 
-               retval = nand_erase(p, offset, offset + length);
-               if (retval == ERROR_OK)
-               {
-                       command_print(cmd_ctx, "successfully erased blocks "
-                                       "%lu to %lu on NAND flash device '%s'",
-                                       offset, offset + length, p->device->name);
-               }
-               else if (retval == ERROR_NAND_OPERATION_FAILED)
-               {
-                       command_print(cmd_ctx, "erase failed");
-               }
-               else
-               {
-                       command_print(cmd_ctx, "unknown error when erasing NAND flash device");
-               }
+       retval = nand_erase(p, offset, offset + length - 1);
+       if (retval == ERROR_OK)
+       {
+               command_print(cmd_ctx, "erased blocks %lu to %lu "
+                               "on NAND flash device #%s '%s'",
+                               offset, offset + length,
+                               args[0], p->device->name);
+       }
+       else if (retval == ERROR_NAND_OPERATION_FAILED)
+       {
+               command_print(cmd_ctx, "erase failed");
        }
        else
        {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
+               command_print(cmd_ctx, "unknown error when erasing NAND flash device");
        }
 
        return ERROR_OK;
@@ -1249,8 +1229,6 @@ static int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cm
 
 int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
-       int retval;
        int first = -1;
        int last = -1;
 
@@ -1260,31 +1238,25 @@ int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char
 
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (!p) {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds",
-                               args[0]);
-               return ERROR_INVALID_ARGUMENTS;
-       }
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
 
        if (argc == 3)
        {
-               char *cp;
                unsigned long offset;
                unsigned long length;
 
-               offset = strtoul(args[1], &cp, 0);
-               if (*cp || offset == ULONG_MAX || offset % p->erase_size)
-               {
+               COMMAND_PARSE_NUMBER(ulong, args[1], offset);
+               if (offset % p->erase_size)
                        return ERROR_INVALID_ARGUMENTS;
-               }
                offset /= p->erase_size;
 
-               length = strtoul(args[2], &cp, 0);
-               if (*cp || length == ULONG_MAX || length % p->erase_size)
-               {
+               COMMAND_PARSE_NUMBER(ulong, args[2], length);
+               if (length % p->erase_size)
                        return ERROR_INVALID_ARGUMENTS;
-               }
+
                length -= 1;
                length /= p->erase_size;
 
@@ -1321,164 +1293,159 @@ static int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cm
 
        fileio_t fileio;
 
-       duration_t duration;
-       char *duration_text;
-
-       nand_device_t *p;
 
        if (argc < 3)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
-
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
-       {
-               uint8_t *page = NULL;
-               uint32_t page_size = 0;
-               uint8_t *oob = NULL;
-               uint32_t oob_size = 0;
-               const int *eccpos = NULL;
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       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;
 
-               offset = strtoul(args[2], NULL, 0);
+       COMMAND_PARSE_NUMBER(u32, args[2], offset);
 
-               if (argc > 3)
+       if (argc > 3)
+       {
+               int i;
+               for (i = 3; i < argc; i++)
                {
-                       int i;
-                       for (i = 3; 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 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
                        {
-                               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, "unknown option: %s", args[i]);
+                               return ERROR_COMMAND_SYNTAX_ERROR;
                        }
                }
+       }
 
-               duration_start_measure(&duration);
+       struct duration bench;
+       duration_start(&bench);
 
-               if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
-               {
-                       return ERROR_OK;
-               }
+       if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
+       {
+               return ERROR_OK;
+       }
 
-               buf_cnt = binary_size = fileio.size;
+       buf_cnt = binary_size = fileio.size;
 
-               if (!(oob_format & NAND_OOB_ONLY))
-               {
-                       page_size = p->page_size;
-                       page = malloc(p->page_size);
-               }
+       if (!(oob_format & NAND_OOB_ONLY))
+       {
+               page_size = p->page_size;
+               page = malloc(p->page_size);
+       }
 
-               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);
+       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);
+       }
 
-               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;
-               }
+       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;
+       }
 
-               while (buf_cnt > 0)
-               {
-                       uint32_t size_read;
+       while (buf_cnt > 0)
+       {
+               uint32_t size_read;
 
-                       if (NULL != page)
+               if (NULL != page)
+               {
+                       fileio_read(&fileio, page_size, page, &size_read);
+                       buf_cnt -= size_read;
+                       if (size_read < page_size)
                        {
-                               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);
-                               }
+                               memset(page + size_read, 0xff, page_size - size_read);
                        }
+               }
 
-                       if (oob_format & NAND_OOB_SW_ECC)
-                       {
-                               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;
-                               }
+               if (oob_format & NAND_OOB_SW_ECC)
+               {
+                       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)
+               }
+               else if (NULL != oob)
+               {
+                       fileio_read(&fileio, oob_size, oob, &size_read);
+                       buf_cnt -= size_read;
+                       if (size_read < oob_size)
                        {
-                               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);
-                               }
+                               memset(oob + size_read, 0xff, oob_size - size_read);
                        }
+               }
 
-                       if (nand_write_page(p, offset / p->page_size, page, page_size, oob, oob_size) != ERROR_OK)
-                       {
-                               command_print(cmd_ctx, "failed writing file %s to NAND flash %s at offset 0x%8.8" PRIx32 "",
-                                       args[1], args[0], offset);
+               if (nand_write_page(p, offset / p->page_size, page, page_size, oob, oob_size) != ERROR_OK)
+               {
+                       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);
+                       fileio_close(&fileio);
+                       free(oob);
+                       free(page);
 
-                               return ERROR_OK;
-                       }
-                       offset += page_size;
+                       return ERROR_OK;
                }
-
-               fileio_close(&fileio);
-               free(oob);
-               free(page);
-               oob = NULL;
-               page = NULL;
-               duration_stop_measure(&duration, &duration_text);
-               command_print(cmd_ctx, "wrote file %s to NAND flash %s up to offset 0x%8.8" PRIx32 " in %s",
-                       args[1], args[0], offset, duration_text);
-               free(duration_text);
-               duration_text = NULL;
+               offset += page_size;
        }
-       else
+
+       fileio_close(&fileio);
+       free(oob);
+       free(page);
+       oob = NULL;
+       page = NULL;
+       if (duration_measure(&bench) == ERROR_OK)
        {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
+               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));
        }
 
        return ERROR_OK;
@@ -1486,121 +1453,117 @@ static int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cm
 
 static int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
-
        if (argc < 4)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
-       {
-               if (p->device)
-               {
-                       fileio_t fileio;
-                       duration_t duration;
-                       char *duration_text;
-                       int retval;
-
-                       uint8_t *page = NULL;
-                       uint32_t page_size = 0;
-                       uint8_t *oob = NULL;
-                       uint32_t oob_size = 0;
-                       uint32_t address = strtoul(args[2], NULL, 0);
-                       uint32_t size = strtoul(args[3], NULL, 0);
-                       uint32_t bytes_done = 0;
-                       enum oob_formats oob_format = NAND_OOB_NONE;
-
-                       if (argc > 4)
-                       {
-                               int i;
-                               for (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]);
-                               }
-                       }
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
 
-                       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 (NULL == p->device)
+       {
+               command_print(cmd_ctx, "#%s: not probed", args[0]);
+               return ERROR_OK;
+       }
 
-                       if (!(oob_format & NAND_OOB_ONLY))
-                       {
-                               page_size = p->page_size;
-                               page = malloc(p->page_size);
-                       }
+       fileio_t fileio;
 
-                       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);
-                       }
+       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 (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
-                       {
-                               return ERROR_OK;
-                       }
+       if (argc > 4)
+       {
+               int i;
+               for (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]);
+               }
+       }
 
-                       duration_start_measure(&duration);
+       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;
+       }
 
-                       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)
-                               {
-                                       command_print(cmd_ctx, "reading NAND flash page failed");
-                                       free(page);
-                                       free(oob);
-                                       fileio_close(&fileio);
-                                       return ERROR_OK;
-                               }
+       if (!(oob_format & NAND_OOB_ONLY))
+       {
+               page_size = p->page_size;
+               page = malloc(p->page_size);
+       }
 
-                               if (NULL != page)
-                               {
-                                       fileio_write(&fileio, page_size, page, &size_written);
-                                       bytes_done += 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 (NULL != oob)
-                               {
-                                       fileio_write(&fileio, oob_size, oob, &size_written);
-                                       bytes_done += oob_size;
-                               }
+       if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
+       {
+               return ERROR_OK;
+       }
 
-                               size -= p->page_size;
-                               address += p->page_size;
-                       }
+       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)
+               {
+                       command_print(cmd_ctx, "reading NAND flash page failed");
                        free(page);
-                       page = NULL;
                        free(oob);
-                       oob = NULL;
                        fileio_close(&fileio);
+                       return ERROR_OK;
+               }
 
-                       duration_stop_measure(&duration, &duration_text);
-                       command_print(cmd_ctx, "dumped %lld byte in %s", fileio.size, duration_text);
-                       free(duration_text);
-                       duration_text = NULL;
+               if (NULL != page)
+               {
+                       fileio_write(&fileio, page_size, page, &size_written);
+                       bytes_done += page_size;
                }
-               else
+
+               if (NULL != oob)
                {
-                       command_print(cmd_ctx, "#%s: not probed", args[0]);
+                       fileio_write(&fileio, oob_size, oob, &size_written);
+                       bytes_done += oob_size;
                }
+
+               size -= p->page_size;
+               address += p->page_size;
        }
-       else
+
+       free(page);
+       page = NULL;
+       free(oob);
+       oob = NULL;
+       fileio_close(&fileio);
+
+       if (duration_measure(&bench) == ERROR_OK)
        {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
+               command_print(cmd_ctx, "dumped %lld byte in %fs (%0.3f kb/s)",
+                       fileio.size, duration_elapsed(&bench),
+                       duration_kbps(&bench, fileio.size));
        }
 
        return ERROR_OK;
@@ -1608,45 +1571,71 @@ static int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd
 
 static int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       nand_device_t *p;
-
        if ((argc < 1) || (argc > 2))
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_nand_device_by_num(strtoul(args[0], NULL, 0));
-       if (p)
-       {
-               if (p->device)
-               {
-                       if (argc == 2)
-                       {
-                               if (strcmp("enable", args[1]) == 0)
-                               {
-                                       p->use_raw = 1;
-                               }
-                               else if (strcmp("disable", args[1]) == 0)
-                               {
-                                       p->use_raw = 0;
-                               }
-                               else
-                               {
-                                       return ERROR_COMMAND_SYNTAX_ERROR;
-                               }
-                       }
+       nand_device_t *p;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       if (ERROR_OK != retval)
+               return retval;
 
-                       command_print(cmd_ctx, "raw access is %s", (p->use_raw) ? "enabled" : "disabled");
-               }
-               else
-               {
-                       command_print(cmd_ctx, "#%s: not probed", args[0]);
-               }
+       if (NULL == p->device)
+       {
+               command_print(cmd_ctx, "#%s: not probed", args[0]);
+               return ERROR_OK;
        }
-       else
+
+       if (argc == 2)
        {
-               command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]);
+               if (strcmp("enable", args[1]) == 0)
+                       p->use_raw = 1;
+               else if (strcmp("disable", args[1]) == 0)
+                       p->use_raw = 0;
+               else
+                       return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
+       const char *msg = p->use_raw ? "enabled" : "disabled";
+       command_print(cmd_ctx, "raw access is %s", msg);
+
+       return ERROR_OK;
+}
+
+int nand_init(struct command_context_s *cmd_ctx)
+{
+       if (!nand_devices)
+               return ERROR_OK;
+
+       register_command(cmd_ctx, nand_cmd, "list",
+                       handle_nand_list_command, COMMAND_EXEC,
+                       "list configured NAND flash devices");
+       register_command(cmd_ctx, nand_cmd, "info",
+                       handle_nand_info_command, COMMAND_EXEC,
+                       "print info about NAND flash device <num>");
+       register_command(cmd_ctx, nand_cmd, "probe",
+                       handle_nand_probe_command, COMMAND_EXEC,
+                       "identify NAND flash device <num>");
+
+       register_command(cmd_ctx, nand_cmd, "check_bad_blocks",
+                       handle_nand_check_bad_blocks_command, COMMAND_EXEC,
+                       "check NAND flash device <num> for bad blocks [<offset> <length>]");
+       register_command(cmd_ctx, nand_cmd, "erase",
+                       handle_nand_erase_command, COMMAND_EXEC,
+                       "erase blocks on NAND flash device <num> [<offset> <length>]");
+       register_command(cmd_ctx, nand_cmd, "dump",
+                       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, "write",
+                       handle_nand_write_command, COMMAND_EXEC,
+                       "write to NAND flash device <num> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]");
+
+       register_command(cmd_ctx, nand_cmd, "raw_access",
+                       handle_nand_raw_access_command, COMMAND_EXEC,
+                       "raw access to NAND flash device <num> ['enable'|'disable']");
+
        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)