comparison README.hosttools @ 969:63ebab69680a

README.hosttools updated in preparation for fc-host-tools release
author Mychaela Falconia <falcon@ivan.Harhan.ORG>
date Sat, 07 Nov 2015 06:17:53 +0000
parents c6e1c813e7f0
children
comparison
equal deleted inserted replaced
968:2d986b8c0e4e 969:63ebab69680a
2 tools in this package have been written to run on a Unix-based or Unix-like 2 tools in this package have been written to run on a Unix-based or Unix-like
3 host system, such as a GNU/Linux PC or laptop, with the expectation that the 3 host system, such as a GNU/Linux PC or laptop, with the expectation that the
4 user will compile them from the source using her regular system C compiler. 4 user will compile them from the source using her regular system C compiler.
5 5
6 Most of these tools interface to and operate on Calypso-based GSM devices, 6 Most of these tools interface to and operate on Calypso-based GSM devices,
7 while a few perform some ancillary functions. The tools collected in the 7 while a few perform some ancillary functions. Please see
8 present package are as follows: 8 doc/Host-tools-overview for the listing of what tools are available and what
9 they do. These tools are built in the following source directories:
9 10
10 ffstools Here you will find tools for "in vitro" examination of FFS 11 ffstools tiffs, mokoffs and pirffs are built here.
11 (flash file system) images read out of TI-based GSM devices.
12 See doc/TIFFS-Overview for more information.
13 12
14 loadtools These tools allow you to load your own code into Calypso GSM 13 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of
15 devices. Using these tools, you can load code into target 14 FC host tools called loadtools, which used to be its own
16 device IRAM or XRAM and run it there, as well as dump and load 15 package. In common with the rest of FC host tools, loadtools
17 flash. The operation of these tools is based on gaining 16 run on a PC or whatever host system, but they also require two
18 control of the target device either through the Calypso on-chip 17 target-side components called loadagent (for all targets) and
19 boot ROM (on freedom-enabled devices), or through the 18 compalstage (for Compal phones only). If you are working with
20 flash-resident boot code on the crippled Compal phones. 19 a packaged release of FC host tools, as opposed to a random
20 snapshot of the source tree, precompiled binaries for loadagent
21 and compalstage will be included under
22 loadtools/target-binaries.
21 23
22 miscutil Two miscellaneous utilities are currently built here: 24 lcdemu fc-lcdemu is built here.
23 fc-serterm, which is a simple binary-safe serial terminal for
24 talking to debug serial ports that mix ASCII with binary, and
25 imei-luhn, whose function should be self-explanatory.
26 25
27 rvinterf In common with TI's original fw, FreeCalypso GSM fw implements 26 miscutil fc-rgbconv, fc-serterm and imei-luhn are built here.
28 the so-called RiViera serial MUX, which is a binary packet 27
29 protocol for multiplexing many kinds of debug and development 28 rvinterf Everything dealing with the RVTMUX interface to running GSM
30 traffic over just one available physical serial port. This 29 firmwares and everything based on the rvinterf framework is
31 rvinterf directory contains our suite of tools for connecting 30 built under rvinterf.
32 to this RV serial interface, supporting both our own gsm-fw as
33 well as some existing proprietary firmwares to the extent to
34 which they are compatible.
35 31
36 The tfc139 utility, which logically belongs with loadtools, is 32 The tfc139 utility, which logically belongs with loadtools, is
37 built in the rvinterf subtree because it is based on the 33 built in the rvinterf subtree because it is built from mostly
38 rvinterf framework. 34 the same source components as rvtdump and rvinterf.
35
36 The 5 directories listed above contain all of FC host tools; they are all you
37 need in order to get a fully working installation of these tools if you are
38 using the provided precompiled binaries for loadagent and compalstage. However,
39 if you would like to recompile these components from source, you will need the
40 following additional stuff:
41
42 target-utils The source for loadagent and compalstage lives here, along with
43 a few extra target utilities that are of interest only to
44 developers.
45
46 toolchain Scripts and patches for building the gcc+binutils toolchain
47 targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
48 processor. You'll need to build and install this toolchain
49 first before you can build target-utils.