OpenEmbedded®/Yocto Project®: Build From Sources

How to Build OpenEmbedded Core for MPU

Support for the Microchip MPU System-on-a-Chip (SoC) family is provided through the meta-mchp Yocto Project® layer. The source for this layer is hosted on the Linux4Microchip GitHub^® account on the Microchip Yocto Project BSP page.

Building Environment

A step-by-step, comprehensive installation is explained on the Yocto Project Quick Build page. The following lines should be considered as an add-on that is MPU-specific, or that can facilitate your setup.

Step-by-Step Build Procedure

OpenEmbedded/Yocto Project BSP Layer for Microchip's SoCs

• Description
  • The meta-mchp-common layer consolidates common Board Support Package (BSP) components and metadata for Microchip platforms, streamlining development across various Microchip devices for use with OpenEmbedded and/or Yocto Project.
• Supported Machines
  • The meta-mchp-common layer provides support for various Microchip platforms. For detailed information about supported machines, please refer to the documentation in the relevant sub-layers:
    • MPU layer README
• Prerequisites
  • Before starting, please refer to the "Required Packages for Build Host" section in the Yocto Project documentation to install the required dependencies for the build environment:

For instance, on Ubuntu® or Debian®, these packages need to be installed on your development host:

• Usage

  • To integrate this layer into your Yocto Project build environment:

  Clone the necessary repositories.

  Create an empty directory to hold the workspace:

  mkdir yocto-dev
  cd yocto-dev

  Use the repo tool to fetch all the required repositories.

  Information

  Note: Make sure to install the repo utility first.

  repo init -u https://github.com/linux4microchip/meta-mchp-manifest.git -b <branch> -m <target>/default.xml

  Replace and with the Yocto Project release branch and the manifest required. For example:

  repo init -u https://github.com/linux4microchip/meta-mchp-manifest.git -b scarthgap -m mpu/default.xml

  Fetch all the required repositories using the following repo command:

  repo sync

  ---

  Initialize the build environment.

  The meta-mchp repository provides sample configuration templates that help set up BitBake layers and key configuration files in the Yocto Project build directory.

  Set the TEMPLATECONF environment variable to point to the appropriate configuration template before initializing the build environment:

  export TEMPLATECONF=${TEMPLATECONF:-../meta-mchp/<meta-layer>/conf/templates/default}

  Replace meta-layer above with the desired layer based on your target platform. For example:

  export TEMPLATECONF=${TEMPLATECONF:-../meta-mchp/meta-mchp-mpu/meta-mchp-mpu-apps/conf/templates/default}

  Information

  Note: Setting TEMPLATECONF is only needed the first time you will run the source command.

  Then initialize the Yocto Project build environment:

  source openembedded-core/oe-init-build-env

  ---

  Set the target machine and build the image.

  MACHINE=<machine> bitbake core-image-minimal

  Each sub-layer provides several images that include demos and applications tailored for its respective platform.

  For more information on the supported images, please refer to the MPU layer README.

  • Layer dependencies

    This layer depends on the following layers:

    - meta-openembedded
     - URI: git://git.openembedded.org/meta-openembedded
     - Layers: meta-oe, meta-networking, meta-python
    
    - openembedded-core
     - URI: git://git.openembedded.org/openembedded-core
     - Layers: meta

  For information on the specific revisions used, refer to the meta-mchp manifest repository.

• Licensing
  • The contents of this layer are licensed under the MIT License. See COPYING.MIT for details.
• Contributing 
  • If you want to contribute changes, you can send GitHub pull requests. 

Back to Top

OpenEmbedded Software Development Kit (SDK)

The meta-toolchain recipes build tarballs that contain a cross-compilation toolchain, cross-compiled libraries, header files, and configuration tools suitable for application development outside OpenEmbedded.

The cross-compilation toolchain and all cross-compiled libraries are included in this Software Development Kit (SDK), allowing users to match exactly what is provided in the associated Linux4SAM demo image.

Using a different cross-compilation toolchain may lead to undefined symbols and mismatched library calls. Because the SDK matches the software available on the target system, developers can fully use the shared libraries typically expected in an embedded Linux® environment.

This cross-development cycle does not need to be integrated into an OpenEmbedded build flow. Standard development tools such as Makefiles, CMake, or IDEs can be used. This allows the development phase to remain separate from the integration phase.

Build OpenEmbedded SDK

This SDK is generated using the BitBake handy target populate_sdk.

or

It will produce a comprehensive SDK script (auto-extracting archive) available in the deployment directory: from the build directory, it is usually located in tmp/deploy/sdk.

For instance, for the sama5d27-wlsom1-ek-sd graphic image type of SDK, you can find it available in: tmp/deploy/sdk/oecore-mchp-graphics-image-x86_64-cortexa5t2hf-neon-vfpv4-sama5d27-wlsom1-ek-sd-toolchain-nodistro.0.sh.

Install OpenEmbedded SDK

Once the SDK archive is generated, you can install it by running the script directly. Choose the appropriate script name according to your board.

Some installation information will be asked of the user, as well as the appropriate installation rights:

Hereunder is an example with an SDK from the Scarthgap branch of OpenEmbedded present in Linux4SAM 2024.10:

Use OpenEmbedded SDK

The installation directory (/opt/oecore) contains a setup script that can be sourced to initialize all required environment variables.

You can check your new environment

Back to Top

Tips & Tricks

BitBake

• BitBake User Manual
• BitBake Cheat Sheet

• List tasks provided by a package:

  bitbake -c listtasks <package_name>You can use one of those tasks to have fine-grained control over the package building.

Hello World example

• Reference to the "Hello World" example

Back to Top

Recent FAQ

• YoctoProject
• FAQ about audio
• Connect Module From PDA
• Yocto Project FAQ
• GUI Solutions
• Using systemd
• SAM9X60-EK Evaluation Kit - Attaching the TM5000 WVGA Display

Back to Top