add jim_handler to command_registration
[openocd.git] / src / flash / nand.c
index d812805ab1ed885e2d96f3febb2e99d8ba8dd8f2..1e28ba2697151318a15fb91f4bceaa080d509422 100644 (file)
@@ -63,7 +63,6 @@ static struct nand_flash_controller *nand_flash_controllers[] =
 
 /* configured NAND devices and NAND Flash command handler */
 static struct nand_device *nand_devices = NULL;
-static struct command *nand_cmd;
 
 /*     Chip ID list
  *
@@ -204,89 +203,110 @@ 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)
+{
+       if (NULL != controller->commands)
        {
-               LOG_WARNING("incomplete flash device nand configuration");
-               return ERROR_FLASH_BANK_INVALID;
+               int retval = register_commands(CMD_CTX, NULL,
+                               controller->commands);
+               if (ERROR_OK != retval)
+                       return retval;
        }
+       struct nand_device *c = malloc(sizeof(struct nand_device));
 
-       for (i = 0; nand_flash_controllers[i]; i++)
-       {
-               struct nand_device *p, *c;
+       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;
 
-               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));
+       int retval = CALL_COMMAND_HANDLER(controller->nand_device_command, c);
+       if (ERROR_OK != retval)
+       {
+               LOG_ERROR("'%s' driver rejected nand flash", controller->name);
+               free(c);
+               return ERROR_OK;
+       }
 
-                       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;
+       if (nand_devices) {
+               struct nand_device *p = nand_devices;
+               while (p && p->next) p = p->next;
+               p->next = c;
+       } else
+               nand_devices = c;
 
-                       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)
-                       {
-                               /* 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);
 }
 
+static const struct command_registration nand_config_command_handlers[] = {
+       {
+               .name = "device",
+               .handler = &handle_nand_device_command,
+               .mode = COMMAND_CONFIG,
+               .help = "defines a new NAND bank",
+       },
+       {
+               .name = "drivers",
+               .handler = &handle_nand_list_drivers,
+               .mode = COMMAND_ANY,
+               .help = "lists available NAND drivers",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration nand_command_handlers[] = {
+       {
+               .name = "nand",
+               .mode = COMMAND_ANY,
+               .help = "NAND flash command group",
+               .chain = nand_config_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
 int nand_register_commands(struct command_context *cmd_ctx)
 {
-       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;
+       return register_commands(cmd_ctx, NULL, nand_command_handlers);
 }
 
 struct nand_device *get_nand_device_by_name(const char *name)
@@ -297,6 +317,8 @@ struct nand_device *get_nand_device_by_name(const char *name)
        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)
@@ -322,7 +344,7 @@ 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];
@@ -1100,7 +1122,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;
 
@@ -1175,7 +1197,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;
 
@@ -1204,7 +1226,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;
 
@@ -1263,7 +1285,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;
 
@@ -1415,7 +1437,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;
 
@@ -1613,7 +1635,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)
@@ -1674,7 +1696,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;
 
@@ -1693,43 +1715,80 @@ COMMAND_HANDLER(handle_nand_raw_access_command)
        return ERROR_OK;
 }
 
+static const struct command_registration nand_exec_command_handlers[] = {
+       {
+               .name = "list",
+               .handler = &handle_nand_list_command,
+               .mode = COMMAND_EXEC,
+               .help = "list configured NAND flash devices",
+       },
+       {
+               .name = "info",
+               .handler = &handle_nand_info_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank>",
+               .help = "print info about a NAND flash device",
+       },
+       {
+               .name = "probe",
+               .handler = &handle_nand_probe_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank>",
+               .help = "identify NAND flash device <num>",
+
+       },
+       {
+               .name = "check_bad_blocks",
+               .handler = &handle_nand_check_bad_blocks_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> [<offset> <length>]",
+               .help = "check NAND flash device <num> for bad blocks",
+       },
+       {
+               .name = "erase",
+               .handler = &handle_nand_erase_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> [<offset> <length>]",
+               .help = "erase blocks on NAND flash device",
+       },
+       {
+               .name = "dump",
+               .handler = &handle_nand_dump_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> <length> "
+                       "[oob_raw | oob_only]",
+               .help = "dump from NAND flash device",
+       },
+       {
+               .name = "verify",
+               .handler = &handle_nand_verify_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
+               .help = "verify NAND flash device",
+       },
+       {
+               .name = "write",
+               .handler = &handle_nand_write_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<bank> <filename> <offset> "
+                       "[oob_raw | oob_only | oob_softecc | oob_softecc_kw]",
+               .help = "write to NAND flash device",
+       },
+       {
+               .name = "raw_access",
+               .handler = &handle_nand_raw_access_command,
+               .mode = COMMAND_EXEC,
+               .usage = "<num> ['enable'|'disable']",
+               .help = "raw access to NAND flash device",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
 int nand_init(struct command_context *cmd_ctx)
 {
        if (!nand_devices)
                return ERROR_OK;
-
-       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 <num>");
-       register_command(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",
-                       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",
-                       handle_nand_erase_command, COMMAND_EXEC,
-                       "erase blocks on NAND flash device <num> [<offset> <length>]");
-       register_command(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",
-                       &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",
-                       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",
-                       handle_nand_raw_access_command, COMMAND_EXEC,
-                       "raw access to NAND flash device <num> ['enable'|'disable']");
-
-       return ERROR_OK;
+       struct command *parent = command_find_in_context(cmd_ctx, "nand");
+       return register_commands(cmd_ctx, parent, nand_exec_command_handlers);
 }

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)