Merge remote-tracking branch 'langdale' into 2023

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

15 files changed, 206 insertions, 21 deletions

diff --git a/meta-xilinx-core/conf/machine/README b/meta-xilinx-core/conf/machine/README
index f455eb84..5361dc81 100644
--- a/meta-xilinx-core/conf/machine/README
+++ b/meta-xilinx-core/conf/machine/README
@@ -11,8 +11,12 @@ 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.
+all 4 machines.  This facilitates sstate-cache and binary distribution
+package re-use.
+
+To accomplish this, each machine.conf file should contain the following
+preamble and postamble.  This ensures that the machine overrides and
+package archs can be extended by another machine configuration file.
 
 #### Preamble
 MACHINEOVERRIDES =. "${@['', '<machine>:']['<machine>' != '${MACHINE}']}"
@@ -24,10 +28,13 @@ MACHINEOVERRIDES =. "${@['', '<machine>:']['<machine>' != '${MACHINE}']}"
 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.
+Between the Preamble and Postamble, you should "require" the machine
+configuration that your machine is based on.  After the 'require' is where
+most variables should be defined.  (See variable requirements at the end
+of this document.)  This will allow you to extend other configurations
+to match your specific requirements.  Values should be set using = and
++=, but not :append or :prepend.  This allows a machine inheriting your
+machine file to add or overwrite the value easily.  Such as:
 
 Typical case example (my-example.conf):
 
@@ -35,7 +42,7 @@ Typical case example (my-example.conf):
 MACHINEOVERRIDES =. "${@['', 'my-example:']['my-example' != '${MACHINE}']}"
 #### Regular settings follow
 
-require conf/machine/zynqmp-ev-generic.conf
+require conf/machine/zynqmp-generic.conf
 
 HDF_MACHINE = "zcu102-zynqmp"
 MACHINE_FEATURES += "pci"
@@ -45,15 +52,20 @@ MACHINE_FEATURES += "pci"
 PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
 
 
+A few variable must be set BEFORE the requires, DEFAULTTUNE for example.
+(See variable requirements at the end of this document.)  Usually ?= is the
+correct way to set these, as the machine inheriting your machine may need
+to override the value.
+
 Example of defaulttune override:
 
 #### Preamble
 MACHINEOVERRIDES =. "${@['', 'my-example:']['my-example' != '${MACHINE}']}"
 #### Regular settings follow
 
-DEFAULTTUNE = "aarch64"
+DEFAULTTUNE ?= "aarch64"
 
-require conf/machine/zynqmp-ev-generic.conf
+require conf/machine/zynqmp-generic.conf
 
 HDF_MACHINE = "zcu102-zynqmp"
 MACHINE_FEATURES += "pci"
@@ -63,6 +75,9 @@ MACHINE_FEATURES += "pci"
 PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
 
 
+Additionally, for microblaze you may need to define a specific microblaze
+tune-features.  Like DEFAULTTUNE, this needs to be set before the require line.
+
 Example of microblaze tune override:
 
 #### Preamble
@@ -79,3 +94,68 @@ SERIAL_CONSOLE = "115200,ttyUL0"
 #### No additional settings should be after the Postamble
 #### Postamble
 PACKAGE_EXTRA_ARCHS:append = "${@['', ' my_example']['my-example' != "${MACHINE}"]}"
+
+
+Variable Requirements
+=====================
+
+The question has been raised why we don't use ?= or ??= for all default
+values, instead we rely on specific ordering of the override components?
+
+This is done intentionally, as it forces the user to create a new machine
+configuration file to extend their system.  In the past, it was common
+for people to just set values in their local.conf file, but this lead to
+problems reproducing success and failures, as well as trying to support
+the overall configuration.  Moving to a model where most variables must
+be added to, or replaced after the require has simplified this model.
+There are a few exception, these will be covered first.
+
+The following variables must be set using ?= BEFORE the 'require' line
+of the inherited base machine .conf file.  This is due to them being
+used to control inclusion of tune data.
+
+DEFAULTTUNE - Default Tune for this machine
+
+TUNEFILE[<tune>] - The tune file, based on DEFAULTTUNE, to load
+
+For DEFAULTTUNE, see the Yocto Project documentation.  For
+TUNEFILE[<tune>] see include/soc-tune-include.inc for the defined ones.
+
+
+The following variables should be set using ?= BEFORE the 'require' line
+of the inherited base machine .conf file, if the user may override them.
+If the values are fixed, then it should be set after the requires per
+the next section.
+
+These are common values a user may want to override and will let the user
+easiy make a local change, if allowed by the machine .conf:
+
+UBOOT_MACHINE - The defconfig for u-boot.  (Note, this may be an error TBD).
+
+SOC_VARIANT - See include/soc-*.inc (Note, most machines this is fixed).
+
+
+The following variables must be set AFTER the 'require' line, using '='
+or '+='/'=+' as required.  Using ':append', ':prepend', or ':remove' will
+prevent an inheriting machine from overriding that value.  Similarly
+you should not use :<machine> override values for the same reason.  Note,
+not every machine file will have all of these variables, only the ones
+you need to override should be set.
+
+System wide setting:
+TUNE_FEATURES:tune-<tune> - Specific tune features
+
+external-hdf recipe from meta-xilinx-tools:
+HDF_MACHINE - Used by the  recipe to find the correct XSA
+HDF_EXT - only xsa is supported, legacy variable
+HDF_BASE - protocol if not using the default external-hdf repository
+HDF_PATH - path to the repository or XSA file
+
+device-tree recipe from meta-xilinx-tools:
+YAML_DT_BOARD_FLAGS - flags used for dtgen
+
+u-boot-xlnx recipe from meta-xilinx-core:
+UBOOT_MACHINE - Name of the defconfig to use
+HAS_PLATFORM_INIT - List of defconfig files available for u-boot
+
+...and more...
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 7d3d45f3..06203985 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,6 @@
+# HDF_MACHINE should be set _AFTER_ this has been loaded
+HDF_MACHINE_PRIOR := "${HDF_MACHINE}"
+INHERIT += "xilinx-vars"
 INHERIT += "xilinx-deprecated"
 
 # Default Xilinx BSP Machine settings
diff --git a/meta-xilinx-core/conf/machine/include/soc-tune-include.inc b/meta-xilinx-core/conf/machine/include/soc-tune-include.inc
index 539879d4..ad58cf92 100644
--- a/meta-xilinx-core/conf/machine/include/soc-tune-include.inc
+++ b/meta-xilinx-core/conf/machine/include/soc-tune-include.inc
@@ -10,6 +10,9 @@ TUNEFILE[cortexa72] = "conf/machine/include/arm/armv8a/tune-cortexa72.inc"
 TUNEFILE[cortexa72-cortexa53] = "conf/machine/include/arm/armv8a/tune-cortexa72-cortexa53.inc"
 TUNEFILE[microblaze] = "conf/machine/include/xilinx-microblaze.inc"
 
+# Capture the defaulttune, to make sure it's been modified in the right order
+DEFAULTTUNE_PRIOR := "${DEFAULTTUNE}"
+
 # Default to arch-armv8a.inc
 TUNEFILE = "${@ d.getVarFlag('TUNEFILE', d.getVar('DEFAULTTUNE')) or 'conf/machine/include/arm/arch-armv8a.inc'}"
 
diff --git a/meta-xilinx-core/conf/machine/include/soc-zynqmp.inc b/meta-xilinx-core/conf/machine/include/soc-zynqmp.inc
index 0ae23b01..bdb72194 100644
--- a/meta-xilinx-core/conf/machine/include/soc-zynqmp.inc
+++ b/meta-xilinx-core/conf/machine/include/soc-zynqmp.inc
@@ -2,12 +2,12 @@ DEFAULTTUNE ?= "cortexa72-cortexa53"
 SOC_FAMILY ?= "zynqmp"
 
 # Available SOC_VARIANT's for zynqmp:
-# "cg" - Zynq UltraScale+  CG Devices
+# "cg" - Zynq UltraScale+  CG Devices (default lowest common denominator)
 # "eg" - Zynq UltraScale+  EG Devices
 # "ev" - Zynq UltraScale+  EV Devices
 # "dr" - Zynq UltraScale+  DR Devices
 
-SOC_VARIANT ?= "eg"
+SOC_VARIANT ?= "cg"
 
 GRAPHICSOVERRIDES = ""
 VCUOVERRIDES = ""
diff --git a/meta-xilinx-core/conf/machine/versal-ai-core-generic.conf b/meta-xilinx-core/conf/machine/versal-ai-core-generic.conf
new file mode 100644
index 00000000..34f57691
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/versal-ai-core-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'versal-ai-core-generic:']['versal-ai-core-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/versal-generic.conf
+
+SOC_VARIANT = "ai-core"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' versal_ai_core_generic']['versal-ai-core-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/versal-ai-edge-generic.conf b/meta-xilinx-core/conf/machine/versal-ai-edge-generic.conf
new file mode 100644
index 00000000..bf5523ed
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/versal-ai-edge-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'versal-ai-edge-generic:']['versal-ai-edge-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/versal-generic.conf
+
+SOC_VARIANT = "ai-edge"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' versal_ai_edge_generic']['versal-ai-edge-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/versal-hbm-generic.conf b/meta-xilinx-core/conf/machine/versal-hbm-generic.conf
new file mode 100644
index 00000000..23fffcb9
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/versal-hbm-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'versal-hbm-generic:']['versal-hbm-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/versal-generic.conf
+
+SOC_VARIANT = "hbm"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' versal_hbm_generic']['versal-hbm-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/versal-net-generic.conf b/meta-xilinx-core/conf/machine/versal-net-generic.conf
index 1941235a..7b410aaa 100644
--- a/meta-xilinx-core/conf/machine/versal-net-generic.conf
+++ b/meta-xilinx-core/conf/machine/versal-net-generic.conf
@@ -6,18 +6,12 @@
 MACHINEOVERRIDES =. "${@['', 'versal-net-generic:']['versal-net-generic' != '${MACHINE}']}"
 #### Regular settings follow
 
-SOC_VARIANT = "net"
-
 # Must be set first, or versal-generic will set it
 UBOOT_MACHINE ?= "xilinx_versal_net_virt_defconfig"
 
 require conf/machine/versal-generic.conf
 
-#### REMOVE THE FOLLOWING WHEN BOOTGEN IS SYNCED
-# required for bootgen native/nativesdk
-MACHINEOVERRIDES:class-native = "versal-net"
-MACHINEOVERRIDES:class-nativesdk = "versal-net"
-#### REMOVE THE ABOVE
+SOC_VARIANT = "net"
 
 HDF_MACHINE = "versal-net-generic"
 
diff --git a/meta-xilinx-core/conf/machine/versal-premium-generic.conf b/meta-xilinx-core/conf/machine/versal-premium-generic.conf
new file mode 100644
index 00000000..d785edff
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/versal-premium-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'versal-premium-generic:']['versal-premium-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/versal-generic.conf
+
+SOC_VARIANT = "premium"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' versal_premium_generic']['versal-premium-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/versal-prime-generic.conf b/meta-xilinx-core/conf/machine/versal-prime-generic.conf
new file mode 100644
index 00000000..94e9b05e
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/versal-prime-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'versal-prime-generic:']['versal-prime-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/versal-generic.conf
+
+SOC_VARIANT = "prime"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' versal_prime_generic']['versal-prime-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/zynqmp-cg-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-cg-generic.conf
new file mode 100644
index 00000000..38c9126f
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/zynqmp-cg-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'zynqmp-cg-generic:']['zynqmp-cg-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/zynqmp-generic.conf
+
+SOC_VARIANT = "cg"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' zynqmp_cg_generic']['zynqmp-cg-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/zynqmp-dr-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-dr-generic.conf
new file mode 100644
index 00000000..fbe445aa
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/zynqmp-dr-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'zynqmp-dr-generic:']['zynqmp-dr-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/zynqmp-generic.conf
+
+SOC_VARIANT = "dr"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' zynqmp_dr_generic']['zynqmp-dr-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/zynqmp-eg-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-eg-generic.conf
new file mode 100644
index 00000000..33375b46
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/zynqmp-eg-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'zynqmp-eg-generic:']['zynqmp-eg-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/zynqmp-generic.conf
+
+SOC_VARIANT = "eg"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' zynqmp_eg_generic']['zynqmp-eg-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/zynqmp-ev-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-ev-generic.conf
new file mode 100644
index 00000000..f2ffe40f
--- /dev/null
+++ b/meta-xilinx-core/conf/machine/zynqmp-ev-generic.conf
@@ -0,0 +1,12 @@
+#### Preamble
+MACHINEOVERRIDES =. "${@['', 'zynqmp-ev-generic:']['zynqmp-ev-generic' != '${MACHINE}']}"
+#### Regular settings follow
+
+require conf/machine/zynqmp-generic.conf
+
+SOC_VARIANT = "ev"
+
+#### No additional settings should be after the Postamble
+#### Postamble
+PACKAGE_EXTRA_ARCHS:append = "${@['', ' zynqmp_ev_generic']['zynqmp-ev-generic' != "${MACHINE}"]}"
+
diff --git a/meta-xilinx-core/conf/machine/zynqmp-generic.conf b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
index 32de4d50..c375d8e5 100644
--- a/meta-xilinx-core/conf/machine/zynqmp-generic.conf
+++ b/meta-xilinx-core/conf/machine/zynqmp-generic.conf
@@ -11,9 +11,6 @@ unset USE_BOARD
 MACHINEOVERRIDES =. "${@['', 'zynqmp-generic:']['zynqmp-generic' != '${MACHINE}']}"
 #### Regular settings follow
 
-# 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