view doc/Compiling @ 22:aa20bdae9e53

doc/Compiling update: OpenSSL dependency eliminated, fc-lcdemu retired
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 22 Oct 2016 16:21:22 +0000
parents 6a029ad28212
children 4213cf6536fa
line wrap: on
line source

Building and installing FreeCalypso host tools
==============================================

In order to compile and install our host tools, just run 'make', then
'make install' as root.

The "standard" install directories are /usr/local/bin for binaries and
/usr/local/share/freecalypso for helper files.  If you need to change these
paths to something else, you'll need to edit a bunch of individual component
Makefiles, and possibly also some source files like loadtools/defpath.c -
sorry, FreeCalypso is not GNU and does not use autotools.

All FreeCalypso host tools are written in plain C, and with the exception of one
special hack-utility that has been excluded from the standard build set, they
have absolutely no library dependencies beyond libc.  In other words, they are
very friendly to those who like bare bones minimalist systems.  The only
exception is the fc-lcdemu hack which needs libX11 to compile and an X11 display
to run.  It was a developer-only hack-utility to begin with, and the developer
setup of which it was a part never worked in a satisfactory manner, so it has
been retired.  If you would like to play with it, you will need to compile it
separately, as it has been excluded from the top Makefile in order to have the
standard build set with no dependencies.

The previous dependency on OpenSSL libraries for DES decryption of the factory
IMEI record on the Pirelli DP-L10 has been eliminated by incorporating our own
simple DES implementation (performance is not a concern for the one time
operation of retrieving the factory IMEI) into our rvinterf/etmsync source, and
the functions that require access to Pirelli's IMEI have now been integrated
into fc-fsio.

Building and installing the ARM7 toolchain
==========================================

The current "official" GNU ARM toolchain for FreeCalypso consists of
binutils-2.21.1, gcc-4.5.4 and newlib-2.0.0 with a specific set of patches and
build configuration options.  This toolchain is used to compile target-utils in
this package as well as our separately-maintained Citrine firmware.  Build it
as follows:

1. Download these 3 source tarballs for the standard GNU+newlib components:

   binutils-2.21.1a.tar.bz2
   gcc-core-4.5.4.tar.bz2
   newlib-2.0.0.tar.gz

2. Run the build+install.sh script in the toolchain directory.  Read the
   comments in the script first for the usage instructions.

The toolchain thus built will need to be in your PATH before you can compile
target-utils or Citrine.

Please note: the toolchain that is prescribed for FreeCalypso as above is
*believed* to be equivalent to the one used by OsmocomBB, but there are no
guarantees.  Use any other toolchain at your own risk.

Compiling target-utils
======================

Running 'make' in the target-utils tree with the ARM7 toolchain present in your
PATH will result in compalstage and loadagent being built; these are the two
components needed in order to use FreeCalypso loadtools.  Run 'make install' to
install these target binaries in /usr/local/share/freecalypso, which is where
loadtools will look for them.

Run 'make all' in target-utils to build some other components that aren't
really needed.