diff mbox series

[1/2] acpi: cedt: add tests for ACPI CEDT table (mantis 2076)

Message ID 20221011082653.41440-1-ivan.hu@canonical.com
State Accepted
Headers show
Series [1/2] acpi: cedt: add tests for ACPI CEDT table (mantis 2076) | expand

Commit Message

Ivan Hu Oct. 11, 2022, 8:26 a.m. UTC
BugLink: https://bugs.launchpad.net/fwts/+bug/1992413

Signed-off-by: Ivan Hu <ivan.hu@canonical.com>
---
 src/Makefile.am             |   1 +
 src/acpi/cedt/cedt.c        | 245 ++++++++++++++++++++++++++++++++++++
 src/lib/include/fwts_acpi.h |  61 +++++++++
 3 files changed, 307 insertions(+)
 create mode 100644 src/acpi/cedt/cedt.c
diff mbox series

Patch

diff --git a/src/Makefile.am b/src/Makefile.am
index 3bb35e5c..128ddaa0 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -68,6 +68,7 @@  fwts_SOURCES = main.c 				\
 	acpi/brightness/brightness-helper.c	\
 	acpi/brightness/brightness.c 		\
 	acpi/brightness/autobrightness.c 	\
+	acpi/cedt/cedt.c			\
 	acpi/checksum/checksum.c 		\
 	acpi/cpep/cpep.c			\
 	acpi/crsdump/crsdump.c			\
diff --git a/src/acpi/cedt/cedt.c b/src/acpi/cedt/cedt.c
new file mode 100644
index 00000000..847af25d
--- /dev/null
+++ b/src/acpi/cedt/cedt.c
@@ -0,0 +1,245 @@ 
+/*
+ * Copyright (C) 2022 Canonical
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ */
+#include "fwts.h"
+
+#if defined(FWTS_HAS_ACPI)
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <inttypes.h>
+#include <string.h>
+
+static fwts_acpi_table_info *table;
+acpi_table_init(CEDT, &table)
+
+static void cedt_chbs_test(
+	fwts_framework *fw,
+	const fwts_acpi_table_cedt_chbs *entry,
+	bool *passed)
+{
+	fwts_log_info_verbatim(fw, "  CXL Host Bridge Structure (CHBS):");
+	fwts_log_info_simp_int(fw, "    Type:                           ", entry->header.type);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->header.reserved);
+	fwts_log_info_simp_int(fw, "    Record Length:                  ", entry->header.record_length);
+	fwts_log_info_simp_int(fw, "    UID:                            ", entry->uid);
+	fwts_log_info_simp_int(fw, "    CXL Version:                    ", entry->cxl_version);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->reserved);
+	fwts_log_info_simp_int(fw, "    Base:                           ", entry->base);
+	fwts_log_info_simp_int(fw, "    Length:                         ", entry->length);
+
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->header.reserved, passed);
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->reserved, passed);
+
+	switch(entry->cxl_version) {
+		case 0: /* RCH */
+			if (entry->length != 0x2000) {
+				*passed = false;
+				fwts_failed(fw, LOG_LEVEL_HIGH,
+					"CEDTBadCHBSLength",
+					"CEDT CHBS Length must be 0x2000, got "
+					"0x%" PRIx64 " instead", entry->length);
+			}
+			//fwts_acpi_fixed_value(fw, LOG_LEVEL_HIGH, "CEDT", "CHBS Length", entry->length, 0x2000, passed);
+			break;
+		case 1: /* Host Bridge */
+			if (entry->length != 0x10000) {
+				*passed = false;
+				fwts_failed(fw, LOG_LEVEL_HIGH,
+					"CEDTBadCHBSLength",
+					"CEDT CHBS Length must be 0x10000, got "
+					"0x%" PRIx64 " instead", entry->length);
+			}
+			//fwts_acpi_fixed_value(fw, LOG_LEVEL_HIGH, "CEDT", "CHBS Length", entry->length, 0x10000, passed);
+			break;
+		default:
+			*passed = false;
+			fwts_failed(fw, LOG_LEVEL_HIGH,
+				"CEDTBadCXLVersion",
+				"CXL Version must have the value with 0 or 1, got "
+				"0x%" PRIx32 " instead", entry->cxl_version);
+			break;
+	}
+
+}
+
+static void cedt_cfmws_test(
+	fwts_framework *fw,
+	const fwts_acpi_table_cedt_cfmws *entry,
+	bool *passed)
+{
+	fwts_log_info_verbatim(fw, "  CXL Fixed Memory Window Structure (CFMWS):");
+	fwts_log_info_simp_int(fw, "    Type:                           ", entry->header.type);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->header.reserved);
+	fwts_log_info_simp_int(fw, "    Record Length:                  ", entry->header.record_length);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->reserved1);
+	fwts_log_info_simp_int(fw, "    Base HPA:                       ", entry->base_hpa);
+	fwts_log_info_simp_int(fw, "    Window Size:                    ", entry->window_size);
+	fwts_log_info_simp_int(fw, "    ENIW:                           ", entry->eniw);
+	fwts_log_info_simp_int(fw, "    Interleave Arithmetic:          ", entry->interleave_arithmetic);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->reserved2);
+	fwts_log_info_simp_int(fw, "    HBIG:                           ", entry->hbig);
+	fwts_log_info_simp_int(fw, "    Window Restrictions:            ", entry->window_restrictions);
+	fwts_log_info_simp_int(fw, "    QTG ID:                         ", entry->qtg_id);
+	fwts_log_info_verbatim(fw, "    Interleave Target List");	/* TODO: dumping the raw data */
+
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->header.reserved, passed);
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->reserved1, passed);
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->reserved2, passed);
+
+	if (entry->interleave_arithmetic > 1) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"CEDTBadInterleaveArithmetic",
+			"CEDT CFMWS interleave arithmetic must have the value with 0 or 1, got "
+			"0x%2.2" PRIx8 "instead", entry->interleave_arithmetic);
+	}
+
+	fwts_acpi_reserved_bits("CEDT", "Window Restrictions", entry->window_restrictions, 5, 15, passed);
+
+}
+
+static void cedt_cxims_test(
+	fwts_framework *fw,
+	const fwts_acpi_table_cedt_cxims *entry,
+	bool *passed)
+{
+	int i;
+
+	fwts_log_info_verbatim(fw, "  CXL XOR Interleave Math Structure (CXIMS):");
+	fwts_log_info_simp_int(fw, "    Type:                           ", entry->header.type);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->header.reserved);
+	fwts_log_info_simp_int(fw, "    Record Length:                  ", entry->header.record_length);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->reserved);
+	fwts_log_info_simp_int(fw, "    HBIG:                           ", entry->hbig);
+	fwts_log_info_simp_int(fw, "    Number of Bitmap Entries(NIB):  ", entry->nig);
+	for (i= 0; i < entry->nig; i++)
+		fwts_log_info_simp_int(fw, "    XORMAP List                     ", entry->xormap_list[i]);
+
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->header.reserved, passed);
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->reserved, passed);
+
+}
+
+static void cedt_rdpas_test(
+	fwts_framework *fw,
+	const fwts_acpi_table_cedt_rdpas *entry,
+	bool *passed)
+{
+	fwts_log_info_verbatim(fw, "  RCEC Downstream Port Association Structure (RDPAS):");
+	fwts_log_info_simp_int(fw, "    Type:                           ", entry->header.type);
+	fwts_log_info_simp_int(fw, "    Reserved:                       ", entry->header.reserved);
+	fwts_log_info_simp_int(fw, "    Record Length:                  ", entry->header.record_length);
+	fwts_log_info_simp_int(fw, "    RCEC Segment Number             ", entry->rece_seg_num);
+	fwts_log_info_simp_int(fw, "    RCEC BDF:                       ", entry->rece_bdf);
+	fwts_log_info_simp_int(fw, "    Protocol Type:                  ", entry->protocol_type);
+	fwts_log_info_simp_int(fw, "    Base Address                    ", entry->base_addr);
+
+	fwts_acpi_reserved_zero("CEDT", "Reserved", entry->header.reserved, passed);
+
+	if (entry->protocol_type > 1) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"CEDTBadProtocolType",
+			"CEDT CFMWS protocol type must have the value with 0 or 1, got "
+			"0x%2.2" PRIx8 " instead", entry->protocol_type);
+	}
+
+}
+
+static void cedt_structure(
+	fwts_framework *fw,
+	fwts_acpi_table_cedt_header *entry,
+	bool *passed)
+{
+	switch(entry->type) {
+		case FWTS_CEDT_TYPE_CHBS:
+			cedt_chbs_test(fw, (fwts_acpi_table_cedt_chbs *)entry, passed);
+			break;
+		case FWTS_CEDT_TYPE_CFMWS:
+			cedt_cfmws_test(fw, (fwts_acpi_table_cedt_cfmws *)entry, passed);
+			break;
+		case FWTS_CEDT_TYPE_CXIMS:
+			cedt_cxims_test(fw, (fwts_acpi_table_cedt_cxims *)entry, passed);
+			break;
+		case FWTS_CEDT_TYPE_RDPAS:
+			cedt_rdpas_test(fw, (fwts_acpi_table_cedt_rdpas *)entry, passed);
+			break;
+		default:
+			*passed = false;
+			fwts_failed(fw, LOG_LEVEL_HIGH,
+				"CEDTBadSubtableType",
+				"CEDT must have subtable with Type 0 to 3, got "
+				"0x%4.4" PRIx16 " instead", entry->type);
+			break;
+	}
+}
+
+static int cedt_test1(fwts_framework *fw)
+{
+	fwts_acpi_table_cedt_header *entry;
+	bool passed = true;
+	uint32_t offset;
+
+	if (!fwts_acpi_table_length(fw, "CEDT", table->length, sizeof(fwts_acpi_table_cedt)))
+		return FWTS_OK;
+
+	fwts_log_info_verbatim(fw, "CEDT CXL Early Discovery Table:");
+
+	entry = (fwts_acpi_table_cedt_header *) (table->data + sizeof(fwts_acpi_table_cedt));
+	offset = sizeof(fwts_acpi_table_cedt);
+	while (offset < table->length) {
+
+		if (fwts_acpi_structure_length_zero(fw, "CEDT", entry->record_length, offset)) {
+			passed = false;
+			break;
+		}
+
+		cedt_structure(fw, entry, &passed);
+
+		offset += entry->record_length;
+		if (fwts_acpi_structure_range(fw, "CEDT", table->length, offset)) {
+			passed = false;
+			break;
+		}
+
+		entry = (fwts_acpi_table_cedt_header *) (table->data + offset);
+		fwts_log_nl(fw);
+	}
+
+	if (passed)
+		fwts_passed(fw, "No issues found in CEDT table.");
+
+	return FWTS_OK;
+}
+
+static fwts_framework_minor_test cedt_tests[] = {
+	{ cedt_test1, "Validate CEDT table." },
+	{ NULL, NULL }
+};
+
+static fwts_framework_ops cedt_ops = {
+	.description = "CEDT CXL Early Discovery Table test",
+	.init        = CEDT_init,
+	.minor_tests = cedt_tests
+};
+
+FWTS_REGISTER("cedt", &cedt_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_ACPI)
+
+#endif
diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
index a599710d..c367a936 100644
--- a/src/lib/include/fwts_acpi.h
+++ b/src/lib/include/fwts_acpi.h
@@ -2286,4 +2286,65 @@  typedef struct {
 	fwts_acpi_table_svkl_key_structure key_struct[0];
 } __attribute__ ((packed)) fwts_acpi_table_svkl;
 
+/*
+ * ACPI CEDT (CXL Early Discovery Table)
+ *   https://www.computeexpresslink.org/download-the-specification
+ */
+typedef struct {
+	fwts_acpi_table_header	header;
+} __attribute__ ((packed)) fwts_acpi_table_cedt;
+
+typedef enum {
+	FWTS_CEDT_TYPE_CHBS	= 0,
+	FWTS_CEDT_TYPE_CFMWS	= 1,
+	FWTS_CEDT_TYPE_CXIMS	= 2,
+	FWTS_CEDT_TYPE_RDPAS	= 3,
+	FWTS_CEDT_TYPE_RESERVED	= 4,
+} fwts_acpi_cedt_type;
+
+typedef struct {
+	uint8_t	type;
+	uint8_t	reserved;
+	uint16_t	record_length;
+} __attribute__ ((packed)) fwts_acpi_table_cedt_header;
+
+typedef struct {
+	fwts_acpi_table_cedt_header	header;
+	uint32_t	uid;
+	uint32_t	cxl_version;
+	uint32_t	reserved;
+	uint64_t	base;
+	uint64_t	length;
+} __attribute__ ((packed)) fwts_acpi_table_cedt_chbs;
+
+typedef struct {
+	fwts_acpi_table_cedt_header	header;
+	uint32_t	reserved1;
+	uint64_t	base_hpa;
+	uint64_t	window_size;
+	uint8_t	eniw;
+	uint8_t	interleave_arithmetic;
+	uint16_t	reserved2;
+	uint32_t	hbig;
+	uint16_t	window_restrictions;
+	uint16_t	qtg_id;
+	uint32_t	interleave_target_list[0];
+} __attribute__ ((packed)) fwts_acpi_table_cedt_cfmws;
+
+typedef struct {
+	fwts_acpi_table_cedt_header	header;
+	uint16_t	reserved;
+	uint8_t	hbig;
+	uint8_t	nig;
+	uint64_t	xormap_list[0];
+} __attribute__ ((packed)) fwts_acpi_table_cedt_cxims;
+
+typedef struct {
+	fwts_acpi_table_cedt_header	header;
+	uint16_t	rece_seg_num;
+	uint16_t	rece_bdf;
+	uint8_t	protocol_type;
+	uint64_t	base_addr;
+} __attribute__ ((packed)) fwts_acpi_table_cedt_rdpas;
+
 #endif