FreeCalypso > hg > freecalypso-tools

comparison doc/opt-freecalypso-tree @ 881:bb8ad7c0cee8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 02 Apr 2022 23:48:53 +0000
parents ef501e258036
children
comparison
equal deleted inserted replaced
880:5b68ba735e98 881:bb8ad7c0cee8
1 The /opt/freecalypso host directory tree used by the present FC host tools 1 The /opt/freecalypso host directory tree used by the present FC host tools
2 package and by various add-ons to it does NOT follow the traditional Unix/Linux 2 package and by various add-ons to it does NOT follow the traditional Unix/Linux
3 file system hierarchy standard (FHS), instead it is a highly specialized 3 file system hierarchy standard (FHS), instead it is a highly specialized
4 directory tree that is meant to be private to FreeCalypso, with its structure 4 directory tree that is meant to be private to FreeCalypso, with its structure
5 defined solely by the Mother and no one else. The following subdirectories are 5 defined solely by the Mother and no one else. The following subdirectories are
6 currently defined: 6 populated by the base FC host tools package:
7 7
8 aud-*: these directories appear if you install our optional 8 bin All Unix/Linux host binaries are installed here.
9 fc-audio-config package, and contain subtrees to be uploaded by
10 production line scripts into target device FFS under /aud via fc-fsio.
11 9
12 batteries and charging: these subtrees come from fc-battery-conf 10 include rvinterf headers are installed here, allowing them to be used
13 (optional just like fc-audio-config) and are meant to be used with 11 by add-on packages like fc-rfcal-tools.
14 fc-fsio write-battery-table and write-charging-config commands.
15 12
16 bin and include are the only subdirectories under /opt/freecalypso 13 helpfiles Help files for those FC host utilities which implement a help
17 which follow traditional UNIX directory layout; include was added so 14 command.
18 that packages external to the core FC host tools package like
19 fc-rfcal-tools and freecalypso-ui-dev can use rvinterf headers.
20 15
21 gcc: the recommend install location for our ARM7 gcc toolchain is 16 loadtools Hardware parameter files and init scripts which underlie the
22 /opt/freecalypso/gcc. 17 all-important -h option to fc-loadtool, fc-iram and fc-xram,
18 collectively known as loadtools.
23 19
24 helpfiles subdir contains help files for those FC host utilities which 20 scripts Command scripts for FC host tools other than fc-loadtool,
25 implement a help command. 21 currently for fc-fsio.
26 22
27 loadtools subdir contains hardware parameter files and init scripts 23 target-bin ARM7 target binaries used under the hood by loadtools.
28 which underlie the all-important -h option to fc-loadtool, fc-iram and
29 fc-xram, collectively known as loadtools.
30 24
31 rfcal subdir only appears if you are doing RF calibration and install 25 The following additional subdirectories will be populated by the add-on FC FFS
32 fc-rfcal-tools, and some of the necessary config files under that 26 bundle package:
33 subdir you have to create yourself using your own RF knowledge specific
34 to your particular setup.
35 27
36 scripts subdir contains command scripts for FC host tools other than 28 aud-* Images of /aud FFS directory subtree (audio mode config files)
37 fc-loadtool, currently for fc-fsio. 29 for different supported FreeCalypso devices, either FC hardware
30 products or aftermarket configurations.
38 31
39 sim-data and sim-scripts subdirectories are used by the FC SIM tools package. 32 batteries Collection of battery discharge threshold configuration files.
40 33
41 target-bin contains ARM7 target binaries used under the hood by 34 buz FFS subtree with PWT buzzer melodies, to be uploaded into /buz
42 loadtools. 35 on those FC devices that feature a traditional ringing buzzer -
36 see the Buzzer-melodies article.
43 37
44 The basic minimal form of the /opt/freecalypso tree is populated when 38 charging Collection of battery charging configuration files.
45 you install FC host tools, but it is further enriched if and when you 39
46 install further add-ons (fc-audio-config, fc-battery-conf, 40 mel FFS subtree with E1 melodies, to be uploaded into /mel on those
47 fc-rfcal-tools) which are more specialized and not required for all 41 FC devices that will use a voice path loudspeaker for ringing.
48 users. I expect to have more additions in the future: for example, 42
49 when we start using the Melody E1 mechanism in our planned FC Libre 43 Other subdirectories that are currently defined by the Mother:
50 Dumbphone, there will be a FreeCalypso ringtones package that will 44
51 install E1-format melody files somewhere under /opt/freecalyso, to be 45 gcc The recommend install location for our ARM7 gcc toolchain is
52 subsequently uploaded into the actual phones via fc-fsio, initially at 46 /opt/freecalypso/gcc.
53 production time and optionally by end users. 47
48 rfcal This subdir only appears if you are doing RF calibration and
49 install fc-rfcal-tools, and some of the necessary config files
50 under that subdir you have to create yourself using your own RF
51 knowledge specific to your particular setup.
52
53 sim-data These two subdirs are used by the FC SIM tools package.
54 sim-scripts