Editing Documentation/Maemo 5 Developer Guide/Kernel and Debugging Guide/Maemo Kernel Guide

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

Learn more about Contributing to the wiki.

This chapter describes how to configure, compile and flash the Linux kernel for the Internet Tablet device. The chapter is targeted at developers wishing to compile their own custom kernels for the device.

== Prerequisites ==

Before starting, set up the Maemo environment. The required GCC toolchain that is used to compile the kernel is included in Scratchbox by default.

Setting up a separate target for kernel compilation is not mandatory, but this example does it in case the default armel target has been modified in some way.

<ul>
<li>Start Scratchbox.</li>

<li><pre>
$ scratchbox
</pre></li>

<li>
Create a new target called MaemoKernel with qemu-arm CPU transparency. The second command installs the armel rootstraps to the target. The last command installs the C-library, /etc, devkits and fakeroot.
</li>

<li><pre>
[sbox-FREMANTLE_ARMEL: ~] > sb-conf setup MaemoKernel \
-c cs2007q3-glibc2.5-arm7 \
-d qemu:perl:svn:apt-https -t /scratchbox/devkits/qemu/bin/qemu-arm-sb
[sbox-FREMANTLE_ARMEL: ~] > sb-conf select MaemoKernel
[sbox-MaemoKernel: ~] > sb-conf rs MaemoKernel \
/home/&lt;username&gt;/maemo-sdk-rootstrap_5.0_armel.tgz
[sbox-MaemoKernel: ~] > sb-conf in MaemoKernel -edFL
</pre></li>
</ul>

{{ambox|text=The <username> above refers to your login name in the environment. If you have used the Maemo installer, the rootstraps are under your home directory. If you have performed a manual installation, the rootstrap is under the /scratchbox/packages directory. Keep this in mind when running the sb-conf command above.}}

<ul>
<li>
Verify that the sources.list file inside the Scratchbox environment is correct. If the below lines are not in the /etc/apt/sources.list file, add them there.
</li>

<li><pre>
deb http://repository.maemo.org/ fremantle/sdk free non-free
deb-src http://repository.maemo.org/ fremantle/sdk free

deb http://repository.maemo.org/ fremantle/tools free non-free
deb-src http://repository.maemo.org/ fremantle/tools free
</pre></li>

<li>Create a working directory (inside Scratchbox) for the kernel sources.</li>
 
<li><pre>[sbox-MaemoKernel: ~] &gt; mkdir ~/maemo_kernel</pre></li>
</ul>

The Scratchbox environment is now ready for compiling the kernel.

== Getting Kernel Sources ==

Kernel sources are not included in the rootstrap. Therefore, you need to download them from the repository.

<ul>
<li>Select the kernel compilation target, if not selected already.</li>
 
<li><pre>
[sbox-FREMANTLE_ARMEL: ~] > sb-conf select MaemoKernel
</pre></li>

<li>Update the package database. This requires the earlier modifications in the sources.list file.</li>
 
<li><pre>
[sbox-MaemoKernel: ~] > fakeroot apt-get update
</pre></li>

<li>Go to the working directory and fetch the sources.</li>
 
<li><pre>
[sbox-MaemoKernel: ~] > cd ~/maemo_kernel
[sbox-MaemoKernel: ~/maemo_kernel ] > apt-get source kernel
</pre></li>
</ul>

Kernel sources should now be fetched and ready to be compiled.

== Configuring Source Tree and Compiling Kernel ==

<ul>
<li>A source subdirectory is listed. Enter the directory and create the default configuration.</li>

<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel ] > cd kernel-2.6.28
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > make EXTRAVERSION=-omap1 rx51_defconfig
 # lots of output from make program...
</pre></li>

<li>Compile the kernel image and check the image file timestamp to ensure that it is properly created.</li>

<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] &gt; make EXTRAVERSION=-omap1 bzImage
# compilation output...
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] &gt; ls -l arch/arm/boot/zImage
-rwxrwxr-x  1 maemo maemo 1717620 Jul 29 18:10 arch/arm/boot/zImage
</pre></li>
</ul>

{{ambox|text=The kernel is very strict on versions. <code>EXTRAVERSION=-omap1</code> sets the version to match the default installation. Instead of always supplying it to the <code>make</code> command, as done in this chapter, it is possible to modify the kernel <code>Makefile</code>. Another alternative is to avoid using <code>make</code> directly and use <code>dpkg-buildpackage -rfakeroot -b</code> to compile the kernel.}}

Now the device can be flashed with the new kernel image using the Flasher tool. This must be performed outside Scratchbox. For short instructions on flashing, see the [[Documentation/Maemo 5 Developer Guide/Development Environment/Maemo Flasher-3.5|Flashing Kernel]] section.

== Changing Default Kernel Configuration ==

The following steps describe how to change the default kernel configuration.

<ul>
<li>Restore the original default configuration, just in case it has been changed.</li>
 
<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > make EXTRAVERSION=-omap1 \
rx51_defconfig
</pre></li>

<li>Edit the configuration file with your chosen editor. Editing the file is OK even though the system warns against it.</li>
 
<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > vi .config
</pre></li>

<li>Include your changes for compilation.</li>

<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > make EXTRAVERSION=-omap1 oldconfig
</pre></li>
</ul>

Now a kernel image with modified configuration can be recompiled.

If you have a local repository, by default extra information will be appended to the kernel version. This will stop the kernel version from matching the default install.  To keep it from doing so, change scripts/setlocalversion to add "exit" to the beginning:
<source lang="bash">
#!/bin/sh
# Print additional version information for non-release trees.
exit
</source>

== Compiling External Kernel Modules ==

In this section, a simple external, or out-of-tree, kernel module is built against the kernel-headers. This is the recommended way of building new modules. A real external kernel module can be a driver for an uncommon or new device or some special service for a system, but this example code only prints some helloworlds to the kernel ring buffer.

# As before, start in the work directory. <pre>[sbox-MaemoKernel: ~/maemo_kernel] ></pre>
# Install the kernel-headers package. <pre>[sbox-MaemoKernel: ~/maemo_kernel] > fakeroot apt-get install kernel-headers</pre>

<ol start=3> 
<li> Download the example files from the Maemo svn.
<pre>
[sbox-MaemoKernel: ~/maemo_kernel] > svn export https://vcs.maemo.org/svn/\
maemoexamples/tags/maemo_5.0/hello-module/

[sbox-MaemoKernel: ~/maemo_kernel] > cd hello-module
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] > ls -l
total 32
-rw-rw-r--  1 maemo maemo 17989 Aug 28 13:59 COPYING
-rw-rw-r--  1 maemo maemo   380 Aug 28 13:59 Makefile
-rw-rw-r--  1 maemo maemo   480 Aug 28 14:23 README
-rw-rw-r--  1 maemo maemo   640 Aug 28 13:59 hello.c
</pre>

The source code for the module is very simple:
<pre>
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] > cat hello.c
/* hello-module.c, an example kernel module */

#include &lt;linux/module.h&gt; /* needed by all kernel modules */
#include &lt;linux/init.h&gt;   /* needed for custom init/exit functions */
#include &lt;linux/kernel.h&gt; /* needed for KERN_ALERT macro */

/* Special macro to indicate license (to avoid tainting the kernel) */
MODULE_LICENSE("GPLv2");

static int hello_init(void) {
  printk(KERN_ALERT "Hello, world\n"); /* top priority message */
  return 0;
}

static void hello_exit(void)
{
	printk(KERN_INFO "Goodbye, world\n");
}

/* macros to mark modules init/exit funcs (run on insmod/rmmod) */
module_init(hello_init);
module_exit(hello_exit);
</pre>

Compiling kernel modules differs from compiling normal programs. That is reflected in the <code>Makefile</code>:

<pre>
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] > cat Makefile
# Makefile for building the hello kernel module outside the kernel tree

KERNELDIR := /usr/src/kernel-headers

obj-m := hello.o

# default build target (uses kernel build (kbuild) system)
all:
	$(MAKE) -C $(KERNELDIR) M=`pwd` EXTRAVERSION=-omap1 modules

# target for cleaning up
clean:
	$(RM) *.o .depend .*.cmd *.ko *.mod.c Module.symvers modules.order
	$(RM) -R .tmp_versions
</pre>

The <code>all:</code> target compiles the module, not using this <code>Makefile</code>,
but a <code>Makefile</code> in the kernel headers folder set in variable 
<code>KERNELDIR</code>. The <code>clean:</code> target is a regular target handled in this <code>Makefile</code>.
</li>

<li>Compile the module.
<pre>
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] &gt; make
make -C /usr/src/kernel-headers M=`pwd` modules
make[1]: Entering directory `/targets/MaemoKernel/usr/src/kernel-headers'
  CC [M]  /home/maemo/maemo_kernel/hello-module/hello.o
  Building modules, stage 2.
  MODPOST 1 modules
  CC      /home/maemo/maemo_kernel/hello-module/hello.mod.o
  LD [M]  /home/maemo/maemo_kernel/hello-module/hello.ko
make[1]: Leaving directory `/targets/MaemoKernel/usr/src/kernel-headers'
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] &gt;
</pre></li>
<li> Check the results. 
<pre>
[sbox-MaemoKernel: ~/maemo_kernel/hello-module] &gt; ls -l
total 148
-rw-rw-r--  1 maemo maemo   223 Aug  6 14:51 Makefile
-rw-rw-r--  1 maemo maemo     0 Aug  6 14:51 Module.symvers
-rw-rw-r--  1 maemo maemo   692 Aug  6 14:50 hello.c
-rw-rw-r--  1 maemo maemo 64037 Aug  6 14:51 hello.ko
-rw-rw-r--  1 maemo maemo   663 Aug  6 14:51 hello.mod.c
-rw-rw-r--  1 maemo maemo 32656 Aug  6 14:51 hello.mod.o
-rw-rw-r--  1 maemo maemo 32400 Aug  6 14:51 hello.o
-rw-rw-r--  1 maemo maemo    57 Aug  6 14:51 modules.order
</pre></li>
</ol>

File <code>hello.ko</code> is the new module. Install it by copying it to the device and running it (as root)
 Nokia-NXX-31-10:/home/user# insmod hello.ko
and remove it by calling 
 Nokia-NXX-31-10:/home/user# rmmod hello.ko

Check that the module worked properly by examining the kernel ring buffer:
 
 Nokia-NXX-31-10:/home/user# dmesg | tail
 ...
 [11921.578338] Hello, world
 [11928.357696] Goodbye, world

If there is a slight version mismatch between SDK's kernel headers and the running kernel on device, <code>insmod</code> refuses to install the module with the error message <code>insmod: error inserting '<module>': -1 Invalid module format</code>. In this case, install the module by stripping version info from it before installation:
 
 [sbox-FREMANTLE_ARMEL: ~/maemo_kernel/hello-module] &gt; objcopy --strip-debug \ 
 -R .modinfo -R __versions hello.ko

For more information on kernel modules, see the following:

* [http://www.tldp.org/LDP/lkmpg/2.6/html/index.html The Linux Kernel Module Programming Guide]
* <nowiki>/scratchbox/users/&lt;username&gt;/home/&lt;username&gt;/maemo_kernel/kernel-2.6.28/Documentation/kbuild/modules.txt</nowiki>

== Compiling Internal Kernel Modules ==

This section explains how to configure and compile additional kernel modules included in the kernel source tree for the Internet Tablet in the Maemo environment. The NFSD module is used as an example. In this section, the modules are compiled against the full kernel source tree, not the kernel headers package. This example compiles all configured modules at once.

<ul>
<li>Go to your working directory with kernel sources.</li>
 
<li><pre>
[sbox-MaemoKernel:] > cd  ~/maemo_kernel/kernel-2.6.28
</pre></li>

<li> Edit the configuration file and define that the NFSD is a kernel module.</li>

<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > vi .config
</pre></li>

<li>Find the location of the NFSD configuration.</li>

<li><pre>
# CONFIG_NFSD is not set
</pre></li>

<li>Enable NFSD support as a module (m for module, Y for built-in).
 
<li><pre>
CONFIG_NFSD=m
</pre></li>

<li>As described in the previous sections, refresh the configuration and build new modules.</li>

<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > make EXTRAVERSION=-omap1 oldconfig
# lots of output here. Answer Y to NFSD_V3, default to others.
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] > make EXTRAVERSION=-omap1 modules
</pre></li>

<li>Check with the find command to see which kernel object files (extension .ko) now exist.</li>
 
<li><pre>
[sbox-MaemoKernel: ~/maemo_kernel/kernel-2.6.28] &gt; find . -name "*.ko" -ls
 655362  804 -rw-rw-r--   1 maemo maemo   817889 Aug  4 16:57 ./fs/ext2/ext2.ko
 630786  108 -rw-rw-r--   1 maemo maemo   106187 Aug  4 16:57 ./fs/exportfs/exp
ortfs.ko
1335340  144 -rw-rw-r--   1 maemo maemo   141168 Aug  4 16:57 ./fs/fat/vfat.ko
...
4595743 1328 -rw-rw-r--   1 maemo maemo  1354124 Aug  4 16:57 ./fs/nfsd/nfsd.ko
...
4074612  104 -rw-rw-r--   1 maemo maemo    98930 Aug  4 16:57 ./arch/arm/mach-o
map2/dspbridge.ko
</pre></li>
</ul>

The list of .ko files is quite long, depending on whether or not some additional changes were made to the .config file. Module <code>nfsd.ko</code> is the one just added.

The kernel modules are kept under <code>/lib/modules/</code>. However, the <code>insmod</code> command can be used to load the modules into the running kernel from any directory they have been saved in.

== Using make menuconfig ==

'make menuconfig' fails to autodetect the ncurses library available in Scratchbox and exits with an error.  If you want to use 'make menuconfig', first edit <code>scripts/kconfig/lxdialog/check-lxdialog.sh</code> and change

<pre>
# What library to link
ldflags()
{
	for ext in so a dylib ; do
</pre>

<pre>
# What library to link
ldflags()
{
	# XXX autodetection fails in scratchbox
	echo -lncurses
	exit
	for ext in so a dylib ; do
</pre>

== Flashing Kernel ==

You can flash the custom kernel from outside Scratchbox with the flasher tool using USB.

# flasher-3.5 -f -k /scratchbox/users/&lt;username&gt;/home/&lt;username&gt;/\
 maemo_kernel/kernel-2.6.28/arch/arm/boot/zImage

== Testing kernel ==

It is possible to try the custom kernel without flashing it by temporarily changing arch/arm/plat-omap/bootreason.c as follows:

<pre>
	//	len += sprintf(page + len, "%s\n", boot_reason);
	len += sprintf(page + len, "pwr_key\n");
</pre>

For the flasher tool, use

# flasher-3.5 -l -b -k /scratchbox/users/&lt;username&gt;/home/&lt;username&gt;/\
 maemo_kernel/kernel-2.6.28/arch/arm/boot/zImage

[[Category:Development]]
[[Category:Documentation]]
[[Category:Fremantle]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Templates used on this page:

Template:Ambox (view source) (semi-protected)

Retrieved from "http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Kernel_and_Debugging_Guide/Maemo_Kernel_Guide"

Personal tools

Navigation

Views

Editing Documentation/Maemo 5 Developer Guide/Kernel and Debugging Guide/Maemo Kernel Guide