FreeCalypso > hg > freecalypso-sw

comparison loadtools/README @ 228:3275c8881cb7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation update for the loadtools-r2 release
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Sat, 25 Jan 2014 18:16:52 +0000
parents 8b44e806b6e1
children 1ec83a5fa8b3
comparison
equal deleted inserted replaced
227:1852900ce9ea 228:3275c8881cb7
168 168
169 The fc-loadtool command lines shown above will usually be sufficient. However, 169 The fc-loadtool command lines shown above will usually be sufficient. However,
170 here is the complete command line description for all 3 tools: 170 here is the complete command line description for all 3 tools:
171 171
172 fc-iram [options] ttyport iramimage.srec 172 fc-iram [options] ttyport iramimage.srec
173 fc-xram [options] ttyport xramimage.srec [runbaud] 173 fc-xram [options] ttyport xramimage.srec [2ndprog]
174 fc-loadtool [options] ttyport 174 fc-loadtool [options] ttyport
175
176 The last optional argument to fc-xram selects the serial line baud rate which
177 should be set just before the loaded XRAM image is jumped to; the default is
178 115200 baud.
179 175
180 The available options are common for all 3 utilities, with a few noted 176 The available options are common for all 3 utilities, with a few noted
181 exceptions: 177 exceptions:
182 178
183 -a /path/to/loadagent 179 -a /path/to/loadagent
205 download protocol, i.e., the rate selected with -b, defaulting to 201 download protocol, i.e., the rate selected with -b, defaulting to
206 115200 baud if no -b option was given either. Neither -b nor -B 202 115200 baud if no -b option was given either. Neither -b nor -B
207 affects the baud rate that will be in effect when the loaded XRAM image 203 affects the baud rate that will be in effect when the loaded XRAM image
208 is jumped to and fc-xram drops into the serial tty pass-thru mode: that 204 is jumped to and fc-xram drops into the serial tty pass-thru mode: that
209 baud rate independently defaults to 115200 baud and can only be changed 205 baud rate independently defaults to 115200 baud and can only be changed
210 by the last optional argument on the fc-xram command line. 206 with the -r option.
211 207
212 -h hwtype 208 -h hwtype
213 209
214 This option is common for all 3 utilities. It selects the specific 210 This option is common for all 3 utilities. It selects the specific
215 target device configuration to be used. More precisely, it constructs 211 target device configuration to be used. More precisely, it constructs
216 a pathname of the form /usr/local/share/freecalypso/%s.config, where %s 212 a pathname of the form /usr/local/share/freecalypso/%s.config, where %s
217 is the argument given to this option, and uses that file as the hardware 213 is the argument given to this option, and uses that file as the hardware
218 parameters file. 214 parameters file.
219 215
220 The hardware configurations knows to the present release of FreeCalypso 216 The hardware configurations known to the present release of FreeCalypso
221 loadtools are gta02 and pirelli. 217 loadtools are gta02 and pirelli.
222 218
223 -H /path/to/hwparam-file 219 -H /path/to/hwparam-file
224 220
225 This option is just like -h, except that the given argument is used 221 This option is just like -h, except that the given argument is used
240 option, it has an effect of making each tool automatically toggle the 236 option, it has an effect of making each tool automatically toggle the
241 modem power control upon startup, removing the need for manual 237 modem power control upon startup, removing the need for manual
242 sequencing of the Calypso boot process. This -n option suppresses that 238 sequencing of the Calypso boot process. This -n option suppresses that
243 action, making the AP build behave like the standard build in this 239 action, making the AP build behave like the standard build in this
244 regard. 240 regard.
241
242 -r baud
243
244 This option is specific to fc-xram. It selects the serial line baud
245 rate which should be set just before the loaded XRAM image is jumped
246 to; the default is 115200 baud.
247
248 fc-xram 2nd program invokation
249 ==============================
250
251 The fc-xram utility can take two possible actions after it has loaded the
252 specified S-record image into XRAM:
253
254 * The default action, in the absence of additional command line arguments, is
255 to drop into a serial tty pass-thru mode, just like fc-iram.
256
257 * The alternative action is to invoke a 2nd program and pass the serial
258 communication channel to it. This 2nd program invokation facility is intended
259 primarily for passing the serial communication channel to rvinterf or rvtdump
260 from the FreeCalypso software suite, not for launching any arbitrary 3rd-party
261 programs from fc-xram.
262
263 The intended usage scenario is that one builds a version of the FreeCalypso GSM
264 firmware (or some subset thereof, such as an "in vivo" FFS editing agent) in the
265 ramImage configuration, fc-xram is used to load that ramImage into the target
266 device, and then the serial communication channel (RVTMUX) is immediately taken
267 over by rvinterf or rvtdump.
268
269 More detailed usage instructions will be written when the rvinterf tools reach
270 a point of being usable by more than just the original developer; until then,
271 read the source code.