diff target-utils/README @ 387:4391890bacd9

documentation update: top level README and target-utils/README
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Tue, 10 Jun 2014 20:07:13 +0000
parents a2e793f6b8c4
children
line wrap: on
line diff
--- a/target-utils/README	Tue Jun 10 18:48:21 2014 +0000
+++ b/target-utils/README	Tue Jun 10 20:07:13 2014 +0000
@@ -1,16 +1,34 @@
-Two programs are currently buildable in this target-utils tree: loadagent and
-pirexplore.  Loadagent is built to be loaded and run out of the Calypso internal
-(on-chip) RAM, and does not depend on any hardware outside of the Calypso chip
-itself - thus it should run unchanged on all Calypso targets.  It expects to be
-loaded by the Calypso ROM bootloader in the UART download mode, and it reads a
-RAM variable left behind by the ROM code that indicates which UART has been used
-to perform that download - it then uses that same UART to communicate with the
-host, presenting an interactive command prompt.  You can run loadagent "raw" by
-loading loadagent.srec with fc-iram, but normally it is used "behind the scenes"
-by fc-loadtool and fc-xram.
+The following target utilities or code components are currently buildable in
+this target-utils tree:
+
+compalstage	For Compal phones only: a little piece of code that is fed to
+		the original fw's bootloader via the serial download protocol
+		provided by the latter; it re-enables the Calypso chip boot ROM
+		and jumps to it, allowing our loadagent to be loaded in the
+		same way as on freedom-enabled devices.
+
+helloapp	Template/skeleton for building programs like loadagent and
+		pirexplore.
 
-Pirexplore is built in the same manner as loadagent (also runs out of IRAM,
-expects to be loaded with fc-iram, and presents an interactive command prompt
-on the autodetected UART), but it automatically performs some hardware (board
-level) initialization specific to the Pirelli, and offers additional commands
-for exploring the hardware features of this device.
+loadagent	Loadagent is built to be loaded and run out of the Calypso
+		internal (on-chip) RAM, and does not depend on any hardware
+		outside of the Calypso chip itself - thus it should run
+		unchanged on all Calypso targets.  It expects to be loaded by
+		the Calypso ROM bootloader in the UART download mode, and it
+		reads a RAM variable left behind by the ROM code that indicates
+		which UART has been used to perform that download - it then
+		uses that same UART to communicate with the host, presenting an
+		interactive command prompt.  You can run loadagent "raw" by
+		loading loadagent.srec with fc-iram, but normally it is used
+		"behind the scenes" by fc-loadtool and fc-xram.
+
+pirexplore	For Pirelli DP-L10 target only: this program is built in the
+		same manner as loadagent (also runs out of IRAM, expects to be
+		loaded with fc-iram, and presents an interactive command prompt
+		on the autodetected UART), but it automatically performs some
+		hardware (board level) initialization specific to the Pirelli,
+		and offers additional commands for exploring the hardware
+		features of this device.
+
+tf-breakin	Here we build the payload for the tfc139 hack-utility; see
+		../rvinterf/lowlevel/tfc139.c for the ugly details.