split nand.c into nand/{core,fileio,tcl}.c
authorZachary T Welch <zw@superlucidity.net>
Sat, 5 Dec 2009 03:28:18 +0000 (19:28 -0800)
committerZachary T Welch <zw@superlucidity.net>
Sat, 5 Dec 2009 05:41:23 +0000 (21:41 -0800)
Moves commands into nand/tcl.c and core implementation to 'nand/core.c'
and 'nand/fileio.c'.  Eliminates 'flash/nand.c'.

Adds 'nand/imp.h' to share routines between TCL commands and core.

src/flash/Makefile.am
src/flash/nand/Makefile.am
src/flash/nand/core.c [moved from src/flash/nand.c with 52% similarity]
src/flash/nand/fileio.c [new file with mode: 0644]
src/flash/nand/fileio.h [new file with mode: 0644]
src/flash/nand/imp.h [new file with mode: 0644]
src/flash/nand/tcl.c [new file with mode: 0644]

index ba44adb..2144ff2 100644 (file)
@@ -12,7 +12,6 @@ libflash_la_SOURCES = \
        arm_nandio.c \
        nand_ecc.c \
        nand_ecc_kw.c \
        arm_nandio.c \
        nand_ecc.c \
        nand_ecc_kw.c \
-       nand.c \
        mflash.c
 
 libflash_la_LIBADD = \
        mflash.c
 
 libflash_la_LIBADD = \
index 7d250f6..3885a7b 100644 (file)
@@ -3,6 +3,9 @@ AM_CPPFLAGS = -I$(top_srcdir)/src
 noinst_LTLIBRARIES = libocdflashnand.la
 
 libocdflashnand_la_SOURCES = \
 noinst_LTLIBRARIES = libocdflashnand.la
 
 libocdflashnand_la_SOURCES = \
+       core.c \
+       fileio.c \
+       tcl.c \
        $(NAND_DRIVERS) \
        driver.c
 
        $(NAND_DRIVERS) \
        driver.c
 
similarity index 52%
rename from src/flash/nand.c
rename to src/flash/nand/core.c
index 9a220d2..46f5454 100644 (file)
@@ -1,9 +1,9 @@
 /***************************************************************************
 /***************************************************************************
- *   Copyright (C) 2007 by Dominic Rath                                    *
- *   Dominic.Rath@gmx.de                                                   *
+ *   Copyright (C) 2007 by Dominic Rath <Dominic.Rath@gmx.de>              *
+ *   Copyright (C) 2002 Thomas Gleixner <tglx@linutronix.de>               *
+ *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
  *                                                                         *
  *   Partially based on drivers/mtd/nand_ids.c from Linux.                 *
  *                                                                         *
  *   Partially based on drivers/mtd/nand_ids.c from Linux.                 *
- *   Copyright (C) 2002 Thomas Gleixner <tglx@linutronix.de>               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
 #include "config.h"
 #endif
 
 #include "config.h"
 #endif
 
-#include "nand.h"
-#include "common.h"
-#include <helper/time_support.h>
-#include <helper/fileio.h>
+#include <flash/nand.h>
+#include <flash/common.h>
+#include "imp.h"
 
 
-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);
+/* configured NAND devices and NAND Flash command handler */
+struct nand_device *nand_devices = NULL;
 
 
-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);
+void nand_device_add(struct nand_device *c)
+{
+       if (nand_devices) {
+               struct nand_device *p = nand_devices;
+               while (p && p->next) p = p->next;
+               p->next = c;
+       } else
+               nand_devices = c;
+}
 
 
-/* configured NAND devices and NAND Flash command handler */
-static struct nand_device *nand_devices = NULL;
 
 /*     Chip ID list
  *
 
 /*     Chip ID list
  *
@@ -157,140 +162,6 @@ static struct nand_ecclayout nand_oob_8 = {
 };
 #endif
 
 };
 #endif
 
-static struct nand_ecclayout nand_oob_16 = {
-       .eccbytes = 6,
-       .eccpos = {0, 1, 2, 3, 6, 7},
-       .oobfree = {
-               {.offset = 8,
-                . length = 8}}
-};
-
-static struct nand_ecclayout nand_oob_64 = {
-       .eccbytes = 24,
-       .eccpos = {
-                  40, 41, 42, 43, 44, 45, 46, 47,
-                  48, 49, 50, 51, 52, 53, 54, 55,
-                  56, 57, 58, 59, 60, 61, 62, 63},
-       .oobfree = {
-               {.offset = 2,
-                .length = 38}}
-};
-
-int nand_list_walker(struct nand_flash_controller *c, void *x)
-{
-       struct command_context *cmd_ctx = (struct command_context *)x;
-       command_print(cmd_ctx, "  %s", c->name);
-       return ERROR_OK;
-}
-COMMAND_HANDLER(handle_nand_list_drivers)
-{
-       command_print(CMD_CTX, "Available NAND flash controller drivers:");
-       return nand_driver_walk(&nand_list_walker, CMD_CTX);
-}
-
-static COMMAND_HELPER(create_nand_device, const char *bank_name,
-               struct nand_flash_controller *controller)
-{
-       if (NULL != controller->commands)
-       {
-               int retval = register_commands(CMD_CTX, NULL,
-                               controller->commands);
-               if (ERROR_OK != retval)
-                       return retval;
-       }
-       struct nand_device *c = malloc(sizeof(struct nand_device));
-
-       c->name = strdup(bank_name);
-       c->controller = controller;
-       c->controller_priv = NULL;
-       c->manufacturer = NULL;
-       c->device = NULL;
-       c->bus_width = 0;
-       c->address_cycles = 0;
-       c->page_size = 0;
-       c->use_raw = 0;
-       c->next = NULL;
-
-       int retval = CALL_COMMAND_HANDLER(controller->nand_device_command, c);
-       if (ERROR_OK != retval)
-       {
-               LOG_ERROR("'%s' driver rejected nand flash", controller->name);
-               free(c);
-               return ERROR_OK;
-       }
-
-       if (nand_devices) {
-               struct nand_device *p = nand_devices;
-               while (p && p->next) p = p->next;
-               p->next = c;
-       } else
-               nand_devices = c;
-
-       return ERROR_OK;
-}
-
-COMMAND_HANDLER(handle_nand_device_command)
-{
-       if (CMD_ARGC < 1)
-       {
-               LOG_ERROR("incomplete nand device configuration");
-               return ERROR_FLASH_BANK_INVALID;
-       }
-
-       // save name and increment (for compatibility) with drivers
-       const char *bank_name = *CMD_ARGV++;
-       CMD_ARGC--;
-
-       const char *driver_name = CMD_ARGV[0];
-       struct nand_flash_controller *controller;
-       controller = nand_driver_find_by_name(CMD_ARGV[0]);
-       if (NULL == controller)
-       {
-               LOG_ERROR("No valid NAND flash driver found (%s)", driver_name);
-               return CALL_COMMAND_HANDLER(handle_nand_list_drivers);
-       }
-       return CALL_COMMAND_HANDLER(create_nand_device, bank_name, controller);
-}
-
-
-COMMAND_HANDLER(handle_nand_init_command);
-
-static const struct command_registration nand_config_command_handlers[] = {
-       {
-               .name = "device",
-               .handler = &handle_nand_device_command,
-               .mode = COMMAND_CONFIG,
-               .help = "defines a new NAND bank",
-       },
-       {
-               .name = "drivers",
-               .handler = &handle_nand_list_drivers,
-               .mode = COMMAND_ANY,
-               .help = "lists available NAND drivers",
-       },
-       {
-               .name = "init",
-               .mode = COMMAND_CONFIG,
-               .handler = &handle_nand_init_command,
-               .help = "initialize NAND devices",
-       },
-       COMMAND_REGISTRATION_DONE
-};
-static const struct command_registration nand_command_handlers[] = {
-       {
-               .name = "nand",
-               .mode = COMMAND_ANY,
-               .help = "NAND flash command group",
-               .chain = nand_config_command_handlers,
-       },
-       COMMAND_REGISTRATION_DONE
-};
-
-int nand_register_commands(struct command_context *cmd_ctx)
-{
-       return register_commands(cmd_ctx, NULL, nand_command_handlers);
-}
-
 struct nand_device *get_nand_device_by_name(const char *name)
 {
        unsigned requested = get_flash_name_index(name);
 struct nand_device *get_nand_device_by_name(const char *name)
 {
        unsigned requested = get_flash_name_index(name);
@@ -344,7 +215,7 @@ COMMAND_HELPER(nand_command_get_device, unsigned name_index,
        return ERROR_OK;
 }
 
        return ERROR_OK;
 }
 
-static int nand_build_bbt(struct nand_device *nand, int first, int last)
+int nand_build_bbt(struct nand_device *nand, int first, int last)
 {
        uint32_t page = 0x0;
        int i;
 {
        uint32_t page = 0x0;
        int i;
@@ -642,7 +513,7 @@ int nand_probe(struct nand_device *nand)
        return ERROR_OK;
 }
 
        return ERROR_OK;
 }
 
-static int nand_erase(struct nand_device *nand, int first_block, int last_block)
+int nand_erase(struct nand_device *nand, int first_block, int last_block)
 {
        int i;
        uint32_t page;
 {
        int i;
        uint32_t page;
@@ -823,7 +694,9 @@ int nand_write_page(struct nand_device *nand, uint32_t page, uint8_t *data, uint
                return nand->controller->write_page(nand, page, data, data_size, oob, oob_size);
 }
 
                return nand->controller->write_page(nand, page, data, data_size, oob, 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)
+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;
 {
        if (!nand->device)
                return ERROR_NAND_DEVICE_NOT_PROBED;
@@ -1042,725 +915,3 @@ int nand_write_page_raw(struct nand_device *nand, uint32_t page, uint8_t *data,
        return ERROR_OK;
 }
 
        return ERROR_OK;
 }
 
-COMMAND_HANDLER(handle_nand_list_command)
-{
-       struct nand_device *p;
-       int i;
-
-       if (!nand_devices)
-       {
-               command_print(CMD_CTX, "no NAND flash devices configured");
-               return ERROR_OK;
-       }
-
-       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,\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);
-       }
-
-       return ERROR_OK;
-}
-
-COMMAND_HANDLER(handle_nand_info_command)
-{
-       int i = 0;
-       int j = 0;
-       int first = -1;
-       int last = -1;
-
-       switch (CMD_ARGC) {
-       default:
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       case 1:
-               first = 0;
-               last = INT32_MAX;
-               break;
-       case 2:
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], i);
-               first = last = i;
-               i = 0;
-               break;
-       case 3:
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], first);
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], last);
-               break;
-       }
-
-       struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if (NULL == p->device)
-       {
-               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
-               return ERROR_OK;
-       }
-
-       if (first >= p->num_blocks)
-               first = p->num_blocks - 1;
-
-       if (last >= p->num_blocks)
-               last = 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);
-
-       for (j = first; j <= last; j++)
-       {
-               char *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
-                       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;
-}
-
-COMMAND_HANDLER(handle_nand_probe_command)
-{
-       if (CMD_ARGC != 1)
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       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");
-       }
-
-       return ERROR_OK;
-}
-
-COMMAND_HANDLER(handle_nand_erase_command)
-{
-       if (CMD_ARGC != 1 && CMD_ARGC != 3)
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       }
-
-       struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       unsigned long offset;
-       unsigned long length;
-
-       /* erase specified part of the chip; or else everything */
-       if (CMD_ARGC == 3) {
-               unsigned long size = p->erase_size * p->num_blocks;
-
-               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], offset);
-               if ((offset % p->erase_size) != 0 || offset >= size)
-                       return ERROR_INVALID_ARGUMENTS;
-
-               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length);
-               if ((length == 0) || (length % p->erase_size) != 0
-                               || (length + offset) > size)
-                       return ERROR_INVALID_ARGUMENTS;
-
-               offset /= p->erase_size;
-               length /= p->erase_size;
-       } else {
-               offset = 0;
-               length = p->num_blocks;
-       }
-
-       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,
-                               CMD_ARGV[0], 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");
-       }
-
-       return ERROR_OK;
-}
-
-COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
-{
-       int first = -1;
-       int last = -1;
-
-       if ((CMD_ARGC < 1) || (CMD_ARGC > 3) || (CMD_ARGC == 2))
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       }
-
-       struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if (CMD_ARGC == 3)
-       {
-               unsigned long offset;
-               unsigned long length;
-
-               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], offset);
-               if (offset % p->erase_size)
-                       return ERROR_INVALID_ARGUMENTS;
-               offset /= p->erase_size;
-
-               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length);
-               if (length % p->erase_size)
-                       return ERROR_INVALID_ARGUMENTS;
-
-               length -= 1;
-               length /= p->erase_size;
-
-               first = offset;
-               last = offset + length;
-       }
-
-       retval = nand_build_bbt(p, first, last);
-       if (retval == ERROR_OK)
-       {
-               command_print(CMD_CTX, "checked NAND flash device for bad blocks, "
-                               "use \"nand info\" command to list blocks");
-       }
-       else if (retval == ERROR_NAND_OPERATION_FAILED)
-       {
-               command_print(CMD_CTX, "error when checking for bad blocks on "
-                               "NAND flash device");
-       }
-       else
-       {
-               command_print(CMD_CTX, "unknown error when checking for bad "
-                               "blocks on NAND flash device");
-       }
-
-       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;
-}
-static int nand_fileio_finish(struct nand_fileio_state *state)
-{
-       nand_fileio_cleanup(state);
-       return duration_measure(&state->bench);
-}
-
-static COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
-               struct nand_device **dev, enum fileio_access filemode,
-               bool need_size, bool sw_ecc)
-{
-       nand_fileio_init(state);
-
-       unsigned minargs = need_size ? 4 : 3;
-       if (CMD_ARGC < minargs)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       struct nand_device *nand;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &nand);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if (NULL == nand->device)
-       {
-               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
-               return ERROR_OK;
-       }
-
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], state->address);
-       if (need_size)
-       {
-                       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], state->size);
-                       if (state->size % nand->page_size)
-                       {
-                               command_print(CMD_CTX, "only page-aligned sizes are supported");
-                               return ERROR_COMMAND_SYNTAX_ERROR;
-                       }
-       }
-
-       if (CMD_ARGC > minargs)
-       {
-               for (unsigned i = minargs; i < CMD_ARGC; i++)
-               {
-                       if (!strcmp(CMD_ARGV[i], "oob_raw"))
-                               state->oob_format |= NAND_OOB_RAW;
-                       else if (!strcmp(CMD_ARGV[i], "oob_only"))
-                               state->oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
-                       else if (sw_ecc && !strcmp(CMD_ARGV[i], "oob_softecc"))
-                               state->oob_format |= NAND_OOB_SW_ECC;
-                       else if (sw_ecc && !strcmp(CMD_ARGV[i], "oob_softecc_kw"))
-                               state->oob_format |= NAND_OOB_SW_ECC_KW;
-                       else
-                       {
-                               command_print(CMD_CTX, "unknown option: %s", CMD_ARGV[i]);
-                               return ERROR_COMMAND_SYNTAX_ERROR;
-                       }
-               }
-       }
-
-       retval = nand_fileio_start(CMD_CTX, nand, CMD_ARGV[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)
-{
-       size_t total_read = 0;
-       size_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)
-{
-       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)
-       {
-               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,
-                               CMD_ARGV[1], CMD_ARGV[0], s.address);
-                       return nand_fileio_cleanup(&s);
-               }
-               s.address += s.page_size;
-       }
-
-       if (nand_fileio_finish(&s))
-       {
-               command_print(CMD_CTX, "wrote file %s to NAND flash %s up to "
-                               "offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
-                               CMD_ARGV[1], CMD_ARGV[0], s.address, duration_elapsed(&s.bench),
-                               duration_kbps(&s.bench, total_bytes));
-       }
-       return ERROR_OK;
-}
-
-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;
-
-       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)
-       {
-               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");
-                       nand_fileio_cleanup(&dev);
-                       return nand_fileio_cleanup(&file);
-               }
-
-               int bytes_read = nand_fileio_read(nand, &file);
-               if (bytes_read <= 0)
-               {
-                       command_print(CMD_CTX, "error while reading file");
-                       nand_fileio_cleanup(&dev);
-                       return nand_fileio_cleanup(&file);
-               }
-
-               if ((dev.page && memcmp(dev.page, file.page, dev.page_size)) ||
-                   (dev.oob && memcmp(dev.oob, file.oob, dev.oob_size)) )
-               {
-                       command_print(CMD_CTX, "NAND flash contents differ "
-                                               "at 0x%8.8" PRIx32, dev.address);
-                       nand_fileio_cleanup(&dev);
-                       return nand_fileio_cleanup(&file);
-               }
-
-               file.size -= bytes_read;
-               dev.address += nand->page_size;
-       }
-
-       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)",
-                               CMD_ARGV[1], CMD_ARGV[0], dev.address, duration_elapsed(&file.bench),
-                               duration_kbps(&file.bench, dev.size));
-       }
-
-       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)
-       {
-               size_t size_written;
-               int retval = nand_read_page(nand, s.address / nand->page_size,
-                               s.page, s.page_size, s.oob, s.oob_size);
-               if (ERROR_OK != retval)
-               {
-                       command_print(CMD_CTX, "reading NAND flash page failed");
-                       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;
-}
-
-COMMAND_HANDLER(handle_nand_raw_access_command)
-{
-       if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if (NULL == p->device)
-       {
-               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
-               return ERROR_OK;
-       }
-
-       if (CMD_ARGC == 2)
-               COMMAND_PARSE_ENABLE(CMD_ARGV[1], p->use_raw);
-
-       const char *msg = p->use_raw ? "enabled" : "disabled";
-       command_print(CMD_CTX, "raw access is %s", msg);
-
-       return ERROR_OK;
-}
-
-static const struct command_registration nand_exec_command_handlers[] = {
-       {
-               .name = "list",
-               .handler = &handle_nand_list_command,
-               .mode = COMMAND_EXEC,
-               .help = "list configured NAND flash devices",
-       },
-       {
-               .name = "info",
-               .handler = &handle_nand_info_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "print info about a NAND flash device",
-       },
-       {
-               .name = "probe",
-               .handler = &handle_nand_probe_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "identify NAND flash device <num>",
-
-       },
-       {
-               .name = "check_bad_blocks",
-               .handler = &handle_nand_check_bad_blocks_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank> [<offset> <length>]",
-               .help = "check NAND flash device <num> for bad blocks",
-       },
-       {
-               .name = "erase",
-               .handler = &handle_nand_erase_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank> [<offset> <length>]",
-               .help = "erase blocks on NAND flash device",
-       },
-       {
-               .name = "dump",
-               .handler = &handle_nand_dump_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank> <filename> <offset> <length> "
-                       "[oob_raw | oob_only]",
-               .help = "dump from NAND flash device",
-       },
-       {
-               .name = "verify",
-               .handler = &handle_nand_verify_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank> <filename> <offset> "
-                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
-               .help = "verify NAND flash device",
-       },
-       {
-               .name = "write",
-               .handler = &handle_nand_write_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<bank> <filename> <offset> "
-                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
-               .help = "write to NAND flash device",
-       },
-       {
-               .name = "raw_access",
-               .handler = &handle_nand_raw_access_command,
-               .mode = COMMAND_EXEC,
-               .usage = "<num> ['enable'|'disable']",
-               .help = "raw access to NAND flash device",
-       },
-       COMMAND_REGISTRATION_DONE
-};
-
-int nand_init(struct command_context *cmd_ctx)
-{
-       if (!nand_devices)
-               return ERROR_OK;
-       struct command *parent = command_find_in_context(cmd_ctx, "nand");
-       return register_commands(cmd_ctx, parent, nand_exec_command_handlers);
-}
-
-COMMAND_HANDLER(handle_nand_init_command)
-{
-       if (CMD_ARGC != 0)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       static bool nand_initialized = false;
-       if (nand_initialized)
-       {
-               LOG_INFO("'nand init' has already been called");
-               return ERROR_OK;
-       }
-       nand_initialized = true;
-
-       LOG_DEBUG("Initializing NAND devices...");
-       return nand_init(CMD_CTX);
-}
diff --git a/src/flash/nand/fileio.c b/src/flash/nand/fileio.c
new file mode 100644 (file)
index 0000000..fbaa8b4
--- /dev/null
@@ -0,0 +1,244 @@
+/***************************************************************************
+ *   Copyright (C) 2007 by Dominic Rath <Dominic.Rath@gmx.de>              *
+ *   Copyright (C) 2002 Thomas Gleixner <tglx@linutronix.de>               *
+ *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
+ *                                                                         *
+ *   Partially based on drivers/mtd/nand_ids.c from Linux.                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <flash/nand.h>
+#include "fileio.h"
+
+static struct nand_ecclayout nand_oob_16 = {
+       .eccbytes = 6,
+       .eccpos = {0, 1, 2, 3, 6, 7},
+       .oobfree = {
+               {.offset = 8,
+                . length = 8}}
+};
+
+static struct nand_ecclayout nand_oob_64 = {
+       .eccbytes = 24,
+       .eccpos = {
+                  40, 41, 42, 43, 44, 45, 46, 47,
+                  48, 49, 50, 51, 52, 53, 54, 55,
+                  56, 57, 58, 59, 60, 61, 62, 63},
+       .oobfree = {
+               {.offset = 2,
+                .length = 38}}
+};
+
+void nand_fileio_init(struct nand_fileio_state *state)
+{
+       memset(state, 0, sizeof(*state));
+       state->oob_format = NAND_OOB_NONE;
+}
+
+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;
+}
+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 (CMD_ARGC < minargs)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct nand_device *nand;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &nand);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (NULL == nand->device)
+       {
+               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
+               return ERROR_OK;
+       }
+
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], state->address);
+       if (need_size)
+       {
+                       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], state->size);
+                       if (state->size % nand->page_size)
+                       {
+                               command_print(CMD_CTX, "only page-aligned sizes are supported");
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       }
+       }
+
+       if (CMD_ARGC > minargs)
+       {
+               for (unsigned i = minargs; i < CMD_ARGC; i++)
+               {
+                       if (!strcmp(CMD_ARGV[i], "oob_raw"))
+                               state->oob_format |= NAND_OOB_RAW;
+                       else if (!strcmp(CMD_ARGV[i], "oob_only"))
+                               state->oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY;
+                       else if (sw_ecc && !strcmp(CMD_ARGV[i], "oob_softecc"))
+                               state->oob_format |= NAND_OOB_SW_ECC;
+                       else if (sw_ecc && !strcmp(CMD_ARGV[i], "oob_softecc_kw"))
+                               state->oob_format |= NAND_OOB_SW_ECC_KW;
+                       else
+                       {
+                               command_print(CMD_CTX, "unknown option: %s", CMD_ARGV[i]);
+                               return ERROR_COMMAND_SYNTAX_ERROR;
+                       }
+               }
+       }
+
+       retval = nand_fileio_start(CMD_CTX, nand, CMD_ARGV[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)
+{
+       size_t total_read = 0;
+       size_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;
+}
+
diff --git a/src/flash/nand/fileio.h b/src/flash/nand/fileio.h
new file mode 100644 (file)
index 0000000..7855431
--- /dev/null
@@ -0,0 +1,57 @@
+/***************************************************************************
+ *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifndef FLASH_NAND_FILEIO_H
+#define FLASH_NAND_FILEIO_H
+
+#include <helper/time_support.h>
+#include <helper/fileio.h>
+
+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;
+};
+
+void nand_fileio_init(struct nand_fileio_state *state);
+int nand_fileio_start(struct command_context *cmd_ctx,
+               struct nand_device *nand, const char *filename, int filemode,
+               struct nand_fileio_state *state);
+int nand_fileio_cleanup(struct nand_fileio_state *state);
+int nand_fileio_finish(struct nand_fileio_state *state);
+
+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);
+
+int nand_fileio_read(struct nand_device *nand, struct nand_fileio_state *s);
+
+#endif // FLASH_NAND_FILEIO_H
diff --git a/src/flash/nand/imp.h b/src/flash/nand/imp.h
new file mode 100644 (file)
index 0000000..b381b53
--- /dev/null
@@ -0,0 +1,34 @@
+/***************************************************************************
+ *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifndef FLASH_NAND_IMP_H
+#define FLASH_NAND_IMP_H
+
+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);
+
+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);
+
+int nand_probe(struct nand_device *nand);
+int nand_erase(struct nand_device *nand, int first_block, int last_block);
+int nand_build_bbt(struct nand_device *nand, int first, int last);
+
+#endif // FLASH_NAND_IMP_H
diff --git a/src/flash/nand/tcl.c b/src/flash/nand/tcl.c
new file mode 100644 (file)
index 0000000..75a416f
--- /dev/null
@@ -0,0 +1,645 @@
+/***************************************************************************
+ *   Copyright (C) 2007 by Dominic Rath <Dominic.Rath@gmx.de>              *
+ *   Copyright (C) 2002 Thomas Gleixner <tglx@linutronix.de>               *
+ *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
+ *                                                                         *
+ *   Partially based on drivers/mtd/nand_ids.c from Linux.                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <flash/nand.h>
+#include "imp.h"
+#include "fileio.h"
+
+// to be removed
+extern struct nand_device *nand_devices;
+
+COMMAND_HANDLER(handle_nand_list_command)
+{
+       struct nand_device *p;
+       int i;
+
+       if (!nand_devices)
+       {
+               command_print(CMD_CTX, "no NAND flash devices configured");
+               return ERROR_OK;
+       }
+
+       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,\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);
+       }
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_nand_info_command)
+{
+       int i = 0;
+       int j = 0;
+       int first = -1;
+       int last = -1;
+
+       switch (CMD_ARGC) {
+       default:
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       case 1:
+               first = 0;
+               last = INT32_MAX;
+               break;
+       case 2:
+               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], i);
+               first = last = i;
+               i = 0;
+               break;
+       case 3:
+               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], first);
+               COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], last);
+               break;
+       }
+
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (NULL == p->device)
+       {
+               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
+               return ERROR_OK;
+       }
+
+       if (first >= p->num_blocks)
+               first = p->num_blocks - 1;
+
+       if (last >= p->num_blocks)
+               last = 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);
+
+       for (j = first; j <= last; j++)
+       {
+               char *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
+                       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;
+}
+
+COMMAND_HANDLER(handle_nand_probe_command)
+{
+       if (CMD_ARGC != 1)
+       {
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       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");
+       }
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_nand_erase_command)
+{
+       if (CMD_ARGC != 1 && CMD_ARGC != 3)
+       {
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       }
+
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       unsigned long offset;
+       unsigned long length;
+
+       /* erase specified part of the chip; or else everything */
+       if (CMD_ARGC == 3) {
+               unsigned long size = p->erase_size * p->num_blocks;
+
+               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], offset);
+               if ((offset % p->erase_size) != 0 || offset >= size)
+                       return ERROR_INVALID_ARGUMENTS;
+
+               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length);
+               if ((length == 0) || (length % p->erase_size) != 0
+                               || (length + offset) > size)
+                       return ERROR_INVALID_ARGUMENTS;
+
+               offset /= p->erase_size;
+               length /= p->erase_size;
+       } else {
+               offset = 0;
+               length = p->num_blocks;
+       }
+
+       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,
+                               CMD_ARGV[0], 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");
+       }
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
+{
+       int first = -1;
+       int last = -1;
+
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 3) || (CMD_ARGC == 2))
+       {
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       }
+
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (CMD_ARGC == 3)
+       {
+               unsigned long offset;
+               unsigned long length;
+
+               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], offset);
+               if (offset % p->erase_size)
+                       return ERROR_INVALID_ARGUMENTS;
+               offset /= p->erase_size;
+
+               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length);
+               if (length % p->erase_size)
+                       return ERROR_INVALID_ARGUMENTS;
+
+               length -= 1;
+               length /= p->erase_size;
+
+               first = offset;
+               last = offset + length;
+       }
+
+       retval = nand_build_bbt(p, first, last);
+       if (retval == ERROR_OK)
+       {
+               command_print(CMD_CTX, "checked NAND flash device for bad blocks, "
+                               "use \"nand info\" command to list blocks");
+       }
+       else if (retval == ERROR_NAND_OPERATION_FAILED)
+       {
+               command_print(CMD_CTX, "error when checking for bad blocks on "
+                               "NAND flash device");
+       }
+       else
+       {
+               command_print(CMD_CTX, "unknown error when checking for bad "
+                               "blocks on NAND flash device");
+       }
+
+       return ERROR_OK;
+}
+
+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)
+       {
+               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,
+                               CMD_ARGV[1], CMD_ARGV[0], s.address);
+                       return nand_fileio_cleanup(&s);
+               }
+               s.address += s.page_size;
+       }
+
+       if (nand_fileio_finish(&s))
+       {
+               command_print(CMD_CTX, "wrote file %s to NAND flash %s up to "
+                               "offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
+                               CMD_ARGV[1], CMD_ARGV[0], s.address, duration_elapsed(&s.bench),
+                               duration_kbps(&s.bench, total_bytes));
+       }
+       return ERROR_OK;
+}
+
+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;
+
+       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)
+       {
+               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");
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
+               }
+
+               int bytes_read = nand_fileio_read(nand, &file);
+               if (bytes_read <= 0)
+               {
+                       command_print(CMD_CTX, "error while reading file");
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
+               }
+
+               if ((dev.page && memcmp(dev.page, file.page, dev.page_size)) ||
+                   (dev.oob && memcmp(dev.oob, file.oob, dev.oob_size)) )
+               {
+                       command_print(CMD_CTX, "NAND flash contents differ "
+                                               "at 0x%8.8" PRIx32, dev.address);
+                       nand_fileio_cleanup(&dev);
+                       return nand_fileio_cleanup(&file);
+               }
+
+               file.size -= bytes_read;
+               dev.address += nand->page_size;
+       }
+
+       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)",
+                               CMD_ARGV[1], CMD_ARGV[0], dev.address, duration_elapsed(&file.bench),
+                               duration_kbps(&file.bench, dev.size));
+       }
+
+       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)
+       {
+               size_t size_written;
+               int retval = nand_read_page(nand, s.address / nand->page_size,
+                               s.page, s.page_size, s.oob, s.oob_size);
+               if (ERROR_OK != retval)
+               {
+                       command_print(CMD_CTX, "reading NAND flash page failed");
+                       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;
+}
+
+COMMAND_HANDLER(handle_nand_raw_access_command)
+{
+       if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
+       {
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+
+       struct nand_device *p;
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (NULL == p->device)
+       {
+               command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]);
+               return ERROR_OK;
+       }
+
+       if (CMD_ARGC == 2)
+               COMMAND_PARSE_ENABLE(CMD_ARGV[1], p->use_raw);
+
+       const char *msg = p->use_raw ? "enabled" : "disabled";
+       command_print(CMD_CTX, "raw access is %s", msg);
+
+       return ERROR_OK;
+}
+
+static const struct command_registration nand_exec_command_handlers[] = {
+       {
+               .name = "list",
+               .handler = &handle_nand_list_command,
+               .mode = COMMAND_EXEC,
+               .help = "list configured NAND flash devices",
+       },
+       {
+               .name = "info",
+               .handler = &handle_nand_info_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank>",
+               .help = "print info about a NAND flash device",
+       },
+       {
+               .name = "probe",
+               .handler = &handle_nand_probe_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank>",
+               .help = "identify NAND flash device <num>",
+
+       },
+       {
+               .name = "check_bad_blocks",
+               .handler = &handle_nand_check_bad_blocks_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> [<offset> <length>]",
+               .help = "check NAND flash device <num> for bad blocks",
+       },
+       {
+               .name = "erase",
+               .handler = &handle_nand_erase_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> [<offset> <length>]",
+               .help = "erase blocks on NAND flash device",
+       },
+       {
+               .name = "dump",
+               .handler = &handle_nand_dump_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> <length> "
+                       "[oob_raw | oob_only]",
+               .help = "dump from NAND flash device",
+       },
+       {
+               .name = "verify",
+               .handler = &handle_nand_verify_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
+               .help = "verify NAND flash device",
+       },
+       {
+               .name = "write",
+               .handler = &handle_nand_write_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
+               .help = "write to NAND flash device",
+       },
+       {
+               .name = "raw_access",
+               .handler = &handle_nand_raw_access_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<num> ['enable'|'disable']",
+               .help = "raw access to NAND flash device",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int nand_init(struct command_context *cmd_ctx)
+{
+       if (!nand_devices)
+               return ERROR_OK;
+       struct command *parent = command_find_in_context(cmd_ctx, "nand");
+       return register_commands(cmd_ctx, parent, nand_exec_command_handlers);
+}
+
+COMMAND_HANDLER(handle_nand_init_command)
+{
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       static bool nand_initialized = false;
+       if (nand_initialized)
+       {
+               LOG_INFO("'nand init' has already been called");
+               return ERROR_OK;
+       }
+       nand_initialized = true;
+
+       LOG_DEBUG("Initializing NAND devices...");
+       return nand_init(CMD_CTX);
+}
+int nand_list_walker(struct nand_flash_controller *c, void *x)
+{
+       struct command_context *cmd_ctx = (struct command_context *)x;
+       command_print(cmd_ctx, "  %s", c->name);
+       return ERROR_OK;
+}
+COMMAND_HANDLER(handle_nand_list_drivers)
+{
+       command_print(CMD_CTX, "Available NAND flash controller drivers:");
+       return nand_driver_walk(&nand_list_walker, CMD_CTX);
+}
+
+static COMMAND_HELPER(create_nand_device, const char *bank_name,
+               struct nand_flash_controller *controller)
+{
+       if (NULL != controller->commands)
+       {
+               int retval = register_commands(CMD_CTX, NULL,
+                               controller->commands);
+               if (ERROR_OK != retval)
+                       return retval;
+       }
+       struct nand_device *c = malloc(sizeof(struct nand_device));
+
+       c->name = strdup(bank_name);
+       c->controller = controller;
+       c->controller_priv = NULL;
+       c->manufacturer = NULL;
+       c->device = NULL;
+       c->bus_width = 0;
+       c->address_cycles = 0;
+       c->page_size = 0;
+       c->use_raw = 0;
+       c->next = NULL;
+
+       int retval = CALL_COMMAND_HANDLER(controller->nand_device_command, c);
+       if (ERROR_OK != retval)
+       {
+               LOG_ERROR("'%s' driver rejected nand flash", controller->name);
+               free(c);
+               return ERROR_OK;
+       }
+
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_nand_device_command)
+{
+       if (CMD_ARGC < 1)
+       {
+               LOG_ERROR("incomplete nand device configuration");
+               return ERROR_FLASH_BANK_INVALID;
+       }
+
+       // save name and increment (for compatibility) with drivers
+       const char *bank_name = *CMD_ARGV++;
+       CMD_ARGC--;
+
+       const char *driver_name = CMD_ARGV[0];
+       struct nand_flash_controller *controller;
+       controller = nand_driver_find_by_name(CMD_ARGV[0]);
+       if (NULL == controller)
+       {
+               LOG_ERROR("No valid NAND flash driver found (%s)", driver_name);
+               return CALL_COMMAND_HANDLER(handle_nand_list_drivers);
+       }
+       return CALL_COMMAND_HANDLER(create_nand_device, bank_name, controller);
+}
+
+static const struct command_registration nand_config_command_handlers[] = {
+       {
+               .name = "device",
+               .handler = &handle_nand_device_command,
+               .mode = COMMAND_CONFIG,
+               .help = "defines a new NAND bank",
+       },
+       {
+               .name = "drivers",
+               .handler = &handle_nand_list_drivers,
+               .mode = COMMAND_ANY,
+               .help = "lists available NAND drivers",
+       },
+       {
+               .name = "init",
+               .mode = COMMAND_CONFIG,
+               .handler = &handle_nand_init_command,
+               .help = "initialize NAND devices",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration nand_command_handlers[] = {
+       {
+               .name = "nand",
+               .mode = COMMAND_ANY,
+               .help = "NAND flash command group",
+               .chain = nand_config_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int nand_register_commands(struct command_context *cmd_ctx)
+{
+       return register_commands(cmd_ctx, NULL, nand_command_handlers);
+}
+
+