README.building.md: Update README on build instructions

Signed-off-by: Sandeep Gundlupet Raju <sandeep.gundlupet-raju@amd.com>
Signed-off-by: Mark Hatle <mark.hatle@amd.com>

1 files changed, 78 insertions, 96 deletions

diff --git a/README.building.md b/README.building.md
index 230037c1..0638b75e 100644
--- a/README.building.md
+++ b/README.building.md
@@ -1,100 +1,82 @@
-Build Instructions
-==================
+# Build Instructions
+
+This section describes how to get your build host ready to work with meta-xilinx
+layers.
 
 The following instructions require OE-Core meta and BitBake. Poky provides these
 components, however they can be acquired separately.
 
-Initialize a build using the `oe-init-build-env` script. Once initialized
-configure `bblayers.conf` by adding the `meta-xilinx-bsp` and
-`meta-xilinx-contrib` layer. e.g.:
-
-        BBLAYERS ?= " \
-                <path to layer>/oe-core/meta \
-                <path to layer>/meta-xilinx-bsp \
-                <path to layer>/meta-xilinx-standalone \
-                <path to layer>/meta-xilinx-contrib \
-                "
-
-meta-xilinx-standalone layer provides recipes which enable building baremetal
-toolchain for PMU firmware. This layer is required for ZU+ devices which
-depends on PMU firmware
-
-meta-xilinx-contrib is a contribution layer and is optional.
-
-To build a specific target BSP configure the associated machine in `local.conf`:
-
-        MACHINE ?= "zc702-zynq7"
-
-Build the target file system image using `bitbake`:
-
-        $ bitbake core-image-minimal
-
-Once complete the images for the target machine will be available in the output
-directory `tmp/deploy/images/<machine name>/`.
-
-Using SPL flow to build ZU+
-------------------------------
-
-The pmufw needs a "configuration object" to know what it should do, and it
-expects to receive it at runtime.
-
-With the U-Boot SPL workflow there's no FSBL, and passing a cfg obj to pmufw is
-just not implemented in U-Boot
-
-To work around this problem a small patch has been developed so that
-pm_cfg_obj.c is linked into pmufw and loaded directly, without waiting for it
-from the outside. Find the original patch on the meta-topic layer [1] and the
-patch updated for pmufw 2018.x here [2].
-
-[1]
-https://github.com/topic-embedded-products/meta-topic/blob/master/recipes-bsp/pmu-firmware/pmu-firmware_2017.%25.bbappend
-
-[2]
-https://github.com/lucaceresoli/zynqmp-pmufw-builder/blob/master/0001-Load-XPm_ConfigObject-at-boot.patch
-
-
-Using multiconfig to build ZU+
-------------------------------
-
-In your local.conf multiconfig should be enabled by:
-
-`BBMULTICONFIG ?= "pmu"`
-
-Add a directory conf/multiconfig in the build directory and create pmu.conf inside it.
-
-Add the following in pmu.conf: 
-
-        MACHINE="zynqmp-pmu" 
-        DISTRO="xilinx-standalone" 
-        TMPDIR="${TOPDIR}/pmutmp" 
-
-Add the following in your local.conf
-
-        MACHINE="zcu102-zynqmp" 
-        DISTRO="poky" 
-
-A multiconfig dependency has to be added in the image recipe or local.conf.
-
-For example in core-image-minimal you would need: 
-
-        do_image[mcdepends] = "multiconfig::pmu:pmu-firmware:do_deploy"
-
-This creates a multiconfig dependency between the task do_image from the default multiconfig '' (which has no name)
-to the task do_deploy() from the package pmu-firmware from the pmu multiconfig which was just created above.
-
-        $ bitbake core-image-minimal
-
-This will build both core-image-minimal and pmu-firmware.
-
-
-More information about multiconfig:
-https://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html#dev-building-images-for-multiple-targets-using-multiple-configurations
-
-
-Additional Information
-----------------------
-
-For more complete details on setting up and using Yocto/OE refer to the Yocto
-Project Quick Start guide available at:
-        http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html
-
+> **Pre-requisites:** Refer [Preparing Build Host](https://docs.yoctoproject.org/4.1.2/singleindex.html#preparing-the-build-host) documentation.
+
+1. Create a project directory.
+```
+$ mkdir sources
+$ cd sources
+```
+2. Clone the poky, openembedded and amd xilinx repository.
+> **Note:**
+> * *release_branch:* refers to upstream stable release branch.
+> * *rel-version:* refers to amd xilinx release version.
+```
+$ mkdir sources
+$ git clone -b <release-branch> https://git.yoctoproject.org/poky.git
+$ git clone -b <release-branch> https://git.openembedded.org/meta-openembedded.git
+$ git clone -b <rel-version> https://github.com/Xilinx/meta-xilinx.git
+```
+3. Initialize a build environment using the `oe-init-build-env` script. 
+```
+$ source poky/oe-init-build-env
+```
+4. Once initialized configure `bblayers.conf` add `meta-xilinx` layer as shown
+   below using `bitbake-layers` command
+```
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-microbalze
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-xilinx-core
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-xilinx-standalone
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-xilinx-bsp
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-xilinx-vendor
+$ bitbake-layers add-layer ./<path-to-layer>/meta-xilinx/meta-xilinx-contrib
+```
+5. Set hardware `MACHINE` configuration variable in <proj-dir>/build/conf/local.conf
+   file for a specific target which can boot and run the in the board or QEMU.
+```
+MACHINE = "<target_machine_name>"
+```
+Available target machines are:
+
+| Device     | target machines     |
+|------------|---------------------|
+| MicroBlaze | microblaze-generic  |
+|            | ac701-microblazeel  |
+|            | kc705-microblazeel  |
+|            | kcu105-microblazeel |
+|            | vcu118-microblazeel |
+| Zynq-7000  | zynq-generic        |
+|            | zc702-zynq7         |
+|            | zc706-zynq7         |
+| ZynqMP     | zynqmp-generic      |
+|            | zcu102-zynqmp       |
+|            | zcu104-zynqmp       |
+|            | zcu106-zynqmp       |
+|            | zcu111-zynqmp       |
+|            | zcu208-zynqmp       |
+|            | zcu216-zynqmp       |
+|            | zcu670-zynqmp       |
+|            | zcu1275-zynqmp      |
+|            | zcu1285-zynqmp      |
+|            | ultra96-zynqmp      |
+| Versal     | versal-generic      |
+|            | versal-net-generic  |
+|            | vck190-versal       |
+|            | vmk180-versal       |
+|            | vek280-versal       |
+|            | vpk120-versal       |
+|            | vpk180-versal       |
+|            | vhk158-versal       |
+
+6. Build an OS image for the target using `bitbake` command.
+```
+$ bitbake core-image-minimal
+```
+7. Once complete the images for the target machine will be available in the output
+   directory `${TMPDIR}/deploy/images/${MACHINE}/`.