[PATCH 1/2] acpi: Add LPIT ACPI test (LP: #1470184)
Colin King
colin.king at canonical.com
Tue Jun 30 17:20:32 UTC 2015
From: Colin Ian King <colin.king at canonical.com>
Add new LPIT test
Signed-off-by: Colin Ian King <colin.king at canonical.com>
---
src/Makefile.am | 1 +
src/acpi/lpit/lpit.c | 229 ++++++++++++++++++++++++++++++++++++++++++++
src/lib/include/fwts_acpi.h | 24 +++++
3 files changed, 254 insertions(+)
create mode 100644 src/acpi/lpit/lpit.c
diff --git a/src/Makefile.am b/src/Makefile.am
index 5542574..e79d5f6 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -55,6 +55,7 @@ fwts_SOURCES = main.c \
acpi/hest/hest.c \
acpi/hpet/hpet.c \
acpi/lid/lid.c \
+ acpi/lpit/lpit.c \
acpi/madt/madt.c \
acpi/mcfg/mcfg.c \
acpi/method/method.c \
diff --git a/src/acpi/lpit/lpit.c b/src/acpi/lpit/lpit.c
new file mode 100644
index 0000000..03aa26d
--- /dev/null
+++ b/src/acpi/lpit/lpit.c
@@ -0,0 +1,229 @@
+/*
+ * Copyright (C) 2015 Canonical
+ *
+ * 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"
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <inttypes.h>
+#include <string.h>
+
+static fwts_acpi_table_info *table;
+
+static int lpit_init(fwts_framework *fw)
+{
+
+ if (fwts_acpi_find_table(fw, "LPIT", 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 LPIT table does not exist, skipping test");
+ return FWTS_SKIP;
+ }
+
+ return FWTS_OK;
+}
+
+static void lpit_check_type_0(
+ fwts_framework *fw,
+ uint32_t *length,
+ uint8_t **data,
+ bool *passed)
+{
+ fwts_acpi_table_lpit_c_state *lpi = (fwts_acpi_table_lpit_c_state *)*data;
+
+ /* We know table is at least long enough to access type and length.. */
+ fwts_log_info_verbatum(fw, "Native C-state based LPI structure:");
+ fwts_log_info_verbatum(fw, " Type: 0x%8.8" PRIx32, lpi->type);
+ fwts_log_info_verbatum(fw, " Length: 0x%8.8" PRIx32, lpi->length);
+
+ if (lpi->length < sizeof(fwts_acpi_table_lpit_c_state)) {
+ *passed = false;
+ *length = 0; /* Force loop exit */
+ fwts_failed(fw, LOG_LEVEL_HIGH,
+ "LPITNativeCStateLpitShort",
+ "Native C-state based LPI structure is too short, "
+ "got %" PRIu32 " bytes, expected %zu bytes",
+ lpi->length,
+ sizeof(fwts_acpi_table_lpit_c_state));
+ return;
+ }
+
+ fwts_log_info_verbatum(fw, " ID: 0x%4.4" PRIx16, lpi->id);
+ fwts_log_info_verbatum(fw, " Reserved: 0x%4.4" PRIx16, lpi->reserved);
+ fwts_log_info_verbatum(fw, " Flags: 0x%8.8" PRIx32, lpi->flags);
+ fwts_log_info_verbatum(fw, " Entry Trigger:");
+ fwts_log_info_verbatum(fw, " Address Space ID: 0x%2.2" PRIx8, lpi->entry_trigger.address_space_id);
+ fwts_log_info_verbatum(fw, " Register Bit Width 0x%2.2" PRIx8, lpi->entry_trigger.register_bit_width);
+ fwts_log_info_verbatum(fw, " Register Bit Offset 0x%2.2" PRIx8, lpi->entry_trigger.register_bit_offset);
+ fwts_log_info_verbatum(fw, " Access Size 0x%2.2" PRIx8, lpi->entry_trigger.access_width);
+ fwts_log_info_verbatum(fw, " Address 0x%16.16" PRIx64, lpi->entry_trigger.address);
+ fwts_log_info_verbatum(fw, " Residency: 0x%8.8" PRIx32, lpi->residency);
+ fwts_log_info_verbatum(fw, " Latency: 0x%8.8" PRIx32, lpi->latency);
+
+ /* If flags [1] set, then counter is not available */
+ if (lpi->flags & 0x2) {
+ fwts_log_info_verbatum(fw, " Residency Counter not available");
+ } else {
+ fwts_log_info_verbatum(fw, " Residency Counter:");
+ fwts_log_info_verbatum(fw, " Address Space ID: 0x%2.2" PRIx8, lpi->residency_counter.address_space_id);
+ fwts_log_info_verbatum(fw, " Register Bit Width 0x%2.2" PRIx8, lpi->residency_counter.register_bit_width);
+ fwts_log_info_verbatum(fw, " Register Bit Offset 0x%2.2" PRIx8, lpi->residency_counter.register_bit_offset);
+ fwts_log_info_verbatum(fw, " Access Size 0x%2.2" PRIx8, lpi->residency_counter.access_width);
+ fwts_log_info_verbatum(fw, " Address 0x%16.16" PRIx64, lpi->residency_counter.address);
+ fwts_log_info_verbatum(fw, " Residency Counter Freq: 0x%16.16" PRIx64, lpi->residency_counter_freq);
+ }
+ fwts_log_nl(fw);
+
+ if (lpi->reserved) {
+ *passed = false;
+ fwts_failed(fw, LOG_LEVEL_LOW,
+ "LPITNativeCStateLpitReservedNonZero",
+ "Native C-state based LPI structure reserved field "
+ "was expected to be zero, got 0x%4.4" PRIx16 " instead",
+ lpi->reserved);
+ }
+
+ if (lpi->flags & ~3) {
+ *passed = false;
+ fwts_failed(fw, LOG_LEVEL_LOW,
+ "LPITNativeCStateLpitFlagsReserved",
+ "Some of the Native C-state based LPI structure flags "
+ "bits [31:2] are set, they are expected to be zero");
+ }
+
+ /* 2.2.1.2, if FFH, then it is a MSR, check GAS fields */
+ if (((lpi->flags & 2) == 0) &&
+ (lpi->residency_counter.address_space_id == FWTS_GAS_ADDR_SPACE_ID_FFH)) {
+ if (lpi->residency_counter.register_bit_width != 64) {
+ *passed = false;
+ fwts_failed(fw, LOG_LEVEL_LOW,
+ "LPITNativeCStateLpitResidencyCounterWidth",
+ "Native C-state based LPI structure Residency Structure "
+ "Register Bit Width was %" PRIu8 " for a FFH Address "
+ "Space (e.g. a MSR), and was expecting 64.",
+ lpi->residency_counter.register_bit_width);
+ }
+ if (lpi->residency_counter.register_bit_offset != 0) {
+ *passed = false;
+ fwts_failed(fw, LOG_LEVEL_LOW,
+ "LPITNativeCStateLpitResidencyCounterOffset",
+ "Native C-state based LPI structure Residency Structure "
+ "Register Bit Offset %" PRIu8 " for a FFH Address "
+ "Space (e.g. a MSR), and was expecting 0.",
+ lpi->residency_counter.register_bit_offset);
+ }
+ if (lpi->residency_counter.access_width != 0) {
+ *passed = false;
+ fwts_failed(fw, LOG_LEVEL_LOW,
+ "LPITNativeCStateLpitResidencyCounterAccessSize",
+ "Native C-state based LPI structure Residency Structure "
+ "Register Access Size %" PRIu8 " for a FFH Address "
+ "Space (e.g. a MSR), and was expecting 0.",
+ lpi->residency_counter.access_width);
+ }
+ }
+ if (! *passed)
+ fwts_log_nl(fw);
+
+ *length -= lpi->length;
+ *data += lpi->length;
+}
+
+/*
+ * http://www.uefi.org/sites/default/files/resources/ACPI_Low_Power_Idle_Table.pdf
+ */
+static int lpit_test1(fwts_framework *fw)
+{
+ uint8_t *data;
+ bool passed = true;
+ uint32_t length;
+ fwts_acpi_table_lpit *lpit = (fwts_acpi_table_lpit *)table->data;
+
+ if (table->length < sizeof(fwts_acpi_table_lpit)) {
+ passed = false;
+ fwts_failed(fw, LOG_LEVEL_HIGH,
+ "LPITTooShort",
+ "LPIT is only %zu bytes long, "
+ "expected at least %zu bytes for the "
+ "header structure",
+ table->length,
+ sizeof(fwts_acpi_table_lpit_c_state));
+ goto done;
+ }
+
+ length = lpit->header.length - sizeof(fwts_acpi_table_lpit);
+ data = (uint8_t *)table->data + sizeof(fwts_acpi_table_lpit);
+
+ /* Got enough data to be able to inspect the initial 2 x 32 bit words.. */
+ while (length > 8) {
+ uint32_t *ptr = (uint32_t *)data;
+ uint32_t lpi_length = *(ptr + 1);
+
+ /* Stated LPI length must not be longer than what's left in the table */
+ if (length < lpi_length) {
+ passed = false;
+ fwts_failed(fw, LOG_LEVEL_HIGH,
+ "LPITTooShort",
+ "LPIT LPI structure type is only %" PRIu32
+ " bytes long, expected at least %zu bytes",
+ length,
+ table->length);
+ break;
+ }
+
+ /* For now, just one type is described in the specification */
+ switch (*ptr) {
+ case 0x0:
+ lpit_check_type_0(fw, &length, &data, &passed);
+ break;
+ default:
+ passed = false;
+ fwts_failed(fw, LOG_LEVEL_HIGH,
+ "LPITInvalidType",
+ "LPIT Type 0x8.8%" PRIx32
+ " is an invalid type, expecting 0",
+ *ptr);
+ length = 0;
+ break;
+ }
+ }
+
+done:
+ if (passed)
+ fwts_passed(fw, "No issues found in LPIT table.");
+
+ return FWTS_OK;
+}
+
+static fwts_framework_minor_test lpit_tests[] = {
+ { lpit_test1, "LPIT Low Power Idle Table test." },
+ { NULL, NULL }
+};
+
+static fwts_framework_ops lpit_ops = {
+ .description = "LPIT LPIT Low Power Idle Table test.",
+ .init = lpit_init,
+ .minor_tests = lpit_tests
+};
+
+FWTS_REGISTER("lpit", &lpit_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_TEST_ACPI)
diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
index a6b929c..1acbaef 100644
--- a/src/lib/include/fwts_acpi.h
+++ b/src/lib/include/fwts_acpi.h
@@ -1099,4 +1099,28 @@ typedef struct {
#define FWTS_ACPI_TABLE_CSRT_TYPE_TIMER (0x0002)
#define FWTS_ACPI_TABLE_CSRT_TYPE_DMA (0x0003)
+/*
+ * ACPI Low Power Idle Table
+ * http://www.uefi.org/sites/default/files/resources/ACPI_Low_Power_Idle_Table.pdf
+ */
+
+/* LPI struct type 0 */
+typedef struct {
+ uint32_t type;
+ uint32_t length;
+ uint16_t id;
+ uint16_t reserved;
+ uint32_t flags;
+ fwts_acpi_gas entry_trigger;
+ uint32_t residency;
+ uint32_t latency;
+ fwts_acpi_gas residency_counter;
+ uint64_t residency_counter_freq;
+} __attribute__ ((packed)) fwts_acpi_table_lpit_c_state;
+
+typedef struct {
+ fwts_acpi_table_header header;
+ /* followed by 1 or more LPI structure types */
+} __attribute__ ((packed)) fwts_acpi_table_lpit;
+
#endif
--
2.1.4
More information about the fwts-devel
mailing list