[10/12] sbbr/xsdt: Add initial tests to xsdt acpi table as per sbbr.

Message ID 1488493596-3437-11-git-send-email-supreeth.venkatesh@arm.com
State Superseded
Headers show

Commit Message

Supreeth Venkatesh March 2, 2017, 10:26 p.m.
Server Base Boot Requirements (SBBR) specification is intended for SBSA-
compliant 64-bit ARMv8 servers.
It defines the base firmware requirements for out-of-box support of any
ARM SBSA-compatible Operating System or hypervisor.
The requirements in this specification are expected to be minimal yet
complete for booting a multi-core ARMv8 server platform, while leaving
plenty of room for OEM or ODM innovations and design details.
For more information, download the SBBR specification here:
http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0044b/index.html

This change introduces test cases as per SBBR specification to xsdt acpi
table. These test cases may be subset/superset of xsdt  acpi table tests
already existing. However, to preserve "sbbr" classification, new file
is created, even when most of the code is re-used from acpi/xsdt.

Signed-off-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
---
 src/sbbr/xsdt/xsdt.c | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 src/sbbr/xsdt/xsdt.c

Comments

Colin King March 2, 2017, 11:55 p.m. | #1
On 02/03/17 22:26, Supreeth Venkatesh wrote:
> Server Base Boot Requirements (SBBR) specification is intended for SBSA-
> compliant 64-bit ARMv8 servers.
> It defines the base firmware requirements for out-of-box support of any
> ARM SBSA-compatible Operating System or hypervisor.
> The requirements in this specification are expected to be minimal yet
> complete for booting a multi-core ARMv8 server platform, while leaving
> plenty of room for OEM or ODM innovations and design details.
> For more information, download the SBBR specification here:
> http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0044b/index.html
> 
> This change introduces test cases as per SBBR specification to xsdt acpi
> table. These test cases may be subset/superset of xsdt  acpi table tests
> already existing. However, to preserve "sbbr" classification, new file
> is created, even when most of the code is re-used from acpi/xsdt.
> 
> Signed-off-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
> ---
>  src/sbbr/xsdt/xsdt.c | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 90 insertions(+)
>  create mode 100644 src/sbbr/xsdt/xsdt.c
> 
> diff --git a/src/sbbr/xsdt/xsdt.c b/src/sbbr/xsdt/xsdt.c
> new file mode 100644
> index 0000000..7d4aaec
> --- /dev/null
> +++ b/src/sbbr/xsdt/xsdt.c
> @@ -0,0 +1,90 @@
> +/*
> + * Copyright (C) 2015-2017 Canonical
> + * Copyright (C) 2017 ARM Ltd
> + *
> + * Portions of this code original from the Linux-ready Firmware Developer Kit
> + *
> + * 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_SBBR)
> +
> +#include <stdlib.h>
> +#include <stdio.h>
> +#include <unistd.h>
> +#include <inttypes.h>
> +#include <string.h>
> +
> +static fwts_acpi_table_info *table;
> +
> +static int sbbr_xsdt_init(fwts_framework *fw)
> +{
> +	if (fwts_acpi_find_table(fw, "XSDT", 0, &table) != FWTS_OK) {
> +		fwts_log_error(fw, "Cannot read ACPI tables.");
> +		return FWTS_ERROR;
> +	}
> +	if (table == NULL || (table && table->length == 0)) {
> +		fwts_log_error(fw, "ACPI XSDT table does not exist.");
> +		return FWTS_ERROR;
> +	}
> +	return FWTS_OK;
> +}
> +
> +/*
> + *  XSDT Extended System Description Table
> + */
> +static int sbbr_xsdt_test1(fwts_framework *fw)
> +{
> +	fwts_acpi_table_xsdt *xsdt = (fwts_acpi_table_xsdt*)table->data;
> +	size_t i, n;
> +	bool passed = true;
> +
> +	n = (table->length - sizeof(fwts_acpi_table_header)) / sizeof(uint64_t);
> +	for (i = 0; i < n; i++) {
> +		if (xsdt->entries[i] == 0) {
> +			passed = false;
> +			fwts_failed(fw, LOG_LEVEL_CRITICAL,
> +				"XSDTEntryNull",
> +				"XSDT Entry %zd is null, should not be non-zero.", i);
> +			fwts_advice(fw,
> +				"A XSDT pointer is null and therefore erroneously "
> +				"points to an invalid 64 bit ACPI table header. "
> +				"At worse this will cause the kernel to oops, at "
> +				"best the kernel may ignore this.  However, it "
> +				"should be fixed where possible.");
> +		}
> +	}
> +	if (passed)
> +		fwts_passed(fw, "XSDT is present, pointed at by XsdrAddress=0x%lx and contain valid pointers to %d other ACPI tables mandated by SBBR", xsdt->entries[0], (int)n);
> +

can you break the fwts_passed line up over a bunch of lines, my editor
isn't much wider than 80 chars :-)

> +	return FWTS_OK;
> +}
> +
> +static fwts_framework_minor_test sbbr_xsdt_tests[] = {
> +	{ sbbr_xsdt_test1, "XSDT Extended System Description Table test." },
> +	{ NULL, NULL }
> +};
> +
> +static fwts_framework_ops sbbr_xsdt_ops = {
> +	.description = "XSDT Extended System Description Table test.",
> +	.init        = sbbr_xsdt_init,
> +	.minor_tests = sbbr_xsdt_tests
> +};
> +
> +FWTS_REGISTER("sbbr_xsdt", &sbbr_xsdt_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_TEST_SBBR)
> +
> +#endif
>

Patch

diff --git a/src/sbbr/xsdt/xsdt.c b/src/sbbr/xsdt/xsdt.c
new file mode 100644
index 0000000..7d4aaec
--- /dev/null
+++ b/src/sbbr/xsdt/xsdt.c
@@ -0,0 +1,90 @@ 
+/*
+ * Copyright (C) 2015-2017 Canonical
+ * Copyright (C) 2017 ARM Ltd
+ *
+ * Portions of this code original from the Linux-ready Firmware Developer Kit
+ *
+ * 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_SBBR)
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <inttypes.h>
+#include <string.h>
+
+static fwts_acpi_table_info *table;
+
+static int sbbr_xsdt_init(fwts_framework *fw)
+{
+	if (fwts_acpi_find_table(fw, "XSDT", 0, &table) != FWTS_OK) {
+		fwts_log_error(fw, "Cannot read ACPI tables.");
+		return FWTS_ERROR;
+	}
+	if (table == NULL || (table && table->length == 0)) {
+		fwts_log_error(fw, "ACPI XSDT table does not exist.");
+		return FWTS_ERROR;
+	}
+	return FWTS_OK;
+}
+
+/*
+ *  XSDT Extended System Description Table
+ */
+static int sbbr_xsdt_test1(fwts_framework *fw)
+{
+	fwts_acpi_table_xsdt *xsdt = (fwts_acpi_table_xsdt*)table->data;
+	size_t i, n;
+	bool passed = true;
+
+	n = (table->length - sizeof(fwts_acpi_table_header)) / sizeof(uint64_t);
+	for (i = 0; i < n; i++) {
+		if (xsdt->entries[i] == 0) {
+			passed = false;
+			fwts_failed(fw, LOG_LEVEL_CRITICAL,
+				"XSDTEntryNull",
+				"XSDT Entry %zd is null, should not be non-zero.", i);
+			fwts_advice(fw,
+				"A XSDT pointer is null and therefore erroneously "
+				"points to an invalid 64 bit ACPI table header. "
+				"At worse this will cause the kernel to oops, at "
+				"best the kernel may ignore this.  However, it "
+				"should be fixed where possible.");
+		}
+	}
+	if (passed)
+		fwts_passed(fw, "XSDT is present, pointed at by XsdrAddress=0x%lx and contain valid pointers to %d other ACPI tables mandated by SBBR", xsdt->entries[0], (int)n);
+
+	return FWTS_OK;
+}
+
+static fwts_framework_minor_test sbbr_xsdt_tests[] = {
+	{ sbbr_xsdt_test1, "XSDT Extended System Description Table test." },
+	{ NULL, NULL }
+};
+
+static fwts_framework_ops sbbr_xsdt_ops = {
+	.description = "XSDT Extended System Description Table test.",
+	.init        = sbbr_xsdt_init,
+	.minor_tests = sbbr_xsdt_tests
+};
+
+FWTS_REGISTER("sbbr_xsdt", &sbbr_xsdt_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_TEST_SBBR)
+
+#endif