diff loadtools/README @ 228:3275c8881cb7

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
line wrap: on
line diff
--- a/loadtools/README	Tue Jan 14 02:31:09 2014 +0000
+++ b/loadtools/README	Sat Jan 25 18:16:52 2014 +0000
@@ -170,13 +170,9 @@
 here is the complete command line description for all 3 tools:
 
 fc-iram [options] ttyport iramimage.srec
-fc-xram [options] ttyport xramimage.srec [runbaud]
+fc-xram [options] ttyport xramimage.srec [2ndprog]
 fc-loadtool [options] ttyport
 
-The last optional argument to fc-xram selects the serial line baud rate which
-should be set just before the loaded XRAM image is jumped to; the default is
-115200 baud.
-
 The available options are common for all 3 utilities, with a few noted
 exceptions:
 
@@ -207,7 +203,7 @@
 	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
-	by the last optional argument on the fc-xram command line.
+	with the -r option.
 
 -h hwtype
 
@@ -217,7 +213,7 @@
 	is the argument given to this option, and uses that file as the hardware
 	parameters file.
 
-	The hardware configurations knows to the present release of FreeCalypso
+	The hardware configurations known to the present release of FreeCalypso
 	loadtools are gta02 and pirelli.
 
 -H /path/to/hwparam-file
@@ -242,3 +238,34 @@
 	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
+
+	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.
+
+More detailed usage instructions will be written when the rvinterf tools reach
+a point of being usable by more than just the original developer; until then,
+read the source code.