How to create a custom yocto meta layer - Revision history

Andres: /* Pre-requisites */

2025-06-14T18:45:55Z

Pre-requisites

← Older revision		Revision as of 18:45, 14 June 2025
Line 12:		Line 12:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	apt install build-essential chrpath cpio debianutils diffstat file gawk gcc git iputils-ping libacl1 liblz4-tool locales python3 python3-git python3-jinja2 python3-pexpect python3-pip python3-subunit socat texinfo unzip wget xz-utils zstd		apt install build-essential chrpath cpio debianutils diffstat file gawk gcc git iputils-ping libacl1 liblz4-tool locales python3 python3-git python3-jinja2 python3-pexpect python3-pip python3-subunit socat texinfo unzip wget xz-utils zstd
	</syntaxhighlight>

	3. Get the latest copy of the [https://github.com/yoctoproject/poky Poky repository].
	<syntaxhighlight lang="bash">
	git clone git://git.yoctoproject.org/poky
	</syntaxhighlight>		</syntaxhighlight>

Andres: /* Introduction */

2025-06-14T18:45:27Z

Introduction

← Older revision		Revision as of 18:45, 14 June 2025
Line 2:		Line 2:

	This wiki will provide a detailed guide on how to create a custom Yocto meta-layer.		This wiki will provide a detailed guide on how to create a custom Yocto meta-layer.

	<!--- COMMENTED THIS OUT SINCE THIS PAGE ONLY SHOWS HOW TO CREATE A CUSTOM LAYER, NOT CREATE A YOCTO IMAGE
	=Pre-requisites=		=Pre-requisites=
	1. The host machine must have the following requirements:		1. The host machine must have the following requirements:
Line 18:		Line 18:
	git clone git://git.yoctoproject.org/poky		git clone git://git.yoctoproject.org/poky
	</syntaxhighlight>		</syntaxhighlight>

	--->
	=Create Base Meta-Layer=		=Create Base Meta-Layer=

Sonni: /* 🏗 Need a Solution for Your Project? */

2025-03-25T02:03:21Z

🏗 Need a Solution for Your Project?

← Older revision		Revision as of 02:03, 25 March 2025
Line 381:		Line 381:
	This should add the meta-proventusnova to the build/conf/bblayers.conf file or where you set the build directory.		This should add the meta-proventusnova to the build/conf/bblayers.conf file or where you set the build directory.

			{{Footer}}
	= 🏗 Need a Solution for Your Project? =
	Are you looking for ways to:
	✅ Optimize your '''embedded system''' for better performance?
	✅ Integrate '''AI and computer vision''' into your products?
	✅ Improve '''multimedia processing''' for real-time applications?
	✅ Develop a '''robust and scalable''' web platform?

	Our team has helped businesses across multiple industries solve these challenges.

	📩 '''Let’s collaborate!''' Contact us at '''[support@proventusnova.com](mailto:support@proventusnova.com)''' or visit '''[ProventusNova.com](https://proventusnova.com)''' to discuss your project.

Sonni: /* Step 1. Create custom layer */

2025-03-24T13:30:15Z

Step 1. Create custom layer

← Older revision		Revision as of 13:30, 24 March 2025
Line 366:		Line 366:
	├── COPYING.MIT		├── COPYING.MIT
	├── recipes-example		├── recipes-example
		⚫	│ └── example
			│ └──example_0.1.bb
	└── README.md		└── README.md

⚫	└── example
	└──exambple_0.1.bb
	</syntaxhighlight>		</syntaxhighlight>

Sonni: Add how to create a layer via bitbake

2025-03-24T09:00:56Z

Add how to create a layer via bitbake

@@ Line 2: / Line 2: @@
 This wiki will provide a detailed guide on how to create a custom Yocto meta-layer.
 After completion, the custom base meta-layer will contain the following parts:
@@ Line 13: / Line 30: @@
 * Custom config template files
 * Custom image recipe
 ===Step 1. Add base layer.conf file===
@@ Line 330: / Line 349: @@
 </syntaxhighlight>

Andres: /* Step 2. Add base distro config */

2025-03-11T22:12:20Z

Step 2. Add base distro config

← Older revision		Revision as of 22:12, 11 March 2025
Line 121:		Line 121:

	LICENSE_FLAGS_ACCEPTED += "commercial_faad2 commercial_x264"		LICENSE_FLAGS_ACCEPTED += "commercial_faad2 commercial_x264"

	USE_REDUNDANT_FLASH_LAYOUT_DEFAULT ?= "1"

	INHERIT += "tegra-support-sanity"
	ESDK_CLASS_INHERIT_DISABLE:append = " tegra-support-sanity"

	BB_SIGNATURE_HANDLER ?= "OEEquivHash"
	BB_HASHSERVE ??= "auto"

	</syntaxhighlight>		</syntaxhighlight>

Andres: /* Step 4. Add initial config template files */

2025-03-11T22:12:04Z

Step 4. Add initial config template files

← Older revision		Revision as of 22:12, 11 March 2025
Line 292:		Line 292:
	# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to		# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
	# track the version of this file when it was generated.		# track the version of this file when it was generated.
	CONF_VERSION = "1"		CONF_VERSION = "2"

	</syntaxhighlight>		</syntaxhighlight>

Andres: /* Step 4. Add initial config template files */

2025-03-11T20:28:22Z

Step 4. Add initial config template files

← Older revision		Revision as of 20:28, 11 March 2025
Line 177:		Line 177:
	Now, in order to simplify the configuration of a custom Yocto build, it is possible to include template configuration files on the custom meta-layer. This practice is encouraged in order to increase build repeatability.		Now, in order to simplify the configuration of a custom Yocto build, it is possible to include template configuration files on the custom meta-layer. This practice is encouraged in order to increase build repeatability.

	These 2 files are generally created inside '''meta-layer/conf/templates'''.		These 2 files are generally created inside '''meta-layer/conf/templates/template-name'''.
	For reference, this is how the directory structure would look like after the files are created:		For reference, this is how the directory structure would look like after the files are created:

Line 189:		Line 189:
	│ │ └── proventusnova-jetson-orin-nx-16-devkit.conf		│ │ └── proventusnova-jetson-orin-nx-16-devkit.conf
	│ └── templates		│ └── templates
	│ ~~├──~~ ~~bblayers.conf.sample~~		│ └── proventusnova
	│ ~~└──~~ ~~local~~.conf.sample		│ ├── bblayers.conf.sample
			│ └── local.conf.sample
	└── README.md		└── README.md
	</syntaxhighlight>		</syntaxhighlight>

Andres: /* Step 5. Add base image recipe */

2025-03-11T19:39:39Z

Step 5. Add base image recipe

← Older revision		Revision as of 19:39, 11 March 2025
Line 296:		Line 296:

	===Step 5. Add base image recipe===		===Step 5. Add base image recipe===

			In order to create a custom image, it is necessary to add a custom image recipe file.
			This file is usually added inside the '''meta-layer/recipes-layer/images''' directory.

			For example:

			<syntaxhighlight lang="bash">
			meta-proventusnova/
			├── conf
			│ ├── distro
			│ │ └── proventusnova.conf
			│ ├── layer.conf
			│ ├── machine
			│ │ └── proventusnova-jetson-orin-nx-16-devkit.conf
			│ └── templates
			│ ├── bblayers.conf.sample
			│ └── local.conf.sample
			├── README.md
			└── recipes-proventusnova
			└── images
			└── proventusnova-image-base.bb
			</syntaxhighlight>

			Once again, a custom image recipe can be based on another image recipe. And, it can also import other image recipes in order to include their base configurations.

			As reference, the following image recipe was based on [https://github.com/OE4T/tegra-demo-distro/blob/scarthgap-l4t-r35.x/layers/meta-tegrademo/recipes-demo/images/demo-image-base.bb NVIDIA tegra-demo-distro demo-image-base recipe]:

			<syntaxhighlight lang="bash">
			DESCRIPTION = "ProventusNova base image"
			LICENSE = "CLOSED"

			inherit core-image

			IMAGE_FEATURES += "ssh-server-openssh debug-tweaks"

			CORE_IMAGE_BASE_INSTALL += "systemd"
			TOOLCHAIN_HOST_TASK += "nativesdk-packagegroup-cuda-sdk-host"

			inherit nopackages

			</syntaxhighlight>

Andres: /* Step 4. Add initial config template files */

2025-03-11T19:24:43Z

Step 4. Add initial config template files

← Older revision		Revision as of 19:24, 11 March 2025
Line 168:		Line 168:

	===Step 4. Add initial config template files===		===Step 4. Add initial config template files===

			Bitbake will require 2 configuration files for building an image:

			'''bblayers.conf''': This file contains information about the location of the required meta-layers for the project.

			'''local.conf''': This file contains general build configuration for bitbake. For instance, in this file it is possible to determine where to store downloads, cache and even which package management configuration to use.

			Now, in order to simplify the configuration of a custom Yocto build, it is possible to include template configuration files on the custom meta-layer. This practice is encouraged in order to increase build repeatability.

			These 2 files are generally created inside '''meta-layer/conf/templates'''.
			For reference, this is how the directory structure would look like after the files are created:

			<syntaxhighlight lang="bash">
			meta-proventusnova/
			├── conf
			│ ├── distro
			│ │ └── proventusnova.conf
			│ ├── layer.conf
			│ ├── machine
			│ │ └── proventusnova-jetson-orin-nx-16-devkit.conf
			│ └── templates
			│ ├── bblayers.conf.sample
			│ └── local.conf.sample
			└── README.md
			</syntaxhighlight>

			Here is an example of a custom bblayers.conf.sample file based on [https://github.com/OE4T/tegra-demo-distro/blob/scarthgap-l4t-r35.x/layers/meta-tegrademo/conf/templates/tegrademo/bblayers.conf.sample NVIDIA tegra-demo-distro]:

			<syntaxhighlight lang="bash">
			# Version of layers configuration, specific to
			# each defined distro in the repository.
			# Format: ${DISTRO}-<version>
			TD_BBLAYERS_CONF_VERSION = "proventusnova-1"

			BBPATH = "${TOPDIR}"
			BBFILES ?= ""

			BBLAYERS ?= " \
			##OEROOT##/meta \
			##OEROOT##/../meta-tegra \
			##OEROOT##/../meta-tegra-community \
			##OEROOT##/../meta-virtualization \
			##OEROOT##/../meta-openembedded/meta-oe \
			##OEROOT##/../meta-openembedded/meta-python \
			##OEROOT##/../meta-openembedded/meta-networking \
			##OEROOT##/../meta-openembedded/meta-filesystems \
			"

			</syntaxhighlight>

			And, this is an example of a custom local.conf.sample file based on [https://github.com/OE4T/tegra-demo-distro/blob/scarthgap-l4t-r35.x/layers/meta-tegrademo/conf/templates/tegrademo/local.conf.sample NVIDIA tegra-demo-distro]:

			<syntaxhighlight lang="bash">
			#
			# Machine Selection
			#
			MACHINE ??= "proventusnova-jetson-orin-nx-16-devkit.conf"

			#
			# Where to place downloads
			#
			DL_DIR ?= "${TOPDIR}/../downloads"

			#
			# Where to place shared-state files
			#
			SSTATE_DIR ?= "${TOPDIR}/../sstate-cache"

			#
			# Where to place the build output
			#
			TMPDIR = "${TOPDIR}/tmp"

			#
			# Default policy (distro) config
			#
			DISTRO ?= "proventusnova"

			#
			# Package Management configuration
			#
			PACKAGE_CLASSES ?= "package_deb"

			#
			# SDK target architecture
			#
			SDKMACHINE ?= "x86_64"

			#
			# Extra image configuration defaults
			#
			EXTRA_IMAGE_FEATURES ?= "debug-tweaks"

			#
			# Additional image features
			#
			USER_CLASSES ?= "buildstats"

			#
			# Interactive shell configuration
			#
			PATCHRESOLVE = "noop"

			#
			# Disk Space Monitoring during the build
			#
			BB_DISKMON_DIRS ??= "\
			STOPTASKS,${TMPDIR},1G,100K \
			STOPTASKS,${DL_DIR},1G,100K \
			STOPTASKS,${SSTATE_DIR},1G,100K \
			STOPTASKS,/tmp,100M,100K \
			HALT,${TMPDIR},100M,1K \
			HALT,${DL_DIR},100M,1K \
			HALT,${SSTATE_DIR},100M,1K \
			HALT,/tmp,10M,1K"

			#
			# Qemu configuration
			#
			PACKAGECONFIG:append:pn-qemu-system-native = " sdl"

			# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
			# track the version of this file when it was generated.
			CONF_VERSION = "1"

			</syntaxhighlight>

	===Step 5. Add base image recipe===		===Step 5. Add base image recipe===