FreeCalypso > hg > freecalypso-sw

comparison loadtools/README @ 428:e61eacecd319

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
loadtools/README: command line etc description brought over and updated from README.old
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Sat, 21 Jun 2014 17:27:17 +0000
parents 1ec83a5fa8b3
children 5e73df562a7d
comparison
equal deleted inserted replaced
427:7e305184b0b4 428:e61eacecd319
98 If all of the above succeeds, you will land at a loadtool> prompt. Type 98 If all of the above succeeds, you will land at a loadtool> prompt. Type
99 'help', and it will guide you from there. Alternatively, you can familiarize 99 'help', and it will guide you from there. Alternatively, you can familiarize
100 yourself with loadtool commands and operations without actually running it by 100 yourself with loadtool commands and operations without actually running it by
101 reading the loadtool.help text file. 101 reading the loadtool.help text file.
102 102
103 For other fc-loadtool options and fc-[ix]ram usage details, see the slightly 103 Command line options
104 outdated README.old file. For newer options added since that file was written, 104 ====================
105 see the source code. I hope to write some real man pages eventually. 105
106 The fc-loadtool command lines shown above will usually be sufficient. However,
107 here is the complete command line description for all 3 tools:
108
109 fc-iram [options] ttyport iramimage.srec
110 fc-xram [options] ttyport xramimage.srec [2ndprog]
111 fc-loadtool [options] ttyport
112
113 The available options are common for all 3 utilities, with a few noted
114 exceptions:
115
116 -a /path/to/loadagent
117
118 This option applies only to fc-loadtool and fc-xram. It specifies the
119 pathname at which the required loadagent.srec image should be sought,
120 overriding the compiled-in default.
121
122 -b baud
123
124 This option is common for all 3 utilities. It selects the baud rate
125 to be used when pushing the IRAM image to the Calypso boot ROM. In the
126 case of fc-iram, the selected baud rate will be in effect when the
127 loaded IRAM image is jumped to and fc-iram drops into the serial tty
128 pass-thru mode; in the case of fc-loadtool, it will be the initial baud
129 rate for communicating with loadagent, which can be switched later with
130 the baud command. The default is 115200 baud.
131
132 -B baud
133
134 This option is specific to fc-xram. It selects the baud rate to be
135 used when pushing the XRAM image to loadagent. If no -B option is
136 specified, fc-xram will communicate with loadagent at the same baud
137 rate that was used to load loadagent itself via the Calypso boot ROM
138 download protocol, i.e., the rate selected with -b, defaulting to
139 115200 baud if no -b option was given either. Neither -b nor -B
140 affects the baud rate that will be in effect when the loaded XRAM image
141 is jumped to and fc-xram drops into the serial tty pass-thru mode: that
142 baud rate independently defaults to 115200 baud and can only be changed
143 with the -r option.
144
145 -c <compalstage flavor>
146
147 This option is common for all 3 utilities. It directs the tools to
148 perform the Compal loading stage before proceeding with the Calypso
149 boot ROM serial protocol, and selects the "flavor" of compalstage to
150 use. As you can see in the source, compalstage is built in 3 different
151 versions, for different C1xx models which exhibit different quirks.
152
153 This option overrides the compal-stage setting given in the hardware
154 parameter file selected with -h or -H; the -c or -C option must be given
155 after -h or -H in order to take effect. -c none disables the Compal
156 stage and causes the tools to proceed directly to the Calypso boot ROM
157 phase, even on targets for which the hardware parameter file specifies
158 compal-stage.
159
160 -C /path/to/compalstage-binary
161
162 This option is just like -c, except that the given argument is used
163 directly as the compalstage binary file pathname (absolute or relative)
164 without checking or alteration.
165
166 -h hwtype
167
168 This option is common for all 3 utilities. It selects the specific
169 target device configuration to be used. More precisely, it constructs
170 a pathname of the form /usr/local/share/freecalypso/%s.config, where %s
171 is the argument given to this option, and uses that file as the hardware
172 parameter file.
173
174 The hardware configurations known to the present release of FreeCalypso
175 loadtools are listed in the "Basic usage" section above.
176
177 -H /path/to/hwparam-file
178
179 This option is just like -h, except that the given argument is used
180 directly as the hardware parameter file pathname (absolute or relative)
181 without alteration.
182
183 -i num
184
185 This option is common for all 3 utilities. It specifies the interval
186 in milliseconds at which the tool will send "please interrupt the boot
187 process" beacons out the serial port, hoping to catch the Calypso
188 internal boot ROM. The default is 13 ms.
189
190 -n
191
192 This option does anything only when loadtools have been compiled to run
193 on GTA0x AP (see the corresponding section below). If you've compiled
194 loadtools with the -DGTA0x_AP_BUILD option, it has an effect of making
195 each tool automatically toggle the modem power control upon startup,
196 removing the need for manual sequencing of the Calypso boot process.
197 This -n option suppresses that action, making the AP build behave like
198 the standard build in this regard.
199
200 -r baud (fc-loadtool)
201
202 This optoin is specific to fc-loadtool. It causes the tool to skip its
203 normal steps of feeding loadagent and possibly compalstage to the target
204 via special serial protocols, and instead assume that the target is
205 already running loadagent, communicating at the specified baud rate.
206 In other words, reattach to an already running loadagent. Use this
207 option if your fc-loadtool session has been terminated ungracefully and
208 you would like to reattach and resume, rather than forcibly reset the
209 target by yanking and reinserting the battery and restart from the
210 beginning.
211
212 -r baud (fc-xram)
213
214 This option is specific to fc-xram. It selects the serial line baud
215 rate which should be set just before the loaded XRAM image is jumped
216 to; the default is 115200 baud.
217
218 fc-xram 2nd program invokation
219 ==============================
220
221 The fc-xram utility can take two possible actions after it has loaded the
222 specified S-record image into XRAM:
223
224 * The default action, in the absence of additional command line arguments, is
225 to drop into a serial tty pass-thru mode, just like fc-iram.
226
227 * The alternative action is to invoke a 2nd program and pass the serial
228 communication channel to it. This 2nd program invokation facility is intended
229 primarily for passing the serial communication channel to rvinterf or rvtdump
230 from the FreeCalypso software suite, not for launching any arbitrary 3rd-party
231 programs from fc-xram.
232
233 The intended usage scenario is that one builds a version of the FreeCalypso GSM
234 firmware (or some subset thereof, such as an "in vivo" FFS editing agent) in the
235 ramImage configuration, fc-xram is used to load that ramImage into the target
236 device, and then the serial communication channel (RVTMUX) is immediately taken
237 over by rvinterf or rvtdump.
106 238
107 Openmoko GTA0x 239 Openmoko GTA0x
108 ============== 240 ==============
109 241
110 All of the above instructions assume that you are running these loadtools on a 242 All of the above instructions assume that you are running these loadtools on a