fix a few overfull hboxes, remove some redundant stuff
[openwrt/openwrt.git] / docs / build.tex
1 One of the biggest challenges to getting started with embedded devices is that you
2 cannot just install a copy of Linux and expect to be able to compile a firmware.
3 Even if you did remember to install a compiler and every development tool offered,
4 you still would not have the basic set of tools needed to produce a firmware image.
5 The embedded device represents an entirely new hardware platform, which is
6 most of the time incompatible with the hardware on your development machine, so in a process called
7 cross compiling you need to produce a new compiler capable of generating code for
8 your embedded platform, and then use it to compile a basic Linux distribution to
9 run on your device.
10
11 The process of creating a cross compiler can be tricky, it is not something that is
12 regularly attempted and so there is a certain amount of mystery and black magic
13 associated with it. In many cases when you are dealing with embedded devices you will
14 be provided with a binary copy of a compiler and basic libraries rather than
15 instructions for creating your own -- it is a time saving step but at the same time
16 often means you will be using a rather dated set of tools. Likewise, it is also common
17 to be provided with a patched copy of the Linux kernel from the board or chip vendor,
18 but this is also dated and it can be difficult to spot exactly what has been
19 modified to make the kernel run on the embedded platform.
20
21 \subsection{Building an image}
22
23 OpenWrt takes a different approach to building a firmware; downloading, patching
24 and compiling everything from scratch, including the cross compiler. To put it
25 in simpler terms, OpenWrt does not contain any executables or even sources, it is an
26 automated system for downloading the sources, patching them to work with the given
27 platform and compiling them correctly for that platform. What this means is that
28 just by changing the template, you can change any step in the process.
29
30 As an example, if a new kernel is released, a simple change to one of the Makefiles
31 will download the latest kernel, patch it to run on the embedded platform and produce
32 a new firmware image -- there is no work to be done trying to track down an unmodified
33 copy of the existing kernel to see what changes had been made, the patches are
34 already provided and the process ends up almost completely transparent. This does not
35 just apply to the kernel, but to anything included with OpenWrt -- It is this one
36 simple understated concept which is what allows OpenWrt to stay on the bleeding edge
37 with the latest compilers, latest kernels and latest applications.
38
39 So let's take a look at OpenWrt and see how this all works.
40
41
42 \subsubsection{Download OpenWrt}
43
44 This article refers to the "Kamikaze" branch of OpenWrt, which can be downloaded via
45 subversion using the following command:
46
47 \begin{Verbatim}
48 $ svn checkout https://svn.openwrt.org/openwrt/trunk kamikaze
49 \end{Verbatim}
50
51 Additionally, there is a trac interface on \href{https://dev.openwrt.org/}{https://dev.openwrt.org/}
52 which can be used to monitor svn commits and browse the source repository.
53
54
55 \subsubsection{The directory structure}
56
57 There are four key directories in the base:
58
59 \begin{itemize}
60 \item \texttt{tools}
61 \item \texttt{toolchain}
62 \item \texttt{package}
63 \item \texttt{target}
64 \end{itemize}
65
66 \texttt{tools} and \texttt{toolchain} refer to common tools which will be
67 used to build the firmware image, the compiler, and the C library.
68 The result of this is three new directories, \texttt{tool\_build}, which is a temporary
69 directory for building the target independent tools, \texttt{toolchain\_build\_\textit{<arch>}}
70 which is used for building the toolchain for a specific architecture, and
71 \texttt{staging\_dir\_\textit{<arch>}} where the resulting toolchain is installed.
72 You will not need to do anything with the toolchain directory unless you intend to
73 add a new version of one of the components above.
74
75 \begin{itemize}
76 \item \texttt{tool\_build}
77 \item \texttt{toolchain\_build\_\textit{<arch>}}
78 \end{itemize}
79
80 \texttt{package} is for exactly that -- packages. In an OpenWrt firmware, almost everything
81 is an \texttt{.ipk}, a software package which can be added to the firmware to provide new
82 features or removed to save space. Note that packages are also maintained outside of the main
83 trunk and can be obtained from subversion at the following location:
84
85 \begin{Verbatim}
86 $ svn checkout https://svn.openwrt.org/openwrt/packages packages
87 \end{Verbatim}
88
89 Those packages can be used to extend the functionality of the build system and need to be
90 symlinked into the main trunk. Once you do that, the packages will show up in the menu for
91 configuration. From kamikaze you would do something like this:
92
93 \begin{Verbatim}
94 $ ls
95 kamikaze packages
96 $ ln -s packages/net/nmap kamikaze/package/nmap
97 \end{Verbatim}
98
99 To include all packages, issue the following command:
100
101 \begin{Verbatim}
102 $ ln -s packages/*/* kamikaze/package/
103 \end{Verbatim}
104
105 \texttt{target} refers to the embedded platform, this contains items which are specific to
106 a specific embedded platform. Of particular interest here is the "\texttt{target/linux}"
107 directory which is broken down by platform \textit{<arch>} and contains the patches to the
108 kernel, profile config, for a particular platform. There's also the "\texttt{target/image}" directory
109 which describes how to package a firmware for a specific platform.
110
111 Both the target and package steps will use the directory "\texttt{build\_\textit{<arch>}}"
112 as a temporary directory for compiling. Additionally, anything downloaded by the toolchain,
113 target or package steps will be placed in the "\texttt{dl}" directory.
114
115 \begin{itemize}
116 \item \texttt{build\_\textit{<arch>}}
117 \item \texttt{dl}
118 \end{itemize}
119
120 \subsubsection{Building OpenWrt}
121
122 While the OpenWrt build environment was intended mostly for developers, it also has to be
123 simple enough that an inexperienced end user can easily build his or her own customized firmware.
124
125 Running the command "\texttt{make menuconfig}" will bring up OpenWrt's configuration menu
126 screen, through this menu you can select which platform you're targeting, which versions of
127 the toolchain you want to use to build and what packages you want to install into the
128 firmware image. Note that it will also check to make sure you have the basic dependencies for it
129 to run correctly. If that fails, you will need to install some more tools in your local environment
130 before you can begin.
131
132 Similar to the linux kernel config, almost every option has three choices,
133 \texttt{y/m/n} which are represented as follows:
134
135 \begin{itemize}
136 \item{\texttt{<*>} (pressing y)} \\
137 This will be included in the firmware image
138 \item{\texttt{<M>} (pressing m)} \\
139 This will be compiled but not included (for later install)
140 \item{\texttt{< >} (pressing n)} \\
141 This will not be compiled
142 \end{itemize}
143
144 After you've finished with the menu configuration, exit and when prompted, save your
145 configuration changes.
146
147 If you want, you can also modify the kernel config for the selected target system.
148 simply run "\texttt{make kernel\_menuconfig}" and the build system will unpack the kernel sources
149 (if necessary), run menuconfig inside of the kernel tree, and then copy the kernel config
150 to \texttt{target/linux/\textit{<platform>}/config} so that it is preserved over
151 "\texttt{make clean}" calls.
152
153 To begin compiling the firmware, type "\texttt{make}". By default
154 OpenWrt will only display a high level overview of the compile process and not each individual
155 command.
156
157 \subsubsection{Example:}
158
159 \begin{Verbatim}
160 make[2] toolchain/install
161 make[3] -C toolchain install
162 make[2] target/compile
163 make[3] -C target compile
164 make[4] -C target/utils prepare
165
166 [...]
167 \end{Verbatim}
168
169 This makes it easier to monitor which step it's actually compiling and reduces the amount
170 of noise caused by the compile output. To see the full output, run the command
171 "\texttt{make V=99}".
172
173 During the build process, buildroot will download all sources to the "\texttt{dl}"
174 directory and will start patching and compiling them in the "\texttt{build\_\textit{<arch>}}"
175 directory. When finished, the resulting firmware will be in the "\texttt{bin}" directory
176 and packages will be in the "\texttt{bin/packages}" directory.
177
178
179 \subsection{Creating packages}
180
181 One of the things that we've attempted to do with OpenWrt's template system is make it
182 incredibly easy to port software to OpenWrt. If you look at a typical package directory
183 in OpenWrt you'll find two things:
184
185 \begin{itemize}
186 \item \texttt{package/\textit{<name>}/Makefile}
187 \item \texttt{package/\textit{<name>}/patches}
188 \item \texttt{package/\textit{<name>}/files}
189 \end{itemize}
190
191 The patches directory is optional and typically contains bug fixes or optimizations to
192 reduce the size of the executable. The package makefile is the important item, provides
193 the steps actually needed to download and compile the package.
194
195 The files directory is also optional and typicall contains package specific startup scripts or default configuration files that can be used out of the box with OpenWrt.
196
197 Looking at one of the package makefiles, you'd hardly recognize it as a makefile.
198 Through what can only be described as blatant disregard and abuse of the traditional
199 make format, the makefile has been transformed into an object oriented template which
200 simplifies the entire ordeal.
201
202 Here for example, is \texttt{package/bridge/Makefile}:
203
204 \begin{Verbatim}[frame=single,numbers=left]
205 # $Id: Makefile 5624 2006-11-23 00:29:07Z nbd $
206
207 include $(TOPDIR)/rules.mk
208
209 PKG_NAME:=bridge
210 PKG_VERSION:=1.0.6
211 PKG_RELEASE:=1
212
213 PKG_SOURCE:=bridge-utils-$(PKG_VERSION).tar.gz
214 PKG_SOURCE_URL:=@SF/bridge
215 PKG_MD5SUM:=9b7dc52656f5cbec846a7ba3299f73bd
216 PKG_CAT:=zcat
217
218 PKG_BUILD_DIR:=$(BUILD_DIR)/bridge-utils-$(PKG_VERSION)
219
220 include $(INCLUDE_DIR)/package.mk
221
222 define Package/bridge
223 SECTION:=net
224 CATEGORY:=Base system
225 TITLE:=Ethernet bridging configuration utility
226 URL:=http://bridge.sourceforge.net/
227 endef
228
229 define Package/bridge/description
230 Manage ethernet bridging:
231 a way to connect networks together to form a larger network.
232 endef
233
234 define Build/Configure
235 $(call Build/Configure/Default, \
236 --with-linux-headers="$(LINUX_DIR)" \
237 )
238 endef
239
240 define Package/bridge/install
241 $(INSTALL_DIR) $(1)/usr/sbin
242 $(INSTALL_BIN) $(PKG_BUILD_DIR)/brctl/brctl $(1)/usr/sbin/
243 endef
244
245 $(eval $(call BuildPackage,bridge))
246 \end{Verbatim}
247
248 As you can see, there's not much work to be done; everything is hidden in other makefiles
249 and abstracted to the point where you only need to specify a few variables.
250
251 \begin{itemize}
252 \item \texttt{PKG\_NAME} \\
253 The name of the package, as seen via menuconfig and ipkg
254 \item \texttt{PKG\_VERSION} \\
255 The upstream version number that we are downloading
256 \item \texttt{PKG\_RELEASE} \\
257 The version of this package Makefile
258 \item \texttt{PKG\_SOURCE} \\
259 The filename of the original sources
260 \item \texttt{PKG\_SOURCE\_URL} \\
261 Where to download the sources from (no trailing slash), you can add multiple download sources by separating them with a \\ and a carriage return.
262 \item \texttt{PKG\_MD5SUM} \\
263 A checksum to validate the download
264 \item \texttt{PKG\_CAT} \\
265 How to decompress the sources (zcat, bzcat, unzip)
266 \item \texttt{PKG\_BUILD\_DIR} \\
267 Where to compile the package
268 \end{itemize}
269
270 The \texttt{PKG\_*} variables define where to download the package from;
271 \texttt{@SF} is a special keyword for downloading packages from sourceforge. There is also
272 another keyword of \texttt{@GNU} for grabbing GNU source releases. If any of the above mentionned download source fails, the OpenWrt mirrors will be used as source.
273
274 The md5sum (if present) is used to verify the package was downloaded correctly and
275 \texttt{PKG\_BUILD\_DIR} defines where to find the package after the sources are
276 uncompressed into \texttt{\$(BUILD\_DIR)}.
277
278 At the bottom of the file is where the real magic happens, "BuildPackage" is a macro
279 set up by the earlier include statements. BuildPackage only takes one argument directly --
280 the name of the package to be built, in this case "\texttt{bridge}". All other information
281 is taken from the define blocks. This is a way of providing a level of verbosity, it's
282 inherently clear what the contents of the \texttt{description} template in
283 \texttt{Package/bridge} is, which wouldn't be the case if we passed this information
284 directly as the Nth argument to \texttt{BuildPackage}.
285
286 \texttt{BuildPackage} uses the following defines:
287
288 \textbf{\texttt{Package/\textit{<name>}}:} \\
289 \texttt{\textit{<name>}} matches the argument passed to buildroot, this describes
290 the package the menuconfig and ipkg entries. Within \texttt{Package/\textit{<name>}}
291 you can define the following variables:
292
293 \begin{itemize}
294 \item \texttt{SECTION} \\
295 The type of package (currently unused)
296 \item \texttt{CATEGORY} \\
297 Which menu it appears in menuconfig: Network, Sound, Utilities, Multimedia ...
298 \item \texttt{TITLE} \\
299 A short description of the package
300 \item \texttt{URL} \\
301 Where to find the original software
302 \item \texttt{MAINTAINER} (optional) \\
303 Who to contact concerning the package
304 \item \texttt{DEPENDS} (optional) \\
305 Which packages must be built/installed before this package. To reference a dependency defined in the
306 same Makefile, use \textit{<dependency name>}. If defined as an external package, use
307 \textit{+<dependency name>}. For a kernel version dependency use: \textit{@LINUX\_2\_<minor version>}
308 \end{itemize}
309
310 \textbf{\texttt{Package/\textit{<name>}/conffiles} (optional):} \\
311 A list of config files installed by this package, one file per line.
312
313 \textbf{\texttt{Build/Prepare} (optional):} \\
314 A set of commands to unpack and patch the sources. You may safely leave this
315 undefined.
316
317 \textbf{\texttt{Build/Configure} (optional):} \\
318 You can leave this undefined if the source doesn't use configure or has a
319 normal config script, otherwise you can put your own commands here or use
320 "\texttt{\$(call Build/Configure/Default,\textit{<first list of arguments, second list>})}" as above to
321 pass in additional arguments for a standard configure script. The first list of arguments will be passed
322 to the configure script like that: \texttt{--arg 1} \texttt{--arg 2}. The second list contains arguments that should be
323 defined before running the configure script such as autoconf or compiler specific variables.
324
325 To make it easier to modify the configure command line, you can either extend or completely override the following variables:
326 \begin{itemize}
327 \item \texttt{CONFIGURE\_ARGS} \\
328 Contains all command line arguments (format: \texttt{--arg 1} \texttt{--arg 2})
329 \item \texttt{CONFIGURE\_VARS} \\
330 Contains all environment variables that are passed to ./configure (format: \texttt{NAME="value"})
331 \end{itemize}
332
333 \textbf{\texttt{Build/Compile} (optional):} \\
334 How to compile the source; in most cases you should leave this undefined.
335
336 As with \texttt{Build/Configure} there are two variables that allow you to override
337 the make command line environment variables and flags:
338 \begin{itemize}
339 \item \texttt{MAKE\_FLAGS} \\
340 Contains all command line arguments (typically variable overrides like \texttt{NAME="value"}
341 \item \texttt{MAKE\_VARS} \\
342 Contains all environment variables that are passed to the make command
343 \end{itemize}
344
345 \textbf{\texttt{Package/\textit{<name>}/install}:} \\
346 A set of commands to copy files out of the compiled source and into the ipkg
347 which is represented by the \texttt{\$(1)} directory. Note that there are currently
348 4 defined install macros:
349 \begin{itemize}
350 \item \texttt{INSTALL\_DIR} \\
351 install -d -m0755
352 \item \texttt{INSTALL\_BIN} \\
353 install -m0755
354 \item \texttt{INSTALL\_DATA} \\
355 install -m0644
356 \item \texttt{INSTALL\_CONF} \\
357 install -m0600
358 \end{itemize}
359
360 The reason that some of the defines are prefixed by "\texttt{Package/\textit{<name>}}"
361 and others are simply "\texttt{Build}" is because of the possibility of generating
362 multiple packages from a single source. OpenWrt works under the assumption of one
363 source per package Makefile, but you can split that source into as many packages as
364 desired. Since you only need to compile the sources once, there's one global set of
365 "\texttt{Build}" defines, but you can add as many "Package/<name>" defines as you want
366 by adding extra calls to \texttt{BuildPackage} -- see the dropbear package for an example.
367
368 After you have created your \texttt{package/\textit{<name>}/Makefile}, the new package
369 will automatically show in the menu the next time you run "make menuconfig" and if selected
370 will be built automatically the next time "\texttt{make}" is run.
371
372 \subsection{Creating kernel modules packages}
373
374 The OpenWrt distribution makes the distinction between two kind of kernel modules, those coming along with the mainline kernel, and the others available as a separate project. We will see later that a common template is used for both of them.
375
376 For kernel modules that are part of the mainline kernel source, the makefiles are located in \textit{package/kernel/modules/*.mk} and they appear under the section "Kernel modules"
377
378 For external kernel modules, you can add them to the build system just like if they were software packages by defining a KernelPackage section in the package makefile.
379
380 Here for instance the Makefile for the I2C subsytem kernel modules :
381
382 \begin{Verbatim}[frame=single,numbers=left]
383 # $Id $
384
385 I2CMENU:=I2C Bus
386
387 define KernelPackage/i2c-core
388 TITLE:=I2C support
389 DESCRIPTION:=Kernel modules for i2c support
390 SUBMENU:=$(I2CMENU)
391 KCONFIG:=CONFIG_I2C_CORE CONFIG_I2C_DEV
392 FILES:=$(MODULES_DIR)/kernel/drivers/i2c/*.$(LINUX_KMOD_SUFFIX)
393 AUTOLOAD:=$(call AutoLoad,50,i2c-core i2c-dev)
394 endef
395 $(eval $(call KernelPackage,i2c-core))
396 \end{Verbatim}
397
398 To group kernel modules under a common description in menuconfig, you might want to define a \textit{<description>MENU} variable on top of the kernel modules makefile.
399
400 \begin{itemize}
401 \item \texttt{TITLE} \\
402 The name of the module as seen via menuconfig
403 \item \texttt{DESCRIPTION} \\
404 The description as seen via help in menuconfig
405 \item \texttt{SUBMENU} \\
406 The sub menu under which this package will be seen
407 \item \texttt{KCONFIG} \\
408 Kernel configuration option dependency. For external modules, remove it.
409 \item \texttt{FILES} \\
410 Files you want to inlude to this kernel module package, separate with spaces.
411 \item \texttt{AUTOLOAD} \\
412 Modules that will be loaded automatically on boot, the order you write them is the order they would be loaded.
413 \end{itemize}
414
415 After you have created your \texttt{package/kernel/modules/\textit{<name>}.mk}, the new kernel modules package
416 will automatically show in the menu under "Kernel modules" next time you run "make menuconfig" and if selected
417 will be built automatically the next time "\texttt{make}" is run.
418
419 \subsection{Conventions}
420
421 There are a couple conventions to follow regarding packages:
422
423 \begin{itemize}
424 \item \texttt{files}
425 \begin{enumerate}
426 \item configuration files follow the convention \\
427 \texttt{\textit{<name>}.conf}
428 \item init files follow the convention \\
429 \texttt{\textit{<name>}.init}
430 \end{enumerate}
431 \item \texttt{patches}
432 \begin{enumerate}
433 \item patches are numerically prefixed and named related to what they do
434 \end{enumerate}
435 \end{itemize}
436
437 \subsection{Troubleshooting}
438
439 If you find your package doesn't show up in menuconfig, try the following command to
440 see if you get the correct description:
441
442 \begin{Verbatim}
443 TOPDIR=$PWD make -C package/<name> DUMP=1 V=99
444 \end{Verbatim}
445
446 If you're just having trouble getting your package to compile, there's a few
447 shortcuts you can take. Instead of waiting for make to get to your package, you can
448 run one of the following:
449
450 \begin{itemize}
451 \item \texttt{make package/\textit{<name>}-clean V=99}
452 \item \texttt{make package/\textit{<name>}-install V=99}
453 \end{itemize}
454
455 Another nice trick is that if the source directory under \texttt{build\_\textit{<arch>}}
456 is newer than the package directory, it won't clobber it by unpacking the sources again.
457 If you were working on a patch you could simply edit the sources under the
458 \texttt{build\_\textit{<arch>}/\textit{<source>}} directory and run the install command above,
459 when satisfied, copy the patched sources elsewhere and diff them with the unpatched
460 sources. A warning though - if you go modify anything under \texttt{package/\textit{<name>}}
461 it will remove the old sources and unpack a fresh copy.
462
463 Other useful targets include:
464
465 \begin{itemize}
466 \item \texttt{make package/\textit{<name>}-prepare V=99}
467 \item \texttt{make package/\textit{<name>}-compile V=99}
468 \item \texttt{make package/\textit{<name>}-configure V=99}
469 \end{itemize}
470