diff README @ 0:e7502631a0f9

initial import from freecalypso-sw rev 1033:5ab737ac3ad7
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 11 Jun 2016 00:13:35 +0000
parents
children 10e0f8fdc37c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Jun 11 00:13:35 2016 +0000
@@ -0,0 +1,49 @@
+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.
+
+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	tiffs, mokoffs and pirffs are built here.
+
+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 under
+		loadtools/target-binaries.
+
+lcdemu		fc-lcdemu is built here.
+
+miscutil	fc-rgbconv, fc-serterm and imei-luhn 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.