Add VbExGetLocalizationCount
authorDaisuke Nojiri <dnojiri@chromium.org>
Wed, 7 Oct 2015 00:03:08 +0000 (17:03 -0700)
committerchrome-bot <chrome-bot@chromium.org>
Tue, 20 Oct 2015 18:18:53 +0000 (11:18 -0700)
VbExGetLocalizationCount is a callback function which is supposed to
return the number of screen locales supported by VbExDisplayScreen.

After this change, we still try to get the number of locales from GBB
first but when it fails, VbExGetLocalizationCount is called. The error
code from VbGbbReadBmpHeader will be masked, similarly to the error from
VbDislayScreenFromGBB.

BUG=chromium:502066
BRANCH=tot
TEST=Tested on Samus. make runtests

Change-Id: I04ef8bf1ea02b1aaa05e65673b57bcea1932d8b0
Signed-off-by: Daisuke Nojiri <dnojiri@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/304376
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
firmware/include/vboot_api.h
firmware/lib/vboot_display.c
tests/vboot_display_tests.c

index bc90b19..18ee4cc 100644 (file)
@@ -1078,4 +1078,12 @@ VbError_t VbLockDevice(void);
  * @return 0 if no override, 1-15 for override priority.
  */
 uint8_t VbExOverrideGptEntryPriority(const GptEntry *e);
+
+/**
+ * Return number of locales supported
+ *
+ * @param count                Pointer to the number of locales.
+ * @return VBERROR_... error, VBERROR_SUCCESS on success.
+ */
+VbError_t VbExGetLocalizationCount(uint32_t *count);
 #endif  /* VBOOT_REFERENCE_VBOOT_API_H_ */
index 1a127e2..f8417b9 100644 (file)
 static uint32_t disp_current_screen = VB_SCREEN_BLANK;
 static uint32_t disp_width = 0, disp_height = 0;
 
+__attribute__((weak))
+VbError_t VbExGetLocalizationCount(uint32_t *count) {
+       return VBERROR_UNKNOWN;
+}
+
 VbError_t VbGetLocalizationCount(VbCommonParams *cparams, uint32_t *count)
 {
        BmpBlockHeader hdr;
@@ -28,12 +33,15 @@ VbError_t VbGetLocalizationCount(VbCommonParams *cparams, uint32_t *count)
        /* Default to 0 on error */
        *count = 0;
 
+       /* First try to get the count from GBB */
        ret = VbGbbReadBmpHeader(cparams, &hdr);
-       if (ret)
+       if (ret == VBERROR_SUCCESS) {
+               *count = hdr.number_of_localizations;
                return ret;
+       }
 
-       *count = hdr.number_of_localizations;
-       return VBERROR_SUCCESS;
+       /* If GBB is broken or missing, fallback to the callback */
+       return VbExGetLocalizationCount(count);
 }
 
 /*
index 63f6890..6e36f64 100644 (file)
@@ -149,14 +149,14 @@ static void LocalizationTest(void)
        ResetMocks();
        cparams.gbb->bmpfv_size = 0;
        TEST_EQ(VbGetLocalizationCount(&cparams, &count),
-               VBERROR_INVALID_GBB, "VbGetLocalizationCount bad gbb");
+               VBERROR_UNKNOWN, "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");
+               VBERROR_UNKNOWN, "VbGetLocalizationCount bad bmpfv");
        VbApiKernelFree(&cparams);
 
        ResetMocks();