|
424
|
1 The set of host tools built in this directory consists of:
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
2
|
|
424
|
3 fc-loadtool The tool for operating on Calypso GSM devices at a low
|
|
|
4 level. After "breaking" into the target GSM device in
|
|
|
5 its boot process and getting FreeCalypso loadagent
|
|
|
6 running on the target (out of Calypso internal RAM, aka
|
|
|
7 IRAM), loadtool presents an interactive command prompt
|
|
|
8 with commands for peeking and poking registers and most
|
|
|
9 importantly, reading and writing any part of the
|
|
|
10 device's non-volatile flash memory.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
11
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
12 fc-iram & fc-xram These utilities are intended for FreeCalypso developers
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
13 only. They load an S-record code image into IRAM or
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
14 XRAM, respectively, induce a transfer of control to the
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
15 loaded code, and then drop into a serial line pass-thru
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
16 mode for the operator to interact with the thus loaded
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
17 target code.
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
18
|
|
424
|
19 The currently supported target devices are the Compal family of basic
|
|
|
20 dumbphones, the Openmoko GTA0x GSM modem and the Pirelli DP-L10 feature phone.
|
|
|
21
|
|
|
22 All tools in the FreeCalypso loadtools suite work by feeding pieces of code to
|
|
|
23 the target device as it boots, preventing the booting of its regular firmware
|
|
|
24 and diverting control to these externally-loaded code pieces. These pieces of
|
|
|
25 ARM7 target code need to be installed on the host system running loadtools,
|
|
|
26 normally in /usr/local/share/freecalypso:
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
27
|
|
424
|
28 loadagent This is the "agent" code that runs on the target device when
|
|
|
29 fc-loadtool is operating on it: loadtool carries out its
|
|
|
30 operations by sending commands to loadagent. There is only one
|
|
|
31 version of loadagent for all currently supported Calypso
|
|
|
32 targets: loadagent does not access any resources outside of the
|
|
|
33 Calypso chip itself unless commanded to do so, and loadtool
|
|
|
34 supports different target devices with different hardware
|
|
|
35 configurations by sending different commands to loadagent as
|
|
|
36 appropriate.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
37
|
|
424
|
38 compalstage For Compal phones only: a little piece of code that is fed to
|
|
|
39 the original fw's bootloader via the serial download protocol
|
|
|
40 provided by the latter; it re-enables the Calypso chip boot ROM
|
|
|
41 and jumps to it, allowing our loadagent to be loaded in the
|
|
|
42 same way as on freedom-enabled devices.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
43
|
|
424
|
44 If you are working with a development snapshot of the freecalypso-sw source
|
|
|
45 tree, you will need to compile and install a GNU cross-compiler toolchain
|
|
|
46 targeting ARM7 (see ../toolchain) and then use that toolchain to compile
|
|
|
47 loadagent and compalstage (see ../target-utils) before you can successfully use
|
|
|
48 loadtools to operate on a target device. End-user oriented releases of
|
|
|
49 FreeCalypso host tools will include prebuilt loadagent and compalstage binaries
|
|
|
50 in the target-binaries subdirectory.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
51
|
|
424
|
52 Installing
|
|
|
53 ==========
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
54
|
|
424
|
55 Just run 'make' and 'make install' as usual. If the target-binaries directory
|
|
|
56 is present, your installation will be complete and ready to use. If you are
|
|
|
57 building these pieces yourself from source, do a 'make' and 'make install' in
|
|
|
58 ../target-utils, after you have the ARM7 gcc toolchain installed and working.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
59
|
|
424
|
60 Basic usage
|
|
|
61 ===========
|
|
|
62
|
|
|
63 The steps for bringing up fc-loadtool to operate on a target Calypso device are
|
|
|
64 as follows:
|
|
|
65
|
|
|
66 1. If you are using a USB serial adapter, or operating on a Pirelli phone that
|
|
|
67 has one built in, connect the USB side first so that the necessary
|
|
|
68 /dev/ttyUSB* device node appears.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
69
|
|
424
|
70 2. Run fc-loadtool like this:
|
|
|
71
|
|
|
72 fc-loadtool $TARGETOPT /dev/ttyXXX
|
|
|
73
|
|
|
74 Change /dev/ttyXXX to the actual serial port you are using, and change
|
|
|
75 $TARGETOPT to:
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
76
|
|
424
|
77 Device Needed options
|
|
|
78 -----------------------------------
|
|
|
79 Mot C11x/123 -h compal
|
|
|
80 Mot C139/140 -h compal -c 1003
|
|
|
81 Mot C155/156 -h c155
|
|
|
82 Openmoko GTA02 -h gta02
|
|
|
83 Pirelli DP-L10 -h pirelli
|
|
|
84
|
|
|
85 3. Cause the target device to execute its boot path. Openmoko GTA0x and
|
|
|
86 Pirelli DP-L10 targets have the Calypso boot ROM enabled, and will interrupt
|
|
|
87 and divert their normal boot path when they "hear" the beacons which
|
|
|
88 fc-loadtool will be sending down the serial line. Compal phones have this
|
|
|
89 boot ROM disabled at the board level, but their standard firmware includes a
|
|
|
90 flash-resident bootloader that offers a different way of interrupting the
|
|
|
91 boot path and loading code over the serial line; fc-loadtool will be set up
|
|
|
92 to speak the latter protocol when run with the corresponding options from
|
|
|
93 the table above.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
94
|
|
424
|
95 You will see messages showing fc-loadtool's progress with feeding first
|
|
|
96 compalstage (if needed), then loadagent (always needed) to the target device,
|
|
|
97 followed by some target-specific initialization done via loadagent commands.
|
|
|
98 If all of the above succeeds, you will land at a loadtool> prompt. Type
|
|
|
99 'help', and it will guide you from there. Alternatively, you can familiarize
|
|
|
100 yourself with loadtool commands and operations without actually running it by
|
|
|
101 reading the loadtool.help text file.
|
|
|
102
|
428
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
103 Command line options
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
104 ====================
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
105
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
106 The fc-loadtool command lines shown above will usually be sufficient. However,
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
107 here is the complete command line description for all 3 tools:
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
108
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
109 fc-iram [options] ttyport iramimage.srec
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
110 fc-xram [options] ttyport xramimage.srec [2ndprog]
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
111 fc-loadtool [options] ttyport
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
112
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
113 The available options are common for all 3 utilities, with a few noted
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
114 exceptions:
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
115
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
116 -a /path/to/loadagent
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
117
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
118 This option applies only to fc-loadtool and fc-xram. It specifies the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
119 pathname at which the required loadagent.srec image should be sought,
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
120 overriding the compiled-in default.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
121
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
122 -b baud
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
123
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
124 This option is common for all 3 utilities. It selects the baud rate
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
125 to be used when pushing the IRAM image to the Calypso boot ROM. In the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
126 case of fc-iram, the selected baud rate will be in effect when the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
127 loaded IRAM image is jumped to and fc-iram drops into the serial tty
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
128 pass-thru mode; in the case of fc-loadtool, it will be the initial baud
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
129 rate for communicating with loadagent, which can be switched later with
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
130 the baud command. The default is 115200 baud.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
131
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
132 -B baud
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
133
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
134 This option is specific to fc-xram. It selects the baud rate to be
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
135 used when pushing the XRAM image to loadagent. If no -B option is
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
136 specified, fc-xram will communicate with loadagent at the same baud
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
137 rate that was used to load loadagent itself via the Calypso boot ROM
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
138 download protocol, i.e., the rate selected with -b, defaulting to
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
139 115200 baud if no -b option was given either. Neither -b nor -B
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
140 affects the baud rate that will be in effect when the loaded XRAM image
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
141 is jumped to and fc-xram drops into the serial tty pass-thru mode: that
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
142 baud rate independently defaults to 115200 baud and can only be changed
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
143 with the -r option.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
144
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
145 -c <compalstage flavor>
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
146
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
147 This option is common for all 3 utilities. It directs the tools to
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
148 perform the Compal loading stage before proceeding with the Calypso
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
149 boot ROM serial protocol, and selects the "flavor" of compalstage to
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
150 use. As you can see in the source, compalstage is built in 3 different
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
151 versions, for different C1xx models which exhibit different quirks.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
152
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
153 This option overrides the compal-stage setting given in the hardware
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
154 parameter file selected with -h or -H; the -c or -C option must be given
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
155 after -h or -H in order to take effect. -c none disables the Compal
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
156 stage and causes the tools to proceed directly to the Calypso boot ROM
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
157 phase, even on targets for which the hardware parameter file specifies
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
158 compal-stage.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
159
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
160 -C /path/to/compalstage-binary
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
161
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
162 This option is just like -c, except that the given argument is used
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
163 directly as the compalstage binary file pathname (absolute or relative)
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
164 without checking or alteration.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
165
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
166 -h hwtype
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
167
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
168 This option is common for all 3 utilities. It selects the specific
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
169 target device configuration to be used. More precisely, it constructs
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
170 a pathname of the form /usr/local/share/freecalypso/%s.config, where %s
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
171 is the argument given to this option, and uses that file as the hardware
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
172 parameter file.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
173
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
174 The hardware configurations known to the present release of FreeCalypso
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
175 loadtools are listed in the "Basic usage" section above.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
176
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
177 -H /path/to/hwparam-file
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
178
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
179 This option is just like -h, except that the given argument is used
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
180 directly as the hardware parameter file pathname (absolute or relative)
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
181 without alteration.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
182
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
183 -i num
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
184
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
185 This option is common for all 3 utilities. It specifies the interval
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
186 in milliseconds at which the tool will send "please interrupt the boot
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
187 process" beacons out the serial port, hoping to catch the Calypso
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
188 internal boot ROM. The default is 13 ms.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
189
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
190 -n
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
191
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
192 This option does anything only when loadtools have been compiled to run
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
193 on GTA0x AP (see the corresponding section below). If you've compiled
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
194 loadtools with the -DGTA0x_AP_BUILD option, it has an effect of making
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
195 each tool automatically toggle the modem power control upon startup,
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
196 removing the need for manual sequencing of the Calypso boot process.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
197 This -n option suppresses that action, making the AP build behave like
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
198 the standard build in this regard.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
199
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
200 -r baud (fc-loadtool)
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
201
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
202 This optoin is specific to fc-loadtool. It causes the tool to skip its
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
203 normal steps of feeding loadagent and possibly compalstage to the target
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
204 via special serial protocols, and instead assume that the target is
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
205 already running loadagent, communicating at the specified baud rate.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
206 In other words, reattach to an already running loadagent. Use this
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
207 option if your fc-loadtool session has been terminated ungracefully and
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
208 you would like to reattach and resume, rather than forcibly reset the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
209 target by yanking and reinserting the battery and restart from the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
210 beginning.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
211
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
212 -r baud (fc-xram)
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
213
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
214 This option is specific to fc-xram. It selects the serial line baud
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
215 rate which should be set just before the loaded XRAM image is jumped
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
216 to; the default is 115200 baud.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
217
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
218 fc-xram 2nd program invokation
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
219 ==============================
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
220
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
221 The fc-xram utility can take two possible actions after it has loaded the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
222 specified S-record image into XRAM:
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
223
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
224 * The default action, in the absence of additional command line arguments, is
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
225 to drop into a serial tty pass-thru mode, just like fc-iram.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
226
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
227 * The alternative action is to invoke a 2nd program and pass the serial
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
228 communication channel to it. This 2nd program invokation facility is intended
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
229 primarily for passing the serial communication channel to rvinterf or rvtdump
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
230 from the FreeCalypso software suite, not for launching any arbitrary 3rd-party
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
231 programs from fc-xram.
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
232
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
233 The intended usage scenario is that one builds a version of the FreeCalypso GSM
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
234 firmware (or some subset thereof, such as an "in vivo" FFS editing agent) in the
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
235 ramImage configuration, fc-xram is used to load that ramImage into the target
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
236 device, and then the serial communication channel (RVTMUX) is immediately taken
|
e61eacecd319
loadtools/README: command line etc description brought over and updated
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
237 over by rvinterf or rvtdump.
|
107
8b44e806b6e1
loadtools/README: documentation for loadtools should now be complete
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
diff
changeset
|
238
|
|
424
|
239 Openmoko GTA0x
|
|
|
240 ==============
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
241
|
|
424
|
242 All of the above instructions assume that you are running these loadtools on a
|
|
|
243 general-purpose host system such as a GNU/Linux PC or laptop, and will
|
|
|
244 potentially use them to operate on multiple Calypso targets of different kinds.
|
|
|
245 If instead you are building loadtools to run on the application processor of a
|
|
|
246 smartphone such as Openmoko GTA0x, then it makes no sense for that special build
|
|
|
247 of loadtools to support any target other than the specific modem in that
|
|
|
248 smartphone. Loadtools can be built with compalstage support excluded and with
|
|
|
249 GTA0x-specific modem power control included instead. This build will still
|
|
|
250 include a bunch of functions of no relevance to GTA0x, but oh well..
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
251
|
|
424
|
252 To build loadtools for the GTA0x AP, you'll need to make the following
|
|
|
253 modifications to the Makefile:
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
254
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
255 * Change the CC= line to point to the appropriate cross-compiler (which you'll
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
256 need to provide yourself);
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
257
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
258 * Change the CFLAGS= line: add the right options to target the ARM920T core in
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
259 the GTA0x AP (e.g., -march=armv4t -mtune=arm920t), and add -DGTA0x_AP_BUILD
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
260 to enable some code that makes sense only when running on the GTA0x AP.
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
261
|
|
424
|
262 * Change EXTRA_OBJ= from listing compalload.o to listing compaldummy.o and
|
|
|
263 gtapower.o instead.
|
97
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
264
|
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff
changeset
|
265 See gta-ap-build.sed for an example.
|
