FreeCalypso > hg > freecalypso-tools
annotate README @ 1012:11391cb6bdc0
patch from fixeria: doc change from SE K2x0 to K2xx
Since their discovery in late 2022, Sony Ericsson K200 and K220 phones
were collectively referred to as SE K2x0 in FreeCalypso documentation.
However, now that SE K205 has been discovered as yet another member
of the same family (same PCBA in different case), it makes more sense
to refer to the whole family as SE K2xx.
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Mon, 23 Sep 2024 12:23:20 +0000 |
| parents | dddcd55883fe |
| children |
| rev | line source |
|---|---|
|
0
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
1 You are looking at the top level of the FreeCalypso host tools package. All |
|
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
2 tools in this package have been written to run on a Unix-based or Unix-like |
|
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
3 host system, such as a GNU/Linux PC or laptop, with the expectation that the |
|
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
4 user will compile them from the source using her regular system C compiler. |
|
434
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
5 See INSTALL for installation instructions. Most of these tools interface to |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
6 and operate on Calypso-based GSM devices, while a few perform some ancillary |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
7 functions. Please see doc/Host-tools-overview for the listing of what tools |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
8 are available and what they do. |
|
0
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
9 |
|
434
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
10 The most commonly needed tool for flashing firmware images (fc-loadtool) and |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
11 some of the more rarely needed tools (fc-xram, fc-iram when used with Mot C1xx |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
12 phones, and fc-buzplay) have target-side components, i.e., a part of their |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
13 functionality is implemented in Calypso ARM7 code pieces which these tools feed |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
14 to the Calypso chip's boot ROM or to Mot/Compal's bootloader on Mot C1xx phones. |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
15 The most important of these ARM7 code pieces is loadagent (implements flash |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
16 reading and writing, hardware peeks and pokes, and the chain loading function |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
17 for fc-xram) which is needed for all of our supported Calypso targets (it is |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
18 also common to all of them, no variants), and the second most important piece |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
19 is compalstage, which is needed for Compal (Mot C1xx) phones only. |
|
390
c7599298998c
README: updated for the new set of top-level source directories
Mychaela Falconia <falcon@freecalypso.org>
parents:
211
diff
changeset
|
20 |
|
434
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
21 If you are working with a packaged release of FC host tools, as opposed to a |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
22 random snapshot of the source tree, precompiled binaries for loadagent and |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
23 compalstage will be included in the target-bin directory, otherwise you will |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
24 need to build them from source: the source for loadagent and compalstage (plus |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
25 a few extra target utilities that are of interest only to developers) resides |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
26 in target-utils, and you will first need to build and install a special ARM7 |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
27 gcc toolchain as explained in the INSTALL document. |
|
0
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
28 |
|
434
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
29 There is a good amount of documentation included in the doc directory, and |
|
3ec8ef8b2d37
top README simplified, source dirs info moved to Source-dirs
Mychaela Falconia <falcon@freecalypso.org>
parents:
390
diff
changeset
|
30 there is more documentation in our dedicated freecalypso-docs repository: |
|
0
e7502631a0f9
initial import from freecalypso-sw rev 1033:5ab737ac3ad7
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
31 |
|
569
dddcd55883fe
README: Bitbucket link changed to new location (freecalypso-docs)
Mychaela Falconia <falcon@freecalypso.org>
parents:
434
diff
changeset
|
32 https://www.freecalypso.org/hg/freecalypso-docs/ |