Adding new overlays to yocto image

[rania]

i am trying to add new overlays to my yocto image using this recipe :

FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"

SRC_URI += "\
    file://aunit_tcm_overlay.dts \
    file://can-overlay.dts \
"

TEZI_EXTERNAL_KERNEL_DEVICETREE += "\
    aunit_tcm_overlay.dtbo \
    can-overlay.dtbo \
" 

TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT = "\
    aunit_tcm_overlay.dtbo \
    can-overlay.dtbo \
"

do_collect_overlays:prepend() {
    cp ${WORKDIR}/aunit_tcm_overlay.dts ${S}
    cp ${WORKDIR}/can-overlay.dts ${S}
}

i tried this one as well

FILESEXTRAPATHS:prepend := "${THISDIR}/device-tree-overlays-mainline:"

CUSTOM_OVERLAYS_SOURCE = " \
    <custom_overlay1>.dts \
    <custom_overlay2>.dts \
"

CUSTOM_OVERLAYS_BINARY = " \
    <custom_overlay1>.dtbo \
    <custom_overlay2>.dtbo \
"

SRC_URI += " \
    file://<custom_overlay1>.dts \
    file://<custom_overlay2>.dts \
"

TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT:use-mainline-bsp += " \
    ${CUSTOM_OVERLAYS_BINARY} \
"

do_collect_overlays:prepend() {

    for DTS in ${CUSTOM_OVERLAYS_SOURCE}; do
        cp ${WORKDIR}/${DTS} ${S}
    done

}

the problem with these two recipes is that my other overlays are deleted all what i find after extracting my bootfs are the new overlays
this is from an old build :

this is from the new build

i also tried this recipe

FILESEXTRAPATHS:prepend := "${THISDIR}/device-tree-overlays:"

SRC_URI += "\
    file://apalis-imx8_can_bus_overlay.dts  \
    file://apalis-imx8_disable-cm40-uart_overlay.dts \
    file://apalis-imx8_hmp_overlay.dts \
"


#compiles and makes the overlay available to be used

TEZI_EXTERNAL_KERNEL_DEVICETREE += "\
    apalis-imx8_can_bus_overlay.dtbo \
    apalis-imx8_disable-cm40-uart_overlay.dtbo \
    apalis-imx8_hmp_overlay.dtbo \
    apalis-imx8_hdmi_overlay.dtbo \
    apalis-imx8_spi1_spidev_overlay.dtbo \
    apalis-imx8_spi2_spidev_overlay.dtbo \ 
    apalis-imx8_resistive-touch_overlay.dtbo \  
    apalis-imx8_mezzanine_can_overlay.dtbo \
    apalis-imx8_mezzanine_ov5640_overlay.dtbo \
    apalis-imx8_mezzanine_panel-cap-touch-10inch-lvds_overlay.dtbo \
    apalis-imx8_nau8822-btl_overlay.dtbo \
    apalis-imx8_ov5640_overlay.dtbo \
    apalis-imx8_panel-cap-touch-10inch-lvds_overlay.dtbo \
    apalis-imx8_panel-lvds-dual-channel-1080p_overlay.dtbo \
    apalis-imx8_ar0521_overlay.dtbo \ 
" 
#add the already compiled overlay to overlays.txt

TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT = "\
    apalis-imx8_can_bus_overlay.dtbo \
    apalis-imx8_disable-cm40-uart_overlay.dtbo \
    apalis-imx8_hmp_overlay.dtbo \
    apalis-imx8_hdmi_overlay.dtbo \
    apalis-imx8_spi1_spidev_overlay.dtbo \
    apalis-imx8_spi2_spidev_overlay.dtbo \ 
    apalis-imx8_resistive-touch_overlay.dtbo \  
    apalis-imx8_mezzanine_can_overlay.dtbo \
    apalis-imx8_mezzanine_ov5640_overlay.dtbo \
    apalis-imx8_mezzanine_panel-cap-touch-10inch-lvds_overlay.dtbo \
    apalis-imx8_nau8822-btl_overlay.dtbo \
    apalis-imx8_ov5640_overlay.dtbo \
    apalis-imx8_panel-cap-touch-10inch-lvds_overlay.dtbo \
    apalis-imx8_panel-lvds-dual-channel-1080p_overlay.dtbo \
    apalis-imx8_ar0521_overlay.dtbo \ 
"

do_collect_overlays:prepend() {
    cp ${WORKDIR}/apalis-imx8_can_bus_overlay.dts ${S}
    cp ${WORKDIR}/apalis-imx8_disable-cm40-uart_overlay.dts ${S}
    cp ${WORKDIR}/apalis-imx8_hmp_overlay.dts ${S}
} 

but the build never came to an end it spent more than two making tar image and wic image so i stopped because this is weird

how to solve the problem am i having a syntax error or something and why my other overlays disappeard

[ToradexAI]

Hi, I’m the Toradex AI Assistant. The Toradex Support team will follow up with you shortly!

Did you like my answer?

---

Hello!

It seems you’re encountering issues with your Yocto recipes where existing overlays are being removed when you add new ones. To address this, it’s crucial to ensure that you are appending to the TEZI_EXTERNAL_KERNEL_DEVICETREE and TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT variables rather than overwriting them. You should use the += operator to append new overlays, which helps preserve the existing ones. Here’s an example:

TEZI_EXTERNAL_KERNEL_DEVICETREE += "\
    new_overlay1.dtbo \
    new_overlay2.dtbo \
"

TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT += "\
    new_overlay1.dtbo \
    new_overlay2.dtbo \
"

This approach should prevent the deletion of existing overlays by adding the new ones to the list.

Regarding the long build times, here are some steps you can take:

1. Check for Syntax Errors: Ensure there are no syntax errors in your recipes that might cause the build process to hang. Double-check the use of backslashes and spaces.
2. Review Build Logs: Examine the build logs for any errors or warnings that could indicate what is causing the delay.
3. Resource Allocation: Make sure your build environment has sufficient resources (CPU, RAM, disk space) to handle the build process efficiently.
4. Incremental Builds: If possible, try performing an incremental build to see if it reduces the build time.

By following these steps, you should be able to resolve the issues with your device tree overlays and improve the build process efficiency.

Best regards,
Toradex AI Assistant

Please, also check if these links can help you solve your problem:

BSP5 device tree overlay file modification with Yocto build

Hi, As described in my previous question https://www.toradex.com/community/questions/58635/lvds-display-integration-with-imx8mm-verdin-and-da.html?childToView=58948#comment-58948 I was able to create Yocto Linux image, modify device tree using mmc mode (ums 0 mmc 0, copy paste dtbo file into overlays folder, and edit overlays.txt file from my host machine) and got custom display working fine. Now I have tried to do same from Yocto build to include my version of DTBO file into device instead of…

Testing 10" DSI display on development Yocto images

I am testing the 10.1" DSI display sold by Toradex with the Verdin i.MX8M Plus SOM and Mallow board. There is a known touch issue which @bruno.tx has indicated is fixed in the next BSP release. I would like to try the touch function with the nightly/monthly Yocto image releases which have the fix already. I tried both the nightly and monthly images but both fail to find the verdin-imx8mp_panel-cap-touch-10inch-dsi_overlay.dtbo after I modify the overlays.txt file to include that overlay. The bo…

Device Tree Overlays with Yocto-project.

[rania]

i tried to append this way

FILESEXTRAPATHS:prepend := "${THISDIR}/device-tree-overlays:"

SRC_URI += "\
    file://apalis-imx8_can_bus_overlay.dts  \
    file://apalis-imx8_disable-cm40-uart_overlay.dts \
    file://apalis-imx8_hmp_overlay.dts \
"

#compiles and makes the overlay available to be used
TEZI_EXTERNAL_KERNEL_DEVICETREE += "\
    apalis-imx8_can_bus_overlay.dtbo \
    apalis-imx8_disable-cm40-uart_overlay.dtbo \
    apalis-imx8_hmp_overlay.dtbo \
"
#add the already compiled overlay to overlays.txt
TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT += "\
    apalis-imx8_can_bus_overlay.dtbo \
    apalis-imx8_disable-cm40-uart_overlay.dtbo \
    apalis-imx8_hmp_overlay.dtbo \
"

do_collect_overlays:prepend() {
    cp ${WORKDIR}/apalis-imx8_can_bus_overlay.dts ${S}
    cp ${WORKDIR}/apalis-imx8_disable-cm40-uart_overlay.dts ${S}
    cp ${WORKDIR}/apalis-imx8_hmp_overlay.dts ${S}
} 

this is the error that shows

ERROR: device-tree-overlays-toradex_5.15-2.2.x-imx+gitAUTOINC+939f660fed-r0 do_deploy: apalis-imx8_hdmi_overlay.dtbo is not installed in your boot filesystem, please make sure it's in TEZI_EXTERNAL_KERNEL_DEVICETREE or being provided by virtual/dtb.
ERROR: device-tree-overlays-toradex_5.15-2.2.x-imx+gitAUTOINC+939f660fed-r0 do_deploy: ExecutionError('/home/rania/pixii_os/pixii_os/build/tmp/work/apalis_imx8-tdx-linux/device-tree-overlays/toradex_5.15-2.2.x-imx+gitAUTOINC+939f660fed-r0/temp/run.do_deploy.7635', 1, None, None)
ERROR: Logfile of failure stored in: /home/rania/pixii_os/pixii_os/build/tmp/work/apalis_imx8-tdx-linux/device-tree-overlays/toradex_5.15-2.2.x-imx+gitAUTOINC+939f660fed-r0/temp/log.do_deploy.7635
ERROR: Task (/home/rania/pixii_os/pixii_os/build/../layers/meta-toradex-nxp/recipes-kernel/linux/device-tree-overlays_git.bb:do_deploy) failed with exit code '1'

[henrique.tx]

Hi @rania !

@rania

this is the error that shows

ERROR: device-tree-overlays-toradex_5.15-2.2.x-imx+gitAUTOINC+939f660fed-r0 do_deploy: apalis-imx8_hdmi_overlay.dtbo is not installed in your boot filesystem, please make sure it's in TEZI_EXTERNAL_KERNEL_DEVICETREE or being provided by virtual/dtb.

From this, we can see that the error is pointing you to the solution: add your overlay to TEZI_EXTERNAL_KERNEL_DEVICETREE.

Please find below an example of how I add overlays to my Yocto builds.

I start by creating the bbappend for device tree overlays. Please note that the target for your .bbapend depends on the module you will build for and if it will be based on upstream or downstream kernel. See below the available device-tree-overlays recipes on BSP 7:

~/yocto/oe-workdir/tdxref-bsp-7/layers $ find . -iname "*device-tree-overlays*"
./meta-toradex-bsp-common/recipes-kernel/linux/device-tree-overlays-mainline_git.bb
./meta-toradex-nxp/recipes-kernel/linux/device-tree-overlays_git.bb
./meta-toradex-ti/recipes-kernel/linux/device-tree-overlays-ti_git.bb

In your case, since you are using Apalis iMX8QM, I expect you are using downstream-based Linux Kernel, therefore you will need to create the .bbappend for meta-toradex-nxp/recipes-kernel/linux/device-tree-overlays_git.bb. This can be done manually or using the recipetool command. From what I can see, you already know the drill to create the .bbappend, so I will skip the creation details.

This is the example content of my .bbappend:

# file: meta-grilo-experiments/recipes-kernel/linux/device-tree-overlays_git.bbappend

FILESEXTRAPATHS:prepend := "${THISDIR}/device-tree-overlays:"

CUSTOM_OVERLAYS_SOURCE = " \
    my-device-tree_overlay.dts \
"
CUSTOM_OVERLAYS_BINARY = " \
    my-device-tree_overlay.dtbo \
"

SRC_URI += " \
    file://my-device-tree_overlay.dts \
"

TEZI_EXTERNAL_KERNEL_DEVICETREE += " \
    ${CUSTOM_OVERLAYS_BINARY} \
"

TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT = " \
    ${CUSTOM_OVERLAYS_BINARY} \
"

do_collect_overlays:prepend() {
    for DTS in ${CUSTOM_OVERLAYS_SOURCE}; do
        cp ${WORKDIR}/${DTS} ${S}
    done
}

And the actual device tree overlay file is located in meta-grilo-experiments/recipes-kernel/linux/device-tree-overlays/my-device-tree_overlay.dts

With this, the outcome will be: all the overlays will be available, but only my-device-tree_overlay.dtbo will be enabled. You can use the variables TEZI_EXTERNAL_KERNEL_DEVICETREE and TEZI_EXTERNAL_KERNEL_DEVICETREE_BOOT according to your requirements to deploy and pre-enable the device tree overlays you need. To know what they do, please check the comments on toradex-devicetree.bbclass « classes - meta-toradex-bsp-common.git - Toradex BSP layer, recipes common to all modules.

I hope it helps.

Best regards,

[rania]

thank you i solved the problem by adding the missing overlays here :
TEZI_EXTERNAL_KERNEL_DEVICETREE