FreeCalypso > hg > freecalypso-tools

comparison README @ 211:3b009a0a1873

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README: minor updates
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 19 May 2017 00:31:54 +0000
parents 10e0f8fdc37c
children c7599298998c
comparison
equal deleted inserted replaced
210:071544322478 211:3b009a0a1873
1 You are looking at the top level of the FreeCalypso host tools package. All 1 You are looking at the top level of the FreeCalypso host tools package. All
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 See INSTALL for installation instructions.
5 6
6 Most of these tools interface to and operate on Calypso-based GSM devices, 7 Most of these tools interface to and operate on Calypso-based GSM devices,
7 while a few perform some ancillary functions. Please see 8 while a few perform some ancillary functions. Please see
8 doc/Host-tools-overview for the listing of what tools are available and what 9 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: 10 they do. These tools are built in the following source directories:
10 11
11 ffstools tiffs, mokoffs and pirffs are built here. 12 ffstools This directory subtree contains tools for "in vitro" analysis
13 of flash file system images read out of Calypso GSM devices,
14 as well as for analysis of some specific content from these
15 file systems.
12 16
13 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of 17 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of
14 FC host tools called loadtools, which used to be its own 18 FC host tools called loadtools, which used to be its own
15 package. In common with the rest of FC host tools, loadtools 19 package. In common with the rest of FC host tools, loadtools
16 run on a PC or whatever host system, but they also require two 20 run on a PC or whatever host system, but they also require two
17 target-side components called loadagent (for all targets) and 21 target-side components called loadagent (for all targets) and
18 compalstage (for Compal phones only). If you are working with 22 compalstage (for Compal phones only). If you are working with
19 a packaged release of FC host tools, as opposed to a random 23 a packaged release of FC host tools, as opposed to a random
20 snapshot of the source tree, precompiled binaries for loadagent 24 snapshot of the source tree, precompiled binaries for loadagent
21 and compalstage will be included under 25 and compalstage will be included in the target-bin directory.
22 loadtools/target-binaries. 26
27 fc-buzplay is also built in the loadtools suite because it uses
28 many of the same components.
23 29
24 miscutil A few miscellaneous utilities are built here. 30 miscutil A few miscellaneous utilities are built here.
31
32 ringtools Tools for working with ringtone melodies are built here.
25 33
26 rvinterf Everything dealing with the RVTMUX interface to running GSM 34 rvinterf Everything dealing with the RVTMUX interface to running GSM
27 firmwares and everything based on the rvinterf framework is 35 firmwares and everything based on the rvinterf framework is
28 built under rvinterf. 36 built under rvinterf.
29 37
30 The tfc139 utility, which logically belongs with loadtools, is 38 The tfc139 utility, which logically belongs with loadtools, is
31 built in the rvinterf subtree because it is built from mostly 39 built in the rvinterf subtree because it is built from mostly
32 the same source components as rvtdump and rvinterf. 40 the same source components as rvtdump and rvinterf.
33 41
34 The 4 directories listed above contain all of FC host tools; they are all you 42 The 5 directories listed above contain all of FC host tools; they are all you
35 need in order to get a fully working installation of these tools if you are 43 need in order to get a fully working installation of these tools if you are
36 using the provided precompiled binaries for loadagent and compalstage. However, 44 using the provided precompiled binaries for loadagent and compalstage. However,
37 if you would like to recompile these components from source, you will need the 45 if you would like to recompile these components from source, you will need the
38 following additional stuff: 46 following additional stuff:
39 47