struct fileio: improve member types
[openocd.git] / src / flash / nand.c
index 181700d04f183170e0274f7e17a702c5e66dd9df..9d997fadd8a25127cadc9f3b835e7db5e21a26b3 100644 (file)
 #include "time_support.h"
 #include "fileio.h"
 
-static int nand_read_page(struct nand_device_s *nand, 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 *nand, uint32_t address, uint8_t *data, uint32_t data_size);
+static int nand_read_page(struct nand_device *nand, 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 *nand, uint32_t address, uint8_t *data, uint32_t data_size);
 
-static int nand_write_page(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
+static int nand_write_page(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size);
 
 /* NAND flash controller
  */
-extern nand_flash_controller_t davinci_nand_controller;
-extern nand_flash_controller_t lpc3180_nand_controller;
-extern nand_flash_controller_t orion_nand_controller;
-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; */
-
-static nand_flash_controller_t *nand_flash_controllers[] =
+extern struct nand_flash_controller davinci_nand_controller;
+extern struct nand_flash_controller lpc3180_nand_controller;
+extern struct nand_flash_controller orion_nand_controller;
+extern struct nand_flash_controller s3c2410_nand_controller;
+extern struct nand_flash_controller s3c2412_nand_controller;
+extern struct nand_flash_controller s3c2440_nand_controller;
+extern struct nand_flash_controller s3c2443_nand_controller;
+extern struct nand_flash_controller imx31_nand_flash_controller;
+
+/* extern struct nand_flash_controller boundary_scan_nand_controller; */
+
+static struct nand_flash_controller *nand_flash_controllers[] =
 {
        &davinci_nand_controller,
        &lpc3180_nand_controller,
@@ -61,8 +61,8 @@ static nand_flash_controller_t *nand_flash_controllers[] =
 };
 
 /* configured NAND devices and NAND Flash command handler */
-static nand_device_t *nand_devices = NULL;
-static command_t *nand_cmd;
+static struct nand_device *nand_devices = NULL;
+static struct command *nand_cmd;
 
 /*     Chip ID list
  *
@@ -74,7 +74,7 @@ static command_t *nand_cmd;
  *     256     256 Byte page size
  *     512     512 Byte page size
  */
-static nand_info_t nand_flash_ids[] =
+static struct nand_info nand_flash_ids[] =
 {
        /* start "museum" IDs */
        {"NAND 1MiB 5V 8-bit",          0x6e, 256, 1, 0x1000, 0},
@@ -154,7 +154,7 @@ static nand_info_t nand_flash_ids[] =
 
 /* Manufacturer ID list
  */
-static nand_manufacturer_t nand_manuf_ids[] =
+static struct nand_manufacturer nand_manuf_ids[] =
 {
        {0x0, "unknown"},
        {NAND_MFR_TOSHIBA, "Toshiba"},
@@ -173,7 +173,7 @@ static nand_manufacturer_t nand_manuf_ids[] =
  */
 
 #if 0
-static nand_ecclayout_t nand_oob_8 = {
+static struct nand_ecclayout nand_oob_8 = {
        .eccbytes = 3,
        .eccpos = {0, 1, 2},
        .oobfree = {
@@ -184,7 +184,7 @@ static nand_ecclayout_t nand_oob_8 = {
 };
 #endif
 
-static nand_ecclayout_t nand_oob_16 = {
+static struct nand_ecclayout nand_oob_16 = {
        .eccbytes = 6,
        .eccpos = {0, 1, 2, 3, 6, 7},
        .oobfree = {
@@ -192,7 +192,7 @@ static nand_ecclayout_t nand_oob_16 = {
                 . length = 8}}
 };
 
-static nand_ecclayout_t nand_oob_64 = {
+static struct nand_ecclayout nand_oob_64 = {
        .eccbytes = 24,
        .eccpos = {
                   40, 41, 42, 43, 44, 45, 46, 47,
@@ -218,7 +218,7 @@ COMMAND_HANDLER(handle_nand_device_command)
 
        for (i = 0; nand_flash_controllers[i]; i++)
        {
-               nand_device_t *p, *c;
+               struct nand_device *p, *c;
 
                if (strcmp(args[0], nand_flash_controllers[i]->name) == 0)
                {
@@ -229,7 +229,7 @@ COMMAND_HANDLER(handle_nand_device_command)
                                return retval;
                        }
 
-                       c = malloc(sizeof(nand_device_t));
+                       c = malloc(sizeof(struct nand_device));
 
                        c->controller = nand_flash_controllers[i];
                        c->controller_priv = NULL;
@@ -241,7 +241,8 @@ COMMAND_HANDLER(handle_nand_device_command)
                        c->use_raw = 0;
                        c->next = NULL;
 
-                       if ((retval = nand_flash_controllers[i]->nand_device_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
+                       retval = CALL_COMMAND_HANDLER(nand_flash_controllers[i]->nand_device_command, c);
+                       if (ERROR_OK != retval)
                        {
                                LOG_ERROR("'%s' driver rejected nand flash", c->controller->name);
                                free(c);
@@ -278,7 +279,7 @@ COMMAND_HANDLER(handle_nand_device_command)
        return ERROR_OK;
 }
 
-int nand_register_commands(struct command_context_s *cmd_ctx)
+int nand_register_commands(struct command_context *cmd_ctx)
 {
        nand_cmd = register_command(cmd_ctx, NULL, "nand", NULL, COMMAND_ANY, "NAND specific commands");
 
@@ -287,9 +288,9 @@ int nand_register_commands(struct command_context_s *cmd_ctx)
        return ERROR_OK;
 }
 
-nand_device_t *get_nand_device_by_num(int num)
+struct nand_device *get_nand_device_by_num(int num)
 {
-       nand_device_t *p;
+       struct nand_device *p;
        int i = 0;
 
        for (p = nand_devices; p; p = p->next)
@@ -303,9 +304,10 @@ 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 **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);
@@ -316,7 +318,7 @@ int nand_command_get_device_by_num(struct command_context_s *cmd_ctx,
        return ERROR_OK;
 }
 
-static int nand_build_bbt(struct nand_device_s *nand, int first, int last)
+static int nand_build_bbt(struct nand_device *nand, int first, int last)
 {
        uint32_t page = 0x0;
        int i;
@@ -350,7 +352,7 @@ static int nand_build_bbt(struct nand_device_s *nand, int first, int last)
        return ERROR_OK;
 }
 
-int nand_read_status(struct nand_device_s *nand, uint8_t *status)
+int nand_read_status(struct nand_device *nand, uint8_t *status)
 {
        if (!nand->device)
                return ERROR_NAND_DEVICE_NOT_PROBED;
@@ -375,7 +377,7 @@ int nand_read_status(struct nand_device_s *nand, uint8_t *status)
        return ERROR_OK;
 }
 
-static int nand_poll_ready(struct nand_device_s *nand, int timeout)
+static int nand_poll_ready(struct nand_device *nand, int timeout)
 {
        uint8_t status;
 
@@ -396,7 +398,7 @@ static int nand_poll_ready(struct nand_device_s *nand, int timeout)
        return (status & NAND_STATUS_READY) != 0;
 }
 
-int nand_probe(struct nand_device_s *nand)
+int nand_probe(struct nand_device *nand)
 {
        uint8_t manufacturer_id, device_id;
        uint8_t id_buff[6];
@@ -601,7 +603,7 @@ int nand_probe(struct nand_device_s *nand)
        }
 
        nand->num_blocks = (nand->device->chip_size * 1024) / (nand->erase_size / 1024);
-       nand->blocks = malloc(sizeof(nand_block_t) * nand->num_blocks);
+       nand->blocks = malloc(sizeof(struct nand_block) * nand->num_blocks);
 
        for (i = 0; i < nand->num_blocks; i++)
        {
@@ -614,7 +616,7 @@ int nand_probe(struct nand_device_s *nand)
        return ERROR_OK;
 }
 
-static int nand_erase(struct nand_device_s *nand, int first_block, int last_block)
+static int nand_erase(struct nand_device *nand, int first_block, int last_block)
 {
        int i;
        uint32_t page;
@@ -703,7 +705,7 @@ static int nand_erase(struct nand_device_s *nand, int first_block, int last_bloc
 }
 
 #if 0
-static int nand_read_plain(struct nand_device_s *nand, uint32_t address, uint8_t *data, uint32_t data_size)
+static int nand_read_plain(struct nand_device *nand, uint32_t address, uint8_t *data, uint32_t data_size)
 {
        uint8_t *page;
 
@@ -740,7 +742,7 @@ static int nand_read_plain(struct nand_device_s *nand, uint32_t address, uint8_t
        return ERROR_OK;
 }
 
-static int nand_write_plain(struct nand_device_s *nand, uint32_t address, uint8_t *data, uint32_t data_size)
+static int nand_write_plain(struct nand_device *nand, uint32_t address, uint8_t *data, uint32_t data_size)
 {
        uint8_t *page;
 
@@ -778,7 +780,7 @@ static int nand_write_plain(struct nand_device_s *nand, uint32_t address, uint8_
 }
 #endif
 
-int nand_write_page(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
+int nand_write_page(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
 {
        uint32_t block;
 
@@ -795,7 +797,7 @@ int nand_write_page(struct nand_device_s *nand, uint32_t page, uint8_t *data, ui
                return nand->controller->write_page(nand, page, data, data_size, oob, oob_size);
 }
 
-static int nand_read_page(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
+static int nand_read_page(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
 {
        if (!nand->device)
                return ERROR_NAND_DEVICE_NOT_PROBED;
@@ -806,7 +808,7 @@ static int nand_read_page(struct nand_device_s *nand, uint32_t page, uint8_t *da
                return nand->controller->read_page(nand, page, data, data_size, oob, oob_size);
 }
 
-int nand_read_page_raw(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
+int nand_read_page_raw(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
 {
        uint32_t i;
 
@@ -920,7 +922,7 @@ int nand_read_page_raw(struct nand_device_s *nand, uint32_t page, uint8_t *data,
        return ERROR_OK;
 }
 
-int nand_write_page_raw(struct nand_device_s *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
+int nand_write_page_raw(struct nand_device *nand, uint32_t page, uint8_t *data, uint32_t data_size, uint8_t *oob, uint32_t oob_size)
 {
        uint32_t i;
        int retval;
@@ -1043,7 +1045,7 @@ int nand_write_page_raw(struct nand_device_s *nand, uint32_t page, uint8_t *data
 
 COMMAND_HANDLER(handle_nand_list_command)
 {
-       nand_device_t *p;
+       struct nand_device *p;
        int i;
 
        if (!nand_devices)
@@ -1075,8 +1077,8 @@ COMMAND_HANDLER(handle_nand_info_command)
        int first = -1;
        int last = -1;
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1150,8 +1152,8 @@ COMMAND_HANDLER(handle_nand_probe_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1179,8 +1181,8 @@ COMMAND_HANDLER(handle_nand_erase_command)
 
        }
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1238,8 +1240,8 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
 
        }
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1284,288 +1286,361 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
        return ERROR_OK;
 }
 
-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;
-
-       fileio_t fileio;
-
-
-       if (argc < 3)
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
+struct nand_fileio_state {
+       uint32_t address;
+       uint32_t size;
 
-       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;
+       uint32_t page_size;
 
-       uint8_t *page = NULL;
-       uint32_t page_size = 0;
-       uint8_t *oob = NULL;
-       uint32_t oob_size = 0;
-       const int *eccpos = NULL;
+       enum oob_formats oob_format;
+       uint8_t *oob;
+       uint32_t oob_size;
 
-       COMMAND_PARSE_NUMBER(u32, args[2], offset);
+       const int *eccpos;
 
-       if (argc > 3)
-       {
-               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
-                       {
-                               command_print(cmd_ctx, "unknown option: %s", args[i]);
-                               return ERROR_COMMAND_SYNTAX_ERROR;
-                       }
-               }
-       }
+       bool file_opened;
+       struct fileio fileio;
 
        struct duration bench;
-       duration_start(&bench);
-
-       if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
-       {
-               return ERROR_OK;
-       }
+};
 
-       buf_cnt = binary_size = fileio.size;
+static void nand_fileio_init(struct nand_fileio_state *state)
+{
+       memset(state, 0, sizeof(*state));
+       state->oob_format = NAND_OOB_NONE;
+}
 
-       if (!(oob_format & NAND_OOB_ONLY))
+static int nand_fileio_start(struct command_context *cmd_ctx,
+               struct nand_device *nand, const char *filename, int filemode,
+               struct nand_fileio_state *state)
+{
+       if (state->address % nand->page_size)
        {
-               page_size = p->page_size;
-               page = malloc(p->page_size);
+               command_print(cmd_ctx, "only page-aligned addresses are supported");
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       if (oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC | NAND_OOB_SW_ECC_KW))
+       duration_start(&state->bench);
+
+       if (NULL != filename)
        {
-               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;
+               int retval = fileio_open(&state->fileio, filename, filemode, FILEIO_BINARY);
+               if (ERROR_OK != retval)
+               {
+                       const char *msg = (FILEIO_READ == filemode) ? "read" : "write";
+                       command_print(cmd_ctx, "failed to open '%s' for %s access",
+                                       filename, msg);
+                       return retval;
                }
-               oob = malloc(oob_size);
+               state->file_opened = true;
        }
 
-       if (offset % p->page_size)
+       if (!(state->oob_format & NAND_OOB_ONLY))
        {
-               command_print(cmd_ctx, "only page size aligned offsets and sizes are supported");
-               fileio_close(&fileio);
-               free(oob);
-               free(page);
-               return ERROR_OK;
+               state->page_size = nand->page_size;
+               state->page = malloc(nand->page_size);
        }
 
-       while (buf_cnt > 0)
+       if (state->oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC | NAND_OOB_SW_ECC_KW))
        {
-               uint32_t size_read;
-
-               if (NULL != page)
+               if (nand->page_size == 512)
                {
-                       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);
-                       }
-               }
-
-               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;
-                       }
+                       state->oob_size = 16;
+                       state->eccpos = nand_oob_16.eccpos;
                }
-               else if (NULL != oob)
+               else if (nand->page_size == 2048)
                {
-                       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);
-                       }
+                       state->oob_size = 64;
+                       state->eccpos = nand_oob_64.eccpos;
                }
+               state->oob = malloc(state->oob_size);
+       }
 
-               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);
+       return ERROR_OK;
+}
+static int nand_fileio_cleanup(struct nand_fileio_state *state)
+{
+       if (state->file_opened)
+               fileio_close(&state->fileio);
 
-                       return ERROR_OK;
-               }
-               offset += page_size;
+       if (state->oob)
+       {
+               free(state->oob);
+               state->oob = NULL;
        }
-
-       fileio_close(&fileio);
-       free(oob);
-       free(page);
-       oob = NULL;
-       page = NULL;
-       if (duration_measure(&bench) == ERROR_OK)
+       if (state->page)
        {
-               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));
+               free(state->page);
+               state->page = NULL;
        }
-
        return ERROR_OK;
 }
+static int nand_fileio_finish(struct nand_fileio_state *state)
+{
+       nand_fileio_cleanup(state);
+       return duration_measure(&state->bench);
+}
 
-COMMAND_HANDLER(handle_nand_dump_command)
+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)
 {
-       if (argc < 4)
-       {
+       nand_fileio_init(state);
+
+       unsigned minargs = need_size ? 4 : 3;
+       if (argc < minargs)
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *nand;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &nand);
        if (ERROR_OK != retval)
                return retval;
 
-       if (NULL == p->device)
+       if (NULL == nand->device)
        {
                command_print(cmd_ctx, "#%s: not probed", args[0]);
                return ERROR_OK;
        }
 
-       fileio_t 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;
+       COMMAND_PARSE_NUMBER(u32, args[2], state->address);
+       if (need_size)
+       {
+                       COMMAND_PARSE_NUMBER(u32, args[2], state->size);
+                       if (state->size % nand->page_size)
+                       {
+                               command_print(cmd_ctx, "only page-aligned sizes are supported");
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       }
+       }
 
-       if (argc > 4)
+       if (argc > minargs)
        {
-               int i;
-               for (i = 4; i < argc; i++)
+               for (unsigned i = minargs; i < argc; i++)
                {
                        if (!strcmp(args[i], "oob_raw"))
-                               oob_format |= NAND_OOB_RAW;
+                               state->oob_format |= NAND_OOB_RAW;
                        else if (!strcmp(args[i], "oob_only"))
-                               oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
+                               state->oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
+                       else if (sw_ecc && !strcmp(args[i], "oob_softecc"))
+                               state->oob_format |= NAND_OOB_SW_ECC;
+                       else if (sw_ecc && !strcmp(args[i], "oob_softecc_kw"))
+                               state->oob_format |= NAND_OOB_SW_ECC_KW;
                        else
-                               command_print(cmd_ctx, "unknown option: '%s'", args[i]);
+                       {
+                               command_print(cmd_ctx, "unknown option: %s", args[i]);
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       }
                }
        }
 
-       if ((address % p->page_size) || (size % p->page_size))
+       retval = nand_fileio_start(cmd_ctx, nand, args[1], filemode, state);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (!need_size)
+               state->size = state->fileio.size;
+
+       *dev = nand;
+
+       return ERROR_OK;
+}
+
+/**
+ * @returns If no error occurred, returns number of bytes consumed;
+ * otherwise, returns a negative error code.)
+ */
+static int nand_fileio_read(struct nand_device *nand,
+               struct nand_fileio_state *s)
+{
+       uint32_t total_read = 0;
+       uint32_t one_read;
+
+       if (NULL != s->page)
        {
-               command_print(cmd_ctx, "only page size aligned addresses and sizes are supported");
-               return ERROR_OK;
+               fileio_read(&s->fileio, s->page_size, s->page, &one_read);
+               if (one_read < s->page_size)
+                       memset(s->page + one_read, 0xff, s->page_size - one_read);
+               total_read += one_read;
        }
 
-       if (!(oob_format & NAND_OOB_ONLY))
+       if (s->oob_format & NAND_OOB_SW_ECC)
+       {
+               uint8_t ecc[3];
+               memset(s->oob, 0xff, s->oob_size);
+               for (uint32_t i = 0, j = 0; i < s->page_size; i += 256)
+               {
+                       nand_calculate_ecc(nand, s->page + i, ecc);
+                       s->oob[s->eccpos[j++]] = ecc[0];
+                       s->oob[s->eccpos[j++]] = ecc[1];
+                       s->oob[s->eccpos[j++]] = ecc[2];
+               }
+       }
+       else if (s->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.
+                */
+               uint8_t *ecc = s->oob + s->oob_size - s->page_size / 512 * 10;
+               memset(s->oob, 0xff, s->oob_size);
+               for (uint32_t i = 0; i < s->page_size; i += 512)
+               {
+                       nand_calculate_ecc_kw(nand, s->page + i, ecc);
+                       ecc += 10;
+               }
+       }
+       else if (NULL != s->oob)
        {
-               page_size = p->page_size;
-               page = malloc(p->page_size);
+               fileio_read(&s->fileio, s->oob_size, s->oob, &one_read);
+               if (one_read < s->oob_size)
+                       memset(s->oob + one_read, 0xff, s->oob_size - one_read);
+               total_read += one_read;
        }
+       return total_read;
+}
 
-       if (oob_format & NAND_OOB_RAW)
+COMMAND_HANDLER(handle_nand_write_command)
+{
+       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;
+
+       uint32_t total_bytes = s.size;
+       while (s.size > 0)
        {
-               if (p->page_size == 512)
-                       oob_size = 16;
-               else if (p->page_size == 2048)
-                       oob_size = 64;
-               oob = malloc(oob_size);
+               int bytes_read = nand_fileio_read(nand, &s);
+               if (bytes_read <= 0)
+               {
+                       command_print(cmd_ctx, "error while reading file");
+                       return nand_fileio_cleanup(&s);
+               }
+               s.size -= bytes_read;
+
+               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;
        }
 
-       if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
+       if (nand_fileio_finish(&s))
        {
-               return 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], s.address, duration_elapsed(&s.bench),
+                               duration_kbps(&s.bench, total_bytes));
        }
+       return ERROR_OK;
+}
 
-       struct duration bench;
-       duration_start(&bench);
+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;
 
-       while (size > 0)
+       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 (file.size > 0)
        {
-               uint32_t size_written;
-               if ((retval = nand_read_page(p, address / p->page_size, page, page_size, oob, oob_size)) != ERROR_OK)
+               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)
                {
                        command_print(cmd_ctx, "reading NAND flash page failed");
-                       free(page);
-                       free(oob);
-                       fileio_close(&fileio);
-                       return ERROR_OK;
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
 
-               if (NULL != page)
+               int bytes_read = nand_fileio_read(nand, &file);
+               if (bytes_read <= 0)
                {
-                       fileio_write(&fileio, page_size, page, &size_written);
-                       bytes_done += page_size;
+                       command_print(cmd_ctx, "error while reading file");
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
 
-               if (NULL != oob)
+               if ((dev.page && memcmp(dev.page, file.page, dev.page_size)) ||
+                   (dev.oob && memcmp(dev.oob, file.oob, dev.oob_size)) )
                {
-                       fileio_write(&fileio, oob_size, oob, &size_written);
-                       bytes_done += oob_size;
+                       command_print(cmd_ctx, "NAND flash contents differ "
+                                               "at 0x%8.8" PRIx32, dev.address);
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
                }
 
-               size -= p->page_size;
-               address += p->page_size;
+               file.size -= bytes_read;
+               file.address += nand->page_size;
        }
 
-       free(page);
-       page = NULL;
-       free(oob);
-       oob = NULL;
-       fileio_close(&fileio);
+       if (nand_fileio_finish(&file) == ERROR_OK)
+       {
+               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));
+       }
 
-       if (duration_measure(&bench) == ERROR_OK)
+       return nand_fileio_cleanup(&dev);
+}
+
+COMMAND_HANDLER(handle_nand_dump_command)
+{
+       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;
+
+       while (s.size > 0)
        {
-               command_print(cmd_ctx, "dumped %lld byte in %fs (%0.3f kb/s)",
-                       fileio.size, duration_elapsed(&bench),
-                       duration_kbps(&bench, fileio.size));
+               uint32_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");
+                       return nand_fileio_cleanup(&s);
+               }
+
+               if (NULL != s.page)
+                       fileio_write(&s.fileio, s.page_size, s.page, &size_written);
+
+               if (NULL != s.oob)
+                       fileio_write(&s.fileio, s.oob_size, s.oob, &size_written);
+
+               s.size -= nand->page_size;
+               s.address += nand->page_size;
        }
 
+       if (nand_fileio_finish(&s) == ERROR_OK)
+       {
+               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;
 }
 
@@ -1576,8 +1651,8 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
-       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1603,7 +1678,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
        return ERROR_OK;
 }
 
-int nand_init(struct command_context_s *cmd_ctx)
+int nand_init(struct command_context *cmd_ctx)
 {
        if (!nand_devices)
                return ERROR_OK;
@@ -1628,6 +1703,10 @@ int nand_init(struct command_context_s *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)