FreeCalypso > hg > freecalypso-sw

annotate loadtools/README @ 204:61c7480b3c50

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fc-loadtool: flash idcheck standalone command implemented
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Mon, 23 Dec 2013 08:49:38 +0000
parents 8b44e806b6e1
children 3275c8881cb7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
1 You are looking at the source for the FreeCalypso loadtools package. You may
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
2 have downloaded it either as a separate package or as part of the larger
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
3 freecalypso-sw suite.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
4
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
5 The tools in this package are written to run on some Unix/Linux machine
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
6 (normally a PC/Linux desktop or laptop) that acts as a host for operating on
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
7 Calypso target devices. All of these tools communicate with the Calypso target
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
8 through a serial port; each tool begins its operation by sending special byte
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
9 sequences to this serial port which are designed to interrupt the Calypso
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
10 device boot process in the ROM bootloader.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
11
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
12 Three utilities are currently built as part of FreeCalypso loadtools:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
13
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
14 fc-iram & fc-xram These utilities are intended for FreeCalypso developers
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
15 only. They load an S-record code image into IRAM or
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
16 XRAM, respectively, induce a transfer of control to the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
17 loaded code, and then drop into a serial line pass-thru
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
18 mode for the operator to interact with the thus loaded
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
19 target code.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
20
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
21 fc-loadtool This utility is intended for both developers and end
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
22 users. After establishing communication with the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
23 target, fc-loadtool drops into interactive operation.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
24 Once at the loadtool> prompt, you can peek and poke
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
25 registers, and most importantly, dump (read) and load
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
26 (program) the flash memory of the target device.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
27
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
28 Loadagent
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
29 =========
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
30
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
31 Both fc-loadtool and fc-xram work by first feeding a FreeCalypso-developed
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
32 program called loadagent to the Calypso ROM bootloader; all further operations
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
33 (loading code into XRAM or flash) are done via this loadagent. An S-record
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
34 image of the loadagent program is required for fc-loadtool and fc-xram to work.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
35 That program is in turn built with the ARM7 toolchain.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
36
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
37 If you are working with the full freecalypso-sw suite, you presumably already
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
38 have the proper ARM7 toolchain built and installed. To build loadagent, simply
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
39 run 'make' in the ../target-utils tree.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
40
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
41 If you have downloaded a separately-packaged version of FreeCalypso loadtools,
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
42 the package should have a prebuilt loadagent.srec image included, sparing
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
43 non-developer users the nontrivial hurdle of having to build and install a
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
44 special cross-compilation toolchain. The same loadagent binary is designed to
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
45 work on all supported Calypso targets.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
46
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
47 Building and installing loadtools
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
48 =================================
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
49
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
50 Normally the machine on which you build and install fc-loadtools would be your
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
51 PC/Linux desktop or laptop, the system you would use to program or otherwise
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
52 interact with Calypso phones by way of appropriate USB-to-phone cables. Just
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
53 like loadagent, the host utilities you are going to build and install aren't
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
54 specific to a particular target device; instead you will select the target
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
55 device at run time via a command line option. Hence you can build and install
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
56 the host utilities (usual 'make' and 'make install') without limiting your
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
57 setup to just one target phone type.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
58
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
59 However, if your intended target device is an Openmoko GTA02 (or GTA01)
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
60 smartphone, there is one additional complication: one cannot directly access
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
61 the Calypso part of these phones from the outside without going through the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
62 phone's application processor first. If you would like to use fc-loadtool to
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
63 read or write the GSM flash memory of your GTA0x (load a different firmware
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
64 image, dump the flash file system for backup or examination, restore a previous
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
65 backup etc), there are two ways to do it:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
66
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
67 1. The recommended way for FreeCalypso developers is to get a special serial
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
68 cable (low voltage, as in 3.3V or lower - *NOT* RS-232 levels - please don't
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
69 fry your precious phone!) that would plug into the 2.5mm jack on the left
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
70 side of the phone that is normally intended for a wired headset. This way
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
71 you can use your regular build of fc-loadtool (and fc-iram & fc-xram) on
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
72 your PC/Linux (or other) development host, no need to build anything for
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
73 GTA0x AP, and all communication happens directly between your development
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
74 host and the Calypso part of your target phone - not going through the AP
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
75 at all. You still need working software on the GTA0x AP to do battery
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
76 management, to power the Calypso block on and off, and to enable the headset
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
77 jack "download" path, but it is much less burdensome than having to do the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
78 actual FreeCalypso work from the AP.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
79
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
80 Having the headset jack do double duty as a programming port is actually a
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
81 standard practice in the world of basic (non-smart) cellular phones, and
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
82 furthermore, the pinout used by FIC on the GTA0x phones just happens to be
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
83 exactly the same as that used by Compal/Motorola - hence the same headset jack
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
84 serial cables that are used by OsmocomBB with the latter phones (the famous
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
85 "T191 unlock cable") will also work for connecting from an external host
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
86 directly to the Calypso part of GTA0x phones.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
87
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
88 2. If you are an end user who simply wishes to reflash a different GSM firmware
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
89 image, it can be done from inside the phone (from the AP) without having to
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
90 acquire special hardware (as in the cable described above). However, the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
91 trade-off is that in return for saving on the special hardware, you have to
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
92 do more work on the software. You will have to use a cross-compiler
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
93 targeting the ARM/Linux AP environment (*not* the ARM7 cross-compiler used
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
94 for the GSM firmware itself!) to build fc-loadtools to run on the GTA0x AP.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
95
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
96 Building loadtools for GTA0x AP
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
97 ===============================
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
98
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
99 If you've decided to build loadtools for the GTA0x AP, you'll need to make the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
100 following modifications to the Makefile:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
101
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
102 * Change the CC= line to point to the appropriate cross-compiler (which you'll
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
103 need to provide yourself);
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
104
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
105 * Change the CFLAGS= line: add the right options to target the ARM920T core in
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
106 the GTA0x AP (e.g., -march=armv4t -mtune=arm920t), and add -DGTA0x_AP_BUILD
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
107 to enable some code that makes sense only when running on the GTA0x AP.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
108
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
109 * Change EXTRA_OBJ= to EXTRA_OBJ=gtapower.o, i.e., add gtapower.c (compiling
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
110 into gtapower.o) to the build.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
111
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
112 See gta-ap-build.sed for an example.
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
113
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
114 Running fc-loadtool
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
115 ===================
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
116
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
117 Once you've got loadtools built and installed, you can run fc-loadtool
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
118 as follows:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
119
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
120 To operate on a Pirelli DP-L10 that appears as /dev/ttyUSB0:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
121
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
122 fc-loadtool -h pirelli /dev/ttyUSB0
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
123
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
124 The usb2serial chip inside the phone is bus-powered and will be visible as
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
125 /dev/ttyUSBx whether the phone battery is present or not. There are two ways
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
126 to break into the bootloader:
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
127
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
128 1. Run the fc-loadtool command given above with the USB cable connected, but no
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
129 battery present. Once loadtool says "Sending beacons to <port>", insert the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
130 battery.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
131
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
132 2. Connect the USB cable to a powered-on phone running its original factory
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
133 firmware. (If the phone was off, it will power up and boot in the "charging
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
134 only" mode - it is not possible for a Calypso/Iota phone to be completely
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
135 off when both the battery and the charging voltage are present.) Run
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
136 fc-loadtool as above - it will start sending its beacons, which will be
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
137 ignored by the running fw. Then execute the "power off" operation from the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
138 UI (unlock the keypad, then press and hold the red button). The presence of
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
139 USB VBUS (used as the charging power source on this phone) will turn the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
140 power-off into a reboot, and you'll break into the bootloader.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
141
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
142 To operate on the Calypso block of a GTA02, accessing it from an external
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
143 PC/Linux host via a USB-to-headset-jack serial cable that appears as
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
144 /dev/ttyUSB0:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
145
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
146 fc-loadtool -h gta02 /dev/ttyUSB0
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
147
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
148 Run the above command first, then power on the GSM modem from the AP - or power
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
149 it off, then on if it was on already. The "download" path needs to be enabled
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
150 (controlled from the AP) and fc-loadtool needs to be running on the external
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
151 host when the modem is powered on.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
152
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
153 To operate on the Calypso block of a GTA02, running fc-loadtool from inside the
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
154 phone, i.e., from the AP of the same GTA02:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
155
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
156 fc-loadtool -h gta02 /dev/ttySAC0
107
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
157
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
158 In this last scenario the specially built version of fc-loadtool running on the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
159 AP takes care of manipulating the modem power to induce entry into the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
160 bootloader, thus no extra manual steps are needed.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
161
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
162 See loadtool.help for a detailed description of the functionality and commands
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
163 that are available once loadtool is running and communicating with loadagent on
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
164 the target device.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
165
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
166 Command line options
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
167 ====================
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
168
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
169 The fc-loadtool command lines shown above will usually be sufficient. However,
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
170 here is the complete command line description for all 3 tools:
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
171
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
172 fc-iram [options] ttyport iramimage.srec
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
173 fc-xram [options] ttyport xramimage.srec [runbaud]
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
174 fc-loadtool [options] ttyport
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
175
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
176 The last optional argument to fc-xram selects the serial line baud rate which
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
177 should be set just before the loaded XRAM image is jumped to; the default is
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
178 115200 baud.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
179
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
180 The available options are common for all 3 utilities, with a few noted
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
181 exceptions:
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
182
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
183 -a /path/to/loadagent
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
184
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
185 This option applies only to fc-loadtool and fc-xram. It specifies the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
186 pathname at which the required loadagent.srec image should be sought,
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
187 overriding the compiled-in default.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
188
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
189 -b baud
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
190
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
191 This option is common for all 3 utilities. It selects the baud rate
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
192 to be used when pushing the IRAM image to the Calypso boot ROM. In the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
193 case of fc-iram, the selected baud rate will be in effect when the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
194 loaded IRAM image is jumped to and fc-iram drops into the serial tty
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
195 pass-thru mode; in the case of fc-loadtool, it will be the initial baud
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
196 rate for communicating with loadagent, which can be switched later with
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
197 the baud command. The default is 115200 baud.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
198
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
199 -B baud
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
200
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
201 This option is specific to fc-xram. It selects the baud rate to be
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
202 used when pushing the XRAM image to loadagent. If no -B option is
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
203 specified, fc-xram will communicate with loadagent at the same baud
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
204 rate that was used to load loadagent itself via the Calypso boot ROM
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
205 download protocol, i.e., the rate selected with -b, defaulting to
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
206 115200 baud if no -b option was given either. Neither -b nor -B
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
207 affects the baud rate that will be in effect when the loaded XRAM image
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
208 is jumped to and fc-xram drops into the serial tty pass-thru mode: that
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
209 baud rate independently defaults to 115200 baud and can only be changed
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
210 by the last optional argument on the fc-xram command line.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
211
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
212 -h hwtype
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
213
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
214 This option is common for all 3 utilities. It selects the specific
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
215 target device configuration to be used. More precisely, it constructs
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
216 a pathname of the form /usr/local/share/freecalypso/%s.config, where %s
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
217 is the argument given to this option, and uses that file as the hardware
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
218 parameters file.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
219
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
220 The hardware configurations knows to the present release of FreeCalypso
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
221 loadtools are gta02 and pirelli.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
222
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
223 -H /path/to/hwparam-file
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
224
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
225 This option is just like -h, except that the given argument is used
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
226 directly as the hardware parameter file pathname (absolute or relative)
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
227 without alteration.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
228
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
229 -i num
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
230
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
231 This option is common for all 3 utilities. It specifies the interval
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
232 in milliseconds at which the tool will send "please interrupt the boot
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
233 process" beacons out the serial port, hoping to catch the Calypso
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
234 internal boot ROM. The default is 13 ms.
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
235
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
236 -n
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
237
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
238 This option does anything only when loadtools have been compiled to run
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
239 on GTA0x AP. If you've compiled loadtools with the -DGTA0x_AP_BUILD
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
240 option, it has an effect of making each tool automatically toggle the
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
241 modem power control upon startup, removing the need for manual
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
242 sequencing of the Calypso boot process. This -n option suppresses that
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
243 action, making the AP build behave like the standard build in this
8b44e806b6e1 loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
244 regard.