Adding yocto packages

From Variscite Wiki
Adding packages to the Yocto build


Packages and package groups can be added to image recipes. See the Yocto Development manual for how to customize an image:

Adding a package to the local build of the BSP

Search for the corresponding recipe and which layer the recipe is in. This link is a useful tool for doing so:

If the package is in the meta-openembedded layer, the recipe is already available in your build tree.

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

 IMAGE_INSTALL_append = " <package>"

Note: The leading white-space between the " and the package name is necessary for the append command.

If you need to add a layer to the BSP, clone or extract it to the YOCTO_DIR/sources/ directory. Then, modify YOCTO_DIR/BUILD_DIR/conf/bblayers.conf to include this new layer in BBLAYERS:

 BBLAYERS += "${BSPDIR}/sources/<new_layer>"

Webserver support

Recipes in meta-openembedded/meta-webserver/recipes-httpd:
- apache2
- cherokee
- hiawatha
- monkey
- nginx
- nostromo
- sthttpd
Recipes in poky/meta/recipes-extended/lighttpd:
- lighttpd

Although full of capabilities and features, Apache is commonly considered quite heavy, so is not generally used for embedded devices.
Nostromo and sthttpd are commonly considered ultralight webserver, with a very small set of capabilities and features, with very limited resource requirements.
The usual choice is usually between the following 5:
- cherokee
- hiawatha
- monkey
- nginx
- lighttpd
Here you can find an article comparing the above 5 webserver:

Accelerated browsers support

Yocto build system allow integrating browsers that support iMX GPU accelerations.

The common used browsers are:

  • qtwebkit based browsers: QtWebKit is the WebKit porting to Qt. WebKit is an open source web browser engine. Qt5 provides some demo implementations in webkitwidgets examples. Qt6 does not support qtwebkit.
  • qtwebengine based browsers: QtWebEngine integrates chromium's fast moving web capabilities into Qt. Both Qt5 and Qt6 provide some demo implementations in webenginewidgets examples.
  • chromium based browsers: Chromium is an open-source browser project.

Till 2016, FSLC community maintained chromium-imx project: customized Chromium versions (up to v48) providing GPU and VPU integration for iMX CPUs.

Much more updated Chromium versions are available from meta-browser, only providing GPU integration.

The minimum requirements to use chromium browsers is X11 or Wayland.

Qt based browsers directly rely on Qt integration with iMX accelerations.

QtWebKit has been superseded by QtWebEngine, mainly because QtWebKit has not been actively synchronized with the upstream WebKit code since Qt 5.2, it has been deprecated in Qt 5.5 and completely removed from Qt6 releases. Further details are available in Qt WebEngine Overview

For Qt5 only, Qt team provides a QtWebEngine browser for embedded touch devices and related recipes hase been integrated in our BSP starting from Sumo.

The performance of each browser is strictly related to the features to be used, so different html applications can provide better performance with different browsers.

Add QtWebKit examples to the build (Qt5 only)

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " qtwebkit-examples-examples"

Add QtWebEngine examples to the build (Both Qt5 and Qt6)

Add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " qtwebengine-examples"

For Qt6, the following may be also be required

PACKAGECONFIG_append_pn-qtwebengine = " examples"

Add Chromium to the build

Chromium support is provided by the 3rd party layer meta-browser.

Due to the lack of dedicated integrations with iMX SoCs, this layer is no longer part of our latest manifests. Also, be aware that the branch/commit should match your current BSP version, but not all the branches are available from meta-browser layer: e.g. at the time being, there's no dunfell branch.

Before proceeding, double-check that the meta-browser layer is actually listed in the YOCTO_DIR/BUILD_DIR/conf/bblayers.conf file.

If missing, ensure to have downloaded the meta-browser layer in YOCTO_DIR/sources folder and to add it to the list in the YOCTO_DIR/BUILD_DIR/conf/bblayers.conf file.

To build chromium, you can add the following line to YOCTO_DIR/BUILD_DIR/conf/local.conf:

IMAGE_INSTALL_append = " chromium<suffix>"
LICENSE_FLAGS_WHITELIST += "commercial_libav commercial_x264"
The <suffix> depends on your specific Yocto version and graphic backend.

Till Yocto Morty, chromium was available only for x11 backend and no suffix was required

IMAGE_INSTALL_append = " chromium"

Starting from Yocto Thud, chromium is available for both x11 backend

IMAGE_INSTALL_append = " chromium-x11"

and wayland backend

IMAGE_INSTALL_append = " chromium-ozone-wayland"

If you plan to use Chromium, please take care of the specific requirements for commercial license of libav and x264 packages.

Also, starting from March 2021, in the master branch, the layer structure has been reorganized with the commit chromium, firefox: split layer into meta-chromium and meta-firefox.

Building chromium from a meta-layer version before this commit, the expected change in the bblayers.conf file is

BBLAYERS += "${BSPDIR}/sources/meta-browser"

while after this commit, the expected change in the bblayers.conf file is

BBLAYERS += "${BSPDIR}/sources/meta-browser/meta-chromium"

The demo browser used for the above tests is available as