flash: nor: rewrite command 'flash list' as COMMAND_HANDLER 86/7486/2
authorAntonio Borneo <borneo.antonio@gmail.com>
Sun, 18 Dec 2022 15:09:02 +0000 (16:09 +0100)
committerAntonio Borneo <borneo.antonio@gmail.com>
Sat, 25 Mar 2023 18:10:02 +0000 (18:10 +0000)
The mixed use of jim commands and OpenOCD commands is error prone
due to handling of errors through JIM_xx and ERROR_yy.

Rewrite the jim command 'flash list' as OpenOCD command.
While there:
- format in a human readable way the output dictionary list, while
  preserving the structure of its TCL data;
- add the mandatory 'usage' field.

Change-Id: I1ee69870d3ab3c1cfc46cd2b8ec03de6b2300bd6
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/7486
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
Tested-by: jenkins
src/flash/nor/tcl.c

index 4ff6d983868f74233235189b2d90efd11c7f9ae5..ecbcf00aaa25b89cd6a97197156c3c0f6eed155b 100644 (file)
@@ -1324,40 +1324,27 @@ COMMAND_HANDLER(handle_flash_banks_command)
        return ERROR_OK;
 }
 
-static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+COMMAND_HANDLER(handle_flash_list)
 {
-       if (argc != 1) {
-               Jim_WrongNumArgs(interp, 1, argv,
-                       "no arguments to 'flash list' command");
-               return JIM_ERR;
-       }
-
-       Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        for (struct flash_bank *p = flash_bank_list(); p; p = p->next) {
-               Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);
-
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->name, -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "driver", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "target", -1));
-               Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, target_name(p->target), -1));
-
-               Jim_ListAppendElement(interp, list, elem);
+               command_print(CMD,
+                       "{\n"
+                       "    name       %s\n"
+                       "    driver     %s\n"
+                       "    base       " TARGET_ADDR_FMT "\n"
+                       "    size       0x%" PRIx32 "\n"
+                       "    bus_width  %u\n"
+                       "    chip_width %u\n"
+                       "    target     %s\n"
+                       "}",
+                       p->name, p->driver->name, p->base, p->size, p->bus_width, p->chip_width,
+                       target_name(p->target));
        }
 
-       Jim_SetResult(interp, list);
-
-       return JIM_OK;
+       return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_flash_init_command)
@@ -1404,8 +1391,9 @@ static const struct command_registration flash_config_command_handlers[] = {
        {
                .name = "list",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_flash_list,
+               .handler = handle_flash_list,
                .help = "Returns a list of details about the flash banks.",
+               .usage = "",
        },
        COMMAND_REGISTRATION_DONE
 };

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)