Skip to end of metadata
Go to start of metadata


This manual describes the rdk-generic-broadband-image build procedure for Yocto 3.1 builds. This will upgrade the default build system used in RDKB, from morty(2.2) to dunfell(3.1). In addition to upgrades to opensource packages, Yocto 3.1 also contain Long term Support release feature. The current version lacks the variety of features available in the dunfell. The upgraded build tools will be used to generate rdk-generic-broadband-image for Raspberrypi reference platform. 

Yocto 3.1 Upgradation support the following:

  • Yocto BSP layer for meta-raspberrypi.
  • OpenEmbedded and Yocto Dunfell.
  • Linux kernel 5.4.72.
  • Version upgrades for bitbake, and other oe/python recipes.

Each component in RDK is a standalone repository with its own individual build tools producing a library or set of binaries. When we upgrade the OE layers to the newer versions, we need to make necessary changes in the RDK layers which use these components, to avoid build failures.

Host Setup

The OpenEmbedded build system should be able to run on Ubuntu 18.04 distribution/other compatible linux distribution with the following versions for Git, tar, and Python.

  • Git or greater
  • tar 1.27 or greater
  • Python 3.4.0 or greater
  • Coreutils(E.g realpath)

Note: You should also have about 50 Gbytes of free disk space for building images.

The essential packages you need for a supported Ubuntu or Debian distribution are shown in the following command:

$ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
  build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \
  xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
  pylint3 xterm bmap-tools

$ sudo apt-get install git cmake autoconf texinfo openjdk-8-jdk openjdk-8-jre \
  m4 libtool libtool-bin curl pkg-config lib32z1 doxygen

Repo Setup

In order to use Yocto build system, the repo tool must be properly installed on the machine.

To install Repo make sure you have a /bin directory in your home directory and that it is included in your path

Repo Setup Steps
$ mkdir ~/bin
$ PATH=~/bin:$PATH
Download the repo tool and ensure that it is executable
$ curl > ~/bin/repo
$ chmod a+x ~/bin/repo

Note: it is also recommended to put credentials in ~/.netrc when interacting with repo.

A sample ~/.netrc file is illustrated below

machine login YOUR_USERNAME password YOUR_PASSWORD

Yocto Build Steps

To build, follow below instructions

Build Steps
$ mkdir <workspace dir>
$ cd <workspace dir>
$ repo init -u -b dunfell -m rdkb-extsrc.xml
$ repo sync -j`nproc` --no-clone-bundle
$ MACHINE=raspberrypi-rdk-broadband source meta-cmf-raspberrypi/setup-environment
$ bitbake rdk-generic-broadband-image


Flashing Procedure

Following command can be used to flash the RPI image to sd card using linux machine . bmap tool should be available in linux

Flash command
bzip2 -d <path to ImageName.wic.bz2>
sudo -E bmaptool copy --nobmap <path to ImageName.wic> <path to SD card space>


$ bzip2 -d rdk-generic-broadband-image-raspberrypi-rdk-broadband.wic.bz2
$ sudo -E bmaptool copy --nobmap rdk-generic-broadband-image-raspberrypi-rdk-broadband.wic /dev/sdb

Validated Functionalities




1LAN Connected Devices-Ethernet(tick)
2WAN Connected Devices-Wi-Fi(tick)
3Parental Control(tick)
4Firewall settings(tick)
5Advanced Config: Port Triggering(error)
6Advanced Config: Port Forwarding(tick)
7Advanced Config: Remote Management(tick)
8Advanced Config: DMZ(tick)
9Xfinity Wi-Fi 2.4/5 GHz – Public Hotspot(tick)
10Test and Diagnostics(tick)
11Local WebUI Configuration(tick)
12Factory Reset(tick)
13DHCP /Reserved IP(tick)
15Eth Agent(tick)
162.4 GHz Band Support(tick)
175 GHz Band Support(tick)
18Bridge Mode Support(tick)
19Persistent Storage Management(tick)
20WebPA for Comcast,community(tick)
21Lost and Found(error)
22Harvester Support(error)
27Boot time data measurement(error)
28Wireless Protection Setup(WPS)(tick)
29Captive Portal(tick)
30Wi-Fi MAC Filtering(error)
31Log Rotation Support(tick)
32Firmware Upgrade Support(tick)
33Multiboot Support(tick)
34Telemetry Support(tick)

Log level control through CcspLogAgent


Band Steering using RSSI


Backup and Restore



       40Password-Reset                (tick) 
       41WebUI JST                  (tick) 

  • No labels


  1. Hello, I try to build for Raspberry I get following error :

    build-raspberrypi-rdk-broadband$ bitbake rdk-generic-broadband-image

    ERROR: Layer 'cmf-raspberrypi' depends on layer 'cmf-broadband', but this layer is not enabled in your configuration

    ERROR: Command execution failed: Traceback (most recent call last):

      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 103, in runAsyncCommand


      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 1543, in updateCache

        self.parseConfiguration ()

      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 433, in parseConfiguration


      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 1205, in handleCollections


      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 1195, in calc_layer_priority


      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 1195, in calc_layer_priority


      File "/home/lesaoutf/RDKB-RapsberryPi/openembedded-core/bitbake/lib/bb/", line 1192, in calc_layer_priority

        if not collection_priorities[collection]:

    KeyError: 'cmf-broadband'

    I'm running this on Ubuntu 20.04.3 LTS.

    1. Hello Z-Florent Le Saout 

      The builds are officially tested on Ubuntu 18.04 for Dunfell. Could you please check the builds in a Ubuntu 18.04 machine?

  2. Hello   Narayanaswamy Ramaiyer 

    I will give a try with 18.04 LXC container and keep you posted. Maybe this should be added in the limitations.

    As It seems to be layer configuration, I don't think it will help, but let see.

    1. Hello Z-Florent Le Saout 

      It is mentioned in the documentation that this is tried out in Ubuntu 18.04 . We will see if we can explicitely mention this is not officially tested in Ubuntu 20.04 (as there are chances it is assumed the Dunfell based RDK-B builds will work fine in all later versions of UBuntu ) until we will start official support in 20.04 too. Thanks

  3. I did try on an LXC container with Ubuntu 18.04 and it doesn't stop the compilation anymore at this stage (full compilation ongoing, and it takes quite some time (wink) )

    Currently  8 running tasks (292 of 4975)   5% |#########                                                                                                                                                          |
    0: libffi-native-3.3-r0 do_configure - 38s (pid 211974)
    1: libpcre2-native-10.34-r0 do_compile - 26s (pid 223720)
    2: mpfr-native-4.0.2-r0 do_configure - 16s (pid 229183)
    3: make-native-4.3-r0 do_configure - 13s (pid 230719)
    4: sqlite3-native-3_3.31.1-r0 do_configure - 13s (pid 230684)

    But when I read about dunfell, it does support Ubuntu 20.04 by default, so where does come this restriction ? RDK layers themselves ? Narayanaswamy Ramaiyer,,,20,0,0,0::recentpostdate%2Fsticky,,,20,2,40,74526284

     meta-poky/conf/distro/poky.conf | 1 +
     1 file changed, 1 insertion(+)

    diff --git a/meta-poky/conf/distro/poky.conf b/meta-poky/conf/distro/poky.conf
    index 91779e4..2696eb6 100644
    --- a/meta-poky/conf/distro/poky.conf
    +++ b/meta-poky/conf/distro/poky.conf
    @@ -56,6 +56,7 @@ SANITY_TESTED_DISTROS ?= " \
                 ubuntu-16.04 \n \
                 ubuntu-18.04 \n \
                 ubuntu-19.04 \n \
    +            ubuntu-20.04 \n \
                 fedora-30 \n \
                 fedora-31 \n \
                 centos-7 \n \

    1. Hello Z-Florent Le Saout  It is just that the builds are not officially tested and verified in 20.04 Ubuntu as the priorities are more on the feature/enhancement on the platform rather than the host machine( plus 18.04 support is still available as it is an LTS version )

  4. I found an issue with heaptrack package, but as I've switched to Raspi4, I will post on raspi4 thread Narayanaswamy Ramaiyer 

  5. The source code cannot download.....

    And my netrc is correct.

    alex@vm:~/rdkb$ repo init -u -b dunfell -m rdkb-extsrc.xml
    Downloading Repo source from
    Downloading manifest from
    fatal: remote error: access at least one ref not permitted
    manifests: sleeping 4.0 seconds before retrying
    fatal: remote error: access at least one ref not permitted
    fatal: cannot obtain manifest

  6. Also having the issue reported above - Do I need to raise a support ticket ?