doc: regenerate
[opendreambox.git] / doc / opendreambox.txt
1 opendreambox
2
3    Andreas Oberritter <obi@opendreambox.org>
4    September 2014
5
6   Contents
7
8    1 Introduction
9     1.1 Target audience
10     1.2 Supported products
11     1.3 License
12     1.4 Obtaining the source code
13     1.5 Quick start
14     1.6 Directory structure
15      1.6.1 openembedded-core and meta-openembedded
16      1.6.2 meta-opendreambox
17      1.6.3 meta-dreambox
18    2 Further readings
19    3 Prerequisites
20     3.1 Required software
21    4 Major changes since previous public releases
22     4.1 Changes since release 1.6
23     4.2 Changes since release 2.0
24    5 Known Issues
25    6 Building OpenDreambox
26     6.1 Makefile targets
27     6.2 Configuration variables
28      6.2.1 BB_NUMBER_THREADS
29      6.2.2 MACHINE
30      6.2.3 PARALLEL_MAKE
31     6.3 Adding custom layers
32     6.4 Adding custom options
33      6.4.1 DISTRO_FEED_PREFIX
34      6.4.2 DISTRO_FEED_URI
35      6.4.3 INHERIT
36     6.5 Setting up a build directory
37     6.6 Building a firmware image
38     6.7 Building a package
39    7 Development hints
40     7.1 Cross-compilation of external software
41     7.2 Coding style
42     7.3 Package architecture
43    8 Bug reports and patches
44
45   1 Introduction
46
47    This document briefly describes the OpenDreambox distribution, an embedded
48    Linux distribution for Set-Top-Boxes manufactured by Dream Property GmbH.
49
50    OpenDreambox is based on the OpenEmbedded build framework, which uses BitBake
51    to transform build instructions into distributable firmare images and software
52    packages.
53
54    The current version, OpenDreambox 2.2, is based on the Yocto Project, release
55    1.5.1 "Dora", an umbrella project for OpenEmbedded and related tools.
56
57     1.1 Target audience
58
59    Developers familiar with previous versions of OpenDreambox or OpenEmbedded in
60    general.
61
62     1.2 Supported products
63
64    The current version includes support for the following products:
65
66    +-----------------------------------------------------------------------------+
67    |  ----------------------  |  ----------------------------------------------  |
68    |Product name              |Environment variable                              |
69    |  ----------------------  |  ----------------------------------------------  |
70    |DM 500 HD                 |MACHINE=dm500hd                                   |
71    |DM 500 HD V2              |MACHINE=dm500hdv2                                 |
72    |DM 800 HD SE              |MACHINE=dm800se                                   |
73    |DM 800 HD SE V2           |MACHINE=dm800sev2                                 |
74    |DM 820 HD                 |MACHINE=dm820                                     |
75    |DM 7020 HD                |MACHINE=dm7020hd                                  |
76    |DM 7020 HD V2             |MACHINE=dm7020hdv2                                |
77    |DM 7080 HD                |MACHINE=dm7080                                    |
78    |DM 8000 HD PVR            |MACHINE=dm8000                                    |
79    |  ----------------------  |  ----------------------------------------------  |
80    +-----------------------------------------------------------------------------+
81
82    Note, that not all of these platforms offer enough internal storage to actually
83    flash a generated firmware image. It might be possible to boot from external
84    storage or network, though.
85
86     1.3 License
87
88    Copyright (c) 2010-2014 Dream Property GmbH, Germany
89                            http://www.dream-multimedia-tv.de/
90    Authors:
91      Andreas Frisch <fraxinas@opendreambox.org>
92      Andreas Monzner <ghost@opendreambox.org>
93      Andreas Oberritter <obi@opendreambox.org>
94      Mladen Horvat <acid-burn@opendreambox.org>
95      Stefan Pluecken <thedoc@opendreambox.org>
96      Stephan Reichholf <reichi@opendreambox.org>
97
98    Permission is hereby granted, free of charge, to any person obtaining a copy
99    of this software and associated documentation files (the "Software"), to deal
100    in the Software without restriction, including without limitation the rights
101    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
102    copies of the Software, and to permit persons to whom the Software is
103    furnished to do so, subject to the following conditions:
104
105    The above copyright notice and this permission notice shall be included in
106    all copies or substantial portions of the Software.
107
108    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
109    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
110    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
111    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
112    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
113    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
114    THE SOFTWARE.
115
116
117     1.4 Obtaining the source code
118
119    OpenDreambox uses the Git version control system. To obtain the source code, it
120    is required to install Git. See http://git-scm.com/.
121
122    To initially download the source into the current directory, issue the
123    following command:
124
125    git clone -b dora git://git.opendreambox.org/git/opendreambox.git
126
127    The Git repository can be viewed online at:
128
129    http://git.opendreambox.org/?p=opendreambox.git
130
131     1.5 Quick start
132
133    For the impatient:
134
135    make -C opendreambox image
136
137    If this command fails, prerequisites my be missing. See section 3.
138
139     1.6 Directory structure
140
141    OpenDreambox consists of a set of layers containing build instructions. This
142    meta data is used by BitBake to download and compile source code and to
143    assemble installable software packages and firmware images.
144
145    Currently, these layers are used, ordered by priority from highest to lowest:
146      * meta-dreambox
147      * meta-opendreambox
148      * meta-qt5
149      * meta-openembedded/meta-oe
150      * meta-openembedded/meta-filesystems
151      * meta-openembedded/meta-initramfs
152      * meta-openembedded/meta-multimedia
153      * meta-openembedded/meta-networking
154      * meta-openembedded/meta-ruby
155      * openembedded-core/meta
156
157    If a recipe for the same package exists in multiple layers, then the higher
158    priority layer takes precedence over the lower priority layer.
159
160    For example, if libmad_0.15.1b.bb existed in both meta-openembedded and
161    openembedded-core, the recipe in meta-openembedded would be used, because
162    openembedded-core has lower priority.
163
164    NOTE: This would still be true even if the version of libmad in
165    openembeded-core was higher than the version in meta-openembedded, unless
166    PREFERRED_VERSION_libmad was set to the version in openembedded-core. There is
167    currently no way to prefer a version of a lower priority layer, if the same
168    version is present in a higher priority layer.
169
170       1.6.1 openembedded-core and meta-openembedded
171
172    These directories contain copies of Git repositories from git.openembedded.org,
173    including the OpenEmbedded-Core layer and the (Meta-)OpenEmbedded layers. They
174    get created automatically when building the distribution for the first time.
175
176    Throughout this document, the combination of these directories will be referred
177    to as OpenEmbedded.
178
179    The latest changes to these Git repositories can be seen at:
180
181    http://git.openembedded.org/openembedded-core-contrib/log/?h=obi/dora
182
183    http://git.openembedded.org/meta-openembedded-contrib/log/?h=obi/dora
184
185       1.6.2 meta-opendreambox
186
187    This directory contains:
188      * Recipes for packages written specifically for the OpenDreambox distribution
189      * Modifications to recipes from OpenEmbedded
190      * Recipes for software versions older than those available from OpenEmbedded
191      * Recipes for software versions newer than those available from OpenEmbedded
192
193       1.6.3 meta-dreambox
194
195    The directory meta-dreambox contains Board Support Packages (BSP) for the
196    supported Dreambox models. This includes:
197      * Hardware drivers
198      * Machine specific overrides
199      * The Linux kernel
200      * The boot loader
201      * Splash images
202
203   2 Further readings
204
205      * The Yocto Project Reference Manual:
206        https://www.yoctoproject.org/docs/1.5.1/ref-manual/ref-manual.html
207
208   3 Prerequisites
209
210     3.1 Required software
211
212    The OpenEmbedded project provides a general list of prerequisites for many
213    Linux distributions and also for some other operating systems.
214      * http://www.openembedded.org/wiki/Getting\_started#Required\_software
215
216    It is highly recommended to use Linux to build OpenDreambox. In theory, any
217    recent distribution will do, but not many distributions have been verified to
218    build OpenDreambox without errors. Tested distributions include:
219      * Debian 7.6 "Wheezy" [i386, amd64]
220      * Ubuntu 14.04.1 LTS "Trusty Tahr" [amd64]
221
222   4 Major changes since previous public releases
223
224     4.1 Changes since release 1.6
225
226      * Recipes were split across multiple layers and categorized.
227      * env.source has been replaced by two files, bitbake.env and
228        cross-compile.env. The former sets a minimal environment that is needed to
229        execute bitbake. The latter creates machine-specific command aliases, in
230        order to compile external software.
231      * All machines share a common tmp directory.
232      * ${MACHINE}/build directories were renamed to build/${MACHINE}.
233      * Kernel packages were renamed from linux-${MACHINE} to linux-dreambox.
234      * Support for machines based on ATI Xilleon or IBM STB was dropped.
235
236     4.2 Changes since release 2.0
237
238      * Added support for DM7080.
239      * If a recipe changes, the corresponding packages will be rebuilt
240        automatically, in contrast to required manual PR bumps in the past.
241      * Each machine uses its own tmp directory again, like before 2.0. However,
242        there is a shared sstate-cache, which allows to share already compiled data
243        between compatible machines. This impacts performance and size of the build
244        system, but improves reliability and consistency across builds.
245      * Support for machines without FPU and kernel versions below 3.x was dropped
246        (DM800).
247      * Layers under meta-bsp were combined into meta-dreambox.
248      * Default package format switched from ipk (opkg) to deb (dpkg + apt).
249      * dreambox-image was renamed to include the package format
250        (dreambox-image-deb).
251
252   5 Known Issues
253
254    None.
255
256   6 Building OpenDreambox
257
258    In the top level directory, there is a Makefile, which is used to set up build
259    directories and to fetch or update all used repositories. The Makefile can be
260    influenced by environment variables, either by specifing them on the
261    command-line or by storing them in a file called conf/make.conf. It is not
262    recommended to edit the Makefile directly in order to avoid conflicts with
263    future updates.
264
265    When the Makefile is run for the first time, the following steps will be
266    executed:
267      * Creation of configuration files
268           * bitbake.env
269           * conf/opendreambox.conf
270           * build/${MACHINE}/conf/bblayers.conf
271           * build/${MACHINE}/conf/local.conf
272      * Update or checkout of Git repositories
273           * OpenDreambox
274           * BitBake
275           * OpenEmbedded
276
277     6.1 Makefile targets
278
279    Run make help to get a list of targets of the top level Makefile, together with
280    a brief description.
281
282     6.2 Configuration variables
283
284       6.2.1 BB_NUMBER_THREADS
285
286    Controls how many BitBake tasks may run at a time. Defaults to the number of
287    cores available on the build system.
288
289       6.2.2 MACHINE
290
291    Controls the target machine to build packages for. See section 1.2 for a list
292    of supported products.
293
294       6.2.3 PARALLEL_MAKE
295
296    Controls how many processes per recipe make may use. Defaults to the number of
297    cores available on the build system.
298
299     6.3 Adding custom layers
300
301    It is possible to add custom layers to the build system. This can be done
302    globally and per machine. To add a layer globally, edit conf/bblayers-ext.conf.
303    To add a machine-specific layer, edit conf/bblayers-${MACHINE}-ext.conf.
304    Assuming that an additional layer is available at ${HOME}/custom-layer, the
305    entry to add to the file will look like this:
306
307    BBLAYERS =+ "${HOME}/custom-layer"
308
309     6.4 Adding custom options
310
311    It is possible to tweak a lot more options than those used by the Makefile by
312    editing conf/local-ext.conf or conf/local-${MACHINE}-ext.conf.
313
314    For example, if the firmware shall use the package feed built on the develoment
315    machine, which happens to be 192.168.1.1 and has a webserver configured to
316    point to tmp/deploy/ipk, a line like the following may be added:
317
318    DISTRO_FEED_URI = "http://192.168.1.1/${DISTRO}/${DISTRO_VERSION}"
319
320    In general, any variable in OpenEmbedded that uses weak assignment (?=) may be
321    overridden from these files.
322
323    The following sections list some commonly used options.
324
325       6.4.1 DISTRO_FEED_PREFIX
326
327    DISTRO_FEED_PREFIX specifies the name of the package update feed. This name may
328    be chosen arbitarily.
329
330    Default: DISTRO_FEED_PREFIX = "remote"
331
332       6.4.2 DISTRO_FEED_URI
333
334    DISTRO_FEED_URI specifies the URI of the package update feed.
335
336    Default: DISTRO_FEED_URI = "http://my-distribution.example/remote-feed/"
337
338       6.4.3 INHERIT
339
340    INHERIT specifies bbclasses to include from a configuration file. Usually, this
341    variable gets appended to by using the += operator.
342
343    The OpenDreambox distribution automatically appends "buildhistory
344    recipe_sanity" to INHERIT.
345
346    Default: INHERIT = ""
347
348    Some examples:
349
350    Always build the latest versions of OpenDreambox-related projects from Git:
351
352    INHERIT += "opendreambox-autorev"
353
354    Remove temporary files of previous versions of a recipe before a newer version
355    gets built:
356
357    INHERIT += "rm_old_work"
358
359     6.5 Setting up a build directory
360
361    To set up a build directory for e.g. DM 7080 run make MACHINE=dm7080. If
362    MACHINE=dm7080 has been set in conf/make.conf (default), you can simply run
363    make with no arguments instead. This will create and initialize the directory
364    build/dm7080.
365
366     6.6 Building a firmware image
367
368    To build a firmware image for e.g. DM 7080 run make MACHINE=dm7080 image. If
369    MACHINE=dm7080 has been set in conf/make.conf (default), you can simply run
370    make image instead.
371
372     6.7 Building a package
373
374    To build a single package, BitBake has to be used directly. First, the
375    environment has to be set up, in order to make BitBake available to the shell.
376    This can be done with the following command:
377
378    source bitbake.env
379
380    BitBake must be run from the machine's build directory. For DM 7080 run:
381
382    cd build/dm7080
383
384    In order to build enigma2, run:
385
386    bitbake enigma2.
387
388   7 Development hints
389
390     7.1 Cross-compilation of external software
391
392    OpenDreambox provides a script called cross-compile.env. Once run, the script
393    will create the following commands (shell aliases), aiming to ease
394    cross-compilation of external source trees:
395      * oe_autoreconf - Calls OE's version of autoreconf. Useful for projects based
396        on GNU autotools.
397      * oe_runconf - Calls ./configure with parameters suitable for OE. Useful for
398        projects based on GNU autotools.
399      * oe_runmake - Calls make with parameters suitable for OE. Useful for
400        projects based on GNU autotools or GNU make.
401      * oe_env - Useful to execute arbitrary commands in the OE environment (e.g.
402        oe_env env).
403      * oe_setenv - Exports the OE environment to the currently running shell
404        session.
405
406    The script needs to know the target machine, which can be one of the supported
407    products (see 1.2). Because the script adds aliases to your currently running
408    shell session, it has to be invoked using source or . (the dot operator), e.g.:
409
410    source cross-compile.env dm7080
411
412    The script may be called from any location, but must reside inside the
413    OpenDreambox Git tree. You may want to create a symlink to cross-compile.env
414    somewhere in your PATH.
415
416     7.2 Coding style
417
418    Run scripts/do_stylize.sh on new recipes to ensure proper coding style.
419
420     7.3 Package architecture
421
422    Set PACKAGE_ARCH = "${MACHINE_ARCH}" if either condition is met:
423      * The recipe uses COMBINED_FEATURES, MACHINE_FEATURES or DREAMBOX_FEATURES.
424      * The recipe uses COMPATIBLE_MACHINE.
425      * The recipe is part of meta-dreambox.
426
427   8 Bug reports and patches
428
429    Please send bug reports and patches to the Enigma2 development mailing list
430    <enigma2-devel@lists.elitedvb.net>.
431
432    A comfortable way to create patches is to use git format-patch, after all
433    changes have been committed to your local copy of the repository.