comparison doc/Loadtools-usage @ 687:d2e4a2274497

doc/Loadtools-usage: extended batch mode documented
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 11 Mar 2020 00:16:24 +0000
parents 7674abe34c25
children 3713a349fb1e
comparison
equal deleted inserted replaced
686:752aef91cc95 687:d2e4a2274497
117 ====================== 117 ======================
118 118
119 In addition to the interactive mode described above, fc-loadtool can be used in 119 In addition to the interactive mode described above, fc-loadtool can be used in
120 a scripted or batch mode where it makes contact with the target device as it 120 a scripted or batch mode where it makes contact with the target device as it
121 boots, interrupts and diverts the boot process to loadagent, executes a given 121 boots, interrupts and diverts the boot process to loadagent, executes a given
122 command script, cleans up the target state as appropriate (usually powers off) 122 command or script, cleans up the target state as appropriate (usually powers
123 and exits. This mode is used by the FreeCalypso factory for initial flash 123 off) and exits. This mode is used by the FreeCalypso factory for initial flash
124 programming on the device production line, but it can also be used by end users 124 programming on the device production line, but it can also be used by end users
125 to install firmware updates in a more automated manner. 125 to install firmware updates in a more automated manner.
126 126
127 The batch mode is entered when there is a command script given on the 127 To use the batch mode, specify an exec (command script), flash or flash2 command
128 fc-loadtool invokation command line. 128 on the fc-loadtool invokation command line after the target tty port name. For
129 backward compatibility, if only one extra argument (in the UNIX process argument
130 list sense) is given after the target tty port name, it is interpreted as the
131 name of the command script to execute, as if it was preceded by 'exec'. Only
132 flash and flash2 commands can be given directly without going through a script;
133 if you need to run other commands in batch mode, you will need to put them into
134 a script file.
129 135
130 Command line options 136 Command line options
131 ==================== 137 ====================
132 138
133 The fc-loadtool command lines shown above will usually be sufficient. However, 139 The fc-loadtool command lines shown above will usually be sufficient. However,
134 here is the complete command line description for all 3 tools: 140 here is the complete command line description for all 3 tools:
135 141
136 fc-iram [options] ttyport iramimage.srec [2ndprog] 142 fc-iram [options] ttyport iramimage.srec [2ndprog]
137 fc-xram [options] ttyport xramimage.srec [2ndprog] 143 fc-xram [options] ttyport xramimage.srec [2ndprog]
138 fc-loadtool [options] ttyport [batch-script] 144 fc-loadtool [options] ttyport [batch command]
139 145
140 The available options are common for all 3 utilities, with a few noted 146 The available options are common for all 3 utilities, with a few noted
141 exceptions: 147 exceptions:
142 148
143 -a /path/to/loadagent 149 -a /path/to/loadagent