X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fnand.c;h=9d997fadd8a25127cadc9f3b835e7db5e21a26b3;hp=b2508ac03d34754b02d1526bd356a8c8e4745009;hb=69df712d1d06b2c698bed3de086b9f734de73b7e;hpb=ffb73fe1d6f1c8e2c8ceaeea54908869e830c375 diff --git a/src/flash/nand.c b/src/flash/nand.c index b2508ac03d..9d997fadd8 100644 --- a/src/flash/nand.c +++ b/src/flash/nand.c @@ -24,66 +24,45 @@ #include "config.h" #endif -#include "replacements.h" -#include "log.h" - -#include -#include -#include - -#include - #include "nand.h" -#include "flash.h" #include "time_support.h" #include "fileio.h" -#include "image.h" -int nand_register_commands(struct command_context_s *cmd_ctx); -int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_copy_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +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); -int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); - -int nand_read_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size); -int nand_read_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size); -int nand_read_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size); - -int nand_write_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 oob_size); -int nand_write_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 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 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 boundary_scan_nand_controller; */ - -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, &orion_nand_controller, &s3c2410_nand_controller, &s3c2412_nand_controller, &s3c2440_nand_controller, &s3c2443_nand_controller, + &imx31_nand_flash_controller, /* &boundary_scan_nand_controller, */ NULL }; /* configured NAND devices and NAND Flash command handler */ -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 * @@ -95,8 +74,9 @@ static command_t *nand_cmd; * 256 256 Byte page size * 512 512 Byte page size */ -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}, {"NAND 2MiB 5V 8-bit", 0x64, 256, 2, 0x1000, 0}, {"NAND 4MiB 5V 8-bit", 0x6b, 512, 4, 0x2000, 0}, @@ -112,6 +92,7 @@ nand_info_t nand_flash_ids[] = {"NAND 8MiB 3,3V 8-bit", 0xe6, 512, 8, 0x2000, 0}, {"NAND 8MiB 1,8V 16-bit", 0x49, 512, 8, 0x2000, NAND_BUSWIDTH_16}, {"NAND 8MiB 3,3V 16-bit", 0x59, 512, 8, 0x2000, NAND_BUSWIDTH_16}, + /* end "museum" IDs */ {"NAND 16MiB 1,8V 8-bit", 0x33, 512, 16, 0x4000, 0}, {"NAND 16MiB 3,3V 8-bit", 0x73, 512, 16, 0x4000, 0}, @@ -168,12 +149,12 @@ nand_info_t nand_flash_ids[] = {"NAND 2GiB 1,8V 16-bit", 0xB5, 0, 2048, 0, LP_OPTIONS16}, {"NAND 2GiB 3,3V 16-bit", 0xC5, 0, 2048, 0, LP_OPTIONS16}, - {NULL, 0,} + {NULL, 0, 0, 0, 0, 0 } }; /* Manufacturer ID list */ -nand_manufacturer_t nand_manuf_ids[] = +static struct nand_manufacturer nand_manuf_ids[] = { {0x0, "unknown"}, {NAND_MFR_TOSHIBA, "Toshiba"}, @@ -183,6 +164,7 @@ nand_manufacturer_t nand_manuf_ids[] = {NAND_MFR_RENESAS, "Renesas"}, {NAND_MFR_STMICRO, "ST Micro"}, {NAND_MFR_HYNIX, "Hynix"}, + {NAND_MFR_MICRON, "Micron"}, {0x0, NULL}, }; @@ -190,7 +172,8 @@ nand_manufacturer_t nand_manuf_ids[] = * Define default oob placement schemes for large and small page devices */ -nand_ecclayout_t nand_oob_8 = { +#if 0 +static struct nand_ecclayout nand_oob_8 = { .eccbytes = 3, .eccpos = {0, 1, 2}, .oobfree = { @@ -199,8 +182,9 @@ nand_ecclayout_t nand_oob_8 = { {.offset = 6, .length = 2}} }; +#endif -nand_ecclayout_t nand_oob_16 = { +static struct nand_ecclayout nand_oob_16 = { .eccbytes = 6, .eccpos = {0, 1, 2, 3, 6, 7}, .oobfree = { @@ -208,7 +192,7 @@ nand_ecclayout_t nand_oob_16 = { . length = 8}} }; -nand_ecclayout_t nand_oob_64 = { +static struct nand_ecclayout nand_oob_64 = { .eccbytes = 24, .eccpos = { 40, 41, 42, 43, 44, 45, 46, 47, @@ -221,21 +205,21 @@ nand_ecclayout_t nand_oob_64 = { /* nand device [controller options] */ -int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_device_command) { int i; int retval; - + if (argc < 1) { LOG_WARNING("incomplete flash device nand configuration"); return ERROR_FLASH_BANK_INVALID; } - + 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) { /* register flash specific commands */ @@ -244,8 +228,8 @@ int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_ERROR("couldn't register '%s' commands", args[0]); return retval; } - - c = malloc(sizeof(nand_device_t)); + + c = malloc(sizeof(struct nand_device)); c->controller = nand_flash_controllers[i]; c->controller_priv = NULL; @@ -257,13 +241,14 @@ int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, cha 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); return ERROR_OK; } - + /* put NAND device in linked list */ if (nand_devices) { @@ -276,7 +261,7 @@ int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, cha { nand_devices = c; } - + return ERROR_OK; } } @@ -290,49 +275,22 @@ int handle_nand_device_command(struct command_context_s *cmd_ctx, char *cmd, cha { LOG_ERROR("%i: %s", i, nand_flash_controllers[i]->name); } - + 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"); - + register_command(cmd_ctx, nand_cmd, "device", handle_nand_device_command, COMMAND_CONFIG, NULL); - - return ERROR_OK; -} -int nand_init(struct command_context_s *cmd_ctx) -{ - if (nand_devices) - { - register_command(cmd_ctx, nand_cmd, "list", handle_nand_list_command, COMMAND_EXEC, - "list configured NAND flash devices"); - register_command(cmd_ctx, nand_cmd, "info", handle_nand_info_command, COMMAND_EXEC, - "print info about NAND flash device "); - register_command(cmd_ctx, nand_cmd, "probe", handle_nand_probe_command, COMMAND_EXEC, - "identify NAND flash device "); - register_command(cmd_ctx, nand_cmd, "check_bad_blocks", handle_nand_check_bad_blocks_command, COMMAND_EXEC, - "check NAND flash device for bad blocks [ ]"); - register_command(cmd_ctx, nand_cmd, "erase", handle_nand_erase_command, COMMAND_EXEC, - "erase blocks on NAND flash device "); - register_command(cmd_ctx, nand_cmd, "copy", handle_nand_copy_command, COMMAND_EXEC, - "copy from NAND flash device "); - register_command(cmd_ctx, nand_cmd, "dump", handle_nand_dump_command, COMMAND_EXEC, - "dump from NAND flash device [options]"); - register_command(cmd_ctx, nand_cmd, "write", handle_nand_write_command, COMMAND_EXEC, - "write to NAND flash device [oob_raw|oob_only|oob_softecc]"); - register_command(cmd_ctx, nand_cmd, "raw_access", handle_nand_raw_access_command, COMMAND_EXEC, - "raw access to NAND flash device ['enable'|'disable']"); - } - 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) @@ -342,81 +300,95 @@ nand_device_t *get_nand_device_by_num(int num) return p; } } - + return NULL; } -int nand_build_bbt(struct nand_device_s *device, int first, int last) +COMMAND_HELPER(nand_command_get_device_by_num, unsigned name_index, + struct nand_device **nand) { - u32 page = 0x0; + const char *str = args[name_index]; + unsigned num; + COMMAND_PARSE_NUMBER(uint, str, num); + *nand = get_nand_device_by_num(num); + if (!*nand) { + command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", str); + return ERROR_INVALID_ARGUMENTS; + } + return ERROR_OK; +} + +static int nand_build_bbt(struct nand_device *nand, int first, int last) +{ + uint32_t page = 0x0; int i; - u8 oob[6]; - - if ((first < 0) || (first >= device->num_blocks)) + uint8_t oob[6]; + + if ((first < 0) || (first >= nand->num_blocks)) first = 0; - - if ((last >= device->num_blocks) || (last == -1)) - last = device->num_blocks - 1; - + + if ((last >= nand->num_blocks) || (last == -1)) + last = nand->num_blocks - 1; + for (i = first; i < last; i++) { - nand_read_page(device, page, NULL, 0, oob, 6); - - if (((device->device->options & NAND_BUSWIDTH_16) && ((oob[0] & oob[1]) != 0xff)) - || (((device->page_size == 512) && (oob[5] != 0xff)) || - ((device->page_size == 2048) && (oob[0] != 0xff)))) + nand_read_page(nand, page, NULL, 0, oob, 6); + + if (((nand->device->options & NAND_BUSWIDTH_16) && ((oob[0] & oob[1]) != 0xff)) + || (((nand->page_size == 512) && (oob[5] != 0xff)) || + ((nand->page_size == 2048) && (oob[0] != 0xff)))) { - LOG_WARNING("invalid block: %i", i); - device->blocks[i].is_bad = 1; + LOG_WARNING("bad block: %i", i); + nand->blocks[i].is_bad = 1; } else { - device->blocks[i].is_bad = 0; + nand->blocks[i].is_bad = 0; } - - page += (device->erase_size / device->page_size); + + page += (nand->erase_size / nand->page_size); } - + return ERROR_OK; } -int nand_read_status(struct nand_device_s *device, u8 *status) +int nand_read_status(struct nand_device *nand, uint8_t *status) { - if (!device->device) + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - + /* Send read status command */ - device->controller->command(device, NAND_CMD_STATUS); - + nand->controller->command(nand, NAND_CMD_STATUS); + alive_sleep(1); - + /* read status */ - if (device->device->options & NAND_BUSWIDTH_16) + if (nand->device->options & NAND_BUSWIDTH_16) { - u16 data; - device->controller->read_data(device, &data); + uint16_t data; + nand->controller->read_data(nand, &data); *status = data & 0xff; } else { - device->controller->read_data(device, status); + nand->controller->read_data(nand, status); } - + return ERROR_OK; } -int nand_poll_ready(struct nand_device_s *device, int timeout) +static int nand_poll_ready(struct nand_device *nand, int timeout) { - u8 status; + uint8_t status; - device->controller->command(device, NAND_CMD_STATUS); + nand->controller->command(nand, NAND_CMD_STATUS); do { - if (device->device->options & NAND_BUSWIDTH_16) { - u16 data; - device->controller->read_data(device, &data); + if (nand->device->options & NAND_BUSWIDTH_16) { + uint16_t data; + nand->controller->read_data(nand, &data); status = data & 0xff; } else { - device->controller->read_data(device, &status); + nand->controller->read_data(nand, &status); } if (status & NAND_STATUS_READY) break; @@ -426,25 +398,25 @@ int nand_poll_ready(struct nand_device_s *device, int timeout) return (status & NAND_STATUS_READY) != 0; } -int nand_probe(struct nand_device_s *device) +int nand_probe(struct nand_device *nand) { - u8 manufacturer_id, device_id; - u8 id_buff[6]; + uint8_t manufacturer_id, device_id; + uint8_t id_buff[6]; int retval; int i; /* clear device data */ - device->device = NULL; - device->manufacturer = NULL; - + nand->device = NULL; + nand->manufacturer = NULL; + /* clear device parameters */ - device->bus_width = 0; - device->address_cycles = 0; - device->page_size = 0; - device->erase_size = 0; - + nand->bus_width = 0; + nand->address_cycles = 0; + nand->page_size = 0; + nand->erase_size = 0; + /* initialize controller (device parameters are zero, use controller default) */ - if ((retval = device->controller->init(device) != ERROR_OK)) + if ((retval = nand->controller->init(nand) != ERROR_OK)) { switch (retval) { @@ -459,161 +431,161 @@ int nand_probe(struct nand_device_s *device) return ERROR_NAND_OPERATION_FAILED; } } - - device->controller->command(device, NAND_CMD_RESET); - device->controller->reset(device); - device->controller->command(device, NAND_CMD_READID); - device->controller->address(device, 0x0); - - if (device->bus_width == 8) + nand->controller->command(nand, NAND_CMD_RESET); + nand->controller->reset(nand); + + nand->controller->command(nand, NAND_CMD_READID); + nand->controller->address(nand, 0x0); + + if (nand->bus_width == 8) { - device->controller->read_data(device, &manufacturer_id); - device->controller->read_data(device, &device_id); + nand->controller->read_data(nand, &manufacturer_id); + nand->controller->read_data(nand, &device_id); } else { - u16 data_buf; - device->controller->read_data(device, &data_buf); + uint16_t data_buf; + nand->controller->read_data(nand, &data_buf); manufacturer_id = data_buf & 0xff; - device->controller->read_data(device, &data_buf); + nand->controller->read_data(nand, &data_buf); device_id = data_buf & 0xff; } - + for (i = 0; nand_flash_ids[i].name; i++) { if (nand_flash_ids[i].id == device_id) { - device->device = &nand_flash_ids[i]; + nand->device = &nand_flash_ids[i]; break; } } - + for (i = 0; nand_manuf_ids[i].name; i++) { if (nand_manuf_ids[i].id == manufacturer_id) { - device->manufacturer = &nand_manuf_ids[i]; + nand->manufacturer = &nand_manuf_ids[i]; break; } } - - if (!device->manufacturer) + + if (!nand->manufacturer) { - device->manufacturer = &nand_manuf_ids[0]; - device->manufacturer->id = manufacturer_id; + nand->manufacturer = &nand_manuf_ids[0]; + nand->manufacturer->id = manufacturer_id; } - - if (!device->device) + + if (!nand->device) { LOG_ERROR("unknown NAND flash device found, manufacturer id: 0x%2.2x device id: 0x%2.2x", manufacturer_id, device_id); return ERROR_NAND_OPERATION_FAILED; } - - LOG_DEBUG("found %s (%s)", device->device->name, device->manufacturer->name); - + + LOG_DEBUG("found %s (%s)", nand->device->name, nand->manufacturer->name); + /* initialize device parameters */ - - /* bus width */ - if (device->device->options & NAND_BUSWIDTH_16) - device->bus_width = 16; + + /* bus width */ + if (nand->device->options & NAND_BUSWIDTH_16) + nand->bus_width = 16; else - device->bus_width = 8; + nand->bus_width = 8; /* Do we need extended device probe information? */ - if (device->device->page_size == 0 || - device->device->erase_size == 0) + if (nand->device->page_size == 0 || + nand->device->erase_size == 0) { - if (device->bus_width == 8) + if (nand->bus_width == 8) { - device->controller->read_data(device, id_buff+3); - device->controller->read_data(device, id_buff+4); - device->controller->read_data(device, id_buff+5); + nand->controller->read_data(nand, id_buff + 3); + nand->controller->read_data(nand, id_buff + 4); + nand->controller->read_data(nand, id_buff + 5); } else { - u16 data_buf; + uint16_t data_buf; - device->controller->read_data(device, &data_buf); + nand->controller->read_data(nand, &data_buf); id_buff[3] = data_buf; - device->controller->read_data(device, &data_buf); + nand->controller->read_data(nand, &data_buf); id_buff[4] = data_buf; - device->controller->read_data(device, &data_buf); + nand->controller->read_data(nand, &data_buf); id_buff[5] = data_buf >> 8; } } - + /* page size */ - if (device->device->page_size == 0) + if (nand->device->page_size == 0) { - device->page_size = 1 << (10 + (id_buff[4] & 3)); + nand->page_size = 1 << (10 + (id_buff[4] & 3)); } - else if (device->device->page_size == 256) + else if (nand->device->page_size == 256) { LOG_ERROR("NAND flashes with 256 byte pagesize are not supported"); return ERROR_NAND_OPERATION_FAILED; } else { - device->page_size = device->device->page_size; + nand->page_size = nand->device->page_size; } - + /* number of address cycles */ - if (device->page_size <= 512) + if (nand->page_size <= 512) { /* small page devices */ - if (device->device->chip_size <= 32) - device->address_cycles = 3; - else if (device->device->chip_size <= 8*1024) - device->address_cycles = 4; + if (nand->device->chip_size <= 32) + nand->address_cycles = 3; + else if (nand->device->chip_size <= 8*1024) + nand->address_cycles = 4; else { LOG_ERROR("BUG: small page NAND device with more than 8 GiB encountered"); - device->address_cycles = 5; + nand->address_cycles = 5; } } else { /* large page devices */ - if (device->device->chip_size <= 128) - device->address_cycles = 4; - else if (device->device->chip_size <= 32*1024) - device->address_cycles = 5; + if (nand->device->chip_size <= 128) + nand->address_cycles = 4; + else if (nand->device->chip_size <= 32*1024) + nand->address_cycles = 5; else { LOG_ERROR("BUG: large page NAND device with more than 32 GiB encountered"); - device->address_cycles = 6; + nand->address_cycles = 6; } } - + /* erase size */ - if (device->device->erase_size == 0) + if (nand->device->erase_size == 0) { switch ((id_buff[4] >> 4) & 3) { case 0: - device->erase_size = 64 << 10; + nand->erase_size = 64 << 10; break; case 1: - device->erase_size = 128 << 10; + nand->erase_size = 128 << 10; break; case 2: - device->erase_size = 256 << 10; + nand->erase_size = 256 << 10; break; case 3: - device->erase_size =512 << 10; + nand->erase_size =512 << 10; break; } } else { - device->erase_size = device->device->erase_size; + nand->erase_size = nand->device->erase_size; } - + /* initialize controller, but leave parameters at the controllers default */ - if ((retval = device->controller->init(device) != ERROR_OK)) + if ((retval = nand->controller->init(nand) != ERROR_OK)) { switch (retval) { @@ -622,999 +594,1127 @@ int nand_probe(struct nand_device_s *device) return ERROR_NAND_OPERATION_FAILED; case ERROR_NAND_OPERATION_NOT_SUPPORTED: LOG_ERROR("controller doesn't support requested parameters (buswidth: %i, address cycles: %i, page size: %i)", - device->bus_width, device->address_cycles, device->page_size); + nand->bus_width, nand->address_cycles, nand->page_size); return ERROR_NAND_OPERATION_FAILED; default: LOG_ERROR("BUG: unknown controller initialization failure"); return ERROR_NAND_OPERATION_FAILED; } } - - device->num_blocks = (device->device->chip_size * 1024) / (device->erase_size / 1024); - device->blocks = malloc(sizeof(nand_block_t) * device->num_blocks); - - for (i = 0; i < device->num_blocks; i++) + + nand->num_blocks = (nand->device->chip_size * 1024) / (nand->erase_size / 1024); + nand->blocks = malloc(sizeof(struct nand_block) * nand->num_blocks); + + for (i = 0; i < nand->num_blocks; i++) { - device->blocks[i].size = device->erase_size; - device->blocks[i].offset = i * device->erase_size; - device->blocks[i].is_erased = -1; - device->blocks[i].is_bad = -1; + nand->blocks[i].size = nand->erase_size; + nand->blocks[i].offset = i * nand->erase_size; + nand->blocks[i].is_erased = -1; + nand->blocks[i].is_bad = -1; } - + return ERROR_OK; } -int nand_erase(struct nand_device_s *device, int first_block, int last_block) +static int nand_erase(struct nand_device *nand, int first_block, int last_block) { int i; - u32 page; - u8 status; + uint32_t page; + uint8_t status; int retval; - - if (!device->device) + + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - - if ((first_block < 0) || (last_block > device->num_blocks)) + + if ((first_block < 0) || (last_block > nand->num_blocks)) return ERROR_INVALID_ARGUMENTS; - + /* make sure we know if a block is bad before erasing it */ for (i = first_block; i <= last_block; i++) { - if (device->blocks[i].is_bad == -1) + if (nand->blocks[i].is_bad == -1) { - nand_build_bbt(device, i, last_block); + nand_build_bbt(nand, i, last_block); break; } } - + for (i = first_block; i <= last_block; i++) { /* Send erase setup command */ - device->controller->command(device, NAND_CMD_ERASE1); - - page = i * (device->erase_size / device->page_size); - + nand->controller->command(nand, NAND_CMD_ERASE1); + + page = i * (nand->erase_size / nand->page_size); + /* Send page address */ - if (device->page_size <= 512) + if (nand->page_size <= 512) { /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); - + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); + /* 3rd cycle only on devices with more than 32 MiB */ - if (device->address_cycles >= 4) - device->controller->address(device, (page >> 16) & 0xff); - + if (nand->address_cycles >= 4) + nand->controller->address(nand, (page >> 16) & 0xff); + /* 4th cycle only on devices with more than 8 GiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 24) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 24) & 0xff); } else { /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); - + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); + /* 3rd cycle only on devices with more than 128 MiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 16) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 16) & 0xff); } - + /* Send erase confirm command */ - device->controller->command(device, NAND_CMD_ERASE2); + nand->controller->command(nand, NAND_CMD_ERASE2); - retval = device->controller->nand_ready ? - device->controller->nand_ready(device, 1000) : - nand_poll_ready(device, 1000); + retval = nand->controller->nand_ready ? + nand->controller->nand_ready(nand, 1000) : + nand_poll_ready(nand, 1000); if (!retval) { LOG_ERROR("timeout waiting for NAND flash block erase to complete"); return ERROR_NAND_OPERATION_TIMEOUT; } - - if ((retval = nand_read_status(device, &status)) != ERROR_OK) + + if ((retval = nand_read_status(nand, &status)) != ERROR_OK) { LOG_ERROR("couldn't read status"); return ERROR_NAND_OPERATION_FAILED; } - + if (status & 0x1) { - LOG_ERROR("erase operation didn't pass, status: 0x%2.2x", status); - return ERROR_NAND_OPERATION_FAILED; + LOG_ERROR("didn't erase %sblock %d; status: 0x%2.2x", + (nand->blocks[i].is_bad == 1) + ? "bad " : "", + i, status); + /* continue; other blocks might still be erasable */ } - device->blocks[i].is_erased = 1; + nand->blocks[i].is_erased = 1; } - + return ERROR_OK; } -int nand_read_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size) +#if 0 +static int nand_read_plain(struct nand_device *nand, uint32_t address, uint8_t *data, uint32_t data_size) { - u8 *page; - - if (!device->device) + uint8_t *page; + + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - - if (address % device->page_size) + + if (address % nand->page_size) { LOG_ERROR("reads need to be page aligned"); return ERROR_NAND_OPERATION_FAILED; } - - page = malloc(device->page_size); - - while (data_size > 0 ) + + page = malloc(nand->page_size); + + while (data_size > 0) { - u32 thisrun_size = (data_size > device->page_size) ? device->page_size : data_size; - u32 page_address; - - - page_address = address / device->page_size; - - nand_read_page(device, page_address, page, device->page_size, NULL, 0); + uint32_t thisrun_size = (data_size > nand->page_size) ? nand->page_size : data_size; + uint32_t page_address; + + + page_address = address / nand->page_size; + + nand_read_page(nand, page_address, page, nand->page_size, NULL, 0); memcpy(data, page, thisrun_size); - + address += thisrun_size; data += thisrun_size; data_size -= thisrun_size; } - + free(page); - + return ERROR_OK; } -int nand_write_plain(struct nand_device_s *device, u32 address, u8 *data, u32 data_size) +static int nand_write_plain(struct nand_device *nand, uint32_t address, uint8_t *data, uint32_t data_size) { - u8 *page; - - if (!device->device) + uint8_t *page; + + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - - if (address % device->page_size) + + if (address % nand->page_size) { LOG_ERROR("writes need to be page aligned"); return ERROR_NAND_OPERATION_FAILED; } - - page = malloc(device->page_size); - - while (data_size > 0 ) + + page = malloc(nand->page_size); + + while (data_size > 0) { - u32 thisrun_size = (data_size > device->page_size) ? device->page_size : data_size; - u32 page_address; - - memset(page, 0xff, device->page_size); + uint32_t thisrun_size = (data_size > nand->page_size) ? nand->page_size : data_size; + uint32_t page_address; + + memset(page, 0xff, nand->page_size); memcpy(page, data, thisrun_size); - - page_address = address / device->page_size; - - nand_write_page(device, page_address, page, device->page_size, NULL, 0); - + + page_address = address / nand->page_size; + + nand_write_page(nand, page_address, page, nand->page_size, NULL, 0); + address += thisrun_size; data += thisrun_size; data_size -= thisrun_size; } - + free(page); - + return ERROR_OK; } +#endif -int nand_write_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 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) { - u32 block; + uint32_t block; - if (!device->device) + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - - block = page / (device->erase_size / device->page_size); - if (device->blocks[block].is_erased == 1) - device->blocks[block].is_erased = 0; - if (device->use_raw || device->controller->write_page == NULL) - return nand_write_page_raw(device, page, data, data_size, oob, oob_size); + block = page / (nand->erase_size / nand->page_size); + if (nand->blocks[block].is_erased == 1) + nand->blocks[block].is_erased = 0; + + if (nand->use_raw || nand->controller->write_page == NULL) + return nand_write_page_raw(nand, page, data, data_size, oob, oob_size); else - return device->controller->write_page(device, page, data, data_size, oob, oob_size); + return nand->controller->write_page(nand, page, data, data_size, oob, oob_size); } -int nand_read_page(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 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 (!device->device) + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - - if (device->use_raw || device->controller->read_page == NULL) - return nand_read_page_raw(device, page, data, data_size, oob, oob_size); + + if (nand->use_raw || nand->controller->read_page == NULL) + return nand_read_page_raw(nand, page, data, data_size, oob, oob_size); else - return device->controller->read_page(device, page, data, data_size, oob, oob_size); + return nand->controller->read_page(nand, page, data, data_size, oob, oob_size); } -int nand_read_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 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) { - int i; - - if (!device->device) + uint32_t i; + + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - if (device->page_size <= 512) + if (nand->page_size <= 512) { /* small page device */ if (data) - device->controller->command(device, NAND_CMD_READ0); + nand->controller->command(nand, NAND_CMD_READ0); else - device->controller->command(device, NAND_CMD_READOOB); - + nand->controller->command(nand, NAND_CMD_READOOB); + /* column (always 0, we start at the beginning of a page/OOB area) */ - device->controller->address(device, 0x0); - + nand->controller->address(nand, 0x0); + /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); - + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); + /* 4th cycle only on devices with more than 32 MiB */ - if (device->address_cycles >= 4) - device->controller->address(device, (page >> 16) & 0xff); + if (nand->address_cycles >= 4) + nand->controller->address(nand, (page >> 16) & 0xff); /* 5th cycle only on devices with more than 8 GiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 24) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 24) & 0xff); } else { /* large page device */ - device->controller->command(device, NAND_CMD_READ0); - + nand->controller->command(nand, NAND_CMD_READ0); + /* column (0 when we start at the beginning of a page, * or 2048 for the beginning of OOB area) */ - device->controller->address(device, 0x0); + nand->controller->address(nand, 0x0); if (data) - device->controller->address(device, 0x0); + nand->controller->address(nand, 0x0); else - device->controller->address(device, 0x8); - + nand->controller->address(nand, 0x8); + /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); /* 5th cycle only on devices with more than 128 MiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 16) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 16) & 0xff); /* large page devices need a start command */ - device->controller->command(device, NAND_CMD_READSTART); + nand->controller->command(nand, NAND_CMD_READSTART); } - - if (device->controller->nand_ready) { - if (!device->controller->nand_ready(device, 100)) + + if (nand->controller->nand_ready) { + if (!nand->controller->nand_ready(nand, 100)) return ERROR_NAND_OPERATION_TIMEOUT; } else { alive_sleep(1); } - + if (data) { - if (device->controller->read_block_data != NULL) - (device->controller->read_block_data)(device, data, data_size); + if (nand->controller->read_block_data != NULL) + (nand->controller->read_block_data)(nand, data, data_size); else { for (i = 0; i < data_size;) { - if (device->device->options & NAND_BUSWIDTH_16) + if (nand->device->options & NAND_BUSWIDTH_16) { - device->controller->read_data(device, data); + nand->controller->read_data(nand, data); data += 2; i += 2; } else { - device->controller->read_data(device, data); + nand->controller->read_data(nand, data); data += 1; i += 1; } } } } - + if (oob) { - if (device->controller->read_block_data != NULL) - (device->controller->read_block_data)(device, oob, oob_size); + if (nand->controller->read_block_data != NULL) + (nand->controller->read_block_data)(nand, oob, oob_size); else { for (i = 0; i < oob_size;) { - if (device->device->options & NAND_BUSWIDTH_16) + if (nand->device->options & NAND_BUSWIDTH_16) { - device->controller->read_data(device, oob); + nand->controller->read_data(nand, oob); oob += 2; i += 2; } else { - device->controller->read_data(device, oob); + nand->controller->read_data(nand, oob); oob += 1; i += 1; } } } } - - return ERROR_OK; + + return ERROR_OK; } -int nand_write_page_raw(struct nand_device_s *device, u32 page, u8 *data, u32 data_size, u8 *oob, u32 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) { - int i; + uint32_t i; int retval; - u8 status; - - if (!device->device) + uint8_t status; + + if (!nand->device) return ERROR_NAND_DEVICE_NOT_PROBED; - device->controller->command(device, NAND_CMD_SEQIN); - - if (device->page_size <= 512) + nand->controller->command(nand, NAND_CMD_SEQIN); + + if (nand->page_size <= 512) { /* column (always 0, we start at the beginning of a page/OOB area) */ - device->controller->address(device, 0x0); - + nand->controller->address(nand, 0x0); + /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); - + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); + /* 4th cycle only on devices with more than 32 MiB */ - if (device->address_cycles >= 4) - device->controller->address(device, (page >> 16) & 0xff); + if (nand->address_cycles >= 4) + nand->controller->address(nand, (page >> 16) & 0xff); /* 5th cycle only on devices with more than 8 GiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 24) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 24) & 0xff); } else { /* column (0 when we start at the beginning of a page, * or 2048 for the beginning of OOB area) */ - device->controller->address(device, 0x0); + nand->controller->address(nand, 0x0); if (data) - device->controller->address(device, 0x0); + nand->controller->address(nand, 0x0); else - device->controller->address(device, 0x8); - + nand->controller->address(nand, 0x8); + /* row */ - device->controller->address(device, page & 0xff); - device->controller->address(device, (page >> 8) & 0xff); + nand->controller->address(nand, page & 0xff); + nand->controller->address(nand, (page >> 8) & 0xff); /* 5th cycle only on devices with more than 128 MiB */ - if (device->address_cycles >= 5) - device->controller->address(device, (page >> 16) & 0xff); + if (nand->address_cycles >= 5) + nand->controller->address(nand, (page >> 16) & 0xff); } - + if (data) { - if (device->controller->write_block_data != NULL) - (device->controller->write_block_data)(device, data, data_size); + if (nand->controller->write_block_data != NULL) + (nand->controller->write_block_data)(nand, data, data_size); else { for (i = 0; i < data_size;) { - if (device->device->options & NAND_BUSWIDTH_16) + if (nand->device->options & NAND_BUSWIDTH_16) { - u16 data_buf = le_to_h_u16(data); - device->controller->write_data(device, data_buf); + uint16_t data_buf = le_to_h_u16(data); + nand->controller->write_data(nand, data_buf); data += 2; i += 2; } else { - device->controller->write_data(device, *data); + nand->controller->write_data(nand, *data); data += 1; i += 1; } } } } - + if (oob) { - if (device->controller->write_block_data != NULL) - (device->controller->write_block_data)(device, oob, oob_size); + if (nand->controller->write_block_data != NULL) + (nand->controller->write_block_data)(nand, oob, oob_size); else { for (i = 0; i < oob_size;) { - if (device->device->options & NAND_BUSWIDTH_16) + if (nand->device->options & NAND_BUSWIDTH_16) { - u16 oob_buf = le_to_h_u16(data); - device->controller->write_data(device, oob_buf); + uint16_t oob_buf = le_to_h_u16(data); + nand->controller->write_data(nand, oob_buf); oob += 2; i += 2; } else { - device->controller->write_data(device, *oob); + nand->controller->write_data(nand, *oob); oob += 1; i += 1; } } } } - - device->controller->command(device, NAND_CMD_PAGEPROG); - - retval = device->controller->nand_ready ? - device->controller->nand_ready(device, 100) : - nand_poll_ready(device, 100); + + nand->controller->command(nand, NAND_CMD_PAGEPROG); + + retval = nand->controller->nand_ready ? + nand->controller->nand_ready(nand, 100) : + nand_poll_ready(nand, 100); if (!retval) return ERROR_NAND_OPERATION_TIMEOUT; - - if ((retval = nand_read_status(device, &status)) != ERROR_OK) + + if ((retval = nand_read_status(nand, &status)) != ERROR_OK) { LOG_ERROR("couldn't read status"); return ERROR_NAND_OPERATION_FAILED; } - + if (status & NAND_STATUS_FAIL) { LOG_ERROR("write operation didn't pass, status: 0x%2.2x", status); return ERROR_NAND_OPERATION_FAILED; } - - return ERROR_OK; + + return ERROR_OK; } -int handle_nand_list_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_list_command) { - nand_device_t *p; - int i = 0; - + 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; p; p = p->next) + + for (p = nand_devices, i = 0; p; p = p->next, i++) { if (p->device) - command_print(cmd_ctx, "#%i: %s (%s) pagesize: %i, buswidth: %i, erasesize: %i", - i++, p->device->name, p->manufacturer->name, p->page_size, p->bus_width, p->erase_size); + command_print(cmd_ctx, "#%i: %s (%s) " + "pagesize: %i, buswidth: %i,\n\t" + "blocksize: %i, blocks: %i", + i, p->device->name, p->manufacturer->name, + p->page_size, p->bus_width, + p->erase_size, p->num_blocks); else - command_print(cmd_ctx, "#%i: not probed"); + command_print(cmd_ctx, "#%i: not probed", i); } - + return ERROR_OK; } -int handle_nand_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_info_command) { - nand_device_t *p; int i = 0; int j = 0; int first = -1; int last = -1; - - if ((argc < 1) || (argc > 3)) - { - return ERROR_COMMAND_SYNTAX_ERROR; + struct nand_device *p; + int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p); + if (ERROR_OK != retval) + return retval; + + switch (argc) { + default: + return ERROR_COMMAND_SYNTAX_ERROR; + case 1: + first = 0; + last = INT32_MAX; + break; + case 2: + COMMAND_PARSE_NUMBER(int, args[1], i); + first = last = i; + i = 0; + break; + case 3: + COMMAND_PARSE_NUMBER(int, args[1], first); + COMMAND_PARSE_NUMBER(int, args[2], last); + break; + } + + if (NULL == p->device) + { + command_print(cmd_ctx, "#%s: not probed", args[0]); + return ERROR_OK; } - - if (argc == 2) - { - first = last = strtoul(args[1], NULL, 0); - } - else if (argc == 3) - { - first = strtoul(args[1], NULL, 0); - last = strtoul(args[2], NULL, 0); - } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + 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++) { - if (p->device) - { - 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)"; + char *erase_state, *bad_state; - command_print(cmd_ctx, "\t#%i: 0x%8.8x (0x%xkB) %s%s", - j, p->blocks[j].offset, p->blocks[j].size / 1024, - erase_state, bad_state); - } - } + if (p->blocks[j].is_erased == 0) + erase_state = "not erased"; + else if (p->blocks[j].is_erased == 1) + erase_state = "erased"; else - { - command_print(cmd_ctx, "#%i: not probed"); - } + 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; } -int handle_nand_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_probe_command) { - nand_device_t *p; - int retval; - if (argc != 1) { return ERROR_COMMAND_SYNTAX_ERROR; } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + struct nand_device *p; + int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 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) { - if ((retval = nand_probe(p)) == ERROR_OK) - { - command_print(cmd_ctx, "NAND flash device '%s' found", p->device->name); - } - else if (retval == ERROR_NAND_OPERATION_FAILED) - { - command_print(cmd_ctx, "probing failed for NAND flash device"); - } - else - { - command_print(cmd_ctx, "unknown error when probing NAND flash device"); - } + command_print(cmd_ctx, "probing failed for NAND flash device"); } else { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + command_print(cmd_ctx, "unknown error when probing NAND flash device"); } - + return ERROR_OK; } -int handle_nand_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_erase_command) { - nand_device_t *p; - int retval; - - if (argc != 3) + if (argc != 1 && argc != 3) { return ERROR_COMMAND_SYNTAX_ERROR; } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + struct nand_device *p; + int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p); + if (ERROR_OK != retval) + return retval; + + unsigned long offset; + unsigned long length; + + /* erase specified part of the chip; or else everything */ + if (argc == 3) { + unsigned long size = p->erase_size * p->num_blocks; + + COMMAND_PARSE_NUMBER(ulong, args[1], offset); + if ((offset % p->erase_size) != 0 || offset >= size) + return ERROR_INVALID_ARGUMENTS; + + COMMAND_PARSE_NUMBER(ulong, args[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) { - int first = strtoul(args[1], NULL, 0); - int last = strtoul(args[2], NULL, 0); - - if ((retval = nand_erase(p, first, last)) == ERROR_OK) - { - command_print(cmd_ctx, "successfully erased blocks %i to %i on NAND flash device '%s'", first, last, 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"); - } + command_print(cmd_ctx, "erased blocks %lu to %lu " + "on NAND flash device #%s '%s'", + offset, offset + length, + args[0], p->device->name); + } + else if (retval == ERROR_NAND_OPERATION_FAILED) + { + command_print(cmd_ctx, "erase failed"); } else { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + command_print(cmd_ctx, "unknown error when erasing NAND flash device"); } - + return ERROR_OK; } -int handle_nand_check_bad_blocks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_check_bad_blocks_command) { - nand_device_t *p; - int retval; int first = -1; int last = -1; - + if ((argc < 1) || (argc > 3) || (argc == 2)) { return ERROR_COMMAND_SYNTAX_ERROR; } - + + struct nand_device *p; + int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p); + if (ERROR_OK != retval) + return retval; + if (argc == 3) { - first = strtoul(args[1], NULL, 0); - last = strtoul(args[2], NULL, 0); + unsigned long offset; + unsigned long length; + + COMMAND_PARSE_NUMBER(ulong, args[1], offset); + if (offset % p->erase_size) + return ERROR_INVALID_ARGUMENTS; + offset /= p->erase_size; + + COMMAND_PARSE_NUMBER(ulong, args[2], length); + if (length % p->erase_size) + return ERROR_INVALID_ARGUMENTS; + + length -= 1; + length /= p->erase_size; + + first = offset; + last = offset + length; } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + retval = nand_build_bbt(p, first, last); + if (retval == ERROR_OK) { - if ((retval = nand_build_bbt(p, first, last)) == ERROR_OK) - { - command_print(cmd_ctx, "checked NAND flash device for bad blocks, use \"nand info\" command to list blocks", p->device->name); - } - 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"); - } + 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, "NAND flash device '#%s' is out of bounds", args[0]); + command_print(cmd_ctx, "unknown error when checking for bad " + "blocks on NAND flash device"); } - + return ERROR_OK; } -int handle_nand_copy_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +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) { - nand_device_t *p; - - if (argc != 4) + 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; } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + 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); } - else + + 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) { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + 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); +} -int handle_nand_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +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) { - u32 offset; - u32 binary_size; - u32 buf_cnt; - enum oob_formats oob_format = NAND_OOB_NONE; - - fileio_t fileio; - - duration_t duration; - char *duration_text; - - nand_device_t *p; - - if (argc < 3) - { + nand_fileio_init(state); + + unsigned minargs = need_size ? 4 : 3; + if (argc < minargs) return ERROR_COMMAND_SYNTAX_ERROR; + 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 == 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; + } } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + if (argc > minargs) { - u8 *page = NULL; - u32 page_size = 0; - u8 *oob = NULL; - u32 oob_size = 0; - const int *eccpos = NULL; - - offset = strtoul(args[2], NULL, 0); - - if (argc > 3) + for (unsigned i = minargs; i < argc; i++) { - int i; - for (i = 3; 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 { - 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 - { - command_print(cmd_ctx, "unknown option: %s", args[i]); - return ERROR_COMMAND_SYNTAX_ERROR; - } + command_print(cmd_ctx, "unknown option: %s", args[i]); + return ERROR_COMMAND_SYNTAX_ERROR; } } - - duration_start_measure(&duration); + } + + 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; - if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK) + *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) + { + 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) { - return ERROR_OK; + 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]; } - - buf_cnt = binary_size = fileio.size; - - if (!(oob_format & NAND_OOB_ONLY)) + } + 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) { - page_size = p->page_size; - page = malloc(p->page_size); + 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; +} - if (oob_format & (NAND_OOB_RAW | NAND_OOB_SW_ECC)) +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) { - if (p->page_size == 512) { - oob_size = 16; - eccpos = nand_oob_16.eccpos; - } else if (p->page_size == 2048) { - oob_size = 64; - eccpos = nand_oob_64.eccpos; - } - oob = malloc(oob_size); + command_print(cmd_ctx, "error while reading file"); + return nand_fileio_cleanup(&s); } - - if (offset % p->page_size) + 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, "only page size aligned offsets and sizes are supported"); - fileio_close(&fileio); - free(oob); - free(page); - return ERROR_OK; + 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); } - - while (buf_cnt > 0) - { - u32 size_read; - - if (NULL != page) - { - 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); - } - } + s.address += s.page_size; + } - if (oob_format & NAND_OOB_SW_ECC) - { - int i, j; - u8 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 (NULL != oob) - { - fileio_read(&fileio, oob_size, oob, &size_read); - buf_cnt -= size_read; - if (size_read < oob_size) - { - memset(oob + size_read, 0xff, oob_size - size_read); - } - } - - 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.8x", - args[1], args[0], offset); + 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)", + args[1], args[0], s.address, duration_elapsed(&s.bench), + duration_kbps(&s.bench, total_bytes)); + } + return ERROR_OK; +} - fileio_close(&fileio); - free(oob); - free(page); +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); + } - return ERROR_OK; - } - offset += page_size; + 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); } - fileio_close(&fileio); - free(oob); - free(page); - oob = NULL; - page = NULL; - duration_stop_measure(&duration, &duration_text); - command_print(cmd_ctx, "wrote file %s to NAND flash %s up to offset 0x%8.8x in %s", - args[1], args[0], offset, duration_text); - free(duration_text); - duration_text = NULL; + 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; + file.address += nand->page_size; } - else + + if (nand_fileio_finish(&file) == ERROR_OK) { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + command_print(cmd_ctx, "verified file %s in NAND flash %s " + "up to offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)", + args[1], args[0], dev.address, duration_elapsed(&file.bench), + duration_kbps(&file.bench, dev.size)); } - - return ERROR_OK; + + return nand_fileio_cleanup(&dev); } -int handle_nand_dump_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_dump_command) { - nand_device_t *p; - - if (argc < 4) - { - return ERROR_COMMAND_SYNTAX_ERROR; - } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) - { - if (p->device) + 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) + { + 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) { - fileio_t fileio; - duration_t duration; - char *duration_text; - int retval; - - u8 *page = NULL; - u32 page_size = 0; - u8 *oob = NULL; - u32 oob_size = 0; - u32 address = strtoul(args[2], NULL, 0); - u32 size = strtoul(args[3], NULL, 0); - u32 bytes_done = 0; - enum oob_formats oob_format = NAND_OOB_NONE; - - if (argc > 4) - { - int i; - for (i = 4; i < argc; i++) - { - if (!strcmp(args[i], "oob_raw")) - oob_format |= NAND_OOB_RAW; - else if (!strcmp(args[i], "oob_only")) - oob_format |= NAND_OOB_RAW | NAND_OOB_ONLY; - else - command_print(cmd_ctx, "unknown option: '%s'", args[i]); - } - } - - if ((address % p->page_size) || (size % p->page_size)) - { - command_print(cmd_ctx, "only page size aligned addresses and sizes are supported"); - return ERROR_OK; - } - - if (!(oob_format & NAND_OOB_ONLY)) - { - page_size = p->page_size; - page = malloc(p->page_size); - } - - if (oob_format & NAND_OOB_RAW) - { - if (p->page_size == 512) - oob_size = 16; - else if (p->page_size == 2048) - oob_size = 64; - oob = malloc(oob_size); - } - - if (fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK) - { - return ERROR_OK; - } - - duration_start_measure(&duration); - - while (size > 0) - { - u32 size_written; - if ((retval = nand_read_page(p, address / p->page_size, page, page_size, oob, oob_size)) != ERROR_OK) - { - command_print(cmd_ctx, "reading NAND flash page failed"); - free(page); - free(oob); - fileio_close(&fileio); - return ERROR_OK; - } - - if (NULL != page) - { - fileio_write(&fileio, page_size, page, &size_written); - bytes_done += page_size; - } - - if (NULL != oob) - { - fileio_write(&fileio, oob_size, oob, &size_written); - bytes_done += oob_size; - } - - size -= p->page_size; - address += p->page_size; - } - - free(page); - page = NULL; - free(oob); - oob = NULL; - fileio_close(&fileio); - - duration_stop_measure(&duration, &duration_text); - command_print(cmd_ctx, "dumped %"PRIi64" byte in %s", fileio.size, duration_text); - free(duration_text); - duration_text = NULL; - } - else - { - command_print(cmd_ctx, "#%i: not probed"); + 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; } - else + + if (nand_fileio_finish(&s) == ERROR_OK) { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + 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; } -int handle_nand_raw_access_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_nand_raw_access_command) { - nand_device_t *p; - if ((argc < 1) || (argc > 2)) { return ERROR_COMMAND_SYNTAX_ERROR; } - - p = get_nand_device_by_num(strtoul(args[0], NULL, 0)); - if (p) + + struct nand_device *p; + int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p); + if (ERROR_OK != retval) + return retval; + + if (NULL == p->device) { - if (p->device) - { - if (argc == 2) - { - if (strcmp("enable", args[1]) == 0) - { - p->use_raw = 1; - } - else if (strcmp("disable", args[1]) == 0) - { - p->use_raw = 0; - } - else - { - return ERROR_COMMAND_SYNTAX_ERROR; - } - } - - command_print(cmd_ctx, "raw access is %s", (p->use_raw) ? "enabled" : "disabled"); - } - else - { - command_print(cmd_ctx, "#%i: not probed"); - } + command_print(cmd_ctx, "#%s: not probed", args[0]); + return ERROR_OK; } - else + + if (argc == 2) { - command_print(cmd_ctx, "NAND flash device '#%s' is out of bounds", args[0]); + if (strcmp("enable", args[1]) == 0) + p->use_raw = 1; + else if (strcmp("disable", args[1]) == 0) + p->use_raw = 0; + else + return ERROR_COMMAND_SYNTAX_ERROR; } - + + const char *msg = p->use_raw ? "enabled" : "disabled"; + command_print(cmd_ctx, "raw access is %s", msg); + + return ERROR_OK; +} + +int nand_init(struct command_context *cmd_ctx) +{ + if (!nand_devices) + return ERROR_OK; + + register_command(cmd_ctx, nand_cmd, "list", + handle_nand_list_command, COMMAND_EXEC, + "list configured NAND flash devices"); + register_command(cmd_ctx, nand_cmd, "info", + handle_nand_info_command, COMMAND_EXEC, + "print info about NAND flash device "); + register_command(cmd_ctx, nand_cmd, "probe", + handle_nand_probe_command, COMMAND_EXEC, + "identify NAND flash device "); + + register_command(cmd_ctx, nand_cmd, "check_bad_blocks", + handle_nand_check_bad_blocks_command, COMMAND_EXEC, + "check NAND flash device for bad blocks [ ]"); + register_command(cmd_ctx, nand_cmd, "erase", + handle_nand_erase_command, COMMAND_EXEC, + "erase blocks on NAND flash device [ ]"); + register_command(cmd_ctx, nand_cmd, "dump", + handle_nand_dump_command, COMMAND_EXEC, + "dump from NAND flash device " + " [oob_raw | oob_only]"); + register_command(cmd_ctx, nand_cmd, "verify", + &handle_nand_verify_command, COMMAND_EXEC, + "verify NAND flash device " + "[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 " + "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]"); + + register_command(cmd_ctx, nand_cmd, "raw_access", + handle_nand_raw_access_command, COMMAND_EXEC, + "raw access to NAND flash device ['enable'|'disable']"); + return ERROR_OK; }