sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

doc: add documentation for 'dfu' 

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
This commit is contained in:
Robert Schwebel 2010-07-11 13:38:45 +02:00 committed by Sascha Hauer
parent 82b23ea679
commit 916abc68fc
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/commands.dox
View File

@ -10,6 +10,7 @@
@li @subpage crc_command
@li @subpage delpart_command
@li @subpage devinfo_command
@li @subpage dfu_command
@li @subpage edit_command
@li @subpage erase_command
@li @subpage export_command

28
commands/dfu.c
View File

@ -162,16 +162,24 @@ out:
return 1;
}
static const __maybe_unused char cmd_dfu_help[] =
"Usage: dfu [OPTION]... description\n"
"start dfu firmware update\n"
" -m <str> Manufacturer string (barebox)\n"
" -p <str> product string (" CONFIG_BOARDINFO ")\n"
" -V <id> vendor id\n"
" -P <id> product id\n"
"description has the form\n"
"device1(name1)[sr],device2(name2)[sr]\n"
"where s is for save mode and r for read back of firmware\n";
BAREBOX_CMD_HELP_START(dfu)
BAREBOX_CMD_HELP_USAGE("dfu [OPTIONS] <description>\n")
BAREBOX_CMD_HELP_SHORT("Start firmware update with the Device Firmware Update (DFU) protocol.\n")
BAREBOX_CMD_HELP_OPT ("-m <str>", "Manufacturer string (barebox)\n")
BAREBOX_CMD_HELP_OPT ("-p <str>", "product string (" CONFIG_BOARDINFO ")\n")
BAREBOX_CMD_HELP_OPT ("-V <id>", "vendor id\n")
BAREBOX_CMD_HELP_OPT ("-P <id>", "product id\n")
BAREBOX_CMD_HELP_END
/**
* @page dfu_command
\<description> has the following form:
device1(name1)[sr],device2(name2)[sr]
's' means 'safe mode' (download the complete image before flashing) and
'r' that readback of the firmware is allowed.
\todo Add example, how to use dfu from a Linux or Windows host.
*/
BAREBOX_CMD_START(dfu)
.cmd = do_dfu,