FreeCalypso > hg > freecalypso-sw

annotate README @ 1033:5ab737ac3ad7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
TCH special feature documentation update
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 01 Jun 2016 02:06:44 +0000
parents 36e3f6bf0156
children 405b5469abc4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1000
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
1 This source repository is a top-level container for all of the main software
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
2 and firmware components developed in the FreeCalypso project.
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
3 The subtrees of this source tree are as follows:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
4
1000
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
5 compal-flash-boot-for-fc
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
6 A patched version of Compal's flash boot code for Mot C11x/12x
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
7 and C139/140 families, modified to work with main fw images from
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
8 FreeCalypso subprojects. It is compatible with our own gsm-fw
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
9 and with tcs211-c139.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
10
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
11 ffstools Here you will find tools for "in vitro" examination of FFS
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
12 (flash file system) images read out of TI-based GSM devices.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
13 See doc/TIFFS-Overview for more information.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
14
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
15 gsm-fw Our Calypso GSM firmware reconstruction and reintegration
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
16 attempt lives here; see doc/Firmware_Architecture and
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
17 doc/Firmware_Status for more information.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
18
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
19 loadtools These tools allow you to load your own code into Calypso GSM
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
20 devices. Using these tools, you can load code into target
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
21 device IRAM or XRAM and run it there, as well as dump and load
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
22 flash. The operation of these tools is based on gaining
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
23 control of the target device either through the Calypso on-chip
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
24 boot ROM (on freedom-enabled devices), or through the
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
25 flash-resident boot code on the crippled Compal phones.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
26
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
27 lcdemu fc-lcdemu is built here.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
28
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
29 miscutil fc-rgbconv, fc-serterm and imei-luhn are built here.
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
30
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
31 rvinterf In common with TI's original fw, FreeCalypso GSM fw implements
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
32 the so-called RiViera serial MUX, which is a binary packet
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
33 protocol for multiplexing many kinds of debug and development
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
34 traffic over just one available physical serial port. This
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
35 rvinterf directory contains our suite of tools for connecting
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
36 to this RV serial interface, supporting both our own gsm-fw as
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
37 well as some existing proprietary firmwares to the extent to
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
38 which they are compatible.
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
39
387
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
40 target-utils This tree contains code that runs on Calypso targets, but is
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
41 not regular firmware (gsm-fw) or a part thereof. The two key
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
42 components built in this tree are loadagent (needed for all
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
43 targets) and compalstage (for Compal phones only), which need
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
44 to be installed on the user's host system in order for
1000
36e3f6bf0156 top README: just describe what each subtree is for, and refer to other docs
Mychaela Falconia <falcon@ivan.Harhan.ORG>
parents: 897
diff changeset
45 loadtools (see above) to do their job.
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
46
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
47 toolchain Scripts and patches for building the gcc+binutils toolchain
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
48 targeting ARM7, the CPU core of the Calypso GSM/GPRS baseband
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
49 processor. You'll need to build and install this toolchain
143
afceeeb2cba1 Our nuc-fw is destined to become gsm-fw, so I went ahead and did the big hg mv
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 97
diff changeset
50 first before you can build gsm-fw or target-utils.
484
c617a6adcb69 top level README: status update
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 387
diff changeset
51
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
52 Website and mailing list
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
53 ========================
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
54
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
55 Please see our website at www.freecalypso.org for information on:
484
c617a6adcb69 top level README: status update
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 387
diff changeset
56
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
57 * The overall FreeCalypso libre phone project, beyond this specific sw/fw
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
58 subproject;
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
59
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
60 * Our community mailing list and how you can subscribe to it;
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
61
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
62 * How you can help the human family behind the project with donations and how
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
63 you can accelerate the progress of our project by funding it.