# HG changeset patch # User Mychaela Falconia # Date 1446877073 0 # Node ID 63ebab69680a41f50a54ee01b52a981afe1fd01e # Parent 2d986b8c0e4e146660cb3a6c8eda42a4539443ba README.hosttools updated in preparation for fc-host-tools release diff -r 2d986b8c0e4e -r 63ebab69680a README.hosttools --- a/README.hosttools Sat Nov 07 04:53:24 2015 +0000 +++ b/README.hosttools Sat Nov 07 06:17:53 2015 +0000 @@ -4,35 +4,46 @@ 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. The tools collected in the -present package are as follows: +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 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. +ffstools tiffs, mokoffs and pirffs are built here. -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. +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. -miscutil Two miscellaneous utilities are currently built here: - fc-serterm, which is a simple binary-safe serial terminal for - talking to debug serial ports that mix ASCII with binary, and - imei-luhn, whose function should be self-explanatory. +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. +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 based on the - rvinterf framework. + 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.