FreeCalypso > hg > freecalypso-tools

annotate README @ 412:a5dab452be0d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mokosrec2bin utility imported from the old freecalypso-reveng tree, header comments changed for new understanding and new usage in forward rather than reverse engineering
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 25 Oct 2018 19:23:35 +0000
parents c7599298998c
children 3ec8ef8b2d37
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 You are looking at the top level of the FreeCalypso host tools package. All
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 tools in this package have been written to run on a Unix-based or Unix-like
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 host system, such as a GNU/Linux PC or laptop, with the expectation that the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 user will compile them from the source using her regular system C compiler.
211
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
5 See INSTALL for installation instructions.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 Most of these tools interface to and operate on Calypso-based GSM devices,
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 while a few perform some ancillary functions. Please see
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 doc/Host-tools-overview for the listing of what tools are available and what
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 they do. These tools are built in the following source directories:
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
211
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
12 ffstools This directory subtree contains tools for "in vitro" analysis
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
13 of flash file system images read out of Calypso GSM devices,
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
14 as well as for analysis of some specific content from these
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
15 file systems.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 FC host tools called loadtools, which used to be its own
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 package. In common with the rest of FC host tools, loadtools
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 run on a PC or whatever host system, but they also require two
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 target-side components called loadagent (for all targets) and
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 compalstage (for Compal phones only). If you are working with
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 a packaged release of FC host tools, as opposed to a random
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 snapshot of the source tree, precompiled binaries for loadagent
211
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
25 and compalstage will be included in the target-bin directory.
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
26
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
27 fc-buzplay is also built in the loadtools suite because it uses
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
28 many of the same components.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29
21
10e0f8fdc37c top README: lcdemu hack dropped
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
30 miscutil A few miscellaneous utilities are built here.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31
211
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
32 ringtools Tools for working with ringtone melodies are built here.
3b009a0a1873 README: minor updates
Mychaela Falconia <falcon@freecalypso.org>
parents: 21
diff changeset
33
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 rvinterf Everything dealing with the RVTMUX interface to running GSM
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 firmwares and everything based on the rvinterf framework is
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 built under rvinterf.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 The tfc139 utility, which logically belongs with loadtools, is
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 built in the rvinterf subtree because it is built from mostly
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 the same source components as rvtdump and rvinterf.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41
390
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
42 uptools The User Phone Tools suite is built here - see
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
43 doc/User-phone-tools.
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
44
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
45 The 6 directories listed above plus the two common libraries librftab and
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
46 libserial contain all of FC host tools; they are all you need in order to get a
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
47 fully working installation of these tools if you are using the provided
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
48 precompiled binaries for loadagent and compalstage. However, if you would like
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
49 to recompile these components from source, you will need the following
c7599298998c README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents: 211
diff changeset
50 additional stuff:
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52 target-utils The source for loadagent and compalstage lives here, along with
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 a few extra target utilities that are of interest only to
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 developers.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56 toolchain Scripts and patches for building the gcc+binutils toolchain
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58 processor. You'll need to build and install this toolchain
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 first before you can build target-utils.