annotate README.hosttools @ 1017:759b3cbf46aa

doc/TCH-special-feature: document written
author Mychaela Falconia <falcon@ivan.Harhan.ORG>
date Mon, 21 Mar 2016 06:05:57 +0000
parents 63ebab69680a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
1 You are looking at the top level of the FreeCalypso host tools package. All
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
2 tools in this package have been written to run on a Unix-based or Unix-like
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
3 host system, such as a GNU/Linux PC or laptop, with the expectation that the
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
4 user will compile them from the source using her regular system C compiler.
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
5
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
6 Most of these tools interface to and operate on Calypso-based GSM devices,
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
7 while a few perform some ancillary functions. Please see
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
8 doc/Host-tools-overview for the listing of what tools are available and what
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
9 they do. These tools are built in the following source directories:
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
10
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
11 ffstools tiffs, mokoffs and pirffs are built here.
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
12
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
13 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
14 FC host tools called loadtools, which used to be its own
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
15 package. In common with the rest of FC host tools, loadtools
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
16 run on a PC or whatever host system, but they also require two
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
17 target-side components called loadagent (for all targets) and
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
18 compalstage (for Compal phones only). If you are working with
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
19 a packaged release of FC host tools, as opposed to a random
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
20 snapshot of the source tree, precompiled binaries for loadagent
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
21 and compalstage will be included under
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
22 loadtools/target-binaries.
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
23
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
24 lcdemu fc-lcdemu is built here.
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
25
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
26 miscutil fc-rgbconv, fc-serterm and imei-luhn are built here.
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
27
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
28 rvinterf Everything dealing with the RVTMUX interface to running GSM
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
29 firmwares and everything based on the rvinterf framework is
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
30 built under rvinterf.
385
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
31
1cb7b2b6ce18 Makefile.hosttools and README.hosttools added at the top level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
32 The tfc139 utility, which logically belongs with loadtools, is
969
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
33 built in the rvinterf subtree because it is built from mostly
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
34 the same source components as rvtdump and rvinterf.
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
35
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
36 The 5 directories listed above contain all of FC host tools; they are all you
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
37 need in order to get a fully working installation of these tools if you are
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
38 using the provided precompiled binaries for loadagent and compalstage. However,
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
39 if you would like to recompile these components from source, you will need the
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
40 following additional stuff:
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
41
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
42 target-utils The source for loadagent and compalstage lives here, along with
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
43 a few extra target utilities that are of interest only to
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
44 developers.
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
45
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
46 toolchain Scripts and patches for building the gcc+binutils toolchain
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
47 targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
48 processor. You'll need to build and install this toolchain
63ebab69680a README.hosttools updated in preparation for fc-host-tools release
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 435
diff changeset
49 first before you can build target-utils.