This source repository is a top-level container for all of the main software
and firmware components developed in the FreeCalypso project.
The subtrees of this source tree are as follows:

compal-flash-boot-for-fc
		A patched version of Compal's flash boot code for Mot C11x/12x
		and C139/140 families, modified to work with main fw images from
		FreeCalypso subprojects.  It is compatible with our own gsm-fw
		and with tcs211-c139.

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.

gsm-fw		Our Calypso GSM firmware reconstruction and reintegration
		attempt lives here; see doc/Firmware_Architecture and
		doc/Firmware_Status for more information.

loadtools	These tools allow you to load your own code into Calypso GSM
		devices.  Using these tools, you can load code into target
		device IRAM or XRAM and run it there, as well as dump and load
		flash.  The operation of these tools is based on gaining
		control of the target device either through the Calypso on-chip
		boot ROM (on freedom-enabled devices), or through the
		flash-resident boot code on the crippled Compal phones.

lcdemu		fc-lcdemu is built here.

miscutil	fc-rgbconv, fc-serterm and imei-luhn are built here.

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 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 above) to do their job.

toolchain	Scripts and patches for building the gcc+binutils toolchain
		targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
		processor.  You'll need to build and install this toolchain
		first before you can build gsm-fw or target-utils.

Website and mailing list
========================

Please see our website at www.freecalypso.org for information on:

* The overall FreeCalypso libre phone project, beyond this specific sw/fw
  subproject;

* Our community mailing list and how you can subscribe to it;

* How you can help the human family behind the project with donations and how
  you can accelerate the progress of our project by funding it.