Adapt the Quickstart and Guides to use the Lamprey branch.
Bug-AGL: SPEC-4006
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I9c722e06c076d8c7209cc2bb5e92675255587b83
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26483
### 1. QEMU (Emulation)
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.ext4.xz).
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/bzImage).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/images/qemux86-64/bzImage).
3. Install [QEMU](https://www.qemu.org/download/) :
**NOTE :** Please note [https://www.virtualbox.org/ticket/19873](https://www.virtualbox.org/ticket/19873) as this affects the VMs resolution.
The AGL demo images do require 1920x1080. The instructions below have been adapted.
- 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz).
+ 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.vmdk.xz).
2. Install and set up [Virtual Box](https://www.virtualbox.org/wiki/Linux_Downloads).
**NOTE :** UEFI enabled system is required.
- 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz).
+ 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/images/qemux86-64/agl-demo-platform-crosssdk-qemux86-64.wic.xz).
2. Extract the image into USB drive :
### 1. QEMU (Emulation)
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm/deploy/images/qemuarm/agl-demo-platform-crosssdk-qemuarm.ext4.xz).
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/images/qemuarm/zImage).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm/deploy/images/qemuarm/zImage).
3. Install [QEMU](https://www.qemu.org/download/) :
### 2. BeagleBone Enhanced (BBE)
- 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/bbe/deploy/images/bbe/agl-demo-platform-crosssdk-bbe.wic.xz).
+ 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/bbe/deploy/images/bbe/agl-demo-platform-crosssdk-bbe.wic.xz).
2. Extract the image into the SD card of BeagleBone Enhanced :
### 1. QEMU (Emulation)
-1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm64/deploy/images/qemuarm64/agl-demo-platform-crosssdk-qemuarm64.ext4.xz).
-2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/images/qemuarm64/Image).
+2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm64/deploy/images/qemuarm64/Image).
3. Install [QEMU](https://www.qemu.org/download/) :
### 2. Raspberry Pi 4
- 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz).
+ 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-demo-platform-crosssdk-raspberrypi4-64.wic.xz).
2. Extract the image into the SD card of Raspberry Pi 4 :
**NOTE :** The prebuilt image doesn't support graphics (as of yet) and will run headless. For graphical support, a local build with the neccesary graphics driver is required.
- 1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/).
+ 1. Update the [firmware](https://elinux.org/R-Car/Boards/H3SK#Flashing_firmware) using files from [here](https://download.automotivelinux.org/AGL/release/lamprey/latest/h3ulcb-nogfx/deploy/images/h3ulcb/).
- 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-image-ivi-crosssdk-h3ulcb.wic.xz).
+ 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/lamprey/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-image-ivi-crosssdk-h3ulcb.wic.xz).
3. Extract the image into the boot device :
**NOTE:** This entire section presumes you want to build an image.
You can skip the entire build process if you want to use a ready-made
development image.
-The [supported images](https://download.automotivelinux.org/AGL/snapshots/master/latest/) exist for several boards as
+The [supported images](https://download.automotivelinux.org/AGL/release/lamprey/latest/) exist for several boards as
well as for the Quick EMUlator (QEMU).
See the
"[Quickstart](../1_Quickstart/Using_Ready_Made_Images.md)"
Using the latest stable release gives you a solid snapshot of the
latest know release.
The release is static, tested, and known to work.
- To download the latest stable release branch (i.e. Jellyfish), use
+ To download the latest stable release branch (i.e. lamprey), use
the following commands:
```sh
$ cd $AGL_TOP
- $ mkdir koi
- $ cd koi
- $ repo init -b koi -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
+ $ mkdir lamprey
+ $ cd lamprey
+ $ repo init -b lamprey -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
$ repo sync
```
You can find this script here:
```sh
-$AGL_TOP/master/meta-agl/scripts/aglsetup.sh
+$AGL_TOP/lamprey/meta-agl/scripts/aglsetup.sh
```
The script accepts many options that allow you to define build parameters such
Use the following commands to see the available options and script syntax:
```sh
-$ cd $AGL_TOP/master
+$ cd $AGL_TOP/lamprey
$ source meta-agl/scripts/aglsetup.sh -h
```
```sh
Available machines:
[meta-agl]
- bbe # BeagleBoneEnhanced
- beaglebone # BeagleBone
- cubox-i # multiple i.MX6 boards
- cyclone5 # CycloneV
- dra7xx-evm # TI DRA7xx-EVM 'vayu'
- 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)
- 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
+ bbe
+ beaglebone
+ cubox-i
+ dragonboard-410c
+ dragonboard-820c
+ ebisu
+ h3-salvator-x
+ h3ulcb
+ h3ulcb-kf
+ h3ulcb-nogfx
+ hsdk
+ imx6qdlsabreauto
+ imx8mqevk
+ imx8mqevk-viv
+ intel-corei7-64
+ j7-evm
+ m3-salvator-x
+ m3ulcb
+ m3ulcb-kf
+ m3ulcb-nogfx
+ nitrogen6x
+ qemuarm
+ qemuarm64
+ qemuriscv64
+ * qemux86-64
+ raspberrypi4
+ virtio-aarch64
```
## AGL Features
```sh
Available features:
[meta-agl]
- agl-all-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework agl-netboot )
+ agl-all-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-netboot )
agl-appfw-smack
agl-archiver
agl-buildstats
agl-ci
- agl-ci-change-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework agl-devel agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
- agl-ci-change-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework agl-devel agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
- agl-ci-snapshot-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework agl-devel agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
- agl-ci-snapshot-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework agl-devel agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
- agl-devel
+ agl-ci-change-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
+ agl-ci-change-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
+ agl-ci-snapshot-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
+ agl-ci-snapshot-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
+ agl-devel :( agl-package-management )
agl-fossdriver
agl-gplv2
agl-hmi-framework
+ agl-localdev
agl-netboot
+ agl-package-management
agl-pipewire
- agl-profile-cluster :( agl-profile-graphical )
- agl-profile-cluster-qt5 :( agl-profile-graphical-qt5 agl-profile-graphical )
- agl-profile-graphical
- agl-profile-graphical-html5 :( agl-profile-graphical )
- agl-profile-graphical-qt5 :( agl-profile-graphical )
- agl-profile-hud
- agl-profile-telematics
agl-ptest
+ agl-refhw-h3
agl-sign-wgts
agl-sota
agl-virt
agl-virt-guest-xen
agl-virt-xen :( agl-virt )
- agl-weston-remoting :( agl-profile-graphical )
- [meta-agl-cluster-demo]
- agl-cluster-demo :( agl-profile-cluster-qt5 agl-profile-graphical-qt5 agl-profile-graphical agl-hmi-framework )
- agl-cluster-demo-preload
+ agl-weston-remoting :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
+ agl-weston-waltham-remoting :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
[meta-agl-demo]
agl-cloudproxy
- agl-cluster-demo-support :( agl-weston-remoting agl-profile-graphical )
- agl-demo :( agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-pipewire agl-speech-framework )
+ agl-cluster-demo-support :( agl-weston-remoting agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
+ agl-demo :( agl-appfw-smack agl-hmi-framework agl-pipewire )
agl-demo-preload
- agl-demo-soundmanager :( agl-appfw-smack agl-hmi-framework agl-profile-graphical-qt5 agl-profile-graphical agl-audio-soundmanager-framework )
[meta-agl-devel]
+ agl-basesystem
+ agl-drm-lease
agl-jailhouse
- agl-speech-framework
- agl-voiceagent-alexa :( agl-speech-framework )
- agl-voiceagent-alexa-wakeword :( agl-voiceagent-alexa agl-speech-framework )
- [meta-agl-extra]
- agl-localdev
- [meta-agl-telematics-demo]
- agl-telematics-demo :( agl-profile-telematics )
+ agl-lxc :( agl-virt agl-drm-lease )
+ agl-voiceagent-alexa
+ agl-voiceagent-alexa-wakeword :( agl-voiceagent-alexa )
```
To find out exactly what a feature provides, check out the respective layer and its README.
[Ptest](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#testing-packages-with-ptest)
as part of the build.
-* **agl-sota**: Enables Software Over-the-Air (SOTA) components and dependencies.
- Includes meta-updater, meta-updater-qemux86-64, meta-filesystems, and meta-python.
-
* **agl-demo**: Enables the layers meta-agl-demo and meta-qt5.
You need agl-demo if you are going to build the agl-demo-platform.
-* **agl-sdl**: Enables or adds SDL to the build.
-
* **agl-pipewire**: Enables AGLs pipewire support.
-* **agl-audio-soundmanager-framework**: Enables Soundmanager framework, which is an exclusive switch for audio framework.
-
* **agl-localdev**: Adds a local layer named "meta-localdev" in the
meta directory and a local.dev.inc configuration file when that file
is present.
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/master/qemux86-64`.
+For this example, the Build Directory is `$AGL_TOP/lamprey/qemux86-64`.
The script's output also indicates the machine and AGL features selected for the build.
To use mirrors, add this line to your `local.conf` file in the Build directory:
```sh
-SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/master/${DEFAULTTUNE}/PATH \n "
+SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate-mirror/lamprey/${DEFAULTTUNE}/PATH \n "
```
You can learn more about shared state and how it is used in the
$ echo '# reuse download directories' >> $AGL_TOP/site.conf
$ echo 'DL_DIR = "$HOME/downloads/"' >> $AGL_TOP/site.conf
$ echo 'SSTATE_DIR = "$AGL_TOP/sstate-cache/"' >> $AGL_TOP/site.conf
-$ cd $AGL_TOP/master/qemux86-64/
+$ cd $AGL_TOP/lamprey/qemux86-64/
$ ln -sf $AGL_TOP/site.conf conf/
In General;
For this example :
```sh
-$ source $AGL_TOP/master/qemux86-64/agl-init-build-env
+$ source $AGL_TOP/lamprey/qemux86-64/agl-init-build-env
```
In general :
-# Building for Supported Renesas Boards
+# Building for Supported Renesas Boards
AGL supports building for several automotive
[Renesas](https://www.renesas.com/us/en/solutions/automotive.html) board kits.
| AGL Version | Renesas version |
|:-:|:-:|
- | AGL master | 4.7.0 |
+ | AGL lamprey | 4.7.0 |
3. **Download the Files:**
1. Download the prebuilt SDK :
- - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh)
+ - **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-12.0.0.sh)
- - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-10.90.0+snapshot.sh)
+ - **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-12.0.0.sh)
- - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-10.90.0+snapshot.sh)
+ - **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-13.0.0.sh)
*Henceforth,* **qemux86-64** *is used in these guides, unless specified
otherwise.*
```sh
$ mkdir ~/agl-app
- $ cp ~/Downloads/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh ~/agl-app/
+ $ cp ~/Downloads/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-*.sh ~/agl-app/
$ cd ~/agl-app
```
3. Install the downloaded SDK :
```sh
- $ chmod 777 poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh
+ $ chmod 777 poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-*.sh
$ mkdir agl-sdk/
- $ ./poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh
+ $ ./poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-*.sh
```
Select target directory for SDK : `~/agl-app/agl-sdk`
```sh
Automotive Grade Linux SDK installer version 10.90.0+snapshot
=============================================================
- Enter target directory for SDK (default: /opt/agl-sdk/10.90.0+snapshot-corei7-64): ~/agl-app/agl-sdk
+ Enter target directory for SDK (default: /opt/agl-sdk/12.0.0+snapshot-corei7-64): ~/agl-app/agl-sdk
You are about to install the SDK to "/home/boron/agl-app/agl-sdk". Proceed [Y/n]? Y
Extracting SDK..........................................................................................................................................done
Setting it up...done
You could find the SDK build from Yocto which embed the afb-helpers library
here:
-- **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-10.90.0+snapshot.sh)
+- **x86** : [qemux86-64](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-qemux86-64-toolchain-12.0.0.sh)
-- **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-10.90.0+snapshot.sh)
+- **ARM 32 bit** : [qemuarm](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-armv7vet2hf-neon-vfpv4-qemuarm-toolchain-12.0.0.sh)
-- **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-10.90.0+snapshot.sh)
+- **AARCH64 - ARM 64bit** : [qemuarm64](https://download.automotivelinux.org/AGL/release/lamprey/latest/qemuarm64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-aarch64-qemuarm64-toolchain-12.0.0.sh)
Then use your package manager to install the library.
Code Review / AGL / documentation.git / commitdiff