FreeCalypso > hg > freecalypso-tools
diff doc/Loadtools-usage @ 236:b5f2ccfdafec
doc/Loadtools-usage: fc-loadtool batch mode documented
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Sun, 20 Aug 2017 17:37:45 +0000 |
parents | 1a658ab756fe |
children | 30f6d1c32c6f |
line wrap: on
line diff
--- a/doc/Loadtools-usage Thu Aug 17 05:27:43 2017 +0000 +++ b/doc/Loadtools-usage Sun Aug 20 17:37:45 2017 +0000 @@ -98,6 +98,20 @@ yourself with loadtool commands and operations without actually running it by reading the loadtool.help text file. +fc-loadtool batch mode +====================== + +In addition to the interactive mode described above, fc-loadtool can be used in +a scripted or batch mode where it makes contact with the target device as it +boots, interrupts and diverts the boot process to loadagent, executes a given +command script, cleans up the target state as appropriate (usually powers off) +and exits. This mode is used by the FreeCalypso factory for initial flash +programming on the device production line, but it can also be used by end users +to install firmware updates in a more automated manner. + +The batch mode is entered when there is a command script given on the +fc-loadtool invokation command line. + Command line options ==================== @@ -106,7 +120,7 @@ fc-iram [options] ttyport iramimage.srec [2ndprog] fc-xram [options] ttyport xramimage.srec [2ndprog] -fc-loadtool [options] ttyport +fc-loadtool [options] ttyport [batch-script] The available options are common for all 3 utilities, with a few noted exceptions: @@ -127,7 +141,14 @@ rate for communicating with loadagent, which can be switched later with the baud command. The default is 115200 baud. --B baud +-B baud (fc-loadtool) + + This option is specific to the batch mode of fc-loadtool, and has no + effect when no batch mode command script is specified on the command + line. In the batch mode this option commands a baud rate switch to be + performed before the command script is executed. + +-B baud (fc-xram) This option is specific to fc-xram. It selects the baud rate to be used when pushing the XRAM image to loadagent. If no -B option is