view README @ 216:7e3e3a958e3f

doc/Host-tools-overview: updated and simplified
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 20 May 2017 12:48:38 +0000
parents 3b009a0a1873
children c7599298998c
line wrap: on
line source

You are looking at the top level of the FreeCalypso host tools package.  All
tools in this package have been written to run on a Unix-based or Unix-like
host system, such as a GNU/Linux PC or laptop, with the expectation that the
user will compile them from the source using her regular system C compiler.
See INSTALL for installation instructions.

Most of these tools interface to and operate on Calypso-based GSM devices,
while a few perform some ancillary functions.  Please see
doc/Host-tools-overview for the listing of what tools are available and what
they do.  These tools are built in the following source directories:

ffstools	This directory subtree contains tools for "in vitro" analysis
		of flash file system images read out of Calypso GSM devices,
		as well as for analysis of some specific content from these
		file systems.

loadtools	fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of
		FC host tools called loadtools, which used to be its own
		package.  In common with the rest of FC host tools, loadtools
		run on a PC or whatever host system, but they also require two
		target-side components called loadagent (for all targets) and
		compalstage (for Compal phones only).  If you are working with
		a packaged release of FC host tools, as opposed to a random
		snapshot of the source tree, precompiled binaries for loadagent
		and compalstage will be included in the target-bin directory.

		fc-buzplay is also built in the loadtools suite because it uses
		many of the same components.

miscutil	A few miscellaneous utilities are built here.

ringtools	Tools for working with ringtone melodies are built here.

rvinterf	Everything dealing with the RVTMUX interface to running GSM
		firmwares and everything based on the rvinterf framework is
		built under rvinterf.

		The tfc139 utility, which logically belongs with loadtools, is
		built in the rvinterf subtree because it is built from mostly
		the same source components as rvtdump and rvinterf.

The 5 directories listed above contain all of FC host tools; they are all you
need in order to get a fully working installation of these tools if you are
using the provided precompiled binaries for loadagent and compalstage.  However,
if you would like to recompile these components from source, you will need the
following additional stuff:

target-utils	The source for loadagent and compalstage lives here, along with
		a few extra target utilities that are of interest only to
		developers.

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 target-utils.