FreeCalypso > hg > freecalypso-tools

comparison README @ 434:3ec8ef8b2d37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
top README simplified, source dirs info moved to Source-dirs
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 04 Nov 2018 19:24:46 +0000
parents c7599298998c
children dddcd55883fe
comparison
equal deleted inserted replaced
433:1a35a5cfe602 434:3ec8ef8b2d37
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 See INSTALL for installation instructions. Most of these tools interface to
6 and operate on Calypso-based GSM devices, while a few perform some ancillary
7 functions. Please see doc/Host-tools-overview for the listing of what tools
8 are available and what they do.
6 9
7 Most of these tools interface to and operate on Calypso-based GSM devices, 10 The most commonly needed tool for flashing firmware images (fc-loadtool) and
8 while a few perform some ancillary functions. Please see 11 some of the more rarely needed tools (fc-xram, fc-iram when used with Mot C1xx
9 doc/Host-tools-overview for the listing of what tools are available and what 12 phones, and fc-buzplay) have target-side components, i.e., a part of their
10 they do. These tools are built in the following source directories: 13 functionality is implemented in Calypso ARM7 code pieces which these tools feed
14 to the Calypso chip's boot ROM or to Mot/Compal's bootloader on Mot C1xx phones.
15 The most important of these ARM7 code pieces is loadagent (implements flash
16 reading and writing, hardware peeks and pokes, and the chain loading function
17 for fc-xram) which is needed for all of our supported Calypso targets (it is
18 also common to all of them, no variants), and the second most important piece
19 is compalstage, which is needed for Compal (Mot C1xx) phones only.
11 20
12 ffstools This directory subtree contains tools for "in vitro" analysis 21 If you are working with a packaged release of FC host tools, as opposed to a
13 of flash file system images read out of Calypso GSM devices, 22 random snapshot of the source tree, precompiled binaries for loadagent and
14 as well as for analysis of some specific content from these 23 compalstage will be included in the target-bin directory, otherwise you will
15 file systems. 24 need to build them from source: the source for loadagent and compalstage (plus
25 a few extra target utilities that are of interest only to developers) resides
26 in target-utils, and you will first need to build and install a special ARM7
27 gcc toolchain as explained in the INSTALL document.
16 28
17 loadtools fc-loadtool, fc-iram, fc-xram and fc-compalram form the part of 29 There is a good amount of documentation included in the doc directory, and
18 FC host tools called loadtools, which used to be its own 30 there is more documentation in our dedicated freecalypso-docs repository:
19 package. In common with the rest of FC host tools, loadtools
20 run on a PC or whatever host system, but they also require two
21 target-side components called loadagent (for all targets) and
22 compalstage (for Compal phones only). If you are working with
23 a packaged release of FC host tools, as opposed to a random
24 snapshot of the source tree, precompiled binaries for loadagent
25 and compalstage will be included in the target-bin directory.
26 31
27 fc-buzplay is also built in the loadtools suite because it uses 32 https://bitbucket.org/falconian/freecalypso-docs
28 many of the same components.
29
30 miscutil A few miscellaneous utilities are built here.
31
32 ringtools Tools for working with ringtone melodies are built here.
33
34 rvinterf Everything dealing with the RVTMUX interface to running GSM
35 firmwares and everything based on the rvinterf framework is
36 built under rvinterf.
37
38 The tfc139 utility, which logically belongs with loadtools, is
39 built in the rvinterf subtree because it is built from mostly
40 the same source components as rvtdump and rvinterf.
41
42 uptools The User Phone Tools suite is built here - see
43 doc/User-phone-tools.
44
45 The 6 directories listed above plus the two common libraries librftab and
46 libserial contain all of FC host tools; they are all you need in order to get a
47 fully working installation of these tools if you are using the provided
48 precompiled binaries for loadagent and compalstage. However, if you would like
49 to recompile these components from source, you will need the following
50 additional stuff:
51
52 target-utils The source for loadagent and compalstage lives here, along with
53 a few extra target utilities that are of interest only to
54 developers.
55
56 toolchain Scripts and patches for building the gcc+binutils toolchain
57 targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
58 processor. You'll need to build and install this toolchain
59 first before you can build target-utils.