Difference between revisions of "Raspberry Pi Kernel Compilation"

From eLinux.org
Jump to: navigation, search
m (compiling: Added instructions to copy .config from a running image)
(Transfer the firmware)
(123 intermediate revisions by 43 users not shown)
Line 1: Line 1:
 
{{Template:RPi_Software}}
 
{{Template:RPi_Software}}
 
  
 
= Overview =
 
= Overview =
 +
This page explains how to rebuild the kernel image for the RPi. There are two possible routes available:
 +
# Compile on the Raspberry Pi itself
 +
# Cross compile on another Linux system
  
First, you are going to get and build the linux kernel and its modules using a suitable compiler (a "cross-compiler" if you aren't building it on the same hardware you will be running it on) and then you are going to create a kernel image from the uncompressed kernel (Image) to place on the sd, along with the modules you build alongside it.
+
Both of these routes are covered below, however, you are strongly recommended to follow the cross compilation route. The low processing power of the RPi means that a local compile will take many hours. A compilation of the latest kernel and modules took about 752 minutes (12h:30m)!
  
See below for the various guides to get and compile a suitable kernel for your RPi, and then create a kernel.img according to the steps at the end.
+
If you want to compile an upstream kernel, rather than the Raspberry Pi Foundation's downstream kernel, please see [[RPi_Upstream_Kernel_Compilation]] for a few tips.
  
= Raspberry PI kernel compilation =
+
== Example Checklist/Roadmap ==
 +
This section serves to hold a new user's hand just a bit more than some of the other more generic information below in the document. To get more information on the steps in the roadmap, search this page for additional details. It assumes you can navigate filesystems, move files across systems, and have a general understanding of compiling linux kernels, filesystems, partitions, and block devices.
  
You can compile the kernel on the board itself, but because of the limited resources it will take a lot of time. Alternatively you can crosscompile the kernel on another machine running Linux, Windows or OS X.
+
This series of steps yielded a successful custom/updated hardfp kernel to a stock Raspbian installation, cross compiled from an amd64 Debian system without regression on any kernel configuration options or requiring modified boot parameters. Be aware that in the worst case, you may need to overlay a stock set of kernel/modules/firmware on the Raspberry Pi if something fails. If you do not know how to do this, then a reimage of the SD card may be necessary. Assuming this is not an issue for your configuration, continue onward:
 +
# Get the latest raspberrypi kernel source (https://github.com/raspberrypi/linux)
 +
# Set an environment variable KERNEL_SRC to point to the location of the source ( e.g. KERNEL_SRC=/home/me/linux/ )
 +
# Get the latest raspberrypi compiler (git clone https://github.com/raspberrypi/tools)
 +
# Set an environment variable CCPREFIX to point to the location of tools ( e.g. CCPREFIX=/home/me/tools/arm-bcm2708/arm-bcm2708-linux-gnueabi/bin/arm-bcm2708-linux-gnueabi- )
 +
# From the kernel clone location, clean the kernel source with "make mrproper"
 +
# Pull the /proc/config.gz from the running Raspbian installation
 +
# Prime kernel with the old config by running "ARCH=arm CROSS_COMPILE=${CCPREFIX} make oldconfig"
 +
# Modify the kernel config by either modifying the .config file or using "ARCH=arm CROSS_COMPILE=${CCPREFIX} make menuconfig"
 +
# Build the new kernel by using "ARCH=arm CROSS_COMPILE=${CCPREFIX} make"
 +
# Set an environment variable MODULES_TEMP to point to the location of the source ( e.g. MODULES_TEMP=/home/me/modules/ )
 +
# Set aside the new kernel modules by using "ARCH=arm CROSS_COMPILE=${CCPREFIX} INSTALL_MOD_PATH=${MODULES_TEMP} make modules_install"
 +
# From the tools clone location, in the mkimage directory, run "./imagetool-uncompressed.py ${KERNEL_SRC}/arch/arm/boot/zImage"
 +
# Move the resulting kernel.img to the Raspberry Pi's /boot/ directory
 +
# Package up the modules into an archive such that at the top level, the structure looks like this:
 +
#* ./firmware
 +
#* ./firmware/brcm
 +
#* ./firmware/edgeport
 +
#* ./firmware/emi26
 +
#* ...
 +
#* ./modules
 +
#* ./modules/3.6.11+
 +
#* ./modules/3.6.11+/kernel
 +
#* ./modules/3.6.11+/kernel/lib
 +
#* ./modules/3.6.11+/kernel/fs
 +
#* ...
 +
# Move the modules archive to the Raspberry Pi and extract them such that the aforementioned firmware and modules directories overwrite /lib/firmware and /lib/modules
 +
# Get the latest raspberrypi firmware (git://github.com/raspberrypi/firmware.git)
 +
# Transfer the following files from the firmware/boot directory to the Raspberry pi /boot directory:
 +
#* bootcode.bin
 +
#* fixup.dat
 +
#* start.elf
 +
# Transfer the firmware/hardfp/opt directory to the Raspberry pi /opt directory
 +
# Reboot the Raspberry Pi
 +
The Raspberry Pi should now boot with the newly configured/recompiled kernel.
  
== Compiling on the Raspberry pi itself ==
+
= Get the kernel source =
 +
The kernel source should be downloaded from the [https://github.com/raspberrypi/linux RPI linux section on GitHub]. Although you could just compile the vanilla kernel from [http://www.kernel.org/ Kernel.org], it will not have the necessary drivers and modules for the Broadcom SoC on the RPi. You can however apply patches from the vanilla kernel to the RPi one - be prepared for potential compiler grumbles though!
  
TODO: write the rest of this section.
+
Jan '14 the current is rpi-3.10.y, you can check this and other available versions by browsing [https://github.com/raspberrypi/linux RPI linux section on GitHub]
  
== Cross compiling on a foreign machine==
+
You can download the source directly using git. For the 3.10 branch:
 +
<pre>
 +
git init
 +
git clone --depth 1 git://github.com/raspberrypi/linux.git
 +
</pre>
 +
and for the other Stable Code branch change the numbers in the following to suit:
 +
<pre>
 +
git init
 +
git fetch git://github.com/raspberrypi/linux.git rpi-3.6.y:refs/remotes/origin/rpi-3.6.y
 +
git checkout rpi-3.6.y
 +
</pre>
  
=== Ubuntu Linux ===
+
Or you can download a tarball from the same website:
  
==== getting the compiler ====
+
= Get a compiler =
 +
Next, you will need to get a version of GCC in order to build the kernel.
  
On Ubuntu Oneiric getting the arm cross compiler can be as easy as:
+
== 1. On the RPi ==
  
sudo apt-get install gcc-4.6-arm-linux-gnueabi
+
=== Raspbian and PiBang ===
sudo apt-get install git  #jhauser14905 -- might as well state the obvious, you need git installed!
+
<pre>
 +
apt-get update
 +
apt-get -y dist-upgrade
 +
apt-get -y install gcc make bc screen ncurses-dev
 +
</pre>
  
(TODO: Is this the right one? More packages required? I did this a while ago! TODO: Other distributions?)
+
=== Arch Linux ===
 
+
<pre>
==== getting the sources ====
+
pacman -Syu
 +
pacman -S gcc make
 +
</pre>
  
create a directory where you can work on the raspberry pi software. I called mine "raspberrypi". Then clone the git repository.  
+
=== OpenSuSE Linux ===
 +
Detailed OpenSuSE RPI 12.3 Image 20130407 + 3.8.8 kernel hack  tutorial witten ( 22042013 updated )
 +
see: http://www.raspberrypi.org/phpBB3/viewtopic.php?f=87&t=40664&p=331953#p331953
 +
Kernel Compile takes ~22H on RPI Model B  due massive module compiles , Include all IP_VS , ARPD , Fuse-zfs  , Zram and more :-) 
  
mkdir raspberrypi
+
This works as well for Debian , Fedora remix and others ( just package Install command differ )
cd raspberrypi
+
  zypper install u-boot-tools sudo gcc automake autoconf bison gettext flex libncurses5 ncurses-devel
git clone https://github.com/raspberrypi/linux.git
 
  cd linux
 
  
jhauser14905: on 2012-01-28, with all package updates applied, i had to add the following symlink in order to get the make commands to work. otherwise they would error out
+
<pre>
 +
cd /usr/src
 +
mkdir GIT; cd GIT; git init; D=`date +"%m-%d-%Y"`
 +
git fetch git://github.com/raspberrypi/linux.git rpi-3.8.y:refs/remotes/origin/rpi-3.8.y
 +
git checkout rpi-3.8.y
 +
tar cpf rpi-3.8.y.$D.tar  rpi-3.8.y
  
sudo ln -s  /usr/bin/arm-linux-gnueabi-gcc-4.6 /usr/bin/arm-linux-gnueabi-gcc
+
cd /usr/src
 +
tar xpf  GIT/rpi-3.8.y.$D.tar
 +
rm linux
 +
ln -s linux-rpi-3.8.y linux
  
==== compiling ====
+
cd /usr/src/linux
 +
kversion=$(make -s kernelrelease)
 +
cp linux/.config .config_$kversion
  
Next, the kernel options are configured. Either copy the cut down Raspberry Pi .config file from the kernel source configs directory:
+
cd /usr/src/
cp arch/arm/configs/bcmrpi_cutdown_defconfig .config
+
# get config-3.8.7.ipvs+krb5+arpd.tar.bz2 from the Tutorial:
 +
wget http://www.raspberrypi.org/phpBB3/download/file.php?id=3174
 +
# copy the .config to /usr/src/linux:
 +
tar xpfj config-3.8.7.ipvs+krb5+arpd.tar.bz2
  
Or alternatively, to use the configuration from a currently running Raspberry Pi image, connect to the target and extract the .config file.  Then copy the resultant .config file into the Linux kernel source root directory:
 
zcat /proc/config.gz > .config
 
cp .config <path to linux source root directory>
 
  
Configure the kernel with the copied .config file by running oldconfig:
+
#make the Kernel and go sleep :-)
make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- oldconfig
+
cd linux
 +
make oldconfig
 +
nohup make zImage dep modules &
  
Then build the kernel:
+
#Next day .. Install It.
  make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- -k
+
cd /usr/src/linux
 +
kversion=$(make -s kernelrelease)
 +
echo $kversion
 +
mkdir -p /boot/$kversion
 +
make ARCH=arm INSTALL_PATH=/boot/ install
 +
cp System.map /boot/System.map-$kversion
 +
cp System.map-$kversion /boot/System.map
 +
make ARCH=arm modules_install INSTALL_MOD_PATH=/
 +
make ARCH=arm INSTALL_PATH=/boot/ zinstall
 +
cp .config /boot/config-$kversion
 +
cp ./Module.symvers  /boot/symvers-$kversion
 +
cp arch/arm/boot/Image /boot/kernel.img
 +
</pre>
  
You can use the "-j" flag to improve compilation time. If you have a dual core machine you can use "-j 3", for a quad core machine you can use "-j 6", and so on.
+
== 2. Cross compiling from Linux ==
 +
Please note that when cross-compiling, your compiler may not target the correct ARM processor by default. This will at best reduce performance, or worse, compile for a much newer processor resulting in illegal instructions in your code. The pre-built compiler or a custom-built compiler are recommended because of this. (For example, the latest GCC Linaro binary targets armv7-a by default, whereas the RPi requires armv6kz). It is possible to add extra compiler options to the <tt>HOSTCFLAGS</tt> line in <tt>Makefile</tt>. The correct flags are shown on the [[RPi_Software#Compiler|software page]] - note that you may also need to add <tt>-marm</tt> if your compiler produces Thumb code by default.
  
If you get the error messages that arm-linux-gnueabi-gcc cannot be found when running make, run the following command:
+
=== Use the provided compiler ===
 +
Download the pre-built bmc2708 compiler from the [https://github.com/raspberrypi/tools/tree/master/arm-bcm2708/arm-bcm2708hardfp-linux-gnueabi RPI tools section on GitHub].
 +
<pre>
 +
git clone git://github.com/raspberrypi/tools.git
 +
</pre>
 +
or you can download a tarball from the website using [https://github.com/raspberrypi/tools/archive/master.tar.gz this link].
  
sudo ln -s /usr/bin/arm-linux-gnueabi-gcc-4.6 /usr/bin/arm-linux-gnueabi-gcc
+
=== Custom-built Linaro GCC ===
 +
See [[RPi_Linaro_GCC_Compilation|Linaro GCC Compilation]].
  
this creates a symbolic link to the 4.6 gcc binary
+
=== Ubuntu ===
 +
<pre>
 +
apt-get install gcc-arm-linux-gnueabi make ncurses-dev
 +
</pre>
  
 
=== Gentoo Linux ===
 
=== Gentoo Linux ===
 +
<pre>
 +
crossdev -S -v -t arm-unknown-linux-gnueabi
 +
</pre>
  
==== getting the compiler ====
+
Crossdev should create a cross-toolchain using the latest stable versions of the required packages.  If it fails, you can specify exact versions by removing the "-S" flag and adding the "--b", "--g", "--k" and "--l" flags. On 2012-05-06, <tt>cross -S -v -A gnueabi arm</tt> works just fine.
 
 
Build the cross toolchain:
 
crossdev -S -v -t arm-unknown-linux-gnueabi
 
 
 
theBuell: on 2012-05-06, cross -S -v -A gnueabi arm works just fine
 
 
 
This command should create a cross-toolchain using the latest stable versions of the required packages.  If it fails, you can specify exact versions by removing the "-S" flag and adding the "--b", "--g", "--k" and "--l" flags. For the exact usage refer to the crossdev manpage. A good starting point for figuring out the right versions are those which are stable for the arm architecture.
 
 
 
==== getting the sources ====
 
 
 
create a directory where you can work on  the raspberry pi software. I called mine "raspberrypi". Then clone the git repository.
 
 
 
mkdir raspberrypi
 
cd raspberrypi
 
git clone https://github.com/raspberrypi/linux.git
 
cd linux
 
 
 
==== compiling ====
 
 
 
Next you have to configure the kernel:
 
cp arch/arm/configs/bcmrpi_cutdown_defconfig .config
 
make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- oldconfig
 
 
 
Then building the kernel:
 
make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- -k
 
 
 
You can use the "-j" flag to improve compilation time. If you have a dual core machine you can use "-j 3", for a quad core machine you can use "-j 6", and so on.
 
  
 
=== Arch Linux ===
 
=== Arch Linux ===
 +
<pre>
 +
yaourt -S arm-linux-gnueabi-gcc
 +
</pre>
  
==== getting the compiler ====
+
== Cross compiling from OSX ==
You will need GIT to clone the kernel source tree from GitHub:
+
=== Macports ===
pacman -S git
+
The Kernel source requires a case-sensitive filesystem. If you do not have a HFS+ Case-sensitive partition that can be used, create a disk image with the appropriate format.
 +
Ensure latest Xcode and command line tools are installed from [http://developer.apple.com/downloads Apple Developer Connection]
 +
Install [http://guide.macports.org/#installing macports]
 +
<pre>
 +
port install arm-none-eabi-gcc
 +
port install arm-none-eabi-binutils
 +
</pre>
  
Build the cross toolchain:
+
'''If you get an error message that elf.h is missing'''
arm-linux-gnueabi-gcc is on the AUR. If you use yaourt:
+
sudo port install libelf && sudo ln -s /opt/local/include/libelf /usr/include/libelf
 +
From opensource.apple.com, download and copy [http://opensource.apple.com/source/dtrace/dtrace-48/sys/elf.h?txt elf.h] and [http://opensource.apple.com/source/dtrace/dtrace-48/sys/elftypes.h?txt elftypes.h] to /usr/include
  
  yaourt -S arm-linux-gnueabi-gcc
+
Edit elf.h and add
 
+
  #define R_386_NONE        0
Yaourt is recommended as it will build all dependencies.
+
#define R_386_32          1
 
+
#define R_386_PC32        2
==== getting the sources ====
+
#define R_ARM_NONE        0
 
+
#define R_ARM_PC24        1
create a directory where you can work on the raspberry pi software. I called mine "raspberrypi". Then clone the git repository.
+
#define R_ARM_ABS32      2
 
+
  #define R_MIPS_NONE      0
  mkdir raspberrypi
+
#define R_MIPS_16        1
  cd raspberrypi
+
  #define R_MIPS_32        2
  git clone https://github.com/raspberrypi/linux.git
+
  #define R_MIPS_REL32      3
  cd linux
+
  #define R_MIPS_26        4
 
+
  #define R_MIPS_HI16      5
==== compiling ====
+
#define R_MIPS_LO16      6
 
+
'''If you get a "SEGMENT_SIZE is undeclared" error'''
Next you have to configure the kernel:
+
open the Makefile and change the line:
  cp arch/arm/configs/bcmrpi_cutdown_defconfig .config
+
  NOSTDINC_FLAGS += -nostdinc -isystem $(shell $(CC) -print-file-name=include)
make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- oldconfig
+
to
 
+
  NOSTDINC_FLAGS += -nostdinc -isystem $(shell $(CC) -print-file-name=include) -Dlinux
Then building the kernel:
 
  make ARCH=arm CROSS_COMPILE=/usr/bin/arm-linux-gnueabi- -k
 
 
 
You can use the "-j" flag to improve compilation time. If you have a dual core machine you can use "-j 3", for a quad core machine you can use "-j 6", and so on.
 
 
 
=== Windows ===
 
  
TODO
+
'''Complete script''' requires raspberrypi.config to be in the same folder that you execute from
 +
<pre>
 +
sudo port install arm-none-eabi-gcc
 +
sudo port install arm-none-eabi-binutils
 +
sudo port install libelf && sudo ln -s /opt/local/include/libelf /usr/include/libelf
 +
sudo curl http://opensource.apple.com/source/dtrace/dtrace-48/sys/elftypes.h?txt -o  /usr/include/elftypes.h
 +
sudo curl http://opensource.apple.com/source/dtrace/dtrace-48/sys/elf.h?txt -o /usr/include/elf.h
 +
#code to append to elf.h
 +
echo "
 +
#define R_386_NONE 0
 +
#define R_386_32 1
 +
#define R_386_PC32 2
 +
#define R_ARM_NONE 0
 +
#define R_ARM_PC24 1
 +
#define R_ARM_ABS32 2
 +
#define R_MIPS_NONE 0
 +
#define R_MIPS_16 1
 +
#define R_MIPS_32 2
 +
#define R_MIPS_REL32 3
 +
#define R_MIPS_26 4
 +
#define R_MIPS_HI16 5
 +
#define R_MIPS_LO16 6" > elf-append.h
 +
sudo -s 'cat elf-append.h >> /usr/include/elf.h'
  
=== OS X ===
+
#Make a case sensitive 3gb disk image, raspberrypi-kernel, and attach it
 +
hdiutil create -size 10g -type SPARSEBUNDLE -nospotlight -volname raspberrypi-kernel -fs "Case-sensitive Journaled HFS+" -attach ./raspberrypi-kernel.dmg
 +
cp raspberrypi.config /Volumes/raspberrypi-kernel/
 +
mkdir /Volumes/raspberrypi-kernel/src
 +
cd /Volumes/raspberrypi-kernel/src
  
==== getting the compiler ====
+
#get source, either 1. from zip (faster), or 2. from git
Ensure latest Xcode and command line tools are installed from [http://developer.apple.com/downloads Apple Developer Connection] then
+
#1. from zip
Downoad and install an GNU ARM toolchain such as [http://www.yagarto.de/#downloadmac yagarto]
+
curl https://codeload.github.com/raspberrypi/linux/zip/rpi-3.6.y -o ./rpi-3.6.y.zip
 +
unzip rpi-3.6.y.zip
 +
#2. from git (disabled)
 +
#git init
 +
#git fetch git://github.com/raspberrypi/linux.git rpi-3.6.y:refs/remotes/origin/rpi-3.6.y
 +
#git checkout rpi-3.6.y
  
Another option is the MacPorts arm-none-eabi-*:
+
cpu=$(sysctl hw.ncpu | awk '{print $2}')
 +
cpup1=$((cpu+1))
  
port install arm-none-eabi-binutils
+
cd /Volumes/raspberrypi-kernel/src/linux-rpi-3.6.y/
 +
export CCPREFIX=/opt/local/bin/arm-none-eabi-
 +
make mrproper
 +
cp /Volumes/raspberrypi-kernel/raspberrypi.config .config
 +
#answer yes to all config options
 +
#yes "" | make ARCH=arm CROSS_COMPILE=${CCPREFIX} oldconfig
 +
make ARCH=arm CROSS_COMPILE=${CCPREFIX} -j$cpup1
 +
#make ARCH=arm CROSS_COMPILE=${CCPREFIX} modules -j$cpup1
 +
</pre>
  
==== getting the sources ====
+
=== Yagarto ===
 +
Download and install from [http://www.yagarto.de/#downloadmac here].
  
create a directory where you can work on  the raspberry pi software. I called mine "raspberrypi". Then clone the git repository.
+
= Perform the compilation =
 +
Firstly, ensure your build directory is clean:
 +
<pre>
 +
make mrproper
 +
</pre>
  
mkdir raspberrypi
+
Next, in all cases, you will want to get a working kernel configuration to start from. You can get the one running on the RPi by typing the following (on the RPi):
cd raspberrypi
+
<pre>
git clone https://github.com/raspberrypi/linux.git
+
zcat /proc/config.gz > .config
cd linux
+
</pre>
 +
then copy <tt>.config</tt> into your build directory.
  
==== compiling ====
+
Alternatively, the default configuration is available in the downloaded kernel source in <tt>arch/arm/configs/bcmrpi_defconfig</tt>. Just copy this to <tt>.config</tt> in the build directory.
  
Next you have to configure the kernel: (the running kernel config can be found in <code>/proc/config.gz</code> on your RPi)
+
From this point on, if you are cross-compiling, set an environment variable <tt>CCPREFIX</tt> that points to the prefix of your compiler binary as each compiler will be named slightly differently.
cp arch/arm/configs/bcmrpi_cutdown_defconfig .config
+
<pre>
make ARCH=arm CROSS_COMPILE=/path/to/yagarto/bin/arm-none-eabi- oldconfig
+
export CCPREFIX=/path/to/your/compiler/binary/prefix-of-binary-
 +
</pre>
  
or if you used the MacPorts
+
If you are building on the RPi, remove <tt>ARCH=arm CROSS_COMPILE=${CCPREFIX}</tt> from each command.
make ARCH=arm CROSS_COMPILE=/opt/local/bin/arm-none-eabi- oldconfig
 
  
Then building the kernel:
+
Ensure that your configuration file is up-to-date:
make ARCH=arm CROSS_COMPILE=/path/to/yagarto/bin/arm-none-eabi- -k
+
<pre>
 +
make ARCH=arm CROSS_COMPILE=${CCPREFIX} oldconfig
 +
</pre>
 +
If any configuration options have been added, you will be asked what set each option to. If you don't know the answer, just press enter to accept the default.
  
or if you used the MacPorts
+
Optionally, if you want to make changes to the configuration, run this next:
make ARCH=arm CROSS_COMPILE=/opt/local/bin/arm-none-eabi- -k
+
<pre>
 +
make ARCH=arm CROSS_COMPILE=${CCPREFIX} menuconfig
 +
</pre>
  
You can use the "-j" flag to improve compilation time. If you have a dual core machine you can use "-j 3", for a quad core machine you can use "-j 6", and so on. (Don't use these for the oldconfig option because it messes up the input and output).
+
Now you are ready to build:<br>
 +
(On the Raspberry PI, type 'screen' to open a virtual screen. If you use it you can disconnect from the pi and compile overnight...)
 +
<pre>
 +
make ARCH=arm CROSS_COMPILE=${CCPREFIX}
 +
</pre>
 +
If you are on a multi-core system, you can make the build faster by appending <tt>-j<N></tt> where <tt><N></tt> is the number of cores on your system plus one (i.e. -j3 for 2 cores).
  
'''If you get an error message that elf.h is missing'''
+
Find something else to get on with while the compilation takes place. On an average PC with the default configuration, this should take about 15 minutes.
  
install [http://guide.macports.org/#installing macports]
+
The modules will be build with the following command.
install libelf and symlink to /usr/libelf:
+
<pre>
sudo port install libelf && sudo ln -s /opt/local/include/libelf /usr/include/libelf
+
make ARCH=arm CROSS_COMPILE=${CCPREFIX} modules
copy [http://opensource.apple.com/source/dtrace/dtrace-48/sys/elf.h?txt elf.h] and [http://opensource.apple.com/source/dtrace/dtrace-48/sys/elftypes.h?txt elftypes.h] to /usr/include
+
</pre>
 
 
Edit elf.h and add
 
#define R_386_NONE        0
 
#define R_386_32          1
 
#define R_386_PC32        2
 
#define R_ARM_NONE        0
 
#define R_ARM_PC24        1
 
#define R_ARM_ABS32      2
 
#define R_MIPS_NONE      0
 
#define R_MIPS_16        1
 
#define R_MIPS_32        2
 
#define R_MIPS_REL32      3
 
#define R_MIPS_26        4
 
#define R_MIPS_HI16      5
 
#define R_MIPS_LO16      6
 
  
= Final step: Making the 'kernel.img' for your Pi =
+
= Transfer the build =
 +
The fully built kernel will be <tt>arch/arm/boot/Image</tt>. Copy your new kernel file into the RPi boot partition, though preferably as a new file (such as <tt>kernel_new.img</tt>) just in case it doesn't work. If you're building on the RPi, just copy the file to <tt>/boot</tt>. If you use a different filename, edit <tt>config.txt</tt> change the kernel line:
 +
<pre>
 +
kernel=kernel_new.img
 +
#kernel=kernel.img
 +
</pre>
  
Finally you need to build a kernel.img for your Pi to boot from. For this, you need the mkimage tool from the raspberrypi github repository:
+
Now you need to transfer the modules. Set an environment variable that points to a temporary module path.
 +
<pre>
 +
export MODULES_TEMP=~/modules
 +
</pre>
  
git clone https://github.com/raspberrypi/tools
+
In the build directory, run the following command:
 +
<pre>
 +
make ARCH=arm CROSS_COMPILE=${CCPREFIX} INSTALL_MOD_PATH=${MODULES_TEMP} modules_install
 +
</pre>
  
In tools/mkimage, you'll find a python script called 'imagetool-uncompressed.py':
+
The contents of this directory, a single <pre>lib</pre> directory, should then be copied into the RPi root directory, merging or overwriting <pre>/lib</pre>
 +
NOTE: If you have rebuilt the new kernel with exactly the same version as the one that's running, you'll need to remove the old modules first. Ideally this should be done offline by mounting the SD card on another system.
  
usage : imagetool-uncompressed.py <kernel image>
+
NOTE: The lib directory will have symlinks back to the kernel sources (lib/modules/<kernel-version>/source and lib/modules/<kernel-version>/build). If you have limited space on the SD card and don't intend to compile modules on the raspberry-pi itself, you will probably want to remove those links before you transfer the lib directory. The size difference can be many hundreds of Mb.
  
After building your linux kernel, you'll find the kernel image you require in 'arch/arm/boot/Image' of the linux directory. Convert your kernel image with the script:
+
Your RPi should now be ready to boot the new kernel. However, at this point it's recommended that you update your GPU firmware and libraries. '''This is required if you've just moved from 3.2 to 3.6 as the firmware interface has changed'''.
  
python imagetool-uncompressed.py path/to/linux/arch/arm/boot/Image
+
= Get the firmware =
 +
The firmware and boot files should be updated at the same time to ensure that your new kernel works properly. Again, two branches are available:
 +
* '''master''' - This is the version of firmware currently used in Raspbian (i.e. it works with the 3.2 kernel).
 +
* '''next''' - This is a development branch which provides a newer GPU firmware to work with the updated drivers in the 3.6 kernel.
  
Then you have to transfer this img file to the /boot directory and install the compiled modules. Unfortunately the compiled modules are not in a single place, there are two options of installing them.
+
You can either download the source directly using git:
 +
You can download the firmware directly using git. For the master branch:
 +
<pre>
 +
git clone git://github.com/raspberrypi/firmware.git
 +
</pre>
 +
and for the next branch:
 +
<pre>
 +
git fetch git://github.com/raspberrypi/firmware.git next:refs/remotes/origin/next
 +
</pre>
 +
Or you can download a tarball from the website using these links: [https://github.com/raspberrypi/firmware/archive/master.tar.gz master] [https://github.com/raspberrypi/firmware/archive/next.tar.gz next]
  
Boot your RaspberryPi and mount the <code>linux</code> directory over the network using sshfs:
+
= Transfer the firmware =
cd /mnt
+
Firstly, update the required boot files in the RPi <tt>boot</tt> directory with those you've downloaded. These are:
mkdir linux
+
* bootcode.bin
mount <user>@<host>:<path/to/linux>
+
* fixup.dat
cd linux
+
* start.elf
make modules_install
 
  
If that is not an option, you can also install the modules into a temporary folder:
+
Next, you need to copy the VC libraries over. There are two copies of this: one for hard float and one for soft float. To find the correct one, run the following command:
mkdir /tmp/modules
+
<pre>
make ARCH=arm modules_install INSTALL_MOD_PATH=/tmp/modules
+
${CCPREFIX}gcc -v 2>&1 | grep hard
 +
</pre>
  
Now you have to copy the contents of that directory to /lib/modules on the SD card.
+
If something prints out, and you can see <tt>--with-float=hard</tt>, you need the hard float ones. NOTE: The current version of Raspbian uses hard float.
  
Once you've done those two steps, you are ready to put the SD card in and try booting your new system!
+
Remove the <tt>/opt/vc</tt> directory from the RPi root, then:
 +
* For hard float, copy <tt>vc</tt> from the <tt>hardfp/opt</tt> directory into <tt>/opt</tt> in the RPi root directory
 +
* Otherwise copy <tt>vc</tt> from the top-level <tt>opt</tt> directory into <tt>/opt</tt> in the RPi root directory.
  
 +
Note: The hard float vs soft float here refers only to the kernel itself, not the functionality it provides. Your applications will still be able to use hard floats.  The kernel doesn't use floats anyway it is not something to worry about as long as you select the correct <tt>vc</tt> directory to copy.
  
 +
= Test your build =
 +
Power cycle your RPi and check the following:
 +
* If you have the serial port on the GPIO expander wired up, you should see the kernel booting.
 +
* The screen works - the kernel boots and you get a login prompt.
 +
* The VC interface is working - if the 'OK' LED flashes regularly eight or so times every few seconds once the OS has booted, it's not. You can also test this by running <tt>vcgencmd measure_temp</tt>. If it prints "VCHI initialization failed", you have the a mismatch between the firmware, the VC libraries, and the kernel driver.
 +
* Run <tt>uname -a</tt> and check that your new kernel is the one that's running.
 +
* Make sure you don't have any odd error messages during boot that may indicate a module isn't working properly. If you see <tt>missed completion of cmd 18</tt> regarding DMA transfers to the SD card, you can safely ignore it.
  
 
{{Template:Raspberry Pi}}
 
{{Template:Raspberry Pi}}
[[Category: RaspberryPi]]
+
[[Category:RaspberryPi]]

Revision as of 09:34, 5 April 2014

Back to the Hub.


Software & Distributions:

Software - an overview.

Distributions - operating systems and development environments for the Raspberry Pi.

Kernel Compilation - advice on compiling a kernel.

Performance - measures of the Raspberry Pi's performance.

Programming - programming languages that might be used on the Raspberry Pi.

Overview

This page explains how to rebuild the kernel image for the RPi. There are two possible routes available:

  1. Compile on the Raspberry Pi itself
  2. Cross compile on another Linux system

Both of these routes are covered below, however, you are strongly recommended to follow the cross compilation route. The low processing power of the RPi means that a local compile will take many hours. A compilation of the latest kernel and modules took about 752 minutes (12h:30m)!

If you want to compile an upstream kernel, rather than the Raspberry Pi Foundation's downstream kernel, please see RPi_Upstream_Kernel_Compilation for a few tips.

Example Checklist/Roadmap

This section serves to hold a new user's hand just a bit more than some of the other more generic information below in the document. To get more information on the steps in the roadmap, search this page for additional details. It assumes you can navigate filesystems, move files across systems, and have a general understanding of compiling linux kernels, filesystems, partitions, and block devices.

This series of steps yielded a successful custom/updated hardfp kernel to a stock Raspbian installation, cross compiled from an amd64 Debian system without regression on any kernel configuration options or requiring modified boot parameters. Be aware that in the worst case, you may need to overlay a stock set of kernel/modules/firmware on the Raspberry Pi if something fails. If you do not know how to do this, then a reimage of the SD card may be necessary. Assuming this is not an issue for your configuration, continue onward:

  1. Get the latest raspberrypi kernel source (https://github.com/raspberrypi/linux)
  2. Set an environment variable KERNEL_SRC to point to the location of the source ( e.g. KERNEL_SRC=/home/me/linux/ )
  3. Get the latest raspberrypi compiler (git clone https://github.com/raspberrypi/tools)
  4. Set an environment variable CCPREFIX to point to the location of tools ( e.g. CCPREFIX=/home/me/tools/arm-bcm2708/arm-bcm2708-linux-gnueabi/bin/arm-bcm2708-linux-gnueabi- )
  5. From the kernel clone location, clean the kernel source with "make mrproper"
  6. Pull the /proc/config.gz from the running Raspbian installation
  7. Prime kernel with the old config by running "ARCH=arm CROSS_COMPILE=${CCPREFIX} make oldconfig"
  8. Modify the kernel config by either modifying the .config file or using "ARCH=arm CROSS_COMPILE=${CCPREFIX} make menuconfig"
  9. Build the new kernel by using "ARCH=arm CROSS_COMPILE=${CCPREFIX} make"
  10. Set an environment variable MODULES_TEMP to point to the location of the source ( e.g. MODULES_TEMP=/home/me/modules/ )
  11. Set aside the new kernel modules by using "ARCH=arm CROSS_COMPILE=${CCPREFIX} INSTALL_MOD_PATH=${MODULES_TEMP} make modules_install"
  12. From the tools clone location, in the mkimage directory, run "./imagetool-uncompressed.py ${KERNEL_SRC}/arch/arm/boot/zImage"
  13. Move the resulting kernel.img to the Raspberry Pi's /boot/ directory
  14. Package up the modules into an archive such that at the top level, the structure looks like this:
    • ./firmware
    • ./firmware/brcm
    • ./firmware/edgeport
    • ./firmware/emi26
    • ...
    • ./modules
    • ./modules/3.6.11+
    • ./modules/3.6.11+/kernel
    • ./modules/3.6.11+/kernel/lib
    • ./modules/3.6.11+/kernel/fs
    • ...
  15. Move the modules archive to the Raspberry Pi and extract them such that the aforementioned firmware and modules directories overwrite /lib/firmware and /lib/modules
  16. Get the latest raspberrypi firmware (git://github.com/raspberrypi/firmware.git)
  17. Transfer the following files from the firmware/boot directory to the Raspberry pi /boot directory:
    • bootcode.bin
    • fixup.dat
    • start.elf
  18. Transfer the firmware/hardfp/opt directory to the Raspberry pi /opt directory
  19. Reboot the Raspberry Pi

The Raspberry Pi should now boot with the newly configured/recompiled kernel.

Get the kernel source

The kernel source should be downloaded from the RPI linux section on GitHub. Although you could just compile the vanilla kernel from Kernel.org, it will not have the necessary drivers and modules for the Broadcom SoC on the RPi. You can however apply patches from the vanilla kernel to the RPi one - be prepared for potential compiler grumbles though!

Jan '14 the current is rpi-3.10.y, you can check this and other available versions by browsing RPI linux section on GitHub

You can download the source directly using git. For the 3.10 branch:

git init
git clone --depth 1 git://github.com/raspberrypi/linux.git

and for the other Stable Code branch change the numbers in the following to suit:

git init
git fetch git://github.com/raspberrypi/linux.git rpi-3.6.y:refs/remotes/origin/rpi-3.6.y
git checkout rpi-3.6.y

Or you can download a tarball from the same website:

Get a compiler

Next, you will need to get a version of GCC in order to build the kernel.

1. On the RPi

Raspbian and PiBang

apt-get update
apt-get -y dist-upgrade
apt-get -y install gcc make bc screen ncurses-dev

Arch Linux

pacman -Syu
pacman -S gcc make

OpenSuSE Linux

Detailed OpenSuSE RPI 12.3 Image 20130407 + 3.8.8 kernel hack tutorial witten ( 22042013 updated ) see: http://www.raspberrypi.org/phpBB3/viewtopic.php?f=87&t=40664&p=331953#p331953 Kernel Compile takes ~22H on RPI Model B due massive module compiles , Include all IP_VS , ARPD , Fuse-zfs , Zram and more :-)

This works as well for Debian , Fedora remix and others ( just package Install command differ )

zypper install u-boot-tools sudo gcc automake autoconf bison gettext flex libncurses5 ncurses-devel
cd /usr/src
mkdir GIT; cd GIT; git init; D=`date +"%m-%d-%Y"`
git fetch git://github.com/raspberrypi/linux.git rpi-3.8.y:refs/remotes/origin/rpi-3.8.y
git checkout rpi-3.8.y
tar cpf rpi-3.8.y.$D.tar   rpi-3.8.y

cd /usr/src
tar xpf  GIT/rpi-3.8.y.$D.tar
rm linux
ln -s linux-rpi-3.8.y linux

cd /usr/src/linux
kversion=$(make -s kernelrelease)
cp linux/.config .config_$kversion

cd /usr/src/
# get config-3.8.7.ipvs+krb5+arpd.tar.bz2 from the Tutorial:
wget http://www.raspberrypi.org/phpBB3/download/file.php?id=3174
# copy the .config to /usr/src/linux: 
tar xpfj config-3.8.7.ipvs+krb5+arpd.tar.bz2


#make the Kernel and go sleep :-)
cd linux
make oldconfig
nohup make zImage dep modules &

#Next day .. Install It.
cd /usr/src/linux
kversion=$(make -s kernelrelease)
echo $kversion
mkdir -p  /boot/$kversion
make ARCH=arm INSTALL_PATH=/boot/ install
cp System.map /boot/System.map-$kversion
cp System.map-$kversion /boot/System.map
make ARCH=arm modules_install INSTALL_MOD_PATH=/
make ARCH=arm INSTALL_PATH=/boot/ zinstall
cp .config /boot/config-$kversion
cp ./Module.symvers  /boot/symvers-$kversion
cp arch/arm/boot/Image /boot/kernel.img

2. Cross compiling from Linux

Please note that when cross-compiling, your compiler may not target the correct ARM processor by default. This will at best reduce performance, or worse, compile for a much newer processor resulting in illegal instructions in your code. The pre-built compiler or a custom-built compiler are recommended because of this. (For example, the latest GCC Linaro binary targets armv7-a by default, whereas the RPi requires armv6kz). It is possible to add extra compiler options to the HOSTCFLAGS line in Makefile. The correct flags are shown on the software page - note that you may also need to add -marm if your compiler produces Thumb code by default.

Use the provided compiler

Download the pre-built bmc2708 compiler from the RPI tools section on GitHub.

git clone git://github.com/raspberrypi/tools.git

or you can download a tarball from the website using this link.

Custom-built Linaro GCC

See Linaro GCC Compilation.

Ubuntu

apt-get install gcc-arm-linux-gnueabi make ncurses-dev

Gentoo Linux

crossdev -S -v -t arm-unknown-linux-gnueabi

Crossdev should create a cross-toolchain using the latest stable versions of the required packages. If it fails, you can specify exact versions by removing the "-S" flag and adding the "--b", "--g", "--k" and "--l" flags. On 2012-05-06, cross -S -v -A gnueabi arm works just fine.

Arch Linux

yaourt -S arm-linux-gnueabi-gcc

Cross compiling from OSX

Macports

The Kernel source requires a case-sensitive filesystem. If you do not have a HFS+ Case-sensitive partition that can be used, create a disk image with the appropriate format. Ensure latest Xcode and command line tools are installed from Apple Developer Connection Install macports

port install arm-none-eabi-gcc
port install arm-none-eabi-binutils

If you get an error message that elf.h is missing

sudo port install libelf && sudo ln -s /opt/local/include/libelf /usr/include/libelf

From opensource.apple.com, download and copy elf.h and elftypes.h to /usr/include

Edit elf.h and add

#define R_386_NONE        0
#define R_386_32          1
#define R_386_PC32        2
#define R_ARM_NONE        0
#define R_ARM_PC24        1
#define R_ARM_ABS32       2
#define R_MIPS_NONE       0
#define R_MIPS_16         1
#define R_MIPS_32         2
#define R_MIPS_REL32      3
#define R_MIPS_26         4
#define R_MIPS_HI16       5
#define R_MIPS_LO16       6

If you get a "SEGMENT_SIZE is undeclared" error open the Makefile and change the line:

NOSTDINC_FLAGS += -nostdinc -isystem $(shell $(CC) -print-file-name=include)

to

NOSTDINC_FLAGS += -nostdinc -isystem $(shell $(CC) -print-file-name=include) -Dlinux

Complete script requires raspberrypi.config to be in the same folder that you execute from

sudo port install arm-none-eabi-gcc
sudo port install arm-none-eabi-binutils
sudo port install libelf && sudo ln -s /opt/local/include/libelf /usr/include/libelf
sudo curl http://opensource.apple.com/source/dtrace/dtrace-48/sys/elftypes.h?txt -o  /usr/include/elftypes.h
sudo curl http://opensource.apple.com/source/dtrace/dtrace-48/sys/elf.h?txt -o /usr/include/elf.h
#code to append to elf.h
echo "
#define R_386_NONE 0
#define R_386_32 1
#define R_386_PC32 2
#define R_ARM_NONE 0
#define R_ARM_PC24 1
#define R_ARM_ABS32 2
#define R_MIPS_NONE 0
#define R_MIPS_16 1
#define R_MIPS_32 2
#define R_MIPS_REL32 3
#define R_MIPS_26 4
#define R_MIPS_HI16 5
#define R_MIPS_LO16 6" > elf-append.h
sudo -s 'cat elf-append.h >> /usr/include/elf.h'

#Make a case sensitive 3gb disk image, raspberrypi-kernel, and attach it
hdiutil create -size 10g -type SPARSEBUNDLE -nospotlight -volname raspberrypi-kernel -fs "Case-sensitive Journaled HFS+" -attach ./raspberrypi-kernel.dmg
cp raspberrypi.config /Volumes/raspberrypi-kernel/
mkdir /Volumes/raspberrypi-kernel/src
cd /Volumes/raspberrypi-kernel/src

#get source, either 1. from zip (faster), or 2. from git
#1. from zip
curl https://codeload.github.com/raspberrypi/linux/zip/rpi-3.6.y -o ./rpi-3.6.y.zip
unzip rpi-3.6.y.zip
#2. from git (disabled)
#git init
#git fetch git://github.com/raspberrypi/linux.git rpi-3.6.y:refs/remotes/origin/rpi-3.6.y
#git checkout rpi-3.6.y

cpu=$(sysctl hw.ncpu | awk '{print $2}')
cpup1=$((cpu+1))

cd /Volumes/raspberrypi-kernel/src/linux-rpi-3.6.y/
export CCPREFIX=/opt/local/bin/arm-none-eabi-
make mrproper
cp /Volumes/raspberrypi-kernel/raspberrypi.config .config
#answer yes to all config options
#yes "" | make ARCH=arm CROSS_COMPILE=${CCPREFIX} oldconfig
make ARCH=arm CROSS_COMPILE=${CCPREFIX} -j$cpup1
#make ARCH=arm CROSS_COMPILE=${CCPREFIX} modules -j$cpup1

Yagarto

Download and install from here.

Perform the compilation

Firstly, ensure your build directory is clean:

make mrproper

Next, in all cases, you will want to get a working kernel configuration to start from. You can get the one running on the RPi by typing the following (on the RPi):

zcat /proc/config.gz > .config

then copy .config into your build directory.

Alternatively, the default configuration is available in the downloaded kernel source in arch/arm/configs/bcmrpi_defconfig. Just copy this to .config in the build directory.

From this point on, if you are cross-compiling, set an environment variable CCPREFIX that points to the prefix of your compiler binary as each compiler will be named slightly differently.

export CCPREFIX=/path/to/your/compiler/binary/prefix-of-binary-

If you are building on the RPi, remove ARCH=arm CROSS_COMPILE=${CCPREFIX} from each command.

Ensure that your configuration file is up-to-date:

make ARCH=arm CROSS_COMPILE=${CCPREFIX} oldconfig

If any configuration options have been added, you will be asked what set each option to. If you don't know the answer, just press enter to accept the default.

Optionally, if you want to make changes to the configuration, run this next:

make ARCH=arm CROSS_COMPILE=${CCPREFIX} menuconfig

Now you are ready to build:
(On the Raspberry PI, type 'screen' to open a virtual screen. If you use it you can disconnect from the pi and compile overnight...)

make ARCH=arm CROSS_COMPILE=${CCPREFIX}

If you are on a multi-core system, you can make the build faster by appending -j<N> where <N> is the number of cores on your system plus one (i.e. -j3 for 2 cores).

Find something else to get on with while the compilation takes place. On an average PC with the default configuration, this should take about 15 minutes.

The modules will be build with the following command.

make ARCH=arm CROSS_COMPILE=${CCPREFIX} modules

Transfer the build

The fully built kernel will be arch/arm/boot/Image. Copy your new kernel file into the RPi boot partition, though preferably as a new file (such as kernel_new.img) just in case it doesn't work. If you're building on the RPi, just copy the file to /boot. If you use a different filename, edit config.txt change the kernel line:

kernel=kernel_new.img
#kernel=kernel.img

Now you need to transfer the modules. Set an environment variable that points to a temporary module path.

export MODULES_TEMP=~/modules

In the build directory, run the following command:

make ARCH=arm CROSS_COMPILE=${CCPREFIX} INSTALL_MOD_PATH=${MODULES_TEMP} modules_install

The contents of this directory, a single

lib

directory, should then be copied into the RPi root directory, merging or overwriting

/lib

NOTE: If you have rebuilt the new kernel with exactly the same version as the one that's running, you'll need to remove the old modules first. Ideally this should be done offline by mounting the SD card on another system.

NOTE: The lib directory will have symlinks back to the kernel sources (lib/modules/<kernel-version>/source and lib/modules/<kernel-version>/build). If you have limited space on the SD card and don't intend to compile modules on the raspberry-pi itself, you will probably want to remove those links before you transfer the lib directory. The size difference can be many hundreds of Mb.

Your RPi should now be ready to boot the new kernel. However, at this point it's recommended that you update your GPU firmware and libraries. This is required if you've just moved from 3.2 to 3.6 as the firmware interface has changed.

Get the firmware

The firmware and boot files should be updated at the same time to ensure that your new kernel works properly. Again, two branches are available:

  • master - This is the version of firmware currently used in Raspbian (i.e. it works with the 3.2 kernel).
  • next - This is a development branch which provides a newer GPU firmware to work with the updated drivers in the 3.6 kernel.

You can either download the source directly using git: You can download the firmware directly using git. For the master branch:

git clone git://github.com/raspberrypi/firmware.git

and for the next branch:

git fetch git://github.com/raspberrypi/firmware.git next:refs/remotes/origin/next

Or you can download a tarball from the website using these links: master next

Transfer the firmware

Firstly, update the required boot files in the RPi boot directory with those you've downloaded. These are:

  • bootcode.bin
  • fixup.dat
  • start.elf

Next, you need to copy the VC libraries over. There are two copies of this: one for hard float and one for soft float. To find the correct one, run the following command:

${CCPREFIX}gcc -v 2>&1 | grep hard

If something prints out, and you can see --with-float=hard, you need the hard float ones. NOTE: The current version of Raspbian uses hard float.

Remove the /opt/vc directory from the RPi root, then:

  • For hard float, copy vc from the hardfp/opt directory into /opt in the RPi root directory
  • Otherwise copy vc from the top-level opt directory into /opt in the RPi root directory.

Note: The hard float vs soft float here refers only to the kernel itself, not the functionality it provides. Your applications will still be able to use hard floats. The kernel doesn't use floats anyway it is not something to worry about as long as you select the correct vc directory to copy.

Test your build

Power cycle your RPi and check the following:

  • If you have the serial port on the GPIO expander wired up, you should see the kernel booting.
  • The screen works - the kernel boots and you get a login prompt.
  • The VC interface is working - if the 'OK' LED flashes regularly eight or so times every few seconds once the OS has booted, it's not. You can also test this by running vcgencmd measure_temp. If it prints "VCHI initialization failed", you have the a mismatch between the firmware, the VC libraries, and the kernel driver.
  • Run uname -a and check that your new kernel is the one that's running.
  • Make sure you don't have any odd error messages during boot that may indicate a module isn't working properly. If you see missed completion of cmd 18 regarding DMA transfers to the SD card, you can safely ignore it.