Rework for AGL UCB integration

Changes include:
- The provided kernel patches have been reworked to not modify the
  salvator-x(s) devicetree source, but to introduce new files for the
  reference hardware instead.  There is some possibility that the
  reference hardware devicetree could be based off the the salvator-x
  with some work and perhaps splitting of the salvator-x source, but
  for now the aim is to avoid breaking the salvator-x(s) with the
  reference hardware changes.
- The modifications to the r8a7795 pinctrl driver have been replaced
  with a splitting of the USB interface OVC pins into their own pin
  groups, which has previously been done for other older Renesas
  hardware.  This allows booting the reference hardware off of the
  same kernel as other H3 boards, at the expense of minor devicetree
  modifications for them (e.g. h3ulcb).  There is likely some more
  work required if this needs to be upstreamed, as the ulcb.dtsi
  changes would mean that the pinctrl drivers for M3 would also need
  the new pin groups.
- All changes for the ST asm330lhh driver addtion have been moved to
  that patch to the kernel.
- A machine conf file has been added for "agl-refhw-h3", and the
  firmware documentation updated to document how to set up a build of
  the firmware using it.  This is required due to the firmware options
  from this layer's arm-trusted-firmware bbappend not being compatible
  with other H3 boards (eMMC versus Hyperflash boot).  A definition
  of the COMPATIBLE_MACHINE variable has been added to that bbappend
  to make sure that attempting to use it with another H3 machine will
  trigger an error.  In AGL, the bbappend will need to be masked out
  with BBMASK for now.
- The top-level README file has been updated to reflect the expected
  integration in AGL.

Bug-AGL: SPEC-3658

Signed-off-by: Scott Murray <scott.murray@konsulko.com>

1 files changed, 46 insertions, 32 deletions

diff --git a/README b/README
index e806db8..aa8e63d 100644
--- a/README
+++ b/README
@@ -1,54 +1,65 @@
 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: dunfell
+
+  URI: git://git.openembedded.org/meta-openembedded
+  layers: meta-oe, meta-python
+  branch: dunfell
+
+  URI: https://github.com/renesas-rcar/meta-renesas
+  branch: dunfell-dev-4.14
 
 
 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 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 h3uclb -b build \
+	  agl-devel agl-demo agl-localdev
 
-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 has been integrated with the
+"h3ulcb" (and "h3ulcb-nogfx") machine templates in the AGL UCB tree.  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 +67,19 @@ 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
+2.  There are suspicious HDMI0/1 interrupts detected and disabled forcibly by
     the kernel during boot. The reason is under investigation.