FreeCalypso > hg > freecalypso-tools

comparison doc/Loadtools-usage @ 236:b5f2ccfdafec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
235:15a2a308fb31 236:b5f2ccfdafec
96 If all of the above succeeds, you will land at a loadtool> prompt. Type 96 If all of the above succeeds, you will land at a loadtool> prompt. Type
97 'help', and it will guide you from there. Alternatively, you can familiarize 97 'help', and it will guide you from there. Alternatively, you can familiarize
98 yourself with loadtool commands and operations without actually running it by 98 yourself with loadtool commands and operations without actually running it by
99 reading the loadtool.help text file. 99 reading the loadtool.help text file.
100 100
101 fc-loadtool batch mode
102 ======================
103
104 In addition to the interactive mode described above, fc-loadtool can be used in
105 a scripted or batch mode where it makes contact with the target device as it
106 boots, interrupts and diverts the boot process to loadagent, executes a given
107 command script, cleans up the target state as appropriate (usually powers off)
108 and exits. This mode is used by the FreeCalypso factory for initial flash
109 programming on the device production line, but it can also be used by end users
110 to install firmware updates in a more automated manner.
111
112 The batch mode is entered when there is a command script given on the
113 fc-loadtool invokation command line.
114
101 Command line options 115 Command line options
102 ==================== 116 ====================
103 117
104 The fc-loadtool command lines shown above will usually be sufficient. However, 118 The fc-loadtool command lines shown above will usually be sufficient. However,
105 here is the complete command line description for all 3 tools: 119 here is the complete command line description for all 3 tools:
106 120
107 fc-iram [options] ttyport iramimage.srec [2ndprog] 121 fc-iram [options] ttyport iramimage.srec [2ndprog]
108 fc-xram [options] ttyport xramimage.srec [2ndprog] 122 fc-xram [options] ttyport xramimage.srec [2ndprog]
109 fc-loadtool [options] ttyport 123 fc-loadtool [options] ttyport [batch-script]
110 124
111 The available options are common for all 3 utilities, with a few noted 125 The available options are common for all 3 utilities, with a few noted
112 exceptions: 126 exceptions:
113 127
114 -a /path/to/loadagent 128 -a /path/to/loadagent
125 loaded IRAM image is jumped to and fc-iram drops into the serial tty 139 loaded IRAM image is jumped to and fc-iram drops into the serial tty
126 pass-thru mode; in the case of fc-loadtool, it will be the initial baud 140 pass-thru mode; in the case of fc-loadtool, it will be the initial baud
127 rate for communicating with loadagent, which can be switched later with 141 rate for communicating with loadagent, which can be switched later with
128 the baud command. The default is 115200 baud. 142 the baud command. The default is 115200 baud.
129 143
130 -B baud 144 -B baud (fc-loadtool)
145
146 This option is specific to the batch mode of fc-loadtool, and has no
147 effect when no batch mode command script is specified on the command
148 line. In the batch mode this option commands a baud rate switch to be
149 performed before the command script is executed.
150
151 -B baud (fc-xram)
131 152
132 This option is specific to fc-xram. It selects the baud rate to be 153 This option is specific to fc-xram. It selects the baud rate to be
133 used when pushing the XRAM image to loadagent. If no -B option is 154 used when pushing the XRAM image to loadagent. If no -B option is
134 specified, fc-xram will communicate with loadagent at the same baud 155 specified, fc-xram will communicate with loadagent at the same baud
135 rate that was used to load loadagent itself via the Calypso boot ROM 156 rate that was used to load loadagent itself via the Calypso boot ROM