FreeCalypso > hg > ffs-data-bundle

annotate README @ 7:57f97e839441 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
aud-pirelli/headset.src: cosmetic fix (rm extra empty line)
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 27 Aug 2022 18:27:56 +0000
parents cd0641c3611a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 The present repository (FreeCalypso FFS data bundle) houses a collection of bits
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 that are eventually destined to be uploaded somewhere in FFS on FreeCalypso GSM
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 devices. The set of FC GSM devices for which these FFS bits are intended
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 includes both FC-original development boards and some pre-existing Calypso
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 phone models on which we are able to run our FreeCalypso firmware in an
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 aftermarket manner. Whether the underlying hardware is FC-original or a
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 repurposed old phone, our FC firmware always uses and maintains a flash file
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 system (FFS) structure in the device's flash memory, and with the current
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 evolutionary state of our FC firmware, this FFS needs to be populated with
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 certain bits for proper functionality. Depending on the target device, some or
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 all of the following bits need to be populated in FFS:
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 * For all phone-type devices, or development boards with directly connected
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 audio transducers, a set of audio mode configuration files needs to be
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 populated in /aud.
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 * For phone handsets and other devices with battery charging capabilities,
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 battery and charging driver configuration files need to be populated.
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 * In an upcoming development, our FC handset firmware will soon require a set
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 of ringtone melodies to be populated in FFS, in either PWT buzzer or Melody E1
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 format, depending on target hardware and firmware configuration.
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 The present FFS data bundle package contains the original ASCII source form for
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 all of the above-listed bits, as well as the necessary Makefile hierarchy for
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 compiling them into the final binary form that is uploaded into FC device FFS.
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 The intended usage model is as follows:
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 1) You need to have a recent version of FreeCalypso host tools
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 (fc-host-tools-r17 or later) installed on your host system;
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 2) You run 'make' in the present FFS data bundle source tree to compile some
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 bits from source into binary form as needed - all compilation steps are done
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 using tools that are installed as part of our FC host tools package;
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36 3) You run 'make install' - this step installs all of the bundled FFS bits in
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 various Mother-designated directories under your /opt/freecalypso host tools
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 installation;
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 4) The bits installed under /opt/freecalypso will at some point be uploaded into
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41 FC device FFS with fc-fsio, or used by shell scripts as part of preparing
cd0641c3611a add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 FFS trees for tiffs-mkfs.