From 9d130a9e1038e406c4be74a70a99f5530ef5c55d Mon Sep 17 00:00:00 2001 From: Aaron Durbin Date: Fri, 5 Aug 2016 15:24:33 -0500 Subject: [PATCH] drivers/elog: remove unnecessary global state There were 3 variables indicating the state of the event log region. However, there's no need to keep track of those individually. The only thing required is to know is if elog_scan_flash() failed. There's no other tracking required beyond that. BUG=chrome-os-partner:55932 Change-Id: I88ad32091d3c37966a2ac6272f8ad95bcc8c4270 Signed-off-by: Aaron Durbin Reviewed-on: https://review.coreboot.org/16100 Tested-by: build bot (Jenkins) Reviewed-by: Martin Roth --- src/drivers/elog/elog.c | 71 ++++++++------------------------ src/drivers/elog/elog_internal.h | 16 ------- 2 files changed, 17 insertions(+), 70 deletions(-) diff --git a/src/drivers/elog/elog.c b/src/drivers/elog/elog.c index f65c0d648b..036ab91493 100644 --- a/src/drivers/elog/elog.c +++ b/src/drivers/elog/elog.c @@ -50,10 +50,6 @@ static u32 flash_base; static u16 full_threshold; static u16 shrink_size; -static elog_area_state area_state; -static elog_header_state header_state; -static elog_event_buffer_state event_buffer_state; - /* * The non-volatile storage chases the mirrored copy. When nv_last_write * is less than the mirrored last write the non-volatile storage needs @@ -220,22 +216,6 @@ static int elog_is_buffer_clear(size_t offset) return ret; } -/* - * Check that the ELOG area has been initialized and is valid. - */ -static int elog_is_area_valid(void) -{ - elog_debug("elog_is_area_valid()\n"); - - if (area_state != ELOG_AREA_HAS_CONTENT) - return 0; - if (header_state != ELOG_HEADER_VALID) - return 0; - if (event_buffer_state != ELOG_EVENT_BUFFER_OK) - return 0; - return 1; -} - /* * Verify if the mirrored elog structure is valid. * Returns 1 if the header is valid, 0 otherwise @@ -357,7 +337,7 @@ static void elog_flash_erase(void) /* * Scan the event area and validate each entry and update the ELOG state. */ -static void elog_update_event_buffer_state(void) +static int elog_update_event_buffer_state(void) { size_t offset = elog_events_start(); @@ -372,8 +352,7 @@ static void elog_update_event_buffer_state(void) if (rdev_readat(mirror_dev_get(), &type, offset + type_offset, size) < 0) { - event_buffer_state = ELOG_EVENT_BUFFER_CORRUPTED; - break; + return -1; } /* The end of the event marker has been found */ @@ -383,10 +362,8 @@ static void elog_update_event_buffer_state(void) /* Validate the event */ len = elog_is_event_valid(offset); - if (!len) { - event_buffer_state = ELOG_EVENT_BUFFER_CORRUPTED; - break; - } + if (!len) + return -1; /* Move to the next event */ elog_tandem_increment_last_write(len); @@ -395,19 +372,17 @@ static void elog_update_event_buffer_state(void) /* Ensure the remaining buffer is empty */ if (!elog_is_buffer_clear(offset)) - event_buffer_state = ELOG_EVENT_BUFFER_CORRUPTED; + return -1; + + return 0; } -static void elog_scan_flash(void) +static int elog_scan_flash(void) { elog_debug("elog_scan_flash()\n"); void *mirror_buffer; const struct region_device *rdev = mirror_dev_get(); - area_state = ELOG_AREA_UNDEFINED; - header_state = ELOG_HEADER_INVALID; - event_buffer_state = ELOG_EVENT_BUFFER_OK; - /* Fill memory buffer by reading from SPI */ mirror_buffer = rdev_mmap_full(rdev); elog_spi->read(elog_spi, flash_base, total_size, mirror_buffer); @@ -417,24 +392,17 @@ static void elog_scan_flash(void) elog_tandem_reset_last_write(); /* Check if the area is empty or not */ - if (elog_is_buffer_clear(0)) { - area_state = ELOG_AREA_EMPTY; - return; - } - - area_state = ELOG_AREA_HAS_CONTENT; + if (elog_is_buffer_clear(0)) + return -1; /* Indicate that header possibly written. */ elog_tandem_increment_last_write(elog_events_start()); /* Validate the header */ - if (!elog_is_header_valid()) { - header_state = ELOG_HEADER_INVALID; - return; - } + if (!elog_is_header_valid()) + return -1; - header_state = ELOG_HEADER_VALID; - elog_update_event_buffer_state(); + return elog_update_event_buffer_state(); } static void elog_write_header_in_mirror(void) @@ -568,7 +536,7 @@ static int elog_prepare_empty(void) elog_debug("elog_prepare_empty()\n"); elog_shrink_by_size(elog_events_total_space()); - if (!elog_is_area_valid()) + if (elog_initialized != ELOG_INITIALIZED) return -1; return 0; @@ -706,10 +674,8 @@ static int elog_sync_to_nv(void) if (!erase_needed) return 0; - elog_scan_flash(); - /* Mark broken if the scan failed after a sync. */ - if (!elog_is_area_valid()) { + if (elog_scan_flash() < 0) { printk(BIOS_ERR, "ELOG: Sync back from NV storage failed.\n"); elog_initialized = ELOG_BROKEN; return -1; @@ -765,17 +731,14 @@ int elog_init(void) } mem_region_device_rw_init(&mirror_dev, mirror_buffer, total_size); - /* Load the log from flash */ - elog_scan_flash(); - /* * Mark as initialized to allow elog_init() to be called and deemed * successful in the prepare/shrink path which adds events. */ elog_initialized = ELOG_INITIALIZED; - /* Prepare the flash if necessary */ - if (!elog_is_area_valid()) { + /* Load the log from flash and prepare the flash if necessary. */ + if (elog_scan_flash() < 0) { printk(BIOS_ERR, "ELOG: flash area invalid\n"); if (elog_prepare_empty() < 0) { printk(BIOS_ERR, "ELOG: Unable to prepare flash\n"); diff --git a/src/drivers/elog/elog_internal.h b/src/drivers/elog/elog_internal.h index ef21bf0f3f..a09bbefe8d 100644 --- a/src/drivers/elog/elog_internal.h +++ b/src/drivers/elog/elog_internal.h @@ -45,20 +45,4 @@ struct event_header { /* SMBIOS Type 15 related constants */ #define ELOG_HEADER_TYPE_OEM 0x88 -typedef enum elog_area_state { - ELOG_AREA_UNDEFINED, /* Initial boot strap state */ - ELOG_AREA_EMPTY, /* Entire area is empty */ - ELOG_AREA_HAS_CONTENT, /* Area has some content */ -} elog_area_state; - -typedef enum elog_header_state { - ELOG_HEADER_INVALID, - ELOG_HEADER_VALID, -} elog_header_state; - -typedef enum elog_event_buffer_state { - ELOG_EVENT_BUFFER_OK, - ELOG_EVENT_BUFFER_CORRUPTED, -} elog_event_buffer_state; - #endif /* ELOG_INTERNAL_H_ */