view doc/opt-freecalypso-tree @ 1007:85ea82ce21d5

CHANGES: document Installed-binaries
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 10 Dec 2023 01:24:14 +0000
parents bb8ad7c0cee8
children
line wrap: on
line source

The /opt/freecalypso host directory tree used by the present FC host tools
package and by various add-ons to it does NOT follow the traditional Unix/Linux
file system hierarchy standard (FHS), instead it is a highly specialized
directory tree that is meant to be private to FreeCalypso, with its structure
defined solely by the Mother and no one else.  The following subdirectories are
populated by the base FC host tools package:

bin		All Unix/Linux host binaries are installed here.

include		rvinterf headers are installed here, allowing them to be used
		by add-on packages like fc-rfcal-tools.

helpfiles	Help files for those FC host utilities which implement a help
		command.

loadtools	Hardware parameter files and init scripts which underlie the
		all-important -h option to fc-loadtool, fc-iram and fc-xram,
		collectively known as loadtools.

scripts		Command scripts for FC host tools other than fc-loadtool,
		currently for fc-fsio.

target-bin	ARM7 target binaries used under the hood by loadtools.

The following additional subdirectories will be populated by the add-on FC FFS
bundle package:

aud-*		Images of /aud FFS directory subtree (audio mode config files)
		for different supported FreeCalypso devices, either FC hardware
		products or aftermarket configurations.

batteries	Collection of battery discharge threshold configuration files.

buz		FFS subtree with PWT buzzer melodies, to be uploaded into /buz
		on those FC devices that feature a traditional ringing buzzer -
		see the Buzzer-melodies article.

charging	Collection of battery charging configuration files.

mel		FFS subtree with E1 melodies, to be uploaded into /mel on those
		FC devices that will use a voice path loudspeaker for ringing.

Other subdirectories that are currently defined by the Mother:

gcc		The recommend install location for our ARM7 gcc toolchain is
		/opt/freecalypso/gcc.

rfcal		This subdir only appears if you are doing RF calibration and
		install fc-rfcal-tools, and some of the necessary config files
		under that subdir you have to create yourself using your own RF
		knowledge specific to your particular setup.

sim-data	These two subdirs are used by the FC SIM tools package.
sim-scripts