FreeCalypso > hg > freecalypso-citrine

annotate README @ 48:4bb56b6c8645

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
LICENSE: new terms
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 14 Apr 2020 21:38:35 +0000
parents 3ba0351942e1
children 908742e46a7f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
1 You are looking at the source tree for FreeCalypso Citrine, which is the final
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
2 state of our first attempt at gcc-built FreeCalypso modem firmware, the first
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
3 attempt that started in late 2013 (then called simply FreeCalypso GSM fw) and
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
4 was deemed a dead end in late 2016 (then named FC Citrine).
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
6 FC Citrine firmware project is now retired and will not receive any further
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
7 development or support; it is now fully supplanted by the newer FreeCalypso
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
8 Selenite firmware:
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
10 https://bitbucket.org/falconian/fc-selenite
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
12 FC Selenite offers the option of compiling either with TI's original TMS470
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
13 compiler or with gcc; when built with gcc, FC Selenite does not contain any
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
14 blobs and is no less free than FC Citrine. However, the configuration and
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
15 build system of FC Selenite has been derived from FC Magnetite, and is very
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
16 different from FC Citrine.
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
18 FC Citrine does not contain any code for CSD, fax or GPRS support (only voice
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
19 and SMS are supported), and it also omits the infrastructure for driving various
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
20 Calypso DSP-based audio services, functionality that was considered mandatory
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
21 and always included in TI's original TCS211 fw. OTOH, FC Selenite retains the
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
22 full architecture and functionality of TCS211, including CSD, fax, GPRS, audio
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
23 services and L1 test modes, and CSD and audio functions already work in the
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
24 gcc-built version, providing a functionality increase over Citrine. (GPRS is
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
25 currently broken in Selenite-gcc as of this writing.)
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
26
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
27 FC Citrine has been unmaintained since 2016-10; there have been many new
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
28 developments since then, including loudspeaker and MCSI digital voice interface
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
29 control on our FCDEV3B platform and better support for the legacy Compal and
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
30 Pirelli targets (more proper RF operation, battery charging and automatic
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
31 power-off on host disconnection); these new developments are available in our
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
32 newer Magnetite and Selenite firmwares, but not in Citrine.
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
33
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
34 There are only a few features in Citrine which have not been replicated in our
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
35 Magnetite or Selenite firmwares yet; these features *can* be replicated in FC
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
36 Selenite, but there has been insufficient justification so far for expending
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
37 the necessary effort:
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
38
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
39 * FC Citrine supports the Motorola C155/156 target; FC Selenite currently
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
40 supports only C11x/12x and C139/140. Mot C155/156 phones are not very common,
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
41 much less common than the other two subfamilies, and in any case the proper
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
42 way forward is our own FreeCalypso hardware, not hacking Mot C1xx phones of
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
43 any variant.
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
44
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
45 * FC Citrine supports an FFS-in-RAM hack; FC Selenite requires the FFS to be in
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
46 flash just like FC Magnetite and all of TI's original firmwares. Citrine's
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
47 FFS-in-RAM hack is only useful on the C155/156 target (see the previous point)
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
48 and on the Pirelli DP-L10, thus it is ultimately deprecated when we see our
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
49 own FreeCalypso hw as the proper way forward.
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
50
47
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
51 * FC Citrine supports a special hack for tapping voice TCH (traffic channel)
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
52 bits with FR and EFR speech codecs (but very notably not with AMR) - see the
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
53 doc/TCH-special-feature write-up. This functionality has been implemented as
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
54 a paid-for feature for some folks who were working in some highly unusual
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
55 environment, but because the underlying DSP mechanism does not work with AMR,
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
56 its usefulness for the general public community is very dubious. In the
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
57 Mother's opinion, it does not make sense to port this TCH hack to our newer
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
58 Magnetite and Selenite firmwares unless we also implement some way to force
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
59 the use of FR or EFR codecs on a per-call basis, or at least per GSM network
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
60 connection session, so that our mobile station fw would work in AMR mode
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
61 normally, but go into FR-only or FR&EFR-only restricted operation when the
3ba0351942e1 README: FC Citrine is retired, supplanted by FC Selenite
Mychaela Falconia <falcon@freecalypso.org>
parents: 42
diff changeset
62 user wishes to play with the TCH rerouting special feature.