annotate README @ 42:ef5376a04b8c

README: project status update
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 17 May 2017 06:38:58 +0000
parents 51e1a3b213a3
children 3ba0351942e1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 You are looking at the source tree for FreeCalypso Citrine, which is one of the
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 several Calypso GSM firmware offerings developed under the FreeCalypso umbrella.
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 The key distinguishing features of FC Citrine are:
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * The firmware is built from full source, no blobs;
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * The compiler used to build the fw is gcc (free software) instead of TI's
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 proprietary compiler;
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 * The way in which the firmware is put together is "from the bottom up".
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 Our Citrine firmware can be built for the following targets:
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
12 FreeCalypso FCDEV3B
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 Mot C11x/12x
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 Mot C139/140
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 Mot C155/156
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 Openmoko GTA01/02
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 Pirelli DP-L10
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 However, only minimal functionality is implemented so far: whichever target
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 device you are using, it can only function as an AT-command-controlled voice+SMS
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 pseudo-modem; because there is no UI code integrated yet, the LCD stays dark
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 and the buttons do nothing on those target devices that have such hardware.
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 No CSD, fax or GPRS support has been integrated yet either, and in general this
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
24 Citrine firmware does NOT exhibit the level of functionality and stability
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
25 offered by our production quality Magnetite fw.
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 Please refer to the write-ups in the doc directory for instructions on how to
51e1a3b213a3 started re-adding documentation
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 compile and play with this firmware.
42
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
29
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
30 Citrine vs. Magnetite
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
31 =====================
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
32
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
33 The following table lists the major differences between our two current
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
34 FreeCalypso firmware offerings:
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
35
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
36 Feature Citrine Magnetite
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
37
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
38 Support for Mot/Compal All 3 subfamilies: C139/140 only
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
39 targets C11x/12x, C139/140,
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
40 C155/156
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
41
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
42 Source/blob status Full source Still has some blobs
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
43
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
44 Compiler toolchain gcc TI's proprietary
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
45
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
46 GSM MS functionality Voice and SMS only Voice, SMS, CSD, fax
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
47 and GPRS
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
48
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
49 Overall functionality Experimental Production
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
50 and quality
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
51
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
52 The current main focus in the FreeCalypso family of projects is on producing
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
53 new Calypso-based GSM+GPRS modem products of full commercial quality and
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
54 functionality, hence our primary firmware focus is currently on Magnetite.
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
55
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
56 Citrine firmware is not currently receiving active new development, but it is
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
57 maintained primarily for the purpose of winning users over from OsmocomBB: the
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
58 limited GSM MS functionality (voice and SMS only) matches our competitor's
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
59 offering, the blob-free status and the use of gcc are expected to be in line
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
60 with the interests of that user population, and all 3 Mot C1xx subfamilies are
ef5376a04b8c README: project status update
Mychaela Falconia <falcon@freecalypso.org>
parents: 26
diff changeset
61 supported.