sdmmc: Add erase command-38. Support erase/trim/discard/sanitize

options.

Erase command (38) for SD cards allows option for erase/dicard/fule
operation at block level and for MMC cards supports option for
discard/trim at block level. When Sanitize is executed only the
portion of data that was unmapped by a Discard command shall be
removed by the Sanitize command.

Unit test cases added to verify ERASE feature in SD/SDSPI mode.
TRIM/DISCARD/SANITIZE tests for eMMC devices.

Closes https://github.com/espressif/esp-idf/pull/7635
Closes https://github.com/espressif/esp-idf/issues/7623
This commit is contained in:
Vamshi Gajjela
2022-02-25 17:14:53 +05:30
parent 19ddb8bde1
commit ffdbeee9f6
12 changed files with 825 additions and 16 deletions

View File

@@ -694,3 +694,437 @@ TEST_CASE("WP input works in SPI mode", "[sd][test_env=UT_T1_SPIMODE]")
sd_test_board_power_off();
}
#endif //WITH_SDSPI_TEST
#if WITH_SD_TEST || WITH_EMMC_TEST
#define PATTERN_SEED 0x12345678
#define FLAG_ERASE_TEST_ADJACENT (1 << 0)
#define FLAG_VERIFY_ERASE_STATE (1 << 1)
bool do_sanitize_flag = false;
static void ensure_sector_written(sdmmc_card_t* card, size_t sector,
uint8_t *pattern_buf, uint8_t *temp_buf)
{
size_t block_size = card->csd.sector_size;
TEST_ESP_OK(sdmmc_write_sectors(card, pattern_buf, sector, 1));
memset((void *)temp_buf, 0x00, block_size);
TEST_ESP_OK(sdmmc_read_sectors(card, temp_buf, sector, 1));
check_buffer(PATTERN_SEED, temp_buf, block_size / sizeof(uint32_t));
}
static void ensure_sector_intact(sdmmc_card_t* card, size_t sector,
uint8_t *pattern_buf, uint8_t *temp_buf)
{
size_t block_size = card->csd.sector_size;
memset((void *)temp_buf, 0x00, block_size);
TEST_ESP_OK(sdmmc_read_sectors(card, temp_buf, sector, 1));
check_buffer(PATTERN_SEED, temp_buf, block_size / sizeof(uint32_t));
}
static int32_t ensure_sector_erase(sdmmc_card_t* card, size_t sector,
uint8_t *pattern_buf, uint8_t *temp_buf)
{
size_t block_size = card->csd.sector_size;
memset((void *)temp_buf, 0, block_size);
TEST_ESP_OK(sdmmc_read_sectors(card, temp_buf, sector, 1));
return memcmp(pattern_buf, temp_buf, block_size);
}
static void do_single_erase_test(sdmmc_card_t* card, size_t start_block,
size_t block_count, uint8_t flags, sdmmc_erase_arg_t arg)
{
size_t block_size = card->csd.sector_size;
uint8_t *temp_buf = NULL;
uint8_t *pattern_buf = NULL;
size_t end_block = (start_block + block_count - 1);
/*
* To ensure erase is successful/valid
* selected blocks after erase should have erase state data pattern
* data of blocks adjacent to selected region should remain intact
*/
TEST_ESP_OK((start_block + block_count) > card->csd.capacity);
pattern_buf = (uint8_t *)heap_caps_malloc(block_size, MALLOC_CAP_DMA);
TEST_ASSERT_NOT_NULL(pattern_buf);
temp_buf = (uint8_t *)heap_caps_malloc(block_size, MALLOC_CAP_DMA);
TEST_ASSERT_NOT_NULL(temp_buf);
// create pattern buffer
fill_buffer(PATTERN_SEED, pattern_buf, block_size / sizeof(uint32_t));
// check if it's not the first block of device & write/read/verify pattern
if ((flags & FLAG_ERASE_TEST_ADJACENT) && start_block) {
ensure_sector_written(card, (start_block - 1), pattern_buf, temp_buf);
}
ensure_sector_written(card, start_block, pattern_buf, temp_buf);
// check if it's not the last block of device & write/read/verify pattern
if ((flags & FLAG_ERASE_TEST_ADJACENT) && (end_block < (card->csd.capacity - 1))) {
ensure_sector_written(card, (end_block + 1), pattern_buf, temp_buf);
}
// when block count is 1, start and end block is same, hence skip
if (block_count != 1) {
ensure_sector_written(card, end_block, pattern_buf, temp_buf);
}
// fill pattern to (start_block + end_block)/2 in the erase range
if(block_count > 2) {
ensure_sector_written(card, (start_block + end_block)/2, pattern_buf, temp_buf);
}
float total_size = (block_count/1024.0f) * block_size;
printf(" %10d | %10d | %8.1f ", start_block, block_count, total_size);
fflush(stdout);
// erase the blocks
struct timeval t_start_er;
gettimeofday(&t_start_er, NULL);
TEST_ESP_OK(sdmmc_erase_sectors(card, start_block, block_count, arg));
if (do_sanitize_flag) {
TEST_ESP_OK(sdmmc_mmc_sanitize(card, block_count * 500));
}
struct timeval t_stop_wr;
gettimeofday(&t_stop_wr, NULL);
float time_er = 1e3f * (t_stop_wr.tv_sec - t_start_er.tv_sec) + 1e-3f * (t_stop_wr.tv_usec - t_start_er.tv_usec);
printf(" | %8.2f\n", time_er);
// ensure adjacent blocks are not affected
// block before start_block
if ((flags & FLAG_ERASE_TEST_ADJACENT) && start_block) {
ensure_sector_intact(card, (start_block - 1), pattern_buf, temp_buf);
}
// block after end_block
if ((flags & FLAG_ERASE_TEST_ADJACENT) && (end_block < (card->csd.capacity - 1))) {
ensure_sector_intact(card, (end_block + 1), pattern_buf, temp_buf);
}
uint8_t erase_mem_byte = 0xFF;
// ensure all the blocks are erased and are up to after erase state.
if (!card->is_mmc) {
erase_mem_byte = card->scr.erase_mem_state ? 0xFF : 0x00;
} else {
erase_mem_byte = card->ext_csd.erase_mem_state ? 0xFF : 0x00;
}
memset((void *)pattern_buf, erase_mem_byte, block_size);
// as it is block by block comparison, a time taking process. Really long
// when you do erase and verify on complete device.
if (flags & FLAG_VERIFY_ERASE_STATE) {
for (size_t i = 0; i < block_count; i++) {
if (ensure_sector_erase(card, (start_block + i), pattern_buf, temp_buf)) {
printf("Error: Sector %d erase\n", (start_block + i));
break;
}
}
}
free(temp_buf);
free(pattern_buf);
}
#endif // WITH_SD_TEST || WITH_EMMC_TEST
#if WITH_SDSPI_TEST
static void test_sdspi_erase_blocks(size_t start_block, size_t block_count)
{
sd_test_board_power_on();
sdmmc_host_t config = SDSPI_HOST_DEFAULT();
sdspi_dev_handle_t handle;
sdspi_device_config_t dev_config = SDSPI_DEVICE_CONFIG_DEFAULT();
dev_config.host_id = config.slot;
dev_config.gpio_cs = SDSPI_TEST_CS_PIN;
test_sdspi_init_bus(dev_config.host_id, SDSPI_TEST_MOSI_PIN, SDSPI_TEST_MISO_PIN, SDSPI_TEST_SCLK_PIN, SPI_DMA_CH_AUTO);
TEST_ESP_OK(sdspi_host_init());
TEST_ESP_OK(sdspi_host_init_device(&dev_config, &handle));
// This test can only run under 20MHz on ESP32, because the runner connects the card to
// non-IOMUX pins of HSPI.
sdmmc_card_t* card = malloc(sizeof(sdmmc_card_t));
TEST_ASSERT_NOT_NULL(card);
TEST_ESP_OK(sdmmc_card_init(&config, card));
sdmmc_card_print_info(stdout, card);
printf("block size %d capacity %d\n", card->csd.sector_size, card->csd.capacity);
printf("Erasing sectors %d-%d\n", start_block, (start_block + block_count -1));
size_t block_size = card->csd.sector_size;
uint8_t *pattern_buf = (uint8_t *)heap_caps_malloc(block_size, MALLOC_CAP_DMA);
TEST_ASSERT_NOT_NULL(pattern_buf);
uint8_t *temp_buf = (uint8_t *)heap_caps_malloc(block_size, MALLOC_CAP_DMA);
TEST_ASSERT_NOT_NULL(temp_buf);
struct timeval t_start_er;
gettimeofday(&t_start_er, NULL);
TEST_ESP_OK(sdmmc_erase_sectors(card, start_block, block_count, SDMMC_ERASE_ARG));
struct timeval t_stop_wr;
gettimeofday(&t_stop_wr, NULL);
float time_er = 1e3f * (t_stop_wr.tv_sec - t_start_er.tv_sec) + 1e-3f * (t_stop_wr.tv_usec - t_start_er.tv_usec);
printf("Erase duration: %.2fms\n", time_er);
// nominal delay before re-init card
vTaskDelay(pdMS_TO_TICKS(1000));
// has to re-init card, after erase operation.
TEST_ESP_OK(sdmmc_card_init(&config, card));
printf("Verifying erase state...\n");
uint8_t erase_mem_byte = 0xFF;
// ensure all the blocks are erased and are up to after erase state.
if (!card->is_mmc) {
erase_mem_byte = card->scr.erase_mem_state ? 0xFF : 0x00;
} else {
erase_mem_byte = card->ext_csd.erase_mem_state ? 0xFF : 0x00;
}
memset((void *)pattern_buf, erase_mem_byte, block_size);
size_t i;
for (i = 0; i < block_count; i++) {
memset((void *)temp_buf, 0, block_size);
TEST_ESP_OK(sdmmc_read_sectors(card, temp_buf, (start_block + i), 1));
if (memcmp(pattern_buf, temp_buf, block_size)) {
printf("Error: Sector %d erase\n", (start_block + i));
break;
}
}
if (i == block_count) {
printf("Sectors erase success\n");
}
TEST_ESP_OK(sdspi_host_deinit());
test_sdspi_deinit_bus(dev_config.host_id);
free(card);
free(temp_buf);
free(pattern_buf);
sd_test_board_power_off();
}
TEST_CASE("SDMMC erase (SPI mode)", "[sdspi][test_env=UT_T1_SPIMODE]")
{
test_sdspi_erase_blocks(0, 16);
}
#endif // WITH_SDSPI_TEST
#if WITH_SD_TEST
static void test_sd_erase_blocks(sdmmc_card_t* card)
{
sdmmc_card_print_info(stdout, card);
printf("block size %d capacity %d\n", card->csd.sector_size, card->csd.capacity);
printf(" sector | count | size(kB) | er_time(ms) \n");
/*
* bit-0: verify adjacent blocks of given range
* bit-1: verify erase state of blocks in range
*/
uint8_t flags = 0;
sdmmc_erase_arg_t arg = SDMMC_ERASE_ARG;
//check for adjacent blocks and erase state of blocks
flags |= (uint8_t)FLAG_ERASE_TEST_ADJACENT | (uint8_t)FLAG_VERIFY_ERASE_STATE;
do_single_erase_test(card, 1, 16, flags, arg);
do_single_erase_test(card, 1, 13, flags, arg);
do_single_erase_test(card, 16, 32, flags, arg);
do_single_erase_test(card, 48, 64, flags, arg);
do_single_erase_test(card, 128, 128, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 64, flags, arg);
// single sector erase is failing on different make cards
do_single_erase_test(card, card->csd.capacity - 8, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 4, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 8, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 16, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 128, flags, arg);
#ifdef SDMMC_FULL_ERASE_TEST
/*
* check for adjacent blocks, do not check erase state of blocks as it is
* time taking process to verify all the blocks.
*/
flags &= ~(uint8_t)FLAG_VERIFY_ERASE_STATE; //comment this line to verify after-erase state
// erase complete card
do_single_erase_test(card, 0, card->csd.capacity, flags, arg);
#endif //SDMMC_FULL_ERASE_TEST
}
TEST_CASE("SDMMC erase test (SD slot 1, 1 line)", "[sd][test_env=UT_T1_SDMODE]")
{
sd_test_board_power_on();
sd_test_rw_blocks(1, 1, test_sd_erase_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC erase test (SD slot 1, 4 line)", "[sd][test_env=UT_T1_SDMODE]")
{
sd_test_board_power_on();
sd_test_rw_blocks(1, 4, test_sd_erase_blocks);
sd_test_board_power_off();
}
#endif //WITH_SD_TEST
#if WITH_EMMC_TEST
static void test_mmc_sanitize_blocks(sdmmc_card_t* card)
{
/* MMC dicard applies to write blocks */
sdmmc_card_print_info(stdout, card);
printf("block size %d capacity %d\n", card->csd.sector_size, card->csd.capacity);
if (sdmmc_mmc_can_sanitize(card)) {
printf("Card/device do not support sanitize\n");
return;
}
printf(" sector | count | size(kB) | er_time(ms) \n");
/*
* bit-0: verify adjacent blocks of given range
* bit-1: verify erase state of blocks in range
*/
uint8_t flags = 0;
sdmmc_erase_arg_t arg = SDMMC_DISCARD_ARG;
do_sanitize_flag = true;
/*
* Check for adjacent blocks only.
* After discard operation, the original data may be remained partially or
* fully accessible to the host dependent on device. Hence do not verify
* the erased state of the blocks.
*
* Note: After sanitize blocks has to be in erased state
*/
flags |= (uint8_t)FLAG_ERASE_TEST_ADJACENT | (uint8_t)FLAG_VERIFY_ERASE_STATE;
do_single_erase_test(card, 1, 16, flags, arg);
do_single_erase_test(card, 1, 13, flags, arg);
do_single_erase_test(card, 16, 32, flags, arg);
do_single_erase_test(card, 48, 64, flags, arg);
do_single_erase_test(card, 128, 128, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity - 8, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 4, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 8, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 16, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 128, flags, arg);
do_sanitize_flag = false;
}
static void test_mmc_discard_blocks(sdmmc_card_t* card)
{
/* MMC dicard applies to write blocks */
sdmmc_card_print_info(stdout, card);
printf("block size %d capacity %d\n", card->csd.sector_size, card->csd.capacity);
printf(" sector | count | size(kB) | er_time(ms) \n");
/*
* bit-0: verify adjacent blocks of given range
* bit-1: verify erase state of blocks in range
*/
uint8_t flags = 0;
sdmmc_erase_arg_t arg = SDMMC_DISCARD_ARG;
/*
* Check for adjacent blocks only.
* After discard operation, the original data may be remained partially or
* fully accessible to the host dependent on device. Hence do not verify
* the erased state of the blocks.
*/
flags |= (uint8_t)FLAG_ERASE_TEST_ADJACENT;
do_single_erase_test(card, 1, 16, flags, arg);
do_single_erase_test(card, 1, 13, flags, arg);
do_single_erase_test(card, 16, 32, flags, arg);
do_single_erase_test(card, 48, 64, flags, arg);
do_single_erase_test(card, 128, 128, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity - 8, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 4, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 8, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 16, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 128, flags, arg);
}
static void test_mmc_trim_blocks(sdmmc_card_t* card)
{
/* MMC trim applies to write blocks */
sdmmc_card_print_info(stdout, card);
printf("block size %d capacity %d\n", card->csd.sector_size, card->csd.capacity);
printf(" sector | count | size(kB) | er_time(ms) \n");
/*
* bit-0: verify adjacent blocks of given range
* bit-1: verify erase state of blocks in range
*/
uint8_t flags = 0;
sdmmc_erase_arg_t arg = SDMMC_ERASE_ARG;
//check for adjacent blocks and erase state of blocks
flags |= (uint8_t)FLAG_ERASE_TEST_ADJACENT | (uint8_t)FLAG_VERIFY_ERASE_STATE;
do_single_erase_test(card, 1, 16, flags, arg);
do_single_erase_test(card, 1, 13, flags, arg);
do_single_erase_test(card, 16, 32, flags, arg);
do_single_erase_test(card, 48, 64, flags, arg);
do_single_erase_test(card, 128, 128, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity - 64, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity - 8, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 1, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 4, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 8, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 16, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 32, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 64, flags, arg);
do_single_erase_test(card, card->csd.capacity/2, 128, flags, arg);
#ifdef SDMMC_FULL_ERASE_TEST
/*
* check for adjacent blocks, do not check erase state of blocks as it is
* time taking process to verify all the blocks.
*/
flags &= ~(uint8_t)FLAG_VERIFY_ERASE_STATE; //comment this line to verify after erase state
// erase complete card
do_single_erase_test(card, 0, card->csd.capacity, flags, arg);
#endif //SDMMC_FULL_ERASE_TEST
}
TEST_CASE("SDMMC trim test (eMMC slot 0, 4 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 4, test_mmc_trim_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC trim test (eMMC slot 0, 8 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 8, test_mmc_trim_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC discard test (eMMC slot 0, 4 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 4, test_mmc_discard_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC discard test (eMMC slot 0, 8 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 8, test_mmc_discard_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC sanitize test (eMMC slot 0, 4 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 4, test_mmc_sanitize_blocks);
sd_test_board_power_off();
}
TEST_CASE("SDMMC sanitize test (eMMC slot 0, 8 line)", "[sd][test_env=EMMC]")
{
sd_test_board_power_on();
sd_test_rw_blocks(0, 8, test_mmc_sanitize_blocks);
sd_test_board_power_off();
}
#endif //WITH_EMMC_TEST