FreeCalypso > hg > freecalypso-tools

annotate doc/Host-tools-overview @ 388:3d45660f78f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/User-phone-tools article written
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 11 Mar 2018 06:32:00 +0000
parents b84bc65e7f86
children 53b474e7e590
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
1 FreeCalypso host tools suite includes a large number of different tools, many
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
2 of which are quite specialized and rarely needed. The following tools are the
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
3 most essential ones:
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 fc-loadtool This is the tool used to read and write the non-volatile flash
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 memory of supported GSM devices. It can be used to reflash
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 these devices with new firmware (whether pre-existing or new
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 firmwares developed within our project), and to save and restore
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 flash backups. This tool operates on the target device (phone
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 or modem) while its regular firmware is shut down.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
12 fc-iram, Reprogramming the non-volatile flash memory is not the only way
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
13 fc-xram, to run your own code on a Calypso GSM device. If your code is
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
14 fc-compalram small enough to fit entirely into the available RAM on the
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
15 device, and you would like to just run it without flashing it
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
16 permanently, these tools do the job of loading code images into
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
17 different kinds of RAM through different download protocols.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
18 Some phones have large enough RAM to allow a complete functional
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
19 firmware image to be run via fc-xram without flashing.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
20
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
21 rvinterf This program is our engine for communicating with up & running
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
22 TI-based firmwares through the RVTMUX binary packet interface.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
23 It receives and decodes all debug trace and other packets
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
24 emitted by the target fw, and allows the options of printing
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
25 them on the terminal, saving them to a log file, and/or passing
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
26 them to other programs that connect to rvinterf as local socket
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
27 clients. In the other direction those latter client programs
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
28 can send arbitrary command packets to the target fw.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
29
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
30 fc-fsio Going through rvinterf, this tool connects to GSM devices
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
31 running one of the supported firmware versions while the fw is
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
32 running (unlike fc-loadtool which operates on a device while
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
33 its regular fw is shut down) and allows you to manipulate
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
34 (read and write) the device's flash file system. It is thus a
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
35 higher-level tool than fc-loadtool. It is intended primarily
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
36 for working with our own firmwares, but it also works with
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
37 Pirelli's original fw.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 fc-shell FreeCalypso firmwares have a feature of our own invention (not
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 present in any pre-existing ones) to accept AT commands over
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 the RVTMUX interface. It is useful when no second UART is
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 available for a dedicated standard AT command interface.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 fc-shell is the tool that allows you to send AT commands to the
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 firmware in this manner; it also allows a few other kinds of
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
45 asynchronous commands to be sent. It works through rvinterf.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
47 And here is a listing of all other tools in mostly-alphabetical order:
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
49 c139explore This is a run-from-RAM (no flashing) program for Mot C139/140
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
50 phones that exercises their peripheral hardware: LCD, keypad
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
51 backlight, buzzer and vibrator.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52
300
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
53 c1xx-calextr This utility extracts the factory RF calibration values for
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
54 Mot C1xx phones from the records contained in a special sector
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
55 of their flash and converts them to FreeCalypso format, to be
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
56 used when running our own firmware on these phones. See the
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
57 Compal-calibration article for more details.
0cfb2e3aeda4 started documenting c1xx-calextr
Mychaela Falconia <falcon@freecalypso.org>
parents: 244
diff changeset
58
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59 ctracedec GSM firmwares built in TI's Windows environment (official ones
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 as well as our own hacks based on the TCS211 semi-src) have a
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61 "compressed trace" misfeature whereby many of the ASCII strings
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62 in debug trace messages get replaced with numeric indices at
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 build time, and these numeric indices are all that gets emitted
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64 on the RVTMUX serial channel. This numeric trace output can be
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65 turned back into ASCII strings if you have the str2ind.tab file
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66 corresponding to the fw version that emitted the output in
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67 question; this ctracedec utility performs that decoding.
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
69 fc-buzplay This program plays piezoelectic buzzer melodies on an actual
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
70 Calypso device equipped with such a buzzer (Mot C1xx, TI's
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
71 D-Sample board, our planned future HSMBP) by loading a buzplayer
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
72 agent onto the target and feeding melodies to be played to it.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
73
308
6a254cc6a7f3 doc/Host-tools-overview: fc-cal2bin documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 300
diff changeset
74 fc-cal2bin This utility takes an RF table in FreeCalypso ASCII format and
6a254cc6a7f3 doc/Host-tools-overview: fc-cal2bin documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 300
diff changeset
75 converts it to the firmware's native binary format. See the
6a254cc6a7f3 doc/Host-tools-overview: fc-cal2bin documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 300
diff changeset
76 RF_tables article for more details.
6a254cc6a7f3 doc/Host-tools-overview: fc-cal2bin documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 300
diff changeset
77
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
78 fc-cal2text This utility takes a dump of TI's /gsm/rf flash file system
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
79 directory subtree as input (either extracted in vitro with tiffs
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
80 or read out in vivo with fc-fsio) and converts all RF tables
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
81 found therein into a readable ASCII format. See the RF_tables
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
82 article for more details.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
83
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
84 fc-dspapidump This utility uses ETM in synchronous mode (going through
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
85 rvinterf) to read and dump the contents of the DSP API RAM in a
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
86 target Calypso GSM device while the firmware is running.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
88 fc-e1decode This utility decodes a melody in TI's Melody E1 format from the
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
89 the native binary format to our own ASCII-based representation;
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
90 see the Melody_E1 article for more information.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
91
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
92 fc-e1gen This utility compiles an E1 melody from our own ASCII source
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
93 format into binary bits to be loaded into a FreeCalypso phone;
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
94 see the Melody_E1 article for more information.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
95
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
96 fc-fr2tch This hack-utility converts a GSM 06.10 speech sample from the
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
97 de facto standard libgsm format (which can be recorded with
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
98 standard tools like SoX) into an uplink play file that can be
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
99 played with the tch play command in fc-shell; see the
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
100 TCH-bit-access article for more information.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
101
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
102 fc-gsm2vm This utility converts a GSM 06.10 speech sample from the same
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
103 libgsm source format into a voice memo file that can be
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
104 uploaded into the FFS of a FreeCalypso device and played with
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
105 the audio_vm_play_start() API or the AT@VMP command that
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
106 invokes the latter.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
107
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
108 fc-lcdemu We have TI's TCS211 firmware semi-src that includes TI's
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
109 demo/prototype phone UI targeting the 176x220 pixel LCD on TI's
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 D-Sample development kit, but no suitable hardware on which we
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111 could run this fw with this UI and see it in action. We built
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112 a hacked-up version of the fw that emits all raster blits
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
113 intended for the big LCD on the RVTMUX serial interface, and
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 this fc-lcdemu utility is a plug-in for rvinterf that actually
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
115 displays these LCD blits in an X11 window. This program is not
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
116 built by default as it requires libX11 to compile and an X11
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
117 display to run.
0
e7502631a0f9 initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
118
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
119 fc-memdump This tool captures a memory dump from a GSM device whose
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
120 firmware implements one of TI's Test Mode memory read commands,
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
121 either the old TM3 version or the new ETM one. It works with
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
122 FreeCalypso Citrine, with TCS211-based firmwares including
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
123 FreeCalypso Magnetite, with really old TI firmwares which
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
124 predate ETM, and with Mot C1xx original firmwares. It works
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
125 through rvinterf.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
126
310
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
127 fc-readcal This program attempts to read a bunch of RF calibration tables
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
128 out of a running firmware through Test Mode commands: first
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
129 tms 1, then rfpw 7 for each band, then rftr and ttr commands to
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
130 read various tables. The primary intended purpose is extracting
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
131 RF calibration or static configuration data from alien
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
132 firmwares. Please beware that the tms 1 and rfpw 7 commands
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
133 sent by this tool are highly disruptive to normal GSM operation.
c31a9cbf6ee2 doc/Host-tools-overview: fc-readcal documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 308
diff changeset
134
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
135 fc-rgbconv A simple aid for phone UI development that converts RGB color
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
136 values between human-intuitive 8:8:8 format and the 5:6:5 format
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
137 used by the color LCDs in the phones targeted by FreeCalypso.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
138
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
139 fc-serterm This tool is a trivial serial terminal program. Its special
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
140 feature is that any output coming from the serial port that
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
141 isn't printable ASCII is displayed as by cat -v. It is useful
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
142 for talking to serially-interfaced devices that mix ASCII with
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
143 binary in their serial talk.
23
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
144
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
145 fc-tch2fr This hack-utility takes a TCH downlink recording produced with
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
146 the tch record command in fc-shell and converts it to a playable
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
147 libgsm file which will most likely contain some garbage by
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
148 disregarding the non-understood DSP status words; see the
10b71f01f4ff doc/Host-tools-overview updated for the current state of the tools
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
149 TCH-bit-access article for more information.
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
150
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
151 fc-tmsh TI-based GSM firmwares provide a rich set of Test Mode commands
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
152 that can be issued through the RVTMUX (debug trace) serial
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
153 channel, used for L1/RF test functions, production line RF
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
154 calibration, FFS (flash file system) access, audio configuration
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
155 and other miscellany. fc-tmsh is our test mode shell for
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
156 sending these Test Mode commands to targets and displaying
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
157 decoded target responses; it works through rvinterf. fc-tmsh
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
158 supports all Test Mode commands (both TM3 and ETM) implemented
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
159 in our target firmwares except FFS access; use fc-fsio for the
311
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
160 latter. fc-tmsh is fully asynchronous in that the issuance of
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
161 commands to the target and the handling of target responses are
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
162 fully decoupled.
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
163
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
164 fc-tmsync This program reimplements a small subset of fc-tmsh commands in
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
165 a synchronous manner; it was written together with fc-readcal
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
166 for the same purpose of extracting "in vivo" data from alien
b84bc65e7f86 doc/Host-tools-overview: fc-tmsync documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 310
diff changeset
167 firmwares.
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
168
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
169 fc-vm2hex This utility converts the old-fashioned (non-AMR) voice memo
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
170 files read out of FFS into hex strings that can be analyzed by
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
171 a human or further fed to fc-tch2fr.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
172
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
173 imei-luhn A simple utility for computing or verifying the Luhn check
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
174 digit of an IMEI number.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
175
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
176 pirexplore This is a run-from-RAM (no flashing) program for Pirelli DP-L10
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
177 phones that exercises their peripheral hardware, primarily their
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
178 LCD.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
179
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
180 rvtdump This tool produces a human-readable dump of all output emitted
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
181 by a TI-based GSM fw on the RVTMUX binary packet interface. It
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
182 can also log this dump to a file.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
183
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
184 tfc139 This tool breaks into Mot C1xx phones via shellcode injection,
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
185 a method that works despite any bootloader locks, allowing you
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
186 to reflash locked phones with new firmware with fc-loadtool.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
187 The name of the utility is historical: previously it was
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
188 specific to TFC139 phones (C139s sold with TracFone branding),
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
189 but the current version is expected to work with all Mot C1xx
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
190 firmware versions.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
191
244
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
192 tiaud-compile This utility compiles an audio mode configuration table for TI's
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
193 Audio Service from our own ASCII source format into the binary
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
194 format for uploading into FreeCalypso GSM device FFS with
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
195 fc-fsio.
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
196
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
197 tiaud-decomp This utility decodes TI's audio mode configuration files read
244
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
198 out of FFS into our own ASCII format. It is the reverse of the
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
199 operation performed by tiaud-compile.
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
200
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
201 tiaud-mkvol This utility is a companion to tiaud-compile that generates the
97d6d593ffc6 doc/Host-tools-overview: tiaud-compile and tiaud-mkvol documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 216
diff changeset
202 *.vol binary files which need to accompany the main *.cfg ones.
216
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
203
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
204 tiffs, These tools perform "in vitro" analysis of flash file system
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
205 mokoffs, (FFS) images read out of GSM devices with TI-based firmwares.
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
206 pirffs You can list and extract the FFS content captured as a raw
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
207 flash image, and even perform a few "forensic" operations along
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
208 the lines of reading deleted files and seeing the history of
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
209 FFS modifications. tiffs is the main program, whereas mokoffs
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
210 and pirffs are convenience wrappers for the common FFS
7e3e3a958e3f doc/Host-tools-overview: updated and simplified
Mychaela Falconia <falcon@freecalypso.org>
parents: 154
diff changeset
211 configurations from Openmoko and Pirelli.