diff options
author | Juergen Beisert <j.beisert@pengutronix.de> | 2007-11-09 14:05:23 +0100 |
---|---|---|
committer | Juergen Beisert <j.beisert@pengutronix.de> | 2007-11-09 14:05:23 +0100 |
commit | 3ff14ef200fc6f69b6237fffabbad796aa463cfb (patch) | |
tree | e6e749f27cbd14641eac77e46e8e52736cb0cc92 /commands/flash.c | |
parent | 8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9 (diff) | |
download | barebox-3ff14ef200fc6f69b6237fffabbad796aa463cfb.tar.gz barebox-3ff14ef200fc6f69b6237fffabbad796aa463cfb.tar.xz |
various doc added
Signed-off-by: Juergen Beisert <j.beisert@pengutronix.de>
Diffstat (limited to 'commands/flash.c')
-rw-r--r-- | commands/flash.c | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/commands/flash.c b/commands/flash.c index 835663c2b6..cfbf903087 100644 --- a/commands/flash.c +++ b/commands/flash.c @@ -23,6 +23,11 @@ * MA 02111-1307 USA */ +/** + * @file + * @brief Flash memory support: erase, protect, unprotect + */ + #include <common.h> #include <command.h> #include <cfi_flash.h> @@ -92,6 +97,18 @@ U_BOOT_CMD_START(erase) U_BOOT_CMD_HELP(cmd_erase_help) U_BOOT_CMD_END +/** @page erase_command erase Erase flash memory + * + * Usage is: erase \<devicee> + * + * Erase the flash memory behind the device. It depends on the device given, + * what area will be erased. If the device represents the whole flash memory + * the whole memory will be erased. If the device represents a partition on + * a main flash memory, only this partition part will be erased. + * + * Refer \b addpart, \b delpart and \b devinfo for partition handling. + */ + static int do_protect (cmd_tbl_t *cmdtp, int argc, char *argv[]) { int fd; @@ -163,3 +180,26 @@ U_BOOT_CMD_START(unprotect) U_BOOT_CMD_HELP(cmd_protect_help) U_BOOT_CMD_END +/** @page protect_command protect Protect a flash memory + * + * Usage is: protect \<devicee> + * + * Protect the flash memory behind the device. It depends on the device given, + * what area will be protected. If the device represents the whole flash memory + * the whole memory will be protected. If the device represents a partition on + * a main flash memory, only this partition part will be protected. + * + * Refer \b addpart, \b delpart and \b devinfo for partition handling. + */ + +/** @page unprotect_command unprotect Unprotect a flash memory + * + * Usage is: unprotect \<devicee> + * + * Unprotect the flash memory behind the device. It depends on the device given, + * what area will be unprotected. If the device represents the whole flash memory + * the whole memory will be unprotected. If the device represents a partition + * on a main flash memory, only this partition part will be unprotected. + * + * Refer \b addpart, \b delpart and \b devinfo for partition handling. + */ |