diff 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 3d88461d8284
children c617a6adcb69
line wrap: on
line diff
--- a/README	Tue Jun 10 18:48:21 2014 +0000
+++ b/README	Tue Jun 10 20:07:13 2014 +0000
@@ -1,4 +1,11 @@
-You are looking at the top level of the freecalypso-sw source code tree.
+You are looking at the top level of the freecalypso-sw source code tree.  The
+primary aim of this project is to produce our own full-source GSM firmware that
+would fully operate the TI Calypso-based GSM phones and modems of interest to
+us; this primary subproject is being worked on in the gsm-fw subtree.  While
+that project is progressing very slowly, the associated side projects have
+already produced some useful tools for operating on these GSM devices; see
+README.hosttools for the details.
+
 The subtrees of this source tree are as follows:
 
 gsm-fw		This tree contains the early beginnings of my (Michael
@@ -10,36 +17,20 @@
 		At the present, none of the actual GSM code (L1 or G23) has
 		been integrated yet, but most of the underlying RTOS environment
 		is present and working: one can exercise RVT, ETM and FFS.
-		L1 integration will begin soon.
-
-ffstools	Here you will find tools for "in vitro" examination of FFS
-		(flash file system) images read out of TI-based GSM devices.
-		See doc/TIFFS-Overview for more information.
-
-loadtools	The suite of tools which run on a development host machine
-		(normally PC/Linux desktop or laptop) and communicate with
-		Calypso targets.  Starting from the Calypso ROM bootloader,
-		these tools allow you to peek and poke registers, read and
-		program flash, and load and execute experimental code in IRAM
-		or XRAM.
+		The OSL component of GPF is currently being worked on; L1 will
+		follow afterward.
 
-rvinterf	In common with TI's original fw, FreeCalypso GSM fw implements
-		the so-called RiViera serial MUX, which is a binary packet
-		protocol for multiplexing many kinds of debug and development
-		traffic over just one available physical serial port.  This
-		rvinterf directory contains the early beginnings of our suite
-		of tools for connecting to this RV serial interface, supporting
-		both our own gsm-fw as well as some existing proprietary
-		firmwares to the extent to which they are compatible.
+target-utils	This tree contains code that runs on Calypso targets, but is
+		not regular firmware (gsm-fw) or a part thereof.  The two key
+		components built in this tree are loadagent (needed for all
+		targets) and compalstage (for Compal phones only), which need
+		to be installed on the user's host system in order for
+		loadtools (see README.hosttools) to do their job.
 
-target-utils	These are utilities which run on Calypso targets, but which are
-		independent of Nucleus, of any other RTOS, and of any larger
-		firmware suite, i.e., totally standalone.  The two current
-		utilities are loadagent, which is common for all currently
-		supported Calypso targets and is required in order to use
-		fc-loadtool or fc-xram (see loadtools), and pirexplore - the
-		latter is a hardware exploration utility specific to the
-		Pirelli DP-L10 target.
+ffstools	Tools that run on a Unix or GNU/Linux host; see README.hosttools
+loadtools	for the details.
+miscutil
+rvinterf
 
 toolchain	Scripts and patches for building the gcc+binutils toolchain
 		targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband