Deprecate BOARD and BOARD_VARIANT support

If the BOARD and/or BOARD_VARIANT is set, continue to allow this to
work, however warn the user it is deprecated.

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

13 files changed, 222 insertions, 26 deletions

diff --git a/meta-xilinx-bsp/conf/machine/ultra96-zynqmp.conf b/meta-xilinx-bsp/conf/machine/ultra96-zynqmp.conf
index e78fede1..f724bbe3 100644
--- a/meta-xilinx-bsp/conf/machine/ultra96-zynqmp.conf
+++ b/meta-xilinx-bsp/conf/machine/ultra96-zynqmp.conf
@@ -3,8 +3,8 @@
 #@DESCRIPTION: Machine support for Ultra96 Evaluation Board.
 #
 
-require conf/machine/zynqmp-generic.conf
-
 MACHINE = "zynqmp-generic"
 BOARD = "ultra96"
 SOC_VARIANT = 'eg'
+
+require conf/machine/zynqmp-generic.conf
diff --git a/meta-xilinx-bsp/conf/machine/vck-sc-zynqmp.conf b/meta-xilinx-bsp/conf/machine/vck-sc-zynqmp.conf
index 1bda4cd1..2c88be62 100644
--- a/meta-xilinx-bsp/conf/machine/vck-sc-zynqmp.conf
+++ b/meta-xilinx-bsp/conf/machine/vck-sc-zynqmp.conf
@@ -3,8 +3,10 @@
 ##@DESCRIPTION: Machine support for vck190 system controller.
 
 
-require conf/machine/include/soc-zynqmp.inc
-require conf/machine/include/machine-xilinx-default.inc
+MACHINE = "zynqmp-generic"
+BOARD = "vck-sc"
+
+require conf/machine/zynqmp-generic.conf
 
 MACHINE_FEATURES = "rtc ext2 ext3 vfat usbhost"
 
@@ -25,4 +27,3 @@ IMAGE_BOOT_FILES += " \
     atf-uboot.ub \
     boot.scr \
 "
-BOARD = "vck-sc"
diff --git a/meta-xilinx-core/classes/xilinx-deprecated.bbclass b/meta-xilinx-core/classes/xilinx-deprecated.bbclass
new file mode 100644
index 00000000..b9a44fc7
--- /dev/null
+++ b/meta-xilinx-core/classes/xilinx-deprecated.bbclass
@@ -0,0 +1,73 @@
+# Class to add a deprecated warning from various configuration files.
+
+# Immediately after the ConfigParsed event handler, warn the user of any
+# deprecated files the user has used.
+addhandler xilinx_deprecated_config_eventhandler
+xilinx_deprecated_config_eventhandler[eventmask] = "bb.event.ConfigParsed"
+python xilinx_deprecated_config_eventhandler () {
+    # Check for BOARD & BOARD_VARIANT usage
+    if d.getVar('BOARD') or d.getVar('BOARD_VARIANT'):
+        bb.warn("Deprecated BOARD (%s) or BOARD_VARIANT (%s) is being used." % (d.getVar('BOARD'), d.getVar('BOARD_VARIANT')))
+
+        if d.getVar('MACHINE') != d.getVar('ORIG_MACHINE'):
+            if d.getVar('BOARD_VARIANT') or d.getVar('BOARD') == d.getVar('MACHINE'):
+                if not check_conf_exists("conf/machine/${MACHINE}.conf", d):
+                    mach_path = os.path.join(d.getVar('TOPDIR'), "conf/machine", d.getVar('MACHINE') + '.conf')
+                    bb.utils.mkdirhier(os.path.dirname(mach_path))
+                    bb.warn('Generating (board_variant) MACHINE file: %s' % mach_path)
+                    with open(mach_path, "w") as f:
+                        f.write('#@TYPE: Machine\n')
+                        f.write('#@NAME: %s\n' % d.getVar('MACHINE'))
+                        f.write('#@DESCRIPTION: Generated %s machine\n' % d.getVar('MACHINE'))
+                        f.write('\n')
+                        f.write('#### Preamble\n')
+                        f.write('''MACHINEOVERRIDES =. "${@['', '%s:']['%s' != '${MACHINE}']}"\n''' % (d.getVar('MACHINE'), d.getVar('MACHINE')))
+                        f.write('#### Regular settings follow\n')
+                        f.write('\n')
+                        f.write('unset BOARD\n')
+                        f.write('unset BOARD_VARIANT\n')
+                        f.write('\n')
+                        f.write('DEFAULTTUNE ?= "%s"\n' % d.getVar('DEFAULTTUNE'))
+                        if d.getVar('TUNE_FEATURES:tune-microblaze'):
+                            f.write('TUNE_FEATURES:tune-microblaze ?= "%s"\n' % d.getVar('TUNE_FEATURES'))
+                        if d.getVar('SOC_VARIANT'):
+                            f.write('SOC_VARIANT ?= "%s"\n' % d.getVar('SOC_VARIANT'))
+                        f.write('\n')
+                        f.write('require conf/machine/%s.conf\n' % [d.getVar('ORIG_MACHINE'), d.getVar('BOARD')][bool(d.getVar('BOARD_VARIANT'))])
+                        f.write('\n')
+                        f.write('#### No additional settings should be after the Postamble\n')
+                        f.write('#### Postamble\n')
+                        f.write('''PACKAGE_EXTRA_ARCHS:append = "${@['', ' %s']['%s' != "${MACHINE}"]}"\n''' % ((d.getVar('MACHINE_ARCH'), d.getVar('MACHINE'))))
+                    bb.warn('Note: The generated machine conf file may be incomplete.  If so copy the missing settings from the original conf files.')
+                bb.warn('In the future use: MACHINE = "%s"' % d.getVar('MACHINE'))
+            if d.getVar('BOARD') and d.getVar('BOARD') != d.getVar('MACHINE'):
+                if not check_conf_exists("conf/machine/${BOARD}.conf", d):
+                    mach_path = os.path.join(d.getVar('TOPDIR'), "conf/machine", d.getVar('BOARD') + '.conf')
+                    bb.utils.mkdirhier(os.path.dirname(mach_path))
+                    bb.warn('Generating (board) MACHINE file: %s' % mach_path)
+                    with open(mach_path, "w") as f:
+                        f.write('#@TYPE: Machine\n')
+                        f.write('#@NAME: %s\n' % d.getVar('BOARD'))
+                        f.write('#@DESCRIPTION: Generated %s machine\n' % d.getVar('BOARD'))
+                        f.write('\n')
+                        f.write('#### Preamble\n')
+                        f.write('''MACHINEOVERRIDES =. "${@['', '%s:']['%s' != '${MACHINE}']}"\n''' % (d.getVar('BOARD'), d.getVar('BOARD')))
+                        f.write('#### Regular settings follow\n')
+                        f.write('\n')
+                        f.write('unset BOARD\n')
+                        f.write('unset BOARD_VARIANT\n')
+                        f.write('require conf/machine/%s.conf\n' % d.getVar('ORIG_MACHINE'))
+                        f.write('\n')
+                        f.write('#### No additional settings should be after the Postamble\n')
+                        f.write('#### Postamble\n')
+                        f.write('''PACKAGE_EXTRA_ARCHS:append = "${@['', ' %s']['%s' != "${MACHINE}"]}"\n''' % ((d.getVar('BOARD_ARCH'), d.getVar('BOARD'))))
+                    bb.warn('Note: The generated machine conf file may be incomplete.  If so copy the missing settings from the original conf files.')
+            d.delVar('ORIG_MACHINE')
+
+    msg_list = d.getVarFlags('XILINX_DEPRECATED') or []
+    for msg_source in msg_list:
+        if msg_source == "doc":
+            continue
+        msg = d.getVarFlag('XILINX_DEPRECATED', msg_source) or ""
+        bb.warn('%s: %s' % (msg_source, msg))
+}
diff --git a/meta-xilinx-core/conf/machine/README b/meta-xilinx-core/conf/machine/README
new file mode 100644
index 00000000..f455eb84
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/README
@@ -0,0 +1,81 @@
+Xilinx Machines
+===============
+
+Xilinx uses an inheritence model to define defaults in a heirarchical
+model.  This allows for machines to include other machines and then
+override defaults.
+
+For example, a carrier board with a system on module using a zynqmp ev
+can be implements as:
+
+k26_kv -> k26 -> zynqmp-ev-generic -> zynqmp-generic
+
+The above needs to result MACHINEOVERRIDES and PACKAGE_ARCHS that include
+all 4 machines.  To accomplish this, each machine.conf file should contain
+the following preamble and postamble.
+
+#### Preamble
+MACHINEOVERRIDES =. "${@['', '<machine>:']['<machine>' != '${MACHINE}']}"
+#### Regular settings follow
+
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' <machine_arch>']['<machine>' != "${MACHINE}"]}"
+
+
+Typically the first thing after the preamble will be a requires of the machine
+configuration that we depend on.  After the machine would be changes to various
+defaults.  The exception is when a different microblaze tune and/or defaulttune
+is desired; these must be set before require of the inherited machine.
+
+Typical case example (my-example.conf):
+
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'my-example:']['my-example' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/zynqmp-ev-generic.conf
+
+HDF_MACHINE = "zcu102-zynqmp"
+MACHINE_FEATURES += "pci"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
+
+
+Example of defaulttune override:
+
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'my-example:']['my-example' != '${MACHINE}']}"
+#### Regular settings follow
+
+DEFAULTTUNE = "aarch64"
+
+require conf/machine/zynqmp-ev-generic.conf
+
+HDF_MACHINE = "zcu102-zynqmp"
+MACHINE_FEATURES += "pci"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
+
+
+Example of microblaze tune override:
+
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'my-example:']['my-example' != '${MACHINE}']}"
+#### Regular settings follow
+
+TUNE_FEATURES:tune-microblaze ?= "microblaze v8.50 barrel-shift reorder pattern-compare divide-hard multiply-high fpu-hard"
+
+require conf/machine/microblaze-generic.conf
+
+HDF_MACHINE = "ml605"
+SERIAL_CONSOLE = "115200,ttyUL0"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
diff --git a/meta-xilinx-core/conf/machine/include/README b/meta-xilinx-core/conf/machine/include/README
index 89a25faf..38596d0f 100644
--- a/meta-xilinx-core/conf/machine/include/README
+++ b/meta-xilinx-core/conf/machine/include/README
@@ -29,6 +29,4 @@ machine-xilinx-default - Set Xilinx FPGA wide defaults, all machines
 
 machine-xilinx-qemu    - Settings required for qemu-xilinx support.
 
-xilinx-board.inc       - enabled BOARD and BOARD_VARIANT.  This allows you to
-                         use only generic machines, and simply set which BOARD
-                         and optionally BOARD_VARIANT in the local.conf.
+xilinx-board-*.inc       - DEPRECATED - enabled BOARD and BOARD_VARIANT
diff --git a/meta-xilinx-core/conf/machine/include/machine-xilinx-default.inc b/meta-xilinx-core/conf/machine/include/machine-xilinx-default.inc
index d8b1e2d9..d169c513 100644
--- a/meta-xilinx-core/conf/machine/include/machine-xilinx-default.inc
+++ b/meta-xilinx-core/conf/machine/include/machine-xilinx-default.inc
@@ -1,3 +1,5 @@
+INHERIT += "xilinx-deprecated"
+
 # Default Xilinx BSP Machine settings
 
 MACHINE_FEATURES_BACKFILL_CONSIDERED += "rtc"
diff --git a/meta-xilinx-core/conf/machine/include/xilinx-board-post.inc b/meta-xilinx-core/conf/machine/include/xilinx-board-post.inc
new file mode 100644
index 00000000..6f05eddd
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/include/xilinx-board-post.inc
@@ -0,0 +1,6 @@
+BOARD_ARCH ?= "${@['${BOARD}', '${MACHINE_ARCH}'][d.getVar('BOARD')=='']}"
+BOARDVARIANT_ARCH ?= "${@['${BOARD}_${BOARD_VARIANT}','${BOARD_ARCH}'][d.getVar('BOARD_VARIANT')=='']}"
+
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' ${BOARD_ARCH}']['${BOARD}' != '' and '${BOARD_ARCH}' != '${MACHINE_ARCH}']}"
+# We don't add BOARDVARIANT_ARCH as that will be automatic via MACHINE
+#PACKAGE_EXTRA_ARCHS:append = "${@['', ' ${BOARDVARIANT_ARCH}']['${BOARD_VARIANT}' != '' and '${BOARDVARIANT_ARCH}' != '${MACHINE_ARCH}']}"
diff --git a/meta-xilinx-core/conf/machine/include/xilinx-board-pre.inc b/meta-xilinx-core/conf/machine/include/xilinx-board-pre.inc
new file mode 100644
index 00000000..8fea5ce2
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/include/xilinx-board-pre.inc
@@ -0,0 +1,14 @@
+BOARD ??= ""
+BOARD_VARIANT ??= ""
+
+# Change the MACHINE to the BOARD-VARIANT (or BOARD)
+ORIG_MACHINE := "${MACHINE}"
+MACHINE := "${@['${BOARD}-${BOARD_VARIANT}', '${BOARD}' or '${ORIG_MACHINE}']['${BOARD_VARIANT}' == '']}"
+
+# Add the BOARD and BOARD_VARIANT to the overrides
+MACHINEOVERRIDES =. "${@['', '${BOARD}:']['${BOARD}' != '' and '${MACHINE}' != '${BOARD}']}"
+# We don't add BOARD-BOARD_VARIANT as that will be automatic via MACHINE
+#MACHINEOVERRIDES =. "${@['', '${BOARD}-${BOARD_VARIANT}:']['${BOARD_VARIANT}' != '' and '${MACHINE}' != '${BOARD_VARIANT}']}"
+
+include conf/machine/include/${BOARD}.inc
+include conf/machine/include/${BOARD}-${BOARD_VARIANT}.inc
diff --git a/meta-xilinx-core/conf/machine/include/xilinx-board.inc b/meta-xilinx-core/conf/machine/include/xilinx-board.inc
deleted file mode 100644
index 18b04742..00000000
--- a/meta-xilinx-core/conf/machine/include/xilinx-board.inc
+++ /dev/null
@@ -1,12 +0,0 @@
-BOARD ??= ""
-BOARD_VARIANT ??= ""
-
-MACHINEOVERRIDES .= "${@['', ':${BOARD}']['${BOARD}' != '']}"
-MACHINEOVERRIDES .= "${@['', ':${BOARD}-${BOARD_VARIANT}']['${BOARD_VARIANT}' != '']}"
-
-
-BOARD_ARCH ?= "${@['${BOARD}', '${MACHINE_ARCH}'][d.getVar('BOARD')=='']}"
-BOARDVARIANT_ARCH ?= "${@['${BOARD}-${BOARD_VARIANT}','${BOARD_ARCH}'][d.getVar('BOARD_VARIANT')=='']}"
-
-PACKAGE_EXTRA_ARCHS:append = "${@['', ' ${BOARD_ARCH}'][d.getVar('BOARDVARIANT_ARCH') != d.getVar('MACHINE_ARCH')]}"
-PACKAGE_EXTRA_ARCHS:append = "${@['', ' ${BOARDVARIANT_ARCH}'][d.getVar('BOARDVARIANT_ARCH') != d.getVar('BOARD_ARCH')]}"
diff --git a/meta-xilinx-core/conf/machine/microblaze-generic.conf b/meta-xilinx-core/conf/machine/microblaze-generic.conf
index 6dfa9997..0ba5b80a 100644
--- a/meta-xilinx-core/conf/machine/microblaze-generic.conf
+++ b/meta-xilinx-core/conf/machine/microblaze-generic.conf
@@ -2,6 +2,11 @@
 #@NAME: microblaze-generic
 #@DESCRIPTION: Generic microblaze defaults to little-endian v11.0 barrel-shift pattern-compare reorder divide-hard multiple-high support
 
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-pre.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
+
 # Set the default for a modern full feature microblaze...
 TUNE_FEATURES:tune-microblaze ?= "microblaze v11.0 barrel-shift pattern-compare reorder divide-hard multiply-high"
 DEFAULTTUNE ?= "microblaze"
@@ -9,7 +14,6 @@ DEFAULTTUNE ?= "microblaze"
 require conf/machine/include/soc-tune-include.inc
 require conf/machine/include/machine-xilinx-default.inc
 require conf/machine/include/machine-xilinx-qemu.inc
-require conf/machine/include/xilinx-board.inc
 
 # The default MACHINE_ARCH is dynmic for microblaze, since the architecture is not fixed
 # Based on core bitbake.conf
@@ -30,3 +34,8 @@ EXTRA_IMAGEDEPENDS += "libyaml-native python3-cython-native python3-pyyaml-nativ
 
 UBOOT_MACHINE ?= "microblaze-generic_defconfig"
 UBOOT_INITIAL_ENV = ""
+
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-post.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
diff --git a/meta-xilinx-core/conf/machine/versal-generic.conf b/meta-xilinx-core/conf/machine/versal-generic.conf
index 2b0cd495..a5d99b75 100644
--- a/meta-xilinx-core/conf/machine/versal-generic.conf
+++ b/meta-xilinx-core/conf/machine/versal-generic.conf
@@ -2,10 +2,14 @@
 #@NAME: Generic versal
 #@DESCRIPTION: versal devices
 
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-pre.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
+
 require conf/machine/include/soc-versal.inc
 require conf/machine/include/machine-xilinx-default.inc
 require conf/machine/include/machine-xilinx-qemu.inc
-require conf/machine/include/xilinx-board.inc
 
 MACHINE_FEATURES += "rtc ext2 ext3 vfat usbhost"
 
@@ -84,3 +88,8 @@ QB_PLM_OPT = " \
     -display none \
     "
 QB_OPT_APPEND:append:qemuboot-xilinx = " -plm-args '${QB_PLM_OPT}'"
+
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-post.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
diff --git a/meta-xilinx-core/conf/machine/zynq-generic.conf b/meta-xilinx-core/conf/machine/zynq-generic.conf
index 2fc6d27b..4a903282 100644
--- a/meta-xilinx-core/conf/machine/zynq-generic.conf
+++ b/meta-xilinx-core/conf/machine/zynq-generic.conf
@@ -2,10 +2,14 @@
 #@NAME: Generic Zynq
 #@DESCRIPTION: Generic Zynq Device
 
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-pre.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
+
 require conf/machine/include/soc-zynq.inc
 require conf/machine/include/machine-xilinx-default.inc
 require conf/machine/include/machine-xilinx-qemu.inc
-require conf/machine/include/xilinx-board.inc
 
 MACHINE_FEATURES += "rtc ext2 ext3 vfat usbhost usbgadget"
 
@@ -39,3 +43,8 @@ QB_OPT_APPEND = " \
         -device loader,addr=0xf8000108,data=0x0001e008,data-len=4 \
         -device loader,addr=0xF8000910,data=0xF,data-len=0x4 \
         "
+
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-post.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
diff --git a/meta-xilinx-core/conf/machine/zynqmp-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
index eb9d4bc4..317b3fc7 100644
--- a/meta-xilinx-core/conf/machine/zynqmp-generic.conf
+++ b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
@@ -2,13 +2,17 @@
 #@NAME: Generic zynqmp
 #@DESCRIPTION: zynqmp devices
 
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-pre.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD
+
 # CG is the lowest common demoninator, so use this by default
 SOC_VARIANT ?= "cg"
 
 require conf/machine/include/soc-zynqmp.inc
 require conf/machine/include/machine-xilinx-default.inc
 require conf/machine/include/machine-xilinx-qemu.inc
-require conf/machine/include/xilinx-board.inc
 
 # Machine features must result in a superset
 # Basic features:
@@ -81,5 +85,7 @@ QB_OPT_APPEND:append:qemuboot-xilinx = " -pmu-args '${QB_PMU_OPT}'"
 
 do_write_qemuboot_conf[depends] += "u-boot-zynq-uenv:do_deploy"
 
-# Board specific overrides
-include conf/machine/include/board/ultra96.inc
+# Deprecated board config
+USE_BOARD = "${@"conf/machine/include/xilinx-board-post.inc" if d.getVar("BOARD") or d.getVar("BOARD_VARIANT") else ""}"
+require ${USE_BOARD}
+unset USE_BOARD