diff loadtools/README @ 428:e61eacecd319

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
line wrap: on
line diff
--- a/loadtools/README	Sat Jun 21 08:01:14 2014 +0000
+++ b/loadtools/README	Sat Jun 21 17:27:17 2014 +0000
@@ -100,9 +100,141 @@
 yourself with loadtool commands and operations without actually running it by
 reading the loadtool.help text file.
 
-For other fc-loadtool options and fc-[ix]ram usage details, see the slightly
-outdated README.old file.  For newer options added since that file was written,
-see the source code.  I hope to write some real man pages eventually.
+Command line options
+====================
+
+The fc-loadtool command lines shown above will usually be sufficient.  However,
+here is the complete command line description for all 3 tools:
+
+fc-iram [options] ttyport iramimage.srec
+fc-xram [options] ttyport xramimage.srec [2ndprog]
+fc-loadtool [options] ttyport
+
+The available options are common for all 3 utilities, with a few noted
+exceptions:
+
+-a /path/to/loadagent
+
+	This option applies only to fc-loadtool and fc-xram.  It specifies the
+	pathname at which the required loadagent.srec image should be sought,
+	overriding the compiled-in default.
+
+-b baud
+
+	This option is common for all 3 utilities.  It selects the baud rate
+	to be used when pushing the IRAM image to the Calypso boot ROM.  In the
+	case of fc-iram, the selected baud rate will be in effect when the
+	loaded IRAM image is jumped to and fc-iram drops into the serial tty
+	pass-thru mode; in the case of fc-loadtool, it will be the initial baud
+	rate for communicating with loadagent, which can be switched later with
+	the baud command.  The default is 115200 baud.
+
+-B baud
+
+	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
+	specified, fc-xram will communicate with loadagent at the same baud
+	rate that was used to load loadagent itself via the Calypso boot ROM
+	download protocol, i.e., the rate selected with -b, defaulting to
+	115200 baud if no -b option was given either.  Neither -b nor -B
+	affects the baud rate that will be in effect when the loaded XRAM image
+	is jumped to and fc-xram drops into the serial tty pass-thru mode: that
+	baud rate independently defaults to 115200 baud and can only be changed
+	with the -r option.
+
+-c <compalstage flavor>
+
+	This option is common for all 3 utilities.  It directs the tools to
+	perform the Compal loading stage before proceeding with the Calypso
+	boot ROM serial protocol, and selects the "flavor" of compalstage to
+	use.  As you can see in the source, compalstage is built in 3 different
+	versions, for different C1xx models which exhibit different quirks.
+
+	This option overrides the compal-stage setting given in the hardware
+	parameter file selected with -h or -H; the -c or -C option must be given
+	after -h or -H in order to take effect.  -c none disables the Compal
+	stage and causes the tools to proceed directly to the Calypso boot ROM
+	phase, even on targets for which the hardware parameter file specifies
+	compal-stage.
+
+-C /path/to/compalstage-binary
+
+	This option is just like -c, except that the given argument is used
+	directly as the compalstage binary file pathname (absolute or relative)
+	without checking or alteration.
+
+-h hwtype
+
+	This option is common for all 3 utilities.  It selects the specific
+	target device configuration to be used.  More precisely, it constructs
+	a pathname of the form /usr/local/share/freecalypso/%s.config, where %s
+	is the argument given to this option, and uses that file as the hardware
+	parameter file.
+
+	The hardware configurations known to the present release of FreeCalypso
+	loadtools are listed in the "Basic usage" section above.
+
+-H /path/to/hwparam-file
+
+	This option is just like -h, except that the given argument is used
+	directly as the hardware parameter file pathname (absolute or relative)
+	without alteration.
+
+-i num
+
+	This option is common for all 3 utilities.  It specifies the interval
+	in milliseconds at which the tool will send "please interrupt the boot
+	process" beacons out the serial port, hoping to catch the Calypso
+	internal boot ROM.  The default is 13 ms.
+
+-n
+
+	This option does anything only when loadtools have been compiled to run
+	on GTA0x AP (see the corresponding section below).  If you've compiled
+	loadtools with the -DGTA0x_AP_BUILD option, it has an effect of making
+	each tool automatically toggle the modem power control upon startup,
+	removing the need for manual sequencing of the Calypso boot process.
+	This -n option suppresses that action, making the AP build behave like
+	the standard build in this regard.
+
+-r baud	(fc-loadtool)
+
+	This optoin is specific to fc-loadtool.  It causes the tool to skip its
+	normal steps of feeding loadagent and possibly compalstage to the target
+	via special serial protocols, and instead assume that the target is
+	already running loadagent, communicating at the specified baud rate.
+	In other words, reattach to an already running loadagent.  Use this
+	option if your fc-loadtool session has been terminated ungracefully and
+	you would like to reattach and resume, rather than forcibly reset the
+	target by yanking and reinserting the battery and restart from the
+	beginning.
+
+-r baud	(fc-xram)
+
+	This option is specific to fc-xram.  It selects the serial line baud
+	rate which should be set just before the loaded XRAM image is jumped
+	to; the default is 115200 baud.
+
+fc-xram 2nd program invokation
+==============================
+
+The fc-xram utility can take two possible actions after it has loaded the
+specified S-record image into XRAM:
+
+* The default action, in the absence of additional command line arguments, is
+  to drop into a serial tty pass-thru mode, just like fc-iram.
+
+* The alternative action is to invoke a 2nd program and pass the serial
+  communication channel to it.  This 2nd program invokation facility is intended
+  primarily for passing the serial communication channel to rvinterf or rvtdump
+  from the FreeCalypso software suite, not for launching any arbitrary 3rd-party
+  programs from fc-xram.
+
+The intended usage scenario is that one builds a version of the FreeCalypso GSM
+firmware (or some subset thereof, such as an "in vivo" FFS editing agent) in the
+ramImage configuration, fc-xram is used to load that ramImage into the target
+device, and then the serial communication channel (RVTMUX) is immediately taken
+over by rvinterf or rvtdump.
 
 Openmoko GTA0x
 ==============