qemu-xilinx cleanup

Refactor qemuboot-xilinx.bbclass and machine-xilinx-qemu.inc.  Following
the example of the core version of qemu.bbclass and match inc file.

Refactor some of the functions to make them more readable.  Specifically
around qemu_rootfs_params.  Code may not be as compact, but it'll be
easier to read (and update) in the future.

Add mising qemu-system-native PREFERRED_PROVIDER (and recipe PROVIDE).
This resolves the issue where occasionally you use runqemu and the qemu
binary appears to be missing.

*-generic.conf: Remove overrides that are the same as the default qemu
settings.

Remove :append operations on QB_OPT_APPEND, this allows easy override
when someone includes a generic machine.

Signed-off-by: John Toomey <jtoomey@xilinx.com>
Signed-off-by: Mark Hatle <mark.hatle@amd.com>
Signed-off-by: Mark Hatle <mark.hatle@kernel.crashing.org>

7 files changed, 134 insertions, 125 deletions

diff --git a/meta-xilinx-core/classes/qemuboot-xilinx.bbclass b/meta-xilinx-core/classes/qemuboot-xilinx.bbclass
index 59d3f0ab..0f7c75ed 100644
--- a/meta-xilinx-core/classes/qemuboot-xilinx.bbclass
+++ b/meta-xilinx-core/classes/qemuboot-xilinx.bbclass
@@ -10,6 +10,12 @@ QB_MACHINE_XILINX:aarch64 = "-machine arm-generic-fdt"
 QB_MACHINE_XILINX:arm = "-M arm-generic-fdt-7series"
 QB_MACHINE_XILINX:microblaze = "-M microblaze-fdt-plnx"
 
+QB_SYSTEM_NAME = "${@qemu_target_binary(d)}"
+QB_DEFAULT_FSTYPE = "${@qemu_rootfs_params(d,'fstype')}"
+QB_ROOTFS = "${@qemu_rootfs_params(d,'rootfs')}"
+QB_ROOTFS_OPT = "${@qemu_rootfs_params(d,'rootfs-opt')}"
+QB_DTB = "${@qemu_default_dtb(d)}"
+
 # defaults
 QB_DEFAULT_KERNEL ?= "none"
 QB_DEFAULT_KERNEL:zynq ?= "${@'zImage' if \
@@ -19,6 +25,118 @@ QB_DEFAULT_KERNEL:microblaze ?= "${@'simpleImage.mb' if \
 
 inherit qemuboot
 
+def qemu_target_binary(data):
+    package_arch = data.getVar("PACKAGE_ARCH")
+    qemu_target_binary = (data.getVar("QEMU_TARGET_BINARY_%s" % package_arch) or "")
+    if qemu_target_binary:
+        return qemu_target_binary
+
+    target_arch = data.getVar("TARGET_ARCH")
+    if target_arch == "microblazeeb":
+        target_arch = "microblaze"
+    elif target_arch == "aarch64":
+        target_arch += "-multiarch"
+    elif target_arch == "arm":
+        target_arch = "aarch64"
+    return "qemu-system-%s" % target_arch
+
+def qemu_add_extra_args(data):
+    initramfs_image = data.getVar('INITRAMFS_IMAGE') or ""
+    bundle_image = data.getVar('INITRAMFS_IMAGE_BUNDLE') or ""
+    deploy_dir = data.getVar('DEPLOY_DIR_IMAGE') or ""
+    machine_name = data.getVar('MACHINE') or ""
+    soc_family = data.getVar('SOC_FAMILY') or ""
+    qb_extra_args = ''
+    # Add kernel image and boot.scr to qemu boot command when initramfs_image supplied
+    kernel_name = ''
+    bootscr_image = '%s/boot.scr' % deploy_dir
+    if soc_family in ('zynqmp', 'versal'):
+        kernel_name = 'Image'
+        bootscr_loadaddr = '0x20000000'
+    if initramfs_image:
+        kernel_image = '%s/%s' % (deploy_dir, kernel_name)
+        if bundle_image == "1":
+            kernel_image = '%s/%s-initramfs-%s.bin' % (deploy_dir, kernel_name, machine_name)
+        kernel_loadaddr = '0x200000'
+        if kernel_name:
+            qb_extra_args = ' -device loader,file=%s,addr=%s,force-raw=on' % (kernel_image, kernel_loadaddr)
+            qb_extra_args += ' -device loader,file=%s,addr=%s,force-raw=on' % (bootscr_image, bootscr_loadaddr)
+        if soc_family == 'versal':
+            qb_extra_args += ' -boot mode=5'
+    else:
+        if soc_family in ('zynqmp', 'versal'):
+            qb_extra_args = ' -boot mode=5'
+    return qb_extra_args
+
+def qemu_rootfs_params(data, param):
+    initramfs_image = data.getVar('INITRAMFS_IMAGE') or ""
+    bundle_image = data.getVar('INITRAMFS_IMAGE_BUNDLE') or ""
+    soc_family = data.getVar('SOC_FAMILY') or ""
+    tune_features = (data.getVar('TUNE_FEATURES') or []).split()
+    if 'microblaze' in tune_features:
+        soc_family = 'microblaze'
+    soc_variant = data.getVar('SOC_VARIANT') or ""
+
+    if param == 'rootfs':
+        return 'none' if bundle_image == "1" else ''
+
+    elif param == 'fstype':
+        fstype_dict = {
+            "microblaze": "cpio.gz",
+            "zynq": "cpio.gz",
+            "zynqmp": "cpio.gz.u-boot",
+            "versal": "cpio.gz.u-boot.qemu-sd-fatimg"
+        }
+        if not initramfs_image:
+            image_fs = data.getVar('IMAGE_FSTYPES')
+            if 'wic.qemu-sd' in image_fs:
+                return 'wic.qemu-sd'
+        return fstype_dict[soc_family]
+
+    elif param == 'rootfs-opt':
+        sd_index = "1"
+        if soc_family == 'zynq':
+            sd_index = "0"
+        if soc_family == 'versal' and soc_variant == 'net':
+            sd_index = "0"
+
+        # Device is using a disk
+        if not initramfs_image:
+            return ' -drive if=sd,index=%s,file=@ROOTFS@,format=raw' % (sd_index)
+
+        # Device is using a ramdisk
+        if soc_family not in ('zynq', 'microblaze'):
+            return ' -device loader,file=@ROOTFS@,addr=0x04000000,force-raw=on'
+
+        # Ramdisk must be compiled into the kernel
+        return ''
+
+def qemu_default_dtb(data):
+    if data.getVar("IMAGE_BOOT_FILES", True):
+        dtbs = data.getVar("IMAGE_BOOT_FILES", True).split(" ")
+        # IMAGE_BOOT_FILES has extra renaming info in the format '<source>;<target>'
+        # Note: Wildcard sources work here only because runqemu expands them at run time
+        dtbs = [f.split(";")[0] for f in dtbs]
+        dtbs = [f for f in dtbs if f.endswith(".dtb")]
+        if len(dtbs) != 0:
+            return dtbs[0]
+    return ""
+
+def qemu_default_serial(data):
+    if data.getVar("SERIAL_CONSOLES", True):
+        first_console = data.getVar("SERIAL_CONSOLES", True).split(" ")[0]
+        speed, console = first_console.split(";", 1)
+        # zynqmp uses earlycon and stdout (in dtb)
+        if "zynqmp" in data.getVar("MACHINEOVERRIDES", True).split(":"):
+            return ""
+        return "console=%s,%s earlyprintk" % (console, speed)
+    return ""
+
+def qemu_zynqmp_unhalt(data, multiarch):
+    if multiarch:
+        return "-global xlnx,zynqmp-boot.cpu-num=0 -global xlnx,zynqmp-boot.use-pmufw=true"
+    return "-device loader,addr=0xfd1a0104,data=0x8000000e,data-len=4 -device loader,addr=0xfd1a0104,data=0x8000000e,data-len=4"
+
 # rewrite the qemuboot with the custom sysroot bindir
 python do_write_qemuboot_conf:append() {
     val = os.path.join(d.getVar('BASE_WORKDIR'), d.getVar('BUILD_SYS'), 'qemu-xilinx-helper-native/1.0-r1/recipe-sysroot-native/usr/bin/')
@@ -28,4 +146,3 @@ python do_write_qemuboot_conf:append() {
     with open(qemuboot, 'w') as f:
         cf.write(f)
 }
-
diff --git a/meta-xilinx-core/conf/machine/include/machine-xilinx-qemu.inc b/meta-xilinx-core/conf/machine/include/machine-xilinx-qemu.inc
index 0fcc5087..7b953975 100644
--- a/meta-xilinx-core/conf/machine/include/machine-xilinx-qemu.inc
+++ b/meta-xilinx-core/conf/machine/include/machine-xilinx-qemu.inc
@@ -1,111 +1,17 @@
 # This include is used to setup default QEMU and qemuboot config for meta-xilinx
 # machines.
 
-# Use the xilinx specific version for these users
-IMAGE_CLASSES += "qemuboot-xilinx"
-
-# depend on qemu-helper-native, which will depend on QEMU
-EXTRA_IMAGEDEPENDS += "qemu-helper-native:do_addto_recipe_sysroot"
-
 PREFERRED_PROVIDER_qemu-helper-native = "qemu-xilinx-helper-native"
 PREFERRED_PROVIDER_qemu = "qemu-xilinx"
 PREFERRED_PROVIDER_qemu-native = "qemu-xilinx-native"
+PREFERRED_PROVIDER_qemu-system-native = "qemu-xilinx-system-native"
 PREFERRED_PROVIDER_nativesdk-qemu = "nativesdk-qemu-xilinx"
 
-def qemu_add_extra_args(d):
-    initramfs_image = d.getVar('INITRAMFS_IMAGE') or ""
-    bundle_image = d.getVar('INITRAMFS_IMAGE_BUNDLE') or ""
-    deploy_dir = d.getVar('DEPLOY_DIR_IMAGE') or ""
-    machine_name = d.getVar('MACHINE') or ""
-    soc_family = d.getVar('SOC_FAMILY') or ""
-    qb_extra_args = ''
-    # Add kernel image and boot.scr to qemu boot command when initramfs_image supplied
-    kernel_name = ''
-    bootscr_image = '%s/boot.scr' % deploy_dir
-    if soc_family in ('zynqmp', 'versal'):
-        kernel_name = 'Image'
-        bootscr_loadaddr = '0x20000000'
-    if initramfs_image:
-        kernel_image = '%s/%s' % (deploy_dir, kernel_name)
-        if bundle_image == "1":
-            kernel_image = '%s/%s-initramfs-%s.bin' % (deploy_dir, kernel_name, machine_name)
-        kernel_loadaddr = '0x200000'
-        if kernel_name:
-            qb_extra_args = ' -device loader,file=%s,addr=%s,force-raw=on' % (kernel_image, kernel_loadaddr)
-            qb_extra_args += ' -device loader,file=%s,addr=%s,force-raw=on' % (bootscr_image, bootscr_loadaddr)
-        if soc_family == 'versal':
-            qb_extra_args += ' -boot mode=5'
-    else:
-        if soc_family in ('zynqmp', 'versal'):
-            qb_extra_args = ' -boot mode=5'
-    return qb_extra_args
-
-def qemu_rootfs_params(d,param):
-    initramfs_image = d.getVar('INITRAMFS_IMAGE') or ""
-    bundle_image = d.getVar('INITRAMFS_IMAGE_BUNDLE') or ""
-    soc_family = d.getVar('SOC_FAMILY') or ""
-    tune_features = (d.getVar('TUNE_FEATURES') or []).split()
-    if param == 'rootfs':
-        return 'none' if bundle_image == "1" else ''
-    elif param == 'fstype':
-        fstype_dict = {
-            "microblaze": "cpio.gz",
-            "zynq": "cpio.gz",
-            "zynqmp": "cpio.gz.u-boot",
-            "versal": "cpio.gz.u-boot.qemu-sd-fatimg"
-        }
-        if 'microblaze' in tune_features:
-            soc_family = 'microblaze'
-        if not initramfs_image:
-            image_fs = d.getVar('IMAGE_FSTYPES')
-            if 'wic.qemu-sd' in image_fs:
-                return 'wic.qemu-sd'
-        return fstype_dict[soc_family]
-
-    elif param == 'rootfs-opt':
-        if not initramfs_image or soc_family == 'versal':
-            sd_index = "1"
-            if soc_family == 'zynq': sd_index = "0"
-            return ' -drive if=sd,index=%s,file=@ROOTFS@,format=raw' % (sd_index)
-        elif soc_family not in ('zynq') or 'microblaze' in tune_features:
-            return ' -device loader,file=@ROOTFS@,addr=0x04000000,force-raw=on'
+# enable the overrides for the context of the conf only
+MACHINEOVERRIDES =. "qemuboot-xilinx:"
 
-def qemu_default_dtb(d):
-    if d.getVar("IMAGE_BOOT_FILES", True):
-        dtbs = d.getVar("IMAGE_BOOT_FILES", True).split(" ")
-        # IMAGE_BOOT_FILES has extra renaming info in the format '<source>;<target>'
-        # Note: Wildcard sources work here only because runqemu expands them at run time
-        dtbs = [f.split(";")[0] for f in dtbs]
-        dtbs = [f for f in dtbs if f.endswith(".dtb")]
-        if len(dtbs) != 0:
-            return dtbs[0]
-    return ""
-
-def qemu_default_serial(d):
-    if d.getVar("SERIAL_CONSOLES", True):
-        first_console = d.getVar("SERIAL_CONSOLES", True).split(" ")[0]
-        speed, console = first_console.split(";", 1)
-        # zynqmp uses earlycon and stdout (in dtb)
-        if "zynqmp" in d.getVar("MACHINEOVERRIDES", True).split(":"):
-            return ""
-        return "console=%s,%s earlyprintk" % (console, speed)
-    return ""
-
-def qemu_target_binary(d):
-    ta = d.getVar("TARGET_ARCH", True)
-    if ta == "microblazeeb":
-        ta = "microblaze"
-    elif ta == "arm":
-        ta = "aarch64"
-    return "qemu-system-%s" % ta
-
-def qemu_zynqmp_unhalt(d, multiarch):
-    if multiarch:
-        return "-global xlnx,zynqmp-boot.cpu-num=0 -global xlnx,zynqmp-boot.use-pmufw=true"
-    return "-device loader,addr=0xfd1a0104,data=0x8000000e,data-len=4 -device loader,addr=0xfd1a0104,data=0x8000000e,data-len=4"
+# depend on qemu-helper-native, which will depend on QEMU
+EXTRA_IMAGEDEPENDS += "qemu-system-native qemu-helper-native:do_addto_recipe_sysroot"
 
-# For qemuboot, default setup across all machines in meta-xilinx
-QB_SYSTEM_NAME:aarch64 ?= "${@qemu_target_binary(d)}-multiarch"
-QB_SYSTEM_NAME ?= "${@qemu_target_binary(d)}"
-QB_DEFAULT_FSTYPE ?= "cpio"
-QB_DTB ?= "${@qemu_default_dtb(d)}"
+# Use the xilinx specific version for these users
+IMAGE_CLASSES += "qemuboot-xilinx"
diff --git a/meta-xilinx-core/conf/machine/microblaze-generic.conf b/meta-xilinx-core/conf/machine/microblaze-generic.conf
index 3fcc453d..c0e41948 100644
--- a/meta-xilinx-core/conf/machine/microblaze-generic.conf
+++ b/meta-xilinx-core/conf/machine/microblaze-generic.conf
@@ -47,13 +47,10 @@ UBOOT_INITIAL_ENV = ""
 
 HDF_MACHINE = "kc705-microblazeel"
 IMAGE_FSTYPES += "cpio.gz"
-QB_ROOTFS:qemuboot-xilinx = "${@qemu_rootfs_params(d,'rootfs')}"
-QB_DEFAULT_FSTYPE:qemuboot-xilinx = "${@qemu_rootfs_params(d,'fstype')}"
-QB_ROOTFS_OPT:qemuboot-xilinx = " ${@qemu_rootfs_params(d,'rootfs-opt')}"
 
 QB_KERNEL_CMDLINE = "none"
 
-QB_OPT_APPEND ?= ""
+QB_OPT_APPEND = ""
 
 QB_NETWORK_DEVICE = "-net nic,netdev=net0,macaddr=@MAC@"
 
diff --git a/meta-xilinx-core/conf/machine/versal-generic.conf b/meta-xilinx-core/conf/machine/versal-generic.conf
index 53b20cb8..b737f1d1 100644
--- a/meta-xilinx-core/conf/machine/versal-generic.conf
+++ b/meta-xilinx-core/conf/machine/versal-generic.conf
@@ -60,17 +60,14 @@ QB_NETWORK_DEVICE = ""
 QB_KERNEL_CMDLINE_APPEND ?= ""
 QB_NET = "none"
 
-QB_DEFAULT_FSTYPE:qemuboot-xilinx = "${@qemu_rootfs_params(d,'fstype')}"
-QB_ROOTFS_OPT:qemuboot-xilinx = " ${@qemu_rootfs_params(d,'rootfs-opt')}"
-
 QEMU_HW_DTB_PATH = "${DEPLOY_DIR_IMAGE}/qemu-hw-devicetrees/multiarch"
-QEMU_HW_DTB_PS ?="${QEMU_HW_DTB_PATH}/board-versal-ps-vck190.dtb"
-QEMU_HW_DTB_PMC ?="${QEMU_HW_DTB_PATH}/board-versal-pmc-vc-p-a2197-00.dtb"
+QEMU_HW_DTB_PS = "${QEMU_HW_DTB_PATH}/board-versal-ps-vck190.dtb"
+QEMU_HW_DTB_PMC = "${QEMU_HW_DTB_PATH}/board-versal-pmc-vc-p-a2197-00.dtb"
 
 QEMU_HW_DTB_PS_vp1202-versal = "${QEMU_HW_DTB_PATH}/board-versal-vp1202-ps-virt.dtb"
 QEMU_HW_DTB_PMC_vp1202-versal = "${QEMU_HW_DTB_PATH}/board-versal-vp1202-pmc-virt.dtb"
 
-QB_OPT_APPEND:append:qemuboot-xilinx = " \
+QB_OPT_APPEND = " \
     -hw-dtb ${QEMU_HW_DTB_PS} \
     -serial null -serial null  \
     ${@qemu_add_extra_args(d)} \
@@ -89,7 +86,7 @@ QB_PLM_OPT = " \
     -hw-dtb ${QEMU_HW_DTB_PMC} \
     -display none \
     "
-QB_OPT_APPEND:append:qemuboot-xilinx = " -plm-args '${QB_PLM_OPT}'"
+QB_OPT_APPEND += " -plm-args '${QB_PLM_OPT}'"
 
 #### No additional settings should be after the Postamble
 #### Postamble
diff --git a/meta-xilinx-core/conf/machine/zynq-generic.conf b/meta-xilinx-core/conf/machine/zynq-generic.conf
index 71bfda61..3c30c362 100644
--- a/meta-xilinx-core/conf/machine/zynq-generic.conf
+++ b/meta-xilinx-core/conf/machine/zynq-generic.conf
@@ -39,11 +39,6 @@ WKS_FILES ?= "sdimage-bootpart.wks"
 QB_MEM = "-m 1024"
 QB_NETWORK_DEVICE = "-net nic,netdev=net0,macaddr=@MAC@"
 
-QB_SYSTEM_NAME ?= "${@qemu_target_binary(d)}"
-QB_ROOTFS:qemuboot-xilinx = "${@qemu_rootfs_params(d,'rootfs')}"
-QB_DEFAULT_FSTYPE:qemuboot-xilinx = "${@qemu_rootfs_params(d,'fstype')}"
-QB_ROOTFS_OPT:qemuboot-xilinx = " ${@qemu_rootfs_params(d,'rootfs-opt')}"
-
 QB_KERNEL_CMDLINE = "none"
 
 QB_KERNEL_ROOT = "/dev/mmcblk0p2"
diff --git a/meta-xilinx-core/conf/machine/zynqmp-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
index 98615661..15fe9d11 100644
--- a/meta-xilinx-core/conf/machine/zynqmp-generic.conf
+++ b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
@@ -63,11 +63,10 @@ IMAGE_BOOT_FILES += " \
 
 # This machine has a QEMU model, runqemu setup:
 QB_MEM = "-m 4096"
-QB_OPT_APPEND ?= ""
 QB_NETWORK_DEVICE = "-net nic -net nic -net nic -net nic,netdev=net0,macaddr=@MAC@"
 
 # Replicate BootROM like behaviour, having loaded SPL and PMU(ROM+FW)
-QB_OPT_APPEND:append:qemuboot-xilinx = " \
+QB_OPT_APPEND = " \
                 -hw-dtb ${DEPLOY_DIR_IMAGE}/qemu-hw-devicetrees/multiarch/zcu102-arm.dtb \
                 ${@qemu_zynqmp_unhalt(d, True)} \
                 -device loader,file=${DEPLOY_DIR_IMAGE}/arm-trusted-firmware.elf,cpu-num=0 \
@@ -76,10 +75,6 @@ QB_OPT_APPEND:append:qemuboot-xilinx = " \
                 ${@qemu_add_extra_args(d)} \
                 "
 
-QB_ROOTFS:qemuboot-xilinx = "${@qemu_rootfs_params(d,'rootfs')}"
-QB_DEFAULT_FSTYPE:qemuboot-xilinx = "${@qemu_rootfs_params(d,'fstype')}"
-QB_ROOTFS_OPT:qemuboot-xilinx = "${@qemu_rootfs_params(d,'rootfs-opt')}"
-
 QB_PMU_OPT = " \
                 -M microblaze-fdt \
                 -display none \
@@ -89,7 +84,7 @@ QB_PMU_OPT = " \
                 -device loader,addr=0xfd1a0074,data=0x1011003,data-len=4 \
                 -device loader,addr=0xfd1a007C,data=0x1010f03,data-len=4 \
                 "
-QB_OPT_APPEND:append:qemuboot-xilinx = " -pmu-args '${QB_PMU_OPT}'"
+QB_OPT_APPEND += " -pmu-args '${QB_PMU_OPT}'"
 
 do_write_qemuboot_conf[depends] += "u-boot-zynq-uenv:do_deploy"
 
diff --git a/meta-xilinx-core/recipes-devtools/qemu/qemu-xilinx-system-native_2022.1.bb b/meta-xilinx-core/recipes-devtools/qemu/qemu-xilinx-system-native_2022.1.bb
index f5b89f05..f177872a 100644
--- a/meta-xilinx-core/recipes-devtools/qemu/qemu-xilinx-system-native_2022.1.bb
+++ b/meta-xilinx-core/recipes-devtools/qemu/qemu-xilinx-system-native_2022.1.bb
@@ -1,5 +1,7 @@
 require qemu-xilinx-native.inc
 
+PROVIDES = "qemu-system-native"
+
 EXTRA_OECONF:append = " --target-list=${@get_qemu_system_target_list(d)}"
 
 PACKAGECONFIG ??= "fdt alsa kvm pie"