# HG changeset patch # User Mychaela Falconia # Date 1649222796 0 # Node ID cd0641c3611a3f95ca4fa4ae42984c11be1f1d67 # Parent e0c7fa6be0fc215b1630c67986b3a0c325fc310e add README diff -r e0c7fa6be0fc -r cd0641c3611a README --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Wed Apr 06 05:26:36 2022 +0000 @@ -0,0 +1,42 @@ +The present repository (FreeCalypso FFS data bundle) houses a collection of bits +that are eventually destined to be uploaded somewhere in FFS on FreeCalypso GSM +devices. The set of FC GSM devices for which these FFS bits are intended +includes both FC-original development boards and some pre-existing Calypso +phone models on which we are able to run our FreeCalypso firmware in an +aftermarket manner. Whether the underlying hardware is FC-original or a +repurposed old phone, our FC firmware always uses and maintains a flash file +system (FFS) structure in the device's flash memory, and with the current +evolutionary state of our FC firmware, this FFS needs to be populated with +certain bits for proper functionality. Depending on the target device, some or +all of the following bits need to be populated in FFS: + +* For all phone-type devices, or development boards with directly connected + audio transducers, a set of audio mode configuration files needs to be + populated in /aud. + +* For phone handsets and other devices with battery charging capabilities, + battery and charging driver configuration files need to be populated. + +* In an upcoming development, our FC handset firmware will soon require a set + of ringtone melodies to be populated in FFS, in either PWT buzzer or Melody E1 + format, depending on target hardware and firmware configuration. + +The present FFS data bundle package contains the original ASCII source form for +all of the above-listed bits, as well as the necessary Makefile hierarchy for +compiling them into the final binary form that is uploaded into FC device FFS. +The intended usage model is as follows: + +1) You need to have a recent version of FreeCalypso host tools + (fc-host-tools-r17 or later) installed on your host system; + +2) You run 'make' in the present FFS data bundle source tree to compile some + bits from source into binary form as needed - all compilation steps are done + using tools that are installed as part of our FC host tools package; + +3) You run 'make install' - this step installs all of the bundled FFS bits in + various Mother-designated directories under your /opt/freecalypso host tools + installation; + +4) The bits installed under /opt/freecalypso will at some point be uploaded into + FC device FFS with fc-fsio, or used by shell scripts as part of preparing + FFS trees for tiffs-mkfs.