aboutsummaryrefslogtreecommitdiffstats
path: root/docs/01_Getting_Started
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2024-11-19 15:56:45 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2025-01-02 21:34:38 +0000
commitbfd2802190a0bf15c8551e0369f8ff9d8c997a45 (patch)
tree96100a86b62ba8e0a55a5de8178cfbfb038a2587 /docs/01_Getting_Started
parent32d269ea365f6c944b3222332eb9d99c6eb92a45 (diff)
Update documentation
Update names of images. Remove out-of-date sections and streamline page. Bug-AGL: SPEC- Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: I140cc290204564c4d1f026b2e975f3ce04e2afb9 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30528
Diffstat (limited to 'docs/01_Getting_Started')
-rw-r--r--docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md48
-rw-r--r--docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md13
2 files changed, 34 insertions, 27 deletions
diff --git a/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md b/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md
index a019337..1d07ebf 100644
--- a/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md
+++ b/docs/01_Getting_Started/01_Quickstart/01_Using_Ready_Made_Images.md
@@ -8,7 +8,7 @@ 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/release/ricefish/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.ext4.xz).
2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemux86-64/deploy/images/qemux86-64/bzImage).
@@ -28,7 +28,7 @@ AGL provides a number of pre-built ready-made images of various versions.
```sh
$ mkdir ~/agl-demo/
- $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz ~/agl-demo/
+ $ cp ~/Downloads/agl-ivi-demo-qt-qemux86-64.ext4.xz ~/agl-demo/
$ cp ~/Downloads/bzImage ~/agl-demo/
$ cd ~/agl-demo
$ sync
@@ -37,7 +37,7 @@ AGL provides a number of pre-built ready-made images of various versions.
6. Extract prebuilt compressed image :
```sh
- $ xz -v -d agl-ivi-demo-qt-crosssdk-qemux86-64.ext4.xz
+ $ xz -v -d agl-ivi-demo-qt-qemux86-64.ext4.xz
```
7. Launch QEMU with vinagre (for scaling), remove `- snapshot \` if you want to save changes to the image files :
@@ -45,7 +45,7 @@ AGL provides a number of pre-built ready-made images of various versions.
```sh
$ ( sleep 5 && vinagre --vnc-scale localhost ) > /tmp/vinagre.log 2>&1 &
$ qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \
- -drive file=agl-ivi-demo-qt-crosssdk-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \
+ -drive file=agl-ivi-demo-qt-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \
-snapshot -vga virtio \
-vnc :0 -soundhw hda -machine q35 -cpu kvm64 -cpu qemu64,+ssse3,+sse4.1,+sse4.2,+popcnt -enable-kvm \
-m 2048 -serial mon:vc -serial mon:stdio -serial null -kernel bzImage \
@@ -66,7 +66,7 @@ AGL provides a number of pre-built ready-made images of various versions.
```sh
$ ( sleep 5 && vncviewer ) &
qemu-system-x86_64 -device virtio-net-pci,netdev=net0,mac=52:54:00:12:35:02 -netdev user,id=net0,hostfwd=tcp::2222-:22 \
- -drive file=agl-ivi-demo-qt-crosssdk-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \
+ -drive file=agl-ivi-demo-qt-qemux86-64.ext4,if=virtio,format=raw -show-cursor -usb -usbdevice tablet -device virtio-rng-pci \
-snapshot -vga virtio \
-vnc :0 -soundhw hda -machine q35 -cpu kvm64 -cpu qemu64,+ssse3,+sse4.1,+sse4.2,+popcnt -enable-kvm \
-m 2048 -serial mon:vc -serial mon:stdio -serial null -kernel bzImage \
@@ -78,11 +78,11 @@ 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-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk.xz).
+ 1. Download the [compressed vbox disk image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.wic.vmdk.xz).
2. Install and set up [Virtual Box](https://www.virtualbox.org/wiki/Linux_Downloads).
- 3. Extract the vmdk file : `$ xz -v -d agl-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk.xz`
+ 3. Extract the vmdk file : `$ xz -v -d agl-ivi-demo-qt-qemux86-64.wic.vmdk.xz`
4. Configure virtual box for AGL :
- Click on `New` or `Add`.
@@ -92,7 +92,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
![vbox-step-1](images/vbox-1.png)
- Select Memory size. Recommended is `2048 MB`, click on `Next`.
![vbox-step-2](images/vbox-2.png)
- - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-ivi-demo-qt-crosssdk-qemux86-64.wic.vmdk` file, click on `Create`.
+ - Click on `Use an existing virtual hard disk file`, and select the extracted `agl-ivi-demo-qt-qemux86-64.wic.vmdk` file, click on `Create`.
![vbox-step-3](images/vbox-3.png)
- Go to `Settings`, and into `System`. Select `Chipset : IHC9`. Check on `Enable EFI (special OSes only)` and click on `OK`.
![vbox-step-4](images/vbox-4.png)
@@ -110,14 +110,14 @@ 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-ivi-demo-qt-crosssdk-qemux86-64.wic.xz).
+ 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/snapshots/master/latest/qemux86-64/deploy/images/qemux86-64/agl-ivi-demo-qt-qemux86-64.wic.xz).
2. Extract the image into USB drive :
```sh
$ lsblk
$ sudo umount <usb_device_name>
- $ xzcat agl-ivi-demo-qt-crosssdk-qemux86-64.wic.xz | sudo dd of=<usb_device_name> bs=4M
+ $ xzcat agl-ivi-demo-qt-qemux86-64.wic.xz | sudo dd of=<usb_device_name> bs=4M
$ sync
```
@@ -128,7 +128,7 @@ 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/release/ricefish/latest/qemuarm/deploy/images/qemuarm/agl-ivi-demo-qt-crosssdk-qemuarm.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm/deploy/images/qemuarm/agl-ivi-demo-qt-qemuarm.ext4.xz).
2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm/deploy/images/qemuarm/zImage).
@@ -148,7 +148,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
```sh
$ mkdir ~/agl-demo/
- $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemuarm.ext4.xz ~/agl-demo/
+ $ cp ~/Downloads/agl-ivi-demo-qt-qemuarm.ext4.xz ~/agl-demo/
$ cp ~/Downloads/zImage ~/agl-demo/
$ cd ~/agl-demo
$ sync
@@ -157,7 +157,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
6. Extract prebuilt compressed image :
```sh
- $ xz -v -d agl-ivi-demo-qt-crosssdk-qemuarm.ext4.xz
+ $ xz -v -d agl-ivi-demo-qt-qemuarm.ext4.xz
```
7. Launch QEMU with vinagre (for scaling), remove `- snapshot` if you want to save changes to the image files :
@@ -170,7 +170,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
-device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on -vnc :0 \
-device qemu-xhci -device usb-tablet -device usb-kbd \
-kernel zImage -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false" \
- -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm.ext4 \
+ -drive format=raw,file=agl-ivi-demo-qt-qemuarm.ext4 \
-snapshot
```
@@ -193,7 +193,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
-device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on -vnc :0 \
-device qemu-xhci -device usb-tablet -device usb-kbd \
-kernel zImage -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false" \
- -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm.ext4 \
+ -drive format=raw,file=agl-ivi-demo-qt-qemuarm.ext4 \
-snapshot
```
@@ -201,7 +201,7 @@ 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/release/ricefish/latest/qemuarm64/deploy/images/qemuarm64/agl-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz).
+1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm64/deploy/images/qemuarm64/agl-ivi-demo-qt-qemuarm64.ext4.xz).
2. Download the [compressed kernel image](https://download.automotivelinux.org/AGL/release/ricefish/latest/qemuarm64/deploy/images/qemuarm64/Image).
@@ -221,7 +221,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
```sh
$ mkdir ~/agl-demo/
- $ cp ~/Downloads/agl-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz ~/agl-demo/
+ $ cp ~/Downloads/agl-ivi-demo-qt-qemuarm64.ext4.xz ~/agl-demo/
$ cp ~/Downloads/zImage ~/agl-demo/
$ cd ~/agl-demo
$ sync
@@ -230,7 +230,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
6. Extract prebuilt compressed image :
```sh
- $ xz -v -d agl-ivi-demo-qt-crosssdk-qemuarm64.ext4.xz
+ $ xz -v -d agl-ivi-demo-qt-qemuarm64.ext4.xz
```
7. Launch QEMU with vinagre (for scaling), remove `- snapshot \` if you want to save changes to the image files :
@@ -243,7 +243,7 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
-device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on \
-device qemu-xhci -device usb-tablet -device usb-kbd -vnc :0 \
-kernel Image -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false " \
- -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm64.ext4 \
+ -drive format=raw,file=agl-ivi-demo-qt-qemuarm64.ext4 \
-snapshot
```
@@ -266,20 +266,20 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
-device virtio-rng-pci -device VGA,vgamem_mb=64,edid=on \
-device qemu-xhci -device usb-tablet -device usb-kbd -vnc :0 \
-kernel Image -append "console=ttyAMA0,115200 root=/dev/vda verbose systemd.log_color=false " \
- -drive format=raw,file=agl-ivi-demo-qt-crosssdk-qemuarm64.ext4 \
+ -drive format=raw,file=agl-ivi-demo-qt-qemuarm64.ext4 \
-snapshot
```
### 2. Raspberry Pi 4
- 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-ivi-demo-qt-crosssdk-raspberrypi4-64.wic.xz).
+ 1. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/raspberrypi4/deploy/images/raspberrypi4-64/agl-ivi-demo-qt-raspberrypi4-64.wic.xz).
2. Extract the image into the SD card of Raspberry Pi 4 :
```sh
$ lsblk
$ sudo umount <sdcard_device_name>
- $ xzcat agl-ivi-demo-qt-crosssdk-raspberrypi4-64.wic.xz | sudo dd of=<sdcard_device_name> bs=4M
+ $ xzcat agl-ivi-demo-qt-raspberrypi4-64.wic.xz | sudo dd of=<sdcard_device_name> bs=4M
$ sync
```
@@ -342,14 +342,14 @@ The AGL demo images do require 1920x1080. The instructions below have been adapt
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/).
- 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-ivi-demo-qt-crosssdk-h3ulcb.wic.xz).
+ 2. Download the [compressed prebuilt image](https://download.automotivelinux.org/AGL/release/ricefish/latest/h3ulcb-nogfx/deploy/images/h3ulcb/agl-ivi-demo-qt-h3ulcb.wic.xz).
3. Extract the image into the boot device :
```sh
$ lsblk
$ sudo umount <boot_device_name>
- $ xzcat agl-ivi-demo-qt-crosssdk-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M
+ $ xzcat agl-ivi-demo-qt-h3ulcb.wic.xz | sudo dd of=<boot_device_name> bs=4M
$ sync
```
diff --git a/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md b/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md
index 397d478..113fd44 100644
--- a/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md
+++ b/docs/01_Getting_Started/02_Building_AGL_Image/04_Initializing_Your_Build_Environment.md
@@ -33,8 +33,13 @@ Following is a list of the available machines (level of support varies!):
```sh
Available machines:
[meta-agl]
+ am62xx-evm
+ aws-ec2-arm64
+ aws-ec2-x86-64
bbe # BeagleBoneEnhanced
beaglebone # BeagleBone
+ beaglebone-ai64
+ beagleplay
cubox-i # multiple i.MX6 boards
dragonboard-410c # Qualcomm Dragonboard 410c
dragonboard-820c # Qualcomm Dragonboard 820c
@@ -49,6 +54,7 @@ Available machines:
imx8mqevk-viv # i.MX8 w vivante
intel-corei7-64 # x86-64 (Intel flavour)
j7-evm # TI Jacinto 7 EVM
+ jetson-agx-orin-devkit
m3-salvator-x # Renesas RCar Salvator/M3
m3ulcb # Renesas RCar M3
m3ulcb-kf # Renesas RCar M3 w Kingfisher Board
@@ -56,10 +62,12 @@ Available machines:
nitrogen6x # i.MX6 nitrogen board
qemuarm # Qemu ARM
qemuarm64 # Qemu AArch 64 (ARM 64bit)
+ qemuriscv64
* qemux86-64 # Qemu x86-64
raspberrypi4 # Raspberry Pi 4
- virtio-aarch64 # Virtio Guest
-
+ raspberrypi5 # Raspberry Pi 5
+ s4sk
+ unmatched
```
## AGL Features
@@ -108,7 +116,6 @@ Available features:
[meta-agl-devel] # Development layer
Refer: https://git.automotivelinux.org/AGL/meta-agl-devel/tree/templates/feature
- agl-basesystem # Toyota basesystem
agl-drm-lease # DRM lease support
agl-egvirt # EG-Virt feature
agl-flutter # Flutter support