Add nand_fileio_* helper APIs.
[openocd.git] / src / flash / nand.c
index 794836127d166944459a2a1f176d7adc5783341f..9cc08022783801e04f8b91e59fc34c1b5befedc7 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
  */
@@ -61,8 +61,8 @@ static struct nand_flash_controller *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
  *
@@ -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;
@@ -279,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");
 
@@ -288,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)
@@ -304,8 +304,8 @@ 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)
+int nand_command_get_device_by_num(struct command_context *cmd_ctx,
+               const char *str, struct nand_device **nand)
 {
        unsigned num;
        COMMAND_PARSE_NUMBER(uint, str, num);
@@ -317,7 +317,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;
@@ -351,7 +351,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;
@@ -376,7 +376,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;
 
@@ -397,7 +397,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];
@@ -602,7 +602,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++)
        {
@@ -615,7 +615,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;
@@ -704,7 +704,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;
 
@@ -741,7 +741,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;
 
@@ -779,7 +779,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;
 
@@ -796,7 +796,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;
@@ -807,7 +807,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;
 
@@ -921,7 +921,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;
@@ -1044,7 +1044,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)
@@ -1076,7 +1076,7 @@ COMMAND_HANDLER(handle_nand_info_command)
        int first = -1;
        int last = -1;
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1151,7 +1151,7 @@ COMMAND_HANDLER(handle_nand_probe_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1180,7 +1180,7 @@ COMMAND_HANDLER(handle_nand_erase_command)
 
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1239,7 +1239,7 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
 
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1285,6 +1285,222 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
        return ERROR_OK;
 }
 
+struct nand_fileio_state {
+       uint32_t address;
+       uint32_t size;
+
+       uint8_t *page;
+       uint32_t page_size;
+
+       enum oob_formats oob_format;
+       uint8_t *oob;
+       uint32_t oob_size;
+
+       const int *eccpos;
+
+       bool file_opened;
+       struct fileio fileio;
+
+       struct duration bench;
+};
+
+static void nand_fileio_init(struct nand_fileio_state *state)
+{
+       memset(state, 0, sizeof(*state));
+       state->oob_format = NAND_OOB_NONE;
+}
+
+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)
+       {
+               command_print(cmd_ctx, "only page-aligned addresses are supported");
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       duration_start(&state->bench);
+
+       if (NULL != filename)
+       {
+               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;
+               }
+               state->file_opened = true;
+       }
+
+       if (!(state->oob_format & NAND_OOB_ONLY))
+       {
+               state->page_size = nand->page_size;
+               state->page = malloc(nand->page_size);
+       }
+
+       if (state->oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC | NAND_OOB_SW_ECC_KW))
+       {
+               if (nand->page_size == 512)
+               {
+                       state->oob_size = 16;
+                       state->eccpos = nand_oob_16.eccpos;
+               }
+               else if (nand->page_size == 2048)
+               {
+                       state->oob_size = 64;
+                       state->eccpos = nand_oob_64.eccpos;
+               }
+               state->oob = malloc(state->oob_size);
+       }
+
+       return ERROR_OK;
+}
+static int nand_fileio_cleanup(struct nand_fileio_state *state)
+{
+       if (state->file_opened)
+               fileio_close(&state->fileio);
+
+       if (state->oob)
+       {
+               free(state->oob);
+               state->oob = NULL;
+       }
+       if (state->page)
+       {
+               free(state->page);
+               state->page = NULL;
+       }
+       return ERROR_OK;
+}
+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,
+               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)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct nand_device *nand;
+       int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &nand);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (NULL == nand->device)
+       {
+               command_print(cmd_ctx, "#%s: not probed", args[0]);
+               return ERROR_OK;
+       }
+
+       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 > minargs)
+       {
+               for (unsigned i = minargs; i < argc; i++)
+               {
+                       if (!strcmp(args[i], "oob_raw"))
+                               state->oob_format |= NAND_OOB_RAW;
+                       else if (!strcmp(args[i], "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]);
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       }
+               }
+       }
+
+       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.)
+ */
+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)
+       {
+               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 (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)
+       {
+               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;
+}
+
 COMMAND_HANDLER(handle_nand_write_command)
 {
        uint32_t offset;
@@ -1300,7 +1516,7 @@ COMMAND_HANDLER(handle_nand_write_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1458,7 +1674,7 @@ COMMAND_HANDLER(handle_nand_dump_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1575,7 +1791,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       nand_device_t *p;
+       struct nand_device *p;
        int retval = nand_command_get_device_by_num(cmd_ctx, args[0], &p);
        if (ERROR_OK != retval)
                return retval;
@@ -1602,7 +1818,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;

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)