FreeCalypso > hg > freecalypso-tools

annotate doc/opt-freecalypso-tree @ 981:f21798eb13cf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fc-loadtool: implement flash ppb-* commands
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 02 Dec 2023 05:46:00 +0000
parents bb8ad7c0cee8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 The /opt/freecalypso host directory tree used by the present FC host tools
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 package and by various add-ons to it does NOT follow the traditional Unix/Linux
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 file system hierarchy standard (FHS), instead it is a highly specialized
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 directory tree that is meant to be private to FreeCalypso, with its structure
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 defined solely by the Mother and no one else. The following subdirectories are
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
6 populated by the base FC host tools package:
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
7
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
8 bin All Unix/Linux host binaries are installed here.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
10 include rvinterf headers are installed here, allowing them to be used
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
11 by add-on packages like fc-rfcal-tools.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
13 helpfiles Help files for those FC host utilities which implement a help
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
14 command.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
16 loadtools Hardware parameter files and init scripts which underlie the
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
17 all-important -h option to fc-loadtool, fc-iram and fc-xram,
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
18 collectively known as loadtools.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
20 scripts Command scripts for FC host tools other than fc-loadtool,
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
21 currently for fc-fsio.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
23 target-bin ARM7 target binaries used under the hood by loadtools.
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
24
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
25 The following additional subdirectories will be populated by the add-on FC FFS
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
26 bundle package:
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
28 aud-* Images of /aud FFS directory subtree (audio mode config files)
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
29 for different supported FreeCalypso devices, either FC hardware
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
30 products or aftermarket configurations.
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
31
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
32 batteries Collection of battery discharge threshold configuration files.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
34 buz FFS subtree with PWT buzzer melodies, to be uploaded into /buz
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
35 on those FC devices that feature a traditional ringing buzzer -
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
36 see the Buzzer-melodies article.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
38 charging Collection of battery charging configuration files.
797
ef501e258036 doc/opt-freecalypso-tree: add sim-data and sim-scripts
Mychaela Falconia <falcon@freecalypso.org>
parents: 606
diff changeset
39
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
40 mel FFS subtree with E1 melodies, to be uploaded into /mel on those
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
41 FC devices that will use a voice path loudspeaker for ringing.
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
42
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
43 Other subdirectories that are currently defined by the Mother:
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
44
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
45 gcc The recommend install location for our ARM7 gcc toolchain is
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
46 /opt/freecalypso/gcc.
435
0a01e1c4ea54 documentation: added some notes about the importance of preserving
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47
881
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
48 rfcal This subdir only appears if you are doing RF calibration and
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
49 install fc-rfcal-tools, and some of the necessary config files
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
50 under that subdir you have to create yourself using your own RF
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
51 knowledge specific to your particular setup.
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
52
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
53 sim-data These two subdirs are used by the FC SIM tools package.
bb8ad7c0cee8 doc/opt-freecalypso-tree: new FC FFS bundle package coming soon
Mychaela Falconia <falcon@freecalypso.org>
parents: 797
diff changeset
54 sim-scripts