embeddedsw: Rework the embeddedsw copy firmware recipes

fsbl, plmfw, pufw, and psmfw are reworked to provide earlier error messages,
and better handle multiconfig builds.

Also adjust MACHINE specific changes to use .* for compatibility based on the
SOC_FAMILY override.  The system doesn't always set the SOC_FAMILY as
COMPATIBLE_MACHINE, so this avoids an error of incompatible machine.

Align all of the expected firmware filenames to be <firmware>-${MACHINE}.
The user can override as necessary.

The license moves to CLOSED as we don't know the license of the software being
provided by the user or other dependencies.  It'll be up to the user to
reconcile it.

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

10 files changed, 90 insertions, 3 deletions

diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl-fw-cfg.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl-fw-cfg.inc
new file mode 100644
index 00000000..5499befd
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl-fw-cfg.inc
@@ -0,0 +1,7 @@
+# Default fsbl configuration, using fsbl-fw multiconfig
+#
+# This requires MULTICONFIG += "fsbl-fw" to be added to local.conf
+FSBL_DEPENDS ?= ""
+FSBL_MCDEPENDS ?= "mc::fsbl-fw:fsbl-firmware:do_deploy"
+FSBL_DEPLOY_DIR ?= "${TOPDIR}/tmp-fsbl-fw/deploy/images/${MACHINE}"
+FSBL_IMAGE_NAME ?= "fsbl"
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl.bbappend b/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl.bbappend
new file mode 100644
index 00000000..5b02e3de
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/fsbl.bbappend
@@ -0,0 +1,9 @@
+# Include the fsbl-fw setting, if it's enabled
+FSBL_INC = "${@bb.utils.contains('BBMULTICONFIG', 'fsbl-fw', 'fsbl-fw-cfg.inc', '', d)}"
+require ${FSBL_INC}
+
+def check_fsbl_variables(d):
+    if not d.getVar('FSBL_DEPENDS') and not d.getVar('FSBL_MCDEPENDS') and not (d.getVar('BBMULTICONFIG') and 'fsbl-fw' in d.getVar('BBMULTICONFIG').split()):
+        if not os.path.exists(d.getVar('FSBL_FILE') + ".elf"):
+            d.setVar('BB_DONT_CACHE', '1')
+            raise bb.parse.SkipRecipe("The expect file %s.elf is not available.\nEither specify FSBL_FILE, or you may need to enable BBMULTICONFIG += 'fsbl-fw' to generate it." % d.getVar('FSBL_FILE'))
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/plm-firmware.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/plm-firmware.inc
index 355a55ed..44e428ff 100644
--- a/meta-xilinx-standalone/recipes-bsp/embeddedsw/plm-firmware.inc
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/plm-firmware.inc
@@ -65,7 +65,7 @@ do_install() {
 PACKAGES = ""
 
 # This is the default in most BSPs.  A MACHINE.conf can override this!
-PLM_IMAGE_NAME ??= "plm-versal-mb"
+PLM_IMAGE_NAME ??= "plm-${MACHINE}"
 
 inherit image-artifact-names
 
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/plmfw.bbappend b/meta-xilinx-standalone/recipes-bsp/embeddedsw/plmfw.bbappend
new file mode 100644
index 00000000..d63529ff
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/plmfw.bbappend
@@ -0,0 +1,17 @@
+# Include the versal-fw setting, if it's enabled
+PLMFW_INC = "${@bb.utils.contains('BBMULTICONFIG', 'versal-fw', 'versal-fw-cfg.inc', '', d)}"
+require ${PLMFW_INC}
+
+def check_plm_vars(d):
+    if not d.getVar('PLM_DEPENDS') and not d.getVar('PLM_MCDEPENDS') and not (d.getVar('BBMULTICONFIG') and 'versal-fw' in d.getVar('BBMULTICONFIG').split()):
+        msg = ""
+        fail = False
+        if not os.path.exists(d.getVar('PLM_FILE') + ".elf"):
+            msg = msg + "The expected file %s.elf is not available.  " % d.getVar('PLM_FILE')
+            fail = True
+        if not os.path.exists(d.getVar('PLM_FILE') + ".bin"):
+            msg = msg + "The expected file %s.bin is not available.  " % d.getVar('PLM_FILE')
+            fail = True
+        if fail:
+            d.setVar('BB_DONT_CACHE', '1')
+            raise bb.parse.SkipRecipe("%s\nEither specify PLM_FILE, or you may need to enable BBMULTICONFIG += 'versal-fw' to generate it." % msg)
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmu-firmware.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmu-firmware.inc
index 22352fab..b789af5d 100644
--- a/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmu-firmware.inc
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmu-firmware.inc
@@ -64,7 +64,7 @@ do_install() {
 PACKAGES = ""
 
 # This is the default in most BSPs.  A MACHINE.conf can override this!
-PMU_FIRMWARE_IMAGE_NAME ??= "pmu-firmware-zynqmp-pmu"
+PMU_FIRMWARE_IMAGE_NAME ??= "pmu-firmware-${MACHINE}"
 
 inherit image-artifact-names
 
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmufw.bbappend b/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmufw.bbappend
new file mode 100644
index 00000000..947408a1
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/pmufw.bbappend
@@ -0,0 +1,17 @@
+# Include the zynqmp-pmufw setting, if it's enabled
+PMUFW_INC = "${@bb.utils.contains('BBMULTICONFIG', 'zynqmp-pmufw', 'zynqmp-pmufw-cfg.inc', '', d)}"
+require ${PMUFW_INC}
+
+def check_pmu_vars(d):
+    if not d.getVar('PMU_DEPENDS') and not d.getVar('PMU_MCDEPENDS') and not (d.getVar('BBMULTICONFIG') and 'zynqmp-pmufw' in d.getVar('BBMULTICONFIG').split()):
+        msg = ""
+        fail = False
+        if not os.path.exists(d.getVar('PMU_FILE') + ".elf"):
+            msg = msg + "The expected file %s.elf is not available.  " % d.getVar('PMU_FILE')
+            fail = True
+        if not os.path.exists(d.getVar('PMU_FILE') + ".bin"):
+            msg = msg + "The expected file %s.bin is not available.  " % d.getVar('PMU_FILE')
+            fail = True
+        if fail:
+            d.setVar('BB_DONT_CACHE', '1')
+            raise bb.parse.SkipRecipe("%s\nEither specify PMU_FILE, or you may need to enable BBMULTICONFIG += 'zynqmp-pmufw' to generate it." % msg)
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/psm-firmware.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/psm-firmware.inc
index 2bdae284..a7acfbb7 100644
--- a/meta-xilinx-standalone/recipes-bsp/embeddedsw/psm-firmware.inc
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/psm-firmware.inc
@@ -65,7 +65,7 @@ do_install() {
 PACKAGES = ""
 
 # This is the default in most BSPs.  A MACHINE.conf can override this!
-PSM_FIRMWARE_IMAGE_NAME ??= "psm-firmware-versal-mb"
+PSM_FIRMWARE_IMAGE_NAME ??= "psm-firmware-${MACHINE}"
 
 inherit image-artifact-names
 
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/psmfw.bbappend b/meta-xilinx-standalone/recipes-bsp/embeddedsw/psmfw.bbappend
new file mode 100644
index 00000000..8944152d
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/psmfw.bbappend
@@ -0,0 +1,17 @@
+# Include the versal-fw setting, if it's enabled
+PSMFW_INC = "${@bb.utils.contains('BBMULTICONFIG', 'versal-fw', 'versal-fw-cfg.inc', '', d)}"
+require ${PSMFW_INC}
+
+def check_psm_vars(d):
+    if not d.getVar('PSM_DEPENDS') and not d.getVar('PSM_MCDEPENDS') and not (d.getVar('BBMULTICONFIG') and 'versal-fw' in d.getVar('BBMULTICONFIG').split()):
+        msg = ""
+        fail = False
+        if not os.path.exists(d.getVar('PSM_FILE') + ".elf"):
+            msg = msg + "The expected file %s.elf is not available.  " % d.getVar('PSM_FILE')
+            fail = True
+        if not os.path.exists(d.getVar('PSM_FILE') + ".bin"):
+            msg = msg + "The expected file %s.bin is not available.  " % d.getVar('PSM_FILE')
+            fail = True
+        if fail:
+            d.setVar('BB_DONT_CACHE', '1')
+            raise bb.parse.SkipRecipe("%s\nEither specify PSM_FILE, or you may need to enable BBMULTICONFIG += 'versal-fw' to generate it." % msg)
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/versal-fw-cfg.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/versal-fw-cfg.inc
new file mode 100644
index 00000000..bae740e2
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/versal-fw-cfg.inc
@@ -0,0 +1,13 @@
+# Default fsbl configuration, using fsbl-fw multiconfig
+#
+# This requires MULTICONFIG += "versal-fw" to be added to local.conf
+PSM_DEPENDS ?= ""
+PSM_MCDEPENDS ?= "mc::versal-fw:psm-firmware:do_deploy"
+PSM_FIRMWARE_IMAGE_NAME ?= "psm-firmware-${MACHINE}"
+PSM_FIRMWARE_DEPLOY_DIR ?= "${TOPDIR}/tmp-microblaze-versal-fw/deploy/images/${MACHINE}"
+
+PLM_DEPENDS ?= ""
+PLM_MCDEPENDS ?= "mc::versal-fw:plm-firmware:do_deploy"
+PLM_IMAGE_NAME ?= "plm-${MACHINE}"
+PLM_DEPLOY_DIR ?= "${TOPDIR}/tmp-microblaze-versal-fw/deploy/images/${MACHINE}"
+
diff --git a/meta-xilinx-standalone/recipes-bsp/embeddedsw/zynqmp-pmufw-cfg.inc b/meta-xilinx-standalone/recipes-bsp/embeddedsw/zynqmp-pmufw-cfg.inc
new file mode 100644
index 00000000..982c4425
--- /dev/null
+++ b/meta-xilinx-standalone/recipes-bsp/embeddedsw/zynqmp-pmufw-cfg.inc
@@ -0,0 +1,7 @@
+# Default fsbl configuration, using fsbl-fw multiconfig
+#
+# This requires MULTICONFIG += "zynqmp-pmufw" to be added to local.conf
+PMU_DEPENDS ?= ""
+PMU_MCDEPENDS ?= "mc::zynqmp-pmufw:pmu-firmware:do_deploy"
+PMU_FIRMWARE_DEPLOY_DIR ?= "${TOPDIR}/tmp-microblaze-zynqmp-pmufw/deploy/images/${MACHINE}"
+PMU_FIRMWARE_IMAGE_NAME ?= "pmu-firmware-${MACHINE}"