Implementation of Region APIstabilize-4636.B

At present reading data from storage in Vboot is a little fragmented. For
the firmware image, we expect the boot loader to handle this. For the disk
we have a block-level API. For the GBB (which also sits in the firmware
image) we expect the entire thing to be read before Vboot is called.

Add the concept of a region, and an API to read from a region. At present,
and most pressing, is reading from a GBB region. In the future this could
be extended to other parts of the firmware or even the disk.

Move all access to the GBB into this API so that the boot loader can provide
either a GBB region in one large contiguous chunk, or a function to deal with
read requests from vboot.

The call to VbExRegionRead() is behind a flag since not all boot loaders
support it yet.

The main change for boot loaders which don't support this new API is that
vboot will do more behind the scenes. For example, it will allocate memory
for chunks of data that it reads from the GBB, rather than just accessing it
directly. This approach is considerably simpler than trying to pass char **
everywhere and have vboot decide whether something needs to be allocated or
not.

The tests are updated, mainly to include setting up a GBB structure
accessible from VbCommonParams, which is now required by the firmware and
kernel functions. In normal operation this is set up at the start of
VbLoadFIrmware() and VbSelectAndLoadKernel() but for tests which call
children of these functions directly, the GBB structure must be set up
manually by the test.

BUG=chrome-os-partner:21115
BRANCH=none
TEST=manual
FEATURES=test sudo -E  emerge vboot_reference

Change-Id: If2b8bbe467fdbd643239d8d9b5d7aa98df4d286f
Signed-off-by: Simon Glass <sjg@chromium.org>
Signed-off-by: David Hendricks <dhendrix@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/63336
Reviewed-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/167361

1 files changed, 44 insertions, 11 deletions

diff --git a/tests/vboot_display_tests.c b/tests/vboot_display_tests.c
index 8e4a3a27..8086d319 100644
--- a/tests/vboot_display_tests.c
+++ b/tests/vboot_display_tests.c
@@ -13,9 +13,11 @@
 #include "bmpblk_font.h"
 #include "gbb_header.h"
 #include "host_common.h"
+#include "region.h"
 #include "test_common.h"
 #include "vboot_common.h"
 #include "vboot_display.h"
+#include "vboot_kernel.h"
 #include "vboot_nvstorage.h"
 
 /* Mock data */
@@ -59,6 +61,20 @@ static void ResetMocks(void)
 	cparams.gbb_data = gbb;
 	cparams.gbb_size = sizeof(gbb_data);
 
+	/*
+	 * Note, VbApiKernelFree() expects this to be allocated by
+	 * VbExMalloc(), so we cannot just assign it staticly.
+	 */
+	cparams.gbb = VbExMalloc(sizeof(*gbb));
+	gbb->header_size = sizeof(*gbb);
+	gbb->rootkey_offset = gbb_used;
+	gbb->rootkey_size = 64;
+	gbb_used += 64;
+	gbb->recovery_key_offset = gbb_used;
+	gbb->recovery_key_size = 64;
+	gbb_used += 64;
+	memcpy(cparams.gbb, gbb, sizeof(*gbb));
+
 	Memset(&vnc, 0, sizeof(vnc));
 	VbNvSetup(&vnc);
 	VbNvTeardown(&vnc);                   /* So CRC gets generated */
@@ -81,6 +97,7 @@ VbError_t VbExDisplayDebugInfo(const char *info_str)
 /* Test displaying debug info */
 static void DebugInfoTest(void)
 {
+	char hwid[VB_REGION_HWID_LEN];
 	int i;
 
 	/* Recovery string should be non-null for any code */
@@ -89,28 +106,39 @@ static void DebugInfoTest(void)
 
 	/* HWID should come from the gbb */
 	ResetMocks();
-	TEST_EQ(strcmp(VbHWID(&cparams), "Test HWID"), 0, "HWID");
+	VbRegionReadHWID(&cparams, hwid, sizeof(hwid));
+	TEST_EQ(strcmp(hwid, "Test HWID"), 0, "HWID");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
 	cparams.gbb_size = 0;
-	TEST_EQ(strcmp(VbHWID(&cparams), "{INVALID}"), 0, "HWID bad gbb");
+	VbRegionReadHWID(&cparams, hwid, sizeof(hwid));
+	TEST_EQ(strcmp(hwid, "{INVALID}"), 0, "HWID bad gbb");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
-	gbb->hwid_size = 0;
-	TEST_EQ(strcmp(VbHWID(&cparams), "{INVALID}"), 0, "HWID missing");
+	cparams.gbb->hwid_size = 0;
+	VbRegionReadHWID(&cparams, hwid, sizeof(hwid));
+	TEST_EQ(strcmp(hwid, "{INVALID}"), 0, "HWID missing");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
-	gbb->hwid_offset = cparams.gbb_size + 1;
-	TEST_EQ(strcmp(VbHWID(&cparams), "{INVALID}"), 0, "HWID past end");
+	cparams.gbb->hwid_offset = cparams.gbb_size + 1;
+	VbRegionReadHWID(&cparams, hwid, sizeof(hwid));
+	TEST_EQ(strcmp(hwid, "{INVALID}"), 0, "HWID past end");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
-	gbb->hwid_size = cparams.gbb_size;
-	TEST_EQ(strcmp(VbHWID(&cparams), "{INVALID}"), 0, "HWID overflow");
+	cparams.gbb->hwid_size = cparams.gbb_size;
+	VbRegionReadHWID(&cparams, hwid, sizeof(hwid));
+	TEST_EQ(strcmp(hwid, "{INVALID}"), 0, "HWID overflow");
+	VbApiKernelFree(&cparams);
 
 	/* Display debug info */
 	ResetMocks();
 	VbDisplayDebugInfo(&cparams, &vnc);
 	TEST_NEQ(*debug_info, '\0', "Some debug info was displayed");
+	VbApiKernelFree(&cparams);
 }
 
 /* Test localization */
@@ -119,21 +147,23 @@ static void LocalizationTest(void)
 	uint32_t count = 6;
 
 	ResetMocks();
-	gbb->bmpfv_size = 0;
+	cparams.gbb->bmpfv_size = 0;
 	TEST_EQ(VbGetLocalizationCount(&cparams, &count),
 		VBERROR_INVALID_GBB, "VbGetLocalizationCount bad gbb");
 	TEST_EQ(count, 0, "  count");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
 	bhdr->signature[0] ^= 0x5a;
 	TEST_EQ(VbGetLocalizationCount(&cparams, &count),
 		VBERROR_INVALID_BMPFV, "VbGetLocalizationCount bad bmpfv");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
 	TEST_EQ(VbGetLocalizationCount(&cparams, &count), 0,
 		"VbGetLocalizationCount()");
 	TEST_EQ(count, 3, "  count");
-
+	VbApiKernelFree(&cparams);
 }
 
 /* Test display key checking */
@@ -144,10 +174,12 @@ static void DisplayKeyTest(void)
 	ResetMocks();
 	VbCheckDisplayKey(&cparams, 'q', &vnc);
 	TEST_EQ(*debug_info, '\0', "DisplayKey q = does nothing");
+	VbApiKernelFree(&cparams);
 
 	ResetMocks();
 	VbCheckDisplayKey(&cparams, '\t', &vnc);
 	TEST_NEQ(*debug_info, '\0', "DisplayKey tab = display");
+	VbApiKernelFree(&cparams);
 
 	/* Toggle localization */
 	ResetMocks();
@@ -165,6 +197,7 @@ static void DisplayKeyTest(void)
 	VbCheckDisplayKey(&cparams, VB_KEY_UP, &vnc);
 	VbNvGet(&vnc, VBNV_LOCALIZATION_INDEX, &u);
 	TEST_EQ(u, 0, "DisplayKey up");
+	VbApiKernelFree(&cparams);
 
 	/* Reset localization if localization count is invalid */
 	ResetMocks();
@@ -174,7 +207,7 @@ static void DisplayKeyTest(void)
 	VbCheckDisplayKey(&cparams, VB_KEY_UP, &vnc);
 	VbNvGet(&vnc, VBNV_LOCALIZATION_INDEX, &u);
 	TEST_EQ(u, 0, "DisplayKey invalid");
-
+	VbApiKernelFree(&cparams);
 }
 
 static void FontTest(void)