Add Yocto Project scarthgap release compatibility

[AGL/meta-agl-refhw.git] / README

diff --git a/README b/README
index e806db8..ed7bcd8 100644 (file)
--- a/README
+++ b/README
@@ -1,54 +1,66 @@
 This README file contains information on the contents of the meta-agl-refhw-gen3
-layer which provides the reference hardware support for AGL environment.
+layer which provides support for the Renesas R-Car H3 based AGL reference
+hardware.
 
-Dependency
-==========
+Dependencies
+============
 
-- Yocto layers of AGL Happy Halibut.
-  Especially depends on meta-renesas-rcar-gen3.
+This layer depends on:
+
+  URI: git://git.openembedded.org/openembedded-core
+  layers: meta
+  branch: kirkstone
+
+  URI: git://git.openembedded.org/meta-openembedded
+  layers: meta-oe, meta-python
+  branch: kirkstone
+
+  URI: https://github.com/renesas-rcar/meta-renesas
+  branch: kirkstone-dev_3.5_M3_v5.9.0
 
 
 Build Instructions
 ==================
 
-  I. Adding the meta-agl-refhw-gen3 layer to your AGL environment
+  I. Building with the layer in the AGL environment
  II. Build agl-demo-platform by using meta-agl-refhw-gen3
-III. Update firmware.
+III. Updating firmware
  IV. Notes
 
 
 I. Adding the meta-agl-refhw-gen3 layer to your AGL environment
-==============================================================
-
-You can add this layer to your AGL HH environemnt as following:
+===============================================================
 
-1. Put meta-refhw folder into the "$AGL_TOP/bsp" directory where AGL BSP layers
-   like meta-renesas-rcar-gen3/ are placed.
-   # See "Downloading AGL Software" in AGL developper site.
+This layer has been integrated into the AGL build environment for the UCB 11.0
+(Kooky Koi) release, so manual integration is no longer required.  See section
+(II) below for how to build an image, and the "How to build the Firmware" section
+in the document meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md for how to
+configure a standalone build without AGL.
 
-2. Put refhw-h3 folder into the meta-agl/templates/machine where other machine
-   configuration files are placed.
 
 II. Build for Reference Hardware
 ================================
-You should follow the instructions in "Building for Supported Renesas Boards"
-section in AGL developper site to build images for reference hardware.
 
-The modification needed is to set machine to "refhw-h3" when execute
-aglsetup.sh (parameter of "-m" option).
+You should follow the instructions in the "Building for Supported Renesas Boards"
+section on the AGL developer site to build images for the reference hardware.
+
+Use the "h3ulcb" machine and "agl-refhw-h3" feature when configuring, e.g.:
 
        $ cd $AGL_TOP
-       $ source meta-agl/scripts/aglsetup.sh -m refhw-h3 -b build \
-         agl-devel agl-demo agl-netboot agl-appfw-smack agl-localdev
+       $ source meta-agl/scripts/aglsetup.sh -m h3ulcb -b build \
+         agl-refhw-h3 agl-demo agl-devel
 
-The "real" MACHINE in the internal building is set to "salvator-x" so that we
-can divert the configurations defined for salvator-x. While, the DTB file used
-by reference hardware is "r8a7795-refhw.dtb". so the settings in u-boot is
-expected as following (in case of booting from the Micro SD card in SD#0):
+This works as the AGL reference hardware support activated by the "agl-refhw-h3"
+feature integrates on top of the "h3ulcb" (or "h3ulcb-nogfx") machine support in
+the AGL UCB tree.  Note that it has not been tested with the "h3ulcb-kf" machine.
+In the resulting build, the image can be used on the reference hardware by using
+the DTB file "r8a7795-agl-refhw.dtb".  In the reference hardware u-boot settings,
+this can be done with the following (in case of booting from the Micro SD card
+in SD#0):
 
        => setenv bootargs 'console=ttySC0,115200 root=/dev/mmcblk1p1 rootwait ro rootfstype=ext4'
        => setenv bootcmd 'run load_ker; run load_dtb; booti 0x48080000 - 0x48000000'
-       => setenv load_dtb 'ext4load mmc 0:1 0x48000000 /boot/r8a7795-refhw.dtb'
+       => setenv load_dtb 'ext4load mmc 0:1 0x48000000 /boot/r8a7795-agl-refhw.dtb'
        => setenv load_ker 'ext4load mmc 0:1 0x48080000 /boot/Image'
        => saveenv
        
@@ -56,16 +68,17 @@ expected as following (in case of booting from the Micro SD card in SD#0):
        ...
        bootargs=console=ttySC0,115200 root=/dev/mmcblk1p1 rootwait ro rootfstype=ext4
        bootcmd=run load_ker; run load_dtb; booti 0x48080000 - 0x48000000
-       load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7795-refhw.dtb
+       load_dtb=ext4load mmc 0:1 0x48000000 /boot/r8a7795-agl-refhw.dtb
        load_ker=ext4load mmc 0:1 0x48080000 /boot/Image
        ..
 
-III. Update firmware.
-=====================
-Please refer to meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md for detail.
+
+III. Updating firmware
+======================
+
+Please refer to meta-agl-refhw-gen3/docs/ReferenceHW_Rcar_gen3.md for details.
+
 
 IV. Notes
-==========
+=========
 1.  SD#1 is not supported.
-2.  There are suspicious HDMI0/1 interrupts detected and disabled forcely by
-    the kernel during boot. The reason is under investigation.