src/flash/nor: usage/help/doc updates
[openocd.git] / src / flash / nor / tcl.c
index d417ca0f6f92e4ba0f69536032b89a866d2b7a5f..65523fbe4bfda55256930a8c4cfb92aa8e2cfb96 100644 (file)
@@ -439,7 +439,7 @@ COMMAND_HANDLER(handle_flash_write_image_command)
 
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               command_print(CMD_CTX, "wrote %" PRIu32 " byte from file %s "
+               command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
                                "in %fs (%0.3f kb/s)", written, CMD_ARGV[0],
                                duration_elapsed(&bench), duration_kbps(&bench, written));
        }
@@ -534,14 +534,16 @@ COMMAND_HANDLER(handle_flash_fill_command)
 
        for (wrote = 0; wrote < (count*wordsize); wrote += cur_size)
        {
-               cur_size = MIN((count*wordsize - wrote), sizeof(chunk));
                struct flash_bank *bank;
+
                bank = get_flash_bank_by_addr(target, address);
                if (bank == NULL)
                {
                        retval = ERROR_FAIL;
                        goto done;
                }
+
+               cur_size = MIN((count * wordsize - wrote), chunksize);
                err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
                if (err != ERROR_OK)
                {
@@ -576,7 +578,7 @@ COMMAND_HANDLER(handle_flash_fill_command)
                                duration_elapsed(&bench), duration_kbps(&bench, wrote));
        }
 
-       done:
+done:
        free(readback);
        free(chunk);
 
@@ -623,9 +625,9 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
 
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               command_print(CMD_CTX, "wrote %zu byte from file %s to flash bank %u"
+               command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
                                " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
-                               fileio.size, CMD_ARGV[1], p->bank_number, offset,
+                               (long)fileio.size, CMD_ARGV[1], p->bank_number, offset,
                                duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
        }
 
@@ -652,89 +654,99 @@ void flash_set_dirty(void)
 static const struct command_registration flash_exec_command_handlers[] = {
        {
                .name = "probe",
-               .handler = &handle_flash_probe_command,
+               .handler = handle_flash_probe_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "identify flash bank",
+               .usage = "bank_id",
+               .help = "Identify a flash bank.",
        },
        {
                .name = "info",
-               .handler = &handle_flash_info_command,
+               .handler = handle_flash_info_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "print bank information",
+               .usage = "bank_id",
+               .help = "Print information about a flash bank.",
        },
        {
                .name = "erase_check",
-               .handler = &handle_flash_erase_check_command,
+               .handler = handle_flash_erase_check_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "check erase state of sectors",
+               .usage = "bank_id",
+               .help = "Check erase state of all blocks in a "
+                       "flash bank.",
        },
        {
                .name = "protect_check",
-               .handler = &handle_flash_protect_check_command,
+               .handler = handle_flash_protect_check_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank>",
-               .help = "check protection state of sectors",
+               .usage = "bank_id",
+               .help = "Check protection state of all blocks in a "
+                       "flash bank.",
        },
        {
                .name = "erase_sector",
-               .handler = &handle_flash_erase_command,
+               .handler = handle_flash_erase_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <first> <last>",
-               .help = "erase sectors",
+               .usage = "bank_id first_sector_num last_sector_num",
+               .help = "Erase a range of sectors in a flash bank.",
        },
        {
                .name = "erase_address",
-               .handler = &handle_flash_erase_address_command,
+               .handler = handle_flash_erase_address_command,
                .mode = COMMAND_EXEC,
-               .usage = "<address> <length>",
-               .help = "erase address range",
-
+               .usage = "address length",
+               .help = "Erase flash blocks starting at address "
+                       "and continuing for length bytes.",
        },
        {
                .name = "fillw",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <word_pattern> <count>",
-               .help = "fill with pattern (no autoerase)",
+               .usage = "address value n",
+               .help = "Fill n words with 32-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "fillh",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <halfword_pattern> <count>",
-               .help = "fill with pattern",
+               .usage = "address value n",
+               .help = "Fill n halfwords with 16-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "fillb",
-               .handler = &handle_flash_fill_command,
+               .handler = handle_flash_fill_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <address> <byte_pattern> <count>",
-               .help = "fill with pattern",
-
+               .usage = "address value n",
+               .help = "Fill n bytes with 8-bit value, starting at "
+                       "word address.  (No autoerase.)",
        },
        {
                .name = "write_bank",
-               .handler = &handle_flash_write_bank_command,
+               .handler = handle_flash_write_bank_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <file> <offset>",
-               .help = "write binary data",
+               .usage = "bank_id filename offset",
+               .help = "Write binary data from file to flash bank, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank.",
        },
        {
                .name = "write_image",
-               .handler = &handle_flash_write_image_command,
+               .handler = handle_flash_write_image_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> [erase] [unlock] <file> [offset] [type]",
-               .help = "write an image to flash"
+               .usage = "[erase] [unlock] filename [offset [file_type]]",
+               .help = "Write an image to flash.  Optionally first unprotect "
+                       "and/or erase the region to be used.  Allow optional "
+                       "offset from beginning of bank (defaults to zero)",
        },
        {
                .name = "protect",
-               .handler = &handle_flash_protect_command,
+               .handler = handle_flash_protect_command,
                .mode = COMMAND_EXEC,
-               .usage = "<bank> <first> <last> <on | off>",
-               .help = "set protection of sectors",
+               .usage = "bank_id first_sector [last_sector|'last'] "
+                       "('on'|'off')",
+               .help = "Turn protection on or off for a range of sectors "
+                       "in a given flash bank.",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -816,14 +828,30 @@ COMMAND_HANDLER(handle_flash_bank_command)
        flash_bank_add(c);
 
        return ERROR_OK;
-
 }
 
+COMMAND_HANDLER(handle_flash_banks_command)
+{
+       if (CMD_ARGC != 0)
+               return ERROR_INVALID_ARGUMENTS;
 
-static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+       unsigned n = 0;
+       for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++)
+       {
+               LOG_USER("#%u: %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
+                       "buswidth %u, chipwidth %u", n,
+                       p->driver->name, p->base, p->size,
+                       p->bus_width, p->chip_width);
+       }
+       return ERROR_OK;
+}
+
+static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
-       if (argc != 1) {
-               Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
+       if (argc != 1)
+       {
+               Jim_WrongNumArgs(interp, 1, argv,
+                               "no arguments to 'flash list' command");
                return JIM_ERR;
        }
 
@@ -875,8 +903,8 @@ static const struct command_registration flash_config_command_handlers[] = {
                .name = "bank",
                .handler = &handle_flash_bank_command,
                .mode = COMMAND_CONFIG,
-               .usage = "<name> <driver> <base> <size> "
-                       "<chip_width> <bus_width> <target> "
+               .usage = "bank_id driver_name base_address size_bytes "
+                       "chip_width_bytes bus_width_bytes target "
                        "[driver_options ...]",
                .help = "Define a new bank with the given name, "
                        "using the specified NOR flash driver.",
@@ -885,13 +913,19 @@ static const struct command_registration flash_config_command_handlers[] = {
                .name = "init",
                .mode = COMMAND_CONFIG,
                .handler = &handle_flash_init_command,
-               .help = "initialize flash devices",
+               .help = "Initialize flash devices.",
        },
        {
                .name = "banks",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_flash_banks,
-               .help = "return information about the flash banks",
+               .handler = &handle_flash_banks_command,
+               .help = "Display table with information about flash banks.",
+       },
+       {
+               .name = "list",
+               .mode = COMMAND_ANY,
+               .jim_handler = &jim_flash_list,
+               .help = "Returns a list of details about the flash banks.",
        },
        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)