use COMMAND_REGISTER macro
[fw/openocd] / src / flash / nand.c
index c96354aaaa0b4a70cfa596a7a5792cc67d92b184..2438ddd51d48585b0900c7af7e6c55c2ed8ce540 100644 (file)
@@ -25,6 +25,7 @@
 #endif
 
 #include "nand.h"
+#include "common.h"
 #include "time_support.h"
 #include "fileio.h"
 
@@ -203,91 +204,115 @@ static struct nand_ecclayout nand_oob_64 = {
                 .length = 38}}
 };
 
-/* nand device <nand_controller> [controller options]
- */
-COMMAND_HANDLER(handle_nand_device_command)
+COMMAND_HANDLER(handle_nand_list_drivers)
 {
-       int i;
-       int retval;
+       command_print(CMD_CTX, "Available NAND flash controller drivers:");
+       for (unsigned i = 0; nand_flash_controllers[i]; i++)
+               command_print(CMD_CTX, "  %s", nand_flash_controllers[i]->name);
+       return ERROR_OK;
+}
 
-       if (CMD_ARGC < 1)
+static COMMAND_HELPER(create_nand_device, const char *bank_name,
+               struct nand_flash_controller *controller)
+{
+       int retval = controller->register_commands(CMD_CTX);
+       if (ERROR_OK != retval)
        {
-               LOG_WARNING("incomplete flash device nand configuration");
-               return ERROR_FLASH_BANK_INVALID;
+               LOG_ERROR("couldn't register '%s' commands", controller->name);
+               return retval;
        }
+       struct nand_device *c = malloc(sizeof(struct nand_device));
 
-       for (i = 0; nand_flash_controllers[i]; i++)
-       {
-               struct nand_device *p, *c;
-
-               if (strcmp(CMD_ARGV[0], nand_flash_controllers[i]->name) == 0)
-               {
-                       /* register flash specific commands */
-                       if ((retval = nand_flash_controllers[i]->register_commands(CMD_CTX)) != ERROR_OK)
-                       {
-                               LOG_ERROR("couldn't register '%s' commands", CMD_ARGV[0]);
-                               return retval;
-                       }
-
-                       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;
 
-                       c->controller = nand_flash_controllers[i];
-                       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;
+       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;
+       }
 
-                       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;
-                       }
+       if (nand_devices) {
+               struct nand_device *p = nand_devices;
+               while (p && p->next) p = p->next;
+               p->next = c;
+       } else
+               nand_devices = c;
 
-                       /* put NAND device in linked list */
-                       if (nand_devices)
-                       {
-                               /* find last flash device */
-                               for (p = nand_devices; p && p->next; p = p->next);
-                               if (p)
-                                       p->next = c;
-                       }
-                       else
-                       {
-                               nand_devices = 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;
        }
 
-       /* no valid NAND controller was found (i.e. the configuration option,
-        * didn't match one of the compiled-in controllers)
-        */
-       LOG_ERROR("No valid NAND flash controller found (%s)", CMD_ARGV[0]);
-       LOG_ERROR("compiled-in NAND flash controllers:");
-       for (i = 0; nand_flash_controllers[i]; i++)
+       // save name and increment (for compatibility) with drivers
+       const char *bank_name = *CMD_ARGV++;
+       CMD_ARGC--;
+
+       const char *driver_name = CMD_ARGV[0];
+       for (unsigned i = 0; nand_flash_controllers[i]; i++)
        {
-               LOG_ERROR("%i: %s", i, nand_flash_controllers[i]->name);
+               struct nand_flash_controller *controller = nand_flash_controllers[i];
+               if (strcmp(driver_name, controller->name) != 0)
+                       continue;
+
+               return CALL_COMMAND_HANDLER(create_nand_device,
+                               bank_name, controller);
        }
 
-       return ERROR_OK;
+       LOG_ERROR("No valid NAND flash driver found (%s)", driver_name);
+       return CALL_COMMAND_HANDLER(handle_nand_list_drivers);
 }
 
 int nand_register_commands(struct command_context *cmd_ctx)
 {
-       nand_cmd = register_command(cmd_ctx, NULL, "nand", NULL, COMMAND_ANY, "NAND specific commands");
+       nand_cmd = COMMAND_REGISTER(cmd_ctx, NULL, "nand",
+                       NULL, COMMAND_ANY, "NAND specific commands");
 
-       register_command(cmd_ctx, nand_cmd, "device", handle_nand_device_command, COMMAND_CONFIG, NULL);
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "device",
+                       &handle_nand_device_command, COMMAND_CONFIG,
+                       "defines a new NAND bank");
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "drivers",
+                       &handle_nand_list_drivers, COMMAND_ANY,
+                       "lists available NAND drivers");
 
        return ERROR_OK;
 }
 
+struct nand_device *get_nand_device_by_name(const char *name)
+{
+       unsigned requested = get_flash_name_index(name);
+       unsigned found = 0;
+
+       struct nand_device *nand;
+       for (nand = nand_devices; NULL != nand; nand = nand->next)
+       {
+               if (strcmp(nand->name, name) == 0)
+                       return nand;
+               if (!flash_driver_name_matches(nand->controller->name, name))
+                       continue;
+               if (++found < requested)
+                       continue;
+               return nand;
+       }
+       return NULL;
+}
+
 struct nand_device *get_nand_device_by_num(int num)
 {
        struct nand_device *p;
@@ -304,15 +329,19 @@ struct nand_device *get_nand_device_by_num(int num)
        return NULL;
 }
 
-COMMAND_HELPER(nand_command_get_device_by_num, unsigned name_index,
+COMMAND_HELPER(nand_command_get_device, unsigned name_index,
                struct nand_device **nand)
 {
        const char *str = CMD_ARGV[name_index];
+       *nand = get_nand_device_by_name(str);
+       if (*nand)
+               return ERROR_OK;
+
        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);
+               command_print(CMD_CTX, "NAND flash device '%s' not found", str);
                return ERROR_INVALID_ARGUMENTS;
        }
        return ERROR_OK;
@@ -1078,7 +1107,7 @@ COMMAND_HANDLER(handle_nand_info_command)
        int last = -1;
 
        struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1153,7 +1182,7 @@ COMMAND_HANDLER(handle_nand_probe_command)
        }
 
        struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1182,7 +1211,7 @@ COMMAND_HANDLER(handle_nand_erase_command)
        }
 
        struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1241,7 +1270,7 @@ COMMAND_HANDLER(handle_nand_check_bad_blocks_command)
        }
 
        struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1393,7 +1422,7 @@ static COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct nand_device *nand;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &nand);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &nand);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1406,7 +1435,7 @@ static COMMAND_HELPER(nand_fileio_parse_args, struct nand_fileio_state *state,
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], state->address);
        if (need_size)
        {
-                       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], state->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");
@@ -1591,7 +1620,7 @@ COMMAND_HANDLER(handle_nand_verify_command)
                }
 
                file.size -= bytes_read;
-               file.address += nand->page_size;
+               dev.address += nand->page_size;
        }
 
        if (nand_fileio_finish(&file) == ERROR_OK)
@@ -1652,7 +1681,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
        }
 
        struct nand_device *p;
-       int retval = CALL_COMMAND_HANDLER(nand_command_get_device_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(nand_command_get_device, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1663,14 +1692,7 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
        }
 
        if (CMD_ARGC == 2)
-       {
-               if (strcmp("enable", CMD_ARGV[1]) == 0)
-                       p->use_raw = 1;
-               else if (strcmp("disable", CMD_ARGV[1]) == 0)
-                       p->use_raw = 0;
-               else
-                       return ERROR_COMMAND_SYNTAX_ERROR;
-       }
+               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);
@@ -1683,36 +1705,36 @@ int nand_init(struct command_context *cmd_ctx)
        if (!nand_devices)
                return ERROR_OK;
 
-       register_command(cmd_ctx, nand_cmd, "list",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "list",
                        handle_nand_list_command, COMMAND_EXEC,
                        "list configured NAND flash devices");
-       register_command(cmd_ctx, nand_cmd, "info",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "info",
                        handle_nand_info_command, COMMAND_EXEC,
                        "print info about NAND flash device <num>");
-       register_command(cmd_ctx, nand_cmd, "probe",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "probe",
                        handle_nand_probe_command, COMMAND_EXEC,
                        "identify NAND flash device <num>");
 
-       register_command(cmd_ctx, nand_cmd, "check_bad_blocks",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "check_bad_blocks",
                        handle_nand_check_bad_blocks_command, COMMAND_EXEC,
                        "check NAND flash device <num> for bad blocks [<offset> <length>]");
-       register_command(cmd_ctx, nand_cmd, "erase",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "erase",
                        handle_nand_erase_command, COMMAND_EXEC,
                        "erase blocks on NAND flash device <num> [<offset> <length>]");
-       register_command(cmd_ctx, nand_cmd, "dump",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "dump",
                        handle_nand_dump_command, COMMAND_EXEC,
                        "dump from NAND flash device <num> <filename> "
                         "<offset> <length> [oob_raw | oob_only]");
-       register_command(cmd_ctx, nand_cmd, "verify",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "verify",
                        &handle_nand_verify_command, COMMAND_EXEC,
                        "verify NAND flash device <num> <filename> <offset> "
                        "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]");
-       register_command(cmd_ctx, nand_cmd, "write",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "write",
                        handle_nand_write_command, COMMAND_EXEC,
                        "write to NAND flash device <num> <filename> <offset> "
                        "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]");
 
-       register_command(cmd_ctx, nand_cmd, "raw_access",
+       COMMAND_REGISTER(cmd_ctx, nand_cmd, "raw_access",
                        handle_nand_raw_access_command, COMMAND_EXEC,
                        "raw access to NAND flash device <num> ['enable'|'disable']");