Software Getting Started » History » Version 20
tsaitgaist, 02/19/2016 10:49 PM
remove shell commad header, part 2
1 | 1 | == OsmocomBB Getting Started Guide == |
|
---|---|---|---|
2 | |||
3 | This page will describe how to compile the firmware, the host utilities and how to use them. |
||
4 | 10 | If you haven't do so already, checkout [wiki:PreliminaryRequirements] |
|
5 | 1 | ||
6 | === Compiling osmocomBB === |
||
7 | osmocomBB consists out of software that is intended to be run on the phone (target) and the host system. |
||
8 | |||
9 | 6 | steve-m | ==== Dependencies for the host ==== |
10 | 1 | ||
11 | 18 | tsaitgaist | osmocomBB requires GNU autoconf, automake, libtool, pkg-config, make and GCC to compile. |
12 | You will also need to use git to access and update the sources. |
||
13 | The name of these packages depend on the distribution used. |
||
14 | 1 | For Debian the package names are: |
|
15 | {{{ |
||
16 | 20 | tsaitgaist | #!sh |
17 | 1 | sudo aptitude install libtool shtool autoconf git-core pkg-config make gcc |
|
18 | }}} |
||
19 | 18 | tsaitgaist | |
20 | For osmocomBB, as for several other osmocom projects, you will also need [wiki:libosmocore]. |
||
21 | |||
22 | 1 | ||
23 | 9 | ==== Dependencies for the target ==== |
|
24 | 1 | ||
25 | 15 | tsaitgaist | To compile osmocomBB or SIMtrace for the target we need a GNU [wiki:toolchain] for ARM. |
26 | 13 | ||
27 | 1 | ==== Getting and updating the source ==== |
|
28 | |||
29 | 2 | {{{ |
|
30 | 20 | tsaitgaist | #!sh |
31 | git clone git://git.osmocom.org/osmocom-bb.git |
||
32 | 19 | tsaitgaist | cd osmocom-bb |
33 | git pull --rebase |
||
34 | 9 | }}} |
|
35 | |||
36 | ==== Verify the `PATH` environment variable ==== |
||
37 | |||
38 | 1 | 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: |
|
39 | 9 | ||
40 | {{{ |
||
41 | 20 | tsaitgaist | #!sh |
42 | 9 | export $PATH:$HOME/install/gnuarm-3.4.3/bin |
|
43 | 2 | }}} |
|
44 | |||
45 | 1 | Or on Ubuntu you might want to try: |
|
46 | 11 | ||
47 | {{{ |
||
48 | 20 | tsaitgaist | #!sh |
49 | 11 | export PATH=$PATH:$HOME/install/gnuarm-3.4.3/bin |
|
50 | }}} |
||
51 | |||
52 | 12 | (presuming it's in your home directory, if you have changed to root it probably wont be :)) |
|
53 | 1 | ==== Building the source ==== |
|
54 | Compiling both the target and the host code will happen with the following command. It assumes that the '''arm-elf-gcc''' |
||
55 | is inside the current path. |
||
56 | 2 | ||
57 | {{{ |
||
58 | 20 | tsaitgaist | #!sh |
59 | cd src |
||
60 | make |
||
61 | 1 | }}} |
|
62 | |||
63 | If your GCC binary that produces ARM code is not called '''arm-elf-gcc''' you will need to invoke the following statement |
||
64 | 4 | and provide the basename of the toolchain with the ending '''-'''. |
|
65 | |||
66 | 2 | {{{ |
|
67 | 20 | tsaitgaist | #!sh |
68 | cd src |
||
69 | make -e CROSS_TOOL_PREFIX=arm-OTHER_NAME- |
||
70 | 1 | }}} |
|
71 | 4 | ||
72 | If no error has occured you will have the firmware binaries in ''src/target/firmware/board/compal_e88/*.bin'' that can be |
||
73 | used with the Motorola C123. You also have the binaries to run on your host in ''src/host/osmocon/osmocon'', in |
||
74 | ''src/host/layer23/src/misc'' and ''layer23/src/mobile''. |
||
75 | 5 | ||
76 | |||
77 | === Running osmocomBB === |
||
78 | The original bootloader of Compal and others are built in a way to load code via the serial interface. The [wiki:osmocon] |
||
79 | utility implements this protocol and can upload the firmware. Please the [wiki:osmocon] for the details of how to use |
||
80 | it properly. |
||
81 | |||
82 | After the firmware has been loaded the [wiki:osmocon] application will print the output of the serial console |
||
83 | and it provides a unix domain socket that another layer of software can connect to. In the case of osmocomBB |
||
84 | 16 | this higher layer software is called [wiki:ccch_scan] and is actually a group of binaries providing different functionality. Please |
|
85 | see [wiki:ccch_scan] for the details. |