/* * SPDX-FileCopyrightText: 2016-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include "esp_partition.h" #include "esp_private/partition_linux.h" #include "wear_levelling.h" #include "WL_Flash.h" #include "crc32.h" #include #include "sdkconfig.h" #include "esp_log.h" static const char *TAG = "test_wl"; // Number of test cycles. Prime number close to 100 #define TEST_COUNT_MAX 101 // Number of erase operations until emulated power off error is raised // Prime number close to 100 #define ERASE_CYCLES_TILL_POWER_OFF 97 TEST_CASE("write and read back data", "[wear_levelling]") { esp_err_t result; wl_handle_t wl_handle; const esp_partition_t *partition = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage"); // Mount wear-levelled partition result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); // Get the sector size uint32_t sector_size = wl_sector_size(wl_handle); REQUIRE(sector_size == CONFIG_WL_SECTOR_SIZE); uint8_t* data = (uint8_t*) malloc(partition->size); uint8_t* read = (uint8_t*) malloc(partition->size); uint32_t sectors = partition->size / sector_size; // Generate data for(uint32_t sector = 0; sector < sectors; sector++) { uint32_t sector_address = sector * sector_size; for(uint32_t i = 0; i < sector_size / sizeof(i); i++) { ((uint32_t*) data)[i] = sector_address + i; } } // Write data result = wl_write(wl_handle, 0, data, partition->size); REQUIRE(result == ESP_OK); // Read data result = wl_read(wl_handle, 0, read, partition->size); REQUIRE(result == ESP_OK); // Verify that written and read data match REQUIRE(memcmp(data, read, partition->size)); // Erase some ranges result = wl_erase_range(wl_handle, 0, sector_size); REQUIRE(result == ESP_OK); result = wl_erase_range(wl_handle, 12288, sector_size * 2); REQUIRE(result == ESP_OK); result = wl_erase_range(wl_handle, 28672, sector_size * 3); REQUIRE(result == ESP_OK); // Expected data after erasure memset(data + 0, 0xFF, sector_size); memset(data + 12288, 0xFF, sector_size * 2); memset(data + 28672, 0xFF, sector_size * 3); // Read again, with erased ranges result = wl_read(wl_handle, 0, read, partition->size); REQUIRE(result == ESP_OK); // Verify that written and read data match REQUIRE(memcmp(data, read, partition->size)); // Unmount result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); free(data); free(read); } TEST_CASE("power down test", "[wear_levelling]") { esp_err_t result; wl_handle_t wl_handle; const esp_partition_t *partition = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage"); // Disable power down failure counting esp_partition_fail_after(SIZE_MAX, 0); // Mount wear-levelled partition result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); // Get wl partition information size_t sector_size = wl_sector_size(wl_handle); int32_t sectors_count = wl_size(wl_handle) / sector_size; uint32_t add_const = 0; uint32_t *sector_data = new uint32_t[sector_size / sizeof(uint32_t)]; // Fill partition with check data for (int32_t i = 0; i < sectors_count; i++) { ESP_LOGV(TAG, "%s(%d): wl_erase_range (*, %lu, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); REQUIRE(wl_erase_range(wl_handle, i * sector_size, sector_size) == ESP_OK); for (uint32_t m = 0; m < sector_size / sizeof(uint32_t); m++) { uint32_t temp_data = i * sector_size + add_const + m; sector_data[m] = temp_data; } ESP_LOGV(TAG, "%s(%d): wl_write (*, %lu, *, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); REQUIRE(wl_write(wl_handle, i * sector_size, sector_data, sector_size) == ESP_OK); } for (int32_t i = 0; i < sectors_count; i++) { ESP_LOGV(TAG, "%s(%d): wl_read (*, %lu, *, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); result |= wl_read(wl_handle, i * sector_size, sector_data, sector_size); for (uint32_t m = 0; m < sector_size / sizeof(uint32_t); m++) { uint32_t temp_data = i * sector_size + add_const + m; REQUIRE(temp_data == sector_data[m]); if (temp_data != sector_data[m]) { printf("Error - read: %08x, expected %08x\n", sector_data[m], temp_data); } } } // Perform test int32_t max_count = ERASE_CYCLES_TILL_POWER_OFF; int32_t max_check_count = TEST_COUNT_MAX; ESP_LOGI(TAG, "%s(%d): max_check_count = %d)", __FUNCTION__, __LINE__, max_check_count); for (int32_t k = 0; k < max_check_count; k++) { // Enable power down failure after max_count cycles esp_partition_fail_after(max_count, ESP_PARTITION_FAIL_AFTER_MODE_BOTH); int32_t err_sector = -1; for (int32_t i = 0; i < sectors_count; i++) { result = ESP_OK; ESP_LOGV(TAG, "%s(%d): wl_erase_range (*, %lu, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); result = wl_erase_range(wl_handle, i * sector_size, sector_size); if (result != ESP_OK) { err_sector = i; break; } for (uint32_t m = 0; m < sector_size / sizeof(uint32_t); m++) { uint32_t temp_data = i * sector_size + add_const + m; sector_data[m] = temp_data; } ESP_LOGV(TAG, "%s(%d): wl_write (*, %lu, *, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); result = wl_write(wl_handle, i * sector_size, sector_data, sector_size); if (result != ESP_OK) { err_sector = i; break; } } if (err_sector >= 0) { max_count++; } else { max_count = 0; } // Call unmount, but don't care about the result as the power down failure may be persisting or even arise during the unmount. // In real power down scenario, this function won't be called, here in the test, we need it to free wl handles in driver. ESP_LOGV(TAG, "%s(%d): wl_unmount", __FUNCTION__, __LINE__); wl_unmount(wl_handle); // Disable power down failure counting esp_partition_fail_after(SIZE_MAX, 0); ESP_LOGV(TAG, "%s(%d): wl_mount", __FUNCTION__, __LINE__); result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); for (int32_t i = 0; i < sectors_count; i++) { if (i != err_sector) { ESP_LOGV(TAG, "%s(%d): wl_read (*, %lu, *, %zu)", __FUNCTION__, __LINE__, i * sector_size, sector_size); result |= wl_read(wl_handle, i * sector_size, sector_data, sector_size); for (uint32_t m = 0; m < sector_size / sizeof(uint32_t); m++) { uint32_t temp_data = i * sector_size + add_const + m; REQUIRE(temp_data == sector_data[m]); if (temp_data != sector_data[m]) { printf("Error - read: %08x, expected %08x, m=%i, sector=%i\n", sector_data[m], temp_data, m, i); } } } } if (err_sector != -1) { ESP_LOGV(TAG, "%s(%d): wl_erase_range (*, %lu, %zu)", __FUNCTION__, __LINE__, err_sector * sector_size, sector_size); result |= wl_erase_range(wl_handle, err_sector * sector_size, sector_size); for (uint32_t m = 0; m < sector_size / sizeof(uint32_t); m++) { uint32_t temp_data = err_sector * sector_size + add_const + m; sector_data[m] = temp_data; } ESP_LOGV(TAG, "%s(%d): wl_write (*, %lu, *, %zu)", __FUNCTION__, __LINE__, err_sector * sector_size, sector_size); result |= wl_write(wl_handle, err_sector * sector_size, sector_data, sector_size); } } delete[] sector_data; // Unmount ESP_LOGV(TAG, "%s(%d): wl_unmount", __FUNCTION__, __LINE__); result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); } // Calculates wl status blocks offsets and status block size void calculate_wl_state_address_info(const esp_partition_t *partition, size_t *offset_state_1, size_t *offset_state_2, size_t *state_size) { // This code follows ::init of WL_Flash.cpp // and define directives from wear_levelling.cpp // get sector size esp_err_t result; wl_handle_t wl_handle; // Try to mount wear-levelled partition ESP_LOGD(TAG, "wl_mount"); result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); size_t sector_size = wl_sector_size(wl_handle); //SPI_FLASH_SEC_SIZE 4096; REQUIRE(sector_size == CONFIG_WL_SECTOR_SIZE); // Unmount ESP_LOGD(TAG, "wl_unmount"); result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); // rest of parameters size_t full_mem_size = partition->size; size_t start_addr = 0; // WL_DEFAULT_START_ADDR 0 size_t wr_size = 16; // WL_DEFAULT_WRITE_SIZE 16 size_t cfg_size = 0; *state_size = sector_size; if (*state_size < (sizeof(wl_state_t) + (full_mem_size / sector_size) * wr_size)) { *state_size = ((sizeof(wl_state_t) + (full_mem_size / sector_size) * wr_size) + sector_size - 1) / sector_size; *state_size = *state_size * sector_size; } cfg_size = (sizeof(wl_config_t) + sector_size - 1) / sector_size; cfg_size = cfg_size * sector_size; *offset_state_1 = start_addr + full_mem_size - *state_size * 2 - cfg_size; *offset_state_2 = start_addr + full_mem_size - *state_size * 1 - cfg_size; } #ifndef WL_CFG_CRC_CONST #define WL_CFG_CRC_CONST UINT32_MAX #endif // WL_CFG_CRC_CONST // calculates crc of wear levelling state block void calculate_wl_state_crc(WL_State_s *state_ptr) { int check_size = WL_STATE_CRC_LEN_V2; // Chech CRC and recover state state_ptr->crc32 = crc32::crc32_le(WL_CFG_CRC_CONST, (uint8_t *)state_ptr, check_size); } TEST_CASE("power down during WL status 1 update", "[wear_levelling]") { // Manipulates wl status block 1 as if it wasn't written correctly due to power down event // Tries to let such a damaged flash wl_mount (and recover) ESP_LOGI(TAG, "power down during WL status 1 update"); esp_err_t result; wl_handle_t wl_handle; const esp_partition_t *partition = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage"); size_t offset_state_1, offset_state_2, size_state = 0; // get offsets of respective status blocks in flash calculate_wl_state_address_info(partition, &offset_state_1, &offset_state_2, &size_state); // allocate temporary buffer for status manipulation uint8_t* tmp_state = (uint8_t*) malloc(size_state); // damage 1st status block memset(tmp_state, 0xff, size_state); ESP_LOGD(TAG, "esp_partition_erase_range offset: %zu size: %zu", offset_state_1, size_state); result = esp_partition_erase_range(partition, offset_state_1, size_state); REQUIRE(result == ESP_OK); ESP_LOGD(TAG, "esp_partition_write offset: %zu size: %zu", offset_state_1, size_state); result = esp_partition_write(partition, offset_state_1, tmp_state, size_state); REQUIRE(result == ESP_OK); // Try to mount wear-levelled partition ESP_LOGD(TAG, "wl_mount"); result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); // Unmount ESP_LOGD(TAG, "wl_unmount"); result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); free(tmp_state); } TEST_CASE("power down during WL status 2 update", "[wear_levelling]") { // Manipulates wl status block 2 as if it wasn't written correctly due to power down event // Tries to let such a damaged flash wl_mount (and recover) ESP_LOGI(TAG, "power down during WL status 2 update"); esp_err_t result; wl_handle_t wl_handle; const esp_partition_t *partition = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage"); size_t offset_state_1, offset_state_2, size_state = 0; // get offsets of respective status blocks in flash calculate_wl_state_address_info(partition, &offset_state_1, &offset_state_2, &size_state); // allocate temporary buffer for status manipulation uint8_t* tmp_state = (uint8_t*) malloc(size_state); // damage 2nd status block memset(tmp_state, 0xff, size_state); ESP_LOGD(TAG, "esp_partition_erase_range offset: %zu size: %zu", offset_state_2, size_state); result = esp_partition_erase_range(partition, offset_state_2, size_state); REQUIRE(result == ESP_OK); ESP_LOGD(TAG, "esp_partition_write offset: %zu size: %zu", offset_state_2, size_state); result = esp_partition_write(partition, offset_state_2, tmp_state, size_state); REQUIRE(result == ESP_OK); // Try to mount wear-levelled partition ESP_LOGD(TAG, "wl_mount"); result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); // Unmount ESP_LOGD(TAG, "wl_unmount"); result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); free(tmp_state); } TEST_CASE("power down between WL status 1 and WL status 2 update", "[wear_levelling]") { // Manipulates wl status block 2 and reclaculates its crc just to have two different ones as if it wasn't updates due to power down event // Tries to let such a damaged flash wl_mount (and recover) ESP_LOGI(TAG, "power down between WL status 1 and WL status 2 update"); esp_err_t result; wl_handle_t wl_handle; const esp_partition_t *partition = esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "storage"); size_t offset_state_1, offset_state_2, size_state = 0; // get offsets of respective status blocks in flash calculate_wl_state_address_info(partition, &offset_state_1, &offset_state_2, &size_state); // allocate temporary buffer for status manipulation uint8_t* tmp_state = (uint8_t*) malloc(size_state); // unsync 1st and 2nd block state - change move count in 2nd block and recalculate its crc // read actual status2 ESP_LOGD(TAG, "esp_partition_read offset: %zu size: %zu", offset_state_2, size_state); result = esp_partition_read(partition, offset_state_2, tmp_state, size_state); REQUIRE(result == ESP_OK); // change move count and recalc crc WL_State_s *state_ptr = (WL_State_s *) tmp_state; state_ptr->wl_dummy_sec_move_count++; calculate_wl_state_crc(state_ptr); // write back modified status2 ESP_LOGD(TAG, "esp_partition_erase_range offset: %zu size: %zu", offset_state_2, size_state); result = esp_partition_erase_range(partition, offset_state_2, size_state); REQUIRE(result == ESP_OK); ESP_LOGD(TAG, "esp_partition_write offset: %zu size: %zu", offset_state_2, size_state); result = esp_partition_write(partition, offset_state_2, tmp_state, size_state); REQUIRE(result == ESP_OK); // Try to mount wear-levelled partition ESP_LOGD(TAG, "wl_mount"); result = wl_mount(partition, &wl_handle); REQUIRE(result == ESP_OK); // Unmount ESP_LOGD(TAG, "wl_unmount"); result = wl_unmount(wl_handle); REQUIRE(result == ESP_OK); free(tmp_state); }