X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fflash%2Fnand%2Ftcl.c;h=67a62770fb92c1fdcfc643957e0a38e2973f6912;hb=5308bd991ca63e56c272af47ad6dacf7e4c75569;hp=1272bf62b50c706d0485c046c92d25d82433b73c;hpb=5fd1c2db9ad43cc893d6287549262f82e6932e90;p=openocd.git diff --git a/src/flash/nand/tcl.c b/src/flash/nand/tcl.c index 1272bf62b5..67a62770fb 100644 --- a/src/flash/nand/tcl.c +++ b/src/flash/nand/tcl.c @@ -1,25 +1,13 @@ +// SPDX-License-Identifier: GPL-2.0-or-later + /*************************************************************************** * Copyright (C) 2007 by Dominic Rath * * Copyright (C) 2002 Thomas Gleixner * * Copyright (C) 2009 Zachary T Welch * * * * 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 @@ -27,32 +15,28 @@ #include "core.h" #include "imp.h" #include "fileio.h" - -// to be removed -extern struct nand_device *nand_devices; +#include COMMAND_HANDLER(handle_nand_list_command) { struct nand_device *p; int i; - if (!nand_devices) - { - command_print(CMD_CTX, "no NAND flash devices configured"); + if (!nand_devices) { + command_print(CMD, "no NAND flash devices configured"); return ERROR_OK; } - for (p = nand_devices, i = 0; p; p = p->next, i++) - { + for (p = nand_devices, i = 0; p; p = p->next, i++) { if (p->device) - command_print(CMD_CTX, "#%i: %s (%s) " + command_print(CMD, "#%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); + command_print(CMD, "#%i: not probed", i); } return ERROR_OK; @@ -66,31 +50,30 @@ COMMAND_HANDLER(handle_nand_info_command) 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; + 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) + if (retval != ERROR_OK) return retval; - if (NULL == p->device) - { - command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]); + if (!p->device) { + command_print(CMD, "#%s: not probed", CMD_ARGV[0]); return ERROR_OK; } @@ -100,11 +83,16 @@ COMMAND_HANDLER(handle_nand_info_command) 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); + command_print(CMD, + "#%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++) - { + for (j = first; j <= last; j++) { char *erase_state, *bad_state; if (p->blocks[j].is_erased == 0) @@ -121,13 +109,13 @@ COMMAND_HANDLER(handle_nand_info_command) 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); + command_print(CMD, + "\t#%i: 0x%8.8" PRIx32 " (%" PRIu32 "kB) %s%s", + j, + p->blocks[j].offset, + p->blocks[j].size / 1024, + erase_state, + bad_state); } return ERROR_OK; @@ -136,42 +124,30 @@ COMMAND_HANDLER(handle_nand_info_command) 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) + if (retval != ERROR_OK) 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"); + retval = nand_probe(p); + if (retval == ERROR_OK) { + command_print(CMD, "NAND flash device '%s (%s)' found", + p->device->name, p->manufacturer->name); } - return ERROR_OK; + return retval; } 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) + if (retval != ERROR_OK) return retval; unsigned long offset; @@ -183,12 +159,12 @@ COMMAND_HANDLER(handle_nand_erase_command) COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[1], offset); if ((offset % p->erase_size) != 0 || offset >= size) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length); if ((length == 0) || (length % p->erase_size) != 0 - || (length + offset) > size) - return ERROR_INVALID_ARGUMENTS; + || (length + offset) > size) + return ERROR_COMMAND_SYNTAX_ERROR; offset /= p->erase_size; length /= p->erase_size; @@ -198,23 +174,14 @@ COMMAND_HANDLER(handle_nand_erase_command) } 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"); + if (retval == ERROR_OK) { + command_print(CMD, "erased blocks %lu to %lu " + "on NAND flash device #%s '%s'", + offset, offset + length - 1, + CMD_ARGV[0], p->device->name); } - return ERROR_OK; + return retval; } COMMAND_HANDLER(handle_nand_check_bad_blocks_command) @@ -223,29 +190,25 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command) 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) + if (retval != ERROR_OK) return retval; - if (CMD_ARGC == 3) - { + 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; + return ERROR_COMMAND_SYNTAX_ERROR; offset /= p->erase_size; COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], length); if (length % p->erase_size) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; length -= 1; length /= p->erase_size; @@ -255,23 +218,12 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command) } 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"); + if (retval == ERROR_OK) { + command_print(CMD, "checked NAND flash device for bad blocks, " + "use \"nand info\" command to list blocks"); } - return ERROR_OK; + return retval; } COMMAND_HANDLER(handle_nand_write_command) @@ -280,38 +232,36 @@ COMMAND_HANDLER(handle_nand_write_command) struct nand_fileio_state s; int retval = CALL_COMMAND_HANDLER(nand_fileio_parse_args, &s, &nand, FILEIO_READ, false, true); - if (ERROR_OK != retval) + if (retval != ERROR_OK) return retval; uint32_t total_bytes = s.size; - while (s.size > 0) - { + 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); + if (bytes_read <= 0) { + command_print(CMD, "error while reading file"); + nand_fileio_cleanup(&s); + return ERROR_FAIL; } 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 " + if (retval != ERROR_OK) { + command_print(CMD, "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); + nand_fileio_cleanup(&s); + return retval; } 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 KiB/s)", - CMD_ARGV[1], CMD_ARGV[0], s.address, duration_elapsed(&s.bench), - duration_kbps(&s.bench, total_bytes)); + if (nand_fileio_finish(&s) == ERROR_OK) { + command_print(CMD, "wrote file %s to NAND flash %s up to " + "offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + CMD_ARGV[1], CMD_ARGV[0], s.address, duration_elapsed(&s.bench), + duration_kbps(&s.bench, total_bytes)); } return ERROR_OK; } @@ -322,7 +272,7 @@ COMMAND_HANDLER(handle_nand_verify_command) struct nand_fileio_state file; int retval = CALL_COMMAND_HANDLER(nand_fileio_parse_args, &file, &nand, FILEIO_READ, false, true); - if (ERROR_OK != retval) + if (retval != ERROR_OK) return retval; struct nand_fileio_state dev; @@ -330,48 +280,46 @@ COMMAND_HANDLER(handle_nand_verify_command) 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) + retval = nand_fileio_start(CMD, nand, NULL, FILEIO_NONE, &dev); + if (retval != ERROR_OK) return retval; - while (file.size > 0) - { - int retval = nand_read_page(nand, dev.address / dev.page_size, + while (file.size > 0) { + 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"); + if (retval != ERROR_OK) { + command_print(CMD, "reading NAND flash page failed"); nand_fileio_cleanup(&dev); - return nand_fileio_cleanup(&file); + nand_fileio_cleanup(&file); + return retval; } int bytes_read = nand_fileio_read(nand, &file); - if (bytes_read <= 0) - { - command_print(CMD_CTX, "error while reading file"); + if (bytes_read <= 0) { + command_print(CMD, "error while reading file"); nand_fileio_cleanup(&dev); - return nand_fileio_cleanup(&file); + nand_fileio_cleanup(&file); + return ERROR_FAIL; } 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); + (dev.oob && memcmp(dev.oob, file.oob, dev.oob_size))) { + command_print(CMD, "NAND flash contents differ " + "at 0x%8.8" PRIx32, dev.address); nand_fileio_cleanup(&dev); - return nand_fileio_cleanup(&file); + nand_fileio_cleanup(&file); + return ERROR_FAIL; } 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 KiB/s)", - CMD_ARGV[1], CMD_ARGV[0], dev.address, duration_elapsed(&file.bench), - duration_kbps(&file.bench, dev.size)); + if (nand_fileio_finish(&file) == ERROR_OK) { + command_print(CMD, "verified file %s in NAND flash %s " + "up to offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)", + CMD_ARGV[1], CMD_ARGV[0], dev.address, duration_elapsed(&file.bench), + duration_kbps(&file.bench, dev.size)); } return nand_fileio_cleanup(&dev); @@ -379,39 +327,42 @@ COMMAND_HANDLER(handle_nand_verify_command) COMMAND_HANDLER(handle_nand_dump_command) { + size_t filesize; 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) + if (retval != ERROR_OK) return retval; - while (s.size > 0) - { + while (s.size > 0) { size_t size_written; - int retval = nand_read_page(nand, s.address / nand->page_size, + 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 (retval != ERROR_OK) { + command_print(CMD, "reading NAND flash page failed"); + nand_fileio_cleanup(&s); + return retval; } - if (NULL != s.page) - fileio_write(&s.fileio, s.page_size, s.page, &size_written); + if (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); + if (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 %ld bytes in %fs (%0.3f KiB/s)", - (long)s.fileio.size, duration_elapsed(&s.bench), - duration_kbps(&s.bench, s.fileio.size)); + retval = fileio_size(s.fileio, &filesize); + if (retval != ERROR_OK) + return retval; + + if (nand_fileio_finish(&s) == ERROR_OK) { + command_print(CMD, "dumped %zu bytes in %fs (%0.3f KiB/s)", + filesize, duration_elapsed(&s.bench), + duration_kbps(&s.bench, filesize)); } return ERROR_OK; } @@ -419,18 +370,15 @@ COMMAND_HANDLER(handle_nand_dump_command) 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) + if (retval != ERROR_OK) return retval; - if (NULL == p->device) - { - command_print(CMD_CTX, "#%s: not probed", CMD_ARGV[0]); + if (!p->device) { + command_print(CMD, "#%s: not probed", CMD_ARGV[0]); return ERROR_OK; } @@ -438,7 +386,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command) 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); + command_print(CMD, "raw access is %s", msg); return ERROR_OK; } @@ -449,6 +397,7 @@ static const struct command_registration nand_exec_command_handlers[] = { .handler = handle_nand_list_command, .mode = COMMAND_EXEC, .help = "list configured NAND flash devices", + .usage = "", }, { .name = "info", @@ -516,8 +465,8 @@ static 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); + + return register_commands(cmd_ctx, "nand", nand_exec_command_handlers); } COMMAND_HANDLER(handle_nand_init_command) @@ -525,9 +474,8 @@ COMMAND_HANDLER(handle_nand_init_command) if (CMD_ARGC != 0) return ERROR_COMMAND_SYNTAX_ERROR; - static bool nand_initialized = false; - if (nand_initialized) - { + static bool nand_initialized; + if (nand_initialized) { LOG_INFO("'nand init' has already been called"); return ERROR_OK; } @@ -539,30 +487,45 @@ COMMAND_HANDLER(handle_nand_init_command) static 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); + struct command_invocation *cmd = x; + command_print(cmd, " %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); + command_print(CMD, "Available NAND flash controller drivers:"); + return nand_driver_walk(&nand_list_walker, CMD); } static COMMAND_HELPER(create_nand_device, const char *bank_name, - struct nand_flash_controller *controller) + struct nand_flash_controller *controller) { - if (NULL != controller->commands) - { - int retval = register_commands(CMD_CTX, NULL, - controller->commands); - if (ERROR_OK != retval) + struct nand_device *c; + struct target *target; + int retval; + + if (CMD_ARGC < 2) + return ERROR_COMMAND_SYNTAX_ERROR; + target = get_target(CMD_ARGV[1]); + if (!target) { + LOG_ERROR("invalid target %s", CMD_ARGV[1]); + return ERROR_COMMAND_ARGUMENT_INVALID; + } + + if (controller->commands) { + retval = register_commands(CMD_CTX, NULL, controller->commands); + if (retval != ERROR_OK) return retval; } - struct nand_device *c = malloc(sizeof(struct nand_device)); + c = malloc(sizeof(struct nand_device)); + if (!c) { + LOG_ERROR("End of memory"); + return ERROR_FAIL; + } c->name = strdup(bank_name); + c->target = target; c->controller = controller; c->controller_priv = NULL; c->manufacturer = NULL; @@ -570,17 +533,21 @@ static COMMAND_HELPER(create_nand_device, const char *bank_name, c->bus_width = 0; c->address_cycles = 0; c->page_size = 0; - c->use_raw = 0; + c->use_raw = false; 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); + retval = CALL_COMMAND_HANDLER(controller->nand_device_command, c); + if (retval != ERROR_OK) { + LOG_ERROR("'%s' driver rejected nand flash. Usage: %s", + controller->name, + controller->usage); free(c); - return ERROR_OK; + return retval; } + if (!controller->usage) + LOG_DEBUG("'%s' driver usage field missing", controller->name); + nand_device_add(c); return ERROR_OK; @@ -588,21 +555,17 @@ static COMMAND_HELPER(create_nand_device, const char *bank_name, COMMAND_HANDLER(handle_nand_device_command) { - if (CMD_ARGC < 1) - { - LOG_ERROR("incomplete nand device configuration"); - return ERROR_FLASH_BANK_INVALID; - } + if (CMD_ARGC < 2) + return ERROR_COMMAND_SYNTAX_ERROR; - // save name and increment (for compatibility) with drivers + /* 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) - { + if (!controller) { LOG_ERROR("No valid NAND flash driver found (%s)", driver_name); return CALL_COMMAND_HANDLER(handle_nand_list_drivers); } @@ -622,20 +585,24 @@ static const struct command_registration nand_config_command_handlers[] = { .handler = &handle_nand_list_drivers, .mode = COMMAND_ANY, .help = "lists available NAND drivers", + .usage = "" }, { .name = "init", .mode = COMMAND_CONFIG, .handler = &handle_nand_init_command, .help = "initialize NAND devices", + .usage = "" }, COMMAND_REGISTRATION_DONE }; + static const struct command_registration nand_command_handlers[] = { { .name = "nand", .mode = COMMAND_ANY, .help = "NAND flash command group", + .usage = "", .chain = nand_config_command_handlers, }, COMMAND_REGISTRATION_DONE @@ -645,5 +612,3 @@ int nand_register_commands(struct command_context *cmd_ctx) { return register_commands(cmd_ctx, NULL, nand_command_handlers); } - -