[1/2] acpi: hmat: add ACPI HMAT test (mantis 1705)

Submitted by Alex Hung on Aug. 3, 2017, 7:43 a.m.

Details

Message ID 1501746208-21930-1-git-send-email-alex.hung@canonical.com
State New
Headers show

Commit Message

Alex Hung Aug. 3, 2017, 7:43 a.m.
Signed-off-by: Alex Hung <alex.hung@canonical.com>
---
 src/Makefile.am             |   1 +
 src/acpi/hmat/hmat.c        | 309 ++++++++++++++++++++++++++++++++++++++++++++
 src/lib/include/fwts_acpi.h |  51 ++++++++
 3 files changed, 361 insertions(+)
 create mode 100644 src/acpi/hmat/hmat.c

Patch hide | download patch | download mbox

diff --git a/src/Makefile.am b/src/Makefile.am
index 11862c9..916834c 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -79,6 +79,7 @@  fwts_SOURCES = main.c 				\
 	acpi/gtdt/gtdt.c			\
 	acpi/hest/hest.c			\
 	acpi/hpet/hpet.c 			\
+	acpi/hmat/hmat.c 			\
 	acpi/iort/iort.c			\
 	acpi/lid/lid.c 				\
 	acpi/lpit/lpit.c 			\
diff --git a/src/acpi/hmat/hmat.c b/src/acpi/hmat/hmat.c
new file mode 100644
index 0000000..35a1f4c
--- /dev/null
+++ b/src/acpi/hmat/hmat.c
@@ -0,0 +1,309 @@ 
+/*
+ * Copyright (C) 2017 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.
+ *
+ */
+#include "fwts.h"
+
+#if defined(FWTS_HAS_ACPI)
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <inttypes.h>
+#include <stdbool.h>
+
+static fwts_acpi_table_info *table;
+
+static int hmat_init(fwts_framework *fw)
+{
+	if (fwts_acpi_find_table(fw, "HMAT", 0, &table) != FWTS_OK) {
+		fwts_log_error(fw, "Cannot load ACPI table");
+		return FWTS_ERROR;
+	}
+	if (table == NULL) {
+		fwts_log_error(fw, "ACPI HMAT table does not exist, skipping test");
+		return FWTS_SKIP;
+	}
+
+	return FWTS_OK;
+}
+
+static void hmat_addr_range_test(fwts_framework *fw, const fwts_acpi_table_hmat_addr_range *entry, bool *passed)
+{
+	fwts_log_info_verbatim(fw, "  Memory Subsystem Address Range (Type 0):");
+	fwts_log_info_verbatim(fw, "    Type:                           0x%4.4" PRIx16, entry->header.type);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->header.reserved);
+	fwts_log_info_verbatim(fw, "    Length:                         0x%8.8" PRIx32, entry->header.length);
+	fwts_log_info_verbatim(fw, "    Flags:                          0x%4.4" PRIx16, entry->flags);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->reserved1);
+	fwts_log_info_verbatim(fw, "    Processor Proximity Domain:     0x%8.8" PRIx32, entry->processor_proximity_domain);
+	fwts_log_info_verbatim(fw, "    Memory Proximity Domain:        0x%8.8" PRIx32, entry->memory_proximity_domain);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%8.8" PRIx32, entry->reserved2);
+	fwts_log_info_verbatim(fw, "    System Phy Addr Range Base:     0x%16.16" PRIx64, entry->phy_addr_base);
+	fwts_log_info_verbatim(fw, "    System Phy Addr Range Length:   0x%16.16" PRIx64, entry->phy_addr_length);
+
+	if (entry->header.reserved != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->header.reserved);
+	}
+
+	if (entry->flags & ~0x07) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"HMATBadFlags",
+			"HMAT Flags's Bits[15..3] must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->flags);
+	}
+
+	if (entry->reserved1 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->reserved1);
+	}
+
+	if (entry->reserved2 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%8.8" PRIx32 " instead", entry->reserved2);
+		}
+}
+
+static void hmat_locality_test(fwts_framework *fw, const fwts_acpi_table_hmat_locality *entry, bool *passed)
+{
+	uint32_t pd_size;
+
+	fwts_log_info_verbatim(fw, "  System Locality Latency and Bandwidth Information (Type 1):");
+	fwts_log_info_verbatim(fw, "    Type:                           0x%4.4" PRIx16, entry->header.type);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->header.reserved);
+	fwts_log_info_verbatim(fw, "    Length:                         0x%8.8" PRIx32, entry->header.length);
+	fwts_log_info_verbatim(fw, "    Flags:                          0x%2.2" PRIx8, entry->flags);
+	fwts_log_info_verbatim(fw, "    Data Type:                      0x%2.2" PRIx8, entry->data_type);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->reserved1);
+	fwts_log_info_verbatim(fw, "    Number of Initiator PDs:        0x%8.8" PRIx32, entry->num_initiator);
+	fwts_log_info_verbatim(fw, "    Number of Target PDs:           0x%8.8" PRIx32, entry->num_target);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%8.8" PRIx32, entry->reserved2);
+	fwts_log_info_verbatim(fw, "    Entry Base Unit:                0x%16.16" PRIx64, entry->entry_base_unit);
+
+	if (entry->header.reserved != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->header.reserved);
+	}
+
+	if (entry->flags & ~0x1f) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_CRITICAL,
+			"HMATBadFlags",
+			"HMAT Flags's Bits[7..5] must be zero, got "
+			"0x%2.2" PRIx8 " instead", entry->flags);
+	}
+
+	if (entry->data_type > 5) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_CRITICAL,
+			"HMATBadFDataType",
+			"HMAT Data Type must be 0..5, got "
+			"0x%2.2" PRIx8 " instead", entry->data_type);
+	}
+
+	if (entry->reserved1 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->reserved1);
+	}
+
+	if (entry->reserved2 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%8.8" PRIx32 " instead", entry->reserved2);
+	}
+
+	pd_size = (entry->num_initiator + entry->num_target) * 4 +
+	          (entry->num_initiator * entry->num_target * 2);
+	if ((entry->header.length - sizeof(fwts_acpi_table_hmat_locality)) != pd_size) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATBadNumProximityDomain",
+			"HMAT length does not match to the number of Proximity Domains ");
+	}
+}
+
+static void hmat_cache_test(fwts_framework *fw, const fwts_acpi_table_hmat_cache *entry, bool *passed)
+{
+	fwts_log_info_verbatim(fw, "  Memory Side Cache Information (Type 2):");
+	fwts_log_info_verbatim(fw, "    Type:                           0x%4.4" PRIx16, entry->header.type);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->header.reserved);
+	fwts_log_info_verbatim(fw, "    Length:                         0x%8.8" PRIx32, entry->header.length);
+	fwts_log_info_verbatim(fw, "    Memory Proximity Domain:        0x%8.8" PRIx32, entry->memory_proximity_domain);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%8.8" PRIx32, entry->reserved1);
+	fwts_log_info_verbatim(fw, "    Memory Side Cache Size:         0x%16.16" PRIx64, entry->cache_size);
+	fwts_log_info_verbatim(fw, "    Cache Attributes:               0x%8.8" PRIx32, entry->cache_attr);
+	fwts_log_info_verbatim(fw, "    Reserved:                       0x%4.4" PRIx16, entry->reserved2);
+	fwts_log_info_verbatim(fw, "    Number of SMBIOS Handles:       0x%4.4" PRIx16, entry->num_smbios);
+
+	if (entry->header.reserved != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->header.reserved);
+	}
+
+
+	if ((entry->cache_attr & 0xf) > 3 ||
+	   ((entry->cache_attr >> 4) & 0xf) > 3 ||
+	   ((entry->cache_attr >> 8) & 0xf) > 2 ||
+	   ((entry->cache_attr >> 12) & 0xf) > 2) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_CRITICAL,
+			"HMATBadCacheAttributeReserved",
+			"HMAT Cache Attribute reserved values are used, got "
+			"0x%8.8" PRIx32 " instead", entry->cache_attr);
+	}
+
+	if (entry->reserved1 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%8.8" PRIx32 " instead", entry->reserved1);
+	}
+
+	if (entry->reserved2 != 0) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", entry->reserved2);
+		}
+
+	if ((entry->header.length - sizeof(fwts_acpi_table_hmat_cache)) / 2 != entry->num_smbios) {
+		*passed = false;
+		fwts_failed(fw, LOG_LEVEL_CRITICAL,
+			"HMATBadNumberOfSMBIOS",
+			"HMAT length does not match to "
+			"the number of SMBIOS handles");
+	}
+}
+
+static int hmat_test1(fwts_framework *fw)
+{
+	fwts_acpi_table_hmat *hmat = (fwts_acpi_table_hmat*) table->data;
+	fwts_acpi_table_hmat_header *entry;
+	bool passed = true;
+	uint32_t offset;
+
+	fwts_log_info_verbatim(fw, "HMAT Heterogeneous Memory Attribute Table:");
+	fwts_log_info_verbatim(fw, "  Reserved:        0x%2.2" PRIx8, hmat->reserved);
+
+	if (hmat->reserved != 0) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"HMATReservedNonZero",
+			"HMAT reserved field must be zero, got "
+			"0x%8.8" PRIx32 " instead", hmat->reserved);
+	}
+
+	entry = (fwts_acpi_table_hmat_header *) (table->data + sizeof(fwts_acpi_table_hmat));
+	offset = sizeof(fwts_acpi_table_hmat);
+	while (offset < table->length) {
+		uint32_t type_length;
+
+		if (entry->length == 0) {
+			passed = false;
+			fwts_failed(fw, LOG_LEVEL_HIGH, "HMATStructLengthZero",
+				    "HMAT structure (offset 0x%4.4" PRIx32 ") "
+				    "length cannot be 0", offset);
+			break;
+		}
+
+		if (entry->type == FWTS_ACPI_HMAT_TYPE_ADDRESS_RANGE) {
+			hmat_addr_range_test(fw, (fwts_acpi_table_hmat_addr_range *) entry, &passed);
+			type_length = sizeof(fwts_acpi_table_hmat_addr_range);
+		} else if (entry->type == FWTS_ACPI_HMAT_TYPE_LOCALITY) {
+			fwts_acpi_table_hmat_locality *locality = (fwts_acpi_table_hmat_locality *) entry;
+			hmat_locality_test(fw, (fwts_acpi_table_hmat_locality *) entry, &passed);
+			type_length = sizeof(fwts_acpi_table_hmat_locality) +
+			              (locality->num_initiator + locality->num_target) * 4 +
+			              (locality->num_initiator * locality->num_target * 2);
+		} else if (entry->type == FWTS_ACPI_HMAT_TYPE_CACHE) {
+			hmat_cache_test(fw, (fwts_acpi_table_hmat_cache *) entry, &passed);
+			type_length = sizeof(fwts_acpi_table_hmat_cache) +
+			              ((fwts_acpi_table_hmat_cache *) entry)->num_smbios * 2;
+		} else {
+			passed = false;
+			fwts_failed(fw, LOG_LEVEL_HIGH,
+				"HMATBadSubtableType",
+				"HMAT must have subtable with Type 0..2, got "
+				"0x%2.2" PRIx8 " instead", entry->type);
+			break;
+		}
+
+		if (entry->length != type_length) {
+			passed = false;
+			fwts_failed(fw, LOG_LEVEL_CRITICAL,
+				"HMATBadSubtableLength",
+				"HMAT subtable Type 0x%2.2" PRIx8 " should have "
+				"length 0x%2.2" PRIx8 ", got 0x%2.2" PRIx8,
+				entry->type, entry->length, type_length);
+			break;
+		}
+
+		if ((offset += entry->length) > table->length) {
+			passed = false;
+			fwts_failed(fw, LOG_LEVEL_CRITICAL,
+				"HMATBadTableLength",
+				"HMAT has more subtypes than its size can handle");
+			break;
+		}
+		entry = (fwts_acpi_table_hmat_header *) (table->data + offset);
+		fwts_log_nl(fw);
+	}
+
+
+	fwts_log_nl(fw);
+
+	if (passed)
+		fwts_passed(fw, "No issues found in HMAT table.");
+
+	return FWTS_OK;
+}
+
+static fwts_framework_minor_test hmat_tests[] = {
+	{ hmat_test1, "Validate HMAT table." },
+	{ NULL, NULL }
+};
+
+static fwts_framework_ops hmat_ops = {
+	.description = "HMAT Heterogeneous Memory Attribute Table test.",
+	.init        = hmat_init,
+	.minor_tests = hmat_tests
+};
+
+FWTS_REGISTER("hmat", &hmat_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_TEST_ACPI)
+
+#endif
diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
index bbedea3..0742ef3 100644
--- a/src/lib/include/fwts_acpi.h
+++ b/src/lib/include/fwts_acpi.h
@@ -1247,6 +1247,57 @@  typedef struct {
 	uint64_t	hint_address[];
 } __attribute__ ((packed)) fwts_acpi_table_nfit_flush_addr;
 
+/*
+ * ACPI HMAT (Heterogeneous Memory Attribute Table), 5.2.27
+ */
+typedef struct {
+	fwts_acpi_table_header	header;
+	uint32_t	reserved;
+} __attribute__ ((packed)) fwts_acpi_table_hmat;
+
+typedef enum {
+	FWTS_ACPI_HMAT_TYPE_ADDRESS_RANGE	= 0,
+	FWTS_ACPI_HMAT_TYPE_LOCALITY		= 1,
+	FWTS_ACPI_HMAT_TYPE_CACHE		= 2,
+} fwts_acpi_hmat_type;
+
+typedef struct {
+	uint16_t	type;
+	uint16_t	reserved;
+	uint32_t	length;
+} __attribute__ ((packed)) fwts_acpi_table_hmat_header;
+
+typedef struct {
+	fwts_acpi_table_hmat_header	header;
+	uint16_t	flags;
+	uint16_t	reserved1;
+	uint32_t	processor_proximity_domain;
+	uint32_t	memory_proximity_domain;
+	uint32_t	reserved2;
+	uint64_t	phy_addr_base;
+	uint64_t	phy_addr_length;
+} __attribute__ ((packed)) fwts_acpi_table_hmat_addr_range;
+
+typedef struct {
+	fwts_acpi_table_hmat_header	header;
+	uint8_t		flags;
+	uint8_t		data_type;
+	uint16_t	reserved1;
+	uint32_t	num_initiator;
+	uint32_t	num_target;
+	uint32_t	reserved2;
+	uint64_t	entry_base_unit;
+} __attribute__ ((packed)) fwts_acpi_table_hmat_locality;
+
+typedef struct {
+	fwts_acpi_table_hmat_header	header;
+	uint32_t	memory_proximity_domain;
+	uint32_t	reserved1;
+	uint64_t	cache_size;
+	uint32_t	cache_attr;
+	uint16_t	reserved2;
+	uint16_t	num_smbios;
+} __attribute__ ((packed)) fwts_acpi_table_hmat_cache;
 
 /*
  * ACPI PPTT (Processor Properties Topology Table), 5.2.29