meta-xilinx-core: README.md update to explain recent changes

Signed-off-by: Mark Hatle <mark.hatle@xilinx.com>

1 files changed, 32 insertions, 1 deletions

diff --git a/meta-xilinx-core/README.md b/meta-xilinx-core/README.md
index cb6c06c8..8997760c 100644
--- a/meta-xilinx-core/README.md
+++ b/meta-xilinx-core/README.md
@@ -27,6 +27,37 @@ This layer depends on:
         URI: git://git.openembedded.org/openembedded-core
         layers: meta
 
+Configuring Machines
+====================
+
+All machines that use meta-xilinx-tools should be derived from one of the
+following: microblaze-generic, zynq-generic, zynqmp-generic, or 
+versal-generic.
+
+microblaze-generic requries the include of the meta-microblaze layer
+
+zynq-generic, zynqmp-generic and versal-generic each require a device-tree
+to be defined.  The device tree can be manually passed in via the
+variable CONFIG_DTFILE.  Note, some items in the system may expect the
+device-tree to be referenced to system-top.dtb.
+Enabling meta-xilinx-tools will generate the appropriate device tree in most
+cases.
+
+Zynqmp-generic requires pmu-firmware.  The firmware can be passed directly
+as a path to a binary: PMU_FILE, you may use the generic built version
+by including meta-xilinx-standalone, the XSCT version by adding
+meta-xilinx-tools or the DTB workflow version using
+meta-xilinx-standalone-experimental.
+
+Versal-generic requires both PLM and PSM firmware to be specified.  They can
+be specified as a path to a binary using PLM_FILE and PSM_FILE.  Or they can
+be generated by including meta-xilinx-standalone, the XSCT version by adding
+meta-xilinx-tools or the DTB workflow version using
+meta-xilinx-standalone-experimental.  Additionally some configurations may
+require you to specify the path to a PDI file using PDI_PATH.  The XSCT
+version will extract the PDI automatically.
+
+
 Recipe Licenses
 ===============
 
@@ -41,7 +72,7 @@ In order to use recipes that rely on restricted content the `xilinx` license
 flag must be white-listed in the build configuration (e.g. `local.conf`). This
 can be done on a per package basis:
 
-        LICENSE_FLAGS_WHITELIST += "xilinx_pmu-rom"
+        LICENSE_FLAGS_WHITELIST += "xilinx_pmu-rom-native"
 
 or generally: