diff options
Diffstat (limited to 'docs/0_Getting_Started')
7 files changed, 70 insertions, 85 deletions
diff --git a/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md b/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md index 17f238d..436d62f 100644 --- a/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md +++ b/docs/0_Getting_Started/1_Quickstart/Using_Ready_Made_Images.md @@ -8,9 +8,9 @@ AGL provides a number of pre-built ready-made images of various versions. ### 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/) : @@ -78,7 +78,7 @@ AGL provides a number of pre-built ready-made images of various versions. **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). @@ -110,7 +110,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt **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 : @@ -128,9 +128,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 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/) : @@ -199,7 +199,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 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 : @@ -224,9 +224,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 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/) : @@ -295,7 +295,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt ### 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 : @@ -363,9 +363,9 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt **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 : diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md b/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md index 6acdfdd..a76cbf6 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host.md @@ -17,7 +17,7 @@ the Yocto Project documentation **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)" diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md b/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md index ee18805..3bb51d5 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/2_Downloading_AGL_Software.md @@ -51,14 +51,14 @@ The remainder of this section provides steps on how to download the AGL source f 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 ``` diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md b/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md index 15ad5ed..fca4ebf 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/3_Initializing_Your_Build_Environment.md @@ -10,7 +10,7 @@ run to initialize the build environment. 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 @@ -18,7 +18,7 @@ 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: ```sh -$ cd $AGL_TOP/master +$ cd $AGL_TOP/lamprey $ source meta-agl/scripts/aglsetup.sh -h ``` @@ -33,32 +33,33 @@ Following is a list of the available machines (level of support varies!): ```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 @@ -73,53 +74,44 @@ Following is a list of the available 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. @@ -190,18 +182,11 @@ Following are brief descriptions of the AGL features you can specify on the [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. @@ -256,7 +241,7 @@ Common targets are: 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. diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md b/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md index d1d4101..6330e89 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/4_Customizing_Your_Build.md @@ -128,7 +128,7 @@ using mirrors. 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 @@ -141,7 +141,7 @@ section of the Yocto Project Reference Manual. $ 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; diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md b/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md index 0f2121c..b215fb0 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/5_1_x86_Emulation_and_Hardware.md @@ -94,7 +94,7 @@ If you built your image with bitbake, you can now just use the ``runqemu`` wrapp 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 : diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md index bfc273d..1ac9666 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/5_3_RCar_Gen_3.md @@ -1,4 +1,4 @@ -# 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. @@ -61,7 +61,7 @@ Follow these steps to download the drivers you need: | AGL Version | Renesas version | |:-:|:-:| - | AGL master | 4.7.0 | + | AGL lamprey | 4.7.0 | 3. **Download the Files:** |