Part of the downloaded AGL software is a setup script that you must run to initialize the build environment.

aglsetup.sh Script

You can find this script here:

$AGL_TOP/needlefish/meta-agl/scripts/aglsetup.sh

The script accepts many options that allow you to define build parameters such as the target hardware (i.e. the machine), build directory, and so forth. Use the following commands to see the available options and script syntax:

$ cd $AGL_TOP/needlefish
$ source meta-agl/scripts/aglsetup.sh -h

AGL Machines (board support)

Your target platform will be selected with the -m flag. The MACHINE can be selected from the templates in meta-agl/templates/machine/*. Note: This is also the place where you can add new boards.

Following is a list of the available machines (level of support varies!):

Available machines:
   [meta-agl]
       bbe                        # BeagleBoneEnhanced
       beaglebone                 # BeagleBone
       cubox-i                    # multiple i.MX6 boards
       dragonboard-410c           # Qualcomm Dragonboard 410c
       dragonboard-820c           # Qualcomm Dragonboard 820c
       ebisu                      # Renesas RCar Ebisu
       h3-salvator-x              # Renesas RCar Salvator/H3
       h3ulcb                     # Renesas RCar H3
       h3ulcb-kf                  # Renesas RCar H3 w Kingfisher Board
       h3ulcb-nogfx               # Renesas RCar H3 w/o gfx blobs
       hsdk                       # ARC HS
       imx6qdlsabreauto           # i.MX6 sabreauto
       imx8mqevk                  # i.MX8 w etnaviv
       imx8mqevk-viv              # i.MX8 w vivante
       intel-corei7-64            # x86-64 (Intel flavour)
       j7-evm                     # TI Jacinto 7 EVM
       m3-salvator-x              # Renesas RCar Salvator/M3
       m3ulcb                     # Renesas RCar M3
       m3ulcb-kf                  # Renesas RCar M3 w Kingfisher Board
       m3ulcb-nogfx               # Renesas RCAR M3 w/o gfx blobs
       nitrogen6x                 # i.MX6 nitrogen board
       qemuarm                    # Qemu ARM
       qemuarm64                  # Qemu AArch 64 (ARM 64bit)
     * qemux86-64                 # Qemu x86-64
       raspberrypi4               # Raspberry Pi 4
       virtio-aarch64             # Virtio Guest

AGL Features

Before running the aglsetup.sh, you should understand what AGL features you want to include as part of your image. The script's help output lists available features and shows you the layers in which they reside.

Following is a list of the available features:

Available features:

   [meta-agl]                                    # CORE layer
       agl-all-features :( agl-demo  agl-pipewire  agl-app-framework  agl-netboot )
                                                 # For the usual demo image
       agl-app-framework                         # Application Framework
       agl-archiver                              # Source Archiver
       agl-buildstats                            # Build Statistics
       agl-devel :( agl-package-management )     # Developer Env (root login)
       agl-fossdriver                            # Fossology integration
       agl-gplv2                                 # GPLv2-only packages
       agl-localdev                              # inclusion of local development folder
       agl-netboot                               # network boot (e.g. CI)
       agl-package-management                    # include package management (e.g. rpm)
       agl-pipewire                              # include pipewire
       agl-ptest                                 # enable ptest pckages
       agl-refhw-h3                              # enable reference hardware
       agl-virt                                  # EG-Virt features
       agl-virt-guest-xen                        # EG-Virt features
       agl-virt-xen :( agl-virt )                # EG-Virt features
       agl-weston-remoting :( agl-demo  agl-pipewire  agl-app-framework )
       agl-weston-waltham-remoting :( agl-demo  agl-pipewire  agl-app-framework )

   [meta-agl-demo]                                    # DEMO layer
       agl-cluster-demo-support :( agl-weston-remoting  agl-demo  agl-pipewire  agl-app-framework )
                                                      # sample IVI demo
       agl-demo :( agl-pipewire  agl-app-framework )  # default IVI demo
       agl-demo-preload                               # Add Tokens and sample files

   [meta-agl-devel]                                   # Development layer
       agl-basesystem                                 # Toyota basesystem
       agl-drm-lease                                  # DRM lease support
       agl-egvirt                                     # EG-Virt feature
       agl-flutter                                    # Flutter support
       agl-jailhouse                                  # GSoC: jailhouse enablement
       agl-lxc :( agl-drm-lease  agl-pipewire )       # IC-EG container support
       agl-ros2                                       # GSoC: ros2 enablement

Specialized features (e.g. CI):
       agl-ci                                                                         # Tweaks for CI
       agl-ci-change-features :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-pipewire  agl-buildstats  agl-ptest )
       agl-ci-change-features-nogfx :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-pipewire  agl-buildstats  agl-ptest )
       agl-ci-snapshot-features :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-archiver  agl-pipewire  agl-buildstats  agl-ptest )
       agl-ci-snapshot-features-nogfx :( agl-demo  agl-pipewire  agl-app-framework  agl-devel  agl-package-management  agl-netboot  agl-archiver  agl-pipewire  agl-buildstats  agl-ptest )

To find out exactly what a feature provides, check out the respective layer and its README.

An AGL feature is a configuration that accounts for specific settings and dependencies needed for a particular build. For example, specifying the "agl-demo" feature makes sure that the aglsetup.sh script creates configuration files needed to build the image for the AGL demo.

Following are brief descriptions of the AGL features you can specify on the aglsetup.sh command line:

This feature provides a shortcut for using the layer meta-localdev in the top-level folder for easy modifications to your own recipes.

Example

Following is an example that initializes the build environment, selects "beaglebone" for the machine, and chooses the "agl-demo" feature, which also includes the "agl-appfw-smack", "agl-devel", and "agl-hmi-framework" features:

$ source meta-agl/scripts/aglsetup.sh -m qemux86-64 -b qemux86-64 agl-demo agl-devel
aglsetup.sh: Starting
Generating configuration files:
   Build dir: /home/scottrif/workspace_agl/build
   Machine: qemux86-64
   Features: agl-appfw-smack agl-demo agl-devel
   Running /home/scottrif/workspace_agl/poky/oe-init-build-env
   Templates dir: /home/scottrif/workspace_agl/meta-agl/templates/base
   Config: /home/scottrif/workspace_agl/build/conf/bblayers.conf
   Config: /home/scottrif/workspace_agl/build/conf/local.conf
   Setup script: /home/scottrif/workspace_agl/build/conf/setup.sh
   Executing setup script ... --- beginning of setup script
 fragment /home/scottrif/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh
 fragment /home/scottrif/workspace_agl/meta-agl/templates/base/99_setup_EULAconf.sh
 end of setup script
OK
Generating setup file: /home/scottrif/workspace_agl/build/agl-init-build-env ... OK
aglsetup.sh: Done
 Shell environment set up for builds.
You can now run 'bitbake target'
Common targets are:
  - meta-agl:          (core system)
    agl-image-minimal
    agl-image-minimal-qa

    agl-image-ivi
    agl-image-ivi-qa
    agl-image-ivi-crosssdk

    agl-image-weston

  - meta-agl-demo:     (demo with UI)
    agl-demo-platform  (* default demo target)
    agl-demo-platform-qa
    agl-demo-platform-crosssdk
    agl-demo-platform-html5

Running the script creates the Build Directory if it does not already exist. The default Build Directory is $AGL_TOP/<release-branch-name>/build, and the nomenclature to be used throughout this doc is going to be $AGL_TOP/<release-branch-name>/<build-dir> For this example, the Build Directory is $AGL_TOP/needlefish/qemux86-64.

The script's output also indicates the machine and AGL features selected for the build.

The script creates two primary configuration files used for the build: local.conf and bblayers.conf. Both these configuration files are located in the Build Directory in the conf folder. If you were to examine these files, you would find standard Yocto Project configurations along with AGL configuration fragments, which are driven by the machine (i.e. beaglebone) and the AGL features specified as part of the script's command line.

The end result is configuration files specific for your build in the AGL development environment.

Finally, part of the aglsetup.sh script makes sure that any End User License Agreements (EULA) are considered. You can see that processing in the script's output as well.

NOTE: Use of the local.conf and bblayers.conf configuration files is fundamental in the Yocto Project build environment. Consequently, it is fundamental in the AGL build environment. You can find lots of information on configuring builds in the Yocto Project documentation set. Here are some references if you want to dig into configuration further: