[M] Change in coreboot[main]: soc/intel/xeon_sp: Add _OSC ASL generation utils for IIO domains

[Lean Sheng Tan (Code Review)]

Lean Sheng Tan has submitted this change. ( https://review.coreboot.org/c/coreboot/+/82034?usp=email )

Change subject: soc/intel/xeon_sp: Add _OSC ASL generation utils for IIO domains
......................................................................

soc/intel/xeon_sp: Add _OSC ASL generation utils for IIO domains

For multi-SKU/SoC supports, IIO domain layouts are returned from FSP
HOBs. Add _OSC ASL generation utils so that static IIO domain layout
definition file per SKU/SoC are not needed any more.

The _OSC generation codes is a thin AML generation layer which
further invokes _SB.POSC which is defined in ASL. The ASL handler
is able to handle boot-time generated info as parameters while keeps
good readability for the ease of maintenance. In this case, firmware
granted capabilities are calculated in boot time and passed to ASL
handler as parameters.

TEST=Build and boot on intel/archercity CRB

Change-Id: Ibd3bfa2428725fe593754436d5ed75a3a11b4cdc
Signed-off-by: Shuo Liu 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/82034
Tested-by: build bot (Jenkins) 
Reviewed-by: Christian Walter 
---
M src/soc/intel/xeon_sp/acpi.c
A src/soc/intel/xeon_sp/acpi/iiostack.asl
M src/soc/intel/xeon_sp/include/soc/acpi.h
3 files changed, 171 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Christian Walter: Looks good to me, approved

diff --git a/src/soc/intel/xeon_sp/acpi.c b/src/soc/intel/xeon_sp/acpi.c
index 1c493af..f66f5e9 100644
--- a/src/soc/intel/xeon_sp/acpi.c
+++ b/src/soc/intel/xeon_sp/acpi.c
@@ -1,5 +1,6 @@
 /* SPDX-License-Identifier: GPL-2.0-or-later */

+#include <acpi/acpigen.h>
 #include <assert.h>
 #include <intelblocks/acpi.h>
 #include <soc/chip_common.h>
@@ -119,3 +120,22 @@

return NULL;
 }
+
+void acpigen_write_OSC_pci_domain_fixed_caps(const struct device *domain,
+				const uint32_t granted_pcie_features,
+				const bool is_cxl_domain,
+				const uint32_t granted_cxl_features)
+{
+	acpigen_write_method("_OSC", 4);
+
+	acpigen_write_return_namestr("\_SB.POSC");
+	acpigen_emit_byte(ARG0_OP);
+	acpigen_emit_byte(ARG1_OP);
+	acpigen_emit_byte(ARG2_OP);
+	acpigen_emit_byte(ARG3_OP);
+	acpigen_write_integer(granted_pcie_features);
+	acpigen_write_integer(is_cxl_domain);
+	acpigen_write_integer(granted_cxl_features);
+
+	acpigen_pop_len();
+}
diff --git a/src/soc/intel/xeon_sp/acpi/iiostack.asl b/src/soc/intel/xeon_sp/acpi/iiostack.asl
new file mode 100644
index 0000000..c943dd5
--- /dev/null
+++ b/src/soc/intel/xeon_sp/acpi/iiostack.asl
@@ -0,0 +1,136 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#define PCI_HOST_BRIDGE_OSC_UUID     "33db4d5b-1ff7-401c-9657-7441c03dd766"
+#define CXL_HOST_BRIDGE_OSC_UUID     "68f2d50b-c469-4d8a-bd3d-941a103fd3fc"
+
+#define OSC_RET_FAILURE              0x02
+#define OSC_RET_UNRECOGNIZED_UUID    0x04
+#define OSC_RET_UNRECOGNIZED_REV     0x08
+#define OSC_RET_CAPABILITIES_MASKED  0x10
+
+#define OSC_QUERY_SUPPORT_SET        0x01
+
+#define ASL_UUID_UNHANDLED           0x00
+#define ASL_UUID_HANDLED             0x01
+
+Scope (_SB)
+{
+	/*
+	 * _SB.POSC - OSC handler for PCIe _OSC calls
+	 *
+	 * Reference:
+	 * 6.2.11 in https://uefi.org/htmlspecs/ACPI_Spec_6_4_html/06_Device_Configuration/Device...
+	 *
+	 * Note:
+	 * This call negotiate with OS on fixed firmware capabilities. It doesn't support to runtime
+	 * change firmware settings.
+	 *
+	 * Arguments: (7)
+	 * Arg0 - Map to _OSC Arg0. A Buffer containing a UUID
+	 * Arg1 - Map to _OSC Arg1. An Integer containing a Revision ID of the buffer format
+	 * Arg2 - Map to _OSC Arg2. An Integer containing a count of entries in Arg3
+	 * Arg3 - Map to _OSC Arg3. A Buffer containing a list of DWORD capabilities
+	 * Arg4 - GrantedPCIeFeatures
+	 * Arg5 - IsCxlDomain
+	 * Arg6 - GrantedCxlFeatures
+	 *
+	 * _OSC ASL Return Value:
+	 * A Buffer containing a list of capabilities
+	 *
+	 * Local Variables Assignment:
+	 * Local0 - Not used
+	 * Local1 - Not used
+	 * Local2 - Not used
+	 * Local3 - Not used
+	 * Local4 - Not used
+	 * Local5 - Not used
+	 * Local6 - Record whether the UUID is handled
+	 * Local7 - Backs up the input value of Arg3
+	 *
+	 * Field Definitions:
+	 * Name - Width	Source	Offset	Description
+	 * --------------------------------
+	 * RETE - DWord	Arg3	0x00	Returned errors
+	 * SUPP - Dword	Arg3	0x04	PCIe Features that OS supported
+	 * CTRL - Dword	Arg3	0x08	PCIe Features that firmware grant control to OS
+	 * OTRL - Dword	Local7	0x08	PCIe Features that OS requests for control
+	 * SUPC - Dword	Arg3	0x0C	CXL Features that OS supported
+	 * CTRC - Dword	Arg3	0x10	CXL Features that firmware grant control to OS
+	 * OTRC - Dword	Local7	0x10	CXL Features that OS requests for control
+	*/
+
+	Method (POSC, 7, NotSerialized)
+	{
+
+#define OscArg0              Arg0
+#define OscArg1              Arg1
+#define OscArg2              Arg2
+#define OscArg3              Arg3
+#define GrantedPCIeFeatures  Arg4
+#define IsCxlDomain          Arg5
+#define GrantedCxlFeatures   Arg6
+
+                Local7 = OscArg3
+                CreateDWordField (OscArg3, Zero, RETE)
+                RETE = 0x0
+                Local6 = ASL_UUID_UNHANDLED
+
+		If ((OscArg1 != 0x01))
+		{
+			RETE = OSC_RET_UNRECOGNIZED_REV
+			Return (OscArg3)
+		}
+
+		If ((OscArg2 < 0x03))
+		{
+			RETE = OSC_RET_FAILURE
+			Return (OscArg3)
+		}
+
+		If ((OscArg0 == ToUUID (PCI_HOST_BRIDGE_OSC_UUID)) ||
+			((IsCxlDomain != 0x00) &&
+			(OscArg0 == ToUUID (CXL_HOST_BRIDGE_OSC_UUID))))
+		{
+			CreateDWordField (OscArg3, 0x04, SUPP)
+			CreateDWordField (OscArg3, 0x08, CTRL)
+			CreateDWordField (Local7, 0x08, OTRL)
+
+			CTRL &= GrantedPCIeFeatures
+
+			/* TODO: further suppress CTRL bits per SUPP caps */
+
+			If ((CTRL != OTRL))
+			{
+				RETE = OSC_RET_CAPABILITIES_MASKED
+			}
+
+			Local6 = ASL_UUID_HANDLED
+		}
+
+		If ((IsCxlDomain != 0x00) &&
+			(OscArg0 == ToUUID (CXL_HOST_BRIDGE_OSC_UUID)))
+		{
+			CreateDWordField (OscArg3, 0x0C, SUPC)
+			CreateDWordField (OscArg3, 0x10, CTRC)
+			CreateDWordField (Local7, 0x10, OTRC)
+
+			CTRC &= GrantedCxlFeatures
+
+                        /* TODO: further suppress CTRC bits per SUPC caps */
+
+			If ((CTRC != OTRC))
+			{
+				RETE = OSC_RET_CAPABILITIES_MASKED
+			}
+
+			Local6 = ASL_UUID_HANDLED
+		}
+
+		If ((Local6 == ASL_UUID_UNHANDLED))
+		{
+			RETE = OSC_RET_UNRECOGNIZED_UUID
+		}
+
+		Return (OscArg3)
+	}
+}
diff --git a/src/soc/intel/xeon_sp/include/soc/acpi.h b/src/soc/intel/xeon_sp/include/soc/acpi.h
index e11b19e..7c7aee0 100644
--- a/src/soc/intel/xeon_sp/include/soc/acpi.h
+++ b/src/soc/intel/xeon_sp/include/soc/acpi.h
@@ -24,4 +24,19 @@

void iio_domain_set_acpi_name(struct device *dev, const char *prefix);

+#define PCIE_NATIVE_HOTPLUG_CONTROL  0x01
+#define SHPC_NATIVE_HOTPLUG_CONTROL  0x02
+#define PCIE_PME_CONTROL             0x04
+#define PCIE_AER_CONTROL             0x08
+#define PCIE_CAP_STRUCTURE_CONTROL   0x10
+#define PCIE_LTR_CONTROL             0x20
+#define PCIE_DPC_COTROL              0x80
+
+#define CXL_ERROR_REPORTING_CONTROL  0x01
+
+void acpigen_write_OSC_pci_domain_fixed_caps(const struct device *domain,
+				const uint32_t granted_pcie_features,
+				const bool is_cxl_domain,
+				const uint32_t granted_cxl_features);
+
 #endif /* _SOC_ACPI_H_ */