annotate README @ 892:eed6dc6aca3c

gsm-fw/comlib/cl_imei.c: hell with TI's different return code types
author Space Falcon <falcon@ivan.Harhan.ORG>
date Mon, 29 Jun 2015 22:57:27 +0000
parents 78c894c7c471
children e8bdd3d0c4c2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
1 What this project is about
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
2 ==========================
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
3
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
4 You are looking at the software/firmware subproject of FreeCalypso. The goal
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
5 of this subproject is to produce a fully functional firmware version for the
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
6 Calypso GSM baseband chipset from Texas Instruments that is fully controlled
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
7 by We the People (recompilation with a free compiler from full source code
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
8 which is freely published and maintained by us, as opposed to a frozen
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
9 impenetrable binary blob from some long-defunct vendor) and which we can use in
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
10 two ways:
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
11
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
12 a) replace the original proprietary firmware of certain pre-existing phone
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
13 models based on this chipset, thereby turning these historical devices into
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
14 libre phones;
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
15
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
16 b) use as the official firmware for new phones and modems which we design and
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
17 build ourselves, using the same Calypso chipset.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
18
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
19 Origin of the source
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
20 ====================
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
21
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
22 We are *not* attempting to reimplement a fully functional and practically
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
23 usable GSM protocol stack from scratch in this project - such a task would be
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
24 far beyond the capabilities of our very small and woefully underfunded team,
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
25 and in the opinion of project leader Space Falcon, such a from-scratch
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
26 reimplementation would be an egregious and morally impermissible waste of human
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
27 talent. Instead, we are using the L1 and G23M protocol stack code for TI's
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
28 LoCosto chipset that was included in the chipset.zip public release made by the
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
29 CEO of Peek, Inc. (the Peek mobile email device company) as that company went
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
30 under, and porting it from the LoCosto-based Peek platform to our Calypso target
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
31 devices of interest.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
32
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
33 Where we came from
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
34 ==================
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
35
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
36 Just because we are reusing most components from TI's original firmware releases
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
37 does not mean that our project is trivial or devoid of our own original work.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
38 When we started the GSM firmware subproject in the fall of 2013 (that was when
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
39 we obtained the last missing piece of required starting source material), the
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
40 available TI firmware sources consisted of:
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
41
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
42 * A TCS211 semi-src deliverable that could be compiled into a working fw image
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
43 for the GSM modem in the Neo Freerunner. While this version includes
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
44 recompilable source for most of the supporting components, the actual GSM
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
45 protocol stack is 100% linkable binary libraries sans source. These binary
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
46 object components necessitate the use of TI's proprietary compiler tools to
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
47 rebuild the fw. The build environment is set up for Windows only.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
48
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
49 * The source from Peek (TCS3.2_N5.24_M18_V1.11_M23BTH_PSL1_src.zip) for TI's
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
50 I-Sample board with the LoCosto chipset. Mostly real source (about 95%), but
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
51 still has a few required components which exist only as linkable binary
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
52 libraries sans source. The use of TI's proprietary compiler tools is still
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
53 required for the same reason, and the build environment is set up to use a
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
54 bunch of other Windows-only tools.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
55
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
56 * The Peek Linux project (svn.peeklinux.com) replaced the Windows-based build
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
57 system with a Linux-based one, but the binary-only libraries are still there,
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
58 hence the compiler toolchain is still the same proprietary one from TI.
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 The above sorry state of affairs (absolute dependency on binary object code
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
61 sans source, on proprietary compiler toolchains and on Windows) was very far
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
62 from what we sought to accomplish (compilation from full source with gcc under
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
63 GNU/Linux or other free Unix), hence we set out on a firmware reintegration
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
64 project that took a year and a half.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
65
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
66 What we've done
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
67 ===============
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
68
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
69 By a process of painstaking reintegration piece by piece, we have put together
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
70 our own firmware suite for the Calypso that builds into a flashable image (but
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
71 doesn't work properly yet - see below) and has the following essential
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
72 features/qualities/attributes:
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
73
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
74 * Targets Calypso rather than LoCosto. This decision is somewhat controversial,
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
75 i.e., one could make a valid argument that we should have gone with LoCosto
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
76 instead. But in our defense, we already have several pre-existing devices
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
77 with the Calypso chipset on which we would like to run libre firmware; as for
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
78 LoCosto, we don't have a hardware platform to use as a bring-up vehicle, and
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
79 when we started the project, we were missing a copy of some of TI's Windows
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
80 tools for LoCosto.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
81
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
82 * The overall architecture of our firmware (what components are included) mimics
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
83 that of TCS211 (TI's official fw for Calypso platforms for which we only have
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
84 a semi-src): e.g., we use real RiViera rather than RV emulation atop GPF.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
85 In the case of RiViera, FFS and other components for which our copy of TCS211
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
86 has real source, we have used that TCS211 source.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
87
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
88 * L1 and all of G23M (including ACI, CCD and AIM/SAP definitions) are the
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
89 version from the LoCosto source - which has an unfortunate quality of being
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
90 completely untested.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
91
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
92 * Configured for a feature set matching TCS211, i.e., most of the newer features
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
93 appearing in TCS3.2 are *not* enabled. The GSM protocol stack is also
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
94 configured for the minimal voice+SMS feature set, i.e., CSD, fax and GPRS
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
95 haven't been integrated or enabled yet.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
96
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
97 * Everything builds from full source with gcc, i.e., *nothing* is used in the
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
98 form of a precompiled binary object or library. Some parts of GPF, L1 and
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
99 system initialization code had to be reconstructed from disassembly of TCS211
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
100 binary objects, as no original or suitable substitute source could be found.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
101
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
102 * The version of Nucleus we use comes from a non-TI source; all TI GSM fw
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
103 sources we found have their Nucleus in binary-only libs.
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
104
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
105 * To reiterate: our compiler is gcc, *not* TI's proprietary TMS470!
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
106
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
107 Current status (2015-05)
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
108 ========================
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
109
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
110 We are currently using the Calypso GSM modem in the Openmoko GTA02 smartphone
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
111 as our bring-up vehicle. This target has been chosen as the BUV because it is
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
112 very close to TI's reference hardware platform (Leonardo) on which TI's TCS211
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
113 reference firmware was designed to run. Because our own firmware, despite
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
114 having been reintegrated and rebuilt by us, is still based on TI's reference
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
115 design and is only slowly diverging from that origin, it makes the most sense
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
116 to bring our fw up on the most "vanilla" hw platform first, and only then port
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
117 to other hw targets of interest (Motorola and Pirelli phones) that exhibit
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
118 noticeable differences from TI's "canon".
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
119
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
120 Our current gcc-built GSM firmware image runs on this gtamodem target. But it
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
121 doesn't work properly yet: getting this firmware *built* was the first half of
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
122 the project (took a year and a half), and now we enter the second stage:
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
123 debugging problems one by one until we make it work. Right now one can flash
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
124 our firmware image into a GTA02 modem and boot it; the modem running our fw
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
125 will then present a working AT command interface: one can exercise trivial
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
126 functions like version queries and even bring up SIM communication; one can
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
127 successfully query the SIM for its IMSI and phone numbers, for example. But
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
128 attempting to bring the radio interface up fails. There is also some weird
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
129 interaction with a hardware power cycling issue which we still need to
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
130 characterize further.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
131
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
132 We are confident that we can fix whatever issues currently prevent our gcc-built
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
133 firmware from working, and get it to work no worse than the original half-src,
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
134 half-binary TCS211 - at least in the voice+SMS functional subset, without CSD,
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
135 fax or GPRS. Once we reach that point, we will then port our FreeCalypso fw to
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
136 our non-Openmoko targets of interest (Motorola C1xx and Pirelli DP-L10), and
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
137 start reintegrating TI's reference UI code - our current fw is controlled by AT
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
138 commands only. Then later re-add CSD, fax and GPRS.
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
139
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
140 We have also produced some host tools for loading firmware into Calypso GSM
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
141 devices, for communicating with running firmwares over the RVTMUX interface,
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
142 and for manipulating TI's flash file system. See README.hosttools for the
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
143 details.
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
144
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
145 Source tree
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
146 ===========
387
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
147
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
148 The subtrees of this source tree are as follows:
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
149
700
2913c4fdd34a top level README: describe the project at a higher level
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 625
diff changeset
150 gsm-fw The main FreeCalypso GSM firmware work, see above.
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
151
387
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
152 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
153 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
154 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
155 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
156 to be installed on the user's host system in order for
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
157 loadtools (see README.hosttools) to do their job.
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
158
387
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
159 ffstools Tools that run on a Unix or GNU/Linux host; see README.hosttools
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
160 loadtools for the details.
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
161 miscutil
4391890bacd9 documentation update: top level README and target-utils/README
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 250
diff changeset
162 rvinterf
97
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
163
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
164 toolchain Scripts and patches for building the gcc+binutils toolchain
a2e793f6b8c4 some README files added
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
165 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
166 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
167 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
168
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
169 Website and mailing list
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
170 ========================
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
171
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
172 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
173
863
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
174 * 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
175 subproject;
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
176
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
177 * 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
178
78c894c7c471 top README: project status update
Space Falcon <falcon@ivan.Harhan.ORG>
parents: 701
diff changeset
179 * 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
180 you can accelerate the progress of our project by funding it.