OsmocomBB

== OsmocomBB Getting Started Guide ==

This page will describe how to compile the firmware, the host utilities and how to use them.

If you haven't do so already, checkout [wiki:PreliminaryRequirements]

=== Compiling osmocomBB ===

osmocomBB consists out of software that is intended to be run on the phone (target) and the host system.

==== Dependencies for the host ====

osmocomBB requires GNU autoconf, automake, libtool, pkg-config, make and GCC to compile. You will

also need to use git to access and update the sources. There should be no other depedencies. The name

of these packages depend on the distribution used. To

For Debian the package names are:

{{{

sudo aptitude install libtool shtool autoconf git-core pkg-config make gcc

}}}

==== Dependencies for the target ====

To compile software for the target we need a GNU Toolchain for ARM. There are various pre-compiled toolchains

available but not all of them will produce working firmware. We will try to support all these configurations but it

might take a while to identify the source of a problem.

The toolchains that are known working are the [http://www.gnuarm.com GNUArm.com] ones. They provide a

ARM GCC 3.4 .3 for X86 [http://gnuarm.com/bu-2.15_gcc-3.4.3-c-c++-java_nl-1.12.0_gi-6.1.tar.bz2 here] and

a ARM GCC 4.0.2 for x86_64 [http://gnuarm.com/bu-2.16.1_gcc-4.0.2-c-c++_nl-1.14.0_gi-6.4_x86-64.tar.bz2 here]. The

toolchain is relocatable and be extracted in your home directory.

Apparently the arm-elf-gcc 4.3.2 from ports for mac os x can compile the sourcecode as well after symlinking /opt/local/bin/arm-elf-ranlib to /opt/local/bin/arm-elf-linux-ranlib and /opt/local/bin/arm-elf-strip to /opt/local/bin/arm-elf-linux-strip. If you omit the links, there will be unresolvable references to symbols in the libraries.

If you want to build your own toolchain, known to be working with OsmocomBB, see here: [wiki:GnuArmToolchain].

An example for x86

{{{

$ wget http://gnuarm.com/bu-2.15_gcc-3.4.3-c-c++-java_nl-1.12.0_gi-6.1.tar.bz2

$ mkdir install

$ cd install

$ tar xjf ../bu-2.15_gcc-3.4.3-c-c++-java_nl-1.12.0_gi-6.1.tar.bz2

$ ls gnuarm-3.4.3/bin/arm-elf-gcc

}}}

==== Getting and updating the source ====

{{{

git clone git://git.osmocom.org/osmocom-bb.git

}}}

{{{

$ cd osmocom-bb

$ git pull --rebase

}}}

==== Verify the `PATH` environment variable ====

Please ensure that the cross-compiler is available in your `PATH`, for example by adding the following command to your shell's startup script (e.g. `.bashrc`) or typing it in the terminal you use to build:

{{{

export $PATH:$HOME/install/gnuarm-3.4.3/bin

}}}

==== Building the source ====

Compiling both the target and the host code will happen with the following command. It assumes that the '''arm-elf-gcc'''

is inside the current path.

{{{

$ cd src

$ make

}}}

If your GCC binary that produces ARM code is not called '''arm-elf-gcc''' you will need to invoke the following statement

and provide the basename of the toolchain with the ending '''-'''.

{{{

$ cd src

$ make -e CROSS_TOOL_PREFIX=arm-OTHER_NAME-

}}}

If no error has occured you will have the firmware binaries in ''src/target/firmware/board/compal_e88/*.bin'' that can be

used with the Motorola C123. You also have the binaries to run on your host in ''src/host/osmocon/osmocon'', in 

''src/host/layer23/src/misc'' and ''layer23/src/mobile''.

=== Running osmocomBB ===

The original bootloader of Compal and others are built in a way to load code via the serial interface. The [wiki:osmocon]

utility implements this protocol and can upload the firmware. Please the [wiki:osmocon] for the details of how to use

it properly.

After the firmware has been loaded the [wiki:osmocon] application will print the output of the serial console

and it provides a unix domain socket that another layer of software can connect to. In the case of osmocomBB

this higher layer software is called [wiki:layer23] and is actually a group of binaries providing different functionality. Please

see [wiki:layer23] for the details.