diff options
author | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-09 08:58:38 -0800 |
---|---|---|
committer | David Brownell <dbrownell@users.sourceforge.net> | 2010-01-09 10:25:03 -0800 |
commit | 1c5c57ec8e3f285cc81d4ad101edccb82b721beb (patch) | |
tree | 155a6af8cff6aa050f047f736529e5963f7ba666 /src/flash/nor/lpc2900.c | |
parent | 70738bd75dbc122e380ff3288542ac4e73700eed (diff) |
src/flash/nor: usage/help/doc updates
Make "usage" messages use the same EBNF as the User's Guide;
no angle brackets. Improve and correct various helptexts.
Don't use "&function"; a function's name is its address.
Remove a couple instances of pointless whitespace; shrink a
few overlong lines; fix some bad indents.
Add TODO list entry re full support for NAND/NOR bank names.
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'src/flash/nor/lpc2900.c')
-rw-r--r-- | src/flash/nor/lpc2900.c | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/src/flash/nor/lpc2900.c b/src/flash/nor/lpc2900.c index 13dd731c..d39b2ddf 100644 --- a/src/flash/nor/lpc2900.c +++ b/src/flash/nor/lpc2900.c @@ -953,43 +953,47 @@ static const struct command_registration lpc2900_exec_command_handlers[] = { .name = "signature", .handler = &lpc2900_handle_signature_command, .mode = COMMAND_EXEC, - .usage = "<bank>", - .help = "print device signature of flash bank", + .usage = "bank_id", + .help = "Calculate and display signature of flash bank.", }, { .name = "read_custom", .handler = &lpc2900_handle_read_custom_command, .mode = COMMAND_EXEC, - .usage = "<bank> <filename>", - .help = "read customer information from index sector to file", + .usage = "bank_id filename", + .help = "Copies 912 bytes of customer information " + "from index sector into file.", }, { .name = "password", .handler = &lpc2900_handle_password_command, .mode = COMMAND_EXEC, - .usage = "<bank> <password>", - .help = "enter password to enable 'dangerous' options", + .usage = "bank_id password", + .help = "Enter fixed password to enable 'dangerous' options.", }, { .name = "write_custom", .handler = &lpc2900_handle_write_custom_command, .mode = COMMAND_EXEC, - .usage = "<bank> <filename> [<type>]", - .help = "write customer info from file to index sector", + .usage = "bank_id filename ('bin'|'ihex'|'elf'|'s19')", + .help = "Copies 912 bytes of customer info from file " + "to index sector.", }, { .name = "secure_sector", .handler = &lpc2900_handle_secure_sector_command, .mode = COMMAND_EXEC, - .usage = "<bank> <first> <last>", - .help = "activate sector security for a range of sectors", + .usage = "bank_id first_sector last_sector", + .help = "Activate sector security for a range of sectors. " + "It will be effective after a power cycle.", }, { .name = "secure_jtag", .handler = &lpc2900_handle_secure_jtag_command, .mode = COMMAND_EXEC, - .usage = "<bank> <level>", - .help = "activate JTAG security", + .usage = "bank_id", + .help = "Disable the JTAG port. " + "It will be effective after a power cycle.", }, COMMAND_REGISTRATION_DONE }; |