FreeCalypso > hg > freecalypso-tools

annotate doc/Loadtools-usage @ 776:fac3176de18d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
simagent: bare Tx implemented
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 12 Mar 2021 23:36:46 +0000
parents 94c57b4d430d
children 81f4b8722206
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 The loadtools subset of FreeCalypso host tools consists of:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 fc-loadtool The tool for operating on Calypso GSM devices at a low
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 level. After "breaking" into the target GSM device in
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 its boot process and getting FreeCalypso loadagent
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 running on the target (out of Calypso internal RAM, aka
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 IRAM), loadtool presents an interactive command prompt
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 with commands for peeking and poking registers and most
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 importantly, reading and writing any part of the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 device's non-volatile flash memory.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 fc-iram & fc-xram These utilities are intended for FreeCalypso developers
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 only. They load an S-record code image into IRAM or
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 XRAM, respectively, induce a transfer of control to the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 loaded code, and then drop into a serial line pass-thru
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 mode for the operator to interact with the thus loaded
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 target code.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
556
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
19 The currently supported target devices are:
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
20
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
21 1) All Calypso devices (preferably with Iota ABB so we can cleanly power off
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
22 after we are done) that have Calypso boot ROM (version 0200 or 0300) enabled
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
23 by nIBOOT strapping on the board. This category includes TI and FreeCalypso
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
24 development boards, several modems (Openmoko GTA01/02, Huawei GTM900, Tango)
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
25 and other devices.
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
26
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
27 2) Motorola C1xx and Sony Ericsson J100 phones made by Compal: these phones do
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
28 NOT have Calypso boot ROM enabled, but they provide a different way of
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
29 gaining serial code download access which is supported by our tools.
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 All tools in the FreeCalypso loadtools suite work by feeding pieces of code to
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 the target device as it boots, preventing the booting of its regular firmware
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 and diverting control to these externally-loaded code pieces. These pieces of
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 ARM7 target code need to be installed on the host system running loadtools,
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 normally in /opt/freecalypso/target-bin:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 loadagent This is the "agent" code that runs on the target device when
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 fc-loadtool is operating on it: loadtool carries out its
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 operations by sending commands to loadagent. There is only one
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 version of loadagent for all currently supported Calypso
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 targets: loadagent does not access any resources outside of the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 Calypso chip itself unless commanded to do so, and loadtool
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 supports different target devices with different hardware
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44 configurations by sending different commands to loadagent as
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 appropriate.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 compalstage For Compal phones only: a little piece of code that is fed to
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
48 the original fw's bootloader via the serial download protocol
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
49 provided by the latter; it re-enables the Calypso chip boot ROM
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
50 and jumps to it, allowing our loadagent to be loaded in the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
51 same way as on freedom-enabled devices.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
52
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
53 If you are working with a development snapshot of the freecalypso-tools source
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
54 tree, you will need to compile and install a GNU cross-compiler toolchain
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
55 targeting ARM7 (see ../toolchain) and then use that toolchain to compile
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
56 loadagent and compalstage (see ../target-utils) before you can successfully use
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
57 loadtools to operate on a target device. End-user oriented releases of
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
58 FreeCalypso host tools include prebuilt loadagent and compalstage binaries.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
59
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
60 Basic usage
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
61 ===========
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
62
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
63 The steps for bringing up fc-loadtool to operate on a target Calypso device are
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
64 as follows:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
65
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
66 1. If you are using a USB serial adapter, or operating on a Pirelli phone that
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
67 has one built in, connect the USB side first so that the necessary
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
68 /dev/ttyUSB* device node appears. If you are working with a target such as
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
69 FCDEV3B or D-Sample on which both Calypso UARTs are equally accessible with
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
70 equal convenience, you can arbitrarily pick either one for fc-loadtool - it
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
71 will work exactly the same through either port.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
72
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
73 2. Run fc-loadtool like this:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
74
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
75 fc-loadtool $TARGETOPT /dev/ttyXXX
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
76
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
77 Change /dev/ttyXXX to the actual serial port you are using, and change
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
78 $TARGETOPT to:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
79
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
80 Device Needed options
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
81 -----------------------------------
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
82 FreeCalypso FCDEV3B -h fcfam
742
94c57b4d430d doc/Loadtools-usage: Tango disclosure
Mychaela Falconia <falcon@freecalypso.org>
parents: 716
diff changeset
83 FreeCalypso Tango -h gen8 (or -h fcfam)
562
e9d3fd3389e6 doc/Loadtools-usage: updated for -h gen8 (GTM900 & Tango)
Mychaela Falconia <falcon@freecalypso.org>
parents: 556
diff changeset
84 Huawei GTM900 -h gen8
742
94c57b4d430d doc/Loadtools-usage: Tango disclosure
Mychaela Falconia <falcon@freecalypso.org>
parents: 716
diff changeset
85 iWOW TR-800 -h gen8
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
86 Mot C11x/123 -h compal
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
87 Mot C139/140 -h compal -c 1004
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
88 Mot C155/156 -h c155
716
3713a349fb1e doc/Loadtools-usage: Mot V17x documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 687
diff changeset
89 Mot V17x -h c155
514
5f66dd6e676b doc/Loadtools-usage: Mot W220 support added
Mychaela Falconia <falcon@freecalypso.org>
parents: 480
diff changeset
90 Mot W220 -h w220
568
a97d96e0fc5c doc: new Loadtool-targets article
Mychaela Falconia <falcon@freecalypso.org>
parents: 562
diff changeset
91 Openmoko GTA01/02 -h fic
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
92 Pirelli DP-L10 -h pirelli
480
09b47223ee1b doc/Loadtools-usage: SE J100 documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 463
diff changeset
93 Sony Ericsson J100 -h compal -c 1004
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
94 TI D-Sample -h dsample
556
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
95 TI Leonardo -h leonardo
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
96
568
a97d96e0fc5c doc: new Loadtool-targets article
Mychaela Falconia <falcon@freecalypso.org>
parents: 562
diff changeset
97 Please refer to the Loadtool-targets article for more information about -h
a97d96e0fc5c doc: new Loadtool-targets article
Mychaela Falconia <falcon@freecalypso.org>
parents: 562
diff changeset
98 targets.
a97d96e0fc5c doc: new Loadtool-targets article
Mychaela Falconia <falcon@freecalypso.org>
parents: 562
diff changeset
99
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
100 3. Cause the target device to execute its boot path. TI/Openmoko/FreeCalypso
556
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
101 and other sensible targets have the Calypso boot ROM enabled, and will
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
102 interrupt and divert their normal boot path when they "hear" the beacons
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
103 which fc-loadtool will be sending down the serial line. Compal phones have
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
104 this boot ROM disabled at the board level, but their standard firmware
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
105 includes a flash-resident bootloader that offers a different way of
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
106 interrupting the boot path and loading code over the serial line;
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
107 fc-loadtool will be set up to speak the latter protocol when run with the
9a53f62c9990 doc/Loadtools-usage: updated for Leonardo and Tango support
Mychaela Falconia <falcon@freecalypso.org>
parents: 537
diff changeset
108 corresponding options from the table above.
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
109
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
110 You will see messages showing fc-loadtool's progress with feeding first
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
111 compalstage (if needed), then loadagent (always needed) to the target device,
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
112 followed by some target-specific initialization done via loadagent commands.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
113 If all of the above succeeds, you will land at a loadtool> prompt. Type
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
114 'help', and it will guide you from there. Alternatively, you can familiarize
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
115 yourself with loadtool commands and operations without actually running it by
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
116 reading the loadtool.help text file.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
117
236
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
118 fc-loadtool batch mode
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
119 ======================
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
120
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
121 In addition to the interactive mode described above, fc-loadtool can be used in
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
122 a scripted or batch mode where it makes contact with the target device as it
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
123 boots, interrupts and diverts the boot process to loadagent, executes a given
687
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
124 command or script, cleans up the target state as appropriate (usually powers
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
125 off) and exits. This mode is used by the FreeCalypso factory for initial flash
236
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
126 programming on the device production line, but it can also be used by end users
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
127 to install firmware updates in a more automated manner.
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
128
687
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
129 To use the batch mode, specify an exec (command script), flash or flash2 command
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
130 on the fc-loadtool invokation command line after the target tty port name. For
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
131 backward compatibility, if only one extra argument (in the UNIX process argument
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
132 list sense) is given after the target tty port name, it is interpreted as the
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
133 name of the command script to execute, as if it was preceded by 'exec'. Only
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
134 flash and flash2 commands can be given directly without going through a script;
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
135 if you need to run other commands in batch mode, you will need to put them into
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
136 a script file.
236
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
137
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
138 Command line options
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
139 ====================
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
140
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
141 The fc-loadtool command lines shown above will usually be sufficient. However,
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
142 here is the complete command line description for all 3 tools:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
143
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
144 fc-iram [options] ttyport iramimage.srec [2ndprog]
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
145 fc-xram [options] ttyport xramimage.srec [2ndprog]
687
d2e4a2274497 doc/Loadtools-usage: extended batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 684
diff changeset
146 fc-loadtool [options] ttyport [batch command]
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
147
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
148 The available options are common for all 3 utilities, with a few noted
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
149 exceptions:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
150
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
151 -a /path/to/loadagent
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
152
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
153 This option applies only to fc-loadtool and fc-xram. It specifies the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
154 pathname at which the required loadagent.srec image should be sought,
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
155 overriding the compiled-in default.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
156
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
157 -b baud
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
158
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
159 This option is common for all 3 utilities. It selects the baud rate
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
160 to be used when pushing the IRAM image to the Calypso boot ROM. In the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
161 case of fc-iram, the selected baud rate will be in effect when the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
162 loaded IRAM image is jumped to and fc-iram drops into the serial tty
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
163 pass-thru mode; in the case of fc-loadtool, it will be the initial baud
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
164 rate for communicating with loadagent, which can be switched later with
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
165 the baud command. The default is 115200 baud.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
166
236
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
167 -B baud (fc-loadtool)
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
168
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
169 This option is specific to the batch mode of fc-loadtool, and has no
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
170 effect when no batch mode command script is specified on the command
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
171 line. In the batch mode this option commands a baud rate switch to be
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
172 performed before the command script is executed.
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
173
b5f2ccfdafec doc/Loadtools-usage: fc-loadtool batch mode documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 215
diff changeset
174 -B baud (fc-xram)
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
175
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
176 This option is specific to fc-xram. It selects the baud rate to be
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
177 used when pushing the XRAM image to loadagent. If no -B option is
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
178 specified, fc-xram will communicate with loadagent at the same baud
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
179 rate that was used to load loadagent itself via the Calypso boot ROM
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
180 download protocol, i.e., the rate selected with -b, defaulting to
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
181 115200 baud if no -b option was given either. Neither -b nor -B
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
182 affects the baud rate that will be in effect when the loaded XRAM image
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
183 is jumped to and fc-xram drops into the serial tty pass-thru mode: that
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
184 baud rate independently defaults to 115200 baud and can only be changed
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
185 with the -r option.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
186
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
187 -c <compalstage flavor>
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
188
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
189 This option is common for all 3 utilities. It directs the tools to
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
190 perform the Compal loading stage before proceeding with the Calypso
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
191 boot ROM serial protocol, and selects the "flavor" of compalstage to
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
192 use. As you can see in the source, compalstage is built in 3 different
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
193 versions, for different C1xx models which exhibit different quirks.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
194
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
195 This option overrides the compal-stage setting given in the hardware
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
196 parameter file selected with -h or -H; the -c or -C option must be given
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
197 after -h or -H in order to take effect. -c none disables the Compal
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
198 stage and causes the tools to proceed directly to the Calypso boot ROM
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
199 phase, even on targets for which the hardware parameter file specifies
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
200 compal-stage.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
201
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
202 -C /path/to/compalstage-binary
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
203
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
204 This option is just like -c, except that the given argument is used
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
205 directly as the compalstage binary file pathname (absolute or relative)
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
206 without checking or alteration.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
207
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
208 -h hwtype
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
210 This option is common for all 3 utilities. It selects the specific
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
211 target device configuration to be used. More precisely, it constructs
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
212 a pathname of the form /opt/freecalypso/loadtools/%s.config, where %s
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
213 is the argument given to this option, and uses that file as the hardware
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
214 parameter file.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
215
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
216 The hardware configurations known to the present release of FreeCalypso
568
a97d96e0fc5c doc: new Loadtool-targets article
Mychaela Falconia <falcon@freecalypso.org>
parents: 562
diff changeset
217 loadtools are listed in the Loadtool-targets article.
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
218
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
219 -H /path/to/hwparam-file
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
220
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
221 This option is just like -h, except that the given argument is used
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
222 directly as the hardware parameter file pathname (absolute or relative)
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
223 without alteration.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
224
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
225 -i num
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
226
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
227 This option is common for all 3 utilities. It specifies the interval
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
228 in milliseconds at which the tool will send "please interrupt the boot
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
229 process" beacons out the serial port, hoping to catch the Calypso
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
230 internal boot ROM. The default is 13 ms.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
231
537
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
232 -j
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
233
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
234 This option is specific to fc-xram; it selects the special JTAG mode.
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
235 In this mode the jump command to start executing the loaded image is
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
236 skipped and the target is left in loadagent, allowing the developer to
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
237 connect via JTAG, halt the ARM7 core, set whatever breakpoints or
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
238 watchpoints are needed and resume at the image start address.
018488f6343b doc/Loadtools-usage: new fc-xram -j option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 524
diff changeset
239
586
f3af56eac3f4 doc/Loadtools-usage: -P option instead of -n
Mychaela Falconia <falcon@freecalypso.org>
parents: 568
diff changeset
240 -P <boot control name>
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
241
586
f3af56eac3f4 doc/Loadtools-usage: -P option instead of -n
Mychaela Falconia <falcon@freecalypso.org>
parents: 568
diff changeset
242 This option is common for all utilities in the loadtools suite; it
f3af56eac3f4 doc/Loadtools-usage: -P option instead of -n
Mychaela Falconia <falcon@freecalypso.org>
parents: 568
diff changeset
243 tells the tools to perform target boot control as described in the
f3af56eac3f4 doc/Loadtools-usage: -P option instead of -n
Mychaela Falconia <falcon@freecalypso.org>
parents: 568
diff changeset
244 Target-boot-control article.
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
245
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
246 -r baud (fc-loadtool)
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
247
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
248 This option is specific to fc-loadtool. It causes the tool to skip its
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
249 normal steps of feeding loadagent and possibly compalstage to the target
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
250 via special serial protocols, and instead assume that the target is
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
251 already running loadagent, communicating at the specified baud rate.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
252 In other words, reattach to an already running loadagent. Use this
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
253 option if your fc-loadtool session has been terminated ungracefully and
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
254 you would like to reattach and resume, rather than forcibly reset the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
255 target by yanking and reinserting the battery and restart from the
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
256 beginning.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
257
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
258 -r baud (fc-xram)
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
259
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
260 This option is specific to fc-xram. It selects the serial line baud
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
261 rate which should be set just before the loaded XRAM image is jumped
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
262 to; the default is 115200 baud.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
263
684
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
264 -t num
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
265
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
266 This option is common for all utilities in the loadtools suite; it sets
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
267 the timeout to be applied to the wait for the Calypso boot ROM response.
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
268 Normally the tools wait forever for the Calypso boot ROM to respond to
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
269 the interrupt-boot beacons that are being sent continuously at the
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
270 interval set with -i; this -t option sets a timeout in ms instead.
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
271 This option is intended for automated (unattended) environments where
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
272 it is used together with some kind of target boot control, either -P or
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
273 external.
7674abe34c25 doc/Loadtools-usage: -t option documented
Mychaela Falconia <falcon@freecalypso.org>
parents: 586
diff changeset
274
209
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
275 fc-iram & fc-xram 2nd program invokation
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
276 ========================================
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
277
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
278 Our fc-iram and fc-xram utilities can take two possible actions after they have
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
279 loaded the specified S-record image into RAM:
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
280
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
281 * The default action, in the absence of additional command line arguments, is
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
282 to drop into a serial tty pass-thru mode.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
283
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
284 * The alternative action is to invoke a 2nd program and pass the serial
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
285 communication channel to it. This 2nd program invokation facility is intended
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
286 primarily for passing the serial communication channel to rvinterf or rvtdump
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
287 from the FreeCalypso host tools suite, not for launching any arbitrary
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
288 3rd-party programs from fc-xram or fc-iram.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
289
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
290 This feature was originally implemented in fc-xram only, and the intended usage
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
291 scenario is that one builds a version of one of our FreeCalypso GSM firmwares
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
292 (or some subset thereof, such as an "in vivo" FFS editing agent) in the ramImage
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
293 configuration, fc-xram is used to load that ramImage into the target device,
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
294 and then the serial communication channel (RVTMUX) is immediately taken over by
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
295 rvinterf or rvtdump.
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
296
5433349a6e2c doc/Loadtools-usage: replacing loadtools/README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
297 This second program invokation capability was later extended to fc-iram for no
416
30f6d1c32c6f doc/Flash-boot-defect article removed (no longer relevant)
Mychaela Falconia <falcon@freecalypso.org>
parents: 236
diff changeset
298 purpose other than to facilitate a boot hack that was only needed on one (1)
463
131eefcbe4d7 doc/Loadtools-usage: refer to Flash-boot-wa article when explaining
Mychaela Falconia <falcon@freecalypso.org>
parents: 416
diff changeset
299 defective FCDEV3B board - see the Flash-boot-wa article.