diff doc/Target-boot-control @ 585:d3e2b23ebf1d

doc/Target-boot-control: finished for now
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 03 Feb 2020 05:22:21 +0000
parents deda54106c0e
children f19d12f5756f
line wrap: on
line diff
--- a/doc/Target-boot-control	Mon Feb 03 02:51:44 2020 +0000
+++ b/doc/Target-boot-control	Mon Feb 03 05:22:21 2020 +0000
@@ -102,3 +102,48 @@
 
 fc-loadtool -h fcfam -Puja1 /dev/ttyUSB3
 fc-loadtool -h fcfam -Puja2 /dev/ttyUSB4
+
+Example 2: Openmoko GTA02
+=========================
+
+There is a modem-power-ctrl.sh script provided in the openmoko directory of this
+FC host tools package; if you are going to run fc-loadtool on the application
+processor of your GTA02 smartphone, you should install this script in some
+sensible location such as /usr/local/sbin/modem-power-ctrl.  Then fill in your
+/opt/freecalypso/bootctrl.conf file as follows:
+
+lm	/usr/local/sbin/modem-power-ctrl boot
+
+The name 'lm' stands for "local modem"; you can then run fc-loadtool as follows:
+
+fc-loadtool -h fic -Plm /dev/ttySAC0
+
+Change from the past
+====================
+
+Back in 2013 the predecessor to our current FC host tools package was just
+loadtools, and we had a special configuration for building our loadtools to run
+on the GTA02 AP.  But it worked backwards relative to our current arrangement:
+the current sensible arrangement is that a tool like fc-loadtool run without
+any special options simply operates on the specified serial port without any
+special magic, and if special magic is desired, it needs to be requested
+explicitly with the new -P option; the old loadtools-on-GTA02-AP arrangement
+was the opposite: you needed to specify -n to get "regular" operation, otherwise
+the tools would automatically operate the modem power control.
+
+Now that we support many more different Calypso hardware targets than we even
+knew about in 2013-2014, a cleanup has been long overdue.  The new arrangement
+as of fc-host-tools-r12 cleans up the mess in several ways:
+
+* Our FC host tools package has grown so much that making special code
+  configurations for special environments like the AP of some particular
+  smartphone is no longer scalable; now we just have one standard FC host tools
+  package without platform-specific hacks.
+
+* Openmoko platform was certainly very special to us once, but it is not so
+  special any more - now we just treat it the same as any other.  Our target
+  boot control mechanism has now been generalized from just OM GTA02 to any
+  arbitrary platform with similar needs.
+
+* No more reversal of the standard tool paradigm: we have standard operation by
+  default, magic on request with an option.