From f89dc1a25200480f19094c468b2122462bfdfc45 Mon Sep 17 00:00:00 2001 From: Jan-Simon Möller Date: Tue, 2 Feb 2021 18:30:26 +0100 Subject: Generic updates to the documentation matching master and koi MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mostly updates to the yocto links or adding the refhw. Signed-off-by: Jan-Simon Möller Change-Id: Ib28bd5de72e7be8b2a2605e8149143fb946a7b69 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25986 --- .../1_Quickstart/Using_Ready_Made_Images.md | 9 +++--- .../2_Building_AGL_Image/0_Build_Process.md | 2 +- .../1_Preparing_Your_Build_Host.md | 10 +++---- .../3_Initializing_Your_Build_Environment.md | 22 +++++++-------- .../4_Customizing_Your_Build.md | 10 +++---- .../2_Building_AGL_Image/5_3_RCar_Gen_3.md | 32 +++++++++++----------- 6 files changed, 43 insertions(+), 42 deletions(-) (limited to 'docs/0_Getting_Started') 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 81bc630..7bbc957 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 @@ -55,7 +55,7 @@ AGL provides a number of pre-built ready-made images of various versions. - Login into AGL : ```sh - Automotive Grade Linux 9.99.4+snapshot qemux86-64 ttyS1 + Automotive Grade Linux 11.0.0+snapshot qemux86-64 ttyS1 qemux86-64 login: root ``` @@ -95,6 +95,7 @@ AGL provides a number of pre-built ready-made images of various versions. ![vbox-step-4](images/vbox-4.png) - Go to `Storage`, and change the attribute to `Type : AHCI` and click on `OK`. ![vbox-step-5](images/vbox-5.png) + - Next go to `Display` and change the attribute to 'VMSVGA' for the graphics driver. Change the graphics memory to be at least 64MB. - Click on `Start`. - For troubleshooting, you can refer [here](https://lists.automotivelinux.org/g/agl-dev-community/message/8474). @@ -152,7 +153,7 @@ AGL provides a number of pre-built ready-made images of various versions. $ xz -v -d agl-demo-platform-crosssdk-qemuarm.ext4.xz ``` -7. Launch QEMU with vinagre (for scaling), remove `- snapshot \` if you want to save changes to the image files : +7. Launch QEMU with vinagre (for scaling), remove `- snapshot` if you want to save changes to the image files : ```sh $ ( sleep 5 && vinagre --vnc-scale localhost ) > /tmp/vinagre.log 2>&1 & @@ -169,7 +170,7 @@ AGL provides a number of pre-built ready-made images of various versions. - Login into AGL : ```sh - Automotive Grade Linux 9.99.4+snapshot qemux86-64 ttyS1 + Automotive Grade Linux 11.0.0+snapshot qemux86-64 ttyS1 qemux86-64 login: root ``` @@ -265,7 +266,7 @@ AGL provides a number of pre-built ready-made images of various versions. - Login into AGL : ```sh - Automotive Grade Linux 9.99.4+snapshot qemux86-64 ttyS1 + Automotive Grade Linux 11.0.0+snapshot qemux86-64 ttyS1 qemux86-64 login: root ``` diff --git a/docs/0_Getting_Started/2_Building_AGL_Image/0_Build_Process.md b/docs/0_Getting_Started/2_Building_AGL_Image/0_Build_Process.md index fe6f687..0d78f7f 100644 --- a/docs/0_Getting_Started/2_Building_AGL_Image/0_Build_Process.md +++ b/docs/0_Getting_Started/2_Building_AGL_Image/0_Build_Process.md @@ -29,5 +29,5 @@ elsewhere. 4. Make sure your build configuration is defined exactly how you want it for your build. 5. Use - [BitBake](https://yoctoproject.org/docs/3.1.2/bitbake-user-manual/bitbake-user-manual.html) + [BitBake](https://yoctoproject.org/docs/3.1.4/bitbake-user-manual/bitbake-user-manual.html) to build your image. 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 14c6f6e..6acdfdd 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 @@ -6,7 +6,7 @@ Preparing your build host so that it can build an AGL image means making sure your system is set up to use the [Yocto Project](https://yoctoproject.org) OpenEmbedded build system, which is based on -[BitBake](https://yoctoproject.org/docs/3.1.2/bitbake-user-manual/bitbake-user-manual.html). +[BitBake](https://yoctoproject.org/docs/3.1.4/bitbake-user-manual/bitbake-user-manual.html). This section presents minimal information so you can prepare the build host to use the "Dunfell" version of the Yocto Project (i.e. version 3.1.2). @@ -26,7 +26,7 @@ section for more information on the ready-made images. 1. **Use a Supported Linux Distribution:** To use the AGL software, it is recommended that your build host is a native Linux machine that runs a Yocto Project supported distribution as described by the - "[Supported Linux Distributions](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#detailed-supported-distros)" + "[Supported Linux Distributions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#detailed-supported-distros)" section in the Yocto Project Reference Manual. Basically, you should be running a recent version of Ubuntu, Fedora, openSUSE, CentOS, or Debian. @@ -42,7 +42,7 @@ section for more information on the ready-made images. * Python 3.4.0 or greater If your distribution does not meet these minimal requirements, see the - "[Required Git, tar, and Python Versions](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#required-git-tar-and-python-versions)" + "[Required Git, tar, and Python Versions](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#required-git-tar-and-python-versions)" section in the Yocto Project Reference Manual for steps that you can take to be sure you have these tools. @@ -51,13 +51,13 @@ section for more information on the ready-made images. Depending on the Linux distribution you are using, the list of host packages differ. See - "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.2/yocto-project-qs/yocto-project-qs.html#packages)" + "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)" section of the Yocto Project Quick Start for information on the packages you need. **NOTE:** If you are using the CentOS distribution, you need to separately install the epel-release package and run the `makecache` command as described in - "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.2/yocto-project-qs/yocto-project-qs.html#packages)" + "[The Build Host Packages](https://www.yoctoproject.org/docs/3.1.4/yocto-project-qs/yocto-project-qs.html#packages)" section of the Yocto Project Quick Start. Aside from the packages listed in the previous section, you need the following: 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 d31b3ff..15ad5ed 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 @@ -143,7 +143,7 @@ Following are brief descriptions of the AGL features you can specify on the * **agl-ci**: Flags used for Continuous Integration (CI). Using this feature changes the value of the - [`IMAGE_FSTYPES`](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#var-IMAGE_FSTYPES) + [`IMAGE_FSTYPES`](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-IMAGE_FSTYPES) variable. * **agl-ci-change-features**: Enables features for CI builds for Gerrit changes. @@ -179,15 +179,15 @@ Following are brief descriptions of the AGL features you can specify on the agl-profile-telematics **NOTE:** For information on Package Groups, see the - "[Customizing Images Using Custom Package Groups](https://www.yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)" + "[Customizing Images Using Custom Package Groups](https://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)" section in the Yocto Project Development Tasks Manual. You can also find general information about Layers in the - "[Layers](https://www.yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#yocto-project-layers)" + "[Layers](https://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#yocto-project-layers)" section in that same manual. --> * **agl-ptest**: Enables - [Ptest](https://yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#testing-packages-with-ptest) + [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. @@ -280,10 +280,10 @@ 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: -* [Customizing Images Using local.conf](https://yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#usingpoky-extend-customimage-localconf) -* [Local](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#ref-varlocality-config-local) -* [build/conf/local.conf](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#structure-build-conf-local.conf) -* [build/conf/bblayers.conf](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf) -* [BBLAYERS](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#var-BBLAYERS) -* [User Configuration](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#user-configuration) -* [Enabling Your Layer](https://yoctoproject.org/docs/3.1.2/dev-manual/dev-manual.html#enabling-your-layer) +* [Customizing Images Using local.conf](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-localconf) +* [Local](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#ref-varlocality-config-local) +* [build/conf/local.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-local.conf) +* [build/conf/bblayers.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf) +* [BBLAYERS](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-BBLAYERS) +* [User Configuration](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#user-configuration) +* [Enabling Your Layer](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#enabling-your-layer) 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 2fec0de..d1d4101 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 @@ -47,7 +47,7 @@ BUILDHISTORY_COMMIT = "1" ``` See the -"[Maintaining Build Output Quality](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#maintaining-build-output-quality)" +"[Maintaining Build Output Quality](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#maintaining-build-output-quality)" section in the Yocto Project Reference Manual for a complete discussion on build history. @@ -64,7 +64,7 @@ INHERIT += "rm_work" ``` You can read about the class in the -"[rm_work.bbclass](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#ref-classes-rm-work)" +"[rm_work.bbclass](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#ref-classes-rm-work)" section of the Yocto Project Reference Manual for more information. ## Pointing at Shared State Cache Locations @@ -96,7 +96,7 @@ SSTATE_MIRRORS ?= "\ ``` If you want to know more about the Yocto Project sstate mechanism, see the -"[Shared State Cache](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#shared-state-cache)" +"[Shared State Cache](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#shared-state-cache)" section in the Yocto Project Reference Manual. ## Preserving the Download Directory @@ -106,7 +106,7 @@ from various upstream projects. Downloading these files can take a while, particularly if your network connection is slow. The process downloads files into a -"[download directory](https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#var-DL_DIR)". +"[download directory](https://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-DL_DIR)". The `DL_DIR` variable defines the download directory. For subsequent builds, you can preserve this directory to speed up the download part of a build. @@ -132,7 +132,7 @@ SSTATE_MIRRORS_append = " file://.* https://download.automotivelinux.org/sstate- ``` You can learn more about shared state and how it is used in the -"[Shared State Cache](https://yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#shared-state-cache)" +"[Shared State Cache](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#shared-state-cache)" section of the Yocto Project Reference Manual. ## Common Settings using Symbolic Link with site.conf 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 f97996b..4d8fca3 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 @@ -94,7 +94,7 @@ Follow these steps to download the drivers you need: You can use the following command: ```sh - chmod a+x $XDG_DOWNLOAD_DIR/*.zip + chmod a+rw $XDG_DOWNLOAD_DIR/*.zip ``` 6. **Check to be Sure the Files are Downloaded and Have the Correct Rights:** @@ -156,19 +156,19 @@ you need to take steps to make sure your build host is set up correctly. |:-:|:-:| | Starter Kit Pro/M3 | `MACHINE`=m3ulcb | | Starter Kit Pro/M3 + kingfisher support | `MACHINE`=m3ulcb-kf | - | Starter Kit Pro/M3 without graphic | `MACHINE`=m3ulcb-nogfx | + | Starter Kit Pro/M3 without graphic driver (using pixman) | `MACHINE`=m3ulcb-nogfx | | Starter Kit Premier/H3 | `MACHINE`=h3ulcb | | Starter Kit Premier/H3 + kingfisher support | `MACHINE`=h3ulcb-kf | - | Starter Kit Premier/H3 without graphic | `MACHINE`=h3ulcb-nogfx | + | Starter Kit Premier/H3 without graphic driver (using pixman) | `MACHINE`=h3ulcb-nogfx | | Salvator-X | `MACHINE`=h3-salvator-x | | AGL Reference Hardware | `MACHINE`=h3ulcb | - | AGL Reference Hardware without graphic | `MACHINE`=h3ulcb-nogfx | + | AGL Reference Hardware without graphic driver (using pixman) | `MACHINE`=h3ulcb-nogfx | For example, the following command defines and exports the `MACHINE` variable - for the Starter Kit Pro/M3 Board: + for the Starter Kit Premier/H3 Board: ```sh - $ export MACHINE=m3ulcb + $ export MACHINE=h3ulcb ``` 2. **Run the `aglsetup.sh` Script:** @@ -223,8 +223,8 @@ you need to take steps to make sure your build host is set up correctly. https://www.renesas.com/en-us/solutions/automotive/rcar-demoboard-2.html These 2 files from there should be store in your'/home/devel/Downloads' directory. - R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip - R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip + R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip + R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip /home/working/workspace_agl_master/build_gen3 --- fragment /home/working/workspace_agl_master/meta-agl/templates/base/99_setup_EULAconf.sh --- end of setup script @@ -243,18 +243,18 @@ you need to take steps to make sure your build host is set up correctly. ~/workspace_agl/build/conf $ cat setup.log --- beginning of setup script --- fragment /home/working/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh - --- fragment /home/working/workspace_agl/meta-agl/templates/machine/m3ulcb/50_setup.sh + --- fragment /home/working/workspace_agl/meta-agl/templates/machine/h3ulcb/50_setup.sh ~/workspace_agl ~/workspace_agl/build - ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip+" NOT EXTRACTING CORRECTLY - ERROR: FILES "+/home/working/Downloads/R-car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip+" NOT EXTRACTING CORRECTLY + ERROR: FILES "+/home/working/Downloads/R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY + ERROR: FILES "+/home/working/Downloads/R-car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip+" NOT EXTRACTING CORRECTLY The graphics and multimedia acceleration packages for the R-Car Gen3 board BSP can be downloaded from: These 2 files from there should be stored in your '/home/working/Downloads' directory. - R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston5-20190802.zip - R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston5-20190802.zip + R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-weston8-20200923.zip + R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-weston8-20200923.zip ERROR: Script /home/working/workspace_agl/build/conf/setup.sh failed [snip] ``` @@ -783,9 +783,9 @@ Last login: Tue Dec 6 10:01:11 2016 from 10.0.0.13 root@m3ulcb:~# cat /etc/os-release ID="poky-agl" NAME="Automotive Grade Linux" -VERSION="3.0.0+snapshot-20161202 (chinook)" -VERSION_ID="3.0.0-snapshot-20161202" -PRETTY_NAME="Automotive Grade Linux 3.0.0+snapshot-20161202 (chinook)" +VERSION="11.0.0+snapshot-20210128 (koi)" +VERSION_ID="11.0.0-snapshot-20210128" +PRETTY_NAME="Automotive Grade Linux 11.0.0+snapshot-20210128 (koi)" ``` ## 11. Supplementary Information -- cgit 1.2.3-korg