minidiag: Rename storage to storage health info
Rename storage to storage health info to prevent confusing with storage
self-test.
BRANCH=none
BUG=b:173364332
TEST=make clean && CC=x86_64-pc-linux-gnu-clang make runtests
Cq-Depend: chromium:2709784
Signed-off-by: Chung-Sheng Wu <chungsheng@google.com>
Change-Id: I6c5e355e2062b8c371dbbeff8a5f1b9445bac9f0
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/vboot_reference/+/2719252
Tested-by: Chung-Sheng Wu <chungsheng@chromium.org>
Commit-Queue: Chung-Sheng Wu <chungsheng@chromium.org>
Reviewed-by: Meng-Huan Yu <menghuan@chromium.org>
Reviewed-by: Yu-Ping Wu <yupingso@chromium.org>
diff --git a/firmware/2lib/2stub.c b/firmware/2lib/2stub.c
index 79fcf71..f7b15ce 100644
--- a/firmware/2lib/2stub.c
+++ b/firmware/2lib/2stub.c
@@ -187,9 +187,10 @@
}
__attribute__((weak))
-const char *vb2ex_get_diagnostic_storage(void)
+vb2_error_t vb2ex_diag_get_storage_health(const char **out)
{
- return "mock";
+ *out = "mock";
+ return VB2_SUCCESS;
}
__attribute__((weak))
diff --git a/firmware/2lib/2ui_screens.c b/firmware/2lib/2ui_screens.c
index adebc53..a843530 100644
--- a/firmware/2lib/2ui_screens.c
+++ b/firmware/2lib/2ui_screens.c
@@ -1056,8 +1056,8 @@
static const struct vb2_menu_item diagnostics_items[] = {
LANGUAGE_SELECT_ITEM,
{
- .text = "Storage",
- .target = VB2_SCREEN_DIAGNOSTICS_STORAGE,
+ .text = "Storage health info",
+ .target = VB2_SCREEN_DIAGNOSTICS_STORAGE_HEALTH,
},
{
.text = "Quick memory check",
@@ -1077,16 +1077,17 @@
};
/******************************************************************************/
-/* VB2_SCREEN_DIAGNOSTICS_STORAGE */
+/* VB2_SCREEN_DIAGNOSTICS_STORAGE_HEALTH */
-#define DIAGNOSTICS_STORAGE_ITEM_PAGE_UP 0
-#define DIAGNOSTICS_STORAGE_ITEM_PAGE_DOWN 1
-#define DIAGNOSTICS_STORAGE_ITEM_BACK 2
+#define DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_UP 0
+#define DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_DOWN 1
+#define DIAGNOSTICS_STORAGE_HEALTH_ITEM_BACK 2
-static vb2_error_t diagnostics_storage_init(struct vb2_ui_context *ui)
+static vb2_error_t diagnostics_storage_health_init(struct vb2_ui_context *ui)
{
- const char *log_string = vb2ex_get_diagnostic_storage();
- if (!log_string) {
+ const char *log_string;
+ vb2_error_t rv = vb2ex_diag_get_storage_health(&log_string);
+ if (rv != VB2_SUCCESS) {
VB2_DEBUG("ERROR: Failed to retrieve storage log message\n");
ui->error_code = VB2_UI_ERROR_DIAGNOSTICS;
return vb2_ui_screen_back(ui);
@@ -1102,21 +1103,21 @@
return log_page_init(ui);
}
-static const struct vb2_menu_item diagnostics_storage_items[] = {
- [DIAGNOSTICS_STORAGE_ITEM_PAGE_UP] = PAGE_UP_ITEM,
- [DIAGNOSTICS_STORAGE_ITEM_PAGE_DOWN] = PAGE_DOWN_ITEM,
- [DIAGNOSTICS_STORAGE_ITEM_BACK] = BACK_ITEM,
+static const struct vb2_menu_item diagnostics_storage_health_items[] = {
+ [DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_UP] = PAGE_UP_ITEM,
+ [DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_DOWN] = PAGE_DOWN_ITEM,
+ [DIAGNOSTICS_STORAGE_HEALTH_ITEM_BACK] = BACK_ITEM,
POWER_OFF_ITEM,
};
-static const struct vb2_screen_info diagnostics_storage_screen = {
- .id = VB2_SCREEN_DIAGNOSTICS_STORAGE,
- .name = "Storage",
- .init = diagnostics_storage_init,
- .menu = MENU_ITEMS(diagnostics_storage_items),
- .page_up_item = DIAGNOSTICS_STORAGE_ITEM_PAGE_UP,
- .page_down_item = DIAGNOSTICS_STORAGE_ITEM_PAGE_DOWN,
- .back_item = DIAGNOSTICS_STORAGE_ITEM_BACK,
+static const struct vb2_screen_info diagnostics_storage_health_screen = {
+ .id = VB2_SCREEN_DIAGNOSTICS_STORAGE_HEALTH,
+ .name = "Storage health info",
+ .init = diagnostics_storage_health_init,
+ .menu = MENU_ITEMS(diagnostics_storage_health_items),
+ .page_up_item = DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_UP,
+ .page_down_item = DIAGNOSTICS_STORAGE_HEALTH_ITEM_PAGE_DOWN,
+ .back_item = DIAGNOSTICS_STORAGE_HEALTH_ITEM_BACK,
};
/******************************************************************************/
@@ -1283,7 +1284,7 @@
&developer_invalid_disk_screen,
&developer_select_bootloader_screen,
&diagnostics_screen,
- &diagnostics_storage_screen,
+ &diagnostics_storage_health_screen,
&diagnostics_memory_quick_screen,
&diagnostics_memory_full_screen,
};
diff --git a/firmware/2lib/include/2api.h b/firmware/2lib/include/2api.h
index 2b7fce4..8821ff9 100644
--- a/firmware/2lib/include/2api.h
+++ b/firmware/2lib/include/2api.h
@@ -1344,7 +1344,7 @@
/* Diagnostic tools */
VB2_SCREEN_DIAGNOSTICS = 0x400,
/* Storage diagnostic screen */
- VB2_SCREEN_DIAGNOSTICS_STORAGE = 0x410,
+ VB2_SCREEN_DIAGNOSTICS_STORAGE_HEALTH = 0x410,
/* Memory diagnostic screens */
VB2_SCREEN_DIAGNOSTICS_MEMORY_QUICK = 0x420,
VB2_SCREEN_DIAGNOSTICS_MEMORY_FULL = 0x421,
@@ -1515,16 +1515,15 @@
const char *str);
/**
- * Get the full storage diagnostic log.
+ * Get the health info of the storage.
*
- * Return a pointer of full log string which is guaranteed to be
- * null-terminated. The function implementation should manage string memory
- * internally. Subsequent calls may update the string and/or may return a new
- * pointer.
- *
- * @return The pointer to the full debug info string. NULL on error.
+ * @param out For returning a read-only pointer of full log string which is
+ * guaranteed to be null-terminated. The function will manage
+ * memory internally, so the returned pointer will only be valid
+ * until next call.
+ * @return VB2_SUCCESS, or error code on error.
*/
-const char *vb2ex_get_diagnostic_storage(void);
+vb2_error_t vb2ex_diag_get_storage_health(const char **out);
/**
* Get the memory diagnostic status. When it is called, it will take over the
diff --git a/tests/vb2_ui_tests.c b/tests/vb2_ui_tests.c
index 812fe5e..39acd2d 100644
--- a/tests/vb2_ui_tests.c
+++ b/tests/vb2_ui_tests.c
@@ -1818,9 +1818,9 @@
DISPLAYED_EQ("storage button",
VB2_SCREEN_DIAGNOSTICS, MOCK_IGNORE, 1, MOCK_IGNORE,
MOCK_IGNORE, MOCK_IGNORE);
- DISPLAYED_EQ("#1: storage screen", VB2_SCREEN_DIAGNOSTICS_STORAGE,
- MOCK_IGNORE, MOCK_IGNORE, MOCK_IGNORE, MOCK_IGNORE,
- MOCK_IGNORE);
+ DISPLAYED_EQ("#1: storage screen",
+ VB2_SCREEN_DIAGNOSTICS_STORAGE_HEALTH, MOCK_IGNORE,
+ MOCK_IGNORE, MOCK_IGNORE, MOCK_IGNORE, MOCK_IGNORE);
/* #2: Quick memory test screen */
DISPLAYED_PASS();
DISPLAYED_EQ("quick memory test button",
