Code Review / AGL / documentation.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Fix documentation for Renesas (AGL vs. BSP version)
[AGL/documentation.git] / docs / 0_Getting_Started / 2_Building_AGL_Image / 5_3_RCar_Gen_3.md
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 d0030c4..f4a9f2f 100644 (file)
--- 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
@@ -18,6 +18,15 @@ image for the following Renesas platforms:
 The information on this page describes setup and build procedures for both of these
 Renesas development kits.
 
+Additionally, the AGL Reference Hardware platform is based on the same Renesas
+H3 processor used on the Renesas R-Car Starter Kit Premier and Salvator-X boards,
+so support for it leverages the Starter Kit Premier (also known as "h3ulcb")
+build.
+For more information on the AGL reference hardware platform, please refer to its
+[manual](https://wiki.automotivelinux.org/_media/eg-rhsa/rh_manual_ver.1.0.pdf),
+or the Reference Hardware System Architecture Expert Group
+[wiki page](https://wiki.automotivelinux.org/eg-rhsa).
+
 ## 1. Downloading Proprietary Drivers
 
 Before setting up the build environment, you need to download proprietary drivers from the
@@ -52,7 +61,9 @@ Follow these steps to download the drivers you need:
 
     | AGL Version | Renesas version |
     |:-:|:-:|
-    | AGL master | 4.1.0 |
+    | AGL Koi 11.0.0 | 4.7.0 |
+    | AGL Koi 11.0.1 | 4.7.0 |
+    | AGL Koi 11.0.2 | 4.7.0 |
 
 3. **Download the Files:**
 
@@ -85,7 +96,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:**
@@ -147,17 +158,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 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:**
@@ -169,6 +182,14 @@ you need to take steps to make sure your build host is set up correctly.
     $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo
     ```
 
+    If building for the AGL Reference Hardware (with `MACHINE` set to "h3ulcb" or
+    "h3ulcb-nogfx"), add `agl-refhw-h3`, for example:
+
+    ```sh
+    $ cd $AGL_TOP
+    $ source meta-agl/scripts/aglsetup.sh -m $MACHINE -b build agl-devel agl-demo agl-refhw-h3
+    ```
+
     **NOTE:**
     Running the `aglsetup.sh` script automatically places you in the
     working directory (i.e. `$AGL_TOP/build`).
@@ -204,8 +225,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
@@ -224,18 +245,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:
     <https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-documents-software>
 
     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]
     ```
@@ -371,6 +392,10 @@ Follow these steps to update the firmware:
     ```
 
     **NOTE:** The Salvator-X firmware update process is not documented on eLinux.
+    **NOTE:** The AGL Reference Hardware board generally should not require a
+    firmware update to be usable, and has a slightly different update procedure.
+    If you do need to update the firmware, the procedure is documented
+    [here](https://git.automotivelinux.org/AGL/meta-agl-refhw/tree/meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md).
 
 ### Preparing the MicroSD Card
 
@@ -691,6 +716,8 @@ boot device and also to set the screen resolution:
 
        * **M3SK with a Kingfisher board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7796-m3ulcb-kf.dtb`
 
+       * **AGL Reference Hardware board** : `$ setenv load_dtb ext4load mmc 0:1 0x48000000 /boot/r8a7795-agl-refhw.dtb`
+
 5. Save the boot environment:
     ```sh
     saveenv
@@ -709,7 +736,7 @@ Once the board boots, you should see the
 on the external monitor.
 A login prompt should appear as follows depending on your board:
 
-**h3ulcb**:
+**h3ulcb** or **AGL Reference Hardware**:
 
 ```text
 Automotive Grade Linux ${AGL_VERSION} h3ulcb ttySC0
@@ -758,9 +785,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
This holds the documentation hosted on readthedocs.io